field-redactor 1.5.0 → 1.6.0

package/CHANGELOG.md

@@ -5,6 +5,28 @@ All notable changes to this project are documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [1.6.0] - 2026-07-21
+
+Path rules, pass-key allowlists, Opaque/Remove naming aliases, and architecture cleanup. See [docs/release-notes/v1.6.0.md](docs/release-notes/v1.6.0.md) and [docs/guides/migration-1.5-to-1.6.md](docs/guides/migration-1.5-to-1.6.md).
+
+### Added
+
+- **`pathRules` / `.pathRule()`** — path-based redaction modes (`shallow`, `deep`, `opaque`, `remove`, `pass`) with `*` wildcards.
+- **`passKeys` / `.passKey()`** — allowlisted keys preserved under deep parents.
+- **Naming aliases** — `opaqueSecretKeys`, `removeSecretKeys`, `CustomObjectMatchType.Opaque` / `Remove` (legacy `full`/`delete` names retained).
+- **`RedactionMode`**, **`PathRule`**, **`PathRuleMode`** exports.
+- **`RuleResolver`** — shared precedence for traversal and dry-run attribution.
+- **Path rules guide** — [docs/guides/path-rules.md](docs/guides/path-rules.md).
+- **Migration guide** — [docs/guides/migration-1.5-to-1.6.md](docs/guides/migration-1.5-to-1.6.md).
+- **Contributing guide** — [CONTRIBUTING.md](CONTRIBUTING.md).
+
+### Changed
+
+- Source layout under `api/`, `engine/`, `rules/`, `dryrun/`, `config/`, `util/`.
+- Unified sync/async traversal behind `MaybeAsync` helpers.
+- `package.json` `"exports"` limited to the package root (`.`).
+- Internal sync-traversal alias removed (`ObjectRedactorSyncTraversal`).
+
 ## [1.5.0] - 2026-06-24
 
 Published npm release bundling **v1.2.1**–**v1.3.0** git work and former internal milestones **2.4.0**–**2.5.1**. See [docs/guides/migration-1.2-to-1.5.md](docs/guides/migration-1.2-to-1.5.md) when upgrading from npm **1.2.x**.
