field-redactor 1.2.0 → 1.6.0

package/dist/fieldRedactor.js

@@ -13,69 +13,150 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.FieldRedactor = void 0;
-const rfdc_1 = __importDefault(require("rfdc"));
-const objectRedactor_1 = require("./objectRedactor");
-const primitiveRedactor_1 = require("./primitiveRedactor");
-const secretManager_1 = require("./secretManager");
-const customObjectManager_1 = require("./customObjectManager");
 const errors_1 = require("./errors");
+const fieldRedactorDeps_1 = require("./fieldRedactorDeps");
+const dryRun_1 = require("./dryRun");
+const rfdc_1 = __importDefault(require("rfdc"));
+const configValidator_1 = require("./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 });
-        const { redactor, secretKeys, deepSecretKeys, fullSecretKeys, deleteSecretKeys, customObjects } = config || {};
-        const ignoreNullOrUndefined = typeof (config === null || config === void 0 ? void 0 : config.ignoreNullOrUndefined) === 'boolean' ? config.ignoreNullOrUndefined : true;
-        const ignoreBooleans = typeof (config === null || config === void 0 ? void 0 : config.ignoreBooleans) === 'boolean' ? config.ignoreBooleans : true;
-        const primitiveRedactor = new primitiveRedactor_1.PrimitiveRedactor({
-            ignoreBooleans,
-            ignoreNullOrUndefined,
-            redactor
-        });
-        const secretManager = new secretManager_1.SecretManager({
-            secretKeys,
-            deepSecretKeys,
-            fullSecretKeys,
-            deleteSecretKeys
+        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, or valuePatterns entry. Without explicit rules, new FieldRedactor() redacts all values by default.');
+        }
+        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));
         });
-        const customObjectChecker = new customObjectManager_1.CustomObjectManager(customObjects);
-        this.objectRedactor = new objectRedactor_1.ObjectRedactor(primitiveRedactor, secretManager, customObjectChecker);
+    }
+    /** 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.
-     * @param value The JSON value to redact. If primitive it will be resolved as-is.
-     * @returns The redacted JSON object.
      */
     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);
