appwrite-utils-cli 1.5.1 → 1.6.0

package/dist/utils/sessionPreservationExample.d.ts

@@ -0,0 +1,1666 @@
+/**
+ * @fileoverview Session Preservation Usage Examples
+ *
+ * This file demonstrates how to use the enhanced config loading functions
+ * with session preservation capabilities.
+ */
+/**
+ * Example 1: Basic session preservation
+ */
+export declare function loadConfigWithSession(configDir: string, sessionCookie: string): Promise<{
+    appwriteEndpoint: string;
+    appwriteProject: string;
+    appwriteKey: string;
+    appwriteClient: any;
+    authMethod: "session" | "apikey" | "auto";
+    logging: {
+        enabled: boolean;
+        level: "error" | "warn" | "info" | "debug";
+        console: boolean;
+        logDirectory?: string | undefined;
+    };
+    enableBackups: boolean;
+    backupInterval: number;
+    backupRetention: number;
+    enableBackupCleanup: boolean;
+    enableMockData: boolean;
+    documentBucketId: string;
+    usersCollectionName: string;
+    useMigrations: boolean;
+    databases: {
+        $id: string;
+        name: string;
+        bucket?: {
+            $id: string;
+            name: string;
+            permissions?: ({
+                permission: string;
+                target: string;
+            } | {
+                permission: string;
+                target: string;
+            })[] | undefined;
+            fileSecurity?: boolean | undefined;
+            enabled?: boolean | undefined;
+            maximumFileSize?: number | undefined;
+            allowedFileExtensions?: string[] | undefined;
+            compression?: "none" | "gzip" | "zstd" | undefined;
+            encryption?: boolean | undefined;
+            antivirus?: boolean | undefined;
+        } | undefined;
+    }[];
+    buckets: {
+        $id: string;
+        name: string;
+        permissions?: ({
+            permission: string;
+            target: string;
+        } | {
+            permission: string;
+            target: string;
+        })[] | undefined;
+        fileSecurity?: boolean | undefined;
+        enabled?: boolean | undefined;
+        maximumFileSize?: number | undefined;
+        allowedFileExtensions?: string[] | undefined;
+        compression?: "none" | "gzip" | "zstd" | undefined;
+        encryption?: boolean | undefined;
+        antivirus?: boolean | undefined;
+    }[];
+    apiMode: "auto" | "legacy" | "tablesdb";
+    sessionCookie?: string | undefined;
+    sessionMetadata?: {
+        email?: string | undefined;
+        expiresAt?: string | undefined;
+    } | undefined;
+    collections?: {
+        name: string;
+        attributes: ({
+            key: string;
+            type: "string";
+            size: number;
+            error?: string | undefined;
+            required?: boolean | undefined;
+            array?: boolean | undefined;
+            xdefault?: string | null | undefined;
+            encrypted?: boolean | undefined;
+            format?: string | null | undefined;
+        } | {
+            key: string;
+            type: "integer";
+            error?: string | undefined;
+            required?: boolean | undefined;
+            array?: boolean | undefined;
+            min?: number | undefined;
+            max?: number | undefined;
+            xdefault?: number | null | undefined;
+        } | {
+            key: string;
+            type: "double";
+            error?: string | undefined;
+            required?: boolean | undefined;
+            array?: boolean | undefined;
+            min?: number | undefined;
+            max?: number | undefined;
+            xdefault?: number | null | undefined;
+        } | {
+            key: string;
+            type: "float";
+            error?: string | undefined;
+            required?: boolean | undefined;
+            array?: boolean | undefined;
+            min?: number | undefined;
+            max?: number | undefined;
+            xdefault?: number | null | undefined;
+        } | {
+            key: string;
+            type: "boolean";
+            error?: string | undefined;
+            required?: boolean | undefined;
+            array?: boolean | undefined;
+            xdefault?: boolean | null | undefined;
+        } | {
+            key: string;
+            type: "datetime";
+            error?: string | undefined;
+            required?: boolean | undefined;
+            array?: boolean | undefined;
+            xdefault?: string | null | undefined;
+        } | {
+            key: string;
+            type: "email";
+            error?: string | undefined;
+            required?: boolean | undefined;
+            array?: boolean | undefined;
+            xdefault?: string | null | undefined;
+        } | {
+            key: string;
+            type: "ip";
+            error?: string | undefined;
+            required?: boolean | undefined;
+            array?: boolean | undefined;
+            xdefault?: string | null | undefined;
+        } | {
+            key: string;
+            type: "url";
+            error?: string | undefined;
+            required?: boolean | undefined;
+            array?: boolean | undefined;
+            xdefault?: string | null | undefined;
+        } | {
+            key: string;
+            type: "enum";
+            elements: string[];
+            error?: string | undefined;
+            required?: boolean | undefined;
+            array?: boolean | undefined;
+            xdefault?: string | null | undefined;
+        } | {
+            key: string;
+            type: "relationship";
+            relatedCollection: string;
+            relationType: "oneToMany" | "manyToOne" | "oneToOne" | "manyToMany";
+            twoWay: boolean;
+            onDelete: "setNull" | "cascade" | "restrict";
+            error?: string | undefined;
+            required?: boolean | undefined;
+            array?: boolean | undefined;
+            twoWayKey?: string | undefined;
+            side?: "parent" | "child" | undefined;
+            importMapping?: {
+                originalIdField: string;
+                targetField?: string | undefined;
+            } | undefined;
+        })[];
+        $permissions: {
+            permission: string;
+            target: string;
+        }[];
+        indexes: {
+            key: string;
+            type: "key" | "unique" | "fulltext";
+            attributes: string[];
+            status?: string | undefined;
+            error?: string | undefined;
+            orders?: string[] | undefined;
+        }[];
+        importDefs: {
+            filePath: string;
+            primaryKeyField: string;
+            attributeMappings: {
+                targetKey: string;
+                oldKey?: string | undefined;
+                oldKeys?: string[] | undefined;
+                valueToSet?: any;
+                fileData?: {
+                    name: string;
+                    path: string;
+                } | undefined;
+                converters?: string[] | undefined;
+                validationActions?: {
+                    action: string;
+                    params: string[];
+                }[] | undefined;
+                postImportActions?: {
+                    action: string;
+                    params: (string | Record<string, any>)[];
+                }[] | undefined;
+            }[];
+            type?: "create" | "update" | undefined;
+            basePath?: string | undefined;
+            idMappings?: {
+                sourceField: string;
+                targetField: string;
+                targetCollection: string;
+                fieldToSet?: string | undefined;
+                targetFieldToMatch?: string | undefined;
+            }[] | undefined;
+            createUsers?: boolean | null | undefined;
+            updateMapping?: {
+                originalIdField: string;
+                targetField: string;
+            } | undefined;
+        }[];
+        $id?: string | undefined;
+        enabled?: boolean | undefined;
+        documentSecurity?: boolean | undefined;
+        databaseId?: string | undefined;
+    }[] | undefined;
+    tables?: {
+        attributes: ({
+            key: string;
+            type: "string";
+            size: number;
+            error?: string | undefined;
+            required?: boolean | undefined;
+            array?: boolean | undefined;
+            xdefault?: string | null | undefined;
+            encrypted?: boolean | undefined;
+            format?: string | null | undefined;
+        } | {
+            key: string;
+            type: "integer";
+            error?: string | undefined;
+            required?: boolean | undefined;
+            array?: boolean | undefined;
+            min?: number | undefined;
+            max?: number | undefined;
+            xdefault?: number | null | undefined;
+        } | {
+            key: string;
+            type: "double";
+            error?: string | undefined;
+            required?: boolean | undefined;
+            array?: boolean | undefined;
+            min?: number | undefined;
+            max?: number | undefined;
+            xdefault?: number | null | undefined;
+        } | {
+            key: string;
+            type: "float";
+            error?: string | undefined;
+            required?: boolean | undefined;
+            array?: boolean | undefined;
+            min?: number | undefined;
+            max?: number | undefined;
+            xdefault?: number | null | undefined;
+        } | {
+            key: string;
+            type: "boolean";
+            error?: string | undefined;
+            required?: boolean | undefined;
+            array?: boolean | undefined;
+            xdefault?: boolean | null | undefined;
+        } | {
+            key: string;
+            type: "datetime";
+            error?: string | undefined;
+            required?: boolean | undefined;
+            array?: boolean | undefined;
+            xdefault?: string | null | undefined;
+        } | {
+            key: string;
+            type: "email";
+            error?: string | undefined;
+            required?: boolean | undefined;
+            array?: boolean | undefined;
+            xdefault?: string | null | undefined;
+        } | {
+            key: string;
+            type: "ip";
+            error?: string | undefined;
+            required?: boolean | undefined;
+            array?: boolean | undefined;
+            xdefault?: string | null | undefined;
+        } | {
+            key: string;
+            type: "url";
+            error?: string | undefined;
+            required?: boolean | undefined;
+            array?: boolean | undefined;
+            xdefault?: string | null | undefined;
+        } | {
+            key: string;
+            type: "enum";
+            elements: string[];
+            error?: string | undefined;
+            required?: boolean | undefined;
+            array?: boolean | undefined;
+            xdefault?: string | null | undefined;
+        } | {
+            key: string;
+            type: "relationship";
+            relatedCollection: string;
+            relationType: "oneToMany" | "manyToOne" | "oneToOne" | "manyToMany";
+            twoWay: boolean;
+            onDelete: "setNull" | "cascade" | "restrict";
+            error?: string | undefined;
+            required?: boolean | undefined;
+            array?: boolean | undefined;
+            twoWayKey?: string | undefined;
+            side?: "parent" | "child" | undefined;
+            importMapping?: {
+                originalIdField: string;
+                targetField?: string | undefined;
+            } | undefined;
+        })[];
+        columns: undefined;
+        indexes: {
+            key: string;
+            type: "key" | "unique" | "fulltext";
+            attributes: string[];
+            status?: string | undefined;
+            error?: string | undefined;
+            orders?: string[] | undefined;
+        }[];
+        name: string;
+        $permissions: {
+            permission: string;
+            target: string;
+        }[];
+        importDefs: {
+            filePath: string;
+            primaryKeyField: string;
+            attributeMappings: {
+                targetKey: string;
+                oldKey?: string | undefined;
+                oldKeys?: string[] | undefined;
+                valueToSet?: any;
+                fileData?: {
+                    name: string;
+                    path: string;
+                } | undefined;
+                converters?: string[] | undefined;
+                validationActions?: {
+                    action: string;
+                    params: string[];
+                }[] | undefined;
+                postImportActions?: {
+                    action: string;
+                    params: (string | Record<string, any>)[];
+                }[] | undefined;
+            }[];
+            type?: "create" | "update" | undefined;
+            basePath?: string | undefined;
+            idMappings?: {
+                sourceField: string;
+                targetField: string;
+                targetCollection: string;
+                fieldToSet?: string | undefined;
+                targetFieldToMatch?: string | undefined;
+            }[] | undefined;
+            createUsers?: boolean | null | undefined;
+            updateMapping?: {
+                originalIdField: string;
+                targetField: string;
+            } | undefined;
+        }[];
+        $id?: string | undefined;
+        enabled?: boolean | undefined;
+        documentSecurity?: boolean | undefined;
+        databaseId?: string | undefined;
+        tableId?: string | undefined;
+    }[] | undefined;
+    functions?: {
+        $id: string;
+        name: string;
+        runtime: any;
+        execute: string[];
+        events: string[];
+        dirPath?: string | undefined;
+        schedule?: string | undefined;
+        timeout?: number | undefined;
+        enabled?: boolean | undefined;
+        logging?: boolean | undefined;
+        ignore?: string[] | undefined;
+        entrypoint?: string | undefined;
+        predeployCommands?: string[] | undefined;
+        deployDir?: string | undefined;
+        commands?: string | undefined;
+        scopes?: string[] | undefined;
+        installationId?: string | undefined;
+        providerRepositoryId?: string | undefined;
+        providerBranch?: string | undefined;
+        providerSilentMode?: boolean | undefined;
+        providerRootDirectory?: string | undefined;
+        templateRepository?: string | undefined;
+        templateOwner?: string | undefined;
+        templateRootDirectory?: string | undefined;
+        templateVersion?: string | undefined;
+        specification?: string | undefined;
+    }[] | undefined;
+    schemaConfig?: {
+        outputDirectory: string;
+        yamlSchemaDirectory: string;
+        importDirectory: string;
+        collectionsDirectory: string;
+        tablesDirectory: string;
+    } | undefined;
+}>;
+/**
+ * Example 2: Using the helper function for cleaner code
+ */
+export declare function loadConfigWithSessionHelper(configDir: string, sessionCookie: string, email?: string, expiresAt?: string): Promise<{
+    config: import("appwrite-utils").AppwriteConfig;
+    actualConfigPath: string;
+    validation?: import("../config/configValidation.js").ValidationResult;
+}>;
+/**
+ * Example 3: Preserving existing appwriteClient with session context
+ */
+export declare function loadConfigPreservingClient(configDir: string, existingClient: any, sessionCookie: string): Promise<{
+    appwriteEndpoint: string;
+    appwriteProject: string;
+    appwriteKey: string;
+    appwriteClient: any;
+    authMethod: "session" | "apikey" | "auto";
+    logging: {
+        enabled: boolean;
+        level: "error" | "warn" | "info" | "debug";
+        console: boolean;
+        logDirectory?: string | undefined;
+    };
+    enableBackups: boolean;
+    backupInterval: number;
+    backupRetention: number;
+    enableBackupCleanup: boolean;
+    enableMockData: boolean;
+    documentBucketId: string;
+    usersCollectionName: string;
+    useMigrations: boolean;
+    databases: {
+        $id: string;
+        name: string;
+        bucket?: {
+            $id: string;
+            name: string;
+            permissions?: ({
+                permission: string;
+                target: string;
+            } | {
+                permission: string;
+                target: string;
+            })[] | undefined;
+            fileSecurity?: boolean | undefined;
+            enabled?: boolean | undefined;
+            maximumFileSize?: number | undefined;
+            allowedFileExtensions?: string[] | undefined;
+            compression?: "none" | "gzip" | "zstd" | undefined;
+            encryption?: boolean | undefined;
+            antivirus?: boolean | undefined;
+        } | undefined;
+    }[];
+    buckets: {
+        $id: string;
+        name: string;
+        permissions?: ({
+            permission: string;
+            target: string;
+        } | {
+            permission: string;
+            target: string;
+        })[] | undefined;
+        fileSecurity?: boolean | undefined;
+        enabled?: boolean | undefined;
+        maximumFileSize?: number | undefined;
+        allowedFileExtensions?: string[] | undefined;
+        compression?: "none" | "gzip" | "zstd" | undefined;
+        encryption?: boolean | undefined;
+        antivirus?: boolean | undefined;
+    }[];
+    apiMode: "auto" | "legacy" | "tablesdb";
+    sessionCookie?: string | undefined;
+    sessionMetadata?: {
+        email?: string | undefined;
+        expiresAt?: string | undefined;
+    } | undefined;
+    collections?: {
+        name: string;
+        attributes: ({
+            key: string;
+            type: "string";
+            size: number;
+            error?: string | undefined;
+            required?: boolean | undefined;
+            array?: boolean | undefined;
+            xdefault?: string | null | undefined;
+            encrypted?: boolean | undefined;
+            format?: string | null | undefined;
+        } | {
+            key: string;
+            type: "integer";
+            error?: string | undefined;
+            required?: boolean | undefined;
+            array?: boolean | undefined;
+            min?: number | undefined;
+            max?: number | undefined;
+            xdefault?: number | null | undefined;
+        } | {
+            key: string;
+            type: "double";
+            error?: string | undefined;
+            required?: boolean | undefined;
+            array?: boolean | undefined;
+            min?: number | undefined;
+            max?: number | undefined;
+            xdefault?: number | null | undefined;
+        } | {
+            key: string;
+            type: "float";
+            error?: string | undefined;
+            required?: boolean | undefined;
+            array?: boolean | undefined;
+            min?: number | undefined;
+            max?: number | undefined;
+            xdefault?: number | null | undefined;
+        } | {
+            key: string;
+            type: "boolean";
+            error?: string | undefined;
+            required?: boolean | undefined;
+            array?: boolean | undefined;
+            xdefault?: boolean | null | undefined;
+        } | {
+            key: string;
+            type: "datetime";
+            error?: string | undefined;
+            required?: boolean | undefined;
+            array?: boolean | undefined;
+            xdefault?: string | null | undefined;
+        } | {
+            key: string;
+            type: "email";
+            error?: string | undefined;
+            required?: boolean | undefined;
+            array?: boolean | undefined;
+            xdefault?: string | null | undefined;
+        } | {
+            key: string;
+            type: "ip";
+            error?: string | undefined;
+            required?: boolean | undefined;
+            array?: boolean | undefined;
+            xdefault?: string | null | undefined;
+        } | {
+            key: string;
+            type: "url";
+            error?: string | undefined;
+            required?: boolean | undefined;
+            array?: boolean | undefined;
+            xdefault?: string | null | undefined;
+        } | {
+            key: string;
+            type: "enum";
+            elements: string[];
+            error?: string | undefined;
+            required?: boolean | undefined;
+            array?: boolean | undefined;
+            xdefault?: string | null | undefined;
+        } | {
+            key: string;
+            type: "relationship";
+            relatedCollection: string;
+            relationType: "oneToMany" | "manyToOne" | "oneToOne" | "manyToMany";
+            twoWay: boolean;
+            onDelete: "setNull" | "cascade" | "restrict";
+            error?: string | undefined;
+            required?: boolean | undefined;
+            array?: boolean | undefined;
+            twoWayKey?: string | undefined;
+            side?: "parent" | "child" | undefined;
+            importMapping?: {
+                originalIdField: string;
+                targetField?: string | undefined;
+            } | undefined;
+        })[];
+        $permissions: {
+            permission: string;
+            target: string;
+        }[];
+        indexes: {
+            key: string;
+            type: "key" | "unique" | "fulltext";
+            attributes: string[];
+            status?: string | undefined;
+            error?: string | undefined;
+            orders?: string[] | undefined;
+        }[];
+        importDefs: {
+            filePath: string;
+            primaryKeyField: string;
+            attributeMappings: {
+                targetKey: string;
+                oldKey?: string | undefined;
+                oldKeys?: string[] | undefined;
+                valueToSet?: any;
+                fileData?: {
+                    name: string;
+                    path: string;
+                } | undefined;
+                converters?: string[] | undefined;
+                validationActions?: {
+                    action: string;
+                    params: string[];
+                }[] | undefined;
+                postImportActions?: {
+                    action: string;
+                    params: (string | Record<string, any>)[];
+                }[] | undefined;
+            }[];
+            type?: "create" | "update" | undefined;
+            basePath?: string | undefined;
+            idMappings?: {
+                sourceField: string;
+                targetField: string;
+                targetCollection: string;
+                fieldToSet?: string | undefined;
+                targetFieldToMatch?: string | undefined;
+            }[] | undefined;
+            createUsers?: boolean | null | undefined;
+            updateMapping?: {
+                originalIdField: string;
+                targetField: string;
+            } | undefined;
+        }[];
+        $id?: string | undefined;
+        enabled?: boolean | undefined;
+        documentSecurity?: boolean | undefined;
+        databaseId?: string | undefined;
+    }[] | undefined;
+    tables?: {
+        attributes: ({
+            key: string;
+            type: "string";
+            size: number;
+            error?: string | undefined;
+            required?: boolean | undefined;
+            array?: boolean | undefined;
+            xdefault?: string | null | undefined;
+            encrypted?: boolean | undefined;
+            format?: string | null | undefined;
+        } | {
+            key: string;
+            type: "integer";
+            error?: string | undefined;
+            required?: boolean | undefined;
+            array?: boolean | undefined;
+            min?: number | undefined;
+            max?: number | undefined;
+            xdefault?: number | null | undefined;
+        } | {
+            key: string;
+            type: "double";
+            error?: string | undefined;
+            required?: boolean | undefined;
+            array?: boolean | undefined;
+            min?: number | undefined;
+            max?: number | undefined;
+            xdefault?: number | null | undefined;
+        } | {
+            key: string;
+            type: "float";
+            error?: string | undefined;
+            required?: boolean | undefined;
+            array?: boolean | undefined;
+            min?: number | undefined;
+            max?: number | undefined;
+            xdefault?: number | null | undefined;
+        } | {
+            key: string;
+            type: "boolean";
+            error?: string | undefined;
+            required?: boolean | undefined;
+            array?: boolean | undefined;
+            xdefault?: boolean | null | undefined;
+        } | {
+            key: string;
+            type: "datetime";
+            error?: string | undefined;
+            required?: boolean | undefined;
+            array?: boolean | undefined;
+            xdefault?: string | null | undefined;
+        } | {
+            key: string;
+            type: "email";
+            error?: string | undefined;
+            required?: boolean | undefined;
+            array?: boolean | undefined;
+            xdefault?: string | null | undefined;
+        } | {
+            key: string;
+            type: "ip";
+            error?: string | undefined;
+            required?: boolean | undefined;
+            array?: boolean | undefined;
+            xdefault?: string | null | undefined;
+        } | {
+            key: string;
+            type: "url";
+            error?: string | undefined;
+            required?: boolean | undefined;
+            array?: boolean | undefined;
+            xdefault?: string | null | undefined;
+        } | {
+            key: string;
+            type: "enum";
+            elements: string[];
+            error?: string | undefined;
+            required?: boolean | undefined;
+            array?: boolean | undefined;
+            xdefault?: string | null | undefined;
+        } | {
+            key: string;
+            type: "relationship";
+            relatedCollection: string;
+            relationType: "oneToMany" | "manyToOne" | "oneToOne" | "manyToMany";
+            twoWay: boolean;
+            onDelete: "setNull" | "cascade" | "restrict";
+            error?: string | undefined;
+            required?: boolean | undefined;
+            array?: boolean | undefined;
+            twoWayKey?: string | undefined;
+            side?: "parent" | "child" | undefined;
+            importMapping?: {
+                originalIdField: string;
+                targetField?: string | undefined;
+            } | undefined;
+        })[];
+        columns: undefined;
+        indexes: {
+            key: string;
+            type: "key" | "unique" | "fulltext";
+            attributes: string[];
+            status?: string | undefined;
+            error?: string | undefined;
+            orders?: string[] | undefined;
+        }[];
+        name: string;
+        $permissions: {
+            permission: string;
+            target: string;
+        }[];
+        importDefs: {
+            filePath: string;
+            primaryKeyField: string;
+            attributeMappings: {
+                targetKey: string;
+                oldKey?: string | undefined;
+                oldKeys?: string[] | undefined;
+                valueToSet?: any;
+                fileData?: {
+                    name: string;
+                    path: string;
+                } | undefined;
+                converters?: string[] | undefined;
+                validationActions?: {
+                    action: string;
+                    params: string[];
+                }[] | undefined;
+                postImportActions?: {
+                    action: string;
+                    params: (string | Record<string, any>)[];
+                }[] | undefined;
+            }[];
+            type?: "create" | "update" | undefined;
+            basePath?: string | undefined;
+            idMappings?: {
+                sourceField: string;
+                targetField: string;
+                targetCollection: string;
+                fieldToSet?: string | undefined;
+                targetFieldToMatch?: string | undefined;
+            }[] | undefined;
+            createUsers?: boolean | null | undefined;
+            updateMapping?: {
+                originalIdField: string;
+                targetField: string;
+            } | undefined;
+        }[];
+        $id?: string | undefined;
+        enabled?: boolean | undefined;
+        documentSecurity?: boolean | undefined;
+        databaseId?: string | undefined;
+        tableId?: string | undefined;
+    }[] | undefined;
+    functions?: {
+        $id: string;
+        name: string;
+        runtime: any;
+        execute: string[];
+        events: string[];
+        dirPath?: string | undefined;
+        schedule?: string | undefined;
+        timeout?: number | undefined;
+        enabled?: boolean | undefined;
+        logging?: boolean | undefined;
+        ignore?: string[] | undefined;
+        entrypoint?: string | undefined;
+        predeployCommands?: string[] | undefined;
+        deployDir?: string | undefined;
+        commands?: string | undefined;
+        scopes?: string[] | undefined;
+        installationId?: string | undefined;
+        providerRepositoryId?: string | undefined;
+        providerBranch?: string | undefined;
+        providerSilentMode?: boolean | undefined;
+        providerRootDirectory?: string | undefined;
+        templateRepository?: string | undefined;
+        templateOwner?: string | undefined;
+        templateRootDirectory?: string | undefined;
+        templateVersion?: string | undefined;
+        specification?: string | undefined;
+    }[] | undefined;
+    schemaConfig?: {
+        outputDirectory: string;
+        yamlSchemaDirectory: string;
+        importDirectory: string;
+        collectionsDirectory: string;
+        tablesDirectory: string;
+    } | undefined;
+}>;
+/**
+ * Example 4: Auto-detection with fallback
+ */
+export declare function loadConfigWithAutoAuth(configDir: string, sessionCookie?: string, apiKey?: string): Promise<{
+    appwriteEndpoint: string;
+    appwriteProject: string;
+    appwriteKey: string;
+    appwriteClient: any;
+    authMethod: "session" | "apikey" | "auto";
+    logging: {
+        enabled: boolean;
+        level: "error" | "warn" | "info" | "debug";
+        console: boolean;
+        logDirectory?: string | undefined;
+    };
+    enableBackups: boolean;
+    backupInterval: number;
+    backupRetention: number;
+    enableBackupCleanup: boolean;
+    enableMockData: boolean;
+    documentBucketId: string;
+    usersCollectionName: string;
+    useMigrations: boolean;
+    databases: {
+        $id: string;
+        name: string;
+        bucket?: {
+            $id: string;
+            name: string;
+            permissions?: ({
+                permission: string;
+                target: string;
+            } | {
+                permission: string;
+                target: string;
+            })[] | undefined;
+            fileSecurity?: boolean | undefined;
+            enabled?: boolean | undefined;
+            maximumFileSize?: number | undefined;
+            allowedFileExtensions?: string[] | undefined;
+            compression?: "none" | "gzip" | "zstd" | undefined;
+            encryption?: boolean | undefined;
+            antivirus?: boolean | undefined;
+        } | undefined;
+    }[];
+    buckets: {
+        $id: string;
+        name: string;
+        permissions?: ({
+            permission: string;
+            target: string;
+        } | {
+            permission: string;
+            target: string;
+        })[] | undefined;
+        fileSecurity?: boolean | undefined;
+        enabled?: boolean | undefined;
+        maximumFileSize?: number | undefined;
+        allowedFileExtensions?: string[] | undefined;
+        compression?: "none" | "gzip" | "zstd" | undefined;
+        encryption?: boolean | undefined;
+        antivirus?: boolean | undefined;
+    }[];
+    apiMode: "auto" | "legacy" | "tablesdb";
+    sessionCookie?: string | undefined;
+    sessionMetadata?: {
+        email?: string | undefined;
+        expiresAt?: string | undefined;
+    } | undefined;
+    collections?: {
+        name: string;
+        attributes: ({
+            key: string;
+            type: "string";
+            size: number;
+            error?: string | undefined;
+            required?: boolean | undefined;
+            array?: boolean | undefined;
+            xdefault?: string | null | undefined;
+            encrypted?: boolean | undefined;
+            format?: string | null | undefined;
+        } | {
+            key: string;
+            type: "integer";
+            error?: string | undefined;
+            required?: boolean | undefined;
+            array?: boolean | undefined;
+            min?: number | undefined;
+            max?: number | undefined;
+            xdefault?: number | null | undefined;
+        } | {
+            key: string;
+            type: "double";
+            error?: string | undefined;
+            required?: boolean | undefined;
+            array?: boolean | undefined;
+            min?: number | undefined;
+            max?: number | undefined;
+            xdefault?: number | null | undefined;
+        } | {
+            key: string;
+            type: "float";
+            error?: string | undefined;
+            required?: boolean | undefined;
+            array?: boolean | undefined;
+            min?: number | undefined;
+            max?: number | undefined;
+            xdefault?: number | null | undefined;
+        } | {
+            key: string;
+            type: "boolean";
+            error?: string | undefined;
+            required?: boolean | undefined;
+            array?: boolean | undefined;
+            xdefault?: boolean | null | undefined;
+        } | {
+            key: string;
+            type: "datetime";
+            error?: string | undefined;
+            required?: boolean | undefined;
+            array?: boolean | undefined;
+            xdefault?: string | null | undefined;
+        } | {
+            key: string;
+            type: "email";
+            error?: string | undefined;
+            required?: boolean | undefined;
+            array?: boolean | undefined;
+            xdefault?: string | null | undefined;
+        } | {
+            key: string;
+            type: "ip";
+            error?: string | undefined;
+            required?: boolean | undefined;
+            array?: boolean | undefined;
+            xdefault?: string | null | undefined;
+        } | {
+            key: string;
+            type: "url";
+            error?: string | undefined;
+            required?: boolean | undefined;
+            array?: boolean | undefined;
+            xdefault?: string | null | undefined;
+        } | {
+            key: string;
+            type: "enum";
+            elements: string[];
+            error?: string | undefined;
+            required?: boolean | undefined;
+            array?: boolean | undefined;
+            xdefault?: string | null | undefined;
+        } | {
+            key: string;
+            type: "relationship";
+            relatedCollection: string;
+            relationType: "oneToMany" | "manyToOne" | "oneToOne" | "manyToMany";
+            twoWay: boolean;
+            onDelete: "setNull" | "cascade" | "restrict";
+            error?: string | undefined;
+            required?: boolean | undefined;
+            array?: boolean | undefined;
+            twoWayKey?: string | undefined;
+            side?: "parent" | "child" | undefined;
+            importMapping?: {
+                originalIdField: string;
+                targetField?: string | undefined;
+            } | undefined;
+        })[];
+        $permissions: {
+            permission: string;
+            target: string;
+        }[];
+        indexes: {
+            key: string;
+            type: "key" | "unique" | "fulltext";
+            attributes: string[];
+            status?: string | undefined;
+            error?: string | undefined;
+            orders?: string[] | undefined;
+        }[];
+        importDefs: {
+            filePath: string;
+            primaryKeyField: string;
+            attributeMappings: {
+                targetKey: string;
+                oldKey?: string | undefined;
+                oldKeys?: string[] | undefined;
+                valueToSet?: any;
+                fileData?: {
+                    name: string;
+                    path: string;
+                } | undefined;
+                converters?: string[] | undefined;
+                validationActions?: {
+                    action: string;
+                    params: string[];
+                }[] | undefined;
+                postImportActions?: {
+                    action: string;
+                    params: (string | Record<string, any>)[];
+                }[] | undefined;
+            }[];
+            type?: "create" | "update" | undefined;
+            basePath?: string | undefined;
+            idMappings?: {
+                sourceField: string;
+                targetField: string;
+                targetCollection: string;
+                fieldToSet?: string | undefined;
+                targetFieldToMatch?: string | undefined;
+            }[] | undefined;
+            createUsers?: boolean | null | undefined;
+            updateMapping?: {
+                originalIdField: string;
+                targetField: string;
+            } | undefined;
+        }[];
+        $id?: string | undefined;
+        enabled?: boolean | undefined;
+        documentSecurity?: boolean | undefined;
+        databaseId?: string | undefined;
+    }[] | undefined;
+    tables?: {
+        attributes: ({
+            key: string;
+            type: "string";
+            size: number;
+            error?: string | undefined;
+            required?: boolean | undefined;
+            array?: boolean | undefined;
+            xdefault?: string | null | undefined;
+            encrypted?: boolean | undefined;
+            format?: string | null | undefined;
+        } | {
+            key: string;
+            type: "integer";
+            error?: string | undefined;
+            required?: boolean | undefined;
+            array?: boolean | undefined;
+            min?: number | undefined;
+            max?: number | undefined;
+            xdefault?: number | null | undefined;
+        } | {
+            key: string;
+            type: "double";
+            error?: string | undefined;
+            required?: boolean | undefined;
+            array?: boolean | undefined;
+            min?: number | undefined;
+            max?: number | undefined;
+            xdefault?: number | null | undefined;
+        } | {
+            key: string;
+            type: "float";
+            error?: string | undefined;
+            required?: boolean | undefined;
+            array?: boolean | undefined;
+            min?: number | undefined;
+            max?: number | undefined;
+            xdefault?: number | null | undefined;
+        } | {
+            key: string;
+            type: "boolean";
+            error?: string | undefined;
+            required?: boolean | undefined;
+            array?: boolean | undefined;
+            xdefault?: boolean | null | undefined;
+        } | {
+            key: string;
+            type: "datetime";
+            error?: string | undefined;
+            required?: boolean | undefined;
+            array?: boolean | undefined;
+            xdefault?: string | null | undefined;
+        } | {
+            key: string;
+            type: "email";
+            error?: string | undefined;
+            required?: boolean | undefined;
+            array?: boolean | undefined;
+            xdefault?: string | null | undefined;
+        } | {
+            key: string;
+            type: "ip";
+            error?: string | undefined;
+            required?: boolean | undefined;
+            array?: boolean | undefined;
+            xdefault?: string | null | undefined;
+        } | {
+            key: string;
+            type: "url";
+            error?: string | undefined;
+            required?: boolean | undefined;
+            array?: boolean | undefined;
+            xdefault?: string | null | undefined;
+        } | {
+            key: string;
+            type: "enum";
+            elements: string[];
+            error?: string | undefined;
+            required?: boolean | undefined;
+            array?: boolean | undefined;
+            xdefault?: string | null | undefined;
+        } | {
+            key: string;
+            type: "relationship";
+            relatedCollection: string;
+            relationType: "oneToMany" | "manyToOne" | "oneToOne" | "manyToMany";
+            twoWay: boolean;
+            onDelete: "setNull" | "cascade" | "restrict";
+            error?: string | undefined;
+            required?: boolean | undefined;
+            array?: boolean | undefined;
+            twoWayKey?: string | undefined;
+            side?: "parent" | "child" | undefined;
+            importMapping?: {
+                originalIdField: string;
+                targetField?: string | undefined;
+            } | undefined;
+        })[];
+        columns: undefined;
+        indexes: {
+            key: string;
+            type: "key" | "unique" | "fulltext";
+            attributes: string[];
+            status?: string | undefined;
+            error?: string | undefined;
+            orders?: string[] | undefined;
+        }[];
+        name: string;
+        $permissions: {
+            permission: string;
+            target: string;
+        }[];
+        importDefs: {
+            filePath: string;
+            primaryKeyField: string;
+            attributeMappings: {
+                targetKey: string;
+                oldKey?: string | undefined;
+                oldKeys?: string[] | undefined;
+                valueToSet?: any;
+                fileData?: {
+                    name: string;
+                    path: string;
+                } | undefined;
+                converters?: string[] | undefined;
+                validationActions?: {
+                    action: string;
+                    params: string[];
+                }[] | undefined;
+                postImportActions?: {
+                    action: string;
+                    params: (string | Record<string, any>)[];
+                }[] | undefined;
+            }[];
+            type?: "create" | "update" | undefined;
+            basePath?: string | undefined;
+            idMappings?: {
+                sourceField: string;
+                targetField: string;
+                targetCollection: string;
+                fieldToSet?: string | undefined;
+                targetFieldToMatch?: string | undefined;
+            }[] | undefined;
+            createUsers?: boolean | null | undefined;
+            updateMapping?: {
+                originalIdField: string;
+                targetField: string;
+            } | undefined;
+        }[];
+        $id?: string | undefined;
+        enabled?: boolean | undefined;
+        documentSecurity?: boolean | undefined;
+        databaseId?: string | undefined;
+        tableId?: string | undefined;
+    }[] | undefined;
+    functions?: {
+        $id: string;
+        name: string;
+        runtime: any;
+        execute: string[];
+        events: string[];
+        dirPath?: string | undefined;
+        schedule?: string | undefined;
+        timeout?: number | undefined;
+        enabled?: boolean | undefined;
+        logging?: boolean | undefined;
+        ignore?: string[] | undefined;
+        entrypoint?: string | undefined;
+        predeployCommands?: string[] | undefined;
+        deployDir?: string | undefined;
+        commands?: string | undefined;
+        scopes?: string[] | undefined;
+        installationId?: string | undefined;
+        providerRepositoryId?: string | undefined;
+        providerBranch?: string | undefined;
+        providerSilentMode?: boolean | undefined;
+        providerRootDirectory?: string | undefined;
+        templateRepository?: string | undefined;
+        templateOwner?: string | undefined;
+        templateRootDirectory?: string | undefined;
+        templateVersion?: string | undefined;
+        specification?: string | undefined;
+    }[] | undefined;
+    schemaConfig?: {
+        outputDirectory: string;
+        yamlSchemaDirectory: string;
+        importDirectory: string;
+        collectionsDirectory: string;
+        tablesDirectory: string;
+    } | undefined;
+}>;
+/**
+ * Example 5: Backward compatibility - no changes to existing calls
+ */
+export declare function existingUsageStillWorks(configDir: string): Promise<{
+    appwriteEndpoint: string;
+    appwriteProject: string;
+    appwriteKey: string;
+    appwriteClient: any;
+    authMethod: "session" | "apikey" | "auto";
+    logging: {
+        enabled: boolean;
+        level: "error" | "warn" | "info" | "debug";
+        console: boolean;
+        logDirectory?: string | undefined;
+    };
+    enableBackups: boolean;
+    backupInterval: number;
+    backupRetention: number;
+    enableBackupCleanup: boolean;
+    enableMockData: boolean;
+    documentBucketId: string;
+    usersCollectionName: string;
+    useMigrations: boolean;
+    databases: {
+        $id: string;
+        name: string;
+        bucket?: {
+            $id: string;
+            name: string;
+            permissions?: ({
+                permission: string;
+                target: string;
+            } | {
+                permission: string;
+                target: string;
+            })[] | undefined;
+            fileSecurity?: boolean | undefined;
+            enabled?: boolean | undefined;
+            maximumFileSize?: number | undefined;
+            allowedFileExtensions?: string[] | undefined;
+            compression?: "none" | "gzip" | "zstd" | undefined;
+            encryption?: boolean | undefined;
+            antivirus?: boolean | undefined;
+        } | undefined;
+    }[];
+    buckets: {
+        $id: string;
+        name: string;
+        permissions?: ({
+            permission: string;
+            target: string;
+        } | {
+            permission: string;
+            target: string;
+        })[] | undefined;
+        fileSecurity?: boolean | undefined;
+        enabled?: boolean | undefined;
+        maximumFileSize?: number | undefined;
+        allowedFileExtensions?: string[] | undefined;
+        compression?: "none" | "gzip" | "zstd" | undefined;
+        encryption?: boolean | undefined;
+        antivirus?: boolean | undefined;
+    }[];
+    apiMode: "auto" | "legacy" | "tablesdb";
+    sessionCookie?: string | undefined;
+    sessionMetadata?: {
+        email?: string | undefined;
+        expiresAt?: string | undefined;
+    } | undefined;
+    collections?: {
+        name: string;
+        attributes: ({
+            key: string;
+            type: "string";
+            size: number;
+            error?: string | undefined;
+            required?: boolean | undefined;
+            array?: boolean | undefined;
+            xdefault?: string | null | undefined;
+            encrypted?: boolean | undefined;
+            format?: string | null | undefined;
+        } | {
+            key: string;
+            type: "integer";
+            error?: string | undefined;
+            required?: boolean | undefined;
+            array?: boolean | undefined;
+            min?: number | undefined;
+            max?: number | undefined;
+            xdefault?: number | null | undefined;
+        } | {
+            key: string;
+            type: "double";
+            error?: string | undefined;
+            required?: boolean | undefined;
+            array?: boolean | undefined;
+            min?: number | undefined;
+            max?: number | undefined;
+            xdefault?: number | null | undefined;
+        } | {
+            key: string;
+            type: "float";
+            error?: string | undefined;
+            required?: boolean | undefined;
+            array?: boolean | undefined;
+            min?: number | undefined;
+            max?: number | undefined;
+            xdefault?: number | null | undefined;
+        } | {
+            key: string;
+            type: "boolean";
+            error?: string | undefined;
+            required?: boolean | undefined;
+            array?: boolean | undefined;
+            xdefault?: boolean | null | undefined;
+        } | {
+            key: string;
+            type: "datetime";
+            error?: string | undefined;
+            required?: boolean | undefined;
+            array?: boolean | undefined;
+            xdefault?: string | null | undefined;
+        } | {
+            key: string;
+            type: "email";
+            error?: string | undefined;
+            required?: boolean | undefined;
+            array?: boolean | undefined;
+            xdefault?: string | null | undefined;
+        } | {
+            key: string;
+            type: "ip";
+            error?: string | undefined;
+            required?: boolean | undefined;
+            array?: boolean | undefined;
+            xdefault?: string | null | undefined;
+        } | {
+            key: string;
+            type: "url";
+            error?: string | undefined;
+            required?: boolean | undefined;
+            array?: boolean | undefined;
+            xdefault?: string | null | undefined;
+        } | {
+            key: string;
+            type: "enum";
+            elements: string[];
+            error?: string | undefined;
+            required?: boolean | undefined;
+            array?: boolean | undefined;
+            xdefault?: string | null | undefined;
+        } | {
+            key: string;
+            type: "relationship";
+            relatedCollection: string;
+            relationType: "oneToMany" | "manyToOne" | "oneToOne" | "manyToMany";
+            twoWay: boolean;
+            onDelete: "setNull" | "cascade" | "restrict";
+            error?: string | undefined;
+            required?: boolean | undefined;
+            array?: boolean | undefined;
+            twoWayKey?: string | undefined;
+            side?: "parent" | "child" | undefined;
+            importMapping?: {
+                originalIdField: string;
+                targetField?: string | undefined;
+            } | undefined;
+        })[];
+        $permissions: {
+            permission: string;
+            target: string;
+        }[];
+        indexes: {
+            key: string;
+            type: "key" | "unique" | "fulltext";
+            attributes: string[];
+            status?: string | undefined;
+            error?: string | undefined;
+            orders?: string[] | undefined;
+        }[];
+        importDefs: {
+            filePath: string;
+            primaryKeyField: string;
+            attributeMappings: {
+                targetKey: string;
+                oldKey?: string | undefined;
+                oldKeys?: string[] | undefined;
+                valueToSet?: any;
+                fileData?: {
+                    name: string;
+                    path: string;
+                } | undefined;
+                converters?: string[] | undefined;
+                validationActions?: {
+                    action: string;
+                    params: string[];
+                }[] | undefined;
+                postImportActions?: {
+                    action: string;
+                    params: (string | Record<string, any>)[];
+                }[] | undefined;
+            }[];
+            type?: "create" | "update" | undefined;
+            basePath?: string | undefined;
+            idMappings?: {
+                sourceField: string;
+                targetField: string;
+                targetCollection: string;
+                fieldToSet?: string | undefined;
+                targetFieldToMatch?: string | undefined;
+            }[] | undefined;
+            createUsers?: boolean | null | undefined;
+            updateMapping?: {
+                originalIdField: string;
+                targetField: string;
+            } | undefined;
+        }[];
+        $id?: string | undefined;
+        enabled?: boolean | undefined;
+        documentSecurity?: boolean | undefined;
+        databaseId?: string | undefined;
+    }[] | undefined;
+    tables?: {
+        attributes: ({
+            key: string;
+            type: "string";
+            size: number;
+            error?: string | undefined;
+            required?: boolean | undefined;
+            array?: boolean | undefined;
+            xdefault?: string | null | undefined;
+            encrypted?: boolean | undefined;
+            format?: string | null | undefined;
+        } | {
+            key: string;
+            type: "integer";
+            error?: string | undefined;
+            required?: boolean | undefined;
+            array?: boolean | undefined;
+            min?: number | undefined;
+            max?: number | undefined;
+            xdefault?: number | null | undefined;
+        } | {
+            key: string;
+            type: "double";
+            error?: string | undefined;
+            required?: boolean | undefined;
+            array?: boolean | undefined;
+            min?: number | undefined;
+            max?: number | undefined;
+            xdefault?: number | null | undefined;
+        } | {
+            key: string;
+            type: "float";
+            error?: string | undefined;
+            required?: boolean | undefined;
+            array?: boolean | undefined;
+            min?: number | undefined;
+            max?: number | undefined;
+            xdefault?: number | null | undefined;
+        } | {
+            key: string;
+            type: "boolean";
+            error?: string | undefined;
+            required?: boolean | undefined;
+            array?: boolean | undefined;
+            xdefault?: boolean | null | undefined;
+        } | {
+            key: string;
+            type: "datetime";
+            error?: string | undefined;
+            required?: boolean | undefined;
+            array?: boolean | undefined;
+            xdefault?: string | null | undefined;
+        } | {
+            key: string;
+            type: "email";
+            error?: string | undefined;
+            required?: boolean | undefined;
+            array?: boolean | undefined;
+            xdefault?: string | null | undefined;
+        } | {
+            key: string;
+            type: "ip";
+            error?: string | undefined;
+            required?: boolean | undefined;
+            array?: boolean | undefined;
+            xdefault?: string | null | undefined;
+        } | {
+            key: string;
+            type: "url";
+            error?: string | undefined;
+            required?: boolean | undefined;
+            array?: boolean | undefined;
+            xdefault?: string | null | undefined;
+        } | {
+            key: string;
+            type: "enum";
+            elements: string[];
+            error?: string | undefined;
+            required?: boolean | undefined;
+            array?: boolean | undefined;
+            xdefault?: string | null | undefined;
+        } | {
+            key: string;
+            type: "relationship";
+            relatedCollection: string;
+            relationType: "oneToMany" | "manyToOne" | "oneToOne" | "manyToMany";
+            twoWay: boolean;
+            onDelete: "setNull" | "cascade" | "restrict";
+            error?: string | undefined;
+            required?: boolean | undefined;
+            array?: boolean | undefined;
+            twoWayKey?: string | undefined;
+            side?: "parent" | "child" | undefined;
+            importMapping?: {
+                originalIdField: string;
+                targetField?: string | undefined;
+            } | undefined;
+        })[];
+        columns: undefined;
+        indexes: {
+            key: string;
+            type: "key" | "unique" | "fulltext";
+            attributes: string[];
+            status?: string | undefined;
+            error?: string | undefined;
+            orders?: string[] | undefined;
+        }[];
+        name: string;
+        $permissions: {
+            permission: string;
+            target: string;
+        }[];
+        importDefs: {
+            filePath: string;
+            primaryKeyField: string;
+            attributeMappings: {
+                targetKey: string;
+                oldKey?: string | undefined;
+                oldKeys?: string[] | undefined;
+                valueToSet?: any;
+                fileData?: {
+                    name: string;
+                    path: string;
+                } | undefined;
+                converters?: string[] | undefined;
+                validationActions?: {
+                    action: string;
+                    params: string[];
+                }[] | undefined;
+                postImportActions?: {
+                    action: string;
+                    params: (string | Record<string, any>)[];
+                }[] | undefined;
+            }[];
+            type?: "create" | "update" | undefined;
+            basePath?: string | undefined;
+            idMappings?: {
+                sourceField: string;
+                targetField: string;
+                targetCollection: string;
+                fieldToSet?: string | undefined;
+                targetFieldToMatch?: string | undefined;
+            }[] | undefined;
+            createUsers?: boolean | null | undefined;
+            updateMapping?: {
+                originalIdField: string;
+                targetField: string;
+            } | undefined;
+        }[];
+        $id?: string | undefined;
+        enabled?: boolean | undefined;
+        documentSecurity?: boolean | undefined;
+        databaseId?: string | undefined;
+        tableId?: string | undefined;
+    }[] | undefined;
+    functions?: {
+        $id: string;
+        name: string;
+        runtime: any;
+        execute: string[];
+        events: string[];
+        dirPath?: string | undefined;
+        schedule?: string | undefined;
+        timeout?: number | undefined;
+        enabled?: boolean | undefined;
+        logging?: boolean | undefined;
+        ignore?: string[] | undefined;
+        entrypoint?: string | undefined;
+        predeployCommands?: string[] | undefined;
+        deployDir?: string | undefined;
+        commands?: string | undefined;
+        scopes?: string[] | undefined;
+        installationId?: string | undefined;
+        providerRepositoryId?: string | undefined;
+        providerBranch?: string | undefined;
+        providerSilentMode?: boolean | undefined;
+        providerRootDirectory?: string | undefined;
+        templateRepository?: string | undefined;
+        templateOwner?: string | undefined;
+        templateRootDirectory?: string | undefined;
+        templateVersion?: string | undefined;
+        specification?: string | undefined;
+    }[] | undefined;
+    schemaConfig?: {
+        outputDirectory: string;
+        yamlSchemaDirectory: string;
+        importDirectory: string;
+        collectionsDirectory: string;
+        tablesDirectory: string;
+    } | undefined;
+}>;