les-revisions 1.0.0

package/dist/server/src/bootstrap.d.ts

@@ -0,0 +1,5 @@
+import type { Core } from '@strapi/strapi';
+declare const bootstrap: ({ strapi }: {
+    strapi: Core.Strapi;
+}) => void;
+export default bootstrap;

package/dist/server/src/config/index.d.ts

@@ -0,0 +1,12 @@
+declare const _default: {
+    default: {
+        maxVersions: number;
+        enabledContentTypes: string[] | "*";
+        excludeContentTypes: string[];
+        softDelete: boolean;
+        excludeFields: string[];
+        populateDepth: number;
+    };
+    validator(config: any): void;
+};
+export default _default;

package/dist/server/src/content-types/index.d.ts

@@ -0,0 +1,76 @@
+declare const _default: {
+    revision: {
+        schema: {
+            kind: string;
+            collectionName: string;
+            info: {
+                singularName: string;
+                pluralName: string;
+                displayName: string;
+                description: string;
+            };
+            options: {
+                draftAndPublish: boolean;
+            };
+            pluginOptions: {
+                "content-manager": {
+                    visible: boolean;
+                };
+                "content-type-builder": {
+                    visible: boolean;
+                };
+            };
+            attributes: {
+                contentType: {
+                    type: string;
+                    required: boolean;
+                    configurable: boolean;
+                };
+                entryDocumentId: {
+                    type: string;
+                    required: boolean;
+                    configurable: boolean;
+                };
+                version: {
+                    type: string;
+                    required: boolean;
+                    configurable: boolean;
+                    default: number;
+                };
+                snapshot: {
+                    type: string;
+                    required: boolean;
+                    configurable: boolean;
+                };
+                changeType: {
+                    type: string;
+                    enum: string[];
+                    required: boolean;
+                    configurable: boolean;
+                };
+                changedByName: {
+                    type: string;
+                    configurable: boolean;
+                };
+                changedByEmail: {
+                    type: string;
+                    configurable: boolean;
+                };
+                changedById: {
+                    type: string;
+                    configurable: boolean;
+                };
+                isDeleted: {
+                    type: string;
+                    default: boolean;
+                    configurable: boolean;
+                };
+                metadata: {
+                    type: string;
+                    configurable: boolean;
+                };
+            };
+        };
+    };
+};
+export default _default;

package/dist/server/src/content-types/revision/index.d.ts

@@ -0,0 +1,74 @@
+declare const _default: {
+    schema: {
+        kind: string;
+        collectionName: string;
+        info: {
+            singularName: string;
+            pluralName: string;
+            displayName: string;
+            description: string;
+        };
+        options: {
+            draftAndPublish: boolean;
+        };
+        pluginOptions: {
+            "content-manager": {
+                visible: boolean;
+            };
+            "content-type-builder": {
+                visible: boolean;
+            };
+        };
+        attributes: {
+            contentType: {
+                type: string;
+                required: boolean;
+                configurable: boolean;
+            };
+            entryDocumentId: {
+                type: string;
+                required: boolean;
+                configurable: boolean;
+            };
+            version: {
+                type: string;
+                required: boolean;
+                configurable: boolean;
+                default: number;
+            };
+            snapshot: {
+                type: string;
+                required: boolean;
+                configurable: boolean;
+            };
+            changeType: {
+                type: string;
+                enum: string[];
+                required: boolean;
+                configurable: boolean;
+            };
+            changedByName: {
+                type: string;
+                configurable: boolean;
+            };
+            changedByEmail: {
+                type: string;
+                configurable: boolean;
+            };
+            changedById: {
+                type: string;
+                configurable: boolean;
+            };
+            isDeleted: {
+                type: string;
+                default: boolean;
+                configurable: boolean;
+            };
+            metadata: {
+                type: string;
+                configurable: boolean;
+            };
+        };
+    };
+};
+export default _default;

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

@@ -0,0 +1,15 @@
+declare const _default: {
+    revision: ({ strapi }: {
+        strapi: import("@strapi/types/dist/core").Strapi;
+    }) => {
+        find(ctx: any): Promise<any>;
+        findOne(ctx: any): Promise<any>;
+        restore(ctx: any): Promise<any>;
+        delete(ctx: any): Promise<any>;
+        compare(ctx: any): Promise<any>;
+        getContentTypes(ctx: any): Promise<any>;
+        getEntries(ctx: any): Promise<any>;
+        getConfig(ctx: any): Promise<void>;
+    };
+};
+export default _default;

package/dist/server/src/controllers/revision.d.ts

