@zudojs/observability 1.2.0 → 1.2.2

package/README.md

@@ -86,7 +86,9 @@ Redaction is **on by default**, as it is in `@zudojs/logger`: with no
 (`DEFAULT_LOGGER_SECRET_FIELDS` — password, passphrase, secret, token, jwt,
 bearer, auth, authorization, cookie, session, sid, credential, api key,
 private key, client secret, card number, cvv, ssn, pin, otp and more) is
-redacted here too, along with this package's own `DEFAULT_SENSITIVE_FIELDS`.
+redacted here too. `DEFAULT_SENSITIVE_FIELDS` is that effective default list:
+the logger's `DEFAULT_LOGGER_SECRET_FIELDS` plus a few spellings of its own
+(`apikey`, `access_token`, `cardnumber`, …).
 Pass a config to change the rules, or `redaction: false` to turn it off.
 Before 1.2 redaction was off unless configured, so a `password` field was
 exported in the clear.
@@ -100,8 +102,8 @@ redacted the same way one written to a log field is.
 const obs = createObservability({
   serviceName: "api",
   redaction: {
-    // Setting `fields` replaces the default list (and the logger's rules).
-    fields: ["password", "token", "ssn"],
+    // `fields` adds to the defaults; they stay in force.
+    fields: ["nationalId", "taxNumber"],
     patterns: [/^x-.*-secret$/i],
     // "contains" (the default) matches on word boundaries: "userPassword"
     // and "x-api-key" match, "shippingAddress" and "authorId" do not.
@@ -117,6 +119,22 @@ obs.logger.info("login", {
 });
 ```
 
+`fields` **extends** the defaults (since 1.2.1): the default names and the
+logger's matcher stay in force, so a field list can only add redaction —
+`fields: ["nationalId"]` and `fields: [...DEFAULT_SENSITIVE_FIELDS, "nationalId"]`
+mean the same thing. In 1.2.0 a list replaced the defaults, and because
+`DEFAULT_SENSITIVE_FIELDS` then lacked `jwt`, `sid`, `pwd`, `passphrase` and
+`bearer`, spreading it redacted less than the default. To use your list alone,
+opt out explicitly:
+
+```typescript
+createObservability({
+  serviceName: "api",
+  // Only `ssn` is redacted — no default names, no logger matcher.
+  redaction: { fields: ["ssn"], replaceDefaults: true },
+});
+```
+
 Traversal handles the shapes secrets actually arrive in: arrays, nested
 objects, instances of your own classes (a DTO carrying a `password` field is
 redacted and keeps its prototype), and cyclic graphs (a request object in a log

package/dist/redaction/index.d.ts

@@ -3,5 +3,6 @@
  *
  * Sensitive field redaction for logs and traces.
  */
-export { createRedactor, createStructureRedactor, redactObject, redactValue, isSensitiveField, DEFAULT_SENSITIVE_FIELDS, CIRCULAR_MARKER, MAX_DEPTH_MARKER, } from "./redaction.core.js";
+export { createRedactor, createStructureRedactor, redactObject, redactValue, isSensitiveField, CIRCULAR_MARKER, MAX_DEPTH_MARKER, } from "./redaction.core.js";
+export { DEFAULT_SENSITIVE_FIELDS } from "./redaction.defaults.js";
 //# sourceMappingURL=index.d.ts.map

package/dist/redaction/index.js

@@ -3,5 +3,6 @@
  *
  * Sensitive field redaction for logs and traces.
  */
-export { createRedactor, createStructureRedactor, redactObject, redactValue, isSensitiveField, DEFAULT_SENSITIVE_FIELDS, CIRCULAR_MARKER, MAX_DEPTH_MARKER, } from "./redaction.core.js";
+export { createRedactor, createStructureRedactor, redactObject, redactValue, isSensitiveField, CIRCULAR_MARKER, MAX_DEPTH_MARKER, } from "./redaction.core.js";
+export { DEFAULT_SENSITIVE_FIELDS } from "./redaction.defaults.js";
 //# sourceMappingURL=index.js.map

package/dist/redaction/redaction.core.d.ts

@@ -17,8 +17,6 @@
  *     `x-api-key` are caught, not just the exact names in the list.
  */
 import type { RedactionConfig } from "../types.js";
-/** Default sensitive field names, matched case-insensitively. */
-export declare const DEFAULT_SENSITIVE_FIELDS: readonly string[];
 /** Marker used in place of a structure that was too deep or already seen. */
 export declare const CIRCULAR_MARKER = "[CIRCULAR]";
 export declare const MAX_DEPTH_MARKER = "[MAX_DEPTH]";

package/dist/redaction/redaction.core.js

@@ -17,39 +17,13 @@
  *     `x-api-key` are caught, not just the exact names in the list.
  */
 import { createDefaultSecretFieldMatcher } from "@zudojs/logger";
+import { DEFAULT_SENSITIVE_FIELDS } from "./redaction.defaults.js";
 /**
  * @zudojs/logger's default secret-name matcher. The default rules here
  * include it, so a field the logger redacts is never exported in the clear
  * by this package.
  */
 const isLoggerSecretField = createDefaultSecretFieldMatcher();
-/** Default sensitive field names, matched case-insensitively. */
-export const DEFAULT_SENSITIVE_FIELDS = [
-    "password",
-    "passwd",
-    "secret",
-    "token",
-    "authorization",
-    "auth",
-    "cookie",
-    "session",
-    "credential",
-    "api_key",
-    "apikey",
-    "access_token",
-    "refresh_token",
-    "private_key",
-    "client_secret",
-    "credit_card",
-    "creditcard",
-    "card_number",
-    "cardnumber",
-    "cvv",
-    "ssn",
-    "social_security",
-    "pin",
-    "otp",
-];
 const DEFAULT_REPLACEMENT = "[REDACTED]";
 const DEFAULT_MAX_DEPTH = 8;
 /** Marker used in place of a structure that was too deep or already seen. */
@@ -94,12 +68,16 @@ function wordJoins(key) {
     return joins;
 }
 function compile(config) {
-    const fields = (config?.fields ?? DEFAULT_SENSITIVE_FIELDS).map((field) => field.toLowerCase());
+    const configured = config?.fields;
+    const replaceDefaults = configured !== undefined && config?.replaceDefaults === true;
+    const fields = (replaceDefaults
+        ? configured
+        : [...DEFAULT_SENSITIVE_FIELDS, ...(configured ?? [])]).map((field) => field.toLowerCase());
     const patterns = config?.patterns ?? [];
     const matchMode = config?.matchMode ?? "contains";
     const exact = new Set(fields);
     const normalizedFields = new Set(fields.map((field) => field.replace(/[^a-z0-9]/g, "")).filter(Boolean));
-    const withLoggerDefaults = config?.fields === undefined && matchMode === "contains";
+    const withLoggerDefaults = !replaceDefaults && matchMode === "contains";
     const isSensitive = (key) => {
         const lower = key.toLowerCase();
         if (exact.has(lower))

package/dist/redaction/redaction.defaults.d.ts

@@ -0,0 +1,18 @@
+/**
+ * @zudojs/observability — Default redaction field list
+ *
+ * One list, built from @zudojs/logger's rather than copied from it, so the
+ * documented "extend the defaults" pattern
+ * (`fields: [...DEFAULT_SENSITIVE_FIELDS, "nationalId"]`) can never cover
+ * fewer names than the default rules do.
+ */
+/**
+ * Default sensitive field names, matched case-insensitively.
+ *
+ * Every entry of @zudojs/logger's `DEFAULT_LOGGER_SECRET_FIELDS` (password,
+ * passphrase, pwd, secret, token, jwt, bearer, auth, cookie, session, sid,
+ * credential, api key, card number, cvv, ssn, pin, otp, …) plus the
+ * spellings in {@link OBSERVABILITY_EXTRA_FIELDS}.
+ */
+export declare const DEFAULT_SENSITIVE_FIELDS: readonly string[];
+//# sourceMappingURL=redaction.defaults.d.ts.map

package/dist/redaction/redaction.defaults.js

@@ -0,0 +1,33 @@
+/**
+ * @zudojs/observability — Default redaction field list
+ *
+ * One list, built from @zudojs/logger's rather than copied from it, so the
+ * documented "extend the defaults" pattern
+ * (`fields: [...DEFAULT_SENSITIVE_FIELDS, "nationalId"]`) can never cover
+ * fewer names than the default rules do.
+ */
+import { DEFAULT_LOGGER_SECRET_FIELDS } from "@zudojs/logger";
+/**
+ * Spellings this package matched before it adopted the logger's list. In
+ * `"contains"` mode they are already covered by a logger entry; they are kept
+ * so `"exact"` mode (`apikey` vs `api_key`) does not lose them.
+ */
+const OBSERVABILITY_EXTRA_FIELDS = [
+    "apikey",
+    "access_token",
+    "refresh_token",
+    "creditcard",
+    "cardnumber",
+];
+/**
+ * Default sensitive field names, matched case-insensitively.
+ *
+ * Every entry of @zudojs/logger's `DEFAULT_LOGGER_SECRET_FIELDS` (password,
+ * passphrase, pwd, secret, token, jwt, bearer, auth, cookie, session, sid,
+ * credential, api key, card number, cvv, ssn, pin, otp, …) plus the
+ * spellings in {@link OBSERVABILITY_EXTRA_FIELDS}.
+ */
+export const DEFAULT_SENSITIVE_FIELDS = Object.freeze([
+    ...new Set([...DEFAULT_LOGGER_SECRET_FIELDS, ...OBSERVABILITY_EXTRA_FIELDS]),
+]);
+//# sourceMappingURL=redaction.defaults.js.map

package/dist/types/config.types.d.ts

@@ -50,11 +50,18 @@ export type RedactionMatchMode = "exact" | "contains";
 /** Configuration for redacting sensitive fields from logs and traces. */
 export interface RedactionConfig {
     /**
-     * Field names to redact (case-insensitive). Defaults to a built-in list
-     * covering passwords, tokens, cookies, keys and card numbers, plus every
-     * name @zudojs/logger's default matcher redacts. Setting it replaces both.
+     * Extra field names to redact (case-insensitive), added to the defaults:
+     * `DEFAULT_SENSITIVE_FIELDS` and @zudojs/logger's default matcher stay in
+     * force, so a list can only ever add redaction. Set
+     * {@link RedactionConfig.replaceDefaults} to use this list alone.
      */
     readonly fields?: readonly string[];
+    /**
+     * `true` makes {@link RedactionConfig.fields} replace the default names and
+     * the logger's matcher instead of extending them — the pre-1.2.1 meaning
+     * of `fields`. Ignored when `fields` is not set. Default: `false`.
+     */
+    readonly replaceDefaults?: boolean;
     /**
      * Additional patterns tested against the field name. Useful for
      * conventions a name list cannot express, such as `/^x-.*-token$/i`.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zudojs/observability",
-  "version": "1.2.0",
+  "version": "1.2.2",
   "description": "Structured logging, metrics, tracing, context propagation, and exporters for Zudojs applications.",
   "license": "MIT",
   "author": {
@@ -26,8 +26,8 @@
     "!dist/.tsbuildinfo"
   ],
   "dependencies": {
-    "@zudojs/errors": "1.3.0",
-    "@zudojs/logger": "1.4.0"
+    "@zudojs/errors": "1.3.1",
+    "@zudojs/logger": "1.4.2"
   },
   "devDependencies": {
     "typescript": "7.0.2",