@adaptabletools/adaptable 11.0.0-canary.2 → 11.0.0-canary.6

package/src/Api/Implementation/AlertApiImpl.js

@@ -16,7 +16,7 @@ class AlertApiImpl extends ApiBase_1.ApiBase {
     }
     getAdaptableFormByName(name) {
         var _a;
-        const alertForms = this.getNotificationsOptions().alertForms || [];
+        const alertForms = this.getAlertOptions().alertForms || [];
         return (_a = alertForms.find((f) => f.name === name)) === null || _a === void 0 ? void 0 : _a.form;
     }
     getAlertDefinitions() {
@@ -57,7 +57,7 @@ class AlertApiImpl extends ApiBase_1.ApiBase {
             }
             actions.forEach((action) => {
                 var _a;
-                const buttonOnClick = (_a = this.getNotificationsOptions().actionHandlers) === null || _a === void 0 ? void 0 : _a.find((x) => x.name === action);
+                const buttonOnClick = (_a = this.getAlertOptions().actionHandlers) === null || _a === void 0 ? void 0 : _a.find((x) => x.name === action);
                 buttonOnClick === null || buttonOnClick === void 0 ? void 0 : buttonOnClick.handler(button, context);
                 this.adaptable.api.alertApi.executeAlertAction(action, {
                     alertDefinition: context.alert.alertDefinition,
@@ -79,10 +79,13 @@ class AlertApiImpl extends ApiBase_1.ApiBase {
             switch (highhlightType) {
                 case 'Error':
                     backgroundColor = 'var(--ab-color-error)';
+                    break;
                 case 'Info':
                     backgroundColor = 'var(--ab-color-info)';
+                    break;
                 case 'Success':
                     backgroundColor = 'var(--ab-color-success)';
+                    break;
                 case 'Warning':
                     backgroundColor = 'var(--ab-color-warn)';
             }
@@ -92,7 +95,7 @@ class AlertApiImpl extends ApiBase_1.ApiBase {
                 highlightStyle: {
                     BackColor: backgroundColor,
                 },
-                timeout: this.getNotificationsOptions().cellHighlightDuration,
+                timeout: this.getAlertOptions().cellHighlightDuration,
             });
             return;
         }
@@ -132,9 +135,12 @@ class AlertApiImpl extends ApiBase_1.ApiBase {
         // 3 things we always do with an alert are:
         // 1. Dispatch the Alert (so it appears in the toolbar)
         this.addUidToAdaptableObject(alertToShow);
-        this.dispatchAction(SystemRedux.SystemAlertAdd(alertToShow, this.getNotificationsOptions().maxAlertsInStore));
+        this.dispatchAction(SystemRedux.SystemAlertAdd(alertToShow, this.getAlertOptions().maxAlertsInStore));
         // 2. Publish the Alert Fired Event
-        const alertFiredInfo = { adaptableApi: this.adaptable.api, alert: alertToShow };
+        const alertFiredInfo = {
+            adaptableApi: this.adaptable.api,
+            alert: alertToShow,
+        };
         const results = await this.adaptable.api.eventApi.emit('AlertFired', alertFiredInfo);
         const showPopup = results.reduce((endResult, aResult) => {
             return endResult && aResult !== false;
@@ -175,7 +181,7 @@ class AlertApiImpl extends ApiBase_1.ApiBase {
                     this.adaptable.api.gridApi.refreshCells([alertNode], [dataChangedInfo.column.columnId]);
                     setTimeout(() => {
                         this.dispatchAction(SystemRedux.SystemAlertRemoveHighlight(alertToShow));
-                    }, this.adaptable.adaptableOptions.notificationsOptions.cellHighlightDuration);
+                    }, this.adaptable.adaptableOptions.alertOptions.cellHighlightDuration);
                 }
             }
             if (alertProperties.HighlightRow && dataChangedInfo) {
@@ -187,7 +193,7 @@ class AlertApiImpl extends ApiBase_1.ApiBase {
                     this.adaptable.api.gridApi.refreshRowNode(alertNode);
                     setTimeout(() => {
                         this.dispatchAction(SystemRedux.SystemAlertRemoveHighlight(alertToShow));
-                    }, this.adaptable.adaptableOptions.notificationsOptions.cellHighlightDuration);
+                    }, this.adaptable.adaptableOptions.alertOptions.cellHighlightDuration);
                 }
             }
             if (alertProperties.LogToConsole) {
@@ -196,7 +202,10 @@ class AlertApiImpl extends ApiBase_1.ApiBase {
         }
     }
     publishAlertFiredEvent(alertToFire) {
-        const alertFiredInfo = { adaptableApi: this.adaptable.api, alert: alertToFire };
+        const alertFiredInfo = {
+            adaptableApi: this.adaptable.api,
+            alert: alertToFire,
+        };
         this.adaptable.api.eventApi.emit('AlertFired', alertFiredInfo);
     }
     displayMessageAlertPopup(alertToDisplayAsPopup) {
@@ -242,7 +251,7 @@ class AlertApiImpl extends ApiBase_1.ApiBase {
     }
     getAlertDescription(alertDefinition, dataChangedInfo) {
         var _a;
-        const alertMessageFunction = (_a = this.adaptable.adaptableOptions.notificationsOptions) === null || _a === void 0 ? void 0 : _a.alertMessageText;
+        const alertMessageFunction = (_a = this.adaptable.adaptableOptions.alertOptions) === null || _a === void 0 ? void 0 : _a.alertMessageText;
         if (alertMessageFunction) {
             const returnText = alertMessageFunction(alertDefinition, dataChangedInfo);
             if (returnText) {
@@ -260,7 +269,7 @@ class AlertApiImpl extends ApiBase_1.ApiBase {
         var _a, _b;
         let ruleDescription = alert.Rule.Predicate
             ? this.adaptable.api.predicateApi.predicateToString(alert.Rule.Predicate)
-            : (_b = (_a = alert.Rule.BooleanExpression) !== null && _a !== void 0 ? _a : alert.Rule.ObservableExpression) !== null && _b !== void 0 ? _b : alert.Rule.AggregationExpression;
+            : (_b = (_a = alert.Rule.BooleanExpression) !== null && _a !== void 0 ? _a : alert.Rule.ObservableExpression) !== null && _b !== void 0 ? _b : alert.Rule.AggregatedBooleanExpression;
         return ruleDescription;
     }
 }

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

@@ -12,6 +12,7 @@ import { NotificationsOptions } from '../../AdaptableOptions/NotificationsOption
 import { ToolPanelOptions } from '../../AdaptableOptions/ToolPanelOptions';
 import { ModuleParams } from '../../View/Components/SharedProps/ModuleViewPopupProps';
 import { QueryLanguageOptions } from '../../AdaptableOptions/QueryLanguageOptions';
+import { AlertOptions } from '../../AdaptableOptions/AlertOptions';
 export declare abstract class ApiBase {
     protected adaptable: IAdaptable;
     /**
@@ -46,6 +47,7 @@ export declare abstract class ApiBase {
     protected getOptions(): AdaptableOptions;
     protected getContainerOptions(): ContainerOptions;
     protected getNotificationsOptions(): NotificationsOptions;
+    protected getAlertOptions(): AlertOptions;
     protected getDashboardOptions(): DashboardOptions;
     protected getEditOptions(): EditOptions;
     protected getExportOptions(): ExportOptions;

package/src/Api/Implementation/ApiBase.js

@@ -77,6 +77,9 @@ class ApiBase {
     getNotificationsOptions() {
         return this.getOptions().notificationsOptions;
     }
+    getAlertOptions() {
+        return this.getOptions().alertOptions;
+    }
     getDashboardOptions() {
         return this.getOptions().dashboardOptions;
     }

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

@@ -42,7 +42,6 @@ export declare class ColumnApiImpl extends ApiBase implements ColumnApi {
     getColumnFromFriendlyName(columnName: string, logWarning?: boolean): AdaptableColumn;
     getColumnsOfType(dataType: DataType): AdaptableColumn[];
     getNumericColumns(): AdaptableColumn[];
-    getNumericArrayColumns(): AdaptableColumn[];
     getStringColumns(): AdaptableColumn[];
     getDateColumns(): AdaptableColumn[];
     getBooleanColumns(): AdaptableColumn[];

package/src/Api/Implementation/ColumnApiImpl.js

@@ -224,8 +224,6 @@ class ColumnApiImpl extends ApiBase_1.ApiBase {
                 return this.getDateColumns();
             case Enums_1.DataType.Number:
                 return this.getNumericColumns();
-            case Enums_1.DataType.NumberArray:
-                return this.getNumericArrayColumns();
             case Enums_1.DataType.String:
                 return this.getStringColumns();
             default:
@@ -235,9 +233,6 @@ class ColumnApiImpl extends ApiBase_1.ApiBase {
     getNumericColumns() {
         return this.getColumns().filter((c) => c.dataType == Enums_1.DataType.Number);
     }
-    getNumericArrayColumns() {
-        return this.getColumns().filter((c) => c.dataType == Enums_1.DataType.NumberArray);
-    }
     getStringColumns() {
         return this.getColumns().filter((c) => c.dataType == Enums_1.DataType.String);
     }

package/src/Api/Implementation/DashboardApiImpl.js

@@ -5,7 +5,7 @@ const tslib_1 = require("tslib");
 const DashboardRedux = tslib_1.__importStar(require("../../Redux/ActionsReducers/DashboardRedux"));
 const ApiBase_1 = require("./ApiBase");
 const ModuleConstants = tslib_1.__importStar(require("../../Utilities/Constants/ModuleConstants"));
-const isEqual_1 = tslib_1.__importDefault(require("lodash-es/isEqual"));
+const isEqual_1 = tslib_1.__importDefault(require("lodash/isEqual"));
 const ArrayExtensions_1 = tslib_1.__importDefault(require("../../Utilities/Extensions/ArrayExtensions"));
 const Helper_1 = tslib_1.__importDefault(require("../../Utilities/Helpers/Helper"));
 const react_dom_1 = tslib_1.__importDefault(require("react-dom"));

package/src/Api/Implementation/FlashingCellApiImpl.js

@@ -45,10 +45,8 @@ class FlashingCellApiImpl extends ApiBase_1.ApiBase {
         return this.getFlashingCellDefinitions().filter((fc) => !fc.IsSuspended);
     }
     getFlashingCellFlashTarget(flashingCellDefinition) {
-        const flashTarget = flashingCellDefinition.FlashTarget === 'cell' || !flashingCellDefinition.FlashTarget
-            ? 'cell'
-            : 'row';
-        return flashTarget;
+        var _a;
+        return (_a = flashingCellDefinition.FlashTarget) !== null && _a !== void 0 ? _a : 'cell';
     }
     showFlashingCell(flashingCellToShow) {
         this.addUidToAdaptableObject(flashingCellToShow);

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

@@ -13,11 +13,6 @@ export declare class FreeTextColumnApiImpl extends ApiBase implements FreeTextCo
     }): FreeTextColumn;
     addEditFreeTextColumnStoredValue(freeTextColumn: FreeTextColumn, storedValue: FreeTextStoredValue): FreeTextColumn;
     addStoredValuesToFreeTextColumn(columnId: string, storedValues: FreeTextStoredValue[], replaceAction: 'All' | 'Conflicting' | 'None'): void;
-    createFreeTextColumn({ columnName, columnId, defaultValue, }: {
-        columnId: string;
-        columnName?: string;
-        defaultValue: string;
-    }): FreeTextColumn;
     deleteFreeTextColumn(columnId: string): void;
     showFreeTextColumnPopup(): void;
     getFreeTextColumnValueFromRowNode(freeTextColumn: FreeTextColumn, rowNode: RowNode): any;

package/src/Api/Implementation/FreeTextColumnApiImpl.js

@@ -4,7 +4,6 @@ exports.FreeTextColumnApiImpl = void 0;
 const tslib_1 = require("tslib");
 const FreeTextColumnRedux = tslib_1.__importStar(require("../../Redux/ActionsReducers/FreeTextColumnRedux"));
 const ApiBase_1 = require("./ApiBase");
-const ObjectFactory_1 = require("../../Utilities/ObjectFactory");
 const ModuleConstants = tslib_1.__importStar(require("../../Utilities/Constants/ModuleConstants"));
 const ArrayExtensions_1 = tslib_1.__importDefault(require("../../Utilities/Extensions/ArrayExtensions"));
 const LoggingHelper_1 = require("../../Utilities/Helpers/LoggingHelper");
@@ -67,14 +66,6 @@ class FreeTextColumnApiImpl extends ApiBase_1.ApiBase {
             this.dispatchAction(FreeTextColumnRedux.FreeTextColumnEdit(freeTextColumn));
         }
     }
-    createFreeTextColumn({ columnName, columnId, defaultValue = null, }) {
-        let freeTextColumn = ObjectFactory_1.ObjectFactory.CreateEmptyFreeTextColumn(this.adaptable.api.internalApi.getAdaptableOptions().filterOptions
-            .enableFilterOnSpecialColumns);
-        freeTextColumn.ColumnId = columnId;
-        freeTextColumn.FriendlyName = columnName || columnId;
-        freeTextColumn.DefaultValue = defaultValue;
-        return this.addFreeTextColumn(freeTextColumn);
-    }
     deleteFreeTextColumn(columnId) {
         let freeTextColumn = this.getAllFreeTextColumn().find((ftc) => ftc.ColumnId == columnId);
         if (this.checkItemExists(freeTextColumn, columnId, ModuleConstants.FreeTextColumnModuleId)) {

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

@@ -7,7 +7,8 @@ import { GridCell } from '../../PredefinedConfig/Selection/GridCell';
 import { ColumnSort } from '../../PredefinedConfig/Common/ColumnSort';
 import { DataUpdateConfig } from '../../PredefinedConfig/Common/DataUpdateConfig';
 import { DataChangedInfo, AccessLevel, AdaptableModule } from '../../types';
-import { CellHighlightInfo, RowHighlightInfo } from '../../PredefinedConfig/Common/CellHighlightInfo';
+import { CellHighlightInfo } from '../../PredefinedConfig/Common/CellHighlightInfo';
+import { RowHighlightInfo } from '../../PredefinedConfig/Common/RowHighlightInfo';
 import { GridOptions, RowNode } from '@ag-grid-community/all-modules';
 import { GridCellRange } from '../../PredefinedConfig/Selection/GridCellRange';
 export declare class GridApiImpl extends ApiBase implements GridApi {
@@ -16,10 +17,10 @@ export declare class GridApiImpl extends ApiBase implements GridApi {
     getGridData(): any[];
     getFilteredData(): any[];
     loadGridData(dataSource: any): void;
-    updateGridData(dataRows: any[], dataUpdateConfig?: DataUpdateConfig): Promise<void>;
-    addGridData(dataRows: any[], dataUpdateConfig?: DataUpdateConfig): Promise<void>;
+    updateGridData(dataRows: any[], dataUpdateConfig?: DataUpdateConfig): Promise<RowNode[]>;
+    addGridData(dataRows: any[], dataUpdateConfig?: DataUpdateConfig): Promise<RowNode[]>;
     undoCellEdit(dataChangedInfo: DataChangedInfo): boolean;
-    deleteGridData(dataRows: any[], dataUpdateConfig?: DataUpdateConfig): Promise<void>;
+    deleteGridData(dataRows: any[], dataUpdateConfig?: DataUpdateConfig): Promise<RowNode[]>;
     setCellValue(columnId: string, newValue: any, primaryKeyValue: any): void;
     setCellsValue(gridCells: {
         columnId: any;

package/src/Api/Implementation/GridApiImpl.js

@@ -25,10 +25,12 @@ class GridApiImpl extends ApiBase_1.ApiBase {
     async updateGridData(dataRows, dataUpdateConfig) {
         const rowNodes = await this.adaptable.updateRows(dataRows, dataUpdateConfig);
         this.fireGridDataChangedEvent(dataRows, rowNodes, 'Edit');
+        return rowNodes;
     }
     async addGridData(dataRows, dataUpdateConfig) {
         const rowNodes = await this.adaptable.addRows(dataRows, dataUpdateConfig);
         this.fireGridDataChangedEvent(dataRows, rowNodes, 'Add');
+        return rowNodes;
     }
     undoCellEdit(dataChangedInfo) {
         // for the reason of this hacky solution see the comments in DataService
@@ -40,7 +42,9 @@ class GridApiImpl extends ApiBase_1.ApiBase {
         if (this.checkArrayExists(dataRows)) {
             const rowNodes = await this.adaptable.deleteRows(dataRows, dataUpdateConfig);
             this.fireGridDataChangedEvent(dataRows, rowNodes, 'Delete');
+            return rowNodes;
         }
+        return [];
     }
     setCellValue(columnId, newValue, primaryKeyValue) {
         const abColumn = this.adaptable.api.columnApi.getColumnFromId(columnId);

package/src/Api/Implementation/InternalApiImpl.js

@@ -25,7 +25,7 @@ class InternalApiImpl extends ApiBase_1.ApiBase {
         let adaptableAlertForm;
         let isActionForm = false;
         if (typeof alertForm === 'string') {
-            const alertForms = this.getNotificationsOptions().alertForms || [];
+            const alertForms = this.getAlertOptions().alertForms || [];
             adaptableAlertForm = (_a = alertForms.find((f) => f.name === alertForm)) === null || _a === void 0 ? void 0 : _a.form;
         }
         else {
@@ -68,7 +68,7 @@ class InternalApiImpl extends ApiBase_1.ApiBase {
         const forPrimaryKey = (_a = AdaptableFlashingAlerts[primaryKey]) !== null && _a !== void 0 ? _a : {};
         const toFlashingAlert = (uuid) => { var _a; return uuid ? (_a = AdaptableFlashingAlertsMap[uuid]) !== null && _a !== void 0 ? _a : null : null; };
         if (!columnId) {
-            return toFlashingAlert(forPrimaryKey[SystemRedux_1.FLASHING_ALERT_ROW_KEY]);
+            return toFlashingAlert(forPrimaryKey[SystemRedux_1.FLASHING_CELL_ROW_KEY]);
         }
         return toFlashingAlert(forPrimaryKey[columnId]);
     }

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

@@ -1,6 +1,7 @@
 import { ApiBase } from './ApiBase';
 import { LayoutApi } from '../LayoutApi';
 import { LayoutState, Layout } from '../../PredefinedConfig/LayoutState';
+import { AdaptableColumn } from '../../PredefinedConfig/Common/AdaptableColumn';
 export declare class LayoutApiImpl extends ApiBase implements LayoutApi {
     getLayoutState(): LayoutState;
     shouldAutoSaveLayout: (layout?: Layout) => boolean;
@@ -27,6 +28,7 @@ export declare class LayoutApiImpl extends ApiBase implements LayoutApi {
     getLayoutDescription(layout: Layout): string;
     private getColumnSort;
     createDefaultLayoutIfNeeded(): Layout | null;
+    showChangeColumnCaption(column: AdaptableColumn): void;
     showLayoutPopup(): void;
     isCurrentLayoutReadOnly(): boolean;
 }

package/src/Api/Implementation/LayoutApiImpl.js

@@ -10,10 +10,12 @@ const ObjectFactory_1 = tslib_1.__importDefault(require("../../Utilities/ObjectF
 const LoggingHelper_1 = require("../../Utilities/Helpers/LoggingHelper");
 const Helper_1 = tslib_1.__importDefault(require("../../Utilities/Helpers/Helper"));
 const Uuid_1 = require("../../PredefinedConfig/Uuid");
-const isEqual_1 = tslib_1.__importDefault(require("lodash-es/isEqual"));
+const isEqual_1 = tslib_1.__importDefault(require("lodash/isEqual"));
 const GeneralConstants_1 = require("../../Utilities/Constants/GeneralConstants");
 const Enums_1 = require("../../PredefinedConfig/Common/Enums");
 const ArrayExtensions_1 = require("../../Utilities/Extensions/ArrayExtensions");
+const PopupRedux_1 = require("../../Redux/ActionsReducers/PopupRedux");
+const LayoutRedux_1 = require("../../Redux/ActionsReducers/LayoutRedux");
 class LayoutApiImpl extends ApiBase_1.ApiBase {
     constructor() {
         super(...arguments);
@@ -229,6 +231,15 @@ class LayoutApiImpl extends ApiBase_1.ApiBase {
             }
         }
     }
+    showChangeColumnCaption(column) {
+        this.dispatchAction(PopupRedux_1.PopupShowPrompt({
+            Header: `Change caption for '${column.friendlyName}'`,
+            Msg: '',
+            DefaultValue: column.friendlyName,
+            ConfirmActionCreator: (inputText) => inputText !== column.friendlyName &&
+                LayoutRedux_1.LayoutSetColumnCaption(this.getCurrentLayoutName(), column.columnId, inputText),
+        }));
+    }
     showLayoutPopup() {
         this.showModulePopup(ModuleConstants.LayoutModuleId);
     }

package/src/Api/Implementation/QueryApiImpl.js

@@ -25,7 +25,10 @@ class QueryApiImpl extends ApiBase_1.ApiBase {
         // check that there is no other existing named query with the same name
         const duplicate = this.getAllNamedQuery().find((q) => q.Name === namedQuery.Name && q.Uuid !== namedQuery.Uuid);
         if (duplicate) {
-            return { valid: false, message: 'A Named Query already exists with that name' };
+            return {
+                valid: false,
+                message: 'A Named Query already exists with that name',
+            };
         }
         return { valid: true, message: '' };
     }

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

@@ -5,7 +5,7 @@ import { ExpressionFunctionMap } from '../../types';
 export declare class QueryLanguageApiImpl extends ApiBase implements QueryLanguageApi {
     isValidBooleanExpression(query: string, module: AdaptableModule, validationErrorMessage?: string): boolean;
     isValidObservableExpression(expression: string, module: AdaptableModule, validationErrorMessage?: string): boolean;
-    isValidAggregationExpression(expression: string, module: AdaptableModule, validationErrorMessage?: string): boolean;
+    isValidAggregatedBooleanExpression(expression: string, module: AdaptableModule, validationErrorMessage?: string): boolean;
     getASTForExpression(query: string): any;
     getColumnsFromExpression(expression: string): string[];
     getQueryableColumnIds(): string[] | undefined;

package/src/Api/Implementation/QueryLanguageApiImpl.js

@@ -8,7 +8,7 @@ const ArrayExtensions_1 = tslib_1.__importDefault(require("../../Utilities/Exten
 const LoggingHelper_1 = require("../../Utilities/Helpers/LoggingHelper");
 class QueryLanguageApiImpl extends ApiBase_1.ApiBase {
     isValidBooleanExpression(query, module, validationErrorMessage) {
-        const { isValid, errorMessage, } = this.adaptable.api.internalApi
+        const { isValid, errorMessage } = this.adaptable.api.internalApi
             .getQueryLanguageService()
             .validateBoolean(query, module, { force: true });
         if (!isValid && validationErrorMessage) {
@@ -17,7 +17,7 @@ class QueryLanguageApiImpl extends ApiBase_1.ApiBase {
         return isValid;
     }
     isValidObservableExpression(expression, module, validationErrorMessage) {
-        const { isValid, errorMessage, } = this.adaptable.api.internalApi
+        const { isValid, errorMessage } = this.adaptable.api.internalApi
             .getQueryLanguageService()
             .validateObservable(expression, module);
         if (!isValid && validationErrorMessage) {
@@ -25,10 +25,10 @@ class QueryLanguageApiImpl extends ApiBase_1.ApiBase {
         }
         return isValid;
     }
-    isValidAggregationExpression(expression, module, validationErrorMessage) {
-        const { isValid, errorMessage, } = this.adaptable.api.internalApi
+    isValidAggregatedBooleanExpression(expression, module, validationErrorMessage) {
+        const { isValid, errorMessage } = this.adaptable.api.internalApi
             .getQueryLanguageService()
-            .validateAggregation(expression, module);
+            .validateAggregatedBoolean(expression, module);
         if (!isValid && validationErrorMessage) {
             LoggingHelper_1.LogAdaptableWarning(`${validationErrorMessage} :: ${errorMessage}`);
         }
@@ -51,8 +51,7 @@ class QueryLanguageApiImpl extends ApiBase_1.ApiBase {
         }
     }
     getQueryableColumnIds() {
-        let queryableColumns = this.getQueryLanguageOptions()
-            .queryableColumns;
+        let queryableColumns = this.getQueryLanguageOptions().queryableColumns;
         if (!queryableColumns) {
             return undefined;
         }

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

@@ -0,0 +1,7 @@
+import { SettingsPanelApi } from '../SettingsPanelApi';
+import { ApiBase } from './ApiBase';
+import { AdaptableModule } from '../../../types';
+export declare class SettingsPanelApiImpl extends ApiBase implements SettingsPanelApi {
+    showSettingsPanel(moduleName?: AdaptableModule): void;
+    showCustomSettingsPanel(name: string): void;
+}

package/src/Api/Implementation/SettingsPanelApiImpl.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SettingsPanelApiImpl = void 0;
+const tslib_1 = require("tslib");
+const ApiBase_1 = require("./ApiBase");
+const PopupRedux = tslib_1.__importStar(require("../../Redux/ActionsReducers/PopupRedux"));
+class SettingsPanelApiImpl extends ApiBase_1.ApiBase {
+    showSettingsPanel(moduleName) {
+        this.dispatchAction(PopupRedux.PopupShowScreen(moduleName));
+    }
+    showCustomSettingsPanel(name) {
+        this.dispatchAction(PopupRedux.PopupShowScreen('CustomSettingsPanelModule', name));
+    }
+}
+exports.SettingsPanelApiImpl = SettingsPanelApiImpl;

package/src/Api/LayoutApi.d.ts

@@ -1,3 +1,4 @@
+import { AdaptableColumn } from '../../types';
 import { LayoutState, Layout } from '../PredefinedConfig/LayoutState';
 /**
  * Provides run-time access to the Layout Module and associated state
@@ -128,4 +129,10 @@ export interface LayoutApi {
      */
     setColumnCaption(columnId: string, caption: string): void;
     isCurrentLayoutReadOnly(): boolean;
+    /**
+     * Opens change column caption popup
+     *
+     * @param column AdaptableColumn
+     */
+    showChangeColumnCaption(column: AdaptableColumn): void;
 }

package/src/Api/OpenFinApi.d.ts

@@ -2,6 +2,7 @@ import { OpenFinState, OpenFinReport, OpenFinSchedule } from '../PredefinedConfi
 import { AdaptableAlert } from '../PredefinedConfig/Common/AdaptableAlert';
 import { OpenFinPluginOptions } from '../AdaptableOptions/OpenFinPluginOptions';
 import { NotificationsOptions } from '../AdaptableOptions/NotificationsOptions';
+import { AlertOptions } from '../AdaptableOptions/AlertOptions';
 /**
  * Provides run-time access to the OpenFin Plugin
  */
@@ -44,6 +45,10 @@ export interface OpenFinApi {
      * Gets the Notification section from Adaptable Options
      */
     getNotificationsOptions(): NotificationsOptions;
+    /**
+     * Gets the Alert section from Adaptable Options
+     */
+    getAlertOptions(): AlertOptions;
     /**
      * Retrieves all Schedules that send data to Excel via OpenFin
      */

package/src/Api/PluginsApi.d.ts

@@ -7,12 +7,41 @@ import { FinanceApi } from './FinanceApi';
  * API methods dealing with AdapTable plugins
  */
 export interface PluginsApi {
+    /**
+     * Retrieves the Plugin State (internal only)
+     */
     getPluginsState(): PluginsState;
+    /**
+     * Gets the State for a given Plugin
+     * @param pluginId plugin state to retrieve
+     */
     getPluginState(pluginId: string): any;
+    /**
+     * Registers a Plugin (internal method)
+     * @param pluginId Plugin to register
+     * @param initialPluginState any state the Plugin requires
+     */
     registerPlugin(pluginId: string, initialPluginState: any): void;
+    /**
+     * Sets the initial state for a given plugin (internal method)
+     * @param pluginId Plugin to set state for
+     * @param pluginState State to set
+     */
     setPluginState(pluginId: string, pluginState: any): void;
+    /**
+     * Returns ipushpull API class in Adaptable API
+     */
     getipushpullPluginApi(): IPushPullApi;
+    /**
+     * Returns Glue42 API class in Adaptable API
+     */
     getGlue42PluginApi(): Glue42Api;
+    /**
+     * Returns OpenFin API class in Adaptable API
+     */
     getOpenFinPluginApi(): OpenFinApi;
+    /**
+     * Returns Finance API class in Adaptable API
+     */
     getFinancePluginApi(): FinanceApi;
 }

package/src/Api/QueryLanguageApi.d.ts

@@ -13,21 +13,21 @@ export interface QueryLanguageApi {
     isValidBooleanExpression(query: string, module: AdaptableModule, validationErrorMessage?: string): boolean;
     /**
      * Whether the given ObservableExpression is valid
-     * @param query query to Check
-     * @param module module specific query
-     * @param validationErrorMessage optional validation error message; if provided, the error will be logged
+     * @param expression - ObservableExpression to check
+     * @param module - module specific query
+     * @param validationErrorMessage - optional validation error message; if provided, the error will be logged
      */
     isValidObservableExpression(expression: string, module: AdaptableModule, validationErrorMessage?: string): boolean;
     /**
-     * Whether the given AggregationExpression is valid
-     * @param query query to Check
-     * @param module module specific query
-     * @param validationErrorMessage optional validation error message; if provided, the error will be logged
+     * Whether the given AggregatedBooleanExpression is valid
+     * @param expression -  AggregatedBooleanExpression to check
+     * @param module - module specific query
+     * @param validationErrorMessage - optional validation error message; if provided, the error will be logged
      */
-    isValidAggregationExpression(expression: string, module: AdaptableModule, validationErrorMessage?: string): boolean;
+    isValidAggregatedBooleanExpression(expression: string, module: AdaptableModule, validationErrorMessage?: string): boolean;
     /**
-     * Returns all Columns referenced in a Query
-     * @param adaptableQuery Query to check
+     * Returns all Columns referenced in a QueryExpression
+     * @param expression - expression to check
      */
     getColumnsFromExpression(expression: string): string[];
     /**

package/src/Api/SettingsPanelApi.d.ts

@@ -0,0 +1,17 @@
+import { AdaptableModule } from '../../types';
+/**
+ * Provides run-time access to the Settings Panel
+ **/
+export interface SettingsPanelApi {
+    /**
+     * Opens settings panel to specified module,
+     * when not specified it opens the first available module
+     * @param moduleName module name
+     */
+    showSettingsPanel(moduleName?: AdaptableModule): void;
+    /**
+     * Opens a the settings panel to the custom module
+     * @param name name of the custom settings panel
+     */
+    showCustomSettingsPanel(name: string): void;
+}

package/src/Api/SettingsPanelApi.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/src/Api/UserInterfaceApi.d.ts

@@ -25,13 +25,16 @@ export interface UserInterfaceApi {
      */
     getPermittedValuesForColumn(column: AdaptableColumn): any[];
     /**
-     * Retrieves Permitted values for filtering by column values in Floating Filter and dropdown Filter.
+     * Retrieves Permitted values for filtering by column values in Floating Filter and Quick Filter Bar
      */
     getFilterPermittedValuesForColumn(column: AdaptableColumn): FilterPermittedValues | undefined;
     /**
-     * Retrieves Permitted values for Custom sort.
+     * Retrieves Permitted values for Custom Sort Module
      */
     getCustomSortPermittedValuesForColumn(column: AdaptableColumn): CustomSortPermittedValues | undefined;
+    /**
+     * Retrieves Permitted values for Bulk Update Module
+     */
     getBulkUpdatePermittedValuesForColumn(column: AdaptableColumn): BulkUpdatePermittedValues | undefined;
     /**
      * Retrieves `editLookUpItems` property from User Interface Options

package/src/PredefinedConfig/AlertState.d.ts

@@ -8,19 +8,17 @@ import { AdaptableButton, ButtonContext } from './Common/AdaptableButton';
 import { SuspendableObject } from './Common/SuspendableObject';
 import { AdaptableStyle } from './Common/AdaptableStyle';
 import { XOR } from '../Utilities/Extensions/TypeExtensions';
-import { AdaptableAggregationQuery, AdaptableBooleanQuery, AdaptableObservableQuery } from './Common/AdaptableQuery';
+import { AdaptableAggregatedBooleanQuery, AdaptableBooleanQuery, AdaptableObservableQuery } from './Common/AdaptableQuery';
 import { ButtonStyle } from './Common/ButtonStyle';
-import { AlertButtonContext } from '../AdaptableOptions/NotificationsOptions';
+import { AlertButtonContext } from '../types';
 /**
  * Predefined Configuration for Alert Module
  */
 export interface AlertState extends ConfigState {
     /**
      * Alert Definitions - will trigger Alerts when rule is met
-     * @defaultValue  null
      */
     AlertDefinitions?: AlertDefinition[];
-    FlashingAlertDefinitions?: any[];
 }
 /**
  * The Alert Definition object used in the Alert function
@@ -62,7 +60,7 @@ export interface AlertDefinitionPredicate extends AdaptablePredicate {
  */
 export declare type AlertRule = XOR<{
     Predicate: AlertDefinitionPredicate;
-}, XOR<AdaptableBooleanQuery, XOR<AdaptableObservableQuery, AdaptableAggregationQuery>>>;
+}, XOR<AdaptableBooleanQuery, XOR<AdaptableObservableQuery, AdaptableAggregatedBooleanQuery>>>;
 export declare type AdaptableAlertAction = 'highlight-cell' | 'jump-to-cell' | 'jump-to-row' | 'jump-to-column' | 'suspend' | 'undo';
 /**
  * Defines a button that appears in an Alert Form
@@ -116,7 +114,7 @@ export interface AlertProperties {
     LogToConsole?: boolean;
     /**
      * Automatically prevent any cell edit which triggered the Alert (i.e. validation)
-     * @default false
+     * @defaultValue false
      */
     PreventEdit?: boolean;
 }

package/src/PredefinedConfig/CalculatedColumnState.d.ts

@@ -8,7 +8,6 @@ import { SpecialColumnSettings } from './Common/SpecialColumnSettings';
 export interface CalculatedColumnState extends ConfigState {
     /**
      * Collection of Calculated Columns
-     * @defaultValue  empty
      */
     CalculatedColumns?: CalculatedColumn[];
 }