@squiz/dx-common-lib 1.21.1-alpha.9 → 1.22.0

package/lib/json-order/parse.spec.js

@@ -0,0 +1,260 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const parse_1 = __importDefault(require("./parse"));
+describe('parse ', () => {
+    const expectMap = (input, map) => expect((0, parse_1.default)(input, '$', '.').map).toEqual(map);
+    it('returns nothing for a blank JSON string', () => expectMap('{}', {}));
+    it('throws error if prefix is an empty string', () => {
+        expect(() => (0, parse_1.default)('', '', '.')).toThrowError('Prefix should not be an empty string.');
+    });
+    it('throws error if separator is an empty string', () => {
+        expect(() => (0, parse_1.default)('', '$', '')).toThrowError('Separator should not be an empty string.');
+    });
+    it('throws error if separator is a slash', () => {
+        expect(() => (0, parse_1.default)('', '$', '\\')).toThrowError('Separator cannot be "\\".');
+    });
+    it('handles top level values for of primitive types', () => {
+        const input = `
+    {
+      "b": "str",
+      "c": 3,
+      "a": true
+    }`;
+        const map = {
+            $: ['b', 'c', 'a'],
+        };
+        expectMap(input, map);
+    });
+    it('handles top level values of type [object]', () => {
+        const input = `
+    {
+      "a": {
+        "az": "str",
+        "ay": "str"
+      }
+    }`;
+        const map = {
+            $: ['a'],
+            '$.a': ['az', 'ay'],
+        };
+        expectMap(input, map);
+    });
+    it('handles top level values of a blank [object]', () => {
+        const input = `
+    {
+      "a": { }
+    }`;
+        const map = {
+            $: ['a'],
+        };
+        expectMap(input, map);
+    });
+    it('handles multi-character prefix', () => {
+        const input = `
+    {
+      "a": {
+        "a2": {
+          "b": "str"
+        },
+        "a1": {
+          "d": 2,
+          "c": false
+        }
+      }
+    }`;
+        const map = {
+            ab: ['a'],
+            'ab.a': ['a2', 'a1'],
+            'ab.a.a2': ['b'],
+            'ab.a.a1': ['d', 'c'],
+        };
+        expect((0, parse_1.default)(input, 'ab', '.').map).toEqual(map);
+    });
+    it('handles multi-character separator', () => {
+        const input = `
+    {
+      "a": {
+        "a2": {
+          "b": "str"
+        },
+        "a1": {
+          "d": 2,
+          "c": false
+        }
+      }
+    }`;
+        const map = {
+            $: ['a'],
+            '$~|a': ['a2', 'a1'],
+            '$~|a~|a2': ['b'],
+            '$~|a~|a1': ['d', 'c'],
+        };
+        expect((0, parse_1.default)(input, '$', '~|').map).toEqual(map);
+    });
+    it('handles nesting [object] > [object]', () => {
+        const input = `
+    {
+      "a": {
+        "a2": {
+          "b": "str"
+        },
+        "a1": {
+          "d": 2,
+          "c": false
+        }
+      }
+    }`;
+        const map = {
+            $: ['a'],
+            '$.a': ['a2', 'a1'],
+            '$.a.a2': ['b'],
+            '$.a.a1': ['d', 'c'],
+        };
+        expectMap(input, map);
+    });
+    it('should not return mappings for primitive elements of an [array]', () => {
+        const input = `
+    {
+      "a": [1, "2", "three"]
+    }`;
+        const map = {
+            $: ['a'],
+        };
+        expectMap(input, map);
+    });
+    it('handles nesting [array] > [array]', () => {
+        const input = `
+    {
+      "a": [1, "two", [ 3, "four", true]]
+    }`;
+        const map = {
+            $: ['a'],
+        };
+        expectMap(input, map);
+    });
+    it('handles nesting [array] > [object]', () => {
+        const input = `
+    {
+      "a": [1, "two", {
+        "b": "str"
+      }]
+    }`;
+        const map = {
+            $: ['a'],
+            '$.a.2': ['b'],
+        };
+        expectMap(input, map);
+    });
+    it('handles nesting [array] > [array] > [object]', () => {
+        const input = `
+    {
+      "c": [1, "two", [3, {
+        "b": "str"
+      }, 4], {
+        "a": "str"
+      }]
+    }`;
+        const map = {
+            $: ['c'],
+            '$.c.2.1': ['b'],
+            '$.c.3': ['a'],
+        };
+        expectMap(input, map);
+    });
+    it('handles nesting [array] > [array] > [object] > [array] > [object]', () => {
+        const input = `
+    {
+      "d": [
+        1, "two", [
+          3, {
+            "c": "str",
+            "b": [4, {
+              "a": "str"
+            }]
+          }
+        ]
+      ]
+    }`;
+        const map = {
+            $: ['d'],
+            '$.d.2.1': ['c', 'b'],
+            '$.d.2.1.b.1': ['a'],
+        };
+        expectMap(input, map);
+    });
+    it('handles keys with no name', () => {
+        const input = `
+    {
+      "": {
+        "c": "str",
+        "b": "str",
+        "a": "str"
+      }
+    }`;
+        const map = {
+            $: [''],
+            '$.': ['c', 'b', 'a'],
+        };
+        expectMap(input, map);
+    });
+    it('escapes slashes as well as the separator when it exists in the object keys', () => {
+        // slashes in the encoded JSON are double escapes, so "\\\\" is actually equivalent to "\".
+        const input = `
+    {
+      ".": {
+        "a": {"z": "str"},
+        "b": {"y": "str"}
+      },
+      "\\\\.": {
+        "b": {"x": "str"},
+        "a": {"w": "str"}
+      },
+      "\\\\": {
+        "a": {"v": "str"}
+      },
+      ".a": {
+        "c": {"u": "str"},
+        "b": {"t": "str"},
+        "a": {"s": "str"}
+      }
+    }`;
+        // all below slashes are escaped so "\\" is actually equivalent to "\".
+        const map = {
+            $: ['.', '\\.', '\\', '.a'],
+            '$.\\.': ['a', 'b'],
+            '$.\\..a': ['z'],
+            '$.\\..b': ['y'],
+            '$.\\\\\\.': ['b', 'a'],
+            '$.\\\\\\..b': ['x'],
+            '$.\\\\\\..a': ['w'],
+            '$.\\\\': ['a'],
+            '$.\\\\.a': ['v'],
+            '$.\\.a': ['c', 'b', 'a'],
+            '$.\\.a.c': ['u'],
+            '$.\\.a.b': ['t'],
+            '$.\\.a.a': ['s'],
+        };
+        expectMap(input, map);
+    });
+    it('handles keys with different types of values', () => {
+        const input = `
+    {
+      "a": "a",
+      "b": 2,
+      "c": 2.3,
+      "d": true,
+      "e": false,
+      "f": null,
+      "g": {},
+      "h": []
+    }`;
+        const map = {
+            $: ['a', 'b', 'c', 'd', 'e', 'f', 'g', 'h'],
+        };
+        expectMap(input, map);
+    });
+});
+//# sourceMappingURL=parse.spec.js.map

