@kubb/core 5.0.0-alpha.6 → 5.0.0-alpha.61

package/src/defineResolver.ts

@@ -0,0 +1,521 @@
+import path from 'node:path'
+import { camelCase, pascalCase } from '@internals/utils'
+import type { FileNode, InputNode, Node, OperationNode, SchemaNode } from '@kubb/ast'
+import { createFile, isOperationNode, isSchemaNode } from '@kubb/ast'
+import { PluginDriver } from './PluginDriver.ts'
+import type {
+  Config,
+  PluginFactoryOptions,
+  ResolveBannerContext,
+  ResolveOptionsContext,
+  Resolver,
+  ResolverContext,
+  ResolverFileParams,
+  ResolverPathParams,
+} from './types.ts'
+
+/**
+ * Builder type for the plugin-specific resolver fields.
+ *
+ * `default`, `resolveOptions`, `resolvePath`, `resolveFile`, `resolveBanner`, and `resolveFooter`
+ * are optional — built-in fallbacks are injected when omitted.
+ *
+ * The builder receives `ctx` — a reference to the fully assembled resolver — so methods can
+ * call sibling resolver methods without using `this`.  Because `ctx` is captured by the closure
+ * and the resolver is populated after the builder runs, `ctx` correctly reflects any overrides
+ * that were applied by the builder itself.
+ */
+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'>> & {
+    name: string
+    pluginName: T['name']
+  }
+
+// String patterns are compiled lazily and cached — the same filter is reused for every node.
+const stringPatternCache = new Map<string, RegExp>()
+
+function testPattern(value: string, pattern: string | RegExp): boolean {
+  if (typeof pattern === 'string') {
+    let regex = stringPatternCache.get(pattern)
+    if (!regex) {
+      regex = new RegExp(pattern)
+      stringPatternCache.set(pattern, regex)
+    }
+    return regex.test(value)
+  }
+  // Use .match() for user-supplied RegExp to preserve semantics regardless of `g`/`y` flags.
+  return value.match(pattern) !== null
+}
+
+/**
+ * Checks if an operation matches a pattern for a given filter type (`tag`, `operationId`, `path`, `method`).
+ */
+function matchesOperationPattern(node: OperationNode, type: string, pattern: string | RegExp): boolean {
+  switch (type) {
+    case 'tag':
+      return node.tags.some((tag) => testPattern(tag, pattern))
+    case 'operationId':
+      return testPattern(node.operationId, pattern)
+    case 'path':
+      return testPattern(node.path, pattern)
+    case 'method':
+      return testPattern(node.method.toLowerCase(), pattern)
+    case 'contentType':
+      return node.requestBody?.content?.some((c) => testPattern(c.contentType, pattern)) ?? false
+    default:
+      return false
+  }
+}
+
+/**
+ * Checks if a schema matches a pattern for a given filter type (`schemaName`).
+ *
+ * Returns `null` when the filter type doesn't apply to schemas.
+ */
+function matchesSchemaPattern(node: SchemaNode, type: string, pattern: string | RegExp): boolean | null {
+  switch (type) {
+    case 'schemaName':
+      return node.name ? testPattern(node.name, pattern) : false
+    default:
+      return null
+  }
+}
+
+/**
+ * Default name resolver used by `defineResolver`.
+ *
+ * - `camelCase` for `function` and `file` types.
+ * - `PascalCase` for `type`.
+ * - `camelCase` for everything else.
+ */
+function defaultResolver(name: string, type?: 'file' | 'function' | 'type' | 'const'): string {
+  let resolvedName = camelCase(name)
+
+  if (type === 'file' || type === 'function') {
+    resolvedName = camelCase(name, {
+      isFile: type === 'file',
+    })
+  }
+
+  if (type === 'type') {
+    resolvedName = pascalCase(name)
+  }
+
+  return resolvedName
+}
+
+/**
+ * Default option resolver — applies include/exclude filters and merges matching override options.
+ *
+ * Returns `null` when the node is filtered out by an `exclude` rule or not matched by any `include` rule.
+ *
+ * @example Include/exclude filtering
+ * ```ts
+ * const options = defaultResolveOptions(operationNode, {
+ *   options: { output: 'types' },
+ *   exclude: [{ type: 'tag', pattern: 'internal' }],
+ * })
+ * // → null when node has tag 'internal'
+ * ```
+ *
+ * @example Override merging
+ * ```ts
+ * const options = defaultResolveOptions(operationNode, {
+ *   options: { enumType: 'asConst' },
+ *   override: [{ type: 'operationId', pattern: 'listPets', options: { enumType: 'enum' } }],
+ * })
+ * // → { enumType: 'enum' } when operationId matches
+ * ```
+ */
+export function defaultResolveOptions<TOptions>(
+  node: Node,
+  { options, exclude = [], include, override = [] }: ResolveOptionsContext<TOptions>,
+): TOptions | null {
+  if (isOperationNode(node)) {
+    const isExcluded = exclude.some(({ type, pattern }) => matchesOperationPattern(node, type, pattern))
+    if (isExcluded) {
+      return null
+    }
+
+    if (include && !include.some(({ type, pattern }) => matchesOperationPattern(node, type, pattern))) {
+      return null
+    }
+
+    const overrideOptions = override.find(({ type, pattern }) => matchesOperationPattern(node, type, pattern))?.options
+
+    return { ...options, ...overrideOptions }
+  }
+
+  if (isSchemaNode(node)) {
+    if (exclude.some(({ type, pattern }) => matchesSchemaPattern(node, type, pattern) === true)) {
+      return null
+    }
+
+    if (include) {
+      const results = include.map(({ type, pattern }) => matchesSchemaPattern(node, type, pattern))
+      const applicable = results.filter((r) => r !== null)
+      if (applicable.length > 0 && !applicable.includes(true)) {
+        return null
+      }
+    }
+
+    const overrideOptions = override.find(({ type, pattern }) => matchesSchemaPattern(node, type, pattern) === true)?.options
+
+    return { ...options, ...overrideOptions }
+  }
+
+  return options
+}
+
+/**
+ * Default path resolver used by `defineResolver`.
+ *
+ * - Returns the output directory in `single` mode.
+ * - Resolves into a tag- or path-based subdirectory when `group` and a `tag`/`path` value are provided.
+ * - Falls back to a flat `output/baseName` path otherwise.
+ *
+ * A custom `group.name` function overrides the default subdirectory naming.
+ * For `tag` groups the default is `${camelCase(tag)}Controller`.
+ * For `path` groups the default is the first path segment after `/`.
+ *
+ * @example Flat output
+ * ```ts
+ * defaultResolvePath({ baseName: 'petTypes.ts' }, { root: '/src', output: { path: 'types' } })
+ * // → '/src/types/petTypes.ts'
+ * ```
+ *
+ * @example Tag-based grouping
+ * ```ts
+ * defaultResolvePath(
+ *   { baseName: 'petTypes.ts', tag: 'pets' },
+ *   { root: '/src', output: { path: 'types' }, group: { type: 'tag' } },
+ * )
+ * // → '/src/types/petsController/petTypes.ts'
+ * ```
+ *
+ * @example Path-based grouping
+ * ```ts
+ * defaultResolvePath(
+ *   { baseName: 'petTypes.ts', path: '/pets/list' },
+ *   { root: '/src', output: { path: 'types' }, group: { type: 'path' } },
+ * )
+ * // → '/src/types/pets/petTypes.ts'
+ * ```
+ *
+ * @example Single-file mode
+ * ```ts
+ * defaultResolvePath(
+ *   { baseName: 'petTypes.ts', pathMode: 'single' },
+ *   { root: '/src', output: { path: 'types' } },
+ * )
+ * // → '/src/types'
+ * ```
+ */
+export function defaultResolvePath({ baseName, pathMode, tag, path: groupPath }: ResolverPathParams, { root, output, group }: ResolverContext): string {
+  const mode = pathMode ?? PluginDriver.getMode(path.resolve(root, output.path))
+
+  if (mode === 'single') {
+    return path.resolve(root, output.path)
+  }
+
+  let result: string
+
+  if (group && (groupPath || tag)) {
+    const groupValue = group.type === 'path' ? groupPath! : tag!
+    const defaultName =
+      group.type === 'tag'
+        ? ({ group: g }: { group: string }) => `${camelCase(g)}Controller`
+        : ({ group: g }: { group: string }) => {
+            // Strip traversal components (empty, '.', '..') before taking the first meaningful segment.
+            // When every segment is a traversal component (e.g. '../../') we fall back to '' so the
+            // file is placed directly in the output root — the boundary check below ensures safety.
+            const segment = g.split('/').filter((s) => s !== '' && s !== '.' && s !== '..')[0]
+            return segment ? camelCase(segment) : ''
+          }
+    const resolveName = group.name ?? defaultName
+    result = path.resolve(root, output.path, resolveName({ group: groupValue }), baseName)
+  } else {
+    result = path.resolve(root, output.path, baseName)
+  }
+
+  // Ensure the resolved path stays within the configured output directory.
+  // This prevents path traversal from malicious OpenAPI specs or custom group.name functions.
+  // `result === outputDir` is intentionally permitted: it matches single-file mode paths and
+  // edge cases where baseName resolves to the output directory itself.
+  const outputDir = path.resolve(root, output.path)
+  const outputDirWithSep = outputDir.endsWith(path.sep) ? outputDir : `${outputDir}${path.sep}`
+  if (result !== outputDir && !result.startsWith(outputDirWithSep)) {
+    throw new Error(
+      `[Kubb] Resolved path "${result}" is outside the output directory "${outputDir}". ` +
+        'This may indicate a path traversal attempt in the OpenAPI specification or a misconfigured group.name function.',
+    )
+  }
+
+  return result
+}
+
+/**
+ * Default file resolver used by `defineResolver`.
+ *
+ * Resolves a `FileNode` by combining name resolution (`resolver.default`) with
+ * path resolution (`resolver.resolvePath`). The resolved file always has empty
+ * `sources`, `imports`, and `exports` arrays — consumers populate those separately.
+ *
+ * In `single` mode the name is omitted and the file sits directly in the output directory.
+ *
+ * @example Resolve a schema file
+ * ```ts
+ * const file = defaultResolveFile(
+ *   { name: 'pet', extname: '.ts' },
+ *   { root: '/src', output: { path: 'types' } },
+ *   resolver,
+ * )
+ * // → { baseName: 'pet.ts', path: '/src/types/pet.ts', sources: [], ... }
+ * ```
+ *
+ * @example Resolve an operation file with tag grouping
+ * ```ts
+ * const file = defaultResolveFile(
+ *   { name: 'listPets', extname: '.ts', tag: 'pets' },
+ *   { root: '/src', output: { path: 'types' }, group: { type: 'tag' } },
+ *   resolver,
+ * )
+ * // → { baseName: 'listPets.ts', path: '/src/types/petsController/listPets.ts', ... }
+ * ```
+ */
+export function defaultResolveFile({ name, extname, tag, path: groupPath }: ResolverFileParams, context: ResolverContext, ctx: Resolver): FileNode {
+  const pathMode = PluginDriver.getMode(path.resolve(context.root, context.output.path))
+  const resolvedName = pathMode === 'single' ? '' : ctx.default(name, 'file')
+  const baseName = `${resolvedName}${extname}` as FileNode['baseName']
+  const filePath = ctx.resolvePath({ baseName, pathMode, tag, path: groupPath }, context)
+
+  return createFile({
+    path: filePath,
+    baseName: path.basename(filePath) as `${string}.${string}`,
+    meta: {
+      pluginName: ctx.pluginName,
+    },
+    sources: [],
+    imports: [],
+    exports: [],
+  })
+}
+
+/**
+ * Generates the default "Generated by Kubb" banner from config and optional node metadata.
+ */
+export function buildDefaultBanner({
+  title,
+  description,
+  version,
+  config,
+}: {
+  title?: string
+  description?: string
+  version?: string
+  config: Config
+}): string {
+  try {
+    let source = ''
+    if (Array.isArray(config.input)) {
+      const first = config.input[0]
+      if (first && 'path' in first) {
+        source = path.basename(first.path)
+      }
+    } else if ('path' in config.input) {
+      source = path.basename(config.input.path)
+    } else if ('data' in config.input) {
+      source = 'text content'
+    }
+
+    let banner = '/**\n* Generated by Kubb (https://kubb.dev/).\n* Do not edit manually.\n'
+
+    if (config.output.defaultBanner === 'simple') {
+      banner += '*/\n'
+      return banner
+    }
+
+    if (source) {
+      banner += `* Source: ${source}\n`
+    }
+
+    if (title) {
+      banner += `* Title: ${title}\n`
+    }
+
+    if (description) {
+      const formattedDescription = description.replace(/\n/gm, '\n* ')
+      banner += `* Description: ${formattedDescription}\n`
+    }
+
+    if (version) {
+      banner += `* OpenAPI spec version: ${version}\n`
+    }
+
+    banner += '*/\n'
+    return banner
+  } catch (_error) {
+    return '/**\n* Generated by Kubb (https://kubb.dev/).\n* Do not edit manually.\n*/'
+  }
+}
+
+/**
+ * Default banner resolver — returns the banner string for a generated file.
+ *
+ * A user-supplied `output.banner` overrides the default Kubb "Generated by Kubb" notice.
+ * When no `output.banner` is set, the Kubb notice is used (including `title` and `version`
+ * from the OAS spec when a `node` is provided).
+ *
+ * - When `output.banner` is a function and `node` is provided, returns `output.banner(node)`.
+ * - When `output.banner` is a function and `node` is absent, falls back to the Kubb notice.
+ * - When `output.banner` is a string, returns it directly.
+ * - When `config.output.defaultBanner` is `false`, returns `undefined`.
+ * - Otherwise returns the Kubb "Generated by Kubb" notice.
+ *
+ * @example String banner overrides default
+ * ```ts
+ * defaultResolveBanner(undefined, { output: { banner: '// my banner' }, config })
+ * // → '// my banner'
+ * ```
+ *
+ * @example Function banner with node
+ * ```ts
+ * defaultResolveBanner(inputNode, { output: { banner: (node) => `// v${node.version}` }, config })
+ * // → '// v3.0.0'
+ * ```
+ *
+ * @example No user banner — Kubb notice with OAS metadata
+ * ```ts
+ * defaultResolveBanner(inputNode, { config })
+ * // → '/** Generated by Kubb ... Title: Pet Store ... *\/'
+ * ```
+ *
+ * @example Disabled default banner
+ * ```ts
+ * defaultResolveBanner(undefined, { config: { output: { defaultBanner: false }, ...config } })
+ * // → undefined
+ * ```
+ */
+export function defaultResolveBanner(node: InputNode | undefined, { output, config }: ResolveBannerContext): string | undefined {
+  if (typeof output?.banner === 'function') {
+    return output.banner(node)
+  }
+
+  if (typeof output?.banner === 'string') {
+    return output.banner
+  }
+
+  if (config.output.defaultBanner === false) {
+    return undefined
+  }
+
+  return buildDefaultBanner({
+    title: node?.meta?.title,
+    version: node?.meta?.version,
+    config,
+  })
+}
+
+/**
+ * Default footer resolver — returns the footer string for a generated file.
+ *
+ * - When `output.footer` is a function and `node` is provided, calls it with the node.
+ * - When `output.footer` is a function and `node` is absent, returns `undefined`.
+ * - When `output.footer` is a string, returns it directly.
+ * - Otherwise returns `undefined`.
+ *
+ * @example String footer
+ * ```ts
+ * defaultResolveFooter(undefined, { output: { footer: '// end of file' }, config })
+ * // → '// end of file'
+ * ```
+ *
+ * @example Function footer with node
+ * ```ts
+ * defaultResolveFooter(inputNode, { output: { footer: (node) => `// ${node.title}` }, config })
+ * // → '// Pet Store'
+ * ```
+ */
+export function defaultResolveFooter(node: InputNode | undefined, { output }: ResolveBannerContext): string | undefined {
+  if (typeof output?.footer === 'function') {
+    return node ? output.footer(node) : undefined
+  }
+  if (typeof output?.footer === 'string') {
+    return output.footer
+  }
+  return undefined
+}
+
+/**
+ * Defines a resolver for a plugin, injecting built-in defaults for name casing,
+ * include/exclude/override filtering, path resolution, and file construction.
+ *
+ * All four defaults can be overridden by providing them in the builder function:
+ * - `default` — name casing strategy (camelCase / PascalCase)
+ * - `resolveOptions` — include/exclude/override filtering
+ * - `resolvePath` — output path computation
+ * - `resolveFile` — full `FileNode` construction
+ *
+ * The builder receives `ctx` — a reference to the assembled resolver — so methods can
+ * call sibling resolver methods using `ctx` instead of `this`.
+ *
+ * @example Basic resolver with naming helpers
+ * ```ts
+ * export const resolver = defineResolver<PluginTs>((ctx) => ({
+ *   name: 'default',
+ *   resolveName(node) {
+ *     return ctx.default(node.name, 'function')
+ *   },
+ *   resolveTypedName(node) {
+ *     return ctx.default(node.name, 'type')
+ *   },
+ * }))
+ * ```
+ *
+ * @example Override resolvePath for a custom output structure
+ * ```ts
+ * export const resolver = defineResolver<PluginTs>((_ctx) => ({
+ *   name: 'custom',
+ *   resolvePath({ baseName }, { root, output }) {
+ *     return path.resolve(root, output.path, 'generated', baseName)
+ *   },
+ * }))
+ * ```
+ *
+ * @example Use ctx.default inside a helper
+ * ```ts
+ * export const resolver = defineResolver<PluginTs>((ctx) => ({
+ *   name: 'default',
+ *   resolveParamName(node, param) {
+ *     return ctx.default(`${node.operationId} ${param.in} ${param.name}`, 'type')
+ *   },
+ * }))
+ * ```
+ */
+export function defineResolver<T extends PluginFactoryOptions>(build: ResolverBuilder<T>): T['resolver'] {
+  // Create the resolver shell first.  When `build(resolver)` executes below, `resolver` is
+  // still empty, but methods returned by the builder capture it by reference.  By the time
+  // those methods are actually called, `Object.assign` will have already populated all
+  // properties (including any overrides from the builder itself).
+  const resolver = {} as T['resolver']
+
+  Object.assign(resolver, {
+    default: defaultResolver,
+    resolveOptions: defaultResolveOptions,
+    resolvePath: defaultResolvePath,
+    // Wire the default resolveFile implementation with a wrapper that passes resolver as ctx.
+    // Unlike other defaults which can be assigned directly, defaultResolveFile requires the
+    // resolver as its third parameter.
+    resolveFile: (params: ResolverFileParams, context: ResolverContext) => defaultResolveFile(params, context, resolver as Resolver),
+    resolveBanner: defaultResolveBanner,
+    resolveFooter: defaultResolveFooter,
+    // Builder overrides are applied last.  Any method in the builder can call
+    // ctx.xxx() and will see the fully merged resolver (including its own overrides).
+    ...build(resolver),
+  })
+
+  return resolver
+}

