@etsoo/shared 1.0.95 → 1.0.99

package/README.md

@@ -24,6 +24,7 @@ Data type definitions and type safe functions
 |Name|Description|
 |---:|---|
 |DataType|Data type enum|
+|AddOrEditType|Add or edit conditional type for same data model|
 |Basic|Basic types, includes number, bigint, Date, boolean, string|
 |BasicArray|Basic type name array|
 |BasicConditional|Conditional type based on BasicNames|
@@ -58,8 +59,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

@@ -87,6 +87,19 @@ test('Tests for getItemId', () => {
     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[] = [

package/lib/cjs/DataTypes.d.ts

@@ -113,6 +113,13 @@ export declare namespace DataTypes {
      * Number and string combination id type
      */
     type IdType = number | string;
+    /**
+     * Add or edit conditional type for same data model
+     * Dynamic add changedFields for editing case
+     */
+    type AddOrEditType<T, Editing extends boolean> = Editing extends true ? T & {
+        changedFields?: string[];
+    } : Partial<T>;
     /**
      * Enum value type
      */
@@ -245,6 +252,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

@@ -308,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/mjs/DataTypes.d.ts

@@ -113,6 +113,13 @@ export declare namespace DataTypes {
      * Number and string combination id type
      */
     type IdType = number | string;
+    /**
+     * Add or edit conditional type for same data model
+     * Dynamic add changedFields for editing case
+     */
+    type AddOrEditType<T, Editing extends boolean> = Editing extends true ? T & {
+        changedFields?: string[];
+    } : Partial<T>;
     /**
      * Enum value type
      */
@@ -245,6 +252,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

@@ -305,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/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@etsoo/shared",
-    "version": "1.0.95",
+    "version": "1.0.99",
     "description": "TypeScript shared utilities and functions",
     "main": "lib/cjs/index.js",
     "module": "lib/mjs/index.js",
@@ -54,7 +54,7 @@
     "homepage": "https://github.com/ETSOO/Shared#readme",
     "dependencies": {},
     "devDependencies": {
-        "@types/jest": "^27.0.3",
+        "@types/jest": "^27.4.0",
         "@typescript-eslint/eslint-plugin": "^5.8.0",
         "@typescript-eslint/parser": "^5.8.0",
         "eslint": "^8.5.0",

package/src/DataTypes.ts

@@ -147,6 +147,14 @@ export namespace DataTypes {
      */
     export type IdType = number | string;
 
+    /**
+     * Add or edit conditional type for same data model
+     * Dynamic add changedFields for editing case
+     */
+    export type AddOrEditType<T, Editing extends boolean> = Editing extends true
+        ? T & { changedFields?: string[] }
+        : Partial<T>;
+
     /**
      * Enum value type
      */
@@ -491,6 +499,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