package/lib/json-order/parse.spec.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"parse.spec.js","sourceRoot":"","sources":["../../src/json-order/parse.spec.ts"],"names":[],"mappings":";;;;;AACA,oDAA4B;AAE5B,QAAQ,CAAC,QAAQ,EAAE,GAAG,EAAE;IACtB,MAAM,SAAS,GAAG,CAAC,KAAa,EAAE,GAAgB,EAAE,EAAE,CAAC,MAAM,CAAC,IAAA,eAAK,EAAC,KAAK,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;IAEvG,EAAE,CAAC,yCAAyC,EAAE,GAAG,EAAE,CAAC,SAAS,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,CAAC;IAEzE,EAAE,CAAC,2CAA2C,EAAE,GAAG,EAAE;QACnD,MAAM,CAAC,GAAG,EAAE,CAAC,IAAA,eAAK,EAAC,EAAE,EAAE,EAAE,EAAE,GAAG,CAAC,CAAC,CAAC,YAAY,CAAC,uCAAuC,CAAC,CAAC;IACzF,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,8CAA8C,EAAE,GAAG,EAAE;QACtD,MAAM,CAAC,GAAG,EAAE,CAAC,IAAA,eAAK,EAAC,EAAE,EAAE,GAAG,EAAE,EAAE,CAAC,CAAC,CAAC,YAAY,CAAC,0CAA0C,CAAC,CAAC;IAC5F,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,sCAAsC,EAAE,GAAG,EAAE;QAC9C,MAAM,CAAC,GAAG,EAAE,CAAC,IAAA,eAAK,EAAC,EAAE,EAAE,GAAG,EAAE,IAAI,CAAC,CAAC,CAAC,YAAY,CAAC,2BAA2B,CAAC,CAAC;IAC/E,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,iDAAiD,EAAE,GAAG,EAAE;QACzD,MAAM,KAAK,GAAG;;;;;MAKZ,CAAC;QAEH,MAAM,GAAG,GAAG;YACV,CAAC,EAAE,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC;SACnB,CAAC;QAEF,SAAS,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;IACxB,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,2CAA2C,EAAE,GAAG,EAAE;QACnD,MAAM,KAAK,GAAG;;;;;;MAMZ,CAAC;QAEH,MAAM,GAAG,GAAG;YACV,CAAC,EAAE,CAAC,GAAG,CAAC;YACR,KAAK,EAAE,CAAC,IAAI,EAAE,IAAI,CAAC;SACpB,CAAC;QAEF,SAAS,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;IACxB,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,8CAA8C,EAAE,GAAG,EAAE;QACtD,MAAM,KAAK,GAAG;;;MAGZ,CAAC;QAEH,MAAM,GAAG,GAAG;YACV,CAAC,EAAE,CAAC,GAAG,CAAC;SACT,CAAC;QAEF,SAAS,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;IACxB,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,gCAAgC,EAAE,GAAG,EAAE;QACxC,MAAM,KAAK,GAAG;;;;;;;;;;;MAWZ,CAAC;QAEH,MAAM,GAAG,GAAG;YACV,EAAE,EAAE,CAAC,GAAG,CAAC;YACT,MAAM,EAAE,CAAC,IAAI,EAAE,IAAI,CAAC;YACpB,SAAS,EAAE,CAAC,GAAG,CAAC;YAChB,SAAS,EAAE,CAAC,GAAG,EAAE,GAAG,CAAC;SACtB,CAAC;QAEF,MAAM,CAAC,IAAA,eAAK,EAAC,KAAK,EAAE,IAAI,EAAE,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;IACnD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,mCAAmC,EAAE,GAAG,EAAE;QAC3C,MAAM,KAAK,GAAG;;;;;;;;;;;MAWZ,CAAC;QAEH,MAAM,GAAG,GAAG;YACV,CAAC,EAAE,CAAC,GAAG,CAAC;YACR,MAAM,EAAE,CAAC,IAAI,EAAE,IAAI,CAAC;YACpB,UAAU,EAAE,CAAC,GAAG,CAAC;YACjB,UAAU,EAAE,CAAC,GAAG,EAAE,GAAG,CAAC;SACvB,CAAC;QAEF,MAAM,CAAC,IAAA,eAAK,EAAC,KAAK,EAAE,GAAG,EAAE,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;IACnD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,qCAAqC,EAAE,GAAG,EAAE;QAC7C,MAAM,KAAK,GAAG;;;;;;;;;;;MAWZ,CAAC;QAEH,MAAM,GAAG,GAAG;YACV,CAAC,EAAE,CAAC,GAAG,CAAC;YACR,KAAK,EAAE,CAAC,IAAI,EAAE,IAAI,CAAC;YACnB,QAAQ,EAAE,CAAC,GAAG,CAAC;YACf,QAAQ,EAAE,CAAC,GAAG,EAAE,GAAG,CAAC;SACrB,CAAC;QAEF,SAAS,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;IACxB,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,iEAAiE,EAAE,GAAG,EAAE;QACzE,MAAM,KAAK,GAAG;;;MAGZ,CAAC;QAEH,MAAM,GAAG,GAAG;YACV,CAAC,EAAE,CAAC,GAAG,CAAC;SACT,CAAC;QAEF,SAAS,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;IACxB,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,mCAAmC,EAAE,GAAG,EAAE;QAC3C,MAAM,KAAK,GAAG;;;MAGZ,CAAC;QAEH,MAAM,GAAG,GAAG;YACV,CAAC,EAAE,CAAC,GAAG,CAAC;SACT,CAAC;QAEF,SAAS,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;IACxB,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,oCAAoC,EAAE,GAAG,EAAE;QAC5C,MAAM,KAAK,GAAG;;;;;MAKZ,CAAC;QAEH,MAAM,GAAG,GAAG;YACV,CAAC,EAAE,CAAC,GAAG,CAAC;YACR,OAAO,EAAE,CAAC,GAAG,CAAC;SACf,CAAC;QAEF,SAAS,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;IACxB,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,8CAA8C,EAAE,GAAG,EAAE;QACtD,MAAM,KAAK,GAAG;;;;;;;MAOZ,CAAC;QAEH,MAAM,GAAG,GAAG;YACV,CAAC,EAAE,CAAC,GAAG,CAAC;YACR,SAAS,EAAE,CAAC,GAAG,CAAC;YAChB,OAAO,EAAE,CAAC,GAAG,CAAC;SACf,CAAC;QAEF,SAAS,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;IACxB,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,mEAAmE,EAAE,GAAG,EAAE;QAC3E,MAAM,KAAK,GAAG;;;;;;;;;;;;MAYZ,CAAC;QAEH,MAAM,GAAG,GAAG;YACV,CAAC,EAAE,CAAC,GAAG,CAAC;YACR,SAAS,EAAE,CAAC,GAAG,EAAE,GAAG,CAAC;YACrB,aAAa,EAAE,CAAC,GAAG,CAAC;SACrB,CAAC;QAEF,SAAS,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;IACxB,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,2BAA2B,EAAE,GAAG,EAAE;QACnC,MAAM,KAAK,GAAG;;;;;;;MAOZ,CAAC;QAEH,MAAM,GAAG,GAAG;YACV,CAAC,EAAE,CAAC,EAAE,CAAC;YACP,IAAI,EAAE,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC;SACtB,CAAC;QAEF,SAAS,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;IACxB,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,4EAA4E,EAAE,GAAG,EAAE;QACpF,2FAA2F;QAC3F,MAAM,KAAK,GAAG;;;;;;;;;;;;;;;;;;MAkBZ,CAAC;QAEH,uEAAuE;QACvE,MAAM,GAAG,GAAG;YACV,CAAC,EAAE,CAAC,GAAG,EAAE,KAAK,EAAE,IAAI,EAAE,IAAI,CAAC;YAC3B,OAAO,EAAE,CAAC,GAAG,EAAE,GAAG,CAAC;YACnB,SAAS,EAAE,CAAC,GAAG,CAAC;YAChB,SAAS,EAAE,CAAC,GAAG,CAAC;YAChB,WAAW,EAAE,CAAC,GAAG,EAAE,GAAG,CAAC;YACvB,aAAa,EAAE,CAAC,GAAG,CAAC;YACpB,aAAa,EAAE,CAAC,GAAG,CAAC;YACpB,QAAQ,EAAE,CAAC,GAAG,CAAC;YACf,UAAU,EAAE,CAAC,GAAG,CAAC;YACjB,QAAQ,EAAE,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC;YACzB,UAAU,EAAE,CAAC,GAAG,CAAC;YACjB,UAAU,EAAE,CAAC,GAAG,CAAC;YACjB,UAAU,EAAE,CAAC,GAAG,CAAC;SAClB,CAAC;QAEF,SAAS,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;IACxB,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,6CAA6C,EAAE,GAAG,EAAE;QACrD,MAAM,KAAK,GAAG;;;;;;;;;;MAUZ,CAAC;QAEH,MAAM,GAAG,GAAG;YACV,CAAC,EAAE,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC;SAC5C,CAAC;QAEF,SAAS,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;IACxB,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/lib/json-order/stringify.d.ts

