field-redactor 1.2.0 → 1.5.0

package/dist/configValidator.d.ts

@@ -0,0 +1,10 @@
+import { hasExplicitRedactionRules } from './redactionRules';
+import { CustomObject, FieldRedactorConfig } from './types';
+export { hasExplicitRedactionRules };
+export declare const assertNoIdenticalCustomObjectSchemas: (customObjects?: CustomObject[]) => void;
+/**
+ * Returns non-fatal configuration warnings. Throws {@link FieldRedactorConfigurationError} for
+ * invalid custom object duplicates and when `strict` is true on any warning.
+ */
+export declare const validateFieldRedactorConfig: (config?: FieldRedactorConfig) => string[];
+//# sourceMappingURL=configValidator.d.ts.map

package/dist/configValidator.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"configValidator.d.ts","sourceRoot":"","sources":["../src/configValidator.ts"],"names":[],"mappings":"AAEA,OAAO,EACL,yBAAyB,EAG1B,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EAAE,YAAY,EAAE,mBAAmB,EAAE,MAAM,SAAS,CAAC;AAE5D,OAAO,EAAE,yBAAyB,EAAE,CAAC;AAIrC,eAAO,MAAM,oCAAoC,mBAAoB,YAAY,EAAE,KAAG,IAgBrF,CAAC;AAoEF;;;GAGG;AACH,eAAO,MAAM,2BAA2B,YAAa,mBAAmB,KAAG,MAAM,EAiBhF,CAAC"}

package/dist/configValidator.js

@@ -0,0 +1,94 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.validateFieldRedactorConfig = exports.assertNoIdenticalCustomObjectSchemas = exports.hasExplicitRedactionRules = void 0;
+const errors_1 = require("./errors");
+const regexUtils_1 = require("./regexUtils");
+const redactionRules_1 = require("./redactionRules");
+Object.defineProperty(exports, "hasExplicitRedactionRules", { enumerable: true, get: function () { return redactionRules_1.hasExplicitRedactionRules; } });
+const KEY_RULE_FIELDS = new Set(redactionRules_1.SECRET_REGEX_FIELDS);
+const assertNoIdenticalCustomObjectSchemas = (customObjects) => {
+    if (!customObjects || customObjects.length <= 1) {
+        return;
+    }
+    for (let i = 0; i < customObjects.length - 1; i++) {
+        const keys = Object.keys(customObjects[i]);
+        for (let j = i + 1; j < customObjects.length; j++) {
+            const otherKeys = Object.keys(customObjects[j]);
+            if (keys.length === otherKeys.length && keys.every((key) => otherKeys.includes(key))) {
+                throw new errors_1.FieldRedactorConfigurationError(`Custom Objects at indexes ${i} and ${j} cannot have identical keys: ${keys}`);
+            }
+        }
+    }
+};
+exports.assertNoIdenticalCustomObjectSchemas = assertNoIdenticalCustomObjectSchemas;
+const collectRegexWarnings = (config) => {
+    const warnings = [];
+    const keyRuleDuplicates = new Map();
+    for (const field of redactionRules_1.REGEX_ARRAY_CONFIG_FIELDS) {
+        const regexes = config[field];
+        if (!regexes) {
+            continue;
+        }
+        for (const regex of regexes) {
+            if (regex.global) {
+                warnings.push(`Global regex ${(0, regexUtils_1.formatRegExp)(regex)} in \`${field}\` can produce surprising \`.test()\` results; remove the \`g\` flag.`);
+            }
+            if (!KEY_RULE_FIELDS.has(field)) {
+                continue;
+            }
+            const identity = (0, regexUtils_1.regexIdentity)(regex);
+            const prior = keyRuleDuplicates.get(identity);
+            if (prior && prior !== field) {
+                warnings.push(`${(0, regexUtils_1.formatRegExp)(regex)} appears in both \`${prior}\` and \`${field}\` — only the higher-precedence rule applies.`);
+            }
+            else if (!prior) {
+                keyRuleDuplicates.set(identity, field);
+            }
+        }
+    }
+    return warnings;
+};
+const collectSchemaWarnings = (customObjects) => {
+    const warnings = [];
+    customObjects.forEach((schema, schemaIndex) => {
+        for (const [field, rule] of Object.entries(schema)) {
+            if (typeof rule === 'string' && !Object.prototype.hasOwnProperty.call(schema, rule)) {
+                warnings.push(`Schema at index ${schemaIndex}: field \`${field}: '${rule}'\` references sibling key \`${rule}\` which is not defined in the schema.`);
+            }
+        }
+    });
+    for (let i = 0; i < customObjects.length - 1; i++) {
+        const keysA = Object.keys(customObjects[i]);
+        for (let j = i + 1; j < customObjects.length; j++) {
+            const keysB = Object.keys(customObjects[j]);
+            const aSubsetOfB = keysA.length < keysB.length && keysA.every((key) => keysB.includes(key));
+            const bSubsetOfA = keysB.length < keysA.length && keysB.every((key) => keysA.includes(key));
+            if (aSubsetOfB || bSubsetOfA) {
+                warnings.push(`Schemas at index ${i} and ${j} may both match the same object; index ${keysB.length > keysA.length ? j : i} wins only when it has more keys.`);
+            }
+        }
+    }
+    return warnings;
+};
+/**
+ * Returns non-fatal configuration warnings. Throws {@link FieldRedactorConfigurationError} for
+ * invalid custom object duplicates and when `strict` is true on any warning.
+ */
+const validateFieldRedactorConfig = (config) => {
+    var _a;
+    const resolved = config !== null && config !== void 0 ? config : {};
+    (0, exports.assertNoIdenticalCustomObjectSchemas)(resolved.customObjects);
+    const warnings = [
+        ...(!(0, redactionRules_1.hasExplicitRedactionRules)(resolved)
+            ? ['All values will be redacted. Did you mean to set `secretKeys` or use `FieldRedactor.createSafe()`?']
+            : []),
+        ...collectRegexWarnings(resolved),
+        ...collectSchemaWarnings((_a = resolved.customObjects) !== null && _a !== void 0 ? _a : [])
+    ];
+    if (resolved.strict && warnings[0]) {
+        throw new errors_1.FieldRedactorConfigurationError(warnings[0]);
+    }
+    return warnings;
+};
+exports.validateFieldRedactorConfig = validateFieldRedactorConfig;
+//# sourceMappingURL=configValidator.js.map

