storyblok 4.14.1 → 4.14.3

package/dist/config/index.d.mts

@@ -69,6 +69,20 @@ interface MigrationsRunOptions extends CommandOptions {
     publish?: 'all' | 'published' | 'published-with-changes';
 }
 
+/**
+ * Options for the datasources delete command.
+ */
+interface DeleteDatasourceOptions {
+    /**
+     * The datasource id to delete by, if provided. If not set, the command will delete by name.
+     */
+    id?: string;
+    /**
+     * If true, skip confirmation prompt (for CI or automation)
+     */
+    force?: boolean;
+}
+
 /**
  * Interface representing the options for the `datasources pull` command.
  */
@@ -113,6 +127,8 @@ interface PushDatasourcesOptions extends CommandOptions {
     suffix?: string;
 }
 
+type MigrationsRollbackOptions = CommandOptions;
+
 interface GenerateTypesOptions {
     separateFiles?: boolean;
     strict?: boolean;
@@ -125,6 +141,73 @@ interface GenerateTypesOptions {
     compilerOptions?: string;
 }
 
+/**
+ * Interface representing the options for the `pull-languages` command.
+ */
+interface PullLanguagesOptions extends CommandOptions {
+    /**
+     * The path to save the languages file to.
+     * Defaults to `.storyblok/languages`.
+     * @default `.storyblok/languages`
+     */
+    path?: string;
+    /**
+     * The space ID.
+     * @required true
+     */
+    space: string;
+    /**
+     * The filename to save the file as.
+     * Defaults to `DEFAULT_LANGUAGES_FILENAME`. The file will be saved as `<filename>.<space>.json`.
+     * @default DEFAULT_LANGUAGES_FILENAME
+     */
+    filename?: string;
+    /**
+     * The suffix to add to the filename.
+     * Defaults to the space ID.
+     * @default space
+     */
+    suffix?: string;
+}
+
+interface PullAssetsOptions extends CommandOptions {
+    dryRun?: boolean;
+    query?: string;
+    assetToken?: string;
+}
+
+interface PushAssetsOptions extends CommandOptions {
+    from?: string;
+    data?: string;
+    shortFilename?: string;
+    folder?: string;
+    cleanup?: boolean;
+    updateStories?: boolean;
+    assetToken?: string;
+    dryRun?: boolean;
+}
+
+interface PullStoriesOptions extends CommandOptions {
+    dryRun?: boolean;
+    query?: string;
+    startsWith?: string;
+}
+
+interface PushStoriesOptions extends CommandOptions {
+    from?: string;
+    dryRun?: boolean;
+    publish?: string;
+    cleanup?: boolean;
+}
+
+interface PruneLogsOptions extends CommandOptions {
+    keep: number;
+}
+
+interface PruneReportsOptions extends CommandOptions {
+    keep: number;
+}
+
 /**
  * Makes all properties in T optional recursively
  */
@@ -132,7 +215,6 @@ type DeepPartial<T> = T extends object ? {
     [P in keyof T]?: DeepPartial<T[P]>;
 } : T;
 
-type PlainObject = Record<string, any>;
 interface ApiConfig {
     maxRetries: number;
     maxConcurrency: number;
@@ -159,6 +241,8 @@ interface UiConfig {
 }
 interface GlobalConfig {
     region?: RegionCode;
+    space?: number | string;
+    path?: string;
     api: ApiConfig;
     log: LogConfig;
     report: ReportConfig;
@@ -167,41 +251,68 @@ interface GlobalConfig {
 }
 type StripCommandOption<T> = T extends CommandOptions ? Omit<T, keyof CommandOptions> : T;
 type CommandConfig<T> = Partial<StripCommandOption<T>>;
-interface ComponentsModuleConfig extends Record<string, unknown> {
-    space?: number;
+interface SharedConfigOptions {
+    space?: number | string;
     path?: string;
-    pull?: CommandConfig<PullComponentsOptions>;
-    push?: CommandConfig<PushComponentsOptions>;
 }
-interface DatasourcesModuleConfig extends Record<string, unknown> {
-    space?: number;
-    path?: string;
-    pull?: CommandConfig<PullDatasourcesOptions>;
-    push?: CommandConfig<PushDatasourcesOptions>;
-}
-interface MigrationsModuleConfig extends Record<string, unknown> {
-    space?: number;
-    path?: string;
-    generate?: CommandConfig<MigrationsGenerateOptions>;
-    run?: CommandConfig<MigrationsRunOptions>;
+interface CommandOptionsMap {
+    components: {
+        pull: PullComponentsOptions;
+        push: PushComponentsOptions;
+    };
+    datasources: {
+        pull: PullDatasourcesOptions;
+        push: PushDatasourcesOptions;
+        delete: DeleteDatasourceOptions;
+    };
+    migrations: {
+        generate: MigrationsGenerateOptions;
+        run: MigrationsRunOptions;
+        rollback: MigrationsRollbackOptions;
+    };
+    types: {
+        generate: GenerateTypesOptions;
+    };
+    languages: {
+        pull: PullLanguagesOptions;
+    };
+    assets: {
+        pull: PullAssetsOptions;
+        push: PushAssetsOptions;
+    };
+    stories: {
+        pull: PullStoriesOptions;
+        push: PushStoriesOptions;
+    };
+    logs: {
+        list: Record<string, never>;
+        prune: PruneLogsOptions;
+    };
+    reports: {
+        list: Record<string, never>;
+        prune: PruneReportsOptions;
+    };
 }
-interface TypesModuleConfig extends Record<string, unknown> {
-    space?: number;
-    path?: string;
-    generate?: CommandConfig<GenerateTypesOptions>;
-}
-type ModulesConfig = Record<string, PlainObject> & {
-    components?: ComponentsModuleConfig;
-    datasources?: DatasourcesModuleConfig;
-    migrations?: MigrationsModuleConfig;
-    types?: TypesModuleConfig;
+type SubcommandConfig<T> = SharedConfigOptions & CommandConfig<T>;
+type ModuleConfig<Subs extends Record<string, any>> = SharedConfigOptions & {
+    [K in keyof Subs]?: SubcommandConfig<Subs[K]>;
+};
+type ModulesConfig = {
+    [K in keyof CommandOptionsMap]?: ModuleConfig<CommandOptionsMap[K]>;
 };
+type ComponentsModuleConfig = ModulesConfig['components'];
+type DatasourcesModuleConfig = ModulesConfig['datasources'];
+type MigrationsModuleConfig = ModulesConfig['migrations'];
+type TypesModuleConfig = ModulesConfig['types'];
+type LanguagesModuleConfig = ModulesConfig['languages'];
+type AssetsModuleConfig = ModulesConfig['assets'];
+type StoriesModuleConfig = ModulesConfig['stories'];
+type LogsModuleConfig = ModulesConfig['logs'];
+type ReportsModuleConfig = ModulesConfig['reports'];
 interface StoryblokConfig extends DeepPartial<GlobalConfig> {
-    space?: number;
-    path?: string;
     modules?: ModulesConfig;
 }
 declare function defineConfig<T extends StoryblokConfig>(config: T): T;
 
 export { defineConfig };
-export type { ComponentsModuleConfig, DatasourcesModuleConfig, MigrationsModuleConfig, ModulesConfig, StoryblokConfig, TypesModuleConfig };
+export type { AssetsModuleConfig, ComponentsModuleConfig, DatasourcesModuleConfig, LanguagesModuleConfig, LogsModuleConfig, MigrationsModuleConfig, ModulesConfig, ReportsModuleConfig, StoriesModuleConfig, StoryblokConfig, TypesModuleConfig };

package/dist/config/index.d.ts

@@ -69,6 +69,20 @@ interface MigrationsRunOptions extends CommandOptions {
     publish?: 'all' | 'published' | 'published-with-changes';
 }
 
+/**
+ * Options for the datasources delete command.
+ */
+interface DeleteDatasourceOptions {
+    /**
+     * The datasource id to delete by, if provided. If not set, the command will delete by name.
+     */
+    id?: string;
+    /**
+     * If true, skip confirmation prompt (for CI or automation)
+     */
+    force?: boolean;
+}
+
 /**
  * Interface representing the options for the `datasources pull` command.
  */
@@ -113,6 +127,8 @@ interface PushDatasourcesOptions extends CommandOptions {
     suffix?: string;
 }
 
+type MigrationsRollbackOptions = CommandOptions;
+
 interface GenerateTypesOptions {
     separateFiles?: boolean;
     strict?: boolean;
@@ -125,6 +141,73 @@ interface GenerateTypesOptions {
     compilerOptions?: string;
 }
 
+/**
+ * Interface representing the options for the `pull-languages` command.
+ */
+interface PullLanguagesOptions extends CommandOptions {
+    /**
+     * The path to save the languages file to.
+     * Defaults to `.storyblok/languages`.
+     * @default `.storyblok/languages`
+     */
+    path?: string;
+    /**
+     * The space ID.
+     * @required true
+     */
+    space: string;
+    /**
+     * The filename to save the file as.
+     * Defaults to `DEFAULT_LANGUAGES_FILENAME`. The file will be saved as `<filename>.<space>.json`.
+     * @default DEFAULT_LANGUAGES_FILENAME
+     */
+    filename?: string;
+    /**
+     * The suffix to add to the filename.
+     * Defaults to the space ID.
+     * @default space
+     */
+    suffix?: string;
+}
+
+interface PullAssetsOptions extends CommandOptions {
+    dryRun?: boolean;
+    query?: string;
+    assetToken?: string;
+}
+
+interface PushAssetsOptions extends CommandOptions {
+    from?: string;
+    data?: string;
+    shortFilename?: string;
+    folder?: string;
+    cleanup?: boolean;
+    updateStories?: boolean;
+    assetToken?: string;
+    dryRun?: boolean;
+}
+
+interface PullStoriesOptions extends CommandOptions {
+    dryRun?: boolean;
+    query?: string;
+    startsWith?: string;
+}
+
+interface PushStoriesOptions extends CommandOptions {
+    from?: string;
+    dryRun?: boolean;
+    publish?: string;
+    cleanup?: boolean;
+}
+
+interface PruneLogsOptions extends CommandOptions {
+    keep: number;
+}
+
+interface PruneReportsOptions extends CommandOptions {
+    keep: number;
+}
+
 /**
  * Makes all properties in T optional recursively
  */
@@ -132,7 +215,6 @@ type DeepPartial<T> = T extends object ? {
     [P in keyof T]?: DeepPartial<T[P]>;
 } : T;
 
-type PlainObject = Record<string, any>;
 interface ApiConfig {
     maxRetries: number;
     maxConcurrency: number;
@@ -159,6 +241,8 @@ interface UiConfig {
 }
 interface GlobalConfig {
     region?: RegionCode;
+    space?: number | string;
+    path?: string;
     api: ApiConfig;
     log: LogConfig;
     report: ReportConfig;
@@ -167,41 +251,68 @@ interface GlobalConfig {
 }
 type StripCommandOption<T> = T extends CommandOptions ? Omit<T, keyof CommandOptions> : T;
 type CommandConfig<T> = Partial<StripCommandOption<T>>;
-interface ComponentsModuleConfig extends Record<string, unknown> {
-    space?: number;
+interface SharedConfigOptions {
+    space?: number | string;
     path?: string;
-    pull?: CommandConfig<PullComponentsOptions>;
-    push?: CommandConfig<PushComponentsOptions>;
 }
-interface DatasourcesModuleConfig extends Record<string, unknown> {
-    space?: number;
-    path?: string;
-    pull?: CommandConfig<PullDatasourcesOptions>;
-    push?: CommandConfig<PushDatasourcesOptions>;
-}
-interface MigrationsModuleConfig extends Record<string, unknown> {
-    space?: number;
-    path?: string;
-    generate?: CommandConfig<MigrationsGenerateOptions>;
-    run?: CommandConfig<MigrationsRunOptions>;
+interface CommandOptionsMap {
+    components: {
+        pull: PullComponentsOptions;
+        push: PushComponentsOptions;
+    };
+    datasources: {
+        pull: PullDatasourcesOptions;
+        push: PushDatasourcesOptions;
+        delete: DeleteDatasourceOptions;
+    };
+    migrations: {
+        generate: MigrationsGenerateOptions;
+        run: MigrationsRunOptions;
+        rollback: MigrationsRollbackOptions;
+    };
+    types: {
+        generate: GenerateTypesOptions;
+    };
+    languages: {
+        pull: PullLanguagesOptions;
+    };
+    assets: {
+        pull: PullAssetsOptions;
+        push: PushAssetsOptions;
+    };
+    stories: {
+        pull: PullStoriesOptions;
+        push: PushStoriesOptions;
+    };
+    logs: {
+        list: Record<string, never>;
+        prune: PruneLogsOptions;
+    };
+    reports: {
+        list: Record<string, never>;
+        prune: PruneReportsOptions;
+    };
 }
-interface TypesModuleConfig extends Record<string, unknown> {
-    space?: number;
-    path?: string;
-    generate?: CommandConfig<GenerateTypesOptions>;
-}
-type ModulesConfig = Record<string, PlainObject> & {
-    components?: ComponentsModuleConfig;
-    datasources?: DatasourcesModuleConfig;
-    migrations?: MigrationsModuleConfig;
-    types?: TypesModuleConfig;
+type SubcommandConfig<T> = SharedConfigOptions & CommandConfig<T>;
+type ModuleConfig<Subs extends Record<string, any>> = SharedConfigOptions & {
+    [K in keyof Subs]?: SubcommandConfig<Subs[K]>;
+};
+type ModulesConfig = {
+    [K in keyof CommandOptionsMap]?: ModuleConfig<CommandOptionsMap[K]>;
 };
+type ComponentsModuleConfig = ModulesConfig['components'];
+type DatasourcesModuleConfig = ModulesConfig['datasources'];
+type MigrationsModuleConfig = ModulesConfig['migrations'];
+type TypesModuleConfig = ModulesConfig['types'];
+type LanguagesModuleConfig = ModulesConfig['languages'];
+type AssetsModuleConfig = ModulesConfig['assets'];
+type StoriesModuleConfig = ModulesConfig['stories'];
+type LogsModuleConfig = ModulesConfig['logs'];
+type ReportsModuleConfig = ModulesConfig['reports'];
 interface StoryblokConfig extends DeepPartial<GlobalConfig> {
-    space?: number;
-    path?: string;
     modules?: ModulesConfig;
 }
 declare function defineConfig<T extends StoryblokConfig>(config: T): T;
 
 export { defineConfig };
-export type { ComponentsModuleConfig, DatasourcesModuleConfig, MigrationsModuleConfig, ModulesConfig, StoryblokConfig, TypesModuleConfig };
+export type { AssetsModuleConfig, ComponentsModuleConfig, DatasourcesModuleConfig, LanguagesModuleConfig, LogsModuleConfig, MigrationsModuleConfig, ModulesConfig, ReportsModuleConfig, StoriesModuleConfig, StoryblokConfig, TypesModuleConfig };

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 { MigrationsGenerateOptions } from '../../commands/migrations/generate/constants';\nimport type { MigrationsRunOptions } from '../../commands/migrations/run/constants';\nimport type { GenerateTypesOptions } from '../../commands/types/generate/constants';\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  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 ComponentsModuleConfig extends Record<string, unknown> {\n  space?: number;\n  path?: string;\n  pull?: CommandConfig<PullComponentsOptions>;\n  push?: CommandConfig<PushComponentsOptions>;\n}\n\nexport interface DatasourcesModuleConfig extends Record<string, unknown> {\n  space?: number;\n  path?: string;\n  pull?: CommandConfig<PullDatasourcesOptions>;\n  push?: CommandConfig<PushDatasourcesOptions>;\n}\n\nexport interface MigrationsModuleConfig extends Record<string, unknown> {\n  space?: number;\n  path?: string;\n  generate?: CommandConfig<MigrationsGenerateOptions>;\n  run?: CommandConfig<MigrationsRunOptions>;\n}\n\nexport interface TypesModuleConfig extends Record<string, unknown> {\n  space?: number;\n  path?: string;\n  generate?: CommandConfig<GenerateTypesOptions>;\n}\n\nexport type ModulesConfig = Record<string, PlainObject> & {\n  components?: ComponentsModuleConfig;\n  datasources?: DatasourcesModuleConfig;\n  migrations?: MigrationsModuleConfig;\n  types?: TypesModuleConfig;\n};\n\nexport interface StoryblokConfig extends DeepPartial<GlobalConfig> {\n  space?: number;\n  path?: string;\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":"AAoGO,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,MAAc,EAAA;AACpE,EAAO,OAAA,MAAA;AACT;;;;"}