@trackunit/iris-app-runtime-core-api 1.13.3 → 1.13.4-alpha-58b6b568fca.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@trackunit/iris-app-runtime-core-api",
-  "version": "1.13.3",
+  "version": "1.13.4-alpha-58b6b568fca.0",
   "repository": "https://github.com/Trackunit/manager",
   "license": "SEE LICENSE IN LICENSE.txt",
   "engines": {
@@ -8,8 +8,8 @@
   },
   "dependencies": {
     "@graphql-typed-document-node/core": "^3.2.0",
-    "@trackunit/shared-utils": "1.13.78",
-    "@trackunit/geo-json-utils": "1.11.79"
+    "@trackunit/shared-utils": "1.13.79-alpha-58b6b568fca.0",
+    "@trackunit/geo-json-utils": "1.11.80-alpha-58b6b568fca.0"
   },
   "module": "./index.esm.js",
   "main": "./index.cjs.js",

package/src/ChildConnector.d.ts

@@ -1,5 +1,6 @@
 import { AssetSortingState } from "./AssetSortingRuntime";
 import { FilterBarValues } from "./FilterBarRuntime";
+import { TableColumnOptions } from "./TablePersistenceRuntime";
 import { TemporalPeriod, TimeRange } from "./TimeRangeRuntime";
 import { TokenContext } from "./TokenRuntime";
 export interface ChildConnectorApi {
@@ -47,6 +48,12 @@ export interface ChildConnectorApi {
      * @deprecated Use { ChildConnectorApi.onAssetsFilterBarValuesChanged} instead.
      */
     onFilterBarValuesChanged: (filters: FilterBarValues | null) => void;
+    /**
+     * Gets called when the table persistence state changes.
+     *
+     * @param tableState new table column options
+     */
+    onTablePersistenceStateChanged: (tableState: TableColumnOptions | null) => void;
     /**
      * Gets called when the widget poll interval changes.
      *

package/src/HostConnector.d.ts

@@ -17,11 +17,12 @@ import { OemBrandingRuntimeApi } from "./OemBrandingRuntime";
 import { ParamsRuntimeApi } from "./ParamsRuntime";
 import { RestRuntimeApi } from "./RestRuntime";
 import { SiteRuntimeApi } from "./SiteRuntime";
+import { TablePersistenceRuntimeApi } from "./TablePersistenceRuntime";
 import { ThemeCssRuntimeApi } from "./ThemeCssRuntime";
 import { TimeRangeRuntimeApi } from "./TimeRangeRuntime";
 import { ToastRuntimeApi } from "./ToastRuntime";
 import { TokenRuntimeApi } from "./TokenRuntime";
 import { UserSubscriptionRuntimeApi } from "./UserSubscriptionRuntime";
 import { WidgetConfigRuntimeApi } from "./WidgetConfigRuntime";
-export interface HostConnectorApi extends AnalyticsRuntimeApi<EventDictionary>, AssetRuntimeApi, AssetSortingRuntimeApi, ConfirmationDialogRuntimeApi, CurrentUserPreferenceRuntimeApi, CurrentUserRuntimeApi, CustomerRuntimeApi, EnvironmentRuntimeApi, EventRuntimeApi, ExportDataRuntimeApi, FilterBarRuntimeApi, GeolocationRuntimeApi, ModalDialogRuntimeApi, NavigationRuntimeApi, OemBrandingRuntimeApi, RestRuntimeApi, SiteRuntimeApi, ThemeCssRuntimeApi, TimeRangeRuntimeApi, ToastRuntimeApi, TokenRuntimeApi, UserSubscriptionRuntimeApi, ParamsRuntimeApi, FeatureFlagRuntimeApi, WidgetConfigRuntimeApi {
+export interface HostConnectorApi extends AnalyticsRuntimeApi<EventDictionary>, AssetRuntimeApi, AssetSortingRuntimeApi, ConfirmationDialogRuntimeApi, CurrentUserPreferenceRuntimeApi, CurrentUserRuntimeApi, CustomerRuntimeApi, EnvironmentRuntimeApi, EventRuntimeApi, ExportDataRuntimeApi, FilterBarRuntimeApi, GeolocationRuntimeApi, ModalDialogRuntimeApi, NavigationRuntimeApi, OemBrandingRuntimeApi, RestRuntimeApi, SiteRuntimeApi, TablePersistenceRuntimeApi, ThemeCssRuntimeApi, TimeRangeRuntimeApi, ToastRuntimeApi, TokenRuntimeApi, UserSubscriptionRuntimeApi, ParamsRuntimeApi, FeatureFlagRuntimeApi, WidgetConfigRuntimeApi {
 }

package/src/TablePersistenceRuntime.d.ts

@@ -0,0 +1,37 @@
+export type SortingEntry = {
+    id: string;
+    desc: boolean;
+};
+export type ColumnPinning = {
+    left?: Array<string>;
+    right?: Array<string>;
+};
+export type TableColumnOptions = {
+    columnOrder?: Array<string>;
+    sorting?: Array<SortingEntry>;
+    columnVisibility?: Record<string, boolean>;
+    columnSizing?: Record<string, number>;
+    columnPinning?: ColumnPinning;
+};
+export interface TablePersistenceContext {
+    /**
+     * The current persisted table state, or `null` if no state has been persisted yet.
+     */
+    tableState: TableColumnOptions | null;
+    /**
+     * Whether the table persistence state is still loading.
+     */
+    isLoading: boolean;
+}
+export interface TablePersistenceRuntimeApi {
+    /**
+     * Returns the currently persisted table column state for the active table.
+     */
+    getTablePersistenceState: () => Promise<TableColumnOptions | null>;
+    /**
+     * Persists a new table column state.
+     *
+     * @param state - The table column options to persist.
+     */
+    setTablePersistenceState: (state: TableColumnOptions) => Promise<void>;
+}

package/src/index.d.ts

@@ -22,6 +22,7 @@ export * from "./ParamsRuntime";
 export * from "./RestRuntime";
 export * from "./RouterRuntime";
 export * from "./SiteRuntime";
+export * from "./TablePersistenceRuntime";
 export * from "./ThemeCssProperties";
 export * from "./ThemeCssRuntime";
 export * from "./TimeRangeRuntime";