ghost 4.47.3 → 5.0.0

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

@@ -1,168 +0,0 @@
-const _ = require('lodash');
-const url = require('./utils/url');
-const typeGroupMapper = require('../../../../shared/serializers/input/utils/settings-filter-type-group-mapper');
-const settingsCache = require('../../../../../../shared/settings-cache');
-
-const DEPRECATED_SETTINGS = [
-    'bulk_email_settings',
-    'slack'
-];
-
-const deprecatedSupportedSettingsOneToManyMap = {
-    slack: [{
-        from: '[0].url',
-        to: {
-            key: 'slack_url',
-            group: 'slack',
-            type: 'string'
-        }
-    }, {
-        from: '[0].username',
-        to: {
-            key: 'slack_username',
-            group: 'slack',
-            type: 'string'
-        }
-    }]
-};
-
-const getMappedDeprecatedSettings = (settings) => {
-    const mappedSettings = [];
-
-    for (const key in deprecatedSupportedSettingsOneToManyMap) {
-        const deprecatedSetting = settings.find(setting => setting.key === key);
-
-        if (deprecatedSetting) {
-            let deprecatedSettingValue;
-
-            try {
-                deprecatedSettingValue = JSON.parse(deprecatedSetting.value);
-            } catch (err) {
-                // ignore the value if it's invalid
-            }
-
-            if (deprecatedSettingValue) {
-                deprecatedSupportedSettingsOneToManyMap[key].forEach(({from, to}) => {
-                    const value = _.get(deprecatedSettingValue, from);
-                    mappedSettings.push({
-                        key: to.key,
-                        value: value
-                    });
-                });
-            }
-        }
-    }
-
-    return mappedSettings;
-};
-
-module.exports = {
-    browse(apiConfig, frame) {
-        if (frame.options.type) {
-            let mappedGroupOptions = typeGroupMapper(frame.options.type);
-
-            if (frame.options.group) {
-                frame.options.group = `${frame.options.group},${mappedGroupOptions}`;
-            } else {
-                frame.options.group = mappedGroupOptions;
-            }
-        }
-    },
-
-    read(apiConfig, frame) {
-        if (frame.options.key === 'ghost_head') {
-            frame.options.key = 'codeinjection_head';
-        }
-
-        if (frame.options.key === 'ghost_foot') {
-            frame.options.key = 'codeinjection_foot';
-        }
-
-        if (frame.options.key === 'active_timezone') {
-            frame.options.key = 'timezone';
-        }
-
-        if (frame.options.key === 'default_locale') {
-            frame.options.key = 'lang';
-        }
-    },
-
-    edit(apiConfig, frame) {
-        // CASE: allow shorthand syntax where a single key and value are passed to edit instead of object and options
-        if (_.isString(frame.data)) {
-            frame.data = {settings: [{key: frame.data, value: frame.options}]};
-        }
-        const settings = settingsCache.getAll();
-
-        frame.data.settings = frame.data.settings.filter((setting) => {
-            const settingFlagsStr = settings[setting.key] ? settings[setting.key].flags : '';
-            const settingFlagsArr = settingFlagsStr ? settingFlagsStr.split(',') : [];
-
-            // Ignore and drop all values with Read-only flag AND 'labs' setting
-            return !settingFlagsArr.includes('RO') && (setting.key !== 'labs');
-        });
-
-        const mappedDeprecatedSettings = getMappedDeprecatedSettings(frame.data.settings);
-        mappedDeprecatedSettings.forEach((setting) => {
-            // NOTE: give priority for non-deprecated setting values if they exist
-            const nonDeprecatedExists = frame.data.settings.find(s => s.key === setting.key);
-
-            if (!nonDeprecatedExists) {
-                frame.data.settings.push(setting);
-            }
-        });
-
-        frame.data.settings.forEach((setting) => {
-            // CASE: transform objects/arrays into string (we store stringified objects in the db)
-            // @TODO: This belongs into the model layer. We should stringify before saving and parse when fetching from db.
-            // @TODO: Fix when dropping v0.1
-            const settingType = settings[setting.key] ? settings[setting.key].type : '';
-
-            //TODO: Needs to be removed once we get rid of all `object` type settings
-            // NOTE: this transformation is more related to the fact that internal API calls call
-            //       settings API with plain objects instead of stringified ones
-            if (_.isObject(setting.value)) {
-                setting.value = JSON.stringify(setting.value);
-            }
-
-            // @TODO: handle these transformations in a centralized API place (these rules should apply for ALL resources)
-
-            // CASE: Ensure we won't forward strings, otherwise model events or model interactions can fail
-            if (settingType === 'boolean' && (setting.value === '0' || setting.value === '1')) {
-                setting.value = !!+setting.value;
-            }
-
-            // CASE: Ensure we won't forward strings, otherwise model events or model interactions can fail
-            if (settingType === 'boolean' && (setting.value === 'false' || setting.value === 'true')) {
-                setting.value = setting.value === 'true';
-            }
-
-            if (setting.key === 'ghost_head') {
-                setting.key = 'codeinjection_head';
-            }
-
-            if (setting.key === 'ghost_foot') {
-                setting.key = 'codeinjection_foot';
-            }
-
-            if (setting.key === 'active_timezone') {
-                setting.key = 'timezone';
-            }
-
-            if (setting.key === 'default_locale') {
-                setting.key = 'lang';
-            }
-
-            if (setting.key === 'unsplash') {
-                setting.value = JSON.parse(setting.value).isActive;
-            }
-
-            setting = url.forSetting(setting);
-        });
-
-        // Ignore all deprecated settings
-        frame.data.settings = frame.data.settings.filter((setting) => {
-            return DEPRECATED_SETTINGS.includes(setting.key) === false;
-        });
-    }
-};