@@ -0,0 +1,12 @@
+import { PropertyMap } from './models';
+/**
+ * Stringify a JS object while maintaining a particular property order:
+ *
+ * @param sourceObject an object with the properties in any order
+ * @param map the `PropertyMap` generated by the `parse` method.
+ * @param separator a non-empty `string` that controls what the key separator is in the generated map. Defaults to `~`.
+ * @param space a `number` used to insert white space into the output JSON string for readability purposes, as per the `JSON.stringify` [documentation](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/stringify#Parameters)
+ * @returns the stringified source object ordered as per the map. If the map is unset, the response is a standard `JSON.stringify`.
+ */
+declare const stringify: (sourceObject: object, map: PropertyMap | null, separator?: string, space?: number) => string;
+export default stringify;

package/lib/json-order/stringify.js

@@ -0,0 +1,20 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const order_1 = __importDefault(require("./order"));
+/**
+ * Stringify a JS object while maintaining a particular property order:
+ *
+ * @param sourceObject an object with the properties in any order
+ * @param map the `PropertyMap` generated by the `parse` method.
+ * @param separator a non-empty `string` that controls what the key separator is in the generated map. Defaults to `~`.
+ * @param space a `number` used to insert white space into the output JSON string for readability purposes, as per the `JSON.stringify` [documentation](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/stringify#Parameters)
+ * @returns the stringified source object ordered as per the map. If the map is unset, the response is a standard `JSON.stringify`.
+ */
+const stringify = (sourceObject, map, separator = '~', space) => {
+    return JSON.stringify((0, order_1.default)(sourceObject, map, separator), null, space);
+};
+exports.default = stringify;
+//# sourceMappingURL=stringify.js.map

package/lib/json-order/stringify.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"stringify.js","sourceRoot":"","sources":["../../src/json-order/stringify.ts"],"names":[],"mappings":";;;;;AACA,oDAA4B;AAE5B;;;;;;;;GAQG;AACH,MAAM,SAAS,GAAG,CAAC,YAAoB,EAAE,GAAuB,EAAE,SAAS,GAAG,GAAG,EAAE,KAAc,EAAU,EAAE;IAC3G,OAAO,IAAI,CAAC,SAAS,CAAC,IAAA,eAAK,EAAC,YAAY,EAAE,GAAG,EAAE,SAAS,CAAC,EAAE,IAAI,EAAE,KAAK,CAAC,CAAC;AAC1E,CAAC,CAAC;AAEF,kBAAe,SAAS,CAAC"}

package/lib/json-order/stringify.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/json-order/stringify.spec.js

