@njdamstra/appwrite-utils-cli 1.11.4 → 1.11.6

package/dist/migrations/migrateStrings.js

@@ -290,7 +290,7 @@ export async function executeMigrationPlan(adapter, options) {
                 },
             ]);
             if (updateYaml) {
-                MessageFormatter.info("Local YAML update: use your editor to change 'type: string' to the new types in your collection YAML files.", { prefix: "Execute" });
+                await updateCollectionYaml(first.collectionName, entries, checkpoint);
             }
         }
     }
@@ -320,7 +320,7 @@ async function migrateOneAttribute(adapter, entry, cpEntry, checkpoint, checkpoi
         MessageFormatter.info(`    Creating backup attribute ${backupKey}...`, {
             prefix: "Migrate",
         });
-        await tryAwaitWithRetry(() => adapter.createAttribute({
+        await createAttributeIfNotExists(adapter, {
             databaseId,
             tableId: collectionId,
             key: backupKey,
@@ -328,7 +328,7 @@ async function migrateOneAttribute(adapter, entry, cpEntry, checkpoint, checkpoi
             size: entry.currentSize,
             required: false, // always optional for backup
             array: entry.isArray,
-        }));
+        });
         const available = await waitForAttribute(adapter, databaseId, collectionId, backupKey);
         if (!available)
             throw new Error(`Backup attribute ${backupKey} stuck`);
@@ -385,7 +385,7 @@ async function migrateOneAttribute(adapter, entry, cpEntry, checkpoint, checkpoi
         if (entry.hasDefault && entry.defaultValue !== undefined) {
             createParams.default = entry.defaultValue;
         }
-        await tryAwaitWithRetry(() => adapter.createAttribute(createParams));
+        await createAttributeIfNotExists(adapter, createParams);
         const available = await waitForAttribute(adapter, databaseId, collectionId, attributeKey);
         if (!available)
             throw new Error(`New attribute ${attributeKey} stuck after creation`);
@@ -507,7 +507,7 @@ async function verifyDataCopy(adapter, databaseId, collectionId, sourceKey, targ
     for (const doc of docs) {
         if (!(sourceKey in doc))
             continue;
-        if (doc[sourceKey] !== doc[targetKey]) {
+        if (JSON.stringify(doc[sourceKey]) !== JSON.stringify(doc[targetKey])) {
             throw new Error(`Verification failed: doc ${doc.$id} has ${sourceKey}=${JSON.stringify(doc[sourceKey])} but ${targetKey}=${JSON.stringify(doc[targetKey])}`);
         }
     }
@@ -515,7 +515,7 @@ async function verifyDataCopy(adapter, databaseId, collectionId, sourceKey, targ
 // ────────────────────────────────────────────────────────
 // Helper: wait for attribute to become available
 // ────────────────────────────────────────────────────────
-async function waitForAttribute(adapter, databaseId, collectionId, key, maxWaitMs = 60_000) {
+async function waitForAttribute(adapter, databaseId, collectionId, key, maxWaitMs = 120_000) {
     const start = Date.now();
     const checkInterval = 2000;
     while (Date.now() - start < maxWaitMs) {
@@ -724,8 +724,181 @@ function printDryRunSummary(plan) {
     console.log("");
 }
 // ────────────────────────────────────────────────────────
+// Update local collection YAML after migration
+// ────────────────────────────────────────────────────────
+async function updateCollectionYaml(collectionName, entries, checkpoint) {
+    // Find candidate YAML files
+    const candidates = findYamlFiles(process.cwd(), collectionName);
+    if (candidates.length === 0) {
+        MessageFormatter.warning(`No YAML file found for collection "${collectionName}". Skipping local config update.`, { prefix: "YAML" });
+        return;
+    }
+    let yamlPath;
+    if (candidates.length === 1) {
+        const { usePath } = await inquirer.prompt([
+            {
+                type: "confirm",
+                name: "usePath",
+                message: `Found: ${candidates[0]}. Use this file?`,
+                default: true,
+            },
+        ]);
+        if (!usePath) {
+            const { customPath } = await inquirer.prompt([
+                {
+                    type: "input",
+                    name: "customPath",
+                    message: "Enter path to collection YAML file:",
+                },
+            ]);
+            if (!customPath || !fs.existsSync(customPath)) {
+                MessageFormatter.warning("Invalid path. Skipping YAML update.", {
+                    prefix: "YAML",
+                });
+                return;
+            }
+            yamlPath = customPath;
+        }
+        else {
+            yamlPath = candidates[0];
+        }
+    }
+    else {
+        const { selectedPath } = await inquirer.prompt([
+            {
+                type: "list",
+                name: "selectedPath",
+                message: `Multiple YAML files found for "${collectionName}". Select one:`,
+                choices: [
+                    ...candidates.map((c) => ({ name: c, value: c })),
+                    { name: "Enter custom path", value: "__custom__" },
+                ],
+            },
+        ]);
+        if (selectedPath === "__custom__") {
+            const { customPath } = await inquirer.prompt([
+                {
+                    type: "input",
+                    name: "customPath",
+                    message: "Enter path to collection YAML file:",
+                },
+            ]);
+            if (!customPath || !fs.existsSync(customPath)) {
+                MessageFormatter.warning("Invalid path. Skipping YAML update.", {
+                    prefix: "YAML",
+                });
+                return;
+            }
+            yamlPath = customPath;
+        }
+        else {
+            yamlPath = selectedPath;
+        }
+    }
+    // Load and parse YAML
+    let doc;
+    try {
+        const content = fs.readFileSync(yamlPath, "utf8");
+        doc = yaml.load(content);
+    }
+    catch (err) {
+        MessageFormatter.error(`Failed to parse ${yamlPath}: ${err.message}`, undefined, { prefix: "YAML" });
+        return;
+    }
+    if (!doc || !Array.isArray(doc.attributes)) {
+        MessageFormatter.warning(`No "attributes" array found in ${yamlPath}. Skipping.`, { prefix: "YAML" });
+        return;
+    }
+    // Update attributes that were successfully migrated
+    let updated = 0;
+    for (const entry of entries) {
+        const cp = findCheckpointEntry(checkpoint, entry);
+        if (cp?.phase !== "completed")
+            continue;
+        const attr = doc.attributes.find((a) => a.key === entry.attributeKey && a.type === "string");
+        if (!attr)
+            continue;
+        attr.type = entry.targetType;
+        if (entry.targetType !== "varchar") {
+            delete attr.size;
+        }
+        updated++;
+    }
+    if (updated === 0) {
+        MessageFormatter.info("No matching string attributes found in YAML to update.", { prefix: "YAML" });
+        return;
+    }
+    // Write back
+    try {
+        const output = yaml.dump(doc, {
+            lineWidth: 120,
+            noRefs: true,
+            sortKeys: false,
+        });
+        fs.writeFileSync(yamlPath, output, "utf8");
+        MessageFormatter.success(`Updated ${updated} attribute(s) in ${yamlPath}`, { prefix: "YAML" });
+    }
+    catch (err) {
+        MessageFormatter.error(`Failed to write ${yamlPath}: ${err.message}`, undefined, { prefix: "YAML" });
+    }
+}
+function findYamlFiles(searchRoot, collectionName) {
+    const results = [];
+    const lowerName = collectionName.toLowerCase();
+    function walk(dir) {
+        let dirEntries;
+        try {
+            dirEntries = fs.readdirSync(dir, { withFileTypes: true });
+        }
+        catch {
+            return; // skip inaccessible directories
+        }
+        for (const ent of dirEntries) {
+            const fullPath = path.join(dir, ent.name);
+            if (ent.isDirectory()) {
+                // Skip node_modules, .git, and other common non-config dirs
+                if (ent.name === "node_modules" || ent.name === ".git" || ent.name === "dist")
+                    continue;
+                walk(fullPath);
+            }
+            else if (ent.isFile() &&
+                ent.name.toLowerCase() === `${lowerName}.yaml`) {
+                // Verify it looks like a collection config (has a name field)
+                try {
+                    const content = fs.readFileSync(fullPath, "utf8");
+                    const parsed = yaml.load(content);
+                    if (parsed && parsed.name === collectionName) {
+                        results.push(fullPath);
+                    }
+                }
+                catch {
+                    // skip unparseable files
+                }
+            }
+        }
+    }
+    walk(searchRoot);
+    return results;
+}
+// ────────────────────────────────────────────────────────
 // Utility
 // ────────────────────────────────────────────────────────
+async function createAttributeIfNotExists(adapter, params) {
+    try {
+        await tryAwaitWithRetry(() => adapter.createAttribute(params), 0, true);
+    }
+    catch (err) {
+        const code = err?.code || err?.originalError?.code;
+        const type = err?.originalError?.type || "";
+        if (code === 409 || type === "column_already_exists") {
+            MessageFormatter.info(`      (backup attribute already exists, reusing)`, {
+                prefix: "Migrate",
+            });
+            return;
+        }
+        throw err;
+    }
+}
 function delay(ms) {
     return new Promise((resolve) => setTimeout(resolve, ms));
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@njdamstra/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.11.4",
+  "version": "1.11.6",
   "main": "dist/main.js",
   "type": "module",
   "repository": {

package/src/migrations/migrateStrings.ts

@@ -398,10 +398,7 @@ export async function executeMigrationPlan(
         },
       ]);
       if (updateYaml) {
-        MessageFormatter.info(
-          "Local YAML update: use your editor to change 'type: string' to the new types in your collection YAML files.",
-          { prefix: "Execute" }
-        );
+        await updateCollectionYaml(first.collectionName, entries, checkpoint);
       }
     }
   }
@@ -458,17 +455,15 @@ async function migrateOneAttribute(
     MessageFormatter.info(`    Creating backup attribute ${backupKey}...`, {
       prefix: "Migrate",
     });
-    await tryAwaitWithRetry(() =>
-      adapter.createAttribute({
-        databaseId,
-        tableId: collectionId,
-        key: backupKey,
-        type: "string", // backup keeps original type
-        size: entry.currentSize,
-        required: false, // always optional for backup
-        array: entry.isArray,
-      })
-    );
+    await createAttributeIfNotExists(adapter, {
+      databaseId,
+      tableId: collectionId,
+      key: backupKey,
+      type: "string", // backup keeps original type
+      size: entry.currentSize,
+      required: false, // always optional for backup
+      array: entry.isArray,
+    });
     const available = await waitForAttribute(
       adapter,
       databaseId,
@@ -560,7 +555,7 @@ async function migrateOneAttribute(
       createParams.default = entry.defaultValue;
     }
 
-    await tryAwaitWithRetry(() => adapter.createAttribute(createParams as any));
+    await createAttributeIfNotExists(adapter, createParams as any);
     const available = await waitForAttribute(
       adapter,
       databaseId,
@@ -756,7 +751,7 @@ async function verifyDataCopy(
   const docs = res?.documents || res?.rows || [];
   for (const doc of docs) {
     if (!(sourceKey in doc)) continue;
-    if (doc[sourceKey] !== doc[targetKey]) {
+    if (JSON.stringify(doc[sourceKey]) !== JSON.stringify(doc[targetKey])) {
       throw new Error(
         `Verification failed: doc ${doc.$id} has ${sourceKey}=${JSON.stringify(doc[sourceKey])} but ${targetKey}=${JSON.stringify(doc[targetKey])}`
       );
@@ -773,7 +768,7 @@ async function waitForAttribute(
   databaseId: string,
   collectionId: string,
   key: string,
-  maxWaitMs: number = 60_000
+  maxWaitMs: number = 120_000
 ): Promise<boolean> {
   const start = Date.now();
   const checkInterval = 2000;
@@ -1077,10 +1072,218 @@ function printDryRunSummary(plan: MigrationPlan): void {
   console.log("");
 }
 
+// ────────────────────────────────────────────────────────
+// Update local collection YAML after migration
+// ────────────────────────────────────────────────────────
+
+async function updateCollectionYaml(
+  collectionName: string,
+  entries: MigrationPlanEntry[],
+  checkpoint: MigrationCheckpoint
+): Promise<void> {
+  // Find candidate YAML files
+  const candidates = findYamlFiles(process.cwd(), collectionName);
+
+  if (candidates.length === 0) {
+    MessageFormatter.warning(
+      `No YAML file found for collection "${collectionName}". Skipping local config update.`,
+      { prefix: "YAML" }
+    );
+    return;
+  }
+
+  let yamlPath: string;
+
+  if (candidates.length === 1) {
+    const { usePath } = await inquirer.prompt([
+      {
+        type: "confirm",
+        name: "usePath",
+        message: `Found: ${candidates[0]}. Use this file?`,
+        default: true,
+      },
+    ]);
+    if (!usePath) {
+      const { customPath } = await inquirer.prompt([
+        {
+          type: "input",
+          name: "customPath",
+          message: "Enter path to collection YAML file:",
+        },
+      ]);
+      if (!customPath || !fs.existsSync(customPath)) {
+        MessageFormatter.warning("Invalid path. Skipping YAML update.", {
+          prefix: "YAML",
+        });
+        return;
+      }
+      yamlPath = customPath;
+    } else {
+      yamlPath = candidates[0];
+    }
+  } else {
+    const { selectedPath } = await inquirer.prompt([
+      {
+        type: "list",
+        name: "selectedPath",
+        message: `Multiple YAML files found for "${collectionName}". Select one:`,
+        choices: [
+          ...candidates.map((c) => ({ name: c, value: c })),
+          { name: "Enter custom path", value: "__custom__" },
+        ],
+      },
+    ]);
+    if (selectedPath === "__custom__") {
+      const { customPath } = await inquirer.prompt([
+        {
+          type: "input",
+          name: "customPath",
+          message: "Enter path to collection YAML file:",
+        },
+      ]);
+      if (!customPath || !fs.existsSync(customPath)) {
+        MessageFormatter.warning("Invalid path. Skipping YAML update.", {
+          prefix: "YAML",
+        });
+        return;
+      }
+      yamlPath = customPath;
+    } else {
+      yamlPath = selectedPath;
+    }
+  }
+
+  // Load and parse YAML
+  let doc: any;
+  try {
+    const content = fs.readFileSync(yamlPath, "utf8");
+    doc = yaml.load(content);
+  } catch (err: any) {
+    MessageFormatter.error(
+      `Failed to parse ${yamlPath}: ${err.message}`,
+      undefined,
+      { prefix: "YAML" }
+    );
+    return;
+  }
+
+  if (!doc || !Array.isArray(doc.attributes)) {
+    MessageFormatter.warning(
+      `No "attributes" array found in ${yamlPath}. Skipping.`,
+      { prefix: "YAML" }
+    );
+    return;
+  }
+
+  // Update attributes that were successfully migrated
+  let updated = 0;
+  for (const entry of entries) {
+    const cp = findCheckpointEntry(checkpoint, entry);
+    if (cp?.phase !== "completed") continue;
+
+    const attr = doc.attributes.find(
+      (a: any) => a.key === entry.attributeKey && a.type === "string"
+    );
+    if (!attr) continue;
+
+    attr.type = entry.targetType;
+    if (entry.targetType !== "varchar") {
+      delete attr.size;
+    }
+    updated++;
+  }
+
+  if (updated === 0) {
+    MessageFormatter.info(
+      "No matching string attributes found in YAML to update.",
+      { prefix: "YAML" }
+    );
+    return;
+  }
+
+  // Write back
+  try {
+    const output = yaml.dump(doc, {
+      lineWidth: 120,
+      noRefs: true,
+      sortKeys: false,
+    });
+    fs.writeFileSync(yamlPath, output, "utf8");
+    MessageFormatter.success(
+      `Updated ${updated} attribute(s) in ${yamlPath}`,
+      { prefix: "YAML" }
+    );
+  } catch (err: any) {
+    MessageFormatter.error(
+      `Failed to write ${yamlPath}: ${err.message}`,
+      undefined,
+      { prefix: "YAML" }
+    );
+  }
+}
+
+function findYamlFiles(searchRoot: string, collectionName: string): string[] {
+  const results: string[] = [];
+  const lowerName = collectionName.toLowerCase();
+
+  function walk(dir: string): void {
+    let dirEntries: fs.Dirent[];
+    try {
+      dirEntries = fs.readdirSync(dir, { withFileTypes: true });
+    } catch {
+      return; // skip inaccessible directories
+    }
+    for (const ent of dirEntries) {
+      const fullPath = path.join(dir, ent.name);
+      if (ent.isDirectory()) {
+        // Skip node_modules, .git, and other common non-config dirs
+        if (ent.name === "node_modules" || ent.name === ".git" || ent.name === "dist") continue;
+        walk(fullPath);
+      } else if (
+        ent.isFile() &&
+        ent.name.toLowerCase() === `${lowerName}.yaml`
+      ) {
+        // Verify it looks like a collection config (has a name field)
+        try {
+          const content = fs.readFileSync(fullPath, "utf8");
+          const parsed = yaml.load(content) as any;
+          if (parsed && parsed.name === collectionName) {
+            results.push(fullPath);
+          }
+        } catch {
+          // skip unparseable files
+        }
+      }
+    }
+  }
+
+  walk(searchRoot);
+  return results;
+}
+
 // ────────────────────────────────────────────────────────
 // Utility
 // ────────────────────────────────────────────────────────
 
+async function createAttributeIfNotExists(
+  adapter: DatabaseAdapter,
+  params: Parameters<DatabaseAdapter["createAttribute"]>[0]
+): Promise<void> {
+  try {
+    await tryAwaitWithRetry(() => adapter.createAttribute(params), 0, true);
+  } catch (err: any) {
+    const code = err?.code || err?.originalError?.code;
+    const type = err?.originalError?.type || "";
+    if (code === 409 || type === "column_already_exists") {
+      MessageFormatter.info(`      (backup attribute already exists, reusing)`, {
+        prefix: "Migrate",
+      });
+      return;
+    }
+    throw err;
+  }
+}
+
 function delay(ms: number): Promise<void> {
   return new Promise((resolve) => setTimeout(resolve, ms));
 }