field-redactor 1.0.0 → 1.2.0

package/README.md

@@ -18,7 +18,7 @@ In many instances, redaction of sensitive data from log output is fairly straigh
 If this object is placed in a data set with many others, and only some of these objects contain PII, redaction becomes quite troublesome. One could redact all `value` fields from these objects - but this merely renders the log output useless for debugging or tracing, as all values are now redacted. The value of the `name` field determines whether or not the `value` field should be redacted. I often found myself writing custom logic to make this determination, which led to brittle code that was difficult to maintain. In the end I decided to write a new, highly configurable plug-and-play solution that could redact sensitive data in various manners while requiring only minor configuration tweaks. Enter FieldRedactor!
 
 ## Basic Usage
-Basic usage of the FieldRedactor is straightforward but not recommended. Object redaction can be performed either in-place or return the redacted object:
+Basic usage of the FieldRedactor is straightforward but not recommended. Object redaction can be performed either in-place or return the redacted object. If redactor is given a string, primitive, Date, function, or null/undefined value then it returns the value without modification.
 
 ```typescript
 import { FieldRedactor } from 'field-redactor';
@@ -27,15 +27,19 @@ const fieldRedactor = new FieldRedactor();
 
 // return redacted result
 const result = await fieldRedactor.redact(myJsonObject);
+const primitiveResult = await fieldRedactor.redact("foobar");
 console.log(myJsonObject); // { foo: "bar", fizz: null }
 console.log(result); // { foo: "REDACTED", fizz: null }
+console.log(primitiveResult); // "foobar"
 
 // redact in place
 await fieldRedactor.redactInPlace(myJsonObject);
 console.log(myJsonObject); // { foo: "REDACTED", fizz: null }
 ```
-> **Note:** `null` and `undefined` values are not redacted by default.
 
+> **Note:** `null`, `undefined`, `string`, `Date`, `Function`, and primitive value inputs are completely ignored.
+> 
+> **Note:** `null` and `undefined` values are not redacted by default.
 
 
 ## Customization
@@ -48,6 +52,7 @@ The true power of this tool comes from its customization. FieldRedactor can be c
 | `secretKeys`          | `RegExp[]`                     | `null`                         | Specifies which values at any level of the JSON object should be redacted. Objects are not deeply redacted, but primitive values in arrays are. If not specified, all values are considered secret. |
 | `deepSecretKeys`      | `RegExp[]`                     | `[]`                           | Specifies keys at any level of the JSON object to be deeply redacted. All values within matching objects are fully redacted unless matching a custom object. |
 | `fullSecretKeys`      | `RegExp[]`                     | `[]`                           | Specifies keys at any level of the JSON object to be stringified and fully redacted. Primarily used for objects and arrays. |
+| `deleteSecretKeys`      | `RegExp[]`                     | `[]`                           | Specifies keys at any level of the JSON object to be completely deleted. |
 | `customObjects`       | `CustomObject[]`               | `[]`                           | Specifies custom objects requiring fine-tuned redaction logic, such as referencing sibling keys. See the "Custom Objects" section for details. |
 | `ignoreBooleans`      | `boolean`                      | `false`                        | If `true`, booleans will not be redacted even if secret.               |
 | `ignoreNullOrUndefined` | `boolean`                   | `true`                         | If `true`, `null` and `undefined` values will not be redacted.        |
