feat(cli): add type helpers for user's config file

Author: alexjoverm

packages/cli/build.config.ts

@@ -2,7 +2,13 @@ import { defineBuildConfig } from 'unbuild';
 
 export default defineBuildConfig({
   declaration: true,
-  entries: ['./src/index'],
+  entries: [
+    './src/index',
+    {
+      input: './src/entrypoints/config',
+      name: 'config/index',
+    },
+  ],
   failOnWarn: false,
   sourcemap: true,
 });

packages/cli/package.json

@@ -18,7 +18,18 @@
     "node",
     "javascript"
   ],
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.mjs"
+    },
+    "./config": {
+      "types": "./dist/config/index.d.ts",
+      "import": "./dist/config/index.mjs"
+    }
+  },
   "main": "./dist/index.mjs",
+  "types": "./dist/index.d.ts",
   "bin": {
     "storyblok": "./dist/index.mjs"
   },

packages/cli/src/config/index.test.ts

@@ -3,6 +3,7 @@ import { Command } from 'commander';
 import { resolveConfig } from './resolver';
 import { applyConfigToCommander } from './commander';
 import { DEFAULT_GLOBAL_CONFIG } from './defaults';
+import { defineConfig } from './types';
 import * as helpers from './helpers';
 
 interface CommandHierarchy {
@@ -168,3 +169,21 @@ describe('config resolver', () => {
     expect(pull.getOptionValue('suffix')).toBe('resolved');
   });
 });
+
+describe('defineConfig', () => {
+  it('returns the same config reference for typed authoring', () => {
+    const input = {
+      region: 'us',
+      modules: {
+        components: {
+          path: '.storyblok',
+          pull: {
+            separateFiles: true,
+          },
+        },
+      },
+    } as const;
+    const result = defineConfig(input);
+    expect(result).toBe(input);
+  });
+});

packages/cli/src/config/types.ts

@@ -1,5 +1,13 @@
 import type { RegionCode } from '../constants';
 import type { Command, Option } from 'commander';
+import type { CommandOptions } from '../types';
+import type { PullComponentsOptions } from '../commands/components/pull/constants';
+import type { PushComponentsOptions } from '../commands/components/push/constants';
+import type { PullDatasourcesOptions } from '../commands/datasources/pull/constants';
+import type { PushDatasourcesOptions } from '../commands/datasources/push/constants';
+import type { MigrationsGenerateOptions } from '../commands/migrations/generate/constants';
+import type { MigrationsRunOptions } from '../commands/migrations/run/constants';
+import type { GenerateTypesOptions } from '../commands/types/generate/constants';
 
 export type PlainObject = Record<string, any>;
 
@@ -41,6 +49,59 @@ export interface ResolvedCliConfig extends GlobalConfig {
   [key: string]: any;
 }
 
+type StripCommandOption<T> = T extends CommandOptions ? Omit<T, keyof CommandOptions> : T;
+type CommandConfig<T> = Partial<StripCommandOption<T>>;
+
+export interface ComponentsModuleConfig extends Record<string, unknown> {
+  space?: string;
+  path?: string;
+  pull?: CommandConfig<PullComponentsOptions>;
+  push?: CommandConfig<PushComponentsOptions>;
+}
+
+export interface DatasourcesModuleConfig extends Record<string, unknown> {
+  space?: string;
+  path?: string;
+  pull?: CommandConfig<PullDatasourcesOptions>;
+  push?: CommandConfig<PushDatasourcesOptions>;
+}
+
+export interface MigrationsModuleConfig extends Record<string, unknown> {
+  space?: string;
+  path?: string;
+  generate?: CommandConfig<MigrationsGenerateOptions>;
+  run?: CommandConfig<MigrationsRunOptions>;
+}
+
+export interface TypesModuleConfig extends Record<string, unknown> {
+  space?: string;
+  path?: string;
+  generate?: CommandConfig<GenerateTypesOptions>;
+}
+
+export type ModulesConfig = Record<string, PlainObject> & {
+  components?: ComponentsModuleConfig;
+  datasources?: DatasourcesModuleConfig;
+  migrations?: MigrationsModuleConfig;
+  types?: TypesModuleConfig;
+};
+
+export type DeepPartial<T> = {
+  [K in keyof T]?: T[K] extends (...args: any[]) => any
+    ? T[K]
+    : T[K] extends object
+      ? DeepPartial<T[K]>
+      : T[K];
+};
+
+export interface StoryblokConfig extends DeepPartial<GlobalConfig> {
+  modules?: ModulesConfig;
+}
+
+export function defineConfig<T extends StoryblokConfig>(config: T): T {
+  return config;
+}
+
 export type OptionParser<T> = (value: string, previous?: T) => T;
 
 export interface GlobalOptionDefinition<T = unknown> {

packages/cli/src/entrypoints/config.ts

@@ -0,0 +1,9 @@
+export { defineConfig } from '../config/types';
+export type {
+  ComponentsModuleConfig,
+  DatasourcesModuleConfig,
+  MigrationsModuleConfig,
+  ModulesConfig,
+  StoryblokConfig,
+  TypesModuleConfig,
+} from '../config/types';