@kubb/plugin-oas 3.0.0-alpha.13 → 3.0.0-alpha.14

package/dist/utils.cjs

@@ -1,7 +1,7 @@
 'use strict';
 
-var chunkG35AGMCZ_cjs = require('./chunk-G35AGMCZ.cjs');
-var chunkJRZ3YURA_cjs = require('./chunk-JRZ3YURA.cjs');
+var chunk2S2QRJPN_cjs = require('./chunk-2S2QRJPN.cjs');
+var chunkXELSZPJC_cjs = require('./chunk-XELSZPJC.cjs');
 var transformers = require('@kubb/core/transformers');
 var utils = require('@kubb/core/utils');
 var oas = require('@kubb/oas');
@@ -11,10 +11,10 @@ function _interopDefault (e) { return e && e.__esModule ? e : { default: e }; }
 var transformers__default = /*#__PURE__*/_interopDefault(transformers);
 
 // src/utils/index.ts
-chunkJRZ3YURA_cjs.init_cjs_shims();
+chunkXELSZPJC_cjs.init_cjs_shims();
 
 // src/utils/getComments.ts
-chunkJRZ3YURA_cjs.init_cjs_shims();
+chunkXELSZPJC_cjs.init_cjs_shims();
 function getComments(operation) {
   return [
     operation.getDescription() && `@description ${operation.getDescription()}`,
@@ -25,7 +25,7 @@ function getComments(operation) {
 }
 
 // src/utils/getParams.ts
-chunkJRZ3YURA_cjs.init_cjs_shims();
+chunkXELSZPJC_cjs.init_cjs_shims();
 function getASTParams(operationSchema, {
   typed = false,
   override
@@ -58,7 +58,7 @@ function getPathParams(operationSchema, options = {}) {
 }
 
 // src/utils/refSorter.ts
-chunkJRZ3YURA_cjs.init_cjs_shims();
+chunkXELSZPJC_cjs.init_cjs_shims();
 function refsSorter(a, b) {
   if (Object.keys(a.import.refs)?.length < Object.keys(b.import.refs)?.length) {
     return -1;
@@ -71,15 +71,15 @@ function refsSorter(a, b) {
 
 Object.defineProperty(exports, "parseFromConfig", {
   enumerable: true,
-  get: function () { return chunkG35AGMCZ_cjs.parseFromConfig; }
+  get: function () { return chunk2S2QRJPN_cjs.parseFromConfig; }
 });
 Object.defineProperty(exports, "getSchemaFactory", {
   enumerable: true,
-  get: function () { return chunkJRZ3YURA_cjs.getSchemaFactory; }
+  get: function () { return chunkXELSZPJC_cjs.getSchemaFactory; }
 });
 Object.defineProperty(exports, "getSchemas", {
   enumerable: true,
-  get: function () { return chunkJRZ3YURA_cjs.getSchemas; }
+  get: function () { return chunkXELSZPJC_cjs.getSchemas; }
 });
 Object.defineProperty(exports, "isOptional", {
   enumerable: true,

package/dist/utils.d.cts

@@ -2,8 +2,8 @@ import { Operation, Oas, SchemaObject, OpenAPIV3, OpenAPIV3_1 } from '@kubb/oas'
 export { isOptional } from '@kubb/oas';
 import { FunctionParamsAST } from '@kubb/core/utils';
 import { Params } from '@kubb/react/types';
-import { d as OperationSchema, b as Refs } from './types-CZTUCaE5.cjs';
-export { G as GetSchemasProps, h as getSchemas } from './types-CZTUCaE5.cjs';
+import { v as OperationSchema, t as Refs } from './OperationGenerator-BqfyX5-8.cjs';
+export { z as GetSchemasProps, B as getSchemas } from './OperationGenerator-BqfyX5-8.cjs';
 import { FormatOptions } from '@kubb/oas/parser';
 import { Config } from '@kubb/core';
 import '@kubb/fs/types';

package/dist/utils.d.ts

@@ -2,8 +2,8 @@ import { Operation, Oas, SchemaObject, OpenAPIV3, OpenAPIV3_1 } from '@kubb/oas'
 export { isOptional } from '@kubb/oas';
 import { FunctionParamsAST } from '@kubb/core/utils';
 import { Params } from '@kubb/react/types';
-import { d as OperationSchema, b as Refs } from './types-CZTUCaE5.js';
-export { G as GetSchemasProps, h as getSchemas } from './types-CZTUCaE5.js';
+import { v as OperationSchema, t as Refs } from './OperationGenerator-BqfyX5-8.js';
+export { z as GetSchemasProps, B as getSchemas } from './OperationGenerator-BqfyX5-8.js';
 import { FormatOptions } from '@kubb/oas/parser';
 import { Config } from '@kubb/core';
 import '@kubb/fs/types';

package/dist/utils.js

@@ -1,6 +1,6 @@
-export { parseFromConfig } from './chunk-TEEWKGS3.js';
-import { init_esm_shims } from './chunk-NW6726BC.js';
-export { getSchemaFactory, getSchemas } from './chunk-NW6726BC.js';
+export { parseFromConfig } from './chunk-OSKSFHO2.js';
+import { init_esm_shims } from './chunk-E2Z4IRAI.js';
+export { getSchemaFactory, getSchemas } from './chunk-E2Z4IRAI.js';
 import transformers, { camelCase } from '@kubb/core/transformers';
 import { URLPath } from '@kubb/core/utils';
 import { isParameterObject } from '@kubb/oas';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kubb/plugin-oas",
-  "version": "3.0.0-alpha.13",
+  "version": "3.0.0-alpha.14",
   "description": "Generator swagger",
   "keywords": [
     "typescript",
@@ -25,6 +25,11 @@
       "require": "./dist/index.cjs",
       "default": "./dist/index.cjs"
     },
+    "./generators": {
+      "import": "./dist/generators.js",
+      "require": "./dist/generators.cjs",
+      "default": "./dist/generators.cjs"
+    },
     "./utils": {
       "import": "./dist/utils.js",
       "require": "./dist/utils.cjs",
@@ -56,6 +61,9 @@
       ],
       "components": [
         "./dist/components.d.ts"
+      ],
+      "generators": [
+        "./dist/generators.d.ts"
       ]
     }
   },
@@ -68,11 +76,11 @@
   "dependencies": {
     "@stoplight/yaml": "^4.3.0",
     "execa": "^9.3.1",
-    "remeda": "^2.11.0",
-    "@kubb/core": "3.0.0-alpha.13",
-    "@kubb/fs": "3.0.0-alpha.13",
-    "@kubb/oas": "3.0.0-alpha.13",
-    "@kubb/react": "3.0.0-alpha.13"
+    "remeda": "^2.12.0",
+    "@kubb/core": "3.0.0-alpha.14",
+    "@kubb/fs": "3.0.0-alpha.14",
+    "@kubb/oas": "3.0.0-alpha.14",
+    "@kubb/react": "3.0.0-alpha.14"
   },
   "devDependencies": {
     "@types/react": "^18.3.5",
@@ -80,12 +88,12 @@
     "react": "^18.3.1",
     "tsup": "^8.2.4",
     "typescript": "^5.5.4",
-    "@kubb/config-biome": "3.0.0-alpha.13",
-    "@kubb/config-ts": "3.0.0-alpha.13",
-    "@kubb/config-tsup": "3.0.0-alpha.13"
+    "@kubb/config-biome": "3.0.0-alpha.14",
+    "@kubb/config-ts": "3.0.0-alpha.14",
+    "@kubb/config-tsup": "3.0.0-alpha.14"
   },
   "peerDependencies": {
-    "@kubb/react": "3.0.0-alpha.13"
+    "@kubb/react": "3.0.0-alpha.14"
   },
   "engines": {
     "node": ">=20"

package/src/components/Schema.tsx

@@ -3,7 +3,6 @@ import { File, createContext, useApp, useFile } 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/types'
 import type { ReactNode } from 'react'
@@ -39,7 +38,7 @@ type FileProps = {
   children?: KubbNode
 }
 
-Schema.File = function ({ output, isTypeOnly, children }: FileProps): ReactNode {
+Schema.File = function ({ isTypeOnly, children }: FileProps): ReactNode {
   const { plugin, pluginManager, mode } = useApp<PluginOas>()
   const { name } = useSchema()
 

package/src/generators/index.ts

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

package/src/generators/jsonGenerator.ts

@@ -0,0 +1,30 @@
+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, name, instance }) {
+    const { pluginManager, plugin } = instance.context
+    const file = pluginManager.getFile({
+      name: camelCase(name),
+      extName: '.json',
+      mode: 'split',
+      pluginKey: plugin.key,
+    })
+
+    return [
+      {
+        ...file,
+        sources: [
+          {
+            name: camelCase(name),
+            isExportable: false,
+            isIndexable: false,
+            value: JSON.stringify(schema),
+          },
+        ],
+      },
+    ]
+  },
+})

package/src/plugin.ts

@@ -1,25 +1,31 @@
-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 { Oas } from '@kubb/oas'
 import type { FormatOptions } from '@kubb/oas/parser'
+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 },
+    output = {
+      path: 'schemas',
+      export: false,
+      exportType: 'barrelNamed',
+    },
     experimentalFilter: filter,
     experimentalSort: sort,
     validate = true,
+    generators = [jsonGenerator],
     serverIndex = 0,
     contentType,
     oasClass,
@@ -45,16 +51,7 @@ export const pluginOas = createPlugin<PluginOas>((options) => {
 
   return {
     name: pluginOasName,
-    output:
-      output === false
-        ? {
-            path: '',
-            exportType: false,
-          }
-        : {
-            exportType: 'barrelNamed',
-            ...output,
-          },
+    output,
     options,
     context() {
       const { config, logger } = this
@@ -69,12 +66,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
@@ -90,32 +100,42 @@ export const pluginOas = createPlugin<PluginOas>((options) => {
       })
       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

@@ -4,6 +4,7 @@ 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 = {
@@ -25,18 +26,16 @@ 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
+  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
+  }
   /**
    * Which server to use from the array of `servers.url[serverIndex]`
    * @example
@@ -52,7 +51,14 @@ export type Options = {
   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>>
 }
 
 /**

package/dist/OperationGenerator-By5WOmWB.d.ts

@@ -1,165 +0,0 @@
-import { FileMetaBase, ResolveNameParams, PluginFactoryOptions, BaseGenerator, PluginManager, Plugin } from '@kubb/core';
-import * as KubbFile from '@kubb/fs/types';
-import { SchemaObject, Oas, contentType, Operation } from '@kubb/oas';
-import { KubbNode } from '@kubb/react/types';
-import { d as OperationSchema, b as Refs, g as Override, f as OperationsByMethod, e as OperationSchemas, E as Exclude, I as Include } from './types-CZTUCaE5.js';
-import { S as Schema, c as SchemaKeywordMapper } from './SchemaMapper-sGcY1xL5.js';
-
-type GetSchemaGeneratorOptions<T extends SchemaGenerator<any, any, any>> = T extends SchemaGenerator<infer Options, any, any> ? Options : never;
-type SchemaMethodResult<TFileMeta extends FileMetaBase> = Promise<KubbFile.File<TFileMeta> | Array<KubbFile.File<TFileMeta>> | null>;
-type Context$1<TOptions, TPluginOptions extends PluginFactoryOptions> = {
-    oas: Oas;
-    pluginManager: PluginManager;
-    /**
-     * Current plugin
-     */
-    plugin: Plugin<TPluginOptions>;
-    mode: KubbFile.Mode;
-    include?: Array<'schemas' | 'responses' | 'requestBodies'>;
-    override: Array<Override<TOptions>> | undefined;
-    contentType?: contentType;
-    output?: string;
-};
-type SchemaGeneratorOptions = {
-    dateType: false | 'string' | 'stringOffset' | 'stringLocal' | 'date';
-    unknownType: 'any' | 'unknown';
-    enumType?: 'enum' | 'asConst' | 'asPascalConst' | 'constEnum' | 'literal';
-    enumSuffix?: string;
-    usedEnumNames?: Record<string, number>;
-    mapper?: Record<string, string>;
-    typed?: boolean;
-    transformers: {
-        /**
-         * Customize the names based on the type that is provided by the plugin.
-         */
-        name?: (name: ResolveNameParams['name'], type?: ResolveNameParams['type']) => string;
-        /**
-         * Receive schema and name(propertName) and return FakerMeta array
-         * TODO TODO add docs
-         * @beta
-         */
-        schema?: (schemaProps: SchemaProps$1, defaultSchemas: Schema[]) => Schema[] | undefined;
-    };
-};
-type SchemaGeneratorBuildOptions = Omit<OperationSchema, 'name' | 'schema'>;
-type SchemaProps$1 = {
-    schema?: SchemaObject;
-    name?: string;
-    parentName?: string;
-};
-declare class SchemaGenerator<TOptions extends SchemaGeneratorOptions = SchemaGeneratorOptions, TPluginOptions extends PluginFactoryOptions = PluginFactoryOptions, TFileMeta extends FileMetaBase = FileMetaBase> extends BaseGenerator<TOptions, Context$1<TOptions, TPluginOptions>> {
-    #private;
-    refs: Refs;
-    /**
-     * Creates a type node from a given schema.
-     * Delegates to getBaseTypeFromSchema internally and
-     * optionally adds a union with null.
-     */
-    parse(props: SchemaProps$1): Schema[];
-    deepSearch<T extends keyof SchemaKeywordMapper>(tree: Schema[] | undefined, keyword: T): SchemaKeywordMapper[T][];
-    find<T extends keyof SchemaKeywordMapper>(tree: Schema[] | undefined, keyword: T): SchemaKeywordMapper[T] | undefined;
-    static deepSearch<T extends keyof SchemaKeywordMapper>(tree: Schema[] | undefined, keyword: T): SchemaKeywordMapper[T][];
-    static findInObject<T extends keyof SchemaKeywordMapper>(tree: Schema[] | undefined, keyword: T): SchemaKeywordMapper[T] | undefined;
-    static find<T extends keyof SchemaKeywordMapper>(tree: Schema[] | undefined, keyword: T): SchemaKeywordMapper[T] | undefined;
-    build(...generators: Array<Generator<Extract<TOptions, PluginFactoryOptions>>>): Promise<Array<KubbFile.File<TFileMeta>>>;
-    /**
-     * Schema
-     */
-    schema(name: string, object: SchemaObject, options: TOptions): SchemaMethodResult<TFileMeta>;
-}
-
-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'>;
-    name: string;
-    schema: SchemaObject;
-    options: TOptions['resolvedOptions'];
-};
-type GeneratorOptions<TOptions extends PluginFactoryOptions> = {
-    name: string;
-    operations?: (props: OperationsProps<TOptions>) => Promise<KubbFile.File[]>;
-    operation?: (props: OperationProps<TOptions>) => Promise<KubbFile.File[]>;
-    schema?: (props: SchemaProps<TOptions>) => Promise<KubbFile.File[]>;
-};
-type Generator<TOptions extends PluginFactoryOptions> = GeneratorOptions<TOptions>;
-declare function createGenerator<TOptions extends PluginFactoryOptions>(parseOptions: GeneratorOptions<TOptions>): Generator<TOptions>;
-type ReactGeneratorOptions<TOptions extends PluginFactoryOptions> = {
-    name: string;
-    Operations?: (props: OperationsProps<TOptions>) => KubbNode;
-    Operation?: (props: OperationProps<TOptions>) => KubbNode;
-    Schema?: (props: SchemaProps<TOptions>) => KubbNode;
-    /**
-     * Combine all react nodes and only render ones(to string or render)
-     */
-    render?: () => any;
-};
-declare function createReactGenerator<TOptions extends PluginFactoryOptions>(parseOptions: ReactGeneratorOptions<TOptions>): Generator<TOptions>;
-
-/**
- * @deprecated
- */
-type GetOperationGeneratorOptions<T extends OperationGenerator<any, any, any>> = T extends OperationGenerator<infer Options, any, any> ? Options : never;
-type OperationMethodResult<TFileMeta extends FileMetaBase> = Promise<KubbFile.File<TFileMeta> | Array<KubbFile.File<TFileMeta>> | null>;
-type Context<TOptions, TPluginOptions extends PluginFactoryOptions> = {
-    oas: Oas;
-    exclude: Array<Exclude> | undefined;
-    include: Array<Include> | undefined;
-    override: Array<Override<TOptions>> | undefined;
-    contentType: contentType | undefined;
-    pluginManager: PluginManager;
-    /**
-     * Current plugin
-     */
-    plugin: Plugin<TPluginOptions>;
-    mode: KubbFile.Mode;
-};
-declare class OperationGenerator<TOptions = unknown, TPluginOptions extends PluginFactoryOptions = PluginFactoryOptions, TFileMeta extends FileMetaBase = FileMetaBase> extends BaseGenerator<TOptions, Context<TOptions, TPluginOptions>> {
-    #private;
-    get operationsByMethod(): OperationsByMethod;
-    set operationsByMethod(paths: OperationsByMethod);
-    getSchemas(operation: Operation, { forStatusCode, resolveName, }?: {
-        forStatusCode?: string | number;
-        resolveName?: (name: string) => string;
-    }): OperationSchemas;
-    build(...generators: Array<Generator<Extract<TOptions, PluginFactoryOptions>>>): Promise<Array<KubbFile.File<TFileMeta>>>;
-    /**
-     * Operation
-     */
-    operation(operation: Operation, options: TOptions): OperationMethodResult<TFileMeta>;
-    /**
-     * GET
-     */
-    get(operation: Operation, options: TOptions): OperationMethodResult<TFileMeta>;
-    /**
-     * POST
-     */
-    post(operation: Operation, options: TOptions): OperationMethodResult<TFileMeta>;
-    /**
-     * PATCH
-     */
-    patch(operation: Operation, options: TOptions): OperationMethodResult<TFileMeta>;
-    /**
-     * PUT
-     */
-    put(operation: Operation, options: TOptions): OperationMethodResult<TFileMeta>;
-    /**
-     * DELETE
-     */
-    delete(operation: Operation, options: TOptions): OperationMethodResult<TFileMeta>;
-    /**
-     * Combination of GET, POST, PATCH, PUT, DELETE
-     */
-    all(operations: Operation[], paths: OperationsByMethod): OperationMethodResult<TFileMeta>;
-}
-
-export { type GetOperationGeneratorOptions as G, type OperationMethodResult as O, type ReactGeneratorOptions as R, type SchemaGeneratorBuildOptions as S, OperationGenerator as a, type GetSchemaGeneratorOptions as b, type SchemaGeneratorOptions as c, type SchemaMethodResult as d, SchemaGenerator as e, createGenerator as f, createReactGenerator as g, type Generator as h, type GeneratorOptions as i };