package/dist/configValidator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"configValidator.js","sourceRoot":"","sources":["../src/configValidator.ts"],"names":[],"mappings":";;;AAAA,qCAA2D;AAC3D,6CAA2D;AAC3D,qDAI0B;AAGjB,0GANP,0CAAyB,OAMO;AAElC,MAAM,eAAe,GAAG,IAAI,GAAG,CAAS,oCAAmB,CAAC,CAAC;AAEtD,MAAM,oCAAoC,GAAG,CAAC,aAA8B,EAAQ,EAAE;IAC3F,IAAI,CAAC,aAAa,IAAI,aAAa,CAAC,MAAM,IAAI,CAAC,EAAE,CAAC;QAChD,OAAO;IACT,CAAC;IAED,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,aAAa,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC;QAClD,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC;QAC3C,KAAK,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,aAAa,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;YAClD,MAAM,SAAS,GAAG,MAAM,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC;YAChD,IAAI,IAAI,CAAC,MAAM,KAAK,SAAS,CAAC,MAAM,IAAI,IAAI,CAAC,KAAK,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,SAAS,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC;gBACrF,MAAM,IAAI,wCAA+B,CACvC,6BAA6B,CAAC,QAAQ,CAAC,gCAAgC,IAAI,EAAE,CAC9E,CAAC;YACJ,CAAC;QACH,CAAC;IACH,CAAC;AACH,CAAC,CAAC;AAhBW,QAAA,oCAAoC,wCAgB/C;AAEF,MAAM,oBAAoB,GAAG,CAAC,MAA2B,EAAY,EAAE;IACrE,MAAM,QAAQ,GAAa,EAAE,CAAC;IAC9B,MAAM,iBAAiB,GAAG,IAAI,GAAG,EAAkB,CAAC;IAEpD,KAAK,MAAM,KAAK,IAAI,0CAAyB,EAAE,CAAC;QAC9C,MAAM,OAAO,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC;QAC9B,IAAI,CAAC,OAAO,EAAE,CAAC;YACb,SAAS;QACX,CAAC;QAED,KAAK,MAAM,KAAK,IAAI,OAAO,EAAE,CAAC;YAC5B,IAAI,KAAK,CAAC,MAAM,EAAE,CAAC;gBACjB,QAAQ,CAAC,IAAI,CACX,gBAAgB,IAAA,yBAAY,EAAC,KAAK,CAAC,SAAS,KAAK,uEAAuE,CACzH,CAAC;YACJ,CAAC;YAED,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC;gBAChC,SAAS;YACX,CAAC;YAED,MAAM,QAAQ,GAAG,IAAA,0BAAa,EAAC,KAAK,CAAC,CAAC;YACtC,MAAM,KAAK,GAAG,iBAAiB,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;YAC9C,IAAI,KAAK,IAAI,KAAK,KAAK,KAAK,EAAE,CAAC;gBAC7B,QAAQ,CAAC,IAAI,CACX,GAAG,IAAA,yBAAY,EAAC,KAAK,CAAC,sBAAsB,KAAK,YAAY,KAAK,+CAA+C,CAClH,CAAC;YACJ,CAAC;iBAAM,IAAI,CAAC,KAAK,EAAE,CAAC;gBAClB,iBAAiB,CAAC,GAAG,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC;YACzC,CAAC;QACH,CAAC;IACH,CAAC;IAED,OAAO,QAAQ,CAAC;AAClB,CAAC,CAAC;AAEF,MAAM,qBAAqB,GAAG,CAAC,aAA6B,EAAY,EAAE;IACxE,MAAM,QAAQ,GAAa,EAAE,CAAC;IAE9B,aAAa,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,WAAW,EAAE,EAAE;QAC5C,KAAK,MAAM,CAAC,KAAK,EAAE,IAAI,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;YACnD,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,EAAE,CAAC;gBACpF,QAAQ,CAAC,IAAI,CACX,mBAAmB,WAAW,aAAa,KAAK,MAAM,IAAI,gCAAgC,IAAI,wCAAwC,CACvI,CAAC;YACJ,CAAC;QACH,CAAC;IACH,CAAC,CAAC,CAAC;IAEH,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,aAAa,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC;QAClD,MAAM,KAAK,GAAG,MAAM,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC;QAC5C,KAAK,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,aAAa,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;YAClD,MAAM,KAAK,GAAG,MAAM,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC;YAC5C,MAAM,UAAU,GAAG,KAAK,CAAC,MAAM,GAAG,KAAK,CAAC,MAAM,IAAI,KAAK,CAAC,KAAK,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC;YAC5F,MAAM,UAAU,GAAG,KAAK,CAAC,MAAM,GAAG,KAAK,CAAC,MAAM,IAAI,KAAK,CAAC,KAAK,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC;YAC5F,IAAI,UAAU,IAAI,UAAU,EAAE,CAAC;gBAC7B,QAAQ,CAAC,IAAI,CACX,oBAAoB,CAAC,QAAQ,CAAC,0CAA0C,KAAK,CAAC,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,mCAAmC,CAC/I,CAAC;YACJ,CAAC;QACH,CAAC;IACH,CAAC;IAED,OAAO,QAAQ,CAAC;AAClB,CAAC,CAAC;AAEF;;;GAGG;AACI,MAAM,2BAA2B,GAAG,CAAC,MAA4B,EAAY,EAAE;;IACpF,MAAM,QAAQ,GAAG,MAAM,aAAN,MAAM,cAAN,MAAM,GAAI,EAAE,CAAC;IAC9B,IAAA,4CAAoC,EAAC,QAAQ,CAAC,aAAa,CAAC,CAAC;IAE7D,MAAM,QAAQ,GAAG;QACf,GAAG,CAAC,CAAC,IAAA,0CAAyB,EAAC,QAAQ,CAAC;YACtC,CAAC,CAAC,CAAC,oGAAoG,CAAC;YACxG,CAAC,CAAC,EAAE,CAAC;QACP,GAAG,oBAAoB,CAAC,QAAQ,CAAC;QACjC,GAAG,qBAAqB,CAAC,MAAA,QAAQ,CAAC,aAAa,mCAAI,EAAE,CAAC;KACvD,CAAC;IAEF,IAAI,QAAQ,CAAC,MAAM,IAAI,QAAQ,CAAC,CAAC,CAAC,EAAE,CAAC;QACnC,MAAM,IAAI,wCAA+B,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC;IACzD,CAAC;IAED,OAAO,QAAQ,CAAC;AAClB,CAAC,CAAC;AAjBW,QAAA,2BAA2B,+BAiBtC"}

package/dist/copyOnWriteHelpers.d.ts

@@ -0,0 +1,20 @@
+import { JsonArray, JsonObject, JsonValue } from './types';
+export type ObjectCopyState<T extends JsonObject> = {
+    source: T;
+    current: T;
+    copied: boolean;
+};
+export type ArrayCopyState<T extends JsonArray> = {
+    source: T;
+    current: T;
+    copied: boolean;
+};
+export declare const createObjectCopyState: <T extends JsonObject>(source: T) => ObjectCopyState<T>;
+export declare const createArrayCopyState: <T extends JsonArray>(source: T) => ArrayCopyState<T>;
+export declare const finishObjectCopy: <T extends JsonObject>(state: ObjectCopyState<T>) => T;
+export declare const finishArrayCopy: <T extends JsonArray>(state: ArrayCopyState<T>) => T;
+export declare const setObjectKey: <T extends JsonObject>(state: ObjectCopyState<T>, key: string, value: JsonValue | undefined) => void;
+export declare const deleteObjectKey: <T extends JsonObject>(state: ObjectCopyState<T>, key: string) => void;
+export declare const setArrayIndex: <T extends JsonArray>(state: ArrayCopyState<T>, index: number, value: JsonValue | undefined) => void;
+export declare const deleteArrayIndex: <T extends JsonArray>(state: ArrayCopyState<T>, index: number) => void;
+//# sourceMappingURL=copyOnWriteHelpers.d.ts.map

package/dist/copyOnWriteHelpers.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"copyOnWriteHelpers.d.ts","sourceRoot":"","sources":["../src/copyOnWriteHelpers.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,UAAU,EAAc,SAAS,EAAE,MAAM,SAAS,CAAC;AAEvE,MAAM,MAAM,eAAe,CAAC,CAAC,SAAS,UAAU,IAAI;IAClD,MAAM,EAAE,CAAC,CAAC;IACV,OAAO,EAAE,CAAC,CAAC;IACX,MAAM,EAAE,OAAO,CAAC;CACjB,CAAC;AAEF,MAAM,MAAM,cAAc,CAAC,CAAC,SAAS,SAAS,IAAI;IAChD,MAAM,EAAE,CAAC,CAAC;IACV,OAAO,EAAE,CAAC,CAAC;IACX,MAAM,EAAE,OAAO,CAAC;CACjB,CAAC;AAEF,eAAO,MAAM,qBAAqB,GAAI,CAAC,SAAS,UAAU,UAAU,CAAC,KAAG,eAAe,CAAC,CAAC,CAIvF,CAAC;AAEH,eAAO,MAAM,oBAAoB,GAAI,CAAC,SAAS,SAAS,UAAU,CAAC,KAAG,cAAc,CAAC,CAAC,CAIpF,CAAC;AAEH,eAAO,MAAM,gBAAgB,GAAI,CAAC,SAAS,UAAU,SAAS,eAAe,CAAC,CAAC,CAAC,KAAG,CACtC,CAAC;AAE9C,eAAO,MAAM,eAAe,GAAI,CAAC,SAAS,SAAS,SAAS,cAAc,CAAC,CAAC,CAAC,KAAG,CACnC,CAAC;AAoB9C,eAAO,MAAM,YAAY,GAAI,CAAC,SAAS,UAAU,SACxC,eAAe,CAAC,CAAC,CAAC,OACpB,MAAM,SACJ,SAAS,GAAG,SAAS,KAC3B,IAIF,CAAC;AAEF,eAAO,MAAM,eAAe,GAAI,CAAC,SAAS,UAAU,SAAS,eAAe,CAAC,CAAC,CAAC,OAAO,MAAM,KAAG,IAI9F,CAAC;AAEF,eAAO,MAAM,aAAa,GAAI,CAAC,SAAS,SAAS,SACxC,cAAc,CAAC,CAAC,CAAC,SACjB,MAAM,SACN,SAAS,GAAG,SAAS,KAC3B,IAIF,CAAC;AAEF,eAAO,MAAM,gBAAgB,GAAI,CAAC,SAAS,SAAS,SAAS,cAAc,CAAC,CAAC,CAAC,SAAS,MAAM,KAAG,IAI/F,CAAC"}

