@jsopen/objects 1.1.0 → 1.3.0

package/CHANGELOG.md

@@ -0,0 +1,6 @@
+# v1.3.0
+[2024-11-22]
+
+### Changes
+
+* feat: Added ability to merge non plain objects ([`3d32279`](https://github.com/panates/jsopen-objects/commit/3d3227998dbd8b345c24f4d7a0d9ab9bc3cd7b52))

package/cjs/index.js

@@ -2,7 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
 tslib_1.__exportStar(require("./clone.js"), exports);
-tslib_1.__exportStar(require("./is-built-in.js"), exports);
 tslib_1.__exportStar(require("./is-object.js"), exports);
 tslib_1.__exportStar(require("./merge.js"), exports);
 tslib_1.__exportStar(require("./omit.js"), exports);
+tslib_1.__exportStar(require("./type-guards.js"), exports);

package/cjs/merge.js

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.merge = merge;
 exports.getMergeFunction = getMergeFunction;
 const is_object_js_1 = require("./is-object.js");
+const type_guards_js_1 = require("./type-guards.js");
 function merge(target, source, options) {
     if (!((0, is_object_js_1.isObject)(target) || typeof target === 'function')) {
         throw new TypeError('"target" argument must be an object');
@@ -12,7 +13,7 @@ function merge(target, source, options) {
         throw new TypeError('"target" argument must be an object');
     }
     const fn = getMergeFunction(options);
-    return fn(target, source, '', options, fn, is_object_js_1.isPlainObject, is_object_js_1.isObject, arrayClone);
+    return fn(target, source, '', options, fn, type_guards_js_1.isBuiltIn, is_object_js_1.isObject, is_object_js_1.isPlainObject, arrayClone);
 }
 // eslint-disable-next-line @typescript-eslint/no-unused-vars
 const functionCache = new Map();
@@ -49,14 +50,15 @@ function buildMerge(options) {
         'curPath',
         'options',
         'mergeFunction',
-        'isPlainObject',
+        'isBuiltIn',
         'isObject',
+        'isPlainObject',
         'arrayClone',
     ];
     const scriptL0 = [
         `
 const _merge = (_trgVal, _srcVal, _curPath) => 
-    mergeFunction(_trgVal, _srcVal, _curPath, options, mergeFunction, isPlainObject, isObject, arrayClone);
+    mergeFunction(_trgVal, _srcVal, _curPath, options, mergeFunction, isBuiltIn, isObject, isPlainObject, arrayClone);
 const keys = Object.getOwnPropertyNames(source);
 keys.push(...Object.getOwnPropertySymbols(source));
 let key;
@@ -66,7 +68,7 @@ let trgVal;
 `,
     ];
     if (options?.deep) {
-        scriptL0.push(`let subPath;`, `let _isPlain;`, `let _isArray;`);
+        scriptL0.push(`let subPath;`, `let _isArray;`);
         if (typeof options?.deep === 'function') {
             scriptL0.push(`const deepCallback = options.deep;`);
         }
@@ -84,6 +86,7 @@ let trgVal;
         scriptL0.push(`const moveArraysCallback = options.moveArrays;`);
     }
     scriptL0.push(`
+if (isPlainObject(target)) Object.setPrototypeOf(target, Object.getPrototypeOf(source));  
 let i = 0;
 const len = keys.length;
 for (i = 0; i < len; i++) {
@@ -133,7 +136,7 @@ if (
   srcVal = source[key];`);
     }
     else {
-        scriptL1For.push(`descriptor = {enumerable: true, configurable: true, writable: true}`, `srcVal =  source[key];`);
+        scriptL1For.push(`descriptor = {enumerable: true, configurable: true, writable: true}`, `srcVal = source[key];`);
     }
     /** ************* keepExisting *****************/
     if (options?.keepExisting) {
@@ -147,36 +150,32 @@ if (
     if (options?.ignoreNulls) {
         scriptL1For.push(`if (srcVal === null) continue;`);
     }
+    const deepArray = !options?.moveArrays || typeof options?.moveArrays === 'function';
     /** ************* deep *****************/
     if (options?.deep) {
-        scriptL1For.push(`
-_isPlain = isPlainObject(srcVal);
+        if (deepArray) {
+            scriptL1For.push(`
 _isArray = Array.isArray(srcVal);
-if (_isPlain || _isArray) {`);
+if (_isArray || (typeof srcVal === 'object' && !isBuiltIn(srcVal))) {`);
+        }
+        else {
+            scriptL1For.push(`
+if (typeof srcVal === 'object' && !isBuiltIn(srcVal)) {
+  subPath = curPath + (curPath ? '.' : '') + key;`);
+        }
+        scriptL1For.push(`subPath = curPath + (curPath ? '.' : '') + key;`);
         const scriptL2Deep = [];
         scriptL1For.push(scriptL2Deep);
         scriptL1For.push('}');
         let scriptL3Deep = scriptL2Deep;
         if (typeof options?.deep === 'function') {
             scriptL2Deep.push(`
-subPath = curPath + (curPath ? '.' : '') + key;
 if (deepCallback(key, subPath, target, source)) {`);
             scriptL3Deep = [];
             scriptL2Deep.push(scriptL3Deep);
             scriptL2Deep.push('}');
         }
-        /** ************* _isPlain *****************/
-        scriptL3Deep.push(`
-if (_isPlain) {
-  trgVal = target[key];
-  if (!isObject(trgVal)) {
-    descriptor.value = trgVal = {};
-    Object.defineProperty(target, key, descriptor);
-  }
-  _merge(trgVal, srcVal, subPath, options);
-  continue;
-}`);
-        /** ************* moveArrays *****************/
+        /** ************* Array *****************/
         if (!options?.moveArrays || typeof options?.moveArrays === 'function') {
             scriptL3Deep.push(`if (_isArray) {`);
             const scriptL4IsArray = [];
@@ -184,7 +183,12 @@ if (_isPlain) {
             scriptL3Deep.push('}');
             let scriptL5CloneArrays = scriptL4IsArray;
             if (typeof options?.moveArrays === 'function') {
-                scriptL4IsArray.push(`if (!moveArraysCallback(key, subPath, target, source)) {`);
+                scriptL4IsArray.push(`
+if (moveArraysCallback(key, subPath, target, source)) {
+  descriptor.value = srcVal;
+  Object.defineProperty(target, key, descriptor);
+  continue;
+} else {`);
                 scriptL5CloneArrays = [];
                 scriptL4IsArray.push(scriptL5CloneArrays);
                 scriptL4IsArray.push('}');
@@ -195,6 +199,15 @@ Object.defineProperty(target, key, descriptor);
 continue;
 `);
         }
+        /** ************* object *****************/
+        scriptL3Deep.push(`
+trgVal = target[key];
+if (!isObject(trgVal)) {
+  descriptor.value = trgVal = {};  
+  Object.defineProperty(target, key, descriptor);
+}
+_merge(trgVal, srcVal, subPath, options);
+continue;`);
     }
     /** ************* finalize *****************/
     scriptL1For.push(`
@@ -209,7 +222,7 @@ function arrayClone(arr, _merge, curPath) {
     return arr.map((x) => {
         if (Array.isArray(x))
             return arrayClone(x, _merge, curPath);
-        if ((0, is_object_js_1.isPlainObject)(x))
+        if (typeof x === 'object' && !(0, type_guards_js_1.isBuiltIn)(x))
             return _merge({}, x, curPath);
         return x;
     });

package/cjs/omit.js

@@ -1,60 +1,39 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.omit = omit;
 exports.omitUndefined = omitUndefined;
 exports.omitNull = omitNull;
 exports.omitNullish = omitNullish;
-const is_object_js_1 = require("./is-object.js");
+const merge_js_1 = require("./merge.js");
+function omit(obj, keys) {
+    const keysSet = new Set(keys);
+    return (0, merge_js_1.merge)({}, obj, {
+        deep: false,
+        filter(key) {
+            return !keysSet.has(key);
+        },
+    });
+}
 function omitUndefined(obj, deep) {
-    /* istanbul ignore next */
-    if (!(obj && typeof obj === 'object'))
-        return obj;
-    let v;
-    for (const k of Object.keys(obj)) {
-        v = obj[k];
-        if (v === undefined)
-            delete obj[k];
-        else if (deep) {
-            if (Array.isArray(v))
-                v.forEach(x => omitUndefined(x, deep));
-            else if ((0, is_object_js_1.isPlainObject)(v))
-                omitUndefined(obj[k], deep);
-        }
-    }
-    return obj;
+    return (0, merge_js_1.merge)({}, obj, {
+        deep,
+        ignoreUndefined: true,
+        copyDescriptors: true,
+    });
 }
 function omitNull(obj, deep) {
-    /* istanbul ignore next */
-    if (!(obj && typeof obj === 'object'))
-        return obj;
-    let v;
-    for (const k of Object.keys(obj)) {
-        v = obj[k];
-        if (v === null)
-            delete obj[k];
-        else if (deep) {
-            if (Array.isArray(v))
-                v.forEach(x => omitNull(x, deep));
-            else if ((0, is_object_js_1.isPlainObject)(v))
-                omitNull(obj[k], deep);
-        }
-    }
-    return obj;
+    return (0, merge_js_1.merge)({}, obj, {
+        deep,
+        ignoreNulls: true,
+        ignoreUndefined: false,
+        copyDescriptors: true,
+    });
 }
 function omitNullish(obj, deep) {
-    /* istanbul ignore next */
-    if (!(obj && typeof obj === 'object'))
-        return obj;
-    let v;
-    for (const k of Object.keys(obj)) {
-        v = obj[k];
-        if (v == null)
-            delete obj[k];
-        else if (deep) {
-            if (Array.isArray(v))
-                v.forEach(x => omitNullish(x, deep));
-            else if ((0, is_object_js_1.isPlainObject)(v))
-                omitNullish(obj[k], deep);
-        }
-    }
-    return obj;
+    return (0, merge_js_1.merge)({}, obj, {
+        deep,
+        ignoreNulls: true,
+        ignoreUndefined: true,
+        copyDescriptors: true,
+    });
 }

package/cjs/tsconfig-build-cjs.tsbuildinfo

@@ -1 +1 @@
-{"root":["../../src/clone.ts","../../src/index.ts","../../src/is-built-in.ts","../../src/is-object.ts","../../src/merge.ts","../../src/omit.ts"],"version":"5.6.3"}
+{"root":["../../src/clone.ts","../../src/index.ts","../../src/is-object.ts","../../src/merge.ts","../../src/omit.ts","../../src/type-guards.ts"],"version":"5.6.3"}

package/cjs/{is-built-in.js → type-guards.js}

@@ -1,6 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.isBuiltIn = isBuiltIn;
+exports.isConstructor = isConstructor;
+exports.isIterable = isIterable;
+exports.isAsyncIterable = isAsyncIterable;
 function isBuiltIn(v) {
     return ((typeof v === 'object' &&
         (v instanceof Date ||
@@ -25,3 +28,16 @@ function isBuiltIn(v) {
             Buffer.isBuffer(v))) ||
         Array.isArray(v));
 }
+function isConstructor(fn) {
+    return (typeof fn === 'function' &&
+        fn.prototype &&
+        fn.prototype.constructor === fn &&
+        fn.prototype.constructor.name !== 'Function' &&
+        fn.prototype.constructor.name !== 'embedded');
+}
+function isIterable(x) {
+    return Symbol.iterator in x;
+}
+function isAsyncIterable(x) {
+    return Symbol.asyncIterator in x;
+}

package/esm/index.js

@@ -1,5 +1,5 @@
 export * from './clone.js';
-export * from './is-built-in.js';
 export * from './is-object.js';
 export * from './merge.js';
 export * from './omit.js';
+export * from './type-guards.js';

package/esm/merge.js

@@ -1,4 +1,5 @@
 import { isObject, isPlainObject } from './is-object.js';
+import { isBuiltIn } from './type-guards.js';
 export function merge(target, source, options) {
     if (!(isObject(target) || typeof target === 'function')) {
         throw new TypeError('"target" argument must be an object');
@@ -8,7 +9,7 @@ export function merge(target, source, options) {
         throw new TypeError('"target" argument must be an object');
     }
     const fn = getMergeFunction(options);
-    return fn(target, source, '', options, fn, isPlainObject, isObject, arrayClone);
+    return fn(target, source, '', options, fn, isBuiltIn, isObject, isPlainObject, arrayClone);
 }
 // eslint-disable-next-line @typescript-eslint/no-unused-vars
 const functionCache = new Map();
@@ -45,14 +46,15 @@ function buildMerge(options) {
         'curPath',
         'options',
         'mergeFunction',
-        'isPlainObject',
+        'isBuiltIn',
         'isObject',
+        'isPlainObject',
         'arrayClone',
     ];
     const scriptL0 = [
         `
 const _merge = (_trgVal, _srcVal, _curPath) => 
-    mergeFunction(_trgVal, _srcVal, _curPath, options, mergeFunction, isPlainObject, isObject, arrayClone);
+    mergeFunction(_trgVal, _srcVal, _curPath, options, mergeFunction, isBuiltIn, isObject, isPlainObject, arrayClone);
 const keys = Object.getOwnPropertyNames(source);
 keys.push(...Object.getOwnPropertySymbols(source));
 let key;
@@ -62,7 +64,7 @@ let trgVal;
 `,
     ];
     if (options?.deep) {
-        scriptL0.push(`let subPath;`, `let _isPlain;`, `let _isArray;`);
+        scriptL0.push(`let subPath;`, `let _isArray;`);
         if (typeof options?.deep === 'function') {
             scriptL0.push(`const deepCallback = options.deep;`);
         }
@@ -80,6 +82,7 @@ let trgVal;
         scriptL0.push(`const moveArraysCallback = options.moveArrays;`);
     }
     scriptL0.push(`
+if (isPlainObject(target)) Object.setPrototypeOf(target, Object.getPrototypeOf(source));  
 let i = 0;
 const len = keys.length;
 for (i = 0; i < len; i++) {
@@ -129,7 +132,7 @@ if (
   srcVal = source[key];`);
     }
     else {
-        scriptL1For.push(`descriptor = {enumerable: true, configurable: true, writable: true}`, `srcVal =  source[key];`);
+        scriptL1For.push(`descriptor = {enumerable: true, configurable: true, writable: true}`, `srcVal = source[key];`);
     }
     /** ************* keepExisting *****************/
     if (options?.keepExisting) {
@@ -143,36 +146,32 @@ if (
     if (options?.ignoreNulls) {
         scriptL1For.push(`if (srcVal === null) continue;`);
     }
+    const deepArray = !options?.moveArrays || typeof options?.moveArrays === 'function';
     /** ************* deep *****************/
     if (options?.deep) {
-        scriptL1For.push(`
-_isPlain = isPlainObject(srcVal);
+        if (deepArray) {
+            scriptL1For.push(`
 _isArray = Array.isArray(srcVal);
-if (_isPlain || _isArray) {`);
+if (_isArray || (typeof srcVal === 'object' && !isBuiltIn(srcVal))) {`);
+        }
+        else {
+            scriptL1For.push(`
+if (typeof srcVal === 'object' && !isBuiltIn(srcVal)) {
+  subPath = curPath + (curPath ? '.' : '') + key;`);
+        }
+        scriptL1For.push(`subPath = curPath + (curPath ? '.' : '') + key;`);
         const scriptL2Deep = [];
         scriptL1For.push(scriptL2Deep);
         scriptL1For.push('}');
         let scriptL3Deep = scriptL2Deep;
         if (typeof options?.deep === 'function') {
             scriptL2Deep.push(`
-subPath = curPath + (curPath ? '.' : '') + key;
 if (deepCallback(key, subPath, target, source)) {`);
             scriptL3Deep = [];
             scriptL2Deep.push(scriptL3Deep);
             scriptL2Deep.push('}');
         }
-        /** ************* _isPlain *****************/
-        scriptL3Deep.push(`
-if (_isPlain) {
-  trgVal = target[key];
-  if (!isObject(trgVal)) {
-    descriptor.value = trgVal = {};
-    Object.defineProperty(target, key, descriptor);
-  }
-  _merge(trgVal, srcVal, subPath, options);
-  continue;
-}`);
-        /** ************* moveArrays *****************/
+        /** ************* Array *****************/
         if (!options?.moveArrays || typeof options?.moveArrays === 'function') {
             scriptL3Deep.push(`if (_isArray) {`);
             const scriptL4IsArray = [];
@@ -180,7 +179,12 @@ if (_isPlain) {
             scriptL3Deep.push('}');
             let scriptL5CloneArrays = scriptL4IsArray;
             if (typeof options?.moveArrays === 'function') {
-                scriptL4IsArray.push(`if (!moveArraysCallback(key, subPath, target, source)) {`);
+                scriptL4IsArray.push(`
+if (moveArraysCallback(key, subPath, target, source)) {
+  descriptor.value = srcVal;
+  Object.defineProperty(target, key, descriptor);
+  continue;
+} else {`);
                 scriptL5CloneArrays = [];
                 scriptL4IsArray.push(scriptL5CloneArrays);
                 scriptL4IsArray.push('}');
@@ -191,6 +195,15 @@ Object.defineProperty(target, key, descriptor);
 continue;
 `);
         }
+        /** ************* object *****************/
+        scriptL3Deep.push(`
+trgVal = target[key];
+if (!isObject(trgVal)) {
+  descriptor.value = trgVal = {};  
+  Object.defineProperty(target, key, descriptor);
+}
+_merge(trgVal, srcVal, subPath, options);
+continue;`);
     }
     /** ************* finalize *****************/
     scriptL1For.push(`
@@ -205,7 +218,7 @@ function arrayClone(arr, _merge, curPath) {
     return arr.map((x) => {
         if (Array.isArray(x))
             return arrayClone(x, _merge, curPath);
-        if (isPlainObject(x))
+        if (typeof x === 'object' && !isBuiltIn(x))
             return _merge({}, x, curPath);
         return x;
     });

package/esm/omit.js

@@ -1,55 +1,33 @@
-import { isPlainObject } from './is-object.js';
+import { merge } from './merge.js';
+export function omit(obj, keys) {
+    const keysSet = new Set(keys);
+    return merge({}, obj, {
+        deep: false,
+        filter(key) {
+            return !keysSet.has(key);
+        },
+    });
+}
 export function omitUndefined(obj, deep) {
-    /* istanbul ignore next */
-    if (!(obj && typeof obj === 'object'))
-        return obj;
-    let v;
-    for (const k of Object.keys(obj)) {
-        v = obj[k];
-        if (v === undefined)
-            delete obj[k];
-        else if (deep) {
-            if (Array.isArray(v))
-                v.forEach(x => omitUndefined(x, deep));
-            else if (isPlainObject(v))
-                omitUndefined(obj[k], deep);
-        }
-    }
-    return obj;
+    return merge({}, obj, {
+        deep,
+        ignoreUndefined: true,
+        copyDescriptors: true,
+    });
 }
 export function omitNull(obj, deep) {
-    /* istanbul ignore next */
-    if (!(obj && typeof obj === 'object'))
-        return obj;
-    let v;
-    for (const k of Object.keys(obj)) {
-        v = obj[k];
-        if (v === null)
-            delete obj[k];
-        else if (deep) {
-            if (Array.isArray(v))
-                v.forEach(x => omitNull(x, deep));
-            else if (isPlainObject(v))
-                omitNull(obj[k], deep);
-        }
-    }
-    return obj;
+    return merge({}, obj, {
+        deep,
+        ignoreNulls: true,
+        ignoreUndefined: false,
+        copyDescriptors: true,
+    });
 }
 export function omitNullish(obj, deep) {
-    /* istanbul ignore next */
-    if (!(obj && typeof obj === 'object'))
-        return obj;
-    let v;
-    for (const k of Object.keys(obj)) {
-        v = obj[k];
-        if (v == null)
-            delete obj[k];
-        else if (deep) {
-            if (Array.isArray(v))
-                v.forEach(x => omitNullish(x, deep));
-            else if (isPlainObject(v))
-                omitNullish(obj[k], deep);
-        }
-    }
-    return obj;
+    return merge({}, obj, {
+        deep,
+        ignoreNulls: true,
+        ignoreUndefined: true,
+        copyDescriptors: true,
+    });
 }

package/esm/tsconfig-build-esm.tsbuildinfo

@@ -1 +1 @@
-{"root":["../../src/clone.ts","../../src/index.ts","../../src/is-built-in.ts","../../src/is-object.ts","../../src/merge.ts","../../src/omit.ts"],"version":"5.6.3"}
+{"root":["../../src/clone.ts","../../src/index.ts","../../src/is-object.ts","../../src/merge.ts","../../src/omit.ts","../../src/type-guards.ts"],"version":"5.6.3"}

package/esm/{is-built-in.js → type-guards.js}

@@ -22,3 +22,16 @@ export function isBuiltIn(v) {
             Buffer.isBuffer(v))) ||
         Array.isArray(v));
 }
+export function isConstructor(fn) {
+    return (typeof fn === 'function' &&
+        fn.prototype &&
+        fn.prototype.constructor === fn &&
+        fn.prototype.constructor.name !== 'Function' &&
+        fn.prototype.constructor.name !== 'embedded');
+}
+export function isIterable(x) {
+    return Symbol.iterator in x;
+}
+export function isAsyncIterable(x) {
+    return Symbol.asyncIterator in x;
+}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@jsopen/objects",
   "description": "Helper utilities for working with JavaScript objects and arrays",
-  "version": "1.1.0",
+  "version": "1.3.0",
   "author": "Panates",
   "license": "MIT",
   "dependencies": {

package/types/index.d.cts

@@ -1,5 +1,5 @@
 export * from './clone.js';
-export * from './is-built-in.js';
 export * from './is-object.js';
 export * from './merge.js';
 export * from './omit.js';
+export * from './type-guards.js';

package/types/index.d.ts

@@ -1,5 +1,5 @@
 export * from './clone.js';
-export * from './is-built-in.js';
 export * from './is-object.js';
 export * from './merge.js';
 export * from './omit.js';
+export * from './type-guards.js';

package/types/omit.d.ts

@@ -1,4 +1,4 @@
-import { DeeperOmitTypes } from 'ts-gems';
-export declare function omitUndefined<T>(obj: T, deep?: boolean): DeeperOmitTypes<T, undefined>;
-export declare function omitNull<T>(obj: T, deep?: boolean): DeeperOmitTypes<T, null>;
-export declare function omitNullish<T>(obj: T, deep?: boolean): DeeperOmitTypes<T, null | undefined>;
+export declare function omit<T, K extends keyof T>(obj: T, keys: K[]): Omit<T, K>;
+export declare function omitUndefined<T>(obj: T, deep?: boolean): T;
+export declare function omitNull<T>(obj: T, deep?: boolean): T;
+export declare function omitNullish<T>(obj: T, deep?: boolean): T;

package/types/type-guards.d.ts

@@ -0,0 +1,5 @@
+import { Type } from 'ts-gems';
+export declare function isBuiltIn(v: any): boolean;
+export declare function isConstructor(fn: any): fn is Type;
+export declare function isIterable<T = unknown>(x: any): x is Iterable<T>;
+export declare function isAsyncIterable<T = unknown>(x: any): x is AsyncIterableIterator<T>;

package/types/is-built-in.d.ts

@@ -1 +0,0 @@
-export declare function isBuiltIn(v: any): boolean;