@logtape/redaction 0.10.0-dev.164 → 0.10.0-dev.168

package/esm/field.js

@@ -52,8 +52,16 @@ export function redactByField(sink, options = DEFAULT_REDACT_FIELDS) {
     return wrapped;
 }
 /**
- * Redacts properties in a record based on the provided field patterns and
- * action.
+ * Redacts properties from an object based on specified field patterns.
+ *
+ * This function creates a shallow copy of the input object and applies
+ * redaction rules to its properties. For properties that match the redaction
+ * patterns, the function either removes them or transforms their values based
+ * on the provided action.
+ *
+ * The redaction process is recursive and will be applied to nested objects
+ * as well, allowing for deep redaction of sensitive data in complex object
+ * structures.
  * @param properties The properties to redact.
  * @param options The redaction options.
  * @returns The redacted properties.
@@ -62,13 +70,22 @@ export function redactByField(sink, options = DEFAULT_REDACT_FIELDS) {
 export function redactProperties(properties, options) {
     const copy = { ...properties };
     for (const field in copy) {
-        if (!shouldFieldRedacted(field, options.fieldPatterns))
+        if (shouldFieldRedacted(field, options.fieldPatterns)) {
+            if (options.action == null || options.action === "delete") {
+                delete copy[field];
+            }
+            else {
+                copy[field] = options.action(copy[field]);
+            }
             continue;
-        if (options.action == null || options.action === "delete") {
-            delete copy[field];
         }
-        else {
-            copy[field] = options.action(copy[field]);
+        const value = copy[field];
+        // Check if value is a vanilla object:
+        if (typeof value === "object" && value !== null &&
+            (Object.getPrototypeOf(value) === Object.prototype ||
+                Object.getPrototypeOf(value) === null)) {
+            // @ts-ignore: value is always Record<string, unknown>
+            copy[field] = redactProperties(value, options);
         }
     }
     return copy;

package/esm/mod.js

@@ -1 +1,2 @@
 export { DEFAULT_REDACT_FIELDS, redactByField, } from "./field.js";
+export * from "./pattern.js";

package/esm/pattern.js

@@ -0,0 +1,84 @@
+/**
+ * A redaction pattern for email addresses.
+ * @since 0.10.0
+ */
+export const EMAIL_ADDRESS_PATTERN = {
+    pattern: /[\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,
+    replacement: "REDACTED@EMAIL.ADDRESS",
+};
+/**
+ * A redaction pattern for credit card numbers (including American Express).
+ * @since 0.10.0
+ */
+export const CREDIT_CARD_NUMBER_PATTERN = {
+    pattern: /(?:\d{4}-){3}\d{4}|(?:\d{4}-){2}\d{6}/g,
+    replacement: "XXXX-XXXX-XXXX-XXXX",
+};
+/**
+ * A redaction pattern for U.S. Social Security numbers.
+ * @since 0.10.0
+ */
+export const US_SSN_PATTERN = {
+    pattern: /\d{3}-\d{2}-\d{4}/g,
+    replacement: "XXX-XX-XXXX",
+};
+/**
+ * A redaction pattern for South Korean resident registration numbers
+ * (住民登錄番號).
+ * @since 0.10.0
+ */
+export const KR_RRN_PATTERN = {
+    pattern: /\d{6}-\d{7}/g,
+    replacement: "XXXXXX-XXXXXXX",
+};
+/**
+ * A redaction pattern for JSON Web Tokens (JWT).
+ * @since 0.10.0
+ */
+export const JWT_PATTERN = {
+    pattern: /eyJ[a-zA-Z0-9_-]*\.[a-zA-Z0-9_-]*\.[a-zA-Z0-9_-]*/g,
+    replacement: "[JWT REDACTED]",
+};
+export function redactByPattern(formatter, patterns) {
+    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) {
+            // The following ternary operator may seem strange, but it's for
+            // making TypeScript happy:
+            str = typeof p.replacement === "string"
+                ? str.replaceAll(p.pattern, p.replacement)
+                : str.replaceAll(p.pattern, p.replacement);
+        }
+        return str;
+    }
+    function replaceObject(object) {
+        if (typeof object === "string")
+            return replaceString(object);
+        else if (Array.isArray(object))
+            return object.map(replaceObject);
+        else if (typeof object === "object" && object !== null) {
+            // Check if object is a vanilla object:
+            if (Object.getPrototypeOf(object) === Object.prototype ||
+                Object.getPrototypeOf(object) === null) {
+                const redacted = {};
+                for (const key in object) {
+                    redacted[key] =
+                        // @ts-ignore: object always has key
+                        replaceObject(object[key]);
+                }
+                return redacted;
+            }
+        }
+        return object;
+    }
+    return (record) => {
+        const output = formatter(record);
+        if (typeof output === "string")
+            return replaceString(output);
+        return output.map(replaceObject);
+    };
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@logtape/redaction",
-  "version": "0.10.0-dev.164+f355881a",
+  "version": "0.10.0-dev.168+93601094",
   "description": "Redact sensitive data from log messages",
   "keywords": [
     "logging",
@@ -47,13 +47,11 @@
   "funding": [
     "https://github.com/sponsors/dahlia"
   ],
-  "dependencies": {
-    "@logtape/logtape": "^0.10.0-dev.162"
-  },
   "devDependencies": {
     "@types/node": "^20.9.0",
     "picocolors": "^1.0.0",
-    "@deno/shim-deno": "~0.18.0"
+    "@deno/shim-deno": "~0.18.0",
+    "@logtape/logtape": "^0.10.0-dev.168"
   },
   "_generatedBy": "dnt@dev"
 }

