ghost 4.47.4 → 5.0.1

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

@@ -61,10 +61,6 @@ module.exports = {
         return require('./members');
     },
 
-    get products() {
-        return require('./products');
-    },
-
     get tiers() {
         return require('./tiers');
     },
@@ -85,8 +81,8 @@ module.exports = {
         return require('./users');
     },
 
-    get preview() {
-        return require('./preview');
+    get previews() {
+        return require('./previews');
     },
 
     get email_post() {
@@ -109,10 +105,6 @@ module.exports = {
         return require('./site');
     },
 
-    get email_previews() {
-        return require('./email-previews');
-    },
-
     get custom_theme_settings() {
         return require('./custom-theme-settings');
     },

package/core/server/api/canary/utils/serializers/output/mappers/index.js

@@ -9,5 +9,6 @@ module.exports = {
     settings: require('./settings'),
     snippets: require('./snippets'),
     tags: require('./tags'),
+    newsletters: require('./newsletters'),
     users: require('./users')
 };

package/core/server/api/canary/utils/serializers/output/mappers/newsletters.js

@@ -0,0 +1,24 @@
+const utils = require('../../../index');
+
+module.exports = (model, frame) => {
+    const jsonModel = model.toJSON(frame.options);
+
+    if (utils.isContentAPI(frame)) {
+        const serialized = {
+            id: jsonModel.id,
+            uuid: jsonModel.uuid,
+            name: jsonModel.name,
+            description: jsonModel.description,
+            slug: jsonModel.slug,
+            subscribe_on_signup: jsonModel.subscribe_on_signup,
+            visibility: jsonModel.visibility,
+            sort_order: jsonModel.sort_order,
+            created_at: jsonModel.created_at,
+            updated_at: jsonModel.updated_at
+        };
+
+        return serialized;
+    }
+
+    return jsonModel;
+};

package/core/server/api/canary/utils/serializers/output/mappers/pages.js

@@ -4,7 +4,7 @@ module.exports = async (model, frame, options) => {
     const jsonModel = await mapPost(model, frame, options);
 
     delete jsonModel.email_subject;
-    delete jsonModel.email_recipient_filter;
+    delete jsonModel.email_segment;
     delete jsonModel.email_only;
     delete jsonModel.newsletter_id;
 

package/core/server/api/canary/utils/serializers/output/mappers/posts.js

@@ -16,7 +16,7 @@ const postsMetaSchema = require('../../../../../../data/schema').tables.posts_me
 const labsService = require('../../../../../../../shared/labs');
 
 const getPostServiceInstance = require('../../../../../../services/posts/posts-service');
-const postsService = getPostServiceInstance('canary');
+const postsService = getPostServiceInstance();
 
 module.exports = async (model, frame, options = {}) => {
     const {tiers: tiersData} = options || {};
@@ -26,6 +26,10 @@ module.exports = async (model, frame, options = {}) => {
 
     const jsonModel = model.toJSON(extendedOptions);
 
+    // Map email_recipient_filter to email_segment
+    jsonModel.email_segment = jsonModel.email_recipient_filter;
+    delete jsonModel.email_recipient_filter;
+
     url.forPost(model.id, jsonModel, frame);
 
     extraAttrs.forPost(frame, model, jsonModel);
@@ -51,14 +55,8 @@ module.exports = async (model, frame, options = {}) => {
     }
 
     if (utils.isContentAPI(frame)) {
-        // Content api v2 still expects page prop
-        if (jsonModel.type === 'page') {
-            jsonModel.page = true;
-        }
         date.forPost(jsonModel);
         gating.forPost(jsonModel, frame);
-
-        delete jsonModel.newsletter_id;
     }
 
     // Transforms post/page metadata to flat structure
@@ -96,6 +94,10 @@ module.exports = async (model, frame, options = {}) => {
             if (relation === 'email' && _.isEmpty(jsonModel.email)) {
                 jsonModel.email = null;
             }
+
+            if (relation === 'newsletter' && _.isEmpty(jsonModel.newsletter)) {
+                jsonModel.newsletter = null;
+            }
         });
     }
 

package/core/server/api/canary/utils/serializers/output/mappers/settings.js

@@ -1,36 +1,10 @@
 const _ = require('lodash');
 
-const extraAttrs = require('../utils/extra-attrs');
-const url = require('../utils/url');
-
-module.exports = (attrs, frame) => {
-    url.forSettings(attrs);
-    extraAttrs.forSettings(attrs, frame);
-
-    // NOTE: The cleanup of deprecated ghost_head/ghost_foot has to happen here
-    //       because codeinjection_head/codeinjection_foot are assigned on a previous
-    //      `forSettings` step. This logic can be rewritten once we get rid of deprecated
-    //      fields completely.
-    if (_.isArray(attrs)) {
-        const keysToFilter = ['ghost_head', 'ghost_foot'];
-
-        // NOTE: to support edits of deprecated 'slack' setting artificial 'slack_url' and 'slack_username'
-        //       were added to the request body in the input serializer. These should not be returned in response
-        //       body unless directly requested
-        if (frame.original.body && frame.original.body.settings) {
-            const requestedEditSlackUrl = frame.original.body.settings.find(s => s.key === 'slack_url');
-            const requestedEditSlackUsername = frame.original.body.settings.find(s => s.key === 'slack_username');
-
-            if (!requestedEditSlackUrl) {
-                keysToFilter.push('slack_url');
-            }
-
-            if (!requestedEditSlackUsername) {
-                keysToFilter.push('slack_username');
-            }
-        }
-
-        attrs = _.filter(attrs, attr => !(keysToFilter.includes(attr.key)));
+module.exports = (attrs) => {
+    if (Array.isArray(attrs)) {
+        return attrs.map((setting) => {
+            return _.pick(setting, ['key', 'value']);
+        });
     }
 
     return attrs;

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

@@ -4,8 +4,6 @@ const {unparse} = require('@tryghost/members-csv');
 const labsService = require('../../../../../../shared/labs');
 
 module.exports = {
-    hasActiveStripeSubscriptions: createSerializer('hasActiveStripeSubscriptions', passthrough),
-
     browse: createSerializer('browse', paginatedMembers),
     read: createSerializer('read', singleMember),
     edit: createSerializer('edit', singleMember),
@@ -79,18 +77,13 @@ function bulkAction(bulkActionResult, _apiConfig, frame) {
 /**
  * @template PageMeta
  *
- * @param {{data: import('bookshelf').Model[], meta: PageMeta}} page
- * @param {APIConfig} _apiConfig
- * @param {Frame} frame
+ * @param {{data: any[]}} data
  *
  * @returns {string} - A CSV string
  */
-function exportCSV(page, _apiConfig, frame) {
+function exportCSV(data) {
     debug('exportCSV');
-
-    const members = page.data.map(model => serializeMember(model, frame.options));
-
-    return unparse(members);
+    return unparse(data.data);
 }
 
 /**
@@ -129,7 +122,24 @@ function serializeMember(member, options) {
     };
 
     if (json.products) {
-        serialized.products = json.products;
+        serialized.tiers = json.products;
+    }
+
+    // Rename subscriptions.price.product to subscriptions.price.tier
+    for (const subscription of serialized.subscriptions) {
+        if (!subscription.price) {
+            continue;
+        }
+        
+        if (!subscription.price.tier && subscription.price.product) {
+            subscription.price.tier = subscription.price.product;
+            
+            if (!subscription.price.tier.tier_id) {
+                subscription.price.tier.tier_id = subscription.price.tier.product_id;
+            }
+            delete subscription.price.tier.product_id;
+        }
+        delete subscription.price.product;
     }
 
     if (labsService.isSet('multipleNewsletters')) {

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

@@ -1,8 +1,16 @@
 const debug = require('@tryghost/debug')('api:canary:utils:serializers:output:offers');
+const utils = require('../../index');
 
 module.exports = {
-    all() {
+    all(_models, _apiConfig, frame) {
         debug('all');
         // Offers has frame.response already set
+
+        // Cleanup response for content API
+        // TODO: remove and set explicit allowlist when moved to mapper
+        if (utils.isContentAPI(frame) && frame.response?.offers?.[0]) {
+            delete frame.response.offers[0].redemption_count;
+            delete frame.response.offers[0].code;
+        }
     }
 };

package/core/server/api/canary/utils/serializers/output/{preview.js → previews.js}

@@ -10,8 +10,8 @@ module.exports = {
 
         const data = await mappers.posts(model, frame, {tiers});
         frame.response = {
-            preview: [data]
+            previews: [data]
         };
-        frame.response.preview[0].page = model.get('type') === 'page';
+        frame.response.previews[0].type = model.get('type');
     }
 };

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

@@ -38,20 +38,14 @@ function serializeSettings(models, apiConfig, frame) {
     }
 
     frame.response = {
-        settings: mappers.settings(filteredSettings, frame),
+        settings: mappers.settings(filteredSettings),
         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;
-        }
+    if (frame.options.group) {
+        frame.response.meta.filters = {
+            group: frame.options.group
+        };
     }
 }
 
@@ -86,7 +80,5 @@ module.exports = {
     download: serializeData,
     upload: serializeData,
 
-    updateMembersEmail: passthrough,
-    validateMembersEmailUpdate: passthrough,
-    disconnectStripeConnectIntegration: passthrough
+    validateMembersEmailUpdate: passthrough
 };

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

@@ -14,7 +14,6 @@ module.exports = {
                 'accent_color',
                 'url',
                 'version',
-                'oauth',
                 'sentry_dsn',
                 'sentry_env'
             ])

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

@@ -1,8 +1,8 @@
 //@ts-check
 const debug = require('@tryghost/debug')('api:canary:utils:serializers:output:tiers');
-const _ = require('lodash');
 
 const allowedIncludes = ['monthly_price', 'yearly_price'];
+const localUtils = require('../../index');
 const utils = require('../../../../shared/utils');
 
 module.exports = {
@@ -22,15 +22,9 @@ module.exports = {
  * @returns {{tiers: SerializedTier[], meta: PageMeta}}
  */
 function paginatedTiers(page, _apiConfig, frame) {
-    const requestedQueryIncludes = frame.original && frame.original.query && frame.original.query.include && frame.original.query.include.split(',') || [];
-    const requestedOptionsIncludes = utils.options.trimAndLowerCase(frame.original && frame.original.options && frame.original.options.include || []);
     return {
         tiers: page.data.map((model) => {
-            return cleanIncludes(
-                allowedIncludes,
-                requestedQueryIncludes.concat(requestedOptionsIncludes),
-                serializeTier(model, frame.options, frame.apiType)
-            );
+            return serializeTier(model, frame.options, frame);
         }),
         meta: page.meta
     };
@@ -44,15 +38,9 @@ function paginatedTiers(page, _apiConfig, frame) {
  * @returns {{tiers: SerializedTier[]}}
  */
 function singleTier(model, _apiConfig, frame) {
-    const requestedQueryIncludes = frame.original && frame.original.query && frame.original.query.include && frame.original.query.include.split(',') || [];
-    const requestedOptionsIncludes = frame.original && frame.original.options && frame.original.options.include || [];
     return {
         tiers: [
-            cleanIncludes(
-                allowedIncludes,
-                requestedQueryIncludes.concat(requestedOptionsIncludes),
-                serializeTier(model, frame.options, frame.apiType)
-            )
+            serializeTier(model, frame.options, frame)
         ]
     };
 }
@@ -60,15 +48,13 @@ function singleTier(model, _apiConfig, frame) {
 /**
  * @param {import('bookshelf').Model} tier
  * @param {object} options
- * @param {'content'|'admin'} apiType
+ * @param {object} frame
  *
  * @returns {SerializedTier}
  */
-function serializeTier(tier, options, apiType) {
+function serializeTier(tier, options, frame) {
     const json = tier.toJSON(options);
 
-    const hideStripeData = apiType === 'content';
-
     const serialized = {
         id: json.id,
         name: json.name,
@@ -79,47 +65,34 @@ function serializeTier(tier, options, apiType) {
         welcome_page_url: json.welcome_page_url,
         created_at: json.created_at,
         updated_at: json.updated_at,
-        stripe_prices: json.stripePrices ? json.stripePrices.map(price => serializeStripePrice(price, hideStripeData)) : null,
-        monthly_price: serializeStripePrice(json.monthlyPrice, hideStripeData),
-        yearly_price: serializeStripePrice(json.yearlyPrice, hideStripeData),
-        benefits: json.benefits || null,
-        visibility: json.visibility
+        visibility: json.visibility,
+        benefits: null
     };
 
-    return serialized;
-}
+    if (Array.isArray(json.benefits)) {
+        serialized.benefits = json.benefits.map(benefit => benefit.name);
+    } else {
+        serialized.benefits = null;
+    }
 
-/**
- * @param {object} data
- * @param {boolean} hideStripeData
- *
- * @returns {StripePrice}
- */
-function serializeStripePrice(data, hideStripeData) {
-    if (_.isEmpty(data)) {
-        return null;
+    if (serialized.type === 'paid') {
+        serialized.currency = json.monthlyPrice?.currency;
+        serialized.monthly_price = json.monthlyPrice?.amount;
+        serialized.yearly_price = json.yearlyPrice?.amount;
     }
-    const price = {
-        id: data.id,
-        stripe_tier_id: data.stripe_product_id,
-        stripe_price_id: data.stripe_price_id,
-        active: data.active,
-        nickname: data.nickname,
-        description: data.description,
-        currency: data.currency,
-        amount: data.amount,
-        type: data.type,
-        interval: data.interval,
-        created_at: data.created_at,
-        updated_at: data.updated_at
-    };
 
-    if (hideStripeData) {
-        delete price.stripe_price_id;
-        delete price.stripe_tier_id;
+    if (!localUtils.isContentAPI(frame)) {
+        const requestedQueryIncludes = frame.original && frame.original.query && frame.original.query.include && frame.original.query.include.split(',') || [];
+        const requestedOptionsIncludes = utils.options.trimAndLowerCase(frame.original && frame.original.options && frame.original.options.include || []);
+
+        return cleanIncludes(
+            allowedIncludes,
+            requestedQueryIncludes.concat(requestedOptionsIncludes),
+            serialized
+        );
     }
 
-    return price;
+    return serialized;
 }
 
 /**
@@ -160,7 +133,7 @@ function createSerializer(debugString, serialize) {
 }
 
 /**
- * @typedef {Object} SerializedTier
+ * @typedef {Object} FreeTier
  * @prop {string} id
  * @prop {string} name
  * @prop {string} slug
@@ -170,34 +143,21 @@ function createSerializer(debugString, serialize) {
  * @prop {string} welcome_page_url
  * @prop {Date} created_at
  * @prop {Date} updated_at
- * @prop {StripePrice} [monthly_price]
- * @prop {StripePrice} [yearly_price]
- * @prop {Benefit[]} [benefits]
+ * @prop {string[]} [benefits]
  */
 
 /**
- * @typedef {object} Benefit
- * @prop {string} id
- * @prop {string} name
- * @prop {string} slug
- * @prop {Date} created_at
- * @prop {Date} updated_at
+ * @typedef {FreeTier} PaidTier
+ * @prop {string} currency
+ * @prop {number} monthly_price
+ * @prop {number} yearly_price
  */
 
 /**
- * @typedef {object} StripePrice
- * @prop {string} id
- * @prop {string|null} stripe_tier_id
- * @prop {string|null} stripe_price_id
- * @prop {boolean} active
- * @prop {string} nickname
- * @prop {string} description
+ * @typedef {FreeTier | PaidTier} SerializedTier
  * @prop {string} currency
- * @prop {number} amount
- * @prop {'recurring'|'one-time'} type
- * @prop {'day'|'week'|'month'|'year'} interval
- * @prop {Date} created_at
- * @prop {Date} updated_at
+ * @prop {number} monthly_price
+ * @prop {number} yearly_price
  */
 
 /**

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

@@ -73,10 +73,10 @@ 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;
+        delete attrs.newsletter;
+        delete attrs.email_segment;
 
         // We are standardising on returning null from the Content API for any empty values
         if (attrs.twitter_title === '') {
@@ -101,16 +101,10 @@ const post = (attrs, frame) => {
         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 (columns && columns.includes('email_segment') && fields && !fields.includes('email_segment')) {
+        delete attrs.email_segment;
     }
 
     if (!attrs.tags) {
@@ -124,6 +118,7 @@ const post = (attrs, frame) => {
     delete attrs.locale;
     delete attrs.author;
     delete attrs.type;
+    delete attrs.newsletter_id;
 
     return attrs;
 };

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

@@ -31,129 +31,3 @@ module.exports.forPost = (frame, model, attrs) => {
         }
     }
 };
-
-module.exports.forSettings = (attrs, frame) => {
-    const _ = require('lodash');
-
-    // @TODO: https://github.com/TryGhost/Ghost/issues/10106
-    // @NOTE: Admin & Content API return a different format, needs two mappers
-    if (_.isArray(attrs)) {
-        // 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;
-            }
-        }
-        // 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 === 'locale') {
-                    const target = _.find(attrs, {key: 'lang'});
-                    target.key = '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);
-                    }
-                }
-            });
-
-            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 locale = _.cloneDeep(_.find(attrs, {key: 'lang'}));
-
-        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 = JSON.stringify([{
-                url: slackURL && slackURL.value,
-                username: slackUsername && slackUsername.value
-            }]);
-
-            attrs.push(slack);
-        }
-
-        if (locale) {
-            locale.key = 'locale';
-            attrs.push(locale);
-        }
-    }
-};

package/core/server/api/canary/utils/serializers/output/utils/post-gating.js

@@ -15,7 +15,7 @@ const forPost = (attrs, frame) => {
 
         if (paywallIndex !== -1) {
             attrs.html = attrs.html.slice(0, paywallIndex);
-            attrs.plaintext = htmlToPlaintext(attrs.html);
+            attrs.plaintext = htmlToPlaintext.excerpt(attrs.html);
 
             if (!attrs.custom_excerpt && attrs.excerpt) {
                 attrs.excerpt = attrs.plaintext.substring(0, 500);

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

@@ -58,10 +58,6 @@ const forTag = (id, attrs, options) => {
     return attrs;
 };
 
-const forSettings = (attrs) => {
-    return attrs;
-};
-
 const forImage = (path) => {
     return urlUtils.urlFor('image', {image: path}, true);
 };
@@ -69,5 +65,4 @@ const forImage = (path) => {
 module.exports.forPost = forPost;
 module.exports.forUser = forUser;
 module.exports.forTag = forTag;
-module.exports.forSettings = forSettings;
 module.exports.forImage = forImage;