@xylabs/logger 5.0.83 → 5.0.84

package/README.md

@@ -56,8 +56,7 @@ XYLabs Logger Library
 
 ***
 
-Interface to handle overlap between Winston &
-`console` with as much congruency as possible.
+A LevelLogger that delegates to the global `console` object.
 
 ## Extends
 
@@ -223,8 +222,8 @@ get warn(): LogFunction;
 
 ***
 
-Interface to handle overlap between Winston &
-`console` with as much congruency as possible.
+A logger wrapper that prefixes every log message with a bracketed identifier.
+Useful for distinguishing log output from different components or instances.
 
 ## Implements
 
@@ -422,8 +421,8 @@ Logger.warn
 
 ***
 
-Interface to handle overlap between Winston &
-`console` with as much congruency as possible.
+A logger that filters messages based on a configured log level.
+Methods for levels above the configured threshold return a no-op function.
 
 ## Extended by
 
@@ -615,6 +614,8 @@ new SilentLogger(): SilentLogger;
 readonly debug: (..._data) => undefined = NoOpLogFunction;
 ```
 
+A log function that silently discards all arguments.
+
 ### Parameters
 
 #### \_data
@@ -637,6 +638,8 @@ readonly debug: (..._data) => undefined = NoOpLogFunction;
 readonly error: (..._data) => undefined = NoOpLogFunction;
 ```
 
+A log function that silently discards all arguments.
+
 ### Parameters
 
 #### \_data
@@ -659,6 +662,8 @@ readonly error: (..._data) => undefined = NoOpLogFunction;
 readonly info: (..._data) => undefined = NoOpLogFunction;
 ```
 
+A log function that silently discards all arguments.
+
 ### Parameters
 
 #### \_data
@@ -681,6 +686,8 @@ readonly info: (..._data) => undefined = NoOpLogFunction;
 readonly log: (..._data) => undefined = NoOpLogFunction;
 ```
 
+A log function that silently discards all arguments.
+
 ### Parameters
 
 #### \_data
@@ -703,6 +710,8 @@ readonly log: (..._data) => undefined = NoOpLogFunction;
 readonly trace: (..._data) => undefined = NoOpLogFunction;
 ```
 
+A log function that silently discards all arguments.
+
 ### Parameters
 
 #### \_data
@@ -725,6 +734,8 @@ readonly trace: (..._data) => undefined = NoOpLogFunction;
 readonly warn: (..._data) => undefined = NoOpLogFunction;
 ```
 
+A log function that silently discards all arguments.
+
 ### Parameters
 
 #### \_data
@@ -751,6 +762,8 @@ readonly warn: (..._data) => undefined = NoOpLogFunction;
 function NoOpLogFunction(..._data): undefined;
 ```
 
+A log function that silently discards all arguments.
+
 ## Parameters
 
 ### \_data
@@ -771,16 +784,22 @@ function NoOpLogFunction(..._data): undefined;
 function getFunctionName(depth?): string;
 ```
 
+Retrieves the name of the calling function by inspecting the stack trace.
+
 ## Parameters
 
 ### depth?
 
 `number` = `2`
 
