@rxap/nest-logger 10.2.11-dev.0 → 10.3.0-dev.0

package/CHANGELOG.md

@@ -3,6 +3,12 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [10.3.0-dev.0](https://gitlab.com/rxap/packages/compare/@rxap/nest-logger@10.2.11-dev.0...@rxap/nest-logger@10.3.0-dev.0) (2025-01-16)
+
+### Features
+
+- support custom print messages function ([db34f07](https://gitlab.com/rxap/packages/commit/db34f070178b9ea7a453304e7f66d20d3a508e01))
+
 ## [10.2.11-dev.0](https://gitlab.com/rxap/packages/compare/@rxap/nest-logger@10.2.10...@rxap/nest-logger@10.2.11-dev.0) (2025-01-08)
 
 **Note:** Version bump only for package @rxap/nest-logger

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "10.2.11-dev.0",
+  "version": "10.3.0-dev.0",
   "name": "@rxap/nest-logger",
   "license": "GPL-3.0-or-later",
   "dependencies": {
@@ -50,7 +50,7 @@
     "directory": "packages/nest/logger"
   },
   "type": "commonjs",
-  "gitHead": "3fb11056505011351451e412704f25a645e517ce",
+  "gitHead": "897ab34bff42ac956e06340c5e3cfe7b1deff11c",
   "types": "./src/index.d.ts",
   "main": "./src/index.js"
 }

package/src/lib/logger.d.ts

@@ -1,18 +1,16 @@
 import { ConsoleLogger, ConsoleLoggerOptions, LogLevel } from '@nestjs/common';
+/**
+ * @return true - call the super.printMessages method
+ */
+export type PrintMessagesFunction = (messages: unknown[], context: string, logLevel: LogLevel, writeStreamType?: 'stdout' | 'stderr') => boolean;
 /**
  * A custom logger class that extends the ConsoleLogger class.
  * This class provides additional methods for logging at different log levels and supports the interpolation of optional parameters.
  */
 export declare class RxapLogger extends ConsoleLogger {
-    constructor(context?: string, options?: ConsoleLoggerOptions);
-    log(message: string, ...optionalParams: any[]): void;
-    error(message: string, ...optionalParams: any[]): void;
-    warn(message: string, ...optionalParams: any[]): void;
-    debug(message: string, ...optionalParams: any[]): void;
-    verbose(message: string, ...optionalParams: any[]): void;
-    protected interpolate(message: unknown, optionalParams: any[], logLevel: LogLevel): {
-        msg: unknown;
-        params: any[];
-    };
+    protected readonly printMessagesFunction: PrintMessagesFunction | null;
+    constructor(context?: string, options?: ConsoleLoggerOptions, printMessagesFunction?: PrintMessagesFunction | null);
+    protected interpolate(messages: unknown[]): unknown[];
     protected stringifyCircular(obj: any): string;
+    protected printMessages(messages: unknown[], context?: string, logLevel?: LogLevel, writeStreamType?: 'stdout' | 'stderr'): void;
 }

package/src/lib/logger.js

@@ -9,70 +9,49 @@ const tokens_1 = require("./tokens");
  * This class provides additional methods for logging at different log levels and supports the interpolation of optional parameters.
  */
 let RxapLogger = class RxapLogger extends common_1.ConsoleLogger {
-    constructor(context, options = {}) {
+    constructor(context, options = {}, printMessagesFunction = null) {
         super(context, options);
+        this.printMessagesFunction = printMessagesFunction;
     }
-    log(message, ...optionalParams) {
-        const { msg, params, } = this.interpolate(message, optionalParams, 'log');
-        super.log(msg, ...params);
-    }
-    error(message, ...optionalParams) {
-        const { msg, params, } = this.interpolate(message, optionalParams, 'error');
-        super.error(msg, ...params);
-    }
-    warn(message, ...optionalParams) {
-        const { msg, params, } = this.interpolate(message, optionalParams, 'warn');
-        super.warn(msg, ...params);
-    }
-    debug(message, ...optionalParams) {
-        const { msg, params, } = this.interpolate(message, optionalParams, 'debug');
-        super.debug(msg, ...params);
-    }
-    verbose(message, ...optionalParams) {
-        const { msg, params, } = this.interpolate(message, optionalParams, 'verbose');
-        super.verbose(msg, ...params);
-    }
-    interpolate(message, optionalParams, logLevel) {
-        if (this.isLevelEnabled(logLevel) && typeof message === 'string') {
-            if (message.includes('%JSON')) {
-                // replace each %JSON with the corresponding optionalParam
-                const msg = message.replace(/%JSON/g, () => {
-                    if (optionalParams.length) {
-                        const param = optionalParams.shift();
-                        if (typeof param === 'object') {
-                            if (param) {
-                                return this.stringifyCircular(param);
-                            }
-                            else if (param === null) {
-                                return '<null>';
-                            }
-                        }
-                        if (typeof param === 'undefined') {
-                            return '<undefined>';
-                        }
-                        if (typeof param === 'string') {
-                            return JSON.stringify(param);
-                        }
-                        if (typeof param === 'number') {
-                            return JSON.stringify(param);
-                        }
-                        if (typeof param === 'boolean') {
-                            return JSON.stringify(param);
-                        }
-                        optionalParams.unshift(param);
+    interpolate(messages) {
+        if (messages.length <= 1) {
+            return messages;
+        }
+        if (typeof messages[0] !== 'string') {
+            return messages;
+        }
+        if (!messages[0].includes('%JSON')) {
+            return messages;
+        }
+        let message = messages.shift();
+        message = message.replace(/%JSON/g, () => {
+            if (messages.length) {
+                const param = messages.shift();
+                if (typeof param === 'object') {
+                    if (param) {
+                        return this.stringifyCircular(param);
                     }
-                    return '<json>';
-                });
-                return {
-                    msg,
-                    params: optionalParams,
-                };
+                    else if (param === null) {
+                        return '<null>';
+                    }
+                }
+                if (typeof param === 'undefined') {
+                    return '<undefined>';
+                }
+                if (typeof param === 'string') {
+                    return JSON.stringify(param);
+                }
+                if (typeof param === 'number') {
+                    return JSON.stringify(param);
+                }
+                if (typeof param === 'boolean') {
+                    return JSON.stringify(param);
+                }
+                messages.unshift(param);
             }
-        }
-        return {
-            msg: message,
-            params: optionalParams,
-        };
+            return '<json>';
+        });
+        return [message, ...messages];
     }
     stringifyCircular(obj) {
         const seenObjects = new Set();
@@ -87,6 +66,17 @@ let RxapLogger = class RxapLogger extends common_1.ConsoleLogger {
             return value;
         });
     }
+    printMessages(messages, context = '', logLevel = 'log', writeStreamType) {
+        if (this.printMessagesFunction) {
+            const call = this.printMessagesFunction(messages, context, logLevel, writeStreamType);
+            if (call) {
+                super.printMessages(this.interpolate(messages), context, logLevel, writeStreamType);
+            }
+        }
+        else {
+            super.printMessages(this.interpolate(messages), context, logLevel, writeStreamType);
+        }
+    }
 };
 exports.RxapLogger = RxapLogger;
 exports.RxapLogger = RxapLogger = tslib_1.__decorate([
@@ -94,5 +84,7 @@ exports.RxapLogger = RxapLogger = tslib_1.__decorate([
     tslib_1.__param(0, (0, common_1.Optional)()),
     tslib_1.__param(1, (0, common_1.Inject)(tokens_1.CONSOLE_LOGGER_OPTIONS)),
     tslib_1.__param(1, (0, common_1.Optional)()),
-    tslib_1.__metadata("design:paramtypes", [String, Object])
+    tslib_1.__param(2, (0, common_1.Optional)()),
+    tslib_1.__param(2, (0, common_1.Inject)(tokens_1.RXAP_LOGGER_PRINT_MESSAGES)),
+    tslib_1.__metadata("design:paramtypes", [String, Object, Object])
 ], RxapLogger);

package/src/lib/tokens.d.ts

@@ -1 +1,2 @@
 export declare const CONSOLE_LOGGER_OPTIONS: unique symbol;
+export declare const RXAP_LOGGER_PRINT_MESSAGES: unique symbol;

package/src/lib/tokens.js

@@ -1,4 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.CONSOLE_LOGGER_OPTIONS = void 0;
+exports.RXAP_LOGGER_PRINT_MESSAGES = exports.CONSOLE_LOGGER_OPTIONS = void 0;
 exports.CONSOLE_LOGGER_OPTIONS = Symbol('CONSOLE_LOGGER_OPTIONS');
+exports.RXAP_LOGGER_PRINT_MESSAGES = Symbol('RXAP_LOGGER_PRINT_MESSAGES');