@genesislcap/grid-pro 14.141.2 → 14.142.0

package/dist/grid-pro.api.json

@@ -9482,6 +9482,194 @@
           "name": "GridProGenesisDatasource",
           "preserveMemberOrder": false,
           "members": [
+            {
+              "kind": "Property",
+              "canonicalReference": "@genesislcap/grid-pro!GridProGenesisDatasource#applyAsyncFuncName:member",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "applyAsyncFuncName: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "string"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "applyAsyncFuncName",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "isStatic": false,
+              "isProtected": false,
+              "isAbstract": false
+            },
+            {
+              "kind": "Property",
+              "canonicalReference": "@genesislcap/grid-pro!GridProGenesisDatasource#applyFuncName:member",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "applyFuncName: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "string"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "applyFuncName",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "isStatic": false,
+              "isProtected": false,
+              "isAbstract": false
+            },
+            {
+              "kind": "Method",
+              "canonicalReference": "@genesislcap/grid-pro!GridProGenesisDatasource#applyTransaction:member(1)",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "applyTransaction(agTransaction: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "RowDataTransaction",
+                  "canonicalReference": "@ag-grid-community/core!RowDataTransaction:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": "): "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "RowNodeTransaction",
+                  "canonicalReference": "@ag-grid-community/core!RowNodeTransaction:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": " | null | undefined"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isStatic": false,
+              "returnTypeTokenRange": {
+                "startIndex": 3,
+                "endIndex": 5
+              },
+              "releaseTag": "Public",
+              "isProtected": false,
+              "overloadIndex": 1,
+              "parameters": [
+                {
+                  "parameterName": "agTransaction",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 1,
+                    "endIndex": 2
+                  },
+                  "isOptional": false
+                }
+              ],
+              "isOptional": false,
+              "isAbstract": false,
+              "name": "applyTransaction"
+            },
+            {
+              "kind": "Method",
+              "canonicalReference": "@genesislcap/grid-pro!GridProGenesisDatasource#applyTransactionAsync:member(1)",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "applyTransactionAsync(agTransaction: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "RowDataTransaction",
+                  "canonicalReference": "@ag-grid-community/core!RowDataTransaction:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": ", callback?: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "(res: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "RowNodeTransaction",
+                  "canonicalReference": "@ag-grid-community/core!RowNodeTransaction:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": ") => void"
+                },
+                {
+                  "kind": "Content",
+                  "text": "): "
+                },
+                {
+                  "kind": "Content",
+                  "text": "void"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isStatic": false,
+              "returnTypeTokenRange": {
+                "startIndex": 7,
+                "endIndex": 8
+              },
+              "releaseTag": "Public",
+              "isProtected": false,
+              "overloadIndex": 1,
+              "parameters": [
+                {
+                  "parameterName": "agTransaction",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 1,
+                    "endIndex": 2
+                  },
+                  "isOptional": false
+                },
+                {
+                  "parameterName": "callback",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 3,
+                    "endIndex": 6
+                  },
+                  "isOptional": true
+                }
+              ],
+              "isOptional": false,
+              "isAbstract": false,
+              "name": "applyTransactionAsync"
+            },
             {
               "kind": "Property",
               "canonicalReference": "@genesislcap/grid-pro!GridProGenesisDatasource#auth:member",
@@ -10142,67 +10330,6 @@
               "isProtected": false,
               "isAbstract": false
             },
