appwrite-utils-cli 1.11.0 → 1.12.0

package/dist/migrations/afterImportActions.d.ts

@@ -0,0 +1,17 @@
+import { Databases, Storage, type Models } from "node-appwrite";
+import { type AppwriteConfig } from "appwrite-utils";
+export declare const getDatabaseFromConfig: (config: AppwriteConfig) => Databases;
+export declare const getStorageFromConfig: (config: AppwriteConfig) => Storage;
+export declare const afterImportActions: {
+    updateCreatedDocument: (config: AppwriteConfig, dbId: string, collId: string, docId: string, data: any) => Promise<void>;
+    checkAndUpdateFieldInDocument: (config: AppwriteConfig, dbId: string, collId: string, docId: string, fieldName: string, oldFieldValue: any, newFieldValue: any) => Promise<void>;
+    setFieldFromOtherCollectionDocument: (config: AppwriteConfig, dbId: string, collIdOrName: string, docId: string, fieldName: string, otherCollIdOrName: string, otherDocId: string, otherFieldName: string) => Promise<void>;
+    /**
+     * Updates a field in a document by setting it with document IDs from another collection
+     * based on a matching field value.
+     */
+    setFieldFromOtherCollectionDocuments: (config: AppwriteConfig, dbId: string, collIdOrName: string, docId: string, fieldName: string, otherCollIdOrName: string, matchingFieldName: string, matchingFieldValue: any, fieldToSet?: string) => Promise<void>;
+    setTargetFieldFromOtherCollectionDocumentsByMatchingField: (config: AppwriteConfig, dbId: string, collIdOrName: string, docId: string, fieldName: string, otherCollIdOrName: string, matchingFieldName: string, matchingFieldValue: any, targetField: string) => Promise<void>;
+    createOrGetBucket: (config: AppwriteConfig, bucketName: string, bucketId?: string, permissions?: string[], fileSecurity?: boolean, enabled?: boolean, maxFileSize?: number, allowedExtensions?: string[], compression?: string, encryption?: boolean, antivirus?: boolean) => Promise<Models.Bucket | undefined>;
+    createFileAndUpdateField: (config: AppwriteConfig, dbId: string, collId: string, docId: string, fieldName: string, bucketId: string, filePath: string, fileName: string) => Promise<void>;
+};

package/dist/migrations/afterImportActions.js