package/script/field.js

@@ -58,8 +58,16 @@ function redactByField(sink, options = exports.DEFAULT_REDACT_FIELDS) {
     return wrapped;
 }
 /**
- * Redacts properties in a record based on the provided field patterns and
- * action.
+ * Redacts properties from an object based on specified field patterns.
+ *
+ * This function creates a shallow copy of the input object and applies
+ * redaction rules to its properties. For properties that match the redaction
+ * patterns, the function either removes them or transforms their values based
+ * on the provided action.
+ *
+ * The redaction process is recursive and will be applied to nested objects
+ * as well, allowing for deep redaction of sensitive data in complex object
+ * structures.
  * @param properties The properties to redact.
  * @param options The redaction options.
  * @returns The redacted properties.
@@ -68,13 +76,22 @@ function redactByField(sink, options = exports.DEFAULT_REDACT_FIELDS) {
 function redactProperties(properties, options) {
     const copy = { ...properties };
     for (const field in copy) {
-        if (!shouldFieldRedacted(field, options.fieldPatterns))
+        if (shouldFieldRedacted(field, options.fieldPatterns)) {
+            if (options.action == null || options.action === "delete") {
+                delete copy[field];
+            }
+            else {
+                copy[field] = options.action(copy[field]);
+            }
             continue;
-        if (options.action == null || options.action === "delete") {
-            delete copy[field];
         }
-        else {
-            copy[field] = options.action(copy[field]);
+        const value = copy[field];
+        // Check if value is a vanilla object:
+        if (typeof value === "object" && value !== null &&
+            (Object.getPrototypeOf(value) === Object.prototype ||
+                Object.getPrototypeOf(value) === null)) {
+            // @ts-ignore: value is always Record<string, unknown>
+            copy[field] = redactProperties(value, options);
         }
     }
     return copy;

package/script/mod.js

@@ -1,6 +1,21 @@
 "use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.redactByField = exports.DEFAULT_REDACT_FIELDS = void 0;
 var field_js_1 = require("./field.js");
 Object.defineProperty(exports, "DEFAULT_REDACT_FIELDS", { enumerable: true, get: function () { return field_js_1.DEFAULT_REDACT_FIELDS; } });
 Object.defineProperty(exports, "redactByField", { enumerable: true, get: function () { return field_js_1.redactByField; } });
+__exportStar(require("./pattern.js"), exports);

package/script/pattern.js

@@ -0,0 +1,88 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.JWT_PATTERN = exports.KR_RRN_PATTERN = exports.US_SSN_PATTERN = exports.CREDIT_CARD_NUMBER_PATTERN = exports.EMAIL_ADDRESS_PATTERN = void 0;
+exports.redactByPattern = redactByPattern;
+/**
+ * A redaction pattern for email addresses.
+ * @since 0.10.0
+ */
+exports.EMAIL_ADDRESS_PATTERN = {
+    pattern: /[\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,
+    replacement: "REDACTED@EMAIL.ADDRESS",
+};
+/**
+ * A redaction pattern for credit card numbers (including American Express).
+ * @since 0.10.0
+ */
+exports.CREDIT_CARD_NUMBER_PATTERN = {
+    pattern: /(?:\d{4}-){3}\d{4}|(?:\d{4}-){2}\d{6}/g,
+    replacement: "XXXX-XXXX-XXXX-XXXX",
+};
+/**
+ * A redaction pattern for U.S. Social Security numbers.
+ * @since 0.10.0
+ */
+exports.US_SSN_PATTERN = {
+    pattern: /\d{3}-\d{2}-\d{4}/g,
+    replacement: "XXX-XX-XXXX",
+};
+/**
+ * A redaction pattern for South Korean resident registration numbers
+ * (住民登錄番號).
+ * @since 0.10.0
+ */
+exports.KR_RRN_PATTERN = {
+    pattern: /\d{6}-\d{7}/g,
+    replacement: "XXXXXX-XXXXXXX",
+};
+/**
+ * A redaction pattern for JSON Web Tokens (JWT).
+ * @since 0.10.0
+ */
+exports.JWT_PATTERN = {
+    pattern: /eyJ[a-zA-Z0-9_-]*\.[a-zA-Z0-9_-]*\.[a-zA-Z0-9_-]*/g,
+    replacement: "[JWT REDACTED]",
+};
+function redactByPattern(formatter, patterns) {
+    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) {
+            // The following ternary operator may seem strange, but it's for
+            // making TypeScript happy:
+            str = typeof p.replacement === "string"
+                ? str.replaceAll(p.pattern, p.replacement)
+                : str.replaceAll(p.pattern, p.replacement);
+        }
+        return str;
+    }
+    function replaceObject(object) {
+        if (typeof object === "string")
+            return replaceString(object);
+        else if (Array.isArray(object))
+            return object.map(replaceObject);
+        else if (typeof object === "object" && object !== null) {
+            // Check if object is a vanilla object:
+            if (Object.getPrototypeOf(object) === Object.prototype ||
+                Object.getPrototypeOf(object) === null) {
+                const redacted = {};
+                for (const key in object) {
+                    redacted[key] =
+                        // @ts-ignore: object always has key
+                        replaceObject(object[key]);
+                }
+                return redacted;
+            }
+        }
+        return object;
+    }
+    return (record) => {
+        const output = formatter(record);
+        if (typeof output === "string")
+            return replaceString(output);
+        return output.map(replaceObject);
+    };
+}

