@decaf-ts/logging 0.10.0 → 0.10.2

package/lib/esm/types.d.ts

@@ -1,8 +1,8 @@
 import { styles } from "styled-string-builder";
 import { LoggingMode, LogLevel } from "./constants";
 /**
- * @description String-compatible value accepted by the logging APIs.
- * @summary Represents either a literal string or an object exposing a `toString()` method, allowing lazy stringification of complex payloads.
+ * @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
  */
@@ -10,32 +10,32 @@ export type StringLike = string | {
     toString: () => string;
 };
 /**
- * @description Generic function signature for loosely typed callbacks.
- * @summary Covers variadic functions whose arguments and return types are not constrained, enabling the logging layer to accept any callable.
- * @typedef {function(any[]): any} AnyFunction
+ * @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 Constructable class type.
- * @summary Describes a constructor that produces instances of type `T`, allowing APIs to accept class references for context-aware logging.
+ * @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 {any} Class
+ * @typedef Class
  * @memberOf module:Logging
  */
 export type Class<T> = {
     new (...args: any[]): T;
 };
 /**
- * @description Context descriptor accepted when requesting a logger instance.
+ * @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|Function|Object)} LoggingContext
+ * @typedef {(string|Class<any>|AnyFunction)} LoggingContext
  * @memberOf module:Logging
  */
 export type LoggingContext = string | Class<any> | AnyFunction;
 /**
- * @description 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, enabling chained logger customization.
+ * @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
@@ -45,16 +45,14 @@ 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.
-     * @template THIS
-     * @template ARGS
      * @param {ARGS} args - Arguments forwarded to the impersonation strategy.
      * @return {THIS} Derived instance using the provided arguments.
      */
     for(...args: ARGS): THIS;
 }
 /**
- * @description Interface for loggers that support multiple verbosity levels.
- * @summary Declares severity-specific log methods, configuration overrides, and factory helpers used throughout the logging toolkit.
+ * @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
  */
