@adaptabletools/adaptable 18.1.6 → 18.1.8

package/src/parser/src/types.d.ts

@@ -1,5 +1,8 @@
 import { IRowNode } from '@ag-grid-community/core';
 import { BaseContext } from '../../../types';
+/**
+ * An AST Expression
+ */
 export type AST = AST_Expression[];
 export type PredicateType = 'VALUE_REF' | 'INFIX' | 'UNARY' | 'FUNCTION' | 'CONDITIONAL';
 /**
@@ -15,6 +18,9 @@ export type AST_Function = {
     range?: [number, number];
     metaInfo?: PredicateType;
 };
+/**
+ * Token used by the AdapTableQL parser
+ */
 export type Token = {
     type: string;
     value: string;
@@ -129,6 +135,9 @@ args: any[],
  */
 context: ExpressionContext) => any;
 export declare const isAST_Function: (node: AST_Expression) => node is AST_Function;
+/**
+ * Defines an AdapTableQL function that aggregates data
+ */
 export interface AggregatedExpressionFunction {
     /**
      * Description of the Aggregated Expression Function
@@ -154,7 +163,7 @@ export interface AggregatedExpressionFunction {
      * Called AFTER the reducer() has processed all values / rows
      * Can be used to change result of reducer based on the values array (e.g. average = aggregated value / count)
      */
-    processAggregatedValue?: (context: AggregatedExpressionProcessAggregatedValueContext) => any;
+    processAggregatedValue?: (context: AggregatedExpressionProcessAggValueContext) => any;
     /**
      * Called for each row AFTER the reducer() and processAggregatedValue() functions
      * Can be used when each row has a different aggregated value (e.g. percentage = row value / aggregated value).
@@ -164,12 +173,15 @@ export interface AggregatedExpressionFunction {
     /**
      * Optional filter which is applied to each row before the reducer is called. If the filter returns false, the row is NOT included in the aggregation.
      */
-    filterRow?: (context: AggregatedExpressionFilteRowContext) => boolean;
+    filterRow?: (context: AggregatedExpressionFilterRowContext) => boolean;
     /**
      * Optional argument types.
      */
     inputTypes?: ExpressionFunctionInputType[];
 }
+/**
+ * Context used by the reducer property in Aggregated Expressions
+ */
 export interface AggregatedExpressionReducerContext extends BaseContext {
     /**
      * Value returned by the previous call to the reducer function, or the initialValue if this is the first call. You return the new accumulator value from this function.
@@ -205,7 +217,10 @@ export interface AggregatedExpressionReducerContext extends BaseContext {
      */
     getValueForColId: (colId: string) => any;
 }
-export interface AggregatedExpressionProcessAggregatedValueContext extends BaseContext {
+/**
+ * Context used by processAggregatedValue property in Aggregated Expressions
+ */
+export interface AggregatedExpressionProcessAggValueContext extends BaseContext {
     /**
      * Result of the reducer
      */
@@ -227,6 +242,9 @@ export interface AggregatedExpressionProcessAggregatedValueContext extends BaseC
      */
     groupByColumnIds?: string[];
 }
+/**
+ * Context used by prepareRowValue property in Aggregated Expressions
+ */
 export interface AggregatedExpressionPrepareRowValueContext extends BaseContext {
     /**
      * Current Row Node
@@ -254,7 +272,10 @@ export interface AggregatedExpressionPrepareRowValueContext extends BaseContext
      */
     getValueForColId: (colId: string) => any;
 }
-export interface AggregatedExpressionFilteRowContext extends BaseContext {
+/**
+ * Context used when applying a filter to Rows before Reducer is called
+ */
+export interface AggregatedExpressionFilterRowContext extends BaseContext {
     /**
      * Current row node
      */

package/src/types.d.ts

@@ -1,4 +1,4 @@
-export type { ExpressionFunction, ExpressionFunctionDocBlock, ExpressionFunctionHandler, ExpressionContext, ExpressionFunctionMap, ExpressionCategory, ExpressionFunctionInputType, AggregatedExpressionFunction, AggregatedExpressionReducerContext, AggregatedExpressionProcessAggregatedValueContext, AggregatedExpressionPrepareRowValueContext, AggregatedExpressionFilteRowContext, AST, AST_Function, AST_Expression, Token, } from './../src/parser/src/types';
+export type { ExpressionFunction, ExpressionFunctionDocBlock, ExpressionFunctionHandler, ExpressionContext, ExpressionFunctionMap, ExpressionCategory, ExpressionFunctionInputType, AggregatedExpressionFunction, AggregatedExpressionReducerContext, AggregatedExpressionProcessAggValueContext, AggregatedExpressionPrepareRowValueContext, AggregatedExpressionFilterRowContext, AST, AST_Function, AST_Expression, Token, } from './../src/parser/src/types';
 export type { AgGridConfig } from './AdaptableInterfaces/IAdaptable';
 export type { AdaptableConfig } from './View/AdaptableWizardView/AdaptableConfigurationDialog/AdaptableConfig';
 export type { AdaptableNoCodeWizardOptions, IAdaptableNoCodeWizard, } from './AdaptableInterfaces/AdaptableNoCodeWizard';