package/types/deps/jsr.io/@std/assert/0.222.1/assert.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"assert.d.ts","sourceRoot":"","sources":["../../../../../../src/deps/jsr.io/@std/assert/0.222.1/assert.ts"],"names":[],"mappings":"AAIA;;;;;;;;;;GAUG;AACH,wBAAgB,MAAM,CAAC,IAAI,EAAE,OAAO,EAAE,GAAG,SAAK,GAAG,OAAO,CAAC,IAAI,CAI5D"}

package/types/deps/jsr.io/@std/assert/0.222.1/assert_exists.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"assert_exists.d.ts","sourceRoot":"","sources":["../../../../../../src/deps/jsr.io/@std/assert/0.222.1/assert_exists.ts"],"names":[],"mappings":"AAIA;;;;;;;;;;;GAWG;AACH,wBAAgB,YAAY,CAAC,CAAC,EAC5B,MAAM,EAAE,CAAC,EACT,GAAG,CAAC,EAAE,MAAM,GACX,OAAO,CAAC,MAAM,IAAI,WAAW,CAAC,CAAC,CAAC,CAOlC"}

package/types/deps/jsr.io/@std/assert/0.222.1/assert_false.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"assert_false.d.ts","sourceRoot":"","sources":["../../../../../../src/deps/jsr.io/@std/assert/0.222.1/assert_false.ts"],"names":[],"mappings":"AAIA,uDAAuD;AACvD,MAAM,MAAM,KAAK,GAAG,KAAK,GAAG,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,IAAI,GAAG,SAAS,CAAC;AAE3D;;;;;;;;;;GAUG;AACH,wBAAgB,WAAW,CAAC,IAAI,EAAE,OAAO,EAAE,GAAG,SAAK,GAAG,OAAO,CAAC,IAAI,IAAI,KAAK,CAI1E"}

package/types/deps/jsr.io/@std/assert/0.222.1/assert_is_error.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"assert_is_error.d.ts","sourceRoot":"","sources":["../../../../../../src/deps/jsr.io/@std/assert/0.222.1/assert_is_error.ts"],"names":[],"mappings":"AAKA;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,aAAa,CAAC,CAAC,SAAS,KAAK,GAAG,KAAK,EACnD,KAAK,EAAE,OAAO,EAEd,UAAU,CAAC,EAAE,KAAK,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,CAAC,EACtC,UAAU,CAAC,EAAE,MAAM,GAAG,MAAM,EAC5B,GAAG,CAAC,EAAE,MAAM,GACX,OAAO,CAAC,KAAK,IAAI,CAAC,CAmCpB"}

