@kubb/core 5.0.0-alpha.9 → 5.0.0-beta.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (64) hide show
  1. package/README.md +24 -21
  2. package/dist/PluginDriver-BXibeQk-.cjs +1036 -0
  3. package/dist/PluginDriver-BXibeQk-.cjs.map +1 -0
  4. package/dist/PluginDriver-DV3p2Hky.js +945 -0
  5. package/dist/PluginDriver-DV3p2Hky.js.map +1 -0
  6. package/dist/index.cjs +752 -1641
  7. package/dist/index.cjs.map +1 -1
  8. package/dist/index.d.ts +271 -225
  9. package/dist/index.js +736 -1609
  10. package/dist/index.js.map +1 -1
  11. package/dist/mocks.cjs +145 -0
  12. package/dist/mocks.cjs.map +1 -0
  13. package/dist/mocks.d.ts +80 -0
  14. package/dist/mocks.js +140 -0
  15. package/dist/mocks.js.map +1 -0
  16. package/dist/types-CC09VtBt.d.ts +2148 -0
  17. package/package.json +51 -57
  18. package/src/FileManager.ts +115 -0
  19. package/src/FileProcessor.ts +86 -0
  20. package/src/Kubb.ts +207 -131
  21. package/src/PluginDriver.ts +325 -564
  22. package/src/constants.ts +20 -47
  23. package/src/createAdapter.ts +13 -6
  24. package/src/createKubb.ts +574 -0
  25. package/src/createRenderer.ts +57 -0
  26. package/src/createStorage.ts +13 -1
  27. package/src/defineGenerator.ts +77 -124
  28. package/src/defineLogger.ts +4 -2
  29. package/src/defineMiddleware.ts +62 -0
  30. package/src/defineParser.ts +44 -0
  31. package/src/definePlugin.ts +83 -0
  32. package/src/defineResolver.ts +418 -28
  33. package/src/devtools.ts +14 -14
  34. package/src/index.ts +13 -15
  35. package/src/mocks.ts +178 -0
  36. package/src/renderNode.ts +35 -0
  37. package/src/storages/fsStorage.ts +41 -11
  38. package/src/storages/memoryStorage.ts +4 -2
  39. package/src/types.ts +1031 -283
  40. package/src/utils/diagnostics.ts +4 -1
  41. package/src/utils/isInputPath.ts +10 -0
  42. package/src/utils/packageJSON.ts +50 -12
  43. package/dist/PluginDriver-BkFepPdm.d.ts +0 -1054
  44. package/dist/chunk-ByKO4r7w.cjs +0 -38
  45. package/dist/hooks.cjs +0 -103
  46. package/dist/hooks.cjs.map +0 -1
  47. package/dist/hooks.d.ts +0 -77
  48. package/dist/hooks.js +0 -98
  49. package/dist/hooks.js.map +0 -1
  50. package/src/build.ts +0 -418
  51. package/src/config.ts +0 -56
  52. package/src/createPlugin.ts +0 -28
  53. package/src/hooks/index.ts +0 -4
  54. package/src/hooks/useKubb.ts +0 -143
  55. package/src/hooks/useMode.ts +0 -11
  56. package/src/hooks/usePlugin.ts +0 -11
  57. package/src/hooks/usePluginDriver.ts +0 -11
  58. package/src/utils/FunctionParams.ts +0 -155
  59. package/src/utils/TreeNode.ts +0 -215
  60. package/src/utils/executeStrategies.ts +0 -81
  61. package/src/utils/formatters.ts +0 -56
  62. package/src/utils/getBarrelFiles.ts +0 -141
  63. package/src/utils/getConfigs.ts +0 -12
  64. package/src/utils/linters.ts +0 -25
package/dist/index.d.ts CHANGED
@@ -1,177 +1,324 @@
1
1
  import { t as __name } from "./chunk--u3MIqq1.js";
