@kubb/swagger-ts 2.0.0-beta.1 → 2.0.0-beta.10

package/dist/components.d.cts

@@ -0,0 +1,163 @@
+import { ResolvePathOptions, Exclude, Include, Override, AppMeta as AppMeta$1, OasBuilder, OasTypes } from '@kubb/swagger';
+import { PluginFactoryOptions, KubbFile, ResolveNameParams } from '@kubb/core';
+import { ReactNode } from 'react';
+
+type Options = {
+    output?: {
+        /**
+         * Relative path to save the TypeScript types.
+         * When output is a file it will save all models inside that file else it will create a file per schema item.
+         * @default 'types'
+         */
+        path: string;
+        /**
+         * Name to be used for the `export * as {{exportAs}} from './'`
+         */
+        exportAs?: string;
+        /**
+         * Add an extension to the generated imports and exports, default it will not use an extension
+         */
+        extName?: KubbFile.Extname;
+        /**
+         * Define what needs to exported, here you can also disable the export of barrel files
+         * @default `'barrel'`
+         */
+        exportType?: 'barrel' | false;
+    };
+    /**
+     * Group the TypeScript types based on the provided name.
+     */
+    group?: {
+        /**
+         * Tag will group based on the operation tag inside the Swagger file.
+         */
+        type: 'tag';
+        /**
+         * Relative path to save the grouped TypeScript Types.
+         *
+         * `{{tag}}` will be replaced by the current tagName.
+         * @example `${output}/{{tag}}Controller` => `models/PetController`
+         * @default `${output}/{{tag}}Controller`
+         */
+        output?: string;
+    };
+    /**
+     * Array containing exclude paramaters to exclude/skip tags/operations/methods/paths.
+     */
+    exclude?: Array<Exclude>;
+    /**
+     * Array containing include paramaters to include tags/operations/methods/paths.
+     */
+    include?: Array<Include>;
+    /**
+     * Array containing override paramaters to override `options` based on tags/operations/methods/paths.
+     */
+    override?: Array<Override<Options>>;
+    /**
+     * Choose to use `enum` or `as const` for enums
+     * @default 'asConst'
+     */
+    enumType?: 'enum' | 'asConst' | 'asPascalConst';
+    /**
+     * Choose to use `date` or `datetime` as JavaScript `Date` instead of `string`.
+     * @default 'string'
+     */
+    dateType?: 'string' | 'date';
+    /**
+     * Choose what to use as mode for an optional value.
+     * @examples 'questionToken': type?: string
+     * @examples 'undefined': type: string | undefined
+     * @examples 'questionTokenAndUndefined': type?: string | undefined
+     * @default 'questionToken'
+     */
+    optionalType?: 'questionToken' | 'undefined' | 'questionTokenAndUndefined';
+    transformers?: {
+        /**
+         * Customize the names based on the type that is provided by the plugin.
+         */
+        name?: (name: ResolveNameParams['name'], type?: ResolveNameParams['type']) => string;
+    };
+    /**
+     * Export an Oas object as Oas type with `import type { Infer } from '@kubb/swagger-ts/oas'`
+     */
+    oasType?: 'infer' | false;
+};
+type ResolvedOptions = {
+    enumType: NonNullable<Options['enumType']>;
+    dateType: NonNullable<Options['dateType']>;
+    optionalType: NonNullable<Options['optionalType']>;
+    transformers: NonNullable<Options['transformers']>;
+    oasType: NonNullable<Options['oasType']>;
+    usedEnumNames: Record<string, number>;
+};
+type AppMeta = AppMeta$1;
+type PluginOptions = PluginFactoryOptions<'swagger-ts', Options, ResolvedOptions, never, ResolvePathOptions, AppMeta>;
+declare module '@kubb/core' {
+    interface _Register {
+        ['@kubb/swagger-ts']: PluginOptions;
+    }
+}
+
+declare class TypeBuilder extends OasBuilder<PluginOptions['resolvedOptions']> {
+    build(name?: string): Required<Pick<KubbFile.File, 'imports' | 'source'>>;
+}
+
+type Props$2 = {
+    builder: TypeBuilder;
+};
+declare function Mutation({ builder, }: Props$2): ReactNode;
+declare namespace Mutation {
+    var File: ({ mode }: FileProps$2) => ReactNode;
+}
+type FileProps$2 = {
+    mode: KubbFile.Mode;
+};
+
+type TemplateProps = {
+    /**
+     * Name of the function
+     */
+    name: string;
+    typeName: string;
+    api: OasTypes.OASDocument;
+};
+declare function Template({ name, typeName, api, }: TemplateProps): ReactNode;
+declare const defaultTemplates: {
+    readonly default: typeof Template;
+};
+type Props$1 = {
+    name: string;
+    typeName: string;
+    /**
+     * This will make it possible to override the default behaviour.
+     */
+    Template?: React.ComponentType<React.ComponentProps<typeof Template>>;
+};
+declare function Oas({ name, typeName, Template, }: Props$1): ReactNode;
+declare namespace Oas {
+    var File: ({ name, typeName, templates }: FileProps$1) => ReactNode;
+    var templates: {
+        readonly default: typeof Template;
+    };
+}
+type FileProps$1 = {
+    name: string;
+    typeName: string;
+    /**
+     * This will make it possible to override the default behaviour.
+     */
+    templates?: typeof defaultTemplates;
+};
+
+type Props = {
+    builder: TypeBuilder;
+};
+declare function Query({ builder, }: Props): ReactNode;
+declare namespace Query {
+    var File: ({ mode }: FileProps) => ReactNode;
+}
+type FileProps = {
+    mode: KubbFile.Mode;
+};
+
+export { Mutation, Oas, Query };