package/types/deps/jsr.io/@std/assert/0.222.1/assert_match.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"assert_match.d.ts","sourceRoot":"","sources":["../../../../../../src/deps/jsr.io/@std/assert/0.222.1/assert_match.ts"],"names":[],"mappings":"AAIA;;;;;;;;;;;GAWG;AACH,wBAAgB,WAAW,CACzB,MAAM,EAAE,MAAM,EACd,QAAQ,EAAE,MAAM,EAChB,GAAG,CAAC,EAAE,MAAM,QAOb"}

package/types/deps/jsr.io/@std/assert/0.222.1/assert_throws.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"assert_throws.d.ts","sourceRoot":"","sources":["../../../../../../src/deps/jsr.io/@std/assert/0.222.1/assert_throws.ts"],"names":[],"mappings":"AAKA;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,YAAY,CAC1B,EAAE,EAAE,MAAM,OAAO,EACjB,GAAG,CAAC,EAAE,MAAM,GACX,OAAO,CAAC;AACX;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,YAAY,CAAC,CAAC,SAAS,KAAK,GAAG,KAAK,EAClD,EAAE,EAAE,MAAM,OAAO,EAEjB,UAAU,EAAE,KAAK,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,CAAC,EACrC,WAAW,CAAC,EAAE,MAAM,EACpB,GAAG,CAAC,EAAE,MAAM,GACX,CAAC,CAAC"}

package/types/field.d.ts

