strapi-plugin-comments 3.2.4 → 3.2.5

package/dist/server/src/services/settings.service.d.ts

@@ -1,135 +1,147 @@
 import { StrapiContext } from '../@types';
 import { CommentsPluginConfig } from '../config';
-declare const _default: ({ strapi }: StrapiContext) => {
+declare const settingsService: ({ strapi }: StrapiContext) => {
     getConfig: (viaSettingsPage?: boolean) => Promise<{
-        enabledCollections?: string[];
-        approvalFlow?: string[];
-        entryLabel?: Record<string, string[]>;
-        moderatorRoles?: string[];
-        badWords?: boolean;
-        blockedAuthorProps?: string[];
+        enabledCollections: string[];
+        moderatorRoles: string[];
+        approvalFlow: string[];
+        entryLabel: Record<string, string[]>;
+        blockedAuthorProps: string[];
+        reactionsEnabled: boolean;
+        client: {
+            url?: string;
+            contactEmail?: string;
+        };
         isValidationEnabled?: boolean;
         reportReasons?: {
-            BAD_LANGUAGE?: import("../const").REPORT_REASON.BAD_LANGUAGE;
-            DISCRIMINATION?: import("../const").REPORT_REASON.DISCRIMINATION;
-            OTHER?: import("../const").REPORT_REASON.OTHER;
+            BAD_LANGUAGE: import("../const").REPORT_REASON.BAD_LANGUAGE;
+            OTHER: import("../const").REPORT_REASON.OTHER;
+            DISCRIMINATION: import("../const").REPORT_REASON.DISCRIMINATION;
         };
         isGQLPluginEnabled?: boolean;
+        isReactionsPluginInstalled?: boolean;
+        badWords?: boolean;
         gql?: {
             auth?: boolean;
         };
-        client?: {
+    } | Omit<{
+        enabledCollections: string[];
+        moderatorRoles: string[];
+        approvalFlow: string[];
+        entryLabel: Record<string, string[]>;
+        blockedAuthorProps: string[];
+        reactionsEnabled: boolean;
+        client: {
             url?: string;
             contactEmail?: string;
         };
-    } | Omit<{
-        enabledCollections?: string[];
-        approvalFlow?: string[];
-        entryLabel?: Record<string, string[]>;
-        moderatorRoles?: string[];
-        badWords?: boolean;
-        blockedAuthorProps?: string[];
         isValidationEnabled?: boolean;
         reportReasons?: {
-            BAD_LANGUAGE?: import("../const").REPORT_REASON.BAD_LANGUAGE;
-            DISCRIMINATION?: import("../const").REPORT_REASON.DISCRIMINATION;
-            OTHER?: import("../const").REPORT_REASON.OTHER;
+            BAD_LANGUAGE: import("../const").REPORT_REASON.BAD_LANGUAGE;
+            OTHER: import("../const").REPORT_REASON.OTHER;
+            DISCRIMINATION: import("../const").REPORT_REASON.DISCRIMINATION;
         };
         isGQLPluginEnabled?: boolean;
+        isReactionsPluginInstalled?: boolean;
+        badWords?: boolean;
         gql?: {
             auth?: boolean;
         };
-        client?: {
+    }, "enabledCollections" | "moderatorRoles" | "isGQLPluginEnabled" | "isReactionsPluginInstalled">>;
+    update: (config: CommentsPluginConfig) => Promise<{
+        enabledCollections: string[];
+        moderatorRoles: string[];
+        approvalFlow: string[];
+        entryLabel: Record<string, string[]>;
+        blockedAuthorProps: string[];
+        reactionsEnabled: boolean;
+        client: {
             url?: string;
             contactEmail?: string;
         };
-    }, "enabledCollections" | "moderatorRoles" | "isGQLPluginEnabled">>;
-    update: (config: CommentsPluginConfig) => Promise<{
-        enabledCollections?: string[];
-        approvalFlow?: string[];
-        entryLabel?: Record<string, string[]>;
-        moderatorRoles?: string[];
-        badWords?: boolean;
-        blockedAuthorProps?: string[];
         isValidationEnabled?: boolean;
         reportReasons?: {
-            BAD_LANGUAGE?: import("../const").REPORT_REASON.BAD_LANGUAGE;
-            DISCRIMINATION?: import("../const").REPORT_REASON.DISCRIMINATION;
-            OTHER?: import("../const").REPORT_REASON.OTHER;
+            BAD_LANGUAGE: import("../const").REPORT_REASON.BAD_LANGUAGE;
+            OTHER: import("../const").REPORT_REASON.OTHER;
+            DISCRIMINATION: import("../const").REPORT_REASON.DISCRIMINATION;
         };
         isGQLPluginEnabled?: boolean;
+        isReactionsPluginInstalled?: boolean;
+        badWords?: boolean;
         gql?: {
             auth?: boolean;
         };
-        client?: {
+    } | Omit<{
+        enabledCollections: string[];
+        moderatorRoles: string[];
+        approvalFlow: string[];
+        entryLabel: Record<string, string[]>;
+        blockedAuthorProps: string[];
+        reactionsEnabled: boolean;
+        client: {
             url?: string;
             contactEmail?: string;
         };
-    } | Omit<{
-        enabledCollections?: string[];
-        approvalFlow?: string[];
-        entryLabel?: Record<string, string[]>;
-        moderatorRoles?: string[];
-        badWords?: boolean;
-        blockedAuthorProps?: string[];
         isValidationEnabled?: boolean;
         reportReasons?: {
-            BAD_LANGUAGE?: import("../const").REPORT_REASON.BAD_LANGUAGE;
-            DISCRIMINATION?: import("../const").REPORT_REASON.DISCRIMINATION;
-            OTHER?: import("../const").REPORT_REASON.OTHER;
+            BAD_LANGUAGE: import("../const").REPORT_REASON.BAD_LANGUAGE;
+            OTHER: import("../const").REPORT_REASON.OTHER;
+            DISCRIMINATION: import("../const").REPORT_REASON.DISCRIMINATION;
         };
         isGQLPluginEnabled?: boolean;
+        isReactionsPluginInstalled?: boolean;
+        badWords?: boolean;
         gql?: {
             auth?: boolean;
         };
-        client?: {
+    }, "enabledCollections" | "moderatorRoles" | "isGQLPluginEnabled" | "isReactionsPluginInstalled">>;
+    restore: () => Promise<{
+        enabledCollections: string[];
+        moderatorRoles: string[];
+        approvalFlow: string[];
+        entryLabel: Record<string, string[]>;
+        blockedAuthorProps: string[];
+        reactionsEnabled: boolean;
+        client: {
             url?: string;
             contactEmail?: string;
         };
-    }, "enabledCollections" | "moderatorRoles" | "isGQLPluginEnabled">>;
-    restore: () => Promise<{
-        enabledCollections?: string[];
-        approvalFlow?: string[];
-        entryLabel?: Record<string, string[]>;
-        moderatorRoles?: string[];
-        badWords?: boolean;
-        blockedAuthorProps?: string[];
         isValidationEnabled?: boolean;
         reportReasons?: {
-            BAD_LANGUAGE?: import("../const").REPORT_REASON.BAD_LANGUAGE;
-            DISCRIMINATION?: import("../const").REPORT_REASON.DISCRIMINATION;
-            OTHER?: import("../const").REPORT_REASON.OTHER;
+            BAD_LANGUAGE: import("../const").REPORT_REASON.BAD_LANGUAGE;
+            OTHER: import("../const").REPORT_REASON.OTHER;
+            DISCRIMINATION: import("../const").REPORT_REASON.DISCRIMINATION;
         };
         isGQLPluginEnabled?: boolean;
+        isReactionsPluginInstalled?: boolean;
+        badWords?: boolean;
         gql?: {
             auth?: boolean;
         };
-        client?: {
+    } | Omit<{
+        enabledCollections: string[];
+        moderatorRoles: string[];
+        approvalFlow: string[];
+        entryLabel: Record<string, string[]>;
+        blockedAuthorProps: string[];
+        reactionsEnabled: boolean;
+        client: {
             url?: string;
             contactEmail?: string;
         };
-    } | Omit<{
-        enabledCollections?: string[];
-        approvalFlow?: string[];
-        entryLabel?: Record<string, string[]>;
-        moderatorRoles?: string[];
-        badWords?: boolean;
-        blockedAuthorProps?: string[];
         isValidationEnabled?: boolean;
         reportReasons?: {
-            BAD_LANGUAGE?: import("../const").REPORT_REASON.BAD_LANGUAGE;
-            DISCRIMINATION?: import("../const").REPORT_REASON.DISCRIMINATION;
-            OTHER?: import("../const").REPORT_REASON.OTHER;
+            BAD_LANGUAGE: import("../const").REPORT_REASON.BAD_LANGUAGE;
+            OTHER: import("../const").REPORT_REASON.OTHER;
+            DISCRIMINATION: import("../const").REPORT_REASON.DISCRIMINATION;
         };
         isGQLPluginEnabled?: boolean;
+        isReactionsPluginInstalled?: boolean;
+        badWords?: boolean;
         gql?: {
             auth?: boolean;
         };
-        client?: {
-            url?: string;
-            contactEmail?: string;
-        };
-    }, "enabledCollections" | "moderatorRoles" | "isGQLPluginEnabled">>;
+    }, "enabledCollections" | "moderatorRoles" | "isGQLPluginEnabled" | "isReactionsPluginInstalled">>;
     restart: () => void;
 };
-export default _default;
+export default settingsService;

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

@@ -1,10 +1,10 @@
 import { StrapiUser } from '@sensinum/strapi-utils';
 import { AdminUser } from '../../@types';
 import PluginError from '../../utils/error';
-import { Comment, CommentWithRelated } from '../../validators/repositories';
+import { Comment, CommentInput, CommentWithRelated } from '../../validators/repositories';
 export declare const getRelatedGroups: (related: string) => Array<string>;
 export declare const filterOurResolvedReports: (item: Comment) => Comment;
-export declare const buildAuthorModel: (item: Comment | CommentWithRelated, blockedAuthorProps: Array<string>, fieldsToPopulate?: Array<string>) => Comment;
+export declare const buildAuthorModel: (item: CommentInput | CommentWithRelated, blockedAuthorProps: Array<string>, fieldsToPopulate?: Array<string>) => Comment;
 export declare const resolveUserContextError: (user?: AdminUser | StrapiUser) => PluginError;
 type AuthorNameProps = {
     lastname?: string;

package/dist/server/src/services/utils/reactions.d.ts

@@ -0,0 +1,12 @@
+import { Id, StrapiContext } from '../../@types';
+import { ReactionsCount, ReactionsMeta } from '../reactions.service';
+type CommentTreeNode = {
+    documentId?: string | null;
+    children?: Array<CommentTreeNode>;
+};
+export declare const collectCommentDocumentIds: (comments: Array<CommentTreeNode>) => Array<string>;
+export declare const attachReactionsToComments: <T extends CommentTreeNode>(comments: Array<T>, reactionsMeta: ReactionsMeta) => Array<T & {
+    reactions: ReactionsCount;
+}>;
+export declare const collectNestedCommentDocumentIds: ({ strapi }: StrapiContext, commentId: Id) => Promise<Array<string>>;
+export {};

package/dist/server/src/utils/constants.d.ts

@@ -6,6 +6,7 @@ export declare const CONFIG_PARAMS: {
     readonly MODERATOR_ROLES: "moderatorRoles";
     readonly BAD_WORDS: "badWords";
     readonly AUTHOR_BLOCKED_PROPS: "blockedAuthorProps";
+    readonly REACTIONS_ENABLED: "reactionsEnabled";
 };
 export declare const APPROVAL_STATUS: {
     PENDING: string;

package/dist/server/src/utils/getConfig.d.ts

@@ -1,3 +1,3 @@
 import { StrapiContext, PathValue } from '../@types';
 import { CommentsPluginConfig } from '../config';
-export declare const getConfig: <T extends "enabledCollections" | "approvalFlow" | "entryLabel" | "moderatorRoles" | "badWords" | "blockedAuthorProps" | "isValidationEnabled" | "reportReasons" | "isGQLPluginEnabled" | "gql" | "client">(strapi: StrapiContext['strapi'], path: T, defaultValue: PathValue<CommentsPluginConfig, T>) => Promise<CommentsPluginConfig[T]>;
+export declare const getConfig: <T extends "enabledCollections" | "approvalFlow" | "entryLabel" | "moderatorRoles" | "badWords" | "blockedAuthorProps" | "reactionsEnabled" | "isValidationEnabled" | "reportReasons" | "isGQLPluginEnabled" | "isReactionsPluginInstalled" | "gql" | "client">(strapi: StrapiContext['strapi'], path: T, defaultValue: PathValue<CommentsPluginConfig, T>) => Promise<CommentsPluginConfig[T]>;

package/dist/server/src/utils/getPluginService.d.ts

@@ -1,3 +1,3 @@
 import { CoreStrapi } from '../@types';
 import { PluginServices } from '../services';
-export declare const getPluginService: <T extends "gql" | "client" | "admin" | "common" | "settings">(strapi: CoreStrapi, serviceName: T) => PluginServices[T];
+export declare const getPluginService: <T extends keyof import("../services").CommentsPluginServices>(strapi: CoreStrapi, serviceName: T) => PluginServices[T];

package/dist/server/src/utils/types.d.ts

@@ -2,7 +2,7 @@ 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: {
+    model?: {
         singularName: string;
         uid: string;
         tableName: string;
@@ -15,7 +15,9 @@ export interface LifeCycleEvent<THookName extends LifeCycleHookName = LifeCycleH
         }>;
         columnToAttribute: Record<string, string>;
     };
-    state: Record<string, unknown>;
-    params: TParams;
+    state?: Record<string, unknown>;
+    params?: TParams;
     result?: TResult | TResult[];
 }
+export type Effect<T = void> = [T] extends [void] ? () => void | Promise<void> : (event: T) => void | Promise<void>;
+export type LifecycleHookRecord = Partial<Record<LifeCycleHookName, Array<Effect<LifeCycleEvent>>>>;