@etsoo/shared 1.0.93 → 1.0.97

package/README.md

@@ -38,6 +38,8 @@ Data type definitions and type safe functions
 |HAlign|Horizontal align|
 |HAlignEnum|Horizontal align enum|
 |IdType|Number and string combination id type|
+|IdItem|Item with id or id generator|
+|IdLabelItem|Item with id and label|
 |Simple|Basic or basic array type|
 |SimpleEnum|Simple type enum|
 |SimpleNames|Simple type names|
@@ -56,6 +58,10 @@ Data type definitions and type safe functions
 |getEnumByValue|Get enum item from value|
 |getEnumKey|Get enum string literal type value|
 |getEnumKeys|Get Enum keys|
+|getIdValue|Get object id field value|
+|getItemId|Get item id|
+|getItemLabel|Get item label|
+|getStringValue|Get object string field value|
 |isBasicName|Check the type is a basic type or not (type guard)|
 |isSimpleObject|Is the target a simple object, all values are simple type (Type guard)|
 |isSimpleType|Is the input value simple type, include null and undefined|

package/__tests__/DataTypes.ts

@@ -74,6 +74,45 @@ test('Tests for getEnumKeys', () => {
     expect(DataTypes.getEnumKeys(ProductUnit)).toContainEqual('GRAM');
 });
 
