@rsdk/logging 5.7.0-next.2 → 6.0.0-next.0

package/dist/implementations/index.d.ts

@@ -1 +1,2 @@
+export * from './noop-logger.class';
 export * from './pino-logger.class';

package/dist/implementations/index.js

@@ -14,5 +14,6 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./noop-logger.class"), exports);
 __exportStar(require("./pino-logger.class"), exports);
 //# sourceMappingURL=index.js.map

package/dist/implementations/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/implementations/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,sDAAoC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/implementations/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,sDAAoC;AACpC,sDAAoC"}

package/dist/implementations/noop-logger.class.d.ts

@@ -0,0 +1,40 @@
+import type { ErrorLike } from '@rsdk/common';
+import type { ILogger } from '../logger.interface';
+import type { LogLevel, Params } from '../types';
+/**
+ * Implementation of ILogger interface that does nothing.
+ * Used when logging needs to be completely disabled.
+ *
+ * Features:
+ * - Implements all ILogger methods but performs no operations
+ * - Useful for testing or when logging needs to be disabled
+ */
+export declare class NoopLogger implements ILogger {
+    fatal(error: Error): void;
+    fatal(message: string): void;
+    fatal(message: string, params: Params): void;
+    fatal(message: string, error: ErrorLike): void;
+    error(error: Error): void;
+    error(message: string): void;
+    error(message: string, params: Params): void;
+    error(message: string, error: ErrorLike): void;
+    warn(error: ErrorLike): void;
+    warn(message: string): void;
+    warn(message: string, params: Params): void;
+    warn(message: string, error: ErrorLike): void;
+    info(message: string): void;
+    info(message: string, params: Params): void;
+    debug(error: ErrorLike): void;
+    debug(params: Params): void;
+    debug(message: string): void;
+    debug(message: string, params: Params): void;
+    trace(error: ErrorLike): void;
+    trace(params: Params): void;
+    trace(message: string): void;
+    trace(message: string, params: Params): void;
+    log(level: LogLevel, message: string): void;
+    log(level: LogLevel, error: ErrorLike): void;
+    log(level: LogLevel, params: Params): void;
+    log(level: LogLevel, message: string, params?: Params): void;
+    log(level: LogLevel, message: string, error?: ErrorLike): void;
+}

package/dist/implementations/noop-logger.class.js

@@ -0,0 +1,36 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NoopLogger = void 0;
+/**
+ * Implementation of ILogger interface that does nothing.
+ * Used when logging needs to be completely disabled.
+ *
+ * Features:
+ * - Implements all ILogger methods but performs no operations
+ * - Useful for testing or when logging needs to be disabled
+ */
+class NoopLogger {
+    fatal() {
+        return;
+    }
+    error() {
+        return;
+    }
+    warn() {
+        return;
+    }
+    info() {
+        return;
+    }
+    debug() {
+        return;
+    }
+    trace() {
+        return;
+    }
+    log() {
+        return;
+    }
+}
+exports.NoopLogger = NoopLogger;
+//# sourceMappingURL=noop-logger.class.js.map

package/dist/implementations/noop-logger.class.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"noop-logger.class.js","sourceRoot":"","sources":["../../src/implementations/noop-logger.class.ts"],"names":[],"mappings":";;;AAMA;;;;;;;GAOG;AAEH,MAAa,UAAU;IAKrB,KAAK;QACH,OAAO;IACT,CAAC;IAMD,KAAK;QACH,OAAO;IACT,CAAC;IAMD,IAAI;QACF,OAAO;IACT,CAAC;IAID,IAAI;QACF,OAAO;IACT,CAAC;IAMD,KAAK;QACH,OAAO;IACT,CAAC;IAMD,KAAK;QACH,OAAO;IACT,CAAC;IAOD,GAAG;QACD,OAAO;IACT,CAAC;CACF;AAvDD,gCAuDC"}

package/dist/implementations/pino-logger.class.d.ts

@@ -9,6 +9,17 @@ import { LogLevel } from '../types';
  * https://github.com/pinojs/pino-pretty/issues/275
  */
 type GetLogger = () => Pino;
