@kubb/core 1.11.0-canary.20231011T130347 → 1.11.0-canary.20231011T170015

package/dist/index.d.cts

@@ -1,740 +0,0 @@
-import { DirectoryTreeOptions } from 'directory-tree';
-import { Ora } from 'ora';
-export { default as pc } from 'picocolors';
-
-declare function isPromise<T>(result: PossiblePromise<T>): result is Promise<T>;
-declare function isPromiseFulfilledResult<T = unknown>(result: PromiseSettledResult<unknown>): result is PromiseFulfilledResult<T>;
-declare function isPromiseRejectedResult<T>(result: PromiseSettledResult<unknown>): result is Omit<PromiseRejectedResult, 'reason'> & {
-    reason: T;
-};
-
-declare function write(data: string, path: string): Promise<void>;
-
-interface Cache<TStore extends object = object> {
-    delete(id: keyof TStore): boolean;
-    get(id: keyof TStore): TStore[keyof TStore] | null;
-    has(id: keyof TStore): boolean;
-    set(id: keyof TStore, value: unknown): void;
-}
-declare function createPluginCache<TStore extends PluginCache>(Store?: TStore): Cache<TStore>;
-
-declare function getRelativePath(rootDir?: string | null, filePath?: string | null, platform?: 'windows' | 'mac' | 'linux'): string;
-type PathMode = 'file' | 'directory';
-declare function getPathMode(path: string | undefined | null): PathMode;
-declare function read(path: string): Promise<string>;
-
-type FunctionParamsAst = {
-    name: string;
-    type?: string;
-    /**
-     * @default true
-     */
-    required?: boolean;
-    /**
-     * @default true
-     */
-    enabled?: boolean;
-    default?: string;
-};
-/**
- * Convert an string array to a string of parameters that can be used inside a function
- * The parameter name is converted to `camelcase`
- */
-declare function createFunctionParams(data: FunctionParamsAst[]): string;
-
-declare function nameSorter<T extends {
-    name: string;
-}>(a: T, b: T): 0 | 1 | -1;
-
-declare function createJSDocBlockText({ comments }: {
-    comments: Array<string>;
-}): string;
-
-declare function getUniqueName(originalName: string, data: Record<string, number>): string;
-
-declare function timeout(ms: number): Promise<unknown>;
-
-type QueueJob<T = unknown> = {
-    (...args: unknown[]): Promise<T> | Promise<void>;
-};
-type RunOptions = {
-    controller?: AbortController;
-    name?: string;
-    description?: string;
-};
-declare class Queue {
-    private queue;
-    private workerCount;
-    private maxParallel;
-    private debug;
-    constructor(maxParallel: number, debug?: boolean);
-    run<T>(job: QueueJob<T>, options?: RunOptions): Promise<T>;
-    runSync<T>(job: QueueJob<T>, options?: RunOptions): void;
-    get hasJobs(): boolean;
-    private work;
-}
-
-declare function escape(text?: string): string;
-/**
- * Escape all characters not included in SingleStringCharacters and DoubleStringCharacters on
- * @link http://www.ecma-international.org/ecma-262/5.1/#sec-7.8.4
- * @link https://github.com/joliss/js-string-escape/blob/master/index.js
- */
-declare function jsStringEscape(input: any): string;
-
-declare function transformReservedWord(word: string): string;
-
-declare function combineCodes(codes: string[]): string;
-
-declare function renderTemplate<TData extends Record<string, unknown> = Record<string, unknown>>(template: string, data?: TData | undefined): string;
-
-declare function clean(path: string): Promise<void>;
-
-type TreeNodeOptions = DirectoryTreeOptions;
-declare class TreeNode<T = unknown> {
-    data: T;
-    parent?: TreeNode<T>;
-    children: Array<TreeNode<T>>;
-    constructor(data: T, parent?: TreeNode<T>);
-    addChild(data: T): TreeNode<T>;
-    find(data?: T): TreeNode<T> | null;
-    get leaves(): TreeNode<T>[];
-    get root(): TreeNode<T>;
-    forEach(callback: (treeNode: TreeNode<T>) => void): this;
-    static build<T = unknown>(path: string, options?: TreeNodeOptions): TreeNode<T> | null;
-}
-
-declare const uniqueIdFactory: (counter: number) => (str?: string) => string;
-
-/**
- * Normalizes directories to have a trailing slash.
- * Resolve is pretty finicky -- if the directory name doesn't have
- * a trailing slash then it tries to look in the parent directory.
- * i.e., if the directory is "/usr/nzakas/foo" it will start the
- * search in /usr/nzakas. However, if the directory is "/user/nzakas/foo/",
- * then it will start the search in /user/nzakas/foo.
- * @param {string} directory The directory to check.
- * @returns {string} The normalized directory.
- */
-declare function normalizeDirectory(directory: string): string;
-declare function getLocation(path: string, cwd?: string): string;
-declare function importModule(path: string, cwd?: string): Promise<any | undefined>;
-
-declare const throttle: <R, A extends any[]>(fn: (...args: A) => R, delay: number) => [(...args: A) => R | undefined, () => void];
-
-declare class SummaryError extends Error {
-    summary: string[];
-    constructor(message: string, options: {
-        cause: Error;
-        summary?: string[];
-    });
-}
-
-/**
- * Behaves as an Error to log a warning in the console(still stops the execution)
- */
-declare class Warning extends Error {
-    constructor(message?: string, options?: {
-        cause: Error;
-    });
-}
-
-type LogType = 'error' | 'info' | 'warning';
-type Logger = {
-    log: (message: string | null) => void;
-    error: (message: string | null) => void;
-    info: (message: string | null) => void;
-    warn: (message: string | null) => void;
-    spinner?: Ora;
-    logs: string[];
-};
-declare function createLogger(spinner?: Ora): Logger;
-
-declare const defaultColours: readonly ["black", "blue", "darkBlue", "cyan", "gray", "green", "darkGreen", "magenta", "red", "darkRed", "yellow", "darkYellow"];
-declare function randomColour(text?: string, colours?: readonly ["black", "blue", "darkBlue", "cyan", "gray", "green", "darkGreen", "magenta", "red", "darkRed", "yellow", "darkYellow"]): string;
-declare function randomPicoColour(text?: string, colors?: readonly ["black", "blue", "darkBlue", "cyan", "gray", "green", "darkGreen", "magenta", "red", "darkRed", "yellow", "darkYellow"]): string;
-
-type URLObject = {
-    url: string;
-    params?: Record<string, string>;
-};
-type ObjectOptions = {
-    type?: 'path' | 'template';
-    replacer?: (pathParam: string) => string;
-    stringify?: boolean;
-};
-declare class URLPath {
-    path: string;
-    constructor(path: string);
-    /**
-     * Convert Swagger path to URLPath(syntax of Express)
-     * @example /pet/{petId} => /pet/:petId
-     */
-    get URL(): string;
-    get isUrl(): boolean;
-    /**
-     * Convert Swagger path to template literals/ template strings(camelcase)
-     * @example /pet/{petId} => `/pet/${petId}`
-     * @example /account/monetary-accountID => `/account/${monetaryAccountId}`
-     * @example /account/userID => `/account/${userId}`
-     */
-    get template(): string;
-    get object(): URLObject | string;
-    get params(): Record<string, string> | undefined;
-    toObject(options?: ObjectOptions): URLObject | string;
-    /**
-     * Convert Swagger path to template literals/ template strings(camelcase)
-     * @example /pet/{petId} => `/pet/${petId}`
-     * @example /account/monetary-accountID => `/account/${monetaryAccountId}`
-     * @example /account/userID => `/account/${userId}`
-     */
-    toTemplateString(replacer?: (pathParam: string) => string): string;
-    /**
-     * Convert Swagger path to template literals/ template strings(camelcase)
-     * @example /pet/{petId} => `/pet/${petId}`
-     * @example /account/monetary-accountID => `/account/${monetaryAccountId}`
-     * @example /account/userID => `/account/${userId}`
-     */
-    static toTemplateString(path: string, replacer?: (pathParam: string) => string): string;
-    getParams(replacer?: (pathParam: string) => string): Record<string, string> | undefined;
-    static getParams(path: string, replacer?: (pathParam: string) => string): Record<string, string> | undefined;
-    /**
-     * Convert Swagger path to URLPath(syntax of Express)
-     * @example /pet/{petId} => /pet/:petId
-     */
-    toURLPath(): string;
-    static toURLPath(path: string): string;
-    static toObject(path: string, { type, replacer, stringify }?: ObjectOptions): URLObject | string;
-    static isURL(path: string): boolean;
-}
-
-type Import = {
-    name: string | string[];
-    path: string;
-    isTypeOnly?: boolean;
-};
-type Export = {
-    name?: string | string[];
-    path: string;
-    isTypeOnly?: boolean;
-    asAlias?: boolean;
-};
-type UUID = string;
-type Source = string;
-type File<Meta extends {
-    pluginName?: string;
-} = {
-    pluginName?: string;
-}> = {
-    /**
-     * Name to be used to dynamicly create the fileName(based on input.path)
-     */
-    fileName: string;
-    /**
-     * Path will be full qualified path to a specified file
-     */
-    path: Path;
-    source: Source;
-    imports?: Import[];
-    exports?: Export[];
-    /**
-     * This will call fileManager.add instead of fileManager.addOrAppend, adding the source when the files already exists
-     * @default `false`
-     */
-    override?: boolean;
-    meta?: Meta;
-    /**
-     * This will override `process.env[key]` inside the `source`, see `getFileSource`.
-     */
-    env?: NodeJS.ProcessEnv;
-};
-type ResolvedFile = File & {
-    /**
-     * crypto.randomUUID()
-     */
-    id: UUID;
-};
-type CacheItem = ResolvedFile & {
-    cancel?: () => void;
-};
-type Status = 'new' | 'success' | 'removed';
-
-declare function getIndexes(root: string, options?: TreeNodeOptions): File[] | null;
-declare function combineFiles(files: Array<File | null>): File[];
-/**
- * Support for js, ts and tsx(React)
- */
-type Extension = '.ts' | '.js' | '.tsx';
-declare const extensions: Array<Extension>;
-declare function isExtensionAllowed(fileName: string): boolean;
-declare function combineExports(exports: Export[]): Export[];
-declare function combineImports(imports: Import[], exports: Export[], source: string): Import[];
-declare function createFileSource(file: File): string;
-
-declare class FileManager {
-    private cache;
-    private task?;
-    private queue?;
-    constructor(options?: {
-        queue?: Queue;
-        task?: QueueJob<ResolvedFile>;
-    });
-    get extensions(): Extension[];
-    get files(): File[];
-    get isExecuting(): boolean;
-    add(file: File): Promise<ResolvedFile>;
-    addOrAppend(file: File): Promise<ResolvedFile>;
-    private append;
-    getCacheByUUID(UUID: UUID): File | undefined;
-    get(path: Path): File[] | undefined;
-    remove(path: Path): void;
-    write(...params: Parameters<typeof write>): Promise<void>;
-    read(...params: Parameters<typeof read>): Promise<string>;
-}
-
-declare class PluginError extends Error {
-    pluginManager: PluginManager;
-    cause: Error;
-    constructor(message: string, options: {
-        cause: Error;
-        pluginManager: PluginManager;
-    });
-}
-
-/**
- * Get the type of the first argument in a function.
- * @example Arg0<(a: string, b: number) => void> -> string
- */
-type Argument0<H extends keyof PluginLifecycle> = Parameters<PluginLifecycle[H]>[0];
-type Strategy = 'hookFirst' | 'hookForPlugin' | 'hookParallel' | 'hookReduceArg0' | 'hookSeq';
-type Executer<H extends PluginLifecycleHooks = PluginLifecycleHooks> = {
-    strategy: Strategy;
-    hookName: H;
-    plugin: KubbPlugin;
-    parameters?: unknown[] | undefined;
-    output?: unknown;
-};
-type ParseResult<H extends PluginLifecycleHooks> = PluginLifecycle[H];
-type SafeParseResult<H extends PluginLifecycleHooks, Result = ReturnType<ParseResult<H>>> = {
-    result: Result;
-    plugin: KubbPlugin;
-};
-
-declare const hooks: [keyof PluginLifecycle<PluginFactoryOptions<string, unknown, false, any, Record<string, unknown>>>];
-type Options$1 = {
-    debug?: boolean;
-    task: QueueJob<ResolvedFile>;
-    logger: Logger;
-};
-type Events = {
-    execute: [executer: Executer];
-    executed: [executer: Executer];
-    error: [pluginError: PluginError];
-};
-declare class PluginManager {
-    plugins: KubbPlugin[];
-    readonly fileManager: FileManager;
-    private readonly core;
-    queue: Queue;
-    executed: Executer[];
-    logger: Logger;
-    private eventEmitter;
-    constructor(config: KubbConfig, options: Options$1);
-    resolvePath: (params: ResolvePathParams) => OptionalPath;
-    resolveName: (params: ResolveNameParams) => string;
-    on<TEventName extends keyof Events & string>(eventName: TEventName, handler: (...eventArg: Events[TEventName]) => void): void;
-    /**
-     *
-     * Run only hook for a specific plugin name
-     */
-    hookForPlugin<H extends PluginLifecycleHooks>({ pluginName, hookName, parameters, }: {
-        pluginName: string;
-        hookName: H;
-        parameters: Parameters<PluginLifecycle[H]>;
-    }): Promise<ReturnType<ParseResult<H>> | null> | null;
-    hookForPluginSync<H extends PluginLifecycleHooks>({ pluginName, hookName, parameters, }: {
-        pluginName: string;
-        hookName: H;
-        parameters: Parameters<PluginLifecycle[H]>;
-    }): ReturnType<ParseResult<H>> | null;
-    /**
-     *
-     * Chains, first non-null result stops and returns
-     */
-    hookFirst<H extends PluginLifecycleHooks>({ hookName, parameters, skipped, }: {
-        hookName: H;
-        parameters: Parameters<PluginLifecycle[H]>;
-        skipped?: ReadonlySet<KubbPlugin> | null;
-    }): Promise<SafeParseResult<H>>;
-    /**
-     *
-     * Chains, first non-null result stops and returns
-     */
-    hookFirstSync<H extends PluginLifecycleHooks>({ hookName, parameters, skipped, }: {
-        hookName: H;
-        parameters: Parameters<PluginLifecycle[H]>;
-        skipped?: ReadonlySet<KubbPlugin> | null;
-    }): SafeParseResult<H>;
-    /**
-     *
-     * Parallel, runs all plugins
-     */
-    hookParallel<H extends PluginLifecycleHooks, TOuput = void>({ hookName, parameters, }: {
-        hookName: H;
-        parameters?: Parameters<PluginLifecycle[H]> | undefined;
-    }): Promise<Awaited<TOuput>[]>;
-    /**
-     *
-     * Chains, reduces returned value, handling the reduced value as the first hook argument
-     */
-    hookReduceArg0<H extends PluginLifecycleHooks>({ hookName, parameters, reduce, }: {
-        hookName: H;
-        parameters: Parameters<PluginLifecycle[H]>;
-        reduce: (reduction: Argument0<H>, result: ReturnType<ParseResult<H>>, plugin: KubbPlugin) => PossiblePromise<Argument0<H> | null>;
-    }): Promise<Argument0<H>>;
-    /**
-     * Chains plugins
-     */
-    hookSeq<H extends PluginLifecycleHooks>({ hookName, parameters }: {
-        hookName: H;
-        parameters?: Parameters<PluginLifecycle[H]>;
-    }): Promise<void>;
-    private getSortedPlugins;
-    getPlugin(hookName: keyof PluginLifecycle, pluginName: string): KubbPlugin;
-    private addExecutedToCallStack;
-    /**
-     * Run an async plugin hook and return the result.
-     * @param hookName Name of the plugin hook. Must be either in `PluginHooks` or `OutputPluginValueHooks`.
-     * @param args Arguments passed to the plugin hook.
-     * @param plugin The actual pluginObject to run.
-     */
-    private execute;
-    /**
-     * Run a sync plugin hook and return the result.
-     * @param hookName Name of the plugin hook. Must be in `PluginHooks`.
-     * @param args Arguments passed to the plugin hook.
-     * @param plugin The acutal plugin
-     * @param replaceContext When passed, the plugin context can be overridden.
-     */
-    private executeSync;
-    private catcher;
-}
-
-declare class ValidationPluginError extends Error {
-}
-declare function getDependedPlugins<TPlugins extends KubbPlugin[]>(plugins: KubbPlugin[], dependedPluginNames: string | string[]): TPlugins;
-
-declare class ParallelPluginError extends Error {
-    errors: PluginError[];
-    pluginManager: PluginManager;
-    constructor(message: string, options: {
-        cause?: Error;
-        errors: PluginError[];
-        pluginManager: PluginManager;
-    });
-    findError<T extends Error = Error>(searchError: T | undefined): T | undefined;
-}
-
-/**
- * @deprecated
- */
-interface Register {
-}
-type PossiblePromise<T> = Promise<T> | T;
-/**
- * Config used in `kubb.config.js`
- *
- * @example import { defineConfig } from '@kubb/core'
- * export default defineConfig({
- * ...
- * })
- */
-type KubbUserConfig = Omit<KubbConfig, 'root' | 'plugins'> & {
-    /**
-     * Project root directory. Can be an absolute path, or a path relative from
-     * the location of the config file itself.
-     * @default process.cwd()
-     */
-    root?: string;
-    /**
-     * Plugin type can be KubbJSONPlugin or KubbPlugin
-     * Example: ['@kubb/swagger', { output: false }]
-     * Or: createSwagger({ output: false })
-     */
-    plugins?: KubbPlugin[] | KubbJSONPlugins[] | KubbObjectPlugins;
-};
-/**
- * Global/internal config used through out the full generation.
- */
-type KubbConfig = {
-    /**
-     * Project root directory. Can be an absolute path, or a path relative from
-     * the location of the config file itself.
-     * @default process.cwd()
-     */
-    root: string;
-    input: {
-        /**
-         * Path to be used as the input. Can be an absolute path, or a path relative from
-         * the defined root option.
-         */
-        path: string;
-    };
-    output: {
-        /**
-         * Path to be used to export all generated files. Can be an absolute path, or a path relative based of the defined root option.
-         */
-        path: string;
-        /**
-         * Remove previous generated files and folders.
-         */
-        clean?: boolean;
-        /**
-         * Enabled or disable the writing to the filesystem. This is being used for the playground.
-         * @default true
-         */
-        write?: boolean;
-    };
-    /**
-     * Array of Kubb plugins to use.
-     * The plugin/package can forsee some options that you need to pass through.
-     * Sometimes a plugin is depended on another plugin, if that's the case you will get an error back from the plugin you installed.
-     */
-    plugins?: KubbPlugin[];
-    /**
-     * Hooks that will be called when a specific action is triggered in Kubb.
-     */
-    hooks?: {
-        /**
-         * Hook that will be triggerend at the end of all executions.
-         * Useful for running Prettier or ESLint to use your own linting structure.
-         */
-        done?: string | string[];
-    };
-};
-type CLIOptions = {
-    /**
-     * Path to `kubb.config.js`
-     */
-    config?: string;
-    /**
-     * Watch changes on input
-     */
-    watch?: string;
-    /**
-     * Log level to report when using the CLI
-     *
-     * `silent` will hide all information that is not relevant
-     *
-     * `info` will show all information possible(not related to the PluginManager)
-     *
-     * `debug` will show all information possible(related to the PluginManager), handy for seeing logs
-     * @default `silent`
-     */
-    logLevel?: LogLevel;
-};
-type BuildOutput = {
-    files: FileManager['files'];
-    pluginManager: PluginManager;
-};
-type KubbPluginKind = 'schema' | 'controller';
-type KubbJSONPlugins = [plugin: keyof Kubb.OptionsPlugins | (string & {}), options: Kubb.OptionsPlugins[keyof Kubb.OptionsPlugins]];
-type KubbObjectPlugin = keyof Kubb.OptionsPlugins;
-type KubbObjectPlugins = {
-    [K in keyof Kubb.OptionsPlugins]: Kubb.OptionsPlugins[K] | object;
-};
-type KubbUserPlugin<TOptions extends PluginFactoryOptions = PluginFactoryOptions> = {
-    /**
-     * Unique name used for the plugin
-     * @example @kubb/typescript
-     */
-    name: PluginFactoryOptions['name'];
-    /**
-     * Options set for a specific plugin(see kubb.config.js), passthrough of options.
-     */
-    options?: TOptions['options'];
-    /**
-     * Kind/type for the plugin
-     * Type 'schema' can be used for JSON schema's, TypeScript types, ...
-     * Type 'controller' can be used to create generate API calls, React-Query hooks, Axios controllers, ...
-     * @default undefined
-     */
-    kind?: KubbPluginKind;
-    /**
-     * Define an api that can be used by other plugins, see `PluginManager' where we convert from `KubbUserPlugin` to `KubbPlugin`(used when calling `createPlugin`).
-     */
-    api?: (this: Omit<PluginContext, 'addFile'>) => TOptions['api'];
-} & Partial<PluginLifecycle<TOptions>>;
-type KubbPlugin<TOptions extends PluginFactoryOptions = PluginFactoryOptions> = {
-    /**
-     * Unique name used for the plugin
-     * @example @kubb/typescript
-     */
-    name: PluginFactoryOptions['name'];
-    /**
-     * Options set for a specific plugin(see kubb.config.js), passthrough of options.
-     */
-    options?: TOptions['options'];
-    /**
-     * Kind/type for the plugin
-     * Type 'schema' can be used for JSON schema's, TypeScript types, ...
-     * Type 'controller' can be used to create generate API calls, React-Query hooks, Axios controllers, ...
-     * @default undefined
-     */
-    kind?: KubbPluginKind;
-    /**
-     * Define an api that can be used by other plugins, see `PluginManager' where we convert from `KubbUserPlugin` to `KubbPlugin`(used when calling `createPlugin`).
-     */
-    api?: TOptions['api'];
-} & Partial<PluginLifecycle<TOptions>>;
-type PluginFactoryOptions<Name = string, Options = unknown, Nested extends boolean = false, API = any, resolvePathOptions = Record<string, unknown>> = {
-    name: Name;
-    options: Options;
-    nested: Nested;
-    api: API;
-    resolvePathOptions: resolvePathOptions;
-};
-type PluginLifecycle<TOptions extends PluginFactoryOptions = PluginFactoryOptions> = {
-    /**
-     * Valdiate all plugins to see if their depended plugins are installed and configured.
-     * @type hookParallel
-     */
-    validate: (this: Omit<PluginContext, 'addFile'>, plugins: KubbPlugin[]) => PossiblePromise<true>;
-    /**
-     * Start of the lifecycle of a plugin.
-     * @type hookParallel
-     */
-    buildStart: (this: PluginContext, kubbConfig: KubbConfig) => PossiblePromise<void>;
-    /**
-     * Resolve to a Path based on a fileName(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, fileName: string, directory?: string, options?: TOptions['resolvePathOptions']) => OptionalPath;
-    /**
-     * Resolve to a name based on a string.
-     * Useful when converting to PascalCase or camelCase.
-     * @type hookFirst
-     * @example ('pet') => 'Pet'
-     */
-    resolveName: (this: PluginContext, name: string) => string;
-    /**
-     * Makes it possible to run async logic to override the path defined previously by `resolvePath`.
-     * @type hookFirst
-     */
-    load: (this: Omit<PluginContext, 'addFile'>, path: Path) => PossiblePromise<TransformResult | null>;
-    /**
-     * Transform the source-code.
-     * @type hookReduceArg0
-     */
-    transform: (this: Omit<PluginContext, 'addFile'>, source: string, path: Path) => PossiblePromise<TransformResult>;
-    /**
-     * Write the result to the file-system based on the id(defined by `resolvePath` or changed by `load`).
-     * @type hookParallel
-     */
-    writeFile: (this: Omit<PluginContext, 'addFile'>, source: string | undefined, path: Path) => PossiblePromise<void>;
-    /**
-     * End of the plugin lifecycle.
-     * @type hookParallel
-     */
-    buildEnd: (this: PluginContext) => PossiblePromise<void>;
-};
-type PluginLifecycleHooks = keyof PluginLifecycle;
-type PluginCache = Record<string, [number, unknown]>;
-type ResolvePathParams<TOptions = Record<string, unknown>> = {
-    /**
-     * When set, resolvePath will only call resolvePath of the name of the plugin set here.
-     * If not defined it will fall back on the resolvePath of the core plugin.
-     */
-    pluginName?: string;
-    fileName: string;
-    directory?: string | undefined;
-    /**
-     * Options to be passed to 'resolvePath' 3th parameter
-     */
-    options?: TOptions;
-};
-type ResolveNameParams = {
-    /**
-     * When set, resolvePath will only call resolvePath of the name of the plugin set here.
-     * If not defined it will fall back on the resolvePath of the core plugin.
-     */
-    pluginName?: string;
-    name: string;
-};
-type PluginContext<TOptions = Record<string, unknown>> = {
-    config: KubbConfig;
-    cache: Cache<PluginCache>;
-    fileManager: FileManager;
-    addFile: (...file: File[]) => Promise<File[]>;
-    resolvePath: (params: ResolvePathParams<TOptions>) => OptionalPath;
-    resolveName: (params: ResolveNameParams) => string;
-    logger: Logger;
-    plugins: KubbPlugin[];
-};
-type TransformResult = string | null;
-/**
- * @description Computing the name of a file or directory together with its position in relation to other directories traced back in a line to the root
- */
-type Path = string;
-type OptionalPath = Path | null | undefined;
-type FileName = string | null | undefined;
-declare const LogLevel: {
-    readonly silent: "silent";
-    readonly info: "info";
-    readonly debug: "debug";
-};
-type LogLevel = keyof typeof LogLevel;
-
-type BuildOptions = {
-    config: PluginContext['config'];
-    /**
-     * @default Logger without the spinner
-     */
-    logger?: Logger;
-    logLevel?: LogLevel;
-};
-declare function build(options: BuildOptions): Promise<BuildOutput>;
-
-/**
- * Type helper to make it easier to use kubb.config.js
- * accepts a direct {@link KubbConfig} object, or a function that returns it.
- * The function receives a {@link ConfigEnv} object that exposes two properties:
- */
-declare function defineConfig(options: PossiblePromise<KubbUserConfig> | ((
-/** The options derived from the CLI flags */
-cliOptions: CLIOptions) => PossiblePromise<KubbUserConfig>)): typeof options;
-
-type KubbPluginFactory<T extends PluginFactoryOptions = PluginFactoryOptions> = (options: T['options']) => T['nested'] extends true ? Array<KubbUserPlugin<T>> : KubbUserPlugin<T>;
-declare function createPlugin<T extends PluginFactoryOptions = PluginFactoryOptions>(factory: KubbPluginFactory<T>): (options: T['options']) => ReturnType<KubbPluginFactory<T>>;
-type Options = {
-    config: PluginContext['config'];
-    fileManager: FileManager;
-    resolvePath: PluginContext['resolvePath'];
-    resolveName: PluginContext['resolveName'];
-    logger: PluginContext['logger'];
-    getPlugins: () => KubbPlugin[];
-};
-type CorePluginOptions = PluginFactoryOptions<'core', Options, false, PluginContext>;
-declare const pluginName: CorePluginOptions['name'];
-
-/**
- * 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 Generator<TOptions extends object = object> {
-    private _options;
-    constructor(options?: TOptions);
-    get options(): TOptions;
-    abstract build(...params: unknown[]): unknown;
-}
-
-/**
- * Abstract class that contains the building blocks for plugins to create their own SchemaGenerator
- */
-declare abstract class SchemaGenerator<TOptions extends object, TInput, TOutput> extends Generator<TOptions> {
-    abstract build(schema: TInput, name: string, description?: string): TOutput;
-}
-
-export { Argument0, BuildOutput, CLIOptions, Cache, CacheItem, Executer, Export, Extension, File, FileManager, FileName, Generator, Import, KubbConfig, KubbJSONPlugins, KubbObjectPlugin, KubbObjectPlugins, KubbPlugin, KubbPluginKind, KubbUserConfig, KubbUserPlugin, LogLevel, LogType, Logger, OptionalPath, ParallelPluginError, ParseResult, Path, PathMode, PluginCache, PluginContext, PluginError, PluginFactoryOptions, PluginLifecycle, PluginLifecycleHooks, PluginManager, PossiblePromise, Queue, QueueJob, Register, ResolveNameParams, ResolvePathParams, ResolvedFile, SafeParseResult, SchemaGenerator, Source, Status, Strategy, SummaryError, TransformResult, TreeNode, TreeNodeOptions, URLPath, UUID, ValidationPluginError, Warning, build, clean, combineCodes, combineExports, combineFiles, combineImports, createFileSource, createFunctionParams, createJSDocBlockText, createLogger, createPlugin, createPluginCache, build as default, defaultColours, defineConfig, escape, extensions, getDependedPlugins, getIndexes, getLocation, getPathMode, getRelativePath, getUniqueName, hooks, importModule, isExtensionAllowed, isPromise, isPromiseFulfilledResult, isPromiseRejectedResult, jsStringEscape, pluginName as name, nameSorter, normalizeDirectory, pluginName, randomColour, randomPicoColour, read, renderTemplate, throttle, timeout, transformReservedWord, uniqueIdFactory, write };