appwrite-utils-cli 0.0.70 → 0.0.72

package/README.md

@@ -132,6 +132,8 @@ This setup ensures that developers have robust tools at their fingertips to mana
 
 ### Changelog
 
+- 0.0.72: Remove `ulid` for `ulidx`, fixing compatibility issues
+- 0.0.71: Slight change to file download logic after errors
 - 0.0.70: Bump to `node-appwrite` version
 - 0.0.69: Fixed single ID not getting replaced due to the below change =D also, `nice`
 - 0.0.68: Fixed the occasional case where, when mapping ID's from old data to new, there would be an array of ID's to match against. `idMappings` now supports arrays.

package/dist/migrations/converters.d.ts

@@ -1,3 +1,4 @@
+import { type AttributeMappings } from "appwrite-utils";
 /**
  * Deeply converts all properties of an object (or array) to strings.
  * @param data The input data to convert.
@@ -28,25 +29,7 @@ export declare const convertObjectBySchema: (obj: Record<string, any>, schema: R
  * @param attributeMappings The attributeMappings defining how keys in the object should be converted.
  * @returns The converted object with keys renamed according to attributeMappings.
  */
-export declare const convertObjectByAttributeMappings: (obj: Record<string, any>, attributeMappings: {
-    targetKey: string;
-    oldKey?: string | undefined;
-    oldKeys?: string[] | undefined;
-    valueToSet?: any;
-    fileData?: {
-        path: string;
-        name: string;
-    } | undefined;
-    converters?: string[] | undefined;
-    validationActions?: {
-        params: string[];
-        action: string;
-    }[] | undefined;
-    postImportActions?: {
-        params: (string | Record<string, any>)[];
-        action: string;
-    }[] | undefined;
-}[]) => Record<string, any>;
+export declare const convertObjectByAttributeMappings: (obj: Record<string, any>, attributeMappings: AttributeMappings) => Record<string, any>;
 /**
  * Ensures data conversion without mutating the original input.
  * @param data The data to convert.

package/dist/migrations/dataLoader.d.ts

@@ -74,15 +74,6 @@ export declare const CollectionImportDataSchema: z.ZodObject<{
             error?: string | undefined;
             xdefault?: number | null | undefined;
             min?: number | undefined;
-            /**
-             * Prepares the data for creating user collection documents.
-             * This involves loading the data, transforming it according to the import definition,
-             * and handling the creation of new unique IDs for each item.
-             *
-             * @param db - The database configuration.
-             * @param collection - The collection configuration.
-             * @param importDef - The import definition containing the attribute mappings and other relevant info.
-             */
             max?: number | undefined;
         }, {
             key: string;
@@ -683,7 +674,18 @@ export declare const CollectionImportDataSchema: z.ZodObject<{
                 }[] | undefined;
             }[];
             type?: "create" | "update" | undefined;
-            basePath?: string | undefined;
+            basePath
+            /**
+             * Generates attribute mappings with post-import actions based on the provided attribute mappings.
+             * This method checks each mapping for a fileData attribute and adds a post-import action to create a file
+             * and update the field with the file's ID if necessary.
+             *
+             * @param attributeMappings - The attribute mappings from the import definition.
+             * @param context - The context object containing information about the database, collection, and document.
+             * @param item - The item being imported, used for resolving template paths in fileData mappings.
+             * @returns The attribute mappings updated with any necessary post-import actions.
+             */
+            ?: string | undefined;
             idMappings?: {
                 sourceField: string;
                 targetField: string;
@@ -1303,7 +1305,18 @@ export declare const CollectionImportDataSchema: z.ZodObject<{
                 }[] | undefined;
             }[];
             type?: "create" | "update" | undefined;
-            basePath?: string | undefined;
+            basePath
+            /**
+             * Generates attribute mappings with post-import actions based on the provided attribute mappings.
+             * This method checks each mapping for a fileData attribute and adds a post-import action to create a file
+             * and update the field with the file's ID if necessary.
+             *
+             * @param attributeMappings - The attribute mappings from the import definition.
+             * @param context - The context object containing information about the database, collection, and document.
+             * @param item - The item being imported, used for resolving template paths in fileData mappings.
+             * @returns The attribute mappings updated with any necessary post-import actions.
+             */
+            ?: string | undefined;
             idMappings?: {
                 sourceField: string;
                 targetField: string;
@@ -1707,7 +1720,18 @@ export declare class DataLoader {
                     }[] | undefined;
                 }[];
                 type?: "create" | "update" | undefined;