@@ -144,6 +166,7 @@ Development tags `2.0.0`–`2.3.1` track incremental work toward `1.3.0`. See [d
 
 - Initial public release: regex key rules, custom object schemas with sibling-key indirection, async `redact()` / `redactInPlace()`, and configurable redactor functions.
 
+[1.6.0]: https://github.com/mologna/field-redactor/compare/v1.5.0...v1.6.0
 [1.5.0]: https://github.com/mologna/field-redactor/releases/tag/v1.5.0
 [2.5.1]: https://github.com/mologna/field-redactor/compare/2.5.0...2.5.1
 [2.5.0]: https://github.com/mologna/field-redactor/compare/2.4.0...2.5.0

package/CONTRIBUTING.md

@@ -0,0 +1,64 @@
+# Contributing to field-redactor
+
+This repository publishes the npm package **`field-redactor`**. The local folder may be named `obfuscator`; that is only a workspace path—use the package name in docs, issues, and imports.
+
+## Versioning
+
+| Channel | Meaning |
+|---------|---------|
+| npm `1.x` | Public releases (current line: `1.6.x`) |
+| Internal `2.x` tags / release notes | Historical development tags; not the npm line of record |
+
+Prefer npm version numbers in user-facing docs. Internal release notes under `docs/release-notes/` may still mention older `2.x` tags for chronology.
+
+## Layout
+
+```
+src/
+  api/       Public facade: FieldRedactor, ConfigBuilder, DI wiring
+  engine/    Traversal, array/custom-object handlers, PrimitiveRedactor
+  rules/     SecretManager, matchers, RuleResolver, CustomObjectManager
+  dryrun/    Structural diff + rule attribution
+  config/    Validation, presets, redactionRules, schema helpers
+  util/      pathParsing, jsonWalk, maybeAsync, regexUtils
+  index.ts   Public exports only
+  types.ts   Shared types
+  errors.ts  Public errors
+```
+
+Public consumers should import from `field-redactor` (see `package.json` `exports`). Do not rely on deep `dist/...` paths.
+
+## Rule precedence
+
+Single source of truth: **`RuleResolver`** (`src/rules/ruleResolver.ts`).
+
+Order: **schema → path rule → enclosing opaque/deep key → leaf key rule → value pattern → default**.
+
+Traversal and dry-run attribution both use this module. When adding a rule type, update `RuleResolver` and add a contract case in `tests/unit/ruleResolver.contract.spec.ts`.
+
+### Naming vocabulary
+
+| Mode | Preferred config / enum | Legacy aliases |
+|------|-------------------------|----------------|
+| Shallow | `secretKeys`, `CustomObjectMatchType.Shallow` | — |
+| Deep | `deepSecretKeys` | — |
+| Opaque | `opaqueSecretKeys`, `CustomObjectMatchType.Opaque` | `fullSecretKeys`, `Full` |
+| Remove | `removeSecretKeys`, `CustomObjectMatchType.Remove` | `deleteSecretKeys`, `Delete` |
+
+## Development
+
+```bash
+yarn install
+yarn build
+yarn test
+```
+
+- Unit tests: `tests/unit/`
+- Integration / end-to-end: `tests/integration/` (keep these few and scenario-focused; prefer unit tests for rule edge cases)
+- Shared test helpers: `tests/helpers/`
+
+## Pull requests
+
+- Keep changes focused; avoid drive-by refactors outside the task.
+- Do not commit unless asked.
+- Match existing commit message style (short, imperative, why-focused).

package/README.md

@@ -69,9 +69,12 @@ Use `FieldRedactor.createSafe({ ... })` or `FieldRedactorConfigBuilder` so you n
 | [Metadata redaction](docs/guides/metadata-redaction.md) | `{ name, value }` schemas and sibling-key rules |
 | [Anti-patterns](docs/guides/anti-patterns.md) | Common config mistakes and fixes |
 | [Value-pattern redaction](docs/guides/value-pattern-redaction.md) | Detect PII in free-text field values |
+| [Path rules & allowlists](docs/guides/path-rules.md) | Target stable JSON paths; exempt keys under deep redaction |
 | [Configuration reference](docs/reference/config.md) | Full option table, API, presets, validation |
+| [Migration 1.5 → 1.6](docs/guides/migration-1.5-to-1.6.md) | Upgrade from 1.5.x (path rules, naming, exports) |
 | [Migration 1.2 → 1.5](docs/guides/migration-1.2-to-1.5.md) | Upgrade from the previous npm line |
 | [Release notes](docs/release-notes/README.md) | Per-version notes for every published tag |
+| [Contributing](CONTRIBUTING.md) | Layout, precedence, naming, and local workflow |
 
 ## API surface
 

package/dist/api/fieldRedactor.d.ts

@@ -0,0 +1,53 @@
+import { DryRunResult, FieldRedactorConfig, RedactableInput } from '../types';
+/**
+ * FieldRedactor is a highly customizable JSON object field redactor. It conditionally redacts fields based on
+ * the secrets, deepSecrets, fullSecrets, and custom objects provided in the configuration. Refer to the README.md
+ * for more details.
+ *
+ * Defaults: `ignoreNullOrUndefined` is `true`, `ignoreBooleans` is `false`, `cloneInput` is `true`.
+ */
+export declare class FieldRedactor {
+    private readonly deepCopy;
+    private readonly deps;
+    /** Non-fatal configuration warnings from the last construction (empty when `strict` threw). */
+    readonly configWarnings: readonly string[];
+    constructor(config?: FieldRedactorConfig);
+    /**
+     * Creates a FieldRedactor that requires at least one explicit redaction rule: Shallow (`secretKeys`),
+     * Deep (`deepSecretKeys`), Opaque (`fullSecretKeys`), Remove (`deleteSecretKeys`), Schema (`customObjects`),
+     * or Value-pattern (`valuePatterns`).
+     * Unlike `new FieldRedactor()`, omitting all rules does not default to redacting every value.
+     */
+    static createSafe(config: FieldRedactorConfig): FieldRedactor;
+    /** Convenience alias for `new FieldRedactor(config)`. */
+    static fromConfig(config?: FieldRedactorConfig): FieldRedactor;
+    /** Redacts a copy of the input and returns an audit report of affected paths without mutating the original. */
+    dryRun<T extends RedactableInput>(value: T): Promise<DryRunResult<T>>;
+    /** Synchronous {@link FieldRedactor.dryRun} without per-field Promise overhead. */
+    dryRunSync<T extends RedactableInput>(value: T): DryRunResult<T>;
+    private runDryRun;
+    private emptyDryRunResult;
+    private toDryRunResult;
+    /**
+     * Conditionally redacts fields in the JSON object based on the configuration provided in the constructor and returns the
+     * redacted result.
+     * If the value is a primitive, undefined, or date, returns the value as-is.
+     */
+    redact<T extends RedactableInput>(value: T): Promise<T>;
+    /**
+     * Synchronously redacts fields and returns a copy without per-field Promise overhead.
+     * Uses copy-on-write structural sharing by default so only mutated branches are cloned.
+     */
+    redactSync<T extends RedactableInput>(value: T): T;
+    /** Conditionally redacts fields in the JSON object in place based on the configuration provided in the constructor. */
+    redactInPlace<T extends RedactableInput>(value: T): Promise<void>;
+    /**
+     * Synchronously redacts fields in the JSON object in place without per-field Promise overhead.
+     * Requires a `syncRedactor` or the default redactor; throws when only an async `redactor` is configured.
+     */
+    redactInPlaceSync<T extends RedactableInput>(value: T): void;
+    private runTraversableRedaction;
+    private toFieldRedactorError;
+    private isPrimitiveOrUndefined;
+}
+//# sourceMappingURL=fieldRedactor.d.ts.map

package/dist/api/fieldRedactor.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"fieldRedactor.d.ts","sourceRoot":"","sources":["../../src/api/fieldRedactor.ts"],"names":[],"mappings":"AAEA,OAAO,EACL,YAAY,EACZ,mBAAmB,EAInB,eAAe,EAEhB,MAAM,UAAU,CAAC;AAKlB;;;;;;GAMG;AACH,qBAAa,aAAa;IACxB,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAwC;IACjE,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAoB;IAEzC,+FAA+F;IAC/F,SAAgB,cAAc,EAAE,SAAS,MAAM,EAAE,CAAC;gBAEtC,MAAM,CAAC,EAAE,mBAAmB;IASxC;;;;;OAKG;WACW,UAAU,CAAC,MAAM,EAAE,mBAAmB,GAAG,aAAa;IAUpE,yDAAyD;WAC3C,UAAU,CAAC,MAAM,CAAC,EAAE,mBAAmB,GAAG,aAAa;IAIrE,+GAA+G;IAClG,MAAM,CAAC,CAAC,SAAS,eAAe,EAAE,KAAK,EAAE,CAAC,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;IAIlF,mFAAmF;IAC5E,UAAU,CAAC,CAAC,SAAS,eAAe,EAAE,KAAK,EAAE,CAAC,GAAG,YAAY,CAAC,CAAC,CAAC;IASvE,OAAO,CAAC,SAAS;IAiBjB,OAAO,CAAC,iBAAiB;IAIzB,OAAO,CAAC,cAAc;IActB;;;;OAIG;IACU,MAAM,CAAC,CAAC,SAAS,eAAe,EAAE,KAAK,EAAE,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC;IAmBpE;;;OAGG;IACI,UAAU,CAAC,CAAC,SAAS,eAAe,EAAE,KAAK,EAAE,CAAC,GAAG,CAAC;IAazD,uHAAuH;IAC1G,aAAa,CAAC,CAAC,SAAS,eAAe,EAAE,KAAK,EAAE,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;IAS9E;;;OAGG;IACI,iBAAiB,CAAC,CAAC,SAAS,eAAe,EAAE,KAAK,EAAE,CAAC,GAAG,IAAI;IAQnE,OAAO,CAAC,uBAAuB;IAoB/B,OAAO,CAAC,oBAAoB;IAK5B,OAAO,CAAC,sBAAsB;CAG/B"}

package/dist/api/fieldRedactor.js

