@trackunit/iris-app-runtime-core 0.3.70 → 0.3.71

package/index.cjs.js

@@ -546,7 +546,7 @@ const CurrentUserRuntime = {
  * @param newValue the new value to set
  * @returns { CustomFieldValue } an updated CustomFieldValue
  */
-const getCustomFieldValueFromRawValue = (customFieldDefinition, newValue) => {
+const getCustomFieldValueToSaveFromRawValue = (customFieldDefinition, newValue) => {
     if (customFieldDefinition.type === irisAppRuntimeCoreApi.CustomFieldType.BOOLEAN) {
         return {
             booleanValue: newValue ? true : false,
@@ -666,7 +666,7 @@ const CustomFieldRuntime = {
             if (found) {
                 values.push({
                     definitionKey: key,
-                    value: getCustomFieldValueFromRawValue(found, formData[key]),
+                    value: getCustomFieldValueToSaveFromRawValue(found, formData[key]),
                 });
             }
             else {
@@ -675,6 +675,16 @@ const CustomFieldRuntime = {
         });
         return api.setCustomFieldsFor(entity, values);
     }),
+    getCustomFieldValueForDisplayInUI: (value, _unit, _systemOfMeasurement, language) => {
+        if (value === undefined || value === null || value === "") {
+            return "";
+        }
+        const numberValue = Number(value);
+        const numberAsString = numberValue > 9999
+            ? Math.round(numberValue)
+            : new Intl.NumberFormat(language, { maximumSignificantDigits: 4, minimumSignificantDigits: 4 }).format(numberValue);
+        return numberAsString;
+    },
 };
 
 const EnvironmentRuntime = {
@@ -804,7 +814,7 @@ exports.SiteRuntime = SiteRuntime;
 exports.ToastRuntime = ToastRuntime;
 exports.TokenRuntime = TokenRuntime;
 exports.UserSubscriptionRuntime = UserSubscriptionRuntime;
-exports.getCustomFieldValueFromRawValue = getCustomFieldValueFromRawValue;
+exports.getCustomFieldValueToSaveFromRawValue = getCustomFieldValueToSaveFromRawValue;
 exports.getDateValue = getDateValue;
 exports.getHostConnector = getHostConnector;
 exports.getStringValue = getStringValue;

package/index.esm.js

@@ -543,7 +543,7 @@ const CurrentUserRuntime = {
  * @param newValue the new value to set
  * @returns { CustomFieldValue } an updated CustomFieldValue
  */
-const getCustomFieldValueFromRawValue = (customFieldDefinition, newValue) => {
+const getCustomFieldValueToSaveFromRawValue = (customFieldDefinition, newValue) => {
     if (customFieldDefinition.type === CustomFieldType.BOOLEAN) {
         return {
             booleanValue: newValue ? true : false,
@@ -663,7 +663,7 @@ const CustomFieldRuntime = {
             if (found) {
                 values.push({
                     definitionKey: key,
-                    value: getCustomFieldValueFromRawValue(found, formData[key]),
+                    value: getCustomFieldValueToSaveFromRawValue(found, formData[key]),
                 });
             }
             else {
@@ -672,6 +672,16 @@ const CustomFieldRuntime = {
         });
         return api.setCustomFieldsFor(entity, values);
     }),
+    getCustomFieldValueForDisplayInUI: (value, _unit, _systemOfMeasurement, language) => {
+        if (value === undefined || value === null || value === "") {
+            return "";
+        }
+        const numberValue = Number(value);
+        const numberAsString = numberValue > 9999
+            ? Math.round(numberValue)
+            : new Intl.NumberFormat(language, { maximumSignificantDigits: 4, minimumSignificantDigits: 4 }).format(numberValue);
+        return numberAsString;
+    },
 };
 
 const EnvironmentRuntime = {
@@ -786,4 +796,4 @@ const UserSubscriptionRuntime = {
     }),
 };
 
-export { AnalyticsContextRuntime, AssetRuntime, AssetSortingRuntime, CurrentUserRuntime, CustomFieldRuntime, EnvironmentRuntime, GlobalSelectionRuntime, NavigationRuntime, OemBrandingContextRuntime, ParamsRuntime, RestRuntime, SiteRuntime, ToastRuntime, TokenRuntime, UserSubscriptionRuntime, getCustomFieldValueFromRawValue, getDateValue, getHostConnector, getStringValue, setupHostConnector };
+export { AnalyticsContextRuntime, AssetRuntime, AssetSortingRuntime, CurrentUserRuntime, CustomFieldRuntime, EnvironmentRuntime, GlobalSelectionRuntime, NavigationRuntime, OemBrandingContextRuntime, ParamsRuntime, RestRuntime, SiteRuntime, ToastRuntime, TokenRuntime, UserSubscriptionRuntime, getCustomFieldValueToSaveFromRawValue, getDateValue, getHostConnector, getStringValue, setupHostConnector };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@trackunit/iris-app-runtime-core",
-  "version": "0.3.70",
+  "version": "0.3.71",
   "repository": "https://github.com/Trackunit/manager",
   "license": "SEE LICENSE IN LICENSE.txt",
   "engines": {
@@ -9,7 +9,7 @@
   "module": "./index.esm.js",
   "main": "./index.cjs.js",
   "dependencies": {
-    "@trackunit/iris-app-runtime-core-api": "0.3.63",
+    "@trackunit/iris-app-runtime-core-api": "0.3.64",
     "@trackunit/react-core-contexts-api": "0.2.54"
   },
   "peerDependencies": {}

package/src/CustomFieldRuntime.d.ts

@@ -1,7 +1,9 @@
-import { CustomFieldDefinition, CustomFieldError, CustomFieldValue, EntityIdentity, ValueAndDefinition, ValueAndDefinitionKey } from "@trackunit/iris-app-runtime-core-api";
+import { CustomFieldDefinition, CustomFieldError, CustomFieldValue, EntityIdentity, UnitSiType, UnitUsType, ValueAndDefinition, ValueAndDefinitionKey } from "@trackunit/iris-app-runtime-core-api";
 export interface DropdownSelection {
     value: string;
 }
+/** System of measurement. */
+export type SystemOfMeasurement = "SI" | "US_CUSTOMARY";
 /**
  * Get the value of a custom field from a raw value.
  *
@@ -9,7 +11,7 @@ export interface DropdownSelection {
  * @param newValue the new value to set
  * @returns { CustomFieldValue } an updated CustomFieldValue
  */
-export declare const getCustomFieldValueFromRawValue: (customFieldDefinition: CustomFieldDefinition, newValue: boolean | string | string[] | DropdownSelection[] | DropdownSelection | number) => CustomFieldValue;
+export declare const getCustomFieldValueToSaveFromRawValue: (customFieldDefinition: CustomFieldDefinition, newValue: boolean | string | string[] | DropdownSelection[] | DropdownSelection | number) => CustomFieldValue;
 /**
  *  Convert the received value to a string
  */
@@ -23,5 +25,6 @@ export interface ICustomFieldRuntime {
     getCustomFieldsFor: (entity: EntityIdentity) => Promise<ValueAndDefinition[]>;
     setCustomFieldsFor: (entity: EntityIdentity, values: ValueAndDefinitionKey[]) => Promise<void | CustomFieldError>;
     setCustomFieldsFromFormData: (entity: EntityIdentity, formData: Record<string, boolean | string | string[] | number>, originalDefinitions: ValueAndDefinition[]) => Promise<void | CustomFieldError>;
+    getCustomFieldValueForDisplayInUI: (value: number | string | null | undefined, unit: UnitUsType | UnitSiType | null | undefined, systemOfMeasurement?: SystemOfMeasurement, language?: string) => number | string | null | undefined;
 }
 export declare const CustomFieldRuntime: ICustomFieldRuntime;