@decaf-ts/logging 0.11.4 → 0.12.1

package/lib/time.d.ts

@@ -1,151 +0,0 @@
-/**
- * @description A snapshot of a recorded lap interval.
- * @summary This captures the lap index, an optional label, the elapsed milliseconds for the lap, and the cumulative elapsed time since the stopwatch started.
- * @typedef {object} Lap
- * @property {number} index - The zero-based lap order.
- * @property {string} [label] - An optional label that describes the lap.
- * @property {number} ms - The duration of the lap in milliseconds.
- * @property {number} totalMs - The total elapsed time when the lap was recorded.
- * @memberOf module:Logging
- */
-export type Lap = {
-    index: number;
-    label?: string;
-    /** Duration of this lap in milliseconds */
-    ms: number;
-    /** Cumulative time up to this lap in milliseconds */
-    totalMs: number;
-};
-type NowFn = () => number;
-/**
- * @description A high-resolution clock accessor that returns milliseconds.
- * @summary This function chooses the most precise timer available in the current runtime, preferring `performance.now` or `process.hrtime.bigint`.
- * @return {number} The milliseconds that have elapsed, according to the best available clock.
- * @function now
- * @memberOf module:Logging
- */
-export declare const now: NowFn;
-/**
- * @description A high-resolution stopwatch with pause, resume, and lap tracking.
- * @summary This class tracks elapsed time using the highest precision timer available. It supports pausing, resuming, and recording labeled laps for diagnostics and benchmarking.
- * @param {boolean} [autoStart=false] - When `true`, the stopwatch starts immediately upon construction.
- * @class StopWatch
- * @example
- * const sw = new StopWatch(true);
- * // ... work ...
- * const lap = sw.lap("phase 1");
- * sw.pause();
- * console.log(`Elapsed: ${lap.totalMs}ms`);
- * @mermaid
- * sequenceDiagram
- *   participant Client
- *   participant StopWatch
- *   participant Clock as now()
- *   Client->>StopWatch: start()
- *   StopWatch->>Clock: now()
- *   Clock-->>StopWatch: timestamp
- *   Client->>StopWatch: lap()
- *   StopWatch->>Clock: now()
- *   Clock-->>StopWatch: timestamp
- *   StopWatch-->>Client: Lap
- *   Client->>StopWatch: pause()
- *   StopWatch->>Clock: now()
- *   Clock-->>StopWatch: timestamp
- */
-export declare class StopWatch {
-    private _startMs;
-    private _elapsedMs;
-    private _running;
-    private _laps;
-    private _lastLapTotalMs;
-    constructor(autoStart?: boolean);
-    /**
-     * @description Indicates whether the stopwatch is actively running.
-     * @summary This method returns `true` when timing is in progress, and `false` when it is paused or stopped.
-     * @return {boolean} The current running state.
-     */
-    get running(): boolean;
-    /**
-     * @description The elapsed time that has been captured by the stopwatch.
-     * @summary This method computes the total elapsed time in milliseconds, including the current session if it is running.
-     * @return {number} The milliseconds that have elapsed since the stopwatch started.
-     */
-    get elapsedMs(): number;
-    /**
-     * @description Starts timing if the stopwatch is not already running.
-     * @summary This method records the current timestamp and transitions the stopwatch into the running state.
-     * @return {this} A fluent reference to the stopwatch.
-     */
-    start(): this;
-    /**
-     * @description Pauses timing and accumulates the elapsed milliseconds.
-     * @summary This method captures the partial duration, updates the accumulator, and keeps the stopwatch ready to resume later.
-     * @return {this} A fluent reference to the stopwatch.
-     */
-    pause(): this;
-    /**
-     * @description Resumes timing after a pause.
-     * @summary This method captures a fresh start timestamp, while keeping the previous elapsed time intact.
-     * @return {this} A fluent reference to the stopwatch.
-     */
-    resume(): this;
-    /**
-     * @description Stops timing and returns the total elapsed milliseconds.
-     * @summary This method invokes {@link StopWatch.pause} to consolidate the elapsed time, and leaves the stopwatch in a non-running state.
-     * @return {number} The milliseconds that have accumulated across all runs.
-     */
-    stop(): number;
-    /**
-     * @description Resets the stopwatch state, while optionally continuing to run.
-     * @summary This method clears the elapsed time and lap history, and preserves whether the stopwatch should continue ticking.
-     * @return {this} A fluent reference to the stopwatch.
-     */
-    reset(): this;
-    /**
-     * @description Records a lap split since the stopwatch started, or since the previous lap.
-     * @summary This method stores the lap metadata, updates the cumulative tracking, and returns the newly created {@link Lap}.
-     * @param {string} [label] - An optional label that describes the lap.
-     * @return {Lap} A lap snapshot that captures incremental and cumulative timings.
-     */
-    lap(label?: string): Lap;
-    /**
-     * @description Retrieves the recorded lap history.
-     * @summary This method returns the internal lap array as a read-only view to prevent external mutation.
-     * @return {Array<Lap>} The laps that have been captured by the stopwatch.
-     */
-    get laps(): readonly Lap[];
-    /**
-     * @description Formats the elapsed time in a human-readable representation.
-     * @summary This method uses {@link formatMs} to produce an `hh:mm:ss.mmm` string for display and logging.
-     * @return {string} The elapsed time, formatted for presentation.
-     */
-    toString(): string;
-    /**
-     * @description Serializes the stopwatch state.
-     * @summary This method provides a JSON-friendly snapshot that includes the running state, elapsed time, and lap details.
-     * @return {{running: boolean, elapsedMs: number, laps: Lap[]}} A serializable stopwatch representation.
-     */
-    toJSON(): {
-        running: boolean;
-        elapsedMs: number;
-        laps: Lap[];
-    };
-}
-/**
- * @description Formats milliseconds into `hh:mm:ss.mmm`.
- * @summary This function breaks the duration into hours, minutes, seconds, and milliseconds, and returns a zero-padded string.
- * @param {number} ms - The milliseconds to format.
- * @return {string} The formatted duration string.
- * @function formatMs
- * @memberOf module:Logging
- * @mermaid
- * sequenceDiagram
- *   participant Caller
- *   participant Formatter as formatMs
- *   Caller->>Formatter: formatMs(ms)
- *   Formatter->>Formatter: derive hours/minutes/seconds
- *   Formatter->>Formatter: pad segments
- *   Formatter-->>Caller: hh:mm:ss.mmm
- */
-export declare function formatMs(ms: number): string;
-export {};

