@etsoo/shared 1.0.94 → 1.0.95

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,8 @@ Data type definitions and type safe functions
 |getEnumByValue|Get enum item from value|
 |getEnumKey|Get enum string literal type value|
 |getEnumKeys|Get Enum keys|
+|getItemId|Get item id|
+|getItemLabel|Get item label|
 |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,32 @@ 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 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
      */

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

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
      */

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

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@etsoo/shared",
-    "version": "1.0.94",
+    "version": "1.0.95",
     "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
      */