@genesislcap/grid-pro 15.20.2-grid-pro-datasource-fix.1 → 15.21.0

package/dist/esm/datasource/server-side.resource-base.js

@@ -1,6 +1,7 @@
 import { __awaiter, __decorate } from "tslib";
 import { Auth, Connect } from '@genesislcap/foundation-comms';
 import { UUID } from '@genesislcap/foundation-utils';
+import { convertDateFilterToCriteria, convertNumberFilterToCriteria, convertSetFilterToCriteria, convertTextFilterToCriteria, } from './filter.utils';
 /**
  * Base class for server-side resource datasources used in Grid Pro SSRM implementations.
  * Provides common logic for filtering, sorting, and infinite-scroll row counting.
@@ -240,117 +241,18 @@ export class BaseServerSideDatasource {
         }
     }
     criteriaForTextModel(k, model) {
-        const type = model.type;
-        const val = model.filter;
-        if (!val && (type === 'false' || type === 'true')) {
-            return `${k} == ${type}`;
-        }
-        const safeVal = val ? String(val).replace(/'/g, "\\'") : '';
-        switch (type) {
-            case 'blank':
-                return `(${k} == '' || ${k} == null)`;
-            case 'contains':
-                return `Expr.containsIgnoreCase(${k}, '${safeVal}')`;
-            case 'equals':
-                return `${k} == '${safeVal}'`;
-            case 'notBlank':
-                return `(${k} != '' && ${k} != null)`;
-            case 'notEqual':
-                return `${k} != '${safeVal}'`;
-            case 'wordStartsWith':
-                return `Expr.containsWordsStartingWithIgnoreCase(${k}, '${safeVal}')`;
-            default:
-                return null;
-        }
+        return convertTextFilterToCriteria(model, k);
     }
     criteriaForSetModel(k, model) {
-        var _a, _b;
-        const selectedValues = ((_a = model.values) !== null && _a !== void 0 ? _a : []);
-        if (!selectedValues.length) {
-            // Nothing selected means no additional criteria
-            return null;
-        }
-        // Try to detect "all values selected" using VALID_VALUES from metadata.
-        // In that case we don't want to send any criteria, as it would be equivalent
-        // to no filter at all.
-        const colMeta = (_b = this.resourceColDefs) === null || _b === void 0 ? void 0 : _b.find((o) => o.NAME === k);
-        let allValues;
-        if (colMeta === null || colMeta === void 0 ? void 0 : colMeta.VALID_VALUES) {
-            try {
-                allValues = Array.isArray(colMeta.VALID_VALUES)
-                    ? colMeta.VALID_VALUES
-                    : colMeta.VALID_VALUES.split('|');
-            }
-            catch (_c) {
-                allValues = undefined;
-            }
-        }
-        if (allValues &&
-            allValues.length === selectedValues.length &&
-            allValues.every((v) => selectedValues.includes(v))) {
-            // All enum options are selected – skip adding criteria for this column
-            return null;
-        }
-        const orConditions = selectedValues.map((val) => {
-            const safeVal = String(val).replace(/'/g, "\\'");
-            return `${k} == '${safeVal}'`;
-        });
-        return orConditions.length ? `(${orConditions.join(' || ')})` : null;
+        var _a;
+        const colMeta = (_a = this.resourceColDefs) === null || _a === void 0 ? void 0 : _a.find((o) => o.NAME === k);
+        return convertSetFilterToCriteria(model, k, colMeta);
     }
     criteriaForNumberModel(k, model) {
-        const value = model.filter;
-        const valueTwo = model.filterTo;
-        const isNum = (v) => v !== null && v !== '' && !isNaN(Number(v));
-        switch (model.type) {
-            case 'equals':
-                return isNum(value) ? `${k} == ${value}` : null;
-            case 'notEqual':
-                return isNum(value) ? `${k} != ${value}` : null;
-            case 'greaterThan':
-                return isNum(value) ? `${k} > ${value}` : null;
-            case 'greaterThanOrEqual':
-                return isNum(value) ? `${k} >= ${value}` : null;
-            case 'lessThan':
-                return isNum(value) ? `${k} < ${value}` : null;
-            case 'lessThanOrEqual':
-                return isNum(value) ? `${k} <= ${value}` : null;
-            case 'inRange':
-                return isNum(value) && isNum(valueTwo) ? `${k} >= ${value} && ${k} <= ${valueTwo}` : null;
-            case 'blank':
-                return `${k} == 0`;
-            case 'notBlank':
-                return `${k} != 0`;
-            default:
-                return null;
-        }
+        return convertNumberFilterToCriteria(model, k);
     }
     criteriaForDateModel(k, model) {
-        var _a, _b;
-        const dateFrom = (_a = model.dateFrom) === null || _a === void 0 ? void 0 : _a.replace(/-/g, '').replace('T', '-').split(' ')[0];
-        const dateTo = (_b = model.dateTo) === null || _b === void 0 ? void 0 : _b.replace(/-/g, '').replace('T', '-').split(' ')[0];
-        switch (model.type) {
-            case 'equals':
-                return `Expr.dateIsEqual(${k}, '${dateFrom}')`;
-            case 'lessThan':
-                return `Expr.dateIsBefore(${k}, '${dateFrom}')`;
-            case 'greaterThan':
-                return `Expr.dateIsAfter(${k}, '${dateFrom}')`;
-            case 'inRange':
-                return `Expr.dateIsAfter(${k}, '${dateFrom}') && Expr.dateIsBefore(${k}, '${dateTo}')`;
-            case 'isToday': {
-                const now = new Date();
-                const year = now.getFullYear();
-                const month = (now.getMonth() + 1).toString().padStart(2, '0');
-                const day = now.getDate().toString().padStart(2, '0');
-                return `Expr.dateIsEqual(${k}, '${year}-${month}-${day} 00:00:00')`;
-            }
-            case 'blank':
-                return `${k} == null`;
-            case 'notBlank':
-                return `${k} != null`;
-            default:
-                return null;
-        }
+        return convertDateFilterToCriteria(model, k);
     }
     getFiltersByType(filterType) {
         var _a;

package/dist/esm/grid-pro-beta.js

@@ -4,14 +4,14 @@ import { avoidTreeShaking, LifecycleMixin, respondToVisibility, } from '@genesis
 import { baseLayerLuminance, StandardLuminance } from '@microsoft/fast-components';
 import { attr, DOM, observable } from '@microsoft/fast-element';
 import { FoundationElement } from '@microsoft/fast-foundation';
-import { CellStyleModule, CheckboxEditorModule, ClientSideRowModelApiModule, ClientSideRowModelModule, ColumnApiModule, ColumnAutoSizeModule, createGrid, CsvExportModule, CustomEditorModule, DateEditorModule, DateFilterModule, EventApiModule, HighlightChangesModule, ModuleRegistry, NumberEditorModule, NumberFilterModule, PaginationModule, RenderApiModule, RowApiModule, RowDragModule, RowSelectionModule, RowStyleModule, SelectEditorModule, TextEditorModule, TextFilterModule, TooltipModule, } from 'ag-grid-community';
+import { CellStyleModule, CheckboxEditorModule, ClientSideRowModelApiModule, ClientSideRowModelModule, ColumnApiModule, ColumnAutoSizeModule, createGrid, CsvExportModule, CustomEditorModule, DateEditorModule, DateFilterModule, EventApiModule, HighlightChangesModule, InfiniteRowModelModule, ModuleRegistry, NumberEditorModule, NumberFilterModule, PaginationModule, RenderApiModule, RowApiModule, RowDragModule, RowSelectionModule, RowStyleModule, SelectEditorModule, TextEditorModule, TextFilterModule, TooltipModule, } from 'ag-grid-community';
 import * as changeCase from 'change-case';
 import debounce from 'lodash.debounce';
 import { GridProCell } from './cell';
 import { DateEditor, MultiselectEditor, NumberEditor, SelectEditor, StringEditor, } from './cell-editors';
 import { ActionRenderer, ActionsMenuRenderer, BooleanRenderer, EditableRenderer, IconRenderer, SelectRenderer, StatusPillRenderer, } from './cell-renderers';
 import { GridProColumn, resolveVisibleColumnFields } from './column';
-import { GridProClientSideDatasource, GridProServerSideDatasource } from './datasource';
+import { GridProClientSideDatasource, GridProInfiniteDatasource, GridProServerSideDatasource, } from './datasource';
 import { baseDatasourceEventNames } from './datasource/base.types';
 import { GridProGenesisDatasource, gridProGenesisDatasourceEventNames, } from './grid-pro-genesis-datasource';
 import { datasourceEventNames, } from './grid-pro-genesis-datasource/datasource-events.types';
@@ -21,7 +21,7 @@ import { StatePersistence } from './state-persistence';
 import { LabelValueStatusBarComponent, LoadMoreStatusBarComponent, ReloadStatusBarComponent, RowCountStatusBarComponent, } from './status-bar-components';
 import { ErrorTooltip } from './tooltips';
 import { convertToKebabCase, logger, mergeAndDedupColDefWithColumnState, sanitizeColumnState, } from './utils';
-avoidTreeShaking(GridProGenesisDatasource, GridProClientSideDatasource, GridProServerSideDatasource, GridProCell, GridProColumn);
+avoidTreeShaking(GridProGenesisDatasource, GridProClientSideDatasource, GridProServerSideDatasource, GridProInfiniteDatasource, GridProCell, GridProColumn);
 ModuleRegistry.registerModules([
     CsvExportModule,
     ClientSideRowModelModule,
@@ -47,6 +47,7 @@ ModuleRegistry.registerModules([
     DateEditorModule,
     SelectEditorModule,
     CheckboxEditorModule,
+    InfiniteRowModelModule,
     // ValidationModule,
 ]);
 const DEBOUNCE_TIME = 400;
@@ -171,12 +172,6 @@ export class GridProBeta extends LifecycleMixin(FoundationElement) {
         this.withStatusBar = false;
         this.applyingDatasourceGridOptions = false;
         this.rehydrationAttempted = false;
-        /**
-         * Whether `onGridReady` has ever fired `datasourceEventNames.ready` at least once. A datasource
-         * that connects (or restarts) after that point would otherwise miss the one-shot event entirely
-         * — see `handleInitialize`, which replays it directly to any datasource that inits late.
-         */
-        this.hasEmittedDatasourceReady = false;
         this.rootEventsListeners = [];
         this.datasourceEventHandlers = [];
         this.gridEventsQueue = [];