package/lib/time.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"time.js","sourceRoot":"","sources":["../src/time.ts"],"names":[],"mappings":";;;AA+OA,4BASC;AAnOD,SAAS,OAAO;IACd,wCAAwC;IACxC,IACE,OAAO,UAAU,KAAK,WAAW;QACjC,OAAO,UAAU,CAAC,WAAW,EAAE,GAAG,KAAK,UAAU,EACjD,CAAC;QACD,OAAO,GAAG,EAAE,CAAC,UAAU,CAAC,WAAW,CAAC,GAAG,EAAE,CAAC;IAC5C,CAAC;IACD,oEAAoE;IACpE,IACE,OAAO,OAAO,KAAK,WAAW;QAC9B,OAAQ,OAAe,CAAC,MAAM,EAAE,MAAM,KAAK,UAAU,EACrD,CAAC;QACD,OAAO,GAAG,EAAE;YACV,MAAM,EAAE,GAAI,OAAe,CAAC,MAAM,CAAC,MAAM,EAAY,CAAC,CAAC,cAAc;YACrE,OAAO,MAAM,CAAC,EAAE,CAAC,GAAG,SAAS,CAAC,CAAC,QAAQ;QACzC,CAAC,CAAC;IACJ,CAAC;IACD,WAAW;IACX,OAAO,GAAG,EAAE,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC;AAC1B,CAAC;AAED;;;;;;GAMG;AACU,QAAA,GAAG,GAAG,OAAO,EAAE,CAAC;AAE7B;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,MAAa,SAAS;IAOpB,YAAY,SAAS,GAAG,KAAK;QANrB,aAAQ,GAAkB,IAAI,CAAC;QAC/B,eAAU,GAAG,CAAC,CAAC;QACf,aAAQ,GAAG,KAAK,CAAC;QACjB,UAAK,GAAU,EAAE,CAAC;QAClB,oBAAe,GAAG,CAAC,CAAC;QAG1B,IAAI,SAAS;YAAE,IAAI,CAAC,KAAK,EAAE,CAAC;IAC9B,CAAC;IAED;;;;OAIG;IACH,IAAI,OAAO;QACT,OAAO,IAAI,CAAC,QAAQ,CAAC;IACvB,CAAC;IAED;;;;OAIG;IACH,IAAI,SAAS;QACX,IAAI,CAAC,IAAI,CAAC,QAAQ,IAAI,IAAI,CAAC,QAAQ,IAAI,IAAI;YAAE,OAAO,IAAI,CAAC,UAAU,CAAC;QACpE,OAAO,IAAI,CAAC,UAAU,GAAG,CAAC,IAAA,WAAG,GAAE,GAAG,IAAI,CAAC,QAAQ,CAAC,CAAC;IACnD,CAAC;IAED;;;;OAIG;IACH,KAAK;QACH,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC;YACnB,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC;YACrB,IAAI,CAAC,QAAQ,GAAG,IAAA,WAAG,GAAE,CAAC;QACxB,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;OAIG;IACH,KAAK;QACH,IAAI,IAAI,CAAC,QAAQ,IAAI,IAAI,CAAC,QAAQ,IAAI,IAAI,EAAE,CAAC;YAC3C,IAAI,CAAC,UAAU,IAAI,IAAA,WAAG,GAAE,GAAG,IAAI,CAAC,QAAQ,CAAC;YACzC,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC;YACrB,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC;QACxB,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;OAIG;IACH,MAAM;QACJ,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC;YACnB,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC;YACrB,IAAI,CAAC,QAAQ,GAAG,IAAA,WAAG,GAAE,CAAC;QACxB,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;OAIG;IACH,IAAI;QACF,IAAI,CAAC,KAAK,EAAE,CAAC;QACb,OAAO,IAAI,CAAC,UAAU,CAAC;IACzB,CAAC;IAED;;;;OAIG;IACH,KAAK;QACH,MAAM,UAAU,GAAG,IAAI,CAAC,QAAQ,CAAC;QACjC,IAAI,CAAC,QAAQ,GAAG,UAAU,CAAC,CAAC,CAAC,IAAA,WAAG,GAAE,CAAC,CAAC,CAAC,IAAI,CAAC;QAC1C,IAAI,CAAC,UAAU,GAAG,CAAC,CAAC;QACpB,IAAI,CAAC,KAAK,GAAG,EAAE,CAAC;QAChB,IAAI,CAAC,eAAe,GAAG,CAAC,CAAC;QACzB,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;OAKG;IACH,GAAG,CAAC,KAAc;QAChB,MAAM,KAAK,GAAG,IAAI,CAAC,SAAS,CAAC;QAC7B,MAAM,EAAE,GAAG,KAAK,GAAG,IAAI,CAAC,eAAe,CAAC;QACxC,MAAM,GAAG,GAAQ;YACf,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC,MAAM;YACxB,KAAK;YACL,EAAE;YACF,OAAO,EAAE,KAAK;SACf,CAAC;QACF,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACrB,IAAI,CAAC,eAAe,GAAG,KAAK,CAAC;QAC7B,OAAO,GAAG,CAAC;IACb,CAAC;IACD;;;;OAIG;IACH,IAAI,IAAI;QACN,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;IAED;;;;OAIG;IACH,QAAQ;QACN,OAAO,QAAQ,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;IAClC,CAAC;IAED;;;;OAIG;IACH,MAAM;QACJ,OAAO;YACL,OAAO,EAAE,IAAI,CAAC,QAAQ;YACtB,SAAS,EAAE,IAAI,CAAC,SAAS;YACzB,IAAI,EAAE,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE;SACzB,CAAC;IACJ,CAAC;CACF;AA/ID,8BA+IC;AACD;;;;;;;;;;;;;;;GAeG;AACH,SAAgB,QAAQ,CAAC,EAAU;IACjC,MAAM,IAAI,GAAG,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC;IAC/B,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;IACzB,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,GAAG,SAAS,CAAC,CAAC;IAC1C,MAAM,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,GAAG,GAAG,SAAS,CAAC,GAAG,MAAM,CAAC,CAAC;IACvD,MAAM,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,GAAG,GAAG,MAAM,CAAC,GAAG,IAAI,CAAC,CAAC;IAClD,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,GAAG,IAAI,CAAC,CAAC;IACtC,MAAM,GAAG,GAAG,CAAC,CAAS,EAAE,CAAS,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC;IACpE,OAAO,GAAG,IAAI,GAAG,GAAG,CAAC,KAAK,EAAE,CAAC,CAAC,IAAI,GAAG,CAAC,OAAO,EAAE,CAAC,CAAC,IAAI,GAAG,CAAC,OAAO,EAAE,CAAC,CAAC,IAAI,GAAG,CAAC,MAAM,EAAE,CAAC,CAAC,EAAE,CAAC;AAC3F,CAAC"}

