@kubb/plugin-oas 5.0.0-alpha.1 → 5.0.0-alpha.11

package/src/generators/types.ts

@@ -1,5 +1,4 @@
-import type { OperationNode, SchemaNode } from '@kubb/ast/types'
-import type { 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,43 +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
-  plugin: Plugin<TOptions>
-  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
-  plugin: Plugin<TOptions>
-  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>
@@ -54,16 +31,4 @@ export type SchemaV1Props<TOptions extends PluginFactoryOptions> = {
   }
 }
 
-export type SchemaV2Props<TOptions extends PluginFactoryOptions> = {
-  config: Config
-  plugin: Plugin<TOptions>
-  node: SchemaNode
-}
-
-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/index.ts

@@ -1,5 +1,4 @@
 export { useOas } from './useOas.ts'
 export type { SchemaNames } from './useOperationManager.ts'
 export { useOperationManager } from './useOperationManager.ts'
-export { useRootNode } from './useRootNode.ts'
 export { useSchemaManager } from './useSchemaManager.ts'

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,12 +1,12 @@
-import type { FileMetaBase, Plugin, PluginFactoryOptions, ResolveNameParams } from '@kubb/core'
-import { usePlugin, usePluginManager } from '@kubb/core/hooks'
+import type { FileMetaBase, PluginFactoryOptions, ResolveNameParams } from '@kubb/core'
+import { usePlugin, usePluginDriver } from '@kubb/core/hooks'
 import type { KubbFile } from '@kubb/fabric-core/types'
 import type { Operation, Operation as OperationType } from '@kubb/oas'
 import type { OperationGenerator } from '../OperationGenerator.ts'
 import type { OperationSchemas } from '../types.ts'
 
 type FileMeta = FileMetaBase & {
-  pluginKey: Plugin['key']
+  pluginName: string
   name: string
   group?: {
     tag?: string
@@ -31,7 +31,7 @@ type UseOperationManagerResult = {
     params: {
       prefix?: string
       suffix?: string
-      pluginKey?: Plugin['key']
+      pluginName?: string
       type: ResolveNameParams['type']
     },
   ) => string
@@ -40,7 +40,7 @@ type UseOperationManagerResult = {
     params?: {
       prefix?: string
       suffix?: string
-      pluginKey?: Plugin['key']
+      pluginName?: string
       extname?: KubbFile.Extname
       group?: {
         tag?: string
@@ -51,11 +51,11 @@ type UseOperationManagerResult = {
   groupSchemasByName: (
     operation: OperationType,
     params: {
-      pluginKey?: Plugin['key']
+      pluginName?: string
       type: ResolveNameParams['type']
     },
   ) => SchemaNames
-  getSchemas: (operation: Operation, params?: { pluginKey?: Plugin['key']; type?: ResolveNameParams['type'] }) => OperationSchemas
+  getSchemas: (operation: Operation, params?: { pluginName?: string; type?: ResolveNameParams['type'] }) => OperationSchemas
   getGroup: (operation: Operation) => FileMeta['group'] | undefined
 }
 
@@ -66,12 +66,13 @@ export function useOperationManager<TPluginOptions extends PluginFactoryOptions
   generator: Omit<OperationGenerator<TPluginOptions>, 'build'>,
 ): UseOperationManagerResult {
   const plugin = usePlugin()
-  const pluginManager = usePluginManager()
+  const driver = usePluginDriver()
+  const defaultPluginName = plugin.name
 
-  const getName: UseOperationManagerResult['getName'] = (operation, { prefix = '', suffix = '', pluginKey = plugin.key, type }) => {
-    return pluginManager.resolveName({
+  const getName: UseOperationManagerResult['getName'] = (operation, { prefix = '', suffix = '', pluginName = defaultPluginName, type }) => {
+    return driver.resolveName({
       name: `${prefix} ${operation.getOperationId()} ${suffix}`,
-      pluginKey,
+      pluginName,
       type,
     })
   }
@@ -90,23 +91,23 @@ export function useOperationManager<TPluginOptions extends PluginFactoryOptions
 
     return generator.getSchemas(operation, {
       resolveName: (name) =>
-        pluginManager.resolveName({
+        driver.resolveName({
           name,
-          pluginKey: params?.pluginKey,
+          pluginName: params?.pluginName ?? defaultPluginName,
           type: params?.type,
         }),
     })
   }
 
-  const getFile: UseOperationManagerResult['getFile'] = (operation, { prefix, suffix, pluginKey = plugin.key, extname = '.ts' } = {}) => {
-    const name = getName(operation, { type: 'file', pluginKey, prefix, suffix })
+  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,
-      pluginKey,
-      options: { type: 'file', pluginKey, group },
+      pluginName,
+      options: { type: 'file', pluginName, group },
     })
 
     return {
@@ -114,18 +115,18 @@ export function useOperationManager<TPluginOptions extends PluginFactoryOptions
       meta: {
         ...file.meta,
         name,
-        pluginKey,
+        pluginName,
         group,
       },
     }
   }
 
-  const groupSchemasByName: UseOperationManagerResult['groupSchemasByName'] = (operation, { pluginKey = plugin.key, 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,9 +134,9 @@ export function useOperationManager<TPluginOptions extends PluginFactoryOptions
           return prev
         }
 
-        prev[acc.statusCode] = pluginManager.resolveName({
+        prev[acc.statusCode] = driver.resolveName({
           name: acc.name,
-          pluginKey,
+          pluginName,
           type,
         })
 
@@ -150,9 +151,9 @@ export function useOperationManager<TPluginOptions extends PluginFactoryOptions
           return prev
         }
 
-        prev[acc.statusCode] = pluginManager.resolveName({
+        prev[acc.statusCode] = driver.resolveName({
           name: acc.name,
-          pluginKey,
+          pluginName,
           type,
         })
 
@@ -163,40 +164,40 @@ export function useOperationManager<TPluginOptions extends PluginFactoryOptions
 
     return {
       request: schemas.request?.name
-        ? pluginManager.resolveName({
+        ? driver.resolveName({
             name: schemas.request.name,
-            pluginKey,
+            pluginName,
             type,
           })
         : undefined,
       parameters: {
         path: schemas.pathParams?.name
-          ? pluginManager.resolveName({
+          ? driver.resolveName({
               name: schemas.pathParams.name,
-              pluginKey,
+              pluginName,
               type,
             })
           : undefined,
         query: schemas.queryParams?.name
-          ? pluginManager.resolveName({
+          ? driver.resolveName({
               name: schemas.queryParams.name,
-              pluginKey,
+              pluginName,
               type,
             })
           : undefined,
         header: schemas.headerParams?.name
-          ? pluginManager.resolveName({
+          ? driver.resolveName({
               name: schemas.headerParams.name,
-              pluginKey,
+              pluginName,
               type,
             })
           : undefined,
       },
       responses: {
         ...responses,
-        ['default']: pluginManager.resolveName({
+        ['default']: driver.resolveName({
           name: schemas.response.name,
-          pluginKey,
+          pluginName,
           type,
         }),
         ...errors,

package/src/hooks/useSchemaManager.ts

@@ -1,9 +1,9 @@
-import type { FileMetaBase, Plugin, ResolveNameParams } from '@kubb/core'
-import { usePlugin, usePluginManager } from '@kubb/core/hooks'
+import type { FileMetaBase, ResolveNameParams } from '@kubb/core'
+import { usePlugin, usePluginDriver } from '@kubb/core/hooks'
 import type { KubbFile } from '@kubb/fabric-core/types'
 
 type FileMeta = FileMetaBase & {
-  pluginKey: Plugin['key']
+  pluginName: string
   name: string
   group?: {
     tag?: string
@@ -12,11 +12,11 @@ type FileMeta = FileMetaBase & {
 }
 
 type UseSchemaManagerResult = {
-  getName: (name: string, params: { pluginKey?: Plugin['key']; type: ResolveNameParams['type'] }) => string
+  getName: (name: string, params: { pluginName?: string; type: ResolveNameParams['type'] }) => string
   getFile: (
     name: string,
     params?: {
-      pluginKey?: Plugin['key']
+      pluginName?: string
       mode?: KubbFile.Mode
       extname?: KubbFile.Extname
       group?: {
@@ -29,27 +29,28 @@ type UseSchemaManagerResult = {
 
 /**
  * `useSchemaManager` returns helper functions to get the schema file and schema name.
+ * @deprecated
  */
 export function useSchemaManager(): UseSchemaManagerResult {
   const plugin = usePlugin()
-  const pluginManager = usePluginManager()
+  const driver = usePluginDriver()
 
-  const getName: UseSchemaManagerResult['getName'] = (name, { pluginKey = plugin.key, type }) => {
-    return pluginManager.resolveName({
+  const getName: UseSchemaManagerResult['getName'] = (name, { pluginName = plugin.name, type }) => {
+    return driver.resolveName({
       name,
-      pluginKey,
+      pluginName,
       type,
     })
   }
 
-  const getFile: UseSchemaManagerResult['getFile'] = (name, { mode = 'split', pluginKey = plugin.key, extname = '.ts', group } = {}) => {
-    const resolvedName = mode === 'single' ? '' : getName(name, { type: 'file', pluginKey })
+  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,
-      pluginKey,
-      options: { type: 'file', pluginKey, group },
+      pluginName,
+      options: { type: 'file', pluginName, group },
     })
 
     return {
@@ -57,7 +58,7 @@ export function useSchemaManager(): UseSchemaManagerResult {
       meta: {
         ...file.meta,
         name: resolvedName,
-        pluginKey,
+        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,7 +1,7 @@
 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 Group, getMode, type KubbEvents } from '@kubb/core'
 import type { Oas } from '@kubb/oas'
 import { parseFromConfig, resolveServerUrl } from '@kubb/oas'
 import { jsonGenerator } from './generators'
@@ -11,7 +11,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',
@@ -135,7 +135,7 @@ export const pluginOas = definePlugin<PluginOas>((options) => {
     async install() {
       const oas = await this.getOas({ validate })
 
-      if (!output) {
+      if (!output || generators.length === 0) {
         return
       }
 
@@ -152,7 +152,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 +169,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,4 +1,4 @@
-import type { Group, Output, Plugin, PluginFactoryOptions, ResolveNameParams } from '@kubb/core'
+import type { Group, Output, PluginFactoryOptions, ResolveNameParams } from '@kubb/core'
 import type { KubbFile } from '@kubb/fabric-core/types'
 
 import type { contentType, HttpMethod, Oas, Operation, SchemaObject } from '@kubb/oas'
@@ -20,7 +20,7 @@ declare global {
 }
 
 export type ResolvePathOptions = {
-  pluginKey?: Plugin['key']
+  pluginName?: string
   group?: {
     tag?: string
     path?: string
@@ -136,14 +136,14 @@ export type Options = {
  *
  * `originalName` is the original name used(in PascalCase), only used to remove duplicates
  *
- * `pluginKey` can be used to override the current plugin being used, handy when you want to import a type/schema out of another plugin
+ * `pluginName` can be used to override the current plugin being used, handy when you want to import a type/schema out of another plugin
  * @example import a type(plugin-ts) for a mock file(swagger-faker)
  */
 export type Ref = {
   propertyName: string
   originalName: string
   path: KubbFile.Path
-  pluginKey?: Plugin['key']
+  pluginName?: string
 }
 export type Refs = Record<string, Ref>
 
@@ -220,10 +220,11 @@ 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>
 }