ghost 5.2.2 → 5.3.0

package/core/server/api/endpoints/comments-comments.js

@@ -0,0 +1,247 @@
+const Promise = require('bluebird');
+const tpl = require('@tryghost/tpl');
+const errors = require('@tryghost/errors');
+const models = require('../../models');
+const db = require('../../data/db');
+const ALLOWED_INCLUDES = ['post', 'member', 'likes', 'replies'];
+const UNSAFE_ATTRS = ['status'];
+
+const messages = {
+    commentNotFound: 'Comment could not be found',
+    memberNotFound: 'Unable to find member',
+    likeNotFound: 'Unable to find like',
+    alreadyLiked: 'This comment was liked already'
+};
+
+module.exports = {
+    docName: 'comments',
+
+    browse: {
+        options: [
+            'include',
+            'page',
+            'limit',
+            'fields',
+            'filter',
+            'order',
+            'debug'
+        ],
+        validation: {
+            options: {
+                include: ALLOWED_INCLUDES
+            }
+        },
+        permissions: true,
+        query(frame) {
+            return models.Comment.findPage(frame.options);
+        }
+    },
+
+    read: {
+        options: [
+            'include'
+        ],
+        data: [
+            'id',
+            'email'
+        ],
+        validation: {
+            options: {
+                include: ALLOWED_INCLUDES
+            }
+        },
+        permissions: true,
+        query(frame) {
+            return models.Comment.findOne(frame.data, frame.options)
+                .then((model) => {
+                    if (!model) {
+                        return Promise.reject(new errors.NotFoundError({
+                            message: tpl(messages.commentNotFound)
+                        }));
+                    }
+
+                    return model;
+                });
+        }
+    },
+
+    edit: {
+        headers: {},
+        options: [
+            'id',
+            'include'
+        ],
+        validation: {
+            options: {
+                include: {
+                    values: ALLOWED_INCLUDES
+                },
+                id: {
+                    required: true
+                }
+            }
+        },
+        permissions: true,
+        query(frame) {
+            return models.Comment.edit(frame.data.comments[0], frame.options)
+                .then((model) => {
+                    if (!model) {
+                        return Promise.reject(new errors.NotFoundError({
+                            message: tpl(messages.commentNotFound)
+                        }));
+                    }
+
+                    return model;
+                });
+        }
+    },
+
+    add: {
+        statusCode: 201,
+        options: [
+            'include'
+
+        ],
+        validation: {
+            options: {
+                include: ALLOWED_INCLUDES
+            },
+            data: {
+                post_id: {
+                    required: true
+                }
+            }
+        },
+        permissions: {
+            unsafeAttrs: UNSAFE_ATTRS
+        },
+        query(frame) {
+            // TODO: move to comment service
+            const data = frame.data.comments[0];
+
+            if (frame.options?.context?.member?.id) {
+                data.member_id = frame.options.context.member.id;
+
+                // todo: add validation that the parent comment is on the same post, and not deleted
+                return models.Comment.add(data, frame.options);
+            } else {
+                return Promise.reject(new errors.NotFoundError({
+                    message: tpl(messages.memberNotFound)
+                }));
+            }
+        }
+    },
+
+    destroy: {
+        statusCode: 204,
+        options: [
+            'include',
+            'id'
+        ],
+        validation: {
+            options: {
+                include: ALLOWED_INCLUDES
+            }
+        },
+        permissions: true,
+        query(frame) {
+            frame.options.require = true;
+
+            return models.Comment.destroy(frame.options)
+                .then(() => null)
+                .catch(models.Comment.NotFoundError, () => {
+                    return Promise.reject(new errors.NotFoundError({
+                        message: tpl(messages.commentNotFound)
+                    }));
+                });
+        }
+    },
+
+    counts: {
+        permissions: false,
+        async query(frame) {
+            const query = db.knex('comments')
+                .select(db.knex.raw(`COUNT(*) AS count, post_id`))
+                .groupBy('post_id');
+
+            if (Array.isArray(frame?.data?.ids)) {
+                query.whereIn('post_id', frame.data.ids);
+            }
+
+            const results = await query;
+
+            const counts = {};
+
+            for (const row of results) {
+                counts[row.post_id] = row.count;
+            }
+
+            return counts;
+        }
+    },
+
+    like: {
+        statusCode: 204,
+        options: [
+            'id'
+        ],
+        validation: {
+        },
+        permissions: true,
+        async query(frame) {
+            // TODO: move to likes service
+            if (frame.options?.context?.member?.id) {
+                const data = {
+                    member_id: frame.options.context.member.id,
+                    comment_id: frame.options.id
+                };
+
+                const existing = await models.CommentLike.findOne(data, frame.options);
+
+                if (existing) {
+                    throw new errors.BadRequestError({
+                        message: tpl(messages.alreadyLiked)
+                    });
+                }
+
+                return await models.CommentLike.add(data, frame.options);
+            } else {
+                throw new errors.NotFoundError({
+                    message: tpl(messages.memberNotFound)
+                });
+            }
+        }
+    },
+
+    unlike: {
+        statusCode: 204,
+        options: [
+            'id'
+        ],
+        validation: {},
+        permissions: true,
+        query(frame) {
+            frame.options.require = true;
+
+            // TODO: move to likes service
+            if (frame.options?.context?.member?.id) {
+                return models.CommentLike.destroy({
+                    ...frame.options,
+                    destroyBy: {
+                        member_id: frame.options.context.member.id,
+                        comment_id: frame.options.id
+                    }
+                }).then(() => null)
+                    .catch(models.CommentLike.NotFoundError, () => {
+                        return Promise.reject(new errors.NotFoundError({
+                            message: tpl(messages.likeNotFound)
+                        }));
+                    });
+            } else {
+                return Promise.reject(new errors.NotFoundError({
+                    message: tpl(messages.memberNotFound)
+                }));
+            }
+        }
+    }
+};

