@logtape/redaction 2.2.0-dev.679 → 2.2.0-dev.683

package/dist/pattern.d.cts

@@ -1,3 +1,4 @@
+import { RedactionTraversalOptions } from "./traversal.cjs";
 import { ConsoleFormatter, TextFormatter } from "@logtape/logtape";
 
 //#region src/pattern.d.ts
@@ -51,6 +52,22 @@ declare const JWT_PATTERN: RedactionPattern;
  * @since 0.10.0
  */
 type RedactionPatterns = readonly RedactionPattern[];
+/**
+ * Options for pattern-based redaction.
+ * @since 2.2.0
+ */
+interface PatternRedactionOptions extends RedactionTraversalOptions {
+  /**
+   * Maximum recursion depth for object and array traversal.
+   * @default `20`
+   */
+  readonly maxDepth?: number;
+  /**
+   * Maximum number of properties or array elements to process per object.
+   * @default `1000`
+   */
+  readonly maxProperties?: number;
+}
 /**
  * Applies data redaction to a {@link TextFormatter}.
  *
@@ -82,10 +99,11 @@ type RedactionPatterns = readonly RedactionPattern[];
  * ```
  * @param formatter The text formatter to apply redaction to.
  * @param patterns The redaction patterns to apply.
+ * @param options Options for bounding recursive traversal of formatter output.
  * @returns The redacted text formatter.
  * @since 0.10.0
  */
-declare function redactByPattern(formatter: TextFormatter, patterns: RedactionPatterns): TextFormatter;
+declare function redactByPattern(formatter: TextFormatter, patterns: RedactionPatterns, options?: PatternRedactionOptions): TextFormatter;
 /**
  * Applies data redaction to a {@link ConsoleFormatter}.
  *
@@ -116,11 +134,12 @@ declare function redactByPattern(formatter: TextFormatter, patterns: RedactionPa
  * ```
  * @param formatter The console formatter to apply redaction to.
  * @param patterns The redaction patterns to apply.
+ * @param options Options for bounding recursive traversal of formatter output.
  * @returns The redacted console formatter.
  * @since 0.10.0
  */
-declare function redactByPattern(formatter: ConsoleFormatter, patterns: RedactionPatterns): ConsoleFormatter;
+declare function redactByPattern(formatter: ConsoleFormatter, patterns: RedactionPatterns, options?: PatternRedactionOptions): ConsoleFormatter;
 //# sourceMappingURL=pattern.d.ts.map
 //#endregion
-export { CREDIT_CARD_NUMBER_PATTERN, EMAIL_ADDRESS_PATTERN, JWT_PATTERN, KR_RRN_PATTERN, RedactionPattern, RedactionPatterns, US_SSN_PATTERN, redactByPattern };
+export { CREDIT_CARD_NUMBER_PATTERN, EMAIL_ADDRESS_PATTERN, JWT_PATTERN, KR_RRN_PATTERN, PatternRedactionOptions, RedactionPattern, RedactionPatterns, US_SSN_PATTERN, redactByPattern };
 //# sourceMappingURL=pattern.d.cts.map

package/dist/pattern.d.cts.map

@@ -1 +1 @@
-{"version":3,"file":"pattern.d.cts","names":[],"sources":["../src/pattern.ts"],"sourcesContent":[],"mappings":";;;;;;AAWA;AAsBA;AAUA;AASa,UAzCI,gBAAA,CAyCY;EAUhB;AASb;AASA;AAyDA;EAA+B,SAAA,OAAA,EAzHX,MAyHW;EAAA;;;AAGf;AAmChB;EAA+B,SAAA,WAAA,EAAA,MAAA,GAAA,CAAA,CAAA,KAAA,EAAA,MAAA,EAAA,GAAA,IAAA,EAAA,SAAA,GAAA,EAAA,EAAA,GAAA,MAAA,CAAA;;;;AAGZ;;cAjJN,uBAAuB;;;;;cAUvB,4BAA4B;;;;;cAS5B,gBAAgB;;;;;;cAUhB,gBAAgB;;;;;cAShB,aAAa;;;;;KASd,iBAAA,YAA6B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAyDzB,eAAA,YACH,yBACD,oBACT;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAmCa,eAAA,YACH,4BACD,oBACT"}
+{"version":3,"file":"pattern.d.cts","names":[],"sources":["../src/pattern.ts"],"sourcesContent":[],"mappings":";;;;;;;AAuBA;AAsBA;AAUA;AASa,UAzCI,gBAAA,CAyCY;EAUhB;AASb;AASA;AAMA;EAsEgB,SAAA,OAAA,EA5II,MA4IW;EAAA;;;;;EAIf,SAAA,WAAA,EAAA,MAAA,GAAA,CAAA,CAAA,KAAA,EAAA,MAAA,EAAA,GAAA,IAAA,EAAA,SAAA,GAAA,EAAA,EAAA,GAAA,MAAA,CAAA;AAoChB;;;;;AAIG,cAvKU,qBAuKV,EAvKiC,gBAuKjC;AAAgB;;;;cA7JN,4BAA4B;;;;;cAS5B,gBAAgB;;;;;;cAUhB,gBAAgB;;;;;cAShB,aAAa;;;;;KASd,iBAAA,YAA6B;;;;;UAMxB,uBAAA,SAAgC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAsEjC,eAAA,YACH,yBACD,6BACA,0BACT;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAoCa,eAAA,YACH,4BACD,6BACA,0BACT"}

package/dist/pattern.d.ts

@@ -1,3 +1,4 @@
+import { RedactionTraversalOptions } from "./traversal.js";
 import { ConsoleFormatter, TextFormatter } from "@logtape/logtape";
 
 //#region src/pattern.d.ts
@@ -51,6 +52,22 @@ declare const JWT_PATTERN: RedactionPattern;
  * @since 0.10.0
  */
 type RedactionPatterns = readonly RedactionPattern[];
+/**
+ * Options for pattern-based redaction.
+ * @since 2.2.0
+ */
+interface PatternRedactionOptions extends RedactionTraversalOptions {
+  /**
+   * Maximum recursion depth for object and array traversal.
+   * @default `20`
+   */
+  readonly maxDepth?: number;
+  /**
+   * Maximum number of properties or array elements to process per object.
+   * @default `1000`
+   */
+  readonly maxProperties?: number;
+}
 /**
  * Applies data redaction to a {@link TextFormatter}.
  *
@@ -82,10 +99,11 @@ type RedactionPatterns = readonly RedactionPattern[];
  * ```
  * @param formatter The text formatter to apply redaction to.
  * @param patterns The redaction patterns to apply.
+ * @param options Options for bounding recursive traversal of formatter output.
  * @returns The redacted text formatter.
  * @since 0.10.0
  */
