ghost 4.38.1 → 4.40.0

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

@@ -25,7 +25,6 @@ const sign = async (claims, options) => {
 
 module.exports = {
     docName: 'identities',
-    permissions: true,
     read: {
         permissions: true,
         async query(frame) {

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

@@ -58,7 +58,13 @@ module.exports = {
             'include'
         ],
         permissions: true,
-        validation: {},
+        validation: {
+            options: {
+                include: {
+                    values: allowedIncludes
+                }
+            }
+        },
         async query(frame) {
             const page = await membersService.api.memberBREADService.browse(frame.options);
 

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

@@ -54,7 +54,9 @@ module.exports = {
                 }
             }
         },
-        permissions: true,
+        permissions: {
+            docName: 'products'
+        },
         async query(frame) {
             const model = await membersService.api.productRepository.get(frame.data, frame.options);
 

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

@@ -1,6 +1,6 @@
 const _ = require('lodash');
 const debug = require('@tryghost/debug')('api:canary:utils:serializers:input:pages');
-const mapNQLKeyValues = require('@nexes/nql').utils.mapKeyValues;
+const mapNQLKeyValues = require('@tryghost/nql').utils.mapKeyValues;
 const mobiledoc = require('../../../../../lib/mobiledoc');
 const url = require('./utils/url');
 const slugFilterOrder = require('./utils/slug-filter-order');

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

@@ -1,6 +1,6 @@
 const _ = require('lodash');
 const debug = require('@tryghost/debug')('api:canary:utils:serializers:input:posts');
-const mapNQLKeyValues = require('@nexes/nql').utils.mapKeyValues;
+const mapNQLKeyValues = require('@tryghost/nql').utils.mapKeyValues;
 const url = require('./utils/url');
 const slugFilterOrder = require('./utils/slug-filter-order');
 const localUtils = require('../../index');

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

@@ -1,3 +1,13 @@
+const localUtils = require('../../index');
+
+const forceActiveFilter = (frame) => {
+    if (frame.options.filter) {
+        frame.options.filter = `(${frame.options.filter})+active:true`;
+    } else {
+        frame.options.filter = 'active:true';
+    }
+};
+
 module.exports = {
     all(_apiConfig, frame) {
         if (!frame.options.withRelated) {
@@ -18,6 +28,13 @@ 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];

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

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

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

@@ -1,5 +1,5 @@
 const tpl = require('@tryghost/tpl');
-const mapper = require('./utils/mapper');
+const mappers = require('./mappers');
 const debug = require('@tryghost/debug')('api:canary:utils:serializers:output:authentication');
 
 const messages = {
@@ -12,7 +12,7 @@ module.exports = {
     setup(user, apiConfig, frame) {
         frame.response = {
             users: [
-                mapper.mapUser(user, {options: {context: {internal: true}}})
+                mappers.users(user, {options: {context: {internal: true}}})
             ]
         };
     },
@@ -20,7 +20,7 @@ module.exports = {
     updateSetup(user, apiConfig, frame) {
         frame.response = {
             users: [
-                mapper.mapUser(user, {options: {context: {internal: true}}})
+                mappers.users(user, {options: {context: {internal: true}}})
             ]
         };
     },

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

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

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

@@ -1,4 +1,4 @@
-const mapper = require('./utils/mapper');
+const mappers = require('./mappers');
 const gating = require('./utils/post-gating');
 const membersService = require('../../../../../services/members');
 
@@ -9,7 +9,7 @@ module.exports = {
         });
         const tiers = tiersModels.data && tiersModels.data.map(tierModel => tierModel.toJSON());
 
-        const emailPost = await mapper.mapPost(model, frame, {tiers});
+        const emailPost = await mappers.posts(model, frame, {tiers});
         gating.forPost(emailPost, frame);
 
         frame.response = {

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

@@ -1,15 +1,15 @@
-const mapper = require('./utils/mapper');
+const mappers = require('./mappers');
 
 module.exports = {
     read(email, apiConfig, frame) {
         frame.response = {
-            emails: [mapper.mapEmail(email, frame)]
+            emails: [mappers.emails(email, frame)]
         };
     },
 
     browse(page, apiConfig, frame) {
         const data = {
-            emails: page.data.map(model => mapper.mapEmail(model, frame)),
+            emails: page.data.map(model => mappers.emails(model, frame)),
             meta: page.meta
         };
 

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

@@ -1,5 +1,5 @@
 const debug = require('@tryghost/debug')('api:canary:utils:serializers:output:images');
-const mapper = require('./utils/mapper');
+const mappers = require('./mappers');
 
 module.exports = {
     upload(path, apiConfig, frame) {
@@ -7,7 +7,7 @@ module.exports = {
 
         return frame.response = {
             images: [{
-                url: mapper.mapImage(path),
+                url: mappers.images(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

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

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

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

@@ -1,5 +1,5 @@
 const debug = require('@tryghost/debug')('api:canary:utils:serializers:output:labels');
-const mapper = require('./utils/mapper');
+const mappers = require('./mappers');
 
 module.exports = {
     all(models, apiConfig, frame) {
@@ -11,7 +11,7 @@ module.exports = {
 
         if (models.meta) {
             frame.response = {
-                labels: models.data.map(model => mapper.mapLabel(model, frame)),
+                labels: models.data.map(model => mappers.labels(model, frame)),
                 meta: models.meta
             };
 
@@ -19,7 +19,7 @@ module.exports = {
         }
 
         frame.response = {
-            labels: [mapper.mapLabel(models, frame)]
+            labels: [mappers.labels(models, frame)]
         };
     }
 };

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

@@ -0,0 +1,7 @@
+const clean = require('../utils/clean');
+
+module.exports = (model, frame) => {
+    const attrs = model.toJSON(frame.options);
+    clean.action(attrs);
+    return attrs;
+};

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

@@ -0,0 +1,17 @@
+const mega = require('../../../../../../services/mega');
+
+module.exports = (model, frame) => {
+    const jsonModel = model.toJSON ? model.toJSON(frame.options) : model;
+
+    // Ensure we're not outputting unwanted replacement strings when viewing email contents
+    // TODO: extract this to a utility, it's duplicated in the email-preview API controller
+    const replacements = mega.postEmailSerializer.parseReplacements(jsonModel);
+    replacements.forEach((replacement) => {
+        jsonModel[replacement.format] = jsonModel[replacement.format].replace(
+            replacement.match,
+            replacement.fallback || ''
+        );
+    });
+
+    return jsonModel;
+};

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

@@ -0,0 +1,5 @@
+const url = require('../utils/url');
+
+module.exports = (path) => {
+    return url.forImage(path);
+};

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

@@ -0,0 +1,12 @@
+module.exports = {
+    actions: require('./actions'),
+    emails: require('./emails'),
+    images: require('./images'),
+    integrations: require('./integrations'),
+    labels: require('./labels'),
+    pages: require('./pages'),
+    posts: require('./posts'),
+    settings: require('./settings'),
+    tags: require('./tags'),
+    users: require('./users')
+};

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

@@ -0,0 +1,13 @@
+module.exports = (model, frame) => {
+    const jsonModel = model.toJSON ? model.toJSON(frame.options) : model;
+
+    if (jsonModel.api_keys) {
+        jsonModel.api_keys.forEach((key) => {
+            if (key.type === 'admin') {
+                key.secret = `${key.id}:${key.secret}`;
+            }
+        });
+    }
+
+    return jsonModel;
+};

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

@@ -0,0 +1,4 @@
+module.exports = (model, frame) => {
+    const jsonModel = model.toJSON ? model.toJSON(frame.options) : model;
+    return jsonModel;
+};

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

@@ -0,0 +1,11 @@
+const mapPost = require('./posts');
+
+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_only;
+
+    return jsonModel;
+};

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

@@ -0,0 +1,101 @@
+const _ = require('lodash');
+
+const mapTag = require('./tags');
+const mapUser = require('./users');
+const mapEmail = require('./emails');
+
+const clean = require('../utils/clean');
+const date = require('../utils/date');
+const extraAttrs = require('../utils/extra-attrs');
+const gating = require('../utils/post-gating');
+const url = require('../utils/url');
+
+const utils = require('../../../index');
+
+const postsMetaSchema = require('../../../../../../data/schema').tables.posts_meta;
+const labsService = require('../../../../../../../shared/labs');
+
+const getPostServiceInstance = require('../../../../../../services/posts/posts-service');
+const postsService = getPostServiceInstance('canary');
+
+module.exports = async (model, frame, options = {}) => {
+    const {tiers: tiersData} = options || {};
+    const extendedOptions = Object.assign(_.cloneDeep(frame.options), {
+        extraProperties: ['canonical_url']
+    });
+
+    const jsonModel = model.toJSON(extendedOptions);
+
+    url.forPost(model.id, jsonModel, frame);
+
+    extraAttrs.forPost(frame, model, jsonModel);
+
+    // Attach tiers to custom nql visibility filter
+    if (labsService.isSet('multipleProducts')
+        && jsonModel.visibility
+    ) {
+        if (['members', 'public'].includes(jsonModel.visibility) && jsonModel.tiers) {
+            jsonModel.tiers = tiersData || [];
+        }
+
+        if (jsonModel.visibility === 'paid' && jsonModel.tiers) {
+            jsonModel.tiers = tiersData ? tiersData.filter(t => t.type === 'paid') : [];
+        }
+
+        if (!['members', 'public', 'paid', 'tiers'].includes(jsonModel.visibility)) {
+            const tiers = await postsService.getProductsFromVisibilityFilter(jsonModel.visibility);
+
+            jsonModel.visibility = 'tiers';
+            jsonModel.tiers = tiers;
+        }
+    }
+
+    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);
+    }
+
+    // Transforms post/page metadata to flat structure
+    let metaAttrs = _.keys(_.omit(postsMetaSchema, ['id', 'post_id']));
+    _(metaAttrs).filter((k) => {
+        return (!frame.options.columns || (frame.options.columns && frame.options.columns.includes(k)));
+    }).each((attr) => {
+        // NOTE: the default of `email_only` is `false` which is why we default to `false` instead of `null`
+        //       The undefined value is possible because `posts_meta` table is lazily created only one of the
+        //       values is assigned.
+        const defaultValue = (attr === 'email_only') ? false : null;
+        jsonModel[attr] = _.get(jsonModel.posts_meta, attr) || defaultValue;
+    });
+    delete jsonModel.posts_meta;
+
+    clean.post(jsonModel, frame);
+
+    if (frame.options && frame.options.withRelated) {
+        frame.options.withRelated.forEach((relation) => {
+            // @NOTE: this block also decorates primary_tag/primary_author objects as they
+            // are being passed by reference in tags/authors. Might be refactored into more explicit call
+            // in the future, but is good enough for current use-case
+            if (relation === 'tags' && jsonModel.tags) {
+                jsonModel.tags = jsonModel.tags.map(tag => mapTag(tag, frame));
+            }
+
+            if (relation === 'authors' && jsonModel.authors) {
+                jsonModel.authors = jsonModel.authors.map(author => mapUser(author, frame));
+            }
+
+            if (relation === 'email' && jsonModel.email) {
+                jsonModel.email = mapEmail(jsonModel.email, frame);
+            }
+
+            if (relation === 'email' && _.isEmpty(jsonModel.email)) {
+                jsonModel.email = null;
+            }
+        });
+    }
+
+    return jsonModel;
+};

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

@@ -0,0 +1,37 @@
+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)));
+    }
+
+    return attrs;
+};

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

@@ -0,0 +1,11 @@
+const clean = require('../utils/clean');
+const url = require('../utils/url');
+
+module.exports = (model, frame) => {
+    const jsonModel = model.toJSON ? model.toJSON(frame.options) : model;
+
+    url.forTag(model.id, jsonModel, frame.options);
+    clean.tag(jsonModel, frame);
+
+    return jsonModel;
+};

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

@@ -0,0 +1,12 @@
+const clean = require('../utils/clean');
+const url = require('../utils/url');
+
+module.exports = (model, frame) => {
+    const jsonModel = model.toJSON ? model.toJSON(frame.options) : model;
+
+    url.forUser(model.id, jsonModel, frame.options);
+
+    clean.author(jsonModel, frame);
+
+    return jsonModel;
+};

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

@@ -1,7 +1,6 @@
 //@ts-check
 const debug = require('@tryghost/debug')('api:canary:utils:serializers:output:members');
 const {unparse} = require('@tryghost/members-csv');
-const labs = require('../../../../../../shared/labs');
 
 module.exports = {
     hasActiveStripeSubscriptions: createSerializer('hasActiveStripeSubscriptions', passthrough),
@@ -17,7 +16,6 @@ module.exports = {
     exportCSV: createSerializer('exportCSV', exportCSV),
 
     importCSV: createSerializer('importCSV', passthrough),
-    stats: createSerializer('stats', passthrough),
     memberStats: createSerializer('memberStats', passthrough),
     mrrStats: createSerializer('mrrStats', passthrough),
     subscriberStats: createSerializer('subscriberStats', passthrough),
@@ -125,13 +123,10 @@ function serializeMember(member, options) {
         email_opened_count: json.email_opened_count,
         email_open_rate: json.email_open_rate,
         email_recipients: json.email_recipients,
-        status: json.status
+        status: json.status,
+        last_seen_at: json.last_seen_at
     };
 
-    if (labs.isSet('membersLastSeenFilter')) {
-        serialized.last_seen_at = json.last_seen_at;
-    }
-
     if (json.products) {
         serialized.products = json.products;
     }

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

@@ -1,5 +1,5 @@
 const debug = require('@tryghost/debug')('api:canary:utils:serializers:output:pages');
-const mapper = require('./utils/mapper');
+const mappers = require('./mappers');
 const membersService = require('../../../../../services/members');
 
 module.exports = {
@@ -19,7 +19,7 @@ module.exports = {
 
         if (models.meta) {
             for (let model of models.data) {
-                let page = await mapper.mapPage(model, frame, {tiers});
+                let page = await mappers.pages(model, frame, {tiers});
                 pages.push(page);
             }
             frame.response = {
@@ -29,7 +29,7 @@ module.exports = {
 
             return;
         }
-        let page = await mapper.mapPage(models, frame, {tiers});
+        let page = await mappers.pages(models, frame, {tiers});
         frame.response = {
             pages: [page]
         };

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

@@ -1,5 +1,5 @@
 const debug = require('@tryghost/debug')('api:canary:utils:serializers:output:posts');
-const mapper = require('./utils/mapper');
+const mappers = require('./mappers');
 const membersService = require('../../../../../services/members');
 
 module.exports = {
@@ -18,7 +18,7 @@ module.exports = {
         const tiers = tiersModels.data ? tiersModels.data.map(tierModel => tierModel.toJSON()) : [];
         if (models.meta) {
             for (let model of models.data) {
-                let post = await mapper.mapPost(model, frame, {tiers});
+                let post = await mappers.posts(model, frame, {tiers});
                 posts.push(post);
             }
             frame.response = {
@@ -28,7 +28,7 @@ module.exports = {
 
             return;
         }
-        let post = await mapper.mapPost(models, frame, {tiers});
+        let post = await mappers.posts(models, frame, {tiers});
         frame.response = {
             posts: [post]
         };

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

@@ -1,4 +1,4 @@
-const mapper = require('./utils/mapper');
+const mappers = require('./mappers');
 const membersService = require('../../../../../services/members');
 
 module.exports = {
@@ -8,7 +8,7 @@ module.exports = {
         });
         const tiers = tiersModels.data ? tiersModels.data.map(tierModel => tierModel.toJSON()) : [];
 
-        const data = await mapper.mapPost(model, frame, {tiers});
+        const data = await mappers.posts(model, frame, {tiers});
         frame.response = {
             preview: [data]
         };

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

@@ -1,6 +1,6 @@
 const _ = require('lodash');
 const utils = require('../../index');
-const mapper = require('./utils/mapper');
+const mappers = require('./mappers');
 const _private = {};
 
 /**
@@ -34,7 +34,7 @@ module.exports = {
         }
 
         frame.response = {
-            settings: mapper.mapSettings(filteredSettings, frame),
+            settings: mappers.settings(filteredSettings, frame),
             meta: {}
         };
 

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

@@ -1,5 +1,5 @@
 const debug = require('@tryghost/debug')('api:canary:utils:serializers:output:tags');
-const mapper = require('./utils/mapper');
+const mappers = require('./mappers');
 
 module.exports = {
     all(models, apiConfig, frame) {
@@ -11,7 +11,7 @@ module.exports = {
 
         if (models.meta) {
             frame.response = {
-                tags: models.data.map(model => mapper.mapTag(model, frame)),
+                tags: models.data.map(model => mappers.tags(model, frame)),
                 meta: models.meta
             };
 
@@ -19,7 +19,7 @@ module.exports = {
         }
 
         frame.response = {
-            tags: [mapper.mapTag(models, frame)]
+            tags: [mappers.tags(models, frame)]
         };
     }
 };