@logtape/redaction 0.10.0-dev.164

package/LICENSE

@@ -0,0 +1,20 @@
+MIT License
+
+Copyright 2024 Hong Minhee
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -0,0 +1,31 @@
+<!-- deno-fmt-ignore-file -->
+
+Data redaction for LogTape
+==========================
+
+[![JSR][JSR badge]][JSR]
+[![npm][npm badge]][npm]
+
+This package provides data redaction for [LogTape].  You can redact sensitive
+data in log records.
+
+[JSR]: https://jsr.io/@logtape/redaction
+[JSR badge]: https://jsr.io/badges/@logtape/redaction
+[npm]: https://www.npmjs.com/package/@logtape/redaction
+[npm badge]: https://img.shields.io/npm/v/@logtape/redaction?logo=npm
+[LogTape]: https://logtape.org/
+
+
+Installation
+------------
+
+This package is available on [JSR] and [npm].  You can install it for various
+JavaScript runtimes and package managers:
+
+~~~~ sh
+deno add jsr:@logtape/redaction  # for Deno
+npm  add     @logtape/redaction  # for npm
+pnpm add     @logtape/redaction  # for pnpm
+yarn add     @logtape/redaction  # for Yarn
+bun  add     @logtape/redaction  # for Bun
+~~~~

package/esm/field.js

@@ -0,0 +1,95 @@
+/**
+ * Default field patterns for redaction.  These patterns will match
+ * common sensitive fields such as passwords, tokens, and personal
+ * information.
+ * @since 0.10.0
+ */
+export const DEFAULT_REDACT_FIELDS = [
+    /pass(?:code|phrase|word)/i,
+    /secret/i,
+    /token/i,
+    /key/i,
+    /credential/i,
+    /auth/i,
+    /signature/i,
+    /sensitive/i,
+    /private/i,
+    /ssn/i,
+    /email/i,
+    /phone/i,
+    /address/i,
+];
+/**
+ * Redacts properties in a {@link LogRecord} based on the provided field
+ * patterns and action.
+ *
+ * Note that it is a decorator which wraps the sink and redacts properties
+ * before passing them to the sink.
+ *
+ * @example
+ * ```ts
+ * import { getConsoleSink } from "@logtape/logtape";
+ * import { redactByField } from "@logtape/redaction";
+ *
+ * const sink = redactByField(getConsoleSink());
+ * ```
+ *
+ * @param sink The sink to wrap.
+ * @param options The redaction options.
+ * @returns The wrapped sink.
+ * @since 0.10.0
+ */
+export function redactByField(sink, options = DEFAULT_REDACT_FIELDS) {
+    const opts = Array.isArray(options) ? { fieldPatterns: options } : options;
+    const wrapped = (record) => {
+        sink({ ...record, properties: redactProperties(record.properties, opts) });
+    };
+    if (Symbol.dispose in sink)
+        wrapped[Symbol.dispose] = sink[Symbol.dispose];
+    if (Symbol.asyncDispose in sink) {
+        wrapped[Symbol.asyncDispose] = sink[Symbol.asyncDispose];
+    }
+    return wrapped;
+}
+/**
+ * Redacts properties in a record based on the provided field patterns and
+ * action.
+ * @param properties The properties to redact.
+ * @param options The redaction options.
+ * @returns The redacted properties.
+ * @since 0.10.0
+ */
+export function redactProperties(properties, options) {
+    const copy = { ...properties };
+    for (const field in copy) {
+        if (!shouldFieldRedacted(field, options.fieldPatterns))
+            continue;
+        if (options.action == null || options.action === "delete") {
+            delete copy[field];
+        }
+        else {
+            copy[field] = options.action(copy[field]);
+        }
+    }
+    return copy;
+}
+/**
+ * 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.
+ * @returns `true` if the field should be redacted, `false` otherwise.
+ * @since 0.10.0
+ */
+export function shouldFieldRedacted(field, fieldPatterns) {
+    for (const fieldPattern of fieldPatterns) {
+        if (typeof fieldPattern === "string") {
+            if (fieldPattern === field)
+                return true;
+        }
+        else {
+            if (fieldPattern.test(field))
+                return true;
+        }
+    }
+    return false;
+}