2
- import { A as UserConfig, B as Storage, C as PluginWithLifeCycle, D as ResolveOptionsContext, E as ResolveNameParams, F as CoreGeneratorV2, G as AsyncEventEmitter, H as formatters, I as Generator, L as ReactGeneratorV2, M as UserPlugin, N as UserPluginWithLifeCycle, O as ResolvePathParams, P as UserResolver, R as defineGenerator, S as PluginParameter, T as PrinterFactoryOptions, U as linters, V as createStorage, W as logLevel, _ as Plugin, a as AdapterFactoryOptions, b as PluginLifecycle, c as Config, d as InputData, f as InputPath, g as Output, h as LoggerOptions, i as Adapter, j as UserLogger, k as Resolver, l as DevtoolsOptions, m as LoggerContext, n as PluginDriver, o as AdapterSource, p as Logger, r as getMode, s as BarrelType, u as Group, v as PluginContext, w as Printer, x as PluginLifecycleHooks, y as PluginFactoryOptions, z as KubbEvents } from "./PluginDriver-BkFepPdm.js";
3
- import { definePrinter } from "@kubb/ast";
4
- import { Node } from "@kubb/ast/types";
5
- import { Fabric, KubbFile } from "@kubb/fabric-core/types";
2
+ import { $ as defineParser, A as KubbPluginStartContext, B as Override, C as KubbGenerationSummaryContext, D as KubbLifecycleStartContext, E as KubbInfoContext, F as Logger, G as ResolveOptionsContext, H as PossibleConfig, I as LoggerContext, J as ResolverFileParams, K as Resolver, L as LoggerOptions, M as KubbSuccessContext, N as KubbVersionNewContext, O as KubbPluginEndContext, P as KubbWarnContext, Q as Parser, R as NormalizedPlugin, S as KubbGenerationStartContext, T as KubbHookStartContext, U as ResolveBannerContext, V as PluginFactoryOptions, W as ResolveNameParams, X as UserConfig, Y as ResolverPathParams, Z as UserLogger, _ as KubbErrorContext, _t as logLevel, a as Config, at as createKubb, b as KubbFilesProcessingStartContext, c as GeneratorContext, ct as Plugin, d as InputData, dt as defineGenerator, et as Middleware, f as InputPath, ft as Storage, g as KubbDebugContext, gt as createRenderer, h as KubbConfigEndContext, ht as RendererFactory, i as CLIOptions, it as BuildOutput, j as KubbPluginsEndContext, k as KubbPluginSetupContext, l as Group, lt as definePlugin, m as KubbBuildStartContext, mt as Renderer, n as AdapterFactoryOptions, nt as Kubb, o as DevtoolsOptions, ot as PluginDriver, p as KubbBuildEndContext, pt as createStorage, q as ResolverContext, r as AdapterSource, rt as KubbHooks, s as Exclude, st as FileManager, t as Adapter, tt as defineMiddleware, u as Include, ut as Generator, v as KubbFileProcessingUpdateContext, vt as AsyncEventEmitter, w as KubbHookEndContext, x as KubbGenerationEndContext, y as KubbFilesProcessingEndContext, z as Output } from "./types-CC09VtBt.js";
3
+ import * as ast from "@kubb/ast";
4
+ import { FileNode, InputNode, Node } from "@kubb/ast";
6
5
 
