strapi-plugin-comments 2.2.4 → 2.2.6

package/server/services/admin.js

@@ -35,9 +35,11 @@ module.exports = ({ strapi }) => ({
         const entryLabel = getConfigProp("entryLabel");
         const approvalFlow = getConfigProp("approvalFlow");
         const reportReasons = getConfigProp("reportReasons");
+        const blockedAuthorProps = getConfigProp("blockedAuthorProps");
         const result = {
             entryLabel,
             approvalFlow,
+            blockedAuthorProps,
             reportReasons,
             ...additionalConfiguration,
         };
@@ -119,7 +121,7 @@ module.exports = ({ strapi }) => ({
         });
         const relatedEntities = await this.getCommonService().findRelatedEntitiesFor(entities);
         const result = entities
-            .map((_) => (0, functions_2.filterOurResolvedReports)(this.getCommonService().sanitizeCommentEntity(_, defaultAuthorUserPopulate?.populate)))
+            .map((_) => (0, functions_2.filterOurResolvedReports)(this.getCommonService().sanitizeCommentEntity(_, [], defaultAuthorUserPopulate?.populate)))
             .map((_) => this.getCommonService().mergeRelatedEntityTo(_, relatedEntities));
         const pageCount = Math.floor(total / pageSize);
         return {
@@ -194,8 +196,8 @@ module.exports = ({ strapi }) => ({
                 related: this.getCommonService().sanitizeCommentEntity({
                     ..._.related,
                     gotThread: isCommentWithThread,
-                }),
-            }, defaultAuthorUserPopulate?.populate));
+                }, []),
+            }, [], defaultAuthorUserPopulate?.populate));
         });
         const pageCount = Math.floor(total / pageSize);
         return {
@@ -289,7 +291,7 @@ module.exports = ({ strapi }) => ({
         const selectedEntity = this.getCommonService().sanitizeCommentEntity({
             ...entity,
             threadOf: entity.threadOf || null,
-        }, defaultAuthorUserPopulate?.populate);
+        }, [], defaultAuthorUserPopulate?.populate);
         return {
             entity: relatedEntity,
             selected: selectedEntity,
@@ -306,7 +308,7 @@ module.exports = ({ strapi }) => ({
                 blocked: !(0, lodash_1.isNil)(forceStatus) ? forceStatus : !existingEntity.blocked,
             },
         });
-        return this.getCommonService().sanitizeCommentEntity(changedEntity);
+        return this.getCommonService().sanitizeCommentEntity(changedEntity, []);
     },
     async deleteComment(id) {
         const changedEntity = await strapi.db
@@ -317,7 +319,7 @@ module.exports = ({ strapi }) => ({
                 removed: true,
             },
         });
-        return this.getCommonService().sanitizeCommentEntity(changedEntity);
+        return this.getCommonService().sanitizeCommentEntity(changedEntity, []);
     },
     async blockCommentThread(id, forceStatus) {
         const existingEntity = await this.getCommonService().findOne({ id });
@@ -334,7 +336,7 @@ module.exports = ({ strapi }) => ({
             },
         });
         await this.blockNestedThreads(id, changedEntity.blockedThread);
-        return this.getCommonService().sanitizeCommentEntity(changedEntity);
+        return this.getCommonService().sanitizeCommentEntity(changedEntity, []);
     },
     async approveComment(id) {
         const changedEntity = await strapi.db
@@ -343,7 +345,7 @@ module.exports = ({ strapi }) => ({
             where: { id },
             data: { approvalStatus: constants_1.APPROVAL_STATUS.APPROVED },
         });
-        return this.getCommonService().sanitizeCommentEntity(changedEntity);
+        return this.getCommonService().sanitizeCommentEntity(changedEntity, []);
     },
     async rejectComment(id) {
         const changedEntity = await strapi.db
@@ -352,7 +354,7 @@ module.exports = ({ strapi }) => ({
             where: { id },
             data: { approvalStatus: constants_1.APPROVAL_STATUS.REJECTED },
         });
-        return this.getCommonService().sanitizeCommentEntity(changedEntity);
+        return this.getCommonService().sanitizeCommentEntity(changedEntity, []);
     },
     async blockNestedThreads(id, blockStatus) {
         return await this.getCommonService().modifiedNestedNestedComments(id, "blockedThread", blockStatus);
@@ -486,7 +488,7 @@ module.exports = ({ strapi }) => ({
                 content: body
             }
         });
