@thi.ng/rstream-log 4.1.101 → 5.0.1

package/CHANGELOG.md

@@ -1,6 +1,6 @@
 # Change Log
 
-- **Last updated**: 2024-02-10T08:59:57Z
+- **Last updated**: 2024-02-16T20:48:02Z
 - **Generator**: [thi.ng/monopub](https://thi.ng/monopub)
 
 All notable changes to this project will be documented in this file.
@@ -9,6 +9,23 @@ See [Conventional Commits](https://conventionalcommits.org/) for commit guidelin
 **Note:** Unlisted _patch_ versions only involve non-code or otherwise excluded changes
 and/or version bumps of transitive dependencies.
 
+### [5.0.1](https://github.com/thi-ng/umbrella/tree/@thi.ng/rstream-log@5.0.1) (2024-02-16)
+
+#### 🩹 Bug fixes
+
+- fix Logger.logEntry() & .childLogger() impls ([3484617](https://github.com/thi-ng/umbrella/commit/3484617))
+
+# [5.0.0](https://github.com/thi-ng/umbrella/tree/@thi.ng/rstream-log@5.0.0) (2024-02-16)
+
+#### 🛑 Breaking changes
+
+- update Logger impl, remove obsolete types ([36c8649](https://github.com/thi-ng/umbrella/commit/36c8649))
+- BREAKING CHANGE: update Logger, remove obsolete types
+  - Logger now a subclass of `ALogger` & implementing `ISubscriber` interface
+    - instead of extending rstream `StreamMerge`, now exposes a `Stream` via `.stream`
+    - adding child loggers now handled via `ILogger.childLogger()` or `ILogger.addChild()`
+  - update tests
+
 ### [4.1.84](https://github.com/thi-ng/umbrella/tree/@thi.ng/rstream-log@4.1.84) (2023-11-24)
 
 #### 🩹 Bug fixes

package/README.md

@@ -44,10 +44,10 @@ infrastructure, with logged values transformable via
 [@thi.ng/transducers](https://github.com/thi-ng/umbrella/tree/develop/packages/transducers).
 Several built-in transformers are provided.
 
-The `Logger` class provided by this package implements the
-[@thi.ng/api](https://github.com/thi-ng/umbrella/tree/develop/packages/api)
+The `Logger` class in this package implements the
+[@thi.ng/logger](https://github.com/thi-ng/umbrella/tree/develop/packages/logger)
 `ILogger` interface and uses `LogLevel` enums to configure levels /
-filtering.
+filtering. See that package for more details.
 
 ## Status
 
@@ -61,7 +61,7 @@ filtering.
 
 ## Related packages
 
-- [@thi.ng/logger](https://github.com/thi-ng/umbrella/tree/develop/packages/logger) - Types & basis infrastructure for arbitrary logging (w/ default impls)
+- [@thi.ng/logger](https://github.com/thi-ng/umbrella/tree/develop/packages/logger) - Basis types for arbitrary & hierarchical logging
 
 ## Installation
 
@@ -83,13 +83,12 @@ For Node.js REPL:
 const rstreamLog = await import("@thi.ng/rstream-log");
 ```
 
-Package sizes (brotli'd, pre-treeshake): ESM: 857 bytes
+Package sizes (brotli'd, pre-treeshake): ESM: 715 bytes
 
 ## Dependencies
 
 - [@thi.ng/api](https://github.com/thi-ng/umbrella/tree/develop/packages/api)
 - [@thi.ng/checks](https://github.com/thi-ng/umbrella/tree/develop/packages/checks)
-- [@thi.ng/errors](https://github.com/thi-ng/umbrella/tree/develop/packages/errors)
 - [@thi.ng/logger](https://github.com/thi-ng/umbrella/tree/develop/packages/logger)
 - [@thi.ng/rstream](https://github.com/thi-ng/umbrella/tree/develop/packages/rstream)
 - [@thi.ng/strings](https://github.com/thi-ng/umbrella/tree/develop/packages/strings)
@@ -99,42 +98,38 @@ Package sizes (brotli'd, pre-treeshake): ESM: 857 bytes
 
 [Generated API docs](https://docs.thi.ng/umbrella/rstream-log/)
 
-```ts
-import { LogLevel } from "@thi.ng/api";
-import * as log from "@thi.ng/rstream-log";
+```ts tangle:export/readme.ts
+import { LogLevel } from "@thi.ng/logger";
+import { Logger, formatString, writeConsole } from "@thi.ng/rstream-log";
 
-const logger = new log.Logger("main");
+const logger = new Logger("main");
 // or with min level
-const logger = new log.Logger("main", LogLevel.DEBUG);
+const logger = new Logger("main", LogLevel.DEBUG);
+// or min level given as string
+const logger = new Logger("main", "DEBUG");
 
 // add console output w/ string formatter (a transducer)
-logger.subscribe(log.writeConsole(), log.formatString());
+// each logger instance has a rstream Stream instance
+// allowing for downstream processing
+logger.stream.transform(formatString()).subscribe(writeConsole());
 
 logger.debug("hello world");
-// [DEBUG] [main] 2018-01-20T09:04:05.198Z hello world
+// [DEBUG] main: 2024-02-16T20:38:11.143Z hello world
 
 logger.warn("eek");
-// [WARN] [main] 2018-01-20T09:04:16.913Z eek
+// [WARN] main: 2024-02-16T20:38:11.144Z eek
 
-// each logger instance is a rstream StreamMerge instance
-// allowing to form logger hierarchies
-
-const mod1 = new log.Logger("module-1", LogLevel.INFO);
-// pipe mod1 into main logger
-logger.add(mod1);
+// loggers can form hierarchies by creating/attaching child loggers
+const child = logger.childLogger("child", LogLevel.INFO);
 
 import { postWorker } from "@thi.ng/rstream";
 // additionally send messages from this logger to worker
-mod1.subscribe(postWorker("log-worker.js"));
-
-mod1.info("hi from sub-module");
+child.stream.subscribe(postWorker("log-worker.js"));
 
-// only shown in console:
-// [INFO] [module-1] 2018-01-20T09:05:21.198Z hi from sub-module
+child.info("hi from submodule");
+// [INFO] child: 2024-02-16T20:38:11.145Z hi from submodule
 ```
 
-TODO
-
 ## Authors
 
 - [Karsten Schmidt](https://thi.ng)

package/api.d.ts

@@ -1,15 +1,6 @@
 import type { IID } from "@thi.ng/api";
-import type { ILogger as APILogger, LogLevel } from "@thi.ng/logger";
+import type { ILogger as APILogger, LogEntry, LogLevel } from "@thi.ng/logger";
 import type { ISubscribable } from "@thi.ng/rstream";
-/**
- * @deprecated moved to thi.ng/logger package
- */
-export interface LogEntry extends Array<any> {
-    [0]: LogLevel;
-    [1]: string;
-    [2]: number;
-    [id: number]: any;
-}
 export interface LogEntryObj extends IID<string> {
     level: LogLevel;
     time: number;

package/logger.d.ts

@@ -1,20 +1,13 @@
-import { LogLevel, type LogEntry } from "@thi.ng/logger/api";
-import { type ISubscribable } from "@thi.ng/rstream/api";
-import { StreamMerge } from "@thi.ng/rstream/merge";
-import type { ILogger } from "./api.js";
-export declare class Logger extends StreamMerge<LogEntry, LogEntry> implements ILogger {
-    level: LogLevel;
-    constructor();
-    constructor(id: string);
-    constructor(id: string, level: LogLevel);
-    constructor(id: string, sources: Iterable<ISubscribable<LogEntry>>, level?: LogLevel);
-    enabled(level: LogLevel): boolean;
+import { ALogger } from "@thi.ng/logger/alogger";
+import { LogLevel, type ILogger, type LogEntry, type LogLevelName } from "@thi.ng/logger/api";
+import { Stream, type ISubscriber } from "@thi.ng/rstream";
+export declare class Logger extends ALogger implements ISubscriber<LogEntry> {
+    stream: Stream<LogEntry>;
+    constructor(id: string, level?: LogLevel | LogLevelName, parent?: ILogger);
     next(x: LogEntry): void;
-    fine(...args: any[]): void;
-    debug(...args: any[]): void;
-    info(...args: any[]): void;
-    warn(...args: any[]): void;
-    severe(...args: any[]): void;
-    protected log(level: LogLevel, args: any[]): void;
+    done(): void;
+    error(e: Error): boolean;
+    logEntry(e: LogEntry): void;
+    childLogger(id: string, level?: LogLevel): Logger;
 }
 //# sourceMappingURL=logger.d.ts.map

package/logger.js

@@ -1,57 +1,34 @@
-import { illegalArity } from "@thi.ng/errors/illegal-arity";
-import { LogLevel } from "@thi.ng/logger/api";
-import { CloseMode } from "@thi.ng/rstream/api";
-import { __nextID } from "@thi.ng/rstream/idgen";
-import { StreamMerge } from "@thi.ng/rstream/merge";
-class Logger extends StreamMerge {
-  level;
-  constructor(...args) {
-    let id;
-    let level = LogLevel.FINE;
-    let src;
-    switch (args.length) {
-      case 0:
-        break;
-      case 1:
-        id = args[0];
-        break;
-      case 2:
-        [id, level] = args;
-        break;
-      case 3:
-        [id, src, level] = args;
-        src = [...src];
-        break;
-      default:
-        illegalArity(args.length);
-    }
-    id = id || `logger-${__nextID()}`;
-    super({ src, id, closeIn: CloseMode.NEVER, closeOut: CloseMode.NEVER });
-    this.level = level;
-  }
-  enabled(level) {
-    return this.level <= level;
+import { ALogger } from "@thi.ng/logger/alogger";
+import {
+  LogLevel
+} from "@thi.ng/logger/api";
+import { CloseMode, Stream } from "@thi.ng/rstream";
+class Logger extends ALogger {
+  stream;
+  constructor(id, level, parent) {
+    super(id, level, parent);
+    this.stream = new Stream({
+      id: this.id,
+      closeOut: CloseMode.NEVER
+    });
   }
   next(x) {
-    x[0] >= this.level && super.next(x);
-  }
-  fine(...args) {
-    this.log(LogLevel.FINE, args);
+    this.logEntry(x);
   }
-  debug(...args) {
-    this.log(LogLevel.DEBUG, args);
+  done() {
+    this.stream.done();
   }
-  info(...args) {
-    this.log(LogLevel.INFO, args);
+  error(e) {
+    return this.stream.error(e);
   }
-  warn(...args) {
-    this.log(LogLevel.WARN, args);
-  }
-  severe(...args) {
-    this.log(LogLevel.SEVERE, args);
+  logEntry(e) {
+    if (e[0] >= this.level) {
+      this.stream.next(e);
+      this.parent && this.parent.logEntry(e);
+    }
   }
-  log(level, args) {
-    this.level <= level && super.next([level, this.id, Date.now(), ...args]);
+  childLogger(id, level) {
+    return new Logger(id, level ?? this.level, this);
   }
 }
 export {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@thi.ng/rstream-log",
-  "version": "4.1.101",
+  "version": "5.0.1",
   "description": "Structured, multilevel & hierarchical loggers based on @thi.ng/rstream",
   "type": "module",
   "module": "./index.js",
@@ -37,11 +37,10 @@
   "dependencies": {
     "@thi.ng/api": "^8.9.23",
     "@thi.ng/checks": "^3.4.23",
-    "@thi.ng/errors": "^2.4.16",
-    "@thi.ng/logger": "^2.1.10",
-    "@thi.ng/rstream": "^8.3.2",
+    "@thi.ng/logger": "^3.0.0",
+    "@thi.ng/rstream": "^8.3.3",
     "@thi.ng/strings": "^3.7.14",
-    "@thi.ng/transducers": "^8.9.1"
+    "@thi.ng/transducers": "^8.9.2"
   },
   "devDependencies": {
     "@microsoft/api-extractor": "^7.40.1",
@@ -98,5 +97,5 @@
     ],
     "year": 2017
   },
-  "gitHead": "e304d8e10f3446a22666ba75aaa2fb1d32752ae0\n"
+  "gitHead": "31173a8ccccdc296c104602d8d9db8b6553fd305\n"
 }