@@ -80,16 +85,14 @@ console.log(result);
 ```
 
 ### `secretKeys` Configuration
-Used to specify primitive that should be redacted. If none of `secretKeys`, `deepSecretKeys`, or `fullSecretKeys` specified then all values are considered secret. Users should almost always specify at least one of these three fields. Has the lowest precedence of all configurable secret fields.
+* Specifies values which should be redacted.
+* __All values are considered secret if no secrets of any type are specified.__
+* has lowest precedence of all secret specifiers.
 
 #### Details
 - **Type:** `RegExp[]`
-- **Default:** All values considered secret
-  - If `deepSecretKeys` or `fullSecretKeys` specified, defaults to `[]`
-- **Effect:** Matches keys in objects or child objects and redacts their values, if primitive. Arrays are processed recursively, with primitives redacted. 
-  - If the value is an object it will be assessed using the same logic, regardless of if its key value is a secret.
-  - if an array value is an object it will be assessed using the same logic, regardless of if its key value is a secret.
-  - Has lowest precedence when compared to `deepSecretKeys`, `fullSecretKeys`, and `customObjects` configurations.
+- **Default:** All values considered secret unless a secret field is specified.
+- **Effect:** Matches keys in objects, child objects, or array value primitives. Assessed recursively.
 
 #### Example
 ##### Code
@@ -103,14 +106,11 @@ const myJsonObject = {
     firstName: "Foo",
     lastName: "Bar",
     Salutation: "Mr.",
-    preference: "email",
-    lastUpdated: "2024-12-01T22:07:26.448Z"
   },
   someSecretData: ["fizz", "buzz", { deep: "is not redacted", name: "foobar" }],
-  hobbies: ["Basketball", "Baseball", "Tennis"]
 }
 const fieldRedactor = new FieldRedactor({
-  secretKeys: [/email/i, /name/i, /someSecretData/i, /contactInfo/i],
+  secretKeys: [/email/i, /name/i, /userid/i, /someSecretData/i],
 });
 const result = await fieldRedactor.redact(myJsonObject);
 console.log(result);
@@ -120,33 +120,31 @@ console.log(result);
 ```json
 {
   "timestamp": "2024-12-01T22:07:26.448Z",
-  "userId": 271,
+  "userId": "REDACTED",
   "contactInfo": {
     "email": "REDACTED",
     "firstName": "REDACTED",
     "lastName": "REDACTED",
     "Salutation": "Mr.",
-    "preference": "email",
-    "lastUpdated": "2024-12-01T22:07:26.448Z"
   },
-  "someSecretData": ["REDACTED", "REDACTED", { "deep": "is not redacted", "name": "REDACTED" }],
-  "hobbies": ["Basketball", "Baseball", "Tennis"]
+  "someSecretData": ["REDACTED", "REDACTED", { "deep": "is not redacted", "name": "REDACTED" }]
 }
 ```
 
-> - contactInfo was not redacted despite being a RegExp match as it is not a primitive.
-> - `email`, `firstName`, and `lastName` fields were redacted in contactInfo as they matched RegExes
-> - primitives in `someSecretData` array value were redacted
-> - object in `someSecretData` was evaluated separate from primitives in the same array
+> - `email` and `name` fields were all redacted
+> - primitives in `someSecretData` array were redacted
+> - object values in `someSecretData` was evaluated and redacted if applicable
 
 ### `deepSecretKeys` Configuration
-Used to specify secrets which should be deeply redacted. Values which are objects or arrays will have all their values redacted, including child objects and arrays, unless identified as a `fullSecretKey` or `customObject` which take higher precedence.
+* Specifies values which should be deeply redacted
+* Has higher precedence than `secretKeys`
+* All children of the key will have their values redacted unless `fullSecretKey` or `customObject` has precedence.
 
 #### Details
 - **Type:** `RegExp[]`
 - **Default:** `[]`
 - **Effect:** Matches keys in objects or child objects and deeply redacts all values, including values in child objects or objects within arrays. 
-  - Has higher precedence than `secretKeys` but lower precedence than `fullSecretKeys` and `customObjects`.
+  - _Note: has higher precedence than `secretKeys`._
 
 #### Example
 ##### Code
@@ -160,16 +158,11 @@ const myJsonObject = {
     firstName: "Foo",
     lastName: "Bar",
     Salutation: "Mr.",
-    preference: "email",
-    lastUpdated: "2024-12-01T22:07:26.448Z",
     lastUpdatedBy: {
-      firstName: "John",
-      lastName: "Doe",
-      id: "12345"
+      id: 1
     }
   },
-  someSecretData: ["fizz", "buzz", { deep: "FOO", name: "BAR" }],
-  hobbies: ["Basketball", "Baseball", "Tennis", {contactInfo: "foobar"}]
+  someSecretData: ["fizz", "buzz", { deep: "FOO", name: "BAR" }]
 }
 const fieldRedactor = new FieldRedactor({
   deepSecretKeys: [/someSecretData/i, /contactInfo/i]
@@ -188,28 +181,24 @@ console.log(result);
     "firstName": "REDACTED",
     "lastName": "REDACTED",
     "Salutation": "REDACTED",
-    "preference": "REDACTED",
-    "lastUpdated": "REDACTED",
     "lastUpdatedBy": {
-      "firstName": "REDACTED",
-      "lastName": "REDACTED",
       "id": "REDACTED"
     }
   },
-  "someSecretData": ["REDACTED", "REDACTED", { "deep": "REDACTED", "name": "REDACTED" }],
-  "hobbies": ["Basketball", "Baseball", "Tennis", { "contactInfo": "REDACTED" }]
+  "someSecretData": ["REDACTED", "REDACTED", { "deep": "REDACTED", "name": "REDACTED" }]
 }
 ```