@@ -0,0 +1,169 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FieldRedactor = void 0;
+const errors_1 = require("../errors");
+const fieldRedactorDeps_1 = require("./fieldRedactorDeps");
+const dryRun_1 = require("../dryrun/dryRun");
+const rfdc_1 = __importDefault(require("rfdc"));
+const configValidator_1 = require("../config/configValidator");
+/**
+ * FieldRedactor is a highly customizable JSON object field redactor. It conditionally redacts fields based on
+ * the secrets, deepSecrets, fullSecrets, and custom objects provided in the configuration. Refer to the README.md
+ * for more details.
+ *
+ * Defaults: `ignoreNullOrUndefined` is `true`, `ignoreBooleans` is `false`, `cloneInput` is `true`.
+ */
+class FieldRedactor {
+    constructor(config) {
+        var _a;
+        this.deepCopy = (0, rfdc_1.default)({ proto: true, circles: true });
+        this.configWarnings = (0, configValidator_1.validateFieldRedactorConfig)(config);
+        for (const warning of this.configWarnings) {
+            (_a = config === null || config === void 0 ? void 0 : config.onConfigWarning) === null || _a === void 0 ? void 0 : _a.call(config, warning);
+        }
+        this.deps = (0, fieldRedactorDeps_1.buildFieldRedactorDeps)(config);
+    }
+    /**
+     * Creates a FieldRedactor that requires at least one explicit redaction rule: Shallow (`secretKeys`),
+     * Deep (`deepSecretKeys`), Opaque (`fullSecretKeys`), Remove (`deleteSecretKeys`), Schema (`customObjects`),
+     * or Value-pattern (`valuePatterns`).
+     * Unlike `new FieldRedactor()`, omitting all rules does not default to redacting every value.
+     */
+    static createSafe(config) {
+        if (!(0, configValidator_1.hasExplicitRedactionRules)(config)) {
+            throw new errors_1.FieldRedactorConfigurationError('FieldRedactor.createSafe() requires at least one non-empty secretKeys, deepSecretKeys, fullSecretKeys, deleteSecretKeys, customObjects, valuePatterns, or pathRules entry. Without explicit rules, new FieldRedactor() redacts all values by default.');
+        }
+        return new FieldRedactor(config);
+    }
+    /** Convenience alias for `new FieldRedactor(config)`. */
+    static fromConfig(config) {
+        return new FieldRedactor(config);
+    }
+    /** Redacts a copy of the input and returns an audit report of affected paths without mutating the original. */
+    dryRun(value) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.runDryRun(value, (input) => this.redact(input));
+        });
+    }
+    /** Synchronous {@link FieldRedactor.dryRun} without per-field Promise overhead. */
+    dryRunSync(value) {
+        if (this.isPrimitiveOrUndefined(value)) {
+            return this.emptyDryRunResult(value);
+        }
+        const snapshot = this.deepCopy(value);
+        return this.toDryRunResult(snapshot, this.redactSync(value));
+    }
+    runDryRun(value, redact) {
+        if (this.isPrimitiveOrUndefined(value)) {
+            return this.emptyDryRunResult(value);
+        }
+        const snapshot = this.deepCopy(value);
+        const result = redact(value);
+        if (result instanceof Promise) {
+            return result.then((redacted) => this.toDryRunResult(snapshot, redacted));
+        }
+        return this.toDryRunResult(snapshot, result);
+    }
+    emptyDryRunResult(value) {
+        return { result: value, report: dryRun_1.EMPTY_DRY_RUN_REPORT };
+    }
+    toDryRunResult(snapshot, result) {
+        return {
+            result,
+            report: (0, dryRun_1.buildDryRunReport)(snapshot, result, this.deps.customObjectManager, this.deps.secretManager, this.deps.valuePatternMatcher, this.deps.pathRuleMatcher)
+        };
+    }
+    /**
+     * Conditionally redacts fields in the JSON object based on the configuration provided in the constructor and returns the
+     * redacted result.
+     * If the value is a primitive, undefined, or date, returns the value as-is.
+     */
+    redact(value) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (this.isPrimitiveOrUndefined(value)) {
+                return value;
+            }
+            if (!this.deps.cloneInput) {
+                yield this.redactInPlace(value);
+                return value;
+            }
+            if (!this.deps.usesAsyncRedactor) {
+                return Promise.resolve(this.redactSync(value));
+            }
+            const copy = this.deepCopy(value);
+            yield this.redactInPlace(copy);
+            return copy;
+        });
+    }
+    /**
+     * Synchronously redacts fields and returns a copy without per-field Promise overhead.
+     * Uses copy-on-write structural sharing by default so only mutated branches are cloned.
+     */
+    redactSync(value) {
+        if (this.isPrimitiveOrUndefined(value)) {
+            return value;
+        }
+        if (!this.deps.cloneInput) {
+            this.redactInPlaceSync(value);
+            return value;
+        }
+        return this.deps.objectRedactor.redactCopyOnWrite(value);
+    }
+    /** Conditionally redacts fields in the JSON object in place based on the configuration provided in the constructor. */
+    redactInPlace(value) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (!this.deps.usesAsyncRedactor) {
+                this.redactInPlaceSync(value);
+                return;
+            }
+            yield this.runTraversableRedaction(value, () => this.deps.objectRedactor.redactInPlace(value));
+        });
+    }
+    /**
+     * Synchronously redacts fields in the JSON object in place without per-field Promise overhead.
+     * Requires a `syncRedactor` or the default redactor; throws when only an async `redactor` is configured.
+     */
+    redactInPlaceSync(value) {
+        if (this.deps.usesAsyncRedactor) {
+            throw new errors_1.FieldRedactorError('redactInPlaceSync requires syncRedactor configuration or the default redactor');
+        }
+        this.runTraversableRedaction(value, () => this.deps.objectRedactor.redactInPlaceSync(value));
+    }
+    runTraversableRedaction(value, redact) {
+        if (this.isPrimitiveOrUndefined(value)) {
+            return;
+        }
+        try {
+            const result = redact();
+            if (result instanceof Promise) {
+                return result.catch((error) => {
+                    throw this.toFieldRedactorError(error);
+                });
+            }
+        }
+        catch (error) {
+            throw this.toFieldRedactorError(error);
+        }
+    }
+    toFieldRedactorError(error) {
+        const message = error instanceof Error ? error.message : String(error);
+        return new errors_1.FieldRedactorError(message);
+    }
+    isPrimitiveOrUndefined(value) {
+        return !value || typeof value !== 'object' || value instanceof Date;
+    }
+}
+exports.FieldRedactor = FieldRedactor;
+//# sourceMappingURL=fieldRedactor.js.map

