@trackunit/react-core-contexts-api 0.2.91 → 0.2.92

package/index.cjs.js

@@ -125,6 +125,55 @@ const isIrisOptions = (options) => {
         ("extensionId") in options);
 };
 
+/** The property to sort by. */
+exports.SiteSortByProperty = void 0;
+(function (SiteSortByProperty) {
+    SiteSortByProperty["Area"] = "AREA";
+    SiteSortByProperty["CenterLatitude"] = "CENTER_LATITUDE";
+    SiteSortByProperty["CenterLongitude"] = "CENTER_LONGITUDE";
+    SiteSortByProperty["City"] = "CITY";
+    SiteSortByProperty["Country"] = "COUNTRY";
+    SiteSortByProperty["CreatedDate"] = "CREATED_DATE";
+    SiteSortByProperty["Description"] = "DESCRIPTION";
+    SiteSortByProperty["EndDate"] = "END_DATE";
+    SiteSortByProperty["LastModifiedDate"] = "LAST_MODIFIED_DATE";
+    SiteSortByProperty["Name"] = "NAME";
+    SiteSortByProperty["StartDate"] = "START_DATE";
+    SiteSortByProperty["Status"] = "STATUS";
+    SiteSortByProperty["StreetAddress"] = "STREET_ADDRESS";
+    SiteSortByProperty["Type"] = "TYPE";
+    SiteSortByProperty["ZipCode"] = "ZIP_CODE";
+    SiteSortByProperty["ZoneId"] = "ZONE_ID";
+})(exports.SiteSortByProperty || (exports.SiteSortByProperty = {}));
+/**
+ * Ensures that a string is a valid SiteSortByProperty enum value
+ *
+ * @param input A string to test against SiteSortByProperty
+ * @returns {SiteSortByProperty.Name} The SiteSortByProperty enum value or the default value (SiteSortByProperty.Name)
+ */
+const validateStringAsSiteSortByProperty = (input) => {
+    const fallback = exports.SiteSortByProperty.Name;
+    if (!input) {
+        return fallback;
+    }
+    switch (input) {
+        case exports.SiteSortByProperty.Area:
+            return exports.SiteSortByProperty.Area;
+        case exports.SiteSortByProperty.EndDate:
+            return exports.SiteSortByProperty.EndDate;
+        case exports.SiteSortByProperty.Name:
+            return exports.SiteSortByProperty.Name;
+        case exports.SiteSortByProperty.StartDate:
+            return exports.SiteSortByProperty.StartDate;
+        case exports.SiteSortByProperty.Status:
+            return exports.SiteSortByProperty.Status;
+        case exports.SiteSortByProperty.Type:
+            return exports.SiteSortByProperty.Type;
+        default:
+            return fallback;
+    }
+};
+
 const UserSubscriptionPackage = {
     EXPLORE_FLEET_OWNER: "Explore (Fleet Owner)",
     EVOLVE_FLEET_OWNER: "Evolve (Fleet Owner)",
@@ -146,3 +195,4 @@ exports.createEvent = createEvent;
 exports.isIrisOptions = isIrisOptions;
 exports.siteHomePageIds = siteHomePageIds;
 exports.validateStringAsAssetSortByProperty = validateStringAsAssetSortByProperty;
+exports.validateStringAsSiteSortByProperty = validateStringAsSiteSortByProperty;

package/index.esm.js

@@ -121,6 +121,55 @@ const isIrisOptions = (options) => {
         ("extensionId") in options);
 };
 