-declare function redactByPattern(formatter: TextFormatter, patterns: RedactionPatterns): TextFormatter;
+declare function redactByPattern(formatter: TextFormatter, patterns: RedactionPatterns, options?: PatternRedactionOptions): TextFormatter;
 /**
  * Applies data redaction to a {@link ConsoleFormatter}.
  *
@@ -116,11 +134,12 @@ declare function redactByPattern(formatter: TextFormatter, patterns: RedactionPa
  * ```
  * @param formatter The console formatter to apply redaction to.
  * @param patterns The redaction patterns to apply.
+ * @param options Options for bounding recursive traversal of formatter output.
  * @returns The redacted console formatter.
  * @since 0.10.0
  */
-declare function redactByPattern(formatter: ConsoleFormatter, patterns: RedactionPatterns): ConsoleFormatter;
+declare function redactByPattern(formatter: ConsoleFormatter, patterns: RedactionPatterns, options?: PatternRedactionOptions): ConsoleFormatter;
 //# sourceMappingURL=pattern.d.ts.map
 //#endregion
-export { CREDIT_CARD_NUMBER_PATTERN, EMAIL_ADDRESS_PATTERN, JWT_PATTERN, KR_RRN_PATTERN, RedactionPattern, RedactionPatterns, US_SSN_PATTERN, redactByPattern };
+export { CREDIT_CARD_NUMBER_PATTERN, EMAIL_ADDRESS_PATTERN, JWT_PATTERN, KR_RRN_PATTERN, PatternRedactionOptions, RedactionPattern, RedactionPatterns, US_SSN_PATTERN, redactByPattern };
 //# sourceMappingURL=pattern.d.ts.map

package/dist/pattern.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"pattern.d.ts","names":[],"sources":["../src/pattern.ts"],"sourcesContent":[],"mappings":";;;;;;AAWA;AAsBA;AAUA;AASa,UAzCI,gBAAA,CAyCY;EAUhB;AASb;AASA;AAyDA;EAA+B,SAAA,OAAA,EAzHX,MAyHW;EAAA;;;AAGf;AAmChB;EAA+B,SAAA,WAAA,EAAA,MAAA,GAAA,CAAA,CAAA,KAAA,EAAA,MAAA,EAAA,GAAA,IAAA,EAAA,SAAA,GAAA,EAAA,EAAA,GAAA,MAAA,CAAA;;;;AAGZ;;cAjJN,uBAAuB;;;;;cAUvB,4BAA4B;;;;;cAS5B,gBAAgB;;;;;;cAUhB,gBAAgB;;;;;cAShB,aAAa;;;;;KASd,iBAAA,YAA6B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAyDzB,eAAA,YACH,yBACD,oBACT;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAmCa,eAAA,YACH,4BACD,oBACT"}
+{"version":3,"file":"pattern.d.ts","names":[],"sources":["../src/pattern.ts"],"sourcesContent":[],"mappings":";;;;;;;AAuBA;AAsBA;AAUA;AASa,UAzCI,gBAAA,CAyCY;EAUhB;AASb;AASA;AAMA;EAsEgB,SAAA,OAAA,EA5II,MA4IW;EAAA;;;;;EAIf,SAAA,WAAA,EAAA,MAAA,GAAA,CAAA,CAAA,KAAA,EAAA,MAAA,EAAA,GAAA,IAAA,EAAA,SAAA,GAAA,EAAA,EAAA,GAAA,MAAA,CAAA;AAoChB;;;;;AAIG,cAvKU,qBAuKV,EAvKiC,gBAuKjC;AAAgB;;;;cA7JN,4BAA4B;;;;;cAS5B,gBAAgB;;;;;;cAUhB,gBAAgB;;;;;cAShB,aAAa;;;;;KASd,iBAAA,YAA6B;;;;;UAMxB,uBAAA,SAAgC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAsEjC,eAAA,YACH,yBACD,6BACA,0BACT;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAoCa,eAAA,YACH,4BACD,6BACA,0BACT"}

package/dist/pattern.js

@@ -1,4 +1,9 @@
+import { createRedactionTraversalContext, redactionTruncatedValue } from "./traversal.js";
+import { getLogger } from "@logtape/logtape";
+
 //#region src/pattern.ts
+const metaLogger = getLogger(["logtape", "meta"]);
+let reportingRedactionLimit = false;
 /**
 * A redaction pattern for email addresses.
 * @since 0.10.0
@@ -49,28 +54,46 @@ const JWT_PATTERN = {
 function isBuiltInObject(value) {
 	return value instanceof Error || value instanceof Date || value instanceof RegExp || value instanceof Map || value instanceof Set || value instanceof WeakMap || value instanceof WeakSet || value instanceof Promise || value instanceof ArrayBuffer || typeof SharedArrayBuffer !== "undefined" && value instanceof SharedArrayBuffer || ArrayBuffer.isView(value);
 }
-function redactByPattern(formatter, patterns) {
+function redactByPattern(formatter, patterns, options = {}) {
 	for (const { pattern } of patterns) if (!pattern.global) throw new TypeError(`Pattern ${pattern} does not have the global flag set.`);
 	function replaceString(str) {
 		for (const p of patterns) str = typeof p.replacement === "string" ? str.replaceAll(p.pattern, p.replacement) : str.replaceAll(p.pattern, p.replacement);
 		return str;
 	}
-	function replaceObject(object, visited) {
+	function replaceObject(object, context, depth) {
 		if (typeof object === "object" && object !== null) {
-			if (visited.has(object)) return visited.get(object);
+			if (context.visited.has(object)) return context.visited.get(object);
 		}
 		if (typeof object === "string") return replaceString(object);
 		if (Array.isArray(object)) {
 			const copy = [];
-			visited.set(object, copy);
-			object.forEach((item) => copy.push(replaceObject(item, visited)));
+			const length = Math.min(object.length, context.limits.maxProperties);
+			copy.length = length;
+			context.visited.set(object, copy);
+			if (object.length > context.limits.maxProperties) reportLimitOnce(context, "maxProperties");
+			for (let i = 0; i < length; i++) {
+				if (!(i in object)) continue;
+				const item = object[i];
+				if (shouldTraverseValue(item) && depth + 1 > context.limits.maxDepth) {
+					reportLimitOnce(context, "maxDepth");
+					copy[i] = redactionTruncatedValue;
+				} else copy[i] = replaceObject(item, context, depth + 1);
+			}
 			return copy;
 		}
 		if (typeof object === "object" && object !== null) {
 			if (isBuiltInObject(object)) return object;
 			const redacted = {};
-			visited.set(object, redacted);
-			for (const key in object) if (Object.prototype.hasOwnProperty.call(object, key)) redacted[key] = replaceObject(object[key], visited);
+			context.visited.set(object, redacted);
+			const keys = Object.keys(object);
+			if (keys.length > context.limits.maxProperties) reportLimitOnce(context, "maxProperties");
+			for (const key of keys.slice(0, context.limits.maxProperties)) {
+				const value = object[key];
+				if (shouldTraverseValue(value) && depth + 1 > context.limits.maxDepth) {
+					reportLimitOnce(context, "maxDepth");
+					redacted[key] = redactionTruncatedValue;
+				} else redacted[key] = replaceObject(value, context, depth + 1);
+			}
 			return redacted;
 		}
 		return object;
@@ -78,9 +101,33 @@ function redactByPattern(formatter, patterns) {
 	return (record) => {
 		const output = formatter(record);
 		if (typeof output === "string") return replaceString(output);
-		return output.map((obj) => replaceObject(obj, /* @__PURE__ */ new Map()));
+		const context = createPatternRedactionContext(options);
+		if (output.length > context.limits.maxProperties) reportLimitOnce(context, "maxProperties");
+		return output.slice(0, context.limits.maxProperties).map((obj) => replaceObject(obj, context, 0));
 	};
 }