@@ -0,0 +1,41 @@
+import type { Core } from '@strapi/strapi';
+declare const revisionController: ({ strapi }: {
+    strapi: Core.Strapi;
+}) => {
+    /**
+     * GET /revisions
+     * Query: contentType, documentId, page?, pageSize?, includeDeleted?
+     */
+    find(ctx: any): Promise<any>;
+    /**
+     * GET /revisions/:documentId
+     */
+    findOne(ctx: any): Promise<any>;
+    /**
+     * POST /revisions/:documentId/restore
+     */
+    restore(ctx: any): Promise<any>;
+    /**
+     * DELETE /revisions/:documentId
+     */
+    delete(ctx: any): Promise<any>;
+    /**
+     * GET /revisions/compare
+     * Query: rev1, rev2
+     */
+    compare(ctx: any): Promise<any>;
+    /**
+     * GET /content-types
+     */
+    getContentTypes(ctx: any): Promise<any>;
+    /**
+     * GET /entries
+     * Query: contentType, page?, pageSize?
+     */
+    getEntries(ctx: any): Promise<any>;
+    /**
+     * GET /config
+     */
+    getConfig(ctx: any): Promise<void>;
+};
+export default revisionController;

package/dist/server/src/destroy.d.ts

@@ -0,0 +1,5 @@
+import type { Core } from '@strapi/strapi';
+declare const destroy: ({ strapi }: {
+    strapi: Core.Strapi;
+}) => void;
+export default destroy;

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

@@ -0,0 +1,189 @@
+declare const _default: {
+    register: ({ strapi }: {
+        strapi: import("@strapi/types/dist/core").Strapi;
+    }) => void;
+    bootstrap: ({ strapi }: {
+        strapi: import("@strapi/types/dist/core").Strapi;
+    }) => void;
+    destroy: ({ strapi }: {
+        strapi: import("@strapi/types/dist/core").Strapi;
+    }) => void;
+    config: {
+        default: {
+            maxVersions: number;
+            enabledContentTypes: string[] | "*";
+            excludeContentTypes: string[];
+            softDelete: boolean;
+            excludeFields: string[];
+            populateDepth: number;
+        };
+        validator(config: any): void;
+    };
+    controllers: {
+        revision: ({ strapi }: {
+            strapi: import("@strapi/types/dist/core").Strapi;
+        }) => {
+            find(ctx: any): Promise<any>;
+            findOne(ctx: any): Promise<any>;
+            restore(ctx: any): Promise<any>;
+            delete(ctx: any): Promise<any>;
+            compare(ctx: any): Promise<any>;
+            getContentTypes(ctx: any): Promise<any>;
+            getEntries(ctx: any): Promise<any>;
+            getConfig(ctx: any): Promise<void>;
+        };
+    };
+    routes: {
+        'content-api': () => {
+            type: string;
+            routes: any[];
+        };
+        admin: () => {
+            type: string;
+            routes: {
+                method: string;
+                path: string;
+                handler: string;
+                config: {
+                    policies: any[];
+                };
+            }[];
+        };
+    };
+    services: {
+        revision: ({ strapi }: {
+            strapi: import("@strapi/types/dist/core").Strapi;
+        }) => {
+            getConfig(): import("./services/revision").PluginConfig;
+            isEnabled(contentTypeUID: string): boolean;
+            getPopulate(contentTypeUID: string): true | Record<string, any>;
+            createRevision({ contentType, documentId, snapshot, changeType, userId }: import("./services/revision").RevisionInput): Promise<import("@strapi/types/dist/modules/documents").AnyDocument>;
+            findRevisions(contentType: string, documentId: string, params?: import("./services/revision").RevisionQueryParams): Promise<{
+                results: import("@strapi/types/dist/modules/documents").AnyDocument[];
+                pagination: {
+                    page: number;
+                    pageSize: number;
+                    pageCount: number;
+                    total: number;
+                };
+            }>;
+            findOne(revisionDocumentId: string): Promise<import("@strapi/types/dist/modules/documents").AnyDocument>;
+            restore(revisionDocumentId: string): Promise<import("@strapi/types/dist/modules/documents").AnyDocument>;
+            deleteRevision(revisionDocumentId: string): Promise<import("@strapi/types/dist/modules/documents").AnyDocument | {
+                documentId: import("@strapi/types/dist/modules/documents").ID;
+                entries: import("@strapi/types/dist/modules/documents").Result<TContentTypeUID, TParams>[];
+            }>;
+            compareRevisions(docId1: string, docId2: string): Promise<{
+                revision1: {
+                    documentId: string;
+                    id: number;
+                } & {
+                    [key: string]: any;
+                };
+                revision2: {
+                    documentId: string;
+                    id: number;
+                } & {
+                    [key: string]: any;
+                };
+                diff: {
+                    path: string;
+                    type: "added" | "removed" | "changed";
+                    oldValue?: any;
+                    newValue?: any;
+                }[];
+            }>;
+            pruneRevisions(contentType: string, documentId: string): Promise<void>;
+            getContentTypesWithRevisions(): Promise<any[]>;
+            getEntriesWithRevisions(contentType: string, params?: import("./services/revision").PaginationParams): Promise<{
+                results: any[];
+                pagination: {
+                    page: number;
+                    pageSize: number;
+                    pageCount: number;
+                    total: number;
+                };
+            }>;
+            deleteAllRevisionsForEntry(contentType: string, documentId: string): Promise<void>;
+            _filtersToWhere(filters: Record<string, any>): Record<string, any>;
+        };
+    };
+    contentTypes: {
+        revision: {
+            schema: {
+                kind: string;
+                collectionName: string;
+                info: {
+                    singularName: string;
+                    pluralName: string;
+                    displayName: string;
+                    description: string;
+                };
+                options: {
+                    draftAndPublish: boolean;
+                };
+                pluginOptions: {
+                    "content-manager": {
+                        visible: boolean;
+                    };
+                    "content-type-builder": {
+                        visible: boolean;
+                    };
+                };
+                attributes: {
+                    contentType: {
+                        type: string;
+                        required: boolean;
+                        configurable: boolean;
+                    };
+                    entryDocumentId: {
+                        type: string;
+                        required: boolean;
+                        configurable: boolean;
+                    };
+                    version: {
+                        type: string;
+                        required: boolean;
+                        configurable: boolean;
+                        default: number;
+                    };
+                    snapshot: {
+                        type: string;
+                        required: boolean;
+                        configurable: boolean;
+                    };
+                    changeType: {
+                        type: string;
+                        enum: string[];
+                        required: boolean;
+                        configurable: boolean;
+                    };
+                    changedByName: {
+                        type: string;
+                        configurable: boolean;
+                    };
+                    changedByEmail: {
+                        type: string;
+                        configurable: boolean;
+                    };
+                    changedById: {
+                        type: string;
+                        configurable: boolean;
+                    };
+                    isDeleted: {
+                        type: string;
+                        default: boolean;
+                        configurable: boolean;
+                    };
+                    metadata: {
+                        type: string;
+                        configurable: boolean;
+                    };
+                };
+            };
+        };
+    };
+    policies: {};
+    middlewares: {};
+};
+export default _default;

