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

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

@@ -0,0 +1,586 @@
+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;
+    author?: {
+        name?: string;
+        id?: number;
+        email?: string;
+        avatar?: string;
+    };
+    threadOf?: number;
+    relation?: `{${string}::${string}.${number}}`;
+}>;
+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}}`;
+    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 | {
+            $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;
+        }>[];
+        $or?: Record<string, 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;
+        }>[];
+    } | Record<string, string | number | boolean | Record<string, string | number | boolean>>;
+    sort?: string;
+    filter?: {
+        content?: 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;
+        };
+        createdAt?: 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;
+        };
+        updatedAt?: 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;
+        };
+        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;
+        };
+    };
+    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 | {
+            $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;
+        }>[];
+        $or?: Record<string, 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;
+        }>[];
+    } | Record<string, string | number | boolean | Record<string, string | number | boolean>>;
+    sort?: string;
+    filter?: {
+        content?: 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;
+        };
+        createdAt?: 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;
+        };
+        updatedAt?: 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;
+        };
+        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;
+        };
+    };
+    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 | {
+            $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;
+        }>[];
+        $or?: Record<string, 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;
+        }>[];
+    } | Record<string, string | number | boolean | Record<string, string | number | boolean>>;
+    type?: string;
+    sort?: string;
+    authorId?: string | number;
+    pagination?: {
+        page?: number;
+        pageSize?: number;
+        withCount?: boolean;
+    };
+    populate?: Record<string, boolean | {
+        populate?: boolean;
+    }>;
+    limit?: number;
+    fields?: string[];
+    omit?: string[];
+    isAdmin?: boolean;
+    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<{
+    content?: string;
+    reason?: string;
+    relation?: `{${string}::${string}.${number}}`;
+    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}}`;
+    commentId?: number;
+}>;
+export type RemoveCommentValidatorSchema = ExtractRightEither<ReturnType<typeof removeCommentValidator>>;

package/dist/server/src/validators/api/controllers/index.d.ts

@@ -0,0 +1,3 @@
+export * as admin from './admin.controller.validator';
+export * as settings from './settings.controller.validator';
+export * as client from './client.controller.validator';

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

@@ -0,0 +1,18 @@
+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[];
+    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;
+    };
+    isGQLPluginEnabled?: boolean;
+}>;
+export type CommentsPluginConfig = z.infer<typeof schemaConfig>;

package/dist/server/src/validators/api/index.d.ts

@@ -0,0 +1 @@
+export * from './controllers';

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

@@ -0,0 +1,62 @@
+import { z } from 'zod';
+export declare const dbBaseCommentSchema: z.ZodObject<{
+    id: z.ZodNumber;
+    documentId: z.ZodNullable<z.ZodString>;
+    content: z.ZodString;
+    blocked: z.ZodNullable<z.ZodBoolean>;
+    blockedThread: z.ZodNullable<z.ZodBoolean>;
+    blockReason: z.ZodNullable<z.ZodString>;
+    isAdminComment: z.ZodNullable<z.ZodBoolean>;
+    removed: z.ZodNullable<z.ZodBoolean>;
+    approvalStatus: z.ZodNullable<z.ZodString>;
+    related: z.ZodString;
+    createdAt: z.ZodString;
+    updatedAt: z.ZodNullable<z.ZodString>;
+    publishedAt: z.ZodNullable<z.ZodString>;
+    authorId: z.ZodNullable<z.ZodString>;
+    authorName: z.ZodNullable<z.ZodString>;
+    authorEmail: z.ZodNullable<z.ZodString>;
+    authorAvatar: z.ZodNullable<z.ZodString>;
+    authorUser: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+    locale: z.ZodNullable<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    id?: number;
+    documentId?: string;
+    content?: string;
+    blocked?: boolean;
+    blockedThread?: boolean;
+    blockReason?: string;
+    isAdminComment?: boolean;
+    removed?: boolean;
+    approvalStatus?: string;
+    related?: string;
+    createdAt?: string;
+    updatedAt?: string;
+    publishedAt?: string;
+    authorId?: string;
+    authorName?: string;
+    authorEmail?: string;
+    authorAvatar?: string;
+    authorUser?: string;
+    locale?: string;
+}, {
+    id?: number;
+    documentId?: string;
+    content?: string;
+    blocked?: boolean;
+    blockedThread?: boolean;
+    blockReason?: string;
+    isAdminComment?: boolean;
+    removed?: boolean;
+    approvalStatus?: string;
+    related?: string;
+    createdAt?: string;
+    updatedAt?: string;
+    publishedAt?: string;
+    authorId?: string;
+    authorName?: string;
+    authorEmail?: string;
+    authorAvatar?: string;
+    authorUser?: string;
+    locale?: string;
+}>;