@adaptabletools/adaptable 16.0.0-canary.1 → 16.0.0-canary.3

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.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;
@@ -182,7 +182,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);

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/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

@@ -129,7 +129,7 @@ class FormatColumnInternalApi extends ApiBase_1.ApiBase {
             return value;
         }
         const adaptableOptions = this.adaptable.adaptableOptions;
-        const customFormattersFromOptions = (_c = (_b = adaptableOptions === null || adaptableOptions === void 0 ? void 0 : adaptableOptions.userInterfaceOptions) === null || _b === void 0 ? void 0 : _b.customDisplayFormatters) !== null && _c !== void 0 ? _c : [];
+        const customFormattersFromOptions = (_c = (_b = adaptableOptions === null || adaptableOptions === void 0 ? void 0 : adaptableOptions.formatColumnOptions) === null || _b === void 0 ? void 0 : _b.customDisplayFormatters) !== null && _c !== void 0 ? _c : [];
         // formatters are applied in the order they are defined in the options
         const customFormatters = customFormattersFromOptions.filter((customFormatterOption) => columnCustomFormatters.includes(customFormatterOption.id));
         const customDisplayFormatterContext = ObjectFactory_1.default.CreateCustomDisplayFormatterContext(value, node, abColumn, this.getAdaptableApi());
@@ -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

@@ -1,7 +1,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, LayoutOptions, MenuOptions, NotificationsOptions, SearchOptions, SettingsPanelOptions, StateOptions, TeamSharingOptions, ToolPanelOptions, UserInterfaceOptions } from '../types';
+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';
 /**
  * Range of functions to access Adaptable Options
  */
@@ -123,9 +123,13 @@ export interface OptionsApi {
      */
     getNotificationsOptions(): Readonly<NotificationsOptions>;
     /**
-     * Returns `AdaptableOptions.searchOptions`
+     * Returns `AdaptableOptions.quickSearchOptions`
      */
-    getSearchOptions(): Readonly<SearchOptions>;
+    getQuickSearchOptions(): Readonly<QuickSearchOptions>;
+    /**
+     * Returns `AdaptableOptions.formatColumnOptions`
+     */
+    getFormatColumnOptions(): Readonly<FormatColumnOptions>;
     /**
      * Returns `AdaptableOptions.settingsPanelOptions`
      */

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;
 }

package/src/Api/StyledColumnApi.d.ts

