strapi-plugin-comments 2.2.17 → 2.3.0

package/README.md

@@ -372,6 +372,12 @@ Return a flat structure of comments by specified Author for example `Author` wit
 **Example URL**: `https://localhost:1337/api/comments/author/1` - get comments by `ID:1` of Strapi User
 **Example URL**: `https://localhost:1337/api/comments/author/1/generic` - get comments by `ID:1` of Generic User
 
+#### Skipping fields
+
+To skip a field from the response you can use a query param called `omit`. It is a list of `Comment` entity fields you want to ignore. For example `?omit[]=author&omit[]=related`.
+
+**Remember!** `id` field is required so it will not be skipped.
+
 **Example response body**
 
 ```json
@@ -931,6 +937,46 @@ For developers who upgrades their Strapi instance custom field from Comments plu
 
 Read more about this feature in [Strapi's docs](https://docs-next.strapi.io/user-docs/latest/plugins/introduction-to-plugins.html#custom-fields).
 
+## Model lifecycle hooks
+
+Comments plugin allows to register lifecycle hooks for `Comment` and `Comment report` content types.
+
+You can read more about lifecycle hooks [here](https://docs.strapi.io/dev-docs/backend-customization/models#lifecycle-hooks). (You can set a listener for all of the hooks).
+
+Lifecycle hooks can be register either in `register()` or `bootstrap()` methods of your server. You can register more than one listener for a specified lifecycle hook. For example: you want to do three things on report creation and do not want to handle all of these actions in one big function. You can split logic in as many listeners as you want.
+
+Listeners can by sync and `async`.
+
+>Be aware that lifecycle hooks registered in `register()` may be fired by plugin's bootstrapping. If you want listen to events triggered after server's startup use `bootstrap()`.
+
+Example:
+
+```ts
+  const commentsCommonService = strapi
+    .plugin("comments")
+    .service("common");
+
+  commentsCommonService.registerLifecycleHook({
+    callback: async ({ action, result }) => {
+      const saveResult = await logIntoSystem(action, result);
+
+      console.log(saveResult);
+    },
+    contentTypeName: "comment",
+    hookName: "afterCreate",
+  });
+
+  commentsCommonService.registerLifecycleHook({
+    callback: async ({ action, result }) => {
+      const saveResult = await logIntoSystem(action, result);
+
+      console.log(saveResult);
+    },
+    contentTypeName: "report",
+    hookName: "afterCreate",
+  });
+```
+
 ## 🤝 Contributing
 
 <div>

package/content-types/index.d.ts

@@ -93,6 +93,7 @@ declare const _default: {
                 };
             };
         };
+        lifecycles: Record<import("../server/utils/types").LifeCycleHookName, import("../types/utils").Effect<import("../server/utils/types").LifeCycleEvent<import("../server/utils/types").LifeCycleHookName, unknown, Record<string, unknown>>>>;
     };
     "comment-report": {
         schema: {
@@ -141,6 +142,7 @@ declare const _default: {
                 };
             };
         };
+        lifecycles: Record<import("../server/utils/types").LifeCycleHookName, import("../types/utils").Effect<import("../server/utils/types").LifeCycleEvent<import("../server/utils/types").LifeCycleHookName, unknown, Record<string, unknown>>>>;
     };
 };
 export default _default;

package/content-types/index.js

@@ -3,14 +3,21 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+const functions_1 = require("../server/utils/functions");
 const comment_1 = __importDefault(require("./comment"));
 const report_1 = __importDefault(require("./report"));
 exports.default = {
     comment: {
         schema: comment_1.default,
+        lifecycles: (0, functions_1.buildAllHookListeners)("comment", {
+            strapi,
+        }),
     },
     "comment-report": {
         schema: report_1.default,
+        lifecycles: (0, functions_1.buildAllHookListeners)("comment-report", {
+            strapi,
+        }),
     },
 };
 //# sourceMappingURL=index.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "strapi-plugin-comments",
-  "version": "2.2.17",
+  "version": "2.3.0",
   "description": "Strapi - Comments plugin",
   "strapi": {
     "name": "comments",

package/server/controllers/client.js

@@ -15,7 +15,7 @@ const controllers = {
     async findAllFlat(ctx) {
         const { params = {}, query, sort, pagination } = ctx;
         const { relation } = (0, functions_2.parseParams)(params);
-        const { sort: querySort, pagination: queryPagination, fields, ...filterQuery } = query || {};
+        const { sort: querySort, pagination: queryPagination, fields, omit = [], ...filterQuery } = query || {};
         try {
             (0, functions_1.assertParamsPresent)(params, ["relation"]);
             return this.getService("common").findAllFlat((0, parsers_1.flatInput)({
@@ -24,6 +24,7 @@ const controllers = {
                 sort: sort || querySort,
                 pagination: pagination || queryPagination,
                 fields,
+                omit,
             }));
         }
         catch (e) {
@@ -33,7 +34,7 @@ const controllers = {
     async findAllInHierarchy(ctx) {
         const { params, query, sort } = ctx;
         const { relation } = (0, functions_2.parseParams)(params);
-        const { sort: querySort, fields, ...filterQuery } = query || {};
+        const { sort: querySort, fields, omit, ...filterQuery } = query || {};
         try {
             (0, functions_1.assertParamsPresent)(params, ["relation"]);
             return await this.getService("common").findAllInHierarchy({
@@ -42,6 +43,7 @@ const controllers = {
                     query: filterQuery,
                     sort: sort || querySort,
                     fields,
+                    omit,
                 }),
                 dropBlockedThreads: true,
             });
@@ -53,7 +55,7 @@ const controllers = {
     async findAllPerAuthor(ctx) {
         const { params = {}, query, sort, pagination } = ctx;
         const { id, type } = (0, functions_2.parseParams)(params);
-        const { sort: querySort, pagination: queryPagination, fields, ...filterQuery } = query || {};
+        const { sort: querySort, pagination: queryPagination, fields, omit = [], ...filterQuery } = query || {};
         try {
             (0, functions_1.assertParamsPresent)(params, ["id"]);
             return this.getService("common").findAllPerAuthor((0, parsers_1.flatInput)({
@@ -61,6 +63,7 @@ const controllers = {
                 sort: sort || querySort,
                 pagination: pagination || queryPagination,
                 fields,
+                omit,
             }), id, ![constants_1.AUTHOR_TYPE.GENERIC.toLowerCase(), constants_1.AUTHOR_TYPE.GENERIC].includes(type));
         }
         catch (e) {

package/server/controllers/utils/parsers.d.ts

@@ -6,5 +6,6 @@ export declare const flatInput: <T, TKeys = keyof T>(payload: FlatInput<OnlyStri
     pagination: any;
     sort: any;
     fields: import("strapi-typed").StrapiRequestQueryFieldsClause<OnlyStrings<TKeys>> | undefined;
+    omit: string[] | undefined;
 };
 //# sourceMappingURL=parsers.d.ts.map

package/server/controllers/utils/parsers.js

@@ -7,7 +7,7 @@ exports.flatInput = void 0;
 const error_1 = __importDefault(require("../../utils/error"));
 const functions_1 = require("../../utils/functions");
 const flatInput = (payload) => {
-    const { relation, query, sort, pagination, fields } = payload;
+    const { relation, query, sort, pagination, fields, omit } = payload;
     const { populate = {}, filterBy, filterByValue, ...restQuery } = query;
     const filters = restQuery?.filters || restQuery;
     const orOperator = (filters?.$or || []).filter((_) => !Object.keys(_).includes("removed"));
@@ -65,6 +65,7 @@ const flatInput = (payload) => {
         pagination,
         sort,
         fields,
+        omit,
     };
 };
 exports.flatInput = flatInput;

package/server/services/admin.js

@@ -121,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 {
@@ -197,7 +197,7 @@ module.exports = ({ strapi }) => ({
                     ..._.related,
                     gotThread: isCommentWithThread,
                 }, []),
-            }, [], defaultAuthorUserPopulate?.populate));
+            }, [], [], defaultAuthorUserPopulate?.populate));
         });
         const pageCount = Math.floor(total / pageSize);
         return {
@@ -291,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,

package/server/services/common.js

@@ -9,6 +9,11 @@ const error_1 = __importDefault(require("./../utils/error"));
 const functions_1 = require("./utils/functions");
 const parsers_1 = require("./utils/parsers");
 const PAGE_SIZE = 10;
+const REQUIRED_FIELDS = ["id"];
+const lifecycleHookListeners = {
+    comment: {},
+    "comment-report": {}
+};
 module.exports = ({ strapi }) => ({
     async getConfig(prop, defaultValue, useLocal = false) {
         const queryProp = (0, functions_1.buildConfigQueryProp)(prop);
@@ -33,8 +38,9 @@ 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, isAdmin = false, }, relatedEntity = null) {
-        const defaultSelect = ["id", "related"];
+    async findAllFlat({ query = {}, populate = {}, sort, pagination, fields, isAdmin = false, omit: baseOmit = [], }, relatedEntity = null) {
+        const omit = baseOmit.filter((field) => !REQUIRED_FIELDS.includes(field));
+        const defaultSelect = ["id", "related"].filter((field) => !omit.includes(field));
         const populateClause = {
             authorUser: true,
             ...((0, lodash_1.isObject)(populate) ? populate : {}),
@@ -94,9 +100,11 @@ module.exports = ({ strapi }) => ({
                 firstThreadItemId: (0, lodash_1.first)(nestedEntries)?.id,
             };
         }));
-        const relatedEntities = relatedEntity !== null
-            ? [relatedEntity]
-            : await this.findRelatedEntitiesFor([...entries]);
+        const relatedEntities = omit.includes("related")
+            ? []
+            : relatedEntity !== null
+                ? [relatedEntity]
+                : await this.findRelatedEntitiesFor([...entries]);
         const hasRelatedEntitiesToMap = relatedEntities.filter((_) => _).length > 0;
         const result = entries.map((_) => {
             const threadedItem = entriesWithThreads.find((item) => item.id === _.id);
@@ -118,7 +126,7 @@ module.exports = ({ strapi }) => ({
                 threadOf: primitiveThreadOf || _.threadOf,
                 gotThread: (threadedItem?.itemsInTread || 0) > 0,
                 threadFirstItemId: threadedItem?.firstThreadItemId,
-            }, doNotPopulateAuthor, authorUserPopulate);
+            }, doNotPopulateAuthor, omit, authorUserPopulate);
         });
         return {
             data: hasRelatedEntitiesToMap
@@ -127,8 +135,8 @@ module.exports = ({ strapi }) => ({
             ...((0, lodash_1.isEmpty)(meta) ? {} : { meta }),
         };
     },
-    async findAllInHierarchy({ query, populate = {}, sort, fields, startingFromId = null, dropBlockedThreads = false, isAdmin = false, }, relatedEntity) {
-        const entities = await this.findAllFlat({ query, populate, sort, fields, isAdmin }, relatedEntity);
+    async findAllInHierarchy({ query, populate = {}, sort, fields, startingFromId = null, dropBlockedThreads = false, isAdmin = false, omit = [], }, relatedEntity) {
+        const entities = await this.findAllFlat({ query, populate, sort, fields, isAdmin, omit }, relatedEntity);
         return (0, functions_1.buildNestedStructure)(entities?.data, startingFromId, "threadOf", dropBlockedThreads, false);
     },
     async findOne(criteria) {
@@ -225,18 +233,18 @@ module.exports = ({ strapi }) => ({
             return false;
         }
     },
-    sanitizeCommentEntity(entity, blockedAuthorProps, populate) {
+    sanitizeCommentEntity(entity, blockedAuthorProps, omit = [], populate) {
         const fieldsToPopulate = (0, lodash_1.isArray)(populate)
             ? populate
             : Object.keys(populate || {});
-        return {
+        return (0, lodash_1.omit)({
             ...(0, functions_1.buildAuthorModel)({
                 ...entity,
                 threadOf: (0, lodash_1.isObject)(entity.threadOf)
                     ? (0, functions_1.buildAuthorModel)(entity.threadOf, blockedAuthorProps, fieldsToPopulate)
                     : entity.threadOf,
             }, blockedAuthorProps, fieldsToPopulate),
-        };
+        }, omit);
     },
     isValidUserContext(user) {
         return user ? !(0, lodash_1.isNil)(user?.id) : true;
@@ -272,5 +280,17 @@ module.exports = ({ strapi }) => ({
         const enabledCollections = await this.getConfig("enabledCollections", []);
         return enabledCollections.includes(uid);
     },
+    registerLifecycleHook({ callback, contentTypeName, hookName }) {
+        if (!lifecycleHookListeners[contentTypeName][hookName]) {
+            lifecycleHookListeners[contentTypeName][hookName] = [];
+        }
+        lifecycleHookListeners[contentTypeName][hookName]?.push(callback);
+    },
+    async runLifecycleHook({ contentTypeName, event, hookName }) {
+        const hookListeners = lifecycleHookListeners[contentTypeName][hookName] ?? [];
+        for (const listener of hookListeners) {
+            await listener(event);
+        }
+    },
 });
 //# sourceMappingURL=common.js.map

package/server/utils/constants.d.ts

@@ -1,4 +1,5 @@
 import { ConfigParamKeys, RegExpCollection } from "../../types";
+import { LifeCycleHookName } from "./types";
 export declare const CONFIG_PARAMS: ConfigParamKeys;
 export declare const APPROVAL_STATUS: {
     PENDING: string;
@@ -10,4 +11,5 @@ export declare const AUTHOR_TYPE: {
     STRAPI: string;
 };
 export declare const REGEX: RegExpCollection;
+export declare const LIFECYCLE_HOOKS: ReadonlyArray<LifeCycleHookName>;
 //# sourceMappingURL=constants.d.ts.map

package/server/utils/constants.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.REGEX = exports.AUTHOR_TYPE = exports.APPROVAL_STATUS = exports.CONFIG_PARAMS = void 0;
+exports.LIFECYCLE_HOOKS = exports.REGEX = exports.AUTHOR_TYPE = exports.APPROVAL_STATUS = exports.CONFIG_PARAMS = void 0;
 exports.CONFIG_PARAMS = {
     ENABLED_COLLECTIONS: "enabledCollections",
     APPROVAL_FLOW: "approvalFlow",
@@ -24,4 +24,24 @@ exports.REGEX = {
     email: /\S+@\S+\.\S+/,
     sorting: /^(?<path>[a-z0-9-_\:\.]+)\:+(asc|desc)$/i,
 };
+exports.LIFECYCLE_HOOKS = [
+    "beforeCreate",
+    "beforeCreateMany",
+    "afterCreate",
+    "afterCreateMany",
+    "beforeUpdate",
+    "beforeUpdateMany",
+    "afterUpdate",
+    "afterUpdateMany",
+    "beforeDelete",
+    "beforeDeleteMany",
+    "afterDelete",
+    "afterDeleteMany",
+    "beforeCount",
+    "afterCount",
+    "beforeFindOne",
+    "afterFindOne",
+    "beforeFindMany",
+    "afterFindMany",
+];
 //# sourceMappingURL=constants.js.map

package/server/utils/functions.d.ts

@@ -1,6 +1,10 @@
-import { StrapiQueryParams, StrapiQueryParamsParsed } from "strapi-typed";
+import { StrapiQueryParams, StrapiQueryParamsParsed, StrapiContext } from "strapi-typed";
+import { ContentType, LifeCycleEvent, LifeCycleHookName } from "./types";
+import { Effect } from "../../types/utils";
 export declare const getPluginService: <T>(name: string) => T;
 export declare const parseParams: <T = StrapiQueryParamsParsed>(params: StrapiQueryParams) => T;
 export declare const assertParamsPresent: <T>(params: unknown, keys: string[]) => asserts params is T;
 export declare const assertNotEmpty: <T>(value: T | null | undefined, customError?: Error) => asserts value is T;
+export declare const buildHookListener: (contentTypeName: ContentType, { strapi }: StrapiContext) => (hookName: LifeCycleHookName) => [LifeCycleHookName, Effect<LifeCycleEvent>];
+export declare const buildAllHookListeners: (contentTypeName: ContentType, context: StrapiContext) => Record<LifeCycleHookName, Effect<LifeCycleEvent>>;
 //# sourceMappingURL=functions.d.ts.map

package/server/utils/functions.js

@@ -3,8 +3,9 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.assertNotEmpty = exports.assertParamsPresent = exports.parseParams = exports.getPluginService = void 0;
+exports.buildAllHookListeners = exports.buildHookListener = exports.assertNotEmpty = exports.assertParamsPresent = exports.parseParams = exports.getPluginService = void 0;
 const error_1 = __importDefault(require("./error"));
+const constants_1 = require("./constants");
 const getPluginService = (name) => strapi.plugin("comments").service(name);
 exports.getPluginService = getPluginService;
 const parseParams = (params) => Object.keys(params).reduce((prev, curr) => {
@@ -33,4 +34,20 @@ const assertNotEmpty = (value, customError) => {
     throw (customError ?? new error_1.default(400, "Non-empty value expected, empty given"));
 };
 exports.assertNotEmpty = assertNotEmpty;
+const buildHookListener = (contentTypeName, { strapi }) => (hookName) => [
+    hookName,
+    async (event) => {
+        const commonService = strapi
+            .plugin("comments")
+            .service("common");
+        await commonService.runLifecycleHook({
+            contentTypeName,
+            hookName,
+            event,
+        });
+    },
+];
+exports.buildHookListener = buildHookListener;
+const buildAllHookListeners = (contentTypeName, context) => Object.fromEntries(constants_1.LIFECYCLE_HOOKS.map((0, exports.buildHookListener)(contentTypeName, context)));
+exports.buildAllHookListeners = buildAllHookListeners;
 //# sourceMappingURL=functions.js.map

package/server/utils/types.d.ts

@@ -0,0 +1,23 @@
+import { Effect } from "../../types/utils";
+export type ContentType = "comment" | "comment-report";
+export type LifeCycleHookName = "beforeCreate" | "beforeCreateMany" | "afterCreate" | "afterCreateMany" | "beforeUpdate" | "beforeUpdateMany" | "afterUpdate" | "afterUpdateMany" | "beforeDelete" | "beforeDeleteMany" | "afterDelete" | "afterDeleteMany" | "beforeCount" | "afterCount" | "beforeFindOne" | "afterFindOne" | "beforeFindMany" | "afterFindMany";
+export interface LifeCycleEvent<THookName extends LifeCycleHookName = LifeCycleHookName, TResult = unknown, TParams = Record<string, unknown>> {
+    action: THookName;
+    model: {
+        singularName: string;
+        uid: string;
+        tableName: string;
+        attributes: Record<string, unknown>;
+        lifecycles: Partial<Record<LifeCycleHookName, Effect<LifeCycleEvent>>>;
+        indexes: Array<{
+            type?: string;
+            name: string;
+            columns: string[];
+        }>;
+        columnToAttribute: Record<string, string>;
+    };
+    state: Record<string, unknown>;
+    params: TParams;
+    result?: TResult | TResult[];
+}
+//# sourceMappingURL=types.d.ts.map

package/server/utils/types.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=types.js.map

package/strapi-server.d.ts

@@ -95,6 +95,7 @@ declare const _default: () => {
                     };
                 };
             };
+            lifecycles: Record<import("./server/utils/types").LifeCycleHookName, import("./types/utils").Effect<import("./server/utils/types").LifeCycleEvent<import("./server/utils/types").LifeCycleHookName, unknown, Record<string, unknown>>>>;
         };
         "comment-report": {
             schema: {
@@ -143,6 +144,7 @@ declare const _default: () => {
                     };
                 };
             };
+            lifecycles: Record<import("./server/utils/types").LifeCycleHookName, import("./types/utils").Effect<import("./server/utils/types").LifeCycleEvent<import("./server/utils/types").LifeCycleHookName, unknown, Record<string, unknown>>>>;
         };
     };
     config: {