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

package/.npm/_logs/2023-03-29T01_26_08_740Z-debug-0.log

@@ -0,0 +1,37 @@
+0 verbose cli /usr/local/bin/node /usr/local/bin/npm
+1 info using npm@9.5.0
+2 info using node@v18.15.0
+3 timing npm:load:whichnode Completed in 1ms
+4 timing config:load:defaults Completed in 2ms
+5 timing config:load:file:/usr/local/lib/node_modules/npm/npmrc Completed in 0ms
+6 timing config:load:builtin Completed in 1ms
+7 timing config:load:cli Completed in 1ms
+8 timing config:load:env Completed in 1ms
+9 info found workspace root at /builds/developer-experience/cmp
+10 timing config:load:file:/builds/developer-experience/cmp/.npmrc Completed in 0ms
+11 timing config:load:project Completed in 19ms
+12 timing config:load:file:/root/.npmrc Completed in 1ms
+13 timing config:load:user Completed in 1ms
+14 timing config:load:file:/usr/local/etc/npmrc Completed in 0ms
+15 timing config:load:global Completed in 0ms
+16 timing config:load:setEnvs Completed in 1ms
+17 timing config:load Completed in 28ms
+18 timing npm:load:configload Completed in 28ms
+19 timing npm:load:mkdirpcache Completed in 0ms
+20 timing npm:load:mkdirplogs Completed in 1ms
+21 verbose title npm run compile
+22 verbose argv "run" "compile" "--"
+23 timing npm:load:setTitle Completed in 1ms
+24 timing config:load:flatten Completed in 4ms
+25 timing npm:load:display Completed in 6ms
+26 verbose logfile logs-max:10 dir:/builds/developer-experience/cmp/packages/dx-common-lib/.npm/_logs/2023-03-29T01_26_08_740Z-
+27 verbose logfile /builds/developer-experience/cmp/packages/dx-common-lib/.npm/_logs/2023-03-29T01_26_08_740Z-debug-0.log
+28 timing npm:load:logFile Completed in 4ms
+29 timing npm:load:timers Completed in 0ms
+30 timing npm:load:configScope Completed in 0ms
+31 timing npm:load Completed in 42ms
+32 silly logfile done cleaning log files
+33 timing command:run Completed in 5560ms
+34 verbose exit 0
+35 timing npm Completed in 5616ms
+36 info ok

package/lib/index.d.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/lib/index.js

@@ -27,4 +27,5 @@ __exportStar(require("./api-key-validation/getApiKeyService"), exports);
 __exportStar(require("./server-utils/apiKeyMiddleware"), exports);
 __exportStar(require("./cache"), exports);
 __exportStar(require("./formatted-text/formattedTextToHtmlString"), exports);
+__exportStar(require("./json-order"), exports);
 //# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,gDAA8B;AAC9B,0CAAwB;AACxB,yCAAuB;AACvB,qDAAmC;AACnC,iEAA+C;AAC/C,+DAA6C;AAC7C,+EAA6D;AAC7D,+EAA6D;AAC7D,gFAA8D;AAC9D,wEAAsD;AACtD,kEAAgD;AAChD,0CAAwB;AACxB,6EAA2D"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,gDAA8B;AAC9B,0CAAwB;AACxB,yCAAuB;AACvB,qDAAmC;AACnC,iEAA+C;AAC/C,+DAA6C;AAC7C,+EAA6D;AAC7D,+EAA6D;AAC7D,gFAA8D;AAC9D,wEAAsD;AACtD,kEAAgD;AAChD,0CAAwB;AACxB,6EAA2D;AAC3D,+CAA6B"}

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

@@ -0,0 +1,6 @@
+export { PropertyMap } from './models';
+export declare const jsonOrder: {
+    order: <T extends object>(sourceObject: T, map: import("./models").PropertyMap | null, separator?: string) => T;
+    parse: <T_1 extends object>(jsonString: string, prefix?: string, separator?: string) => import("./models").OrderedParseResult<T_1>;
+    stringify: (sourceObject: object, map: import("./models").PropertyMap | null, separator?: string, space?: number | undefined) => string;
+};

package/lib/json-order/index.js

