@xh/hoist 80.0.0-SNAPSHOT.1768264663674 → 80.0.0-SNAPSHOT.1768323341476

package/CHANGELOG.md

@@ -20,6 +20,7 @@
 * Added new `AppMenuButton.renderWithUserProfile` prop as a built-in alternative to the default
   hamburger menu. Set to `true` to render the current user's initials instead or provide a function
   to render a custom element for the user.
+* Added `AggregationContext` as an additional argument to `CubeField.canAggregateFn`.
 
 ### ⚙️ Typescript API Adjustments
 

package/build/types/data/cube/CubeField.d.ts

@@ -1,5 +1,5 @@
 import { PlainObject } from '@xh/hoist/core';
-import { Aggregator, AverageAggregator, AverageStrictAggregator, ChildCountAggregator, Field, FieldSpec, LeafCountAggregator, MaxAggregator, MinAggregator, NullAggregator, SingleAggregator, SumAggregator, SumStrictAggregator, UniqueAggregator } from '@xh/hoist/data';
+import { AggregationContext, Aggregator, AverageAggregator, AverageStrictAggregator, ChildCountAggregator, Field, FieldSpec, LeafCountAggregator, MaxAggregator, MinAggregator, NullAggregator, SingleAggregator, SumAggregator, SumStrictAggregator, UniqueAggregator } from '@xh/hoist/data';
 export interface CubeFieldSpec extends FieldSpec {
     /** True to allow this field to be used for grouping.*/
     isDimension?: boolean;
@@ -22,8 +22,9 @@ export type AggregatorToken = 'AVG' | 'AVG_STRICT' | 'CHILD_COUNT' | 'LEAF_COUNT
  * @param dimension - dimension of aggregation
  * @param value - value of record on dimension
  * @param appliedDims - *all* applied dimension values for this record
+ * @param context - current aggregation context
  */
-export type CanAggregateFn = (dimension: string, value: any, appliedDims: PlainObject) => boolean;
+export type CanAggregateFn = (dimension: string, value: any, appliedDims: PlainObject, context: AggregationContext) => boolean;
 /**
  * Metadata used to define a measure or dimension in Cube. For properties present on raw data source
  * objects to be included in a Cube, the Cube must be configured with a matching Field that tells

package/build/types/data/index.d.ts

@@ -10,6 +10,7 @@ export * from './filter/FieldFilter';
 export * from './filter/FunctionFilter';
 export * from './filter/Types';
 export * from './filter/Utils';
+export * from './cube/aggregate/AggregationContext';
 export * from './cube/aggregate/Aggregator';
 export * from './cube/aggregate/AverageAggregator';
 export * from './cube/aggregate/AverageStrictAggregator';

package/data/cube/CubeField.ts

@@ -7,6 +7,7 @@
 
 import {PlainObject} from '@xh/hoist/core';
 import {
+    AggregationContext,
     Aggregator,
     AverageAggregator,
     AverageStrictAggregator,
@@ -63,8 +64,14 @@ export type AggregatorToken =
  * @param dimension - dimension of aggregation
  * @param value - value of record on dimension
  * @param appliedDims - *all* applied dimension values for this record
+ * @param context - current aggregation context
  */
-export type CanAggregateFn = (dimension: string, value: any, appliedDims: PlainObject) => boolean;
+export type CanAggregateFn = (
+    dimension: string,
+    value: any,
+    appliedDims: PlainObject,
+    context: AggregationContext
+) => boolean;
 
 /**
  * Metadata used to define a measure or dimension in Cube. For properties present on raw data source

package/data/cube/row/BaseRow.ts

@@ -152,11 +152,13 @@ export abstract class BaseRow {
                 if (appliedDimensions.hasOwnProperty(name)) {
                     ret[name] = false;
                 } else {
-                    const {aggregator, canAggregateFn} = field;
+                    const {aggregator, canAggregateFn} = field,
+                        ctx = view._aggContext;
+
                     ret[name] =
                         aggregator &&
                         (!canAggregateFn ||
-                            canAggregateFn(dimOrBucketName, val, appliedDimensions));
+                            canAggregateFn(dimOrBucketName, val, appliedDimensions, ctx));
                 }
                 return ret;
             },

package/data/index.ts

@@ -19,6 +19,7 @@ export * from './filter/FunctionFilter';
 export * from './filter/Types';
 export * from './filter/Utils';
 
+export * from './cube/aggregate/AggregationContext';
 export * from './cube/aggregate/Aggregator';
 export * from './cube/aggregate/AverageAggregator';
 export * from './cube/aggregate/AverageStrictAggregator';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xh/hoist",
-  "version": "80.0.0-SNAPSHOT.1768264663674",
+  "version": "80.0.0-SNAPSHOT.1768323341476",
   "description": "Hoist add-on for building and deploying React Applications.",
   "repository": "github:xh/hoist-react",
   "homepage": "https://xh.io",