@genesislcap/grid-pro 14.348.0 → 14.350.0

package/dist/esm/grid-pro-genesis-datasource/grid-pro-genesis-datasource.js

@@ -1,5 +1,4 @@
 import { __awaiter, __decorate } from "tslib";
-import { Events, } from '@ag-grid-community/core';
 import { MessageType, ResourceType, dataServerResultFilter, normaliseCriteria, } from '@genesislcap/foundation-comms';
 import { LifecycleMixin } from '@genesislcap/foundation-utils';
 import { DOM, attr, customElement } from '@microsoft/fast-element';
@@ -7,8 +6,8 @@ import { BehaviorSubject, EMPTY } from 'rxjs';
 import { catchError, debounceTime, skip, tap } from 'rxjs/operators';
 import { criteriaDelimiter, GridProBaseDatasource } from '../datasource/base.datasource';
 import { getClientSideFilterParamsByFieldType } from '../datasource/client-side.grid-definitions';
-import { GridProStatusBarTypes } from '../grid-pro.types';
 import { logger } from '../utils/logger';
+import { datasourceEventNames, } from './datasource-events.types';
 import { gridProGenesisDatasourceEventNames } from './grid-pro-genesis-datasource.config';
 const withoutFullInit = null;
 const withoutColumnDefs = null;
