appwrite-utils-cli 1.8.8 → 1.8.9

package/CHANGELOG.md

@@ -25,3 +25,11 @@ All notable changes to this project will be documented in this file.
 - Enhancement: Interactive selection adds “Use same selection as before” when choosing tables per database, speeding up multi-DB workflows.
 - Behavior: Non-interactive `--push` with both `--dbIds` and `--collectionIds` is fully non-interactive. The provided IDs are applied as-is to every selected database and the confirmation summary is skipped.
 - Improvement: Selective push reloads local config from disk before pushing to ensure the latest YAML/TS changes are used.
+- Fix: Sync-from-Appwrite now captures function `scopes` and writes them to config; deployments use `scopes` from either central config or `.fnconfig.yaml`.
+- Change: Removed global prompt to choose between central `config.yaml` and per-function `.fnconfig.yaml` during function deployments. The tool now prompts per function only when both sources exist for that function (with an option to merge where `.fnconfig` overrides).
+
+## 1.8.9 - 2025-10-29
+
+- Fix: Functions sync now fetches full details via `getFunction` per function to reliably capture `scopes` (prevents empty scopes in some environments).
+- Confirmed schema: YAML `appwrite-config.schema.json` supports `functions[].dirPath`; writers preserve `dirPath` when present.
+- Polish: Per-function config source selection is now applied at deploy time when both central and `.fnconfig.yaml` are present.

package/dist/cli/commands/functionCommands.js

@@ -111,38 +111,14 @@ export const functionCommands = {
             MessageFormatter.error("Failed to initialize controller or load config", undefined, { prefix: "Functions" });
             return;
         }
-        // Offer choice of function config sources: central YAML, .fnconfig.yaml, or both
-        let sourceChoice = 'both';
+        // Discover per-function .fnconfig.yaml definitions and merge with central list for selection
+        // No global prompt; we'll handle conflicts per-function if both exist.
+        let discovered = [];
+        let central = cli.controller.config.functions || [];
         try {
-            const answer = await inquirer.prompt([
-                {
-                    type: 'list',
-                    name: 'source',
-                    message: 'Select function config source:',
-                    choices: [
-                        { name: 'config.yaml functions (central)', value: 'central' },
-                        { name: '.fnconfig.yaml (discovered per-function)', value: 'fnconfig' },
-                        { name: 'Both (merge; .fnconfig overrides)', value: 'both' },
-                    ],
-                    default: 'both'
-                }
-            ]);
-            sourceChoice = answer.source;
-        }
-        catch { }
-        try {
-            const discovered = discoverFnConfigs(cli.currentDir);
-            const central = cli.controller.config.functions || [];
-            if (sourceChoice === 'central') {
-                cli.controller.config.functions = central;
-            }
-            else if (sourceChoice === 'fnconfig') {
-                cli.controller.config.functions = discovered;
-            }
-            else {
-                const merged = mergeDiscoveredFunctions(central, discovered);
-                cli.controller.config.functions = merged;
-            }
+            discovered = discoverFnConfigs(cli.currentDir);
+            const merged = mergeDiscoveredFunctions(central, discovered);
+            cli.controller.config.functions = merged;
         }
         catch { }
         const functions = await cli.selectFunctions("Select function(s) to deploy:", true, true);
@@ -155,22 +131,51 @@ export const functionCommands = {
                 MessageFormatter.error("Invalid function configuration", undefined, { prefix: "Functions" });
                 return;
             }