+/** The property to sort by. */
+var SiteSortByProperty;
+(function (SiteSortByProperty) {
+    SiteSortByProperty["Area"] = "AREA";
+    SiteSortByProperty["CenterLatitude"] = "CENTER_LATITUDE";
+    SiteSortByProperty["CenterLongitude"] = "CENTER_LONGITUDE";
+    SiteSortByProperty["City"] = "CITY";
+    SiteSortByProperty["Country"] = "COUNTRY";
+    SiteSortByProperty["CreatedDate"] = "CREATED_DATE";
+    SiteSortByProperty["Description"] = "DESCRIPTION";
+    SiteSortByProperty["EndDate"] = "END_DATE";
+    SiteSortByProperty["LastModifiedDate"] = "LAST_MODIFIED_DATE";
+    SiteSortByProperty["Name"] = "NAME";
+    SiteSortByProperty["StartDate"] = "START_DATE";
+    SiteSortByProperty["Status"] = "STATUS";
+    SiteSortByProperty["StreetAddress"] = "STREET_ADDRESS";
+    SiteSortByProperty["Type"] = "TYPE";
+    SiteSortByProperty["ZipCode"] = "ZIP_CODE";
+    SiteSortByProperty["ZoneId"] = "ZONE_ID";
+})(SiteSortByProperty || (SiteSortByProperty = {}));
+/**
+ * Ensures that a string is a valid SiteSortByProperty enum value
+ *
+ * @param input A string to test against SiteSortByProperty
+ * @returns {SiteSortByProperty.Name} The SiteSortByProperty enum value or the default value (SiteSortByProperty.Name)
+ */
+const validateStringAsSiteSortByProperty = (input) => {
+    const fallback = SiteSortByProperty.Name;
+    if (!input) {
+        return fallback;
+    }
+    switch (input) {
+        case SiteSortByProperty.Area:
+            return SiteSortByProperty.Area;
+        case SiteSortByProperty.EndDate:
+            return SiteSortByProperty.EndDate;
+        case SiteSortByProperty.Name:
+            return SiteSortByProperty.Name;
+        case SiteSortByProperty.StartDate:
+            return SiteSortByProperty.StartDate;
+        case SiteSortByProperty.Status:
+            return SiteSortByProperty.Status;
+        case SiteSortByProperty.Type:
+            return SiteSortByProperty.Type;
+        default:
+            return fallback;
+    }
+};
+
 const UserSubscriptionPackage = {
     EXPLORE_FLEET_OWNER: "Explore (Fleet Owner)",
     EVOLVE_FLEET_OWNER: "Evolve (Fleet Owner)",
@@ -134,4 +183,4 @@ const UserSubscriptionPackage = {
     NONE: "NONE",
 };
 
-export { AssetSortByProperty, SortOrder, SystemOfMeasurement, TimeZonePreference, UserSubscriptionPackage, assetHomePageIds, createEvent, isIrisOptions, siteHomePageIds, validateStringAsAssetSortByProperty };
+export { AssetSortByProperty, SiteSortByProperty, SortOrder, SystemOfMeasurement, TimeZonePreference, UserSubscriptionPackage, assetHomePageIds, createEvent, isIrisOptions, siteHomePageIds, validateStringAsAssetSortByProperty, validateStringAsSiteSortByProperty };

package/package.json

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

package/src/index.d.ts

@@ -6,6 +6,7 @@ export * from "./environmentContext";
 export * from "./filterBarContext";
 export * from "./navigationContext";
 export * from "./oemBrandingContext";
+export * from "./siteSortingContext";
 export * from "./toastContext";
 export * from "./tokenContext";
 export * from "./userSubscriptionContext";

package/src/siteSortingContext.d.ts

@@ -0,0 +1,26 @@
+/** The property to sort by. */
+export declare enum SiteSortByProperty {
+    Area = "AREA",
+    CenterLatitude = "CENTER_LATITUDE",
+    CenterLongitude = "CENTER_LONGITUDE",
+    City = "CITY",
+    Country = "COUNTRY",
+    CreatedDate = "CREATED_DATE",
+    Description = "DESCRIPTION",
+    EndDate = "END_DATE",
+    LastModifiedDate = "LAST_MODIFIED_DATE",
+    Name = "NAME",
+    StartDate = "START_DATE",
+    Status = "STATUS",
+    StreetAddress = "STREET_ADDRESS",
+    Type = "TYPE",
+    ZipCode = "ZIP_CODE",
+    ZoneId = "ZONE_ID"
+}
+/**
+ * Ensures that a string is a valid SiteSortByProperty enum value
+ *
+ * @param input A string to test against SiteSortByProperty
+ * @returns {SiteSortByProperty.Name} The SiteSortByProperty enum value or the default value (SiteSortByProperty.Name)
+ */
+export declare const validateStringAsSiteSortByProperty: (input?: string) => SiteSortByProperty;