@objectstack/spec 0.6.1 → 0.7.2

package/dist/data/document.zod.d.ts

@@ -0,0 +1,746 @@
+import { z } from 'zod';
+/**
+ * Document Version Schema
+ *
+ * Represents a single version of a document in a version-controlled system.
+ * Each version is immutable and maintains its own metadata and download URL.
+ *
+ * @example
+ * ```json
+ * {
+ *   "versionNumber": 2,
+ *   "createdAt": 1704067200000,
+ *   "createdBy": "user_123",
+ *   "size": 2048576,
+ *   "checksum": "a1b2c3d4e5f6",
+ *   "downloadUrl": "https://storage.example.com/docs/v2/file.pdf",
+ *   "isLatest": true
+ * }
+ * ```
+ */
+export declare const DocumentVersionSchema: z.ZodObject<{
+    /**
+     * Sequential version number (increments with each new version)
+     */
+    versionNumber: z.ZodNumber;
+    /**
+     * Timestamp when this version was created (Unix milliseconds)
+     */
+    createdAt: z.ZodNumber;
+    /**
+     * User ID who created this version
+     */
+    createdBy: z.ZodString;
+    /**
+     * File size in bytes
+     */
+    size: z.ZodNumber;
+    /**
+     * Checksum/hash of the file content (for integrity verification)
+     */
+    checksum: z.ZodString;
+    /**
+     * URL to download this specific version
+     */
+    downloadUrl: z.ZodString;
+    /**
+     * Whether this is the latest version
+     * @default false
+     */
+    isLatest: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
+}, "strip", z.ZodTypeAny, {
+    versionNumber: number;
+    createdAt: number;
+    createdBy: string;
+    size: number;
+    checksum: string;
+    downloadUrl: string;
+    isLatest: boolean;
+}, {
+    versionNumber: number;
+    createdAt: number;
+    createdBy: string;
+    size: number;
+    checksum: string;
+    downloadUrl: string;
+    isLatest?: boolean | undefined;
+}>;
+/**
+ * Document Template Schema
+ *
+ * Defines a reusable document template with dynamic placeholders.
+ * Templates can be used to generate documents with variable content.
+ *
+ * @example
+ * ```json
+ * {
+ *   "id": "contract-template",
+ *   "name": "Service Agreement",
+ *   "description": "Standard service agreement template",
+ *   "fileUrl": "https://example.com/templates/contract.docx",
+ *   "fileType": "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
+ *   "placeholders": [
+ *     {
+ *       "key": "client_name",
+ *       "label": "Client Name",
+ *       "type": "text",
+ *       "required": true
+ *     },
+ *     {
+ *       "key": "contract_date",
+ *       "label": "Contract Date",
+ *       "type": "date",
+ *       "required": true
+ *     }
+ *   ]
+ * }
+ * ```
+ */
+export declare const DocumentTemplateSchema: z.ZodObject<{
+    /**
+     * Unique identifier for the template
+     */
+    id: z.ZodString;
+    /**
+     * Human-readable name of the template
+     */
+    name: z.ZodString;
+    /**
+     * Optional description of the template's purpose
+     */
+    description: z.ZodOptional<z.ZodString>;
+    /**
+     * URL to the template file
+     */
+    fileUrl: z.ZodString;
+    /**
+     * MIME type of the template file
+     */
+    fileType: z.ZodString;
+    /**
+     * List of dynamic placeholders in the template
+     */
+    placeholders: z.ZodArray<z.ZodObject<{
+        /**
+         * Placeholder identifier (used in template)
+         */
+        key: z.ZodString;
+        /**
+         * Human-readable label for the placeholder
+         */
+        label: z.ZodString;
+        /**
+         * Data type of the placeholder value
+         */
+        type: z.ZodEnum<["text", "number", "date", "image"]>;
+        /**
+         * Whether this placeholder must be filled
+         * @default false
+         */
+        required: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
+    }, "strip", z.ZodTypeAny, {
+        type: "number" | "date" | "text" | "image";
+        required: boolean;
+        label: string;
+        key: string;
+    }, {
+        type: "number" | "date" | "text" | "image";
+        label: string;
+        key: string;
+        required?: boolean | undefined;
+    }>, "many">;
+}, "strip", z.ZodTypeAny, {
+    name: string;
+    id: string;
+    fileUrl: string;
+    fileType: string;
+    placeholders: {
+        type: "number" | "date" | "text" | "image";
+        required: boolean;
+        label: string;
+        key: string;
+    }[];
+    description?: string | undefined;
+}, {
+    name: string;
+    id: string;
+    fileUrl: string;
+    fileType: string;
+    placeholders: {
+        type: "number" | "date" | "text" | "image";
+        label: string;
+        key: string;
+        required?: boolean | undefined;
+    }[];
+    description?: string | undefined;
+}>;
+/**
+ * E-Signature Configuration Schema
+ *
+ * Configuration for electronic signature workflows.
+ * Supports integration with popular e-signature providers.
+ *
+ * @example
+ * ```json
+ * {
+ *   "provider": "docusign",
+ *   "enabled": true,
+ *   "signers": [
+ *     {
+ *       "email": "client@example.com",
+ *       "name": "John Doe",
+ *       "role": "Client",
+ *       "order": 1
+ *     },
+ *     {
+ *       "email": "manager@example.com",
+ *       "name": "Jane Smith",
+ *       "role": "Manager",
+ *       "order": 2
+ *     }
+ *   ],
+ *   "expirationDays": 30,
+ *   "reminderDays": 7
+ * }
+ * ```
+ */
+export declare const ESignatureConfigSchema: z.ZodObject<{
+    /**
+     * E-signature service provider
+     */
+    provider: z.ZodEnum<["docusign", "adobe-sign", "hellosign", "custom"]>;
+    /**
+     * Whether e-signature is enabled for this document
+     * @default false
+     */
+    enabled: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
+    /**
+     * List of signers in signing order
+     */
+    signers: z.ZodArray<z.ZodObject<{
+        /**
+         * Signer's email address
+         */
+        email: z.ZodString;
+        /**
+         * Signer's full name
+         */
+        name: z.ZodString;
+        /**
+         * Signer's role in the document
+         */
+        role: z.ZodString;
+        /**
+         * Signing order (lower numbers sign first)
+         */
+        order: z.ZodNumber;
+    }, "strip", z.ZodTypeAny, {
+        order: number;
+        email: string;
+        name: string;
+        role: string;
+    }, {
+        order: number;
+        email: string;
+        name: string;
+        role: string;
+    }>, "many">;
+    /**
+     * Days until signature request expires
+     * @default 30
+     */
+    expirationDays: z.ZodDefault<z.ZodOptional<z.ZodNumber>>;
+    /**
+     * Days between reminder emails
+     * @default 7
+     */
+    reminderDays: z.ZodDefault<z.ZodOptional<z.ZodNumber>>;
+}, "strip", z.ZodTypeAny, {
+    enabled: boolean;
+    provider: "custom" | "docusign" | "adobe-sign" | "hellosign";
+    signers: {
+        order: number;
+        email: string;
+        name: string;
+        role: string;
+    }[];
+    expirationDays: number;
+    reminderDays: number;
+}, {
+    provider: "custom" | "docusign" | "adobe-sign" | "hellosign";
+    signers: {
+        order: number;
+        email: string;
+        name: string;
+        role: string;
+    }[];
+    enabled?: boolean | undefined;
+    expirationDays?: number | undefined;
+    reminderDays?: number | undefined;
+}>;
+/**
+ * Document Schema
+ *
+ * Comprehensive document management protocol supporting versioning,
+ * templates, e-signatures, and access control.
+ *
+ * @example
+ * ```json
+ * {
+ *   "id": "doc_123",
+ *   "name": "Service Agreement 2024",
+ *   "description": "Annual service agreement",
+ *   "fileType": "application/pdf",
+ *   "fileSize": 1048576,
+ *   "category": "contracts",
+ *   "tags": ["legal", "2024", "services"],
+ *   "versioning": {
+ *     "enabled": true,
+ *     "versions": [
+ *       {
+ *         "versionNumber": 1,
+ *         "createdAt": 1704067200000,
+ *         "createdBy": "user_123",
+ *         "size": 1048576,
+ *         "checksum": "abc123",
+ *         "downloadUrl": "https://example.com/docs/v1.pdf",
+ *         "isLatest": true
+ *       }
+ *     ],
+ *     "majorVersion": 1,
+ *     "minorVersion": 0
+ *   },
+ *   "access": {
+ *     "isPublic": false,
+ *     "sharedWith": ["user_456", "team_789"],
+ *     "expiresAt": 1735689600000
+ *   },
+ *   "metadata": {
+ *     "author": "John Doe",
+ *     "department": "Legal"
+ *   }
+ * }
+ * ```
+ */
+export declare const DocumentSchema: z.ZodObject<{
+    /**
+     * Unique document identifier
+     */
+    id: z.ZodString;
+    /**
+     * Document name
+     */
+    name: z.ZodString;
+    /**
+     * Optional document description
+     */
+    description: z.ZodOptional<z.ZodString>;
+    /**
+     * MIME type of the document
+     */
+    fileType: z.ZodString;
+    /**
+     * File size in bytes
+     */
+    fileSize: z.ZodNumber;
+    /**
+     * Document category for organization
+     */
+    category: z.ZodOptional<z.ZodString>;
+    /**
+     * Tags for searchability and organization
+     */
+    tags: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+    /**
+     * Version control configuration
+     */
+    versioning: z.ZodOptional<z.ZodObject<{
+        /**
+         * Whether versioning is enabled
+         */
+        enabled: z.ZodBoolean;
+        /**
+         * List of all document versions
+         */
+        versions: z.ZodArray<z.ZodObject<{
+            /**
+             * Sequential version number (increments with each new version)
+             */
+            versionNumber: z.ZodNumber;
+            /**
+             * Timestamp when this version was created (Unix milliseconds)
+             */
+            createdAt: z.ZodNumber;
+            /**
+             * User ID who created this version
+             */
+            createdBy: z.ZodString;
+            /**
+             * File size in bytes
+             */
+            size: z.ZodNumber;
+            /**
+             * Checksum/hash of the file content (for integrity verification)
+             */
+            checksum: z.ZodString;
+            /**
+             * URL to download this specific version
+             */
+            downloadUrl: z.ZodString;
+            /**
+             * Whether this is the latest version
+             * @default false
+             */
+            isLatest: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
+        }, "strip", z.ZodTypeAny, {
+            versionNumber: number;
+            createdAt: number;
+            createdBy: string;
+            size: number;
+            checksum: string;
+            downloadUrl: string;
+            isLatest: boolean;
+        }, {
+            versionNumber: number;
+            createdAt: number;
+            createdBy: string;
+            size: number;
+            checksum: string;
+            downloadUrl: string;
+            isLatest?: boolean | undefined;
+        }>, "many">;
+        /**
+         * Current major version number
+         */
+        majorVersion: z.ZodNumber;
+        /**
+         * Current minor version number
+         */
+        minorVersion: z.ZodNumber;
+    }, "strip", z.ZodTypeAny, {
+        enabled: boolean;
+        versions: {
+            versionNumber: number;
+            createdAt: number;
+            createdBy: string;
+            size: number;
+            checksum: string;
+            downloadUrl: string;
+            isLatest: boolean;
+        }[];
+        majorVersion: number;
+        minorVersion: number;
+    }, {
+        enabled: boolean;
+        versions: {
+            versionNumber: number;
+            createdAt: number;
+            createdBy: string;
+            size: number;
+            checksum: string;
+            downloadUrl: string;
+            isLatest?: boolean | undefined;
+        }[];
+        majorVersion: number;
+        minorVersion: number;
+    }>>;
+    /**
+     * Template configuration (if document is generated from template)
+     */
+    template: z.ZodOptional<z.ZodObject<{
+        /**
+         * Unique identifier for the template
+         */
+        id: z.ZodString;
+        /**
+         * Human-readable name of the template
+         */
+        name: z.ZodString;
+        /**
+         * Optional description of the template's purpose
+         */
+        description: z.ZodOptional<z.ZodString>;
+        /**
+         * URL to the template file
+         */
+        fileUrl: z.ZodString;
+        /**
+         * MIME type of the template file
+         */
+        fileType: z.ZodString;
+        /**
+         * List of dynamic placeholders in the template
+         */
+        placeholders: z.ZodArray<z.ZodObject<{
+            /**
+             * Placeholder identifier (used in template)
+             */
+            key: z.ZodString;
+            /**
+             * Human-readable label for the placeholder
+             */
+            label: z.ZodString;
+            /**
+             * Data type of the placeholder value
+             */
+            type: z.ZodEnum<["text", "number", "date", "image"]>;
+            /**
+             * Whether this placeholder must be filled
+             * @default false
+             */
+            required: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
+        }, "strip", z.ZodTypeAny, {
+            type: "number" | "date" | "text" | "image";
+            required: boolean;
+            label: string;
+            key: string;
+        }, {
+            type: "number" | "date" | "text" | "image";
+            label: string;
+            key: string;
+            required?: boolean | undefined;
+        }>, "many">;
+    }, "strip", z.ZodTypeAny, {
+        name: string;
+        id: string;
+        fileUrl: string;
+        fileType: string;
+        placeholders: {
+            type: "number" | "date" | "text" | "image";
+            required: boolean;
+            label: string;
+            key: string;
+        }[];
+        description?: string | undefined;
+    }, {
+        name: string;
+        id: string;
+        fileUrl: string;
+        fileType: string;
+        placeholders: {
+            type: "number" | "date" | "text" | "image";
+            label: string;
+            key: string;
+            required?: boolean | undefined;
+        }[];
+        description?: string | undefined;
+    }>>;
+    /**
+     * E-signature configuration
+     */
+    eSignature: z.ZodOptional<z.ZodObject<{
+        /**
+         * E-signature service provider
+         */
+        provider: z.ZodEnum<["docusign", "adobe-sign", "hellosign", "custom"]>;
+        /**
+         * Whether e-signature is enabled for this document
+         * @default false
+         */
+        enabled: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
+        /**
+         * List of signers in signing order
+         */
+        signers: z.ZodArray<z.ZodObject<{
+            /**
+             * Signer's email address
+             */
+            email: z.ZodString;
+            /**
+             * Signer's full name
+             */
+            name: z.ZodString;
+            /**
+             * Signer's role in the document
+             */
+            role: z.ZodString;
+            /**
+             * Signing order (lower numbers sign first)
+             */
+            order: z.ZodNumber;
+        }, "strip", z.ZodTypeAny, {
+            order: number;
+            email: string;
+            name: string;
+            role: string;
+        }, {
+            order: number;
+            email: string;
+            name: string;
+            role: string;
+        }>, "many">;
+        /**
+         * Days until signature request expires
+         * @default 30
+         */
+        expirationDays: z.ZodDefault<z.ZodOptional<z.ZodNumber>>;
+        /**
+         * Days between reminder emails
+         * @default 7
+         */
+        reminderDays: z.ZodDefault<z.ZodOptional<z.ZodNumber>>;
+    }, "strip", z.ZodTypeAny, {
+        enabled: boolean;
+        provider: "custom" | "docusign" | "adobe-sign" | "hellosign";
+        signers: {
+            order: number;
+            email: string;
+            name: string;
+            role: string;
+        }[];
+        expirationDays: number;
+        reminderDays: number;
+    }, {
+        provider: "custom" | "docusign" | "adobe-sign" | "hellosign";
+        signers: {
+            order: number;
+            email: string;
+            name: string;
+            role: string;
+        }[];
+        enabled?: boolean | undefined;
+        expirationDays?: number | undefined;
+        reminderDays?: number | undefined;
+    }>>;
+    /**
+     * Access control settings
+     */
+    access: z.ZodOptional<z.ZodObject<{
+        /**
+         * Whether document is publicly accessible
+         * @default false
+         */
+        isPublic: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
+        /**
+         * List of user/team IDs with access
+         */
+        sharedWith: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+        /**
+         * Timestamp when access expires (Unix milliseconds)
+         */
+        expiresAt: z.ZodOptional<z.ZodNumber>;
+    }, "strip", z.ZodTypeAny, {
+        isPublic: boolean;
+        sharedWith?: string[] | undefined;
+        expiresAt?: number | undefined;
+    }, {
+        isPublic?: boolean | undefined;
+        sharedWith?: string[] | undefined;
+        expiresAt?: number | undefined;
+    }>>;
+    /**
+     * Custom metadata fields
+     */
+    metadata: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
+}, "strip", z.ZodTypeAny, {
+    name: string;
+    id: string;
+    fileType: string;
+    fileSize: number;
+    tags?: string[] | undefined;
+    description?: string | undefined;
+    versioning?: {
+        enabled: boolean;
+        versions: {
+            versionNumber: number;
+            createdAt: number;
+            createdBy: string;
+            size: number;
+            checksum: string;
+            downloadUrl: string;
+            isLatest: boolean;
+        }[];
+        majorVersion: number;
+        minorVersion: number;
+    } | undefined;
+    category?: string | undefined;
+    template?: {
+        name: string;
+        id: string;
+        fileUrl: string;
+        fileType: string;
+        placeholders: {
+            type: "number" | "date" | "text" | "image";
+            required: boolean;
+            label: string;
+            key: string;
+        }[];
+        description?: string | undefined;
+    } | undefined;
+    eSignature?: {
+        enabled: boolean;
+        provider: "custom" | "docusign" | "adobe-sign" | "hellosign";
+        signers: {
+            order: number;
+            email: string;
+            name: string;
+            role: string;
+        }[];
+        expirationDays: number;
+        reminderDays: number;
+    } | undefined;
+    access?: {
+        isPublic: boolean;
+        sharedWith?: string[] | undefined;
+        expiresAt?: number | undefined;
+    } | undefined;
+    metadata?: Record<string, any> | undefined;
+}, {
+    name: string;
+    id: string;
+    fileType: string;
+    fileSize: number;
+    tags?: string[] | undefined;
+    description?: string | undefined;
+    versioning?: {
+        enabled: boolean;
+        versions: {
+            versionNumber: number;
+            createdAt: number;
+            createdBy: string;
+            size: number;
+            checksum: string;
+            downloadUrl: string;
+            isLatest?: boolean | undefined;
+        }[];
+        majorVersion: number;
+        minorVersion: number;
+    } | undefined;
+    category?: string | undefined;
+    template?: {
+        name: string;
+        id: string;
+        fileUrl: string;
+        fileType: string;
+        placeholders: {
+            type: "number" | "date" | "text" | "image";
+            label: string;
+            key: string;
+            required?: boolean | undefined;
+        }[];
+        description?: string | undefined;
+    } | undefined;
+    eSignature?: {
+        provider: "custom" | "docusign" | "adobe-sign" | "hellosign";
+        signers: {
+            order: number;
+            email: string;
+            name: string;
+            role: string;
+        }[];
+        enabled?: boolean | undefined;
+        expirationDays?: number | undefined;
+        reminderDays?: number | undefined;
+    } | undefined;
+    access?: {
+        isPublic?: boolean | undefined;
+        sharedWith?: string[] | undefined;
+        expiresAt?: number | undefined;
+    } | undefined;
+    metadata?: Record<string, any> | undefined;
+}>;
+export type Document = z.infer<typeof DocumentSchema>;
+export type DocumentVersion = z.infer<typeof DocumentVersionSchema>;
+export type DocumentTemplate = z.infer<typeof DocumentTemplateSchema>;
+export type ESignatureConfig = z.infer<typeof ESignatureConfigSchema>;
+//# sourceMappingURL=document.zod.d.ts.map