@trackunit/shared-utils 1.8.50 → 1.8.54

package/index.cjs.js

@@ -1,5 +1,6 @@
 'use strict';
 
+var zod = require('zod');
 var uuid = require('uuid');
 
 /**
@@ -19,7 +20,7 @@ const formatAddress = (address) => {
  * @example formatCoordinates({ latitude: 1.234567, longitude: 2.345678 }) // "1.234567, 2.345678"
  */
 const formatCoordinates = (coordinates, toFixed) => {
-    return toFixed
+    return toFixed !== undefined
         ? `${Number(coordinates.latitude.toFixed(toFixed))}, ${Number(coordinates.longitude.toFixed(toFixed))}`
         : `${coordinates.latitude}, ${coordinates.longitude}`;
 };
@@ -45,7 +46,7 @@ const nonNullable = (value) => {
  *
  */
 const truthy = (value) => {
-    return !!value;
+    return Boolean(value);
 };
 /**
  * Converts an object into an array of properly typed key-value pairs.
@@ -59,7 +60,9 @@ const truthy = (value) => {
  * @param {TObject} object - The object to convert.
  * @template TObject - The type of the object.
  */
-const objectEntries = (object) => Object.entries(object);
+const objectEntries = (object) => 
+// eslint-disable-next-line local-rules/no-typescript-assertion
+Object.entries(object);
 /**
  * Converts an array of key-value pairs into an object.
  * This is a type-faithful alternative to Object.fromEntries().
@@ -68,6 +71,7 @@ const objectEntries = (object) => Object.entries(object);
  * @template TEntries - The type of the entries array.
  */
 const objectFromEntries = (entries) => {
+    // eslint-disable-next-line local-rules/no-typescript-assertion
     return Object.fromEntries(entries);
 };
 /**
@@ -84,6 +88,7 @@ const objectFromEntries = (entries) => {
  * @returns {(keyof TObject)[]} An array of the keys of the object.
  */
 const objectKeys = (object) => {
+    // eslint-disable-next-line local-rules/no-typescript-assertion
     return Object.keys(object).map(key => key);
 };
 /**
@@ -95,17 +100,20 @@ const objectKeys = (object) => {
  *
  * @template TObject - The type of the object.
  * @param {TObject} object - The object to get the values from.
- * @returns {TObject[keyof TObject][]} An array of the values of the object.
+ * @returns {Array} An array of the values of the object.
  */
-const objectValues = (object) => Object.values(object);
+const objectValues = (object) => 
+// eslint-disable-next-line local-rules/no-typescript-assertion
+Object.values(object);
 
 /**
  * Returns a new array with the items from the previous array and the new array, but only if the item's key is unique.
  *
+ * @template TObject - the type of the items in the array
  * @param key   The key to use to determine uniqueness
  * @param previous The previous array of items to merge with the new array
  * @param newArray The new array of items to merge with the previous array
- * @returns A new array with the items from the previous array and the new array, but only if the item's key is unique.
+ * @returns {Array<TObject>} A new array with the items from the previous array and the new array, but only if the item's key is unique.
  */
 const unionArraysByKey = (key, previous, newArray) => {
     const previousIds = previous?.map(edge => edge[key]) || [];
@@ -127,8 +135,9 @@ const isArrayEqual = (a, b) => a.length === b.length && a.every((v, i) => v ===
 /**
  * Checks if an array is not empty.
  *
+ * @template TItem
  * @param array - The array to check.
- * @returns The array if not empty, otherwise undefined.
+ * @returns {Array<TItem> | undefined} The array if not empty, otherwise undefined.
  */
 const arrayNotEmpty = (array) => array && array.length > 0 ? array : undefined;
 
@@ -160,14 +169,13 @@ const size = {
     LARGE: "large",
 };
 
-exports.HoursAndMinutesFormat = void 0;
-(function (HoursAndMinutesFormat) {
-    HoursAndMinutesFormat["HOURS_MIN_SEC_LONG"] = "HOURS_MIN_SEC_LONG";
-    HoursAndMinutesFormat["HOURS_MIN_SEC"] = "HOURS_MIN_SEC";
-    HoursAndMinutesFormat["HOURS_MIN_LONG"] = "HOURS_MIN_LONG";
-    HoursAndMinutesFormat["HOURS_MIN"] = "HOURS_MIN";
-    HoursAndMinutesFormat["HOURS_LONG"] = "HOURS_LONG";
-})(exports.HoursAndMinutesFormat || (exports.HoursAndMinutesFormat = {}));
+const HoursAndMinutesFormat = {
+    HOURS_MIN_SEC_LONG: "HOURS_MIN_SEC_LONG", // h [h] mm [min] ss [sec]
+    HOURS_MIN_SEC: "HOURS_MIN_SEC", // h[h] m[m] s[s]
+    HOURS_MIN_LONG: "HOURS_MIN_LONG", // h [hrs] mm [min]
+    HOURS_MIN: "HOURS_MIN", // h[h] m[m]
+    HOURS_LONG: "HOURS_LONG", //  h [hrs]
+};
 const DateTimeFormat = {
     DATE: {
         selectFormat: "dateOnly",
@@ -207,7 +215,7 @@ const DateTimeFormat = {
  */
 const getISOStringFromDate = (date) => {
     try {
-        if (!date) {
+        if (date === null || date === undefined) {
             return null;
         }
         return new Date(date).toISOString();
@@ -278,7 +286,7 @@ function doNothing() {
  */
 const enumFromValue = (val, _enum) => {
     const enumName = objectKeys(_enum).find(k => _enum[k] === val);
-    if (!enumName) {
+    if (enumName === undefined) {
         throw Error(`Unknown enum value: ${val} expect one of: ${JSON.stringify(objectValues(_enum))}`);
     }
     return _enum[enumName];
@@ -308,7 +316,7 @@ const enumOrUndefinedFromValue = (_enum, val) => {
  */
 const enumFromValueTypesafe = (val, _enum) => {
     const enumName = objectKeys(_enum).find(k => _enum[k] === val);
-    if (!enumName) {
+    if (enumName === undefined) {
         throw Error(`Unknown enum value: ${String(val)} expect one of: ${JSON.stringify(objectValues(_enum))}`);
     }
     return _enum[enumName];
@@ -333,9 +341,10 @@ const exhaustiveCheck = (value) => {
 
 /**
  *
+ * @template TItem
  * @param arr1 An array of string or numbers
  * @param arr2 An array of string or numbers
- * @returns The elements shared between arr1 and arr2.
+ * @returns {Array<TItem>} The elements shared between arr1 and arr2.
  */
 function intersection(arr1, arr2) {
     const a = new Set(arr1);
@@ -345,9 +354,10 @@ function intersection(arr1, arr2) {
 }
 /**
  *
+ * @template TItem
  * @param arr1 An array of string or numbers
  * @param arr2 An array of string or numbers
- * @returns The elements present in arr1 but not arr2.
+ * @returns {Array<TItem>} The elements present in arr1 but not arr2.
  */
 function difference(arr1, arr2) {
     const a = new Set(arr1);
@@ -410,11 +420,11 @@ searchTerm) => {
 /**
  * Group an array of items by a key.
  *
- * @template T The type of items in the list.
- * @template K The type of the key.
- * @param {T[]} list The array of items to group.
- * @param {(item: T) => K} getKey A function to get the key to group by.
- * @returns {Map<K, T[]>} A map of the items grouped by the key.
+ * @template TItem The type of items in the list.
+ * @template KeyGroup The type of the key.
+ * @param {TItem[]} list The array of items to group.
+ * @param {(item: TItem) => KeyGroup} getKey A function to get the key to group by.
+ * @returns {Map<KeyGroup, TItem[]>} A map of the items grouped by the key.
  * @example
  * groupBy([{ name: "John", surname: "Doe" }, { name: "Jane", surname: "Doe" }], p => p.surname)
  * Returns: Map { "Doe" => [{ name: "John", surname: "Doe" }, { name: "Jane", surname: "Doe" }] }
@@ -496,7 +506,7 @@ const zeroPadToUUIDLength = (input, maxLength) => input.length < maxLength ? zer
  */
 const toUUID = (value) => {
     if (isUUID(value.toString())) {
-        return value;
+        return value.toString();
     }
     // A valid UUID length is 36 but we subtract 4 because we insert 4 hyphens.
     const id = zeroPadToUUIDLength(value.toString(), 32);
@@ -519,7 +529,7 @@ const toID = (uuid) => Number(uuid.replace(/-/g, "").replace(/^0+/, ""));
  * A helper function that converts a list of UUID to a list of valid machine IDs.
  * NOTE that NaN will be removed so list cannot be expected to be of same size.
  *
- * @param uuid The list of UUIDs that should be converted to a list of valid machine IDs
+ * @param ids The list of UUIDs that should be converted to a list of valid machine IDs
  */
 const toIDs = (ids) => ids?.filter(id => !isNaN(toID(id))).map(id => toID(id)) ?? [];
 
@@ -532,7 +542,7 @@ const toIDs = (ids) => ids?.filter(id => !isNaN(toID(id))).map(id => toID(id)) ?
  * @param {number} options.maxHeight - The maximum height of the converted PNG image.
  * @param {number} options.maxWidth - The maximum width of the converted PNG image.
  * @param {number} options.idealArea - The ideal area of the converted PNG image.
- * @returns The converted PNG image as a data URL.
+ * @returns {string} The converted PNG image as a data URL.
  * @throws Error if unable to get the canvas context.
  */
 const toPNG = ({ image, dimensions, maxHeight, maxWidth, idealArea, }) => {
@@ -647,13 +657,15 @@ const fetchImageAsBase64 = async (url) => {
 /**
  * Deletes all undefined keys from an object.
  *
- * @param obj The object to delete undefined keys from.
- * @returns The object without undefined keys.
+ * @template TObject
+ * @param {TObject} obj The object to delete undefined keys from.
  * @example deleteUndefinedKeys({ a: 1, b: undefined }) // { a: 1 }
+ * @returns {TObject} The object without undefined keys.
  */
 const deleteUndefinedKeys = (obj) => {
     Object.keys(obj).forEach(key => {
         if (typeof obj[key] === "object" && obj[key] !== null) {
+            // eslint-disable-next-line local-rules/no-typescript-assertion
             deleteUndefinedKeys(obj[key]);
         }
         else if (obj[key] === undefined) {
@@ -665,8 +677,8 @@ const deleteUndefinedKeys = (obj) => {
 /**
  * Checks if an object is not empty.
  *
- * @param obj - The object to check.
- * @returns The object if not empty, otherwise undefined.
+ * @template TObject * @param obj - The object to check.
+ * @returns {TObject | undefined} The object if not empty, otherwise undefined.
  */
 const objNotEmpty = (obj) => obj && Object.keys(obj).length > 0 ? obj : undefined;
 /**
@@ -676,14 +688,16 @@ const pick = (obj, ...keys) => {
     return keys.reduce((acc, key) => {
         acc[key] = obj[key];
         return acc;
-    }, {});
+    }, 
+    // eslint-disable-next-line local-rules/no-typescript-assertion
+    {});
 };
 /**
  * Returns an object with only the differences between two input objects.
  * Not recursive, only compares first level properties.
  */
 const getFirstLevelObjectPropertyDifferences = (obj1, obj2) => {
-    return objectEntries(obj1).reduce((diff, [key, value]) => {
+    return Object.entries(obj1).reduce((diff, [key, value]) => {
         // Check if the property exists in obj2.
         if (key in obj2) {
             const val = obj2[key];
@@ -707,7 +721,8 @@ const getFirstLevelObjectPropertyDifferences = (obj1, obj2) => {
  * @example replaceNullableNumbersWithZero({ a: 1, b: null, c: undefined }) // { a: 1, b: 0, c: 0 }
  */
 const replaceNullableNumbersWithZero = (record) => {
-    return Object.fromEntries(objectEntries(record).map(([key, value]) => [key, value ?? 0]));
+    // eslint-disable-next-line local-rules/no-typescript-assertion
+    return Object.fromEntries(Object.entries(record).map(([key, value]) => [key, value ?? 0]));
 };
 /**
  * Removes a property from an object in a type-safe way.
@@ -720,6 +735,7 @@ const replaceNullableNumbersWithZero = (record) => {
 const removeProperty = (obj, key) => {
     const { [key]: _, ...rest } = obj;
     // should be safe because we remove the key from the object, just no way to type it properly
+    // eslint-disable-next-line local-rules/no-typescript-assertion
     return rest;
 };
 /**
@@ -735,7 +751,6 @@ const removeProperties = (obj, keys) => {
     for (const key of keys) {
         delete result[key];
     }
-    // should be safe because we remove the keys from the object, just no way to type it properly
     return result;
 };
 
@@ -891,7 +906,7 @@ const convertBlobToBase64 = (blob) => {
         const reader = new FileReader();
         reader.readAsDataURL(blob);
         reader.onload = () => {
-            if (!reader.result) {
+            if (reader.result === null) {
                 no(new Error("Failed to read blob data"));
                 return;
             }
@@ -982,7 +997,7 @@ const stringCompareFromKey = (key) => (a, b) => {
         return collator.compare(aVal, bVal);
     }
     else {
-        throw new Error(`Cannot compare property '${key}': values are not strings`);
+        throw new Error(`Cannot compare property '${String(key)}': values are not strings`);
     }
 };
 /**
@@ -1038,10 +1053,10 @@ const doNumberCompare = (a, b, options) => {
         return 0;
     }
     if (!isDefined(a)) {
-        return options && options.unknownAfterHighest ? 1 : -1;
+        return (options?.unknownAfterHighest === true) ? 1 : -1;
     }
     if (!isDefined(b)) {
-        return options && options.unknownAfterHighest ? -1 : 1;
+        return (options?.unknownAfterHighest === true) ? -1 : 1;
     }
     return a - b;
 };
@@ -1072,13 +1087,13 @@ function isDefined(value) {
  * @example booleanCompare(false, true) // 1
  */
 const booleanCompare = (a, b) => {
-    if (!a && !b) {
+    if (a !== true && b !== true) {
         return 0;
     }
-    if (!a) {
+    if (a !== true) {
         return 1;
     }
-    if (!b) {
+    if (b !== true) {
         return -1;
     }
     return 0;
@@ -1136,6 +1151,25 @@ const stripHiddenCharacters = (input) => {
     return input.replace(hiddenRegex, "");
 };
 
+const svgElementSchema = zod.z.object({
+    nodeName: zod.z.string(),
+    width: zod.z.object({
+        baseVal: zod.z.object({
+            value: zod.z.number(),
+        }),
+    }),
+    height: zod.z.object({
+        baseVal: zod.z.object({
+            value: zod.z.number(),
+        }),
+    }),
+    viewBox: zod.z.object({
+        baseVal: zod.z.object({
+            width: zod.z.number(),
+            height: zod.z.number(),
+        }),
+    }),
+});
 /**
  * Convert the given value to HEX
  * If the value is not rgb, returns back the same value
@@ -1158,7 +1192,7 @@ const colorsFromStyleDeclaration = (styles) => {
  * Loads the dimensions of an SVG string.
  *
  * @param base64EncodedSVG The SVG string to load dimensions from.
- * @returns A promise that resolves to an object containing the width and height of the SVG.
+ * @returns {Promise<ImageDimensions>} A promise that resolves to an object containing the width and height of the SVG.
  * @throws {Error} If the SVG string is invalid or the dimensions cannot be determined.
  */
 const loadSVGDimensions = (base64EncodedSVG) => {
@@ -1167,12 +1201,17 @@ const loadSVGDimensions = (base64EncodedSVG) => {
         const svgAsString = atob(base64EncodedSVG.replace("data:image/svg+xml;base64,", ""));
         const parser = new DOMParser();
         const svgDoc = parser.parseFromString(svgAsString, "image/svg+xml");
-        const svgElement = svgDoc.documentElement;
-        // Check if parsing was successful
-        if (svgElement.nodeName === "parsererror") {
+        // Check if parsing was successful first
+        if (svgDoc.documentElement.nodeName === "parsererror") {
             reject(new Error("Invalid SVG string"));
             return;
         }
+        const svgElementValidation = svgElementSchema.safeParse(svgDoc.documentElement);
+        if (!svgElementValidation.success) {
+            reject(new Error("Invalid SVG element structure"));
+            return;
+        }
+        const svgElement = svgElementValidation.data;
         // Get dimensions
         const width = svgElement.width.baseVal.value;
         const height = svgElement.height.baseVal.value;
@@ -1214,14 +1253,16 @@ const getAllColors = (base64EncodedSVG) => {
     });
     svgImage.querySelectorAll("style").forEach(element => {
         const cssRules = element.sheet?.cssRules;
-        if (cssRules?.length) {
+        if (cssRules && cssRules.length > 0) {
             for (let i = 0; i < cssRules.length; i++) {
                 // Checking if the style attribute exists
-                const cssRule = cssRules[i]; // Replace type casting with type assertion
-                // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
-                if (cssRule.style) {
-                    const cssRuleStyles = cssRule.style;
-                    colors.push(...colorsFromStyleDeclaration(cssRuleStyles));
+                const cssRuleSchema = zod.z.object({
+                    style: zod.z.instanceof(CSSStyleDeclaration).optional(),
+                });
+                const cssRuleValidation = cssRuleSchema.safeParse(cssRules[i]);
+                if (cssRuleValidation.success && cssRuleValidation.data.style) {
+                    const style = cssRuleValidation.data.style;
+                    colors.push(...colorsFromStyleDeclaration(style));
                 }
             }
         }
@@ -1252,10 +1293,12 @@ const getAllColors = (base64EncodedSVG) => {
 /**
  * Converts a Base64 encoded SVG to a Scaled Base64 PNG.
  *
- * @param {string}  base64EncodedSVG    The Base64 encoded svg string to convert
- * @param {number}  maxWidth            The max width(px) of the output PNG
- * @param {number}  maxHeight           The max height(px) of the output PNG
- * @returns {Promise<string>}    A Base64 encoded PNG, scaled to the given parameters
+ * @param params The parameters object
+ * @param params.base64EncodedSVG The Base64 encoded svg string to convert
+ * @param params.maxWidth The max width(px) of the output PNG
+ * @param params.maxHeight The max height(px) of the output PNG
+ * @param params.idealArea The ideal area for the image
+ * @returns {Promise<string>} A Base64 encoded PNG, scaled to the given parameters
  */
 const svgToPNG = async ({ base64EncodedSVG, maxWidth, maxHeight, idealArea, }) => {
     const [image, dimensions] = await Promise.all([
@@ -1340,6 +1383,7 @@ const convertYardsToMeters = (value) => {
 };
 
 exports.DateTimeFormat = DateTimeFormat;
+exports.HoursAndMinutesFormat = HoursAndMinutesFormat;
 exports.align = align;
 exports.alphabeticallySort = alphabeticallySort;
 exports.arrayLengthCompare = arrayLengthCompare;

package/index.esm.js

@@ -1,3 +1,4 @@
+import { z } from 'zod';
 import { v3, v4, v5 } from 'uuid';
 
 /**
@@ -17,7 +18,7 @@ const formatAddress = (address) => {
  * @example formatCoordinates({ latitude: 1.234567, longitude: 2.345678 }) // "1.234567, 2.345678"
  */
 const formatCoordinates = (coordinates, toFixed) => {
-    return toFixed
+    return toFixed !== undefined
         ? `${Number(coordinates.latitude.toFixed(toFixed))}, ${Number(coordinates.longitude.toFixed(toFixed))}`
         : `${coordinates.latitude}, ${coordinates.longitude}`;
 };
@@ -43,7 +44,7 @@ const nonNullable = (value) => {
  *
  */
 const truthy = (value) => {
-    return !!value;
+    return Boolean(value);
 };
 /**
  * Converts an object into an array of properly typed key-value pairs.
@@ -57,7 +58,9 @@ const truthy = (value) => {
  * @param {TObject} object - The object to convert.
  * @template TObject - The type of the object.
  */
-const objectEntries = (object) => Object.entries(object);
+const objectEntries = (object) => 
+// eslint-disable-next-line local-rules/no-typescript-assertion
+Object.entries(object);
 /**
  * Converts an array of key-value pairs into an object.
  * This is a type-faithful alternative to Object.fromEntries().
@@ -66,6 +69,7 @@ const objectEntries = (object) => Object.entries(object);
  * @template TEntries - The type of the entries array.
  */
 const objectFromEntries = (entries) => {
+    // eslint-disable-next-line local-rules/no-typescript-assertion
     return Object.fromEntries(entries);
 };
 /**
@@ -82,6 +86,7 @@ const objectFromEntries = (entries) => {
  * @returns {(keyof TObject)[]} An array of the keys of the object.
  */
 const objectKeys = (object) => {
+    // eslint-disable-next-line local-rules/no-typescript-assertion
     return Object.keys(object).map(key => key);
 };
 /**
@@ -93,17 +98,20 @@ const objectKeys = (object) => {
  *
  * @template TObject - The type of the object.
  * @param {TObject} object - The object to get the values from.
- * @returns {TObject[keyof TObject][]} An array of the values of the object.
+ * @returns {Array} An array of the values of the object.
  */
-const objectValues = (object) => Object.values(object);
+const objectValues = (object) => 
+// eslint-disable-next-line local-rules/no-typescript-assertion
+Object.values(object);
 
 /**
  * Returns a new array with the items from the previous array and the new array, but only if the item's key is unique.
  *
+ * @template TObject - the type of the items in the array
  * @param key   The key to use to determine uniqueness
  * @param previous The previous array of items to merge with the new array
  * @param newArray The new array of items to merge with the previous array
- * @returns A new array with the items from the previous array and the new array, but only if the item's key is unique.
+ * @returns {Array<TObject>} A new array with the items from the previous array and the new array, but only if the item's key is unique.
  */
 const unionArraysByKey = (key, previous, newArray) => {
     const previousIds = previous?.map(edge => edge[key]) || [];
@@ -125,8 +133,9 @@ const isArrayEqual = (a, b) => a.length === b.length && a.every((v, i) => v ===
 /**
  * Checks if an array is not empty.
  *
+ * @template TItem
  * @param array - The array to check.
- * @returns The array if not empty, otherwise undefined.
+ * @returns {Array<TItem> | undefined} The array if not empty, otherwise undefined.
  */
 const arrayNotEmpty = (array) => array && array.length > 0 ? array : undefined;
 
@@ -158,14 +167,13 @@ const size = {
     LARGE: "large",
 };
 
-var HoursAndMinutesFormat;
-(function (HoursAndMinutesFormat) {
-    HoursAndMinutesFormat["HOURS_MIN_SEC_LONG"] = "HOURS_MIN_SEC_LONG";
-    HoursAndMinutesFormat["HOURS_MIN_SEC"] = "HOURS_MIN_SEC";
-    HoursAndMinutesFormat["HOURS_MIN_LONG"] = "HOURS_MIN_LONG";
-    HoursAndMinutesFormat["HOURS_MIN"] = "HOURS_MIN";
-    HoursAndMinutesFormat["HOURS_LONG"] = "HOURS_LONG";
-})(HoursAndMinutesFormat || (HoursAndMinutesFormat = {}));
+const HoursAndMinutesFormat = {
+    HOURS_MIN_SEC_LONG: "HOURS_MIN_SEC_LONG", // h [h] mm [min] ss [sec]
+    HOURS_MIN_SEC: "HOURS_MIN_SEC", // h[h] m[m] s[s]
+    HOURS_MIN_LONG: "HOURS_MIN_LONG", // h [hrs] mm [min]
+    HOURS_MIN: "HOURS_MIN", // h[h] m[m]
+    HOURS_LONG: "HOURS_LONG", //  h [hrs]
+};
 const DateTimeFormat = {
     DATE: {
         selectFormat: "dateOnly",
@@ -205,7 +213,7 @@ const DateTimeFormat = {
  */
 const getISOStringFromDate = (date) => {
     try {
-        if (!date) {
+        if (date === null || date === undefined) {
             return null;
         }
         return new Date(date).toISOString();
@@ -276,7 +284,7 @@ function doNothing() {
  */
 const enumFromValue = (val, _enum) => {
     const enumName = objectKeys(_enum).find(k => _enum[k] === val);
-    if (!enumName) {
+    if (enumName === undefined) {
         throw Error(`Unknown enum value: ${val} expect one of: ${JSON.stringify(objectValues(_enum))}`);
     }
     return _enum[enumName];
@@ -306,7 +314,7 @@ const enumOrUndefinedFromValue = (_enum, val) => {
  */
 const enumFromValueTypesafe = (val, _enum) => {
     const enumName = objectKeys(_enum).find(k => _enum[k] === val);
-    if (!enumName) {
+    if (enumName === undefined) {
         throw Error(`Unknown enum value: ${String(val)} expect one of: ${JSON.stringify(objectValues(_enum))}`);
     }
     return _enum[enumName];
@@ -331,9 +339,10 @@ const exhaustiveCheck = (value) => {
 
 /**
  *
+ * @template TItem
  * @param arr1 An array of string or numbers
  * @param arr2 An array of string or numbers
- * @returns The elements shared between arr1 and arr2.
+ * @returns {Array<TItem>} The elements shared between arr1 and arr2.
  */
 function intersection(arr1, arr2) {
     const a = new Set(arr1);
@@ -343,9 +352,10 @@ function intersection(arr1, arr2) {
 }
 /**
  *
+ * @template TItem
  * @param arr1 An array of string or numbers
  * @param arr2 An array of string or numbers
- * @returns The elements present in arr1 but not arr2.
+ * @returns {Array<TItem>} The elements present in arr1 but not arr2.
  */
 function difference(arr1, arr2) {
     const a = new Set(arr1);
@@ -408,11 +418,11 @@ searchTerm) => {
 /**
  * Group an array of items by a key.
  *
- * @template T The type of items in the list.
- * @template K The type of the key.
- * @param {T[]} list The array of items to group.
- * @param {(item: T) => K} getKey A function to get the key to group by.
- * @returns {Map<K, T[]>} A map of the items grouped by the key.
+ * @template TItem The type of items in the list.
+ * @template KeyGroup The type of the key.
+ * @param {TItem[]} list The array of items to group.
+ * @param {(item: TItem) => KeyGroup} getKey A function to get the key to group by.
+ * @returns {Map<KeyGroup, TItem[]>} A map of the items grouped by the key.
  * @example
  * groupBy([{ name: "John", surname: "Doe" }, { name: "Jane", surname: "Doe" }], p => p.surname)
  * Returns: Map { "Doe" => [{ name: "John", surname: "Doe" }, { name: "Jane", surname: "Doe" }] }
@@ -494,7 +504,7 @@ const zeroPadToUUIDLength = (input, maxLength) => input.length < maxLength ? zer
  */
 const toUUID = (value) => {
     if (isUUID(value.toString())) {
-        return value;
+        return value.toString();
     }
     // A valid UUID length is 36 but we subtract 4 because we insert 4 hyphens.
     const id = zeroPadToUUIDLength(value.toString(), 32);
@@ -517,7 +527,7 @@ const toID = (uuid) => Number(uuid.replace(/-/g, "").replace(/^0+/, ""));
  * A helper function that converts a list of UUID to a list of valid machine IDs.
  * NOTE that NaN will be removed so list cannot be expected to be of same size.
  *
- * @param uuid The list of UUIDs that should be converted to a list of valid machine IDs
+ * @param ids The list of UUIDs that should be converted to a list of valid machine IDs
  */
 const toIDs = (ids) => ids?.filter(id => !isNaN(toID(id))).map(id => toID(id)) ?? [];
 
@@ -530,7 +540,7 @@ const toIDs = (ids) => ids?.filter(id => !isNaN(toID(id))).map(id => toID(id)) ?
  * @param {number} options.maxHeight - The maximum height of the converted PNG image.
  * @param {number} options.maxWidth - The maximum width of the converted PNG image.
  * @param {number} options.idealArea - The ideal area of the converted PNG image.
- * @returns The converted PNG image as a data URL.
+ * @returns {string} The converted PNG image as a data URL.
  * @throws Error if unable to get the canvas context.
  */
 const toPNG = ({ image, dimensions, maxHeight, maxWidth, idealArea, }) => {
@@ -645,13 +655,15 @@ const fetchImageAsBase64 = async (url) => {
 /**
  * Deletes all undefined keys from an object.
  *
- * @param obj The object to delete undefined keys from.
- * @returns The object without undefined keys.
+ * @template TObject
+ * @param {TObject} obj The object to delete undefined keys from.
  * @example deleteUndefinedKeys({ a: 1, b: undefined }) // { a: 1 }
+ * @returns {TObject} The object without undefined keys.
  */
 const deleteUndefinedKeys = (obj) => {
     Object.keys(obj).forEach(key => {
         if (typeof obj[key] === "object" && obj[key] !== null) {
+            // eslint-disable-next-line local-rules/no-typescript-assertion
             deleteUndefinedKeys(obj[key]);
         }
         else if (obj[key] === undefined) {
@@ -663,8 +675,8 @@ const deleteUndefinedKeys = (obj) => {
 /**
  * Checks if an object is not empty.
  *
- * @param obj - The object to check.
- * @returns The object if not empty, otherwise undefined.
+ * @template TObject * @param obj - The object to check.
+ * @returns {TObject | undefined} The object if not empty, otherwise undefined.
  */
 const objNotEmpty = (obj) => obj && Object.keys(obj).length > 0 ? obj : undefined;
 /**
@@ -674,14 +686,16 @@ const pick = (obj, ...keys) => {
     return keys.reduce((acc, key) => {
         acc[key] = obj[key];
         return acc;
-    }, {});
+    }, 
+    // eslint-disable-next-line local-rules/no-typescript-assertion
+    {});
 };
 /**
  * Returns an object with only the differences between two input objects.
  * Not recursive, only compares first level properties.
  */
 const getFirstLevelObjectPropertyDifferences = (obj1, obj2) => {
-    return objectEntries(obj1).reduce((diff, [key, value]) => {
+    return Object.entries(obj1).reduce((diff, [key, value]) => {
         // Check if the property exists in obj2.
         if (key in obj2) {
             const val = obj2[key];
@@ -705,7 +719,8 @@ const getFirstLevelObjectPropertyDifferences = (obj1, obj2) => {
  * @example replaceNullableNumbersWithZero({ a: 1, b: null, c: undefined }) // { a: 1, b: 0, c: 0 }
  */
 const replaceNullableNumbersWithZero = (record) => {
-    return Object.fromEntries(objectEntries(record).map(([key, value]) => [key, value ?? 0]));
+    // eslint-disable-next-line local-rules/no-typescript-assertion
+    return Object.fromEntries(Object.entries(record).map(([key, value]) => [key, value ?? 0]));
 };
 /**
  * Removes a property from an object in a type-safe way.
@@ -718,6 +733,7 @@ const replaceNullableNumbersWithZero = (record) => {
 const removeProperty = (obj, key) => {
     const { [key]: _, ...rest } = obj;
     // should be safe because we remove the key from the object, just no way to type it properly
+    // eslint-disable-next-line local-rules/no-typescript-assertion
     return rest;
 };
 /**
@@ -733,7 +749,6 @@ const removeProperties = (obj, keys) => {
     for (const key of keys) {
         delete result[key];
     }
-    // should be safe because we remove the keys from the object, just no way to type it properly
     return result;
 };
 
@@ -889,7 +904,7 @@ const convertBlobToBase64 = (blob) => {
         const reader = new FileReader();
         reader.readAsDataURL(blob);
         reader.onload = () => {
-            if (!reader.result) {
+            if (reader.result === null) {
                 no(new Error("Failed to read blob data"));
                 return;
             }
@@ -980,7 +995,7 @@ const stringCompareFromKey = (key) => (a, b) => {
         return collator.compare(aVal, bVal);
     }
     else {
-        throw new Error(`Cannot compare property '${key}': values are not strings`);
+        throw new Error(`Cannot compare property '${String(key)}': values are not strings`);
     }
 };
 /**
@@ -1036,10 +1051,10 @@ const doNumberCompare = (a, b, options) => {
         return 0;
     }
     if (!isDefined(a)) {
-        return options && options.unknownAfterHighest ? 1 : -1;
+        return (options?.unknownAfterHighest === true) ? 1 : -1;
     }
     if (!isDefined(b)) {
-        return options && options.unknownAfterHighest ? -1 : 1;
+        return (options?.unknownAfterHighest === true) ? -1 : 1;
     }
     return a - b;
 };
@@ -1070,13 +1085,13 @@ function isDefined(value) {
  * @example booleanCompare(false, true) // 1
  */
 const booleanCompare = (a, b) => {
-    if (!a && !b) {
+    if (a !== true && b !== true) {
         return 0;
     }
-    if (!a) {
+    if (a !== true) {
         return 1;
     }
-    if (!b) {
+    if (b !== true) {
         return -1;
     }
     return 0;
@@ -1134,6 +1149,25 @@ const stripHiddenCharacters = (input) => {
     return input.replace(hiddenRegex, "");
 };
 
+const svgElementSchema = z.object({
+    nodeName: z.string(),
+    width: z.object({
+        baseVal: z.object({
+            value: z.number(),
+        }),
+    }),
+    height: z.object({
+        baseVal: z.object({
+            value: z.number(),
+        }),
+    }),
+    viewBox: z.object({
+        baseVal: z.object({
+            width: z.number(),
+            height: z.number(),
+        }),
+    }),
+});
 /**
  * Convert the given value to HEX
  * If the value is not rgb, returns back the same value
@@ -1156,7 +1190,7 @@ const colorsFromStyleDeclaration = (styles) => {
  * Loads the dimensions of an SVG string.
  *
  * @param base64EncodedSVG The SVG string to load dimensions from.
- * @returns A promise that resolves to an object containing the width and height of the SVG.
+ * @returns {Promise<ImageDimensions>} A promise that resolves to an object containing the width and height of the SVG.
  * @throws {Error} If the SVG string is invalid or the dimensions cannot be determined.
  */
 const loadSVGDimensions = (base64EncodedSVG) => {
@@ -1165,12 +1199,17 @@ const loadSVGDimensions = (base64EncodedSVG) => {
         const svgAsString = atob(base64EncodedSVG.replace("data:image/svg+xml;base64,", ""));
         const parser = new DOMParser();
         const svgDoc = parser.parseFromString(svgAsString, "image/svg+xml");
-        const svgElement = svgDoc.documentElement;
-        // Check if parsing was successful
-        if (svgElement.nodeName === "parsererror") {
+        // Check if parsing was successful first
+        if (svgDoc.documentElement.nodeName === "parsererror") {
             reject(new Error("Invalid SVG string"));
             return;
         }
+        const svgElementValidation = svgElementSchema.safeParse(svgDoc.documentElement);
+        if (!svgElementValidation.success) {
+            reject(new Error("Invalid SVG element structure"));
+            return;
+        }
+        const svgElement = svgElementValidation.data;
         // Get dimensions
         const width = svgElement.width.baseVal.value;
         const height = svgElement.height.baseVal.value;
@@ -1212,14 +1251,16 @@ const getAllColors = (base64EncodedSVG) => {
     });
     svgImage.querySelectorAll("style").forEach(element => {
         const cssRules = element.sheet?.cssRules;
-        if (cssRules?.length) {
+        if (cssRules && cssRules.length > 0) {
             for (let i = 0; i < cssRules.length; i++) {
                 // Checking if the style attribute exists
-                const cssRule = cssRules[i]; // Replace type casting with type assertion
-                // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
-                if (cssRule.style) {
-                    const cssRuleStyles = cssRule.style;
-                    colors.push(...colorsFromStyleDeclaration(cssRuleStyles));
+                const cssRuleSchema = z.object({
+                    style: z.instanceof(CSSStyleDeclaration).optional(),
+                });
+                const cssRuleValidation = cssRuleSchema.safeParse(cssRules[i]);
+                if (cssRuleValidation.success && cssRuleValidation.data.style) {
+                    const style = cssRuleValidation.data.style;
+                    colors.push(...colorsFromStyleDeclaration(style));
                 }
             }
         }
@@ -1250,10 +1291,12 @@ const getAllColors = (base64EncodedSVG) => {
 /**
  * Converts a Base64 encoded SVG to a Scaled Base64 PNG.
  *
- * @param {string}  base64EncodedSVG    The Base64 encoded svg string to convert
- * @param {number}  maxWidth            The max width(px) of the output PNG
- * @param {number}  maxHeight           The max height(px) of the output PNG
- * @returns {Promise<string>}    A Base64 encoded PNG, scaled to the given parameters
+ * @param params The parameters object
+ * @param params.base64EncodedSVG The Base64 encoded svg string to convert
+ * @param params.maxWidth The max width(px) of the output PNG
+ * @param params.maxHeight The max height(px) of the output PNG
+ * @param params.idealArea The ideal area for the image
+ * @returns {Promise<string>} A Base64 encoded PNG, scaled to the given parameters
  */
 const svgToPNG = async ({ base64EncodedSVG, maxWidth, maxHeight, idealArea, }) => {
     const [image, dimensions] = await Promise.all([

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@trackunit/shared-utils",
-  "version": "1.8.50",
+  "version": "1.8.54",
   "repository": "https://github.com/Trackunit/manager",
   "engines": {
     "node": ">=22.x"
@@ -8,7 +8,8 @@
   "license": "SEE LICENSE IN LICENSE.txt",
   "dependencies": {
     "uuid": "^11.1.0",
-    "@trackunit/react-test-setup": "1.3.50"
+    "@trackunit/react-test-setup": "1.3.53",
+    "zod": "^3.23.8"
   },
   "module": "./index.esm.js",
   "main": "./index.cjs.js",

package/src/DateTimeFormat.d.ts

@@ -1,10 +1,11 @@
-export declare enum HoursAndMinutesFormat {
-    HOURS_MIN_SEC_LONG = "HOURS_MIN_SEC_LONG",// h [h] mm [min] ss [sec]
-    HOURS_MIN_SEC = "HOURS_MIN_SEC",// h[h] m[m] s[s]
-    HOURS_MIN_LONG = "HOURS_MIN_LONG",// h [hrs] mm [min]
-    HOURS_MIN = "HOURS_MIN",// h[h] m[m]
-    HOURS_LONG = "HOURS_LONG"
-}
+export declare const HoursAndMinutesFormat: {
+    readonly HOURS_MIN_SEC_LONG: "HOURS_MIN_SEC_LONG";
+    readonly HOURS_MIN_SEC: "HOURS_MIN_SEC";
+    readonly HOURS_MIN_LONG: "HOURS_MIN_LONG";
+    readonly HOURS_MIN: "HOURS_MIN";
+    readonly HOURS_LONG: "HOURS_LONG";
+};
+export type HoursAndMinutesFormatType = (typeof HoursAndMinutesFormat)[keyof typeof HoursAndMinutesFormat];
 export declare const DateTimeFormat: {
     readonly DATE: {
         readonly selectFormat: "dateOnly";

package/src/DateUtils.d.ts

@@ -19,11 +19,11 @@ export declare const getDifferenceBetweenDates: (date1: Date, date2: Date, unit:
  * @returns {Date} The start of the day for the given date.
  * @example getStartOfDay(new Date("2021-05-19T12:34:56")) // "2021-05-19T00:00:00"
  */
-export declare const getStartOfDay: <T extends string | number | Date>(date: T) => Date;
+export declare const getStartOfDay: <TDate extends string | number | Date>(date: TDate) => Date;
 /**
  * @description Returns the end of the day for a given date.
  * @param date A date object or a date string.
  * @returns {Date} The end of the day for the given date.
  * @example getEndOfDay(new Date("2021-05-19T12:34:56")) // "2021-05-19T23:59:59"
  */
-export declare const getEndOfDay: <T extends string | number | Date>(date: T) => Date;
+export declare const getEndOfDay: <TDate extends string | number | Date>(date: TDate) => Date;

package/src/Maybe.d.ts

@@ -1,4 +1,4 @@
 /**
  * Maybe type
  */
-export type Maybe<T> = T | null;
+export type Maybe<TValue> = TValue | null;

package/src/arrayUtils.d.ts

@@ -1,10 +1,11 @@
 /**
  * Returns a new array with the items from the previous array and the new array, but only if the item's key is unique.
  *
+ * @template TObject - the type of the items in the array
  * @param key   The key to use to determine uniqueness
  * @param previous The previous array of items to merge with the new array
  * @param newArray The new array of items to merge with the previous array
- * @returns A new array with the items from the previous array and the new array, but only if the item's key is unique.
+ * @returns {Array<TObject>} A new array with the items from the previous array and the new array, but only if the item's key is unique.
  */
 export declare const unionArraysByKey: <TObject extends object>(key: keyof TObject, previous: Array<TObject> | undefined | null, newArray: Array<TObject> | undefined | null) => Array<TObject>;
 /**
@@ -14,7 +15,8 @@ export declare const isArrayEqual: <TItem extends string | number>(a: Array<TIte
 /**
  * Checks if an array is not empty.
  *
+ * @template TItem
  * @param array - The array to check.
- * @returns The array if not empty, otherwise undefined.
+ * @returns {Array<TItem> | undefined} The array if not empty, otherwise undefined.
  */
 export declare const arrayNotEmpty: <TItem>(array?: Array<TItem>) => Array<TItem> | undefined;

package/src/deepPartial.d.ts

@@ -1,4 +1,4 @@
-export type DeepPartialNullable<T> = T extends Array<any> ? DeepPartialNullableArray<T[number]> : T extends object ? {
-    [P in keyof T]?: DeepPartialNullable<T[P]> | null;
-} : T | null;
-export type DeepPartialNullableArray<T> = Array<DeepPartialNullable<T>>;
+export type DeepPartialNullable<TObject> = TObject extends Array<unknown> ? DeepPartialNullableArray<TObject[number]> : TObject extends object ? {
+    [P in keyof TObject]?: DeepPartialNullable<TObject[P]> | null;
+} : TObject | null;
+export type DeepPartialNullableArray<TItem> = Array<DeepPartialNullable<TItem>>;

package/src/enumUtils.d.ts

@@ -6,7 +6,7 @@
  * @returns {Record<string, string>} The enum value.
  * @example enumFromValue("MACHINE", AssetType) // AssetType.MACHINE
  */
-export declare const enumFromValue: <T extends Record<string, string | number>>(val: string | number, _enum: T) => T[keyof T];
+export declare const enumFromValue: <TEnum extends Record<string, string | number>>(val: string | number, _enum: TEnum) => TEnum[keyof TEnum];
 /**
  * Returns the enum value from a string value or undefined if the string value is undefined or null.
  *
@@ -15,7 +15,7 @@ export declare const enumFromValue: <T extends Record<string, string | number>>(
  * @returns {Record<string, string> | undefined} The enum value or undefined.
  * @example enumFromValue("MACHINE", AssetType) // AssetType.MACHINE
  */
-export declare const enumOrUndefinedFromValue: <T extends Record<string, string>>(_enum: T, val?: string | null) => T[keyof T] | undefined;
+export declare const enumOrUndefinedFromValue: <TEnum extends Record<string, string>>(_enum: TEnum, val?: string | null) => TEnum[keyof TEnum] | undefined;
 /**
  * Returns the enum value from a string value or undefined if the string value is undefined or null.
  * This is a typesafe version of enumOrUndefinedFromValue.
@@ -25,4 +25,4 @@ export declare const enumOrUndefinedFromValue: <T extends Record<string, string>
  * @returns {Record<string, string> | undefined} The enum value or undefined.
  * @example enumFromValue("MACHINE", AssetType) // AssetType.MACHINE
  */
-export declare const enumFromValueTypesafe: <T extends Record<string, string>>(val: keyof T, _enum: T) => T[keyof T];
+export declare const enumFromValueTypesafe: <TEnum extends Record<string, string>>(val: keyof TEnum, _enum: TEnum) => TEnum[keyof TEnum];

package/src/fastArrayOperations.d.ts

@@ -1,14 +1,16 @@
 /**
  *
+ * @template TItem
  * @param arr1 An array of string or numbers
  * @param arr2 An array of string or numbers
- * @returns The elements shared between arr1 and arr2.
+ * @returns {Array<TItem>} The elements shared between arr1 and arr2.
  */
-export declare function intersection<T>(arr1: Array<T>, arr2: Array<T>): Array<T>;
+export declare function intersection<TItem>(arr1: Array<TItem>, arr2: Array<TItem>): Array<TItem>;
 /**
  *
+ * @template TItem
  * @param arr1 An array of string or numbers
  * @param arr2 An array of string or numbers
- * @returns The elements present in arr1 but not arr2.
+ * @returns {Array<TItem>} The elements present in arr1 but not arr2.
  */
-export declare function difference<T>(arr1: Array<T>, arr2: Array<T>): Array<T>;
+export declare function difference<TItem>(arr1: Array<TItem>, arr2: Array<TItem>): Array<TItem>;

package/src/filter.d.ts

@@ -11,20 +11,20 @@ import { Maybe } from "./Maybe";
  * @returns {[]} The filtered array
  * @example filterByMultiple([{ name: "John", surname: "Doe" }, { name: "Jane", surname: "Doe" }], [p => p.name, p => p.surname], "John") // [{ name: "John", surname: "Doe" }]
  */
-export declare function filterByMultiple<T>(array: Array<T> | null | undefined, props: (p: T) => Array<Maybe<string> | undefined> | null | undefined, match: string): Array<T>;
+export declare function filterByMultiple<TItem>(array: Array<TItem> | null | undefined, props: (p: TItem) => Array<Maybe<string> | undefined> | null | undefined, match: string): Array<TItem>;
 /**
  * Filter an array of items based on a list of properties and a search term.
  * The provided properties will be matched based on the term split on space.
  * All terms must have at least one match
  * The terms can match the same property multiple times
  */
-export declare const fuzzySearch: <T>(
+export declare const fuzzySearch: <TItem>(
 /** The elements that should be filtered  */
-elementsToFilter: Array<T>, 
+elementsToFilter: Array<TItem>, 
 /**
  * A function to run on each element
  * to get an array of strings which should be matched
  */
-filterableProps: (element: T) => Array<string>, 
+filterableProps: (element: TItem) => Array<string>, 
 /** A string of the search to match against the element props*/
-searchTerm: string) => Array<T>;
+searchTerm: string) => Array<TItem>;

package/src/groupBy/groupBy.d.ts

@@ -1,13 +1,13 @@
 /**
  * Group an array of items by a key.
  *
- * @template T The type of items in the list.
- * @template K The type of the key.
- * @param {T[]} list The array of items to group.
- * @param {(item: T) => K} getKey A function to get the key to group by.
- * @returns {Map<K, T[]>} A map of the items grouped by the key.
+ * @template TItem The type of items in the list.
+ * @template KeyGroup The type of the key.
+ * @param {TItem[]} list The array of items to group.
+ * @param {(item: TItem) => KeyGroup} getKey A function to get the key to group by.
+ * @returns {Map<KeyGroup, TItem[]>} A map of the items grouped by the key.
  * @example
  * groupBy([{ name: "John", surname: "Doe" }, { name: "Jane", surname: "Doe" }], p => p.surname)
  * Returns: Map { "Doe" => [{ name: "John", surname: "Doe" }, { name: "Jane", surname: "Doe" }] }
  */
-export declare function groupBy<T, K>(list: Array<T>, getKey: (item: T) => K): Map<K, Array<T>>;
+export declare function groupBy<TItem, KeyGroup>(list: Array<TItem>, getKey: (item: TItem) => KeyGroup): Map<KeyGroup, Array<TItem>>;

package/src/idUtils.d.ts

@@ -21,6 +21,6 @@ export declare const toID: (uuid: string) => number;
  * A helper function that converts a list of UUID to a list of valid machine IDs.
  * NOTE that NaN will be removed so list cannot be expected to be of same size.
  *
- * @param uuid The list of UUIDs that should be converted to a list of valid machine IDs
+ * @param ids The list of UUIDs that should be converted to a list of valid machine IDs
  */
-export declare const toIDs: (ids: Array<string> | null | undefined) => number[];
+export declare const toIDs: (ids: Array<string> | null | undefined) => Array<number>;

package/src/imageTools.d.ts

@@ -11,7 +11,7 @@ export interface ImageDimensions {
  * @param {number} options.maxHeight - The maximum height of the converted PNG image.
  * @param {number} options.maxWidth - The maximum width of the converted PNG image.
  * @param {number} options.idealArea - The ideal area of the converted PNG image.
- * @returns The converted PNG image as a data URL.
+ * @returns {string} The converted PNG image as a data URL.
  * @throws Error if unable to get the canvas context.
  */
 export declare const toPNG: ({ image, dimensions, maxHeight, maxWidth, idealArea, }: {

package/src/objectUtils.d.ts

@@ -2,22 +2,23 @@ import { MappedOmit } from "./typeUtils";
 /**
  * Deletes all undefined keys from an object.
  *
- * @param obj The object to delete undefined keys from.
- * @returns The object without undefined keys.
+ * @template TObject
+ * @param {TObject} obj The object to delete undefined keys from.
  * @example deleteUndefinedKeys({ a: 1, b: undefined }) // { a: 1 }
+ * @returns {TObject} The object without undefined keys.
  */
-export declare const deleteUndefinedKeys: <T extends Record<string, unknown>>(obj: T) => T;
+export declare const deleteUndefinedKeys: <TObject extends Record<string, unknown>>(obj: TObject) => TObject;
 /**
  * Checks if an object is not empty.
  *
- * @param obj - The object to check.
- * @returns The object if not empty, otherwise undefined.
+ * @template TObject * @param obj - The object to check.
+ * @returns {TObject | undefined} The object if not empty, otherwise undefined.
  */
-export declare const objNotEmpty: <T extends object>(obj?: T) => T | undefined;
+export declare const objNotEmpty: <TObject extends object>(obj?: TObject) => TObject | undefined;
 /**
  *  Picks the given keys from an object, typesafe.
  */
-export declare const pick: <T, K extends keyof T>(obj: T, ...keys: Array<K>) => Pick<T, K>;
+export declare const pick: <TObject, KeyObject extends keyof TObject>(obj: TObject, ...keys: Array<KeyObject>) => Pick<TObject, KeyObject>;
 /**
  * Returns an object with only the differences between two input objects.
  * Not recursive, only compares first level properties.

package/src/pictureUtils/pictureUtils.d.ts

@@ -1,4 +1,4 @@
-interface IResizeImageOptions {
+interface ResizeImageOptions {
     maxSize: number;
     file: File;
 }
@@ -22,7 +22,7 @@ export declare const getResizedDimensions: (width: number, height: number, maxWi
 /**
  * Resize an image to be no larger than the maxSize on each dimension
  */
-export declare const resizeImage: (settings: IResizeImageOptions) => Promise<Blob>;
+export declare const resizeImage: (settings: ResizeImageOptions) => Promise<Blob>;
 /**
  * Convert a blob to a base64 string
  *

package/src/sorting/sorting.d.ts

@@ -26,7 +26,7 @@ export declare const stringNaturalCompare: (a?: Maybe<string>, b?: Maybe<string>
  * @example stringCompare("a", "b") // -1
  * @example stringCompareFromKey("a", "b") // -1
  */
-export declare const stringCompareFromKey: <T>(key: keyof T) => (a: T, b: T) => number;
+export declare const stringCompareFromKey: <TObject>(key: keyof TObject) => (a: TObject, b: TObject) => number;
 /**
  * Compare two dates
  *
@@ -70,7 +70,7 @@ export declare const numberCompareUnknownAfterHighest: (a?: Maybe<number>, b?: M
  * @example arrayCompare([1, 2], [1, 2], numberCompare) // 0
  * @example arrayCompare([1, 3], [1, 2], numberCompare) // 1
  */
-export declare const arrayLengthCompare: <T>(a?: Maybe<Array<T>>, b?: Maybe<Array<T>>) => number;
+export declare const arrayLengthCompare: <TItem>(a?: Maybe<Array<TItem>>, b?: Maybe<Array<TItem>>) => number;
 /**
  * Compare two booleans
  *

package/src/svgTools.d.ts

@@ -12,7 +12,7 @@ export declare const colorsFromStyleDeclaration: (styles: CSSStyleDeclaration) =
  * Loads the dimensions of an SVG string.
  *
  * @param base64EncodedSVG The SVG string to load dimensions from.
- * @returns A promise that resolves to an object containing the width and height of the SVG.
+ * @returns {Promise<ImageDimensions>} A promise that resolves to an object containing the width and height of the SVG.
  * @throws {Error} If the SVG string is invalid or the dimensions cannot be determined.
  */
 export declare const loadSVGDimensions: (base64EncodedSVG: string) => Promise<ImageDimensions>;
@@ -23,10 +23,12 @@ export declare const getAllColors: (base64EncodedSVG: string) => Array<string>;
 /**
  * Converts a Base64 encoded SVG to a Scaled Base64 PNG.
  *
- * @param {string}  base64EncodedSVG    The Base64 encoded svg string to convert
- * @param {number}  maxWidth            The max width(px) of the output PNG
- * @param {number}  maxHeight           The max height(px) of the output PNG
- * @returns {Promise<string>}    A Base64 encoded PNG, scaled to the given parameters
+ * @param params The parameters object
+ * @param params.base64EncodedSVG The Base64 encoded svg string to convert
+ * @param params.maxWidth The max width(px) of the output PNG
+ * @param params.maxHeight The max height(px) of the output PNG
+ * @param params.idealArea The ideal area for the image
+ * @returns {Promise<string>} A Base64 encoded PNG, scaled to the given parameters
  */
 export declare const svgToPNG: ({ base64EncodedSVG, maxWidth, maxHeight, idealArea, }: {
     base64EncodedSVG: string;

package/src/typeUtils.d.ts

@@ -114,7 +114,7 @@ export declare const objectKeys: <TObject extends Record<PropertyKey, unknown>>(
  *
  * @template TObject - The type of the object.
  * @param {TObject} object - The object to get the values from.
- * @returns {TObject[keyof TObject][]} An array of the values of the object.
+ * @returns {Array} An array of the values of the object.
  */
 export declare const objectValues: <TObject extends Record<PropertyKey, unknown>>(object: TObject) => Array<TObject[keyof TObject]>;
 export {};