@prosopo/logger 2.0.3 → 2.0.5

package/dist/logger.js

@@ -1,263 +1,242 @@
 import { stringifyBigInts } from "@prosopo/util";
 import { z } from "zod";
-const InfoLevel = "info";
-const DebugLevel = "debug";
-const TraceLevel = "trace";
-const WarnLevel = "warn";
-const ErrorLevel = "error";
-const FatalLevel = "fatal";
-const LogLevel = z.enum([
-  InfoLevel,
-  DebugLevel,
-  TraceLevel,
-  WarnLevel,
-  ErrorLevel,
-  FatalLevel
+//#region src/logger.ts
+var InfoLevel = "info";
+var DebugLevel = "debug";
+var TraceLevel = "trace";
+var WarnLevel = "warn";
+var ErrorLevel = "error";
+var FatalLevel = "fatal";
+var LogLevel = z.enum([
+	InfoLevel,
+	DebugLevel,
+	TraceLevel,
+	WarnLevel,
+	ErrorLevel,
+	FatalLevel
 ]);
-const logLevelMap = {
-  [TraceLevel]: 0,
-  [DebugLevel]: 1,
-  [InfoLevel]: 2,
-  [WarnLevel]: 3,
-  [ErrorLevel]: 4,
-  [FatalLevel]: 5
+var logLevelMap = {
+	[TraceLevel]: 0,
+	[DebugLevel]: 1,
+	[InfoLevel]: 2,
+	[WarnLevel]: 3,
+	[ErrorLevel]: 4,
+	[FatalLevel]: 5
 };
 function parseLogLevel(level, or = InfoLevel) {
-  if (!level) return or;
-  for (const part of level.split(",")) {
-    const trimmed = part.trim();
-    if (trimmed && !trimmed.includes("=")) {
-      const parsed = LogLevel.safeParse(trimmed);
-      if (parsed.success) return parsed.data;
-    }
-  }
-  return or;
+	if (!level) return or;
+	for (const part of level.split(",")) {
+		const trimmed = part.trim();
+		if (trimmed && !trimmed.includes("=")) {
+			const parsed = LogLevel.safeParse(trimmed);
+			if (parsed.success) return parsed.data;
+		}
+	}
+	return or;
 }
+/**
+* Parse a PROSOPO_LOG_LEVEL directive string into a scope→level map.
+* An entry with an empty-string key represents the global default.
+*/
 function parseDirectives(raw) {
-  const map = /* @__PURE__ */ new Map();
-  for (const part of raw.split(",")) {
-    const trimmed = part.trim();
-    if (!trimmed) continue;
-    const eqIdx = trimmed.indexOf("=");
-    if (eqIdx === -1) {
-      const parsed = LogLevel.safeParse(trimmed);
-      if (parsed.success) map.set("", parsed.data);
-    } else {
-      const scope = trimmed.slice(0, eqIdx).trim();
-      if (!scope) continue;
-      const parsed = LogLevel.safeParse(trimmed.slice(eqIdx + 1).trim());
-      if (parsed.success) map.set(scope, parsed.data);
-    }
-  }
-  return map;
+	const map = /* @__PURE__ */ new Map();
+	for (const part of raw.split(",")) {
+		const trimmed = part.trim();
+		if (!trimmed) continue;
+		const eqIdx = trimmed.indexOf("=");
+		if (eqIdx === -1) {
+			const parsed = LogLevel.safeParse(trimmed);
+			if (parsed.success) map.set("", parsed.data);
+		} else {
+			const scope = trimmed.slice(0, eqIdx).trim();
+			if (!scope) continue;
+			const parsed = LogLevel.safeParse(trimmed.slice(eqIdx + 1).trim());
+			if (parsed.success) map.set(scope, parsed.data);
+		}
+	}
+	return map;
 }
+/**
+* Find the most specific directive that matches the given scope.
+* Walks from the full scope up to the empty-string global default.
+* Returns the fallback if nothing matches.
+*/
 function resolveLevel(scope, directives, fallback) {
-  if (directives.has(scope)) return directives.get(scope);
-  const parts = scope.split(":");
-  for (let i = parts.length - 1; i > 0; i--) {
-    const prefix = parts.slice(0, i).join(":");
-    if (directives.has(prefix)) return directives.get(prefix);
-  }
-  if (directives.has("")) return directives.get("");
-  return fallback;
+	if (directives.has(scope)) return directives.get(scope);
+	const parts = scope.split(":");
+	for (let i = parts.length - 1; i > 0; i--) {
+		const prefix = parts.slice(0, i).join(":");
+		if (directives.has(prefix)) return directives.get(prefix);
+	}
+	if (directives.has("")) return directives.get("");
+	return fallback;
 }
-let _globalDirectives;
+var _globalDirectives;
 function getGlobalDirectives() {
-  if (!_globalDirectives) {
-    const raw = typeof process !== "undefined" ? process.env?.PROSOPO_LOG_LEVEL ?? "" : "";
-    _globalDirectives = parseDirectives(raw);
-  }
-  return _globalDirectives;
+	if (!_globalDirectives) _globalDirectives = parseDirectives(typeof process !== "undefined" ? process.env?.PROSOPO_LOG_LEVEL ?? "" : "");
+	return _globalDirectives;
 }
+/**
+* Override the global directives at runtime (useful in tests or at app startup).
+* Accepts the same directive string as PROSOPO_LOG_LEVEL.
+*/
 function setGlobalDirectives(raw) {
-  _globalDirectives = parseDirectives(raw);
+	_globalDirectives = parseDirectives(raw);
 }
 function getLogger(logLevel, scope) {
-  const logger = new NativeLogger(scope);
-  logger.setLogLevel(logLevel);
-  return logger;
+	const logger = new NativeLogger(scope);
+	logger.setLogLevel(logLevel);
+	return logger;
 }
-const inBrowser = typeof window !== "undefined" && typeof window.document !== "undefined";
-const FormatJson = "json";
-const FormatPlain = "plain";
-const Format = z.enum([FormatJson, FormatPlain]);
-class NativeLogger {
-  constructor(scope, levelMap = logLevelMap) {
-    this.scope = scope;
-    this.levelMap = levelMap;
-    this.pretty = 0;
-    this.printStack = false;
-    this.format = FormatJson;
-    this.level = InfoLevel;
-  }
-  setFormat(format) {
-    this.format = format;
-    if (this.format !== FormatJson) {
-      throw new Error("Only JSON format implemented for now");
-    }
-  }
-  getFormat() {
-    return this.format;
-  }
-  with(obj, subscope) {
-    const trimmedSubscope = subscope?.trim();
-    const newScope = trimmedSubscope ? this.scope ? `${this.scope}:${trimmedSubscope}` : trimmedSubscope : this.scope;
-    const newLogger = new NativeLogger(newScope, this.levelMap);
-    const hasObjData = Object.keys(obj).length > 0;
-    if (hasObjData) {
-      newLogger.defaultData = { ...this.defaultData, ...obj };
-    } else if (this.defaultData) {
-      newLogger.defaultData = this.defaultData;
-    }
-    newLogger.setPretty(this.getPretty());
-    newLogger.setPrintStack(this.getPrintStack());
-    newLogger.setLogLevel(this.getLogLevel());
-    return newLogger;
-  }
-  getPrintStack() {
-    return this.printStack;
-  }
-  setPrintStack(printStack) {
-    this.printStack = printStack;
-  }
-  getPretty() {
-    return this.pretty > 0;
-  }
-  setPretty(pretty) {
-    this.pretty = pretty ? 2 : 0;
-  }
-  getScope() {
-    return this.scope;
-  }
-  setLogLevel(level) {
-    this.level = level;
-  }
-  getLogLevel() {
-    return this.level;
-  }
-  unpackError(err) {
-    const e = err;
-    const data = {};
-    for (const key of Object.getOwnPropertyNames(err)) {
-      if (!this.printStack && (key === "stack" || key === "stacktrace"))
-        continue;
-      data[key] = e[key];
-    }
-    if (!data.name) {
-      data.name = err.name ?? "Error";
-    }
-    const cause = e.cause;
-    if (cause !== void 0) {
-      if (cause instanceof Error || typeof cause === "object" && cause !== null) {
-        data.cause = this.unpackError(cause);
-      } else {
-        data.cause = cause;
-      }
-    }
-    const msg = String(e.translationKey ?? e.message ?? e.msg ?? "");
-    return { msg, data };
-  }
-  print(dest, fn, level) {
-    const effectiveLevelNum = this.levelMap[resolveLevel(this.scope, getGlobalDirectives(), this.level)];
-    if (this.levelMap[level] < effectiveLevelNum) {
-      return;
-    }
-    const ts = (/* @__PURE__ */ new Date()).toISOString();
-    let { data, msg, err } = fn();
-    let errMsg;
-    let errData;
-    if (err) {
-      if (err instanceof Error || typeof err === "object") {
-        const result = this.unpackError(err);
-        errMsg = result.msg;
-        errData = result.data;
-      } else {
-        errMsg = String(err);
-      }
-    }
-    if (this.defaultData) {
-      data = { ...this.defaultData, ...data };
-    }
-    const dataMaybeRequestId = data;
-    const reqId = dataMaybeRequestId && typeof dataMaybeRequestId.requestId === "string" ? dataMaybeRequestId.requestId : void 0;
-    const baseRecord = { scope: this.scope, ts, level };
-    if (reqId) {
-      baseRecord.req_id = reqId;
-    }
-    if (data) {
-      baseRecord.data = data;
-    }
-    if (msg) {
-      baseRecord.msg = msg;
-    }
-    if (errMsg) {
-      baseRecord.err = errMsg;
-    }
-    if (errData) {
-      baseRecord.errData = errData;
-    }
-    if (inBrowser) {
-      if (msg || errMsg) {
-        dest(msg || errMsg, baseRecord);
-      } else {
-        dest(baseRecord);
-      }
-    } else {
-      const logRecord = stringifyBigInts(baseRecord);
-      const output = JSON.stringify(logRecord, null, this.pretty);
-      dest(output);
-    }
-  }
-  info(fn) {
-    this.print(console.info.bind(console), fn, InfoLevel);
-  }
-  debug(fn) {
-    this.print(console.debug.bind(console), fn, DebugLevel);
-  }
-  trace(fn) {
-    this.print(console.trace.bind(console), fn, TraceLevel);
-  }
-  warn(fn) {
-    this.print(console.warn.bind(console), fn, WarnLevel);
-  }
-  error(fn) {
-    this.print(console.error.bind(console), fn, ErrorLevel);
-  }
-  fatal(fn) {
-    this.print(console.error.bind(console), fn, FatalLevel);
-  }
-  log(level, fn) {
-    switch (level) {
-      case "trace":
-        this.trace(fn);
-        break;
-      case "debug":
-        this.debug(fn);
-        break;
-      case "info":
-        this.info(fn);
-        break;
-      case "warn":
-        this.warn(fn);
-        break;
-      case "error":
-        this.error(fn);
-        break;
-      case "fatal":
-        this.fatal(fn);
-        break;
-      default:
-        throw new Error(`Unknown log level: ${level}`);
-    }
-  }
-}
-export {
-  Format,
-  LogLevel,
-  NativeLogger,
-  getLogger,
-  parseDirectives,
-  parseLogLevel,
-  resolveLevel,
-  setGlobalDirectives
+var inBrowser = typeof window !== "undefined" && typeof window.document !== "undefined";
+var FormatJson = "json";
+var Format = z.enum([FormatJson, "plain"]);
+/**
+* Native logger which uses console.log, console.error, etc, without any libraries.
+*/
+var NativeLogger = class NativeLogger {
+	constructor(scope, levelMap = logLevelMap) {
+		this.scope = scope;
+		this.levelMap = levelMap;
+		this.pretty = 0;
+		this.printStack = false;
+		this.format = FormatJson;
+		this.level = InfoLevel;
+	}
+	setFormat(format) {
+		this.format = format;
+		if (this.format !== FormatJson) throw new Error("Only JSON format implemented for now");
+	}
+	getFormat() {
+		return this.format;
+	}
+	with(obj, subscope) {
+		const trimmedSubscope = subscope?.trim();
+		const newScope = trimmedSubscope ? this.scope ? `${this.scope}:${trimmedSubscope}` : trimmedSubscope : this.scope;
+		const newLogger = new NativeLogger(newScope, this.levelMap);
+		if (Object.keys(obj).length > 0) newLogger.defaultData = {
+			...this.defaultData,
+			...obj
+		};
+		else if (this.defaultData) newLogger.defaultData = this.defaultData;
+		newLogger.setPretty(this.getPretty());
+		newLogger.setPrintStack(this.getPrintStack());
+		newLogger.setLogLevel(this.getLogLevel());
+		return newLogger;
+	}
+	getPrintStack() {
+		return this.printStack;
+	}
+	setPrintStack(printStack) {
+		this.printStack = printStack;
+	}
+	getPretty() {
+		return this.pretty > 0;
+	}
+	setPretty(pretty) {
+		this.pretty = pretty ? 2 : 0;
+	}
+	getScope() {
+		return this.scope;
+	}
+	setLogLevel(level) {
+		this.level = level;
+	}
+	getLogLevel() {
+		return this.level;
+	}
+	unpackError(err) {
+		const e = err;
+		const data = {};
+		for (const key of Object.getOwnPropertyNames(err)) {
+			if (!this.printStack && (key === "stack" || key === "stacktrace")) continue;
+			data[key] = e[key];
+		}
+		if (!data.name) data.name = err.name ?? "Error";
+		const cause = e.cause;
+		if (cause !== void 0) if (cause instanceof Error || typeof cause === "object" && cause !== null) data.cause = this.unpackError(cause);
+		else data.cause = cause;
+		return {
+			msg: String(e.translationKey ?? e.message ?? e.msg ?? ""),
+			data
+		};
+	}
+	print(dest, fn, level) {
+		const effectiveLevelNum = this.levelMap[resolveLevel(this.scope, getGlobalDirectives(), this.level)];
+		if (this.levelMap[level] < effectiveLevelNum) return;
+		const ts = (/* @__PURE__ */ new Date()).toISOString();
+		let { data, msg, err } = fn();
+		let errMsg;
+		let errData;
+		if (err) if (err instanceof Error || typeof err === "object") {
+			const result = this.unpackError(err);
+			errMsg = result.msg;
+			errData = result.data;
+		} else errMsg = String(err);
+		if (this.defaultData) data = {
+			...this.defaultData,
+			...data
+		};
+		const dataMaybeRequestId = data;
+		const reqId = dataMaybeRequestId && typeof dataMaybeRequestId.requestId === "string" ? dataMaybeRequestId.requestId : void 0;
+		const baseRecord = {
+			scope: this.scope,
+			ts,
+			level
+		};
+		if (reqId) baseRecord.req_id = reqId;
+		if (data) baseRecord.data = data;
+		if (msg) baseRecord.msg = msg;
+		if (errMsg) baseRecord.err = errMsg;
+		if (errData) baseRecord.errData = errData;
+		if (inBrowser) if (msg || errMsg) dest(msg || errMsg, baseRecord);
+		else dest(baseRecord);
+		else {
+			const logRecord = stringifyBigInts(baseRecord);
+			dest(JSON.stringify(logRecord, null, this.pretty));
+		}
+	}
+	info(fn) {
+		this.print(console.info.bind(console), fn, InfoLevel);
+	}
+	debug(fn) {
+		this.print(console.debug.bind(console), fn, DebugLevel);
+	}
+	trace(fn) {
+		this.print(console.trace.bind(console), fn, TraceLevel);
+	}
+	warn(fn) {
+		this.print(console.warn.bind(console), fn, WarnLevel);
+	}
+	error(fn) {
+		this.print(console.error.bind(console), fn, ErrorLevel);
+	}
+	fatal(fn) {
+		this.print(console.error.bind(console), fn, FatalLevel);
+	}
+	log(level, fn) {
+		switch (level) {
+			case "trace":
+				this.trace(fn);
+				break;
+			case "debug":
+				this.debug(fn);
+				break;
+			case "info":
+				this.info(fn);
+				break;
+			case "warn":
+				this.warn(fn);
+				break;
+			case "error":
+				this.error(fn);
+				break;
+			case "fatal":
+				this.fatal(fn);
+				break;
+			default: throw new Error(`Unknown log level: ${level}`);
+		}
+	}
 };
+//#endregion
+export { Format, LogLevel, NativeLogger, getLogger, parseDirectives, parseLogLevel, resolveLevel, setGlobalDirectives };

package/dist/tests/loggerBrowser.unit.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=loggerBrowser.unit.test.d.ts.map

package/dist/tests/loggerBrowser.unit.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"loggerBrowser.unit.test.d.ts","sourceRoot":"","sources":["../../src/tests/loggerBrowser.unit.test.ts"],"names":[],"mappings":""}

package/dist/tests/loggerBrowser.unit.test.js

@@ -0,0 +1,34 @@
+import { afterEach, beforeEach, describe, expect, it, vi, } from "vitest";
+import { getLogger, setGlobalDirectives } from "../logger.js";
+let info;
+let error;
+beforeEach(() => {
+    setGlobalDirectives("");
+    info = vi.fn();
+    error = vi.fn();
+    vi.spyOn(console, "info").mockImplementation(info);
+    vi.spyOn(console, "error").mockImplementation(error);
+});
+afterEach(() => {
+    vi.restoreAllMocks();
+});
+describe("NativeLogger in a browser", () => {
+    it("logs the message and the record separately so dev tools can expand it", () => {
+        getLogger("info", "scope").info(() => ({ msg: "hello" }));
+        expect(info).toHaveBeenCalledWith("hello", expect.objectContaining({ msg: "hello", scope: "scope", level: "info" }));
+    });
+    it("falls back to the error message when there is no msg", () => {
+        getLogger("info", "scope").error(() => ({ err: new Error("boom") }));
+        expect(error).toHaveBeenCalledWith("boom", expect.objectContaining({ err: "boom" }));
+    });
+    it("logs the bare record when there is neither a message nor an error", () => {
+        getLogger("info", "scope").info(() => ({ data: { a: 1 } }));
+        expect(info).toHaveBeenCalledWith(expect.objectContaining({ data: { a: 1 }, scope: "scope" }));
+        expect(info.mock.calls[0]).toHaveLength(1);
+    });
+    it("does not serialise the record to a string", () => {
+        getLogger("info", "scope").info(() => ({ msg: "hello" }));
+        expect(typeof info.mock.calls[0]?.[1]).toBe("object");
+    });
+});
+//# sourceMappingURL=loggerBrowser.unit.test.js.map

package/dist/tests/loggerBrowser.unit.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"loggerBrowser.unit.test.js","sourceRoot":"","sources":["../../src/tests/loggerBrowser.unit.test.ts"],"names":[],"mappings":"AAgBA,OAAO,EAEN,SAAS,EACT,UAAU,EACV,QAAQ,EACR,MAAM,EACN,EAAE,EACF,EAAE,GACF,MAAM,QAAQ,CAAC;AAEhB,OAAO,EAAE,SAAS,EAAE,mBAAmB,EAAE,MAAM,cAAc,CAAC;AAQ9D,IAAI,IAAiB,CAAC;AACtB,IAAI,KAAkB,CAAC;AAEvB,UAAU,CAAC,GAAG,EAAE;IACf,mBAAmB,CAAC,EAAE,CAAC,CAAC;IACxB,IAAI,GAAG,EAAE,CAAC,EAAE,EAAgC,CAAC;IAC7C,KAAK,GAAG,EAAE,CAAC,EAAE,EAAgC,CAAC;IAC9C,EAAE,CAAC,KAAK,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC,kBAAkB,CAAC,IAAI,CAAC,CAAC;IACnD,EAAE,CAAC,KAAK,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAC;AACtD,CAAC,CAAC,CAAC;AAEH,SAAS,CAAC,GAAG,EAAE;IACd,EAAE,CAAC,eAAe,EAAE,CAAC;AACtB,CAAC,CAAC,CAAC;AAEH,QAAQ,CAAC,2BAA2B,EAAE,GAAG,EAAE;IAC1C,EAAE,CAAC,uEAAuE,EAAE,GAAG,EAAE;QAChF,SAAS,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,IAAI,CAAC,GAAc,EAAE,CAAC,CAAC,EAAE,GAAG,EAAE,OAAO,EAAE,CAAC,CAAC,CAAC;QAErE,MAAM,CAAC,IAAI,CAAC,CAAC,oBAAoB,CAChC,OAAO,EACP,MAAM,CAAC,gBAAgB,CAAC,EAAE,GAAG,EAAE,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC,CACxE,CAAC;IACH,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,sDAAsD,EAAE,GAAG,EAAE;QAC/D,SAAS,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,KAAK,CAC/B,GAAc,EAAE,CAAC,CAAC,EAAE,GAAG,EAAE,IAAI,KAAK,CAAC,MAAM,CAAC,EAAE,CAAC,CAC7C,CAAC;QAEF,MAAM,CAAC,KAAK,CAAC,CAAC,oBAAoB,CACjC,MAAM,EACN,MAAM,CAAC,gBAAgB,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,CAAC,CACxC,CAAC;IACH,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,mEAAmE,EAAE,GAAG,EAAE;QAC5E,SAAS,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,IAAI,CAAC,GAAc,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,EAAE,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC;QAEvE,MAAM,CAAC,IAAI,CAAC,CAAC,oBAAoB,CAChC,MAAM,CAAC,gBAAgB,CAAC,EAAE,IAAI,EAAE,EAAE,CAAC,EAAE,CAAC,EAAE,EAAE,KAAK,EAAE,OAAO,EAAE,CAAC,CAC3D,CAAC;QACF,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;IAC5C,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,2CAA2C,EAAE,GAAG,EAAE;QACpD,SAAS,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,IAAI,CAAC,GAAc,EAAE,CAAC,CAAC,EAAE,GAAG,EAAE,OAAO,EAAE,CAAC,CAAC,CAAC;QAErE,MAAM,CAAC,OAAO,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IACvD,CAAC,CAAC,CAAC;AACJ,CAAC,CAAC,CAAC"}

package/dist/tests/loggerLevels.unit.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=loggerLevels.unit.test.d.ts.map

package/dist/tests/loggerLevels.unit.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"loggerLevels.unit.test.d.ts","sourceRoot":"","sources":["../../src/tests/loggerLevels.unit.test.ts"],"names":[],"mappings":""}