@@ -0,0 +1,11 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.jsonOrder = void 0;
+const order_1 = __importDefault(require("./order"));
+const parse_1 = __importDefault(require("./parse"));
+const stringify_1 = __importDefault(require("./stringify"));
+exports.jsonOrder = { order: order_1.default, parse: parse_1.default, stringify: stringify_1.default };
+//# sourceMappingURL=index.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/json-order/index.ts"],"names":[],"mappings":";;;;;;AAAA,oDAA4B;AAC5B,oDAA4B;AAC5B,4DAAoC;AAGvB,QAAA,SAAS,GAAG,EAAE,KAAK,EAAL,eAAK,EAAE,KAAK,EAAL,eAAK,EAAE,SAAS,EAAT,mBAAS,EAAE,CAAC"}

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

@@ -0,0 +1,2 @@
+export declare const escapeKey: (key: string, separator: string) => string;
+export declare const splitKey: (key: string, separator: string) => Array<string>;

package/lib/json-order/key.js

@@ -0,0 +1,44 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.splitKey = exports.escapeKey = void 0;
+const escape_string_regexp_1 = __importDefault(require("escape-string-regexp"));
+const escapeKey = (key, separator) => {
+    const stringsToEscape = ['\\', separator];
+    const pattern = stringsToEscape.map((string) => (0, escape_string_regexp_1.default)(string)).join('|');
+    return key.replace(new RegExp(`(${pattern})`, 'g'), '\\$1');
+};
+exports.escapeKey = escapeKey;
+const splitKey = (key, separator) => {
+    // if key doesn't have any escape sequence avoid iterating through the characters.
+    if (key.indexOf('\\') < 0) {
+        return key.split(separator);
+    }
+    const parts = [];
+    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;
+};
+exports.splitKey = splitKey;
+//# sourceMappingURL=key.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"key.js","sourceRoot":"","sources":["../../src/json-order/key.ts"],"names":[],"mappings":";;;;;;AAAA,gFAAsD;AAE/C,MAAM,SAAS,GAAG,CAAC,GAAW,EAAE,SAAiB,EAAU,EAAE;IAClE,MAAM,eAAe,GAAG,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC;IAC1C,MAAM,OAAO,GAAG,eAAe,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,IAAA,8BAAkB,EAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAEtF,OAAO,GAAG,CAAC,OAAO,CAAC,IAAI,MAAM,CAAC,IAAI,OAAO,GAAG,EAAE,GAAG,CAAC,EAAE,MAAM,CAAC,CAAC;AAC9D,CAAC,CAAC;AALW,QAAA,SAAS,aAKpB;AAEK,MAAM,QAAQ,GAAG,CAAC,GAAW,EAAE,SAAiB,EAAiB,EAAE;IACxE,kFAAkF;IAClF,IAAI,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE;QACzB,OAAO,GAAG,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;KAC7B;IAED,MAAM,KAAK,GAAkB,EAAE,CAAC;IAChC,IAAI,WAAW,GAAG,EAAE,CAAC;IACrB,IAAI,SAAS,GAAG,KAAK,CAAC;IAEtB,KAAK,IAAI,KAAK,GAAG,CAAC,EAAE,KAAK,GAAG,GAAG,CAAC,MAAM,EAAE,KAAK,EAAE,EAAE;QAC/C,MAAM,SAAS,GAAG,GAAG,CAAC,KAAK,CAAC,CAAC;QAE7B,IAAI,SAAS,EAAE;YACb,WAAW,IAAI,SAAS,CAAC;YACzB,SAAS,GAAG,KAAK,CAAC;SACnB;aAAM,IAAI,SAAS,KAAK,IAAI,EAAE;YAC7B,SAAS,GAAG,IAAI,CAAC;SAClB;aAAM,IAAI,SAAS,KAAK,SAAS,CAAC,CAAC,CAAC,IAAI,GAAG,CAAC,MAAM,CAAC,KAAK,EAAE,SAAS,CAAC,MAAM,CAAC,KAAK,SAAS,EAAE;YAC1F,KAAK,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;YACxB,WAAW,GAAG,EAAE,CAAC;YACjB,KAAK,IAAI,SAAS,CAAC,MAAM,GAAG,CAAC,CAAC;SAC/B;aAAM;YACL,WAAW,IAAI,SAAS,CAAC;SAC1B;KACF;IAED,KAAK,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;IAExB,OAAO,KAAK,CAAC;AACf,CAAC,CAAC;AA9BW,QAAA,QAAQ,YA8BnB"}

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

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

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