-            {
-              "kind": "Property",
-              "canonicalReference": "@genesislcap/grid-pro!GridProGenesisDatasource#rowDataMapper:member",
-              "docComment": "/**\n * Allows grid data updates to be processed via and external function before applying in grid\n */\n",
-              "excerptTokens": [
-                {
-                  "kind": "Content",
-                  "text": "rowDataMapper: "
-                },
-                {
-                  "kind": "Reference",
-                  "text": "Function",
-                  "canonicalReference": "!Function:interface"
-                },
-                {
-                  "kind": "Content",
-                  "text": ";"
-                }
-              ],
-              "isReadonly": false,
-              "isOptional": false,
-              "releaseTag": "Public",
-              "name": "rowDataMapper",
-              "propertyTypeTokenRange": {
-                "startIndex": 1,
-                "endIndex": 2
-              },
-              "isStatic": false,
-              "isProtected": false,
-              "isAbstract": false
-            },
-            {
-              "kind": "Property",
-              "canonicalReference": "@genesislcap/grid-pro!GridProGenesisDatasource#rowIdAttr:member",
-              "docComment": "/**\n * Attribute to set an unique identifier for the row.\n *\n * Defaults to `ROW_REF` or `RECORD_ID` depending on the resource type.\n */\n",
-              "excerptTokens": [
-                {
-                  "kind": "Content",
-                  "text": "rowIdAttr: "
-                },
-                {
-                  "kind": "Content",
-                  "text": "any"
-                },
-                {
-                  "kind": "Content",
-                  "text": ";"
-                }
-              ],
-              "isReadonly": false,
-              "isOptional": false,
-              "releaseTag": "Public",
-              "name": "rowIdAttr",
-              "propertyTypeTokenRange": {
-                "startIndex": 1,
-                "endIndex": 2
-              },
-              "isStatic": false,
-              "isProtected": false,
-              "isAbstract": false
-            },
             {
               "kind": "Method",
               "canonicalReference": "@genesislcap/grid-pro!GridProGenesisDatasource#setFilter:member(1)",

package/dist/grid-pro.d.ts

@@ -30,12 +30,17 @@ import { ICellRendererParams } from '@ag-grid-community/core';
 import { InterfaceSymbol } from '@microsoft/fast-foundation';
 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 { LayoutCacheContainer } from '@genesislcap/foundation-utils';
 import { Logger } from '@genesislcap/foundation-logger';
 import { MetadataDetail } from '@genesislcap/foundation-comms';
 import { OverrideFoundationElementDefinition } from '@microsoft/fast-foundation';
+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 { SocketObservable } from '@genesislcap/foundation-comms';
 import { Swatch } from '@microsoft/fast-components';
 import { SwatchRGB } from '@microsoft/fast-components';
@@ -932,6 +937,41 @@ declare interface FuiCellRendererParams extends ICellRendererParams {
     onChange?: (value: string, params: FuiCellRendererParams) => void;
 }
 
+declare class GenesisGridDatasourceElement extends FoundationElement {
+    connect: Connect;
+    deferredGridOptions: GridOptions;
+    deferredColumnStates: ColumnState[];
+    /**
+     * Allows grid data updates to be processed via and external function before applying in grid
+     */
+    rowDataMapper: Function;
+    criteria: string;
+    fields: string;
+    isSnapshot: boolean;
+    maxRows: number;
+    maxView: number;
+    movingView: boolean;
+    orderBy: string;
+    resourceName: string;
+    reverse: boolean;
+    /**
+     * Attribute to set an unique identifier for the row.
+     *
+     * Defaults to `ROW_REF` or `RECORD_ID` depending on the resource type.
+     * @privateRemarks Attribute-only, not to be used as a property. Use `rowId` getter instead.
+     */
+    rowIdAttr: any;
+    protected get rowId(): string;
+    /**
+     * Returns whether the `row-id` attribute is the default one, depending on the resource type.
+     * @internal
+     */
+    protected get hasDefaultRowId(): boolean;
+    protected get defaultRowIdByResourceType(): string;
+    protected isRequestServer: boolean;
+    protected get agGrid(): GridPro | null;
+}
+
 /**
  * Helper function to get ColDef {@link https://www.ag-grid.com/javascript-data-grid/column-properties/} for Actions Menu Renderer.
  * Will take the parameter values for a base ColDef and merge them with the overrideDef (if specified).
@@ -1601,19 +1641,27 @@ declare const GridPro_base: (new (...args: any[]) => {
     focus(options?: FocusOptions): void;
 }) & typeof FoundationElement;
 
-declare class GridProBaseDatasource extends FoundationElement {
-    connect: Connect;
-    deferredGridOptions: GridOptions;
-    deferredColumnStates: ColumnState[];
-    criteria: string;
-    fields: string;
-    isSnapshot: boolean;
-    maxRows: number;
-    maxView: number;
-    movingView: boolean;
-    orderBy: string;
-    resourceName: string;
-    reverse: boolean;
+declare class GridProBaseDatasource extends GenesisGridDatasourceElement {
+    protected dataSubWasLoggedOff: boolean;
+    rowData: Map<string, any>;
+    protected agTransaction: RowDataTransaction | ServerSideTransaction;
+    protected applyFuncName: string;
+    protected applyAsyncFuncName: string;
+    protected handleStreamInserts(insertedRows: any[]): void;
+    protected handleStreamDeletes(deletedRows: any[]): void;
+    protected handleStreamUpdates(updatedRows: any[]): void;
+    protected applyAllAgTransactions(): void;
+    private flashAddedCells;
+    private applyMappedAgTransaction;
+    protected applyTransaction(agTransaction: RowDataTransaction): any;
+    protected applyTransactionAsync(agTransaction: RowDataTransaction, callback?: (res: any) => void): void;
+    /**
+     * Maps the transaction data to the row data mapper function, if it exists.
+     * @param transaction - The transaction data to be mapped.
+     * @param operations - The operations to be mapped. Can be 'add', 'update' or 'remove'.
+     * @returns The mapped transaction (if the row data mapper function exists), or the original transaction.
+     */
+    private mapTransaction;
 }
 
 /**
@@ -1669,50 +1717,24 @@ export declare function gridProColumns<TSource = any>(itemsBinding: Binding<TSou
 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;
     resourceNameChanged(oldValue: string, newValue: string): void;
-    /**
-     * Attribute to set an unique identifier for the row.
-     *
-     * Defaults to `ROW_REF` or `RECORD_ID` depending on the resource type.
-     * @privateRemarks Attribute-only, not to be used as a property. Use `rowId` getter instead.
-     */
-    rowIdAttr: any;
     restartOnReconnection: boolean;
