@genesislcap/grid-pro 15.21.1 → 15.22.1

package/dist/esm/datasource/filter.utils.js

@@ -53,11 +53,22 @@ export function convertTextFilterToCriteria(filterModel, fieldName) {
  * @returns Genesis criteria string or null
  */
 export function convertSetFilterToCriteria(filterModel, fieldName, colMeta) {
-    var _a;
-    const selectedValues = ((_a = filterModel === null || filterModel === void 0 ? void 0 : filterModel.values) !== null && _a !== void 0 ? _a : []);
-    if (!selectedValues || selectedValues.length === 0) {
+    // A model with no values array at all (hand-written, or persisted by an older version) is an
+    // inactive filter — EnumColumnFilter.setModel treats it the same way — so it must translate to
+    // "no criteria", not to the match-nothing expression below.
+    if ((filterModel === null || filterModel === void 0 ? void 0 : filterModel.values) == null) {
         return null;
     }
+    const selectedValues = filterModel.values;
+    if (selectedValues.length === 0) {
+        // An explicitly empty selection means "match nothing" (that is how set filters treat it
+        // client-side). Returning no criteria would make the server send every row instead, so emit
+        // an expression that is false for every value — built only from comparisons the criteria
+        // language accepts. This does cost a server round trip that is guaranteed to return zero
+        // rows; the state is transient (the user is mid-selection), so that is accepted over
+        // teaching the datasource a short-circuit sentinel.
+        return `(${fieldName} == '' && ${fieldName} != '')`;
+    }
     // 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.
@@ -68,17 +79,29 @@ export function convertSetFilterToCriteria(filterModel, fieldName, colMeta) {
                 ? colMeta.VALID_VALUES
                 : colMeta.VALID_VALUES.split('|');
         }
-        catch (_b) {
+        catch (_a) {
             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;
+        // Every enum option is selected, so the only thing this active model can still be excluding
+        // is blanks: interactive set filters (agSetColumnFilter and the grid-pro enum filter alike)
+        // report an all-inclusive selection as a null model, never as an explicit full list.
+        // Returning no criteria here would let blank rows through while the column shows as
+        // filtered — exclude blanks instead. Behaviour note: a model listing every VALID_VALUE set
+        // programmatically via setFilterModel (or persisted by an older version) previously produced
+        // no criteria and now excludes blanks — the faithful set-model reading, since blanks are not
+        // in the list.
+        return `(${fieldName} != '' && ${fieldName} != null)`;
     }
     const orConditions = selectedValues.map((val) => {
+        // A null entry is the set-filter convention for blanks; both agSetColumnFilter and the
+        // grid-pro enum filter emit it.
+        if (val === null) {
+            return `(${fieldName} == '' || ${fieldName} == null)`;
+        }
         return `${fieldName} == '${escapeCriteriaValue(val)}'`;
     });
     if (orConditions.length > 0) {

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

@@ -4,13 +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, InfiniteRowModelModule, 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, CustomFilterModule, 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 { EnumColumnFilter, EnumColumnFloatingFilter, GridProFilterTypes } from './column-filters';
 import { GridProClientSideDatasource, GridProInfiniteDatasource, GridProServerSideDatasource, } from './datasource';
 import { baseDatasourceEventNames } from './datasource/base.types';
 import { GridProGenesisDatasource, gridProGenesisDatasourceEventNames, } from './grid-pro-genesis-datasource';
@@ -47,6 +48,7 @@ ModuleRegistry.registerModules([
     DateEditorModule,
     SelectEditorModule,
     CheckboxEditorModule,
+    CustomFilterModule,
     InfiniteRowModelModule,
     // ValidationModule,
 ]);
@@ -501,31 +503,7 @@ export class GridProBeta extends LifecycleMixin(FoundationElement) {
             if (preSetColumnDefs && preSetColumnDefs.length > 0) {
                 return;
             }
-            // ag-grid from v35 is throwing an error if the MultiFilterModule is not registered
-            // previously it would fallback to the text filter
-            if (!this.gridApi.isModuleRegistered('MultiFilterModule')) {
-                schema.forEach((colDef) => {
-                    if (colDef.filter === 'agMultiColumnFilter') {
-                        logger.warn('MultiFilterModule is not registered, falling back to text filter');
-                        colDef.filter = 'agTextColumnFilter';
-                    }
-                });
-            }
-            // 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;
-                        }
-                    }
-                });
-            }
+            this.applyCommunityFilterFallbacks(schema);
             // Merge with template definitions
             const mergedColumnDefs = yield this.mergeAllColumnDefsAndStates(schema, true);
             this.gridApi.setGridOption('columnDefs', mergedColumnDefs);
@@ -537,6 +515,58 @@ export class GridProBeta extends LifecycleMixin(FoundationElement) {
             this.restoreCachedFilterConfig();
         });
     }
