@wgtechlabs/log-engine 1.2.0 → 1.3.0

package/dist/logger.js

@@ -4,26 +4,53 @@
  * Supports DEBUG, INFO, WARN, ERROR, and LOG levels with intelligent filtering
  * LOG level always outputs regardless of configuration
  * Uses colorized console output with timestamps for better readability
+ * Includes automatic data redaction for sensitive information
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Logger = void 0;
 const types_1 = require("./types");
 const formatter_1 = require("./formatter");
+const redaction_1 = require("./redaction");
 /**
  * Logger class responsible for managing log output and configuration
  * Provides mode-based filtering and formatted console output
  */
 class Logger {
+    /**
+     * Logger constructor - sets up environment-based auto-configuration
+     */
     constructor() {
         // Internal configuration state with sensible defaults
         this.config = {
             mode: types_1.LogMode.INFO
         };
+        // Set initial mode based on NODE_ENV for auto-configuration
+        this.config.mode = this.getEnvironmentMode();
+    }
+    /**
+     * Determines the appropriate log mode based on NODE_ENV
+     * @returns LogMode appropriate for current environment
+     */
+    getEnvironmentMode() {
+        const nodeEnv = process.env.NODE_ENV;
+        switch (nodeEnv) {
+            case 'development':
+                return types_1.LogMode.DEBUG; // Verbose logging for development
+            case 'production':
+                return types_1.LogMode.INFO; // Important info and above for production
+            case 'staging':
+                return types_1.LogMode.WARN; // Focused logging for staging
+            case 'test':
+                return types_1.LogMode.ERROR; // Minimal logging during tests
+            default:
+                return types_1.LogMode.INFO; // Default fallback for unknown environments
+        }
     }
     /**
      * Updates logger configuration with new settings
      * Merges provided config with existing settings (partial update)
      * Supports backwards compatibility by mapping level to mode with deprecation warnings
+     * Also updates redaction configuration based on environment
      * @param config - Partial configuration object to apply
      */
     configure(config) {
@@ -57,6 +84,11 @@ class Logger {
             // Normal configuration update
             this.config = { ...this.config, ...config };
         }
+        // Update redaction configuration based on current environment
+        redaction_1.DataRedactor.updateConfig({
+            ...redaction_1.defaultRedactionConfig,
+            ...redaction_1.RedactionController.getEnvironmentConfig()
+        });
     }
     /**
      * Determines if a message should be logged based on current log mode
@@ -78,44 +110,56 @@ class Logger {
     /**
      * Log a debug message with DEBUG level formatting
      * Uses console.log for output with purple/magenta coloring
+     * Automatically redacts sensitive data when provided
      * @param message - The debug message to log
+     * @param data - Optional data object to log (will be redacted)
      */
-    debug(message) {
+    debug(message, data) {
         if (this.shouldLog(types_1.LogLevel.DEBUG)) {
-            const formatted = formatter_1.LogFormatter.format(types_1.LogLevel.DEBUG, message);
+            const processedData = redaction_1.DataRedactor.redactData(data);
+            const formatted = formatter_1.LogFormatter.format(types_1.LogLevel.DEBUG, message, processedData);
             console.log(formatted);
         }
     }
     /**
      * Log an informational message with INFO level formatting
      * Uses console.log for output with blue coloring
+     * Automatically redacts sensitive data when provided
      * @param message - The info message to log
+     * @param data - Optional data object to log (will be redacted)
      */
-    info(message) {
+    info(message, data) {
         if (this.shouldLog(types_1.LogLevel.INFO)) {
-            const formatted = formatter_1.LogFormatter.format(types_1.LogLevel.INFO, message);
+            const processedData = redaction_1.DataRedactor.redactData(data);
+            const formatted = formatter_1.LogFormatter.format(types_1.LogLevel.INFO, message, processedData);
             console.log(formatted);
         }
     }
     /**
      * Log a warning message with WARN level formatting
      * Uses console.warn for output with yellow coloring
+     * Automatically redacts sensitive data when provided
      * @param message - The warning message to log
+     * @param data - Optional data object to log (will be redacted)
      */
-    warn(message) {
+    warn(message, data) {
         if (this.shouldLog(types_1.LogLevel.WARN)) {
-            const formatted = formatter_1.LogFormatter.format(types_1.LogLevel.WARN, message);
+            const processedData = redaction_1.DataRedactor.redactData(data);
+            const formatted = formatter_1.LogFormatter.format(types_1.LogLevel.WARN, message, processedData);
             console.warn(formatted);
         }
     }
     /**
      * Log an error message with ERROR level formatting
      * Uses console.error for output with red coloring
+     * Automatically redacts sensitive data when provided
      * @param message - The error message to log
+     * @param data - Optional data object to log (will be redacted)
      */
-    error(message) {
+    error(message, data) {
         if (this.shouldLog(types_1.LogLevel.ERROR)) {
-            const formatted = formatter_1.LogFormatter.format(types_1.LogLevel.ERROR, message);
+            const processedData = redaction_1.DataRedactor.redactData(data);
+            const formatted = formatter_1.LogFormatter.format(types_1.LogLevel.ERROR, message, processedData);
             console.error(formatted);
         }
     }
@@ -123,11 +167,74 @@ class Logger {
      * Log a critical message that always outputs (LOG level)
      * Uses console.log for output with green coloring
      * Always shown regardless of configured log level
+     * Automatically redacts sensitive data when provided
+     * @param message - The critical log message to log
+     * @param data - Optional data object to log (will be redacted)
+     */
+    log(message, data) {
+        if (this.shouldLog(types_1.LogLevel.LOG)) {
+            const processedData = redaction_1.DataRedactor.redactData(data);
+            const formatted = formatter_1.LogFormatter.format(types_1.LogLevel.LOG, message, processedData);
+            console.log(formatted);
+        }
+    }
+    /**
+     * Log a debug message without redaction (use with caution)
+     * Bypasses automatic data redaction for debugging purposes
+     * @param message - The debug message to log
+     * @param data - Optional data object to log (no redaction applied)
+     */
+    debugRaw(message, data) {
+        if (this.shouldLog(types_1.LogLevel.DEBUG)) {
+            const formatted = formatter_1.LogFormatter.format(types_1.LogLevel.DEBUG, message, data);
+            console.log(formatted);
+        }
+    }
+    /**
+     * Log an info message without redaction (use with caution)
+     * Bypasses automatic data redaction for debugging purposes
+     * @param message - The info message to log
+     * @param data - Optional data object to log (no redaction applied)
+     */
+    infoRaw(message, data) {
+        if (this.shouldLog(types_1.LogLevel.INFO)) {
+            const formatted = formatter_1.LogFormatter.format(types_1.LogLevel.INFO, message, data);
+            console.log(formatted);
+        }
+    }
+    /**
+     * Log a warning message without redaction (use with caution)
+     * Bypasses automatic data redaction for debugging purposes
+     * @param message - The warning message to log
+     * @param data - Optional data object to log (no redaction applied)
+     */
+    warnRaw(message, data) {
+        if (this.shouldLog(types_1.LogLevel.WARN)) {
+            const formatted = formatter_1.LogFormatter.format(types_1.LogLevel.WARN, message, data);
+            console.warn(formatted);
+        }
+    }
+    /**
+     * Log an error message without redaction (use with caution)
+     * Bypasses automatic data redaction for debugging purposes
+     * @param message - The error message to log
+     * @param data - Optional data object to log (no redaction applied)
+     */
+    errorRaw(message, data) {
+        if (this.shouldLog(types_1.LogLevel.ERROR)) {
+            const formatted = formatter_1.LogFormatter.format(types_1.LogLevel.ERROR, message, data);
+            console.error(formatted);
+        }
+    }
+    /**
+     * Log a critical message without redaction (use with caution)
+     * Bypasses automatic data redaction for debugging purposes
      * @param message - The critical log message to log
+     * @param data - Optional data object to log (no redaction applied)
      */
-    log(message) {
+    logRaw(message, data) {
         if (this.shouldLog(types_1.LogLevel.LOG)) {
-            const formatted = formatter_1.LogFormatter.format(types_1.LogLevel.LOG, message);
+            const formatted = formatter_1.LogFormatter.format(types_1.LogLevel.LOG, message, data);
             console.log(formatted);
         }
     }

package/dist/redaction/config.d.ts

@@ -0,0 +1,29 @@
+/**
+ * Default configuration and constants for data redaction
+ * Provides comprehensive coverage of common sensitive field patterns
+ */
+import { RedactionConfig } from '../types';
+/**
+ * Default redaction configuration with comprehensive sensitive field detection
+ * Covers authentication, personal information, financial data, and internal systems
+ */
+export declare const defaultRedactionConfig: RedactionConfig;
+/**
+ * Environment-based redaction controller
+ * Determines when redaction should be disabled based on environment variables
+ */
+export declare class RedactionController {
+    /**
+     * Check if redaction should be disabled based on environment variables
+     * Development mode and explicit flags can disable redaction for debugging
+     * @returns true if redaction should be disabled, false otherwise
+     */
+    static isRedactionDisabled(): boolean;
+    /**
+     * Get environment-specific configuration overrides
+     * Allows customization through environment variables
+     * @returns Partial redaction config with environment-based overrides
+     */
+    static getEnvironmentConfig(): Partial<RedactionConfig>;
+}
+//# sourceMappingURL=config.d.ts.map

package/dist/redaction/config.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../../src/redaction/config.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,eAAe,EAAE,MAAM,UAAU,CAAC;AAE3C;;;GAGG;AACH,eAAO,MAAM,sBAAsB,EAAE,eAyCpC,CAAC;AAEF;;;GAGG;AACH,qBAAa,mBAAmB;IAC5B;;;;OAIG;IACH,MAAM,CAAC,mBAAmB,IAAI,OAAO;IAUrC;;;;OAIG;IACH,MAAM,CAAC,oBAAoB,IAAI,OAAO,CAAC,eAAe,CAAC;CA4B1D"}

package/dist/redaction/config.js

@@ -0,0 +1,95 @@
+"use strict";
+/**
+ * Default configuration and constants for data redaction
+ * Provides comprehensive coverage of common sensitive field patterns
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RedactionController = exports.defaultRedactionConfig = void 0;
+/**
+ * Default redaction configuration with comprehensive sensitive field detection
+ * Covers authentication, personal information, financial data, and internal systems
+ */
+exports.defaultRedactionConfig = {
+    enabled: true,
+    deepRedaction: true,
+    maxContentLength: 100,
+    redactionText: '[REDACTED]',
+    truncationText: '... [TRUNCATED]',
+    // Comprehensive list of sensitive field patterns (case-insensitive)
+    sensitiveFields: [
+        // Authentication & Security
+        'password', 'pwd', 'pass', 'passphrase',
+        'token', 'accessToken', 'refreshToken', 'bearerToken',
+        'apiKey', 'api_key', 'secret', 'secretKey', 'privateKey',
+        'auth', 'authorization', 'authToken',
+        'jwt', 'sessionId', 'session_id',
+        'cookie', 'cookies', 'csrf', 'csrfToken',
+        // Personal Information (PII)
+        'email', 'emailAddress', 'email_address',
+        'phone', 'phoneNumber', 'phone_number', 'mobile',
+        'ssn', 'socialSecurityNumber', 'social_security_number',
+        'address', 'homeAddress', 'workAddress',
+        'firstName', 'lastName', 'fullName', 'realName', 'displayName',
+        'dateOfBirth', 'dob', 'birthDate',
+        // Financial Information
+        'creditCard', 'credit_card', 'cardNumber', 'card_number',
+        'cvv', 'cvc', 'pin', 'expiryDate', 'expiry_date',
+        'bankAccount', 'bank_account', 'routingNumber',
+        // Internal/System Information
+        'internalId', 'userId', 'customerId',
+        'personalInfo', 'pii', 'sensitive',
+        'clientSecret', 'webhookSecret'
+    ],
+    // Fields that should be truncated rather than redacted
+    contentFields: [
+        'content', 'text', 'message', 'body', 'data',
+        'payload', 'response', 'request', 'description'
+    ]
+};
+/**
+ * Environment-based redaction controller
+ * Determines when redaction should be disabled based on environment variables
+ */
+class RedactionController {
+    /**
+     * Check if redaction should be disabled based on environment variables
+     * Development mode and explicit flags can disable redaction for debugging
+     * @returns true if redaction should be disabled, false otherwise
+     */
+    static isRedactionDisabled() {
+        return (process.env.NODE_ENV === 'development' ||
+            process.env.LOG_REDACTION_DISABLED === 'true' ||
+            process.env.DEBUG_FULL_PAYLOADS === 'true' ||
+            process.env.LOG_LEVEL === 'debug' ||
+            process.env.LOG_REDACTION_ENABLED === 'false');
+    }
+    /**
+     * Get environment-specific configuration overrides
+     * Allows customization through environment variables
+     * @returns Partial redaction config with environment-based overrides
+     */
+    static getEnvironmentConfig() {
+        const envConfig = {
+            enabled: !this.isRedactionDisabled()
+        };
+        // Apply environment variable overrides if they exist
+        if (process.env.LOG_MAX_CONTENT_LENGTH) {
+            const parsedLength = parseInt(process.env.LOG_MAX_CONTENT_LENGTH, 10);
+            if (!isNaN(parsedLength) && parsedLength > 0) {
+                envConfig.maxContentLength = parsedLength;
+            }
+        }
+        if (process.env.LOG_REDACTION_TEXT) {
+            envConfig.redactionText = process.env.LOG_REDACTION_TEXT;
+        }
+        if (process.env.LOG_TRUNCATION_TEXT) {
+            envConfig.truncationText = process.env.LOG_TRUNCATION_TEXT;
+        }
+        if (process.env.LOG_SENSITIVE_FIELDS) {
+            const customFields = process.env.LOG_SENSITIVE_FIELDS.split(',').map(f => f.trim());
+            envConfig.sensitiveFields = [...exports.defaultRedactionConfig.sensitiveFields, ...customFields];
+        }
+        return envConfig;
+    }
+}
+exports.RedactionController = RedactionController;

package/dist/redaction/index.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Redaction module exports
+ * Provides centralized access to all redaction functionality
+ */
+export { DataRedactor } from './redactor';
+export { defaultRedactionConfig, RedactionController } from './config';
+export type { RedactionConfig } from '../types';
+//# sourceMappingURL=index.d.ts.map

package/dist/redaction/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/redaction/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AAC1C,OAAO,EAAE,sBAAsB,EAAE,mBAAmB,EAAE,MAAM,UAAU,CAAC;AACvE,YAAY,EAAE,eAAe,EAAE,MAAM,UAAU,CAAC"}

package/dist/redaction/index.js

@@ -0,0 +1,12 @@
+"use strict";
+/**
+ * Redaction module exports
+ * Provides centralized access to all redaction functionality
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RedactionController = exports.defaultRedactionConfig = exports.DataRedactor = void 0;
+var redactor_1 = require("./redactor");
+Object.defineProperty(exports, "DataRedactor", { enumerable: true, get: function () { return redactor_1.DataRedactor; } });
+var config_1 = require("./config");
+Object.defineProperty(exports, "defaultRedactionConfig", { enumerable: true, get: function () { return config_1.defaultRedactionConfig; } });
+Object.defineProperty(exports, "RedactionController", { enumerable: true, get: function () { return config_1.RedactionController; } });

package/dist/redaction/redactor.d.ts

@@ -0,0 +1,99 @@
+/**
+ * Core data redaction engine
+ * Handles automatic detection and redaction of sensitive information in log data
+ */
+import { RedactionConfig } from '../types';
+/**
+ * DataRedactor class - Core redaction logic for processing log data
+ * Automatically detects and redacts sensitive information while preserving structure
+ */
+export declare class DataRedactor {
+    private static config;
+    private static readonly MAX_RECURSION_DEPTH;
+    private static readonly MAX_REDACT_OBJECT_DEPTH;
+    /**
+     * Update the redaction configuration with new settings
+     * Merges provided config with existing settings and reloads environment variables
+     * @param newConfig - Partial configuration to merge with current settings
+     */
+    static updateConfig(newConfig: Partial<RedactionConfig>): void;
+    /**
+     * Get the current redaction configuration
+     * @returns Deep copy of current redaction configuration
+     */
+    static getConfig(): RedactionConfig;
+    /**
+     * Refresh configuration from environment variables
+     * Useful for picking up runtime environment changes
+     */
+    static refreshConfig(): void;
+    /**
+     * Add custom regex patterns for advanced field detection
+     * @param patterns - Array of regex patterns to add
+     */
+    static addCustomPatterns(patterns: RegExp[]): void;
+    /**
+     * Clear all custom regex patterns
+     */
+    static clearCustomPatterns(): void;
+    /**
+     * Add custom sensitive field names to the existing list
+     * @param fields - Array of field names to add
+     */
+    static addSensitiveFields(fields: string[]): void;
+    /**
+     * Test if a field name would be redacted with current configuration
+     * @param fieldName - Field name to test
+     * @returns true if field would be redacted, false otherwise
+     */
+    static testFieldRedaction(fieldName: string): boolean;
+    /**
+     * Main entry point for data redaction
+     * Processes any type of data and returns a redacted version
+     * @param data - Data to be processed for redaction
+     * @returns Redacted version of the data
+     */
+    static redactData(data: any): any;
+    /**
+     * Process a value of any type (primitive, object, array)
+     * Recursively handles nested structures when deepRedaction is enabled
+     * Includes circular reference protection and recursion depth limiting
+     * @param value - Value to process
+     * @param visited - Set to track visited objects (prevents circular references)
+     * @param depth - Current recursion depth (prevents stack overflow)
+     * @returns Processed value with redaction applied
+     */
+    private static processValue;
+    /**
+     * Process an object and redact sensitive fields
+     * Handles field-level redaction and content truncation
+     * @param obj - Object to process
+     * @param visited - Set to track visited objects (prevents circular references)
+     * @param depth - Current recursion depth (prevents stack overflow)
+     * @returns Object with sensitive fields redacted
+     */
+    private static redactObject;
+    /**
+     * Check if a field name indicates sensitive information
+     * Uses case-insensitive matching with exact and partial matches
+     * Includes smart filtering to avoid false positives and custom patterns
+     * @param fieldName - Field name to check
+     * @returns true if field should be redacted, false otherwise
+     */
+    private static isSensitiveField;
+    /**
+     * Check if a field name indicates content that should be truncated
+     * Uses exact case-insensitive matching for content fields
+     * @param fieldName - Field name to check
+     * @returns true if field is a content field, false otherwise
+     */
+    private static isContentField;
+    /**
+     * Truncate content that exceeds the maximum length
+     * Preserves readability while preventing log bloat
+     * @param content - Content string to potentially truncate
+     * @returns Original content or truncated version with indicator
+     */
+    private static truncateContent;
+}
+//# sourceMappingURL=redactor.d.ts.map

package/dist/redaction/redactor.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"redactor.d.ts","sourceRoot":"","sources":["../../src/redaction/redactor.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,eAAe,EAAE,MAAM,UAAU,CAAC;AAG3C;;;GAGG;AACH,qBAAa,YAAY;IACrB,OAAO,CAAC,MAAM,CAAC,MAAM,CAGnB;IAGF,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,mBAAmB,CAAO;IAElD,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,uBAAuB,CAAM;IAErD;;;;OAIG;IACH,MAAM,CAAC,YAAY,CAAC,SAAS,EAAE,OAAO,CAAC,eAAe,CAAC,GAAG,IAAI;IAU9D;;;OAGG;IACH,MAAM,CAAC,SAAS,IAAI,eAAe;IASnC;;;OAGG;IACH,MAAM,CAAC,aAAa,IAAI,IAAI;IAQ5B;;;OAGG;IACH,MAAM,CAAC,iBAAiB,CAAC,QAAQ,EAAE,MAAM,EAAE,GAAG,IAAI;IAQlD;;OAEG;IACH,MAAM,CAAC,mBAAmB,IAAI,IAAI;IAOlC;;;OAGG;IACH,MAAM,CAAC,kBAAkB,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,IAAI;IAOjD;;;;OAIG;IACH,MAAM,CAAC,kBAAkB,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO;IAMrD;;;;;OAKG;IACH,MAAM,CAAC,UAAU,CAAC,IAAI,EAAE,GAAG,GAAG,GAAG;IASjC;;;;;;;;OAQG;IACH,OAAO,CAAC,MAAM,CAAC,YAAY;IAyC3B;;;;;;;OAOG;IACH,OAAO,CAAC,MAAM,CAAC,YAAY;IA8B3B;;;;;;OAMG;IACH,OAAO,CAAC,MAAM,CAAC,gBAAgB;IAgD/B;;;;;OAKG;IACH,OAAO,CAAC,MAAM,CAAC,cAAc;IAK7B;;;;;OAKG;IACH,OAAO,CAAC,MAAM,CAAC,eAAe;CAMjC"}