@smb-tech/logger-core 1.0.0

package/README.md

@@ -0,0 +1,28 @@
+# @smb-tech/logger-core
+
+Core library for structured logging.
+
+## Features
+
+- LogEvent builder
+- JSON serialization
+- Logging levels
+- Tags and metadata
+
+## Installation
+
+```bash
+npm install @smb-tech/logger-core
+```
+
+## Usage
+
+```ts
+import { Logger } from '@smb-tech/logger-core';
+
+const logger = Logger.get('MyClass');
+
+logger.info((event) => {
+  event.message('Hello world');
+});
+```

package/dist/event.d.ts

@@ -0,0 +1,16 @@
+import type { EventType, NormalizedLogEvent } from './types.js';
+export declare class LogEvent {
+    private messageValue;
+    private dataValue;
+    private tagsValue;
+    private typeValue;
+    private errorValue?;
+    private sensitiveValue;
+    type(type: EventType): this;
+    tag(tag: string): this;
+    sensitive(): this;
+    message(message: string): this;
+    with(key: string, value: unknown): this;
+    error(error: Error): this;
+    toJSON(): NormalizedLogEvent;
+}

package/dist/event.js

@@ -0,0 +1,44 @@
+export class LogEvent {
+    messageValue = '';
+    dataValue = {};
+    tagsValue = new Set();
+    typeValue = 'APP';
+    errorValue;
+    sensitiveValue = false;
+    type(type) {
+        this.typeValue = type;
+        return this;
+    }
+    tag(tag) {
+        this.tagsValue.add(tag);
+        return this;
+    }
+    sensitive() {
+        this.sensitiveValue = true;
+        this.tagsValue.add('SENSITIVE');
+        return this;
+    }
+    message(message) {
+        this.messageValue = message;
+        return this;
+    }
+    with(key, value) {
+        this.dataValue[key] = value;
+        return this;
+    }
+    error(error) {
+        this.errorValue = error;
+        return this;
+    }
+    toJSON() {
+        return {
+            type: this.typeValue,
+            msg: this.messageValue,
+            data: { ...this.dataValue },
+            tags: [...this.tagsValue].filter((tag) => tag !== 'SENSITIVE'),
+            pii: this.sensitiveValue,
+            error: this.errorValue
+        };
+    }
+}
+//# sourceMappingURL=event.js.map

package/dist/event.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"event.js","sourceRoot":"","sources":["../src/event.ts"],"names":[],"mappings":"AAEA,MAAM,OAAO,QAAQ;IACX,YAAY,GAAG,EAAE,CAAC;IAClB,SAAS,GAA4B,EAAE,CAAC;IACxC,SAAS,GAAG,IAAI,GAAG,EAAU,CAAC;IAC9B,SAAS,GAAc,KAAK,CAAC;IAC7B,UAAU,CAAS;IACnB,cAAc,GAAG,KAAK,CAAC;IAE/B,IAAI,CAAC,IAAe;QAClB,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC;QACtB,OAAO,IAAI,CAAC;IACd,CAAC;IAED,GAAG,CAAC,GAAW;QACb,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QACxB,OAAO,IAAI,CAAC;IACd,CAAC;IAED,SAAS;QACP,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC;QAC3B,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;QAChC,OAAO,IAAI,CAAC;IACd,CAAC;IAED,OAAO,CAAC,OAAe;QACrB,IAAI,CAAC,YAAY,GAAG,OAAO,CAAC;QAC5B,OAAO,IAAI,CAAC;IACd,CAAC;IAED,IAAI,CAAC,GAAW,EAAE,KAAc;QAC9B,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;QAC5B,OAAO,IAAI,CAAC;IACd,CAAC;IAED,KAAK,CAAC,KAAY;QAChB,IAAI,CAAC,UAAU,GAAG,KAAK,CAAC;QACxB,OAAO,IAAI,CAAC;IACd,CAAC;IAED,MAAM;QACJ,OAAO;YACL,IAAI,EAAE,IAAI,CAAC,SAAS;YACpB,GAAG,EAAE,IAAI,CAAC,YAAY;YACtB,IAAI,EAAE,EAAE,GAAG,IAAI,CAAC,SAAS,EAAE;YAC3B,IAAI,EAAE,CAAC,GAAG,IAAI,CAAC,SAAS,CAAC,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,KAAK,WAAW,CAAC;YAC9D,GAAG,EAAE,IAAI,CAAC,cAAc;YACxB,KAAK,EAAE,IAAI,CAAC,UAAU;SACvB,CAAC;IACJ,CAAC;CACF"}

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+export * from './event.js';
+export * from './logger.js';
+export * from './types.js';

