ghost 4.41.3 → 4.43.0

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

@@ -0,0 +1,45 @@
+const models = require('../../models');
+
+module.exports = {
+    docName: 'newsletters',
+
+    browse: {
+        options: [
+            'filter',
+            'fields',
+            'limit',
+            'order',
+            'page'
+        ],
+        permissions: true,
+        query(frame) {
+            return models.Newsletter.findPage(frame.options);
+        }
+    },
+
+    add: {
+        statusCode: 201,
+        permissions: true,
+        async query(frame) {
+            return models.Newsletter.add(frame.data.newsletters[0], frame.options);
+        }
+    },
+
+    edit: {
+        headers: {},
+        options: [
+            'id'
+        ],
+        validation: {
+            options: {
+                id: {
+                    required: true
+                }
+            }
+        },
+        permissions: true,
+        async query(frame) {
+            return models.Newsletter.edit(frame.data.newsletters[0], frame.options);
+        }
+    }
+};

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

@@ -0,0 +1,23 @@
+const statsService = require('../../services/stats');
+
+module.exports = {
+    docName: 'stats',
+    memberCountHistory: {
+        permissions: {
+            docName: 'members',
+            method: 'browse'
+        },
+        async query() {
+            return await statsService.members.getCountHistory();
+        }
+    },
+    mrr: {
+        permissions: {
+            docName: 'members',
+            method: 'browse'
+        },
+        async query() {
+            return await statsService.mrr.getHistory();
+        }
+    }
+};

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

@@ -0,0 +1,7 @@
+module.exports = {
+    // @TODO remove for 5.0
+    // This should be a default serializer, not a passthrough, as per the read endpoint
+    sendTestEmail(data, apiConfig, frame) {
+        frame.response = data;
+    }
+};

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

@@ -41,10 +41,6 @@ module.exports = {
         return require('./schedules');
     },
 
-    get webhooks() {
-        return require('./webhooks');
-    },
-
     get posts() {
         return require('./posts');
     },
@@ -73,14 +69,6 @@ module.exports = {
         return require('./tiers');
     },
 
-    get member_signin_urls() {
-        return require('./member-signin-urls');
-    },
-
-    get identities() {
-        return require('./identities');
-    },
-
     get images() {
         return require('./images');
     },
@@ -121,16 +109,8 @@ module.exports = {
         return require('./site');
     },
 
