import * as OasTypes from "oas/types"; import { HttpMethods as HttpMethod, OASDocument, SchemaObject, User } from "oas/types"; import { Operation, Operation as Operation$1 } from "oas/operation"; import { OpenAPIV3 } from "openapi-types"; import * as oas_normalize_lib_types0 from "oas-normalize/lib/types"; import BaseOas from "oas"; import { KubbFile } from "@kubb/fabric-core/types"; import { Fabric } from "@kubb/react-fabric"; import { ConsolaInstance, LogLevel } from "consola"; import { KubbNode } from "@kubb/react-fabric/types"; //#region ../oas/src/types.d.ts type contentType = 'application/json' | (string & {}); type SchemaObject$1 = OasTypes.SchemaObject & { 'x-nullable'?: boolean; $ref?: string; }; //#endregion //#region ../oas/src/Oas.d.ts type Options$4 = { contentType?: contentType; discriminator?: 'strict' | 'inherit'; }; declare class Oas extends BaseOas { #private; document: TOAS; constructor({ oas, user }: { oas: TOAS | OASDocument | string; user?: User; }); setOptions(options: Options$4): void; get options(): Options$4; get($ref: string): any; getKey($ref: string): string | undefined; set($ref: string, value: unknown): false | undefined; getDiscriminator(schema: OasTypes.SchemaObject): OpenAPIV3.DiscriminatorObject | undefined; dereferenceWithRef(schema?: unknown): any; getResponseSchema(operation: Operation, statusCode: string | number): SchemaObject; getRequestSchema(operation: Operation): SchemaObject | undefined; getParametersSchema(operation: Operation, inKey: 'path' | 'query' | 'header'): SchemaObject | null; valdiate(): Promise; } //#endregion //#region ../core/src/BaseGenerator.d.ts /** * Abstract class that contains the building blocks for plugins to create their own Generator * @link idea based on https://github.com/colinhacks/zod/blob/master/src/types.ts#L137 */ declare abstract class BaseGenerator { #private; constructor(options?: TOptions, context?: TContext); get options(): TOptions; get context(): TContext; set options(options: TOptions); abstract build(...params: unknown[]): unknown; } //#endregion //#region ../core/src/utils/EventEmitter.d.ts declare class EventEmitter> { #private; constructor(); emit(eventName: TEventName, ...eventArg: TEvents[TEventName]): void; on(eventName: TEventName, handler: (...eventArg: TEvents[TEventName]) => void): void; off(eventName: TEventName, handler: (...eventArg: TEvents[TEventName]) => void): void; removeAll(): void; } //#endregion //#region ../core/src/logger.d.ts type DebugEvent = { date: Date; logs: string[]; fileName?: string; }; type Events$1 = { start: [message: string]; success: [message: string]; error: [message: string, cause: Error]; warning: [message: string]; debug: [DebugEvent]; info: [message: string]; progress_start: [{ id: string; size: number; message?: string; }]; progressed: [{ id: string; message?: string; }]; progress_stop: [{ id: string; }]; }; type Logger = { /** * Optional config name to show in CLI output */ name?: string; logLevel: LogLevel; consola?: ConsolaInstance; on: EventEmitter['on']; emit: EventEmitter['emit']; writeLogs: () => Promise; }; //#endregion //#region ../core/src/utils/types.d.ts type PossiblePromise = Promise | T; //#endregion //#region ../core/src/types.d.ts declare global { namespace Kubb { interface PluginContext {} } } /** * Config used in `kubb.config.ts` * * @example * import { defineConfig } from '@kubb/core' * export default defineConfig({ * ... * }) */ type InputPath = { /** * Specify your Swagger/OpenAPI file, either as an absolute path or a path relative to the root. */ path: string; }; type InputData = { /** * A `string` or `object` that contains your Swagger/OpenAPI data. */ data: string | unknown; }; type Input = InputPath | InputData | Array; type BarrelType = 'all' | 'named' | 'propagate'; /** * @private */ type Config = { /** * The name to display in the CLI output. */ name?: string; /** * The project root directory, which can be either an absolute path or a path relative to the location of your `kubb.config.ts` file. * @default process.cwd() */ root: string; /** * You can use either `input.path` or `input.data`, depending on your specific needs. */ input: TInput; output: { /** * The path where all generated files will be exported. * This can be an absolute path or a path relative to the specified root option. */ path: string; /** * Clean the output directory before each build. */ clean?: boolean; /** * Save files to the file system. * @default true */ write?: boolean; /** * Specifies the formatting tool to be used. * @default prettier * * Possible values: * - 'prettier': Uses Prettier for code formatting. * - 'biome': Uses Biome for code formatting. * */ format?: 'prettier' | 'biome' | false; /** * Specifies the linter that should be used to analyze the code. * The accepted values indicate different linting tools. * * Possible values: * - 'eslint': Represents the use of ESLint, a widely used JavaScript linter. * - 'biome': Represents the Biome linter, a modern tool for code scanning. * - 'oxlint': Represents the Oxlint tool for linting purposes. * */ lint?: 'eslint' | 'biome' | 'oxlint' | false; /** * Override the extension to the generated imports and exports, by default each plugin will add an extension * @default { '.ts': '.ts'} */ extension?: Record; /** * Specify how `index.ts` files should be created. You can also disable the generation of barrel files here. While each plugin has its own `barrelType` option, this setting controls the creation of the root barrel file, such as` src/gen/index.ts`. * @default 'named' */ barrelType?: Exclude | false; /** * Add a default banner to the beginning of every generated file. This makes it clear that the file was generated by Kubb. * - 'simple': will only add banner with link to Kubb * - 'full': will add source, title, description and the OpenAPI version used * @default 'simple' */ defaultBanner?: 'simple' | 'full' | false; }; /** * An array of Kubb plugins that will be used in the generation. * Each plugin may include additional configurable options(defined in the plugin itself). * If a plugin depends on another plugin, an error will be returned if the required dependency is missing. See pre for more details. */ plugins?: Array; /** * Hooks that will be called when a specific action is triggered in Kubb. */ hooks?: { /** * Hook that will be triggered at the end of all executions. * Useful for running Prettier or ESLint to format/lint your code. */ done?: string | Array; }; }; type PluginFactoryOptions< /** * Name to be used for the plugin, this will also be used for they key. */ TName extends string = string, /** * Options of the plugin. */ TOptions extends object = object, /** * Options of the plugin that can be used later on, see `options` inside your plugin config. */ TResolvedOptions extends object = TOptions, /** * Context that you want to expose to other plugins. */ TContext = any, /** * When calling `resolvePath` you can specify better types. */ TResolvePathOptions extends object = object> = { name: TName; /** * Same behaviour like what has been done with `QueryKey` in `@tanstack/react-query` */ key: PluginKey; options: TOptions; resolvedOptions: TResolvedOptions; context: TContext; resolvePathOptions: TResolvePathOptions; }; type PluginKey = [name: TName, identifier?: string | number]; type UserPlugin = { /** * Unique name used for the plugin * The name of the plugin follows the format scope:foo-bar or foo-bar, adding scope: can avoid naming conflicts with other plugins. * @example @kubb/typescript */ name: TOptions['name']; /** * Options set for a specific plugin(see kubb.config.js), passthrough of options. */ options: TOptions['resolvedOptions']; /** * Specifies the preceding plugins for the current plugin. You can pass an array of preceding plugin names, and the current plugin will be executed after these plugins. * Can be used to validate dependent plugins. */ pre?: Array; /** * Specifies the succeeding plugins for the current plugin. You can pass an array of succeeding plugin names, and the current plugin will be executed before these plugins. */ post?: Array; inject?: (this: PluginContext, context: PluginContext) => TOptions['context']; }; type UserPluginWithLifeCycle = UserPlugin & PluginLifecycle; type Plugin = { /** * Unique name used for the plugin * @example @kubb/typescript */ name: TOptions['name']; /** * Internal key used when a developer uses more than one of the same plugin * @private */ key: TOptions['key']; /** * Specifies the preceding plugins for the current plugin. You can pass an array of preceding plugin names, and the current plugin will be executed after these plugins. * Can be used to validate dependent plugins. */ pre?: Array; /** * Specifies the succeeding plugins for the current plugin. You can pass an array of succeeding plugin names, and the current plugin will be executed before these plugins. */ post?: Array; /** * Options set for a specific plugin(see kubb.config.js), passthrough of options. */ options: TOptions['resolvedOptions']; install: (this: PluginContext, context: PluginContext) => PossiblePromise; /** * Define a context that can be used by other plugins, see `PluginManager' where we convert from `UserPlugin` to `Plugin`(used when calling `definePlugin`). */ inject: (this: PluginContext, context: PluginContext) => TOptions['context']; }; type PluginWithLifeCycle = Plugin & PluginLifecycle; type PluginLifecycle = { /** * Start of the lifecycle of a plugin. * @type hookParallel */ install?: (this: PluginContext, context: PluginContext) => PossiblePromise; /** * Resolve to a Path based on a baseName(example: `./Pet.ts`) and directory(example: `./models`). * Options can als be included. * @type hookFirst * @example ('./Pet.ts', './src/gen/') => '/src/gen/Pet.ts' */ resolvePath?: (this: PluginContext, baseName: KubbFile.BaseName, mode?: KubbFile.Mode, options?: TOptions['resolvePathOptions']) => KubbFile.Path; /** * Resolve to a name based on a string. * Useful when converting to PascalCase or camelCase. * @type hookFirst * @example ('pet') => 'Pet' */ resolveName?: (this: PluginContext, name: ResolveNameParams['name'], type?: ResolveNameParams['type']) => string; }; type PluginLifecycleHooks = keyof PluginLifecycle; type PluginParameter = Parameters[H]>; type ResolvePathParams = { pluginKey?: Plugin['key']; baseName: KubbFile.BaseName; mode?: KubbFile.Mode; /** * Options to be passed to 'resolvePath' 3th parameter */ options?: TOptions; }; type ResolveNameParams = { name: string; pluginKey?: Plugin['key']; /** * `file` will be used to customize the name of the created file(use of camelCase) * `function` can be used to customize the exported functions(use of camelCase) * `type` is a special type for TypeScript(use of PascalCase) * `const` can be used for variables(use of camelCase) */ type?: 'file' | 'function' | 'type' | 'const'; }; type PluginContext = { fabric: Fabric; config: Config; pluginManager: PluginManager; /** * Only add when the file does not exist yet */ addFile: (...file: Array) => Promise; /** * merging multiple sources into the same output file */ upsertFile: (...file: Array) => Promise; logger: Logger; mode: KubbFile.Mode; /** * Current plugin */ plugin: Plugin; } & Kubb.PluginContext; /** * Specify the export location for the files and define the behavior of the output */ type Output = { /** * Path to the output folder or file that will contain the generated code */ path: string; /** * Define what needs to be exported, here you can also disable the export of barrel files * @default 'named' */ barrelType?: BarrelType | false; /** * Add a banner text in the beginning of every file */ banner?: string | ((options: TOptions) => string); /** * Add a footer text in the beginning of every file */ footer?: string | ((options: TOptions) => string); }; type GroupContext = { group: string; }; type Group = { /** * Define a type where to group the files on */ type: 'tag' | 'path'; /** * Return the name of a group based on the group name, this will be used for the file and name generation */ name?: (context: GroupContext) => string; }; //#endregion //#region ../core/src/PluginManager.d.ts type RequiredPluginLifecycle = Required; type Strategy = 'hookFirst' | 'hookForPlugin' | 'hookParallel' | 'hookSeq'; type Executer = { message: string; strategy: Strategy; hookName: H; plugin: Plugin; parameters?: unknown[] | undefined; output?: unknown; }; type ParseResult = RequiredPluginLifecycle[H]; type SafeParseResult>> = { result: Result; plugin: Plugin; }; type Options$3 = { fabric: Fabric; logger: Logger; /** * @default Number.POSITIVE_INFINITY */ concurrency?: number; }; type Events = { executing: [executer: Executer]; executed: [executer: Executer]; error: [error: Error]; }; type GetFileProps = { name: string; mode?: KubbFile.Mode; extname: KubbFile.Extname; pluginKey: Plugin['key']; options?: TOptions; }; declare class PluginManager { #private; readonly events: EventEmitter; readonly config: Config; readonly executed: Array; readonly logger: Logger; readonly options: Options$3; constructor(config: Config, options: Options$3); getContext(plugin: Plugin): PluginContext & Record; get plugins(): Array; getFile({ name, mode, extname, pluginKey, options }: GetFileProps): KubbFile.File<{ pluginKey: Plugin['key']; }>; resolvePath: (params: ResolvePathParams) => KubbFile.Path; resolveName: (params: ResolveNameParams) => string; /** * Instead of calling `pluginManager.events.on` you can use `pluginManager.on`. This one also has better types. */ on(eventName: TEventName, handler: (...eventArg: Events[TEventName]) => void): void; /** * Run a specific hookName for plugin x. */ hookForPlugin({ pluginKey, hookName, parameters, message }: { pluginKey: Plugin['key']; hookName: H; parameters: PluginParameter; message: string; }): Promise> | null>>; /** * Run a specific hookName for plugin x. */ hookForPluginSync({ pluginKey, hookName, parameters, message }: { pluginKey: Plugin['key']; hookName: H; parameters: PluginParameter; message: string; }): Array>> | null; /** * First non-null result stops and will return it's value. */ hookFirst({ hookName, parameters, skipped, message }: { hookName: H; parameters: PluginParameter; skipped?: ReadonlySet | null; message: string; }): Promise>; /** * First non-null result stops and will return it's value. */ hookFirstSync({ hookName, parameters, skipped, message }: { hookName: H; parameters: PluginParameter; skipped?: ReadonlySet | null; message: string; }): SafeParseResult; /** * Run all plugins in parallel(order will be based on `this.plugin` and if `pre` or `post` is set). */ hookParallel({ hookName, parameters, message }: { hookName: H; parameters?: Parameters | undefined; message: string; }): Promise[]>; /** * Chains plugins */ hookSeq({ hookName, parameters, message }: { hookName: H; parameters?: PluginParameter; message: string; }): Promise; getPluginByKey(pluginKey: Plugin['key']): Plugin | undefined; getPluginsByKey(hookName: keyof PluginWithLifeCycle, pluginKey: Plugin['key']): Plugin[]; } //#endregion //#region ../core/src/utils/getBarrelFiles.d.ts type FileMetaBase = { pluginKey?: Plugin['key']; }; //#endregion //#region ../plugin-oas/src/types.d.ts type Context$2 = { getOas(): Promise; getBaseURL(): Promise; }; declare global { namespace Kubb { interface PluginContext extends Context$2 {} } } type ResolvePathOptions = { pluginKey?: Plugin['key']; group?: { tag?: string; path?: string; }; type?: ResolveNameParams['type']; }; /** * `propertyName` is the ref name + resolved with the nameResolver * @example import { Pet } from './Pet' * * `originalName` is the original name used(in PascalCase), only used to remove duplicates * * `pluginKey` can be used to override the current plugin being used, handy when you want to import a type/schema out of another plugin * @example import a type(plugin-ts) for a mock file(swagger-faker) */ type Ref = { propertyName: string; originalName: string; path: KubbFile.Path; pluginKey?: Plugin['key']; }; type Refs = Record; type OperationSchema = { /** * Converted name, contains already `PathParams`, `QueryParams`, ... */ name: string; schema: SchemaObject$1; operation?: Operation$1; /** * OperationName in PascalCase, only being used in OperationGenerator */ operationName: string; description?: string; statusCode?: number; keys?: string[]; keysToOmit?: string[]; withData?: boolean; }; type OperationSchemas = { pathParams?: OperationSchema & { keysToOmit?: never; }; queryParams?: OperationSchema & { keysToOmit?: never; }; headerParams?: OperationSchema & { keysToOmit?: never; }; request?: OperationSchema; response: OperationSchema; responses: Array; statusCodes?: Array; errors?: Array; }; type ByTag = { type: 'tag'; pattern: string | RegExp; }; type ByOperationId = { type: 'operationId'; pattern: string | RegExp; }; type ByPath = { type: 'path'; pattern: string | RegExp; }; type ByMethod = { type: 'method'; pattern: HttpMethod | RegExp; }; type BySchemaName = { type: 'schemaName'; pattern: string | RegExp; }; type ByContentType = { type: 'contentType'; pattern: string | RegExp; }; type Exclude$1 = ByTag | ByOperationId | ByPath | ByMethod | ByContentType; type Include = ByTag | ByOperationId | ByPath | ByMethod | ByContentType; type Override = (ByTag | ByOperationId | ByPath | ByMethod | BySchemaName | ByContentType) & { options: Partial; }; //#endregion //#region ../plugin-oas/src/OperationGenerator.d.ts type Context$1 = { fabric: Fabric; oas: Oas; exclude: Array | undefined; include: Array | undefined; override: Array> | undefined; contentType: contentType | undefined; pluginManager: PluginManager; /** * Current plugin */ plugin: Plugin; mode: KubbFile.Mode; }; declare class OperationGenerator extends BaseGenerator> { #private; getSchemas(operation: Operation$1, { resolveName }?: { resolveName?: (name: string) => string; }): OperationSchemas; getOperations(): Promise>; build(...generators: Array>): Promise>>; } //#endregion //#region ../plugin-oas/src/SchemaMapper.d.ts type SchemaKeywordMapper = { object: { keyword: 'object'; args: { properties: { [x: string]: Schema[]; }; additionalProperties: Schema[]; strict?: boolean; }; }; url: { keyword: 'url'; }; readOnly: { keyword: 'readOnly'; }; writeOnly: { keyword: 'writeOnly'; }; uuid: { keyword: 'uuid'; }; email: { keyword: 'email'; }; firstName: { keyword: 'firstName'; }; lastName: { keyword: 'lastName'; }; phone: { keyword: 'phone'; }; password: { keyword: 'password'; }; date: { keyword: 'date'; args: { type?: 'date' | 'string'; }; }; time: { keyword: 'time'; args: { type?: 'date' | 'string'; }; }; datetime: { keyword: 'datetime'; args: { offset?: boolean; local?: boolean; }; }; tuple: { keyword: 'tuple'; args: { items: Schema[]; min?: number; max?: number; rest?: Schema; }; }; array: { keyword: 'array'; args: { items: Schema[]; min?: number; max?: number; unique?: boolean; }; }; enum: { keyword: 'enum'; args: { name: string; typeName: string; asConst: boolean; items: Array<{ name: string | number; format: 'string' | 'number' | 'boolean'; value?: string | number | boolean; }>; }; }; and: { keyword: 'and'; args: Schema[]; }; const: { keyword: 'const'; args: { name: string | number; format: 'string' | 'number' | 'boolean'; value?: string | number | boolean; }; }; union: { keyword: 'union'; args: Schema[]; }; ref: { keyword: 'ref'; args: { name: string; $ref: string; /** * Full qualified path. */ path: KubbFile.Path; /** * When true `File.Import` will be used. * When false a reference will be used inside the current file. */ isImportable: boolean; }; }; matches: { keyword: 'matches'; args?: string; }; boolean: { keyword: 'boolean'; }; default: { keyword: 'default'; args: string | number | boolean; }; string: { keyword: 'string'; }; integer: { keyword: 'integer'; }; number: { keyword: 'number'; }; max: { keyword: 'max'; args: number; }; min: { keyword: 'min'; args: number; }; exclusiveMaximum: { keyword: 'exclusiveMaximum'; args: number; }; exclusiveMinimum: { keyword: 'exclusiveMinimum'; args: number; }; describe: { keyword: 'describe'; args: string; }; example: { keyword: 'example'; args: string; }; deprecated: { keyword: 'deprecated'; }; optional: { keyword: 'optional'; }; undefined: { keyword: 'undefined'; }; nullish: { keyword: 'nullish'; }; nullable: { keyword: 'nullable'; }; null: { keyword: 'null'; }; any: { keyword: 'any'; }; unknown: { keyword: 'unknown'; }; void: { keyword: 'void'; }; blob: { keyword: 'blob'; }; schema: { keyword: 'schema'; args: { type: 'string' | 'number' | 'integer' | 'boolean' | 'array' | 'object'; format?: string; }; }; name: { keyword: 'name'; args: string; }; catchall: { keyword: 'catchall'; }; interface: { keyword: 'interface'; }; }; type Schema = { keyword: string; } | SchemaKeywordMapper[keyof SchemaKeywordMapper]; //#endregion //#region ../plugin-oas/src/SchemaGenerator.d.ts type Context = { fabric: Fabric; oas: Oas; pluginManager: PluginManager; /** * Current plugin */ plugin: Plugin; mode: KubbFile.Mode; include?: Array<'schemas' | 'responses' | 'requestBodies'>; override: Array> | undefined; contentType?: contentType; output?: string; }; type SchemaGeneratorOptions = { dateType: false | 'string' | 'stringOffset' | 'stringLocal' | 'date'; unknownType: 'any' | 'unknown' | 'void'; emptySchemaType: 'any' | 'unknown' | 'void'; enumType?: 'enum' | 'asConst' | 'asPascalConst' | 'constEnum' | 'literal'; enumSuffix?: string; usedEnumNames?: Record; mapper?: Record; 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 SchemaProps$1 = { schemaObject?: SchemaObject$1; name?: string; parentName?: string; }; declare class SchemaGenerator extends BaseGenerator> { #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[]; static deepSearch(tree: Schema[] | undefined, keyword: T): Array; static find(tree: Schema[] | undefined, keyword: T): SchemaKeywordMapper[T] | undefined; static combineObjects(tree: Schema[] | undefined): Schema[]; build(...generators: Array>): Promise>>; } //#endregion //#region ../plugin-oas/src/generators/createReactGenerator.d.ts type ReactGenerator = { name: string; type: 'react'; Operations: (props: OperationsProps) => KubbNode; Operation: (props: OperationProps) => KubbNode; Schema: (props: SchemaProps) => KubbNode; }; //#endregion //#region ../plugin-oas/src/generators/types.d.ts type OperationsProps = { config: Config; generator: Omit, 'build'>; plugin: Plugin; operations: Array; }; type OperationProps = { config: Config; generator: Omit, 'build'>; plugin: Plugin; operation: Operation$1; }; type SchemaProps = { config: Config; generator: Omit, 'build'>; plugin: Plugin; schema: { name: string; tree: Array; value: SchemaObject$1; }; }; type Generator = CoreGenerator | ReactGenerator; //#endregion //#region ../plugin-oas/src/generators/createGenerator.d.ts type CoreGenerator = { name: string; type: 'core'; operations: (props: OperationsProps) => Promise; operation: (props: OperationProps) => Promise; schema: (props: SchemaProps) => Promise; }; //#endregion //#region ../plugin-client/src/types.d.ts type Options$2 = { /** * Specify the export location for the files and define the behavior of the output * @default { path: 'clients', barrelType: 'named' } */ output?: Output; /** * 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; /** * Array containing include parameters to include tags/operations/methods/paths. */ include?: Array; /** * Array containing override parameters to override `options` based on tags/operations/methods/paths. */ override?: Array>; /** * Create `operations.ts` file with all operations grouped by methods. * @default false */ operations?: boolean; /** * Export urls that are used by operation x * `export` will make them part of your barrel file * false will not make them exportable * @example getGetPetByIdUrl */ urlType?: 'export' | false; /** * Path to the client import path that will be used to do the API calls. * It will be used as `import client from '${client.importPath}'`. * It allows both relative and absolute path but be aware that we will not change the path. */ importPath?: string; /** * Allows you to set a custom base url for all generated calls. */ baseURL?: string; /** * ReturnType that will be used when calling the client. * - 'data' will return ResponseConfig[data]. * - 'full' will return ResponseConfig. * @default 'data' */ dataReturnType?: 'data' | 'full'; /** * How to style your params, by default no casing is applied * - 'camelcase' will use camelcase for the params names */ paramsCasing?: 'camelcase'; /** * How to pass your params * - 'object' will return the params and pathParams as an object. * - 'inline' will return the params as comma separated params. * @default 'inline' */ paramsType?: 'object' | 'inline'; /** * How to pass your pathParams. * - 'object' will return the pathParams as an object. * - 'inline' will return the pathParams as comma separated params. * @default 'inline' */ pathParamsType?: 'object' | 'inline'; /** * Which parser can be used before returning the data * - 'zod' will use `@kubb/plugin-zod` to parse the data. * @default 'client' */ parser?: 'client' | 'zod'; /** * Which client should be used to do the HTTP calls * - 'axios' will use `@kubb/plugin-client/templates/axios` to fetch data. * - 'fetch' will use `@kubb/plugin-client/templates/fetch` to fetch data. * @default 'axios' */ client?: 'axios' | 'fetch'; /** * Bundle the selected client into the generated `.kubb` directory. * When disabled the generated clients will import the shared runtime from `@kubb/plugin-client/clients/*`. * @default false * In version 5 of Kubb this will be by default true */ bundle?: boolean; transformers?: { /** * Customize the names based on the type that is provided by the plugin. */ name?: (name: ResolveNameParams['name'], type?: ResolveNameParams['type']) => string; }; /** * Define some generators next to the client generators */ generators?: Array>; }; type ResolvedOptions$1 = { output: Output; group?: Options$2['group']; baseURL: string | undefined; client: Options$2['client']; bundle: NonNullable; parser: NonNullable; urlType: NonNullable; importPath: Options$2['importPath']; dataReturnType: NonNullable; pathParamsType: NonNullable; paramsType: NonNullable; paramsCasing: Options$2['paramsCasing']; }; type PluginClient = PluginFactoryOptions<'plugin-client', Options$2, ResolvedOptions$1, never, ResolvePathOptions>; //#endregion //#region src/types.d.ts type TransformerProps = { operation: Operation$1; schemas: OperationSchemas; casing: 'camelcase' | undefined; }; type Transformer = (props: TransformerProps) => unknown[]; /** * Customize the queryKey */ type QueryKey = Transformer; /** * Customize the mutationKey */ type MutationKey = Transformer; type Query = { /** * Define which HttpMethods can be used for queries * @default ['get'] */ methods: Array; /** * Path to the useQuery that will be used to do the useQuery functionality. * It will be used as `import { useQuery } from '${importPath}'`. * It allows both relative and absolute path. * the path will be applied as is, so relative path should be based on the file being generated. * @default '@tanstack/svelte-query' */ importPath?: string; }; type Mutation = { /** * Define which HttpMethods can be used for mutations * @default ['post', 'put', 'delete'] */ methods: Array; /** * Path to the useQuery that will be used to do the useQuery functionality. * It will be used as `import { useQuery } from '${importPath}'`. * It allows both relative and absolute path. * the path will be applied as is, so relative path should be based on the file being generated. * @default '@tanstack/svelte-query' */ importPath?: string; }; type Options$1 = { /** * Specify the export location for the files and define the behavior of the output * @default { path: 'hooks', barrelType: 'named' } */ output?: Output; /** * Define which contentType should be used. * By default, the first JSON valid mediaType will be used */ contentType?: contentType; /** * Group the @tanstack/query hooks based on the provided name. */ group?: Group; client?: Pick; /** * Array containing exclude parameters to exclude/skip tags/operations/methods/paths. */ exclude?: Array; /** * Array containing include parameters to include tags/operations/methods/paths. */ include?: Array; /** * Array containing override parameters to override `options` based on tags/operations/methods/paths. */ override?: Array>; /** * How to style your params, by default no casing is applied * - 'camelcase' will use camelcase for the params names */ paramsCasing?: 'camelcase'; /** * How to pass your params * - 'object' will return the params and pathParams as an object. * - 'inline' will return the params as comma separated params. * @default 'inline' */ paramsType?: 'object' | 'inline'; /** * How to pass your pathParams. * - 'object' will return the pathParams as an object. * - 'inline' will return the pathParams as comma separated params. * @default 'inline' */ pathParamsType?: PluginClient['options']['pathParamsType']; queryKey?: QueryKey; /** * Override some useQuery behaviours. */ query?: Partial | false; mutationKey?: MutationKey; /** * Override some useMutation behaviours. */ mutation?: Mutation | false; /** * Which parser should be used before returning the data to `@tanstack/query`. * `'zod'` will use `@kubb/plugin-zod` to parse the data. */ parser?: PluginClient['options']['parser']; transformers?: { /** * Customize the names based on the type that is provided by the plugin. */ name?: (name: ResolveNameParams['name'], type?: ResolveNameParams['type']) => string; }; /** * Define some generators next to the svelte-query generators */ generators?: Array>; }; type ResolvedOptions = { output: Output; group: Options$1['group']; client: NonNullable; parser: Required>; paramsCasing: Options$1['paramsCasing']; paramsType: NonNullable; pathParamsType: NonNullable; queryKey: QueryKey | undefined; query: NonNullable> | false; mutationKey: MutationKey | undefined; mutation: NonNullable> | false; }; type PluginSvelteQuery = PluginFactoryOptions<'plugin-svelte-query', Options$1, ResolvedOptions, never, ResolvePathOptions>; //#endregion export { OperationSchemas as a, ReactGenerator as i, PluginSvelteQuery as n, UserPluginWithLifeCycle as o, Transformer as r, Operation$1 as s, Options$1 as t }; //# sourceMappingURL=types-DAA4yhtI.d.cts.map