appwrite-utils-cli 0.9.2 → 0.9.3

package/README.md

@@ -80,6 +80,7 @@ Available options:
 - `--remoteEndpoint`: Set the remote Appwrite endpoint for transfers
 - `--remoteProjectId`: Set the remote Appwrite project ID for transfers
 - `--remoteApiKey`: Set the remote Appwrite API key for transfers
+- `--setup`: Create setup files
 
 ## Examples
 
@@ -123,7 +124,7 @@ This updated CLI ensures that developers have robust tools at their fingertips t
 
 ## Changelog
 
-- 0.9.3: Fixed deployment error
+- 0.9.3: Fixed deployment error && fix lack of existing `appwriteConfig.ts` file from causing error (you want to be able to setup yeah? haha)
 - 0.9.2: Added changelog back, whoops
 - 0.0.90: Updated README with new command-line options and fixed alias issues
 - 0.0.74: Added `--backup` support, even if only one database

package/dist/interactiveCLI.d.ts

@@ -1,8 +1,9 @@
-import { UtilsController } from "./utilsController.js";
 export declare class InteractiveCLI {
+    private currentDir;
     private controller;
-    constructor(currentDir?: string, utilsController?: UtilsController);
+    constructor(currentDir: string);
     run(): Promise<void>;
+    private initControllerIfNeeded;
     private selectDatabases;
     private selectCollections;
     private selectBuckets;

package/dist/interactiveCLI.js

@@ -22,22 +22,14 @@ var CHOICES;
     CHOICES["EXIT"] = "Exit";
 })(CHOICES || (CHOICES = {}));
 export class InteractiveCLI {
+    currentDir;
     controller;
-    constructor(currentDir, utilsController) {
-        if (utilsController) {
-            this.controller = utilsController;
-        }
-        else if (currentDir) {
-            this.controller = new UtilsController(currentDir);
-        }
-        else {
-            throw new Error("Current directory or utils controller is required");
-        }
+    constructor(currentDir) {
+        this.currentDir = currentDir;
     }
     async run() {
         console.log("Welcome to Appwrite Utils CLI Tool by Zach Handley");
         console.log("For more information, visit https://github.com/zachhandley/appwrite-utils");
-        await this.controller.init();
         while (true) {
             const { action } = await inquirer.prompt([
                 {
@@ -52,30 +44,37 @@ export class InteractiveCLI {
                     await this.createCollectionConfig();
                     break;
                 case CHOICES.SETUP_DIRS_FILES:
-                    await setupDirsFiles(false);
+                    await setupDirsFiles(false, this.currentDir);
                     break;
                 case CHOICES.SETUP_DIRS_FILES_WITH_EXAMPLE_DATA:
-                    await setupDirsFiles(true);
+                    await setupDirsFiles(true, this.currentDir);
                     break;
                 case CHOICES.SYNCHRONIZE_CONFIGURATIONS:
+                    await this.initControllerIfNeeded();
                     await this.synchronizeConfigurations();
                     break;
                 case CHOICES.SYNC_DB:
+                    await this.initControllerIfNeeded();
                     await this.syncDb();
                     break;
                 case CHOICES.TRANSFER_DATA:
+                    await this.initControllerIfNeeded();
                     await this.transferData();
                     break;
                 case CHOICES.BACKUP_DATABASE:
+                    await this.initControllerIfNeeded();
                     await this.backupDatabase();
                     break;
                 case CHOICES.WIPE_DATABASE:
+                    await this.initControllerIfNeeded();
                     await this.wipeDatabase();
                     break;
                 case CHOICES.GENERATE_SCHEMAS:
+                    await this.initControllerIfNeeded();
                     await this.generateSchemas();
                     break;
                 case CHOICES.IMPORT_DATA:
+                    await this.initControllerIfNeeded();
                     await this.importData();
                     break;
                 case CHOICES.EXIT:
@@ -84,6 +83,12 @@ export class InteractiveCLI {
             }
         }
     }
+    async initControllerIfNeeded() {
+        if (!this.controller) {
+            this.controller = new UtilsController(this.currentDir);
+            await this.controller.init();
+        }
+    }
     async selectDatabases(databases, message, multiSelect = true) {
         const choices = databases.map((db) => ({ name: db.name, value: db }));
         if (multiSelect) {

package/dist/main.js

@@ -110,18 +110,33 @@ const argv = yargs(hideBin(process.argv))
     .option("remoteApiKey", {
     type: "string",
     description: "Set the remote Appwrite API key for transfers",
+})
+    .option("setup", {
+    type: "boolean",
+    description: "Setup the project with example data",
 })
     .help()
     .parse();
 async function main() {
     const parsedArgv = (await argv);
-    const controller = new UtilsController(process.cwd());
-    await controller.init();
+    let controller;
     if (parsedArgv.it) {
-        const cli = new InteractiveCLI(process.cwd(), controller);
+        try {
+            controller = new UtilsController(process.cwd());
+            await controller.init();
+        }
+        catch (error) {
+            // If it fails, that means there's no config, more than likely
+            console.log("No config found, you probably need to create the setup files");
+        }
+        const cli = new InteractiveCLI(process.cwd());
         await cli.run();
     }
     else {
+        if (!controller) {
+            controller = new UtilsController(process.cwd());
+            await controller.init();
+        }
         // Handle non-interactive mode with the new options
         const options = {
             databases: parsedArgv.dbIds

package/dist/setupCommands.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/setupCommands.js

@@ -0,0 +1 @@
+export {};

package/dist/utils/schemaStrings.js

@@ -17,24 +17,24 @@ export class SchemaGenerator {
         const collections = this.config.collections;
         delete this.config.collections;
         const configPath = path.join(this.appwriteFolderPath, "appwriteConfig.ts");
-        const configContent = `import { type AppwriteConfig } from "appwrite-utils";
-  
-  const appwriteConfig: AppwriteConfig = {
-    appwriteEndpoint: "${this.config.appwriteEndpoint}",
-    appwriteProject: "${this.config.appwriteProject}",
-    appwriteKey: "${this.config.appwriteKey}",
-    enableBackups: ${this.config.enableBackups},
-    backupInterval: ${this.config.backupInterval},
-    backupRetention: ${this.config.backupRetention},
-    enableBackupCleanup: ${this.config.enableBackupCleanup},
-    enableMockData: ${this.config.enableMockData},
-    documentBucketId: "${this.config.documentBucketId}",
-    usersCollectionName: "${this.config.usersCollectionName}",
-    databases: ${JSON.stringify(this.config.databases)},
-    buckets: ${JSON.stringify(this.config.buckets)},
-  };
-  
-  export default appwriteConfig;
+        const configContent = `import { type AppwriteConfig } from "appwrite-utils";
+  
+  const appwriteConfig: AppwriteConfig = {
+    appwriteEndpoint: "${this.config.appwriteEndpoint}",
+    appwriteProject: "${this.config.appwriteProject}",
+    appwriteKey: "${this.config.appwriteKey}",
+    enableBackups: ${this.config.enableBackups},
+    backupInterval: ${this.config.backupInterval},
+    backupRetention: ${this.config.backupRetention},
+    enableBackupCleanup: ${this.config.enableBackupCleanup},
+    enableMockData: ${this.config.enableMockData},
+    documentBucketId: "${this.config.documentBucketId}",
+    usersCollectionName: "${this.config.usersCollectionName}",
+    databases: ${JSON.stringify(this.config.databases)},
+    buckets: ${JSON.stringify(this.config.buckets)},
+  };
+  
+  export default appwriteConfig;
   `;
         fs.writeFileSync(configPath, configContent, { encoding: "utf-8" });
         const collectionsFolderPath = path.join(this.appwriteFolderPath, "collections");
@@ -44,19 +44,19 @@ export class SchemaGenerator {
         collections?.forEach((collection) => {
             const { databaseId, ...collectionWithoutDbId } = collection; // Destructure to exclude databaseId
             const collectionFilePath = path.join(collectionsFolderPath, `${collection.name}.ts`);
-            const collectionContent = `import { type CollectionCreate } from "appwrite-utils";
-  
-  const ${collection.name}Config: Partial<CollectionCreate> = {
-    name: "${collection.name}",
-    $id: "${collection.$id}",
-    enabled: ${collection.enabled},
-    documentSecurity: ${collection.documentSecurity},
-    $permissions: [
+            const collectionContent = `import { type CollectionCreate } from "appwrite-utils";
+  
+  const ${collection.name}Config: Partial<CollectionCreate> = {
+    name: "${collection.name}",
+    $id: "${collection.$id}",
+    enabled: ${collection.enabled},
+    documentSecurity: ${collection.documentSecurity},
+    $permissions: [
       ${collection.$permissions
                 .map((permission) => `{ permission: "${permission.permission}", target: "${permission.target}" }`)
-                .join(",\n    ")}
-    ],
-    attributes: [
+                .join(",\n    ")}
+    ],
+    attributes: [
       ${collection.attributes
                 .map((attr) => {
                 return `{ ${Object.entries(attr)
@@ -84,9 +84,9 @@ export class SchemaGenerator {
                 })
                     .join(", ")} }`;
             })
-                .join(",\n    ")}
-    ],
-    indexes: [
+                .join(",\n    ")}
+    ],
+    indexes: [
       ${(collection.indexes?.map((index) => {
                 // Map each attribute to ensure it is properly quoted
                 const formattedAttributes = index.attributes.map((attr) => `"${attr}"`).join(", ") ?? "";
@@ -94,11 +94,11 @@ export class SchemaGenerator {
                     ?.filter((order) => order !== null)
                     .map((order) => `"${order}"`)
                     .join(", ") ?? ""}] }`;
-            }) ?? []).join(",\n    ")}
-    ]
-  };
-  
-  export default ${collection.name}Config;
+            }) ?? []).join(",\n    ")}
+    ]
+  };
+  
+  export default ${collection.name}Config;
   `;
             fs.writeFileSync(collectionFilePath, collectionContent, {
                 encoding: "utf-8",

package/dist/utils/setupFiles.d.ts

@@ -1,3 +1,3 @@
 export declare const customDefinitionsFile = "import type { ConverterFunctions, ValidationRules, AfterImportActions } from \"appwrite-utils\";\n\nexport const customConverterFunctions: ConverterFunctions = {\n  // Add your custom converter functions here\n}\nexport const customValidationRules: ValidationRules = {\n  // Add your custom validation rules here\n}\nexport const customAfterImportActions: AfterImportActions = {\n  // Add your custom after import actions here\n}";
 export declare const createEmptyCollection: (collectionName: string) => void;
-export declare const setupDirsFiles: (example?: boolean) => Promise<void>;
+export declare const setupDirsFiles: (example?: boolean, currentDir?: string) => Promise<void>;

package/dist/utils/setupFiles.js

@@ -143,8 +143,8 @@ export default ${collectionName};`;
     const collectionFilePath = path.join(collectionsFolder, `${collectionName}.ts`);
     writeFileSync(collectionFilePath, emptyCollection);
 };
