storyblok 4.17.1 → 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 } } : {}
     };
   }
 }
@@ -2268,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);
   }
@@ -2285,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}`);
   }
@@ -2328,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);
   }
@@ -6114,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();
@@ -6180,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;
     }
@@ -8057,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,
@@ -8073,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 {
@@ -8141,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 ?? "",
@@ -9248,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;