@genesislcap/grid-pro 15.24.2 → 15.25.0-FUI-2611.2

package/dist/custom-elements.json

@@ -9539,6 +9539,13 @@
           "description": "",
           "name": "GridProBaseDatasource",
           "members": [
+            {
+              "kind": "field",
+              "name": "serializer",
+              "type": {
+                "text": "JSONSerializer"
+              }
+            },
             {
               "kind": "field",
               "name": "dataSubWasLoggedOff",
@@ -9572,7 +9579,17 @@
                 "text": "TransactionData"
               },
               "privacy": "protected",
-              "default": "{\n    add: [],\n    remove: [],\n    update: [],\n  }"
+              "default": "{ add: [], remove: [], update: [] }"
+            },
+            {
+              "kind": "field",
+              "name": "missingRowIdWarned",
+              "type": {
+                "text": "boolean"
+              },
+              "privacy": "private",
+              "default": "false",
+              "description": "So rows without a row id are warned about once per element, not once per block. @internal"
             },
             {
               "kind": "field",
@@ -9692,6 +9709,36 @@
                 }
               ]
             },
+            {
+              "kind": "method",
+              "name": "emitTransaction",
+              "privacy": "protected",
+              "return": {
+                "type": {
+                  "text": "void"
+                }
+              },
+              "parameters": [
+                {
+                  "name": "transaction",
+                  "type": {
+                    "text": "TransactionData | undefined"
+                  }
+                }
+              ],
+              "description": "Emits `datasource-data-changed` for `transaction` when it is non-empty. @internal"
+            },
+            {
+              "kind": "method",
+              "name": "emitPendingTransaction",
+              "privacy": "protected",
+              "return": {
+                "type": {
+                  "text": "void"
+                }
+              },
+              "description": "Emits `datasource-data-changed` for the current transaction when it is non-empty. @internal"
+            },
             {
               "kind": "method",
               "name": "mapTransaction",
@@ -11556,6 +11603,17 @@
                 "module": "src/datasource/base.datasource.ts"
               }
             },
+            {
+              "kind": "field",
+              "name": "serializer",
+              "type": {
+                "text": "JSONSerializer"
+              },
+              "inheritedFrom": {
+                "name": "GridProBaseDatasource",
+                "module": "src/datasource/base.datasource.ts"
+              }
+            },
             {
               "kind": "field",
               "name": "dataSubWasLoggedOff",
@@ -11581,6 +11639,20 @@
                 "module": "src/datasource/base.datasource.ts"
               }
             },
+            {
+              "kind": "field",
+              "name": "missingRowIdWarned",
+              "type": {
+                "text": "boolean"
+              },
+              "privacy": "private",
+              "default": "false",
+              "description": "So rows without a row id are warned about once per element, not once per block. @internal",
+              "inheritedFrom": {
+                "name": "GridProBaseDatasource",
+                "module": "src/datasource/base.datasource.ts"
+              }
+            },
             {
               "kind": "field",
               "name": "connectionSub",
@@ -11677,6 +11749,44 @@
                 "module": "src/datasource/base.datasource.ts"
               }
             },
+            {
+              "kind": "method",
+              "name": "emitTransaction",
+              "privacy": "protected",
+              "return": {
+                "type": {
+                  "text": "void"
+                }
+              },
+              "parameters": [
+                {
+                  "name": "transaction",
+                  "type": {
+                    "text": "TransactionData | undefined"
+                  }
+                }
+              ],
+              "description": "Emits `datasource-data-changed` for `transaction` when it is non-empty. @internal",
+              "inheritedFrom": {
+                "name": "GridProBaseDatasource",
+                "module": "src/datasource/base.datasource.ts"
+              }
+            },
+            {
+              "kind": "method",
+              "name": "emitPendingTransaction",
+              "privacy": "protected",
+              "return": {
+                "type": {
+                  "text": "void"
+                }
+              },
+              "description": "Emits `datasource-data-changed` for the current transaction when it is non-empty. @internal",
+              "inheritedFrom": {
+                "name": "GridProBaseDatasource",
+                "module": "src/datasource/base.datasource.ts"
+              }
+            },
             {
               "kind": "method",
               "name": "mapTransaction",
@@ -12609,6 +12719,12 @@
       "declarations": [],
       "exports": []
     },
