storyblok 4.16.4 → 4.16.6

package/dist/index.mjs

@@ -10,9 +10,9 @@ import { readPackageUp } from 'read-package-up';
 import { Command } from 'commander';
 import { MultiBar, Presets } from 'cli-progress';
 import { Spinner } from '@topcli/spinner';
-import fs, { mkdir, writeFile, readFile as readFile$1, appendFile, access, constants, readdir, unlink } from 'node:fs/promises';
+import fs, { mkdir, writeFile, access, constants, readFile as readFile$1, appendFile, readdir, unlink } from 'node:fs/promises';
 import filenamify from 'filenamify';
-import { ManagementApiClient } from '@storyblok/management-api-client';
+import { ManagementApiClient, normalizeAssetUrl } from '@storyblok/management-api-client';
 import { RateLimit, Sema } from 'async-sema';
 import { select, password, input, confirm } from '@inquirer/prompts';
 import { exec, spawn } from 'node:child_process';
@@ -664,6 +664,7 @@ const API_ACTIONS = {
   update_component_internal_tag: "Failed to update component internal tag",
   update_component_group: "Failed to update component group",
   update_component_preset: "Failed to update component preset",
+  delete_component_preset: "Failed to delete component preset",
   pull_stories: "Failed to pull stories",
   pull_story: "Failed to pull story",
   create_story: "Failed to create story",
@@ -1357,6 +1358,15 @@ async function fileExists(path) {
     return false;
   }
 }
+function consolidatedFilename(defaultFilename, suffix) {
+  return suffix ? `${defaultFilename}.${suffix}.json` : `${defaultFilename}.json`;
+}
+async function shouldUseSeparateFiles(resolvedPath, defaultFilename, separateFiles, suffix) {
+  if (separateFiles !== void 0) {
+    return separateFiles;
+  }
+  return !await fileExists(join(resolvedPath, consolidatedFilename(defaultFilename, suffix)));
+}
 
 const REPORT_STATUS = {
   unfinished: "UNFINISHED",
@@ -2502,6 +2512,20 @@ const upsertComponentPreset = async (space, preset, existingId) => {
     return await pushComponentPreset(space, preset);
   }
 };
