@logtape/redaction 1.4.0-dev.413 → 1.4.0-dev.417

package/dist/field.cjs

@@ -96,16 +96,27 @@ function redactProperties(properties, options, visited = /* @__PURE__ */ new Map
 			continue;
 		}
 		const value = properties[field];
-		if (Array.isArray(value)) copy[field] = value.map((item) => {
-			if (typeof item === "object" && item !== null) return redactProperties(item, options, visited);
-			return item;
-		});
+		if (Array.isArray(value)) copy[field] = redactArray(value, options, visited);
 		else if (typeof value === "object" && value !== null) copy[field] = redactProperties(value, options, visited);
 		else copy[field] = value;
 	}
 	return copy;
 }
 /**
+* Redacts sensitive fields in an array recursively.
+* @param array The array to process.
+* @param options The redaction options.
+* @param visited Map of visited objects to prevent circular reference issues.
+* @returns A new array with redacted values.
+*/
+function redactArray(array, options, visited) {
+	return array.map((item) => {
+		if (Array.isArray(item)) return redactArray(item, options, visited);
+		if (typeof item === "object" && item !== null) return redactProperties(item, options, visited);
+		return item;
+	});
+}
+/**
 * Checks if a field should be redacted based on the provided field patterns.
 * @param field The field name to check.
 * @param fieldPatterns The field patterns to match against.

package/dist/field.js

@@ -95,16 +95,27 @@ function redactProperties(properties, options, visited = /* @__PURE__ */ new Map
 			continue;
 		}
 		const value = properties[field];