package/dist/api/fieldRedactor.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"fieldRedactor.js","sourceRoot":"","sources":["../../src/api/fieldRedactor.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,sCAAgF;AAChF,2DAAgF;AAUhF,6CAA2E;AAC3E,gDAAwB;AACxB,+DAAmG;AAEnG;;;;;;GAMG;AACH,MAAa,aAAa;IAOxB,YAAY,MAA4B;;QANvB,aAAQ,GAAG,IAAA,cAAI,EAAC,EAAE,KAAK,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC;QAO/D,IAAI,CAAC,cAAc,GAAG,IAAA,6CAA2B,EAAC,MAAM,CAAC,CAAC;QAC1D,KAAK,MAAM,OAAO,IAAI,IAAI,CAAC,cAAc,EAAE,CAAC;YAC1C,MAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,eAAe,uDAAG,OAAO,CAAC,CAAC;QACrC,CAAC;QAED,IAAI,CAAC,IAAI,GAAG,IAAA,0CAAsB,EAAC,MAAM,CAAC,CAAC;IAC7C,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,UAAU,CAAC,MAA2B;QAClD,IAAI,CAAC,IAAA,2CAAyB,EAAC,MAAM,CAAC,EAAE,CAAC;YACvC,MAAM,IAAI,wCAA+B,CACvC,uPAAuP,CACxP,CAAC;QACJ,CAAC;QAED,OAAO,IAAI,aAAa,CAAC,MAAM,CAAC,CAAC;IACnC,CAAC;IAED,yDAAyD;IAClD,MAAM,CAAC,UAAU,CAAC,MAA4B;QACnD,OAAO,IAAI,aAAa,CAAC,MAAM,CAAC,CAAC;IACnC,CAAC;IAED,+GAA+G;IAClG,MAAM,CAA4B,KAAQ;;YACrD,OAAO,IAAI,CAAC,SAAS,CAAC,KAAK,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;QAC9D,CAAC;KAAA;IAED,mFAAmF;IAC5E,UAAU,CAA4B,KAAQ;QACnD,IAAI,IAAI,CAAC,sBAAsB,CAAC,KAAK,CAAC,EAAE,CAAC;YACvC,OAAO,IAAI,CAAC,iBAAiB,CAAC,KAAK,CAAC,CAAC;QACvC,CAAC;QAED,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAM,CAAC;QAC3C,OAAO,IAAI,CAAC,cAAc,CAAC,QAAQ,EAAE,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC;IAC/D,CAAC;IAEO,SAAS,CACf,KAAQ,EACR,MAAoC;QAEpC,IAAI,IAAI,CAAC,sBAAsB,CAAC,KAAK,CAAC,EAAE,CAAC;YACvC,OAAO,IAAI,CAAC,iBAAiB,CAAC,KAAK,CAAC,CAAC;QACvC,CAAC;QAED,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAM,CAAC;QAC3C,MAAM,MAAM,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC;QAC7B,IAAI,MAAM,YAAY,OAAO,EAAE,CAAC;YAC9B,OAAO,MAAM,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,IAAI,CAAC,cAAc,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC,CAAC;QAC5E,CAAC;QAED,OAAO,IAAI,CAAC,cAAc,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;IAC/C,CAAC;IAEO,iBAAiB,CAAI,KAAQ;QACnC,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,6BAAoB,EAAE,CAAC;IACzD,CAAC;IAEO,cAAc,CAA4B,QAAW,EAAE,MAAS;QACtE,OAAO;YACL,MAAM;YACN,MAAM,EAAE,IAAA,0BAAiB,EACvB,QAAqB,EACrB,MAAmB,EACnB,IAAI,CAAC,IAAI,CAAC,mBAAmB,EAC7B,IAAI,CAAC,IAAI,CAAC,aAAa,EACvB,IAAI,CAAC,IAAI,CAAC,mBAAmB,EAC7B,IAAI,CAAC,IAAI,CAAC,eAAe,CAC1B;SACF,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACU,MAAM,CAA4B,KAAQ;;YACrD,IAAI,IAAI,CAAC,sBAAsB,CAAC,KAAK,CAAC,EAAE,CAAC;gBACvC,OAAO,KAAK,CAAC;YACf,CAAC;YAED,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,CAAC;gBAC1B,MAAM,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;gBAChC,OAAO,KAAK,CAAC;YACf,CAAC;YAED,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE,CAAC;gBACjC,OAAO,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC;YACjD,CAAC;YAED,MAAM,IAAI,GAAG,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAM,CAAC;YACvC,MAAM,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;YAC/B,OAAO,IAAI,CAAC;QACd,CAAC;KAAA;IAED;;;OAGG;IACI,UAAU,CAA4B,KAAQ;QACnD,IAAI,IAAI,CAAC,sBAAsB,CAAC,KAAK,CAAC,EAAE,CAAC;YACvC,OAAO,KAAK,CAAC;QACf,CAAC;QAED,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,CAAC;YAC1B,IAAI,CAAC,iBAAiB,CAAC,KAAK,CAAC,CAAC;YAC9B,OAAO,KAAK,CAAC;QACf,CAAC;QAED,OAAO,IAAI,CAAC,IAAI,CAAC,cAAc,CAAC,iBAAiB,CAAC,KAAwB,CAAM,CAAC;IACnF,CAAC;IAED,uHAAuH;IAC1G,aAAa,CAA4B,KAAQ;;YAC5D,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE,CAAC;gBACjC,IAAI,CAAC,iBAAiB,CAAC,KAAK,CAAC,CAAC;gBAC9B,OAAO;YACT,CAAC;YAED,MAAM,IAAI,CAAC,uBAAuB,CAAC,KAAK,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,cAAc,CAAC,aAAa,CAAC,KAAwB,CAAC,CAAC,CAAC;QACpH,CAAC;KAAA;IAED;;;OAGG;IACI,iBAAiB,CAA4B,KAAQ;QAC1D,IAAI,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE,CAAC;YAChC,MAAM,IAAI,2BAAkB,CAAC,+EAA+E,CAAC,CAAC;QAChH,CAAC;QAED,IAAI,CAAC,uBAAuB,CAAC,KAAK,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,cAAc,CAAC,iBAAiB,CAAC,KAAwB,CAAC,CAAC,CAAC;IAClH,CAAC;IAEO,uBAAuB,CAC7B,KAAQ,EACR,MAAqB;QAErB,IAAI,IAAI,CAAC,sBAAsB,CAAC,KAAK,CAAC,EAAE,CAAC;YACvC,OAAO;QACT,CAAC;QAED,IAAI,CAAC;YACH,MAAM,MAAM,GAAG,MAAM,EAAE,CAAC;YACxB,IAAI,MAAM,YAAY,OAAO,EAAE,CAAC;gBAC9B,OAAO,MAAM,CAAC,KAAK,CAAC,CAAC,KAAc,EAAE,EAAE;oBACrC,MAAM,IAAI,CAAC,oBAAoB,CAAC,KAAK,CAAC,CAAC;gBACzC,CAAC,CAAC,CAAC;YACL,CAAC;QACH,CAAC;QAAC,OAAO,KAAc,EAAE,CAAC;YACxB,MAAM,IAAI,CAAC,oBAAoB,CAAC,KAAK,CAAC,CAAC;QACzC,CAAC;IACH,CAAC;IAEO,oBAAoB,CAAC,KAAc;QACzC,MAAM,OAAO,GAAG,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;QACvE,OAAO,IAAI,2BAAkB,CAAC,OAAO,CAAC,CAAC;IACzC,CAAC;IAEO,sBAAsB,CAAC,KAAsB;QACnD,OAAO,CAAC,KAAK,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,YAAY,IAAI,CAAC;IACtE,CAAC;CACF;AAlLD,sCAkLC"}

package/dist/api/fieldRedactorConfigBuilder.d.ts