package/lib/types.d.ts

@@ -1,287 +0,0 @@
-import { styles } from "styled-string-builder";
-import { LoggingMode, LogLevel } from "./constants";
-/**
- * @description A string-compatible value that can be accepted by the logging APIs.
- * @summary Represents either a literal string or an object that has a `toString()` method. This allows for the lazy stringification of complex payloads.
- * @typedef {(string|Object)} StringLike
- * @memberOf module:Logging
- */
-export type StringLike = string | {
-    toString: () => string;
-};
-export type LogMeta = Record<string, unknown>;
-/**
- * @description A generic function signature for loosely typed callbacks.
- * @summary This type covers variadic functions where the arguments and return types are not constrained, which enables the logging layer to accept any callable.
- * @typedef {function(...any[]): any} AnyFunction
- * @memberOf module:Logging
- */
-export type AnyFunction = (...args: any[]) => any;
-/**
- * @description A constructable class type.
- * @summary Describes a constructor that produces instances of type `T`. This allows APIs to accept class references for context-aware logging.
- * @template T
- * @typedef Class
- * @memberOf module:Logging
- */
-export type Class<T> = {
-    new (...args: any[]): T;
-};
-/**
- * @description A context descriptor that is accepted when requesting a logger instance.
- * @summary Allows the logging system to resolve context names from strings, constructors, or functions.
- * @typedef {(string|Class<any>|AnyFunction)} LoggingContext
- * @memberOf module:Logging
- */
-export type LoggingContext = string | Class<any> | AnyFunction;
-/**
- * @description An interface for factories that create contextual clones of the receiver.
- * @summary Declares a `for` method that returns another instance of `THIS` using the provided arguments. This enables chained logger customization.
- * @template THIS
- * @template ARGS
- * @interface Impersonatable
- * @memberOf module:Logging
- */
-export interface Impersonatable<THIS, ARGS extends any[] = any[]> {
-    /**
-     * @description Produce a copy of the current instance with altered context.
-     * @summary Called by logging utilities to derive child objects with supplemental configuration and context metadata.
-     * @param {ARGS} args - Arguments forwarded to the impersonation strategy.
-     * @return {THIS} Derived instance using the provided arguments.
-     */
-    for(...args: ARGS): THIS;
-}
-/**
- * @description An interface for loggers that support multiple verbosity levels.
- * @summary This interface declares severity-specific log methods, configuration overrides, and factory helpers that are used throughout the logging toolkit.
- * @interface Logger
- * @memberOf module:Logging
- */
-export interface Logger extends Impersonatable<Logger, [
-    (string | {
-        new (...args: any[]): any;
-    } | AnyFunction | Partial<LoggingConfig>),
-    Partial<LoggingConfig>,
-    ...any[]
-]> {
-    /**
-     * @description Logs a benchmark message.
-     * @summary Emits high-frequency performance metrics at the `benchmark` log level.
-     * @param {StringLike} msg - Message or payload to emit.
-     * @return {void}
-     */
-    benchmark(msg: StringLike, meta?: LogMeta): void;
-    /**
-     * @description Logs a `way too verbose` or a silly message.
-     * @summary Emits playful or extremely verbose details at the `silly` log level.
-     * @param {StringLike} msg - Message or payload to emit.
-     * @return {void}
-     */
-    silly(msg: StringLike, verbosity?: number | LogMeta, meta?: LogMeta): void;
-    /**
-     * @description Logs developer trace messages.
-     * @summary Emits playful or extremely verbose details at the `silly` log level.
-     * @param {StringLike} msg - Message or payload to emit.
-     * @return {void}
-     */
-    trace(msg: StringLike, meta?: LogMeta): void;
-    /**
-     * @description Logs a verbose message.
-     * @summary Writes diagnostic output governed by the configured verbosity threshold.
-     * @param {StringLike} msg - Message or payload to emit.
-     * @param {number} [verbosity] - Verbosity level required for the message to pass through.
-     * @return {void}
-     */
-    verbose(msg: StringLike, verbosityOrMeta?: number | LogMeta, meta?: LogMeta): void;
-    /**
-     * @description Logs an info message.
-     * @summary Emits general informational events that describe application progress.
-     * @param {StringLike} msg - Message or payload to emit.
-     * @return {void}
-     */
-    info(msg: StringLike, meta?: LogMeta): void;
-    /**
-     * @description Logs an error message.
-     * @summary Records errors and exceptions, including optional stack traces.
-     * @param {StringLike|Error} msg - Message or {@link Error} instance to log.
-     * @param {Error} [e] - Optional secondary error or cause.
-     * @return {void}
-     */
-    error(msg: StringLike | Error, error?: Error | LogMeta, meta?: LogMeta): void;
-    /**
-     * @description Logs a debug message.
-     * @summary Emits fine-grained diagnostic details useful during development and troubleshooting.
-     * @param {StringLike} msg - Message or payload to emit.
-     * @return {void}
-     */
-    debug(msg: StringLike, meta?: LogMeta): void;
-    /**
-     * @description Logs a debug message.
-     * @summary Emits fine-grained diagnostic details useful during development and troubleshooting.
-     * @param {StringLike} msg - Message or payload to emit.
-     * @return {void}
-     */
-    warn(msg: StringLike, meta?: LogMeta): void;
-    /**
-     * @description Creates a new logger for a specific method or context.
-     * @summary Produces a scoped logger that formats entries using the derived context and overrides supplied configuration.
-     * @param {any} method - Method name, callback, constructor, or partial configuration used to seed the child logger.
-     * @param {Partial<LoggingConfig>} [config] - Optional configuration overrides for the child logger.
-     * @param {...any[]} args - Extra arguments forwarded to factory implementations.
-     * @return {Logger} Logger instance tailored to the supplied context.
-     */
-    for(config: Partial<LoggingConfig>): this;
-    for(context: string | {
-        new (...args: any[]): any;
-    } | AnyFunction | object): this;
-    for(method: string | {
-        new (...args: any[]): any;
-    } | AnyFunction | object | Partial<LoggingConfig>, config?: Partial<LoggingConfig>, ...args: any[]): this;
-    /**
-     * @description Clears any contextual overrides applied via {@link Logger.for}.
-     * @summary Resets temporary context/configuration so ensuing chains start from the base logger while preserving the concrete instance type.
-     * @return {this} The same logger instance to continue chaining.
-     */
-    clear(): this;
-    /**
-     * @description Updates the logger configuration.
-     * @summary Merges the given options into the logger's existing configuration.
-     * @param {Partial<LoggingConfig>} config - Configuration overrides to apply.
-     * @return {void}
-     */
-    setConfig(config: Partial<LoggingConfig>): void;
-    /**
-     * @description Immutable base context for the logger instance.
-     * @summary Returned as a copy so callers cannot mutate the internal base context while still allowing inspection.
-     */
-    readonly root: string[];
-}
-/**
- * @description An interface for filters that can mutate or reject log messages.
- * @summary This allows for custom pre-processing of log entries before they are formatted or emitted.
- * @interface LoggingFilter
- * @memberOf module:Logging
- */
-export interface LoggingFilter {
-    /**
-     * @description Apply filtering logic to an incoming message.
-     * @summary Receives the active configuration, original message, and context stack to produce the final message string.
-     * @param {LoggingConfig} config - Active logging configuration.
-     * @param {string} message - Message submitted for logging.
-     * @param {string[]} context - Context identifiers associated with the message.
-     * @return {string} Filtered message string.
-     */
-    filter(config: LoggingConfig, message: string, context: string[]): string;
-}
-/**
- * @description Configuration for the logging system.
- * @summary Defines the log level, verbosity, and other settings for logging.
- * @template TRANSPORT
- * @typedef {object} LoggingConfig
- * @property {string} env - The environment, e.g., "development", "production".
- * @property {LogLevel} level - The logging level.
- * @property {boolean} [logLevel] - Whether to display the log level in the output.
- * @property {number} verbose - The verbosity level.
- * @property {string} contextSeparator - The separator to use between context entries.
- * @property {string} separator - The separator to use between log components.
- * @property {boolean} [style] - Whether to apply styling to the log output.
- * @property {boolean} [timestamp] - Whether to include timestamps in log messages.
- * @property {string} [timestampFormat] - The format for timestamps.
- * @property {boolean} [context] - Whether to include context information in log messages.
- * @property {Theme} [theme] - The theme to use for styling log messages.
- * @property {LoggingMode} format - The output format for log messages.
- * @property {string} pattern - The pattern to use for formatting log messages.
- * @property {(string|number)} [correlationId] - A correlation ID for tracking related log messages.
- * @property {(string[]|LoggingFilter[])} [filters] - An array of filters to apply to log messages.
- * @property {TRANSPORT[]} [transports] - An array of transports to use for logging.
- * @memberOf module:Logging
- */
-export type LoggingConfig<TRANSPORT = object> = {
-    env: "development" | "production" | "test" | "staging" | string;
-    level: LogLevel;
-    logLevel?: boolean;
-    verbose: number;
-    contextSeparator: string;
-    separator: string;
-    style?: boolean;
-    timestamp?: boolean;
-    timestampFormat?: string;
-    context?: boolean;
-    meta?: boolean;
-    theme?: Theme;
-    format: LoggingMode;
-    pattern: string;
-    correlationId?: string | number;
-    filters?: string[] | LoggingFilter[];
-    transports?: TRANSPORT[];
-};
-/**
- * @description A factory signature for creating logger instances.
- * @summary This allows consumers to override the logger construction with custom implementations.
- * @template L
- * @typedef {function(string, Partial<LoggingConfig>, ...any[]): L} LoggerFactory
- * @memberOf module:Logging
- */
-export type LoggerFactory<L extends Logger = Logger> = (object?: string, config?: Partial<LoggingConfig>, ...args: any[]) => L;
-/**
- * @description A theme option that is applied to a specific log element.
- * @summary This interface configures the foreground and background colors, as well as additional style directives for styled console output.
- * @interface ThemeOption
- * @memberOf module:Logging
- */
-export interface ThemeOption {
-    fg?: number | [number] | [number, number, number];
-    bg?: number | [number] | [number, number, number];
-    style?: number[] | [keyof typeof styles];
-}
-/**
- * @description A mapping between log levels and theme overrides.
- * @summary This enables level-specific styling by associating each {@link LogLevel} with a {@link ThemeOption} configuration.
- * @typedef {Partial<Record<LogLevel, ThemeOption>>} ThemeOptionByLogLevel
- * @memberOf module:Logging
- */
-export type ThemeOptionByLogLevel = Partial<Record<LogLevel, ThemeOption>>;
-/**
- * @description A theme definition that is applied to the console output.
- * @summary This interface specifies the styling for each console log element and supports overrides based on {@link LogLevel} values.
- * @interface Theme
- * @memberOf module:Logging
- */
-export interface Theme {
-    /**
-     * @description Styling for application identifiers in the output.
-     */
-    app: ThemeOption | ThemeOptionByLogLevel;
-    /**
-     * @description Styling for separators inserted between log sections.
-     */
-    separator: ThemeOption | ThemeOptionByLogLevel;
-    /**
-     * @description Styling for class names in the output.
-     */
-    class: ThemeOption | ThemeOptionByLogLevel;
-    /**
-     * @description Styling for timestamps in the output.
-     */
-    timestamp: ThemeOption | ThemeOptionByLogLevel;
-    /**
-     * @description Styling for the main message text in the output.
-     */
-    message: ThemeOption | ThemeOptionByLogLevel;
-    /**
-     * @description Styling for method names in the output.
-     */
-    method: ThemeOption | ThemeOptionByLogLevel;
-    /**
-     * @description Styling for identifier elements in the output.
-     */
-    id: ThemeOption | ThemeOptionByLogLevel;
-    /**
-     * @description Styling for stack trace blocks in the output.
-     */
-    stack: ThemeOption;
-    /**
-     * @description Styling overrides keyed by {@link LogLevel}.
-     */
-    logLevel: ThemeOptionByLogLevel;
-}

