@kubb/plugin-oas 3.0.0-alpha.9 → 3.0.0-beta.10

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,27 +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
-    //TODO replace with group
-    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 },
     })
@@ -79,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(
@@ -149,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 { mode, plugin, pluginManager, fileManager } = 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,7 +1,4 @@
-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 {
@@ -13,6 +10,7 @@ export type { SchemaMethodResult } from './SchemaGenerator.ts'
 export { SchemaGenerator } from './SchemaGenerator.ts'
 export type {
   Schema,
+  SchemaTree,
   SchemaKeyword,
   SchemaKeywordBase,
   SchemaKeywordMapper,

package/src/plugin.ts

@@ -1,34 +1,35 @@
-import path from 'node:path'
-
-import { createPlugin } from '@kubb/core'
-import { camelCase } from '@kubb/core/transformers'
+import { FileManager, createPlugin } from '@kubb/core'
 
 import { getSchemas } from './utils/getSchemas.ts'
 import { parseFromConfig } from './utils/parseFromConfig.ts'
 
+import path from 'node:path'
 import type { Config } from '@kubb/core'
 import type { Logger } from '@kubb/core/logger'
-import type { Oas, OasTypes } from '@kubb/oas'
-import type { FormatOptions } from '@kubb/oas/parser'
+import type { Oas } from '@kubb/oas'
+import { OperationGenerator } from './OperationGenerator.ts'
+import { SchemaGenerator } from './SchemaGenerator.ts'
+import { jsonGenerator } from './generators'
 import type { PluginOas } from './types.ts'
 
 export const pluginOasName = 'plugin-oas' satisfies PluginOas['name']
 
 export const pluginOas = createPlugin<PluginOas>((options) => {
   const {
-    output = { path: 'schemas', export: false },
-    experimentalFilter: filter,
-    experimentalSort: sort,
+    output = {
+      path: 'schemas',
+    },
     validate = true,
+    generators = [jsonGenerator],
     serverIndex = 0,
     contentType,
     oasClass,
   } = options
 
-  const getOas = async ({ config, logger, formatOptions }: { config: Config; logger: Logger; formatOptions?: FormatOptions }): Promise<Oas> => {
+  const getOas = async ({ config, logger }: { config: Config; logger: Logger }): Promise<Oas> => {
     try {
       // needs to be in a different variable or the catch here will not work(return of a promise instead)
-      const oas = await parseFromConfig(config, formatOptions, oasClass)
+      const oas = await parseFromConfig(config, oasClass)
 
       if (validate) {
         await oas.valdiate()
@@ -39,29 +40,22 @@ export const pluginOas = createPlugin<PluginOas>((options) => {
       const error = e as Error
 
       logger.emit('warning', error?.message)
-      return parseFromConfig(config, {}, oasClass)
+      return parseFromConfig(config, oasClass)
     }
   }
 
   return {
     name: pluginOasName,
-    output:
-      output === false
-        ? {
-            path: '',
-            exportType: false,
-          }
-        : {
-            exportType: 'barrelNamed',
-            ...output,
-          },
-    options,
+    options: {
+      output,
+      ...options,
+    },
     context() {
       const { config, logger } = this
 
       return {
-        getOas(formatOptions) {
-          return getOas({ config, logger, formatOptions })
+        getOas() {
+          return getOas({ config, logger })
         },
         async getSchemas({ includes } = {}) {
           const oas = await this.getOas()
@@ -69,12 +63,25 @@ export const pluginOas = createPlugin<PluginOas>((options) => {
         },
         async getBaseURL() {
           const oasInstance = await this.getOas()
-          const baseURL = oasInstance.api.servers?.at(serverIndex)?.url
-          return baseURL
+          return oasInstance.api.servers?.at(serverIndex)?.url
         },
         contentType,
       }
     },
+    resolvePath(baseName, pathMode, options) {
+      const root = path.resolve(this.config.root, this.config.output.path)
+      const mode = pathMode ?? FileManager.getMode(path.resolve(root, output.path))
+
+      if (mode === 'single') {
+        /**
+         * when output is a file then we will always append to the same file(output file), see fileManager.addOrAppend
+         * Other plugins then need to call addOrAppend instead of just add from the fileManager class
+         */
+        return path.resolve(root, output.path)
+      }
+
+      return path.resolve(root, output.path, baseName)
+    },
     async buildStart() {
       if (!output) {
         return
@@ -83,39 +90,45 @@ export const pluginOas = createPlugin<PluginOas>((options) => {
       const oas = await getOas({
         config: this.config,
         logger: this.logger,
-        formatOptions: {
-          filterSet: filter,
-          sortSet: sort,
-        },
       })
       await oas.dereference()
 
-      const root = path.resolve(this.config.root, this.config.output.path)
-      const schemas = getSchemas({ oas, contentType })
-
-      const mapSchema = async ([name, schema]: [string, OasTypes.SchemaObject]) => {
-        const baseName = `${camelCase(name)}.json` as `${string}.json`
-        const resolvedPath = path.resolve(root, output.path, baseName)
-
-        await this.addFile({
-          path: resolvedPath,
-          baseName,
-          meta: {
-            pluginKey: this.plugin.key,
-          },
-          sources: [
-            {
-              name: camelCase(name),
-              isExportable: false,
-              isIndexable: false,
-              value: JSON.stringify(schema),
-            },
-          ],
-        })
-      }
+      const schemaGenerator = new SchemaGenerator(
+        {
+          unknownType: 'unknown',
+          dateType: 'date',
+          transformers: {},
+          ...this.plugin.options,
+        },
+        {
+          oas,
+          pluginManager: this.pluginManager,
+          plugin: this.plugin,
+          contentType,
+          include: undefined,
+          override: undefined,
+          mode: 'split',
+          output: output.path,
+        },
+      )
+
+      const schemaFiles = await schemaGenerator.build(...generators)
+      await this.addFile(...schemaFiles)
+
+      const operationGenerator = new OperationGenerator(this.plugin.options, {
+        oas,
+        pluginManager: this.pluginManager,
+        plugin: this.plugin,
+        contentType,
+        exclude: undefined,
+        include: undefined,
+        override: undefined,
+        mode: 'split',
+      })
+
+      const operationFiles = await operationGenerator.build(...generators)
 
-      const promises = Object.entries(schemas).map(mapSchema)
-      await Promise.all(promises)
+      await this.addFile(...operationFiles)
     },
   }
 })

package/src/types.ts

@@ -1,9 +1,9 @@
-import type { Plugin } from '@kubb/core'
+import type { Output, Plugin } from '@kubb/core'
 import type { PluginFactoryOptions, ResolveNameParams } from '@kubb/core'
 import type * as KubbFile from '@kubb/fs/types'
 
 import type { HttpMethod, Oas, Operation, SchemaObject, contentType } from '@kubb/oas'
-import type { FormatOptions } from '@kubb/oas/parser'
+import type { Generator } from './generator.tsx'
 import type { GetSchemasProps } from './utils/getSchemas.ts'
 
 export type ResolvePathOptions = {
@@ -13,7 +13,7 @@ export type ResolvePathOptions = {
 }
 
 export type API = {
-  getOas: (formatOptions?: FormatOptions) => Promise<Oas>
+  getOas: () => Promise<Oas>
   getSchemas: (options?: Pick<GetSchemasProps, 'includes'>) => Promise<Record<string, SchemaObject>>
   getBaseURL: () => Promise<string | undefined>
   contentType?: contentType
@@ -25,18 +25,11 @@ export type Options = {
    * @default true
    */
   validate?: boolean
-  output?:
-    | {
-        /**
-         * Relative path to save the JSON models.
-         * False will not generate the schema JSON's.
-         * @default 'schemas'
-         */
-        path: string
-        extName?: KubbFile.Extname
-        exportType?: 'barrel' | 'barrelNamed' | false
-      }
-    | false
+  /**
+   * Specify the export location for the files and define the behavior of the output
+   * @default { path: 'schemas', barrelType: 'named' }
+   */
+  output?: Output
   /**
    * Which server to use from the array of `servers.url[serverIndex]`
    * @example
@@ -47,24 +40,28 @@ export type Options = {
   serverIndex?: number
   /**
    * Define which contentType should be used.
-   * By default, this is set based on the first used contentType..
+   * By default, this is set based on the contentType being found.
    */
   contentType?: contentType
-  experimentalFilter?: FormatOptions['filterSet']
-  experimentalSort?: FormatOptions['sortSet']
+  /**
+   * Override some behaviour of the Oas class instance, see '@kubb/oas'
+   */
   oasClass?: typeof Oas
+  /**
+   * Define some generators next to the JSON generation
+   */
+  generators?: Array<Generator<PluginOas>>
 }
 
 /**
  * `propertyName` is the ref name + resolved with the nameResolver
- *  @example `import { Pet } from './Pet'`
+ *  @example import { Pet } from './Pet'
  *
  * `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
  * @example import a type(plugin-ts) for a mock file(swagger-faker)
  */
-
 export type Ref = {
   propertyName: string
   originalName: string
@@ -92,7 +89,7 @@ export type OperationSchema = {
   /**
    * OperationName in PascalCase, only being used in OperationGenerator
    */
-  operationName?: string
+  operationName: string
   description?: string
   statusCode?: number
   keys?: string[]
@@ -106,6 +103,7 @@ export type OperationSchemas = {
   headerParams?: OperationSchema & { keysToOmit?: never }
   request?: OperationSchema
   response: OperationSchema
+  responses: Array<OperationSchema>
   statusCodes?: Array<OperationSchema>
   errors?: Array<OperationSchema>
 }
@@ -130,6 +128,11 @@ type ByMethod = {
   type: 'method'
   pattern: HttpMethod | RegExp
 }
+// TODO implement as alternative for ByMethod
+type ByMethods = {
+  type: 'methods'
+  pattern: Array<HttpMethod>
+}
 
 type BySchemaName = {
   type: 'schemaName'
@@ -143,4 +146,8 @@ export type Override<TOptions> = (ByTag | ByOperationId | ByPath | ByMethod | By
   options: Partial<TOptions>
 }
 
-export type PluginOas = PluginFactoryOptions<'plugin-oas', Options, Options, API, never>
+type ResolvedOptions = Options & {
+  output: Output
+}
+
+export type PluginOas = PluginFactoryOptions<'plugin-oas', Options, ResolvedOptions, API, never>

package/src/utils/getParams.ts

@@ -1,10 +1,10 @@
 import { isParameterObject } from '@kubb/oas'
 
+import { camelCase } from '@kubb/core/transformers'
 import type { FunctionParamsAST } from '@kubb/core/utils'
 import type { OasTypes } from '@kubb/oas'
 import type { Params } from '@kubb/react/types'
 import type { OperationSchema } from '../types.ts'
-import { camelCase } from '@kubb/core/transformers'
 /**
  *
  * @deprecated

package/src/utils/getSchemaFactory.ts

@@ -26,7 +26,7 @@ export function getSchemaFactory<TWithRef extends boolean = false>(oas: Oas): (s
     const version = isOpenApiV3_1Document(oas.api) ? '3.1' : '3.0'
 
     return {
-      schema,
+      schema: oas.dereferenceWithRef(schema),
       version,
     } as SchemaResult<TWithRef>
   }

package/src/utils/index.ts

@@ -3,7 +3,6 @@ export { getASTParams, getPathParams } from './getParams.ts'
 export { getSchemaFactory } from './getSchemaFactory.ts'
 export type { GetSchemasProps } from './getSchemas.ts'
 export { getSchemas } from './getSchemas.ts'
-export { refsSorter } from './refSorter.ts'
 export { parseFromConfig } from './parseFromConfig.ts'
 
 export { isOptional } from '@kubb/oas'

package/src/utils/parseFromConfig.ts

@@ -2,35 +2,35 @@ import { resolve } from 'node:path'
 
 import { URLPath } from '@kubb/core/utils'
 
-import { type FormatOptions, parse } from '@kubb/oas/parser'
+import { parse } from '@kubb/oas/parser'
 
 import type { Config } from '@kubb/core'
 import { Oas, type OasTypes } from '@kubb/oas'
 import yaml from '@stoplight/yaml'
 
-export function parseFromConfig(config: Config, options: FormatOptions = {}, oasClass: typeof Oas = Oas): Promise<Oas> {
+export function parseFromConfig(config: Config, oasClass: typeof Oas = Oas): Promise<Oas> {
   if ('data' in config.input) {
     if (typeof config.input.data === 'object') {
       const api: OasTypes.OASDocument = JSON.parse(JSON.stringify(config.input.data)) as OasTypes.OASDocument
-      return parse(api, options, oasClass)
+      return parse(api, oasClass)
     }
 
     try {
       const api: string = yaml.parse(config.input.data as string) as string
 
-      return parse(api, options, oasClass)
+      return parse(api, oasClass)
     } catch (e) {
       /* empty */
     }
 
     const api: OasTypes.OASDocument = JSON.parse(JSON.stringify(config.input.data)) as OasTypes.OASDocument
 
-    return parse(api, options, oasClass)
+    return parse(api, oasClass)
   }
 
   if (new URLPath(config.input.path).isURL) {
-    return parse(config.input.path, options, oasClass)
+    return parse(config.input.path, oasClass)
   }
 
-  return parse(resolve(config.root, config.input.path), options, oasClass)
+  return parse(resolve(config.root, config.input.path), oasClass)
 }