@wavy/fn 0.0.36 → 0.0.39

package/dist/main.cjs

@@ -20,6 +20,7 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 // src/main.ts
 var main_exports = {};
 __export(main_exports, {
+  TODO: () => TODO,
   addArticle: () => addArticle,
   arrayEquals: () => arrayEquals,
   arrayWithConst: () => arrayWithConst,
@@ -48,7 +49,6 @@ __export(main_exports, {
   getFileExt: () => getFileExt,
   getFilename: () => getFilename,
   getMimeTypes: () => getMimeTypes,
-  getObjectValue: () => getObjectValue,
   group: () => group,
   hasIndex: () => hasIndex,
   ifDefined: () => ifDefined,
@@ -104,6 +104,7 @@ __export(main_exports, {
   timeDuration: () => timeDuration,
   toNumber: () => toNumber,
   toObject: () => ObjectConverter_default,
+  traverse: () => traverse,
   trimString: () => trimString,
   undefinedIfEmpty: () => undefinedIfEmpty,
   upperFirst: () => upperFirst,
@@ -595,6 +596,9 @@ function format(event, ...args) {
       return event;
   }
 }
+function TODO(message) {
+  throw new Error(`Todo: ${message}`);
+}
 function isFile(value) {
   const requiredKeys = [
     "name",
@@ -616,7 +620,7 @@ function isFileDetails(value) {
     return false;
   }
 }
-function getObjectValue(obj, path) {
+function traverse(obj, path) {
   const pathArr = path.split(".");
   return pathArr.reduce((currentObj, key) => {
     return currentObj?.[key];
@@ -625,12 +629,19 @@ function getObjectValue(obj, path) {
 function findObjectChanges(source, compareTo, options) {
   let entries = Object.entries(source);
   const changes = Object.keys(compareTo).filter(
-    (key) => !entries.some(([sourceKey]) => sourceKey === key)
+    (key) => !options?.ignoredKeys?.includes(key) && !entries.some(([sourceKey]) => sourceKey === key)
   );
+  const ignoreDepth = options?.ignoreDepth === "max" ? Infinity : Math.abs(options?.ignoreDepth || 0);
+  const isKeyIgnored = (key) => {
+    return key.split(".").some(
+      (key2, idx) => idx <= ignoreDepth && options?.ignoredKeys?.includes(key2)
+    );
+  };
   for (let idx = 0; idx < entries.length; idx++) {
     const [key, value] = entries[idx];
-    const comparedValue = getObjectValue(compareTo, key);
+    const comparedValue = traverse(compareTo, key);
     const checkArrayEquality = options?.strict ? strictArrayEquals : arrayEquals;
+    if (isKeyIgnored(key)) continue;
     if (Array.isArray(value) && Array.isArray(comparedValue) && !checkArrayEquality(value, comparedValue)) {
       changes.push(key);
     } else if (!!value && !!comparedValue && typeof value === "object" && typeof comparedValue === "object") {
@@ -640,6 +651,9 @@ function findObjectChanges(source, compareTo, options) {
           return [path, nestedValue];
         }
       );
+      const newCompareTo = traverse(compareTo, key);
+      const nonExistentKeys = Object.keys(newCompareTo).filter((key2) => !isKeyIgnored(key2) && !(key2 in value)).map((nestedKey) => [key, nestedKey].join("."));
+      changes.push(...nonExistentKeys);
       entries.push(...newEntries);
     } else if (JSON.stringify(value) !== JSON.stringify(comparedValue)) {
       changes.push(key);
@@ -647,18 +661,18 @@ function findObjectChanges(source, compareTo, options) {
   }
   return changes;
 }
-function findChanges(source, compareTo) {
+function findChanges(source, compareTo, options) {
   if (Array.isArray(source) && Array.isArray(compareTo)) {
     const changes = [];
     for (let idx = 0; idx < source.length; idx++) {
-      const _changes = findObjectChanges(source[idx], compareTo[idx]);
+      const _changes = findObjectChanges(source[idx], compareTo[idx], options);
       if (_changes.length > 0) {
         changes.push({ keys: _changes, index: idx });
       }
     }
     return changes;
   } else if (typeof source === "object" && typeof compareTo === "object") {
-    return findObjectChanges(source, compareTo);
+    return findObjectChanges(source, compareTo, options);
   }
   return [];
 }
@@ -1101,6 +1115,7 @@ function arrayWithConst(array) {
 }
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
+  TODO,
   addArticle,
   arrayEquals,
   arrayWithConst,
@@ -1129,7 +1144,6 @@ function arrayWithConst(array) {
   getFileExt,
   getFilename,
   getMimeTypes,
-  getObjectValue,
   group,
   hasIndex,
   ifDefined,
@@ -1185,6 +1199,7 @@ function arrayWithConst(array) {
   timeDuration,
   toNumber,
   toObject,
+  traverse,
   trimString,
   undefinedIfEmpty,
   upperFirst,

package/dist/main.d.cts

@@ -82,13 +82,22 @@ declare const toMoney: (value: string | number, options?: NumberFormatterTypes["
  * @example parseDate, parseMoney, parseName, parseAddress, parseFileSize
  */
 declare function format<Event extends "date" | "money" | "name" | "address" | "file-size">(event: Event, ...args: Event extends "date" ? Parameters<typeof dateFormat> : Event extends "money" ? Parameters<typeof toMoney> : Event extends "name" ? Parameters<typeof nameToString> : Event extends "address" ? Parameters<typeof addressToString> : Event extends "file-size" ? [bytes: number] : never): Event extends "date" | "money" | "name" | "address" | "file-size" ? string : never;
+declare function TODO(message: string): void;
 declare function isFile(value: unknown): value is File;
 declare function isFileDetails(value: unknown): value is FileDetails;
-declare function getObjectValue(obj: object, path: string): object;
+declare function traverse(obj: object, path: string): object;
 declare function findObjectChanges<T extends object>(source: T, compareTo: T, options?: Partial<{
     strict: boolean;
+    ignoredKeys: (keyof T | (string & {}))[];
+    /**
+     * How deep the ignoredKeys should be applied.
+     *
+     * @default 0 */
+    ignoreDepth: "max" | number;
 }>): string[];
-declare function findChanges<T extends object | object[]>(source: T, compareTo: T): T extends object[] ? {
+declare function findChanges<T extends object | object[]>(source: T, compareTo: T, options?: Parameters<typeof findObjectChanges>["2"] & {
+    ignoredKeys?: T extends any[] ? (keyof T[number] | (string & {}))[] : T extends object ? (keyof T | (string & {}))[] : never;
+}): T extends object[] ? {
     keys: string[];
     index: number;
 }[] : T extends object ? string[] : never;
@@ -227,4 +236,4 @@ declare function arrayWithConst<T>(array: T[]): {
     asConst: readonly T[];
 };
 
-export { addArticle, arrayEquals, arrayWithConst, asyncRun, averageOf, blankSpaces, buildArray, camelCaseToLetter, castArray, castReturn, classNameExt, classNameResolver, coerceIn, copyToClipboard, count, dataSearcher, distinct, drop, dropLast, dropLastWhile, dropWhile, findChanges, findObjectChanges, format, getCaps, getFileExt, getFilename, getMimeTypes, getObjectValue, group, hasIndex, ifDefined, ifEmpty, inRange, indexOf, indices, inferFilename, insertAt, isEmpty, isFile, isFileDetails, isIterable, isLetter, isNumber, isPromise, lastIndex, limit, map, mapToArray, maxOf, minOf, negate, omit, omitNils, ordinalIndicator, overwrite, parseAddress, parseDate, parseFileSize, parseMoney, parseName, pick, pluralize, poll, random, range, readClipboardText, removeAll, repeat, run, someValuesEmpty, sort, strictArray, strictArrayEquals, stringToSearch, subObjectList, sumOf, take, takeLast, takeLastWhile, takeWhile, timeDuration, toNumber, toObject, trimString, undefinedIfEmpty, upperFirst, windowed };
+export { TODO, addArticle, arrayEquals, arrayWithConst, asyncRun, averageOf, blankSpaces, buildArray, camelCaseToLetter, castArray, castReturn, classNameExt, classNameResolver, coerceIn, copyToClipboard, count, dataSearcher, distinct, drop, dropLast, dropLastWhile, dropWhile, findChanges, findObjectChanges, format, getCaps, getFileExt, getFilename, getMimeTypes, group, hasIndex, ifDefined, ifEmpty, inRange, indexOf, indices, inferFilename, insertAt, isEmpty, isFile, isFileDetails, isIterable, isLetter, isNumber, isPromise, lastIndex, limit, map, mapToArray, maxOf, minOf, negate, omit, omitNils, ordinalIndicator, overwrite, parseAddress, parseDate, parseFileSize, parseMoney, parseName, pick, pluralize, poll, random, range, readClipboardText, removeAll, repeat, run, someValuesEmpty, sort, strictArray, strictArrayEquals, stringToSearch, subObjectList, sumOf, take, takeLast, takeLastWhile, takeWhile, timeDuration, toNumber, toObject, traverse, trimString, undefinedIfEmpty, upperFirst, windowed };

package/dist/main.d.ts

@@ -82,13 +82,22 @@ declare const toMoney: (value: string | number, options?: NumberFormatterTypes["
  * @example parseDate, parseMoney, parseName, parseAddress, parseFileSize
  */
 declare function format<Event extends "date" | "money" | "name" | "address" | "file-size">(event: Event, ...args: Event extends "date" ? Parameters<typeof dateFormat> : Event extends "money" ? Parameters<typeof toMoney> : Event extends "name" ? Parameters<typeof nameToString> : Event extends "address" ? Parameters<typeof addressToString> : Event extends "file-size" ? [bytes: number] : never): Event extends "date" | "money" | "name" | "address" | "file-size" ? string : never;
+declare function TODO(message: string): void;
 declare function isFile(value: unknown): value is File;
 declare function isFileDetails(value: unknown): value is FileDetails;
-declare function getObjectValue(obj: object, path: string): object;
+declare function traverse(obj: object, path: string): object;
 declare function findObjectChanges<T extends object>(source: T, compareTo: T, options?: Partial<{
     strict: boolean;
+    ignoredKeys: (keyof T | (string & {}))[];
+    /**
+     * How deep the ignoredKeys should be applied.
+     *
+     * @default 0 */
+    ignoreDepth: "max" | number;
 }>): string[];
-declare function findChanges<T extends object | object[]>(source: T, compareTo: T): T extends object[] ? {
+declare function findChanges<T extends object | object[]>(source: T, compareTo: T, options?: Parameters<typeof findObjectChanges>["2"] & {
+    ignoredKeys?: T extends any[] ? (keyof T[number] | (string & {}))[] : T extends object ? (keyof T | (string & {}))[] : never;
+}): T extends object[] ? {
     keys: string[];
     index: number;
 }[] : T extends object ? string[] : never;
@@ -227,4 +236,4 @@ declare function arrayWithConst<T>(array: T[]): {
     asConst: readonly T[];
 };
 
-export { addArticle, arrayEquals, arrayWithConst, asyncRun, averageOf, blankSpaces, buildArray, camelCaseToLetter, castArray, castReturn, classNameExt, classNameResolver, coerceIn, copyToClipboard, count, dataSearcher, distinct, drop, dropLast, dropLastWhile, dropWhile, findChanges, findObjectChanges, format, getCaps, getFileExt, getFilename, getMimeTypes, getObjectValue, group, hasIndex, ifDefined, ifEmpty, inRange, indexOf, indices, inferFilename, insertAt, isEmpty, isFile, isFileDetails, isIterable, isLetter, isNumber, isPromise, lastIndex, limit, map, mapToArray, maxOf, minOf, negate, omit, omitNils, ordinalIndicator, overwrite, parseAddress, parseDate, parseFileSize, parseMoney, parseName, pick, pluralize, poll, random, range, readClipboardText, removeAll, repeat, run, someValuesEmpty, sort, strictArray, strictArrayEquals, stringToSearch, subObjectList, sumOf, take, takeLast, takeLastWhile, takeWhile, timeDuration, toNumber, toObject, trimString, undefinedIfEmpty, upperFirst, windowed };
+export { TODO, addArticle, arrayEquals, arrayWithConst, asyncRun, averageOf, blankSpaces, buildArray, camelCaseToLetter, castArray, castReturn, classNameExt, classNameResolver, coerceIn, copyToClipboard, count, dataSearcher, distinct, drop, dropLast, dropLastWhile, dropWhile, findChanges, findObjectChanges, format, getCaps, getFileExt, getFilename, getMimeTypes, group, hasIndex, ifDefined, ifEmpty, inRange, indexOf, indices, inferFilename, insertAt, isEmpty, isFile, isFileDetails, isIterable, isLetter, isNumber, isPromise, lastIndex, limit, map, mapToArray, maxOf, minOf, negate, omit, omitNils, ordinalIndicator, overwrite, parseAddress, parseDate, parseFileSize, parseMoney, parseName, pick, pluralize, poll, random, range, readClipboardText, removeAll, repeat, run, someValuesEmpty, sort, strictArray, strictArrayEquals, stringToSearch, subObjectList, sumOf, take, takeLast, takeLastWhile, takeWhile, timeDuration, toNumber, toObject, traverse, trimString, undefinedIfEmpty, upperFirst, windowed };

package/dist/main.js

@@ -485,6 +485,9 @@ function format(event, ...args) {
       return event;
   }
 }
+function TODO(message) {
+  throw new Error(`Todo: ${message}`);
+}
 function isFile(value) {
   const requiredKeys = [
     "name",
@@ -506,7 +509,7 @@ function isFileDetails(value) {
     return false;
   }
 }
-function getObjectValue(obj, path) {
+function traverse(obj, path) {
   const pathArr = path.split(".");
   return pathArr.reduce((currentObj, key) => {
     return currentObj?.[key];
@@ -515,12 +518,19 @@ function getObjectValue(obj, path) {
 function findObjectChanges(source, compareTo, options) {
   let entries = Object.entries(source);
   const changes = Object.keys(compareTo).filter(
-    (key) => !entries.some(([sourceKey]) => sourceKey === key)
+    (key) => !options?.ignoredKeys?.includes(key) && !entries.some(([sourceKey]) => sourceKey === key)
   );
+  const ignoreDepth = options?.ignoreDepth === "max" ? Infinity : Math.abs(options?.ignoreDepth || 0);
+  const isKeyIgnored = (key) => {
+    return key.split(".").some(
+      (key2, idx) => idx <= ignoreDepth && options?.ignoredKeys?.includes(key2)
+    );
+  };
   for (let idx = 0; idx < entries.length; idx++) {
     const [key, value] = entries[idx];
-    const comparedValue = getObjectValue(compareTo, key);
+    const comparedValue = traverse(compareTo, key);
     const checkArrayEquality = options?.strict ? strictArrayEquals : arrayEquals;
+    if (isKeyIgnored(key)) continue;
     if (Array.isArray(value) && Array.isArray(comparedValue) && !checkArrayEquality(value, comparedValue)) {
       changes.push(key);
     } else if (!!value && !!comparedValue && typeof value === "object" && typeof comparedValue === "object") {
@@ -530,6 +540,9 @@ function findObjectChanges(source, compareTo, options) {
           return [path, nestedValue];
         }
       );
+      const newCompareTo = traverse(compareTo, key);
+      const nonExistentKeys = Object.keys(newCompareTo).filter((key2) => !isKeyIgnored(key2) && !(key2 in value)).map((nestedKey) => [key, nestedKey].join("."));
+      changes.push(...nonExistentKeys);
       entries.push(...newEntries);
     } else if (JSON.stringify(value) !== JSON.stringify(comparedValue)) {
       changes.push(key);
@@ -537,18 +550,18 @@ function findObjectChanges(source, compareTo, options) {
   }
   return changes;
 }
-function findChanges(source, compareTo) {
+function findChanges(source, compareTo, options) {
   if (Array.isArray(source) && Array.isArray(compareTo)) {
     const changes = [];
     for (let idx = 0; idx < source.length; idx++) {
-      const _changes = findObjectChanges(source[idx], compareTo[idx]);
+      const _changes = findObjectChanges(source[idx], compareTo[idx], options);
       if (_changes.length > 0) {
         changes.push({ keys: _changes, index: idx });
       }
     }
     return changes;
   } else if (typeof source === "object" && typeof compareTo === "object") {
-    return findObjectChanges(source, compareTo);
+    return findObjectChanges(source, compareTo, options);
   }
   return [];
 }
@@ -990,6 +1003,7 @@ function arrayWithConst(array) {
   return { value: array, asConst: [...array] };
 }
 export {
+  TODO,
   addArticle,
   arrayEquals,
   arrayWithConst,
@@ -1018,7 +1032,6 @@ export {
   getFileExt,
   getFilename,
   getMimeTypes,
-  getObjectValue,
   group,
   hasIndex,
   ifDefined,
@@ -1074,6 +1087,7 @@ export {
   timeDuration,
   toNumber,
   ObjectConverter_default as toObject,
+  traverse,
   trimString,
   undefinedIfEmpty,
   upperFirst,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wavy/fn",
-  "version": "0.0.36",
+  "version": "0.0.39",
   "main": "./dist/main.js",
   "module": "./dist/main.cjs",
   "types": "./dist/main.d.ts",
@@ -33,7 +33,7 @@
     "zod": "^4.2.1"
   },
   "dependencies": {
-    "@wavy/util": "^0.0.7",
+    "@wavy/util": "^0.0.9",
     "uuid": "^13.0.0"
   }
 }