appwrite-utils-cli 1.7.8 → 1.8.1

package/dist/config/services/ConfigLoaderService.js

@@ -1,5 +1,6 @@
 import fs from "fs";
 import path from "path";
+import { resolve as resolvePath, dirname, isAbsolute } from "node:path";
 import yaml from "js-yaml";
 import { register } from "tsx/esm/api";
 import { pathToFileURL } from "node:url";
@@ -8,6 +9,7 @@ import { normalizeYamlData } from "../../utils/yamlConverter.js";
 import { loadYamlConfig } from "../yamlConfig.js";
 import { loadAppwriteProjectConfig, projectConfigToAppwriteConfig, getCollectionsFromProject } from "../../utils/projectConfig.js";
 import { loadYamlCollection, loadYamlTable, } from "../../utils/configDiscovery.js";
+import { expandTildePath } from "../../functions/pathResolution.js";
 /**
  * Service for loading and parsing Appwrite configuration files.
  *
@@ -25,6 +27,31 @@ import { loadYamlCollection, loadYamlTable, } from "../../utils/configDiscovery.
  * - Validates and normalizes configuration data
  */
 export class ConfigLoaderService {
+    /**
+     * Normalizes function dirPath to absolute path
+     * @param func Function configuration object
+     * @param configDir Directory containing the config file
+     * @returns Function with normalized dirPath
+     */
+    normalizeFunctionPath(func, configDir) {
+        if (!func.dirPath) {
+            return func;
+        }
+        // Expand tilde first
+        const expandedPath = expandTildePath(func.dirPath);
+        // If already absolute, return as-is
+        if (isAbsolute(expandedPath)) {
+            return {
+                ...func,
+                dirPath: expandedPath
+            };
+        }
+        // Resolve relative to config directory
+        return {
+            ...func,
+            dirPath: resolvePath(configDir, expandedPath)
+        };
+    }
     /**
      * Loads configuration from a discovered path, auto-detecting the type
      * @param configPath Path to the configuration file
@@ -46,6 +73,11 @@ export class ConfigLoaderService {
             if (!partialConfig.appwriteEndpoint || !partialConfig.appwriteProject) {
                 throw new Error("JSON project config must contain at minimum 'endpoint' and 'projectId' fields");
             }
+            const configDir = path.dirname(configPath);
+            // Normalize function paths
+            const normalizedFunctions = partialConfig.functions
+                ? partialConfig.functions.map(func => this.normalizeFunctionPath(func, configDir))
+                : [];
             return {
                 appwriteEndpoint: partialConfig.appwriteEndpoint,
                 appwriteProject: partialConfig.appwriteProject,
@@ -73,7 +105,7 @@ export class ConfigLoaderService {
                 },
                 databases: partialConfig.databases || [],
                 buckets: partialConfig.buckets || [],
-                functions: partialConfig.functions || [],
+                functions: normalizedFunctions,
                 collections: partialConfig.collections || [],
                 sessionCookie: partialConfig.sessionCookie,
                 authMethod: partialConfig.authMethod || "auto",
@@ -114,6 +146,10 @@ export class ConfigLoaderService {
             }
             // Load collections and tables from their respective directories
             const configDir = path.dirname(yamlPath);
+            // Normalize function paths
+            if (config.functions) {
+                config.functions = config.functions.map(func => this.normalizeFunctionPath(func, configDir));
+            }
             const collectionsDir = path.join(configDir, config.schemaConfig?.collectionsDirectory || "collections");
             const tablesDir = path.join(configDir, config.schemaConfig?.tablesDirectory || "tables");
             // Detect API mode to determine priority order
@@ -175,6 +211,11 @@ export class ConfigLoaderService {
             if (!config) {
                 throw new Error(`Failed to load TypeScript config from: ${tsPath}`);
             }
+            // Normalize function paths
+            const configDir = path.dirname(tsPath);
+            if (config.functions) {
+                config.functions = config.functions.map(func => this.normalizeFunctionPath(func, configDir));
+            }
             MessageFormatter.success(`Loaded TypeScript config from: ${tsPath}`, {
                 prefix: "Config",
             });
@@ -210,6 +251,11 @@ export class ConfigLoaderService {
             if (collections.length > 0) {
                 appwriteConfig.collections = collections;
             }
+            // Normalize function paths
+            const configDir = path.dirname(jsonPath);
+            if (appwriteConfig.functions) {
+                appwriteConfig.functions = appwriteConfig.functions.map(func => this.normalizeFunctionPath(func, configDir));
+            }
             MessageFormatter.success(`Loaded project config from: ${jsonPath}`, {
                 prefix: "Config",
             });

package/dist/config/yamlConfig.d.ts

@@ -239,100 +239,165 @@ export declare const createSessionPreservingYamlConfig: (configPath: string, ses
             name: string;
             attributes: ({
                 key: string;
-                type: "string";
-                size: number;
-                error?: string | undefined;
-                required?: boolean | undefined;
-                array?: boolean | undefined;
-                xdefault?: string | null | undefined;
-                encrypted?: boolean | undefined;
-                format?: string | null | undefined;
-            } | {
-                key: string;
+                required: boolean;
                 type: "integer";
-                error?: string | undefined;
-                required?: boolean | undefined;
                 array?: boolean | undefined;
+                format?: string | undefined;
+                status?: string | undefined;
+                attributes?: string[] | undefined;
+                orders?: string[] | undefined;
+                $createdAt?: string | undefined;
+                $updatedAt?: string | undefined;
+                error?: string | undefined;
                 min?: number | undefined;
                 max?: number | undefined;
                 xdefault?: number | null | undefined;
             } | {
                 key: string;
-                type: "double";
+                required: boolean;
+                type: "relationship";
+                relatedCollection: string;
+                relationType: "oneToMany" | "manyToOne" | "oneToOne" | "manyToMany";
+                twoWay: boolean;
+                onDelete: "setNull" | "cascade" | "restrict";
+                array?: boolean | undefined;
+                format?: string | undefined;
+                status?: string | undefined;
+                attributes?: string[] | undefined;
+                orders?: string[] | undefined;
+                $createdAt?: string | undefined;
+                $updatedAt?: string | undefined;
                 error?: string | undefined;
-                required?: boolean | undefined;
+                twoWayKey?: string | undefined;
+                side?: "parent" | "child" | undefined;
+                importMapping?: {
+                    originalIdField: string;
+                    targetField?: string | undefined;
+                } | undefined;
+            } | {
+                key: string;
+                required: boolean;
+                type: "string";
+                size: number;
                 array?: boolean | undefined;
+                format?: string | undefined;
+                status?: string | undefined;
+                attributes?: string[] | undefined;
+                orders?: string[] | undefined;
+                $createdAt?: string | undefined;
+                $updatedAt?: string | undefined;
+                error?: string | undefined;
+                xdefault?: string | null | undefined;
+                encrypted?: boolean | undefined;
+            } | {
+                key: string;
+                required: boolean;
+                type: "double";
+                array?: boolean | undefined;
+                format?: string | undefined;
+                status?: string | undefined;
+                attributes?: string[] | undefined;
+                orders?: string[] | undefined;
+                $createdAt?: string | undefined;
+                $updatedAt?: string | undefined;
+                error?: string | undefined;
                 min?: number | undefined;
                 max?: number | undefined;
                 xdefault?: number | null | undefined;
             } | {
                 key: string;
+                required: boolean;
                 type: "float";
-                error?: string | undefined;
-                required?: boolean | undefined;
                 array?: boolean | undefined;
+                format?: string | undefined;
+                status?: string | undefined;
+                attributes?: string[] | undefined;
+                orders?: string[] | undefined;
+                $createdAt?: string | undefined;
+                $updatedAt?: string | undefined;
+                error?: string | undefined;
                 min?: number | undefined;
                 max?: number | undefined;
                 xdefault?: number | null | undefined;
             } | {
                 key: string;
+                required: boolean;
                 type: "boolean";
-                error?: string | undefined;
-                required?: boolean | undefined;
                 array?: boolean | undefined;
+                format?: string | undefined;
+                status?: string | undefined;
+                attributes?: string[] | undefined;
+                orders?: string[] | undefined;
+                $createdAt?: string | undefined;
+                $updatedAt?: string | undefined;
+                error?: string | undefined;
                 xdefault?: boolean | null | undefined;
             } | {
                 key: string;
+                required: boolean;
                 type: "datetime";
-                error?: string | undefined;
-                required?: boolean | undefined;
                 array?: boolean | undefined;
+                format?: string | undefined;
+                status?: string | undefined;
+                attributes?: string[] | undefined;
+                orders?: string[] | undefined;
+                $createdAt?: string | undefined;
+                $updatedAt?: string | undefined;
+                error?: string | undefined;
                 xdefault?: string | null | undefined;
             } | {
                 key: string;
+                required: boolean;
                 type: "email";
-                error?: string | undefined;
-                required?: boolean | undefined;
                 array?: boolean | undefined;
+                format?: string | undefined;
+                status?: string | undefined;
+                attributes?: string[] | undefined;
+                orders?: string[] | undefined;
+                $createdAt?: string | undefined;
+                $updatedAt?: string | undefined;
+                error?: string | undefined;
                 xdefault?: string | null | undefined;
             } | {
                 key: string;
+                required: boolean;
                 type: "ip";
-                error?: string | undefined;
-                required?: boolean | undefined;
                 array?: boolean | undefined;
+                format?: string | undefined;
+                status?: string | undefined;
+                attributes?: string[] | undefined;
+                orders?: string[] | undefined;
+                $createdAt?: string | undefined;
+                $updatedAt?: string | undefined;
+                error?: string | undefined;
                 xdefault?: string | null | undefined;
             } | {
                 key: string;
+                required: boolean;
                 type: "url";
-                error?: string | undefined;
-                required?: boolean | undefined;
                 array?: boolean | undefined;
+                format?: string | undefined;
+                status?: string | undefined;
+                attributes?: string[] | undefined;
+                orders?: string[] | undefined;
+                $createdAt?: string | undefined;
+                $updatedAt?: string | undefined;
+                error?: string | undefined;
                 xdefault?: string | null | undefined;
             } | {
                 key: string;
+                required: boolean;
                 type: "enum";
                 elements: string[];
-                error?: string | undefined;
-                required?: boolean | undefined;
                 array?: boolean | undefined;
-                xdefault?: string | null | undefined;
-            } | {
-                key: string;
-                type: "relationship";
-                relatedCollection: string;
-                relationType: "oneToMany" | "manyToOne" | "oneToOne" | "manyToMany";
-                twoWay: boolean;
-                onDelete: "setNull" | "cascade" | "restrict";
+                format?: string | undefined;
+                status?: string | undefined;
+                attributes?: string[] | undefined;
+                orders?: string[] | undefined;
+                $createdAt?: string | undefined;
+                $updatedAt?: string | undefined;
                 error?: string | undefined;
-                required?: boolean | undefined;
-                array?: boolean | undefined;
-                twoWayKey?: string | undefined;
-                side?: "parent" | "child" | undefined;
-                importMapping?: {
-                    originalIdField: string;
-                    targetField?: string | undefined;
-                } | undefined;
+                xdefault?: string | null | undefined;
             })[];
             $permissions: {
                 permission: string;
@@ -387,104 +452,170 @@ export declare const createSessionPreservingYamlConfig: (configPath: string, ses
             enabled?: boolean | undefined;
             documentSecurity?: boolean | undefined;
             databaseId?: string | undefined;
+            databaseIds?: string[] | undefined;
         }[] | undefined;
         tables?: {
             attributes: ({
                 key: string;
-                type: "string";
-                size: number;
-                error?: string | undefined;
-                required?: boolean | undefined;
-                array?: boolean | undefined;
-                xdefault?: string | null | undefined;
-                encrypted?: boolean | undefined;
-                format?: string | null | undefined;
-            } | {
-                key: string;
+                required: boolean;
                 type: "integer";
-                error?: string | undefined;
-                required?: boolean | undefined;
                 array?: boolean | undefined;
+                format?: string | undefined;
+                status?: string | undefined;
+                attributes?: string[] | undefined;
+                orders?: string[] | undefined;
+                $createdAt?: string | undefined;
+                $updatedAt?: string | undefined;
+                error?: string | undefined;
                 min?: number | undefined;
                 max?: number | undefined;
                 xdefault?: number | null | undefined;
             } | {
                 key: string;
-                type: "double";
+                required: boolean;
+                type: "relationship";
+                relatedCollection: string;
+                relationType: "oneToMany" | "manyToOne" | "oneToOne" | "manyToMany";
+                twoWay: boolean;
+                onDelete: "setNull" | "cascade" | "restrict";
+                array?: boolean | undefined;
+                format?: string | undefined;
+                status?: string | undefined;
+                attributes?: string[] | undefined;
+                orders?: string[] | undefined;
+                $createdAt?: string | undefined;
+                $updatedAt?: string | undefined;
                 error?: string | undefined;
-                required?: boolean | undefined;
+                twoWayKey?: string | undefined;
+                side?: "parent" | "child" | undefined;
+                importMapping?: {
+                    originalIdField: string;
+                    targetField?: string | undefined;
+                } | undefined;
+            } | {
+                key: string;
+                required: boolean;
+                type: "string";
+                size: number;
                 array?: boolean | undefined;
+                format?: string | undefined;
+                status?: string | undefined;
+                attributes?: string[] | undefined;
+                orders?: string[] | undefined;
+                $createdAt?: string | undefined;
+                $updatedAt?: string | undefined;
+                error?: string | undefined;
+                xdefault?: string | null | undefined;
+                encrypted?: boolean | undefined;
+            } | {
+                key: string;
+                required: boolean;
+                type: "double";
+                array?: boolean | undefined;
+                format?: string | undefined;
+                status?: string | undefined;
+                attributes?: string[] | undefined;
+                orders?: string[] | undefined;
+                $createdAt?: string | undefined;
+                $updatedAt?: string | undefined;
+                error?: string | undefined;
                 min?: number | undefined;
                 max?: number | undefined;
                 xdefault?: number | null | undefined;
             } | {
                 key: string;
+                required: boolean;
                 type: "float";
-                error?: string | undefined;
-                required?: boolean | undefined;
                 array?: boolean | undefined;
+                format?: string | undefined;
+                status?: string | undefined;
+                attributes?: string[] | undefined;
+                orders?: string[] | undefined;
+                $createdAt?: string | undefined;
+                $updatedAt?: string | undefined;
+                error?: string | undefined;
                 min?: number | undefined;
                 max?: number | undefined;
                 xdefault?: number | null | undefined;
             } | {
                 key: string;
+                required: boolean;
                 type: "boolean";
-                error?: string | undefined;
-                required?: boolean | undefined;
                 array?: boolean | undefined;
+                format?: string | undefined;
+                status?: string | undefined;
+                attributes?: string[] | undefined;
+                orders?: string[] | undefined;
+                $createdAt?: string | undefined;
+                $updatedAt?: string | undefined;
+                error?: string | undefined;
                 xdefault?: boolean | null | undefined;
             } | {
                 key: string;
+                required: boolean;
                 type: "datetime";
-                error?: string | undefined;
-                required?: boolean | undefined;
                 array?: boolean | undefined;
+                format?: string | undefined;
+                status?: string | undefined;
+                attributes?: string[] | undefined;
+                orders?: string[] | undefined;
+                $createdAt?: string | undefined;
+                $updatedAt?: string | undefined;
+                error?: string | undefined;
                 xdefault?: string | null | undefined;
             } | {
                 key: string;
+                required: boolean;
                 type: "email";
-                error?: string | undefined;
-                required?: boolean | undefined;
                 array?: boolean | undefined;
+                format?: string | undefined;
+                status?: string | undefined;
+                attributes?: string[] | undefined;
+                orders?: string[] | undefined;
+                $createdAt?: string | undefined;
+                $updatedAt?: string | undefined;
+                error?: string | undefined;
                 xdefault?: string | null | undefined;
             } | {
                 key: string;
+                required: boolean;
                 type: "ip";
-                error?: string | undefined;
-                required?: boolean | undefined;
                 array?: boolean | undefined;
+                format?: string | undefined;
+                status?: string | undefined;
+                attributes?: string[] | undefined;
+                orders?: string[] | undefined;
+                $createdAt?: string | undefined;
+                $updatedAt?: string | undefined;
+                error?: string | undefined;
                 xdefault?: string | null | undefined;
             } | {
                 key: string;
+                required: boolean;
                 type: "url";
-                error?: string | undefined;
-                required?: boolean | undefined;
                 array?: boolean | undefined;
+                format?: string | undefined;
+                status?: string | undefined;
+                attributes?: string[] | undefined;
+                orders?: string[] | undefined;
+                $createdAt?: string | undefined;
+                $updatedAt?: string | undefined;
+                error?: string | undefined;
                 xdefault?: string | null | undefined;
             } | {
                 key: string;
+                required: boolean;
                 type: "enum";
                 elements: string[];
-                error?: string | undefined;
-                required?: boolean | undefined;
                 array?: boolean | undefined;
-                xdefault?: string | null | undefined;
-            } | {
-                key: string;
-                type: "relationship";
-                relatedCollection: string;
-                relationType: "oneToMany" | "manyToOne" | "oneToOne" | "manyToMany";
-                twoWay: boolean;
-                onDelete: "setNull" | "cascade" | "restrict";
+                format?: string | undefined;
+                status?: string | undefined;
+                attributes?: string[] | undefined;
+                orders?: string[] | undefined;
+                $createdAt?: string | undefined;
+                $updatedAt?: string | undefined;
                 error?: string | undefined;
-                required?: boolean | undefined;
-                array?: boolean | undefined;
-                twoWayKey?: string | undefined;
-                side?: "parent" | "child" | undefined;
-                importMapping?: {
-                    originalIdField: string;
-                    targetField?: string | undefined;
-                } | undefined;
+                xdefault?: string | null | undefined;
             })[];
             columns: undefined;
             indexes: {
@@ -541,7 +672,9 @@ export declare const createSessionPreservingYamlConfig: (configPath: string, ses
             enabled?: boolean | undefined;
             documentSecurity?: boolean | undefined;
             databaseId?: string | undefined;
+            databaseIds?: string[] | undefined;
             tableId?: string | undefined;
+            rowSecurity?: boolean | undefined;
         }[] | undefined;
         functions?: {
             $id: string;

package/dist/examples/yamlTerminologyExample.d.ts

@@ -7,7 +7,7 @@
  * 3. Validate terminology consistency
  * 4. Migrate between formats
  */
-import type { CollectionCreate } from "appwrite-utils";
+import { type CollectionCreate } from "appwrite-utils";
 /**
  * Example 1: Generate YAML templates for both collection and table formats
  */

package/dist/examples/yamlTerminologyExample.js

@@ -11,6 +11,7 @@ import { collectionToYaml, generateYamlTemplate, generateExampleYamls, convertTe
 import { createYamlLoader } from "../utils/yamlLoader.js";
 import { YamlImportIntegration } from "../migrations/yaml/YamlImportIntegration.js";
 import { createImportSchemas } from "../migrations/yaml/generateImportSchemas.js";
+import { CollectionCreateSchema } from "appwrite-utils";
 import fs from "fs";
 import path from "path";
 /**
@@ -208,7 +209,7 @@ export async function runYamlTerminologyExamples(outputDir) {
     console.log("🎯 Running YAML Terminology Examples\\n");
     try {
         // Example collection for demonstrations
-        const exampleCollection = {
+        const exampleCollectionInput = {
             name: "Product",
             $id: "product",
             enabled: true,
@@ -223,7 +224,7 @@ export async function runYamlTerminologyExamples(outputDir) {
                 },
                 {
                     key: "price",
-                    type: "float",
+                    type: "double",
                     required: true,
                     min: 0
                 },
@@ -233,7 +234,8 @@ export async function runYamlTerminologyExamples(outputDir) {
                     relationType: "manyToOne",
                     relatedCollection: "Categories",
                     twoWay: false,
-                    onDelete: "setNull"
+                    onDelete: "setNull",
+                    required: false
                 }
             ],
             indexes: [
@@ -245,6 +247,7 @@ export async function runYamlTerminologyExamples(outputDir) {
             ],
             importDefs: []
         };
+        const exampleCollection = CollectionCreateSchema.parse(exampleCollectionInput);
         // Run examples
         await generateTemplateExamples(outputDir);
         console.log("\\n" + "=".repeat(60) + "\\n");

package/dist/functions/deployments.js

@@ -11,23 +11,7 @@ import { execSync } from "child_process";
 import { createFunction, getFunction, updateFunction, updateFunctionSpecifications, } from "./methods.js";
 import ignore from "ignore";
 import { MessageFormatter } from "../shared/messageFormatter.js";
-const findFunctionDirectory = (basePath, functionName) => {
-    const normalizedName = functionName.toLowerCase().replace(/\s+/g, "-");
-    const dirs = fs.readdirSync(basePath, { withFileTypes: true });
-    for (const dir of dirs) {
-        if (dir.isDirectory()) {
-            const fullPath = join(basePath, dir.name);
-            if (dir.name.toLowerCase() === normalizedName) {
-                return fullPath;
-            }
-            const nestedResult = findFunctionDirectory(fullPath, functionName);
-            if (nestedResult) {
-                return nestedResult;
-            }
-        }
-    }
-    return undefined;
-};
+import { resolveFunctionDirectory, validateFunctionDirectory } from './pathResolution.js';
 export const deployFunction = async (client, functionId, codePath, activate = true, entrypoint = "index.js", commands = "npm install", ignored = [
     "node_modules",
     ".git",
@@ -123,12 +107,10 @@ export const deployLocalFunction = async (client, functionName, functionConfig,
     catch (error) {
         functionExists = false;
     }
-    const resolvedPath = functionPath ||
-        functionConfig.dirPath ||
-        findFunctionDirectory(process.cwd(), functionName) ||
-        join(process.cwd(), "functions", functionName.toLowerCase().replace(/\s+/g, "-"));
-    if (!fs.existsSync(resolvedPath)) {
-        throw new Error(`Function directory not found at ${resolvedPath}`);
+    const configDirPath = process.cwd(); // TODO: This should be passed from caller
+    const resolvedPath = resolveFunctionDirectory(functionName, configDirPath, functionConfig.dirPath, functionPath);
+    if (!validateFunctionDirectory(resolvedPath)) {
+        throw new Error(`Function directory is invalid or missing required files: ${resolvedPath}`);
     }
     if (functionConfig.predeployCommands?.length) {
         MessageFormatter.processing("Executing predeploy commands...", { prefix: "Deployment" });

package/dist/functions/fnConfigDiscovery.d.ts

@@ -0,0 +1,3 @@
+import { type AppwriteFunction } from 'appwrite-utils';
+export declare function discoverFnConfigs(startDir: string): AppwriteFunction[];
+export declare function mergeDiscoveredFunctions(central?: AppwriteFunction[], discovered?: AppwriteFunction[]): AppwriteFunction[];