+test('Tests for getItemId', () => {
+    // Arrange
+    const items: DataTypes.IdItem[] = [
+        { id: 1 },
+        { id: '123' },
+        { id: () => 'f123' }
+    ];
+
+    // Assert
+    expect(DataTypes.getItemId(items[0])).toBe('1');
+    expect(DataTypes.getItemId(items[2])).toBe('f123');
+});
+
+test('Tests for getIdValue', () => {
+    const data = { id: 1, flag: true };
+    expect(DataTypes.getIdValue(data, 'id')).toBe(1);
+    expect(DataTypes.getIdValue(data, 'flag')).toBe('true');
+    expect(DataTypes.getIdValue(data, 'unknown')).toBeNull();
+});
+
+test('Tests for getStringValue', () => {
+    const data = { id: 1, flag: true };
+    expect(DataTypes.getStringValue(data, 'id')).toBe('1');
+    expect(DataTypes.getStringValue(data, 'flag')).toBe('true');
+});
+
+test('Tests for getItemLabel', () => {
+    // Arrange
+    const items: DataTypes.IdLabelItem[] = [
+        { id: 1, label: '123' },
+        { id: '123', label: () => 'f123' },
+        { id: () => 'f123', label: 'l123' }
+    ];
+
+    // Assert
+    expect(DataTypes.getItemLabel(items[0])).toBe('123');
+    expect(DataTypes.getItemLabel(items[1])).toBe('f123');
+});
+
 test('Tests for isSimpleType', () => {
     expect(DataTypes.isSimpleType(1)).toBeTruthy();
     expect(DataTypes.isSimpleType(new Date())).toBeTruthy();

package/__tests__/StorageUtils.ts

@@ -7,12 +7,17 @@ test('Tests for all', () => {
     StorageUtils.setSessionData('number', 3.14);
     StorageUtils.setSessionData('test', { id: 123, name: 'test' });
 
+    const array = StorageUtils.getSessionData<string[]>('array', []);
+    array.push('new');
+    StorageUtils.setSessionData('array', array);
+
     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('number1', 0)).toBe(0);
     expect(StorageUtils.getSessionData('test', {})).toHaveProperty('id', 123);
+    expect(StorageUtils.getSessionData<string[]>('array')).toEqual(array);
 });
 
 test('Tests for getLocalObject', () => {

package/lib/cjs/DataTypes.d.ts

@@ -133,6 +133,36 @@ export declare namespace DataTypes {
      * Simple object, string key, simple type and null value Record
      */
     type SimpleObject = Record<string, Simple | null | undefined>;
+    /**
+     * Item with id property
+     */
+    type IdItem = {
+        /**
+         * Id field or generator
+         */
+        id: IdType | (() => string);
+    };
+    /**
+     * Item with id and label property
+     */
+    type IdLabelItem = IdItem & {
+        /**
+         * label field or generator
+         */
+        label: string | (() => string);
+    };
+    /**
+     * Get item id
+     * @param item Item with id
+     * @returns string id
+     */
+    const getItemId: (item: IdItem) => string;
+    /**
+     * Get item label
+     * @param item Item with id
+     * @returns string id
+     */
+    const getItemLabel: (item: IdLabelItem) => string;
     /**
      * Culture definiton
      */
@@ -215,6 +245,20 @@ export declare namespace DataTypes {
      * @returns Keys
      */
     function getEnumKeys<T extends EnumBase, K extends keyof T>(input: T): K[];
+    /**
+     * Get object id field value
+     * @param data Data
+     * @param key Property name
+     * @returns Id value
+     */
+    function getIdValue<T extends {}>(data: T | undefined | null, key: keyof T | string): IdType | undefined | null;
+    /**
+     * Get object string field value
+     * @param data Data
+     * @param key Property name
+     * @returns String value
+     */
+    function getStringValue<T extends {}>(data: T | undefined | null, key: keyof T | string): string | undefined | null;
     /**
      * Check the type is a basic type or not (type guard)
      * @param name Type name

package/lib/cjs/DataTypes.js

@@ -74,6 +74,28 @@ var DataTypes;
         VAlignEnum[VAlignEnum["Center"] = 2] = "Center";
         VAlignEnum[VAlignEnum["Bottom"] = 3] = "Bottom";
     })(VAlignEnum = DataTypes.VAlignEnum || (DataTypes.VAlignEnum = {}));
+    /**
+     * Get item id
+     * @param item Item with id
+     * @returns string id
+     */
+    DataTypes.getItemId = (item) => {
+        if (typeof item.id === 'function')
+            return item.id();
+        if (typeof item.id === 'number')
+            return item.id.toString();
+        return item.id;
+    };
+    /**
+     * Get item label
+     * @param item Item with id
+     * @returns string id
+     */
+    DataTypes.getItemLabel = (item) => {
+        if (typeof item.label === 'function')
+            return item.label();
+        return item.label;
+    };
     /**
      * Convert value to target type
      * @param input Input value
@@ -286,6 +308,36 @@ var DataTypes;
             .map((item) => item);
     }
     DataTypes.getEnumKeys = getEnumKeys;
+    /**
+     * Get object id field value
+     * @param data Data
+     * @param key Property name
+     * @returns Id value
+     */
+    function getIdValue(data, key) {
+        if (data == null)
+            return null;
+        const value = typeof key === 'string' ? Reflect.get(data, key) : data[key];
+        if (value == null)
+            return null;
+        if (typeof value === 'number')
+            return value;
+        return convert(value, 'string');
+    }
+    DataTypes.getIdValue = getIdValue;
+    /**
+     * Get object string field value
+     * @param data Data
+     * @param key Property name
+     * @returns String value
+     */
+    function getStringValue(data, key) {
+        const value = getIdValue(data, key);
+        if (typeof value === 'number')
+            return value.toString();
+        return value;
+    }
+    DataTypes.getStringValue = getStringValue;
     /**
      * Check the type is a basic type or not (type guard)
      * @param name Type name

package/lib/cjs/storage/IStorage.d.ts

@@ -2,12 +2,24 @@
  * Storage interface
  */
 export interface IStorage {
+    /**
+     * Clear keys
+     * @param keys Keys
+     * @param persisted Persisted or session data
+     */
+    clear(keys: string[], persisted?: boolean): void;
     /**
      * Copy keys to session from persisted source
      * @param keys Keys
      * @param removeSource Remove from the source
      */
-    copy(keys: string[], removeSource?: boolean): void;
+    copyFrom(keys: string[], removeSource?: boolean): void;
+    /**
+     * Copy keys to persisted source
+     * @param keys Keys
+     * @param removeSource Remove from the source
+     */
+    copyTo(keys: string[], removeSource?: boolean): void;
     /**
      * Get data
      * @param key Key name

package/lib/cjs/storage/WindowStorage.d.ts

@@ -4,12 +4,24 @@ import { IStorage } from './IStorage';
  * https://developer.mozilla.org/en-US/docs/Web/API/Storage
  */
 export declare class WindowStorage implements IStorage {
+    /**
+     * Clear keys
+     * @param keys Keys
+     * @param persisted Persisted or session data
+     */
+    clear(keys: string[], persisted?: boolean): void;
     /**
      * Copy keys to session from persisted source
      * @param keys Keys
      * @param removeSource Remove from the source
      */
-    copy(keys: string[], removeSource?: boolean): void;
+    copyFrom(keys: string[], removeSource?: boolean): void;
+    /**
+     * Copy keys to persisted source
+     * @param keys Keys
+     * @param removeSource Remove from the source
+     */
+    copyTo(keys: string[], removeSource?: boolean): void;
     /**
      * Get data
      * @param key Key name

package/lib/cjs/storage/WindowStorage.js

@@ -8,18 +8,43 @@ const Utils_1 = require("../Utils");
  * https://developer.mozilla.org/en-US/docs/Web/API/Storage
  */
 class WindowStorage {
+    /**
+     * Clear keys
+     * @param keys Keys
+     * @param persisted Persisted or session data
+     */
+    clear(keys, persisted) {
+        keys.forEach((key) => {
+            if (persisted)
+                this.setPersistedData(key, undefined);
+            else
+                this.setData(key, undefined);
+        });
+    }
     /**
      * Copy keys to session from persisted source
      * @param keys Keys
      * @param removeSource Remove from the source
      */
-    copy(keys, removeSource) {
+    copyFrom(keys, removeSource) {
         keys.forEach((key) => {
             this.setData(key, this.getPersistedData(key));
             if (removeSource)
                 this.setPersistedData(key, undefined);
         });
     }
+    /**
+     * Copy keys to persisted source
+     * @param keys Keys
+     * @param removeSource Remove from the source
+     */
+    copyTo(keys, removeSource) {
+        keys.forEach((key) => {
+            this.setPersistedData(key, this.getData(key));
+            if (removeSource)
+                this.setData(key, undefined);
+        });
+    }
     /**
      * Get data
      * @param key Key name

package/lib/mjs/DataTypes.d.ts

@@ -133,6 +133,36 @@ export declare namespace DataTypes {
      * Simple object, string key, simple type and null value Record
      */
     type SimpleObject = Record<string, Simple | null | undefined>;
+    /**
+     * Item with id property
+     */
+    type IdItem = {
+        /**
+         * Id field or generator
+         */
+        id: IdType | (() => string);
+    };
+    /**
+     * Item with id and label property
+     */
+    type IdLabelItem = IdItem & {
+        /**
+         * label field or generator
+         */
+        label: string | (() => string);
+    };
+    /**
+     * Get item id
+     * @param item Item with id
+     * @returns string id
+     */
+    const getItemId: (item: IdItem) => string;
+    /**
+     * Get item label
+     * @param item Item with id
+     * @returns string id
+     */
+    const getItemLabel: (item: IdLabelItem) => string;
     /**
      * Culture definiton
      */
@@ -215,6 +245,20 @@ export declare namespace DataTypes {
      * @returns Keys
      */
     function getEnumKeys<T extends EnumBase, K extends keyof T>(input: T): K[];
+    /**
+     * Get object id field value
+     * @param data Data
+     * @param key Property name
+     * @returns Id value
+     */
+    function getIdValue<T extends {}>(data: T | undefined | null, key: keyof T | string): IdType | undefined | null;
+    /**
+     * Get object string field value
+     * @param data Data
+     * @param key Property name
+     * @returns String value
+     */
+    function getStringValue<T extends {}>(data: T | undefined | null, key: keyof T | string): string | undefined | null;
     /**
      * Check the type is a basic type or not (type guard)
      * @param name Type name

package/lib/mjs/DataTypes.js

@@ -71,6 +71,28 @@ export var DataTypes;
         VAlignEnum[VAlignEnum["Center"] = 2] = "Center";
         VAlignEnum[VAlignEnum["Bottom"] = 3] = "Bottom";
     })(VAlignEnum = DataTypes.VAlignEnum || (DataTypes.VAlignEnum = {}));
+    /**
+     * Get item id
+     * @param item Item with id
+     * @returns string id
+     */
+    DataTypes.getItemId = (item) => {
+        if (typeof item.id === 'function')
+            return item.id();
+        if (typeof item.id === 'number')
+            return item.id.toString();
+        return item.id;
+    };
+    /**
+     * Get item label
+     * @param item Item with id
+     * @returns string id
+     */
+    DataTypes.getItemLabel = (item) => {
+        if (typeof item.label === 'function')
+            return item.label();
+        return item.label;
+    };
     /**
      * Convert value to target type
      * @param input Input value
@@ -283,6 +305,36 @@ export var DataTypes;
             .map((item) => item);
     }
     DataTypes.getEnumKeys = getEnumKeys;
+    /**
+     * Get object id field value
+     * @param data Data
+     * @param key Property name
+     * @returns Id value
+     */
+    function getIdValue(data, key) {
+        if (data == null)
+            return null;
+        const value = typeof key === 'string' ? Reflect.get(data, key) : data[key];
+        if (value == null)
+            return null;
+        if (typeof value === 'number')
+            return value;
+        return convert(value, 'string');
+    }
+    DataTypes.getIdValue = getIdValue;
+    /**
+     * Get object string field value
+     * @param data Data
+     * @param key Property name
+     * @returns String value
+     */
+    function getStringValue(data, key) {
+        const value = getIdValue(data, key);
+        if (typeof value === 'number')
+            return value.toString();
+        return value;
+    }
+    DataTypes.getStringValue = getStringValue;
     /**
      * Check the type is a basic type or not (type guard)
      * @param name Type name

package/lib/mjs/storage/IStorage.d.ts

@@ -2,12 +2,24 @@
  * Storage interface
  */
 export interface IStorage {
+    /**
+     * Clear keys
+     * @param keys Keys
+     * @param persisted Persisted or session data
+     */
+    clear(keys: string[], persisted?: boolean): void;
     /**
      * Copy keys to session from persisted source
      * @param keys Keys
      * @param removeSource Remove from the source
      */
-    copy(keys: string[], removeSource?: boolean): void;
+    copyFrom(keys: string[], removeSource?: boolean): void;
+    /**
+     * Copy keys to persisted source
+     * @param keys Keys
+     * @param removeSource Remove from the source
+     */
+    copyTo(keys: string[], removeSource?: boolean): void;
     /**
      * Get data
      * @param key Key name

package/lib/mjs/storage/WindowStorage.d.ts

@@ -4,12 +4,24 @@ import { IStorage } from './IStorage';
  * https://developer.mozilla.org/en-US/docs/Web/API/Storage
  */
 export declare class WindowStorage implements IStorage {
+    /**
+     * Clear keys
+     * @param keys Keys
+     * @param persisted Persisted or session data
+     */
+    clear(keys: string[], persisted?: boolean): void;
     /**
      * Copy keys to session from persisted source
      * @param keys Keys
      * @param removeSource Remove from the source
      */
-    copy(keys: string[], removeSource?: boolean): void;
+    copyFrom(keys: string[], removeSource?: boolean): void;
+    /**
+     * Copy keys to persisted source
+     * @param keys Keys
+     * @param removeSource Remove from the source
+     */
+    copyTo(keys: string[], removeSource?: boolean): void;
     /**
      * Get data
      * @param key Key name

package/lib/mjs/storage/WindowStorage.js

@@ -5,18 +5,43 @@ import { Utils } from '../Utils';
  * https://developer.mozilla.org/en-US/docs/Web/API/Storage
  */
 export class WindowStorage {
+    /**
+     * Clear keys
+     * @param keys Keys
+     * @param persisted Persisted or session data
+     */
+    clear(keys, persisted) {
+        keys.forEach((key) => {
+            if (persisted)
+                this.setPersistedData(key, undefined);
+            else
+                this.setData(key, undefined);
+        });
+    }
     /**
      * Copy keys to session from persisted source
      * @param keys Keys
      * @param removeSource Remove from the source
      */
-    copy(keys, removeSource) {
+    copyFrom(keys, removeSource) {
         keys.forEach((key) => {
             this.setData(key, this.getPersistedData(key));
             if (removeSource)
                 this.setPersistedData(key, undefined);
         });
     }
+    /**
+     * Copy keys to persisted source
+     * @param keys Keys
+     * @param removeSource Remove from the source
+     */
+    copyTo(keys, removeSource) {
+        keys.forEach((key) => {
+            this.setPersistedData(key, this.getData(key));
+            if (removeSource)
+                this.setData(key, undefined);
+        });
+    }
     /**
      * Get data
      * @param key Key name

package/package.json

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

package/src/DataTypes.ts

@@ -172,6 +172,47 @@ export namespace DataTypes {
      */
     export type SimpleObject = Record<string, Simple | null | undefined>;
 
+    /**
+     * Item with id property
+     */
+    export type IdItem = {
+        /**
+         * Id field or generator
+         */
+        id: IdType | (() => string);
+    };
+
+    /**
+     * Item with id and label property
+     */
+    export type IdLabelItem = IdItem & {
+        /**
+         * label field or generator
+         */
+        label: string | (() => string);
+    };
+
+    /**
+     * Get item id
+     * @param item Item with id
+     * @returns string id
+     */
+    export const getItemId = (item: IdItem) => {
+        if (typeof item.id === 'function') return item.id();
+        if (typeof item.id === 'number') return item.id.toString();
+        return item.id;
+    };
+
+    /**
+     * Get item label
+     * @param item Item with id
+     * @returns string id
+     */
+    export const getItemLabel = (item: IdLabelItem) => {
+        if (typeof item.label === 'function') return item.label();
+        return item.label;
+    };
+
     /**
      * Culture definiton
      */
@@ -450,6 +491,39 @@ export namespace DataTypes {
             .map((item) => <K>item);
     }
 
+    /**
+     * Get object id field value
+     * @param data Data
+     * @param key Property name
+     * @returns Id value
+     */
+    export function getIdValue<T extends {}>(
+        data: T | undefined | null,
+        key: keyof T | string
+    ): IdType | undefined | null {
+        if (data == null) return null;
+        const value =
+            typeof key === 'string' ? Reflect.get(data, key) : data[key];
+        if (value == null) return null;
+        if (typeof value === 'number') return value;
+        return convert(value, 'string');
+    }
+
+    /**
+     * Get object string field value
+     * @param data Data
+     * @param key Property name
+     * @returns String value
+     */
+    export function getStringValue<T extends {}>(
+        data: T | undefined | null,
+        key: keyof T | string
+    ): string | undefined | null {
+        const value = getIdValue(data, key);
+        if (typeof value === 'number') return value.toString();
+        return value;
+    }
+
     /**
      * Check the type is a basic type or not (type guard)
      * @param name Type name

package/src/storage/IStorage.ts

@@ -2,12 +2,26 @@
  * Storage interface
  */
 export interface IStorage {
+    /**
+     * Clear keys
+     * @param keys Keys
+     * @param persisted Persisted or session data
+     */
+    clear(keys: string[], persisted?: boolean): void;
+
     /**
      * Copy keys to session from persisted source
      * @param keys Keys
      * @param removeSource Remove from the source
      */
-    copy(keys: string[], removeSource?: boolean): void;
+    copyFrom(keys: string[], removeSource?: boolean): void;
+
+    /**
+     * Copy keys to persisted source
+     * @param keys Keys
+     * @param removeSource Remove from the source
+     */
+    copyTo(keys: string[], removeSource?: boolean): void;
 
     /**
      * Get data

package/src/storage/WindowStorage.ts

@@ -7,18 +7,42 @@ import { IStorage } from './IStorage';
  * https://developer.mozilla.org/en-US/docs/Web/API/Storage
  */
 export class WindowStorage implements IStorage {
+    /**
+     * Clear keys
+     * @param keys Keys
+     * @param persisted Persisted or session data
+     */
+    clear(keys: string[], persisted?: boolean) {
+        keys.forEach((key) => {
+            if (persisted) this.setPersistedData(key, undefined);
+            else this.setData(key, undefined);
+        });
+    }
+
     /**
      * Copy keys to session from persisted source
      * @param keys Keys
      * @param removeSource Remove from the source
      */
-    copy(keys: string[], removeSource?: boolean) {
+    copyFrom(keys: string[], removeSource?: boolean) {
         keys.forEach((key) => {
             this.setData(key, this.getPersistedData(key));
             if (removeSource) this.setPersistedData(key, undefined);
         });
     }
 
+    /**
+     * Copy keys to persisted source
+     * @param keys Keys
+     * @param removeSource Remove from the source
+     */
+    copyTo(keys: string[], removeSource?: boolean) {
+        keys.forEach((key) => {
+            this.setPersistedData(key, this.getData(key));
+            if (removeSource) this.setData(key, undefined);
+        });
+    }
+
     /**
      * Get data
      * @param key Key name