@adaptabletools/adaptable 18.0.11 → 18.1.0-canary.0

package/src/parser/src/predicate/mapExpressionToQlPredicate.d.ts

@@ -1,2 +1,3 @@
 import { QlPredicateError, QlPredicate } from './types';
+export declare const isArgumentColumnOrField: (arg: unknown) => boolean;
 export declare function mapExpressionToQlPredicate(expression: string): QlPredicate | QlPredicateError;

package/src/parser/src/predicate/mapExpressionToQlPredicate.js

@@ -2,6 +2,9 @@ import { isBooleanAdaptableQlFunction } from '../../../Utilities/ExpressionFunct
 import { getAST } from '../index';
 import { isAST_Function } from '../types';
 import { isQlLogicalOperator } from './types';
+export const isArgumentColumnOrField = (arg) => {
+    return arg && typeof arg === 'string' && (arg.includes('[') || arg.includes('FIELD'));
+};
 function mapAstToQlPredicate(ast) {
     const operator = getOperatorFromAST(ast);
     if (!isAST_Function(ast)) {
@@ -17,6 +20,11 @@ function mapAstToQlPredicate(ast) {
             if (arg.type === 'COL') {
                 return [`[${arg.args[0]}]`];
             }
+            // special case for FIELD
+            if (arg.type === 'FIELD') {
+                // we are keeping the expression to know we are dealing with a field
+                return `FIELD('${arg.args[0]}')`;
+            }
             if (arg.type === 'DATE') {
                 return `DATE("${arg.args[0]}")`;
             }
@@ -35,9 +43,10 @@ function mapAstToQlPredicate(ast) {
         .filter((arg) => arg !== null && arg !== undefined)
         .flat();
     if (!isQlLogicalOperator(operator)) {
-        if (!args[0] || typeof args[0] !== 'string' || !args[0].includes('[')) {
+        // this throws
+        if (!isArgumentColumnOrField(args[0])) {
             throw {
-                errorMessage: 'First Argument must be an Adaptable Column!',
+                errorMessage: 'First Argument must be an Adaptable Column or Field!',
             };
         }
     }

package/src/parser/src/predicate/mapQlPredicateToExpression.js

@@ -24,6 +24,9 @@ export function mapQlPredicateToExpression(predicate) {
             if (arg.includes('[')) {
                 return arg;
             }
+            if (arg.includes('FIELD')) {
+                return arg;
+            }
             if (arg.includes('DATE')) {
                 return arg;
             }
@@ -32,7 +35,7 @@ export function mapQlPredicateToExpression(predicate) {
             }
             return `"${arg}"`;
         }
-        if (typeof arg === 'object' && 'operator' in arg) {
+        if (arg && typeof arg === 'object' && 'operator' in arg) {
             if (isQlLogicalOperator(arg.operator)) {
                 return `(${mapQlPredicateToExpression(arg)})`;
             }

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

@@ -1,5 +1,5 @@
 import { IRowNode } from '@ag-grid-community/core';
-import { BaseContext } from '../../../types';
+import { AdaptableApi, BaseContext } from '../../../types';
 export type AST = AST_Expression[];
 export type PredicateType = 'VALUE_REF' | 'INFIX' | 'UNARY' | 'FUNCTION' | 'CONDITIONAL';
 /**
@@ -129,3 +129,103 @@ args: any[],
  */
 context: ExpressionContext) => any;
 export declare const isAST_Function: (node: AST_Expression) => node is AST_Function;
+export interface AggregatedScalarExpressionReducerContext extends BaseContext {
+    /**
+     * Current row node
+     */
+    rowNode: IRowNode;
+    /**
+     * Adaptable API
+     */
+    adaptableApi: AdaptableApi;
+    /**
+     * Arguments passed to the function
+     * Column arguments are transformed to their values, e.g. [colId] -> args = [value-of-colId]
+     */
+    args: any[];
+    /**
+     * Column Id of the column being aggregated
+     */
+    aggColumnId: string;
+    /**
+     * Helper function to get the value of a column
+     * @param colId column id
+     * @returns
+     */
+    getValueForColId: (colId: string) => any;
+}
+export interface AggregatedScalarExpressionProcessReducerValueContext extends BaseContext {
+    /**
+     * Arguments passed to the function
+     */
+    args: any[];
+}
+export interface AggregatedScalarExpressionPrepareRowValueContext extends BaseContext {
+    /**
+     * Arguments passed to the function
+     */
+    args: any[];
+    aggColumnId: string;
+    getValueForColId: (colId: string) => any;
+}
+export interface AggregatedScalarExpressionRowFilterContext extends BaseContext {
+    /**
+     * Column Id of the column being aggregated
+     * Usualy the first Col argument, e.g. [colId]
+     */
+    aggColumnId: string;
+    /**
+     * Utility function to get the value of a column
+     * @param colId column id
+     * @returns
+     */
+    getValueForColId: (colId: string) => any;
+}
+export interface AggregatedScalarExpressionFunction {
+    /**
+     * Expression description.
+     */
+    description?: string;
+    /**
+     * Examples how this function ca be used.
+     */
+    signatures?: string[];
+    /**
+     * How the function can be used.
+     */
+    examples?: string[];
+    /**
+     * Initial Value for the aggregation
+     */
+    initialValue: any;
+    /**
+     * Reducer function which is called for each value in the Column Data.
+     * @param accumulator - the 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.
+     * @param currentValue - the current value being processed in the Column Data
+     * @param index - index of the current value in the Column Data
+     * @param context - context object with the current row node, adaptableApi, aggColumnId and other possible custom arguments
+     */
+    reducer: (accumulator: any, currentValue: any, index: number, context: AggregatedScalarExpressionReducerContext) => any;
+    /**
+     * If specified, this function is called after the reducer has processed all values.
+     * Can be used to change the result of the reducer based on the values array (e.g. average).
+     * @param aggregatedValue - result of the reducer
+     * @param dataArray - array of values. If aggregation was grouped, this will be the array of values for the group.
+     * @param context - context object with the args
+     */
+    processReducerValue?: (aggregatedValue: any, dataArray: any[], context: AggregatedScalarExpressionProcessReducerValueContext) => number | string | Date;
+    /**
+     * If specified, this function is be called for each row.
+     * This can be used when each row has a different value (e.g. percentage).
+     * @param rowNode - current row node
+     * @param context - context object with the args, aggColumnId, getValueForColId
+     * @returns return value for each individual row
+     */
+    prepareRowValue?: (rowNode: IRowNode, aggregatedValue: any, context: AggregatedScalarExpressionPrepareRowValueContext) => number | string | Date;
+    /**
+     * If specified, this function filters the rows that are included in the aggregation.
+     * @param rowNode - current row node
+     * @param context - context object with the aggColumnId, getValueForColId
+     */
+    rowFilter?: (rowNode: IRowNode, context: AggregatedScalarExpressionRowFilterContext) => boolean;
+}

package/src/types.d.ts

@@ -1,4 +1,4 @@
-export type { ExpressionFunction, ExpressionFunctionDocBlock, ExpressionFunctionHandler, ExpressionContext, ExpressionFunctionMap, ExpressionCategory, ExpressionFunctionInputType, AST, AST_Function, AST_Expression, Token, } from './../src/parser/src/types';
+export type { ExpressionFunction, ExpressionFunctionDocBlock, ExpressionFunctionHandler, ExpressionContext, ExpressionFunctionMap, ExpressionCategory, ExpressionFunctionInputType, AggregatedScalarExpressionFunction, AggregatedScalarExpressionReducerContext, 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';
@@ -17,7 +17,10 @@ export type { DashboardOptions, CustomToolbar, DashboardButtonContext, CustomToo
 export type { EditOptions, ServerValidationResult, SmartEditCustomOperation, SmartEditOperation, SmartEditOperationContext, ServerValidationContext, CellEditableContext, } from './AdaptableOptions/EditOptions';
 export type { ActionRowOptions, ActionRowButtonOptions, ActionRowFormOptions, ActionRowParamContext, ActionRowParamFieldContext, CreateActionRowFormContext, EditActionRowFormContext, ActionRowFormContext, ActionRowType, ActionRowButtonType, ActionRowButtonConfigurationContext, ActionRowButtonsContext, SetPrimaryKeyValueContext, ActionRowFormColumnContext, } from './AdaptableOptions/ActionRowOptions';
 export type { ActionColumnContext, ActionColumn, ActionColumnSettings, ActionColumnOptions, } from './AdaptableOptions/ActionColumnOptions';
-export type { ExportOptions, SystemExportDestination, SystemExportDestinations, CustomDestination, ExternalReport, PreProcessExportContext, AdaptableReportColumn, DataFormatType, ExportFormContext, ReportContext, ExportableColumnContext, ReportFileNameContext, } from './AdaptableOptions/ExportOptions';
+export type { AdaptableNumberCellEditorParams } from './agGrid/editors/AdaptableNumberEditor';
+export type { AdaptableDateEditorParams } from './agGrid/editors/AdaptableDateEditor';
+export type { AdaptablePercentageCellEditorParams } from './agGrid/editors/AdaptablePercentageEditor';
+export type { ExportOptions, SystemExportDestination, SystemExportDestinations, CustomDestination, ExternalReport, PreProcessExportContext, AdaptableReportColumn, DataFormatType, ExportFormContext, ReportContext, ExportableColumnContext, ReportFileNameContext, DataFormatTypeContext, DataFormatDataType, } from './AdaptableOptions/ExportOptions';
 export type { DataImportValidationError, DataImportOptions, DataImportFileHandler, HandleImportedDataContext, DataImportValidateContext, GetPrimaryKeyValueContext, PreprocessRowDataContext, HandleImportedDataResolution, } from './AdaptableOptions/DataImportOptions';
 export type { DataSetOptions, DataSet, DataSetFormContext, } from './AdaptableOptions/DataSetOptions';
 export type { CellSummaryOptions } from './AdaptableOptions/CellSummaryOptions';
@@ -32,7 +35,7 @@ export type { OpenFinPluginOptions } from './AdaptableOptions/OpenFinPluginOptio
 export type { InteropioPluginOptions } from './AdaptableOptions/InteropioPluginOptions';
 export type { MasterDetailPluginOptions, DetailInitContext, } from './AdaptableOptions/MasterDetailPluginOptions';
 export type { DateInputOptions } from './AdaptableOptions/DateInputOptions';
-export type { ColumnFilterOptions, QuickFilterOptions, FilterFormOptions, ValuesFilterOptions, ColumnFilterContext, } from './AdaptableOptions/ColumnFilterOptions';
+export type { ColumnFilterOptions, QuickFilterOptions, FilterFormOptions, ValuesFilterOptions, ColumnFilterContext, ColumnValuesFilterPredicate, ColumnFilterPredicateContext, } from './AdaptableOptions/ColumnFilterOptions';
 export type { GridFilterOptions, GridFilterEditors, GridFilterEditor, } from './AdaptableOptions/GridFilterOptions';
 export type { QuickSearchOptions, QuickSearchContext } from './AdaptableOptions/QuickSearchOptions';
 export type { FormatColumnOptions, CustomDisplayFormatter, CustomDisplayFormatterContext, } from './AdaptableOptions/FormatColumnOptions';
@@ -50,7 +53,7 @@ export type { ContextMenuOptions, AdaptableSystemContextMenuItem, CustomContextM
 export type { ColumnMenuOptions, CustomColumnMenuContext, CustomColumnMenuItem, UserColumnMenuItem, AdaptableSystemColumnMenuItem, AgGridColumnMenuItemType, } from './AdaptableOptions/ColumnMenuOptions';
 export type { CustomSettingsPanel, SettingsPanelOptions, } from './AdaptableOptions/SettingsPanelOptions';
 export type { EntitlementOptions, EntitlementContext, DefaultAccessLevelContext, } from './AdaptableOptions/EntitlementOptions';
-export type { EvaluateExpressionExternallyContext, ExpressionOptions, ModuleExpressionFunctions, ModuleExpressionFunctionsMap, GlobalExpressionFunctionsContext, ModuleExpressionFunctionsContext, CustomQueryVariableContext, QueryableColumnContext, } from './AdaptableOptions/ExpressionOptions';
+export type { EvaluateExpressionExternallyContext, ExpressionOptions, ModuleExpressionFunctions, ModuleExpressionFunctionsMap, GlobalExpressionFunctionsContext, ModuleExpressionFunctionsContext, CustomQueryVariableContext, QueryableColumnContext, AdaptableFieldContext, } from './AdaptableOptions/ExpressionOptions';
 export type { PredicateOptions, SystemPredicatesContext, } from './AdaptableOptions/PredicateOptions';
 export type { CalendarOptions } from './AdaptableOptions/CalendarOptions';
 export type { DataChangeHistoryOptions, DataChangeHistoryButton, DataChangeHistoryContext, AdaptableDataChangeHistoryAction, } from './AdaptableOptions/DataChangeHistoryOptions';
@@ -65,7 +68,7 @@ export type { CalendarApi } from './Api/CalendarApi';
 export type { CalculatedColumnApi } from './Api/CalculatedColumnApi';
 export type { CellSummaryApi } from './Api/CellSummaryApi';
 export type { ChartingApi } from './Api/ChartingApi';
-export type { ColumnApi } from './Api/ColumnApi';
+export type { ColumnApi, ColumnConfig } from './Api/ColumnApi';
 export type { ColumnFilterApi } from './Api/ColumnFilterApi';
 export type { CommentApi } from './Api/CommentApi';
 export type { ConfigApi } from './Api/ConfigApi';
@@ -149,6 +152,7 @@ export type { FlashingCellDefinition, FlashingCellState, SystemFlashingCellPredi
 export type { AdaptableAlert, AdaptableAlertType, AdaptableGenericAlert, AdaptableCellChangedAlert, AdaptableRowChangedAlert, AdaptableAlertBase, } from './PredefinedConfig/Common/AdaptableAlert';
 export type { AdaptableFlashingCell } from './PredefinedConfig/Common/AdaptableFlashingCell';
 export type { AdaptableColumn, AdaptableColumnBase, AdaptableColumnDataType, AdaptableColumnGroup, } from './PredefinedConfig/Common/AdaptableColumn';
+export type { AdaptableField } from './PredefinedConfig/Common/AdaptableField';
 export type { AdaptableComparerFunction } from './PredefinedConfig/Common/AdaptableComparerFunction';
 export type { SystemStatusMessageInfo } from './PredefinedConfig/Common/SystemStatusMessageInfo';
 export type { AlternativeModuleName } from './PredefinedConfig/Common/AlternativeModuleName';
@@ -206,8 +210,6 @@ export type { SharedEntity, AdaptableSharedEntity, CustomSharedEntity, TeamShari
 export type { AdaptableTheme, ThemeState } from './PredefinedConfig/ThemeState';
 export type { ToolPanelState, AdaptableToolPanelDefinition, ToolPanelVisibilityMode, } from './PredefinedConfig/ToolPanelState';
 export type { AdaptableFrameworkComponent, AngularFrameworkComponent, ReactFrameworkComponent, CustomRenderFunction, CustomRenderContext, CustomWindowConfig, } from './AdaptableOptions/AdaptableFrameworkComponent';
-export type { Fdc3StandardContextType, Fdc3CustomContextType, InstrumentContext, InstrumentListContext, PositionContext, PortfolioContext, ContactContext, ContactListContext, CountryContext, OrganizationContext, Fdc3ContextType, Fdc3Context, ChartContextType, ChartContext, ChatInitSettingsContext, ChatInitSettingsContextType, ContactContextType, ContactListContextType, CurrencyContext, EmailContext, CountryContextType, CurrencyContextType, EmailContextType, InstrumentContextType, InstrumentListContextType, NothingContextType, OrganizationContextType, PortfolioContextType, PositionContextType, NothingContext, Fdc3CustomContext, ValuationContext, ValuationContextType, TimeRangeContextType, TimeRangeContext, } from './PredefinedConfig/Common/Fdc3Context';
-export type { Fdc3IntentType, Fdc3StandardIntentType, Fdc3CustomIntentType, CompatibleContext, } from './PredefinedConfig/Common/Fdc3Intent';
 export type { Fdc3Options, GridDataContextMapping, ActionColumnDefaultConfiguration, ResolveContextDataContext, RaiseIntentConfig, BroadcastConfig, HandleFdc3IntentContext, HandleFdc3Context, Fdc3ButtonContext, Fdc3AdaptableButton, HandleFdc3IntentResolutionContext, UIControlConfig, Fdc3IntentOptions, Fdc3ContextOptions, RaiseIntentConfiguration, BroadcastConfiguration, FDC3ActionColumn, } from './AdaptableOptions/Fdc3Options';
 export type { CommentState, CommentThread, AdaptableComment, } from './PredefinedConfig/CommentState';
 export type { UpgradeConfig } from '../agGrid';