@contrail/data-grouping 1.0.53-alpha.1 → 1.2.0-alpha.0

package/CHANGELOG.md

@@ -7,6 +7,14 @@ Versioning follows [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
 
+## [1.2.0] - 2026-06-04
+
+### Added
+
+- `buildDataGroupStructure` now accepts an optional trailing `filterDefinition` argument. When a grouping property is multi-select and the same property is filtered, the library derives an include/exclude rule (new `deriveValueFilterRule`) and prunes the fan-out to the filter-selected values — so consumers no longer translate filter criteria into a grouping rule themselves. Backwards-compatible: existing positional calls are unaffected and `DataGroupingProperty.valueFilter` is retained (now also populated internally). Adds an `@contrail/filters` dependency. (VIBE-10759)
+
+## [1.1.0] - 2026-06-03
+
 ### 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)

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

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

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

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.DataGroupGenerator = void 0;
 const util_1 = require("@contrail/util");
 const types_1 = require("@contrail/types");
+const filters_1 = require("@contrail/filters");
 class DataGroupGenerator {
     static isEmptyGroupingValue(value) {
         return ((value === undefined ||
@@ -114,6 +115,27 @@ class DataGroupGenerator {
         }
         return distinctValues;
     }
+    static deriveValueFilterRule(groupingProperty, filterDefinition) {
+        var _a, _b;
+        if (!filterDefinition || ((_a = groupingProperty === null || groupingProperty === void 0 ? void 0 : groupingProperty.propertyDefinition) === null || _a === void 0 ? void 0 : _a.propertyType) !== types_1.PropertyType.MultiSelect) {
+            return null;
+        }
+        const propertyCriteria = ((_b = filterDefinition === null || filterDefinition === void 0 ? void 0 : filterDefinition.filterCriteria) === null || _b === void 0 ? void 0 : _b.propertyCriteria) || [];
+        const expectedSlug = util_1.StringUtil.convertToCamelCase(groupingProperty.typeRootSlug) + '.' + groupingProperty.propertyDefinition.slug;
+        const matching = propertyCriteria.filter((criterion) => { var _a; return ((_a = criterion === null || criterion === void 0 ? void 0 : criterion.filterPropertyDefinition) === null || _a === void 0 ? void 0 : _a.slug) === expectedSlug; });
+        if (matching.length !== 1 || !Array.isArray(matching[0].criteriaValue)) {
+            return null;
+        }
+        const criterion = matching[0];
+        if (criterion.filterConditionType === filters_1.FilterConditionType.IS_ANY_OF ||
+            criterion.filterConditionType === filters_1.FilterConditionType.EQUALS) {
+            return { mode: 'include', values: criterion.criteriaValue };
+        }
+        if (criterion.filterConditionType === filters_1.FilterConditionType.IS_NONE_OF) {
+            return { mode: 'exclude', values: criterion.criteriaValue };
+        }
+        return null;
+    }
     static applyGroupingValueFilter(distinctValues, groupingProperty, groupMultiSelectInSeparateFrame) {
         var _a;
         const rule = groupingProperty === null || groupingProperty === void 0 ? void 0 : groupingProperty.valueFilter;
@@ -132,7 +154,7 @@ class DataGroupGenerator {
             return rule.mode === 'exclude' ? !ruleValues.has(value) : ruleValues.has(value);
         });
     }
-    static buildChildDataGroups(data, parentGroup, groupingProperties, leafNodeDataCount, currentDepth, groupMultiSelectInSeparateFrame = false, displayItemsWithEmptyGroupingValues = false, displayOptionFrameWithNoData = false) {
+    static buildChildDataGroups(data, parentGroup, groupingProperties, leafNodeDataCount, currentDepth, groupMultiSelectInSeparateFrame = false, displayItemsWithEmptyGroupingValues = false, displayOptionFrameWithNoData = false, filterDefinition) {
         var _a, _b, _c, _d, _e;
         const groupingProperty = groupingProperties[currentDepth];
         const isDateProperty = ((_a = groupingProperty === null || groupingProperty === void 0 ? void 0 : groupingProperty.propertyDefinition) === null || _a === void 0 ? void 0 : _a.propertyType) === 'date';
@@ -149,7 +171,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);
+        let effectiveGroupingProperty = groupingProperty;
+        const derivedRule = this.deriveValueFilterRule(groupingProperty, filterDefinition);
+        if (derivedRule) {
+            effectiveGroupingProperty = Object.assign(Object.assign({}, groupingProperty), { valueFilter: derivedRule });
+        }
+        distinctValues = this.applyGroupingValueFilter(distinctValues, effectiveGroupingProperty, 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);
@@ -196,12 +223,12 @@ class DataGroupGenerator {
                 group.subGroups = this.createPartitionedGroupsFromData(group, groupData, leafNodeDataCount);
             }
             else if (currentDepth < groupingProperties.length - 1) {
-                this.buildChildDataGroups(groupData, group, groupingProperties, leafNodeDataCount, currentDepth + 1, groupMultiSelectInSeparateFrame, displayItemsWithEmptyGroupingValues, displayOptionFrameWithNoData);
+                this.buildChildDataGroups(groupData, group, groupingProperties, leafNodeDataCount, currentDepth + 1, groupMultiSelectInSeparateFrame, displayItemsWithEmptyGroupingValues, displayOptionFrameWithNoData, filterDefinition);
             }
             parentGroup.subGroups.push(group);
         }
     }
-    static buildDataGroupStructure(data, groupingProperties, leafNodeDataCount, groupMultiSelectInSeparateFrame = false, displayItemsWithEmptyGroupingValues = false, displayOptionFrameWithNoData = false) {
+    static buildDataGroupStructure(data, groupingProperties, leafNodeDataCount, groupMultiSelectInSeparateFrame = false, displayItemsWithEmptyGroupingValues = false, displayOptionFrameWithNoData = false, filterDefinition) {
         const structure = {
             rootGroup: {
                 subGroups: [],
@@ -212,7 +239,7 @@ class DataGroupGenerator {
             groupingProperties,
             depth: groupingProperties ? groupingProperties.length : 0,
         };
-        this.buildChildDataGroups(data, structure.rootGroup, groupingProperties, leafNodeDataCount, 0, groupMultiSelectInSeparateFrame, displayItemsWithEmptyGroupingValues, displayOptionFrameWithNoData);
+        this.buildChildDataGroups(data, structure.rootGroup, groupingProperties, leafNodeDataCount, 0, groupMultiSelectInSeparateFrame, displayItemsWithEmptyGroupingValues, displayOptionFrameWithNoData, filterDefinition);
         return structure;
     }
     static createPartitionedGroupsFromData(parentGroup, data, leafNodeDataCount) {

package/lib/interfaces.d.ts

@@ -22,14 +22,15 @@ export interface DataGroupStructure {
         sortDefinition?: any;
     };
 }
+export interface GroupingValueFilterRule {
+    mode: 'include' | 'exclude';
+    values: Array<string>;
+}
 export interface DataGroupingProperty {
     propertyDefinition: TypeProperty;
     values?: Array<string>;
     typeRootSlug: string;
     sort: TypePropertySortOrder;
     isSecondaryGroup?: boolean;
-    valueFilter?: {
-        mode: 'include' | 'exclude';
-        values: Array<string>;
-    };
+    valueFilter?: GroupingValueFilterRule;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contrail/data-grouping",
-  "version": "1.0.53-alpha.1",
+  "version": "1.2.0-alpha.0",
   "description": "Utilities and interfaces for grouping data into hierarchial data structures based on properties.",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
@@ -14,7 +14,6 @@
   "author": "",
   "license": "ISC",
   "devDependencies": {
-    "@contrail/util": "^1.3.0",
     "@types/jest": "^29.5.2",
     "jest": "^29.5.0",
     "prettier": "^1.19.1",
@@ -39,6 +38,8 @@
   },
   "dependencies": {
     "@contrail/documents": "^1.5.0",
-    "@contrail/types": "^3.4.0"
+    "@contrail/filters": "^1.3.0",
+    "@contrail/types": "^3.4.0",
+    "@contrail/util": "^1.3.0"
   }
 }