@@ -57,11 +57,6 @@ export interface StyledColumnApi {
      * @param styledColumn
      */
     unSuspendStyledColumn(styledColumn: StyledColumn): void;
-    /**
-     * Returns first Styled Column that contains checkbox style
-     * @param columnId column to check
-     */
-    getCheckBoxStyleStyledColumn(column: AdaptableColumn): StyledColumn | undefined;
     /**
      * Checks whether Column with given `columnId` has a PercentBar Style applied
      * @param columnId column ID
@@ -77,15 +72,6 @@ export interface StyledColumnApi {
      * @param columnId column ID
      */
     isSparklineStyleStyledColumn(column: AdaptableColumn): boolean;
-    /**
-     * Whether given column is a (boolean) checkbox column
-     * @param columnId column to check
-     */
-    isCheckBoxStyleStyledColumn(column: AdaptableColumn): boolean;
-    /**
-     * Publishes the CheckboxColumnClickedEvent - when the checkbox in an Checkbox Column is clicked
-     */
-    fireCheckboxColumnClickedEvent(columnId: string, rowData: any, primaryKeyValue: any, isChecked: boolean): void;
     /**
      * Returns a Styled Column for a given column
      * @param column Column to check

package/src/PredefinedConfig/Common/AdaptableColumn.d.ts

@@ -2,7 +2,7 @@ import { AdaptableObject } from './AdaptableObject';
 /**
  * Type of data stored in an Adaptable Column
  */
-export declare type AdaptableColumnDataType = 'String' | 'Number' | 'Boolean' | 'Date' | 'Object' | 'NumberArray' | 'TupleNumberArray' | 'ObjectNumberArray' | 'Unknown';
+export declare type AdaptableColumnDataType = 'String' | 'Number' | 'Boolean' | 'Date' | 'Object' | 'StringArray' | 'NumberArray' | 'TupleNumberArray' | 'ObjectNumberArray' | 'Unknown';
 /**
  * Base class for Adaptable Column containing most important properties
  */

package/src/PredefinedConfig/Common/AdaptableIcon.d.ts

@@ -3,17 +3,17 @@ import { TypeHint } from './Types';
 /**
  * Defines an icon to be used in AdapTable (e.g. in Dashboard Header, Buttons, Menu, etc.)
  */
-export declare type AdaptableIcon = AdaptableInternalIcon | AdaptableExternalIcon | AdaptableElementIcon;
+export declare type AdaptableIcon = AdaptableSystemIcon | AdaptableCustomIcon | AdaptableElementIcon;
 /**
- * Defines an icon from the internal AdapTable icon set
+ * Defines an icon from the System AdapTable icon set
  */
-export interface AdaptableInternalIcon extends AdaptableBaseIcon {
+export interface AdaptableSystemIcon extends AdaptableBaseIcon {
     /**
      * The name of the icon to use (referencing the AdapTable Icon Library)
      *
      * The icon can be a adaptable icon or a custom one defined in `interfaceOptions.customIcons`
      */
-    name: TypeHint<string, AdaptableInternalIconName>;
+    name: TypeHint<string, AdaptableSystemIconName>;
     /**
      * The size (in pixels) of the SVG icon (defaults to `17px`)
      *
@@ -23,7 +23,7 @@ export interface AdaptableInternalIcon extends AdaptableBaseIcon {
 /**
  * Defines an icon from an external source
  */
-export interface AdaptableExternalIcon extends AdaptableBaseIcon {
+export interface AdaptableCustomIcon extends AdaptableBaseIcon {
     /**
      * The URL of the icon to use
      */
@@ -52,6 +52,6 @@ export interface AdaptableBaseIcon {
     style?: React.CSSProperties;
 }
 /**
- * All AdapTable internal icon names
+ * All AdapTable System Icon names
  */
-export declare type AdaptableInternalIconName = 'add' | 'alert' | 'building' | 'laptop' | 'arrow-down' | 'arrow-left' | 'arrow-right' | 'arrow-up' | 'arrow-up-long' | 'arrow-down-long' | 'arrow-expand' | 'paperclip' | 'unfilled-circle' | 'boolean-list' | 'broadcast' | 'brush' | 'spanner' | 'edit-table' | 'chart-and-grid' | 'calendar' | 'call' | 'cells' | 'flag' | 'chart' | 'chat' | 'check' | 'check-circle' | 'checked' | 'clone' | 'close' | 'cloud-upload' | 'collapse' | 'column-add' | 'columns' | 'filter-list' | 'comment' | 'contains' | 'dashboard' | 'data-set' | 'date-range' | 'delete' | 'division' | 'dock' | 'drag' | 'edit' | 'ends-with' | 'equals' | 'equation' | 'error' | 'expand' | 'exponent' | 'export' | 'export-data' | 'fast-backward' | 'fast-forward' | 'filter' | 'lightning' | 'folder' | 'folder-open' | 'folder-shared' | 'color-palette' | 'horizontal-lines' | 'function' | 'greater-than' | 'greater-than-or-equal' | 'history' | 'home' | 'import-export' | 'info' | 'brain' | 'download' | 'grid' | 'less-than' | 'less-than-or-equal' | 'list' | 'logout' | 'menu' | 'minus' | 'multiplication' | 'newpage' | 'news' | 'filled-circle' | 'not-contains' | 'not-equal' | 'open-in-new' | 'pause' | 'percent' | 'percent-tag' | 'person' | 'pie-chart' | 'play' | 'plus' | 'add-circle' | 'search' | 'search-table' | 'quote' | 'refresh' | 'regex' | 'reminder' | 'save' | 'schedule' | 'settings' | 'link' | 'sort-asc' | 'sort-desc' | 'spark-line' | 'starts-with' | 'assignment' | 'statusbar' | 'stop' | 'traffic-lights' | 'tab-unselected' | 'theme' | 'clipboard' | 'target' | 'triangle-down' | 'triangle-up' | 'unchecked' | 'undo' | 'downloaded' | 'upload' | 'warning' | 'gradient' | 'badge' | 'italic' | 'bold' | 'align-left' | 'align-right' | 'align-center' | 'align-justify' | 'underline' | 'strikethrough' | 'overline' | 'case-upper' | 'case-lower' | 'case-sentence' | 'visibility-on' | 'visibility-off' | 'visibility-off-bold' | 'visibility-on-bold';
+export declare type AdaptableSystemIconName = 'add' | 'alert' | 'building' | 'laptop' | 'arrow-down' | 'arrow-left' | 'arrow-right' | 'arrow-up' | 'arrow-up-long' | 'arrow-down-long' | 'arrow-expand' | 'paperclip' | 'unfilled-circle' | 'boolean-list' | 'broadcast' | 'brush' | 'spanner' | 'edit-table' | 'chart-and-grid' | 'calendar' | 'call' | 'cells' | 'flag' | 'chart' | 'chat' | 'check' | 'check-circle' | 'checked' | 'clone' | 'close' | 'cloud-upload' | 'collapse' | 'column-add' | 'columns' | 'filter-list' | 'comment' | 'contains' | 'dashboard' | 'data-set' | 'date-range' | 'delete' | 'division' | 'dock' | 'drag' | 'edit' | 'ends-with' | 'equals' | 'equation' | 'error' | 'expand' | 'exponent' | 'export' | 'export-data' | 'fast-backward' | 'fast-forward' | 'filter' | 'lightning' | 'folder' | 'folder-open' | 'folder-shared' | 'color-palette' | 'horizontal-lines' | 'function' | 'greater-than' | 'greater-than-or-equal' | 'history' | 'home' | 'import-export' | 'info' | 'brain' | 'download' | 'grid' | 'less-than' | 'less-than-or-equal' | 'list' | 'logout' | 'menu' | 'minus' | 'multiplication' | 'newpage' | 'news' | 'filled-circle' | 'not-contains' | 'not-equal' | 'open-in-new' | 'pause' | 'percent' | 'percent-tag' | 'person' | 'pie-chart' | 'play' | 'plus' | 'add-circle' | 'search' | 'search-table' | 'quote' | 'refresh' | 'regex' | 'reminder' | 'save' | 'schedule' | 'settings' | 'link' | 'sort-asc' | 'sort-desc' | 'spark-line' | 'starts-with' | 'assignment' | 'statusbar' | 'stop' | 'traffic-lights' | 'tab-unselected' | 'theme' | 'clipboard' | 'target' | 'triangle-down' | 'triangle-up' | 'unchecked' | 'undo' | 'downloaded' | 'upload' | 'warning' | 'gradient' | 'badge' | 'italic' | 'bold' | 'align-left' | 'align-right' | 'align-center' | 'align-justify' | 'underline' | 'strikethrough' | 'overline' | 'case-upper' | 'case-lower' | 'case-sentence' | 'visibility-on' | 'visibility-off' | 'visibility-off-bold' | 'visibility-on-bold';

package/src/PredefinedConfig/Common/AdaptablePredicate.d.ts

@@ -1,7 +1,8 @@
-import { AdaptableScope } from './AdaptableScope';
-import { AdaptableColumn, AdaptableColumnDataType } from './AdaptableColumn';
-import { AdaptableApi, AdaptableIcon, ColumnFilter } from '../../types';
 import { IRowNode } from '@ag-grid-community/core';
+import { AdaptableIcon, ColumnFilter } from '../../types';
+import { AdaptableColumn, AdaptableColumnDataType } from './AdaptableColumn';
+import { AdaptableScope } from './AdaptableScope';
+import { BaseContext } from './BaseContext';
 /**
  * Predicate object used by AdapTableQL - essentially a boolean function
  */
@@ -51,7 +52,7 @@ export interface AdaptablePredicateDef {
     /**
      * Actual boolean function invoked when evaluating the Predicate
      */
-    handler: (params: PredicateDefHandlerParams) => boolean;
+    handler: (params: PredicateDefHandlerContext) => boolean;
     /**
      * String representation of the Predicate
      */
@@ -66,10 +67,6 @@ export interface AdaptablePredicateDef {
      * Keyboard shortcuts to initiate predicate - used in Quick Filter bar
      */
     shortcuts?: string[];
-    /**
-     * Display this predicate only in Quick Filter Bar (and NOT in Filter Form)
-     */
-    onlyQuickFilter?: boolean;
 }
 /**
  * Defines an Input to a Predicate
@@ -82,7 +79,7 @@ export interface PredicateDefInput {
 /**
  * Object passed into an Adaptable Predicate Definition
  */
-export interface PredicateDefHandlerParams {
+export interface PredicateDefHandlerContext extends BaseContext {
     /**
      * Raw value in cell being evaluated
      */
@@ -99,18 +96,14 @@ export interface PredicateDefHandlerParams {
      * AG Grid Row node which contains the cell
      */
     node: IRowNode;
-    /**
-     * Any inputs required to perform evaluation
-     */
-    inputs: any[];
     /**
      * Adaptable Column which contains the cell
      */
     column: AdaptableColumn;
     /**
-     * The Adaptable Api
+     * Any (optional) inputs required to perform evaluation
      */
-    api: AdaptableApi;
+    inputs?: any[];
 }
 /**
  * Inputs required for a Predicate