@trackunit/iris-app-runtime-core 0.3.172 → 0.3.174

package/index.cjs.js

@@ -43,10 +43,9 @@ const doNothingByDefault = () => { };
  * @returns { Connection<HostConnectorApi> } the connection to the host
  */
 const setupHostConnector = (subscribedMethods) => {
-    var _a;
     const methods = Object.assign({ onFilterBarValuesChanged: doNothingByDefault, onTokenChanged: doNothingByDefault, onAssetSortingStateChanged: doNothingByDefault }, subscribedMethods);
     const connection = penpal.connectToParent({ methods });
-    (_a = connection.promise) === null || _a === void 0 ? void 0 : _a.catch(err => {
+    connection.promise.catch(err => {
         // TODO consider how to handle this catch
         // eslint-disable-next-line no-console
         console.log(err);
@@ -135,6 +134,8 @@ const CurrentUserRuntime = {
  * Get the value of a custom field from a raw value.
  *
  * @param customFieldDefinition the definition of the custom field
+ * @param customFieldDefinition.type the type of the custom field definition
+ * @param customFieldDefinition.isInteger whether the custom field is an integer
  * @param newValue the new value to set
  * @returns { CustomFieldValue } an updated CustomFieldValue
  */
@@ -171,7 +172,7 @@ const getCustomFieldValueToSaveFromRawValue = (customFieldDefinition, newValue)
                     stringArrayValue.push(item);
                 }
                 else {
-                    stringArrayValue.push(item === null || item === void 0 ? void 0 : item.value);
+                    stringArrayValue.push(item.value);
                 }
             });
         }
@@ -180,7 +181,7 @@ const getCustomFieldValueToSaveFromRawValue = (customFieldDefinition, newValue)
                 stringArrayValue.push(newValue);
             }
             else if (typeof newValue === "object") {
-                stringArrayValue.push(newValue === null || newValue === void 0 ? void 0 : newValue.value);
+                stringArrayValue.push(newValue.value);
             }
         }
         return {
@@ -237,7 +238,7 @@ const getCustomFieldValueToSaveFromRawValue = (customFieldDefinition, newValue)
  */
 const getStringValue = (value) => {
     const stringValue = value;
-    if (stringValue === null || stringValue === undefined) {
+    if (value === null || value === undefined) {
         return null;
     }
     else if (stringValue.trim().length === 0) {
@@ -330,6 +331,23 @@ const OemBrandingContextRuntime = {
     }),
 };
 
+const ModalDialogRuntime = {
+    openModal() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const scrollX = window.scrollX || 0;
+            const scrollY = window.scrollY || 0;
+            const api = yield getHostConnector();
+            return api.openModal({ scrollX, scrollY });
+        });
+    },
+    closeModal() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const api = yield getHostConnector();
+            return api.closeModal();
+        });
+    },
+};
+
 const NavigationRuntime = {
     gotoAssetHome: (assetId, options) => __awaiter(void 0, void 0, void 0, function* () {
         const api = yield getHostConnector();
@@ -454,6 +472,7 @@ exports.CustomerRuntime = CustomerRuntime;
 exports.EnvironmentRuntime = EnvironmentRuntime;
 exports.EventRuntime = EventRuntime;
 exports.FilterBarRuntime = FilterBarRuntime;
+exports.ModalDialogRuntime = ModalDialogRuntime;
 exports.NavigationRuntime = NavigationRuntime;
 exports.OemBrandingContextRuntime = OemBrandingContextRuntime;
 exports.ParamsRuntime = ParamsRuntime;

package/index.esm.js

@@ -39,10 +39,9 @@ const doNothingByDefault = () => { };
  * @returns { Connection<HostConnectorApi> } the connection to the host
  */
 const setupHostConnector = (subscribedMethods) => {
-    var _a;
     const methods = Object.assign({ onFilterBarValuesChanged: doNothingByDefault, onTokenChanged: doNothingByDefault, onAssetSortingStateChanged: doNothingByDefault }, subscribedMethods);
     const connection = connectToParent({ methods });
-    (_a = connection.promise) === null || _a === void 0 ? void 0 : _a.catch(err => {
+    connection.promise.catch(err => {
         // TODO consider how to handle this catch
         // eslint-disable-next-line no-console
         console.log(err);
@@ -131,6 +130,8 @@ const CurrentUserRuntime = {
  * Get the value of a custom field from a raw value.
  *
  * @param customFieldDefinition the definition of the custom field
+ * @param customFieldDefinition.type the type of the custom field definition
+ * @param customFieldDefinition.isInteger whether the custom field is an integer
  * @param newValue the new value to set
  * @returns { CustomFieldValue } an updated CustomFieldValue
  */
@@ -167,7 +168,7 @@ const getCustomFieldValueToSaveFromRawValue = (customFieldDefinition, newValue)
                     stringArrayValue.push(item);
                 }
                 else {
-                    stringArrayValue.push(item === null || item === void 0 ? void 0 : item.value);
+                    stringArrayValue.push(item.value);
                 }
             });
         }
@@ -176,7 +177,7 @@ const getCustomFieldValueToSaveFromRawValue = (customFieldDefinition, newValue)
                 stringArrayValue.push(newValue);
             }
             else if (typeof newValue === "object") {
-                stringArrayValue.push(newValue === null || newValue === void 0 ? void 0 : newValue.value);
+                stringArrayValue.push(newValue.value);
             }
         }
         return {
@@ -233,7 +234,7 @@ const getCustomFieldValueToSaveFromRawValue = (customFieldDefinition, newValue)
  */
 const getStringValue = (value) => {
     const stringValue = value;
-    if (stringValue === null || stringValue === undefined) {
+    if (value === null || value === undefined) {
         return null;
     }
     else if (stringValue.trim().length === 0) {
@@ -326,6 +327,23 @@ const OemBrandingContextRuntime = {
     }),
 };
 
+const ModalDialogRuntime = {
+    openModal() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const scrollX = window.scrollX || 0;
+            const scrollY = window.scrollY || 0;
+            const api = yield getHostConnector();
+            return api.openModal({ scrollX, scrollY });
+        });
+    },
+    closeModal() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const api = yield getHostConnector();
+            return api.closeModal();
+        });
+    },
+};
+
 const NavigationRuntime = {
     gotoAssetHome: (assetId, options) => __awaiter(void 0, void 0, void 0, function* () {
         const api = yield getHostConnector();
@@ -440,4 +458,4 @@ const UserSubscriptionRuntime = {
     }),
 };
 
-export { AnalyticsContextRuntime, AssetRuntime, AssetSortingRuntime, ConfirmationDialogRuntime, CurrentUserPreferenceRuntime, CurrentUserRuntime, CustomerRuntime, EnvironmentRuntime, EventRuntime, FilterBarRuntime, NavigationRuntime, OemBrandingContextRuntime, ParamsRuntime, RestRuntime, RouterRuntime, SiteRuntime, ToastRuntime, TokenRuntime, UserSubscriptionRuntime, getCustomFieldValueForDisplayInUI, getCustomFieldValueToSaveFromRawValue, getDateValue, getHostConnector, getStringValue, isValidCustomFieldValue, setupHostConnector };
+export { AnalyticsContextRuntime, AssetRuntime, AssetSortingRuntime, ConfirmationDialogRuntime, CurrentUserPreferenceRuntime, CurrentUserRuntime, CustomerRuntime, EnvironmentRuntime, EventRuntime, FilterBarRuntime, ModalDialogRuntime, 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.172",
+  "version": "0.3.174",
   "repository": "https://github.com/Trackunit/manager",
   "license": "SEE LICENSE IN LICENSE.txt",
   "engines": {

package/src/AnalyticsRuntime.d.ts

@@ -1,2 +1,2 @@
 import { IAnalyticsContextAsync } from "@trackunit/react-core-contexts-api";
-export declare const AnalyticsContextRuntime: IAnalyticsContextAsync<{}>;
+export declare const AnalyticsContextRuntime: IAnalyticsContextAsync<Record<string, never>>;

package/src/AssetRuntime.d.ts

@@ -1,5 +1,5 @@
 import { AssetInfo } from "@trackunit/iris-app-runtime-core-api";
-export interface IAssetRuntime {
+export interface AssetRuntimeApi {
     getAssetInfo: () => Promise<AssetInfo>;
 }
-export declare const AssetRuntime: IAssetRuntime;
+export declare const AssetRuntime: AssetRuntimeApi;

package/src/AssetSortingRuntime.d.ts

@@ -1,6 +1,6 @@
 import { AssetSortingContextValue } from "@trackunit/react-core-contexts-api";
-export interface IAssetSortingRuntime {
+export interface AssetSortingRuntimeApi {
     getAssetSortingState: () => Promise<AssetSortingContextValue["sortingState"]>;
     setAssetSortingState: (...args: Parameters<AssetSortingContextValue["setSortBy"]>) => Promise<void>;
 }
-export declare const AssetSortingRuntime: IAssetSortingRuntime;
+export declare const AssetSortingRuntime: AssetSortingRuntimeApi;

package/src/CurrentPreferenceUserRuntime.d.ts

@@ -1,4 +1,4 @@
 import { ICurrentUserPreferenceContext } from "@trackunit/react-core-contexts-api";
-export interface ICurrentUserPreferenceRuntime extends ICurrentUserPreferenceContext {
+export interface CurrentUserPreferenceRuntimeApi extends ICurrentUserPreferenceContext {
 }
-export declare const CurrentUserPreferenceRuntime: ICurrentUserPreferenceRuntime;
+export declare const CurrentUserPreferenceRuntime: CurrentUserPreferenceRuntimeApi;

package/src/CurrentUserRuntime.d.ts

@@ -1,5 +1,5 @@
 import { ICurrentUserContext } from "@trackunit/react-core-contexts-api";
-export interface ICurrentUserRuntime {
+export interface CurrentUserRuntimeApi {
     getCurrentUserContext: () => Promise<ICurrentUserContext>;
 }
-export declare const CurrentUserRuntime: ICurrentUserRuntime;
+export declare const CurrentUserRuntime: CurrentUserRuntimeApi;

package/src/CustomFieldRuntime.d.ts

@@ -7,6 +7,8 @@ export interface DropdownSelection {
  * Get the value of a custom field from a raw value.
  *
  * @param customFieldDefinition the definition of the custom field
+ * @param customFieldDefinition.type the type of the custom field definition
+ * @param customFieldDefinition.isInteger whether the custom field is an integer
  * @param newValue the new value to set
  * @returns { CustomFieldValue } an updated CustomFieldValue
  */
@@ -17,7 +19,7 @@ export declare const getCustomFieldValueToSaveFromRawValue: (customFieldDefiniti
 /**
  *  Convert the received value to a string
  */
-export declare const getStringValue: (value: boolean | string | string[] | DropdownSelection[] | DropdownSelection | number) => string | null;
+export declare const getStringValue: (value: boolean | string | string[] | DropdownSelection[] | DropdownSelection | number | null | undefined) => string | null;
 /**
  *  Format the received value to a date string
  *  yyyy-mm-dd

package/src/CustomerRuntime.d.ts

@@ -1,5 +1,5 @@
 import { CustomerInfo } from "@trackunit/iris-app-runtime-core-api";
-export interface ICustomerRuntime {
+export interface CustomerRuntimeApi {
     getCustomerInfo: () => Promise<CustomerInfo>;
 }
-export declare const CustomerRuntime: ICustomerRuntime;
+export declare const CustomerRuntime: CustomerRuntimeApi;

package/src/EnvironmentRuntime.d.ts

@@ -1,5 +1,5 @@
 import { IEnvironmentContext } from "@trackunit/react-core-contexts-api";
-export interface IEnvironmentRuntime {
+export interface EnvironmentRuntimeApi {
     getEnvironmentContext: () => Promise<IEnvironmentContext>;
 }
-export declare const EnvironmentRuntime: IEnvironmentRuntime;
+export declare const EnvironmentRuntime: EnvironmentRuntimeApi;

package/src/EventRuntime.d.ts

@@ -1,5 +1,5 @@
 import { EventInfo } from "@trackunit/iris-app-runtime-core-api";
-export interface IEventRuntime {
+export interface EventRuntimeApi {
     getEventInfo: () => Promise<EventInfo>;
 }
-export declare const EventRuntime: IEventRuntime;
+export declare const EventRuntime: EventRuntimeApi;

package/src/FilterBarRuntime.d.ts

@@ -1,5 +1,5 @@
 import { FilterBarValues } from "@trackunit/react-core-contexts-api";
-export interface IFilterBarRuntime {
+export interface FilterBarRuntimeApi {
     getFilterBarValues: () => Promise<FilterBarValues>;
 }
-export declare const FilterBarRuntime: IFilterBarRuntime;
+export declare const FilterBarRuntime: FilterBarRuntimeApi;

package/src/IrisOemManifestRuntime.d.ts

@@ -1,5 +1,5 @@
 import { IOemBrandingContext } from "@trackunit/react-core-contexts-api";
-export interface IOemBrandingContextRuntime {
+export interface OemBrandingContextRuntimeApi {
     getOemBrandingContextRuntime: () => Promise<IOemBrandingContext>;
 }
-export declare const OemBrandingContextRuntime: IOemBrandingContextRuntime;
+export declare const OemBrandingContextRuntime: OemBrandingContextRuntimeApi;

package/src/ModalDialogRuntime.d.ts

@@ -0,0 +1,2 @@
+import { ModalDialogContextValue } from "@trackunit/react-core-contexts-api";
+export declare const ModalDialogRuntime: ModalDialogContextValue;

package/src/ParamsRuntime.d.ts

@@ -1,6 +1,6 @@
-export interface IParamsRuntime {
+export interface ParamsRuntimeApi {
     getAppName: () => Promise<string | undefined>;
     getExtensionName: () => Promise<string | undefined>;
     getOrgName: () => Promise<string | undefined>;
 }
-export declare const ParamsRuntime: IParamsRuntime;
+export declare const ParamsRuntime: ParamsRuntimeApi;

package/src/RestRuntime.d.ts

@@ -1,7 +1,7 @@
 import { BodyType, HttpResponse, RequestParams } from "@trackunit/iris-app-runtime-core-api";
 export type RestRunTimeResponse = HttpResponse<any, any>;
-export interface IRestRuntime {
+export interface RestRuntimeApi {
     apiHost: string;
     request: (path: string, method: string, requestParams?: RequestParams | undefined, body?: unknown, bodyType?: BodyType | undefined, secureByDefault?: boolean | undefined) => Promise<RestRunTimeResponse>;
 }
-export declare const RestRuntime: IRestRuntime;
+export declare const RestRuntime: RestRuntimeApi;

package/src/RouterRuntime.d.ts

@@ -1,4 +1,4 @@
-export interface IRouterRuntime {
+export interface RouterRuntimeApi {
     getBasePath: () => string;
 }
-export declare const RouterRuntime: IRouterRuntime;
+export declare const RouterRuntime: RouterRuntimeApi;

package/src/SiteRuntime.d.ts

@@ -1,5 +1,5 @@
 import { SiteInfo } from "@trackunit/iris-app-runtime-core-api";
-export interface ISiteRuntime {
+export interface SiteRuntimeApi {
     getSiteInfo: () => Promise<SiteInfo>;
 }
-export declare const SiteRuntime: ISiteRuntime;
+export declare const SiteRuntime: SiteRuntimeApi;

package/src/TokenRuntime.d.ts

@@ -1,5 +1,5 @@
 import { ITokenContext } from "@trackunit/react-core-contexts-api";
-export interface ITokenRuntime {
+export interface TokenRuntimeApi {
     getTokenContext: () => Promise<ITokenContext>;
 }
-export declare const TokenRuntime: ITokenRuntime;
+export declare const TokenRuntime: TokenRuntimeApi;

package/src/UserSubscriptionRuntime.d.ts

@@ -1,5 +1,5 @@
 import { IUserSubscriptionContext } from "@trackunit/react-core-contexts-api";
-export interface IUserSubscriptionRuntime {
+export interface UserSubscriptionRuntimeApi {
     getUserSubscriptionContext: () => Promise<IUserSubscriptionContext>;
 }
-export declare const UserSubscriptionRuntime: IUserSubscriptionRuntime;
+export declare const UserSubscriptionRuntime: UserSubscriptionRuntimeApi;

package/src/index.d.ts

@@ -12,6 +12,7 @@ export * from "./EventRuntime";
 export * from "./FilterBarRuntime";
 export * from "./HostConnector";
 export * from "./IrisOemManifestRuntime";
+export * from "./ModalDialogRuntime";
 export * from "./NavigationRuntime";
 export * from "./ParamsRuntime";
 export * from "./RestRuntime";