package/lib/types.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":""}

package/lib/utils.d.ts

@@ -1,48 +0,0 @@
-/**
- * @description Checks if a value is a class.
- * @summary This function determines if the given value is a class constructor.
- * @param {unknown} value - The value to check.
- * @return {boolean} `true` if the value is a class, `false` otherwise.
- * @function isClass
- * @memberOf module:Logging
- */
-export declare function isClass(value: unknown): value is abstract new (...args: any[]) => any;
-/**
- * @description Checks if a value is a function.
- * @summary This function determines if the given value is a function, but not a class.
- * @template T
- * @param {unknown} value - The value to check.
- * @return {boolean} `true` if the value is a function, `false` otherwise.
- * @function isFunction
- * @memberOf module:Logging
- */
-export declare function isFunction<T extends (...args: any[]) => unknown>(value: unknown): value is T;
-/**
- * @description Checks if a value is a method.
- * @summary This function determines if the given value is a method.
- * @template T
- * @param {unknown} value - The value to check.
- * @return {boolean} `true` if the value is a method, `false` otherwise.
- * @function isMethod
- * @memberOf module:Logging
- */
-export declare function isMethod<T extends (...args: any[]) => unknown>(value: unknown): value is T;
-/**
- * @description Checks if a value is an instance of a class.
- * @summary This function determines if the given value is an instance of a class.
- * @template T
- * @param {unknown} value - The value to check.
- * @return {boolean} `true` if the value is an instance of a class, `false` otherwise.
- * @function isInstance
- * @memberOf module:Logging
- */
-export declare function isInstance<T extends object>(value: unknown): value is T;
-/**
- * @description Gets the name of an object.
- * @summary This function returns the name of the given object, which can be a class, an instance of a class, a function, or a primitive value.
- * @param {unknown} value - The value to get the name of.
- * @return {string} The name of the object.
- * @function getObjectName
- * @memberOf module:Logging
- */
-export declare function getObjectName(value: unknown): string;

