storyblok 4.15.0 → 4.15.1

package/dist/index.mjs

@@ -11,7 +11,7 @@ import { Command } from 'commander';
 import path, { join, resolve as resolve$1, parse, dirname as dirname$1, extname, relative, basename } from 'node:path';
 import { MultiBar, Presets } from 'cli-progress';
 import { Spinner } from '@topcli/spinner';
-import fs, { mkdir, writeFile, readFile as readFile$1, appendFile, access, constants, readdir, unlink, stat } from 'node:fs/promises';
+import fs, { mkdir, writeFile, readFile as readFile$1, appendFile, access, constants, readdir, unlink } from 'node:fs/promises';
 import filenamify from 'filenamify';
 import { ManagementApiClient } from '@storyblok/management-api-client';
 import { RateLimit, Sema } from 'async-sema';
@@ -103,6 +103,44 @@ const regionNames = {
 ({
   SB_Agent_Version: process.env.npm_package_version || "4.x"
 });
+const SUPPORTED_ASSET_EXTENSIONS = /* @__PURE__ */ new Set([
+  // Images: image/png, image/x-png, image/gif, image/jpeg, image/avif, image/svg+xml, image/webp
+  ".jpg",
+  ".jpeg",
+  ".png",
+  ".gif",
+  ".webp",
+  ".avif",
+  ".svg",
+  // Video: video/*, application/mp4, application/x-mpegurl, application/vnd.apple.mpegurl
+  ".mp4",
+  ".mov",
+  ".avi",
+  ".webm",
+  ".wmv",
+  ".mkv",
+  ".flv",
+  ".ogv",
+  ".3gp",
+  ".m4v",
+  ".mpg",
+  ".mpeg",
+  ".m3u8",
+  // Audio: audio/*
+  ".mp3",
+  ".wav",
+  ".ogg",
+  ".aac",
+  ".flac",
+  ".wma",
+  ".m4a",
+  ".opus",
+  // Documents: application/msword, text/plain, application/pdf, application/vnd.openxmlformats-officedocument.wordprocessingml.document
+  ".pdf",
+  ".doc",
+  ".docx",
+  ".txt"
+]);
 const directories = {
   assets: "assets",
   components: "components",
@@ -651,25 +689,38 @@ const API_ACTIONS = {
 const API_ERRORS = {
   unauthorized: "The user is not authorized to access the API",
   network_error: "No response from server, please check if you are correctly connected to internet",
+  server_error: "The server returned an error",
   invalid_credentials: "The provided credentials are invalid",
   timeout: "The API request timed out",
   generic: "Error fetching data from the API",
   not_found: "The requested resource was not found",
   unprocessable_entity: "The request was well-formed but was unable to be followed due to semantic errors"
 };
+function getErrorId(status) {
+  switch (status) {
+    case 401:
+      return "unauthorized";
+    case 404:
+      return "not_found";
+    case 422:
+      return "unprocessable_entity";
+    default:
+      return status >= 500 ? "server_error" : "generic";
+  }
+}
 function handleAPIError(action, error, customMessage) {
   if (error instanceof FetchError) {
-    const status = error.response.status;
-    switch (status) {
-      case 401:
-        throw new APIError("unauthorized", action, error, customMessage);
-      case 404:
-        throw new APIError("not_found", action, error, customMessage);
-      case 422:
-        throw new APIError("unprocessable_entity", action, error, customMessage);
-      default:
-        throw new APIError("network_error", action, error, customMessage);
-    }
+    const errorId = getErrorId(error.response.status);
+    throw new APIError(errorId, action, error, customMessage);
+  }
+  const response = error?.response;
+  if (response?.status) {
+    const wrappedError = new FetchError(
+      response.statusText ?? error.message,
+      { status: response.status, statusText: response.statusText ?? "", data: response.data }
+    );
+    const errorId = getErrorId(response.status);
+    throw new APIError(errorId, action, wrappedError, customMessage);
   }
   throw new APIError("generic", action, error, customMessage);
 }
@@ -1888,34 +1939,10 @@ const getUser = async (token, region) => {
     });
     return data?.user;
   } catch (error) {
-    if (error instanceof FetchError) {
-      const status = error.response.status;
-      switch (status) {
-        case 401:
-          throw new APIError("unauthorized", "get_user", error, `The token provided ${chalk.bold(maskToken(token))} is invalid.
-        Please make sure you are using the correct token and try again.`);
-        default:
-          throw new APIError("network_error", "get_user", error);
-      }
-    }
-    if (typeof error === "string" && error === "Unauthorized") {
-      const mockFetchError = new FetchError("Non-JSON response", {
-        status: 401,
-        statusText: "Unauthorized",
-        data: null
-      });
-      throw new APIError("unauthorized", "get_user", mockFetchError, `The token provided ${chalk.bold(maskToken(token))} is invalid.
-        Please make sure you are using the correct token and try again.`);
-    }
-    if (typeof error === "object" && error !== null && Object.keys(error).length === 0) {
-      const mockFetchError = new FetchError("Network Error", {
-        status: 500,
-        statusText: "Internal Server Error",
-        data: null
-      });
-      throw new APIError("network_error", "get_user", mockFetchError);
-    }
-    throw new APIError("generic", "get_user", error);
+    const status = error?.response?.status;
+    const customMessage = status === 401 ? `The token provided ${chalk.bold(maskToken(token))} is invalid.
+        Please make sure you are using the correct token and try again.` : void 0;
+    handleAPIError("get_user", error, customMessage);
   }
 };
 
