strapi-plugin-comments 3.0.0-beta.0 → 3.0.0

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

@@ -1,5 +1,5 @@
-import { StrapiContext } from '../@types-v5';
-import { CommentsPluginConfig } from '../validators/api/controllers/settings.controller.validator';
+import { StrapiContext } from '../@types';
+import { CommentsPluginConfig } from '../config';
 declare const _default: ({ strapi }: StrapiContext) => {
     getConfig: (viaSettingsPage?: boolean) => Promise<{
         enabledCollections?: string[];
@@ -15,6 +15,13 @@ declare const _default: ({ strapi }: StrapiContext) => {
             OTHER?: import("../const").REPORT_REASON.OTHER;
         };
         isGQLPluginEnabled?: boolean;
+        gql?: {
+            auth?: boolean;
+        };
+        client?: {
+            url?: string;
+            contactEmail?: string;
+        };
     } | Omit<{
         enabledCollections?: string[];
         approvalFlow?: string[];
@@ -29,6 +36,13 @@ declare const _default: ({ strapi }: StrapiContext) => {
             OTHER?: import("../const").REPORT_REASON.OTHER;
         };
         isGQLPluginEnabled?: boolean;
+        gql?: {
+            auth?: boolean;
+        };
+        client?: {
+            url?: string;
+            contactEmail?: string;
+        };
     }, "enabledCollections" | "moderatorRoles" | "isGQLPluginEnabled">>;
     update: (config: CommentsPluginConfig) => Promise<{
         enabledCollections?: string[];
@@ -44,6 +58,13 @@ declare const _default: ({ strapi }: StrapiContext) => {
             OTHER?: import("../const").REPORT_REASON.OTHER;
         };
         isGQLPluginEnabled?: boolean;
+        gql?: {
+            auth?: boolean;
+        };
+        client?: {
+            url?: string;
+            contactEmail?: string;
+        };
     } | Omit<{
         enabledCollections?: string[];
         approvalFlow?: string[];
@@ -58,6 +79,13 @@ declare const _default: ({ strapi }: StrapiContext) => {
             OTHER?: import("../const").REPORT_REASON.OTHER;
         };
         isGQLPluginEnabled?: boolean;
+        gql?: {
+            auth?: boolean;
+        };
+        client?: {
+            url?: string;
+            contactEmail?: string;
+        };
     }, "enabledCollections" | "moderatorRoles" | "isGQLPluginEnabled">>;
     restore: () => Promise<{
         enabledCollections?: string[];
@@ -73,6 +101,13 @@ declare const _default: ({ strapi }: StrapiContext) => {
             OTHER?: import("../const").REPORT_REASON.OTHER;
         };
         isGQLPluginEnabled?: boolean;
+        gql?: {
+            auth?: boolean;
+        };
+        client?: {
+            url?: string;
+            contactEmail?: string;
+        };
     } | Omit<{
         enabledCollections?: string[];
         approvalFlow?: string[];
@@ -87,6 +122,13 @@ declare const _default: ({ strapi }: StrapiContext) => {
             OTHER?: import("../const").REPORT_REASON.OTHER;
         };
         isGQLPluginEnabled?: boolean;
+        gql?: {
+            auth?: boolean;
+        };
+        client?: {
+            url?: string;
+            contactEmail?: string;
+        };
     }, "enabledCollections" | "moderatorRoles" | "isGQLPluginEnabled">>;
     restart: () => void;
 };

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

@@ -1,12 +1,16 @@
-import { StrapiAdmin, StrapiUser } from '@sensinum/strapi-utils';
-import { AdminUser, Id } from '../../@types-v5';
+import { StrapiUser } from '@sensinum/strapi-utils';
+import { AdminUser, Id } from '../../@types';
 import PluginError from '../../utils/error';
 import { Comment, CommentWithRelated } from '../../validators/repositories';
 export declare const buildNestedStructure: (entities: Array<Comment | CommentWithRelated>, id?: Id | null, field?: string, dropBlockedThreads?: boolean, blockNestedThreads?: boolean) => Array<Comment>;
 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 buildAuthorModel: (item: any, blockedAuthorProps: Array<string>, fieldsToPopulate?: Array<string>) => Comment;
