@elytracms/core 0.0.6

package/dist/operations/documents.d.ts

@@ -0,0 +1,432 @@
+import { z } from 'zod';
+import type { OperationsRuntime } from './core';
+export declare const upsertDocumentInputSchema: z.ZodObject<{
+    projectId: z.ZodString;
+    document: z.ZodObject<{
+        collection: z.ZodString;
+        id: z.ZodString;
+        values: z.ZodDefault<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+        localized: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodRecord<z.ZodString, z.ZodUnknown>>>;
+        defaultLocale: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>;
+}, z.core.$strip>;
+export declare const documentRefInputSchema: z.ZodObject<{
+    projectId: z.ZodString;
+    ref: z.ZodObject<{
+        collection: z.ZodString;
+        id: z.ZodString;
+    }, z.core.$strip>;
+}, z.core.$strip>;
+export declare const listDocumentsInputSchema: z.ZodObject<{
+    projectId: z.ZodString;
+    collection: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+export declare const snapshotDocumentInputSchema: z.ZodObject<{
+    projectId: z.ZodString;
+    ref: z.ZodObject<{
+        collection: z.ZodString;
+        id: z.ZodString;
+    }, z.core.$strip>;
+    label: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+export declare const restoreDocumentInputSchema: z.ZodObject<{
+    projectId: z.ZodString;
+    ref: z.ZodObject<{
+        collection: z.ZodString;
+        id: z.ZodString;
+    }, z.core.$strip>;
+    version: z.ZodNumber;
+}, z.core.$strip>;
+export declare const pinVersionInputSchema: z.ZodObject<{
+    projectId: z.ZodString;
+    ref: z.ZodObject<{
+        collection: z.ZodString;
+        id: z.ZodString;
+    }, z.core.$strip>;
+    version: z.ZodNumber;
+}, z.core.$strip>;
+export declare const documentOperationDefinitions: {
+    readonly upsert: import("./core").OperationDefinition<z.ZodObject<{
+        projectId: z.ZodString;
+        document: z.ZodObject<{
+            collection: z.ZodString;
+            id: z.ZodString;
+            values: z.ZodDefault<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+            localized: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodRecord<z.ZodString, z.ZodUnknown>>>;
+            defaultLocale: z.ZodOptional<z.ZodString>;
+        }, z.core.$strip>;
+    }, z.core.$strip>, {
+        createdAt: string;
+        updatedAt: string;
+        projectId: string;
+        document: {
+            collection: string;
+            id: string;
+            values: Record<string, unknown>;
+            localized?: Record<string, Record<string, unknown>> | undefined;
+            defaultLocale?: string | undefined;
+        };
+        publishedVersion?: number | undefined;
+    }>;
+    readonly delete: import("./core").OperationDefinition<z.ZodObject<{
+        projectId: z.ZodString;
+        ref: z.ZodObject<{
+            collection: z.ZodString;
+            id: z.ZodString;
+        }, z.core.$strip>;
+    }, z.core.$strip>, {
+        ref: {
+            collection: string;
+            id: string;
+        };
+    }>;
+    readonly get: import("./core").OperationDefinition<z.ZodObject<{
+        projectId: z.ZodString;
+        ref: z.ZodObject<{
+            collection: z.ZodString;
+            id: z.ZodString;
+        }, z.core.$strip>;
+    }, z.core.$strip>, {
+        createdAt: string;
+        updatedAt: string;
+        projectId: string;
+        document: {
+            collection: string;
+            id: string;
+            values: Record<string, unknown>;
+            localized?: Record<string, Record<string, unknown>> | undefined;
+            defaultLocale?: string | undefined;
+        };
+        publishedVersion?: number | undefined;
+    }>;
+    readonly list: import("./core").OperationDefinition<z.ZodObject<{
+        projectId: z.ZodString;
+        collection: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>, {
+        createdAt: string;
+        updatedAt: string;
+        projectId: string;
+        document: {
+            collection: string;
+            id: string;
+            values: Record<string, unknown>;
+            localized?: Record<string, Record<string, unknown>> | undefined;
+            defaultLocale?: string | undefined;
+        };
+        publishedVersion?: number | undefined;
+    }[]>;
+    readonly snapshot: import("./core").OperationDefinition<z.ZodObject<{
+        projectId: z.ZodString;
+        ref: z.ZodObject<{
+            collection: z.ZodString;
+            id: z.ZodString;
+        }, z.core.$strip>;
+        label: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>, {
+        projectId: string;
+        collection: string;
+        docId: string;
+        version: number;
+        snapshot: {
+            collection: string;
+            id: string;
+            values: Record<string, unknown>;
+            localized?: Record<string, Record<string, unknown>> | undefined;
+            defaultLocale?: string | undefined;
+        };
+        createdAt: string;
+        label?: string | undefined;
+    }>;
+    readonly listVersions: import("./core").OperationDefinition<z.ZodObject<{
+        projectId: z.ZodString;
+        ref: z.ZodObject<{
+            collection: z.ZodString;
+            id: z.ZodString;
+        }, z.core.$strip>;
+    }, z.core.$strip>, {
+        projectId: string;
+        collection: string;
+        docId: string;
+        version: number;
+        snapshot: {
+            collection: string;
+            id: string;
+            values: Record<string, unknown>;
+            localized?: Record<string, Record<string, unknown>> | undefined;
+            defaultLocale?: string | undefined;
+        };
+        createdAt: string;
+        label?: string | undefined;
+    }[]>;
+    readonly restore: import("./core").OperationDefinition<z.ZodObject<{
+        projectId: z.ZodString;
+        ref: z.ZodObject<{
+            collection: z.ZodString;
+            id: z.ZodString;
+        }, z.core.$strip>;
+        version: z.ZodNumber;
+    }, z.core.$strip>, {
+        createdAt: string;
+        updatedAt: string;
+        projectId: string;
+        document: {
+            collection: string;
+            id: string;
+            values: Record<string, unknown>;
+            localized?: Record<string, Record<string, unknown>> | undefined;
+            defaultLocale?: string | undefined;
+        };
+        publishedVersion?: number | undefined;
+    }>;
+    readonly publish: import("./core").OperationDefinition<z.ZodObject<{
+        projectId: z.ZodString;
+        ref: z.ZodObject<{
+            collection: z.ZodString;
+            id: z.ZodString;
+        }, z.core.$strip>;
+    }, z.core.$strip>, {
+        createdAt: string;
+        updatedAt: string;
+        projectId: string;
+        document: {
+            collection: string;
+            id: string;
+            values: Record<string, unknown>;
+            localized?: Record<string, Record<string, unknown>> | undefined;
+            defaultLocale?: string | undefined;
+        };
+        publishedVersion?: number | undefined;
+    }>;
+    readonly unpublish: import("./core").OperationDefinition<z.ZodObject<{
+        projectId: z.ZodString;
+        ref: z.ZodObject<{
+            collection: z.ZodString;
+            id: z.ZodString;
+        }, z.core.$strip>;
+    }, z.core.$strip>, {
+        createdAt: string;
+        updatedAt: string;
+        projectId: string;
+        document: {
+            collection: string;
+            id: string;
+            values: Record<string, unknown>;
+            localized?: Record<string, Record<string, unknown>> | undefined;
+            defaultLocale?: string | undefined;
+        };
+        publishedVersion?: number | undefined;
+    }>;
+    readonly pinVersion: import("./core").OperationDefinition<z.ZodObject<{
+        projectId: z.ZodString;
+        ref: z.ZodObject<{
+            collection: z.ZodString;
+            id: z.ZodString;
+        }, z.core.$strip>;
+        version: z.ZodNumber;
+    }, z.core.$strip>, {
+        createdAt: string;
+        updatedAt: string;
+        projectId: string;
+        document: {
+            collection: string;
+            id: string;
+            values: Record<string, unknown>;
+            localized?: Record<string, Record<string, unknown>> | undefined;
+            defaultLocale?: string | undefined;
+        };
+        publishedVersion?: number | undefined;
+    }>;
+};
+export declare function createDocumentOperations(runtime: OperationsRuntime): {
+    upsert: (input: {
+        projectId: string;
+        document: {
+            collection: string;
+            id: string;
+            values?: Record<string, unknown> | undefined;
+            localized?: Record<string, Record<string, unknown>> | undefined;
+            defaultLocale?: string | undefined;
+        };
+    }) => Promise<import("./core").OperationResult<{
+        createdAt: string;
+        updatedAt: string;
+        projectId: string;
+        document: {
+            collection: string;
+            id: string;
+            values: Record<string, unknown>;
+            localized?: Record<string, Record<string, unknown>> | undefined;
+            defaultLocale?: string | undefined;
+        };
+        publishedVersion?: number | undefined;
+    }>>;
+    delete: (input: {
+        projectId: string;
+        ref: {
+            collection: string;
+            id: string;
+        };
+    }) => Promise<import("./core").OperationResult<{
+        ref: {
+            collection: string;
+            id: string;
+        };
+    }>>;
+    get: (input: {
+        projectId: string;
+        ref: {
+            collection: string;
+            id: string;
+        };
+    }) => Promise<import("./core").OperationResult<{
+        createdAt: string;
+        updatedAt: string;
+        projectId: string;
+        document: {
+            collection: string;
+            id: string;
+            values: Record<string, unknown>;
+            localized?: Record<string, Record<string, unknown>> | undefined;
+            defaultLocale?: string | undefined;
+        };
+        publishedVersion?: number | undefined;
+    }>>;
+    list: (input: {
+        projectId: string;
+        collection?: string | undefined;
+    }) => Promise<import("./core").OperationResult<{
+        createdAt: string;
+        updatedAt: string;
+        projectId: string;
+        document: {
+            collection: string;
+            id: string;
+            values: Record<string, unknown>;
+            localized?: Record<string, Record<string, unknown>> | undefined;
+            defaultLocale?: string | undefined;
+        };
+        publishedVersion?: number | undefined;
+    }[]>>;
+    snapshot: (input: {
+        projectId: string;
+        ref: {
+            collection: string;
+            id: string;
+        };
+        label?: string | undefined;
+    }) => Promise<import("./core").OperationResult<{
+        projectId: string;
+        collection: string;
+        docId: string;
+        version: number;
+        snapshot: {
+            collection: string;
+            id: string;
+            values: Record<string, unknown>;
+            localized?: Record<string, Record<string, unknown>> | undefined;
+            defaultLocale?: string | undefined;
+        };
+        createdAt: string;
+        label?: string | undefined;
+    }>>;
+    listVersions: (input: {
+        projectId: string;
+        ref: {
+            collection: string;
+            id: string;
+        };
+    }) => Promise<import("./core").OperationResult<{
+        projectId: string;
+        collection: string;
+        docId: string;
+        version: number;
+        snapshot: {
+            collection: string;
+            id: string;
+            values: Record<string, unknown>;
+            localized?: Record<string, Record<string, unknown>> | undefined;
+            defaultLocale?: string | undefined;
+        };
+        createdAt: string;
+        label?: string | undefined;
+    }[]>>;
+    restore: (input: {
+        projectId: string;
+        ref: {
+            collection: string;
+            id: string;
+        };
+        version: number;
+    }) => Promise<import("./core").OperationResult<{
+        createdAt: string;
+        updatedAt: string;
+        projectId: string;
+        document: {
+            collection: string;
+            id: string;
+            values: Record<string, unknown>;
+            localized?: Record<string, Record<string, unknown>> | undefined;
+            defaultLocale?: string | undefined;
+        };
+        publishedVersion?: number | undefined;
+    }>>;
+    publish: (input: {
+        projectId: string;
+        ref: {
+            collection: string;
+            id: string;
+        };
+    }) => Promise<import("./core").OperationResult<{
+        createdAt: string;
+        updatedAt: string;
+        projectId: string;
+        document: {
+            collection: string;
+            id: string;
+            values: Record<string, unknown>;
+            localized?: Record<string, Record<string, unknown>> | undefined;
+            defaultLocale?: string | undefined;
+        };
+        publishedVersion?: number | undefined;
+    }>>;
+    unpublish: (input: {
+        projectId: string;
+        ref: {
+            collection: string;
+            id: string;
+        };
+    }) => Promise<import("./core").OperationResult<{
+        createdAt: string;
+        updatedAt: string;
+        projectId: string;
+        document: {
+            collection: string;
+            id: string;
+            values: Record<string, unknown>;
+            localized?: Record<string, Record<string, unknown>> | undefined;
+            defaultLocale?: string | undefined;
+        };
+        publishedVersion?: number | undefined;
+    }>>;
+    pinVersion: (input: {
+        projectId: string;
+        ref: {
+            collection: string;
+            id: string;
+        };
+        version: number;
+    }) => Promise<import("./core").OperationResult<{
+        createdAt: string;
+        updatedAt: string;
+        projectId: string;
+        document: {
+            collection: string;
+            id: string;
+            values: Record<string, unknown>;
+            localized?: Record<string, Record<string, unknown>> | undefined;
+            defaultLocale?: string | undefined;
+        };
+        publishedVersion?: number | undefined;
+    }>>;
+};
+export type DocumentOperations = ReturnType<typeof createDocumentOperations>;