@etsoo/shared 1.0.99 → 1.1.3

package/README.md

@@ -36,6 +36,7 @@ Data type definitions and type safe functions
 |EnumBase|Enum base type|
 |EnumValue|Enum value type|
 |ExtendedEnum|Extended type enum|
+|Func<R>|Function type, R is return type|
 |HAlign|Horizontal align|
 |HAlignEnum|Horizontal align enum|
 |IdType|Number and string combination id type|
@@ -62,6 +63,7 @@ Data type definitions and type safe functions
 |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|
 |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)|

package/__tests__/Utils.ts

@@ -133,3 +133,18 @@ test('Test for snakeNameToWord', () => {
 test('Tests for mergeClasses', () => {
     expect(Utils.mergeClasses('a', '', 'b ', undefined, 'c')).toBe('a b c');
 });
+
+test('Tests for getResult', () => {
+    // Arrange
+    type test = ((visible: boolean) => number) | number;
+    const input: test = (visible) => (visible ? 1 : 0);
+    const inputNumber: test = 5;
+
+    // Act & assert
+    const result = Utils.getResult(input, true);
+    expect(result).toBe(1);
+    expect(Utils.getResult(input, false)).toBe(0);
+
+    const valueResult = Utils.getResult(inputNumber);
+    expect(valueResult).toBe(5);
+});

package/lib/cjs/DataTypes.d.ts

@@ -117,9 +117,9 @@ export declare namespace DataTypes {
      * 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 & {
+    type AddOrEditType<T, Editing extends boolean> = (Editing extends true ? T : Partial<T>) & {
         changedFields?: string[];
-    } : Partial<T>;
+    };
     /**
      * Enum value type
      */
@@ -128,6 +128,10 @@ export declare namespace DataTypes {
      * Enum base type
      */
     type EnumBase = Record<string, EnumValue>;
+    /**
+     * Function type
+     */
+    type Func<R> = (...args: any[]) => R;
     /**
      * String key, unknown value Record
      */

package/lib/cjs/Utils.d.ts

@@ -69,6 +69,13 @@ export declare namespace Utils {
      * @returns
      */
     function getDataChanges(input: {}, initData: {}, ignoreFields?: string[]): string[];
+    /**
+     * Get input function or value result
+     * @param input Input function or value
+     * @param args Arguments
+     * @returns Result
+     */
+    const getResult: <R, T = R | DataTypes.Func<R>>(input: T, ...args: T extends DataTypes.Func<R> ? Parameters<T> : never) => T extends DataTypes.Func<R> ? ReturnType<T> : T;
     /**
      * Get time zone
      * @returns Timezone

package/lib/cjs/Utils.js

@@ -125,6 +125,15 @@ var Utils;
         return changes;
     }
     Utils.getDataChanges = getDataChanges;
+    /**
+     * Get input function or value result
+     * @param input Input function or value
+     * @param args Arguments
+     * @returns Result
+     */
+    Utils.getResult = (input, ...args) => {
+        return typeof input === 'function' ? input(...args) : input;
+    };
     /**
      * Get time zone
      * @returns Timezone

package/lib/mjs/DataTypes.d.ts

@@ -117,9 +117,9 @@ export declare namespace DataTypes {
      * 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 & {
+    type AddOrEditType<T, Editing extends boolean> = (Editing extends true ? T : Partial<T>) & {
         changedFields?: string[];
-    } : Partial<T>;
+    };
     /**
      * Enum value type
      */
@@ -128,6 +128,10 @@ export declare namespace DataTypes {
      * Enum base type
      */
     type EnumBase = Record<string, EnumValue>;
+    /**
+     * Function type
+     */
+    type Func<R> = (...args: any[]) => R;
     /**
      * String key, unknown value Record
      */

package/lib/mjs/Utils.d.ts

@@ -69,6 +69,13 @@ export declare namespace Utils {
      * @returns
      */
     function getDataChanges(input: {}, initData: {}, ignoreFields?: string[]): string[];
+    /**
+     * Get input function or value result
+     * @param input Input function or value
+     * @param args Arguments
+     * @returns Result
+     */
+    const getResult: <R, T = R | DataTypes.Func<R>>(input: T, ...args: T extends DataTypes.Func<R> ? Parameters<T> : never) => T extends DataTypes.Func<R> ? ReturnType<T> : T;
     /**
      * Get time zone
      * @returns Timezone

package/lib/mjs/Utils.js

@@ -122,6 +122,15 @@ export var Utils;
         return changes;
     }
     Utils.getDataChanges = getDataChanges;
+    /**
+     * Get input function or value result
+     * @param input Input function or value
+     * @param args Arguments
+     * @returns Result
+     */
+    Utils.getResult = (input, ...args) => {
+        return typeof input === 'function' ? input(...args) : input;
+    };
     /**
      * Get time zone
      * @returns Timezone

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@etsoo/shared",
-    "version": "1.0.99",
+    "version": "1.1.3",
     "description": "TypeScript shared utilities and functions",
     "main": "lib/cjs/index.js",
     "module": "lib/mjs/index.js",
@@ -55,12 +55,12 @@
     "dependencies": {},
     "devDependencies": {
         "@types/jest": "^27.4.0",
-        "@typescript-eslint/eslint-plugin": "^5.8.0",
-        "@typescript-eslint/parser": "^5.8.0",
-        "eslint": "^8.5.0",
+        "@typescript-eslint/eslint-plugin": "^5.9.0",
+        "@typescript-eslint/parser": "^5.9.0",
+        "eslint": "^8.6.0",
         "eslint-config-airbnb-base": "^15.0.0",
-        "eslint-plugin-import": "^2.25.3",
-        "jest": "^27.4.5",
+        "eslint-plugin-import": "^2.25.4",
+        "jest": "^27.4.7",
         "ts-jest": "^27.1.2",
         "typescript": "^4.5.4"
     }

package/src/DataTypes.ts

@@ -151,9 +151,10 @@ export namespace DataTypes {
      * 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>;
+    export type AddOrEditType<
+        T,
+        Editing extends boolean
+    > = (Editing extends true ? T : Partial<T>) & { changedFields?: string[] };
 
     /**
      * Enum value type
@@ -165,6 +166,11 @@ export namespace DataTypes {
      */
     export type EnumBase = Record<string, EnumValue>;
 
+    /**
+     * Function type
+     */
+    export type Func<R> = (...args: any[]) => R;
+
     /**
      * String key, unknown value Record
      */

package/src/Utils.ts

@@ -187,6 +187,19 @@ export namespace Utils {
         return changes;
     }
 
+    /**
+     * Get input function or value result
+     * @param input Input function or value
+     * @param args Arguments
+     * @returns Result
+     */
+    export const getResult = <R, T = DataTypes.Func<R> | R>(
+        input: T,
+        ...args: T extends DataTypes.Func<R> ? Parameters<typeof input> : never
+    ): T extends DataTypes.Func<R> ? ReturnType<T> : T => {
+        return typeof input === 'function' ? input(...args) : input;
+    };
+
     /**
      * Get time zone
      * @returns Timezone