@@ -0,0 +1,57 @@
+import type { FieldRedactor } from './fieldRedactor';
+import { CustomObject, FieldRedactorConfig, PathRuleMode, Redactor, SyncRedactor } from '../types';
+export type SchemaOptions = {
+    /** Optional label surfaced in {@link FieldRedactor.dryRun} `matchedSchemas` reports. */
+    name?: string;
+};
+/**
+ * Fluent builder for {@link FieldRedactorConfig} using doc labels (Shallow, Deep, Opaque, Remove, Schema).
+ */
+export declare class FieldRedactorConfigBuilder {
+    private config;
+    private schemas;
+    static create(): FieldRedactorConfigBuilder;
+    /** Shallow — redact matching keys' scalar values (`secretKeys`). */
+    shallow(...patterns: RegExp[]): this;
+    /** Deep — redact matching keys and descendants (`deepSecretKeys`). */
+    deep(...patterns: RegExp[]): this;
+    /** Opaque — stringify entire values at matching keys (`fullSecretKeys`). */
+    opaque(...patterns: RegExp[]): this;
+    /** Remove — delete matching keys from output (`deleteSecretKeys`). */
+    remove(...patterns: RegExp[]): this;
+    /** Alias for {@link FieldRedactorConfigBuilder.remove}. */
+    delete(...patterns: RegExp[]): this;
+    /** Register an object schema (`customObjects`). */
+    schema(customObject: CustomObject, options?: SchemaOptions): this;
+    /**
+     * Value-pattern — redact scalar fields whose string form matches a pattern, regardless of key name (`valuePatterns`).
+     * Lowest precedence; opt-in defense in depth beyond key-name rules.
+     */
+    valuePattern(...patterns: RegExp[]): this;
+    /**
+     * Path rule — apply a redaction mode at a JSON path (`metadata.*.value`, `accountInfo.id`).
+     */
+    pathRule(path: string, mode: PathRuleMode): this;
+    /** Allowlist — matching key names are never redacted under deep parents (`passKeys`). */
+    passKey(...patterns: RegExp[]): this;
+    /**
+     * Merge a {@link presets} return value (or any partial config) into the builder.
+     * Regex arrays and schemas accumulate; scalar options apply only when not already set.
+     */
+    usePreset(preset: Partial<FieldRedactorConfig>): this;
+    redactor(fn: Redactor): this;
+    syncRedactor(fn: SyncRedactor): this;
+    ignoreBooleans(value: boolean): this;
+    ignoreNullOrUndefined(value: boolean): this;
+    cloneInput(value: boolean): this;
+    strict(value?: boolean): this;
+    onConfigWarning(handler: (message: string) => void): this;
+    build(): FieldRedactorConfig;
+    /** Constructs a {@link FieldRedactor} from the built config. */
+    buildRedactor(): FieldRedactor;
+    /** Like {@link FieldRedactor.createSafe} using the built config. */
+    buildSafeRedactor(): FieldRedactor;
+    private appendRegex;
+    private set;
+}
+//# sourceMappingURL=fieldRedactorConfigBuilder.d.ts.map

package/dist/api/fieldRedactorConfigBuilder.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"fieldRedactorConfigBuilder.d.ts","sourceRoot":"","sources":["../../src/api/fieldRedactorConfigBuilder.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAQrD,OAAO,EAAE,YAAY,EAAE,mBAAmB,EAAE,YAAY,EAAE,QAAQ,EAAE,YAAY,EAAE,MAAM,UAAU,CAAC;AAEnG,MAAM,MAAM,aAAa,GAAG;IAC1B,wFAAwF;IACxF,IAAI,CAAC,EAAE,MAAM,CAAC;CACf,CAAC;AAEF;;GAEG;AACH,qBAAa,0BAA0B;IACrC,OAAO,CAAC,MAAM,CAA2B;IACzC,OAAO,CAAC,OAAO,CAA0B;IAEzC,MAAM,CAAC,MAAM,IAAI,0BAA0B;IAI3C,oEAAoE;IACpE,OAAO,CAAC,GAAG,QAAQ,EAAE,MAAM,EAAE,GAAG,IAAI;IAIpC,sEAAsE;IACtE,IAAI,CAAC,GAAG,QAAQ,EAAE,MAAM,EAAE,GAAG,IAAI;IAIjC,4EAA4E;IAC5E,MAAM,CAAC,GAAG,QAAQ,EAAE,MAAM,EAAE,GAAG,IAAI;IAInC,sEAAsE;IACtE,MAAM,CAAC,GAAG,QAAQ,EAAE,MAAM,EAAE,GAAG,IAAI;IAInC,2DAA2D;IAC3D,MAAM,CAAC,GAAG,QAAQ,EAAE,MAAM,EAAE,GAAG,IAAI;IAInC,mDAAmD;IACnD,MAAM,CAAC,YAAY,EAAE,YAAY,EAAE,OAAO,CAAC,EAAE,aAAa,GAAG,IAAI;IAKjE;;;OAGG;IACH,YAAY,CAAC,GAAG,QAAQ,EAAE,MAAM,EAAE,GAAG,IAAI;IAKzC;;OAEG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,YAAY,GAAG,IAAI;IAKhD,yFAAyF;IACzF,OAAO,CAAC,GAAG,QAAQ,EAAE,MAAM,EAAE,GAAG,IAAI;IAKpC;;;OAGG;IACH,SAAS,CAAC,MAAM,EAAE,OAAO,CAAC,mBAAmB,CAAC,GAAG,IAAI;IAKrD,QAAQ,CAAC,EAAE,EAAE,QAAQ,GAAG,IAAI;IAI5B,YAAY,CAAC,EAAE,EAAE,YAAY,GAAG,IAAI;IAIpC,cAAc,CAAC,KAAK,EAAE,OAAO,GAAG,IAAI;IAIpC,qBAAqB,CAAC,KAAK,EAAE,OAAO,GAAG,IAAI;IAI3C,UAAU,CAAC,KAAK,EAAE,OAAO,GAAG,IAAI;IAIhC,MAAM,CAAC,KAAK,UAAO,GAAG,IAAI;IAI1B,eAAe,CAAC,OAAO,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,IAAI,GAAG,IAAI;IAIzD,KAAK,IAAI,mBAAmB;IAI5B,gEAAgE;IAChE,aAAa,IAAI,aAAa;IAM9B,oEAAoE;IACpE,iBAAiB,IAAI,aAAa;IAKlC,OAAO,CAAC,WAAW;IAKnB,OAAO,CAAC,GAAG;CAIZ"}

package/dist/api/fieldRedactorConfigBuilder.js

