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

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'
+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

@@ -1,8 +1,8 @@
 export { getComments } from './getComments.ts'
-export { getGroupedByTagFiles } from './getGroupedByTagFiles.ts'
 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)
 }

package/dist/OperationGenerator-D7rSlflc.d.cts

@@ -1,158 +0,0 @@
-import { FileMetaBase, ResolveNameParams, PluginFactoryOptions, Generator, PluginManager, Plugin } from '@kubb/core';
-import * as KubbFile from '@kubb/fs/types';
-import { SchemaObject, Oas, contentType, Operation } from '@kubb/oas';
-import { d as OperationSchema, b as Refs, g as Override, f as OperationsByMethod, e as OperationSchemas, E as Exclude, I as Include } from './types-C2RXaY0_.cjs';
-import { KubbNode } from '@kubb/react';
-import { S as Schema, c as SchemaKeywordMapper } from './SchemaMapper-BM1IGWqD.cjs';
-
-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 Generator<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(...parsers: Array<Parser<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 ParserOptions<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 Parser<TOptions extends PluginFactoryOptions> = ParserOptions<TOptions>;
-declare function createParser<TOptions extends PluginFactoryOptions>(parseOptions: ParserOptions<TOptions>): Parser<TOptions>;
-type ParserReactOptions<TOptions extends PluginFactoryOptions> = {
-    name: string;
-    Operations?: (props: OperationsProps<TOptions>) => KubbNode;
-    Operation?: (props: OperationProps<TOptions>) => KubbNode;
-    Schema?: (props: SchemaProps<TOptions>) => KubbNode;
-};
-declare function createReactParser<TOptions extends PluginFactoryOptions>(parseOptions: ParserReactOptions<TOptions>): Parser<TOptions>;
-
-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 Generator<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(...parsers: Array<Parser<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 ParserReactOptions as P, type SchemaGeneratorBuildOptions as S, OperationGenerator as a, type GetSchemaGeneratorOptions as b, type SchemaGeneratorOptions as c, type SchemaMethodResult as d, SchemaGenerator as e, createParser as f, createReactParser as g, type Parser as h, type ParserOptions as i };

package/dist/OperationGenerator-vw0Zf-Mi.d.ts

@@ -1,158 +0,0 @@
-import { FileMetaBase, ResolveNameParams, PluginFactoryOptions, Generator, PluginManager, Plugin } from '@kubb/core';
-import * as KubbFile from '@kubb/fs/types';
-import { SchemaObject, Oas, contentType, Operation } from '@kubb/oas';
-import { d as OperationSchema, b as Refs, g as Override, f as OperationsByMethod, e as OperationSchemas, E as Exclude, I as Include } from './types-C2RXaY0_.js';
-import { KubbNode } from '@kubb/react';
-import { S as Schema, c as SchemaKeywordMapper } from './SchemaMapper-BM1IGWqD.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 Generator<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(...parsers: Array<Parser<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 ParserOptions<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 Parser<TOptions extends PluginFactoryOptions> = ParserOptions<TOptions>;
-declare function createParser<TOptions extends PluginFactoryOptions>(parseOptions: ParserOptions<TOptions>): Parser<TOptions>;
-type ParserReactOptions<TOptions extends PluginFactoryOptions> = {
-    name: string;
-    Operations?: (props: OperationsProps<TOptions>) => KubbNode;
-    Operation?: (props: OperationProps<TOptions>) => KubbNode;
-    Schema?: (props: SchemaProps<TOptions>) => KubbNode;
-};
-declare function createReactParser<TOptions extends PluginFactoryOptions>(parseOptions: ParserReactOptions<TOptions>): Parser<TOptions>;
-
-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 Generator<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(...parsers: Array<Parser<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 ParserReactOptions as P, type SchemaGeneratorBuildOptions as S, OperationGenerator as a, type GetSchemaGeneratorOptions as b, type SchemaGeneratorOptions as c, type SchemaMethodResult as d, SchemaGenerator as e, createParser as f, createReactParser as g, type Parser as h, type ParserOptions as i };

package/dist/Schema-DxyOIX7q.d.cts

@@ -1,35 +0,0 @@
-import * as react from 'react';
-import { ReactNode } from 'react';
-import * as KubbFile from '@kubb/fs/types';
-import { SchemaObject } from '@kubb/oas';
-import { KubbNode } from '@kubb/react';
-import { S as Schema$1 } from './SchemaMapper-BM1IGWqD.cjs';
-
-type SchemaContextProps = {
-    name: string;
-    schema?: SchemaObject;
-    tree: Array<Schema$1>;
-};
-type Props = {
-    name: string;
-    value?: SchemaObject;
-    tree?: Array<Schema$1>;
-    children?: KubbNode;
-};
-declare function Schema({ name, value, tree, children }: Props): KubbNode;
-declare namespace Schema {
-    var File: ({ output, isTypeOnly, children }: FileProps) => ReactNode;
-    var Imports: ({ isTypeOnly, extName }: SchemaImportsProps) => ReactNode;
-    var Context: react.Context<SchemaContextProps>;
-}
-type FileProps = {
-    isTypeOnly?: boolean;
-    output: string | undefined;
-    children?: KubbNode;
-};
-type SchemaImportsProps = {
-    isTypeOnly?: boolean;
-    extName?: KubbFile.Extname;
-};
-
-export { Schema as S, type SchemaContextProps as a };

package/dist/Schema-gHgN14i2.d.ts

@@ -1,35 +0,0 @@
-import * as react from 'react';
-import { ReactNode } from 'react';
-import * as KubbFile from '@kubb/fs/types';
-import { SchemaObject } from '@kubb/oas';
-import { KubbNode } from '@kubb/react';
-import { S as Schema$1 } from './SchemaMapper-BM1IGWqD.js';
-
-type SchemaContextProps = {
-    name: string;
-    schema?: SchemaObject;
-    tree: Array<Schema$1>;
-};
-type Props = {
-    name: string;
-    value?: SchemaObject;
-    tree?: Array<Schema$1>;
-    children?: KubbNode;
-};
-declare function Schema({ name, value, tree, children }: Props): KubbNode;
-declare namespace Schema {
-    var File: ({ output, isTypeOnly, children }: FileProps) => ReactNode;
-    var Imports: ({ isTypeOnly, extName }: SchemaImportsProps) => ReactNode;
-    var Context: react.Context<SchemaContextProps>;
-}
-type FileProps = {
-    isTypeOnly?: boolean;
-    output: string | undefined;
-    children?: KubbNode;
-};
-type SchemaImportsProps = {
-    isTypeOnly?: boolean;
-    extName?: KubbFile.Extname;
-};
-
-export { Schema as S, type SchemaContextProps as a };