@@ -0,0 +1,123 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const stringify_1 = __importDefault(require("./stringify"));
+describe('stringify ', () => {
+    const expectString = (obj, map, str) => expect((0, stringify_1.default)(obj, map, '.', 0)).toEqual(str);
+    it('returns nothing for a blank JSON string', () => expectString({}, {}, '{}'));
+    it('throws error if separator is an empty string', () => {
+        expect(() => (0, stringify_1.default)({}, {}, '')).toThrowError('Separator should not be an empty string.');
+    });
+    it('ignores properties not found in source', () => expectString({}, { $: ['a'] }, '{}'));
+    it('returns regular json string if map is undefined', () => expectString({ a: '1', b: '2' }, null, '{"a":"1","b":"2"}'));
+    it('ignores properties not found in map', () => expectString({ a: '1', b: '2' }, { $: ['b'] }, '{"b":"2"}'));
+    it('returns first level object properties in order', () => expectString({ a: 2, b: 1 }, { $: ['b', 'a'] }, '{"b":1,"a":2}'));
+    it('returns first level array value in order', () => expectString({ a: ['2', 1, true] }, { $: ['a'] }, '{"a":["2",1,true]}'));
+    it('returns nested [array] > [object] properties in expected order', () => expectString({ a: [1, { c: '3', d: '2' }] }, { $: ['a'], '$.a.1': ['d', 'c'] }, '{"a":[1,{"d":"2","c":"3"}]}'));
+    it('ignores nested [array] > [object] properties partially not found in map', () => expectString({ a: [1, { b: 2, c: 3 }, 4] }, { $: ['a'], '$.a.1': ['c'] }, '{"a":[1,{"c":3},4]}'));
+    it('ignores nested [array] > [object] properties not found in map', () => expectString({ a: [1, { b: 2, c: 3 }, 4] }, { $: ['a'] }, '{"a":[1,{},4]}'));
+    it('handles multi-character prefix', () => {
+        expect((0, stringify_1.default)({
+            a: {
+                b: {
+                    c: 3,
+                    d: 4,
+                },
+                e: {
+                    f: 4,
+                    g: 5,
+                },
+                h: 6,
+            },
+            i: 7,
+        }, {
+            ab: ['i', 'a'],
+            'ab.a': ['e', 'h', 'b'],
+            'ab.a.e': ['g', 'f'],
+            'ab.a.b': ['d', 'c'],
+        }, '.', 0)).toEqual('{"i":7,"a":{"e":{"g":5,"f":4},"h":6,"b":{"d":4,"c":3}}}');
+    });
+    it('handles multi-character separator', () => {
+        expect((0, stringify_1.default)({
+            a: {
+                b: {
+                    c: 3,
+                    d: 4,
+                },
+                e: {
+                    f: 4,
+                    g: 5,
+                },
+                h: 6,
+            },
+            i: 7,
+        }, {
+            $: ['i', 'a'],
+            '$~|a': ['e', 'h', 'b'],
+            '$~|a~|e': ['g', 'f'],
+            '$~|a~|b': ['d', 'c'],
+        }, '~|', 0)).toEqual('{"i":7,"a":{"e":{"g":5,"f":4},"h":6,"b":{"d":4,"c":3}}}');
+    });
+    it('returns nested [object] > [object] properties in expected order', () => expectString({
+        a: {
+            b: {
+                c: 3,
+                d: 4,
+            },
+            e: {
+                f: 4,
+                g: 5,
+            },
+            h: 6,
+        },
+        i: 7,
+    }, {
+        $: ['i', 'a'],
+        '$.a': ['e', 'h', 'b'],
+        '$.a.e': ['g', 'f'],
+        '$.a.b': ['d', 'c'],
+    }, '{"i":7,"a":{"e":{"g":5,"f":4},"h":6,"b":{"d":4,"c":3}}}'));
+    it('returns nested [object] > [array] > [object] > [array] > [object] properties in expected order', () => expectString({
+        a: {
+            b: [
+                8,
+                {
+                    c: 9,
+                    d: [
+                        {
+                            e: 12,
+                            f: {
+                                g: true,
+                                h: 'h',
+                            },
+                        },
+                        10,
+                    ],
+                },
+                11,
+            ],
+        },
+        i: 7,
+    }, {
+        $: ['i', 'a'],
+        '$.a': ['b'],
+        '$.a.b.1': ['d', 'c'],
+        '$.a.b.1.d.0': ['f', 'e'],
+        '$.a.b.1.d.0.f': ['h', 'g'],
+    }, '{"i":7,"a":{"b":[8,{"d":[{"f":{"h":"h","g":true},"e":12},10],"c":9},11]}}'));
+    it('handles keys with different types of values', () => expectString({
+        a: 'a',
+        b: 2,
+        c: 2.3,
+        d: true,
+        e: false,
+        f: null,
+        g: {},
+        h: [],
+    }, {
+        $: ['a', 'b', 'c', 'd', 'e', 'f', 'g', 'h'],
+    }, '{"a":"a","b":2,"c":2.3,"d":true,"e":false,"f":null,"g":{},"h":[]}'));
+});
+//# sourceMappingURL=stringify.spec.js.map