package/dist/index.js

@@ -0,0 +1,4 @@
+export * from './event.js';
+export * from './logger.js';
+export * from './types.js';
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,YAAY,CAAC;AAC3B,cAAc,aAAa,CAAC;AAC5B,cAAc,YAAY,CAAC"}

package/dist/logger.d.ts

@@ -0,0 +1,20 @@
+import { LogEvent } from './event.js';
+import type { LogContextAccessor, LogSink, RuntimeDetailsProvider } from './types.js';
+export declare class Logger {
+    private readonly contextName;
+    private readonly contextAccessor;
+    private readonly sink;
+    private readonly runtimeDetailsProvider;
+    constructor(contextName: string, contextAccessor: LogContextAccessor, sink: LogSink, runtimeDetailsProvider: RuntimeDetailsProvider);
+    trace(builder: (event: LogEvent) => void): void;
+    debug(builder: (event: LogEvent) => void): void;
+    info(builder: (event: LogEvent) => void): void;
+    warn(builder: (event: LogEvent) => void): void;
+    error(builder: (event: LogEvent) => void): void;
+    metric(builder: (event: LogEvent) => void): void;
+    audit(builder: (event: LogEvent) => void): void;
+    security(builder: (event: LogEvent) => void): void;
+    track(builder: (event: LogEvent) => void): void;
+    private log;
+    private toPayload;
+}

package/dist/logger.js

@@ -0,0 +1,88 @@
+import { LogEvent } from './event.js';
+const ENABLED_LEVELS = new Set(['TRACE', 'DEBUG', 'INFO', 'WARN', 'ERROR', 'METRIC', 'AUDIT', 'SECURITY', 'TRACK']);
+export class Logger {
+    contextName;
+    contextAccessor;
+    sink;
+    runtimeDetailsProvider;
+    constructor(contextName, contextAccessor, sink, runtimeDetailsProvider) {
+        this.contextName = contextName;
+        this.contextAccessor = contextAccessor;
+        this.sink = sink;
+        this.runtimeDetailsProvider = runtimeDetailsProvider;
+    }
+    trace(builder) {
+        this.log('TRACE', builder);
+    }
+    debug(builder) {
+        this.log('DEBUG', builder);
+    }
+    info(builder) {
+        this.log('INFO', builder);
+    }
+    warn(builder) {
+        this.log('WARN', builder);
+    }
+    error(builder) {
+        this.log('ERROR', builder);
+    }
+    metric(builder) {
+        this.log('METRIC', (event) => {
+            event.type('METRIC');
+            builder(event);
+        });
+    }
+    audit(builder) {
+        this.log('AUDIT', (event) => {
+            event.type('AUDIT');
+            builder(event);
+        });
+    }
+    security(builder) {
+        this.log('SECURITY', (event) => {
+            event.type('SECURITY');
+            builder(event);
+        });
+    }
+    track(builder) {
+        this.log('TRACK', (event) => {
+            event.type('TRACK');
+            builder(event);
+        });
+    }
+    log(level, builder) {
+        if (!ENABLED_LEVELS.has(level)) {
+            return;
+        }
+        const event = new LogEvent();
+        builder(event);
+        const payload = this.toPayload(level, event);
+        this.sink.dispatch(JSON.stringify(payload), level);
+    }
+    toPayload(level, event) {
+        const normalized = event.toJSON();
+        const error = normalized.error;
+        const mdc = this.contextAccessor.getMdc();
+        return {
+            ts: new Date().toISOString(),
+            uuid: mdc.requestId ?? this.runtimeDetailsProvider.fallbackId(),
+            type: normalized.type === 'APP' ? level : normalized.type,
+            msg: normalized.msg,
+            class: this.contextName,
+            pii: normalized.pii,
+            thread: this.runtimeDetailsProvider.getThreadLabel(),
+            mdc,
+            data: normalized.data,
+            tags: normalized.tags,
+            exception: error
+                ? {
+                    message: error.message,
+                    class: error.name,
+                    stack: error.stack,
+                    cause: error.cause instanceof Error ? error.cause.message : undefined
+                }
+                : {}
+        };
+    }
+}
+//# sourceMappingURL=logger.js.map