package/lib/utils.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"utils.js","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":";;AAQA,0BA+BC;AAWD,gCAIC;AAWD,4BAOC;AAWD,gCAQC;AAUD,sCA0CC;AA/ID;;;;;;;GAOG;AACH,SAAgB,OAAO,CACrB,KAAc;IAEd,IAAI,OAAO,KAAK,KAAK,UAAU;QAAE,OAAO,KAAK,CAAC;IAE9C,kCAAkC;IAClC,yDAAyD;IACzD,IAAI,CAAC;QACH,MAAM,GAAG,GAAG,QAAQ,CAAC,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACpD,IAAI,gBAAgB,CAAC,IAAI,CAAC,GAAG,CAAC;YAAE,OAAO,IAAI,CAAC;IAC9C,CAAC;IAAC,MAAM,CAAC;QACP,8DAA8D;IAChE,CAAC;IAED,oEAAoE;IACpE,MAAM,SAAS,GAAG,MAAM,CAAC,wBAAwB,CAAC,KAAK,EAAE,WAAW,CAAC,CAAC;IACtE,IAAI,CAAC,SAAS,IAAI,CAAC,SAAS,CAAC,KAAK;QAAE,OAAO,KAAK,CAAC;IAEjD,kEAAkE;IAClE,gEAAgE;IAChE,IAAI,SAAS,CAAC,QAAQ,KAAK,KAAK;QAAE,OAAO,IAAI,CAAC;IAE9C,8CAA8C;IAC9C,qEAAqE;IACrE,MAAM,KAAK,GAAI,KAAa,CAAC,SAAS,CAAC;IACvC,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,KAAK,EAAE,aAAa,CAAC;QAAE,OAAO,KAAK,CAAC;IAE9E,MAAM,KAAK,GAAG,MAAM,CAAC,mBAAmB,CAAC,KAAK,CAAC,CAAC,MAAM,CACpD,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,aAAa,CAC3B,CAAC;IACF,OAAO,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC;AAC1B,CAAC;AAED;;;;;;;;GAQG;AACH,SAAgB,UAAU,CACxB,KAAc;IAEd,OAAO,OAAO,KAAK,KAAK,UAAU,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;AACxD,CAAC;AAED;;;;;;;;GAQG;AACH,SAAgB,QAAQ,CACtB,KAAc;IAEd,IAAI,CAAC,UAAU,CAAI,KAAK,CAAC;QAAE,OAAO,KAAK,CAAC;IAExC,MAAM,UAAU,GAAG,MAAM,CAAC,wBAAwB,CAAC,KAAK,EAAE,WAAW,CAAC,CAAC;IACvE,OAAO,CAAC,UAAU,IAAI,UAAU,CAAC,KAAK,KAAK,SAAS,CAAC;AACvD,CAAC;AAED;;;;;;;;GAQG;AACH,SAAgB,UAAU,CAAmB,KAAc;IACzD,IAAI,KAAK,KAAK,IAAI,IAAI,OAAO,KAAK,KAAK,QAAQ;QAAE,OAAO,KAAK,CAAC;IAE9D,sEAAsE;IACtE,MAAM,IAAI,GAAI,KAAoC,CAAC,WAAW,CAAC;IAC/D,IAAI,CAAC,IAAI,IAAI,IAAI,KAAK,MAAM;QAAE,OAAO,KAAK,CAAC;IAE3C,OAAO,OAAO,CAAC,IAAI,CAAC,CAAC;AACvB,CAAC;AAED;;;;;;;GAOG;AACH,SAAgB,aAAa,CAAC,KAAc;IAC1C,IAAI,KAAK,KAAK,IAAI;QAAE,OAAO,MAAM,CAAC;IAClC,IAAI,KAAK,KAAK,SAAS;QAAE,OAAO,WAAW,CAAC;IAC5C,IAAI,OAAO,KAAK,KAAK,QAAQ;QAAE,OAAO,KAAK,CAAC;IAE5C,IAAI,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;QACnB,OAAO,KAAK,CAAC,IAAI,IAAI,gBAAgB,CAAC;IACxC,CAAC;IAED,IAAI,UAAU,CAAC,KAAK,CAAC,EAAE,CAAC;QACtB,MAAM,UAAU,GAAI,KAAqC,CAAC,QAAQ,CAAC;QACnE,IACE,OAAO,UAAU,KAAK,UAAU;YAChC,UAAU,KAAK,MAAM,CAAC,SAAS,CAAC,QAAQ,EACxC,CAAC;YACD,IAAI,CAAC;gBACH,MAAM,QAAQ,GAAG,UAAU,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;gBACxC,IAAI,OAAO,QAAQ,KAAK,QAAQ,IAAI,QAAQ,CAAC,MAAM;oBAAE,OAAO,QAAQ,CAAC;YACvE,CAAC;YAAC,MAAM,CAAC;gBACP,mEAAmE;YACrE,CAAC;QACH,CAAC;QACD,sEAAsE;QACtE,MAAM,IAAI,GAAI,KAAoC,CAAC,WAAW,CAAC;QAC/D,OAAO,IAAI,IAAI,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,mBAAmB,CAAC;IAC7D,CAAC;IAED,IAAI,QAAQ,CAAC,KAAK,CAAC,IAAI,UAAU,CAAC,KAAK,CAAC,EAAE,CAAC;QACzC,sEAAsE;QACtE,MAAM,EAAE,GAAG,KAAiB,CAAC;QAC7B,IAAI,EAAE,CAAC,IAAI;YAAE,OAAO,EAAE,CAAC,IAAI,CAAC;QAC5B,OAAO,WAAW,CAAC;IACrB,CAAC;IAED,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QAC9B,MAAM,GAAG,GAAG,MAAM,CAAC,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAClD,MAAM,KAAK,GAAG,uBAAuB,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAChD,IAAI,KAAK,EAAE,CAAC,CAAC,CAAC;YAAE,OAAO,KAAK,CAAC,CAAC,CAAC,CAAC;QAChC,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,OAAO,OAAO,KAAK,CAAC;AACtB,CAAC"}