-            return this.redactInPlace(copy);
+            yield this.redactInPlace(copy);
+            return copy;
         });
     }
     /**
-     * Conditionally redacts fields in the JSON object in place based on the configuration provided in the constructor.
-     * If the value is a primitive, undefined, or date, returns the value as-is.
-     * @param value The JSON value to redact in place. If primitive it will be resolved as-is.
-     * @returns The redacted JSON object.
+     * 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.isPrimitiveOrUndefined(value)) {
-                return value;
-            }
-            try {
-                return this.objectRedactor.redactInPlace(value);
-            }
-            catch (e) {
-                throw new errors_1.FieldRedactorError(e.message);
+            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;
     }

package/dist/fieldRedactor.js.map

@@ -1 +1 @@
-{"version":3,"file":"fieldRedactor.js","sourceRoot":"","sources":["../src/fieldRedactor.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,gDAAwB;AAExB,qDAAkD;AAClD,2DAAwD;AACxD,mDAAgD;AAChD,+DAA4D;AAC5D,qCAA8C;AAE9C;;;;GAIG;AACH,MAAa,aAAa;IAGxB,YAAY,MAA4B;QAFhC,aAAQ,GAAG,IAAA,cAAI,EAAC,EAAE,KAAK,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC;QAGtD,MAAM,EAAE,QAAQ,EAAE,UAAU,EAAE,cAAc,EAAE,cAAc,EAAE,gBAAgB,EAAE,aAAa,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;QAE/G,MAAM,qBAAqB,GACzB,OAAO,CAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,qBAAqB,CAAA,KAAK,SAAS,CAAC,CAAC,CAAC,MAAM,CAAC,qBAAqB,CAAC,CAAC,CAAC,IAAI,CAAC;QAC3F,MAAM,cAAc,GAAG,OAAO,CAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,cAAc,CAAA,KAAK,SAAS,CAAC,CAAC,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC,CAAC,IAAI,CAAC;QAElG,MAAM,iBAAiB,GAAG,IAAI,qCAAiB,CAAC;YAC9C,cAAc;YACd,qBAAqB;YACrB,QAAQ;SACT,CAAC,CAAC;QAEH,MAAM,aAAa,GAAG,IAAI,6BAAa,CAAC;YACtC,UAAU;YACV,cAAc;YACd,cAAc;YACd,gBAAgB;SACjB,CAAC,CAAC;QAEH,MAAM,mBAAmB,GAAG,IAAI,yCAAmB,CAAC,aAAa,CAAC,CAAC;QAEnE,IAAI,CAAC,cAAc,GAAG,IAAI,+BAAc,CAAC,iBAAiB,EAAE,aAAa,EAAE,mBAAmB,CAAC,CAAC;IAClG,CAAC;IAED;;;;;;OAMG;IACU,MAAM,CAAC,KAAU;;YAC5B,MAAM,IAAI,GAAG,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;YAClC,OAAO,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;QAClC,CAAC;KAAA;IAED;;;;;OAKG;IACU,aAAa,CAAC,KAAU;;YACnC,IAAI,IAAI,CAAC,sBAAsB,CAAC,KAAK,CAAC,EAAE,CAAC;gBACvC,OAAO,KAAK,CAAC;YACf,CAAC;YAED,IAAI,CAAC;gBACH,OAAO,IAAI,CAAC,cAAc,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;YAClD,CAAC;YAAC,OAAO,CAAM,EAAE,CAAC;gBAChB,MAAM,IAAI,2BAAkB,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC;YAC1C,CAAC;QACH,CAAC;KAAA;IAEO,sBAAsB,CAAC,KAAU;QACvC,OAAO,CAAC,KAAK,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,YAAY,IAAI,CAAC;IACtE,CAAC;CACF;AA7DD,sCA6DC"}
+{"version":3,"file":"fieldRedactor.js","sourceRoot":"","sources":["../src/fieldRedactor.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,qCAA+E;AAC/E,2DAAgF;AAUhF,qCAAmE;AACnE,gDAAwB;AACxB,uDAA2F;AAE3F;;;;;;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,4OAA4O,CAC7O,CAAC;QACJ,CAAC;QAED,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;AA7KD,sCA6KC"}

package/dist/fieldRedactorConfigBuilder.d.ts

@@ -0,0 +1,55 @@
+import { 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;
+    buildRedactor(): FieldRedactor;
+    buildSafeRedactor(): FieldRedactor;
+    private appendRegex;
+    private set;
+}
+//# sourceMappingURL=fieldRedactorConfigBuilder.d.ts.map

package/dist/fieldRedactorConfigBuilder.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"fieldRedactorConfigBuilder.d.ts","sourceRoot":"","sources":["../src/fieldRedactorConfigBuilder.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAQhD,OAAO,EAAE,YAAY,EAAE,mBAAmB,EAAE,YAAY,EAAE,QAAQ,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AAElG,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,aAAa,IAAI,aAAa;IAI9B,iBAAiB,IAAI,aAAa;IAIlC,OAAO,CAAC,WAAW;IAKnB,OAAO,CAAC,GAAG;CAIZ"}

package/dist/fieldRedactorConfigBuilder.js

@@ -0,0 +1,111 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FieldRedactorConfigBuilder = void 0;
+const fieldRedactor_1 = require("./fieldRedactor");
+const redactionRules_1 = require("./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));
+    }
+    buildRedactor() {
+        return new fieldRedactor_1.FieldRedactor(this.build());
+    }
+    buildSafeRedactor() {
+        return fieldRedactor_1.FieldRedactor.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/fieldRedactorConfigBuilder.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"fieldRedactorConfigBuilder.js","sourceRoot":"","sources":["../src/fieldRedactorConfigBuilder.ts"],"names":[],"mappings":";;;AAAA,mDAAgD;AAChD,qDAM0B;AAQ1B;;GAEG;AACH,MAAa,0BAA0B;IAAvC;QACU,WAAM,GAAwB,EAAE,CAAC;QACjC,YAAO,GAAuB,EAAE,CAAC;IAsH3C,CAAC;IApHC,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,aAAa;QACX,OAAO,IAAI,6BAAa,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC,CAAC;IACzC,CAAC;IAED,iBAAiB;QACf,OAAO,6BAAa,CAAC,UAAU,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC,CAAC;IAChD,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;AAxHD,gEAwHC"}

package/dist/fieldRedactorDeps.d.ts

@@ -0,0 +1,19 @@
+import { CustomObjectManager } from './customObjectManager';
+import { ObjectRedactor } from './objectRedactor';
+import { PrimitiveRedactor } from './primitiveRedactor';
+import { SecretManager } from './secretManager';
+import { FieldRedactorConfig } from './types';
+import { PathRuleMatcher } from './pathRuleMatcher';
+import { ValuePatternMatcher } from './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/fieldRedactorDeps.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"fieldRedactorDeps.d.ts","sourceRoot":"","sources":["../src/fieldRedactorDeps.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAC5D,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAClD,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAExD,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAChD,OAAO,EAAE,mBAAmB,EAAE,MAAM,SAAS,CAAC;AAC9C,OAAO,EAA2B,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAC7E,OAAO,EAA+B,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAEzF,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,iBAgDrE,CAAC"}

package/dist/fieldRedactorDeps.js

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

package/dist/fieldRedactorDeps.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"fieldRedactorDeps.js","sourceRoot":"","sources":["../src/fieldRedactorDeps.ts"],"names":[],"mappings":";;;AAAA,+DAA4D;AAC5D,qDAAkD;AAClD,2DAAwD;AACxD,qDAAqD;AACrD,mDAAgD;AAEhD,uDAA6E;AAC7E,+DAAyF;AAazF,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,EACJ,QAAQ,EACR,YAAY,EACZ,cAAc,EACd,cAAc,EACd,gBAAgB,EAChB,aAAa,EACb,aAAa,EACb,SAAS,EACT,QAAQ,EACT,GAAG,MAAM,aAAN,MAAM,cAAN,MAAM,GAAI,EAAE,CAAC;IAEjB,MAAM,iBAAiB,GAAG,IAAI,qCAAiB,CAAC;QAC9C,cAAc,EAAE,cAAc,CAAC,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,cAAc,EAAE,KAAK,CAAC;QAC7D,qBAAqB,EAAE,cAAc,CAAC,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,qBAAqB,EAAE,IAAI,CAAC;QAC1E,QAAQ;QACR,YAAY;KACb,CAAC,CAAC;IAEH,MAAM,aAAa,GAAG,IAAI,6BAAa,CAAC;QACtC,UAAU,EAAE,IAAA,kCAAiB,EAAC,MAAM,CAAC;QACrC,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,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,WAAW,CAAC,CAAC;IACxF,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,CAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,UAAU,MAAK,KAAK;KACzC,CAAC;AACJ,CAAC,CAAC;AAhDW,QAAA,sBAAsB,0BAgDjC"}

package/dist/index.d.ts

@@ -1,4 +1,10 @@
-import { FieldRedactor } from './fieldRedactor';
-export { CustomObjectMatchType, Redactor, FieldRedactorConfig, CustomObject } from './types';
+import { FieldRedactor } from './api/fieldRedactor';
+export { CustomObjectMatchType, Redactor, FieldRedactorConfig, CustomObject, DryRunReport, DryRunResult, DryRunPathRule, MatchedSchemaReport, PathRule, PathRuleMode, RedactionMode, RedactionRuleLabel, JsonArray, JsonFunction, JsonLeafValue, JsonObject, JsonPrimitive, JsonValue, RedactableInput, RedactablePrimitive, RedactedPrimitive, RedactorInput, SecretSpecifierValue, SyncRedactor, TraversableJson, isJsonObject } from './types';
+export { FieldRedactorError, FieldRedactorConfigurationError } from './errors';
+export { validateFieldRedactorConfig, hasExplicitRedactionRules } from './config/configValidator';
+export { EMPTY_DRY_RUN_REPORT } from './dryrun/dryRun';
+export { presets } from './config/presets';
+export { FieldRedactorConfigBuilder } from './api/fieldRedactorConfigBuilder';
+export type { SchemaOptions } from './api/fieldRedactorConfigBuilder';
 export { FieldRedactor };
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAChD,OAAO,EAAE,qBAAqB,EAAE,QAAQ,EAAE,mBAAmB,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AAC7F,OAAO,EAAE,aAAa,EAAE,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AACpD,OAAO,EACL,qBAAqB,EACrB,QAAQ,EACR,mBAAmB,EACnB,YAAY,EACZ,YAAY,EACZ,YAAY,EACZ,cAAc,EACd,mBAAmB,EACnB,QAAQ,EACR,YAAY,EACZ,aAAa,EACb,kBAAkB,EAClB,SAAS,EACT,YAAY,EACZ,aAAa,EACb,UAAU,EACV,aAAa,EACb,SAAS,EACT,eAAe,EACf,mBAAmB,EACnB,iBAAiB,EACjB,aAAa,EACb,oBAAoB,EACpB,YAAY,EACZ,eAAe,EACf,YAAY,EACb,MAAM,SAAS,CAAC;AACjB,OAAO,EAAE,kBAAkB,EAAE,+BAA+B,EAAE,MAAM,UAAU,CAAC;AAC/E,OAAO,EAAE,2BAA2B,EAAE,yBAAyB,EAAE,MAAM,0BAA0B,CAAC;AAClG,OAAO,EAAE,oBAAoB,EAAE,MAAM,iBAAiB,CAAC;AACvD,OAAO,EAAE,OAAO,EAAE,MAAM,kBAAkB,CAAC;AAC3C,OAAO,EAAE,0BAA0B,EAAE,MAAM,kCAAkC,CAAC;AAC9E,YAAY,EAAE,aAAa,EAAE,MAAM,kCAAkC,CAAC;AACtE,OAAO,EAAE,aAAa,EAAE,CAAC"}

package/dist/index.js

@@ -1,8 +1,21 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.FieldRedactor = exports.CustomObjectMatchType = void 0;
-const fieldRedactor_1 = require("./fieldRedactor");
+exports.FieldRedactor = exports.FieldRedactorConfigBuilder = exports.presets = exports.EMPTY_DRY_RUN_REPORT = exports.hasExplicitRedactionRules = exports.validateFieldRedactorConfig = exports.FieldRedactorConfigurationError = exports.FieldRedactorError = exports.isJsonObject = exports.CustomObjectMatchType = void 0;
+const fieldRedactor_1 = require("./api/fieldRedactor");
 Object.defineProperty(exports, "FieldRedactor", { enumerable: true, get: function () { return fieldRedactor_1.FieldRedactor; } });
 var types_1 = require("./types");
 Object.defineProperty(exports, "CustomObjectMatchType", { enumerable: true, get: function () { return types_1.CustomObjectMatchType; } });
+Object.defineProperty(exports, "isJsonObject", { enumerable: true, get: function () { return types_1.isJsonObject; } });
+var errors_1 = require("./errors");
+Object.defineProperty(exports, "FieldRedactorError", { enumerable: true, get: function () { return errors_1.FieldRedactorError; } });
+Object.defineProperty(exports, "FieldRedactorConfigurationError", { enumerable: true, get: function () { return errors_1.FieldRedactorConfigurationError; } });
+var configValidator_1 = require("./config/configValidator");
+Object.defineProperty(exports, "validateFieldRedactorConfig", { enumerable: true, get: function () { return configValidator_1.validateFieldRedactorConfig; } });
+Object.defineProperty(exports, "hasExplicitRedactionRules", { enumerable: true, get: function () { return configValidator_1.hasExplicitRedactionRules; } });
+var dryRun_1 = require("./dryrun/dryRun");
+Object.defineProperty(exports, "EMPTY_DRY_RUN_REPORT", { enumerable: true, get: function () { return dryRun_1.EMPTY_DRY_RUN_REPORT; } });
+var presets_1 = require("./config/presets");
+Object.defineProperty(exports, "presets", { enumerable: true, get: function () { return presets_1.presets; } });
+var fieldRedactorConfigBuilder_1 = require("./api/fieldRedactorConfigBuilder");
+Object.defineProperty(exports, "FieldRedactorConfigBuilder", { enumerable: true, get: function () { return fieldRedactorConfigBuilder_1.FieldRedactorConfigBuilder; } });
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAAA,mDAAgD;AAEvC,8FAFA,6BAAa,OAEA;AADtB,iCAA6F;AAApF,8GAAA,qBAAqB,OAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAAA,uDAAoD;AAmC3C,8FAnCA,6BAAa,OAmCA;AAlCtB,iCA2BiB;AA1Bf,8GAAA,qBAAqB,OAAA;AAyBrB,qGAAA,YAAY,OAAA;AAEd,mCAA+E;AAAtE,4GAAA,kBAAkB,OAAA;AAAE,yHAAA,+BAA+B,OAAA;AAC5D,4DAAkG;AAAzF,8HAAA,2BAA2B,OAAA;AAAE,4HAAA,yBAAyB,OAAA;AAC/D,0CAAuD;AAA9C,8GAAA,oBAAoB,OAAA;AAC7B,4CAA2C;AAAlC,kGAAA,OAAO,OAAA;AAChB,+EAA8E;AAArE,wIAAA,0BAA0B,OAAA"}

package/dist/jsonWalk.d.ts

@@ -0,0 +1,11 @@
+import { JsonArray, JsonObject, JsonValue } from './types';
+export { parseJsonPath } from './pathParsing';
+export declare const getJsonValueAtPath: (value: JsonValue | undefined, segments: Array<string | number>) => JsonValue | undefined;
+export declare const getParentContext: (value: JsonValue | undefined, segments: Array<string | number>) => {
+    parent: JsonObject | JsonArray | undefined;
+    leaf: string | number | undefined;
+};
+export declare const joinPath: (base: string, segment: string | number) => string;
+export declare const isTraversableJson: (value: JsonValue | undefined) => value is JsonObject | JsonValue[];
+export declare const walkTraversableJson: (value: JsonValue | undefined, path: string, visit: (value: JsonValue, path: string) => void) => void;
+//# sourceMappingURL=jsonWalk.d.ts.map

package/dist/jsonWalk.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"jsonWalk.d.ts","sourceRoot":"","sources":["../src/jsonWalk.ts"],"names":[],"mappings":"AAAA,OAAO,EAAgB,SAAS,EAAE,UAAU,EAAE,SAAS,EAAE,MAAM,SAAS,CAAC;AAEzE,OAAO,EAAE,aAAa,EAAE,MAAM,eAAe,CAAC;AAE9C,eAAO,MAAM,kBAAkB,UAAW,SAAS,GAAG,SAAS,YAAY,KAAK,CAAC,MAAM,GAAG,MAAM,CAAC,KAAG,SAAS,GAAG,SAsB/G,CAAC;AAEF,eAAO,MAAM,gBAAgB,UACpB,SAAS,GAAG,SAAS,YAClB,KAAK,CAAC,MAAM,GAAG,MAAM,CAAC,KAC/B;IAAE,MAAM,EAAE,UAAU,GAAG,SAAS,GAAG,SAAS,CAAC;IAAC,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAAA;CASjF,CAAC;AAEF,eAAO,MAAM,QAAQ,SAAU,MAAM,WAAW,MAAM,GAAG,MAAM,KAAG,MACqD,CAAC;AAExH,eAAO,MAAM,iBAAiB,UAAW,SAAS,GAAG,SAAS,KAAG,KAAK,IAAI,UAAU,GAAG,SAAS,EAC9B,CAAC;AAEnE,eAAO,MAAM,mBAAmB,UACvB,SAAS,GAAG,SAAS,QACtB,MAAM,SACL,CAAC,KAAK,EAAE,SAAS,EAAE,IAAI,EAAE,MAAM,KAAK,IAAI,KAC9C,IAgBF,CAAC"}

package/dist/jsonWalk.js

@@ -0,0 +1,55 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.walkTraversableJson = exports.isTraversableJson = exports.joinPath = exports.getParentContext = exports.getJsonValueAtPath = exports.parseJsonPath = void 0;
+const types_1 = require("./types");
+var pathParsing_1 = require("./pathParsing");
+Object.defineProperty(exports, "parseJsonPath", { enumerable: true, get: function () { return pathParsing_1.parseJsonPath; } });
+const getJsonValueAtPath = (value, segments) => {
+    let current = value;
+    for (const segment of segments) {
+        if (current === undefined || current === null || typeof current !== 'object') {
+            return undefined;
+        }
+        if (Array.isArray(current) && typeof segment === 'number') {
+            current = current[segment];
+            continue;
+        }
+        if ((0, types_1.isJsonObject)(current) && typeof segment === 'string') {
+            current = current[segment];
+            continue;
+        }
+        return undefined;
+    }
+    return current;
+};
+exports.getJsonValueAtPath = getJsonValueAtPath;
+const getParentContext = (value, segments) => {
+    if (segments.length === 0) {
+        return { parent: undefined, leaf: undefined };
+    }
+    const leaf = segments.at(-1);
+    const parent = segments.length === 1 ? value : (0, exports.getJsonValueAtPath)(value, segments.slice(0, -1));
+    return (0, exports.isTraversableJson)(parent) ? { parent, leaf } : { parent: undefined, leaf };
+};
+exports.getParentContext = getParentContext;
+const joinPath = (base, segment) => typeof segment === 'number' ? (base ? `${base}[${segment}]` : `[${segment}]`) : base ? `${base}.${segment}` : segment;
+exports.joinPath = joinPath;
+const isTraversableJson = (value) => !!value && typeof value === 'object' && !(value instanceof Date);
+exports.isTraversableJson = isTraversableJson;
+const walkTraversableJson = (value, path, visit) => {
+    if (!(0, exports.isTraversableJson)(value)) {
+        return;
+    }
+    if (Array.isArray(value)) {
+        value.forEach((item, index) => (0, exports.walkTraversableJson)(item, (0, exports.joinPath)(path, index), visit));
+        return;
+    }
+    if ((0, types_1.isJsonObject)(value)) {
+        visit(value, path);
+        for (const key of Object.keys(value)) {
+            (0, exports.walkTraversableJson)(value[key], (0, exports.joinPath)(path, key), visit);
+        }
+    }
+};
+exports.walkTraversableJson = walkTraversableJson;
+//# sourceMappingURL=jsonWalk.js.map

package/dist/jsonWalk.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"jsonWalk.js","sourceRoot":"","sources":["../src/jsonWalk.ts"],"names":[],"mappings":";;;AAAA,mCAAyE;AAEzE,6CAA8C;AAArC,4GAAA,aAAa,OAAA;AAEf,MAAM,kBAAkB,GAAG,CAAC,KAA4B,EAAE,QAAgC,EAAyB,EAAE;IAC1H,IAAI,OAAO,GAA0B,KAAK,CAAC;IAE3C,KAAK,MAAM,OAAO,IAAI,QAAQ,EAAE,CAAC;QAC/B,IAAI,OAAO,KAAK,SAAS,IAAI,OAAO,KAAK,IAAI,IAAI,OAAO,OAAO,KAAK,QAAQ,EAAE,CAAC;YAC7E,OAAO,SAAS,CAAC;QACnB,CAAC;QAED,IAAI,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,IAAI,OAAO,OAAO,KAAK,QAAQ,EAAE,CAAC;YAC1D,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;YAC3B,SAAS;QACX,CAAC;QAED,IAAI,IAAA,oBAAY,EAAC,OAAO,CAAC,IAAI,OAAO,OAAO,KAAK,QAAQ,EAAE,CAAC;YACzD,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;YAC3B,SAAS;QACX,CAAC;QAED,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,OAAO,OAAO,CAAC;AACjB,CAAC,CAAC;AAtBW,QAAA,kBAAkB,sBAsB7B;AAEK,MAAM,gBAAgB,GAAG,CAC9B,KAA4B,EAC5B,QAAgC,EACmD,EAAE;IACrF,IAAI,QAAQ,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC1B,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC;IAChD,CAAC;IAED,MAAM,IAAI,GAAG,QAAQ,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;IAC7B,MAAM,MAAM,GAAG,QAAQ,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAA,0BAAkB,EAAC,KAAK,EAAE,QAAQ,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;IAEhG,OAAO,IAAA,yBAAiB,EAAC,MAAM,CAAC,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC;AACpF,CAAC,CAAC;AAZW,QAAA,gBAAgB,oBAY3B;AAEK,MAAM,QAAQ,GAAG,CAAC,IAAY,EAAE,OAAwB,EAAU,EAAE,CACzE,OAAO,OAAO,KAAK,QAAQ,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,IAAI,IAAI,OAAO,GAAG,CAAC,CAAC,CAAC,IAAI,OAAO,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,IAAI,IAAI,OAAO,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC;AAD3G,QAAA,QAAQ,YACmG;AAEjH,MAAM,iBAAiB,GAAG,CAAC,KAA4B,EAAqC,EAAE,CACnG,CAAC,CAAC,KAAK,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,CAAC,CAAC,KAAK,YAAY,IAAI,CAAC,CAAC;AADtD,QAAA,iBAAiB,qBACqC;AAE5D,MAAM,mBAAmB,GAAG,CACjC,KAA4B,EAC5B,IAAY,EACZ,KAA+C,EACzC,EAAE;IACR,IAAI,CAAC,IAAA,yBAAiB,EAAC,KAAK,CAAC,EAAE,CAAC;QAC9B,OAAO;IACT,CAAC;IAED,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;QACzB,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC,IAAA,2BAAmB,EAAC,IAAI,EAAE,IAAA,gBAAQ,EAAC,IAAI,EAAE,KAAK,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC;QACxF,OAAO;IACT,CAAC;IAED,IAAI,IAAA,oBAAY,EAAC,KAAK,CAAC,EAAE,CAAC;QACxB,KAAK,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;QACnB,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;YACrC,IAAA,2BAAmB,EAAC,KAAK,CAAC,GAAG,CAAC,EAAE,IAAA,gBAAQ,EAAC,IAAI,EAAE,GAAG,CAAC,EAAE,KAAK,CAAC,CAAC;QAC9D,CAAC;IACH,CAAC;AACH,CAAC,CAAC;AApBW,QAAA,mBAAmB,uBAoB9B"}

package/dist/maybeAsync.d.ts

@@ -0,0 +1,7 @@
+export type MaybeAsync<T> = T | Promise<T>;
+export declare const awaitMaybe: <T>(value: MaybeAsync<T>) => Promise<T>;
+/** Normalizes sync results for async traversal without forcing Promises on the sync path. */
+export declare const resolveMaybeAsync: <T>(value: MaybeAsync<T>, asyncMode: boolean) => MaybeAsync<T>;
+export declare const runSequential: <T>(items: readonly T[], process: (item: T, index: number) => MaybeAsync<void>, asyncMode: boolean) => MaybeAsync<void>;
+export declare const finalizeMaybeAsync: <T>(work: MaybeAsync<void>, result: () => T, asyncMode: boolean) => MaybeAsync<T>;
+//# sourceMappingURL=maybeAsync.d.ts.map

