storyblok 4.6.3 → 4.6.6

package/dist/index.mjs

@@ -9,7 +9,7 @@ import { Spinner } from '@topcli/spinner';
 import { select, password, input, confirm } from '@inquirer/prompts';
 import { ManagementApiClient } from '@storyblok/management-api-client';
 import { RateLimit, Sema } from 'async-sema';
-import fs, { mkdir, writeFile, readFile as readFile$1, access, readdir } from 'node:fs/promises';
+import fs, { mkdir, writeFile, readFile as readFile$1, appendFile, access, readdir } from 'node:fs/promises';
 import path, { join, parse, resolve } from 'node:path';
 import filenamify from 'filenamify';
 import { exec, spawn } from 'node:child_process';
@@ -668,6 +668,22 @@ const saveToFile = async (filePath, data, options) => {
     handleFileSystemError("write", writeError);
   }
 };
+const appendToFile = async (filePath, data, options) => {
+  const resolvedPath = parse(filePath).dir;
+  try {
+    await mkdir(resolvedPath, { recursive: true });
+  } catch (mkdirError) {
+    handleFileSystemError("mkdir", mkdirError);
+    return;
+  }
+  try {
+    const dataWithNewline = data.endsWith("\n") ? data : `${data}
+`;
+    await appendFile(filePath, dataWithNewline, options);
+  } catch (writeError) {
+    handleFileSystemError("write", writeError);
+  }
+};
 const readFile = async (filePath) => {
   try {
     return await readFile$1(filePath, "utf8");
@@ -840,7 +856,7 @@ const loginStrategy = {
       short: "Email"
     },
     {
-      name: "With Token (SSO)",
+      name: "With Token (Personal Access Token \u2013 works also for SSO accounts)",
       value: "login-with-token",
       short: "Token"
     }
@@ -899,8 +915,13 @@ program$i.command(commands.LOGIN).description("Login to the Storyblok CLI").opti
     try {
       const strategy = await select(loginStrategy);
       if (strategy === "login-with-token") {
+        konsola.info([
+          "\u{1F511} You can use a Personal Access Token to log in.",
+          "This works for all accounts, including SSO accounts.",
+          `Generate one in your Storyblok account settings: ${chalk.underline.blue("https://app.storyblok.com/#/me/account?tab=token")}`
+        ].join("\n"));
         const userToken = await password({
-          message: "Please enter your token:",
+          message: "Please enter your Personal Access Token:",
           validate: (value) => {
             return value.length > 0;
           }
@@ -3048,69 +3069,61 @@ async function getMigrationFunction(fileName, space, basePath) {
   }
 }
 function applyMigrationToAllBlocks(content, migrationFunction, targetComponent) {
+  let processed = false;
   if (!content || typeof content !== "object") {
-    return false;
+    return processed;
   }
-  let modified = false;
   const baseTargetComponent = targetComponent.split(".")[0];
+  let migratedContent = null;
   if (content.component === baseTargetComponent) {
-    const migratedContent = migrationFunction({ ...content });
-    Object.assign(content, migratedContent);
-    modified = true;
-  }
-  for (const key in content) {
-    if (Object.prototype.hasOwnProperty.call(content, key)) {
-      const value = content[key];
-      if (Array.isArray(value)) {
-        for (let i = 0; i < value.length; i++) {
-          if (value[i] && typeof value[i] === "object") {
-            const blockModified = applyMigrationToAllBlocks(value[i], migrationFunction, targetComponent);
-            modified = modified || blockModified;
-          }
+    migratedContent = migrationFunction({ ...content });
+    processed = true;
+  }
+  const uniqueKeys = /* @__PURE__ */ new Set([...Object.keys(content), ...Object.keys(migratedContent || {})]);
+  for (const key of uniqueKeys) {
+    if (migratedContent) {
+      if (!(key in migratedContent)) {
+        delete content[key];
+        continue;
+      }
+      content[key] = migratedContent[key];
+    }
+    if (Array.isArray(content[key])) {
+      for (const value of content[key]) {
+        if (value && typeof value === "object") {
+          const blockProcessed = applyMigrationToAllBlocks(value, migrationFunction, targetComponent);
+          processed = processed || blockProcessed;
         }
-      } else if (value && typeof value === "object") {
-        const blockModified = applyMigrationToAllBlocks(value, migrationFunction, targetComponent);
-        modified = modified || blockModified;
       }
+    } else if (content[key] && typeof content[key] === "object") {
+      const blockProcessed = applyMigrationToAllBlocks(content[key], migrationFunction, targetComponent);
+      processed = processed || blockProcessed;
     }
   }
-  return modified;
+  return processed;
 }
 
 async function saveRollbackData({
   space,
   path,
-  stories,
-  migrationFile
+  story,
+  migrationTimestamp,
+  migrationNames
 }) {
   const rollbackData = {
-    stories: stories.map((story) => ({
-      storyId: story.id,
-      name: story.name,
-      content: story.content
-    }))
+    storyId: story.id,
+    name: story.name,
+    content: story.content
   };
   const rollbacksPath = resolvePath(path, `migrations/${space}/rollbacks`);
-  const timestamp = Date.now();
-  const rollbackFileName = `${migrationFile.replace(".js", "")}.${timestamp}.json`;
+  const componentNames = migrationNames.map((n) => getComponentNameFromFilename(n));
+  const rollbackName = [...new Set(componentNames)].join("~");
+  const rollbackFileName = `${rollbackName}.${migrationTimestamp}.jsonl`;
   const rollbackFilePath = join(rollbacksPath, rollbackFileName);
-  try {
-    await saveToFile(
-      rollbackFilePath,
-      JSON.stringify(rollbackData, null, 2)
-    );
-  } catch (error) {
-    if (error.code === "ENOENT") {
-      const fs = await import('node:fs/promises');
-      await fs.mkdir(rollbacksPath, { recursive: true });
-      await saveToFile(
-        rollbackFilePath,
-        JSON.stringify(rollbackData, null, 2)
-      );
-    } else {
-      throw error;
-    }
-  }
+  await appendToFile(
+    rollbackFilePath,
+    JSON.stringify(rollbackData)
+  );
 }
 async function readRollbackFile({
   space,
@@ -3120,8 +3133,10 @@ async function readRollbackFile({
   try {
     const resolvedPath = resolvePath(path, `migrations/${space}/rollbacks`);
     const rollbackFilePath = join(resolvedPath, migrationFile);
-    const filePath = rollbackFilePath.endsWith(".json") ? rollbackFilePath : `${rollbackFilePath}.json`;
-    return JSON.parse(await readFile$1(filePath, "utf-8"));
+    const filePath = rollbackFilePath.endsWith(".jsonl") ? rollbackFilePath : `${rollbackFilePath}.jsonl`;
+    return {
+      stories: (await readFile$1(filePath, "utf-8")).trim().split("\n").filter(Boolean).map((x) => JSON.parse(x))
+    };
   } catch (error) {
     throw new CommandError(`Failed to read rollback file: ${error.message}`);
   }
@@ -3140,6 +3155,7 @@ class MigrationStream extends Transform {
       totalProcessed: 0
     };
   }
+  timestamp = Date.now();
   results;
   migrationFunctions = /* @__PURE__ */ new Map();
   totalProcessed = 0;
@@ -3160,66 +3176,71 @@ class MigrationStream extends Transform {
       callback(error);
     }
   }
-  async processStory(story) {
-    if (!story.content) {
-      for (const migrationFile of this.options.migrationFiles) {
-        this.results.failed.push({
-          storyId: story.id,
-          migrationName: migrationFile.name,
-          error: new Error("Story content is missing")
-        });
-      }
-      return [];
+  async getOrLoadMigrationFunction(migrationFile) {
+    if (this.migrationFunctions.has(migrationFile.name)) {
+      return this.migrationFunctions.get(migrationFile.name);
     }
+    const migrationFunction = await getMigrationFunction(
+      migrationFile.name,
+      this.options.space,
+      this.options.path
+    );
+    this.migrationFunctions.set(migrationFile.name, migrationFunction);
+    return migrationFunction;
+  }
+  async processStory(story) {
     const relevantMigrations = this.options.componentName ? this.options.migrationFiles.filter((file) => {
       const targetComponent = getComponentNameFromFilename(file.name);
       return targetComponent.split(".")[0] === this.options.componentName;
     }) : this.options.migrationFiles;
+    if (!story.content) {
+      this.results.failed.push({
+        storyId: story.id,
+        migrationNames: relevantMigrations.map((m) => m.name),
+        error: new Error("Story content is missing")
+      });
+      return [];
+    }
     const successfulResults = [];
-    for (const migrationFile of relevantMigrations) {
-      const result = await this.applyMigrationToStory(story, migrationFile);
-      if (result) {
-        successfulResults.push(result);
-      }
+    const result = await this.applyMigrationsToStory(story, relevantMigrations);
+    if (result) {
+      successfulResults.push(result);
     }
     return successfulResults;
   }
-  async applyMigrationToStory(story, migrationFile) {
+  async applyMigrationsToStory(story, migrationFiles) {
+    const migrationNames = migrationFiles.map((f) => f.name);
     try {
-      let migrationFunction = this.migrationFunctions.get(migrationFile.name);
-      if (!migrationFunction) {
-        migrationFunction = await getMigrationFunction(
-          migrationFile.name,
-          this.options.space,
-          this.options.path
-        );
-        this.migrationFunctions.set(migrationFile.name, migrationFunction);
-      }
-      if (!migrationFunction) {
-        this.results.failed.push({
-          storyId: story.id,
-          migrationName: migrationFile.name,
-          error: new Error(`Failed to load migration function from file "${migrationFile.name}"`)
-        });
-        return null;
-      }
-      await saveRollbackData({
-        space: this.options.space,
-        path: this.options.path,
-        stories: [{ id: story.id, name: story.name || "", content: story.content }],
-        migrationFile: migrationFile.name
-      });
       const storyContent = structuredClone(story.content);
-      const originalContentHash = hash(story.content);
-      const targetComponent = this.options.componentName || getComponentNameFromFilename(migrationFile.name);
-      const modified = applyMigrationToAllBlocks(storyContent, migrationFunction, targetComponent);
+      const originalContentHash = hash(storyContent);
+      let processed = false;
+      for (const migrationFile of migrationFiles) {
+        const migrationFunction = await this.getOrLoadMigrationFunction(migrationFile);
+        if (!migrationFunction) {
+          this.results.failed.push({
+            storyId: story.id,
+            migrationNames,
+            error: new Error(`Failed to load migration function from file "${migrationFile.name}"`)
+          });
+          return null;
+        }
+        const targetComponent = this.options.componentName || getComponentNameFromFilename(migrationFile.name);
+        processed = applyMigrationToAllBlocks(storyContent, migrationFunction, targetComponent);
+      }
       const newContentHash = hash(storyContent);
       const contentChanged = originalContentHash !== newContentHash;
-      if (modified && contentChanged) {
+      if (processed && contentChanged) {
+        await saveRollbackData({
+          space: this.options.space,
+          path: this.options.path,
+          story: { id: story.id, name: story.name || "", content: story.content },
+          migrationTimestamp: this.timestamp,
+          migrationNames
+        });
         this.results.successful.push({
           storyId: story.id,
           name: story.name,
-          migrationName: migrationFile.name,
+          migrationNames,
           content: storyContent
         });
         return {
@@ -3227,28 +3248,32 @@ class MigrationStream extends Transform {
           name: story.name,
           content: storyContent
         };
-      } else if (modified && !contentChanged) {
+      } else if (processed && !contentChanged) {
         this.results.skipped.push({
           storyId: story.id,
           name: story.name,
-          migrationName: migrationFile.name,
+          migrationNames,
           reason: "No changes detected after migration"
         });
         return null;
       } else {
-        const baseComponent = targetComponent.split(".")[0];
+        const reason = migrationFiles.map((migrationFile) => {
+          const targetComponent = this.options.componentName || getComponentNameFromFilename(migrationFile.name);
+          const baseComponent = targetComponent.split(".")[0];
+          return baseComponent === this.options.componentName ? `No matching components found for ${migrationFile.name}` : `Different component target ${migrationFile.name}`;
+        }).join("\n");
         this.results.skipped.push({
           storyId: story.id,
           name: story.name,
-          migrationName: migrationFile.name,
-          reason: baseComponent === this.options.componentName ? "No matching components found" : "Different component target"
+          migrationNames,
+          reason
         });
         return null;
       }
     } catch (error) {
       this.results.failed.push({
         storyId: story.id,
-        migrationName: migrationFile.name,
+        migrationNames,
         error
       });
       return null;
@@ -3346,8 +3371,9 @@ class UpdateStream extends Writable {
       } else if (this.options.publish === "all") {
         payload.publish = 1;
       }
-      const updatedStory = await updateStory(this.options.space, storyId, payload);
-      if (updatedStory) {
+      const updatedStory = !this.options.dryRun && await updateStory(this.options.space, storyId, payload);
+      const isStoryUpdated = Boolean(updatedStory);
+      if (isStoryUpdated || this.options.dryRun) {
         this.results.successful.push({ storyId, name: storyName });
         this.results.totalProcessed++;
         this.options.onProgress?.(this.results.totalProcessed);
@@ -3406,6 +3432,10 @@ class UpdateStream extends Writable {
 const program$8 = getProgram();
 migrationsCommand.command("run [componentName]").description("Run migrations").option("--fi, --filter <filter>", "glob filter to apply to the components before pushing").option("-d, --dry-run", "Preview changes without applying them to Storyblok").option("-q, --query <query>", 'Filter stories by content attributes using Storyblok filter query syntax. Example: --query="[highlighted][in]=true"').option("--starts-with <path>", 'Filter stories by path. Example: --starts-with="/en/blog/"').option("--publish <publish>", "Options for publication mode: all | published | published-with-changes").action(async (componentName, options) => {
   konsola.title(`${commands.MIGRATIONS}`, colorPalette.MIGRATIONS, componentName ? `Running migrations for component ${componentName}...` : "Running migrations...");
+  if (options.dryRun) {
+    konsola.warn(`DRY RUN MODE ENABLED: No changes will be made.
+`);
+  }
   const verbose = program$8.opts().verbose;
   const { filter, dryRun = false, query, startsWith, publish } = options;
   const { space, path } = migrationsCommand.opts();
@@ -3535,6 +3565,13 @@ migrationsCommand.command("rollback [migrationFile]").description("Rollback a mi
     handleError(new CommandError(`Please provide the space as argument --space YOUR_SPACE_ID.`), verbose);
     return;
   }
+  const { password, region } = state;
+  mapiClient({
+    token: {
+      accessToken: password
+    },
+    region
+  });
   try {
     const rollbackData = await readRollbackFile({
       space,
@@ -3985,6 +4022,7 @@ const storyblokSchemas = /* @__PURE__ */ new Map([
 ]);
 
 const STORY_TYPE = "ISbStoryData";
+const DEFAULT_COMPONENT_FILENAME = "storyblok-components";
 const DEFAULT_TYPEDEFS_HEADER = [
   "// This file was generated by the storyblok CLI.",
   "// DO NOT MODIFY THIS FILE BY HAND."
@@ -4247,8 +4285,8 @@ const generateTypes = async (spaceData, options = {
     handleError(error);
   }
 };
-const saveTypesToFile = async (space, typedefString, options) => {
-  const { filename = "storyblok-components", path } = options;
+const saveTypesToComponentsFile = async (space, typedefString, options) => {
+  const { filename = DEFAULT_COMPONENT_FILENAME, path } = options;
   const resolvedPath = path ? resolve(process.cwd(), path, "types", space) : resolvePath(path, `types/${space}`);
   try {
     await saveToFile(join(resolvedPath, `${filename}.d.ts`), typedefString);
@@ -4257,7 +4295,7 @@ const saveTypesToFile = async (space, typedefString, options) => {
   }
 };
 const generateStoryblokTypes = async (options = {}) => {
-  const { filename = "storyblok", path } = options;
+  const { path } = options;
   try {
     const storyblokTypesPath = resolve(__dirname, "./index.d.ts");
     const storyblokTypesContent = readFileSync(storyblokTypesPath, "utf-8");
@@ -4268,7 +4306,7 @@ const generateStoryblokTypes = async (options = {}) => {
       storyblokTypesContent
     ].join("\n");
     const resolvedPath = path ? resolve(process.cwd(), path, "types") : resolvePath(path, "types");
-    await saveToFile(join(resolvedPath, `${filename}.d.ts`), typeDefs);
+    await saveToFile(join(resolvedPath, `storyblok.d.ts`), typeDefs);
     return true;
   } catch (error) {
     handleFileSystemError("read", error);
@@ -4277,7 +4315,10 @@ const generateStoryblokTypes = async (options = {}) => {
 };
 
 const program$5 = getProgram();
-typesCommand.command("generate").description("Generate types d.ts for your component schemas").option("--sf, --separate-files", "").option("--strict", "strict mode, no loose typing").option("--type-prefix <prefix>", "prefix to be prepended to all generated component type names").option("--type-suffix <suffix>", "suffix to be appended to all generated component type names").option("--suffix <suffix>", "Components suffix").option("--custom-fields-parser <path>", "Path to the parser file for Custom Field Types").option("--compiler-options <options>", "path to the compiler options from json-schema-to-typescript").action(async (options) => {
+typesCommand.command("generate").description("Generate types d.ts for your component schemas").option("--sf, --separate-files", "Generate one .d.ts file per component instead of a single combined file").option(
+  "--filename <name>",
+  "Base file name for all component types when generating a single declarations file (e.g. components.d.ts). Ignored when using --separate-files."
+).option("--strict", "strict mode, no loose typing").option("--type-prefix <prefix>", "prefix to be prepended to all generated component type names").option("--type-suffix <suffix>", "suffix to be appended to all generated component type names").option("--suffix <suffix>", "Components suffix").option("--custom-fields-parser <path>", "Path to the parser file for Custom Field Types").option("--compiler-options <options>", "path to the compiler options from json-schema-to-typescript").action(async (options) => {
   konsola.title(`${commands.TYPES}`, colorPalette.TYPES, "Generating types...");
   const verbose = program$5.opts().verbose;
   const { space, path } = typesCommand.opts();
@@ -4292,7 +4333,6 @@ typesCommand.command("generate").description("Generate types d.ts for your compo
       path
     });
     await generateStoryblokTypes({
-      ...options,
       path
     });
     const spaceDataWithDatasources = {
@@ -4304,8 +4344,8 @@ typesCommand.command("generate").description("Generate types d.ts for your compo
       path
     });
     if (typedefString) {
-      await saveTypesToFile(space, typedefString, {
-        ...options,
+      await saveTypesToComponentsFile(space, typedefString, {
+        filename: options.filename,
         path
       });
     }
@@ -5141,7 +5181,7 @@ program$1.command(`${commands.CREATE} [project-path]`).alias("c").description(`S
   konsola.br();
 });
 
-const version = "4.6.3";
+const version = "4.6.6";
 const pkg = {
 	version: version};