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

package/dist/admin/src/hooks/useAPI.d.ts

@@ -0,0 +1,430 @@
+export declare const useAPI: () => {
+    config: {
+        getKey(): string[];
+        query(): Promise<{
+            entryLabel: Record<string, string[]>;
+            approvalFlow: string[];
+            blockedAuthorProps: string[];
+            reportReasons: {
+                BAD_LANGUAGE: "BAD_LANGUAGE";
+                DISCRIMINATION: "DISCRIMINATION";
+                OTHER: "OTHER";
+            };
+            regex: {
+                uid: string;
+                relatedUid: string;
+                email: string;
+                sorting: string;
+            };
+            enabledCollections: string[];
+            moderatorRoles: string[];
+            isGQLPluginEnabled: boolean;
+            client: {
+                url: string | null;
+                contactEmail: string | null;
+            };
+            badWords?: boolean | null | undefined;
+            gql?: {
+                auth: boolean | null;
+            } | undefined;
+        }>;
+    };
+    contentTypeBuilder: {
+        single: {
+            getKey(uid: string, canAccess: boolean): (string | boolean)[];
+            query(uid: string): Promise<{
+                uid: string;
+                apiID: string;
+                schema: {
+                    displayName: string;
+                    attributes: Record<string, {
+                        type: string;
+                    }>;
+                    collectionName: string;
+                    description: string;
+                    draftAndPublish: boolean;
+                    kind: string;
+                    pluralName: string;
+                    singularName: string;
+                    visible: boolean;
+                };
+            }>;
+        };
+        all: {
+            getKey(): string[];
+            query(): Promise<{
+                uid: string;
+                apiID: string;
+                schema: {
+                    displayName: string;
+                    attributes: Record<string, {
+                        type: string;
+                    }>;
+                    collectionName: string;
+                    description: string;
+                    draftAndPublish: boolean;
+                    kind: string;
+                    pluralName: string;
+                    singularName: string;
+                    visible: boolean;
+                };
+            }[]>;
+        };
+    };
+    roles: {
+        getKey(): string[];
+        query(): Promise<{
+            code: string;
+            id: number;
+            documentId: string;
+            createdAt: string;
+            updatedAt: string;
+            publishedAt: string;
+            name: string;
+            description: string;
+            locale: string | null;
+            usersCount: number;
+        }[]>;
+    };
+    user: {
+        getKey(): string[];
+        query(): Promise<{
+            email: string;
+            id: number;
+            documentId: string;
+            createdAt: string;
+            updatedAt: string;
+            publishedAt: string;
+            blocked: boolean;
+            locale: null;
+            firstname: string;
+            lastname: string;
+            username: string | null;
+            isActive: boolean;
+            preferedLanguage: string | null;
+            roles: {
+                code: string;
+                id: number;
+                name: string;
+                description: string;
+            }[];
+        }>;
+    };
+    comments: {
+        findAll: {
+            getKey(queryParams?: Record<string, string> | undefined): string[];
+            query(queryParams: Record<string, string>): Promise<{
+                pagination: {
+                    page: number;
+                    pageSize: number;
+                    pageCount: number;
+                    total: number;
+                };
+                result: import("../api/schemas").Comment[];
+            }>;
+        };
+        findOne: {
+            getKey(id?: string | number | undefined, filters?: any): string[];
+            query(id: string | number, filters: any): Promise<{
+                entity: {
+                    uid: string;
+                    id: number;
+                    documentId: string;
+                    createdAt: string;
+                    updatedAt: string;
+                    publishedAt: string | null;
+                } & Record<string, unknown>;
+                selected: {
+                    id: number;
+                    createdAt: string;
+                    updatedAt: string;
+                    content: string;
+                    blocked: boolean | null;
+                    blockedThread: boolean | null;
+                    blockReason: string | null;
+                    isAdminComment: boolean | null;
+                    removed: boolean | null;
+                    approvalStatus: "PENDING" | "APPROVED" | "REJECTED" | "BLOCKED" | "OPEN" | "REMOVED" | "TO_REVIEW" | "UNKNOWN" | null;
+                    author: {
+                        email: string;
+                        id: string | number;
+                        name: string;
+                        avatar: {
+                            url: string | null;
+                            formats: {
+                                thumbnail: {
+                                    url: string;
+                                } | null;
+                            };
+                        } | {
+                            email: string;
+                            url: string | null;
+                            id: string;
+                            name: string;
+                            avatar: string | null;
+                        } | null;
+                    };
+                    related: string;
+                    reports?: {
+                        resolved: boolean;
+                        id: number;
+                        createdAt: string;
+                        updatedAt: string | null;
+                        reason: "BAD_LANGUAGE" | "DISCRIMINATION" | "OTHER";
+                        content: string;
+                    }[] | null | undefined;
+                    gotThread?: boolean | null | undefined;
+                    threadFirstItemId?: number | null | undefined;
+                    threadOf?: {
+                        id: number;
+                        documentId: string;
+                        createdAt: string;
+                        updatedAt: string;
+                        content: string;
+                        blocked: boolean | null;
+                        blockedThread: boolean | null;
+                        blockReason: string | null;
+                        isAdminComment: boolean | null;
+                        removed: boolean | null;
+                        approvalStatus: "PENDING" | "APPROVED" | "REJECTED" | "BLOCKED" | "OPEN" | "REMOVED" | "TO_REVIEW" | "UNKNOWN" | null;
+                        author: {
+                            email: string;
+                            id: string | number;
+                            name: string;
+                            avatar: {
+                                url: string | null;
+                                formats: {
+                                    thumbnail: {
+                                        url: string;
+                                    } | null;
+                                };
+                            } | {
+                                email: string;
+                                url: string | null;
+                                id: string;
+                                name: string;
+                                avatar: string | null;
+                            } | null;
+                        };
+                        related: string;
+                        reports?: {
+                            resolved: boolean;
+                            id: number;
+                            createdAt: string;
+                            updatedAt: string | null;
+                            reason: "BAD_LANGUAGE" | "DISCRIMINATION" | "OTHER";
+                            content: string;
+                        }[] | null | undefined;
+                        gotThread?: boolean | null | undefined;
+                        threadFirstItemId?: number | null | undefined;
+                        threadOf?: {
+                            id: number;
+                            createdAt: string;
+                            updatedAt: string;
+                            content: string;
+                            blocked: boolean | null;
+                            blockedThread: boolean | null;
+                            blockReason: string | null;
+                            isAdminComment: boolean | null;
+                            removed: boolean | null;
+                            approvalStatus: "PENDING" | "APPROVED" | "REJECTED" | "BLOCKED" | "OPEN" | "REMOVED" | "TO_REVIEW" | "UNKNOWN" | null;
+                            author: {
+                                email: string;
+                                id: string | number;
+                                name: string;
+                                avatar: {
+                                    url: string | null;
+                                    formats: {
+                                        thumbnail: {
+                                            url: string;
+                                        } | null;
+                                    };
+                                } | {
+                                    email: string;
+                                    url: string | null;
+                                    id: string;
+                                    name: string;
+                                    avatar: string | null;
+                                } | null;
+                            };
+                            related: string;
+                            documentId?: string | undefined;
+                            reports?: {
+                                resolved: boolean;
+                                id: number;
+                                createdAt: string;
+                                updatedAt: string | null;
+                                reason: "BAD_LANGUAGE" | "DISCRIMINATION" | "OTHER";
+                                content: string;
+                            }[] | null | undefined;
+                            gotThread?: boolean | null | undefined;
+                            threadFirstItemId?: number | null | undefined;
+                            threadOf?: import("../api/schemas").Comment | null | undefined;
+                        } | null | undefined;
+                    } | null | undefined;
+                } | null;
+                level: {
+                    id: number;
+                    documentId: string;
+                    createdAt: string;
+                    updatedAt: string;
+                    content: string;
+                    blocked: boolean | null;
+                    blockedThread: boolean | null;
+                    blockReason: string | null;
+                    isAdminComment: boolean | null;
+                    removed: boolean | null;
+                    approvalStatus: "PENDING" | "APPROVED" | "REJECTED" | "BLOCKED" | "OPEN" | "REMOVED" | "TO_REVIEW" | "UNKNOWN" | null;
+                    author: {
+                        email: string;
+                        id: string | number;
+                        name: string;
+                        avatar: {
+                            url: string | null;
+                            formats: {
+                                thumbnail: {
+                                    url: string;
+                                } | null;
+                            };
+                        } | {
+                            email: string;
+                            url: string | null;
+                            id: string;
+                            name: string;
+                            avatar: string | null;
+                        } | null;
+                    };
+                    reports?: {
+                        resolved: boolean;
+                        id: number;
+                        createdAt: string;
+                        updatedAt: string | null;
+                        reason: "BAD_LANGUAGE" | "DISCRIMINATION" | "OTHER";
+                        content: string;
+                    }[] | null | undefined;
+                    gotThread?: boolean | null | undefined;
+                    threadFirstItemId?: number | null | undefined;
+                }[];
+            }>;
+        };
+        approve(id: number): Promise<import("@strapi/strapi/admin").FetchResponse<any>>;
+        reject(id: number): Promise<import("@strapi/strapi/admin").FetchResponse<any>>;
+        block(id: number): Promise<import("@strapi/strapi/admin").FetchResponse<any>>;
+        unblock(id: number): Promise<import("@strapi/strapi/admin").FetchResponse<any>>;
+        blockThread(id: number): Promise<import("@strapi/strapi/admin").FetchResponse<any>>;
+        unBlockThread(id: number): Promise<import("@strapi/strapi/admin").FetchResponse<any>>;
+        delete(id: number): Promise<import("@strapi/strapi/admin").FetchResponse<any>>;
+        postComment({ id, content, author }: {
+            id: string | number;
+            content: string;
+            author: {
+                email: string;
+                id: number;
+                documentId: string;
+                createdAt: string;
+                updatedAt: string;
+                publishedAt: string;
+                blocked: boolean;
+                locale: null;
+                firstname: string;
+                lastname: string;
+                username: string | null;
+                isActive: boolean;
+                preferedLanguage: string | null;
+                roles: {
+                    code: string;
+                    id: number;
+                    name: string;
+                    description: string;
+                }[];
+            };
+        }): Promise<import("@strapi/strapi/admin").FetchResponse<any>>;
+        updateComment({ id, content }: {
+            id: string | number;
+            content: string;
+        }): Promise<import("@strapi/strapi/admin").FetchResponse<any>>;
+    };
+    reports: {
+        findAll: {
+            getKey(queryParams?: Record<string, string> | undefined): string[];
+            query(queryParams?: Record<string, string> | undefined): Promise<{
+                pagination: {
+                    page: number;
+                    pageSize: number;
+                    pageCount: number;
+                    total: number;
+                };
+                result: {
+                    id: number;
+                    createdAt: string;
+                    updatedAt: string | null;
+                    reason: "BAD_LANGUAGE" | "DISCRIMINATION" | "OTHER";
+                    content: string;
+                    reports: unknown[];
+                    related: {
+                        id: number;
+                        createdAt: string;
+                        updatedAt: string;
+                        content: string;
+                        blocked: boolean | null;
+                        blockedThread: boolean | null;
+                        blockReason: string | null;
+                        isAdminComment: boolean | null;
+                        removed: boolean | null;
+                        approvalStatus: "PENDING" | "APPROVED" | "REJECTED" | "BLOCKED" | "OPEN" | "REMOVED" | "TO_REVIEW" | "UNKNOWN" | null;
+                        author: {
+                            email: string;
+                            id: string | number;
+                            name: string;
+                            avatar: {
+                                url: string | null;
+                                formats: {
+                                    thumbnail: {
+                                        url: string;
+                                    } | null;
+                                };
+                            } | {
+                                email: string;
+                                url: string | null;
+                                id: string;
+                                name: string;
+                                avatar: string | null;
+                            } | null;
+                        };
+                        reports?: {
+                            resolved: boolean;
+                            id: number;
+                            createdAt: string;
+                            updatedAt: string | null;
+                            reason: "BAD_LANGUAGE" | "DISCRIMINATION" | "OTHER";
+                            content: string;
+                        }[] | null | undefined;
+                        gotThread?: boolean | null | undefined;
+                        threadFirstItemId?: number | null | undefined;
+                    };
+                    resolved?: boolean | undefined;
+                    approvalStatus?: "PENDING" | "APPROVED" | "REJECTED" | "BLOCKED" | "OPEN" | "REMOVED" | "TO_REVIEW" | "UNKNOWN" | null | undefined;
+                    author?: unknown;
+                }[];
+            }>;
+        };
+        resolve({ id, reportId }: {
+            id: number;
+            reportId: number;
+        }): Promise<import("@strapi/strapi/admin").FetchResponse<any>>;
+        resolveMultipleReports({ reportIds }: {
+            reportIds: number[];
+        }): Promise<import("@strapi/strapi/admin").FetchResponse<any>>;
+        resolveCommentMultipleReports({ id, reportIds }: {
+            id: number;
+            reportIds: number[];
+        }): Promise<import("@strapi/strapi/admin").FetchResponse<any>>;
+        resolveAllAbuseReportsForComment(id: number): Promise<import("@strapi/strapi/admin").FetchResponse<any>>;
+        resolveAllAbuseReportsForThread(id: number): Promise<import("@strapi/strapi/admin").FetchResponse<any>>;
+    };
+    settings: {
+        update(body: any): Promise<import("@strapi/strapi/admin").FetchResponse<any>>;
+        restore(): Promise<import("@strapi/strapi/admin").FetchResponse<any>>;
+        restart(): Promise<import("@strapi/strapi/admin").FetchResponse<any>>;
+    };
+};

