@helpers4/object 2.0.0-alpha.3 → 2.0.0-alpha.6

package/lib/index.js

@@ -1,231 +1,270 @@
-// helpers/object/get.ts
-function get(obj, path, defaultValue) {
-  const keys = path.split(".");
-  let result = obj;
-  for (const key of keys) {
-    if (result == null || typeof result !== "object") {
-      return defaultValue;
-    }
-    result = result[key];
-  }
-  return result !== undefined ? result : defaultValue;
-}
-// helpers/object/set.ts
-function set(obj, path, value) {
-  const keys = path.split(".");
-  let current = obj;
-  for (let i = 0;i < keys.length - 1; i++) {
-    const key = keys[i];
-    if (!(key in current) || typeof current[key] !== "object" || current[key] === null) {
-      current[key] = {};
-    }
-    current = current[key];
-  }
-  current[keys[keys.length - 1]] = value;
-  return obj;
-}
-// helpers/object/quickCompare.ts
-function quickCompare(objA, objB) {
-  if (objA === objB) {
-    return true;
-  }
-  if (typeof objA === "function" || typeof objB === "function") {
-    return objA === objB;
-  }
-  try {
-    return JSON.stringify(objA) === JSON.stringify(objB);
-  } catch {
-    return objA === objB;
-  }
+import { isNullish } from "radashi";
+//#region helpers/object/deepClone.ts
+/**
+* This file is part of helpers4.
+* Copyright (C) 2025 baxyz
+* SPDX-License-Identifier: LGPL-3.0-or-later
+*/
+/**
+* Creates a deep copy of an object or array
+* @param obj - The object to clone
+* @returns Deep cloned object
+*/
+function deepClone(obj) {
+	if (obj === null || typeof obj !== "object") return obj;
+	if (obj instanceof Date) return new Date(obj.getTime());
+	if (Array.isArray(obj)) return obj.map((item) => deepClone(item));
+	const cloned = {};
+	for (const key in obj) if (obj.hasOwnProperty(key)) cloned[key] = deepClone(obj[key]);
+	return cloned;
 }
-// helpers/array/quickCompare.ts
-function quickCompare2(arrA, arrB) {
-  try {
-    return JSON.stringify(arrA) === JSON.stringify(arrB);
-  } catch {
-    return arrA === arrB;
-  }
+//#endregion
+//#region helpers/array/quickCompare.ts
+/**
+* This file is part of helpers4.
+* Copyright (C) 2025 baxyz
+* SPDX-License-Identifier: LGPL-3.0-or-later
+*/
+/**
+* Quick comparison of two arrays using JSON.stringify.
+* This is a fast but simple comparison that may not work for all edge cases.
+* 
+* @param arrA - First array to compare
+* @param arrB - Second array to compare
+* @returns `true` if arrays are identical according to JSON.stringify, `false` otherwise
+*/
+function quickCompare$1(arrA, arrB) {
+	try {
+		return JSON.stringify(arrA) === JSON.stringify(arrB);
+	} catch {
+		return arrA === arrB;
+	}
 }
-
-// helpers/date/compare.ts
+//#endregion
+//#region helpers/date/compare.ts
+/**
+* Comparison of two dates.
+* 
+* @param dateA - First date to compare
+* @param dateB - Second date to compare
+* @param options - Comparison options
+* @returns `true` if dates are identical according to the specified precision, `false` otherwise
+*/
 function compare(dateA, dateB, options = {}) {
-  const { precision = "milliseconds" } = options;
-  if (!(dateA instanceof Date) || !(dateB instanceof Date)) {
-    return dateA === dateB;
-  }
-  if (isNaN(dateA.getTime()) || isNaN(dateB.getTime())) {
-    return isNaN(dateA.getTime()) && isNaN(dateB.getTime());
-  }
-  switch (precision) {
-    case "days":
-      return dateA.toDateString() === dateB.toDateString();
-    case "hours":
-      const hoursA = Math.floor(dateA.getTime() / (1000 * 60 * 60));
-      const hoursB = Math.floor(dateB.getTime() / (1000 * 60 * 60));
-      return hoursA === hoursB;
-    case "minutes":
-      const minutesA = Math.floor(dateA.getTime() / (1000 * 60));
-      const minutesB = Math.floor(dateB.getTime() / (1000 * 60));
-      return minutesA === minutesB;
-    case "seconds":
-      const secondsA = Math.floor(dateA.getTime() / 1000);
-      const secondsB = Math.floor(dateB.getTime() / 1000);
-      return secondsA === secondsB;
-    case "milliseconds":
-    default:
-      return dateA.getTime() === dateB.getTime();
-  }
+	const { precision = "milliseconds" } = options;
+	if (!(dateA instanceof Date) || !(dateB instanceof Date)) return dateA === dateB;
+	if (isNaN(dateA.getTime()) || isNaN(dateB.getTime())) return isNaN(dateA.getTime()) && isNaN(dateB.getTime());
+	switch (precision) {
+		case "days": return dateA.toDateString() === dateB.toDateString();
+		case "hours": return Math.floor(dateA.getTime() / (1e3 * 60 * 60)) === Math.floor(dateB.getTime() / (1e3 * 60 * 60));
+		case "minutes": return Math.floor(dateA.getTime() / (1e3 * 60)) === Math.floor(dateB.getTime() / (1e3 * 60));
+		case "seconds": return Math.floor(dateA.getTime() / 1e3) === Math.floor(dateB.getTime() / 1e3);
+		default: return dateA.getTime() === dateB.getTime();
+	}
 }
-
-// helpers/type/isSpecialObject.ts
+//#endregion
+//#region helpers/type/isSpecialObject.ts
+/**
+* This file is part of helpers4.
+* Copyright (C) 2025 baxyz
+* SPDX-License-Identifier: LGPL-3.0-or-later
+*/
+/**
+* Determines if a value is a special object that should not have its properties compared deeply.
+* Special objects include: Date, Function, Promise, Observable, RegExp, Error, Map, Set, WeakMap, WeakSet, etc.
+* 
+* @param value - The value to check
+* @returns `true` if the value is a special object, `false` otherwise
+*/
 function isSpecialObject(value) {
-  if (value === null || value === undefined) {
-    return false;
-  }
-  if (typeof value === "function") {
-    return true;
-  }
-  if (typeof value !== "object") {
-    return false;
-  }
-  if (Array.isArray(value)) {
-    return false;
-  }
-  if (value instanceof Date || value instanceof Promise || value instanceof RegExp || value instanceof Error || value instanceof Map || value instanceof Set || value instanceof WeakMap || value instanceof WeakSet || value instanceof ArrayBuffer || value instanceof DataView) {
-    return true;
-  }
-  if (value.constructor?.name === "Observable") {
-    return true;
-  }
-  if (typeof HTMLElement !== "undefined" && value instanceof HTMLElement) {
-    return true;
-  }
-  const constructorName = value.constructor?.name;
-  if (constructorName && [
-    "Buffer",
-    "URL",
-    "URLSearchParams",
-    "File",
-    "Blob",
-    "FormData",
-    "Headers",
-    "Request",
-    "Response",
-    "EventTarget",
-    "Symbol"
-  ].includes(constructorName)) {
-    return true;
-  }
-  return false;
+	if (value === null || value === void 0) return false;
+	if (typeof value === "function") return true;
+	if (typeof value !== "object") return false;
+	if (Array.isArray(value)) return false;
+	if (value instanceof Date || value instanceof Promise || value instanceof RegExp || value instanceof Error || value instanceof Map || value instanceof Set || value instanceof WeakMap || value instanceof WeakSet || value instanceof ArrayBuffer || value instanceof DataView) return true;
+	if (value.constructor?.name === "Observable") return true;
+	if (typeof HTMLElement !== "undefined" && value instanceof HTMLElement) return true;
+	const constructorName = value.constructor?.name;
+	if (constructorName && [
+		"Buffer",
+		"URL",
+		"URLSearchParams",
+		"File",
+		"Blob",
+		"FormData",
+		"Headers",
+		"Request",
+		"Response",
+		"EventTarget",
+		"Symbol"
+	].includes(constructorName)) return true;
+	return false;
 }
-
-// helpers/object/deepCompare.ts
+//#endregion
+//#region helpers/object/deepCompare.ts
+/**
+* This file is part of helpers4.
+* Copyright (C) 2025 baxyz
+* SPDX-License-Identifier: LGPL-3.0-or-later
+*/
+/**
+* Deep comparison of two objects that returns detailed information about differences.
+* 
+* @param objA - First object to compare (can be object, undefined, or null)
+* @param objB - Second object to compare (can be object, undefined, or null)
+* @returns `true` if objects are identical, `false` if incompatible types, or a `DeepCompareResult` object detailing differences
+*/
 function deepCompare(objA, objB) {
-  if (objA === objB) {
-    return true;
-  }
-  if (objA == null || objB == null) {
-    return false;
-  }
-  if (objA instanceof Date && objB instanceof Date) {
-    return compare(objA, objB);
-  }
-  if (Array.isArray(objA) && Array.isArray(objB)) {
-    return quickCompare2(objA, objB);
-  }
-  if (Array.isArray(objA) || Array.isArray(objB)) {
-    return false;
-  }
-  if (isSpecialObject(objA) || isSpecialObject(objB)) {
-    return objA === objB;
-  }
-  const keys = Array.from(new Set([...Object.keys(objA), ...Object.keys(objB)]));
-  const differences = {};
-  for (const key of keys) {
-    const hasA = key in objA;
-    const hasB = key in objB;
-    if (!hasA && hasB) {
-      differences[key] = "onlyB";
-    } else if (hasA && !hasB) {
-      differences[key] = "onlyA";
-    } else if (hasA && hasB) {
-      const valueA = objA[key];
-      const valueB = objB[key];
-      if (Array.isArray(valueA) && Array.isArray(valueB)) {
-        if (!quickCompare2(valueA, valueB)) {
-          differences[key] = false;
-        }
-      } else if (valueA instanceof Date && valueB instanceof Date) {
-        if (!compare(valueA, valueB)) {
-          differences[key] = false;
-        }
-      } else if (isSpecialObject(valueA) || isSpecialObject(valueB)) {
-        if (valueA !== valueB) {
-          differences[key] = false;
-        }
-      } else if (valueA !== null && valueB !== null && valueA !== undefined && valueB !== undefined && typeof valueA === "object" && typeof valueB === "object" && !isSpecialObject(valueA) && !isSpecialObject(valueB)) {
-        const nestedResult = deepCompare(valueA, valueB);
-        if (nestedResult !== true) {
-          differences[key] = nestedResult === false ? false : nestedResult;
-        }
-      } else if (valueA !== valueB) {
-        differences[key] = false;
-      }
-    }
-  }
-  return Object.keys(differences).length > 0 ? differences : true;
+	if (objA === objB) return true;
+	if (objA == null || objB == null) return false;
+	if (objA instanceof Date && objB instanceof Date) return compare(objA, objB);
+	if (Array.isArray(objA) && Array.isArray(objB)) return quickCompare$1(objA, objB);
+	if (Array.isArray(objA) || Array.isArray(objB)) return false;
+	if (isSpecialObject(objA) || isSpecialObject(objB)) return objA === objB;
+	const keys = Array.from(new Set([...Object.keys(objA), ...Object.keys(objB)]));
+	const differences = {};
+	for (const key of keys) {
+		const hasA = key in objA;
+		const hasB = key in objB;
+		if (!hasA && hasB) differences[key] = "onlyB";
+		else if (hasA && !hasB) differences[key] = "onlyA";
+		else {
+			const valueA = objA[key];
+			const valueB = objB[key];
+			if (Array.isArray(valueA) && Array.isArray(valueB)) {
+				if (!quickCompare$1(valueA, valueB)) differences[key] = false;
+			} else if (valueA instanceof Date && valueB instanceof Date) {
+				if (!compare(valueA, valueB)) differences[key] = false;
+			} else if (isSpecialObject(valueA) || isSpecialObject(valueB)) {
+				if (valueA !== valueB) differences[key] = false;
+			} else if (valueA !== null && valueB !== null && valueA !== void 0 && valueB !== void 0 && typeof valueA === "object" && typeof valueB === "object" && !isSpecialObject(valueA) && !isSpecialObject(valueB)) {
+				const nestedResult = deepCompare(valueA, valueB);
+				if (nestedResult !== true) differences[key] = nestedResult === false ? false : nestedResult;
+			} else if (valueA !== valueB) differences[key] = false;
+		}
+	}
+	return Object.keys(differences).length > 0 ? differences : true;
 }
-// helpers/object/deepMerge.ts
+//#endregion
+//#region helpers/object/deepMerge.ts
+/**
+* This file is part of helpers4.
+* Copyright (C) 2025 baxyz
+* SPDX-License-Identifier: LGPL-3.0-or-later
+*/
+/**
+* Merges two or more objects deeply
+* @param target - The target object
+* @param sources - The source objects to merge
+* @returns The merged object
+*/
 function deepMerge(target, ...sources) {
-  if (!sources.length)
-    return target;
-  const source = sources.shift();
-  if (!source)
-    return deepMerge(target, ...sources);
-  for (const key in source) {
-    const targetValue = target[key];
-    const sourceValue = source[key];
-    if (isObject(targetValue) && isObject(sourceValue)) {
-      target[key] = deepMerge(targetValue, sourceValue);
-    } else if (sourceValue !== undefined) {
-      target[key] = sourceValue;
-    }
-  }
-  return deepMerge(target, ...sources);
+	if (!sources.length) return target;
+	const source = sources.shift();
+	if (!source) return deepMerge(target, ...sources);
+	for (const key in source) {
+		const targetValue = target[key];
+		const sourceValue = source[key];
+		if (isObject(targetValue) && isObject(sourceValue)) target[key] = deepMerge(targetValue, sourceValue);
+		else if (sourceValue !== void 0) target[key] = sourceValue;
+	}
+	return deepMerge(target, ...sources);
 }
 function isObject(item) {
-  return item && typeof item === "object" && !Array.isArray(item);
+	return item && typeof item === "object" && !Array.isArray(item);
 }
-// helpers/object/removeUndefinedNull.ts
-import { isNullish } from "radashi";
+//#endregion
+//#region helpers/object/get.ts
+/**
+* This file is part of helpers4.
+* Copyright (C) 2025 baxyz
+* SPDX-License-Identifier: LGPL-3.0-or-later
+*/
+/**
+* Gets a value from an object using a dot-notated path
+* @param obj - The object to get value from
+* @param path - The dot-notated path (e.g., 'a.b.c')
+* @param defaultValue - Default value if path doesn't exist
+* @returns The value at the path or default value
+*/
+function get(obj, path, defaultValue) {
+	const keys = path.split(".");
+	let result = obj;
+	for (const key of keys) {
+		if (result == null || typeof result !== "object") return defaultValue;
+		result = result[key];
+	}
+	return result !== void 0 ? result : defaultValue;
+}
+//#endregion
+//#region helpers/object/quickCompare.ts
+/**
+* This file is part of helpers4.
+* Copyright (C) 2025 baxyz
+* SPDX-License-Identifier: LGPL-3.0-or-later
+*/
+/**
+* Quick comparison of two objects using JSON.stringify.
+* This is a fast but simple comparison that may not work for all edge cases.
+*
+* @param objA - First object to compare
+* @param objB - Second object to compare
+* @returns `true` if objects are identical according to JSON.stringify, `false` otherwise
+*/
+function quickCompare(objA, objB) {
+	if (objA === objB) return true;
+	if (typeof objA === "function" || typeof objB === "function") return objA === objB;
+	try {
+		return JSON.stringify(objA) === JSON.stringify(objB);
+	} catch {
+		return objA === objB;
+	}
+}
+//#endregion
+//#region helpers/object/removeUndefinedNull.ts
+/**
+* This file is part of helpers4.
+* Copyright (C) 2025 baxyz
+* SPDX-License-Identifier: LGPL-3.0-or-later
+*/
+/**
+* Remove null and undefined values from an object.
+*
+* @param obj an object
+* @returns A shallow copy of the object without null or undefined values
+*/
 function removeUndefinedNull(obj) {
-  return obj ? Object.entries(obj).filter(([_, v]) => !isNullish(v)).reduce((acc, [k, v]) => ({ ...acc, [k]: v }), {}) : obj;
+	return obj ? Object.entries(obj).filter(([_, v]) => !isNullish(v)).reduce((acc, [k, v]) => ({
+		...acc,
+		[k]: v
+	}), {}) : obj;
 }
-// helpers/object/deepClone.ts
-function deepClone(obj) {
-  if (obj === null || typeof obj !== "object") {
-    return obj;
-  }
-  if (obj instanceof Date) {
-    return new Date(obj.getTime());
-  }
-  if (Array.isArray(obj)) {
-    return obj.map((item) => deepClone(item));
-  }
-  const cloned = {};
-  for (const key in obj) {
-    if (obj.hasOwnProperty(key)) {
-      cloned[key] = deepClone(obj[key]);
-    }
-  }
-  return cloned;
+//#endregion
+//#region helpers/object/set.ts
+/**
+* This file is part of helpers4.
+* Copyright (C) 2025 baxyz
+* SPDX-License-Identifier: LGPL-3.0-or-later
+*/
+/**
+* Sets a value in an object using a dot-notated path
+* @param obj - The object to set value in
+* @param path - The dot-notated path (e.g., 'a.b.c')
+* @param value - The value to set
+* @returns The modified object
+*/
+function set(obj, path, value) {
+	const keys = path.split(".");
+	let current = obj;
+	for (let i = 0; i < keys.length - 1; i++) {
+		const key = keys[i];
+		if (!(key in current) || typeof current[key] !== "object" || current[key] === null) current[key] = {};
+		current = current[key];
+	}
+	current[keys[keys.length - 1]] = value;
+	return obj;
 }
-export {
-  set,
-  removeUndefinedNull,
-  quickCompare,
-  get,
-  deepMerge,
-  deepCompare,
-  deepClone
-};
+//#endregion
+export { deepClone, deepCompare, deepMerge, get, quickCompare, removeUndefinedNull, set };
+
+//# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","names":[],"sources":["../../../helpers/object/deepClone.ts","../../../helpers/array/quickCompare.ts","../../../helpers/date/compare.ts","../../../helpers/type/isSpecialObject.ts","../../../helpers/object/deepCompare.ts","../../../helpers/object/deepMerge.ts","../../../helpers/object/get.ts","../../../helpers/object/quickCompare.ts","../../../helpers/object/removeUndefinedNull.ts","../../../helpers/object/set.ts"],"sourcesContent":["/**\n * This file is part of helpers4.\n * Copyright (C) 2025 baxyz\n * SPDX-License-Identifier: LGPL-3.0-or-later\n */\n\n/**\n * Creates a deep copy of an object or array\n * @param obj - The object to clone\n * @returns Deep cloned object\n */\nexport function deepClone<T>(obj: T): T {\n  if (obj === null || typeof obj !== \"object\") {\n    return obj;\n  }\n\n  if (obj instanceof Date) {\n    return new Date(obj.getTime()) as T;\n  }\n\n  if (Array.isArray(obj)) {\n    return obj.map(item => deepClone(item)) as T;\n  }\n\n  const cloned = {} as T;\n  for (const key in obj) {\n    if (obj.hasOwnProperty(key)) {\n      cloned[key] = deepClone(obj[key]);\n    }\n  }\n\n  return cloned;\n}\n","/**\n * This file is part of helpers4.\n * Copyright (C) 2025 baxyz\n * SPDX-License-Identifier: LGPL-3.0-or-later\n */\n\n/**\n * Quick comparison of two arrays using JSON.stringify.\n * This is a fast but simple comparison that may not work for all edge cases.\n * \n * @param arrA - First array to compare\n * @param arrB - Second array to compare\n * @returns `true` if arrays are identical according to JSON.stringify, `false` otherwise\n */\nexport function quickCompare<T>(arrA: T[], arrB: T[]): boolean {\n  try {\n    return JSON.stringify(arrA) === JSON.stringify(arrB);\n  } catch {\n    // If JSON.stringify fails (e.g., circular references), fall back to reference equality\n    return arrA === arrB;\n  }\n}\n","/**\n * This file is part of helpers4.\n * Copyright (C) 2025 baxyz\n * SPDX-License-Identifier: LGPL-3.0-or-later\n */\n\n/**\n * Options for date comparison\n */\nexport interface DateCompareOptions {\n  /** \n   * Comparison precision\n   * - 'milliseconds': Compare all including milliseconds (default)\n   * - 'seconds': Ignore milliseconds, compare to the second\n   * - 'minutes': Ignore seconds and milliseconds, compare to the minute\n   * - 'hours': Ignore minutes, seconds and milliseconds, compare to the hour\n   * - 'days': Compare only the date part (ignore time completely)\n   */\n  precision?: 'milliseconds' | 'seconds' | 'minutes' | 'hours' | 'days';\n}\n\n/**\n * Comparison of two dates.\n * \n * @param dateA - First date to compare\n * @param dateB - Second date to compare\n * @param options - Comparison options\n * @returns `true` if dates are identical according to the specified precision, `false` otherwise\n */\nexport function compare(dateA: Date, dateB: Date, options: DateCompareOptions = {}): boolean {\n  const { precision = 'milliseconds' } = options;\n\n  if (!(dateA instanceof Date) || !(dateB instanceof Date)) {\n    return dateA === dateB;\n  }\n\n  // Handle invalid dates\n  if (isNaN(dateA.getTime()) || isNaN(dateB.getTime())) {\n    return isNaN(dateA.getTime()) && isNaN(dateB.getTime());\n  }\n\n  switch (precision) {\n    case 'days':\n      return dateA.toDateString() === dateB.toDateString();\n\n    case 'hours':\n      const hoursA = Math.floor(dateA.getTime() / (1000 * 60 * 60));\n      const hoursB = Math.floor(dateB.getTime() / (1000 * 60 * 60));\n      return hoursA === hoursB;\n\n    case 'minutes':\n      const minutesA = Math.floor(dateA.getTime() / (1000 * 60));\n      const minutesB = Math.floor(dateB.getTime() / (1000 * 60));\n      return minutesA === minutesB;\n\n    case 'seconds':\n      const secondsA = Math.floor(dateA.getTime() / 1000);\n      const secondsB = Math.floor(dateB.getTime() / 1000);\n      return secondsA === secondsB;\n\n    case 'milliseconds':\n    default:\n      return dateA.getTime() === dateB.getTime();\n  }\n}\n","/**\n * This file is part of helpers4.\n * Copyright (C) 2025 baxyz\n * SPDX-License-Identifier: LGPL-3.0-or-later\n */\n\n/**\n * Determines if a value is a special object that should not have its properties compared deeply.\n * Special objects include: Date, Function, Promise, Observable, RegExp, Error, Map, Set, WeakMap, WeakSet, etc.\n * \n * @param value - The value to check\n * @returns `true` if the value is a special object, `false` otherwise\n */\nexport function isSpecialObject(value: unknown): boolean {\n  if (value === null || value === undefined) {\n    return false;\n  }\n\n  // Functions are special objects\n  if (typeof value === 'function') {\n    return true;\n  }\n\n  // Non-objects are not special\n  if (typeof value !== 'object') {\n    return false;\n  }\n\n  // Arrays are not considered special objects for our purposes\n  if (Array.isArray(value)) {\n    return false;\n  }\n\n  // Check for built-in special objects\n  if (\n    value instanceof Date ||\n    value instanceof Promise ||\n    value instanceof RegExp ||\n    value instanceof Error ||\n    value instanceof Map ||\n    value instanceof Set ||\n    value instanceof WeakMap ||\n    value instanceof WeakSet ||\n    value instanceof ArrayBuffer ||\n    value instanceof DataView\n  ) {\n    return true;\n  }\n\n  // Check for Observable (RxJS or similar)\n  if (value.constructor?.name === 'Observable') {\n    return true;\n  }\n\n  // Check for DOM elements (if in browser environment)\n  if (typeof HTMLElement !== 'undefined' && value instanceof HTMLElement) {\n    return true;\n  }\n\n  // Check for other built-in types by constructor name\n  const constructorName = value.constructor?.name;\n  if (constructorName && [\n    'Buffer',       // Node.js Buffer\n    'URL',          // Web URL API\n    'URLSearchParams',\n    'File',         // Web File API\n    'Blob',         // Web Blob API\n    'FormData',     // Web FormData API\n    'Headers',      // Web Headers API\n    'Request',      // Web Request API\n    'Response',     // Web Response API\n    'EventTarget',  // Web EventTarget API\n    'Symbol'        // Symbol objects\n  ].includes(constructorName)) {\n    return true;\n  }\n\n  return false;\n}\n","/**\n * This file is part of helpers4.\n * Copyright (C) 2025 baxyz\n * SPDX-License-Identifier: LGPL-3.0-or-later\n */\n\nimport { quickCompare as quickCompareArray } from '../array/quickCompare';\nimport { compare as compareDate } from '../date/compare';\nimport { isSpecialObject } from '../type/isSpecialObject';\n\n/**\n * Result type for deep comparison when objects are not identical\n */\nexport interface DeepCompareResult {\n  [key: string]: \"onlyA\" | \"onlyB\" | false | DeepCompareResult;\n}\n\n/**\n * Deep comparison of two objects that returns detailed information about differences.\n * \n * @param objA - First object to compare (can be object, undefined, or null)\n * @param objB - Second object to compare (can be object, undefined, or null)\n * @returns `true` if objects are identical, `false` if incompatible types, or a `DeepCompareResult` object detailing differences\n */\nexport function deepCompare(objA: object | undefined | null, objB: object | undefined | null): true | false | DeepCompareResult {\n  // Quick reference equality check\n  if (objA === objB) {\n    return true;\n  }\n\n  // Handle null/undefined cases\n  if (objA == null || objB == null) {\n    return false;\n  }\n\n  // Handle Date objects\n  if (objA instanceof Date && objB instanceof Date) {\n    return compareDate(objA, objB);\n  }\n\n  // Handle Arrays at root level - use quickCompare\n  if (Array.isArray(objA) && Array.isArray(objB)) {\n    return quickCompareArray(objA, objB);\n  }\n\n  // If one is array and other is not\n  if (Array.isArray(objA) || Array.isArray(objB)) {\n    return false;\n  }\n\n  // Handle special objects - compare by reference only\n  if (isSpecialObject(objA) || isSpecialObject(objB)) {\n    return objA === objB;\n  }\n\n  // Handle objects - detailed comparison\n  const keys = Array.from(new Set([...Object.keys(objA), ...Object.keys(objB)]));\n\n  const differences: DeepCompareResult = {};\n\n  for (const key of keys) {\n    const hasA = key in objA;\n    const hasB = key in objB;\n\n    if (!hasA && hasB) {\n      differences[key] = \"onlyB\";\n    } else if (hasA && !hasB) {\n      differences[key] = \"onlyA\";\n    } else {\n      // Both objects have this key - compare values\n      const valueA = (objA as any)[key];\n      const valueB = (objB as any)[key];\n\n      // For arrays, use quickCompare\n      if (Array.isArray(valueA) && Array.isArray(valueB)) {\n        if (!quickCompareArray(valueA, valueB)) {\n          differences[key] = false;\n        }\n      }\n      // For dates, use compareDate\n      else if (valueA instanceof Date && valueB instanceof Date) {\n        if (!compareDate(valueA, valueB)) {\n          differences[key] = false;\n        }\n      }\n      // For special objects, compare by reference only\n      else if (isSpecialObject(valueA) || isSpecialObject(valueB)) {\n        if (valueA !== valueB) {\n          differences[key] = false;\n        }\n      }\n      // For objects, recurse (only plain objects now)\n      else if (\n        valueA !== null && valueB !== null &&\n        valueA !== undefined && valueB !== undefined &&\n        typeof valueA === 'object' && typeof valueB === 'object' &&\n        !isSpecialObject(valueA) && !isSpecialObject(valueB)\n      ) {\n        const nestedResult = deepCompare(valueA, valueB);\n        if (nestedResult !== true) {\n          differences[key] = nestedResult === false ? false : nestedResult;\n        }\n      }\n      // For primitives and other types, check equality\n      else if (valueA !== valueB) {\n        differences[key] = false;\n      }\n    }\n  }\n\n  return Object.keys(differences).length > 0 ? differences : true;\n}\n","/**\n * This file is part of helpers4.\n * Copyright (C) 2025 baxyz\n * SPDX-License-Identifier: LGPL-3.0-or-later\n */\n\n/**\n * Merges two or more objects deeply\n * @param target - The target object\n * @param sources - The source objects to merge\n * @returns The merged object\n */\nexport function deepMerge<T extends Record<string, any>>(target: T, ...sources: Record<string, any>[]): T {\n  if (!sources.length) return target;\n  const source = sources.shift();\n\n  if (!source) return deepMerge(target, ...sources);\n\n  for (const key in source) {\n    const targetValue = target[key];\n    const sourceValue = source[key];\n\n    if (isObject(targetValue) && isObject(sourceValue)) {\n      (target as any)[key] = deepMerge(targetValue, sourceValue);\n    } else if (sourceValue !== undefined) {\n      (target as any)[key] = sourceValue;\n    }\n  }\n\n  return deepMerge(target, ...sources);\n}\n\nfunction isObject(item: any): item is object {\n  return item && typeof item === 'object' && !Array.isArray(item);\n}\n","/**\n * This file is part of helpers4.\n * Copyright (C) 2025 baxyz\n * SPDX-License-Identifier: LGPL-3.0-or-later\n */\n\n/**\n * Gets a value from an object using a dot-notated path\n * @param obj - The object to get value from\n * @param path - The dot-notated path (e.g., 'a.b.c')\n * @param defaultValue - Default value if path doesn't exist\n * @returns The value at the path or default value\n */\nexport function get<T = any>(obj: any, path: string, defaultValue?: T): T | undefined {\n  const keys = path.split('.');\n  let result = obj;\n\n  for (const key of keys) {\n    if (result == null || typeof result !== 'object') {\n      return defaultValue;\n    }\n    result = result[key];\n  }\n\n  return result !== undefined ? result : defaultValue;\n}\n","/**\n * This file is part of helpers4.\n * Copyright (C) 2025 baxyz\n * SPDX-License-Identifier: LGPL-3.0-or-later\n */\n\n/**\n * Quick comparison of two objects using JSON.stringify.\n * This is a fast but simple comparison that may not work for all edge cases.\n *\n * @param objA - First object to compare\n * @param objB - Second object to compare\n * @returns `true` if objects are identical according to JSON.stringify, `false` otherwise\n */\nexport function quickCompare(objA: unknown, objB: unknown): boolean {\n  // Quick reference equality check\n  if (objA === objB) {\n    return true;\n  }\n\n  // Handle functions - they can't be JSON.stringified reliably\n  if (typeof objA === 'function' || typeof objB === 'function') {\n    return objA === objB;\n  }\n\n  try {\n    return JSON.stringify(objA) === JSON.stringify(objB);\n  } catch {\n    // If JSON.stringify fails (e.g., circular references), fall back to basic comparison\n    return objA === objB;\n  }\n}\n","/**\n * This file is part of helpers4.\n * Copyright (C) 2025 baxyz\n * SPDX-License-Identifier: LGPL-3.0-or-later\n */\n\nimport { isNullish } from \"radashi\";\n\n/**\n * Remove null and undefined values from an object.\n *\n * @param obj an object\n * @returns A shallow copy of the object without null or undefined values\n */\nexport function removeUndefinedNull<T extends Record<string, string | number | boolean | null | undefined>>(obj: T): Partial<T>;\n\n/**\n * Remove null and undefined values from an object.\n *\n * @param obj a null object\n * @returns null\n */\nexport function removeUndefinedNull(obj: null): null;\n\n/**\n * Remove null and undefined values from an object.\n *\n * @param obj an undefined object\n * @returns undefined\n */\nexport function removeUndefinedNull(obj: undefined): undefined;\n\n/**\n * Remove null and undefined values from an object.\n *\n * @param obj an object\n * @returns A shallow copy of the object without null or undefined values\n */\nexport function removeUndefinedNull<T extends Record<string, string | number | boolean | null | undefined>>(obj: T | null | undefined): Partial<T> | null | undefined {\n  return obj ? Object.entries(obj)\n    .filter(([_, v]) => !isNullish(v))\n    .reduce((acc, [k, v]) => ({ ...acc, [k]: v }), {} as Partial<T>) : obj;\n}\n\n","/**\n * This file is part of helpers4.\n * Copyright (C) 2025 baxyz\n * SPDX-License-Identifier: LGPL-3.0-or-later\n */\n\n/**\n * Sets a value in an object using a dot-notated path\n * @param obj - The object to set value in\n * @param path - The dot-notated path (e.g., 'a.b.c')\n * @param value - The value to set\n * @returns The modified object\n */\nexport function set(obj: Record<string, any>, path: string, value: any): Record<string, any> {\n  const keys = path.split('.');\n  let current = obj;\n\n  for (let i = 0; i < keys.length - 1; i++) {\n    const key = keys[i];\n\n    if (!(key in current) || typeof current[key] !== 'object' || current[key] === null) {\n      current[key] = {};\n    }\n\n    current = current[key];\n  }\n\n  current[keys[keys.length - 1]] = value;\n  return obj;\n}\n"],"mappings":";;;;;;;;;;;;AAWA,SAAgB,UAAa,KAAW;AACtC,KAAI,QAAQ,QAAQ,OAAO,QAAQ,SACjC,QAAO;AAGT,KAAI,eAAe,KACjB,QAAO,IAAI,KAAK,IAAI,SAAS,CAAC;AAGhC,KAAI,MAAM,QAAQ,IAAI,CACpB,QAAO,IAAI,KAAI,SAAQ,UAAU,KAAK,CAAC;CAGzC,MAAM,SAAS,EAAE;AACjB,MAAK,MAAM,OAAO,IAChB,KAAI,IAAI,eAAe,IAAI,CACzB,QAAO,OAAO,UAAU,IAAI,KAAK;AAIrC,QAAO;;;;;;;;;;;;;;;;;ACjBT,SAAgB,eAAgB,MAAW,MAAoB;AAC7D,KAAI;AACF,SAAO,KAAK,UAAU,KAAK,KAAK,KAAK,UAAU,KAAK;SAC9C;AAEN,SAAO,SAAS;;;;;;;;;;;;;ACUpB,SAAgB,QAAQ,OAAa,OAAa,UAA8B,EAAE,EAAW;CAC3F,MAAM,EAAE,YAAY,mBAAmB;AAEvC,KAAI,EAAE,iBAAiB,SAAS,EAAE,iBAAiB,MACjD,QAAO,UAAU;AAInB,KAAI,MAAM,MAAM,SAAS,CAAC,IAAI,MAAM,MAAM,SAAS,CAAC,CAClD,QAAO,MAAM,MAAM,SAAS,CAAC,IAAI,MAAM,MAAM,SAAS,CAAC;AAGzD,SAAQ,WAAR;EACE,KAAK,OACH,QAAO,MAAM,cAAc,KAAK,MAAM,cAAc;EAEtD,KAAK,QAGH,QAFe,KAAK,MAAM,MAAM,SAAS,IAAI,MAAO,KAAK,IAAI,KAC9C,KAAK,MAAM,MAAM,SAAS,IAAI,MAAO,KAAK,IAAI;EAG/D,KAAK,UAGH,QAFiB,KAAK,MAAM,MAAM,SAAS,IAAI,MAAO,IAAI,KACzC,KAAK,MAAM,MAAM,SAAS,IAAI,MAAO,IAAI;EAG5D,KAAK,UAGH,QAFiB,KAAK,MAAM,MAAM,SAAS,GAAG,IAAK,KAClC,KAAK,MAAM,MAAM,SAAS,GAAG,IAAK;EAIrD,QACE,QAAO,MAAM,SAAS,KAAK,MAAM,SAAS;;;;;;;;;;;;;;;;;ACjDhD,SAAgB,gBAAgB,OAAyB;AACvD,KAAI,UAAU,QAAQ,UAAU,KAAA,EAC9B,QAAO;AAIT,KAAI,OAAO,UAAU,WACnB,QAAO;AAIT,KAAI,OAAO,UAAU,SACnB,QAAO;AAIT,KAAI,MAAM,QAAQ,MAAM,CACtB,QAAO;AAIT,KACE,iBAAiB,QACjB,iBAAiB,WACjB,iBAAiB,UACjB,iBAAiB,SACjB,iBAAiB,OACjB,iBAAiB,OACjB,iBAAiB,WACjB,iBAAiB,WACjB,iBAAiB,eACjB,iBAAiB,SAEjB,QAAO;AAIT,KAAI,MAAM,aAAa,SAAS,aAC9B,QAAO;AAIT,KAAI,OAAO,gBAAgB,eAAe,iBAAiB,YACzD,QAAO;CAIT,MAAM,kBAAkB,MAAM,aAAa;AAC3C,KAAI,mBAAmB;EACrB;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACD,CAAC,SAAS,gBAAgB,CACzB,QAAO;AAGT,QAAO;;;;;;;;;;;;;;;;ACrDT,SAAgB,YAAY,MAAiC,MAAmE;AAE9H,KAAI,SAAS,KACX,QAAO;AAIT,KAAI,QAAQ,QAAQ,QAAQ,KAC1B,QAAO;AAIT,KAAI,gBAAgB,QAAQ,gBAAgB,KAC1C,QAAO,QAAY,MAAM,KAAK;AAIhC,KAAI,MAAM,QAAQ,KAAK,IAAI,MAAM,QAAQ,KAAK,CAC5C,QAAO,eAAkB,MAAM,KAAK;AAItC,KAAI,MAAM,QAAQ,KAAK,IAAI,MAAM,QAAQ,KAAK,CAC5C,QAAO;AAIT,KAAI,gBAAgB,KAAK,IAAI,gBAAgB,KAAK,CAChD,QAAO,SAAS;CAIlB,MAAM,OAAO,MAAM,KAAK,IAAI,IAAI,CAAC,GAAG,OAAO,KAAK,KAAK,EAAE,GAAG,OAAO,KAAK,KAAK,CAAC,CAAC,CAAC;CAE9E,MAAM,cAAiC,EAAE;AAEzC,MAAK,MAAM,OAAO,MAAM;EACtB,MAAM,OAAO,OAAO;EACpB,MAAM,OAAO,OAAO;AAEpB,MAAI,CAAC,QAAQ,KACX,aAAY,OAAO;WACV,QAAQ,CAAC,KAClB,aAAY,OAAO;OACd;GAEL,MAAM,SAAU,KAAa;GAC7B,MAAM,SAAU,KAAa;AAG7B,OAAI,MAAM,QAAQ,OAAO,IAAI,MAAM,QAAQ,OAAO;QAC5C,CAAC,eAAkB,QAAQ,OAAO,CACpC,aAAY,OAAO;cAId,kBAAkB,QAAQ,kBAAkB;QAC/C,CAAC,QAAY,QAAQ,OAAO,CAC9B,aAAY,OAAO;cAId,gBAAgB,OAAO,IAAI,gBAAgB,OAAO;QACrD,WAAW,OACb,aAAY,OAAO;cAKrB,WAAW,QAAQ,WAAW,QAC9B,WAAW,KAAA,KAAa,WAAW,KAAA,KACnC,OAAO,WAAW,YAAY,OAAO,WAAW,YAChD,CAAC,gBAAgB,OAAO,IAAI,CAAC,gBAAgB,OAAO,EACpD;IACA,MAAM,eAAe,YAAY,QAAQ,OAAO;AAChD,QAAI,iBAAiB,KACnB,aAAY,OAAO,iBAAiB,QAAQ,QAAQ;cAI/C,WAAW,OAClB,aAAY,OAAO;;;AAKzB,QAAO,OAAO,KAAK,YAAY,CAAC,SAAS,IAAI,cAAc;;;;;;;;;;;;;;;AClG7D,SAAgB,UAAyC,QAAW,GAAG,SAAmC;AACxG,KAAI,CAAC,QAAQ,OAAQ,QAAO;CAC5B,MAAM,SAAS,QAAQ,OAAO;AAE9B,KAAI,CAAC,OAAQ,QAAO,UAAU,QAAQ,GAAG,QAAQ;AAEjD,MAAK,MAAM,OAAO,QAAQ;EACxB,MAAM,cAAc,OAAO;EAC3B,MAAM,cAAc,OAAO;AAE3B,MAAI,SAAS,YAAY,IAAI,SAAS,YAAY,CAC/C,QAAe,OAAO,UAAU,aAAa,YAAY;WACjD,gBAAgB,KAAA,EACxB,QAAe,OAAO;;AAI3B,QAAO,UAAU,QAAQ,GAAG,QAAQ;;AAGtC,SAAS,SAAS,MAA2B;AAC3C,QAAO,QAAQ,OAAO,SAAS,YAAY,CAAC,MAAM,QAAQ,KAAK;;;;;;;;;;;;;;;;ACpBjE,SAAgB,IAAa,KAAU,MAAc,cAAiC;CACpF,MAAM,OAAO,KAAK,MAAM,IAAI;CAC5B,IAAI,SAAS;AAEb,MAAK,MAAM,OAAO,MAAM;AACtB,MAAI,UAAU,QAAQ,OAAO,WAAW,SACtC,QAAO;AAET,WAAS,OAAO;;AAGlB,QAAO,WAAW,KAAA,IAAY,SAAS;;;;;;;;;;;;;;;;;ACVzC,SAAgB,aAAa,MAAe,MAAwB;AAElE,KAAI,SAAS,KACX,QAAO;AAIT,KAAI,OAAO,SAAS,cAAc,OAAO,SAAS,WAChD,QAAO,SAAS;AAGlB,KAAI;AACF,SAAO,KAAK,UAAU,KAAK,KAAK,KAAK,UAAU,KAAK;SAC9C;AAEN,SAAO,SAAS;;;;;;;;;;;;;;;;ACSpB,SAAgB,oBAA4F,KAA0D;AACpK,QAAO,MAAM,OAAO,QAAQ,IAAI,CAC7B,QAAQ,CAAC,GAAG,OAAO,CAAC,UAAU,EAAE,CAAC,CACjC,QAAQ,KAAK,CAAC,GAAG,QAAQ;EAAE,GAAG;GAAM,IAAI;EAAG,GAAG,EAAE,CAAe,GAAG;;;;;;;;;;;;;;;;AC5BvE,SAAgB,IAAI,KAA0B,MAAc,OAAiC;CAC3F,MAAM,OAAO,KAAK,MAAM,IAAI;CAC5B,IAAI,UAAU;AAEd,MAAK,IAAI,IAAI,GAAG,IAAI,KAAK,SAAS,GAAG,KAAK;EACxC,MAAM,MAAM,KAAK;AAEjB,MAAI,EAAE,OAAO,YAAY,OAAO,QAAQ,SAAS,YAAY,QAAQ,SAAS,KAC5E,SAAQ,OAAO,EAAE;AAGnB,YAAU,QAAQ;;AAGpB,SAAQ,KAAK,KAAK,SAAS,MAAM;AACjC,QAAO"}

package/package.json

@@ -1,42 +1,51 @@
 {
   "name": "@helpers4/object",
-  "version": "2.0.0-alpha.3",
+  "version": "2.0.0-alpha.6",
   "description": "A set of helpers in TS/JS, compatible with tree-shaking, for object.",
   "author": "baxyz <baxy@etik.com>",
-  "license": "AGPL-3.0",
+  "license": "LGPL-3.0",
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/helpers4/helpers4.git"
+    "url": "git+https://github.com/helpers4/typescript.git"
   },
   "type": "module",
+  "sideEffects": false,
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
   "exports": {
     ".": {
       "types": "./lib/index.d.ts",
       "import": "./lib/index.js"
-    }
+    },
+    "./examples.json": "./examples.json",
+    "./api.json": "./api.json",
+    "./package.json": "./package.json"
   },
   "keywords": [
     "helpers",
     "object",
-    "get",
-    "set",
-    "quickCompare",
+    "deepClone",
     "deepCompare",
     "deepMerge",
+    "get",
+    "quickCompare",
     "removeUndefinedNull",
-    "deepClone"
+    "set"
   ],
   "files": [
     "lib/index.js",
     "lib/index.d.ts",
     "lib/index.js.map",
+    "examples.json",
+    "api.json",
     "LICENSE.md",
     "package.json",
     "README.md"
   ],
+  "engines": {
+    "node": ">=18.0.0"
+  },
   "peerDependencies": {
-    "radashi": "^12.4.0"
+    "radashi": "^12.7.2"
   }
-}
+}