-> - All values in `contactInfo` were redacted, including deep children
-> - All values in `someSecretData` were redacted, including object values
+> - All values in `contactInfo` were redacted
+> - All values in `someSecretData` were redacted
 
 ### `fullSecretKeys` Configuration
-Specifies values which should be stringified and passed to the redactor function. Has higher precedence than other secret types but lower precedence than `customObjects`. However, if value is stringified and contains a child object which is a custom object then it will, by definition, not be noticed.
+* Specifies values which should be stringified and redacted
+  * _Note: has higher precedence than `secretKeys` and `deepSecretKeys`_
 
 #### Details
 - **Type:** `RegExp[]`
 - **Default:** `[]`
-- **Effect:** Matches keys in objects or child objects and stringifies and fully redacts their values. 
+- **Effect:** Matches keys and stringifies + redacts their values. 
   - Has higher precedence than `secretKeys` and `deepSecretKeys` but lower precedence than `customObjects`.
 
 #### Example
@@ -227,12 +216,10 @@ const myJsonObject = {
     Salutation: "Mr.",
     preference: "email",
     lastUpdated: "2024-12-01T22:07:26.448Z"
-  },
-  someSecretData: ["fizz", "buzz", { deep: "foo", name: "bar" }],
-  hobbies: ["Basketball", "Baseball", "Tennis"]
+  }
 }
 const fieldRedactor = new FieldRedactor({
-  fullSecretKeys: [/someSecretData/i, /contactInfo/i],
+  fullSecretKeys: [/someSecretData/i],
 });
 const result = await fieldRedactor.redact(myJsonObject);
 console.log(result);