package/dist/components.d.ts

@@ -0,0 +1,163 @@
+import { ResolvePathOptions, Exclude, Include, Override, AppMeta as AppMeta$1, OasBuilder, OasTypes } from '@kubb/swagger';
+import { PluginFactoryOptions, KubbFile, ResolveNameParams } from '@kubb/core';
+import { ReactNode } from 'react';
+
+type Options = {
+    output?: {
+        /**
+         * Relative path to save the TypeScript types.
+         * When output is a file it will save all models inside that file else it will create a file per schema item.
+         * @default 'types'
+         */
+        path: string;
+        /**
+         * Name to be used for the `export * as {{exportAs}} from './'`
+         */
+        exportAs?: string;
+        /**
+         * Add an extension to the generated imports and exports, default it will not use an extension
+         */
+        extName?: KubbFile.Extname;
+        /**
+         * Define what needs to exported, here you can also disable the export of barrel files
+         * @default `'barrel'`
+         */
+        exportType?: 'barrel' | false;
+    };
+    /**
+     * Group the TypeScript types based on the provided name.
+     */
+    group?: {
+        /**
+         * Tag will group based on the operation tag inside the Swagger file.
+         */
+        type: 'tag';
+        /**
+         * Relative path to save the grouped TypeScript Types.
+         *
+         * `{{tag}}` will be replaced by the current tagName.
+         * @example `${output}/{{tag}}Controller` => `models/PetController`
+         * @default `${output}/{{tag}}Controller`
+         */
+        output?: string;
+    };
+    /**
+     * Array containing exclude paramaters to exclude/skip tags/operations/methods/paths.
+     */
+    exclude?: Array<Exclude>;
+    /**
+     * Array containing include paramaters to include tags/operations/methods/paths.
+     */
+    include?: Array<Include>;
+    /**
+     * Array containing override paramaters to override `options` based on tags/operations/methods/paths.
+     */
+    override?: Array<Override<Options>>;
+    /**
+     * Choose to use `enum` or `as const` for enums
+     * @default 'asConst'
+     */
+    enumType?: 'enum' | 'asConst' | 'asPascalConst';
+    /**
+     * Choose to use `date` or `datetime` as JavaScript `Date` instead of `string`.
+     * @default 'string'
+     */
+    dateType?: 'string' | 'date';
+    /**
+     * Choose what to use as mode for an optional value.
+     * @examples 'questionToken': type?: string
+     * @examples 'undefined': type: string | undefined
+     * @examples 'questionTokenAndUndefined': type?: string | undefined
+     * @default 'questionToken'
+     */
+    optionalType?: 'questionToken' | 'undefined' | 'questionTokenAndUndefined';
+    transformers?: {
+        /**
+         * Customize the names based on the type that is provided by the plugin.
+         */
+        name?: (name: ResolveNameParams['name'], type?: ResolveNameParams['type']) => string;
+    };
+    /**
+     * Export an Oas object as Oas type with `import type { Infer } from '@kubb/swagger-ts/oas'`
+     */
+    oasType?: 'infer' | false;
+};
+type ResolvedOptions = {
+    enumType: NonNullable<Options['enumType']>;
+    dateType: NonNullable<Options['dateType']>;
+    optionalType: NonNullable<Options['optionalType']>;
+    transformers: NonNullable<Options['transformers']>;
+    oasType: NonNullable<Options['oasType']>;
+    usedEnumNames: Record<string, number>;
+};
+type AppMeta = AppMeta$1;
+type PluginOptions = PluginFactoryOptions<'swagger-ts', Options, ResolvedOptions, never, ResolvePathOptions, AppMeta>;
+declare module '@kubb/core' {
+    interface _Register {
+        ['@kubb/swagger-ts']: PluginOptions;
+    }
+}
+
+declare class TypeBuilder extends OasBuilder<PluginOptions['resolvedOptions']> {
+    build(name?: string): Required<Pick<KubbFile.File, 'imports' | 'source'>>;
+}
+
+type Props$2 = {
+    builder: TypeBuilder;
+};
+declare function Mutation({ builder, }: Props$2): ReactNode;
+declare namespace Mutation {
+    var File: ({ mode }: FileProps$2) => ReactNode;
+}
+type FileProps$2 = {
+    mode: KubbFile.Mode;
+};
+
+type TemplateProps = {
+    /**
+     * Name of the function
+     */
+    name: string;
+    typeName: string;
+    api: OasTypes.OASDocument;
+};
+declare function Template({ name, typeName, api, }: TemplateProps): ReactNode;
+declare const defaultTemplates: {
+    readonly default: typeof Template;
+};
+type Props$1 = {
+    name: string;
+    typeName: string;
+    /**
+     * This will make it possible to override the default behaviour.
+     */
+    Template?: React.ComponentType<React.ComponentProps<typeof Template>>;
+};
+declare function Oas({ name, typeName, Template, }: Props$1): ReactNode;
+declare namespace Oas {
+    var File: ({ name, typeName, templates }: FileProps$1) => ReactNode;
+    var templates: {
+        readonly default: typeof Template;
+    };
+}
+type FileProps$1 = {
+    name: string;
+    typeName: string;
+    /**
+     * This will make it possible to override the default behaviour.
+     */
+    templates?: typeof defaultTemplates;
+};
+
+type Props = {
+    builder: TypeBuilder;
+};
+declare function Query({ builder, }: Props): ReactNode;
+declare namespace Query {
+    var File: ({ mode }: FileProps) => ReactNode;
+}
+type FileProps = {
+    mode: KubbFile.Mode;
+};
+
+export { Mutation, Oas, Query };