@trayio/commons 4.31.0 → 4.32.0

package/dist/codec/RedactValuesCodec.d.ts

@@ -0,0 +1,12 @@
+import * as E from 'fp-ts/lib/Either';
+import { Codec } from './Codec';
+export declare class RedactValuesCodec implements Codec<unknown> {
+    static instance: Codec<unknown>;
+    encode(value: unknown): unknown;
+    decode(value: unknown): E.Either<Error, unknown>;
+    private isObject;
+    private redactSensitiveValues;
+    private redactValuesFromArrayIfPresent;
+    private redactValuesFromObjectIfPresent;
+}
+//# sourceMappingURL=RedactValuesCodec.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"RedactValuesCodec.d.ts","sourceRoot":"","sources":["../../src/codec/RedactValuesCodec.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,kBAAkB,CAAC;AACtC,OAAO,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AAGhC,qBAAa,iBAAkB,YAAW,KAAK,CAAC,OAAO,CAAC;IACvD,MAAM,CAAC,QAAQ,EAAE,KAAK,CAAC,OAAO,CAAC,CAA2B;IAE1D,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,qBAAqB;IAa7B,OAAO,CAAC,8BAA8B;IAStC,OAAO,CAAC,+BAA+B;CAiBvC"}

package/dist/codec/RedactValuesCodec.js

@@ -0,0 +1,77 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RedactValuesCodec = void 0;
+const E = __importStar(require("fp-ts/lib/Either"));
+const Sensitive_1 = require("../sensitive/Sensitive");
+class RedactValuesCodec {
+    static instance = new RedactValuesCodec();
+    encode(value) {
+        return this.redactSensitiveValues(value);
+    }
+    decode(value) {
+        return E.right(this.redactSensitiveValues(value));
+    }
+    isObject(value) {
+        return typeof value === 'object' && !Array.isArray(value) && value !== null;
+    }
+    redactSensitiveValues(value) {
+        if (value === null) {
+            return value;
+        }
+        if (this.isObject(value)) {
+            return this.redactValuesFromObjectIfPresent(value);
+        }
+        if (Array.isArray(value)) {
+            return this.redactValuesFromArrayIfPresent(value);
+        }
+        return value;
+    }
+    redactValuesFromArrayIfPresent(value) {
+        return value.reduce((acc, propertyValue) => {
+            if (propertyValue == null) {
+                return acc;
+            }
+            return [...acc, this.redactSensitiveValues(propertyValue)];
+        }, []);
+    }
+    redactValuesFromObjectIfPresent(value) {
+        return Object.entries(value).reduce((acc, [key, propertyValue]) => {
+            if (this.isObject(propertyValue)) {
+                if (propertyValue._tag === 'Sensitive') {
+                    return { ...acc, [key]: Sensitive_1.Sensitive.fromValue('<REDACTED>') };
+                }
+                const nestedObject = this.redactValuesFromObjectIfPresent(propertyValue);
+                return { ...acc, [key]: nestedObject };
+            }
+            if (Array.isArray(propertyValue)) {
+                const nestedArray = this.redactValuesFromArrayIfPresent(propertyValue);
+                return { ...acc, [key]: nestedArray };
+            }
+            return { ...acc, [key]: propertyValue };
+        }, {});
+    }
+}
+exports.RedactValuesCodec = RedactValuesCodec;

package/dist/codec/RedactValuesCodec.unit.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=RedactValuesCodec.unit.test.d.ts.map

package/dist/codec/RedactValuesCodec.unit.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"RedactValuesCodec.unit.test.d.ts","sourceRoot":"","sources":["../../src/codec/RedactValuesCodec.unit.test.ts"],"names":[],"mappings":""}

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

@@ -0,0 +1,70 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const Sensitive_1 = require("../sensitive/Sensitive");
+const Sensitive_unit_test_1 = require("../sensitive/Sensitive.unit.test");
+const CompositeCodec_1 = require("./CompositeCodec");
+const RedactValuesCodec_1 = require("./RedactValuesCodec");
+describe('redactValue Codec', () => {
+    it('should redact sensitive typed data', () => {
+        const value = {
+            password: Sensitive_1.Sensitive.fromValue('password'),
+            username: 'username',
+            address: {
+                city: 'city',
+                street: 'street',
+                number: 123,
+            },
+        };
+        const actualValue = RedactValuesCodec_1.RedactValuesCodec.instance.encode(value);
+        const expectedValue = {
+            password: Sensitive_1.Sensitive.fromValue('<REDACTED>'),
+            username: 'username',
+            address: {
+                city: 'city',
+                street: 'street',
+                number: 123,
+            },
+        };
+        expect(actualValue).toStrictEqual(expectedValue);
+    });
+    it('should redact sensitive typed data in nested arrays', () => {
+        const value = {
+            users: [
+                { password: Sensitive_1.Sensitive.fromValue('password'), username: 'username' },
+            ],
+        };
+        const actualValue = RedactValuesCodec_1.RedactValuesCodec.instance.encode(value);
+        const expectedValue = {
+            users: [
+                { password: Sensitive_1.Sensitive.fromValue('<REDACTED>'), username: 'username' },
+            ],
+        };
+        expect(actualValue).toStrictEqual(expectedValue);
+    });
+    it('should redact sensitive typed data in nested objects', () => {
+        const value = {
+            user: { password: Sensitive_1.Sensitive.fromValue('password'), username: 'username' },
+        };
+        const actualValue = RedactValuesCodec_1.RedactValuesCodec.instance.encode(value);
+        const expectedValue = {
+            user: {
+                password: Sensitive_1.Sensitive.fromValue('<REDACTED>'),
+                username: 'username',
+            },
+        };
+        expect(actualValue).toStrictEqual(expectedValue);
+    });
+    it('should redact sensitive typed data and type encode the value', () => {
+        const testValueEncoded = {
+            strField: 'str',
+            intField: Sensitive_1.Sensitive.fromValue(123),
+        };
+        const redactAndTypeDecode = CompositeCodec_1.CompositeCodec.fromCodecs(RedactValuesCodec_1.RedactValuesCodec.instance, Sensitive_unit_test_1.testTypeSensitiveCodec);
+        const result = redactAndTypeDecode.encode(testValueEncoded);
+        const expected = {
+            strField: 'str',
+            intField: '<REDACTED>',
+        };
+        expect(result).toStrictEqual(expected);
+    });
+});