@@ -0,0 +1,115 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FieldRedactorConfigBuilder = void 0;
+const redactionRules_1 = require("../config/redactionRules");
+/**
+ * Fluent builder for {@link FieldRedactorConfig} using doc labels (Shallow, Deep, Opaque, Remove, Schema).
+ */
+class FieldRedactorConfigBuilder {
+    constructor() {
+        this.config = {};
+        this.schemas = [];
+    }
+    static create() {
+        return new FieldRedactorConfigBuilder();
+    }
+    /** Shallow — redact matching keys' scalar values (`secretKeys`). */
+    shallow(...patterns) {
+        return this.appendRegex('secretKeys', patterns);
+    }
+    /** Deep — redact matching keys and descendants (`deepSecretKeys`). */
+    deep(...patterns) {
+        return this.appendRegex('deepSecretKeys', patterns);
+    }
+    /** Opaque — stringify entire values at matching keys (`fullSecretKeys`). */
+    opaque(...patterns) {
+        return this.appendRegex('fullSecretKeys', patterns);
+    }
+    /** Remove — delete matching keys from output (`deleteSecretKeys`). */
+    remove(...patterns) {
+        return this.appendRegex('deleteSecretKeys', patterns);
+    }
+    /** Alias for {@link FieldRedactorConfigBuilder.remove}. */
+    delete(...patterns) {
+        return this.remove(...patterns);
+    }
+    /** Register an object schema (`customObjects`). */
+    schema(customObject, options) {
+        this.schemas.push({ object: customObject, name: options === null || options === void 0 ? void 0 : options.name });
+        return this;
+    }
+    /**
+     * Value-pattern — redact scalar fields whose string form matches a pattern, regardless of key name (`valuePatterns`).
+     * Lowest precedence; opt-in defense in depth beyond key-name rules.
+     */
+    valuePattern(...patterns) {
+        (0, redactionRules_1.appendRegExpArray)(this.config, 'valuePatterns', patterns);
+        return this;
+    }
+    /**
+     * Path rule — apply a redaction mode at a JSON path (`metadata.*.value`, `accountInfo.id`).
+     */
+    pathRule(path, mode) {
+        var _a;
+        this.config.pathRules = [...((_a = this.config.pathRules) !== null && _a !== void 0 ? _a : []), { path, mode }];
+        return this;
+    }
+    /** Allowlist — matching key names are never redacted under deep parents (`passKeys`). */
+    passKey(...patterns) {
+        (0, redactionRules_1.appendRegExpArray)(this.config, 'passKeys', patterns);
+        return this;
+    }
+    /**
+     * Merge a {@link presets} return value (or any partial config) into the builder.
+     * Regex arrays and schemas accumulate; scalar options apply only when not already set.
+     */
+    usePreset(preset) {
+        (0, redactionRules_1.mergePartialConfig)(this.config, this.schemas, preset);
+        return this;
+    }
+    redactor(fn) {
+        return this.set('redactor', fn);
+    }
+    syncRedactor(fn) {
+        return this.set('syncRedactor', fn);
+    }
+    ignoreBooleans(value) {
+        return this.set('ignoreBooleans', value);
+    }
+    ignoreNullOrUndefined(value) {
+        return this.set('ignoreNullOrUndefined', value);
+    }
+    cloneInput(value) {
+        return this.set('cloneInput', value);
+    }
+    strict(value = true) {
+        return this.set('strict', value);
+    }
+    onConfigWarning(handler) {
+        return this.set('onConfigWarning', handler);
+    }
+    build() {
+        return Object.assign(Object.assign({}, this.config), (0, redactionRules_1.finalizeRegisteredSchemas)(this.schemas));
+    }
+    /** Constructs a {@link FieldRedactor} from the built config. */
+    buildRedactor() {
+        // Lazy require avoids a module cycle: builder → FieldRedactor → deps → …
+        const { FieldRedactor: Redactor } = require('./fieldRedactor');
+        return new Redactor(this.build());
+    }
+    /** Like {@link FieldRedactor.createSafe} using the built config. */
+    buildSafeRedactor() {
+        const { FieldRedactor: Redactor } = require('./fieldRedactor');
+        return Redactor.createSafe(this.build());
+    }
+    appendRegex(field, patterns) {
+        (0, redactionRules_1.appendRegExpArray)(this.config, field, patterns);
+        return this;
+    }
+    set(key, value) {
+        this.config[key] = value;
+        return this;
+    }
+}
+exports.FieldRedactorConfigBuilder = FieldRedactorConfigBuilder;
+//# sourceMappingURL=fieldRedactorConfigBuilder.js.map

package/dist/api/fieldRedactorConfigBuilder.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"fieldRedactorConfigBuilder.js","sourceRoot":"","sources":["../../src/api/fieldRedactorConfigBuilder.ts"],"names":[],"mappings":";;;AACA,6DAMkC;AAQlC;;GAEG;AACH,MAAa,0BAA0B;IAAvC;QACU,WAAM,GAAwB,EAAE,CAAC;QACjC,YAAO,GAAuB,EAAE,CAAC;IA2H3C,CAAC;IAzHC,MAAM,CAAC,MAAM;QACX,OAAO,IAAI,0BAA0B,EAAE,CAAC;IAC1C,CAAC;IAED,oEAAoE;IACpE,OAAO,CAAC,GAAG,QAAkB;QAC3B,OAAO,IAAI,CAAC,WAAW,CAAC,YAAY,EAAE,QAAQ,CAAC,CAAC;IAClD,CAAC;IAED,sEAAsE;IACtE,IAAI,CAAC,GAAG,QAAkB;QACxB,OAAO,IAAI,CAAC,WAAW,CAAC,gBAAgB,EAAE,QAAQ,CAAC,CAAC;IACtD,CAAC;IAED,4EAA4E;IAC5E,MAAM,CAAC,GAAG,QAAkB;QAC1B,OAAO,IAAI,CAAC,WAAW,CAAC,gBAAgB,EAAE,QAAQ,CAAC,CAAC;IACtD,CAAC;IAED,sEAAsE;IACtE,MAAM,CAAC,GAAG,QAAkB;QAC1B,OAAO,IAAI,CAAC,WAAW,CAAC,kBAAkB,EAAE,QAAQ,CAAC,CAAC;IACxD,CAAC;IAED,2DAA2D;IAC3D,MAAM,CAAC,GAAG,QAAkB;QAC1B,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG,QAAQ,CAAC,CAAC;IAClC,CAAC;IAED,mDAAmD;IACnD,MAAM,CAAC,YAA0B,EAAE,OAAuB;QACxD,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,YAAY,EAAE,IAAI,EAAE,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,IAAI,EAAE,CAAC,CAAC;QACjE,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;OAGG;IACH,YAAY,CAAC,GAAG,QAAkB;QAChC,IAAA,kCAAiB,EAAC,IAAI,CAAC,MAAM,EAAE,eAAe,EAAE,QAAQ,CAAC,CAAC;QAC1D,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;OAEG;IACH,QAAQ,CAAC,IAAY,EAAE,IAAkB;;QACvC,IAAI,CAAC,MAAM,CAAC,SAAS,GAAG,CAAC,GAAG,CAAC,MAAA,IAAI,CAAC,MAAM,CAAC,SAAS,mCAAI,EAAE,CAAC,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC;QAC3E,OAAO,IAAI,CAAC;IACd,CAAC;IAED,yFAAyF;IACzF,OAAO,CAAC,GAAG,QAAkB;QAC3B,IAAA,kCAAiB,EAAC,IAAI,CAAC,MAAM,EAAE,UAAU,EAAE,QAAQ,CAAC,CAAC;QACrD,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;OAGG;IACH,SAAS,CAAC,MAAoC;QAC5C,IAAA,mCAAkB,EAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;QACtD,OAAO,IAAI,CAAC;IACd,CAAC;IAED,QAAQ,CAAC,EAAY;QACnB,OAAO,IAAI,CAAC,GAAG,CAAC,UAAU,EAAE,EAAE,CAAC,CAAC;IAClC,CAAC;IAED,YAAY,CAAC,EAAgB;QAC3B,OAAO,IAAI,CAAC,GAAG,CAAC,cAAc,EAAE,EAAE,CAAC,CAAC;IACtC,CAAC;IAED,cAAc,CAAC,KAAc;QAC3B,OAAO,IAAI,CAAC,GAAG,CAAC,gBAAgB,EAAE,KAAK,CAAC,CAAC;IAC3C,CAAC;IAED,qBAAqB,CAAC,KAAc;QAClC,OAAO,IAAI,CAAC,GAAG,CAAC,uBAAuB,EAAE,KAAK,CAAC,CAAC;IAClD,CAAC;IAED,UAAU,CAAC,KAAc;QACvB,OAAO,IAAI,CAAC,GAAG,CAAC,YAAY,EAAE,KAAK,CAAC,CAAC;IACvC,CAAC;IAED,MAAM,CAAC,KAAK,GAAG,IAAI;QACjB,OAAO,IAAI,CAAC,GAAG,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC;IACnC,CAAC;IAED,eAAe,CAAC,OAAkC;QAChD,OAAO,IAAI,CAAC,GAAG,CAAC,iBAAiB,EAAE,OAAO,CAAC,CAAC;IAC9C,CAAC;IAED,KAAK;QACH,uCAAY,IAAI,CAAC,MAAM,GAAK,IAAA,0CAAyB,EAAC,IAAI,CAAC,OAAO,CAAC,EAAG;IACxE,CAAC;IAED,gEAAgE;IAChE,aAAa;QACX,yEAAyE;QACzE,MAAM,EAAE,aAAa,EAAE,QAAQ,EAAE,GAAG,OAAO,CAAC,iBAAiB,CAAqC,CAAC;QACnG,OAAO,IAAI,QAAQ,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC,CAAC;IACpC,CAAC;IAED,oEAAoE;IACpE,iBAAiB;QACf,MAAM,EAAE,aAAa,EAAE,QAAQ,EAAE,GAAG,OAAO,CAAC,iBAAiB,CAAqC,CAAC;QACnG,OAAO,QAAQ,CAAC,UAAU,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC,CAAC;IAC3C,CAAC;IAEO,WAAW,CAAC,KAAuB,EAAE,QAAkB;QAC7D,IAAA,kCAAiB,EAAC,IAAI,CAAC,MAAM,EAAE,KAAK,EAAE,QAAQ,CAAC,CAAC;QAChD,OAAO,IAAI,CAAC;IACd,CAAC;IAEO,GAAG,CAAsC,GAAM,EAAE,KAA6B;QACpF,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;QACzB,OAAO,IAAI,CAAC;IACd,CAAC;CACF;AA7HD,gEA6HC"}