package/lib/web.d.ts

@@ -1,8 +0,0 @@
-/**
- * @description Determines if the current environment is a browser by checking the prototype chain of the global object.
- * @summary This function checks if the code is running in a browser environment.
- * @return {boolean} `true` if the environment is a browser, `false` otherwise.
- * @function isBrowser
- * @memberOf module:Logging
- */
-export declare function isBrowser(): boolean;

package/lib/web.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"web.js","sourceRoot":"","sources":["../src/web.ts"],"names":[],"mappings":";;AAOA,8BAKC;AAZD;;;;;;GAMG;AACH,SAAgB,SAAS;IACvB,OAAO,CACL,MAAM,CAAC,cAAc,CAAC,MAAM,CAAC,cAAc,CAAC,UAAU,CAAC,CAAC;QACxD,MAAM,CAAC,SAAS,CACjB,CAAC;AACJ,CAAC"}

package/lib/winston/index.d.ts

@@ -1,7 +0,0 @@
-/**
- * @module Winston
- * @description This module provides an adapter for the Winston logger.
- * @summary This module exports the {@link WinstonLogger} class.
- * @memberOf module:Logging
- */
-export * from "./winston";

package/lib/winston/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/winston/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA;;;;;GAKG;AACH,gDAA0B"}

package/lib/winston/winston.d.ts

