@adaptabletools/adaptable 10.0.4-canary.0 → 10.0.4-canary.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adaptabletools/adaptable",
-  "version": "10.0.4-canary.0",
+  "version": "10.0.4-canary.1",
   "description": "Powerful data-agnostic HTML5 datagrid add-on that sits on top of an underlying grid component and provides all the rich functionality that advanced users expect from their DataGrids and Data Tables",
   "main": "index.js",
   "typings": "index.d.ts",

package/publishTimestamp.d.ts

@@ -1,2 +1,2 @@
-declare const _default: 1637745164610;
+declare const _default: 1637827862614;
 export default _default;

package/publishTimestamp.js

@@ -1,3 +1,3 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.default = 1637745164610;
+exports.default = 1637827862614;

package/src/AdaptableOptions/NotificationsOptions.d.ts

@@ -1,7 +1,8 @@
-import { AlertButton, FlashingAlertProperties } from '../PredefinedConfig/AlertState';
+import { AlertButton, AlertDefinition, FlashingAlertProperties } from '../PredefinedConfig/AlertState';
 import { AdaptableAlert } from '../PredefinedConfig/Common/AdaptableAlert';
 import { ButtonContext } from '../PredefinedConfig/Common/AdaptableButton';
 import { AdaptableForm, AdaptableFormData } from '../PredefinedConfig/Common/AdaptableForm';
+import { DataChangedInfo } from '../types';
 /**
  * Options related to Alerts, System Status Messages and Notifications in Adaptable.
  */
@@ -111,6 +112,7 @@ export interface NotificationsOptions {
      * @gridInfoItem
      */
     maxSystemMessagesInStore?: number;
+    alertMessageText?: (alertDefinition: AlertDefinition, dataChangedInfo?: DataChangedInfo) => string | undefined;
 }
 /**
  * Handles a Form Button Action

package/src/AdaptableOptions/UserInterfaceOptions.d.ts

@@ -6,7 +6,7 @@ import { AdaptableButton, ButtonContext } from '../PredefinedConfig/Common/Adapt
 import { RowNode } from '@ag-grid-community/all-modules';
 import { AdaptableObject } from '../PredefinedConfig/Common/AdaptableObject';
 import { AdaptableStyle } from '../PredefinedConfig/Common/AdaptableStyle';
-import { GridCell } from '../../types';
+import { AdaptableApi, GridCell } from '../../types';
 /**
  * Options for managing the User Interface of AdapTable
  */
@@ -95,13 +95,13 @@ export interface PermittedValues extends BasePermittedValues {
     /**
      * Values to display: either hardcoded list or a function
      */
-    values?: any[] | ((column: AdaptableColumn) => any[]);
+    values?: any[] | ((params: PermittedValuesParams) => any[]);
 }
 /**
  * Used to define permitted values for inline column editor
  */
 export interface EditLookUpPermittedValues extends BasePermittedValues {
-    values?: any[] | ((column: AdaptableColumn, gridCell: GridCell) => any[]);
+    values?: any[] | ((params: EditLookUpParams) => any[]);
 }
 /**
  * Used to define values inside the floating filter and floating filter (quick filter)
@@ -112,19 +112,19 @@ export interface FilterPermittedValues extends BasePermittedValues {
      * @default false
      */
     suppressClientSideFiltering?: boolean;
-    values: (column: AdaptableColumn, filter: string) => any[] | Promise<any[]>;
+    values: (params: FilterPermittedValuesParams) => any[] | Promise<any[]>;
 }
 /**
  * Custom column values for custom sort.
  */
 export interface CustomSortPermittedValues extends BasePermittedValues {
-    values: (column: AdaptableColumn) => any[] | Promise<any[]>;
+    values: (params: PermittedValuesParams) => any[] | Promise<any[]>;
 }
 /**
  * User to define permitted values when updating cells via bulk update
  */
 export interface BulkUpdatePermittedValues extends BasePermittedValues {
-    values: (column: AdaptableColumn, selectedGridCells: GridCell[]) => any[] | Promise<any[]>;
+    values: (params: BulkUpdatePermittedValuesParams) => any[] | Promise<any[]>;
 }
 /**
  * Use PermittedValues instead
@@ -197,3 +197,21 @@ export interface ActionColumnSettings {
      */
     suppressMovable?: boolean;
 }
