storyblok 4.10.0 → 4.11.0

package/dist/config/index.d.mts

@@ -0,0 +1,207 @@
+declare const regionCodes: readonly ["eu", "us", "cn", "ca", "ap"];
+type RegionCode = typeof regionCodes[number];
+
+/**
+ * Interface representing the default options for a CLI command.
+ */
+interface CommandOptions {
+    /**
+     * Indicates whether verbose output is enabled.
+     */
+    verbose: boolean;
+}
+
+/**
+ * Interface representing the options for the `components pull` command.
+ */
+interface PullComponentsOptions extends CommandOptions {
+    /**
+     * The filename to save the file as.
+     * Defaults to `components`. The file will be saved as `<filename>.<space>.json`.
+     * @default `components
+     */
+    filename?: string;
+    /**
+     * The suffix to add to the filename.
+     * Defaults to the space ID.
+     * @default space
+     */
+    suffix?: string;
+    /**
+     * Indicates whether to save each component to a separate file.
+     * @default false
+     */
+    separateFiles?: boolean;
+}
+
+interface PushComponentsOptions extends CommandOptions {
+    /**
+     * The glob pattern filter to apply to components before pushing.
+     * Matching components and all their dependencies (groups, tags, other components)
+     * will be collected and pushed together.
+     * @default `.*`
+     */
+    filter?: string;
+    /**
+     * Indicates whether to save each component to a separate file.
+     * @default false
+     */
+    separateFiles?: boolean;
+    /**
+     * The source space id.
+     */
+    from?: string;
+    /**
+     * Suffix to add to the component name.
+     */
+    suffix?: string;
+}
+
+interface MigrationsGenerateOptions extends CommandOptions {
+    suffix?: string;
+}
+
+interface MigrationsRunOptions extends CommandOptions {
+    dryRun?: boolean;
+    filter?: string;
+    query?: string;
+    startsWith?: string;
+    publish?: 'all' | 'published' | 'published-with-changes';
+}
+
+/**
+ * Interface representing the options for the `datasources pull` command.
+ */
+interface PullDatasourcesOptions extends CommandOptions {
+    /**
+     * The filename to save the file as.
+     * Defaults to `DEFAULT_DATASOURCES_FILENAME`. The file will be saved as `<filename>.<space>.json`.
+     * @default DEFAULT_DATASOURCES_FILENAME
+     */
+    filename?: string;
+    /**
+     * The suffix to add to the filename.
+     * Defaults to the space ID.
+     * @default space
+     */
+    suffix?: string;
+    /**
+     * Indicates whether to save each datasource to a separate file.
+     * @default false
+     */
+    separateFiles?: boolean;
+}
+
+interface PushDatasourcesOptions extends CommandOptions {
+    /**
+     * The glob pattern filter to apply to datasources before pushing.
+     * @default `.*`
+     */
+    filter?: string;
+    /**
+     * Indicates whether to save each component to a separate file.
+     * @default false
+     */
+    separateFiles?: boolean;
+    /**
+     * The source space id.
+     */
+    from?: string;
+    /**
+     * Suffix to add to the component name.
+     */
+    suffix?: string;
+}
+
+interface GenerateTypesOptions {
+    separateFiles?: boolean;
+    strict?: boolean;
+    typePrefix?: string;
+    typeSuffix?: string;
+    filename?: string;
+    path?: string;
+    suffix?: string;
+    customFieldsParser?: string;
+    compilerOptions?: string;
+}
+
+/**
+ * Makes all properties in T optional recursively
+ */
+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;
+}
+interface LogConsoleConfig {
+    enabled: boolean;
+    level: string;
+}
+interface LogFileConfig {
+    enabled: boolean;
+    level: string;
+    maxFiles: number;
+}
+interface LogConfig {
+    console: LogConsoleConfig;
+    file: LogFileConfig;
+}
+interface ReportConfig {
+    enabled: boolean;
+    maxFiles: number;
+}
+interface UiConfig {
+    enabled: boolean;
+}
+interface GlobalConfig {
+    region?: RegionCode;
+    api: ApiConfig;
+    log: LogConfig;
+    report: ReportConfig;
+    ui: UiConfig;
+    verbose: boolean;
+}
+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;
+    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 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;
+};
+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 };

package/dist/config/index.d.ts

