ghost 4.18.0 → 4.20.1

package/core/server/adapters/storage/LocalFileStorage.js

@@ -29,27 +29,25 @@ class LocalFileStore extends StorageBase {
 
     /**
      * Saves a buffer in the targetPath
-     * - buffer is an instance of Buffer
-     * - returns a Promise which returns the full URL to retrieve the data
+     * @param {Buffer} buffer is an instance of Buffer
+     * @param {String} targetPath path to which the buffer should be written
+     * @returns {Promise<String>} a URL to retrieve the data
      */
-    saveRaw(buffer, targetPath) {
+    async saveRaw(buffer, targetPath) {
         const storagePath = path.join(this.storagePath, targetPath);
         const targetDir = path.dirname(storagePath);
 
-        return fs.mkdirs(targetDir)
-            .then(() => {
-                return fs.writeFile(storagePath, buffer);
-            })
-            .then(() => {
-                // For local file system storage can use relative path so add a slash
-                const fullUrl = (
-                    urlUtils.urlJoin('/', urlUtils.getSubdir(),
-                        urlUtils.STATIC_IMAGE_URL_PREFIX,
-                        targetPath)
-                ).replace(new RegExp(`\\${path.sep}`, 'g'), '/');
-
-                return fullUrl;
-            });
+        await fs.mkdirs(targetDir);
+        await fs.writeFile(storagePath, buffer);
+
+        // For local file system storage can use relative path so add a slash
+        const fullUrl = (
+            urlUtils.urlJoin('/', urlUtils.getSubdir(),
+                urlUtils.STATIC_IMAGE_URL_PREFIX,
+                targetPath)
+        ).replace(new RegExp(`\\${path.sep}`, 'g'), '/');
+
+        return fullUrl;
     }
 
     /**
@@ -57,34 +55,32 @@ class LocalFileStore extends StorageBase {
      * - image is the express image object
      * - returns a promise which ultimately returns the full url to the uploaded image
      *
-     * @param image
-     * @param targetDir
-     * @returns {*}
+     * @param {StorageBase.Image} image
+     * @param {String} targetDir
+     * @returns {Promise<String>}
      */
-    save(image, targetDir) {
+    async save(image, targetDir) {
         let targetFilename;
 
         // NOTE: the base implementation of `getTargetDir` returns the format this.storagePath/YYYY/MM
         targetDir = targetDir || this.getTargetDir(this.storagePath);
 
-        return this.getUniqueFileName(image, targetDir).then((filename) => {
-            targetFilename = filename;
-            return fs.mkdirs(targetDir);
-        }).then(() => {
-            return fs.copy(image.path, targetFilename);
-        }).then(() => {
-            // The src for the image must be in URI format, not a file system path, which in Windows uses \
-            // For local file system storage can use relative path so add a slash
-            const fullUrl = (
-                urlUtils.urlJoin('/', urlUtils.getSubdir(),
-                    urlUtils.STATIC_IMAGE_URL_PREFIX,
-                    path.relative(this.storagePath, targetFilename))
-            ).replace(new RegExp(`\\${path.sep}`, 'g'), '/');
-
-            return fullUrl;
-        }).catch((e) => {
-            return Promise.reject(e);
-        });
+        const filename = await this.getUniqueFileName(image, targetDir);
+
+        targetFilename = filename;
+        await fs.mkdirs(targetDir);
+
+        await fs.copy(image.path, targetFilename);
+
+        // The src for the image must be in URI format, not a file system path, which in Windows uses \
+        // For local file system storage can use relative path so add a slash
+        const fullUrl = (
+            urlUtils.urlJoin('/', urlUtils.getSubdir(),
+                urlUtils.STATIC_IMAGE_URL_PREFIX,
+                path.relative(this.storagePath, targetFilename))
+        ).replace(new RegExp(`\\${path.sep}`, 'g'), '/');
+
+        return fullUrl;
     }
 
     exists(fileName, targetDir) {

package/core/server/adapters/storage/index.js

@@ -1,7 +1,17 @@
 const adapterManager = require('../../services/adapter-manager');
 
-function getStorage() {
-    return adapterManager.getAdapter('storage');
+/**
+ * @param {'images'|'videos'|'audios'} [feature] - name for the "feature" to enable through adapter, e.g.: images or videos storage
+ * @returns {Object} adapter instance
+ */
+function getStorage(feature) {
+    let adapterName = 'storage';
+
+    if (feature) {
+        adapterName += `:${feature}`;
+    }
+
+    return adapterManager.getAdapter(adapterName);
 }
 
 module.exports.getStorage = getStorage;

package/core/server/api/canary/custom-theme-settings.js

@@ -6,7 +6,7 @@ module.exports = {
     browse: {
         permissions: true,
         query() {
-            return customThemeSettingsService.listSettings();
+            return customThemeSettingsService.api.listSettings();
         }
     },
 
@@ -16,7 +16,7 @@ module.exports = {
         },
         permissions: true,
         query(frame) {
-            return customThemeSettingsService.updateSettings(frame.data.custom_theme_settings);
+            return customThemeSettingsService.api.updateSettings(frame.data.custom_theme_settings);
         }
     }
 };

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

@@ -7,7 +7,7 @@ module.exports = {
         statusCode: 201,
         permissions: false,
         query(frame) {
-            const store = storage.getStorage();
+            const store = storage.getStorage('images');
 
             if (frame.files) {
                 return Promise

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

@@ -1,8 +1,8 @@
 const config = require('../../../shared/config');
 const externalRequest = require('../../lib/request-external');
-const tpl = require('@tryghost/tpl');
+
 const OEmbed = require('../../services/oembed');
-const oembed = new OEmbed({config, externalRequest, tpl});
+const oembed = new OEmbed({config, externalRequest});
 
 module.exports = {
     docName: 'oembed',

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

@@ -1,12 +1,21 @@
+const tpl = require('@tryghost/tpl');
+const errors = require('@tryghost/errors');
 const offersService = require('../../services/offers');
 
+const messages = {
+    offerNotFound: 'Offer not found.'
+};
+
 module.exports = {
     docName: 'offers',
 
     browse: {
+        options: [
+            'filter'
+        ],
         permissions: true,
         async query(frame) {
-            const offers = await offersService.api.listOffers();
+            const offers = await offersService.api.listOffers(frame.options);
             frame.response = {
                 offers
             };
@@ -18,6 +27,12 @@ module.exports = {
         permissions: true,
         async query(frame) {
             const offer = await offersService.api.getOffer(frame.data);
+            if (!offer) {
+                throw new errors.NotFoundError({
+                    message: tpl(messages.offerNotFound)
+                });
+            }
+
             frame.response = {
                 offers: [offer]
             };
@@ -27,11 +42,21 @@ module.exports = {
     edit: {
         options: ['id'],
         permissions: true,
+        headers: {
+            cacheInvalidate: true
+        },
         async query(frame) {
             const offer = await offersService.api.updateOffer({
                 ...frame.data.offers[0],
                 id: frame.options.id
             });
+
+            if (!offer) {
+                throw new errors.NotFoundError({
+                    message: tpl(messages.offerNotFound)
+                });
+            }
+
             frame.response = {
                 offers: [offer]
             };
@@ -40,6 +65,9 @@ module.exports = {
 
     add: {
         permissions: true,
+        headers: {
+            cacheInvalidate: true
+        },
         async query(frame) {
             const offer = await offersService.api.createOffer(frame.data.offers[0]);
             frame.response = {

package/core/server/api/canary/posts-public.js

@@ -1,8 +1,12 @@
 const models = require('../../models');
-const i18n = require('../../../shared/i18n');
+const tpl = require('@tryghost/tpl');
 const errors = require('@tryghost/errors');
 const allowedIncludes = ['tags', 'authors'];
 
+const messages = {
+    postNotFound: 'Post not found.'
+};
+
 module.exports = {
     docName: 'posts',
 
@@ -63,7 +67,7 @@ module.exports = {
                 .then((model) => {
                     if (!model) {
                         throw new errors.NotFoundError({
-                            message: i18n.t('errors.api.posts.postNotFound')
+                            message: tpl(messages.postNotFound)
                         });
                     }
 

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

@@ -3,10 +3,14 @@
 const errors = require('@tryghost/errors');
 const membersService = require('../../services/members');
 
-const i18n = require('../../../shared/i18n');
+const tpl = require('@tryghost/tpl');
 
 const allowedIncludes = ['stripe_prices', 'monthly_price', 'yearly_price', 'benefits'];
 
+const messages = {
+    productNotFound: 'Product not found.'
+};
+
 module.exports = {
     docName: 'products',
 
@@ -56,7 +60,7 @@ module.exports = {
 
             if (!model) {
                 throw new errors.NotFoundError({
-                    message: i18n.t('errors.api.products.productNotFound')
+                    message: tpl(messages.productNotFound)
                 });
             }
 

package/core/server/api/canary/tags-public.js

@@ -1,10 +1,14 @@
 const Promise = require('bluebird');
-const i18n = require('../../../shared/i18n');
+const tpl = require('@tryghost/tpl');
 const errors = require('@tryghost/errors');
 const models = require('../../models');
 
 const ALLOWED_INCLUDES = ['count.posts'];
 
+const messages = {
+    tagNotFound: 'Tag not found.'
+};
+
 module.exports = {
     docName: 'tags',
 
@@ -56,7 +60,7 @@ module.exports = {
                 .then((model) => {
                     if (!model) {
                         return Promise.reject(new errors.NotFoundError({
-                            message: i18n.t('errors.api.tags.tagNotFound')
+                            message: tpl(messages.tagNotFound)
                         }));
                     }
 

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

@@ -1,5 +1,5 @@
 const Promise = require('bluebird');
-const i18n = require('../../../shared/i18n');
+const tpl = require('@tryghost/tpl');
 const errors = require('@tryghost/errors');
 const models = require('../../models');
 const permissionsService = require('../../services/permissions');
@@ -12,11 +12,16 @@ const userService = new UsersService({dbBackup, models, auth, apiMail, apiSettin
 const ALLOWED_INCLUDES = ['count.posts', 'permissions', 'roles', 'roles.permissions'];
 const UNSAFE_ATTRS = ['status', 'roles'];
 
+const messages = {
+    noPermissionToAction: 'You do not have permission to perform this action',
+    userNotFound: 'User not found.'
+};
+
 function permissionOnlySelf(frame) {
     const targetId = getTargetId(frame);
     const userId = frame.user.id;
     if (targetId !== userId) {
-        return Promise.reject(new errors.NoPermissionError({message: i18n.t('errors.permissions.noPermissionToAction')}));
+        return Promise.reject(new errors.NoPermissionError({message: tpl(messages.noPermissionToAction)}));
     }
     return Promise.resolve();
 }
@@ -88,7 +93,7 @@ module.exports = {
                 .then((model) => {
                     if (!model) {
                         return Promise.reject(new errors.NotFoundError({
-                            message: i18n.t('errors.api.users.userNotFound')
+                            message: tpl(messages.userNotFound)
                         }));
                     }
 
@@ -121,7 +126,7 @@ module.exports = {
                 .then((model) => {
                     if (!model) {
                         return Promise.reject(new errors.NotFoundError({
-                            message: i18n.t('errors.api.users.userNotFound')
+                            message: tpl(messages.userNotFound)
                         }));
                     }
 

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

@@ -1,13 +1,13 @@
 module.exports = {
     browse(models, apiConfig, frame) {
         frame.response = {
-            customThemeSettings: models
+            custom_theme_settings: models
         };
     },
 
     edit(models, apiConfig, frame) {
         frame.response = {
-            customThemeSettings: models
+            custom_theme_settings: models
         };
     }
 };

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

@@ -19,6 +19,7 @@ module.exports = {
             delete notification.seen;
             delete notification.seenBy;
             delete notification.addedAt;
+            delete notification.createdAtVersion;
         });
 
         frame.response = {

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

@@ -55,9 +55,8 @@ module.exports = {
         this.browse(...arguments);
     },
 
-    edit(models, apiConfig, frame) {
-        const settingsKeyedJSON = _.keyBy(_.invokeMap(models, 'toJSON'), 'key');
-        this.browse(settingsKeyedJSON, apiConfig, frame);
+    edit() {
+        this.browse(...arguments);
     },
 
     download(bytes, apiConfig, frame) {

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

@@ -1,4 +1,4 @@
-const urlService = require('../../../../../../../frontend/services/url');
+const urlService = require('../../../../../../services/url');
 const urlUtils = require('../../../../../../../shared/url-utils');
 const localUtils = require('../../../index');
 

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

@@ -1,7 +1,10 @@
 const Promise = require('bluebird');
 const tpl = require('@tryghost/tpl');
 const errors = require('@tryghost/errors');
-const messages = {noUrlProvided: 'No url provided.'};
+
+const messages = {
+    noUrlProvided: 'No url provided.'
+};
 
 module.exports = {
     read(apiConfig, frame) {

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

@@ -1,9 +1,14 @@
 const Promise = require('bluebird');
 const validator = require('@tryghost/validator');
 const debug = require('@tryghost/debug')('api:canary:utils:validators:input:passwordreset');
-const i18n = require('../../../../../../shared/i18n');
+const tpl = require('@tryghost/tpl');
 const errors = require('@tryghost/errors');
 
+const messages = {
+    newPasswordsDoNotMatch: 'Your new passwords do not match',
+    invalidEmailReceived: 'The server did not receive a valid email'
+};
+
 module.exports = {
     resetPassword(apiConfig, frame) {
         debug('resetPassword');
@@ -12,7 +17,7 @@ module.exports = {
 
         if (data.newPassword !== data.ne2Password) {
             return Promise.reject(new errors.ValidationError({
-                message: i18n.t('errors.models.user.newPasswordsDoNotMatch')
+                message: tpl(messages.newPasswordsDoNotMatch)
             }));
         }
     },
@@ -24,7 +29,7 @@ module.exports = {
 
         if (typeof email !== 'string' || !validator.isEmail(email)) {
             throw new errors.BadRequestError({
-                message: i18n.t('errors.api.authentication.invalidEmailReceived')
+                message: tpl(messages.invalidEmailReceived)
             });
         }
     }

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

@@ -1,12 +1,13 @@
 const Promise = require('bluebird');
 const _ = require('lodash');
-const i18n = require('../../../../../../shared/i18n');
+const tpl = require('@tryghost/tpl');
 const {NotFoundError, ValidationError, BadRequestError} = require('@tryghost/errors');
 const validator = require('@tryghost/validator');
 
 const messages = {
     invalidEmailReceived: 'Please send a valid email',
-    invalidEmailTypeReceived: 'Invalid email type received'
+    invalidEmailTypeReceived: 'Invalid email type received',
+    problemFindingSetting: 'Problem finding setting: {key}'
 };
 
 module.exports = {
@@ -14,7 +15,7 @@ module.exports = {
         // @NOTE: was removed https://github.com/TryGhost/Ghost/issues/10373
         if (frame.options.key === 'ghost_head' || frame.options.key === 'ghost_foot') {
             return Promise.reject(new NotFoundError({
-                message: i18n.t('errors.api.settings.problemFindingSetting', {
+                message: tpl(messages.problemFindingSetting, {
                     key: frame.options.key
                 })
             }));
@@ -28,7 +29,7 @@ module.exports = {
             if (setting.key === 'ghost_head' || setting.key === 'ghost_foot') {
                 // @NOTE: was removed https://github.com/TryGhost/Ghost/issues/10373
                 errors.push(new NotFoundError({
-                    message: i18n.t('errors.api.settings.problemFindingSetting', {
+                    message: tpl(messages.problemFindingSetting, {
                         key: setting.key
                     })
                 }));

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

@@ -1,13 +1,17 @@
 const debug = require('@tryghost/debug')('api:canary:utils:validators:input:updateSetup');
-const i18n = require('../../../../../../shared/i18n');
+const tpl = require('@tryghost/tpl');
 const errors = require('@tryghost/errors');
 
+const messages = {
+    notTheBlogOwner: 'You are not the site owner.'
+};
+
 module.exports = {
     updateSetup(apiConfig, frame) {
         debug('resetPassword');
 
         if (!frame.options.context || !frame.options.context.user) {
-            throw new errors.NoPermissionError({message: i18n.t('errors.api.authentication.notTheBlogOwner')});
+            throw new errors.NoPermissionError({message: tpl(messages.notTheBlogOwner)});
         }
     }
 };

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

@@ -1,8 +1,12 @@
 const Promise = require('bluebird');
 const debug = require('@tryghost/debug')('api:canary:utils:validators:input:users');
-const i18n = require('../../../../../../shared/i18n');
+const tpl = require('@tryghost/tpl');
 const errors = require('@tryghost/errors');
 
+const messages = { 
+    newPasswordsDoNotMatch: 'Your new passwords do not match'
+};
+
 module.exports = {
     changePassword(apiConfig, frame) {
         debug('changePassword');
@@ -11,7 +15,7 @@ module.exports = {
 
         if (data.newPassword !== data.ne2Password) {
             return Promise.reject(new errors.ValidationError({
-                message: i18n.t('errors.models.user.newPasswordsDoNotMatch')
+                message: tpl(messages.newPasswordsDoNotMatch)
             }));
         }
     }

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

@@ -1,16 +1,21 @@
 const _ = require('lodash');
 const errors = require('@tryghost/errors');
-const i18n = require('../../../../../../shared/i18n');
+const tpl = require('@tryghost/tpl');
 const jsonSchema = require('../utils/json-schema');
 
+const messages = {
+    schemaValidationFailed: 'Validation failed for \'{key}\'.',
+    noIntegrationIdProvidedContext: 'You may only create webhooks with \'integration_id\' when using session authentication.'
+};
+
 module.exports = {
     add(apiConfig, frame) {
         if (!_.get(frame, 'options.context.integration.id') && !_.get(frame.data, 'webhooks[0].integration_id')) {
             return Promise.reject(new errors.ValidationError({
-                message: i18n.t('notices.data.validation.index.schemaValidationFailed', {
+                message: tpl(messages.schemaValidationFailed, {
                     key: 'integration_id'
                 }),
-                context: i18n.t('errors.api.webhooks.noIntegrationIdProvided.context'),
+                context: tpl(messages.noIntegrationIdProvidedContext),
                 property: 'integration_id'
             }));
         }

package/core/server/api/v2/images.js

@@ -7,7 +7,7 @@ module.exports = {
         statusCode: 201,
         permissions: false,
         query(frame) {
-            const store = storage.getStorage();
+            const store = storage.getStorage('images');
 
             if (frame.files) {
                 return Promise

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

@@ -1,6 +1,11 @@
-const i18n = require('../../../../../../shared/i18n');
+const tpl = require('@tryghost/tpl');
 const mapper = require('./utils/mapper');
 const debug = require('@tryghost/debug')('api:v2:utils:serializers:output:authentication');
+const messages = {
+    checkEmailForInstructions: 'Check your email for further instructions.',
+    passwordChanged: 'Password changed successfully.',
+    invitationAccepted: 'Invitation accepted.'
+};
 
 module.exports = {
     setup(user, apiConfig, frame) {
@@ -28,7 +33,7 @@ module.exports = {
     generateResetToken(data, apiConfig, frame) {
         frame.response = {
             passwordreset: [{
-                message: i18n.t('common.api.authentication.mail.checkEmailForInstructions')
+                message: tpl(messages.checkEmailForInstructions)
             }]
         };
     },
@@ -36,7 +41,7 @@ module.exports = {
     resetPassword(data, apiConfig, frame) {
         frame.response = {
             passwordreset: [{
-                message: i18n.t('common.api.authentication.mail.passwordChanged')
+                message: tpl(messages.passwordChanged)
             }]
         };
     },
@@ -46,7 +51,7 @@ module.exports = {
 
         frame.response = {
             invitation: [
-                {message: i18n.t('common.api.authentication.mail.invitationAccepted')}
+                {message: tpl(messages.invitationAccepted)}
             ]
         };
     },

package/core/server/api/v2/utils/serializers/output/notifications.js

@@ -19,6 +19,7 @@ module.exports = {
             delete notification.seen;
             delete notification.seenBy;
             delete notification.addedAt;
+            delete notification.createdAtVersion;
         });
 
         frame.response = {

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

@@ -1,7 +1,9 @@
 const debug = require('@tryghost/debug')('api:v2:utils:serializers:output:users');
-const i18n = require('../../../../../../shared/i18n');
+const tpl = require('@tryghost/tpl');
 const mapper = require('./utils/mapper');
-
+const messages = {
+    pwdChangedSuccessfully: 'Password changed successfully.'
+};
 module.exports = {
     browse(models, apiConfig, frame) {
         debug('browse');
@@ -29,7 +31,7 @@ module.exports = {
         debug('changePassword');
 
         frame.response = {
-            password: [{message: i18n.t('notices.api.users.pwdChangedSuccessfully')}]
+            password: [{message: tpl(messages.pwdChangedSuccessfully)}]
         };
     },
 

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

@@ -1,4 +1,4 @@
-const urlService = require('../../../../../../../frontend/services/url');
+const urlService = require('../../../../../../services/url');
 const urlUtils = require('../../../../../../../shared/url-utils');
 const localUtils = require('../../../index');