appwrite-utils-cli 0.10.4 → 0.10.6

package/README.md

@@ -147,6 +147,8 @@ This updated CLI ensures that developers have robust tools at their fingertips t
 
 ## Changelog
 
+- 0.10.051: Added `node_modules` and a few others to the ignore
+- 0.10.05: Made deploy function into deploy function(s) -- so you can do more than one at a time
 - 0.10.04: Fixed stupid progress bar not updating -- also fixed double text
 - 0.10.03: Fixed `syncDb` to push the configurations properly, accidentally hurt it during `synchronizeConfigurations`
 - 0.10.02: Updated `wipeCollection` to handle errors gracefully

package/dist/functions/deployments.js

@@ -9,6 +9,7 @@ import chalk from "chalk";
 import cliProgress from "cli-progress";
 import { execSync } from "child_process";
 import { createFunction, getFunction, updateFunctionSpecifications, } from "./methods.js";
+import ignore from "ignore";
 const findFunctionDirectory = (basePath, functionName) => {
     const normalizedName = functionName.toLowerCase().replace(/\s+/g, "-");
     const dirs = fs.readdirSync(basePath, { withFileTypes: true });
@@ -26,9 +27,18 @@ const findFunctionDirectory = (basePath, functionName) => {
     }
     return undefined;
 };