@@ -247,6 +242,15 @@ export class GridProBeta extends LifecycleMixin(FoundationElement) {
                 datasourceEventNames.applyServerSideTransaction,
                 this.handleApplyServerSideTransaction.bind(this),
             ],
+            // Infinite Row Model specific events
+            [
+                datasourceEventNames.setInfiniteDatasource,
+                this.handleSetInfiniteDatasource.bind(this),
+            ],
+            [
+                datasourceEventNames.refreshInfiniteCache,
+                this.handleRefreshInfiniteCache.bind(this),
+            ],
         ];
     }
     /**
@@ -427,17 +431,6 @@ export class GridProBeta extends LifecycleMixin(FoundationElement) {
      */
     handleInitialize(event) {
         const { options, keepColDefsOnClearRowData } = event.detail;
-        if (this.hasEmittedDatasourceReady) {
-            // The grid already fired its one-shot ready event before this datasource registered its
-            // `once` listener (late connection, or a restart after an earlier ready). Replay it
-            // directly at the datasource once its own init() has finished registering that listener —
-            // a microtask guarantees that ordering without depending on rAF (DOM.queueUpdate can stall
-            // for reasons unrelated to this handshake, e.g. a backgrounded tab).
-            const datasource = event.target;
-            if (datasource) {
-                queueMicrotask(() => datasource.dispatchEvent(new Event(datasourceEventNames.ready)));
-            }
-        }
         if (keepColDefsOnClearRowData) {
             this.columnState = this.gridApi.getColumnState();
         }
@@ -518,6 +511,21 @@ export class GridProBeta extends LifecycleMixin(FoundationElement) {
                     }
                 });
             }
