@tmlmobilidade/utils 20250918.1353.26 → 20250918.1816.45

package/dist/index.d.ts

@@ -1,5 +1,4 @@
 export * from './src/batching/index.js';
-export * from './src/convert-object.js';
 export * from './src/css/index.js';
 export * from './src/dates/index.js';
 export * from './src/files/files.js';
@@ -9,6 +8,7 @@ export * from './src/http.js';
 export * from './src/logs/index.js';
 export * from './src/math/index.js';
 export * from './src/navigation/index.js';
+export * from './src/objects/index.js';
 export * from './src/permissions.js';
 export * from './src/random/index.js';
 export * from './src/singleton-proxy.js';

package/dist/index.js

@@ -1,5 +1,4 @@
 export * from './src/batching/index.js';
-export * from './src/convert-object.js';
 export * from './src/css/index.js';
 export * from './src/dates/index.js';
 export * from './src/files/files.js';
@@ -9,6 +8,7 @@ export * from './src/http.js';
 export * from './src/logs/index.js';
 export * from './src/math/index.js';
 export * from './src/navigation/index.js';
+export * from './src/objects/index.js';
 export * from './src/permissions.js';
 export * from './src/random/index.js';
 export * from './src/singleton-proxy.js';

package/dist/src/objects/compare-objects.d.ts

@@ -0,0 +1,37 @@
+type Diff<T> = {
+    [K in keyof T]?: T[K] extends (infer U)[] ? (Diff<U> | {
+        curr_value: U;
+        prev_value: U;
+    })[] : T[K] extends object ? Diff<T[K]> | {
+        curr_value: T[K];
+        prev_value: T[K];
+    } : {
+        curr_value: T[K];
+        prev_value: T[K];
+    };
+};
+/**
+ * Compares two objects and returns the differences between them.
+ *
+ * @template T - The type of the objects being compared.
+ * @param {T} prev - The previous state of the object.
+ * @param {Partial<T>} curr - The current state of the object.
+ * @returns {Diff<T>} - An object representing the differences between the previous and current states.
+ *
+ * This function iterates over the keys of the current object and compares each value with the corresponding value in the previous object.
+ * If the values are arrays, it compares each element in the arrays and records any differences.
+ * If the values are objects, it recursively compares the nested objects.
+ * If the values are primitive types, it records the current and previous values if they differ.
+ *
+ * @example
+ * const prev = { name: 'Alice', age: 30, hobbies: ['reading', 'hiking'] };
+ * const curr = { name: 'Alice', age: 31, hobbies: ['reading', 'swimming'] };
+ * const differences = compareObjects(prev, curr);
+ * // differences will be:
+ * // {
+ * //   age: { curr_value: 31, prev_value: 30 },
+ * //   hobbies: [{ curr_value: 'swimming', prev_value: 'hiking' }]
+ * // }
+ */
+export declare function compareObjects<T extends object>(prev: T, curr: Partial<T>): Diff<T>;
+export {};

package/dist/src/objects/compare-objects.js

@@ -0,0 +1,65 @@
+/**
+ * Compares two objects and returns the differences between them.
+ *
+ * @template T - The type of the objects being compared.
+ * @param {T} prev - The previous state of the object.
+ * @param {Partial<T>} curr - The current state of the object.
+ * @returns {Diff<T>} - An object representing the differences between the previous and current states.
+ *
+ * This function iterates over the keys of the current object and compares each value with the corresponding value in the previous object.
+ * If the values are arrays, it compares each element in the arrays and records any differences.
+ * If the values are objects, it recursively compares the nested objects.
+ * If the values are primitive types, it records the current and previous values if they differ.
+ *
+ * @example
+ * const prev = { name: 'Alice', age: 30, hobbies: ['reading', 'hiking'] };
+ * const curr = { name: 'Alice', age: 31, hobbies: ['reading', 'swimming'] };
+ * const differences = compareObjects(prev, curr);
+ * // differences will be:
+ * // {
+ * //   age: { curr_value: 31, prev_value: 30 },
+ * //   hobbies: [{ curr_value: 'swimming', prev_value: 'hiking' }]
+ * // }
+ */
+export function compareObjects(prev, curr) {
+    const diff = {};
+    Object.keys(curr).forEach((key) => {
+        const prevVal = prev[key];
+        const currVal = curr[key];
+        if (prevVal === currVal)
+            return;
+        if (Array.isArray(prevVal) && Array.isArray(currVal)) {
+            const arrayDiff = [];
+            const maxLength = Math.max(prevVal.length, currVal.length);
+            for (let i = 0; i < maxLength; i++) {
+                const p = prevVal[i];
+                const c = currVal[i];
+                if (p === c)
+                    continue;
+                if (typeof p === 'object' && typeof c === 'object' && p && c) {
+                    const nestedDiff = compareObjects(p, c);
+                    arrayDiff.push(nestedDiff);
+                }
+                else {
+                    arrayDiff.push({ curr_value: c, prev_value: p });
+                }
+            }
+            if (arrayDiff.length > 0) {
+                diff[key] = arrayDiff;
+            }
+        }
+        else if (prevVal
+            && currVal
+            && typeof prevVal === 'object'
+            && typeof currVal === 'object') {
+            const nestedDiff = compareObjects(prevVal, currVal);
+            if (Object.keys(nestedDiff).length > 0) {
+                diff[key] = nestedDiff;
+            }
+        }
+        else {
+            diff[key] = { curr_value: currVal, prev_value: prevVal };
+        }
+    });
+    return diff;
+}

