ghost 4.47.4 → 5.0.1

package/core/server/api/v3/utils/serializers/output/index.js

@@ -1,135 +0,0 @@
-// ESLint Override Notice
-// This is a valid index.js file - it just exports a lot of stuff!
-// Long term we would like to change the API architecture to reduce this file,
-// but that's not the problem the index.js max - line eslint "proxy" rule is there to solve.
-/* eslint-disable max-lines */
-
-module.exports = {
-    get all() {
-        return require('./all');
-    },
-
-    get authentication() {
-        return require('./authentication');
-    },
-
-    get db() {
-        return require('./db');
-    },
-
-    get integrations() {
-        return require('./integrations');
-    },
-
-    get pages() {
-        return require('./pages');
-    },
-
-    get redirects() {
-        return require('./redirects');
-    },
-
-    get roles() {
-        return require('./roles');
-    },
-
-    get slugs() {
-        return require('./slugs');
-    },
-
-    get schedules() {
-        return require('./schedules');
-    },
-
-    get webhooks() {
-        return require('./webhooks');
-    },
-
-    get posts() {
-        return require('./posts');
-    },
-
-    get invites() {
-        return require('./invites');
-    },
-
-    get settings() {
-        return require('./settings');
-    },
-
-    get notifications() {
-        return require('./notifications');
-    },
-
-    get mail() {
-        return require('./mail');
-    },
-
-    get members() {
-        return require('./members');
-    },
-
-    get member_signin_urls() {
-        return require('./member-signin_urls');
-    },
-
-    get identities() {
-        return require('./identities');
-    },
-
-    get images() {
-        return require('./images');
-    },
-
-    get tags() {
-        return require('./tags');
-    },
-
-    get users() {
-        return require('./users');
-    },
-
-    get preview() {
-        return require('./preview');
-    },
-
-    get oembed() {
-        return require('./oembed');
-    },
-
-    get authors() {
-        return require('./authors');
-    },
-
-    get config() {
-        return require('./config');
-    },
-
-    get themes() {
-        return require('./themes');
-    },
-
-    get actions() {
-        return require('./actions');
-    },
-
-    get site() {
-        return require('./site');
-    },
-
-    get email_preview() {
-        return require('./email-preview');
-    },
-
-    get emails() {
-        return require('./emails');
-    },
-
-    get labels() {
-        return require('./labels');
-    },
-
-    get snippets() {
-        return require('./snippets');
-    }
-};

package/core/server/api/v3/utils/serializers/output/integrations.js

@@ -1,35 +0,0 @@
-const debug = require('@tryghost/debug')('api:v3:utils:serializers:output:integrations');
-const mapper = require('./utils/mapper');
-
-module.exports = {
-    browse({data, meta}, apiConfig, frame) {
-        debug('browse');
-
-        frame.response = {
-            integrations: data.map(model => mapper.mapIntegration(model, frame)),
-            meta
-        };
-    },
-    read(model, apiConfig, frame) {
-        debug('read');
-
-        frame.response = {
-            integrations: [mapper.mapIntegration(model, frame)]
-        };
-    },
-    add(model, apiConfig, frame) {
-        debug('add');
-
-        frame.response = {
-            integrations: [mapper.mapIntegration(model, frame)]
-        };
-    },
-    edit(model, apiConfig, frame) {
-        debug('edit');
-
-        frame.response = {
-            integrations: [mapper.mapIntegration(model, frame)]
-        };
-    }
-};
-

package/core/server/api/v3/utils/serializers/output/invites.js

@@ -1,24 +0,0 @@
-const debug = require('@tryghost/debug')('api:v3:utils:serializers:output:invites');
-
-module.exports = {
-    all(models, apiConfig, frame) {
-        debug('all');
-
-        if (!models) {
-            return;
-        }
-
-        if (models.meta) {
-            frame.response = {
-                invites: models.data.map(model => model.toJSON(frame.options)),
-                meta: models.meta
-            };
-
-            return;
-        }
-
-        frame.response = {
-            invites: [models.toJSON(frame.options)]
-        };
-    }
-};

package/core/server/api/v3/utils/serializers/output/labels.js

@@ -1,25 +0,0 @@
-const debug = require('@tryghost/debug')('api:v3:utils:serializers:output:labels');
-const mapper = require('./utils/mapper');
-
-module.exports = {
-    all(models, apiConfig, frame) {
-        debug('all');
-
-        if (!models) {
-            return;
-        }
-
-        if (models.meta) {
-            frame.response = {
-                labels: models.data.map(model => mapper.mapLabel(model, frame)),
-                meta: models.meta
-            };
-
-            return;
-        }
-
-        frame.response = {
-            labels: [mapper.mapLabel(models, frame)]
-        };
-    }
-};

