@decaf-ts/logging 0.10.0 → 0.10.2

package/lib/filters/LogFilter.d.ts

@@ -1,8 +1,8 @@
 import { Logger, LoggingConfig, LoggingFilter } from "../types";
 import { LoggedClass } from "../LoggedClass";
 /**
- * @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 {
@@ -26,18 +26,18 @@ import { LoggedClass } from "../LoggedClass";
  */
 export declare abstract class LogFilter extends LoggedClass implements LoggingFilter {
     /**
-     * @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(): Logger;
     /**
-     * @description Transform or suppress a log message.
-     * @summary Inspect the provided message and context to produce the value that will be forwarded to subsequent filters or emitters.
-     * @param {LoggingConfig} config - Active logging configuration.
-     * @param {string} message - Original log message payload.
-     * @param {string[]} context - Context values attached to the message.
-     * @return {string} Filtered message to pass to downstream processing.
+     * @description Transforms or suppresses a log message.
+     * @summary This method inspects the provided message and context to produce the value that will be forwarded to subsequent filters or emitters.
+     * @param {LoggingConfig} config - The active logging configuration.
+     * @param {string} message - The original log message payload.
+     * @param {string[]} context - The context values that are attached to the message.
+     * @return {string} The filtered message to pass to downstream processing.
      */
     abstract filter(config: LoggingConfig, message: string, context: string[]): string;
 }

package/lib/filters/PatternFilter.cjs

