@trackunit/iris-app-runtime-core-api 1.7.9 → 1.7.10

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@trackunit/iris-app-runtime-core-api",
-  "version": "1.7.9",
+  "version": "1.7.10",
   "repository": "https://github.com/Trackunit/manager",
   "license": "SEE LICENSE IN LICENSE.txt",
   "engines": {
@@ -8,8 +8,8 @@
   },
   "dependencies": {
     "jest-fetch-mock": "^3.0.3",
-    "@trackunit/react-core-contexts-api": "1.8.9",
-    "@trackunit/react-test-setup": "1.4.7"
+    "@trackunit/react-core-contexts-api": "1.8.10",
+    "@trackunit/react-test-setup": "1.4.8"
   },
   "module": "./index.esm.js",
   "main": "./index.cjs.js",

package/src/ChildConnector.d.ts

@@ -44,4 +44,10 @@ export interface ChildConnectorApi {
      * @deprecated Use { ChildConnectorApi.onAssetsFilterBarValuesChanged} instead.
      */
     onFilterBarValuesChanged: (filters: FilterBarValues | null) => void;
+    /**
+     * Gets called when the widget poll interval changes.
+     *
+     * @param pollInterval new poll interval
+     */
+    onWidgetPollIntervalChanged: (pollInterval: number) => void;
 }

package/src/HostConnector.d.ts

@@ -1,4 +1,4 @@
-import { AssetSortingContextValue, ConfirmationDialogContextValue, CurrentUserContextInterface, FilterBarValues, IAnalyticsContextAsync, ICurrentUserPreferenceContext, IEnvironmentContext, INavigationContext, ITokenContext, IUserSubscriptionContext, ModalDialogContextValue, OemBrandingContext, TemporalPeriod, TimeRange } from "@trackunit/react-core-contexts-api";
+import { AssetSortingContextValue, ConfirmationDialogContextValue, CurrentUserContextInterface, FilterBarValues, IAnalyticsContextAsync, ICurrentUserPreferenceContext, IEnvironmentContext, INavigationContext, ITokenContext, IUserSubscriptionContext, LoadingState, ModalDialogContextValue, OemBrandingContext, TemporalPeriod, TimeRange } from "@trackunit/react-core-contexts-api";
 import { AssetInfo } from "./AssetRuntime";
 import { CustomerInfo } from "./CustomerRuntime";
 import { EventInfo } from "./EventRuntime";
@@ -20,13 +20,50 @@ export interface HostConnectorApi extends IAnalyticsContextAsync<Record<string,
         timeRange: TimeRange | null;
         temporalPeriod: TemporalPeriod | null;
     }>;
+    /**
+     * Gets the data of the widget.
+     */
     getWidgetData(): Promise<Record<string, unknown>>;
+    /**
+     * Sets the data of the widget.
+     * Dataversion is used to make it easy for you to see what dataVersion is saved in the widget.
+     * Use it to upgrade the widget data to a new version when loading the widget.
+     *
+     * @param data the data to set
+     * @param dataVersion the data version to set
+     * @param title the title to set
+     */
     setWidgetData(data: Record<string, unknown>, dataVersion: number, title?: string): Promise<void>;
+    /**
+     * Gets the data version of the widget.
+     * Dataversion is used to make it easy for you to see what dataVersion is saved in the widget.
+     * Use it to upgrade the widget data to a new version when loading the widget.
+     */
     getWidgetDataVersion(): Promise<number>;
+    /**
+     * Gets the title of the widget.
+     */
     getWidgetTitle(): Promise<string>;
+    /**
+     * Sets the title of the widget.
+     */
     setWidgetTitle(title: string): Promise<void>;
+    /**
+     * Opens the edit mode of the widget.
+     */
     openEditMode(): Promise<void>;
+    /**
+     * Closes the edit mode of the widget.
+     */
     closeEditMode(): Promise<void>;
+    /**
+     * Sets the loading state of the widget.
+     */
+    setLoadingState(loadingState: LoadingState): Promise<void>;
+    /**
+     * Gets the poll interval of the widget.
+     */
+    getWidgetPollInterval(): Promise<number>;
     /**
      * @deprecated Use { getAssetsFilterBarValues } instead.
      * @returns { Promise<FilterBarValues | null> } empty object!
@@ -58,5 +95,17 @@ export interface HostConnectorApi extends IAnalyticsContextAsync<Record<string,
     getCustomerInfo(): Promise<CustomerInfo>;
     getEventInfo(): Promise<EventInfo>;
     getThemeCssProperties(): Promise<ThemeCssProperties | null>;
-    requestTrackunitRestApi: <T, E>(path: string, method: string, requestParams?: RequestParams, body?: unknown, bodyType?: BodyType, secureByDefault?: boolean) => Promise<HttpResponse<T, E>>;
+    /**
+     * Requests the rest api.
+     *
+     * @deprecated Use the Public Graphql instead.
+     * @param path the path of the rest api
+     * @param method the method of the rest api
+     * @param requestParams the request params of the rest api
+     * @param body the body of the rest api
+     * @param bodyType the body type of the rest api
+     * @param secureByDefault
+     * @returns { Promise<HttpResponse> } the response from the rest api
+     */
+    requestTrackunitRestApi: <TData, TError>(path: string, method: string, requestParams?: RequestParams, body?: unknown, bodyType?: BodyType, secureByDefault?: boolean) => Promise<HttpResponse<TData, TError>>;
 }

package/src/WidgetConfigRuntime.d.ts

@@ -0,0 +1,12 @@
+import { LoadingState } from "@trackunit/react-core-contexts-api";
+export interface WidgetConfigRuntimeApi {
+    getData: () => Promise<Record<string, unknown>>;
+    setData: (data: Record<string, unknown>, dataVersion: number, title?: string) => Promise<void>;
+    getDataVersion: () => Promise<number>;
+    openEditMode: () => Promise<void>;
+    closeEditMode: () => Promise<void>;
+    getTitle: () => Promise<string>;
+    setTitle: (title: string) => Promise<void>;
+    setLoadingState: (loadingState: LoadingState) => Promise<void>;
+    getPollInterval: () => Promise<number>;
+}

package/src/index.d.ts

@@ -1,8 +1,8 @@
 export * from "./AssetRuntime";
 export * from "./ChildConnector";
 export * from "./CurrentUserRuntime";
-export * from "./CustomFieldRuntime";
 export * from "./CustomerRuntime";
+export * from "./CustomFieldRuntime";
 export * from "./EventRuntime";
 export * from "./HostConnector";
 export * from "./NavigationRuntime";
@@ -10,3 +10,4 @@ export * from "./RestRuntime";
 export * from "./SiteRuntime";
 export * from "./ThemeCssProperties";
 export * from "./ToastRuntime";
+export * from "./WidgetConfigRuntime";