+            // Resolve effective config for this function (prefer per-function choice if both sources exist)
+            const byIdOrName = (arr) => arr.find((f) => f?.$id === functionConfig.$id || f?.name === functionConfig.name);
+            const centralDef = byIdOrName(central);
+            const discoveredDef = byIdOrName(discovered);
+            let effectiveConfig = functionConfig;
+            if (centralDef && discoveredDef) {
+                try {
+                    const answer = await inquirer.prompt([
+                        {
+                            type: 'list',
+                            name: 'cfgChoice',
+                            message: `Multiple configs found for '${functionConfig.name}'. Which to use?`,
+                            choices: [
+                                { name: 'config.yaml (central)', value: 'central' },
+                                { name: '.fnconfig.yaml (local file)', value: 'fnconfig' },
+                                { name: 'Merge (.fnconfig overrides central)', value: 'merge' },
+                            ],
+                            default: 'fnconfig'
+                        }
+                    ]);
+                    if (answer.cfgChoice === 'central')
+                        effectiveConfig = centralDef;
+                    else if (answer.cfgChoice === 'fnconfig')
+                        effectiveConfig = discoveredDef;
+                    else
+                        effectiveConfig = { ...centralDef, ...discoveredDef };
+                }
+                catch { }
+            }
             // Ensure functions array exists
             if (!cli.controller.config.functions) {
                 cli.controller.config.functions = [];
             }
-            const functionNameLower = functionConfig.name
+            const functionNameLower = effectiveConfig.name
                 .toLowerCase()
                 .replace(/\s+/g, "-");
             // Debug logging
             MessageFormatter.info(`🔍 Function deployment debug:`, { prefix: "Functions" });
