@trackunit/iris-app-runtime-core 0.3.146 → 0.3.147

package/index.cjs.js

@@ -253,44 +253,37 @@ const getDateValue = (value) => {
     const year = date.toLocaleString("en-US", { year: "numeric" });
     return `${year}-${month}-${day}`;
 };
-const CustomFieldRuntime = {
-    getCustomFieldsFor: (entity) => __awaiter(void 0, void 0, void 0, function* () {
-        const api = yield getHostConnector();
-        return api.getCustomFieldsFor(entity);
-    }),
-    setCustomFieldsFor: (entity, values) => __awaiter(void 0, void 0, void 0, function* () {
-        const api = yield getHostConnector();
-        return api.setCustomFieldsFor(entity, values);
-    }),
-    setCustomFieldsFromFormData: (entity, formData, originalDefinitions) => __awaiter(void 0, void 0, void 0, function* () {
-        const api = yield getHostConnector();
-        const values = [];
-        Object.keys(formData).forEach(key => {
-            var _a;
-            const found = (_a = originalDefinitions.find(originalDefinition => originalDefinition.definition.key === key)) === null || _a === void 0 ? void 0 : _a.definition;
-            const formDataValue = formData[key];
-            if (found && formDataValue) {
-                values.push({
-                    definitionKey: key,
-                    value: getCustomFieldValueToSaveFromRawValue(found, formDataValue),
-                });
-            }
-            else {
-                throw new Error("Unsupported custom field type: " + key);
-            }
-        });
-        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;
-    },
+/**
+ * Format a custom field value to ensure a consistent representation in the ui.
+ */
+const 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;
+};
+/**
+ * type guard to ensure that a value is of a type compatible with custom fields
+ */
+const isValidCustomFieldValue = (value) => {
+    const isBoolean = typeof value === "boolean";
+    const isString = typeof value === "string";
+    const isStringArray = Array.isArray(value) && value.every(item => typeof item === "string");
+    const isDropdownSelectionArray = Array.isArray(value) && value.every(item => isDropdownSelection(item));
+    const isDropdownSelection = (dropdownValue) => typeof dropdownValue === "object" && dropdownValue !== null && "value" in dropdownValue;
+    const isNumber = typeof value === "number";
+    const isNull = value === null;
+    return (isBoolean ||
+        isString ||
+        isStringArray ||
+        isDropdownSelectionArray ||
+        isDropdownSelection(value) ||
+        isNumber ||
+        isNull);
 };
 
 const EnvironmentRuntime = {
@@ -429,7 +422,6 @@ exports.AssetSortingRuntime = AssetSortingRuntime;
 exports.ConfirmationDialogRuntime = ConfirmationDialogRuntime;
 exports.CurrentUserPreferenceRuntime = CurrentUserPreferenceRuntime;
 exports.CurrentUserRuntime = CurrentUserRuntime;
-exports.CustomFieldRuntime = CustomFieldRuntime;
 exports.EnvironmentRuntime = EnvironmentRuntime;
 exports.EventRuntime = EventRuntime;
 exports.FilterBarRuntime = FilterBarRuntime;
@@ -442,10 +434,12 @@ exports.SiteRuntime = SiteRuntime;
 exports.ToastRuntime = ToastRuntime;
 exports.TokenRuntime = TokenRuntime;
 exports.UserSubscriptionRuntime = UserSubscriptionRuntime;
+exports.getCustomFieldValueForDisplayInUI = getCustomFieldValueForDisplayInUI;
 exports.getCustomFieldValueToSaveFromRawValue = getCustomFieldValueToSaveFromRawValue;
 exports.getDateValue = getDateValue;
 exports.getHostConnector = getHostConnector;
 exports.getStringValue = getStringValue;
+exports.isValidCustomFieldValue = isValidCustomFieldValue;
 exports.setupHostConnector = setupHostConnector;
 Object.keys(irisAppRuntimeCoreApi).forEach(function (k) {
     if (k !== 'default' && !exports.hasOwnProperty(k)) Object.defineProperty(exports, k, {

package/index.esm.js

@@ -249,44 +249,37 @@ const getDateValue = (value) => {
     const year = date.toLocaleString("en-US", { year: "numeric" });
     return `${year}-${month}-${day}`;
 };
-const CustomFieldRuntime = {
-    getCustomFieldsFor: (entity) => __awaiter(void 0, void 0, void 0, function* () {
-        const api = yield getHostConnector();
-        return api.getCustomFieldsFor(entity);
-    }),
-    setCustomFieldsFor: (entity, values) => __awaiter(void 0, void 0, void 0, function* () {
-        const api = yield getHostConnector();
-        return api.setCustomFieldsFor(entity, values);
-    }),
-    setCustomFieldsFromFormData: (entity, formData, originalDefinitions) => __awaiter(void 0, void 0, void 0, function* () {
-        const api = yield getHostConnector();
-        const values = [];
-        Object.keys(formData).forEach(key => {
-            var _a;
-            const found = (_a = originalDefinitions.find(originalDefinition => originalDefinition.definition.key === key)) === null || _a === void 0 ? void 0 : _a.definition;
-            const formDataValue = formData[key];
-            if (found && formDataValue) {
-                values.push({
-                    definitionKey: key,
-                    value: getCustomFieldValueToSaveFromRawValue(found, formDataValue),
-                });
-            }
-            else {
-                throw new Error("Unsupported custom field type: " + key);
-            }
-        });
-        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;
-    },
+/**
+ * Format a custom field value to ensure a consistent representation in the ui.
+ */
+const 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;
+};
+/**
+ * type guard to ensure that a value is of a type compatible with custom fields
+ */
+const isValidCustomFieldValue = (value) => {
+    const isBoolean = typeof value === "boolean";
+    const isString = typeof value === "string";
+    const isStringArray = Array.isArray(value) && value.every(item => typeof item === "string");
+    const isDropdownSelectionArray = Array.isArray(value) && value.every(item => isDropdownSelection(item));
+    const isDropdownSelection = (dropdownValue) => typeof dropdownValue === "object" && dropdownValue !== null && "value" in dropdownValue;
+    const isNumber = typeof value === "number";
+    const isNull = value === null;
+    return (isBoolean ||
+        isString ||
+        isStringArray ||
+        isDropdownSelectionArray ||
+        isDropdownSelection(value) ||
+        isNumber ||
+        isNull);
 };
 
 const EnvironmentRuntime = {
@@ -419,4 +412,4 @@ const UserSubscriptionRuntime = {
     }),
 };
 
-export { AnalyticsContextRuntime, AssetRuntime, AssetSortingRuntime, ConfirmationDialogRuntime, CurrentUserPreferenceRuntime, CurrentUserRuntime, CustomFieldRuntime, EnvironmentRuntime, EventRuntime, FilterBarRuntime, NavigationRuntime, OemBrandingContextRuntime, ParamsRuntime, RestRuntime, RouterRuntime, SiteRuntime, ToastRuntime, TokenRuntime, UserSubscriptionRuntime, getCustomFieldValueToSaveFromRawValue, getDateValue, getHostConnector, getStringValue, setupHostConnector };
+export { AnalyticsContextRuntime, AssetRuntime, AssetSortingRuntime, ConfirmationDialogRuntime, CurrentUserPreferenceRuntime, CurrentUserRuntime, EnvironmentRuntime, EventRuntime, FilterBarRuntime, NavigationRuntime, OemBrandingContextRuntime, ParamsRuntime, RestRuntime, RouterRuntime, SiteRuntime, ToastRuntime, TokenRuntime, UserSubscriptionRuntime, getCustomFieldValueForDisplayInUI, getCustomFieldValueToSaveFromRawValue, getDateValue, getHostConnector, getStringValue, isValidCustomFieldValue, setupHostConnector };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@trackunit/iris-app-runtime-core",
-  "version": "0.3.146",
+  "version": "0.3.147",
   "repository": "https://github.com/Trackunit/manager",
   "license": "SEE LICENSE IN LICENSE.txt",
   "engines": {

package/src/CustomFieldRuntime.d.ts

@@ -1,4 +1,4 @@
-import { CustomFieldError, CustomFieldType, CustomFieldValue, EntityIdentity, UnitSiType, UnitUsType, ValueAndDefinition, ValueAndDefinitionKey } from "@trackunit/iris-app-runtime-core-api";
+import { CustomFieldType, CustomFieldValue, UnitSiType, UnitUsType } from "@trackunit/iris-app-runtime-core-api";
 import { SystemOfMeasurementType } from "@trackunit/react-core-contexts-api";
 export interface DropdownSelection {
     value: string;
@@ -23,10 +23,11 @@ export declare const getStringValue: (value: boolean | string | string[] | Dropd
  *  yyyy-mm-dd
  */
 export declare const getDateValue: (value: string) => string;
-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?: SystemOfMeasurementType | null, language?: string) => number | string | null | undefined;
-}
-export declare const CustomFieldRuntime: ICustomFieldRuntime;
+/**
+ * Format a custom field value to ensure a consistent representation in the ui.
+ */
+export declare const getCustomFieldValueForDisplayInUI: (value: number | string | null | undefined, _unit: UnitUsType | UnitSiType | null | undefined, _systemOfMeasurement?: SystemOfMeasurementType | null, language?: string) => number | string | null | undefined;
+/**
+ * type guard to ensure that a value is of a type compatible with custom fields
+ */
+export declare const isValidCustomFieldValue: (value: unknown) => value is string | number | boolean | DropdownSelection | string[] | DropdownSelection[] | null;