feat: add deepMerge utility

src/modules/esl-utils/misc/object.ts

@@ -87,3 +87,28 @@ export const get = (data: any, path: string, defaultValue?: any): any => {
   }, data);
   return typeof result === 'undefined' ? defaultValue : result;
 };
+
+/**
+ * Performs a deep merge of objects and returns new object.
+ * Does not modify objects (immutable)
+ * @param objects to merge
+ * @returns new object with merged key/values
+ */
+export function deepMerge(...objects: any[]): any {
+  return objects.reduce((res: any, obj: any) => {
+    isObject(obj) && Object.keys(obj).forEach((key) => {
+      const resultVal = res[key];
+      const objectVal = obj[key];
+
+      if (Array.isArray(objectVal)) {
+        res[key] = objectVal.slice();
+      } else if (isObject(resultVal) && isObject(objectVal)) {
+        res[key] = deepMerge(resultVal, objectVal);
+      } else {
+        res[key] = objectVal;
+      }
+    });
+
+    return res;
+  }, {});
+}

src/modules/esl-utils/misc/test/object.test.ts

@@ -1,4 +1,4 @@
-import {defined, deepCompare, getPropertyDescriptor, get, set, copyDefinedKeys, copy, omit} from '../object';
+import {defined, deepCompare, getPropertyDescriptor, get, set, copyDefinedKeys, copy, omit, deepMerge} from '../object';
 
 describe('misc/object', () => {
   describe('deepCompare', () => {
@@ -144,7 +144,6 @@ describe('misc/object', () => {
   });
 
   describe('omit', () => {
-    const predicate = (key: string) => !key.startsWith('_');
     test.each([
       [undefined, ['prop'], {}],
       [null, ['prop'], {}],
@@ -189,4 +188,18 @@ describe('misc/object', () => {
       expect(targ).toEqual(expVal)
     });
   });
+
+  describe('deepMerge', () => {
+    test.each([
+      [{}, {}, {}],
+      [{a: 1, b: 1}, {a: 2, c: 2}, {a: 2, b: 1, c: 2}],
+      [{a: {a: 1, b: 1}, b: 1}, {a: {a: 3, c: 3}}, {a: {a: 3, b: 1, c: 3}, b: 1}],
+      [{a: 1}, {b: 2}, {c: 3}, {a: 1, b: 2, c: 3}],
+      [{a: 'value', b: 'value'}, {a: null, b: ''}, {a: null, b: ''}],
+      [{a: [1, 2, {a: 1, b: 1}]}, {a: [3, 4, {a: 2, b: 2}]}, {a: [3, 4, {a: 2, b: 2}]}]
+    ])('get key "%s" from %p', (...args: any[]) => {
+      const result = args.pop();
+      expect(deepMerge(...args)).toEqual(result);
+    });
+  });
 });