+    {
+      "kind": "javascript-module",
+      "path": "src/datasource/delivered-block.ledger.ts",
+      "declarations": [],
+      "exports": []
+    },
     {
       "kind": "javascript-module",
       "path": "src/datasource/error-handler.dialog.ts",
@@ -13014,6 +13130,15 @@
               "privacy": "private",
               "description": "Unsubscribes the commit-response listener behind `pollTriggerEvents`. @internal"
             },
+            {
+              "kind": "field",
+              "name": "maxBlocksInCache",
+              "type": {
+                "text": "number | undefined"
+              },
+              "privacy": "private",
+              "description": "The `maxBlocksInCache` the grid was initialised with, so eviction can be mirrored. @internal"
+            },
             {
               "kind": "method",
               "name": "resourceNameChanged",
@@ -13097,17 +13222,6 @@
                 "module": "src/datasource/base.datasource.ts"
               }
             },
-            {
-              "kind": "method",
-              "name": "clearRowData",
-              "privacy": "private",
-              "parameters": [
-                {
-                  "name": "withColumnDefs",
-                  "default": "true"
-                }
-              ]
-            },
             {
               "kind": "method",
               "name": "teardownCommitTriggeredRefresh",
@@ -13237,6 +13351,17 @@
                 "module": "src/mixins/lifecycle/lifecycle.ts"
               }
             },
+            {
+              "kind": "field",
+              "name": "serializer",
+              "type": {
+                "text": "JSONSerializer"
+              },
+              "inheritedFrom": {
+                "name": "GridProBaseDatasource",
+                "module": "src/datasource/base.datasource.ts"
+              }
+            },
             {
               "kind": "field",
               "name": "dataSubWasLoggedOff",
@@ -13282,7 +13407,21 @@
                 "text": "TransactionData"
               },
               "privacy": "protected",
-              "default": "{\n    add: [],\n    remove: [],\n    update: [],\n  }",
+              "default": "{ add: [], remove: [], update: [] }",
+              "inheritedFrom": {
+                "name": "GridProBaseDatasource",
+                "module": "src/datasource/base.datasource.ts"
+              }
+            },
+            {
+              "kind": "field",
+              "name": "missingRowIdWarned",
+              "type": {
+                "text": "boolean"
+              },
+              "privacy": "private",
+              "default": "false",
+              "description": "So rows without a row id are warned about once per element, not once per block. @internal",
               "inheritedFrom": {
                 "name": "GridProBaseDatasource",
                 "module": "src/datasource/base.datasource.ts"
@@ -13442,6 +13581,44 @@
                 "module": "src/datasource/base.datasource.ts"
               }
             },
+            {
+              "kind": "method",
+              "name": "emitTransaction",
+              "privacy": "protected",
+              "return": {
+                "type": {
+                  "text": "void"
+                }
+              },
+              "parameters": [
+                {
+                  "name": "transaction",
+                  "type": {
+                    "text": "TransactionData | undefined"
+                  }
+                }
+              ],
+              "description": "Emits `datasource-data-changed` for `transaction` when it is non-empty. @internal",
+              "inheritedFrom": {
+                "name": "GridProBaseDatasource",
+                "module": "src/datasource/base.datasource.ts"
+              }
+            },
+            {
+              "kind": "method",
+              "name": "emitPendingTransaction",
+              "privacy": "protected",
+              "return": {
+                "type": {
+                  "text": "void"
+                }
+              },
+              "description": "Emits `datasource-data-changed` for the current transaction when it is non-empty. @internal",
+              "inheritedFrom": {
+                "name": "GridProBaseDatasource",
+                "module": "src/datasource/base.datasource.ts"
+              }
+            },
             {
               "kind": "method",
               "name": "mapTransaction",
@@ -14143,6 +14320,14 @@
               "description": "Fired when column metadata or defs are updated. detail: `SchemaUpdatedEventDetail`",
               "name": "datasource-schema-updated"
             },
