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

package/dist/{types-CiPWLv-5.d.ts → types-Bbh1o0yW.d.ts}

@@ -1,8 +1,9 @@
 import { t as __name } from "./chunk--u3MIqq1.js";
 import { EventEmitter } from "node:events";
 import { Fabric } from "@kubb/react-fabric";
-import { Printer, PrinterFactoryOptions, RootNode, SchemaNode } from "@kubb/ast/types";
+import { OperationNode, Printer, PrinterFactoryOptions, RootNode, SchemaNode } from "@kubb/ast/types";
 import { KubbFile } from "@kubb/fabric-core/types";
+import { FabricReactNode } from "@kubb/react-fabric/types";
 
 //#region ../../internals/utils/dist/index.d.ts
 /**
@@ -530,6 +531,61 @@ interface KubbEvents {
   'plugins:hook:processing:end': [meta: ExecutedMeta];
 }
 //#endregion
+//#region src/defineGenerator.d.ts
+type OperationsV2Props<TPlugin extends PluginFactoryOptions = PluginFactoryOptions> = {
+  config: Config;
+  adapter: Adapter;
+  options: Plugin<TPlugin>['options'];
+  nodes: Array<OperationNode>;
+};
+type OperationV2Props<TPlugin extends PluginFactoryOptions = PluginFactoryOptions> = {
+  config: Config;
+  adapter: Adapter;
+  options: Plugin<TPlugin>['options'];
+  node: OperationNode;
+};
+type SchemaV2Props<TPlugin extends PluginFactoryOptions = PluginFactoryOptions> = {
+  config: Config;
+  adapter: Adapter;
+  options: Plugin<TPlugin>['options'];
+  node: SchemaNode;
+};
+type UserCoreGeneratorV2<TPlugin extends PluginFactoryOptions> = {
+  name: string;
+  type: 'core';
+  version?: '2';
+  operations?(props: OperationsV2Props<TPlugin>): Promise<Array<KubbFile.File>>;
+  operation?(props: OperationV2Props<TPlugin>): Promise<Array<KubbFile.File>>;
+  schema?(props: SchemaV2Props<TPlugin>): Promise<Array<KubbFile.File>>;
+};
+type UserReactGeneratorV2<TPlugin extends PluginFactoryOptions> = {
+  name: string;
+  type: 'react';
+  version?: '2';
+  Operations?(props: OperationsV2Props<TPlugin>): FabricReactNode;
+  Operation?(props: OperationV2Props<TPlugin>): FabricReactNode;
+  Schema?(props: SchemaV2Props<TPlugin>): FabricReactNode;
+};
+type CoreGeneratorV2<TPlugin extends PluginFactoryOptions = PluginFactoryOptions> = {
+  name: string;
+  type: 'core';
+  version: '2';
+  operations(props: OperationsV2Props<TPlugin>): Promise<Array<KubbFile.File>>;
+  operation(props: OperationV2Props<TPlugin>): Promise<Array<KubbFile.File>>;
+  schema(props: SchemaV2Props<TPlugin>): Promise<Array<KubbFile.File>>;
+};
+type ReactGeneratorV2<TPlugin extends PluginFactoryOptions = PluginFactoryOptions> = {
+  name: string;
+  type: 'react';
+  version: '2';
+  Operations(props: OperationsV2Props<TPlugin>): FabricReactNode;
+  Operation(props: OperationV2Props<TPlugin>): FabricReactNode;
+  Schema(props: SchemaV2Props<TPlugin>): FabricReactNode;
+};
+type Generator<TPlugin extends PluginFactoryOptions = PluginFactoryOptions> = UserCoreGeneratorV2<TPlugin> | UserReactGeneratorV2<TPlugin>;
+declare function defineGenerator<TPlugin extends PluginFactoryOptions = PluginFactoryOptions>(generator: UserReactGeneratorV2<TPlugin>): ReactGeneratorV2<TPlugin>;
+declare function defineGenerator<TPlugin extends PluginFactoryOptions = PluginFactoryOptions>(generator: UserCoreGeneratorV2<TPlugin>): CoreGeneratorV2<TPlugin>;
+//#endregion
 //#region src/types.d.ts
 declare global {
   namespace Kubb {
@@ -997,5 +1053,5 @@ type Logger<TOptions extends LoggerOptions = LoggerOptions> = {
 };
 type UserLogger<TOptions extends LoggerOptions = LoggerOptions> = Omit<Logger<TOptions>, 'logLevel'>;
 //#endregion
-export { UserPluginWithLifeCycle as A, URLPath as B, PrinterFactoryOptions as C, UserConfig as D, UnknownUserPlugin as E, defineStorage as F, formatters as I, linters as L, PluginManager as M, getMode as N, UserLogger as O, DefineStorage as P, logLevel as R, Printer as S, ResolvePathParams as T, PluginFactoryOptions as _, Config as a, PluginParameter as b, Group as c, Logger as d, LoggerContext as f, PluginContext as g, Plugin as h, BarrelType as i, KubbEvents as j, UserPlugin as k, InputData as l, Output as m, AdapterFactoryOptions as n, DevtoolsOptions as o, LoggerOptions as p, AdapterSource as r, GetPluginFactoryOptions as s, Adapter as t, InputPath as u, PluginLifecycle as v, ResolveNameParams as w, PluginWithLifeCycle as x, PluginLifecycleHooks as y, AsyncEventEmitter as z };
-//# sourceMappingURL=types-CiPWLv-5.d.ts.map
+export { UserPluginWithLifeCycle as A, formatters as B, PrinterFactoryOptions as C, UserConfig as D, UnknownUserPlugin as E, KubbEvents as F, logLevel as H, PluginManager as I, getMode as L, Generator as M, ReactGeneratorV2 as N, UserLogger as O, defineGenerator as P, DefineStorage as R, Printer as S, ResolvePathParams as T, AsyncEventEmitter as U, linters as V, URLPath as W, PluginFactoryOptions as _, Config as a, PluginParameter as b, Group as c, Logger as d, LoggerContext as f, PluginContext as g, Plugin as h, BarrelType as i, CoreGeneratorV2 as j, UserPlugin as k, InputData as l, Output as m, AdapterFactoryOptions as n, DevtoolsOptions as o, LoggerOptions as p, AdapterSource as r, GetPluginFactoryOptions as s, Adapter as t, InputPath as u, PluginLifecycle as v, ResolveNameParams as w, PluginWithLifeCycle as x, PluginLifecycleHooks as y, defineStorage as z };
+//# sourceMappingURL=types-Bbh1o0yW.d.ts.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kubb/core",
-  "version": "5.0.0-alpha.3",
+  "version": "5.0.0-alpha.4",
   "description": "Core functionality for Kubb's plugin-based code generation system, providing the foundation for transforming OpenAPI specifications.",
   "keywords": [
     "typescript",
@@ -71,7 +71,7 @@
     "remeda": "^2.33.6",
     "semver": "^7.7.4",
     "tinyexec": "^1.0.4",
-    "@kubb/ast": "5.0.0-alpha.3"
+    "@kubb/ast": "5.0.0-alpha.4"
   },
   "devDependencies": {
     "@types/semver": "^7.7.1",

package/src/defineGenerator.ts

@@ -0,0 +1,106 @@
+import type { OperationNode, SchemaNode } from '@kubb/ast/types'
+import type { KubbFile } from '@kubb/fabric-core/types'
+import type { FabricReactNode } from '@kubb/react-fabric/types'
+import type { Adapter, Config, Plugin, PluginFactoryOptions } from './types.ts'
+
+export type Version = '1' | '2'
+
+// V2 props — fully typed with @kubb/ast (already a @kubb/core dependency)
+export type OperationsV2Props<TPlugin extends PluginFactoryOptions = PluginFactoryOptions> = {
+  config: Config
+  adapter: Adapter
+  options: Plugin<TPlugin>['options']
+  nodes: Array<OperationNode>
+}
+
+export type OperationV2Props<TPlugin extends PluginFactoryOptions = PluginFactoryOptions> = {
+  config: Config
+  adapter: Adapter
+  options: Plugin<TPlugin>['options']
+  node: OperationNode
+}
+
+export type SchemaV2Props<TPlugin extends PluginFactoryOptions = PluginFactoryOptions> = {
+  config: Config
+  adapter: Adapter
+  options: Plugin<TPlugin>['options']
+  node: SchemaNode
+}
+
+type UserCoreGeneratorV2<TPlugin extends PluginFactoryOptions> = {
+  name: string
+  type: 'core'
+  version?: '2'
+  operations?(props: OperationsV2Props<TPlugin>): Promise<Array<KubbFile.File>>
+  operation?(props: OperationV2Props<TPlugin>): Promise<Array<KubbFile.File>>
+  schema?(props: SchemaV2Props<TPlugin>): Promise<Array<KubbFile.File>>
+}
+
+type UserReactGeneratorV2<TPlugin extends PluginFactoryOptions> = {
+  name: string
+  type: 'react'
+  version?: '2'
+  Operations?(props: OperationsV2Props<TPlugin>): FabricReactNode
+  Operation?(props: OperationV2Props<TPlugin>): FabricReactNode
+  Schema?(props: SchemaV2Props<TPlugin>): FabricReactNode
+}
+
+export type CoreGeneratorV2<TPlugin extends PluginFactoryOptions = PluginFactoryOptions> = {
+  name: string
+  type: 'core'
+  version: '2'
+  operations(props: OperationsV2Props<TPlugin>): Promise<Array<KubbFile.File>>
+  operation(props: OperationV2Props<TPlugin>): Promise<Array<KubbFile.File>>
+  schema(props: SchemaV2Props<TPlugin>): Promise<Array<KubbFile.File>>
+}
+
+export type ReactGeneratorV2<TPlugin extends PluginFactoryOptions = PluginFactoryOptions> = {
+  name: string
+  type: 'react'
+  version: '2'
+  Operations(props: OperationsV2Props<TPlugin>): FabricReactNode
+  Operation(props: OperationV2Props<TPlugin>): FabricReactNode
+  Schema(props: SchemaV2Props<TPlugin>): FabricReactNode
+}
+
+export type Generator<TPlugin extends PluginFactoryOptions = PluginFactoryOptions> = UserCoreGeneratorV2<TPlugin> | UserReactGeneratorV2<TPlugin>
+
+export function defineGenerator<TPlugin extends PluginFactoryOptions = PluginFactoryOptions>(
+  generator: UserReactGeneratorV2<TPlugin>,
+): ReactGeneratorV2<TPlugin>
+
+export function defineGenerator<TPlugin extends PluginFactoryOptions = PluginFactoryOptions>(generator: UserCoreGeneratorV2<TPlugin>): CoreGeneratorV2<TPlugin>
+
+export function defineGenerator<TPlugin extends PluginFactoryOptions = PluginFactoryOptions>(
+  generator: UserCoreGeneratorV2<TPlugin> | UserReactGeneratorV2<TPlugin>,
+): unknown {
+  if (generator.type === 'react') {
+    return {
+      version: '2',
+      Operations() {
+        return null
+      },
+      Operation() {
+        return null
+      },
+      Schema() {
+        return null
+      },
+      ...generator,
+    }
+  }
+
+  return {
+    version: '2',
+    async operations() {
+      return []
+    },
+    async operation() {
+      return []
+    },
+    async schema() {
+      return []
+    },
+    ...generator,
+  }
+}

package/src/index.ts

@@ -4,6 +4,7 @@ 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 { defineGenerator } from './defineGenerator.ts'
 export { defineLogger } from './defineLogger.ts'
 export { definePlugin } from './definePlugin.ts'
 export { defineStorage } from './defineStorage.ts'
@@ -20,3 +21,4 @@ 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'

package/src/types.ts

@@ -508,5 +508,6 @@ export type Logger<TOptions extends LoggerOptions = LoggerOptions> = {
 
 export type UserLogger<TOptions extends LoggerOptions = LoggerOptions> = Omit<Logger<TOptions>, 'logLevel'>
 
+export type { CoreGeneratorV2, Generator, ReactGeneratorV2 } from './defineGenerator.ts'
 export type { DefineStorage } from './defineStorage.ts'
 export type { KubbEvents } from './Kubb.ts'

package/src/utils/resolveOptions.ts

@@ -0,0 +1,93 @@
+import { isOperationNode, isSchemaNode } from '@kubb/ast'
+import type { Node, OperationNode, SchemaNode } from '@kubb/ast/types'
+
+type FilterItem = {
+  type: string
+  pattern: string | RegExp
+}
+
+type OverrideItem<TOptions> = FilterItem & {
+  options: Partial<TOptions>
+}
+
+type ResolveOptionsContext<TOptions> = {
+  options: TOptions
+  exclude?: Array<FilterItem>
+  include?: Array<FilterItem>
+  override?: Array<OverrideItem<TOptions>>
+}
+
+function matchesOperationPattern(node: OperationNode, type: string, pattern: string | RegExp): boolean {
+  switch (type) {
+    case 'tag':
+      return node.tags.some((tag) => !!tag.match(pattern))
+    case 'operationId':
+      return !!node.operationId.match(pattern)
+    case 'path':
+      return !!node.path.match(pattern)
+    case 'method':
+      return !!(node.method.toLowerCase() as string).match(pattern)
+    default:
+      return false
+  }
+}
+
+function matchesSchemaPattern(node: SchemaNode, type: string, pattern: string | RegExp): boolean | null {
+  switch (type) {
+    case 'schemaName':
+      return node.name ? !!node.name.match(pattern) : false
+    default:
+      return null
+  }
+}
+
+/**
+ * Resolves the effective plugin options for a given AST node by applying
+ * `exclude`, `include`, and `override` rules from the plugin configuration.
+ *
+ * Returns `null` when the node is excluded or not matched by `include`.
+ * Returns the merged options (base options merged with any matching `override`) otherwise.
+ *
+ * Supported filter types for `OperationNode`: `tag`, `operationId`, `path`, `method`.
+ * Supported filter types for `SchemaNode`: `schemaName`.
+ *
+ * @example
+ * const resolved = resolveOptions(operationNode, { options, exclude, include, override })
+ * if (!resolved) return // excluded
+ */
+export function resolveOptions<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
+}