package/lib/json-order/stringify.spec.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"stringify.spec.js","sourceRoot":"","sources":["../../src/json-order/stringify.spec.ts"],"names":[],"mappings":";;;;;AAAA,4DAAoC;AAGpC,QAAQ,CAAC,YAAY,EAAE,GAAG,EAAE;IAC1B,MAAM,YAAY,GAAG,CAAC,GAAW,EAAE,GAAuB,EAAE,GAAW,EAAE,EAAE,CACzE,MAAM,CAAC,IAAA,mBAAS,EAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;IAEnD,EAAE,CAAC,yCAAyC,EAAE,GAAG,EAAE,CAAC,YAAY,CAAC,EAAE,EAAE,EAAE,EAAE,IAAI,CAAC,CAAC,CAAC;IAEhF,EAAE,CAAC,8CAA8C,EAAE,GAAG,EAAE;QACtD,MAAM,CAAC,GAAG,EAAE,CAAC,IAAA,mBAAS,EAAC,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC,CAAC,YAAY,CAAC,0CAA0C,CAAC,CAAC;IAC/F,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,wCAAwC,EAAE,GAAG,EAAE,CAAC,YAAY,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,EAAE,IAAI,CAAC,CAAC,CAAC;IAEzF,EAAE,CAAC,iDAAiD,EAAE,GAAG,EAAE,CACzD,YAAY,CAAC,EAAE,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,GAAG,EAAE,EAAE,IAAI,EAAE,mBAAmB,CAAC,CAAC,CAAC;IAE/D,EAAE,CAAC,qCAAqC,EAAE,GAAG,EAAE,CAAC,YAAY,CAAC,EAAE,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,GAAG,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,EAAE,WAAW,CAAC,CAAC,CAAC;IAE7G,EAAE,CAAC,gDAAgD,EAAE,GAAG,EAAE,CACxD,YAAY,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC,GAAG,EAAE,GAAG,CAAC,EAAE,EAAE,eAAe,CAAC,CAAC,CAAC;IAEpE,EAAE,CAAC,0CAA0C,EAAE,GAAG,EAAE,CAClD,YAAY,CAAC,EAAE,CAAC,EAAE,CAAC,GAAG,EAAE,CAAC,EAAE,IAAI,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,EAAE,oBAAoB,CAAC,CAAC,CAAC;IAE3E,EAAE,CAAC,gEAAgE,EAAE,GAAG,EAAE,CACxE,YAAY,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,OAAO,EAAE,CAAC,GAAG,EAAE,GAAG,CAAC,EAAE,EAAE,6BAA6B,CAAC,CAAC,CAAC;IAElH,EAAE,CAAC,yEAAyE,EAAE,GAAG,EAAE,CACjF,YAAY,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,OAAO,EAAE,CAAC,GAAG,CAAC,EAAE,EAAE,qBAAqB,CAAC,CAAC,CAAC;IAEpG,EAAE,CAAC,+DAA+D,EAAE,GAAG,EAAE,CACvE,YAAY,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,EAAE,gBAAgB,CAAC,CAAC,CAAC;IAE/E,EAAE,CAAC,gCAAgC,EAAE,GAAG,EAAE;QACxC,MAAM,CACJ,IAAA,mBAAS,EACP;YACE,CAAC,EAAE;gBACD,CAAC,EAAE;oBACD,CAAC,EAAE,CAAC;oBACJ,CAAC,EAAE,CAAC;iBACL;gBACD,CAAC,EAAE;oBACD,CAAC,EAAE,CAAC;oBACJ,CAAC,EAAE,CAAC;iBACL;gBACD,CAAC,EAAE,CAAC;aACL;YACD,CAAC,EAAE,CAAC;SACL,EACD;YACE,EAAE,EAAE,CAAC,GAAG,EAAE,GAAG,CAAC;YACd,MAAM,EAAE,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC;YACvB,QAAQ,EAAE,CAAC,GAAG,EAAE,GAAG,CAAC;YACpB,QAAQ,EAAE,CAAC,GAAG,EAAE,GAAG,CAAC;SACrB,EACD,GAAG,EACH,CAAC,CACF,CACF,CAAC,OAAO,CAAC,yDAAyD,CAAC,CAAC;IACvE,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,mCAAmC,EAAE,GAAG,EAAE;QAC3C,MAAM,CACJ,IAAA,mBAAS,EACP;YACE,CAAC,EAAE;gBACD,CAAC,EAAE;oBACD,CAAC,EAAE,CAAC;oBACJ,CAAC,EAAE,CAAC;iBACL;gBACD,CAAC,EAAE;oBACD,CAAC,EAAE,CAAC;oBACJ,CAAC,EAAE,CAAC;iBACL;gBACD,CAAC,EAAE,CAAC;aACL;YACD,CAAC,EAAE,CAAC;SACL,EACD;YACE,CAAC,EAAE,CAAC,GAAG,EAAE,GAAG,CAAC;YACb,MAAM,EAAE,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC;YACvB,SAAS,EAAE,CAAC,GAAG,EAAE,GAAG,CAAC;YACrB,SAAS,EAAE,CAAC,GAAG,EAAE,GAAG,CAAC;SACtB,EACD,IAAI,EACJ,CAAC,CACF,CACF,CAAC,OAAO,CAAC,yDAAyD,CAAC,CAAC;IACvE,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,iEAAiE,EAAE,GAAG,EAAE,CACzE,YAAY,CACV;QACE,CAAC,EAAE;YACD,CAAC,EAAE;gBACD,CAAC,EAAE,CAAC;gBACJ,CAAC,EAAE,CAAC;aACL;YACD,CAAC,EAAE;gBACD,CAAC,EAAE,CAAC;gBACJ,CAAC,EAAE,CAAC;aACL;YACD,CAAC,EAAE,CAAC;SACL;QACD,CAAC,EAAE,CAAC;KACL,EACD;QACE,CAAC,EAAE,CAAC,GAAG,EAAE,GAAG,CAAC;QACb,KAAK,EAAE,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC;QACtB,OAAO,EAAE,CAAC,GAAG,EAAE,GAAG,CAAC;QACnB,OAAO,EAAE,CAAC,GAAG,EAAE,GAAG,CAAC;KACpB,EACD,yDAAyD,CAC1D,CAAC,CAAC;IAEL,EAAE,CAAC,gGAAgG,EAAE,GAAG,EAAE,CACxG,YAAY,CACV;QACE,CAAC,EAAE;YACD,CAAC,EAAE;gBACD,CAAC;gBACD;oBACE,CAAC,EAAE,CAAC;oBACJ,CAAC,EAAE;wBACD;4BACE,CAAC,EAAE,EAAE;4BACL,CAAC,EAAE;gCACD,CAAC,EAAE,IAAI;gCACP,CAAC,EAAE,GAAG;6BACP;yBACF;wBACD,EAAE;qBACH;iBACF;gBACD,EAAE;aACH;SACF;QACD,CAAC,EAAE,CAAC;KACL,EACD;QACE,CAAC,EAAE,CAAC,GAAG,EAAE,GAAG,CAAC;QACb,KAAK,EAAE,CAAC,GAAG,CAAC;QACZ,SAAS,EAAE,CAAC,GAAG,EAAE,GAAG,CAAC;QACrB,aAAa,EAAE,CAAC,GAAG,EAAE,GAAG,CAAC;QACzB,eAAe,EAAE,CAAC,GAAG,EAAE,GAAG,CAAC;KAC5B,EACD,2EAA2E,CAC5E,CAAC,CAAC;IAEL,EAAE,CAAC,6CAA6C,EAAE,GAAG,EAAE,CACrD,YAAY,CACV;QACE,CAAC,EAAE,GAAG;QACN,CAAC,EAAE,CAAC;QACJ,CAAC,EAAE,GAAG;QACN,CAAC,EAAE,IAAI;QACP,CAAC,EAAE,KAAK;QACR,CAAC,EAAE,IAAI;QACP,CAAC,EAAE,EAAE;QACL,CAAC,EAAE,EAAE;KACN,EACD;QACE,CAAC,EAAE,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC;KAC5C,EACD,mEAAmE,CACpE,CAAC,CAAC;AACP,CAAC,CAAC,CAAC"}

