ghost 4.48.0 → 5.0.2

package/core/server/api/canary/settings.js

@@ -4,7 +4,7 @@ const models = require('../../models');
 const routeSettings = require('../../services/route-settings');
 const tpl = require('@tryghost/tpl');
 const {BadRequestError} = require('@tryghost/errors');
-const settingsService = require('../../services/settings');
+const settingsService = require('../../services/settings/settings-service');
 const membersService = require('../../services/members');
 const stripeService = require('../../services/stripe');
 
@@ -12,9 +12,23 @@ const settingsBREADService = settingsService.getSettingsBREADServiceInstance();
 
 const messages = {
     failedSendingEmail: 'Failed Sending Email'
-    
+
 };
 
+async function getStripeConnectData(frame) {
+    const stripeConnectIntegrationToken = frame.data.settings.find(setting => setting.key === 'stripe_connect_integration_token');
+
+    if (stripeConnectIntegrationToken && stripeConnectIntegrationToken.value) {
+        const getSessionProp = prop => frame.original.session[prop];
+
+        return await settingsBREADService.getStripeConnectData(
+            stripeConnectIntegrationToken,
+            getSessionProp,
+            membersService.stripeConnect.getStripeConnectTokenData
+        );
+    }
+}
+
 module.exports = {
     docName: 'settings',
 
@@ -57,7 +71,7 @@ module.exports = {
                     required: true
                 },
                 action: {
-                    values: ['fromaddressupdate', 'supportaddressupdate']
+                    values: ['supportaddressupdate']
                 }
             }
         },
