@kubb/core 5.0.0-alpha.4 → 5.0.0-alpha.41

package/src/mocks.ts

@@ -0,0 +1,234 @@
+import { resolve } from 'node:path'
+import type { FileNode, OperationNode, SchemaNode, Visitor } from '@kubb/ast'
+import { transform } from '@kubb/ast'
+import { FileManager } from './FileManager.ts'
+import { PluginDriver } from './PluginDriver.ts'
+import { applyHookResult } from './renderNode.ts'
+import type {
+  Adapter,
+  AdapterFactoryOptions,
+  Config,
+  Generator,
+  GeneratorContext,
+  Plugin,
+  PluginFactoryOptions,
+  ResolveNameParams,
+  ResolvePathParams,
+} from './types.ts'
+
+function toCamelOrPascal(text: string, pascal: boolean): string {
+  const normalized = text
+    .trim()
+    .replace(/([a-z\d])([A-Z])/g, '$1 $2')
+    .replace(/([A-Z]+)([A-Z][a-z])/g, '$1 $2')
+    .replace(/(\d)([a-z])/g, '$1 $2')
+
+  const words = normalized.split(/[\s\-_./\\:]+/).filter(Boolean)
+
+  return words
+    .map((word, i) => {
+      const allUpper = word.length > 1 && word === word.toUpperCase()
+      if (allUpper) return word
+      if (i === 0 && !pascal) return word.charAt(0).toLowerCase() + word.slice(1)
+      return word.charAt(0).toUpperCase() + word.slice(1)
+    })
+    .join('')
+    .replace(/[^a-zA-Z0-9]/g, '')
+}
+
+function camelCase(text: string): string {
+  return toCamelOrPascal(text, false)
+}
+
+function pascalCase(text: string): string {
+  return toCamelOrPascal(text, true)
+}
+
+/**
+ * Creates a minimal `PluginDriver` mock suitable for unit tests.
+ */
+export function createMockedPluginDriver(options: { name?: string; plugin?: Plugin; config?: Config } = {}): PluginDriver {
+  return {
+    resolveName: (result: ResolveNameParams) => {
+      if (result.type === 'file') {
+        return camelCase(options?.name || result.name)
+      }
+
+      if (result.type === 'type') {
+        return pascalCase(result.name)
+      }
+
+      if (result.type === 'function') {
+        return camelCase(result.name)
+      }
+
+      return camelCase(result.name)
+    },
+    config: options?.config ?? {
+      root: '.',
+      output: {
+        path: './path',
+      },
+    },
+    resolvePath: ({ baseName }: ResolvePathParams) => baseName,
+    getFile: ({
+      name,
+      extname,
+      pluginName,
+      options: fileOptions,
+    }: {
+      name: string
+      extname: `.${string}`
+      pluginName: string
+      options?: { group?: { tag?: string; path?: string } }
+    }) => {
+      const baseName = `${name}${extname}`
+      const groupDir = fileOptions?.group?.tag ?? fileOptions?.group?.path?.split('/').filter(Boolean)[0]
+      const filePath = groupDir ? `${groupDir}/${baseName}` : baseName
+
+      return {
+        path: filePath,
+        baseName,
+        meta: { pluginName },
+      }
+    },
+    getPlugin(_pluginName: Plugin['name']): Plugin | undefined {
+      return options?.plugin
+    },
+    fileManager: new FileManager(),
+  } as unknown as PluginDriver
+}
+
+/**
+ * Creates a minimal `Adapter` mock suitable for unit tests.
+ *
+ * - `parse` returns an empty `InputNode` by default; override via `options.parse`.
+ * - `getImports` returns `[]` by default (single-file mode, no cross-file imports).
+ */
+export function createMockedAdapter<TOptions extends AdapterFactoryOptions = AdapterFactoryOptions>(
+  options: {
+    name?: TOptions['name']
+    resolvedOptions?: TOptions['resolvedOptions']
+    inputNode?: Adapter<TOptions>['inputNode']
+    parse?: Adapter<TOptions>['parse']
+    getImports?: Adapter<TOptions>['getImports']
+  } = {},
+): Adapter<TOptions> {
+  return {
+    name: (options.name ?? 'oas') as TOptions['name'],
+    options: (options.resolvedOptions ?? {}) as TOptions['resolvedOptions'],
+    inputNode: options.inputNode ?? null,
+    parse: options.parse ?? (async () => ({ kind: 'Input' as const, schemas: [], operations: [] })),
+    getImports: options.getImports ?? ((_node: SchemaNode, _resolve: (schemaName: string) => { name: string; path: string }) => []),
+  } as Adapter<TOptions>
+}
+
+/**
+ * Creates a minimal `Plugin` mock suitable for unit tests.
+ *
+ * @example
+ * const plugin = createMockedPlugin<PluginTs>({ name: '@kubb/plugin-ts', options })
+ */
+export function createMockedPlugin<TOptions extends PluginFactoryOptions = PluginFactoryOptions>(params: {
+  name: TOptions['name']
+  options: TOptions['resolvedOptions']
+  resolver?: TOptions['resolver']
+  transformer?: Visitor
+  dependencies?: Array<string>
+}): Plugin<TOptions> {
+  return {
+    name: params.name,
+    options: params.options,
+    resolver: params.resolver,
+    transformer: params.transformer,
+    dependencies: params.dependencies,
+    install: () => {},
+    inject: () => undefined as TOptions['context'],
+  } as unknown as Plugin<TOptions>
+}
+
+type RenderGeneratorOptions<TOptions extends PluginFactoryOptions> = {
+  config: Config
+  adapter: Adapter
+  driver: PluginDriver
+  plugin: Plugin<TOptions>
+  options: TOptions['resolvedOptions']
+  resolver: TOptions['resolver']
+}
+
+function createMockedPluginContext<TOptions extends PluginFactoryOptions>(opts: RenderGeneratorOptions<TOptions>): Omit<GeneratorContext<TOptions>, 'options'> {
+  const root = resolve(opts.config.root, opts.config.output.path)
+
+  return {
+    config: opts.config,
+    root,
+    getMode: (output: { path: string }) => PluginDriver.getMode(resolve(root, output.path)),
+    adapter: opts.adapter,
+    resolver: opts.resolver,
+    plugin: opts.plugin,
+    driver: opts.driver,
+    inputNode: { kind: 'Input', schemas: [], operations: [] },
+    upsertFile: async (...files: Array<FileNode>) => opts.driver.fileManager.upsert(...files),
+    warn: (msg: string) => console.warn(msg),
+    error: (msg: string) => console.error(msg),
+    info: (msg: string) => console.info(msg),
+    openInStudio: async () => {},
+  } as unknown as Omit<GeneratorContext<TOptions>, 'options'>
+}
+
+/**
+ * Renders a generator's `schema` method in a test context.
+ *
+ * @example
+ * await renderGeneratorSchema(typeGenerator, node, { config, adapter, driver, plugin, options, resolver })
+ * await matchFiles(driver.fileManager.files)
+ */
+export async function renderGeneratorSchema<TOptions extends PluginFactoryOptions>(
+  generator: Generator<TOptions>,
+  node: SchemaNode,
+  opts: RenderGeneratorOptions<TOptions>,
+): Promise<void> {
+  if (!generator.schema) return
+  const context = createMockedPluginContext(opts)
+  const transformedNode = opts.plugin.transformer ? transform(node, opts.plugin.transformer) : node
+  const result = await generator.schema(transformedNode, { ...context, options: opts.options })
+  await applyHookResult(result, opts.driver, generator.renderer ?? undefined)
+}
+
+/**
+ * Renders a generator's `operation` method in a test context.
+ *
+ * @example
+ * await renderGeneratorOperation(typeGenerator, node, { config, adapter, driver, plugin, options, resolver })
+ * await matchFiles(driver.fileManager.files)
+ */
+export async function renderGeneratorOperation<TOptions extends PluginFactoryOptions>(
+  generator: Generator<TOptions>,
+  node: OperationNode,
+  opts: RenderGeneratorOptions<TOptions>,
+): Promise<void> {
+  if (!generator.operation) return
+  const context = createMockedPluginContext(opts)
+  const transformedNode = opts.plugin.transformer ? transform(node, opts.plugin.transformer) : node
+  const result = await generator.operation(transformedNode, { ...context, options: opts.options })
+  await applyHookResult(result, opts.driver, generator.renderer ?? undefined)
+}
+
+/**
+ * Renders a generator's `operations` method in a test context.
+ *
+ * @example
+ * await renderGeneratorOperations(classClientGenerator, nodes, { config, adapter, driver, plugin, options, resolver })
+ * await matchFiles(driver.fileManager.files)
+ */
+export async function renderGeneratorOperations<TOptions extends PluginFactoryOptions>(
+  generator: Generator<TOptions>,
+  nodes: Array<OperationNode>,
+  opts: RenderGeneratorOptions<TOptions>,
+): Promise<void> {
+  if (!generator.operations) return
+  const context = createMockedPluginContext(opts)
+  const transformedNodes = opts.plugin.transformer ? nodes.map((n) => transform(n, opts.plugin.transformer!)) : nodes
+  const result = await generator.operations(transformedNodes, { ...context, options: opts.options })
+  await applyHookResult(result, opts.driver, generator.renderer ?? undefined)
+}