package/core/server/api/endpoints/comments.js

@@ -0,0 +1,25 @@
+const models = require('../../models');
+
+module.exports = {
+    docName: 'comments',
+
+    edit: {
+        options: [
+            'id'
+        ],
+        validation: {
+            options: {
+                id: {
+                    required: true
+                }
+            }
+        },
+        permissions: true,
+        query(frame) {
+            return models.Comment.edit({
+                id: frame.data.comments[0].id,
+                status: frame.data.comments[0].status
+            }, frame.options);
+        }
+    }
+};

package/core/server/api/endpoints/explore.js

@@ -0,0 +1,12 @@
+const exploreService = require('../../services/explore');
+
+module.exports = {
+    docName: 'explore',
+
+    read: {
+        permissions: true,
+        query() {
+            return exploreService.fetchData();
+        }
+    }
+};

package/core/server/api/{canary → endpoints}/index.js

@@ -137,6 +137,10 @@ module.exports = {
         return shared.pipeline(require('./config'), localUtils);
     },
 
+    get explore() {
+        return shared.pipeline(require('./explore'), localUtils);
+    },
+
     get themes() {
         return shared.pipeline(require('./themes'), localUtils);
     },
@@ -177,6 +181,10 @@ module.exports = {
         return shared.pipeline(require('./newsletters'), localUtils);
     },
 
+    get comments() {
+        return shared.pipeline(require('./comments'), localUtils);
+    },
+
     /**
      * Content API Controllers
      *
@@ -215,5 +223,13 @@ module.exports = {
 
     get offersPublic() {
         return shared.pipeline(require('./offers-public'), localUtils, 'content');
+    },
+
+    /**
+     * Comment API
+     */
+
+    get commentsComments() {
+        return shared.pipeline(require('./comments-comments'), localUtils, 'comments');
     }
 };

package/core/server/api/{canary → endpoints}/utils/permissions.js

