@trackunit/shared-utils 1.15.52 → 1.15.53

package/index.cjs.js

@@ -936,6 +936,17 @@ const convertBlobToBase64 = (blob) => {
  */
 const isValidImage = (file) => (file.type.match(/image.*/) ? true : false);
 
+/**
+ * Type guard that checks whether a string is a recognised sorting property.
+ *
+ * @param sortingState - Array of valid sort property names.
+ * @param value - The value to check.
+ * @returns {boolean} `true` when {@link value} matches one of the entries in {@link sortingState}.
+ */
+const isSortByProperty = (sortingState, value) => {
+    const sortByPropertyValidated = sortingState.find(validName => validName === value);
+    return !!sortByPropertyValidated;
+};
 /**
  * Compare two strings
  *
@@ -1605,6 +1616,7 @@ exports.groupTinyDataToOthers = groupTinyDataToOthers;
 exports.hourIntervals = hourIntervals;
 exports.intersection = intersection;
 exports.isArrayEqual = isArrayEqual;
+exports.isSortByProperty = isSortByProperty;
 exports.isSorted = isSorted;
 exports.isUUID = isUUID;
 exports.isValidImage = isValidImage;

package/index.esm.js

@@ -934,6 +934,17 @@ const convertBlobToBase64 = (blob) => {
  */
 const isValidImage = (file) => (file.type.match(/image.*/) ? true : false);
 
+/**
+ * Type guard that checks whether a string is a recognised sorting property.
+ *
+ * @param sortingState - Array of valid sort property names.
+ * @param value - The value to check.
+ * @returns {boolean} `true` when {@link value} matches one of the entries in {@link sortingState}.
+ */
+const isSortByProperty = (sortingState, value) => {
+    const sortByPropertyValidated = sortingState.find(validName => validName === value);
+    return !!sortByPropertyValidated;
+};
 /**
  * Compare two strings
  *
@@ -1556,4 +1567,4 @@ const formatUsCustomaryDistance = (value) => {
     }
 };
 
-export { DateTimeFormat, HoursAndMinutesFormat, UnitsOfMeasurementSI, UnitsOfMeasurementUSCustomary, VISIBLE_ONLY_COLUMN_VISIBILITY_KEY, align, alphabeticallySort, arrayLengthCompare, arrayNotEmpty, booleanCompare, calculateImageScaleRatio, capitalize, colorsFromStyleDeclaration, convertBlobToBase64, convertMetersToKilometers, convertMetersToYards, convertYardsToMeters, convertYardsToMiles, dateCompare, deleteUndefinedKeys, difference, doNothing, enumFromValue, enumFromValueTypesafe, enumOrUndefinedFromValue, exhaustiveCheck, fetchImageAsBase64, filterByMultiple, formatAddress, formatCoordinates, formatSiDistance, formatUsCustomaryDistance, fuzzySearch, getAllColors, getDifferenceBetweenDates, getEndOfDay, getFirstLevelObjectPropertyDifferences, getISOStringFromDate, getLoremIpsum, getMimeTypeFromDataURL, getResizedDimensions, getStartOfDay, groupBy, groupTinyDataToOthers, hourIntervals, intersection, isArrayEqual, isSorted, isUUID, isValidImage, loadSVGDimensions, nonNullable, numberCompare, numberCompareUnknownAfterHighest, objNotEmpty, objectEntries, objectFromEntries, objectKeys, objectValues, parseTailwindArbitraryValue, pick, preload, removeLeftPadding, removeProperties, removeProperty, replaceNullableNumbersWithZero, resizeBlob, resizeImage, rgb2hex, size, stringCompare, stringCompareFromKey, stringNaturalCompare, stripHiddenCharacters, svgToPNG, titleCase, toID, toIDs, toPNG, toUUID, trimIds, trimPath, truthy, unionArraysByKey, uuidv3, uuidv4, uuidv5 };
+export { DateTimeFormat, HoursAndMinutesFormat, UnitsOfMeasurementSI, UnitsOfMeasurementUSCustomary, VISIBLE_ONLY_COLUMN_VISIBILITY_KEY, align, alphabeticallySort, arrayLengthCompare, arrayNotEmpty, booleanCompare, calculateImageScaleRatio, capitalize, colorsFromStyleDeclaration, convertBlobToBase64, convertMetersToKilometers, convertMetersToYards, convertYardsToMeters, convertYardsToMiles, dateCompare, deleteUndefinedKeys, difference, doNothing, enumFromValue, enumFromValueTypesafe, enumOrUndefinedFromValue, exhaustiveCheck, fetchImageAsBase64, filterByMultiple, formatAddress, formatCoordinates, formatSiDistance, formatUsCustomaryDistance, fuzzySearch, getAllColors, getDifferenceBetweenDates, getEndOfDay, getFirstLevelObjectPropertyDifferences, getISOStringFromDate, getLoremIpsum, getMimeTypeFromDataURL, getResizedDimensions, getStartOfDay, groupBy, groupTinyDataToOthers, hourIntervals, intersection, isArrayEqual, isSortByProperty, isSorted, isUUID, isValidImage, loadSVGDimensions, nonNullable, numberCompare, numberCompareUnknownAfterHighest, objNotEmpty, objectEntries, objectFromEntries, objectKeys, objectValues, parseTailwindArbitraryValue, pick, preload, removeLeftPadding, removeProperties, removeProperty, replaceNullableNumbersWithZero, resizeBlob, resizeImage, rgb2hex, size, stringCompare, stringCompareFromKey, stringNaturalCompare, stripHiddenCharacters, svgToPNG, titleCase, toID, toIDs, toPNG, toUUID, trimIds, trimPath, truthy, unionArraysByKey, uuidv3, uuidv4, uuidv5 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@trackunit/shared-utils",
-  "version": "1.15.52",
+  "version": "1.15.53",
   "repository": "https://github.com/Trackunit/manager",
   "engines": {
     "node": ">=24.x"

package/src/sorting/sorting.d.ts

@@ -1,4 +1,12 @@
 import { Maybe } from "../Maybe";
+/**
+ * Type guard that checks whether a string is a recognised sorting property.
+ *
+ * @param sortingState - Array of valid sort property names.
+ * @param value - The value to check.
+ * @returns {boolean} `true` when {@link value} matches one of the entries in {@link sortingState}.
+ */
+export declare const isSortByProperty: <TSortByType extends string>(sortingState: Array<TSortByType>, value?: string) => value is TSortByType;
 /**
  * Compare two strings
  *