feat(object): add merge utils fns

.changeset/nine-turkeys-judge.md

@@ -0,0 +1,5 @@
+---
+"@opentf/utils": minor
+---
+
+Added merge utils fns & renamed arrayDiff to arrDiff

README.md

@@ -12,7 +12,11 @@
 
 > A collection of JavaScript utility functions.
 
-# [Playground](https://js-utils.pages.dev/playground) | [Documentation](https://js-utils.pages.dev)
+<div align="center">
+
+## [Playground](https://js-utils.pages.dev/playground) | [Documentation](https://js-utils.pages.dev)
+
+</div>
 
 ## Features
 
@@ -47,11 +51,11 @@ import { isNum, pascalCase, sort, clone, sleep } from "@opentf/utils";
 
 isNum(NaN); //=> false
 
-pascalCase('pascal case'); //=> PascalCase
+pascalCase("pascal case"); //=> PascalCase
 
-sort([1, 10, 21, 2], 'desc'); //=> [ 21, 10, 2, 1 ]
+sort([1, 10, 21, 2], "desc"); //=> [ 21, 10, 2, 1 ]
 
-const obj = {a: 1, b: 'abc', c: new Map([['key', 'val']])}
+const obj = { a: 1, b: "abc", c: new Map([["key", "val"]]) };
 clone(obj); // It returns deeply cloned value.
 
 await sleep(1000); // It suspends the exection for 1 second.
