@visulima/pail 4.0.0-alpha.8 → 4.0.0

package/dist/pail.server.d.ts

@@ -1,233 +0,0 @@
-import InteractiveManager from "./interactive/interactive-manager.d.ts";
-import { PailBrowserImpl } from "./pail.d.ts";
-import type { MultiBarOptions, SingleBarOptions } from "./progress-bar.d.ts";
-import { MultiProgressBar, ProgressBar } from "./progress-bar.d.ts";
-import type { SpinnerOptions } from "./spinner.d.ts";
-import { MultiSpinner, Spinner } from "./spinner.d.ts";
-import type { ConstructorOptions, DefaultLogTypes, LoggerFunction, Reporter, ServerConstructorOptions } from "./types.d.ts";
-declare class PailServerImpl<T extends string = string, L extends string = string> extends PailBrowserImpl<T, L> {
-    #private;
-    readonly options: ServerConstructorOptions<T, L>;
-    protected readonly stdout: NodeJS.WriteStream;
-    protected readonly stderr: NodeJS.WriteStream;
-    protected interactiveManager: InteractiveManager | undefined;
-    protected readonly interactive: boolean;
-    /**
-     * Creates a new Pail server logger instance.
-     *
-     * Initializes the server-compatible logger with streams, interactive support,
-     * and server-specific configuration options.
-     * @param options Server-specific configuration options
-     */
-    constructor(options: ServerConstructorOptions<T, L>);
-    scope<N extends string = T>(...name: string[]): PailServerType<N, L>;
-    /**
-     * Creates a child logger that inherits settings from the parent.
-     *
-     * Returns a new logger instance that inherits all configuration from the parent
-     * (reporters, processors, types, log levels, throttle settings, etc.) while allowing
-     * you to override only what you need. Child loggers are independent instances with
-     * their own state (timers, counters, etc.).
-     * @template N - The new custom logger type names
-     * @template LC - The new log level types
-     * @param options Configuration options to override or extend parent settings
-     * @returns A new child logger instance
-     * @example
-     * ```typescript
-     * const parent = createPail({
-     *   logLevel: "info",
-     *   types: { http: { label: "HTTP", logLevel: "info" } },
-     *   reporters: [new PrettyReporter()],
-     * });
-     *
-     * // Child inherits parent settings but overrides log level
-     * const child = parent.child({ logLevel: "debug" });
-     * child.info("This will be logged"); // Uses debug level from child
-     * child.http("GET /api 200"); // Inherits http type from parent
-     *
-     * // Child can add new types
-     * const childWithNewType = parent.child({
-     *   types: { db: { label: "DB", logLevel: "info" } },
-     * });
-     * childWithNewType.db("Query executed"); // New type available
-     * ```
-     */
-    child<N extends string = T, LC extends string = L>(options?: Partial<ConstructorOptions<N, LC>> & Partial<Pick<ServerConstructorOptions<N, LC>, "interactive" | "stderr" | "stdout">>): PailServerType<N, LC>;
-    /**
-     * Gets the interactive manager instance if interactive mode is enabled.
-     *
-     * Returns the InteractiveManager instance that handles interactive terminal
-     * features like progress bars and dynamic updates. Only available when
-     * interactive mode is enabled in the constructor options.
-     * @returns The interactive manager instance, or undefined if not in interactive mode
-     * @example
-     * ```typescript
-     * const logger = createPail({ interactive: true });
-     * const manager = logger.getInteractiveManager();
-     * if (manager) {
-     *   manager.hook();
-     *   // Use interactive features
-     *   manager.unhook();
-     * }
-     * ```
-     */
-    getInteractiveManager(): InteractiveManager | undefined;
-    /**
-     * Wraps stdout and stderr streams to redirect them through the logger.
-     *
-     * Intercepts writes to process.stdout and process.stderr, redirecting them
-     * through the logger instead of writing directly to the streams. This allows
-     * all output to be processed by the logging pipeline.
-     * @example
-     * ```typescript
-     * const logger = createPail();
-     * logger.wrapStd();
-     *
-     * console.log("This goes through logger");
-     * process.stdout.write("This too");
-     *
-     * logger.restoreStd(); // Restore original streams
-     * ```
-     */
-    wrapStd(): void;
-    /**
-     * Restores the original stdout and stderr streams.
-     *
-     * Removes the stream wrapping that was applied by wrapStd(),
-     * restoring the original stream write methods.
-     * @example
-     * ```typescript
-     * const logger = createPail();
-     * logger.wrapStd();
-     * // Streams are wrapped
-     * logger.restoreStd();
-     * // Streams are restored to original behavior
-     * ```
-     */
-    restoreStd(): void;
-    /**
-     * Wraps all output sources (console and streams).
-     *
-     * Convenience method that calls both wrapConsole() and wrapStd()
-     * to redirect all output through the logger.
-     * @example
-     * ```typescript
-     * const logger = createPail();
-     * logger.wrapAll(); // Wraps console and streams
-     *
-     * // All output now goes through logger
-     * console.log("Console output");
-     * process.stdout.write("Stream output");
-     *
-     * logger.restoreAll(); // Restore everything
-     * ```
-     */
-    wrapAll(): void;
-    /**
-     * Restores all wrapped output sources.
-     *
-     * Convenience method that calls both restoreConsole() and restoreStd()
-     * to restore all original output behavior.
-     * @example
-     * ```typescript
-     * const logger = createPail();
-     * logger.wrapAll();
-     * // All output is wrapped
-     * logger.restoreAll();
-     * // All output sources are restored
-     * ```
-     */
-    restoreAll(): void;
-    /**
-     * Creates a single progress bar.
-     * @param options Configuration options for the progress bar
-     * @returns A new ProgressBar instance
-     * @example
-     * ```typescript
-     * const logger = createPail({ interactive: true });
-     * const bar = logger.createProgressBar({
-     *   total: 100,
-     *   format: 'Downloading [{bar}] {percentage}% | ETA: {eta}s | {value}/{total}'
-     * });
-     *
-     * bar.start();
-     * // ... do work and update progress
-     * bar.update(50);
-     * bar.stop();
-     * ```
-     */
-    createProgressBar(options: SingleBarOptions): ProgressBar;
-    /**
-     * Creates a multi-bar progress manager for displaying multiple progress bars.
-     * @param options Configuration options for the multi-bar manager
-     * @returns A new MultiProgressBar instance
-     * @example
-     * ```typescript
-     * const logger = createPail({ interactive: true });
-     * const multiBar = logger.createMultiProgressBar();
-     *
-     * const bar1 = multiBar.create(100);
-     * const bar2 = multiBar.create(200);
-     *
-     * bar1.start();
-     * bar2.start();
-     * // ... update bars as needed
-     * multiBar.stop();
-     * ```
-     */
-    createMultiProgressBar(options?: MultiBarOptions): MultiProgressBar;
-    /**
-     * Creates a single spinner.
-     * @param options Configuration options for the spinner
-     * @returns A new Spinner instance
-     * @example
-     * ```typescript
-     * const logger = createPail({ interactive: true });
-     * const spinner = logger.createSpinner({ name: 'dots' });
-     * spinner.start('Loading...');
-     * // ... do work
-     * spinner.succeed('Done');
-     * ```
-     */
-    createSpinner(options?: SpinnerOptions): Spinner;
-    /**
-     * Creates a multi-spinner manager for displaying multiple spinners.
-     * @param options Configuration options for the multi-spinner manager
-     * @returns A new MultiSpinner instance
-     * @example
-     * ```typescript
-     * const logger = createPail({ interactive: true });
-     * const multiSpinner = logger.createMultiSpinner();
-     *
-     * const spinner1 = multiSpinner.create('Loading 1');
-     * const spinner2 = multiSpinner.create('Loading 2');
-     *
-     * spinner1.start();
-     * spinner2.start();
-     * // ... update spinners as needed
-     * multiSpinner.stop();
-     * ```
-     */
-    createMultiSpinner(options?: SpinnerOptions): MultiSpinner;
-    /**
-     * Clears the terminal screen.
-     *
-     * Sends ANSI escape sequences to clear the terminal screen and move
-     * the cursor to the top-left position. This overrides the browser
-     * implementation to work with terminal streams.
-     * @example
-     * ```typescript
-     * const logger = createPail();
-     * logger.info("Some output");
-     * logger.clear(); // Clears the terminal screen
-     * ```
-     */
-    clear(): void;
-    protected extendReporter(reporter: Reporter<L>): Reporter<L>;
-}
-export type PailServerType<T extends string = string, L extends string = string> = Console & (new <TC extends string = string, LC extends string = string>(options?: ServerConstructorOptions<TC, LC>) => PailServerType<TC, LC>) & PailServerImpl<T, L> & Record<DefaultLogTypes, LoggerFunction> & Record<T, LoggerFunction> & {
-    force: Record<DefaultLogTypes, LoggerFunction> & Record<T, LoggerFunction>;
-};
-export type PailConstructor<T extends string = string, L extends string = string> = new (options?: ServerConstructorOptions<T, L>) => PailServerType<T, L>;
-export declare const PailServer: PailServerType;
-export {};

