appwrite-utils-cli 0.0.281 → 0.0.284

package/README.md

@@ -24,7 +24,7 @@ npm install -g appwrite-utils-cli
 However, due to the nature of the speed at which I am developing this project, I would recommend the following command:
 
 ```bash
-npx --package=appwrite-utils-cli@latest appwrite-migrate -- --arg1 --arg2 --arg3
+npx --package=appwrite-utils-cli@latest appwrite-migrate --arg1 --arg2 --arg3
 ```
 
 **DO NOT INSTALL THIS LOCALLY INTO YOUR PROJECT, IT IS MEANT TO BE USED AS A COMMAND LINE TOOL ONLY**

package/dist/main.js

@@ -34,7 +34,8 @@ program.on("--help", () => {
 });
 // Parse and handle options
 program.action(async (options) => {
-    const controller = new UtilsController();
+    const currentUserDir = process.cwd();
+    const controller = new UtilsController(currentUserDir);
     try {
         // Convert Commander options to the format expected by UtilsController
         const setupOptions = {
@@ -55,6 +56,7 @@ program.action(async (options) => {
             project: options.project,
             key: options.key,
         };
+        console.log("Running operation...", setupOptions);
         await controller.run(setupOptions);
         console.log("Operation completed successfully.");
     }

package/dist/migrations/appwriteToX.js

@@ -2,7 +2,7 @@ import { SchemaGenerator } from "./schemaStrings.js";
 import { Databases, Query } from "node-appwrite";
 import { fetchAllCollections } from "./collections.js";
 import { fetchAllDatabases } from "./databases.js";
-import { CollectionSchema, attributeSchema, AppwriteConfigSchema, permissionsSchema, attributesSchema, indexesSchema, } from "appwrite-utils";
+import { CollectionSchema, attributeSchema, AppwriteConfigSchema, permissionsSchema, attributesSchema, indexesSchema, parseAttribute, } from "appwrite-utils";
 import { getDatabaseFromConfig } from "./afterImportActions.js";
 export class AppwriteToX {
     config;
@@ -27,6 +27,9 @@ export class AppwriteToX {
     };
     // Function to parse an array of permission strings
     parsePermissionsArray = (permissions) => {
+        if (permissions.length === 0) {
+            return [];
+        }
         const parsedPermissions = permissionsSchema.parse(permissions);
         // Validate the parsed permissions using Zod
         return parsedPermissions ?? [];
@@ -51,22 +54,20 @@ export class AppwriteToX {
             }
             const collections = await fetchAllCollections(database.$id, db);
             // Loop through each collection in the current database
+            if (!updatedConfig.collections) {
+                updatedConfig.collections = [];
+            }
             for (const collection of collections) {
-                if (!updatedConfig.collections) {
-                    updatedConfig.collections = [];
-                }
+                console.log(`Processing collection: ${collection.name}`);
                 const existingCollectionIndex = updatedConfig.collections.findIndex((c) => c.name === collection.name);
+                console.log(`Parsing permissions...`);
                 // Parse the collection permissions and attributes
                 const collPermissions = this.parsePermissionsArray(collection.$permissions);
-                const collAttributes = attributesSchema
-                    .parse(collection.attributes.map((attr) => {
-                    if (attr.type === "string" &&
-                        attr.format &&
-                        attr.format.length > 0) {
-                        return { ...attr, type: attr.format };
-                    }
-                    return attr;
-                }))
+                console.log(`Parsing attributes...`, collection.attributes);
+                const collAttributes = collection.attributes
+                    .map((attr) => {
+                    return parseAttribute(attr);
+                })
                     .filter((attribute) => attribute.type === "relationship"
                     ? attribute.side !== "child"
                     : true);
@@ -86,7 +87,16 @@ export class AppwriteToX {
                     }
                 }
                 this.collToAttributeMap.set(collection.name, collAttributes);
-                const collIndexes = indexesSchema.parse(collection.indexes);
+                const finalIndexes = collection.indexes.map((index) => {
+                    return {
+                        ...index,
+                        orders: index.orders?.filter((order) => {
+                            return order !== null && order;
+                        }),
+                    };
+                });
+                console.log(`Parsing indexes...`, finalIndexes);
+                const collIndexes = indexesSchema.parse(finalIndexes) ?? [];
                 // Prepare the collection object to be added or updated
                 const collToPush = CollectionSchema.parse({
                     $id: collection.$id,

package/dist/migrations/backup.d.ts

@@ -280,6 +280,14 @@ export declare const getMigrationCollectionSchemas: () => {
                 permission: string;
                 target: string;
             }[];
+            indexes: {
+                type: "key" | "unique" | "fulltext";
+                key: string;
+                attributes: string[];
+                status?: string | undefined;
+                error?: string | undefined;
+                orders?: string[] | undefined;
+            }[];
             importDefs: {
                 filePath: string;
                 primaryKeyField: string;
@@ -317,14 +325,6 @@ export declare const getMigrationCollectionSchemas: () => {
             description?: string | undefined;
             enabled?: boolean | undefined;
             documentSecurity?: boolean | undefined;
-            indexes?: {
-                type: "key" | "unique" | "fulltext";
-                key: string;
-                attributes: string[];
-                status?: string | undefined;
-                error?: string | undefined;
-                orders?: string[] | undefined;
-            }[] | undefined;
             databaseId?: string | undefined;
         };
         attributes: ({
@@ -532,6 +532,14 @@ export declare const getMigrationCollectionSchemas: () => {
                 permission: string;
                 target: string;
             }[];
+            indexes: {
+                type: "key" | "unique" | "fulltext";
+                key: string;
+                attributes: string[];
+                status?: string | undefined;
+                error?: string | undefined;
+                orders?: string[] | undefined;
+            }[];
             importDefs: {
                 filePath: string;
                 primaryKeyField: string;
@@ -569,14 +577,6 @@ export declare const getMigrationCollectionSchemas: () => {
             description?: string | undefined;
             enabled?: boolean | undefined;
             documentSecurity?: boolean | undefined;
-            indexes?: {
-                type: "key" | "unique" | "fulltext";
-                key: string;
-                attributes: string[];
-                status?: string | undefined;
-                error?: string | undefined;
-                orders?: string[] | undefined;
-            }[] | undefined;
             databaseId?: string | undefined;
         };
         attributes: ({

package/dist/migrations/dataLoader.d.ts

@@ -319,7 +319,7 @@ export declare const CollectionImportDataSchema: z.ZodObject<{
                 targetField?: string | undefined;
             } | undefined;
         }>]>, "many">>;
-        indexes: z.ZodOptional<z.ZodDefault<z.ZodArray<z.ZodObject<{
+        indexes: z.ZodEffects<z.ZodDefault<z.ZodOptional<z.ZodArray<z.ZodObject<{
             key: z.ZodString;
             type: z.ZodDefault<z.ZodOptional<z.ZodEnum<["key", "unique", "fulltext"]>>>;
             status: z.ZodOptional<z.ZodString>;
@@ -340,7 +340,21 @@ export declare const CollectionImportDataSchema: z.ZodObject<{
             status?: string | undefined;
             error?: string | undefined;
             orders?: string[] | undefined;
-        }>, "many">>>;
+        }>, "many">>>, {
+            type: "key" | "unique" | "fulltext";
+            key: string;
+            attributes: string[];
+            status?: string | undefined;
+            error?: string | undefined;
+            orders?: string[] | undefined;
+        }[], {
+            key: string;
+            attributes: string[];
+            type?: "key" | "unique" | "fulltext" | undefined;
+            status?: string | undefined;
+            error?: string | undefined;
+            orders?: string[] | undefined;
+        }[] | undefined>;
         importDefs: z.ZodDefault<z.ZodOptional<z.ZodArray<z.ZodObject<{
             type: z.ZodOptional<z.ZodDefault<z.ZodEnum<["create", "update"]>>>;
             filePath: z.ZodString;
@@ -615,6 +629,14 @@ export declare const CollectionImportDataSchema: z.ZodObject<{
             permission: string;
             target: string;
         }[];
+        indexes: {
+            type: "key" | "unique" | "fulltext";
+            key: string;
+            attributes: string[];
+            status?: string | undefined;
+            error?: string | undefined;
+            orders?: string[] | undefined;
+        }[];
         importDefs: {
             filePath: string;
             primaryKeyField: string;
@@ -652,14 +674,6 @@ export declare const CollectionImportDataSchema: z.ZodObject<{
         description?: string | undefined;
         enabled?: boolean | undefined;
         documentSecurity?: boolean | undefined;
-        indexes?: {
-            type: "key" | "unique" | "fulltext";
-            key: string;
-            attributes: string[];
-            status?: string | undefined;
-            error?: string | undefined;
-            orders?: string[] | undefined;
-        }[] | undefined;
         databaseId?: string | undefined;
     }, {
         name: string;
@@ -1207,6 +1221,14 @@ export declare const CollectionImportDataSchema: z.ZodObject<{
             permission: string;
             target: string;
         }[];
+        indexes: {
+            type: "key" | "unique" | "fulltext";
+            key: string;
+            attributes: string[];
+            status?: string | undefined;
+            error?: string | undefined;
+            orders?: string[] | undefined;
+        }[];
         importDefs: {
             filePath: string;
             primaryKeyField: string;
@@ -1244,14 +1266,6 @@ export declare const CollectionImportDataSchema: z.ZodObject<{
         description?: string | undefined;
         enabled?: boolean | undefined;
         documentSecurity?: boolean | undefined;
-        indexes?: {
-            type: "key" | "unique" | "fulltext";
-            key: string;
-            attributes: string[];
-            status?: string | undefined;
-            error?: string | undefined;
-            orders?: string[] | undefined;
-        }[] | undefined;
         databaseId?: string | undefined;
     } | undefined;
 }, {
@@ -1599,6 +1613,14 @@ export declare class DataLoader {
                 permission: string;
                 target: string;
             }[];
+            indexes: {
+                type: "key" | "unique" | "fulltext";
+                key: string;
+                attributes: string[];
+                status?: string | undefined;
+                error?: string | undefined;
+                orders?: string[] | undefined;
+            }[];
             importDefs: {
                 filePath: string;
                 primaryKeyField: string;
@@ -1636,14 +1658,6 @@ export declare class DataLoader {
             description?: string | undefined;
             enabled?: boolean | undefined;
             documentSecurity?: boolean | undefined;
-            indexes?: {
-                type: "key" | "unique" | "fulltext";
-                key: string;
-                attributes: string[];
-                status?: string | undefined;
-                error?: string | undefined;
-                orders?: string[] | undefined;
-            }[] | undefined;
             databaseId?: string | undefined;
         } | undefined;
     }>;

package/dist/migrations/schemaStrings.js

@@ -69,9 +69,14 @@ export class SchemaGenerator {
                     }
                     else if (Array.isArray(value)) {
                         // If the value is an array, join it with commas
-                        return `${key}: [${value
-                            .map((item) => `"${item}"`)
-                            .join(", ")}]`;
+                        if (value.length > 0) {
+                            return `${key}: [${value
+                                .map((item) => `"${item}"`)
+                                .join(", ")}]`;
+                        }
+                        else {
+                            return `${key}: []`;
+                        }
                     }
                     else {
                         // If the value is not a string (e.g., boolean or number), output it directly
@@ -88,7 +93,10 @@ export class SchemaGenerator {
                 const formattedAttributes = index.attributes
                     .map((attr) => `"${attr}"`)
                     .join(", ");
-                return `{ key: "${index.key}", type: "${index.type}", attributes: [${formattedAttributes}] }`;
+                return `{ key: "${index.key}", type: "${index.type}", attributes: [${formattedAttributes}], orders: [${index.orders
+                    ?.filter((order) => order !== null)
+                    .map((order) => `"${order}"`)
+                    .join(", ") ?? ""}] }`;
             }) ?? []).join(",\n    ")}
     ]
   };

package/dist/utils/loadConfigs.js

@@ -8,9 +8,12 @@ import { register } from "tsx/esm/api"; // Import the register function
  * @returns The path to the file if found, or null if not found.
  */
 export const findAppwriteConfig = (dir) => {
+    if (dir === "node_modules") {
+        return null;
+    }
     const files = fs.readdirSync(dir, { withFileTypes: true });
     for (const file of files) {
-        if (file.isDirectory()) {
+        if (file.isDirectory() && file.name !== "node_modules") {
             const result = findAppwriteConfig(path.join(dir, file.name));
             if (result)
                 return result;
@@ -30,6 +33,7 @@ export const loadConfig = async (configDir) => {
     const unregister = register(); // Register tsx enhancement
     try {
         const configPath = path.resolve(configDir, "appwriteConfig.ts");
+        console.log(`Loading config from: ${configPath}`);
         const config = (await import(configPath)).default;
         const collectionsDir = path.resolve(configDir, "collections");
         const collectionFiles = fs.readdirSync(collectionsDir);

package/dist/utilsController.d.ts

@@ -27,7 +27,7 @@ export declare class UtilsController {
     converterDefinitions: ConverterFunctions;
     validityRuleDefinitions: ValidationRules;
     afterImportActionsDefinitions: AfterImportActions;
-    constructor();
+    constructor(currentUserDir: string);
     init(setupOptions: SetupOptions): Promise<void>;
     run(options: SetupOptions): Promise<void>;
 }

package/dist/utilsController.js

@@ -22,14 +22,17 @@ export class UtilsController {
     converterDefinitions = converterFunctions;
     validityRuleDefinitions = validationRules;
     afterImportActionsDefinitions = afterImportActions;
-    constructor() {
-        const basePath = process.cwd(); // Gets the current working directory
+    constructor(currentUserDir) {
+        const basePath = currentUserDir; // Gets the current working directory
         const appwriteConfigFound = findAppwriteConfig(basePath);
         if (!appwriteConfigFound) {
             throw new Error("Failed to find appwriteConfig.ts");
         }
         this.appwriteConfigPath = appwriteConfigFound;
         this.appwriteFolderPath = path.dirname(appwriteConfigFound);
+        if (!this.appwriteFolderPath) {
+            throw new Error("Failed to get appwriteFolderPath");
+        }
     }
     // async loadCustomDefinitions(): Promise<void> {
     //   try {

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.281",
+  "version": "0.0.284",
   "main": "src/main.ts",
   "type": "module",
   "repository": {
@@ -34,7 +34,7 @@
   "dependencies": {
     "@asteasolutions/zod-to-openapi": "^7.0.0",
     "@types/inquirer": "^9.0.7",
-    "appwrite-utils": "^0.1.23",
+    "appwrite-utils": "^0.2.1",
     "commander": "^12.0.0",
     "inquirer": "^9.2.20",
     "js-yaml": "^4.1.0",

package/src/main.ts

@@ -49,7 +49,8 @@ program.on("--help", () => {
 
 // Parse and handle options
 program.action(async (options) => {
-  const controller = new UtilsController();
+  const currentUserDir = process.cwd();
+  const controller = new UtilsController(currentUserDir);
   try {
     // Convert Commander options to the format expected by UtilsController
     const setupOptions = {
@@ -70,6 +71,7 @@ program.action(async (options) => {
       project: options.project,
       key: options.key,
     };
+    console.log("Running operation...", setupOptions);
 
     await controller.run(setupOptions);
     console.log("Operation completed successfully.");

package/src/migrations/appwriteToX.ts

@@ -12,6 +12,7 @@ import {
   permissionsSchema,
   attributesSchema,
   indexesSchema,
+  parseAttribute,
 } from "appwrite-utils";
 import { getDatabaseFromConfig } from "./afterImportActions.js";
 
@@ -41,6 +42,9 @@ export class AppwriteToX {
 
   // Function to parse an array of permission strings
   parsePermissionsArray = (permissions: string[]) => {
+    if (permissions.length === 0) {
+      return [];
+    }
     const parsedPermissions = permissionsSchema.parse(permissions);
     // Validate the parsed permissions using Zod
     return parsedPermissions ?? [];
@@ -71,31 +75,25 @@ export class AppwriteToX {
       const collections = await fetchAllCollections(database.$id, db);
 
       // Loop through each collection in the current database
+      if (!updatedConfig.collections) {
+        updatedConfig.collections = [];
+      }
       for (const collection of collections) {
-        if (!updatedConfig.collections) {
-          updatedConfig.collections = [];
-        }
+        console.log(`Processing collection: ${collection.name}`);
         const existingCollectionIndex = updatedConfig.collections.findIndex(
           (c) => c.name === collection.name
         );
 
+        console.log(`Parsing permissions...`);
         // Parse the collection permissions and attributes
         const collPermissions = this.parsePermissionsArray(
           collection.$permissions
         );
-        const collAttributes = attributesSchema
-          .parse(
-            collection.attributes.map((attr: any) => {
-              if (
-                attr.type === "string" &&
-                attr.format &&
-                attr.format.length > 0
-              ) {
-                return { ...attr, type: attr.format };
-              }
-              return attr;
-            })
-          )
+        console.log(`Parsing attributes...`, collection.attributes);
+        const collAttributes = collection.attributes
+          .map((attr: any) => {
+            return parseAttribute(attr);
+          })
           .filter((attribute) =>
             attribute.type === "relationship"
               ? attribute.side !== "child"
@@ -127,7 +125,16 @@ export class AppwriteToX {
           }
         }
         this.collToAttributeMap.set(collection.name, collAttributes);
-        const collIndexes = indexesSchema.parse(collection.indexes);
+        const finalIndexes = collection.indexes.map((index) => {
+          return {
+            ...index,
+            orders: index.orders?.filter((order) => {
+              return order !== null && order;
+            }),
+          };
+        });
+        console.log(`Parsing indexes...`, finalIndexes);
+        const collIndexes = indexesSchema.parse(finalIndexes) ?? [];
 
         // Prepare the collection object to be added or updated
         const collToPush = CollectionSchema.parse({

package/src/migrations/schemaStrings.ts

@@ -97,9 +97,13 @@ export class SchemaGenerator {
                 return `${key}: "${value.replace(/"/g, '\\"')}"`; // Escape existing quotes in the string
               } else if (Array.isArray(value)) {
                 // If the value is an array, join it with commas
-                return `${key}: [${value
-                  .map((item) => `"${item}"`)
-                  .join(", ")}]`;
+                if (value.length > 0) {
+                  return `${key}: [${value
+                    .map((item) => `"${item}"`)
+                    .join(", ")}]`;
+                } else {
+                  return `${key}: []`;
+                }
               } else {
                 // If the value is not a string (e.g., boolean or number), output it directly
                 return `${key}: ${value}`;
@@ -116,7 +120,14 @@ export class SchemaGenerator {
           const formattedAttributes = index.attributes
             .map((attr) => `"${attr}"`)
             .join(", ");
-          return `{ key: "${index.key}", type: "${index.type}", attributes: [${formattedAttributes}] }`;
+          return `{ key: "${index.key}", type: "${
+            index.type
+          }", attributes: [${formattedAttributes}], orders: [${
+            index.orders
+              ?.filter((order) => order !== null)
+              .map((order) => `"${order}"`)
+              .join(", ") ?? ""
+          }] }`;
         }) ?? []
       ).join(",\n    ")}
     ]

package/src/utils/loadConfigs.ts

@@ -9,10 +9,13 @@ import { register } from "tsx/esm/api"; // Import the register function
  * @returns The path to the file if found, or null if not found.
  */
 export const findAppwriteConfig = (dir: string): string | null => {
+  if (dir === "node_modules") {
+    return null;
+  }
   const files = fs.readdirSync(dir, { withFileTypes: true });
 
   for (const file of files) {
-    if (file.isDirectory()) {
+    if (file.isDirectory() && file.name !== "node_modules") {
       const result = findAppwriteConfig(path.join(dir, file.name));
       if (result) return result;
     } else if (file.name === "appwriteConfig.ts") {
@@ -35,6 +38,7 @@ export const loadConfig = async (
 
   try {
     const configPath = path.resolve(configDir, "appwriteConfig.ts");
+    console.log(`Loading config from: ${configPath}`);
     const config = (await import(configPath)).default as AppwriteConfig;
 
     const collectionsDir = path.resolve(configDir, "collections");

package/src/utilsController.ts

@@ -61,14 +61,17 @@ export class UtilsController {
   public validityRuleDefinitions: ValidationRules = validationRules;
   public afterImportActionsDefinitions: AfterImportActions = afterImportActions;
 
-  constructor() {
-    const basePath = process.cwd(); // Gets the current working directory
+  constructor(currentUserDir: string) {
+    const basePath = currentUserDir; // Gets the current working directory
     const appwriteConfigFound = findAppwriteConfig(basePath);
     if (!appwriteConfigFound) {
       throw new Error("Failed to find appwriteConfig.ts");
     }
     this.appwriteConfigPath = appwriteConfigFound;
     this.appwriteFolderPath = path.dirname(appwriteConfigFound);
+    if (!this.appwriteFolderPath) {
+      throw new Error("Failed to get appwriteFolderPath");
+    }
   }
 
   // async loadCustomDefinitions(): Promise<void> {