npm - ghost - Versions diffs - 5.82.8 → 5.82.9 - Mend

ghost 5.82.8 → 5.82.9

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (277) hide show

package/core/server/api/endpoints/member-signin-urls.js CHANGED Viewed

@@ -6,8 +6,10 @@ const messages = {
     memberNotFound: 'Member not found.'
 };
-module.exports = {
+/** @type {import('@tryghost/api-framework').Controller} */
+const controller = {
     docName: 'member_signin_urls',
     read: {
         headers: {
             cacheInvalidate: false
@@ -34,3 +36,5 @@ module.exports = {
         }
     }
 };
+module.exports = controller;

package/core/server/api/endpoints/members-stripe-connect.js CHANGED Viewed

@@ -1,6 +1,7 @@
 const membersService = require('../../services/members');
-module.exports = {
+/** @type {import('@tryghost/api-framework').Controller} */
+const controller = {
     docName: 'members_stripe_connect',
     auth: {
         headers: {
@@ -30,3 +31,5 @@ module.exports = {
         }
     }
 };
+module.exports = controller;

package/core/server/api/endpoints/members.js CHANGED Viewed

@@ -29,7 +29,8 @@ const messages = {
 const allowedIncludes = ['email_recipients', 'products', 'tiers'];
-module.exports = {
+/** @type {import('@tryghost/api-framework').Controller} */
+const controller = {
     docName: 'members',
     browse: {
@@ -503,3 +504,5 @@ module.exports = {
         }
     }
 };
+module.exports = controller;

package/core/server/api/endpoints/mentions.js CHANGED Viewed

@@ -1,6 +1,7 @@
 const mentions = require('../../services/mentions');
-module.exports = {
+/** @type {import('@tryghost/api-framework').Controller} */
+const controller = {
     docName: 'mentions',
     browse: {
         headers: {
@@ -37,3 +38,5 @@ module.exports = {
         }
     }
 };
+module.exports = controller;

package/core/server/api/endpoints/newsletters-public.js CHANGED Viewed

@@ -1,6 +1,7 @@
 const models = require('../../models');
-module.exports = {
+/** @type {import('@tryghost/api-framework').Controller} */
+const controller = {
     docName: 'newsletters',
     browse: {
@@ -20,3 +21,5 @@ module.exports = {
         }
     }
 };
+module.exports = controller;

package/core/server/api/endpoints/newsletters.js CHANGED Viewed

@@ -2,7 +2,8 @@ const allowedIncludes = ['count.posts', 'count.members', 'count.active_members']
 const newslettersService = require('../../services/newsletters');
-module.exports = {
+/** @type {import('@tryghost/api-framework').Controller} */
+const controller = {
     docName: 'newsletters',
     browse: {
@@ -121,3 +122,5 @@ module.exports = {
         }
     }
 };
+module.exports = controller;

package/core/server/api/endpoints/notifications.js CHANGED Viewed

@@ -3,7 +3,8 @@ const settingsService = require('../../services/settings/settings-service');
 const settingsBREADService = settingsService.getSettingsBREADServiceInstance();
 const internalContext = {context: {internal: true}};
-module.exports = {
+/** @type {import('@tryghost/api-framework').Controller} */
+const controller = {
     docName: 'notifications',
     browse: {
@@ -101,3 +102,5 @@ module.exports = {
         }
     }
 };
+module.exports = controller;

package/core/server/api/endpoints/oembed.js CHANGED Viewed

@@ -1,6 +1,7 @@
 const oembed = require('../../services/oembed');
-module.exports = {
+/** @type {import('@tryghost/api-framework').Controller} */
+const controller = {
     docName: 'oembed',
     read: {
@@ -20,3 +21,5 @@ module.exports = {
         }
     }
 };
+module.exports = controller;

package/core/server/api/endpoints/offers-public.js CHANGED Viewed

@@ -6,7 +6,8 @@ const messages = {
     offerNotFound: 'Offer not found.'
 };
-module.exports = {
+/** @type {import('@tryghost/api-framework').Controller} */
+const controller = {
     docName: 'offers',
     read: {
@@ -29,3 +30,5 @@ module.exports = {
         }
     }
 };
+module.exports = controller;

package/core/server/api/endpoints/offers.js CHANGED Viewed

@@ -6,7 +6,8 @@ const messages = {
     offerNotFound: 'Offer not found.'
 };
-module.exports = {
+/** @type {import('@tryghost/api-framework').Controller} */
+const controller = {
     docName: 'offers',
     browse: {
@@ -82,3 +83,5 @@ module.exports = {
         }
     }
 };
+module.exports = controller;

package/core/server/api/endpoints/pages-public.js CHANGED Viewed

@@ -20,7 +20,8 @@ const rejectPrivateFieldsTransformer = input => mapQuery(input, function (value,
     };
 });
-module.exports = {
+/** @type {import('@tryghost/api-framework').Controller} */
+const controller = {
     docName: 'pages',
     browse: {
@@ -103,3 +104,5 @@ module.exports = {
         }
     }
 };
+module.exports = controller;

package/core/server/api/endpoints/pages.js CHANGED Viewed

@@ -11,7 +11,8 @@ const messages = {
 const postsService = getPostServiceInstance();
-module.exports = {
+/** @type {import('@tryghost/api-framework').Controller} */
+const controller = {
     docName: 'pages',
     browse: {
         headers: {
@@ -282,3 +283,5 @@ module.exports = {
         }
     }
 };
+module.exports = controller;

package/core/server/api/endpoints/posts-public.js CHANGED Viewed

@@ -23,6 +23,12 @@ const rejectPrivateFieldsTransformer = input => mapQuery(input, function (value,
     };
 });
+/**
+ *
+ * @param {import('@tryghost/api-framework').Frame} frame
+ * @param {object} options
+ * @returns {object}
+ */
 function generateOptionsData(frame, options) {
     return options.reduce((memo, option) => {
         let value = frame.options?.[option];
@@ -52,7 +58,9 @@ function generateAuthData(frame) {
         };
     }
 }
-module.exports = {
+/** @type {import('@tryghost/api-framework').Controller} */
+const controller = {
     docName: 'posts',
     browse: {
@@ -172,3 +180,5 @@ module.exports = {
         }
     }
 };
+module.exports = controller;

package/core/server/api/endpoints/posts.js CHANGED Viewed

@@ -38,7 +38,8 @@ function getCacheHeaderFromEventString(event, dto) {
     }
 }
-module.exports = {
+/** @type {import('@tryghost/api-framework').Controller} */
+const controller = {
     docName: 'posts',
     browse: {
         headers: {
@@ -327,3 +328,5 @@ module.exports = {
         }
     }
 };
+module.exports = controller;

package/core/server/api/endpoints/previews.js CHANGED Viewed

@@ -7,7 +7,8 @@ const messages = {
     postNotFound: 'Post not found.'
 };
-module.exports = {
+/** @type {import('@tryghost/api-framework').Controller} */
+const controller = {
     docName: 'previews',
     read: {
@@ -47,3 +48,5 @@ module.exports = {
         }
     }
 };
+module.exports = controller;

package/core/server/api/endpoints/recommendations-public.js CHANGED Viewed

@@ -1,6 +1,7 @@
 const recommendations = require('../../services/recommendations');
-module.exports = {
+/** @type {import('@tryghost/api-framework').Controller} */
+const controller = {
     docName: 'recommendations',
     browse: {
@@ -62,3 +63,5 @@ module.exports = {
         }
     }
 };
+module.exports = controller;

package/core/server/api/endpoints/recommendations.js CHANGED Viewed

@@ -1,6 +1,7 @@
 const recommendations = require('../../services/recommendations');
-module.exports = {
+/** @type {import('@tryghost/api-framework').Controller} */
+const controller = {
     docName: 'recommendations',
     browse: {
@@ -107,3 +108,5 @@ module.exports = {
         }
     }
 };
+module.exports = controller;

package/core/server/api/endpoints/redirects.js CHANGED Viewed

@@ -2,7 +2,8 @@ const path = require('path');
 const customRedirects = require('../../services/custom-redirects');
-module.exports = {
+/** @type {import('@tryghost/api-framework').Controller} */
+const controller = {
     docName: 'redirects',
     download: {
@@ -44,3 +45,5 @@ module.exports = {
         }
     }
 };
+module.exports = controller;

package/core/server/api/endpoints/roles.js CHANGED Viewed

@@ -1,6 +1,7 @@
 const models = require('../../models');
-module.exports = {
+/** @type {import('@tryghost/api-framework').Controller} */
+const controller = {
     docName: 'roles',
     browse: {
         headers: {
@@ -20,3 +21,5 @@ module.exports = {
         }
     }
 };
+module.exports = controller;

package/core/server/api/endpoints/schedules.js CHANGED Viewed

@@ -1,8 +1,8 @@
 const models = require('../../models');
 const postSchedulingService = require('../../services/posts/post-scheduling-service')();
-module.exports = {
+/** @type {import('@tryghost/api-framework').Controller} */
+const controller = {
     docName: 'schedules',
     publish: {
         headers: {
@@ -85,3 +85,5 @@ module.exports = {
         }
     }
 };
+module.exports = controller;

package/core/server/api/endpoints/session.js CHANGED Viewed

@@ -8,7 +8,8 @@ const messages = {
     accessDenied: 'Access Denied.'
 };
-const session = {
+/** @type {import('@tryghost/api-framework').Controller} */
+const controller = {
     read(frame) {
         /*
          * TODO
@@ -31,7 +32,7 @@ const session = {
             email: object.username,
             password: object.password
         }).then((user) => {
-            return Promise.resolve((req, res, next) => {
+            return Promise.resolve(function sessionMiddleware(req, res, next) {
                 req.brute.reset(function (err) {
                     if (err) {
                         return next(err);
@@ -60,10 +61,10 @@ const session = {
         });
     },
     delete() {
-        return Promise.resolve((req, res, next) => {
+        return Promise.resolve(function destroySessionMw(req, res, next) {
             auth.session.destroySession(req, res, next);
         });
     }
 };
-module.exports = session;
+module.exports = controller;

package/core/server/api/endpoints/settings-public.js CHANGED Viewed

@@ -2,7 +2,8 @@ const settingsCache = require('../../../shared/settings-cache');
 const urlUtils = require('../../../shared/url-utils');
 const ghostVersion = require('@tryghost/version');
-module.exports = {
+/** @type {import('@tryghost/api-framework').Controller} */
+const controller = {
     docName: 'settings',
     browse: {
@@ -22,3 +23,5 @@ module.exports = {
         }
     }
 };
+module.exports = controller;

package/core/server/api/endpoints/settings.js CHANGED Viewed

@@ -21,7 +21,8 @@ async function getStripeConnectData(frame) {
     }
 }
-module.exports = {
+/** @type {import('@tryghost/api-framework').Controller} */
+const controller = {
     docName: 'settings',
     browse: {
@@ -179,3 +180,5 @@ module.exports = {
         }
     }
 };
+module.exports = controller;

package/core/server/api/endpoints/site.js CHANGED Viewed

@@ -1,6 +1,7 @@
 const publicConfig = require('../../services/public-config');
-const site = {
+/** @type {import('@tryghost/api-framework').Controller} */
+const controller = {
     docName: 'site',
     read: {
@@ -14,4 +15,4 @@ const site = {
     }
 };
-module.exports = site;
+module.exports = controller;

package/core/server/api/endpoints/slack.js CHANGED Viewed

@@ -1,7 +1,8 @@
 // Used to call the slack ping service, iirc this was done to avoid circular deps a long time ago
 const events = require('../../lib/common/events');
-module.exports = {
+/** @type {import('@tryghost/api-framework').Controller} */
+const controller = {
     docName: 'slack',
     sendTest: {
         headers: {
@@ -13,3 +14,5 @@ module.exports = {
         }
     }
 };
+module.exports = controller;

package/core/server/api/endpoints/slugs.js CHANGED Viewed

@@ -12,7 +12,8 @@ const allowedTypes = {
     user: models.User
 };
-module.exports = {
+/** @type {import('@tryghost/api-framework').Controller} */
+const controller = {
     docName: 'slugs',
     generate: {
         headers: {
@@ -52,3 +53,5 @@ module.exports = {
         }
     }
 };
+module.exports = controller;

package/core/server/api/endpoints/snippets.js CHANGED Viewed

@@ -7,7 +7,8 @@ const messages = {
     snippetAlreadyExists: 'Snippet already exists.'
 };
-module.exports = {
+/** @type {import('@tryghost/api-framework').Controller} */
+const controller = {
     docName: 'snippets',
     browse: {
@@ -131,3 +132,5 @@ module.exports = {
         }
     }
 };
+module.exports = controller;

package/core/server/api/endpoints/stats.js CHANGED Viewed

@@ -1,6 +1,7 @@
 const statsService = require('../../services/stats');
-module.exports = {
+/** @type {import('@tryghost/api-framework').Controller} */
+const controller = {
     docName: 'stats',
     memberCountHistory: {
         headers: {
@@ -104,3 +105,5 @@ module.exports = {
         }
     }
 };
+module.exports = controller;

package/core/server/api/endpoints/tags-public.js CHANGED Viewed

@@ -9,7 +9,8 @@ const messages = {
     tagNotFound: 'Tag not found.'
 };
-module.exports = {
+/** @type {import('@tryghost/api-framework').Controller} */
+const controller = {
     docName: 'tags',
     browse: {
@@ -76,3 +77,5 @@ module.exports = {
         }
     }
 };
+module.exports = controller;

package/core/server/api/endpoints/tags.js CHANGED Viewed

@@ -8,7 +8,8 @@ const messages = {
     tagNotFound: 'Tag not found.'
 };
-module.exports = {
+/** @type {import('@tryghost/api-framework').Controller} */
+const controller = {
     docName: 'tags',
     browse: {
@@ -156,3 +157,5 @@ module.exports = {
         }
     }
 };
+module.exports = controller;

package/core/server/api/endpoints/themes.js CHANGED Viewed

@@ -6,7 +6,8 @@ const models = require('../../models');
 const events = require('../../lib/common/events');
 const {settingsCache} = require('../../services/settings-helpers');
-module.exports = {
+/** @type {import('@tryghost/api-framework').Controller} */
+const controller = {
     docName: 'themes',
     browse: {
@@ -180,3 +181,5 @@ module.exports = {
         }
     }
 };
+module.exports = controller;

package/core/server/api/endpoints/tiers-public.js CHANGED Viewed

@@ -1,6 +1,7 @@
 const tiersService = require('../../services/tiers');
-module.exports = {
+/** @type {import('@tryghost/api-framework').Controller} */
+const controller = {
     docName: 'tiers',
     browse: {
@@ -23,3 +24,5 @@ module.exports = {
         }
     }
 };
+module.exports = controller;

package/core/server/api/endpoints/tiers.js CHANGED Viewed

@@ -1,6 +1,7 @@
 const tiersService = require('../../services/tiers');
-module.exports = {
+/** @type {import('@tryghost/api-framework').Controller} */
+const controller = {
     docName: 'tiers',
     browse: {
@@ -80,3 +81,5 @@ module.exports = {
         }
     }
 };
+module.exports = controller;

package/core/server/api/endpoints/users.js CHANGED Viewed

@@ -73,7 +73,8 @@ function shouldInvalidateCacheAfterChange(model) {
     return false;
 }
-module.exports = {
+/** @type {import('@tryghost/api-framework').Controller} */
+const controller = {
     docName: 'users',
     browse: {
@@ -287,3 +288,5 @@ module.exports = {
         }
     }
 };
+module.exports = controller;

package/core/server/api/endpoints/utils/index.js CHANGED Viewed

@@ -19,17 +19,25 @@ module.exports = {
      * is a Content API implementation -  see index.js file.
      *
      * @TODO: Move this helper function into a utils.js file.
-     * @param {Object} frame
+     * @param {import('@tryghost/api-framework').Frame} frame
      * @return {boolean}
      */
     isContentAPI: (frame) => {
         return frame.apiType === 'content';
     },
+    /**
+     * @param {import('@tryghost/api-framework').Frame} frame
+     * @returns {boolean}
+     */
     isMembersAPI: (frame) => {
         return frame.apiType === 'members';
     },
+    /**
+     * @param {import('@tryghost/api-framework').Frame} frame
+     * @returns {boolean}
+     */
     isInternal: (frame) => {
         return frame.options.context && frame.options.context.internal;
     }

package/core/server/api/endpoints/utils/permissions.js CHANGED Viewed

@@ -12,7 +12,7 @@ const messages = {
  * @description Handle requests, which need authentication.
  *
  * @param {Object} apiConfig - Docname & method of API ctrl
- * @param {Object} frame
+ * @param {import('@tryghost/api-framework').Frame} frame
  * @return {Promise}
  */
 const nonePublicAuth = (apiConfig, frame) => {
@@ -81,7 +81,7 @@ module.exports = {
      * @description Handle permission stage for API.
      *
      * @param {Object} apiConfig - Docname & method of target ctrl.
-     * @param {Object} frame
+     * @param {import('@tryghost/api-framework').Frame} frame
      * @return {Promise}
      */
     handle(apiConfig, frame) {