+            {
+              "description": "Fired when rows are delivered to the grid, a DATASERVER push changes them, or a re-read no longer returns them; `add` are rows the grid did not hold before, `update` are held rows whose content changed, `remove` carries the row id. detail: `DataChangedEventDetail`",
+              "name": "datasource-data-changed",
+              "inheritedFrom": {
+                "name": "GenesisGridDatasourceElement",
+                "module": "src/datasource/base.datasource.ts"
+              }
+            },
             {
               "description": "Fired to attach or clear the infinite row model datasource. detail: `SetInfiniteDatasourceEventDetail`",
               "name": "set-infinite-datasource"
@@ -14164,7 +14349,7 @@
               "name": "cache-filter-config"
             },
             {
-              "description": "Fired when infinite row data is cleared. detail: `DataClearedEventDetail`",
+              "description": "Fired when the grid drops every row it held (reload, filter or sort change, destroy); `includeSchema` says whether the columns went too. detail: `DataClearedEventDetail`",
               "name": "datasource-data-cleared"
             },
             {
@@ -14186,14 +14371,6 @@
                 "name": "GenesisGridDatasourceElement",
                 "module": "src/datasource/base.datasource.ts"
               }
-            },
-            {
-              "description": "Fired when row data changes from applied stream transactions. detail: `DataChangedEventDetail`",
-              "name": "datasource-data-changed",
-              "inheritedFrom": {
-                "name": "GenesisGridDatasourceElement",
-                "module": "src/datasource/base.datasource.ts"
-              }
             }
           ],
           "mixins": [
@@ -14557,6 +14734,16 @@
               },
               "privacy": "private"
             },
+            {
+              "kind": "field",
+              "name": "ledger",
+              "type": {
+                "text": "DeliveredBlockLedger"
+              },
+              "privacy": "private",
+              "description": "Which rows each delivered block carried, for withdrawal and eviction reporting. @internal",
+              "default": "new DeliveredBlockLedger(options.rowId, options.maxBlocksInCache)"
+            },
             {
               "kind": "field",
               "name": "HTTP_NOT_FOUND",
@@ -14765,6 +14952,36 @@
               ],
               "description": "Called by AG Grid when more rows are needed.\nImplements the IDatasource.getRows method."
             },
+            {
+              "kind": "method",
+              "name": "getDataserverRows",
+              "privacy": "private",
+              "return": {
+                "type": {
+                  "text": "void"
+                }
+              },
+              "parameters": [
+                {
+                  "name": "params",
+                  "type": {
+                    "text": "IGetRowsParams"
+                  }
+                },
+                {
+                  "name": "criteria",
+                  "type": {
+                    "text": "string"
+                  }
+                },
+                {
+                  "name": "sortConfig",
+                  "type": {
+                    "text": "{ orderBy: string | null; reverse: boolean }"
+                  }
+                }
+              ]
+            },
             {
               "kind": "method",
               "name": "cacheIndexOf",
@@ -14808,7 +15025,8 @@
                 "type": {
                   "text": "void"
                 }
-              }
+              },
+              "description": "Drops the subscription and the cached rows."
             },
             {
               "kind": "field",
@@ -14817,6 +15035,22 @@
             {
               "kind": "field",
               "name": "onRowsUpdatedFunc"
+            },
+            {
+              "kind": "field",
+              "name": "onRowsDeliveredFunc"
+            },
+            {
+              "kind": "field",
+              "name": "onRowsWithdrawnFunc"
+            },
+            {
+              "kind": "field",
+              "name": "onRowsEvictedFunc"
+            },
+            {
+              "kind": "field",
+              "name": "onRowCacheResetFunc"
             }
           ]
         }
