@trackunit/shared-utils 0.0.13 → 0.0.15

package/index.cjs.js

@@ -133,6 +133,34 @@ const getMultipleCoordinatesFromGeoJsonObject = (geoObject) => {
     }
 };
 
+/**
+ * Group data that has smaller count then 0.5% (smallestCount) of total count if there is more than 3% (limitToStartGrouping) of them to "Others" group.
+ * It can help charts to look better.
+ *
+ * @param data Input data
+ * @param smallestCount Breaking point to start considering the item as candidate to "Others" group [in percentage] - default 0,5%
+ * @param limitToStartGrouping Lowest limit of candidates for grouping to "Others" [in percentage] - default 3%
+ */
+function groupTinyDataToOthers(data, smallestCount = 0.5, limitToStartGrouping = 3) {
+    if (!data || data.length < 2) {
+        return data;
+    }
+    const breakingPoint = (data.reduce((x, y) => ({ key: "GroupedOthers", count: x.count + y.count })).count * smallestCount) / 100;
+    if (data.filter(x => x.count <= breakingPoint).length < 2) {
+        return data;
+    }
+    const others = data
+        .filter(x => x.count <= breakingPoint)
+        .reduce((x, y) => ({ key: "GroupedOthers", count: x.count + y.count }));
+    const canGroupToOthers = others.count / data.reduce((x, y) => ({ key: "GroupedOthers", count: x.count + y.count })).count >
+        limitToStartGrouping / 100;
+    if (!canGroupToOthers) {
+        return data;
+    }
+    const temp = data.filter(x => x.count > breakingPoint);
+    return [...temp, others].sort((a, b) => a.count - b.count);
+}
+
 /**
  * Converts meters to yards
  *
@@ -423,24 +451,28 @@ searchTerm) => {
 /**
  * Group an array of items by a key.
  *
- * @param list The array of items to group.
- * @param getKey A function to get the key to group by.
- * @returns A map of the items grouped by the key.
- * @example groupBy([{ name: "John", surname: "Doe" }, { name: "Jane", surname: "Doe" }], p => p.surname) // Map { "Doe" => [{ name: "John", surname: "Doe" }, { name: "Jane", surname: "Doe" }] }
+ * @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.
+ * @example
+ * groupBy([{ name: "John", surname: "Doe" }, { name: "Jane", surname: "Doe" }], p => p.surname)
+ * Returns: Map { "Doe" => [{ name: "John", surname: "Doe" }, { name: "Jane", surname: "Doe" }] }
  */
 function groupBy(list, getKey) {
-    const map = new Map();
+    const groupedMap = new Map();
     list.forEach(item => {
         const key = getKey(item);
-        const collection = map.get(key);
+        const collection = groupedMap.get(key);
         if (!collection) {
-            map.set(key, [item]);
+            groupedMap.set(key, [item]);
         }
         else {
             collection.push(item);
         }
     });
-    return map;
+    return groupedMap;
 }
 
 const UUID_HYPHEN_POSITIONS = [8, 12, 16, 20];
@@ -961,6 +993,7 @@ exports.getPointCoordinateFromGeoJsonObject = getPointCoordinateFromGeoJsonObjec
 exports.getResizedDimensions = getResizedDimensions;
 exports.getStartOfDay = getStartOfDay;
 exports.groupBy = groupBy;
+exports.groupTinyDataToOthers = groupTinyDataToOthers;
 exports.hourIntervals = hourIntervals;
 exports.intersection = intersection;
 exports.isStringArrayEqual = isStringArrayEqual;

package/index.esm.js

@@ -129,6 +129,34 @@ const getMultipleCoordinatesFromGeoJsonObject = (geoObject) => {
     }
 };
 
