@kubb/core 2.0.0-beta.1 → 2.0.0-beta.11

package/dist/index.d.ts

@@ -1,69 +1,18 @@
+import { w as write, r as read } from './write-46ytbnu9.js';
 import { PossiblePromise, GreaterThan, TupleToUnion, ObjValueTuple } from '@kubb/types';
 import { DirectoryTreeOptions } from 'directory-tree';
-import { Ora } from 'ora';
-
-declare function read(path: string): Promise<string>;
-
-declare function write(data: string, path: string): Promise<string | undefined>;
+import { E as EventEmitter, Q as Queue, a as QueueJob } from './Queue-2-6pMcCx.js';
+import { Logger, LogLevel } from './logger.js';
+import 'ora';
+import 'picocolors';
 
 type BarrelManagerOptions = {
     treeNode?: DirectoryTreeOptions;
     isTypeOnly?: boolean;
-    filter?: (file: KubbFile.File) => boolean;
-    map?: (file: KubbFile.File) => KubbFile.File;
-    includeExt?: boolean;
-    output?: string;
-};
-
-declare class EventEmitter<TEvents extends Record<string, any>> {
-    #private;
-    constructor();
-    emit<TEventName extends keyof TEvents & string>(eventName: TEventName, ...eventArg: TEvents[TEventName]): void;
-    on<TEventName extends keyof TEvents & string>(eventName: TEventName, handler: (...eventArg: TEvents[TEventName]) => void): void;
-    off<TEventName extends keyof TEvents & string>(eventName: TEventName, handler: (...eventArg: TEvents[TEventName]) => void): void;
-    removeAll(): void;
-}
-
-type QueueJob<T = unknown> = {
-    (...args: unknown[]): Promise<T | void>;
-};
-type RunOptions = {
-    controller?: AbortController;
-    name?: string;
-    description?: string;
-};
-type Events$1 = {
-    jobDone: [result: unknown];
-    jobFailed: [error: Error];
-};
-declare class Queue {
-    #private;
-    readonly eventEmitter: EventEmitter<Events$1>;
-    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;
-    get count(): number;
-}
-
-declare const LogLevel: {
-    readonly silent: "silent";
-    readonly info: "info";
-    readonly debug: "debug";
-};
-type LogLevel = keyof typeof LogLevel;
-type Logger = {
     /**
-     * Optional config name to show in CLI output
+     * Add .ts or .js
      */
-    name?: string;
-    logLevel: LogLevel;
-    log: (message: string | null) => void;
-    error: (message: string | null) => void;
-    info: (message: string | null) => void;
-    warn: (message: string | null) => void;
-    spinner?: Ora;
-    logs: string[];
+    extName?: KubbFile.Extname;
 };
 
 type RequiredPluginLifecycle = Required<PluginLifecycle>;
