storyblok 4.15.2 → 4.16.1

package/README.md

@@ -99,7 +99,7 @@ Then you can set breakpoints directly to the typescript files and the debugger w
 
 For help, discussion about best practices, or any other conversation that would benefit from being searchable:
 
-- [Discuss Storyblok on Github Discussions](https://github.com/storyblok/storyblok/discussions)
+- [Discuss Storyblok on GitHub Discussions](https://github.com/storyblok/storyblok/discussions)
 
 For community support, chatting with other users, please visit:
 
@@ -114,7 +114,7 @@ For bugs or feature requests, please [submit an issue](https://github.com/storyb
 
 ### I can't share my company project code
 
-We understand that you might not be able to share your company's project code. Please provide a minimal reproducible example that demonstrates the issue by using tools like [Stackblitz](https://stackblitz.com) or a link to a Github Repo lease make sure you include a README file with the instructions to build and run the project, important not to include any access token, password or personal information of any kind.
+We understand that you might not be able to share your company's project code. Please provide a minimal reproducible example that demonstrates the issue by using tools like [Stackblitz](https://stackblitz.com) or a link to a GitHub repo. Please make sure you include a README file with the instructions to build and run the project, important not to include any access token, password or personal information of any kind.
 
 ### I only have a question
 
@@ -122,7 +122,7 @@ If you have a question, please ask in the [Discuss Storyblok on Discord](https:/
 
 ## Contributing
 
-If you're interested in contributing to Storyblok CLI, please read our [contributing docs](https://github.com/storyblok/.github/blob/main/contributing.md) before submitting a pull request.
+If you're interested in contributing to Storyblok CLI, please read our [contributing docs](../../CONTRIBUTING.md) before submitting a pull request.
 
 ## License
 

package/dist/config/index.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"index.mjs","sources":["../../src/lib/config/types.ts"],"sourcesContent":["import type { RegionCode } from '../../constants';\nimport type { Command, Option } from 'commander';\nimport type { CommandOptions } from '../../types';\nimport type { PullComponentsOptions } from '../../commands/components/pull/constants';\nimport type { PushComponentsOptions } from '../../commands/components/push/constants';\nimport type { PullDatasourcesOptions } from '../../commands/datasources/pull/constants';\nimport type { PushDatasourcesOptions } from '../../commands/datasources/push/constants';\nimport type { DeleteDatasourceOptions } from '../../commands/datasources/delete/constants';\nimport type { MigrationsGenerateOptions } from '../../commands/migrations/generate/constants';\nimport type { MigrationsRunOptions } from '../../commands/migrations/run/constants';\nimport type { MigrationsRollbackOptions } from '../../commands/migrations/rollback/types';\nimport type { GenerateTypesOptions } from '../../commands/types/generate/constants';\nimport type { PullLanguagesOptions } from '../../commands/languages/constants';\nimport type { PullAssetsOptions } from '../../commands/assets/pull/types';\nimport type { PushAssetsOptions } from '../../commands/assets/push/types';\nimport type { PullStoriesOptions } from '../../commands/stories/pull/types';\nimport type { PushStoriesOptions } from '../../commands/stories/push/types';\nimport type { PruneLogsOptions } from '../../commands/logs/prune/types';\nimport type { PruneReportsOptions } from '../../commands/reports/prune/types';\nimport type { DeepPartial } from '../../utils/types';\n\nexport type PlainObject = Record<string, any>;\n\nexport interface ApiConfig {\n  maxRetries: number;\n  maxConcurrency: number;\n}\n\nexport interface LogConsoleConfig {\n  enabled: boolean;\n  level: string;\n}\n\nexport interface LogFileConfig {\n  enabled: boolean;\n  level: string;\n  maxFiles: number;\n}\n\nexport interface LogConfig {\n  console: LogConsoleConfig;\n  file: LogFileConfig;\n}\n\nexport interface ReportConfig {\n  enabled: boolean;\n  maxFiles: number;\n}\n\nexport interface UiConfig {\n  enabled: boolean;\n}\n\nexport interface GlobalConfig {\n  region?: RegionCode;\n  space?: number | string;\n  path?: string;\n  api: ApiConfig;\n  log: LogConfig;\n  report: ReportConfig;\n  ui: UiConfig;\n  verbose: boolean;\n}\n\nexport interface ResolvedCliConfig extends GlobalConfig {\n  [key: string]: any;\n}\n\ntype StripCommandOption<T> = T extends CommandOptions ? Omit<T, keyof CommandOptions> : T;\ntype CommandConfig<T> = Partial<StripCommandOption<T>>;\n\nexport interface SharedConfigOptions {\n  space?: number | string;\n  path?: string;\n}\n\nexport interface CommandOptionsMap {\n  components: { pull: PullComponentsOptions; push: PushComponentsOptions };\n  datasources: { pull: PullDatasourcesOptions; push: PushDatasourcesOptions; delete: DeleteDatasourceOptions };\n  migrations: { generate: MigrationsGenerateOptions; run: MigrationsRunOptions; rollback: MigrationsRollbackOptions };\n  types: { generate: GenerateTypesOptions };\n  languages: { pull: PullLanguagesOptions };\n  assets: { pull: PullAssetsOptions; push: PushAssetsOptions };\n  stories: { pull: PullStoriesOptions; push: PushStoriesOptions };\n  logs: { list: Record<string, never>; prune: PruneLogsOptions };\n  reports: { list: Record<string, never>; prune: PruneReportsOptions };\n}\n\ntype SubcommandConfig<T> = SharedConfigOptions & CommandConfig<T>;\n\ntype ModuleConfig<Subs extends Record<string, any>> = SharedConfigOptions & {\n  [K in keyof Subs]?: SubcommandConfig<Subs[K]>;\n};\n\nexport type ModulesConfig = {\n  [K in keyof CommandOptionsMap]?: ModuleConfig<CommandOptionsMap[K]>;\n};\n\nexport type ComponentsModuleConfig = ModulesConfig['components'];\nexport type DatasourcesModuleConfig = ModulesConfig['datasources'];\nexport type MigrationsModuleConfig = ModulesConfig['migrations'];\nexport type TypesModuleConfig = ModulesConfig['types'];\nexport type LanguagesModuleConfig = ModulesConfig['languages'];\nexport type AssetsModuleConfig = ModulesConfig['assets'];\nexport type StoriesModuleConfig = ModulesConfig['stories'];\nexport type LogsModuleConfig = ModulesConfig['logs'];\nexport type ReportsModuleConfig = ModulesConfig['reports'];\n\nexport interface StoryblokConfig extends DeepPartial<GlobalConfig> {\n  modules?: ModulesConfig;\n}\n\nexport function defineConfig<T extends StoryblokConfig>(config: T): T {\n  return config;\n}\n\nexport type OptionParser<T> = (value: string, previous?: T) => T;\n\nexport interface GlobalOptionDefinition<T = unknown> {\n  flags: string;\n  description: string;\n  defaultValue?: T;\n  parser?: OptionParser<T>;\n}\n\nexport interface ConfigLocation {\n  cwd: string;\n  configFile: string;\n}\n\nexport type CommanderOption = Option;\nexport type CommanderCommand = Command;\n"],"names":[],"mappings":"AAgHO,SAAS,aAAwC,MAAc,EAAA;AACpE,EAAO,OAAA,MAAA;AACT;;;;"}
+{"version":3,"file":"index.mjs","sources":["../../src/lib/config/types.ts"],"sourcesContent":["import type { RegionCode } from '../../constants';\nimport type { Command, Option } from 'commander';\nimport type { CommandOptions } from '../../types';\nimport type { PullComponentsOptions } from '../../commands/components/pull/constants';\nimport type { PushComponentsOptions } from '../../commands/components/push/constants';\nimport type { PullDatasourcesOptions } from '../../commands/datasources/pull/constants';\nimport type { PushDatasourcesOptions } from '../../commands/datasources/push/constants';\nimport type { DeleteDatasourceOptions } from '../../commands/datasources/delete/constants';\nimport type { MigrationsGenerateOptions } from '../../commands/migrations/generate/constants';\nimport type { MigrationsRunOptions } from '../../commands/migrations/run/constants';\nimport type { MigrationsRollbackOptions } from '../../commands/migrations/rollback/types';\nimport type { GenerateTypesOptions } from '../../commands/types/generate/constants';\nimport type { PullLanguagesOptions } from '../../commands/languages/constants';\nimport type { PullAssetsOptions } from '../../commands/assets/pull/types';\nimport type { PushAssetsOptions } from '../../commands/assets/push/types';\nimport type { PullStoriesOptions } from '../../commands/stories/pull/types';\nimport type { PushStoriesOptions } from '../../commands/stories/push/types';\nimport type { PruneLogsOptions } from '../../commands/logs/prune/types';\nimport type { PruneReportsOptions } from '../../commands/reports/prune/types';\nimport type { DeepPartial } from '../../utils/types';\n\nexport type PlainObject = Record<string, any>;\n\nexport interface ApiConfig {\n  maxRetries: number;\n  maxConcurrency: number;\n}\n\nexport interface LogConsoleConfig {\n  enabled: boolean;\n  level: string;\n}\n\nexport interface LogFileConfig {\n  enabled: boolean;\n  level: string;\n  maxFiles: number;\n}\n\nexport interface LogConfig {\n  console: LogConsoleConfig;\n  file: LogFileConfig;\n}\n\nexport interface ReportConfig {\n  enabled: boolean;\n  maxFiles: number;\n}\n\nexport interface UiConfig {\n  enabled: boolean;\n}\n\nexport interface GlobalConfig {\n  region?: RegionCode;\n  space?: number | string;\n  path?: string;\n  api: ApiConfig;\n  log: LogConfig;\n  report: ReportConfig;\n  ui: UiConfig;\n  verbose: boolean;\n}\n\nexport interface ResolvedCliConfig extends GlobalConfig {\n  [key: string]: any;\n}\n\ntype StripCommandOption<T> = T extends CommandOptions ? Omit<T, keyof CommandOptions> : T;\ntype CommandConfig<T> = Partial<StripCommandOption<T>>;\n\nexport interface SharedConfigOptions {\n  space?: number | string;\n  path?: string;\n}\n\nexport interface CommandOptionsMap {\n  components: { pull: PullComponentsOptions; push: PushComponentsOptions };\n  datasources: { pull: PullDatasourcesOptions; push: PushDatasourcesOptions; delete: DeleteDatasourceOptions };\n  migrations: { generate: MigrationsGenerateOptions; run: MigrationsRunOptions; rollback: MigrationsRollbackOptions };\n  types: { generate: GenerateTypesOptions };\n  languages: { pull: PullLanguagesOptions };\n  assets: { pull: PullAssetsOptions; push: PushAssetsOptions };\n  stories: { pull: PullStoriesOptions; push: PushStoriesOptions };\n  logs: { list: Record<string, never>; prune: PruneLogsOptions };\n  reports: { list: Record<string, never>; prune: PruneReportsOptions };\n}\n\ntype SubcommandConfig<T> = SharedConfigOptions & CommandConfig<T>;\n\ntype ModuleConfig<Subs extends Record<string, any>> = SharedConfigOptions & {\n  [K in keyof Subs]?: SubcommandConfig<Subs[K]>;\n};\n\nexport type ModulesConfig = {\n  [K in keyof CommandOptionsMap]?: ModuleConfig<CommandOptionsMap[K]>;\n};\n\nexport type ComponentsModuleConfig = ModulesConfig['components'];\nexport type DatasourcesModuleConfig = ModulesConfig['datasources'];\nexport type MigrationsModuleConfig = ModulesConfig['migrations'];\nexport type TypesModuleConfig = ModulesConfig['types'];\nexport type LanguagesModuleConfig = ModulesConfig['languages'];\nexport type AssetsModuleConfig = ModulesConfig['assets'];\nexport type StoriesModuleConfig = ModulesConfig['stories'];\nexport type LogsModuleConfig = ModulesConfig['logs'];\nexport type ReportsModuleConfig = ModulesConfig['reports'];\n\nexport interface StoryblokConfig extends DeepPartial<GlobalConfig> {\n  modules?: ModulesConfig;\n}\n\nexport function defineConfig<T extends StoryblokConfig>(config: T): T {\n  return config;\n}\n\nexport type OptionParser<T> = (value: string, previous?: T) => T;\n\nexport interface GlobalOptionDefinition<T = unknown> {\n  flags: string;\n  description: string;\n  defaultValue?: T;\n  parser?: OptionParser<T>;\n}\n\nexport interface ConfigLocation {\n  cwd: string;\n  configFile: string;\n}\n\nexport type CommanderOption = Option;\nexport type CommanderCommand = Command;\n"],"names":[],"mappings":"AAgHO,SAAS,aAAwC,MAAA,EAAc;AACpE,EAAA,OAAO,MAAA;AACT;;;;"}

package/dist/index.mjs

@@ -1074,10 +1074,10 @@ const konsola = {
   }
 };
 
-const __filename$1 = fileURLToPath(import.meta.url);
-const __dirname$1 = dirname(__filename$1);
+const __filename$2 = fileURLToPath(import.meta.url);
+const __dirname$2 = dirname(__filename$2);
 const result = await readPackageUp({
-  cwd: __dirname$1
+  cwd: __dirname$2
 });
 const packageJson$1 = result ? result.packageJson : {
   name: "storyblok",
@@ -1091,8 +1091,8 @@ function getPackageJson() {
   return packageJson$1;
 }
 
-const __filename = fileURLToPath(import.meta.url);
-const __dirname = dirname(__filename);
+const __filename$1 = fileURLToPath(import.meta.url);
+const __dirname$1 = dirname(__filename$1);
 function isRegion(value) {
   return Object.values(regions).includes(value);
 }
@@ -4077,6 +4077,36 @@ const updateStory = async (spaceId, storyId, payload) => {
     handleAPIError("update_story", error);
   }
 };
+const prefetchTargetStories = async (spaceId, options) => {
+  const result = {
+    bySlug: /* @__PURE__ */ new Map(),
+    byId: /* @__PURE__ */ new Map()
+  };
+  let page = 1;
+  let totalPages = 1;
+  while (page <= totalPages) {
+    const response = await fetchStories(spaceId, { page, per_page: 100 });
+    if (!response) {
+      break;
+    }
+    const total = Number(response.headers.get("Total"));
+    const perPage = Number(response.headers.get("Per-Page"));
+    totalPages = Math.ceil(total / perPage);
+    if (page === 1) {
+      options?.onTotal?.(total);
+    }
+    for (const story of response.stories) {
+      const ref = { id: story.id, uuid: story.uuid };
+      if (story.full_slug) {
+        result.bySlug.set(story.full_slug, ref);
+      }
+      result.byId.set(story.id, ref);
+    }
+    options?.onIncrement?.(response.stories.length);
+    page++;
+  }
+  return result;
+};
 
 const ERROR_CODES = {
   MIGRATION_APPLY_TO_STORY_ERROR: "MIGRATION_APPLY_TO_STORY_ERROR",
@@ -5785,7 +5815,7 @@ const saveTypesToComponentsFile = async (space, typedefData, options) => {
 const generateStoryblokTypes = async (options = {}) => {
   const { path } = options;
   try {
-    const storyblokTypesPath = resolve(__dirname, "./index.d.ts");
+    const storyblokTypesPath = resolve(__dirname$1, "./index.d.ts");
     const storyblokTypesContent = readFileSync(storyblokTypesPath, "utf-8");
     const typeDefs = [
       "// This file was generated by the Storyblok CLI.",
@@ -8186,23 +8216,8 @@ const mapReferencesStream = ({
     }
   });
 };
-const getRemoteStory = async ({ spaceId, storyId }) => {
-  const { data, response } = await getMapiClient().stories.get({
-    path: {
-      space_id: spaceId,
-      story_id: storyId
-    }
-  });
-  if (!response.ok && response.status !== 404) {
-    handleAPIError("pull_story", new FetchError(response.statusText, response));
-  }
-  if (data?.story?.deleted_at) {
-    return void 0;
-  }
-  return data?.story;
-};
 const makeCreateStoryAPITransport = ({ spaceId }) => async (localStory) => {
-  const { id: _id, uuid: _uuid, parent_id: _parentId, content, ...newStoryData } = localStory;
+  const { id: _id, uuid: _uuid, parent_id: _parentId, is_startpage: _isStartpage, 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.`);
   }
@@ -8233,7 +8248,8 @@ const makeAppendToManifestFSTransport = ({ manifestFile }) => async (localStory,
 };
 const createStoryPlaceholderStream = ({
   maps,
-  spaceId,
+  existingTargetStories,
+  isCrossSpace,
   transports,
   onIncrement,
   onStorySuccess,
@@ -8248,16 +8264,19 @@ const createStoryPlaceholderStream = ({
       const task = (async () => {
         try {
           const mappedStoryId = maps.stories?.get(localStory.id);
-          const mappedRemoteStory = mappedStoryId && await getRemoteStory({ spaceId, storyId: Number(mappedStoryId) });
+          const mappedRemoteStory = mappedStoryId ? existingTargetStories.byId.get(Number(mappedStoryId)) : void 0;
           if (mappedRemoteStory) {
             onStorySkipped?.(localStory, mappedRemoteStory);
             return;
           }
-          const existingRemoteStory = await getRemoteStory({ spaceId, storyId: localStory.id });
-          if (existingRemoteStory && existingRemoteStory.uuid === localStory.uuid) {
-            await transports.appendStoryManifest(localStory, existingRemoteStory);
-            onStorySkipped?.(localStory, existingRemoteStory);
-            return;
+          const existingBySlug = localStory.full_slug ? existingTargetStories.bySlug.get(localStory.full_slug) : void 0;
+          if (existingBySlug) {
+            const isMatchConfirmed = isCrossSpace || existingBySlug.uuid === localStory.uuid;
+            if (isMatchConfirmed) {
+              await transports.appendStoryManifest(localStory, existingBySlug);
+              onStorySkipped?.(localStory, existingBySlug);
+              return;
+            }
           }
           const newRemoteStory = await transports.createStory(localStory);
           await transports.appendStoryManifest(localStory, newRemoteStory);
@@ -8895,6 +8914,12 @@ pushCmd.action(async (options, command) => {
       logger.error(message);
       return;
     }
+    const fetchProgress = ui.createProgressBar({ title: "Matching Stories...".padEnd(21) });
+    const existingTargetStories = await prefetchTargetStories(space, {
+      onTotal: (total) => fetchProgress.setTotal(total),
+      onIncrement: (count) => fetchProgress.increment(count)
+    });
+    fetchProgress.stop();
     const storiesDirectoryPath = resolveCommandPath(directories.stories, fromSpace, basePath);
     const creationProgress = ui.createProgressBar({ title: "Creating Stories...".padEnd(21) });
     const processProgress = ui.createProgressBar({ title: "Processing Stories...".padEnd(21) });
@@ -8924,7 +8949,8 @@ pushCmd.action(async (options, command) => {
       // Create remote stories.
       createStoryPlaceholderStream({
         maps,
-        spaceId: space,
+        existingTargetStories,
+        isCrossSpace: fromSpace !== space,
         transports: {
           createStory: options.dryRun ? async (story) => story : makeCreateStoryAPITransport({
             spaceId: space