package/dist/api/fieldRedactorDeps.d.ts

@@ -0,0 +1,19 @@
+import { CustomObjectManager } from '../rules/customObjectManager';
+import { ObjectRedactor } from '../engine/objectRedactor';
+import { PrimitiveRedactor } from '../engine/primitiveRedactor';
+import { SecretManager } from '../rules/secretManager';
+import { FieldRedactorConfig } from '../types';
+import { PathRuleMatcher } from '../rules/pathRuleMatcher';
+import { ValuePatternMatcher } from '../rules/valuePatternMatcher';
+export type FieldRedactorDeps = {
+    primitiveRedactor: PrimitiveRedactor;
+    secretManager: SecretManager;
+    valuePatternMatcher: ValuePatternMatcher;
+    pathRuleMatcher: PathRuleMatcher;
+    customObjectManager: CustomObjectManager;
+    objectRedactor: ObjectRedactor;
+    usesAsyncRedactor: boolean;
+    cloneInput: boolean;
+};
+export declare const buildFieldRedactorDeps: (config?: FieldRedactorConfig) => FieldRedactorDeps;
+//# sourceMappingURL=fieldRedactorDeps.d.ts.map

package/dist/api/fieldRedactorDeps.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"fieldRedactorDeps.d.ts","sourceRoot":"","sources":["../../src/api/fieldRedactorDeps.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,mBAAmB,EAAE,MAAM,8BAA8B,CAAC;AACnE,OAAO,EAAE,cAAc,EAAE,MAAM,0BAA0B,CAAC;AAC1D,OAAO,EAAE,iBAAiB,EAAE,MAAM,6BAA6B,CAAC;AAEhE,OAAO,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AACvD,OAAO,EAAE,mBAAmB,EAAE,MAAM,UAAU,CAAC;AAC/C,OAAO,EAA2B,eAAe,EAAE,MAAM,0BAA0B,CAAC;AACpF,OAAO,EAA+B,mBAAmB,EAAE,MAAM,8BAA8B,CAAC;AAEhG,MAAM,MAAM,iBAAiB,GAAG;IAC9B,iBAAiB,EAAE,iBAAiB,CAAC;IACrC,aAAa,EAAE,aAAa,CAAC;IAC7B,mBAAmB,EAAE,mBAAmB,CAAC;IACzC,eAAe,EAAE,eAAe,CAAC;IACjC,mBAAmB,EAAE,mBAAmB,CAAC;IACzC,cAAc,EAAE,cAAc,CAAC;IAC/B,iBAAiB,EAAE,OAAO,CAAC;IAC3B,UAAU,EAAE,OAAO,CAAC;CACrB,CAAC;AAKF,eAAO,MAAM,sBAAsB,YAAa,mBAAmB,KAAG,iBAiDrE,CAAC"}

package/dist/api/fieldRedactorDeps.js

@@ -0,0 +1,45 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.buildFieldRedactorDeps = void 0;
+const customObjectManager_1 = require("../rules/customObjectManager");
+const objectRedactor_1 = require("../engine/objectRedactor");
+const primitiveRedactor_1 = require("../engine/primitiveRedactor");
+const redactionRules_1 = require("../config/redactionRules");
+const secretManager_1 = require("../rules/secretManager");
+const pathRuleMatcher_1 = require("../rules/pathRuleMatcher");
+const valuePatternMatcher_1 = require("../rules/valuePatternMatcher");
+const resolveBoolean = (value, defaultValue) => typeof value === 'boolean' ? value : defaultValue;
+const buildFieldRedactorDeps = (config) => {
+    var _a;
+    const normalized = (_a = (0, redactionRules_1.normalizeFieldRedactorConfig)(config)) !== null && _a !== void 0 ? _a : {};
+    const { redactor, syncRedactor, deepSecretKeys, fullSecretKeys, deleteSecretKeys, customObjects, valuePatterns, pathRules, passKeys } = normalized;
+    const primitiveRedactor = new primitiveRedactor_1.PrimitiveRedactor({
+        ignoreBooleans: resolveBoolean(normalized.ignoreBooleans, false),
+        ignoreNullOrUndefined: resolveBoolean(normalized.ignoreNullOrUndefined, true),
+        redactor,
+        syncRedactor
+    });
+    const secretManager = new secretManager_1.SecretManager({
+        secretKeys: (0, redactionRules_1.resolveSecretKeys)(normalized),
+        deepSecretKeys,
+        fullSecretKeys,
+        deleteSecretKeys,
+        passKeys
+    });
+    const valuePatternMatcher = (valuePatterns === null || valuePatterns === void 0 ? void 0 : valuePatterns.length) ? new valuePatternMatcher_1.ValuePatternMatcher(valuePatterns) : valuePatternMatcher_1.EMPTY_VALUE_PATTERN_MATCHER;
+    const pathRuleMatcher = (pathRules === null || pathRules === void 0 ? void 0 : pathRules.length) ? new pathRuleMatcher_1.PathRuleMatcher(pathRules) : pathRuleMatcher_1.EMPTY_PATH_RULE_MATCHER;
+    const customObjectManager = new customObjectManager_1.CustomObjectManager(customObjects, normalized.schemaNames);
+    const objectRedactor = new objectRedactor_1.ObjectRedactor(primitiveRedactor, secretManager, customObjectManager, valuePatternMatcher, pathRuleMatcher);
+    return {
+        primitiveRedactor,
+        secretManager,
+        valuePatternMatcher,
+        pathRuleMatcher,
+        customObjectManager,
+        objectRedactor,
+        usesAsyncRedactor: primitiveRedactor.usesAsyncRedactor(),
+        cloneInput: normalized.cloneInput !== false
+    };
+};
+exports.buildFieldRedactorDeps = buildFieldRedactorDeps;
+//# sourceMappingURL=fieldRedactorDeps.js.map