package/dist/src/objects/flatten-object.d.ts

@@ -0,0 +1,21 @@
+type DotPrefix<T extends string, U extends string> = '' extends T ? U : `${T}.${U}`;
+type NestedKeys<T, Prefix extends string = ''> = {
+    [K in keyof T & string]: T[K] extends Record<string, any> ? DotPrefix<Prefix, K> | NestedKeys<T[K], DotPrefix<Prefix, K>> : DotPrefix<Prefix, K>;
+}[keyof T & string];
+export type FlattenObjectType<T> = Record<NestedKeys<T>, any>;
+/**
+ * Flattens an object using dot notation for nested fields.
+ * Arrays are treated as leaf nodes and are not traversed.
+ * Includes both nested objects and their individual properties as separate keys.
+ *
+ * Example:
+ * flattenObject({ a: { b: 1, c: { d: 2 } } })
+ *   -> {
+ *        'a': { b: 1, c: { d: 2 } },
+ *        'a.b': 1,
+ *        'a.c': { d: 2 },
+ *        'a.c.d': 2
+ *      }
+ */
+export declare function flattenObject<T extends object>(input: T): FlattenObjectType<T>;
+export {};

package/dist/src/objects/flatten-object.js

@@ -0,0 +1,53 @@
+/**
+ * Flattens an object using dot notation for nested fields.
+ * Arrays are treated as leaf nodes and are not traversed.
+ * Includes both nested objects and their individual properties as separate keys.
+ *
+ * Example:
+ * flattenObject({ a: { b: 1, c: { d: 2 } } })
+ *   -> {
+ *        'a': { b: 1, c: { d: 2 } },
+ *        'a.b': 1,
+ *        'a.c': { d: 2 },
+ *        'a.c.d': 2
+ *      }
+ */
+export function flattenObject(input) {
+    const result = {};
+    if (input === null || input === undefined)
+        return result;
+    const isObject = (value) => typeof value === 'object' && value !== null && !Array.isArray(value);
+    const stack = [{ path: '', value: input }];
+    while (stack.length > 0) {
+        const { path, value } = stack.pop();
+        if (!isObject(value)) {
+            if (path) {
+                result[path] = value;
+            }
+            continue;
+        }
+        const entries = Object.entries(value);
+        if (entries.length === 0) {
+            if (path)
+                result[path] = value;
+            continue;
+        }
+        // Add the current object itself to the result
+        if (path) {
+            result[path] = value;
+        }
+        for (const [key, child] of entries) {
+            const nextPath = path ? `${path}.${key}` : key;
+            if (Array.isArray(child)) {
+                result[nextPath] = child;
+                continue;
+            }
+            if (isObject(child)) {
+                stack.push({ path: nextPath, value: child });
+                continue;
+            }
+            result[nextPath] = child;
+        }
+    }
+    return result;
+}

package/dist/src/objects/index.d.ts

@@ -0,0 +1,3 @@
+export * from './compare-objects.js';
+export * from './convert-object.js';
+export * from './flatten-object.js';

package/dist/src/objects/index.js

@@ -0,0 +1,3 @@
+export * from './compare-objects.js';
+export * from './convert-object.js';
+export * from './flatten-object.js';

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@tmlmobilidade/utils",
-	"version": "20250918.1353.26",
+	"version": "20250918.1816.45",
 	"author": "João de Vasconcelos & Jusi Monteiro",
 	"license": "AGPL-3.0-or-later",
 	"homepage": "https://github.com/tmlmobilidade/services#readme",