@trackunit/react-core-contexts-api 0.2.116-alpha-869e1cbc10.0 → 0.2.116

package/index.cjs.js

@@ -102,6 +102,37 @@ exports.SortOrder = void 0;
     SortOrder["Desc"] = "DESC";
 })(exports.SortOrder || (exports.SortOrder = {}));
 
+/** The property to sort by. */
+exports.ContactSortByProperty = void 0;
+(function (ContactSortByProperty) {
+    ContactSortByProperty["Name"] = "NAME";
+    ContactSortByProperty["Email"] = "EMAIL";
+    ContactSortByProperty["Fax"] = "FAX";
+    ContactSortByProperty["Phone"] = "PHONE";
+    ContactSortByProperty["Title"] = "TITLE";
+})(exports.ContactSortByProperty || (exports.ContactSortByProperty = {}));
+/**
+ * Ensures that a string is a valid ContactSortByProperty enum value
+ *
+ * @param input A string to test against ContactSortByProperty
+ * @returns {ContactSortByProperty.Name} The ContactSortByProperty enum value or the default value (ContactSortByProperty.Name)
+ */
+const validateStringAsContactSortByProperty = (input) => {
+    switch (input) {
+        case exports.ContactSortByProperty.Email:
+            return exports.ContactSortByProperty.Email;
+        case exports.ContactSortByProperty.Fax:
+            return exports.ContactSortByProperty.Fax;
+        case exports.ContactSortByProperty.Phone:
+            return exports.ContactSortByProperty.Phone;
+        case exports.ContactSortByProperty.Title:
+            return exports.ContactSortByProperty.Title;
+        case exports.ContactSortByProperty.Name:
+        default:
+            return exports.ContactSortByProperty.Name;
+    }
+};
+
 const assetHomePageIds = [
     "status",
     "movement",
@@ -207,4 +238,5 @@ exports.createEvent = createEvent;
 exports.isIrisOptions = isIrisOptions;
 exports.siteHomePageIds = siteHomePageIds;
 exports.validateStringAsAssetSortByProperty = validateStringAsAssetSortByProperty;
+exports.validateStringAsContactSortByProperty = validateStringAsContactSortByProperty;
 exports.validateStringAsSiteSortByProperty = validateStringAsSiteSortByProperty;

package/index.esm.js

@@ -98,6 +98,37 @@ var SortOrder;
     SortOrder["Desc"] = "DESC";
 })(SortOrder || (SortOrder = {}));
 
+/** The property to sort by. */
+var ContactSortByProperty;
+(function (ContactSortByProperty) {
+    ContactSortByProperty["Name"] = "NAME";
+    ContactSortByProperty["Email"] = "EMAIL";
+    ContactSortByProperty["Fax"] = "FAX";
+    ContactSortByProperty["Phone"] = "PHONE";
+    ContactSortByProperty["Title"] = "TITLE";
+})(ContactSortByProperty || (ContactSortByProperty = {}));
+/**
+ * Ensures that a string is a valid ContactSortByProperty enum value
+ *
+ * @param input A string to test against ContactSortByProperty
+ * @returns {ContactSortByProperty.Name} The ContactSortByProperty enum value or the default value (ContactSortByProperty.Name)
+ */
+const validateStringAsContactSortByProperty = (input) => {
+    switch (input) {
+        case ContactSortByProperty.Email:
+            return ContactSortByProperty.Email;
+        case ContactSortByProperty.Fax:
+            return ContactSortByProperty.Fax;
+        case ContactSortByProperty.Phone:
+            return ContactSortByProperty.Phone;
+        case ContactSortByProperty.Title:
+            return ContactSortByProperty.Title;
+        case ContactSortByProperty.Name:
+        default:
+            return ContactSortByProperty.Name;
+    }
+};
+
 const assetHomePageIds = [
     "status",
     "movement",
@@ -195,4 +226,4 @@ const UserSubscriptionPackage = {
     LEAP: "Leap",
 };
 
-export { AssetSortByProperty, SiteSortByProperty, SortOrder, SystemOfMeasurement, TimeZonePreference, UserSubscriptionPackage, assetHomePageIds, createEvent, isIrisOptions, siteHomePageIds, validateStringAsAssetSortByProperty, validateStringAsSiteSortByProperty };
+export { AssetSortByProperty, ContactSortByProperty, SiteSortByProperty, SortOrder, SystemOfMeasurement, TimeZonePreference, UserSubscriptionPackage, assetHomePageIds, createEvent, isIrisOptions, siteHomePageIds, validateStringAsAssetSortByProperty, validateStringAsContactSortByProperty, validateStringAsSiteSortByProperty };

package/package.json

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

package/src/contactSortingContext.d.ts

@@ -0,0 +1,15 @@
+/** The property to sort by. */
+export declare enum ContactSortByProperty {
+    Name = "NAME",
+    Email = "EMAIL",
+    Fax = "FAX",
+    Phone = "PHONE",
+    Title = "TITLE"
+}
+/**
+ * Ensures that a string is a valid ContactSortByProperty enum value
+ *
+ * @param input A string to test against ContactSortByProperty
+ * @returns {ContactSortByProperty.Name} The ContactSortByProperty enum value or the default value (ContactSortByProperty.Name)
+ */
+export declare const validateStringAsContactSortByProperty: (input?: string) => ContactSortByProperty;

package/src/index.d.ts

@@ -2,6 +2,7 @@ export * from "./IUserPreferencesContext";
 export * from "./analyticsContext";
 export * from "./assetSortingContext";
 export * from "./confirmationDialogContext";
+export * from "./contactSortingContext";
 export * from "./currentUserContext";
 export * from "./environmentContext";
 export * from "./filterBarContext";