@@ -131,13 +129,19 @@ export interface Logger extends Impersonatable<Logger, [
      * @param {...any[]} args - Extra arguments forwarded to factory implementations.
      * @return {Logger} Logger instance tailored to the supplied context.
      */
-    for(config: Partial<LoggingConfig>): Logger;
+    for(config: Partial<LoggingConfig>): this;
     for(context: string | {
         new (...args: any[]): any;
-    } | AnyFunction | object): Logger;
+    } | AnyFunction | object): this;
     for(method: string | {
         new (...args: any[]): any;
-    } | AnyFunction | object | Partial<LoggingConfig>, config?: Partial<LoggingConfig>, ...args: any[]): Logger;
+    } | 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.
@@ -145,10 +149,15 @@ export interface Logger extends Impersonatable<Logger, [
      * @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 Interface for filters that mutate or reject log messages.
- * @summary Allows custom pre-processing of log entries before they are formatted or emitted.
+ * @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
  */
@@ -164,25 +173,29 @@ export interface LoggingFilter {
     filter(config: LoggingConfig, message: string, context: string[]): string;
 }
 /**
- * @description Configuration for logging.
- * @summary Defines the log level and verbosity for logging.
- * @typedef {Object} LoggingConfig
+ * @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 log level in output.
+ * @property {boolean} [logLevel] - Whether to display the log level in the output.
  * @property {number} verbose - The verbosity level.
- * @property {LoggingMode} [mode] - Output format mode.
- * @property {string} contextSeparator - Separator between context entries.
- * @property {string} separator - Separator between log components.
- * @property {boolean} [style] - Whether to apply styling to log output.
+ * @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] - Format for timestamps.
+ * @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 {string|number} [correlationId] - Correlation ID for tracking related 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 = {
-    app?: string;
+export type LoggingConfig<TRANSPORT = object> = {
     env: "development" | "production" | "test" | "staging" | string;
     level: LogLevel;
     logLevel?: boolean;
@@ -198,23 +211,19 @@ export type LoggingConfig = {
     pattern: string;
     correlationId?: string | number;
     filters?: string[] | LoggingFilter[];
-    pino?: {
-        instance?: unknown;
-        options?: unknown;
-        destination?: unknown;
-    };
+    transports?: TRANSPORT[];
 };
 /**
- * @description Factory signature for creating logger instances.
- * @summary Allows consumers to override logger construction with custom implementations.
- * @template L - The logger type, extending the base Logger interface
- * @typedef {function(string, Partial<LoggingConfig>, any[]): L} LoggerFactory
+ * @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;
+export type LoggerFactory<L extends Logger = Logger> = (object?: string, config?: Partial<LoggingConfig>, ...args: any[]) => L;
 /**
- * @description Theme option applied to a specific log element.
- * @summary Configures foreground and background colors as well as additional style directives for styled console output.
+ * @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
  */
@@ -224,15 +233,15 @@ export interface ThemeOption {
     style?: number[] | [keyof typeof styles];
 }
 /**
- * @description Mapping between log levels and theme overrides.
- * @summary Enables level-specific styling by associating each {@link LogLevel} with a {@link ThemeOption} configuration.
- * @typedef {Object} ThemeOptionByLogLevel
+ * @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 Theme definition applied to console output.
- * @summary Specifies styling for each console log element and supports overrides based on {@link LogLevel} values.
+ * @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
  */

package/lib/esm/utils.d.ts

@@ -1,5 +1,48 @@
+/**
+ * @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/esm/utils.js

@@ -1,3 +1,11 @@
+/**
+ * @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 function isClass(value) {
     if (typeof value !== "function")
         return false;
@@ -27,15 +35,42 @@ export function isClass(value) {
     const names = Object.getOwnPropertyNames(proto).filter((n) => n !== "constructor");
     return names.length > 0;
 }
+/**
+ * @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 function isFunction(value) {
     return typeof value === "function" && !isClass(value);
 }
+/**
+ * @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 function isMethod(value) {
     if (!isFunction(value))
         return false;
     const descriptor = Object.getOwnPropertyDescriptor(value, "prototype");
     return !descriptor || descriptor.value === undefined;
 }
+/**
+ * @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 function isInstance(value) {
     if (value === null || typeof value !== "object")
         return false;
@@ -45,6 +80,14 @@ export function isInstance(value) {
         return false;
     return isClass(ctor);
 }
+/**
+ * @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 function getObjectName(value) {
     if (value === null)
         return "null";
@@ -56,6 +99,18 @@ export function getObjectName(value) {
         return value.name || "AnonymousClass";
     }
     if (isInstance(value)) {
+        const toStringFn = value.toString;
+        if (typeof toStringFn === "function" &&
+            toStringFn !== Object.prototype.toString) {
+            try {
+                const rendered = toStringFn.call(value);
+                if (typeof rendered === "string" && rendered.length)
+                    return rendered;
+            }
+            catch {
+                // ignore custom toString errors and fall back to constructor name.
+            }
+        }
         // eslint-disable-next-line @typescript-eslint/no-unsafe-function-type
         const ctor = value.constructor;
         return ctor && ctor.name ? ctor.name : "AnonymousInstance";
@@ -65,9 +120,6 @@ export function getObjectName(value) {
         const fn = value;
         if (fn.name)
             return fn.name;
-        const src = Function.prototype.toString.call(fn).trim();
-        if (src)
-            return src.split("\n")[0];
         return "anonymous";
     }
     if (typeof value === "object") {

package/lib/esm/utils.js.map

@@ -1 +1 @@
-{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../src/utils.ts"],"names":[],"mappings":"AAAA,MAAM,UAAU,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,MAAM,UAAU,UAAU,CACxB,KAAc;IAEd,OAAO,OAAO,KAAK,KAAK,UAAU,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;AACxD,CAAC;AAED,MAAM,UAAU,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,MAAM,UAAU,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,MAAM,UAAU,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,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;QAE5B,MAAM,GAAG,GAAG,QAAQ,CAAC,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC;QACxD,IAAI,GAAG;YAAE,OAAO,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;QACnC,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"}
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../src/utils.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AACH,MAAM,UAAU,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,MAAM,UAAU,UAAU,CACxB,KAAc;IAEd,OAAO,OAAO,KAAK,KAAK,UAAU,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;AACxD,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,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,MAAM,UAAU,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,MAAM,UAAU,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/esm/web.d.ts

@@ -1,7 +1,7 @@
 /**
  * @description Determines if the current environment is a browser by checking the prototype chain of the global object.
- * @summary Checks if the code is running in a browser environment.
- * @return {boolean} True if the environment is a browser, false otherwise.
+ * @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
  */

package/lib/esm/web.js

@@ -1,7 +1,7 @@
 /**
  * @description Determines if the current environment is a browser by checking the prototype chain of the global object.
- * @summary Checks if the code is running in a browser environment.
- * @return {boolean} True if the environment is a browser, false otherwise.
+ * @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
  */

package/lib/esm/winston/index.d.ts

@@ -0,0 +1,7 @@
+/**
+ * @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/esm/winston/index.js

@@ -1,2 +1,8 @@
-"use strict";
+/**
+ * @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.js";
 //# sourceMappingURL=index.js.map

package/lib/esm/winston/index.js.map

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

package/lib/esm/winston/winston.d.ts

@@ -1,15 +1,12 @@
 import winston from "winston";
-import Transport from "winston-transport";
 import { Logger, LoggerFactory, LoggingConfig, StringLike } from "../types";
 import { MiniLogger } from "../logging";
 import { LogLevel } from "../constants";
 /**
- * @description A logger implementation using Winston
- * @summary WinstonLogger extends MiniLogger to provide logging functionality using the Winston library.
- * It configures Winston with appropriate transports and formats based on the logging configuration.
- * @param {string} cont - The context (typically class name) this logger is associated with
- * @param {Partial<LoggingConfig>} [conf] - Optional configuration to override global settings
- * @param {Transport[]|Transport} [transports] - Winston transports to use for logging
+ * @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
@@ -24,28 +21,27 @@ import { LogLevel } from "../constants";
  * methodLogger.debug('Processing data...');
  */
 export declare class WinstonLogger extends MiniLogger implements Logger {
-    protected transports?: (Transport[] | Transport) | undefined;
     protected winston: winston.Logger;
-    constructor(cont: string, conf?: Partial<LoggingConfig>, transports?: (Transport[] | Transport) | undefined);
+    constructor(cont?: string, conf?: Partial<LoggingConfig>);
+    private resolveTransports;
     /**
-     * @description Logs a message with the specified log level using Winston
-     * @summary 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] - Optional stack trace to include in the log
+     * @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): void;
 }
 /**
- * @description Factory function for creating Winston loggers
- * @summary A LoggerFactory implementation that creates WinstonLogger instances
+ * @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
- * @type {LoggerFactory}
- * @param {string} context - The context (typically 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
  * @memberOf module:Logging
  */
 export declare const WinstonFactory: LoggerFactory;

package/lib/esm/winston/winston.js

@@ -1,12 +1,10 @@
 import winston from "winston";
 import { Logging, MiniLogger } from "./../logging.js";
 /**
- * @description A logger implementation using Winston
- * @summary WinstonLogger extends MiniLogger to provide logging functionality using the Winston library.
- * It configures Winston with appropriate transports and formats based on the logging configuration.
- * @param {string} cont - The context (typically class name) this logger is associated with
- * @param {Partial<LoggingConfig>} [conf] - Optional configuration to override global settings
- * @param {Transport[]|Transport} [transports] - Winston transports to use for logging
+ * @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
@@ -21,35 +19,29 @@ import { Logging, MiniLogger } from "./../logging.js";
  * methodLogger.debug('Processing data...');
  */
 export class WinstonLogger extends MiniLogger {
-    constructor(cont, conf, transports) {
+    constructor(cont, conf) {
         super(cont, conf);
-        this.transports = transports;
         const config = Object.assign({}, Logging.getConfig(), this.conf || {});
-        const { level, context, style, timestamp, timestampFormat } = config;
-        const formats = [winston.format.splat(), winston.format.simple()];
-        if (timestamp)
-            formats.unshift(winston.format.timestamp({ format: timestampFormat }));
-        if (style)
-            formats.unshift(winston.format.colorize());
-        this.transports = this.transports || [
-            new winston.transports.Console({
-                format: winston.format.combine(...formats),
-            }),
-        ];
+        const transports = this.resolveTransports(config.transports || undefined);
+        const passThrough = winston.format.printf(({ message }) => typeof message === "string" ? message : JSON.stringify(message));
         const winstonConfig = {
-            level: level,
-            defaultMeta: context,
-            format: winston.format.json(),
-            transports: transports,
+            level: config.level,
+            transports,
+            format: passThrough,
         };
         this.winston = winston.createLogger(winstonConfig);
     }
+    resolveTransports(transports) {
+        if (transports && transports.length)
+            return transports;
+        return [new winston.transports.Console()];
+    }
     /**
-     * @description Logs a message with the specified log level using Winston
-     * @summary 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] - Optional stack trace to include in the log
+     * @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}
      */
     log(level, msg, error) {
@@ -63,15 +55,16 @@ export class WinstonLogger extends MiniLogger {
     }
 }
 /**
- * @description Factory function for creating Winston loggers
- * @summary A LoggerFactory implementation that creates WinstonLogger instances
+ * @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
- * @type {LoggerFactory}
- * @param {string} context - The context (typically 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
  * @memberOf module:Logging
  */
-export const WinstonFactory = (context, conf, ...args) => new WinstonLogger(context, conf, ...args);
+export const WinstonFactory = (context, conf, 
+// eslint-disable-next-line @typescript-eslint/no-unused-vars
+..._args) => new WinstonLogger(context, conf);
 //# sourceMappingURL=winston.js.map

package/lib/esm/winston/winston.js.map

@@ -1 +1 @@
-{"version":3,"file":"winston.js","sourceRoot":"","sources":["../../../src/winston/winston.ts"],"names":[],"mappings":"AAAA,OAAO,OAAoC,MAAM,SAAS,CAAC;AAG3D,OAAO,EAAE,OAAO,EAAE,UAAU,EAAE,wBAAmB;AAGjD;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,OAAO,aAAc,SAAQ,UAAU;IAG3C,YACE,IAAY,EACZ,IAA6B,EACnB,UAAoC;QAE9C,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;QAFR,eAAU,GAAV,UAAU,CAA0B;QAG9C,MAAM,MAAM,GAAkB,MAAM,CAAC,MAAM,CACzC,EAAE,EACF,OAAO,CAAC,SAAS,EAAE,EACnB,IAAI,CAAC,IAAI,IAAI,EAAE,CAChB,CAAC;QACF,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,KAAK,EAAE,SAAS,EAAE,eAAe,EAAE,GAAG,MAAM,CAAC;QAErE,MAAM,OAAO,GAAG,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,EAAE,EAAE,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC;QAClE,IAAI,SAAS;YACX,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,SAAS,CAAC,EAAE,MAAM,EAAE,eAAe,EAAE,CAAC,CAAC,CAAC;QACzE,IAAI,KAAK;YAAE,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC,CAAC;QAEtD,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,UAAU,IAAI;YACnC,IAAI,OAAO,CAAC,UAAU,CAAC,OAAO,CAAC;gBAC7B,MAAM,EAAE,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC,GAAG,OAAO,CAAC;aAC3C,CAAC;SACH,CAAC;QAEF,MAAM,aAAa,GAAkB;YACnC,KAAK,EAAE,KAAK;YACZ,WAAW,EAAE,OAAO;YACpB,MAAM,EAAE,OAAO,CAAC,MAAM,CAAC,IAAI,EAAE;YAC7B,UAAU,EAAE,UAAU;SACvB,CAAC;QACF,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC,YAAY,CAAC,aAAa,CAAC,CAAC;IACrD,CAAC;IAED;;;;;;;OAOG;IACgB,GAAG,CACpB,KAAe,EACf,GAAuB,EACvB,KAAa;QAEb,MAAM,OAAO,GAAa;YACxB,KAAK,EAAE,KAAK;YACZ,OAAO,EAAE,IAAI,CAAC,SAAS,CAAC,KAAK,EAAE,GAAG,EAAE,KAAK,CAAC;SAC3C,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;AAED;;;;;;;;;;GAUG;AACH,MAAM,CAAC,MAAM,cAAc,GAAkB,CAC3C,OAAe,EACf,IAA6B,EAC7B,GAAG,IAAW,EACd,EAAE,CAAC,IAAI,aAAa,CAAC,OAAO,EAAE,IAAI,EAAE,GAAG,IAAI,CAAC,CAAC"}
+{"version":3,"file":"winston.js","sourceRoot":"","sources":["../../../src/winston/winston.ts"],"names":[],"mappings":"AAAA,OAAO,OAAoC,MAAM,SAAS,CAAC;AAG3D,OAAO,EAAE,OAAO,EAAE,UAAU,EAAE,wBAAmB;AAGjD;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,OAAO,aAAc,SAAQ,UAAU;IAG3C,YAAY,IAAa,EAAE,IAA6B;QACtD,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;QAClB,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,CAC1B,EAAE,EACF,OAAO,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,OAAO,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,OAAO,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,OAAO,CAAC,UAAU,CAAC,OAAO,EAAE,CAAC,CAAC;IAC5C,CAAC;IAED;;;;;;;OAOG;IACgB,GAAG,CACpB,KAAe,EACf,GAAuB,EACvB,KAAa;QAEb,MAAM,OAAO,GAAa;YACxB,KAAK,EAAE,KAAK;YACZ,OAAO,EAAE,IAAI,CAAC,SAAS,CAAC,KAAK,EAAE,GAAG,EAAE,KAAK,CAAC;SAC3C,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;AAED;;;;;;;;;GASG;AACH,MAAM,CAAC,MAAM,cAAc,GAAkB,CAC3C,OAAgB,EAChB,IAA6B;AAC7B,6DAA6D;AAC7D,GAAG,KAAY,EACA,EAAE,CAAC,IAAI,aAAa,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC"}

package/lib/filters/LogFilter.cjs

@@ -3,8 +3,8 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.LogFilter = void 0;
 const LoggedClass_1 = require("./../LoggedClass.cjs");
 /**
- * @description Base class for message filters that plug into the logging pipeline.
- * @summary Extends {@link LoggedClass} to supply a scoped logger and defines the contract required by {@link LoggingFilter} implementers that transform or drop log messages before emission.
+ * @description A base class for message filters that can be plugged into the logging pipeline.
+ * @summary This class extends {@link LoggedClass} to supply a scoped logger, and defines the contract that is required by {@link LoggingFilter} implementers that transform or drop log messages before emission.
  * @class LogFilter
  * @example
  * class RedactSecretsFilter extends LogFilter {
@@ -28,9 +28,9 @@ const LoggedClass_1 = require("./../LoggedClass.cjs");
  */
 class LogFilter extends LoggedClass_1.LoggedClass {
     /**
-     * @description Scoped logger that excludes other filters from the chain.
-     * @summary Returns a child logger dedicated to the filter, preventing recursive filter invocation when emitting diagnostic messages.
-     * @return {Logger} Context-aware logger for the filter instance.
+     * @description A scoped logger that excludes other filters from the chain.
+     * @summary This method returns a child logger that is dedicated to the filter, which prevents recursive filter invocation when emitting diagnostic messages.
+     * @return {Logger} A context-aware logger for the filter instance.
      */
     get log() {
         return super.log.for(this, { filters: [] });