@etsoo/shared 1.1.41 → 1.1.42

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|
@@ -121,6 +122,7 @@ Data type definitions and type safe functions
 |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

@@ -90,11 +90,17 @@ test('Tests for getItemId', () => {
     expect(DataTypes.getItemId(items[2])).toBe('f123');
 });
 
-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', () => {

package/lib/cjs/DataTypes.d.ts

@@ -168,6 +168,12 @@ export declare namespace DataTypes {
          */
         label: string | (() => string);
     };
+    /**
+     * Get specific type keys
+     */
+    type Keys<T, R = string | number> = {
+        [k in keyof T]: T[k] extends R ? k : never;
+    }[keyof T];
     /**
      * Get item id
      * @param item Item with id
@@ -262,13 +268,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

@@ -306,12 +306,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 +321,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 +339,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

@@ -168,6 +168,12 @@ export declare namespace DataTypes {
          */
         label: string | (() => string);
     };
+    /**
+     * Get specific type keys
+     */
+    type Keys<T, R = string | number> = {
+        [k in keyof T]: T[k] extends R ? k : never;
+    }[keyof T];
     /**
      * Get item id
      * @param item Item with id
@@ -262,13 +268,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

@@ -303,12 +303,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 +318,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 +336,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.42",
     "description": "TypeScript shared utilities and functions",
     "main": "lib/cjs/index.js",
     "module": "lib/mjs/index.js",

package/src/DataTypes.ts

@@ -213,6 +213,13 @@ export namespace DataTypes {
         label: string | (() => string);
     };
 
+    /**
+     * Get specific type keys
+     */
+    export type Keys<T, R = string | number> = {
+        [k in keyof T]: T[k] extends R ? k : never;
+    }[keyof T];
+
     /**
      * Get item id
      * @param item Item with id
@@ -513,12 +520,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 +537,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 +560,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;
     }