@adobe/spacecat-shared-utils 1.17.1 → 1.18.0

package/CHANGELOG.md

@@ -1,3 +1,10 @@
+# [@adobe/spacecat-shared-utils-v1.18.0](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-utils-v1.17.1...@adobe/spacecat-shared-utils-v1.18.0) (2024-07-04)
+
+
+### Features
+
+* utils deepEqual ([#282](https://github.com/adobe/spacecat-shared/issues/282)) ([d17ef5f](https://github.com/adobe/spacecat-shared/commit/d17ef5ff6dcacb7ddb3e60512d40d66202e14ffc))
+
 # [@adobe/spacecat-shared-utils-v1.17.1](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-utils-v1.17.0...@adobe/spacecat-shared-utils-v1.17.1) (2024-07-02)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/spacecat-shared-utils",
-  "version": "1.17.1",
+  "version": "1.18.0",
   "description": "Shared modules of the Spacecat Services - utils",
   "type": "module",
   "main": "src/index.js",

package/src/functions.js

@@ -63,7 +63,7 @@ function isNumber(value) {
  * @returns {boolean} True if the parameter is an object, false otherwise.
  */
 function isObject(value) {
-  return !isArray(value) && value !== null && typeof value === 'object';
+  return value !== null && typeof value === 'object' && !isArray(value);
 }
 
 /**
@@ -75,6 +75,43 @@ function isNonEmptyObject(value) {
   return isObject(value) && Object.keys(value).length > 0;
 }
 
+/**
+ * Deeply compares two objects or arrays for equality. Supports nested objects and arrays.
+ * Does not support circular references. Does not compare functions.
+ * @param {unknown} x - The first object or array to compare.
+ * @param {unknown} y - The second object or array to compare.
+ * @return {boolean} True if the objects or arrays are equal, false otherwise.
+ */
+function deepEqual(x, y) {
+  if (x === y) return true;
+
+  if (isArray(x) && isArray(y)) {
+    if (x.length !== y.length) return false;
+    for (let i = 0; i < x.length; i += 1) {
+      if (!deepEqual(x[i], y[i])) return false;
+    }
+    return true;
+  }
+
+  if (!isObject(x) || !isObject(y)) return false;
+
+  if (x.constructor !== y.constructor) return false;
+
+  if (x instanceof Date) return x.getTime() === y.getTime();
+  if (x instanceof RegExp) return x.toString() === y.toString();
+
+  const xKeys = Object.keys(x).filter((key) => typeof x[key] !== 'function');
+  const yKeys = Object.keys(y).filter((key) => typeof y[key] !== 'function');
+
+  if (xKeys.length !== yKeys.length) return false;
+
+  for (const key of xKeys) {
+    if (!Object.prototype.hasOwnProperty.call(y, key) || !deepEqual(x[key], y[key])) return false;
+  }
+
+  return true;
+}
+
 /**
  * Determines if the given parameter is a string.
  *
@@ -210,4 +247,5 @@ export {
   toBoolean,
   isValidUrl,
   dateAfterDays,
+  deepEqual,
 };

package/src/index.d.ts

@@ -39,6 +39,8 @@ export function isValidUrl(urlString: string): boolean;
 
 export function dateAfterDays(days: number, dateString: string): Date;
 
+export function deepEqual(a: unknown, b: unknown): boolean;
+
 export function sqsWrapper(fn: (message: object, context: object) => Promise<Response>):
   (request: object, context: object) => Promise<Response>;