@kubb/plugin-ts/dist/types-DkvPgLAK.d.cts

TypeScript code generation plugin for Kubb, transforming OpenAPI schemas into TypeScript interfaces, types, and utility functions.

import { Output, Group, ResolveNameParams, PluginFactoryOptions } from '@kubb/core';
import { Oas, contentType } from '@kubb/oas';
import { Exclude, Include, Override, Generator, ResolvePathOptions } from '@kubb/plugin-oas';
import ts from 'typescript';

type Options = {
    /**
     * Specify the export location for the files and define the behavior of the output
     * @default { path: 'types', barrelType: 'named' }
     */
    output?: Output<Oas>;
    /**
     * Define which contentType should be used.
     * By default, the first JSON valid mediaType will be used
     */
    contentType?: contentType;
    /**
     * Group the clients based on the provided name.
     */
    group?: Group;
    /**
     * Array containing exclude parameters to exclude/skip tags/operations/methods/paths.
     */
    exclude?: Array<Exclude>;
    /**
     * Array containing include parameters to include tags/operations/methods/paths.
     */
    include?: Array<Include>;
    /**
     * Array containing override parameters to override `options` based on tags/operations/methods/paths.
     */
    override?: Array<Override<ResolvedOptions>>;
    /**
     * Choose to use `enum` or `as const` for enums
     * @default 'asConst'
     * asPascalConst is deprecated
     */
    enumType?: 'enum' | 'asConst' | 'asPascalConst' | 'constEnum' | 'literal';
    /**
     * Switch between type or interface for creating TypeScript types
     * @default 'type'
     */
    syntaxType?: 'type' | 'interface';
    /**
     * Set a suffix for the generated enums.
     * @default 'enum'
     */
    enumSuffix?: string;
    /**
     * Choose to use `date` or `datetime` as JavaScript `Date` instead of `string`.
     * @default 'string'
     */
    dateType?: 'string' | 'date';
    /**
     * Which type to use when the Swagger/OpenAPI file is not providing more information.
     * @default 'any'
     */
    unknownType?: 'any' | 'unknown' | 'void';
    /**
     * Which type to use for empty schema values
     * @default `unknownType`
     */
    emptySchemaType?: 'any' | 'unknown' | 'void';
    /**
     * 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/oas'`
     */
    oasType?: 'infer' | false;
    /**
     * @example
     * Use https://ts-ast-viewer.com to generate factory code(see createPropertySignature)
     * category: factory.createPropertySignature(
     *   undefined,
     *   factory.createIdentifier("category"),
     *   factory.createToken(ts.SyntaxKind.QuestionToken),
     *   factory.createKeywordTypeNode(ts.SyntaxKind.StringKeyword)
     * )
     */
    mapper?: Record<string, ts.PropertySignature>;
    /**
     * Define some generators next to the ts generators
     */
    generators?: Array<Generator<PluginTs>>;
};
type ResolvedOptions = {
    output: Output<Oas>;
    group: Options['group'];
    override: NonNullable<Options['override']>;
    enumType: NonNullable<Options['enumType']>;
    enumSuffix: NonNullable<Options['enumSuffix']>;
    dateType: NonNullable<Options['dateType']>;
    unknownType: NonNullable<Options['unknownType']>;
    emptySchemaType: NonNullable<Options['emptySchemaType']>;
    optionalType: NonNullable<Options['optionalType']>;
    transformers: NonNullable<Options['transformers']>;
    oasType: NonNullable<Options['oasType']>;
    syntaxType: NonNullable<Options['syntaxType']>;
    usedEnumNames: Record<string, number>;
    mapper: Record<string, any>;
};
type PluginTs = PluginFactoryOptions<'plugin-ts', Options, ResolvedOptions, never, ResolvePathOptions>;

export type { Options as O, PluginTs as P };