appwrite-utils-cli 0.10.86 → 1.0.2

package/src/{migrations → utils}/validationRules.ts

@@ -67,7 +67,7 @@ export const validationRules = {
   isDate: (value: any): boolean => isDate(value),
   isEmpty: (value: any): boolean => isEmpty(value),
   isInteger: (value: any): boolean => isInteger(value),
-  isFloat: (value: any): boolean => isNumber(value) && !isInteger(value),
+  isFloat: (value: any): boolean => isNumber(value) && !isInteger(value), // Note: Works for double precision numbers
   isArrayLike: (value: any): boolean => isArrayLike(value),
   isArrayLikeObject: (value: any): boolean => isArrayLikeObject(value),
   isFunction: (value: any): boolean => isFunction(value),

package/src/utils/yamlConverter.ts

@@ -0,0 +1,131 @@
+import yaml from "js-yaml";
+import type { Collection, CollectionCreate } from "appwrite-utils";
+
+export interface YamlCollectionData {
+  name: string;
+  id?: string;
+  documentSecurity?: boolean;
+  enabled?: boolean;
+  permissions?: Array<{
+    permission: string;
+    target: string;
+  }>;
+  attributes?: Array<{
+    key: string;
+    type: string;
+    size?: number;
+    required?: boolean;
+    array?: boolean;
+    default?: any;
+    description?: string;
+    min?: number;
+    max?: number;
+    elements?: string[];
+    relatedCollection?: string;
+    relationType?: string;
+    twoWay?: boolean;
+    twoWayKey?: string;
+    onDelete?: string;
+    side?: string;
+  }>;
+  indexes?: Array<{
+    key: string;
+    type: string;
+    attributes: string[];
+    orders?: string[];
+  }>;
+  importDefs?: any[];
+}
+
+/**
+ * Converts a Collection object to YAML format with proper schema reference
+ */
+export function collectionToYaml(collection: Collection | CollectionCreate, schemaPath = "../.yaml_schemas/collection.schema.json"): string {
+  // Convert Collection to YamlCollectionData format
+  const yamlData: YamlCollectionData = {
+    name: collection.name,
+    id: collection.$id,
+    documentSecurity: collection.documentSecurity,
+    enabled: collection.enabled,
+  };
+
+  // Convert permissions
+  if (collection.$permissions && collection.$permissions.length > 0) {
+    yamlData.permissions = collection.$permissions.map(p => ({
+      permission: p.permission,
+      target: p.target
+    }));
+  }
+
+  // Convert attributes
+  if (collection.attributes && collection.attributes.length > 0) {
+    yamlData.attributes = collection.attributes.map(attr => {
+      const yamlAttr: any = {
+        key: attr.key,
+        type: attr.type,
+      };
+
+      // Add optional properties only if they exist (safely access with 'in' operator)
+      if ('size' in attr && attr.size !== undefined) yamlAttr.size = attr.size;
+      if (attr.required !== undefined) yamlAttr.required = attr.required;
+      if (attr.array !== undefined) yamlAttr.array = attr.array;
+      if ('xdefault' in attr && attr.xdefault !== undefined) yamlAttr.default = attr.xdefault;
+      if (attr.description !== undefined) yamlAttr.description = attr.description;
+      if ('min' in attr && attr.min !== undefined) yamlAttr.min = attr.min;
+      if ('max' in attr && attr.max !== undefined) yamlAttr.max = attr.max;
+      if ('elements' in attr && attr.elements !== undefined) yamlAttr.elements = attr.elements;
+      if ('relatedCollection' in attr && attr.relatedCollection !== undefined) yamlAttr.relatedCollection = attr.relatedCollection;
+      if ('relationType' in attr && attr.relationType !== undefined) yamlAttr.relationType = attr.relationType;
+      if ('twoWay' in attr && attr.twoWay !== undefined) yamlAttr.twoWay = attr.twoWay;
+      if ('twoWayKey' in attr && attr.twoWayKey !== undefined) yamlAttr.twoWayKey = attr.twoWayKey;
+      if ('onDelete' in attr && attr.onDelete !== undefined) yamlAttr.onDelete = attr.onDelete;
+      if ('side' in attr && attr.side !== undefined) yamlAttr.side = attr.side;
+
+      return yamlAttr;
+    });
+  }
+
+  // Convert indexes
+  if (collection.indexes && collection.indexes.length > 0) {
+    yamlData.indexes = collection.indexes.map(idx => ({
+      key: idx.key,
+      type: idx.type,
+      attributes: idx.attributes,
+      ...(idx.orders && idx.orders.length > 0 ? { orders: idx.orders } : {})
+    }));
+  }
+
+  // Add import definitions if they exist
+  if (collection.importDefs && collection.importDefs.length > 0) {
+    yamlData.importDefs = collection.importDefs;
+  } else {
+    yamlData.importDefs = [];
+  }
+
+  // Generate YAML with schema reference
+  const yamlContent = yaml.dump(yamlData, {
+    indent: 2,
+    lineWidth: 120,
+    sortKeys: false,
+    quotingType: '"',
+    forceQuotes: false,
+  });
+
+  return `# yaml-language-server: $schema=${schemaPath}
+# Collection Definition: ${collection.name}
+${yamlContent}`;
+}
+
+/**
+ * Sanitizes a collection name for use as a filename
+ */
+export function sanitizeFilename(name: string): string {
+  return name.replace(/[^a-zA-Z0-9_-]/g, '_');
+}
+
+/**
+ * Generates the filename for a collection YAML file
+ */
+export function getCollectionYamlFilename(collection: Collection | CollectionCreate): string {
+  return `${sanitizeFilename(collection.name)}.yaml`;
+}

package/src/utilsController.ts

@@ -13,10 +13,11 @@ import {
 } from "appwrite-utils";
 import {
   loadConfig,
+  loadConfigWithPath,
   findAppwriteConfig,
   findFunctionsDir,
 } from "./utils/loadConfigs.js";
-import { UsersController } from "./migrations/users.js";
+import { UsersController } from "./users/methods.js";
 import { AppwriteToX } from "./migrations/appwriteToX.js";
 import { ImportController } from "./migrations/importController.js";
 import { ImportDataActions } from "./migrations/importDataActions.js";
@@ -25,7 +26,7 @@ import {
   ensureDatabasesExist,
   wipeOtherDatabases,
   ensureCollectionsExist,
-} from "./migrations/setupDatabase.js";
+} from "./databases/setup.js";
 import {
   createOrUpdateCollections,
   wipeDatabase,
@@ -57,7 +58,7 @@ import {
   type TransferOptions,
 } from "./migrations/transfer.js";
 import { getClient } from "./utils/getClientFromConfig.js";
-import { fetchAllDatabases } from "./migrations/databases.js";
+import { fetchAllDatabases } from "./databases/methods.js";
 import {
   listFunctions,
   updateFunctionSpecifications,
@@ -65,6 +66,8 @@ import {
 import chalk from "chalk";
 import { deployLocalFunction } from "./functions/deployments.js";
 import fs from "node:fs";
+import { configureLogging, updateLogger } from "./shared/logging.js";
+import { MessageFormatter, Messages } from "./shared/messageFormatter.js";
 
 export interface SetupOptions {
   databases?: Models.Database[];
@@ -105,15 +108,15 @@ export class UtilsController {
     if (directConfig) {
       let hasErrors = false;
       if (!directConfig.appwriteEndpoint) {
-        console.log(chalk.red("Appwrite endpoint is required"));
+        MessageFormatter.error("Appwrite endpoint is required", undefined, { prefix: "Config" });
         hasErrors = true;
       }
       if (!directConfig.appwriteProject) {
-        console.log(chalk.red("Appwrite project is required"));
+        MessageFormatter.error("Appwrite project is required", undefined, { prefix: "Config" });
         hasErrors = true;
       }
       if (!directConfig.appwriteKey) {
-        console.log(chalk.red("Appwrite key is required"));
+        MessageFormatter.error("Appwrite key is required", undefined, { prefix: "Config" });
         hasErrors = true;
       }
       if (!hasErrors) {
@@ -130,42 +133,56 @@ export class UtilsController {
           enableMockData: false,
           documentBucketId: "",
           usersCollectionName: "",
+          useMigrations: true,
           databases: [],
           buckets: [],
           functions: [],
+          logging: {
+            enabled: false,
+            level: "info",
+            console: false,
+          },
         };
       }
     } else {
       // Try to find config file
       const appwriteConfigFound = findAppwriteConfig(basePath);
       if (!appwriteConfigFound) {
-        console.log(
-          chalk.yellow(
-            "No appwriteConfig.ts found and no direct configuration provided"
-          )
+        MessageFormatter.warning(
+          "No appwriteConfig.ts found and no direct configuration provided",
+          { prefix: "Config" }
         );
         return;
       }
       this.appwriteConfigPath = appwriteConfigFound;
-      this.appwriteFolderPath = path.dirname(appwriteConfigFound);
+      this.appwriteFolderPath = appwriteConfigFound; // For YAML configs, findAppwriteConfig already returns the correct directory
     }
   }
 
   async init() {
     if (!this.config) {
       if (this.appwriteFolderPath && this.appwriteConfigPath) {
-        console.log("Loading config from file...");
-        this.config = await loadConfig(this.appwriteFolderPath);
-        if (!this.config) {
-          console.log(chalk.red("Failed to load config from file"));
+        MessageFormatter.progress("Loading config from file...", { prefix: "Config" });
+        try {
+          const { config, actualConfigPath } = await loadConfigWithPath(this.appwriteFolderPath);
+          this.config = config;
+          MessageFormatter.info(`Loaded config from: ${actualConfigPath}`, { prefix: "Config" });
+        } catch (error) {
+          MessageFormatter.error("Failed to load config from file", undefined, { prefix: "Config" });
           return;
         }
       } else {
-        console.log(chalk.red("No configuration available"));
+        MessageFormatter.error("No configuration available", undefined, { prefix: "Config" });
         return;
       }
     }
 
+    // Configure logging based on config
+    if (this.config.logging) {
+      configureLogging(this.config.logging);
+      updateLogger();
+    }
+
     this.appwriteServer = new Client();
     this.appwriteServer
       .setEndpoint(this.config.appwriteEndpoint)
@@ -179,7 +196,7 @@ export class UtilsController {
 
   async reloadConfig() {
     if (!this.appwriteFolderPath) {
-      console.log(chalk.red("Failed to get appwriteFolderPath"));
+      MessageFormatter.error("Failed to get appwriteFolderPath", undefined, { prefix: "Controller" });
       return;
     }
     this.config = await loadConfig(this.appwriteFolderPath);
@@ -187,6 +204,13 @@ export class UtilsController {
       console.log(chalk.red("Failed to load config"));
       return;
     }
+
+    // Configure logging based on updated config
+    if (this.config.logging) {
+      configureLogging(this.config.logging);
+      updateLogger();
+    }
+
     this.appwriteServer = new Client();
     this.appwriteServer
       .setEndpoint(this.config.appwriteEndpoint)
@@ -200,7 +224,7 @@ export class UtilsController {
   async setupMigrationDatabase() {
     await this.init();
     if (!this.config) {
-      console.log(chalk.red("Config not initialized"));
+      MessageFormatter.error("Config not initialized", undefined, { prefix: "Controller" });
       return;
     }
     await setupMigrationDatabase(this.config);
@@ -209,11 +233,11 @@ export class UtilsController {
   async ensureDatabaseConfigBucketsExist(databases: Models.Database[] = []) {
     await this.init();
     if (!this.storage) {
-      console.log(chalk.red("Storage not initialized"));
+      MessageFormatter.error("Storage not initialized", undefined, { prefix: "Controller" });
       return;
     }
     if (!this.config) {
-      console.log(chalk.red("Config not initialized"));
+      MessageFormatter.error("Config not initialized", undefined, { prefix: "Controller" });
       return;
     }
     await ensureDatabaseConfigBucketsExist(
@@ -226,7 +250,7 @@ export class UtilsController {
   async ensureDatabasesExist(databases?: Models.Database[]) {
     await this.init();
     if (!this.config) {
-      console.log(chalk.red("Config not initialized"));
+      MessageFormatter.error("Config not initialized", undefined, { prefix: "Controller" });
       return;
     }
     await this.setupMigrationDatabase();
@@ -240,7 +264,7 @@ export class UtilsController {
   ) {
     await this.init();
     if (!this.config) {
-      console.log(chalk.red("Config not initialized"));
+      MessageFormatter.error("Config not initialized", undefined, { prefix: "Controller" });
       return;
     }
     await ensureCollectionsExist(this.config, database, collections);
@@ -249,7 +273,7 @@ export class UtilsController {
   async getDatabasesByIds(ids: string[]) {
     await this.init();
     if (!this.database) {
-      console.log(chalk.red("Database not initialized"));
+      MessageFormatter.error("Database not initialized", undefined, { prefix: "Controller" });
       return;
     }
     if (ids.length === 0) return [];
@@ -263,10 +287,10 @@ export class UtilsController {
   async wipeOtherDatabases(databasesToKeep: Models.Database[]) {
     await this.init();
     if (!this.database) {
-      console.log(chalk.red("Database not initialized"));
+      MessageFormatter.error("Database not initialized", undefined, { prefix: "Controller" });
       return;
     }
-    await wipeOtherDatabases(this.database, databasesToKeep);
+    await wipeOtherDatabases(this.database, databasesToKeep, this.config?.useMigrations ?? true);
   }
 
   async wipeUsers() {
@@ -307,7 +331,7 @@ export class UtilsController {
 
   async findFunctionDirectories() {
     if (!this.appwriteFolderPath) {
-      console.log(chalk.red("Failed to get appwriteFolderPath"));
+      MessageFormatter.error("Failed to get appwriteFolderPath", undefined, { prefix: "Controller" });
       return new Map();
     }
     const functionsDir = findFunctionsDir(this.appwriteFolderPath);
@@ -378,11 +402,11 @@ export class UtilsController {
     ]);
 
     for (const localFunction of localFunctions) {
-      console.log(chalk.blue(`Syncing function ${localFunction.name}...`));
+      MessageFormatter.progress(`Syncing function ${localFunction.name}...`, { prefix: "Functions" });
       await this.deployFunction(localFunction.name);
     }
 
-    console.log(chalk.green("✨ All functions synchronized successfully!"));
+    MessageFormatter.success("All functions synchronized successfully!", { prefix: "Functions" });
   }
 
   async wipeDatabase(database: Models.Database, wipeBucket: boolean = false) {
@@ -443,7 +467,7 @@ export class UtilsController {
     if (!this.database || !this.config)
       throw new Error("Database or config not initialized");
     for (const database of databases) {
-      if (database.$id === "migrations") continue;
+      if (!this.config.useMigrations && database.$id === "migrations") continue;
       await this.createOrUpdateCollections(database, undefined, collections);
     }
   }
@@ -468,11 +492,11 @@ export class UtilsController {
   async generateSchemas() {
     await this.init();
     if (!this.config) {
-      console.log(chalk.red("Config not initialized"));
+      MessageFormatter.error("Config not initialized", undefined, { prefix: "Controller" });
       return;
     }
     if (!this.appwriteFolderPath) {
-      console.log(chalk.red("Failed to get appwriteFolderPath"));
+      MessageFormatter.error("Failed to get appwriteFolderPath", undefined, { prefix: "Controller" });
       return;
     }
     await generateSchemas(this.config, this.appwriteFolderPath);
@@ -481,19 +505,19 @@ export class UtilsController {
   async importData(options: SetupOptions = {}) {
     await this.init();
     if (!this.database) {
-      console.log(chalk.red("Database not initialized"));
+      MessageFormatter.error("Database not initialized", undefined, { prefix: "Controller" });
       return;
     }
     if (!this.storage) {
-      console.log(chalk.red("Storage not initialized"));
+      MessageFormatter.error("Storage not initialized", undefined, { prefix: "Controller" });
       return;
     }
     if (!this.config) {
-      console.log(chalk.red("Config not initialized"));
+      MessageFormatter.error("Config not initialized", undefined, { prefix: "Controller" });
       return;
     }
     if (!this.appwriteFolderPath) {
-      console.log(chalk.red("Failed to get appwriteFolderPath"));
+      MessageFormatter.error("Failed to get appwriteFolderPath", undefined, { prefix: "Controller" });
       return;
     }
 
@@ -524,16 +548,16 @@ export class UtilsController {
   ) {
     await this.init();
     if (!this.storage) {
-      console.log(chalk.red("Storage not initialized"));
+      MessageFormatter.error("Storage not initialized", undefined, { prefix: "Controller" });
       return;
     }
     const configToUse = config || this.config;
     if (!configToUse) {
-      console.log(chalk.red("Config not initialized"));
+      MessageFormatter.error("Config not initialized", undefined, { prefix: "Controller" });
       return;
     }
     if (!this.appwriteFolderPath) {
-      console.log(chalk.red("Failed to get appwriteFolderPath"));
+      MessageFormatter.error("Failed to get appwriteFolderPath", undefined, { prefix: "Controller" });
       return;
     }
     const appwriteToX = new AppwriteToX(
@@ -550,7 +574,7 @@ export class UtilsController {
   ) {
     await this.init();
     if (!this.database) {
-      console.log(chalk.red("Database not initialized"));
+      MessageFormatter.error("Database not initialized", undefined, { prefix: "Controller" });
       return;
     }
     if (databases.length === 0) {
@@ -644,7 +668,7 @@ export class UtilsController {
         console.log(chalk.red("Appwrite server not initialized"));
         return;
       } else {
-        console.log(chalk.blue("Starting user transfer..."));
+        MessageFormatter.progress("Starting user transfer...", { prefix: "Transfer" });
         const localUsers = new Users(this.appwriteServer);
         await transferUsersLocalToRemote(
           localUsers,
@@ -652,7 +676,7 @@ export class UtilsController {
           options.transferProject!,
           options.transferKey!
         );
-        console.log(chalk.green("User transfer completed"));
+        MessageFormatter.success("User transfer completed", { prefix: "Transfer" });
       }
     }
 
@@ -677,10 +701,9 @@ export class UtilsController {
             .replace(/\s+/g, "")}`);
 
       if (sourceBucketId && targetBucketId) {
-        console.log(
-          chalk.blue(
-            `Starting storage transfer from ${sourceBucketId} to ${targetBucketId}`
-          )
+        MessageFormatter.progress(
+          `Starting storage transfer from ${sourceBucketId} to ${targetBucketId}`,
+          { prefix: "Transfer" }
         );
 
         if (options.isRemote) {
@@ -702,7 +725,7 @@ export class UtilsController {
       }
     }
 
-    console.log(chalk.green("Transfer completed"));
+    MessageFormatter.success("Transfer completed", { prefix: "Transfer" });
   }
 
   async updateFunctionSpecifications(
@@ -712,20 +735,18 @@ export class UtilsController {
     await this.init();
     if (!this.appwriteServer)
       throw new Error("Appwrite server not initialized");
-    console.log(
-      chalk.green(
-        `Updating function specifications for ${functionId} to ${specification}`
-      )
+    MessageFormatter.progress(
+      `Updating function specifications for ${functionId} to ${specification}`,
+      { prefix: "Functions" }
     );
     await updateFunctionSpecifications(
       this.appwriteServer,
       functionId,
       specification
     );
-    console.log(
-      chalk.green(
-        `Successfully updated function specifications for ${functionId} to ${specification}`
-      )
+    MessageFormatter.success(
+      `Successfully updated function specifications for ${functionId} to ${specification}`,
+      { prefix: "Functions" }
     );
   }
 }

package/src/functions/templates/poetry/README.md

@@ -1,30 +0,0 @@
-# Python Poetry Function Template
-
-This is a Python template for Appwrite Functions using Poetry for dependency management.
-
-## Structure
-- `src/index.py`: Main function entry point
-- `pyproject.toml`: Poetry configuration and dependencies
-
-## Usage
-Your function will receive a context object with:
-- `req`: Request object containing request data, headers, and environment variables
-- `res`: Response object for sending responses
-- `log`: Function for logging (shows in your function logs)
-- `error`: Function for error logging
-
-## Example Request
-```json
-{
-  "key": "value"
-}
-```
-
-## Development
-1. Install Poetry: `curl -sSL https://install.python-poetry.org | python3 -`
-2. Install dependencies: `poetry install`
-3. Deploy: Dependencies will be installed during deployment
-
-## Deployment
-Make sure it's inside `appwriteConfig.ts` functions array, and if you want to install dependencies FIRST, before Appwrite (using your system), you can
-add the `predeployCommands` to the function in `appwriteConfig.ts`.

package/src/functions/templates/poetry/pyproject.toml

@@ -1,16 +0,0 @@
-[tool.poetry]
-name = "{{functionName}}"
-version = "0.1.0"
-description = ""
-authors = ["Your Name <you@example.com>"]
-packages = [
-    { include = "src" }
-]
-
-[tool.poetry.dependencies]
-python = "^3.9"
-appwrite = "^7.0.1"
-
-[build-system]
-requires = ["poetry-core>=1.0.0"]
-build-backend = "poetry.core.masonry.api"