-    /**
-     * Allows grid data updates to be processed via and external function before applying in grid
-     */
-    rowDataMapper: Function;
     private dataSub;
     private updateSub;
     private connectionSub;
-    private isRequestServer;
     private requiresFullRowDataAndColDefs;
-    private dataSubWasLoggedOff;
-    private rows;
-    private agTransaction;
     private sourceRef;
     private criteriaFromFilters;
     private update;
     connectedCallback(): void;
     disconnectedCallback(): void;
     deepClone(): Node;
-    private get agGrid();
-    /**
-     * Returns the `row-id` attribute, depending on the resource type.
-     * @remarks Will favour the `row-id` attribute if set.
-     * @internal
-     */
-    private get rowId();
-    /**
-     * Returns whether the `row-id` attribute is the default one, depending on the resource type.
-     * @internal
-     */
-    private get hasDefaultRowId();
-    private get defaultRowIdByResourceType();
     /**
      * Initializes the datasource.
      * @public
@@ -1779,23 +1801,12 @@ export declare class GridProGenesisDatasource extends GridProGenesisDatasource_b
     private handleStreamResult;
     private applyRequestServerData;
     private applyDataserverData;
-    private applyAllAgTransactions;
-    private flashAddedCells;
-    private applyMappedAgTransaction;
-    /**
-     * Maps the transaction data to the row data mapper function, if it exists.
-     * @param transaction - The transaction data to be mapped.
-     * @param operations - The operations to be mapped. Can be 'add', 'update' or 'remove'.
-     * @returns The mapped transaction (if the row data mapper function exists), or the original transaction.
-     */
-    private mapTransaction;
-    private handleStreamInserts;
-    private handleStreamDeletes;
-    private handleStreamUpdates;
     private getAgColumnDefs;
     private buildCriteria;
     setFilter(fieldName: string, newFilter: string): void;
     removeFilter(fieldName: string): void;
