@trackunit/iris-app-runtime-core-api 1.7.50 → 1.7.52

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@trackunit/iris-app-runtime-core-api",
-  "version": "1.7.50",
+  "version": "1.7.52",
   "repository": "https://github.com/Trackunit/manager",
   "license": "SEE LICENSE IN LICENSE.txt",
   "engines": {
@@ -8,8 +8,10 @@
   },
   "dependencies": {
     "jest-fetch-mock": "^3.0.3",
-    "@trackunit/react-core-contexts-api": "1.8.50",
-    "@trackunit/react-test-setup": "1.4.46"
+    "@trackunit/react-core-contexts-api": "1.8.52",
+    "@trackunit/react-test-setup": "1.4.47",
+    "@graphql-typed-document-node/core": "^3.2.0",
+    "@trackunit/shared-utils": "1.9.47"
   },
   "module": "./index.esm.js",
   "main": "./index.cjs.js",

package/src/ExportDataRuntime.d.ts

@@ -0,0 +1,51 @@
+import { TypedDocumentNode } from "@graphql-typed-document-node/core";
+import { DateTimeFormatType } from "@trackunit/shared-utils";
+type ValuePathType = {
+    [key: string]: string;
+};
+export interface BaseExportable {
+    /**
+     * The accessor to use for the value or array of accessors to use for the value.
+     * If not provided, the value will not be accessed.
+     */
+    accessor: string | Array<string>;
+    /**
+     * The translation map to use for the value.
+     * If not provided, the value will not be translated.
+     */
+    translationMap?: ValuePathType | null;
+    /**
+     * The transformer to use for the value.
+     * If not provided, the value will not be transformed.
+     */
+    transformer?: {
+        type: "customFields";
+        id: string;
+    } | {
+        type: "date";
+        format: DateTimeFormatType;
+    };
+    /**
+     * The prefix to add to the value only if the value is not empty
+     */
+    prefix?: string;
+    /**
+     * The postfix to add to the value only if the value is not empty
+     */
+    postfix?: string;
+}
+export type ExportableColumn = BaseExportable & {
+    id: string;
+    header: string;
+};
+export interface ExportDataProps<TData, TVariables> {
+    document: TypedDocumentNode<TData, TVariables>;
+    variables: TVariables;
+    columns: Array<ExportableColumn>;
+    name: string;
+    headers?: Record<string, string>;
+}
+export interface ExportDataRuntimeApi {
+    exportData: <TData, TVariables>(props: ExportDataProps<TData, TVariables>) => Promise<void>;
+}
+export {};

package/src/HostConnector.d.ts

@@ -2,11 +2,12 @@ import { AssetSortingContextValue, ConfirmationDialogContextValue, CurrentUserCo
 import { AssetInfo } from "./AssetRuntime";
 import { CustomerInfo } from "./CustomerRuntime";
 import { EventInfo } from "./EventRuntime";
+import { ExportDataRuntimeApi } from "./ExportDataRuntime";
 import { BodyType, HttpResponse, RequestParams } from "./RestRuntime";
 import { SiteInfo } from "./SiteRuntime";
 import { ThemeCssProperties } from "./ThemeCssProperties";
 import { PublicToast } from "./ToastRuntime";
-export interface HostConnectorApi extends IAnalyticsContextAsync<Record<string, never>>, INavigationContext, OemBrandingContext, ICurrentUserPreferenceContext, ConfirmationDialogContextValue, ModalDialogContextValue {
+export interface HostConnectorApi extends IAnalyticsContextAsync<Record<string, never>>, ExportDataRuntimeApi, INavigationContext, OemBrandingContext, ICurrentUserPreferenceContext, ConfirmationDialogContextValue, ModalDialogContextValue {
     getAssetSortingState(): Promise<AssetSortingContextValue["sortingState"]>;
     setAssetSortingState(...args: Parameters<AssetSortingContextValue["setSortBy"]>): Promise<void>;
     getEnvironmentContext(): Promise<IEnvironmentContext>;
@@ -87,6 +88,12 @@ export interface HostConnectorApi extends IAnalyticsContextAsync<Record<string,
      * @param toast the toast to add
      */
     addToast(toast: PublicToast): Promise<void | "primaryAction" | "secondaryAction">;
+    /**
+     * Removes a toast from the host pages toast stack.
+     *
+     * @param id the id of the toast to remove
+     */
+    removeToast(id: string): Promise<void>;
     getAppName(): string | undefined;
     getOrgName(): string | undefined;
     getExtensionName(): string | undefined;

package/src/index.d.ts

@@ -4,6 +4,7 @@ export * from "./CurrentUserRuntime";
 export * from "./CustomerRuntime";
 export * from "./CustomFieldRuntime";
 export * from "./EventRuntime";
+export * from "./ExportDataRuntime";
 export * from "./HostConnector";
 export * from "./NavigationRuntime";
 export * from "./RestRuntime";