@decohere/scribe-console 0.0.1-dev.120

package/commonjs/src/index.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+_export_star(require("./json-console.adapter.js"), exports);
+function _export_star(from, to) {
+    Object.keys(from).forEach(function(k) {
+        if (k !== "default" && !Object.prototype.hasOwnProperty.call(to, k)) {
+            Object.defineProperty(to, k, {
+                enumerable: true,
+                get: function() {
+                    return from[k];
+                }
+            });
+        }
+    });
+    return from;
+}

package/commonjs/src/json-console.adapter.js

@@ -0,0 +1,85 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+Object.defineProperty(exports, "JsonConsoleAdapter", {
+    enumerable: true,
+    get: function() {
+        return JsonConsoleAdapter;
+    }
+});
+const _scribe = require("@decohere/scribe");
+class JsonConsoleAdapter extends _scribe.LogEntryAdapter {
+    timestamp;
+    constructor(options = {}){
+        super();
+        this.timestamp = options.timestamp ?? false;
+    }
+    write(entry) {
+        const method = methodFor(this.levels[entry.level] ?? _scribe.LogLevels.info);
+        console[method](stringify(toLine(entry, this.timestamp)));
+    }
+}
+/**
+ * Custom levels pick the method of the default level at or below them:
+ * `fatal` and `error` → `console.error`, `warn` → `console.warn`, `info` →
+ * `console.info`, `debug` and `trace` → `console.debug` (`console.trace` would
+ * print a stack).
+ */ function methodFor(value) {
+    if (value >= _scribe.LogLevels.error) {
+        return "error";
+    }
+    if (value >= _scribe.LogLevels.warn) {
+        return "warn";
+    }
+    if (value >= _scribe.LogLevels.info) {
+        return "info";
+    }
+    return "debug";
+}
+/** `level`, `name`, `time` and `msg` are the entry's own; a field cannot replace them. */ function toLine(entry, timestamp) {
+    const line = {
+        level: entry.level,
+        name: entry.name
+    };
+    if (timestamp) {
+        line.time = new Date().toISOString();
+    }
+    if (entry.msg !== undefined) {
+        line.msg = entry.msg;
+    }
+    for (const [key, value] of Object.entries(entry.fields)){
+        if (!(key in line)) {
+            line[key] = value;
+        }
+    }
+    if (entry.err != null) {
+        line.err = entry.err;
+    }
+    return line;
+}
+/** `JSON.stringify` that survives cycles and bigints, and serializes nested errors. */ function stringify(line) {
+    const ancestors = [];
+    return JSON.stringify(line, function(_key, value) {
+        if (typeof value === "bigint") {
+            return value.toString();
+        }
+        if (value == null || typeof value !== "object") {
+            return value;
+        }
+        while(ancestors.length > 0 && ancestors.at(-1) !== this){
+            ancestors.pop();
+        }
+        if (ancestors.includes(value)) {
+            return "[Circular]";
+        }
+        if (value instanceof Error) {
+            // Track the error too: its serialized properties may point back at it.
+            const serialized = (0, _scribe.serializeError)(value);
+            ancestors.push(value, serialized);
+            return serialized;
+        }
+        ancestors.push(value);
+        return value;
+    });
+}

package/es6/src/index.js

@@ -0,0 +1 @@
+export * from "./json-console.adapter.js";

package/es6/src/json-console.adapter.js

