storyblok 4.17.0 → 4.17.1

package/dist/index.mjs

@@ -1106,7 +1106,7 @@ const isVitest = process.env.VITEST === "true";
 const noopProgressBar = {
   increment: () => {
   },
-  setTotal: (_n) => {
+  setTotal: () => {
   },
   stop: () => {
   }
@@ -1190,7 +1190,17 @@ class UI {
     }
   }
   createProgressBar(options) {
-    return this.multiBar?.create(0, 0, options) || noopProgressBar;
+    const bar = this.multiBar?.create(0, 0, options);
+    if (!bar) {
+      return noopProgressBar;
+    }
+    return {
+      increment: (count = 1) => bar.increment(count),
+      // cli-progress renders `{eta_formatted}` as "LLs" when total is 0.
+      // Floor at 1 so an empty phase stays a clean 0/1 instead.
+      setTotal: (total) => bar.setTotal(Math.max(total, 1)),
+      stop: () => bar.stop()
+    };
   }
   stopAllProgressBars() {
     this.multiBar?.stop();
@@ -8968,6 +8978,105 @@ pullCmd.action(async (options, command) => {
   }
 });
 
+function formatStoryIdentifier(record) {
+  const title = record.full_slug ?? record.slug ?? record.uuid ?? record.id?.toString() ?? record.filename ?? "unknown story";
+  const extras = [];
+  if (record.uuid && record.uuid !== title) {
+    extras.push(`uuid: ${record.uuid}`);
+  }
+  if (record.filename && record.filename !== title) {
+    extras.push(`file: ${record.filename}`);
+  }
+  return extras.length > 0 ? `${title} (${extras.join(", ")})` : title;
+}
+const ENRICHABLE_FIELDS = ["full_slug", "slug", "uuid", "id", "filename"];
+function enrichFieldMessage(detail, record) {
+  const match = detail.match(/^(\w+):/);
+  if (!match) {
+    return detail;
+  }
+  const field = match[1];
+  if (!ENRICHABLE_FIELDS.includes(field)) {
+    return detail;
+  }
+  const value = record[field];
+  if (value == null || value === "" || value instanceof Error) {
+    return detail;
+  }
+  return `${field} (${String(value)})${detail.slice(field.length)}`;
+}
+function renderFailureReport(ui, records, verbose) {
+  if (records.length === 0) {
+    return;
+  }
+  ui.error(`Failed stories (${records.length}):`, void 0, { header: false, margin: false });
+  const lines = [];
+  for (const record of records) {
+    lines.push(formatStoryIdentifier(record));
+    const messages = record.error instanceof APIError ? record.error.messageStack : [record.error.message];
+    const [primary, ...rest] = messages;
+    lines.push(`  \u2022 ${enrichFieldMessage(primary ?? "Unknown error", record)}`);
+    for (const detail of rest) {
+      lines.push(`      \u2514\u2500 ${enrichFieldMessage(detail, record)}`);
+    }
+    if (verbose && record.error.stack) {
+      for (const frame of record.error.stack.split("\n")) {
+        lines.push(`      ${frame}`);
+      }
+    }
+  }
+  ui.list(lines);
+  ui.br();
+  if (!verbose) {
+    ui.info("Re-run with the `--verbose` flag for full stack traces.", { margin: false });
+  }
+}
+class FailureCollector {
+  records = /* @__PURE__ */ new Map();
+  keyFor(story) {
+    return story.full_slug ?? story.uuid ?? story.filename ?? `__unknown_${this.records.size}`;
+  }
+  /**
+   * Record a failure. Returns `true` if this is the first failure seen for
+   * this story's identity, `false` if one was already recorded (in which case
+   * the caller should skip counter updates to avoid double-billing).
+   */
+  record(story, error) {
+    const key = this.keyFor(story);
+    if (this.records.has(key)) {
+      return false;
+    }
+    this.records.set(key, {
+      filename: story.filename,
+      full_slug: story.full_slug,
+      slug: story.slug,
+      uuid: story.uuid,
+      id: story.id,
+      error
+    });
+    return true;
+  }
+  get isEmpty() {
+    return this.records.size === 0;
+  }
+  get size() {
+    return this.records.size;
+  }
+  render(ui, verbose = false) {
+    renderFailureReport(ui, [...this.records.values()], verbose);
+  }
+  toReporterMeta() {
+    return [...this.records.values()].map((r) => ({
+      filename: r.filename,
+      full_slug: r.full_slug,
+      slug: r.slug,
+      uuid: r.uuid,
+      id: r.id,
+      error: r.error.message
+    }));
+  }
+}
+
 const pushCmd = storiesCommand.command("push").option("-s, --space <space>", "space ID").option("-f, --from <from>", "source space id").option("-d, --dry-run", "Preview changes without applying them to Storyblok").option("--publish", "Publish stories after pushing").option("--cleanup", "delete local stories after a successful push (note: does not cleanup manifests)").description(`Push local stories to a Storyblok space.`);
 pushCmd.action(async (options, command) => {
   const ui = getUI();
@@ -8991,6 +9100,7 @@ pushCmd.action(async (options, command) => {
     return;
   }
   const pendingWarnings = [];
+  const failures = new FailureCollector();
   const summary = {
     creationResults: { total: 0, succeeded: 0, skipped: 0, failed: 0 },
     processResults: { total: 0, succeeded: 0, failed: 0 },
@@ -9064,8 +9174,10 @@ pushCmd.action(async (options, command) => {
         scanProgress.increment();
       },
       onError(error, filename) {
-        summary.creationResults.failed += 1;
-        handleError(error, verbose, { storyFile: filename });
+        if (failures.record({ filename }, error)) {
+          summary.creationResults.failed += 1;
+        }
+        logOnlyError(error, { storyFile: filename });
       }
     });
     const levels = groupStoriesByDepth(storyIndex);
@@ -9093,8 +9205,11 @@ pushCmd.action(async (options, command) => {
         dryRun: options.dryRun ?? false,
         appendToManifest,
         onStorySuccess(entry, remoteStory) {
-          if (!entry.uuid || !remoteStory.uuid) {
-            throw new Error("Invalid story provided!");
+          if (!entry.uuid) {
+            throw new Error(`Local story file "${entry.filename}" is missing a "uuid" field. Re-pull the story or add the uuid manually.`);
+          }
+          if (!remoteStory.uuid) {
+            throw new Error(`Storyblok API returned a story without a uuid for slug "${entry.slug}".`);
           }
           maps.stories.set(entry.id, remoteStory.id);
           maps.stories.set(entry.uuid, remoteStory.uuid);
@@ -9103,8 +9218,11 @@ pushCmd.action(async (options, command) => {
           creationProgress.increment();
         },
         onStorySkipped(entry, remoteStory, reason) {
-          if (!entry.uuid || !remoteStory.uuid) {
-            throw new Error("Invalid story provided!");
+          if (!entry.uuid) {
+            throw new Error(`Local story file "${entry.filename}" is missing a "uuid" field. Re-pull the story or add the uuid manually.`);
+          }
+          if (!remoteStory.uuid) {
+            throw new Error(`Storyblok API returned a story without a uuid for slug "${entry.slug}".`);
           }
           maps.stories.set(entry.id, remoteStory.id);
           maps.stories.set(entry.uuid, remoteStory.uuid);
@@ -9113,13 +9231,15 @@ pushCmd.action(async (options, command) => {
           creationProgress.increment();
         },
         onStoryError(error, entry) {
-          summary.creationResults.failed += 1;
-          summary.processResults.total -= 1;
-          summary.updateResults.total -= 1;
-          processProgress.setTotal(summary.processResults.total);
-          updateProgress.setTotal(summary.updateResults.total);
+          if (failures.record(entry, error)) {
+            summary.creationResults.failed += 1;
+            summary.processResults.total -= 1;
+            summary.updateResults.total -= 1;
+            processProgress.setTotal(summary.processResults.total);
+            updateProgress.setTotal(summary.updateResults.total);
+          }
           creationProgress.increment();
-          handleError(error, verbose, { storyId: entry?.uuid });
+          logOnlyError(error, { storyId: entry.uuid });
         }
       });
     }
@@ -9142,12 +9262,15 @@ pushCmd.action(async (options, command) => {
           updateProgress.setTotal(total);
         },
         onStoryError(error, filename) {
-          summary.creationResults.failed += 1;
-          summary.processResults.total -= 1;
+          if (failures.record({ filename }, error)) {
+            summary.processResults.failed += 1;
+          } else {
+            summary.processResults.total -= 1;
+            processProgress.setTotal(summary.processResults.total);
+          }
           summary.updateResults.total -= 1;
-          processProgress.setTotal(summary.processResults.total);
           updateProgress.setTotal(summary.updateResults.total);
-          handleError(error, verbose, { storyFile: filename });
+          logOnlyError(error, { storyFile: filename });
         }
       }),
       // Map all references to numeric ids and uuids.
@@ -9163,10 +9286,15 @@ pushCmd.action(async (options, command) => {
           summary.processResults.succeeded += 1;
         },
         onStoryError(error, localStory) {
-          summary.processResults.failed += 1;
+          logOnlyError(error, { storyId: localStory.uuid });
+          if (failures.record(localStory, error)) {
+            summary.processResults.failed += 1;
+          } else {
+            summary.processResults.total -= 1;
+            processProgress.setTotal(summary.processResults.total);
+          }
           summary.updateResults.total -= 1;
           updateProgress.setTotal(summary.updateResults.total);
-          handleError(error, verbose, { storyId: localStory.uuid });
         }
       }),
       // Update remote stories with correct references.
@@ -9186,8 +9314,13 @@ pushCmd.action(async (options, command) => {
           summary.updateResults.succeeded += 1;
         },
         onStoryError(error, localStory) {
-          summary.updateResults.failed += 1;
-          handleError(error, verbose, { storyId: localStory.uuid });
+          logOnlyError(error, { storyId: localStory.uuid });
+          if (failures.record(localStory, error)) {
+            summary.updateResults.failed += 1;
+          } else {
+            summary.updateResults.total -= 1;
+            updateProgress.setTotal(summary.updateResults.total);
+          }
         }
       })
     );
@@ -9196,19 +9329,30 @@ pushCmd.action(async (options, command) => {
   } finally {
     logger.info("Pushing stories finished", summary);
     ui.stopAllProgressBars();
-    for (const warning of pendingWarnings) {
-      ui.warn(warning);
-    }
-    const failedStories = Math.max(summary.creationResults.failed, summary.processResults.failed, summary.updateResults.failed);
-    ui.info(`Push results: ${summary.creationResults.total} ${summary.creationResults.total === 1 ? "story" : "stories"} pushed, ${failedStories} ${failedStories === 1 ? "story" : "stories"} failed`);
+    ui.br();
+    const failedCount = failures.size;
+    ui.info(`Push results: ${summary.creationResults.total} ${summary.creationResults.total === 1 ? "story" : "stories"} pushed, ${failedCount} ${failedCount === 1 ? "story" : "stories"} failed`);
     ui.list([
       `Creating stories: ${summary.creationResults.succeeded + summary.creationResults.skipped}/${summary.creationResults.total} succeeded, ${summary.creationResults.failed} failed.`,
       `Processing stories: ${summary.processResults.succeeded}/${summary.processResults.total} succeeded, ${summary.processResults.failed} failed.`,
       `Updating stories: ${summary.updateResults.succeeded}/${summary.updateResults.total} succeeded, ${summary.updateResults.failed} failed.`
     ]);
+    if (pendingWarnings.length > 0 || !failures.isEmpty) {
+      ui.br();
+    }
+    for (const warning of pendingWarnings) {
+      ui.warn(warning);
+    }
+    if (pendingWarnings.length > 0 && !failures.isEmpty) {
+      ui.br();
+    }
+    failures.render(ui, verbose);
     reporter.addSummary("creationResults", summary.creationResults);
     reporter.addSummary("processResults", summary.processResults);
     reporter.addSummary("updateResults", summary.updateResults);
+    if (!failures.isEmpty) {
+      reporter.addMeta("failedStories", failures.toReporterMeta());
+    }
     reporter.finalize();
   }
 });