-export declare const buildConfigQueryProp: (prop?: undefined | string | Array<string>) => string;
+export declare const buildAuthorModel: (item: Comment | CommentWithRelated, blockedAuthorProps: Array<string>, fieldsToPopulate?: Array<string>) => Comment;
 export declare const resolveUserContextError: (user?: AdminUser | StrapiUser) => PluginError;
-export declare const getAuthorName: (author: StrapiAdmin) => string;
+type AuthorNameProps = {
+    lastname?: string;
+    firstname?: string;
+    username?: string;
+};
+export declare const getAuthorName: (author: AuthorNameProps) => string;
+export {};

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

@@ -0,0 +1 @@
+export declare const caster: <T>(source: unknown) => T;

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

@@ -1,4 +1,4 @@
-import { LifeCycleHookName } from "./types";
+import { LifeCycleHookName } from './types';
 export declare const CONFIG_PARAMS: {
     readonly ENABLED_COLLECTIONS: "enabledCollections";
     readonly APPROVAL_FLOW: "approvalFlow";

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

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

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

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

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

@@ -1,3 +1,3 @@
-import { RequestContext } from '../@types-v5';
+import { RequestContext } from '../@types';
 import PluginError from './PluginError';
 export declare const throwError: (ctx: RequestContext, e: PluginError | Error | unknown) => PluginError | Error | unknown | never;

package/dist/server/src/validators/api/controllers/client.controller.validator.d.ts

@@ -1,27 +1,40 @@
+import { CommentsPluginConfig } from '../../../config';
 import { APPROVAL_STATUS } from '../../../const';
 import { ExtractRightEither } from '../../../utils/Either';
 export declare const newCommentValidator: (enabledCollections: string[], relation: string, payload: object) => import("../../../utils/Either").Left<import("../../../utils/PluginError").default> | import("../../../utils/Either").Right<{
     content?: string;
     approvalStatus?: APPROVAL_STATUS;
+    locale?: string;
     author?: {
         name?: string;
         id?: number;
         email?: string;
         avatar?: string;
     };
-    threadOf?: number;
-    relation?: `{${string}::${string}.${number}}`;
+    threadOf?: string;
+    relation?: `${string}::${string}.${string}`;
 }>;
 export type NewCommentValidatorSchema = ExtractRightEither<ReturnType<typeof newCommentValidator>>;
 export declare const updateCommentValidator: (enabledCollections: string[], payload: object) => import("../../../utils/Either").Left<import("../../../utils/PluginError").default> | import("../../../utils/Either").Right<{
     content?: string;
-    relation?: `{${string}::${string}.${number}}`;
+    relation?: `${string}::${string}.${string}`;
     commentId?: number;
 }>;
 export type UpdateCommentValidatorSchema = ExtractRightEither<ReturnType<typeof updateCommentValidator>>;
 export declare const findAllFlatValidator: (enabledCollections: string[], relation: string, payload: object) => import("../../../utils/Either").Left<import("../../../utils/PluginError").default> | import("../../../utils/Either").Right<{
-    query?: {
-        $and?: Record<string, string | number | {
+    sort?: string;
+    locale?: string;
+    pagination?: {
+        page?: number;
+        pageSize?: number;
+        withCount?: boolean;
+    };
+    relation?: `${string}::${string}.${string}`;
+    populate?: Record<string, boolean | {
+        populate?: boolean;
+    }>;
+    filters?: {
+        id?: string | number | {
             $eq?: string;
         } | {
             $eqi?: string;
@@ -55,8 +68,8 @@ export declare const findAllFlatValidator: (enabledCollections: string[], relati
             $notContainsi?: string;
         } | {
             $notNull?: boolean;
-        }>[];
-        $or?: Record<string, string | number | {
+        };
+        content?: string | number | {
             $eq?: string;
         } | {
             $eqi?: string;
@@ -90,11 +103,8 @@ export declare const findAllFlatValidator: (enabledCollections: string[], relati
             $notContainsi?: string;
         } | {
             $notNull?: boolean;
-        }>[];
-    } | Record<string, string | number | boolean | Record<string, string | number | boolean>>;
-    sort?: string;
-    filter?: {
-        content?: string | number | {
+        };
+        createdAt?: string | number | {
             $eq?: string;
         } | {
             $eqi?: string;
@@ -129,7 +139,7 @@ export declare const findAllFlatValidator: (enabledCollections: string[], relati
         } | {
             $notNull?: boolean;
         };
-        createdAt?: string | number | {
+        updatedAt?: string | number | {
             $eq?: string;
         } | {
             $eqi?: string;
@@ -164,7 +174,7 @@ export declare const findAllFlatValidator: (enabledCollections: string[], relati
         } | {
             $notNull?: boolean;
         };
-        updatedAt?: string | number | {
+        authorName?: string | number | {
             $eq?: string;
         } | {
             $eqi?: string;
@@ -199,7 +209,23 @@ export declare const findAllFlatValidator: (enabledCollections: string[], relati
         } | {
             $notNull?: boolean;
         };
-        authorName?: string | number | {
+    };
+    limit?: number;
+    fields?: string[];
+    omit?: string[];
+    isAdmin?: boolean;
+    skip?: number;
+}>;
+export type FindAllFlatSchema = ExtractRightEither<ReturnType<typeof findAllFlatValidator>>;
+export declare const findAllInHierarchyValidator: (enabledCollections: string[], relation: string, payload: object) => import("../../../utils/Either").Left<import("../../../utils/PluginError").default> | import("../../../utils/Either").Right<{
+    sort?: string;
+    locale?: string;
+    relation?: `${string}::${string}.${string}`;
+    populate?: Record<string, boolean | {
+        populate?: boolean;
+    }>;
+    filters?: {
+        id?: string | number | {
             $eq?: string;
         } | {
             $eqi?: string;
@@ -234,26 +260,7 @@ export declare const findAllFlatValidator: (enabledCollections: string[], relati
         } | {
             $notNull?: boolean;
         };
-    };
-    pagination?: {
-        page?: number;
-        pageSize?: number;
-        withCount?: boolean;
-    };
-    relation?: `{${string}::${string}.${number}}`;
-    populate?: Record<string, boolean | {
-        populate?: boolean;
-    }>;
-    limit?: number;
-    fields?: string[];
-    omit?: string[];
-    isAdmin?: boolean;
-    skip?: number;
-}>;
-export type FindAllFlatSchema = ExtractRightEither<ReturnType<typeof findAllFlatValidator>>;
-export declare const findAllInHierarchyValidator: (enabledCollections: string[], relation: string, payload: object) => import("../../../utils/Either").Left<import("../../../utils/PluginError").default> | import("../../../utils/Either").Right<{
-    query?: {
-        $and?: Record<string, string | number | {
+        content?: string | number | {
             $eq?: string;
         } | {
             $eqi?: string;
@@ -287,8 +294,8 @@ export declare const findAllInHierarchyValidator: (enabledCollections: string[],
             $notContainsi?: string;
         } | {
             $notNull?: boolean;
-        }>[];
-        $or?: Record<string, string | number | {
+        };
+        createdAt?: string | number | {
             $eq?: string;
         } | {
             $eqi?: string;
@@ -322,11 +329,8 @@ export declare const findAllInHierarchyValidator: (enabledCollections: string[],
             $notContainsi?: string;
         } | {
             $notNull?: boolean;
-        }>[];
-    } | Record<string, string | number | boolean | Record<string, string | number | boolean>>;
-    sort?: string;
-    filter?: {
-        content?: string | number | {
+        };
+        updatedAt?: string | number | {
             $eq?: string;
         } | {
             $eqi?: string;
@@ -361,7 +365,7 @@ export declare const findAllInHierarchyValidator: (enabledCollections: string[],
         } | {
             $notNull?: boolean;
         };
-        createdAt?: string | number | {
+        authorName?: string | number | {
             $eq?: string;
         } | {
             $eqi?: string;
@@ -396,7 +400,31 @@ export declare const findAllInHierarchyValidator: (enabledCollections: string[],
         } | {
             $notNull?: boolean;
         };
-        updatedAt?: string | number | {
+    };
+    limit?: number;
+    fields?: string[];
+    omit?: string[];
+    isAdmin?: boolean;
+    skip?: number;
+    startingFromId?: number;
+    dropBlockedThreads?: boolean;
+}>;
+export type FindAllInHierarchyValidatorSchema = ExtractRightEither<ReturnType<typeof findAllInHierarchyValidator>>;
+export declare const findAllPerAuthorValidator: (params: object, payload: object) => import("../../../utils/Either").Left<import("../../../utils/PluginError").default> | import("../../../utils/Either").Right<{
+    type?: string;
+    sort?: string;
+    authorId?: string | number;
+    locale?: string;
+    pagination?: {
+        page?: number;
+        pageSize?: number;
+        withCount?: boolean;
+    };
+    populate?: Record<string, boolean | {
+        populate?: boolean;
+    }>;
+    filters?: {
+        id?: string | number | {
             $eq?: string;
         } | {
             $eqi?: string;
@@ -431,7 +459,7 @@ export declare const findAllInHierarchyValidator: (enabledCollections: string[],
         } | {
             $notNull?: boolean;
         };
-        authorName?: string | number | {
+        content?: string | number | {
             $eq?: string;
         } | {
             $eqi?: string;
@@ -466,23 +494,7 @@ export declare const findAllInHierarchyValidator: (enabledCollections: string[],
         } | {
             $notNull?: boolean;
         };
-    };
-    relation?: `{${string}::${string}.${number}}`;
-    populate?: Record<string, boolean | {
-        populate?: boolean;
-    }>;
-    limit?: number;
-    fields?: string[];
-    omit?: string[];
-    isAdmin?: boolean;
-    skip?: number;
-    startingFromId?: number;
-    dropBlockedThreads?: boolean;
-}>;
-export type FindAllInHierarchyValidatorSchema = ExtractRightEither<ReturnType<typeof findAllInHierarchyValidator>>;
-export declare const findAllPerAuthorValidator: (params: object, payload: object) => import("../../../utils/Either").Left<import("../../../utils/PluginError").default> | import("../../../utils/Either").Right<{
-    query?: {
-        $and?: Record<string, string | number | {
+        createdAt?: string | number | {
             $eq?: string;
         } | {
             $eqi?: string;
@@ -516,8 +528,8 @@ export declare const findAllPerAuthorValidator: (params: object, payload: object
             $notContainsi?: string;
         } | {
             $notNull?: boolean;
-        }>[];
-        $or?: Record<string, string | number | {
+        };
+        updatedAt?: string | number | {
             $eq?: string;
         } | {
             $eqi?: string;
@@ -551,19 +563,43 @@ export declare const findAllPerAuthorValidator: (params: object, payload: object
             $notContainsi?: string;
         } | {
             $notNull?: boolean;
-        }>[];
-    } | Record<string, string | number | boolean | Record<string, string | number | boolean>>;
-    type?: string;
-    sort?: string;
-    authorId?: string | number;
-    pagination?: {
-        page?: number;
-        pageSize?: number;
-        withCount?: boolean;
+        };
+        authorName?: string | number | {
+            $eq?: string;
+        } | {
+            $eqi?: string;
+        } | {
+            $ne?: string;
+        } | {
+            $nei?: string;
+        } | {
+            $gt?: string;
+        } | {
+            $gte?: string;
+        } | {
+            $lt?: string;
+        } | {
+            $lte?: string;
+        } | {
+            $startsWith?: string;
+        } | {
+            $startsWithi?: string;
+        } | {
+            $endsWith?: string;
+        } | {
+            $endsWithi?: string;
+        } | {
+            $contains?: string;
+        } | {
+            $containsi?: string;
+        } | {
+            $notContains?: string;
+        } | {
+            $notContainsi?: string;
+        } | {
+            $notNull?: boolean;
+        };
     };
-    populate?: Record<string, boolean | {
-        populate?: boolean;
-    }>;
     limit?: number;
     fields?: string[];
     omit?: string[];
@@ -571,16 +607,16 @@ export declare const findAllPerAuthorValidator: (params: object, payload: object
     skip?: number;
 }>;
 export type FindAllPerAuthorValidatorSchema = ExtractRightEither<ReturnType<typeof findAllPerAuthorValidator>>;
-export declare const reportAbuseValidator: (enabledCollections: string[], payload: object) => import("../../../utils/Either").Left<import("../../../utils/PluginError").default> | import("../../../utils/Either").Right<{
+export declare const reportAbuseValidator: (config: CommentsPluginConfig, payload: object) => import("../../../utils/Either").Left<import("../../../utils/PluginError").default> | import("../../../utils/Either").Right<{
     content?: string;
-    reason?: string;
-    relation?: `{${string}::${string}.${number}}`;
+    reason?: import("../../../const").REPORT_REASON;
+    relation?: `${string}::${string}.${string}`;
     commentId?: number;
 }>;
 export type ReportAbuseValidatorSchema = ExtractRightEither<ReturnType<typeof reportAbuseValidator>>;
 export declare const removeCommentValidator: (enabledCollections: string[], payload: object) => import("../../../utils/Either").Left<import("../../../utils/PluginError").default> | import("../../../utils/Either").Right<{
     authorId?: string | number;
-    relation?: `{${string}::${string}.${number}}`;
+    relation?: `${string}::${string}.${string}`;
     commentId?: number;
 }>;
 export type RemoveCommentValidatorSchema = ExtractRightEither<ReturnType<typeof removeCommentValidator>>;

package/dist/server/src/validators/api/controllers/settings.controller.validator.d.ts

@@ -1,5 +1,3 @@
-import { z } from "zod";
-import { schemaConfig } from "../../../config";
 export declare const validateConfig: (config: unknown) => import("../../../utils/Either").Left<import("../../../utils/PluginError").default> | import("../../../utils/Either").Right<{
     enabledCollections?: string[];
     approvalFlow?: string[];
@@ -14,5 +12,11 @@ export declare const validateConfig: (config: unknown) => import("../../../utils
         OTHER?: import("../../../const").REPORT_REASON.OTHER;
     };
     isGQLPluginEnabled?: boolean;
+    gql?: {
+        auth?: boolean;
+    };
+    client?: {
+        url?: string;
+        contactEmail?: string;
+    };
 }>;
-export type CommentsPluginConfig = z.infer<typeof schemaConfig>;

package/dist/server/src/validators/repositories/comment.schema.d.ts

@@ -17,7 +17,16 @@ export declare const dbBaseCommentSchema: z.ZodObject<{
     authorName: z.ZodNullable<z.ZodString>;
     authorEmail: z.ZodNullable<z.ZodString>;
     authorAvatar: z.ZodNullable<z.ZodString>;
-    authorUser: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+    authorUser: z.ZodNullable<z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodObject<{
+        id: z.ZodNumber;
+        email: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        id?: number;
+        email?: string;
+    }, {
+        id?: number;
+        email?: string;
+    }>]>>>;
     locale: z.ZodNullable<z.ZodString>;
 }, "strip", z.ZodTypeAny, {
     id?: number;
@@ -37,7 +46,10 @@ export declare const dbBaseCommentSchema: z.ZodObject<{
     authorName?: string;
     authorEmail?: string;
     authorAvatar?: string;
-    authorUser?: string;
+    authorUser?: string | {
+        id?: number;
+        email?: string;
+    };
     locale?: string;
 }, {
     id?: number;
@@ -57,6 +69,9 @@ export declare const dbBaseCommentSchema: z.ZodObject<{
     authorName?: string;
     authorEmail?: string;
     authorAvatar?: string;
-    authorUser?: string;
+    authorUser?: string | {
+        id?: number;
+        email?: string;
+    };
     locale?: string;
 }>;