package/dist/admin/src/hooks/useCommentMutations.d.ts

@@ -0,0 +1,72 @@
+type MutationKey = {
+    comment: {
+        block: boolean;
+        unBlock: boolean;
+        blockThread: boolean;
+        unBlockThread: boolean;
+        delete: boolean;
+        postComment: boolean;
+    };
+    report: {
+        resolve: boolean;
+        resolveMultiple: boolean;
+        resolveAllAbuse: boolean;
+        resolveAllAbuseThread: boolean;
+        resolveCommentMultipleReports: boolean;
+    };
+};
+type CallbacksMutation = {
+    [K in keyof MutationKey]?: {
+        [L in keyof MutationKey[K] as `${L & string}${'Success' | 'Error'}`]?: () => void;
+    };
+};
+export declare const useCommentMutations: (callbacksMutation?: CallbacksMutation) => {
+    commentMutation: {
+        block: import("@tanstack/react-query").UseMutationResult<import("@strapi/admin/strapi-admin").FetchResponse<any>, Error, number, unknown>;
+        unBlock: import("@tanstack/react-query").UseMutationResult<import("@strapi/admin/strapi-admin").FetchResponse<any>, Error, number, unknown>;
+        blockThread: import("@tanstack/react-query").UseMutationResult<import("@strapi/admin/strapi-admin").FetchResponse<any>, Error, number, unknown>;
+        unBlockThread: import("@tanstack/react-query").UseMutationResult<import("@strapi/admin/strapi-admin").FetchResponse<any>, Error, number, unknown>;
+        delete: import("@tanstack/react-query").UseMutationResult<import("@strapi/admin/strapi-admin").FetchResponse<any>, Error, number, unknown>;
+        postComment: import("@tanstack/react-query").UseMutationResult<import("@strapi/admin/strapi-admin").FetchResponse<any>, Error, {
+            id: string | number;
+            content: string;
+            author: {
+                email: string;
+                id: number;
+                documentId: string;
+                createdAt: string;
+                updatedAt: string;
+                publishedAt: string;
+                blocked: boolean;
+                locale: null;
+                firstname: string;
+                lastname: string;
+                username: string | null;
+                isActive: boolean;
+                preferedLanguage: string | null;
+                roles: {
+                    code: string;
+                    id: number;
+                    name: string;
+                    description: string;
+                }[];
+            };
+        }, unknown>;
+    };
+    reportMutation: {
+        resolve: import("@tanstack/react-query").UseMutationResult<import("@strapi/admin/strapi-admin").FetchResponse<any>, Error, {
+            id: number;
+            reportId: number;
+        }, unknown>;
+        resolveMultiple: import("@tanstack/react-query").UseMutationResult<import("@strapi/admin/strapi-admin").FetchResponse<any>, Error, {
+            reportIds: number[];
+        }, unknown>;
+        resolveAllAbuse: import("@tanstack/react-query").UseMutationResult<import("@strapi/admin/strapi-admin").FetchResponse<any>, Error, number, unknown>;
+        resolveAllAbuseThread: import("@tanstack/react-query").UseMutationResult<import("@strapi/admin/strapi-admin").FetchResponse<any>, Error, number, unknown>;
+        resolveCommentMultipleReports: import("@tanstack/react-query").UseMutationResult<import("@strapi/admin/strapi-admin").FetchResponse<any>, Error, {
+            id: number;
+            reportIds: number[];
+        }, unknown>;
+    };
+};
+export {};