@@ -93,6 +97,10 @@ await sleep(1000); // It suspends the exection for 1 second.
 - [isShallowEql](https://js-utils.pages.dev/docs/Object/isShallowEql)
 - [setInObj](https://js-utils.pages.dev/docs/Object/setInObj)
 - [size](https://js-utils.pages.dev/docs/Object/size)
+- [merge](https://js-utils.pages.dev/docs/Object/merge)
+- [mergeAll](https://js-utils.pages.dev/docs/Object/mergeAll)
+- [shallowMerge](https://js-utils.pages.dev/docs/Object/shallowMerge)
+- [shallowMergeAll](https://js-utils.pages.dev/docs/Object/shallowMergeAll)
 
 ### String
 

apps/docs/components/PlaygroundREPL.js

@@ -20,6 +20,7 @@ log(camelCase('i phone'));
 `;
 
 const setupCode = `const _ = require('lodash');
+const R = require('ramda');
 const log = console.log;`;
 
 export default function PlaygroundREPL() {
@@ -30,7 +31,7 @@ export default function PlaygroundREPL() {
       <NodeREPL
         code={code}
         setupCode={setupCode}
-        deps={["@opentf/utils", "lodash"]}
+        deps={["@opentf/utils", "lodash", "ramda"]}
         layout="SPLIT_PANEL"
         editor={{
           darkMode: resolvedTheme === "dark",

apps/docs/components/REPL.js

@@ -11,6 +11,7 @@ const NodeREPL = dynamic(
 );
 
 const setupCode = `const _ = require('lodash');
+const R = require('ramda');
 const log = console.log;`;
 
 export default function REPL({ code = "", layout = "DEFAULT" }) {
@@ -28,7 +29,7 @@ export default function REPL({ code = "", layout = "DEFAULT" }) {
           <NodeREPL
             code={code}
             setupCode={setupCode}
-            deps={["@opentf/utils", "lodash"]}
+            deps={["@opentf/utils", "lodash", 'ramda']}
             editor={{
               darkMode: resolvedTheme === "dark",
               header: false,

apps/docs/pages/Object/_meta.json

@@ -3,5 +3,9 @@
   "delInObj": "delInObj",
   "getInObj": "getInObj",
   "setInObj": "setInObj",
-  "isShallowEql": "isShallowEql"
+  "isShallowEql": "isShallowEql",
+  "merge": "merge",
+  "mergeAll": "mergeAll",
+  "shallowMerge": "shallowMerge",
+  "shallowMergeAll": "shallowMergeAll"
 }

apps/docs/pages/Object/merge.mdx

@@ -0,0 +1,38 @@
+import { Callout } from "nextra/components";
+import REPL from "../../components/REPL";
+
+> It deeply merges objects or arrays.
+
+## Syntax
+
+```ts
+import { merge } from '@opentf/utils';
+
+merge(obj1, ...objN);
+```
+
+<Callout type="info" emoji="✅">
+Immutable: This does not mutate the given arrays or objects.
+</Callout>
+
+## Examples
+
+```ts
+const a = { a: { b: 1 }, d: 3 };
+const b = { a: { c: 2 }, e: 5 };
+merge(a, b); //=> { a: { b: 1, c: 2 }, d: 3, e: 5 }
+
+const a = { a: [1, 2] };
+const b = { a: [3, 4, 5] };
+const c = { a: [7, 8] };
+merge(a, b, c); //=> { a: [7, 8, 5] }
+```
+
+## Try
+
+<REPL code={`const { merge } = require('@opentf/utils');
+
+const a = { a: { b: 1 }, d: 3 };
+const b = { a: { c: 2 }, e: 5 };
+merge(a, b);
+`} />

apps/docs/pages/Object/mergeAll.mdx

@@ -0,0 +1,33 @@
+import { Callout } from "nextra/components";
+import REPL from "../../components/REPL";
+
+> It deeply merges objects and concatenates the arrays if any present.
+
+## Syntax
+
+```ts
+import { mergeAll } from '@opentf/utils';
+
+mergeAll(obj1, ...objN);
+```
+
+<Callout type="info" emoji="✅">
+Immutable: This does not mutate the given arrays or objects.
+</Callout>
+
+## Examples
+
+```ts
+const a = { a: { b: [1] } };
+const b = { a: { b: [2] } };
+mergeAll(a, b); //=> { a: { b: [1, 2] }
+```
+
+## Try
+
+<REPL code={`const { mergeAll } = require('@opentf/utils');
+
+const a = { a: { b: [1] } };
+const b = { a: { b: [2] } };
+mergeAll(a, b);
+`} />

apps/docs/pages/Object/shallowMerge.mdx

@@ -0,0 +1,38 @@
+import { Callout } from "nextra/components";
+import REPL from "../../components/REPL";
+
+> Shallow Merges objects or arrays.
+
+## Syntax
+
+```ts
+import { shallowMerge } from '@opentf/utils';
+
+shallowMerge(obj1, ...objN);
+```
+
+<Callout type="info" emoji="✅">
+Immutable: This does not mutate the given arrays or objects.
+</Callout>
+
+## Examples
+
+```ts
+const a = { a: 1 };
+const b = { b: 2 };
+shallowMerge(a, b); //=> { a: 1, b: 2 }
+
+const a = [1];
+const b = [2];
+const c = [3];
+shallowMerge(a, b, c); //=> [3]
+```
+
+## Try
+
+<REPL code={`const { shallowMerge } = require('@opentf/utils');
+
+const a = { a: 1 };
+const b = { b: 2 };
+shallowMerge(a, b);
+`} />

apps/docs/pages/Object/shallowMergeAll.mdx

@@ -0,0 +1,35 @@
+import { Callout } from "nextra/components";
+import REPL from "../../components/REPL";
+
+> Shallow merges objects and concatenates the array.
+
+## Syntax
+
+```ts
+import { shallowMergeAll } from '@opentf/utils';
+
+shallowMergeAll(obj1, ...objN);
+```
+
+<Callout type="info" emoji="✅">
+Immutable: This does not mutate the given arrays or objects.
+</Callout>
+
+## Examples
+
+```ts
+const a = [1];
+const b = [2];
+const c = [3];
+shallowMergeAll(a, b, c); //=> [1, 2, 3]
+```
+
+## Try
+
+<REPL code={`const { shallowMergeAll } = require('@opentf/utils');
+
+const a = [1];
+const b = [2];
+const c = [3];
+shallowMergeAll(a, b, c);
+`} />

apps/docs/pages/playground.mdx

@@ -12,7 +12,8 @@ import PlaygroundREPL from "../components/PlaygroundREPL";
 </Callout>
 
 <Callout type="info">
+ - The [Lodash](https://lodash.com/docs/) methods were preloaded. You can use it like, `_.isEmpty(value)`
 
-The [Lodash](https://lodash.com/docs/) methods were preloaded. You can use it like, `_.isEmpty(value)`
+ - The [Ramda](https://ramdajs.com/) methods were preloaded. You can use it like, `R.pipe(Math.pow, R.negate, R.inc)`
 
 </Callout>

packages/utils/README.md

@@ -12,7 +12,11 @@
 
 > A collection of JavaScript utility functions.
 
-# [Playground](https://js-utils.pages.dev/playground) | [Documentation](https://js-utils.pages.dev)
+<div align="center">
+
+## [Playground](https://js-utils.pages.dev/playground) | [Documentation](https://js-utils.pages.dev)
+
+</div>
 
 ## Features
 
@@ -43,14 +47,17 @@ bun add @opentf/utils
 ## Usage
 
 ```ts
-import { isNum, range, pascalCase, sleep } from '@opentf/utils';
+import { isNum, pascalCase, sort, clone, sleep } from '@opentf/utils';
 
 isNum(NaN); //=> false
 
-range(1, 5); //=> [1, 2, 3, 4, 5]
-
 pascalCase('pascal case'); //=> PascalCase
 
+sort([1, 10, 21, 2], 'desc'); //=> [ 21, 10, 2, 1 ]
+
+const obj = { a: 1, b: 'abc', c: new Map([['key', 'val']]) };
+clone(obj); // It returns deeply cloned value.
+
 await sleep(1000); // It suspends the exection for 1 second.
 ```
 
@@ -90,6 +97,10 @@ await sleep(1000); // It suspends the exection for 1 second.
 - [isShallowEql](https://js-utils.pages.dev/docs/Object/isShallowEql)
 - [setInObj](https://js-utils.pages.dev/docs/Object/setInObj)
 - [size](https://js-utils.pages.dev/docs/Object/size)
+- [merge](https://js-utils.pages.dev/docs/Object/merge)
+- [mergeAll](https://js-utils.pages.dev/docs/Object/mergeAll)
+- [shallowMerge](https://js-utils.pages.dev/docs/Object/shallowMerge)
+- [shallowMergeAll](https://js-utils.pages.dev/docs/Object/shallowMergeAll)
 
 ### String