@etsoo/shared 1.0.77 → 1.0.78

package/README.md

@@ -143,6 +143,8 @@ String and other related utilities
 |newGUID|Create a GUID|
 |numberToChars|Number to base64 chars|
 |objectEqual|Test two objects are equal or not|
+|objectKeys|Get two object's unqiue properties|
+|objectUpdated|Get the new object's updated fields contrast to the previous object|
 |parseString|Parse string (JSON) to specific type|
 |setLabels|Set source with new labels|
 |snakeNameToWord|Snake name to works, 'snake_name' to 'Snake Name'|

package/__tests__/Utils.ts

@@ -92,6 +92,13 @@ test('Tests for objectEqual', () => {
     expect(Utils.objectEqual(obj1, obj2, ['a'], 2)).toBeFalsy();
 });
 
+test('Tests for objectUpdated', () => {
+    const objPrev = { a: 1, b: 'abc', c: true, d: null, f: [1, 2] };
+    const objNew = { a: 2, b: 'abc', d: new Date(), f: [1, 2, 3] };
+    const fields = Utils.objectUpdated(objNew, objPrev, ['d']);
+    expect(fields.sort()).toStrictEqual(['a', 'c', 'f']);
+});
+
 test('Tests for parseString', () => {
     expect(Utils.parseString('test', '')).toBe('test');
     expect(Utils.parseString('true', false)).toBe(true);

package/lib/cjs/Utils.d.ts

@@ -117,6 +117,23 @@ export declare namespace Utils {
      * @returns Result
      */
     function objectEqual(obj1: {}, obj2: {}, ignoreFields?: string[], strict?: number): boolean;
+    /**
+     * Get two object's unqiue properties
+     * @param obj1 Object 1
+     * @param obj2 Object 2
+     * @param ignoreFields Ignored fields
+     * @returns Unique properties
+     */
+    function objectKeys(obj1: {}, obj2: {}, ignoreFields?: string[]): Set<string>;
+    /**
+     * Get the new object's updated fields contrast to the previous object
+     * @param objNew New object
+     * @param objPre Previous object
+     * @param ignoreFields Ignored fields
+     * @param strict Strict level, 0 with ==, 1 === but null equal undefined, 2 ===
+     * @returns Updated fields
+     */
+    function objectUpdated(objNew: {}, objPrev: {}, ignoreFields?: string[], strict?: number): string[];
     /**
      * Parse string (JSON) to specific type
      * @param input Input string

package/lib/cjs/Utils.js

@@ -216,11 +216,8 @@ var Utils;
      * @returns Result
      */
     function objectEqual(obj1, obj2, ignoreFields = [], strict = 1) {
-        // Keys
-        const keys = new Set([
-            ...Object.keys(obj1).filter((item) => !ignoreFields.includes(item)),
-            ...Object.keys(obj2).filter((item) => !ignoreFields.includes(item))
-        ]);
+        // Unique keys
+        const keys = Utils.objectKeys(obj1, obj2, ignoreFields);
         for (const key of keys) {
             // Values
             const v1 = Reflect.get(obj1, key);
@@ -231,6 +228,44 @@ var Utils;
         return true;
     }
     Utils.objectEqual = objectEqual;
+    /**
+     * Get two object's unqiue properties
+     * @param obj1 Object 1
+     * @param obj2 Object 2
+     * @param ignoreFields Ignored fields
+     * @returns Unique properties
+     */
+    function objectKeys(obj1, obj2, ignoreFields = []) {
+        // All keys
+        const allKeys = [...Object.keys(obj1), ...Object.keys(obj2)].filter((item) => !ignoreFields.includes(item));
+        // Unique keys
+        return new Set(allKeys);
+    }
+    Utils.objectKeys = objectKeys;
+    /**
+     * Get the new object's updated fields contrast to the previous object
+     * @param objNew New object
+     * @param objPre Previous object
+     * @param ignoreFields Ignored fields
+     * @param strict Strict level, 0 with ==, 1 === but null equal undefined, 2 ===
+     * @returns Updated fields
+     */
+    function objectUpdated(objNew, objPrev, ignoreFields = [], strict = 1) {
+        // Fields
+        const fields = [];
+        // Unique keys
+        const keys = Utils.objectKeys(objNew, objPrev, ignoreFields);
+        for (const key of keys) {
+            // Values
+            const vNew = Reflect.get(objNew, key);
+            const vPrev = Reflect.get(objPrev, key);
+            if (!Utils.equals(vNew, vPrev, strict)) {
+                fields.push(key);
+            }
+        }
+        return fields;
+    }
+    Utils.objectUpdated = objectUpdated;
     /**
      * Parse string (JSON) to specific type
      * @param input Input string

package/lib/mjs/Utils.d.ts

@@ -117,6 +117,23 @@ export declare namespace Utils {
      * @returns Result
      */
     function objectEqual(obj1: {}, obj2: {}, ignoreFields?: string[], strict?: number): boolean;
+    /**
+     * Get two object's unqiue properties
+     * @param obj1 Object 1
+     * @param obj2 Object 2
+     * @param ignoreFields Ignored fields
+     * @returns Unique properties
+     */
+    function objectKeys(obj1: {}, obj2: {}, ignoreFields?: string[]): Set<string>;
+    /**
+     * Get the new object's updated fields contrast to the previous object
+     * @param objNew New object
+     * @param objPre Previous object
+     * @param ignoreFields Ignored fields
+     * @param strict Strict level, 0 with ==, 1 === but null equal undefined, 2 ===
+     * @returns Updated fields
+     */
+    function objectUpdated(objNew: {}, objPrev: {}, ignoreFields?: string[], strict?: number): string[];
     /**
      * Parse string (JSON) to specific type
      * @param input Input string

package/lib/mjs/Utils.js

@@ -213,11 +213,8 @@ export var Utils;
      * @returns Result
      */
     function objectEqual(obj1, obj2, ignoreFields = [], strict = 1) {
-        // Keys
-        const keys = new Set([
-            ...Object.keys(obj1).filter((item) => !ignoreFields.includes(item)),
-            ...Object.keys(obj2).filter((item) => !ignoreFields.includes(item))
-        ]);
+        // Unique keys
+        const keys = Utils.objectKeys(obj1, obj2, ignoreFields);
         for (const key of keys) {
             // Values
             const v1 = Reflect.get(obj1, key);
@@ -228,6 +225,44 @@ export var Utils;
         return true;
     }
     Utils.objectEqual = objectEqual;
+    /**
+     * Get two object's unqiue properties
+     * @param obj1 Object 1
+     * @param obj2 Object 2
+     * @param ignoreFields Ignored fields
+     * @returns Unique properties
+     */
+    function objectKeys(obj1, obj2, ignoreFields = []) {
+        // All keys
+        const allKeys = [...Object.keys(obj1), ...Object.keys(obj2)].filter((item) => !ignoreFields.includes(item));
+        // Unique keys
+        return new Set(allKeys);
+    }
+    Utils.objectKeys = objectKeys;
+    /**
+     * Get the new object's updated fields contrast to the previous object
+     * @param objNew New object
+     * @param objPre Previous object
+     * @param ignoreFields Ignored fields
+     * @param strict Strict level, 0 with ==, 1 === but null equal undefined, 2 ===
+     * @returns Updated fields
+     */
+    function objectUpdated(objNew, objPrev, ignoreFields = [], strict = 1) {
+        // Fields
+        const fields = [];
+        // Unique keys
+        const keys = Utils.objectKeys(objNew, objPrev, ignoreFields);
+        for (const key of keys) {
+            // Values
+            const vNew = Reflect.get(objNew, key);
+            const vPrev = Reflect.get(objPrev, key);
+            if (!Utils.equals(vNew, vPrev, strict)) {
+                fields.push(key);
+            }
+        }
+        return fields;
+    }
+    Utils.objectUpdated = objectUpdated;
     /**
      * Parse string (JSON) to specific type
      * @param input Input string

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@etsoo/shared",
-    "version": "1.0.77",
+    "version": "1.0.78",
     "description": "TypeScript shared utilities and functions",
     "main": "lib/cjs/index.js",
     "module": "lib/mjs/index.js",

package/src/Utils.ts

@@ -293,11 +293,8 @@ export namespace Utils {
         ignoreFields: string[] = [],
         strict = 1
     ) {
-        // Keys
-        const keys = new Set([
-            ...Object.keys(obj1).filter((item) => !ignoreFields.includes(item)),
-            ...Object.keys(obj2).filter((item) => !ignoreFields.includes(item))
-        ]);
+        // Unique keys
+        const keys = Utils.objectKeys(obj1, obj2, ignoreFields);
 
         for (const key of keys) {
             // Values
@@ -310,6 +307,60 @@ export namespace Utils {
         return true;
     }
 
+    /**
+     * Get two object's unqiue properties
+     * @param obj1 Object 1
+     * @param obj2 Object 2
+     * @param ignoreFields Ignored fields
+     * @returns Unique properties
+     */
+    export function objectKeys(
+        obj1: {},
+        obj2: {},
+        ignoreFields: string[] = []
+    ) {
+        // All keys
+        const allKeys = [...Object.keys(obj1), ...Object.keys(obj2)].filter(
+            (item) => !ignoreFields.includes(item)
+        );
+
+        // Unique keys
+        return new Set(allKeys);
+    }
+
+    /**
+     * Get the new object's updated fields contrast to the previous object
+     * @param objNew New object
+     * @param objPre Previous object
+     * @param ignoreFields Ignored fields
+     * @param strict Strict level, 0 with ==, 1 === but null equal undefined, 2 ===
+     * @returns Updated fields
+     */
+    export function objectUpdated(
+        objNew: {},
+        objPrev: {},
+        ignoreFields: string[] = [],
+        strict = 1
+    ) {
+        // Fields
+        const fields: string[] = [];
+
+        // Unique keys
+        const keys = Utils.objectKeys(objNew, objPrev, ignoreFields);
+
+        for (const key of keys) {
+            // Values
+            const vNew = Reflect.get(objNew, key);
+            const vPrev = Reflect.get(objPrev, key);
+
+            if (!Utils.equals(vNew, vPrev, strict)) {
+                fields.push(key);
+            }
+        }
+
+        return fields;
+    }
+
     /**
      * Parse string (JSON) to specific type
      * @param input Input string