@@ -243,26 +230,58 @@ console.log(result);
 {
   "timestamp": "2024-12-01T22:07:26.448Z",
   "userId": 271,
-  "contactInfo": "REDACTED",
-  "someSecretData": "REDACTED",
-  "hobbies": ["Basketball", "Baseball", "Tennis"]
+  "contactInfo": "REDACTED"
 }
 ```
 > - Entirity of `contactInfo` was redacted.
-> - Entirity of `someSecretData` was redacted.
+
+### `deleteSecretKeys` Configuration
+* Specifies values which should be completely deleted.
+
+#### Details
+- **Type:** `RegExp[]`
+- **Default:** `[]`
+- **Effect:** Matches keys and deletes them from output.
+  - Has lower precedence than `customObjects` 
+
+#### Example
+##### Code
+```typescript
+import { FieldRedactor } from 'field-redactor';
+
+const myJsonObject = {
+  timestamp: "2024-12-01T22:07:26.448Z",
+  userId: 271,
+  appAuthKey: "12345-67890"
+}
+const fieldRedactor = new FieldRedactor({
+  deleteSecretKeys: [/authKey/i],
+});
+const result = await fieldRedactor.redact(myJsonObject);
+console.log(result);
+```
+
+##### Output
+```json
+{
+  "timestamp": "2024-12-01T22:07:26.448Z",
+  "userId": 271
+}
+```
+> - `appAuthKey` was deleted
 
 ### `customObjects` Configuration
-**One of the most powerful features of this library and why it was written in the first place.** Combining `secretKeys`, `deepSecretKeys`, `fullSecretKeys`, and `customObjects` yields a powerful and highly customizable redaction tool capable of conditionally redacting a broad variety of input JSON objects correctly according to a single schema configuration.
+* **One of the most powerful features of this library and why it was written in the first place.** 
+* Combining CustomObjects with secrets yields a powerful and highly customizable redaction tool capable of conditionally redacting a broad variety of input JSON objects correctly according to a user-specified schema.
 
 #### Details
 - **Type:** `CustomObject` (See `CustomObject` Schema Section)
 - **Default:** `[]`
-- **Effect:** Any object that matches the schema will be considered a custom object and redacted based on the schema configuration.
-  - Priority supercedes all others. If a `CustomObject` is nested inside a `deepSecretKey` value then the `CustomObject` configuration takes precedence.
-  - If a `CustomObject` is found inside another `CustomObject` then the new `CustomObject` takes precedence.
+- **Effect:** Any object that matches the schema will be redacted based on its schema.
+  - _Note: has highest precedence_
+  - -_Note: If a custom object is nested inside another, the child takes precedence_
 
 #### `CustomObject` Schema
-A custom object takes the following format:
 ```typescript
 {
   [key]: CustomObjectMatchType | string
@@ -271,91 +290,98 @@ A custom object takes the following format:
 
 - `key`
   - **Type:** `string`
-  - **Effect:** Specifies the key for a custom object
+  - **Effect:** Specifies the key to match on.
 - `value`:
   - **Type:** `CustomObjectMatchType | string`
   - **Effect:** Specifies how the value should be redacted
-    - `string` - checks if the sibling key with this name has a value which is a `secretKey`, `deepSecretKey`, or `fullSecretKey` and redacts accordingly
-    - `CustomObjectMatchType` - Redacts according to the match type. See `CustomObjectMatchType` Enum Section.
+    - `string` - checks if a sibling key with this name exists and contains a secret value. If so, redacts according to the secret specifier.
+    - `CustomObjectMatchType` - Redacts according to the match type.
 
 
 #### `CustomObjectMatchType` Enum
+Specifies how a value should be redacted in a CustomObject if not using a `string` sibling specifier.
+
 | Key | Description |
 | --- | ----------- |
-| `Full` | Stringify value and redact. Functions identical to `fullSecretKeys`. |
-| `Deep` | Redact if primitive, deeply redact all values and children if object or array. Functions identical to `deepSecretKeys`. |
-| `Shallow` | Redact if primitive or array of primitives and revery to normal evaluation if object or array contains object. Functions identical to `secretKeys`. |
-| `Pass` | Do not redact if primitive value and revert to normal rules if an object. |
-| `Ignore` | Do not redact if primitive and skip evaluation entirely if object or array. |
+| `Delete` | Delete the value from the result. |
+| `Full` | Stringify value and redact. |
+| `Deep` | Redact if primitive and deeply redact if object or array. |
+| `Shallow` | Redact if primitive or array of primitives and revert to normal rules otherwise, including objects in arrays. |
+| `Pass` | Do not redact, but revert to normal rules for child objects or objects in arrays. |
+| `Ignore` | Skip evaluation entirely. |
 
 #### Example
 ```typescript
-import { FieldRedactor } from 'field-redactor';
+import { FieldRedactor, CustomObjectMatchType } from 'field-redactor';
 
-const myCustomObject = {
-  name: CustomObjectMatchType.Ignore,
-  type: CustomObjectMatchType.Ignore,
-  significance: CustomObjectMatchType.Ignore,
-  shallowValue: "name",
-  deepValue: "type",
-  fullValue: "significance"
+const myCustomObject1 = {
   shallow: CustomObjectMatchType.Shallow,
   deep: CustomObjectMatchType.Deep,
   full: CustomObjectMatchType.Full,
+  delete: CustomObjectMatchType.Delete
   pass: CustomObjectMatchType.Pass,
   ignore: CustomObjectMatchType.Ignore
 };
 
+const myCustomObject2 = {
+  name: CustomObjectMatchType.Ignore,
+  type: CustomObjectMatchType.Ignore,
+  shallowValue: "name",
+  deepValue: "type",
+}
+
 const myJsonObject = {
   timestamp: "2024-12-01T22:07:26.448Z",
   userId: 271,
   data: [
     {
-      name: "email",
-      type: "Secure",
-      significance: "meta"
-      shallowValue: "foo.bar@example.com",
-      deepValue: "foobar",
-      fullValue: "hello",
       shallow: "hello",
       deep: "hello",
       full: "hello",
+      delete: "hello",
       pass: "hello",
       ignore: "hello"
     },
     {
       name: "email",
       type: "Secure",
-      significance: "meta",
-      shallowValue: {
+      shallowValue: "foo.bar@example.com",
+      deepValue: "foobar",
+    },
+    {
+      shallow: {
         hello: "world",
         email: "foobar"
       },
-      deepValue: {
+      deep: {
         hello: "world",
         email: "foobar"
       },
-      deepValue: {
+      full: {
         hello: "world",
         email: "foobar"
       },
-      shallow: {
+      delete: {
         hello: "world",
         email: "foobar"
       },
-      deep: {
+      pass: {
         hello: "world",
         email: "foobar"
       },
-      full: {
+      ignore: {
         hello: "world",
         email: "foobar"
-      },
-      pass: {
+      }
+    }
+    {
+      name: "email",
+      type: "Secure",
+      shallowValue: {
         hello: "world",
         email: "foobar"
       },
-      ignore: {
+      deepValue: {
         hello: "world",
         email: "foobar"
       }
@@ -366,7 +392,7 @@ const fieldRedactor = new FieldRedactor({
   secretKeys: [/email/],
   deepSecretKeys: [/secure/i],
   fullSecretKeys: [/meta/i],
-  customObjects: [myCustomObject]
+  customObjects: [myCustomObject1, myCustomObject2]
 });
 const result = await fieldRedactor.redact(myJsonObject);
 console.log(result);
@@ -379,11 +405,6 @@ console.log(result);
   "userId": 271,
   "data": [
     {
-      "name": "email",
-      "type": "Secure",
-      "shallowValue": "REDACTED",
-      "deepValue": "REDACTED",
-      "fullValue": "REDACTED",
       "shallow": "REDACTED",
       "deep": "REDACTED",
       "full": "REDACTED",
@@ -393,15 +414,10 @@ console.log(result);
     {
       "name": "email",
       "type": "Secure",
-      "shallowValue": {
-        "hello": "world",
-        "email": "REDACTED"
-      },
-      "deepValue": {
-        "hello": "REDACTED",
-        "email": "REDACTED"
-      },
-      "fullValue": "REDACTED",
+      "shallowValue": "REDACTED",
+      "deepValue": "REDACTED"
+    },
+    {
       "shallow": {
         "hello": "world",
         "email": "REDACTED"
@@ -420,14 +436,22 @@ console.log(result);
         "email": "foobar"
       }
     }
+    {
+      "name": "email",
+      "type": "Secure",
+      "shallowValue": {
+        "hello": "world",
+        "email": "REDACTED"
+      },
+      "deepValue": {
+        "hello": "REDACTED",
+        "email": "REDACTED"
+      }
+    }
   ]
-};
+}
 ```
-> - Both objects in the data array matched the custom object and were redacted accordingly
->   - The first object contains only primitives whereas the second contains objects to highlight the differences
-> - `name` and `type` field were never redacted in either object because `CustomObjectMatchType` was `Ignore`
-> - `shallowValue`, `deepValue`, and `fullValue` had string key specifiers which matched a `shallowKey`, `deepSecretKey`, and `fullSecretKey`, respectively, and were redacted according to those rules.
-> - `shallow`, `deep`, `full`, `pass`, and `ignore` fields were redacted according to their `CustomObjectMatchType` value specified in the schema. 
+>  - Example shows both primitives and objects to highlight differences
 
 ### `ignoreBooleans` Configuration
 - **Type:** `boolean`
@@ -517,6 +541,7 @@ const fieldRedactor: FieldRedactor = new FieldRedactor({
   redactor: myRedactor,
   secretKeys: [/email/, /name/i, /someSecretData/, /children/],
   deepSecretKeys: [/accountInfo/i, /someDeepSecretData/i, /privateInfo/i],
+  deleteSecretKeys: [/authKey/i],
   customObjects: [metadataCustomObject, actionsCustomObject],
   ignoreNullOrUndefined: false
 });
@@ -524,6 +549,7 @@ const fieldRedactor: FieldRedactor = new FieldRedactor({
 const myJsonObjectToRedact = {
   timestamp: "2024-12-01T22:07:26.448Z",
   userId: 271,
+  authKey: 12345,
   contactInfo: {
     email: "foo.bar@example.com",
     salutation: "Mr.",

package/dist/{customObjectChecker.d.ts → customObjectManager.d.ts}

@@ -2,7 +2,7 @@ import { CustomObject } from './types';
 /**
  * Utility for determining if a given object matches a CustomObject schema.
  */
-export declare class CustomObjectChecker {
+export declare class CustomObjectManager {
     private customObjects;
     /**
      * Creates a CustomObjectChecker with the specified CustomObjects.
@@ -16,7 +16,7 @@ export declare class CustomObjectChecker {
      */
     getMatchingCustomObject(value: any): CustomObject | undefined;
     private isCustomObject;
-    private customObjectDoesNotHaveExtraKeys;
+    private objectHasExtraKeys;
     private validateCustomObjects;
 }
-//# sourceMappingURL=customObjectChecker.d.ts.map
+//# sourceMappingURL=customObjectManager.d.ts.map

package/dist/customObjectManager.d.ts.map

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

package/dist/{customObjectChecker.js → customObjectManager.js}

@@ -1,11 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.CustomObjectChecker = void 0;
+exports.CustomObjectManager = void 0;
 const errors_1 = require("./errors");
 /**
  * Utility for determining if a given object matches a CustomObject schema.
  */
-class CustomObjectChecker {
+class CustomObjectManager {
     /**
      * Creates a CustomObjectChecker with the specified CustomObjects.
      * @param customObjects The CustomObjects to check against.
@@ -32,23 +32,10 @@ class CustomObjectChecker {
         if (typeof value !== 'object' || !value || Array.isArray(value)) {
             return false;
         }
-        if (!this.customObjectDoesNotHaveExtraKeys(value, customObject)) {
-            return false;
-        }
-        for (const key of Object.keys(value)) {
-            if (!customObject.hasOwnProperty(key)) {
-                return false;
-            }
-        }
-        return true;
+        return !this.objectHasExtraKeys(customObject, value) && !this.objectHasExtraKeys(value, customObject);
     }
-    customObjectDoesNotHaveExtraKeys(value, customObject) {
-        for (const key of Object.keys(customObject)) {
-            if (!value.hasOwnProperty(key)) {
-                return false;
-            }
-        }
-        return true;
+    objectHasExtraKeys(object, objectToCompareTo) {
+        return Object.keys(object).some((key) => !objectToCompareTo.hasOwnProperty(key));
     }
     validateCustomObjects(customObjects) {
         if (!customObjects || customObjects.length <= 1) {
@@ -68,5 +55,5 @@ class CustomObjectChecker {
         }
     }
 }
-exports.CustomObjectChecker = CustomObjectChecker;
-//# sourceMappingURL=customObjectChecker.js.map
+exports.CustomObjectManager = CustomObjectManager;
+//# sourceMappingURL=customObjectManager.js.map

package/dist/customObjectManager.js.map

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

package/dist/errors.d.ts

@@ -11,10 +11,4 @@ export declare class FieldRedactorError extends Error {
 export declare class FieldRedactorConfigurationError extends FieldRedactorError {
     constructor(message: string);
 }
-/**
- * Error thrown when the input value to the FieldRedactor fails validation, such as not being a JSON object.
- */
-export declare class FieldRedactorValidationError extends FieldRedactorError {
-    constructor(message: string);
-}
 //# sourceMappingURL=errors.d.ts.map

package/dist/errors.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../src/errors.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,qBAAa,kBAAmB,SAAQ,KAAK;gBAC/B,OAAO,EAAE,MAAM;CAI5B;AAED;;;GAGG;AACH,qBAAa,+BAAgC,SAAQ,kBAAkB;gBACzD,OAAO,EAAE,MAAM;CAI5B;AAED;;GAEG;AACH,qBAAa,4BAA6B,SAAQ,kBAAkB;gBACtD,OAAO,EAAE,MAAM;CAI5B"}
+{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../src/errors.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,qBAAa,kBAAmB,SAAQ,KAAK;gBAC/B,OAAO,EAAE,MAAM;CAI5B;AAED;;;GAGG;AACH,qBAAa,+BAAgC,SAAQ,kBAAkB;gBACzD,OAAO,EAAE,MAAM;CAI5B"}

package/dist/errors.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.FieldRedactorValidationError = exports.FieldRedactorConfigurationError = exports.FieldRedactorError = void 0;
+exports.FieldRedactorConfigurationError = exports.FieldRedactorError = void 0;
 /**
  * Top-Level Field Redactor error thrown when there is an error redacting a JSON object.
  */
@@ -22,14 +22,4 @@ class FieldRedactorConfigurationError extends FieldRedactorError {
     }
 }
 exports.FieldRedactorConfigurationError = FieldRedactorConfigurationError;
-/**
- * Error thrown when the input value to the FieldRedactor fails validation, such as not being a JSON object.
- */
-class FieldRedactorValidationError extends FieldRedactorError {
-    constructor(message) {
-        super(message);
-        this.name = 'FieldRedactorValidationError';
-    }
-}
-exports.FieldRedactorValidationError = FieldRedactorValidationError;
 //# sourceMappingURL=errors.js.map

package/dist/errors.js.map

@@ -1 +1 @@
-{"version":3,"file":"errors.js","sourceRoot":"","sources":["../src/errors.ts"],"names":[],"mappings":";;;AAAA;;GAEG;AACH,MAAa,kBAAmB,SAAQ,KAAK;IAC3C,YAAY,OAAe;QACzB,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,IAAI,CAAC,IAAI,GAAG,oBAAoB,CAAC;IACnC,CAAC;CACF;AALD,gDAKC;AAED;;;GAGG;AACH,MAAa,+BAAgC,SAAQ,kBAAkB;IACrE,YAAY,OAAe;QACzB,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,IAAI,CAAC,IAAI,GAAG,iCAAiC,CAAC;IAChD,CAAC;CACF;AALD,0EAKC;AAED;;GAEG;AACH,MAAa,4BAA6B,SAAQ,kBAAkB;IAClE,YAAY,OAAe;QACzB,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,IAAI,CAAC,IAAI,GAAG,8BAA8B,CAAC;IAC7C,CAAC;CACF;AALD,oEAKC"}
+{"version":3,"file":"errors.js","sourceRoot":"","sources":["../src/errors.ts"],"names":[],"mappings":";;;AAAA;;GAEG;AACH,MAAa,kBAAmB,SAAQ,KAAK;IAC3C,YAAY,OAAe;QACzB,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,IAAI,CAAC,IAAI,GAAG,oBAAoB,CAAC;IACnC,CAAC;CACF;AALD,gDAKC;AAED;;;GAGG;AACH,MAAa,+BAAgC,SAAQ,kBAAkB;IACrE,YAAY,OAAe;QACzB,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,IAAI,CAAC,IAAI,GAAG,iCAAiC,CAAC;IAChD,CAAC;CACF;AALD,0EAKC"}

package/dist/fieldRedactor.d.ts

@@ -11,15 +11,18 @@ export declare class FieldRedactor {
     /**
      * Conditionally redacts fields in the JSON object based on the configuration provided in the constructor and returns the
      * redacted result.
-     * @param value The JSON value to redact.
+     * 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: any): Promise<any>;
     /**
      * Conditionally redacts fields in the JSON object in place based on the configuration provided in the constructor.
-     * @param value The JSON value to redact in place.
+     * 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.
      */
     redactInPlace(value: any): Promise<void>;
-    private validateInput;
+    private isPrimitiveOrUndefined;
 }
 //# sourceMappingURL=fieldRedactor.d.ts.map

package/dist/fieldRedactor.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"fieldRedactor.d.ts","sourceRoot":"","sources":["../src/fieldRedactor.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,mBAAmB,EAAE,MAAM,SAAS,CAAC;AAO9C;;;;GAIG;AACH,qBAAa,aAAa;IACxB,OAAO,CAAC,QAAQ,CAAwC;IACxD,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAiB;gBACpC,MAAM,CAAC,EAAE,mBAAmB;IA4BxC;;;;;OAKG;IACU,MAAM,CAAC,KAAK,EAAE,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC;IAK7C;;;OAGG;IACU,aAAa,CAAC,KAAK,EAAE,GAAG,GAAG,OAAO,CAAC,IAAI,CAAC;IASrD,OAAO,CAAC,aAAa;CAKtB"}
+{"version":3,"file":"fieldRedactor.d.ts","sourceRoot":"","sources":["../src/fieldRedactor.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,mBAAmB,EAAE,MAAM,SAAS,CAAC;AAO9C;;;;GAIG;AACH,qBAAa,aAAa;IACxB,OAAO,CAAC,QAAQ,CAAwC;IACxD,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAiB;gBACpC,MAAM,CAAC,EAAE,mBAAmB;IAyBxC;;;;;;OAMG;IACU,MAAM,CAAC,KAAK,EAAE,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC;IAK7C;;;;;OAKG;IACU,aAAa,CAAC,KAAK,EAAE,GAAG,GAAG,OAAO,CAAC,IAAI,CAAC;IAYrD,OAAO,CAAC,sBAAsB;CAG/B"}