-export const deployFunction = async (client, functionId, codePath, activate = true, entrypoint = "index.js", commands = "npm install") => {
+export const deployFunction = async (client, functionId, codePath, activate = true, entrypoint = "index.js", commands) => {
     const functions = new Functions(client);
-    console.log(chalk.blue("📦 Preparing function deployment..."));
+    console.log(chalk.blue("Preparing function deployment..."));
+    // Setup ignore rules
+    const ig = ignore.default();
+    ig.add(["node_modules", ".git", ".vscode", ".DS_Store"]); // Common directories to ignore
+    // Read .gitignore if it exists
+    const gitignorePath = join(codePath, ".gitignore");
+    if (fs.existsSync(gitignorePath)) {
+        const gitignoreContent = fs.readFileSync(gitignorePath, "utf8");
+        ig.add(gitignoreContent);
+    }
     const progressBar = new cliProgress.SingleBar({
         format: "Uploading |" +
             chalk.cyan("{bar}") +
@@ -42,6 +52,7 @@ export const deployFunction = async (client, functionId, codePath, activate = tr
         gzip: true,
         file: tarPath,
         cwd: codePath,
+        filter: (path) => !ig.ignores(path), // Use ignore to filter files
     }, ["."]);
     const fileBuffer = await fs.promises.readFile(tarPath);
     const fileObject = InputFile.fromBuffer(new Uint8Array(fileBuffer), `function-${functionId}.tar.gz`);

package/dist/interactiveCLI.js

@@ -19,7 +19,7 @@ var CHOICES;
 (function (CHOICES) {
     CHOICES["CREATE_COLLECTION_CONFIG"] = "Create collection config file";
     CHOICES["CREATE_FUNCTION"] = "Create a new function, from scratch or using a template";
-    CHOICES["DEPLOY_FUNCTION"] = "Deploy function";
+    CHOICES["DEPLOY_FUNCTION"] = "Deploy function(s)";
     CHOICES["DELETE_FUNCTION"] = "Delete function";
     CHOICES["SETUP_DIRS_FILES"] = "Setup directories and files";
     CHOICES["SETUP_DIRS_FILES_WITH_EXAMPLE_DATA"] = "Setup directories and files with example data";
@@ -369,73 +369,74 @@ export class InteractiveCLI {
             console.log(chalk.red("Failed to initialize controller or load config"));
             return;
         }
-        const functions = await this.selectFunctions("Select function to deploy:", false, true);
+        const functions = await this.selectFunctions("Select function(s) to deploy:", true, true);
         if (!functions?.length) {
             console.log(chalk.red("No function selected"));
             return;
         }
-        const functionConfig = functions[0];
-        if (!functionConfig) {
-            console.log(chalk.red("Invalid function configuration"));
-            return;
-        }
-        // Ensure functions array exists
-        if (!this.controller.config.functions) {
-            this.controller.config.functions = [];
-        }
-        let functionPath = join(this.controller.getAppwriteFolderPath(), "functions", functionConfig.name);
-        if (!fs.existsSync(functionPath)) {
-            console.log(chalk.yellow(`Function not found in primary location, searching subdirectories...`));
-            const foundPath = await this.findFunctionInSubdirectories(this.controller.getAppwriteFolderPath(), functionConfig.name.toLowerCase());
-            if (foundPath) {
-                functionPath = foundPath;
-                functionConfig.dirPath = foundPath;
+        for (const functionConfig of functions) {
+            if (!functionConfig) {
+                console.log(chalk.red("Invalid function configuration"));
+                return;
             }
-            else {
-                const { shouldDownload } = await inquirer.prompt([
-                    {
-                        type: "confirm",
-                        name: "shouldDownload",
-                        message: "Function not found locally. Would you like to download the latest deployment?",
-                        default: false,
-                    },
-                ]);
-                if (shouldDownload) {
-                    try {
-                        console.log(chalk.blue("Downloading latest deployment..."));
-                        const { path: downloadedPath, function: remoteFunction } = await downloadLatestFunctionDeployment(this.controller.appwriteServer, functionConfig.$id, join(this.controller.getAppwriteFolderPath(), "functions"));
-                        console.log(chalk.green(`✨ Function downloaded to ${downloadedPath}`));
-                        const existingIndex = this.controller.config.functions.findIndex((f) => f?.$id === remoteFunction.$id);
-                        if (existingIndex >= 0) {
-                            // Only update the dirPath if function exists
-                            this.controller.config.functions[existingIndex].dirPath =
-                                downloadedPath;
+            // Ensure functions array exists
+            if (!this.controller.config.functions) {
+                this.controller.config.functions = [];
+            }
+            let functionPath = join(this.controller.getAppwriteFolderPath(), "functions", functionConfig.name);
+            if (!fs.existsSync(functionPath)) {
+                console.log(chalk.yellow(`Function not found in primary location, searching subdirectories...`));
+                const foundPath = await this.findFunctionInSubdirectories(this.controller.getAppwriteFolderPath(), functionConfig.name.toLowerCase());
+                if (foundPath) {
+                    functionPath = foundPath;
+                    functionConfig.dirPath = foundPath;
+                }
+                else {
+                    const { shouldDownload } = await inquirer.prompt([
+                        {
+                            type: "confirm",
+                            name: "shouldDownload",
+                            message: "Function not found locally. Would you like to download the latest deployment?",
+                            default: false,
+                        },
+                    ]);
+                    if (shouldDownload) {
+                        try {
+                            console.log(chalk.blue("Downloading latest deployment..."));
+                            const { path: downloadedPath, function: remoteFunction } = await downloadLatestFunctionDeployment(this.controller.appwriteServer, functionConfig.$id, join(this.controller.getAppwriteFolderPath(), "functions"));
+                            console.log(chalk.green(`✨ Function downloaded to ${downloadedPath}`));
+                            const existingIndex = this.controller.config.functions.findIndex((f) => f?.$id === remoteFunction.$id);
+                            if (existingIndex >= 0) {
+                                // Only update the dirPath if function exists
+                                this.controller.config.functions[existingIndex].dirPath =
+                                    downloadedPath;
+                            }
+                            await this.controller.reloadConfig();
+                            functionConfig.dirPath = downloadedPath;
+                            functionPath = downloadedPath;
+                        }
+                        catch (error) {
+                            console.error(chalk.red("Failed to download function deployment:"), error);
+                            return;
                         }
-                        await this.controller.reloadConfig();
-                        functionConfig.dirPath = downloadedPath;
-                        functionPath = downloadedPath;
                     }
-                    catch (error) {
-                        console.error(chalk.red("Failed to download function deployment:"), error);
+                    else {
+                        console.log(chalk.red(`Function ${functionConfig.name} not found locally. Cannot deploy.`));
                         return;
                     }
                 }
-                else {
-                    console.log(chalk.red(`Function ${functionConfig.name} not found locally. Cannot deploy.`));
-                    return;
-                }
             }
-        }
-        if (!this.controller.appwriteServer) {
-            console.log(chalk.red("Appwrite server not initialized"));
-            return;
-        }
-        try {
-            await deployLocalFunction(this.controller.appwriteServer, functionConfig.name, functionConfig);
-            console.log(chalk.green("✨ Function deployed successfully!"));
-        }
-        catch (error) {
-            console.error(chalk.red("Failed to deploy function:"), error);
+            if (!this.controller.appwriteServer) {
+                console.log(chalk.red("Appwrite server not initialized"));
+                return;
+            }
+            try {
+                await deployLocalFunction(this.controller.appwriteServer, functionConfig.name, functionConfig);
+                console.log(chalk.green("✨ Function deployed successfully!"));
+            }
+            catch (error) {
+                console.error(chalk.red("Failed to deploy function:"), error);
+            }
         }
     }
     async deleteFunction() {

package/package.json

@@ -1,57 +1,58 @@
-{
-  "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.10.04",
-  "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.97",
-    "chalk": "^5.3.0",
-    "cli-progress": "^3.12.0",
-    "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": "^14.1.0",
-    "tar": "^7.4.3",
-    "tsx": "^4.17.0",
-    "ulidx": "^2.4.0",
-    "winston": "^3.14.2",
-    "zod": "^3.23.8"
-  },
-  "devDependencies": {
-    "@types/cli-progress": "^3.11.6",
-    "@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.10.06",
+  "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.97",
+    "chalk": "^5.3.0",
+    "cli-progress": "^3.12.0",
+    "commander": "^12.1.0",
+    "ignore": "^6.0.2",
+    "inquirer": "^9.3.6",
+    "js-yaml": "^4.1.0",
+    "lodash": "^4.17.21",
+    "luxon": "^3.5.0",
+    "nanostores": "^0.10.3",
+    "node-appwrite": "^14.1.0",
+    "tar": "^7.4.3",
+    "tsx": "^4.17.0",
+    "ulidx": "^2.4.0",
+    "winston": "^3.14.2",
+    "zod": "^3.23.8"
+  },
+  "devDependencies": {
+    "@types/cli-progress": "^3.11.6",
+    "@types/js-yaml": "^4.0.9",
+    "@types/lodash": "^4.17.7",
+    "@types/luxon": "^3.4.2",
+    "typescript": "^5.5.4"
+  }
+}

package/src/functions/deployments.ts

@@ -13,6 +13,7 @@ import {
   getFunction,
   updateFunctionSpecifications,
 } from "./methods.js";
+import ignore from "ignore";
 
 const findFunctionDirectory = (
   basePath: string,
@@ -44,10 +45,21 @@ export const deployFunction = async (
   codePath: string,
   activate: boolean = true,
   entrypoint: string = "index.js",
-  commands: string = "npm install"
+  commands?: string
 ) => {
   const functions = new Functions(client);
-  console.log(chalk.blue("📦 Preparing function deployment..."));
+  console.log(chalk.blue("Preparing function deployment..."));
+
+  // Setup ignore rules
+  const ig = ignore.default();
+  ig.add(["node_modules", ".git", ".vscode", ".DS_Store"]); // Common directories to ignore
+
+  // Read .gitignore if it exists
+  const gitignorePath = join(codePath, ".gitignore");
+  if (fs.existsSync(gitignorePath)) {
+    const gitignoreContent = fs.readFileSync(gitignorePath, "utf8");
+    ig.add(gitignoreContent);
+  }
 
   const progressBar = new cliProgress.SingleBar({
     format:
@@ -60,11 +72,13 @@ export const deployFunction = async (
   });
 
   const tarPath = join(process.cwd(), `function-${functionId}.tar.gz`);
+
   await createTarball(
     {
       gzip: true,
       file: tarPath,
       cwd: codePath,
+      filter: (path) => !ig.ignores(path), // Use ignore to filter files
     },
     ["."]
   );

package/src/interactiveCLI.ts

@@ -47,7 +47,7 @@ import { SchemaGenerator } from "./migrations/schemaStrings.js";
 enum CHOICES {
   CREATE_COLLECTION_CONFIG = "Create collection config file",
   CREATE_FUNCTION = "Create a new function, from scratch or using a template",
-  DEPLOY_FUNCTION = "Deploy function",
+  DEPLOY_FUNCTION = "Deploy function(s)",
   DELETE_FUNCTION = "Delete function",
   SETUP_DIRS_FILES = "Setup directories and files",
   SETUP_DIRS_FILES_WITH_EXAMPLE_DATA = "Setup directories and files with example data",
@@ -494,8 +494,8 @@ export class InteractiveCLI {
     }
 
     const functions = await this.selectFunctions(
-      "Select function to deploy:",
-      false,
+      "Select function(s) to deploy:",
+      true,
       true
     );
 
@@ -504,106 +504,107 @@ export class InteractiveCLI {
       return;
     }
 
-    const functionConfig = functions[0];
-    if (!functionConfig) {
-      console.log(chalk.red("Invalid function configuration"));
-      return;
-    }
-
-    // Ensure functions array exists
-    if (!this.controller.config.functions) {
-      this.controller.config.functions = [];
-    }
+    for (const functionConfig of functions) {
+      if (!functionConfig) {
+        console.log(chalk.red("Invalid function configuration"));
+        return;
+      }
 
-    let functionPath = join(
-      this.controller.getAppwriteFolderPath(),
-      "functions",
-      functionConfig.name
-    );
+      // Ensure functions array exists
+      if (!this.controller.config.functions) {
+        this.controller.config.functions = [];
+      }
 
-    if (!fs.existsSync(functionPath)) {
-      console.log(
-        chalk.yellow(
-          `Function not found in primary location, searching subdirectories...`
-        )
-      );
-      const foundPath = await this.findFunctionInSubdirectories(
+      let functionPath = join(
         this.controller.getAppwriteFolderPath(),
-        functionConfig.name.toLowerCase()
+        "functions",
+        functionConfig.name
       );
 
-      if (foundPath) {
-        functionPath = foundPath;
-        functionConfig.dirPath = foundPath;
-      } else {
-        const { shouldDownload } = await inquirer.prompt([
-          {
-            type: "confirm",
-            name: "shouldDownload",
-            message:
-              "Function not found locally. Would you like to download the latest deployment?",
-            default: false,
-          },
-        ]);
+      if (!fs.existsSync(functionPath)) {
+        console.log(
+          chalk.yellow(
+            `Function not found in primary location, searching subdirectories...`
+          )
+        );
+        const foundPath = await this.findFunctionInSubdirectories(
+          this.controller.getAppwriteFolderPath(),
+          functionConfig.name.toLowerCase()
+        );
 
-        if (shouldDownload) {
-          try {
-            console.log(chalk.blue("Downloading latest deployment..."));
-            const { path: downloadedPath, function: remoteFunction } =
-              await downloadLatestFunctionDeployment(
-                this.controller.appwriteServer!,
-                functionConfig.$id,
-                join(this.controller.getAppwriteFolderPath(), "functions")
+        if (foundPath) {
+          functionPath = foundPath;
+          functionConfig.dirPath = foundPath;
+        } else {
+          const { shouldDownload } = await inquirer.prompt([
+            {
+              type: "confirm",
+              name: "shouldDownload",
+              message:
+                "Function not found locally. Would you like to download the latest deployment?",
+              default: false,
+            },
+          ]);
+
+          if (shouldDownload) {
+            try {
+              console.log(chalk.blue("Downloading latest deployment..."));
+              const { path: downloadedPath, function: remoteFunction } =
+                await downloadLatestFunctionDeployment(
+                  this.controller.appwriteServer!,
+                  functionConfig.$id,
+                  join(this.controller.getAppwriteFolderPath(), "functions")
+                );
+              console.log(
+                chalk.green(`✨ Function downloaded to ${downloadedPath}`)
               );
-            console.log(
-              chalk.green(`✨ Function downloaded to ${downloadedPath}`)
-            );
 
-            const existingIndex = this.controller.config.functions.findIndex(
-              (f) => f?.$id === remoteFunction.$id
-            );
+              const existingIndex = this.controller.config.functions.findIndex(
+                (f) => f?.$id === remoteFunction.$id
+              );
 
-            if (existingIndex >= 0) {
-              // Only update the dirPath if function exists
-              this.controller.config.functions[existingIndex].dirPath =
-                downloadedPath;
+              if (existingIndex >= 0) {
+                // Only update the dirPath if function exists
+                this.controller.config.functions[existingIndex].dirPath =
+                  downloadedPath;
+              }
+
+              await this.controller.reloadConfig();
+              functionConfig.dirPath = downloadedPath;
+              functionPath = downloadedPath;
+            } catch (error) {
+              console.error(
+                chalk.red("Failed to download function deployment:"),
+                error
+              );
+              return;
             }
-
-            await this.controller.reloadConfig();
-            functionConfig.dirPath = downloadedPath;
-            functionPath = downloadedPath;
-          } catch (error) {
-            console.error(
-              chalk.red("Failed to download function deployment:"),
-              error
+          } else {
+            console.log(
+              chalk.red(
+                `Function ${functionConfig.name} not found locally. Cannot deploy.`
+              )
             );
             return;
           }
-        } else {
-          console.log(
-            chalk.red(
-              `Function ${functionConfig.name} not found locally. Cannot deploy.`
-            )
-          );
-          return;
         }
       }
-    }
 
-    if (!this.controller.appwriteServer) {
-      console.log(chalk.red("Appwrite server not initialized"));
-      return;
-    }
+      if (!this.controller.appwriteServer) {
+        console.log(chalk.red("Appwrite server not initialized"));
+        return;
+      }
 
-    try {
-      await deployLocalFunction(
-        this.controller.appwriteServer,
-        functionConfig.name,
-        functionConfig
-      );
-      console.log(chalk.green("✨ Function deployed successfully!"));
-    } catch (error) {
-      console.error(chalk.red("Failed to deploy function:"), error);
+      try {
+        await deployLocalFunction(
+          this.controller.appwriteServer,
+          functionConfig.name,
+          functionConfig
+        );
+        console.log(chalk.green("✨ Function deployed successfully!"));
+      } catch (error) {
+        console.error(chalk.red("Failed to deploy function:"), error);
+      }
     }
   }