@adaptabletools/adaptable 10.0.1 → 10.0.4-canary.1

package/src/Api/Events/AdaptableReady.d.ts

@@ -1,14 +1,10 @@
-import { AdaptableApi } from '../AdaptableApi';
+import { BaseEventInfo } from './BaseEventInfo';
 /**
  * Object returned by `AdaptableReady` event - fired when AdapTable has loaded
  */
-export interface AdaptableReadyInfo {
+export interface AdaptableReadyInfo extends BaseEventInfo {
     /**
      * Instance of the underlying vendor grid (e.g. for AG Grid its the GridOptions object)
      */
     vendorGrid: any;
-    /**
-     * Adaptable API object used for runtime programmatic access to AdapTable
-     */
-    adaptableApi: AdaptableApi;
 }

package/src/Api/Events/AdaptableStateChanged.d.ts

@@ -1,9 +1,10 @@
 import * as Redux from 'redux';
 import { AdaptableState } from '../../PredefinedConfig/AdaptableState';
+import { BaseEventInfo } from './BaseEventInfo';
 /**
  * Object returned by the `AdaptableStateChanged` event
  */
-export interface AdaptableStateChangedInfo {
+export interface AdaptableStateChangedInfo extends BaseEventInfo {
     /**
      * Name of the Action
      */

package/src/Api/Events/AlertFired.d.ts

@@ -1,8 +1,9 @@
 import { AdaptableAlert } from '../../PredefinedConfig/Common/AdaptableAlert';
+import { BaseEventInfo } from './BaseEventInfo';
 /**
  * Object returned by the `AlertFired` event
  */
-export interface AlertFiredInfo {
+export interface AlertFiredInfo extends BaseEventInfo {
     /**
      * Alert which has been fired
      */

package/src/Api/Events/BaseEventInfo.d.ts

@@ -0,0 +1,10 @@
+import { AdaptableApi } from '../AdaptableApi';
+/**
+ * Base Object returned by all events - contains the Adaptable API
+ */
+export interface BaseEventInfo {
+    /**
+     * Adaptable API object used for runtime programmatic access to AdapTable
+     */
+    adaptableApi: AdaptableApi;
+}

package/src/Api/Events/CellChanged.d.ts

@@ -1,8 +1,9 @@
 import { DataChangedInfo } from '../../PredefinedConfig/Common/DataChangedInfo';
+import { BaseEventInfo } from './BaseEventInfo';
 /**
  * EventInfo returned by CellChanged event
  */
-export interface CellChangedInfo {
+export interface CellChangedInfo extends BaseEventInfo {
     /**
      * Object providing full information of the cell (and column and row) that changed
      */

package/src/Api/Events/ChexboxColumnClicked.d.ts

@@ -1,8 +1,9 @@
 import { AdaptableColumn } from '../../PredefinedConfig/Common/AdaptableColumn';
+import { BaseEventInfo } from './BaseEventInfo';
 /**
  * Event Info published by CheckboxColumnClicked event
  */
-export interface CheckboxColumnClickedInfo {
+export interface CheckboxColumnClickedInfo extends BaseEventInfo {
     /**
      * Name of Column where Checkbox was clicked
      */

package/src/Api/Events/CustomToolbarConfigured.d.ts

@@ -1,8 +1,9 @@
 import { CustomToolbar } from '../../AdaptableOptions/DashboardOptions';
+import { BaseEventInfo } from './BaseEventInfo';
 /**
  * EventInfo returned by the CustomToolbarConfigured event
  */
-export interface CustomToolbarConfiguredInfo {
+export interface CustomToolbarConfiguredInfo extends BaseEventInfo {
     /**
      * Custom Toolbar in which the 'Configure' button has been clicked
      */

package/src/Api/Events/DashboardChanged.d.ts

@@ -1,8 +1,9 @@
 import { DashboardState } from '../../PredefinedConfig/DashboardState';
+import { BaseEventInfo } from './BaseEventInfo';
 /**
  * Object returned by the `DashboardChanged` event
  */
-export interface DashboardChangedInfo {
+export interface DashboardChangedInfo extends BaseEventInfo {
     /**
      * What caused Dashboard State to change
      */

package/src/Api/Events/FlashingAlertFired.d.ts

@@ -1,8 +1,9 @@
 import { AdaptableFlashingAlert } from '../../PredefinedConfig/Common/AdaptableFlashingAlert';
+import { BaseEventInfo } from './BaseEventInfo';
 /**
  * Object returned by the `FlashingAlertFired` event
  */
-export interface FlashingAlertFiredInfo {
+export interface FlashingAlertFiredInfo extends BaseEventInfo {
     /**
      * FlashingAlert which has been fired
      */

package/src/Api/Events/GridDataChanged.d.ts

@@ -1,7 +1,8 @@
+import { BaseEventInfo } from './BaseEventInfo';
 /**
  * EventInfo returned by GridDataChanged event
  */
-export interface GridDataChangedInfo {
+export interface GridDataChangedInfo extends BaseEventInfo {
     /**
      * Rows that have been added, updated, or deleted
      */

package/src/Api/Events/LayoutChanged.d.ts

@@ -1,8 +1,9 @@
 import { LayoutState } from '../../PredefinedConfig/LayoutState';
+import { BaseEventInfo } from './BaseEventInfo';
 /**
  * EventInfo returned by LayoutChanged event
  */
-export interface LayoutChangedInfo {
+export interface LayoutChangedInfo extends BaseEventInfo {
     /**
      * What caused Layout State to change
      */

package/src/Api/Events/LiveDataChanged.d.ts

@@ -1,8 +1,9 @@
 import { Report } from '../../PredefinedConfig/ExportState';
+import { BaseEventInfo } from './BaseEventInfo';
 /**
  * EventInfo returned by LiveDataChanged event
  */
-export interface LiveDataChangedInfo {
+export interface LiveDataChangedInfo extends BaseEventInfo {
     /**
      * Which Adaptable partner is the export destination for the live data
      */

package/src/Api/Events/SearchChanged.d.ts

@@ -2,10 +2,11 @@ import { DataSource } from '../../PredefinedConfig/DataSourceState';
 import { CustomSort } from '../../PredefinedConfig/CustomSortState';
 import { ColumnSort } from '../../PredefinedConfig/Common/ColumnSort';
 import { ColumnFilter } from '../../PredefinedConfig/FilterState';
+import { BaseEventInfo } from './BaseEventInfo';
 /**
  * EventInfo returned by SearchChanged event; includes full AdapTable search and sort info plus the event's trigger
  */
-export interface SearchChangedInfo {
+export interface SearchChangedInfo extends BaseEventInfo {
     /**
      * What action caused event to fire: DataSource, CurrentQuery, Filter, DataChange or Sort
      */

package/src/Api/Events/SelectionChanged.d.ts

@@ -1,9 +1,10 @@
 import { SelectedCellInfo } from '../../PredefinedConfig/Selection/SelectedCellInfo';
 import { SelectedRowInfo } from '../../PredefinedConfig/Selection/SelectedRowInfo';
+import { BaseEventInfo } from './BaseEventInfo';
 /**
  * Event Info published by SelectionChanged event
  */
-export interface SelectionChangedInfo {
+export interface SelectionChangedInfo extends BaseEventInfo {
     /**
      * Details of cells currently selected in the Grid
      */

package/src/Api/Events/SystemStatusMessageDisplayed.d.ts

@@ -1,8 +1,9 @@
 import { SystemStatusMessageInfo } from '../../PredefinedConfig/Common/SystemStatusMessageInfo';
+import { BaseEventInfo } from './BaseEventInfo';
 /**
  * Object returned by the `SystemStatusMessageDisplayed' event
  */
-export interface SystemStatusMessageDisplayedInfo {
+export interface SystemStatusMessageDisplayedInfo extends BaseEventInfo {
     /**
      * Details of the System Status Message and Type
      */

package/src/Api/Events/TeamSharingEntityChanged.d.ts

@@ -1,8 +1,9 @@
 import { SharedEntity } from '../../PredefinedConfig/TeamSharingState';
+import { BaseEventInfo } from './BaseEventInfo';
 /**
  * EventInfo returned by TeamSharingEntityChanged event
  */
-export interface TeamSharingEntityChangedInfo {
+export interface TeamSharingEntityChangedInfo extends BaseEventInfo {
     /**
      * Object containing the Shared Entity that has changed
      */

package/src/Api/Events/ThemeChanged.d.ts

@@ -1,8 +1,9 @@
 import { AdaptableTheme } from '../../PredefinedConfig/ThemeState';
+import { BaseEventInfo } from './BaseEventInfo';
 /**
  * Object returned by the `ThemeChanged` event
  */
-export interface ThemeChangedInfo {
+export interface ThemeChangedInfo extends BaseEventInfo {
     /**
      * Selected Theme: either name of a (System) theme or the (Custom) Theme itself
      */

package/src/Api/GridApi.d.ts

@@ -23,6 +23,14 @@ export interface GridApi {
      * @param data any data from any datasource that is suitable for the underlying grid.
      */
     setGridData(data: any): void;
+    /**
+     * Retrieves all data from the grid
+     */
+    getGridData(): any[];
+    /**
+     * Retrieves filtered data from the grid
+     */
+    getFilteredData(): any[];
     /**
      * Loads grid with given data
      * @param data any data from any datasource that is suitable for the underlying grid.
@@ -55,6 +63,15 @@ export interface GridApi {
      *
      */
     setCellValue(columnId: string, newValue: any, primaryKeyValue: any, forceFilter: boolean): void;
+    /**
+     * Updates multiple cells
+     * @param gridCells cells to update
+     */
+    setCellsValue(gridCells: {
+        columnId: any;
+        newValue: any;
+        primaryKeyValue: any;
+    }[]): void;
     /**
      * Reverses a data change (if triggered by cell edit)
      * @param dataChangedInfo data change to undo
@@ -185,10 +202,10 @@ export interface GridApi {
     getPrimaryKeyValueForRowNode(rowNode: RowNode): any;
     /**
      * Retrieves Cell in given Row and Column
-     * @param rowwNode Row to use
+     * @param rowNode Row to use
      * @param columnId ColumnId to lookup
      */
-    getGridCellFromRowNode(rowwNode: RowNode, columnId: string): GridCell | undefined;
+    getGridCellFromRowNode(rowNode: RowNode, columnId: string): GridCell | undefined;
     /**
      * Retrieves Display Value for a given cell
      * @param primaryKeyValue (unique) value in Primary Key Column
@@ -209,10 +226,10 @@ export interface GridApi {
     getCellNormalisedValue(primaryKeyValue: any, columnId: string): any | undefined;
     /**
      * Retrieves Raw Value for Cell in given Row and Column
-     * @param rowwNode Row to use
+     * @param rowNode Row to use
      * @param columnId ColumnId to lookup
      */
-    getRawValueFromRowNode(rowwNode: RowNode, columnId: string): any | undefined;
+    getRawValueFromRowNode(rowNode: RowNode, columnId: string): any | undefined;
     /**
      * Retrieves Formatted Value for a given Raw Value in given Column
      * @param columnId ColumnId to lookup
@@ -221,16 +238,16 @@ export interface GridApi {
     getFormattedValueFromRawValue(columnId: string, rawValue: any): string | undefined;
     /**
      * Retrieves Display Value for Cell in given Row and Column
-     * @param rowwNode Row to use
+     * @param rowNode Row to use
      * @param columnId ColumnId to lookup
      */
-    getDisplayValueFromRowNode(rowwNode: RowNode, columnId: string): any | undefined;
+    getDisplayValueFromRowNode(rowNode: RowNode, columnId: string): any | undefined;
     /**
      * Retrieves Normalised Value for Cell in given Row and Column
-     * @param rowwNode Row to use
+     * @param rowNode Row to use
      * @param columnId ColumnId to lookup
      */
-    getNormalisedValueFromRowNode(rowwNode: RowNode, columnId: string): any | undefined;
+    getNormalisedValueFromRowNode(rowNode: RowNode, columnId: string): any | undefined;
     /**
      * Sets the grid to Row Group
      * @param columnIds ColumnIds to row group
@@ -335,6 +352,11 @@ export interface GridApi {
      * @param columnIds ColumnIds which contain cells to refresh
      */
     refreshCells(rowNodes: RowNode[], columnIds: string[]): void;
+    /**
+     * Forces a render of a row
+     * @param primaryKey row primary key
+     */
+    refreshRow(primaryKey: any): void;
     /**
      * Returns number of rows in Data Source
      */
@@ -373,4 +395,8 @@ export interface GridApi {
      * Deselects all selected rows, cells and ranges
      */
     deselectAll(): void;
+    /**
+     * Returns the Grid Container in which the Adaptable Instance is present
+     */
+    getGridContainerElement(): HTMLElement | null;
 }

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

@@ -54,6 +54,6 @@ export declare class AlertApiImpl extends ApiBase implements AlertApi {
     unSuspendFlashingAlertDefinition(flashingAlertDefinition: FlashingAlertDefinition): FlashingAlertDefinition;
     addFlashingAlertDefinitions(flashingAlertDefinitions: FlashingAlertDefinition[]): FlashingAlertDefinition[];
     editFlashingAlertDefinitions(flashingAlertDefinitions: FlashingAlertDefinition[]): FlashingAlertDefinition[];
-    getAlertDescription(alert: AlertDefinition): string;
+    getAlertDescription(alertDefinition: AlertDefinition, dataChangedInfo?: DataChangedInfo): string;
     getAlertRuleDescription(alert: BaseAlertDefinition): string;
 }

package/src/Api/Implementation/AlertApiImpl.js

@@ -117,7 +117,7 @@ class AlertApiImpl extends ApiBase_1.ApiBase {
         }
         if (actionName === 'highlight-cell') {
             this.adaptable.api.gridApi.highlightCell({
-                columnId: dataChangedInfo.columnId,
+                columnId: dataChangedInfo.column.columnId,
                 primaryKeyValue: dataChangedInfo.primaryKeyValue,
                 highlightType: alertDefinition.MessageType,
                 timeout: this.getNotificationsOptions().cellHighlightDuration,
@@ -125,11 +125,11 @@ class AlertApiImpl extends ApiBase_1.ApiBase {
             return;
         }
         if (actionName === 'jump-to-cell') {
-            this.adaptable.api.gridApi.jumpToCell(dataChangedInfo.primaryKeyValue, dataChangedInfo.columnId);
+            this.adaptable.api.gridApi.jumpToCell(dataChangedInfo.primaryKeyValue, dataChangedInfo.column.columnId);
             return;
         }
         if (actionName === 'jump-to-column') {
-            this.adaptable.api.gridApi.jumpToColumn(dataChangedInfo.columnId);
+            this.adaptable.api.gridApi.jumpToColumn(dataChangedInfo.column.columnId);
             return;
         }
         if (actionName === 'suspend') {
@@ -159,6 +159,7 @@ class AlertApiImpl extends ApiBase_1.ApiBase {
     showFlashingAlert(alertToShow) {
         this.addUidToAdaptableObject(alertToShow);
         const flashingAlertFiredInfo = {
+            adaptableApi: this.adaptable.api,
             flashingAlert: alertToShow,
         };
         const results = this.adaptable.api.eventApi.emitSync('FlashingAlertFired', flashingAlertFiredInfo);
@@ -181,9 +182,7 @@ class AlertApiImpl extends ApiBase_1.ApiBase {
         this.addUidToAdaptableObject(alertToShow);
         this.dispatchAction(SystemRedux.SystemAlertAdd(alertToShow, this.getNotificationsOptions().maxAlertsInStore));
         // 2. Publish the Alert Fired Event
-        const alertFiredInfo = {
-            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;
@@ -212,7 +211,7 @@ class AlertApiImpl extends ApiBase_1.ApiBase {
             }
             // 4: Jump to the Cell
             if (alertProperties.JumpToCell && dataChangedInfo) {
-                this.adaptable.jumpToCell(dataChangedInfo.columnId, dataChangedInfo.rowNode);
+                this.adaptable.jumpToCell(dataChangedInfo.column.columnId, dataChangedInfo.rowNode);
             }
             // 5: Hight the cell - though that is taken care of in the Style Service
             if (alertProperties.HighlightCell && dataChangedInfo) {
@@ -221,7 +220,7 @@ class AlertApiImpl extends ApiBase_1.ApiBase {
                     alertNode = this.adaptable.getRowNodeForPrimaryKey(dataChangedInfo.primaryKeyValue);
                 }
                 if (alertNode) {
-                    this.adaptable.api.gridApi.refreshCells([alertNode], [dataChangedInfo.columnId]);
+                    this.adaptable.api.gridApi.refreshCells([alertNode], [dataChangedInfo.column.columnId]);
                     setTimeout(() => {
                         this.dispatchAction(SystemRedux.SystemAlertRemoveHighlight(alertToShow));
                     }, this.adaptable.adaptableOptions.notificationsOptions.cellHighlightDuration);
@@ -233,9 +232,7 @@ class AlertApiImpl extends ApiBase_1.ApiBase {
         }
     }
     publishAlertFiredEvent(alertToFire) {
-        const alertFiredInfo = {
-            alert: alertToFire,
-        };
+        const alertFiredInfo = { adaptableApi: this.adaptable.api, alert: alertToFire };
         this.adaptable.api.eventApi.emit('AlertFired', alertFiredInfo);
     }
     displayMessageAlertPopup(alertToDisplayAsPopup) {
@@ -284,7 +281,6 @@ class AlertApiImpl extends ApiBase_1.ApiBase {
     }
     addFlashingAlertDefinition(flashingAlertDefinition) {
         this.dispatchAction(AlertRedux.FlashingAlertDefinitionAdd(flashingAlertDefinition));
-        console.log('flasing alert', flashingAlertDefinition);
         return this.getFlashingAlertDefinitionById(flashingAlertDefinition.Uuid);
     }
     editFlashingAlertDefinition(flashingAlertDefinition) {
@@ -311,9 +307,20 @@ class AlertApiImpl extends ApiBase_1.ApiBase {
         });
         return flashingAlertDefinitions === null || flashingAlertDefinitions === void 0 ? void 0 : flashingAlertDefinitions.map((alert) => this.getFlashingAlertDefinitionById(alert === null || alert === void 0 ? void 0 : alert.Uuid));
     }
-    getAlertDescription(alert) {
-        let scopeDescription = this.adaptable.api.scopeApi.getScopeDescription(alert.Scope);
-        let ruleDescription = this.getAlertRuleDescription(alert);
+    getAlertDescription(alertDefinition, dataChangedInfo) {
+        var _a;
+        const alertMessageFunction = (_a = this.adaptable.adaptableOptions.notificationsOptions) === null || _a === void 0 ? void 0 : _a.alertMessageText;
+        if (alertMessageFunction) {
+            const returnText = alertMessageFunction(alertDefinition, dataChangedInfo);
+            if (returnText) {
+                return returnText;
+            }
+        }
+        if (alertDefinition.MessageText != null) {
+            return alertDefinition.MessageText;
+        }
+        let scopeDescription = this.adaptable.api.scopeApi.getScopeDescription(alertDefinition.Scope);
+        let ruleDescription = this.getAlertRuleDescription(alertDefinition);
         return scopeDescription + ' - ' + ruleDescription;
     }
     getAlertRuleDescription(alert) {

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

@@ -13,4 +13,7 @@ export declare class CalculatedColumnApiImpl extends ApiBase implements Calculat
     deleteCalculatedColumn(column: string): void;
     showCalculatedColumnPopup(): void;
     getCalculatedColumnModuleReferences(calculatedColumn: CalculatedColumn): string[];
+    getCalculatedColumnsReferencingColumnId(columnId: string): CalculatedColumn[];
+    getReferencedColumnIdsForCalculatedColumn(calculatedColumn: CalculatedColumn): string[];
+    getReferencedColumnIdsForCalculatedColumnId(calculatedColumnId: string): string[];
 }

package/src/Api/Implementation/CalculatedColumnApiImpl.js

@@ -60,5 +60,28 @@ class CalculatedColumnApiImpl extends ApiBase_1.ApiBase {
         });
         return references;
     }
+    getCalculatedColumnsReferencingColumnId(columnId) {
+        var calcColumns = [];
+        this.getAllCalculatedColumn().forEach((calculatedColumn) => {
+            var _a;
+            if (this.adaptable.api.columnApi.isColumnReferencedInExpression(columnId, (_a = calculatedColumn.Query) === null || _a === void 0 ? void 0 : _a.ScalarExpression)) {
+                calcColumns.push(calculatedColumn);
+            }
+        });
+        return calcColumns;
+    }
+    getReferencedColumnIdsForCalculatedColumn(calculatedColumn) {
+        var _a;
+        const columnIds = this.adaptable.api.queryLanguageApi.getColumnsFromExpression((_a = calculatedColumn.Query) === null || _a === void 0 ? void 0 : _a.ScalarExpression);
+        return columnIds;
+    }
+    getReferencedColumnIdsForCalculatedColumnId(calculatedColumnId) {
+        const calculatedColumn = this.adaptable.api.calculatedColumnApi
+            .getAllCalculatedColumn()
+            .find((cc) => cc.ColumnId == calculatedColumnId);
+        if (calculatedColumn) {
+            return this.getReferencedColumnIdsForCalculatedColumn(calculatedColumn);
+        }
+    }
 }
 exports.CalculatedColumnApiImpl = CalculatedColumnApiImpl;

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

@@ -2,6 +2,7 @@ import { ApiBase } from './ApiBase';
 import { AdaptableColumn } from '../../PredefinedConfig/Common/AdaptableColumn';
 import { DataType } from '../../PredefinedConfig/Common/Enums';
 import { ColumnApi } from '../ColumnApi';
+import { GridCell } from '../../PredefinedConfig/Selection/GridCell';
 import { RowNode } from '@ag-grid-community/all-modules';
 export declare class ColumnApiImpl extends ApiBase implements ColumnApi {
     getColumns(): AdaptableColumn[];
@@ -49,6 +50,12 @@ export declare class ColumnApiImpl extends ApiBase implements ColumnApi {
     getQueryableColumns(): AdaptableColumn[];
     private LogMissingColumnWarning;
     getDistinctDisplayValuesForColumn(columnId: string): any[];
+    getDistinctFilterDisplayValuesForColumn(columnId: string, filter: string): Promise<{
+        values: any[];
+        suppressClientSideFilter: boolean;
+    }>;
+    getDistinctCustomSortDisplayValuesForColumn(columnId: string): Promise<any[]>;
+    getDistinctBulkUpdateDisplayValuesForColumn(columnId: string, selectedGridCells: GridCell[]): Promise<any[]>;
     getDistinctVisibleDisplayValuesForColumn(columnId: string): any[];
     getDistinctRawValuesForColumn(columnId: string, skipRowNode?: RowNode): any[];
     getDistinctVisibleRawValuesForColumn(columnId: string): any[];
@@ -57,4 +64,5 @@ export declare class ColumnApiImpl extends ApiBase implements ColumnApi {
     getAllColumnFriendlyNames(): string[];
     usesAdaptableFilterForm(columnId: string): boolean;
     usesAdaptableQuickFilter(columnId: string): boolean;
+    isColumnReferencedInExpression(columnId: string, expression: string): boolean;
 }