@trackunit/shared-utils 0.0.60 → 0.0.62

package/index.cjs.js

@@ -306,20 +306,6 @@ const objectValues = (object) =>
 // eslint-disable-next-line local-rules/no-typescript-assertion, local-rules/prefer-custom-object-values
 Object.values(object);
 
-/** toggle whether a value is in an array or not */
-function toggle(array, value) {
-    if (value && (array === null || array === void 0 ? void 0 : array.includes(value))) {
-        return array.filter(item => item !== value);
-    }
-    return [...(array || []), value];
-}
-/** Ensure the argument is an array, if not, create array with that element in it */
-function ensureArray(arrayish) {
-    if (!arrayish) {
-        return [];
-    }
-    return Array.isArray(arrayish) ? arrayish : [arrayish];
-}
 /**
  * Returns a new array with the items from the previous array and the new array, but only if the item's key is unique.
  *
@@ -341,15 +327,17 @@ const unionArraysByKey = (key, previous, newArray) => {
     })
         .filter(truthy);
 };
-/** Ensures if an array is equal to another array */
-const isStringArrayEqual = (first = [], second = []) => first.length === second.length && first.every((val, i) => val === second[i]);
+/**
+ * Checks if two arrays are equal.
+ */
+const isArrayEqual = (a, b) => a.length === b.length && a.every((v, i) => v === b[i]);
 /**
  * Checks if an array is not empty.
  *
  * @param array - The array to check.
  * @returns The array if not empty, otherwise undefined.
  */