package/core/server/api/v3/utils/serializers/output/mail.js

@@ -1,19 +0,0 @@
-const _ = require('lodash');
-const debug = require('@tryghost/debug')('api:v3:utils:serializers:output:mail');
-
-module.exports = {
-    all(response, apiConfig, frame) {
-        debug('all');
-        const toReturn = _.cloneDeep(frame.data);
-
-        delete toReturn.mail[0].options;
-        // Sendmail returns extra details we don't need and that don't convert to JSON
-        delete toReturn.mail[0].message.transport;
-
-        toReturn.mail[0].status = {
-            message: response.message
-        };
-
-        frame.response = toReturn;
-    }
-};

package/core/server/api/v3/utils/serializers/output/member-signin_urls.js

@@ -1,7 +0,0 @@
-module.exports = {
-    read(data, apiConfig, frame) {
-        frame.response = {
-            member_signin_urls: [data]
-        };
-    }
-};

package/core/server/api/v3/utils/serializers/output/members.js

@@ -1,228 +0,0 @@
-//@ts-check
-const debug = require('@tryghost/debug')('api:v3:utils:serializers:output:members');
-const {unparse} = require('@tryghost/members-csv');
-
-module.exports = {
-    hasActiveStripeSubscriptions: createSerializer('hasActiveStripeSubscriptions', passthrough),
-
-    browse: createSerializer('browse', paginatedMembers),
-    read: createSerializer('read', singleMember),
-    edit: createSerializer('edit', singleMember),
-    add: createSerializer('add', singleMember),
-    editSubscription: createSerializer('editSubscription', singleMember),
-
-    exportCSV: createSerializer('exportCSV', exportCSV),
-
-    importCSV: createSerializer('importCSV', passthrough),
-    stats: createSerializer('stats', passthrough)
-};
-
-/**
- * @template PageMeta
- *
- * @param {{data: import('bookshelf').Model[], meta: PageMeta}} page
- * @param {APIConfig} _apiConfig
- * @param {Frame} frame
- *
- * @returns {{members: SerializedMember[], meta: PageMeta}}
- */
-function paginatedMembers(page, _apiConfig, frame) {
-    return {
-        members: page.data.map(model => serializeMember(model, frame.options)),
-        meta: page.meta
-    };
-}
-
-/**
- * @param {import('bookshelf').Model} model
- * @param {APIConfig} _apiConfig
- * @param {Frame} frame
- *
- * @returns {{members: SerializedMember[]}}
- */
-function singleMember(model, _apiConfig, frame) {
-    return {
-        members: [serializeMember(model, frame.options)]
-    };
-}
-
-/**
- * @template PageMeta
- *
- * @param {{data: import('bookshelf').Model[], meta: PageMeta}} page
- * @param {APIConfig} _apiConfig
- * @param {Frame} frame
- *
- * @returns {string} - A CSV string
- */
-function exportCSV(page, _apiConfig, frame) {
-    debug('exportCSV');
-
-    const members = page.data.map(model => serializeMember(model, frame.options));
-
-    return unparse(members);
-}
-
-/**
- * @param {import('bookshelf').Model} member
- * @param {object} options
- *
- * @returns {SerializedMember}
- */
-function serializeMember(member, options) {
-    const json = member.toJSON(options);
-
-    let comped = false;
-    let stripe = null;
-    if (json.subscriptions) {
-        stripe = {
-            subscriptions: json.subscriptions
-        };
-    }
-
-    return {
-        id: json.id,
-        uuid: json.uuid,
-        email: json.email,
-        name: json.name,
-        note: json.note,
-        geolocation: json.geolocation,
-        subscribed: json.subscribed,
-        created_at: json.created_at,
-        updated_at: json.updated_at,
-        labels: json.labels,
-        stripe: stripe,
-        avatar_image: json.avatar_image,
-        comped: comped,
-        email_count: json.email_count,
-        email_opened_count: json.email_opened_count,
-        email_open_rate: json.email_open_rate,
-        email_recipients: json.email_recipients
-    };
-}
-
-/**
- * @template Data
- * @param {Data} data
- * @returns Data
- */
-function passthrough(data) {
-    return data;
-}
-
-/**
- * @template Data
- * @template Response
- * @param {string} debugString
- * @param {(data: Data, apiConfig: APIConfig, frame: Frame) => Response} serialize - A function to serialize the data into an object suitable for API response
- *
- * @returns {(data: Data, apiConfig: APIConfig, frame: Frame) => void}
- */
-function createSerializer(debugString, serialize) {
-    return function serializer(data, apiConfig, frame) {
-        debug(debugString);
-        const response = serialize(data, apiConfig, frame);
-        frame.response = response;
-    };
-}
-
-/**
- * @typedef {Object} SerializedMember
- * @prop {string} id
- * @prop {string} uuid
- * @prop {string} email
- * @prop {string=} name
- * @prop {string=} note
- * @prop {null|string} geolocation
- * @prop {boolean} subscribed
- * @prop {string} created_at
- * @prop {string} updated_at
- * @prop {string[]} labels
- * @prop {null|SerializedMemberStripeData} stripe
- * @prop {string} avatar_image
- * @prop {boolean} comped
- * @prop {number} email_count
- * @prop {number} email_opened_count
- * @prop {number} email_open_rate
- * @prop {null|SerializedEmailRecipient[]} email_recipients
- */
-
-/**
- * @typedef {Object} SerializedMemberStripeData
- * @prop {SerializedMemberStripeSubscription[]} subscriptions
- */
-
-/**
- * @typedef {Object} SerializedMemberStripeSubscription
- *
- * @prop {string} id
- * @prop {string} status
- * @prop {string} start_date
- * @prop {string} default_payment_card_last4
- * @prop {string} current_period_end
- * @prop {boolean} cancel_at_period_end
- *
- * @prop {Object} customer
- * @prop {string} customer.id
- * @prop {null|string} customer.name
- * @prop {string} customer.email
- *
- * @prop {Object} plan
- * @prop {string} plan.id
- * @prop {string} plan.nickname
- * @prop {number} plan.amount
- * @prop {string} plan.currency
- */
-
-/**
- * @typedef {Object} SerializedEmailRecipient
- *
- * @prop {string} id
- * @prop {string} email_id
- * @prop {string} batch_id
- * @prop {string} processed_at
- * @prop {string} delivered_at
- * @prop {string} opened_at
- * @prop {string} failed_at
- * @prop {string} member_uuid
- * @prop {string} member_email
- * @prop {string} member_name
- * @prop {SerializedEmail[]} email
- */
-
-/**
- * @typedef {Object} SerializedEmail
- *
- * @prop {string} id
- * @prop {string} post_id
- * @prop {string} uuid
- * @prop {string} status
- * @prop {string} recipient_filter
- * @prop {null|string} error
- * @prop {string} error_data
- * @prop {number} email_count
- * @prop {number} delivered_count
- * @prop {number} opened_count
- * @prop {number} failed_count
- * @prop {string} subject
- * @prop {string} from
- * @prop {string} reply_to
- * @prop {string} html
- * @prop {string} plaintext
- * @prop {boolean} track_opens
- * @prop {string} created_at
- * @prop {string} created_by
- * @prop {string} updated_at
- * @prop {string} updated_by
- */
-
-/**
- * @typedef {Object} APIConfig
- * @prop {string} docName
- * @prop {string} method
- */
-
-/**
- * @typedef {Object<string, any>} Frame
- * @prop {Object} options
- */

