@xylabs/logger 5.0.94 → 5.0.96

package/README.md

@@ -1,68 +1,52 @@
 # @xylabs/logger
 
-[![logo][]](https://xylabs.com)
+[![npm][npm-badge]][npm-link]
+[![license][license-badge]][license-link]
 
-[![main-build][]][main-build-link]
-[![npm-badge][]][npm-link]
-[![npm-downloads-badge][]][npm-link]
-[![jsdelivr-badge][]][jsdelivr-link]
-[![npm-license-badge][]](LICENSE)
-[![codacy-badge][]][codacy-link]
-[![codeclimate-badge][]][codeclimate-link]
-[![snyk-badge][]][snyk-link]
-[![socket-badge][]][socket-link]
+> XYLabs Logger Library
 
+## Install
 
-XYLabs Logger Library
-
+Using npm:
 
+```sh
+npm install {{name}}
+```
 
-## Reference
+Using yarn:
 
-**@xylabs/logger**
+```sh
+yarn add {{name}}
+```
 
-***
+Using pnpm:
 
-## Classes
+```sh
+pnpm add {{name}}
+```
 
-| Class | Description |
-| ------ | ------ |
-| [ConsoleLogger](#classes/ConsoleLogger) | A LevelLogger that delegates to the global `console` object. |
-| [IdLogger](#classes/IdLogger) | A logger wrapper that prefixes every log message with a bracketed identifier. Useful for distinguishing log output from different components or instances. |
-| [LevelLogger](#classes/LevelLogger) | A logger that filters messages based on a configured log level. Methods for levels above the configured threshold return a no-op function. |
-| [SilentLogger](#classes/SilentLogger) | A logger that does not log anything. This is useful when you want to disable logging like when running unit tests or in silent mode. It implements the `Logger` interface but all methods are no-op functions. |
+Using bun:
 
-## Interfaces
+```sh
+bun add {{name}}
+```
 
-| Interface | Description |
-| ------ | ------ |
-| [Logger](#interfaces/Logger) | Interface to handle overlap between Winston & `console` with as much congruency as possible. |
 
-## Type Aliases
+## License
 
-| Type Alias | Description |
-| ------ | ------ |
-| [LogFunction](#type-aliases/LogFunction) | A generic logging function that accepts any number of arguments. |
-| [LogLevelKey](#type-aliases/LogLevelKey) | String key for a log level (e.g. 'error', 'warn', 'info'). |
-| [LogVerbosity](#type-aliases/LogVerbosity) | Alias for LogLevelKey, representing the verbosity setting as a string. |
-| [LogLevelValue](#type-aliases/LogLevelValue) | Numeric value of a log level (1 through 6). |
+See the [LICENSE](LICENSE) file for license rights and limitations (LGPL-3.0-only).
 
-## Variables
+## Reference
 
-| Variable | Description |
-| ------ | ------ |
-| [LogLevel](#variables/LogLevel) | Numeric log level values, from least verbose (error=1) to most verbose (trace=6). |
+### packages
 
-## Functions
+  ### logger
 
-| Function | Description |
-| ------ | ------ |
-| [NoOpLogFunction](#functions/NoOpLogFunction) | A log function that silently discards all arguments. |
-| [getFunctionName](#functions/getFunctionName) | Retrieves the name of the calling function by inspecting the stack trace. |
+    ### .temp-typedoc
 
-### classes
+      ### classes
 
-  ### <a id="ConsoleLogger"></a>ConsoleLogger
+        ### <a id="ConsoleLogger"></a>ConsoleLogger
 
 [**@xylabs/logger**](#../README)
 
@@ -79,14 +63,14 @@ A LevelLogger that delegates to the global `console` object.
 ### Constructor
 
 ```ts
-new ConsoleLogger(level?: LogLevelValue): ConsoleLogger;
+new ConsoleLogger(level?): ConsoleLogger;
 ```
 
 ### Parameters
 
-| Parameter | Type | Default value |
-| ------ | ------ | ------ |
-| `level` | [`LogLevelValue`](#../type-aliases/LogLevelValue) | `LogLevel.warn` |
+#### level?
+
+[`LogLevelValue`](#../type-aliases/LogLevelValue) = `LogLevel.warn`
 
 ### Returns
 
@@ -98,10 +82,27 @@ new ConsoleLogger(level?: LogLevelValue): ConsoleLogger;
 
 ## Properties
 
-| Property | Modifier | Type | Inherited from |
-| ------ | ------ | ------ | ------ |
-| <a id="level"></a> `level` | `readonly` | [`LogLevelValue`](#../type-aliases/LogLevelValue) | [`LevelLogger`](#LevelLogger).[`level`](LevelLogger.md#level) |
-| <a id="logger"></a> `logger` | `readonly` | [`Logger`](#../interfaces/Logger) | [`LevelLogger`](#LevelLogger).[`logger`](LevelLogger.md#logger) |
+### level
+
+```ts
+readonly level: LogLevelValue;
+```
+
+### Inherited from
+
+[`LevelLogger`](#LevelLogger).[`level`](LevelLogger.md#level)
+
+***
+
+### logger
+
+```ts
+readonly logger: Logger;
+```
+
+### Inherited from
+
+[`LevelLogger`](#LevelLogger).[`logger`](LevelLogger.md#logger)
 
 ## Accessors
 
@@ -211,7 +212,7 @@ get warn(): LogFunction;
 
 [`LevelLogger`](#LevelLogger).[`warn`](LevelLogger.md#warn)
 
-  ### <a id="IdLogger"></a>IdLogger
+        ### <a id="IdLogger"></a>IdLogger
 
 [**@xylabs/logger**](#../README)
 
@@ -229,15 +230,18 @@ Useful for distinguishing log output from different components or instances.
 ### Constructor
 
 ```ts
-new IdLogger(logger: Logger, id?: () => string): IdLogger;
+new IdLogger(logger, id?): IdLogger;
 ```
 
 ### Parameters
 
-| Parameter | Type |
-| ------ | ------ |
-| `logger` | [`Logger`](#../interfaces/Logger) |
-| `id?` | () => `string` |
+#### logger
+
+[`Logger`](#../interfaces/Logger)
+
+#### id?
+
+() => `string`
 
 ### Returns
 
@@ -250,14 +254,14 @@ new IdLogger(logger: Logger, id?: () => string): IdLogger;
 ### Set Signature
 
 ```ts
-set id(id: string): void;
+set id(id): void;
 ```
 
 #### Parameters
 
-| Parameter | Type |
-| ------ | ------ |
-| `id` | `string` |
+##### id
+
+`string`
 
 #### Returns
 
@@ -268,14 +272,14 @@ set id(id: string): void;
 ### debug()
 
 ```ts
-debug(...data: unknown[]): void;
+debug(...data): void;
 ```
 
 ### Parameters
 
-| Parameter | Type |
-| ------ | ------ |
-| ...`data` | `unknown`[] |
+#### data
+
+...`unknown`[]
 
 ### Returns
 
@@ -292,14 +296,14 @@ Logger.debug
 ### error()
 
 ```ts
-error(...data: unknown[]): void;
+error(...data): void;
 ```
 
 ### Parameters
 
-| Parameter | Type |
-| ------ | ------ |
-| ...`data` | `unknown`[] |
+#### data
+
+...`unknown`[]
 
 ### Returns
 
@@ -316,14 +320,14 @@ Logger.error
 ### info()
 
 ```ts
-info(...data: unknown[]): void;
+info(...data): void;
 ```
 
 ### Parameters
 
-| Parameter | Type |
-| ------ | ------ |
-| ...`data` | `unknown`[] |
+#### data
+
+...`unknown`[]
 
 ### Returns
 
@@ -340,14 +344,14 @@ Logger.info
 ### log()
 
 ```ts
-log(...data: unknown[]): void;
+log(...data): void;
 ```
 
 ### Parameters
 
-| Parameter | Type |
-| ------ | ------ |
-| ...`data` | `unknown`[] |
+#### data
+
+...`unknown`[]
 
 ### Returns
 
@@ -364,14 +368,14 @@ Logger.log
 ### trace()
 
 ```ts
-trace(...data: unknown[]): void;
+trace(...data): void;
 ```
 
 ### Parameters
 
-| Parameter | Type |
-| ------ | ------ |
-| ...`data` | `unknown`[] |
+#### data
+
+...`unknown`[]
 
 ### Returns
 
@@ -388,14 +392,14 @@ Logger.trace
 ### warn()
 
 ```ts
-warn(...data: unknown[]): void;
+warn(...data): void;
 ```
 
 ### Parameters
 
-| Parameter | Type |
-| ------ | ------ |
-| ...`data` | `unknown`[] |
+#### data
+
+...`unknown`[]
 
 ### Returns
 
@@ -407,7 +411,7 @@ warn(...data: unknown[]): void;
 Logger.warn
 ```
 
-  ### <a id="LevelLogger"></a>LevelLogger
+        ### <a id="LevelLogger"></a>LevelLogger
 
 [**@xylabs/logger**](#../README)
 
@@ -429,15 +433,18 @@ Methods for levels above the configured threshold return a no-op function.
 ### Constructor
 
 ```ts
-new LevelLogger(logger: Logger, level?: LogLevelValue): LevelLogger;
+new LevelLogger(logger, level?): LevelLogger;
 ```
 
 ### Parameters
 
-| Parameter | Type | Default value |
-| ------ | ------ | ------ |
-| `logger` | [`Logger`](#../interfaces/Logger) | `undefined` |
-| `level` | [`LogLevelValue`](#../type-aliases/LogLevelValue) | `LogLevel.warn` |
+#### logger
+
+[`Logger`](#../interfaces/Logger)
+
+#### level?
+
+[`LogLevelValue`](#../type-aliases/LogLevelValue) = `LogLevel.warn`
 
 ### Returns
 
@@ -445,10 +452,19 @@ new LevelLogger(logger: Logger, level?: LogLevelValue): LevelLogger;
 
 ## Properties
 
-| Property | Modifier | Type |
-| ------ | ------ | ------ |
-| <a id="level"></a> `level` | `readonly` | [`LogLevelValue`](#../type-aliases/LogLevelValue) |
-| <a id="logger"></a> `logger` | `readonly` | [`Logger`](#../interfaces/Logger) |
+### level
+
+```ts
+readonly level: LogLevelValue;
+```
+
+***
+
+### logger
+
+```ts
+readonly logger: Logger;
+```
 
 ## Accessors
 
@@ -558,7 +574,7 @@ get warn(): LogFunction;
 
 [`Logger`](#../interfaces/Logger).[`warn`](../interfaces/Logger.md#warn)
 
-  ### <a id="SilentLogger"></a>SilentLogger
+        ### <a id="SilentLogger"></a>SilentLogger
 
 [**@xylabs/logger**](#../README)
 
@@ -588,56 +604,191 @@ new SilentLogger(): SilentLogger;
 
 ## Properties
 
-| Property | Modifier | Type | Default value |
-| ------ | ------ | ------ | ------ |
-| <a id="debug"></a> `debug` | `readonly` | (...`_data`: `unknown`[]) => `undefined` | `NoOpLogFunction` |
-| <a id="error"></a> `error` | `readonly` | (...`_data`: `unknown`[]) => `undefined` | `NoOpLogFunction` |
-| <a id="info"></a> `info` | `readonly` | (...`_data`: `unknown`[]) => `undefined` | `NoOpLogFunction` |
-| <a id="log"></a> `log` | `readonly` | (...`_data`: `unknown`[]) => `undefined` | `NoOpLogFunction` |
-| <a id="trace"></a> `trace` | `readonly` | (...`_data`: `unknown`[]) => `undefined` | `NoOpLogFunction` |
-| <a id="warn"></a> `warn` | `readonly` | (...`_data`: `unknown`[]) => `undefined` | `NoOpLogFunction` |
+### debug
+
+```ts
+readonly debug: (..._data) => undefined = NoOpLogFunction;
+```
+
+A log function that silently discards all arguments.
+
+### Parameters
+
+#### \_data
+
+...`unknown`[]
+
+### Returns
+
+`undefined`
+
+### Implementation of
+
+[`Logger`](#../interfaces/Logger).[`debug`](../interfaces/Logger.md#debug)
+
+***
+
+### error
+
+```ts
+readonly error: (..._data) => undefined = NoOpLogFunction;
+```
+
+A log function that silently discards all arguments.
+
+### Parameters
+
+#### \_data
+
+...`unknown`[]
+
+### Returns
+
+`undefined`
+
+### Implementation of
+
+[`Logger`](#../interfaces/Logger).[`error`](../interfaces/Logger.md#error)
+
+***
+
+### info
+
+```ts
+readonly info: (..._data) => undefined = NoOpLogFunction;
+```
+
+A log function that silently discards all arguments.
+
+### Parameters
+
+#### \_data
+
+...`unknown`[]
+
+### Returns
+
+`undefined`
+
+### Implementation of
+
+[`Logger`](#../interfaces/Logger).[`info`](../interfaces/Logger.md#info)
+
+***
+
+### log
+
+```ts
+readonly log: (..._data) => undefined = NoOpLogFunction;
+```
+
+A log function that silently discards all arguments.
+
+### Parameters
+
+#### \_data
+
+...`unknown`[]
+
+### Returns
+
+`undefined`
+
+### Implementation of
+
+[`Logger`](#../interfaces/Logger).[`log`](../interfaces/Logger.md#log)
+
+***
+
+### trace
+
+```ts
+readonly trace: (..._data) => undefined = NoOpLogFunction;
+```
+
+A log function that silently discards all arguments.
+
+### Parameters
+
+#### \_data
+
+...`unknown`[]
 
-### functions
+### Returns
+
+`undefined`
+
+### Implementation of
+
+[`Logger`](#../interfaces/Logger).[`trace`](../interfaces/Logger.md#trace)
+
+***
+
+### warn
+
+```ts
+readonly warn: (..._data) => undefined = NoOpLogFunction;
+```
+
+A log function that silently discards all arguments.
+
+### Parameters
+
+#### \_data
+
+...`unknown`[]
+
+### Returns
+
+`undefined`
+
+### Implementation of
+
+[`Logger`](#../interfaces/Logger).[`warn`](../interfaces/Logger.md#warn)
 
-  ### <a id="NoOpLogFunction"></a>NoOpLogFunction
+      ### functions
+
+        ### <a id="NoOpLogFunction"></a>NoOpLogFunction
 
 [**@xylabs/logger**](#../README)
 
 ***
 
 ```ts
-function NoOpLogFunction(..._data: unknown[]): undefined;
+function NoOpLogFunction(..._data): undefined;
 ```
 
 A log function that silently discards all arguments.
 
 ## Parameters
 
-| Parameter | Type |
-| ------ | ------ |
-| ...`_data` | `unknown`[] |
+### \_data
+
+...`unknown`[]
 
 ## Returns
 
 `undefined`
 
-  ### <a id="getFunctionName"></a>getFunctionName
+        ### <a id="getFunctionName"></a>getFunctionName
 
 [**@xylabs/logger**](#../README)
 
 ***
 
 ```ts
-function getFunctionName(depth?: number): string;
+function getFunctionName(depth?): string;
 ```
 
 Retrieves the name of the calling function by inspecting the stack trace.
 
 ## Parameters
 
-| Parameter | Type | Default value | Description |
-| ------ | ------ | ------ | ------ |
-| `depth` | `number` | `2` | The stack frame depth to inspect (default: 2, the caller's caller). |
+### depth?
+
+`number` = `2`
+
+The stack frame depth to inspect (default: 2, the caller's caller).
 
 ## Returns
 
@@ -645,9 +796,9 @@ Retrieves the name of the calling function by inspecting the stack trace.
 
 The function name, or '<unknown>' if it cannot be determined.
 
-### interfaces
+      ### interfaces
 
-  ### <a id="Logger"></a>Logger
+        ### <a id="Logger"></a>Logger
 
 [**@xylabs/logger**](#../README)
 
@@ -658,40 +809,77 @@ Interface to handle overlap between Winston &
 
 ## Properties
 
-| Property | Type |
-| ------ | ------ |
-| <a id="debug"></a> `debug` | [`LogFunction`](#../type-aliases/LogFunction) |
-| <a id="error"></a> `error` | [`LogFunction`](#../type-aliases/LogFunction) |
-| <a id="info"></a> `info` | [`LogFunction`](#../type-aliases/LogFunction) |
-| <a id="log"></a> `log` | [`LogFunction`](#../type-aliases/LogFunction) |
-| <a id="trace"></a> `trace` | [`LogFunction`](#../type-aliases/LogFunction) |
-| <a id="warn"></a> `warn` | [`LogFunction`](#../type-aliases/LogFunction) |
+### debug
+
+```ts
+debug: LogFunction;
+```
+
+***
+
+### error
+
+```ts
+error: LogFunction;
+```
+
+***
+
+### info
+
+```ts
+info: LogFunction;
+```
+
+***
+
+### log
+
+```ts
+log: LogFunction;
+```
+
+***
+
+### trace
+
+```ts
+trace: LogFunction;
+```
+
+***
+
+### warn
+
+```ts
+warn: LogFunction;
+```
 
-### type-aliases
+      ### type-aliases
 
-  ### <a id="LogFunction"></a>LogFunction
+        ### <a id="LogFunction"></a>LogFunction
 
 [**@xylabs/logger**](#../README)
 
 ***
 
 ```ts
-type LogFunction = (...data: unknown[]) => void;
+type LogFunction = (...data) => void;
 ```
 
 A generic logging function that accepts any number of arguments.
 
 ## Parameters
 
-| Parameter | Type |
-| ------ | ------ |
-| ...`data` | `unknown`[] |
+### data
+
+...`unknown`[]
 
 ## Returns
 
 `void`
 
-  ### <a id="LogLevelKey"></a>LogLevelKey
+        ### <a id="LogLevelKey"></a>LogLevelKey
 
 [**@xylabs/logger**](#../README)
 
@@ -703,7 +891,7 @@ type LogLevelKey = EnumKey<typeof LogLevel>;
 
 String key for a log level (e.g. 'error', 'warn', 'info').
 
-  ### <a id="LogLevelValue"></a>LogLevelValue
+        ### <a id="LogLevelValue"></a>LogLevelValue
 
 [**@xylabs/logger**](#../README)
 
@@ -715,7 +903,7 @@ type LogLevelValue = EnumValue<typeof LogLevel>;
 
 Numeric value of a log level (1 through 6).
 
-  ### <a id="LogVerbosity"></a>LogVerbosity
+        ### <a id="LogVerbosity"></a>LogVerbosity
 
 [**@xylabs/logger**](#../README)
 
@@ -727,9 +915,9 @@ type LogVerbosity = LogLevelKey;
 
 Alias for LogLevelKey, representing the verbosity setting as a string.
 
-### variables
+      ### variables
 
-  ### <a id="LogLevel"></a>LogLevel
+        ### <a id="LogLevel"></a>LogLevel
 
 [**@xylabs/logger**](#../README)
 
@@ -749,41 +937,7 @@ 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)
-
-## Maintainers
-
--   [Arie Trouw](https://github.com/arietrouw) ([arietrouw.com](https://arietrouw.com))
--   [Matt Jones](https://github.com/jonesmac)
--   [Joel Carter](https://github.com/JoelBCarter)
--   [Jordan Trouw](https://github.com/jordantrouw)
-
-## License
-
-> See the [LICENSE](LICENSE) file for license details
-
-## Credits
-
-[Made with 🔥 and ❄️ by XYLabs](https://xylabs.com)
-
-[logo]: https://cdn.xy.company/img/brand/XYPersistentCompany_Logo_Icon_Colored.svg
-
-[main-build]: https://github.com/xylabs/sdk-js/actions/workflows/build.yml/badge.svg
-[main-build-link]: https://github.com/xylabs/sdk-js/actions/workflows/build.yml
 [npm-badge]: https://img.shields.io/npm/v/@xylabs/logger.svg
 [npm-link]: https://www.npmjs.com/package/@xylabs/logger
-[codacy-badge]: https://app.codacy.com/project/badge/Grade/c8e15e14f37741c18cfb47ac7245c698
-[codacy-link]: https://www.codacy.com/gh/xylabs/sdk-js/dashboard?utm_source=github.com&utm_medium=referral&utm_content=xylabs/sdk-js&utm_campaign=Badge_Grade
-[codeclimate-badge]: https://api.codeclimate.com/v1/badges/c5eb068f806f0b047ea7/maintainability
-[codeclimate-link]: https://codeclimate.com/github/xylabs/sdk-js/maintainability
-[snyk-badge]: https://snyk.io/test/github/xylabs/sdk-js/badge.svg?targetFile=package.json
-[snyk-link]: https://snyk.io/test/github/xylabs/sdk-js?targetFile=package.json
-
-[npm-downloads-badge]: https://img.shields.io/npm/dw/@xylabs/logger
-[npm-license-badge]: https://img.shields.io/npm/l/@xylabs/logger
-
-[jsdelivr-badge]: https://data.jsdelivr.com/v1/package/npm/@xylabs/logger/badge
-[jsdelivr-link]: https://www.jsdelivr.com/package/npm/@xylabs/logger
-
-[socket-badge]: https://socket.dev/api/badge/npm/package/@xylabs/logger
-[socket-link]: https://socket.dev/npm/package/@xylabs/logger
+[license-badge]: https://img.shields.io/npm/l/@xylabs/logger.svg
+[license-link]: https://github.com/xylabs/sdk-js/blob/main/LICENSE

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xylabs/logger",
-  "version": "5.0.94",
+  "version": "5.0.96",
   "description": "XYLabs Logger Library",
   "keywords": [
     "logger",
@@ -29,12 +29,10 @@
   "exports": {
     ".": {
       "types": "./dist/neutral/index.d.ts",
-      "import": "./dist/neutral/index.mjs",
       "default": "./dist/neutral/index.mjs"
     },
     "./package.json": "./package.json"
   },
-  "types": "./dist/neutral/index.d.ts",
   "files": [
     "dist",
     "!**/*.bench.*",
@@ -43,20 +41,18 @@
     "README.md"
   ],
   "dependencies": {
-    "@xylabs/enum": "~5.0.94",
-    "@xylabs/typeof": "~5.0.94",
-    "@xylabs/error": "~5.0.94"
+    "@xylabs/enum": "~5.0.96",
+    "@xylabs/error": "~5.0.96",
+    "@xylabs/typeof": "~5.0.96"
   },
   "devDependencies": {
-    "@types/node": "~25.5.2",
-    "@xylabs/ts-scripts-common": "~7.7.3",
-    "@xylabs/ts-scripts-pnpm": "~7.7.3",
-    "@xylabs/tsconfig": "~7.7.3",
-    "acorn": "^6.0.0 || ^7.0.0 || ^8.0.0",
+    "@types/node": "~25.6.0",
+    "@xylabs/toolchain": "~7.10.4",
+    "@xylabs/tsconfig": "~7.10.4",
     "esbuild": "^0.28.0",
     "typescript": "^5",
-    "vite": "^6.0.0 || ^7.0.0 || ^8.0.0",
-    "vitest": "^4.1.2"
+    "vite": "^8.0.8",
+    "vitest": "^4.1.4"
   },
   "engines": {
     "node": ">=18"