@@ -15135,13 +15369,6 @@
           "description": "A Genesis Datasource element, for server-side | SSRM-compatible data fetching and used exclusively by the GridPro element.",
           "name": "GridProServerSideDatasource",
           "members": [
-            {
-              "kind": "field",
-              "name": "serializer",
-              "type": {
-                "text": "JSONSerializer"
-              }
-            },
             {
               "kind": "field",
               "name": "pollingDatasource",
@@ -15297,17 +15524,6 @@
                 "module": "src/datasource/base.datasource.ts"
               }
             },
-            {
-              "kind": "method",
-              "name": "clearRowData",
-              "privacy": "private",
-              "parameters": [
-                {
-                  "name": "withColumnDefs",
-                  "default": "true"
-                }
-              ]
-            },
             {
               "kind": "method",
               "name": "createReqRepRequest",
@@ -15455,6 +15671,17 @@
                 "module": "src/mixins/lifecycle/lifecycle.ts"
               }
             },
+            {
+              "kind": "field",
+              "name": "serializer",
+              "type": {
+                "text": "JSONSerializer"
+              },
+              "inheritedFrom": {
+                "name": "GridProBaseDatasource",
+                "module": "src/datasource/base.datasource.ts"
+              }
+            },
             {
               "kind": "field",
               "name": "dataSubWasLoggedOff",
@@ -15500,7 +15727,21 @@
                 "text": "TransactionData"
               },
               "privacy": "protected",
-              "default": "{\n    add: [],\n    remove: [],\n    update: [],\n  }",
+              "default": "{ add: [], remove: [], update: [] }",
+              "inheritedFrom": {
+                "name": "GridProBaseDatasource",
+                "module": "src/datasource/base.datasource.ts"
+              }
+            },
+            {
+              "kind": "field",
+              "name": "missingRowIdWarned",
+              "type": {
+                "text": "boolean"
+              },
+              "privacy": "private",
+              "default": "false",
+              "description": "So rows without a row id are warned about once per element, not once per block. @internal",
               "inheritedFrom": {
                 "name": "GridProBaseDatasource",
                 "module": "src/datasource/base.datasource.ts"
@@ -15660,6 +15901,44 @@
                 "module": "src/datasource/base.datasource.ts"
               }
             },
+            {
+              "kind": "method",
+              "name": "emitTransaction",
+              "privacy": "protected",
+              "return": {
+                "type": {
+                  "text": "void"
+                }
+              },
+              "parameters": [
+                {
+                  "name": "transaction",
+                  "type": {
+                    "text": "TransactionData | undefined"
+                  }
+                }
+              ],
+              "description": "Emits `datasource-data-changed` for `transaction` when it is non-empty. @internal",
+              "inheritedFrom": {
+                "name": "GridProBaseDatasource",
+                "module": "src/datasource/base.datasource.ts"
+              }
+            },
+            {
+              "kind": "method",
+              "name": "emitPendingTransaction",
+              "privacy": "protected",
+              "return": {
+                "type": {
+                  "text": "void"
+                }
+              },
+              "description": "Emits `datasource-data-changed` for the current transaction when it is non-empty. @internal",
+              "inheritedFrom": {
+                "name": "GridProBaseDatasource",
+                "module": "src/datasource/base.datasource.ts"
+              }
+            },
             {
               "kind": "method",
               "name": "mapTransaction",
@@ -16388,7 +16667,7 @@
               }
             },
             {
-              "description": "Fired when row data changes from applied stream transactions. detail: `DataChangedEventDetail`",
+              "description": "Fired when rows are delivered to the grid, a live stream pushes a change, a poll detects one, or a re-read no longer returns a row; `add` are rows the grid did not hold before, `update` are held rows whose content changed, `remove` carries the row id. detail: `DataChangedEventDetail`",
               "name": "datasource-data-changed",
               "inheritedFrom": {
                 "name": "GenesisGridDatasourceElement",
@@ -16436,7 +16715,7 @@
               "name": "datasource-filters-restored"
             },
             {
-              "description": "Fired when server-side row data is cleared. detail: `DataClearedEventDetail`",
+              "description": "Fired when the grid drops every row it held (reload, filter or sort change, destroy); `includeSchema` says whether the columns went too. detail: `DataClearedEventDetail`",
               "name": "datasource-data-cleared"
             },
             {
@@ -16812,6 +17091,40 @@
               },
               "privacy": "protected"
             },