+    applyTransaction(agTransaction: RowDataTransaction): RowNodeTransaction | null | undefined;
+    applyTransactionAsync(agTransaction: RowDataTransaction, callback?: (res: RowNodeTransaction) => void): void;
 }
 
 declare const GridProGenesisDatasource_base: (new (...args: any[]) => {
@@ -1813,11 +1824,6 @@ declare const GridProGenesisDatasource_base: (new (...args: any[]) => {
     connectedCallback(): void;
     readonly $fastController: Controller;
     $emit(type: string, detail?: any, options?: Omit<CustomEventInit<any>, "detail">): boolean | void;
-    /**
-     * Returns the `row-id` attribute, depending on the resource type.
-     * @remarks Will favour the `row-id` attribute if set.
-     * @internal
-     */
     disconnectedCallback(): void;
     attributeChangedCallback(name: string, oldValue: string, newValue: string): void;
     accessKey: string;
@@ -1886,23 +1892,13 @@ declare const GridProGenesisDatasource_base: (new (...args: any[]) => {
     getElementsByTagNameNS(namespaceURI: "http://www.w3.org/2000/svg", localName: string): HTMLCollectionOf<SVGElement>;
     getElementsByTagNameNS(namespace: string, localName: string): HTMLCollectionOf<Element>;
     hasAttribute(qualifiedName: string): boolean;
-    /**
-     * Sends a DATA_LOGOFF when the resource is an active stream
-     * @remarks Will only happen for streaming DATASERER resources.
-     * @internal
-     */
     hasAttributeNS(namespace: string, localName: string): boolean;
     hasAttributes(): boolean;
     hasPointerCapture(pointerId: number): boolean;
     insertAdjacentElement(where: InsertPosition, element: Element): Element;
     insertAdjacentHTML(position: InsertPosition, text: string): void;
     insertAdjacentText(where: InsertPosition, data: string): void;
-    matches(selectors: string): boolean; /**
-    * Clears the rowData and columnDefs for the grid.
-    * @remarks This is called when `reloadResourceData` happens, on criteria and filters change or full `reset`.
-    * @param withColumnDefs - Whether to clear the columnDefs as well. Defaults to true.
-    * @internal
-    */
+    matches(selectors: string): boolean;
     releasePointerCapture(pointerId: number): void;
     removeAttribute(qualifiedName: string): void;
     removeAttributeNS(namespace: string, localName: string): void;
@@ -2163,12 +2159,13 @@ export declare enum GridProRendererTypes {
  * @alpha
  */
 export declare class GridProServerSideDatasource extends GridProServerSideDatasource_base {
+    applyFuncName: string;
+    applyAsyncFuncName: string;
     criteriaChanged(oldCriteria: string, newCriteria: string): void;
     resourceNameChanged(oldValue: string, newValue: string): void;
     pagination: boolean;
-    rowId: string;
     private indexes;
-    private dataserverStream;
+    private ssrmDatasource;
     private originalFieldDef;
     connectedCallback(): void;
     disconnectedCallback(): void;
@@ -2176,12 +2173,15 @@ export declare class GridProServerSideDatasource extends GridProServerSideDataso
     init(): void;
     reset(): void;
     restart(): void;
-    private get agGrid();
     private clearRowData;
     private getResourceIndexes;
     get params(): any;
+    get rowModel(): IServerSideRowModel;
     private createDataserverStream;
+    private handleStreamDeletesTemp;
     private getAgColumnDefs;
+    applyTransaction(agTransaction: RowDataTransaction): ServerSideTransactionResult;
+    applyTransactionAsync(agTransaction: RowDataTransaction, callback?: (res: ServerSideTransactionResult) => void): void;
 }
 
 declare const GridProServerSideDatasource_base: (new (...args: any[]) => {
@@ -2335,6 +2335,11 @@ declare const GridProServerSideDatasource_base: (new (...args: any[]) => {
     readonly DOCUMENT_TYPE_NODE: number;
     readonly ELEMENT_NODE: number;
     readonly ENTITY_NODE: number;
+    /**
+     * A Genesis Datasource element, for server-side | SSRM-compatible data fetching and used exclusively by the GridPro element.
+     * @remarks Only supports Server-Side Row Model. Requires `@ag-grid-enterprise/server-side-row-model` setup and valid AG Grid Enterprise license.
+     * @alpha
+     */
     readonly ENTITY_REFERENCE_NODE: number;
     readonly NOTATION_NODE: number;
     readonly PROCESSING_INSTRUCTION_NODE: number;
@@ -2593,16 +2598,6 @@ export declare interface NumberEditorParams extends ICellEditorParams {
     disabled: boolean;
 }
 
-/**
- * The operation type for the {@link @genesislcap/grid-pro#GridProGenesisDatasource.mapTransaction} method.
- * @internal
- */
-export declare enum OperationType {
-    Add = "add",
-    Update = "update",
-    Remove = "remove"
-}
-
 declare interface SelectCellRendererParams extends ICellRendererParams {
     accessor: string;
     defaultValue?: string;
@@ -2663,11 +2658,16 @@ export declare class SelectRenderer extends FoundationElement implements ICellRe
     selectionChanged: (e: any) => void;
 }
 
+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 implements IServerSideDatasource {
+export declare class StreamDatasource extends StreamBaseDatasource implements IServerSideDatasource {
     auth: Auth;
     connect: Connect;
     dataserverStream: SocketObservable<FilteredDataServerResult>;
@@ -2683,27 +2683,25 @@ export declare class StreamDatasource implements IServerSideDatasource {
      * The number of rows in the grid. THIS DO NOT CONSIDER CRITERIA_MATCH scenarios.
      * @internal
      */
-    private server_ROWS_COUNT;
+    server_ROWS_COUNT: number;
     /**
      * The number of rows in the grid. THIS IS A LOCAL COUNT CONSIDERING CONSIDER CRITERIA_MATCH scenarios.
      * @internal
      */
-    private client_ROWS_COUNT;
+    client_ROWS_COUNT: number;
     private moreRows;
     private calculatedRowsCount;
     private lastSequenceId;
     private currentFilterModel;
     private originalCriteriaMatch;
     private currentSortModel;
-    private rowData;
-    private agTransaction;
-    private rowId;
     constructor(options: StreamDatasourceOptions);
     getRows(params: IServerSideGetRowsParams): Promise<void>;
+    private sortMapByNumericKey;
     private dataLogoff;
     private restartSubscription;
     private getOrderByAndToBeSortedColIds;
-    private handleInitialStreamLoad;
+    private handleCurrentStreamLoad;
     private buildCriteriaMatchFromFilters;
     private criteriaFromFilters;
     private getFiltersByType;

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

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

package/docs/api/grid-pro.gridprogenesisdatasource.applytransaction.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; [GridProGenesisDatasource](./grid-pro.gridprogenesisdatasource.md) &gt; [applyTransaction](./grid-pro.gridprogenesisdatasource.applytransaction.md)
+
+## GridProGenesisDatasource.applyTransaction() method
+
+**Signature:**
+
+```typescript
+applyTransaction(agTransaction: RowDataTransaction): RowNodeTransaction | null | undefined;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  agTransaction | RowDataTransaction |  |
+
+**Returns:**
+
+RowNodeTransaction \| null \| undefined
+

package/docs/api/grid-pro.gridprogenesisdatasource.applytransactionasync.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; [GridProGenesisDatasource](./grid-pro.gridprogenesisdatasource.md) &gt; [applyTransactionAsync](./grid-pro.gridprogenesisdatasource.applytransactionasync.md)
+
+## GridProGenesisDatasource.applyTransactionAsync() method
+
+**Signature:**
+
+```typescript
+applyTransactionAsync(agTransaction: RowDataTransaction, callback?: (res: RowNodeTransaction) => void): void;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  agTransaction | RowDataTransaction |  |
+|  callback | (res: RowNodeTransaction) =&gt; void | _(Optional)_ |
+
+**Returns:**
+
+void
+