-            MessageFormatter.info(`  Function name: ${functionConfig.name}`, { prefix: "Functions" });
-            MessageFormatter.info(`  Function ID: ${functionConfig.$id}`, { prefix: "Functions" });
-            MessageFormatter.info(`  Config dirPath: ${functionConfig.dirPath || 'undefined'}`, { prefix: "Functions" });
-            if (functionConfig.dirPath) {
-                const expandedPath = functionConfig.dirPath.startsWith('~/')
-                    ? functionConfig.dirPath.replace('~', os.homedir())
-                    : functionConfig.dirPath;
+            MessageFormatter.info(`  Function name: ${effectiveConfig.name}`, { prefix: "Functions" });
+            MessageFormatter.info(`  Function ID: ${effectiveConfig.$id}`, { prefix: "Functions" });
+            MessageFormatter.info(`  Config dirPath: ${effectiveConfig.dirPath || 'undefined'}`, { prefix: "Functions" });
+            if (effectiveConfig.dirPath) {
+                const expandedPath = effectiveConfig.dirPath.startsWith('~/')
+                    ? effectiveConfig.dirPath.replace('~', os.homedir())
+                    : effectiveConfig.dirPath;
                 MessageFormatter.info(`  Expanded dirPath: ${expandedPath}`, { prefix: "Functions" });
             }
             MessageFormatter.info(`  Appwrite folder: ${cli.controller.getAppwriteFolderPath()}`, { prefix: "Functions" });
@@ -182,10 +187,10 @@ export const functionCommands = {
             // Check locations in priority order:
             const priorityLocations = [
                 // 1. Config dirPath if specified (with tilde expansion)
-                functionConfig.dirPath
-                    ? (require('node:path').isAbsolute(expandTildePath(functionConfig.dirPath))
-                        ? expandTildePath(functionConfig.dirPath)
-                        : require('node:path').resolve(yamlBaseDir, expandTildePath(functionConfig.dirPath)))
+                effectiveConfig.dirPath
+                    ? (require('node:path').isAbsolute(expandTildePath(effectiveConfig.dirPath))
+                        ? expandTildePath(effectiveConfig.dirPath)
+                        : require('node:path').resolve(yamlBaseDir, expandTildePath(effectiveConfig.dirPath)))
                     : undefined,
                 // 2. Appwrite config folder/functions/name
                 join(cli.controller.getAppwriteFolderPath(), "functions", functionNameLower),
@@ -226,10 +231,10 @@ export const functionCommands = {
                 if (shouldDownload) {
                     try {
                         MessageFormatter.progress("Downloading latest deployment...", { prefix: "Functions" });
-                        const { path: downloadedPath, function: remoteFunction } = await downloadLatestFunctionDeployment(cli.controller.appwriteServer, functionConfig.$id, join(cli.controller.getAppwriteFolderPath(), "functions"));
+                        const { path: downloadedPath, function: remoteFunction } = await downloadLatestFunctionDeployment(cli.controller.appwriteServer, effectiveConfig.$id, join(cli.controller.getAppwriteFolderPath(), "functions"));
                         MessageFormatter.success(`✨ Function downloaded to ${downloadedPath}`, { prefix: "Functions" });
                         functionPath = downloadedPath;
-                        functionConfig.dirPath = downloadedPath;
+                        effectiveConfig.dirPath = downloadedPath;
                         const existingIndex = cli.controller.config.functions.findIndex((f) => f?.$id === remoteFunction.$id);
                         if (existingIndex >= 0) {
                             cli.controller.config.functions[existingIndex].dirPath =
@@ -243,7 +248,7 @@ export const functionCommands = {
                     }
                 }
                 else {
-                    MessageFormatter.error(`Function ${functionConfig.name} not found locally. Cannot deploy.`, undefined, { prefix: "Functions" });
+                    MessageFormatter.error(`Function ${effectiveConfig.name} not found locally. Cannot deploy.`, undefined, { prefix: "Functions" });
                     return;
                 }
             }
@@ -252,8 +257,8 @@ export const functionCommands = {
                 return;
             }
             try {
-                await deployLocalFunction(cli.controller.appwriteServer, functionConfig.name, {
-                    ...functionConfig,
+                await deployLocalFunction(cli.controller.appwriteServer, effectiveConfig.name, {
+                    ...effectiveConfig,
                     dirPath: functionPath,
                 }, functionPath);
                 MessageFormatter.success("Function deployed successfully!", { prefix: "Functions" });

package/dist/migrations/appwriteToX.js

@@ -7,7 +7,7 @@ import { CollectionSchema, attributeSchema, AppwriteConfigSchema, permissionsSch
 import { getDatabaseFromConfig } from "./afterImportActions.js";
 import { getAdapterFromConfig } from "../utils/getClientFromConfig.js";
 import { listBuckets } from "../storage/methods.js";
-import { listFunctions, listFunctionDeployments } from "../functions/methods.js";
+import { listFunctions, listFunctionDeployments, getFunction } from "../functions/methods.js";
 import { MessageFormatter } from "../shared/messageFormatter.js";
 import { isLegacyDatabases } from "../utils/typeGuards.js";
 /**
@@ -420,7 +420,18 @@ export class AppwriteToX {
         const remoteFunctions = await listFunctions(this.config.appwriteClient, [
             Query.limit(1000),
         ]);
-        this.updatedConfig.functions = remoteFunctions.functions.map((func) => ({
+        // Fetch full details per function to ensure 'scopes' and other fields are present
+        const detailedFunctions = [];
+        for (const f of remoteFunctions.functions) {
+            try {
+                const full = await getFunction(this.config.appwriteClient, f.$id);
+                detailedFunctions.push(full);
+            }
+            catch {
+                detailedFunctions.push(f);
+            }
+        }
+        this.updatedConfig.functions = detailedFunctions.map((func) => ({
             $id: func.$id,
             name: func.name,
             runtime: func.runtime,
@@ -432,6 +443,7 @@ export class AppwriteToX {
             logging: func.logging !== false,
             entrypoint: func.entrypoint || "src/index.ts",
             commands: func.commands || "npm install",
+            scopes: Array.isArray(func.scopes) ? func.scopes : [],
             dirPath: `functions/${func.name}`,
             specification: func.specification,
         }));

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": "1.8.8",
+  "version": "1.8.9",
   "main": "src/main.ts",
   "type": "module",
   "repository": {

package/src/cli/commands/functionCommands.ts

@@ -138,36 +138,14 @@ export const functionCommands = {
       return;
     }
 
-    // Offer choice of function config sources: central YAML, .fnconfig.yaml, or both
-    let sourceChoice: 'central' | 'fnconfig' | 'both' = 'both';
+    // Discover per-function .fnconfig.yaml definitions and merge with central list for selection
+    // No global prompt; we'll handle conflicts per-function if both exist.
+    let discovered: any[] = [];
+    let central: any[] = (cli as any).controller!.config!.functions || [];
     try {
-      const answer = await inquirer.prompt([
-        {
-          type: 'list',
-          name: 'source',
-          message: 'Select function config source:',
-          choices: [
-            { name: 'config.yaml functions (central)', value: 'central' },
-            { name: '.fnconfig.yaml (discovered per-function)', value: 'fnconfig' },
-            { name: 'Both (merge; .fnconfig overrides)', value: 'both' },
-          ],
-          default: 'both'
-        }
-      ]);
-      sourceChoice = answer.source;
-    } catch {}
-
-    try {
-      const discovered = discoverFnConfigs((cli as any).currentDir);
-      const central = (cli as any).controller!.config!.functions || [];
-      if (sourceChoice === 'central') {
-        (cli as any).controller!.config!.functions = central as any;
-      } else if (sourceChoice === 'fnconfig') {
-        (cli as any).controller!.config!.functions = discovered as any;
-      } else {
-        const merged = mergeDiscoveredFunctions(central, discovered);
-        (cli as any).controller!.config!.functions = merged as any;
-      }
+      discovered = discoverFnConfigs((cli as any).currentDir) as any[];
+      const merged = mergeDiscoveredFunctions(central as any, discovered as any);
+      (cli as any).controller!.config!.functions = merged as any;
     } catch {}
 
     const functions = await (cli as any).selectFunctions(
@@ -181,32 +159,59 @@ export const functionCommands = {
       return;
     }
 
-    for (const functionConfig of functions) {
+    for (const functionConfig of functions) {
       if (!functionConfig) {
         MessageFormatter.error("Invalid function configuration", undefined, { prefix: "Functions" });
         return;
       }
 
-      // Ensure functions array exists
-      if (!(cli as any).controller.config.functions) {
-        (cli as any).controller.config.functions = [];
-      }
+      // Resolve effective config for this function (prefer per-function choice if both sources exist)
+      const byIdOrName = (arr: any[]) => arr.find((f:any) => f?.$id === functionConfig.$id || f?.name === functionConfig.name);
+      const centralDef = byIdOrName(central as any[]);
+      const discoveredDef = byIdOrName(discovered as any[]);
+
+      let effectiveConfig = functionConfig;
+      if (centralDef && discoveredDef) {
+        try {
+          const answer = await inquirer.prompt([
+            {
+              type: 'list',
+              name: 'cfgChoice',
+              message: `Multiple configs found for '${functionConfig.name}'. Which to use?`,
+              choices: [
+                { name: 'config.yaml (central)', value: 'central' },
+                { name: '.fnconfig.yaml (local file)', value: 'fnconfig' },
+                { name: 'Merge (.fnconfig overrides central)', value: 'merge' },
+              ],
+              default: 'fnconfig'
+            }
+          ]);
+          if (answer.cfgChoice === 'central') effectiveConfig = centralDef;
+          else if (answer.cfgChoice === 'fnconfig') effectiveConfig = discoveredDef;
+          else effectiveConfig = { ...centralDef, ...discoveredDef };
+        } catch {}
+      }
+
+      // Ensure functions array exists
+      if (!(cli as any).controller.config.functions) {
+        (cli as any).controller.config.functions = [];
+      }
 
-      const functionNameLower = functionConfig.name
-        .toLowerCase()
-        .replace(/\s+/g, "-");
+      const functionNameLower = effectiveConfig.name
+        .toLowerCase()
+        .replace(/\s+/g, "-");
 
       // Debug logging
       MessageFormatter.info(`🔍 Function deployment debug:`, { prefix: "Functions" });
-      MessageFormatter.info(`  Function name: ${functionConfig.name}`, { prefix: "Functions" });
-      MessageFormatter.info(`  Function ID: ${functionConfig.$id}`, { prefix: "Functions" });
-      MessageFormatter.info(`  Config dirPath: ${functionConfig.dirPath || 'undefined'}`, { prefix: "Functions" });
-      if (functionConfig.dirPath) {
-        const expandedPath = functionConfig.dirPath.startsWith('~/')
-          ? functionConfig.dirPath.replace('~', os.homedir())
-          : functionConfig.dirPath;
-        MessageFormatter.info(`  Expanded dirPath: ${expandedPath}`, { prefix: "Functions" });
-      }
+      MessageFormatter.info(`  Function name: ${effectiveConfig.name}`, { prefix: "Functions" });
+      MessageFormatter.info(`  Function ID: ${effectiveConfig.$id}`, { prefix: "Functions" });
+      MessageFormatter.info(`  Config dirPath: ${effectiveConfig.dirPath || 'undefined'}`, { prefix: "Functions" });
+      if (effectiveConfig.dirPath) {
+        const expandedPath = effectiveConfig.dirPath.startsWith('~/')
+          ? effectiveConfig.dirPath.replace('~', os.homedir())
+          : effectiveConfig.dirPath;
+        MessageFormatter.info(`  Expanded dirPath: ${expandedPath}`, { prefix: "Functions" });
+      }
       MessageFormatter.info(`  Appwrite folder: ${(cli as any).controller.getAppwriteFolderPath()}`, { prefix: "Functions" });
       MessageFormatter.info(`  Current working dir: ${process.cwd()}`, { prefix: "Functions" });
 
@@ -218,10 +223,10 @@ export const functionCommands = {
       // Check locations in priority order:
       const priorityLocations = [
         // 1. Config dirPath if specified (with tilde expansion)
-        functionConfig.dirPath
-          ? (require('node:path').isAbsolute(expandTildePath(functionConfig.dirPath))
-              ? expandTildePath(functionConfig.dirPath)
-              : require('node:path').resolve(yamlBaseDir, expandTildePath(functionConfig.dirPath)))
+        effectiveConfig.dirPath
+          ? (require('node:path').isAbsolute(expandTildePath(effectiveConfig.dirPath))
+              ? expandTildePath(effectiveConfig.dirPath)
+              : require('node:path').resolve(yamlBaseDir, expandTildePath(effectiveConfig.dirPath)))
           : undefined,
         // 2. Appwrite config folder/functions/name
         join(
@@ -240,7 +245,7 @@ export const functionCommands = {
         MessageFormatter.info(`  ${i + 1}. ${loc}`, { prefix: "Functions" });
       });
 
-      let functionPath: string | null = null;
+      let functionPath: string | null = null;
 
       // Check each priority location
       for (const location of priorityLocations) {
@@ -280,21 +285,21 @@ export const functionCommands = {
             const { path: downloadedPath, function: remoteFunction } =
               await downloadLatestFunctionDeployment(
                 (cli as any).controller.appwriteServer!,
-                functionConfig.$id,
-                join((cli as any).controller.getAppwriteFolderPath()!, "functions")
-              );
+                effectiveConfig.$id,
+                join((cli as any).controller.getAppwriteFolderPath()!, "functions")
+              );
             MessageFormatter.success(`✨ Function downloaded to ${downloadedPath}`, { prefix: "Functions" });
 
             functionPath = downloadedPath;
-            functionConfig.dirPath = downloadedPath;
+            effectiveConfig.dirPath = downloadedPath;
 
             const existingIndex = (cli as any).controller.config.functions.findIndex(
               (f: any) => f?.$id === remoteFunction.$id
             );
 
             if (existingIndex >= 0) {
-              (cli as any).controller.config.functions[existingIndex].dirPath =
-                downloadedPath;
+              (cli as any).controller.config.functions[existingIndex].dirPath =
+                downloadedPath;
             }
 
             await (cli as any).reloadConfigWithSessionPreservation();
@@ -303,9 +308,9 @@ export const functionCommands = {
             return;
           }
         } else {
-          MessageFormatter.error(`Function ${functionConfig.name} not found locally. Cannot deploy.`, undefined, { prefix: "Functions" });
-          return;
-        }
+          MessageFormatter.error(`Function ${effectiveConfig.name} not found locally. Cannot deploy.`, undefined, { prefix: "Functions" });
+          return;
+        }
       }
 
       if (!(cli as any).controller.appwriteServer) {
@@ -316,13 +321,13 @@ export const functionCommands = {
       try {
         await deployLocalFunction(
           (cli as any).controller.appwriteServer,
-          functionConfig.name,
-          {
-            ...functionConfig,
-            dirPath: functionPath,
-          },
-          functionPath
-        );
+          effectiveConfig.name,
+          {
+            ...effectiveConfig,
+            dirPath: functionPath,
+          },
+          functionPath
+        );
         MessageFormatter.success("Function deployed successfully!", { prefix: "Functions" });
       } catch (error) {
         MessageFormatter.error("Failed to deploy function", error instanceof Error ? error : new Error(String(error)), { prefix: "Functions" });

package/src/migrations/appwriteToX.ts

@@ -28,7 +28,7 @@ import {
 import { getDatabaseFromConfig } from "./afterImportActions.js";
 import { getAdapterFromConfig } from "../utils/getClientFromConfig.js";
 import { listBuckets } from "../storage/methods.js";
-import { listFunctions, listFunctionDeployments } from "../functions/methods.js";
+import { listFunctions, listFunctionDeployments, getFunction } from "../functions/methods.js";
 import { MessageFormatter } from "../shared/messageFormatter.js";
 import { isLegacyDatabases } from "../utils/typeGuards.js";
 import type { DatabaseAdapter } from "../adapters/DatabaseAdapter.js";
@@ -570,27 +570,39 @@ export class AppwriteToX {
       antivirus: bucket.antivirus,
     }));
 
-    const remoteFunctions = await listFunctions(this.config.appwriteClient!, [
-      Query.limit(1000),
-    ]);
-
-    this.updatedConfig.functions = remoteFunctions.functions.map(
-      (func) => ({
-        $id: func.$id,
-        name: func.name,
-        runtime: func.runtime as Runtime,
-        execute: func.execute,
-        events: func.events || [],
-        schedule: func.schedule || "",
-        timeout: func.timeout || 15,
-        enabled: func.enabled !== false,
-        logging: func.logging !== false,
-        entrypoint: func.entrypoint || "src/index.ts",
-        commands: func.commands || "npm install",
-        dirPath: `functions/${func.name}`,
-        specification: func.specification as Specification,
-      })
-    );
+    const remoteFunctions = await listFunctions(this.config.appwriteClient!, [
+      Query.limit(1000),
+    ]);
+
+    // Fetch full details per function to ensure 'scopes' and other fields are present
+    const detailedFunctions: any[] = [];
+    for (const f of remoteFunctions.functions) {
+      try {
+        const full = await getFunction(this.config.appwriteClient!, f.$id);
+        detailedFunctions.push(full);
+      } catch {
+        detailedFunctions.push(f);
+      }
+    }
+
+    this.updatedConfig.functions = detailedFunctions.map(
+      (func: any) => ({
+        $id: func.$id,
+        name: func.name,
+        runtime: func.runtime as Runtime,
+        execute: func.execute,
+        events: func.events || [],
+        schedule: func.schedule || "",
+        timeout: func.timeout || 15,
+        enabled: func.enabled !== false,
+        logging: func.logging !== false,
+        entrypoint: func.entrypoint || "src/index.ts",
+        commands: func.commands || "npm install",
+        scopes: Array.isArray(func.scopes) ? func.scopes : [],
+        dirPath: `functions/${func.name}`,
+        specification: func.specification as Specification,
+      })
+    );
 
     // Make sure to update the config with all changes including databases
     updatedConfig.functions = this.updatedConfig.functions;