package/dist/copyOnWriteHelpers.js

@@ -0,0 +1,58 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.deleteArrayIndex = exports.setArrayIndex = exports.deleteObjectKey = exports.setObjectKey = exports.finishArrayCopy = exports.finishObjectCopy = exports.createArrayCopyState = exports.createObjectCopyState = void 0;
+const createObjectCopyState = (source) => ({
+    source,
+    current: source,
+    copied: false
+});
+exports.createObjectCopyState = createObjectCopyState;
+const createArrayCopyState = (source) => ({
+    source,
+    current: source,
+    copied: false
+});
+exports.createArrayCopyState = createArrayCopyState;
+const finishObjectCopy = (state) => state.copied ? state.current : state.source;
+exports.finishObjectCopy = finishObjectCopy;
+const finishArrayCopy = (state) => state.copied ? state.current : state.source;
+exports.finishArrayCopy = finishArrayCopy;
+const ensureObjectCopy = (state) => {
+    if (!state.copied) {
+        state.current = Object.assign({}, state.source);
+        state.copied = true;
+    }
+    return state.current;
+};
+const ensureArrayCopy = (state) => {
+    if (!state.copied) {
+        state.current = state.source.slice();
+        state.copied = true;
+    }
+    return state.current;
+};
+const setObjectKey = (state, key, value) => {
+    if (state.source[key] !== value) {
+        ensureObjectCopy(state)[key] = value;
+    }
+};
+exports.setObjectKey = setObjectKey;
+const deleteObjectKey = (state, key) => {
+    if (Object.prototype.hasOwnProperty.call(state.source, key)) {
+        delete ensureObjectCopy(state)[key];
+    }
+};
+exports.deleteObjectKey = deleteObjectKey;
+const setArrayIndex = (state, index, value) => {
+    if (state.source[index] !== value) {
+        ensureArrayCopy(state)[index] = value;
+    }
+};
+exports.setArrayIndex = setArrayIndex;
+const deleteArrayIndex = (state, index) => {
+    if (index < state.source.length) {
+        delete ensureArrayCopy(state)[index];
+    }
+};
+exports.deleteArrayIndex = deleteArrayIndex;
+//# sourceMappingURL=copyOnWriteHelpers.js.map

package/dist/copyOnWriteHelpers.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"copyOnWriteHelpers.js","sourceRoot":"","sources":["../src/copyOnWriteHelpers.ts"],"names":[],"mappings":";;;AAcO,MAAM,qBAAqB,GAAG,CAAuB,MAAS,EAAsB,EAAE,CAAC,CAAC;IAC7F,MAAM;IACN,OAAO,EAAE,MAAM;IACf,MAAM,EAAE,KAAK;CACd,CAAC,CAAC;AAJU,QAAA,qBAAqB,yBAI/B;AAEI,MAAM,oBAAoB,GAAG,CAAsB,MAAS,EAAqB,EAAE,CAAC,CAAC;IAC1F,MAAM;IACN,OAAO,EAAE,MAAM;IACf,MAAM,EAAE,KAAK;CACd,CAAC,CAAC;AAJU,QAAA,oBAAoB,wBAI9B;AAEI,MAAM,gBAAgB,GAAG,CAAuB,KAAyB,EAAK,EAAE,CACrF,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC;AADjC,QAAA,gBAAgB,oBACiB;AAEvC,MAAM,eAAe,GAAG,CAAsB,KAAwB,EAAK,EAAE,CAClF,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC;AADjC,QAAA,eAAe,mBACkB;AAE9C,MAAM,gBAAgB,GAAG,CAAuB,KAAyB,EAAc,EAAE;IACvF,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC;QAClB,KAAK,CAAC,OAAO,qBAAQ,KAAK,CAAC,MAAM,CAAE,CAAC;QACpC,KAAK,CAAC,MAAM,GAAG,IAAI,CAAC;IACtB,CAAC;IAED,OAAO,KAAK,CAAC,OAAO,CAAC;AACvB,CAAC,CAAC;AAEF,MAAM,eAAe,GAAG,CAAsB,KAAwB,EAAa,EAAE;IACnF,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC;QAClB,KAAK,CAAC,OAAO,GAAG,KAAK,CAAC,MAAM,CAAC,KAAK,EAAO,CAAC;QAC1C,KAAK,CAAC,MAAM,GAAG,IAAI,CAAC;IACtB,CAAC;IAED,OAAO,KAAK,CAAC,OAAO,CAAC;AACvB,CAAC,CAAC;AAEK,MAAM,YAAY,GAAG,CAC1B,KAAyB,EACzB,GAAW,EACX,KAA4B,EACtB,EAAE;IACR,IAAI,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,KAAK,KAAK,EAAE,CAAC;QAChC,gBAAgB,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;IACvC,CAAC;AACH,CAAC,CAAC;AARW,QAAA,YAAY,gBAQvB;AAEK,MAAM,eAAe,GAAG,CAAuB,KAAyB,EAAE,GAAW,EAAQ,EAAE;IACpG,IAAI,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,GAAG,CAAC,EAAE,CAAC;QAC5D,OAAO,gBAAgB,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC,CAAC;IACtC,CAAC;AACH,CAAC,CAAC;AAJW,QAAA,eAAe,mBAI1B;AAEK,MAAM,aAAa,GAAG,CAC3B,KAAwB,EACxB,KAAa,EACb,KAA4B,EACtB,EAAE;IACR,IAAI,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,KAAK,EAAE,CAAC;QAClC,eAAe,CAAC,KAAK,CAAC,CAAC,KAAK,CAAC,GAAG,KAAK,CAAC;IACxC,CAAC;AACH,CAAC,CAAC;AARW,QAAA,aAAa,iBAQxB;AAEK,MAAM,gBAAgB,GAAG,CAAsB,KAAwB,EAAE,KAAa,EAAQ,EAAE;IACrG,IAAI,KAAK,GAAG,KAAK,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC;QAChC,OAAO,eAAe,CAAC,KAAK,CAAC,CAAC,KAAK,CAAC,CAAC;IACvC,CAAC;AACH,CAAC,CAAC;AAJW,QAAA,gBAAgB,oBAI3B"}

package/dist/customObjectManager.d.ts

