@thi.ng/rstream-log 5.0.5 → 5.1.0

package/CHANGELOG.md

@@ -1,6 +1,6 @@
 # Change Log
 
-- **Last updated**: 2024-02-22T11:59:16Z
+- **Last updated**: 2024-02-28T14:23:30Z
 - **Generator**: [thi.ng/monopub](https://thi.ng/monopub)
 
 All notable changes to this project will be documented in this file.
@@ -9,6 +9,14 @@ 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.1.0](https://github.com/thi-ng/umbrella/tree/@thi.ng/rstream-log@5.1.0) (2024-02-28)
+
+#### 🚀 Features
+
+- update formatString() ([1ad60cc](https://github.com/thi-ng/umbrella/commit/1ad60cc))
+  - add support for msg post-processing in formatString()
+  - add/update docstrings
+
 ### [5.0.1](https://github.com/thi-ng/umbrella/tree/@thi.ng/rstream-log@5.0.1) (2024-02-16)
 
 #### 🩹 Bug fixes

package/README.md

@@ -83,7 +83,7 @@ For Node.js REPL:
 const rstreamLog = await import("@thi.ng/rstream-log");
 ```
 
-Package sizes (brotli'd, pre-treeshake): ESM: 715 bytes
+Package sizes (brotli'd, pre-treeshake): ESM: 768 bytes
 
 ## Dependencies
 

package/format.d.ts

@@ -2,7 +2,21 @@ import { type LogEntry } from "@thi.ng/logger/api";
 import type { Transducer } from "@thi.ng/transducers";
 import type { BodyFormat, DateFormat, LogEntryObj } from "./api.js";
 export declare const isoDate: (dt: number) => string;
-export declare const formatString: (dtFmt?: DateFormat, bodyFmt?: BodyFormat) => Transducer<LogEntry, string>;
+/**
+ * Log entry formatter/transducer. Formats a {@link LogEntry} tuple as string
+ * using optionally provided formatters.
+ *
+ * @remarks
+ * If `wrap` is given, it will be called with both the already formatted message
+ * string and the original log entry. The function can be used to post-process
+ * the message (e.g. to wrap it in ANSI color escape sequences, based on logger
+ * ID and/or level, also see [thi.ng/text-format](https://thi.ng/text-format))
+ *
+ * @param dateFmt
+ * @param bodyFmt
+ * @param wrap
+ */
+export declare const formatString: (dateFmt?: DateFormat, bodyFmt?: BodyFormat, wrap?: ((msg: string, entry: LogEntry) => string) | undefined) => Transducer<LogEntry, string>;
 /**
  * Takes an array of regex patterns and optional `mask` string. Returns
  * transducer which replaces all found pattern occurrences with `mask`.
@@ -12,6 +26,10 @@ export declare const formatString: (dtFmt?: DateFormat, bodyFmt?: BodyFormat) =>
  *
  * @example
  * ```ts
+ * import { Logger, formatString, maskSecrets, writeConsole } from "@thi.ng/rstream-log";
+ *
+ * const logger = new Logger();
+ *
  * logger.transform(
  *   formatString(),
  *   maskSecrets([/(?<=[A-Z0-9_]\=)\w+/g])
@@ -27,6 +45,17 @@ export declare const formatString: (dtFmt?: DateFormat, bodyFmt?: BodyFormat) =>
  * @param mask -
  */
 export declare const maskSecrets: (patterns: RegExp[], mask?: string) => Transducer<string, string>;
+/**
+ * Log entry transducer which converts a {@link LogEntry} tuple to a
+ * {@link LogEntryObj}.
+ */
 export declare const formatObject: () => Transducer<LogEntry, LogEntryObj>;
-export declare const formatJSON: (dtfmt?: DateFormat) => Transducer<LogEntry, string>;
+/**
+ * Log entry formatter/transducer. Format a {@link LogEntry} tuple into a
+ * serialized JSON string (object keys: `id`, `level`, `time`, `body`), with the
+ * entry's timestamp formatted using given `dateFmt` (default: {@link isoDate}).
+ *
+ * @param dateFmt
+ */
+export declare const formatJSON: (dateFmt?: DateFormat) => Transducer<LogEntry, string>;
 //# sourceMappingURL=format.d.ts.map

package/format.js

@@ -2,24 +2,27 @@ import { LogLevel } from "@thi.ng/logger/api";
 import { stringify } from "@thi.ng/strings/stringify";
 import { map } from "@thi.ng/transducers/map";
 const isoDate = (dt) => new Date(dt).toISOString();
-const formatString = (dtFmt, bodyFmt) => {
-  dtFmt = dtFmt || isoDate;
+const formatString = (dateFmt, bodyFmt, wrap) => {
+  dateFmt = dateFmt || isoDate;
   bodyFmt = bodyFmt || ((x) => x.map(stringify()).join(" "));
-  return map(
-    ([level, id, time, ...body]) => `[${LogLevel[level]}] ${id}: ${dtFmt(time)} ${bodyFmt(body)}`
-  );
+  return map((entry) => {
+    const [level, id, time, ...body] = entry;
+    const date = dateFmt(time);
+    const res = `[${LogLevel[level]}] ${id}: ${date ? date + " " : ""}${bodyFmt(body)}`;
+    return wrap ? wrap(res, entry) : res;
+  });
 };
 const maskSecrets = (patterns, mask = "****") => map(
   (msg) => patterns.reduce((acc, pat) => acc.replace(pat, mask), msg)
 );
 const formatObject = () => map(([level, id, time, ...body]) => ({ level, id, time, body }));
-const formatJSON = (dtfmt) => {
-  dtfmt = dtfmt || isoDate;
+const formatJSON = (dateFmt) => {
+  dateFmt = dateFmt || isoDate;
   return map(
     ([level, id, time, ...body]) => JSON.stringify({
       id,
       level: LogLevel[level],
-      time: dtfmt(time),
+      time: dateFmt(time),
       body
     })
   );

package/logger.d.ts

@@ -1,9 +1,10 @@
 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";
+import { type ISubscriber } from "@thi.ng/rstream/api";
+import { Stream } from "@thi.ng/rstream/stream";
 export declare class Logger extends ALogger implements ISubscriber<LogEntry> {
     stream: Stream<LogEntry>;
-    constructor(id: string, level?: LogLevel | LogLevelName, parent?: ILogger);
+    constructor(id?: string, level?: LogLevel | LogLevelName, parent?: ILogger);
     next(x: LogEntry): void;
     done(): void;
     error(e: Error): boolean;

package/logger.js

@@ -2,11 +2,13 @@ import { ALogger } from "@thi.ng/logger/alogger";
 import {
   LogLevel
 } from "@thi.ng/logger/api";
-import { CloseMode, Stream } from "@thi.ng/rstream";
+import { CloseMode } from "@thi.ng/rstream/api";
+import { Stream } from "@thi.ng/rstream/stream";
+import { __nextID } from "@thi.ng/rstream/idgen";
 class Logger extends ALogger {
   stream;
   constructor(id, level, parent) {
-    super(id, level, parent);
+    super(id || `logger-${__nextID()}`, level, parent);
     this.stream = new Stream({
       id: this.id,
       closeOut: CloseMode.NEVER

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@thi.ng/rstream-log",
-  "version": "5.0.5",
+  "version": "5.1.0",
   "description": "Structured, multilevel & hierarchical loggers based on @thi.ng/rstream",
   "type": "module",
   "module": "./index.js",
@@ -35,12 +35,12 @@
     "test": "bun test"
   },
   "dependencies": {
-    "@thi.ng/api": "^8.9.25",
+    "@thi.ng/api": "^8.9.26",
     "@thi.ng/checks": "^3.5.0",
-    "@thi.ng/logger": "^3.0.2",
-    "@thi.ng/rstream": "^8.3.7",
-    "@thi.ng/strings": "^3.7.16",
-    "@thi.ng/transducers": "^8.9.6"
+    "@thi.ng/logger": "^3.0.3",
+    "@thi.ng/rstream": "^8.3.8",
+    "@thi.ng/strings": "^3.7.18",
+    "@thi.ng/transducers": "^8.9.7"
   },
   "devDependencies": {
     "@microsoft/api-extractor": "^7.40.1",
@@ -97,5 +97,5 @@
     ],
     "year": 2017
   },
-  "gitHead": "16f2b92b5410bd35dcde6c2971c8e62783ebc472\n"
+  "gitHead": "190d68e7f7524631b333cfdbf32c6a23be27c166\n"
 }