package/dist/server/src/middlewares/index.d.ts

@@ -0,0 +1,2 @@
+declare const _default: {};
+export default _default;

package/dist/server/src/policies/index.d.ts

@@ -0,0 +1,2 @@
+declare const _default: {};
+export default _default;

package/dist/server/src/register.d.ts

@@ -0,0 +1,5 @@
+import type { Core } from '@strapi/strapi';
+declare const register: ({ strapi }: {
+    strapi: Core.Strapi;
+}) => void;
+export default register;

package/dist/server/src/routes/admin/index.d.ts

@@ -0,0 +1,12 @@
+declare const _default: () => {
+    type: string;
+    routes: {
+        method: string;
+        path: string;
+        handler: string;
+        config: {
+            policies: any[];
+        };
+    }[];
+};
+export default _default;

package/dist/server/src/routes/content-api/index.d.ts

@@ -0,0 +1,5 @@
+declare const _default: () => {
+    type: string;
+    routes: any[];
+};
+export default _default;

package/dist/server/src/routes/index.d.ts

@@ -0,0 +1,18 @@
+declare const routes: {
+    'content-api': () => {
+        type: string;
+        routes: any[];
+    };
+    admin: () => {
+        type: string;
+        routes: {
+            method: string;
+            path: string;
+            handler: string;
+            config: {
+                policies: any[];
+            };
+        }[];
+    };
+};
+export default routes;

package/dist/server/src/services/index.d.ts