+/**
+ * Implementation of ILogger interface using Pino logger.
+ * Provides logging functionality with different severity levels and context support.
+ *
+ * Features:
+ * - Supports trace, debug, info, warn, error and fatal log levels
+ * - Includes context information in logs
+ * - Handles both string messages and error objects
+ * - Normalizes and formats error objects and parameters
+ * - Emits log events through provided callback
+ */
 export declare class PinoLogger implements ILogger {
     private readonly context;
     /**

package/dist/implementations/pino-logger.class.js

@@ -4,6 +4,17 @@ exports.PinoLogger = void 0;
 const common_1 = require("@rsdk/common");
 const helpers_1 = require("../helpers");
 const types_1 = require("../types");
+/**
+ * Implementation of ILogger interface using Pino logger.
+ * Provides logging functionality with different severity levels and context support.
+ *
+ * Features:
+ * - Supports trace, debug, info, warn, error and fatal log levels
+ * - Includes context information in logs
+ * - Handles both string messages and error objects
+ * - Normalizes and formats error objects and parameters
+ * - Emits log events through provided callback
+ */
 class PinoLogger {
     context;
     /**

package/dist/implementations/pino-logger.class.js.map

@@ -1 +1 @@
-{"version":3,"file":"pino-logger.class.js","sourceRoot":"","sources":["../../src/implementations/pino-logger.class.ts"],"names":[],"mappings":";;;AACA,yCAAsE;AAGtE,wCAA8C;AAG9C,oCAAoC;AAUpC,MAAa,UAAU;IACJ,OAAO,CAAS;IAEjC;;OAEG;IACc,KAAK,CAAY;IACjB,IAAI,CAAY;IAEjC,YAAY,IAAe,EAAE,IAAe,EAAE,OAAuB;QACnE,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;QAClB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,OAAO,GAAG,IAAA,0BAAgB,EAAC,OAAO,CAAC,CAAC;IAC3C,CAAC;IAED,IAAI,IAAI;QACN,OAAO,IAAI,CAAC,KAAK,EAAE,CAAC;IACtB,CAAC;IAID,KAAK,CAAC,IAAqB,EAAE,MAAe;QAC1C,IAAI,CAAC,GAAG,CAAC,gBAAQ,CAAC,KAAK,EAAE,IAAI,EAAE,MAAM,CAAC,CAAC;IACzC,CAAC;IAID,KAAK,CAAC,IAAqB,EAAE,MAAe;QAC1C,IAAI,CAAC,GAAG,CAAC,gBAAQ,CAAC,KAAK,EAAE,IAAI,EAAE,MAAM,CAAC,CAAC;IACzC,CAAC;IAED,IAAI,CAAC,OAAe,EAAE,MAAe;QACnC,IAAI,CAAC,GAAG,CAAC,gBAAQ,CAAC,IAAI,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC;IAC3C,CAAC;IAKD,IAAI,CAAC,IAAwB,EAAE,IAAyB;QACtD,IAAI,CAAC,GAAG,CAAC,gBAAQ,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;IACtC,CAAC;IAKD,KAAK,CAAC,IAAoB,EAAE,IAAgB;QAC1C,IAAI,CAAC,GAAG,CAAC,gBAAQ,CAAC,KAAK,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;IACvC,CAAC;IAKD,KAAK,CAAC,IAAoB,EAAE,IAAgB;QAC1C,IAAI,CAAC,GAAG,CAAC,gBAAQ,CAAC,KAAK,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;IACvC,CAAC;IAeD,GAAG,CACD,KAAe,EACf,IAAiC,EACjC,IAAyB;QAEzB,IAAI,IAAI,CAAC,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC;YACxD,OAAO;QACT,CAAC;QAED,MAAM,IAAI,GAAwB;YAChC,OAAO,EAAE,IAAI,CAAC,OAAO;SACtB,CAAC;QAEF,IAAI,OAAO,GAAuB,SAAS,CAAC;QAE5C,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE,CAAC;YAC7B,OAAO,GAAG,IAAI,CAAC;QACjB,CAAC;aAAM,IAAI,IAAA,oBAAW,EAAC,IAAI,CAAC,EAAE,CAAC;YAC7B,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC;QACzB,CAAC;QAED,MAAM,aAAa,GAAG,OAAO,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC;QAE7D,IAAI,aAAa,EAAE,CAAC;YAClB,MAAM,OAAO,GAAqB;gBAChC,QAAQ,EAAE,sBAAa;aACxB,CAAC;YAEF,IAAI,KAAK,KAAK,OAAO,IAAI,KAAK,KAAK,OAAO,EAAE,CAAC;gBAC3C,IAAI,CAAC,OAAO,CAAC,GAAG,IAAA,mBAAU,GAAE,CAAC,aAAa,EAAE,OAAO,CAAC,CAAC;YACvD,CAAC;iBAAM,CAAC;gBACN,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,IAAA,mBAAU,GAAE,CAAC,aAAa,EAAE,OAAO,CAAC,CAAC,CAAC;YAC5D,CAAC;QACH,CAAC;QAED,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE,EAAE,GAAG,IAAI,EAAE,OAAO,EAAE,CAAC,CAAC;QACvC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;IAClC,CAAC;CACF;AA3GD,gCA2GC"}
+{"version":3,"file":"pino-logger.class.js","sourceRoot":"","sources":["../../src/implementations/pino-logger.class.ts"],"names":[],"mappings":";;;AACA,yCAAsE;AAGtE,wCAA8C;AAG9C,oCAAoC;AAUpC;;;;;;;;;;GAUG;AACH,MAAa,UAAU;IACJ,OAAO,CAAS;IAEjC;;OAEG;IACc,KAAK,CAAY;IACjB,IAAI,CAAY;IAEjC,YAAY,IAAe,EAAE,IAAe,EAAE,OAAuB;QACnE,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;QAClB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,OAAO,GAAG,IAAA,0BAAgB,EAAC,OAAO,CAAC,CAAC;IAC3C,CAAC;IAED,IAAI,IAAI;QACN,OAAO,IAAI,CAAC,KAAK,EAAE,CAAC;IACtB,CAAC;IAID,KAAK,CAAC,IAAqB,EAAE,MAAe;QAC1C,IAAI,CAAC,GAAG,CAAC,gBAAQ,CAAC,KAAK,EAAE,IAAI,EAAE,MAAM,CAAC,CAAC;IACzC,CAAC;IAID,KAAK,CAAC,IAAqB,EAAE,MAAe;QAC1C,IAAI,CAAC,GAAG,CAAC,gBAAQ,CAAC,KAAK,EAAE,IAAI,EAAE,MAAM,CAAC,CAAC;IACzC,CAAC;IAED,IAAI,CAAC,OAAe,EAAE,MAAe;QACnC,IAAI,CAAC,GAAG,CAAC,gBAAQ,CAAC,IAAI,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC;IAC3C,CAAC;IAKD,IAAI,CAAC,IAAwB,EAAE,IAAyB;QACtD,IAAI,CAAC,GAAG,CAAC,gBAAQ,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;IACtC,CAAC;IAKD,KAAK,CAAC,IAAoB,EAAE,IAAgB;QAC1C,IAAI,CAAC,GAAG,CAAC,gBAAQ,CAAC,KAAK,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;IACvC,CAAC;IAKD,KAAK,CAAC,IAAoB,EAAE,IAAgB;QAC1C,IAAI,CAAC,GAAG,CAAC,gBAAQ,CAAC,KAAK,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;IACvC,CAAC;IAeD,GAAG,CACD,KAAe,EACf,IAAiC,EACjC,IAAyB;QAEzB,IAAI,IAAI,CAAC,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC;YACxD,OAAO;QACT,CAAC;QAED,MAAM,IAAI,GAAwB;YAChC,OAAO,EAAE,IAAI,CAAC,OAAO;SACtB,CAAC;QAEF,IAAI,OAAO,GAAuB,SAAS,CAAC;QAE5C,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE,CAAC;YAC7B,OAAO,GAAG,IAAI,CAAC;QACjB,CAAC;aAAM,IAAI,IAAA,oBAAW,EAAC,IAAI,CAAC,EAAE,CAAC;YAC7B,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC;QACzB,CAAC;QAED,MAAM,aAAa,GAAG,OAAO,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC;QAE7D,IAAI,aAAa,EAAE,CAAC;YAClB,MAAM,OAAO,GAAqB;gBAChC,QAAQ,EAAE,sBAAa;aACxB,CAAC;YAEF,IAAI,KAAK,KAAK,OAAO,IAAI,KAAK,KAAK,OAAO,EAAE,CAAC;gBAC3C,IAAI,CAAC,OAAO,CAAC,GAAG,IAAA,mBAAU,GAAE,CAAC,aAAa,EAAE,OAAO,CAAC,CAAC;YACvD,CAAC;iBAAM,CAAC;gBACN,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,IAAA,mBAAU,GAAE,CAAC,aAAa,EAAE,OAAO,CAAC,CAAC,CAAC;YAC5D,CAAC;QACH,CAAC;QAED,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE,EAAE,GAAG,IAAI,EAAE,OAAO,EAAE,CAAC,CAAC;QACvC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;IAClC,CAAC;CACF;AA3GD,gCA2GC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rsdk/logging",
-  "version": "5.7.0-next.2",
+  "version": "6.0.0-next.0",
   "description": "Base framework independent logging functionality",
   "license": "Apache License 2.0",
   "publishConfig": {
@@ -17,5 +17,5 @@
   "peerDependencies": {
     "@rsdk/common": "*"
   },
-  "gitHead": "c85fca0b594a2ea168d06f1d2941a4fb05b59440"
+  "gitHead": "215cccea23d95118dd8b6af3ce11c6a35ce19c30"
 }

package/src/implementations/index.ts

@@ -1 +1,2 @@
+export * from './noop-logger.class';
 export * from './pino-logger.class';

package/src/implementations/noop-logger.class.ts

@@ -0,0 +1,71 @@
+/* eslint-disable @typescript-eslint/unified-signatures */
+import type { ErrorLike } from '@rsdk/common';
+
+import type { ILogger } from '../logger.interface';
+import type { LogLevel, Params } from '../types';
+
+/**
+ * Implementation of ILogger interface that does nothing.
+ * Used when logging needs to be completely disabled.
+ *
+ * Features:
+ * - Implements all ILogger methods but performs no operations
+ * - Useful for testing or when logging needs to be disabled
+ */
+
+export class NoopLogger implements ILogger {
+  fatal(error: Error): void;
+  fatal(message: string): void;
+  fatal(message: string, params: Params): void;
+  fatal(message: string, error: ErrorLike): void;
+  fatal(): void {
+    return;
+  }
+
+  error(error: Error): void;
+  error(message: string): void;
+  error(message: string, params: Params): void;
+  error(message: string, error: ErrorLike): void;
+  error(): void {
+    return;
+  }
+
+  warn(error: ErrorLike): void;
+  warn(message: string): void;
+  warn(message: string, params: Params): void;
+  warn(message: string, error: ErrorLike): void;
+  warn(): void {
+    return;
+  }
+
+  info(message: string): void;
+  info(message: string, params: Params): void;
+  info(): void {
+    return;
+  }
+
+  debug(error: ErrorLike): void;
+  debug(params: Params): void;
+  debug(message: string): void;
+  debug(message: string, params: Params): void;
+  debug(): void {
+    return;
+  }
+
+  trace(error: ErrorLike): void;
+  trace(params: Params): void;
+  trace(message: string): void;
+  trace(message: string, params: Params): void;
+  trace(): void {
+    return;
+  }
+
+  log(level: LogLevel, message: string): void;
+  log(level: LogLevel, error: ErrorLike): void;
+  log(level: LogLevel, params: Params): void;
+  log(level: LogLevel, message: string, params?: Params): void;
+  log(level: LogLevel, message: string, error?: ErrorLike): void;
+  log(): void {
+    return;
+  }
+}

package/src/implementations/pino-logger.class.spec.ts

@@ -0,0 +1,117 @@
+import type { Logger as Pino } from 'pino';
+
+import { LogLevel } from '../types';
+
+import { PinoLogger } from './pino-logger.class';
+
+describe('PinoLogger', () => {
+  let mockPino: jest.Mocked<Pino>;
+  let logger: PinoLogger;
+  let emitSpy: jest.Mock;
+
+  beforeEach(() => {
+    mockPino = {
+      trace: jest.fn(),
+      debug: jest.fn(),
+      info: jest.fn(),
+      warn: jest.fn(),
+      error: jest.fn(),
+      fatal: jest.fn(),
+      levelVal: 10, // trace level
+      levels: {
+        values: {
+          [LogLevel.trace]: 10,
+          [LogLevel.debug]: 20,
+          [LogLevel.info]: 30,
+          [LogLevel.warn]: 40,
+          [LogLevel.error]: 50,
+          [LogLevel.fatal]: 60,
+        },
+      },
+    } as unknown as jest.Mocked<Pino>;
+
+    emitSpy = jest.fn();
+    logger = new PinoLogger(() => mockPino, emitSpy, 'TestContext');
+  });
+
+  describe('binary data handling', () => {
+    it('should handle Buffer and ArrayBuffer in parameters', () => {
+      // Arrange
+      const params = {
+        normalField: 'test',
+        buffer: Buffer.from('binary content'),
+        arrayBuffer: new ArrayBuffer(16),
+        nested: {
+          buffer: Buffer.from('nested binary'),
+          arrayBuffer: new ArrayBuffer(8),
+        },
+      };
+
+      // Act
+      logger.info('test message', params);
+
+      // Assert
+      expect(mockPino.info).toHaveBeenCalledWith(
+        expect.objectContaining({
+          context: 'TestContext',
+          normalField: 'test',
+          buffer: expect.stringContaining('[Buffer'),
+          arrayBuffer: '[ArrayBuffer 16]',
+          nested: expect.objectContaining({
+            buffer: expect.stringContaining('[Buffer'),
+            arrayBuffer: '[ArrayBuffer 8]',
+          }),
+        }),
+        'test message',
+      );
+    });
+
+    it('should handle binary data in error object', () => {
+      // Arrange
+      const error = new Error('test error', {
+        cause: {
+          binaryData: Buffer.from('some binary data'),
+          arrayBuffer: new ArrayBuffer(16),
+        },
+      });
+
+      // Act
+      logger.error('Error occurred', error);
+
+      // Assert
+      expect(mockPino.error).toHaveBeenCalledWith(
+        expect.objectContaining({
+          context: 'TestContext',
+          error: expect.objectContaining({
+            cause: expect.objectContaining({
+              binaryData: expect.stringContaining('[Buffer'),
+              arrayBuffer: '[ArrayBuffer 16]',
+            }),
+          }),
+        }),
+        'Error occurred',
+      );
+    });
+
+    it('should emit normalized data without binary content', () => {
+      // Arrange
+      const params = {
+        buffer: Buffer.from('binary content'),
+        arrayBuffer: new ArrayBuffer(16),
+      };
+
+      // Act
+      logger.info('test message', params);
+
+      // Assert
+      expect(emitSpy).toHaveBeenCalledWith(
+        LogLevel.info,
+        expect.objectContaining({
+          context: 'TestContext',
+          buffer: expect.stringContaining('[Buffer'),
+          arrayBuffer: '[ArrayBuffer 16]',
+        }),
+      );
+    });
+  });
+});

package/src/implementations/pino-logger.class.ts

@@ -15,6 +15,17 @@ import { LogLevel } from '../types';
 
 type GetLogger = () => Pino;
 
+/**
+ * Implementation of ILogger interface using Pino logger.
+ * Provides logging functionality with different severity levels and context support.
+ *
+ * Features:
+ * - Supports trace, debug, info, warn, error and fatal log levels
+ * - Includes context information in logs
+ * - Handles both string messages and error objects
+ * - Normalizes and formats error objects and parameters
+ * - Emits log events through provided callback
+ */
 export class PinoLogger implements ILogger {
   private readonly context: string;