@trackunit/react-core-contexts-api 0.2.58 → 0.2.60

package/index.cjs.js

@@ -2,6 +2,18 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
+var sharedUtils = require('@trackunit/shared-utils');
+
+const SystemOfMeasurement = {
+    Si: "SI",
+    UsCustomary: "US_CUSTOMARY",
+};
+const TimeZonePreference = {
+    CustomTimeZone: "CUSTOM_TIME_ZONE",
+    LocalTimeZone: "LOCAL_TIME_ZONE",
+    MachineTimeZone: "MACHINE_TIME_ZONE",
+};
+
 /**
  * Takes an event type and a description and returns an event
  *
@@ -39,6 +51,28 @@ exports.AssetSortByProperty = void 0;
     AssetSortByProperty["TelematicsDeviceSerialNumber"] = "TELEMATICS_DEVICE_SERIAL_NUMBER";
     AssetSortByProperty["Type"] = "TYPE";
 })(exports.AssetSortByProperty || (exports.AssetSortByProperty = {}));
+// 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,
+    CUSTOM_FIELD: exports.AssetSortByProperty.CustomField,
+    CRITICALITY: exports.AssetSortByProperty.Criticality,
+    ACCESS_MANAGEMENT: exports.AssetSortByProperty.AccessManagement,
+    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,
+};
 /**
  * Ensures that a string is a valid AssetSortByProperty enum value
  *
@@ -48,33 +82,19 @@ exports.AssetSortByProperty = void 0;
 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,
-        CUSTOM_FIELD: exports.AssetSortByProperty.CustomField,
-        CRITICALITY: exports.AssetSortByProperty.Criticality,
-        ACCESS_MANAGEMENT: exports.AssetSortByProperty.AccessManagement,
-        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;
+        return { sortBy: fallback };
     }
     // Try to get the enum value from the string. -> Fallback to the default
-    return (_a = stringToEnum[input]) !== null && _a !== void 0 ? _a : fallback;
+    if (sharedUtils.isUUID(input)) {
+        return {
+            sortBy: exports.AssetSortByProperty.CustomField,
+            customFieldDefinitionId: input,
+        };
+    }
+    return {
+        sortBy: (_a = stringToEnum[input]) !== null && _a !== void 0 ? _a : fallback,
+    };
 };
 exports.SortOrder = void 0;
 (function (SortOrder) {
@@ -95,6 +115,8 @@ const UserSubscriptionPackage = {
     NONE: "NONE",
 };
 
+exports.SystemOfMeasurement = SystemOfMeasurement;
+exports.TimeZonePreference = TimeZonePreference;
 exports.UserSubscriptionPackage = UserSubscriptionPackage;
 exports.createEvent = createEvent;
 exports.validateStringAsAssetSortByProperty = validateStringAsAssetSortByProperty;

package/index.esm.js

@@ -1,3 +1,15 @@
+import { isUUID } from '@trackunit/shared-utils';
+
+const SystemOfMeasurement = {
+    Si: "SI",
+    UsCustomary: "US_CUSTOMARY",
+};
+const TimeZonePreference = {
+    CustomTimeZone: "CUSTOM_TIME_ZONE",
+    LocalTimeZone: "LOCAL_TIME_ZONE",
+    MachineTimeZone: "MACHINE_TIME_ZONE",
+};
+
 /**
  * Takes an event type and a description and returns an event
  *
@@ -35,6 +47,28 @@ var AssetSortByProperty;
     AssetSortByProperty["TelematicsDeviceSerialNumber"] = "TELEMATICS_DEVICE_SERIAL_NUMBER";
     AssetSortByProperty["Type"] = "TYPE";
 })(AssetSortByProperty || (AssetSortByProperty = {}));
+// The type [key in AssetSortByProperty] will insure that ALL keys are present
+const stringToEnum = {
+    ACTIVITY: AssetSortByProperty.Activity,
+    BRAND: AssetSortByProperty.Brand,
+    CATEGORY: AssetSortByProperty.Category,
+    CUSTOM_FIELD: AssetSortByProperty.CustomField,
+    CRITICALITY: AssetSortByProperty.Criticality,
+    ACCESS_MANAGEMENT: AssetSortByProperty.AccessManagement,
+    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,
+};
 /**
  * Ensures that a string is a valid AssetSortByProperty enum value
  *
@@ -44,33 +78,19 @@ var AssetSortByProperty;
 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,
-        CUSTOM_FIELD: AssetSortByProperty.CustomField,
-        CRITICALITY: AssetSortByProperty.Criticality,
-        ACCESS_MANAGEMENT: AssetSortByProperty.AccessManagement,
-        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;
+        return { sortBy: fallback };
     }
     // Try to get the enum value from the string. -> Fallback to the default
-    return (_a = stringToEnum[input]) !== null && _a !== void 0 ? _a : fallback;
+    if (isUUID(input)) {
+        return {
+            sortBy: AssetSortByProperty.CustomField,
+            customFieldDefinitionId: input,
+        };
+    }
+    return {
+        sortBy: (_a = stringToEnum[input]) !== null && _a !== void 0 ? _a : fallback,
+    };
 };
 var SortOrder;
 (function (SortOrder) {
@@ -91,4 +111,4 @@ const UserSubscriptionPackage = {
     NONE: "NONE",
 };
 
-export { AssetSortByProperty, SortOrder, UserSubscriptionPackage, createEvent, validateStringAsAssetSortByProperty };
+export { AssetSortByProperty, SortOrder, SystemOfMeasurement, TimeZonePreference, UserSubscriptionPackage, createEvent, validateStringAsAssetSortByProperty };

package/package.json

@@ -1,11 +1,15 @@
 {
   "name": "@trackunit/react-core-contexts-api",
-  "version": "0.2.58",
+  "version": "0.2.60",
   "repository": "https://github.com/Trackunit/manager",
   "license": "SEE LICENSE IN LICENSE.txt",
   "engines": {
     "node": ">=18.x"
   },
   "module": "./index.esm.js",
-  "main": "./index.cjs.js"
+  "main": "./index.cjs.js",
+  "dependencies": {
+    "@trackunit/shared-utils": "0.0.9"
+  },
+  "peerDependencies": {}
 }

package/src/IUserPreferencesContext.d.ts

@@ -0,0 +1,19 @@
+export declare const SystemOfMeasurement: {
+    readonly Si: "SI";
+    readonly UsCustomary: "US_CUSTOMARY";
+};
+export declare const TimeZonePreference: {
+    readonly CustomTimeZone: "CUSTOM_TIME_ZONE";
+    readonly LocalTimeZone: "LOCAL_TIME_ZONE";
+    readonly MachineTimeZone: "MACHINE_TIME_ZONE";
+};
+export type SystemOfMeasurementType = (typeof SystemOfMeasurement)[keyof typeof SystemOfMeasurement];
+export type TimeZonePreferenceType = (typeof TimeZonePreference)[keyof typeof TimeZonePreference];
+export interface IUserPreferencesContext {
+    language?: string;
+    setLanguage?: (language: string) => void;
+    timeZonePreference?: TimeZonePreferenceType;
+    setTimeZonePreference?: (timeZonePreference: TimeZonePreferenceType) => void;
+    systemOfMeasurement?: SystemOfMeasurementType;
+    setSystemOfMeasurement?: (systemOfMeasurement: SystemOfMeasurementType) => void;
+}

package/src/assetSortingContext.d.ts

@@ -1,8 +1,10 @@
 export interface IAssetSortingContext {
     sortingState: SortingState;
-    setSortBy: (sortBy: AssetSortByProperty, order?: SortOrder) => void;
+    setSortBy: (sortBy: AssetSortByProperty, order?: SortOrder, customFieldDefinitionId?: string) => void;
 }
 export interface SortingState {
+    /** Custom field definitionId if AssetSortByProperty is a CustomField */
+    customFieldDefinitionId?: string;
     /** The property to sort by. */
     sortBy: AssetSortByProperty;
     /** The property to sort by. */
@@ -35,7 +37,10 @@ export declare enum AssetSortByProperty {
  * @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 const validateStringAsAssetSortByProperty: (input?: string) => {
+    sortBy: AssetSortByProperty;
+    customFieldDefinitionId?: string;
+};
 export declare enum SortOrder {
     Asc = "ASC",
     Desc = "DESC"

package/src/index.d.ts

@@ -1,3 +1,4 @@
+export * from "./IUserPreferencesContext";
 export * from "./analyticsContext";
 export * from "./assetSortingContext";
 export * from "./currentUserContext";