@trackunit/shared-utils 1.2.40 → 1.2.43

package/index.cjs.js

@@ -709,6 +709,48 @@ const getFirstLevelObjectPropertyDifferences = (obj1, obj2) => {
         return diff;
     }, {});
 };
+/**
+ * Replaces all null or undefined number values in a record with 0.
+ *
+ * @param record - The record to transform
+ * @returns {Record<string, number>} A new record with all null/undefined number values replaced with 0
+ * @example replaceNullableNumbersWithZero({ a: 1, b: null, c: undefined }) // { a: 1, b: 0, c: 0 }
+ */
+const replaceNullableNumbersWithZero = (record) => {
+    // eslint-disable-next-line local-rules/no-typescript-assertion, no-autofix/local-rules/prefer-custom-object-from-entries
+    return Object.fromEntries(objectEntries(record).map(([key, value]) => [key, value ?? 0]));
+};
+/**
+ * Removes a property from an object in a type-safe way.
+ *
+ * @param obj - The object to remove a property from
+ * @param key - The key to remove
+ * @returns {object} A new object without the specified property
+ * @example removeProperty({ a: 1, b: 2 }, 'a') // { b: 2 }
+ */
+const removeProperty = (obj, key) => {
+    const { [key]: _, ...rest } = obj;
+    // should be safe because we remove the key from the object, just no way to type it properly
+    // eslint-disable-next-line local-rules/no-typescript-assertion
+    return rest;
+};
+/**
+ * Removes multiple properties from an object in a type-safe way.
+ *
+ * @param obj - The object to remove properties from
+ * @param keys - The keys to remove
+ * @returns {object} A new object without the specified properties
+ * @example removeProperties({ a: 1, b: 2, c: 3 }, ['a', 'b']) // { c: 3 }
+ */
+const removeProperties = (obj, keys) => {
+    const result = { ...obj };
+    for (const key of keys) {
+        delete result[key];
+    }
+    // should be safe because we remove the keys from the object, just no way to type it properly
+    // eslint-disable-next-line local-rules/no-typescript-assertion
+    return result;
+};
 
 /**
  * @param path the path to manipulate
@@ -1359,6 +1401,9 @@ exports.objectValues = objectValues;
 exports.pick = pick;
 exports.preload = preload;
 exports.removeLeftPadding = removeLeftPadding;
+exports.removeProperties = removeProperties;
+exports.removeProperty = removeProperty;
+exports.replaceNullableNumbersWithZero = replaceNullableNumbersWithZero;
 exports.resizeBlob = resizeBlob;
 exports.resizeImage = resizeImage;
 exports.rgb2hex = rgb2hex;

package/index.esm.js

@@ -707,6 +707,48 @@ const getFirstLevelObjectPropertyDifferences = (obj1, obj2) => {
         return diff;
     }, {});
 };
+/**
+ * Replaces all null or undefined number values in a record with 0.
+ *
+ * @param record - The record to transform
+ * @returns {Record<string, number>} A new record with all null/undefined number values replaced with 0
+ * @example replaceNullableNumbersWithZero({ a: 1, b: null, c: undefined }) // { a: 1, b: 0, c: 0 }
+ */
+const replaceNullableNumbersWithZero = (record) => {
+    // eslint-disable-next-line local-rules/no-typescript-assertion, no-autofix/local-rules/prefer-custom-object-from-entries
+    return Object.fromEntries(objectEntries(record).map(([key, value]) => [key, value ?? 0]));
+};
+/**
+ * Removes a property from an object in a type-safe way.
+ *
+ * @param obj - The object to remove a property from
+ * @param key - The key to remove
+ * @returns {object} A new object without the specified property
+ * @example removeProperty({ a: 1, b: 2 }, 'a') // { b: 2 }
+ */
+const removeProperty = (obj, key) => {
+    const { [key]: _, ...rest } = obj;
+    // should be safe because we remove the key from the object, just no way to type it properly
+    // eslint-disable-next-line local-rules/no-typescript-assertion
+    return rest;
+};
+/**
+ * Removes multiple properties from an object in a type-safe way.
+ *
+ * @param obj - The object to remove properties from
+ * @param keys - The keys to remove
+ * @returns {object} A new object without the specified properties
+ * @example removeProperties({ a: 1, b: 2, c: 3 }, ['a', 'b']) // { c: 3 }
+ */
+const removeProperties = (obj, keys) => {
+    const result = { ...obj };
+    for (const key of keys) {
+        delete result[key];
+    }
+    // should be safe because we remove the keys from the object, just no way to type it properly
+    // eslint-disable-next-line local-rules/no-typescript-assertion
+    return result;
+};
 
 /**
  * @param path the path to manipulate
@@ -1304,4 +1346,4 @@ const convertYardsToMeters = (value) => {
     return Math.round(value * 0.9144);
 };
 
-export { DateTimeFormat, HoursAndMinutesFormat, align, alphabeticallySort, arrayLengthCompare, arrayNotEmpty, booleanCompare, calculateImageScaleRatio, capitalize, colorsFromStyleDeclaration, convertBlobToBase64, convertMetersToYards, convertYardsToMeters, dateCompare, deleteUndefinedKeys, difference, doNothing, enumFromValue, enumFromValueTypesafe, enumOrUndefinedFromValue, exhaustiveCheck, fetchImageAsBase64, filterByMultiple, formatAddress, formatCoordinates, fuzzySearch, getAllColors, getDifferenceBetweenDates, getEndOfDay, getFirstLevelObjectPropertyDifferences, getISOStringFromDate, getMimeTypeFromDataURL, getResizedDimensions, getStartOfDay, groupBy, groupTinyDataToOthers, hourIntervals, intersection, isArrayEqual, isSorted, isUUID, isValidImage, loadSVGDimensions, nonNullable, numberCompare, numberCompareUnknownAfterHighest, objNotEmpty, objectEntries, objectFromEntries, objectKeys, objectValues, pick, preload, removeLeftPadding, resizeBlob, resizeImage, rgb2hex, size, stringCompare, stringCompareFromKey, stringNaturalCompare, stripHiddenCharacters, svgToPNG, titleCase, toID, toIDs, toPNG, toUUID, trimIds, trimPath, truthy, unionArraysByKey, uuidv3, uuidv4, uuidv5 };
+export { DateTimeFormat, HoursAndMinutesFormat, align, alphabeticallySort, arrayLengthCompare, arrayNotEmpty, booleanCompare, calculateImageScaleRatio, capitalize, colorsFromStyleDeclaration, convertBlobToBase64, convertMetersToYards, convertYardsToMeters, dateCompare, deleteUndefinedKeys, difference, doNothing, enumFromValue, enumFromValueTypesafe, enumOrUndefinedFromValue, exhaustiveCheck, fetchImageAsBase64, filterByMultiple, formatAddress, formatCoordinates, fuzzySearch, getAllColors, getDifferenceBetweenDates, getEndOfDay, getFirstLevelObjectPropertyDifferences, getISOStringFromDate, getMimeTypeFromDataURL, getResizedDimensions, getStartOfDay, groupBy, groupTinyDataToOthers, hourIntervals, intersection, isArrayEqual, isSorted, isUUID, isValidImage, loadSVGDimensions, nonNullable, numberCompare, numberCompareUnknownAfterHighest, objNotEmpty, objectEntries, objectFromEntries, objectKeys, objectValues, 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.2.40",
+  "version": "1.2.43",
   "repository": "https://github.com/Trackunit/manager",
   "engines": {
     "node": ">=20.x"

package/src/objectUtils.d.ts

@@ -1,3 +1,4 @@
+import { MappedOmit } from "./typeUtils";
 /**
  * Deletes all undefined keys from an object.
  *
@@ -21,4 +22,30 @@ export declare const pick: <T, K extends keyof T>(obj: T, ...keys: K[]) => Pick<
  * Returns an object with only the differences between two input objects.
  * Not recursive, only compares first level properties.
  */
