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

package/dist/OperationGenerator-D7rSlflc.d.cts

@@ -0,0 +1,158 @@
+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

@@ -0,0 +1,158 @@
+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-an5hOrjZ.d.cts → Schema-DxyOIX7q.d.cts}

@@ -3,7 +3,7 @@ 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 { S as Schema$1 } from './SchemaMapper-BM1IGWqD.cjs';
 
 type SchemaContextProps = {
     name: string;

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

@@ -3,7 +3,7 @@ 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 { S as Schema$1 } from './SchemaMapper-BM1IGWqD.js';
 
 type SchemaContextProps = {
     name: string;

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

@@ -245,4 +245,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-BM1IGWqD.d.ts}

@@ -245,4 +245,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 };