@trackunit/shared-utils 0.0.48 → 0.0.50

package/index.cjs.js

@@ -208,6 +208,9 @@ const formatCoordinates = (coordinates, toFixed) => {
         : `${coordinates.latitude}, ${coordinates.longitude}`;
 };
 
+/* -------------------------------------------------------------------------- */
+/* Filtering utilities */
+/* -------------------------------------------------------------------------- */
 /**
  * Use with filter() to remove null and undefined from an array
  *
@@ -228,20 +231,63 @@ const nonNullable = (value) => {
 const truthy = (value) => {
     return !!value;
 };
+/**
+ * Converts an object into an array of properly typed key-value pairs.
+ * This is a type-faithful alternative to Object.entries().
+ *
+ * Uses the `Object.entries()` to get an array of the object's key-value pairs,
+ * and then casts each key-value pair to `[keyof TObject, TObject[keyof TObject]]`
+ *
+ * See https://stackoverflow.com/a/76176570
+ *
+ * @param {TObject} object - The object to convert.
+ * @template TObject - The type of the object.
+ */
+const objectEntries = (object) => 
+// eslint-disable-next-line local-rules/no-typescript-assertion, local-rules/prefer-custom-object-entries
+Object.entries(object);
+/**
+ * Converts an array of key-value pairs into an object.
+ * This is a type-faithful alternative to Object.fromEntries().
+ *
+ * @param {TEntries} entries - The array of key-value pairs to convert.
+ * @template TEntries - The type of the entries array.
+ */
+const objectFromEntries = (entries) => {
+    // eslint-disable-next-line local-rules/no-typescript-assertion, local-rules/prefer-custom-object-from-entries
+    return Object.fromEntries(entries);
+};
 /**
  * Returns an array of the **correctly typed** keys of a given object.
+ * This is a type-faithful alternative to Object.keys().
+ *
+ * Uses the `Object.keys()` to get an array of the object's keys,
+ * and then casts each key to `keyof TObject`
  *
- * This function uses the `Object.keys()` method to get an array of the object's keys,
- * and then casts each key to `keyof TObject` to ensure TypeScript understands the keys are of the correct type.
+ * See https://stackoverflow.com/a/76176570
  *
  * @template TObject - The type of the object.
  * @param {TObject} object - The object to get the keys from.
  * @returns {(keyof TObject)[]} An array of the keys of the object.
  */
 const objectKeys = (object) => {
-    // eslint-disable-next-line local-rules/no-typescript-assertion
+    // eslint-disable-next-line local-rules/no-typescript-assertion, local-rules/prefer-custom-object-keys
     return Object.keys(object).map(key => key);
 };
+/**
+ * Returns an array of the **correctly typed** values of a given object.
+ * This is a type-faithful alternative to Object.values().
+ *
+ * Uses the `Object.values()` to get an array of the object's values,
+ * and then casts each value to `TObject[keyof TObject]`
+ *
+ * @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.
+ */
+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) {
@@ -1030,7 +1076,10 @@ exports.nonNullable = nonNullable;
 exports.numberCompare = numberCompare;
 exports.numberCompareUnknownAfterHighest = numberCompareUnknownAfterHighest;
 exports.objNotEmpty = objNotEmpty;
+exports.objectEntries = objectEntries;
+exports.objectFromEntries = objectFromEntries;
 exports.objectKeys = objectKeys;
+exports.objectValues = objectValues;
 exports.pick = pick;
 exports.removeLeftPadding = removeLeftPadding;
 exports.resizeBlob = resizeBlob;

package/index.esm.js

@@ -204,6 +204,9 @@ const formatCoordinates = (coordinates, toFixed) => {
         : `${coordinates.latitude}, ${coordinates.longitude}`;
 };
 
+/* -------------------------------------------------------------------------- */
+/* Filtering utilities */
+/* -------------------------------------------------------------------------- */
 /**
  * Use with filter() to remove null and undefined from an array
  *
@@ -224,20 +227,63 @@ const nonNullable = (value) => {
 const truthy = (value) => {
     return !!value;
 };
+/**
+ * Converts an object into an array of properly typed key-value pairs.
+ * This is a type-faithful alternative to Object.entries().
+ *
+ * Uses the `Object.entries()` to get an array of the object's key-value pairs,
+ * and then casts each key-value pair to `[keyof TObject, TObject[keyof TObject]]`
+ *
+ * See https://stackoverflow.com/a/76176570
+ *
+ * @param {TObject} object - The object to convert.
+ * @template TObject - The type of the object.
+ */
+const objectEntries = (object) => 
+// eslint-disable-next-line local-rules/no-typescript-assertion, local-rules/prefer-custom-object-entries
+Object.entries(object);
+/**
+ * Converts an array of key-value pairs into an object.
+ * This is a type-faithful alternative to Object.fromEntries().
+ *
+ * @param {TEntries} entries - The array of key-value pairs to convert.
+ * @template TEntries - The type of the entries array.
+ */
+const objectFromEntries = (entries) => {
+    // eslint-disable-next-line local-rules/no-typescript-assertion, local-rules/prefer-custom-object-from-entries
+    return Object.fromEntries(entries);
+};
 /**
  * Returns an array of the **correctly typed** keys of a given object.
+ * This is a type-faithful alternative to Object.keys().
+ *
+ * Uses the `Object.keys()` to get an array of the object's keys,
+ * and then casts each key to `keyof TObject`
  *
- * This function uses the `Object.keys()` method to get an array of the object's keys,
- * and then casts each key to `keyof TObject` to ensure TypeScript understands the keys are of the correct type.
+ * See https://stackoverflow.com/a/76176570
  *
  * @template TObject - The type of the object.
  * @param {TObject} object - The object to get the keys from.
  * @returns {(keyof TObject)[]} An array of the keys of the object.
  */
 const objectKeys = (object) => {
-    // eslint-disable-next-line local-rules/no-typescript-assertion
+    // eslint-disable-next-line local-rules/no-typescript-assertion, local-rules/prefer-custom-object-keys
     return Object.keys(object).map(key => key);
 };
+/**
+ * Returns an array of the **correctly typed** values of a given object.
+ * This is a type-faithful alternative to Object.values().
+ *
+ * Uses the `Object.values()` to get an array of the object's values,
+ * and then casts each value to `TObject[keyof TObject]`
+ *
+ * @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.
+ */
+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) {
@@ -987,4 +1033,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, groupTinyDataToOthers, hourIntervals, intersection, isStringArrayEqual, isUUID, isValidImage, nonNullable, numberCompare, numberCompareUnknownAfterHighest, objNotEmpty, objectKeys, pick, 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, objectEntries, objectFromEntries, objectKeys, objectValues, pick, removeLeftPadding, resizeBlob, resizeImage, size, stringCompare, stringCompareFromKey, stringNaturalCompare, titleCase, toID, toIDs, toUUID, toggle, trimIds, trimPath, truthy, unionArraysByKey };

