@trackunit/iris-app-runtime-core 1.8.78 → 1.8.80

package/index.cjs.js

@@ -42,25 +42,31 @@ const getHostConnector = () => {
     return hostConnector.promise;
 };
 
-const AnalyticsContextRuntime = {
+/**
+ * This is the runtime API for interacting with analytics engine.
+ */
+const AnalyticsRuntime = () => ({
     logPageView: async (details) => {
         const api = await getHostConnector();
-        api.logPageView(details);
+        await api.logPageView(details);
     },
     logError: async (details) => {
         const api = await getHostConnector();
-        api.logError(details);
+        await api.logError(details);
     },
     logEvent: async (eventName, details, nameSupplement) => {
         const api = await getHostConnector();
-        api.logEvent(eventName, details, nameSupplement);
+        await api.logEvent(eventName, details, nameSupplement);
     },
     setUserProperty: async (name, data) => {
         const api = await getHostConnector();
-        api.setUserProperty(name, data);
+        await api.setUserProperty(name, data);
     },
-};
+});
 
+/**
+ * This is the runtime API for interacting with asset information available only on the asset page.
+ */
 const AssetRuntime = {
     getAssetInfo: async () => {
         const api = await getHostConnector();
@@ -355,29 +361,6 @@ const ExportDataRuntime = {
     },
 };
 
-const OemBrandingContextRuntime = {
-    getOemBrandingContextRuntime: async () => {
-        const api = await getHostConnector();
-        return {
-            getAllBrandingDetails: api.getAllBrandingDetails,
-            getOemImage: api.getOemImage,
-            getOemBranding: api.getOemBranding,
-        };
-    },
-    getAllBrandingDetails: async () => {
-        const api = await getHostConnector();
-        return api.getAllBrandingDetails();
-    },
-    getOemImage: async (imageId, size) => {
-        const api = await getHostConnector();
-        return api.getOemImage(imageId, size);
-    },
-    getOemBranding: async (accountId) => {
-        const api = await getHostConnector();
-        return api.getOemBranding(accountId);
-    },
-};
-
 const ModalDialogRuntime = {
     async openModal() {
         const scrollX = window.scrollX || 0;
@@ -474,6 +457,21 @@ const NavigationRuntime = {
     },
 };
 
+const OemBrandingRuntime = {
+    getAllBrandingDetails: async () => {
+        const api = await getHostConnector();
+        return api.getAllBrandingDetails();
+    },
+    getOemImage: async (imageId, size) => {
+        const api = await getHostConnector();
+        return api.getOemImage(imageId, size);
+    },
+    getOemBranding: async (accountId) => {
+        const api = await getHostConnector();
+        return api.getOemBranding(accountId);
+    },
+};
+
 const ParamsRuntime = {
     getAppName: async () => {
         const api = await getHostConnector();
@@ -623,7 +621,7 @@ const WidgetConfigRuntime = {
     },
 };
 
-exports.AnalyticsContextRuntime = AnalyticsContextRuntime;
+exports.AnalyticsRuntime = AnalyticsRuntime;
 exports.AssetRuntime = AssetRuntime;
 exports.AssetSortingRuntime = AssetSortingRuntime;
 exports.AssetsFilterBarRuntime = AssetsFilterBarRuntime;
@@ -637,7 +635,7 @@ exports.EventRuntime = EventRuntime;
 exports.ExportDataRuntime = ExportDataRuntime;
 exports.ModalDialogRuntime = ModalDialogRuntime;
 exports.NavigationRuntime = NavigationRuntime;
-exports.OemBrandingContextRuntime = OemBrandingContextRuntime;
+exports.OemBrandingRuntime = OemBrandingRuntime;
 exports.ParamsRuntime = ParamsRuntime;
 exports.RestRuntime = RestRuntime;
 exports.RouterRuntime = RouterRuntime;

package/index.esm.js

@@ -40,25 +40,31 @@ const getHostConnector = () => {
     return hostConnector.promise;
 };
 
-const AnalyticsContextRuntime = {
+/**
+ * This is the runtime API for interacting with analytics engine.
+ */
+const AnalyticsRuntime = () => ({
     logPageView: async (details) => {
         const api = await getHostConnector();
-        api.logPageView(details);
+        await api.logPageView(details);
     },
     logError: async (details) => {
         const api = await getHostConnector();
-        api.logError(details);
+        await api.logError(details);
     },
     logEvent: async (eventName, details, nameSupplement) => {
         const api = await getHostConnector();
-        api.logEvent(eventName, details, nameSupplement);
+        await api.logEvent(eventName, details, nameSupplement);
     },
     setUserProperty: async (name, data) => {
         const api = await getHostConnector();
-        api.setUserProperty(name, data);
+        await api.setUserProperty(name, data);
     },
-};
+});
 
+/**
+ * This is the runtime API for interacting with asset information available only on the asset page.
+ */
 const AssetRuntime = {
     getAssetInfo: async () => {
         const api = await getHostConnector();
@@ -353,29 +359,6 @@ const ExportDataRuntime = {
     },
 };
 
-const OemBrandingContextRuntime = {
-    getOemBrandingContextRuntime: async () => {
-        const api = await getHostConnector();
-        return {
-            getAllBrandingDetails: api.getAllBrandingDetails,
-            getOemImage: api.getOemImage,
-            getOemBranding: api.getOemBranding,
-        };
-    },
-    getAllBrandingDetails: async () => {
-        const api = await getHostConnector();
-        return api.getAllBrandingDetails();
-    },
-    getOemImage: async (imageId, size) => {
-        const api = await getHostConnector();
-        return api.getOemImage(imageId, size);
-    },
-    getOemBranding: async (accountId) => {
-        const api = await getHostConnector();
-        return api.getOemBranding(accountId);
-    },
-};
-
 const ModalDialogRuntime = {
     async openModal() {
         const scrollX = window.scrollX || 0;
@@ -472,6 +455,21 @@ const NavigationRuntime = {
     },
 };
 
+const OemBrandingRuntime = {
+    getAllBrandingDetails: async () => {
+        const api = await getHostConnector();
+        return api.getAllBrandingDetails();
+    },
+    getOemImage: async (imageId, size) => {
+        const api = await getHostConnector();
+        return api.getOemImage(imageId, size);
+    },
+    getOemBranding: async (accountId) => {
+        const api = await getHostConnector();
+        return api.getOemBranding(accountId);
+    },
+};
+
 const ParamsRuntime = {
     getAppName: async () => {
         const api = await getHostConnector();
@@ -621,4 +619,4 @@ const WidgetConfigRuntime = {
     },
 };
 
-export { AnalyticsContextRuntime, AssetRuntime, AssetSortingRuntime, AssetsFilterBarRuntime, ConfirmationDialogRuntime, CurrentUserPreferenceRuntime, CurrentUserRuntime, CustomerRuntime, CustomersFilterBarRuntime, EnvironmentRuntime, EventRuntime, ExportDataRuntime, ModalDialogRuntime, NavigationRuntime, OemBrandingContextRuntime, ParamsRuntime, RestRuntime, RouterRuntime, SiteRuntime, SitesFilterBarRuntime, ThemeCssRuntime, TimeRangeRuntime, ToastRuntime, TokenRuntime, UserSubscriptionRuntime, WidgetConfigRuntime, getCustomFieldValueForDisplayInUI, getCustomFieldValueToSaveFromRawValue, getDateValue, getHostConnector, getStringValue, isValidCustomFieldValue, setupHostConnector };
+export { AnalyticsRuntime, AssetRuntime, AssetSortingRuntime, AssetsFilterBarRuntime, ConfirmationDialogRuntime, CurrentUserPreferenceRuntime, CurrentUserRuntime, CustomerRuntime, CustomersFilterBarRuntime, EnvironmentRuntime, EventRuntime, ExportDataRuntime, ModalDialogRuntime, NavigationRuntime, OemBrandingRuntime, ParamsRuntime, RestRuntime, RouterRuntime, SiteRuntime, SitesFilterBarRuntime, ThemeCssRuntime, TimeRangeRuntime, ToastRuntime, TokenRuntime, UserSubscriptionRuntime, WidgetConfigRuntime, getCustomFieldValueForDisplayInUI, getCustomFieldValueToSaveFromRawValue, getDateValue, getHostConnector, getStringValue, isValidCustomFieldValue, setupHostConnector };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@trackunit/iris-app-runtime-core",
-  "version": "1.8.78",
+  "version": "1.8.80",
   "repository": "https://github.com/Trackunit/manager",
   "license": "SEE LICENSE IN LICENSE.txt",
   "engines": {
@@ -8,7 +8,7 @@
   },
   "dependencies": {
     "penpal": "^6.2.2",
-    "@trackunit/iris-app-runtime-core-api": "1.7.78"
+    "@trackunit/iris-app-runtime-core-api": "1.7.80"
   },
   "module": "./index.esm.js",
   "main": "./index.cjs.js",

package/src/AnalyticsRuntime.d.ts

@@ -1,2 +1,5 @@
-import { AnalyticsRuntimeApi } from "@trackunit/iris-app-runtime-core-api";
-export declare const AnalyticsContextRuntime: AnalyticsRuntimeApi;
+import { AnalyticsRuntimeApi, EventDictionary } from "@trackunit/iris-app-runtime-core-api";
+/**
+ * This is the runtime API for interacting with analytics engine.
+ */
+export declare const AnalyticsRuntime: <TEvents extends EventDictionary>() => AnalyticsRuntimeApi<TEvents>;

package/src/AssetRuntime.d.ts

@@ -1,2 +1,5 @@
 import { AssetRuntimeApi } from "@trackunit/iris-app-runtime-core-api";
+/**
+ * This is the runtime API for interacting with asset information available only on the asset page.
+ */
 export declare const AssetRuntime: AssetRuntimeApi;

package/src/OemBrandingRuntime.d.ts

@@ -0,0 +1,2 @@
+import { OemBrandingRuntimeApi } from "@trackunit/iris-app-runtime-core-api";
+export declare const OemBrandingRuntime: OemBrandingRuntimeApi;

package/src/index.d.ts

@@ -13,9 +13,9 @@ export * from "./EnvironmentRuntime";
 export * from "./EventRuntime";
 export * from "./ExportDataRuntime";
 export * from "./HostConnector";
-export * from "./IrisOemManifestRuntime";
 export * from "./ModalDialogRuntime";
 export * from "./NavigationRuntime";
+export * from "./OemBrandingRuntime";
 export * from "./ParamsRuntime";
 export * from "./RestRuntime";
 export * from "./RouterRuntime";

package/src/IrisOemManifestRuntime.d.ts

@@ -1,5 +0,0 @@
-import { OemBrandingContext, OemBrandingRuntimeApi } from "@trackunit/iris-app-runtime-core-api";
-export interface OemBrandingContextRuntimeApi {
-    getOemBrandingContextRuntime: () => Promise<OemBrandingContext>;
-}
-export declare const OemBrandingContextRuntime: OemBrandingContextRuntimeApi & OemBrandingRuntimeApi;