package/src/renderNode.ts

@@ -0,0 +1,35 @@
+import type { FileNode } from '@kubb/ast'
+import type { RendererFactory } from './createRenderer.ts'
+import type { PluginDriver } from './PluginDriver.ts'
+
+/**
+ * Handles the return value of a plugin AST hook or generator method.
+ *
+ * - Renderer output → rendered via the provided `rendererFactory` (e.g. JSX), files stored in `driver.fileManager`
+ * - `Array<FileNode>` → added directly into `driver.fileManager`
+ * - `void` / `null` / `undefined` → no-op (plugin handled it via `this.upsertFile`)
+ *
+ * Pass a `rendererFactory` (e.g. `jsxRenderer` from `@kubb/renderer-jsx`) when the result
+ * may be a renderer element. Generators that only return `Array<FileNode>` do not need one.
+ */
+export async function applyHookResult<TElement = unknown>(
+  result: TElement | Array<FileNode> | void,
+  driver: PluginDriver,
+  rendererFactory?: RendererFactory<TElement>,
+): Promise<void> {
+  if (!result) return
+
+  if (Array.isArray(result)) {
+    driver.fileManager.upsert(...(result as Array<FileNode>))
+    return
+  }
+
+  if (!rendererFactory) {
+    return
+  }
+
+  const renderer = rendererFactory()
+  await renderer.render(result)
+  driver.fileManager.upsert(...renderer.files)
+  renderer.unmount()
+}

