appwrite-utils-cli 0.0.4 → 0.0.5

package/README.md

@@ -77,4 +77,8 @@ This setup ensures that developers have robust tools at their fingertips to mana
 
 - Syncing configuration
 - Better file format for config (potentially)
-- Separation of collections and import configuration from main config
+- Separation of collections and import configuration from main config
+
+### Changelog
+
+- 0.0.5: Added `setFieldFromOtherCollectionDocuments` to set an array of ID's for instance from another collection as a `postImportAction`

package/dist/migrations/afterImportActions.d.ts

@@ -7,6 +7,11 @@ 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) => 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

@@ -79,6 +79,67 @@ export const afterImportActions = {
             console.error("Error setting field from other collection document: ", error);
         }
     },
+    /**
+     * 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) => {
+        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 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 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 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 db.updateDocument(dbId, targetCollectionId, docId, updatePayload);
+                console.log(`Field ${fieldName} updated successfully in document ${docId} with ${documentIds.length} document IDs.`);
+            }
+        }
+        catch (error) {
+            console.error("Error setting field from other collection documents: ", error);
+        }
+    },
     createOrGetBucket: async (config, bucketName, bucketId, permissions, fileSecurity, enabled, maxFileSize, allowedExtensions, compression, encryption, antivirus) => {
         try {
             const storage = getStorageFromConfig(config);

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "appwrite-utils-cli",
   "description": "Appwrite Utility Functions to help with database management, data conversion, data import, migrations, and much more. Meant to be used as a CLI tool, I do not recommend installing this in frontend environments.",
-  "version": "0.0.4",
+  "version": "0.0.5",
   "main": "src/main.ts",
   "type": "module",
   "repository": {

package/src/migrations/afterImportActions.ts

@@ -128,6 +128,101 @@ export const afterImportActions = {
       );
     }
   },
+  /**
+   * Updates a field in a document by setting it with document IDs from another collection
+   * based on a matching field value.
+   */
+  setFieldFromOtherCollectionDocuments: async (
+    config: AppwriteConfig,
+    dbId: string,
+    collIdOrName: string,
+    docId: string,
+    fieldName: string,
+    otherCollIdOrName: string,
+    matchingFieldName: string,
+    matchingFieldValue: any
+  ): Promise<void> => {
+    const db = getDatabaseFromConfig(config);
+
+    // Helper function to find a collection ID by name or return the ID if given
+    const findCollectionId = async (collectionIdentifier: string) => {
+      const collections = 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: string,
+      fieldName: string
+    ) => {
+      const collection = await db.getCollection(dbId, collectionId);
+      const attribute = collection.attributes.find(
+        (attr: any) => 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?: string
+      ): Promise<Models.Document[]> => {
+        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 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 db.updateDocument(dbId, targetCollectionId, docId, updatePayload);
+
+        console.log(
+          `Field ${fieldName} updated successfully in document ${docId} with ${documentIds.length} document IDs.`
+        );
+      }
+    } catch (error) {
+      console.error(
+        "Error setting field from other collection documents: ",
+        error
+      );
+    }
+  },
   createOrGetBucket: async (
     config: AppwriteConfig,
     bucketName: string,