@etsoo/shared 1.1.41 → 1.1.44

package/.github/workflows/main.yml

@@ -28,7 +28,7 @@ jobs:
       # Setup .npmrc file to publish to npm
       - uses: actions/setup-node@v1
         with:
-          node-version: '14.18'
+          node-version: '18.x'
           registry-url: 'https://registry.npmjs.org'
 
       # Named after Continuous Integration, installs dependencies directly from package-lock.json

package/README.md

@@ -98,6 +98,7 @@ Data type definitions and type safe functions
 |IdItem|Item with id or id generator|
 |IdLabelItem|Item with id and label|
 |KeyCollection|Key collection, like { key1: {}, key2: {} }|
+|Keys|Get specific type keys|
 |Simple|Basic or basic array type|
 |SimpleEnum|Simple type enum|
 |SimpleNames|Simple type names|
@@ -117,10 +118,9 @@ Data type definitions and type safe functions
 |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|
 |getResult|Get input function or value result|
 |getStringValue|Get object string field value|
+|getValue|Get object 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

@@ -77,24 +77,29 @@ test('Tests for getEnumKeys', () => {
     expect(keys).toContainEqual('Unkwown');
 });
 
-test('Tests for getItemId', () => {
+test('Tests for IdLabelItem', () => {
     // Arrange
-    const items: DataTypes.IdItem[] = [
-        { id: 1 },
-        { id: '123' },
-        { id: () => 'f123' }
+    const items: DataTypes.IdLabelItem[] = [
+        { id: 1, label: 'Item 1' },
+        { id: 2, label: 'Item 2' }
     ];
 
     // Assert
-    expect(DataTypes.getItemId(items[0])).toBe('1');
-    expect(DataTypes.getItemId(items[2])).toBe('f123');
+    expect(items[0].id).toBe(1);
+    expect(items[1].label).toBe('Item 2');
 });
 
-test('Tests for getIdValue', () => {
+test('Tests for getValue', () => {
     const data = { id: 1, flag: true };
+    expect(DataTypes.getValue(data, 'id')).toBe(1);
+    expect(DataTypes.getValue(data, 'flag')).toBe('true');
+    expect(DataTypes.getValue(data, 'unknown')).toBeNull();
+});
+
+test('Tests for getIdValue', () => {
+    const data = { id: 1, flag: true, field: 'string' };
     expect(DataTypes.getIdValue(data, 'id')).toBe(1);
-    expect(DataTypes.getIdValue(data, 'flag')).toBe('true');
-    expect(DataTypes.getIdValue(data, 'unknown')).toBeNull();
+    expect(DataTypes.getIdValue(data, 'field')).toBe('string');
 });
 
 test('Tests for getStringValue', () => {
@@ -103,19 +108,6 @@ test('Tests for getStringValue', () => {
     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/lib/cjs/DataTypes.d.ts

@@ -133,7 +133,7 @@ export declare namespace DataTypes {
     /**
      * Enum base type
      */
-    type EnumBase = Record<string, EnumValue>;
+    type EnumBase<T extends EnumValue = EnumValue> = Record<string, T>;
     /**
      * Function type
      */
@@ -153,33 +153,27 @@ export declare namespace DataTypes {
     /**
      * Item with id property
      */
-    type IdItem = {
+    type IdItem<T extends IdType = number> = {
         /**
-         * Id field or generator
+         * Id field
          */
-        id: IdType | (() => string);
+        id: T;
     };
     /**
      * Item with id and label property
      */
-    type IdLabelItem = IdItem & {
+    type IdLabelItem<T extends IdType = number> = IdItem<T> & {
         /**
-         * label field or generator
+         * label field
          */
-        label: string | (() => string);
+        label: 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
+     * Get specific type keys
      */
-    const getItemLabel: (item: IdLabelItem) => string;
+    type Keys<T, R = string | number> = {
+        [k in keyof T]: T[k] extends R ? k : never;
+    }[keyof T];
     /**
      * Culture definiton
      */
@@ -262,13 +256,20 @@ export declare namespace DataTypes {
      * @returns Keys
      */
     function getEnumKeys<T extends EnumBase, K extends keyof T & string>(input: T): K[];
+    /**
+     * Get object field value
+     * @param data Data
+     * @param key Property name
+     * @returns Value
+     */
+    function getValue<T extends {}>(data: T | undefined | null, key: keyof T | string): IdType | undefined | null;
     /**
      * 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;
+    function getIdValue<T extends {}, K extends Keys<T, string | number>>(data: T, key: K): T[K];
     /**
      * Get object string field value
      * @param data Data

package/lib/cjs/DataTypes.js

@@ -71,28 +71,6 @@ 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
@@ -306,12 +284,12 @@ var DataTypes;
     }
     DataTypes.getEnumKeys = getEnumKeys;
     /**
-     * Get object id field value
+     * Get object field value
      * @param data Data
      * @param key Property name
-     * @returns Id value
+     * @returns Value
      */
-    function getIdValue(data, key) {
+    function getValue(data, key) {
         if (data == null)
             return null;
         const value = typeof key === 'string' ? Reflect.get(data, key) : data[key];
@@ -321,6 +299,16 @@ var DataTypes;
             return value;
         return convert(value, 'string');
     }
+    DataTypes.getValue = getValue;
+    /**
+     * Get object id field value
+     * @param data Data
+     * @param key Property name
+     * @returns Id value
+     */
+    function getIdValue(data, key) {
+        return data[key];
+    }
     DataTypes.getIdValue = getIdValue;
     /**
      * Get object string field value
@@ -329,7 +317,7 @@ var DataTypes;
      * @returns String value
      */
     function getStringValue(data, key) {
-        const value = getIdValue(data, key);
+        const value = getValue(data, key);
         if (typeof value === 'number')
             return value.toString();
         return value;

package/lib/mjs/DataTypes.d.ts

@@ -133,7 +133,7 @@ export declare namespace DataTypes {
     /**
      * Enum base type
      */
-    type EnumBase = Record<string, EnumValue>;
+    type EnumBase<T extends EnumValue = EnumValue> = Record<string, T>;
     /**
      * Function type
      */
@@ -153,33 +153,27 @@ export declare namespace DataTypes {
     /**
      * Item with id property
      */
-    type IdItem = {
+    type IdItem<T extends IdType = number> = {
         /**
-         * Id field or generator
+         * Id field
          */
-        id: IdType | (() => string);
+        id: T;
     };
     /**
      * Item with id and label property
      */
-    type IdLabelItem = IdItem & {
+    type IdLabelItem<T extends IdType = number> = IdItem<T> & {
         /**
-         * label field or generator
+         * label field
          */
-        label: string | (() => string);
+        label: 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
+     * Get specific type keys
      */
-    const getItemLabel: (item: IdLabelItem) => string;
+    type Keys<T, R = string | number> = {
+        [k in keyof T]: T[k] extends R ? k : never;
+    }[keyof T];
     /**
      * Culture definiton
      */
@@ -262,13 +256,20 @@ export declare namespace DataTypes {
      * @returns Keys
      */
     function getEnumKeys<T extends EnumBase, K extends keyof T & string>(input: T): K[];
+    /**
+     * Get object field value
+     * @param data Data
+     * @param key Property name
+     * @returns Value
+     */
+    function getValue<T extends {}>(data: T | undefined | null, key: keyof T | string): IdType | undefined | null;
     /**
      * 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;
+    function getIdValue<T extends {}, K extends Keys<T, string | number>>(data: T, key: K): T[K];
     /**
      * Get object string field value
      * @param data Data

package/lib/mjs/DataTypes.js

@@ -68,28 +68,6 @@ 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
@@ -303,12 +281,12 @@ export var DataTypes;
     }
     DataTypes.getEnumKeys = getEnumKeys;
     /**
-     * Get object id field value
+     * Get object field value
      * @param data Data
      * @param key Property name
-     * @returns Id value
+     * @returns Value
      */
-    function getIdValue(data, key) {
+    function getValue(data, key) {
         if (data == null)
             return null;
         const value = typeof key === 'string' ? Reflect.get(data, key) : data[key];
@@ -318,6 +296,16 @@ export var DataTypes;
             return value;
         return convert(value, 'string');
     }
+    DataTypes.getValue = getValue;
+    /**
+     * Get object id field value
+     * @param data Data
+     * @param key Property name
+     * @returns Id value
+     */
+    function getIdValue(data, key) {
+        return data[key];
+    }
     DataTypes.getIdValue = getIdValue;
     /**
      * Get object string field value
@@ -326,7 +314,7 @@ export var DataTypes;
      * @returns String value
      */
     function getStringValue(data, key) {
-        const value = getIdValue(data, key);
+        const value = getValue(data, key);
         if (typeof value === 'number')
             return value.toString();
         return value;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@etsoo/shared",
-    "version": "1.1.41",
+    "version": "1.1.44",
     "description": "TypeScript shared utilities and functions",
     "main": "lib/cjs/index.js",
     "module": "lib/mjs/index.js",
@@ -56,9 +56,9 @@
     "dependencies": {},
     "devDependencies": {
         "@types/jest": "^28.1.6",
-        "@typescript-eslint/eslint-plugin": "^5.32.0",
-        "@typescript-eslint/parser": "^5.32.0",
-        "eslint": "^8.21.0",
+        "@typescript-eslint/eslint-plugin": "^5.33.0",
+        "@typescript-eslint/parser": "^5.33.0",
+        "eslint": "^8.22.0",
         "eslint-config-airbnb-base": "^15.0.0",
         "eslint-plugin-import": "^2.26.0",
         "jest": "^28.1.3",

package/src/DataTypes.ts

@@ -171,7 +171,7 @@ export namespace DataTypes {
     /**
      * Enum base type
      */
-    export type EnumBase = Record<string, EnumValue>;
+    export type EnumBase<T extends EnumValue = EnumValue> = Record<string, T>;
 
     /**
      * Function type
@@ -196,43 +196,29 @@ export namespace DataTypes {
     /**
      * Item with id property
      */
-    export type IdItem = {
+    export type IdItem<T extends IdType = number> = {
         /**
-         * Id field or generator
+         * Id field
          */
-        id: IdType | (() => string);
+        id: T;
     };
 
     /**
      * Item with id and label property
      */
-    export type IdLabelItem = IdItem & {
+    export type IdLabelItem<T extends IdType = number> = IdItem<T> & {
         /**
-         * label field or generator
+         * label field
          */
-        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;
+        label: string;
     };
 
     /**
-     * Get item label
-     * @param item Item with id
-     * @returns string id
+     * Get specific type keys
      */
-    export const getItemLabel = (item: IdLabelItem) => {
-        if (typeof item.label === 'function') return item.label();
-        return item.label;
-    };
+    export type Keys<T, R = string | number> = {
+        [k in keyof T]: T[k] extends R ? k : never;
+    }[keyof T];
 
     /**
      * Culture definiton
@@ -513,12 +499,12 @@ export namespace DataTypes {
     }
 
     /**
-     * Get object id field value
+     * Get object field value
      * @param data Data
      * @param key Property name
-     * @returns Id value
+     * @returns Value
      */
-    export function getIdValue<T extends {}>(
+    export function getValue<T extends {}>(
         data: T | undefined | null,
         key: keyof T | string
     ): IdType | undefined | null {
@@ -530,6 +516,19 @@ export namespace DataTypes {
         return convert(value, 'string');
     }
 
+    /**
+     * Get object id field value
+     * @param data Data
+     * @param key Property name
+     * @returns Id value
+     */
+    export function getIdValue<
+        T extends {},
+        K extends Keys<T, string | number>
+    >(data: T, key: K): T[K] {
+        return data[key];
+    }
+
     /**
      * Get object string field value
      * @param data Data
@@ -540,7 +539,7 @@ export namespace DataTypes {
         data: T | undefined | null,
         key: keyof T | string
     ): string | undefined | null {
-        const value = getIdValue(data, key);
+        const value = getValue(data, key);
         if (typeof value === 'number') return value.toString();
         return value;
     }