-export declare const getFirstLevelObjectPropertyDifferences: <TObject extends Record<PropertyKey, unknown>>(obj1: TObject, obj2: TObject) => Partial<TObject>;
+export declare const getFirstLevelObjectPropertyDifferences: <TRecord extends Record<PropertyKey, unknown>>(obj1: TRecord, obj2: TRecord) => Partial<TRecord>;
+/**
+ * Replaces all null or undefined number values in a record with 0.
+ *
+ * @param record - The record to transform
+ * @returns {Record<string, number>} A new record with all null/undefined number values replaced with 0
+ * @example replaceNullableNumbersWithZero({ a: 1, b: null, c: undefined }) // { a: 1, b: 0, c: 0 }
+ */
+export declare const replaceNullableNumbersWithZero: <TRecord extends Record<PropertyKey, number | null | undefined>>(record: TRecord) => { [KeyItem in keyof TRecord]: number; };
+/**
+ * Removes a property from an object in a type-safe way.
+ *
+ * @param obj - The object to remove a property from
+ * @param key - The key to remove
+ * @returns {object} A new object without the specified property
+ * @example removeProperty({ a: 1, b: 2 }, 'a') // { b: 2 }
+ */
+export declare const removeProperty: <TRecord extends Record<PropertyKey, unknown>, KeyItem extends keyof TRecord>(obj: TRecord, key: KeyItem) => MappedOmit<TRecord, KeyItem>;
+/**
+ * Removes multiple properties from an object in a type-safe way.
+ *
+ * @param obj - The object to remove properties from
+ * @param keys - The keys to remove
+ * @returns {object} A new object without the specified properties
+ * @example removeProperties({ a: 1, b: 2, c: 3 }, ['a', 'b']) // { c: 3 }
+ */
+export declare const removeProperties: <TRecord extends Record<PropertyKey, unknown>, KeyItem extends keyof TRecord>(obj: TRecord, keys: readonly KeyItem[]) => MappedOmit<TRecord, KeyItem>;