+function reportRedactionLimitExceeded(limit, limits) {
+	if (reportingRedactionLimit || typeof metaLogger.warn !== "function") return;
+	try {
+		reportingRedactionLimit = true;
+		metaLogger.warn("Redaction traversal exceeded {limit}; replacing or omitting remaining data to keep logging bounded.", {
+			limit,
+			...limits
+		});
+	} catch {} finally {
+		reportingRedactionLimit = false;
+	}
+}
+function shouldTraverseValue(value) {
+	return typeof value === "object" && value !== null && !isBuiltInObject(value);
+}
+function createPatternRedactionContext(options) {
+	return createRedactionTraversalContext(options, reportRedactionLimitExceeded);
+}
+function reportLimitOnce(context, limit) {
+	if (context.exceededLimits.has(limit)) return;
+	context.reportLimitExceeded(limit);
+}
 
 //#endregion
 export { CREDIT_CARD_NUMBER_PATTERN, EMAIL_ADDRESS_PATTERN, JWT_PATTERN, KR_RRN_PATTERN, US_SSN_PATTERN, redactByPattern };

package/dist/pattern.js.map

@@ -1 +1 @@
-{"version":3,"file":"pattern.js","names":["EMAIL_ADDRESS_PATTERN: RedactionPattern","CREDIT_CARD_NUMBER_PATTERN: RedactionPattern","US_SSN_PATTERN: RedactionPattern","KR_RRN_PATTERN: RedactionPattern","JWT_PATTERN: RedactionPattern","value: object","formatter: TextFormatter | ConsoleFormatter","patterns: RedactionPatterns","str: string","object: unknown","visited: Map<object, object>","copy: unknown[]","redacted: Record<string, unknown>","record: LogRecord"],"sources":["../src/pattern.ts"],"sourcesContent":["import type {\n  ConsoleFormatter,\n  LogRecord,\n  TextFormatter,\n} from \"@logtape/logtape\";\n\n/**\n * A redaction pattern, which is a pair of regular expression and replacement\n * string or function.\n * @since 0.10.0\n */\nexport interface RedactionPattern {\n  /**\n   * The regular expression to match against.  Note that it must have the\n   * `g` (global) flag set, otherwise it will throw a `TypeError`.\n   */\n  readonly pattern: RegExp;\n\n  /**\n   * The replacement string or function.  If the replacement is a function,\n   * it will be called with the matched string and any capture groups (the same\n   * signature as `String.prototype.replaceAll()`).\n   */\n  readonly replacement:\n    | string\n    // deno-lint-ignore no-explicit-any\n    | ((match: string, ...rest: readonly any[]) => string);\n}\n\n/**\n * A redaction pattern for email addresses.\n * @since 0.10.0\n */\nexport const EMAIL_ADDRESS_PATTERN: RedactionPattern = {\n  pattern:\n    /[\\p{L}0-9.!#$%&'*+/=?^_`{|}~-]+@[\\p{L}0-9](?:[\\p{L}0-9-]{0,61}[\\p{L}0-9])?(?:\\.[\\p{L}0-9](?:[\\p{L}0-9-]{0,61}[\\p{L}0-9])?)+/gu,\n  replacement: \"REDACTED@EMAIL.ADDRESS\",\n};\n\n/**\n * A redaction pattern for credit card numbers (including American Express).\n * @since 0.10.0\n */\nexport const CREDIT_CARD_NUMBER_PATTERN: RedactionPattern = {\n  pattern: /(?:\\d{4}-){2}(?:\\d{4}-\\d{4}|\\d{6})/g,\n  replacement: \"XXXX-XXXX-XXXX-XXXX\",\n};\n\n/**\n * A redaction pattern for U.S. Social Security numbers.\n * @since 0.10.0\n */\nexport const US_SSN_PATTERN: RedactionPattern = {\n  pattern: /\\d{3}-\\d{2}-\\d{4}/g,\n  replacement: \"XXX-XX-XXXX\",\n};\n\n/**\n * A redaction pattern for South Korean resident registration numbers\n * (住民登錄番號).\n * @since 0.10.0\n */\nexport const KR_RRN_PATTERN: RedactionPattern = {\n  pattern: /\\d{6}-\\d{7}/g,\n  replacement: \"XXXXXX-XXXXXXX\",\n};\n\n/**\n * A redaction pattern for JSON Web Tokens (JWT).\n * @since 0.10.0\n */\nexport const JWT_PATTERN: RedactionPattern = {\n  pattern: /eyJ[a-zA-Z0-9_-]*\\.[a-zA-Z0-9_-]*\\.[a-zA-Z0-9_-]*/g,\n  replacement: \"[JWT REDACTED]\",\n};\n\n/**\n * A list of {@link RedactionPattern}s.\n * @since 0.10.0\n */\nexport type RedactionPatterns = readonly RedactionPattern[];\n\n/**\n * Checks if a value is a built-in object that should not be recursively\n * processed (e.g., Error, Date, RegExp, Map, Set, etc.).\n * @param value The value to check.\n * @returns `true` if the value is a built-in object, `false` otherwise.\n */\nfunction isBuiltInObject(value: object): boolean {\n  return value instanceof Error ||\n    value instanceof Date ||\n    value instanceof RegExp ||\n    value instanceof Map ||\n    value instanceof Set ||\n    value instanceof WeakMap ||\n    value instanceof WeakSet ||\n    value instanceof Promise ||\n    value instanceof ArrayBuffer ||\n    (typeof SharedArrayBuffer !== \"undefined\" &&\n      value instanceof SharedArrayBuffer) ||\n    ArrayBuffer.isView(value);\n}\n\n/**\n * Applies data redaction to a {@link TextFormatter}.\n *\n * Note that there are some built-in redaction patterns:\n *\n * - {@link CREDIT_CARD_NUMBER_PATTERN}\n * - {@link EMAIL_ADDRESS_PATTERN}\n * - {@link JWT_PATTERN}\n * - {@link KR_RRN_PATTERN}\n * - {@link US_SSN_PATTERN}\n *\n * @example\n * ```ts\n * import { getFileSink } from \"@logtape/file\";\n * import { getAnsiColorFormatter } from \"@logtape/logtape\";\n * import {\n *   CREDIT_CARD_NUMBER_PATTERN,\n *   EMAIL_ADDRESS_PATTERN,\n *   JWT_PATTERN,\n *   redactByPattern,\n * } from \"@logtape/redaction\";\n *\n * const formatter = redactByPattern(getAnsiConsoleFormatter(), [\n *   CREDIT_CARD_NUMBER_PATTERN,\n *   EMAIL_ADDRESS_PATTERN,\n *   JWT_PATTERN,\n * ]);\n * const sink = getFileSink(\"my-app.log\", { formatter });\n * ```\n * @param formatter The text formatter to apply redaction to.\n * @param patterns The redaction patterns to apply.\n * @returns The redacted text formatter.\n * @since 0.10.0\n */\nexport function redactByPattern(\n  formatter: TextFormatter,\n  patterns: RedactionPatterns,\n): TextFormatter;\n\n/**\n * Applies data redaction to a {@link ConsoleFormatter}.\n *\n * Note that there are some built-in redaction patterns:\n *\n * - {@link CREDIT_CARD_NUMBER_PATTERN}\n * - {@link EMAIL_ADDRESS_PATTERN}\n * - {@link JWT_PATTERN}\n * - {@link KR_RRN_PATTERN}\n * - {@link US_SSN_PATTERN}\n *\n * @example\n * ```ts\n * import { defaultConsoleFormatter, getConsoleSink } from \"@logtape/logtape\";\n * import {\n *   CREDIT_CARD_NUMBER_PATTERN,\n *   EMAIL_ADDRESS_PATTERN,\n *   JWT_PATTERN,\n *   redactByPattern,\n * } from \"@logtape/redaction\";\n *\n * const formatter = redactByPattern(defaultConsoleFormatter, [\n *   CREDIT_CARD_NUMBER_PATTERN,\n *   EMAIL_ADDRESS_PATTERN,\n *   JWT_PATTERN,\n * ]);\n * const sink = getConsoleSink({ formatter });\n * ```\n * @param formatter The console formatter to apply redaction to.\n * @param patterns The redaction patterns to apply.\n * @returns The redacted console formatter.\n * @since 0.10.0\n */\nexport function redactByPattern(\n  formatter: ConsoleFormatter,\n  patterns: RedactionPatterns,\n): ConsoleFormatter;\n\nexport function redactByPattern(\n  formatter: TextFormatter | ConsoleFormatter,\n  patterns: RedactionPatterns,\n): (record: LogRecord) => string | readonly unknown[] {\n  for (const { pattern } of patterns) {\n    if (!pattern.global) {\n      throw new TypeError(\n        `Pattern ${pattern} does not have the global flag set.`,\n      );\n    }\n  }\n\n  function replaceString(str: string): string {\n    for (const p of patterns) {\n      // The following ternary operator may seem strange, but it's for\n      // making TypeScript happy:\n      str = typeof p.replacement === \"string\"\n        ? str.replaceAll(p.pattern, p.replacement)\n        : str.replaceAll(p.pattern, p.replacement);\n    }\n    return str;\n  }\n\n  function replaceObject(\n    object: unknown,\n    visited: Map<object, object>,\n  ): unknown {\n    if (typeof object === \"object\" && object !== null) {\n      if (visited.has(object)) {\n        return visited.get(object)!; // Circular reference detected\n      }\n    }\n\n    if (typeof object === \"string\") return replaceString(object);\n    if (Array.isArray(object)) {\n      const copy: unknown[] = [];\n      visited.set(object, copy);\n      object.forEach((item) => copy.push(replaceObject(item, visited)));\n      return copy;\n    }\n    if (typeof object === \"object\" && object !== null) {\n      if (isBuiltInObject(object)) {\n        return object;\n      }\n      const redacted: Record<string, unknown> = {};\n      visited.set(object, redacted);\n      for (const key in object) {\n        if (Object.prototype.hasOwnProperty.call(object, key)) {\n          redacted[key] = replaceObject(\n            (object as Record<string, unknown>)[key],\n            visited,\n          );\n        }\n      }\n      return redacted;\n    }\n    return object;\n  }\n\n  return (record: LogRecord) => {\n    const output = formatter(record);\n    if (typeof output === \"string\") return replaceString(output);\n    return output.map((obj) => replaceObject(obj, new Map()));\n  };\n}\n"],"mappings":";;;;;AAiCA,MAAaA,wBAA0C;CACrD,SACE;CACF,aAAa;AACd;;;;;AAMD,MAAaC,6BAA+C;CAC1D,SAAS;CACT,aAAa;AACd;;;;;AAMD,MAAaC,iBAAmC;CAC9C,SAAS;CACT,aAAa;AACd;;;;;;AAOD,MAAaC,iBAAmC;CAC9C,SAAS;CACT,aAAa;AACd;;;;;AAMD,MAAaC,cAAgC;CAC3C,SAAS;CACT,aAAa;AACd;;;;;;;AAcD,SAAS,gBAAgBC,OAAwB;AAC/C,QAAO,iBAAiB,SACtB,iBAAiB,QACjB,iBAAiB,UACjB,iBAAiB,OACjB,iBAAiB,OACjB,iBAAiB,WACjB,iBAAiB,WACjB,iBAAiB,WACjB,iBAAiB,sBACT,sBAAsB,eAC5B,iBAAiB,qBACnB,YAAY,OAAO,MAAM;AAC5B;AA+ED,SAAgB,gBACdC,WACAC,UACoD;AACpD,MAAK,MAAM,EAAE,SAAS,IAAI,SACxB,MAAK,QAAQ,OACX,OAAM,IAAI,WACP,UAAU,QAAQ;CAKzB,SAAS,cAAcC,KAAqB;AAC1C,OAAK,MAAM,KAAK,SAGd,cAAa,EAAE,gBAAgB,WAC3B,IAAI,WAAW,EAAE,SAAS,EAAE,YAAY,GACxC,IAAI,WAAW,EAAE,SAAS,EAAE,YAAY;AAE9C,SAAO;CACR;CAED,SAAS,cACPC,QACAC,SACS;AACT,aAAW,WAAW,YAAY,WAAW,MAC3C;OAAI,QAAQ,IAAI,OAAO,CACrB,QAAO,QAAQ,IAAI,OAAO;EAC3B;AAGH,aAAW,WAAW,SAAU,QAAO,cAAc,OAAO;AAC5D,MAAI,MAAM,QAAQ,OAAO,EAAE;GACzB,MAAMC,OAAkB,CAAE;AAC1B,WAAQ,IAAI,QAAQ,KAAK;AACzB,UAAO,QAAQ,CAAC,SAAS,KAAK,KAAK,cAAc,MAAM,QAAQ,CAAC,CAAC;AACjE,UAAO;EACR;AACD,aAAW,WAAW,YAAY,WAAW,MAAM;AACjD,OAAI,gBAAgB,OAAO,CACzB,QAAO;GAET,MAAMC,WAAoC,CAAE;AAC5C,WAAQ,IAAI,QAAQ,SAAS;AAC7B,QAAK,MAAM,OAAO,OAChB,KAAI,OAAO,UAAU,eAAe,KAAK,QAAQ,IAAI,CACnD,UAAS,OAAO,cACb,OAAmC,MACpC,QACD;AAGL,UAAO;EACR;AACD,SAAO;CACR;AAED,QAAO,CAACC,WAAsB;EAC5B,MAAM,SAAS,UAAU,OAAO;AAChC,aAAW,WAAW,SAAU,QAAO,cAAc,OAAO;AAC5D,SAAO,OAAO,IAAI,CAAC,QAAQ,cAAc,qBAAK,IAAI,MAAM,CAAC;CAC1D;AACF"}
+{"version":3,"file":"pattern.js","names":["EMAIL_ADDRESS_PATTERN: RedactionPattern","CREDIT_CARD_NUMBER_PATTERN: RedactionPattern","US_SSN_PATTERN: RedactionPattern","KR_RRN_PATTERN: RedactionPattern","JWT_PATTERN: RedactionPattern","value: object","formatter: TextFormatter | ConsoleFormatter","patterns: RedactionPatterns","options: PatternRedactionOptions","str: string","object: unknown","context: RedactionTraversalContext","depth: number","copy: unknown[]","redacted: Record<string, unknown>","record: LogRecord","limit: RedactionLimit","limits: RedactionTraversalLimits","value: unknown","options: RedactionTraversalOptions"],"sources":["../src/pattern.ts"],"sourcesContent":["import {\n  type ConsoleFormatter,\n  getLogger,\n  type LogRecord,\n  type TextFormatter,\n} from \"@logtape/logtape\";\nimport {\n  createRedactionTraversalContext,\n  type RedactionLimit,\n  type RedactionTraversalContext,\n  type RedactionTraversalLimits,\n  type RedactionTraversalOptions,\n  redactionTruncatedValue,\n} from \"./traversal.ts\";\n\nconst metaLogger = getLogger([\"logtape\", \"meta\"]);\nlet reportingRedactionLimit = false;\n\n/**\n * A redaction pattern, which is a pair of regular expression and replacement\n * string or function.\n * @since 0.10.0\n */\nexport interface RedactionPattern {\n  /**\n   * The regular expression to match against.  Note that it must have the\n   * `g` (global) flag set, otherwise it will throw a `TypeError`.\n   */\n  readonly pattern: RegExp;\n\n  /**\n   * The replacement string or function.  If the replacement is a function,\n   * it will be called with the matched string and any capture groups (the same\n   * signature as `String.prototype.replaceAll()`).\n   */\n  readonly replacement:\n    | string\n    // deno-lint-ignore no-explicit-any\n    | ((match: string, ...rest: readonly any[]) => string);\n}\n\n/**\n * A redaction pattern for email addresses.\n * @since 0.10.0\n */\nexport const EMAIL_ADDRESS_PATTERN: RedactionPattern = {\n  pattern:\n    /[\\p{L}0-9.!#$%&'*+/=?^_`{|}~-]+@[\\p{L}0-9](?:[\\p{L}0-9-]{0,61}[\\p{L}0-9])?(?:\\.[\\p{L}0-9](?:[\\p{L}0-9-]{0,61}[\\p{L}0-9])?)+/gu,\n  replacement: \"REDACTED@EMAIL.ADDRESS\",\n};\n\n/**\n * A redaction pattern for credit card numbers (including American Express).\n * @since 0.10.0\n */\nexport const CREDIT_CARD_NUMBER_PATTERN: RedactionPattern = {\n  pattern: /(?:\\d{4}-){2}(?:\\d{4}-\\d{4}|\\d{6})/g,\n  replacement: \"XXXX-XXXX-XXXX-XXXX\",\n};\n\n/**\n * A redaction pattern for U.S. Social Security numbers.\n * @since 0.10.0\n */\nexport const US_SSN_PATTERN: RedactionPattern = {\n  pattern: /\\d{3}-\\d{2}-\\d{4}/g,\n  replacement: \"XXX-XX-XXXX\",\n};\n\n/**\n * A redaction pattern for South Korean resident registration numbers\n * (住民登錄番號).\n * @since 0.10.0\n */\nexport const KR_RRN_PATTERN: RedactionPattern = {\n  pattern: /\\d{6}-\\d{7}/g,\n  replacement: \"XXXXXX-XXXXXXX\",\n};\n\n/**\n * A redaction pattern for JSON Web Tokens (JWT).\n * @since 0.10.0\n */\nexport const JWT_PATTERN: RedactionPattern = {\n  pattern: /eyJ[a-zA-Z0-9_-]*\\.[a-zA-Z0-9_-]*\\.[a-zA-Z0-9_-]*/g,\n  replacement: \"[JWT REDACTED]\",\n};\n\n/**\n * A list of {@link RedactionPattern}s.\n * @since 0.10.0\n */\nexport type RedactionPatterns = readonly RedactionPattern[];\n\n/**\n * Options for pattern-based redaction.\n * @since 2.2.0\n */\nexport interface PatternRedactionOptions extends RedactionTraversalOptions {\n  /**\n   * Maximum recursion depth for object and array traversal.\n   * @default `20`\n   */\n  readonly maxDepth?: number;\n\n  /**\n   * Maximum number of properties or array elements to process per object.\n   * @default `1000`\n   */\n  readonly maxProperties?: number;\n}\n\n/**\n * Checks if a value is a built-in object that should not be recursively\n * processed (e.g., Error, Date, RegExp, Map, Set, etc.).\n * @param value The value to check.\n * @returns `true` if the value is a built-in object, `false` otherwise.\n */\nfunction isBuiltInObject(value: object): boolean {\n  return value instanceof Error ||\n    value instanceof Date ||\n    value instanceof RegExp ||\n    value instanceof Map ||\n    value instanceof Set ||\n    value instanceof WeakMap ||\n    value instanceof WeakSet ||\n    value instanceof Promise ||\n    value instanceof ArrayBuffer ||\n    (typeof SharedArrayBuffer !== \"undefined\" &&\n      value instanceof SharedArrayBuffer) ||\n    ArrayBuffer.isView(value);\n}\n\n/**\n * Applies data redaction to a {@link TextFormatter}.\n *\n * Note that there are some built-in redaction patterns:\n *\n * - {@link CREDIT_CARD_NUMBER_PATTERN}\n * - {@link EMAIL_ADDRESS_PATTERN}\n * - {@link JWT_PATTERN}\n * - {@link KR_RRN_PATTERN}\n * - {@link US_SSN_PATTERN}\n *\n * @example\n * ```ts\n * import { getFileSink } from \"@logtape/file\";\n * import { getAnsiColorFormatter } from \"@logtape/logtape\";\n * import {\n *   CREDIT_CARD_NUMBER_PATTERN,\n *   EMAIL_ADDRESS_PATTERN,\n *   JWT_PATTERN,\n *   redactByPattern,\n * } from \"@logtape/redaction\";\n *\n * const formatter = redactByPattern(getAnsiConsoleFormatter(), [\n *   CREDIT_CARD_NUMBER_PATTERN,\n *   EMAIL_ADDRESS_PATTERN,\n *   JWT_PATTERN,\n * ]);\n * const sink = getFileSink(\"my-app.log\", { formatter });\n * ```\n * @param formatter The text formatter to apply redaction to.\n * @param patterns The redaction patterns to apply.\n * @param options Options for bounding recursive traversal of formatter output.\n * @returns The redacted text formatter.\n * @since 0.10.0\n */\nexport function redactByPattern(\n  formatter: TextFormatter,\n  patterns: RedactionPatterns,\n  options?: PatternRedactionOptions,\n): TextFormatter;\n\n/**\n * Applies data redaction to a {@link ConsoleFormatter}.\n *\n * Note that there are some built-in redaction patterns:\n *\n * - {@link CREDIT_CARD_NUMBER_PATTERN}\n * - {@link EMAIL_ADDRESS_PATTERN}\n * - {@link JWT_PATTERN}\n * - {@link KR_RRN_PATTERN}\n * - {@link US_SSN_PATTERN}\n *\n * @example\n * ```ts\n * import { defaultConsoleFormatter, getConsoleSink } from \"@logtape/logtape\";\n * import {\n *   CREDIT_CARD_NUMBER_PATTERN,\n *   EMAIL_ADDRESS_PATTERN,\n *   JWT_PATTERN,\n *   redactByPattern,\n * } from \"@logtape/redaction\";\n *\n * const formatter = redactByPattern(defaultConsoleFormatter, [\n *   CREDIT_CARD_NUMBER_PATTERN,\n *   EMAIL_ADDRESS_PATTERN,\n *   JWT_PATTERN,\n * ]);\n * const sink = getConsoleSink({ formatter });\n * ```\n * @param formatter The console formatter to apply redaction to.\n * @param patterns The redaction patterns to apply.\n * @param options Options for bounding recursive traversal of formatter output.\n * @returns The redacted console formatter.\n * @since 0.10.0\n */\nexport function redactByPattern(\n  formatter: ConsoleFormatter,\n  patterns: RedactionPatterns,\n  options?: PatternRedactionOptions,\n): ConsoleFormatter;\n\nexport function redactByPattern(\n  formatter: TextFormatter | ConsoleFormatter,\n  patterns: RedactionPatterns,\n  options: PatternRedactionOptions = {},\n): (record: LogRecord) => string | readonly unknown[] {\n  for (const { pattern } of patterns) {\n    if (!pattern.global) {\n      throw new TypeError(\n        `Pattern ${pattern} does not have the global flag set.`,\n      );\n    }\n  }\n\n  function replaceString(str: string): string {\n    for (const p of patterns) {\n      // The following ternary operator may seem strange, but it's for\n      // making TypeScript happy:\n      str = typeof p.replacement === \"string\"\n        ? str.replaceAll(p.pattern, p.replacement)\n        : str.replaceAll(p.pattern, p.replacement);\n    }\n    return str;\n  }\n\n  function replaceObject(\n    object: unknown,\n    context: RedactionTraversalContext,\n    depth: number,\n  ): unknown {\n    if (typeof object === \"object\" && object !== null) {\n      if (context.visited.has(object)) {\n        return context.visited.get(object)!; // Circular reference detected\n      }\n    }\n\n    if (typeof object === \"string\") return replaceString(object);\n    if (Array.isArray(object)) {\n      const copy: unknown[] = [];\n      const length = Math.min(object.length, context.limits.maxProperties);\n      copy.length = length;\n      context.visited.set(object, copy);\n      if (object.length > context.limits.maxProperties) {\n        reportLimitOnce(context, \"maxProperties\");\n      }\n      for (let i = 0; i < length; i++) {\n        if (!(i in object)) continue;\n        const item = object[i];\n        if (\n          shouldTraverseValue(item) && depth + 1 > context.limits.maxDepth\n        ) {\n          reportLimitOnce(context, \"maxDepth\");\n          copy[i] = redactionTruncatedValue;\n        } else {\n          copy[i] = replaceObject(item, context, depth + 1);\n        }\n      }\n      return copy;\n    }\n    if (typeof object === \"object\" && object !== null) {\n      if (isBuiltInObject(object)) {\n        return object;\n      }\n      const redacted: Record<string, unknown> = {};\n      context.visited.set(object, redacted);\n      const keys = Object.keys(object);\n      if (keys.length > context.limits.maxProperties) {\n        reportLimitOnce(context, \"maxProperties\");\n      }\n      for (const key of keys.slice(0, context.limits.maxProperties)) {\n        const value = (object as Record<string, unknown>)[key];\n        if (\n          shouldTraverseValue(value) && depth + 1 > context.limits.maxDepth\n        ) {\n          reportLimitOnce(context, \"maxDepth\");\n          redacted[key] = redactionTruncatedValue;\n        } else {\n          redacted[key] = replaceObject(value, context, depth + 1);\n        }\n      }\n      return redacted;\n    }\n    return object;\n  }\n\n  return (record: LogRecord) => {\n    const output = formatter(record);\n    if (typeof output === \"string\") return replaceString(output);\n    const context = createPatternRedactionContext(options);\n    if (output.length > context.limits.maxProperties) {\n      reportLimitOnce(context, \"maxProperties\");\n    }\n    return output\n      .slice(0, context.limits.maxProperties)\n      .map((obj) => replaceObject(obj, context, 0));\n  };\n}\n\nfunction reportRedactionLimitExceeded(\n  limit: RedactionLimit,\n  limits: RedactionTraversalLimits,\n): void {\n  if (reportingRedactionLimit || typeof metaLogger.warn !== \"function\") {\n    return;\n  }\n  try {\n    reportingRedactionLimit = true;\n    metaLogger.warn(\n      \"Redaction traversal exceeded {limit}; replacing or omitting \" +\n        \"remaining data to keep logging bounded.\",\n      { limit, ...limits },\n    );\n  } catch {\n    // Meta logging failures must not make normal logging fail.\n  } finally {\n    reportingRedactionLimit = false;\n  }\n}\n\nfunction shouldTraverseValue(value: unknown): boolean {\n  return (typeof value === \"object\" && value !== null) &&\n    !isBuiltInObject(value);\n}\n\nfunction createPatternRedactionContext(\n  options: RedactionTraversalOptions,\n): RedactionTraversalContext {\n  return createRedactionTraversalContext(\n    options,\n    reportRedactionLimitExceeded,\n  );\n}\n\nfunction reportLimitOnce(\n  context: RedactionTraversalContext,\n  limit: RedactionLimit,\n): void {\n  if (context.exceededLimits.has(limit)) return;\n  context.reportLimitExceeded(limit);\n}\n"],"mappings":";;;;AAeA,MAAM,aAAa,UAAU,CAAC,WAAW,MAAO,EAAC;AACjD,IAAI,0BAA0B;;;;;AA6B9B,MAAaA,wBAA0C;CACrD,SACE;CACF,aAAa;AACd;;;;;AAMD,MAAaC,6BAA+C;CAC1D,SAAS;CACT,aAAa;AACd;;;;;AAMD,MAAaC,iBAAmC;CAC9C,SAAS;CACT,aAAa;AACd;;;;;;AAOD,MAAaC,iBAAmC;CAC9C,SAAS;CACT,aAAa;AACd;;;;;AAMD,MAAaC,cAAgC;CAC3C,SAAS;CACT,aAAa;AACd;;;;;;;AAgCD,SAAS,gBAAgBC,OAAwB;AAC/C,QAAO,iBAAiB,SACtB,iBAAiB,QACjB,iBAAiB,UACjB,iBAAiB,OACjB,iBAAiB,OACjB,iBAAiB,WACjB,iBAAiB,WACjB,iBAAiB,WACjB,iBAAiB,sBACT,sBAAsB,eAC5B,iBAAiB,qBACnB,YAAY,OAAO,MAAM;AAC5B;AAmFD,SAAgB,gBACdC,WACAC,UACAC,UAAmC,CAAE,GACe;AACpD,MAAK,MAAM,EAAE,SAAS,IAAI,SACxB,MAAK,QAAQ,OACX,OAAM,IAAI,WACP,UAAU,QAAQ;CAKzB,SAAS,cAAcC,KAAqB;AAC1C,OAAK,MAAM,KAAK,SAGd,cAAa,EAAE,gBAAgB,WAC3B,IAAI,WAAW,EAAE,SAAS,EAAE,YAAY,GACxC,IAAI,WAAW,EAAE,SAAS,EAAE,YAAY;AAE9C,SAAO;CACR;CAED,SAAS,cACPC,QACAC,SACAC,OACS;AACT,aAAW,WAAW,YAAY,WAAW,MAC3C;OAAI,QAAQ,QAAQ,IAAI,OAAO,CAC7B,QAAO,QAAQ,QAAQ,IAAI,OAAO;EACnC;AAGH,aAAW,WAAW,SAAU,QAAO,cAAc,OAAO;AAC5D,MAAI,MAAM,QAAQ,OAAO,EAAE;GACzB,MAAMC,OAAkB,CAAE;GAC1B,MAAM,SAAS,KAAK,IAAI,OAAO,QAAQ,QAAQ,OAAO,cAAc;AACpE,QAAK,SAAS;AACd,WAAQ,QAAQ,IAAI,QAAQ,KAAK;AACjC,OAAI,OAAO,SAAS,QAAQ,OAAO,cACjC,iBAAgB,SAAS,gBAAgB;AAE3C,QAAK,IAAI,IAAI,GAAG,IAAI,QAAQ,KAAK;AAC/B,UAAM,KAAK,QAAS;IACpB,MAAM,OAAO,OAAO;AACpB,QACE,oBAAoB,KAAK,IAAI,QAAQ,IAAI,QAAQ,OAAO,UACxD;AACA,qBAAgB,SAAS,WAAW;AACpC,UAAK,KAAK;IACX,MACC,MAAK,KAAK,cAAc,MAAM,SAAS,QAAQ,EAAE;GAEpD;AACD,UAAO;EACR;AACD,aAAW,WAAW,YAAY,WAAW,MAAM;AACjD,OAAI,gBAAgB,OAAO,CACzB,QAAO;GAET,MAAMC,WAAoC,CAAE;AAC5C,WAAQ,QAAQ,IAAI,QAAQ,SAAS;GACrC,MAAM,OAAO,OAAO,KAAK,OAAO;AAChC,OAAI,KAAK,SAAS,QAAQ,OAAO,cAC/B,iBAAgB,SAAS,gBAAgB;AAE3C,QAAK,MAAM,OAAO,KAAK,MAAM,GAAG,QAAQ,OAAO,cAAc,EAAE;IAC7D,MAAM,QAAS,OAAmC;AAClD,QACE,oBAAoB,MAAM,IAAI,QAAQ,IAAI,QAAQ,OAAO,UACzD;AACA,qBAAgB,SAAS,WAAW;AACpC,cAAS,OAAO;IACjB,MACC,UAAS,OAAO,cAAc,OAAO,SAAS,QAAQ,EAAE;GAE3D;AACD,UAAO;EACR;AACD,SAAO;CACR;AAED,QAAO,CAACC,WAAsB;EAC5B,MAAM,SAAS,UAAU,OAAO;AAChC,aAAW,WAAW,SAAU,QAAO,cAAc,OAAO;EAC5D,MAAM,UAAU,8BAA8B,QAAQ;AACtD,MAAI,OAAO,SAAS,QAAQ,OAAO,cACjC,iBAAgB,SAAS,gBAAgB;AAE3C,SAAO,OACJ,MAAM,GAAG,QAAQ,OAAO,cAAc,CACtC,IAAI,CAAC,QAAQ,cAAc,KAAK,SAAS,EAAE,CAAC;CAChD;AACF;AAED,SAAS,6BACPC,OACAC,QACM;AACN,KAAI,kCAAkC,WAAW,SAAS,WACxD;AAEF,KAAI;AACF,4BAA0B;AAC1B,aAAW,KACT,uGAEA;GAAE;GAAO,GAAG;EAAQ,EACrB;CACF,QAAO,CAEP,UAAS;AACR,4BAA0B;CAC3B;AACF;AAED,SAAS,oBAAoBC,OAAyB;AACpD,eAAe,UAAU,YAAY,UAAU,SAC5C,gBAAgB,MAAM;AAC1B;AAED,SAAS,8BACPC,SAC2B;AAC3B,QAAO,gCACL,SACA,6BACD;AACF;AAED,SAAS,gBACPR,SACAK,OACM;AACN,KAAI,QAAQ,eAAe,IAAI,MAAM,CAAE;AACvC,SAAQ,oBAAoB,MAAM;AACnC"}