-    get email_preview() {
-        return require('./email-preview');
-    },
-
-    get emails() {
-        return require('./emails');
-    },
-
-    get snippets() {
-        return require('./snippets');
+    get email_previews() {
+        return require('./email-previews');
     },
 
     get custom_theme_settings() {

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

@@ -7,6 +7,7 @@ module.exports = {
     pages: require('./pages'),
     posts: require('./posts'),
     settings: require('./settings'),
+    snippets: require('./snippets'),
     tags: require('./tags'),
     users: require('./users')
 };

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

@@ -0,0 +1,36 @@
+/**
+ * @param {import('bookshelf').Model} snippet
+ * @param {Frame} frame
+ *
+ * @returns {SerializedSnippet}
+ */
+module.exports = (snippet, frame) => {
+    const json = snippet.toJSON(frame.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<string, any>} Frame
+ * @prop {Object} options
+ */

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

@@ -1,6 +1,7 @@
 //@ts-check
 const debug = require('@tryghost/debug')('api:canary:utils:serializers:output:members');
 const {unparse} = require('@tryghost/members-csv');
+const labsService = require('../../../../../../shared/labs');
 
 module.exports = {
     hasActiveStripeSubscriptions: createSerializer('hasActiveStripeSubscriptions', passthrough),
@@ -20,8 +21,6 @@ module.exports = {
     importCSV: createSerializer('importCSV', passthrough),
     memberStats: createSerializer('memberStats', passthrough),
     mrrStats: createSerializer('mrrStats', passthrough),
-    subscriberStats: createSerializer('subscriberStats', passthrough),
-    grossVolumeStats: createSerializer('grossVolumeStats', passthrough),
     activityFeed: createSerializer('activityFeed', passthrough)
 };
 
@@ -133,6 +132,10 @@ function serializeMember(member, options) {
         serialized.products = json.products;
     }
 
+    if (json.newsletters && labsService.isSet('multipleNewsletters')) {
+        serialized.newsletters = json.newsletters;
+    }
+
     return serialized;
 }
 

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

@@ -1,8 +1,8 @@
 const debug = require('@tryghost/debug')('api:canary:utils:serializers:output:oembed');
 
 module.exports = {
-    all(res, apiConfig, frame) {
+    all(data, apiConfig, frame) {
         debug('all');
-        frame.response = res;
+        frame.response = data;
     }
 };

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

@@ -1,5 +1,5 @@
 module.exports = {
-    all(response, apiConfig, frame) {
-        frame.response = response;
+    all(data, apiConfig, frame) {
+        frame.response = data;
     }
 };

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

@@ -1,5 +1,5 @@
 module.exports = {
-    all(model, apiConfig, frame) {
-        frame.response = model;
+    all(data, apiConfig, frame) {
+        frame.response = data;
     }
 };

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

@@ -1,9 +1,9 @@
 const debug = require('@tryghost/debug')('api:canary:utils:serializers:output:slack');
 
 module.exports = {
-    all(themes, apiConfig, frame) {
+    all(data, apiConfig, frame) {
         debug('all');
 
-        frame.response = themes;
+        frame.response = data;
     }
 };

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

@@ -1,9 +1,9 @@
 const debug = require('@tryghost/debug')('api:canary:utils:serializers:output:themes');
 
 module.exports = {
-    all(themes, apiConfig, frame) {
+    all(data, apiConfig, frame) {
         debug('all');
 
-        frame.response = themes;
+        frame.response = data;
     }
 };

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

@@ -1,34 +1,11 @@
 const debug = require('@tryghost/debug')('api:canary:utils:serializers:output:users');
 const tpl = require('@tryghost/tpl');
-const mappers = require('./mappers');
 
 const messages = {
     pwdChangedSuccessfully: 'Password changed successfully.'
 };
 
 module.exports = {
-    browse(models, apiConfig, frame) {
-        debug('browse');
-
-        frame.response = {
-            users: models.data.map(model => mappers.users(model, frame)),
-            meta: models.meta
-        };
-    },
-
-    read(model, apiConfig, frame) {
-        debug('read');
-
-        frame.response = {
-            users: [mappers.users(model, frame)]
-        };
-    },
-
-    edit() {
-        debug('edit');
-        this.read(...arguments);
-    },
-
     destroy(filename, apiConfig, frame) {
         debug('destroy');
 

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

@@ -1,3 +1,9 @@
+// ESLint Override Notice
+// This is a valid index.js file - it just exports a lot of stuff!
+// Long term we would like to change the API architecture to reduce this file,
+// but that's not the problem the index.js max - line eslint "proxy" rule is there to solve.
+/* eslint-disable max-lines */
+
 module.exports = {
     get passwordreset() {
         return require('./passwordreset');

package/core/server/api/shared/http.js

@@ -13,7 +13,7 @@ const models = require('../../models');
  * @return {Function}
  */
 const http = (apiImpl) => {
-    return (req, res, next) => {
+    return async (req, res, next) => {
         debug(`External API request to ${req.url}`);
         let apiKey = null;
         let integration = null;
@@ -60,69 +60,70 @@ const http = (apiImpl) => {
             data: apiImpl.data
         });
 
-        apiImpl(frame)
-            .then((result) => {
-                debug(`External API request to ${frame.docName}.${frame.method}`);
-                return shared.headers.get(result, apiImpl.headers, frame)
-                    .then(headers => ({result, headers}));
-            })
-            .then(({result, headers}) => {
-                // CASE: api ctrl wants to handle the express response (e.g. streams)
-                if (typeof result === 'function') {
-                    debug('ctrl function call');
-                    return result(req, res, next);
-                }
+        try {
+            const result = await apiImpl(frame);
 
-                let statusCode = 200;
-                if (typeof apiImpl.statusCode === 'function') {
-                    statusCode = apiImpl.statusCode(result);
-                } else if (apiImpl.statusCode) {
-                    statusCode = apiImpl.statusCode;
-                }
+            debug(`External API request to ${frame.docName}.${frame.method}`);
+            const headers = await shared.headers.get(result, apiImpl.headers, frame) || {};
 
-                res.status(statusCode);
+            // CASE: api ctrl wants to handle the express response (e.g. streams)
+            if (typeof result === 'function') {
+                debug('ctrl function call');
+                return result(req, res, next);
+            }
 
-                // CASE: generate headers based on the api ctrl configuration
-                res.set(headers);
+            let statusCode = 200;
+            if (typeof apiImpl.statusCode === 'function') {
+                statusCode = apiImpl.statusCode(result);
+            } else if (apiImpl.statusCode) {
+                statusCode = apiImpl.statusCode;
+            }
 
-                const send = (format) => {
-                    if (format === 'plain') {
-                        debug('plain text response');
-                        return res.send(result);
-                    }
+            res.status(statusCode);
 
-                    debug('json response');
-                    res.json(result || {});
-                };
+            // CASE: generate headers based on the api ctrl configuration
+            if (req && req.headers && req.headers['accept-version'] && res.locals) {
+                headers['content-version'] = `v${res.locals.safeVersion}`;
+            }
+            res.set(headers);
 
-                let responseFormat;
+            const send = (format) => {
+                if (format === 'plain') {
+                    debug('plain text response');
+                    return res.send(result);
+                }
 
-                if (apiImpl.response){
-                    if (typeof apiImpl.response.format === 'function') {
-                        const apiResponseFormat = apiImpl.response.format();
+                debug('json response');
+                res.json(result || {});
+            };
+
+            let responseFormat;
+
+            if (apiImpl.response){
+                if (typeof apiImpl.response.format === 'function') {
+                    const apiResponseFormat = apiImpl.response.format();
 
-                        if (apiResponseFormat.then) { // is promise
-                            return apiResponseFormat.then((formatName) => {
-                                send(formatName);
-                            });
-                        } else {
-                            responseFormat = apiResponseFormat;
-                        }
+                    if (apiResponseFormat.then) { // is promise
+                        return apiResponseFormat.then((formatName) => {
+                            send(formatName);
+                        });
                     } else {
-                        responseFormat = apiImpl.response.format;
+                        responseFormat = apiResponseFormat;
                     }
+                } else {
+                    responseFormat = apiImpl.response.format;
                 }
+            }
 
-                send(responseFormat);
-            })
-            .catch((err) => {
-                req.frameOptions = {
-                    docName: frame.docName,
-                    method: frame.method
-                };
+            send(responseFormat);
+        } catch (err) {
+            req.frameOptions = {
+                docName: frame.docName,
+                method: frame.method
+            };
 
-                next(err);
-            });
+            next(err);
+        }
     };
 };
 

package/core/server/api/shared/serializers/handle.js

@@ -67,6 +67,19 @@ module.exports.input = (apiConfig, apiSerializers, frame) => {
     return sequence(tasks);
 };
 
+const getBestMatchSerializer = function (apiSerializers, docName, method) {
+    if (apiSerializers[docName] && apiSerializers[docName][method]) {
+        debug(`Calling ${docName}.${method}`);
+        return apiSerializers[docName][method].bind(apiSerializers[docName]);
+    } else if (apiSerializers[docName] && apiSerializers[docName].all) {
+        debug(`Calling ${docName}.all`);
+        return apiSerializers[docName].all.bind(apiSerializers[docName]);
+    }
+
+    debug(`Returning as-is`);
+    return false;
+};
+
 /**
  * @description Shared output serialization handler.
  *
@@ -101,33 +114,19 @@ module.exports.output = (response = {}, apiConfig, apiSerializers, frame) => {
         });
     }
 
-    // CASE: custom serializer exists
-    if (apiSerializers[apiConfig.docName]) {
-        if (apiSerializers[apiConfig.docName].all) {
-            tasks.push(function serialiseCustomAll() {
-                return apiSerializers[apiConfig.docName].all(response, apiConfig, frame);
-            });
-        }
+    const customSerializer = getBestMatchSerializer(apiSerializers, apiConfig.docName, apiConfig.method);
+    const defaultSerializer = getBestMatchSerializer(apiSerializers, 'default', apiConfig.method);
 
-        if (apiSerializers[apiConfig.docName][apiConfig.method]) {
-            tasks.push(function serialiseCustomMethod() {
-                return apiSerializers[apiConfig.docName][apiConfig.method](response, apiConfig, frame);
-            });
-        }
-
-    // CASE: Fall back to default serializer
-    } else if (apiSerializers.default) {
-        if (apiSerializers.default.all) {
-            tasks.push(function serializeDefaultAll() {
-                return apiSerializers.default.all(response, apiConfig, frame);
-            });
-        }
-
-        if (apiSerializers.default[apiConfig.method]) {
-            tasks.push(function serializeDefaultMethod() {
-                return apiSerializers.default[apiConfig.method](response, apiConfig, frame);
-            });
-        }
+    if (customSerializer) {
+        // CASE: custom serializer exists
+        tasks.push(function doCustomSerializer() {
+            return customSerializer(response, apiConfig, frame);
+        });
+    } else if (defaultSerializer) {
+        // CASE: Fall back to default serializer
+        tasks.push(function doDefaultSerializer() {
+            return defaultSerializer(response, apiConfig, frame);
+        });
     }
 
     if (apiSerializers.all && apiSerializers.all.after) {

package/core/server/data/exporter/table-lists.js

@@ -15,6 +15,7 @@ const BACKUP_TABLES = [
     'members_stripe_customers_subscriptions',
     'migrations',
     'migrations_lock',
+    'newsletters',
     'oauth',
     'permissions',
     'permissions_roles',
@@ -39,6 +40,7 @@ const BACKUP_TABLES = [
     'members_paid_subscription_events',
     'members_subscribe_events',
     'members_product_events',
+    'members_newsletters',
     'offers',
     'offer_redemptions'
 ];

package/core/server/data/migrations/utils.js

@@ -65,6 +65,36 @@ function dropTables(names) {
     );
 }
 
+/**
+ * Creates a migration which will drop an existing table and then re-add a new table based on provided spec
+ * @param {string} name - table name
+ * @param {Object} tableSpec - copy of table schema definition as defined in schema.js at the moment of writing the migration,
+ * this parameter MUST be present, otherwise @daniellockyer will hunt you down
+ *
+ * @returns {Object} migration object returning config/up/down properties
+ */
+function recreateTable(name, tableSpec) {
+    return createNonTransactionalMigration(
+        async function up(connection) {
+            const exists = await connection.schema.hasTable(name);
+
+            if (!exists) {
+                logging.warn(`Failed to drop table: ${name} - table does not exist`);
+            } else {
+                logging.info(`Dropping table: ${name}`);
+                await commands.deleteTable(name, connection);
+                logging.info(`Re-adding table: ${name}`);
+                await commands.createTable(name, connection, tableSpec);
+            }
+        },
+        async function down() {
+            // noop: we cannot go back to old table schema
+            logging.warn(`Ignoring rollback for table recreate: ${name}`);
+            return Promise.resolve();
+        }
+    );
+}
+
 /**
  * Creates a migration which will add a permission to the database
  *
@@ -178,7 +208,7 @@ function addPermissionToRole(config) {
                 return;
             }
 
-            logging.warn(`Adding permission(${config.permission}) to role(${config.role})`);
+            logging.info(`Adding permission(${config.permission}) to role(${config.role})`);
             await connection('permissions_roles').insert({
                 id: ObjectId().toHexString(),
                 permission_id: permission.id,
@@ -375,7 +405,8 @@ function createAddColumnMigration(table, column, columnDefinition) {
             column,
             dbIsInCorrectState: hasColumn => hasColumn === false,
             operation: commands.dropColumn,
-            operationVerb: 'Removing'
+            operationVerb: 'Removing',
+            columnDefinition
         })
     );
 }
@@ -462,6 +493,7 @@ function addSetting({key, value, type, group}) {
 module.exports = {
     addTable,
     dropTables,
+    recreateTable,
     addPermission,
     addPermissionToRole,
     addPermissionWithRoles,

package/core/server/data/migrations/versions/4.42/2022-03-21-17-17-add.js

@@ -0,0 +1,25 @@
+// ESLint Override Notice
+// This file was named incorrectly and it didn't flag up in our eslint rules.
+// The ESLint match-regex rule has now been updated to catch this, but this file has to be excluded.
+/* eslint-disable ghost/filenames/match-regex */
+
+const {addTable} = require('../../utils');
+
+module.exports = addTable('newsletters', {
+    id: {type: 'string', maxlength: 24, nullable: false, primary: true},
+    name: {type: 'string', maxlength: 191, nullable: false},
+    description: {type: 'string', maxlength: 2000, nullable: true},
+    sender_name: {type: 'string', maxlength: 191, nullable: false},
+    sender_email: {type: 'string', maxlength: 191, nullable: false, validations: {isEmail: true}},
+    sender_reply_to: {type: 'string', maxlength: 191, nullable: false, validations: {isEmail: true}},
+    default: {type: 'bool', nullable: false, defaultTo: false},
+    status: {type: 'string', maxlength: 50, nullable: false, defaultTo: 'active'},
+    recipient_filter: {
+        type: 'text',
+        maxlength: 1000000000,
+        nullable: false,
+        defaultTo: ''
+    },
+    subscribe_on_signup: {type: 'bool', nullable: false, defaultTo: false},
+    sort_order: {type: 'integer', nullable: false, unsigned: true, defaultTo: 0}
+});

package/core/server/data/migrations/versions/4.42/2022-03-30-15-44-add-newsletter-permissions.js

@@ -0,0 +1,28 @@
+const {
+    addPermissionWithRoles,
+    combineTransactionalMigrations
+} = require('../../utils');
+
+module.exports = combineTransactionalMigrations(
+    addPermissionWithRoles({
+        name: 'Browse newsletters',
+        action: 'browse',
+        object: 'newsletter'
+    }, [
+        'Administrator'
+    ]),
+    addPermissionWithRoles({
+        name: 'Add newsletters',
+        action: 'add',
+        object: 'newsletter'
+    }, [
+        'Administrator'
+    ]),
+    addPermissionWithRoles({
+        name: 'Edit newsletters',
+        action: 'edit',
+        object: 'newsletter'
+    }, [
+        'Administrator'
+    ])
+);

package/core/server/data/migrations/versions/4.43/2022-03-28-19-26-recreate-newsletter-table.js

@@ -0,0 +1,29 @@
+const {recreateTable} = require('../../utils');
+
+module.exports = recreateTable('newsletters', {
+    id: {type: 'string', maxlength: 24, nullable: false, primary: true},
+    name: {type: 'string', maxlength: 191, nullable: false, unique: true},
+    description: {type: 'string', maxlength: 2000, nullable: true},
+    slug: {type: 'string', maxlength: 191, nullable: false, unique: true},
+    sender_name: {type: 'string', maxlength: 191, nullable: false},
+    sender_email: {type: 'string', maxlength: 191, nullable: true},
+    sender_reply_to: {type: 'string', maxlength: 191, nullable: false, defaultTo: 'newsletter', validations: {isIn: ['newsletter', 'support']}},
+    status: {type: 'string', maxlength: 50, nullable: false, defaultTo: 'active'},
+    visibility: {
+        type: 'string',
+        maxlength: 50,
+        nullable: false,
+        defaultTo: 'members'
+    },
+    subscribe_on_signup: {type: 'bool', nullable: false, defaultTo: true},
+    sort_order: {type: 'integer', nullable: false, unsigned: true, defaultTo: 0},
+    header_image: {type: 'string', maxlength: 2000, nullable: true},
+    show_header_icon: {type: 'bool', nullable: false, defaultTo: true},
+    show_header_title: {type: 'bool', nullable: false, defaultTo: true},
+    title_font_category: {type: 'string', maxlength: 191, nullable: false, defaultTo: 'sans_serif', validations: {isIn: ['serif', 'sans_serif']}},
+    title_alignment: {type: 'string', maxlength: 191, nullable: false, defaultTo: 'center', validations: {isIn: ['center', 'left']}},
+    show_feature_image: {type: 'bool', nullable: false, defaultTo: true},
+    body_font_category: {type: 'string', maxlength: 191, nullable: false, defaultTo: 'sans_serif', validations: {isIn: ['serif', 'sans_serif']}},
+    footer_content: {type: 'text', maxlength: 1000000000, nullable: true},
+    show_badge: {type: 'bool', nullable: false, defaultTo: true}
+});