package/dist/admin/src/hooks/useCommentsAll.d.ts

@@ -0,0 +1,59 @@
+export declare const useCommentsAll: (queryParams: Record<string, string>) => import("@tanstack/react-query").DefinedUseQueryResult<{
+    result: {
+        reports: {
+            resolved: boolean;
+            id: number;
+            createdAt: string;
+            updatedAt: string | null;
+            reason: "BAD_LANGUAGE" | "DISCRIMINATION" | "OTHER";
+            content: string;
+        }[];
+        id: number;
+        createdAt: string;
+        updatedAt: string;
+        content: string;
+        blocked: boolean | null;
+        blockedThread: boolean | null;
+        blockReason: string | null;
+        isAdminComment: boolean | null;
+        removed: boolean | null;
+        approvalStatus: "PENDING" | "APPROVED" | "REJECTED" | "BLOCKED" | "OPEN" | "REMOVED" | "TO_REVIEW" | "UNKNOWN" | null;
+        author: {
+            email: string;
+            id: string | number;
+            name: string;
+            avatar: {
+                url: string | null;
+                formats: {
+                    thumbnail: {
+                        url: string;
+                    } | null;
+                };
+            } | {
+                email: string;
+                url: string | null;
+                id: string;
+                name: string;
+                avatar: string | null;
+            } | null;
+        };
+        gotThread?: boolean | null | undefined;
+        threadFirstItemId?: number | null | undefined;
+        threadOf?: import("../api/schemas").Comment | null | undefined;
+        related: string | ({
+            uid: string;
+            id: number;
+            documentId: string;
+            createdAt: string;
+            updatedAt: string;
+            publishedAt: string | null;
+        } & Record<string, unknown>);
+        documentId?: string | undefined;
+    }[];
+    pagination: {
+        page: number;
+        pageSize: number;
+        pageCount: number;
+        total: number;
+    };
+}, Error>;

