appwrite-utils-cli 1.5.2 → 1.6.0

package/dist/config/yamlConfig.d.ts

@@ -5,14 +5,24 @@ declare const YamlConfigSchema: z.ZodObject<{
         endpoint: z.ZodDefault<z.ZodString>;
         project: z.ZodString;
         key: z.ZodString;
+        sessionCookie: z.ZodOptional<z.ZodString>;
+        authMethod: z.ZodDefault<z.ZodOptional<z.ZodEnum<{
+            session: "session";
+            apikey: "apikey";
+            auto: "auto";
+        }>>>;
+        sessionMetadata: z.ZodOptional<z.ZodObject<{
+            email: z.ZodOptional<z.ZodString>;
+            expiresAt: z.ZodOptional<z.ZodString>;
+        }, z.core.$strip>>;
     }, z.core.$strip>;
     logging: z.ZodDefault<z.ZodOptional<z.ZodObject<{
         enabled: z.ZodDefault<z.ZodBoolean>;
         level: z.ZodDefault<z.ZodEnum<{
             error: "error";
-            warn: "warn";
             info: "info";
             debug: "debug";
+            warn: "warn";
         }>>;
         directory: z.ZodOptional<z.ZodString>;
         console: z.ZodDefault<z.ZodBoolean>;
@@ -33,6 +43,7 @@ declare const YamlConfigSchema: z.ZodObject<{
         outputDirectory: z.ZodDefault<z.ZodString>;
         yamlSchemaDirectory: z.ZodDefault<z.ZodString>;
         collectionsDirectory: z.ZodDefault<z.ZodString>;
+        tablesDirectory: z.ZodDefault<z.ZodString>;
     }, z.core.$strip>>>;
     migrations: z.ZodDefault<z.ZodOptional<z.ZodObject<{
         enabled: z.ZodDefault<z.ZodBoolean>;
@@ -117,6 +128,23 @@ declare const YamlConfigSchema: z.ZodObject<{
 }, z.core.$strip>;
 export type YamlConfig = z.infer<typeof YamlConfigSchema>;
 export declare const convertYamlToAppwriteConfig: (yamlConfig: YamlConfig) => AppwriteConfig;
+/**
+ * Enhanced config loading with session authentication support
+ * Supports session override options for preserving session state
+ */
+export interface YamlSessionOptions {
+    sessionCookie?: string;
+    authMethod?: "session" | "apikey" | "auto";
+    sessionMetadata?: {
+        email?: string;
+        expiresAt?: string;
+    };
+}
+/**
+ * Load YAML config with optional session preservation
+ * Maintains authentication priority: explicit session > YAML file > system prefs
+ */
+export declare const loadYamlConfigWithSession: (configPath: string, sessionOptions?: YamlSessionOptions) => Promise<AppwriteConfig | null>;
 export declare const loadYamlConfig: (configPath: string) => Promise<AppwriteConfig | null>;
 export declare const findYamlConfig: (startDir: string) => string | null;
 export declare const generateYamlConfigTemplate: (outputPath: string) => void;
@@ -132,4 +160,430 @@ export declare const writeYamlConfig: (configPath: string, config: AppwriteConfi
  * @param newFunction The function configuration to add
  */
 export declare const addFunctionToYamlConfig: (configPath: string, newFunction: AppwriteFunction) => Promise<void>;
+/**
+ * Extract session options from AppwriteConfig for YAML operations
+ * Useful for preserving session state during config reloads
+ */
+export declare const extractSessionOptionsFromConfig: (config: AppwriteConfig) => YamlSessionOptions;
+/**
+ * Create session-preserved YAML config operations
+ * Maintains authentication state during config file updates
+ */
+export declare const createSessionPreservingYamlConfig: (configPath: string, sessionOptions: YamlSessionOptions) => {
+    load: () => 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;
+        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;
+    } | null>;
+    write: (config: AppwriteConfig) => Promise<void>;
+    addFunction: (func: AppwriteFunction) => Promise<void>;
+};
+/**
+ * Determine if YAML config has session authentication configured
+ */
+export declare const hasYamlSessionAuth: (configPath: string) => boolean;
 export {};