@kubb/plugin-oas 5.0.0-alpha.3 → 5.0.0-alpha.31

package/src/generators/createReactGenerator.ts

@@ -1,22 +1,21 @@
 import type { PluginFactoryOptions } from '@kubb/core'
 import type { FabricReactNode } from '@kubb/react-fabric/types'
-import type { OperationProps, OperationsProps, SchemaProps, Version } from './types.ts'
+import type { OperationProps, OperationsProps, SchemaProps } from './types.ts'
 
-type UserGenerator<TOptions extends PluginFactoryOptions, TVersion extends Version> = {
+type UserGenerator<TOptions extends PluginFactoryOptions> = {
   name: string
-  version?: TVersion
-  Operations?: (props: OperationsProps<TOptions, TVersion>) => FabricReactNode
-  Operation?: (props: OperationProps<TOptions, TVersion>) => FabricReactNode
-  Schema?: (props: SchemaProps<TOptions, TVersion>) => FabricReactNode
+  Operations?: (props: OperationsProps<TOptions>) => FabricReactNode
+  Operation?: (props: OperationProps<TOptions>) => FabricReactNode
+  Schema?: (props: SchemaProps<TOptions>) => FabricReactNode
 }
 
-export type ReactGenerator<TOptions extends PluginFactoryOptions, TVersion extends Version> = {
+export type ReactGenerator<TOptions extends PluginFactoryOptions> = {
   name: string
   type: 'react'
-  version: TVersion
-  Operations: (props: OperationsProps<TOptions, TVersion>) => FabricReactNode
-  Operation: (props: OperationProps<TOptions, TVersion>) => FabricReactNode
-  Schema: (props: SchemaProps<TOptions, TVersion>) => FabricReactNode
+  version: '1'
+  Operations: (props: OperationsProps<TOptions>) => FabricReactNode
+  Operation: (props: OperationProps<TOptions>) => FabricReactNode
+  Schema: (props: SchemaProps<TOptions>) => FabricReactNode
 }
 
 /****
@@ -26,12 +25,10 @@ export type ReactGenerator<TOptions extends PluginFactoryOptions, TVersion exten
  *
  * @returns A generator object with async methods for operations, operation, and schema file generation.
  */
-export function createReactGenerator<TOptions extends PluginFactoryOptions, TVersion extends Version = '1'>(
-  generator: UserGenerator<TOptions, TVersion>,
-): ReactGenerator<TOptions, TVersion> {
+export function createReactGenerator<TOptions extends PluginFactoryOptions>(generator: UserGenerator<TOptions>): ReactGenerator<TOptions> {
   return {
     type: 'react',
-    version: (generator.version ?? '1') as TVersion,
+    version: '1',
     Operations() {
       return null
     },

package/src/generators/index.ts

@@ -1,4 +1,4 @@
-export { createGenerator } from './createGenerator.ts'
-export { createReactGenerator } from './createReactGenerator.ts'
+export { type CoreGenerator, createGenerator } from './createGenerator.ts'
+export { createReactGenerator, type ReactGenerator } from './createReactGenerator.ts'
 export { jsonGenerator } from './jsonGenerator.ts'
 export type { Generator } from './types.ts'

package/src/generators/jsonGenerator.ts

@@ -7,8 +7,8 @@ import { createGenerator } from './createGenerator.ts'
 export const jsonGenerator = createGenerator<PluginOas>({
   name: 'plugin-oas',
   async schema({ schema, generator }) {
-    const { pluginManager, plugin } = generator.context
-    const file = pluginManager.getFile({
+    const { driver, plugin } = generator.context
+    const file = driver.getFile({
       name: camelCase(schema.name),
       extname: '.json',
       mode: 'split',
@@ -29,7 +29,7 @@ export const jsonGenerator = createGenerator<PluginOas>({
         banner: getBanner({
           oas: generator.context.oas,
           output: plugin.options.output,
-          config: pluginManager.config,
+          config: driver.config,
         }),
         format: getFooter({ oas: generator.context.oas, output: plugin.options.output }),
       },

package/src/generators/types.ts

@@ -1,5 +1,4 @@
-import type { OperationNode, SchemaNode } from '@kubb/ast/types'
-import type { Adapter, Config, Plugin, PluginFactoryOptions } from '@kubb/core'
+import type { Config, Generator as CoreV2Generator, Plugin, PluginFactoryOptions } from '@kubb/core'
 import type { Operation, SchemaObject } from '@kubb/oas'
 import type { OperationGenerator } from '../OperationGenerator.ts'
 import type { SchemaGenerator, SchemaGeneratorOptions } from '../SchemaGenerator.ts'
@@ -7,45 +6,21 @@ import type { Schema } from '../SchemaMapper.ts'
 import type { CoreGenerator } from './createGenerator.ts'
 import type { ReactGenerator } from './createReactGenerator.ts'
 
-export type Version = '1' | '2'
-
-export type OperationsV1Props<TOptions extends PluginFactoryOptions> = {
+export type OperationsProps<TOptions extends PluginFactoryOptions> = {
   config: Config
   generator: Omit<OperationGenerator<TOptions>, 'build'>
   plugin: Plugin<TOptions>
   operations: Array<Operation>
 }
 
-export type OperationsV2Props<TOptions extends PluginFactoryOptions> = {
-  config: Config
-  adapter: Adapter
-  options: Plugin<TOptions>['options']
-  nodes: Array<OperationNode>
-}
-
-export type OperationV1Props<TOptions extends PluginFactoryOptions> = {
+export type OperationProps<TOptions extends PluginFactoryOptions> = {
   config: Config
   generator: Omit<OperationGenerator<TOptions>, 'build'>
   plugin: Plugin<TOptions>
   operation: Operation
 }
 
-export type OperationV2Props<TOptions extends PluginFactoryOptions> = {
-  config: Config
-  adapter: Adapter
-  options: Plugin<TOptions>['options']
-  node: OperationNode
-}
-
-export type OperationsProps<TOptions extends PluginFactoryOptions, TVersion extends Version = '1'> = TVersion extends '2'
-  ? OperationsV2Props<TOptions>
-  : OperationsV1Props<TOptions>
-
-export type OperationProps<TOptions extends PluginFactoryOptions, TVersion extends Version = '1'> = TVersion extends '2'
-  ? OperationV2Props<TOptions>
-  : OperationV1Props<TOptions>
-
-export type SchemaV1Props<TOptions extends PluginFactoryOptions> = {
+export type SchemaProps<TOptions extends PluginFactoryOptions> = {
   config: Config
   generator: Omit<SchemaGenerator<SchemaGeneratorOptions, TOptions>, 'build'>
   plugin: Plugin<TOptions>
@@ -56,17 +31,4 @@ export type SchemaV1Props<TOptions extends PluginFactoryOptions> = {
   }
 }
 
-export type SchemaV2Props<TOptions extends PluginFactoryOptions> = {
-  config: Config
-  options: Plugin<TOptions>['options']
-  node: SchemaNode
-  adapter: Adapter
-}
-
-export type SchemaProps<TOptions extends PluginFactoryOptions, TVersion extends Version = '1'> = TVersion extends '2'
-  ? SchemaV2Props<TOptions>
-  : SchemaV1Props<TOptions>
-
-export type Generator<TOptions extends PluginFactoryOptions, TVersion extends Version = Version> =
-  | CoreGenerator<TOptions, TVersion>
-  | ReactGenerator<TOptions, TVersion>
+export type Generator<TOptions extends PluginFactoryOptions> = CoreGenerator<TOptions> | ReactGenerator<TOptions> | CoreV2Generator<TOptions>

package/src/hooks/useOas.ts

@@ -1,9 +1,12 @@
 import type { Oas } from '@kubb/oas'
 
-import { useApp } from '@kubb/react-fabric'
+import { useFabric } from '@kubb/react-fabric'
 
+/**
+ * @deprecated use schemaNode or operationNode instead
+ */
 export function useOas(): Oas {
-  const { meta } = useApp<{ oas: Oas }>()
+  const { meta } = useFabric<{ oas: Oas }>()
 
   return meta.oas
 }

package/src/hooks/useOperationManager.ts

@@ -1,6 +1,5 @@
-import type { FileMetaBase, PluginFactoryOptions, ResolveNameParams } from '@kubb/core'
-import { usePlugin, usePluginManager } from '@kubb/core/hooks'
-import type { KubbFile } from '@kubb/fabric-core/types'
+import type { FileMetaBase, KubbFile, PluginFactoryOptions, ResolveNameParams } from '@kubb/core'
+import { useDriver, usePlugin } from '@kubb/core/hooks'
 import type { Operation, Operation as OperationType } from '@kubb/oas'
 import type { OperationGenerator } from '../OperationGenerator.ts'
 import type { OperationSchemas } from '../types.ts'
@@ -66,10 +65,11 @@ export function useOperationManager<TPluginOptions extends PluginFactoryOptions
   generator: Omit<OperationGenerator<TPluginOptions>, 'build'>,
 ): UseOperationManagerResult {
   const plugin = usePlugin()
-  const pluginManager = usePluginManager()
+  const driver = useDriver()
+  const defaultPluginName = plugin.name
 
-  const getName: UseOperationManagerResult['getName'] = (operation, { prefix = '', suffix = '', pluginName = plugin.name, type }) => {
-    return pluginManager.resolveName({
+  const getName: UseOperationManagerResult['getName'] = (operation, { prefix = '', suffix = '', pluginName = defaultPluginName, type }) => {
+    return driver.resolveName({
       name: `${prefix} ${operation.getOperationId()} ${suffix}`,
       pluginName,
       type,
@@ -78,7 +78,7 @@ export function useOperationManager<TPluginOptions extends PluginFactoryOptions
 
   const getGroup: UseOperationManagerResult['getGroup'] = (operation) => {
     return {
-      tag: operation.getTags().at(0)?.name,
+      tag: operation.getTags().at(0)?.name ?? 'default',
       path: operation.path,
     }
   }
@@ -90,19 +90,19 @@ export function useOperationManager<TPluginOptions extends PluginFactoryOptions
 
     return generator.getSchemas(operation, {
       resolveName: (name) =>
-        pluginManager.resolveName({
+        driver.resolveName({
           name,
-          pluginName: params?.pluginName,
+          pluginName: params?.pluginName ?? defaultPluginName,
           type: params?.type,
         }),
     })
   }
 
-  const getFile: UseOperationManagerResult['getFile'] = (operation, { prefix, suffix, pluginName = plugin.name, extname = '.ts' } = {}) => {
+  const getFile: UseOperationManagerResult['getFile'] = (operation, { prefix, suffix, pluginName = defaultPluginName, extname = '.ts' } = {}) => {
     const name = getName(operation, { type: 'file', pluginName, prefix, suffix })
     const group = getGroup(operation)
 
-    const file = pluginManager.getFile({
+    const file = driver.getFile({
       name,
       extname,
       pluginName,
@@ -120,12 +120,12 @@ export function useOperationManager<TPluginOptions extends PluginFactoryOptions
     }
   }
 
-  const groupSchemasByName: UseOperationManagerResult['groupSchemasByName'] = (operation, { pluginName = plugin.name, type }) => {
+  const groupSchemasByName: UseOperationManagerResult['groupSchemasByName'] = (operation, { pluginName = defaultPluginName, type }) => {
     if (!generator) {
       throw new Error(`useOperationManager: 'generator' parameter is required but was not provided`)
     }
 
-    const schemas = generator.getSchemas(operation)
+    const schemas = getSchemas(operation)
 
     const errors = (schemas.errors || []).reduce(
       (prev, acc) => {
@@ -133,7 +133,7 @@ export function useOperationManager<TPluginOptions extends PluginFactoryOptions
           return prev
         }
 
-        prev[acc.statusCode] = pluginManager.resolveName({
+        prev[acc.statusCode] = driver.resolveName({
           name: acc.name,
           pluginName,
           type,
@@ -150,7 +150,7 @@ export function useOperationManager<TPluginOptions extends PluginFactoryOptions
           return prev
         }
 
-        prev[acc.statusCode] = pluginManager.resolveName({
+        prev[acc.statusCode] = driver.resolveName({
           name: acc.name,
           pluginName,
           type,
@@ -163,7 +163,7 @@ export function useOperationManager<TPluginOptions extends PluginFactoryOptions
 
     return {
       request: schemas.request?.name
-        ? pluginManager.resolveName({
+        ? driver.resolveName({
             name: schemas.request.name,
             pluginName,
             type,
@@ -171,21 +171,21 @@ export function useOperationManager<TPluginOptions extends PluginFactoryOptions
         : undefined,
       parameters: {
         path: schemas.pathParams?.name
-          ? pluginManager.resolveName({
+          ? driver.resolveName({
               name: schemas.pathParams.name,
               pluginName,
               type,
             })
           : undefined,
         query: schemas.queryParams?.name
-          ? pluginManager.resolveName({
+          ? driver.resolveName({
               name: schemas.queryParams.name,
               pluginName,
               type,
             })
           : undefined,
         header: schemas.headerParams?.name
-          ? pluginManager.resolveName({
+          ? driver.resolveName({
               name: schemas.headerParams.name,
               pluginName,
               type,
@@ -194,7 +194,7 @@ export function useOperationManager<TPluginOptions extends PluginFactoryOptions
       },
       responses: {
         ...responses,
-        ['default']: pluginManager.resolveName({
+        ['default']: driver.resolveName({
           name: schemas.response.name,
           pluginName,
           type,

package/src/hooks/useSchemaManager.ts

@@ -1,6 +1,5 @@
-import type { FileMetaBase, ResolveNameParams } from '@kubb/core'
-import { usePlugin, usePluginManager } from '@kubb/core/hooks'
-import type { KubbFile } from '@kubb/fabric-core/types'
+import type { FileMetaBase, KubbFile, ResolveNameParams } from '@kubb/core'
+import { useDriver, usePlugin } from '@kubb/core/hooks'
 
 type FileMeta = FileMetaBase & {
   pluginName: string
@@ -33,10 +32,10 @@ type UseSchemaManagerResult = {
  */
 export function useSchemaManager(): UseSchemaManagerResult {
   const plugin = usePlugin()
-  const pluginManager = usePluginManager()
+  const driver = useDriver()
 
   const getName: UseSchemaManagerResult['getName'] = (name, { pluginName = plugin.name, type }) => {
-    return pluginManager.resolveName({
+    return driver.resolveName({
       name,
       pluginName,
       type,
@@ -46,7 +45,7 @@ export function useSchemaManager(): UseSchemaManagerResult {
   const getFile: UseSchemaManagerResult['getFile'] = (name, { mode = 'split', pluginName = plugin.name, extname = '.ts', group } = {}) => {
     const resolvedName = mode === 'single' ? '' : getName(name, { type: 'file', pluginName })
 
-    const file = pluginManager.getFile({
+    const file = driver.getFile({
       name: resolvedName,
       extname,
       pluginName,

package/src/index.ts

@@ -25,7 +25,7 @@ export type {
 } from './SchemaMapper.ts'
 export { isKeyword, schemaKeywords } from './SchemaMapper.ts'
 export type * from './types.ts'
-export { buildOperation, buildOperations, buildSchema } from './utils.tsx'
+export { renderOperation, renderOperations, renderSchema } from './utils.tsx'
 
 /**
  * @deprecated use `import { createGenerator } from '@kubb/plugin-oas/generators'`
@@ -40,4 +40,4 @@ export const createReactGenerator = _createReactGenerator
 /**
  * @deprecated use `import { Generator } from '@kubb/plugin-oas/generators'`
  */
-export type Generator<TOptions extends PluginFactoryOptions, TVersion extends import('./generators/types.ts').Version = '1'> = _Generator<TOptions, TVersion>
+export type Generator<TOptions extends PluginFactoryOptions> = _Generator<TOptions>

package/src/plugin.ts

@@ -1,9 +1,10 @@
 import path from 'node:path'
+import type { AsyncEventEmitter } from '@internals/utils'
 import { camelCase } from '@internals/utils'
-import type { AsyncEventEmitter } from '@kubb/core'
-import { type Config, definePlugin, type Group, getMode, type KubbEvents } from '@kubb/core'
+import { type Config, createPlugin, type KubbEvents, type UserGroup } from '@kubb/core'
 import type { Oas } from '@kubb/oas'
 import { parseFromConfig, resolveServerUrl } from '@kubb/oas'
+import { version } from '../package.json'
 import { jsonGenerator } from './generators'
 import { OperationGenerator } from './OperationGenerator.ts'
 import { SchemaGenerator } from './SchemaGenerator.ts'
@@ -11,7 +12,7 @@ import type { PluginOas } from './types.ts'
 
 export const pluginOasName = 'plugin-oas' satisfies PluginOas['name']
 
-export const pluginOas = definePlugin<PluginOas>((options) => {
+export const pluginOas = createPlugin<PluginOas>((options) => {
   const {
     output = {
       path: 'schemas',
@@ -60,11 +61,14 @@ export const pluginOas = definePlugin<PluginOas>((options) => {
 
   return {
     name: pluginOasName,
+    version,
     options: {
       output,
       validate,
       discriminator,
       ...options,
+      exclude: [],
+      override: [],
     },
     inject() {
       const config = this.config
@@ -99,8 +103,8 @@ export const pluginOas = definePlugin<PluginOas>((options) => {
       }
     },
     resolvePath(baseName, pathMode, options) {
-      const root = path.resolve(this.config.root, this.config.output.path)
-      const mode = pathMode ?? getMode(path.resolve(root, output.path))
+      const root = this.root
+      const mode = pathMode ?? this.getMode(output)
 
       if (mode === 'single') {
         /**
@@ -111,7 +115,7 @@ export const pluginOas = definePlugin<PluginOas>((options) => {
       }
 
       if (group && (options?.group?.path || options?.group?.tag)) {
-        const groupName: Group['name'] = group?.name
+        const groupName: UserGroup['name'] = group?.name
           ? group.name
           : (ctx) => {
               if (group?.type === 'path') {
@@ -132,7 +136,7 @@ export const pluginOas = definePlugin<PluginOas>((options) => {
 
       return path.resolve(root, output.path, baseName)
     },
-    async install() {
+    async buildStart() {
       const oas = await this.getOas({ validate })
 
       if (!output || generators.length === 0) {
@@ -152,7 +156,7 @@ export const pluginOas = definePlugin<PluginOas>((options) => {
         {
           fabric: this.fabric,
           oas,
-          pluginManager: this.pluginManager,
+          driver: this.driver,
           events: this.events,
           plugin: this.plugin,
           contentType,
@@ -169,7 +173,7 @@ export const pluginOas = definePlugin<PluginOas>((options) => {
       const operationGenerator = new OperationGenerator(this.plugin.options, {
         fabric: this.fabric,
         oas,
-        pluginManager: this.pluginManager,
+        driver: this.driver,
         events: this.events,
         plugin: this.plugin,
         contentType,

package/src/types.ts

@@ -1,5 +1,4 @@
-import type { Group, Output, PluginFactoryOptions, ResolveNameParams } from '@kubb/core'
-import type { KubbFile } from '@kubb/fabric-core/types'
+import type { KubbFile, Output, PluginFactoryOptions, ResolveNameParams, UserGroup } from '@kubb/core'
 
 import type { contentType, HttpMethod, Oas, Operation, SchemaObject } from '@kubb/oas'
 import type { Generator } from './generators/types.ts'
@@ -16,6 +15,9 @@ type Context = {
 declare global {
   namespace Kubb {
     interface PluginContext extends Context {}
+    interface PluginRegistry {
+      'plugin-oas': PluginOas
+    }
   }
 }
 
@@ -42,7 +44,7 @@ export type Options = {
   /**
    * Group the JSON files based on the provided name.
    */
-  group?: Group
+  group?: UserGroup
   /**
    * Which server to use from the array of `servers.url[serverIndex]`
    * @example
@@ -220,15 +222,19 @@ type ByContentType = {
   pattern: string | RegExp
 }
 
-export type Exclude = ByTag | ByOperationId | ByPath | ByMethod | ByContentType
-export type Include = ByTag | ByOperationId | ByPath | ByMethod | ByContentType
+export type Exclude = ByTag | ByOperationId | ByPath | ByMethod | ByContentType | BySchemaName
+export type Include = ByTag | ByOperationId | ByPath | ByMethod | ByContentType | BySchemaName
 
 export type Override<TOptions> = (ByTag | ByOperationId | ByPath | ByMethod | BySchemaName | ByContentType) & {
+  // should be options: Omit<Partial<TOptions>, 'override'>
   options: Partial<TOptions>
 }
 
 type ResolvedOptions = Options & {
   output: Output<Oas>
+  exclude: Array<Exclude>
+  include?: Array<Include>
+  override: Array<Override<ResolvedOptions>>
 }
 
 export type PluginOas = PluginFactoryOptions<'plugin-oas', Options, ResolvedOptions, Context, ResolvePathOptions>

package/src/utils/getBanner.ts

@@ -67,7 +67,7 @@ export function getBanner<TOas extends Oas>({ output, oas, config }: Props<TOas>
   }
 
   if (isFunction(output.banner)) {
-    return `${output.banner(oas)}\n${banner}`
+    return `${output.banner(oas as any)}\n${banner}`
   }
 
   return `${output.banner}\n${banner}`

package/src/utils/getFooter.ts

@@ -13,7 +13,7 @@ export function getFooter<TOas extends Oas>({ output, oas }: Props<TOas>) {
   }
 
   if (isFunction(output.footer)) {
-    return output.footer(oas)
+    return output.footer(oas as any)
   }
 
   return output.footer

package/src/utils/getImports.ts

@@ -1,4 +1,4 @@
-import type { KubbFile } from '@kubb/fabric-core/types'
+import type { KubbFile } from '@kubb/core'
 import { SchemaGenerator } from '../SchemaGenerator.ts'
 import type { Schema } from '../SchemaMapper'
 import { schemaKeywords } from '../SchemaMapper'

package/src/utils/getParams.ts

@@ -20,7 +20,7 @@ export function getASTParams(
     override?: (data: FunctionParamsAST) => FunctionParamsAST
   } = {},
 ): FunctionParamsAST[] {
-  if (!operationSchema || !operationSchema.schema.properties || !operationSchema.name) {
+  if (!operationSchema?.schema.properties || !operationSchema.name) {
     return []
   }
 
@@ -82,7 +82,7 @@ export function getParamsMapping(
     casing?: 'camelcase'
   } = {},
 ): Record<string, string> | undefined {
-  if (!operationSchema || !operationSchema.schema.properties) {
+  if (!operationSchema?.schema.properties) {
     return undefined
   }