@@ -1926,17 +1953,7 @@ const loginWithToken = async (token, region) => {
     if (error instanceof APIError) {
       throw error;
     }
-    if (error instanceof FetchError) {
-      const status = error.response.status;
-      switch (status) {
-        case 401:
-          throw new APIError("unauthorized", "login_with_token", error, `The token provided ${chalk.bold(maskToken(token))} is invalid.
-        Please make sure you are using the correct token and try again.`);
-        default:
-          throw new APIError("network_error", "login_with_token", error);
-      }
-    }
-    throw new APIError("generic", "login_with_token", error, "The provided credentials are invalid");
+    handleAPIError("login_with_token", error);
   }
 };
 const loginWithEmailAndPassword = async (email, password, region) => {
@@ -4025,13 +4042,13 @@ const createStory = async (spaceId, payload) => {
       },
       body: {
         story: payload.story,
-        publish: payload.publish
+        ...payload.publish ? { publish: payload.publish } : {}
       },
       throwOnError: true
     });
     return data?.story;
-  } catch (maybeError) {
-    handleAPIError("create_story", toError(maybeError));
+  } catch (error) {
+    handleAPIError("create_story", error);
   }
 };
 const updateStory = async (spaceId, storyId, payload) => {
@@ -4045,18 +4062,20 @@ const updateStory = async (spaceId, storyId, payload) => {
       body: {
         story: payload.story,
         force_update: payload.force_update === "1" ? "1" : "0",
-        publish: payload.publish
+        ...payload.publish ? { publish: payload.publish } : {}
       },
       throwOnError: true
     });
-    const { story } = data;
+    const story = data?.story;
     if (!story) {
       throw new Error("Failed to update story");
     }
     return story;
-  } catch (maybeError) {
-    handleAPIError("update_story", toError(maybeError));
-    throw maybeError;
+  } catch (error) {
+    if (error instanceof Error && error.message === "Failed to update story") {
+      throw error;
+    }
+    handleAPIError("update_story", error);
   }
 };
 
