@etsoo/shared 1.0.96 → 1.1.0

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|

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
      */
@@ -251,14 +258,14 @@ export declare namespace DataTypes {
      * @param key Property name
      * @returns Id value
      */
-    function getIdValue<T extends {}>(data: T, key: keyof T | string): IdType | undefined | null;
+    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, key: keyof T | string): string | undefined | null;
+    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.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
      */
@@ -251,14 +258,14 @@ export declare namespace DataTypes {
      * @param key Property name
      * @returns Id value
      */
-    function getIdValue<T extends {}>(data: T, key: keyof T | string): IdType | undefined | null;
+    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, key: keyof T | string): string | undefined | null;
+    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/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@etsoo/shared",
-    "version": "1.0.96",
+    "version": "1.1.0",
     "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,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
      */
@@ -498,7 +507,7 @@ export namespace DataTypes {
      * @returns Id value
      */
     export function getIdValue<T extends {}>(
-        data: T,
+        data: T | undefined | null,
         key: keyof T | string
     ): IdType | undefined | null {
         if (data == null) return null;
@@ -516,7 +525,7 @@ export namespace DataTypes {
      * @returns String value
      */
     export function getStringValue<T extends {}>(
-        data: T,
+        data: T | undefined | null,
         key: keyof T | string
     ): string | undefined | null {
         const value = getIdValue(data, key);