Globals.d.ts
Features
AXIOS_BASEfor Axios'sbaseURLAXIOS_HEADERSfor Axios'sheaders
See FileManager#getEnvSource for more information about how this works in the background.
ts
import type { KubbFile, Plugin, PluginFactoryOptions, ResolveNameParams } from '@kubb/core'
import type { Exclude, Include, Override, ResolvePathOptions } from '@kubb/plugin-oas'
import type { Client, Operations } from './components/index.ts'
type Templates = {
operations?: typeof Operations.templates | false
client?: typeof Client.templates | false
}
export type Options = {
output?: {
/**
* Output to save the clients.
* @default `"clients"``
*/
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' | 'barrelNamed' | false
}
/**
* Group the clients 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 clients.
*
* `{{tag}}` will be replaced by the current tagName.
* @example `${output}/{{tag}}Controller` => `clients/PetController`
* @default `${output}/{{tag}}Controller`
*/
output?: string
/**
* Name to be used for the `export * as {{exportAs}} from './`
* @default `"{{tag}}Service"`
*/
exportAs?: string
}
/**
* 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>>
client?: {
/**
* 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 allow both relative and absolute path.
* the path will be applied as is, so relative path shoule be based on the file being generated.
* @default '@kubb/swagger-client/client'
*/
importPath?: string
}
/**
* ReturnType that needs to be used when calling client().
*
* `Data` will return ResponseConfig[data].
*
* `Full` will return ResponseConfig.
* @default `'data'`
* @private
*/
dataReturnType?: 'data' | 'full'
/**
* How to pass your pathParams.
*
* `object` will return the pathParams as an object.
*
* `inline` will return the pathParams as comma separated params.
* @default `'inline'`
* @private
*/
pathParamsType?: 'object' | 'inline'
transformers?: {
/**
* Customize the names based on the type that is provided by the plugin.
*/
name?: (name: ResolveNameParams['name'], type?: ResolveNameParams['type']) => string
}
/**
* Make it possible to override one of the templates
*/
templates?: Partial<Templates>
}
type ResolvedOptions = {
client: Required<NonNullable<Options['client']>>
dataReturnType: NonNullable<Options['dataReturnType']>
pathParamsType: NonNullable<Options['pathParamsType']>
templates: NonNullable<Templates>
}
export type FileMeta = {
pluginKey?: Plugin['key']
tag?: string
}
export type PluginClient = PluginFactoryOptions<'plugin-client', Options, ResolvedOptions, never, ResolvePathOptions>
declare module '@kubb/core' {
export interface _Register {
['@kubb/swagger-client']: PluginClient
}
}ts
/// <reference no-default-lib="true" />
/// <reference lib="esnext" />
type Environments = import('./src/types.ts').Environments
declare module 'global' {
namespace NodeJS {
export interface ProcessEnv extends Partial<Record<keyof Environments, string>> {}
}
}
/**
* `tsconfig.json`
* @example
"compilerOptions": {
___ "types": ["@kubb/swagger-client/globals"]
}
* @example implementation
{
___ env?: NodeJS.ProcessEnv
}
*/
declare namespace NodeJS {
export interface ProcessEnv extends Partial<Record<keyof Environments, string>> {}
}TypeScript
To get TypeScript support for NodeJS.ProcessEnv(with already the process.env type being set), add @kubb/swagger-client/globals to your tsconfig.json:
typescript
{
"compilerOptions": {
"types": [
"@kubb/swagger-client/globals"
]
}
}Usage
ts
import crypto from 'node:crypto'
import { extname, resolve } from 'node:path'
import { orderBy } from 'natural-orderby'
import PQueue from 'p-queue'
import { isDeepEqual } from 'remeda'
import { BarrelManager } from './BarrelManager.ts'
import { getRelativePath, read } from './fs/read.ts'
import { write } from './fs/write.ts'
import { searchAndReplace } from './transformers/searchAndReplace.ts'
import { trimExtName } from './transformers/trim.ts'
import type { GreaterThan } from '@kubb/types'
import type { BarrelManagerOptions } from './BarrelManager.ts'
import type { Logger } from './logger.ts'
import transformers from './transformers/index.ts'
import type { Plugin } from './types.ts'
import { getParser } from './utils'
type BasePath<T extends string = string> = `${T}/`
export namespace KubbFile {
export type Import = {
/**
* Import name to be used
* @example ["useState"]
* @example "React"
*/
name:
| string
| Array<
| string
| {
propertyName: string
name?: string
}
>
/**
* Path for the import
* @xample '@kubb/core'
*/
path: string
/**
* Add `type` prefix to the import, this will result in: `import type { Type } from './path'`.
*/
isTypeOnly?: boolean
/**
* Add `* as` prefix to the import, this will result in: `import * as path from './path'`.
*/
isNameSpace?: boolean
/**
* When root is set it will get the path with relative getRelativePath(root, path).
*/
root?: string
}
Notes
This feature could be useful for:
- Types support for 'axios' options
- Prototyping