package/esm/mod.js

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

package/esm/package.json

@@ -0,0 +1,3 @@
+{
+  "type": "module"
+}

package/package.json

@@ -0,0 +1,59 @@
+{
+  "name": "@logtape/redaction",
+  "version": "0.10.0-dev.164+f355881a",
+  "description": "Redact sensitive data from log messages",
+  "keywords": [
+    "logging",
+    "log",
+    "logger",
+    "redaction",
+    "mask",
+    "masking",
+    "sensitive"
+  ],
+  "author": {
+    "name": "Hong Minhee",
+    "email": "hong@minhee.org",
+    "url": "https://hongminhee.org/"
+  },
+  "homepage": "https://logtape.org/",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/dahlia/logtape.git",
+    "directory": "file/"
+  },
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/dahlia/logtape/issues"
+  },
+  "main": "./script/mod.js",
+  "module": "./esm/mod.js",
+  "types": "./types/mod.d.ts",
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./types/mod.d.ts",
+        "default": "./esm/mod.js"
+      },
+      "require": {
+        "types": "./types/mod.d.ts",
+        "default": "./script/mod.js"
+      }
+    }
+  },
+  "scripts": {
+    "test": "node test_runner.js"
+  },
+  "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"
+  },
+  "_generatedBy": "dnt@dev"
+}

package/script/field.js

@@ -0,0 +1,101 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DEFAULT_REDACT_FIELDS = void 0;
+exports.redactByField = redactByField;
+exports.redactProperties = redactProperties;
+exports.shouldFieldRedacted = shouldFieldRedacted;
+/**
+ * Default field patterns for redaction.  These patterns will match
+ * common sensitive fields such as passwords, tokens, and personal
+ * information.
+ * @since 0.10.0
+ */
+exports.DEFAULT_REDACT_FIELDS = [
+    /pass(?:code|phrase|word)/i,
+    /secret/i,
+    /token/i,
+    /key/i,
+    /credential/i,
+    /auth/i,
+    /signature/i,
+    /sensitive/i,
+    /private/i,
+    /ssn/i,
+    /email/i,
+    /phone/i,
+    /address/i,
+];
+/**
+ * Redacts properties in a {@link LogRecord} based on the provided field
+ * patterns and action.
+ *
+ * Note that it is a decorator which wraps the sink and redacts properties
+ * before passing them to the sink.
+ *
+ * @example
+ * ```ts
+ * import { getConsoleSink } from "@logtape/logtape";
+ * import { redactByField } from "@logtape/redaction";
+ *
+ * const sink = redactByField(getConsoleSink());
+ * ```
+ *
+ * @param sink The sink to wrap.
+ * @param options The redaction options.
+ * @returns The wrapped sink.
+ * @since 0.10.0
+ */
+function redactByField(sink, options = exports.DEFAULT_REDACT_FIELDS) {
+    const opts = Array.isArray(options) ? { fieldPatterns: options } : options;
+    const wrapped = (record) => {
+        sink({ ...record, properties: redactProperties(record.properties, opts) });
+    };
+    if (Symbol.dispose in sink)
+        wrapped[Symbol.dispose] = sink[Symbol.dispose];
+    if (Symbol.asyncDispose in sink) {
+        wrapped[Symbol.asyncDispose] = sink[Symbol.asyncDispose];
+    }
+    return wrapped;
+}
+/**
+ * Redacts properties in a record based on the provided field patterns and
+ * action.
+ * @param properties The properties to redact.
+ * @param options The redaction options.
+ * @returns The redacted properties.
+ * @since 0.10.0
+ */
+function redactProperties(properties, options) {
+    const copy = { ...properties };
+    for (const field in copy) {
+        if (!shouldFieldRedacted(field, options.fieldPatterns))
+            continue;
+        if (options.action == null || options.action === "delete") {
+            delete copy[field];
+        }
+        else {
+            copy[field] = options.action(copy[field]);
+        }
+    }
+    return copy;
+}
+/**
+ * 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.
+ * @returns `true` if the field should be redacted, `false` otherwise.
+ * @since 0.10.0
+ */
+function shouldFieldRedacted(field, fieldPatterns) {
+    for (const fieldPattern of fieldPatterns) {
+        if (typeof fieldPattern === "string") {
+            if (fieldPattern === field)
+                return true;
+        }
+        else {
+            if (fieldPattern.test(field))
+                return true;
+        }
+    }
+    return false;
+}