7
- //#region src/build.d.ts
8
- type BuildOptions = {
9
- config: UserConfig;
10
- events?: AsyncEventEmitter<KubbEvents>;
11
- };
12
- type BuildOutput = {
13
- failedPlugins: Set<{
14
- plugin: Plugin;
15
- error: Error;
16
- }>;
17
- fabric: Fabric;
18
- files: Array<KubbFile.ResolvedFile>;
19
- driver: PluginDriver;
20
- pluginTimings: Map<string, number>;
21
- error?: Error;
22
- sources: Map<KubbFile.Path, string>;
6
+ //#region ../../internals/utils/src/urlPath.d.ts
7
+ type URLObject = {
8
+ /**
9
+ * The resolved URL string (Express-style or template literal, depending on context).
10
+ */
11
+ url: string;
12
+ /**
13
+ * Extracted path parameters as a key-value map, or `undefined` when the path has none.
14
+ */
15
+ params?: Record<string, string>;
23
16
  };
24
- type SetupResult = {
25
- events: AsyncEventEmitter<KubbEvents>;
26
- fabric: Fabric;
27
- driver: PluginDriver;
28
- sources: Map<KubbFile.Path, string>;
17
+ type ObjectOptions = {
18
+ /**
19
+ * Controls whether the `url` is rendered as an Express path or a template literal.
20
+ * @default 'path'
21
+ */
22
+ type?: 'path' | 'template';
23
+ /**
24
+ * Optional transform applied to each extracted parameter name.
25
+ */
26
+ replacer?: (pathParam: string) => string;
27
+ /**
28
+ * When `true`, the result is serialized to a string expression instead of a plain object.
29
+ */
30
+ stringify?: boolean;
29
31
  };
30
- declare function setup(options: BuildOptions): Promise<SetupResult>;
31
- declare function build(options: BuildOptions, overrides?: SetupResult): Promise<BuildOutput>;
32
- declare function safeBuild(options: BuildOptions, overrides?: SetupResult): Promise<BuildOutput>;
33
- //#endregion
34
- //#region src/config.d.ts
35
32
  /**
36
- * CLI options derived from command-line flags.
33
+ * Supported identifier casing strategies for path parameters.
37
34
  */
38
- type CLIOptions = {
39
- /** Path to `kubb.config.js` */config?: string; /** Enable watch mode for input files */
40
- watch?: boolean;
35
+ type PathCasing = 'camelcase';
36
+ type Options = {
41
37
  /**
42
- * Logging verbosity for CLI usage.
43
- *
44
- * - `silent`: hide non-essential logs
45
- * - `info`: show general logs (non-plugin-related)
46
- * - `debug`: include detailed plugin lifecycle logs
47
- * @default 'silent'
38
+ * Casing strategy applied to path parameter names.
39
+ * @default undefined (original identifier preserved)
48
40
  */
49
- logLevel?: 'silent' | 'info' | 'debug'; /** Run Kubb with Bun */
50
- bun?: boolean;
41
+ casing?: PathCasing;
51
42
  };
52
- /** All accepted forms of a Kubb configuration. */
53
- type ConfigInput = PossiblePromise<UserConfig | UserConfig[]> | ((cli: CLIOptions) => PossiblePromise<UserConfig | UserConfig[]>);
54
43
  /**
55
- * Helper for defining a Kubb configuration.
56
- *
57
- * Accepts either:
58
- * - A config object or array of configs
59
- * - A function returning the config(s), optionally async,
60
- * receiving the CLI options as argument
44
+ * Parses and transforms an OpenAPI/Swagger path string into various URL formats.
61
45
  *
62
46
  * @example
63
- * export default defineConfig(({ logLevel }) => ({
64
- * root: 'src',
65
- * plugins: [myPlugin()],
66
- * }))
67
- */
68
- declare function defineConfig(config: (cli: CLIOptions) => PossiblePromise<UserConfig | UserConfig[]>): typeof config;
69
- declare function defineConfig(config: PossiblePromise<UserConfig | UserConfig[]>): typeof config;
70
- /**
71
- * Type guard to check if a given config has an `input.path`.
47
+ * const p = new URLPath('/pet/{petId}')
48
+ * p.URL // '/pet/:petId'
49
+ * p.template // '`/pet/${petId}`'
72
50
  */
73
- declare function isInputPath(config: UserConfig | undefined): config is UserConfig<InputPath>;
51
+ declare class URLPath {
52
+ #private;
53
+ /**
54
+ * The raw OpenAPI/Swagger path string, e.g. `/pet/{petId}`.
55
+ */
56
+ path: string;
57
+ constructor(path: string, options?: Options);
58
+ /** Converts the OpenAPI path to Express-style colon syntax, e.g. `/pet/{petId}` → `/pet/:petId`.
59
+ *
60
+ * @example
61
+ * ```ts
62
+ * new URLPath('/pet/{petId}').URL // '/pet/:petId'
63
+ * ```
64
+ */
65
+ get URL(): string;
66
+ /** Returns `true` when `path` is a fully-qualified URL (e.g. starts with `https://`).
67
+ *
68
+ * @example
69
+ * ```ts
70
+ * new URLPath('https://petstore.swagger.io/v2/pet').isURL // true
71
+ * new URLPath('/pet/{petId}').isURL // false
72
+ * ```
73
+ */
74
+ get isURL(): boolean;
75
+ /**
76
+ * Converts the OpenAPI path to a TypeScript template literal string.
77
+ *
78
+ * @example
79
+ * new URLPath('/pet/{petId}').template // '`/pet/${petId}`'
80
+ * new URLPath('/account/monetary-accountID').template // '`/account/${monetaryAccountId}`'
81
+ */
82
+ get template(): string;
83
+ /** Returns the path and its extracted params as a structured `URLObject`, or as a stringified expression when `stringify` is set.
84
+ *
85
+ * @example
86
+ * ```ts
87
+ * new URLPath('/pet/{petId}').object
88
+ * // { url: '/pet/:petId', params: { petId: 'petId' } }
89
+ * ```
90
+ */
91
+ get object(): URLObject | string;
92
+ /** Returns a map of path parameter names, or `undefined` when the path has no parameters.
93
+ *
94
+ * @example
95
+ * ```ts
96
+ * new URLPath('/pet/{petId}').params // { petId: 'petId' }
97
+ * new URLPath('/pet').params // undefined
98
+ * ```
99
+ */
100
+ get params(): Record<string, string> | undefined;
101
+ toObject({
102
+ type,
103
+ replacer,
104
+ stringify
105
+ }?: ObjectOptions): URLObject | string;
106
+ /**
107
+ * Converts the OpenAPI path to a TypeScript template literal string.
108
+ * An optional `replacer` can transform each extracted parameter name before interpolation.
109
+ *
110
+ * @example
111
+ * new URLPath('/pet/{petId}').toTemplateString() // '`/pet/${petId}`'
112
+ */
113
+ toTemplateString({
114
+ prefix,
115
+ replacer
116
+ }?: {
117
+ prefix?: string;
118
+ replacer?: (pathParam: string) => string;
119
+ }): string;
120
+ /**
121
+ * Extracts all `{param}` segments from the path and returns them as a key-value map.
122
+ * An optional `replacer` transforms each parameter name in both key and value positions.
123
+ * Returns `undefined` when no path parameters are found.
124
+ *
125
+ * @example
126
+ * ```ts
127
+ * new URLPath('/pet/{petId}/tag/{tagId}').getParams()
128
+ * // { petId: 'petId', tagId: 'tagId' }
129
+ * ```
130
+ */
131
+ getParams(replacer?: (pathParam: string) => string): Record<string, string> | undefined;
132
+ /** Converts the OpenAPI path to Express-style colon syntax.
133
+ *
134
+ * @example
135
+ * ```ts
136
+ * new URLPath('/pet/{petId}').toURLPath() // '/pet/:petId'
137
+ * ```
138
+ */
139
+ toURLPath(): string;
140
+ }
74
141
  //#endregion
75
142
  //#region src/createAdapter.d.ts
76
- /**
77
- * Builder type for an {@link Adapter} — takes options and returns the adapter instance.
78
- */
79
143
  type AdapterBuilder<T extends AdapterFactoryOptions> = (options: T['options']) => Adapter<T>;
80
144
  /**
81
- * Creates an adapter factory. Call the returned function with optional options to get the adapter instance.
145
+ * Factory for implementing custom adapters that translate non-OpenAPI specs into Kubb's AST.
146
+ *
147
+ * Use this to support GraphQL schemas, gRPC definitions, AsyncAPI, or custom domain-specific languages.
148
+ * Built-in adapters include `@kubb/adapter-oas` for OpenAPI and Swagger documents.
149
+ *
150
+ * @note Adapters must parse their input format to Kubb's `InputNode` structure.
82
151
  *
83
152
  * @example
153
+ * ```ts
84
154
  * export const myAdapter = createAdapter<MyAdapter>((options) => {
85
155
  * return {
86
156
  * name: 'my-adapter',
87
157
  * options,
88
- * async parse(source) { ... },
158
+ * async parse(source) {
159
+ * // Transform source format to InputNode
160
+ * return { ... }
161
+ * },
89
162
  * }
90
163
  * })
91
164
  *
92
- * // instantiate
165
+ * // Instantiate:
93
166
  * const adapter = myAdapter({ validate: true })
167
+ * ```
94
168
  */
95
169
  declare function createAdapter<T extends AdapterFactoryOptions = AdapterFactoryOptions>(build: AdapterBuilder<T>): (options?: T['options']) => Adapter<T>;
96
170
  //#endregion
97
- //#region src/createPlugin.d.ts
98
- /**
99
- * Builder type for a {@link UserPluginWithLifeCycle} — takes options and returns the plugin instance.
100
- */
101
- type PluginBuilder<T extends PluginFactoryOptions = PluginFactoryOptions> = (options: T['options']) => UserPluginWithLifeCycle<T>;
102
- /**
103
- * Creates a plugin factory. Call the returned function with optional options to get the plugin instance.
104
- *
105
- * @example
106
- * export const myPlugin = createPlugin<MyPlugin>((options) => {
107
- * return {
108
- * name: 'my-plugin',
109
- * options,
110
- * resolvePath(baseName) { ... },
111
- * resolveName(name, type) { ... },
112
- * }
113
- * })
114
- *
115
- * // instantiate
116
- * const plugin = myPlugin({ output: { path: 'src/gen' } })
117
- */
118
- declare function createPlugin<T extends PluginFactoryOptions = PluginFactoryOptions>(build: PluginBuilder<T>): (options?: T['options']) => UserPluginWithLifeCycle<T>;
119
- //#endregion
120
171
  //#region src/defineLogger.d.ts
121
172
  /**
122
173
  * Wraps a logger definition into a typed {@link Logger}.
123
174
  *
124
175
  * @example
176
+ * ```ts
125
177
  * export const myLogger = defineLogger({
126
178
  * name: 'my-logger',
127
179
  * install(context, options) {
128
- * context.on('info', (message) => console.log('ℹ', message))
129
- * context.on('error', (error) => console.error('✗', error.message))
180
+ * context.on('kubb:info', (message) => console.log('ℹ', message))
181
+ * context.on('kubb:error', (error) => console.error('✗', error.message))
130
182
  * },
131
183
  * })
184
+ * ```
132
185
  */
133
186
  declare function defineLogger<Options extends LoggerOptions = LoggerOptions>(logger: UserLogger<Options>): Logger<Options>;
134
187
  //#endregion
135
188
  //#region src/defineResolver.d.ts
136
189
  /**
137
190
  * Builder type for the plugin-specific resolver fields.
138
- * `default` and `resolveOptions` are optional — built-in fallbacks are used when omitted.
191
+ *
192
+ * `default`, `resolveOptions`, `resolvePath`, `resolveFile`, `resolveBanner`, and `resolveFooter`
193
+ * are optional — built-in fallbacks are injected when omitted.
194
+ *
195
+ * The builder receives `ctx` — a reference to the fully assembled resolver — so methods can
196
+ * call sibling resolver methods without using `this`. Because `ctx` is captured by the closure
197
+ * and the resolver is populated after the builder runs, `ctx` correctly reflects any overrides
198
+ * that were applied by the builder itself.
139
199
  */
140
- type ResolverBuilder<T extends PluginFactoryOptions> = () => Omit<T['resolver'], 'default' | 'resolveOptions'> & Partial<Pick<T['resolver'], 'default' | 'resolveOptions'>> & ThisType<T['resolver']>;
200
+ type ResolverBuilder<T extends PluginFactoryOptions> = (ctx: T['resolver']) => Omit<T['resolver'], 'default' | 'resolveOptions' | 'resolvePath' | 'resolveFile' | 'resolveBanner' | 'resolveFooter' | 'name' | 'pluginName'> & Partial<Pick<T['resolver'], 'default' | 'resolveOptions' | 'resolvePath' | 'resolveFile' | 'resolveBanner' | 'resolveFooter'>> & {
201
+ name: string;
202
+ pluginName: T['name'];
203
+ };
141
204
  /**
142
- * Default option resolver — applies include/exclude filters and merges any matching override options.
143
- * Returns `null` when the node is filtered out.
205
+ * Default option resolver — applies include/exclude filters and merges matching override options.
206
+ *
207
+ * Returns `null` when the node is filtered out by an `exclude` rule or not matched by any `include` rule.
208
+ *
209
+ * @example Include/exclude filtering
210
+ * ```ts
211
+ * const options = defaultResolveOptions(operationNode, {
212
+ * options: { output: 'types' },
213
+ * exclude: [{ type: 'tag', pattern: 'internal' }],
214
+ * })
215
+ * // → null when node has tag 'internal'
216
+ * ```
217
+ *
218
+ * @example Override merging
219
+ * ```ts
220
+ * const options = defaultResolveOptions(operationNode, {
221
+ * options: { enumType: 'asConst' },
222
+ * override: [{ type: 'operationId', pattern: 'listPets', options: { enumType: 'enum' } }],
223
+ * })
224
+ * // → { enumType: 'enum' } when operationId matches
225
+ * ```
144
226
  */
145
- declare function defaultResolveOptions<TOptions>(node: Node, {
146
- options,
147
- exclude,
148
- include,
149
- override
150
- }: ResolveOptionsContext<TOptions>): TOptions | null;
151
227
  /**
152
- * Defines a resolver for a plugin, with built-in defaults for name casing and include/exclude/override filtering.
153
- * Override `default` or `resolveOptions` in the builder to customize the behavior.
228
+ * Defines a resolver for a plugin, injecting built-in defaults for name casing,
229
+ * include/exclude/override filtering, path resolution, and file construction.
154
230
  *
155
- * @example
156
- * export const resolver = defineResolver<PluginTs>(() => ({
157
- * resolveName(name) {
158
- * return this.default(name, 'function')
231
+ * All four defaults can be overridden by providing them in the builder function:
232
+ * - `default` name casing strategy (camelCase / PascalCase)
233
+ * - `resolveOptions` — include/exclude/override filtering
234
+ * - `resolvePath` — output path computation
235
+ * - `resolveFile` — full `FileNode` construction
236
+ *
237
+ * The builder receives `ctx` — a reference to the assembled resolver — so methods can
238
+ * call sibling resolver methods using `ctx` instead of `this`.
239
+ *
240
+ * @example Basic resolver with naming helpers
241
+ * ```ts
242
+ * export const resolver = defineResolver<PluginTs>((ctx) => ({
243
+ * name: 'default',
244
+ * resolveName(node) {
245
+ * return ctx.default(node.name, 'function')
159
246
  * },
160
- * resolveTypedName(name) {
161
- * return this.default(name, 'type')
247
+ * resolveTypedName(node) {
248
+ * return ctx.default(node.name, 'type')
249
+ * },
250
+ * }))
251
+ * ```
252
+ *
253
+ * @example Override resolvePath for a custom output structure
254
+ * ```ts
255
+ * export const resolver = defineResolver<PluginTs>((_ctx) => ({
256
+ * name: 'custom',
257
+ * resolvePath({ baseName }, { root, output }) {
258
+ * return path.resolve(root, output.path, 'generated', baseName)
162
259
  * },
260
+ * }))
261
+ * ```
262
+ *
263
+ * @example Use ctx.default inside a helper
264
+ * ```ts
265
+ * export const resolver = defineResolver<PluginTs>((ctx) => ({
266
+ * name: 'default',
163
267
  * resolveParamName(node, param) {
164
- * return this.resolveName(`${node.operationId} ${param.in} ${param.name}`)
268
+ * return ctx.default(`${node.operationId} ${param.in} ${param.name}`, 'type')
165
269
  * },
166
270
  * }))
271
+ * ```
167
272
  */
168
273
  declare function defineResolver<T extends PluginFactoryOptions>(build: ResolverBuilder<T>): T['resolver'];
169
274
  //#endregion
275
+ //#region src/FileProcessor.d.ts
276
+ type ParseOptions = {
277
+ parsers?: Map<FileNode['extname'], Parser>;
278
+ extension?: Record<FileNode['extname'], FileNode['extname'] | ''>;
279
+ };
280
+ type RunOptions = ParseOptions & {
281
+ /**
282
+ * @default 'sequential'
283
+ */
284
+ mode?: 'sequential' | 'parallel';
285
+ onStart?: (files: Array<FileNode>) => Promise<void> | void;
286
+ onEnd?: (files: Array<FileNode>) => Promise<void> | void;
287
+ onUpdate?: (params: {
288
+ file: FileNode;
289
+ source?: string;
290
+ processed: number;
291
+ total: number;
292
+ percentage: number;
293
+ }) => Promise<void> | void;
294
+ };
295
+ /**
296
+ * Converts a single file to a string using the registered parsers.
297
+ * Falls back to joining source values when no matching parser is found.
298
+ *
299
+ * @internal
300
+ */
301
+ declare class FileProcessor {
302
+ #private;
303
+ parse(file: FileNode, {
304
+ parsers,
305
+ extension
306
+ }?: ParseOptions): Promise<string>;
307
+ run(files: Array<FileNode>, {
308
+ parsers,
309
+ mode,
310
+ extension,
311
+ onStart,
312
+ onEnd,
313
+ onUpdate
314
+ }?: RunOptions): Promise<Array<FileNode>>;
315
+ }
316
+ //#endregion
170
317
  //#region src/storages/fsStorage.d.ts
171
318
  /**
172
319
  * Built-in filesystem storage driver.
173
320
  *
174
- * This is the default storage when no `storage` option is configured in `output`.
321
+ * This is the default storage when no `storage` option is configured in the root config.
175
322
  * Keys are resolved against `process.cwd()`, so root-relative paths such as
176
323
  * `src/gen/api/getPets.ts` are written to the correct location without extra configuration.
177
324
  *
@@ -183,11 +330,13 @@ declare function defineResolver<T extends PluginFactoryOptions>(build: ResolverB
183
330
  *
184
331
  * @example
185
332
  * ```ts
186
- * import { defineConfig, fsStorage } from '@kubb/core'
333
+ * import { fsStorage } from '@kubb/core'
334
+ * import { defineConfig } from 'kubb'
187
335
  *
188
336
  * export default defineConfig({
189
337
  * input: { path: './petStore.yaml' },
190
- * output: { path: './src/gen', storage: fsStorage() },
338
+ * output: { path: './src/gen' },
339
+ * storage: fsStorage(),
191
340
  * })
192
341
  * ```
193
342
  */
@@ -203,127 +352,24 @@ declare const fsStorage: (options?: Record<string, never> | undefined) => Storag
203
352
  *
204
353
  * @example
205
354
  * ```ts
206
- * import { defineConfig, memoryStorage } from '@kubb/core'
355
+ * import { memoryStorage } from '@kubb/core'
356
+ * import { defineConfig } from 'kubb'
207
357
  *
208
358
  * export default defineConfig({
209
359
  * input: { path: './petStore.yaml' },
210
- * output: { path: './src/gen', storage: memoryStorage() },
360
+ * output: { path: './src/gen' },
361
+ * storage: memoryStorage(),
211
362
  * })
212
363
  * ```
213
364
  */
214
365
  declare const memoryStorage: (options?: Record<string, never> | undefined) => Storage;
215
366
  //#endregion
216
- //#region src/utils/FunctionParams.d.ts
217
- type FunctionParamsASTWithoutType = {
218
- name?: string;
219
- type?: string;
220
- /**
221
- * @default true
222
- */
223
- required?: boolean;
224
- /**
225
- * @default true
226
- */
227
- enabled?: boolean;
228
- default?: string;
229
- };
230
- type FunctionParamsASTWithType = {
231
- name?: never;
232
- type: string;
233
- /**
234
- * @default true
235
- */
236
- required?: boolean;
237
- /**
238
- * @default true
239
- */
240
- enabled?: boolean;
241
- default?: string;
242
- };
243
- /**
244
- * @deprecated
245
- */
246
- type FunctionParamsAST = FunctionParamsASTWithoutType | FunctionParamsASTWithType;
367
+ //#region src/utils/isInputPath.d.ts
247
368
  /**
248
- * @deprecated
249
- */
250
- declare class FunctionParams {
251
- #private;
252
- get items(): FunctionParamsAST[];
253
- add(item: FunctionParamsAST | Array<FunctionParamsAST | FunctionParamsAST[] | undefined> | undefined): FunctionParams;
254
- static toObject(items: FunctionParamsAST[]): FunctionParamsAST;
255
- toObject(): FunctionParamsAST;
256
- static toString(items: (FunctionParamsAST | FunctionParamsAST[])[]): string;
257
- toString(): string;
258
- }
259
- //#endregion
260
- //#region src/utils/formatters.d.ts
261
- type Formatter = keyof typeof formatters;
262
- /**
263
- * Detect which formatter is available in the system.
264
- *
265
- * @returns Promise that resolves to the first available formatter or undefined if none are found
266
- *
267
- * @remarks
268
- * Checks in order of preference: biome, oxfmt, prettier.
269
- * Uses the `--version` flag to detect if each formatter command is available.
270
- * This is a reliable method as all supported formatters implement this flag.
271
- *
272
- * @example
273
- * ```typescript
274
- * const formatter = await detectFormatter()
275
- * if (formatter) {
276
- * console.log(`Using ${formatter} for formatting`)
277
- * } else {
278
- * console.log('No formatter found')
279
- * }
280
- * ```
281
- */
282
- declare function detectFormatter(): Promise<Formatter | undefined>;
283
- //#endregion
284
- //#region src/utils/getBarrelFiles.d.ts
285
- type FileMetaBase = {
286
- pluginName?: string;
287
- };
288
- type AddIndexesProps = {
289
- type: BarrelType | false | undefined;
290
- /**
291
- * Root based on root and output.path specified in the config
292
- */
293
- root: string;
294
- /**
295
- * Output for plugin
296
- */
297
- output: {
298
- path: string;
299
- };
300
- group?: {
301
- output: string;
302
- exportAs: string;
303
- };
304
- meta?: FileMetaBase;
305
- };
306
- declare function getBarrelFiles(files: Array<KubbFile.ResolvedFile>, {
307
- type,
308
- meta,
309
- root,
310
- output
311
- }: AddIndexesProps): Promise<Array<KubbFile.File>>;
312
- //#endregion
313
- //#region src/utils/getConfigs.d.ts
314
- /**
315
- * Converting UserConfig to Config Array without a change in the object beside the JSON convert.
369
+ * Type guard to check if a given config has an `input.path`.
316
370
  */
317
- declare function getConfigs(config: ConfigInput | UserConfig, args: CLIOptions): Promise<Array<Config>>;
318
- //#endregion
319
- //#region src/utils/linters.d.ts
320
- type Linter = keyof typeof linters;
321
- declare function detectLinter(): Promise<Linter | undefined>;
322
- //#endregion
323
- //#region src/utils/packageJSON.d.ts
324
- type DependencyName = string;
325
- type DependencyVersion = string;
326
- declare function satisfiesDependency(dependency: DependencyName | RegExp, version: DependencyVersion, cwd?: string): boolean;
371
+ declare function isInputPath(config: UserConfig | undefined): config is UserConfig<InputPath>;
372
+ declare function isInputPath(config: Config | undefined): config is Config<InputPath>;
327
373
  //#endregion
328
- export { Adapter, AdapterFactoryOptions, AdapterSource, BarrelType, type CLIOptions, Config, type ConfigInput, CoreGeneratorV2, DevtoolsOptions, type FileMetaBase, FunctionParams, type FunctionParamsAST, Generator, Group, InputData, InputPath, KubbEvents, Logger, LoggerContext, LoggerOptions, Output, Plugin, PluginContext, PluginDriver, PluginFactoryOptions, PluginLifecycle, PluginLifecycleHooks, PluginParameter, PluginWithLifeCycle, Printer, PrinterFactoryOptions, ReactGeneratorV2, ResolveNameParams, ResolveOptionsContext, ResolvePathParams, Resolver, Storage, UserConfig, UserLogger, UserPlugin, UserPluginWithLifeCycle, UserResolver, build, build as default, createAdapter, createPlugin, createStorage, defaultResolveOptions, defineConfig, defineGenerator, defineLogger, definePrinter, defineResolver, detectFormatter, detectLinter, formatters, fsStorage, getBarrelFiles, getConfigs, getMode, isInputPath, linters, logLevel, memoryStorage, safeBuild, satisfiesDependency, setup };
374
+ export { Adapter, AdapterFactoryOptions, AdapterSource, AsyncEventEmitter, BuildOutput, CLIOptions, Config, DevtoolsOptions, Exclude, FileManager, FileProcessor, Generator, GeneratorContext, Group, Include, InputData, InputPath, Kubb, KubbBuildEndContext, KubbBuildStartContext, KubbConfigEndContext, KubbDebugContext, KubbErrorContext, KubbFileProcessingUpdateContext, KubbFilesProcessingEndContext, KubbFilesProcessingStartContext, KubbGenerationEndContext, KubbGenerationStartContext, KubbGenerationSummaryContext, KubbHookEndContext, KubbHookStartContext, KubbHooks, KubbInfoContext, KubbLifecycleStartContext, KubbPluginEndContext, KubbPluginSetupContext, KubbPluginStartContext, KubbPluginsEndContext, KubbSuccessContext, KubbVersionNewContext, KubbWarnContext, Logger, LoggerContext, LoggerOptions, Middleware, NormalizedPlugin, Output, Override, Parser, Plugin, PluginDriver, PluginFactoryOptions, PossibleConfig, Renderer, RendererFactory, ResolveBannerContext, ResolveNameParams, ResolveOptionsContext, Resolver, ResolverContext, ResolverFileParams, ResolverPathParams, Storage, URLPath, UserConfig, UserLogger, ast, createAdapter, createKubb, createRenderer, createStorage, defineGenerator, defineLogger, defineMiddleware, defineParser, definePlugin, defineResolver, fsStorage, isInputPath, logLevel, memoryStorage };
329
375
  //# sourceMappingURL=index.d.ts.map