@xylabs/logger 5.0.79 → 5.0.81

package/README.md

@@ -35,7 +35,6 @@ XYLabs Logger Library
 ## Type Aliases
 
 - [LogFunction](#type-aliases/LogFunction)
-- [~~LogLevel~~](#type-aliases/LogLevel)
 - [LogLevelKey](#type-aliases/LogLevelKey)
 - [LogVerbosity](#type-aliases/LogVerbosity)
 - [LogLevelValue](#type-aliases/LogLevelValue)
@@ -69,12 +68,12 @@ Interface to handle overlap between Winston &
 ### Constructor
 
 ```ts
-new ConsoleLogger(level): ConsoleLogger;
+new ConsoleLogger(level?): ConsoleLogger;
 ```
 
 ### Parameters
 
-#### level
+#### level?
 
 [`LogLevelValue`](#../type-aliases/LogLevelValue) = `LogLevel.warn`
 
@@ -439,7 +438,7 @@ Interface to handle overlap between Winston &
 ### Constructor
 
 ```ts
-new LevelLogger(logger, level): LevelLogger;
+new LevelLogger(logger, level?): LevelLogger;
 ```
 
 ### Parameters
@@ -448,7 +447,7 @@ new LevelLogger(logger, level): LevelLogger;
 
 [`Logger`](#../interfaces/Logger)
 
-#### level
+#### level?
 
 [`LogLevelValue`](#../type-aliases/LogLevelValue) = `LogLevel.warn`
 
@@ -769,12 +768,12 @@ function NoOpLogFunction(..._data): undefined;
 ***
 
 ```ts
-function getFunctionName(depth): string;
+function getFunctionName(depth?): string;
 ```
 
 ## Parameters
 
-### depth
+### depth?
 
 `number` = `2`
 
@@ -863,22 +862,6 @@ type LogFunction = (...data) => void;
 
 `void`
 
-  ### <a id="LogLevel"></a>LogLevel
-
-[**@xylabs/logger**](#../README)
-
-***
-
-```ts
-type LogLevel = LogLevelValue;
-```
-
-## Deprecated
-
-Use `LogLevelValue` instead.
-This name conflicts with the `LogLevel` enum and
-makes it confusing to import
-
   ### <a id="LogLevelKey"></a>LogLevelKey
 
 [**@xylabs/logger**](#../README)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xylabs/logger",
-  "version": "5.0.79",
+  "version": "5.0.81",
   "description": "XYLabs Logger Library",
   "keywords": [
     "logger",
@@ -29,30 +29,27 @@
   "exports": {
     ".": {
       "types": "./dist/neutral/index.d.ts",
-      "source": "./src/index.ts",
       "default": "./dist/neutral/index.mjs"
     },
     "./package.json": "./package.json"
   },
   "module": "./dist/neutral/index.mjs",
-  "source": "./src/index.ts",
   "types": "./dist/neutral/index.d.ts",
   "files": [
     "dist",
-    "src",
     "!**/*.bench.*",
     "!**/*.spec.*",
     "!**/*.test.*"
   ],
   "dependencies": {
-    "@xylabs/enum": "~5.0.79",
-    "@xylabs/error": "~5.0.79",
-    "@xylabs/typeof": "~5.0.79"
+    "@xylabs/enum": "~5.0.81",
+    "@xylabs/error": "~5.0.81",
+    "@xylabs/typeof": "~5.0.81"
   },
   "devDependencies": {
-    "@types/node": "~25.2.3",
-    "@xylabs/ts-scripts-yarn3": "~7.3.2",
-    "@xylabs/tsconfig": "~7.3.2",
+    "@types/node": "~25.4.0",
+    "@xylabs/ts-scripts-yarn3": "~7.4.11",
+    "@xylabs/tsconfig": "~7.4.11",
     "typescript": "~5.9.3",
     "vitest": "~4.0.18"
   },

package/src/ConsoleLogger.ts

@@ -1,8 +0,0 @@
-import type { LogLevelValue } from './LevelLogger.ts'
-import { LevelLogger, LogLevel } from './LevelLogger.ts'
-
-export class ConsoleLogger extends LevelLogger {
-  constructor(level: LogLevelValue = LogLevel.warn) {
-    super(console, level)
-  }
-}

package/src/IdLogger.ts

@@ -1,43 +0,0 @@
-import type { Logger } from './LevelLogger.ts'
-
-export class IdLogger implements Logger {
-  private _id?: () => string
-  private _logger: Logger
-
-  constructor(logger: Logger, id?: () => string) {
-    this._logger = logger
-    this._id = id
-  }
-
-  set id(id: string) {
-    this._id = () => id
-  }
-
-  debug(...data: unknown[]) {
-    this._logger?.debug(this.prefix(), ...data)
-  }
-
-  error(...data: unknown[]) {
-    this._logger?.error(this.prefix(), ...data)
-  }
-
-  info(...data: unknown[]) {
-    this._logger?.info(this.prefix(), ...data)
-  }
-
-  log(...data: unknown[]) {
-    this._logger?.log(this.prefix(), ...data)
-  }
-
-  trace(...data: unknown[]) {
-    this._logger?.trace(this.prefix(), ...data)
-  }
-
-  warn(...data: unknown[]) {
-    this._logger?.warn(this.prefix(), ...data)
-  }
-
-  private prefix() {
-    return `[${this._id?.()}]`
-  }
-}

package/src/LevelLogger.ts

@@ -1,66 +0,0 @@
-import type { EnumKey, EnumValue } from '@xylabs/enum'
-import { Enum } from '@xylabs/enum'
-
-import { NoOpLogFunction } from './NoOpLogFunction.ts'
-
-export type LogFunction = (...data: unknown[]) => void
-
-/**
- * Interface to handle overlap between Winston &
- * `console` with as much congruency as possible.
- */
-export interface Logger {
-  debug: LogFunction
-  error: LogFunction
-  info: LogFunction
-  log: LogFunction
-  trace: LogFunction
-  warn: LogFunction
-}
-
-export const LogLevel = Enum({
-  error: 1,
-  warn: 2,
-  info: 3,
-  log: 4,
-  debug: 5,
-  trace: 6,
-})
-
-export type LogLevelKey = EnumKey<typeof LogLevel>
-export type LogVerbosity = LogLevelKey
-
-export type LogLevelValue = EnumValue<typeof LogLevel>
-
-export class LevelLogger implements Logger {
-  readonly level: LogLevelValue
-  readonly logger: Logger
-  constructor(logger: Logger, level: LogLevelValue = LogLevel.warn) {
-    this.level = level
-    this.logger = logger
-  }
-
-  get debug() {
-    return this.level >= LogLevel.debug ? this.logger.debug : NoOpLogFunction
-  }
-
-  get error() {
-    return this.level >= LogLevel.error ? this.logger.error : NoOpLogFunction
-  }
-
-  get info() {
-    return this.level >= LogLevel.info ? this.logger.info : NoOpLogFunction
-  }
-
-  get log() {
-    return this.level >= LogLevel.log ? this.logger.log : NoOpLogFunction
-  }
-
-  get trace() {
-    return this.level >= LogLevel.trace ? this.logger.trace : NoOpLogFunction
-  }
-
-  get warn() {
-    return this.level >= LogLevel.warn ? this.logger.warn : NoOpLogFunction
-  }
-}

package/src/NoOpLogFunction.ts

@@ -1 +0,0 @@
-export const NoOpLogFunction = (..._data: unknown[]) => void {}

package/src/SilentLogger.ts

@@ -1,18 +0,0 @@
-import type { Logger } from './LevelLogger.ts'
-import { NoOpLogFunction } from './NoOpLogFunction.ts'
-
-/**
- * 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.
- */
-export class SilentLogger implements Logger {
-  readonly debug = NoOpLogFunction
-  readonly error = NoOpLogFunction
-  readonly info = NoOpLogFunction
-  readonly log = NoOpLogFunction
-  readonly trace = NoOpLogFunction
-  readonly warn = NoOpLogFunction
-}

package/src/getFunctionName.ts

@@ -1,24 +0,0 @@
-import { handleError } from '@xylabs/error'
-import { isNumber } from '@xylabs/typeof'
-
-export const getFunctionName = (depth = 2) => {
-  try {
-    throw new Error('Getting function name')
-  } catch (ex) {
-    return handleError(ex, (error) => {
-      let newIndex: number | undefined
-      const stackParts = error.stack?.split('\n')[depth]?.split(' ')
-      const funcName
-        = stackParts?.find((item, index) => {
-          if (item.length > 0 && item !== 'at') {
-            // check if constructor
-            if (item === 'new') {
-              newIndex = index
-            }
-            return true
-          }
-        }) ?? '<unknown>'
-      return isNumber(newIndex) ? `${funcName} ${stackParts?.[newIndex + 1]}` : funcName
-    })
-  }
-}

package/src/index.ts

@@ -1,6 +0,0 @@
-export * from './ConsoleLogger.ts'
-export * from './getFunctionName.ts'
-export * from './IdLogger.ts'
-export * from './LevelLogger.ts'
-export * from './NoOpLogFunction.ts'
-export * from './SilentLogger.ts'