ghost 4.47.3 → 5.0.0

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

@@ -1,19 +0,0 @@
-const _ = require('lodash');
-const debug = require('@tryghost/debug')('api:v3:utils:serializers:output:site');
-
-module.exports = {
-    read(data, apiConfig, frame) {
-        debug('read');
-
-        frame.response = {
-            site: _.pick(data, [
-                'title',
-                'description',
-                'logo',
-                'accent_color',
-                'url',
-                'version'
-            ])
-        };
-    }
-};

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

@@ -1,11 +0,0 @@
-const debug = require('@tryghost/debug')('api:v3:utils:serializers:output:slugs');
-
-module.exports = {
-    all(slug, apiConfig, frame) {
-        debug('all');
-
-        frame.response = {
-            slugs: [{slug}]
-        };
-    }
-};

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

@@ -1,97 +0,0 @@
-//@ts-check
-const debug = require('@tryghost/debug')('api:v3:utils:serializers:output:snippets');
-
-module.exports = {
-    browse: createSerializer('browse', paginatedSnippets),
-    read: createSerializer('read', singleSnippet),
-    edit: createSerializer('edit', singleSnippet),
-    add: createSerializer('add', singleSnippet)
-};
-
-/**
- * @template PageMeta
- *
- * @param {{data: import('bookshelf').Model[], meta: PageMeta}} page
- * @param {APIConfig} _apiConfig
- * @param {Frame} frame
- *
- * @returns {{snippets: SerializedSnippet[], meta: PageMeta}}
- */
-function paginatedSnippets(page, _apiConfig, frame) {
-    return {
-        snippets: page.data.map(model => serializeSnippet(model, frame.options)),
-        meta: page.meta
-    };
-}
-
-/**
- * @param {import('bookshelf').Model} model
- * @param {APIConfig} _apiConfig
- * @param {Frame} frame
- *
- * @returns {{snippets: SerializedSnippet[]}}
- */
-function singleSnippet(model, _apiConfig, frame) {
-    return {
-        snippets: [serializeSnippet(model, frame.options)]
-    };
-}
-
-/**
- * @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;
-    };
-}
-
-/**
- * @param {import('bookshelf').Model} snippet
- * @param {object} options
- *
- * @returns {SerializedSnippet}
- */
-function serializeSnippet(snippet, options) {
-    const json = snippet.toJSON(options);
-
-    return {
-        id: json.id,
-        name: json.name,
-        // @ts-ignore
-        mobiledoc: json.mobiledoc,
-        created_at: json.created_at,
-        updated_at: json.updated_at,
-        created_by: json.created_by,
-        updated_by: json.updated_by
-    };
-}
-
-/**
- * @typedef {Object} SerializedSnippet
- * @prop {string} id
- * @prop {string=} name
- * @prop {string=} mobiledoc
- * @prop {string} created_at
- * @prop {string} updated_at
- * @prop {string} created_by
- * @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/tags.js

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

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

@@ -1,25 +0,0 @@
-const debug = require('@tryghost/debug')('api:v3:utils:serializers:output:themes');
-
-module.exports = {
-    browse(themes, apiConfig, frame) {
-        debug('browse');
-
-        frame.response = themes;
-    },
-
-    upload() {
-        debug('upload');
-        this.browse(...arguments);
-    },
-
-    activate() {
-        debug('activate');
-        this.browse(...arguments);
-    },
-
-    download(fn, apiConfig, frame) {
-        debug('download');
-
-        frame.response = fn;
-    }
-};

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

@@ -1,74 +0,0 @@
-const debug = require('@tryghost/debug')('api:v3:utils:serializers:output:users');
-const tpl = require('@tryghost/tpl');
-const mapper = require('./utils/mapper');
-
-const messages = {
-    pwdChangedSuccessfully: 'Password changed successfully.'
-};
-
-module.exports = {
-    browse(models, apiConfig, frame) {
-        debug('browse');
-
-        frame.response = {
-            users: models.data.map(model => mapper.mapUser(model, frame)),
-            meta: models.meta
-        };
-    },
-
-    read(model, apiConfig, frame) {
-        debug('read');
-
-        frame.response = {
-            users: [mapper.mapUser(model, frame)]
-        };
-    },
-
-    edit() {
-        debug('edit');
-        this.read(...arguments);
-    },
-
-    destroy(filename, apiConfig, frame) {
-        debug('destroy');
-
-        frame.response = {
-            meta: {
-                filename: filename
-            }
-        };
-    },
-
-    changePassword(models, apiConfig, frame) {
-        debug('changePassword');
-
-        frame.response = {
-            password: [{message: tpl(messages.pwdChangedSuccessfully)}]
-        };
-    },
-
-    transferOwnership(models, apiConfig, frame) {
-        debug('transferOwnership');
-
-        frame.response = {
-            users: models.map(model => model.toJSON(frame.options))
-        };
-    },
-
-    readToken(model, apiConfig, frame) {
-        debug('readToken');
-
-        frame.response = {
-            apiKey: model.toJSON(frame.options)
-        };
-    },
-
-    regenerateToken(model, apiConfig, frame) {
-        debug('regenerateToken');
-
-        frame.response = {
-            apiKey: model.toJSON(frame.options)
-        };
-    }
-
-};

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

@@ -1,166 +0,0 @@
-const _ = require('lodash');
-const localUtils = require('../../../index');
-
-const tag = (attrs, frame) => {
-    if (localUtils.isContentAPI(frame)) {
-        delete attrs.created_at;
-        delete attrs.updated_at;
-
-        // We are standardising on returning null from the Content API for any empty values
-        if (attrs.meta_title === '') {
-            attrs.meta_title = null;
-        }
-        if (attrs.meta_description === '') {
-            attrs.meta_description = null;
-        }
-        if (attrs.description === '') {
-            attrs.description = null;
-        }
-    }
-
-    delete attrs.parent_id;
-    delete attrs.parent;
-
-    return attrs;
-};
-
-const author = (attrs, frame) => {
-    if (localUtils.isContentAPI(frame)) {
-        delete attrs.created_at;
-        delete attrs.updated_at;
-        delete attrs.last_seen;
-        delete attrs.status;
-        delete attrs.email;
-
-        // @NOTE: used for night shift
-        delete attrs.accessibility;
-
-        // Extra properties removed from v3
-        delete attrs.tour;
-
-        // We are standardising on returning null from the Content API for any empty values
-        if (attrs.twitter === '') {
-            attrs.twitter = null;
-        }
-        if (attrs.bio === '') {
-            attrs.bio = null;
-        }
-        if (attrs.website === '') {
-            attrs.website = null;
-        }
-        if (attrs.facebook === '') {
-            attrs.facebook = null;
-        }
-        if (attrs.meta_title === '') {
-            attrs.meta_title = null;
-        }
-        if (attrs.meta_description === '') {
-            attrs.meta_description = null;
-        }
-        if (attrs.location === '') {
-            attrs.location = null;
-        }
-    }
-
-    // @NOTE: unused fields
-    delete attrs.visibility;
-    delete attrs.locale;
-
-    return attrs;
-};
-
-const post = (attrs, frame) => {
-    const columns = frame && frame.options && frame.options.columns || null;
-    const fields = frame && frame.original && frame.original.query && frame.original.query.fields || null;
-    if (localUtils.isContentAPI(frame)) {
-        // @TODO: https://github.com/TryGhost/Ghost/issues/10335
-        // delete attrs.page;
-        delete attrs.status;
-        delete attrs.email_only;
-
-        // We are standardising on returning null from the Content API for any empty values
-        if (attrs.twitter_title === '') {
-            attrs.twitter_title = null;
-        }
-        if (attrs.twitter_description === '') {
-            attrs.twitter_description = null;
-        }
-        if (attrs.meta_title === '') {
-            attrs.meta_title = null;
-        }
-        if (attrs.meta_description === '') {
-            attrs.meta_description = null;
-        }
-        if (attrs.og_title === '') {
-            attrs.og_title = null;
-        }
-        if (attrs.og_description === '') {
-            attrs.og_description = null;
-        }
-        // Note: If visibility is set to a specific filter in v4, we want to return paid in v3
-        if (attrs.visibility && !['public', 'members', 'paid'].includes(attrs.visibility)) {
-            attrs.visibility = 'paid';
-        }
-
-        // NOTE: the visibility column has to be always present in Content API response to perform content gating
-        if (columns && columns.includes('visibility') && fields && !fields.includes('visibility')) {
-            delete attrs.visibility;
-        }
-    } else {
-        delete attrs.page;
-    }
-
-    if (columns && columns.includes('email_recipient_filter') && fields && !fields.includes('email_recipient_filter')) {
-        delete attrs.email_recipient_filter;
-    }
-
-    if (fields && !fields.includes('send_email_when_published')) {
-        delete attrs.send_email_when_published;
-    }
-
-    if (!attrs.tags) {
-        delete attrs.primary_tag;
-    }
-
-    if (!attrs.authors) {
-        delete attrs.primary_author;
-    }
-
-    delete attrs.locale;
-    delete attrs.author;
-    delete attrs.type;
-    delete attrs.feature_image_alt;
-    delete attrs.feature_image_caption;
-
-    return attrs;
-};
-
-const action = (attrs) => {
-    if (attrs.actor) {
-        delete attrs.actor_id;
-        delete attrs.resource_id;
-
-        if (attrs.actor_type === 'user') {
-            attrs.actor = _.pick(attrs.actor, ['id', 'name', 'slug', 'profile_image']);
-            attrs.actor.image = attrs.actor.profile_image;
-            delete attrs.actor.profile_image;
-        } else {
-            attrs.actor = _.pick(attrs.actor, ['id', 'name', 'slug', 'icon_image']);
-            attrs.actor.image = attrs.actor.icon_image;
-            delete attrs.actor.icon_image;
-        }
-    } else if (attrs.resource) {
-        delete attrs.actor_id;
-        delete attrs.resource_id;
-
-        // @NOTE: we only support posts right now
-        attrs.resource = _.pick(attrs.resource, ['id', 'title', 'slug', 'feature_image']);
-        attrs.resource.image = attrs.resource.feature_image;
-        delete attrs.resource.feature_image;
-    }
-};
-
-module.exports.post = post;
-module.exports.tag = tag;
-module.exports.author = author;
-module.exports.action = action;

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

@@ -1,21 +0,0 @@
-const moment = require('moment-timezone');
-const settingsCache = require('../../../../../../../shared/settings-cache');
-
-const format = (date) => {
-    return moment(date)
-        .tz(settingsCache.get('timezone'))
-        .toISOString(true);
-};
-
-const forPost = (attrs) => {
-    ['created_at', 'updated_at', 'published_at'].forEach((field) => {
-        if (attrs[field]) {
-            attrs[field] = format(attrs[field]);
-        }
-    });
-
-    return attrs;
-};
-
-module.exports.format = format;
-module.exports.forPost = forPost;

package/core/server/api/v3/utils/serializers/output/utils/extra-attrs.js

@@ -1,174 +0,0 @@
-const readingMinutes = require('@tryghost/helpers').utils.readingMinutes;
-
-module.exports.forPost = (frame, model, attrs) => {
-    const _ = require('lodash');
-
-    if (!Object.prototype.hasOwnProperty.call(frame.options, 'columns') ||
-        (frame.options.columns.includes('excerpt') && frame.options.formats && frame.options.formats.includes('plaintext'))) {
-        if (_.isEmpty(attrs.custom_excerpt)) {
-            let plaintext = model.get('plaintext');
-
-            if (plaintext) {
-                attrs.excerpt = plaintext.substring(0, 500);
-            } else {
-                attrs.excerpt = null;
-            }
-        } else {
-            attrs.excerpt = attrs.custom_excerpt;
-        }
-    }
-
-    if (!Object.prototype.hasOwnProperty.call(frame.options, 'columns') ||
-    (frame.options.columns.includes('reading_time'))) {
-        if (attrs.html) {
-            let additionalImages = 0;
-
-            if (attrs.feature_image) {
-                additionalImages += 1;
-            }
-
-            attrs.reading_time = readingMinutes(attrs.html, additionalImages);
-        }
-    }
-};
-
-module.exports.forSettings = (attrs, frame) => {
-    const _ = require('lodash');
-    const mapGroupToType = require('./settings-type-group-mapper');
-
-    // @TODO: https://github.com/TryGhost/Ghost/issues/10106
-    // @NOTE: Admin & Content API return a different format, needs two mappers
-    if (_.isArray(attrs)) {
-        attrs.forEach((attr) => {
-            attr.type = mapGroupToType(attr.group);
-        });
-
-        // CASE: read single setting
-        if (frame.original.params && frame.original.params.key) {
-            if (frame.original.params.key === 'ghost_head') {
-                attrs[0].key = 'ghost_head';
-                return;
-            }
-
-            if (frame.original.params.key === 'ghost_foot') {
-                attrs[0].key = 'ghost_foot';
-                return;
-            }
-
-            if (frame.original.params.key === 'active_timezone') {
-                attrs[0].key = 'active_timezone';
-                return;
-            }
-
-            if (frame.original.params.key === 'default_locale') {
-                attrs[0].key = 'default_locale';
-                return;
-            }
-
-            if (frame.original.params.key === 'timezone') {
-                return;
-            }
-
-            if (frame.original.params.key === 'lang') {
-                return;
-            }
-
-            if (frame.original.params.key === 'slack_url'
-                || frame.original.params.key === 'slack_username') {
-                return;
-            }
-
-            if (frame.original.params.key === 'unsplash') {
-                attrs[0].value = JSON.stringify({
-                    isActive: attrs[0].value
-                });
-                return;
-            }
-        }
-        // CASE: edit
-        if (frame.original.body && frame.original.body.settings) {
-            frame.original.body.settings.forEach((setting) => {
-                if (setting.key === 'ghost_head') {
-                    const target = _.find(attrs, {key: 'codeinjection_head'});
-                    target.key = 'ghost_head';
-                } else if (setting.key === 'ghost_foot') {
-                    const target = _.find(attrs, {key: 'codeinjection_foot'});
-                    target.key = 'ghost_foot';
-                } else if (setting.key === 'active_timezone') {
-                    const target = _.find(attrs, {key: 'timezone'});
-                    target.key = 'active_timezone';
-                } else if (setting.key === 'default_locale') {
-                    const target = _.find(attrs, {key: 'lang'});
-                    target.key = 'default_locale';
-                } else if (setting.key === 'slack') {
-                    const slackURL = _.cloneDeep(_.find(attrs, {key: 'slack_url'}));
-                    const slackUsername = _.cloneDeep(_.find(attrs, {key: 'slack_username'}));
-
-                    if (slackURL || slackUsername) {
-                        const slack = slackURL || slackUsername;
-                        slack.key = 'slack';
-                        slack.value = JSON.stringify([{
-                            url: slackURL && slackURL.value,
-                            username: slackUsername && slackUsername.value
-                        }]);
-
-                        attrs.push(slack);
-                    }
-                } else if (setting.key === 'unsplash') {
-                    const target = _.find(attrs, {key: 'unsplash'});
-                    target.value = JSON.stringify({
-                        isActive: target.value
-                    });
-                }
-            });
-
-            return;
-        }
-
-        // CASE: browse all settings, add extra keys and keep deprecated
-        const ghostHead = _.cloneDeep(_.find(attrs, {key: 'codeinjection_head'}));
-        const ghostFoot = _.cloneDeep(_.find(attrs, {key: 'codeinjection_foot'}));
-        const timezone = _.cloneDeep(_.find(attrs, {key: 'timezone'}));
-        const lang = _.cloneDeep(_.find(attrs, {key: 'lang'}));
-        const slackURL = _.cloneDeep(_.find(attrs, {key: 'slack_url'}));
-        const slackUsername = _.cloneDeep(_.find(attrs, {key: 'slack_username'}));
-        const unsplash = _.find(attrs, {key: 'unsplash'});
-
-        if (ghostHead) {
-            ghostHead.key = 'ghost_head';
-            attrs.push(ghostHead);
-        }
-
-        if (ghostFoot) {
-            ghostFoot.key = 'ghost_foot';
-            attrs.push(ghostFoot);
-        }
-
-        if (timezone) {
-            timezone.key = 'active_timezone';
-            attrs.push(timezone);
-        }
-
-        if (lang) {
-            lang.key = 'default_locale';
-            attrs.push(lang);
-        }
-
-        if (slackURL || slackUsername) {
-            const slack = slackURL || slackUsername;
-            slack.key = 'slack';
-            slack.value = [{
-                url: slackURL && slackURL.value,
-                username: slackUsername && slackUsername.value
-            }];
-
-            attrs.push(slack);
-        }
-
-        if (unsplash) {
-            unsplash.value = JSON.stringify({
-                isActive: unsplash.value
-            });
-        }
-    }
-};