@@ -1,47 +0,0 @@
-import winston from "winston";
-import { Logger, LoggerFactory, LogMeta, LoggingConfig, StringLike } from "../types";
-import { MiniLogger } from "../logging";
-import { LogLevel } from "../constants";
-/**
- * @description A logger implementation that uses Winston.
- * @summary This class extends {@link MiniLogger} to provide logging functionality using the Winston library. It configures Winston with the appropriate transports and formats based on the logging configuration.
- * @param {string} [cont] - The context (typically the class name) that this logger is associated with.
- * @param {Partial<LoggingConfig>} [conf] - Optional configuration to override global settings.
- * @class WinstonLogger
- * @example
- * // Create a Winston logger for a class
- * const logger = new WinstonLogger('MyClass');
- *
- * // Log messages at different levels
- * logger.info('Application started');
- * logger.error(new Error('Something went wrong'));
- *
- * // Create a child logger for a specific method
- * const methodLogger = logger.for('myMethod');
- * methodLogger.debug('Processing data...');
- */
-export declare class WinstonLogger extends MiniLogger implements Logger {
-    protected winston: winston.Logger;
-    constructor(cont?: string, conf?: Partial<LoggingConfig>);
-    private resolveTransports;
-    /**
-     * @description Logs a message with the specified log level using Winston.
-     * @summary This method overrides the base log method to use Winston for logging.
-     * @param {LogLevel} level - The log level of the message.
-     * @param {(StringLike|Error)} msg - The message to be logged or an Error object.
-     * @param {Error} [error] - An optional stack trace to include in the log.
-     * @return {void}
-     */
-    protected log(level: LogLevel, msg: StringLike | Error, error?: Error, meta?: LogMeta): void;
-}
-/**
- * @description A factory function for creating Winston loggers.
- * @summary This is a {@link LoggerFactory} implementation that creates {@link WinstonLogger} instances.
- * @param {string} [context] - The context (typically the class name) for the logger.
- * @param {Partial<LoggingConfig>} [conf] - Optional configuration to override global settings.
- * @param {...any} _args - Additional arguments to pass to the WinstonLogger constructor.
- * @return {WinstonLogger} A new WinstonLogger instance.
- * @const WinstonFactory
- * @memberOf module:Logging
- */
-export declare const WinstonFactory: LoggerFactory;