package/dist/processor/caller/get-caller-filename.d.ts

@@ -1,23 +0,0 @@
-/**
- * Gets the file location information of the caller.
- *
- * Uses Node.js stack trace API to analyze the call stack and determine
- * the file, line, and column where this function was called from.
- * Filters out internal pail files and native code.
- * @returns Object containing file location information
- * @example
- * ```typescript
- * const location = getCallerFilename();
- * console.log(location);
- * // { fileName: "/path/to/file.js", lineNumber: 42, columnNumber: 10 }
- * ```
- */
-declare const getCallerFilename: () => {
-    /** Column number where the call originated */
-    columnNumber?: number;
-    /** File name/path where the call originated */
-    fileName: string | undefined;
-    /** Line number where the call originated */
-    lineNumber?: number;
-};
-export default getCallerFilename;

package/dist/progress-bar.d.ts

@@ -1,136 +0,0 @@
-import type InteractiveManager from "./interactive/interactive-manager.d.ts";
-export type ProgressBarStyle = "shades_classic" | "shades_grey" | "rect" | "filled" | "solid" | "ascii" | "custom";
-export interface ProgressBarOptions {
-    barCompleteChar?: string | string[];
-    barGlue?: string;
-    barIncompleteChar?: string | string[];
-    current?: number;
-    format?: string;
-    fps?: number;
-    style?: ProgressBarStyle;
-    total: number;
-    width?: number;
-}
-export interface SingleBarOptions extends ProgressBarOptions {
-    format?: string;
-}
-export interface MultiBarOptions {
-    barCompleteChar?: string | string[];
-    barGlue?: string;
-    barIncompleteChar?: string | string[];
-    composite?: boolean;
-    format?: string;
-    fps?: number;
-    style?: ProgressBarStyle;
-}
-export interface ProgressBarPayload {
-    [key: string]: string | number | boolean;
-}
-/**
- * Gets the appropriate bar character based on style and completion state.
- * @param char Custom character override
- * @param style Progress bar style to use
- * @param complete Whether to get completed or incomplete character
- * @returns The appropriate character for the given style
- */
-export declare const getBarChar: (char: string | undefined, style: ProgressBarStyle, complete?: boolean) => string;
-export declare const applyStyleToOptions: <T extends ProgressBarOptions | MultiBarOptions>(options: T) => T;
-export declare class ProgressBar {
-    protected options: ProgressBarOptions;
-    protected current: number;
-    private startTime;
-    private interactiveManager?;
-    private isActive;
-    private payload?;
-    /**
-     * Creates a new progress bar instance.
-     * @param options Configuration options for the progress bar
-     * @param interactiveManager Optional interactive manager for rendering
-     * @param payload Optional initial payload data for format placeholders
-     */
-    constructor(options: ProgressBarOptions, interactiveManager?: InteractiveManager, payload?: ProgressBarPayload);
-    /**
-     * Updates the progress bar to a new value.
-     * @param current The current progress value
-     * @param payload Optional payload data to merge with existing data
-     */
-    update(current: number, payload?: ProgressBarPayload): void;
-    /**
-     * Increments the progress bar by a specified step.
-     * @param step Amount to increment (default: 1)
-     * @param payload Optional payload data to merge with existing data
-     */
-    increment(step?: number, payload?: ProgressBarPayload): void;
-    /**
-     * Renders the progress bar as a formatted string.
-     * @returns Formatted progress bar string with all placeholders replaced
-     */
-    render(): string;
-    /**
-     * Starts the progress bar.
-     * @param total Optional total value to set
-     * @param startValue Optional starting value
-     * @param payload Optional initial payload data
-     */
-    start(total?: number, startValue?: number, payload?: ProgressBarPayload): void;
-    /**
-     * Stops the progress bar and cleanup.
-     */
-    stop(): void;
-    private calculateETA;
-}
-export declare class MultiBarInstance extends ProgressBar {
-    private multiBar;
-    constructor(multiBar: MultiProgressBar, options: ProgressBarOptions, payload?: ProgressBarPayload);
-    update(current: number, payload?: ProgressBarPayload): void;
-    getBarState(): {
-        char: string;
-        current: number;
-        total: number;
-    };
-}
-export declare class MultiProgressBar {
-    private bars;
-    private options;
-    private interactiveManager?;
-    private isActive;
-    private nextBarId;
-    private composite;
-    private barColors;
-    /**
-     * Creates a new multi progress bar manager.
-     * @param options Configuration options for the progress bars
-     * @param interactiveManager Optional interactive manager for rendering
-     */
-    constructor(options?: MultiBarOptions, interactiveManager?: InteractiveManager);
-    /**
-     * Creates a new progress bar within this multi-bar manager.
-     * @param total Total value for the progress bar
-     * @param current Starting current value (default: 0)
-     * @param payload Optional initial payload data for format placeholders
-     * @returns The created progress bar instance
-     */
-    create(total: number, current?: number, payload?: ProgressBarPayload): ProgressBar;
-    /**
-     * Removes a progress bar from the manager.
-     * @param bar The progress bar instance to remove
-     * @returns True if the bar was removed, false if not found
-     */
-    remove(bar: ProgressBar): boolean;
-    /**
-     * Renders all progress bars.
-     */
-    renderAll(): void;
-    /**
-     * Sets or removes a color function for a specific bar.
-     * @param bar The progress bar instance to color (must be from this MultiProgressBar)
-     * @param color Color function or undefined to remove color
-     */
-    setBarColor(bar: MultiBarInstance, color: ((text: string) => string) | undefined): void;
-    /**
-     * Stops all progress bars and cleanup.
-     */
-    stop(): void;
-    private renderComposite;
-    private getCompositeChar;
-}