package/dist/logger.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"logger.js","sourceRoot":"","sources":["../src/logger.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAStC,MAAM,cAAc,GAAG,IAAI,GAAG,CAAW,CAAC,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,QAAQ,EAAE,OAAO,EAAE,UAAU,EAAE,OAAO,CAAC,CAAC,CAAC;AAE9H,MAAM,OAAO,MAAM;IAEE;IACA;IACA;IACA;IAJnB,YACmB,WAAmB,EACnB,eAAmC,EACnC,IAAa,EACb,sBAA8C;QAH9C,gBAAW,GAAX,WAAW,CAAQ;QACnB,oBAAe,GAAf,eAAe,CAAoB;QACnC,SAAI,GAAJ,IAAI,CAAS;QACb,2BAAsB,GAAtB,sBAAsB,CAAwB;IAC9D,CAAC;IAEJ,KAAK,CAAC,OAAkC;QACtC,IAAI,CAAC,GAAG,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;IAC7B,CAAC;IAED,KAAK,CAAC,OAAkC;QACtC,IAAI,CAAC,GAAG,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;IAC7B,CAAC;IAED,IAAI,CAAC,OAAkC;QACrC,IAAI,CAAC,GAAG,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAC5B,CAAC;IAED,IAAI,CAAC,OAAkC;QACrC,IAAI,CAAC,GAAG,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAC5B,CAAC;IAED,KAAK,CAAC,OAAkC;QACtC,IAAI,CAAC,GAAG,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;IAC7B,CAAC;IAED,MAAM,CAAC,OAAkC;QACvC,IAAI,CAAC,GAAG,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE,EAAE;YAC3B,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;YACrB,OAAO,CAAC,KAAK,CAAC,CAAC;QACjB,CAAC,CAAC,CAAC;IACL,CAAC;IAED,KAAK,CAAC,OAAkC;QACtC,IAAI,CAAC,GAAG,CAAC,OAAO,EAAE,CAAC,KAAK,EAAE,EAAE;YAC1B,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;YACpB,OAAO,CAAC,KAAK,CAAC,CAAC;QACjB,CAAC,CAAC,CAAC;IACL,CAAC;IAED,QAAQ,CAAC,OAAkC;QACzC,IAAI,CAAC,GAAG,CAAC,UAAU,EAAE,CAAC,KAAK,EAAE,EAAE;YAC7B,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;YACvB,OAAO,CAAC,KAAK,CAAC,CAAC;QACjB,CAAC,CAAC,CAAC;IACL,CAAC;IAED,KAAK,CAAC,OAAkC;QACtC,IAAI,CAAC,GAAG,CAAC,OAAO,EAAE,CAAC,KAAK,EAAE,EAAE;YAC1B,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;YACpB,OAAO,CAAC,KAAK,CAAC,CAAC;QACjB,CAAC,CAAC,CAAC;IACL,CAAC;IAEO,GAAG,CAAC,KAAe,EAAE,OAAkC;QAC7D,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC;YAC/B,OAAO;QACT,CAAC;QAED,MAAM,KAAK,GAAG,IAAI,QAAQ,EAAE,CAAC;QAC7B,OAAO,CAAC,KAAK,CAAC,CAAC;QAEf,MAAM,OAAO,GAAG,IAAI,CAAC,SAAS,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;QAC7C,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,EAAE,KAAK,CAAC,CAAC;IACrD,CAAC;IAEO,SAAS,CAAC,KAAe,EAAE,KAAe;QAChD,MAAM,UAAU,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC;QAClC,MAAM,KAAK,GAAG,UAAU,CAAC,KAAK,CAAC;QAC/B,MAAM,GAAG,GAAG,IAAI,CAAC,eAAe,CAAC,MAAM,EAAE,CAAC;QAE1C,OAAO;YACL,EAAE,EAAE,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE;YAC5B,IAAI,EAAE,GAAG,CAAC,SAAS,IAAI,IAAI,CAAC,sBAAsB,CAAC,UAAU,EAAE;YAC/D,IAAI,EAAE,UAAU,CAAC,IAAI,KAAK,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,UAAU,CAAC,IAAI;YACzD,GAAG,EAAE,UAAU,CAAC,GAAG;YACnB,KAAK,EAAE,IAAI,CAAC,WAAW;YACvB,GAAG,EAAE,UAAU,CAAC,GAAG;YACnB,MAAM,EAAE,IAAI,CAAC,sBAAsB,CAAC,cAAc,EAAE;YACpD,GAAG;YACH,IAAI,EAAE,UAAU,CAAC,IAAI;YACrB,IAAI,EAAE,UAAU,CAAC,IAAI;YACrB,SAAS,EAAE,KAAK;gBACd,CAAC,CAAC;oBACE,OAAO,EAAE,KAAK,CAAC,OAAO;oBACtB,KAAK,EAAE,KAAK,CAAC,IAAI;oBACjB,KAAK,EAAE,KAAK,CAAC,KAAK;oBAClB,KAAK,EAAE,KAAK,CAAC,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS;iBACtE;gBACH,CAAC,CAAC,EAAE;SACP,CAAC;IACJ,CAAC;CACF"}