@@ -13,10 +13,10 @@ exports.PatternFilter = void 0;
 const LogFilter_1 = require("./LogFilter.cjs");
 const decorators_1 = require("./../decorators.cjs");
 /**
- * @description Filter that patches log messages using regular expressions.
- * @summary Applies a configured {@link RegExp} and replacement strategy to redact, mask, or restructure log payloads before they are emitted.
- * @param {RegExp} regexp - Expression used to detect sensitive or formatted text.
- * @param {string|ReplacementFunction} replacement - Replacement string or callback invoked for each match.
+ * @description A filter that patches log messages using regular expressions.
+ * @summary This class applies a configured {@link RegExp} and replacement strategy to redact, mask, or restructure log payloads before they are emitted.
+ * @param {RegExp} regexp - The expression to use for detecting sensitive or formatted text.
+ * @param {(string|ReplacementFunction)} replacement - The replacement string or a callback that is invoked for each match.
  * @class PatternFilter
  * @example
  * const filter = new PatternFilter(/token=[^&]+/g, "token=***");
@@ -46,9 +46,9 @@ class PatternFilter extends LogFilter_1.LogFilter {
     }
     /**
      * @description Ensures deterministic RegExp matching.
-     * @summary Runs the configured expression, then resets its state so repeated invocations behave consistently.
-     * @param {string} message - Message to test for matches.
-     * @return {RegExpExecArray|null} Match result or null when no match is found.
+     * @summary This method runs the configured expression, then resets its state so that repeated invocations behave consistently.
+     * @param {string} message - The message to test for matches.
+     * @return {(RegExpExecArray|null)} The match result, or null if no match is found.
      */
     match(message) {
         const match = this.regexp.exec(message);
@@ -57,11 +57,11 @@ class PatternFilter extends LogFilter_1.LogFilter {
     }
     /**
      * @description Applies the replacement strategy to the incoming message.
-     * @summary Executes {@link PatternFilter.match} and, when a match is found, replaces every occurrence using the configured replacement handler.
-     * @param {LoggingConfig} config - Active logging configuration (unused but part of the filter contract).
-     * @param {string} message - Message to be sanitized.
-     * @param {string[]} context - Context entries associated with the log event.
-     * @return {string} Sanitized log message.
+     * @summary This method executes {@link PatternFilter.match} and, when a match is found, replaces every occurrence using the configured replacement handler.
+     * @param {LoggingConfig} config - The active logging configuration (unused, but part of the filter contract).
+     * @param {string} message - The message to be sanitized.
+     * @param {string[]} context - The context entries that are associated with the log event.
+     * @return {string} The sanitized log message.
      */
     // eslint-disable-next-line @typescript-eslint/no-unused-vars
     filter(config, message, context) {

package/lib/filters/PatternFilter.d.ts

@@ -1,17 +1,17 @@
 import { LogFilter } from "./LogFilter";
 import { LoggingConfig } from "../types";
 /**
- * @description Replacement callback used to transform RegExp matches.
- * @summary Receives the matched substring and additional capture arguments, returning the replacement text that will be injected into the log message.
- * @typedef {function(string, any[]): string} ReplacementFunction
+ * @description A replacement callback that is used to transform RegExp matches.
+ * @summary This function receives the matched substring and additional capture arguments, and returns the replacement text that will be injected into the log message.
+ * @typedef {function(string, ...any): string} ReplacementFunction
  * @memberOf module:Logging
  */
 export type ReplacementFunction = (substring: string, ...args: any[]) => string;
 /**
- * @description Filter that patches log messages using regular expressions.
- * @summary Applies a configured {@link RegExp} and replacement strategy to redact, mask, or restructure log payloads before they are emitted.
- * @param {RegExp} regexp - Expression used to detect sensitive or formatted text.
- * @param {string|ReplacementFunction} replacement - Replacement string or callback invoked for each match.
+ * @description A filter that patches log messages using regular expressions.
+ * @summary This class applies a configured {@link RegExp} and replacement strategy to redact, mask, or restructure log payloads before they are emitted.
+ * @param {RegExp} regexp - The expression to use for detecting sensitive or formatted text.
+ * @param {(string|ReplacementFunction)} replacement - The replacement string or a callback that is invoked for each match.
  * @class PatternFilter
  * @example
  * const filter = new PatternFilter(/token=[^&]+/g, "token=***");
@@ -39,18 +39,18 @@ export declare class PatternFilter extends LogFilter {
     constructor(regexp: RegExp, replacement: string | ReplacementFunction);
     /**
      * @description Ensures deterministic RegExp matching.
-     * @summary Runs the configured expression, then resets its state so repeated invocations behave consistently.
-     * @param {string} message - Message to test for matches.
-     * @return {RegExpExecArray|null} Match result or null when no match is found.
+     * @summary This method runs the configured expression, then resets its state so that repeated invocations behave consistently.
+     * @param {string} message - The message to test for matches.
+     * @return {(RegExpExecArray|null)} The match result, or null if no match is found.
      */
     protected match(message: string): RegExpExecArray | null;
     /**
      * @description Applies the replacement strategy to the incoming message.
-     * @summary Executes {@link PatternFilter.match} and, when a match is found, replaces every occurrence using the configured replacement handler.
-     * @param {LoggingConfig} config - Active logging configuration (unused but part of the filter contract).
-     * @param {string} message - Message to be sanitized.
-     * @param {string[]} context - Context entries associated with the log event.
-     * @return {string} Sanitized log message.
+     * @summary This method executes {@link PatternFilter.match} and, when a match is found, replaces every occurrence using the configured replacement handler.
+     * @param {LoggingConfig} config - The active logging configuration (unused, but part of the filter contract).
+     * @param {string} message - The message to be sanitized.
+     * @param {string[]} context - The context entries that are associated with the log event.
+     * @return {string} The sanitized log message.
      */
     filter(config: LoggingConfig, message: string, context: string[]): string;
 }

package/lib/index.cjs

@@ -27,9 +27,9 @@ __exportStar(require("./types.cjs"), exports);
 __exportStar(require("./web.cjs"), exports);
 __exportStar(require("./utils.cjs"), exports);
 /**
- * @description Comprehensive logging toolkit for browser and Node environments.
- * @summary Exposes {@link Logging} and {@link MiniLogger} for runtime logging, decorators such as {@link log} for method instrumentation, and utilities like {@link PatternFilter}, {@link StopWatch}, and {@link LoggedEnvironment} to build configurable, theme-aware log pipelines.
  * @module Logging
+ * @description A comprehensive and versatile logging toolkit for both browser and Node.js environments.
+ * @summary This module provides a complete logging solution, exposing {@link Logging} and {@link MiniLogger} for runtime logging. It also includes decorators like {@link log} for method instrumentation, and various utilities such as {@link PatternFilter}, {@link StopWatch}, and {@link LoggedEnvironment} to help build configurable and theme-aware log pipelines.
  */
 /**
  * @description Current package version string.
@@ -38,7 +38,7 @@ __exportStar(require("./utils.cjs"), exports);
  * @type {string}
  * @memberOf module:Logging
  */
-exports.VERSION = "0.9.11";
+exports.VERSION = "0.10.1";
 /**
  * @description Current package version string.
  * @summary Stores the package version for diagnostics and compatibility checks.

package/lib/index.d.ts

@@ -10,9 +10,9 @@ export * from "./types";
 export * from "./web";
 export * from "./utils";
 /**
- * @description Comprehensive logging toolkit for browser and Node environments.
- * @summary Exposes {@link Logging} and {@link MiniLogger} for runtime logging, decorators such as {@link log} for method instrumentation, and utilities like {@link PatternFilter}, {@link StopWatch}, and {@link LoggedEnvironment} to build configurable, theme-aware log pipelines.
  * @module Logging
+ * @description A comprehensive and versatile logging toolkit for both browser and Node.js environments.
+ * @summary This module provides a complete logging solution, exposing {@link Logging} and {@link MiniLogger} for runtime logging. It also includes decorators like {@link log} for method instrumentation, and various utilities such as {@link PatternFilter}, {@link StopWatch}, and {@link LoggedEnvironment} to help build configurable and theme-aware log pipelines.
  */
 /**
  * @description Current package version string.