@@ -1,4 +1,4 @@
-const debug = require('@tryghost/debug')('api:canary:utils:permissions');
+const debug = require('@tryghost/debug')('api:endpoints:utils:permissions');
 const Promise = require('bluebird');
 const _ = require('lodash');
 const permissions = require('../../../services/permissions');
@@ -79,7 +79,7 @@ const nonePublicAuth = (apiConfig, frame) => {
 // @TODO: https://github.com/TryGhost/Ghost/issues/10735
 module.exports = {
     /**
-     * @description Handle permission stage for canary API.
+     * @description Handle permission stage for API.
      *
      * @param {Object} apiConfig - Docname & method of target ctrl.
      * @param {Object} frame
@@ -92,7 +92,7 @@ module.exports = {
         frame.options.context = permissions.parseContext(frame.options.context);
 
         // CASE: Content API access
-        if (frame.options.context.public) {
+        if (frame.options.context.public && frame.apiType !== 'comments') {
             debug('check content permissions');
 
             // @TODO: Remove when we drop v0.1

package/core/server/api/{canary → endpoints}/utils/serializers/input/authors.js

@@ -1,4 +1,4 @@
-const debug = require('@tryghost/debug')('api:canary:utils:serializers:input:authors');
+const debug = require('@tryghost/debug')('api:endpoints:utils:serializers:input:authors');
 const slugFilterOrder = require('./utils/slug-filter-order');
 const utils = require('../../index');
 

package/core/server/api/{canary → endpoints}/utils/serializers/input/db.js

@@ -1,5 +1,5 @@
 const _ = require('lodash');
-const debug = require('@tryghost/debug')('api:canary:utils:serializers:input:db');
+const debug = require('@tryghost/debug')('api:endpoints:utils:serializers:input:db');
 const optionsUtil = require('../../../../shared/utils/options');
 
 const INTERNAL_OPTIONS = ['transacting', 'forUpdate'];

package/core/server/api/{canary → endpoints}/utils/serializers/input/integrations.js

@@ -1,5 +1,5 @@
 const _ = require('lodash');
-const debug = require('@tryghost/debug')('api:canary:utils:serializers:input:integrations');
+const debug = require('@tryghost/debug')('api:endpoints:utils:serializers:input:integrations');
 
 function setDefaultFilter(frame) {
     if (frame.options.filter) {

package/core/server/api/{canary → endpoints}/utils/serializers/input/members.js

@@ -1,5 +1,5 @@
 const _ = require('lodash');
-const debug = require('@tryghost/debug')('api:canary:utils:serializers:input:members');
+const debug = require('@tryghost/debug')('api:endpoints:utils:serializers:input:members');
 const mapNQLKeyValues = require('@tryghost/nql').utils.mapKeyValues;
 
 function defaultRelations(frame) {

package/core/server/api/{canary → endpoints}/utils/serializers/input/pages.js

@@ -1,5 +1,5 @@
 const _ = require('lodash');
-const debug = require('@tryghost/debug')('api:canary:utils:serializers:input:pages');
+const debug = require('@tryghost/debug')('api:endpoints:utils:serializers:input:pages');
 const mobiledoc = require('../../../../../lib/mobiledoc');
 const url = require('./utils/url');
 const slugFilterOrder = require('./utils/slug-filter-order');

package/core/server/api/{canary → endpoints}/utils/serializers/input/posts.js

@@ -1,5 +1,5 @@
 const _ = require('lodash');
-const debug = require('@tryghost/debug')('api:canary:utils:serializers:input:posts');
+const debug = require('@tryghost/debug')('api:endpoints:utils:serializers:input:posts');
 const url = require('./utils/url');
 const slugFilterOrder = require('./utils/slug-filter-order');
 const localUtils = require('../../index');

package/core/server/api/{canary → endpoints}/utils/serializers/input/settings.js

@@ -55,7 +55,8 @@ const EDITABLE_SETTINGS = [
     'accent_color',
     'editor_default_email_recipients',
     'editor_default_email_recipients_filter',
-    'labs'
+    'labs',
+    'comments_enabled'
 ];
 
 module.exports = {

package/core/server/api/{canary → endpoints}/utils/serializers/input/tags.js

@@ -1,4 +1,4 @@
-const debug = require('@tryghost/debug')('api:canary:utils:serializers:input:tags');
+const debug = require('@tryghost/debug')('api:endpoints:utils:serializers:input:tags');
 const url = require('./utils/url');
 const slugFilterOrder = require('./utils/slug-filter-order');
 const utils = require('../../index');

package/core/server/api/{canary → endpoints}/utils/serializers/input/users.js

@@ -1,4 +1,4 @@
-const debug = require('@tryghost/debug')('api:canary:utils:serializers:input:users');
+const debug = require('@tryghost/debug')('api:endpoints:utils:serializers:input:users');
 const url = require('./utils/url');
 
 module.exports = {

package/core/server/api/{canary → endpoints}/utils/serializers/input/webhooks.js

@@ -1,5 +1,5 @@
 const _ = require('lodash');
-const debug = require('@tryghost/debug')('api:canary:utils:serializers:input:webhooks');
+const debug = require('@tryghost/debug')('api:endpoints:utils:serializers:input:webhooks');
 
 module.exports = {
     add(apiConfig, frame) {

package/core/server/api/{canary → endpoints}/utils/serializers/output/all.js

@@ -1,4 +1,4 @@
-const debug = require('@tryghost/debug')('api:canary:utils:serializers:output:all');
+const debug = require('@tryghost/debug')('api:endpoints:utils:serializers:output:all');
 const _ = require('lodash');
 
 const removeXBY = (object) => {

package/core/server/api/{canary → endpoints}/utils/serializers/output/authentication.js

@@ -1,6 +1,6 @@
 const tpl = require('@tryghost/tpl');
 const mappers = require('./mappers');
-const debug = require('@tryghost/debug')('api:canary:utils:serializers:output:authentication');
+const debug = require('@tryghost/debug')('api:endpoints:utils:serializers:output:authentication');
 
 const messages = {
     checkEmailForInstructions: 'Check your email for further instructions.',

package/core/server/api/endpoints/utils/serializers/output/comments.js

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

package/core/server/api/{canary → endpoints}/utils/serializers/output/config.js

@@ -1,5 +1,5 @@
 const _ = require('lodash');
-const debug = require('@tryghost/debug')('api:canary:utils:serializers:output:config');
+const debug = require('@tryghost/debug')('api:endpoints:utils:serializers:output:config');
 
 module.exports = {
     all(data, apiConfig, frame) {

package/core/server/api/{canary → endpoints}/utils/serializers/output/db.js

@@ -1,4 +1,4 @@
-const debug = require('@tryghost/debug')('api:canary:utils:serializers:output:db');
+const debug = require('@tryghost/debug')('api:endpoints:utils:serializers:output:db');
 
 module.exports = {
     backupContent(filename, apiConfig, frame) {

package/core/server/api/{canary → endpoints}/utils/serializers/output/default.js

@@ -1,4 +1,4 @@
-const debug = require('@tryghost/debug')('api:canary:utils:serializers:output:default');
+const debug = require('@tryghost/debug')('api:endpoints:utils:serializers:output:default');
 const mappers = require('./mappers');
 
 const mapResponse = (docName, mappable, frame) => {

package/core/server/api/endpoints/utils/serializers/output/explore.js

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

package/core/server/api/{canary → endpoints}/utils/serializers/output/images.js

@@ -1,4 +1,4 @@
-const debug = require('@tryghost/debug')('api:canary:utils:serializers:output:images');
+const debug = require('@tryghost/debug')('api:endpoints:utils:serializers:output:images');
 const mappers = require('./mappers');
 
 module.exports = {