@kubb/fabric-core 0.2.14 → 0.2.16

package/README.md

@@ -43,7 +43,7 @@ Below is a minimal example showing how `createFabric` works together with plugin
 ```ts
 import { createFabric } from '@kubb/fabric-core'
 import { fsPlugin } from '@kubb/fabric-core/plugins'
-import { typescriptParser, createParser } from '@kubb/fabric-core/parsers'
+import { typescriptParser } from '@kubb/fabric-core/parsers'
 
 const fabric = createFabric()
 
@@ -66,7 +66,11 @@ await fabric.addFile({
 })
 
 await fabric.write()
+```
 
+Creates a file `generated/index.ts` with the following content:
+```ts
+export const x = 1
 ```
 
 # API Reference

package/dist/{Fabric-BfnUdEpq.d.cts → Fabric-AmREkq58.d.ts}

@@ -1,5 +1,5 @@
 declare namespace KubbFile_d_exports {
-  export { AdvancedPath, BaseName, Export, Extname, File, Import, Mode, OptionalPath, Path, ResolvedExport, ResolvedFile, ResolvedImport, Source };
+  export { AdvancedPath, BaseName, Export, Extname, File, Import, Mode, Path, ResolvedExport, ResolvedFile, ResolvedImport, Source };
 }
 type BasePath<T extends string = string> = `${T}/`;
 type Import = {
@@ -76,7 +76,6 @@ type BaseName = `${string}.${string}`;
  */
 type Path = string;
 type AdvancedPath<T extends BaseName = BaseName> = `${BasePath}${T}`;
-type OptionalPath = Path | undefined | null;
 type File<TMeta extends object = object> = {
   /**
    * Name to be used to create the path
@@ -115,20 +114,6 @@ type ResolvedFile<TMeta extends object = object> = File<TMeta> & {
   exports: Array<ResolvedExport>;
 };
 //#endregion
-//#region src/plugins/types.d.ts
-type Plugin<TOptions = unknown, TAppExtension extends Record<string, any> = {}> = {
-  name: string;
-  type: 'plugin';
-  install: Install<TOptions>;
-  /**
-   * Runtime app overrides or extensions.
-   * Merged into the app instance after install.
-   * This cannot be async
-   */
-  inject?: Inject<TOptions, TAppExtension>;
-};
-type UserPlugin<TOptions = unknown, TAppExtension extends Record<string, any> = {}> = Omit<Plugin<TOptions, TAppExtension>, 'type'>;
-//#endregion
 //#region src/parsers/types.d.ts
 type PrintOptions = {
   extname?: Extname;
@@ -149,9 +134,16 @@ type Parser<TOptions = unknown, TMeta extends object = any> = {
 type UserParser<TOptions = unknown, TMeta extends object = any> = Omit<Parser<TOptions, TMeta>, 'type'>;
 //#endregion
 //#region src/utils/AsyncEventEmitter.d.ts
+type Options$2 = {
+  mode?: FabricMode;
+  maxListener?: number;
+};
 declare class AsyncEventEmitter<TEvents extends Record<string, any>> {
   #private;
-  constructor(maxListener?: number);
+  constructor({
+    maxListener,
+    mode
+  }?: Options$2);
   emit<TEventName extends keyof TEvents & string>(eventName: TEventName, ...eventArgs: TEvents[TEventName]): Promise<void>;
   on<TEventName extends keyof TEvents & string>(eventName: TEventName, handler: (...eventArg: TEvents[TEventName]) => void): void;
   onOnce<TEventName extends keyof TEvents & string>(eventName: TEventName, handler: (...eventArgs: TEvents[TEventName]) => void): void;
@@ -214,42 +206,65 @@ declare class FileManager {
   write(options: ProcessFilesProps): Promise<ResolvedFile[]>;
 }
 //#endregion
+//#region src/plugins/types.d.ts
+type Plugin<TOptions = unknown, TAppExtension extends Record<string, any> = {}> = {
+  name: string;
+  type: 'plugin';
+  install: Install<TOptions>;
+  /**
+   * Runtime app overrides or extensions.
+   * Merged into the app instance after install.
+   * This cannot be async
+   */
+  inject?: Inject<TOptions, TAppExtension>;
+};
+type UserPlugin<TOptions = unknown, TAppExtension extends Record<string, any> = {}> = Omit<Plugin<TOptions, TAppExtension>, 'type'>;
+//#endregion
 //#region src/Fabric.d.ts
 declare global {
   namespace Kubb {
     interface Fabric {}
   }
 }
-type FabricOptions = {
+/**
+ * Component placeholder type.
+ * May later be extended to support specific runtime renderers.
+ */
+
+/**
+ * Defines core runtime options for Fabric.
+ */
+interface FabricOptions {
   /**
+   * Determines how Fabric processes files.
+   * - `sequential`: files are processed one by one
+   * - `parallel`: files are processed concurrently
+   *
    * @default 'sequential'
    */
   mode?: FabricMode;
-};
-type FabricEvents = {
-  /**
-   * Called in the beginning of the app lifecycle.
-   */
+}
+/**
+ * Available modes for file processing.
+ */
+type FabricMode = 'sequential' | 'parallel';
+/**
+ * Event definitions emitted during the Fabric lifecycle.
+ */
+interface FabricEvents {
+  /** Called at the beginning of the app lifecycle. */
   start: [];
-  /**
-   * Called in the end of the app lifecycle.
-   */
+  /** Called at the end of the app lifecycle. */
   end: [];
-  /**
-   * Called when being rendered
-   */
+  /** Called when Fabric is rendering. */
   render: [{
     fabric: Fabric;
   }];
-  /**
-   * Called once before processing any files.
-   */
+  /** Called once before any files are processed. */
   'process:start': [{
     files: ResolvedFile[];
   }];
-  /**
-   * Called when FileManager is adding files to its cache
-   */
+  /** Called when files are added to the FileManager cache. */
   'file:add': [{
     files: ResolvedFile[];
   }];
@@ -259,24 +274,20 @@ type FabricEvents = {
   'write:end': [{
     files: ResolvedFile[];
   }];
-  /**
-   * Called for each file when processing begins.
-   */
+  /** Called for each file when processing begins. */
   'file:start': [{
     file: ResolvedFile;
     index: number;
     total: number;
   }];
-  /**
-   * Called for each file when processing finishes.
-   */
+  /** Called for each file when processing completes. */
   'file:end': [{
     file: ResolvedFile;
     index: number;
     total: number;
   }];
   /**
-   * Called periodically (or after each file) to indicate progress.
+   * Called periodically (or per file) to indicate progress.
    * Useful for progress bars or logging.
    */
   'process:progress': [{
@@ -286,33 +297,67 @@ type FabricEvents = {
     source?: string;
     file: ResolvedFile;
   }];
-  /**
-   * Called once all files have been processed successfully.
-   */
+  /** Called once all files have been processed successfully. */
   'process:end': [{
     files: ResolvedFile[];
   }];
-};
-type FabricContext<TOptions extends FabricOptions> = {
-  config?: FabricConfig<TOptions>;
-  events: AsyncEventEmitter<FabricEvents>;
+}
+/**
+ * Shared context passed to all plugins, parsers, and Fabric internals.
+ */
+interface FabricContext<T extends FabricOptions = FabricOptions> extends AsyncEventEmitter<FabricEvents> {
+  /** The active Fabric configuration. */
+  config?: FabricConfig<T>;
+  /** The internal file manager handling file creation, merging, and writing. */
   fileManager: FileManager;
+  /** List of files currently in memory. */
+  files: ResolvedFile[];
+  /** Add new files to the file manager. */
+  addFile(...files: File[]): Promise<void>;
+  /** Track installed plugins and parsers to prevent duplicates. */
   installedPlugins: Set<Plugin>;
   installedParsers: Set<Parser>;
-};
-type FabricMode = 'sequential' | 'parallel';
+}
+/**
+ * Base configuration object for Fabric.
+ */
+interface FabricConfig<T extends FabricOptions = FabricOptions> {
+  /** The runtime options used to configure Fabric. */
+  options: T;
+}
+/**
+ * Utility type that checks whether all properties of `T` are optional.
+ */
 type AllOptional<T> = {} extends T ? true : false;
-type FabricConfig<TOptions extends FabricOptions> = {
-  options: TOptions;
-};
-type Install<TOptions = unknown> = TOptions extends any[] ? (app: Fabric, ...options: TOptions) => void | Promise<void> : AllOptional<TOptions> extends true ? (app: Fabric, options: TOptions | undefined) => void | Promise<void> : (app: Fabric, options: TOptions) => void | Promise<void>;
-type Inject<TOptions = unknown, TAppExtension extends Record<string, any> = {}> = TOptions extends any[] ? (app: Fabric, ...options: TOptions) => Partial<TAppExtension> : AllOptional<TOptions> extends true ? (app: Fabric, options: TOptions | undefined) => Partial<TAppExtension> : (app: Fabric, options: TOptions) => Partial<TAppExtension>;
-interface Fabric<TOptions extends FabricOptions = FabricOptions> extends Kubb.Fabric {
-  context: FabricContext<TOptions>;
-  files: Array<ResolvedFile>;
-  use<TPluginOptions = unknown, TMeta extends object = object, TAppExtension extends Record<string, any> = {}>(pluginOrParser: Plugin<TPluginOptions, TAppExtension> | Parser<TPluginOptions, TMeta>, ...options: TPluginOptions extends any[] ? NoInfer<TPluginOptions> : AllOptional<TPluginOptions> extends true ? [NoInfer<TPluginOptions>?] : [NoInfer<TPluginOptions>]): (this & TAppExtension) | Promise<this & TAppExtension>;
-  addFile(...files: Array<File>): Promise<void>;
+/**
+ * Defines the signature of a plugin or parser's `install` function.
+ */
+type Install<TOptions = unknown> = TOptions extends any[] ? (context: FabricContext, ...options: TOptions) => void | Promise<void> : AllOptional<TOptions> extends true ? (context: FabricContext, options?: TOptions) => void | Promise<void> : (context: FabricContext, options: TOptions) => void | Promise<void>;
+/**
+ * Defines the signature of a plugin or parser's `inject` function.
+ * Returns an object that extends the Fabric instance.
+ */
+type Inject<TOptions = unknown, TExtension extends Record<string, any> = {}> = TOptions extends any[] ? (context: FabricContext, ...options: TOptions) => Partial<TExtension> : AllOptional<TOptions> extends true ? (context: FabricContext, options?: TOptions) => Partial<TExtension> : (context: FabricContext, options: TOptions) => Partial<TExtension>;
+/**
+ * The main Fabric runtime interface.
+ * Provides access to the current context, registered plugins, files, and utility methods.
+ */
+interface Fabric<T extends FabricOptions = FabricOptions> extends Kubb.Fabric {
+  /** The shared context for this Fabric instance. */
+  context: FabricContext<T>;
+  /** The files managed by this Fabric instance. */
+  files: ResolvedFile[];
+  /**
+   * Install a plugin or parser into Fabric.
+   *
+   * @param target - The plugin or parser to install.
+   * @param options - Optional configuration or arguments for the target.
+   * @returns A Fabric instance extended by the plugin (if applicable).
+   */
+  use<TPluginOptions = unknown, TMeta extends object = object, TExtension extends Record<string, any> = {}>(target: Plugin<TPluginOptions, TExtension> | Parser<TPluginOptions, TMeta>, ...options: TPluginOptions extends any[] ? NoInfer<TPluginOptions> : AllOptional<TPluginOptions> extends true ? [NoInfer<TPluginOptions>?] : [NoInfer<TPluginOptions>]): (this & TExtension) | Promise<this & TExtension>;
+  /** Add one or more files to the Fabric file manager. */
+  addFile(...files: File[]): Promise<void>;
 }
 //#endregion
-export { FabricOptions as a, Parser as c, UserPlugin as d, Extname as f, ResolvedFile as h, FabricMode as i, UserParser as l, KubbFile_d_exports as m, FabricConfig as n, FileManager as o, File as p, FabricContext as r, FileProcessor as s, Fabric as t, Plugin as u };
-//# sourceMappingURL=Fabric-BfnUdEpq.d.cts.map
+export { FabricOptions as a, FileManager as c, UserParser as d, Extname as f, ResolvedFile as h, FabricMode as i, FileProcessor as l, KubbFile_d_exports as m, FabricConfig as n, Plugin as o, File as p, FabricContext as r, UserPlugin as s, Fabric as t, Parser as u };
+//# sourceMappingURL=Fabric-AmREkq58.d.ts.map

package/dist/{Fabric-CxMkO4Rt.d.ts → Fabric-CBrTERuf.d.cts}

@@ -1,5 +1,5 @@
 declare namespace KubbFile_d_exports {
-  export { AdvancedPath, BaseName, Export, Extname, File, Import, Mode, OptionalPath, Path, ResolvedExport, ResolvedFile, ResolvedImport, Source };
+  export { AdvancedPath, BaseName, Export, Extname, File, Import, Mode, Path, ResolvedExport, ResolvedFile, ResolvedImport, Source };
 }
 type BasePath<T extends string = string> = `${T}/`;
 type Import = {
@@ -76,7 +76,6 @@ type BaseName = `${string}.${string}`;
  */
 type Path = string;
 type AdvancedPath<T extends BaseName = BaseName> = `${BasePath}${T}`;
-type OptionalPath = Path | undefined | null;
 type File<TMeta extends object = object> = {
   /**
    * Name to be used to create the path
@@ -115,20 +114,6 @@ type ResolvedFile<TMeta extends object = object> = File<TMeta> & {
   exports: Array<ResolvedExport>;
 };
 //#endregion
-//#region src/plugins/types.d.ts
-type Plugin<TOptions = unknown, TAppExtension extends Record<string, any> = {}> = {
-  name: string;
-  type: 'plugin';
-  install: Install<TOptions>;
-  /**
-   * Runtime app overrides or extensions.
-   * Merged into the app instance after install.
-   * This cannot be async
-   */
-  inject?: Inject<TOptions, TAppExtension>;
-};
-type UserPlugin<TOptions = unknown, TAppExtension extends Record<string, any> = {}> = Omit<Plugin<TOptions, TAppExtension>, 'type'>;
-//#endregion
 //#region src/parsers/types.d.ts
 type PrintOptions = {
   extname?: Extname;
@@ -149,9 +134,16 @@ type Parser<TOptions = unknown, TMeta extends object = any> = {
 type UserParser<TOptions = unknown, TMeta extends object = any> = Omit<Parser<TOptions, TMeta>, 'type'>;
 //#endregion
 //#region src/utils/AsyncEventEmitter.d.ts
+type Options$2 = {
+  mode?: FabricMode;
+  maxListener?: number;
+};
 declare class AsyncEventEmitter<TEvents extends Record<string, any>> {
   #private;
-  constructor(maxListener?: number);
+  constructor({
+    maxListener,
+    mode
+  }?: Options$2);
   emit<TEventName extends keyof TEvents & string>(eventName: TEventName, ...eventArgs: TEvents[TEventName]): Promise<void>;
   on<TEventName extends keyof TEvents & string>(eventName: TEventName, handler: (...eventArg: TEvents[TEventName]) => void): void;
   onOnce<TEventName extends keyof TEvents & string>(eventName: TEventName, handler: (...eventArgs: TEvents[TEventName]) => void): void;
@@ -214,42 +206,65 @@ declare class FileManager {
   write(options: ProcessFilesProps): Promise<ResolvedFile[]>;
 }
 //#endregion
+//#region src/plugins/types.d.ts
+type Plugin<TOptions = unknown, TAppExtension extends Record<string, any> = {}> = {
+  name: string;
+  type: 'plugin';
+  install: Install<TOptions>;
+  /**
+   * Runtime app overrides or extensions.
+   * Merged into the app instance after install.
+   * This cannot be async
+   */
+  inject?: Inject<TOptions, TAppExtension>;
+};
+type UserPlugin<TOptions = unknown, TAppExtension extends Record<string, any> = {}> = Omit<Plugin<TOptions, TAppExtension>, 'type'>;
+//#endregion
 //#region src/Fabric.d.ts
 declare global {
   namespace Kubb {
     interface Fabric {}
   }
 }
-type FabricOptions = {
+/**
+ * Component placeholder type.
+ * May later be extended to support specific runtime renderers.
+ */
+
+/**
+ * Defines core runtime options for Fabric.
+ */
+interface FabricOptions {
   /**
+   * Determines how Fabric processes files.
+   * - `sequential`: files are processed one by one
+   * - `parallel`: files are processed concurrently
+   *
    * @default 'sequential'
    */
   mode?: FabricMode;
-};
-type FabricEvents = {
-  /**
-   * Called in the beginning of the app lifecycle.
-   */
+}
+/**
+ * Available modes for file processing.
+ */
+type FabricMode = 'sequential' | 'parallel';
+/**
+ * Event definitions emitted during the Fabric lifecycle.
+ */
+interface FabricEvents {
+  /** Called at the beginning of the app lifecycle. */
   start: [];
-  /**
-   * Called in the end of the app lifecycle.
-   */
+  /** Called at the end of the app lifecycle. */
   end: [];
-  /**
-   * Called when being rendered
-   */
+  /** Called when Fabric is rendering. */
   render: [{
     fabric: Fabric;
   }];
-  /**
-   * Called once before processing any files.
-   */
+  /** Called once before any files are processed. */
   'process:start': [{
     files: ResolvedFile[];
   }];
-  /**
-   * Called when FileManager is adding files to its cache
-   */
+  /** Called when files are added to the FileManager cache. */
   'file:add': [{
     files: ResolvedFile[];
   }];
@@ -259,24 +274,20 @@ type FabricEvents = {
   'write:end': [{
     files: ResolvedFile[];
   }];
-  /**
-   * Called for each file when processing begins.
-   */
+  /** Called for each file when processing begins. */
   'file:start': [{
     file: ResolvedFile;
     index: number;
     total: number;
   }];
-  /**
-   * Called for each file when processing finishes.
-   */
+  /** Called for each file when processing completes. */
   'file:end': [{
     file: ResolvedFile;
     index: number;
     total: number;
   }];
   /**
-   * Called periodically (or after each file) to indicate progress.
+   * Called periodically (or per file) to indicate progress.
    * Useful for progress bars or logging.
    */
   'process:progress': [{
@@ -286,33 +297,67 @@ type FabricEvents = {
     source?: string;
     file: ResolvedFile;
   }];
-  /**
-   * Called once all files have been processed successfully.
-   */
+  /** Called once all files have been processed successfully. */
   'process:end': [{
     files: ResolvedFile[];
   }];
-};
-type FabricContext<TOptions extends FabricOptions> = {
-  config?: FabricConfig<TOptions>;
-  events: AsyncEventEmitter<FabricEvents>;
+}
+/**
+ * Shared context passed to all plugins, parsers, and Fabric internals.
+ */
+interface FabricContext<T extends FabricOptions = FabricOptions> extends AsyncEventEmitter<FabricEvents> {
+  /** The active Fabric configuration. */
+  config?: FabricConfig<T>;
+  /** The internal file manager handling file creation, merging, and writing. */
   fileManager: FileManager;
+  /** List of files currently in memory. */
+  files: ResolvedFile[];
+  /** Add new files to the file manager. */
+  addFile(...files: File[]): Promise<void>;
+  /** Track installed plugins and parsers to prevent duplicates. */
   installedPlugins: Set<Plugin>;
   installedParsers: Set<Parser>;
-};
-type FabricMode = 'sequential' | 'parallel';
+}
+/**
+ * Base configuration object for Fabric.
+ */
+interface FabricConfig<T extends FabricOptions = FabricOptions> {
+  /** The runtime options used to configure Fabric. */
+  options: T;
+}
+/**
+ * Utility type that checks whether all properties of `T` are optional.
+ */
 type AllOptional<T> = {} extends T ? true : false;
-type FabricConfig<TOptions extends FabricOptions> = {
-  options: TOptions;
-};
-type Install<TOptions = unknown> = TOptions extends any[] ? (app: Fabric, ...options: TOptions) => void | Promise<void> : AllOptional<TOptions> extends true ? (app: Fabric, options: TOptions | undefined) => void | Promise<void> : (app: Fabric, options: TOptions) => void | Promise<void>;
-type Inject<TOptions = unknown, TAppExtension extends Record<string, any> = {}> = TOptions extends any[] ? (app: Fabric, ...options: TOptions) => Partial<TAppExtension> : AllOptional<TOptions> extends true ? (app: Fabric, options: TOptions | undefined) => Partial<TAppExtension> : (app: Fabric, options: TOptions) => Partial<TAppExtension>;
-interface Fabric<TOptions extends FabricOptions = FabricOptions> extends Kubb.Fabric {
-  context: FabricContext<TOptions>;
-  files: Array<ResolvedFile>;
-  use<TPluginOptions = unknown, TMeta extends object = object, TAppExtension extends Record<string, any> = {}>(pluginOrParser: Plugin<TPluginOptions, TAppExtension> | Parser<TPluginOptions, TMeta>, ...options: TPluginOptions extends any[] ? NoInfer<TPluginOptions> : AllOptional<TPluginOptions> extends true ? [NoInfer<TPluginOptions>?] : [NoInfer<TPluginOptions>]): (this & TAppExtension) | Promise<this & TAppExtension>;
-  addFile(...files: Array<File>): Promise<void>;
+/**
+ * Defines the signature of a plugin or parser's `install` function.
+ */
+type Install<TOptions = unknown> = TOptions extends any[] ? (context: FabricContext, ...options: TOptions) => void | Promise<void> : AllOptional<TOptions> extends true ? (context: FabricContext, options?: TOptions) => void | Promise<void> : (context: FabricContext, options: TOptions) => void | Promise<void>;
+/**
+ * Defines the signature of a plugin or parser's `inject` function.
+ * Returns an object that extends the Fabric instance.
+ */
+type Inject<TOptions = unknown, TExtension extends Record<string, any> = {}> = TOptions extends any[] ? (context: FabricContext, ...options: TOptions) => Partial<TExtension> : AllOptional<TOptions> extends true ? (context: FabricContext, options?: TOptions) => Partial<TExtension> : (context: FabricContext, options: TOptions) => Partial<TExtension>;
+/**
+ * The main Fabric runtime interface.
+ * Provides access to the current context, registered plugins, files, and utility methods.
+ */
+interface Fabric<T extends FabricOptions = FabricOptions> extends Kubb.Fabric {
+  /** The shared context for this Fabric instance. */
+  context: FabricContext<T>;
+  /** The files managed by this Fabric instance. */
+  files: ResolvedFile[];
+  /**
+   * Install a plugin or parser into Fabric.
+   *
+   * @param target - The plugin or parser to install.
+   * @param options - Optional configuration or arguments for the target.
+   * @returns A Fabric instance extended by the plugin (if applicable).
+   */
+  use<TPluginOptions = unknown, TMeta extends object = object, TExtension extends Record<string, any> = {}>(target: Plugin<TPluginOptions, TExtension> | Parser<TPluginOptions, TMeta>, ...options: TPluginOptions extends any[] ? NoInfer<TPluginOptions> : AllOptional<TPluginOptions> extends true ? [NoInfer<TPluginOptions>?] : [NoInfer<TPluginOptions>]): (this & TExtension) | Promise<this & TExtension>;
+  /** Add one or more files to the Fabric file manager. */
+  addFile(...files: File[]): Promise<void>;
 }
 //#endregion
-export { FabricOptions as a, Parser as c, UserPlugin as d, Extname as f, ResolvedFile as h, FabricMode as i, UserParser as l, KubbFile_d_exports as m, FabricConfig as n, FileManager as o, File as p, FabricContext as r, FileProcessor as s, Fabric as t, Plugin as u };
-//# sourceMappingURL=Fabric-CxMkO4Rt.d.ts.map
+export { FabricOptions as a, FileManager as c, UserParser as d, Extname as f, ResolvedFile as h, FabricMode as i, FileProcessor as l, KubbFile_d_exports as m, FabricConfig as n, Plugin as o, File as p, FabricContext as r, UserPlugin as s, Fabric as t, Parser as u };
+//# sourceMappingURL=Fabric-CBrTERuf.d.cts.map