@@ -0,0 +1,40 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const key_1 = require("./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, key, separator, expected) => {
+        expect((0, key_1.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, key, separator, expected) => {
+        expect((0, key_1.splitKey)(key, separator)).toEqual(expected);
+    });
+});
+//# sourceMappingURL=key.spec.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"key.spec.js","sourceRoot":"","sources":["../../src/json-order/key.spec.ts"],"names":[],"mappings":";;AAAA,+BAA4C;AAE5C,QAAQ,CAAC,aAAa,EAAE,GAAG,EAAE;IAC3B,EAAE,CAAC,IAAI,CAAC;QACN,CAAC,2CAA2C,EAAE,sBAAsB,EAAE,GAAG,EAAE,sBAAsB,CAAC;QAClG,CAAC,sCAAsC,EAAE,sBAAsB,EAAE,GAAG,EAAE,0BAA0B,CAAC;QACjG;YACE,yEAAyE;YACzE,wBAAwB;YACxB,IAAI;YACJ,4BAA4B;SAC7B;QACD,CAAC,mCAAmC,EAAE,wBAAwB,EAAE,GAAG,EAAE,4BAA4B,CAAC;KACnG,CAAC,CAAC,iBAAiB,EAAE,CAAC,WAAmB,EAAE,GAAW,EAAE,SAAiB,EAAE,QAAgB,EAAE,EAAE;QAC9F,MAAM,CAAC,IAAA,eAAS,EAAC,GAAG,EAAE,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;IACtD,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH,QAAQ,CAAC,YAAY,EAAE,GAAG,EAAE;IAC1B,EAAE,CAAC,IAAI,CAAC;QACN,CAAC,2CAA2C,EAAE,sBAAsB,EAAE,GAAG,EAAE,CAAC,QAAQ,EAAE,UAAU,EAAE,MAAM,CAAC,CAAC;QAC1G;YACE,8EAA8E;YAC9E,wBAAwB;YACxB,IAAI;YACJ,CAAC,QAAQ,EAAE,UAAU,EAAE,MAAM,CAAC;SAC/B;QACD,CAAC,mCAAmC,EAAE,wBAAwB,EAAE,GAAG,EAAE,CAAC,QAAQ,EAAE,eAAe,CAAC,CAAC;QACjG;YACE,uEAAuE;YACvE,0BAA0B;YAC1B,IAAI;YACJ,CAAC,QAAQ,EAAE,gBAAgB,CAAC;SAC7B;QACD,CAAC,8BAA8B,EAAE,yBAAyB,EAAE,GAAG,EAAE,CAAC,QAAQ,EAAE,gBAAgB,CAAC,CAAC;KAC/F,CAAC,CAAC,iBAAiB,EAAE,CAAC,WAAmB,EAAE,GAAW,EAAE,SAAiB,EAAE,QAAuB,EAAE,EAAE;QACrG,MAAM,CAAC,IAAA,cAAQ,EAAC,GAAG,EAAE,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;IACrD,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

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

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

package/lib/json-order/models.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=models.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"models.js","sourceRoot":"","sources":["../../src/json-order/models.ts"],"names":[],"mappings":""}

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

@@ -0,0 +1,11 @@
+import { PropertyMap } from './models';
+/**
+ * Duplicate a JS object but containing 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 `~`.
+ * @returns the source object ordered as per the map
+ */
+declare const order: <T extends object>(sourceObject: T, map: PropertyMap | null, separator?: string) => T;
+export default order;

package/lib/json-order/order.js