@@ -0,0 +1,80 @@
+import { LogEntryAdapter, LogLevels, serializeError } from "@decohere/scribe";
+/**
+ * Writes one JSON object per entry, `{ level, name, msg, ...fields, err }`,
+ * through the console method of its level, so hosts that index JSON console
+ * lines (Workers Logs, browser devtools) see the level too. Uses nothing but
+ * `console` and `JSON`: it runs on Workers, in browsers, Deno, Bun and Node.
+ */ export class JsonConsoleAdapter extends LogEntryAdapter {
+    timestamp;
+    constructor(options = {}){
+        super();
+        this.timestamp = options.timestamp ?? false;
+    }
+    write(entry) {
+        const method = methodFor(this.levels[entry.level] ?? LogLevels.info);
+        console[method](stringify(toLine(entry, this.timestamp)));
+    }
+}
+/**
+ * Custom levels pick the method of the default level at or below them:
+ * `fatal` and `error` → `console.error`, `warn` → `console.warn`, `info` →
+ * `console.info`, `debug` and `trace` → `console.debug` (`console.trace` would
+ * print a stack).
+ */ function methodFor(value) {
+    if (value >= LogLevels.error) {
+        return "error";
+    }
+    if (value >= LogLevels.warn) {
+        return "warn";
+    }
+    if (value >= LogLevels.info) {
+        return "info";
+    }
+    return "debug";
+}
+/** `level`, `name`, `time` and `msg` are the entry's own; a field cannot replace them. */ function toLine(entry, timestamp) {
+    const line = {
+        level: entry.level,
+        name: entry.name
+    };
+    if (timestamp) {
+        line.time = new Date().toISOString();
+    }
+    if (entry.msg !== undefined) {
+        line.msg = entry.msg;
+    }
+    for (const [key, value] of Object.entries(entry.fields)){
+        if (!(key in line)) {
+            line[key] = value;
+        }
+    }
+    if (entry.err != null) {
+        line.err = entry.err;
+    }
+    return line;
+}
+/** `JSON.stringify` that survives cycles and bigints, and serializes nested errors. */ function stringify(line) {
+    const ancestors = [];
+    return JSON.stringify(line, function(_key, value) {
+        if (typeof value === "bigint") {
+            return value.toString();
+        }
+        if (value == null || typeof value !== "object") {
+            return value;
+        }
+        while(ancestors.length > 0 && ancestors.at(-1) !== this){
+            ancestors.pop();
+        }
+        if (ancestors.includes(value)) {
+            return "[Circular]";
+        }
+        if (value instanceof Error) {
+            // Track the error too: its serialized properties may point back at it.
+            const serialized = serializeError(value);
+            ancestors.push(value, serialized);
+            return serialized;
+        }
+        ancestors.push(value);
+        return value;
+    });
+}

package/package.json

@@ -0,0 +1,31 @@
+{
+  "name": "@decohere/scribe-console",
+  "version": "0.0.1-dev.120",
+  "description": "JSON console adapter for @decohere/scribe: one JSON line per entry, for Workers, browsers, Deno, Bun and Node",
+  "keywords": [
+    "typescript",
+    "logging",
+    "structured-logging",
+    "json",
+    "cloudflare-workers",
+    "decohere"
+  ],
+  "license": "ISC",
+  "author": "Typesmiths",
+  "type": "module",
+  "main": "index.js",
+  "exports": {
+    ".": {
+      "types": "./types/src/index.d.ts",
+      "import": "./es6/src/index.js",
+      "require": "./commonjs/src/index.js"
+    }
+  },
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "dependencies": {
+    "@decohere/scribe": "0.0.1-dev.120"
+  },
+  "devDependencies": {}
+}

package/types/src/index.d.ts

@@ -0,0 +1 @@
+export * from "./json-console.adapter.js";

package/types/src/json-console.adapter.d.ts

@@ -0,0 +1,19 @@
+import { type LogEntry, LogEntryAdapter } from "@decohere/scribe";
+export type JsonConsoleAdapterOptions = {
+    /**
+     * Add `time` (ISO 8601) to every line. Off by default: hosts such as Workers
+     * Logs and browser devtools stamp each line themselves.
+     */
+    timestamp?: boolean;
+};
+/**
+ * Writes one JSON object per entry, `{ level, name, msg, ...fields, err }`,
+ * through the console method of its level, so hosts that index JSON console
+ * lines (Workers Logs, browser devtools) see the level too. Uses nothing but
+ * `console` and `JSON`: it runs on Workers, in browsers, Deno, Bun and Node.
+ */
+export declare class JsonConsoleAdapter extends LogEntryAdapter {
+    private readonly timestamp;
+    constructor(options?: JsonConsoleAdapterOptions);
+    protected write(entry: LogEntry): void;
+}