+            {
+              "kind": "field",
+              "name": "onRowsDeliveredFunc",
+              "type": {
+                "text": "(rows: any[]) => void | undefined"
+              },
+              "privacy": "protected"
+            },
+            {
+              "kind": "field",
+              "name": "onRowsWithdrawnFunc",
+              "type": {
+                "text": "(rowIds: string[]) => void | undefined"
+              },
+              "privacy": "protected"
+            },
+            {
+              "kind": "field",
+              "name": "onRowsEvictedFunc",
+              "type": {
+                "text": "(rowIds: string[]) => void | undefined"
+              },
+              "privacy": "protected"
+            },
+            {
+              "kind": "field",
+              "name": "ledger",
+              "type": {
+                "text": "DeliveredBlockLedger"
+              },
+              "privacy": "protected",
+              "description": "Which rows each delivered block carried, for withdrawal and eviction reporting. @internal",
+              "default": "new DeliveredBlockLedger(options.rowId, options.maxBlocksInCache)"
+            },
             {
               "kind": "field",
               "name": "resourceName",
@@ -17402,6 +17715,35 @@
                 }
               ]
             },
+            {
+              "kind": "method",
+              "name": "cacheIndexOf",
+              "privacy": "private",
+              "return": {
+                "type": {
+                  "text": "number"
+                }
+              },
+              "parameters": [
+                {
+                  "name": "rows",
+                  "type": {
+                    "text": "Map<string, any>"
+                  }
+                },
+                {
+                  "name": "key",
+                  "type": {
+                    "text": "string"
+                  }
+                }
+              ],
+              "description": "Position of a key in the cache's insertion order. @internal"
+            },
+            {
+              "kind": "field",
+              "name": "gridReceivesLiveUpdates"
+            },
             {
               "kind": "field",
               "name": "auth",
@@ -17505,6 +17847,56 @@
                 "module": "src/datasource/server-side.resource-base.ts"
               }
             },
+            {
+              "kind": "field",
+              "name": "onRowsDeliveredFunc",
+              "type": {
+                "text": "(rows: any[]) => void | undefined"
+              },
+              "privacy": "protected",
+              "inheritedFrom": {
+                "name": "BaseServerSideDatasource",
+                "module": "src/datasource/server-side.resource-base.ts"
+              }
+            },
+            {
+              "kind": "field",
+              "name": "onRowsWithdrawnFunc",
+              "type": {
+                "text": "(rowIds: string[]) => void | undefined"
+              },
+              "privacy": "protected",
+              "inheritedFrom": {
+                "name": "BaseServerSideDatasource",
+                "module": "src/datasource/server-side.resource-base.ts"
+              }
+            },
+            {
+              "kind": "field",
+              "name": "onRowsEvictedFunc",
+              "type": {
+                "text": "(rowIds: string[]) => void | undefined"
+              },
+              "privacy": "protected",
+              "inheritedFrom": {
+                "name": "BaseServerSideDatasource",
+                "module": "src/datasource/server-side.resource-base.ts"
+              }
+            },
+            {
+              "kind": "field",
+              "name": "ledger",
+              "type": {
+                "text": "DeliveredBlockLedger"
+              },
+              "privacy": "protected",
+              "description": "Which rows each delivered block carried, for withdrawal and eviction reporting. @internal",
+              "default": "new DeliveredBlockLedger(options.rowId, options.maxBlocksInCache)",
+              "inheritedFrom": {
+                "name": "BaseServerSideDatasource",
+                "module": "src/datasource/server-side.resource-base.ts"
+              }
+            },
             {
               "kind": "field",
               "name": "resourceName",
@@ -18427,6 +18819,56 @@
                 "module": "src/datasource/server-side.resource-base.ts"
               }
             },