package/dist/types.d.ts

@@ -0,0 +1,39 @@
+export type LogLevel = 'TRACE' | 'DEBUG' | 'INFO' | 'WARN' | 'ERROR' | 'METRIC' | 'AUDIT' | 'SECURITY' | 'TRACK';
+export type EventType = 'APP' | 'ERROR' | 'TRACK' | 'SECURITY' | 'AUDIT' | 'ACCESS' | 'METRIC' | string;
+export interface ThrowablePayload {
+    message?: string;
+    class: string;
+    stack?: string;
+    cause?: string;
+}
+export interface LogPayload {
+    ts: string;
+    uuid: string;
+    type: EventType;
+    msg: string;
+    class: string;
+    pii: boolean;
+    thread: string;
+    mdc: Record<string, string>;
+    data: Record<string, unknown>;
+    tags: string[];
+    exception: Record<string, unknown> | ThrowablePayload;
+}
+export interface NormalizedLogEvent {
+    type: EventType;
+    msg: string;
+    data: Record<string, unknown>;
+    tags: string[];
+    pii: boolean;
+    error?: Error;
+}
+export interface LogContextAccessor {
+    getMdc(): Record<string, string>;
+}
+export interface LogSink {
+    dispatch(line: string, level: LogLevel): void;
+}
+export interface RuntimeDetailsProvider {
+    getThreadLabel(): string;
+    fallbackId(): string;
+}

package/dist/types.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=types.js.map

package/dist/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":""}

package/package.json

@@ -0,0 +1,28 @@
+{
+  "name": "@smb-tech/logger-core",
+  "version": "1.0.0",
+  "description": "Core library for structured logging, events, and serialization",
+  "license": "MIT",
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "scripts": {
+    "build": "tsc -p tsconfig.json"
+  },
+  "devDependencies": {
+    "typescript": "^5.8.2"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}