-        return this.getCommonService().sanitizeCommentEntity(updateComment);
+        return this.getCommonService().sanitizeCommentEntity(updateComment, []);
     },
     getDefaultAuthorPopulate() {
         const strapiUserTypeUid = "plugin::users-permissions.user";

package/server/services/client.js

@@ -30,6 +30,7 @@ module.exports = ({ strapi }) => ({
         }
         const approvalFlow = await this.getCommonService().getConfig(constants_1.CONFIG_PARAMS.APPROVAL_FLOW, []);
         const isApprovalFlowEnabled = approvalFlow.includes(uid) || relatedEntity.requireCommentsApproval;
+        const doNotPopulateAuthor = await this.getCommonService().getConfig(constants_1.CONFIG_PARAMS.AUTHOR_BLOCKED_PROPS, []);
         let linkToThread;
         try {
             linkToThread = !(0, lodash_1.isNil)(threadOf)
@@ -93,7 +94,7 @@ module.exports = ({ strapi }) => ({
             const sanitizedEntity = this.getCommonService().sanitizeCommentEntity({
                 ...entity,
                 threadOf: linkToThread,
-            });
+            }, doNotPopulateAuthor);
             try {
                 await this.sendResponseNotification(sanitizedEntity);
             }
@@ -121,6 +122,7 @@ module.exports = ({ strapi }) => ({
         }
         if ((0, functions_2.isEqualEntity)(existingEntity, data, user) && content) {
             if (await this.getCommonService().checkBadWords(content)) {
+                const blockedAuthorProps = await this.getCommonService().getConfig(constants_1.CONFIG_PARAMS.AUTHOR_BLOCKED_PROPS, []);
                 const entity = await strapi.db
                     .query((0, functions_2.getModelUid)("comment"))
                     .update({
@@ -128,7 +130,7 @@ module.exports = ({ strapi }) => ({
                     data: { content },
                     populate: { threadOf: true, authorUser: true },
                 });
-                return this.getCommonService().sanitizeCommentEntity(entity);
+                return this.getCommonService().sanitizeCommentEntity(entity, blockedAuthorProps);
             }
         }
         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.`);
@@ -213,7 +215,8 @@ module.exports = ({ strapi }) => ({
                     populate: { threadOf: true, authorUser: true },
                 });
                 await this.markAsRemovedNested(id, true);
-                return this.getCommonService().sanitizeCommentEntity(removedEntity);
+                const doNotPopulateAuthor = await this.getCommonService().getConfig(constants_1.CONFIG_PARAMS.AUTHOR_BLOCKED_PROPS, []);
+                return this.getCommonService().sanitizeCommentEntity(removedEntity, doNotPopulateAuthor);
             }
             else {
                 throw new error_1.default(404, `Entity does not exist or you're not allowed to take an action on it`);

package/server/services/common.js

@@ -32,12 +32,15 @@ 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, fields, }, relatedEntity = null) {
+    async findAllFlat({ query = {}, populate = {}, sort, pagination, fields, isAdmin = false, }, relatedEntity = null) {
         const defaultSelect = ["id", "related"];
         const populateClause = {
             authorUser: true,
             ...((0, lodash_1.isObject)(populate) ? populate : {}),
         };
+        const doNotPopulateAuthor = isAdmin
+            ? []
+            : await this.getConfig(constants_1.CONFIG_PARAMS.AUTHOR_BLOCKED_PROPS, []);
         let queryExtension = {};
         if (sort && ((0, lodash_1.isString)(sort) || (0, lodash_1.isArray)(sort))) {
             queryExtension = {
@@ -146,16 +149,17 @@ module.exports = ({ strapi }) => ({
                 : query.threadOf;
             let authorUserPopulate = {};
             if ((0, lodash_1.isObject)(populateClause?.authorUser)) {
-                authorUserPopulate = 'populate' in populateClause.authorUser ?
-                    populateClause.authorUser.populate :
-                    populateClause.authorUser;
+                authorUserPopulate =
+                    "populate" in populateClause.authorUser
+                        ? populateClause.authorUser.populate
+                        : populateClause.authorUser;
             }
             return this.sanitizeCommentEntity({
                 ..._,
                 threadOf: parsedThreadOf || _.threadOf || null,
                 gotThread: (threadedItem?.itemsInTread || 0) > 0,
                 threadFirstItemId: threadedItem?.firstThreadItemId,
-            }, authorUserPopulate);
+            }, doNotPopulateAuthor, authorUserPopulate);
         });
         return {
             data: hasRelatedEntitiesToMap
@@ -164,8 +168,8 @@ module.exports = ({ strapi }) => ({
             ...((0, lodash_1.isEmpty)(meta) ? {} : { meta }),
         };
     },
-    async findAllInHierarchy({ query, populate = {}, sort, fields, startingFromId = null, dropBlockedThreads = false, }, relatedEntity) {
-        const entities = await this.findAllFlat({ query, populate, sort, fields }, relatedEntity);
+    async findAllInHierarchy({ query, populate = {}, sort, fields, startingFromId = null, dropBlockedThreads = false, isAdmin = false, }, relatedEntity) {
+        const entities = await this.findAllFlat({ query, populate, sort, fields, isAdmin }, relatedEntity);
         return (0, functions_1.buildNestedStructure)(entities?.data, startingFromId, "threadOf", dropBlockedThreads, false);
     },
     async findOne(criteria) {
@@ -181,7 +185,8 @@ module.exports = ({ strapi }) => ({
         if (!entity) {
             throw new error_1.default(404, "Comment does not exist. Check your payload please.");
         }
-        return (0, functions_1.filterOurResolvedReports)(this.sanitizeCommentEntity(entity));
+        const doNotPopulateAuthor = await this.getConfig(constants_1.CONFIG_PARAMS.AUTHOR_BLOCKED_PROPS, []);
+        return (0, functions_1.filterOurResolvedReports)(this.sanitizeCommentEntity(entity, doNotPopulateAuthor));
     },
     async findRelatedEntitiesFor(entities = []) {
         const data = entities.reduce((acc, curr) => {
@@ -235,7 +240,7 @@ module.exports = ({ strapi }) => ({
             return false;
         }
     },
-    sanitizeCommentEntity(entity, populate) {
+    sanitizeCommentEntity(entity, blockedAuthorProps, populate) {
         const fieldsToPopulate = (0, lodash_1.isArray)(populate)
             ? populate
             : Object.keys(populate || {});
@@ -243,9 +248,9 @@ module.exports = ({ strapi }) => ({
             ...(0, functions_1.buildAuthorModel)({
                 ...entity,
                 threadOf: (0, lodash_1.isObject)(entity.threadOf)
-                    ? (0, functions_1.buildAuthorModel)(entity.threadOf, fieldsToPopulate)
+                    ? (0, functions_1.buildAuthorModel)(entity.threadOf, blockedAuthorProps, fieldsToPopulate)
                     : entity.threadOf,
-            }, fieldsToPopulate),
+            }, blockedAuthorProps, fieldsToPopulate),
         };
     },
     isValidUserContext(user) {

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, fieldsToPopulate?: Array<string>) => Comment;
+export declare const buildAuthorModel: (item: Comment, blockedAuthorProps: Array<string>, fieldsToPopulate?: Array<string>) => Comment;
 export declare const buildConfigQueryProp: (prop?: undefined | string | Array<string>) => string;
 export declare const resolveUserContextError: (user: StrapiUser) => PluginError;
 export declare const getAuthorName: (author: StrapiAdmin) => any;

package/server/services/utils/functions.js

@@ -64,7 +64,7 @@ const convertContentTypeNameToSlug = (str) => {
         : plainConversion;
 };
 exports.convertContentTypeNameToSlug = convertContentTypeNameToSlug;
-const buildAuthorModel = (item, fieldsToPopulate = []) => {
+const buildAuthorModel = (item, blockedAuthorProps, fieldsToPopulate = []) => {
     const { authorUser, authorId, authorName, authorEmail, authorAvatar, ...rest } = item;
     let author = {};
     if (authorUser) {
@@ -88,9 +88,11 @@ const buildAuthorModel = (item, fieldsToPopulate = []) => {
             avatar: authorAvatar,
         };
     }
+    author = (0, lodash_1.isEmpty)(author) ? author : Object.fromEntries(Object.entries(author)
+        .filter(([name]) => !blockedAuthorProps.includes(name)));
     return {
         ...rest,
-        author: (0, lodash_1.isEmpty)(author) ? undefined : author,
+        author,
     };
 };
 exports.buildAuthorModel = buildAuthorModel;

package/server/utils/constants.js

@@ -7,6 +7,7 @@ exports.CONFIG_PARAMS = {
     ENTRY_LABEL: "entryLabel",
     MODERATOR_ROLES: "moderatorRoles",
     BAD_WORDS: "badWords",
+    AUTHOR_BLOCKED_PROPS: "blockedAuthorProps",
 };
 exports.APPROVAL_STATUS = {
     PENDING: "PENDING",

package/strapi-server.d.ts

@@ -150,6 +150,7 @@ declare const _default: () => {
             enabledCollections: string[];
             moderatorRoles: string[];
             approvalFlow: string[];
+            blockedAuthorProps: string[];
             entryLabel: PluginConfigEntryLabels;
             reportReasons: PluginConfigReportReasons;
             badWords?: boolean | undefined;