@adaptabletools/adaptable 16.0.0-canary.2 → 16.0.0-canary.4

package/src/Api/Implementation/QuickSearchApiImpl.js

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.QuickSearchApiImpl = void 0;
 const tslib_1 = require("tslib");
 const QuickSearchRedux = tslib_1.__importStar(require("../../Redux/ActionsReducers/QuickSearchRedux"));
+const SystemRedux = tslib_1.__importStar(require("../../Redux/ActionsReducers/SystemRedux"));
 const ModuleConstants = tslib_1.__importStar(require("../../Utilities/Constants/ModuleConstants"));
 const ApiBase_1 = require("./ApiBase");
 class QuickSearchApiImpl extends ApiBase_1.ApiBase {
@@ -27,5 +28,11 @@ class QuickSearchApiImpl extends ApiBase_1.ApiBase {
     openQuickSearchSettingsPanel() {
         this.showModulePopup(ModuleConstants.QuickSearchModuleId);
     }
+    showFloatingQuickSearch() {
+        this.dispatchAction(SystemRedux.SystemQuickSearchFloatingVisibility(true));
+    }
+    hideFloatingQuickSearch() {
+        this.dispatchAction(SystemRedux.SystemQuickSearchFloatingVisibility(false));
+    }
 }
 exports.QuickSearchApiImpl = QuickSearchApiImpl;

package/src/Api/Implementation/ScheduleApiImpl.d.ts

@@ -6,7 +6,11 @@ import { Glue42Schedule } from '../../PredefinedConfig/Glue42State';
 import { IPushPullSchedule } from '../../PredefinedConfig/IPushPullState';
 import { OpenFinSchedule } from '../../PredefinedConfig/OpenFinState';
 import { ReminderSchedule, ScheduleState } from '../../PredefinedConfig/ScheduleState';
+import { IAdaptable } from '../../AdaptableInterfaces/IAdaptable';
+import { ScheduleInternalApi } from '../Internal/ScheduleInternalApi';
 export declare class ScheduleApiImpl extends ApiBase implements ScheduleApi {
+    internalApi: ScheduleInternalApi;
+    constructor(adaptable: IAdaptable);
     getScheduleState(): ScheduleState;
     getSchedules(): BaseSchedule[];
     getReminderSchedules(config?: {

package/src/Api/Implementation/ScheduleApiImpl.js

@@ -5,7 +5,12 @@ const tslib_1 = require("tslib");
 const ApiBase_1 = require("./ApiBase");
 const ModuleConstants = tslib_1.__importStar(require("../../Utilities/Constants/ModuleConstants"));
 const ScheduleRedux = tslib_1.__importStar(require("../../Redux/ActionsReducers/ScheduleRedux"));
+const ScheduleInternalApi_1 = require("../Internal/ScheduleInternalApi");
 class ScheduleApiImpl extends ApiBase_1.ApiBase {
+    constructor(adaptable) {
+        super(adaptable);
+        this.internalApi = new ScheduleInternalApi_1.ScheduleInternalApi(adaptable);
+    }
     getScheduleState() {
         return this.getAdaptableState().Schedule;
     }

package/src/Api/Implementation/StyledColumnApiImpl.d.ts

@@ -17,10 +17,7 @@ export declare class StyledColumnApiImpl extends ApiBase implements StyledColumn
     getSuspendedStyledColumns(): StyledColumn[];
     deleteStyledColumn(styledColumn: StyledColumn): void;
     addStyledColumn(styledColumn: StyledColumn): void;
-    getCheckBoxStyleStyledColumn(column: AdaptableColumn): StyledColumn | undefined;
     isSparklineStyleStyledColumn(column: AdaptableColumn): boolean;
-    isCheckBoxStyleStyledColumn(column: AdaptableColumn): boolean;
-    fireCheckboxColumnClickedEvent(columnId: string, rowData: any, primaryKeyValue: any, isChecked: boolean): void;
     getActiveStyledColumnForColumn(column: AdaptableColumn): StyledColumn | undefined;
     hasPercentBarStyle(columnId: string): boolean;
     hasGradientStyle(columnId: string): boolean;

package/src/Api/Implementation/StyledColumnApiImpl.js

@@ -4,7 +4,6 @@ exports.StyledColumnApiImpl = void 0;
 const tslib_1 = require("tslib");
 const ApiBase_1 = require("./ApiBase");
 const StyledColumnRedux = tslib_1.__importStar(require("../../Redux/ActionsReducers/StyledColumnRedux"));
-const Helper_1 = tslib_1.__importDefault(require("../../Utilities/Helpers/Helper"));
 const StyledColumnInternalApi_1 = require("../Internal/StyledColumnInternalApi");
 const ModuleConstants = tslib_1.__importStar(require("../../Utilities/Constants/ModuleConstants"));
 class StyledColumnApiImpl extends ApiBase_1.ApiBase {
@@ -37,37 +36,12 @@ class StyledColumnApiImpl extends ApiBase_1.ApiBase {
     addStyledColumn(styledColumn) {
         this.dispatchAction(StyledColumnRedux.StyledColumnAdd(styledColumn));
     }
-    getCheckBoxStyleStyledColumn(column) {
-        var _a;
-        if (column.dataType != 'Boolean') {
-            return undefined;
-        }
-        const checkBoxFormatColumns = (_a = this.getStyledColumnState().StyledColumns) === null || _a === void 0 ? void 0 : _a.filter((sc) => sc === null || sc === void 0 ? void 0 : sc.CheckBoxStyle);
-        const styledColumn = checkBoxFormatColumns.find((sc) => sc.ColumnId == column.columnId);
-        return styledColumn;
-    }
     isSparklineStyleStyledColumn(column) {
         if (!column) {
             return false;
         }
         return !!this.getStyledColumns().find((styledColumn) => !!styledColumn.SparkLineStyle && styledColumn.ColumnId === column.columnId);
     }
-    isCheckBoxStyleStyledColumn(column) {
-        const styledColumn = this.getCheckBoxStyleStyledColumn(column);
-        return Helper_1.default.objectExists(styledColumn);
-    }
-    fireCheckboxColumnClickedEvent(columnId, rowData, primaryKeyValue, isChecked) {
-        let checkboxColumnClickedInfo = {
-            adaptableApi: this.adaptable.api,
-            column: this.adaptable.api.columnApi.getColumnWithColumnId(columnId),
-            rowData: rowData,
-            primaryKeyValue: primaryKeyValue,
-            isChecked: isChecked,
-            userName: this.adaptable.api.optionsApi.getUserName(),
-            adaptableId: this.adaptable.api.optionsApi.getAdaptableId(),
-        };
-        this.adaptable.api.eventApi.emit('CheckboxColumnClicked', checkboxColumnClickedInfo);
-    }
     getActiveStyledColumnForColumn(column) {
         const styledColumns = this.getActiveStyledColumns();
         return styledColumns.find((sc) => sc.ColumnId == column.columnId);

package/src/Api/Implementation/UserInterfaceApiImpl.d.ts

@@ -5,7 +5,11 @@ import { AdaptableStyle } from '../../PredefinedConfig/Common/AdaptableStyle';
 import { ColumnMenuContext, ContextMenuContext, UserMenuItem } from '../../PredefinedConfig/Common/Menu';
 import { BulkUpdatePermittedValues, CustomSortPermittedValues, EditLookUpPermittedValues, FilterPermittedValues, PermittedValues } from '../../AdaptableOptions/UserInterfaceOptions';
 import { AdaptableObjectTag, GridCell } from '../../types';
+import { UserInterfaceInternalApi } from '../Internal/UserInterfaceInternalApi';
+import { IAdaptable } from '../../AdaptableInterfaces/IAdaptable';
 export declare class UserInterfaceApiImpl extends ApiBase implements UserInterfaceApi {
+    internalApi: UserInterfaceInternalApi;
+    constructor(adaptable: IAdaptable);
     getColorPalette(): string[];
     getStyleClassNames(): string[] | undefined;
     getPermittedValuesItems(): PermittedValues[];
@@ -25,8 +29,5 @@ export declare class UserInterfaceApiImpl extends ApiBase implements UserInterfa
     getEditableCellStyle(): AdaptableStyle | undefined;
     getReadOnlyCellStyle(): AdaptableStyle | undefined;
     getAdaptableObjectTags(): AdaptableObjectTag[] | undefined;
-    getCustomIconDefinition(iconName: string): import("../../types").AdaptableIcon | {
-        name: string;
-        icon: import("../../types").AdaptableIcon;
-    };
+    getCustomIconDefinition(iconName: string): import("../../types").AdaptableIcon | import("../../types").CustomIcon;
 }

package/src/Api/Implementation/UserInterfaceApiImpl.js

@@ -3,7 +3,12 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.UserInterfaceApiImpl = void 0;
 const ApiBase_1 = require("./ApiBase");
 const ArrayExtensions_1 = require("../../Utilities/Extensions/ArrayExtensions");
+const UserInterfaceInternalApi_1 = require("../Internal/UserInterfaceInternalApi");
 class UserInterfaceApiImpl extends ApiBase_1.ApiBase {
+    constructor(adaptable) {
+        super(adaptable);
+        this.internalApi = new UserInterfaceInternalApi_1.UserInterfaceInternalApi(adaptable);
+    }
     getColorPalette() {
         let colorPalette = this.getUserInterfaceOptions().colorPalette;
         // first do the function then get hardcoded items

package/src/Api/Internal/AdaptableInternalApi.d.ts

@@ -3,7 +3,6 @@ import { UIConfirmation } from '../../Utilities/Interface/MessagePopups';
 import { SystemState } from '../../PredefinedConfig/SystemState';
 import { Action } from 'redux';
 import { ModuleParams } from '../../View/Components/SharedProps/ModuleViewPopupProps';
-import { AdaptableColumn } from '../../PredefinedConfig/Common/AdaptableColumn';
 import { AdaptableMenuItem } from '../../PredefinedConfig/Common/Menu';
 import { AdaptableModule } from '../../PredefinedConfig/Common/Types';
 import { CellDataChangedInfo } from '../../PredefinedConfig/Common/CellDataChangedInfo';
@@ -26,6 +25,7 @@ import { IMetamodelService } from '../../Utilities/Services/Interface/IMetamodel
 import { IModuleCollection } from '../../Strategy/Interface/IModule';
 import { AdaptableObjectTag, AdaptableObjectWithScope } from '../../PredefinedConfig/Common/AdaptableObject';
 import { IRowEditService } from '../../Utilities/Services/Interface/IRowEditService';
+import { Fdc3Service } from '../../Utilities/Services/Fdc3Service';
 export declare class AdaptableInternalApi extends ApiBase {
     getSystemState(): SystemState;
     showPopupConfirmation(confirmation: UIConfirmation): void;
@@ -66,6 +66,7 @@ export declare class AdaptableInternalApi extends ApiBase {
     getTeamSharingService(): ITeamSharingService;
     getMetamodelService(): IMetamodelService;
     getRowEditService(): IRowEditService;
+    getFdc3Service(): Fdc3Service;
     getModules(): IModuleCollection;
     getModuleFriendlyName(adaptableModule: AdaptableModule): string;
     forAllRowNodesDo(func: (rowNode: IRowNode) => void, config?: {
@@ -106,7 +107,8 @@ export declare class AdaptableInternalApi extends ApiBase {
     getPreviousGroupedColumnsIndex(layoutId: string): {
         [key: string]: number;
     };
-    getValueUsingField(rowData: Record<string, any>, column: AdaptableColumn): any;
-    setValueUsingField(rowData: Record<string, any>, column: AdaptableColumn, newValue: any): Record<string, any>;
+    getValueUsingField(rowData: Record<string, any>, columnValueKey: string): any;
+    setValueUsingField(rowData: Record<string, any>, columnValueKey: string, newValue: any): Record<string, any>;
     findAdaptableObjectsByLookupCriteria<T extends AdaptableObjectWithScope>({ scope, tag, ids }: AdaptableObjectLookupCriteria, specificAdaptableObjects: T[]): T[];
+    buildBaseContext(): BaseContext;
 }

package/src/Api/Internal/AdaptableInternalApi.js

@@ -11,7 +11,7 @@ const ApiBase_1 = require("../Implementation/ApiBase");
 const StringExtensions_1 = tslib_1.__importDefault(require("../../Utilities/Extensions/StringExtensions"));
 const GeneralConstants_1 = require("../../Utilities/Constants/GeneralConstants");
 const waitForCondition_1 = require("../../Utilities/waitForCondition");
-const AdaptableIconComponent_1 = require("../../components/AdaptableIconComponent");
+const Icon_1 = require("../../components/Icon");
 class AdaptableInternalApi extends ApiBase_1.ApiBase {
     getSystemState() {
         return this.getAdaptableState().System;
@@ -121,6 +121,9 @@ class AdaptableInternalApi extends ApiBase_1.ApiBase {
     getRowEditService() {
         return this.adaptable.RowEditService;
     }
+    getFdc3Service() {
+        return this.adaptable.Fdc3Service;
+    }
     getModules() {
         return this.adaptable.adaptableModules;
     }
@@ -182,7 +185,7 @@ class AdaptableInternalApi extends ApiBase_1.ApiBase {
         if (!buttonIcon) {
             return;
         }
-        if ((0, AdaptableIconComponent_1.isAdaptableInternalIcon)(buttonIcon) || (0, AdaptableIconComponent_1.isAdaptableExternalIcon)(buttonIcon)) {
+        if ((0, Icon_1.isAdaptableSystemIcon)(buttonIcon) || (0, Icon_1.isAdaptableCustomIcon)(buttonIcon)) {
             const defaultIconWidth = (_a = defaultWidthHeight === null || defaultWidthHeight === void 0 ? void 0 : defaultWidthHeight.width) !== null && _a !== void 0 ? _a : 'var(--ab-cmp-simple-button__width)';
             const defaultIconHeight = (_b = defaultWidthHeight === null || defaultWidthHeight === void 0 ? void 0 : defaultWidthHeight.height) !== null && _b !== void 0 ? _b : 'var(--ab-cmp-simple-button__height)';
             const buttonIconStyle = Object.assign({}, { width: defaultIconWidth, height: defaultIconHeight }, buttonIcon.style);
@@ -370,15 +373,13 @@ class AdaptableInternalApi extends ApiBase_1.ApiBase {
         return (_a = SystemRedux.SystemPreviousGroupedColumnsSelector(this.getAdaptableState().System)) === null || _a === void 0 ? void 0 : _a[layoutId];
     }
     // "borrowed" from https://github.com/ag-grid/ag-grid/blob/v28.2.1/community-modules/core/src/ts/utils/object.ts#L205
-    getValueUsingField(rowData, column) {
-        var _a;
-        if (!rowData || !column) {
+    getValueUsingField(rowData, columnValueKey) {
+        if (!rowData || !(columnValueKey === null || columnValueKey === void 0 ? void 0 : columnValueKey.length)) {
             return;
         }
-        const columnValueKey = (_a = column.field) !== null && _a !== void 0 ? _a : column.columnId;
-        const isColumnValueKeyContainsDots = columnValueKey === null || columnValueKey === void 0 ? void 0 : columnValueKey.includes('.');
+        const isColumnValueKeyNested = columnValueKey === null || columnValueKey === void 0 ? void 0 : columnValueKey.includes('.');
         // if no '.', then it's not a deep value
-        if (!isColumnValueKeyContainsDots) {
+        if (!isColumnValueKeyNested) {
             return rowData[columnValueKey];
         }
         // otherwise it is a deep value, so need to dig for it
@@ -393,12 +394,10 @@ class AdaptableInternalApi extends ApiBase_1.ApiBase {
         return currentObject;
     }
     // "borrowed" from https://github.com/ag-grid/ag-grid/blob/v28.2.1/community-modules/core/src/ts/valueService/valueService.ts#L236
-    setValueUsingField(rowData, column, newValue) {
-        var _a;
-        if (!rowData || !column) {
+    setValueUsingField(rowData, columnValueKey, newValue) {
+        if (!rowData || !(columnValueKey === null || columnValueKey === void 0 ? void 0 : columnValueKey.length)) {
             return;
         }
-        const columnValueKey = (_a = column.field) !== null && _a !== void 0 ? _a : column.columnId;
         const isColumnValueKeyContainsDots = columnValueKey === null || columnValueKey === void 0 ? void 0 : columnValueKey.includes('.');
         let valuesAreSame = false;
         if (!isColumnValueKeyContainsDots) {
@@ -447,5 +446,12 @@ class AdaptableInternalApi extends ApiBase_1.ApiBase {
         }
         return locatedAdaptableObjects;
     }
+    buildBaseContext() {
+        return {
+            adaptableApi: this.getAdaptableApi(),
+            adaptableId: this.getAdaptableApi().optionsApi.getAdaptableId(),
+            userName: this.getAdaptableApi().optionsApi.getUserName(),
+        };
+    }
 }
 exports.AdaptableInternalApi = AdaptableInternalApi;

package/src/Api/Internal/AlertInternalApi.js

@@ -474,14 +474,19 @@ class AlertInternalApi extends ApiBase_1.ApiBase {
     }
     isAlertPredicateTriggered(alert, dataChangedEvent, defaultNoPredicateReturn = false) {
         var _a;
-        return this.getAdaptableApi().predicateApi.handleColumnPredicates((_a = alert.Rule) === null || _a === void 0 ? void 0 : _a.Predicates, {
+        const adapatableApi = this.getAdaptableApi();
+        const predicateDefHandlerContext = {
             value: dataChangedEvent.newValue,
             oldValue: dataChangedEvent.oldValue,
             // TODO send real display value
             displayValue: null,
             node: dataChangedEvent.rowNode,
             column: dataChangedEvent.column,
-        }, defaultNoPredicateReturn);
+            adaptableApi: adapatableApi,
+            userName: adapatableApi.optionsApi.getUserName(),
+            adaptableId: adapatableApi.optionsApi.getAdaptableId(),
+        };
+        return this.getAdaptableApi().predicateApi.handleColumnPredicates((_a = alert.Rule) === null || _a === void 0 ? void 0 : _a.Predicates, predicateDefHandlerContext, defaultNoPredicateReturn);
     }
     isAlertDefinitionForRowChangeEvent(alertDefinition) {
         return (this.isAlertDefinitionForAddedRowChangeEvent(alertDefinition) ||

package/src/Api/Internal/Fdc3InternalApi.d.ts

@@ -0,0 +1,11 @@
+import { ApiBase } from '../Implementation/ApiBase';
+import { Fdc3Context, Fdc3ContextType } from '../../PredefinedConfig/Common/Fdc3Context';
+import { IRowNode } from '@ag-grid-community/core';
+export declare class Fdc3InternalApi extends ApiBase {
+    mapRowToContextData(contextType: Fdc3ContextType, rowNode: IRowNode): Fdc3Context;
+    /**
+     * Computes the context based on the given `Fdc3Options.gridDataContextMapping` and the given `IRowNode`.
+     */
+    getMappedContextData(contextType: Fdc3ContextType, rowNode: IRowNode): Fdc3Context;
+    private mapRowValueToContextData;
+}

package/src/Api/Internal/Fdc3InternalApi.js

@@ -0,0 +1,72 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Fdc3InternalApi = void 0;
+const ApiBase_1 = require("../Implementation/ApiBase");
+const fdc3_1 = require("@finos/fdc3");
+const Fdc3Options_1 = require("../../AdaptableOptions/Fdc3Options");
+class Fdc3InternalApi extends ApiBase_1.ApiBase {
+    mapRowToContextData(contextType, rowNode) {
+        const contextMappedFromGridData = this.getMappedContextData(contextType, rowNode);
+        const resolveContextDataFn = this.getFdc3Options().resolveContextData;
+        if (typeof resolveContextDataFn === 'function') {
+            return resolveContextDataFn(Object.assign(Object.assign({}, this.getAdaptableApi().internalApi.buildBaseContext()), { contextType,
+                contextMappedFromGridData,
+                rowNode, rowData: rowNode.data }));
+        }
+        else {
+            return contextMappedFromGridData;
+        }
+    }
+    /**
+     * Computes the context based on the given `Fdc3Options.gridDataContextMapping` and the given `IRowNode`.
+     */
+    getMappedContextData(contextType, rowNode) {
+        var _a;
+        if (contextType === fdc3_1.ContextTypes.Nothing) {
+            return { type: fdc3_1.ContextTypes.Nothing };
+        }
+        const contextMapping = (_a = this.getFdc3Options().gridDataContextMapping) === null || _a === void 0 ? void 0 : _a[contextType];
+        if (!contextMapping) {
+            return { type: contextType };
+        }
+        const mappedData = this.mapRowValueToContextData(rowNode, contextMapping);
+        return Object.assign({ type: contextType }, mappedData);
+    }
+    mapRowValueToContextData(rowNode, contextMapping = {}) {
+        // recursively map the row node values to the context data
+        const mapContext = (obj) => {
+            return Object.keys(obj).reduce((mappedData, contextKey) => {
+                const valueReference = obj[contextKey];
+                if (Array.isArray(valueReference)) {
+                    mappedData[contextKey] = valueReference.map((item) => mapContext(item));
+                }
+                else if (typeof valueReference === 'object') {
+                    mappedData[contextKey] = mapContext(valueReference);
+                }
+                else {
+                    // map value from row node
+                    // first validate refs
+                    if (typeof valueReference !== 'string' ||
+                        (!valueReference.startsWith(Fdc3Options_1.ColumnRefTypePrefix) &&
+                            !valueReference.startsWith(Fdc3Options_1.FieldRefTypePrefix))) {
+                        this.logError(`Invalid FDC3 value reference for '${contextKey}': ${valueReference}`);
+                        return mappedData;
+                    }
+                    // '_coldId.columnId'
+                    if (valueReference.startsWith(Fdc3Options_1.ColumnRefTypePrefix)) {
+                        const columnId = valueReference.replace(Fdc3Options_1.ColumnRefTypePrefix, '');
+                        mappedData[contextKey] = this.getGridApi().getRawValueFromRowNode(rowNode, columnId);
+                    }
+                    // '_field.fieldName'
+                    if (valueReference.startsWith(Fdc3Options_1.FieldRefTypePrefix)) {
+                        const fieldId = valueReference.replace(Fdc3Options_1.FieldRefTypePrefix, '');
+                        mappedData[contextKey] = this.getAdaptableApi().internalApi.getValueUsingField(rowNode.data, fieldId);
+                    }
+                }
+                return mappedData;
+            }, {});
+        };
+        return mapContext(contextMapping);
+    }
+}
+exports.Fdc3InternalApi = Fdc3InternalApi;

package/src/Api/Internal/FilterInternalApi.js

@@ -94,22 +94,26 @@ class FilterInternalApi extends ApiBase_1.ApiBase {
         if (someInputsAreEmpty) {
             return true;
         }
-        const column = this.adaptable.api.columnApi.getColumnWithColumnId(columnFilter.ColumnId);
+        const column = this.getAdaptableApi().columnApi.getColumnWithColumnId(columnFilter.ColumnId);
         if (!column) {
             return true;
         }
-        const gridCell = this.adaptable.api.gridApi.getGridCellFromRowNode(node, columnFilter.ColumnId);
+        const gridCell = this.getAdaptableApi().gridApi.getGridCellFromRowNode(node, columnFilter.ColumnId);
         if (!gridCell) {
             return true;
         }
         let value = gridCell.normalisedValue;
-        return this.adaptable.api.predicateApi.handlePredicate(columnFilter.Predicate, {
+        const predicateDefHandlerContext = {
             value: value,
             oldValue: null,
             displayValue: gridCell.displayValue,
             node,
             column,
-        }, true);
+            adaptableApi: this.getAdaptableApi(),
+            userName: this.getAdaptableApi().optionsApi.getUserName(),
+            adaptableId: this.getAdaptableApi().optionsApi.getAdaptableId(),
+        };
+        return this.adaptable.api.predicateApi.handlePredicate(columnFilter.Predicate, predicateDefHandlerContext, true);
     }
     /**
      * Checks if the filter action should trigger grid filtering.

package/src/Api/Internal/FormatColumnInternalApi.js

@@ -171,12 +171,17 @@ class FormatColumnInternalApi extends ApiBase_1.ApiBase {
         }
         // first run the predicate
         if (formatColumn.Rule.Predicates && ((_b = (_a = formatColumn.Rule) === null || _a === void 0 ? void 0 : _a.Predicates) === null || _b === void 0 ? void 0 : _b.length)) {
-            return this.evaluatePredicate({
-                formatColumn,
-                column,
+            const predicateDefHandlerContext = {
                 value: params.value,
+                oldValue: null,
+                displayValue: params.value,
                 node: params.node,
-            });
+                column: column,
+                adaptableApi: this.getAdaptableApi(),
+                userName: this.getAdaptableApi().optionsApi.getUserName(),
+                adaptableId: this.getAdaptableApi().optionsApi.getAdaptableId(),
+            };
+            return this.evaluatePredicate(formatColumn, predicateDefHandlerContext);
         }
         else if (formatColumn.Rule.BooleanExpression) {
             return this.evaluateExpression(formatColumn, params.node);
@@ -184,16 +189,9 @@ class FormatColumnInternalApi extends ApiBase_1.ApiBase {
         // nothing has passed then return false
         return false;
     }
-    evaluatePredicate({ formatColumn, column, value, node, }) {
+    evaluatePredicate(formatColumn, predicateDefHandlerContext) {
         var _a;
-        const params = {
-            value: value,
-            oldValue: null,
-            displayValue: value,
-            node: node,
-            column: column,
-        };
-        return this.adaptable.api.predicateApi.handleColumnPredicates((_a = formatColumn.Rule) === null || _a === void 0 ? void 0 : _a.Predicates, params, false);
+        return this.adaptable.api.predicateApi.handleColumnPredicates((_a = formatColumn.Rule) === null || _a === void 0 ? void 0 : _a.Predicates, predicateDefHandlerContext, false);
     }
     evaluateExpression(formatColumn, node) {
         const isValidExpression = this.adaptable.api.expressionApi.isValidBooleanExpression(formatColumn.Rule.BooleanExpression, ModuleConstants.FormatColumnModuleId, `Invalid format column rule '${formatColumn.Rule.BooleanExpression}'`);

package/src/Api/Internal/ScheduleInternalApi.d.ts

@@ -0,0 +1,8 @@
+import { ApiBase } from '../Implementation/ApiBase';
+import { BaseSchedule } from '../../PredefinedConfig/Common/Schedule';
+export declare class ScheduleInternalApi extends ApiBase {
+    /**
+     * Fires Schedule Triggered event
+     */
+    fireScheduleTriggeredEvent(schedule: BaseSchedule): void;
+}

package/src/Api/Internal/ScheduleInternalApi.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ScheduleInternalApi = void 0;
+const ApiBase_1 = require("../Implementation/ApiBase");
+class ScheduleInternalApi extends ApiBase_1.ApiBase {
+    /**
+     * Fires Schedule Triggered event
+     */
+    fireScheduleTriggeredEvent(schedule) {
+        const adaptableApi = this.getAdaptableApi();
+        const scheduleTriggeredInfo = {
+            adaptableApi: adaptableApi,
+            userName: adaptableApi.optionsApi.getUserName(),
+            adaptableId: adaptableApi.optionsApi.getAdaptableId(),
+            schedule: schedule,
+        };
+        adaptableApi.eventApi.emit('ScheduleTriggered', scheduleTriggeredInfo);
+    }
+}
+exports.ScheduleInternalApi = ScheduleInternalApi;

package/src/Api/Internal/StyledColumnInternalApi.d.ts

@@ -2,7 +2,7 @@ import { ApiBase } from '../Implementation/ApiBase';
 import { AdaptableColumn } from '../../PredefinedConfig/Common/AdaptableColumn';
 import { BadgeStyleDefinition, CellColorRange, ColumnComparison, NumericStyledColumn, StyledColumn } from '../../PredefinedConfig/StyledColumnState';
 import { IRowNode } from '@ag-grid-community/core';
-import { PredicateDefHandlerParams } from '../../types';
+import { PredicateDefHandlerContext } from '../../types';
 export declare class StyledColumnInternalApi extends ApiBase {
     getMinValueForNumericColumn(column: AdaptableColumn): number | undefined;
     getMaxValueForNumericColumn(column: AdaptableColumn): number | undefined;
@@ -57,6 +57,9 @@ export declare class StyledColumnInternalApi extends ApiBase {
      * @param styledColumn Styled Column to Add
      */
     hasStyledColumnRelativeCellRange(styledColumn: StyledColumn): boolean;
-    getApplicableBadge(styledColumn: StyledColumn, params: Omit<PredicateDefHandlerParams, 'api' | 'inputs'>): BadgeStyleDefinition | null;
+    getApplicableBadge(styledColumn: StyledColumn, context: PredicateDefHandlerContext): BadgeStyleDefinition | null;
     getBadgePredicateDefsForColumn(columnId: string): import("../../types").AdaptablePredicateDef[];
+    getCheckBoxStyleStyledColumn(column: AdaptableColumn): StyledColumn | undefined;
+    isCheckBoxStyleStyledColumn(column: AdaptableColumn): boolean;
+    fireCheckboxColumnClickedEvent(columnId: string, rowData: any, primaryKeyValue: any, isChecked: boolean): void;
 }

package/src/Api/Internal/StyledColumnInternalApi.js

@@ -4,6 +4,7 @@ exports.StyledColumnInternalApi = void 0;
 const tslib_1 = require("tslib");
 const ApiBase_1 = require("../Implementation/ApiBase");
 const ArrayExtensions_1 = tslib_1.__importDefault(require("../../Utilities/Extensions/ArrayExtensions"));
+const Helper_1 = tslib_1.__importDefault(require("../../Utilities/Helpers/Helper"));
 class StyledColumnInternalApi extends ApiBase_1.ApiBase {
     getMinValueForNumericColumn(column) {
         if (column.dataType !== 'Number') {
@@ -245,7 +246,7 @@ class StyledColumnInternalApi extends ApiBase_1.ApiBase {
                 return cellColorRange.Min == 'Col-Min' || cellColorRange.Max == 'Col-Max';
             })))) !== null && _e !== void 0 ? _e : false);
     }
-    getApplicableBadge(styledColumn, params) {
+    getApplicableBadge(styledColumn, context) {
         var _a, _b;
         if (!((_a = styledColumn.BadgeStyle) === null || _a === void 0 ? void 0 : _a.Badges.length)) {
             return null;
@@ -262,7 +263,7 @@ class StyledColumnInternalApi extends ApiBase_1.ApiBase {
             }
         }
         for (let badge of badgesWithoutAll) {
-            if (this.getPredicateApi().handlePredicate(badge.Predicate, params, false)) {
+            if (this.getPredicateApi().handlePredicate(badge.Predicate, context, false)) {
                 return badge;
             }
         }
@@ -281,5 +282,31 @@ class StyledColumnInternalApi extends ApiBase_1.ApiBase {
             .predicateApi.internalApi.getBadgeStylePredicateDefs(scope)
             .filter((predicate) => this.adaptable.api.scopeApi.isColumnInScope(column, predicate.columnScope));
     }
+    // Deprecated Checkbox Column functions
+    getCheckBoxStyleStyledColumn(column) {
+        var _a;
+        if (column.dataType != 'Boolean') {
+            return undefined;
+        }
+        const checkBoxFormatColumns = (_a = this.getAdaptableApi().styledColumnApi.getStyledColumnState().StyledColumns) === null || _a === void 0 ? void 0 : _a.filter((sc) => sc === null || sc === void 0 ? void 0 : sc.CheckBoxStyle);
+        const styledColumn = checkBoxFormatColumns.find((sc) => sc.ColumnId == column.columnId);
+        return styledColumn;
+    }
+    isCheckBoxStyleStyledColumn(column) {
+        const styledColumn = this.getCheckBoxStyleStyledColumn(column);
+        return Helper_1.default.objectExists(styledColumn);
+    }
+    fireCheckboxColumnClickedEvent(columnId, rowData, primaryKeyValue, isChecked) {
+        let checkboxColumnClickedInfo = {
+            adaptableApi: this.adaptable.api,
+            column: this.adaptable.api.columnApi.getColumnWithColumnId(columnId),
+            rowData: rowData,
+            primaryKeyValue: primaryKeyValue,
+            isChecked: isChecked,
+            userName: this.adaptable.api.optionsApi.getUserName(),
+            adaptableId: this.adaptable.api.optionsApi.getAdaptableId(),
+        };
+        this.adaptable.api.eventApi.emit('CheckboxColumnClicked', checkboxColumnClickedInfo);
+    }
 }
 exports.StyledColumnInternalApi = StyledColumnInternalApi;

package/src/Api/Internal/UserInterfaceInternalApi.d.ts

@@ -0,0 +1,5 @@
+import { AdaptableIcon } from '../../types';
+import { ApiBase } from '../Implementation/ApiBase';
+export declare class UserInterfaceInternalApi extends ApiBase {
+    prepareAdaptableIconDef(icon: AdaptableIcon): AdaptableIcon;
+}

package/src/Api/Internal/UserInterfaceInternalApi.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UserInterfaceInternalApi = void 0;
+const ApiBase_1 = require("../Implementation/ApiBase");
+class UserInterfaceInternalApi extends ApiBase_1.ApiBase {
+    prepareAdaptableIconDef(icon) {
+        if (icon && 'name' in icon) {
+            let customIcon = icon && 'name' in icon
+                ? this.adaptable.api.userInterfaceApi.getCustomIconDefinition(icon.name)
+                : null;
+            if (customIcon) {
+                icon = customIcon;
+            }
+        }
+        return icon;
+    }
+}
+exports.UserInterfaceInternalApi = UserInterfaceInternalApi;

package/src/Api/OptionsApi.d.ts

@@ -2,6 +2,7 @@ import { CustomSortOptions } from '../AdaptableOptions/CustomSortOptions';
 import { DataSetOptions } from '../AdaptableOptions/DataSetOptions';
 import { GroupingOptions } from '../AdaptableOptions/GroupingOptions';
 import { ActionColumnOptions, ActionRowOptions, AdaptableOptions, AdaptableQLOptions, AlertOptions, CalendarOptions, CellSummaryOptions, ChartingOptions, ColumnOptions, ContainerOptions, DashboardOptions, DataChangeHistoryOptions, EditOptions, EntitlementOptions, ExportOptions, FilterOptions, FlashingCellOptions, FormatColumnOptions, LayoutOptions, MenuOptions, NotificationsOptions, QuickSearchOptions, SettingsPanelOptions, StateOptions, TeamSharingOptions, ToolPanelOptions, UserInterfaceOptions } from '../types';
+import { Fdc3Options } from '../AdaptableOptions/Fdc3Options';
 /**
  * Range of functions to access Adaptable Options
  */
@@ -123,7 +124,7 @@ export interface OptionsApi {
      */
     getNotificationsOptions(): Readonly<NotificationsOptions>;
     /**
-     * Returns `AdaptableOptions.searchOptions`
+     * Returns `AdaptableOptions.quickSearchOptions`
      */
     getQuickSearchOptions(): Readonly<QuickSearchOptions>;
     /**
@@ -150,4 +151,8 @@ export interface OptionsApi {
      * Returns `AdaptableOptions.userInterfaceOptions`
      */
     getUserInterfaceOptions(): Readonly<UserInterfaceOptions>;
+    /**
+     * Returns `AdaptableOptions.fdc3Options`
+     */
+    getFdc3Options(): Readonly<Fdc3Options>;
 }

package/src/Api/PredicateApi.d.ts

@@ -1,5 +1,5 @@
 import { AdaptableColumnPredicate } from '../../types';
-import { AdaptablePredicateDef, AdaptablePredicate, PredicateDefHandlerParams, PredicateModuleScope } from '../PredefinedConfig/Common/AdaptablePredicate';
+import { AdaptablePredicateDef, AdaptablePredicate, PredicateDefHandlerContext, PredicateModuleScope } from '../PredefinedConfig/Common/AdaptablePredicate';
 /**
  * Functions which manage the Predicate object in AdapTable
  */
@@ -58,7 +58,7 @@ export interface PredicateApi {
      * @param params
      * @param defaultReturn
      */
-    handleColumnPredicate(predicate: AdaptableColumnPredicate, params: Omit<PredicateDefHandlerParams, 'api' | 'inputs'>, defaultReturn: boolean): boolean;
+    handleColumnPredicate(predicate: AdaptableColumnPredicate, params: Omit<PredicateDefHandlerContext, 'adaptableApi' | 'inputs'>, defaultReturn: boolean): boolean;
     /**
      * Same has handle predicates but it tales into account predicate column id.
      *
@@ -66,19 +66,19 @@ export interface PredicateApi {
      * @param params
      * @param defaultReturn
      */
-    handleColumnPredicates(predicate: AdaptableColumnPredicate[], params: Omit<PredicateDefHandlerParams, 'api' | 'inputs'>, defaultReturn: boolean): boolean;
+    handleColumnPredicates(predicate: AdaptableColumnPredicate[], params: Omit<PredicateDefHandlerContext, 'adaptableApi' | 'inputs'>, defaultReturn: boolean): boolean;
     /**
      * Main Handler function for a Predicate Definition - used by AdapTableQL
      * @param predicate Predicate to handle
      * @param params Additional inputs as required
      * @param defaultReturn Whether to return the default
      */
-    handlePredicate(predicate: AdaptablePredicate | undefined, params: Omit<PredicateDefHandlerParams, 'api' | 'inputs'>, defaultReturn: boolean): boolean;
+    handlePredicate(predicate: AdaptablePredicate | undefined, params: Omit<PredicateDefHandlerContext, 'adaptableApi' | 'inputs'>, defaultReturn: boolean): boolean;
     /**
      * Handle and compose (with AND) the given Predicate Definitions
      * @param predicate Predicate to handle
      * @param params Additional inputs as required
      * @param defaultReturn Whether to return the default
      */
-    handlePredicates(predicates: AdaptablePredicate[], params: Omit<PredicateDefHandlerParams, 'api' | 'inputs'>, defaultReturn: boolean): boolean;
+    handlePredicates(predicates: AdaptablePredicate[], params: Omit<PredicateDefHandlerContext, 'adaptableApi' | 'inputs'>, defaultReturn: boolean): boolean;
 }