package/dist/admin/src/hooks/useConfig.d.ts

@@ -0,0 +1,28 @@
+import { Config } from '../api/schemas';
+export declare const useConfig: (setSettings: (settings: Config) => void) => import("@tanstack/react-query").UseQueryResult<{
+    entryLabel: Record<string, string[]>;
+    approvalFlow: string[];
+    blockedAuthorProps: string[];
+    reportReasons: {
+        BAD_LANGUAGE: "BAD_LANGUAGE";
+        DISCRIMINATION: "DISCRIMINATION";
+        OTHER: "OTHER";
+    };
+    regex: {
+        uid: string;
+        relatedUid: string;
+        email: string;
+        sorting: string;
+    };
+    enabledCollections: string[];
+    moderatorRoles: string[];
+    isGQLPluginEnabled: boolean;
+    client: {
+        url: string | null;
+        contactEmail: string | null;
+    };
+    badWords?: boolean | null | undefined;
+    gql?: {
+        auth: boolean | null;
+    } | undefined;
+}, Error>;

package/dist/admin/src/hooks/useElementOnScreen.d.ts

@@ -0,0 +1,2 @@
+/// <reference types="react" />
+export declare const useElementOnScreen: (options: IntersectionObserverInit) => readonly [import("react").RefObject<HTMLElement>, boolean];