@@ -20,10 +19,15 @@ const withoutColumnDefs = null;
 let GridProGenesisDatasource = class GridProGenesisDatasource extends LifecycleMixin(GridProBaseDatasource) {
     constructor() {
         super(...arguments);
-        this.applyFuncName = 'applyTransaction';
-        this.applyAsyncFuncName = 'applyTransactionAsync';
         // Cache for rowData array to avoid repeated Array.from() calls
         this.cachedRowArray = [];
+        // Transaction data for grid operations
+        this.transactionData = {
+            add: [],
+            remove: [],
+            update: [],
+            addIndex: 0,
+        };
         this.keepColDefsOnClearRowData = false;
         this.requiresFullRowDataAndColDefs = true;
         this._lastMoreRows = false;
@@ -113,27 +117,26 @@ let GridProGenesisDatasource = class GridProGenesisDatasource extends LifecycleM
      * @param columnStates  - Optionally set the grid up with column state
      * @remarks This method is called automatically when the element is connected to the DOM.
      */
-    init(columnDefinitions, columnStates) {
+    init(keepColDefsOnClearRowData) {
         return __awaiter(this, void 0, void 0, function* () {
-            if (this.agGrid) {
-                const gridOptions = Object.assign(Object.assign(Object.assign({ getRowId: (params) => params.data[this.rowId] }, this.agGrid['agGridOptions']), (columnDefinitions && { columnDefs: columnDefinitions })), this.deferredGridOptions);
-                this.agGrid.gridOptions = Object.assign({}, gridOptions);
-                this.agGrid['initGrid']();
-                this.agGrid.addEventListener(Events.EVENT_GRID_READY, () => __awaiter(this, void 0, void 0, function* () {
-                    if (columnStates) {
-                        this.agGrid.columnApi.applyColumnState({ state: columnStates });
-                    }
-                    yield this.loadResourceData();
-                }), { once: true });
-                const filterDebounceTime = 600;
-                this.updateSub = this.update
-                    .pipe(skip(1), debounceTime(filterDebounceTime), tap((f) => logger.debug('filters (debounced): ', f)))
-                    .subscribe((_) => {
-                    this.reloadResourceData();
-                });
-                return;
-            }
-            this.handleErrors('Application not connected or invalid resource name, datasource will not work.', 'unknown');
+            // Emit event to initialize datasource with options
+            const options = Object.assign({ getRowId: (params) => params.data[this.rowId] }, this.deferredGridOptions);
+            this.$emit(datasourceEventNames.initialize, {
+                keepColDefsOnClearRowData,
+                options,
+            });
+            // TODO: instead of listening to ready event, we should only render the datasource slot when the grid is ready
+            this.addEventListener(datasourceEventNames.ready, (event) => __awaiter(this, void 0, void 0, function* () {
+                const { pagination } = event.detail;
+                this.pagination = pagination;
+                yield this.loadResourceData();
+            }), { once: true });
+            const filterDebounceTime = 600;
+            this.updateSub = this.update
+                .pipe(skip(1), debounceTime(filterDebounceTime), tap((f) => logger.debug('filters (debounced): ', f)))
+                .subscribe((_) => {
+                this.reloadResourceData();
+            });
         });
     }
     /**
@@ -161,7 +164,6 @@ let GridProGenesisDatasource = class GridProGenesisDatasource extends LifecycleM
         this._isMoreRowsResult = false;
         this._nextOffset = 0;
         this._loadMoreCount = 0;
-        this.agGrid.clearLocalGridOptions();
         this.requiresFullRowDataAndColDefs = true;
         this.dataSubWasLoggedOff = false;
         this.criteriaFromFilters = new Map();
@@ -195,14 +197,8 @@ let GridProGenesisDatasource = class GridProGenesisDatasource extends LifecycleM
      */
     restart() {
         return __awaiter(this, void 0, void 0, function* () {
-            let columnDefinitions;
-            let columnStates;
-            if (this.keepColDefsOnClearRowData) {
-                columnDefinitions = this.agGrid.gridApi.getColumnDefs();
-                columnStates = this.agGrid.columnApi.getColumnState();
-            }
             this.destroy();
-            yield this.init(columnDefinitions, columnStates);
+            yield this.init(this.keepColDefsOnClearRowData);
         });
     }
     /**
@@ -210,7 +206,7 @@ let GridProGenesisDatasource = class GridProGenesisDatasource extends LifecycleM
      */
     refreshRows() {
         this.updateCachedRowArray(); // Ensure the cache is up-to-date
-        this.setRowData(this.cachedRowArray);
+        this.emitDataLoaded(this.cachedRowArray);
     }
     /**
      * Clears the rowData and columnDefs for the grid.
@@ -219,29 +215,23 @@ let GridProGenesisDatasource = class GridProGenesisDatasource extends LifecycleM
      * @internal
      */
     clearRowData(withColumnDefs = true) {
-        var _a, _b, _c, _d, _e, _f, _g, _h;
-        if (this.agGrid.asyncAdd || this.agGrid.asyncUpdate || this.agGrid.asyncRemove) {
-            (_b = (_a = this.agGrid) === null || _a === void 0 ? void 0 : _a.gridApi) === null || _b === void 0 ? void 0 : _b.flushAsyncTransactions();
-        }
         this.rowData = new Map();
         this.cachedRowArray = []; // Clear the cached array
-        this.agTransaction = undefined;
-        if (withColumnDefs && !this.keepColDefsOnClearRowData) {
-            (_d = (_c = this.agGrid) === null || _c === void 0 ? void 0 : _c.gridApi) === null || _d === void 0 ? void 0 : _d.setColumnDefs([]);
-        }
-        (_f = (_e = this.agGrid) === null || _e === void 0 ? void 0 : _e.gridApi) === null || _f === void 0 ? void 0 : _f.setRowData([]);
-        (_h = (_g = this.agGrid) === null || _g === void 0 ? void 0 : _g.gridApi) === null || _h === void 0 ? void 0 : _h.refreshCells({ force: true });
+        this.transactionData = { add: [], remove: [], update: [], addIndex: 0 };
+        // Emit event to clear data
+        this.$emit(datasourceEventNames.dataCleared, {
+            includeSchema: withColumnDefs && !this.keepColDefsOnClearRowData,
+        });
     }
     /**
      * Sets the columnDefs and rowData for the grid.
-     * @remarks This should only happen once, when the grid is first initialized. Follow up updates will use the agTransaction.
+     * @remarks This should only happen once, when the grid is first initialized. Follow up updates will use transactions.
      * @internal
      */
     setRowData(rowData) {
         return __awaiter(this, void 0, void 0, function* () {
-            var _a;
-            const preSetColumnDefs = (_a = this.agGrid.gridApi) === null || _a === void 0 ? void 0 : _a.getColumnDefs();
-            if (!preSetColumnDefs || preSetColumnDefs.length === 0) {
+            // Check if we need to set column definitions first
+            if (this.requiresFullRowDataAndColDefs) {
                 const agColumnDefs = yield this.getAgColumnDefs(this.datasource.fieldMetadata);
                 if (agColumnDefs) {
                     // AG's internals will check if group/pivot are NOT NULL to trigger module registration warning for `row-grouping`.
@@ -255,14 +245,17 @@ let GridProGenesisDatasource = class GridProGenesisDatasource extends LifecycleM
                             col.pivot = null;
                         }
                     });
-                    this.agGrid.gridApi.setColumnDefs(agColumnDefs);
+                    this.$emit(datasourceEventNames.schemaUpdated, {
+                        schema: agColumnDefs,
+                        metadata: this.datasource.fieldMetadata,
+                    });
                 }
             }
             const data = this.rowDataMapper ? this.rowDataMapper(rowData) : rowData;
-            this.agGrid.restoreCachedFilterConfig();
+            this.$emit(datasourceEventNames.filtersRestored);
             // Use transactions for adding data
-            this.agTransaction = { add: data ? [...data] : [], remove: [], update: [], addIndex: 0 };
-            this.applyAllAgTransactions();
+            this.transactionData = { add: data ? [...data] : [], remove: [], update: [], addIndex: 0 };
+            this.emitDataChanged(this.transactionData);
             // Update the cached row array
             this.updateCachedRowArray();
             this.requiresFullRowDataAndColDefs = false;
@@ -275,6 +268,31 @@ let GridProGenesisDatasource = class GridProGenesisDatasource extends LifecycleM
     updateCachedRowArray() {
         this.cachedRowArray = Array.from(this.rowData.values());
     }
+    /**
+     * Emits event to notify data has been loaded
+     * @internal
+     */
+    emitDataLoaded(data, isInitialLoad = false) {
+        this.$emit(datasourceEventNames.dataLoaded, {
+            data,
+            isInitialLoad,
+        });
+    }
+    /**
+     * Emits event to notify data has changed
+     * @internal
+     */
+    emitDataChanged(transaction) {
+        this.$emit(datasourceEventNames.dataChanged, {
+            changes: transaction,
+        });
+        if (this.rowData.size === 0 &&
+            !transaction.add.length &&
+            !transaction.update.length &&
+            !transaction.remove.length) {
+            this.$emit(datasourceEventNames.noDataAvailable);
+        }
+    }
     /**
      * Resets the grid data while keeping columnDefs and sends a DATA_LOGOFF message if it's a stream.
      * Loads resource data without full initialization (no metadata fetch).
@@ -284,7 +302,6 @@ let GridProGenesisDatasource = class GridProGenesisDatasource extends LifecycleM
      */
     reloadResourceData() {
         return __awaiter(this, void 0, void 0, function* () {
-            var _a, _b, _c;
             logger.debug('GridProGenesisDatasource.reloadResourceData()', this.resourceName);
             if (this.dataSub) {
                 this.dataSub.unsubscribe();
@@ -295,10 +312,8 @@ let GridProGenesisDatasource = class GridProGenesisDatasource extends LifecycleM
             this._loadMoreCount = 0;
             this.datasource.updateLoadMoreCount(0);
             this.datasource.stream = undefined;
-            // Cache the current filter model before clearing data to preserve column filters
-            yield ((_a = this.agGrid) === null || _a === void 0 ? void 0 : _a.cacheFilterConfig());
             this.clearRowData(withoutColumnDefs);
-            (_c = (_b = this.agGrid) === null || _b === void 0 ? void 0 : _b.gridApi) === null || _c === void 0 ? void 0 : _c.showLoadingOverlay();
+            this.$emit(datasourceEventNames.loadingStarted);
             this.setDisconnected(false);
             yield this.loadResourceData(withoutFullInit);
         });
@@ -418,20 +433,13 @@ let GridProGenesisDatasource = class GridProGenesisDatasource extends LifecycleM
      * @param sourceRef - The source reference
      * @param rowsCount - The total number of rows
      * @remarks
-     * This method requires AG Grid Enterprise module to work properly.
-     * It will silently fail if the Enterprise module is not available.
+     * This method emits an event for the grid to handle status bar updates.
      */
     updateLoadMoreStatus(moreRows, sourceRef) {
-        var _a, _b, _c;
-        if (!((_a = this.agGrid) === null || _a === void 0 ? void 0 : _a.gridApi))
-            return;
-        const statusBar = this.agGrid.gridApi.getStatusPanel(GridProStatusBarTypes.loadMore);
-        if (statusBar) {
-            (_c = (_b = statusBar).updateParams) === null || _c === void 0 ? void 0 : _c.call(_b, {
-                moreRows,
-                sourceRef,
-            });
-        }
+        this.$emit(datasourceEventNames.moreDataAvailable, {
+            hasMoreData: moreRows,
+            sourceRef,
+        });
     }
     applyRequestServerData(requestServerResult) {
         var _a;
@@ -479,11 +487,11 @@ let GridProGenesisDatasource = class GridProGenesisDatasource extends LifecycleM
             return true; // delete rows that don't exist in requestServerData
         });
         const rowsToInsert = requestServerData.filter((data) => !this.rowData.has(data[this.rowId]));
-        this.agTransaction = { add: [], remove: [], update: [] };
+        this.transactionData = { add: [], remove: [], update: [] };
         this.handleStreamInserts(rowsToInsert);
         this.handleStreamDeletes(rowsToDelete);
         this.handleStreamUpdates(rowsToUpdate);
-        this.applyAllAgTransactions();
+        this.emitDataChanged(this.transactionData);
         this.handleSizeChanged(previousSize, this.rowData.size);
     }
     applyDataserverData(dataServerResult) {
@@ -499,19 +507,19 @@ let GridProGenesisDatasource = class GridProGenesisDatasource extends LifecycleM
             this.handleSizeChanged(previousSize, this.rowData.size);
             return;
         }
-        this.agTransaction = { add: [], remove: [], update: [] };
+        this.transactionData = { add: [], remove: [], update: [] };
         this.handleStreamInserts(dataServerResult.inserts);
         this.handleStreamDeletes(dataServerResult.deletes);
         this.handleStreamUpdates(dataServerResult.updates);
-        this.applyAllAgTransactions();
+        this.emitDataChanged(this.transactionData);
         this.handleSizeChanged(previousSize, this.rowData.size);
     }
     // FUTURE: Work with the field types vs ag grid column def types!
     getAgColumnDefs(fieldsMetadata) {
         return __awaiter(this, void 0, void 0, function* () {
             const columnDefsFromMetadata = this.generateColumnDefsFromMetadata(fieldsMetadata, getClientSideFilterParamsByFieldType);
-            const colDefsMergedWithTemplateDefs = yield this.agGrid.mergeAllColumnDefsAndStates(columnDefsFromMetadata, true);
-            return colDefsMergedWithTemplateDefs;
+            // Return the base column definitions - the grid will handle merging with template definitions
+            return columnDefsFromMetadata;
         });
     }
     setFilter(fieldName, newFilter) {
@@ -522,11 +530,8 @@ let GridProGenesisDatasource = class GridProGenesisDatasource extends LifecycleM
         this.criteriaFromFilters.delete(fieldName);
         this.update.next(this.criteriaFromFilters);
     }
-    applyTransaction(agTransaction) {
-        return this.agGrid.gridApi.applyTransaction(agTransaction);
-    }
-    applyTransactionAsync(agTransaction, callback) {
-        this.agGrid.gridApi.applyTransactionAsync(agTransaction, callback);
+    applyTransaction(transaction) {
+        this.emitDataChanged(transaction);
     }
     handleSizeChanged(oldSize, newSize) {
         if (oldSize === newSize)