package/src/devtools.ts

@@ -1,10 +1,10 @@
-import type { RootNode } from '@kubb/ast/types'
+import type { InputNode } from '@kubb/ast'
 import { deflateSync, inflateSync } from 'fflate'
 import { x } from 'tinyexec'
 import type { DevtoolsOptions } from './types.ts'
 
 /**
- * Encodes a `RootNode` as a compressed, URL-safe string.
+ * Encodes an `InputNode` as a compressed, URL-safe string.
  *
  * The JSON representation is deflate-compressed with {@link deflateSync} before
  * base64url encoding, which typically reduces payload size by 70–80 % and
@@ -12,41 +12,41 @@ import type { DevtoolsOptions } from './types.ts'
  *
  * Use {@link decodeAst} to reverse.
  */
-export function encodeAst(root: RootNode): string {
-  const compressed = deflateSync(new TextEncoder().encode(JSON.stringify(root)))
+export function encodeAst(input: InputNode): string {
+  const compressed = deflateSync(new TextEncoder().encode(JSON.stringify(input)))
   return Buffer.from(compressed).toString('base64url')
 }
 
 /**
- * Decodes a `RootNode` from a string produced by {@link encodeAst}.
+ * Decodes an `InputNode` from a string produced by {@link encodeAst}.
  *
  * Works in both Node.js and the browser — no streaming APIs required.
  */
-export function decodeAst(encoded: string): RootNode {
+export function decodeAst(encoded: string): InputNode {
   const bytes = Buffer.from(encoded, 'base64url')
-  return JSON.parse(new TextDecoder().decode(inflateSync(bytes))) as RootNode
+  return JSON.parse(new TextDecoder().decode(inflateSync(bytes))) as InputNode
 }
 
 /**
- * Constructs the Kubb Studio URL for the given `RootNode`.
+ * Constructs the Kubb Studio URL for the given `InputNode`.
  * When `options.ast` is `true`, navigates to the AST inspector (`/ast`).
- * The `root` is encoded and attached as the `?root=` query parameter so Studio
+ * The `input` is encoded and attached as the `?root=` query parameter so Studio
  * can decode and render it without a round-trip to any server.
  */
-export function getStudioUrl(root: RootNode, studioUrl: string, options: DevtoolsOptions = {}): string {
+export function getStudioUrl(input: InputNode, studioUrl: string, options: DevtoolsOptions = {}): string {
   const baseUrl = studioUrl.replace(/\/$/, '')
   const path = options.ast ? '/ast' : ''
 
-  return `${baseUrl}${path}?root=${encodeAst(root)}`
+  return `${baseUrl}${path}?root=${encodeAst(input)}`
 }
 
 /**
- * Opens the Kubb Studio URL for the given `RootNode` in the default browser —
+ * Opens the Kubb Studio URL for the given `InputNode` in the default browser —
  *
  * Falls back to printing the URL if the browser cannot be launched.
  */
-export async function openInStudio(root: RootNode, studioUrl: string, options: DevtoolsOptions = {}): Promise<void> {
-  const url = getStudioUrl(root, studioUrl, options)
+export async function openInStudio(input: InputNode, studioUrl: string, options: DevtoolsOptions = {}): Promise<void> {
+  const url = getStudioUrl(input, studioUrl, options)
 
   const cmd = process.platform === 'win32' ? 'cmd' : process.platform === 'darwin' ? 'open' : 'xdg-open'
   const args = process.platform === 'win32' ? ['/c', 'start', '', url] : [url]

package/src/index.ts

@@ -1,24 +1,20 @@
 export { AsyncEventEmitter, URLPath } from '@internals/utils'
-export { definePrinter } from '@kubb/ast'
-export { build, build as default, safeBuild, setup } from './build.ts'
-export { type CLIOptions, type ConfigInput, defineConfig, isInputPath } from './config.ts'
-export { formatters, linters, logLevel } from './constants.ts'
-export { defineAdapter } from './defineAdapter.ts'
+export * as ast from '@kubb/ast'
+export { logLevel } from './constants.ts'
+export { createAdapter } from './createAdapter.ts'
+export { createKubb } from './createKubb.ts'
+export { createRenderer } from './createRenderer.ts'
+export { createStorage } from './createStorage.ts'
 export { defineGenerator } from './defineGenerator.ts'
 export { defineLogger } from './defineLogger.ts'
+export { defineMiddleware } from './defineMiddleware.ts'
+export { defineParser } from './defineParser.ts'
 export { definePlugin } from './definePlugin.ts'
-export { defineStorage } from './defineStorage.ts'
-export { PackageManager } from './PackageManager.ts'
-export { getMode, PluginManager } from './PluginManager.ts'
-export { PromiseManager } from './PromiseManager.ts'
+export { defineResolver } from './defineResolver.ts'
+export { FileManager } from './FileManager.ts'
+export { FileProcessor } from './FileProcessor.ts'
+export { PluginDriver } from './PluginDriver.ts'
 export { fsStorage } from './storages/fsStorage.ts'
 export { memoryStorage } from './storages/memoryStorage.ts'
 export * from './types.ts'
-export type { FunctionParamsAST } from './utils/FunctionParams.ts'
-export { FunctionParams } from './utils/FunctionParams.ts'
-export { detectFormatter } from './utils/formatters.ts'
-export type { FileMetaBase } from './utils/getBarrelFiles.ts'
-export { getBarrelFiles } from './utils/getBarrelFiles.ts'
-export { getConfigs } from './utils/getConfigs.ts'
-export { detectLinter } from './utils/linters.ts'
-export { resolveOptions } from './utils/resolveOptions.ts'
+export { isInputPath } from './utils/isInputPath.ts'