merge-deeper-object 0.2.0 → 1.0.0

package/README.md

@@ -1,32 +1,82 @@
 ## merge-deeper-object
-Combine the attributes of objects deeply.
 
-## Install
+A lightweight, zero-dependency utility for deep merging objects
+
+## Features
+
+- **Deep merge object:** recursively merges nested objects
+- **Array concatenation:** arrays are combined, not overwritten
+- **Immutable:** returns a new object, never mutates the originals
+- **Symbol support:** handles Symbol keys alongside string keys
+- **Secure:** blocks prototype pollution
+- **Dual format:** ships both CJS and ESM builds
+- **Zero dependencies**
+
+## Installation
+
 ```
-npm install --save merge-deeper-object
+npm install merge-deeper-object
 ```
 
-## Running tests
 ```
-npm install
-npm run test
+yarn add merge-deeper-object
+```
+
+```
+pnpm add merge-deeper-object
 ```
 
 ## Usage
+
+### ESM
+
 ```javascript
-var mergeDeeper = require('merge-deeper-object')
+import mergeDeeper from 'merge-deeper-object';
 
-var obj1 = { a: { b: { c: 1 } }, d: "d", e: { f: true } }
-var obj2 = { a: { g: "g" }, d: "dd", e: { f: false }  }
+const base = {
+  server: { port: 3000, host: 'localhost' },
+  features: ['auth']
+};
 
-mergeDeeper(obj1, obj2)
+const overrides = {
+  server: { port: 8080, ssl: true },
+  features: ['logging']
+};
 
+const config = mergeDeeper(base, overrides);
+// {
+//   server: { port: 8080, host: 'localhost', ssl: true },
+//   features: ['auth', 'logging']
+// }
+```
+
+### CJS
+
+```javascript
+const mergeDeeper = require('merge-deeper-object');
 
-> { a: { b: { c: 1 }, g: "g" }, d: "dd", e: { f: false } }
+const result = mergeDeeper({ a: 1 }, { b: 2 });
+// { a: 1, b: 2 }
 ```
 
-## Author
-[Ilyass Mabrouk](https://github.com/work-state)
+## Testing
+
+```
+git clone git@github.com:work-state/merge-deeper-object.git
+cd merge-deeper-object
+npm install
+npm test
+```
+
+## Compatibility
+
+- **Node.js** >= 14
+- **Browsers:** all modern browsers (ES2015+). If you need to support older browsers, configure yout bundler (Babel, SWC) to transpile `node_modules/merge-deeper-object`
 
 ## License
+
 [MIT](https://github.com/work-state/merge-deeper-object/blob/master/LICENSE.md)
+
+## Author
+
+[Ilyass Mabrouk](https://github.com/work-state)

package/dist/index.cjs

@@ -0,0 +1,39 @@
+'use strict';
+
+const UNSAFE_KEYS = new Set(['__proto__', 'constructor', 'prototype']);
+
+function isSafe(key) {
+  return typeof key === 'symbol' || !UNSAFE_KEYS.has(key);
+}
+
+function isPlainObject(value) {
+  return value !== null && typeof value === 'object' && !Array.isArray(value);
+}
+
+function mergeDeeper(target, source) {
+  if (!isPlainObject(source)) return target;
+
+  const result = { ...target };
+
+  for (const key of [
+    ...Object.keys(source),
+    ...Object.getOwnPropertySymbols(source)
+  ]) {
+    if (!isSafe(key)) continue;
+
+    const srcVal = source[key];
+    const targetVal = result[key];
+
+    if (Array.isArray(srcVal) && Array.isArray(targetVal)) {
+      result[key] = [...targetVal, ...srcVal];
+    } else if (isPlainObject(srcVal) && isPlainObject(targetVal)) {
+      result[key] = mergeDeeper(targetVal, srcVal);
+    } else {
+      result[key] = srcVal;
+    }
+  }
+
+  return result;
+}
+
+module.exports = mergeDeeper;

package/dist/index.mjs

@@ -0,0 +1,37 @@
+const UNSAFE_KEYS = new Set(['__proto__', 'constructor', 'prototype']);
+
+function isSafe(key) {
+  return typeof key === 'symbol' || !UNSAFE_KEYS.has(key);
+}
+
+function isPlainObject(value) {
+  return value !== null && typeof value === 'object' && !Array.isArray(value);
+}
+
+function mergeDeeper(target, source) {
+  if (!isPlainObject(source)) return target;
+
+  const result = { ...target };
+
+  for (const key of [
+    ...Object.keys(source),
+    ...Object.getOwnPropertySymbols(source)
+  ]) {
+    if (!isSafe(key)) continue;
+
+    const srcVal = source[key];
+    const targetVal = result[key];
+
+    if (Array.isArray(srcVal) && Array.isArray(targetVal)) {
+      result[key] = [...targetVal, ...srcVal];
+    } else if (isPlainObject(srcVal) && isPlainObject(targetVal)) {
+      result[key] = mergeDeeper(targetVal, srcVal);
+    } else {
+      result[key] = srcVal;
+    }
+  }
+
+  return result;
+}
+
+export { mergeDeeper as default };

package/package.json

@@ -1,9 +1,9 @@
 {
-  "version": "0.2.0",
+  "version": "1.0.0",
   "author": "Ilyass Mabrouk",
   "license": "MIT",
   "name": "merge-deeper-object",
-  "description": "Deep merge properties of objects.",
+  "description": "Deep merge utility for nested objects.",
   "homepage": "https://github.com/work-state/merge-deeper-object",
   "repository": {
     "type": "git",
@@ -12,14 +12,19 @@
   "bugs": {
     "url": "https://github.com/work-state/merge-deeper-object/issues"
   },
-  "main": "index.js",
-  "files": [
-    "index.d.ts",
-    "index.js"
-  ],
-  "types": "index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.cjs"
+    }
+  },
+  "main": "dist/index.cjs",
+  "module": "dist/index.mjs",
+  "files": ["dist"],
   "scripts": {
-    "test": "mocha"
+    "test": "vitest run",
+    "build": "rollup -c",
+    "prepublishOnly": "npm run build && npm run test"
   },
   "keywords": [
     "object",
@@ -37,7 +42,8 @@
     "properties",
     "property",
     "entries",
-    "entry"
+    "entry",
+    "recursive"
   ],
   "verb": {
     "tasks": [
@@ -51,10 +57,10 @@
     }
   },
   "devDependencies": {
-    "chai": "^4.3.7",
-    "mocha": "^10.2.0"
+    "rollup": "^4.59.0",
+    "vitest": "^4.1.0"
   },
-  "directories": {
-    "test": "test"
+  "engines": {
+    "node": ">=14"
   }
 }

package/index.d.ts

@@ -1,2 +0,0 @@
-declare function _exports(object: Record<any, any>, merge: Record<any, any>): Record<any, any>;
-export = _exports;

package/index.js

@@ -1,18 +0,0 @@
-module.exports = function mergeDeeper(object, merge) {
-  if (!merge || typeof merge === "string") merge = {};
-  [...Object.keys(merge), ...Object.getOwnPropertySymbols(merge)].map((key) => {
-    if (Array.isArray(merge[key]) && Array.isArray(object[key])) {
-      object[key] = [...object[key], ...merge[key]];
-    } else {
-      if (
-        key in object &&
-        (typeof merge[key] && typeof object[key]) === "object"
-      ) {
-        mergeDeeper(object[key], merge[key]);
-      } else {
-        object[key] = merge[key];
-      }
-    }
-  });
-  return object;
-};