package/dist/sensitive/Sensitive.d.ts

@@ -0,0 +1,13 @@
+import * as t from 'io-ts';
+import { Codec } from '../codec/Codec';
+export type Sensitive<T> = {
+    value: T;
+    readonly _tag: 'Sensitive';
+};
+export interface SensitiveInterface {
+    fromValue: <T>(value: T) => Sensitive<T>;
+    typeCodec: Codec<Sensitive<unknown>>;
+    typeDescriptor: <T>(descriptor: t.Type<T, unknown>) => t.Type<Sensitive<T>, unknown>;
+}
+export declare const Sensitive: SensitiveInterface;
+//# sourceMappingURL=Sensitive.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"Sensitive.d.ts","sourceRoot":"","sources":["../../src/sensitive/Sensitive.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,OAAO,CAAC;AAC3B,OAAO,EAAE,KAAK,EAAE,MAAM,gBAAgB,CAAC;AAGvC,MAAM,MAAM,SAAS,CAAC,CAAC,IAAI;IAC1B,KAAK,EAAE,CAAC,CAAC;IACT,QAAQ,CAAC,IAAI,EAAE,WAAW,CAAC;CAC3B,CAAC;AAEF,MAAM,WAAW,kBAAkB;IAClC,SAAS,EAAE,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,KAAK,SAAS,CAAC,CAAC,CAAC,CAAC;IACzC,SAAS,EAAE,KAAK,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC;IACrC,cAAc,EAAE,CAAC,CAAC,EACjB,UAAU,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,EAAE,OAAO,CAAC,KAC1B,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC;CACnC;AAeD,eAAO,MAAM,SAAS,EAAE,kBAQvB,CAAC"}

package/dist/sensitive/Sensitive.js

@@ -0,0 +1,38 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Sensitive = void 0;
+const t = __importStar(require("io-ts"));
+const TypeCodec_1 = require("../codec/TypeCodec");
+const sensitiveTypeDescriptor = () => new t.Type('Sensitive', (u) => u instanceof Object && '_tag' in u && u._tag === 'Sensitive', (u, c) => t.success(exports.Sensitive.fromValue(u)), (a) => a.value);
+const sensitiveTypeCodec = TypeCodec_1.TypeCodec.fromDescriptor(sensitiveTypeDescriptor());
+exports.Sensitive = {
+    fromValue: (value) => ({
+        value,
+        _tag: 'Sensitive',
+    }),
+    typeCodec: sensitiveTypeCodec,
+    typeDescriptor: (descriptor) => descriptor.pipe(sensitiveTypeDescriptor()),
+};

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

@@ -0,0 +1,8 @@
+import { Codec } from '../codec/Codec';
+import { Sensitive } from './Sensitive';
+export type TestTypeSensitive = {
+    strField: string;
+    intField: Sensitive<number>;
+};
+export declare const testTypeSensitiveCodec: Codec<TestTypeSensitive>;
+//# sourceMappingURL=Sensitive.unit.test.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"Sensitive.unit.test.d.ts","sourceRoot":"","sources":["../../src/sensitive/Sensitive.unit.test.ts"],"names":[],"mappings":"AAEA,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,MAAM,CAAC,CAAC;CAC5B,CAAC;AAEF,eAAO,MAAM,sBAAsB,EAAE,KAAK,CAAC,iBAAiB,CAM1D,CAAC"}

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

@@ -0,0 +1,62 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.testTypeSensitiveCodec = void 0;
+const E = __importStar(require("fp-ts/Either"));
+const t = __importStar(require("io-ts"));
+const TypeCodec_1 = require("../codec/TypeCodec");
+const Sensitive_1 = require("./Sensitive");
+exports.testTypeSensitiveCodec = TypeCodec_1.TypeCodec.fromDescriptor(t.type({
+    strField: t.string,
+    intField: Sensitive_1.Sensitive.typeDescriptor(t.number),
+}));
+describe('Sensitive', () => {
+    describe('encode/decode sensitive values', () => {
+        it('should encode sensitive typed data without the extra layer', () => {
+            const testValueEncoded = {
+                strField: 'str',
+                intField: Sensitive_1.Sensitive.fromValue(123),
+            };
+            const result = exports.testTypeSensitiveCodec.encode(testValueEncoded);
+            const expected = {
+                strField: 'str',
+                intField: 123,
+            };
+            expect(result).toStrictEqual(expected);
+        });
+        it('should decode sensitive typed data without the extra layer', () => {
+            const testValueEncoded = {
+                strField: 'str',
+                intField: 123,
+            };
+            const result = exports.testTypeSensitiveCodec.decode(testValueEncoded);
+            const expected = E.right({
+                strField: 'str',
+                intField: Sensitive_1.Sensitive.fromValue(123),
+            });
+            expect(result).toStrictEqual(expected);
+        });
+    });
+});

package/package.json

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