-                basePath?: string | undefined;
+                basePath
+                /**
+                 * Generates attribute mappings with post-import actions based on the provided attribute mappings.
+                 * This method checks each mapping for a fileData attribute and adds a post-import action to create a file
+                 * and update the field with the file's ID if necessary.
+                 *
+                 * @param attributeMappings - The attribute mappings from the import definition.
+                 * @param context - The context object containing information about the database, collection, and document.
+                 * @param item - The item being imported, used for resolving template paths in fileData mappings.
+                 * @returns The attribute mappings updated with any necessary post-import actions.
+                 */
+                ?: string | undefined;
                 idMappings?: {
                     sourceField: string;
                     targetField: string;

package/dist/migrations/storage.js

@@ -252,9 +252,27 @@ export const transferStorageLocalToLocal = async (storage, fromBucketId, toBucke
     let fromFiles = await tryAwaitWithRetry(async () => await storage.listFiles(fromBucketId, [Query.limit(100)]));
     const allFromFiles = fromFiles.files;
     let numberOfFiles = 0;
+    const downloadFileWithRetry = async (bucketId, fileId) => {
+        let attempts = 3;
+        while (attempts > 0) {
+            try {
+                return await storage.getFileDownload(bucketId, fileId);
+            }
+            catch (error) {
+                console.error(`Error downloading file ${fileId}: ${error}`);
+                attempts--;
+                if (attempts === 0)
+                    throw error;
+            }
+        }
+    };
     if (fromFiles.files.length < 100) {
         for (const file of allFromFiles) {
-            const fileData = await tryAwaitWithRetry(async () => await storage.getFileDownload(file.bucketId, file.$id));
+            const fileData = await tryAwaitWithRetry(async () => await downloadFileWithRetry(file.bucketId, file.$id));
+            if (!fileData) {
+                console.error(`Error downloading file ${file.$id}`);
+                continue;
+            }
             const fileToCreate = InputFile.fromBuffer(Buffer.from(fileData), file.name);
             console.log(`Creating file: ${file.name}`);
             tryAwaitWithRetry(async () => await storage.createFile(toBucketId, file.$id, fileToCreate, file.$permissions));
@@ -277,7 +295,11 @@ export const transferStorageLocalToLocal = async (storage, fromBucketId, toBucke
             }
         }
         for (const file of allFromFiles) {
-            const fileData = await tryAwaitWithRetry(async () => await storage.getFileDownload(file.bucketId, file.$id));
+            const fileData = await tryAwaitWithRetry(async () => await downloadFileWithRetry(file.bucketId, file.$id));
+            if (!fileData) {
+                console.error(`Error downloading file ${file.$id}`);
+                continue;
+            }
             const fileToCreate = InputFile.fromBuffer(Buffer.from(fileData), file.name);
             await tryAwaitWithRetry(async () => await storage.createFile(toBucketId, file.$id, fileToCreate, file.$permissions));
             numberOfFiles++;

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.70",
+  "version": "0.0.72",
   "main": "src/main.ts",
   "type": "module",
   "repository": {
@@ -33,23 +33,23 @@
   },
   "dependencies": {
     "@types/inquirer": "^9.0.7",
-    "appwrite-utils": "^0.3.6",
-    "commander": "^12.0.0",
-    "inquirer": "^9.2.20",
+    "appwrite-utils": "workspace:*",
+    "commander": "^12.1.0",
+    "inquirer": "^9.3.1",
     "js-yaml": "^4.1.0",
     "lodash": "^4.17.21",
     "luxon": "^3.4.4",
     "nanostores": "^0.10.3",
     "node-appwrite": "^13.0.0",
-    "tsx": "^4.9.3",
-    "ulid": "^2.3.0",
+    "tsx": "^4.15.8",
+    "ulidx": "^2.3.0",
     "winston": "^3.13.0",
-    "zod": "^3.22.4"
+    "zod": "^3.23.8"
   },
   "devDependencies": {
     "@types/js-yaml": "^4.0.9",
-    "@types/lodash": "^4.17.0",
+    "@types/lodash": "^4.17.6",
     "@types/luxon": "^3.4.2",
-    "typescript": "^5.0.0"
+    "typescript": "^5.5.2"
   }
 }

package/src/migrations/storage.ts

@@ -388,11 +388,29 @@ export const transferStorageLocalToLocal = async (
   );
   const allFromFiles = fromFiles.files;
   let numberOfFiles = 0;
+
+  const downloadFileWithRetry = async (bucketId: string, fileId: string) => {
+    let attempts = 3;
+    while (attempts > 0) {
+      try {
+        return await storage.getFileDownload(bucketId, fileId);
+      } catch (error) {
+        console.error(`Error downloading file ${fileId}: ${error}`);
+        attempts--;
+        if (attempts === 0) throw error;
+      }
+    }
+  };
+
   if (fromFiles.files.length < 100) {
     for (const file of allFromFiles) {
       const fileData = await tryAwaitWithRetry(
-        async () => await storage.getFileDownload(file.bucketId, file.$id)
+        async () => await downloadFileWithRetry(file.bucketId, file.$id)
       );
+      if (!fileData) {
+        console.error(`Error downloading file ${file.$id}`);
+        continue;
+      }
       const fileToCreate = InputFile.fromBuffer(
         Buffer.from(fileData),
         file.name
@@ -428,8 +446,12 @@ export const transferStorageLocalToLocal = async (
     }
     for (const file of allFromFiles) {
       const fileData = await tryAwaitWithRetry(
-        async () => await storage.getFileDownload(file.bucketId, file.$id)
+        async () => await downloadFileWithRetry(file.bucketId, file.$id)
       );
+      if (!fileData) {
+        console.error(`Error downloading file ${file.$id}`);
+        continue;
+      }
       const fileToCreate = InputFile.fromBuffer(
         Buffer.from(fileData),
         file.name