@webfactoryde/merge-objects 1.0.0

package/.babelrc

@@ -0,0 +1,3 @@
+{
+    "presets": ["@babel/preset-env"]
+}

package/.github/workflows/tests.yml

@@ -0,0 +1,29 @@
+name: Tests
+
+on:
+    push:
+        branches: [ master ]
+    pull_request:
+    pull_request_target:
+
+    # Allows you to run this workflow manually from the Actions tab
+    workflow_dispatch:
+
+jobs:
+    JSUnit:
+        runs-on: ubuntu-latest
+
+        strategy:
+            matrix:
+                node-version: [ 20.x ]
+
+        steps:
+            - uses: actions/checkout@v4
+
+            - name: Use Node.js ${{ matrix.node-version }}
+              uses: actions/setup-node@v3
+              with:
+                  node-version: ${{ matrix.node-version }}
+                  cache: 'npm'
+            -   run: yarn install --immutable --immutable-cache --check-cache
+            -   run: yarn test

package/.idea/merge-objects.iml

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<module type="WEB_MODULE" version="4">
+  <component name="NewModuleRootManager">
+    <content url="file://$MODULE_DIR$" />
+    <orderEntry type="inheritedJdk" />
+    <orderEntry type="sourceFolder" forTests="false" />
+  </component>
+</module>

package/.idea/modules.xml

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="ProjectModuleManager">
+    <modules>
+      <module fileurl="file://$PROJECT_DIR$/.idea/merge-objects.iml" filepath="$PROJECT_DIR$/.idea/merge-objects.iml" />
+    </modules>
+  </component>
+</project>

package/.idea/php.xml

@@ -0,0 +1,19 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="MessDetectorOptionsConfiguration">
+    <option name="transferred" value="true" />
+  </component>
+  <component name="PHPCSFixerOptionsConfiguration">
+    <option name="transferred" value="true" />
+  </component>
+  <component name="PHPCodeSnifferOptionsConfiguration">
+    <option name="highlightLevel" value="WARNING" />
+    <option name="transferred" value="true" />
+  </component>
+  <component name="PhpStanOptionsConfiguration">
+    <option name="transferred" value="true" />
+  </component>
+  <component name="PsalmOptionsConfiguration">
+    <option name="transferred" value="true" />
+  </component>
+</project>

package/.idea/vcs.xml

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="VcsDirectoryMappings">
+    <mapping directory="$PROJECT_DIR$" vcs="Git" />
+  </component>
+</project>

package/README.md

@@ -0,0 +1,30 @@
+# mergeObjects Utility
+
+The `mergeObjects` function is a utility for merging multiple objects into a single object, with an option to perform a deep merge. This function is particularly useful for combining configuration settings, state management, or any scenario where you need to consolidate multiple objects while preserving their properties.
+
+## Installation
+
+```
+npm install @webfactoryde/merge-objects
+```
+
+## Usage
+
+Import the `mergeObjects` function in your module(s) and pass any number of objects:
+
+```javascript
+// your module
+import mergeObjects from '@webfactoryde/merge-objects';
+
+// Shallow merge:
+const obj1 = { a: 1, b: 2 };
+const obj2 = { b: 3, c: 4 };
+const result = mergeObjects(obj1, obj2);
+console.log(result); // Output: { a: 1, b: 3, c: 4 }
+
+// Deep merge
+const obj1 = { a: 1, b: { x: 10, y: 20 } };
+const obj2 = { b: { y: 30, z: 40 }, c: 4 };
+const result = mergeObjects(true, obj1, obj2);
+console.log(result); // Output: { a: 1, b: { x: 10, y: 30, z: 40 }, c: 4 }
+```

package/jest.config.js

@@ -0,0 +1,7 @@
+export default {
+    testEnvironment: 'node',
+    transform: {
+        '^.+\\.jsx?$': 'babel-jest', // Use Babel to transpile ES modules
+    },
+    moduleFileExtensions: ['js', 'json', 'jsx', 'node'],
+};

package/package.json

@@ -0,0 +1,16 @@
+{
+    "name": "@webfactoryde/merge-objects",
+    "version": "1.0.0",
+    "description": "JS Utility that merges multiple objects into one, with an option for deep merging",
+    "main": "src/merge-objects.js",
+    "type": "module",
+    "devDependencies": {
+        "@babel/core": "^7.28.3",
+        "@babel/preset-env": "^7.28.3",
+        "babel-jest": "^30.1.1",
+        "jest": "^30.1.0"
+    },
+    "scripts": {
+        "test": "jest"
+    }
+}

