@wgtechlabs/log-engine 2.0.0 → 2.1.0

package/dist/index.js

@@ -32,155 +32,155 @@ const logger = new logger_1.Logger();
  */
 exports.LogEngine = {
     /**
-     * Configure the logger with new settings
-     * @param config - Configuration object containing logger settings
-     * @example
-     * ```typescript
-     * LogEngine.configure({ mode: LogMode.PRODUCTION });
-     * ```
-     */
+       * Configure the logger with new settings
+       * @param config - Configuration object containing logger settings
+       * @example
+       * ```typescript
+       * LogEngine.configure({ mode: LogMode.PRODUCTION });
+       * ```
+       */
     configure: (config) => logger.configure(config),
     // Standard logging methods with automatic redaction
     /**
-     * Log a debug message with automatic data redaction
-     * Only shown in DEVELOPMENT mode
-     * @param message - The debug message to log
-     * @param data - Optional data object to log (sensitive data will be redacted)
-     * @example
-     * ```typescript
-     * LogEngine.debug('Processing user data', { userId: 123, email: 'user@example.com' });
-     * ```
-     */
+       * Log a debug message with automatic data redaction
+       * Only shown in DEVELOPMENT mode
+       * @param message - The debug message to log
+       * @param data - Optional data object to log (sensitive data will be redacted)
+       * @example
+       * ```typescript
+       * LogEngine.debug('Processing user data', { userId: 123, email: 'user@example.com' });
+       * ```
+       */
     debug: (message, data) => logger.debug(message, data),
     /**
-     * Log an info message with automatic data redaction
-     * Shown in DEVELOPMENT and PRODUCTION modes
-     * @param message - The info message to log
-     * @param data - Optional data object to log (sensitive data will be redacted)
-     * @example
-     * ```typescript
-     * LogEngine.info('User login successful', { username: 'john' });
-     * ```
-     */
+       * Log an info message with automatic data redaction
+       * Shown in DEVELOPMENT and PRODUCTION modes
+       * @param message - The info message to log
+       * @param data - Optional data object to log (sensitive data will be redacted)
+       * @example
+       * ```typescript
+       * LogEngine.info('User login successful', { username: 'john' });
+       * ```
+       */
     info: (message, data) => logger.info(message, data),
     /**
-     * Log a warning message with automatic data redaction
-     * Shown in DEVELOPMENT and PRODUCTION modes
-     * @param message - The warning message to log
-     * @param data - Optional data object to log (sensitive data will be redacted)
-     * @example
-     * ```typescript
-     * LogEngine.warn('API rate limit approaching', { requestsRemaining: 10 });
-     * ```
-     */
+       * Log a warning message with automatic data redaction
+       * Shown in DEVELOPMENT and PRODUCTION modes
+       * @param message - The warning message to log
+       * @param data - Optional data object to log (sensitive data will be redacted)
+       * @example
+       * ```typescript
+       * LogEngine.warn('API rate limit approaching', { requestsRemaining: 10 });
+       * ```
+       */
     warn: (message, data) => logger.warn(message, data),
     /**
-     * Log an error message with automatic data redaction
-     * Shown in DEVELOPMENT and PRODUCTION modes
-     * @param message - The error message to log
-     * @param data - Optional data object to log (sensitive data will be redacted)
-     * @example
-     * ```typescript
-     * LogEngine.error('Database connection failed', { host: 'localhost', port: 5432 });
-     * ```
-     */
+       * Log an error message with automatic data redaction
+       * Shown in DEVELOPMENT and PRODUCTION modes
+       * @param message - The error message to log
+       * @param data - Optional data object to log (sensitive data will be redacted)
+       * @example
+       * ```typescript
+       * LogEngine.error('Database connection failed', { host: 'localhost', port: 5432 });
+       * ```
+       */
     error: (message, data) => logger.error(message, data),
     /**
-     * Log a critical message with automatic data redaction
-     * Always shown regardless of mode (except OFF)
-     * @param message - The critical log message to log
-     * @param data - Optional data object to log (sensitive data will be redacted)
-     * @example
-     * ```typescript
-     * LogEngine.log('Application starting', { version: '1.0.0' });
-     * ```
-     */
+       * Log a critical message with automatic data redaction
+       * Always shown regardless of mode (except OFF)
+       * @param message - The critical log message to log
+       * @param data - Optional data object to log (sensitive data will be redacted)
+       * @example
+       * ```typescript
+       * LogEngine.log('Application starting', { version: '1.0.0' });
+       * ```
+       */
     log: (message, data) => logger.log(message, data),
     // Raw methods that bypass redaction (use with caution)
     /**
-     * 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)
-     */
+       * 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) => logger.debugRaw(message, data),
     /**
-     * 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)
-     */
+       * 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) => logger.infoRaw(message, data),
     /**
-     * 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)
-     */
+       * 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) => logger.warnRaw(message, data),
     /**
-     * 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)
-     */
+       * 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) => logger.errorRaw(message, data),
     /**
-     * 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 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)
+       */
     logRaw: (message, data) => logger.logRaw(message, data),
     // Redaction configuration methods
     /**
-     * Configure data redaction settings
-     * @param config - Partial redaction configuration to apply
-     */
+       * Configure data redaction settings
+       * @param config - Partial redaction configuration to apply
+       */
     configureRedaction: (config) => redaction_1.DataRedactor.updateConfig(config),
     /**
-     * Refresh redaction configuration from environment variables
-     * Useful for picking up runtime environment changes
-     */
+       * Refresh redaction configuration from environment variables
+       * Useful for picking up runtime environment changes
+       */
     refreshRedactionConfig: () => redaction_1.DataRedactor.refreshConfig(),
     /**
-     * Reset redaction configuration to defaults
-     */
+       * Reset redaction configuration to defaults
+       */
     resetRedactionConfig: () => redaction_1.DataRedactor.updateConfig(redaction_1.defaultRedactionConfig),
     /**
-     * Get current redaction configuration
-     * @returns Current redaction configuration
-     */
+       * Get current redaction configuration
+       * @returns Current redaction configuration
+       */
     getRedactionConfig: () => redaction_1.DataRedactor.getConfig(),
