@etsoo/shared 1.2.63 → 1.2.65

package/README.md

@@ -130,8 +130,6 @@ Data type definitions and type safe functions. ListItemType, ListItemType1 and L
 |                Name | Description                                                            |
 | ------------------: | ---------------------------------------------------------------------- |
 |            DataType | Data type enum                                                         |
-|      AddAndEditType | Add and edit data type                                                 |
-|       AddOrEditType | Add or edit conditional type                                           |
 |         addUrlParam | Add parameter to URL                                                   |
 |        addUrlParams | Add parameters to URL                                                  |
 |               Basic | Basic types, includes number, bigint, Date, boolean, string            |
@@ -144,6 +142,7 @@ Data type definitions and type safe functions. ListItemType, ListItemType1 and L
 |   CultureDefinition | Culture definition                                                     |
 |                  DI | Dynamic interface with multiple properties                             |
 |                 DIS | Dynamic interface with single property                                 |
+|            EditType | Create edit type from adding type                                      |
 |            EnumBase | Enum base type                                                         |
 |           EnumValue | Enum value type                                                        |
 |        ExtendedEnum | Extended type enum                                                     |

package/__tests__/DataTypes.ts

@@ -202,39 +202,18 @@ test("Tests for jsonReplacer", () => {
   expect(json2).toBe('{"c":{"c2":false}}');
 });
 
