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

package/index.cjs.js

@@ -3,7 +3,9 @@
 var irisAppRuntimeCoreApi = require('@trackunit/iris-app-runtime-core-api');
 var penpal = require('penpal');
 
-const doNothingByDefault = () => { };
+const doNothingByDefault = () => {
+    // do nothing by default
+};
 /**
  * Setup using the subscribedMethods to subscribe to events from the host.
  *
@@ -34,7 +36,7 @@ const hostConnector = setupHostConnector({});
 /**
  * Gets the host connector.
  *
- * @returns { Promise<HostConnectorApi> } the connection to the host
+ * @returns { Promise<Connection<HostConnectorApi>> } the connection to the host
  */
 const getHostConnector = () => {
     return hostConnector.promise;
@@ -362,6 +364,18 @@ const OemBrandingContextRuntime = {
             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 = {
@@ -475,14 +489,28 @@ const ParamsRuntime = {
     },
 };
 
+/**
+ * Rest Runtime API accessor.
+ * This API is deprecated and will be removed in the future.
+ *
+ * @deprecated Use the Public Graphql instead.
+ */
 const RestRuntime = {
     apiHost: "https://API_HOST",
     async request(path, method, requestParams, body, bodyType, secureByDefault) {
         const api = await getHostConnector();
         return api.requestTrackunitRestApi(path, method, requestParams, body, bodyType, secureByDefault);
     },
+    async requestTrackunitRestApi(path, method, requestParams, body, bodyType, secureByDefault) {
+        const api = await getHostConnector();
+        return api.requestTrackunitRestApi(path, method, requestParams, body, bodyType, secureByDefault);
+    },
 };
 
+/**
+ * Router Runtime API accessor.
+ * This API is used to get the base path of the router.
+ */
 const RouterRuntime = {
     getBasePath: () => {
         return `${document.getElementById("baseHref")?.getAttribute("href") || "<missing baseHref>"}${global.module}`;
@@ -557,23 +585,23 @@ const UserSubscriptionRuntime = {
 };
 
 const WidgetConfigRuntime = {
-    getData: async () => {
+    getWidgetData: async () => {
         const api = await getHostConnector();
         return api.getWidgetData();
     },
-    setData: async (data, dataVersion, title) => {
+    setWidgetData: async (data, dataVersion, title) => {
         const api = await getHostConnector();
         return api.setWidgetData(data, dataVersion, title);
     },
-    getDataVersion: async () => {
+    getWidgetDataVersion: async () => {
         const api = await getHostConnector();
         return api.getWidgetDataVersion();
     },
-    getTitle: async () => {
+    getWidgetTitle: async () => {
         const api = await getHostConnector();
         return api.getWidgetTitle();
     },
-    setTitle: async (title) => {
+    setWidgetTitle: async (title) => {
         const api = await getHostConnector();
         return api.setWidgetTitle(title);
     },
@@ -589,7 +617,7 @@ const WidgetConfigRuntime = {
         const api = await getHostConnector();
         return api.setLoadingState(loadingState);
     },
-    getPollInterval: async () => {
+    getWidgetPollInterval: async () => {
         const api = await getHostConnector();
         return api.getWidgetPollInterval();
     },

package/index.esm.js

@@ -1,7 +1,9 @@
 export * from '@trackunit/iris-app-runtime-core-api';
 import { connectToParent } from 'penpal';
 
-const doNothingByDefault = () => { };
+const doNothingByDefault = () => {
+    // do nothing by default
+};
 /**
  * Setup using the subscribedMethods to subscribe to events from the host.
  *
@@ -32,7 +34,7 @@ const hostConnector = setupHostConnector({});
 /**
  * Gets the host connector.
  *
- * @returns { Promise<HostConnectorApi> } the connection to the host
+ * @returns { Promise<Connection<HostConnectorApi>> } the connection to the host
  */
 const getHostConnector = () => {
     return hostConnector.promise;
@@ -360,6 +362,18 @@ const OemBrandingContextRuntime = {
             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 = {
@@ -473,14 +487,28 @@ const ParamsRuntime = {
     },
 };
 
+/**
+ * Rest Runtime API accessor.
+ * This API is deprecated and will be removed in the future.
+ *
+ * @deprecated Use the Public Graphql instead.
+ */
 const RestRuntime = {
     apiHost: "https://API_HOST",
     async request(path, method, requestParams, body, bodyType, secureByDefault) {
         const api = await getHostConnector();
         return api.requestTrackunitRestApi(path, method, requestParams, body, bodyType, secureByDefault);
     },
+    async requestTrackunitRestApi(path, method, requestParams, body, bodyType, secureByDefault) {
+        const api = await getHostConnector();
+        return api.requestTrackunitRestApi(path, method, requestParams, body, bodyType, secureByDefault);
+    },
 };
 
+/**
+ * Router Runtime API accessor.
+ * This API is used to get the base path of the router.
+ */
 const RouterRuntime = {
     getBasePath: () => {
         return `${document.getElementById("baseHref")?.getAttribute("href") || "<missing baseHref>"}${global.module}`;
@@ -555,23 +583,23 @@ const UserSubscriptionRuntime = {
 };
 
 const WidgetConfigRuntime = {
-    getData: async () => {
+    getWidgetData: async () => {
         const api = await getHostConnector();
         return api.getWidgetData();
     },
-    setData: async (data, dataVersion, title) => {
+    setWidgetData: async (data, dataVersion, title) => {
         const api = await getHostConnector();
         return api.setWidgetData(data, dataVersion, title);
     },
-    getDataVersion: async () => {
+    getWidgetDataVersion: async () => {
         const api = await getHostConnector();
         return api.getWidgetDataVersion();
     },
-    getTitle: async () => {
+    getWidgetTitle: async () => {
         const api = await getHostConnector();
         return api.getWidgetTitle();
     },
-    setTitle: async (title) => {
+    setWidgetTitle: async (title) => {
         const api = await getHostConnector();
         return api.setWidgetTitle(title);
     },
@@ -587,7 +615,7 @@ const WidgetConfigRuntime = {
         const api = await getHostConnector();
         return api.setLoadingState(loadingState);
     },
-    getPollInterval: async () => {
+    getWidgetPollInterval: async () => {
         const api = await getHostConnector();
         return api.getWidgetPollInterval();
     },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@trackunit/iris-app-runtime-core",
-  "version": "1.8.75",
+  "version": "1.8.78",
   "repository": "https://github.com/Trackunit/manager",
   "license": "SEE LICENSE IN LICENSE.txt",
   "engines": {
@@ -8,10 +8,7 @@
   },
   "dependencies": {
     "penpal": "^6.2.2",
-    "jest-fetch-mock": "^3.0.3",
-    "@trackunit/react-core-contexts-api": "1.8.74",
-    "@trackunit/iris-app-runtime-core-api": "1.7.75",
-    "@trackunit/react-test-setup": "1.4.69"
+    "@trackunit/iris-app-runtime-core-api": "1.7.78"
   },
   "module": "./index.esm.js",
   "main": "./index.cjs.js",

package/src/AnalyticsRuntime.d.ts

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

package/src/AssetRuntime.d.ts

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

package/src/AssetSortingRuntime.d.ts

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

package/src/AssetsFilterBarRuntime.d.ts

@@ -1,4 +1,4 @@
-import { FilterBarValues } from "@trackunit/react-core-contexts-api";
+import { FilterBarValues } from "@trackunit/iris-app-runtime-core-api";
 export interface AssetsFilterBarRuntimeApi {
     getAssetsFilterBarValues: () => Promise<FilterBarValues | null>;
 }

package/src/ConfirmationDialogRuntime.d.ts

@@ -1,2 +1,2 @@
-import { ConfirmationDialogContextValue } from "@trackunit/react-core-contexts-api";
-export declare const ConfirmationDialogRuntime: ConfirmationDialogContextValue;
+import { ConfirmationDialogRuntimeApi } from "@trackunit/iris-app-runtime-core-api";
+export declare const ConfirmationDialogRuntime: ConfirmationDialogRuntimeApi;

package/src/CurrentPreferenceUserRuntime.d.ts

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

package/src/CurrentUserRuntime.d.ts

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

package/src/CustomFieldRuntime.d.ts

@@ -1,5 +1,4 @@
-import { CustomFieldValue, UnitOfMeasurementType } from "@trackunit/iris-app-runtime-core-api";
-import { SystemOfMeasurementType } from "@trackunit/react-core-contexts-api";
+import { CustomFieldValue, SystemOfMeasurementType, UnitOfMeasurementType } from "@trackunit/iris-app-runtime-core-api";
 export interface DropdownSelection {
     value: string;
 }

package/src/CustomerRuntime.d.ts

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

package/src/CustomersFilterBarRuntime.d.ts

@@ -1,4 +1,4 @@
-import { FilterBarValues } from "@trackunit/react-core-contexts-api";
+import { FilterBarValues } from "@trackunit/iris-app-runtime-core-api";
 export interface CustomersFilterBarRuntimeApi {
     getCustomersFilterBarValues: () => Promise<FilterBarValues | null>;
 }

package/src/EnvironmentRuntime.d.ts

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

package/src/EventRuntime.d.ts

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

package/src/HostConnector.d.ts

@@ -1,18 +1,15 @@
 import { ChildConnectorApi, HostConnectorApi } from "@trackunit/iris-app-runtime-core-api";
-import { Methods } from "penpal";
+import { AsyncMethodReturns, Connection, Methods } from "penpal";
 /**
  * Setup using the subscribedMethods to subscribe to events from the host.
  *
  * @param subscribedMethods the methods to subscribe to
  * @returns { Connection<HostConnectorApi> } the connection to the host
  */
-export declare const setupHostConnector: (subscribedMethods: Partial<ChildConnectorApi> & Methods) => {
-    promise: Promise<import("penpal").AsyncMethodReturns<HostConnectorApi>>;
-    destroy: Function;
-};
+export declare const setupHostConnector: (subscribedMethods: Partial<ChildConnectorApi> & Methods) => Connection<HostConnectorApi>;
 /**
  * Gets the host connector.
  *
- * @returns { Promise<HostConnectorApi> } the connection to the host
+ * @returns { Promise<Connection<HostConnectorApi>> } the connection to the host
  */
-export declare const getHostConnector: () => Promise<import("penpal").AsyncMethodReturns<HostConnectorApi>>;
+export declare const getHostConnector: () => Promise<AsyncMethodReturns<HostConnectorApi>>;

package/src/IrisOemManifestRuntime.d.ts

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

package/src/ModalDialogRuntime.d.ts

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

package/src/NavigationRuntime.d.ts

@@ -1,2 +1,2 @@
-import { INavigationRuntime } from "@trackunit/iris-app-runtime-core-api";
-export declare const NavigationRuntime: INavigationRuntime;
+import { NavigationRuntimeApi } from "@trackunit/iris-app-runtime-core-api";
+export declare const NavigationRuntime: NavigationRuntimeApi;

package/src/ParamsRuntime.d.ts

@@ -1,6 +1,2 @@
-export interface ParamsRuntimeApi {
-    getAppName: () => Promise<string | undefined>;
-    getExtensionName: () => Promise<string | undefined>;
-    getOrgName: () => Promise<string | undefined>;
-}
+import { ParamsRuntimeApi } from "@trackunit/iris-app-runtime-core-api";
 export declare const ParamsRuntime: ParamsRuntimeApi;

package/src/RestRuntime.d.ts

@@ -1,7 +1,13 @@
-import { BodyType, HttpResponse, RequestParams } from "@trackunit/iris-app-runtime-core-api";
+import { BodyType, HttpResponse, RequestParams, RestRuntimeApi } from "@trackunit/iris-app-runtime-core-api";
 export type RestRunTimeResponse = HttpResponse<any, any>;
-export interface RestRuntimeApi {
+export interface RestRuntimeApiExtended extends 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: RestRuntimeApi;
+/**
+ * Rest Runtime API accessor.
+ * This API is deprecated and will be removed in the future.
+ *
+ * @deprecated Use the Public Graphql instead.
+ */
+export declare const RestRuntime: RestRuntimeApiExtended;

package/src/RouterRuntime.d.ts

@@ -1,4 +1,6 @@
-export interface RouterRuntimeApi {
-    getBasePath: () => string;
-}
+import { RouterRuntimeApi } from "@trackunit/iris-app-runtime-core-api";
+/**
+ * Router Runtime API accessor.
+ * This API is used to get the base path of the router.
+ */
 export declare const RouterRuntime: RouterRuntimeApi;

package/src/SiteRuntime.d.ts

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

package/src/SitesFilterBarRuntime.d.ts

@@ -1,4 +1,4 @@
-import { FilterBarValues } from "@trackunit/react-core-contexts-api";
+import { FilterBarValues } from "@trackunit/iris-app-runtime-core-api";
 export interface SitesFilterBarRuntimeApi {
     getSitesFilterBarValues: () => Promise<FilterBarValues | null>;
 }

package/src/ThemeCssRuntime.d.ts

@@ -1,5 +1,2 @@
-import { ThemeCssProperties } from "@trackunit/iris-app-runtime-core-api";
-export interface ThemeCssRuntimeApi {
-    getThemeCssProperties: () => Promise<ThemeCssProperties | null>;
-}
+import { ThemeCssRuntimeApi } from "@trackunit/iris-app-runtime-core-api";
 export declare const ThemeCssRuntime: ThemeCssRuntimeApi;

package/src/TimeRangeRuntime.d.ts

@@ -1,11 +1,2 @@
-import { TemporalPeriod, TimeRange } from "@trackunit/react-core-contexts-api";
-export interface TimeRangeRuntimeApi {
-    /**
-     * Gets the time range.
-     */
-    getTimeRange: () => Promise<{
-        timeRange: TimeRange | null;
-        temporalPeriod: TemporalPeriod | null;
-    }>;
-}
+import { TimeRangeRuntimeApi } from "@trackunit/iris-app-runtime-core-api";
 export declare const TimeRangeRuntime: TimeRangeRuntimeApi;

package/src/ToastRuntime.d.ts

@@ -1,4 +1,4 @@
-import { Toast } from "@trackunit/react-core-contexts-api";
+import { Toast } from "@trackunit/iris-app-runtime-core-api";
 export declare const ToastRuntime: {
     addToast(toast: Toast): Promise<void | "primaryAction" | "secondaryAction">;
     removeToast(id: string): Promise<void>;

package/src/TokenRuntime.d.ts

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

package/src/UserSubscriptionRuntime.d.ts

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