package/script/mod.js

@@ -0,0 +1,6 @@
+"use strict";
+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; } });

package/script/package.json

@@ -0,0 +1,3 @@
+{
+  "type": "commonjs"
+}

package/types/_dnt.test_shims.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"_dnt.test_shims.d.ts","sourceRoot":"","sources":["../src/_dnt.test_shims.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,iBAAiB,CAAC;AACvC,OAAO,EAAE,IAAI,EAAE,MAAM,iBAAiB,CAAC;AAKvC,eAAO,MAAM,aAAa;;CAA2C,CAAC"}

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

@@ -0,0 +1 @@
+{"version":3,"file":"_constants.d.ts","sourceRoot":"","sources":["../../../../../../src/deps/jsr.io/@std/assert/0.222.1/_constants.ts"],"names":[],"mappings":"AACA,eAAO,MAAM,eAAe,qBAAqB,CAAC"}

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

@@ -0,0 +1 @@
+{"version":3,"file":"_diff.d.ts","sourceRoot":"","sources":["../../../../../../src/deps/jsr.io/@std/assert/0.222.1/_diff.ts"],"names":[],"mappings":"AAUA,eAAO,MAAM,QAAQ;;;;CAIX,CAAC;AAEX,MAAM,MAAM,QAAQ,GAAG,MAAM,OAAO,QAAQ,CAAC;AAE7C,MAAM,WAAW,UAAU,CAAC,CAAC;IAC3B,IAAI,EAAE,QAAQ,CAAC;IACf,KAAK,EAAE,CAAC,CAAC;IACT,OAAO,CAAC,EAAE,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC;CAChC;AA4BD;;;;GAIG;AACH,wBAAgB,IAAI,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,EAAE,CAAC,EAAE,GAAG,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CA+L5D;AAED;;;;;GAKG;AACH,wBAAgB,OAAO,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,wBAsI3C;AAwCD,wBAAgB,YAAY,CAC1B,UAAU,EAAE,aAAa,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,EAC7C,EAAE,UAAkB,EAAE;;CAAK,GAC1B,MAAM,EAAE,CAyBV"}

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

@@ -0,0 +1 @@
+{"version":3,"file":"_format.d.ts","sourceRoot":"","sources":["../../../../../../src/deps/jsr.io/@std/assert/0.222.1/_format.ts"],"names":[],"mappings":"AAYA,wBAAgB,MAAM,CAAC,CAAC,EAAE,OAAO,GAAG,MAAM,CAezC"}

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

@@ -0,0 +1 @@
+{"version":3,"file":"assert_equals.d.ts","sourceRoot":"","sources":["../../../../../../src/deps/jsr.io/@std/assert/0.222.1/assert_equals.ts"],"names":[],"mappings":"AASA;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,YAAY,CAAC,CAAC,EAC5B,MAAM,EAAE,CAAC,EACT,QAAQ,EAAE,CAAC,EACX,GAAG,CAAC,EAAE,MAAM,EACZ,OAAO,GAAE;IAAE,SAAS,CAAC,EAAE,CAAC,KAAK,EAAE,OAAO,KAAK,MAAM,CAAA;CAAO,QAuBzD"}

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

@@ -0,0 +1 @@
+{"version":3,"file":"assertion_error.d.ts","sourceRoot":"","sources":["../../../../../../src/deps/jsr.io/@std/assert/0.222.1/assertion_error.ts"],"names":[],"mappings":"AAGA;;;;;;;;;GASG;AACH,qBAAa,cAAe,SAAQ,KAAK;IACvC,iCAAiC;gBACrB,OAAO,EAAE,MAAM;CAI5B"}

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