package/dist/traversal.cjs

@@ -0,0 +1,30 @@
+
+//#region src/traversal.ts
+const redactionTruncatedValue = "[truncated]";
+const defaultMaxDepth = 20;
+const defaultMaxProperties = 1e3;
+function createRedactionTraversalContext(options, reportLimitExceeded, visited = /* @__PURE__ */ new Map()) {
+	const limits = {
+		maxDepth: normalizeLimit(options.maxDepth, defaultMaxDepth),
+		maxProperties: normalizeLimit(options.maxProperties, defaultMaxProperties)
+	};
+	const exceededLimits = /* @__PURE__ */ new Set();
+	return {
+		limits,
+		visited,
+		exceededLimits,
+		reportLimitExceeded(limit) {
+			exceededLimits.add(limit);
+			reportLimitExceeded(limit, limits);
+		}
+	};
+}
+function normalizeLimit(value, defaultValue) {
+	if (value == null) return defaultValue;
+	if (!Number.isFinite(value) || value < 0) return defaultValue;
+	return Math.floor(value);
+}
+
+//#endregion
+exports.createRedactionTraversalContext = createRedactionTraversalContext;
+exports.redactionTruncatedValue = redactionTruncatedValue;

package/dist/traversal.d.cts

@@ -0,0 +1,20 @@
+//#region src/traversal.d.ts
+/**
+ * Options for bounding recursive redaction traversal.
+ * @since 2.2.0
+ */
+interface RedactionTraversalOptions {
+  /**
+   * Maximum recursion depth for object and array traversal.
+   * @default `20`
+   */
+  readonly maxDepth?: number;
+  /**
+   * Maximum number of properties or array elements to process per object.
+   * @default `1000`
+   */
+  readonly maxProperties?: number;
+}
+//#endregion
+export { RedactionTraversalOptions };
+//# sourceMappingURL=traversal.d.cts.map