+            {
+              "kind": "field",
+              "name": "onRowsDeliveredFunc",
+              "type": {
+                "text": "(rows: any[]) => void | undefined"
+              },
+              "privacy": "protected",
+              "inheritedFrom": {
+                "name": "BaseServerSideDatasource",
+                "module": "src/datasource/server-side.resource-base.ts"
+              }
+            },
+            {
+              "kind": "field",
+              "name": "onRowsWithdrawnFunc",
+              "type": {
+                "text": "(rowIds: string[]) => void | undefined"
+              },
+              "privacy": "protected",
+              "inheritedFrom": {
+                "name": "BaseServerSideDatasource",
+                "module": "src/datasource/server-side.resource-base.ts"
+              }
+            },
+            {
+              "kind": "field",
+              "name": "onRowsEvictedFunc",
+              "type": {
+                "text": "(rowIds: string[]) => void | undefined"
+              },
+              "privacy": "protected",
+              "inheritedFrom": {
+                "name": "BaseServerSideDatasource",
+                "module": "src/datasource/server-side.resource-base.ts"
+              }
+            },
+            {
+              "kind": "field",
+              "name": "ledger",
+              "type": {
+                "text": "DeliveredBlockLedger"
+              },
+              "privacy": "protected",
+              "description": "Which rows each delivered block carried, for withdrawal and eviction reporting. @internal",
+              "default": "new DeliveredBlockLedger(options.rowId, options.maxBlocksInCache)",
+              "inheritedFrom": {
+                "name": "BaseServerSideDatasource",
+                "module": "src/datasource/server-side.resource-base.ts"
+              }
+            },
             {
               "kind": "field",
               "name": "resourceName",
@@ -19842,6 +20284,17 @@
                 "module": "src/mixins/lifecycle/lifecycle.ts"
               }
             },
+            {
+              "kind": "field",
+              "name": "serializer",
+              "type": {
+                "text": "JSONSerializer"
+              },
+              "inheritedFrom": {
+                "name": "GridProBaseDatasource",
+                "module": "src/datasource/base.datasource.ts"
+              }
+            },
             {
               "kind": "field",
               "name": "dataSubWasLoggedOff",
@@ -19867,6 +20320,20 @@
                 "module": "src/datasource/base.datasource.ts"
               }
             },
+            {
+              "kind": "field",
+              "name": "missingRowIdWarned",
+              "type": {
+                "text": "boolean"
+              },
+              "privacy": "private",
+              "default": "false",
+              "description": "So rows without a row id are warned about once per element, not once per block. @internal",
+              "inheritedFrom": {
+                "name": "GridProBaseDatasource",
+                "module": "src/datasource/base.datasource.ts"
+              }
+            },
             {
               "kind": "field",
               "name": "connectionSub",
@@ -19963,6 +20430,44 @@
                 "module": "src/datasource/base.datasource.ts"
               }
             },
+            {
+              "kind": "method",
+              "name": "emitTransaction",
+              "privacy": "protected",
+              "return": {
+                "type": {
+                  "text": "void"
+                }
+              },
+              "parameters": [
+                {
+                  "name": "transaction",
+                  "type": {
+                    "text": "TransactionData | undefined"
+                  }
+                }
+              ],
+              "description": "Emits `datasource-data-changed` for `transaction` when it is non-empty. @internal",
+              "inheritedFrom": {
+                "name": "GridProBaseDatasource",
+                "module": "src/datasource/base.datasource.ts"
+              }
+            },
+            {
+              "kind": "method",
+              "name": "emitPendingTransaction",
+              "privacy": "protected",
+              "return": {
+                "type": {
+                  "text": "void"
+                }
+              },
+              "description": "Emits `datasource-data-changed` for the current transaction when it is non-empty. @internal",
+              "inheritedFrom": {
+                "name": "GridProBaseDatasource",
+                "module": "src/datasource/base.datasource.ts"
+              }
+            },
             {
               "kind": "method",
               "name": "mapTransaction",