@genesislcap/grid-pro 14.199.2-alpha-1ab46f4.0 → 14.199.2

package/dist/grid-pro.d.ts

@@ -1,5 +1,5 @@
 import { ActionMenuItem } from '@genesislcap/foundation-ui';
-import { BehaviorSubject } from 'rxjs';
+import { Auth } from '@genesislcap/foundation-comms';
 import { Binding } from '@microsoft/fast-element';
 import { CaptureType } from '@microsoft/fast-element';
 import { ColDef } from '@ag-grid-community/core';
@@ -18,6 +18,7 @@ import { DatasourceStatusChangedEvent } from '@genesislcap/foundation-comms';
 import { DOMContainer } from '@genesislcap/foundation-utils';
 import { ElementStyles } from '@microsoft/fast-element';
 import { FieldMetadata } from '@genesislcap/foundation-comms';
+import { FilteredDataServerResult } from '@genesislcap/foundation-comms';
 import { FoundationElement } from '@microsoft/fast-foundation';
 import { FoundationElementRegistry } from '@microsoft/fast-foundation';
 import { FoundationLayoutContainer } from '@genesislcap/foundation-utils';
@@ -31,19 +32,23 @@ import { ICellRendererComp } from '@ag-grid-community/core';
 import { ICellRendererFunc } from '@ag-grid-community/core';
 import { ICellRendererParams } from '@ag-grid-community/core';
 import { InterfaceSymbol } from '@microsoft/fast-foundation';
-import { IServerSideRowModel } from '@ag-grid-community/core';
+import type { IServerSideDatasource } from '@ag-grid-community/core';
+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';
 import { OverrideFoundationElementDefinition } from '@microsoft/fast-foundation';
-import { PaginationChangedEvent } from '@ag-grid-community/core';
-import { RowDataTransaction } from '@ag-grid-community/core';
-import { RowNodeTransaction } from '@ag-grid-community/core';
+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 { ServerSideTransactionResult } 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 { SocketSubscription } from '@genesislcap/foundation-comms';
 import { Swatch } from '@microsoft/fast-components';
 import { SwatchRGB } from '@microsoft/fast-components';
 import { TextField } from '@genesislcap/foundation-ui';