package/dist/traversal.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"traversal.d.cts","names":[],"sources":["../src/traversal.ts"],"sourcesContent":[],"mappings":";;AAIA;;;UAAiB,yBAAA"}

package/dist/traversal.d.ts

@@ -0,0 +1,20 @@
+//#region src/traversal.d.ts
+/**
+ * Options for bounding recursive redaction traversal.
+ * @since 2.2.0
+ */
+interface RedactionTraversalOptions {
+  /**
+   * Maximum recursion depth for object and array traversal.
+   * @default `20`
+   */
+  readonly maxDepth?: number;
+  /**
+   * Maximum number of properties or array elements to process per object.
+   * @default `1000`
+   */
+  readonly maxProperties?: number;
+}
+//#endregion
+export { RedactionTraversalOptions };
+//# sourceMappingURL=traversal.d.ts.map

package/dist/traversal.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"traversal.d.ts","names":[],"sources":["../src/traversal.ts"],"sourcesContent":[],"mappings":";;AAIA;;;UAAiB,yBAAA"}

package/dist/traversal.js

@@ -0,0 +1,29 @@
+//#region src/traversal.ts
+const redactionTruncatedValue = "[truncated]";
+const defaultMaxDepth = 20;
+const defaultMaxProperties = 1e3;
+function createRedactionTraversalContext(options, reportLimitExceeded, visited = /* @__PURE__ */ new Map()) {
+	const limits = {
+		maxDepth: normalizeLimit(options.maxDepth, defaultMaxDepth),
+		maxProperties: normalizeLimit(options.maxProperties, defaultMaxProperties)
+	};
+	const exceededLimits = /* @__PURE__ */ new Set();
+	return {
+		limits,
+		visited,
+		exceededLimits,
+		reportLimitExceeded(limit) {
+			exceededLimits.add(limit);
+			reportLimitExceeded(limit, limits);
+		}
+	};
+}
+function normalizeLimit(value, defaultValue) {
+	if (value == null) return defaultValue;
+	if (!Number.isFinite(value) || value < 0) return defaultValue;
+	return Math.floor(value);
+}
+
+//#endregion
+export { createRedactionTraversalContext, redactionTruncatedValue };
+//# sourceMappingURL=traversal.js.map