-export const setupDirsFiles = async (example = false) => {
-    const basePath = process.cwd();
+export const setupDirsFiles = async (example = false, currentDir) => {
+    const basePath = currentDir || process.cwd();
     const srcPath = path.join(basePath);
     // Check if src directory exists in the current working directory
     if (!existsSync(srcPath)) {

package/package.json

@@ -1,53 +1,53 @@
-{
-  "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.9.2",
-  "main": "src/main.ts",
-  "type": "module",
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/zachhandley/AppwriteUtils"
-  },
-  "author": "Zach Handley <zach@blackleafdigital.com> (https://zachhandley.com)",
-  "keywords": [
-    "appwrite",
-    "cli",
-    "utils",
-    "migrations",
-    "data",
-    "database",
-    "import",
-    "migration",
-    "utility"
-  ],
-  "bin": {
-    "appwrite-migrate": "./dist/main.js"
-  },
-  "scripts": {
-    "build": "bun run tsc",
-    "start": "tsx --no-cache src/main.ts",
-    "deploy": "bun run build && npm publish --access public",
-    "postinstall": "echo 'This package is intended for CLI use only and should not be added as a dependency in other projects.'"
-  },
-  "dependencies": {
-    "@types/inquirer": "^9.0.7",
-    "appwrite-utils": "^0.3.8",
-    "commander": "^12.1.0",
-    "inquirer": "^9.3.6",
-    "js-yaml": "^4.1.0",
-    "lodash": "^4.17.21",
-    "luxon": "^3.5.0",
-    "nanostores": "^0.10.3",
-    "node-appwrite": "^13.0.0",
-    "tsx": "^4.17.0",
-    "ulidx": "^2.4.0",
-    "winston": "^3.14.1",
-    "zod": "^3.23.8"
-  },
-  "devDependencies": {
-    "@types/js-yaml": "^4.0.9",
-    "@types/lodash": "^4.17.7",
-    "@types/luxon": "^3.4.2",
-    "typescript": "^5.5.4"
-  }
-}
+{
+  "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.9.3",
+  "main": "src/main.ts",
+  "type": "module",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/zachhandley/AppwriteUtils"
+  },
+  "author": "Zach Handley <zach@blackleafdigital.com> (https://zachhandley.com)",
+  "keywords": [
+    "appwrite",
+    "cli",
+    "utils",
+    "migrations",
+    "data",
+    "database",
+    "import",
+    "migration",
+    "utility"
+  ],
+  "bin": {
+    "appwrite-migrate": "./dist/main.js"
+  },
+  "scripts": {
+    "build": "bun run tsc",
+    "start": "tsx --no-cache src/main.ts",
+    "deploy": "bun run build && npm publish --access public",
+    "postinstall": "echo 'This package is intended for CLI use only and should not be added as a dependency in other projects.'"
+  },
+  "dependencies": {
+    "@types/inquirer": "^9.0.7",
+    "appwrite-utils": "^0.3.8",
+    "commander": "^12.1.0",
+    "inquirer": "^9.3.6",
+    "js-yaml": "^4.1.0",
+    "lodash": "^4.17.21",
+    "luxon": "^3.5.0",
+    "nanostores": "^0.10.3",
+    "node-appwrite": "^13.0.0",
+    "tsx": "^4.17.0",
+    "ulidx": "^2.4.0",
+    "winston": "^3.14.1",
+    "zod": "^3.23.8"
+  },
+  "devDependencies": {
+    "@types/js-yaml": "^4.0.9",
+    "@types/lodash": "^4.17.7",
+    "@types/luxon": "^3.4.2",
+    "typescript": "^5.5.4"
+  }
+}