Ghost/core/server/api/shared/frame.js

const debug = require('ghost-ignition').debug('api:shared:frame');
const _ = require('lodash');

class Frame {
    constructor(obj = {}) {
        this.original = obj;

        this.options = {};
        this.data = {};
        this.user = {};
        this.file = {};
        this.files = [];
        this.apiType = obj.apiType;
    }

    /**
     * If you instantiate a new frame, all the data you pass in, land in `this.original`.
     * Based on the API ctrl implemented, this fn will pick allowed properties to either options or data.
     */
    configure(apiConfig) {
        debug('configure');

        if (apiConfig.options) {
            if (typeof apiConfig.options === 'function') {
                apiConfig.options = apiConfig.options(this);
            }

            if (this.original.hasOwnProperty('query')) {
                Object.assign(this.options, _.pick(this.original.query, apiConfig.options));
            }

            if (this.original.hasOwnProperty('params')) {
                Object.assign(this.options, _.pick(this.original.params, apiConfig.options));
            }

            if (this.original.hasOwnProperty('options')) {
                Object.assign(this.options, _.pick(this.original.options, apiConfig.options));
            }
        }

        this.options.context = this.original.context;

        if (this.original.body && Object.keys(this.original.body).length) {
            this.data = this.original.body;
        } else {
            if (apiConfig.data) {
                if (typeof apiConfig.data === 'function') {
                    apiConfig.data = apiConfig.data(this);
                }

                if (this.original.hasOwnProperty('query')) {
                    Object.assign(this.data, _.pick(this.original.query, apiConfig.data));
                }

                if (this.original.hasOwnProperty('params')) {
                    Object.assign(this.data, _.pick(this.original.params, apiConfig.data));
                }

                if (this.original.hasOwnProperty('options')) {
                    Object.assign(this.data, _.pick(this.original.options, apiConfig.data));
                }
            }
        }

        this.user = this.original.user;
        this.file = this.original.file;
        this.files = this.original.files;

        debug('original', this.original);
        debug('options', this.options);
        debug('data', this.data);
    }
}

module.exports = Frame;