@kubb/core 2.18.3 → 2.18.5

package/dist/index.d.ts

@@ -1,8 +1,11 @@
 import PQueue from 'p-queue';
-import { w as write, r as read } from './write-CN8f7bYv.js';
+import { write, read } from '@kubb/fs';
+import * as KubbFile from '@kubb/fs/types';
+import { BaseName, File, UUID } from '@kubb/fs/src/types.ts';
 import { PossiblePromise, TupleToUnion, ObjValueTuple, GreaterThan } from '@kubb/types';
 import { DirectoryTreeOptions } from 'directory-tree';
-import { E as EventEmitter, L as Logger, a as LogLevel } from './logger-Cskfrvra.js';
+import { E as EventEmitter, L as Logger } from './logger-DChjnJMn.js';
+import 'consola';
 import 'ora';
 
 type BarrelManagerOptions = {
@@ -38,7 +41,7 @@ type Options$2 = {
     /**
      * Task for the FileManager
      */
-    task: (file: KubbFile.ResolvedFile) => Promise<KubbFile.ResolvedFile>;
+    task: (file: ResolvedFile) => Promise<ResolvedFile>;
 };
 type Events = {
     execute: [executer: Executer];
@@ -134,17 +137,7 @@ type Plugins = _Register;
 type OptionsPlugins = {
     [K in keyof Plugins]: Plugins[K]['options'];
 };
-type OptionsOfPlugin<K extends keyof Plugins> = Plugins[K]['options'];
 type PluginUnion = TupleToUnion<ObjValueTuple<OptionsPlugins>>;
-type Plugin$1 = keyof Plugins;
-
-type kubb_OptionsOfPlugin<K extends keyof Plugins> = OptionsOfPlugin<K>;
-type kubb_OptionsPlugins = OptionsPlugins;
-type kubb_PluginUnion = PluginUnion;
-type kubb_Plugins = Plugins;
-declare namespace kubb {
-  export type { kubb_OptionsOfPlugin as OptionsOfPlugin, kubb_OptionsPlugins as OptionsPlugins, Plugin$1 as Plugin, kubb_PluginUnion as PluginUnion, kubb_Plugins as Plugins };
-}
 
 interface Cache<TStore extends object = object> {
     delete(id: keyof TStore): boolean;
@@ -237,31 +230,6 @@ type Config<TInput = Input> = {
         done?: string | Array<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;
-    /**
-     * Run Kubb with Bun
-     */
-    bun?: boolean;
-};
 type UnionPlugins = PluginUnion;
 type ObjectPlugin = keyof OptionsPlugins;
 type PluginFactoryOptions<
@@ -388,7 +356,7 @@ type PluginLifecycle<TOptions extends PluginFactoryOptions = PluginFactoryOption
      * Write the result to the file-system based on the id(defined by `resolvePath` or changed by `load`).
      * @type hookParallel
      */
-    writeFile?: (this: Omit<PluginContext<TOptions>, 'addFile'>, source: string | undefined, path: KubbFile.Path) => PossiblePromise<string | void>;
+    writeFile?: (this: Omit<PluginContext<TOptions>, 'addFile'>, path: KubbFile.Path, source: string | undefined) => PossiblePromise<string | void>;
     /**
      * End of the plugin lifecycle.
      * @type hookParallel
@@ -437,136 +405,22 @@ type PluginContext<TOptions extends PluginFactoryOptions = PluginFactoryOptions>
 };
 type TransformResult = string | null;
 
-type BasePath<T extends string = string> = `${T}/`;
-declare namespace KubbFile {
-    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;
-    };
-    type Export = {
-        /**
-         * Export name to be used.
-         * @example ["useState"]
-         * @example "React"
-         */
-        name?: string | Array<string>;
-        /**
-         * Path for the import.
-         * @xample '@kubb/core'
-         */
-        path: string;
-        /**
-         * Add `type` prefix to the export, this will result in: `export type { Type } from './path'`.
-         */
-        isTypeOnly?: boolean;
-        /**
-         * Make it possible to override the name, this will result in: `export * as aliasName from './path'`.
-         */
-        asAlias?: boolean;
-    };
-    const dataTagSymbol: unique symbol;
-    type DataTag<Type, Value> = Type & {
-        [dataTagSymbol]: Value;
-    };
-    type UUID = string;
-    type Source = string;
-    type Extname = '.ts' | '.js' | '.tsx' | '.json' | `.${string}`;
-    type Mode = 'single' | 'split';
+type ResolvedFile<TMeta extends FileMetaBase = FileMetaBase, TBaseName extends BaseName = BaseName> = File<TMeta, TBaseName> & {
     /**
-     * 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
+     * @default crypto.randomUUID()
      */
-    type BaseName = `${string}${Extname}`;
+    id: UUID;
     /**
-     * Path will be full qualified path to a specified file
+     * Contains the first part of the baseName, generated based on baseName
+     * @link  https://nodejs.org/api/path.html#pathformatpathobject
      */
-    type Path = string;
-    type AdvancedPath<T extends BaseName = BaseName> = `${BasePath}${T}`;
-    type OptionalPath = Path | undefined | null;
-    type FileMetaBase = {
-        pluginKey?: Plugin['key'];
-    };
-    type File<TMeta extends FileMetaBase = FileMetaBase, TBaseName extends BaseName = BaseName> = {
-        /**
-         * Unique identifier to reuse later
-         * @default crypto.randomUUID()
-         */
-        id?: string;
-        /**
-         * Name to be used to create the path
-         * Based on UNIX basename, `${name}.extName`
-         * @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
-         * This will also ignore the combinefiles utils
-         * @default `false`
-         */
-        override?: boolean;
-        /**
-         * Use extra meta, this is getting used to generate the barrel/index files.
-         */
-        meta?: TMeta;
-        /**
-         * Override if a file can be exported by the BarrelManager
-         * @default true
-         */
-        exportable?: boolean;
-        /**
-         * This will override `process.env[key]` inside the `source`, see `getFileSource`.
-         */
-        env?: NodeJS.ProcessEnv;
-        /**
-         * The name of the language being used. This can be TypeScript, JavaScript and still have another ext.
-         */
-        language?: string;
-    };
-    type ResolvedFile<TMeta extends FileMetaBase = FileMetaBase, TBaseName extends BaseName = BaseName> = KubbFile.File<TMeta, TBaseName> & {
-        /**
-         * @default crypto.randomUUID()
-         */
-        id: UUID;
-        /**
-         * Contains the first part of the baseName, generated based on baseName
-         * @link  https://nodejs.org/api/path.html#pathformatpathobject
-         */
-        name: string;
-    };
-}
-type AddResult<T extends Array<KubbFile.File>> = Promise<Awaited<GreaterThan<T['length'], 1> extends true ? Promise<KubbFile.ResolvedFile[]> : Promise<KubbFile.ResolvedFile>>>;
+    name: string;
+};
+type FileMetaBase = {
+    pluginKey?: Plugin['key'];
+};
+type FileWithMeta<TMeta extends FileMetaBase = FileMetaBase> = KubbFile.File<TMeta>;
+type AddResult<T extends Array<FileWithMeta>> = Promise<Awaited<GreaterThan<T['length'], 1> extends true ? Promise<ResolvedFile[]> : Promise<ResolvedFile>>>;
 type AddIndexesProps = {
     /**
      * Root based on root and output.path specified in the config
@@ -583,26 +437,26 @@ type AddIndexesProps = {
     };
     logger: Logger;
     options?: BarrelManagerOptions;
-    meta?: KubbFile.File['meta'];
+    meta?: FileWithMeta['meta'];
 };
 type Options$1 = {
     queue?: PQueue;
-    task?: (file: KubbFile.ResolvedFile) => Promise<KubbFile.ResolvedFile>;
+    task?: (file: ResolvedFile) => Promise<ResolvedFile>;
 };
 declare class FileManager {
     #private;
     constructor({ task, queue }?: Options$1);
-    get files(): Array<KubbFile.File>;
+    get files(): Array<FileWithMeta>;
     get isExecuting(): boolean;
-    add<T extends Array<KubbFile.File> = Array<KubbFile.File>>(...files: T): AddResult<T>;
+    add<T extends Array<FileWithMeta> = Array<FileWithMeta>>(...files: T): AddResult<T>;
     addIndexes({ root, output, meta, logger, options }: AddIndexesProps): Promise<void>;
-    getCacheByUUID(UUID: KubbFile.UUID): KubbFile.File | undefined;
-    get(path: KubbFile.Path): Array<KubbFile.File> | undefined;
+    getCacheByUUID(UUID: KubbFile.UUID): FileWithMeta | undefined;
+    get(path: KubbFile.Path): Array<FileWithMeta> | undefined;
     remove(path: KubbFile.Path): void;
     write(...params: Parameters<typeof write>): Promise<string | undefined>;
     read(...params: Parameters<typeof read>): Promise<string>;
-    static getSource<TMeta extends KubbFile.FileMetaBase = KubbFile.FileMetaBase>(file: KubbFile.File<TMeta>): Promise<string>;
-    static combineFiles<TMeta extends KubbFile.FileMetaBase = KubbFile.FileMetaBase>(files: Array<KubbFile.File<TMeta> | null>): Array<KubbFile.File<TMeta>>;
+    static getSource<TMeta extends FileMetaBase = FileMetaBase>(file: FileWithMeta<TMeta>): Promise<string>;
+    static combineFiles<TMeta extends FileMetaBase = FileMetaBase>(files: Array<FileWithMeta<TMeta> | null>): Array<FileWithMeta<TMeta>>;
     static getMode(path: string | undefined | null): KubbFile.Mode;
     static get extensions(): Array<KubbFile.Extname>;
     static isJavascript(baseName: string): boolean;
@@ -626,6 +480,31 @@ type BuildOutput = {
 declare function build(options: BuildOptions): Promise<BuildOutput>;
 declare function safeBuild(options: BuildOptions): Promise<BuildOutput>;
 
+type Args = {
+    /**
+     * Path to `kubb.config.js`
+     */
+    config?: string;
+    /**
+     * Watch changes on input
+     */
+    watch?: boolean;
+    /**
+     * 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?: string;
+    /**
+     * Run Kubb with Bun
+     */
+    bun?: boolean;
+};
 /**
  * Type helper to make it easier to use kubb.config.js
  * accepts a direct {@link Config} object, or a function that returns it.
@@ -633,7 +512,7 @@ declare function safeBuild(options: BuildOptions): Promise<BuildOutput>;
  */
 declare function defineConfig(options: PossiblePromise<UserConfig | Array<UserConfig>> | ((
 /** The options derived from the CLI flags */
-cliOptions: CLIOptions) => PossiblePromise<UserConfig | Array<UserConfig>>)): typeof options;
+args: Args) => PossiblePromise<UserConfig | Array<UserConfig>>)): typeof options;
 declare function isInputPath(result: Config | undefined): result is Config<InputPath>;
 
 /**
@@ -706,4 +585,4 @@ declare class PromiseManager<TState = any> {
 interface _Register {
 }
 
-export { type CLIOptions, type Config, FileManager, Generator, type GetPluginFactoryOptions, type InputData, type InputPath, kubb as Kubb, KubbFile, type ObjectPlugin, PackageManager, type Plugin, type PluginCache, type PluginContext, type PluginFactoryOptions, type PluginKey, type PluginLifecycle, type PluginLifecycleHooks, PluginManager, type PluginParameter, type PluginWithLifeCycle, PromiseManager, type ResolveNameParams, type ResolvePathParams, type TransformResult, type UnionPlugins, type UserConfig, type UserPlugin, type UserPluginWithLifeCycle, Warning, type _Register, build, createPlugin, build as default, defineConfig, isInputPath, safeBuild };
+export { type Config, FileManager, type FileMetaBase, Generator, type GetPluginFactoryOptions, type InputData, type InputPath, type ObjectPlugin, PackageManager, type Plugin, type PluginCache, type PluginContext, type PluginFactoryOptions, type PluginKey, type PluginLifecycle, type PluginLifecycleHooks, PluginManager, type PluginParameter, type PluginWithLifeCycle, PromiseManager, type ResolveNameParams, type ResolvePathParams, type TransformResult, type UnionPlugins, type UserConfig, type UserPlugin, type UserPluginWithLifeCycle, Warning, type _Register, build, createPlugin, build as default, defineConfig, isInputPath, safeBuild };