storyblok 4.17.0 → 4.17.2

package/dist/index.d.mts

@@ -68,7 +68,7 @@ interface StoryblokMultilinkUrl {
     url: string;
     full_slug: string;
 }
-interface StoryblokMultilink {
+interface StoryblokMultilinkBase {
     fieldtype: 'multilink';
     id: string;
     url: string;
@@ -78,10 +78,18 @@ interface StoryblokMultilink {
     rel?: string;
     title?: string;
     prep?: string;
-    linktype: 'story' | 'url' | 'email' | 'asset';
-    story?: StoryblokMultilinkStory | StoryblokMultilinkLink | StoryblokMultilinkUrl;
-    email?: string;
 }
+type StoryblokMultilink = (StoryblokMultilinkBase & {
+    linktype: 'story';
+    story?: StoryblokMultilinkStory | StoryblokMultilinkLink | StoryblokMultilinkUrl;
+}) | (StoryblokMultilinkBase & {
+    linktype: 'url';
+}) | (StoryblokMultilinkBase & {
+    linktype: 'email';
+    email: string;
+}) | (StoryblokMultilinkBase & {
+    linktype: 'asset';
+});
 interface StoryblokTable {
     fieldtype: 'table';
     thead: Array<{

package/dist/index.d.ts

@@ -68,7 +68,7 @@ interface StoryblokMultilinkUrl {
     url: string;
     full_slug: string;
 }
-interface StoryblokMultilink {
+interface StoryblokMultilinkBase {
     fieldtype: 'multilink';
     id: string;
     url: string;
@@ -78,10 +78,18 @@ interface StoryblokMultilink {
     rel?: string;
     title?: string;
     prep?: string;
-    linktype: 'story' | 'url' | 'email' | 'asset';
-    story?: StoryblokMultilinkStory | StoryblokMultilinkLink | StoryblokMultilinkUrl;
-    email?: string;
 }
+type StoryblokMultilink = (StoryblokMultilinkBase & {
+    linktype: 'story';
+    story?: StoryblokMultilinkStory | StoryblokMultilinkLink | StoryblokMultilinkUrl;
+}) | (StoryblokMultilinkBase & {
+    linktype: 'url';
+}) | (StoryblokMultilinkBase & {
+    linktype: 'email';
+    email: string;
+}) | (StoryblokMultilinkBase & {
+    linktype: 'asset';
+});
 interface StoryblokTable {
     fieldtype: 'table';
     thead: Array<{

package/dist/index.mjs

@@ -578,10 +578,12 @@ function setActiveConfig(config) {
 
 class FetchError extends Error {
   response;
-  constructor(message, response) {
+  request;
+  constructor(message, response, request = {}) {
     super(message);
     this.name = "FetchError";
     this.response = response;
+    this.request = request;
   }
 }
 const delay = (ms) => new Promise((resolve) => setTimeout(resolve, ms));
@@ -589,6 +591,7 @@ async function customFetch(url, options = {}) {
   const { api } = getActiveConfig();
   const maxRetries = options.maxRetries ?? api.maxRetries;
   const baseDelay = options.baseDelay ?? 500;
+  const requestContext = { url, method: options.method ?? "GET" };
   let attempt = 0;
   while (attempt <= maxRetries) {
     try {
@@ -612,7 +615,7 @@ async function customFetch(url, options = {}) {
           status: response.status,
           statusText: response.statusText,
           data: null
-        });
+        }, requestContext);
       }
       if (!response.ok) {
         if (response.status === 429 && attempt < maxRetries) {
@@ -625,7 +628,7 @@ async function customFetch(url, options = {}) {
           status: response.status,
           statusText: response.statusText,
           data
-        });
+        }, requestContext);
       }
       return {
         ...data,
@@ -640,14 +643,14 @@ async function customFetch(url, options = {}) {
         status: 0,
         statusText: "Network Error",
         data: null
-      });
+      }, requestContext);
     }
   }
   throw new FetchError("Max retries exceeded", {
     status: 429,
     statusText: "Rate Limit Exceeded",
     data: null
-  });
+  }, requestContext);
 }
 
 const API_ACTIONS = {
@@ -719,9 +722,14 @@ function handleAPIError(action, error, customMessage) {
   }
   const response = error?.response;
   if (response?.status) {
+    const reqCandidate = error?.request;
     const wrappedError = new FetchError(
       response.statusText ?? error.message,
-      { status: response.status, statusText: response.statusText ?? "", data: response.data }
+      { status: response.status, statusText: response.statusText ?? "", data: response.data },
+      {
+        url: typeof reqCandidate?.url === "string" ? reqCandidate.url : void 0,
+        method: typeof reqCandidate?.method === "string" ? reqCandidate.method : void 0
+      }
     );
     const errorId = getErrorId(response.status);
     throw new APIError(errorId, action, wrappedError, customMessage);
@@ -763,6 +771,8 @@ class APIError extends Error {
     }
   }
   getInfo() {
+    const request = this.error?.request;
+    const hasRequestContext = Boolean(request && (request.url || request.method));
     return {
       name: this.name,
       message: this.message,
@@ -770,7 +780,8 @@ class APIError extends Error {
       cause: this.cause,
       errorId: this.errorId,
       stack: this.stack,
-      responseData: this.response?.data
+      responseData: this.response?.data,
+      ...hasRequestContext ? { request: { url: request.url, method: request.method } } : {}
     };
   }
 }
@@ -1106,7 +1117,7 @@ const isVitest = process.env.VITEST === "true";
 const noopProgressBar = {
   increment: () => {
   },
-  setTotal: (_n) => {
+  setTotal: () => {
   },
   stop: () => {
   }
@@ -1190,7 +1201,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();
@@ -2258,16 +2279,40 @@ const DEFAULT_GROUPS_FILENAME = "groups";
 const DEFAULT_PRESETS_FILENAME = "presets";
 const DEFAULT_TAGS_FILENAME = "tags";
 
+async function fetchAllPages(fetchFunction, extractDataFunction) {
+  const items = [];
+  let page = 1;
+  while (true) {
+    const { data, response } = await fetchFunction(page);
+    const totalHeader = response.headers.get("total");
+    const fetchedItems = extractDataFunction(data);
+    items.push(...fetchedItems);
+    if (!totalHeader) {
+      return items;
+    }
+    const total = Number(totalHeader);
+    if (Number.isNaN(total) || items.length >= total || fetchedItems.length === 0) {
+      return items;
+    }
+    page++;
+  }
+}
+
 const fetchComponents = async (spaceId) => {
   try {
     const client = getMapiClient();
-    const { data } = await client.components.list({
-      path: {
-        space_id: Number(spaceId)
-      },
-      throwOnError: true
-    });
-    return data?.components;
+    return await fetchAllPages(
+      (page) => client.components.list({
+        path: {
+          space_id: Number(spaceId)
+        },
+        query: {
+          page
+        },
+        throwOnError: true
+      }),
+      (data) => data?.components ?? []
+    );
   } catch (error) {
     handleAPIError("pull_components", error);
   }
@@ -2275,16 +2320,20 @@ const fetchComponents = async (spaceId) => {
 const fetchComponent = async (spaceId, componentName) => {
   try {
     const client = getMapiClient();
-    const { data } = await client.components.list({
-      path: {
-        space_id: Number(spaceId)
-      },
-      query: {
-        search: componentName
-      },
-      throwOnError: true
-    });
-    return data?.components?.find((c) => c.name === componentName);
+    const matches = await fetchAllPages(
+      (page) => client.components.list({
+        path: {
+          space_id: Number(spaceId)
+        },
+        query: {
+          page,
+          search: componentName
+        },
+        throwOnError: true
+      }),
+      (data) => data?.components ?? []
+    );
+    return matches.find((c) => c.name === componentName);
   } catch (error) {
     handleAPIError("pull_components", error, `Failed to fetch component ${componentName}`);
   }
@@ -2318,12 +2367,19 @@ const fetchComponentPresets = async (spaceId) => {
 const fetchComponentInternalTags = async (spaceId) => {
   try {
     const client = getMapiClient();
-    const { data } = await client.internalTags.list({
-      path: {
-        space_id: Number(spaceId)
-      }
-    });
-    return data?.internal_tags?.filter((tag) => tag.object_type === "component");
+    return await fetchAllPages(
+      (page) => client.internalTags.list({
+        path: {
+          space_id: Number(spaceId)
+        },
+        query: {
+          page,
+          by_object_type: "component"
+        },
+        throwOnError: true
+      }),
+      (data) => data?.internal_tags ?? []
+    );
   } catch (error) {
     handleAPIError("pull_component_internal_tags", error);
   }
@@ -6104,20 +6160,6 @@ generateCmd.action(async (options, command) => {
 const program$6 = getProgram();
 const datasourcesCommand = program$6.command(commands.DATASOURCES).alias("ds").description(`Manage your space's datasources`);
 
-async function fetchAllPages(fetchFunction, extractDataFunction, page = 1, collectedItems = []) {
-  const { data, response } = await fetchFunction(page);
-  const totalHeader = response.headers.get("total");
-  const total = Number(totalHeader);
-  const fetchedItems = extractDataFunction(data);
-  const allItems = [...collectedItems, ...fetchedItems];
-  if (!totalHeader || Number.isNaN(total)) {
-    return allItems;
-  }
-  if (allItems.length < total && fetchedItems.length > 0) {
-    return fetchAllPages(fetchFunction, extractDataFunction, page + 1, allItems);
-  }
-  return allItems;
-}
 const fetchDatasourceEntries = async (spaceId, datasourceId) => {
   try {
     const client = getMapiClient();
@@ -6170,16 +6212,20 @@ const fetchDatasources = async (spaceId) => {
 const fetchDatasource = async (spaceId, datasourceName) => {
   try {
     const client = getMapiClient();
-    const { data } = await client.datasources.list({
-      path: {
-        space_id: Number(spaceId)
-      },
-      query: {
-        search: datasourceName
-      },
-      throwOnError: true
-    });
-    const found = data.datasources?.find((d) => d.name === datasourceName);
+    const matches = await fetchAllPages(
+      (page) => client.datasources.list({
+        path: {
+          space_id: Number(spaceId)
+        },
+        query: {
+          page,
+          search: datasourceName
+        },
+        throwOnError: true
+      }),
+      (data) => data.datasources || []
+    );
+    const found = matches.find((d) => d.name === datasourceName);
     if (!found) {
       return void 0;
     }
@@ -8047,13 +8093,6 @@ const fetchStoryStream = ({
     }
   });
 };
-const getUUIDFromFilename = (filename) => {
-  const uuid = basename(filename, extname(filename)).split("_").at(-1);
-  if (!uuid) {
-    throw new Error(`Unable to extract UUID from local story "${filename}"`);
-  }
-  return uuid;
-};
 const readLocalStoriesStream = ({
   directoryPath,
   fileFilter = () => true,
@@ -8063,7 +8102,7 @@ const readLocalStoriesStream = ({
   onStoryError
 }) => {
   const listGenerator = async function* localStoryIterator() {
-    const files = (await readDirectory(directoryPath)).filter((f) => extname(f) === ".json" && fileFilter({ uuid: getUUIDFromFilename(f) }));
+    const files = (await readDirectory(directoryPath)).filter((f) => extname(f) === ".json" && fileFilter({ filename: f }));
     setTotalStories?.(files.length);
     for (const file of files) {
       try {
@@ -8131,10 +8170,13 @@ const scanLocalStoryIndex = async ({
       const filePath = join(directoryPath, file);
       const fileContent = await readFile$1(filePath, "utf-8");
       const story = JSON.parse(fileContent);
+      if (!story.uuid) {
+        throw new Error(`Story "${file}" is missing a uuid and cannot be pushed.`);
+      }
       entries.push({
         filename: file,
         id: story.id,
-        uuid: story.uuid ?? "",
+        uuid: story.uuid,
         slug: story.slug ?? "",
         name: story.name ?? "",
         full_slug: story.full_slug ?? "",
@@ -8968,6 +9010,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 +9132,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 +9206,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 +9237,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 +9250,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 +9263,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 });
         }
       });
     }
@@ -9128,12 +9280,14 @@ pushCmd.action(async (options, command) => {
       pendingWarnings.push(message);
       logger.warn(message);
     }
+    const uuidByFilename = new Map(storyIndex.map((entry) => [entry.filename, entry.uuid]));
     await pipeline$1(
       // Read local stories from `.json` files.
       readLocalStoriesStream({
         directoryPath: storiesDirectoryPath,
-        fileFilter({ uuid }) {
-          return Boolean(maps.stories.get(uuid));
+        fileFilter({ filename }) {
+          const uuid = uuidByFilename.get(filename);
+          return uuid != null && Boolean(maps.stories.get(uuid));
         },
         setTotalStories(total) {
           summary.processResults.total = total;
@@ -9142,12 +9296,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 +9320,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 +9348,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 +9363,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();
   }
 });