+    /**
+     * Downgrades enterprise filters in metadata-generated colDefs when their modules are not
+     * registered — from v35 AG Grid throws on unregistered filters instead of falling back.
+     * Enum columns (recognised by their metadata-sourced set-filter values) keep those values by
+     * falling back to the community `EnumColumnFilter` instead of a plain text filter.
+     *
+     * The enum floating filter is only wired as the column's component, not enabled: AG's floating
+     * filter is a full-width header row, so enabling it for one column changes the layout of every
+     * column. Active-filter state is surfaced instead by AG's native header filter icon plus the
+     * header tooltip the enum filter maintains; consumers wanting the floating row opt in with
+     * `floatingFilter: true`.
+     * @internal
+     */
+    applyCommunityFilterFallbacks(schema) {
+        const hasSetFilter = this.gridApi.isModuleRegistered('SetFilterModule');
+        const hasMultiFilter = this.gridApi.isModuleRegistered('MultiFilterModule');
+        schema.forEach((colDef) => {
+            var _a, _b, _c, _d, _e;
+            if (colDef.filter === 'agSetColumnFilter' && !hasSetFilter) {
+                logger.debug(`SetFilterModule is not registered; column '${colDef.field}' falls back to the enum filter`);
+                colDef.filter = GridProFilterTypes.enumFilter;
+                (_a = colDef.floatingFilterComponent) !== null && _a !== void 0 ? _a : (colDef.floatingFilterComponent = GridProFilterTypes.enumFloatingFilter);
+                return;
+            }
+            if (colDef.filter !== 'agMultiColumnFilter') {
+                return;
+            }
+            const setSubFilter = (_c = (_b = colDef.filterParams) === null || _b === void 0 ? void 0 : _b.filters) === null || _c === void 0 ? void 0 : _c.find((subFilter) => subFilter.filter === 'agSetColumnFilter');
+            if (!hasMultiFilter) {
+                if ((_d = setSubFilter === null || setSubFilter === void 0 ? void 0 : setSubFilter.filterParams) === null || _d === void 0 ? void 0 : _d.values) {
+                    logger.debug(`MultiFilterModule is not registered; enum column '${colDef.field}' falls back to the enum filter`);
+                    colDef.filter = GridProFilterTypes.enumFilter;
+                    // Carry the whole sub-filter config over, not just `values` — a consumer-authored
+                    // multi filter may also set valueFormatter, blanks, etc.
+                    colDef.filterParams = Object.assign({}, setSubFilter.filterParams);
+                    (_e = colDef.floatingFilterComponent) !== null && _e !== void 0 ? _e : (colDef.floatingFilterComponent = GridProFilterTypes.enumFloatingFilter);
+                }
+                else {
+                    logger.warn('MultiFilterModule is not registered, falling back to text filter');
+                    colDef.filter = 'agTextColumnFilter';
+                }
+                return;
+            }
+            // The multi filter itself is available but its set sub-filter's module is not — opening
+            // the filter would throw AG error #256. The multi filter hosts custom child filters, so
+            // only the nested set filter is swapped for the enum filter (same params, same model).
+            if (!hasSetFilter && setSubFilter) {
+                logger.debug(`SetFilterModule is not registered; the set sub-filter of column '${colDef.field}' falls back to the enum filter`);
+                setSubFilter.filter = GridProFilterTypes.enumFilter;
+            }
+        });
+    }
     /**
      * Handles data clearing from datasource
      * @internal
@@ -729,6 +759,8 @@ export class GridProBeta extends LifecycleMixin(FoundationElement) {
             [GridProRendererTypes.multiselectEditor]: MultiselectEditor,
             [GridProRendererTypes.dateEditor]: DateEditor,
             [GridProRendererTypes.stringEditor]: StringEditor,
+            [GridProFilterTypes.enumFilter]: EnumColumnFilter,
+            [GridProFilterTypes.enumFloatingFilter]: EnumColumnFloatingFilter,
             [GridProStatusBarTypes.labelValue]: LabelValueStatusBarComponent,
             [GridProStatusBarTypes.loadMore]: LoadMoreStatusBarComponent,
             [GridProStatusBarTypes.reload]: ReloadStatusBarComponent,
@@ -1183,7 +1215,7 @@ export class GridProBeta extends LifecycleMixin(FoundationElement) {
             const templateColumnDefs = Array.from(this.querySelectorAll(this.columnComponentName))
                 .map((templateColumn) => templateColumn.definition)
                 .map((columnDef) => {
-                var _a, _b;
+                var _a, _b, _c, _d, _e, _f;
                 // enable cell flashing for each column if unspecified on column level but enabled on grid level
                 if (this.enableCellFlashing && columnDef.enableCellChangeFlash === undefined) {
                     columnDef.enableCellChangeFlash = true;
@@ -1194,14 +1226,21 @@ export class GridProBeta extends LifecycleMixin(FoundationElement) {
                  * respect that choice and don't inject metadata values. This allows consumers to
                  * opt out of metadata values and let AG Grid extract values from row data instead.
                  */