package/core/server/api/v3/utils/serializers/input/tags.js

@@ -1,42 +0,0 @@
-const debug = require('@tryghost/debug')('api:v3:utils:serializers:input:tags');
-const url = require('./utils/url');
-const slugFilterOrder = require('./utils/slug-filter-order');
-const utils = require('../../index');
-
-function setDefaultOrder(frame) {
-    let defaultOrder = 'name asc';
-
-    if (!frame.options.order && frame.options.filter) {
-        frame.options.autoOrder = slugFilterOrder('tags', frame.options.filter);
-    }
-
-    if (!frame.options.order && !frame.options.autoOrder) {
-        frame.options.order = defaultOrder;
-    }
-}
-
-module.exports = {
-    browse(apiConfig, frame) {
-        debug('browse');
-
-        if (utils.isContentAPI(frame)) {
-            setDefaultOrder(frame);
-        }
-    },
-
-    read() {
-        debug('read');
-
-        this.browse(...arguments);
-    },
-
-    add(apiConfig, frame) {
-        debug('add');
-        frame.data.tags[0] = url.forTag(Object.assign({}, frame.data.tags[0]));
-    },
-
-    edit(apiConfig, frame) {
-        debug('edit');
-        this.add(apiConfig, frame);
-    }
-};

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

@@ -1,26 +0,0 @@
-const debug = require('@tryghost/debug')('api:v3:utils:serializers:input:users');
-const url = require('./utils/url');
-
-module.exports = {
-    read(apiConfig, frame) {
-        debug('read');
-
-        if (frame.data.id === 'me' && frame.options.context && frame.options.context.user) {
-            frame.data.id = frame.options.context.user;
-        }
-    },
-
-    edit(apiConfig, frame) {
-        debug('edit');
-
-        if (frame.options.id === 'me' && frame.options.context && frame.options.context.user) {
-            frame.options.id = frame.options.context.user;
-        }
-
-        if (frame.data.users[0].password) {
-            delete frame.data.users[0].password;
-        }
-
-        frame.data.users[0] = url.forUser(Object.assign({}, frame.data.users[0]));
-    }
-};

package/core/server/api/v3/utils/serializers/input/utils/slug-filter-order.js

@@ -1,18 +0,0 @@
-const slugFilterOrder = (table, filter) => {
-    let orderMatch = filter.match(/slug:\s?\[(.*)\]/);
-
-    if (orderMatch) {
-        let orderSlugs = orderMatch[1].split(',');
-        let order = 'CASE ';
-
-        orderSlugs.forEach((slug, index) => {
-            order += `WHEN \`${table}\`.\`slug\` = '${slug}' THEN ${index} `;
-        });
-
-        order += 'END ASC';
-
-        return order;
-    }
-};
-
-module.exports = slugFilterOrder;