package/dist/admin/src/hooks/usePermissions.d.ts

@@ -0,0 +1,9 @@
+export declare const usePermissions: () => {
+    isLoadingForPermissions: boolean;
+    canAccess: boolean;
+    canModerate: boolean;
+    canAccessReports: boolean;
+    canReviewReports: boolean;
+    canSettings: boolean;
+    canSettingsChange: boolean;
+};

package/dist/admin/src/hooks/useReports.d.ts

@@ -0,0 +1,60 @@
+export declare const useReports: (queryParams?: Record<string, string>) => import("@tanstack/react-query").DefinedUseQueryResult<{
+    pagination: {
+        page: number;
+        pageSize: number;
+        pageCount: number;
+        total: number;
+    };
+    result: {
+        id: number;
+        createdAt: string;
+        updatedAt: string | null;
+        reason: "BAD_LANGUAGE" | "DISCRIMINATION" | "OTHER";
+        content: string;
+        reports: unknown[];
+        related: {
+            id: number;
+            createdAt: string;
+            updatedAt: string;
+            content: string;
+            blocked: boolean | null;
+            blockedThread: boolean | null;
+            blockReason: string | null;
+            isAdminComment: boolean | null;
+            removed: boolean | null;
+            approvalStatus: "PENDING" | "APPROVED" | "REJECTED" | "BLOCKED" | "OPEN" | "REMOVED" | "TO_REVIEW" | "UNKNOWN" | null;
+            author: {
+                email: string;
+                id: string | number;
+                name: string;
+                avatar: {
+                    url: string | null;
+                    formats: {
+                        thumbnail: {
+                            url: string;
+                        } | null;
+                    };
+                } | {
+                    email: string;
+                    url: string | null;
+                    id: string;
+                    name: string;
+                    avatar: string | null;
+                } | null;
+            };
+            reports?: {
+                resolved: boolean;
+                id: number;
+                createdAt: string;
+                updatedAt: string | null;
+                reason: "BAD_LANGUAGE" | "DISCRIMINATION" | "OTHER";
+                content: string;
+            }[] | null | undefined;
+            gotThread?: boolean | null | undefined;
+            threadFirstItemId?: number | null | undefined;
+        };
+        resolved?: boolean | undefined;
+        approvalStatus?: "PENDING" | "APPROVED" | "REJECTED" | "BLOCKED" | "OPEN" | "REMOVED" | "TO_REVIEW" | "UNKNOWN" | null | undefined;
+        author?: unknown;
+    }[];
+}, Error>;

package/dist/admin/src/hooks/useResizeObserver.d.ts

@@ -0,0 +1,2 @@
+import { MutableRefObject } from 'react';
+export declare const useResizeObserver: (sources: MutableRefObject<HTMLElement | null>, onResize: ResizeObserver['observe']) => void;