@@ -0,0 +1,207 @@
+declare const regionCodes: readonly ["eu", "us", "cn", "ca", "ap"];
+type RegionCode = typeof regionCodes[number];
+
+/**
+ * Interface representing the default options for a CLI command.
+ */
+interface CommandOptions {
+    /**
+     * Indicates whether verbose output is enabled.
+     */
+    verbose: boolean;
+}
+
+/**
+ * Interface representing the options for the `components pull` command.
+ */
+interface PullComponentsOptions extends CommandOptions {
+    /**
+     * The filename to save the file as.
+     * Defaults to `components`. The file will be saved as `<filename>.<space>.json`.
+     * @default `components
+     */
+    filename?: string;
+    /**
+     * The suffix to add to the filename.
+     * Defaults to the space ID.
+     * @default space
+     */
+    suffix?: string;
+    /**
+     * Indicates whether to save each component to a separate file.
+     * @default false
+     */
+    separateFiles?: boolean;
+}
+
+interface PushComponentsOptions extends CommandOptions {
+    /**
+     * The glob pattern filter to apply to components before pushing.
+     * Matching components and all their dependencies (groups, tags, other components)
+     * will be collected and pushed together.
+     * @default `.*`
+     */
+    filter?: string;
+    /**
+     * Indicates whether to save each component to a separate file.
+     * @default false
+     */
+    separateFiles?: boolean;
+    /**
+     * The source space id.
+     */
+    from?: string;
+    /**
+     * Suffix to add to the component name.
+     */
+    suffix?: string;
+}
+
+interface MigrationsGenerateOptions extends CommandOptions {
+    suffix?: string;
+}
+
+interface MigrationsRunOptions extends CommandOptions {
+    dryRun?: boolean;
+    filter?: string;
+    query?: string;
+    startsWith?: string;
+    publish?: 'all' | 'published' | 'published-with-changes';
+}
+
+/**
+ * Interface representing the options for the `datasources pull` command.
+ */
+interface PullDatasourcesOptions extends CommandOptions {
+    /**
+     * The filename to save the file as.
+     * Defaults to `DEFAULT_DATASOURCES_FILENAME`. The file will be saved as `<filename>.<space>.json`.
+     * @default DEFAULT_DATASOURCES_FILENAME
+     */
+    filename?: string;
+    /**
+     * The suffix to add to the filename.
+     * Defaults to the space ID.
+     * @default space
+     */
+    suffix?: string;
+    /**
+     * Indicates whether to save each datasource to a separate file.
+     * @default false
+     */
+    separateFiles?: boolean;
+}
+
+interface PushDatasourcesOptions extends CommandOptions {
+    /**
+     * The glob pattern filter to apply to datasources before pushing.
+     * @default `.*`
+     */
+    filter?: string;
+    /**
+     * Indicates whether to save each component to a separate file.
+     * @default false
+     */
+    separateFiles?: boolean;
+    /**
+     * The source space id.
+     */
+    from?: string;
+    /**
+     * Suffix to add to the component name.
+     */
+    suffix?: string;
+}
+
+interface GenerateTypesOptions {
+    separateFiles?: boolean;
+    strict?: boolean;
+    typePrefix?: string;
+    typeSuffix?: string;
+    filename?: string;
+    path?: string;
+    suffix?: string;
+    customFieldsParser?: string;
+    compilerOptions?: string;
+}
+
+/**
+ * Makes all properties in T optional recursively
+ */
+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;
+}
+interface LogConsoleConfig {
+    enabled: boolean;
+    level: string;
+}
+interface LogFileConfig {
+    enabled: boolean;
+    level: string;
+    maxFiles: number;
+}
+interface LogConfig {
+    console: LogConsoleConfig;
+    file: LogFileConfig;
+}
+interface ReportConfig {
+    enabled: boolean;
+    maxFiles: number;
+}
+interface UiConfig {
+    enabled: boolean;
+}
+interface GlobalConfig {
+    region?: RegionCode;
+    api: ApiConfig;
+    log: LogConfig;
+    report: ReportConfig;
+    ui: UiConfig;
+    verbose: boolean;
+}
+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;
+    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 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;
+};
+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 };

package/dist/config/index.mjs

@@ -0,0 +1,6 @@
+function defineConfig(config) {
+  return config;
+}
+
+export { defineConfig };
+//# sourceMappingURL=index.mjs.map

package/dist/config/index.mjs.map

@@ -0,0 +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;;;;"}