package/package.json

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

package/src/typeUtils.d.ts

@@ -47,15 +47,71 @@ export type MakePropertyOptional<TOriginal, KeyOfPropertyToMakeOptional extends
 export type MakePropertiesUnion<TOriginal, TUnion> = {
     [Key in keyof TOriginal]: TOriginal[Key] | TUnion;
 };
+/**
+ * Represents a type that makes all properties of a given type optional recursively.
+ * This is useful for creating types that can accept partial data structures,
+ * where some fields may be omitted.
+ *
+ * @template TObject - The original type whose properties should be made optional.
+ * @example
+ * // Usage:
+ * type PartialUser = DeepPartial<User>;
+ * const user: PartialUser = { name: 'John' }; // Only 'name' is required.
+ */
+export type DeepPartial<TObject> = TObject extends Record<PropertyKey, unknown> ? {
+    [Key in keyof TObject]?: DeepPartial<TObject[Key]>;
+} : TObject;
+type Entries<TObject> = {
+    [Key in keyof TObject]: [Key, TObject[Key]];
+}[keyof TObject][];
+type KeyValueTupleToObject<TEntries extends readonly (readonly [PropertyKey, unknown])[]> = {
+    [Key in TEntries[number] as Key[0]]: Key[1];
+};
+/**
+ * Converts an object into an array of properly typed key-value pairs.
+ * This is a type-faithful alternative to Object.entries().
+ *
+ * Uses the `Object.entries()` to get an array of the object's key-value pairs,
+ * and then casts each key-value pair to `[keyof TObject, TObject[keyof TObject]]`
+ *
+ * See https://stackoverflow.com/a/76176570
+ *
+ * @param {TObject} object - The object to convert.
+ * @template TObject - The type of the object.
+ */
+export declare const objectEntries: <TObject extends Record<PropertyKey, unknown>>(object: TObject) => Entries<TObject>;
+/**
+ * Converts an array of key-value pairs into an object.
+ * This is a type-faithful alternative to Object.fromEntries().
+ *
+ * @param {TEntries} entries - The array of key-value pairs to convert.
+ * @template TEntries - The type of the entries array.
+ */
+export declare const objectFromEntries: <const TEntries extends readonly (readonly [PropertyKey, unknown])[]>(entries: TEntries) => KeyValueTupleToObject<TEntries>;
 /**
  * Returns an array of the **correctly typed** keys of a given object.
+ * This is a type-faithful alternative to Object.keys().
  *
- * This function uses the `Object.keys()` method to get an array of the object's keys,
- * and then casts each key to `keyof TObject` to ensure TypeScript understands the keys are of the correct type.
+ * Uses the `Object.keys()` to get an array of the object's keys,
+ * and then casts each key to `keyof TObject`
+ *
+ * See https://stackoverflow.com/a/76176570
  *
  * @template TObject - The type of the object.
  * @param {TObject} object - The object to get the keys from.
  * @returns {(keyof TObject)[]} An array of the keys of the object.
  */
-export declare const objectKeys: <TObject extends object>(object: TObject) => (keyof TObject)[];
+export declare const objectKeys: <TObject extends Record<PropertyKey, unknown>>(object: TObject) => (keyof TObject)[];
+/**
+ * Returns an array of the **correctly typed** values of a given object.
+ * This is a type-faithful alternative to Object.values().
+ *
+ * Uses the `Object.values()` to get an array of the object's values,
+ * and then casts each value to `TObject[keyof TObject]`
+ *
+ * @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.
+ */
+export declare const objectValues: <TObject extends Record<PropertyKey, unknown>>(object: TObject) => TObject[keyof TObject][];
 export {};