@@ -973,7 +978,6 @@ declare interface FuiCellRendererParams extends ICellRendererParams {
 
 declare class GenesisGridDatasourceElement extends GenesisGridDatasourceElement_base {
     connect: Connect;
-    datasource: Datasource;
     deferredGridOptions: GridOptions;
     deferredColumnStates: ColumnState[];
     /**
@@ -989,16 +993,6 @@ declare class GenesisGridDatasourceElement extends GenesisGridDatasourceElement_
     orderBy: string;
     resourceName: string;
     reverse: boolean;
-    viewNumber: number;
-    pollingInterval: number;
-    disablePolling: boolean;
-    request: any;
-    /**
-     * Attribute to set whether the REQUEST object should be automatically set up.
-     * @remarks Defaults to `true`. Only applies to REQUEST_SERVER (REQ-REP) resources.
-     * @privateRemarks To avoid breaking changes for now, once V15 is out this will be removed and the default behavior will be the same as `false` here.
-     */
-    requestAutoSetup: boolean;
     /**
      * Attribute to set an unique identifier for the row.
      *
@@ -1013,13 +1007,7 @@ declare class GenesisGridDatasourceElement extends GenesisGridDatasourceElement_
      */
     protected get hasDefaultRowId(): boolean;
     protected get defaultRowIdByResourceType(): string;
-    protected criteriaFromFilters: Map<string, string>;
-    protected update: BehaviorSubject<Map<string, string>>;
-    protected datasourceOptions(): DatasourceOptions;
-    private buildCriteria;
-    setFilter(fieldName: string, newFilter: string): void;
-    removeFilter(fieldName: string): void;
-    get isRequestServer(): boolean;
+    protected isRequestServer: boolean;
     datasourceStatusChanged(prev: DatasourceStatus, next: DatasourceStatus): void;
     protected get agGrid(): GridPro | null;
 }
@@ -1649,7 +1637,7 @@ export declare class GridPro extends GridPro_base {
      */
     gridOptionsConfig: GridOptionsConfig;
     constructor();
-    addEventListener(eventType: string, listener: any, options?: boolean | AddEventListenerOptions): void;
+    addEventListener(type: any, listener: any, options?: boolean | AddEventListenerOptions): void;
     private addGridEventListener;
     private handleError;
     hideDatasourceError(): void;
@@ -1923,12 +1911,7 @@ declare const GridPro_base: (new (...args: any[]) => {
     ariaValueNow: string;
     ariaValueText: string;
     role: string;
-    animate(keyframes: PropertyIndexedKeyframes | Keyframe[], options?: number | KeyframeAnimationOptions): Animation; /**
-    * 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
-    */
+    animate(keyframes: PropertyIndexedKeyframes | Keyframe[], options?: number | KeyframeAnimationOptions): Animation;
     getAnimations(options?: GetAnimationsOptions): Animation[];
     after(...nodes: (string | Node)[]): void;
     before(...nodes: (string | Node)[]): void;
@@ -2021,15 +2004,6 @@ declare const GridPro_base: (new (...args: any[]) => {
     onprogress: (this: GlobalEventHandlers, ev: ProgressEvent<EventTarget>) => any;
     onratechange: (this: GlobalEventHandlers, ev: Event) => any;
     onreset: (this: GlobalEventHandlers, ev: Event) => any;
-    /**
-     * Will merge templated column definitions with `columnDefs` plus localStorage's column state or `deferredColumnStates`.
-     * @public
-     * @remarks This will favor the column state from the browser's local storage over the `deferredColumnStates` property on the `grid-pro-genesis-datasource` element.
-     * @param columnDefs - The column definitions to apply to the grid.
-     * @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. Defaults to false but `grid-pro-genesis-datasource` will set this to true.
-     * @returns The merged column definitions.
-     */
     onresize: (this: GlobalEventHandlers, ev: UIEvent) => any;
     onscroll: (this: GlobalEventHandlers, ev: Event) => any;
     onsecuritypolicyviolation: (this: GlobalEventHandlers, ev: SecurityPolicyViolationEvent) => any;
@@ -2540,9 +2514,14 @@ export declare type GridProEventsListeners = {
  * @public
  */
 export declare class GridProGenesisDatasource extends GridProGenesisDatasource_base {
+    auth: Auth;
+    datasource: Datasource;
     applyFuncName: string;
     applyAsyncFuncName: string;
     criteriaChanged(oldCriteria: string, newCriteria: string): void;
+    pollingInterval: number;
+    disablePolling: boolean;
+    request: any;
     requestChanged(oldRequest: string, newRequest: string): void;
     resourceNameChanged(oldValue: string, newValue: string): void;
     restartOnReconnection: boolean;
@@ -2551,6 +2530,8 @@ export declare class GridProGenesisDatasource extends GridProGenesisDatasource_b
     private updateSub;
     private connectionSub;
     private requiresFullRowDataAndColDefs;
+    private criteriaFromFilters;
+    private update;
     connectedCallback(): void;
     disconnectedCallback(): void;
     deepClone(): Node;
@@ -2563,21 +2544,15 @@ export declare class GridProGenesisDatasource extends GridProGenesisDatasource_b
      * @remarks This method is called automatically when the element is connected to the DOM.
      */
     init(columnDefinitions?: ColDef[], columnStates?: ColumnState[]): Promise<void>;
-    /**
-     * Destroys the datasource, resetting it to its initial state.
-     * @public
-     */
-    destroy(): void;
     /**
      * Deinitialises the datasource, resetting it to its initial state.
-     * @deprecated Use `destroy` instead
      * @public
      */
     deinit(): void;
     /**
      * Resets the datasource to its initial state.
      * @public
-     * @deprecated Use `destroy` instead
+     * @deprecated Use `deinit` instead
      */
     reset(): void;
     /**
@@ -2618,11 +2593,13 @@ export declare class GridProGenesisDatasource extends GridProGenesisDatasource_b
      */
     private loadResourceData;
     private handleSnapshot;
-    handleErrors(errors: string | any[]): void;
+    handleErrors(message: string): void;
+    private datasourceOptions;
     private handleStreamResult;
     private applyRequestServerData;
     private applyDataserverData;
     private getAgColumnDefs;
+    private buildCriteria;
     setFilter(fieldName: string, newFilter: string): void;
     removeFilter(fieldName: string): void;
     applyTransaction(agTransaction: RowDataTransaction): RowNodeTransaction | null | undefined;
@@ -2675,10 +2652,6 @@ declare const GridProGenesisDatasource_base: (new (...args: any[]) => {
     readonly classList: DOMTokenList;
     className: string;
     readonly clientHeight: number;
-    /**
-     * Destroys the datasource, resetting it to its initial state.
-     * @public
-     */
     readonly clientLeft: number;
     readonly clientTop: number;
     readonly clientWidth: number;
@@ -3010,42 +2983,30 @@ export declare enum GridProRendererTypes {
 export declare class GridProServerSideDatasource extends GridProServerSideDatasource_base {
     applyFuncName: string;
     applyAsyncFuncName: string;
-    pagination: boolean;
-    /**
-     * The starting VIEW_NUMBER of the data to be fetched.
-     * @remarks The VIEW_NUMBER isincremented by the grid as the user scrolls or changes pages.
-     */
-    zeroBasedViewNumber: boolean;
-    /**
-     * Enable live updates for the grid.
-     * @remarks Only works with DATASERVER resources (StreamDatasource) right now.
-     */
-    liveUpdates: boolean;
-    request: any;
-    private indexes;
-    private ssrmDatasource;
-    private liveUpdatesStream;
-    resourceNameChanged(oldValue: string, newValue: string): void;
     criteriaChanged(oldCriteria: string, newCriteria: string): void;
-    connectedCallback(): void;
-    disconnectedCallback(): void;
-    deepClone(): Node;
     /**
      * Resets the grid data while keeping columnDefs and sends a DATA_LOGOFF message if it's a stream.
      * @remarks This is used when the grid is already initialized and we want to reload the data due to a criteria/filter change.
      * @internal
      */
     private reloadResourceData;
-    init(): Promise<void>;
-    onPaginationChanged(event: PaginationChangedEvent): void;
-    destroy(): Promise<void>;
-    restart(): Promise<void>;
+    resourceNameChanged(oldValue: string, newValue: string): void;
+    pagination: boolean;
+    private indexes;
+    private ssrmDatasource;
+    private originalFieldDef;
+    connectedCallback(): void;
+    disconnectedCallback(): void;
+    deepClone(): Node;
+    deinit(): void;
+    init(): void;
+    restart(): void;
     private clearRowData;
     private getResourceIndexes;
     get params(): any;
     get rowModel(): IServerSideRowModel;
-    private createReqRepRequest;
     private createDataserverStream;
+    private handleStreamDeletesTemp;
     private getAgColumnDefs;
     applyTransaction(agTransaction: RowDataTransaction): ServerSideTransactionResult;
     applyTransactionAsync(agTransaction: RowDataTransaction, callback?: (res: ServerSideTransactionResult) => void): void;
@@ -3260,7 +3221,11 @@ declare const GridProServerSideDatasource_base: (new (...args: any[]) => {
     readonly children: HTMLCollection;
     readonly firstElementChild: Element;
     readonly lastElementChild: Element;
-    append(...nodes: (string | Node)[]): void;
+    append(...nodes: (string | Node)[]): void; /**
+    * Resets the grid data while keeping columnDefs and sends a DATA_LOGOFF message if it's a stream.
+    * @remarks This is used when the grid is already initialized and we want to reload the data due to a criteria/filter change.
+    * @internal
+    */
     prepend(...nodes: (string | Node)[]): void;
     querySelector<K_6 extends keyof HTMLElementTagNameMap>(selectors: K_6): HTMLElementTagNameMap[K_6];
     querySelector<K_7 extends keyof SVGElementTagNameMap>(selectors: K_7): SVGElementTagNameMap[K_7];
@@ -3619,6 +3584,76 @@ export declare interface StatePersistence {
  */
 export declare const StatePersistence: InterfaceSymbol<StatePersistence>;
 
+declare class StreamBaseDatasource {
+    protected rowId: string;
+    rowData: Map<string, any>;
+}
+
+/**
+ * The IServerSideDatasource implementation, used for SSRM (Server-Side Row Model) in the grid.
+ * @alpha
+ */
+export declare class StreamDatasource extends StreamBaseDatasource implements IServerSideDatasource {
+    auth: Auth;
+    connect: Connect;
+    dataserverStream: SocketObservable<FilteredDataServerResult>;
+    dataserverStreamSubscription: SocketSubscription;
+    createDataserverStreamFunc: (existingParams?: any) => Promise<SocketObservable<FilteredDataServerResult>>;
+    private resourceName;
+    resourceParams: any;
+    private resourceIndexes;
+    private resourceColDefs;
+    private maxRows;
+    private maxView;
+    private pagination;
+    streamSourceRef: string;
+    /**
+     * The number of rows in the grid. THIS DO NOT CONSIDER CRITERIA_MATCH scenarios.
+     * @internal
+     */
+    server_ROWS_COUNT: number;
+    /**
+     * The number of rows in the grid. THIS IS A LOCAL COUNT CONSIDERING CONSIDER CRITERIA_MATCH scenarios.
+     * @internal
+     */
+    client_ROWS_COUNT: number;
+    private moreRows;
+    private calculatedRowsCount;
+    private lastSequenceId;
+    private currentFilterModel;
+    private originalCriteriaMatch;
+    private currentSortModel;
+    constructor(options: StreamDatasourceOptions);
+    getRows(params: IServerSideGetRowsParams): Promise<void>;
+    private applyServerSideData;
+    private sortMapByNumericKey;
+    deinit(): Promise<void>;
+    private refreshDatasource;
+    private getOrderByAndToBeSortedColIds;
+    private handleCurrentStreamLoad;
+    private buildCriteriaMatchFromFilters;
+    private criteriaFromFilters;
+    private getFiltersByType;
+}
+
+/**
+ * Type definition for configuration options used for streams.
+ * @remarks
+ * Used by {@link @genesislcap/grid-pro#StreamDatasource} constructor to configure options for the stream.
+ * @alpha
+ */
+export declare type StreamDatasourceOptions = {
+    createDataserverStreamFunc: (existingParams?: any) => Promise<SocketObservable<FilteredDataServerResult>>;
+    resourceName: string;
+    resourceParams?: any;
+    resourceIndexes?: Map<string, [string]>;
+    resourceColDefs?: MetadataDetail[];
+    maxRows?: number;
+    maxView?: number;
+    rowId?: string;
+    pagination?: boolean;
+};
+
 /**
  * The AG String Editor element.
  * @public

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

@@ -7,14 +7,14 @@
 **Signature:**
 
 ```typescript
-addEventListener(eventType: string, listener: any, options?: boolean | AddEventListenerOptions): void;
+addEventListener(type: any, listener: any, options?: boolean | AddEventListenerOptions): void;
 ```
 
 ## Parameters
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  eventType | string |  |
+|  type | any |  |
 |  listener | any |  |
 |  options | boolean \| AddEventListenerOptions | _(Optional)_ |
 

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

@@ -69,7 +69,7 @@ Grid Pro is a Web Component wrapper around the AG Grid Community library.
 
 |  Method | Modifiers | Description |
 |  --- | --- | --- |
-|  [addEventListener(eventType, listener, options)](./grid-pro.gridpro.addeventlistener.md) |  |  |
+|  [addEventListener(type, listener, options)](./grid-pro.gridpro.addeventlistener.md) |  |  |
 |  [agAttributeChangedCallback(attName, oldValue, newValue)](./grid-pro.gridpro.agattributechangedcallback.md) |  |  |
 |  [applyTemplateDefinitions(columnDefs, deferredColumnDefsOrState)](./grid-pro.gridpro.applytemplatedefinitions.md) |  | Will merge templated column definitions with <code>columnDefs</code> plus localStorage's column state or <code>deferredColumnStates</code>. |
 |  [combineAllGridComponents(gridOptionsComponents)](./grid-pro.gridpro.combineallgridcomponents.md) |  |  |

package/docs/api/{grid-pro.gridprogenesisdatasource.destroy.md → grid-pro.gridprogenesisdatasource.auth.md}

@@ -1,17 +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; [GridProGenesisDatasource](./grid-pro.gridprogenesisdatasource.md) &gt; [destroy](./grid-pro.gridprogenesisdatasource.destroy.md)
+[Home](./index.md) &gt; [@genesislcap/grid-pro](./grid-pro.md) &gt; [GridProGenesisDatasource](./grid-pro.gridprogenesisdatasource.md) &gt; [auth](./grid-pro.gridprogenesisdatasource.auth.md)
 
-## GridProGenesisDatasource.destroy() method
-
-Destroys the datasource, resetting it to its initial state.
+## GridProGenesisDatasource.auth property
 
 **Signature:**
 
 ```typescript
-destroy(): void;
+auth: Auth;
 ```
-**Returns:**
-
-void
-

package/docs/api/grid-pro.gridprogenesisdatasource.datasource.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; [GridProGenesisDatasource](./grid-pro.gridprogenesisdatasource.md) &gt; [datasource](./grid-pro.gridprogenesisdatasource.datasource.md)
+
+## GridProGenesisDatasource.datasource property
+
+**Signature:**
+
+```typescript
+datasource: Datasource;
+```

package/docs/api/grid-pro.gridprogenesisdatasource.deinit.md

@@ -4,11 +4,6 @@
 
 ## GridProGenesisDatasource.deinit() method
 
-> Warning: This API is now obsolete.
-> 
-> Use `destroy` instead
-> 
-
 Deinitialises the datasource, resetting it to its initial state.
 
 **Signature:**

package/docs/api/grid-pro.gridprogenesisdatasource.disablepolling.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; [GridProGenesisDatasource](./grid-pro.gridprogenesisdatasource.md) &gt; [disablePolling](./grid-pro.gridprogenesisdatasource.disablepolling.md)
+
+## GridProGenesisDatasource.disablePolling property
+
+**Signature:**
+
+```typescript
+disablePolling: boolean;
+```

package/docs/api/grid-pro.gridprogenesisdatasource.handleerrors.md

@@ -7,14 +7,14 @@
 **Signature:**
 
 ```typescript
-handleErrors(errors: string | any[]): void;
+handleErrors(message: string): void;
 ```
 
 ## Parameters
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
-|  errors | string \| any\[\] |  |
+|  message | string |  |
 
 **Returns:**
 

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

@@ -23,7 +23,12 @@ Only supports Client-Side Row Model.
 |  --- | --- | --- | --- |
 |  [applyAsyncFuncName](./grid-pro.gridprogenesisdatasource.applyasyncfuncname.md) |  | string |  |
 |  [applyFuncName](./grid-pro.gridprogenesisdatasource.applyfuncname.md) |  | string |  |
+|  [auth](./grid-pro.gridprogenesisdatasource.auth.md) |  | Auth |  |
+|  [datasource](./grid-pro.gridprogenesisdatasource.datasource.md) |  | Datasource |  |
+|  [disablePolling](./grid-pro.gridprogenesisdatasource.disablepolling.md) |  | boolean |  |
 |  [keepColDefsOnClearRowData](./grid-pro.gridprogenesisdatasource.keepcoldefsonclearrowdata.md) |  | boolean |  |
+|  [pollingInterval](./grid-pro.gridprogenesisdatasource.pollinginterval.md) |  | number |  |
+|  [request](./grid-pro.gridprogenesisdatasource.request.md) |  | any |  |
 |  [restartOnReconnection](./grid-pro.gridprogenesisdatasource.restartonreconnection.md) |  | boolean |  |
 
 ## Methods
@@ -36,9 +41,8 @@ Only supports Client-Side Row Model.
 |  [criteriaChanged(oldCriteria, newCriteria)](./grid-pro.gridprogenesisdatasource.criteriachanged.md) |  |  |
 |  [deepClone()](./grid-pro.gridprogenesisdatasource.deepclone.md) |  |  |
 |  [deinit()](./grid-pro.gridprogenesisdatasource.deinit.md) |  | Deinitialises the datasource, resetting it to its initial state. |
-|  [destroy()](./grid-pro.gridprogenesisdatasource.destroy.md) |  | Destroys the datasource, resetting it to its initial state. |
 |  [disconnectedCallback()](./grid-pro.gridprogenesisdatasource.disconnectedcallback.md) |  |  |
-|  [handleErrors(errors)](./grid-pro.gridprogenesisdatasource.handleerrors.md) |  |  |
+|  [handleErrors(message)](./grid-pro.gridprogenesisdatasource.handleerrors.md) |  |  |
 |  [init(columnDefinitions, columnStates)](./grid-pro.gridprogenesisdatasource.init.md) |  | Initializes the datasource. |
 |  [refreshRows()](./grid-pro.gridprogenesisdatasource.refreshrows.md) |  | Force the grid to redispatch the current rows |
 |  [removeFilter(fieldName)](./grid-pro.gridprogenesisdatasource.removefilter.md) |  |  |

package/docs/api/grid-pro.gridprogenesisdatasource.pollinginterval.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; [GridProGenesisDatasource](./grid-pro.gridprogenesisdatasource.md) &gt; [pollingInterval](./grid-pro.gridprogenesisdatasource.pollinginterval.md)
+
+## GridProGenesisDatasource.pollingInterval property
+
+**Signature:**
+
+```typescript
+pollingInterval: number;
+```

package/docs/api/grid-pro.gridprogenesisdatasource.request.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; [GridProGenesisDatasource](./grid-pro.gridprogenesisdatasource.md) &gt; [request](./grid-pro.gridprogenesisdatasource.request.md)
+
+## GridProGenesisDatasource.request property
+
+**Signature:**
+
+```typescript
+request: any;
+```

package/docs/api/grid-pro.gridprogenesisdatasource.reset.md

@@ -6,7 +6,7 @@
 
 > Warning: This API is now obsolete.
 > 
-> Use `destroy` instead
+> Use `deinit` instead
 > 
 
 Resets the datasource to its initial state.