@@ -1,22 +1,28 @@
-import { CustomObject } from './types';
+import { CustomObject, MatchedSchemaReport } from './types';
 /**
  * Utility for determining if a given object matches a CustomObject schema.
+ * A value matches when it contains every key defined in the schema; additional keys on the value are allowed.
+ * When multiple schemas match, the schema with the most keys is selected.
  */
 export declare class CustomObjectManager {
-    private customObjects;
+    private readonly customObjects;
+    private readonly schemaNames;
     /**
      * Creates a CustomObjectChecker with the specified CustomObjects.
      * @param customObjects The CustomObjects to check against.
+     * @param schemaNames Optional labels parallel to `customObjects` for dry-run reports.
      */
-    constructor(customObjects?: CustomObject[]);
+    constructor(customObjects?: CustomObject[], schemaNames?: readonly (string | undefined)[]);
+    getSchemaIndex(schema: CustomObject): number;
+    getSchemaName(schemaIndex: number): string | undefined;
+    getSchemaMetadata(schema: CustomObject): Pick<MatchedSchemaReport, 'schemaIndex' | 'schemaName'>;
     /**
      * Determines if the input value matches any of the custom objects provided in the constructor.
+     * When multiple schemas match, returns the schema with the most keys.
      * @param value The value to compare against the custom objects.
-     * @returns A matching custom object if one exists, otherwise undefined.
+     * @returns The most specific matching custom object, otherwise undefined.
      */
-    getMatchingCustomObject(value: any): CustomObject | undefined;
+    getMatchingCustomObject(value: unknown): CustomObject | undefined;
     private isCustomObject;
-    private objectHasExtraKeys;
-    private validateCustomObjects;
 }
 //# sourceMappingURL=customObjectManager.d.ts.map