-test("Tests for AddAndEditType", () => {
-  type Entity = DataTypes.AddAndEditType<{
-    id: number;
-    name: string;
-    age?: number;
-  }>;
-
-  const data1: Entity = { id: 1, name: "hello", changedFields: ["name"] };
-  const data2: Entity = { id: undefined, name: "hello" };
-  const data3: Entity = { name: "hello" };
-
-  expect(data1.name).toBe(data2.name);
-  expect(data2.name).toBe(data3.name);
-});
-
-test("Tests for AddOrEditType", () => {
-  type Entity = {
-    id: number;
+test("Tests for EditType", () => {
+  type AddEntity = {
     name: string;
     age?: number;
   };
-  type AddEntity = DataTypes.AddOrEditType<Entity, false>;
-  type EditEntity = DataTypes.AddOrEditType<Entity, true>;
 
-  const data1: AddEntity = { id: 1, name: "hello" };
-  const data2: AddEntity = { id: undefined, name: "hello" };
-  const data3: AddEntity = { name: "hello" };
+  type EditType = DataTypes.EditType<AddEntity>;
 
-  const data4: EditEntity = { id: 1, name: "hello", changedFields: ["name"] };
+  const data1: EditType = { id: 1, name: "hello", changedFields: ["name"] };
+  const data2: EditType = { id: 1, name: "hello", age: 1 };
 
   expect(data1.name).toBe(data2.name);
-  expect(data2.name).toBe(data3.name);
-  expect(data3.name).toBe(data4.name);
 });
 
 test("Tests for BasicTemplate", () => {

package/__tests__/Utils.ts

@@ -117,6 +117,7 @@ test("Tests for getDataChanges", () => {
     data: { d1: 1, d2: false, d3: 1.2, d4: "Hello" },
     changedFields: ["gender", "brand", "date"]
   };
+
   const initData = {
     id: 1,
     name: "Name",
@@ -129,10 +130,26 @@ test("Tests for getDataChanges", () => {
     ids: [1, 2],
     data: { d1: 1, d3: 1.2, d4: "Hello", d2: false }
   };
+
   const fields = Utils.getDataChanges(input, initData);
   expect(fields).toStrictEqual(["gender", "brand", "amount"]);
   expect(input.price).toBeUndefined();
   expect(input.amount).toBeUndefined();
+
+  const input1 = {
+    id: 2,
+    name: "Name",
+    gender: "F",
+    brand: "",
+    price: "6.0",
+    amount: "",
+    enabled: true,
+    value: undefined,
+    date: new Date("2023/03/18"),
+    ids: [1, 2]
+  };
+  const fields1 = Utils.getDataChanges(input1, initData, ["brand", "date"]);
+  expect(fields1).toStrictEqual(["gender", "amount"]);
 });
 
 test("Tests for object array getDataChanges", () => {
@@ -145,7 +162,7 @@ test("Tests for object array getDataChanges", () => {
     ]
   };
   const initData = {
-    id: 1,
+    id: 2,
     ids: [1],
     items: [
       { id: 1, label: "a" },

package/lib/cjs/DataTypes.d.ts

@@ -139,25 +139,10 @@ export declare namespace DataTypes {
      */
     type Placement = keyof typeof PlacementEnum;
     /**
-     * Add and edit data type
-     * ChangedFields for editing case
-     */
-    type AddAndEditType<T extends {
-        [key in D]: IdType;
-    }, D extends string = "id"> = (Omit<T, D> & {
-        [key in D]?: undefined | never;
-    }) | (Partial<T> & Readonly<Pick<T, D>> & {
-        changedFields?: (keyof T & string)[];
-    });
-    /**
-     * Add or edit conditional type
-     * ChangedFields for editing case
+     * Edit type from adding type
      */
-    type AddOrEditType<T extends {
-        [key in D]: IdType;
-    }, // Entity modal
-    E extends boolean, // Editing or not
-    D extends string = "id"> = E extends false ? Optional<T, D> : Partial<T> & Readonly<Pick<T, D>> & {
+    type EditType<T, I extends IdType = number> = Partial<T> & {
+        id: I;
         changedFields?: (keyof T & string)[];
     };
     /**

package/lib/cjs/Utils.d.ts

@@ -89,7 +89,7 @@ declare global {
  * Utilities
  */
 export declare namespace Utils {
-    const IgnoredProperty: "changedFields";
+    const IgnoredProperties: readonly ["changedFields", "id"];
     /**
      * Add blank item to collection
      * @param options Options
@@ -159,7 +159,7 @@ export declare namespace Utils {
      * @param ignoreFields Ignore fields
      * @returns
      */
-    export function getDataChanges<T extends object>(input: T, initData: object, ignoreFields?: string[]): Exclude<keyof T & string, typeof IgnoredProperty>[];
+    export function getDataChanges<T extends object, const I extends (keyof T & string)[]>(input: T, initData: object, ignoreFields?: I): Exclude<keyof T & string, (typeof ignoreFields)[number] | (typeof IgnoredProperties)[number]>[];
     /**
      * Get nested value from object
      * @param data Data

package/lib/cjs/Utils.js

@@ -133,7 +133,7 @@ String.prototype.removeNonLetters = function () {
  */
 var Utils;
 (function (Utils) {
-    const IgnoredProperty = "changedFields";
+    const IgnoredProperties = ["changedFields", "id"];
     /**
      * Add blank item to collection
      * @param options Options
@@ -260,12 +260,14 @@ var Utils;
      * @param ignoreFields Ignore fields
      * @returns
      */
-    function getDataChanges(input, initData, ignoreFields = ["id"]) {
+    function getDataChanges(input, initData, ignoreFields = []) {
         // Changed fields
         const changes = [];
+        // Ignored fields
+        const allFields = [...ignoreFields, ...IgnoredProperties];
         Object.entries(input).forEach(([key, value]) => {
             // Ignore fields, no process
-            if (key === IgnoredProperty || ignoreFields.includes(key))
+            if (allFields.includes(key))
                 return;
             // Compare with init value
             const initValue = Reflect.get(initData, key);

package/lib/mjs/DataTypes.d.ts

@@ -139,25 +139,10 @@ export declare namespace DataTypes {
      */
     type Placement = keyof typeof PlacementEnum;
     /**
-     * Add and edit data type
-     * ChangedFields for editing case
-     */
-    type AddAndEditType<T extends {
-        [key in D]: IdType;
-    }, D extends string = "id"> = (Omit<T, D> & {
-        [key in D]?: undefined | never;
-    }) | (Partial<T> & Readonly<Pick<T, D>> & {
-        changedFields?: (keyof T & string)[];
-    });
-    /**
-     * Add or edit conditional type
-     * ChangedFields for editing case
+     * Edit type from adding type
      */
-    type AddOrEditType<T extends {
-        [key in D]: IdType;
-    }, // Entity modal
-    E extends boolean, // Editing or not
-    D extends string = "id"> = E extends false ? Optional<T, D> : Partial<T> & Readonly<Pick<T, D>> & {
+    type EditType<T, I extends IdType = number> = Partial<T> & {
+        id: I;
         changedFields?: (keyof T & string)[];
     };
     /**

package/lib/mjs/Utils.d.ts

@@ -89,7 +89,7 @@ declare global {
  * Utilities
  */
 export declare namespace Utils {
-    const IgnoredProperty: "changedFields";
+    const IgnoredProperties: readonly ["changedFields", "id"];
     /**
      * Add blank item to collection
      * @param options Options
@@ -159,7 +159,7 @@ export declare namespace Utils {
      * @param ignoreFields Ignore fields
      * @returns
      */
-    export function getDataChanges<T extends object>(input: T, initData: object, ignoreFields?: string[]): Exclude<keyof T & string, typeof IgnoredProperty>[];
+    export function getDataChanges<T extends object, const I extends (keyof T & string)[]>(input: T, initData: object, ignoreFields?: I): Exclude<keyof T & string, (typeof ignoreFields)[number] | (typeof IgnoredProperties)[number]>[];
     /**
      * Get nested value from object
      * @param data Data

package/lib/mjs/Utils.js

@@ -127,7 +127,7 @@ String.prototype.removeNonLetters = function () {
  */
 export var Utils;
 (function (Utils) {
-    const IgnoredProperty = "changedFields";
+    const IgnoredProperties = ["changedFields", "id"];
     /**
      * Add blank item to collection
      * @param options Options
@@ -254,12 +254,14 @@ export var Utils;
      * @param ignoreFields Ignore fields
      * @returns
      */
-    function getDataChanges(input, initData, ignoreFields = ["id"]) {
+    function getDataChanges(input, initData, ignoreFields = []) {
         // Changed fields
         const changes = [];
+        // Ignored fields
+        const allFields = [...ignoreFields, ...IgnoredProperties];
         Object.entries(input).forEach(([key, value]) => {
             // Ignore fields, no process
-            if (key === IgnoredProperty || ignoreFields.includes(key))
+            if (allFields.includes(key))
                 return;
             // Compare with init value
             const initValue = Reflect.get(initData, key);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@etsoo/shared",
-  "version": "1.2.63",
+  "version": "1.2.65",
   "description": "TypeScript shared utilities and functions",
   "main": "lib/cjs/index.js",
   "module": "lib/mjs/index.js",
@@ -40,7 +40,7 @@
     "@vitejs/plugin-react": "^4.3.4",
     "jsdom": "^26.0.0",
     "typescript": "^5.8.2",
-    "vitest": "^3.0.9"
+    "vitest": "^3.1.1"
   },
   "dependencies": {
     "lodash.isequal": "^4.5.0"

package/src/DataTypes.ts

@@ -183,29 +183,12 @@ export namespace DataTypes {
   export type Placement = keyof typeof PlacementEnum;
 
   /**
-   * Add and edit data type
-   * ChangedFields for editing case
-   */
-  export type AddAndEditType<
-    T extends { [key in D]: IdType },
-    D extends string = "id"
-  > =
-    | (Omit<T, D> & { [key in D]?: undefined | never })
-    | (Partial<T> &
-        Readonly<Pick<T, D>> & { changedFields?: (keyof T & string)[] });
-
-  /**
-   * Add or edit conditional type
-   * ChangedFields for editing case
-   */
-  export type AddOrEditType<
-    T extends { [key in D]: IdType }, // Entity modal
-    E extends boolean, // Editing or not
-    D extends string = "id" // Default is 'id' field
-  > = E extends false
-    ? Optional<T, D>
-    : Partial<T> &
-        Readonly<Pick<T, D>> & { changedFields?: (keyof T & string)[] };
+   * Edit type from adding type
+   */
+  export type EditType<T, I extends IdType = number> = Partial<T> & {
+    id: I;
+    changedFields?: (keyof T & string)[];
+  };
 
   /**
    * Key collection, like { key1: {}, key2: {} }

package/src/Utils.ts

@@ -261,7 +261,7 @@ String.prototype.removeNonLetters = function (this: string) {
  * Utilities
  */
 export namespace Utils {
-  const IgnoredProperty = "changedFields" as const;
+  const IgnoredProperties = ["changedFields", "id"] as const;
 
   /**
    * Add blank item to collection
@@ -405,17 +405,29 @@ export namespace Utils {
    * @param ignoreFields Ignore fields
    * @returns
    */
-  export function getDataChanges<T extends object>(
+  export function getDataChanges<
+    T extends object,
+    const I extends (keyof T & string)[]
+  >(
     input: T,
     initData: object,
-    ignoreFields: string[] = ["id"]
-  ): Exclude<keyof T & string, typeof IgnoredProperty>[] {
+    ignoreFields: I = [] as any
+  ): Exclude<
+    keyof T & string,
+    (typeof ignoreFields)[number] | (typeof IgnoredProperties)[number]
+  >[] {
     // Changed fields
-    const changes: Exclude<keyof T & string, typeof IgnoredProperty>[] = [];
+    const changes: Exclude<
+      keyof T & string,
+      (typeof ignoreFields)[number] | (typeof IgnoredProperties)[number]
+    >[] = [];
+
+    // Ignored fields
+    const allFields: string[] = [...ignoreFields, ...IgnoredProperties];
 
     Object.entries(input).forEach(([key, value]) => {
       // Ignore fields, no process
-      if (key === IgnoredProperty || ignoreFields.includes(key)) return;
+      if (allFields.includes(key)) return;
 
       // Compare with init value
       const initValue = Reflect.get(initData, key);