@kubb/core 1.12.0-canary.20231018T090722 → 1.12.0-canary.20231018T095854

package/dist/index.d.cts

@@ -1,5 +1,5 @@
-import { DirectoryTreeOptions } from 'directory-tree';
 import { Ora } from 'ora';
+import { DirectoryTreeOptions } from 'directory-tree';
 export { default as pc } from 'picocolors';
 
 declare function isPromise<T>(result: PossiblePromise<T>): result is Promise<T>;
@@ -18,41 +18,71 @@ interface Cache<TStore extends object = object> {
 }
 declare function createPluginCache<TStore extends PluginCache>(Store?: TStore): Cache<TStore>;
 
+type BasePath<T extends string = string> = `${T}/`;
+type CacheItem = KubbFile.ResolvedFile & {
+    cancel?: () => void;
+};
+declare namespace KubbFile {
+    type Import = {
+        name: string | Array<string>;
+        path: string;
+        isTypeOnly?: boolean;
+    };
+    type Export = {
+        name?: string | Array<string>;
+        path: string;
+        isTypeOnly?: boolean;
+        asAlias?: boolean;
+    };
+    type UUID = string;
+    type Source = string;
+    type Extname = '.ts' | '.js' | '.tsx' | `.${string}`;
+    type Mode = 'file' | 'directory';
+    type BaseName = `${string}${Extname}`;
+    type Path = string;
+    type AdvancedPath<T extends BaseName = BaseName> = `${BasePath}${T}`;
+    type OptionalPath = Path | undefined | null;
+    type File<TMeta extends {
+        pluginName?: string;
+    } = {
+        pluginName?: string;
+    }, TBaseName extends BaseName = BaseName> = {
+        /**
+         * Name to be used to dynamicly create the baseName(based on input.path)
+         * Based on UNIX basename
+         * @link https://nodejs.org/api/path.html#pathbasenamepath-suffix
+         */
+        baseName: TBaseName;
+        /**
+         * Path will be full qualified path to a specified file
+         */
+        path: AdvancedPath<TBaseName> | 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?: TMeta;
+        /**
+         * This will override `process.env[key]` inside the `source`, see `getFileSource`.
+         */
+        env?: NodeJS.ProcessEnv;
+    };
+    type ResolvedFile = KubbFile.File & {
+        /**
+         * crypto.randomUUID()
+         */
+        id: UUID;
+    };
+}
+
 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 getPathMode(path: string | undefined | null): KubbFile.Mode;
 declare function read(path: string): Promise<string>;