package/core/server/api/v3/utils/serializers/input/utils/url.js

@@ -1,71 +0,0 @@
-const urlUtils = require('../../../../../../../shared/url-utils');
-
-const handleImageUrl = (imageUrl) => {
-    try {
-        const imageURL = new URL(imageUrl, urlUtils.getSiteUrl());
-        const siteURL = new URL(urlUtils.getSiteUrl());
-        const subdir = siteURL.pathname.replace(/\/$/, '');
-        const imagePathRe = new RegExp(`${subdir}/${urlUtils.STATIC_IMAGE_URL_PREFIX}`);
-
-        if (imagePathRe.test(imageURL.pathname)) {
-            return urlUtils.relativeToAbsolute(imageUrl);
-        }
-
-        return imageUrl;
-    } catch (e) {
-        return imageUrl;
-    }
-};
-
-const forPost = (attrs, options) => {
-    if (options && options.withRelated) {
-        options.withRelated.forEach((relation) => {
-            if (relation === 'tags' && attrs.tags) {
-                attrs.tags = attrs.tags.map(tag => forTag(tag));
-            }
-
-            if (relation === 'author' && attrs.author) {
-                attrs.author = forUser(attrs.author, options);
-            }
-
-            if (relation === 'authors' && attrs.authors) {
-                attrs.authors = attrs.authors.map(author => forUser(author, options));
-            }
-        });
-    }
-
-    return attrs;
-};
-
-const forUser = (attrs) => {
-    if (attrs.profile_image) {
-        attrs.profile_image = handleImageUrl(attrs.profile_image);
-    }
-
-    if (attrs.cover_image) {
-        attrs.cover_image = handleImageUrl(attrs.cover_image);
-    }
-
-    return attrs;
-};
-
-const forTag = (attrs) => {
-    if (attrs.feature_image) {
-        attrs.feature_image = handleImageUrl(attrs.feature_image);
-    }
-
-    return attrs;
-};
-
-const forSetting = (attrs) => {
-    if (attrs.value && ['cover_image', 'logo', 'icon', 'portal_button_icon', 'og_image', 'twitter_image'].includes(attrs.key)) {
-        attrs.value = urlUtils.relativeToAbsolute(attrs.value);
-    }
-
-    return attrs;
-};
-
-module.exports.forPost = forPost;
-module.exports.forUser = forUser;
-module.exports.forTag = forTag;
-module.exports.forSetting = forSetting;

package/core/server/api/v3/utils/serializers/input/webhooks.js

@@ -1,12 +0,0 @@
-const _ = require('lodash');
-const debug = require('@tryghost/debug')('api:v3:utils:serializers:input:webhooks');
-
-module.exports = {
-    add(apiConfig, frame) {
-        debug('add');
-
-        if (_.get(frame, 'options.context.integration.id')) {
-            frame.data.webhooks[0].integration_id = frame.options.context.integration.id;
-        }
-    }
-};

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

@@ -1,13 +0,0 @@
-const debug = require('@tryghost/debug')('api:v3:utils:serializers:output:actions');
-const mapper = require('./utils/mapper');
-
-module.exports = {
-    browse(models, apiConfig, frame) {
-        debug('browse');
-
-        frame.response = {
-            actions: models.data.map(model => mapper.mapAction(model, frame)),
-            meta: models.meta
-        };
-    }
-};

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

@@ -1,25 +0,0 @@
-const debug = require('@tryghost/debug')('api:v3:utils:serializers:output:all');
-const _ = require('lodash');
-
-const removeXBY = (object) => {
-    _.each(object, (value, key) => {
-        // CASE: go deeper
-        if (_.isObject(value) || _.isArray(value)) {
-            removeXBY(value);
-        } else if (['updated_by', 'created_by', 'published_by'].includes(key)) {
-            delete object[key];
-        }
-    });
-
-    return object;
-};
-
-module.exports = {
-    after(apiConfig, frame) {
-        debug('all after');
-
-        if (frame.response) {
-            frame.response = removeXBY(frame.response);
-        }
-    }
-};

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