+The stack frame depth to inspect (default: 2, the caller's caller).
+
 ## Returns
 
 `string`
 
+The function name, or '<unknown>' if it cannot be determined.
+
 ### interfaces
 
   ### <a id="Logger"></a>Logger
@@ -852,6 +871,8 @@ warn: LogFunction;
 type LogFunction = (...data) => void;
 ```
 
+A generic logging function that accepts any number of arguments.
+
 ## Parameters
 
 ### data
@@ -872,6 +893,8 @@ type LogFunction = (...data) => void;
 type LogLevelKey = EnumKey<typeof LogLevel>;
 ```
 
+String key for a log level (e.g. 'error', 'warn', 'info').
+
   ### <a id="LogLevelValue"></a>LogLevelValue
 
 [**@xylabs/logger**](#../README)
@@ -882,6 +905,8 @@ type LogLevelKey = EnumKey<typeof LogLevel>;
 type LogLevelValue = EnumValue<typeof LogLevel>;
 ```
 
+Numeric value of a log level (1 through 6).
+
   ### <a id="LogVerbosity"></a>LogVerbosity
 
 [**@xylabs/logger**](#../README)
@@ -892,6 +917,8 @@ type LogLevelValue = EnumValue<typeof LogLevel>;
 type LogVerbosity = LogLevelKey;
 ```
 
+Alias for LogLevelKey, representing the verbosity setting as a string.
+
 ### variables
 
   ### <a id="LogLevel"></a>LogLevel
@@ -911,6 +938,8 @@ const LogLevel: Enum<{
 }>;
 ```
 
+Numeric log level values, from least verbose (error=1) to most verbose (trace=6).
+
 
 Part of [sdk-js](https://www.npmjs.com/package/@xyo-network/sdk-js)
 

package/dist/neutral/ConsoleLogger.d.ts

@@ -1,5 +1,6 @@
 import type { LogLevelValue } from './LevelLogger.ts';
 import { LevelLogger } from './LevelLogger.ts';
+/** A LevelLogger that delegates to the global `console` object. */
 export declare class ConsoleLogger extends LevelLogger {
     constructor(level?: LogLevelValue);
 }

package/dist/neutral/ConsoleLogger.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ConsoleLogger.d.ts","sourceRoot":"","sources":["../../src/ConsoleLogger.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAA;AACrD,OAAO,EAAE,WAAW,EAAY,MAAM,kBAAkB,CAAA;AAExD,qBAAa,aAAc,SAAQ,WAAW;gBAChC,KAAK,GAAE,aAA6B;CAGjD"}
+{"version":3,"file":"ConsoleLogger.d.ts","sourceRoot":"","sources":["../../src/ConsoleLogger.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAA;AACrD,OAAO,EAAE,WAAW,EAAY,MAAM,kBAAkB,CAAA;AAExD,mEAAmE;AACnE,qBAAa,aAAc,SAAQ,WAAW;gBAChC,KAAK,GAAE,aAA6B;CAGjD"}

package/dist/neutral/IdLogger.d.ts

@@ -1,4 +1,8 @@
 import type { Logger } from './LevelLogger.ts';
+/**
+ * A logger wrapper that prefixes every log message with a bracketed identifier.
+ * Useful for distinguishing log output from different components or instances.
+ */
 export declare class IdLogger implements Logger {
     private _id?;
     private _logger;

package/dist/neutral/IdLogger.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"IdLogger.d.ts","sourceRoot":"","sources":["../../src/IdLogger.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,kBAAkB,CAAA;AAE9C,qBAAa,QAAS,YAAW,MAAM;IACrC,OAAO,CAAC,GAAG,CAAC,CAAc;IAC1B,OAAO,CAAC,OAAO,CAAQ;gBAEX,MAAM,EAAE,MAAM,EAAE,EAAE,CAAC,EAAE,MAAM,MAAM;IAK7C,IAAI,EAAE,CAAC,EAAE,EAAE,MAAM,EAEhB;IAED,KAAK,CAAC,GAAG,IAAI,EAAE,OAAO,EAAE;IAIxB,KAAK,CAAC,GAAG,IAAI,EAAE,OAAO,EAAE;IAIxB,IAAI,CAAC,GAAG,IAAI,EAAE,OAAO,EAAE;IAIvB,GAAG,CAAC,GAAG,IAAI,EAAE,OAAO,EAAE;IAItB,KAAK,CAAC,GAAG,IAAI,EAAE,OAAO,EAAE;IAIxB,IAAI,CAAC,GAAG,IAAI,EAAE,OAAO,EAAE;IAIvB,OAAO,CAAC,MAAM;CAGf"}
+{"version":3,"file":"IdLogger.d.ts","sourceRoot":"","sources":["../../src/IdLogger.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,kBAAkB,CAAA;AAE9C;;;GAGG;AACH,qBAAa,QAAS,YAAW,MAAM;IACrC,OAAO,CAAC,GAAG,CAAC,CAAc;IAC1B,OAAO,CAAC,OAAO,CAAQ;gBAEX,MAAM,EAAE,MAAM,EAAE,EAAE,CAAC,EAAE,MAAM,MAAM;IAK7C,IAAI,EAAE,CAAC,EAAE,EAAE,MAAM,EAEhB;IAED,KAAK,CAAC,GAAG,IAAI,EAAE,OAAO,EAAE;IAIxB,KAAK,CAAC,GAAG,IAAI,EAAE,OAAO,EAAE;IAIxB,IAAI,CAAC,GAAG,IAAI,EAAE,OAAO,EAAE;IAIvB,GAAG,CAAC,GAAG,IAAI,EAAE,OAAO,EAAE;IAItB,KAAK,CAAC,GAAG,IAAI,EAAE,OAAO,EAAE;IAIxB,IAAI,CAAC,GAAG,IAAI,EAAE,OAAO,EAAE;IAIvB,OAAO,CAAC,MAAM;CAGf"}

package/dist/neutral/LevelLogger.d.ts

@@ -1,5 +1,6 @@
 import type { EnumKey, EnumValue } from '@xylabs/enum';
 import { Enum } from '@xylabs/enum';
+/** A generic logging function that accepts any number of arguments. */
 export type LogFunction = (...data: unknown[]) => void;
 /**
  * Interface to handle overlap between Winston &
@@ -13,6 +14,7 @@ export interface Logger {
     trace: LogFunction;
     warn: LogFunction;
 }
+/** Numeric log level values, from least verbose (error=1) to most verbose (trace=6). */
 export declare const LogLevel: Enum<{
     error: 1;
     warn: 2;
@@ -21,9 +23,16 @@ export declare const LogLevel: Enum<{
     debug: 5;
     trace: 6;
 }>;
+/** String key for a log level (e.g. 'error', 'warn', 'info'). */
 export type LogLevelKey = EnumKey<typeof LogLevel>;
+/** Alias for LogLevelKey, representing the verbosity setting as a string. */
 export type LogVerbosity = LogLevelKey;
+/** Numeric value of a log level (1 through 6). */
 export type LogLevelValue = EnumValue<typeof LogLevel>;
+/**
+ * A logger that filters messages based on a configured log level.
+ * Methods for levels above the configured threshold return a no-op function.
+ */
 export declare class LevelLogger implements Logger {
     readonly level: LogLevelValue;
     readonly logger: Logger;

package/dist/neutral/LevelLogger.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"LevelLogger.d.ts","sourceRoot":"","sources":["../../src/LevelLogger.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAA;AACtD,OAAO,EAAE,IAAI,EAAE,MAAM,cAAc,CAAA;AAInC,MAAM,MAAM,WAAW,GAAG,CAAC,GAAG,IAAI,EAAE,OAAO,EAAE,KAAK,IAAI,CAAA;AAEtD;;;GAGG;AACH,MAAM,WAAW,MAAM;IACrB,KAAK,EAAE,WAAW,CAAA;IAClB,KAAK,EAAE,WAAW,CAAA;IAClB,IAAI,EAAE,WAAW,CAAA;IACjB,GAAG,EAAE,WAAW,CAAA;IAChB,KAAK,EAAE,WAAW,CAAA;IAClB,IAAI,EAAE,WAAW,CAAA;CAClB;AAED,eAAO,MAAM,QAAQ;;;;;;;EAOnB,CAAA;AAEF,MAAM,MAAM,WAAW,GAAG,OAAO,CAAC,OAAO,QAAQ,CAAC,CAAA;AAClD,MAAM,MAAM,YAAY,GAAG,WAAW,CAAA;AAEtC,MAAM,MAAM,aAAa,GAAG,SAAS,CAAC,OAAO,QAAQ,CAAC,CAAA;AAEtD,qBAAa,WAAY,YAAW,MAAM;IACxC,QAAQ,CAAC,KAAK,EAAE,aAAa,CAAA;IAC7B,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAA;gBACX,MAAM,EAAE,MAAM,EAAE,KAAK,GAAE,aAA6B;IAKhE,IAAI,KAAK,gBAER;IAED,IAAI,KAAK,gBAER;IAED,IAAI,IAAI,gBAEP;IAED,IAAI,GAAG,gBAEN;IAED,IAAI,KAAK,gBAER;IAED,IAAI,IAAI,gBAEP;CACF"}
+{"version":3,"file":"LevelLogger.d.ts","sourceRoot":"","sources":["../../src/LevelLogger.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAA;AACtD,OAAO,EAAE,IAAI,EAAE,MAAM,cAAc,CAAA;AAInC,uEAAuE;AACvE,MAAM,MAAM,WAAW,GAAG,CAAC,GAAG,IAAI,EAAE,OAAO,EAAE,KAAK,IAAI,CAAA;AAEtD;;;GAGG;AACH,MAAM,WAAW,MAAM;IACrB,KAAK,EAAE,WAAW,CAAA;IAClB,KAAK,EAAE,WAAW,CAAA;IAClB,IAAI,EAAE,WAAW,CAAA;IACjB,GAAG,EAAE,WAAW,CAAA;IAChB,KAAK,EAAE,WAAW,CAAA;IAClB,IAAI,EAAE,WAAW,CAAA;CAClB;AAED,wFAAwF;AACxF,eAAO,MAAM,QAAQ;;;;;;;EAOnB,CAAA;AAEF,iEAAiE;AACjE,MAAM,MAAM,WAAW,GAAG,OAAO,CAAC,OAAO,QAAQ,CAAC,CAAA;AAElD,6EAA6E;AAC7E,MAAM,MAAM,YAAY,GAAG,WAAW,CAAA;AAEtC,kDAAkD;AAClD,MAAM,MAAM,aAAa,GAAG,SAAS,CAAC,OAAO,QAAQ,CAAC,CAAA;AAEtD;;;GAGG;AACH,qBAAa,WAAY,YAAW,MAAM;IACxC,QAAQ,CAAC,KAAK,EAAE,aAAa,CAAA;IAC7B,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAA;gBACX,MAAM,EAAE,MAAM,EAAE,KAAK,GAAE,aAA6B;IAKhE,IAAI,KAAK,gBAER;IAED,IAAI,KAAK,gBAER;IAED,IAAI,IAAI,gBAEP;IAED,IAAI,GAAG,gBAEN;IAED,IAAI,KAAK,gBAER;IAED,IAAI,IAAI,gBAEP;CACF"}

package/dist/neutral/NoOpLogFunction.d.ts

@@ -1,2 +1,3 @@
+/** A log function that silently discards all arguments. */
 export declare const NoOpLogFunction: (..._data: unknown[]) => undefined;
 //# sourceMappingURL=NoOpLogFunction.d.ts.map

package/dist/neutral/NoOpLogFunction.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"NoOpLogFunction.d.ts","sourceRoot":"","sources":["../../src/NoOpLogFunction.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,eAAe,GAAI,GAAG,OAAO,OAAO,EAAE,cAAY,CAAA"}
+{"version":3,"file":"NoOpLogFunction.d.ts","sourceRoot":"","sources":["../../src/NoOpLogFunction.ts"],"names":[],"mappings":"AAAA,2DAA2D;AAC3D,eAAO,MAAM,eAAe,GAAI,GAAG,OAAO,OAAO,EAAE,cAAY,CAAA"}

package/dist/neutral/getFunctionName.d.ts

@@ -1,2 +1,7 @@
+/**
+ * Retrieves the name of the calling function by inspecting the stack trace.
+ * @param depth - The stack frame depth to inspect (default: 2, the caller's caller).
+ * @returns The function name, or '<unknown>' if it cannot be determined.
+ */
 export declare const getFunctionName: (depth?: number) => string;
 //# sourceMappingURL=getFunctionName.d.ts.map

package/dist/neutral/getFunctionName.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"getFunctionName.d.ts","sourceRoot":"","sources":["../../src/getFunctionName.ts"],"names":[],"mappings":"AAGA,eAAO,MAAM,eAAe,GAAI,cAAS,WAoBxC,CAAA"}
+{"version":3,"file":"getFunctionName.d.ts","sourceRoot":"","sources":["../../src/getFunctionName.ts"],"names":[],"mappings":"AAGA;;;;GAIG;AACH,eAAO,MAAM,eAAe,GAAI,cAAS,WAoBxC,CAAA"}

package/dist/neutral/index.mjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/LevelLogger.ts","../../src/NoOpLogFunction.ts","../../src/ConsoleLogger.ts","../../src/getFunctionName.ts","../../src/IdLogger.ts","../../src/SilentLogger.ts"],"sourcesContent":["import type { EnumKey, EnumValue } from '@xylabs/enum'\nimport { Enum } from '@xylabs/enum'\n\nimport { NoOpLogFunction } from './NoOpLogFunction.ts'\n\nexport type LogFunction = (...data: unknown[]) => void\n\n/**\n * Interface to handle overlap between Winston &\n * `console` with as much congruency as possible.\n */\nexport interface Logger {\n  debug: LogFunction\n  error: LogFunction\n  info: LogFunction\n  log: LogFunction\n  trace: LogFunction\n  warn: LogFunction\n}\n\nexport const LogLevel = Enum({\n  error: 1,\n  warn: 2,\n  info: 3,\n  log: 4,\n  debug: 5,\n  trace: 6,\n})\n\nexport type LogLevelKey = EnumKey<typeof LogLevel>\nexport type LogVerbosity = LogLevelKey\n\nexport type LogLevelValue = EnumValue<typeof LogLevel>\n\nexport class LevelLogger implements Logger {\n  readonly level: LogLevelValue\n  readonly logger: Logger\n  constructor(logger: Logger, level: LogLevelValue = LogLevel.warn) {\n    this.level = level\n    this.logger = logger\n  }\n\n  get debug() {\n    return this.level >= LogLevel.debug ? this.logger.debug : NoOpLogFunction\n  }\n\n  get error() {\n    return this.level >= LogLevel.error ? this.logger.error : NoOpLogFunction\n  }\n\n  get info() {\n    return this.level >= LogLevel.info ? this.logger.info : NoOpLogFunction\n  }\n\n  get log() {\n    return this.level >= LogLevel.log ? this.logger.log : NoOpLogFunction\n  }\n\n  get trace() {\n    return this.level >= LogLevel.trace ? this.logger.trace : NoOpLogFunction\n  }\n\n  get warn() {\n    return this.level >= LogLevel.warn ? this.logger.warn : NoOpLogFunction\n  }\n}\n","export const NoOpLogFunction = (..._data: unknown[]) => void {}\n","import type { LogLevelValue } from './LevelLogger.ts'\nimport { LevelLogger, LogLevel } from './LevelLogger.ts'\n\nexport class ConsoleLogger extends LevelLogger {\n  constructor(level: LogLevelValue = LogLevel.warn) {\n    super(console, level)\n  }\n}\n","import { handleError } from '@xylabs/error'\nimport { isNumber } from '@xylabs/typeof'\n\nexport const getFunctionName = (depth = 2) => {\n  try {\n    throw new Error('Getting function name')\n  } catch (ex) {\n    return handleError(ex, (error) => {\n      let newIndex: number | undefined\n      const stackParts = error.stack?.split('\\n')[depth]?.split(' ')\n      const funcName\n        = stackParts?.find((item, index) => {\n          if (item.length > 0 && item !== 'at') {\n            // check if constructor\n            if (item === 'new') {\n              newIndex = index\n            }\n            return true\n          }\n        }) ?? '<unknown>'\n      return isNumber(newIndex) ? `${funcName} ${stackParts?.[newIndex + 1]}` : funcName\n    })\n  }\n}\n","import type { Logger } from './LevelLogger.ts'\n\nexport class IdLogger implements Logger {\n  private _id?: () => string\n  private _logger: Logger\n\n  constructor(logger: Logger, id?: () => string) {\n    this._logger = logger\n    this._id = id\n  }\n\n  set id(id: string) {\n    this._id = () => id\n  }\n\n  debug(...data: unknown[]) {\n    this._logger?.debug(this.prefix(), ...data)\n  }\n\n  error(...data: unknown[]) {\n    this._logger?.error(this.prefix(), ...data)\n  }\n\n  info(...data: unknown[]) {\n    this._logger?.info(this.prefix(), ...data)\n  }\n\n  log(...data: unknown[]) {\n    this._logger?.log(this.prefix(), ...data)\n  }\n\n  trace(...data: unknown[]) {\n    this._logger?.trace(this.prefix(), ...data)\n  }\n\n  warn(...data: unknown[]) {\n    this._logger?.warn(this.prefix(), ...data)\n  }\n\n  private prefix() {\n    return `[${this._id?.()}]`\n  }\n}\n","import type { Logger } from './LevelLogger.ts'\nimport { NoOpLogFunction } from './NoOpLogFunction.ts'\n\n/**\n * A logger that does not log anything.\n * This is useful when you want to disable logging\n * like when running unit tests or in silent mode.\n * It implements the `Logger` interface but all methods\n * are no-op functions.\n */\nexport class SilentLogger implements Logger {\n  readonly debug = NoOpLogFunction\n  readonly error = NoOpLogFunction\n  readonly info = NoOpLogFunction\n  readonly log = NoOpLogFunction\n  readonly trace = NoOpLogFunction\n  readonly warn = NoOpLogFunction\n}\n"],"mappings":";AACA,SAAS,YAAY;;;ACDd,IAAM,kBAAkB,IAAI,UAAqB,KAAK,CAAC;;;ADoBvD,IAAM,WAAW,KAAK;AAAA,EAC3B,OAAO;AAAA,EACP,MAAM;AAAA,EACN,MAAM;AAAA,EACN,KAAK;AAAA,EACL,OAAO;AAAA,EACP,OAAO;AACT,CAAC;AAOM,IAAM,cAAN,MAAoC;AAAA,EAChC;AAAA,EACA;AAAA,EACT,YAAY,QAAgB,QAAuB,SAAS,MAAM;AAChE,SAAK,QAAQ;AACb,SAAK,SAAS;AAAA,EAChB;AAAA,EAEA,IAAI,QAAQ;AACV,WAAO,KAAK,SAAS,SAAS,QAAQ,KAAK,OAAO,QAAQ;AAAA,EAC5D;AAAA,EAEA,IAAI,QAAQ;AACV,WAAO,KAAK,SAAS,SAAS,QAAQ,KAAK,OAAO,QAAQ;AAAA,EAC5D;AAAA,EAEA,IAAI,OAAO;AACT,WAAO,KAAK,SAAS,SAAS,OAAO,KAAK,OAAO,OAAO;AAAA,EAC1D;AAAA,EAEA,IAAI,MAAM;AACR,WAAO,KAAK,SAAS,SAAS,MAAM,KAAK,OAAO,MAAM;AAAA,EACxD;AAAA,EAEA,IAAI,QAAQ;AACV,WAAO,KAAK,SAAS,SAAS,QAAQ,KAAK,OAAO,QAAQ;AAAA,EAC5D;AAAA,EAEA,IAAI,OAAO;AACT,WAAO,KAAK,SAAS,SAAS,OAAO,KAAK,OAAO,OAAO;AAAA,EAC1D;AACF;;;AE9DO,IAAM,gBAAN,cAA4B,YAAY;AAAA,EAC7C,YAAY,QAAuB,SAAS,MAAM;AAChD,UAAM,SAAS,KAAK;AAAA,EACtB;AACF;;;ACPA,SAAS,mBAAmB;AAC5B,SAAS,gBAAgB;AAElB,IAAM,kBAAkB,CAAC,QAAQ,MAAM;AAC5C,MAAI;AACF,UAAM,IAAI,MAAM,uBAAuB;AAAA,EACzC,SAAS,IAAI;AACX,WAAO,YAAY,IAAI,CAAC,UAAU;AAChC,UAAI;AACJ,YAAM,aAAa,MAAM,OAAO,MAAM,IAAI,EAAE,KAAK,GAAG,MAAM,GAAG;AAC7D,YAAM,WACF,YAAY,KAAK,CAAC,MAAM,UAAU;AAClC,YAAI,KAAK,SAAS,KAAK,SAAS,MAAM;AAEpC,cAAI,SAAS,OAAO;AAClB,uBAAW;AAAA,UACb;AACA,iBAAO;AAAA,QACT;AAAA,MACF,CAAC,KAAK;AACR,aAAO,SAAS,QAAQ,IAAI,GAAG,QAAQ,IAAI,aAAa,WAAW,CAAC,CAAC,KAAK;AAAA,IAC5E,CAAC;AAAA,EACH;AACF;;;ACrBO,IAAM,WAAN,MAAiC;AAAA,EAC9B;AAAA,EACA;AAAA,EAER,YAAY,QAAgB,IAAmB;AAC7C,SAAK,UAAU;AACf,SAAK,MAAM;AAAA,EACb;AAAA,EAEA,IAAI,GAAG,IAAY;AACjB,SAAK,MAAM,MAAM;AAAA,EACnB;AAAA,EAEA,SAAS,MAAiB;AACxB,SAAK,SAAS,MAAM,KAAK,OAAO,GAAG,GAAG,IAAI;AAAA,EAC5C;AAAA,EAEA,SAAS,MAAiB;AACxB,SAAK,SAAS,MAAM,KAAK,OAAO,GAAG,GAAG,IAAI;AAAA,EAC5C;AAAA,EAEA,QAAQ,MAAiB;AACvB,SAAK,SAAS,KAAK,KAAK,OAAO,GAAG,GAAG,IAAI;AAAA,EAC3C;AAAA,EAEA,OAAO,MAAiB;AACtB,SAAK,SAAS,IAAI,KAAK,OAAO,GAAG,GAAG,IAAI;AAAA,EAC1C;AAAA,EAEA,SAAS,MAAiB;AACxB,SAAK,SAAS,MAAM,KAAK,OAAO,GAAG,GAAG,IAAI;AAAA,EAC5C;AAAA,EAEA,QAAQ,MAAiB;AACvB,SAAK,SAAS,KAAK,KAAK,OAAO,GAAG,GAAG,IAAI;AAAA,EAC3C;AAAA,EAEQ,SAAS;AACf,WAAO,IAAI,KAAK,MAAM,CAAC;AAAA,EACzB;AACF;;;AChCO,IAAM,eAAN,MAAqC;AAAA,EACjC,QAAQ;AAAA,EACR,QAAQ;AAAA,EACR,OAAO;AAAA,EACP,MAAM;AAAA,EACN,QAAQ;AAAA,EACR,OAAO;AAClB;","names":[]}
+{"version":3,"sources":["../../src/LevelLogger.ts","../../src/NoOpLogFunction.ts","../../src/ConsoleLogger.ts","../../src/getFunctionName.ts","../../src/IdLogger.ts","../../src/SilentLogger.ts"],"sourcesContent":["import type { EnumKey, EnumValue } from '@xylabs/enum'\nimport { Enum } from '@xylabs/enum'\n\nimport { NoOpLogFunction } from './NoOpLogFunction.ts'\n\n/** A generic logging function that accepts any number of arguments. */\nexport type LogFunction = (...data: unknown[]) => void\n\n/**\n * Interface to handle overlap between Winston &\n * `console` with as much congruency as possible.\n */\nexport interface Logger {\n  debug: LogFunction\n  error: LogFunction\n  info: LogFunction\n  log: LogFunction\n  trace: LogFunction\n  warn: LogFunction\n}\n\n/** Numeric log level values, from least verbose (error=1) to most verbose (trace=6). */\nexport const LogLevel = Enum({\n  error: 1,\n  warn: 2,\n  info: 3,\n  log: 4,\n  debug: 5,\n  trace: 6,\n})\n\n/** String key for a log level (e.g. 'error', 'warn', 'info'). */\nexport type LogLevelKey = EnumKey<typeof LogLevel>\n\n/** Alias for LogLevelKey, representing the verbosity setting as a string. */\nexport type LogVerbosity = LogLevelKey\n\n/** Numeric value of a log level (1 through 6). */\nexport type LogLevelValue = EnumValue<typeof LogLevel>\n\n/**\n * A logger that filters messages based on a configured log level.\n * Methods for levels above the configured threshold return a no-op function.\n */\nexport class LevelLogger implements Logger {\n  readonly level: LogLevelValue\n  readonly logger: Logger\n  constructor(logger: Logger, level: LogLevelValue = LogLevel.warn) {\n    this.level = level\n    this.logger = logger\n  }\n\n  get debug() {\n    return this.level >= LogLevel.debug ? this.logger.debug : NoOpLogFunction\n  }\n\n  get error() {\n    return this.level >= LogLevel.error ? this.logger.error : NoOpLogFunction\n  }\n\n  get info() {\n    return this.level >= LogLevel.info ? this.logger.info : NoOpLogFunction\n  }\n\n  get log() {\n    return this.level >= LogLevel.log ? this.logger.log : NoOpLogFunction\n  }\n\n  get trace() {\n    return this.level >= LogLevel.trace ? this.logger.trace : NoOpLogFunction\n  }\n\n  get warn() {\n    return this.level >= LogLevel.warn ? this.logger.warn : NoOpLogFunction\n  }\n}\n","/** A log function that silently discards all arguments. */\nexport const NoOpLogFunction = (..._data: unknown[]) => void {}\n","import type { LogLevelValue } from './LevelLogger.ts'\nimport { LevelLogger, LogLevel } from './LevelLogger.ts'\n\n/** A LevelLogger that delegates to the global `console` object. */\nexport class ConsoleLogger extends LevelLogger {\n  constructor(level: LogLevelValue = LogLevel.warn) {\n    super(console, level)\n  }\n}\n","import { handleError } from '@xylabs/error'\nimport { isNumber } from '@xylabs/typeof'\n\n/**\n * Retrieves the name of the calling function by inspecting the stack trace.\n * @param depth - The stack frame depth to inspect (default: 2, the caller's caller).\n * @returns The function name, or '<unknown>' if it cannot be determined.\n */\nexport const getFunctionName = (depth = 2) => {\n  try {\n    throw new Error('Getting function name')\n  } catch (ex) {\n    return handleError(ex, (error) => {\n      let newIndex: number | undefined\n      const stackParts = error.stack?.split('\\n')[depth]?.split(' ')\n      const funcName\n        = stackParts?.find((item, index) => {\n          if (item.length > 0 && item !== 'at') {\n            // check if constructor\n            if (item === 'new') {\n              newIndex = index\n            }\n            return true\n          }\n        }) ?? '<unknown>'\n      return isNumber(newIndex) ? `${funcName} ${stackParts?.[newIndex + 1]}` : funcName\n    })\n  }\n}\n","import type { Logger } from './LevelLogger.ts'\n\n/**\n * A logger wrapper that prefixes every log message with a bracketed identifier.\n * Useful for distinguishing log output from different components or instances.\n */\nexport class IdLogger implements Logger {\n  private _id?: () => string\n  private _logger: Logger\n\n  constructor(logger: Logger, id?: () => string) {\n    this._logger = logger\n    this._id = id\n  }\n\n  set id(id: string) {\n    this._id = () => id\n  }\n\n  debug(...data: unknown[]) {\n    this._logger?.debug(this.prefix(), ...data)\n  }\n\n  error(...data: unknown[]) {\n    this._logger?.error(this.prefix(), ...data)\n  }\n\n  info(...data: unknown[]) {\n    this._logger?.info(this.prefix(), ...data)\n  }\n\n  log(...data: unknown[]) {\n    this._logger?.log(this.prefix(), ...data)\n  }\n\n  trace(...data: unknown[]) {\n    this._logger?.trace(this.prefix(), ...data)\n  }\n\n  warn(...data: unknown[]) {\n    this._logger?.warn(this.prefix(), ...data)\n  }\n\n  private prefix() {\n    return `[${this._id?.()}]`\n  }\n}\n","import type { Logger } from './LevelLogger.ts'\nimport { NoOpLogFunction } from './NoOpLogFunction.ts'\n\n/**\n * A logger that does not log anything.\n * This is useful when you want to disable logging\n * like when running unit tests or in silent mode.\n * It implements the `Logger` interface but all methods\n * are no-op functions.\n */\nexport class SilentLogger implements Logger {\n  readonly debug = NoOpLogFunction\n  readonly error = NoOpLogFunction\n  readonly info = NoOpLogFunction\n  readonly log = NoOpLogFunction\n  readonly trace = NoOpLogFunction\n  readonly warn = NoOpLogFunction\n}\n"],"mappings":";AACA,SAAS,YAAY;;;ACAd,IAAM,kBAAkB,IAAI,UAAqB,KAAK,CAAC;;;ADqBvD,IAAM,WAAW,KAAK;AAAA,EAC3B,OAAO;AAAA,EACP,MAAM;AAAA,EACN,MAAM;AAAA,EACN,KAAK;AAAA,EACL,OAAO;AAAA,EACP,OAAO;AACT,CAAC;AAeM,IAAM,cAAN,MAAoC;AAAA,EAChC;AAAA,EACA;AAAA,EACT,YAAY,QAAgB,QAAuB,SAAS,MAAM;AAChE,SAAK,QAAQ;AACb,SAAK,SAAS;AAAA,EAChB;AAAA,EAEA,IAAI,QAAQ;AACV,WAAO,KAAK,SAAS,SAAS,QAAQ,KAAK,OAAO,QAAQ;AAAA,EAC5D;AAAA,EAEA,IAAI,QAAQ;AACV,WAAO,KAAK,SAAS,SAAS,QAAQ,KAAK,OAAO,QAAQ;AAAA,EAC5D;AAAA,EAEA,IAAI,OAAO;AACT,WAAO,KAAK,SAAS,SAAS,OAAO,KAAK,OAAO,OAAO;AAAA,EAC1D;AAAA,EAEA,IAAI,MAAM;AACR,WAAO,KAAK,SAAS,SAAS,MAAM,KAAK,OAAO,MAAM;AAAA,EACxD;AAAA,EAEA,IAAI,QAAQ;AACV,WAAO,KAAK,SAAS,SAAS,QAAQ,KAAK,OAAO,QAAQ;AAAA,EAC5D;AAAA,EAEA,IAAI,OAAO;AACT,WAAO,KAAK,SAAS,SAAS,OAAO,KAAK,OAAO,OAAO;AAAA,EAC1D;AACF;;;AEvEO,IAAM,gBAAN,cAA4B,YAAY;AAAA,EAC7C,YAAY,QAAuB,SAAS,MAAM;AAChD,UAAM,SAAS,KAAK;AAAA,EACtB;AACF;;;ACRA,SAAS,mBAAmB;AAC5B,SAAS,gBAAgB;AAOlB,IAAM,kBAAkB,CAAC,QAAQ,MAAM;AAC5C,MAAI;AACF,UAAM,IAAI,MAAM,uBAAuB;AAAA,EACzC,SAAS,IAAI;AACX,WAAO,YAAY,IAAI,CAAC,UAAU;AAChC,UAAI;AACJ,YAAM,aAAa,MAAM,OAAO,MAAM,IAAI,EAAE,KAAK,GAAG,MAAM,GAAG;AAC7D,YAAM,WACF,YAAY,KAAK,CAAC,MAAM,UAAU;AAClC,YAAI,KAAK,SAAS,KAAK,SAAS,MAAM;AAEpC,cAAI,SAAS,OAAO;AAClB,uBAAW;AAAA,UACb;AACA,iBAAO;AAAA,QACT;AAAA,MACF,CAAC,KAAK;AACR,aAAO,SAAS,QAAQ,IAAI,GAAG,QAAQ,IAAI,aAAa,WAAW,CAAC,CAAC,KAAK;AAAA,IAC5E,CAAC;AAAA,EACH;AACF;;;ACtBO,IAAM,WAAN,MAAiC;AAAA,EAC9B;AAAA,EACA;AAAA,EAER,YAAY,QAAgB,IAAmB;AAC7C,SAAK,UAAU;AACf,SAAK,MAAM;AAAA,EACb;AAAA,EAEA,IAAI,GAAG,IAAY;AACjB,SAAK,MAAM,MAAM;AAAA,EACnB;AAAA,EAEA,SAAS,MAAiB;AACxB,SAAK,SAAS,MAAM,KAAK,OAAO,GAAG,GAAG,IAAI;AAAA,EAC5C;AAAA,EAEA,SAAS,MAAiB;AACxB,SAAK,SAAS,MAAM,KAAK,OAAO,GAAG,GAAG,IAAI;AAAA,EAC5C;AAAA,EAEA,QAAQ,MAAiB;AACvB,SAAK,SAAS,KAAK,KAAK,OAAO,GAAG,GAAG,IAAI;AAAA,EAC3C;AAAA,EAEA,OAAO,MAAiB;AACtB,SAAK,SAAS,IAAI,KAAK,OAAO,GAAG,GAAG,IAAI;AAAA,EAC1C;AAAA,EAEA,SAAS,MAAiB;AACxB,SAAK,SAAS,MAAM,KAAK,OAAO,GAAG,GAAG,IAAI;AAAA,EAC5C;AAAA,EAEA,QAAQ,MAAiB;AACvB,SAAK,SAAS,KAAK,KAAK,OAAO,GAAG,GAAG,IAAI;AAAA,EAC3C;AAAA,EAEQ,SAAS;AACf,WAAO,IAAI,KAAK,MAAM,CAAC;AAAA,EACzB;AACF;;;ACpCO,IAAM,eAAN,MAAqC;AAAA,EACjC,QAAQ;AAAA,EACR,QAAQ;AAAA,EACR,OAAO;AAAA,EACP,MAAM;AAAA,EACN,QAAQ;AAAA,EACR,OAAO;AAClB;","names":[]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xylabs/logger",
-  "version": "5.0.83",
+  "version": "5.0.84",
   "description": "XYLabs Logger Library",
   "keywords": [
     "logger",
@@ -42,14 +42,14 @@
     "!**/*.test.*"
   ],
   "dependencies": {
-    "@xylabs/enum": "~5.0.83",
-    "@xylabs/error": "~5.0.83",
-    "@xylabs/typeof": "~5.0.83"
+    "@xylabs/enum": "~5.0.84",
+    "@xylabs/error": "~5.0.84",
+    "@xylabs/typeof": "~5.0.84"
   },
   "devDependencies": {
     "@types/node": "~25.4.0",
-    "@xylabs/ts-scripts-yarn3": "~7.4.11",
-    "@xylabs/tsconfig": "~7.4.11",
+    "@xylabs/ts-scripts-yarn3": "~7.4.13",
+    "@xylabs/tsconfig": "~7.4.13",
     "typescript": "~5.9.3",
     "vitest": "~4.0.18"
   },