@njdamstra/appwrite-utils-cli 1.8.9 → 1.10.0

package/src/shared/selectionDialogs.ts

@@ -1,8 +1,8 @@
 import inquirer from "inquirer";
 import chalk from "chalk";
 import type { Models } from "node-appwrite";
-import { MessageFormatter } from "./messageFormatter.js";
-import { logger } from "./logging.js";
+import { MessageFormatter } from '@njdamstra/appwrite-utils-helpers';
+import { logger } from '@njdamstra/appwrite-utils-helpers';
 
 /**
  * Interface for sync selection summary
@@ -307,7 +307,7 @@ export class SelectionDialogs {
       MessageFormatter.section(`Table Selection for ${databaseName}`);
     }
 
-    const configuredIds = new Set(configuredTables.map(table => table.$id || table.id));
+    const configuredIds = new Set(configuredTables.map(table => table.$id || table.id || (table as any).tableId || table.name));
 
     let choices: any[] = [];
 
@@ -320,9 +320,10 @@ export class SelectionDialogs {
     }
 
     availableTables.forEach(table => {
-      const isConfigured = configuredIds.has(table.$id);
+      const tableId = table.$id || table.id || (table as any).tableId || table.name;
+      const isConfigured = configuredIds.has(tableId);
       const status = isConfigured ? chalk.green('✅') : chalk.blue('○');
-      const name = `${status} ${table.name} (${table.$id})`;
+      const name = `${status} ${table.name} (${tableId})`;
 
       if (allowNewOnly && isConfigured) {
         return; // Skip configured tables if only allowing new ones
@@ -330,10 +331,10 @@ export class SelectionDialogs {
 
       choices.push({
         name,
-        value: table.$id,
+        value: tableId,
         short: table.name,
         // Do not preselect anything unless explicitly provided
-        checked: defaultSelected.includes(table.$id)
+        checked: defaultSelected.includes(tableId)
       });
     });
 
@@ -360,7 +361,7 @@ export class SelectionDialogs {
 
     // Handle select all
     if (selectedTableIds.includes('__SELECT_ALL__')) {
-      const allIds = availableTables.map(table => table.$id);
+      const allIds = availableTables.map(table => table.$id || table.id || (table as any).tableId || table.name);
       if (allowNewOnly) {
         return allIds.filter(id => !configuredIds.has(id));
       }

package/src/storage/methods.ts

@@ -8,17 +8,17 @@ import {
   type Models,
 } from "node-appwrite";
 import { tryAwaitWithRetry, type AppwriteConfig } from "@njdamstra/appwrite-utils";
-import { getClientFromConfig } from "../utils/getClientFromConfig.js";
+import { getClientFromConfig } from "@njdamstra/appwrite-utils-helpers";
 import { ulid } from "ulidx";
 import type { BackupCreate } from "./schemas.js";
 import { logOperation } from "../shared/operationLogger.js";
 import { splitIntoBatches } from "../shared/migrationHelpers.js";
-import { retryFailedPromises } from "../utils/retryFailedPromises.js";
+import { retryFailedPromises } from "@njdamstra/appwrite-utils-helpers";
 import { InputFile } from "node-appwrite/file";
-import { MessageFormatter, Messages } from "../shared/messageFormatter.js";
+import { MessageFormatter, Messages } from "@njdamstra/appwrite-utils-helpers";
 import { ProgressManager } from "../shared/progressManager.js";
 import { recordBackup } from "../shared/backupTracking.js";
-import { AdapterFactory } from "../adapters/AdapterFactory.js";
+import { AdapterFactory } from "@njdamstra/appwrite-utils-helpers";
 import { createBackupZip } from "./backupCompression.js";
 
 export const getStorage = (config: AppwriteConfig) => {

package/src/tables/indexManager.ts

@@ -0,0 +1,409 @@
+import type { Index } from "@njdamstra/appwrite-utils";
+import type { DatabaseAdapter } from "@njdamstra/appwrite-utils-helpers";
+import type { Models } from "node-appwrite";
+import { isIndexEqualToIndex } from "../collections/tableOperations.js";
+import { MessageFormatter } from "@njdamstra/appwrite-utils-helpers";
+import { delay, tryAwaitWithRetry } from "@njdamstra/appwrite-utils-helpers";
+
+// Enhanced index operation interfaces
+export interface IndexOperation {
+  type: 'create' | 'update' | 'skip' | 'delete';
+  index: Index;
+  existingIndex?: Models.Index;
+  reason?: string;
+}
+
+export interface IndexOperationPlan {
+  toCreate: IndexOperation[];
+  toUpdate: IndexOperation[];
+  toSkip: IndexOperation[];
+  toDelete: IndexOperation[];
+}
+
+export interface IndexExecutionResult {
+  created: string[];
+  updated: string[];
+  skipped: string[];
+  deleted: string[];
+  errors: Array<{ key: string; error: string }>;
+  summary: {
+    total: number;
+    created: number;
+    updated: number;
+    skipped: number;
+    deleted: number;
+    errors: number;
+  };
+}
+
+/**
+ * Plan index operations by comparing desired indexes with existing ones
+ * Uses the existing isIndexEqualToIndex function for consistent comparison
+ */
+export function planIndexOperations(
+  desiredIndexes: Index[],
+  existingIndexes: Models.Index[]
+): IndexOperationPlan {
+  const plan: IndexOperationPlan = {
+    toCreate: [],
+    toUpdate: [],
+    toSkip: [],
+    toDelete: []
+  };
+
+  for (const desiredIndex of desiredIndexes) {
+    const existingIndex = existingIndexes.find(idx => idx.key === desiredIndex.key);
+
+    if (!existingIndex) {
+      // Index doesn't exist - create it
+      plan.toCreate.push({
+        type: 'create',
+        index: desiredIndex,
+        reason: 'New index'
+      });
+    } else if (isIndexEqualToIndex(existingIndex, desiredIndex)) {
+      // Index exists and is identical - skip it
+      plan.toSkip.push({
+        type: 'skip',
+        index: desiredIndex,
+        existingIndex,
+        reason: 'Index unchanged'
+      });
+    } else {
+      // Index exists but is different - update it
+      plan.toUpdate.push({
+        type: 'update',
+        index: desiredIndex,
+        existingIndex,
+        reason: 'Index configuration changed'
+      });
+    }
+  }
+
+  return plan;
+}
+
+/**
+ * Plan index deletions for indexes that exist but aren't in the desired configuration
+ */
+export function planIndexDeletions(
+  desiredIndexKeys: Set<string>,
+  existingIndexes: Models.Index[]
+): IndexOperation[] {
+  const deletions: IndexOperation[] = [];
+
+  for (const existingIndex of existingIndexes) {
+    if (!desiredIndexKeys.has(existingIndex.key)) {
+      deletions.push({
+        type: 'delete',
+        index: existingIndex as Index, // Convert Models.Index to Index for compatibility
+        reason: 'Obsolete index'
+      });
+    }
+  }
+
+  return deletions;
+}
+
+/**
+ * Execute index operations with proper error handling and status monitoring
+ */
+export async function executeIndexOperations(
+  adapter: DatabaseAdapter,
+  databaseId: string,
+  tableId: string,
+  plan: IndexOperationPlan
+): Promise<IndexExecutionResult> {
+  const result: IndexExecutionResult = {
+    created: [],
+    updated: [],
+    skipped: [],
+    deleted: [],
+    errors: [],
+    summary: {
+      total: 0,
+      created: 0,
+      updated: 0,
+      skipped: 0,
+      deleted: 0,
+      errors: 0
+    }
+  };
+
+  // Execute creates
+  for (const operation of plan.toCreate) {
+    try {
+      await adapter.createIndex({
+        databaseId,
+        tableId,
+        key: operation.index.key,
+        type: operation.index.type,
+        attributes: operation.index.attributes,
+        orders: operation.index.orders || []
+      });
+
+      result.created.push(operation.index.key);
+      MessageFormatter.success(`Created index ${operation.index.key}`, { prefix: 'Indexes' });
+
+      // Wait for index to become available
+      await waitForIndexAvailable(adapter, databaseId, tableId, operation.index.key);
+
+      await delay(150); // Brief delay between operations
+    } catch (error) {
+      const errorMessage = error instanceof Error ? error.message : String(error);
+      result.errors.push({ key: operation.index.key, error: errorMessage });
+      MessageFormatter.error(`Failed to create index ${operation.index.key}`, error instanceof Error ? error : new Error(String(error)), { prefix: 'Indexes' });
+    }
+  }
+
+  // Execute updates (delete + recreate)
+  for (const operation of plan.toUpdate) {
+    try {
+      // Delete existing index first
+      await adapter.deleteIndex({
+        databaseId,
+        tableId,
+        key: operation.index.key
+      });
+
+      await delay(100); // Brief delay for deletion to settle
+
+      // Create new index
+      await adapter.createIndex({
+        databaseId,
+        tableId,
+        key: operation.index.key,
+        type: operation.index.type,
+        attributes: operation.index.attributes,
+        orders: operation.index.orders || operation.existingIndex?.orders || []
+      });
+
+      result.updated.push(operation.index.key);
+      MessageFormatter.success(`Updated index ${operation.index.key}`, { prefix: 'Indexes' });
+
+      // Wait for index to become available
+      await waitForIndexAvailable(adapter, databaseId, tableId, operation.index.key);
+
+      await delay(150); // Brief delay between operations
+    } catch (error) {
+      const errorMessage = error instanceof Error ? error.message : String(error);
+      result.errors.push({ key: operation.index.key, error: errorMessage });
+      MessageFormatter.error(`Failed to update index ${operation.index.key}`, error instanceof Error ? error : new Error(String(error)), { prefix: 'Indexes' });
+    }
+  }
+
+  // Execute skips
+  for (const operation of plan.toSkip) {
+    result.skipped.push(operation.index.key);
+    MessageFormatter.info(`Index ${operation.index.key} unchanged`, { prefix: 'Indexes' });
+  }
+
+  // Calculate summary
+  result.summary.total = result.created.length + result.updated.length + result.skipped.length + result.deleted.length;
+  result.summary.created = result.created.length;
+  result.summary.updated = result.updated.length;
+  result.summary.skipped = result.skipped.length;
+  result.summary.deleted = result.deleted.length;
+  result.summary.errors = result.errors.length;
+
+  return result;
+}
+
+/**
+ * Execute index deletions with proper error handling
+ */
+export async function executeIndexDeletions(
+  adapter: DatabaseAdapter,
+  databaseId: string,
+  tableId: string,
+  deletions: IndexOperation[]
+): Promise<{ deleted: string[]; errors: Array<{ key: string; error: string }> }> {
+  const result = {
+    deleted: [] as string[],
+    errors: [] as Array<{ key: string; error: string }>
+  };
+
+  for (const operation of deletions) {
+    try {
+      await adapter.deleteIndex({
+        databaseId,
+        tableId,
+        key: operation.index.key
+      });
+
+      result.deleted.push(operation.index.key);
+      MessageFormatter.info(`Deleted obsolete index ${operation.index.key}`, { prefix: 'Indexes' });
+
+      // Wait briefly for deletion to settle
+      await delay(500);
+    } catch (error) {
+      const errorMessage = error instanceof Error ? error.message : String(error);
+      result.errors.push({ key: operation.index.key, error: errorMessage });
+      MessageFormatter.error(`Failed to delete index ${operation.index.key}`, error instanceof Error ? error : new Error(String(error)), { prefix: 'Indexes' });
+    }
+  }
+
+  return result;
+}
+
+/**
+ * Wait for an index to become available with timeout and retry logic
+ * This is an adapter-aware version of the logic from collections/indexes.ts
+ */
+async function waitForIndexAvailable(
+  adapter: DatabaseAdapter,
+  databaseId: string,
+  tableId: string,
+  indexKey: string,
+  maxWaitTime: number = 60000, // 1 minute
+  checkInterval: number = 2000 // 2 seconds
+): Promise<boolean> {
+  const startTime = Date.now();
+
+  while (Date.now() - startTime < maxWaitTime) {
+    try {
+      const indexList = await adapter.listIndexes({ databaseId, tableId });
+      const indexes: any[] = (indexList as any).data || (indexList as any).indexes || [];
+      const index = indexes.find((idx: any) => idx.key === indexKey);
+
+      if (!index) {
+        MessageFormatter.error(`Index '${indexKey}' not found after creation`, undefined, { prefix: 'Indexes' });
+        return false;
+      }
+
+      switch (index.status) {
+        case 'available':
+          return true;
+
+        case 'failed':
+          MessageFormatter.error(`Index '${indexKey}' failed: ${index.error || 'unknown error'}`, undefined, { prefix: 'Indexes' });
+          return false;
+
+        case 'stuck':
+          MessageFormatter.warning(`Index '${indexKey}' is stuck`, { prefix: 'Indexes' });
+          return false;
+
+        case 'processing':
+        case 'deleting':
+          // Continue waiting
+          break;
+
+        default:
+          MessageFormatter.warning(`Unknown status '${index.status}' for index '${indexKey}'`, { prefix: 'Indexes' });
+          break;
+      }
+    } catch (error) {
+      MessageFormatter.error(`Error checking index '${indexKey}' status: ${error}`, undefined, { prefix: 'Indexes' });
+    }
+
+    await delay(checkInterval);
+  }
+
+  MessageFormatter.warning(`Timeout waiting for index '${indexKey}' to become available (${maxWaitTime}ms)`, { prefix: 'Indexes' });
+  return false;
+}
+
+/**
+ * Main function to create/update indexes via adapter
+ * This replaces the messy inline code in methods.ts
+ */
+export async function createOrUpdateIndexesViaAdapter(
+  adapter: DatabaseAdapter,
+  databaseId: string,
+  tableId: string,
+  desiredIndexes: Index[],
+  configIndexes?: Index[]
+): Promise<void> {
+  if (!desiredIndexes || desiredIndexes.length === 0) {
+    MessageFormatter.info('No indexes to process', { prefix: 'Indexes' });
+    return;
+  }
+
+  MessageFormatter.info(`Processing ${desiredIndexes.length} indexes for table ${tableId}`, { prefix: 'Indexes' });
+
+  try {
+    // Get existing indexes
+    const existingIdxRes = await adapter.listIndexes({ databaseId, tableId });
+    const existingIndexes: Models.Index[] = (existingIdxRes as any).data || (existingIdxRes as any).indexes || [];
+
+    // Plan operations
+    const plan = planIndexOperations(desiredIndexes, existingIndexes);
+
+    // Show plan with icons (consistent with attribute handling)
+    const planParts: string[] = [];
+    if (plan.toCreate.length) planParts.push(`➕  ${plan.toCreate.length} (${plan.toCreate.map(op => op.index.key).join(', ')})`);
+    if (plan.toUpdate.length) planParts.push(`🔧  ${plan.toUpdate.length} (${plan.toUpdate.map(op => op.index.key).join(', ')})`);
+    if (plan.toSkip.length) planParts.push(`⏭️  ${plan.toSkip.length}`);
+
+    MessageFormatter.info(`Plan → ${planParts.join('  |  ') || 'no changes'}`, { prefix: 'Indexes' });
+
+    // Execute operations
+    const result = await executeIndexOperations(adapter, databaseId, tableId, plan);
+
+    // Show summary
+    MessageFormatter.info(
+      `Summary → ➕  ${result.summary.created}  |  🔧  ${result.summary.updated}  |  ⏭️  ${result.summary.skipped}`,
+      { prefix: 'Indexes' }
+    );
+
+    // Handle errors if any
+    if (result.errors.length > 0) {
+      MessageFormatter.error(`${result.errors.length} index operations failed:`, undefined, { prefix: 'Indexes' });
+      for (const error of result.errors) {
+        MessageFormatter.error(`  ${error.key}: ${error.error}`, undefined, { prefix: 'Indexes' });
+      }
+    }
+
+  } catch (error) {
+    MessageFormatter.error('Failed to process indexes', error instanceof Error ? error : new Error(String(error)), { prefix: 'Indexes' });
+    throw error;
+  }
+}
+
+/**
+ * Handle index deletions for obsolete indexes
+ */
+export async function deleteObsoleteIndexesViaAdapter(
+  adapter: DatabaseAdapter,
+  databaseId: string,
+  tableId: string,
+  desiredIndexKeys: Set<string>
+): Promise<void> {
+  try {
+    // Get existing indexes
+    const existingIdxRes = await adapter.listIndexes({ databaseId, tableId });
+    const existingIndexes: Models.Index[] = (existingIdxRes as any).data || (existingIdxRes as any).indexes || [];
+
+    // Plan deletions
+    const deletions = planIndexDeletions(desiredIndexKeys, existingIndexes);
+
+    if (deletions.length === 0) {
+      MessageFormatter.info('Plan → 🗑️  0 indexes', { prefix: 'Indexes' });
+      return;
+    }
+
+    // Show deletion plan
+    MessageFormatter.info(
+      `Plan → 🗑️  ${deletions.length} (${deletions.map(op => op.index.key).join(', ')})`,
+      { prefix: 'Indexes' }
+    );
+
+    // Execute deletions
+    const result = await executeIndexDeletions(adapter, databaseId, tableId, deletions);
+
+    // Show results
+    if (result.deleted.length > 0) {
+      MessageFormatter.success(`Deleted ${result.deleted.length} indexes: ${result.deleted.join(', ')}`, { prefix: 'Indexes' });
+    }
+
+    if (result.errors.length > 0) {
+      MessageFormatter.error(`${result.errors.length} index deletions failed:`, undefined, { prefix: 'Indexes' });
+      for (const error of result.errors) {
+        MessageFormatter.error(`  ${error.key}: ${error.error}`, undefined, { prefix: 'Indexes' });
+      }
+    }
+
+  } catch (error) {
+    MessageFormatter.warning(`Could not evaluate index deletions: ${(error as Error)?.message || error}`, { prefix: 'Indexes' });
+  }
+}