@@ -0,0 +1,305 @@
+import { Databases, Storage, Query, ID, Compression, } from "node-appwrite";
+import { InputFile } from "node-appwrite/file";
+import path from "path";
+import fs from "fs";
+import os from "os";
+import { logger, MessageFormatter } from "appwrite-utils-helpers";
+import { tryAwaitWithRetry, } from "appwrite-utils";
+import { getClientFromConfig } from "appwrite-utils-helpers";
+export const getDatabaseFromConfig = (config) => {
+    getClientFromConfig(config); // Sets config.appwriteClient if missing
+    return new Databases(config.appwriteClient);
+};
+export const getStorageFromConfig = (config) => {
+    getClientFromConfig(config); // Sets config.appwriteClient if missing
+    return new Storage(config.appwriteClient);
+};
+export const afterImportActions = {
+    updateCreatedDocument: async (config, dbId, collId, docId, data) => {
+        try {
+            const db = getDatabaseFromConfig(config);
+            await tryAwaitWithRetry(async () => await db.updateDocument(dbId, collId, docId, data));
+        }
+        catch (error) {
+            MessageFormatter.error("Error updating document", error instanceof Error ? error : new Error(String(error)), { prefix: "Import" });
+        }
+    },
+    checkAndUpdateFieldInDocument: async (config, dbId, collId, docId, fieldName, oldFieldValue, newFieldValue) => {
+        try {
+            const db = getDatabaseFromConfig(config);
+            const doc = await tryAwaitWithRetry(async () => await db.getDocument(dbId, collId, docId));
+            if (doc[fieldName] == oldFieldValue) {
+                await tryAwaitWithRetry(async () => await db.updateDocument(dbId, collId, docId, {
+                    [fieldName]: newFieldValue,
+                }));
+            }
+        }
+        catch (error) {
+            MessageFormatter.error("Error updating document", error instanceof Error ? error : new Error(String(error)), { prefix: "Import" });
+        }
+    },
+    setFieldFromOtherCollectionDocument: async (config, dbId, collIdOrName, docId, fieldName, otherCollIdOrName, otherDocId, otherFieldName) => {
+        const db = getDatabaseFromConfig(config);
+        // Helper function to find a collection ID by name or return the ID if given
+        const findCollectionId = async (collectionIdentifier) => {
+            const collectionsPulled = await tryAwaitWithRetry(async () => await db.listCollections(dbId, [
+                Query.limit(25),
+                Query.equal("name", collectionIdentifier),
+            ]));
+            if (collectionsPulled.total > 0) {
+                return collectionsPulled.collections[0].$id;
+            }
+            else {
+                // Assuming the passed identifier might directly be an ID if not found by name
+                return collectionIdentifier;
+            }
+        };
+        try {
+            // Resolve the IDs for both the target and other collections
+            const targetCollectionId = await findCollectionId(collIdOrName);
+            const otherCollectionId = await findCollectionId(otherCollIdOrName);
+            // Retrieve the "other" document
+            const otherDoc = await db.getDocument(dbId, otherCollectionId, otherDocId);
+            const valueToSet = otherDoc[otherFieldName];
+            if (valueToSet) {
+                // Update the target document
+                await tryAwaitWithRetry(async () => await db.updateDocument(dbId, targetCollectionId, docId, {
+                    [fieldName]: valueToSet,
+                }));
+            }
+            MessageFormatter.success(`Field ${fieldName} updated successfully in document ${docId}`, { prefix: "Import" });
+        }
+        catch (error) {
+            MessageFormatter.error("Error setting field from other collection document", error instanceof Error ? error : new Error(String(error)), { prefix: "Import" });
+        }
+    },
+    /**
+     * Updates a field in a document by setting it with document IDs from another collection
+     * based on a matching field value.
+     */
+    setFieldFromOtherCollectionDocuments: async (config, dbId, collIdOrName, docId, fieldName, otherCollIdOrName, matchingFieldName, matchingFieldValue, fieldToSet) => {
+        const db = getDatabaseFromConfig(config);
+        // Helper function to find a collection ID by name or return the ID if given
+        const findCollectionId = async (collectionIdentifier) => {
+            const collections = await tryAwaitWithRetry(async () => await db.listCollections(dbId, [
+                Query.equal("name", collectionIdentifier),
+                Query.limit(1),
+            ]));
+            return collections.total > 0
+                ? collections.collections[0].$id
+                : collectionIdentifier;
+        };
+        // Function to check if the target field is an array
+        const isTargetFieldArray = async (collectionId, fieldName) => {
+            const collection = await tryAwaitWithRetry(async () => await db.getCollection(dbId, collectionId));
+            const attribute = collection.attributes.find((attr) => attr.key === fieldName);
+            // @ts-ignore
+            return attribute?.array === true;
+        };
+        try {
+            const targetCollectionId = await findCollectionId(collIdOrName);
+            const otherCollectionId = await findCollectionId(otherCollIdOrName);
+            const targetFieldIsArray = await isTargetFieldArray(targetCollectionId, fieldName);
+            // Function to recursively fetch all matching documents from the other collection
+            const fetchAllMatchingDocuments = async (cursor) => {
+                const docLimit = 100;
+                const queries = targetFieldIsArray
+                    ? // @ts-ignore
+                        [Query.contains(matchingFieldName, [matchingFieldValue])]
+                    : [Query.equal(matchingFieldName, matchingFieldValue)];
+                if (cursor) {
+                    queries.push(Query.cursorAfter(cursor));
+                }
+                queries.push(Query.limit(docLimit));
+                const response = await tryAwaitWithRetry(async () => await db.listDocuments(dbId, otherCollectionId, queries));
+                const documents = response.documents;
+                if (documents.length === 0 || documents.length < docLimit) {
+                    return documents;
+                }
+                const nextCursor = documents[documents.length - 1].$id;
+                const nextBatch = await fetchAllMatchingDocuments(nextCursor);
+                return documents.concat(nextBatch);
+            };
+            const matchingDocuments = await fetchAllMatchingDocuments();
+            const documentIds = matchingDocuments.map((doc) => doc.$id);
+            if (documentIds.length > 0) {
+                const updatePayload = targetFieldIsArray
+                    ? { [fieldName]: documentIds }
+                    : { [fieldName]: documentIds[0] };
+                await tryAwaitWithRetry(async () => await db.updateDocument(dbId, targetCollectionId, docId, updatePayload));
+                MessageFormatter.success(`Field ${fieldName} updated successfully in document ${docId} with ${documentIds.length} document IDs`, { prefix: "Import" });
+            }
+        }
+        catch (error) {
+            MessageFormatter.error("Error setting field from other collection documents", error instanceof Error ? error : new Error(String(error)), { prefix: "Import" });
+        }
+    },
+    setTargetFieldFromOtherCollectionDocumentsByMatchingField: async (config, dbId, collIdOrName, docId, fieldName, otherCollIdOrName, matchingFieldName, matchingFieldValue, targetField) => {
+        const db = getDatabaseFromConfig(config);
+        const findCollectionId = async (collectionIdentifier) => {
+            const collections = await tryAwaitWithRetry(async () => await db.listCollections(dbId, [
+                Query.equal("name", collectionIdentifier),
+                Query.limit(1),
+            ]));
+            return collections.total > 0
+                ? collections.collections[0].$id
+                : collectionIdentifier;
+        };
+        const isTargetFieldArray = async (collectionId, fieldName) => {
+            const collection = await db.getCollection(dbId, collectionId);
+            const attribute = collection.attributes.find((attr) => attr.key === fieldName);
+            // @ts-ignore
+            return attribute?.array === true;
+        };
+        try {
+            const targetCollectionId = await findCollectionId(collIdOrName);
+            const otherCollectionId = await findCollectionId(otherCollIdOrName);
+            const targetFieldIsArray = await isTargetFieldArray(targetCollectionId, fieldName);
+            const fetchAllMatchingDocuments = async (cursor) => {
+                const docLimit = 100;
+                const queries = [
+                    Query.equal(matchingFieldName, matchingFieldValue),
+                    Query.limit(docLimit),
+                ];
+                if (cursor) {
+                    queries.push(Query.cursorAfter(cursor));
+                }
+                const response = await tryAwaitWithRetry(async () => await db.listDocuments(dbId, otherCollectionId, queries));
+                const documents = response.documents;
+                if (documents.length === 0 || documents.length < docLimit) {
+                    return documents;
+                }
+                const nextCursor = documents[documents.length - 1].$id;
+                const nextBatch = await fetchAllMatchingDocuments(nextCursor);
+                return documents.concat(nextBatch);
+            };
+            const matchingDocuments = await fetchAllMatchingDocuments();
+            // Map the values from the targetField instead of the document IDs
+            const targetFieldValues = matchingDocuments.map((doc) => doc[targetField]);
+            if (targetFieldValues.length > 0) {
+                const updatePayload = targetFieldIsArray
+                    ? { [fieldName]: targetFieldValues }
+                    : { [fieldName]: targetFieldValues[0] };
+                await tryAwaitWithRetry(async () => await db.updateDocument(dbId, targetCollectionId, docId, updatePayload));
+                MessageFormatter.success(`Field ${fieldName} updated successfully in document ${docId} with values from field ${targetField}`, { prefix: "Import" });
+            }
+        }
+        catch (error) {
+            MessageFormatter.error("Error setting field from other collection documents", error instanceof Error ? error : new Error(String(error)), { prefix: "Import" });
+        }
+    },
+    createOrGetBucket: async (config, bucketName, bucketId, permissions, fileSecurity, enabled, maxFileSize, allowedExtensions, compression, encryption, antivirus) => {
+        try {
+            const storage = getStorageFromConfig(config);
+            const bucket = await tryAwaitWithRetry(async () => await storage.listBuckets([Query.equal("name", bucketName)]));
+            if (bucket.buckets.length > 0) {
+                return bucket.buckets[0];
+            }
+            else if (bucketId) {
+                try {
+                    return await tryAwaitWithRetry(async () => await storage.getBucket(bucketId));
+                }
+                catch (error) {
+                    return await tryAwaitWithRetry(async () => await storage.createBucket(bucketId, bucketName, permissions, fileSecurity, enabled, maxFileSize, allowedExtensions, compression ? Compression.Gzip : undefined, encryption, antivirus));
+                }
+            }
+            else {
+                return await tryAwaitWithRetry(async () => await storage.createBucket(bucketId || ID.unique(), bucketName, permissions, fileSecurity, enabled, maxFileSize, allowedExtensions, compression ? Compression.Gzip : undefined, encryption, antivirus));
+            }
+        }
+        catch (error) {
+            MessageFormatter.error("Error creating or getting bucket", error instanceof Error ? error : new Error(String(error)), { prefix: "Import" });
+        }
+    },
+    createFileAndUpdateField: async (config, dbId, collId, docId, fieldName, bucketId, filePath, fileName) => {
+        try {
+            const db = getDatabaseFromConfig(config);
+            const storage = getStorageFromConfig(config);
+            const collection = await tryAwaitWithRetry(async () => await db.getCollection(dbId, collId));
+            const attributes = collection.attributes;
+            const attribute = attributes.find((a) => a.key === fieldName);
+            // console.log(
+            //   `Processing field ${fieldName} in collection ${collId} for document ${docId} in database ${dbId} in bucket ${bucketId} with path ${filePath} and name ${fileName}...`
+            // );
+            if (filePath.length === 0 || fileName.length === 0) {
+                MessageFormatter.error(`File path or name is empty for field ${fieldName} in collection ${collId}, skipping...`, undefined, { prefix: "Import" });
+                return;
+            }
+            let isArray = false;
+            if (!attribute) {
+                MessageFormatter.warning(`Field ${fieldName} not found in collection ${collId}, weird, skipping...`, { prefix: "Import" });
+                return;
+            }
+            else if (attribute.array === true) {
+                isArray = true;
+            }
+            // Define a helper function to check if a value is a URL
+            const isUrl = (value) => typeof value === "string" &&
+                (value.startsWith("http://") || value.startsWith("https://"));
+            const doc = await tryAwaitWithRetry(async () => await db.getDocument(dbId, collId, docId));
+            const existingFieldValue = doc[fieldName];
+            // Handle the case where the field is an array
+            let updateData = isArray ? [] : "";
+            if (isArray && Array.isArray(existingFieldValue)) {
+                updateData = existingFieldValue.filter((val) => !isUrl(val)); // Remove URLs from the array
+            }
+            // Process file upload and update logic
+            if (isUrl(filePath)) {
+                // Create a temporary directory
+                const tempDir = fs.mkdtempSync(path.join(os.tmpdir(), "appwrite_tmp"));
+                const tempFilePath = path.join(tempDir, fileName);
+                // Download the file using fetch
+                const response = await tryAwaitWithRetry(async () => await fetch(filePath));
+                if (!response.ok)
+                    MessageFormatter.error(`Failed to fetch ${filePath}: ${response.statusText} for document ${docId} with field ${fieldName}`, undefined, { prefix: "Import" });
+                // Use arrayBuffer if buffer is not available
+                const arrayBuffer = await response.arrayBuffer();
+                const buffer = Buffer.from(arrayBuffer);
+                fs.writeFileSync(tempFilePath, new Uint8Array(buffer));
+                // Create InputFile from the downloaded file
+                const inputFile = InputFile.fromPath(tempFilePath, fileName);
+                // Use the full file name (with extension) for creating the file
+                const file = await tryAwaitWithRetry(async () => await storage.createFile(bucketId, ID.unique(), inputFile));
+                MessageFormatter.success(`Created file from URL: ${file.$id}`, { prefix: "Import" });
+                // After uploading, adjust the updateData based on whether the field is an array or not
+                if (isArray) {
+                    updateData = [...updateData, file.$id]; // Append the new file ID
+                }
+                else {
+                    updateData = file.$id; // Set the new file ID
+                }
+                await tryAwaitWithRetry(async () => await db.updateDocument(dbId, collId, doc.$id, {
+                    [fieldName]: updateData,
+                }));
+                // If the file was downloaded, delete it after uploading
+                fs.unlinkSync(tempFilePath);
+            }
+            else {
+                const files = fs.readdirSync(filePath);
+                const fileFullName = files.find((file) => file.includes(fileName));
+                if (!fileFullName) {
+                    MessageFormatter.error(`File starting with '${fileName}' not found in '${filePath}'`, undefined, { prefix: "Import" });
+                    return;
+                }
+                const pathToFile = path.join(filePath, fileFullName);
+                const inputFile = InputFile.fromPath(pathToFile, fileName);
+                const file = await tryAwaitWithRetry(async () => await storage.createFile(bucketId, ID.unique(), inputFile));
+                if (isArray) {
+                    updateData = [...updateData, file.$id]; // Append the new file ID
+                }
+                else {
+                    updateData = file.$id; // Set the new file ID
+                }
+                tryAwaitWithRetry(async () => await db.updateDocument(dbId, collId, doc.$id, {
+                    [fieldName]: updateData,
+                }));
+                MessageFormatter.success(`Created file from path: ${file.$id}`, { prefix: "Import" });
+            }
+        }
+        catch (error) {
+            logger.error(`Error creating file and updating field, params were:\ndbId: ${dbId}, collId: ${collId}, docId: ${docId}, fieldName: ${fieldName}, filePath: ${filePath}, fileName: ${fileName}\n\nError: ${error}`);
+            MessageFormatter.error("Error creating file and updating field", error instanceof Error ? error : new Error(String(error)), { prefix: "Import" });
+            MessageFormatter.info(`Params were: dbId: ${dbId}, collId: ${collId}, docId: ${docId}, fieldName: ${fieldName}, filePath: ${filePath}, fileName: ${fileName}`, { prefix: "Import" });
+        }
+    },
+};

