@etsoo/shared 1.2.64 → 1.2.66

package/__tests__/Utils.ts

@@ -104,7 +104,7 @@ test("Tests for correctTypes", () => {
 
 test("Tests for getDataChanges", () => {
   const input = {
-    id: 1,
+    id: 2,
     name: "Name",
     gender: "F",
     brand: "",
@@ -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,27 @@ 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],
+    changedFields: ["gender", "brand", "date"]
+  };
+  const fields1 = Utils.getDataChanges(input1, initData, ["brand", "date"]);
+  expect(fields1).toStrictEqual(["id", "gender", "amount", "changedFields"]);
 });
 
 test("Tests for object array getDataChanges", () => {
@@ -145,7 +163,7 @@ test("Tests for object array getDataChanges", () => {
     ]
   };
   const initData = {
-    id: 1,
+    id: 2,
     ids: [1],
     items: [
       { id: 1, label: "a" },

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
@@ -156,10 +156,10 @@ export declare namespace Utils {
      * Get data changed fields (ignored changedFields) with input data updated
      * @param input Input data
      * @param initData Initial data
-     * @param ignoreFields Ignore fields
+     * @param ignoreFields Ignore fields, default is ['changedFields', 'id']
      * @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)[] | undefined = undefined>(input: T, initData: object, ignoreFields?: I): Exclude<keyof T & string, I extends undefined ? (typeof IgnoredProperties)[number] : Exclude<I, undefined>[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
@@ -257,15 +257,17 @@ var Utils;
      * Get data changed fields (ignored changedFields) with input data updated
      * @param input Input data
      * @param initData Initial data
-     * @param ignoreFields Ignore fields
+     * @param ignoreFields Ignore fields, default is ['changedFields', 'id']
      * @returns
      */
-    function getDataChanges(input, initData, ignoreFields = ["id"]) {
+    function getDataChanges(input, initData, ignoreFields) {
+        // Default ignore fields
+        const fields = ignoreFields ?? IgnoredProperties;
         // Changed fields
         const changes = [];
         Object.entries(input).forEach(([key, value]) => {
             // Ignore fields, no process
-            if (key === IgnoredProperty || ignoreFields.includes(key))
+            if (fields.includes(key))
                 return;
             // Compare with init value
             const initValue = Reflect.get(initData, key);

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
@@ -156,10 +156,10 @@ export declare namespace Utils {
      * Get data changed fields (ignored changedFields) with input data updated
      * @param input Input data
      * @param initData Initial data
-     * @param ignoreFields Ignore fields
+     * @param ignoreFields Ignore fields, default is ['changedFields', 'id']
      * @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)[] | undefined = undefined>(input: T, initData: object, ignoreFields?: I): Exclude<keyof T & string, I extends undefined ? (typeof IgnoredProperties)[number] : Exclude<I, undefined>[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
@@ -251,15 +251,17 @@ export var Utils;
      * Get data changed fields (ignored changedFields) with input data updated
      * @param input Input data
      * @param initData Initial data
-     * @param ignoreFields Ignore fields
+     * @param ignoreFields Ignore fields, default is ['changedFields', 'id']
      * @returns
      */
-    function getDataChanges(input, initData, ignoreFields = ["id"]) {
+    function getDataChanges(input, initData, ignoreFields) {
+        // Default ignore fields
+        const fields = ignoreFields ?? IgnoredProperties;
         // Changed fields
         const changes = [];
         Object.entries(input).forEach(([key, value]) => {
             // Ignore fields, no process
-            if (key === IgnoredProperty || ignoreFields.includes(key))
+            if (fields.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.64",
+  "version": "1.2.66",
   "description": "TypeScript shared utilities and functions",
   "main": "lib/cjs/index.js",
   "module": "lib/mjs/index.js",

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
@@ -402,20 +402,36 @@ export namespace Utils {
    * Get data changed fields (ignored changedFields) with input data updated
    * @param input Input data
    * @param initData Initial data
-   * @param ignoreFields Ignore fields
+   * @param ignoreFields Ignore fields, default is ['changedFields', 'id']
    * @returns
    */
-  export function getDataChanges<T extends object>(
+  export function getDataChanges<
+    T extends object,
+    const I extends (keyof T & string)[] | undefined = undefined
+  >(
     input: T,
     initData: object,
-    ignoreFields: string[] = ["id"]
-  ): Exclude<keyof T & string, typeof IgnoredProperty>[] {
+    ignoreFields?: I
+  ): Exclude<
+    keyof T & string,
+    I extends undefined
+      ? (typeof IgnoredProperties)[number]
+      : Exclude<I, undefined>[number]
+  >[] {
+    // Default ignore fields
+    const fields = ignoreFields ?? IgnoredProperties;
+
     // Changed fields
-    const changes: Exclude<keyof T & string, typeof IgnoredProperty>[] = [];
+    const changes: Exclude<
+      keyof T & string,
+      I extends undefined
+        ? (typeof IgnoredProperties)[number]
+        : Exclude<I, undefined>[number]
+    >[] = [];
 
     Object.entries(input).forEach(([key, value]) => {
       // Ignore fields, no process
-      if (key === IgnoredProperty || ignoreFields.includes(key)) return;
+      if (fields.includes(key as any)) return;
 
       // Compare with init value
       const initValue = Reflect.get(initData, key);