@kubb/plugin-oas 3.0.0-alpha.1 → 3.0.0-alpha.10

package/dist/OperationGenerator-By5WOmWB.d.ts

@@ -0,0 +1,165 @@
+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 };

package/dist/OperationGenerator-Gd1X7wUz.d.cts

@@ -0,0 +1,165 @@
+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.cjs';
+import { S as Schema, c as SchemaKeywordMapper } from './SchemaMapper-sGcY1xL5.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 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 };

package/dist/{Schema-DefwBJMc.d.ts → Schema-B1vcPGiK.d.ts}

@@ -1,9 +1,8 @@
 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-CsBQ6eEx.js';
+import { KubbNode } from '@kubb/react/types';
+import { S as Schema$1 } from './SchemaMapper-sGcY1xL5.js';
 
 type SchemaContextProps = {
     name: string;
@@ -19,7 +18,7 @@ type Props = {
 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 Imports: ({ isTypeOnly }: SchemaImportsProps) => ReactNode;
     var Context: react.Context<SchemaContextProps>;
 }
 type FileProps = {
@@ -29,7 +28,6 @@ type FileProps = {
 };
 type SchemaImportsProps = {
     isTypeOnly?: boolean;
-    extName?: KubbFile.Extname;
 };
 
 export { Schema as S, type SchemaContextProps as a };

package/dist/{Schema-an5hOrjZ.d.cts → Schema-DoSFh7Qd.d.cts}

@@ -1,9 +1,8 @@
 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-CsBQ6eEx.cjs';
+import { KubbNode } from '@kubb/react/types';
+import { S as Schema$1 } from './SchemaMapper-sGcY1xL5.cjs';
 
 type SchemaContextProps = {
     name: string;
@@ -19,7 +18,7 @@ type Props = {
 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 Imports: ({ isTypeOnly }: SchemaImportsProps) => ReactNode;
     var Context: react.Context<SchemaContextProps>;
 }
 type FileProps = {
@@ -29,7 +28,6 @@ type FileProps = {
 };
 type SchemaImportsProps = {
     isTypeOnly?: boolean;
-    extName?: KubbFile.Extname;
 };
 
 export { Schema as S, type SchemaContextProps as a };

package/dist/{SchemaMapper-CsBQ6eEx.d.cts → SchemaMapper-sGcY1xL5.d.cts}

@@ -107,7 +107,6 @@ type SchemaKeywordMapper = {
         args: {
             name: string;
             path: KubbFile.OptionalPath;
-            isTypeOnly?: boolean;
         };
     };
     matches: {
@@ -245,4 +244,4 @@ type Schema = {
 } | SchemaKeywordMapper[keyof SchemaKeywordMapper];
 declare function isKeyword<T extends Schema, K extends keyof SchemaKeywordMapper>(meta: T, keyword: K): meta is Extract<T, SchemaKeywordMapper[K]>;
 
-export { type Schema as S, type SchemaKeywordMapper as a, type SchemaKeyword as b, type SchemaKeywordBase as c, type SchemaMapper as d, isKeyword as i, schemaKeywords as s };
+export { type Schema as S, type SchemaKeyword as a, type SchemaKeywordBase as b, type SchemaKeywordMapper as c, type SchemaMapper as d, isKeyword as i, schemaKeywords as s };

package/dist/{SchemaMapper-CsBQ6eEx.d.ts → SchemaMapper-sGcY1xL5.d.ts}

@@ -107,7 +107,6 @@ type SchemaKeywordMapper = {
         args: {
             name: string;
             path: KubbFile.OptionalPath;
-            isTypeOnly?: boolean;
         };
     };
     matches: {
@@ -245,4 +244,4 @@ type Schema = {
 } | SchemaKeywordMapper[keyof SchemaKeywordMapper];
 declare function isKeyword<T extends Schema, K extends keyof SchemaKeywordMapper>(meta: T, keyword: K): meta is Extract<T, SchemaKeywordMapper[K]>;
 
-export { type Schema as S, type SchemaKeywordMapper as a, type SchemaKeyword as b, type SchemaKeywordBase as c, type SchemaMapper as d, isKeyword as i, schemaKeywords as s };
+export { type Schema as S, type SchemaKeyword as a, type SchemaKeywordBase as b, type SchemaKeywordMapper as c, type SchemaMapper as d, isKeyword as i, schemaKeywords as s };

package/dist/chunk-75BIOXB7.cjs

@@ -0,0 +1,7 @@
+"use strict";
+
+var _chunkNU4F7G47cjs = require('./chunk-NU4F7G47.cjs');
+
+// src/components/index.ts
+_chunkNU4F7G47cjs.init_cjs_shims.call(void 0, );
+//# sourceMappingURL=chunk-75BIOXB7.cjs.map

package/dist/chunk-75BIOXB7.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["/home/runner/work/kubb/kubb/packages/plugin-oas/dist/chunk-75BIOXB7.cjs","../src/components/index.ts"],"names":[],"mappings":"AAAA;AACE;AACF,wDAA6B;AAC7B;AACA;ACJA,8CAAA,CAAA","file":"/home/runner/work/kubb/kubb/packages/plugin-oas/dist/chunk-75BIOXB7.cjs","sourcesContent":[null,"export { Oas } from './Oas.tsx'\nexport { Operation } from './Operation.tsx'\nexport { Schema } from './Schema.tsx'\n"]}