+export interface BaseParams {
+    adaptableApi: AdaptableApi;
+}
+export interface EditLookUpParams extends BaseParams {
+    column: AdaptableColumn;
+    gridCell: GridCell;
+}
+export interface PermittedValuesParams extends BaseParams {
+    column: AdaptableColumn;
+}
+export interface FilterPermittedValuesParams extends BaseParams {
+    column: AdaptableColumn;
+    filter: string;
+}
+export interface BulkUpdatePermittedValuesParams extends BaseParams {
+    column: AdaptableColumn;
+    gridCells: GridCell[];
+}

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/BaseEventInfo.js

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

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/Implementation/AlertApiImpl.js

@@ -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;
@@ -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) {
@@ -311,14 +308,17 @@ 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(alertDefinition, dataChangedInfo) {
-        if (alertDefinition.MessageText != null) {
-            if (typeof alertDefinition.MessageText === 'function') {
-                return alertDefinition.MessageText(alertDefinition.Scope, alertDefinition.Rule, dataChangedInfo);
-            }
-            else {
-                return alertDefinition.MessageText;
+        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;

package/src/Api/Implementation/DashboardApiImpl.js

@@ -18,6 +18,7 @@ class DashboardApiImpl extends ApiBase_1.ApiBase {
         // so we debounced to only get tha latest call
         this.fireDashboardChangedEvent = (trigger, oldDashboardState, newDashboardState) => {
             const dashboardChangedInfo = {
+                adaptableApi: this.adaptable.api,
                 actionName: trigger,
                 oldDashboardState: oldDashboardState,
                 newDashboardState: newDashboardState,
@@ -39,7 +40,7 @@ class DashboardApiImpl extends ApiBase_1.ApiBase {
     getCustomDashboardButtonByLabel(buttonLabel) {
         const api = this.getAdaptableApi();
         const dashboardContext = {
-            api,
+            adaptableApi: api,
             dashboardState: api.dashboardApi.getDashboardState(),
         };
         return this.getDashboardOptions().customDashboardButtons.find((cb) => {

package/src/Api/Implementation/FormatColumnApiImpl.js

@@ -256,6 +256,7 @@ class FormatColumnApiImpl extends ApiBase_1.ApiBase {
     }
     fireCheckboxColumnClickedEvent(columnId, rowData, primaryKeyValue, isChecked) {
         let checkboxColumnClickedInfo = {
+            adaptableApi: this.adaptable.api,
             column: this.adaptable.api.columnApi.getColumnFromId(columnId),
             rowData: rowData,
             primaryKeyValue: primaryKeyValue,

package/src/Api/Implementation/GridApiImpl.js

@@ -230,6 +230,7 @@ class GridApiImpl extends ApiBase_1.ApiBase {
             const adaptableSearchState = this.adaptable.api.configApi.getAdaptableSearchState();
             const adaptableSortState = this.adaptable.api.configApi.getAdaptableSortState();
             const searchChangedInfo = {
+                adaptableApi: this.adaptable.api,
                 searchChangedTrigger,
                 adaptableSearchState: adaptableSearchState,
                 adaptableSortState: adaptableSortState,
@@ -240,6 +241,7 @@ class GridApiImpl extends ApiBase_1.ApiBase {
     fireCellChangedEvent(dataChangedInfo) {
         if (this.adaptable.isInitialised) {
             const cellChangedInfo = {
+                adaptableApi: this.adaptable.api,
                 cellChange: dataChangedInfo,
             };
             this.adaptable.api.eventApi.emit('CellChanged', cellChangedInfo);
@@ -248,6 +250,7 @@ class GridApiImpl extends ApiBase_1.ApiBase {
     fireGridDataChangedEvent(dataRows, rowTigger) {
         if (this.adaptable.isInitialised) {
             const gridDataChangedInfo = {
+                adaptableApi: this.adaptable.api,
                 rowTigger: rowTigger,
                 dataRows: dataRows,
             };

package/src/Api/Implementation/LayoutApiImpl.js

@@ -50,6 +50,7 @@ class LayoutApiImpl extends ApiBase_1.ApiBase {
     }
     fireLayoutChangedEvent(trigger, oldSate, newState) {
         const layoutChangedInfo = {
+            adaptableApi: this.adaptable.api,
             actionName: trigger,
             oldLayoutState: oldSate,
             newLayoutState: newState,

package/src/Api/Implementation/SystemStatusApiImpl.js

@@ -80,6 +80,7 @@ class SystemStatusApiImpl extends ApiBase_1.ApiBase {
     }
     fireSystemStatusMessageDisplayedEvent(systemStatusMessageInfo) {
         const systemStatusMessageDisplayedInfo = {
+            adaptableApi: this.adaptable.api,
             systemStatusMessageInfo: systemStatusMessageInfo,
         };
         this.adaptable.api.eventApi.emit('SystemStatusMessageDisplayed', systemStatusMessageDisplayedInfo);

package/src/Api/Implementation/TeamSharingApiImpl.js

@@ -35,6 +35,7 @@ class TeamSharingApiImpl extends ApiBase_1.ApiBase {
     fireTeamSharingEntityChangedEvent(sharedEntity) {
         if (this.adaptable.isInitialised) {
             const teamSharingEntityChangedInfo = {
+                adaptableApi: this.adaptable.api,
                 sharedEntity: sharedEntity,
             };
             this.adaptable.api.eventApi.emit('TeamSharingEntityChanged', teamSharingEntityChangedInfo);

package/src/Api/Implementation/ThemeApiImpl.js

@@ -48,6 +48,7 @@ class ThemeApiImpl extends ApiBase_1.ApiBase {
         }
         this.adaptable.applyAdaptableTheme(currentTheme);
         let themeChangedInfo = {
+            adaptableApi: this.adaptable.api,
             theme: currentTheme,
         };
         this.adaptable.api.eventApi.emit('ThemeChanged', themeChangedInfo);

package/src/Api/Implementation/UserInterfaceApiImpl.js

@@ -67,7 +67,11 @@ class UserInterfaceApiImpl extends ApiBase_1.ApiBase {
         // first do the function then get hardcoded items
         if (permittedValues != null && typeof permittedValues === 'function') {
             if (column) {
-                return permittedValues(column);
+                const permittedValuesParams = {
+                    adaptableApi: this.adaptable.api,
+                    column: column,
+                };
+                return permittedValues(permittedValuesParams);
             }
         }
         else {
@@ -131,7 +135,12 @@ class UserInterfaceApiImpl extends ApiBase_1.ApiBase {
         let editLookUpValues = editLookUpItem.values;
         // first do the function then get hardcoded items
         if (editLookUpValues != null && typeof editLookUpValues === 'function') {
-            return editLookUpValues(gridCell.column, gridCell);
+            const editLookUpParams = {
+                adaptableApi: this.adaptable.api,
+                column: gridCell.column,
+                gridCell: gridCell,
+            };
+            return editLookUpValues(editLookUpParams);
         }
         else {
             let arr = editLookUpValues;

package/src/PredefinedConfig/AlertState.d.ts

@@ -11,7 +11,6 @@ import { XOR } from '../Utilities/Extensions/TypeExtensions';
 import { AdaptableAggregationQuery, AdaptableBooleanQuery, AdaptableObservableQuery } from './Common/AdaptableQuery';
 import { ButtonStyle } from './Common/ButtonStyle';
 import { AlertButtonContext } from '../AdaptableOptions/NotificationsOptions';
-import { DataChangedInfo } from './Common/DataChangedInfo';
 /**
  * Predefined Configuration for Alert function
  */
@@ -86,7 +85,7 @@ export interface AlertDefinition extends BaseAlertDefinition {
     /**
      * Alert Message - can be string or function; if not provided AdapTable creates dynamically using Rule & Scope
      */
-    MessageText?: string | ((scope: AdaptableScope, rule: AlertRule, dataChangedInfo?: DataChangedInfo) => string);
+    MessageText?: string;
     /**
      * Series of properties which set what happens when Alert is triggered
      */

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

@@ -36,5 +36,5 @@ export interface AdaptableButton<CONTEXT_TYPE extends ButtonContext> extends Ada
     hidden?: (button: AdaptableButton<CONTEXT_TYPE>, context: CONTEXT_TYPE) => boolean;
 }
 export interface ButtonContext {
-    api: AdaptableApi;
+    adaptableApi: AdaptableApi;
 }

package/src/Utilities/Services/MetamodelService.js

@@ -16,7 +16,6 @@ class MetamodelService {
     buildGridInfoOptions() {
         const gridInfoOptions = new Map();
         const adaptableMetamodel = adaptable_metamodel_1.ADAPTABLE_METAMODEL;
-        console.log({ adaptableMetamodel });
         const adaptableOptionsMetamodel = adaptableMetamodel['AdaptableOptions'];
         const adaptableOptionsValues = this.adaptable.adaptableOptions;
         const adaptableOptionsDefaultValues = DefaultAdaptableOptions_1.DefaultAdaptableOptions;

package/src/Utilities/Services/ReportService.js

@@ -287,6 +287,7 @@ class ReportService {
     }
     PublishLiveLiveDataChangedEvent(reportDestination, liveDataTrigger, liveReport) {
         const liveDataChangedInfo = {
+            adaptableApi: this.adaptable.api,
             reportDestination: reportDestination,
             liveDataTrigger: liveDataTrigger,
             liveReport: liveReport,

package/src/View/Components/Popups/AdaptablePopupAlert.js

@@ -38,7 +38,7 @@ exports.AdaptablePopupAlert = (props) => {
     const context = React.useMemo(() => {
         return {
             alert: props.adaptableAlert,
-            api,
+            adaptableApi: api,
             formData: formData,
         };
     }, [JSON.stringify(formData), props.adaptableAlert]);

package/src/View/Components/ToolPanel/AdaptableToolPanel.js

@@ -180,7 +180,7 @@ const AdaptableToolPanelComponent = (props) => {
                 };
                 const iconProps = button.icon && Object.assign({}, defaultIconProps, button.icon);
                 const toolPanelContext = {
-                    api: props.api,
+                    adaptableApi: props.api,
                     toolPanelState: props.api.toolPanelApi.getToolPanelState(),
                 };
                 let buttonStyle = props.api.internalApi.getStyleForButton(button, toolPanelContext);

package/src/View/Components/ToolPanel/CustomToolPanelContent.js

@@ -48,7 +48,7 @@ exports.CustomToolPanelContent = (props) => {
             };
             const iconProps = button.icon && Object.assign({}, defaultIconProps, button.icon);
             const toolPanelContext = {
-                api,
+                adaptableApi: api,
                 toolPanelState: api.toolPanelApi.getToolPanelState(),
                 customToolPanel: customToolPanel,
             };

package/src/View/Dashboard/CustomToolbarWrapper.js

@@ -35,6 +35,7 @@ exports.CustomToolbarWrapper = (props) => {
     return (React.createElement(PanelDashboard_1.PanelDashboard, { className: `ab-CustomToolbar ab-DashboardToolbar__${props.customToolbar.name}`, "data-name": `ab-CustomToolbar ab-DashboardToolbar__${props.customToolbar.name}`, headerText: props.customToolbar.title ? props.customToolbar.title : '', showConfigureButton: props.customToolbar.showConfigureButton != null &&
             props.customToolbar.showConfigureButton == true, showCloseButton: props.customToolbar.showCloseButton != null && props.customToolbar.showCloseButton == true, onConfigure: () => {
             const customToolbarConfiguredInfo = {
+                adaptableApi: api,
                 customToolbar: props.customToolbar,
             };
             api.eventApi.emit('CustomToolbarConfigured', customToolbarConfiguredInfo);
@@ -48,7 +49,7 @@ exports.CustomToolbarWrapper = (props) => {
                 // with the next opportunity we should abstract it
                 const dashboardContext = {
                     customToolbar: props.customToolbar,
-                    api,
+                    adaptableApi: api,
                     dashboardState: api.dashboardApi.getDashboardState(),
                 };
                 let buttonStyle = api.internalApi.getStyleForButton(button, dashboardContext);

package/src/View/Dashboard/Dashboard.js

@@ -84,8 +84,7 @@ const DashboardComponent = (props) => {
     };
     const renderDashboardButtons = () => {
         var _a;
-        let dashboardButtonsArray = (_a = props.api.dashboardApi
-            .getCustomDashboardButtons()) === null || _a === void 0 ? void 0 : _a.filter((c) => c);
+        let dashboardButtonsArray = (_a = props.api.dashboardApi.getCustomDashboardButtons()) === null || _a === void 0 ? void 0 : _a.filter((c) => c);
         let customDashboardButtons = null;
         if (dashboardButtonsArray) {
             customDashboardButtons = dashboardButtonsArray.map((button) => {
@@ -103,7 +102,7 @@ const DashboardComponent = (props) => {
                 //      delete iconProps.Uuid;
                 //    }
                 const dashboardContext = {
-                    api: props.api,
+                    adaptableApi: props.api,
                     dashboardState: props.api.dashboardApi.getDashboardState(),
                 };
                 let buttonStyle = props.api.internalApi.getStyleForButton(button, dashboardContext);

package/src/View/DataChangeHistory/DataChangeHistoryGrid.js

@@ -104,7 +104,7 @@ const buildAdaptableOptions = (mainAdaptableInstance, gridOptions, adaptableCont
                     includeGroupedRows: true,
                     actionColumnButton: {
                         label: (button, context) => {
-                            if (context.api.gridApi.isGroupRowNode(context.rowNode)) {
+                            if (context.adaptableApi.gridApi.isGroupRowNode(context.rowNode)) {
                                 return 'Undo Group';
                             }
                             return 'Undo Change';
@@ -112,7 +112,7 @@ const buildAdaptableOptions = (mainAdaptableInstance, gridOptions, adaptableCont
                         onClick: (button, context) => {
                             var _a;
                             const rowNode = context.rowNode;
-                            if (context.api.gridApi.isGroupRowNode(rowNode)) {
+                            if (context.adaptableApi.gridApi.isGroupRowNode(rowNode)) {
                                 // undo all children
                                 const childrenNodes = (_a = context.rowNode) === null || _a === void 0 ? void 0 : _a.childrenAfterFilter;
                                 if (childrenNodes) {

package/src/View/Export/ExportCustomDestinationDialog.js

@@ -15,7 +15,7 @@ isOpen, onDismiss, }) {
     const adaptable = AdaptableContext_1.useAdaptable();
     const context = React.useMemo(() => {
         return {
-            api: adaptable.api,
+            adaptableApi: adaptable.api,
             report,
             reportData: undefined,
             customDestination,

package/src/agGrid/ActionColumnRenderer.js

@@ -40,7 +40,7 @@ class ActionColumnRenderer {
                 actionColumn: actionCol,
                 primaryKeyValue: pkValue,
                 rowNode: params.node,
-                api: adaptable.api,
+                adaptableApi: adaptable.api,
             };
             // if its a group node then only show if set to do so
             if (adaptable.api.gridApi.isGroupRowNode(params.node) && !actionCol.includeGroupedRows) {

package/src/agGrid/Adaptable.js

@@ -486,6 +486,7 @@ class Adaptable {
     performAudit(action, oldState, newState) {
         if (this.isInitialised) {
             const adaptableStateChangedInfo = {
+                adaptableApi: this.api,
                 actionName: action.type,
                 clientTimestamp: new Date(),
                 userName: this.adaptableOptions.userName,
@@ -1490,7 +1491,12 @@ class Adaptable {
         };
         let preparedPermittedValues = undefined;
         try {
-            preparedPermittedValues = await (permittedValues === null || permittedValues === void 0 ? void 0 : permittedValues.values(column, filter));
+            const filterPermittedValuesParams = {
+                adaptableApi: this.api,
+                column: column,
+                filter: filter,
+            };
+            preparedPermittedValues = await (permittedValues === null || permittedValues === void 0 ? void 0 : permittedValues.values(filterPermittedValuesParams));
         }
         catch (error) {
             LoggingHelper_1.ConsoleLogError(`Failed to load filter permitted values`, column, filter, error);
@@ -1504,7 +1510,11 @@ class Adaptable {
         const permittedValues = await this.api.userInterfaceApi.getCustomSortPermittedValuesForColumn(column);
         let preparedPermittedValues = undefined;
         try {
-            preparedPermittedValues = await (permittedValues === null || permittedValues === void 0 ? void 0 : permittedValues.values(column));
+            const permittedValuesParams = {
+                adaptableApi: this.api,
+                column: column,
+            };
+            preparedPermittedValues = await (permittedValues === null || permittedValues === void 0 ? void 0 : permittedValues.values(permittedValuesParams));
         }
         catch (error) {
             LoggingHelper_1.ConsoleLogError(`Failed to load custom sort permitted values`, column, error);
@@ -1515,7 +1525,12 @@ class Adaptable {
         const permittedValues = await this.api.userInterfaceApi.getBulkUpdatePermittedValuesForColumn(column);
         let preparedPermittedValues = undefined;
         try {
-            preparedPermittedValues = await (permittedValues === null || permittedValues === void 0 ? void 0 : permittedValues.values(column, selectedGridCells));
+            const bulkUpdatePermittedValuesParams = {
+                adaptableApi: this.api,
+                column: column,
+                gridCells: selectedGridCells,
+            };
+            preparedPermittedValues = await (permittedValues === null || permittedValues === void 0 ? void 0 : permittedValues.values(bulkUpdatePermittedValuesParams));
         }
         catch (error) {
             LoggingHelper_1.ConsoleLogError(`Failed to load bulk permitted values`, error, column, selectedGridCells);

package/src/agGrid/agGridHelper.js

@@ -322,6 +322,7 @@ class agGridHelper {
     }
     fireSelectionChangedEvent() {
         let selectionChangedInfo = {
+            adaptableApi: this.adaptable.api,
             selectedCellInfo: this.adaptable.api.gridApi.getGridState().SelectedCellInfo,
             selectedRowInfo: this.adaptable.api.gridApi.getGridState().SelectedRowInfo,
         };

package/src/components/AdaptableFormComponent/AdaptableFormComponent.js

@@ -20,9 +20,9 @@ function AdaptableFormComponentButtons({ formDef, onClick, defaultTone, disabled
             },
         };
         const iconProps = button.icon && Object.assign({}, defaultIconProps, button.icon);
-        let buttonStyle = api.internalApi.getStyleForButton(button, context ? context : { api: api });
-        let buttonLabel = api.internalApi.getLabelForButton(button, context ? context : { api: api });
-        let buttonTooltip = api.internalApi.getTooltipForButton(button, context ? context : { api: api });
+        let buttonStyle = api.internalApi.getStyleForButton(button, context ? context : { adaptableApi: api });
+        let buttonLabel = api.internalApi.getLabelForButton(button, context ? context : { adaptableApi: api });
+        let buttonTooltip = api.internalApi.getTooltipForButton(button, context ? context : { adaptableApi: api });
         return (React.createElement(SimpleButton_1.default, { autoFocus: index === 0, disabled: disabledButtons[index], key: index, tooltip: buttonTooltip, tone: (_a = buttonStyle === null || buttonStyle === void 0 ? void 0 : buttonStyle.tone) !== null && _a !== void 0 ? _a : defaultTone, variant: buttonStyle === null || buttonStyle === void 0 ? void 0 : buttonStyle.variant, "data-text": buttonLabel, className: buttonStyle === null || buttonStyle === void 0 ? void 0 : buttonStyle.className, marginLeft: index ? 2 : 0, onClick: () => {
                 onClick(button);
             } },

package/src/metamodel/adaptable.metamodel.d.ts

@@ -444,19 +444,12 @@ export declare const ADAPTABLE_METAMODEL: {
         name: string;
         kind: string;
         description: string;
-        properties: ({
-            name: string;
-            kind: string;
-            description: string;
-            uiLabel: string;
-            reference: string;
-        } | {
+        properties: {
             name: string;
             kind: string;
             description: string;
             uiLabel: string;
-            reference?: undefined;
-        })[];
+        }[];
     };
     AdaptableScope: {
         name: string;

package/src/metamodel/adaptable.metamodel.js

@@ -1244,13 +1244,6 @@ exports.ADAPTABLE_METAMODEL = {
         "kind": "Interface",
         "description": "Object returned by `AdaptableReady` event - fired when AdapTable has loaded",
         "properties": [
-            {
-                "name": "adaptableApi",
-                "kind": "REFERENCE",
-                "description": "Adaptable API object used for runtime programmatic access to AdapTable",
-                "uiLabel": "Adaptable Api",
-                "reference": "AdaptableApi"
-            },
             {
                 "name": "vendorGrid",
                 "kind": "unknown",
@@ -1823,7 +1816,7 @@ exports.ADAPTABLE_METAMODEL = {
             },
             {
                 "name": "MessageText",
-                "kind": "unknown",
+                "kind": "string",
                 "description": "Alert Message - can be string or function; if not provided AdapTable creates dynamically using Rule & Scope",
                 "uiLabel": "Message Text",
                 "isOptional": true

package/src/types.d.ts

@@ -23,7 +23,7 @@ export type { FilterActionOnDataChange } from './PredefinedConfig/Common/FilterA
 export type { ConfigState } from './PredefinedConfig/ConfigState';
 export type { TeamSharingOptions } from './AdaptableOptions/TeamSharingOptions';
 export type { ToolPanelOptions, CustomToolPanel, ToolPanelButtonContext, CustomToolPanelButtonContext, } from './AdaptableOptions/ToolPanelOptions';
-export type { UserInterfaceOptions, CellValuesList, ActionColumnButtonContext, ActionColumn, ActionColumnSettings, BasePermittedValues, PermittedValues, EditLookUpPermittedValues, FilterPermittedValues, CustomSortPermittedValues, BulkUpdatePermittedValues, } from './AdaptableOptions/UserInterfaceOptions';
+export type { UserInterfaceOptions, CellValuesList, ActionColumnButtonContext, ActionColumn, ActionColumnSettings, BasePermittedValues, PermittedValues, EditLookUpPermittedValues, FilterPermittedValues, CustomSortPermittedValues, BulkUpdatePermittedValues, BaseParams, EditLookUpParams, PermittedValuesParams, FilterPermittedValuesParams, BulkUpdatePermittedValuesParams, } from './AdaptableOptions/UserInterfaceOptions';
 export type { MenuOptions } from './AdaptableOptions/MenuOptions';
 export type { EntitlementOptions } from './AdaptableOptions/EntitlementOptions';
 export type { QueryLanguageOptions, ModuleExpressionFunctions, } from './AdaptableOptions/QueryLanguageOptions';

package/version.d.ts

@@ -1,2 +1,2 @@
-declare const _default: "10.0.4-canary.0";
+declare const _default: "10.0.4-canary.1";
 export default _default;

package/version.js

@@ -1,3 +1,3 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.default = '10.0.4-canary.0'; // PLEASE DONT UPDATE THIS!!! - will be updated at build time with the correct version
+exports.default = '10.0.4-canary.1'; // PLEASE DONT UPDATE THIS!!! - will be updated at build time with the correct version