@contrail/util 1.0.11 → 1.0.15

package/lib/index.d.ts

@@ -1,2 +1,2 @@
-export * from './object-util/object-util';
-export * from './string-util/string-util';
+export * from './object-util/object-util';
+export * from './string-util/string-util';

package/lib/index.js

@@ -1,14 +1,14 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !exports.hasOwnProperty(p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./object-util/object-util"), exports);
-__exportStar(require("./string-util/string-util"), exports);
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !exports.hasOwnProperty(p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./object-util/object-util"), exports);
+__exportStar(require("./string-util/string-util"), exports);

package/lib/object-util/cloneDeep/cloneDeep.d.ts

@@ -1 +1 @@
-export declare function cloneDeep(obj: any): any;
+export declare function cloneDeep(obj: any): any;

package/lib/object-util/cloneDeep/cloneDeep.js

@@ -1,10 +1,10 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.cloneDeep = void 0;
-function cloneDeep(obj) {
-    if (!obj) {
-        return null;
-    }
-    return JSON.parse(JSON.stringify(obj));
-}
-exports.cloneDeep = cloneDeep;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.cloneDeep = void 0;
+function cloneDeep(obj) {
+    if (!obj) {
+        return null;
+    }
+    return JSON.parse(JSON.stringify(obj));
+}
+exports.cloneDeep = cloneDeep;

package/lib/object-util/compareDeep/compareDeep.d.ts

@@ -0,0 +1,7 @@
+export interface ObjectDiff {
+    propertyName: string;
+    oldValue: any;
+    newValue: any;
+}
+export declare function getObjectDiffs(before: any, after: any, prefix: string): ObjectDiff[];
+export declare function getObjectDiff(before: any, after: any, name: any): ObjectDiff;

package/lib/object-util/compareDeep/compareDeep.js

@@ -0,0 +1,87 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getObjectDiff = exports.getObjectDiffs = void 0;
+function getObjectDiffs(before, after, prefix) {
+    const diffs = [];
+    if (!before || !after) {
+        return diffs;
+    }
+    const beforeProperties = Object.getOwnPropertyNames(before);
+    const afterProperties = Object.getOwnPropertyNames(after);
+    const addedProperties = afterProperties.filter(value => !beforeProperties.includes(value));
+    const deletedProperties = beforeProperties.filter(value => !afterProperties.includes(value));
+    const commonProperties = beforeProperties.filter(value => afterProperties.includes(value));
+    addedProperties.forEach(addedProperty => {
+        diffs.push(getObjectDiff(null, after[addedProperty], prefix + addedProperty));
+    });
+    deletedProperties.forEach(deletedProperty => {
+        diffs.push(getObjectDiff(before[deletedProperty], null, prefix + deletedProperty));
+    });
+    commonProperties.forEach(commonProperty => {
+        const beforeVal = before[commonProperty];
+        const afterVal = after[commonProperty];
+        if (beforeVal === afterVal) {
+            return;
+        }
+        if (beforeVal === null || afterVal === null) {
+            diffs.push(getObjectDiff(beforeVal, afterVal, prefix + commonProperty));
+            return;
+        }
+        if (typeof beforeVal !== typeof afterVal) {
+            diffs.push(getObjectDiff(beforeVal, afterVal, prefix + commonProperty));
+            return;
+        }
+        if (isObject(beforeVal)) {
+            if (isDate(beforeVal)) {
+                if (!datesEqual(beforeVal, afterVal)) {
+                    diffs.push(getObjectDiff(beforeVal, afterVal, prefix + commonProperty));
+                }
+            }
+            else if (Array.isArray(beforeVal)) {
+                const beforeArray = [...beforeVal].sort(sortFunc);
+                const afterArray = [...afterVal].sort(sortFunc);
+                if (JSON.stringify(beforeArray) !== JSON.stringify(afterArray)) {
+                    diffs.push(getObjectDiff(beforeVal, afterVal, prefix + commonProperty));
+                }
+            }
+            else {
+                const nestedObjectDiffs = getObjectDiffs(beforeVal, afterVal, prefix + commonProperty + '.');
+                diffs.push(...nestedObjectDiffs);
+            }
+        }
+        else {
+            if (beforeVal !== afterVal) {
+                diffs.push(getObjectDiff(beforeVal, afterVal, prefix + commonProperty));
+            }
+        }
+    });
+    return diffs;
+}
+exports.getObjectDiffs = getObjectDiffs;
+function getObjectDiff(before, after, name) {
+    const diff = {
+        propertyName: name,
+        oldValue: before,
+        newValue: after,
+    };
+    return diff;
+}
+exports.getObjectDiff = getObjectDiff;
+function sortFunc(x, y) {
+    const pre = ['string', 'number', 'bool'];
+    if (typeof x !== typeof y)
+        return pre.indexOf(typeof y) - pre.indexOf(typeof x);
+    if (x === y)
+        return 0;
+    else
+        return (x > y) ? 1 : -1;
+}
+function isObject(object) {
+    return object != null && typeof object === 'object';
+}
+function isDate(object) {
+    return object != null && object instanceof Date;
+}
+function datesEqual(date1, date2) {
+    return date1.getTime() === date2.getTime();
+}

package/lib/object-util/compareDeep/mockData.d.ts

@@ -0,0 +1,88 @@
+export declare const item1Assortment1: {
+    id: string;
+    stringProperty: string;
+    intProperty: number;
+    boolProperty: boolean;
+    dateProperty: Date;
+    arrayProperty: string[];
+};
+export declare const item1Assortment2: {
+    id: string;
+    stringProperty: string;
+    intProperty: number;
+    boolProperty: boolean;
+    dateProperty: Date;
+    arrayProperty: string[];
+};
+export declare const item1Assortment3: {
+    id: string;
+    stringProperty: string;
+    intProperty: number;
+    boolProperty: boolean;
+    dateProperty: Date;
+    arrayProperty: any;
+};
+export declare const item2Assortment1: {
+    id: string;
+    stringProperty: string;
+    intProperty: number;
+    boolProperty: boolean;
+    dateProperty: Date;
+    arrayProperty: string[];
+};
+export declare const item2Assortment2ScalarChange: {
+    id: string;
+    stringProperty: string;
+    intProperty: number;
+    boolProperty: boolean;
+    dateProperty: Date;
+    arrayProperty: string[];
+};
+export declare const item2Assortment2ArrayChange: {
+    id: string;
+    stringProperty: string;
+    intProperty: number;
+    boolProperty: boolean;
+    dateProperty: Date;
+    arrayProperty: string[];
+};
+export declare const item2Assortment2DateChange: {
+    id: string;
+    stringProperty: string;
+    intProperty: number;
+    boolProperty: boolean;
+    dateProperty: Date;
+    arrayProperty: string[];
+};
+export declare const item3Assortment1: {
+    id: string;
+    stringProperty: string;
+    intProperty: number;
+    boolProperty: boolean;
+    dateProperty: Date;
+    arrayProperty: string[];
+    nestedProperties: {
+        nestedBoolProperty: boolean;
+        nestedDateProperty: Date;
+        nestedArrayProperty: string[];
+        nestedObject: {
+            nestedBoolProperty: boolean;
+        };
+    };
+};
+export declare const item3Assortment2NestedChanges: {
+    id: string;
+    stringProperty: string;
+    intProperty: number;
+    boolProperty: boolean;
+    dateProperty: Date;
+    arrayProperty: string[];
+    nestedProperties: {
+        nestedBoolProperty: boolean;
+        nestedDateProperty: Date;
+        nestedArrayProperty: string[];
+        nestedObject: {
+            nestedBoolProperty: boolean;
+        };
+    };
+};

package/lib/object-util/compareDeep/mockData.js

@@ -0,0 +1,91 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.item3Assortment2NestedChanges = exports.item3Assortment1 = exports.item2Assortment2DateChange = exports.item2Assortment2ArrayChange = exports.item2Assortment2ScalarChange = exports.item2Assortment1 = exports.item1Assortment3 = exports.item1Assortment2 = exports.item1Assortment1 = void 0;
+exports.item1Assortment1 = {
+    id: 'id1',
+    stringProperty: 'stringProperty1',
+    intProperty: 1,
+    boolProperty: false,
+    dateProperty: new Date('12/22/1994'),
+    arrayProperty: ['A', 'B', 'C'],
+};
+exports.item1Assortment2 = {
+    id: 'id1',
+    stringProperty: 'stringProperty1',
+    intProperty: 1,
+    boolProperty: false,
+    dateProperty: new Date('12/22/1994'),
+    arrayProperty: ['A', 'B', 'C'],
+};
+exports.item1Assortment3 = {
+    id: 'id1',
+    stringProperty: 'stringProperty1',
+    intProperty: 1,
+    boolProperty: false,
+    dateProperty: new Date('12/22/1994'),
+    arrayProperty: null,
+};
+exports.item2Assortment1 = {
+    id: 'id2',
+    stringProperty: 'stringProperty2',
+    intProperty: 2,
+    boolProperty: false,
+    dateProperty: new Date('12/23/1994'),
+    arrayProperty: ['A', 'B'],
+};
+exports.item2Assortment2ScalarChange = {
+    id: 'id2',
+    stringProperty: 'stringProperty3Update',
+    intProperty: 4,
+    boolProperty: true,
+    dateProperty: new Date('12/23/1994'),
+    arrayProperty: ['A', 'B'],
+};
+exports.item2Assortment2ArrayChange = {
+    id: 'id2',
+    stringProperty: 'stringProperty2',
+    intProperty: 2,
+    boolProperty: false,
+    dateProperty: new Date('12/23/1994'),
+    arrayProperty: ['A', 'B', 'D'],
+};
+exports.item2Assortment2DateChange = {
+    id: 'id2',
+    stringProperty: 'stringProperty2',
+    intProperty: 2,
+    boolProperty: false,
+    dateProperty: new Date('12/23/1995'),
+    arrayProperty: ['A', 'B'],
+};
+exports.item3Assortment1 = {
+    id: 'id3',
+    stringProperty: 'stringProperty2',
+    intProperty: 2,
+    boolProperty: false,
+    dateProperty: new Date('12/23/1994'),
+    arrayProperty: ['A', 'B'],
+    nestedProperties: {
+        nestedBoolProperty: false,
+        nestedDateProperty: new Date('12/22/1994'),
+        nestedArrayProperty: ['C', 'D'],
+        nestedObject: {
+            nestedBoolProperty: false,
+        },
+    },
+};
+exports.item3Assortment2NestedChanges = {
+    id: 'id3',
+    stringProperty: 'stringProperty2',
+    intProperty: 2,
+    boolProperty: true,
+    dateProperty: new Date('12/23/1994'),
+    arrayProperty: ['A', 'B'],
+    nestedProperties: {
+        nestedBoolProperty: false,
+        nestedDateProperty: new Date('12/23/1995'),
+        nestedArrayProperty: ['C', 'D', 'A'],
+        nestedObject: {
+            nestedBoolProperty: true,
+        },
+    },
+};

package/lib/object-util/isObject/isObject.d.ts

@@ -1 +1 @@
-export declare function isObject(item: any): boolean;
+export declare function isObject(item: any): boolean;

package/lib/object-util/isObject/isObject.js

@@ -1,7 +1,7 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.isObject = void 0;
-function isObject(item) {
-    return (item && typeof item === 'object' && !Array.isArray(item));
-}
-exports.isObject = isObject;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isObject = void 0;
+function isObject(item) {
+    return (item && typeof item === 'object' && !Array.isArray(item));
+}
+exports.isObject = isObject;

package/lib/object-util/mergeDeep/mergeDeep.d.ts

@@ -1 +1 @@
-export declare function mergeDeep(target: any, ...sources: any[]): any;
+export declare function mergeDeep(target: any, ...sources: any[]): any;

package/lib/object-util/mergeDeep/mergeDeep.js

@@ -1,23 +1,23 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.mergeDeep = void 0;
-const isObject_1 = require("../isObject/isObject");
-function mergeDeep(target, ...sources) {
-    if (!sources.length)
-        return target;
-    const source = sources.shift();
-    if (isObject_1.isObject(target) && isObject_1.isObject(source)) {
-        for (const key in source) {
-            if (isObject_1.isObject(source[key])) {
-                if (!target[key])
-                    Object.assign(target, { [key]: {} });
-                mergeDeep(target[key], source[key]);
-            }
-            else {
-                Object.assign(target, { [key]: source[key] });
-            }
-        }
-    }
-    return mergeDeep(target, ...sources);
-}
-exports.mergeDeep = mergeDeep;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.mergeDeep = void 0;
+const isObject_1 = require("../isObject/isObject");
+function mergeDeep(target, ...sources) {
+    if (!sources.length)
+        return target;
+    const source = sources.shift();
+    if (isObject_1.isObject(target) && isObject_1.isObject(source)) {
+        for (const key in source) {
+            if (isObject_1.isObject(source[key])) {
+                if (!target[key])
+                    Object.assign(target, { [key]: {} });
+                mergeDeep(target[key], source[key]);
+            }
+            else {
+                Object.assign(target, { [key]: source[key] });
+            }
+        }
+    }
+    return mergeDeep(target, ...sources);
+}
+exports.mergeDeep = mergeDeep;

package/lib/object-util/object-util.d.ts

@@ -1,10 +1,13 @@
-import { cloneDeep } from './cloneDeep/cloneDeep';
-import { isObject } from './isObject/isObject';
-import { mergeDeep } from './mergeDeep/mergeDeep';
-export declare class ObjectUtil {
-    static getByPath(obj: any, path: string, def?: any): any;
-    static setByPath(obj: any, path: string, value: any): void;
-    static isObject: typeof isObject;
-    static mergeDeep: typeof mergeDeep;
-    static cloneDeep: typeof cloneDeep;
-}
+import { cloneDeep } from './cloneDeep/cloneDeep';
+import { isObject } from './isObject/isObject';
+import { mergeDeep } from './mergeDeep/mergeDeep';
+import { getObjectDiffs } from './compareDeep/compareDeep';
+export { ObjectDiff } from './compareDeep/compareDeep';
+export declare class ObjectUtil {
+    static getByPath(obj: any, path: string, def?: any): any;
+    static setByPath(obj: any, path: string, value: any): void;
+    static isObject: typeof isObject;
+    static mergeDeep: typeof mergeDeep;
+    static cloneDeep: typeof cloneDeep;
+    static compareDeep: typeof getObjectDiffs;
+}

package/lib/object-util/object-util.js

@@ -1,38 +1,40 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ObjectUtil = void 0;
-const cloneDeep_1 = require("./cloneDeep/cloneDeep");
-const isObject_1 = require("./isObject/isObject");
-const mergeDeep_1 = require("./mergeDeep/mergeDeep");
-class ObjectUtil {
-    static getByPath(obj, path, def = null) {
-        const pathUnits = path
-            .replace(/\[/g, '.')
-            .replace(/]/g, '')
-            .split('.');
-        pathUnits.forEach((level) => {
-            if (obj) {
-                obj = obj[level];
-            }
-        });
-        if (obj === undefined) {
-            return def;
-        }
-        return obj;
-    }
-    static setByPath(obj, path, value) {
-        const a = path.split('.');
-        let o = obj;
-        while (a.length - 1) {
-            const n = a.shift();
-            if (!(n in o))
-                o[n] = {};
-            o = o[n];
-        }
-        o[a[0]] = value;
-    }
-}
-exports.ObjectUtil = ObjectUtil;
-ObjectUtil.isObject = isObject_1.isObject;
-ObjectUtil.mergeDeep = mergeDeep_1.mergeDeep;
-ObjectUtil.cloneDeep = cloneDeep_1.cloneDeep;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ObjectUtil = void 0;
+const cloneDeep_1 = require("./cloneDeep/cloneDeep");
+const isObject_1 = require("./isObject/isObject");
+const mergeDeep_1 = require("./mergeDeep/mergeDeep");
+const compareDeep_1 = require("./compareDeep/compareDeep");
+class ObjectUtil {
+    static getByPath(obj, path, def = null) {
+        const pathUnits = path
+            .replace(/\[/g, '.')
+            .replace(/]/g, '')
+            .split('.');
+        pathUnits.forEach((level) => {
+            if (obj) {
+                obj = obj[level];
+            }
+        });
+        if (obj === undefined) {
+            return def;
+        }
+        return obj;
+    }
+    static setByPath(obj, path, value) {
+        const a = path.split('.');
+        let o = obj;
+        while (a.length - 1) {
+            const n = a.shift();
+            if (!(n in o))
+                o[n] = {};
+            o = o[n];
+        }
+        o[a[0]] = value;
+    }
+}
+exports.ObjectUtil = ObjectUtil;
+ObjectUtil.isObject = isObject_1.isObject;
+ObjectUtil.mergeDeep = mergeDeep_1.mergeDeep;
+ObjectUtil.cloneDeep = cloneDeep_1.cloneDeep;
+ObjectUtil.compareDeep = compareDeep_1.getObjectDiffs;

package/lib/string-util/string-util.d.ts

@@ -1,3 +1,5 @@
-export declare class StringUtil {
-    static convertToHyphenCase(entityName: string, transformToLowerCase?: boolean): string;
-}
+export declare class StringUtil {
+    static convertToHyphenCase(entityName: string, transformToLowerCase?: boolean): string;
+    static parseVariables(variableString: string, data: any, quoteStrings?: boolean): string;
+    static isString(value: any): boolean;
+}

package/lib/string-util/string-util.js

@@ -1,13 +1,38 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.StringUtil = void 0;
-class StringUtil {
-    static convertToHyphenCase(entityName, transformToLowerCase = true) {
-        const slugName = entityName === null || entityName === void 0 ? void 0 : entityName.split(/(?=[A-Z])/).join('-');
-        if (slugName && transformToLowerCase) {
-            return slugName.toLowerCase();
-        }
-        return slugName;
-    }
-}
-exports.StringUtil = StringUtil;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.StringUtil = void 0;
+class StringUtil {
+    static convertToHyphenCase(entityName, transformToLowerCase = true) {
+        const slugName = entityName === null || entityName === void 0 ? void 0 : entityName.split(/(?=[A-Z])/).join('-');
+        if (slugName && transformToLowerCase) {
+            return slugName.toLowerCase();
+        }
+        return slugName;
+    }
+    static parseVariables(variableString, data, quoteStrings = false) {
+        const regExp = /\{([^}]+)\}/;
+        let done = false;
+        let currentVariableString = variableString;
+        while (!done) {
+            const match = regExp.exec(currentVariableString);
+            if (!match) {
+                done = true;
+                break;
+            }
+            const variableLevels = match[1].split('.');
+            let replacementValue = data;
+            for (let i = 0; i < variableLevels.length; i++) {
+                replacementValue = replacementValue[variableLevels[i]];
+            }
+            if (quoteStrings && StringUtil.isString(replacementValue)) {
+                replacementValue = JSON.stringify(replacementValue);
+            }
+            currentVariableString = currentVariableString.replace(match[0], replacementValue);
+        }
+        return currentVariableString;
+    }
+    static isString(value) {
+        return typeof value === 'string' || value instanceof String;
+    }
+}
+exports.StringUtil = StringUtil;

package/package.json

@@ -1,41 +1,41 @@
-{
-  "name": "@contrail/util",
-  "version": "1.0.11",
-  "description": "General javascript utilities",
-  "main": "lib/index.js",
-  "types": "lib/index.d.ts",
-  "scripts": {
-    "build": "tsc",
-    "format": "prettier --write \"src/**/*.ts\" \"src/**/*.js\"",
-    "lint": "tslint -p tsconfig.json",
-    "test:watch": "jest --watch",
-    "test": "jest"
-  },
-  "keywords": [],
-  "author": "",
-  "license": "ISC",
-  "devDependencies": {
-    "@types/jest": "^23.3.14",
-    "jest": "^23.6.0",
-    "prettier": "^1.19.1",
-    "ts-jest": "^23.10.5",
-    "tslint": "^5.11.0",
-    "tslint-config-prettier": "^1.18.0",
-    "typescript": "^3.0.1"
-  },
-  "jest": {
-    "moduleFileExtensions": [
-      "js",
-      "json",
-      "ts"
-    ],
-    "rootDir": "src",
-    "testRegex": ".spec.ts$",
-    "transform": {
-      "^.+\\.(t|j)s$": "ts-jest"
-    },
-    "coverageDirectory": "../coverage",
-    "testEnvironment": "node"
-  },
-  "dependencies": {}
-}
+{
+  "name": "@contrail/util",
+  "version": "1.0.15",
+  "description": "General javascript utilities",
+  "main": "lib/index.js",
+  "types": "lib/index.d.ts",
+  "scripts": {
+    "build": "tsc",
+    "format": "prettier --write \"src/**/*.ts\" \"src/**/*.js\"",
+    "lint": "tslint -p tsconfig.json",
+    "test:watch": "jest --watch",
+    "test": "jest"
+  },
+  "keywords": [],
+  "author": "",
+  "license": "ISC",
+  "devDependencies": {
+    "@types/jest": "^23.3.14",
+    "jest": "^23.6.0",
+    "prettier": "^1.19.1",
+    "ts-jest": "^23.10.5",
+    "tslint": "^5.11.0",
+    "tslint-config-prettier": "^1.18.0",
+    "typescript": "^3.0.1"
+  },
+  "jest": {
+    "moduleFileExtensions": [
+      "js",
+      "json",
+      "ts"
+    ],
+    "rootDir": "src",
+    "testRegex": ".spec.ts$",
+    "transform": {
+      "^.+\\.(t|j)s$": "ts-jest"
+    },
+    "coverageDirectory": "../coverage",
+    "testEnvironment": "node"
+  },
+  "dependencies": {}
+}