package/src/storages/fsStorage.ts

@@ -2,7 +2,14 @@ import type { Dirent } from 'node:fs'
 import { access, readdir, readFile, rm } from 'node:fs/promises'
 import { join, resolve } from 'node:path'
 import { clean, write } from '@internals/utils'
-import { defineStorage } from '../defineStorage.ts'
+import { createStorage } from '../createStorage.ts'
+
+/**
+ * Detects the filesystem error used to indicate that a path does not exist.
+ */
+function isMissingPathError(error: unknown): error is NodeJS.ErrnoException {
+  return typeof error === 'object' && error !== null && 'code' in error && (error as NodeJS.ErrnoException).code === 'ENOENT'
+}
 
 /**
  * Built-in filesystem storage driver.
@@ -27,21 +34,29 @@ import { defineStorage } from '../defineStorage.ts'
  * })
  * ```
  */
-export const fsStorage = defineStorage(() => ({
+export const fsStorage = createStorage(() => ({
   name: 'fs',
   async hasItem(key: string) {
     try {
       await access(resolve(key))
       return true
-    } catch {
-      return false
+    } catch (error) {
+      if (isMissingPathError(error)) {
+        return false
+      }
+
+      throw new Error(`Failed to access storage item "${key}"`, { cause: error as Error })
     }
   },
   async getItem(key: string) {
     try {
       return await readFile(resolve(key), 'utf8')
-    } catch {
-      return null
+    } catch (error) {
+      if (isMissingPathError(error)) {
+        return null
+      }
+
+      throw new Error(`Failed to read storage item "${key}"`, { cause: error as Error })
     }
   },
   async setItem(key: string, value: string) {
@@ -52,13 +67,18 @@ export const fsStorage = defineStorage(() => ({
   },
   async getKeys(base?: string) {
     const keys: Array<string> = []
+    const resolvedBase = resolve(base ?? process.cwd())
 
     async function walk(dir: string, prefix: string): Promise<void> {
       let entries: Array<Dirent>
       try {
         entries = (await readdir(dir, { withFileTypes: true })) as Array<Dirent>
-      } catch {
-        return
+      } catch (error) {
+        if (isMissingPathError(error)) {
+          return
+        }
+
+        throw new Error(`Failed to list storage keys under "${resolvedBase}"`, { cause: error as Error })
       }
       for (const entry of entries) {
         const rel = prefix ? `${prefix}/${entry.name}` : entry.name
@@ -70,7 +90,7 @@ export const fsStorage = defineStorage(() => ({
       }
     }
 
-    await walk(resolve(base ?? process.cwd()), '')
+    await walk(resolvedBase, '')
 
     return keys
   },

package/src/storages/memoryStorage.ts

@@ -1,4 +1,4 @@
-import { defineStorage } from '../defineStorage.ts'
+import { createStorage } from '../createStorage.ts'
 
 /**
  * In-memory storage driver. Useful for testing and dry-run scenarios where
@@ -17,7 +17,7 @@ import { defineStorage } from '../defineStorage.ts'
  * })
  * ```
  */
-export const memoryStorage = defineStorage(() => {
+export const memoryStorage = createStorage(() => {
   const store = new Map<string, string>()
 
   return {