-const arrayNotEmpty = (array) => (array && array.length > 0 ? array : undefined);
+const arrayNotEmpty = (array) => array && array.length > 0 ? array : undefined;
 
 const align = {
     LEFT: "left",
@@ -1095,7 +1083,6 @@ exports.dateCompare = dateCompare;
 exports.deleteUndefinedKeys = deleteUndefinedKeys;
 exports.difference = difference;
 exports.doNothing = doNothing;
-exports.ensureArray = ensureArray;
 exports.enumFromValue = enumFromValue;
 exports.enumFromValueTypesafe = enumFromValueTypesafe;
 exports.enumOrUndefinedFromValue = enumOrUndefinedFromValue;
@@ -1115,8 +1102,8 @@ exports.groupBy = groupBy;
 exports.groupTinyDataToOthers = groupTinyDataToOthers;
 exports.hourIntervals = hourIntervals;
 exports.intersection = intersection;
+exports.isArrayEqual = isArrayEqual;
 exports.isSorted = isSorted;
-exports.isStringArrayEqual = isStringArrayEqual;
 exports.isUUID = isUUID;
 exports.isValidImage = isValidImage;
 exports.nonNullable = nonNullable;
@@ -1139,7 +1126,6 @@ exports.titleCase = titleCase;
 exports.toID = toID;
 exports.toIDs = toIDs;
 exports.toUUID = toUUID;
-exports.toggle = toggle;
 exports.trimIds = trimIds;
 exports.trimPath = trimPath;
 exports.truthy = truthy;

package/index.esm.js

@@ -302,20 +302,6 @@ const objectValues = (object) =>
 // eslint-disable-next-line local-rules/no-typescript-assertion, local-rules/prefer-custom-object-values
 Object.values(object);
 
-/** toggle whether a value is in an array or not */
-function toggle(array, value) {
-    if (value && (array === null || array === void 0 ? void 0 : array.includes(value))) {
-        return array.filter(item => item !== value);
-    }
-    return [...(array || []), value];
-}
-/** Ensure the argument is an array, if not, create array with that element in it */
-function ensureArray(arrayish) {
-    if (!arrayish) {
-        return [];
-    }
-    return Array.isArray(arrayish) ? arrayish : [arrayish];
-}
 /**
  * Returns a new array with the items from the previous array and the new array, but only if the item's key is unique.
  *
@@ -337,15 +323,17 @@ const unionArraysByKey = (key, previous, newArray) => {
     })
         .filter(truthy);
 };
-/** Ensures if an array is equal to another array */
-const isStringArrayEqual = (first = [], second = []) => first.length === second.length && first.every((val, i) => val === second[i]);
+/**
+ * Checks if two arrays are equal.
+ */
+const isArrayEqual = (a, b) => a.length === b.length && a.every((v, i) => v === b[i]);
 /**
  * Checks if an array is not empty.
  *
  * @param array - The array to check.
  * @returns The array if not empty, otherwise undefined.
  */
-const arrayNotEmpty = (array) => (array && array.length > 0 ? array : undefined);
+const arrayNotEmpty = (array) => array && array.length > 0 ? array : undefined;
 
 const align = {
     LEFT: "left",
@@ -1077,4 +1065,4 @@ const isSorted = (sortInput) => {
     return originalKeys.every((key, index) => key === sortedKeys[index]);
 };
 
-export { DateTimeFormat, HoursAndMinutesFormat, align, alphabeticallySort, arrayLengthCompare, arrayNotEmpty, booleanCompare, capitalize, convertBlobToBase64, convertMetersToYards, convertYardsToMeters, dateCompare, deleteUndefinedKeys, difference, doNothing, ensureArray, enumFromValue, enumFromValueTypesafe, enumOrUndefinedFromValue, exhaustiveCheck, filterByMultiple, formatAddress, formatCoordinates, fuzzySearch, getDifferenceBetweenDates, getEndOfDay, getISOStringFromDate, getMultipleCoordinatesFromGeoJsonObject, getPointCoordinateFromGeoJsonObject, getResizedDimensions, getStartOfDay, groupBy, groupTinyDataToOthers, hourIntervals, intersection, isSorted, isStringArrayEqual, isUUID, isValidImage, nonNullable, numberCompare, numberCompareUnknownAfterHighest, objNotEmpty, objectEntries, objectFromEntries, objectKeys, objectValues, pick, removeLeftPadding, resizeBlob, resizeImage, size, stringCompare, stringCompareFromKey, stringNaturalCompare, titleCase, toID, toIDs, toUUID, toggle, trimIds, trimPath, truthy, unionArraysByKey };
+export { DateTimeFormat, HoursAndMinutesFormat, align, alphabeticallySort, arrayLengthCompare, arrayNotEmpty, booleanCompare, capitalize, convertBlobToBase64, convertMetersToYards, convertYardsToMeters, dateCompare, deleteUndefinedKeys, difference, doNothing, enumFromValue, enumFromValueTypesafe, enumOrUndefinedFromValue, exhaustiveCheck, filterByMultiple, formatAddress, formatCoordinates, fuzzySearch, getDifferenceBetweenDates, getEndOfDay, getISOStringFromDate, getMultipleCoordinatesFromGeoJsonObject, getPointCoordinateFromGeoJsonObject, getResizedDimensions, getStartOfDay, groupBy, groupTinyDataToOthers, hourIntervals, intersection, isArrayEqual, isSorted, isUUID, isValidImage, nonNullable, numberCompare, numberCompareUnknownAfterHighest, objNotEmpty, objectEntries, objectFromEntries, objectKeys, objectValues, pick, removeLeftPadding, resizeBlob, resizeImage, size, stringCompare, stringCompareFromKey, stringNaturalCompare, titleCase, toID, toIDs, toUUID, trimIds, trimPath, truthy, unionArraysByKey };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@trackunit/shared-utils",
-  "version": "0.0.60",
+  "version": "0.0.62",
   "repository": "https://github.com/Trackunit/manager",
   "license": "SEE LICENSE IN LICENSE.txt",
   "engines": {

package/src/arrayUtils.d.ts

@@ -1,7 +1,3 @@
-/** toggle whether a value is in an array or not */
-export declare function toggle<T>(array: T[] | null | undefined, value: T | null | undefined): T[];
-/** Ensure the argument is an array, if not, create array with that element in it */
-export declare function ensureArray<T>(arrayish: T | T[]): T[];
 /**
  * Returns a new array with the items from the previous array and the new array, but only if the item's key is unique.
  *
@@ -10,13 +6,15 @@ export declare function ensureArray<T>(arrayish: T | T[]): T[];
  * @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.
  */
-export declare const unionArraysByKey: <T extends object>(key: keyof T, previous: T[] | undefined | null, newArray: T[] | undefined | null) => T[];
-/** Ensures if an array is equal to another array */
-export declare const isStringArrayEqual: (first?: string[], second?: string[]) => boolean;
+export declare const unionArraysByKey: <TObject extends object>(key: keyof TObject, previous: TObject[] | undefined | null, newArray: TObject[] | undefined | null) => TObject[];
+/**
+ * Checks if two arrays are equal.
+ */
+export declare const isArrayEqual: <TItem extends string | number>(a: TItem[], b: TItem[]) => boolean;
 /**
  * Checks if an array is not empty.
  *
  * @param array - The array to check.
  * @returns The array if not empty, otherwise undefined.
  */
-export declare const arrayNotEmpty: <T>(array?: T[]) => T[] | undefined;
+export declare const arrayNotEmpty: <TItem>(array?: TItem[]) => TItem[] | undefined;

package/src/typeUtils.d.ts

@@ -1,3 +1,6 @@
+export type Nullable<TObject> = {
+    [K in keyof TObject]: TObject[K] | null;
+};
 /**
  * Use with filter() to remove null and undefined from an array
  *