-                if (columnDef.filter === 'agSetColumnFilter') {
+                if (columnDef.filter === 'agSetColumnFilter' ||
+                    columnDef.filter === GridProFilterTypes.enumFilter) {
                     const hasExplicitValues = columnDef.filterParams != null && 'values' in columnDef.filterParams;
                     if (!hasExplicitValues) {
-                        const metadataValues = (_b = (_a = columnDefinitionsFromMetadata.find((colDef) => colDef.field === columnDef.field)) === null || _a === void 0 ? void 0 : _a.filterParams) === null || _b === void 0 ? void 0 : _b.values;
+                        const metadataFilterParams = (_a = columnDefinitionsFromMetadata.find((colDef) => colDef.field === columnDef.field)) === null || _a === void 0 ? void 0 : _a.filterParams;
+                        // Metadata enum values are flat ({ values }) on the server-side datasource path, but
+                        // nested inside a multi-filter's set sub-filter on the client-side datasource path.
+                        const metadataValues = (_b = metadataFilterParams === null || metadataFilterParams === void 0 ? void 0 : metadataFilterParams.values) !== null && _b !== void 0 ? _b : (_e = (_d = (_c = metadataFilterParams === null || metadataFilterParams === void 0 ? void 0 : metadataFilterParams.filters) === null || _c === void 0 ? void 0 : _c.find((subFilter) => subFilter.filter === 'agSetColumnFilter')) === null || _d === void 0 ? void 0 : _d.filterParams) === null || _e === void 0 ? void 0 : _e.values;
                         if (metadataValues) {
                             columnDef.filterParams = Object.assign(Object.assign({}, columnDef.filterParams), { values: metadataValues });
                         }
                     }
+                    if (columnDef.filter === GridProFilterTypes.enumFilter) {
+                        (_f = columnDef.floatingFilterComponent) !== null && _f !== void 0 ? _f : (columnDef.floatingFilterComponent = GridProFilterTypes.enumFloatingFilter);
+                    }
                 }
                 if (columnDef.editable) {
                     if (!columnDef.cellRenderer && !columnDef.cellRendererSelector) {

package/dist/esm/index.js

@@ -2,6 +2,7 @@ export * from './cell';
 export * from './cell-renderers';
 export * from './cell-editors';
 export * from './column';
+export * from './column-filters';
 export * from './datasource';
 export * from './external';
 export * from './grid-components';