@kubb/plugin-oas 0.0.0-canary-20240806053140 → 0.0.0-canary-20241106205013

package/src/components/Oas.tsx

@@ -4,20 +4,26 @@ import { Operation } from './Operation.tsx'
 import { Schema } from './Schema.tsx'
 
 import type { Oas as OasType, Operation as OperationType } from '@kubb/oas'
-import type { KubbNode } from '@kubb/react'
+import type { KubbNode } from '@kubb/react/types'
 import type { OperationGenerator } from '../OperationGenerator.ts'
 
 type Props = {
   oas: OasType
   operations?: OperationType[]
-  generator?: OperationGenerator
+  /**
+   * @deprecated
+   */
+  generator?: Omit<OperationGenerator, 'build'>
   children?: KubbNode
 }
 
 type OasContextProps = {
   oas?: OasType
   operations?: OperationType[]
-  generator?: OperationGenerator
+  /**
+   * @deprecated
+   */
+  generator?: Omit<OperationGenerator, 'build'>
 }
 
 const OasContext = createContext<OasContextProps>({})

package/src/components/Operation.tsx

@@ -1,7 +1,7 @@
 import { createContext } from '@kubb/react'
 
 import type { Operation as OperationType } from '@kubb/oas'
-import type { KubbNode } from '@kubb/react'
+import type { KubbNode } from '@kubb/react/types'
 
 type Props = {
   operation: OperationType

package/src/components/Schema.tsx

@@ -1,15 +1,8 @@
-import { File, Parser, createContext, useApp, useFile } from '@kubb/react'
+import { createContext } from '@kubb/react'
 
-import { schemaKeywords } from '../SchemaMapper.ts'
-import { useSchema } from '../hooks/useSchema.ts'
-
-import type * as KubbFile from '@kubb/fs/types'
 import type { SchemaObject } from '@kubb/oas'
-import type { KubbNode } from '@kubb/react'
-import type { ReactNode } from 'react'
-import { SchemaGenerator } from '../SchemaGenerator.ts'
+import type { KubbNode } from '@kubb/react/types'
 import type { Schema as SchemaType } from '../SchemaMapper.ts'
-import type { PluginOas } from '../types.ts'
 
 export type SchemaContextProps = {
   name: string
@@ -33,97 +26,4 @@ export function Schema({ name, value, tree = [], children }: Props): KubbNode {
   return <SchemaContext.Provider value={{ name, schema: value, tree }}>{children}</SchemaContext.Provider>
 }
 
-type FileProps = {
-  isTypeOnly?: boolean
-  output: string | undefined
-  children?: KubbNode
-}
-
-Schema.File = function ({ output, isTypeOnly, children }: FileProps): ReactNode {
-  const { plugin, pluginManager, mode } = useApp<PluginOas>()
-  const { name } = useSchema()
-
-  if (mode === 'single') {
-    const baseName = output as KubbFile.BaseName
-    const resolvedPath = pluginManager.resolvePath({
-      baseName: '',
-      pluginKey: plugin.key,
-    })
-
-    if (!resolvedPath) {
-      return null
-    }
-
-    return (
-      <Parser language="typescript">
-        <File
-          baseName={baseName}
-          path={resolvedPath}
-          meta={{
-            pluginKey: plugin.key,
-          }}
-        >
-          {children}
-        </File>
-      </Parser>
-    )
-  }
-
-  const baseName = `${pluginManager.resolveName({
-    name,
-    pluginKey: plugin.key,
-    type: 'file',
-  })}.ts` as const
-  const resolvedPath = pluginManager.resolvePath({
-    baseName,
-    pluginKey: plugin.key,
-  })
-
-  if (!resolvedPath) {
-    return null
-  }
-
-  return (
-    <Parser language="typescript">
-      <File
-        baseName={baseName}
-        path={resolvedPath}
-        meta={{
-          pluginKey: plugin.key,
-        }}
-      >
-        <Schema.Imports isTypeOnly={isTypeOnly} />
-        {children}
-      </File>
-    </Parser>
-  )
-}
-
-type SchemaImportsProps = {
-  isTypeOnly?: boolean
-  extName?: KubbFile.Extname
-}
-
-Schema.Imports = ({ isTypeOnly, extName }: SchemaImportsProps): ReactNode => {
-  const { tree } = useSchema()
-  const { path: root } = useFile()
-
-  const refs = SchemaGenerator.deepSearch(tree, schemaKeywords.ref)
-
-  return (
-    <>
-      {refs
-        ?.map((item, i) => {
-          if (!item.args.path) {
-            return undefined
-          }
-
-          return (
-            <File.Import key={i} extName={extName} root={root} name={[item.args.name]} path={item.args.path} isTypeOnly={item.args.isTypeOnly ?? isTypeOnly} />
-          )
-        })
-        .filter(Boolean)}
-    </>
-  )
-}
 Schema.Context = SchemaContext

package/src/generator.tsx

@@ -0,0 +1,129 @@
+import type { PluginFactoryOptions } from '@kubb/core'
+import type * as KubbFile from '@kubb/fs/types'
+import type { Operation, SchemaObject } from '@kubb/oas'
+import { Oas } from '@kubb/plugin-oas/components'
+import { App, createRoot } from '@kubb/react'
+import type { KubbNode } from '@kubb/react/types'
+import type { OperationGenerator } from './OperationGenerator.ts'
+import type { SchemaGenerator, SchemaGeneratorOptions } from './SchemaGenerator.ts'
+import type { Schema } from './SchemaMapper.ts'
+import type { OperationsByMethod } from './types.ts'
+
+type OperationsProps<TOptions extends PluginFactoryOptions> = {
+  instance: Omit<OperationGenerator<TOptions>, 'build'>
+  options: TOptions['resolvedOptions']
+  operations: Array<Operation>
+  operationsByMethod: OperationsByMethod
+}
+
+type OperationProps<TOptions extends PluginFactoryOptions> = {
+  instance: Omit<OperationGenerator<TOptions>, 'build'>
+  options: TOptions['resolvedOptions']
+  operation: Operation
+}
+
+type SchemaProps<TOptions extends PluginFactoryOptions> = {
+  instance: Omit<SchemaGenerator<SchemaGeneratorOptions, TOptions>, 'build'>
+  options: TOptions['resolvedOptions']
+  schema: {
+    name: string
+    tree: Array<Schema>
+    value: SchemaObject
+  }
+}
+
+export type GeneratorOptions<TOptions extends PluginFactoryOptions> = {
+  name: string
+  operations?: (this: GeneratorOptions<TOptions>, props: OperationsProps<TOptions>) => Promise<KubbFile.File[]>
+  operation?: (this: GeneratorOptions<TOptions>, props: OperationProps<TOptions>) => Promise<KubbFile.File[]>
+  schema?: (this: GeneratorOptions<TOptions>, props: SchemaProps<TOptions>) => Promise<KubbFile.File[]>
+}
+
+export type Generator<TOptions extends PluginFactoryOptions> = GeneratorOptions<TOptions>
+
+export function createGenerator<TOptions extends PluginFactoryOptions>(parseOptions: GeneratorOptions<TOptions>): Generator<TOptions> {
+  return parseOptions
+}
+
+export type ReactGeneratorOptions<TOptions extends PluginFactoryOptions> = {
+  name: string
+  Operations?: (this: ReactGeneratorOptions<TOptions>, props: OperationsProps<TOptions>) => KubbNode
+  Operation?: (this: ReactGeneratorOptions<TOptions>, props: OperationProps<TOptions>) => KubbNode
+  Schema?: (this: ReactGeneratorOptions<TOptions>, props: SchemaProps<TOptions>) => KubbNode
+}
+
+export function createReactGenerator<TOptions extends PluginFactoryOptions>(parseOptions: ReactGeneratorOptions<TOptions>): Generator<TOptions> {
+  return {
+    ...parseOptions,
+    async operations({ instance, options, operations, operationsByMethod }) {
+      if (!parseOptions.Operations) {
+        return []
+      }
+
+      const { pluginManager, oas, plugin, mode } = instance.context
+      const root = createRoot({
+        logger: pluginManager.logger,
+      })
+
+      const Component = parseOptions.Operations.bind(this)
+
+      root.render(
+        <App pluginManager={pluginManager} plugin={plugin} mode={mode}>
+          <Oas oas={oas} operations={operations} generator={instance}>
+            <Component operations={operations} instance={instance} operationsByMethod={operationsByMethod} options={options} />
+          </Oas>
+        </App>,
+      )
+
+      return root.files
+    },
+    async operation({ instance, operation, options }) {
+      if (!parseOptions.Operation) {
+        return []
+      }
+
+      const { pluginManager, oas, plugin, mode } = instance.context
+      const root = createRoot({
+        logger: pluginManager.logger,
+      })
+
+      const Component = parseOptions.Operation.bind(this)
+
+      root.render(
+        <App pluginManager={pluginManager} plugin={{ ...plugin, options }} mode={mode}>
+          <Oas oas={oas} operations={[operation]} generator={instance}>
+            <Oas.Operation operation={operation}>
+              <Component operation={operation} options={options} instance={instance} />
+            </Oas.Operation>
+          </Oas>
+        </App>,
+      )
+
+      return root.files
+    },
+    async schema({ instance, schema, options }) {
+      if (!parseOptions.Schema) {
+        return []
+      }
+
+      const { pluginManager, oas, plugin, mode } = instance.context
+      const root = createRoot({
+        logger: pluginManager.logger,
+      })
+
+      const Component = parseOptions.Schema.bind(this)
+
+      root.render(
+        <App pluginManager={pluginManager} plugin={{ ...plugin, options }} mode={mode}>
+          <Oas oas={oas}>
+            <Oas.Schema name={schema.name} value={schema.value} tree={schema.tree}>
+              <Component schema={schema} options={options} instance={instance} />
+            </Oas.Schema>
+          </Oas>
+        </App>,
+      )
+
+      return root.files
+    },
+  }
+}

package/src/generators/index.ts

@@ -0,0 +1 @@
+export { jsonGenerator } from './jsonGenerator.ts'

package/src/generators/jsonGenerator.ts

@@ -0,0 +1,32 @@
+import { camelCase } from '@kubb/core/transformers'
+import { createGenerator } from '../generator.tsx'
+import type { PluginOas } from '../types.ts'
+
+export const jsonGenerator = createGenerator<PluginOas>({
+  name: 'plugin-oas',
+  async schema({ schema, instance }) {
+    const { pluginManager, plugin } = instance.context
+    const file = pluginManager.getFile({
+      name: camelCase(schema.name),
+      extname: '.json',
+      mode: 'split',
+      pluginKey: plugin.key,
+    })
+
+    return [
+      {
+        ...file,
+        sources: [
+          {
+            name: camelCase(schema.name),
+            isExportable: false,
+            isIndexable: false,
+            value: JSON.stringify(schema.value),
+          },
+        ],
+        banner: plugin.options.output?.banner,
+        format: plugin.options.output?.footer,
+      },
+    ]
+  },
+})

package/src/hooks/index.ts

@@ -1,5 +1,7 @@
 export { useOas } from './useOas.ts'
 export { useOperation } from './useOperation.ts'
 export { useOperationManager } from './useOperationManager.ts'
+export type { SchemaNames } from './useOperationManager.ts'
 export { useOperations } from './useOperations.ts'
 export { useSchema } from './useSchema.ts'
+export { useSchemaManager } from './useSchemaManager.ts'

package/src/hooks/useOperationManager.ts

@@ -13,7 +13,7 @@ type FileMeta = FileMetaBase & {
   tag?: string
 }
 
-type SchemaNames = {
+export type SchemaNames = {
   request: string | undefined
   parameters: {
     path: string | undefined
@@ -25,14 +25,33 @@ type SchemaNames = {
 }
 
 type UseOperationManagerResult = {
-  getName: (operation: OperationType, params: { pluginKey?: Plugin['key']; type: ResolveNameParams['type'] }) => string
-  getFile: (operation: OperationType, params?: { pluginKey?: Plugin['key']; extName?: KubbFile.Extname }) => KubbFile.File<FileMeta>
-  groupSchemasByName: (operation: OperationType, params: { pluginKey?: Plugin['key']; type: ResolveNameParams['type'] }) => SchemaNames
-  getSchemas: (
-    operation: Operation,
-    params?: { pluginKey?: Plugin['key']; type?: ResolveNameParams['type'] },
-    forStatusCode?: string | number,
-  ) => OperationSchemas
+  getName: (
+    operation: OperationType,
+    params: {
+      prefix?: string
+      suffix?: string
+      pluginKey?: Plugin['key']
+      type: ResolveNameParams['type']
+    },
+  ) => string
+  getFile: (
+    operation: OperationType,
+    params?: {
+      prefix?: string
+      suffix?: string
+      pluginKey?: Plugin['key']
+      extname?: KubbFile.Extname
+      tag?: string
+    },
+  ) => KubbFile.File<FileMeta>
+  groupSchemasByName: (
+    operation: OperationType,
+    params: {
+      pluginKey?: Plugin['key']
+      type: ResolveNameParams['type']
+    },
+  ) => SchemaNames
+  getSchemas: (operation: Operation, params?: { pluginKey?: Plugin['key']; type?: ResolveNameParams['type'] }) => OperationSchemas
 }
 
 /**
@@ -42,26 +61,38 @@ export function useOperationManager(): UseOperationManagerResult {
   const { plugin, pluginManager } = useApp()
   const { generator } = useContext(Oas.Context)
 
-  if (!generator) {
-    throw new Error(`'generator' is not defined`)
-  }
-
-  const getName: UseOperationManagerResult['getName'] = (operation, { pluginKey = plugin.key, type }) => {
+  const getName: UseOperationManagerResult['getName'] = (operation, { prefix = '', suffix = '', pluginKey = plugin.key, type }) => {
     return pluginManager.resolveName({
-      name: operation.getOperationId(),
+      name: `${prefix} ${operation.getOperationId()} ${suffix}`,
       pluginKey,
       type,
     })
   }
 
-  const getFile: UseOperationManagerResult['getFile'] = (operation, { pluginKey = plugin.key, extName = '.ts' } = {}) => {
-    // needed for the `output.group`
-    const tag = operation.getTags().at(0)?.name
-    const name = getName(operation, { type: 'file', pluginKey })
+  const getSchemas: UseOperationManagerResult['getSchemas'] = (operation, params) => {
+    if (!generator) {
+      throw new Error(`'generator' is not defined`)
+    }
 
+    return generator.getSchemas(operation, {
+      resolveName: (name) =>
+        pluginManager.resolveName({
+          name,
+          pluginKey: params?.pluginKey,
+          type: params?.type,
+        }),
+    })
+  }
+
+  //TODO replace tag with group
+  const getFile: UseOperationManagerResult['getFile'] = (
+    operation,
+    { prefix, suffix, pluginKey = plugin.key, tag = operation.getTags().at(0)?.name, extname = '.ts' } = {},
+  ) => {
+    const name = getName(operation, { type: 'file', pluginKey, prefix, suffix })
     const file = pluginManager.getFile({
       name,
-      extName,
+      extname,
       pluginKey,
       options: { type: 'file', pluginKey, tag },
     })
@@ -78,6 +109,10 @@ export function useOperationManager(): UseOperationManagerResult {
   }
 
   const groupSchemasByName: UseOperationManagerResult['groupSchemasByName'] = (operation, { pluginKey = plugin.key, type }) => {
+    if (!generator) {
+      throw new Error(`'generator' is not defined`)
+    }
+
     const schemas = generator.getSchemas(operation)
 
     const errors = (schemas.errors || []).reduce(
@@ -148,16 +183,7 @@ export function useOperationManager(): UseOperationManagerResult {
   return {
     getName,
     getFile,
-    getSchemas: (operation, params, forStatusCode) =>
-      generator.getSchemas(operation, {
-        forStatusCode,
-        resolveName: (name) =>
-          pluginManager.resolveName({
-            name,
-            pluginKey: params?.pluginKey,
-            type: params?.type,
-          }),
-      }),
+    getSchemas,
     groupSchemasByName,
   }
 }

package/src/hooks/useSchemaManager.ts

@@ -0,0 +1,77 @@
+import { useApp } from '@kubb/react'
+
+import type { FileMetaBase, Plugin, ResolveNameParams } from '@kubb/core'
+import type * as KubbFile from '@kubb/fs/types'
+import type { Mode } from '@kubb/fs/types'
+import { SchemaGenerator } from '../SchemaGenerator.ts'
+import { type Schema, schemaKeywords } from '../SchemaMapper'
+
+type FileMeta = FileMetaBase & {
+  pluginKey: Plugin['key']
+  name: string
+  tag?: string
+}
+
+type UseSchemaManagerResult = {
+  getName: (name: string, params: { pluginKey?: Plugin['key']; type: ResolveNameParams['type'] }) => string
+  getFile: (name: string, params?: { pluginKey?: Plugin['key']; mode?: Mode; extname?: KubbFile.Extname; tag?: string }) => KubbFile.File<FileMeta>
+  getImports: (tree: Array<Schema>) => Array<KubbFile.Import>
+}
+
+/**
+ * `useSchemaManager` will return some helper functions that can be used to get the schema file, get the schema name.
+ */
+export function useSchemaManager(): UseSchemaManagerResult {
+  const { plugin, pluginManager } = useApp()
+
+  const getName: UseSchemaManagerResult['getName'] = (name, { pluginKey = plugin.key, type }) => {
+    return pluginManager.resolveName({
+      name,
+      pluginKey,
+      type,
+    })
+  }
+  //TODO replace tag with group
+  const getFile: UseSchemaManagerResult['getFile'] = (name, { mode = 'split', pluginKey = plugin.key, extname = '.ts', tag } = {}) => {
+    const resolvedName = mode === 'single' ? '' : getName(name, { type: 'file', pluginKey })
+
+    const file = pluginManager.getFile({
+      name: resolvedName,
+      extname,
+      pluginKey,
+      options: { type: 'file', pluginKey, tag },
+    })
+
+    return {
+      ...file,
+      meta: {
+        ...file.meta,
+        name: resolvedName,
+        pluginKey,
+      },
+    }
+  }
+
+  const getImports: UseSchemaManagerResult['getImports'] = (tree) => {
+    const refs = SchemaGenerator.deepSearch(tree, schemaKeywords.ref)
+
+    return refs
+      ?.map((item, i) => {
+        if (!item.args.path || !item.args.isImportable) {
+          return undefined
+        }
+
+        return {
+          name: [item.args.name],
+          path: item.args.path,
+        }
+      })
+      .filter(Boolean)
+  }
+
+  return {
+    getName,
+    getFile,
+    getImports,
+  }
+}

package/src/index.ts

@@ -1,9 +1,4 @@
-import { pluginOas } from './plugin.ts'
-
-export type {
-  GetOperationGeneratorOptions,
-  OperationMethodResult,
-} from './OperationGenerator.ts'
+export type { OperationMethodResult } from './OperationGenerator.ts'
 export { OperationGenerator } from './OperationGenerator.ts'
 export { pluginOas, pluginOasName } from './plugin.ts'
 export type {
@@ -15,6 +10,7 @@ export type { SchemaMethodResult } from './SchemaGenerator.ts'
 export { SchemaGenerator } from './SchemaGenerator.ts'
 export type {
   Schema,
+  SchemaTree,
   SchemaKeyword,
   SchemaKeywordBase,
   SchemaKeywordMapper,
@@ -22,10 +18,6 @@ export type {
 } from './SchemaMapper.ts'
 export { isKeyword, schemaKeywords } from './SchemaMapper.ts'
 export type * from './types.ts'
-
-/**
- * @deprecated Use `import { pluginOas } from '@kubb/plugin-oas'` instead
- */
-const definePluginDefault = pluginOas
-
-export default definePluginDefault
+export { createGenerator, createReactGenerator } from './generator.tsx'
+export type { ReactGeneratorOptions } from './generator.tsx'
+export type { Generator, GeneratorOptions } from './generator.tsx'