@njdamstra/appwrite-utils-cli 1.11.5 → 1.11.7

package/dist/migrations/migrateStrings.js

@@ -275,6 +275,27 @@ export async function executeMigrationPlan(adapter, options) {
                 MessageFormatter.error(`  ${entry.attributeKey}: FAILED — ${cpEntry.error}`, undefined, { prefix: "Execute" });
             }
         }
+        // Restore required flags after all attributes in this collection are done.
+        // This must happen AFTER all migrations to avoid partial-update validation
+        // errors (Appwrite rejects updateRow if a required attribute is missing
+        // from the payload, even for partial updates).
+        const completedRequired = entries.filter((e) => {
+            const cp = findCheckpointEntry(checkpoint, e);
+            return cp?.phase === "completed" && e.isRequired;
+        });
+        for (const entry of completedRequired) {
+            try {
+                await tryAwaitWithRetry(() => adapter.updateAttribute({
+                    databaseId: entry.databaseId,
+                    tableId: entry.collectionId,
+                    key: entry.attributeKey,
+                    required: true,
+                }));
+            }
+            catch {
+                MessageFormatter.info(`  Warning: could not set ${entry.attributeKey} back to required`, { prefix: "Execute" });
+            }
+        }
         // After collection completes, offer to update local YAML
         const successInGroup = entries.filter((e) => {
             const cp = findCheckpointEntry(checkpoint, e);
@@ -290,7 +311,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);
             }
         }
     }
@@ -426,21 +447,8 @@ async function migrateOneAttribute(adapter, entry, cpEntry, checkpoint, checkpoi
         advance("backup_deleted");
     }
     // Step 9: Mark completed
-    // If the original attribute was required, update it now (after data is in place)
-    if (entry.isRequired) {
-        try {
-            await tryAwaitWithRetry(() => adapter.updateAttribute({
-                databaseId,
-                tableId: collectionId,
-                key: attributeKey,
-                required: true,
-            }));
-        }
-        catch {
-            // Non-fatal — attribute is migrated, just not set back to required
-            MessageFormatter.info(`    Warning: could not set ${attributeKey} back to required`, { prefix: "Migrate" });
-        }
-    }
+    // NOTE: required flag is restored AFTER all attributes in the collection
+    // are migrated, to avoid partial-update validation errors on other attributes.
     advance("completed");
 }
 // ────────────────────────────────────────────────────────
@@ -724,6 +732,163 @@ 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) {

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.5",
+  "version": "1.11.7",
   "main": "dist/main.js",
   "type": "module",
   "repository": {

package/src/migrations/migrateStrings.ts

@@ -382,6 +382,32 @@ export async function executeMigrationPlan(
       }
     }
 
+    // Restore required flags after all attributes in this collection are done.
+    // This must happen AFTER all migrations to avoid partial-update validation
+    // errors (Appwrite rejects updateRow if a required attribute is missing
+    // from the payload, even for partial updates).
+    const completedRequired = entries.filter((e) => {
+      const cp = findCheckpointEntry(checkpoint, e);
+      return cp?.phase === "completed" && e.isRequired;
+    });
+    for (const entry of completedRequired) {
+      try {
+        await tryAwaitWithRetry(() =>
+          adapter.updateAttribute({
+            databaseId: entry.databaseId,
+            tableId: entry.collectionId,
+            key: entry.attributeKey,
+            required: true,
+          } as any)
+        );
+      } catch {
+        MessageFormatter.info(
+          `  Warning: could not set ${entry.attributeKey} back to required`,
+          { prefix: "Execute" }
+        );
+      }
+    }
+
     // After collection completes, offer to update local YAML
     const successInGroup = entries.filter((e) => {
       const cp = findCheckpointEntry(checkpoint, e);
@@ -398,10 +424,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);
       }
     }
   }
@@ -633,25 +656,8 @@ async function migrateOneAttribute(
   }
 
   // Step 9: Mark completed
-  // If the original attribute was required, update it now (after data is in place)
-  if (entry.isRequired) {
-    try {
-      await tryAwaitWithRetry(() =>
-        adapter.updateAttribute({
-          databaseId,
-          tableId: collectionId,
-          key: attributeKey,
-          required: true,
-        } as any)
-      );
-    } catch {
-      // Non-fatal — attribute is migrated, just not set back to required
-      MessageFormatter.info(
-        `    Warning: could not set ${attributeKey} back to required`,
-        { prefix: "Migrate" }
-      );
-    }
-  }
+  // NOTE: required flag is restored AFTER all attributes in the collection
+  // are migrated, to avoid partial-update validation errors on other attributes.
   advance("completed");
 }
 
@@ -1075,6 +1081,195 @@ 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
 // ────────────────────────────────────────────────────────