@etsoo/shared 1.1.6 → 1.1.10

package/README.md

@@ -151,12 +151,18 @@ String and other related utilities
 
 |Name|Description|
 |---:|---|
+|addBlankItem|Add blank item to collection|
 |charsToNumber|Base64 chars to number|
+|correctTypes|Correct object's property value type|
 |equals|Two values equal|
 |formatInitial|Format inital character to lower case or upper case|
 |formatString|Format string with parameters|
 |getDataChanges|Get data changed fields with input data updated|
 |getTimeZone|Get time zone|
+|hideData|Hide data|
+|hideEmail|Hide email data|
+|isDigits|Is digits string|
+|isEmail|Is email string|
 |joinItems|Join items as a string|
 |mergeFormData|Merge form data to primary one|
 |mergeClasses|Merge class names|
@@ -166,5 +172,6 @@ String and other related utilities
 |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|
+|removeNonLetters|Remove non letters (0-9, a-z, A-Z)|
 |setLabels|Set source with new labels|
 |snakeNameToWord|Snake name to works, 'snake_name' to 'Snake Name'|

package/__tests__/Utils.ts

@@ -1,5 +1,41 @@
 import { Utils } from '../src/Utils';
 
+test('Tests for addBlankItem', () => {
+    const options = [
+        { id: 1, name: 'a' },
+        { id: 2, name: 'b' }
+    ];
+    Utils.addBlankItem(options, 'id', 'name');
+    expect(options.length).toBe(3);
+    expect(options[0].id).toBe('');
+    expect(options[0].name).toBe('---');
+});
+
+test('Tests for correctTypes', () => {
+    const input = {
+        id: '1',
+        price: '6.0',
+        amount: '',
+        date: '2022/01/28',
+        enabled: 'true',
+        ids: ['1', '2']
+    };
+    Utils.correctTypes(input, {
+        id: 'number',
+        price: 'number',
+        amount: 'number',
+        date: 'date',
+        enabled: 'boolean',
+        ids: 'number[]'
+    });
+    expect(typeof input.id).toBe('number');
+    expect(typeof input.price).toBe('number');
+    expect(input.amount).toBeUndefined();
+    expect((input.date as any) instanceof Date ? true : false).toBeTruthy();
+    expect(input.enabled).toBeTruthy();
+    expect(input.ids).toStrictEqual([1, 2]);
+});
+
 test('Tests for getDataChanges', () => {
     const input = {
         id: 1,
@@ -41,6 +77,13 @@ test('Tests for formatString', () => {
     expect(template.format('aa', 'bb')).toBe(result);
 });
 
+test('Tests for hideData', () => {
+    expect('xz@etsoo.com'.hideEmail()).toBe('x***@etsoo.com');
+    expect('info@etsoo.com'.hideEmail()).toBe('in***@etsoo.com');
+    expect('info@etsoo.com'.hideData('@')).toBe('in***@etsoo.com');
+    expect('12345678'.hideData()).toBe('123***678');
+});
+
 test('Tests for isDigits', () => {
     expect(Utils.isDigits('1')).toBeTruthy();
     expect(Utils.isDigits('12', 3)).toBeFalsy();

package/lib/cjs/DateUtils.d.ts

@@ -48,7 +48,7 @@ export declare namespace DateUtils {
      * Format to 'yyyy-MM-dd', especially used for date input min/max property
      * @param date Input date
      */
-    function formatForInput(date?: Date | string): string;
+    function formatForInput(date?: Date | string | null): string;
     /**
      * Get month's days
      * @param year Year

package/lib/cjs/Utils.d.ts

@@ -13,6 +13,17 @@ declare global {
          * @param upperCase To upper case or lower case
          */
         formatInitial(this: string, upperCase: boolean): string;
+        /**
+         * Hide data
+         * @param this Input string
+         * @param endChar End char
+         */
+        hideData(this: string, endChar?: string): string;
+        /**
+         * Hide email data
+         * @param this Input email
+         */
+        hideEmail(this: string): string;
         /**
          * Is digits string
          * @param this Input string
@@ -35,12 +46,28 @@ declare global {
  * Utilities
  */
 export declare namespace Utils {
+    /**
+     * Add blank item to collection
+     * @param options Options
+     * @param idField Id field, default is id
+     * @param labelField Label field, default is label
+     * @param blankLabel Blank label, default is ---
+     */
+    function addBlankItem<T extends {}>(options: T[], idField?: string | keyof T, labelField?: unknown, blankLabel?: string): void;
     /**
      * Base64 chars to number
      * @param base64Chars Base64 chars
      * @returns Number
      */
     function charsToNumber(base64Chars: string): number;
+    /**
+     * Correct object's property value type
+     * @param input Input object
+     * @param fields Fields to correct
+     */
+    function correctTypes<T extends {}, F extends {
+        [P in keyof T]: DataTypes.BasicNames;
+    }>(input: T, fields: F): void;
     /**
      * Two values equal
      * @param v1 Value 1

package/lib/cjs/Utils.js

@@ -14,6 +14,27 @@ String.prototype.formatInitial = function (upperCase = false) {
     return ((upperCase ? initial.toUpperCase() : initial.toLowerCase()) +
         this.slice(1));
 };
+String.prototype.hideData = function (endChar) {
+    if (endChar != null) {
+        const index = this.indexOf(endChar);
+        if (index === -1)
+            return this.hideData();
+        return this.substring(0, index).hideData() + this.substring(index);
+    }
+    var len = this.length;
+    if (len < 4)
+        return this.substring(0, 1) + '***';
+    if (len < 6)
+        return this.substring(0, 2) + '***';
+    if (len < 8)
+        return this.substring(0, 2) + '***' + this.slice(-2);
+    if (len < 12)
+        return this.substring(0, 3) + '***' + this.slice(-3);
+    return this.substring(0, 4) + '***' + this.slice(-4);
+};
+String.prototype.hideEmail = function () {
+    return this.hideData('@');
+};
 String.prototype.isDigits = function (minLength) {
     return this.length >= (minLength !== null && minLength !== void 0 ? minLength : 0) && /^\d+$/.test(this);
 };
@@ -29,6 +50,21 @@ String.prototype.removeNonLetters = function () {
  */
 var Utils;
 (function (Utils) {
+    /**
+     * Add blank item to collection
+     * @param options Options
+     * @param idField Id field, default is id
+     * @param labelField Label field, default is label
+     * @param blankLabel Blank label, default is ---
+     */
+    function addBlankItem(options, idField, labelField, blankLabel) {
+        const blankItem = {
+            [idField !== null && idField !== void 0 ? idField : 'id']: '',
+            [typeof labelField === 'string' ? labelField : 'label']: blankLabel !== null && blankLabel !== void 0 ? blankLabel : '---'
+        };
+        options.unshift(blankItem);
+    }
+    Utils.addBlankItem = addBlankItem;
     /**
      * Base64 chars to number
      * @param base64Chars Base64 chars
@@ -43,6 +79,21 @@ var Utils;
         }, 0);
     }
     Utils.charsToNumber = charsToNumber;
+    /**
+     * Correct object's property value type
+     * @param input Input object
+     * @param fields Fields to correct
+     */
+    function correctTypes(input, fields) {
+        for (const field in fields) {
+            const value = Reflect.get(input, field);
+            const newValue = DataTypes_1.DataTypes.convertByType(value, fields[field]);
+            if (newValue !== value) {
+                Reflect.set(input, field, newValue);
+            }
+        }
+    }
+    Utils.correctTypes = correctTypes;
     /**
      * Two values equal
      * @param v1 Value 1

package/lib/mjs/DateUtils.d.ts

@@ -48,7 +48,7 @@ export declare namespace DateUtils {
      * Format to 'yyyy-MM-dd', especially used for date input min/max property
      * @param date Input date
      */
-    function formatForInput(date?: Date | string): string;
+    function formatForInput(date?: Date | string | null): string;
     /**
      * Get month's days
      * @param year Year

package/lib/mjs/Utils.d.ts

@@ -13,6 +13,17 @@ declare global {
          * @param upperCase To upper case or lower case
          */
         formatInitial(this: string, upperCase: boolean): string;
+        /**
+         * Hide data
+         * @param this Input string
+         * @param endChar End char
+         */
+        hideData(this: string, endChar?: string): string;
+        /**
+         * Hide email data
+         * @param this Input email
+         */
+        hideEmail(this: string): string;
         /**
          * Is digits string
          * @param this Input string
@@ -35,12 +46,28 @@ declare global {
  * Utilities
  */
 export declare namespace Utils {
+    /**
+     * Add blank item to collection
+     * @param options Options
+     * @param idField Id field, default is id
+     * @param labelField Label field, default is label
+     * @param blankLabel Blank label, default is ---
+     */
+    function addBlankItem<T extends {}>(options: T[], idField?: string | keyof T, labelField?: unknown, blankLabel?: string): void;
     /**
      * Base64 chars to number
      * @param base64Chars Base64 chars
      * @returns Number
      */
     function charsToNumber(base64Chars: string): number;
+    /**
+     * Correct object's property value type
+     * @param input Input object
+     * @param fields Fields to correct
+     */
+    function correctTypes<T extends {}, F extends {
+        [P in keyof T]: DataTypes.BasicNames;
+    }>(input: T, fields: F): void;
     /**
      * Two values equal
      * @param v1 Value 1

package/lib/mjs/Utils.js

@@ -11,6 +11,27 @@ String.prototype.formatInitial = function (upperCase = false) {
     return ((upperCase ? initial.toUpperCase() : initial.toLowerCase()) +
         this.slice(1));
 };
+String.prototype.hideData = function (endChar) {
+    if (endChar != null) {
+        const index = this.indexOf(endChar);
+        if (index === -1)
+            return this.hideData();
+        return this.substring(0, index).hideData() + this.substring(index);
+    }
+    var len = this.length;
+    if (len < 4)
+        return this.substring(0, 1) + '***';
+    if (len < 6)
+        return this.substring(0, 2) + '***';
+    if (len < 8)
+        return this.substring(0, 2) + '***' + this.slice(-2);
+    if (len < 12)
+        return this.substring(0, 3) + '***' + this.slice(-3);
+    return this.substring(0, 4) + '***' + this.slice(-4);
+};
+String.prototype.hideEmail = function () {
+    return this.hideData('@');
+};
 String.prototype.isDigits = function (minLength) {
     return this.length >= (minLength !== null && minLength !== void 0 ? minLength : 0) && /^\d+$/.test(this);
 };
@@ -26,6 +47,21 @@ String.prototype.removeNonLetters = function () {
  */
 export var Utils;
 (function (Utils) {
+    /**
+     * Add blank item to collection
+     * @param options Options
+     * @param idField Id field, default is id
+     * @param labelField Label field, default is label
+     * @param blankLabel Blank label, default is ---
+     */
+    function addBlankItem(options, idField, labelField, blankLabel) {
+        const blankItem = {
+            [idField !== null && idField !== void 0 ? idField : 'id']: '',
+            [typeof labelField === 'string' ? labelField : 'label']: blankLabel !== null && blankLabel !== void 0 ? blankLabel : '---'
+        };
+        options.unshift(blankItem);
+    }
+    Utils.addBlankItem = addBlankItem;
     /**
      * Base64 chars to number
      * @param base64Chars Base64 chars
@@ -40,6 +76,21 @@ export var Utils;
         }, 0);
     }
     Utils.charsToNumber = charsToNumber;
+    /**
+     * Correct object's property value type
+     * @param input Input object
+     * @param fields Fields to correct
+     */
+    function correctTypes(input, fields) {
+        for (const field in fields) {
+            const value = Reflect.get(input, field);
+            const newValue = DataTypes.convertByType(value, fields[field]);
+            if (newValue !== value) {
+                Reflect.set(input, field, newValue);
+            }
+        }
+    }
+    Utils.correctTypes = correctTypes;
     /**
      * Two values equal
      * @param v1 Value 1

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@etsoo/shared",
-    "version": "1.1.6",
+    "version": "1.1.10",
     "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.4.0",
-        "@typescript-eslint/eslint-plugin": "^5.10.0",
-        "@typescript-eslint/parser": "^5.10.0",
-        "eslint": "^8.7.0",
+        "@typescript-eslint/eslint-plugin": "^5.10.1",
+        "@typescript-eslint/parser": "^5.10.1",
+        "eslint": "^8.8.0",
         "eslint-config-airbnb-base": "^15.0.0",
         "eslint-plugin-import": "^2.25.4",
         "jest": "^27.4.7",
         "ts-jest": "^27.1.3",
-        "typescript": "^4.5.4"
+        "typescript": "^4.5.5"
     }
 }

package/src/DateUtils.ts

@@ -148,7 +148,7 @@ export namespace DateUtils {
      * Format to 'yyyy-MM-dd', especially used for date input min/max property
      * @param date Input date
      */
-    export function formatForInput(date?: Date | string) {
+    export function formatForInput(date?: Date | string | null) {
         // Parse string as date
         if (typeof date === 'string') date = new Date(date);
 

package/src/Utils.ts

@@ -16,6 +16,19 @@ declare global {
          */
         formatInitial(this: string, upperCase: boolean): string;
 
+        /**
+         * Hide data
+         * @param this Input string
+         * @param endChar End char
+         */
+        hideData(this: string, endChar?: string): string;
+
+        /**
+         * Hide email data
+         * @param this Input email
+         */
+        hideEmail(this: string): string;
+
         /**
          * Is digits string
          * @param this Input string
@@ -59,6 +72,26 @@ String.prototype.formatInitial = function (
     );
 };
 
+String.prototype.hideData = function (this: string, endChar?: string) {
+    if (endChar != null) {
+        const index = this.indexOf(endChar);
+        if (index === -1) return this.hideData();
+        return this.substring(0, index).hideData() + this.substring(index);
+    }
+
+    var len = this.length;
+    if (len < 4) return this.substring(0, 1) + '***';
+    if (len < 6) return this.substring(0, 2) + '***';
+    if (len < 8) return this.substring(0, 2) + '***' + this.slice(-2);
+    if (len < 12) return this.substring(0, 3) + '***' + this.slice(-3);
+
+    return this.substring(0, 4) + '***' + this.slice(-4);
+};
+
+String.prototype.hideEmail = function (this: string) {
+    return this.hideData('@');
+};
+
 String.prototype.isDigits = function (this: string, minLength?: number) {
     return this.length >= (minLength ?? 0) && /^\d+$/.test(this);
 };
@@ -77,6 +110,27 @@ String.prototype.removeNonLetters = function (this: string) {
  * Utilities
  */
 export namespace Utils {
+    /**
+     * Add blank item to collection
+     * @param options Options
+     * @param idField Id field, default is id
+     * @param labelField Label field, default is label
+     * @param blankLabel Blank label, default is ---
+     */
+    export function addBlankItem<T extends {}>(
+        options: T[],
+        idField?: string | keyof T,
+        labelField?: unknown,
+        blankLabel?: string
+    ) {
+        const blankItem: any = {
+            [idField ?? 'id']: '',
+            [typeof labelField === 'string' ? labelField : 'label']:
+                blankLabel ?? '---'
+        };
+        options.unshift(blankItem);
+    }
+
     /**
      * Base64 chars to number
      * @param base64Chars Base64 chars
@@ -93,6 +147,24 @@ export namespace Utils {
         }, 0);
     }
 
+    /**
+     * Correct object's property value type
+     * @param input Input object
+     * @param fields Fields to correct
+     */
+    export function correctTypes<
+        T extends {},
+        F extends { [P in keyof T]: DataTypes.BasicNames }
+    >(input: T, fields: F) {
+        for (const field in fields) {
+            const value = Reflect.get(input, field);
+            const newValue = DataTypes.convertByType(value, fields[field]);
+            if (newValue !== value) {
+                Reflect.set(input, field, newValue);
+            }
+        }
+    }
+
     /**
      * Two values equal
      * @param v1 Value 1