@@ -0,0 +1,75 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const lodash_clonedeep_1 = __importDefault(require("lodash.clonedeep"));
+const key_1 = require("./key");
+const getProperty = (obj, key, separator) => {
+    let exists = true;
+    const value = (0, key_1.splitKey)(key, separator)
+        .slice(1)
+        .reduce((o, x) => {
+        exists = o && x in o;
+        if (!exists) {
+            return undefined;
+        }
+        return o[x];
+    }, obj);
+    return { exists, value };
+};
+const setProperty = (obj, key, value, separator) => {
+    (0, key_1.splitKey)(key, separator)
+        .slice(1)
+        .reduce((o, x, idx, src) => {
+        if (idx === src.length - 1) {
+            const valueToSet = Array.isArray(value) ? (0, lodash_clonedeep_1.default)(value).map((p) => (typeof p === 'object' ? {} : p)) : value;
+            o[x] = valueToSet;
+        }
+        return o[x];
+    }, obj);
+};
+const copyProperty = (sourceObject, resultObject, propertyPath, separator) => {
+    const result = getProperty(sourceObject, propertyPath, separator);
+    if (result.exists) {
+        setProperty(resultObject, propertyPath, result.value, separator);
+    }
+};
+/**
+ * Duplicate a JS object but containing 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 `~`.
+ * @returns the source object ordered as per the map
+ */
+const order = (sourceObject, map, separator = '~') => {
+    if (separator.length < 1) {
+        throw new Error('Separator should not be an empty string.');
+    }
+    else if (separator === '\\') {
+        throw new Error('Separator cannot be "\\".');
+    }
+    if (!map) {
+        return sourceObject;
+    }
+    const mapKeys = Object.keys(map);
+    const prefixLength = (mapKeys[0] && mapKeys[0].length) || 0;
+    const resultObject = {};
+    mapKeys.forEach((mk) => {
+        const childKeys = map[mk];
+        // Remove prefix
+        const parentKey = mk.substr(prefixLength);
+        const parent = getProperty(sourceObject, parentKey, separator);
+        if (parent.exists) {
+            // Set a default value for the property
+            const defaultValue = Array.isArray(parent.value) ? parent.value : {};
+            setProperty(resultObject, parentKey, defaultValue, separator);
+            // Fetch value from source and set on output
+            childKeys.forEach((key) => copyProperty(sourceObject, resultObject, `${parentKey}${separator}${(0, key_1.escapeKey)(key, separator)}`, separator));
+        }
+    });
+    return resultObject;
+};
+exports.default = order;
+//# sourceMappingURL=order.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"order.js","sourceRoot":"","sources":["../../src/json-order/order.ts"],"names":[],"mappings":";;;;;AAAA,wEAAyC;AACzC,+BAA4C;AAQ5C,MAAM,WAAW,GAAG,CAAC,GAAW,EAAE,GAAW,EAAE,SAAiB,EAAa,EAAE;IAC7E,IAAI,MAAM,GAAG,IAAI,CAAC;IAElB,MAAM,KAAK,GAAG,IAAA,cAAQ,EAAC,GAAG,EAAE,SAAS,CAAC;SACnC,KAAK,CAAC,CAAC,CAAC;SACR,MAAM,CAAC,CAAC,CAAsB,EAAE,CAAS,EAAE,EAAE;QAC5C,MAAM,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAErB,IAAI,CAAC,MAAM,EAAE;YACX,OAAO,SAAS,CAAC;SAClB;QAED,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC;IACd,CAAC,EAAE,GAAG,CAAC,CAAC;IAEV,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC;AAC3B,CAAC,CAAC;AAEF,MAAM,WAAW,GAAG,CAAC,GAAW,EAAE,GAAW,EAAE,KAAa,EAAE,SAAiB,EAAE,EAAE;IACjF,IAAA,cAAQ,EAAC,GAAG,EAAE,SAAS,CAAC;SACrB,KAAK,CAAC,CAAC,CAAC;SACR,MAAM,CAAC,CAAC,CAAsB,EAAE,CAAS,EAAE,GAAW,EAAE,GAAkB,EAAU,EAAE;QACrF,IAAI,GAAG,KAAK,GAAG,CAAC,MAAM,GAAG,CAAC,EAAE;YAC1B,MAAM,UAAU,GAAG,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAA,0BAAS,EAAC,KAAK,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,KAAK,QAAQ,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;YAChH,CAAC,CAAC,CAAC,CAAC,GAAG,UAAU,CAAC;SACnB;QAED,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC;IACd,CAAC,EAAE,GAAG,CAAC,CAAC;AACZ,CAAC,CAAC;AAEF,MAAM,YAAY,GAAG,CAAC,YAAoB,EAAE,YAAoB,EAAE,YAAoB,EAAE,SAAiB,EAAE,EAAE;IAC3G,MAAM,MAAM,GAAG,WAAW,CAAC,YAAY,EAAE,YAAY,EAAE,SAAS,CAAC,CAAC;IAClE,IAAI,MAAM,CAAC,MAAM,EAAE;QACjB,WAAW,CAAC,YAAY,EAAE,YAAY,EAAE,MAAM,CAAC,KAAK,EAAE,SAAS,CAAC,CAAC;KAClE;AACH,CAAC,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,KAAK,GAAG,CAAmB,YAAe,EAAE,GAAuB,EAAE,SAAS,GAAG,GAAG,EAAK,EAAE;IAC/F,IAAI,SAAS,CAAC,MAAM,GAAG,CAAC,EAAE;QACxB,MAAM,IAAI,KAAK,CAAC,0CAA0C,CAAC,CAAC;KAC7D;SAAM,IAAI,SAAS,KAAK,IAAI,EAAE;QAC7B,MAAM,IAAI,KAAK,CAAC,2BAA2B,CAAC,CAAC;KAC9C;IAED,IAAI,CAAC,GAAG,EAAE;QACR,OAAO,YAAY,CAAC;KACrB;IAED,MAAM,OAAO,GAAG,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACjC,MAAM,YAAY,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,OAAO,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;IAE5D,MAAM,YAAY,GAAG,EAAE,CAAC;IACxB,OAAO,CAAC,OAAO,CAAC,CAAC,EAAE,EAAE,EAAE;QACrB,MAAM,SAAS,GAAG,GAAG,CAAC,EAAE,CAAC,CAAC;QAE1B,gBAAgB;QAChB,MAAM,SAAS,GAAG,EAAE,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC;QAE1C,MAAM,MAAM,GAAG,WAAW,CAAC,YAAY,EAAE,SAAS,EAAE,SAAS,CAAC,CAAC;QAE/D,IAAI,MAAM,CAAC,MAAM,EAAE;YACjB,uCAAuC;YACvC,MAAM,YAAY,GAAG,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC;YAErE,WAAW,CAAC,YAAY,EAAE,SAAS,EAAE,YAAY,EAAE,SAAS,CAAC,CAAC;YAE9D,4CAA4C;YAC5C,SAAS,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE,CACxB,YAAY,CAAC,YAAY,EAAE,YAAY,EAAE,GAAG,SAAS,GAAG,SAAS,GAAG,IAAA,eAAS,EAAC,GAAG,EAAE,SAAS,CAAC,EAAE,EAAE,SAAS,CAAC,CAC5G,CAAC;SACH;IACH,CAAC,CAAC,CAAC;IAEH,OAAO,YAAiB,CAAC;AAC3B,CAAC,CAAC;AAEF,kBAAe,KAAK,CAAC"}

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

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

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