@@ -0,0 +1 @@
+{"version":3,"file":"equal.d.ts","sourceRoot":"","sources":["../../../../../../src/deps/jsr.io/@std/assert/0.222.1/equal.ts"],"names":[],"mappings":"AAYA;;;;;;;;;;;;GAYG;AACH,wBAAgB,KAAK,CAAC,CAAC,EAAE,OAAO,EAAE,CAAC,EAAE,OAAO,GAAG,OAAO,CA8FrD"}

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

@@ -0,0 +1 @@
+{"version":3,"file":"colors.d.ts","sourceRoot":"","sources":["../../../../../../src/deps/jsr.io/@std/fmt/0.222.1/colors.ts"],"names":[],"mappings":"AAkEA,qEAAqE;AACrE,MAAM,WAAW,GAAG;IAClB,0BAA0B;IAC1B,CAAC,EAAE,MAAM,CAAC;IACV,4BAA4B;IAC5B,CAAC,EAAE,MAAM,CAAC;IACV,2BAA2B;IAC3B,CAAC,EAAE,MAAM,CAAC;CACX;AAID;;;GAGG;AACH,wBAAgB,eAAe,CAAC,KAAK,EAAE,OAAO,QAM7C;AAED,4DAA4D;AAC5D,wBAAgB,eAAe,IAAI,OAAO,CAEzC;AA0BD;;;GAGG;AACH,wBAAgB,KAAK,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAEzC;AAED;;;GAGG;AACH,wBAAgB,IAAI,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAExC;AAED;;;;;;GAMG;AACH,wBAAgB,GAAG,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAEvC;AAED;;;GAGG;AACH,wBAAgB,MAAM,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAE1C;AAED;;;GAGG;AACH,wBAAgB,SAAS,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAE7C;AAED;;;GAGG;AACH,wBAAgB,OAAO,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAE3C;AAED;;;GAGG;AACH,wBAAgB,MAAM,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAE1C;AAED;;;GAGG;AACH,wBAAgB,aAAa,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAEjD;AAED;;;GAGG;AACH,wBAAgB,KAAK,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAEzC;AAED;;;GAGG;AACH,wBAAgB,GAAG,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAEvC;AAED;;;GAGG;AACH,wBAAgB,KAAK,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAEzC;AAED;;;GAGG;AACH,wBAAgB,MAAM,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAE1C;AAED;;;GAGG;AACH,wBAAgB,IAAI,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAExC;AAED;;;GAGG;AACH,wBAAgB,OAAO,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAE3C;AAED;;;GAGG;AACH,wBAAgB,IAAI,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAExC;AAED;;;GAGG;AACH,wBAAgB,KAAK,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAEzC;AAED;;;GAGG;AACH,wBAAgB,IAAI,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAExC;AAED;;;GAGG;AACH,wBAAgB,WAAW,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAE/C;AAED;;;GAGG;AACH,wBAAgB,SAAS,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAE7C;AAED;;;GAGG;AACH,wBAAgB,WAAW,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAE/C;AAED;;;GAGG;AACH,wBAAgB,YAAY,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAEhD;AAED;;;GAGG;AACH,wBAAgB,UAAU,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAE9C;AAED;;;GAGG;AACH,wBAAgB,aAAa,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAEjD;AAED;;;GAGG;AACH,wBAAgB,UAAU,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAE9C;AAED;;;GAGG;AACH,wBAAgB,WAAW,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAE/C;AAED;;;GAGG;AACH,wBAAgB,OAAO,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAE3C;AAED;;;GAGG;AACH,wBAAgB,KAAK,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAEzC;AAED;;;GAGG;AACH,wBAAgB,OAAO,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAE3C;AAED;;;GAGG;AACH,wBAAgB,QAAQ,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAE5C;AAED;;;GAGG;AACH,wBAAgB,MAAM,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAE1C;AAED;;;GAGG;AACH,wBAAgB,SAAS,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAE7C;AAED;;;GAGG;AACH,wBAAgB,MAAM,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAE1C;AAED;;;GAGG;AACH,wBAAgB,OAAO,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAE3C;AAED;;;GAGG;AACH,wBAAgB,aAAa,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAEjD;AAED;;;GAGG;AACH,wBAAgB,WAAW,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAE/C;AAED;;;GAGG;AACH,wBAAgB,aAAa,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAEjD;AAED;;;GAGG;AACH,wBAAgB,cAAc,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAElD;AAED;;;GAGG;AACH,wBAAgB,YAAY,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAEhD;AAED;;;GAGG;AACH,wBAAgB,eAAe,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAEnD;AAED;;;GAGG;AACH,wBAAgB,YAAY,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAEhD;AAED;;;GAGG;AACH,wBAAgB,aAAa,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAEjD;AAcD;;;;;GAKG;AACH,wBAAgB,IAAI,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,MAAM,CAEvD;AAED;;;;;GAKG;AACH,wBAAgB,MAAM,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,MAAM,CAEzD;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,KAAK,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,GAAG,GAAG,MAAM,CAuB9D;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,OAAO,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,GAAG,GAAG,MAAM,CAuBhE;AAWD;;;;;GAKG;AACH,wBAAgB,UAAU,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAEjD;AAED;;;;GAIG;AACH,wBAAgB,aAAa,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAEpD"}