@@ -1,69 +0,0 @@
-const tpl = require('@tryghost/tpl');
-const mapper = require('./utils/mapper');
-const debug = require('@tryghost/debug')('api:v3:utils:serializers:output:authentication');
-
-const messages = {
-    checkEmailForInstructions: 'Check your email for further instructions.',
-    passwordChanged: 'Password changed successfully.',
-    invitationAccepted: 'Invitation accepted.'
-};
-
-module.exports = {
-    setup(user, apiConfig, frame) {
-        frame.response = {
-            users: [
-                mapper.mapUser(user, {options: {context: {internal: true}}})
-            ]
-        };
-    },
-
-    updateSetup(user, apiConfig, frame) {
-        frame.response = {
-            users: [
-                mapper.mapUser(user, {options: {context: {internal: true}}})
-            ]
-        };
-    },
-
-    isSetup(data, apiConfig, frame) {
-        frame.response = {
-            setup: [data]
-        };
-    },
-
-    generateResetToken(data, apiConfig, frame) {
-        frame.response = {
-            passwordreset: [{
-                message: tpl(messages.checkEmailForInstructions)
-            }]
-        };
-    },
-
-    resetPassword(data, apiConfig, frame) {
-        frame.response = {
-            passwordreset: [{
-                message: tpl(messages.passwordChanged)
-            }]
-        };
-    },
-
-    acceptInvitation(data, apiConfig, frame) {
-        debug('acceptInvitation');
-
-        frame.response = {
-            invitation: [
-                {message: tpl(messages.invitationAccepted)}
-            ]
-        };
-    },
-
-    isInvitation(data, apiConfig, frame) {
-        debug('acceptInvitation');
-
-        frame.response = {
-            invitation: [{
-                valid: !!data
-            }]
-        };
-    }
-};

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

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

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

@@ -1,25 +0,0 @@
-const _ = require('lodash');
-const debug = require('@tryghost/debug')('api:v3:utils:serializers:output:config');
-
-module.exports = {
-    all(data, apiConfig, frame) {
-        debug('all');
-
-        frame.response = {
-            config: _.pick(data, [
-                'version',
-                'environment',
-                'database',
-                'mail',
-                'useGravatar',
-                'labs',
-                'clientExtensions',
-                'enableDeveloperExperiments',
-                'stripeDirect',
-                'mailgunIsConfigured',
-                'emailAnalytics',
-                'billingUrl'
-            ])
-        };
-    }
-};

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

@@ -1,40 +0,0 @@
-const debug = require('@tryghost/debug')('api:v3:utils:serializers:output:db');
-
-module.exports = {
-    backupContent(filename, apiConfig, frame) {
-        debug('backupContent');
-
-        frame.response = {
-            db: [{filename: filename}]
-        };
-    },
-
-    exportContent(exportedData, apiConfig, frame) {
-        debug('exportContent');
-
-        frame.response = {
-            db: [exportedData]
-        };
-    },
-
-    importContent(response, apiConfig, frame) {
-        debug('importContent');
-
-        // NOTE: response can contain 2 objects if images are imported
-        const problems = (response.length === 2)
-            ? response[1].problems
-            : response[0].problems;
-
-        frame.response = {
-            db: [],
-            problems: problems
-        };
-    },
-
-    deleteAllContent(response, apiConfig, frame) {
-        frame.response = {
-            db: []
-        };
-    }
-};
-

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

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

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

@@ -1,13 +0,0 @@
-const mapper = require('./utils/mapper');
-
-module.exports = {
-    read(email, apiConfig, frame) {
-        frame.response = {
-            emails: [mapper.mapEmail(email, frame)]
-        };
-    },
-
-    get retry() {
-        return this.read;
-    }
-};

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

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

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

@@ -1,19 +0,0 @@
-const debug = require('@tryghost/debug')('api:v3:utils:serializers:output:images');
-const mapper = require('./utils/mapper');
-
-module.exports = {
-    upload(path, apiConfig, frame) {
-        debug('upload');
-
-        return frame.response = {
-            images: [{
-                url: mapper.mapImage(path),
-                // NOTE: ref field is here to have reference point on the client
-                //       for example when substituting existing images in the mobiledoc
-                //       this field would serve as an identifier to find images to replace
-                //       once the response is back. Think of it as ID on the client's side.
-                ref: frame.data.ref || null
-            }]
-        };
-    }
-};