+const deleteComponentPreset = async (space, presetId) => {
+  try {
+    const client = getMapiClient();
+    await client.presets.delete({
+      path: {
+        space_id: Number(space),
+        preset_id: presetId
+      },
+      throwOnError: true
+    });
+  } catch (error) {
+    handleAPIError("delete_component_preset", error, `Failed to delete component preset ${presetId}`);
+  }
+};
 const pushComponentInternalTag = async (space, componentInternalTag) => {
   try {
     const client = getMapiClient();
@@ -2541,7 +2565,7 @@ const upsertComponentInternalTag = async (space, tag, existingId) => {
   }
 };
 const readComponentsFiles = async (options) => {
-  const { from, path, separateFiles = false, suffix } = options;
+  const { from, path, separateFiles, suffix } = options;
   const resolvedPath = resolvePath(path, `components/${from}`);
   try {
     await readdir(resolvedPath);
@@ -2560,7 +2584,7 @@ const readComponentsFiles = async (options) => {
       message
     );
   }
-  if (separateFiles) {
+  if (await shouldUseSeparateFiles(resolvedPath, DEFAULT_COMPONENTS_FILENAME, separateFiles, suffix)) {
     return await readSeparateFiles$1(resolvedPath, suffix);
   }
   return await readConsolidatedFiles$1(resolvedPath, suffix);
@@ -2646,7 +2670,9 @@ async function readConsolidatedFiles$1(resolvedPath, suffix) {
 
 const pullCmd$4 = componentsCommand.command("pull [componentName]").option("-f, --filename <filename>", "custom name to be used in file(s) name instead of space id").option("--sf, --separate-files", "Argument to create a single file for each component").option("--su, --suffix <suffix>", "suffix to add to the file name (e.g. components.<suffix>.json)").option("-s, --space <space>", "space ID").option("-p, --path <path>", "path for file storage").description(`Download your space's components schema as json. Optionally specify a component name to pull a single component.`);
 pullCmd$4.action(async (componentName, options, command) => {
-  konsola.title(`${commands.COMPONENTS}`, colorPalette.COMPONENTS, componentName ? `Pulling component ${componentName}...` : "Pulling components...");
+  const ui = getUI();
+  const logger = getLogger();
+  ui.title(`${commands.COMPONENTS}`, colorPalette.COMPONENTS, componentName ? `Pulling component ${componentName}...` : "Pulling components...");
   const { space, path, verbose } = command.optsWithGlobals();
   const {
     separateFiles = false,
@@ -2663,41 +2689,30 @@ pullCmd$4.action(async (componentName, options, command) => {
     handleError(new CommandError(`Please provide the space as argument --space YOUR_SPACE_ID.`), verbose);
     return;
   }
-  const spinnerGroups = new Spinner({
-    verbose: !isVitest
-  });
-  const spinnerPresets = new Spinner({
-    verbose: !isVitest
-  });
-  const spinnerInternalTags = new Spinner({
-    verbose: !isVitest
-  });
-  const spinnerComponents = new Spinner({
-    verbose: !isVitest
-  });
+  logger.info("Pulling components started", { space, componentName });
+  const spinnerGroups = ui.createSpinner(`Fetching ${chalk.hex(colorPalette.COMPONENTS)("components groups")}`);
+  const spinnerPresets = ui.createSpinner(`Fetching ${chalk.hex(colorPalette.COMPONENTS)("components presets")}`);
+  const spinnerInternalTags = ui.createSpinner(`Fetching ${chalk.hex(colorPalette.COMPONENTS)("components internal tags")}`);
+  const spinnerComponents = ui.createSpinner(`Fetching ${chalk.hex(colorPalette.COMPONENTS)("components")}`);
   try {
-    spinnerGroups.start(`Fetching ${chalk.hex(colorPalette.COMPONENTS)("components groups")}`);
     const groups = await fetchComponentGroups(space);
     spinnerGroups.succeed(`${chalk.hex(colorPalette.COMPONENTS)("Groups")} - Completed in ${spinnerGroups.elapsedTime.toFixed(2)}ms`);
-    spinnerPresets.start(`Fetching ${chalk.hex(colorPalette.COMPONENTS)("components presets")}`);
     const presets = await fetchComponentPresets(space);
     spinnerPresets.succeed(`${chalk.hex(colorPalette.COMPONENTS)("Presets")} - Completed in ${spinnerPresets.elapsedTime.toFixed(2)}ms`);
-    spinnerInternalTags.start(`Fetching ${chalk.hex(colorPalette.COMPONENTS)("components internal tags")}`);
     const internalTags = await fetchComponentInternalTags(space);
     spinnerInternalTags.succeed(`${chalk.hex(colorPalette.COMPONENTS)("Tags")} - Completed in ${spinnerInternalTags.elapsedTime.toFixed(2)}ms`);
     let components;
-    spinnerComponents.start(`Fetching ${chalk.hex(colorPalette.COMPONENTS)("components")}`);
     if (componentName) {
       const component = await fetchComponent(space, componentName);
       if (!component) {
-        konsola.warn(`No component found with name "${componentName}"`);
+        spinnerComponents.failed(`No component found with name "${componentName}"`);
         return;
       }
       components = [component];
     } else {
       components = await fetchComponents(space);
       if (!components || components.length === 0) {
-        konsola.warn(`No components found in the space ${space}`);
+        spinnerComponents.failed(`No components found in the space ${space}`);
         return;
       }
     }
@@ -2707,33 +2722,35 @@ pullCmd$4.action(async (componentName, options, command) => {
       { components, groups: groups || [], presets: presets || [], internalTags: internalTags || [], datasources: [] },
       { ...options, path, separateFiles: separateFiles || !!componentName }
     );
-    konsola.br();
+    ui.br();
     if (separateFiles) {
       if (filename && filename !== DEFAULT_COMPONENTS_FILENAME) {
-        konsola.warn(`The --filename option is ignored when using --separate-files`);
+        ui.warn(`The --filename option is ignored when using --separate-files`);
       }
       const filePath = `${componentsOutputDir}/`;
       const displayPath = path && isAbsolute(path) ? filePath : `${relative(process.cwd(), componentsOutputDir)}/`;
-      konsola.ok(`Components downloaded successfully to ${chalk.hex(colorPalette.PRIMARY)(displayPath)}`);
+      ui.ok(`Components downloaded successfully to ${chalk.hex(colorPalette.PRIMARY)(displayPath)}`);
     } else if (componentName) {
       const fileName = suffix ? `${actualFilename}.${suffix}.json` : `${componentName}.json`;
       const filePath = join(componentsOutputDir, fileName);
       const displayPath = path && isAbsolute(path) ? filePath : relative(process.cwd(), filePath);
-      konsola.ok(`Component ${chalk.hex(colorPalette.PRIMARY)(componentName)} downloaded successfully in ${chalk.hex(colorPalette.PRIMARY)(displayPath)}`);
+      ui.ok(`Component ${chalk.hex(colorPalette.PRIMARY)(componentName)} downloaded successfully in ${chalk.hex(colorPalette.PRIMARY)(displayPath)}`);
     } else {
       const fileName = suffix ? `${actualFilename}.${suffix}.json` : `${actualFilename}.json`;
       const filePath = join(componentsOutputDir, fileName);
       const displayPath = path && isAbsolute(path) ? filePath : relative(process.cwd(), filePath);
-      konsola.ok(`Components downloaded successfully to ${chalk.hex(colorPalette.PRIMARY)(displayPath)}`);
+      ui.ok(`Components downloaded successfully to ${chalk.hex(colorPalette.PRIMARY)(displayPath)}`);
     }
-    konsola.br();
+    ui.br();
   } catch (error) {
     spinnerGroups.failed(`Pulling ${chalk.hex(colorPalette.COMPONENTS)("Groups")} - Failed`);
     spinnerPresets.failed(`Pulling ${chalk.hex(colorPalette.COMPONENTS)("Presets")} - Failed`);
     spinnerInternalTags.failed(`Pulling ${chalk.hex(colorPalette.COMPONENTS)("Tags")} - Failed`);
     spinnerComponents.failed(`Pulling ${chalk.hex(colorPalette.COMPONENTS)("Components")} - Failed`);
-    konsola.br();
+    ui.br();
     handleError(error, verbose);
+  } finally {
+    logger.info("Pulling components finished", { space, componentName });
   }
 });
 
@@ -3682,7 +3699,9 @@ async function pushWithDependencyGraph(space, spaceState, maxConcurrency = getAc
 
 const pushCmd$3 = componentsCommand.command("push [componentName]").description(`Push your space's components schema as json`).option("-f, --from <from>", "source space id").option("--fi, --filter <filter>", "glob filter to apply to the components before pushing").option("--sf, --separate-files", "Read from separate files instead of consolidated files", false).option("--su, --suffix <suffix>", "Suffix to add to the component name").option("-s, --space <space>", "space ID").option("-p, --path <path>", "path for file storage");
 pushCmd$3.action(async (componentName, options, command) => {
-  konsola.title(`${commands.COMPONENTS}`, colorPalette.COMPONENTS, componentName ? `Pushing component ${componentName}...` : "Pushing components...");
+  const ui = getUI();
+  const logger = getLogger();
+  ui.title(`${commands.COMPONENTS}`, colorPalette.COMPONENTS, componentName ? `Pushing component ${componentName}...` : "Pushing components...");
   const { space, path, verbose } = command.optsWithGlobals();
   const { filter } = options;
   const fromSpace = options.from || space;
@@ -3694,8 +3713,9 @@ pushCmd$3.action(async (componentName, options, command) => {
     handleError(new CommandError(`Please provide the target space as argument --space TARGET_SPACE_ID.`), verbose);
     return;
   }
-  konsola.info(`Attempting to push components ${chalk.bold("from")} space ${chalk.hex(colorPalette.COMPONENTS)(fromSpace)} ${chalk.bold("to")} ${chalk.hex(colorPalette.COMPONENTS)(space)}`);
-  konsola.br();
+  logger.info("Pushing components started", { space, fromSpace, componentName });
+  ui.info(`Attempting to push components ${chalk.bold("from")} space ${chalk.hex(colorPalette.COMPONENTS)(fromSpace)} ${chalk.bold("to")} ${chalk.hex(colorPalette.COMPONENTS)(space)}`);
+  ui.br();
   let requestCount = 0;
   const client = getMapiClient();
   client.interceptors.request.use((config) => {
@@ -3765,24 +3785,45 @@ pushCmd$3.action(async (componentName, options, command) => {
         handleError(new CommandError(`No components found matching pattern "${filter}".`), verbose);
         return;
       }
-      konsola.info(`Filter applied: ${filter}`);
+      ui.info(`Filter applied: ${filter}`);
     }
     if (!spaceState.local.components.length) {
-      konsola.warn("No components found. Please make sure you have pulled the components first.");
+      ui.warn("No components found. Please make sure you have pulled the components first.");
       return;
     }
     const results = {
       successful: [],
       failed: []
     };
-    konsola.info("Using graph-based dependency resolution");
+    const localComponentById = new Map(spaceState.local.components.map((c) => [c.id, c.name]));
+    const localPresetKeys = /* @__PURE__ */ new Set();
+    for (const preset of spaceState.local.presets) {
+      const componentName2 = localComponentById.get(preset.component_id);
+      if (componentName2) {
+        localPresetKeys.add(`${componentName2}:${preset.name}`);
+      }
+    }
+    ui.info("Using graph-based dependency resolution");
     const graphResults = await pushWithDependencyGraph(space, spaceState);
     results.successful.push(...graphResults.successful);
     results.failed.push(...graphResults.failed);
+    const successfulNames = new Set(results.successful);
+    for (const [compositeKey, targetPreset] of spaceState.target.presets) {
+      const separatorIndex = compositeKey.indexOf(":");
+      const componentName2 = compositeKey.substring(0, separatorIndex);
+      if (successfulNames.has(componentName2) && !localPresetKeys.has(compositeKey)) {
+        try {
+          await deleteComponentPreset(space, targetPreset.id);
+          ui.info(`Deleted stale preset: ${chalk.hex(colorPalette.PRESETS)(compositeKey)}`);
+        } catch (error) {
+          results.failed.push({ name: compositeKey, error });
+        }
+      }
+    }
     if (results.failed.length > 0) {
       if (!verbose) {
-        konsola.br();
-        konsola.info("For more information about the error, run the command with the `--verbose` flag");
+        ui.br();
+        ui.info("For more information about the error, run the command with the `--verbose` flag");
       } else {
         results.failed.forEach((failed) => {
           handleError(failed.error, verbose);
@@ -3806,12 +3847,14 @@ pushCmd$3.action(async (componentName, options, command) => {
       }
     });
     if (referencedDatasources.size > 0) {
-      konsola.br();
-      konsola.info(`Components reference datasources: ${chalk.yellow(Array.from(referencedDatasources).join(", "))}`);
-      konsola.info(`To manage datasources, use: ${chalk.cyan("storyblok datasources push")}`);
+      ui.br();
+      ui.info(`Components reference datasources: ${chalk.yellow(Array.from(referencedDatasources).join(", "))}`);
+      ui.info(`To manage datasources, use: ${chalk.cyan("storyblok datasources push")}`);
     }
   } catch (error) {
     handleError(error, verbose);
+  } finally {
+    logger.info("Pushing components finished", { space, fromSpace, componentName });
   }
 });
 
@@ -5947,7 +5990,7 @@ const deleteDatasourceEntry = async (spaceId, entryId) => {
   }
 };
 const readDatasourcesFiles = async (options) => {
-  const { from, path, separateFiles = false, suffix } = options;
+  const { from, path, separateFiles, suffix } = options;
   const resolvedPath = resolvePath(path, `datasources/${from}`);
   try {
     await readdir(resolvedPath);
@@ -5966,7 +6009,7 @@ const readDatasourcesFiles = async (options) => {
       message
     );
   }
-  if (separateFiles) {
+  if (await shouldUseSeparateFiles(resolvedPath, DEFAULT_DATASOURCES_FILENAME, separateFiles, suffix)) {
     return await readSeparateFiles(resolvedPath, suffix);
   }
   return await readConsolidatedFiles(resolvedPath, suffix);
@@ -6030,7 +6073,6 @@ generateCmd.action(async (options, command) => {
     const componentsData = await readComponentsFiles({
       from: space,
       path,
-      separateFiles,
       suffix,
       verbose
     });
@@ -6039,7 +6081,6 @@ generateCmd.action(async (options, command) => {
       dataSourceData = await readDatasourcesFiles({
         from: space,
         path,
-        separateFiles,
         suffix,
         verbose
       });
@@ -8074,9 +8115,13 @@ const bloksFieldRefMapper = (data, { schemas, maps, fieldRefMappers: fieldRefMap
 };
 const assetFieldRefMapper = (data, { maps }) => {
   const mappedAsset = typeof data.id === "number" ? maps.assets?.get(data.id) : void 0;
+  if (!mappedAsset) {
+    return data;
+  }
   return {
     ...data,
-    ...mappedAsset?.new
+    ...mappedAsset.new,
+    filename: normalizeAssetUrl(mappedAsset.new.filename)
   };
 };
 const multiassetFieldRefMapper = (data, options) => {