@contrail/data-grouping 1.0.52 → 1.0.53-alpha.1

package/CHANGELOG.md

@@ -7,6 +7,14 @@ Versioning follows [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
 
+### Added
+
+- `DataGroupingProperty.valueFilter` (`{ mode: 'include' | 'exclude'; values: string[] }`): an optional, caller-supplied rule that restricts a multi-select grouping property's frames to the filter-selected values. Applied in `buildChildDataGroups` via the new `applyGroupingValueFilter` after `getDistinctValues` — pruning the fan-out to the included values (or dropping the excluded ones), while preserving the `(empty)` bucket. No-op for separate-frame mode (`groupMultiSelectInSeparateFrame`) and for non-multi-select grouping. Keeps this package decoupled from `@contrail/filters`: the caller translates its filter criteria into the rule. (VIBE-10759)
+
+### Fixed
+
+- `(empty)` group membership now uses the same emptiness test as the distinct-value pass (extracted as `isEmptyGroupingValue`). The two previously diverged: items whose grouping value was an empty array or a whitespace-only string were dropped entirely (they created the `(empty)` frame but no item matched into it), and `false`/`0` values double-counted into `(empty)` on top of their own group. Only observable with `displayItemsWithEmptyGroupingValues = true`. (VIBE-10759)
+
 ## [1.0.50] - (initial changelog entry)
 
 - Initial changelog. Prior releases did not include a changelog.

package/lib/data-group-generator/data-group-generator.d.ts

@@ -1,6 +1,7 @@
 import { DataGroup, DataGroupStructure, DataGroupingProperty } from '../interfaces';
 import { TypePropertySortOrder } from '@contrail/types';
 export declare class DataGroupGenerator {
+    static isEmptyGroupingValue(value: any): boolean;
     static getDistinctValues(data: any, rootIndex: any, slugIndex?: any, rootAltIndex?: any, slugAltIndex?: any, groupMultiSelectInSeparateFrame?: boolean, sortOptions?: {
         sortOrder: TypePropertySortOrder;
         options: any;
@@ -8,6 +9,7 @@ export declare class DataGroupGenerator {
         isDate: boolean;
         isNumber: boolean;
     }, displayItemsWithEmptyGroupingValues?: boolean, displayOptionFrameWithNoData?: boolean): any[];
+    static applyGroupingValueFilter(distinctValues: Array<any>, groupingProperty: DataGroupingProperty, groupMultiSelectInSeparateFrame: boolean): Array<any>;
     static buildChildDataGroups(data: any, parentGroup: DataGroup, groupingProperties: Array<DataGroupingProperty>, leafNodeDataCount: any, currentDepth: any, groupMultiSelectInSeparateFrame?: boolean, displayItemsWithEmptyGroupingValues?: boolean, displayOptionFrameWithNoData?: boolean): void;
     static buildDataGroupStructure(data: Array<any>, groupingProperties: Array<DataGroupingProperty>, leafNodeDataCount: number, groupMultiSelectInSeparateFrame?: boolean, displayItemsWithEmptyGroupingValues?: boolean, displayOptionFrameWithNoData?: boolean): DataGroupStructure;
     static createPartitionedGroupsFromData(parentGroup: DataGroup, data: Array<any>, leafNodeDataCount: number): Array<DataGroup>;

package/lib/data-group-generator/data-group-generator.js

@@ -4,6 +4,15 @@ exports.DataGroupGenerator = void 0;
 const util_1 = require("@contrail/util");
 const types_1 = require("@contrail/types");
 class DataGroupGenerator {
+    static isEmptyGroupingValue(value) {
+        return ((value === undefined ||
+            value === null ||
+            value === '' ||
+            (Array.isArray(value) && value.length === 0) ||
+            (typeof value === 'string' && value.trim() === '') ||
+            (typeof value === 'number' && isNaN(value))) &&
+            value !== false);
+    }
     static getDistinctValues(data, rootIndex, slugIndex = null, rootAltIndex = null, slugAltIndex = null, groupMultiSelectInSeparateFrame = false, sortOptions = { sortOrder: types_1.TypePropertySortOrder.ASCENDING, options: null }, propertyTypeOptions = { isDate: false, isNumber: false }, displayItemsWithEmptyGroupingValues = false, displayOptionFrameWithNoData = false) {
         const sortOrder = (sortOptions === null || sortOptions === void 0 ? void 0 : sortOptions.sortOrder) || types_1.TypePropertySortOrder.ASCENDING;
         const options = (sortOptions === null || sortOptions === void 0 ? void 0 : sortOptions.options) || null;
@@ -23,13 +32,7 @@ class DataGroupGenerator {
                 }
             }
             let value = key;
-            const isEmptyValue = (value === undefined ||
-                value === null ||
-                value === '' ||
-                (Array.isArray(value) && value.length === 0) ||
-                (typeof value === 'string' && value.trim() === '') ||
-                (typeof value === 'number' && isNaN(value))) &&
-                value !== false;
+            const isEmptyValue = DataGroupGenerator.isEmptyGroupingValue(value);
             if (isEmptyValue) {
                 if (displayItemsWithEmptyGroupingValues) {
                     hasEmptyValues = true;
@@ -111,6 +114,24 @@ class DataGroupGenerator {
         }
         return distinctValues;
     }
+    static applyGroupingValueFilter(distinctValues, groupingProperty, groupMultiSelectInSeparateFrame) {
+        var _a;
+        const rule = groupingProperty === null || groupingProperty === void 0 ? void 0 : groupingProperty.valueFilter;
+        if (!rule ||
+            !rule.values ||
+            rule.values.length === 0 ||
+            groupMultiSelectInSeparateFrame ||
+            ((_a = groupingProperty === null || groupingProperty === void 0 ? void 0 : groupingProperty.propertyDefinition) === null || _a === void 0 ? void 0 : _a.propertyType) !== types_1.PropertyType.MultiSelect) {
+            return distinctValues;
+        }
+        const ruleValues = new Set(rule.values);
+        return distinctValues.filter((value) => {
+            if (value === '(empty)') {
+                return true;
+            }
+            return rule.mode === 'exclude' ? !ruleValues.has(value) : ruleValues.has(value);
+        });
+    }
     static buildChildDataGroups(data, parentGroup, groupingProperties, leafNodeDataCount, currentDepth, groupMultiSelectInSeparateFrame = false, displayItemsWithEmptyGroupingValues = false, displayOptionFrameWithNoData = false) {
         var _a, _b, _c, _d, _e;
         const groupingProperty = groupingProperties[currentDepth];
@@ -128,11 +149,12 @@ class DataGroupGenerator {
         const sort = groupingProperty.sort || types_1.TypePropertySortOrder.ASCENDING;
         const options = ((_e = (_d = groupingProperty.propertyDefinition) === null || _d === void 0 ? void 0 : _d.options) === null || _e === void 0 ? void 0 : _e.map((x) => x.value)) || null;
         let distinctValues = this.getDistinctValues(data, rootIndex, slugIndex, rootAltIndex, slugAltIndex, groupMultiSelectInSeparateFrame, { sortOrder: sort, options }, propertyTypeOptions, displayItemsWithEmptyGroupingValues, displayOptionFrameWithNoData);
+        distinctValues = this.applyGroupingValueFilter(distinctValues, groupingProperty, groupMultiSelectInSeparateFrame);
         for (let val of distinctValues) {
             const groupData = data.filter((obj) => {
                 const objVal = util_1.ObjectUtil.getBySlugs(obj, rootIndex, slugIndex) || util_1.ObjectUtil.getBySlugs(obj, rootAltIndex, slugAltIndex);
                 if (val === '(empty)') {
-                    return !objVal;
+                    return DataGroupGenerator.isEmptyGroupingValue(objVal);
                 }
                 if (propertyTypeOptions.isDate) {
                     const objDate = objVal ? new Date(objVal).toISOString().split('T')[0] : null;

package/lib/interfaces.d.ts

@@ -28,4 +28,8 @@ export interface DataGroupingProperty {
     typeRootSlug: string;
     sort: TypePropertySortOrder;
     isSecondaryGroup?: boolean;
+    valueFilter?: {
+        mode: 'include' | 'exclude';
+        values: Array<string>;
+    };
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contrail/data-grouping",
-  "version": "1.0.52",
+  "version": "1.0.53-alpha.1",
   "description": "Utilities and interfaces for grouping data into hierarchial data structures based on properties.",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",