ghost 4.42.1 → 4.44.0

package/core/frontend/apps/amp/lib/helpers/amp_analytics.js

@@ -3,7 +3,7 @@
 //
 // Outputs inline scripts used for analytics
 const {settingsCache} = require('../../../../services/proxy');
-const {SafeString} = require('../../../../services/rendering');
+const {SafeString} = require('../../../../services/handlebars');
 
 function ampComponents() {
     let components = [];

package/core/frontend/apps/amp/lib/helpers/amp_components.js

@@ -9,7 +9,7 @@
 // amp-img, amp-ad, amp-embed, amp-video and amp-pixel.
 // (less) dirty requires
 const {settingsCache} = require('../../../../services/proxy');
-const {SafeString} = require('../../../../services/rendering');
+const {SafeString} = require('../../../../services/handlebars');
 
 function ampComponents() {
     let components = [];

package/core/frontend/apps/amp/lib/helpers/amp_content.js

@@ -12,7 +12,7 @@ const {DateTime, Interval} = require('luxon');
 const errors = require('@tryghost/errors');
 const logging = require('@tryghost/logging');
 
-const {SafeString} = require('../../../../services/rendering');
+const {SafeString} = require('../../../../services/handlebars');
 
 const amperizeCache = {};
 let allowedAMPTags = [];

package/core/frontend/apps/amp/lib/helpers/amp_style.js

@@ -1,4 +1,4 @@
-const {SafeString, escapeExpression} = require('../../../../services/rendering');
+const {SafeString, escapeExpression} = require('../../../../services/handlebars');
 
 module.exports = function amp_style(options) { // eslint-disable-line camelcase
     if (options.data.site.accent_color) {

package/core/frontend/apps/amp/lib/router.js

@@ -7,7 +7,8 @@ const errors = require('@tryghost/errors');
 
 // Dirty requires
 const urlService = require('../../../../server/services/url');
-const helpers = require('../../../services/routing/helpers');
+const dataService = require('../../../services/data');
+const renderer = require('../../../services/rendering');
 const templateName = 'amp';
 
 const messages = {
@@ -23,15 +24,15 @@ function _renderer(req, res, next) {
 
     // Renderer begin
     // Format data
-    let data = req.body || {};
+    let body = req.body || {};
 
     // CASE: we only support amp pages for posts that are not static pages
-    if (!data.post || data.post.page) {
+    if (!body.post || body.post.page) {
         return next(new errors.NotFoundError({message: tpl(messages.pageNotFound)}));
     }
 
     // Render Call
-    return helpers.renderer(req, res, data);
+    return renderer.renderer(req, res, body);
 }
 
 // This here is a controller.
@@ -71,7 +72,7 @@ function getPostData(req, res, next) {
 
     // @NOTE: amp is not supported for static pages
     // @TODO: https://github.com/TryGhost/Ghost/issues/10548
-    helpers.entryLookup(urlWithoutSubdirectoryWithoutAmp, {permalinks, query: {controller: 'postsPublic', resource: 'posts'}}, res.locals)
+    dataService.entryLookup(urlWithoutSubdirectoryWithoutAmp, {permalinks, query: {controller: 'postsPublic', resource: 'posts'}}, res.locals)
         .then((result) => {
             if (result && result.entry) {
                 req.body.post = result.entry;

package/core/frontend/apps/private-blogging/lib/helpers/input_password.js

@@ -4,7 +4,7 @@
 // Password input used on private.hbs for password-protected blogs
 
 // (less) dirty requires
-const {SafeString, templates} = require('../../../../services/rendering');
+const {SafeString, templates} = require('../../../../services/handlebars');
 
 // We use the name input_password to match the helper for consistency:
 module.exports = function input_password(options) { // eslint-disable-line camelcase

package/core/frontend/apps/private-blogging/lib/router.js

@@ -2,7 +2,7 @@ const path = require('path');
 const express = require('../../../../shared/express');
 const middleware = require('./middleware');
 const bodyParser = require('body-parser');
-const routing = require('../../../services/routing');
+const renderer = require('../../../services/rendering');
 const web = require('../../../../server/web');
 const templateName = 'private';
 const privateRouter = express.Router(templateName);
@@ -23,7 +23,7 @@ function _renderer(req, res) {
     }
 
     // Render Call
-    return routing.helpers.renderer(req, res, data);
+    return renderer.renderer(req, res, data);
 }
 
 // password-protected frontend route

package/core/frontend/helpers/asset.js

@@ -3,7 +3,7 @@
 //
 // Returns the path to the specified asset.
 const {metaData, urlUtils} = require('../services/proxy');
-const {SafeString} = require('../services/rendering');
+const {SafeString} = require('../services/handlebars');
 
 const errors = require('@tryghost/errors');
 const tpl = require('@tryghost/tpl');

package/core/frontend/helpers/author.js

@@ -10,7 +10,7 @@
 // Block helper: `{{#author}}{{/author}}`
 // This is the default handlebars behaviour of dropping into the author object scope
 const {urlService} = require('../services/proxy');
-const {SafeString, escapeExpression, hbs, templates} = require('../services/rendering');
+const {SafeString, escapeExpression, hbs, templates} = require('../services/handlebars');
 const isString = require('lodash/isString');
 
 const builtInHelpers = hbs.handlebars.helpers;

package/core/frontend/helpers/authors.js

@@ -7,7 +7,7 @@
 //
 // Note that the standard {{#each authors}} implementation is unaffected by this helper.
 const {urlService} = require('../services/proxy');
-const {SafeString, escapeExpression, templates} = require('../services/rendering');
+const {SafeString, escapeExpression, templates} = require('../services/handlebars');
 const isString = require('lodash/isString');
 const {utils} = require('@tryghost/helpers');
 

package/core/frontend/helpers/body_class.js

@@ -2,7 +2,7 @@
 // Usage: `{{body_class}}`
 //
 // Output classes for the body element
-const {SafeString} = require('../services/rendering');
+const {SafeString} = require('../services/handlebars');
 
 // We use the name body_class to match the helper for consistency
 module.exports = function body_class(options) { // eslint-disable-line camelcase

package/core/frontend/helpers/cancel_link.js

@@ -6,7 +6,7 @@
 //
 // Defaults to class="cancel-subscription-link" errorClass="cancel-subscription-error" cancelLabel="Cancel subscription" continueLabel="Continue subscription"
 const {labs} = require('../services/proxy');
-const {templates} = require('../services/rendering');
+const {templates} = require('../services/handlebars');
 
 const errors = require('@tryghost/errors');
 const tpl = require('@tryghost/tpl');

package/core/frontend/helpers/concat.js

@@ -1,4 +1,4 @@
-const {SafeString} = require('../services/rendering');
+const {SafeString} = require('../services/handlebars');
 
 module.exports = function concat(...args) {
     const options = args.pop();

package/core/frontend/helpers/content.js

@@ -10,7 +10,7 @@
 //
 // Dev flag feature: In case of restricted content access for member-only posts, shows CTA box
 
-const {templates, hbs, SafeString} = require('../services/rendering');
+const {templates, hbs, SafeString} = require('../services/handlebars');
 const downsize = require('downsize');
 const _ = require('lodash');
 const createFrame = hbs.handlebars.createFrame;

package/core/frontend/helpers/date.js

@@ -3,7 +3,7 @@
 //
 // Formats a date using moment-timezone.js. Formats published_at by default but will also take a date as a parameter
 
-const {SafeString} = require('../services/rendering');
+const {SafeString} = require('../services/handlebars');
 const moment = require('moment-timezone');
 const _ = require('lodash');
 

package/core/frontend/helpers/encode.js

@@ -4,7 +4,7 @@
 //
 // Returns URI encoded string
 
-const {SafeString} = require('../services/rendering');
+const {SafeString} = require('../services/handlebars');
 
 module.exports = function encode(string, options) {
     const uri = string || options;

package/core/frontend/helpers/excerpt.js

@@ -5,7 +5,7 @@
 //
 // Defaults to words="50"
 
-const {SafeString} = require('../services/rendering');
+const {SafeString} = require('../services/handlebars');
 const {metaData} = require('../services/proxy');
 const _ = require('lodash');
 const getMetaDataExcerpt = metaData.getMetaDataExcerpt;

package/core/frontend/helpers/facebook_url.js

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

package/core/frontend/helpers/foreach.js

@@ -2,8 +2,8 @@
 // Usage: `{{#foreach data}}{{/foreach}}`
 //
 // Block helper designed for looping through posts
-const {checks} = require('../services/proxy');
-const {hbs} = require('../services/rendering');
+const {checks} = require('../services/data');
+const {hbs} = require('../services/handlebars');
 
 const _ = require('lodash');
 const logging = require('@tryghost/logging');

package/core/frontend/helpers/get.js

@@ -2,7 +2,7 @@
 // Usage: `{{#get "posts" limit="5"}}`, `{{#get "tags" limit="all"}}`
 // Fetches data from the API
 const {config, api, prepareContextResource} = require('../services/proxy');
-const {hbs} = require('../services/rendering');
+const {hbs} = require('../services/handlebars');
 
 const logging = require('@tryghost/logging');
 const errors = require('@tryghost/errors');

package/core/frontend/helpers/ghost_foot.js

@@ -3,7 +3,7 @@
 //
 // Outputs scripts and other assets at the bottom of a Ghost theme
 const {settingsCache} = require('../services/proxy');
-const {SafeString} = require('../services/rendering');
+const {SafeString} = require('../services/handlebars');
 const _ = require('lodash');
 
 // We use the name ghost_foot to match the helper for consistency:

package/core/frontend/helpers/ghost_head.js

@@ -3,7 +3,7 @@
 //
 // Outputs scripts and other assets at the top of a Ghost theme
 const {metaData, settingsCache, config, blogIcon, urlUtils, labs} = require('../services/proxy');
-const {escapeExpression, SafeString} = require('../services/rendering');
+const {escapeExpression, SafeString} = require('../services/handlebars');
 
 // BAD REQUIRE
 // @TODO fix this require

package/core/frontend/helpers/lang.js

@@ -12,7 +12,7 @@
 // Language tags in HTML and XML
 // https://www.w3.org/International/articles/language-tags/
 
-const {SafeString} = require('../services/rendering');
+const {SafeString} = require('../services/handlebars');
 
 module.exports = function lang(options) {
     const locale = options.data.site.locale;

package/core/frontend/helpers/link.js

@@ -1,6 +1,6 @@
 // # link helper
 const {config} = require('../services/proxy');
-const {SafeString, localUtils} = require('../services/rendering');
+const {SafeString, localUtils} = require('../services/handlebars');
 
 const _ = require('lodash');
 const errors = require('@tryghost/errors');

package/core/frontend/helpers/link_class.js

@@ -1,6 +1,6 @@
 // # link_class helper
 const {config} = require('../services/proxy');
-const {SafeString, localUtils} = require('../services/rendering');
+const {SafeString, localUtils} = require('../services/handlebars');
 
 const _ = require('lodash');
 const errors = require('@tryghost/errors');

package/core/frontend/helpers/match.js

@@ -1,4 +1,4 @@
-const {SafeString} = require('../services/rendering');
+const {SafeString} = require('../services/handlebars');
 
 const logging = require('@tryghost/logging');
 const tpl = require('@tryghost/tpl');

package/core/frontend/helpers/navigation.js

@@ -1,7 +1,7 @@
 // ### Navigation Helper
 // `{{navigation}}`
 // Outputs navigation menu of static urls
-const {SafeString, templates, hbs} = require('../services/rendering');
+const {SafeString, templates, hbs} = require('../services/handlebars');
 
 const errors = require('@tryghost/errors');
 const tpl = require('@tryghost/tpl');

package/core/frontend/helpers/pagination.js

@@ -1,7 +1,7 @@
 // ### Pagination Helper
 // `{{pagination}}`
 // Outputs previous and next buttons, along with info about the current page
-const {templates, hbs} = require('../services/rendering');
+const {templates, hbs} = require('../services/handlebars');
 
 const errors = require('@tryghost/errors');
 const tpl = require('@tryghost/tpl');

package/core/frontend/helpers/plural.js

@@ -9,7 +9,7 @@
 // The 2nd argument is the string that will be output if the variable's value is 0
 // The 3rd argument is the string that will be output if the variable's value is 1
 // The 4th argument is the string that will be output if the variable's value is 2+
-const {SafeString} = require('../services/rendering');
+const {SafeString} = require('../services/handlebars');
 
 const errors = require('@tryghost/errors');
 const tpl = require('@tryghost/tpl');

package/core/frontend/helpers/post_class.js

@@ -2,7 +2,7 @@
 // Usage: `{{post_class}}`
 //
 // Output classes for the body element
-const {SafeString} = require('../services/rendering');
+const {SafeString} = require('../services/handlebars');
 
 // We use the name post_class to match the helper for consistency:
 module.exports = function post_class() { // eslint-disable-line camelcase

package/core/frontend/helpers/prev_post.js

@@ -2,8 +2,9 @@
 //  Example usages
 // `{{#prev_post}}<a href ="{{url}}>previous post</a>{{/prev_post}}'
 // `{{#next_post}}<a href ="{{url absolute="true">next post</a>{{/next_post}}'
-const {api, checks} = require('../services/proxy');
-const {hbs} = require('../services/rendering');
+const {api} = require('../services/proxy');
+const {hbs} = require('../services/handlebars');
+const {checks} = require('../services/data');
 
 const logging = require('@tryghost/logging');
 const tpl = require('@tryghost/tpl');
@@ -50,8 +51,8 @@ const buildApiOptions = function buildApiOptions(options, post) {
 };
 
 /**
- * @param {*} options 
- * @param {*} data 
+ * @param {*} options
+ * @param {*} data
  * @returns {Promise<any>}
  */
 const fetch = function fetch(options, data) {
@@ -84,7 +85,7 @@ const fetch = function fetch(options, data) {
 // then the promise is handled in the api call.
 
 /**
- * @param {*} options 
+ * @param {*} options
  * @returns {Promise<any>}
  */
 module.exports = function prevNext(options) {

package/core/frontend/helpers/products.js

@@ -4,7 +4,7 @@
 // Returns a string of the products with access to the post.
 // By default, products are separated by commas.
 const {labs} = require('../services/proxy');
-const {SafeString} = require('../services/rendering');
+const {SafeString} = require('../services/handlebars');
 
 const isString = require('lodash/isString');
 

package/core/frontend/helpers/reading_time.js

@@ -10,8 +10,8 @@
 //
 // Returns estimated reading time for post
 
-const {checks} = require('../services/proxy');
-const {SafeString} = require('../services/rendering');
+const {checks} = require('../services/data');
+const {SafeString} = require('../services/handlebars');
 
 const {readingTime: calculateReadingTime} = require('@tryghost/helpers');
 

package/core/frontend/helpers/t.js

@@ -10,7 +10,7 @@
 // because often other helpers need that (t) returns a string to be able to work as subexpression; e.g.:
 // {{tags prefix=(t " on ")}}
 
-const {themeI18n} = require('../services/rendering');
+const {themeI18n} = require('../services/handlebars');
 
 module.exports = function t(text, options) {
     const bindings = {};

package/core/frontend/helpers/tags.js

@@ -6,7 +6,7 @@
 //
 // Note that the standard {{#each tags}} implementation is unaffected by this helper
 const {urlService} = require('../services/proxy');
-const {SafeString, escapeExpression, templates} = require('../services/rendering');
+const {SafeString, escapeExpression, templates} = require('../services/handlebars');
 
 const isString = require('lodash/isString');
 const ghostHelperUtils = require('@tryghost/helpers').utils;

package/core/frontend/helpers/tiers.js

@@ -4,7 +4,7 @@
 // Returns a string of the tiers with access to the post.
 // By default, tiers are separated by commas.
 const {labs} = require('../services/proxy');
-const {SafeString, escapeExpression} = require('../services/rendering');
+const {SafeString, escapeExpression} = require('../services/handlebars');
 
 const isString = require('lodash/isString');
 

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');
     },