@trackunit/shared-utils 0.0.44-alpha-d54f3828a2.0 → 0.0.44

package/index.cjs.js

@@ -228,6 +228,20 @@ const nonNullable = (value) => {
 const truthy = (value) => {
     return !!value;
 };
+/**
+ * Returns an array of the **correctly typed** keys of a given object.
+ *
+ * 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.
+ *
+ * @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
+    return Object.keys(object).map(key => key);
+};
 
 /** toggle whether a value is in an array or not */
 function toggle(array, value) {
@@ -1014,6 +1028,7 @@ exports.nonNullable = nonNullable;
 exports.numberCompare = numberCompare;
 exports.numberCompareUnknownAfterHighest = numberCompareUnknownAfterHighest;
 exports.objNotEmpty = objNotEmpty;
+exports.objectKeys = objectKeys;
 exports.pick = pick;
 exports.removeLeftPadding = removeLeftPadding;
 exports.resizeBlob = resizeBlob;

package/index.esm.js

@@ -224,6 +224,20 @@ const nonNullable = (value) => {
 const truthy = (value) => {
     return !!value;
 };
+/**
+ * Returns an array of the **correctly typed** keys of a given object.
+ *
+ * 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.
+ *
+ * @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
+    return Object.keys(object).map(key => key);
+};
 
 /** toggle whether a value is in an array or not */
 function toggle(array, value) {
@@ -971,4 +985,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, 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, objectKeys, 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.44-alpha-d54f3828a2.0",
+  "version": "0.0.44",
   "repository": "https://github.com/Trackunit/manager",
   "license": "SEE LICENSE IN LICENSE.txt",
   "engines": {

package/src/typeUtils.d.ts

@@ -1,17 +1,3 @@
-/**
- * Infer the element type from the array type
- *
- * Use case:
- * You have a GraphQL payload that returns an array of assets with a specific signature
- * and wish be specific instead of just using Partial<Asset> as input for a component
- *
- * Example:
- * interface SomeInterface {
- *  asset: ArrayElement<SomeAssetsQueryQuery["assets"]["payload"]>;
- * }
- *
- */
-export type ArrayElement<A> = A extends readonly (infer T)[] ? T : never;
 /**
  * Use with filter() to remove null and undefined from an array
  *
@@ -19,8 +5,8 @@ export type ArrayElement<A> = A extends readonly (infer T)[] ? T : never;
  * [1, 2, 0, null].filter(nonNullable) // number[]
  *
  */
-export declare const nonNullable: <T>(value: T) => value is NonNullable<T>;
-type Truthy<T> = T extends false | "" | 0 | null | undefined ? never : T;
+export declare const nonNullable: <TValue>(value: TValue) => value is NonNullable<TValue>;
+type Truthy<TOriginal> = TOriginal extends false | "" | 0 | null | undefined ? never : TOriginal;
 /**
  * Use with filter() to remove not-truthy items from an array
  *
@@ -28,28 +14,48 @@ type Truthy<T> = T extends false | "" | 0 | null | undefined ? never : T;
  * [1, 2, 0, null].filter(truthy) // number[]
  *
  */
-export declare const truthy: <T>(value: T) => value is Truthy<T>;
+export declare const truthy: <TValue>(value: TValue) => value is Truthy<TValue>;
 /**
  * Constructs a type by excluding specified keys from another type in a homomorphic manner.
  * Homomorphic types maintain the same shape as the original type but exclude specified keys.
- * For example works correctly on descriminated unions whereas Omit messes up the type.
+ * For example, this works correctly on discriminated unions whereas Omit messes up the type.
  * https://github.com/microsoft/TypeScript/issues/54451
  *
- * @template T - The original type.
- * @template K - The keys to be excluded from the original type.
- * @property {T} P - The resulting type excluding the keys specified by K while preserving the original structure.
+ * @template TOriginal - The original type.
+ * @template KeysToExclude - The keys to be excluded from the original type.
+ * @property {TOriginal} TResult - The resulting type excluding the keys specified by KeysToExclude while preserving the original structure.
  */
-export type MappedOmit<T, K extends keyof T> = {
-    [P in keyof T as P extends K ? never : P]: T[P];
+export type MappedOmit<TOriginal, KeysToExclude extends keyof TOriginal> = {
+    [TResult in keyof TOriginal as TResult extends KeysToExclude ? never : TResult]: TOriginal[TResult];
 };
 /**
  * Creates a new type by making a specific property optional within the original type.
  *
- * @template BaseType - The original type from which a property will be made optional.
- * @template OptionalProp - The key of the property to be made optional.
- * @param {BaseType} obj - The object whose property needs to be made optional.
- * @param {OptionalProp} propKey - The key of the property to be made optional.
- * @returns {Omit<BaseType, OptionalProp> & Partial<Pick<BaseType, OptionalProp>>} - A type with the specified property made optional.
+ * @template TOriginal - The original type from which a property will be made optional.
+ * @template KeyOfPropertyToMakeOptional - The key of the property to be made optional.
+ * @param {TOriginal} obj - The object whose property needs to be made optional.
+ * @param {KeyOfPropertyToMakeOptional} propKey - The key of the property to be made optional.
+ * @returns {Omit<TOriginal, KeyOfPropertyToMakeOptional> & Partial<Pick<TOriginal, KeyOfPropertyToMakeOptional>>} - A type with the specified property made optional.
+ */
+export type MakePropertyOptional<TOriginal, KeyOfPropertyToMakeOptional extends keyof TOriginal> = MappedOmit<TOriginal, KeyOfPropertyToMakeOptional> & Partial<Pick<TOriginal, KeyOfPropertyToMakeOptional>>;
+/**
+ * MakePropertiesUnionWith utility type transforms all properties in a type into a union with a specified type.
+ *
+ * @template TOriginal - The original type.
+ * @template TUnion - The type to union with each property in the original type.
+ */
+export type MakePropertiesUnion<TOriginal, TUnion> = {
+    [Key in keyof TOriginal]: TOriginal[Key] | TUnion;
+};
+/**
+ * Returns an array of the **correctly typed** keys of a given object.
+ *
+ * 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.
+ *
+ * @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 type MakePropertyOptional<BaseType, OptionalProp extends keyof BaseType> = MappedOmit<BaseType, OptionalProp> & Partial<Pick<BaseType, OptionalProp>>;
+export declare const objectKeys: <TObject extends object>(object: TObject) => (keyof TObject)[];
 export {};