@@ -68,7 +82,6 @@ module.exports = {
                     const {token, action} = frame.options;
                     const updatedEmailAddress = await membersService.settings.getEmailFromToken({token});
                     const actionToKeyMapping = {
-                        fromAddressUpdate: 'members_from_address',
                         supportAddressUpdate: 'members_support_address'
                     };
                     if (updatedEmailAddress) {
@@ -96,6 +109,7 @@ module.exports = {
     },
 
     updateMembersEmail: {
+        statusCode: 204,
         permissions: {
             method: 'edit'
         },
@@ -122,12 +136,13 @@ module.exports = {
     },
 
     disconnectStripeConnectIntegration: {
+        statusCode: 204,
         permissions: {
             method: 'edit'
         },
         async query(frame) {
-            const hasActiveStripeSubscriptions = await membersService.api.hasActiveStripeSubscriptions();
-            if (hasActiveStripeSubscriptions) {
+            const paidMembers = await membersService.api.memberBREADService.browse({limit: 0, filter: 'status:paid'});
+            if (_.get(paidMembers, 'meta.pagination.total') !== 0) {
                 throw new BadRequestError({
                     message: 'Cannot disconnect Stripe whilst you have active subscriptions.'
                 });
@@ -170,20 +185,19 @@ module.exports = {
             }
         },
         async query(frame) {
-            let stripeConnectData;
-            const stripeConnectIntegrationToken = frame.data.settings.find(setting => setting.key === 'stripe_connect_integration_token');
+            let stripeConnectData = await getStripeConnectData(frame);
 
-            if (stripeConnectIntegrationToken && stripeConnectIntegrationToken.value) {
-                const getSessionProp = prop => frame.original.session[prop];
+            let result = await settingsBREADService.edit(frame.data.settings, frame.options, stripeConnectData);
 
-                stripeConnectData = await settingsBREADService.getStripeConnectData(
-                    stripeConnectIntegrationToken,
-                    getSessionProp,
-                    membersService.stripeConnect.getStripeConnectTokenData
-                );
+            if (_.isEmpty(result)) {
+                this.headers.cacheInvalidate = false;
+            } else {
+                this.headers.cacheInvalidate = true;
             }
 
-            return await settingsBREADService.edit(frame.data.settings, frame.options, stripeConnectData);
+            // We need to return all settings here, because we have calculated settings that might change
+            const browse = await settingsBREADService.browse(frame.options.context);
+            return browse;
         }
     },
 

package/core/server/api/canary/utils/index.js

@@ -26,9 +26,7 @@ module.exports = {
         return frame.apiType === 'content';
     },
 
-    // @TODO: Remove, not used.
-    isAdminAPIKey: (frame) => {
-        return frame.options.context && Object.keys(frame.options.context).length !== 0 && frame.options.context.api_key &&
-            frame.options.context.api_key.type === 'admin';
+    isInternal: (frame) => {
+        return frame.options.context && frame.options.context.internal;
     }
 };

package/core/server/api/canary/utils/serializers/input/index.js

@@ -39,10 +39,6 @@ module.exports = {
         return require('./media');
     },
 
-    get products() {
-        return require('./products');
-    },
-
     get tiers() {
         return require('./tiers');
     },

package/core/server/api/canary/utils/serializers/input/members.js

@@ -1,7 +1,6 @@
 const _ = require('lodash');
 const debug = require('@tryghost/debug')('api:canary:utils:serializers:input:members');
 const mapNQLKeyValues = require('@tryghost/nql').utils.mapKeyValues;
-const labsService = require('../../../../../../shared/labs');
 
 function defaultRelations(frame) {
     if (frame.options.withRelated) {
@@ -15,30 +14,45 @@ function defaultRelations(frame) {
     frame.options.withRelated = ['labels'];
 }
 
+// @TODO: move this into the member repository in members-api
+function mapSubscribedFlagToNewsletterRelation(frame) {
+    frame.options.mongoTransformer = mapNQLKeyValues({
+        key: {
+            from: 'subscribed',
+            to: 'newsletters.status'
+        },
+        values: [{
+            from: true,
+            to: 'active'
+        }, {
+            from: false,
+            to: {$ne: 'active'}
+        }]
+    });
+}
+
 module.exports = {
+    all(_apiConfig, frame) {
+        if (!frame.options.withRelated) {
+            return;
+        }
+
+        frame.options.withRelated = frame.options.withRelated.map((relation) => {
+            if (relation === 'tiers') {
+                return 'products';
+            }
+            return relation;
+        });
+    },
+
     browse(apiConfig, frame) {
         debug('browse');
         defaultRelations(frame);
+        mapSubscribedFlagToNewsletterRelation(frame);
 
         if (!frame.options.order) {
             frame.options.autoOrder = 'created_at DESC, id DESC';
         }
-
-        if (labsService.isSet('multipleNewsletters')) {
-            frame.options.mongoTransformer = mapNQLKeyValues({
-                key: {
-                    from: 'subscribed',
-                    to: 'newsletters.status'
-                },
-                values: [{
-                    from: true,
-                    to: 'active'
-                }, {
-                    from: false,
-                    to: {$ne: 'active'}
-                }]
-            });
-        }
     },
 
     read() {
@@ -64,6 +78,11 @@ module.exports = {
                 }
             });
         }
+
+        if (frame.data.members[0].tiers) {
+            frame.data.members[0].products = frame.data.members[0].tiers;
+        }
+
         defaultRelations(frame);
     },
 
@@ -86,5 +105,15 @@ module.exports = {
             frame.data.labels = frame.data.labels.map(name => ({name}));
             return;
         }
+    },
+
+    bulkEdit(apiConfig, frame) {
+        debug('bulkEdit');
+        mapSubscribedFlagToNewsletterRelation(frame);
+    },
+
+    bulkDestroy(apiConfig, frame) {
+        debug('bulkDestroy');
+        mapSubscribedFlagToNewsletterRelation(frame);
     }
 };

package/core/server/api/canary/utils/serializers/input/pages.js

@@ -1,26 +1,11 @@
 const _ = require('lodash');
 const debug = require('@tryghost/debug')('api:canary:utils:serializers:input:pages');
-const mapNQLKeyValues = require('@tryghost/nql').utils.mapKeyValues;
 const mobiledoc = require('../../../../../lib/mobiledoc');
 const url = require('./utils/url');
 const slugFilterOrder = require('./utils/slug-filter-order');
 const localUtils = require('../../index');
 const postsMetaSchema = require('../../../../../data/schema').tables.posts_meta;
 
-const replacePageWithType = mapNQLKeyValues({
-    key: {
-        from: 'page',
-        to: 'type'
-    },
-    values: [{
-        from: false,
-        to: 'post'
-    }, {
-        from: true,
-        to: 'page'
-    }]
-});
-
 function removeMobiledocFormat(frame) {
     if (frame.options.formats && frame.options.formats.includes('mobiledoc')) {
         frame.options.formats = frame.options.formats.filter((format) => {
@@ -119,8 +104,6 @@ module.exports = {
             defaultFormat(frame);
             defaultRelations(frame);
         }
-
-        frame.options.mongoTransformer = replacePageWithType;
     },
 
     read(apiConfig, frame) {

package/core/server/api/canary/utils/serializers/input/posts.js

@@ -1,26 +1,11 @@
 const _ = require('lodash');
 const debug = require('@tryghost/debug')('api:canary:utils:serializers:input:posts');
-const mapNQLKeyValues = require('@tryghost/nql').utils.mapKeyValues;
 const url = require('./utils/url');
 const slugFilterOrder = require('./utils/slug-filter-order');
 const localUtils = require('../../index');
 const mobiledoc = require('../../../../../lib/mobiledoc');
 const postsMetaSchema = require('../../../../../data/schema').tables.posts_meta;
 
-const replacePageWithType = mapNQLKeyValues({
-    key: {
-        from: 'page',
-        to: 'type'
-    },
-    values: [{
-        from: false,
-        to: 'post'
-    }, {
-        from: true,
-        to: 'page'
-    }]
-});
-
 function removeMobiledocFormat(frame) {
     if (frame.options.formats && frame.options.formats.includes('mobiledoc')) {
         frame.options.formats = frame.options.formats.filter((format) => {
@@ -38,7 +23,7 @@ function defaultRelations(frame) {
         return false;
     }
 
-    frame.options.withRelated = ['tags', 'authors', 'authors.roles', 'email', 'tiers'];
+    frame.options.withRelated = ['tags', 'authors', 'authors.roles', 'email', 'tiers', 'newsletter'];
 }
 
 function setDefaultOrder(frame) {
@@ -102,15 +87,6 @@ const forceStatusFilter = (frame) => {
     }
 };
 
-const transformLegacyEmailRecipientFilters = (frame) => {
-    if (frame.options.email_recipient_filter === 'free') {
-        frame.options.email_recipient_filter = 'status:free';
-    }
-    if (frame.options.email_recipient_filter === 'paid') {
-        frame.options.email_recipient_filter = 'status:-free';
-    }
-};
-
 module.exports = {
     browse(apiConfig, frame) {
         debug('browse');
@@ -136,8 +112,6 @@ module.exports = {
             defaultFormat(frame);
             defaultRelations(frame);
         }
-
-        frame.options.mongoTransformer = replacePageWithType;
     },
 
     read(apiConfig, frame) {
@@ -205,7 +179,6 @@ module.exports = {
             });
         }
 
-        transformLegacyEmailRecipientFilters(frame);
         handlePostsMeta(frame);
         defaultFormat(frame);
         defaultRelations(frame);

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

@@ -1,134 +1,82 @@
 const _ = require('lodash');
 const url = require('./utils/url');
-const typeGroupMapper = require('../../../../shared/serializers/input/utils/settings-filter-type-group-mapper');
+const localUtils = require('../../index');
 const settingsCache = require('../../../../../../shared/settings-cache');
 const {WRITABLE_KEYS_ALLOWLIST} = require('../../../../../../shared/labs');
 
-const DEPRECATED_SETTINGS = [
-    'bulk_email_settings',
-    'slack'
+const EDITABLE_SETTINGS = [
+    'title',
+    'description',
+    'logo',
+    'cover_image',
+    'icon',
+    'locale',
+    'timezone',
+    'codeinjection_head',
+    'codeinjection_foot',
+    'facebook',
+    'twitter',
+    'navigation',
+    'secondary_navigation',
+    'meta_title',
+    'meta_description',
+    'og_image',
+    'og_title',
+    'og_description',
+    'twitter_image',
+    'twitter_title',
+    'twitter_description',
+    'is_private',
+    'password',
+    'default_content_visibility',
+    'default_content_visibility_tiers',
+    'members_signup_access',
+    'stripe_secret_key',
+    'stripe_publishable_key',
+    'stripe_connect_integration_token',
+    'portal_name',
+    'portal_button',
+    'portal_plans',
+    'portal_button_style',
+    'firstpromoter',
+    'firstpromoter_id',
+    'portal_button_icon',
+    'portal_button_signup_text',
+    'mailgun_api_key',
+    'mailgun_domain',
+    'mailgun_base_url',
+    'email_track_opens',
+    'amp',
+    'amp_gtag_id',
+    'slack_url',
+    'slack_username',
+    'unsplash',
+    'shared_views',
+    'accent_color',
+    'editor_default_email_recipients',
+    'editor_default_email_recipients_filter',
+    'labs'
 ];
 
-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';
-        }
-
-        if (frame.options.key === '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();
 
-        // Ignore and drop all values with Read-only flag
-        frame.data.settings = frame.data.settings.filter((setting) => {
-            const settingFlagsStr = settings[setting.key] ? settings[setting.key].flags : '';
-            const settingFlagsArr = settingFlagsStr ? settingFlagsStr.split(',') : [];
-            return !settingFlagsArr.includes('RO');
-        });
-
-        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);
+        const settings = settingsCache.getAll();
 
-            if (!nonDeprecatedExists) {
-                frame.data.settings.push(setting);
-            }
-        });
+        if (!localUtils.isInternal(frame)) {
+            // Ignore and drop all values not in the EDITABLE_SETTINGS list unless this is an internal request
+            frame.data.settings = frame.data.settings.filter((setting) => {
+                return EDITABLE_SETTINGS.includes(setting.key);
+            });
+        }
 
         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
@@ -141,26 +89,7 @@ module.exports = {
                 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 === 'locale') {
-                setting.key = 'lang';
-            }
-
+            // CASE: filter labs to allowlist
             if (setting.key === 'labs') {
                 const inputLabsValue = JSON.parse(setting.value);
                 const filteredLabsValue = {};
@@ -176,15 +105,5 @@ module.exports = {
 
             setting = url.forSetting(setting);
         });
-
-        // Ignore all deprecated settings
-        frame.data.settings = frame.data.settings.filter((setting) => {
-            // NOTE: ignore old unsplash object notation
-            if (setting.key === 'unsplash' && _.isObject(setting.value)) {
-                return true;
-            }
-
-            return DEPRECATED_SETTINGS.includes(setting.key) === false;
-        });
     }
 };

package/core/server/api/canary/utils/serializers/input/tiers.js

@@ -8,12 +8,63 @@ const forceActiveFilter = (frame) => {
     }
 };
 
+function convertTierInput(input) {
+    const converted = {
+        id: input.id,
+        name: input.name,
+        description: input.description,
+        slug: input.slug,
+        active: input.active,
+        type: input.type,
+        welcome_page_url: input.welcome_page_url,
+        created_at: input.created_at,
+        updated_at: input.updated_at,
+        visibility: input.visibility
+    };
+
+    if (input.monthly_price && input.currency) {
+        converted.monthly_price = {
+            amount: input.monthly_price,
+            currency: input.currency
+        };
+    }
+
+    if (input.yearly_price && input.currency) {
+        converted.yearly_price = {
+            amount: input.yearly_price,
+            currency: input.currency
+        };
+    }
+
+    if (input.benefits) {
+        converted.benefits = input.benefits.map(name => ({name}));
+    }
+
+    return converted;
+}
+
 module.exports = {
     all(_apiConfig, frame) {
+        if (localUtils.isContentAPI(frame)) {
+            // CASE: content api can only have active tiers
+            forceActiveFilter(frame);
+
+            // CASE: content api includes these by default
+            const defaultRelations = ['monthly_price', 'yearly_price', 'benefits'];
+            if (!frame.options.withRelated) {
+                frame.options.withRelated = defaultRelations;
+            } else {
+                for (const relation of defaultRelations) {
+                    if (!frame.options.withRelated.includes(relation)) {
+                        frame.options.withRelated.push(relation);
+                    }
+                }
+            }
+        }
+
         if (!frame.options.withRelated) {
             return;
         }
-
         frame.options.withRelated = frame.options.withRelated.map((relation) => {
             if (relation === 'stripe_prices') {
                 return 'stripePrices';
@@ -28,26 +79,19 @@ module.exports = {
         });
     },
 
-    browse(_apiConfig, frame) {
-        if (localUtils.isContentAPI(frame)) {
-            // CASE: content api can only has active tiers
-            forceActiveFilter(frame);
-        }
-    },
-
     add(_apiConfig, frame) {
         if (frame.data.products) {
-            frame.data = frame.data.products[0];
+            frame.data = convertTierInput(frame.data.products[0]);
             return;
         }
-        frame.data = frame.data.tiers[0];
+        frame.data = convertTierInput(frame.data.tiers[0]);
     },
 
     edit(_apiConfig, frame) {
         if (frame.data.products) {
-            frame.data = frame.data.products[0];
+            frame.data = convertTierInput(frame.data.products[0]);
             return;
         }
-        frame.data = frame.data.tiers[0];
+        frame.data = convertTierInput(frame.data.tiers[0]);
     }
 };

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

@@ -33,7 +33,7 @@ module.exports = {
 
     generateResetToken(data, apiConfig, frame) {
         frame.response = {
-            passwordreset: [{
+            password_reset: [{
                 message: tpl(messages.checkEmailForInstructions)
             }]
         };
@@ -41,16 +41,12 @@ module.exports = {
 
     resetPassword(data, apiConfig, frame) {
         frame.response = {
-            passwordreset: [{
+            password_reset: [{
                 message: tpl(messages.passwordChanged)
             }]
         };
     },
 
-    resetAllPasswords(data, apiConfig, frame) {
-        frame.response = data;
-    },
-
     acceptInvitation(data, apiConfig, frame) {
         debug('acceptInvitation');