package/dist/api/fieldRedactorDeps.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"fieldRedactorDeps.js","sourceRoot":"","sources":["../../src/api/fieldRedactorDeps.ts"],"names":[],"mappings":";;;AAAA,sEAAmE;AACnE,6DAA0D;AAC1D,mEAAgE;AAChE,6DAA2F;AAC3F,0DAAuD;AAEvD,8DAAoF;AACpF,sEAAgG;AAahG,MAAM,cAAc,GAAG,CAAC,KAA0B,EAAE,YAAqB,EAAW,EAAE,CACpF,OAAO,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,YAAY,CAAC;AAE7C,MAAM,sBAAsB,GAAG,CAAC,MAA4B,EAAqB,EAAE;;IACxF,MAAM,UAAU,GAAG,MAAA,IAAA,6CAA4B,EAAC,MAAM,CAAC,mCAAI,EAAE,CAAC;IAC9D,MAAM,EACJ,QAAQ,EACR,YAAY,EACZ,cAAc,EACd,cAAc,EACd,gBAAgB,EAChB,aAAa,EACb,aAAa,EACb,SAAS,EACT,QAAQ,EACT,GAAG,UAAU,CAAC;IAEf,MAAM,iBAAiB,GAAG,IAAI,qCAAiB,CAAC;QAC9C,cAAc,EAAE,cAAc,CAAC,UAAU,CAAC,cAAc,EAAE,KAAK,CAAC;QAChE,qBAAqB,EAAE,cAAc,CAAC,UAAU,CAAC,qBAAqB,EAAE,IAAI,CAAC;QAC7E,QAAQ;QACR,YAAY;KACb,CAAC,CAAC;IAEH,MAAM,aAAa,GAAG,IAAI,6BAAa,CAAC;QACtC,UAAU,EAAE,IAAA,kCAAiB,EAAC,UAAU,CAAC;QACzC,cAAc;QACd,cAAc;QACd,gBAAgB;QAChB,QAAQ;KACT,CAAC,CAAC;IACH,MAAM,mBAAmB,GAAG,CAAA,aAAa,aAAb,aAAa,uBAAb,aAAa,CAAE,MAAM,EAAC,CAAC,CAAC,IAAI,yCAAmB,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,iDAA2B,CAAC;IACzH,MAAM,eAAe,GAAG,CAAA,SAAS,aAAT,SAAS,uBAAT,SAAS,CAAE,MAAM,EAAC,CAAC,CAAC,IAAI,iCAAe,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,yCAAuB,CAAC;IACrG,MAAM,mBAAmB,GAAG,IAAI,yCAAmB,CAAC,aAAa,EAAE,UAAU,CAAC,WAAW,CAAC,CAAC;IAC3F,MAAM,cAAc,GAAG,IAAI,+BAAc,CACvC,iBAAiB,EACjB,aAAa,EACb,mBAAmB,EACnB,mBAAmB,EACnB,eAAe,CAChB,CAAC;IAEF,OAAO;QACL,iBAAiB;QACjB,aAAa;QACb,mBAAmB;QACnB,eAAe;QACf,mBAAmB;QACnB,cAAc;QACd,iBAAiB,EAAE,iBAAiB,CAAC,iBAAiB,EAAE;QACxD,UAAU,EAAE,UAAU,CAAC,UAAU,KAAK,KAAK;KAC5C,CAAC;AACJ,CAAC,CAAC;AAjDW,QAAA,sBAAsB,0BAiDjC"}

package/dist/arrayRedaction.d.ts

@@ -0,0 +1,12 @@
+import { JsonArray, JsonObject } from './types';
+import { ContainerMutation } from './objectRedactorMutation';
+import { MaybeAsync } from './maybeAsync';
+import { TraversalServices } from './traversalServices';
+export declare class ArrayRedactor {
+    private readonly services;
+    constructor(services: TraversalServices);
+    redactArrayInObject(array: JsonArray, key: string, forceDeepRedaction: boolean, parent: ContainerMutation<JsonObject | JsonArray>, pathSegments: Array<string | number>): MaybeAsync<void>;
+    redactObjectsInArray(array: JsonArray, copyOnWrite: boolean, pathSegments: Array<string | number>): MaybeAsync<JsonArray>;
+    redactAllArrayValues(array: JsonArray, forceDeepRedaction: boolean, copyOnWrite: boolean, pathSegments: Array<string | number>): MaybeAsync<JsonArray>;
+}
+//# sourceMappingURL=arrayRedaction.d.ts.map

package/dist/arrayRedaction.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"arrayRedaction.d.ts","sourceRoot":"","sources":["../src/arrayRedaction.ts"],"names":[],"mappings":"AAAA,OAAO,EAAgB,SAAS,EAAE,UAAU,EAAE,MAAM,SAAS,CAAC;AAC9D,OAAO,EAAE,iBAAiB,EAA2B,MAAM,0BAA0B,CAAC;AACtF,OAAO,EAAsB,UAAU,EAAiB,MAAM,cAAc,CAAC;AAE7E,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAExD,qBAAa,aAAa;IACZ,OAAO,CAAC,QAAQ,CAAC,QAAQ;gBAAR,QAAQ,EAAE,iBAAiB;IAExD,mBAAmB,CACjB,KAAK,EAAE,SAAS,EAChB,GAAG,EAAE,MAAM,EACX,kBAAkB,EAAE,OAAO,EAC3B,MAAM,EAAE,iBAAiB,CAAC,UAAU,GAAG,SAAS,CAAC,EACjD,YAAY,EAAE,KAAK,CAAC,MAAM,GAAG,MAAM,CAAC,GACnC,UAAU,CAAC,IAAI,CAAC;IAmBnB,oBAAoB,CAClB,KAAK,EAAE,SAAS,EAChB,WAAW,EAAE,OAAO,EACpB,YAAY,EAAE,KAAK,CAAC,MAAM,GAAG,MAAM,CAAC,GACnC,UAAU,CAAC,SAAS,CAAC;IA6BxB,oBAAoB,CAClB,KAAK,EAAE,SAAS,EAChB,kBAAkB,EAAE,OAAO,EAC3B,WAAW,EAAE,OAAO,EACpB,YAAY,EAAE,KAAK,CAAC,MAAM,GAAG,MAAM,CAAC,GACnC,UAAU,CAAC,SAAS,CAAC;CA0CzB"}