package/src/types.ts

@@ -1,9 +1,9 @@
-export type { ValidationRules } from "./utils/validationRules.js";
+export type { ValidationRules } from "@njdamstra/appwrite-utils-helpers";
 export {
   type AuthUserCreate,
   AuthUserCreateSchema,
   type AuthUser,
   AuthUserSchema,
 } from "./schemas/authUser.js";
-export { validationRules } from "./utils/validationRules.js";
+export { validationRules } from "@njdamstra/appwrite-utils-helpers";
 export { afterImportActions } from "./migrations/afterImportActions.js";

package/src/users/methods.ts

@@ -12,15 +12,14 @@ import {
   type AuthUser,
   type AuthUserCreate,
 } from "../schemas/authUser.js";
-import { logger } from "../shared/logging.js";
+import { logger, MessageFormatter } from "@njdamstra/appwrite-utils-helpers";
 import { splitIntoBatches } from "../shared/migrationHelpers.js";
 import {
   getAppwriteClient,
   tryAwaitWithRetry,
-} from "../utils/helperFunctions.js";
+} from "@njdamstra/appwrite-utils-helpers";
 import { isUndefined } from "es-toolkit/compat";
 import { isEmpty } from "es-toolkit/compat";
-import { MessageFormatter } from "../shared/messageFormatter.js";
 
 export class UsersController {
   private config: AppwriteConfig;

package/src/utils/configMigration.ts

@@ -1,7 +1,7 @@
 import { promises as fs } from "fs";
 import path from "path";
 import { existsSync } from "fs";
-import { MessageFormatter } from "../shared/messageFormatter.js";
+import { MessageFormatter } from "@njdamstra/appwrite-utils-helpers";
 import { ConfirmationDialogs } from "../shared/confirmationDialogs.js";
 import yaml from "js-yaml";
 

package/src/utils/index.ts

@@ -1,2 +1,2 @@
-export * from "./helperFunctions.js";
+export * from '@njdamstra/appwrite-utils-helpers';
 export * from "./setupFiles.js";

package/src/utils/loadConfigs.ts

@@ -4,11 +4,19 @@ import { type AppwriteConfig, type Collection, type CollectionCreate, type Table
 import { register } from "tsx/esm/api"; // Import the register function
 import { pathToFileURL } from "node:url";
 import chalk from "chalk";
-import { findYamlConfig, loadYamlConfig, loadYamlConfigWithSession, extractSessionOptionsFromConfig, type YamlSessionOptions } from "../config/yamlConfig.js";
-import { detectAppwriteVersionCached, fetchServerVersion, isVersionAtLeast } from "./versionDetection.js";
-import { MessageFormatter } from "../shared/messageFormatter.js";
-import { validateCollectionsTablesConfig, reportValidationResults, type ValidationResult } from "../config/configValidation.js";
-import { resolveCollectionsDir, resolveTablesDir } from "./pathResolvers.js";
+import {
+  findYamlConfig,
+  loadYamlConfig,
+  loadYamlConfigWithSession,
+  extractSessionOptionsFromConfig,
+  validateCollectionsTablesConfig,
+  reportValidationResults,
+  type YamlSessionOptions,
+  type ValidationResult
+} from "@njdamstra/appwrite-utils-helpers";
+import { detectAppwriteVersionCached, fetchServerVersion, isVersionAtLeast } from '@njdamstra/appwrite-utils-helpers';
+import { MessageFormatter } from "@njdamstra/appwrite-utils-helpers";
+import { resolveCollectionsDir, resolveTablesDir } from '@njdamstra/appwrite-utils-helpers';
 import {
   findAppwriteConfig,
   findAppwriteConfigTS,
@@ -16,7 +24,7 @@ import {
   discoverCollections,
   discoverTables,
   discoverLegacyDirectory
-} from "./configDiscovery.js";
+} from '@njdamstra/appwrite-utils-helpers';
 
 /**
  * Session authentication preservation options for config loading
@@ -63,7 +71,7 @@ export function createSessionPreservation(
 }
 
 // Re-export config discovery functions for backward compatibility
-export { findAppwriteConfig, findFunctionsDir } from "./configDiscovery.js";
+export { findAppwriteConfig, findFunctionsDir } from '@njdamstra/appwrite-utils-helpers';
 
 /**
  * Loads the Appwrite configuration and returns both config and the path where it was found.

package/src/utils/setupFiles.ts

@@ -2,15 +2,13 @@ import { mkdirSync, writeFileSync, existsSync } from "node:fs";
 import path from "node:path";
 import type { AppwriteConfig } from "@njdamstra/appwrite-utils";
 import { findAppwriteConfig } from "./loadConfigs.js";
-import { loadYamlConfig } from "../config/yamlConfig.js";
-import { fetchServerVersion, isVersionAtLeast } from "./versionDetection.js";
-import { findYamlConfig } from "../config/yamlConfig.js";
+import { loadYamlConfig, findYamlConfig, generateYamlConfigTemplate } from "@njdamstra/appwrite-utils-helpers";
+import { fetchServerVersion, isVersionAtLeast } from '@njdamstra/appwrite-utils-helpers';
 import { ID } from "node-appwrite";
 import { ulid } from "ulidx";
-import { generateYamlConfigTemplate } from "../config/yamlConfig.js";
-import { loadAppwriteProjectConfig, findAppwriteProjectConfig, getProjectDirectoryName, isTablesDBProject } from "./projectConfig.js";
-import { hasSessionAuth, getSessionAuth } from "./sessionAuth.js";
-import { MessageFormatter } from "../shared/messageFormatter.js";
+import { loadAppwriteProjectConfig, findAppwriteProjectConfig, getProjectDirectoryName, isTablesDBProject } from '@njdamstra/appwrite-utils-helpers';
+import { hasSessionAuth, getSessionAuth } from '@njdamstra/appwrite-utils-helpers';
+import { MessageFormatter } from "@njdamstra/appwrite-utils-helpers";
 
 // Example base configuration using types from appwrite-utils
 const baseConfig: AppwriteConfig = {