@trayio/commons 4.56.0 → 4.58.0

package/dist/codec/SensitiveRemoveTagAndRedactCodec.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"SensitiveRemoveTagAndRedactCodec.d.ts","sourceRoot":"","sources":["../../src/codec/SensitiveRemoveTagAndRedactCodec.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,kBAAkB,CAAC;AACtC,OAAO,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AAEhC,qBAAa,gCAAiC,YAAW,KAAK,CAAC,OAAO,CAAC;IAC1D,OAAO,CAAC,YAAY;gBAAZ,YAAY,GAAE,OAAe;IAEjD,MAAM,CAAC,QAAQ,CAAC,YAAY,UAAQ,GAAG,KAAK,CAAC,OAAO,CAAC;IAIrD,MAAM,CAAC,KAAK,EAAE,OAAO,GAAG,OAAO;IAI/B,MAAM,CAAC,KAAK,EAAE,OAAO,GAAG,CAAC,CAAC,MAAM,CAAC,KAAK,EAAE,OAAO,CAAC;IAIhD,OAAO,CAAC,QAAQ;IAIhB,OAAO,CAAC,sBAAsB;IAa9B,OAAO,CAAC,8BAA8B;IAStC,OAAO,CAAC,+BAA+B;CAyCvC"}
+{"version":3,"file":"SensitiveRemoveTagAndRedactCodec.d.ts","sourceRoot":"","sources":["../../src/codec/SensitiveRemoveTagAndRedactCodec.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,kBAAkB,CAAC;AAEtC,OAAO,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AAEhC,qBAAa,gCAAiC,YAAW,KAAK,CAAC,OAAO,CAAC;IAC1D,OAAO,CAAC,YAAY;gBAAZ,YAAY,GAAE,OAAe;IAEjD,MAAM,CAAC,QAAQ,CAAC,YAAY,UAAQ,GAAG,KAAK,CAAC,OAAO,CAAC;IAIrD,MAAM,CAAC,KAAK,EAAE,OAAO,GAAG,OAAO;IAI/B,MAAM,CAAC,KAAK,EAAE,OAAO,GAAG,CAAC,CAAC,MAAM,CAAC,KAAK,EAAE,OAAO,CAAC;IAIhD,OAAO,CAAC,QAAQ;IAIhB,OAAO,CAAC,sBAAsB;IAa9B,OAAO,CAAC,8BAA8B;IAStC,OAAO,CAAC,+BAA+B;CAyCvC"}

package/dist/codec/SensitiveRemoveTagAndRedactCodec.js

@@ -25,6 +25,7 @@ var __importStar = (this && this.__importStar) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SensitiveRemoveTagAndRedactCodec = void 0;
 const E = __importStar(require("fp-ts/lib/Either"));
+const lodash_1 = require("lodash");
 class SensitiveRemoveTagAndRedactCodec {
     redactValues;
     constructor(redactValues = false) {
@@ -37,10 +38,10 @@ class SensitiveRemoveTagAndRedactCodec {
         return this.stripTagAndRedactValue(value);
     }
     decode(value) {
-        return E.right(this.stripTagAndRedactValue(value));
+        return E.right(value);
     }
     isObject(value) {
-        return typeof value === 'object' && !Array.isArray(value) && value !== null;
+        return (0, lodash_1.isPlainObject)(value);
     }
     stripTagAndRedactValue(value) {
         if (value === null) {

package/dist/codec/SensitiveRemoveTagAndRedactCodec.unit.test.js

@@ -98,11 +98,15 @@ describe('SensitiveRemoveTagAndRedactCodec', () => {
         };
         expect(actualValue).toStrictEqual(expectedValue);
     });
-    it('should redact sensitive typed data in nested optional objects', () => {
+    it('should redact sensitive typed data in nested optional objects when redact values is true', () => {
+        const dob = new Date();
+        const creationDate = new Date();
         const value = {
             user: {
                 password: Sensitive_1.Sensitive.fromValue(O.some('test')),
                 username: 'username',
+                dob: Sensitive_1.Sensitive.fromValue(dob),
+                creationDate,
             },
         };
         const actualValue = SensitiveRemoveTagAndRedactCodec_1.SensitiveRemoveTagAndRedactCodec.instance(true).encode(value);
@@ -110,15 +114,21 @@ describe('SensitiveRemoveTagAndRedactCodec', () => {
             user: {
                 password: '<REDACTED>',
                 username: 'username',
+                dob: '<REDACTED>',
+                creationDate,
             },
         };
         expect(actualValue).toStrictEqual(expectedValue);
     });
     it('should not redact sensitive typed data in nested optional objects when redact values is false', () => {
+        const dob = new Date();
+        const creationDate = new Date();
         const value = {
             user: {
                 password: Sensitive_1.Sensitive.fromValue(O.some('test')),
                 username: 'username',
+                dob: Sensitive_1.Sensitive.fromValue(dob),
+                creationDate,
             },
         };
         const actualValue = SensitiveRemoveTagAndRedactCodec_1.SensitiveRemoveTagAndRedactCodec.instance(false).encode(value);
@@ -126,6 +136,8 @@ describe('SensitiveRemoveTagAndRedactCodec', () => {
             user: {
                 password: O.some('test'),
                 username: 'username',
+                dob,
+                creationDate,
             },
         };
         expect(actualValue).toStrictEqual(expectedValue);
@@ -148,7 +160,7 @@ describe('SensitiveRemoveTagAndRedactCodec', () => {
                 })),
             }),
         };
-        const redactAndTypeDecode = CompositeCodec_1.CompositeCodec.fromCodecs(Sensitive_unit_test_1.testTypeSensitiveCodec, SensitiveRemoveTagAndRedactCodec_1.SensitiveRemoveTagAndRedactCodec.instance(true));
+        const redactAndTypeDecode = Sensitive_unit_test_1.testTypeSensitiveRedactionCodec;
         const result = redactAndTypeDecode.encode(testValueEncoded);
         const expected = {
             strField: 'str',

package/dist/codec/TypeCodec.d.ts

@@ -2,7 +2,7 @@ import * as E from 'fp-ts/lib/Either';
 import * as t from 'io-ts';
 import { Codec } from './Codec';
 export declare class TypeCodec<T> implements Codec<T> {
-    static fromDescriptor<T>(descriptor: t.Type<T, unknown>): Codec<T>;
+    static fromDescriptor<T>(descriptor: t.Type<T, unknown>, redactValues?: boolean): Codec<T>;
     static undefined: Codec<undefined>;
     static unknown: Codec<unknown>;
     static emptyRecord: Codec<{}>;

package/dist/codec/TypeCodec.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"TypeCodec.d.ts","sourceRoot":"","sources":["../../src/codec/TypeCodec.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,kBAAkB,CAAC;AACtC,OAAO,KAAK,CAAC,MAAM,OAAO,CAAC;AAK3B,OAAO,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AAEhC,qBAAa,SAAS,CAAC,CAAC,CAAE,YAAW,KAAK,CAAC,CAAC,CAAC;IAC5C,MAAM,CAAC,cAAc,CAAC,CAAC,EAAE,UAAU,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,EAAE,OAAO,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC;IAIlE,MAAM,CAAC,SAAS,EAAE,KAAK,CAAC,SAAS,CAAC,CAEhC;IAEF,MAAM,CAAC,OAAO,EAAE,KAAK,CAAC,OAAO,CAAC,CAAgD;IAC9E,MAAM,CAAC,WAAW,EAAE,KAAK,CAAC,EAAE,CAAC,CAA4C;IACzE,MAAM,CAAC,YAAY,EAAE,KAAK,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAElB;IAIhC,MAAM,CAAC,aAAa,oHAGoB;IAExC,OAAO,CAAC,UAAU,CAAqB;IAEvC,OAAO;IAIP,MAAM,CAAC,KAAK,EAAE,CAAC,GAAG,OAAO;IAIzB,MAAM,CAAC,KAAK,EAAE,OAAO,GAAG,CAAC,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC;CAQ1C"}
+{"version":3,"file":"TypeCodec.d.ts","sourceRoot":"","sources":["../../src/codec/TypeCodec.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,kBAAkB,CAAC;AACtC,OAAO,KAAK,CAAC,MAAM,OAAO,CAAC;AAK3B,OAAO,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AAIhC,qBAAa,SAAS,CAAC,CAAC,CAAE,YAAW,KAAK,CAAC,CAAC,CAAC;IAC5C,MAAM,CAAC,cAAc,CAAC,CAAC,EACtB,UAAU,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,EAAE,OAAO,CAAC,EAC9B,YAAY,GAAE,OAAe,GAC3B,KAAK,CAAC,CAAC,CAAC;IAOX,MAAM,CAAC,SAAS,EAAE,KAAK,CAAC,SAAS,CAAC,CAEhC;IAEF,MAAM,CAAC,OAAO,EAAE,KAAK,CAAC,OAAO,CAAC,CAAgD;IAC9E,MAAM,CAAC,WAAW,EAAE,KAAK,CAAC,EAAE,CAAC,CAA4C;IACzE,MAAM,CAAC,YAAY,EAAE,KAAK,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAElB;IAIhC,MAAM,CAAC,aAAa,oHAGoB;IAExC,OAAO,CAAC,UAAU,CAAqB;IAEvC,OAAO;IAIP,MAAM,CAAC,KAAK,EAAE,CAAC,GAAG,OAAO;IAIzB,MAAM,CAAC,KAAK,EAAE,OAAO,GAAG,CAAC,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC;CAQ1C"}

package/dist/codec/TypeCodec.js

@@ -32,9 +32,11 @@ const t = __importStar(require("io-ts"));
 const io_ts_reporters_1 = __importDefault(require("io-ts-reporters"));
 const Record_1 = require("fp-ts/Record");
 const function_1 = require("fp-ts/function");
+const CompositeCodec_1 = require("./CompositeCodec");
+const SensitiveRemoveTagAndRedactCodec_1 = require("./SensitiveRemoveTagAndRedactCodec");
 class TypeCodec {
-    static fromDescriptor(descriptor) {
-        return new TypeCodec(descriptor);
+    static fromDescriptor(descriptor, redactValues = false) {
+        return CompositeCodec_1.CompositeCodec.fromCodecs(new TypeCodec(descriptor), SensitiveRemoveTagAndRedactCodec_1.SensitiveRemoveTagAndRedactCodec.instance(redactValues));
     }
     static undefined = TypeCodec.fromDescriptor(t.undefined);
     static unknown = TypeCodec.fromDescriptor(t.unknown);

package/dist/sensitive/Sensitive.unit.test.d.ts

@@ -14,5 +14,6 @@ export type TestTypeSensitive = {
         }>>;
     }>;
 };
+export declare const testTypeSensitiveRedactionCodec: Codec<TestTypeSensitive>;
 export declare const testTypeSensitiveCodec: Codec<TestTypeSensitive>;
 //# sourceMappingURL=Sensitive.unit.test.d.ts.map

package/dist/sensitive/Sensitive.unit.test.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Sensitive.unit.test.d.ts","sourceRoot":"","sources":["../../src/sensitive/Sensitive.unit.test.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,CAAC,MAAM,cAAc,CAAC;AAElC,OAAO,EAAE,KAAK,EAAE,MAAM,gBAAgB,CAAC;AAEvC,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAExC,MAAM,MAAM,iBAAiB,GAAG;IAC/B,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,SAAS,CAAC,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC;IACtC,WAAW,EAAE,SAAS,CAAC;QACtB,GAAG,EAAE,MAAM,CAAC;QACZ,GAAG,EAAE,MAAM,CAAC;QACZ,WAAW,EAAE,SAAS,CACrB,CAAC,CAAC,MAAM,CAAC;YACR,IAAI,EAAE,MAAM,CAAC;YACb,KAAK,EAAE,MAAM,CAAC;YACd,SAAS,EAAE,SAAS,CAAC,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;SACzC,CAAC,CACF,CAAC;KACF,CAAC,CAAC;CACH,CAAC;AAEF,eAAO,MAAM,sBAAsB,EAAE,KAAK,CAAC,iBAAiB,CAuB1D,CAAC"}
+{"version":3,"file":"Sensitive.unit.test.d.ts","sourceRoot":"","sources":["../../src/sensitive/Sensitive.unit.test.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,CAAC,MAAM,cAAc,CAAC;AAElC,OAAO,EAAE,KAAK,EAAE,MAAM,gBAAgB,CAAC;AAEvC,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAExC,MAAM,MAAM,iBAAiB,GAAG;IAC/B,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,SAAS,CAAC,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC;IACtC,WAAW,EAAE,SAAS,CAAC;QACtB,GAAG,EAAE,MAAM,CAAC;QACZ,GAAG,EAAE,MAAM,CAAC;QACZ,WAAW,EAAE,SAAS,CACrB,CAAC,CAAC,MAAM,CAAC;YACR,IAAI,EAAE,MAAM,CAAC;YACb,KAAK,EAAE,MAAM,CAAC;YACd,SAAS,EAAE,SAAS,CAAC,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;SACzC,CAAC,CACF,CAAC;KACF,CAAC,CAAC;CACH,CAAC;AAwBF,eAAO,MAAM,+BAA+B,EAAE,KAAK,CAAC,iBAAiB,CAInE,CAAC;AAEH,eAAO,MAAM,sBAAsB,EAAE,KAAK,CAAC,iBAAiB,CACiB,CAAC"}

package/dist/sensitive/Sensitive.unit.test.js

@@ -23,14 +23,14 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.testTypeSensitiveCodec = void 0;
+exports.testTypeSensitiveCodec = exports.testTypeSensitiveRedactionCodec = void 0;
 const E = __importStar(require("fp-ts/Either"));
 const t = __importStar(require("io-ts"));
 const O = __importStar(require("fp-ts/Option"));
 const td = __importStar(require("io-ts-types"));
 const TypeCodec_1 = require("../codec/TypeCodec");
 const Sensitive_1 = require("./Sensitive");
-exports.testTypeSensitiveCodec = TypeCodec_1.TypeCodec.fromDescriptor(t.type({
+const testTypeSensitiveTypeDescriptor = t.type({
     strField: t.string,
     intField: Sensitive_1.Sensitive.typeDescriptor(td.optionFromNullable(t.number)),
     objectField: Sensitive_1.Sensitive.typeDescriptor(t.type({
@@ -42,7 +42,9 @@ exports.testTypeSensitiveCodec = TypeCodec_1.TypeCodec.fromDescriptor(t.type({
             testArray: Sensitive_1.Sensitive.typeDescriptor(t.array(td.optionFromNullable(t.string))),
         }))),
     })),
-}));
+});
+exports.testTypeSensitiveRedactionCodec = TypeCodec_1.TypeCodec.fromDescriptor(testTypeSensitiveTypeDescriptor, true);
+exports.testTypeSensitiveCodec = TypeCodec_1.TypeCodec.fromDescriptor(testTypeSensitiveTypeDescriptor);
 describe('Sensitive', () => {
     describe('encode/decode sensitive values', () => {
         it('should encode sensitive typed data without the extra layer', () => {
@@ -62,16 +64,16 @@ describe('Sensitive', () => {
             const result = exports.testTypeSensitiveCodec.encode(testValueEncoded);
             const expected = {
                 strField: 'str',
-                intField: Sensitive_1.Sensitive.fromValue(123),
-                objectField: Sensitive_1.Sensitive.fromValue({
+                intField: 123,
+                objectField: {
                     int: 123,
                     str: 'test',
-                    optionalObj: Sensitive_1.Sensitive.fromValue({
+                    optionalObj: {
                         test: 'test',
                         test1: 'test1',
-                        testArray: Sensitive_1.Sensitive.fromValue(['test']),
-                    }),
-                }),
+                        testArray: ['test'],
+                    },
+                },
             };
             expect(result).toStrictEqual(expected);
         });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@trayio/commons",
-  "version": "4.56.0",
+  "version": "4.58.0",
   "description": "Extensions to the standard/core libraries and basic features",
   "exports": {
     "./*": "./dist/*.js"