@etsoo/shared 1.0.97 → 1.1.1

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|
@@ -61,6 +62,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,15 @@ 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
+    expect(Utils.getResult(input, true)).toBe(1);
+    expect(Utils.getResult(input, false)).toBe(0);
+    expect(Utils.getResult(inputNumber)).toBe(5);
+});

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 : Partial<T>) & {
+        changedFields?: string[];
+    };
     /**
      * Enum value type
      */

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, F extends R | ((...args: unknown[]) => R)>(input: F, ...args: unknown[]) => R;
     /**
      * 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

@@ -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 : Partial<T>) & {
+        changedFields?: string[];
+    };
     /**
      * Enum value type
      */

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, F extends R | ((...args: unknown[]) => R)>(input: F, ...args: unknown[]) => R;
     /**
      * 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.97",
+    "version": "1.1.1",
     "description": "TypeScript shared utilities and functions",
     "main": "lib/cjs/index.js",
     "module": "lib/mjs/index.js",
@@ -54,13 +54,13 @@
     "homepage": "https://github.com/ETSOO/Shared#readme",
     "dependencies": {},
     "devDependencies": {
-        "@types/jest": "^27.0.3",
-        "@typescript-eslint/eslint-plugin": "^5.8.0",
-        "@typescript-eslint/parser": "^5.8.0",
-        "eslint": "^8.5.0",
+        "@types/jest": "^27.4.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

@@ -147,6 +147,15 @@ 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 : Partial<T>) & { changedFields?: string[] };
+
     /**
      * Enum value type
      */

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, F extends ((...args: unknown[]) => R) | R>(
+        input: F,
+        ...args: unknown[]
+    ): R => {
+        return typeof input === 'function' ? input(...args) : input;
+    };
+
     /**
      * Get time zone
      * @returns Timezone