@@ -0,0 +1,59 @@
+declare const _default: {
+    revision: ({ strapi }: {
+        strapi: import("@strapi/types/dist/core").Strapi;
+    }) => {
+        getConfig(): import("./revision").PluginConfig;
+        isEnabled(contentTypeUID: string): boolean;
+        getPopulate(contentTypeUID: string): true | Record<string, any>;
+        createRevision({ contentType, documentId, snapshot, changeType, userId }: import("./revision").RevisionInput): Promise<import("@strapi/types/dist/modules/documents").AnyDocument>;
+        findRevisions(contentType: string, documentId: string, params?: import("./revision").RevisionQueryParams): Promise<{
+            results: import("@strapi/types/dist/modules/documents").AnyDocument[];
+            pagination: {
+                page: number;
+                pageSize: number;
+                pageCount: number;
+                total: number;
+            };
+        }>;
+        findOne(revisionDocumentId: string): Promise<import("@strapi/types/dist/modules/documents").AnyDocument>;
+        restore(revisionDocumentId: string): Promise<import("@strapi/types/dist/modules/documents").AnyDocument>;
+        deleteRevision(revisionDocumentId: string): Promise<import("@strapi/types/dist/modules/documents").AnyDocument | {
+            documentId: import("@strapi/types/dist/modules/documents").ID;
+            entries: import("@strapi/types/dist/modules/documents").Result<TContentTypeUID, TParams>[];
+        }>;
+        compareRevisions(docId1: string, docId2: string): Promise<{
+            revision1: {
+                documentId: string;
+                id: number;
+            } & {
+                [key: string]: any;
+            };
+            revision2: {
+                documentId: string;
+                id: number;
+            } & {
+                [key: string]: any;
+            };
+            diff: {
+                path: string;
+                type: "added" | "removed" | "changed";
+                oldValue?: any;
+                newValue?: any;
+            }[];
+        }>;
+        pruneRevisions(contentType: string, documentId: string): Promise<void>;
+        getContentTypesWithRevisions(): Promise<any[]>;
+        getEntriesWithRevisions(contentType: string, params?: import("./revision").PaginationParams): Promise<{
+            results: any[];
+            pagination: {
+                page: number;
+                pageSize: number;
+                pageCount: number;
+                total: number;
+            };
+        }>;
+        deleteAllRevisionsForEntry(contentType: string, documentId: string): Promise<void>;
+        _filtersToWhere(filters: Record<string, any>): Record<string, any>;
+    };
+};
+export default _default;

package/dist/server/src/services/revision.d.ts

@@ -0,0 +1,84 @@
+import type { Core } from '@strapi/strapi';
+export interface RevisionInput {
+    contentType: string;
+    documentId: string;
+    snapshot: Record<string, any>;
+    changeType: 'create' | 'update' | 'delete';
+    userId?: number | null;
+}
+export interface PaginationParams {
+    page?: number;
+    pageSize?: number;
+}
+export interface RevisionQueryParams extends PaginationParams {
+    includeDeleted?: boolean;
+}
+export interface PluginConfig {
+    maxVersions: number;
+    enabledContentTypes: string[] | '*';
+    excludeContentTypes: string[];
+    softDelete: boolean;
+    excludeFields: string[];
+    populateDepth: number;
+}
+declare const revisionService: ({ strapi }: {
+    strapi: Core.Strapi;
+}) => {
+    getConfig(): PluginConfig;
+    isEnabled(contentTypeUID: string): boolean;
+    getPopulate(contentTypeUID: string): true | Record<string, any>;
+    createRevision({ contentType, documentId, snapshot, changeType, userId }: RevisionInput): Promise<import("@strapi/types/dist/modules/documents").AnyDocument>;
+    findRevisions(contentType: string, documentId: string, params?: RevisionQueryParams): Promise<{
+        results: import("@strapi/types/dist/modules/documents").AnyDocument[];
+        pagination: {
+            page: number;
+            pageSize: number;
+            pageCount: number;
+            total: number;
+        };
+    }>;
+    findOne(revisionDocumentId: string): Promise<import("@strapi/types/dist/modules/documents").AnyDocument>;
+    restore(revisionDocumentId: string): Promise<import("@strapi/types/dist/modules/documents").AnyDocument>;
+    deleteRevision(revisionDocumentId: string): Promise<import("@strapi/types/dist/modules/documents").AnyDocument | {
+        documentId: import("@strapi/types/dist/modules/documents").ID;
+        entries: import("@strapi/types/dist/modules/documents").Result<TContentTypeUID, TParams>[];
+    }>;
+    compareRevisions(docId1: string, docId2: string): Promise<{
+        revision1: {
+            documentId: string;
+            id: number;
+        } & {
+            [key: string]: any;
+        };
+        revision2: {
+            documentId: string;
+            id: number;
+        } & {
+            [key: string]: any;
+        };
+        diff: {
+            path: string;
+            type: "added" | "removed" | "changed";
+            oldValue?: any;
+            newValue?: any;
+        }[];
+    }>;
+    pruneRevisions(contentType: string, documentId: string): Promise<void>;
+    getContentTypesWithRevisions(): Promise<any[]>;
+    getEntriesWithRevisions(contentType: string, params?: PaginationParams): Promise<{
+        results: any[];
+        pagination: {
+            page: number;
+            pageSize: number;
+            pageCount: number;
+            total: number;
+        };
+    }>;
+    /**
+     * Soft-delete all revisions for an entry (called on entry hard-delete).
+     */
+    deleteAllRevisionsForEntry(contentType: string, documentId: string): Promise<void>;
+    /** Convert Document Service filters to query-engine where clause */
+    _filtersToWhere(filters: Record<string, any>): Record<string, any>;
+};
+export default revisionService;