package/types/field.d.ts

@@ -0,0 +1,84 @@
+import type { Sink } from "@logtape/logtape";
+/**
+ * The type for a field pattern used in redaction.  A string or a regular
+ * expression that matches field names.
+ * @since 0.10.0
+ */
+export type FieldPattern = string | RegExp;
+/**
+ * An array of field patterns used for redaction.  Each pattern can be
+ * a string or a regular expression that matches field names.
+ * @since 0.10.0
+ */
+export type FieldPatterns = FieldPattern[];
+/**
+ * Default field patterns for redaction.  These patterns will match
+ * common sensitive fields such as passwords, tokens, and personal
+ * information.
+ * @since 0.10.0
+ */
+export declare const DEFAULT_REDACT_FIELDS: FieldPatterns;
+/**
+ * Options for redacting fields in a {@link LogRecord}.  Used by
+ * the {@link redactByField} function.
+ * @since 0.10.0
+ */
+export interface FieldRedactionOptions {
+    /**
+     * The field patterns to match against.  This can be an array of
+     * strings or regular expressions.  If a field matches any of the
+     * patterns, it will be redacted.
+     * @defaultValue {@link DEFAULT_REDACT_FIELDS}
+     */
+    readonly fieldPatterns: FieldPatterns;
+    /**
+     * The action to perform on the matched fields.  If not provided,
+     * the default action is to delete the field from the properties.
+     * If a function is provided, it will be called with the
+     * value of the field, and the return value will be used to replace
+     * the field in the properties.
+     * If the action is `"delete"`, the field will be removed from the
+     * properties.
+     * @default `"delete"`
+     */
+    readonly action?: "delete" | ((value: unknown) => unknown);
+}
+/**
+ * Redacts properties in a {@link LogRecord} based on the provided field
+ * patterns and action.
+ *
+ * Note that it is a decorator which wraps the sink and redacts properties
+ * before passing them to the sink.
+ *
+ * @example
+ * ```ts
+ * import { getConsoleSink } from "@logtape/logtape";
+ * import { redactByField } from "@logtape/redaction";
+ *
+ * const sink = redactByField(getConsoleSink());
+ * ```
+ *
+ * @param sink The sink to wrap.
+ * @param options The redaction options.
+ * @returns The wrapped sink.
+ * @since 0.10.0
+ */
+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.
+ * @param properties The properties to redact.
+ * @param options The redaction options.
+ * @returns The redacted properties.
+ * @since 0.10.0
+ */
+export declare function redactProperties(properties: Record<string, unknown>, options: FieldRedactionOptions): Record<string, unknown>;
+/**
+ * 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.
+ * @returns `true` if the field should be redacted, `false` otherwise.
+ * @since 0.10.0
+ */
+export declare function shouldFieldRedacted(field: string, fieldPatterns: FieldPatterns): boolean;
+//# sourceMappingURL=field.d.ts.map

package/types/field.d.ts.map

@@ -0,0 +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"}

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

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

package/types/mod.d.ts

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

package/types/mod.d.ts.map

@@ -0,0 +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"}