package/core/server/api/v3/utils/serializers/output/notifications.js

@@ -1,29 +0,0 @@
-const debug = require('@tryghost/debug')('api:v3:utils:serializers:output:notifications');
-
-module.exports = {
-    all(response, apiConfig, frame) {
-        debug('all');
-        if (!response) {
-            return;
-        }
-
-        if (!response || !response.length) {
-            frame.response = {
-                notifications: []
-            };
-
-            return;
-        }
-
-        response.forEach((notification) => {
-            delete notification.seen;
-            delete notification.seenBy;
-            delete notification.addedAt;
-            delete notification.createdAtVersion;
-        });
-
-        frame.response = {
-            notifications: response
-        };
-    }
-};

package/core/server/api/v3/utils/serializers/output/oembed.js

@@ -1,8 +0,0 @@
-const debug = require('@tryghost/debug')('api:v3:utils:serializers:output:oembed');
-
-module.exports = {
-    all(res, apiConfig, frame) {
-        debug('all');
-        frame.response = res;
-    }
-};

package/core/server/api/v3/utils/serializers/output/pages.js

@@ -1,26 +0,0 @@
-const debug = require('@tryghost/debug')('api:v3:utils:serializers:output:pages');
-const mapper = require('./utils/mapper');
-
-module.exports = {
-    all(models, apiConfig, frame) {
-        debug('all');
-
-        // CASE: e.g. destroy returns null
-        if (!models) {
-            return;
-        }
-
-        if (models.meta) {
-            frame.response = {
-                pages: models.data.map(model => mapper.mapPage(model, frame)),
-                meta: models.meta
-            };
-
-            return;
-        }
-
-        frame.response = {
-            pages: [mapper.mapPage(models, frame)]
-        };
-    }
-};