package/dist/customObjectManager.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"customObjectManager.d.ts","sourceRoot":"","sources":["../src/customObjectManager.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AAEvC;;GAEG;AACH,qBAAa,mBAAmB;IAC9B,OAAO,CAAC,aAAa,CAAsB;IAE3C;;;OAGG;gBACS,aAAa,CAAC,EAAE,YAAY,EAAE;IAK1C;;;;OAIG;IACI,uBAAuB,CAAC,KAAK,EAAE,GAAG,GAAG,YAAY,GAAG,SAAS;IASpE,OAAO,CAAC,cAAc;IAQtB,OAAO,CAAC,kBAAkB;IAI1B,OAAO,CAAC,qBAAqB;CAoB9B"}
+{"version":3,"file":"customObjectManager.d.ts","sourceRoot":"","sources":["../src/customObjectManager.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAc,mBAAmB,EAAE,MAAM,SAAS,CAAC;AAGxE;;;;GAIG;AACH,qBAAa,mBAAmB;IAC9B,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAiB;IAC/C,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAkC;IAE9D;;;;OAIG;gBACS,aAAa,CAAC,EAAE,YAAY,EAAE,EAAE,WAAW,CAAC,EAAE,SAAS,CAAC,MAAM,GAAG,SAAS,CAAC,EAAE;IAMlF,cAAc,CAAC,MAAM,EAAE,YAAY,GAAG,MAAM;IAI5C,aAAa,CAAC,WAAW,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS;IAItD,iBAAiB,CAAC,MAAM,EAAE,YAAY,GAAG,IAAI,CAAC,mBAAmB,EAAE,aAAa,GAAG,YAAY,CAAC;IAMvG;;;;;OAKG;IACI,uBAAuB,CAAC,KAAK,EAAE,OAAO,GAAG,YAAY,GAAG,SAAS;IAiBxE,OAAO,CAAC,cAAc;CAOvB"}

package/dist/customObjectManager.js

@@ -1,58 +1,59 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.CustomObjectManager = void 0;
-const errors_1 = require("./errors");
+const configValidator_1 = require("./configValidator");
 /**
  * Utility for determining if a given object matches a CustomObject schema.
+ * A value matches when it contains every key defined in the schema; additional keys on the value are allowed.
+ * When multiple schemas match, the schema with the most keys is selected.
  */
 class CustomObjectManager {
     /**
      * Creates a CustomObjectChecker with the specified CustomObjects.
      * @param customObjects The CustomObjects to check against.
+     * @param schemaNames Optional labels parallel to `customObjects` for dry-run reports.
      */
-    constructor(customObjects) {
-        this.customObjects = [];
-        this.validateCustomObjects(customObjects);
-        this.customObjects = customObjects ? customObjects : [];
+    constructor(customObjects, schemaNames) {
+        (0, configValidator_1.assertNoIdenticalCustomObjectSchemas)(customObjects);
+        this.customObjects = customObjects !== null && customObjects !== void 0 ? customObjects : [];
+        this.schemaNames = schemaNames !== null && schemaNames !== void 0 ? schemaNames : [];
+    }
+    getSchemaIndex(schema) {
+        return this.customObjects.indexOf(schema);
+    }
+    getSchemaName(schemaIndex) {
+        return this.schemaNames[schemaIndex];
+    }
+    getSchemaMetadata(schema) {
+        const schemaIndex = this.getSchemaIndex(schema);
+        const schemaName = this.getSchemaName(schemaIndex);
+        return schemaName ? { schemaIndex, schemaName } : { schemaIndex };
     }
     /**
      * Determines if the input value matches any of the custom objects provided in the constructor.
+     * When multiple schemas match, returns the schema with the most keys.
      * @param value The value to compare against the custom objects.
-     * @returns A matching custom object if one exists, otherwise undefined.
+     * @returns The most specific matching custom object, otherwise undefined.
      */
     getMatchingCustomObject(value) {
+        let bestMatch;
+        let bestMatchKeyCount = -1;
         for (const customObject of this.customObjects) {
             if (this.isCustomObject(value, customObject)) {
-                return customObject;
+                const keyCount = Object.keys(customObject).length;
+                if (keyCount > bestMatchKeyCount) {
+                    bestMatch = customObject;
+                    bestMatchKeyCount = keyCount;
+                }
             }
         }
-        return undefined;
+        return bestMatch;
     }
     isCustomObject(value, customObject) {
         if (typeof value !== 'object' || !value || Array.isArray(value)) {
             return false;
         }
-        return !this.objectHasExtraKeys(customObject, value) && !this.objectHasExtraKeys(value, customObject);
-    }
-    objectHasExtraKeys(object, objectToCompareTo) {
-        return Object.keys(object).some((key) => !objectToCompareTo.hasOwnProperty(key));
-    }
-    validateCustomObjects(customObjects) {
-        if (!customObjects || customObjects.length <= 1) {
-            return;
-        }
-        for (let i = 0; i < customObjects.length - 1; i++) {
-            const current = customObjects[i];
-            const keys = Object.keys(current);
-            for (let j = i + 1; j < customObjects.length; j++) {
-                const other = customObjects[j];
-                const otherKeys = Object.keys(other);
-                const commonKeys = keys.filter((key) => otherKeys.includes(key));
-                if (commonKeys.length === keys.length && commonKeys.length === otherKeys.length) {
-                    throw new errors_1.FieldRedactorConfigurationError(`Custom Objects at indexes ${i} and ${j} cannot have identical keys: ${commonKeys}`);
-                }
-            }
-        }
+        return Object.keys(customObject).every((key) => Object.prototype.hasOwnProperty.call(value, key));
     }
 }
 exports.CustomObjectManager = CustomObjectManager;

package/dist/customObjectManager.js.map

@@ -1 +1 @@
-{"version":3,"file":"customObjectManager.js","sourceRoot":"","sources":["../src/customObjectManager.ts"],"names":[],"mappings":";;;AAAA,qCAA2D;AAG3D;;GAEG;AACH,MAAa,mBAAmB;IAG9B;;;OAGG;IACH,YAAY,aAA8B;QANlC,kBAAa,GAAmB,EAAE,CAAC;QAOzC,IAAI,CAAC,qBAAqB,CAAC,aAAa,CAAC,CAAC;QAC1C,IAAI,CAAC,aAAa,GAAG,aAAa,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,EAAE,CAAC;IAC1D,CAAC;IAED;;;;OAIG;IACI,uBAAuB,CAAC,KAAU;QACvC,KAAK,MAAM,YAAY,IAAI,IAAI,CAAC,aAAa,EAAE,CAAC;YAC9C,IAAI,IAAI,CAAC,cAAc,CAAC,KAAK,EAAE,YAAY,CAAC,EAAE,CAAC;gBAC7C,OAAO,YAAY,CAAC;YACtB,CAAC;QACH,CAAC;QACD,OAAO,SAAS,CAAC;IACnB,CAAC;IAEO,cAAc,CAAC,KAAU,EAAE,YAA0B;QAC3D,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,CAAC,KAAK,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;YAChE,OAAO,KAAK,CAAC;QACf,CAAC;QAED,OAAO,CAAC,IAAI,CAAC,kBAAkB,CAAC,YAAY,EAAE,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,kBAAkB,CAAC,KAAK,EAAE,YAAY,CAAC,CAAC;IACxG,CAAC;IAEO,kBAAkB,CAAC,MAAW,EAAE,iBAAsB;QAC5D,OAAO,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,iBAAiB,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC,CAAC;IACnF,CAAC;IAEO,qBAAqB,CAAC,aAA8B;QAC1D,IAAI,CAAC,aAAa,IAAI,aAAa,CAAC,MAAM,IAAI,CAAC,EAAE,CAAC;YAChD,OAAO;QACT,CAAC;QAED,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,aAAa,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC;YAClD,MAAM,OAAO,GAAiB,aAAa,CAAC,CAAC,CAAC,CAAC;YAC/C,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;YAClC,KAAK,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,aAAa,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;gBAClD,MAAM,KAAK,GAAiB,aAAa,CAAC,CAAC,CAAC,CAAC;gBAC7C,MAAM,SAAS,GAAG,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;gBACrC,MAAM,UAAU,GAAG,IAAI,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,SAAS,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC;gBACjE,IAAI,UAAU,CAAC,MAAM,KAAK,IAAI,CAAC,MAAM,IAAI,UAAU,CAAC,MAAM,KAAK,SAAS,CAAC,MAAM,EAAE,CAAC;oBAChF,MAAM,IAAI,wCAA+B,CACvC,6BAA6B,CAAC,QAAQ,CAAC,gCAAgC,UAAU,EAAE,CACpF,CAAC;gBACJ,CAAC;YACH,CAAC;QACH,CAAC;IACH,CAAC;CACF;AA1DD,kDA0DC"}
+{"version":3,"file":"customObjectManager.js","sourceRoot":"","sources":["../src/customObjectManager.ts"],"names":[],"mappings":";;;AACA,uDAAyE;AAEzE;;;;GAIG;AACH,MAAa,mBAAmB;IAI9B;;;;OAIG;IACH,YAAY,aAA8B,EAAE,WAA6C;QACvF,IAAA,sDAAoC,EAAC,aAAa,CAAC,CAAC;QACpD,IAAI,CAAC,aAAa,GAAG,aAAa,aAAb,aAAa,cAAb,aAAa,GAAI,EAAE,CAAC;QACzC,IAAI,CAAC,WAAW,GAAG,WAAW,aAAX,WAAW,cAAX,WAAW,GAAI,EAAE,CAAC;IACvC,CAAC;IAEM,cAAc,CAAC,MAAoB;QACxC,OAAO,IAAI,CAAC,aAAa,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;IAC5C,CAAC;IAEM,aAAa,CAAC,WAAmB;QACtC,OAAO,IAAI,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC;IACvC,CAAC;IAEM,iBAAiB,CAAC,MAAoB;QAC3C,MAAM,WAAW,GAAG,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC;QAChD,MAAM,UAAU,GAAG,IAAI,CAAC,aAAa,CAAC,WAAW,CAAC,CAAC;QACnD,OAAO,UAAU,CAAC,CAAC,CAAC,EAAE,WAAW,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC,EAAE,WAAW,EAAE,CAAC;IACpE,CAAC;IAED;;;;;OAKG;IACI,uBAAuB,CAAC,KAAc;QAC3C,IAAI,SAAmC,CAAC;QACxC,IAAI,iBAAiB,GAAG,CAAC,CAAC,CAAC;QAE3B,KAAK,MAAM,YAAY,IAAI,IAAI,CAAC,aAAa,EAAE,CAAC;YAC9C,IAAI,IAAI,CAAC,cAAc,CAAC,KAAK,EAAE,YAAY,CAAC,EAAE,CAAC;gBAC7C,MAAM,QAAQ,GAAG,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,MAAM,CAAC;gBAClD,IAAI,QAAQ,GAAG,iBAAiB,EAAE,CAAC;oBACjC,SAAS,GAAG,YAAY,CAAC;oBACzB,iBAAiB,GAAG,QAAQ,CAAC;gBAC/B,CAAC;YACH,CAAC;QACH,CAAC;QAED,OAAO,SAAS,CAAC;IACnB,CAAC;IAEO,cAAc,CAAC,KAAc,EAAE,YAA0B;QAC/D,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,CAAC,KAAK,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;YAChE,OAAO,KAAK,CAAC;QACf,CAAC;QAED,OAAO,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,KAAK,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC,CAAC;IACpG,CAAC;CACF;AA3DD,kDA2DC"}

package/dist/dryRun.d.ts

@@ -0,0 +1,8 @@
+import { CustomObjectManager } from './customObjectManager';
+import { SecretManager } from './secretManager';
+import { ValuePatternMatcher } from './valuePatternMatcher';
+import { DryRunReport, JsonValue } from './types';
+export declare const createEmptyDryRunReport: () => DryRunReport;
+export declare const EMPTY_DRY_RUN_REPORT: DryRunReport;
+export declare const buildDryRunReport: (before: JsonValue | undefined, after: JsonValue | undefined, manager: CustomObjectManager, secretManager: SecretManager, valuePatternMatcher: ValuePatternMatcher) => DryRunReport;
+//# sourceMappingURL=dryRun.d.ts.map

package/dist/dryRun.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"dryRun.d.ts","sourceRoot":"","sources":["../src/dryRun.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAG5D,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAChD,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAC5D,OAAO,EAAE,YAAY,EAAgB,SAAS,EAAE,MAAM,SAAS,CAAC;AAEhE,eAAO,MAAM,uBAAuB,QAAO,YAKzC,CAAC;AAEH,eAAO,MAAM,oBAAoB,EAAE,YAAwC,CAAC;AA0E5E,eAAO,MAAM,iBAAiB,WACpB,SAAS,GAAG,SAAS,SACtB,SAAS,GAAG,SAAS,WACnB,mBAAmB,iBACb,aAAa,uBACP,mBAAmB,KACvC,YAiBF,CAAC"}

package/dist/dryRun.js

@@ -0,0 +1,75 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.buildDryRunReport = exports.EMPTY_DRY_RUN_REPORT = exports.createEmptyDryRunReport = void 0;
+const dryRunAttribution_1 = require("./dryRunAttribution");
+const jsonWalk_1 = require("./jsonWalk");
+const types_1 = require("./types");
+const createEmptyDryRunReport = () => ({
+    redactedPaths: [],
+    deletedPaths: [],
+    matchedSchemas: [],
+    pathRules: []
+});
+exports.createEmptyDryRunReport = createEmptyDryRunReport;
+exports.EMPTY_DRY_RUN_REPORT = (0, exports.createEmptyDryRunReport)();
+const pushPath = (report, path, list) => {
+    if (path) {
+        report[list].push(path);
+    }
+};
+const diffRedaction = (before, after, path, report) => {
+    if (before === after) {
+        return;
+    }
+    if (!(0, jsonWalk_1.isTraversableJson)(before) || !(0, jsonWalk_1.isTraversableJson)(after)) {
+        pushPath(report, path, after === undefined && before !== undefined ? 'deletedPaths' : 'redactedPaths');
+        return;
+    }
+    if (Array.isArray(before)) {
+        if (!Array.isArray(after)) {
+            pushPath(report, path, 'redactedPaths');
+            return;
+        }
+        for (let index = 0; index < Math.max(before.length, after.length); index++) {
+            if (!Object.prototype.hasOwnProperty.call(after, index) && Object.prototype.hasOwnProperty.call(before, index)) {
+                report.deletedPaths.push((0, jsonWalk_1.joinPath)(path, index));
+                continue;
+            }
+            diffRedaction(before[index], after[index], (0, jsonWalk_1.joinPath)(path, index), report);
+        }
+        return;
+    }
+    if (!(0, types_1.isJsonObject)(before) || !(0, types_1.isJsonObject)(after)) {
+        pushPath(report, path, 'redactedPaths');
+        return;
+    }
+    for (const key of Object.keys(before)) {
+        const childPath = (0, jsonWalk_1.joinPath)(path, key);
+        if (!Object.prototype.hasOwnProperty.call(after, key)) {
+            report.deletedPaths.push(childPath);
+        }
+        else {
+            diffRedaction(before[key], after[key], childPath, report);
+        }
+    }
+};
+const collectMatchedSchemas = (value, manager, path, report) => {
+    (0, jsonWalk_1.walkTraversableJson)(value, path, (node, nodePath) => {
+        const schema = manager.getMatchingCustomObject(node);
+        if (!schema) {
+            return;
+        }
+        report.matchedSchemas.push(Object.assign({ path: nodePath || '(root)' }, manager.getSchemaMetadata(schema)));
+    });
+};
+const buildDryRunReport = (before, after, manager, secretManager, valuePatternMatcher) => {
+    const report = (0, exports.createEmptyDryRunReport)();
+    if (before !== undefined) {
+        diffRedaction(before, after, '', report);
+        collectMatchedSchemas(before, manager, '', report);
+        report.pathRules = (0, dryRunAttribution_1.buildPathRules)(before, report.redactedPaths, report.deletedPaths, secretManager, manager, valuePatternMatcher);
+    }
+    return report;
+};
+exports.buildDryRunReport = buildDryRunReport;
+//# sourceMappingURL=dryRun.js.map

package/dist/dryRun.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"dryRun.js","sourceRoot":"","sources":["../src/dryRun.ts"],"names":[],"mappings":";;;AACA,2DAAqD;AACrD,yCAA8E;AAG9E,mCAAgE;AAEzD,MAAM,uBAAuB,GAAG,GAAiB,EAAE,CAAC,CAAC;IAC1D,aAAa,EAAE,EAAE;IACjB,YAAY,EAAE,EAAE;IAChB,cAAc,EAAE,EAAE;IAClB,SAAS,EAAE,EAAE;CACd,CAAC,CAAC;AALU,QAAA,uBAAuB,2BAKjC;AAEU,QAAA,oBAAoB,GAAiB,IAAA,+BAAuB,GAAE,CAAC;AAE5E,MAAM,QAAQ,GAAG,CAAC,MAAoB,EAAE,IAAY,EAAE,IAAsC,EAAQ,EAAE;IACpG,IAAI,IAAI,EAAE,CAAC;QACT,MAAM,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC1B,CAAC;AACH,CAAC,CAAC;AAEF,MAAM,aAAa,GAAG,CACpB,MAA6B,EAC7B,KAA4B,EAC5B,IAAY,EACZ,MAAoB,EACd,EAAE;IACR,IAAI,MAAM,KAAK,KAAK,EAAE,CAAC;QACrB,OAAO;IACT,CAAC;IAED,IAAI,CAAC,IAAA,4BAAiB,EAAC,MAAM,CAAC,IAAI,CAAC,IAAA,4BAAiB,EAAC,KAAK,CAAC,EAAE,CAAC;QAC5D,QAAQ,CAAC,MAAM,EAAE,IAAI,EAAE,KAAK,KAAK,SAAS,IAAI,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,cAAc,CAAC,CAAC,CAAC,eAAe,CAAC,CAAC;QACvG,OAAO;IACT,CAAC;IAED,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;QAC1B,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;YAC1B,QAAQ,CAAC,MAAM,EAAE,IAAI,EAAE,eAAe,CAAC,CAAC;YACxC,OAAO;QACT,CAAC;QAED,KAAK,IAAI,KAAK,GAAG,CAAC,EAAE,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC,EAAE,KAAK,EAAE,EAAE,CAAC;YAC3E,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,KAAK,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,MAAM,EAAE,KAAK,CAAC,EAAE,CAAC;gBAC/G,MAAM,CAAC,YAAY,CAAC,IAAI,CAAC,IAAA,mBAAQ,EAAC,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC;gBAChD,SAAS;YACX,CAAC;YAED,aAAa,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,KAAK,CAAC,KAAK,CAAC,EAAE,IAAA,mBAAQ,EAAC,IAAI,EAAE,KAAK,CAAC,EAAE,MAAM,CAAC,CAAC;QAC5E,CAAC;QACD,OAAO;IACT,CAAC;IAED,IAAI,CAAC,IAAA,oBAAY,EAAC,MAAM,CAAC,IAAI,CAAC,IAAA,oBAAY,EAAC,KAAK,CAAC,EAAE,CAAC;QAClD,QAAQ,CAAC,MAAM,EAAE,IAAI,EAAE,eAAe,CAAC,CAAC;QACxC,OAAO;IACT,CAAC;IAED,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC;QACtC,MAAM,SAAS,GAAG,IAAA,mBAAQ,EAAC,IAAI,EAAE,GAAG,CAAC,CAAC;QACtC,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,KAAK,EAAE,GAAG,CAAC,EAAE,CAAC;YACtD,MAAM,CAAC,YAAY,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QACtC,CAAC;aAAM,CAAC;YACN,aAAa,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,KAAK,CAAC,GAAG,CAAC,EAAE,SAAS,EAAE,MAAM,CAAC,CAAC;QAC5D,CAAC;IACH,CAAC;AACH,CAAC,CAAC;AAEF,MAAM,qBAAqB,GAAG,CAC5B,KAA4B,EAC5B,OAA4B,EAC5B,IAAY,EACZ,MAAoB,EACd,EAAE;IACR,IAAA,8BAAmB,EAAC,KAAK,EAAE,IAAI,EAAE,CAAC,IAAI,EAAE,QAAQ,EAAE,EAAE;QAClD,MAAM,MAAM,GAAG,OAAO,CAAC,uBAAuB,CAAC,IAAI,CAAC,CAAC;QACrD,IAAI,CAAC,MAAM,EAAE,CAAC;YACZ,OAAO;QACT,CAAC;QAED,MAAM,CAAC,cAAc,CAAC,IAAI,iBACxB,IAAI,EAAE,QAAQ,IAAI,QAAQ,IACvB,OAAO,CAAC,iBAAiB,CAAC,MAAM,CAAC,EACpC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC;AAEK,MAAM,iBAAiB,GAAG,CAC/B,MAA6B,EAC7B,KAA4B,EAC5B,OAA4B,EAC5B,aAA4B,EAC5B,mBAAwC,EAC1B,EAAE;IAChB,MAAM,MAAM,GAAG,IAAA,+BAAuB,GAAE,CAAC;IAEzC,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;QACzB,aAAa,CAAC,MAAM,EAAE,KAAK,EAAE,EAAE,EAAE,MAAM,CAAC,CAAC;QACzC,qBAAqB,CAAC,MAAM,EAAE,OAAO,EAAE,EAAE,EAAE,MAAM,CAAC,CAAC;QACnD,MAAM,CAAC,SAAS,GAAG,IAAA,kCAAc,EAC/B,MAAM,EACN,MAAM,CAAC,aAAa,EACpB,MAAM,CAAC,YAAY,EACnB,aAAa,EACb,OAAO,EACP,mBAAmB,CACpB,CAAC;IACJ,CAAC;IAED,OAAO,MAAM,CAAC;AAChB,CAAC,CAAC;AAvBW,QAAA,iBAAiB,qBAuB5B"}

package/dist/dryRunAttribution.d.ts

@@ -0,0 +1,8 @@
+import { CustomObjectManager } from './customObjectManager';
+import { SecretManager } from './secretManager';
+import { ValuePatternMatcher } from './valuePatternMatcher';
+import { DryRunPathRule, JsonValue } from './types';
+export declare const attributeDeletePathRule: (before: JsonValue | undefined, path: string, secretManager: SecretManager) => DryRunPathRule;
+export declare const attributeRedactPathRule: (before: JsonValue | undefined, path: string, secretManager: SecretManager, manager: CustomObjectManager, valuePatternMatcher: ValuePatternMatcher) => DryRunPathRule;
+export declare const buildPathRules: (before: JsonValue | undefined, redactedPaths: readonly string[], deletedPaths: readonly string[], secretManager: SecretManager, manager: CustomObjectManager, valuePatternMatcher: ValuePatternMatcher) => DryRunPathRule[];
+//# sourceMappingURL=dryRunAttribution.d.ts.map

package/dist/dryRunAttribution.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"dryRunAttribution.d.ts","sourceRoot":"","sources":["../src/dryRunAttribution.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAG5D,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAChD,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAC5D,OAAO,EACL,cAAc,EAGd,SAAS,EAGV,MAAM,SAAS,CAAC;AAkIjB,eAAO,MAAM,uBAAuB,WAC1B,SAAS,GAAG,SAAS,QACvB,MAAM,iBACG,aAAa,KAC3B,cAOF,CAAC;AAEF,eAAO,MAAM,uBAAuB,WAC1B,SAAS,GAAG,SAAS,QACvB,MAAM,iBACG,aAAa,WACnB,mBAAmB,uBACP,mBAAmB,KACvC,cAoBF,CAAC;AAEF,eAAO,MAAM,cAAc,WACjB,SAAS,GAAG,SAAS,iBACd,SAAS,MAAM,EAAE,gBAClB,SAAS,MAAM,EAAE,iBAChB,aAAa,WACnB,mBAAmB,uBACP,mBAAmB,KACvC,cAAc,EAGhB,CAAC"}

package/dist/dryRunAttribution.js

@@ -0,0 +1,106 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.buildPathRules = exports.attributeRedactPathRule = exports.attributeDeletePathRule = void 0;
+const objectRedactorHelpers_1 = require("./objectRedactorHelpers");
+const jsonWalk_1 = require("./jsonWalk");
+const types_1 = require("./types");
+const objectKeysFromPath = (segments) => segments.filter((segment) => typeof segment === 'string');
+const toPathRule = (path, action, rule, extras = {}) => (Object.assign({ path, action, rule }, extras));
+const patternForKey = (secretManager, key, rule) => secretManager.getKeyRulePattern(key, rule);
+const attributeKeyRule = (path, action, key, secretManager) => {
+    var _a;
+    const rule = (_a = secretManager.classifyKeyRule(key)) !== null && _a !== void 0 ? _a : 'default';
+    if (rule === 'default') {
+        return toPathRule(path, action, rule);
+    }
+    return toPathRule(path, action, rule, { pattern: patternForKey(secretManager, key, rule) });
+};
+const trySchemaRule = ({ before, path, segments, secretManager, manager }) => {
+    const { parent, leaf } = (0, jsonWalk_1.getParentContext)(before, segments);
+    if (!(0, types_1.isJsonObject)(parent) || typeof leaf !== 'string') {
+        return undefined;
+    }
+    const schema = manager.getMatchingCustomObject(parent);
+    if (!schema || !(leaf in schema)) {
+        return undefined;
+    }
+    let pattern;
+    if (typeof schema[leaf] === 'string') {
+        const siblingSpecifier = (0, objectRedactorHelpers_1.getStringSpecifiedCustomObjectSecretKeyValueIfExists)(parent, schema, leaf);
+        if (siblingSpecifier !== undefined) {
+            const siblingRule = secretManager.classifyKeyRule(siblingSpecifier);
+            if (siblingRule && siblingRule !== 'default') {
+                pattern = patternForKey(secretManager, siblingSpecifier, siblingRule);
+            }
+        }
+    }
+    return toPathRule(path, 'redact', 'schema', Object.assign(Object.assign({}, manager.getSchemaMetadata(schema)), (pattern ? { pattern } : {})));
+};
+const tryEnclosingOpaqueOrDeep = ({ path, objectKeys, secretManager }) => {
+    for (let index = objectKeys.length - 2; index >= 0; index--) {
+        const key = objectKeys[index];
+        const rule = secretManager.classifyKeyRule(key);
+        if (rule === 'opaque' || rule === 'deep') {
+            return toPathRule(path, 'redact', rule, { pattern: patternForKey(secretManager, key, rule) });
+        }
+    }
+    return undefined;
+};
+const tryLeafKeyRule = ({ path, objectKeys, secretManager }) => {
+    const leafKey = objectKeys.at(-1);
+    if (!leafKey || !secretManager.classifyKeyRule(leafKey)) {
+        return undefined;
+    }
+    return attributeKeyRule(path, 'redact', leafKey, secretManager);
+};
+const tryValuePatternRule = ({ before, path, segments, valuePatternMatcher }) => {
+    const value = (0, jsonWalk_1.getJsonValueAtPath)(before, segments);
+    if (value === undefined || (typeof value !== 'string' && typeof value !== 'number')) {
+        return undefined;
+    }
+    const match = valuePatternMatcher.findMatching((0, objectRedactorHelpers_1.toRedactablePrimitive)(value));
+    if (!match) {
+        return undefined;
+    }
+    return toPathRule(path, 'redact', 'value', { pattern: valuePatternMatcher.formatPattern(match) });
+};
+const REDACT_RULE_RESOLVERS = [
+    trySchemaRule,
+    tryEnclosingOpaqueOrDeep,
+    tryLeafKeyRule,
+    tryValuePatternRule
+];
+const attributeDeletePathRule = (before, path, secretManager) => {
+    const deleteKey = objectKeysFromPath((0, jsonWalk_1.parseJsonPath)(path)).at(-1);
+    if (deleteKey) {
+        return attributeKeyRule(path, 'delete', deleteKey, secretManager);
+    }
+    return toPathRule(path, 'delete', 'default');
+};
+exports.attributeDeletePathRule = attributeDeletePathRule;
+const attributeRedactPathRule = (before, path, secretManager, manager, valuePatternMatcher) => {
+    const segments = (0, jsonWalk_1.parseJsonPath)(path);
+    const context = {
+        before,
+        path,
+        segments,
+        objectKeys: objectKeysFromPath(segments),
+        secretManager,
+        manager,
+        valuePatternMatcher
+    };
+    for (const resolve of REDACT_RULE_RESOLVERS) {
+        const rule = resolve(context);
+        if (rule) {
+            return rule;
+        }
+    }
+    return toPathRule(path, 'redact', 'default');
+};
+exports.attributeRedactPathRule = attributeRedactPathRule;
+const buildPathRules = (before, redactedPaths, deletedPaths, secretManager, manager, valuePatternMatcher) => [
+    ...deletedPaths.map((path) => (0, exports.attributeDeletePathRule)(before, path, secretManager)),
+    ...redactedPaths.map((path) => (0, exports.attributeRedactPathRule)(before, path, secretManager, manager, valuePatternMatcher))
+];
+exports.buildPathRules = buildPathRules;
+//# sourceMappingURL=dryRunAttribution.js.map

package/dist/dryRunAttribution.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"dryRunAttribution.js","sourceRoot":"","sources":["../src/dryRunAttribution.ts"],"names":[],"mappings":";;;AACA,mEAAsH;AACtH,yCAAiF;AAGjF,mCAOiB;AAcjB,MAAM,kBAAkB,GAAG,CAAC,QAAgC,EAAY,EAAE,CACxE,QAAQ,CAAC,MAAM,CAAC,CAAC,OAAO,EAAqB,EAAE,CAAC,OAAO,OAAO,KAAK,QAAQ,CAAC,CAAC;AAE/E,MAAM,UAAU,GAAG,CACjB,IAAY,EACZ,MAAgC,EAChC,IAAwB,EACxB,SAAkF,EAAE,EACpE,EAAE,CAAC,iBAAG,IAAI,EAAE,MAAM,EAAE,IAAI,IAAK,MAAM,EAAG,CAAC;AAEzD,MAAM,aAAa,GAAG,CAAC,aAA4B,EAAE,GAAyB,EAAE,IAAa,EAAsB,EAAE,CACnH,aAAa,CAAC,iBAAiB,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;AAE7C,MAAM,gBAAgB,GAAG,CACvB,IAAY,EACZ,MAAgC,EAChC,GAAyB,EACzB,aAA4B,EACZ,EAAE;;IAClB,MAAM,IAAI,GAAG,MAAA,aAAa,CAAC,eAAe,CAAC,GAAG,CAAC,mCAAI,SAAS,CAAC;IAC7D,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;QACvB,OAAO,UAAU,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,CAAC;IACxC,CAAC;IAED,OAAO,UAAU,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,EAAE,OAAO,EAAE,aAAa,CAAC,aAAa,EAAE,GAAG,EAAE,IAAI,CAAC,EAAE,CAAC,CAAC;AAC9F,CAAC,CAAC;AAEF,MAAM,aAAa,GAAG,CAAC,EACrB,MAAM,EACN,IAAI,EACJ,QAAQ,EACR,aAAa,EACb,OAAO,EACkB,EAA8B,EAAE;IACzD,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG,IAAA,2BAAgB,EAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;IAC5D,IAAI,CAAC,IAAA,oBAAY,EAAC,MAAM,CAAC,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE,CAAC;QACtD,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,MAAM,MAAM,GAAG,OAAO,CAAC,uBAAuB,CAAC,MAAM,CAAC,CAAC;IACvD,IAAI,CAAC,MAAM,IAAI,CAAC,CAAC,IAAI,IAAI,MAAM,CAAC,EAAE,CAAC;QACjC,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,IAAI,OAA2B,CAAC;IAChC,IAAI,OAAO,MAAM,CAAC,IAAI,CAAC,KAAK,QAAQ,EAAE,CAAC;QACrC,MAAM,gBAAgB,GAAG,IAAA,4EAAoD,EAAC,MAAM,EAAE,MAAM,EAAE,IAAI,CAAC,CAAC;QACpG,IAAI,gBAAgB,KAAK,SAAS,EAAE,CAAC;YACnC,MAAM,WAAW,GAAG,aAAa,CAAC,eAAe,CAAC,gBAAgB,CAAC,CAAC;YACpE,IAAI,WAAW,IAAI,WAAW,KAAK,SAAS,EAAE,CAAC;gBAC7C,OAAO,GAAG,aAAa,CAAC,aAAa,EAAE,gBAAgB,EAAE,WAAW,CAAC,CAAC;YACxE,CAAC;QACH,CAAC;IACH,CAAC;IAED,OAAO,UAAU,CAAC,IAAI,EAAE,QAAQ,EAAE,QAAQ,kCACrC,OAAO,CAAC,iBAAiB,CAAC,MAAM,CAAC,GACjC,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,EAC/B,CAAC;AACL,CAAC,CAAC;AAEF,MAAM,wBAAwB,GAAG,CAAC,EAChC,IAAI,EACJ,UAAU,EACV,aAAa,EACY,EAA8B,EAAE;IACzD,KAAK,IAAI,KAAK,GAAG,UAAU,CAAC,MAAM,GAAG,CAAC,EAAE,KAAK,IAAI,CAAC,EAAE,KAAK,EAAE,EAAE,CAAC;QAC5D,MAAM,GAAG,GAAG,UAAU,CAAC,KAAK,CAAC,CAAC;QAC9B,MAAM,IAAI,GAAG,aAAa,CAAC,eAAe,CAAC,GAAG,CAAC,CAAC;QAChD,IAAI,IAAI,KAAK,QAAQ,IAAI,IAAI,KAAK,MAAM,EAAE,CAAC;YACzC,OAAO,UAAU,CAAC,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,EAAE,OAAO,EAAE,aAAa,CAAC,aAAa,EAAE,GAAG,EAAE,IAAI,CAAC,EAAE,CAAC,CAAC;QAChG,CAAC;IACH,CAAC;IAED,OAAO,SAAS,CAAC;AACnB,CAAC,CAAC;AAEF,MAAM,cAAc,GAAG,CAAC,EACtB,IAAI,EACJ,UAAU,EACV,aAAa,EACY,EAA8B,EAAE;IACzD,MAAM,OAAO,GAAG,UAAU,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;IAClC,IAAI,CAAC,OAAO,IAAI,CAAC,aAAa,CAAC,eAAe,CAAC,OAAO,CAAC,EAAE,CAAC;QACxD,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,OAAO,gBAAgB,CAAC,IAAI,EAAE,QAAQ,EAAE,OAAO,EAAE,aAAa,CAAC,CAAC;AAClE,CAAC,CAAC;AAEF,MAAM,mBAAmB,GAAG,CAAC,EAC3B,MAAM,EACN,IAAI,EACJ,QAAQ,EACR,mBAAmB,EACM,EAA8B,EAAE;IACzD,MAAM,KAAK,GAAG,IAAA,6BAAkB,EAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;IACnD,IAAI,KAAK,KAAK,SAAS,IAAI,CAAC,OAAO,KAAK,KAAK,QAAQ,IAAI,OAAO,KAAK,KAAK,QAAQ,CAAC,EAAE,CAAC;QACpF,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,MAAM,KAAK,GAAG,mBAAmB,CAAC,YAAY,CAAC,IAAA,6CAAqB,EAAC,KAAsB,CAAC,CAAC,CAAC;IAC9F,IAAI,CAAC,KAAK,EAAE,CAAC;QACX,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,OAAO,UAAU,CAAC,IAAI,EAAE,QAAQ,EAAE,OAAO,EAAE,EAAE,OAAO,EAAE,mBAAmB,CAAC,aAAa,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;AACpG,CAAC,CAAC;AAEF,MAAM,qBAAqB,GAAG;IAC5B,aAAa;IACb,wBAAwB;IACxB,cAAc;IACd,mBAAmB;CACX,CAAC;AAEJ,MAAM,uBAAuB,GAAG,CACrC,MAA6B,EAC7B,IAAY,EACZ,aAA4B,EACZ,EAAE;IAClB,MAAM,SAAS,GAAG,kBAAkB,CAAC,IAAA,wBAAa,EAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;IACjE,IAAI,SAAS,EAAE,CAAC;QACd,OAAO,gBAAgB,CAAC,IAAI,EAAE,QAAQ,EAAE,SAAS,EAAE,aAAa,CAAC,CAAC;IACpE,CAAC;IAED,OAAO,UAAU,CAAC,IAAI,EAAE,QAAQ,EAAE,SAAS,CAAC,CAAC;AAC/C,CAAC,CAAC;AAXW,QAAA,uBAAuB,2BAWlC;AAEK,MAAM,uBAAuB,GAAG,CACrC,MAA6B,EAC7B,IAAY,EACZ,aAA4B,EAC5B,OAA4B,EAC5B,mBAAwC,EACxB,EAAE;IAClB,MAAM,QAAQ,GAAG,IAAA,wBAAa,EAAC,IAAI,CAAC,CAAC;IACrC,MAAM,OAAO,GAA6B;QACxC,MAAM;QACN,IAAI;QACJ,QAAQ;QACR,UAAU,EAAE,kBAAkB,CAAC,QAAQ,CAAC;QACxC,aAAa;QACb,OAAO;QACP,mBAAmB;KACpB,CAAC;IAEF,KAAK,MAAM,OAAO,IAAI,qBAAqB,EAAE,CAAC;QAC5C,MAAM,IAAI,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;QAC9B,IAAI,IAAI,EAAE,CAAC;YACT,OAAO,IAAI,CAAC;QACd,CAAC;IACH,CAAC;IAED,OAAO,UAAU,CAAC,IAAI,EAAE,QAAQ,EAAE,SAAS,CAAC,CAAC;AAC/C,CAAC,CAAC;AA1BW,QAAA,uBAAuB,2BA0BlC;AAEK,MAAM,cAAc,GAAG,CAC5B,MAA6B,EAC7B,aAAgC,EAChC,YAA+B,EAC/B,aAA4B,EAC5B,OAA4B,EAC5B,mBAAwC,EACtB,EAAE,CAAC;IACrB,GAAG,YAAY,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAA,+BAAuB,EAAC,MAAM,EAAE,IAAI,EAAE,aAAa,CAAC,CAAC;IACnF,GAAG,aAAa,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAA,+BAAuB,EAAC,MAAM,EAAE,IAAI,EAAE,aAAa,EAAE,OAAO,EAAE,mBAAmB,CAAC,CAAC;CACnH,CAAC;AAVW,QAAA,cAAc,kBAUzB"}