strapi-plugin-comments 2.1.0-beta.1 → 2.1.0

package/server/routes/client.js

@@ -7,6 +7,12 @@ const routes = [
         handler: "client.findAllInHierarchy",
         config: {
             policies: [],
+            description: "Find all comments related to configured Collection / Single Type and return them in a nested structure",
+            tag: {
+                plugin: "comments",
+                name: "Comments",
+                actionType: "find",
+            },
         },
     },
     {
@@ -15,6 +21,12 @@ const routes = [
         handler: "client.post",
         config: {
             policies: [],
+            description: "Post a comment against configured Collection / Single Type",
+            tag: {
+                plugin: "comments",
+                name: "Comments",
+                actionType: "create",
+            },
         },
     },
     {
@@ -23,6 +35,12 @@ const routes = [
         handler: "client.findAllFlat",
         config: {
             policies: [],
+            description: "Find all comments related to configured Collection / Single Type and return them in a flat structure for further processing",
+            tag: {
+                plugin: "comments",
+                name: "Comments",
+                actionType: "find",
+            },
         },
     },
     {
@@ -31,6 +49,12 @@ const routes = [
         handler: "client.put",
         config: {
             policies: [],
+            description: "Update comment related to configured Collection / Single Type if user is the author",
+            tag: {
+                plugin: "comments",
+                name: "Comments",
+                actionType: "update",
+            },
         },
     },
     {
@@ -39,14 +63,26 @@ const routes = [
         handler: "client.reportAbuse",
         config: {
             policies: [],
+            description: "Report an abuse against comment for configured Collection / Single Type",
+            tag: {
+                plugin: "comments",
+                name: "Comments",
+                actionType: "create",
+            },
         },
     },
     {
         method: "DELETE",
-        path: "/:relationId/comment/:commentId",
+        path: "/:relation/comment/:commentId",
         handler: "client.removeComment",
         config: {
             policies: [],
+            description: "Remove comment related to configured Collection / Single Type if user is the author",
+            tag: {
+                plugin: "comments",
+                name: "Comments",
+                actionType: "delete",
+            },
         },
     },
 ];

package/server/services/admin.js

@@ -7,6 +7,7 @@ const lodash_1 = require("lodash");
 const error_1 = __importDefault(require("./../utils/error"));
 const functions_2 = require("./utils/functions");
 const constants_1 = require("./../utils/constants");
+const DEFAULT_AUTHOR_POPULATE = { avatar: true };
 module.exports = ({ strapi }) => ({
     getCommonService() {
         return (0, functions_1.getPluginService)("common");
@@ -97,7 +98,7 @@ module.exports = ({ strapi }) => ({
             .findMany({
             ...params,
             populate: {
-                authorUser: true,
+                authorUser: { populate: DEFAULT_AUTHOR_POPULATE },
                 threadOf: true,
                 reports: {
                     where: {
@@ -111,7 +112,7 @@ module.exports = ({ strapi }) => ({
         });
         const relatedEntities = await this.getCommonService().findRelatedEntitiesFor(entities);
         const result = entities
-            .map((_) => (0, functions_2.filterOurResolvedReports)(this.getCommonService().sanitizeCommentEntity(_)))
+            .map((_) => (0, functions_2.filterOurResolvedReports)(this.getCommonService().sanitizeCommentEntity(_, DEFAULT_AUTHOR_POPULATE)))
             .map((_) => this.getCommonService().mergeRelatedEntityTo(_, relatedEntities));
         const pageCount = Math.floor(total / pageSize);
         return {
@@ -139,10 +140,14 @@ module.exports = ({ strapi }) => ({
         };
         const defaultPopulate = {
             populate: {
-                authorUser: true,
+                authorUser: {
+                    populate: DEFAULT_AUTHOR_POPULATE,
+                },
                 threadOf: {
                     populate: {
-                        authorUser: true,
+                        authorUser: {
+                            populate: DEFAULT_AUTHOR_POPULATE,
+                        },
                         ...reportsPopulation,
                     },
                 },
@@ -192,7 +197,7 @@ module.exports = ({ strapi }) => ({
         const selectedEntity = this.getCommonService().sanitizeCommentEntity({
             ...entity,
             threadOf: entity.threadOf || null,
-        });
+        }, DEFAULT_AUTHOR_POPULATE);
         return {
             entity: relatedEntity,
             selected: selectedEntity,

package/server/services/client.js

@@ -11,13 +11,17 @@ module.exports = ({ strapi }) => ({
     getCommonService() {
         return (0, functions_1.getPluginService)("common");
     },
-    async create(relation, data, user = undefined) {
+    async create(relation, data, user) {
         const { content, threadOf } = data;
         const singleRelationFulfilled = relation && constants_1.REGEX.relatedUid.test(relation);
         if (!singleRelationFulfilled) {
             throw new error_1.default(400, `Field "related" got incorrect format, use format like "api::<collection name>.<content type name>:<entity id>"`);
         }
         const [uid, relatedId] = await this.getCommonService().parseRelationString(relation);
+        const isEnabledCollection = await this.getCommonService().isEnabledCollection(uid);
+        if (!isEnabledCollection) {
+            throw new error_1.default(400, `Field "related" refer to not enabled collection. Please amend the plugin settings and try again`);
+        }
         const relatedEntity = await strapi.db
             .query(uid)
             .findOne(relatedId);
@@ -26,29 +30,32 @@ module.exports = ({ strapi }) => ({
         }
         const approvalFlow = await this.getCommonService().getConfig(constants_1.CONFIG_PARAMS.APPROVAL_FLOW, []);
         const isApprovalFlowEnabled = approvalFlow.includes(uid) || relatedEntity.requireCommentsApproval;
-        const linkToThread = !(0, lodash_1.isNil)(threadOf)
-            ? await this.getCommonService().findOne({
-                id: threadOf,
-                related: relation,
-            })
-            : undefined;
-        const validContext = this.getCommonService().isValidUserContext(user);
-        if (linkToThread === null) {
+        let linkToThread;
+        try {
+            linkToThread = !(0, lodash_1.isNil)(threadOf)
+                ? await this.getCommonService().findOne({
+                    id: threadOf,
+                    related: relation,
+                })
+                : null;
+        }
+        catch (e) {
             throw new error_1.default(400, "Thread does not exist");
         }
+        const validContext = this.getCommonService().isValidUserContext(user);
         if (!validContext) {
             throw (0, functions_2.resolveUserContextError)(user);
         }
         if ((await this.getCommonService().checkBadWords(content)) &&
             singleRelationFulfilled) {
-            const { author = {}, ...rest } = data;
+            const { author, ...rest } = data;
             let authorData = {};
             if (validContext && user) {
                 authorData = {
                     authorUser: user?.id,
                 };
             }
-            else {
+            else if (author) {
                 if (author.email && !constants_1.REGEX.email.test(author.email)) {
                     throw new error_1.default(400, 'Field: "author.email". Author e-mail is not valid value. Check your payload');
                 }
@@ -56,11 +63,11 @@ module.exports = ({ strapi }) => ({
                     authorId: author.id,
                     authorName: author.name,
                     authorEmail: author.email,
-                    authorAvatar: author.avatar,
+                    authorAvatar: (0, lodash_1.isString)(author.avatar) ? author.avatar : undefined,
                 };
             }
-            if (!(0, lodash_1.isEmpty)(authorData) &&
-                !(authorData.authorId || authorData.authorUser)) {
+            const authorNotProperlyProvided = !(0, lodash_1.isEmpty)(authorData) && !(authorData.authorId || authorData.authorUser);
+            if ((0, lodash_1.isEmpty)(authorData) || authorNotProperlyProvided) {
                 throw new error_1.default(400, `Not able to recognise author of a comment. Make sure you've provided "author" property in a payload or authenticated your request properly.`);
             }
             if (isApprovalFlowEnabled &&
@@ -85,12 +92,12 @@ module.exports = ({ strapi }) => ({
             });
             return this.getCommonService().sanitizeCommentEntity({
                 ...entity,
-                threadOf: !(0, lodash_1.isNil)(threadOf) ? linkToThread : null,
+                threadOf: linkToThread,
             });
         }
         throw new error_1.default(400, "No content received");
     },
-    async update(id, relation, data, user = undefined) {
+    async update(id, relation, data, user) {
         const { content } = data;
         const singleRelationFulfilled = relation && constants_1.REGEX.relatedUid.test(relation);
         if (!singleRelationFulfilled) {
@@ -119,45 +126,50 @@ module.exports = ({ strapi }) => ({
         }
         throw new error_1.default(403, `You're not allowed to take an action on that entity. Make sure you've provided "author" property in a payload or authenticated your request properly.`);
     },
-    async reportAbuse(id, relation, payload, user = undefined) {
+    async reportAbuse(id, relation, payload, user) {
         if (!this.getCommonService().isValidUserContext(user)) {
             throw (0, functions_2.resolveUserContextError)(user);
         }
         await this.getCommonService().parseRelationString(relation);
-        const reportAgainstEntity = await this.getCommonService().findOne({
-            id,
-            related: relation,
-        });
-        if (reportAgainstEntity) {
-            const entity = await strapi.db
-                .query((0, functions_2.getModelUid)("comment-report"))
-                .create({
-                data: {
-                    ...payload,
-                    resolved: false,
-                    related: id,
-                },
+        try {
+            const reportAgainstEntity = await this.getCommonService().findOne({
+                id,
+                related: relation,
             });
-            if (entity) {
-                const response = {
-                    ...entity,
-                    related: reportAgainstEntity,
-                };
-                try {
-                    await this.sendAbuseReportEmail(entity.reason, entity.content);
-                    return response;
+            if (reportAgainstEntity) {
+                const entity = await strapi.db
+                    .query((0, functions_2.getModelUid)("comment-report"))
+                    .create({
+                    data: {
+                        ...payload,
+                        resolved: false,
+                        related: id,
+                    },
+                });
+                if (entity) {
+                    const response = {
+                        ...entity,
+                        related: reportAgainstEntity,
+                    };
+                    try {
+                        await this.sendAbuseReportEmail(entity.reason, entity.content);
+                        return response;
+                    }
+                    catch (err) {
+                        return response;
+                    }
                 }
-                catch (err) {
-                    return response;
+                else {
+                    throw new error_1.default(500, "Report cannot be created");
                 }
             }
-            else {
-                throw new error_1.default(500, "Report cannot be created");
-            }
+            throw new error_1.default(403, `You're not allowed to take an action on that entity. Make sure that comment exist or you've authenticated your request properly.`);
+        }
+        catch (e) {
+            throw new error_1.default(403, `You're not allowed to take an action on that entity. Make sure that comment exist or you've authenticated your request properly.`);
         }
-        throw new error_1.default(403, `You're not allowed to take an action on that entity. Make sure that comment exist or you've authenticated your request properly.`);
     },
-    async markAsRemoved(id, relation, authorId, user = undefined) {
+    async markAsRemoved(id, relation, authorId, user) {
         if (!this.getCommonService().isValidUserContext(user)) {
             throw (0, functions_2.resolveUserContextError)(user);
         }

package/server/services/common.js

@@ -32,9 +32,11 @@ module.exports = ({ strapi }) => ({
         const result = strapi.config.get(`plugin.comments${queryProp ? "." + queryProp : ""}`);
         return (0, lodash_1.isNil)(result) ? defaultValue : result;
     },
-    async findAllFlat({ query = {}, populate = {}, sort, pagination }, relatedEntity = null) {
-        const defaultPopulate = {
+    async findAllFlat({ query = {}, populate = {}, sort, pagination, fields, }, relatedEntity = null) {
+        const defaultSelect = ["id", "related"];
+        const populateClause = {
             authorUser: true,
+            ...((0, lodash_1.isObject)(populate) ? populate : {}),
         };
         let queryExtension = {};
         if (sort && ((0, lodash_1.isString)(sort) || (0, lodash_1.isArray)(sort))) {
@@ -48,6 +50,12 @@ module.exports = ({ strapi }) => ({
                 }, {}),
             };
         }
+        if (!(0, lodash_1.isNil)(fields)) {
+            queryExtension = {
+                ...queryExtension,
+                select: (0, lodash_1.isArray)(fields) ? (0, lodash_1.uniq)([...fields, ...defaultSelect]) : fields,
+            };
+        }
         let meta = {};
         if (pagination && (0, lodash_1.isObject)(pagination)) {
             const parsedpagination = Object.keys(pagination).reduce((prev, curr) => ({
@@ -85,8 +93,7 @@ module.exports = ({ strapi }) => ({
                 ...query,
             },
             populate: {
-                ...defaultPopulate,
-                ...populate,
+                ...populateClause,
             },
             ...queryExtension,
         });
@@ -137,12 +144,16 @@ module.exports = ({ strapi }) => ({
             const parsedThreadOf = (0, lodash_1.isString)(query.threadOf)
                 ? (0, lodash_1.parseInt)(query.threadOf)
                 : query.threadOf;
+            let authorUserPopulate = {};
+            if ((0, lodash_1.isObject)(populateClause?.authorUser)) {
+                authorUserPopulate = populateClause.authorUser;
+            }
             return this.sanitizeCommentEntity({
                 ..._,
                 threadOf: parsedThreadOf || _.threadOf || null,
                 gotThread: (threadedItem?.itemsInTread || 0) > 0,
                 threadFirstItemId: threadedItem?.firstThreadItemId,
-            });
+            }, authorUserPopulate);
         });
         return {
             data: hasRelatedEntitiesToMap
@@ -151,8 +162,8 @@ module.exports = ({ strapi }) => ({
             ...((0, lodash_1.isEmpty)(meta) ? {} : { meta }),
         };
     },
-    async findAllInHierarchy({ query, populate = {}, sort, startingFromId = null, dropBlockedThreads = false, }, relatedEntity) {
-        const entities = await this.findAllFlat({ query, populate, sort }, relatedEntity);
+    async findAllInHierarchy({ query, populate = {}, sort, fields, startingFromId = null, dropBlockedThreads = false, }, relatedEntity) {
+        const entities = await this.findAllFlat({ query, populate, sort, fields }, relatedEntity);
         return (0, functions_1.buildNestedStructure)(entities?.data, startingFromId, "threadOf", dropBlockedThreads, false);
     },
     async findOne(criteria) {
@@ -222,14 +233,17 @@ module.exports = ({ strapi }) => ({
             return false;
         }
     },
-    sanitizeCommentEntity(entity) {
+    sanitizeCommentEntity(entity, populate) {
+        const fieldsToPopulate = (0, lodash_1.isArray)(populate)
+            ? populate
+            : Object.keys(populate || {});
         return {
             ...(0, functions_1.buildAuthorModel)({
                 ...entity,
                 threadOf: (0, lodash_1.isObject)(entity.threadOf)
-                    ? (0, functions_1.buildAuthorModel)(entity.threadOf)
+                    ? (0, functions_1.buildAuthorModel)(entity.threadOf, fieldsToPopulate)
                     : entity.threadOf,
-            }),
+            }, fieldsToPopulate),
         };
     },
     isValidUserContext(user) {
@@ -241,8 +255,9 @@ module.exports = ({ strapi }) => ({
         const relatedId = (0, lodash_1.isNumber)(parsedRelatedId)
             ? parsedRelatedId
             : relatedStringId;
+        const isEnabledCollection = await this.isEnabledCollection(uid);
         const enabledCollections = await this.getConfig(constants_1.CONFIG_PARAMS.ENABLED_COLLECTIONS, []);
-        if (!enabledCollections.includes(uid)) {
+        if (!isEnabledCollection) {
             throw new error_1.default(403, `Action not allowed for collection '${uid}'. Use one of: ${enabledCollections.join(", ")}`);
         }
         return [uid, relatedId];
@@ -262,5 +277,9 @@ module.exports = ({ strapi }) => ({
         }
         return content;
     },
+    async isEnabledCollection(uid) {
+        const enabledCollections = await this.getConfig("enabledCollections", []);
+        return enabledCollections.includes(uid);
+    },
 });
 //# sourceMappingURL=common.js.map

package/server/services/utils/functions.d.ts

@@ -7,7 +7,7 @@ export declare const getRelatedGroups: (related: string) => Array<string>;
 export declare const getModelUid: (name: string) => string;
 export declare const filterOurResolvedReports: (item: Comment) => Comment;
 export declare const convertContentTypeNameToSlug: (str: string) => string;
-export declare const buildAuthorModel: (item: Comment) => Comment;
+export declare const buildAuthorModel: (item: Comment, fieldsToPopulate?: Array<string>) => Comment;
 export declare const buildConfigQueryProp: (prop?: undefined | string | Array<string>) => string;
 export declare const resolveUserContextError: (user: StrapiUser) => PluginError;
 //# sourceMappingURL=functions.d.ts.map

package/server/services/utils/functions.js

@@ -64,16 +64,21 @@ const convertContentTypeNameToSlug = (str) => {
         : plainConversion;
 };
 exports.convertContentTypeNameToSlug = convertContentTypeNameToSlug;
-const buildAuthorModel = (item) => {
+const buildAuthorModel = (item, fieldsToPopulate = []) => {
     const { authorUser, authorId, authorName, authorEmail, authorAvatar, ...rest } = item;
     let author = {};
     if (authorUser) {
-        author = {
+        author = fieldsToPopulate.reduce((prev, curr) => ({
+            ...prev,
+            [curr]: authorUser[curr],
+        }), {
             id: authorUser.id,
             name: authorUser.username,
             email: authorUser.email,
-            avatar: authorUser.avatar,
-        };
+            avatar: (0, lodash_1.isString)(authorUser.avatar) || (0, lodash_1.isObject)(authorUser.avatar)
+                ? authorUser.avatar
+                : undefined,
+        });
     }
     else if (authorId) {
         author = {