@trayio/commons 3.12.0-unstable → 3.12.0

package/dist/http/Http.d.ts

@@ -3,6 +3,7 @@ import * as O from 'fp-ts/lib/Option';
 import { Readable } from 'stream';
 import { File } from '../file/File';
 import { SerializationFormat } from '../serialization/Serialization';
+import { DynamicObject } from '../dynamictype/DynamicType';
 export type HttpHeaderValue = string | string[];
 export type HttpHeaders = Record<string, HttpHeaderValue | HttpContentType>;
 export type HttpQueryStringSingleValue = number | string | boolean;
@@ -51,6 +52,8 @@ export declare enum HttpHeader {
 export interface HttpHeadersInterface {
     get: (headers: HttpHeaders, name: string) => O.Option<HttpHeaderValue>;
     extractBearerToken: (headers: HttpHeaders) => O.Option<string>;
+    fromDynamicObject: (headers: DynamicObject) => HttpHeaders;
+    toDynamicObject: (headers: HttpHeaders) => DynamicObject;
 }
 export declare const HttpHeaders: HttpHeadersInterface;
 export declare const serializationFormatToHttpContentType: Record<SerializationFormat, HttpContentType>;

package/dist/http/Http.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Http.d.ts","sourceRoot":"","sources":["../../src/http/Http.ts"],"names":[],"mappings":";AAAA,OAAO,KAAK,CAAC,MAAM,kBAAkB,CAAC;AAEtC,OAAO,EAAE,QAAQ,EAAE,MAAM,QAAQ,CAAC;AAClC,OAAO,EAAE,IAAI,EAAE,MAAM,cAAc,CAAC;AACpC,OAAO,EAAE,mBAAmB,EAAE,MAAM,gCAAgC,CAAC;AAOrE,MAAM,MAAM,eAAe,GAAG,MAAM,GAAG,MAAM,EAAE,CAAC;AAEhD,MAAM,MAAM,WAAW,GAAG,MAAM,CAAC,MAAM,EAAE,eAAe,GAAG,eAAe,CAAC,CAAC;AAE5E,MAAM,MAAM,0BAA0B,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC;AAEnE,MAAM,MAAM,oBAAoB,GAC7B,0BAA0B,GAC1B,0BAA0B,EAAE,CAAC;AAEhC,MAAM,MAAM,eAAe,GAAG,MAAM,CAAC,MAAM,EAAE,oBAAoB,CAAC,CAAC;AAEnE,MAAM,MAAM,sBAAsB,GAAG,QAAQ,CAAC;AAE9C,MAAM,MAAM,wBAAwB,GAAG;IACtC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC/B,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;CAC5B,CAAC;AAEF,MAAM,MAAM,eAAe,GAAG,sBAAsB,GAAG,wBAAwB,CAAC;AAEhF,MAAM,MAAM,WAAW,GAAG;IACzB,OAAO,EAAE,WAAW,CAAC;IACrB,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACnC,WAAW,EAAE,eAAe,CAAC;IAC7B,IAAI,EAAE,eAAe,CAAC;CACtB,CAAC;AAEF,MAAM,MAAM,YAAY,GAAG;IAC1B,UAAU,EAAE,MAAM,CAAC;IACnB,OAAO,EAAE,WAAW,CAAC;IACrB,IAAI,EAAE,QAAQ,CAAC;CACf,CAAC;AAEF,oBAAY,UAAU;IACrB,MAAM,WAAW;IACjB,GAAG,QAAQ;IACX,IAAI,SAAS;IACb,OAAO,YAAY;IACnB,KAAK,UAAU;IACf,IAAI,SAAS;IACb,GAAG,QAAQ;CACX;AAED,oBAAY,eAAe;IAC1B,IAAI,qBAAqB;IACzB,WAAW,6BAA6B;IACxC,cAAc,sCAAsC;IACpD,oBAAoB,wBAAwB;IAC5C,IAAI,eAAe;CACnB;AAED,oBAAY,UAAU;IACrB,aAAa,kBAAkB;IAC/B,WAAW,iBAAiB;IAC5B,aAAa,6BAA6B;IAC1C,SAAS,eAAe;IACxB,aAAa,mBAAmB;CAChC;AAED,MAAM,WAAW,oBAAoB;IACpC,GAAG,EAAE,CAAC,OAAO,EAAE,WAAW,EAAE,IAAI,EAAE,MAAM,KAAK,CAAC,CAAC,MAAM,CAAC,eAAe,CAAC,CAAC;IACvE,kBAAkB,EAAE,CAAC,OAAO,EAAE,WAAW,KAAK,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;CAC/D;AAED,eAAO,MAAM,WAAW,EAAE,oBAYzB,CAAC;AAEF,eAAO,MAAM,oCAAoC,EAAE,MAAM,CACxD,mBAAmB,EACnB,eAAe,CAGf,CAAC;AAEF,eAAO,MAAM,eAAe,SACrB,eAAe,qCAEkC,CAAC"}
+{"version":3,"file":"Http.d.ts","sourceRoot":"","sources":["../../src/http/Http.ts"],"names":[],"mappings":";AAAA,OAAO,KAAK,CAAC,MAAM,kBAAkB,CAAC;AAEtC,OAAO,EAAE,QAAQ,EAAE,MAAM,QAAQ,CAAC;AAClC,OAAO,EAAE,IAAI,EAAE,MAAM,cAAc,CAAC;AACpC,OAAO,EAAE,mBAAmB,EAAE,MAAM,gCAAgC,CAAC;AACrE,OAAO,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAC;AAO3D,MAAM,MAAM,eAAe,GAAG,MAAM,GAAG,MAAM,EAAE,CAAC;AAEhD,MAAM,MAAM,WAAW,GAAG,MAAM,CAAC,MAAM,EAAE,eAAe,GAAG,eAAe,CAAC,CAAC;AAE5E,MAAM,MAAM,0BAA0B,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC;AAEnE,MAAM,MAAM,oBAAoB,GAC7B,0BAA0B,GAC1B,0BAA0B,EAAE,CAAC;AAEhC,MAAM,MAAM,eAAe,GAAG,MAAM,CAAC,MAAM,EAAE,oBAAoB,CAAC,CAAC;AAEnE,MAAM,MAAM,sBAAsB,GAAG,QAAQ,CAAC;AAE9C,MAAM,MAAM,wBAAwB,GAAG;IACtC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC/B,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;CAC5B,CAAC;AAEF,MAAM,MAAM,eAAe,GAAG,sBAAsB,GAAG,wBAAwB,CAAC;AAEhF,MAAM,MAAM,WAAW,GAAG;IACzB,OAAO,EAAE,WAAW,CAAC;IACrB,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACnC,WAAW,EAAE,eAAe,CAAC;IAC7B,IAAI,EAAE,eAAe,CAAC;CACtB,CAAC;AAEF,MAAM,MAAM,YAAY,GAAG;IAC1B,UAAU,EAAE,MAAM,CAAC;IACnB,OAAO,EAAE,WAAW,CAAC;IACrB,IAAI,EAAE,QAAQ,CAAC;CACf,CAAC;AAEF,oBAAY,UAAU;IACrB,MAAM,WAAW;IACjB,GAAG,QAAQ;IACX,IAAI,SAAS;IACb,OAAO,YAAY;IACnB,KAAK,UAAU;IACf,IAAI,SAAS;IACb,GAAG,QAAQ;CACX;AAED,oBAAY,eAAe;IAC1B,IAAI,qBAAqB;IACzB,WAAW,6BAA6B;IACxC,cAAc,sCAAsC;IACpD,oBAAoB,wBAAwB;IAC5C,IAAI,eAAe;CACnB;AAED,oBAAY,UAAU;IACrB,aAAa,kBAAkB;IAC/B,WAAW,iBAAiB;IAC5B,aAAa,6BAA6B;IAC1C,SAAS,eAAe;IACxB,aAAa,mBAAmB;CAChC;AAED,MAAM,WAAW,oBAAoB;IACpC,GAAG,EAAE,CAAC,OAAO,EAAE,WAAW,EAAE,IAAI,EAAE,MAAM,KAAK,CAAC,CAAC,MAAM,CAAC,eAAe,CAAC,CAAC;IACvE,kBAAkB,EAAE,CAAC,OAAO,EAAE,WAAW,KAAK,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;IAC/D,iBAAiB,EAAE,CAAC,OAAO,EAAE,aAAa,KAAK,WAAW,CAAC;IAC3D,eAAe,EAAE,CAAC,OAAO,EAAE,WAAW,KAAK,aAAa,CAAC;CACzD;AAED,eAAO,MAAM,WAAW,EAAE,oBAyIzB,CAAC;AAEF,eAAO,MAAM,oCAAoC,EAAE,MAAM,CACxD,mBAAmB,EACnB,eAAe,CAGf,CAAC;AAEF,eAAO,MAAM,eAAe,SACrB,eAAe,qCAEkC,CAAC"}

package/dist/http/Http.js

@@ -59,6 +59,115 @@ exports.HttpHeaders = {
     extractBearerToken: (headers) => (0, function_1.pipe)(getHeader(headers, HttpHeader.Authorization), O.chain((header) => header.toLowerCase().startsWith('bearer ')
         ? O.fromNullable(header.substring(7))
         : O.fromNullable(null))),
+    fromDynamicObject(headers) {
+        const flattenObject = (obj, prefix = '') => Object.entries(obj).reduce((acc, [key, value]) => {
+            const newKey = prefix ? `${prefix}.${key}` : key;
+            if (typeof value === 'object' &&
+                !Array.isArray(value) &&
+                value !== null) {
+                return { ...acc, ...flattenObject(value, newKey) };
+            }
+            acc[newKey] = Array.isArray(value) ? value.join(',') : value;
+            return acc;
+        }, {});
+        const transformHeaders = (obj) => Object.entries(obj).reduce((acc, [key, value]) => {
+            const keyParts = key.split('.');
+            const mainKey = keyParts.shift();
+            if (mainKey === undefined) {
+                return acc;
+            }
+            if (typeof value === 'string' && keyParts.length === 0) {
+                if (Array.isArray(headers[mainKey])) {
+                    const topLevelArr = headers[mainKey];
+                    if (topLevelArr.every((item) => !item.includes('='))) {
+                        /*
+                            Single element arrays or empty arrays should be treated as a single value
+                            [] -> ''
+                            ['value'] -> 'value'
+                        */
+                        if (topLevelArr.length === 1) {
+                            // eslint-disable-next-line prefer-destructuring
+                            acc[mainKey] = topLevelArr[0];
+                        }
+                        else if (topLevelArr.length === 0) {
+                            acc[mainKey] = '';
+                        }
+                        else {
+                            acc[mainKey] = topLevelArr;
+                        }
+                    }
+                }
+                else {
+                    acc[mainKey] = value;
+                }
+            }
+            else {
+                acc[mainKey] = acc[mainKey] || [];
+                acc[mainKey].push(`${keyParts.join('.')}=${value}`);
+            }
+            return acc;
+        }, {});
+        const flattened = flattenObject(headers);
+        return transformHeaders(flattened);
+    },
+    toDynamicObject: (headers) => {
+        /*
+            Headers will conform to OpenAPI 3.0 standards with 'style: simple', 'explode: true'
+            See: https://swagger.io/docs/specification/serialization/
+            EG:
+            Primitive - X-MyHeader: [1]
+            Array - X-MyHeader: [3,4,5]
+            Object - X-MyHeader: [role=admin, name.first=Alex, name.last=Smith, someArray=2,3,4]
+        */
+        const parseNestedProperties = (item, obj) => {
+            const [key, value] = item.split('=');
+            const modifiedVal = value.includes(',') ? value.split(',') : undefined;
+            if (key.includes('.')) {
+                assignNestedProperty(key, value, obj);
+            }
+            else {
+                obj[key] = modifiedVal || value;
+            }
+            return obj;
+        };
+        const assignNestedProperty = (key, value, obj) => {
+            const keys = key.split('.');
+            obj[keys[0]] = obj[keys[0]] || {};
+            if (keys.length > 1) {
+                parseNestedProperties(`${keys.slice(1).join('.')}=${value}`, obj[keys[0]]);
+            }
+            else {
+                obj[keys[0]] = value;
+            }
+        };
+        return Object.keys(headers).reduce((acc, key) => {
+            const value = headers[key];
+            if (Array.isArray(value)) {
+                if (value.length === 0) {
+                    acc[key] = '';
+                }
+                else if (value.length === 1) {
+                    if (value[0].includes('=')) {
+                        acc[key] = parseNestedProperties(value[0], {});
+                    }
+                    else {
+                        // eslint-disable-next-line prefer-destructuring
+                        acc[key] = value[0];
+                    }
+                }
+                else if (value.every((item) => !item.includes('='))) {
+                    acc[key] = value;
+                }
+                else {
+                    acc[key] = value.reduce((obj, item) => parseNestedProperties(item, obj), {});
+                }
+            }
+            else {
+                acc[key] = value;
+            }
+            return acc;
+        }, {});
+    },
 };
 exports.serializationFormatToHttpContentType = {
     [Serialization_1.SerializationFormat.Json]: HttpContentType.Json,

package/dist/http/Http.unit.test.d.ts

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

package/dist/http/Http.unit.test.d.ts.map

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

package/dist/http/Http.unit.test.js

@@ -0,0 +1,134 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const Http_1 = require("./Http");
+describe('HttpHeaders', () => {
+    it('should convert headers to DynamicObject', () => {
+        const headers = {
+            'content-type': 'application/json',
+            'content-length': '100',
+            'x-custom-header': [
+                'role=admin',
+                'name.first=Alex',
+                'name.last=Smith',
+                'description.detail.age=30',
+                'array.values=2,3,4',
+            ],
+            'x-custom-header-2': ['prop=val'],
+            'x-custom-header-3': ['val'],
+            'x-custom-header-4': ['1', '2', '3'],
+        };
+        const result = Http_1.HttpHeaders.toDynamicObject(headers);
+        expect(result).toEqual({
+            'content-type': 'application/json',
+            'content-length': '100',
+            'x-custom-header': {
+                role: 'admin',
+                name: {
+                    first: 'Alex',
+                    last: 'Smith',
+                },
+                description: {
+                    detail: {
+                        age: '30',
+                    },
+                },
+                array: {
+                    values: ['2', '3', '4'],
+                },
+            },
+            'x-custom-header-2': {
+                prop: 'val',
+            },
+            'x-custom-header-3': 'val',
+            'x-custom-header-4': ['1', '2', '3'],
+        });
+    });
+    it('should convert headers to DynamicObject with empty array', () => {
+        const headers = {
+            'content-type': 'application/json',
+            'content-length': '100',
+            'x-custom-header': [],
+        };
+        const result = Http_1.HttpHeaders.toDynamicObject(headers);
+        expect(result).toEqual({
+            'content-type': 'application/json',
+            'content-length': '100',
+            'x-custom-header': '',
+        });
+    });
+    it('should convert DynamicObject to headers', () => {
+        const headers = {
+            'content-type': 'application/json',
+            'content-length': '100',
+            'x-empty-header': [],
+            'x-single-element-header': ['element'],
+            'x-custom-header': {
+                role: 'admin',
+                name: {
+                    first: 'Alex',
+                    last: 'Smith',
+                },
+                description: {
+                    detail: {
+                        age: '30',
+                    },
+                },
+                array: {
+                    values: ['2', '3', '4'],
+                },
+            },
+            'x-custom-header-4': ['1', '2', '3'],
+        };
+        const result = Http_1.HttpHeaders.fromDynamicObject(headers);
+        expect(result).toEqual({
+            'content-type': 'application/json',
+            'content-length': '100',
+            'x-empty-header': '',
+            'x-single-element-header': 'element',
+            'x-custom-header': [
+                'role=admin',
+                'name.first=Alex',
+                'name.last=Smith',
+                'description.detail.age=30',
+                'array.values=2,3,4',
+            ],
+            'x-custom-header-4': ['1', '2', '3'],
+        });
+    });
+    it('should serialize headers then deserialize and get the same result', () => {
+        const headers = {
+            'content-type': 'application/json',
+            'content-length': '100',
+            'x-custom-header': {
+                role: 'admin',
+                name: {
+                    first: 'Alex',
+                    last: 'Smith',
+                },
+                description: {
+                    detail: {
+                        age: '30',
+                    },
+                },
+                array: {
+                    values: ['2', '3', '4'],
+                },
+            },
+            'x-custom-header-4': ['1', '2', '3'],
+            'x-custom-header-2': '',
+        };
+        const serialized = Http_1.HttpHeaders.fromDynamicObject(headers);
+        const deserialized = Http_1.HttpHeaders.toDynamicObject(serialized);
+        expect(deserialized).toEqual(headers);
+    });
+    it('should serialize headers with empty array then deserialize and get an empty string', () => {
+        const headers = {
+            'x-custom-header-2': [],
+        };
+        const serialized = Http_1.HttpHeaders.fromDynamicObject(headers);
+        const deserialized = Http_1.HttpHeaders.toDynamicObject(serialized);
+        expect(deserialized).toEqual({
+            'x-custom-header-2': '',
+        });
+    });
+});

package/package.json

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