ghost 4.41.3 → 4.43.0

package/core/frontend/helpers/title.js

@@ -3,7 +3,7 @@
 //
 // Overrides the standard behaviour of `{[title}}` to ensure the content is correctly escaped
 
-const {SafeString, escapeExpression} = require('../services/rendering');
+const {SafeString, escapeExpression} = require('../services/handlebars');
 
 module.exports = function title() {
     return new SafeString(escapeExpression(this.title || ''));

package/core/frontend/helpers/twitter_url.js

@@ -3,7 +3,7 @@
 //
 // Output a url for a twitter username
 const {socialUrls} = require('../services/proxy');
-const {localUtils} = require('../services/rendering');
+const {localUtils} = require('../services/handlebars');
 
 // We use the name twitter_url to match the helper for consistency:
 module.exports = function twitter_url(username, options) { // eslint-disable-line camelcase

package/core/frontend/helpers/url.js

@@ -5,7 +5,7 @@
 // `absolute` flag outputs absolute URL, else URL is relative
 
 const {metaData} = require('../services/proxy');
-const {SafeString} = require('../services/rendering');
+const {SafeString} = require('../services/handlebars');
 const logging = require('@tryghost/logging');
 const sentry = require('../../shared/sentry');
 const errors = require('@tryghost/errors');

package/core/frontend/meta/url.js

@@ -1,6 +1,6 @@
-const schema = require('../../server/data/schema').checks;
 const urlUtils = require('../../shared/url-utils');
 const urlService = require('../../server/services/url');
+const {checks} = require('../services/data');
 
 // This cleans the url from any `/amp` postfixes, so we'll never
 // output a url with `/amp` in the end, except for the needed `amphtml`
@@ -13,7 +13,7 @@ function sanitizeAmpUrl(url) {
 }
 
 function getUrl(data, absolute) {
-    if (schema.isPost(data)) {
+    if (checks.isPost(data)) {
         /**
          * @NOTE
          *
@@ -33,11 +33,11 @@ function getUrl(data, absolute) {
         return urlService.getUrlByResourceId(data.id, {secure: data.secure, absolute: absolute, withSubdirectory: true});
     }
 
-    if (schema.isTag(data) || schema.isUser(data)) {
+    if (checks.isTag(data) || checks.isUser(data)) {
         return urlService.getUrlByResourceId(data.id, {secure: data.secure, absolute: absolute, withSubdirectory: true});
     }
 
-    if (schema.isNav(data)) {
+    if (checks.isNav(data)) {
         return urlUtils.urlFor('nav', {nav: data, secure: data.secure}, absolute);
     }
 

package/core/{server/data/schema → frontend/services/data}/checks.js

@@ -19,8 +19,8 @@ function isNav(jsonData) {
 }
 
 module.exports = {
-    isPost: isPost,
-    isTag: isTag,
-    isUser: isUser,
-    isNav: isNav
+    isPost,
+    isTag,
+    isUser,
+    isNav
 };

package/core/frontend/services/{routing/helpers → data}/entry-lookup.js

@@ -1,11 +1,11 @@
 const _ = require('lodash');
 const Promise = require('bluebird');
 const url = require('url');
-const debug = require('@tryghost/debug')('services:routing:helpers:entry-lookup');
+const debug = require('@tryghost/debug')('services:data:entry-lookup');
 const routeMatch = require('path-match')();
 
 /**
- * @description Query API for a single entry/resource.
+ * Query API for a single entry/resource.
  * @param {String} postUrl
  * @param {Object} routerOptions
  * @param {Object} locals
@@ -14,7 +14,7 @@ const routeMatch = require('path-match')();
 function entryLookup(postUrl, routerOptions, locals) {
     debug(postUrl);
 
-    const api = require('../../proxy').api[locals.apiVersion];
+    const api = require('../proxy').api[locals.apiVersion];
     const targetPath = url.parse(postUrl).path;
     const permalinks = routerOptions.permalinks;
     let isEditURL = false;

package/core/frontend/services/{routing/helpers → data}/fetch-data.js

@@ -34,7 +34,7 @@ const defaultPostQuery = _.cloneDeep(queryDefaults);
 defaultPostQuery.options = defaultQueryOptions.options;
 
 /**
- * @description Process query request.
+ * Process query request.
  *
  * Takes a 'query' object, ensures that type, resource and options are set
  * Replaces occurrences of `%s` in options with slugParam
@@ -45,7 +45,7 @@ defaultPostQuery.options = defaultQueryOptions.options;
  * @returns {Promise}
  */
 function processQuery(query, slugParam, locals) {
-    const api = require('../../proxy').api[locals.apiVersion];
+    const api = require('../proxy').api[locals.apiVersion];
 
     query = _.cloneDeep(query);
 
@@ -62,7 +62,7 @@ function processQuery(query, slugParam, locals) {
 }
 
 /**
- * @description Fetch data from API helper for controllers.
+ * Fetch data from API helper for controllers.
  *
  * Calls out to get posts per page, builds the final posts query & builds any additional queries
  * Wraps the queries using Promise.props to ensure it gets named responses

package/core/frontend/services/data/index.js

@@ -0,0 +1,5 @@
+module.exports = {
+    checks: require('./checks'),
+    entryLookup: require('./entry-lookup'),
+    fetchData: require('./fetch-data')
+};

package/core/frontend/services/{rendering.js → handlebars.js}

@@ -1,5 +1,5 @@
 /**
- * This is a loose concept of a frontend rendering framework
+ * This is a loose concept of a frontend handlebars toolkit
  * Note: everything here gets deep-required from the theme-engine
  * This indicates that the theme engine is a set of services, rather than a single service
  * and could do with a further refactor.
@@ -17,6 +17,7 @@ module.exports = {
     templates: require('./theme-engine/handlebars/template'),
 
     // Theme i18n
+    // @TODO: this should live somewhere else...
     themeI18n: require('./theme-engine/i18n'),
 
     // TODO: these need a more sensible home

package/core/frontend/services/helpers/handlebars.js

@@ -2,7 +2,7 @@ const Promise = require('bluebird');
 const errors = require('@tryghost/errors');
 const logging = require('@tryghost/logging');
 
-const {hbs} = require('../rendering');
+const {hbs} = require('../handlebars');
 
 // Register an async handlebars helper for a given handlebars instance
 function asyncHelperWrapper(hbsInstance, name, fn) {

package/core/frontend/services/proxy.js

@@ -2,8 +2,8 @@
 const settingsCache = require('../../shared/settings-cache');
 const config = require('../../shared/config');
 
-// Require from the rendering framework
-const {SafeString} = require('./rendering');
+// Require from the handlebars framework
+const {SafeString} = require('./handlebars');
 
 module.exports = {
     /**
@@ -22,8 +22,6 @@ module.exports = {
             }
         });
     },
-    // This is used to decide e.g. if a JSON object is a Post, Page, Tag etc
-    checks: require('../../server/data/schema').checks,
 
     /**
      * Section three: Core API

package/core/frontend/services/{routing/helpers → rendering}/format-response.js

@@ -1,5 +1,5 @@
 const _ = require('lodash');
-const {prepareContextResource} = require('../../proxy');
+const {prepareContextResource} = require('../proxy');
 
 /**
  * @description Formats API response into handlebars/theme format.

package/core/frontend/services/{routing/helpers → rendering}/index.js

@@ -1,12 +1,4 @@
 module.exports = {
-    get entryLookup() {
-        return require('./entry-lookup');
-    },
-
-    get fetchData() {
-        return require('./fetch-data');
-    },
-
     get renderEntries() {
         return require('./render-entries');
     },

package/core/frontend/services/{routing/helpers → rendering}/render-entries.js

@@ -1,4 +1,4 @@
-const debug = require('@tryghost/debug')('services:routing:helpers:render-entries');
+const debug = require('@tryghost/debug')('services:routing:renderer:render-entries');
 const formatResponse = require('./format-response');
 const renderer = require('./renderer');
 

package/core/frontend/services/{routing/helpers → rendering}/render-entry.js

@@ -1,4 +1,4 @@
-const debug = require('@tryghost/debug')('services:routing:helpers:render-post');
+const debug = require('@tryghost/debug')('services:routing:renderer:render-post');
 const formatResponse = require('./format-response');
 const renderer = require('./renderer');
 /**

package/core/frontend/services/{routing/helpers → rendering}/renderer.js

@@ -1,4 +1,4 @@
-const debug = require('@tryghost/debug')('services:routing:helpers:renderer');
+const debug = require('@tryghost/debug')('services:routing:renderer:renderer');
 const setContext = require('./context');
 const templates = require('./templates');
 

package/core/frontend/services/{routing/helpers → rendering}/templates.js

@@ -6,8 +6,8 @@ const _ = require('lodash');
 
 const path = require('path');
 const url = require('url');
-const config = require('../../../../shared/config');
-const themeEngine = require('../../theme-engine');
+const config = require('../../../shared/config');
+const themeEngine = require('../theme-engine');
 const _private = {};
 
 /**

package/core/frontend/services/routing/CollectionRouter.js

@@ -30,7 +30,7 @@ class CollectionRouter extends ParentRouter {
             value: object.permalink
         };
 
-        // @NOTE: see helpers/templates - we use unshift to prepend the templates
+        // @NOTE: see renderer/templates - we use unshift to prepend the templates
         this.templates = (object.templates || []).reverse();
 
         this.filter = object.filter;

package/core/frontend/services/routing/controllers/channel.js

@@ -4,7 +4,8 @@ const tpl = require('@tryghost/tpl');
 const errors = require('@tryghost/errors');
 const security = require('@tryghost/security');
 const themeEngine = require('../../theme-engine');
-const helpers = require('../helpers');
+const dataService = require('../../data');
+const renderer = require('../../rendering');
 
 const messages = {
     pageNotFound: 'Page not found.'
@@ -50,7 +51,7 @@ module.exports = function channelController(req, res, next) {
         }
     }
 
-    return helpers.fetchData(pathOptions, res.routerOptions, res.locals)
+    return dataService.fetchData(pathOptions, res.routerOptions, res.locals)
         .then(function handleResult(result) {
             // CASE: requested page is greater than number of pages we have
             if (pathOptions.page > result.meta.pagination.pages) {
@@ -60,16 +61,15 @@ module.exports = function channelController(req, res, next) {
             }
 
             // Format data 1
-            // @TODO: See helpers/secure for explanation.
-            helpers.secure(req, result.posts);
+            // @TODO: See renderer/secure for explanation.
+            renderer.secure(req, result.posts);
 
-            // @TODO: See helpers/secure for explanation.
+            // @TODO: See renderer/secure for explanation.
             _.each(result.data, function (data) {
-                helpers.secure(req, data);
+                renderer.secure(req, data);
             });
 
-            const renderer = helpers.renderEntries(req, res);
-            return renderer(result);
+            return renderer.renderEntries(req, res)(result);
         })
-        .catch(helpers.handleError(next));
+        .catch(renderer.handleError(next));
 };

package/core/frontend/services/routing/controllers/collection.js

@@ -5,7 +5,8 @@ const errors = require('@tryghost/errors');
 const security = require('@tryghost/security');
 const {routerManager} = require('../');
 const themeEngine = require('../../theme-engine');
-const helpers = require('../helpers');
+const renderer = require('../../rendering');
+const dataService = require('../../data');
 
 const messages = {
     pageNotFound: 'Page not found.'
@@ -49,7 +50,7 @@ module.exports = function collectionController(req, res, next) {
     }
 
     debug('fetching data');
-    return helpers.fetchData(pathOptions, res.routerOptions, res.locals)
+    return dataService.fetchData(pathOptions, res.routerOptions, res.locals)
         .then(function handleResult(result) {
             // CASE: requested page is greater than number of pages we have
             if (pathOptions.page > result.meta.pagination.pages) {
@@ -80,16 +81,15 @@ module.exports = function collectionController(req, res, next) {
             });
 
             // Format data 1
-            // @TODO: See helpers/secure for explanation.
-            helpers.secure(req, result.posts);
+            // @TODO: See renderer/secure for explanation.
+            renderer.secure(req, result.posts);
 
-            // @TODO: See helpers/secure for explanation.
+            // @TODO: See renderer/secure for explanation.
             _.each(result.data, function (data) {
-                helpers.secure(req, data);
+                renderer.secure(req, data);
             });
 
-            const renderer = helpers.renderEntries(req, res);
-            return renderer(result);
+            return renderer.renderEntries(req, res)(result);
         })
-        .catch(helpers.handleError(next));
+        .catch(renderer.handleError(next));
 };

package/core/frontend/services/routing/controllers/email-post.js

@@ -2,7 +2,7 @@ const debug = require('@tryghost/debug')('services:routing:controllers:emailpost
 const config = require('../../../../shared/config');
 const {routerManager} = require('../');
 const urlUtils = require('../../../../shared/url-utils');
-const helpers = require('../helpers');
+const renderer = require('../../rendering');
 
 /**
  * @description Email Post Controller.
@@ -55,11 +55,10 @@ module.exports = function emailPostController(req, res, next) {
                 post.access = !!post.html;
             }
 
-            // @TODO: See helpers/secure
-            helpers.secure(req, post);
+            // @TODO: See renderer/secure
+            renderer.secure(req, post);
 
-            const renderer = helpers.renderEntry(req, res);
-            return renderer(post);
+            return renderer.renderEntry(req, res)(post);
         })
-        .catch(helpers.handleError(next));
+        .catch(renderer.handleError(next));
 };

package/core/frontend/services/routing/controllers/entry.js

@@ -3,7 +3,8 @@ const url = require('url');
 const config = require('../../../../shared/config');
 const {routerManager} = require('../');
 const urlUtils = require('../../../../shared/url-utils');
-const helpers = require('../helpers');
+const dataService = require('../../data');
+const renderer = require('../../rendering');
 
 /**
  * @description Entry controller.
@@ -15,7 +16,7 @@ const helpers = require('../helpers');
 module.exports = function entryController(req, res, next) {
     debug('entryController', res.routerOptions);
 
-    return helpers.entryLookup(req.path, res.routerOptions, res.locals)
+    return dataService.entryLookup(req.path, res.routerOptions, res.locals)
         .then(function then(lookup) {
             // Format data 1
             const entry = lookup ? lookup.entry : false;
@@ -83,10 +84,9 @@ module.exports = function entryController(req, res, next) {
                 }));
             }
 
-            helpers.secure(req, entry);
+            renderer.secure(req, entry);
 
-            const renderer = helpers.renderEntry(req, res);
-            return renderer(entry);
+            return renderer.renderEntry(req, res)(entry);
         })
-        .catch(helpers.handleError(next));
+        .catch(renderer.handleError(next));
 };

package/core/frontend/services/routing/controllers/preview.js

@@ -2,7 +2,7 @@ const debug = require('@tryghost/debug')('services:routing:controllers:preview')
 const config = require('../../../../shared/config');
 const {routerManager} = require('../');
 const urlUtils = require('../../../../shared/url-utils');
-const helpers = require('../helpers');
+const renderer = require('../../rendering');
 
 /**
  * @description Preview Controller.
@@ -57,11 +57,10 @@ module.exports = function previewController(req, res, next) {
                 post.access = !!post.html;
             }
 
-            // @TODO: See helpers/secure
-            helpers.secure(req, post);
+            // @TODO: See renderer/secure
+            renderer.secure(req, post);
 
-            const renderer = helpers.renderEntry(req, res);
-            return renderer(post);
+            return renderer.renderEntry(req, res)(post);
         })
-        .catch(helpers.handleError(next));
+        .catch(renderer.handleError(next));
 };

package/core/frontend/services/routing/controllers/rss.js

@@ -4,7 +4,8 @@ const url = require('url');
 const security = require('@tryghost/security');
 const settingsCache = require('../../../../shared/settings-cache');
 const rssService = require('../../rss');
-const helpers = require('../helpers');
+const renderer = require('../../rendering');
+const dataService = require('../../data');
 
 // @TODO: is this really correct? Should we be using meta data title?
 function getTitle(relatedData) {
@@ -35,7 +36,7 @@ module.exports = function rssController(req, res, next) {
     // @TODO: This belongs to the rss service O_o
     const baseUrl = url.parse(req.originalUrl).pathname;
 
-    helpers.fetchData(pathOptions, res.routerOptions, res.locals)
+    dataService.fetchData(pathOptions, res.routerOptions, res.locals)
         .then(function formatResult(result) {
             const response = _.pick(result, ['posts', 'meta']);
 
@@ -47,5 +48,5 @@ module.exports = function rssController(req, res, next) {
         .then(function (data) {
             return rssService.render(res, baseUrl, data);
         })
-        .catch(helpers.handleError(next));
+        .catch(renderer.handleError(next));
 };

package/core/frontend/services/routing/controllers/static.js

@@ -1,7 +1,7 @@
 const _ = require('lodash');
 const Promise = require('bluebird');
 const debug = require('@tryghost/debug')('services:routing:controllers:static');
-const helpers = require('../helpers');
+const renderer = require('../../rendering');
 
 function processQuery(query, locals) {
     const api = require('../../proxy').api[locals.apiVersion];
@@ -60,12 +60,12 @@ module.exports = function staticController(req, res, next) {
                 });
             }
 
-            // @TODO: See helpers/secure for more context.
+            // @TODO: See renderer/secure for more context.
             _.each(response.data, function (data) {
-                helpers.secure(req, data);
+                renderer.secure(req, data);
             });
 
-            helpers.renderer(req, res, helpers.formatResponse.entries(response));
+            renderer.renderer(req, res, renderer.formatResponse.entries(response));
         })
-        .catch(helpers.handleError(next));
+        .catch(renderer.handleError(next));
 };

package/core/frontend/services/routing/controllers/unsubscribe.js

@@ -1,7 +1,7 @@
 const debug = require('@tryghost/debug')('services:routing:controllers:unsubscribe');
 const path = require('path');
 const megaService = require('../../../../server/services/mega');
-const helpers = require('../../../services/routing/helpers');
+const renderer = require('../../rendering');
 
 module.exports = async function unsubscribeController(req, res) {
     debug('unsubscribeController');
@@ -22,5 +22,5 @@ module.exports = async function unsubscribeController(req, res) {
         defaultTemplate: path.resolve(__dirname, '../../../views/', templateName)
     };
 
-    return helpers.renderer(req, res, data);
+    return renderer.renderer(req, res, data);
 };

package/core/frontend/services/routing/index.js

@@ -7,9 +7,5 @@ module.exports = {
 
     get registry() {
         return registry;
-    },
-
-    get helpers() {
-        return require('./helpers');
     }
 };

package/core/frontend/web/middleware/error-handler.js

@@ -4,7 +4,7 @@ const tpl = require('@tryghost/tpl');
 const sentry = require('../../../shared/sentry');
 
 const config = require('../../../shared/config');
-const helpers = require('../../services/routing/helpers');
+const renderer = require('../../services/rendering');
 
 // @TODO: make this properly shared code
 const {prepareError, prepareStack} = require('@tryghost/mw-error-handler');
@@ -55,7 +55,7 @@ const themeErrorRenderer = (err, req, res, next) => {
 
     // Template
     // @TODO: very dirty !!!!!!
-    helpers.templates.setTemplate(req, res);
+    renderer.templates.setTemplate(req, res);
 
     // It can be that something went wrong with the theme or otherwise loading handlebars
     // This ensures that no matter what res.render will work here

package/core/server/api/canary/email-preview.js

@@ -12,7 +12,8 @@ const emailPreview = new mega.EmailPreview({
 });
 
 module.exports = {
-    docName: 'email_preview',
+    // @TODO make the route match the resource name in 5.0
+    docName: 'email_previews',
 
     read: {
         options: [

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

@@ -158,7 +158,7 @@ module.exports = {
     },
 
     get emails() {
-        return shared.pipeline(require('./email'), localUtils);
+        return shared.pipeline(require('./emails'), localUtils);
     },
 
     get site() {
@@ -169,6 +169,10 @@ module.exports = {
         return shared.pipeline(require('./snippets'), localUtils);
     },
 
+    get stats() {
+        return shared.pipeline(require('./stats'), localUtils);
+    },
+
     get customThemeSettings() {
         return shared.pipeline(require('./custom-theme-settings'), localUtils);
     },
@@ -177,6 +181,10 @@ module.exports = {
         return require('./utils/serializers');
     },
 
+    get newsletters() {
+        return shared.pipeline(require('./newsletters'), localUtils);
+    },
+
     /**
      * Content API Controllers
      *

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

@@ -452,51 +452,6 @@ module.exports = {
             };
         }
     },
-    subscriberStats: {
-        permissions: {
-            method: 'browse'
-        },
-        async query() {
-            const statsData = await membersService.api.events.getSubscriptions();
-            const totalSubscriptions = (_.last(statsData) && _.last(statsData).subscribed) || 0;
-            statsData.forEach((d) => {
-                d.date = moment(d.date).format('YYYY-MM-DD');
-            });
-            return {
-                resource: 'subscribers',
-                total: totalSubscriptions,
-                data: statsData.map((d) => {
-                    return Object.assign({}, {
-                        date: moment(d.date).format('YYYY-MM-DD'),
-                        value: d.subscribed
-                    });
-                })
-            };
-        }
-    },
-    grossVolumeStats: {
-        permissions: {
-            method: 'browse'
-        },
-        async query() {
-            const volumeData = await membersService.api.events.getVolume();
-            const volumeStats = Object.keys(volumeData).map((curr) => {
-                return {
-                    currency: curr,
-                    data: volumeData[curr].map((d) => {
-                        return Object.assign({}, {
-                            date: moment(d.date).format('YYYY-MM-DD'),
-                            value: d.volume
-                        });
-                    })
-                };
-            });
-            return {
-                resource: 'gross-volume',
-                data: volumeStats
-            };
-        }
-    },
 
     activityFeed: {
         options: [