@etsoo/shared 1.0.77 → 1.0.81

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__/StorageUtils.ts

@@ -7,7 +7,8 @@ test('Tests for all', () => {
     StorageUtils.setSessionData('number', 3.14);
     StorageUtils.setSessionData('test', { id: 123, name: 'test' });
 
-    expect(StorageUtils.getSessionData('string', '')).toBe('test');
+    expect(StorageUtils.getSessionData<string>('string')).toBe('test');
+    expect(StorageUtils.getSessionData('string1', '')).toBe('');
     expect(StorageUtils.getSessionData('boolean', false)).toBe(true);
     expect(StorageUtils.getSessionData('number', 0)).toBe(3.14);
     expect(StorageUtils.getSessionData('test', {})).toHaveProperty('id', 123);

package/__tests__/Utils.ts

@@ -92,9 +92,20 @@ 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<string>('test')).toBe('test');
     expect(Utils.parseString('test', '')).toBe('test');
     expect(Utils.parseString('true', false)).toBe(true);
+    expect(Utils.parseString('', false)).toBeFalsy();
+    expect(Utils.parseString<boolean>('')).toBeUndefined();
+    expect(Utils.parseString<number>(undefined)).toBeUndefined();
     expect(Utils.parseString('3.14', 0)).toBe(3.14);
     expect(Utils.parseString('2021/4/13', new Date())).toStrictEqual(
         new Date('2021/4/13')

package/lib/cjs/StorageUtils.d.ts

@@ -20,7 +20,7 @@ export declare namespace StorageUtils {
      * @param key Key name
      * @param defaultValue Default value
      */
-    function getLocalData<T>(key: string, defaultValue: T): T;
+    function getLocalData<T, M = T | undefined>(key: string, defaultValue?: M): M extends T ? M : undefined;
     /**
      * Get local storage object data
      * @param key Key name
@@ -30,7 +30,7 @@ export declare namespace StorageUtils {
      * Get session storage data
      * @param key Key name
      */
-    function getSessionData<T>(key: string, defaultValue: T): T;
+    function getSessionData<T, M = T | undefined>(key: string, defaultValue?: M): M extends T ? M : undefined;
     /**
      * Get session storage object data
      * @param key Key name

package/lib/cjs/Utils.d.ts

@@ -118,12 +118,30 @@ export declare namespace Utils {
      */
     function objectEqual(obj1: {}, obj2: {}, ignoreFields?: string[], strict?: number): boolean;
     /**
-     * Parse string (JSON) to specific type
+     * 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, no type conversion
+     * For type conversion, please use DataTypes.convert
      * @param input Input string
      * @param defaultValue Default value
      * @returns Parsed value
      */
-    function parseString<T>(input: string | undefined | null, defaultValue: T): T;
+    function parseString<T, M = T | undefined>(input: string | undefined | null, defaultValue?: M): M extends T ? M : undefined;
     /**
      * Remove non letters
      * @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);
@@ -232,14 +229,53 @@ var Utils;
     }
     Utils.objectEqual = objectEqual;
     /**
-     * Parse string (JSON) to specific type
+     * 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, no type conversion
+     * For type conversion, please use DataTypes.convert
      * @param input Input string
      * @param defaultValue Default value
      * @returns Parsed value
      */
     function parseString(input, defaultValue) {
-        // Undefined case, return default value
-        if (input == null)
+        // Undefined and empty case, return default value
+        if (input == null || input === '')
             return defaultValue;
         // String
         if (typeof defaultValue === 'string')
@@ -257,16 +293,11 @@ var Utils;
             // Return
             return json;
         }
-        catch (e) {
-            console.log('Utils.parseString error', e);
+        catch {
+            if (defaultValue == null)
+                return input;
             return defaultValue;
         }
-        /*
-        finally part will still return the boolean value
-        finally {
-            return defaultValue
-        }
-        */
     }
     Utils.parseString = parseString;
     /**

package/lib/mjs/StorageUtils.d.ts

@@ -20,7 +20,7 @@ export declare namespace StorageUtils {
      * @param key Key name
      * @param defaultValue Default value
      */
-    function getLocalData<T>(key: string, defaultValue: T): T;
+    function getLocalData<T, M = T | undefined>(key: string, defaultValue?: M): M extends T ? M : undefined;
     /**
      * Get local storage object data
      * @param key Key name
@@ -30,7 +30,7 @@ export declare namespace StorageUtils {
      * Get session storage data
      * @param key Key name
      */
-    function getSessionData<T>(key: string, defaultValue: T): T;
+    function getSessionData<T, M = T | undefined>(key: string, defaultValue?: M): M extends T ? M : undefined;
     /**
      * Get session storage object data
      * @param key Key name

package/lib/mjs/Utils.d.ts

@@ -118,12 +118,30 @@ export declare namespace Utils {
      */
     function objectEqual(obj1: {}, obj2: {}, ignoreFields?: string[], strict?: number): boolean;
     /**
-     * Parse string (JSON) to specific type
+     * 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, no type conversion
+     * For type conversion, please use DataTypes.convert
      * @param input Input string
      * @param defaultValue Default value
      * @returns Parsed value
      */
-    function parseString<T>(input: string | undefined | null, defaultValue: T): T;
+    function parseString<T, M = T | undefined>(input: string | undefined | null, defaultValue?: M): M extends T ? M : undefined;
     /**
      * Remove non letters
      * @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);
@@ -229,14 +226,53 @@ export var Utils;
     }
     Utils.objectEqual = objectEqual;
     /**
-     * Parse string (JSON) to specific type
+     * 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, no type conversion
+     * For type conversion, please use DataTypes.convert
      * @param input Input string
      * @param defaultValue Default value
      * @returns Parsed value
      */
     function parseString(input, defaultValue) {
-        // Undefined case, return default value
-        if (input == null)
+        // Undefined and empty case, return default value
+        if (input == null || input === '')
             return defaultValue;
         // String
         if (typeof defaultValue === 'string')
@@ -254,16 +290,11 @@ export var Utils;
             // Return
             return json;
         }
-        catch (e) {
-            console.log('Utils.parseString error', e);
+        catch {
+            if (defaultValue == null)
+                return input;
             return defaultValue;
         }
-        /*
-        finally part will still return the boolean value
-        finally {
-            return defaultValue
-        }
-        */
     }
     Utils.parseString = parseString;
     /**

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@etsoo/shared",
-    "version": "1.0.77",
+    "version": "1.0.81",
     "description": "TypeScript shared utilities and functions",
     "main": "lib/cjs/index.js",
     "module": "lib/mjs/index.js",
@@ -55,13 +55,13 @@
     "dependencies": {},
     "devDependencies": {
         "@types/jest": "^27.0.3",
-        "@typescript-eslint/eslint-plugin": "^5.4.0",
-        "@typescript-eslint/parser": "^5.4.0",
-        "eslint": "^8.2.0",
+        "@typescript-eslint/eslint-plugin": "^5.8.0",
+        "@typescript-eslint/parser": "^5.8.0",
+        "eslint": "^8.5.0",
         "eslint-config-airbnb-base": "^15.0.0",
         "eslint-plugin-import": "^2.25.3",
-        "jest": "^27.3.1",
-        "ts-jest": "^27.0.7",
-        "typescript": "^4.5.2"
+        "jest": "^27.4.5",
+        "ts-jest": "^27.1.2",
+        "typescript": "^4.5.4"
     }
 }

package/src/StorageUtils.ts

@@ -49,12 +49,15 @@ export namespace StorageUtils {
      * @param key Key name
      * @param defaultValue Default value
      */
-    export function getLocalData<T>(key: string, defaultValue: T) {
+    export function getLocalData<T, M = T | undefined>(
+        key: string,
+        defaultValue?: M
+    ): M extends T ? M : undefined {
         // Get storage
         const data = localStorage.getItem(key);
 
         // Return
-        return Utils.parseString(data, defaultValue);
+        return Utils.parseString<T, M>(data, defaultValue);
     }
 
     /**
@@ -72,12 +75,15 @@ export namespace StorageUtils {
      * Get session storage data
      * @param key Key name
      */
-    export function getSessionData<T>(key: string, defaultValue: T) {
+    export function getSessionData<T, M = T | undefined>(
+        key: string,
+        defaultValue?: M
+    ): M extends T ? M : undefined {
         // Get storage
         const data = sessionStorage.getItem(key);
 
         // Return
-        return Utils.parseString(data, defaultValue);
+        return Utils.parseString<T, M>(data, defaultValue);
     }
 
     /**

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
@@ -311,17 +308,72 @@ export namespace Utils {
     }
 
     /**
-     * Parse string (JSON) to specific type
+     * 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, no type conversion
+     * For type conversion, please use DataTypes.convert
      * @param input Input string
      * @param defaultValue Default value
      * @returns Parsed value
      */
-    export function parseString<T>(
+    export function parseString<T, M = T | undefined>(
         input: string | undefined | null,
-        defaultValue: T
-    ): T {
-        // Undefined case, return default value
-        if (input == null) return defaultValue;
+        defaultValue?: M
+    ): M extends T ? M : undefined {
+        // Undefined and empty case, return default value
+        if (input == null || input === '') return <any>defaultValue;
 
         // String
         if (typeof defaultValue === 'string') return <any>input;
@@ -330,7 +382,7 @@ export namespace Utils {
             // Date
             if (defaultValue instanceof Date) {
                 const date = new Date(input);
-                if (date == null) return defaultValue;
+                if (date == null) return <any>defaultValue;
                 return <any>date;
             }
 
@@ -338,17 +390,11 @@ export namespace Utils {
             const json = JSON.parse(input);
 
             // Return
-            return <T>json;
-        } catch (e) {
-            console.log('Utils.parseString error', e);
-            return defaultValue;
-        }
-        /*
-        finally part will still return the boolean value
-        finally {
-            return defaultValue
+            return json;
+        } catch {
+            if (defaultValue == null) return <any>input;
+            return <any>defaultValue;
         }
-        */
     }
 
     /**