package/dist/migrations/appwriteToX.d.ts

@@ -0,0 +1,211 @@
+import { Storage, type Models } from "node-appwrite";
+import { type AppwriteConfig } from "appwrite-utils";
+import type { DatabaseAdapter } from "appwrite-utils-helpers";
+import type { DatabaseSelection, BucketSelection } from "../shared/selectionDialogs.js";
+export declare class AppwriteToX {
+    config: AppwriteConfig;
+    storage: Storage;
+    updatedConfig: AppwriteConfig;
+    collToAttributeMap: Map<string, ({
+        key: string;
+        required: boolean;
+        type: "string";
+        size: number;
+        array?: boolean | undefined;
+        format?: string | undefined;
+        status?: string | undefined;
+        attributes?: string[] | undefined;
+        orders?: string[] | undefined;
+        $createdAt?: string | undefined;
+        $updatedAt?: string | undefined;
+        error?: string | undefined;
+        xdefault?: string | null | undefined;
+        encrypt?: boolean | undefined;
+    } | {
+        key: string;
+        required: boolean;
+        type: "integer";
+        array?: boolean | undefined;
+        format?: string | undefined;
+        status?: string | undefined;
+        attributes?: string[] | undefined;
+        orders?: string[] | undefined;
+        $createdAt?: string | undefined;
+        $updatedAt?: string | undefined;
+        error?: string | undefined;
+        min?: number | undefined;
+        max?: number | undefined;
+        xdefault?: number | null | undefined;
+    } | {
+        key: string;
+        required: boolean;
+        type: "double";
+        array?: boolean | undefined;
+        format?: string | undefined;
+        status?: string | undefined;
+        attributes?: string[] | undefined;
+        orders?: string[] | undefined;
+        $createdAt?: string | undefined;
+        $updatedAt?: string | undefined;
+        error?: string | undefined;
+        min?: number | undefined;
+        max?: number | undefined;
+        xdefault?: number | null | undefined;
+    } | {
+        key: string;
+        required: boolean;
+        type: "float";
+        array?: boolean | undefined;
+        format?: string | undefined;
+        status?: string | undefined;
+        attributes?: string[] | undefined;
+        orders?: string[] | undefined;
+        $createdAt?: string | undefined;
+        $updatedAt?: string | undefined;
+        error?: string | undefined;
+        min?: number | undefined;
+        max?: number | undefined;
+        xdefault?: number | null | undefined;
+    } | {
+        key: string;
+        required: boolean;
+        type: "boolean";
+        array?: boolean | undefined;
+        format?: string | undefined;
+        status?: string | undefined;
+        attributes?: string[] | undefined;
+        orders?: string[] | undefined;
+        $createdAt?: string | undefined;
+        $updatedAt?: string | undefined;
+        error?: string | undefined;
+        xdefault?: boolean | null | undefined;
+    } | {
+        key: string;
+        required: boolean;
+        type: "datetime";
+        array?: boolean | undefined;
+        format?: string | undefined;
+        status?: string | undefined;
+        attributes?: string[] | undefined;
+        orders?: string[] | undefined;
+        $createdAt?: string | undefined;
+        $updatedAt?: string | undefined;
+        error?: string | undefined;
+        xdefault?: string | null | undefined;
+    } | {
+        key: string;
+        required: boolean;
+        type: "email";
+        array?: boolean | undefined;
+        format?: string | undefined;
+        status?: string | undefined;
+        attributes?: string[] | undefined;
+        orders?: string[] | undefined;
+        $createdAt?: string | undefined;
+        $updatedAt?: string | undefined;
+        error?: string | undefined;
+        xdefault?: string | null | undefined;
+    } | {
+        key: string;
+        required: boolean;
+        type: "ip";
+        array?: boolean | undefined;
+        format?: string | undefined;
+        status?: string | undefined;
+        attributes?: string[] | undefined;
+        orders?: string[] | undefined;
+        $createdAt?: string | undefined;
+        $updatedAt?: string | undefined;
+        error?: string | undefined;
+        xdefault?: string | null | undefined;
+    } | {
+        key: string;
+        required: boolean;
+        type: "url";
+        array?: boolean | undefined;
+        format?: string | undefined;
+        status?: string | undefined;
+        attributes?: string[] | undefined;
+        orders?: string[] | undefined;
+        $createdAt?: string | undefined;
+        $updatedAt?: string | undefined;
+        error?: string | undefined;
+        xdefault?: string | null | undefined;
+    } | {
+        key: string;
+        required: boolean;
+        type: "enum";
+        elements: string[];
+        array?: boolean | undefined;
+        format?: string | undefined;
+        status?: string | undefined;
+        attributes?: string[] | undefined;
+        orders?: string[] | undefined;
+        $createdAt?: string | undefined;
+        $updatedAt?: string | undefined;
+        error?: string | undefined;
+        xdefault?: string | null | undefined;
+    } | {
+        key: string;
+        required: boolean;
+        type: "relationship";
+        relatedCollection: string;
+        relationType: "oneToMany" | "manyToOne" | "oneToOne" | "manyToMany";
+        twoWay: boolean;
+        onDelete: "setNull" | "cascade" | "restrict";
+        array?: boolean | undefined;
+        format?: string | undefined;
+        status?: string | undefined;
+        attributes?: string[] | undefined;
+        orders?: string[] | undefined;
+        $createdAt?: string | undefined;
+        $updatedAt?: string | undefined;
+        error?: string | undefined;
+        twoWayKey?: string | undefined;
+        side?: "parent" | "child" | undefined;
+        importMapping?: {
+            originalIdField: string;
+            targetField?: string | undefined;
+        } | undefined;
+    })[]>;
+    appwriteFolderPath: string;
+    adapter?: DatabaseAdapter;
+    apiMode?: 'legacy' | 'tablesdb';
+    databaseApiModes: Map<string, "legacy" | "tablesdb">;
+    constructor(config: AppwriteConfig, appwriteFolderPath: string, storage: Storage);
+    /**
+     * Initialize adapter for database operations with API mode detection
+     */
+    private initializeAdapter;
+    private ensureClientInitialized;
+    parsePermissionString: (permissionString: string) => {
+        permission: string;
+        target: string;
+    };
+    parsePermissionsArray: (permissions: string[]) => ({
+        permission: string;
+        target: string;
+    } | {
+        permission: string;
+        target: string;
+    })[];
+    updateCollectionConfigAttributes: (collection: Models.Collection) => void;
+    /**
+     * Fetch collections/tables using the appropriate adapter or legacy client
+     */
+    private fetchCollectionsOrTables;
+    /**
+     * Get collection/table using the appropriate adapter or legacy client
+     */
+    private getCollectionOrTable;
+    /**
+     * Detect API mode for a specific database by testing adapter capabilities
+     */
+    private detectDatabaseApiMode;
+    /**
+     * Get API mode context for schema generation
+     */
+    private getSchemaGeneratorApiContext;
+    appwriteSync(config: AppwriteConfig, databases?: Models.Database[], databaseSelections?: DatabaseSelection[], bucketSelections?: BucketSelection[]): Promise<void>;
+    toSchemas(databases?: Models.Database[], databaseSelections?: DatabaseSelection[], bucketSelections?: BucketSelection[]): Promise<void>;
+}