-		if (Array.isArray(value)) copy[field] = value.map((item) => {
-			if (typeof item === "object" && item !== null) return redactProperties(item, options, visited);
-			return item;
-		});
+		if (Array.isArray(value)) copy[field] = redactArray(value, options, visited);
 		else if (typeof value === "object" && value !== null) copy[field] = redactProperties(value, options, visited);
 		else copy[field] = value;
 	}
 	return copy;
 }
 /**
+* Redacts sensitive fields in an array recursively.
+* @param array The array to process.
+* @param options The redaction options.
+* @param visited Map of visited objects to prevent circular reference issues.
+* @returns A new array with redacted values.
+*/
+function redactArray(array, options, visited) {
+	return array.map((item) => {
+		if (Array.isArray(item)) return redactArray(item, options, visited);
+		if (typeof item === "object" && item !== null) return redactProperties(item, options, visited);
+		return item;
+	});
+}
+/**
 * Checks if a field should be redacted based on the provided field patterns.
 * @param field The field name to check.
 * @param fieldPatterns The field patterns to match against.

package/dist/field.js.map

@@ -1 +1 @@
-{"version":3,"file":"field.js","names":["DEFAULT_REDACT_FIELDS: FieldPatterns","sink: Sink | Sink & Disposable | Sink & AsyncDisposable","options: FieldRedactionOptions | FieldPatterns","record: LogRecord","properties: Record<string, unknown>","options: FieldRedactionOptions","copy: Record<string, unknown>","field: string","fieldPatterns: FieldPatterns","template: string","placeholders: string[]","path: string","segments: string[]","message: readonly unknown[]","redactedIndices: Set<number>","wildcardIndices: Set<number>","redactedProperties: Record<string, unknown>","action: \"delete\" | ((value: unknown) => unknown) | undefined","result: unknown[]","original: Record<string, unknown>","redacted: Record<string, unknown>","map: Map<unknown, unknown>","redactedValues: Map<unknown, unknown>"],"sources":["../src/field.ts"],"sourcesContent":["import type { LogRecord, Sink } from \"@logtape/logtape\";\n\n/**\n * The type for a field pattern used in redaction.  A string or a regular\n * expression that matches field names.\n * @since 0.10.0\n */\nexport type FieldPattern = string | RegExp;\n\n/**\n * An array of field patterns used for redaction.  Each pattern can be\n * a string or a regular expression that matches field names.\n * @since 0.10.0\n */\nexport type FieldPatterns = FieldPattern[];\n\n/**\n * Default field patterns for redaction.  These patterns will match\n * common sensitive fields such as passwords, tokens, and personal\n * information.\n * @since 0.10.0\n */\nexport const DEFAULT_REDACT_FIELDS: FieldPatterns = [\n  /pass(?:code|phrase|word)/i,\n  /secret/i,\n  /token/i,\n  /key/i,\n  /credential/i,\n  /auth/i,\n  /signature/i,\n  /sensitive/i,\n  /private/i,\n  /ssn/i,\n  /email/i,\n  /phone/i,\n  /address/i,\n];\n\n/**\n * Options for redacting fields in a {@link LogRecord}.  Used by\n * the {@link redactByField} function.\n * @since 0.10.0\n */\nexport interface FieldRedactionOptions {\n  /**\n   * The field patterns to match against.  This can be an array of\n   * strings or regular expressions.  If a field matches any of the\n   * patterns, it will be redacted.\n   * @defaultValue {@link DEFAULT_REDACT_FIELDS}\n   */\n  readonly fieldPatterns: FieldPatterns;\n\n  /**\n   * The action to perform on the matched fields.  If not provided,\n   * the default action is to delete the field from the properties.\n   * If a function is provided, it will be called with the\n   * value of the field, and the return value will be used to replace\n   * the field in the properties.\n   * If the action is `\"delete\"`, the field will be removed from the\n   * properties.\n   * @default `\"delete\"`\n   */\n  readonly action?: \"delete\" | ((value: unknown) => unknown);\n}\n\n/**\n * Redacts properties and message values in a {@link LogRecord} based on the\n * provided field patterns and action.\n *\n * Note that it is a decorator which wraps the sink and redacts properties\n * and message values before passing them to the sink.\n *\n * For string templates (e.g., `\"Hello, {name}!\"`), placeholder names are\n * matched against the field patterns to determine which values to redact.\n *\n * For tagged template literals (e.g., `` `Hello, ${name}!` ``), redaction\n * is performed by comparing message values with redacted property values.\n *\n * @example\n * ```ts\n * import { getConsoleSink } from \"@logtape/logtape\";\n * import { redactByField } from \"@logtape/redaction\";\n *\n * const sink = redactByField(getConsoleSink());\n * ```\n *\n * @param sink The sink to wrap.\n * @param options The redaction options.\n * @returns The wrapped sink.\n * @since 0.10.0\n */\nexport function redactByField(\n  sink: Sink | Sink & Disposable | Sink & AsyncDisposable,\n  options: FieldRedactionOptions | FieldPatterns = DEFAULT_REDACT_FIELDS,\n): Sink | Sink & Disposable | Sink & AsyncDisposable {\n  const opts = Array.isArray(options) ? { fieldPatterns: options } : options;\n  const wrapped = (record: LogRecord) => {\n    const redactedProperties = redactProperties(record.properties, opts);\n    let redactedMessage = record.message;\n\n    if (typeof record.rawMessage === \"string\") {\n      // String template: redact by placeholder names\n      const placeholders = extractPlaceholderNames(record.rawMessage);\n      const { redactedIndices, wildcardIndices } =\n        getRedactedPlaceholderIndices(\n          placeholders,\n          opts.fieldPatterns,\n        );\n      if (redactedIndices.size > 0 || wildcardIndices.size > 0) {\n        redactedMessage = redactMessageArray(\n          record.message,\n          redactedIndices,\n          wildcardIndices,\n          redactedProperties,\n          opts.action,\n        );\n      }\n    } else {\n      // Tagged template: redact by comparing values\n      const redactedValues = getRedactedValues(\n        record.properties,\n        redactedProperties,\n      );\n      if (redactedValues.size > 0) {\n        redactedMessage = redactMessageByValues(record.message, redactedValues);\n      }\n    }\n\n    sink({\n      ...record,\n      message: redactedMessage,\n      properties: redactedProperties,\n    });\n  };\n  if (Symbol.dispose in sink) wrapped[Symbol.dispose] = sink[Symbol.dispose];\n  if (Symbol.asyncDispose in sink) {\n    wrapped[Symbol.asyncDispose] = sink[Symbol.asyncDispose];\n  }\n  return wrapped;\n}\n\n/**\n * Redacts properties from an object based on specified field patterns.\n *\n * This function creates a shallow copy of the input object and applies\n * redaction rules to its properties. For properties that match the redaction\n * patterns, the function either removes them or transforms their values based\n * on the provided action.\n *\n * The redaction process is recursive and will be applied to nested objects\n * as well, allowing for deep redaction of sensitive data in complex object\n * structures.\n * @param properties The properties to redact.\n * @param options The redaction options.\n * @returns The redacted properties.\n * @since 0.10.0\n */\nexport function redactProperties(\n  properties: Record<string, unknown>,\n  options: FieldRedactionOptions,\n  visited = new Map<object, object>(),\n): Record<string, unknown> {\n  if (visited.has(properties)) {\n    return visited.get(properties) as Record<string, unknown>;\n  }\n\n  const copy: Record<string, unknown> = {};\n  visited.set(properties, copy);\n\n  for (const field in properties) {\n    if (shouldFieldRedacted(field, options.fieldPatterns)) {\n      if (typeof options.action === \"function\") {\n        copy[field] = options.action(properties[field]);\n      }\n      continue;\n    }\n\n    const value = properties[field];\n    if (Array.isArray(value)) {\n      copy[field] = value.map((item) => {\n        if (typeof item === \"object\" && item !== null) {\n          return redactProperties(\n            item as Record<string, unknown>,\n            options,\n            visited,\n          );\n        }\n        return item;\n      });\n    } else if (typeof value === \"object\" && value !== null) {\n      copy[field] = redactProperties(\n        value as Record<string, unknown>,\n        options,\n        visited,\n      );\n    } else {\n      copy[field] = value;\n    }\n  }\n  return copy;\n}\n\n/**\n * Checks if a field should be redacted based on the provided field patterns.\n * @param field The field name to check.\n * @param fieldPatterns The field patterns to match against.\n * @returns `true` if the field should be redacted, `false` otherwise.\n * @since 0.10.0\n */\nexport function shouldFieldRedacted(\n  field: string,\n  fieldPatterns: FieldPatterns,\n): boolean {\n  for (const fieldPattern of fieldPatterns) {\n    if (typeof fieldPattern === \"string\") {\n      if (fieldPattern === field) return true;\n    } else {\n      if (fieldPattern.test(field)) return true;\n    }\n  }\n  return false;\n}\n\n/**\n * Extracts placeholder names from a message template string in order.\n * @param template The message template string.\n * @returns An array of placeholder names in the order they appear.\n */\nfunction extractPlaceholderNames(template: string): string[] {\n  const placeholders: string[] = [];\n  for (let i = 0; i < template.length; i++) {\n    if (template[i] === \"{\") {\n      // Check for escaped brace\n      if (i + 1 < template.length && template[i + 1] === \"{\") {\n        i++;\n        continue;\n      }\n      const closeIndex = template.indexOf(\"}\", i + 1);\n      if (closeIndex === -1) continue;\n      const key = template.slice(i + 1, closeIndex).trim();\n      placeholders.push(key);\n      i = closeIndex;\n    }\n  }\n  return placeholders;\n}\n\n/**\n * Parses a property path into its segments.\n * @param path The property path (e.g., \"user.password\" or \"users[0].email\").\n * @returns An array of path segments.\n */\nfunction parsePathSegments(path: string): string[] {\n  const segments: string[] = [];\n  let current = \"\";\n  for (const char of path) {\n    if (char === \".\" || char === \"[\") {\n      if (current) segments.push(current);\n      current = \"\";\n    } else if (char === \"]\" || char === \"?\") {\n      // Skip these characters\n    } else {\n      current += char;\n    }\n  }\n  if (current) segments.push(current);\n  return segments;\n}\n\n/**\n * Determines which placeholder indices should be redacted based on field\n * patterns, and which are wildcard placeholders.\n * @param placeholders Array of placeholder names from the template.\n * @param fieldPatterns Field patterns to match against.\n * @returns Object with redactedIndices and wildcardIndices.\n */\nfunction getRedactedPlaceholderIndices(\n  placeholders: string[],\n  fieldPatterns: FieldPatterns,\n): { redactedIndices: Set<number>; wildcardIndices: Set<number> } {\n  const redactedIndices = new Set<number>();\n  const wildcardIndices = new Set<number>();\n\n  for (let i = 0; i < placeholders.length; i++) {\n    const placeholder = placeholders[i];\n\n    // Track wildcard {*} separately\n    if (placeholder === \"*\") {\n      wildcardIndices.add(i);\n      continue;\n    }\n\n    // Check the full placeholder name\n    if (shouldFieldRedacted(placeholder, fieldPatterns)) {\n      redactedIndices.add(i);\n      continue;\n    }\n    // For nested paths, check each segment\n    const segments = parsePathSegments(placeholder);\n    for (const segment of segments) {\n      if (shouldFieldRedacted(segment, fieldPatterns)) {\n        redactedIndices.add(i);\n        break;\n      }\n    }\n  }\n  return { redactedIndices, wildcardIndices };\n}\n\n/**\n * Redacts values in the message array based on the redacted placeholder\n * indices and wildcard indices.\n * @param message The original message array.\n * @param redactedIndices Set of placeholder indices to redact.\n * @param wildcardIndices Set of wildcard placeholder indices.\n * @param redactedProperties The redacted properties object.\n * @param action The redaction action.\n * @returns New message array with redacted values.\n */\nfunction redactMessageArray(\n  message: readonly unknown[],\n  redactedIndices: Set<number>,\n  wildcardIndices: Set<number>,\n  redactedProperties: Record<string, unknown>,\n  action: \"delete\" | ((value: unknown) => unknown) | undefined,\n): readonly unknown[] {\n  if (redactedIndices.size === 0 && wildcardIndices.size === 0) return message;\n\n  const result: unknown[] = [];\n  let placeholderIndex = 0;\n\n  for (let i = 0; i < message.length; i++) {\n    if (i % 2 === 0) {\n      // Even index: text segment\n      result.push(message[i]);\n    } else {\n      // Odd index: value/placeholder\n      if (wildcardIndices.has(placeholderIndex)) {\n        // Wildcard {*}: replace with redacted properties\n        result.push(redactedProperties);\n      } else if (redactedIndices.has(placeholderIndex)) {\n        if (action == null || action === \"delete\") {\n          result.push(\"\");\n        } else {\n          result.push(action(message[i]));\n        }\n      } else {\n        result.push(message[i]);\n      }\n      placeholderIndex++;\n    }\n  }\n  return result;\n}\n\n/**\n * Collects redacted value mappings from original to redacted properties.\n * @param original The original properties.\n * @param redacted The redacted properties.\n * @param map The map to populate with original -> redacted value pairs.\n */\nfunction collectRedactedValues(\n  original: Record<string, unknown>,\n  redacted: Record<string, unknown>,\n  map: Map<unknown, unknown>,\n): void {\n  for (const key in original) {\n    const origVal = original[key];\n    const redVal = redacted[key];\n\n    if (origVal !== redVal) {\n      map.set(origVal, redVal);\n    }\n\n    // Recurse into nested objects\n    if (\n      typeof origVal === \"object\" && origVal !== null &&\n      typeof redVal === \"object\" && redVal !== null &&\n      !Array.isArray(origVal)\n    ) {\n      collectRedactedValues(\n        origVal as Record<string, unknown>,\n        redVal as Record<string, unknown>,\n        map,\n      );\n    }\n  }\n}\n\n/**\n * Gets a map of original values to their redacted replacements.\n * @param original The original properties.\n * @param redacted The redacted properties.\n * @returns A map of original -> redacted values.\n */\nfunction getRedactedValues(\n  original: Record<string, unknown>,\n  redacted: Record<string, unknown>,\n): Map<unknown, unknown> {\n  const map = new Map<unknown, unknown>();\n  collectRedactedValues(original, redacted, map);\n  return map;\n}\n\n/**\n * Redacts message array values by comparing with redacted property values.\n * Used for tagged template literals where placeholder names are not available.\n * @param message The original message array.\n * @param redactedValues Map of original -> redacted values.\n * @returns New message array with redacted values.\n */\nfunction redactMessageByValues(\n  message: readonly unknown[],\n  redactedValues: Map<unknown, unknown>,\n): readonly unknown[] {\n  if (redactedValues.size === 0) return message;\n\n  const result: unknown[] = [];\n  for (let i = 0; i < message.length; i++) {\n    if (i % 2 === 0) {\n      result.push(message[i]);\n    } else {\n      const val = message[i];\n      if (redactedValues.has(val)) {\n        result.push(redactedValues.get(val));\n      } else {\n        result.push(val);\n      }\n    }\n  }\n  return result;\n}\n"],"mappings":";;;;;;;AAsBA,MAAaA,wBAAuC;CAClD;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;AACD;;;;;;;;;;;;;;;;;;;;;;;;;;;AAuDD,SAAgB,cACdC,MACAC,UAAiD,uBACE;CACnD,MAAM,OAAO,MAAM,QAAQ,QAAQ,GAAG,EAAE,eAAe,QAAS,IAAG;CACnE,MAAM,UAAU,CAACC,WAAsB;EACrC,MAAM,qBAAqB,iBAAiB,OAAO,YAAY,KAAK;EACpE,IAAI,kBAAkB,OAAO;AAE7B,aAAW,OAAO,eAAe,UAAU;GAEzC,MAAM,eAAe,wBAAwB,OAAO,WAAW;GAC/D,MAAM,EAAE,iBAAiB,iBAAiB,GACxC,8BACE,cACA,KAAK,cACN;AACH,OAAI,gBAAgB,OAAO,KAAK,gBAAgB,OAAO,EACrD,mBAAkB,mBAChB,OAAO,SACP,iBACA,iBACA,oBACA,KAAK,OACN;EAEJ,OAAM;GAEL,MAAM,iBAAiB,kBACrB,OAAO,YACP,mBACD;AACD,OAAI,eAAe,OAAO,EACxB,mBAAkB,sBAAsB,OAAO,SAAS,eAAe;EAE1E;AAED,OAAK;GACH,GAAG;GACH,SAAS;GACT,YAAY;EACb,EAAC;CACH;AACD,KAAI,OAAO,WAAW,KAAM,SAAQ,OAAO,WAAW,KAAK,OAAO;AAClE,KAAI,OAAO,gBAAgB,KACzB,SAAQ,OAAO,gBAAgB,KAAK,OAAO;AAE7C,QAAO;AACR;;;;;;;;;;;;;;;;;AAkBD,SAAgB,iBACdC,YACAC,SACA,0BAAU,IAAI,OACW;AACzB,KAAI,QAAQ,IAAI,WAAW,CACzB,QAAO,QAAQ,IAAI,WAAW;CAGhC,MAAMC,OAAgC,CAAE;AACxC,SAAQ,IAAI,YAAY,KAAK;AAE7B,MAAK,MAAM,SAAS,YAAY;AAC9B,MAAI,oBAAoB,OAAO,QAAQ,cAAc,EAAE;AACrD,cAAW,QAAQ,WAAW,WAC5B,MAAK,SAAS,QAAQ,OAAO,WAAW,OAAO;AAEjD;EACD;EAED,MAAM,QAAQ,WAAW;AACzB,MAAI,MAAM,QAAQ,MAAM,CACtB,MAAK,SAAS,MAAM,IAAI,CAAC,SAAS;AAChC,cAAW,SAAS,YAAY,SAAS,KACvC,QAAO,iBACL,MACA,SACA,QACD;AAEH,UAAO;EACR,EAAC;kBACc,UAAU,YAAY,UAAU,KAChD,MAAK,SAAS,iBACZ,OACA,SACA,QACD;MAED,MAAK,SAAS;CAEjB;AACD,QAAO;AACR;;;;;;;;AASD,SAAgB,oBACdC,OACAC,eACS;AACT,MAAK,MAAM,gBAAgB,cACzB,YAAW,iBAAiB,UAC1B;MAAI,iBAAiB,MAAO,QAAO;CAAK,WAEpC,aAAa,KAAK,MAAM,CAAE,QAAO;AAGzC,QAAO;AACR;;;;;;AAOD,SAAS,wBAAwBC,UAA4B;CAC3D,MAAMC,eAAyB,CAAE;AACjC,MAAK,IAAI,IAAI,GAAG,IAAI,SAAS,QAAQ,IACnC,KAAI,SAAS,OAAO,KAAK;AAEvB,MAAI,IAAI,IAAI,SAAS,UAAU,SAAS,IAAI,OAAO,KAAK;AACtD;AACA;EACD;EACD,MAAM,aAAa,SAAS,QAAQ,KAAK,IAAI,EAAE;AAC/C,MAAI,eAAe,GAAI;EACvB,MAAM,MAAM,SAAS,MAAM,IAAI,GAAG,WAAW,CAAC,MAAM;AACpD,eAAa,KAAK,IAAI;AACtB,MAAI;CACL;AAEH,QAAO;AACR;;;;;;AAOD,SAAS,kBAAkBC,MAAwB;CACjD,MAAMC,WAAqB,CAAE;CAC7B,IAAI,UAAU;AACd,MAAK,MAAM,QAAQ,KACjB,KAAI,SAAS,OAAO,SAAS,KAAK;AAChC,MAAI,QAAS,UAAS,KAAK,QAAQ;AACnC,YAAU;CACX,WAAU,SAAS,OAAO,SAAS,KAAK,CAExC,MACC,YAAW;AAGf,KAAI,QAAS,UAAS,KAAK,QAAQ;AACnC,QAAO;AACR;;;;;;;;AASD,SAAS,8BACPF,cACAF,eACgE;CAChE,MAAM,kCAAkB,IAAI;CAC5B,MAAM,kCAAkB,IAAI;AAE5B,MAAK,IAAI,IAAI,GAAG,IAAI,aAAa,QAAQ,KAAK;EAC5C,MAAM,cAAc,aAAa;AAGjC,MAAI,gBAAgB,KAAK;AACvB,mBAAgB,IAAI,EAAE;AACtB;EACD;AAGD,MAAI,oBAAoB,aAAa,cAAc,EAAE;AACnD,mBAAgB,IAAI,EAAE;AACtB;EACD;EAED,MAAM,WAAW,kBAAkB,YAAY;AAC/C,OAAK,MAAM,WAAW,SACpB,KAAI,oBAAoB,SAAS,cAAc,EAAE;AAC/C,mBAAgB,IAAI,EAAE;AACtB;EACD;CAEJ;AACD,QAAO;EAAE;EAAiB;CAAiB;AAC5C;;;;;;;;;;;AAYD,SAAS,mBACPK,SACAC,iBACAC,iBACAC,oBACAC,QACoB;AACpB,KAAI,gBAAgB,SAAS,KAAK,gBAAgB,SAAS,EAAG,QAAO;CAErE,MAAMC,SAAoB,CAAE;CAC5B,IAAI,mBAAmB;AAEvB,MAAK,IAAI,IAAI,GAAG,IAAI,QAAQ,QAAQ,IAClC,KAAI,IAAI,MAAM,EAEZ,QAAO,KAAK,QAAQ,GAAG;MAClB;AAEL,MAAI,gBAAgB,IAAI,iBAAiB,CAEvC,QAAO,KAAK,mBAAmB;WACtB,gBAAgB,IAAI,iBAAiB,CAC9C,KAAI,UAAU,QAAQ,WAAW,SAC/B,QAAO,KAAK,GAAG;MAEf,QAAO,KAAK,OAAO,QAAQ,GAAG,CAAC;MAGjC,QAAO,KAAK,QAAQ,GAAG;AAEzB;CACD;AAEH,QAAO;AACR;;;;;;;AAQD,SAAS,sBACPC,UACAC,UACAC,KACM;AACN,MAAK,MAAM,OAAO,UAAU;EAC1B,MAAM,UAAU,SAAS;EACzB,MAAM,SAAS,SAAS;AAExB,MAAI,YAAY,OACd,KAAI,IAAI,SAAS,OAAO;AAI1B,aACS,YAAY,YAAY,YAAY,eACpC,WAAW,YAAY,WAAW,SACxC,MAAM,QAAQ,QAAQ,CAEvB,uBACE,SACA,QACA,IACD;CAEJ;AACF;;;;;;;AAQD,SAAS,kBACPF,UACAC,UACuB;CACvB,MAAM,sBAAM,IAAI;AAChB,uBAAsB,UAAU,UAAU,IAAI;AAC9C,QAAO;AACR;;;;;;;;AASD,SAAS,sBACPP,SACAS,gBACoB;AACpB,KAAI,eAAe,SAAS,EAAG,QAAO;CAEtC,MAAMJ,SAAoB,CAAE;AAC5B,MAAK,IAAI,IAAI,GAAG,IAAI,QAAQ,QAAQ,IAClC,KAAI,IAAI,MAAM,EACZ,QAAO,KAAK,QAAQ,GAAG;MAClB;EACL,MAAM,MAAM,QAAQ;AACpB,MAAI,eAAe,IAAI,IAAI,CACzB,QAAO,KAAK,eAAe,IAAI,IAAI,CAAC;MAEpC,QAAO,KAAK,IAAI;CAEnB;AAEH,QAAO;AACR"}
+{"version":3,"file":"field.js","names":["DEFAULT_REDACT_FIELDS: FieldPatterns","sink: Sink | Sink & Disposable | Sink & AsyncDisposable","options: FieldRedactionOptions | FieldPatterns","record: LogRecord","properties: Record<string, unknown>","options: FieldRedactionOptions","copy: Record<string, unknown>","array: unknown[]","visited: Map<object, object>","field: string","fieldPatterns: FieldPatterns","template: string","placeholders: string[]","path: string","segments: string[]","message: readonly unknown[]","redactedIndices: Set<number>","wildcardIndices: Set<number>","redactedProperties: Record<string, unknown>","action: \"delete\" | ((value: unknown) => unknown) | undefined","result: unknown[]","original: Record<string, unknown>","redacted: Record<string, unknown>","map: Map<unknown, unknown>","redactedValues: Map<unknown, unknown>"],"sources":["../src/field.ts"],"sourcesContent":["import type { LogRecord, Sink } from \"@logtape/logtape\";\n\n/**\n * The type for a field pattern used in redaction.  A string or a regular\n * expression that matches field names.\n * @since 0.10.0\n */\nexport type FieldPattern = string | RegExp;\n\n/**\n * An array of field patterns used for redaction.  Each pattern can be\n * a string or a regular expression that matches field names.\n * @since 0.10.0\n */\nexport type FieldPatterns = FieldPattern[];\n\n/**\n * Default field patterns for redaction.  These patterns will match\n * common sensitive fields such as passwords, tokens, and personal\n * information.\n * @since 0.10.0\n */\nexport const DEFAULT_REDACT_FIELDS: FieldPatterns = [\n  /pass(?:code|phrase|word)/i,\n  /secret/i,\n  /token/i,\n  /key/i,\n  /credential/i,\n  /auth/i,\n  /signature/i,\n  /sensitive/i,\n  /private/i,\n  /ssn/i,\n  /email/i,\n  /phone/i,\n  /address/i,\n];\n\n/**\n * Options for redacting fields in a {@link LogRecord}.  Used by\n * the {@link redactByField} function.\n * @since 0.10.0\n */\nexport interface FieldRedactionOptions {\n  /**\n   * The field patterns to match against.  This can be an array of\n   * strings or regular expressions.  If a field matches any of the\n   * patterns, it will be redacted.\n   * @defaultValue {@link DEFAULT_REDACT_FIELDS}\n   */\n  readonly fieldPatterns: FieldPatterns;\n\n  /**\n   * The action to perform on the matched fields.  If not provided,\n   * the default action is to delete the field from the properties.\n   * If a function is provided, it will be called with the\n   * value of the field, and the return value will be used to replace\n   * the field in the properties.\n   * If the action is `\"delete\"`, the field will be removed from the\n   * properties.\n   * @default `\"delete\"`\n   */\n  readonly action?: \"delete\" | ((value: unknown) => unknown);\n}\n\n/**\n * Redacts properties and message values in a {@link LogRecord} based on the\n * provided field patterns and action.\n *\n * Note that it is a decorator which wraps the sink and redacts properties\n * and message values before passing them to the sink.\n *\n * For string templates (e.g., `\"Hello, {name}!\"`), placeholder names are\n * matched against the field patterns to determine which values to redact.\n *\n * For tagged template literals (e.g., `` `Hello, ${name}!` ``), redaction\n * is performed by comparing message values with redacted property values.\n *\n * @example\n * ```ts\n * import { getConsoleSink } from \"@logtape/logtape\";\n * import { redactByField } from \"@logtape/redaction\";\n *\n * const sink = redactByField(getConsoleSink());\n * ```\n *\n * @param sink The sink to wrap.\n * @param options The redaction options.\n * @returns The wrapped sink.\n * @since 0.10.0\n */\nexport function redactByField(\n  sink: Sink | Sink & Disposable | Sink & AsyncDisposable,\n  options: FieldRedactionOptions | FieldPatterns = DEFAULT_REDACT_FIELDS,\n): Sink | Sink & Disposable | Sink & AsyncDisposable {\n  const opts = Array.isArray(options) ? { fieldPatterns: options } : options;\n  const wrapped = (record: LogRecord) => {\n    const redactedProperties = redactProperties(record.properties, opts);\n    let redactedMessage = record.message;\n\n    if (typeof record.rawMessage === \"string\") {\n      // String template: redact by placeholder names\n      const placeholders = extractPlaceholderNames(record.rawMessage);\n      const { redactedIndices, wildcardIndices } =\n        getRedactedPlaceholderIndices(\n          placeholders,\n          opts.fieldPatterns,\n        );\n      if (redactedIndices.size > 0 || wildcardIndices.size > 0) {\n        redactedMessage = redactMessageArray(\n          record.message,\n          redactedIndices,\n          wildcardIndices,\n          redactedProperties,\n          opts.action,\n        );\n      }\n    } else {\n      // Tagged template: redact by comparing values\n      const redactedValues = getRedactedValues(\n        record.properties,\n        redactedProperties,\n      );\n      if (redactedValues.size > 0) {\n        redactedMessage = redactMessageByValues(record.message, redactedValues);\n      }\n    }\n\n    sink({\n      ...record,\n      message: redactedMessage,\n      properties: redactedProperties,\n    });\n  };\n  if (Symbol.dispose in sink) wrapped[Symbol.dispose] = sink[Symbol.dispose];\n  if (Symbol.asyncDispose in sink) {\n    wrapped[Symbol.asyncDispose] = sink[Symbol.asyncDispose];\n  }\n  return wrapped;\n}\n\n/**\n * Redacts properties from an object based on specified field patterns.\n *\n * This function creates a shallow copy of the input object and applies\n * redaction rules to its properties. For properties that match the redaction\n * patterns, the function either removes them or transforms their values based\n * on the provided action.\n *\n * The redaction process is recursive and will be applied to nested objects\n * as well, allowing for deep redaction of sensitive data in complex object\n * structures.\n * @param properties The properties to redact.\n * @param options The redaction options.\n * @returns The redacted properties.\n * @since 0.10.0\n */\nexport function redactProperties(\n  properties: Record<string, unknown>,\n  options: FieldRedactionOptions,\n  visited = new Map<object, object>(),\n): Record<string, unknown> {\n  if (visited.has(properties)) {\n    return visited.get(properties) as Record<string, unknown>;\n  }\n\n  const copy: Record<string, unknown> = {};\n  visited.set(properties, copy);\n\n  for (const field in properties) {\n    if (shouldFieldRedacted(field, options.fieldPatterns)) {\n      if (typeof options.action === \"function\") {\n        copy[field] = options.action(properties[field]);\n      }\n      continue;\n    }\n\n    const value = properties[field];\n    if (Array.isArray(value)) {\n      copy[field] = redactArray(value, options, visited);\n    } else if (typeof value === \"object\" && value !== null) {\n      copy[field] = redactProperties(\n        value as Record<string, unknown>,\n        options,\n        visited,\n      );\n    } else {\n      copy[field] = value;\n    }\n  }\n  return copy;\n}\n\n/**\n * Redacts sensitive fields in an array recursively.\n * @param array The array to process.\n * @param options The redaction options.\n * @param visited Map of visited objects to prevent circular reference issues.\n * @returns A new array with redacted values.\n */\nfunction redactArray(\n  array: unknown[],\n  options: FieldRedactionOptions,\n  visited: Map<object, object>,\n): unknown[] {\n  return array.map((item) => {\n    if (Array.isArray(item)) {\n      return redactArray(item, options, visited);\n    }\n    if (typeof item === \"object\" && item !== null) {\n      return redactProperties(\n        item as Record<string, unknown>,\n        options,\n        visited,\n      );\n    }\n    return item;\n  });\n}\n\n/**\n * Checks if a field should be redacted based on the provided field patterns.\n * @param field The field name to check.\n * @param fieldPatterns The field patterns to match against.\n * @returns `true` if the field should be redacted, `false` otherwise.\n * @since 0.10.0\n */\nexport function shouldFieldRedacted(\n  field: string,\n  fieldPatterns: FieldPatterns,\n): boolean {\n  for (const fieldPattern of fieldPatterns) {\n    if (typeof fieldPattern === \"string\") {\n      if (fieldPattern === field) return true;\n    } else {\n      if (fieldPattern.test(field)) return true;\n    }\n  }\n  return false;\n}\n\n/**\n * Extracts placeholder names from a message template string in order.\n * @param template The message template string.\n * @returns An array of placeholder names in the order they appear.\n */\nfunction extractPlaceholderNames(template: string): string[] {\n  const placeholders: string[] = [];\n  for (let i = 0; i < template.length; i++) {\n    if (template[i] === \"{\") {\n      // Check for escaped brace\n      if (i + 1 < template.length && template[i + 1] === \"{\") {\n        i++;\n        continue;\n      }\n      const closeIndex = template.indexOf(\"}\", i + 1);\n      if (closeIndex === -1) continue;\n      const key = template.slice(i + 1, closeIndex).trim();\n      placeholders.push(key);\n      i = closeIndex;\n    }\n  }\n  return placeholders;\n}\n\n/**\n * Parses a property path into its segments.\n * @param path The property path (e.g., \"user.password\" or \"users[0].email\").\n * @returns An array of path segments.\n */\nfunction parsePathSegments(path: string): string[] {\n  const segments: string[] = [];\n  let current = \"\";\n  for (const char of path) {\n    if (char === \".\" || char === \"[\") {\n      if (current) segments.push(current);\n      current = \"\";\n    } else if (char === \"]\" || char === \"?\") {\n      // Skip these characters\n    } else {\n      current += char;\n    }\n  }\n  if (current) segments.push(current);\n  return segments;\n}\n\n/**\n * Determines which placeholder indices should be redacted based on field\n * patterns, and which are wildcard placeholders.\n * @param placeholders Array of placeholder names from the template.\n * @param fieldPatterns Field patterns to match against.\n * @returns Object with redactedIndices and wildcardIndices.\n */\nfunction getRedactedPlaceholderIndices(\n  placeholders: string[],\n  fieldPatterns: FieldPatterns,\n): { redactedIndices: Set<number>; wildcardIndices: Set<number> } {\n  const redactedIndices = new Set<number>();\n  const wildcardIndices = new Set<number>();\n\n  for (let i = 0; i < placeholders.length; i++) {\n    const placeholder = placeholders[i];\n\n    // Track wildcard {*} separately\n    if (placeholder === \"*\") {\n      wildcardIndices.add(i);\n      continue;\n    }\n\n    // Check the full placeholder name\n    if (shouldFieldRedacted(placeholder, fieldPatterns)) {\n      redactedIndices.add(i);\n      continue;\n    }\n    // For nested paths, check each segment\n    const segments = parsePathSegments(placeholder);\n    for (const segment of segments) {\n      if (shouldFieldRedacted(segment, fieldPatterns)) {\n        redactedIndices.add(i);\n        break;\n      }\n    }\n  }\n  return { redactedIndices, wildcardIndices };\n}\n\n/**\n * Redacts values in the message array based on the redacted placeholder\n * indices and wildcard indices.\n * @param message The original message array.\n * @param redactedIndices Set of placeholder indices to redact.\n * @param wildcardIndices Set of wildcard placeholder indices.\n * @param redactedProperties The redacted properties object.\n * @param action The redaction action.\n * @returns New message array with redacted values.\n */\nfunction redactMessageArray(\n  message: readonly unknown[],\n  redactedIndices: Set<number>,\n  wildcardIndices: Set<number>,\n  redactedProperties: Record<string, unknown>,\n  action: \"delete\" | ((value: unknown) => unknown) | undefined,\n): readonly unknown[] {\n  if (redactedIndices.size === 0 && wildcardIndices.size === 0) return message;\n\n  const result: unknown[] = [];\n  let placeholderIndex = 0;\n\n  for (let i = 0; i < message.length; i++) {\n    if (i % 2 === 0) {\n      // Even index: text segment\n      result.push(message[i]);\n    } else {\n      // Odd index: value/placeholder\n      if (wildcardIndices.has(placeholderIndex)) {\n        // Wildcard {*}: replace with redacted properties\n        result.push(redactedProperties);\n      } else if (redactedIndices.has(placeholderIndex)) {\n        if (action == null || action === \"delete\") {\n          result.push(\"\");\n        } else {\n          result.push(action(message[i]));\n        }\n      } else {\n        result.push(message[i]);\n      }\n      placeholderIndex++;\n    }\n  }\n  return result;\n}\n\n/**\n * Collects redacted value mappings from original to redacted properties.\n * @param original The original properties.\n * @param redacted The redacted properties.\n * @param map The map to populate with original -> redacted value pairs.\n */\nfunction collectRedactedValues(\n  original: Record<string, unknown>,\n  redacted: Record<string, unknown>,\n  map: Map<unknown, unknown>,\n): void {\n  for (const key in original) {\n    const origVal = original[key];\n    const redVal = redacted[key];\n\n    if (origVal !== redVal) {\n      map.set(origVal, redVal);\n    }\n\n    // Recurse into nested objects\n    if (\n      typeof origVal === \"object\" && origVal !== null &&\n      typeof redVal === \"object\" && redVal !== null &&\n      !Array.isArray(origVal)\n    ) {\n      collectRedactedValues(\n        origVal as Record<string, unknown>,\n        redVal as Record<string, unknown>,\n        map,\n      );\n    }\n  }\n}\n\n/**\n * Gets a map of original values to their redacted replacements.\n * @param original The original properties.\n * @param redacted The redacted properties.\n * @returns A map of original -> redacted values.\n */\nfunction getRedactedValues(\n  original: Record<string, unknown>,\n  redacted: Record<string, unknown>,\n): Map<unknown, unknown> {\n  const map = new Map<unknown, unknown>();\n  collectRedactedValues(original, redacted, map);\n  return map;\n}\n\n/**\n * Redacts message array values by comparing with redacted property values.\n * Used for tagged template literals where placeholder names are not available.\n * @param message The original message array.\n * @param redactedValues Map of original -> redacted values.\n * @returns New message array with redacted values.\n */\nfunction redactMessageByValues(\n  message: readonly unknown[],\n  redactedValues: Map<unknown, unknown>,\n): readonly unknown[] {\n  if (redactedValues.size === 0) return message;\n\n  const result: unknown[] = [];\n  for (let i = 0; i < message.length; i++) {\n    if (i % 2 === 0) {\n      result.push(message[i]);\n    } else {\n      const val = message[i];\n      if (redactedValues.has(val)) {\n        result.push(redactedValues.get(val));\n      } else {\n        result.push(val);\n      }\n    }\n  }\n  return result;\n}\n"],"mappings":";;;;;;;AAsBA,MAAaA,wBAAuC;CAClD;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;AACD;;;;;;;;;;;;;;;;;;;;;;;;;;;AAuDD,SAAgB,cACdC,MACAC,UAAiD,uBACE;CACnD,MAAM,OAAO,MAAM,QAAQ,QAAQ,GAAG,EAAE,eAAe,QAAS,IAAG;CACnE,MAAM,UAAU,CAACC,WAAsB;EACrC,MAAM,qBAAqB,iBAAiB,OAAO,YAAY,KAAK;EACpE,IAAI,kBAAkB,OAAO;AAE7B,aAAW,OAAO,eAAe,UAAU;GAEzC,MAAM,eAAe,wBAAwB,OAAO,WAAW;GAC/D,MAAM,EAAE,iBAAiB,iBAAiB,GACxC,8BACE,cACA,KAAK,cACN;AACH,OAAI,gBAAgB,OAAO,KAAK,gBAAgB,OAAO,EACrD,mBAAkB,mBAChB,OAAO,SACP,iBACA,iBACA,oBACA,KAAK,OACN;EAEJ,OAAM;GAEL,MAAM,iBAAiB,kBACrB,OAAO,YACP,mBACD;AACD,OAAI,eAAe,OAAO,EACxB,mBAAkB,sBAAsB,OAAO,SAAS,eAAe;EAE1E;AAED,OAAK;GACH,GAAG;GACH,SAAS;GACT,YAAY;EACb,EAAC;CACH;AACD,KAAI,OAAO,WAAW,KAAM,SAAQ,OAAO,WAAW,KAAK,OAAO;AAClE,KAAI,OAAO,gBAAgB,KACzB,SAAQ,OAAO,gBAAgB,KAAK,OAAO;AAE7C,QAAO;AACR;;;;;;;;;;;;;;;;;AAkBD,SAAgB,iBACdC,YACAC,SACA,0BAAU,IAAI,OACW;AACzB,KAAI,QAAQ,IAAI,WAAW,CACzB,QAAO,QAAQ,IAAI,WAAW;CAGhC,MAAMC,OAAgC,CAAE;AACxC,SAAQ,IAAI,YAAY,KAAK;AAE7B,MAAK,MAAM,SAAS,YAAY;AAC9B,MAAI,oBAAoB,OAAO,QAAQ,cAAc,EAAE;AACrD,cAAW,QAAQ,WAAW,WAC5B,MAAK,SAAS,QAAQ,OAAO,WAAW,OAAO;AAEjD;EACD;EAED,MAAM,QAAQ,WAAW;AACzB,MAAI,MAAM,QAAQ,MAAM,CACtB,MAAK,SAAS,YAAY,OAAO,SAAS,QAAQ;kBAClC,UAAU,YAAY,UAAU,KAChD,MAAK,SAAS,iBACZ,OACA,SACA,QACD;MAED,MAAK,SAAS;CAEjB;AACD,QAAO;AACR;;;;;;;;AASD,SAAS,YACPC,OACAF,SACAG,SACW;AACX,QAAO,MAAM,IAAI,CAAC,SAAS;AACzB,MAAI,MAAM,QAAQ,KAAK,CACrB,QAAO,YAAY,MAAM,SAAS,QAAQ;AAE5C,aAAW,SAAS,YAAY,SAAS,KACvC,QAAO,iBACL,MACA,SACA,QACD;AAEH,SAAO;CACR,EAAC;AACH;;;;;;;;AASD,SAAgB,oBACdC,OACAC,eACS;AACT,MAAK,MAAM,gBAAgB,cACzB,YAAW,iBAAiB,UAC1B;MAAI,iBAAiB,MAAO,QAAO;CAAK,WAEpC,aAAa,KAAK,MAAM,CAAE,QAAO;AAGzC,QAAO;AACR;;;;;;AAOD,SAAS,wBAAwBC,UAA4B;CAC3D,MAAMC,eAAyB,CAAE;AACjC,MAAK,IAAI,IAAI,GAAG,IAAI,SAAS,QAAQ,IACnC,KAAI,SAAS,OAAO,KAAK;AAEvB,MAAI,IAAI,IAAI,SAAS,UAAU,SAAS,IAAI,OAAO,KAAK;AACtD;AACA;EACD;EACD,MAAM,aAAa,SAAS,QAAQ,KAAK,IAAI,EAAE;AAC/C,MAAI,eAAe,GAAI;EACvB,MAAM,MAAM,SAAS,MAAM,IAAI,GAAG,WAAW,CAAC,MAAM;AACpD,eAAa,KAAK,IAAI;AACtB,MAAI;CACL;AAEH,QAAO;AACR;;;;;;AAOD,SAAS,kBAAkBC,MAAwB;CACjD,MAAMC,WAAqB,CAAE;CAC7B,IAAI,UAAU;AACd,MAAK,MAAM,QAAQ,KACjB,KAAI,SAAS,OAAO,SAAS,KAAK;AAChC,MAAI,QAAS,UAAS,KAAK,QAAQ;AACnC,YAAU;CACX,WAAU,SAAS,OAAO,SAAS,KAAK,CAExC,MACC,YAAW;AAGf,KAAI,QAAS,UAAS,KAAK,QAAQ;AACnC,QAAO;AACR;;;;;;;;AASD,SAAS,8BACPF,cACAF,eACgE;CAChE,MAAM,kCAAkB,IAAI;CAC5B,MAAM,kCAAkB,IAAI;AAE5B,MAAK,IAAI,IAAI,GAAG,IAAI,aAAa,QAAQ,KAAK;EAC5C,MAAM,cAAc,aAAa;AAGjC,MAAI,gBAAgB,KAAK;AACvB,mBAAgB,IAAI,EAAE;AACtB;EACD;AAGD,MAAI,oBAAoB,aAAa,cAAc,EAAE;AACnD,mBAAgB,IAAI,EAAE;AACtB;EACD;EAED,MAAM,WAAW,kBAAkB,YAAY;AAC/C,OAAK,MAAM,WAAW,SACpB,KAAI,oBAAoB,SAAS,cAAc,EAAE;AAC/C,mBAAgB,IAAI,EAAE;AACtB;EACD;CAEJ;AACD,QAAO;EAAE;EAAiB;CAAiB;AAC5C;;;;;;;;;;;AAYD,SAAS,mBACPK,SACAC,iBACAC,iBACAC,oBACAC,QACoB;AACpB,KAAI,gBAAgB,SAAS,KAAK,gBAAgB,SAAS,EAAG,QAAO;CAErE,MAAMC,SAAoB,CAAE;CAC5B,IAAI,mBAAmB;AAEvB,MAAK,IAAI,IAAI,GAAG,IAAI,QAAQ,QAAQ,IAClC,KAAI,IAAI,MAAM,EAEZ,QAAO,KAAK,QAAQ,GAAG;MAClB;AAEL,MAAI,gBAAgB,IAAI,iBAAiB,CAEvC,QAAO,KAAK,mBAAmB;WACtB,gBAAgB,IAAI,iBAAiB,CAC9C,KAAI,UAAU,QAAQ,WAAW,SAC/B,QAAO,KAAK,GAAG;MAEf,QAAO,KAAK,OAAO,QAAQ,GAAG,CAAC;MAGjC,QAAO,KAAK,QAAQ,GAAG;AAEzB;CACD;AAEH,QAAO;AACR;;;;;;;AAQD,SAAS,sBACPC,UACAC,UACAC,KACM;AACN,MAAK,MAAM,OAAO,UAAU;EAC1B,MAAM,UAAU,SAAS;EACzB,MAAM,SAAS,SAAS;AAExB,MAAI,YAAY,OACd,KAAI,IAAI,SAAS,OAAO;AAI1B,aACS,YAAY,YAAY,YAAY,eACpC,WAAW,YAAY,WAAW,SACxC,MAAM,QAAQ,QAAQ,CAEvB,uBACE,SACA,QACA,IACD;CAEJ;AACF;;;;;;;AAQD,SAAS,kBACPF,UACAC,UACuB;CACvB,MAAM,sBAAM,IAAI;AAChB,uBAAsB,UAAU,UAAU,IAAI;AAC9C,QAAO;AACR;;;;;;;;AASD,SAAS,sBACPP,SACAS,gBACoB;AACpB,KAAI,eAAe,SAAS,EAAG,QAAO;CAEtC,MAAMJ,SAAoB,CAAE;AAC5B,MAAK,IAAI,IAAI,GAAG,IAAI,QAAQ,QAAQ,IAClC,KAAI,IAAI,MAAM,EACZ,QAAO,KAAK,QAAQ,GAAG;MAClB;EACL,MAAM,MAAM,QAAQ;AACpB,MAAI,eAAe,IAAI,IAAI,CACzB,QAAO,KAAK,eAAe,IAAI,IAAI,CAAC;MAEpC,QAAO,KAAK,IAAI;CAEnB;AAEH,QAAO;AACR"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@logtape/redaction",
-  "version": "1.4.0-dev.413+1097da33",
+  "version": "1.4.0-dev.417+e6c45f5a",
   "description": "Redact sensitive data from log messages",
   "keywords": [
     "logging",
@@ -49,7 +49,7 @@
     "dist/"
   ],
   "peerDependencies": {
-    "@logtape/logtape": "^1.4.0-dev.413+1097da33"
+    "@logtape/logtape": "^1.4.0-dev.417+e6c45f5a"
   },
   "devDependencies": {
     "@alinea/suite": "^0.6.3",