+/**
+ * Group data that has smaller count then 0.5% (smallestCount) of total count if there is more than 3% (limitToStartGrouping) of them to "Others" group.
+ * It can help charts to look better.
+ *
+ * @param data Input data
+ * @param smallestCount Breaking point to start considering the item as candidate to "Others" group [in percentage] - default 0,5%
+ * @param limitToStartGrouping Lowest limit of candidates for grouping to "Others" [in percentage] - default 3%
+ */
+function groupTinyDataToOthers(data, smallestCount = 0.5, limitToStartGrouping = 3) {
+    if (!data || data.length < 2) {
+        return data;
+    }
+    const breakingPoint = (data.reduce((x, y) => ({ key: "GroupedOthers", count: x.count + y.count })).count * smallestCount) / 100;
+    if (data.filter(x => x.count <= breakingPoint).length < 2) {
+        return data;
+    }
+    const others = data
+        .filter(x => x.count <= breakingPoint)
+        .reduce((x, y) => ({ key: "GroupedOthers", count: x.count + y.count }));
+    const canGroupToOthers = others.count / data.reduce((x, y) => ({ key: "GroupedOthers", count: x.count + y.count })).count >
+        limitToStartGrouping / 100;
+    if (!canGroupToOthers) {
+        return data;
+    }
+    const temp = data.filter(x => x.count > breakingPoint);
+    return [...temp, others].sort((a, b) => a.count - b.count);
+}
+
 /**
  * Converts meters to yards
  *
@@ -419,24 +447,28 @@ searchTerm) => {
 /**
  * Group an array of items by a key.
  *
- * @param list The array of items to group.
- * @param getKey A function to get the key to group by.
- * @returns A map of the items grouped by the key.
- * @example groupBy([{ name: "John", surname: "Doe" }, { name: "Jane", surname: "Doe" }], p => p.surname) // Map { "Doe" => [{ name: "John", surname: "Doe" }, { name: "Jane", surname: "Doe" }] }
+ * @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.
+ * @example
+ * groupBy([{ name: "John", surname: "Doe" }, { name: "Jane", surname: "Doe" }], p => p.surname)
+ * Returns: Map { "Doe" => [{ name: "John", surname: "Doe" }, { name: "Jane", surname: "Doe" }] }
  */
 function groupBy(list, getKey) {
-    const map = new Map();
+    const groupedMap = new Map();
     list.forEach(item => {
         const key = getKey(item);
-        const collection = map.get(key);
+        const collection = groupedMap.get(key);
         if (!collection) {
-            map.set(key, [item]);
+            groupedMap.set(key, [item]);
         }
         else {
             collection.push(item);
         }
     });
-    return map;
+    return groupedMap;
 }
 
 const UUID_HYPHEN_POSITIONS = [8, 12, 16, 20];
@@ -928,4 +960,4 @@ const titleCase = (s) => {
  */
 const removeLeftPadding = (id) => Number(id === null || id === void 0 ? void 0 : id.replace(/-/g, "").replace(/^0+/, ""));
 
-export { DateTimeFormat, HoursAndMinutesFormat, align, 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, hourIntervals, intersection, isStringArrayEqual, isUUID, isValidImage, nonNullable, numberCompare, numberCompareUnknownAfterHighest, objNotEmpty, removeLeftPadding, resizeBlob, resizeImage, size, stringCompare, stringCompareFromKey, stringNaturalCompare, titleCase, toID, toIDs, toUUID, toggle, trimIds, trimPath, truthy, unionArraysByKey };
+export { DateTimeFormat, HoursAndMinutesFormat, align, 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, isStringArrayEqual, isUUID, isValidImage, nonNullable, numberCompare, numberCompareUnknownAfterHighest, objNotEmpty, removeLeftPadding, resizeBlob, resizeImage, size, stringCompare, stringCompareFromKey, stringNaturalCompare, titleCase, toID, toIDs, toUUID, toggle, trimIds, trimPath, truthy, unionArraysByKey };

package/package.json

@@ -1,12 +1,15 @@
 {
   "name": "@trackunit/shared-utils",
-  "version": "0.0.13",
+  "version": "0.0.15",
   "repository": "https://github.com/Trackunit/manager",
   "license": "SEE LICENSE IN LICENSE.txt",
   "engines": {
     "node": ">=18.x"
   },
-  "dependencies": {},
+  "dependencies": {
+    "@faker-js/faker": "7.6.0"
+  },
   "module": "./index.esm.js",
-  "main": "./index.cjs.js"
+  "main": "./index.cjs.js",
+  "peerDependencies": {}
 }

package/src/GroupingUtility.d.ts

@@ -0,0 +1,13 @@
+export interface GroupingUtilityData {
+    key: string;
+    count: number;
+}
+/**
+ * Group data that has smaller count then 0.5% (smallestCount) of total count if there is more than 3% (limitToStartGrouping) of them to "Others" group.
+ * It can help charts to look better.
+ *
+ * @param data Input data
+ * @param smallestCount Breaking point to start considering the item as candidate to "Others" group [in percentage] - default 0,5%
+ * @param limitToStartGrouping Lowest limit of candidates for grouping to "Others" [in percentage] - default 3%
+ */
+export declare function groupTinyDataToOthers(data: GroupingUtilityData[] | undefined, smallestCount?: number, limitToStartGrouping?: number): GroupingUtilityData[] | undefined;

package/src/groupBy/groupBy.d.ts

@@ -1,9 +1,13 @@
 /**
  * Group an array of items by a key.
  *
- * @param list The array of items to group.
- * @param getKey A function to get the key to group by.
- * @returns A map of the items grouped by the key.
- * @example groupBy([{ name: "John", surname: "Doe" }, { name: "Jane", surname: "Doe" }], p => p.surname) // Map { "Doe" => [{ name: "John", surname: "Doe" }, { name: "Jane", surname: "Doe" }] }
+ * @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.
+ * @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: T[], getKey: (item: T) => K): Map<K, T[]>;

package/src/index.d.ts

@@ -1,6 +1,7 @@
 export * from "./DateTimeFormat";
 export * from "./DateUtils";
 export * from "./GeoJsonUtils";
+export * from "./GroupingUtility";
 export * from "./UnitOfMeasurementConverter";
 export * from "./addressUtils";
 export * from "./arrayUtils";