package/lib/server-utils/errorMiddleware.js

@@ -5,6 +5,7 @@ exports.errorMiddleware = void 0;
 function errorMiddleware(error, req, res, _next) {
     const statusCode = error.statusCode || 500;
     error.message = (error === null || error === void 0 ? void 0 : error.message) || 'An error occurred with no additional information available';
+    res = res.setHeader('cache-control', 'no-cache, no-store, max-age=0');
     if ((error === null || error === void 0 ? void 0 : error.name) === 'ComponentError') {
         req.log.error({
             message: error,

package/lib/server-utils/errorMiddleware.js.map

@@ -1 +1 @@
-{"version":3,"file":"errorMiddleware.js","sourceRoot":"","sources":["../../src/server-utils/errorMiddleware.ts"],"names":[],"mappings":";;;AAEA,iEAAiE;AACjE,SAAgB,eAAe,CAAC,KAAU,EAAE,GAAY,EAAE,GAAa,EAAE,KAAU;IACjF,MAAM,UAAU,GAAG,KAAK,CAAC,UAAU,IAAI,GAAG,CAAC;IAC3C,KAAK,CAAC,OAAO,GAAG,CAAA,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,OAAO,KAAI,4DAA4D,CAAC;IAE/F,IAAI,CAAA,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,IAAI,MAAK,gBAAgB,EAAE;QACpC,GAAG,CAAC,GAAG,CAAC,KAAK,CAAC;YACZ,OAAO,EAAE,KAAK;YACd,IAAI,EAAE,WAAW;YACjB,eAAe,EAAE,KAAK,CAAC,YAAY;YACnC,gBAAgB,EAAE,KAAK,CAAC,aAAa;YACrC,mBAAmB,EAAE,KAAK,CAAC,gBAAgB;YAC3C,cAAc,EAAE,KAAK,CAAC,UAAU;YAChC,aAAa,EAAE,mBAAmB;SACnC,CAAC,CAAC;KACJ;SAAM,IAAI,CAAA,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,IAAI,MAAK,eAAe,EAAE;QAC1C,GAAG,CAAC,GAAG,CAAC,KAAK,CAAC,+BAA+B,GAAG,CAAC,IAAI,GAAG,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QACxE,OAAO,GAAG,CAAC,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC;YACnC,OAAO,EAAE,mBAAmB;YAC5B,OAAO,EAAE,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,MAAM;SACvB,CAAC,CAAC;KACJ;SAAM,IAAI,KAAK,YAAY,KAAK,EAAE;QACjC,GAAG,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC,CAAC;KACnC;SAAM;QACL,GAAG,CAAC,GAAG,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;KACtB;IAED,OAAO,GAAG,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,IAAI,CAAC,EAAE,OAAO,EAAE,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC;AACjE,CAAC;AA3BD,0CA2BC"}
+{"version":3,"file":"errorMiddleware.js","sourceRoot":"","sources":["../../src/server-utils/errorMiddleware.ts"],"names":[],"mappings":";;;AAEA,iEAAiE;AACjE,SAAgB,eAAe,CAAC,KAAU,EAAE,GAAY,EAAE,GAAa,EAAE,KAAU;IACjF,MAAM,UAAU,GAAG,KAAK,CAAC,UAAU,IAAI,GAAG,CAAC;IAC3C,KAAK,CAAC,OAAO,GAAG,CAAA,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,OAAO,KAAI,4DAA4D,CAAC;IAE/F,GAAG,GAAG,GAAG,CAAC,SAAS,CAAC,eAAe,EAAE,+BAA+B,CAAC,CAAC;IAEtE,IAAI,CAAA,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,IAAI,MAAK,gBAAgB,EAAE;QACpC,GAAG,CAAC,GAAG,CAAC,KAAK,CAAC;YACZ,OAAO,EAAE,KAAK;YACd,IAAI,EAAE,WAAW;YACjB,eAAe,EAAE,KAAK,CAAC,YAAY;YACnC,gBAAgB,EAAE,KAAK,CAAC,aAAa;YACrC,mBAAmB,EAAE,KAAK,CAAC,gBAAgB;YAC3C,cAAc,EAAE,KAAK,CAAC,UAAU;YAChC,aAAa,EAAE,mBAAmB;SACnC,CAAC,CAAC;KACJ;SAAM,IAAI,CAAA,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,IAAI,MAAK,eAAe,EAAE;QAC1C,GAAG,CAAC,GAAG,CAAC,KAAK,CAAC,+BAA+B,GAAG,CAAC,IAAI,GAAG,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QACxE,OAAO,GAAG,CAAC,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC;YACnC,OAAO,EAAE,mBAAmB;YAC5B,OAAO,EAAE,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,MAAM;SACvB,CAAC,CAAC;KACJ;SAAM,IAAI,KAAK,YAAY,KAAK,EAAE;QACjC,GAAG,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC,CAAC;KACnC;SAAM;QACL,GAAG,CAAC,GAAG,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;KACtB;IAED,OAAO,GAAG,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,IAAI,CAAC,EAAE,OAAO,EAAE,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC;AACjE,CAAC;AA7BD,0CA6BC"}

package/lib/server-utils/errorMiddleware.spec.js

@@ -10,6 +10,7 @@ const testRequest = {
 const testResponse = {
     status: jest.fn(() => testResponse),
     json: jest.fn(() => testResponse),
+    setHeader: jest.fn(() => testResponse),
 };
 class ComponentError extends error_1.ErrorWithHttpStatusCode {
     constructor(requestId, error, functionName, componentName, componentVersion, setWebPath, statusCode = 500) {

package/lib/server-utils/errorMiddleware.spec.js.map

@@ -1 +1 @@
-{"version":3,"file":"errorMiddleware.spec.js","sourceRoot":"","sources":["../../src/server-utils/errorMiddleware.spec.ts"],"names":[],"mappings":";;AAAA,oCAAmD;AACnD,uDAAoD;AAEpD,MAAM,WAAW,GAAG;IAClB,GAAG,EAAE;QACH,KAAK,EAAE,IAAI,CAAC,EAAE,EAAE;KACjB;CACF,CAAC;AAEF,MAAM,YAAY,GAAQ;IACxB,MAAM,EAAE,IAAI,CAAC,EAAE,CAAC,GAAG,EAAE,CAAC,YAAY,CAAC;IACnC,IAAI,EAAE,IAAI,CAAC,EAAE,CAAC,GAAG,EAAE,CAAC,YAAY,CAAC;CAClC,CAAC;AAEF,MAAM,cAAe,SAAQ,+BAAuB;IAGlD,YACS,SAAiB,EACjB,KAAkB,EAElB,YAAoB,EACpB,aAAqB,EACrB,gBAAwB,EACxB,UAAkB,EAEzB,aAAqB,GAAG;QAExB,KAAK,CAAC,UAAU,EAAE,CAAA,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,OAAO,KAAI,4DAA4D,CAAC,CAAC;QAV3F,cAAS,GAAT,SAAS,CAAQ;QACjB,UAAK,GAAL,KAAK,CAAa;QAElB,iBAAY,GAAZ,YAAY,CAAQ;QACpB,kBAAa,GAAb,aAAa,CAAQ;QACrB,qBAAgB,GAAhB,gBAAgB,CAAQ;QACxB,eAAU,GAAV,UAAU,CAAQ;QAT3B,SAAI,GAAG,gBAAgB,CAAC;QAetB,IAAI,CAAC,KAAK,GAAG,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,KAAK,CAAC;IAC5B,CAAC;CACF;AAED,QAAQ,CAAC,iBAAiB,EAAE,GAAG,EAAE;IAC/B,UAAU,CAAC,GAAG,EAAE;QACd,WAAW,CAAC,GAAG,CAAC,KAAK,CAAC,SAAS,EAAE,CAAC;IACpC,CAAC,CAAC,CAAC;IACH,EAAE,CAAC,4CAA4C,EAAE,GAAG,EAAE;QACpD,MAAM,KAAK,GAAG,IAAI,cAAc,CAAC,QAAQ,EAAE,IAAI,KAAK,EAAE,EAAE,eAAe,EAAE,gBAAgB,EAAE,QAAQ,EAAE,UAAU,CAAC,CAAC;QACjH,IAAA,iCAAe,EAAC,KAAK,EAAE,WAAkB,EAAE,YAAmB,EAAE,IAAI,CAAC,EAAE,EAAE,CAAC,CAAC;QAE3E,MAAM,CAAC,WAAW,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,cAAc,CAC1C,MAAM,CAAC,gBAAgB,CAAC;YACtB,IAAI,EAAE,WAAW;YACjB,eAAe,EAAE,eAAe;YAChC,gBAAgB,EAAE,gBAAgB;YAClC,mBAAmB,EAAE,QAAQ;YAC7B,cAAc,EAAE,UAAU;YAC1B,OAAO,EAAE,KAAK;SACf,CAAC,CACH,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,iCAAiC,EAAE,GAAG,EAAE;QACzC,MAAM,KAAK,GAAG,IAAI,KAAK,CAAC,2BAA2B,CAAC,CAAC;QAErD,IAAA,iCAAe,EAAC,KAAK,EAAE,WAAkB,EAAE,YAAmB,EAAE,IAAI,CAAC,EAAE,EAAE,CAAC,CAAC;QAC3E,MAAM,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC,cAAc,CAAC,EAAE,OAAO,EAAE,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC;IACvE,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}
+{"version":3,"file":"errorMiddleware.spec.js","sourceRoot":"","sources":["../../src/server-utils/errorMiddleware.spec.ts"],"names":[],"mappings":";;AAAA,oCAAmD;AACnD,uDAAoD;AAEpD,MAAM,WAAW,GAAG;IAClB,GAAG,EAAE;QACH,KAAK,EAAE,IAAI,CAAC,EAAE,EAAE;KACjB;CACF,CAAC;AAEF,MAAM,YAAY,GAAQ;IACxB,MAAM,EAAE,IAAI,CAAC,EAAE,CAAC,GAAG,EAAE,CAAC,YAAY,CAAC;IACnC,IAAI,EAAE,IAAI,CAAC,EAAE,CAAC,GAAG,EAAE,CAAC,YAAY,CAAC;IACjC,SAAS,EAAE,IAAI,CAAC,EAAE,CAAC,GAAG,EAAE,CAAC,YAAY,CAAC;CACvC,CAAC;AAEF,MAAM,cAAe,SAAQ,+BAAuB;IAGlD,YACS,SAAiB,EACjB,KAAkB,EAElB,YAAoB,EACpB,aAAqB,EACrB,gBAAwB,EACxB,UAAkB,EAEzB,aAAqB,GAAG;QAExB,KAAK,CAAC,UAAU,EAAE,CAAA,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,OAAO,KAAI,4DAA4D,CAAC,CAAC;QAV3F,cAAS,GAAT,SAAS,CAAQ;QACjB,UAAK,GAAL,KAAK,CAAa;QAElB,iBAAY,GAAZ,YAAY,CAAQ;QACpB,kBAAa,GAAb,aAAa,CAAQ;QACrB,qBAAgB,GAAhB,gBAAgB,CAAQ;QACxB,eAAU,GAAV,UAAU,CAAQ;QAT3B,SAAI,GAAG,gBAAgB,CAAC;QAetB,IAAI,CAAC,KAAK,GAAG,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,KAAK,CAAC;IAC5B,CAAC;CACF;AAED,QAAQ,CAAC,iBAAiB,EAAE,GAAG,EAAE;IAC/B,UAAU,CAAC,GAAG,EAAE;QACd,WAAW,CAAC,GAAG,CAAC,KAAK,CAAC,SAAS,EAAE,CAAC;IACpC,CAAC,CAAC,CAAC;IACH,EAAE,CAAC,4CAA4C,EAAE,GAAG,EAAE;QACpD,MAAM,KAAK,GAAG,IAAI,cAAc,CAAC,QAAQ,EAAE,IAAI,KAAK,EAAE,EAAE,eAAe,EAAE,gBAAgB,EAAE,QAAQ,EAAE,UAAU,CAAC,CAAC;QACjH,IAAA,iCAAe,EAAC,KAAK,EAAE,WAAkB,EAAE,YAAmB,EAAE,IAAI,CAAC,EAAE,EAAE,CAAC,CAAC;QAE3E,MAAM,CAAC,WAAW,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,cAAc,CAC1C,MAAM,CAAC,gBAAgB,CAAC;YACtB,IAAI,EAAE,WAAW;YACjB,eAAe,EAAE,eAAe;YAChC,gBAAgB,EAAE,gBAAgB;YAClC,mBAAmB,EAAE,QAAQ;YAC7B,cAAc,EAAE,UAAU;YAC1B,OAAO,EAAE,KAAK;SACf,CAAC,CACH,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,iCAAiC,EAAE,GAAG,EAAE;QACzC,MAAM,KAAK,GAAG,IAAI,KAAK,CAAC,2BAA2B,CAAC,CAAC;QAErD,IAAA,iCAAe,EAAC,KAAK,EAAE,WAAkB,EAAE,YAAmB,EAAE,IAAI,CAAC,EAAE,EAAE,CAAC,CAAC;QAC3E,MAAM,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC,cAAc,CAAC,EAAE,OAAO,EAAE,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC;IACvE,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@squiz/dx-common-lib",
-  "version": "1.21.1-alpha.9",
+  "version": "1.22.0",
   "description": "",
   "main": "lib/index.js",
   "scripts": {
@@ -13,17 +13,20 @@
   "license": "ISC",
   "dependencies": {
     "@aws-sdk/client-secrets-manager": "3.218.0",
-    "@squiz/dx-json-schema-lib": "1.21.1-alpha.9",
-    "@squiz/dx-logger-lib": "1.21.1-alpha.9",
+    "@squiz/dx-json-schema-lib": "1.22.0",
+    "@squiz/dx-logger-lib": "1.22.0",
     "archiver": "5.3.1",
-    "fs-extra": "11.1.0"
+    "escape-string-regexp": "4.0.0",
+    "fs-extra": "11.1.0",
+    "lodash.clonedeep": "4.5.0"
   },
   "devDependencies": {
     "@types/archiver": "5.3.1",
     "@types/express": "4.17.17",
     "@types/fs-extra": "11.0.1",
     "@types/jest": "28.1.8",
-    "@types/node": "17.0.27",
+    "@types/lodash.clonedeep": "4.5.7",
+    "@types/node": "18.15.2",
     "dotenv": "16.0.3",
     "jest": "29.4.1",
     "rimraf": "4.1.2",
@@ -32,5 +35,5 @@
     "ts-node": "10.9.1",
     "typescript": "4.9.4"
   },
-  "gitHead": "64afcee1b33efbff451aa0ef4e727c4e8a079621"
+  "gitHead": "c683f01b30c8b35cc23c5bd7426778a94467baec"
 }

package/src/index.ts

@@ -11,3 +11,4 @@ export * from './api-key-validation/getApiKeyService';
 export * from './server-utils/apiKeyMiddleware';
 export * from './cache';
 export * from './formatted-text/formattedTextToHtmlString';
+export * from './json-order';

package/src/json-order/index.ts

@@ -0,0 +1,6 @@
+import order from './order';
+import parse from './parse';
+import stringify from './stringify';
+
+export { PropertyMap } from './models';
+export const jsonOrder = { order, parse, stringify };

package/src/json-order/key.spec.ts

@@ -0,0 +1,39 @@
+import { escapeKey, splitKey } from './key';
+
+describe('escapeKey()', () => {
+  it.each([
+    ['key does not contain a separator or slash', 'object_property_name', '~', 'object_property_name'],
+    ['key contains the separator character', 'object~property~name', '~', 'object\\~property\\~name'],
+    [
+      'key contains the separator character, using a multi-character separator',
+      'object$$property$$name',
+      '$$',
+      'object\\$$property\\$$name',
+    ],
+    ['key contains the escape character', 'object\\property\\name', '~', 'object\\\\property\\\\name'],
+  ])('handles when %s', (description: string, key: string, separator: string, expected: string) => {
+    expect(escapeKey(key, separator)).toEqual(expected);
+  });
+});
+
+describe('splitKey()', () => {
+  it.each([
+    ['key does not contain any escape sequences', 'object~property~name', '~', ['object', 'property', 'name']],
+    [
+      'key does not contain any escape sequences, using a multi-character separator',
+      'object$$property$$name',
+      '$$',
+      ['object', 'property', 'name'],
+    ],
+    ['key contains an escaped separator', 'object~property\\~name', '~', ['object', 'property~name']],
+    [
+      'keys contains an escaped separator, using a multi-character separator',
+      'object$$property\\$$name',
+      '$$',
+      ['object', 'property$$name'],
+    ],
+    ['it contains an escaped slash', 'object~property\\\\name', '~', ['object', 'property\\name']],
+  ])('handles when %s', (description: string, key: string, separator: string, expected: Array<string>) => {
+    expect(splitKey(key, separator)).toEqual(expected);
+  });
+});

package/src/json-order/key.ts

@@ -0,0 +1,40 @@
+import escapeStringRegexp from 'escape-string-regexp';
+
+export const escapeKey = (key: string, separator: string): string => {
+  const stringsToEscape = ['\\', separator];
+  const pattern = stringsToEscape.map((string) => escapeStringRegexp(string)).join('|');
+
+  return key.replace(new RegExp(`(${pattern})`, 'g'), '\\$1');
+};
+
+export const splitKey = (key: string, separator: string): Array<string> => {
+  // if key doesn't have any escape sequence avoid iterating through the characters.
+  if (key.indexOf('\\') < 0) {
+    return key.split(separator);
+  }
+
+  const parts: Array<string> = [];
+  let currentPart = '';
+  let isLiteral = false;
+
+  for (let index = 0; index < key.length; index++) {
+    const character = key[index];
+
+    if (isLiteral) {
+      currentPart += character;
+      isLiteral = false;
+    } else if (character === '\\') {
+      isLiteral = true;
+    } else if (character === separator[0] && key.substr(index, separator.length) === separator) {
+      parts.push(currentPart);
+      currentPart = '';
+      index += separator.length - 1;
+    } else {
+      currentPart += character;
+    }
+  }
+
+  parts.push(currentPart);
+
+  return parts;
+};

package/src/json-order/models.ts

@@ -0,0 +1,8 @@
+export interface PropertyMap {
+  [key: string]: Array<string>;
+}
+
+export interface OrderedParseResult<T> {
+  object: T;
+  map: PropertyMap;
+}