package/src/merge-objects.js

@@ -0,0 +1,49 @@
+/**
+ * Merges multiple objects into one, with an option for deep merging.
+ *
+ * Accepts either:
+ *  - mergeObjects(true, obj1, obj2, ...)  // deep merge
+ *  - mergeObjects(obj1, obj2, ...)        // shallow merge
+ *
+ * @param {...(boolean|Object)} args Boolean deep flag optionally first, then source objects.
+ * @returns {Object} New merged object.
+ * @throws {TypeError} If any provided source (after optional boolean) is not an object.
+ * @see https://gomakethings.com/merging-objects-with-vanilla-javascript/#adding-a-deep-merge
+ */
+export default function mergeObjects(...args) {
+    // Determine whether caller passed (deep, ...objects) or just (...objects)
+    let deep = false;
+    let objects = args;
+
+    if (typeof args[0] === 'boolean') {
+        deep = args[0];
+        objects = args.slice(1);
+    }
+
+    const extended = {};
+
+    // Validate
+    for (const obj of objects) {
+        if (typeof obj !== 'object' || obj === null) {
+            throw new TypeError('All arguments after the deep parameter must be objects.');
+        }
+    }
+
+    const merge = (obj) => {
+        for (const prop in obj) {
+            if (Object.prototype.hasOwnProperty.call(obj, prop)) {
+                if (deep && typeof obj[prop] === 'object' && obj[prop] !== null) {
+                    extended[prop] = mergeObjects(true, extended[prop] || {}, obj[prop]);
+                } else {
+                    extended[prop] = obj[prop];
+                }
+            }
+        }
+    };
+
+    for (const obj of objects) {
+        merge(obj);
+    }
+
+    return extended;
+}

package/tests/mergeObjects.test.js

@@ -0,0 +1,52 @@
+import mergeObjects from '../src/merge-objects'; // Adjust the import path accordingly
+
+describe('mergeObjects', () => {
+    test('should perform a shallow merge', () => {
+        const obj1 = { a: 1, b: 2 };
+        const obj2 = { b: 3, c: 4 };
+        const result = mergeObjects(false, obj1, obj2);
+        expect(result).toEqual({ a: 1, b: 3, c: 4 });
+    });
+
+    test('should perform a deep merge', () => {
+        const obj1 = { a: 1, b: { x: 10, y: 20 } };
+        const obj2 = { b: { y: 30, z: 40 }, c: 4 };
+        const result = mergeObjects(true, obj1, obj2);
+        expect(result).toEqual({ a: 1, b: { x: 10, y: 30, z: 40 }, c: 4 });
+    });
+
+    test('should perform a shallow merge when no deep arg is passed', () => {
+        const obj1 = { a: 1, b: 2 };
+        const obj2 = { b: 3, c: 4 };
+        const result = mergeObjects(obj1, obj2); // No deep argument passed
+        expect(result).toEqual({ a: 1, b: 3, c: 4 });
+    });
+
+    test('should throw an error if a non-object is passed', () => {
+        expect(() => mergeObjects(true, { a: 1 }, 'not an object')).toThrow(TypeError);
+        expect(() => mergeObjects(false, { a: 1 }, null)).toThrow(TypeError);
+        expect(() => mergeObjects(false, { a: 1 }, 42)).toThrow(TypeError);
+    });
+
+    test('should handle more than two objects', () => {
+        const obj1 = { a: 1 };
+        const obj2 = { b: 2 };
+        const obj3 = { c: 3 };
+        const result = mergeObjects(false, obj1, obj2, obj3);
+        expect(result).toEqual({ a: 1, b: 2, c: 3 });
+    });
+
+    test('should handle empty objects', () => {
+        const obj1 = {};
+        const obj2 = {};
+        const result = mergeObjects(false, obj1, obj2);
+        expect(result).toEqual({});
+    });
+
+    test('should handle deep merge with empty objects', () => {
+        const obj1 = { a: 1, b: {} };
+        const obj2 = { b: { y: 30 }, c: 4 };
+        const result = mergeObjects(true, obj1, obj2);
+        expect(result).toEqual({ a: 1, b: { y: 30 }, c: 4 });
+    });
+});