@@ -0,0 +1,191 @@
+"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"));
+describe('order()', () => {
+    const expectObject = (obj, map, res) => expect(JSON.stringify((0, order_1.default)(obj, map, '.'))).toBe(res);
+    it('returns nothing for a blank JSON string', () => expectObject({}, {}, '{}'));
+    it('throws error if separator is an empty string', () => {
+        expect(() => (0, order_1.default)({}, {}, '')).toThrowError('Separator should not be an empty string.');
+    });
+    it('throws error if separator is a slash', () => {
+        expect(() => (0, order_1.default)({}, {}, '\\')).toThrowError('Separator cannot be "\\".');
+    });
+    it('ignores properties not found in source', () => expectObject({}, { $: ['a'] }, '{}'));
+    it('returns regular json string if map is undefined', () => expectObject({ a: '1', b: '2' }, null, '{"a":"1","b":"2"}'));
+    it('ignores properties not found in map', () => expectObject({ a: '1', b: '2' }, { $: ['b'] }, '{"b":"2"}'));
+    it('returns first level object properties in order', () => expectObject({ a: 2, b: 1 }, { $: ['b', 'a'] }, '{"b":1,"a":2}'));
+    it('returns first level array value in order', () => expectObject({ a: ['2', 1, true] }, { $: ['a'] }, '{"a":["2",1,true]}'));
+    it('returns nested [array] > [object] properties in expected order', () => expectObject({ 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', () => expectObject({ 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', () => expectObject({ a: [1, { b: 2, c: 3 }, 4] }, { $: ['a'] }, '{"a":[1,{},4]}'));
+    it('handles multi-character prefix', () => {
+        expect((0, order_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'],
+        }, '.')).toEqual({ i: 7, a: { e: { g: 5, f: 4 }, h: 6, b: { d: 4, c: 3 } } });
+    });
+    it('handles multi-character separator', () => {
+        expect((0, order_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'],
+        }, '~|')).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', () => expectObject({
+        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', () => expectObject({
+        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 no name', () => {
+        expectObject({
+            '': {
+                b: 'str',
+                a: 'str',
+                c: 'str',
+            },
+        }, {
+            $: [''],
+            '$.': ['c', 'b', 'a'],
+        }, '{"":{"c":"str","b":"str","a":"str"}}');
+    });
+    it('handles escape sequences in the object', () => {
+        expectObject({
+            '.a': {
+                b: { t: 'str' },
+                c: { u: 'str' },
+                a: { s: 'str' },
+            },
+            '\\': {
+                a: { v: 'str' },
+            },
+            '\\.': {
+                a: { w: 'str' },
+                b: { x: 'str' },
+            },
+            '.': {
+                b: { y: 'str' },
+                a: { z: 'str' },
+            },
+        }, {
+            $: ['.', '\\.', '\\', '.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'],
+        }, '{".":{"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"}}}');
+    });
+    it('handles escape sequences in child properties of the object', () => {
+        expectObject({
+            property: {
+                '..': { '.': 4, '..': 3 },
+                '.': { '..': 0, '...': 2, '.': 1 },
+                '...': { '.': 5 },
+            },
+        }, {
+            $: ['property'],
+            '$.property': ['.', '..', '...'],
+            '$.property.\\.': ['..', '.', '...'],
+            '$.property.\\.\\.': ['..', '.'],
+            '$.property.\\.\\.\\.': ['.'],
+        }, '{"property":{".":{"..":0,".":1,"...":2},"..":{"..":3,".":4},"...":{".":5}}}');
+    });
+    it('numeric key order defined in map is lost', () => {
+        // Numeric keys aren't ordered per map but instead appear first in ascending order.
+        // See: https://tc39.es/ecma262/#sec-ordinaryownpropertykeys
+        expectObject({
+            4: 'str',
+            a: 'str',
+            3: 'str',
+            b: 'str',
+            2: 'str',
+        }, {
+            $: ['a', '4', 'b', '3', '2'],
+        }, '{"2":"str","3":"str","4":"str","a":"str","b":"str"}');
+    });
+});
+//# sourceMappingURL=order.spec.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"order.spec.js","sourceRoot":"","sources":["../../src/json-order/order.spec.ts"],"names":[],"mappings":";;;;;AAAA,oDAA4B;AAG5B,QAAQ,CAAC,SAAS,EAAE,GAAG,EAAE;IACvB,MAAM,YAAY,GAAG,CAAmB,GAAM,EAAE,GAAuB,EAAE,GAAW,EAAE,EAAE,CACtF,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,IAAA,eAAK,EAAC,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAEzD,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,eAAK,EAAC,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC,CAAC,YAAY,CAAC,0CAA0C,CAAC,CAAC;IAC3F,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,sCAAsC,EAAE,GAAG,EAAE;QAC9C,MAAM,CAAC,GAAG,EAAE,CAAC,IAAA,eAAK,EAAC,EAAE,EAAE,EAAE,EAAE,IAAI,CAAC,CAAC,CAAC,YAAY,CAAC,2BAA2B,CAAC,CAAC;IAC9E,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,eAAK,EACH;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,CACJ,CACF,CAAC,OAAO,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,EAAE,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC;IACzE,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,mCAAmC,EAAE,GAAG,EAAE;QAC3C,MAAM,CACJ,IAAA,eAAK,EACH;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,CACL,CACF,CAAC,OAAO,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,EAAE,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC;IACzE,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,2BAA2B,EAAE,GAAG,EAAE;QACnC,YAAY,CACV;YACE,EAAE,EAAE;gBACF,CAAC,EAAE,KAAK;gBACR,CAAC,EAAE,KAAK;gBACR,CAAC,EAAE,KAAK;aACT;SACF,EACD;YACE,CAAC,EAAE,CAAC,EAAE,CAAC;YACP,IAAI,EAAE,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC;SACtB,EACD,sCAAsC,CACvC,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,wCAAwC,EAAE,GAAG,EAAE;QAChD,YAAY,CACV;YACE,IAAI,EAAE;gBACJ,CAAC,EAAE,EAAE,CAAC,EAAE,KAAK,EAAE;gBACf,CAAC,EAAE,EAAE,CAAC,EAAE,KAAK,EAAE;gBACf,CAAC,EAAE,EAAE,CAAC,EAAE,KAAK,EAAE;aAChB;YACD,IAAI,EAAE;gBACJ,CAAC,EAAE,EAAE,CAAC,EAAE,KAAK,EAAE;aAChB;YACD,KAAK,EAAE;gBACL,CAAC,EAAE,EAAE,CAAC,EAAE,KAAK,EAAE;gBACf,CAAC,EAAE,EAAE,CAAC,EAAE,KAAK,EAAE;aAChB;YACD,GAAG,EAAE;gBACH,CAAC,EAAE,EAAE,CAAC,EAAE,KAAK,EAAE;gBACf,CAAC,EAAE,EAAE,CAAC,EAAE,KAAK,EAAE;aAChB;SACF,EACD;YACE,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,EACD,yCAAyC;YACvC,4CAA4C;YAC5C,2BAA2B;YAC3B,yDAAyD,CAC5D,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,4DAA4D,EAAE,GAAG,EAAE;QACpE,YAAY,CACV;YACE,QAAQ,EAAE;gBACR,IAAI,EAAE,EAAE,GAAG,EAAE,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE;gBACzB,GAAG,EAAE,EAAE,IAAI,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE;gBAClC,KAAK,EAAE,EAAE,GAAG,EAAE,CAAC,EAAE;aAClB;SACF,EACD;YACE,CAAC,EAAE,CAAC,UAAU,CAAC;YACf,YAAY,EAAE,CAAC,GAAG,EAAE,IAAI,EAAE,KAAK,CAAC;YAChC,gBAAgB,EAAE,CAAC,IAAI,EAAE,GAAG,EAAE,KAAK,CAAC;YACpC,mBAAmB,EAAE,CAAC,IAAI,EAAE,GAAG,CAAC;YAChC,sBAAsB,EAAE,CAAC,GAAG,CAAC;SAC9B,EACD,6EAA6E,CAC9E,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,0CAA0C,EAAE,GAAG,EAAE;QAClD,mFAAmF;QACnF,4DAA4D;QAC5D,YAAY,CACV;YACE,CAAC,EAAE,KAAK;YACR,CAAC,EAAE,KAAK;YACR,CAAC,EAAE,KAAK;YACR,CAAC,EAAE,KAAK;YACR,CAAC,EAAE,KAAK;SACT,EACD;YACE,CAAC,EAAE,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC;SAC7B,EACD,qDAAqD,CACtD,CAAC;IACJ,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

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