@@ -7460,31 +7479,25 @@ const readLocalAssetsStream = ({
   const iterator = async function* readAssets() {
     try {
       const files = await readdir(directoryPath);
-      const metadataFiles = files.filter((file) => file.endsWith(".json") && file !== "manifest.jsonl");
-      setTotalAssets?.(metadataFiles.length);
-      for (const file of metadataFiles) {
-        const filePath = join(directoryPath, file);
+      const binaryFiles = files.filter((f) => SUPPORTED_ASSET_EXTENSIONS.has(extname(f).toLowerCase()));
+      setTotalAssets?.(binaryFiles.length);
+      for (const file of binaryFiles) {
+        const binaryFilePath = join(directoryPath, file);
         try {
-          const statResult = await stat(filePath);
-          if (!statResult.isFile()) {
-            continue;
-          }
-          const metadataContent = await readFile$1(filePath, "utf8");
-          const assetRaw = JSON.parse(metadataContent);
+          const sidecar = await loadSidecarAssetData(binaryFilePath);
+          const shortFilename = sidecar.short_filename || (sidecar.filename ? basename(sidecar.filename) : void 0) || file;
           const asset = {
-            ...assetRaw,
-            short_filename: assetRaw.short_filename || basename(assetRaw.filename)
+            ...sidecar,
+            short_filename: shortFilename
           };
-          const baseName = parse(file).name;
-          const extFromMetadata = extname(asset.short_filename || asset.filename) || "";
-          const assetBinaryPath = join(directoryPath, `${baseName}${extFromMetadata}`);
-          const fileBuffer = await readFile$1(assetBinaryPath);
+          const fileBuffer = await readFile$1(binaryFilePath);
+          const sidecarPath = getSidecarFilename(binaryFilePath);
           yield {
             asset,
             context: {
               fileBuffer,
-              assetBinaryPath,
-              assetPath: filePath
+              assetBinaryPath: binaryFilePath,
+              assetPath: sidecarPath
             }
           };
         } catch (maybeError) {
@@ -7868,6 +7881,9 @@ const traverseAndMapBySchema = (data, {
   processedFields,
   missingSchemas
 }) => {
+  if (!data?.component) {
+    return data ?? {};
+  }
   const schema = schemas[data.component];
   if (!schema) {
     missingSchemas.add(data.component);
@@ -7911,7 +7927,7 @@ const traverseAndMapRichtextDoc = (data, {
     }));
   }
   if (data && typeof data === "object") {
-    if (data.type === "link" && data.attrs.linktype === "story") {
+    if (data.type === "link" && data.attrs?.linktype === "story") {
       return {
         ...data,
         attrs: {
@@ -7925,7 +7941,7 @@ const traverseAndMapRichtextDoc = (data, {
         ...data,
         attrs: {
           ...data.attrs,
-          body: data.attrs.body.map((d) => traverseAndMapBySchema(d, {
+          body: (data.attrs?.body ?? []).map((d) => traverseAndMapBySchema(d, {
             schemas,
             maps,
             fieldRefMappers: fieldRefMappers2,
@@ -7967,7 +7983,7 @@ const multilinkFieldRefMapper = (data, { maps }) => {
 };
 const bloksFieldRefMapper = (data, { schemas, maps, fieldRefMappers: fieldRefMappers2, processedFields, missingSchemas }) => {
   if (!Array.isArray(data)) {
-    throw new TypeError("Invalid data!");
+    throw new TypeError(`Invalid bloks field: expected an array, but received ${JSON.stringify(data)}. Please make sure your bloks field value is an array of components (e.g. [{ component: "my_blok", ... }]).`);
   }
   return data.map((d) => traverseAndMapBySchema(d, {
     schemas,
@@ -7986,7 +8002,7 @@ const assetFieldRefMapper = (data, { maps }) => {
 };
 const multiassetFieldRefMapper = (data, options) => {
   if (!Array.isArray(data)) {
-    throw new TypeError("Invalid data!");
+    throw new TypeError(`Invalid multiasset field: expected an array, but received ${JSON.stringify(data)}. Please make sure your multiasset field value is an array of asset objects (e.g. [{ filename: "...", id: 123 }]).`);
   }
   return data.map((d) => assetFieldRefMapper(d, options));
 };
@@ -8009,23 +8025,23 @@ const storyRefMapper = (story, { schemas, maps }) => {
   const missingSchemas = /* @__PURE__ */ new Set();
   const alternates = story.alternates ? story.alternates.map((a) => ({
     ...a,
-    id: maps.stories?.get(a.id) || a.id,
-    parent_id: maps.stories?.get(a.parent_id) || a.parent_id
+    id: maps.stories?.get(a.id) ?? a.id,
+    parent_id: maps.stories?.get(a.parent_id) ?? a.parent_id
   })) : story.alternates;
-  const parentId = maps.stories?.get(story.parent_id) || story.parent_id;
+  const parentId = maps.stories?.get(story.parent_id) ?? story.parent_id;
   const mappedStory = {
     ...story,
-    content: traverseAndMapBySchema(story.content, {
+    content: story.content?.component ? traverseAndMapBySchema(story.content, {
       schemas,
       maps,
       fieldRefMappers,
       processedFields,
       missingSchemas
-    }),
-    id: Number(maps.stories?.get(story.id) || story.id),
-    uuid: String(maps.stories?.get(story.uuid) || story.uuid),
+    }) : story.content,
+    id: Number(maps.stories?.get(story.id) ?? story.id),
+    uuid: String(maps.stories?.get(story.uuid) ?? story.uuid),
     // @ts-expect-error Our types are wrong.
-    parent_id: parentId ? Number(parentId) : null,
+    parent_id: parentId != null ? Number(parentId) : null,
     alternates
   };
   return {
@@ -8187,14 +8203,14 @@ const getRemoteStory = async ({ spaceId, storyId }) => {
   return data?.story;
 };
 const makeCreateStoryAPITransport = ({ spaceId }) => async (localStory) => {
-  const { id: _id, uuid: _uuid, content, parent_id: _p, ...newStoryData } = localStory;
+  const { id: _id, uuid: _uuid, parent_id: _parentId, content, ...newStoryData } = localStory;
+  if (!localStory.is_folder && !content?.component) {
+    throw new Error(`Story "${localStory.slug}" is missing a content type (content.component). Every story must define a content field with a valid component.`);
+  }
   const remoteStory = await createStory(spaceId, {
     story: {
       ...newStoryData,
-      content: {
-        _uid: "",
-        component: "__tmp__"
-      }
+      ...content?.component ? { content: { _uid: "", component: "__migration_artifact__" } } : {}
     },
     publish: 0
   });
@@ -8270,7 +8286,7 @@ const makeWriteStoryFSTransport = ({ directoryPath }) => async (story) => {
 };
 const makeWriteStoryAPITransport = ({ spaceId, publish }) => (mappedLocalStory) => updateStory(spaceId, mappedLocalStory.id, {
   story: mappedLocalStory,
-  publish: publish ?? (mappedLocalStory.published ? 1 : 0)
+  publish: publish ?? (isStoryPublishedWithoutChanges(mappedLocalStory) ? 1 : 0)
 });
 const makeCleanupStoryFSTransport = ({ directoryPath, maps }) => async (mappedStory) => {
   const mapEntry = maps.stories?.entries().find(([_, v]) => v === mappedStory.uuid);
@@ -8896,14 +8912,14 @@ pushCmd.action(async (options, command) => {
           processProgress.setTotal(total);
           updateProgress.setTotal(total);
         },
-        onStoryError(error) {
+        onStoryError(error, filename) {
           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);
+          handleError(error, verbose, { storyFile: filename });
         }
       }),
       // Create remote stories.
@@ -8912,7 +8928,6 @@ pushCmd.action(async (options, command) => {
         spaceId: space,
         transports: {
           createStory: options.dryRun ? async (story) => story : makeCreateStoryAPITransport({
-            maps,
             spaceId: space
           }),
           appendStoryManifest: options.dryRun ? () => Promise.resolve() : makeAppendToManifestFSTransport({
@@ -8937,13 +8952,13 @@ pushCmd.action(async (options, command) => {
           logger.info("Skipped creating story", { storyId: localStory.uuid });
           summary.creationResults.skipped += 1;
         },
-        onStoryError(error) {
+        onStoryError(error, localStory) {
           summary.creationResults.failed += 1;
           summary.processResults.total -= 1;
           summary.updateResults.total -= 1;
           processProgress.setTotal(summary.processResults.total);
           updateProgress.setTotal(summary.updateResults.total);
-          handleError(error, verbose);
+          handleError(error, verbose, { storyId: localStory?.uuid });
         },
         onIncrement() {
           creationProgress.increment();
@@ -8963,13 +8978,13 @@ pushCmd.action(async (options, command) => {
           processProgress.setTotal(total);
           updateProgress.setTotal(total);
         },
-        onStoryError(error) {
+        onStoryError(error, filename) {
           summary.creationResults.failed += 1;
           summary.processResults.total -= 1;
           summary.updateResults.total -= 1;
           processProgress.setTotal(summary.processResults.total);
           updateProgress.setTotal(summary.updateResults.total);
-          handleError(error, verbose);
+          handleError(error, verbose, { storyFile: filename });
         }
       }),
       // Map all references to numeric ids and uuids.