package/core/server/api/v3/utils/serializers/output/posts.js

@@ -1,26 +0,0 @@
-const debug = require('@tryghost/debug')('api:v3:utils:serializers:output:posts');
-const mapper = require('./utils/mapper');
-
-module.exports = {
-    all(models, apiConfig, frame) {
-        debug('all');
-
-        // CASE: e.g. destroy returns null
-        if (!models) {
-            return;
-        }
-
-        if (models.meta) {
-            frame.response = {
-                posts: models.data.map(model => mapper.mapPost(model, frame)),
-                meta: models.meta
-            };
-
-            return;
-        }
-
-        frame.response = {
-            posts: [mapper.mapPost(models, frame)]
-        };
-    }
-};

package/core/server/api/v3/utils/serializers/output/preview.js

@@ -1,10 +0,0 @@
-const mapper = require('./utils/mapper');
-
-module.exports = {
-    all(model, apiConfig, frame) {
-        frame.response = {
-            preview: [mapper.mapPost(model, frame)]
-        };
-        frame.response.preview[0].page = model.get('type') === 'page';
-    }
-};

package/core/server/api/v3/utils/serializers/output/redirects.js

@@ -1,5 +0,0 @@
-module.exports = {
-    download(response, apiConfig, frame) {
-        frame.response = response;
-    }
-};

package/core/server/api/v3/utils/serializers/output/roles.js

@@ -1,29 +0,0 @@
-const Promise = require('bluebird');
-const debug = require('@tryghost/debug')('api:v3:utils:serializers:output:roles');
-const canThis = require('../../../../../services/permissions').canThis;
-
-module.exports = {
-    browse(models, apiConfig, frame) {
-        debug('browse');
-
-        const roles = models.toJSON(frame.options);
-
-        if (frame.options.permissions !== 'assign') {
-            return frame.response = {
-                roles: roles
-            };
-        } else {
-            return Promise.filter(roles.map((role) => {
-                return canThis(frame.options.context).assign.role(role)
-                    .return(role)
-                    .catch(() => {});
-            }), (value) => {
-                return value && (value.name !== 'Owner');
-            }).then((filteredRoles) => {
-                return frame.response = {
-                    roles: filteredRoles
-                };
-            });
-        }
-    }
-};

package/core/server/api/v3/utils/serializers/output/schedules.js

@@ -1,5 +0,0 @@
-module.exports = {
-    all(model, apiConfig, frame) {
-        frame.response = model;
-    }
-};

package/core/server/api/v3/utils/serializers/output/settings.js

@@ -1,65 +0,0 @@
-const _ = require('lodash');
-const utils = require('../../index');
-const mapper = require('./utils/mapper');
-const _private = {};
-
-/**
- * ### Settings Filter
- * Filters an object based on a given filter object
- * @private
- * @param {Object} settings
- * @param {String} filter
- * @returns {*}
- */
-_private.settingsFilter = (settings, filter) => {
-    let filteredGroups = filter ? filter.split(',') : false;
-    return _.filter(settings, (setting) => {
-        if (filteredGroups) {
-            return _.includes(filteredGroups, setting.group);
-        }
-
-        return true;
-    });
-};
-
-module.exports = {
-    browse(models, apiConfig, frame) {
-        let filteredSettings;
-
-        // If this is public, we already have the right data, we just need to add an Array wrapper
-        if (utils.isContentAPI(frame)) {
-            filteredSettings = models;
-        } else {
-            filteredSettings = _.values(_private.settingsFilter(models, frame.options.group));
-        }
-
-        frame.response = {
-            settings: mapper.mapSettings(filteredSettings, frame),
-            meta: {}
-        };
-
-        if (frame.options.type || frame.options.group) {
-            frame.response.meta.filters = {};
-
-            if (frame.options.type) {
-                frame.response.meta.filters.type = frame.options.type;
-            }
-
-            if (frame.options.group) {
-                frame.response.meta.filters.group = frame.options.group;
-            }
-        }
-    },
-
-    read() {
-        this.browse(...arguments);
-    },
-
-    edit() {
-        this.browse(...arguments);
-    },
-
-    download(bytes, apiConfig, frame) {
-        frame.response = bytes;
-    }
-};