package/dist/maybeAsync.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"maybeAsync.d.ts","sourceRoot":"","sources":["../src/maybeAsync.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,UAAU,CAAC,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;AAE3C,eAAO,MAAM,UAAU,GAAU,CAAC,SAAS,UAAU,CAAC,CAAC,CAAC,KAAG,OAAO,CAAC,CAAC,CAAU,CAAC;AAE/E,6FAA6F;AAC7F,eAAO,MAAM,iBAAiB,GAAI,CAAC,SAAS,UAAU,CAAC,CAAC,CAAC,aAAa,OAAO,KAAG,UAAU,CAAC,CAAC,CAU3F,CAAC;AAEF,eAAO,MAAM,aAAa,GAAI,CAAC,SACtB,SAAS,CAAC,EAAE,WACV,CAAC,IAAI,EAAE,CAAC,EAAE,KAAK,EAAE,MAAM,KAAK,UAAU,CAAC,IAAI,CAAC,aAC1C,OAAO,KACjB,UAAU,CAAC,IAAI,CAgBjB,CAAC;AAEF,eAAO,MAAM,kBAAkB,GAAI,CAAC,QAAQ,UAAU,CAAC,IAAI,CAAC,UAAU,MAAM,CAAC,aAAa,OAAO,KAAG,UAAU,CAAC,CAAC,CAa/G,CAAC"}