-
-type FunctionParamsAST = {
-    name?: string;
-    type?: string;
-    /**
-     * @default true
-     */
-    required?: boolean;
-    /**
-     * @default true
-     */
-    enabled?: boolean;
-    default?: string;
-} | {
-    name?: never;
-    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(ast: FunctionParamsAST[]): string;
+declare function readSync(path: string): string;
 
 declare function nameSorter<T extends {
     name: string;
@@ -221,68 +251,38 @@ declare class URLPath {
     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;
+type FunctionParamsAST = {
+    name?: string;
+    type?: string;
     /**
-     * Path will be full qualified path to a specified file
+     * @default true
      */
-    path: Path;
-    source: Source;
-    imports?: Import[];
-    exports?: Export[];
+    required?: boolean;
     /**
-     * This will call fileManager.add instead of fileManager.addOrAppend, adding the source when the files already exists
-     * @default `false`
+     * @default true
      */
-    override?: boolean;
-    meta?: Meta;
+    enabled?: boolean;
+    default?: string;
+} | {
+    name?: never;
+    type: string;
     /**
-     * This will override `process.env[key]` inside the `source`, see `getFileSource`.
+     * @default true
      */
-    env?: NodeJS.ProcessEnv;
-};
-type ResolvedFile = File & {
+    required?: boolean;
     /**
-     * crypto.randomUUID()
+     * @default true
      */
-    id: UUID;
-};
-type CacheItem = ResolvedFile & {
-    cancel?: () => void;
+    enabled?: boolean;
+    default?: string;
 };
-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 FunctionParams {
+    type?: 'generics' | 'typed';
+    items: FunctionParamsAST[];
+    constructor(type?: 'generics' | 'typed');
+    add(item: FunctionParamsAST | Array<FunctionParamsAST | undefined> | undefined): FunctionParams;
+    toString(): string;
+}
 
 declare class FileManager {
     private cache;
@@ -290,21 +290,32 @@ declare class FileManager {
     private queue?;
     constructor(options?: {
         queue?: Queue;
-        task?: QueueJob<ResolvedFile>;
+        task?: QueueJob<KubbFile.ResolvedFile>;
     });
-    get extensions(): Extension[];
-    get files(): File[];
+    get extensions(): Array<KubbFile.Extname>;
+    get files(): Array<KubbFile.File>;
     get isExecuting(): boolean;
-    add(file: File): Promise<ResolvedFile>;
-    addOrAppend(file: File): Promise<ResolvedFile>;
+    add(file: KubbFile.File): Promise<KubbFile.ResolvedFile>;
+    addOrAppend(file: KubbFile.File): Promise<KubbFile.ResolvedFile>;
     private append;
-    getCacheByUUID(UUID: UUID): File | undefined;
-    get(path: Path): File[] | undefined;
-    remove(path: Path): void;
+    getCacheByUUID(UUID: KubbFile.UUID): KubbFile.File | undefined;
+    get(path: KubbFile.Path): Array<KubbFile.File> | undefined;
+    remove(path: KubbFile.Path): void;
     write(...params: Parameters<typeof write>): Promise<void>;
     read(...params: Parameters<typeof read>): Promise<string>;
 }
 
+declare function getIndexes(root: string, options?: TreeNodeOptions): Array<KubbFile.File> | null;
+declare function combineFiles(files: Array<KubbFile.File | null>): Array<KubbFile.File>;
+/**
+ * Support for js, ts and tsx(React)
+ */
+declare const extensions: Array<KubbFile.Extname>;
+declare function isExtensionAllowed(baseName: string): boolean;
+declare function combineExports(exports: Array<KubbFile.Export>): Array<KubbFile.Export>;
+declare function combineImports(imports: Array<KubbFile.Import>, exports: Array<KubbFile.Export>, source: string): Array<KubbFile.Import>;
+declare function createFileSource(file: KubbFile.File): string;
+
 declare class EventEmitter<TEvents extends Record<string, any>> {
     constructor();
     private emitter;
@@ -345,7 +356,7 @@ type SafeParseResult<H extends PluginLifecycleHooks, Result = ReturnType<ParseRe
 declare const hooks: [keyof PluginLifecycle<PluginFactoryOptions<string, unknown, false, any, Record<string, unknown>>>];
 type Options$1 = {
     debug?: boolean;
-    task: QueueJob<ResolvedFile>;
+    task: QueueJob<KubbFile.ResolvedFile>;
     logger: Logger;
 };
 type Events = {
@@ -362,7 +373,7 @@ declare class PluginManager {
     readonly logger: Logger;
     private readonly core;
     constructor(config: KubbConfig, options: Options$1);
-    resolvePath: (params: ResolvePathParams) => OptionalPath;
+    resolvePath: (params: ResolvePathParams) => KubbFile.OptionalPath;
     resolveName: (params: ResolveNameParams) => string;
     on<TEventName extends keyof Events & string>(eventName: TEventName, handler: (...eventArg: Events[TEventName]) => void): void;
     /**
@@ -457,12 +468,6 @@ declare class ParallelPluginError extends Error {
     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`
  *
@@ -483,7 +488,7 @@ type KubbUserConfig = Omit<KubbConfig, 'root' | 'plugins'> & {
      * Example: ['@kubb/swagger', { output: false }]
      * Or: createSwagger({ output: false })
      */
-    plugins?: KubbPlugin[] | KubbJSONPlugins[] | KubbObjectPlugins;
+    plugins?: Array<KubbPlugin> | Array<KubbJSONPlugins> | KubbObjectPlugins;
 };
 /**
  * Global/internal config used through out the full generation.
@@ -522,7 +527,7 @@ type KubbConfig = {
      * 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[];
+    plugins?: Array<KubbPlugin>;
     /**
      * Hooks that will be called when a specific action is triggered in Kubb.
      */
@@ -531,7 +536,7 @@ type KubbConfig = {
          * 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[];
+        done?: string | Array<string>;
     };
 };
 type CLIOptions = {
@@ -628,34 +633,34 @@ type PluginLifecycle<TOptions extends PluginFactoryOptions = PluginFactoryOption
      */
     buildStart: (this: PluginContext, kubbConfig: KubbConfig) => PossiblePromise<void>;
     /**
-     * Resolve to a Path based on a fileName(example: `./Pet.ts`) and directory(example: `./models`).
+     * 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, fileName: string, directory?: string, options?: TOptions['resolvePathOptions']) => OptionalPath;
+    resolvePath: (this: PluginContext, baseName: string, directory?: string, options?: TOptions['resolvePathOptions']) => KubbFile.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;
+    resolveName: (this: PluginContext, name: ResolveNameParams['name'], type?: ResolveNameParams['type']) => 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>;
+    load: (this: Omit<PluginContext, 'addFile'>, path: KubbFile.Path) => PossiblePromise<TransformResult | null>;
     /**
      * Transform the source-code.
      * @type hookReduceArg0
      */
-    transform: (this: Omit<PluginContext, 'addFile'>, source: string, path: Path) => PossiblePromise<TransformResult>;
+    transform: (this: Omit<PluginContext, 'addFile'>, source: string, path: KubbFile.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>;
+    writeFile: (this: Omit<PluginContext, 'addFile'>, source: string | undefined, path: KubbFile.Path) => PossiblePromise<void>;
     /**
      * End of the plugin lifecycle.
      * @type hookParallel
@@ -670,7 +675,7 @@ type ResolvePathParams<TOptions = Record<string, unknown>> = {
      * If not defined it will fall back on the resolvePath of the core plugin.
      */
     pluginName?: string;
-    fileName: string;
+    baseName: string;
     directory?: string | undefined;
     /**
      * Options to be passed to 'resolvePath' 3th parameter
@@ -684,25 +689,20 @@ type ResolveNameParams = {
      * If not defined it will fall back on the resolvePath of the core plugin.
      */
     pluginName?: string;
+    type?: 'file' | 'function';
 };
 type PluginContext<TOptions = Record<string, unknown>> = {
     config: KubbConfig;
     cache: Cache<PluginCache>;
     fileManager: FileManager;
     pluginManager: PluginManager;
-    addFile: (...file: File[]) => Promise<File[]>;
-    resolvePath: (params: ResolvePathParams<TOptions>) => OptionalPath;
+    addFile: (...file: Array<KubbFile.File>) => Promise<Array<KubbFile.File>>;
+    resolvePath: (params: ResolvePathParams<TOptions>) => KubbFile.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";
@@ -712,6 +712,10 @@ type LogLevel = keyof typeof LogLevel;
 type AppMeta = {
     pluginManager: PluginManager;
 };
+type Prettify<T> = {
+    [K in keyof T]: T[K];
+} & {};
+type PossiblePromise<T> = Promise<T> | T;
 
 type BuildOptions = {
     config: PluginContext['config'];
@@ -764,4 +768,4 @@ declare abstract class SchemaGenerator<TOptions extends object, TInput, TOutput>
     abstract build(schema: TInput, name: string, description?: string): TOutput;
 }
 
-export { AppMeta, 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, URLObject, 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 };
+export { AppMeta, Argument0, BuildOutput, CLIOptions, Cache, CacheItem, Executer, FileManager, FunctionParams, FunctionParamsAST, Generator, KubbConfig, KubbFile, KubbJSONPlugins, KubbObjectPlugin, KubbObjectPlugins, KubbPlugin, KubbPluginKind, KubbUserConfig, KubbUserPlugin, LogLevel, LogType, Logger, ParallelPluginError, ParseResult, PluginCache, PluginContext, PluginError, PluginFactoryOptions, PluginLifecycle, PluginLifecycleHooks, PluginManager, PossiblePromise, Prettify, Queue, QueueJob, ResolveNameParams, ResolvePathParams, SafeParseResult, SchemaGenerator, Strategy, SummaryError, TransformResult, TreeNode, TreeNodeOptions, URLObject, URLPath, ValidationPluginError, Warning, build, clean, combineCodes, combineExports, combineFiles, combineImports, createFileSource, 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, readSync, renderTemplate, throttle, timeout, transformReservedWord, uniqueIdFactory, write };