@@ -105,30 +54,36 @@ declare class PluginManager {
     #private;
     readonly plugins: KubbPluginWithLifeCycle[];
     readonly fileManager: FileManager;
-    readonly eventEmitter: EventEmitter<Events>;
+    readonly events: EventEmitter<Events>;
     readonly queue: Queue;
     readonly config: KubbConfig;
-    readonly executed: Executer[];
+    readonly executed: Array<Executer>;
     readonly logger: Logger;
     constructor(config: KubbConfig, options: Options$2);
     resolvePath: <TOptions = object>(params: ResolvePathParams<TOptions>) => KubbFile.OptionalPath;
     resolveName: (params: ResolveNameParams) => string;
+    /**
+     * Instead of calling `pluginManager.events.on` you can use `pluginManager.on`. This one also has better types.
+     */
     on<TEventName extends keyof Events & string>(eventName: TEventName, handler: (...eventArg: Events[TEventName]) => void): void;
     /**
-     * Run only hook for a specific plugin name
+     * Run a specific hookName for plugin x.
      */
     hookForPlugin<H extends PluginLifecycleHooks>({ pluginKey, hookName, parameters, }: {
         pluginKey: KubbPlugin['key'];
         hookName: H;
         parameters: PluginParameter<H>;
     }): Promise<Array<ReturnType<ParseResult<H>> | null>> | null;
+    /**
+     * Run a specific hookName for plugin x.
+     */
     hookForPluginSync<H extends PluginLifecycleHooks>({ pluginKey, hookName, parameters, }: {
         pluginKey: KubbPlugin['key'];
         hookName: H;
         parameters: PluginParameter<H>;
     }): Array<ReturnType<ParseResult<H>>> | null;
     /**
-     * Chains, first non-null result stops and returns
+     * First non-null result stops and will return it's value.
      */
     hookFirst<H extends PluginLifecycleHooks>({ hookName, parameters, skipped, }: {
         hookName: H;
@@ -136,7 +91,7 @@ declare class PluginManager {
         skipped?: ReadonlySet<KubbPlugin> | null;
     }): Promise<SafeParseResult<H>>;
     /**
-     * Chains, first non-null result stops and returns
+     * First non-null result stops and will return it's value.
      */
     hookFirstSync<H extends PluginLifecycleHooks>({ hookName, parameters, skipped, }: {
         hookName: H;
@@ -144,14 +99,14 @@ declare class PluginManager {
         skipped?: ReadonlySet<KubbPlugin> | null;
     }): SafeParseResult<H>;
     /**
-     * Parallel, runs all plugins
+     * Run all plugins in parallel(order will be based on `this.plugin` and if `pre` or `post` is set).
      */
     hookParallel<H extends PluginLifecycleHooks, TOuput = void>({ hookName, parameters, }: {
         hookName: H;
         parameters?: Parameters<RequiredPluginLifecycle[H]> | undefined;
     }): Promise<Awaited<TOuput>[]>;
     /**
-     * Chains, reduces returned value, handling the reduced value as the first hook argument
+     * Chain all plugins, `reduce` can be passed through to handle every returned value. The return value of the first plugin will be used as the first parameter for the plugin after that.
      */
     hookReduceArg0<H extends PluginLifecycleHooks>({ hookName, parameters, reduce, }: {
         hookName: H;
@@ -167,7 +122,7 @@ declare class PluginManager {
     }): Promise<void>;
     getPluginsByKey(hookName: keyof PluginLifecycle, pluginKey: KubbPlugin['key']): KubbPlugin[];
     static getDependedPlugins<T1 extends PluginFactoryOptions, T2 extends PluginFactoryOptions = never, T3 extends PluginFactoryOptions = never, TOutput = T3 extends never ? T2 extends never ? [T1: KubbPlugin<T1>] : [T1: KubbPlugin<T1>, T2: KubbPlugin<T2>] : [T1: KubbPlugin<T1>, T2: KubbPlugin<T2>, T3: KubbPlugin<T3>]>(plugins: Array<KubbPlugin>, dependedPluginNames: string | string[]): TOutput;
-    static get hooks(): readonly ["validate", "buildStart", "resolvePath", "resolveName", "load", "transform", "writeFile", "buildEnd"];
+    static get hooks(): readonly ["buildStart", "resolvePath", "resolveName", "load", "transform", "writeFile", "buildEnd"];
 }
 
 interface Cache<TStore extends object = object> {
@@ -282,7 +237,6 @@ type CLIOptions = {
      */
     logLevel?: LogLevel;
 };
-type KubbPluginKind = 'schema' | 'controller';
 type KubbUnionPlugins = PluginUnion;
 type KubbObjectPlugin = keyof OptionsPlugins;
 type PluginFactoryOptions<
@@ -290,10 +244,6 @@ type PluginFactoryOptions<
  * Name to be used for the plugin, this will also be used for they key.
  */
 TName extends string = string, 
-/**
- * @type "schema" | "controller"
- */
-TKind extends KubbPluginKind = KubbPluginKind, 
 /**
  * Options of the plugin.
  */
@@ -316,55 +266,47 @@ TResolvePathOptions extends object = object,
  */
 TAppMeta = unknown> = {
     name: TName;
-    kind: TKind;
     /**
      * Same behaviour like what has been done with `QueryKey` in `@tanstack/react-query`
      */
-    key: [kind: TKind | undefined, name: TName | string, identifier?: string | number];
+    key: [name: TName | string, identifier?: string | number];
     options: TOptions;
     resolvedOptions: TResolvedOptions;
     api: TAPI;
     resolvePathOptions: TResolvePathOptions;
     appMeta: {
         pluginManager: PluginManager;
-        plugin: KubbPlugin<PluginFactoryOptions<TName, TKind, TOptions, TResolvedOptions, TAPI, TResolvePathOptions, TAppMeta>>;
+        plugin: KubbPlugin<PluginFactoryOptions<TName, TOptions, TResolvedOptions, TAPI, TResolvePathOptions, TAppMeta>>;
     } & TAppMeta;
 };
 type GetPluginFactoryOptions<TPlugin extends KubbUserPlugin> = TPlugin extends KubbUserPlugin<infer X> ? X : never;
 type KubbUserPlugin<TOptions extends PluginFactoryOptions = PluginFactoryOptions> = {
     /**
      * 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'];
-    /**
-     * Internal key used when a developer uses more than one of the same plugin
-     * @private
-     */
-    key?: TOptions['key'];
     /**
      * 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 depended plugins.
+     */
+    pre?: Array<string>;
+    /**
+     * 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<string>;
 } & (TOptions['api'] extends never ? {
     api?: never;
 } : {
     api: (this: TOptions['name'] extends 'core' ? null : Omit<PluginContext<TOptions>, 'addFile'>) => TOptions['api'];
-}) & (TOptions['kind'] extends never ? {
-    kind?: never;
-} : {
-    /**
-     * 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: TOptions['kind'];
 });
 type KubbUserPluginWithLifeCycle<TOptions extends PluginFactoryOptions = PluginFactoryOptions> = KubbUserPlugin<TOptions> & PluginLifecycle<TOptions>;
-type UnknownKubbUserPlugin = KubbUserPlugin<PluginFactoryOptions<any, any, any, any, any, any, any>>;
+type UnknownKubbUserPlugin = KubbUserPlugin<PluginFactoryOptions<any, any, any, any, any, any>>;
 type KubbPlugin<TOptions extends PluginFactoryOptions = PluginFactoryOptions> = {
     /**
      * Unique name used for the plugin
@@ -377,16 +319,18 @@ type KubbPlugin<TOptions extends PluginFactoryOptions = PluginFactoryOptions> =
      */
     key: TOptions['key'];
     /**
-     * Options set for a specific plugin(see kubb.config.js), passthrough of options.
+     * 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 depended plugins.
      */
-    options: TOptions['resolvedOptions'];
+    pre?: Array<string>;
     /**
-     * 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
+     * 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.
      */
-    kind?: TOptions['kind'];
+    post?: Array<string>;
+    /**
+     * Options set for a specific plugin(see kubb.config.js), passthrough of options.
+     */
+    options: TOptions['resolvedOptions'];
 } & (TOptions['api'] extends never ? {
     api?: never;
 } : {
@@ -394,11 +338,6 @@ type KubbPlugin<TOptions extends PluginFactoryOptions = PluginFactoryOptions> =
 });
 type KubbPluginWithLifeCycle<TOptions extends PluginFactoryOptions = PluginFactoryOptions> = KubbPlugin<TOptions> & PluginLifecycle<TOptions>;
 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<TOptions>, 'addFile'>, plugins: NonNullable<KubbConfig['plugins']>) => PossiblePromise<true>;
     /**
      * Start of the lifecycle of a plugin.
      * @type hookParallel
@@ -489,7 +428,10 @@ declare namespace KubbFile {
          * @example ["useState"]
          * @example "React"
          */
-        name: string | Array<string>;
+        name: string | Array<string | {
+            propertyName: string;
+            name?: string;
+        }>;
         /**
          * Path for the import
          * @xample '@kubb/core'
@@ -499,6 +441,14 @@ declare namespace KubbFile {
          * 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 = {
         /**
@@ -551,8 +501,8 @@ declare namespace KubbFile {
          */
         id?: string;
         /**
-         * Name to be used to dynamicly create the baseName(based on input.path)
-         * Based on UNIX basename
+         * 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;
@@ -577,22 +527,34 @@ declare namespace KubbFile {
          * This will override `process.env[key]` inside the `source`, see `getFileSource`.
          */
         env?: NodeJS.ProcessEnv;
-        /**
-         * @deprecated
-         */
-        validate?: boolean;
     };
     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>>>;
 type AddIndexesProps = {
-    root: KubbFile.Path;
-    extName?: KubbFile.Extname;
+    /**
+     * Root based on root and output.path specified in the config
+     */
+    root: string;
+    /**
+     * Output for plugin
+     */
+    output: {
+        path: string;
+        exportAs?: string;
+        extName?: KubbFile.Extname;
+        exportType?: 'barrel' | false;
+    };
     options?: BarrelManagerOptions;
     meta?: KubbFile.File['meta'];
 };
@@ -610,20 +572,17 @@ declare class FileManager {
     get files(): Array<KubbFile.File>;
     get isExecuting(): boolean;
     add<T extends Array<KubbFile.File> = Array<KubbFile.File>>(...files: T): AddResult<T>;
-    addIndexes({ root, extName, meta, options }: AddIndexesProps): Promise<Array<KubbFile.File> | undefined>;
+    addIndexes({ root, output, meta, options }: AddIndexesProps): Promise<Array<KubbFile.File> | undefined>;
     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<string | undefined>;
     read(...params: Parameters<typeof read>): Promise<string>;
     static getSource<TMeta extends KubbFile.FileMetaBase = KubbFile.FileMetaBase>(file: KubbFile.File<TMeta>): string;
-    static combineFiles<TMeta extends KubbFile.FileMetaBase = KubbFile.FileMetaBase>(files: Array<KubbFile.File<TMeta> | null>): Array<KubbFile.File<TMeta>>;
     static getMode(path: string | undefined | null): KubbFile.Mode;
     static get extensions(): Array<KubbFile.Extname>;
     static 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>;
 
 type BuildOptions = {
     config: PluginContext['config'];
@@ -661,8 +620,6 @@ declare class Warning extends Error {
         cause: Error;
     });
 }
-declare class ValidationPluginError extends Error {
-}
 
 /**
  * Abstract class that contains the building blocks for plugins to create their own Generator
@@ -722,13 +679,6 @@ declare class PromiseManager<TState = any> {
     run<TInput extends Array<PromiseFunc<TValue, null>>, TValue, TStrategy extends Strategy, TOutput = StrategySwitch<TStrategy, TInput, TValue>>(strategy: TStrategy, promises: TInput): TOutput;
 }
 
-/**
- * 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;
-}
-
 interface _Register {
 }
 type Plugins = _Register;
@@ -739,4 +689,4 @@ type OptionsOfPlugin<K extends keyof Plugins> = Plugins[K]['options'];
 type PluginUnion = TupleToUnion<ObjValueTuple<OptionsPlugins>>;
 type Plugin = keyof Plugins;
 
-export { type CLIOptions, FileManager, Generator, type GetPluginFactoryOptions, type InputData, type InputPath, type KubbConfig, KubbFile, type KubbObjectPlugin, type KubbPlugin, type KubbPluginKind, type KubbPluginWithLifeCycle, type KubbUnionPlugins, type KubbUserConfig, type KubbUserPlugin, type KubbUserPluginWithLifeCycle, type OptionsOfPlugin, type OptionsPlugins, PackageManager, type Plugin, type PluginCache, type PluginContext, type PluginFactoryOptions, type PluginLifecycle, type PluginLifecycleHooks, PluginManager, type PluginParameter, type PluginUnion, type Plugins, PromiseManager, type ResolveNameParams, type ResolvePathParams, SchemaGenerator, type TransformResult, ValidationPluginError, Warning, type _Register, build, combineExports, combineImports, createPlugin, build as default, defineConfig, isInputPath, pluginName as name, pluginName, safeBuild };
+export { type CLIOptions, FileManager, Generator, type GetPluginFactoryOptions, type InputData, type InputPath, type KubbConfig, KubbFile, type KubbObjectPlugin, type KubbPlugin, type KubbPluginWithLifeCycle, type KubbUnionPlugins, type KubbUserConfig, type KubbUserPlugin, type KubbUserPluginWithLifeCycle, type OptionsOfPlugin, type OptionsPlugins, PackageManager, type Plugin, type PluginCache, type PluginContext, type PluginFactoryOptions, type PluginLifecycle, type PluginLifecycleHooks, PluginManager, type PluginParameter, type PluginUnion, type Plugins, PromiseManager, type ResolveNameParams, type ResolvePathParams, type TransformResult, Warning, type _Register, build, createPlugin, build as default, defineConfig, isInputPath, pluginName as name, pluginName, safeBuild };