+            // Same for the set filter, which enum columns ask for: it is Enterprise, so it only works
+            // when the app registered SetFilterModule - otherwise AG raises error #200 and the column
+            // ends up with no working filter at all.
+            if (!this.gridApi.isModuleRegistered('SetFilterModule')) {
+                schema.forEach((colDef) => {
+                    if (colDef.filter === 'agSetColumnFilter') {
+                        logger.warn('SetFilterModule is not registered, falling back to text filter');
+                        colDef.filter = 'agTextColumnFilter';
+                        // The set filter's value list means nothing to the text filter.
+                        if (colDef.filterParams) {
+                            delete colDef.filterParams.values;
+                        }
+                    }
+                });
+            }
             // Merge with template definitions
             const mergedColumnDefs = yield this.mergeAllColumnDefsAndStates(schema, true);
             this.gridApi.setGridOption('columnDefs', mergedColumnDefs);
@@ -680,6 +688,33 @@ export class GridProBeta extends LifecycleMixin(FoundationElement) {
             }
         }
     }
+    /**
+     * Handles setting infinite datasource
+     * @internal
+     */
+    handleSetInfiniteDatasource(event) {
+        const { datasource } = event.detail;
+        if (this.gridApi) {
+            this.gridApi.setGridOption('datasource', datasource);
+        }
+    }
+    /**
+     * Handles refreshing the infinite cache.
+     * @remarks Mirrors {@link GridProBeta.handleRefreshServerSide}: `purge` drops the block cache
+     * and re-reads, otherwise the loaded blocks are re-read in place.
+     * @internal
+     */
+    handleRefreshInfiniteCache(event) {
+        var _a;
+        if (!this.gridApi)
+            return;
+        if ((_a = event.detail) === null || _a === void 0 ? void 0 : _a.purge) {
+            this.gridApi.purgeInfiniteCache();
+        }
+        else {
+            this.gridApi.refreshInfiniteCache();
+        }
+    }
     combineAllGridComponents(gridOptionsComponents) {
         const defaultFoundationAgComponents = {
             [GridProRendererTypes.action]: ActionRenderer,
@@ -931,7 +966,14 @@ export class GridProBeta extends LifecycleMixin(FoundationElement) {
     get gridProDatasource() {
         return (this.querySelector('grid-pro-genesis-datasource') ||
             this.querySelector('grid-pro-client-side-datasource') ||
-            this.querySelector('grid-pro-server-side-datasource'));
+            this.querySelector('grid-pro-server-side-datasource') ||
+            this.querySelector('grid-pro-infinite-datasource'));
+    }
+    /**
+     * @public
+     */
+    get isInfiniteRowModel() {
+        return this.gridProDatasource instanceof GridProInfiniteDatasource;
     }
     /**
      * Reports the currently visible columns to the datasource. The datasource decides what to do with
@@ -1027,7 +1069,6 @@ export class GridProBeta extends LifecycleMixin(FoundationElement) {
                 // TODO: prevent rendering datasource slot until grid is ready
                 // so there is no need for this even and handling it in datasources
                 (_c = this.gridProDatasource) === null || _c === void 0 ? void 0 : _c.$emit(datasourceEventNames.ready);
-                this.hasEmittedDatasourceReady = true;
                 this.restoreColumnState();
                 this.restoreCachedFilterConfig();
                 this.debouncedColumnAutosize();
@@ -1216,7 +1257,13 @@ export class GridProBeta extends LifecycleMixin(FoundationElement) {
         // The custom rowCount panel is used for server-side infinite scroll (load more) scenarios;
         // client-side row models use AG Grid's own row count component instead.
         if (this.statusBarConfig && this.statusBarConfig.rows === true) {
-            const isServerSide = this.isServerSide || (gridOptions === null || gridOptions === void 0 ? void 0 : gridOptions.rowModelType) === 'serverSide';
+            // Check the derived gridOptions parameter, not this.gridOptions: setupStatusBar runs
+            // before setLocalGridOptions populates the field, so on first init the field is still
+            // undefined and a standalone grid's rowModelType would be missed.
+            const isServerSide = this.isServerSide ||
+                this.isInfiniteRowModel ||
+                (gridOptions === null || gridOptions === void 0 ? void 0 : gridOptions.rowModelType) === 'infinite' ||
+                (gridOptions === null || gridOptions === void 0 ? void 0 : gridOptions.rowModelType) === 'serverSide';
             if (isServerSide) {
                 if (!this.panelExists(GridProStatusBarTypes.rowCount, statusPanels)) {
                     statusPanels.push({
@@ -1263,7 +1310,9 @@ export class GridProBeta extends LifecycleMixin(FoundationElement) {
     }
     addDatasourcePanels(statusPanels) {
         if (this.gridProDatasource) {
-            const datasourceStatusPanels = this.gridProDatasource.getDatasourceStatusBarPanels(this.isServerSide, this.statusBarConfig);
+            // The infinite row model loads on scroll, so its loadMore() is a no-op: suppress the
+            // Load More panel for it the same way it is suppressed for the server-side row model.
+            const datasourceStatusPanels = this.gridProDatasource.getDatasourceStatusBarPanels(this.isServerSide || this.isInfiniteRowModel, this.statusBarConfig);
             // Filter out duplicate datasource panels
             const newDatasourcePanels = datasourceStatusPanels.filter((panel) => !this.panelExists(panel.statusPanel, statusPanels));
             statusPanels.push(...newDatasourcePanels);

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

@@ -32,4 +32,7 @@ export const datasourceEventNames = {
     addGridCssClass: 'add-grid-css-class',
     removeGridCssClass: 'remove-grid-css-class',
     applyServerSideTransaction: 'apply-server-side-transaction',
+    // Infinite Row Model specific events
+    setInfiniteDatasource: 'set-infinite-datasource',
+    refreshInfiniteCache: 'refresh-infinite-cache',
 };

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

@@ -555,9 +555,6 @@ let GridProGenesisDatasource = class GridProGenesisDatasource extends LifecycleM
         this.criteriaFromFilters.delete(fieldName);
         this.update.next(this.criteriaFromFilters);
     }
-    applyTransaction(transaction) {
-        this.emitDataChanged(transaction);
-    }
     handleSizeChanged(oldSize, newSize) {
         if (oldSize === newSize)
             return;

package/dist/esm/grid-pro.js

@@ -188,12 +188,6 @@ export class GridPro extends LifecycleMixin(FoundationElement) {
         this.registeredGridEvents = new Set();
         this.gridEventListeners = new Map();
         this.boundGlobalEventListener = this.globalEventListener.bind(this);
-        /**
-         * Whether `onGridReady` has ever fired `datasourceEventNames.ready` at least once. A datasource
-         * that connects (or restarts) after that point would otherwise miss the one-shot event entirely
-         * — see `handleInitialize`, which replays it directly to any datasource that inits late.
-         */
-        this.hasEmittedDatasourceReady = false;
         this._filterConfig = undefined;
         this.agAttributes = {};
         this.agPropertiesMap = AG_PROPERTIES.reduce((map, property) => {
@@ -212,7 +206,18 @@ export class GridPro extends LifecycleMixin(FoundationElement) {
         [datasourceEventNames.cacheFilterConfig, this.cacheFilterConfig.bind(this)], [datasourceEventNames.refreshServerSide, this.handleRefreshServerSide.bind(this)], [datasourceEventNames.setServerSideDatasource, this.handleSetServerSideDatasource.bind(this)], [datasourceEventNames.addGridCssClass, this.handleAddGridCssClass.bind(this)], [datasourceEventNames.removeGridCssClass, this.handleRemoveGridCssClass.bind(this)], [
             datasourceEventNames.applyServerSideTransaction,
             this.handleApplyServerSideTransaction.bind(this),
-        ]);
+        ], 
+        // Infinite Row Model events: not supported by this legacy grid (it registers neither the
+        // module nor the handlers). Fail loudly rather than leaving a silently empty grid.
+        [datasourceEventNames.setInfiniteDatasource, this.refuseInfiniteDatasource.bind(this)]);
+    }
+    /**
+     * The Infinite Row Model is only wired into the beta grid, so an infinite datasource placed
+     * inside this element can never load data. Report it instead of ignoring the event.
+     * @internal
+     */
+    refuseInfiniteDatasource() {
+        logger.error('grid-pro does not support the Infinite Row Model; use the beta grid (GridProBeta) with grid-pro-infinite-datasource / datasource-type="infinite".');
     }
     /**
      * Adds an event listener to the grid element.
@@ -377,17 +382,6 @@ export class GridPro extends LifecycleMixin(FoundationElement) {
      */
     handleInitialize(event) {
         const { options, keepColDefsOnClearRowData } = event.detail;
-        if (this.hasEmittedDatasourceReady) {
-            // The grid already fired its one-shot ready event before this datasource registered its
-            // `once` listener (late connection, or a restart after an earlier ready). Replay it
-            // directly at the datasource once its own init() has finished registering that listener —
-            // a microtask guarantees that ordering without depending on rAF (DOM.queueUpdate can stall
-            // for reasons unrelated to this handshake, e.g. a backgrounded tab).
-            const datasource = event.target;
-            if (datasource) {
-                queueMicrotask(() => datasource.dispatchEvent(new Event(datasourceEventNames.ready)));
-            }
-        }
         let columnDefinitions;
         if (keepColDefsOnClearRowData) {
             columnDefinitions = this.gridApi.getColumnDefs();
@@ -1045,7 +1039,6 @@ export class GridPro extends LifecycleMixin(FoundationElement) {
                 // TODO: prevent rendering datasource slot until grid is ready
                 // so there is no need for this even and handling it in datasources
                 (_b = this.gridProDatasource) === null || _b === void 0 ? void 0 : _b.$emit(datasourceEventNames.ready);
-                this.hasEmittedDatasourceReady = true;
                 this.restoreColumnState();
                 this.restoreCachedFilterConfig();
                 this.debouncedColumnAutosize();