@darksheep/logger 1.3.0 → 1.3.1

package/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Changelog
 
+## [1.3.1](https://github.com/DarkSheepSoftware/node-packages/compare/logger-v1.3.0...logger-v1.3.1) (2026-04-17)
+
+
+### 📚 Documentation
+
+* Update the READMEs ([#824](https://github.com/DarkSheepSoftware/node-packages/issues/824)) ([9d282b7](https://github.com/DarkSheepSoftware/node-packages/commit/9d282b724fe056ec275578088bf495985e22c25f))
+
 ## [1.3.0](https://github.com/DarkSheepSoftware/node-packages/compare/logger-v1.2.0...logger-v1.3.0) (2025-10-09)
 
 

package/README.md

@@ -1,9 +1,7 @@
 # @darksheep/logger
 Log configuration for NodeJS repos
 
-This repo contains environment aware logging configurations for our NodeJS modules that use Winston.
-
-This can be added using `yarn add @darksheep/logger` how ever you require a valid npm token for github packages!
+This can be added using `yarn add @darksheep/logger`
 
 ### Quick start
 #### Get something logging:

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@darksheep/logger",
-  "version": "1.3.0",
+  "version": "1.3.1",
   "description": "Logging your stuff to where ever you want it",
   "license": "UNLICENCED",
   "type": "module",

package/src/create-logger.js

@@ -13,7 +13,7 @@ import {
 
 /**
  * @param {string} [channel] - The logging channel.
- * @returns {import('./logger.js').Logger}
+ * @returns {Logger}
  */
 export function createLogger(channel) {
   return new Logger(

package/src/index.js

@@ -1,10 +1,20 @@
 import { createLogger } from './create-logger.js';
 
-/** @typedef {import('./utilities/log-types.js').LogContext} LogContext */
-/** @typedef {import('./utilities/log-types.js').LogEntry} LogEntry */
-/** @typedef {import('./utilities/log-types.js').LogLevel} LogLevel */
-/** @typedef {import('./formatter.js').Formatter} Formatter */
-/** @typedef {import('./replacer.js').Replacer} Replacer */
+/**
+ * @typedef {import('./utilities/log-types.js').LogContext} LogContext
+ */
+/**
+ * @typedef {import('./utilities/log-types.js').LogEntry} LogEntry
+ */
+/**
+ * @typedef {import('./utilities/log-types.js').LogLevel} LogLevel
+ */
+/**
+ * @typedef {import('./formatter.js').Formatter} Formatter
+ */
+/**
+ * @typedef {import('./replacer.js').Replacer} Replacer
+ */
 
 export { createLogger } from './create-logger.js';
 export const logger = createLogger();

package/src/logger.js

@@ -1,3 +1,8 @@
+/**
+ * @import { LogLevel, LogContext, LogEntry} from './utilities/log-types.js'
+ * @import { Replacer } from './replacer.js';
+ */
+
 import { AsyncLocalStorage } from 'node:async_hooks';
 
 import { deepmerge } from 'deepmerge-ts';
@@ -15,16 +20,16 @@ import { LogLevels } from './utilities/log-types.js';
 /**
  * @typedef {Object} Options
  * @property {typeof replace} [replace] - The replacer function to use.
- * @property {import('./replacer.js').Replacer<any, any>[]} [replacers] - The replacers to use in the replacer.
+ * @property {Replacer[]} [replacers] - The replacers to use in the replacer.
  * @property {typeof formatter} [format] - The formatter function to use (eg console or json formatter).
  * @property {typeof stdoutWrite} [write] - The place to write the log to.
  */
 
 export class Logger {
-  /** @type {AsyncLocalStorage<import('./utilities/log-types.js').LogContext[]>} */
+  /** @type {AsyncLocalStorage<LogContext[]>} */
   static storage = new AsyncLocalStorage();
 
-  /** @type {import('./utilities/log-types.js').LogContext} */
+  /** @type {LogContext} */
   #context;
 
   /** @type {typeof formatter} */
@@ -36,10 +41,10 @@ export class Logger {
   /** @type {typeof stdoutWrite} */
   #write = stdoutWrite;
 
-  /** @type {import('./replacer.js').Replacer[]} */
+  /** @type {Replacer[]} */
   replacers = [];
   /**
-   * @param {import('./utilities/log-types.js').LogContext} [context] - Context to add to the logger.
+   * @param {LogContext} [context] - Context to add to the logger.
    * @param {Options} [options] - Options for the loggers output.
    */
   constructor(context, options) {
@@ -59,7 +64,7 @@ export class Logger {
   }
 
   /**
-   * @param {import('./utilities/log-types.js').LogContext} context - Context to bind ot the async context.
+   * @param {LogContext} context - Context to bind ot the async context.
    * @returns {void}
    */
   static addAsyncContext(context) {
@@ -81,7 +86,7 @@ export class Logger {
   /**
    * @template [R=unknown]
    * @overload
-   * @param {import('./utilities/log-types.js').LogContext} context - Context to bind ot the async context.
+   * @param {LogContext} context - Context to bind ot the async context.
    * @param {() => R} callback - The function to wrap the context in.
    * @returns {R}
    */
@@ -103,14 +108,14 @@ export class Logger {
     }
 
     return Logger.storage.run(
-      [ ...store, /** @type {import('./utilities/log-types.js').LogContext} */ (context) ],
+      [ ...store, /** @type {LogContext} */ (context) ],
       /** @type {() => R} */ (callback),
     );
   }
 
   /**
-   * @param {import('./utilities/log-types.js').LogContext} context - The new context.
-   * @param {import('./utilities/log-types.js').LogLevel} [level] - The log level at which we allow this context.
+   * @param {LogContext} context - The new context.
+   * @param {LogLevel} [level] - The log level at which we allow this context.
    * @returns {Logger}
    */
   #overrideContext(context, level) {
@@ -150,27 +155,27 @@ export class Logger {
   /**
    * Creating a new logger with {context, ...this.context}.
    * @overload
-   * @param {import('./utilities/log-types.js').LogContext} context - The new context.
+   * @param {LogContext} context - The new context.
    * @returns {Logger}
    */
   /**
    * Creating a new logger with {context, ...this.context}.
    * @overload
-   * @param {import('./utilities/log-types.js').LogContext} context - The new context.
-   * @param {import('./utilities/log-types.js').LogLevel} level - The log level at which we allow this context.
+   * @param {LogContext} context - The new context.
+   * @param {LogLevel} level - The log level at which we allow this context.
    * @returns {Logger}
    */
   /**
    * Creating a new logger with {context, ...this.context}.
    * @overload
-   * @param {import('./utilities/log-types.js').LogLevel} level - The log level at which we allow this context.
-   * @param {import('./utilities/log-types.js').LogContext} context - The new context.
+   * @param {LogLevel} level - The log level at which we allow this context.
+   * @param {LogContext} context - The new context.
    * @returns {Logger}
    */
   /**
    * Creating a new logger with {context, ...this.context}.
-   * @param {import('./utilities/log-types.js').LogContext | import('./utilities/log-types.js').LogLevel} contextOrLevel - The log level at which we allow this context.
-   * @param {import('./utilities/log-types.js').LogLevel | import('./utilities/log-types.js').LogContext} [levelOrContext] - The new context.
+   * @param {LogContext | LogLevel} contextOrLevel - The log level at which we allow this context.
+   * @param {LogLevel | LogContext} [levelOrContext] - The new context.
    * @returns {Logger}
    */
   context(contextOrLevel, levelOrContext) {
@@ -207,31 +212,31 @@ export class Logger {
    * Write a log with the level 'critical' - A crucial part of the application is not working.
    *
    * @param {Error | string} message - The message to log.
-   * @param {import('./utilities/log-types.js').LogContext} [context] - Additional context.
+   * @param {LogContext} [context] - Additional context.
    * @returns {void}
    */
   critical(message, context) {
-    return this.write(LogLevels.critical, message, context);
+    this.write(LogLevels.critical, message, context);
   }
 
   /**
    * Write a log with the level 'debug' - Information that is unlikely to help in production.
    * @param {Error | string} message - The message to log.
-   * @param {import('./utilities/log-types.js').LogContext} [context] - Additional context.
+   * @param {LogContext} [context] - Additional context.
    * @returns {void}
    */
   debug(message, context) {
-    return this.write(LogLevels.debug, message, context);
+    this.write(LogLevels.debug, message, context);
   }
 
   /**
    * Write a log with the level 'error' - A non critical operation fails.
    * @param {Error | string} message - The message to log.
-   * @param {import('./utilities/log-types.js').LogContext} [context] - Additional context.
+   * @param {LogContext} [context] - Additional context.
    * @returns {void}
    */
   error(message, context) {
-    return this.write(LogLevels.error, message, context);
+    this.write(LogLevels.error, message, context);
   }
 
   /**
@@ -246,21 +251,21 @@ export class Logger {
   /**
    * Write a log with the level 'info' - Information about successful operations.
    * @param {Error | string} message - The message to log.
-   * @param {import('./utilities/log-types.js').LogContext} [context] - Additional context.
+   * @param {LogContext} [context] - Additional context.
    * @returns {void}
    */
   info(message, context) {
-    return this.write(LogLevels.info, message, context);
+    this.write(LogLevels.info, message, context);
   }
 
   /**
    * Write a log with the level 'notice' - Information about events that may be unusual.
    * @param {Error | string} message - The message to log.
-   * @param {import('./utilities/log-types.js').LogContext} [context] - Additional context.
+   * @param {LogContext} [context] - Additional context.
    * @returns {void}
    */
   notice(message, context) {
-    return this.write(LogLevels.notice, message, context);
+    this.write(LogLevels.notice, message, context);
   }
 
   /*
@@ -282,11 +287,11 @@ export class Logger {
   /**
    * Write a log with the level 'silly' - Information to help resolve complex logic issues.
    * @param {Error | string} message - The message to log.
-   * @param {import('./utilities/log-types.js').LogContext} [context] - Additional context.
+   * @param {LogContext} [context] - Additional context.
    * @returns {void}
    */
   silly(message, context) {
-    return this.write(LogLevels.silly, message, context);
+    this.write(LogLevels.silly, message, context);
   }
 
   /**
@@ -306,11 +311,11 @@ export class Logger {
   /**
    * Write a log with the level 'warning' - An operation might fail in the future.
    * @param {Error | string} message - The message to log.
-   * @param {import('./utilities/log-types.js').LogContext} [context] - Additional context.
+   * @param {LogContext} [context] - Additional context.
    * @returns {void}
    */
   warning(message, context) {
-    return this.write(LogLevels.warning, message, context);
+    this.write(LogLevels.warning, message, context);
   }
 
   /**
@@ -324,13 +329,13 @@ export class Logger {
 
   /**
    * Write a new log entry.
-   * @param {import('./utilities/log-types.js').LogLevel} level - The log level of the message to log.
+   * @param {LogLevel} level - The log level of the message to log.
    * @param {Error | string} message - The message to log.
-   * @param {import('./utilities/log-types.js').LogContext} [context] - Context to add to the log (merged with this.context, and Logger.contexts).
+   * @param {LogContext} [context] - Context to add to the log (merged with this.context, and Logger.contexts).
    * @returns {void}
    */
   write(level, message, context) {
-    /** @type {import('./utilities/log-types.js').LogContext[]} */
+    /** @type {LogContext[]} */
     const contexts = [];
 
     const asyncContexts = Logger.storage.getStore();
@@ -344,7 +349,7 @@ export class Logger {
     }
 
     const fullContext =
-      /** @type {import('./utilities/log-types.js').LogContext} */
+      /** @type {LogContext} */
       (deepmerge(...contexts));
 
     if (
@@ -354,7 +359,7 @@ export class Logger {
       return;
     }
 
-    /** @type {import('./utilities/log-types.js').LogEntry} */
+    /** @type {LogEntry} */
     const entry = (
       typeof message === 'string'
         ? { ...fullContext, message, level }
@@ -374,11 +379,11 @@ export class Logger {
     }
 
     const normalised =
-      /** @type {import('./utilities/log-types.js').LogEntry} */
+      /** @type {LogEntry} */
       (this.#replace(entry, this.replacers));
 
     const formatted = this.#format(normalised);
 
-    return this.#write(formatted);
+    this.#write(formatted);
   }
 }

package/src/replacer.js

@@ -1,9 +1,12 @@
+/**
+ * @import { TraverseContext } from 'traverse';
+ */
 import Traverse from 'traverse';
 
 import { nodesToPath } from './utilities/json-path.js';
 
 /**
- * @template [T=unknown]
+ * @template [T=any]
  * @template [O=unknown]
  * @typedef {Object} Replacer
  * @property {string} name - The name of the replacer.
@@ -23,15 +26,17 @@ export function replace(object, replacers = []) {
     /**
      * @param {unknown} value - Current property in the traversed object.
      * @returns {void}
-     * @this {import('traverse').TraverseContext}
+     * @this {TraverseContext}
      */
     function (value) {
       if (value == null) {
-        return this.remove();
+        this.remove();
+        return;
       }
 
       if (this.circular != null) {
-        return this.update({ $ref: nodesToPath(this.circular.path) });
+        this.update({ $ref: nodesToPath(this.circular.path) });
+        return;
       }
 
       for (const replacer of replacers) {
@@ -39,10 +44,12 @@ export function replace(object, replacers = []) {
           const replaced = replacer.replace(value, this.path);
 
           if (replaced == null) {
-            return this.remove(replacer.stopHere);
+            this.remove(replacer.stopHere);
+            return;
           }
 
-          return this.update(replaced, replacer.stopHere);
+          this.update(replaced, replacer.stopHere);
+          return;
         }
       }
 
@@ -52,7 +59,8 @@ export function replace(object, replacers = []) {
         typeof value.toJSON === 'function'
       ) {
         try {
-          return this.update(value.toJSON());
+          this.update(value.toJSON());
+          return;
         } catch { }
       }
 
@@ -61,7 +69,8 @@ export function replace(object, replacers = []) {
         Object.getPrototypeOf(value) !== Object.getPrototypeOf({}) &&
         Object.getPrototypeOf(value) !== Object.getPrototypeOf([])
       ) {
-        return this.update({ $class: value.constructor.name });
+        this.update({ $class: value.constructor.name });
+        return;
       }
 
       if (Object.getPrototypeOf(value)?.constructor === Object) {

package/src/replacers/buffers.js

@@ -1,3 +1,7 @@
+/**
+ * @import { Replacer } from '../replacer.js';
+ */
+
 /**
  * @param {Buffer} buffer - The buffer to convert to a string.
  * @returns {string}
@@ -6,7 +10,7 @@ function stringBuffer(buffer) {
   return buffer.toString('utf8');
 }
 
-/** @type {import('../replacer.js').Replacer<Buffer>} */
+/** @type {Replacer<Buffer>} */
 export const BufferReplacer = {
   name: 'Buffer',
   stopHere: true,

package/src/replacers/error.js

@@ -1,3 +1,6 @@
+/**
+ * @import { Replacer } from '../replacer.js';
+ */
 import { parseStack } from '../utilities/stacktrace.js';
 
 /**
@@ -11,7 +14,7 @@ import { parseStack } from '../utilities/stacktrace.js';
  * @typedef {BaseError & { [k: string]: unknown }} NormalisedError
  */
 
-/** @type {import('../replacer.js').Replacer<Error, NormalisedError>} */
+/** @type {Replacer<Error, NormalisedError>} */
 export const ErrorReplacer = {
   name: 'Error',
   shouldReplace: (input) => input instanceof Error,
@@ -21,7 +24,7 @@ export const ErrorReplacer = {
 
     for (const key of Object.getOwnPropertyNames(value)) {
       if (Object.hasOwn(value, key)) {
-        // @ts-ignore - This is always going to be defined
+        // @ts-expect-error - This is always going to be defined
         error[key] = value[key];
       }
     }

package/src/replacers/http-client-request.js

@@ -1,6 +1,10 @@
+/**
+ * @import { Replacer } from '../replacer.js';
+ */
+
 import { ClientRequest } from 'node:http';
 
-/** @type {import('../replacer.js').Replacer<ClientRequest>} */
+/** @type {Replacer<ClientRequest>} */
 export const HttpClientRequestReplacer = {
   name: 'HttpClientRequest',
   shouldReplace: (input) => input instanceof ClientRequest,

package/src/replacers/http-incoming-message.js

@@ -1,11 +1,16 @@
+/**
+ * @import { ClientRequest } from 'node:http'
+ * @import { Replacer } from '../replacer.js'
+ */
+
 import { IncomingMessage } from 'node:http';
 
 /**
- * @type {import('../replacer.js').Replacer<
+ * @type {Replacer<
  *    IncomingMessage & {
  *      hostname?: string,
  *      originalUrl?: string,
- *      req?: import('node:http').ClientRequest
+ *      req?: ClientRequest
  *    }
  * >}
  */

package/src/replacers/http-server-response.js

@@ -1,6 +1,10 @@
+/**
+ * @import { Replacer } from '../replacer.js';
+ */
+
 import { ServerResponse, STATUS_CODES } from 'node:http';
 
-/** @type {import('../replacer.js').Replacer<ServerResponse>} */
+/** @type {Replacer<ServerResponse>} */
 export const HttpServerResponseReplacer = {
   name: 'HttpServerResponse',
   shouldReplace: (input) => input instanceof ServerResponse,

package/src/replacers/long-strings.js

@@ -1,6 +1,10 @@
+/**
+ * @import { Replacer } from '../replacer.js';
+ */
+
 import { environment } from '../utilities/environment.js';
 
-/** @type {import('../replacer.js').Replacer<string>} */
+/** @type {Replacer<string>} */
 export const LongStringReplacer = {
   name: 'LongString',
   shouldReplace: (input) => (

package/src/replacers/net-socket.js

@@ -1,6 +1,10 @@
+/**
+ * @import { Replacer } from '../replacer.js';
+ */
+
 import { Socket } from 'node:net';
 
-/** @type {import('../replacer.js').Replacer<Socket>} */
+/** @type {Replacer<Socket>} */
 export const NetSocketReplacer = {
   name: 'NetSocket',
   shouldReplace: (input) => input instanceof Socket,

package/src/replacers/secrets.js

@@ -1,7 +1,11 @@
+/**
+ * @import { Replacer } from '../replacer.js';
+ */
+
 import { environment } from '../utilities/environment.js';
 import { nodesToPath } from '../utilities/json-path.js';
 
-/** @type {import('../replacer.js').Replacer} */
+/** @type {Replacer} */
 export const SecretDelete = {
   name: 'SecretDelete',
   stopHere: true,
@@ -22,7 +26,7 @@ export const SecretDelete = {
   replace: () => null,
 };
 
-/** @type {import('../replacer.js').Replacer} */
+/** @type {Replacer} */
 export const SecretObscure = {
   name: 'SecretObscure',
   stopHere: true,

package/src/utilities/log-types.js

@@ -23,11 +23,19 @@ export const LogNames = Object.fromEntries(
   Object.entries(LogLevels).map(([ k, v ]) => [ v, k ]),
 );
 
-/** @typedef {keyof LogLevels} LogLevelNames */
-/** @typedef {LogLevels[LogLevelNames]} LogLevel */
+/**
+ * @typedef {keyof LogLevels} LogLevelNames
+ */
+/**
+ * @typedef {LogLevels[LogLevelNames]} LogLevel
+ */
 
-/** @typedef {import('./stacktrace.js').Callsite} Callsite */
-/** @typedef {import('../replacers/error.js').NormalisedError} NormalisedError */
+/**
+ * @typedef {import('./stacktrace.js').Callsite} Callsite
+ */
+/**
+ * @typedef {import('../replacers/error.js').NormalisedError} NormalisedError
+ */
 
 /**
  * @typedef {Object} LogInternal

package/src/utilities/parse-filters.js

@@ -34,7 +34,7 @@ export function parseFilters(filter = '', fallback = []) {
 
     // Allow for multi level wildcards at the start of a filter
     if (regex.startsWith(String.raw`.*\.`)) {
-      regex = `(?:.*\\.)?${regex.slice(4)}`;
+      regex = String.raw`(?:.*\.)?${regex.slice(4)}`;
     }
 
     const pattern = new RegExp(`^${regex}$`);

package/src/utilities/parse-log-level.js

@@ -1,10 +1,14 @@
+/**
+ * @import { LogLevel } from './log-types.js';
+ */
+
 import { LogLevels } from './log-types.js';
 
 /**
  * Convert a given string to a LogLevel.
  * @param {string} [input] - The string to convert.
  * @param {string} [node] - The current NODE_ENV.
- * @returns {import('./log-types.js').LogLevel}
+ * @returns {LogLevel}
  */
 export function parseLogLevel(input, node) {
   switch (input) {

package/types/create-logger.d.ts

@@ -1,5 +1,6 @@
 /**
  * @param {string} [channel] - The logging channel.
- * @returns {import('./logger.js').Logger}
+ * @returns {Logger}
  */
-export function createLogger(channel?: string): import("./logger.js").Logger;
+export function createLogger(channel?: string): Logger;
+import { Logger } from './logger.js';

package/types/logger.d.ts

@@ -1,18 +1,18 @@
 /**
  * @typedef {Object} Options
  * @property {typeof replace} [replace] - The replacer function to use.
- * @property {import('./replacer.js').Replacer<any, any>[]} [replacers] - The replacers to use in the replacer.
+ * @property {Replacer[]} [replacers] - The replacers to use in the replacer.
  * @property {typeof formatter} [format] - The formatter function to use (eg console or json formatter).
  * @property {typeof stdoutWrite} [write] - The place to write the log to.
  */
 export class Logger {
-    /** @type {AsyncLocalStorage<import('./utilities/log-types.js').LogContext[]>} */
-    static storage: AsyncLocalStorage<import("./utilities/log-types.js").LogContext[]>;
+    /** @type {AsyncLocalStorage<LogContext[]>} */
+    static storage: AsyncLocalStorage<LogContext[]>;
     /**
-     * @param {import('./utilities/log-types.js').LogContext} context - Context to bind ot the async context.
+     * @param {LogContext} context - Context to bind ot the async context.
      * @returns {void}
      */
-    static addAsyncContext(context: import("./utilities/log-types.js").LogContext): void;
+    static addAsyncContext(context: LogContext): void;
     /**
      * @template [R=unknown]
      * @overload
@@ -23,18 +23,18 @@ export class Logger {
     /**
      * @template [R=unknown]
      * @overload
-     * @param {import('./utilities/log-types.js').LogContext} context - Context to bind ot the async context.
+     * @param {LogContext} context - Context to bind ot the async context.
      * @param {() => R} callback - The function to wrap the context in.
      * @returns {R}
      */
-    static wrap<R = unknown>(context: import("./utilities/log-types.js").LogContext, callback: () => R): R;
+    static wrap<R = unknown>(context: LogContext, callback: () => R): R;
     /**
-     * @param {import('./utilities/log-types.js').LogContext} [context] - Context to add to the logger.
+     * @param {LogContext} [context] - Context to add to the logger.
      * @param {Options} [options] - Options for the loggers output.
      */
-    constructor(context?: import("./utilities/log-types.js").LogContext, options?: Options);
-    /** @type {import('./replacer.js').Replacer[]} */
-    replacers: import("./replacer.js").Replacer[];
+    constructor(context?: LogContext, options?: Options);
+    /** @type {Replacer[]} */
+    replacers: Replacer[];
     /**
      * Set the channel in the new logger.
      * @param {string} channel - The channel name.
@@ -44,48 +44,48 @@ export class Logger {
     /**
      * Creating a new logger with {context, ...this.context}.
      * @overload
-     * @param {import('./utilities/log-types.js').LogContext} context - The new context.
+     * @param {LogContext} context - The new context.
      * @returns {Logger}
      */
-    context(context: import("./utilities/log-types.js").LogContext): Logger;
+    context(context: LogContext): Logger;
     /**
      * Creating a new logger with {context, ...this.context}.
      * @overload
-     * @param {import('./utilities/log-types.js').LogContext} context - The new context.
-     * @param {import('./utilities/log-types.js').LogLevel} level - The log level at which we allow this context.
+     * @param {LogContext} context - The new context.
+     * @param {LogLevel} level - The log level at which we allow this context.
      * @returns {Logger}
      */
-    context(context: import("./utilities/log-types.js").LogContext, level: import("./utilities/log-types.js").LogLevel): Logger;
+    context(context: LogContext, level: LogLevel): Logger;
     /**
      * Creating a new logger with {context, ...this.context}.
      * @overload
-     * @param {import('./utilities/log-types.js').LogLevel} level - The log level at which we allow this context.
-     * @param {import('./utilities/log-types.js').LogContext} context - The new context.
+     * @param {LogLevel} level - The log level at which we allow this context.
+     * @param {LogContext} context - The new context.
      * @returns {Logger}
      */
-    context(level: import("./utilities/log-types.js").LogLevel, context: import("./utilities/log-types.js").LogContext): Logger;
+    context(level: LogLevel, context: LogContext): Logger;
     /**
      * Write a log with the level 'critical' - A crucial part of the application is not working.
      *
      * @param {Error | string} message - The message to log.
-     * @param {import('./utilities/log-types.js').LogContext} [context] - Additional context.
+     * @param {LogContext} [context] - Additional context.
      * @returns {void}
      */
-    critical(message: Error | string, context?: import("./utilities/log-types.js").LogContext): void;
+    critical(message: Error | string, context?: LogContext): void;
     /**
      * Write a log with the level 'debug' - Information that is unlikely to help in production.
      * @param {Error | string} message - The message to log.
-     * @param {import('./utilities/log-types.js').LogContext} [context] - Additional context.
+     * @param {LogContext} [context] - Additional context.
      * @returns {void}
      */
-    debug(message: Error | string, context?: import("./utilities/log-types.js").LogContext): void;
+    debug(message: Error | string, context?: LogContext): void;
     /**
      * Write a log with the level 'error' - A non critical operation fails.
      * @param {Error | string} message - The message to log.
-     * @param {import('./utilities/log-types.js').LogContext} [context] - Additional context.
+     * @param {LogContext} [context] - Additional context.
      * @returns {void}
      */
-    error(message: Error | string, context?: import("./utilities/log-types.js").LogContext): void;
+    error(message: Error | string, context?: LogContext): void;
     /**
      * Get a value from the context by key.
      * @param {string} key - The key to get from the context.
@@ -95,17 +95,17 @@ export class Logger {
     /**
      * Write a log with the level 'info' - Information about successful operations.
      * @param {Error | string} message - The message to log.
-     * @param {import('./utilities/log-types.js').LogContext} [context] - Additional context.
+     * @param {LogContext} [context] - Additional context.
      * @returns {void}
      */
-    info(message: Error | string, context?: import("./utilities/log-types.js").LogContext): void;
+    info(message: Error | string, context?: LogContext): void;
     /**
      * Write a log with the level 'notice' - Information about events that may be unusual.
      * @param {Error | string} message - The message to log.
-     * @param {import('./utilities/log-types.js').LogContext} [context] - Additional context.
+     * @param {LogContext} [context] - Additional context.
      * @returns {void}
      */
-    notice(message: Error | string, context?: import("./utilities/log-types.js").LogContext): void;
+    notice(message: Error | string, context?: LogContext): void;
     /**
      * Set a value into a new context by key.
      * @param {string} key - The key to set.
@@ -116,10 +116,10 @@ export class Logger {
     /**
      * Write a log with the level 'silly' - Information to help resolve complex logic issues.
      * @param {Error | string} message - The message to log.
-     * @param {import('./utilities/log-types.js').LogContext} [context] - Additional context.
+     * @param {LogContext} [context] - Additional context.
      * @returns {void}
      */
-    silly(message: Error | string, context?: import("./utilities/log-types.js").LogContext): void;
+    silly(message: Error | string, context?: LogContext): void;
     /**
      * Set the trail in the new logger.
      * @param {string} [trail] - The trail id.
@@ -129,10 +129,10 @@ export class Logger {
     /**
      * Write a log with the level 'warning' - An operation might fail in the future.
      * @param {Error | string} message - The message to log.
-     * @param {import('./utilities/log-types.js').LogContext} [context] - Additional context.
+     * @param {LogContext} [context] - Additional context.
      * @returns {void}
      */
-    warning(message: Error | string, context?: import("./utilities/log-types.js").LogContext): void;
+    warning(message: Error | string, context?: LogContext): void;
     /**
      * @template [R=unknown]
      * @param {() => R} callback - The function to wrap the context in.
@@ -141,12 +141,12 @@ export class Logger {
     wrap<R = unknown>(callback: () => R): R;
     /**
      * Write a new log entry.
-     * @param {import('./utilities/log-types.js').LogLevel} level - The log level of the message to log.
+     * @param {LogLevel} level - The log level of the message to log.
      * @param {Error | string} message - The message to log.
-     * @param {import('./utilities/log-types.js').LogContext} [context] - Context to add to the log (merged with this.context, and Logger.contexts).
+     * @param {LogContext} [context] - Context to add to the log (merged with this.context, and Logger.contexts).
      * @returns {void}
      */
-    write(level: import("./utilities/log-types.js").LogLevel, message: Error | string, context?: import("./utilities/log-types.js").LogContext): void;
+    write(level: LogLevel, message: Error | string, context?: LogContext): void;
     #private;
 }
 export type Options = {
@@ -157,7 +157,7 @@ export type Options = {
     /**
      * - The replacers to use in the replacer.
      */
-    replacers?: import("./replacer.js").Replacer<any, any>[];
+    replacers?: Replacer[];
     /**
      * - The formatter function to use (eg console or json formatter).
      */
@@ -167,6 +167,9 @@ export type Options = {
      */
     write?: typeof stdoutWrite;
 };
+import type { Replacer } from './replacer.js';
+import type { LogContext } from './utilities/log-types.js';
+import type { LogLevel } from './utilities/log-types.js';
 import { AsyncLocalStorage } from 'node:async_hooks';
 import { replace } from './replacer.js';
 import { formatter } from './formatter.js';

package/types/replacer.d.ts

@@ -1,5 +1,5 @@
 /**
- * @template [T=unknown]
+ * @template [T=any]
  * @template [O=unknown]
  * @typedef {Object} Replacer
  * @property {string} name - The name of the replacer.
@@ -13,7 +13,7 @@
  * @returns {unknown}
  */
 export function replace(object: unknown, replacers?: Replacer[]): unknown;
-export type Replacer<T = unknown, O = unknown> = {
+export type Replacer<T = any, O = unknown> = {
     /**
      * - The name of the replacer.
      */

package/types/replacers/buffers.d.ts

@@ -1,2 +1,3 @@
-/** @type {import('../replacer.js').Replacer<Buffer>} */
-export const BufferReplacer: import("../replacer.js").Replacer<Buffer>;
+/** @type {Replacer<Buffer>} */
+export const BufferReplacer: Replacer<Buffer>;
+import type { Replacer } from '../replacer.js';

package/types/replacers/error.d.ts

@@ -7,8 +7,8 @@
 /**
  * @typedef {BaseError & { [k: string]: unknown }} NormalisedError
  */
-/** @type {import('../replacer.js').Replacer<Error, NormalisedError>} */
-export const ErrorReplacer: import("../replacer.js").Replacer<Error, NormalisedError>;
+/** @type {Replacer<Error, NormalisedError>} */
+export const ErrorReplacer: Replacer<Error, NormalisedError>;
 export type BaseError = {
     /**
      * - The error type or name.
@@ -26,3 +26,4 @@ export type BaseError = {
 export type NormalisedError = BaseError & {
     [k: string]: unknown;
 };
+import type { Replacer } from '../replacer.js';

package/types/replacers/http-client-request.d.ts

@@ -1,3 +1,4 @@
-/** @type {import('../replacer.js').Replacer<ClientRequest>} */
-export const HttpClientRequestReplacer: import("../replacer.js").Replacer<ClientRequest>;
+/** @type {Replacer<ClientRequest>} */
+export const HttpClientRequestReplacer: Replacer<ClientRequest>;
 import { ClientRequest } from 'node:http';
+import type { Replacer } from '../replacer.js';

package/types/replacers/http-incoming-message.d.ts

@@ -1,15 +1,17 @@
 /**
- * @type {import('../replacer.js').Replacer<
+ * @type {Replacer<
  *    IncomingMessage & {
  *      hostname?: string,
  *      originalUrl?: string,
- *      req?: import('node:http').ClientRequest
+ *      req?: ClientRequest
  *    }
  * >}
  */
-export const HttpIncomingMessageReplacer: import("../replacer.js").Replacer<IncomingMessage & {
+export const HttpIncomingMessageReplacer: Replacer<IncomingMessage & {
     hostname?: string;
     originalUrl?: string;
-    req?: import("node:http").ClientRequest;
+    req?: ClientRequest;
 }>;
 import { IncomingMessage } from 'node:http';
+import type { ClientRequest } from 'node:http';
+import type { Replacer } from '../replacer.js';

package/types/replacers/http-server-response.d.ts

@@ -1,3 +1,4 @@
-/** @type {import('../replacer.js').Replacer<ServerResponse>} */
-export const HttpServerResponseReplacer: import("../replacer.js").Replacer<ServerResponse>;
+/** @type {Replacer<ServerResponse>} */
+export const HttpServerResponseReplacer: Replacer<ServerResponse>;
 import { ServerResponse } from 'node:http';
+import type { Replacer } from '../replacer.js';

package/types/replacers/long-strings.d.ts

@@ -1,2 +1,3 @@
-/** @type {import('../replacer.js').Replacer<string>} */
-export const LongStringReplacer: import("../replacer.js").Replacer<string>;
+/** @type {Replacer<string>} */
+export const LongStringReplacer: Replacer<string>;
+import type { Replacer } from '../replacer.js';

package/types/replacers/net-socket.d.ts

@@ -1,3 +1,4 @@
-/** @type {import('../replacer.js').Replacer<Socket>} */
-export const NetSocketReplacer: import("../replacer.js").Replacer<Socket>;
+/** @type {Replacer<Socket>} */
+export const NetSocketReplacer: Replacer<Socket>;
 import { Socket } from 'node:net';
+import type { Replacer } from '../replacer.js';

package/types/replacers/secrets.d.ts

@@ -1,4 +1,5 @@
-/** @type {import('../replacer.js').Replacer} */
-export const SecretDelete: import("../replacer.js").Replacer;
-/** @type {import('../replacer.js').Replacer} */
-export const SecretObscure: import("../replacer.js").Replacer;
+/** @type {Replacer} */
+export const SecretDelete: Replacer;
+/** @type {Replacer} */
+export const SecretObscure: Replacer;
+import type { Replacer } from '../replacer.js';

package/types/utilities/parse-log-level.d.ts

@@ -2,6 +2,7 @@
  * Convert a given string to a LogLevel.
  * @param {string} [input] - The string to convert.
  * @param {string} [node] - The current NODE_ENV.
- * @returns {import('./log-types.js').LogLevel}
+ * @returns {LogLevel}
  */
-export function parseLogLevel(input?: string, node?: string): import("./log-types.js").LogLevel;
+export function parseLogLevel(input?: string, node?: string): LogLevel;
+import type { LogLevel } from './log-types.js';