-    // Advanced redaction methods (Phase 3)
+    // Advanced redaction methods
     /**
-     * Add custom regex patterns for advanced field detection
-     * @param patterns - Array of regex patterns to add
-     */
+       * Add custom regex patterns for advanced field detection
+       * @param patterns - Array of regex patterns to add
+       */
     addCustomRedactionPatterns: (patterns) => redaction_1.DataRedactor.addCustomPatterns(patterns),
     /**
-     * Clear all custom redaction patterns
-     */
+       * Clear all custom redaction patterns
+       */
     clearCustomRedactionPatterns: () => redaction_1.DataRedactor.clearCustomPatterns(),
     /**
-     * Add custom sensitive field names to the existing list
-     * @param fields - Array of field names to add
-     */
+       * Add custom sensitive field names to the existing list
+       * @param fields - Array of field names to add
+       */
     addSensitiveFields: (fields) => redaction_1.DataRedactor.addSensitiveFields(fields),
     /**
-     * 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
-     */
+       * 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
+       */
     testFieldRedaction: (fieldName) => redaction_1.DataRedactor.testFieldRedaction(fieldName),
     /**
-     * Temporarily disable redaction for a specific logging call
-     * @returns LogEngine instance with redaction bypassed
-     * @example
-     * ```typescript
-     * LogEngine.withoutRedaction().info('Debug data', sensitiveObject);
-     * ```
-     */
+       * Temporarily disable redaction for a specific logging call
+       * @returns LogEngine instance with redaction bypassed
+       * @example
+       * ```typescript
+       * LogEngine.withoutRedaction().info('Debug data', sensitiveObject);
+       * ```
+       */
     withoutRedaction: () => ({
         debug: (message, data) => logger.debugRaw(message, data),
         info: (message, data) => logger.infoRaw(message, data),

package/dist/logger/advanced-outputs.d.ts

@@ -0,0 +1,159 @@
+/**
+ * Advanced output handlers for log-engine
+ * Provides file, HTTP, and other production-ready output handlers
+ */
+import * as fs from 'fs';
+import type { FileOutputConfig, HttpOutputConfig } from '../types';
+/**
+ * Secure filesystem operations for logging operations
+ *
+ * SECURITY NOTE: These functions implement comprehensive path validation and access controls
+ * to prevent path traversal attacks, directory injection, and unauthorized file access.
+ * ESLint security rules are disabled for specific fs operations because:
+ *
+ * 1. All paths are validated through validatePath() which:
+ *    - Prevents directory traversal (../)
+ *    - Restricts access to predefined safe directories
+ *    - Blocks access to system directories
+ *    - Normalizes and resolves paths securely
+ *
+ * 2. The logging library requires dynamic file paths by design (user-configurable log files)
+ * 3. All operations are wrapped in try-catch with comprehensive error handling
+ * 4. File operations are restricted to log and temp directories only
+ */
+/**
+ * Predefined safe base directories for different operation types
+ * Restricted to specific subdirectories to prevent unauthorized access
+ */
+declare const SAFE_BASE_DIRS: {
+    readonly LOG_FILES: readonly [string, string, string];
+    readonly TEMP_FILES: readonly [string, string, string, string];
+    readonly CONFIG_FILES: readonly [string, string, string];
+};
+/**
+ * Validates file path with comprehensive security checks
+ * Prevents path traversal, restricts to safe directories, blocks system paths
+ */
+declare function validatePath(filePath: string): string;
+/**
+ * Secure file existence check
+ * Uses fs.accessSync instead of fs.existsSync for better security practices
+ */
+declare function secureExistsSync(filePath: string): boolean;
+/**
+ * Secure directory creation with recursive option support
+ * Restricted to log and temp directories only
+ */
+declare function secureMkdirSync(dirPath: string, options?: {
+    recursive?: boolean;
+}): void;
+/**
+ * Secure file stat operation
+ * Returns file system statistics for validated paths only
+ */
+declare function secureStatSync(filePath: string): fs.Stats;
+/**
+ * Secure file write operation
+ * Validates path and data before writing to prevent injection attacks
+ */
+declare function secureWriteFileSync(filePath: string, data: string, options?: {
+    flag?: string;
+}): void;
+/**
+ * Secure file deletion
+ * Restricted to log and temp files only for safety
+ */
+declare function secureUnlinkSync(filePath: string): void;
+/**
+ * Secure file rename/move operation
+ * Both source and destination must be in safe directories
+ */
+declare function secureRenameSync(oldPath: string, newPath: string): void;
+/**
+ * File output handler with rotation support and concurrency protection
+ * Implements atomic file operations and write queuing to prevent corruption
+ */
+export declare class FileOutputHandler {
+    private config;
+    private currentFileSize;
+    private rotationInProgress;
+    private writeQueue;
+    constructor(config: FileOutputConfig);
+    /**
+       * Default formatter for file output
+       */
+    private defaultFormatter;
+    /**
+       * Write log to file with rotation support and concurrency protection
+       * Queues writes during rotation to prevent file corruption
+       */
+    write: (level: string, message: string, data?: unknown) => void;
+    /**
+     * Write to file with concurrency protection and rotation check
+     * If rotation is in progress, messages are queued to prevent corruption
+     */
+    private writeToFile;
+    /**
+     * Process queued writes after rotation completes
+     */
+    private processWriteQueue;
+    /**
+       * Rotate log files when size limit is reached
+       * Implements concurrency protection to prevent corruption during rotation
+       */
+    private rotateFile;
+    /**
+     * Clean up resources and process any remaining queued writes
+     */
+    destroy(): void;
+}
+/**
+ * HTTP output handler for sending logs to remote endpoints
+ */
+export declare class HttpOutputHandler {
+    private config;
+    private logBuffer;
+    private flushTimeout;
+    constructor(config: HttpOutputConfig);
+    /**
+       * Default formatter for HTTP output
+       */
+    private defaultFormatter;
+    /**
+       * Write log to HTTP endpoint with batching support
+       */
+    write: (level: string, message: string, data?: unknown) => void;
+    /**
+       * Flush buffered logs to HTTP endpoint
+       */
+    private flush;
+    /**
+       * Send HTTP request with appropriate method based on environment
+       */
+    private sendHttpRequest;
+    /**
+       * Fallback HTTP implementation for Node.js environments without fetch
+       */
+    private sendHttpRequestNodeJS;
+    /**
+     * Cleanup method to prevent memory leaks
+     */
+    destroy(): void;
+}
+/**
+ * Returns a logging handler function based on the specified type and configuration.
+ *
+ * Supported types are:
+ * - `'console'`: Logs to the console using the appropriate method for the log level.
+ * - `'silent'`: Returns a no-op handler that discards all logs.
+ * - `'file'`: Writes logs to a file with optional rotation; requires `filePath` in config.
+ * - `'http'`: Sends logs to a remote HTTP endpoint; requires `url` in config.
+ *
+ * If required configuration is missing or initialization fails, logs an error and returns either a fallback handler or `null`.
+ *
+ * @param type - The type of output handler to create (`'console'`, `'silent'`, `'file'`, or `'http'`)
+ * @returns A log handler function or `null` if the handler cannot be created
+ */
+export declare function createBuiltInHandler(type: string, config?: Record<string, unknown>): ((level: string, message: string, data?: unknown) => void) | null;
+export { secureExistsSync, secureMkdirSync, secureStatSync, secureWriteFileSync, secureUnlinkSync, secureRenameSync, validatePath, SAFE_BASE_DIRS };
+//# sourceMappingURL=advanced-outputs.d.ts.map

package/dist/logger/advanced-outputs.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"advanced-outputs.d.ts","sourceRoot":"","sources":["../../src/logger/advanced-outputs.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,MAAM,IAAI,CAAC;AAGzB,OAAO,KAAK,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,MAAM,UAAU,CAAC;AAuBnE;;;;;;;;;;;;;;;;GAgBG;AAEH;;;GAGG;AACH,QAAA,MAAM,cAAc;;;;CAIV,CAAC;AAEX;;;GAGG;AACH,iBAAS,YAAY,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,CAqC9C;AAED;;;GAGG;AACH,iBAAS,gBAAgB,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CASnD;AAED;;;GAGG;AACH,iBAAS,eAAe,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE;IAAE,SAAS,CAAC,EAAE,OAAO,CAAA;CAAE,GAAG,IAAI,CAWjF;AAED;;;GAGG;AACH,iBAAS,cAAc,CAAC,QAAQ,EAAE,MAAM,GAAG,EAAE,CAAC,KAAK,CAUlD;AAED;;;GAGG;AACH,iBAAS,mBAAmB,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE;IAAE,IAAI,CAAC,EAAE,MAAM,CAAA;CAAE,GAAG,IAAI,CAgB9F;AAED;;;GAGG;AACH,iBAAS,gBAAgB,CAAC,QAAQ,EAAE,MAAM,GAAG,IAAI,CAkBhD;AAED;;;GAGG;AACH,iBAAS,gBAAgB,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,IAAI,CAoBhE;AAED;;;GAGG;AACH,qBAAa,iBAAiB;IAC5B,OAAO,CAAC,MAAM,CAA6B;IAC3C,OAAO,CAAC,eAAe,CAAa;IACpC,OAAO,CAAC,kBAAkB,CAAkB;IAC5C,OAAO,CAAC,UAAU,CAAiE;gBAEvE,MAAM,EAAE,gBAAgB;IA6BpC;;SAEK;IACL,OAAO,CAAC,gBAAgB,CAItB;IAEF;;;SAGK;IACE,KAAK,GAAI,OAAO,MAAM,EAAE,SAAS,MAAM,EAAE,OAAO,OAAO,KAAG,IAAI,CAcnE;IAEF;;;OAGG;IACH,OAAO,CAAC,WAAW;IAgBnB;;OAEG;IACH,OAAO,CAAC,iBAAiB;IAczB;;;SAGK;IACL,OAAO,CAAC,UAAU;IAwClB;;OAEG;IACI,OAAO,IAAI,IAAI;CAUvB;AAED;;GAEG;AACH,qBAAa,iBAAiB;IAC5B,OAAO,CAAC,MAAM,CAA6B;IAC3C,OAAO,CAAC,SAAS,CAAkB;IACnC,OAAO,CAAC,YAAY,CAA+B;gBAEvC,MAAM,EAAE,gBAAgB;IAYpC;;SAEK;IACL,OAAO,CAAC,gBAAgB,CAStB;IAEF;;SAEK;IACE,KAAK,GAAI,OAAO,MAAM,EAAE,SAAS,MAAM,EAAE,OAAO,OAAO,KAAG,IAAI,CA0BnE;IAEF;;SAEK;IACL,OAAO,CAAC,KAAK;IAqBb;;SAEK;IACL,OAAO,CAAC,eAAe;IAiBvB;;SAEK;IACL,OAAO,CAAC,qBAAqB;IAgD7B;;OAEG;IACI,OAAO,IAAI,IAAI;CAQvB;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAgB,oBAAoB,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,OAAO,KAAK,IAAI,CAAC,GAAG,IAAI,CA2CtJ;AAGD,OAAO,EACL,gBAAgB,EAChB,eAAe,EACf,cAAc,EACd,mBAAmB,EACnB,gBAAgB,EAChB,gBAAgB,EAChB,YAAY,EACZ,cAAc,EACf,CAAC"}