@@ -0,0 +1,11 @@
+import { OrderedParseResult } from './models';
+/**
+ * Parse a JSON string and generate a map
+ *
+ * @param jsonString a json string
+ * @param prefix a non-empty `string` that controls what the key prefix value is in the generated map. Defaults to `$`.
+ * @param separator a non-empty `string` that controls what the key separator is in the generated map. Defaults to `~`.
+ * @returns an object containing the parsed `object: T` and the `map: PropertyMap`
+ */
+declare const parse: <T extends object>(jsonString: string, prefix?: string, separator?: string) => OrderedParseResult<T>;
+export default parse;

package/lib/json-order/parse.js

@@ -0,0 +1,47 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const key_1 = require("./key");
+const traverseObject = (obj, map, parentKey, separator) => {
+    const childKeys = Object.keys(obj);
+    if (childKeys.length === 0) {
+        return;
+    }
+    // Ignore storing keys for arrays
+    if (!Array.isArray(obj)) {
+        map[`${parentKey}`] = childKeys;
+    }
+    childKeys.forEach((childKey) => {
+        const value = obj[childKey];
+        if (value !== null && typeof value === 'object') {
+            traverseObject(value, map, `${parentKey}${separator}${(0, key_1.escapeKey)(childKey, separator)}`, separator);
+        }
+    });
+};
+/**
+ * Parse a JSON string and generate a map
+ *
+ * @param jsonString a json string
+ * @param prefix a non-empty `string` that controls what the key prefix value is in the generated map. Defaults to `$`.
+ * @param separator a non-empty `string` that controls what the key separator is in the generated map. Defaults to `~`.
+ * @returns an object containing the parsed `object: T` and the `map: PropertyMap`
+ */
+const parse = (jsonString, prefix = '$', separator = '~') => {
+    if (prefix.length < 1) {
+        throw new Error('Prefix should not be an empty string.');
+    }
+    if (separator.length < 1) {
+        throw new Error('Separator should not be an empty string.');
+    }
+    else if (separator === '\\') {
+        throw new Error('Separator cannot be "\\".');
+    }
+    const obj = JSON.parse(jsonString);
+    const map = {};
+    traverseObject(obj, map, (0, key_1.escapeKey)(prefix, separator), separator);
+    return {
+        object: obj,
+        map,
+    };
+};
+exports.default = parse;
+//# sourceMappingURL=parse.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"parse.js","sourceRoot":"","sources":["../../src/json-order/parse.ts"],"names":[],"mappings":";;AAAA,+BAAkC;AAGlC,MAAM,cAAc,GAAG,CACrB,GAAM,EACN,GAAgB,EAChB,SAAiB,EACjB,SAAiB,EACjB,EAAE;IACF,MAAM,SAAS,GAAG,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAEnC,IAAI,SAAS,CAAC,MAAM,KAAK,CAAC,EAAE;QAC1B,OAAO;KACR;IAED,iCAAiC;IACjC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE;QACvB,GAAG,CAAC,GAAG,SAAS,EAAE,CAAC,GAAG,SAAS,CAAC;KACjC;IAED,SAAS,CAAC,OAAO,CAAC,CAAC,QAAQ,EAAE,EAAE;QAC7B,MAAM,KAAK,GAAG,GAAG,CAAC,QAAQ,CAAC,CAAC;QAE5B,IAAI,KAAK,KAAK,IAAI,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE;YAC/C,cAAc,CAAC,KAAK,EAAE,GAAG,EAAE,GAAG,SAAS,GAAG,SAAS,GAAG,IAAA,eAAS,EAAC,QAAQ,EAAE,SAAS,CAAC,EAAE,EAAE,SAAS,CAAC,CAAC;SACpG;IACH,CAAC,CAAC,CAAC;AACL,CAAC,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,KAAK,GAAG,CAAmB,UAAkB,EAAE,MAAM,GAAG,GAAG,EAAE,SAAS,GAAG,GAAG,EAAyB,EAAE;IAC3G,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE;QACrB,MAAM,IAAI,KAAK,CAAC,uCAAuC,CAAC,CAAC;KAC1D;IAED,IAAI,SAAS,CAAC,MAAM,GAAG,CAAC,EAAE;QACxB,MAAM,IAAI,KAAK,CAAC,0CAA0C,CAAC,CAAC;KAC7D;SAAM,IAAI,SAAS,KAAK,IAAI,EAAE;QAC7B,MAAM,IAAI,KAAK,CAAC,2BAA2B,CAAC,CAAC;KAC9C;IAED,MAAM,GAAG,GAAM,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;IAEtC,MAAM,GAAG,GAAG,EAAE,CAAC;IACf,cAAc,CAAC,GAAG,EAAE,GAAG,EAAE,IAAA,eAAS,EAAC,MAAM,EAAE,SAAS,CAAC,EAAE,SAAS,CAAC,CAAC;IAClE,OAAO;QACL,MAAM,EAAE,GAAG;QACX,GAAG;KACJ,CAAC;AACJ,CAAC,CAAC;AAEF,kBAAe,KAAK,CAAC"}

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

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