@holz/core 0.8.3-rc.172 → 0.8.3-rc.175

package/README.md

@@ -63,7 +63,7 @@ A `Log` object contains the following properties:
 - `message`: The verbatim log message. This property should not contain any interpolated data.
 - `level`: The severity of the log message, expressed as a member of the `LogLevel` enum. The available log levels are, in increasing order of severity: `trace`, `debug`, `info`, `warn`, `error`, `fatal`.
 - `origin`: The source of the log message. This property is an array of strings that typically identifies the library, module, or component that generated the log message, followed by more specific information. This property can be used to filter and group log messages based on their origin.
-- `context`: A dictionary of key-value pairs that provides additional context for the log message. The values in this object must be JSON serializable. Because it's easy to accidentally include unsuitable log context, such as PII or deeply nested objects, the use of nested objects in the context is discouraged.
+- `context`: A dictionary of key-value pairs that provides additional context for the log message. The values in this object must be JSON serializable, except for `error` which must be an `Error` instance.
 
 Here is an example of a log message expressed as a `Log` object:
 

package/dist/holz-core.d.ts

@@ -42,11 +42,19 @@ predicate: (log: Log) => boolean,
 processor: LogProcessor) => LogProcessor;
 
 declare interface JsonContext {
-    [key: string]: JsonPrimitive | ReadonlyArray<JsonPrimitive>;
+    [key: string]: JsonValue;
 }
 
 declare type JsonPrimitive = string | number | boolean | null | undefined;
 
+/**
+ * Any JSON-serializable value. Supports nested objects and arrays so log
+ * context can carry structured data.
+ */
+declare type JsonValue = JsonPrimitive | ReadonlyArray<JsonValue> | {
+    readonly [key: string]: JsonValue;
+};
+
 export declare const level: {
     /** A critical failure happened and the program must exit. */
     readonly fatal: 60;
@@ -84,10 +92,6 @@ export declare interface Log {
      *
      * These values must be JSON serializable.
      *
-     * Because it's easy to accidentally include unsuitable log context (e.g.
-     * redux state, PII) nested objects are not allowed. The restriction doesn't
-     * make it impossible, but it makes it harder to miss during code review.
-     *
      * @example { userId: 123, reason: 'disconnect' }
      */
     readonly context: LogContext;
@@ -146,7 +150,7 @@ export declare interface LogProcessor {
  * first, then falling back to any JSON value.
  */
 declare type StrictContext<Input> = {
-    [Key in keyof Input]: Key extends keyof CustomContext ? CustomContext[Key] : JsonPrimitive | ReadonlyArray<JsonPrimitive>;
+    [Key in keyof Input]: Key extends keyof CustomContext ? CustomContext[Key] : JsonValue;
 };
 
 export { }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@holz/core",
-  "version": "0.8.3-rc.172+825de79",
+  "version": "0.8.3-rc.175+ed2e609",
   "description": "A structured and composable logger",
   "type": "module",
   "repository": {
@@ -44,5 +44,5 @@
     "vite-tsconfig-paths": "^6.0.0",
     "vitest": "^4.0.0"
   },
-  "gitHead": "825de79d6a02f0f1ee2f58836d0a10c37530e538"
+  "gitHead": "ed2e609533740bf1ed09e46ae81ca6eba426e87f"
 }