@@ -65,8 +65,16 @@ export interface FieldRedactionOptions {
  */
 export declare function redactByField(sink: Sink | Sink & Disposable | Sink & AsyncDisposable, options?: FieldRedactionOptions | FieldPatterns): Sink | Sink & Disposable | Sink & AsyncDisposable;
 /**
- * Redacts properties in a record based on the provided field patterns and
- * action.
+ * Redacts properties from an object based on specified field patterns.
+ *
+ * This function creates a shallow copy of the input object and applies
+ * redaction rules to its properties. For properties that match the redaction
+ * patterns, the function either removes them or transforms their values based
+ * on the provided action.
+ *
+ * The redaction process is recursive and will be applied to nested objects
+ * as well, allowing for deep redaction of sensitive data in complex object
+ * structures.
  * @param properties The properties to redact.
  * @param options The redaction options.
  * @returns The redacted properties.

package/types/field.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"field.d.ts","sourceRoot":"","sources":["../src/field.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAa,IAAI,EAAE,MAAM,kBAAkB,CAAC;AAExD;;;;GAIG;AACH,MAAM,MAAM,YAAY,GAAG,MAAM,GAAG,MAAM,CAAC;AAE3C;;;;GAIG;AACH,MAAM,MAAM,aAAa,GAAG,YAAY,EAAE,CAAC;AAE3C;;;;;GAKG;AACH,eAAO,MAAM,qBAAqB,EAAE,aAcnC,CAAC;AAEF;;;;GAIG;AACH,MAAM,WAAW,qBAAqB;IACpC;;;;;OAKG;IACH,QAAQ,CAAC,aAAa,EAAE,aAAa,CAAC;IAEtC;;;;;;;;;OASG;IACH,QAAQ,CAAC,MAAM,CAAC,EAAE,QAAQ,GAAG,CAAC,CAAC,KAAK,EAAE,OAAO,KAAK,OAAO,CAAC,CAAC;CAC5D;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,wBAAgB,aAAa,CAC3B,IAAI,EAAE,IAAI,GAAG,IAAI,GAAG,UAAU,GAAG,IAAI,GAAG,eAAe,EACvD,OAAO,GAAE,qBAAqB,GAAG,aAAqC,GACrE,IAAI,GAAG,IAAI,GAAG,UAAU,GAAG,IAAI,GAAG,eAAe,CAUnD;AAED;;;;;;;GAOG;AACH,wBAAgB,gBAAgB,CAC9B,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EACnC,OAAO,EAAE,qBAAqB,GAC7B,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAWzB;AAED;;;;;;GAMG;AACH,wBAAgB,mBAAmB,CACjC,KAAK,EAAE,MAAM,EACb,aAAa,EAAE,aAAa,GAC3B,OAAO,CAST"}
+{"version":3,"file":"field.d.ts","sourceRoot":"","sources":["../src/field.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAa,IAAI,EAAE,MAAM,kBAAkB,CAAC;AAExD;;;;GAIG;AACH,MAAM,MAAM,YAAY,GAAG,MAAM,GAAG,MAAM,CAAC;AAE3C;;;;GAIG;AACH,MAAM,MAAM,aAAa,GAAG,YAAY,EAAE,CAAC;AAE3C;;;;;GAKG;AACH,eAAO,MAAM,qBAAqB,EAAE,aAcnC,CAAC;AAEF;;;;GAIG;AACH,MAAM,WAAW,qBAAqB;IACpC;;;;;OAKG;IACH,QAAQ,CAAC,aAAa,EAAE,aAAa,CAAC;IAEtC;;;;;;;;;OASG;IACH,QAAQ,CAAC,MAAM,CAAC,EAAE,QAAQ,GAAG,CAAC,CAAC,KAAK,EAAE,OAAO,KAAK,OAAO,CAAC,CAAC;CAC5D;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,wBAAgB,aAAa,CAC3B,IAAI,EAAE,IAAI,GAAG,IAAI,GAAG,UAAU,GAAG,IAAI,GAAG,eAAe,EACvD,OAAO,GAAE,qBAAqB,GAAG,aAAqC,GACrE,IAAI,GAAG,IAAI,GAAG,UAAU,GAAG,IAAI,GAAG,eAAe,CAUnD;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,gBAAgB,CAC9B,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EACnC,OAAO,EAAE,qBAAqB,GAC7B,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAuBzB;AAED;;;;;;GAMG;AACH,wBAAgB,mBAAmB,CACjC,KAAK,EAAE,MAAM,EACb,aAAa,EAAE,aAAa,GAC3B,OAAO,CAST"}

package/types/mod.d.ts

@@ -1,2 +1,3 @@
 export { DEFAULT_REDACT_FIELDS, type FieldPattern, type FieldPatterns, type FieldRedactionOptions, redactByField, } from "./field.js";
+export * from "./pattern.js";
 //# sourceMappingURL=mod.d.ts.map

package/types/mod.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"mod.d.ts","sourceRoot":"","sources":["../src/mod.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,qBAAqB,EACrB,KAAK,YAAY,EACjB,KAAK,aAAa,EAClB,KAAK,qBAAqB,EAC1B,aAAa,GACd,MAAM,YAAY,CAAC"}
+{"version":3,"file":"mod.d.ts","sourceRoot":"","sources":["../src/mod.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,qBAAqB,EACrB,KAAK,YAAY,EACjB,KAAK,aAAa,EAClB,KAAK,qBAAqB,EAC1B,aAAa,GACd,MAAM,YAAY,CAAC;AACpB,cAAc,cAAc,CAAC"}

package/types/pattern.d.ts

@@ -0,0 +1,120 @@
+import type { ConsoleFormatter, TextFormatter } from "@logtape/logtape";
+/**
+ * A redaction pattern, which is a pair of regular expression and replacement
+ * string or function.
+ * @since 0.10.0
+ */
+export interface RedactionPattern {
+    /**
+     * The regular expression to match against.  Note that it must have the
+     * `g` (global) flag set, otherwise it will throw a `TypeError`.
+     */
+    readonly pattern: RegExp;
+    /**
+     * The replacement string or function.  If the replacement is a function,
+     * it will be called with the matched string and any capture groups (the same
+     * signature as `String.prototype.replaceAll()`).
+     */
+    readonly replacement: string | ((match: string, ...rest: readonly any[]) => string);
+}
+/**
+ * A redaction pattern for email addresses.
+ * @since 0.10.0
+ */
+export declare const EMAIL_ADDRESS_PATTERN: RedactionPattern;
+/**
+ * A redaction pattern for credit card numbers (including American Express).
+ * @since 0.10.0
+ */
+export declare const CREDIT_CARD_NUMBER_PATTERN: RedactionPattern;
+/**
+ * A redaction pattern for U.S. Social Security numbers.
+ * @since 0.10.0
+ */
+export declare const US_SSN_PATTERN: RedactionPattern;
+/**
+ * A redaction pattern for South Korean resident registration numbers
+ * (住民登錄番號).
+ * @since 0.10.0
+ */
+export declare const KR_RRN_PATTERN: RedactionPattern;
+/**
+ * A redaction pattern for JSON Web Tokens (JWT).
+ * @since 0.10.0
+ */
+export declare const JWT_PATTERN: RedactionPattern;
+/**
+ * A list of {@link RedactionPattern}s.
+ * @since 0.10.0
+ */
+export type RedactionPatterns = readonly RedactionPattern[];
+/**
+ * Applies data redaction to a {@link TextFormatter}.
+ *
+ * Note that there are some built-in redaction patterns:
+ *
+ * - {@link CREDIT_CARD_NUMBER_PATTERN}
+ * - {@link EMAIL_ADDRESS_PATTERN}
+ * - {@link JWT_PATTERN}
+ * - {@link KR_RRN_PATTERN}
+ * - {@link US_SSN_PATTERN}
+ *
+ * @example
+ * ```ts
+ * import { getFileSink } from "@logtape/file";
+ * import { getAnsiColorFormatter } from "@logtape/logtape";
+ * import {
+ *   CREDIT_CARD_NUMBER_PATTERN,
+ *   EMAIL_ADDRESS_PATTERN,
+ *   JWT_PATTERN,
+ *   redactByPattern,
+ * } from "@logtape/redaction";
+ *
+ * const formatter = redactByPattern(getAnsiConsoleFormatter(), [
+ *   CREDIT_CARD_NUMBER_PATTERN,
+ *   EMAIL_ADDRESS_PATTERN,
+ *   JWT_PATTERN,
+ * ]);
+ * const sink = getFileSink("my-app.log", { formatter });
+ * ```
+ * @param formatter The text formatter to apply redaction to.
+ * @param patterns The redaction patterns to apply.
+ * @returns The redacted text formatter.
+ * @since 0.10.0
+ */
+export declare function redactByPattern(formatter: TextFormatter, patterns: RedactionPatterns): TextFormatter;
+/**
+ * Applies data redaction to a {@link ConsoleFormatter}.
+ *
+ * Note that there are some built-in redaction patterns:
+ *
+ * - {@link CREDIT_CARD_NUMBER_PATTERN}
+ * - {@link EMAIL_ADDRESS_PATTERN}
+ * - {@link JWT_PATTERN}
+ * - {@link KR_RRN_PATTERN}
+ * - {@link US_SSN_PATTERN}
+ *
+ * @example
+ * ```ts
+ * import { defaultConsoleFormatter, getConsoleSink } from "@logtape/logtape";
+ * import {
+ *   CREDIT_CARD_NUMBER_PATTERN,
+ *   EMAIL_ADDRESS_PATTERN,
+ *   JWT_PATTERN,
+ *   redactByPattern,
+ * } from "@logtape/redaction";
+ *
+ * const formatter = redactByPattern(defaultConsoleFormatter, [
+ *   CREDIT_CARD_NUMBER_PATTERN,
+ *   EMAIL_ADDRESS_PATTERN,
+ *   JWT_PATTERN,
+ * ]);
+ * const sink = getConsoleSink({ formatter });
+ * ```
+ * @param formatter The console formatter to apply redaction to.
+ * @param patterns The redaction patterns to apply.
+ * @returns The redacted console formatter.
+ * @since 0.10.0
+ */
+export declare function redactByPattern(formatter: ConsoleFormatter, patterns: RedactionPatterns): ConsoleFormatter;
+//# sourceMappingURL=pattern.d.ts.map

package/types/pattern.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"pattern.d.ts","sourceRoot":"","sources":["../src/pattern.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,gBAAgB,EAEhB,aAAa,EACd,MAAM,kBAAkB,CAAC;AAE1B;;;;GAIG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;;OAGG;IACH,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IAEzB;;;;OAIG;IACH,QAAQ,CAAC,WAAW,EAChB,MAAM,GAEN,CAAC,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,SAAS,GAAG,EAAE,KAAK,MAAM,CAAC,CAAC;CAC1D;AAED;;;GAGG;AACH,eAAO,MAAM,qBAAqB,EAAE,gBAInC,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,0BAA0B,EAAE,gBAGxC,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,cAAc,EAAE,gBAG5B,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,cAAc,EAAE,gBAG5B,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,WAAW,EAAE,gBAGzB,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,iBAAiB,GAAG,SAAS,gBAAgB,EAAE,CAAC;AAE5D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiCG;AACH,wBAAgB,eAAe,CAC7B,SAAS,EAAE,aAAa,EACxB,QAAQ,EAAE,iBAAiB,GAC1B,aAAa,CAAC;AAEjB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgCG;AACH,wBAAgB,eAAe,CAC7B,SAAS,EAAE,gBAAgB,EAC3B,QAAQ,EAAE,iBAAiB,GAC1B,gBAAgB,CAAC"}

package/types/pattern.test.d.ts.map

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