package/lib/winston/winston.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"winston.js","sourceRoot":"","sources":["../../src/winston/winston.ts"],"names":[],"mappings":";;;;;;AAAA,sDAA2D;AAS3D,8CAAiD;AAGjD;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAa,aAAc,SAAQ,oBAAU;IAG3C,YAAY,IAAa,EAAE,IAA6B;QACtD,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;QAClB,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,CAC1B,EAAE,EACF,iBAAO,CAAC,SAAS,EAAE,EACnB,IAAI,CAAC,IAAI,IAAI,EAAE,CACY,CAAC;QAE9B,MAAM,UAAU,GAAG,IAAI,CAAC,iBAAiB,CACtC,MAAM,CAAC,UAAsC,IAAI,SAAS,CAC5D,CAAC;QACF,MAAM,WAAW,GAAG,iBAAO,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,OAAO,EAAE,EAAE,EAAE,CACxD,OAAO,OAAO,KAAK,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAChE,CAAC;QAEF,MAAM,aAAa,GAAkB;YACnC,KAAK,EAAE,MAAM,CAAC,KAAK;YACnB,UAAU;YACV,MAAM,EAAE,WAAW;SACpB,CAAC;QACF,IAAI,CAAC,OAAO,GAAG,iBAAO,CAAC,YAAY,CAAC,aAAa,CAAC,CAAC;IACrD,CAAC;IAEO,iBAAiB,CAAC,UAAwB;QAChD,IAAI,UAAU,IAAI,UAAU,CAAC,MAAM;YAAE,OAAO,UAAU,CAAC;QACvD,OAAO,CAAC,IAAI,iBAAO,CAAC,UAAU,CAAC,OAAO,EAAE,CAAC,CAAC;IAC5C,CAAC;IAED;;;;;;;OAOG;IACgB,GAAG,CACpB,KAAe,EACf,GAAuB,EACvB,KAAa,EACb,IAAc;QAEd,MAAM,OAAO,GAAa;YACxB,KAAK,EAAE,KAAK;YACZ,OAAO,EAAE,IAAI,CAAC,SAAS,CAAC,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE,IAAI,CAAC;SACjD,CAAC;QACF,IAAI,IAAI,CAAC,MAAM,CAAC,eAAe,CAAC;YAC9B,OAAO,CAAC,eAAe,CAAC,GAAG,IAAI,CAAC,MAAM,CAAC,eAAe,CAAC,CAAC;QAC1D,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;IAC5B,CAAC;CACF;AArDD,sCAqDC;AAED;;;;;;;;;GASG;AACI,MAAM,cAAc,GAAkB,CAC3C,OAAgB,EAChB,IAA6B;AAC7B,6DAA6D;AAC7D,GAAG,KAAY,EACA,EAAE,CAAC,IAAI,aAAa,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;AALxC,QAAA,cAAc,kBAK0B"}