package/dist/traversal.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"traversal.js","names":["options: RedactionTraversalOptions","reportLimitExceeded: (\n    limit: RedactionLimit,\n    limits: RedactionTraversalLimits,\n  ) => void","limits: RedactionTraversalLimits","value: number | undefined","defaultValue: number"],"sources":["../src/traversal.ts"],"sourcesContent":["/**\n * Options for bounding recursive redaction traversal.\n * @since 2.2.0\n */\nexport interface RedactionTraversalOptions {\n  /**\n   * Maximum recursion depth for object and array traversal.\n   * @default `20`\n   */\n  readonly maxDepth?: number;\n\n  /**\n   * Maximum number of properties or array elements to process per object.\n   * @default `1000`\n   */\n  readonly maxProperties?: number;\n}\n\nexport interface RedactionTraversalLimits {\n  readonly maxDepth: number;\n  readonly maxProperties: number;\n}\n\nexport type RedactionLimit = keyof RedactionTraversalLimits;\n\nexport interface RedactionTraversalContext {\n  readonly limits: RedactionTraversalLimits;\n  readonly visited: Map<object, object>;\n  readonly exceededLimits: Set<RedactionLimit>;\n  reportLimitExceeded(limit: RedactionLimit): void;\n}\n\nexport const redactionTruncatedValue = \"[truncated]\";\n\nconst defaultMaxDepth = 20;\nconst defaultMaxProperties = 1000;\n\nexport function createRedactionTraversalContext(\n  options: RedactionTraversalOptions,\n  reportLimitExceeded: (\n    limit: RedactionLimit,\n    limits: RedactionTraversalLimits,\n  ) => void,\n  visited = new Map<object, object>(),\n): RedactionTraversalContext {\n  const limits: RedactionTraversalLimits = {\n    maxDepth: normalizeLimit(options.maxDepth, defaultMaxDepth),\n    maxProperties: normalizeLimit(options.maxProperties, defaultMaxProperties),\n  };\n  const exceededLimits = new Set<RedactionLimit>();\n  return {\n    limits,\n    visited,\n    exceededLimits,\n    reportLimitExceeded(limit) {\n      exceededLimits.add(limit);\n      reportLimitExceeded(limit, limits);\n    },\n  };\n}\n\nfunction normalizeLimit(\n  value: number | undefined,\n  defaultValue: number,\n): number {\n  if (value == null) return defaultValue;\n  if (!Number.isFinite(value) || value < 0) return defaultValue;\n  return Math.floor(value);\n}\n"],"mappings":";AAgCA,MAAa,0BAA0B;AAEvC,MAAM,kBAAkB;AACxB,MAAM,uBAAuB;AAE7B,SAAgB,gCACdA,SACAC,qBAIA,0BAAU,IAAI,OACa;CAC3B,MAAMC,SAAmC;EACvC,UAAU,eAAe,QAAQ,UAAU,gBAAgB;EAC3D,eAAe,eAAe,QAAQ,eAAe,qBAAqB;CAC3E;CACD,MAAM,iCAAiB,IAAI;AAC3B,QAAO;EACL;EACA;EACA;EACA,oBAAoB,OAAO;AACzB,kBAAe,IAAI,MAAM;AACzB,uBAAoB,OAAO,OAAO;EACnC;CACF;AACF;AAED,SAAS,eACPC,OACAC,cACQ;AACR,KAAI,SAAS,KAAM,QAAO;AAC1B,MAAK,OAAO,SAAS,MAAM,IAAI,QAAQ,EAAG,QAAO;AACjD,QAAO,KAAK,MAAM,MAAM;AACzB"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@logtape/redaction",
-  "version": "2.2.0-dev.679+7d928b73",
+  "version": "2.2.0-dev.683+daa1aac5",
   "description": "Redact sensitive data from log messages",
   "keywords": [
     "logging",
@@ -49,7 +49,7 @@
     "dist/"
   ],
   "peerDependencies": {
-    "@logtape/logtape": "^2.2.0-dev.679+7d928b73"
+    "@logtape/logtape": "^2.2.0-dev.683+daa1aac5"
   },
   "devDependencies": {
     "@alinea/suite": "^0.6.3",