@trackunit/react-core-contexts-api 0.2.42 → 0.2.44

package/index.cjs

@@ -38,6 +38,42 @@ exports.AssetSortByProperty = void 0;
     AssetSortByProperty["TelematicsDeviceSerialNumber"] = "TELEMATICS_DEVICE_SERIAL_NUMBER";
     AssetSortByProperty["Type"] = "TYPE";
 })(exports.AssetSortByProperty || (exports.AssetSortByProperty = {}));
+/**
+ * Ensures that a string is a valid AssetSortByProperty enum value
+ *
+ * @param input A string to test against AssetSortByProperty
+ * @returns {AssetSortByProperty.Activity} The AssetSortByProperty enum value or the default value (AssetSortByProperty.Activity)
+ */
+const validateStringAsAssetSortByProperty = (input) => {
+    var _a;
+    const fallback = exports.AssetSortByProperty.Activity;
+    // The type [key in AssetSortByProperty] will insure that ALL keys are present
+    const stringToEnum = {
+        ACTIVITY: exports.AssetSortByProperty.Activity,
+        BRAND: exports.AssetSortByProperty.Brand,
+        CATEGORY: exports.AssetSortByProperty.Category,
+        CRITICALITY: exports.AssetSortByProperty.Criticality,
+        DIGITAL_KEY_MODE: exports.AssetSortByProperty.DigitalKeyMode,
+        EXTERNAL_REFERENCE: exports.AssetSortByProperty.ExternalReference,
+        LOCATION: exports.AssetSortByProperty.Location,
+        LOCATION_UPDATED_AT: exports.AssetSortByProperty.LocationUpdatedAt,
+        MODEL: exports.AssetSortByProperty.Model,
+        NAME: exports.AssetSortByProperty.Name,
+        OWNER_ACCOUNT_NAME: exports.AssetSortByProperty.OwnerAccountName,
+        PRODUCTION_YEAR: exports.AssetSortByProperty.ProductionYear,
+        SERIAL_NUMBER: exports.AssetSortByProperty.SerialNumber,
+        SERVICE_PLAN_ASSIGNMENT_STATUS: exports.AssetSortByProperty.ServicePlanAssignmentStatus,
+        SERVICE_PLAN_OVERDUENESS: exports.AssetSortByProperty.ServicePlanOverdueness,
+        SERVICE_PLAN_STATUS: exports.AssetSortByProperty.ServicePlanStatus,
+        TELEMATICS_DEVICE_SERIAL_NUMBER: exports.AssetSortByProperty.TelematicsDeviceSerialNumber,
+        TYPE: exports.AssetSortByProperty.Type,
+    };
+    if (!input) {
+        return fallback;
+    }
+    // Try to get the enum value from the string. -> Fallback to the default
+    return (_a = stringToEnum[input]) !== null && _a !== void 0 ? _a : fallback;
+};
 exports.SortOrder = void 0;
 (function (SortOrder) {
     SortOrder["Asc"] = "ASC";
@@ -59,3 +95,4 @@ const UserSubscriptionPackage = {
 
 exports.UserSubscriptionPackage = UserSubscriptionPackage;
 exports.createEvent = createEvent;
+exports.validateStringAsAssetSortByProperty = validateStringAsAssetSortByProperty;

package/index.js

@@ -34,6 +34,42 @@ var AssetSortByProperty;
     AssetSortByProperty["TelematicsDeviceSerialNumber"] = "TELEMATICS_DEVICE_SERIAL_NUMBER";
     AssetSortByProperty["Type"] = "TYPE";
 })(AssetSortByProperty || (AssetSortByProperty = {}));
+/**
+ * Ensures that a string is a valid AssetSortByProperty enum value
+ *
+ * @param input A string to test against AssetSortByProperty
+ * @returns {AssetSortByProperty.Activity} The AssetSortByProperty enum value or the default value (AssetSortByProperty.Activity)
+ */
+const validateStringAsAssetSortByProperty = (input) => {
+    var _a;
+    const fallback = AssetSortByProperty.Activity;
+    // The type [key in AssetSortByProperty] will insure that ALL keys are present
+    const stringToEnum = {
+        ACTIVITY: AssetSortByProperty.Activity,
+        BRAND: AssetSortByProperty.Brand,
+        CATEGORY: AssetSortByProperty.Category,
+        CRITICALITY: AssetSortByProperty.Criticality,
+        DIGITAL_KEY_MODE: AssetSortByProperty.DigitalKeyMode,
+        EXTERNAL_REFERENCE: AssetSortByProperty.ExternalReference,
+        LOCATION: AssetSortByProperty.Location,
+        LOCATION_UPDATED_AT: AssetSortByProperty.LocationUpdatedAt,
+        MODEL: AssetSortByProperty.Model,
+        NAME: AssetSortByProperty.Name,
+        OWNER_ACCOUNT_NAME: AssetSortByProperty.OwnerAccountName,
+        PRODUCTION_YEAR: AssetSortByProperty.ProductionYear,
+        SERIAL_NUMBER: AssetSortByProperty.SerialNumber,
+        SERVICE_PLAN_ASSIGNMENT_STATUS: AssetSortByProperty.ServicePlanAssignmentStatus,
+        SERVICE_PLAN_OVERDUENESS: AssetSortByProperty.ServicePlanOverdueness,
+        SERVICE_PLAN_STATUS: AssetSortByProperty.ServicePlanStatus,
+        TELEMATICS_DEVICE_SERIAL_NUMBER: AssetSortByProperty.TelematicsDeviceSerialNumber,
+        TYPE: AssetSortByProperty.Type,
+    };
+    if (!input) {
+        return fallback;
+    }
+    // Try to get the enum value from the string. -> Fallback to the default
+    return (_a = stringToEnum[input]) !== null && _a !== void 0 ? _a : fallback;
+};
 var SortOrder;
 (function (SortOrder) {
     SortOrder["Asc"] = "ASC";
@@ -53,4 +89,4 @@ const UserSubscriptionPackage = {
     NONE: "NONE",
 };
 
-export { AssetSortByProperty, SortOrder, UserSubscriptionPackage, createEvent };
+export { AssetSortByProperty, SortOrder, UserSubscriptionPackage, createEvent, validateStringAsAssetSortByProperty };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@trackunit/react-core-contexts-api",
-  "version": "0.2.42",
+  "version": "0.2.44",
   "repository": "https://github.com/Trackunit/manager",
   "license": "SEE LICENSE IN LICENSE.txt",
   "engines": {

package/src/assetSortingContext.d.ts

@@ -28,6 +28,13 @@ export declare enum AssetSortByProperty {
     TelematicsDeviceSerialNumber = "TELEMATICS_DEVICE_SERIAL_NUMBER",
     Type = "TYPE"
 }
+/**
+ * Ensures that a string is a valid AssetSortByProperty enum value
+ *
+ * @param input A string to test against AssetSortByProperty
+ * @returns {AssetSortByProperty.Activity} The AssetSortByProperty enum value or the default value (AssetSortByProperty.Activity)
+ */
+export declare const validateStringAsAssetSortByProperty: (input?: string) => AssetSortByProperty;
 export declare enum SortOrder {
     Asc = "ASC",
     Desc = "DESC"