@genesislcap/grid-pro 14.151.1 → 14.152.0

package/dist/grid-pro.d.ts

@@ -33,6 +33,7 @@ import type { IServerSideGetRowsParams } from '@ag-grid-community/core';
 import type { IServerSideRowModel } from '@ag-grid-community/core';
 import { ITooltipComp } from '@ag-grid-community/core';
 import { ITooltipParams } from '@ag-grid-community/core';
+import { KVStorage } from '@genesislcap/foundation-comms';
 import { LayoutCacheContainer } from '@genesislcap/foundation-utils';
 import { Logger } from '@genesislcap/foundation-logger';
 import { MetadataDetail } from '@genesislcap/foundation-comms';
@@ -41,6 +42,7 @@ import type { RowDataTransaction } from '@ag-grid-community/core';
 import type { RowNodeTransaction } from '@ag-grid-community/core';
 import type { ServerSideTransaction } from '@ag-grid-community/core';
 import type { ServerSideTransactionResult } from '@ag-grid-community/core';
+import { Session } from '@genesislcap/foundation-comms';
 import { SocketObservable } from '@genesislcap/foundation-comms';
 import { Swatch } from '@microsoft/fast-components';
 import { SwatchRGB } from '@microsoft/fast-components';
@@ -1166,7 +1168,7 @@ export declare const GridOptionsConfig: InterfaceSymbol<GridOptionsConfig>;
 export declare class GridPro extends GridPro_base {
     columnApi: ColumnApi;
     gridApi: GridApi;
-    private session;
+    statePersistence: StatePersistence;
     /**
      * Timeout function used to debounce resize calls
      * @internal
@@ -1235,6 +1237,7 @@ export declare class GridPro extends GridPro_base {
     gridComponents: {
         [componentName: string]: any;
     };
+    private columnState;
     protected agAttributes: Record<string, string>;
     protected agPropertiesMap: Record<string, string>;
     protected agGridOptions: GridOptions;
@@ -1277,12 +1280,12 @@ export declare class GridPro extends GridPro_base {
     private removeConfigWidthsToAutosize;
     private saveColumnState;
     /**
-     * Gets the saved grid ColumnState[] from local storage
+     * Gets the saved grid ColumnState[] from storage
      * @remarks This is used to restore the grid state when the grid is rehydrated
      * @privateRemarks Not using `columnApi.get|setColumnState()` for these flows as it doesn't work setting new columnDefs vs different ordering.
      * @public
      */
-    getSavedColumnState(): ColumnState[];
+    getSavedColumnState(): Promise<ColumnState[]>;
     private restoreColumnState;
     private cacheFilterConfig;
     private restoreCachedFilterConfig;
@@ -1292,6 +1295,7 @@ export declare class GridPro extends GridPro_base {
     get gridOptions(): GridOptions;
     get gridProDatasource(): GridProBaseDatasource;
     set gridOptions(options: GridOptions);
+    private initGridOptions;
     /**
      * Will merge templated column definitions with `columnDefs` plus localStorage's column state or `deferredColumnStates`.
      * @deprecated use `applyTemplateDefinitions` instead.
@@ -1299,7 +1303,7 @@ export declare class GridPro extends GridPro_base {
      * @param deferredColumnDefsOrState - If true, will merge the column definitions with the saved column state or the `deferredColumnStates` property on the `grid-pro-genesis-datasource` element.
      * @returns The merged column definitions.
      */
-    applyTemplateDefinitions(columnDefs: ColDef[], deferredColumnDefsOrState?: boolean): ColDef<any>[];
+    applyTemplateDefinitions(columnDefs: ColDef[], deferredColumnDefsOrState?: boolean): Promise<ColDef<any>[]>;
     /**
      * Will merge templated column definitions with `columnDefs` plus localStorage's column state or `deferredColumnStates`.
      * @public
@@ -1309,7 +1313,7 @@ export declare class GridPro extends GridPro_base {
      * on the `grid-pro-genesis-datasource` element. Defaults to false but `grid-pro-genesis-datasource` will set this to true.
      * @returns The merged column definitions.
      */
-    mergeAllColumnDefsAndStates(columnDefs: ColDef[], deferredColumnDefsOrState?: boolean): ColDef<any>[];
+    mergeAllColumnDefsAndStates(columnDefs: ColDef[], deferredColumnDefsOrState?: boolean): Promise<ColDef<any>[]>;
     get observedAttributes(): string[];
     agAttributeChangedCallback(attName: any, oldValue: any, newValue: any): void;
     globalEventListener(eventType: any, event: any): void;
@@ -1360,6 +1364,20 @@ declare const GridPro_base: (new (...args: any[]) => {
     removeEventListener<K_1 extends keyof HTMLElementEventMap>(type: K_1, listener: (this: HTMLElement, ev: HTMLElementEventMap[K_1]) => any, options?: boolean | EventListenerOptions): void;
     removeEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void;
     readonly attributes: NamedNodeMap;
+    /**
+     * Injectable config that allows to change grid options on an app level basis
+     * To modify options, register instance of the config in DOM container that is
+     * above the grid or on the top level of the application, so it applies to all grids.
+     *
+     * @example
+     * ```
+     * DI.getOrCreateDOMContainer().register([
+     *       Registration.instance<GridOptionsConfig>(GridOptionsConfig, {
+     *         headerHeight: 50,
+     *       }),
+     *     ]);
+     * ```
+     */
     readonly classList: DOMTokenList;
     className: string;
     readonly clientHeight: number;
@@ -1444,12 +1462,6 @@ declare const GridPro_base: (new (...args: any[]) => {
     appendChild<T_1 extends Node>(node: T_1): T_1;
     compareDocumentPosition(other: Node): number;
     contains(other: Node): boolean;
-    /**
-     * Gets the saved grid ColumnState[] from local storage
-     * @remarks This is used to restore the grid state when the grid is rehydrated
-     * @privateRemarks Not using `columnApi.get|setColumnState()` for these flows as it doesn't work setting new columnDefs vs different ordering.
-     * @public
-     */
     getRootNode(options?: GetRootNodeOptions): Node;
     hasChildNodes(): boolean;
     insertBefore<T_2 extends Node>(node: T_2, child: Node): T_2;
@@ -2552,6 +2564,28 @@ declare const GridProServerSideDatasource_base: (new (...args: any[]) => {
  */
 export declare const gridProTemplate: ViewTemplate;
 
+/**
+ * Implementation for the KV Storage State Persistence interface.
+ * @public
+ */
+export declare class KVStorageStatePersistence implements StatePersistence {
+    kvStorage: KVStorage;
+    session: Session;
+    getColumnState(persistColumnStateKey: string): Promise<ColumnState[]>;
+    saveColumnState(persistColumnStateKey: string, columnState: ColumnState[]): Promise<void>;
+    private migrateLocalStorageToKVStorage;
+}
+
+/**
+ * Implementation for the Local Storage State Persistence interface.
+ * @public
+ */
+export declare class LocalStorageStatePersistence implements StatePersistence {
+    session: Session;
+    getColumnState(persistColumnStateKey: string): Promise<ColumnState[]>;
+    saveColumnState(persistColumnStateKey: string, columnState: ColumnState[]): Promise<void>;
+}
+
 /**
  * Logger for the grid-pro package
  * @public
@@ -2689,6 +2723,30 @@ export declare class SelectRenderer extends FoundationElement implements ICellRe
     selectionChanged: (e: any) => void;
 }
 
+/**
+ * Represents a state persistence and its capabilities.
+ * Provides methods to set and get columns from the storage.
+ * @public
+ */
+export declare interface StatePersistence {
+    /**
+     * Returns the column state for the given key.
+     * @public
+     */
+    getColumnState(persistColumnStateKey: string): Promise<ColumnState[]>;
+    /**
+     * Saves the column state for the given key.
+     * @public
+     */
+    saveColumnState(persistColumnStateKey: string, columnState: ColumnState[]): Promise<void>;
+}
+
+/**
+ * The DI token for the StatePersistence interface.
+ * @internal
+ */
+export declare const StatePersistence: InterfaceSymbol<StatePersistence>;
+
 declare class StreamBaseDatasource {
     protected rowId: string;
     rowData: Map<string, any>;

package/docs/api/grid-pro.gridpro.applytemplatedefinitions.md

@@ -14,7 +14,7 @@ Will merge templated column definitions with `columnDefs` plus localStorage's co
 **Signature:**
 
 ```typescript
-applyTemplateDefinitions(columnDefs: ColDef[], deferredColumnDefsOrState?: boolean): ColDef<any>[];
+applyTemplateDefinitions(columnDefs: ColDef[], deferredColumnDefsOrState?: boolean): Promise<ColDef<any>[]>;
 ```
 
 ## Parameters
@@ -26,7 +26,7 @@ applyTemplateDefinitions(columnDefs: ColDef[], deferredColumnDefsOrState?: boole
 
 **Returns:**
 
-ColDef&lt;any&gt;\[\]
+Promise&lt;ColDef&lt;any&gt;\[\]&gt;
 
 The merged column definitions.
 

package/docs/api/grid-pro.gridpro.getsavedcolumnstate.md

@@ -4,16 +4,16 @@
 
 ## GridPro.getSavedColumnState() method
 
-Gets the saved grid ColumnState\[\] from local storage
+Gets the saved grid ColumnState\[\] from storage
 
 **Signature:**
 
 ```typescript
-getSavedColumnState(): ColumnState[];
+getSavedColumnState(): Promise<ColumnState[]>;
 ```
 **Returns:**
 
-ColumnState\[\]
+Promise&lt;ColumnState\[\]&gt;
 
 ## Remarks
 

package/docs/api/grid-pro.gridpro.md

@@ -58,6 +58,7 @@ Grid Pro is a Web Component wrapper around the AG Grid Community library.
 |  [onlyTemplateColDefs](./grid-pro.gridpro.onlytemplatecoldefs.md) |  | boolean |  |
 |  [persistColumnStateKey](./grid-pro.gridpro.persistcolumnstatekey.md) |  | string | The key to use for persisting the column state in local storage. |
 |  [rowHeight](./grid-pro.gridpro.rowheight.md) |  | number |  |
+|  [statePersistence](./grid-pro.gridpro.statepersistence.md) |  | [StatePersistence](./grid-pro.statepersistence.md) |  |
 |  [theme](./grid-pro.gridpro.theme.md) |  | string |  |
 
 ## Methods
@@ -70,7 +71,7 @@ Grid Pro is a Web Component wrapper around the AG Grid Community library.
 |  [combineAllGridComponents(gridOptionsComponents)](./grid-pro.gridpro.combineallgridcomponents.md) |  |  |
 |  [connectedCallback()](./grid-pro.gridpro.connectedcallback.md) |  |  |
 |  [disconnectedCallback()](./grid-pro.gridpro.disconnectedcallback.md) |  |  |
-|  [getSavedColumnState()](./grid-pro.gridpro.getsavedcolumnstate.md) |  | Gets the saved grid ColumnState\[\] from local storage |
+|  [getSavedColumnState()](./grid-pro.gridpro.getsavedcolumnstate.md) |  | Gets the saved grid ColumnState\[\] from storage |
 |  [globalEventListener(eventType, event)](./grid-pro.gridpro.globaleventlistener.md) |  |  |
 |  [mergeAllColumnDefsAndStates(columnDefs, deferredColumnDefsOrState)](./grid-pro.gridpro.mergeallcolumndefsandstates.md) |  | Will merge templated column definitions with <code>columnDefs</code> plus localStorage's column state or <code>deferredColumnStates</code>. |
 |  [statePersistanceEnabled()](./grid-pro.gridpro.statepersistanceenabled.md) |  |  |

package/docs/api/grid-pro.gridpro.mergeallcolumndefsandstates.md

@@ -9,7 +9,7 @@ Will merge templated column definitions with `columnDefs` plus localStorage's co
 **Signature:**
 
 ```typescript
-mergeAllColumnDefsAndStates(columnDefs: ColDef[], deferredColumnDefsOrState?: boolean): ColDef<any>[];
+mergeAllColumnDefsAndStates(columnDefs: ColDef[], deferredColumnDefsOrState?: boolean): Promise<ColDef<any>[]>;
 ```
 
 ## Parameters
@@ -21,7 +21,7 @@ mergeAllColumnDefsAndStates(columnDefs: ColDef[], deferredColumnDefsOrState?: bo
 
 **Returns:**
 
-ColDef&lt;any&gt;\[\]
+Promise&lt;ColDef&lt;any&gt;\[\]&gt;
 
 The merged column definitions.
 

package/docs/api/grid-pro.gridpro.statepersistence.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [GridPro](./grid-pro.gridpro.md) &gt; [statePersistence](./grid-pro.gridpro.statepersistence.md)
+
+## GridPro.statePersistence property
+
+**Signature:**
+
+```typescript
+statePersistence: StatePersistence;
+```

package/docs/api/grid-pro.kvstoragestatepersistence.getcolumnstate.md

@@ -0,0 +1,22 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [KVStorageStatePersistence](./grid-pro.kvstoragestatepersistence.md) &gt; [getColumnState](./grid-pro.kvstoragestatepersistence.getcolumnstate.md)
+
+## KVStorageStatePersistence.getColumnState() method
+
+**Signature:**
+
+```typescript
+getColumnState(persistColumnStateKey: string): Promise<ColumnState[]>;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  persistColumnStateKey | string |  |
+
+**Returns:**
+
+Promise&lt;ColumnState\[\]&gt;
+

package/docs/api/grid-pro.kvstoragestatepersistence.kvstorage.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [KVStorageStatePersistence](./grid-pro.kvstoragestatepersistence.md) &gt; [kvStorage](./grid-pro.kvstoragestatepersistence.kvstorage.md)
+
+## KVStorageStatePersistence.kvStorage property
+
+**Signature:**
+
+```typescript
+kvStorage: KVStorage;
+```

package/docs/api/grid-pro.kvstoragestatepersistence.md

@@ -0,0 +1,29 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [KVStorageStatePersistence](./grid-pro.kvstoragestatepersistence.md)
+
+## KVStorageStatePersistence class
+
+Implementation for the KV Storage State Persistence interface.
+
+**Signature:**
+
+```typescript
+export declare class KVStorageStatePersistence implements StatePersistence 
+```
+**Implements:** [StatePersistence](./grid-pro.statepersistence.md)
+
+## Properties
+
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [kvStorage](./grid-pro.kvstoragestatepersistence.kvstorage.md) |  | KVStorage |  |
+|  [session](./grid-pro.kvstoragestatepersistence.session.md) |  | Session |  |
+
+## Methods
+
+|  Method | Modifiers | Description |
+|  --- | --- | --- |
+|  [getColumnState(persistColumnStateKey)](./grid-pro.kvstoragestatepersistence.getcolumnstate.md) |  |  |
+|  [saveColumnState(persistColumnStateKey, columnState)](./grid-pro.kvstoragestatepersistence.savecolumnstate.md) |  |  |
+

package/docs/api/grid-pro.kvstoragestatepersistence.savecolumnstate.md

@@ -0,0 +1,23 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [KVStorageStatePersistence](./grid-pro.kvstoragestatepersistence.md) &gt; [saveColumnState](./grid-pro.kvstoragestatepersistence.savecolumnstate.md)
+
+## KVStorageStatePersistence.saveColumnState() method
+
+**Signature:**
+
+```typescript
+saveColumnState(persistColumnStateKey: string, columnState: ColumnState[]): Promise<void>;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  persistColumnStateKey | string |  |
+|  columnState | ColumnState\[\] |  |
+
+**Returns:**
+
+Promise&lt;void&gt;
+

package/docs/api/grid-pro.kvstoragestatepersistence.session.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [KVStorageStatePersistence](./grid-pro.kvstoragestatepersistence.md) &gt; [session](./grid-pro.kvstoragestatepersistence.session.md)
+
+## KVStorageStatePersistence.session property
+
+**Signature:**
+
+```typescript
+session: Session;
+```

package/docs/api/grid-pro.localstoragestatepersistence.getcolumnstate.md

@@ -0,0 +1,22 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [LocalStorageStatePersistence](./grid-pro.localstoragestatepersistence.md) &gt; [getColumnState](./grid-pro.localstoragestatepersistence.getcolumnstate.md)
+
+## LocalStorageStatePersistence.getColumnState() method
+
+**Signature:**
+
+```typescript
+getColumnState(persistColumnStateKey: string): Promise<ColumnState[]>;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  persistColumnStateKey | string |  |
+
+**Returns:**
+
+Promise&lt;ColumnState\[\]&gt;
+

package/docs/api/grid-pro.localstoragestatepersistence.md

@@ -0,0 +1,28 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [LocalStorageStatePersistence](./grid-pro.localstoragestatepersistence.md)
+
+## LocalStorageStatePersistence class
+
+Implementation for the Local Storage State Persistence interface.
+
+**Signature:**
+
+```typescript
+export declare class LocalStorageStatePersistence implements StatePersistence 
+```
+**Implements:** [StatePersistence](./grid-pro.statepersistence.md)
+
+## Properties
+
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [session](./grid-pro.localstoragestatepersistence.session.md) |  | Session |  |
+
+## Methods
+
+|  Method | Modifiers | Description |
+|  --- | --- | --- |
+|  [getColumnState(persistColumnStateKey)](./grid-pro.localstoragestatepersistence.getcolumnstate.md) |  |  |
+|  [saveColumnState(persistColumnStateKey, columnState)](./grid-pro.localstoragestatepersistence.savecolumnstate.md) |  |  |
+

package/docs/api/grid-pro.localstoragestatepersistence.savecolumnstate.md

@@ -0,0 +1,23 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [LocalStorageStatePersistence](./grid-pro.localstoragestatepersistence.md) &gt; [saveColumnState](./grid-pro.localstoragestatepersistence.savecolumnstate.md)
+
+## LocalStorageStatePersistence.saveColumnState() method
+
+**Signature:**
+
+```typescript
+saveColumnState(persistColumnStateKey: string, columnState: ColumnState[]): Promise<void>;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  persistColumnStateKey | string |  |
+|  columnState | ColumnState\[\] |  |
+
+**Returns:**
+
+Promise&lt;void&gt;
+

package/docs/api/grid-pro.localstoragestatepersistence.session.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [LocalStorageStatePersistence](./grid-pro.localstoragestatepersistence.md) &gt; [session](./grid-pro.localstoragestatepersistence.session.md)
+
+## LocalStorageStatePersistence.session property
+
+**Signature:**
+
+```typescript
+session: Session;
+```

package/docs/api/grid-pro.md

@@ -20,6 +20,8 @@
 |  [GridProClientSideDatasource](./grid-pro.gridproclientsidedatasource.md) | The Genesis Datasource element, for client-side \| CSRM-compatible data fetching and used exclusively by the GridPro element. |
 |  [GridProColumn](./grid-pro.gridprocolumn.md) | The Grid Pro Column element. |
 |  [GridProGenesisDatasource](./grid-pro.gridprogenesisdatasource.md) | The Genesis Datasource element, for CSRM-compatible data fetching and used exclusively by the GridPro element. |
+|  [KVStorageStatePersistence](./grid-pro.kvstoragestatepersistence.md) | Implementation for the KV Storage State Persistence interface. |
+|  [LocalStorageStatePersistence](./grid-pro.localstoragestatepersistence.md) | Implementation for the Local Storage State Persistence interface. |
 |  [MultiselectEditor](./grid-pro.multiselecteditor.md) | The AG Multiselect Editor element. |
 |  [NumberEditor](./grid-pro.numbereditor.md) | The AG Number Editor element. |
 |  [SelectEditor](./grid-pro.selecteditor.md) | The AG Select Editor element. |
@@ -55,6 +57,7 @@
 |  [MultiselectEditorParams](./grid-pro.multiselecteditorparams.md) | Parameters used to configure [MultiselectEditor](./grid-pro.multiselecteditor.md) |
 |  [NumberEditorParams](./grid-pro.numbereditorparams.md) | Parameters used to configure [NumberEditor](./grid-pro.numbereditor.md) |
 |  [SelectEditorParams](./grid-pro.selecteditorparams.md) | Parameters used to configure [SelectEditor](./grid-pro.selecteditor.md) |
+|  [StatePersistence](./grid-pro.statepersistence.md) | Represents a state persistence and its capabilities. Provides methods to set and get columns from the storage. |
 |  [StringEditorParams](./grid-pro.stringeditorparams.md) | Parameters used to configure [StringEditor](./grid-pro.stringeditor.md) |
 
 ## Variables

package/docs/api/grid-pro.statepersistence.getcolumnstate.md

@@ -0,0 +1,24 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [StatePersistence](./grid-pro.statepersistence.md) &gt; [getColumnState](./grid-pro.statepersistence.getcolumnstate.md)
+
+## StatePersistence.getColumnState() method
+
+Returns the column state for the given key.
+
+**Signature:**
+
+```typescript
+getColumnState(persistColumnStateKey: string): Promise<ColumnState[]>;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  persistColumnStateKey | string |  |
+
+**Returns:**
+
+Promise&lt;ColumnState\[\]&gt;
+

package/docs/api/grid-pro.statepersistence.md

@@ -0,0 +1,21 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [StatePersistence](./grid-pro.statepersistence.md)
+
+## StatePersistence interface
+
+Represents a state persistence and its capabilities. Provides methods to set and get columns from the storage.
+
+**Signature:**
+
+```typescript
+export interface StatePersistence 
+```
+
+## Methods
+
+|  Method | Description |
+|  --- | --- |
+|  [getColumnState(persistColumnStateKey)](./grid-pro.statepersistence.getcolumnstate.md) | Returns the column state for the given key. |
+|  [saveColumnState(persistColumnStateKey, columnState)](./grid-pro.statepersistence.savecolumnstate.md) | Saves the column state for the given key. |
+

package/docs/api/grid-pro.statepersistence.savecolumnstate.md

@@ -0,0 +1,25 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [StatePersistence](./grid-pro.statepersistence.md) &gt; [saveColumnState](./grid-pro.statepersistence.savecolumnstate.md)
+
+## StatePersistence.saveColumnState() method
+
+Saves the column state for the given key.
+
+**Signature:**
+
+```typescript
+saveColumnState(persistColumnStateKey: string, columnState: ColumnState[]): Promise<void>;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  persistColumnStateKey | string |  |
+|  columnState | ColumnState\[\] |  |
+
+**Returns:**
+
+Promise&lt;void&gt;
+

package/docs/api-report.md

@@ -39,6 +39,7 @@ import type { IServerSideGetRowsParams } from '@ag-grid-community/core';
 import type { IServerSideRowModel } from '@ag-grid-community/core';
 import { ITooltipComp } from '@ag-grid-community/core';
 import { ITooltipParams } from '@ag-grid-community/core';
+import { KVStorage } from '@genesislcap/foundation-comms';
 import { LayoutCacheContainer } from '@genesislcap/foundation-utils';
 import { Logger } from '@genesislcap/foundation-logger';
 import { MetadataDetail } from '@genesislcap/foundation-comms';
@@ -47,6 +48,7 @@ import type { RowDataTransaction } from '@ag-grid-community/core';
 import type { RowNodeTransaction } from '@ag-grid-community/core';
 import type { ServerSideTransaction } from '@ag-grid-community/core';
 import type { ServerSideTransactionResult } from '@ag-grid-community/core';
+import { Session } from '@genesislcap/foundation-comms';
 import { SocketObservable } from '@genesislcap/foundation-comms';
 import { Swatch } from '@microsoft/fast-components';
 import { SwatchRGB } from '@microsoft/fast-components';
@@ -798,7 +800,7 @@ export class GridPro extends GridPro_base {
     // (undocumented)
     protected agPropertiesMap: Record<string, string>;
     // @deprecated
-    applyTemplateDefinitions(columnDefs: ColDef[], deferredColumnDefsOrState?: boolean): ColDef<any>[];
+    applyTemplateDefinitions(columnDefs: ColDef[], deferredColumnDefsOrState?: boolean): Promise<ColDef<any>[]>;
     asyncAdd: boolean;
     asyncRemove: boolean;
     asyncUpdate: boolean;
@@ -822,7 +824,7 @@ export class GridPro extends GridPro_base {
     enableRowFlashing: boolean;
     // (undocumented)
     eventsAndCallbacks: any;
-    getSavedColumnState(): ColumnState[];
+    getSavedColumnState(): Promise<ColumnState[]>;
     // (undocumented)
     globalEventListener(eventType: any, event: any): void;
     // (undocumented)
@@ -849,7 +851,7 @@ export class GridPro extends GridPro_base {
     headerHeight: number;
     // (undocumented)
     protected initialised: boolean;
-    mergeAllColumnDefsAndStates(columnDefs: ColDef[], deferredColumnDefsOrState?: boolean): ColDef<any>[];
+    mergeAllColumnDefsAndStates(columnDefs: ColDef[], deferredColumnDefsOrState?: boolean): Promise<ColDef<any>[]>;
     // (undocumented)
     get observedAttributes(): string[];
     // (undocumented)
@@ -860,6 +862,8 @@ export class GridPro extends GridPro_base {
     // (undocumented)
     statePersistanceEnabled(): boolean;
     // (undocumented)
+    statePersistence: StatePersistence;
+    // (undocumented)
     theme: string;
     // (undocumented)
     themeChanged(oldValue: string, newValue: string): void;
@@ -1041,6 +1045,28 @@ export class GridProServerSideDatasource extends GridProServerSideDatasource_bas
 // @public
 export const gridProTemplate: ViewTemplate;
 
+// @public
+export class KVStorageStatePersistence implements StatePersistence {
+    // (undocumented)
+    getColumnState(persistColumnStateKey: string): Promise<ColumnState[]>;
+    // (undocumented)
+    kvStorage: KVStorage;
+    // (undocumented)
+    saveColumnState(persistColumnStateKey: string, columnState: ColumnState[]): Promise<void>;
+    // (undocumented)
+    session: Session;
+}
+
+// @public
+export class LocalStorageStatePersistence implements StatePersistence {
+    // (undocumented)
+    getColumnState(persistColumnStateKey: string): Promise<ColumnState[]>;
+    // (undocumented)
+    saveColumnState(persistColumnStateKey: string, columnState: ColumnState[]): Promise<void>;
+    // (undocumented)
+    session: Session;
+}
+
 // @public
 export const logger: Logger;
 
@@ -1193,6 +1219,17 @@ export class SelectRenderer extends FoundationElement implements ICellRendererCo
     value: string;
 }
 
+// Warning: (ae-internal-mixed-release-tag) Mixed release tags are not allowed for "StatePersistence" because one of its declarations is marked as @internal
+//
+// @public
+export interface StatePersistence {
+    getColumnState(persistColumnStateKey: string): Promise<ColumnState[]>;
+    saveColumnState(persistColumnStateKey: string, columnState: ColumnState[]): Promise<void>;
+}
+
+// @internal
+export const StatePersistence: InterfaceSymbol<StatePersistence>;
+
 // Warning: (ae-forgotten-export) The symbol "StreamBaseDatasource" needs to be exported by the entry point index.d.ts
 //
 // @alpha