@adaptabletools/adaptable 18.0.0-canary.8 → 18.0.0

package/src/Api/Implementation/OptionsApiImpl.js

@@ -36,10 +36,10 @@ export class OptionsApiImpl extends ApiBase {
     getColumnOptions() {
         return this.getOptions().columnOptions;
     }
-    getNotesOptions() {
+    getNoteOptions() {
         return this.getOptions().noteOptions;
     }
-    getCommentsOptions() {
+    getCommentOptions() {
         return this.getOptions().commentOptions;
     }
     getCustomSortOptions() {
@@ -72,8 +72,11 @@ export class OptionsApiImpl extends ApiBase {
     getLayoutOptions() {
         return this.getOptions().layoutOptions;
     }
-    getMenuOptions() {
-        return this.getOptions().menuOptions;
+    getColumnMenuOptions() {
+        return this.getOptions().columnMenuOptions;
+    }
+    getContextMenuOptions() {
+        return this.getOptions().contextMenuOptions;
     }
     getColumnFilterOptions() {
         return this.getOptions().columnFilterOptions;

package/src/Api/Implementation/PredicateApiImpl.js

@@ -71,9 +71,9 @@ export class PredicateApiImpl extends ApiBase {
         if (!predicate.ColumnId) {
             return this.handlePredicate(predicate, context, defaultReturn);
         }
-        const paramsForColumn = Object.assign(Object.assign({}, context), { column: this.adaptable.api.columnApi.getColumnWithColumnId(predicate.ColumnId), 
+        const paramsForColumn = Object.assign(Object.assign({}, context), { column: this.getAdaptableApi().columnApi.getColumnWithColumnId(predicate.ColumnId), 
             // value: params?.node?.data?.[predicate.ColumnId],
-            value: this.adaptable.api.gridApi.getRawValueFromRowNode(context.node, predicate.ColumnId) });
+            value: this.getAdaptableApi().gridApi.getRawValueFromRowNode(context.node, predicate.ColumnId) });
         if ('oldValue' in paramsForColumn) {
             delete paramsForColumn.oldValue;
         }

package/src/Api/Implementation/ScheduleApiImpl.js

@@ -52,7 +52,7 @@ export class ScheduleApiImpl extends ApiBase {
     }
     getReportSchedules(config) {
         var _a;
-        return ((_a = this.handleLayoutAssociatedObjects(this.adaptable.api.exportApi.getReportSchedules(), 'Schedule', config)) !== null && _a !== void 0 ? _a : []);
+        return ((_a = this.handleLayoutAssociatedObjects(this.getAdaptableApi().exportApi.getReportSchedules(), 'Schedule', config)) !== null && _a !== void 0 ? _a : []);
     }
     getActiveReportSchedules() {
         return this.getReportSchedules().filter((schedule) => !schedule.IsSuspended);
@@ -81,7 +81,7 @@ export class ScheduleApiImpl extends ApiBase {
     }
     getIPushPullSchedules(config) {
         var _a;
-        const ippApi = this.adaptable.api.pluginsApi.getipushpullPluginApi();
+        const ippApi = this.getAdaptableApi().pluginsApi.getipushpullPluginApi();
         return ((_a = this.handleLayoutAssociatedObjects(ippApi === null || ippApi === void 0 ? void 0 : ippApi.getIPushPullSchedules(), 'Schedule', config)) !== null && _a !== void 0 ? _a : []);
     }
     getActiveIPushPullSchedules() {
@@ -111,7 +111,7 @@ export class ScheduleApiImpl extends ApiBase {
     }
     getOpenFinSchedules(config) {
         var _a;
-        const openFinApi = this.adaptable.api.pluginsApi.getOpenFinPluginApi();
+        const openFinApi = this.getAdaptableApi().pluginsApi.getOpenFinPluginApi();
         return ((_a = this.handleLayoutAssociatedObjects(openFinApi === null || openFinApi === void 0 ? void 0 : openFinApi.getOpenFinSchedules(), 'Schedule', config)) !== null && _a !== void 0 ? _a : []);
     }
     getActiveOpenFinSchedules() {
@@ -163,10 +163,10 @@ export class ScheduleApiImpl extends ApiBase {
         }
         else if (scheduleType == 'Report') {
             const reportSchedule = schedule;
-            this.adaptable.api.exportApi.runReport(reportSchedule.ReportName, reportSchedule.ExportDestination);
+            this.getAdaptableApi().exportApi.runReport(reportSchedule.ReportName, reportSchedule.ExportDestination);
         }
         else if (scheduleType == 'ipushpull') {
-            const ippApi = this.adaptable.api.pluginsApi.getipushpullPluginApi();
+            const ippApi = this.getAdaptableApi().pluginsApi.getipushpullPluginApi();
             const iPushPullSchedule = schedule;
             if (iPushPullSchedule.Transmission == 'Snapshot') {
                 ippApi.sendSnapshot(iPushPullSchedule.IPushPullReport);
@@ -176,7 +176,7 @@ export class ScheduleApiImpl extends ApiBase {
             }
         }
         else if (scheduleType == 'OpenFin') {
-            const openFinApi = this.adaptable.api.pluginsApi.getOpenFinPluginApi();
+            const openFinApi = this.getAdaptableApi().pluginsApi.getOpenFinPluginApi();
             const openFinSchedule = schedule;
             openFinApi.startLiveData(openFinSchedule.OpenFinReport);
         }

package/src/Api/Implementation/TeamSharingApiImpl.js

@@ -15,11 +15,7 @@ export class TeamSharingApiImpl extends ApiBase {
             return [];
         }
         const teamSharingOptions = this.adaptable.adaptableOptions.teamSharingOptions;
-        const sharedEntitiesContext = {
-            adaptableId: this.adaptable.adaptableOptions.adaptableId,
-            userName: this.adaptable.adaptableOptions.userName,
-            adaptableApi: this.getAdaptableApi(),
-        };
+        const sharedEntitiesContext = this.getAdaptableApi().internalApi.buildBaseContext();
         let loadedSharedEntities = await teamSharingOptions.loadSharedEntities(sharedEntitiesContext);
         // with v15 we introduced 2 types of SharedEntity: AdaptableSharedEntity (basically the old one) and the new CustomSharedEntity
         // for backwards compatibility, we add default the 'EntityType' property to 'adaptableEntity'
@@ -40,11 +36,7 @@ export class TeamSharingApiImpl extends ApiBase {
             return false;
         }
         const teamSharingOptions = this.adaptable.adaptableOptions.teamSharingOptions;
-        const sharedEntitiesContext = {
-            adaptableId: this.adaptable.adaptableOptions.adaptableId,
-            userName: this.adaptable.adaptableOptions.userName,
-            adaptableApi: this.getAdaptableApi(),
-        };
+        const sharedEntitiesContext = this.getAdaptableApi().internalApi.buildBaseContext();
         const sharedEntitiesAfterCustomisation = teamSharingOptions.saveSharedEntities(sharedEntities, sharedEntitiesContext);
         await teamSharingOptions.persistSharedEntities(sharedEntitiesAfterCustomisation, sharedEntitiesContext);
         return true;
@@ -100,11 +92,7 @@ export class TeamSharingApiImpl extends ApiBase {
                 this.logError(`Could NOT import custom shared entity because 'TeamSharingOptions.handleCustomSharedEntityImport(...)' is NOT defined!`, sharedEntity);
                 return;
             }
-            customSharedEntityImportHandler(sharedEntity, {
-                adaptableApi: this.getAdaptableApi(),
-                adaptableId: this.adaptable.adaptableOptions.adaptableId,
-                userName: this.adaptable.adaptableOptions.userName,
-            });
+            customSharedEntityImportHandler(sharedEntity, this.getAdaptableApi().internalApi.buildBaseContext());
         }
     }
     getTeamSharingState() {

package/src/Api/Implementation/ThemeApiImpl.js

@@ -57,13 +57,8 @@ export class ThemeApiImpl extends ApiBase {
             return;
         }
         this.adaptable.applyAdaptableTheme(currentTheme);
-        let themeChangedInfo = {
-            adaptableApi: this.getAdaptableApi(),
-            theme: currentTheme,
-            userName: this.adaptable.api.optionsApi.getUserName(),
-            adaptableId: this.adaptable.api.optionsApi.getAdaptableId(),
-        };
-        this.adaptable.api.eventApi.emit('ThemeChanged', themeChangedInfo);
+        let themeChangedInfo = Object.assign(Object.assign({}, this.getAdaptableApi().internalApi.buildBaseContext()), { theme: currentTheme });
+        this.getAdaptableApi().eventApi.emit('ThemeChanged', themeChangedInfo);
     }
     getUserThemes() {
         var _a;

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

@@ -1,14 +1,14 @@
-import { ApiBase } from './ApiBase';
-import { UserInterfaceApi } from '../UserInterfaceApi';
+import { IAdaptable } from '../../AdaptableInterfaces/IAdaptable';
+import { BulkUpdatePermittedValues, CustomSortPermittedValues, EditLookUpPermittedValues, FilterPermittedValues, PermittedValues } from '../../AdaptableOptions/UserInterfaceOptions';
 import { AdaptableColumn } from '../../PredefinedConfig/Common/AdaptableColumn';
 import { AdaptableStyle } from '../../PredefinedConfig/Common/AdaptableStyle';
-import { ColumnMenuContext, ContextMenuContext, UserMenuItem } from '../../PredefinedConfig/Common/Menu';
-import { BulkUpdatePermittedValues, CustomSortPermittedValues, EditLookUpPermittedValues, FilterPermittedValues, PermittedValues } from '../../AdaptableOptions/UserInterfaceOptions';
-import { AdaptableObjectTag, CustomWindowConfig, GridCell } from '../../types';
+import { AdaptableFrameworkComponent, AdaptableObjectTag, CustomRenderFunction, CustomWindowConfig, GridCell } from '../../types';
 import { UserInterfaceInternalApi } from '../Internal/UserInterfaceInternalApi';
-import { IAdaptable } from '../../AdaptableInterfaces/IAdaptable';
+import { UserInterfaceApi } from '../UserInterfaceApi';
+import { ApiBase } from './ApiBase';
 export declare class UserInterfaceApiImpl extends ApiBase implements UserInterfaceApi {
     internalApi: UserInterfaceInternalApi;
+    private showProgressIndicatorTimeout;
     constructor(adaptable: IAdaptable);
     getColorPalette(): string[];
     getStyleClassNames(): string[] | undefined;
@@ -24,14 +24,20 @@ export declare class UserInterfaceApiImpl extends ApiBase implements UserInterfa
     getEditLookUpItems(): EditLookUpPermittedValues[];
     getEditLookUpItemForColumn(column: AdaptableColumn): EditLookUpPermittedValues | undefined;
     getEditLookUpValuesForEditLookUpItem(editLookUpItem: EditLookUpPermittedValues, gridCell: GridCell): any[] | undefined;
-    addColumnMenuItem(userMenuItem: UserMenuItem<ColumnMenuContext>): void;
-    addContextMenuItem(userMenuItem: UserMenuItem<ContextMenuContext>): void;
     getEditableCellStyle(): AdaptableStyle | undefined;
     getReadOnlyCellStyle(): AdaptableStyle | undefined;
     getAdaptableObjectTags(): AdaptableObjectTag[] | undefined;
     getCustomIconDefinition(iconName: string): import("../../types").AdaptableIcon | import("../../types").CustomIcon;
     showLoadingScreen(): void;
     hideLoadingScreen(): void;
+    showProgressIndicator(config: {
+        text: string;
+        message?: string;
+        render?: CustomRenderFunction;
+        frameworkComponent?: AdaptableFrameworkComponent;
+        delay?: number;
+    }): void;
+    hideProgressIndicator(): void;
     openCustomWindowPopup(config: CustomWindowConfig): {
         close: () => void;
     };

package/src/Api/Implementation/UserInterfaceApiImpl.js

@@ -1,11 +1,14 @@
-import { ApiBase } from './ApiBase';
 import * as PopupRedux from '../../Redux/ActionsReducers/PopupRedux';
+import { SystemProgressIndicatorHide, SystemProgressIndicatorShow, } from '../../Redux/ActionsReducers/SystemRedux';
 import { ArrayExtensions } from '../../Utilities/Extensions/ArrayExtensions';
-import { UserInterfaceInternalApi } from '../Internal/UserInterfaceInternalApi';
+import { logDeprecation } from '../../Utilities/logDeprecation';
 import { CUSTOM_WINDOW_FACTORY_ID } from '../../View/Components/Popups/WindowPopups/WindowPopups';
+import { UserInterfaceInternalApi } from '../Internal/UserInterfaceInternalApi';
+import { ApiBase } from './ApiBase';
 export class UserInterfaceApiImpl extends ApiBase {
     constructor(adaptable) {
         super(adaptable);
+        this.showProgressIndicatorTimeout = null;
         this.internalApi = new UserInterfaceInternalApi(adaptable);
     }
     getColorPalette() {
@@ -39,21 +42,21 @@ export class UserInterfaceApiImpl extends ApiBase {
         // columns id
         permittedValuesItem = permittedValues.find((permittedValue) => {
             return ('ColumnIds' in permittedValue.scope &&
-                this.getAdaptableApi().scopeApi.isColumnInScope(column, permittedValue.scope));
+                this.getAdaptableApi().columnScopeApi.isColumnInScope(column, permittedValue.scope));
         });
         if (permittedValuesItem) {
             return permittedValuesItem;
         }
         permittedValuesItem = permittedValues.find((permittedValue) => {
             return ('DataTypes' in permittedValue.scope &&
-                this.getAdaptableApi().scopeApi.isColumnInScope(column, permittedValue.scope));
+                this.getAdaptableApi().columnScopeApi.isColumnInScope(column, permittedValue.scope));
         });
         if (permittedValuesItem) {
             return permittedValuesItem;
         }
         permittedValuesItem = permittedValues.find((permittedValue) => {
             return ('All' in permittedValue.scope &&
-                this.adaptable.api.scopeApi.isColumnInScope(column, permittedValue.scope));
+                this.getAdaptableApi().columnScopeApi.isColumnInScope(column, permittedValue.scope));
         });
         if (permittedValuesItem) {
             return permittedValuesItem;
@@ -73,12 +76,7 @@ export class UserInterfaceApiImpl extends ApiBase {
         // first do the function then get hardcoded items
         if (permittedValues != null && typeof permittedValues === 'function') {
             if (column) {
-                const permittedValuesParams = {
-                    adaptableApi: this.getAdaptableApi(),
-                    userName: this.getOptions().userName,
-                    adaptableId: this.getOptions().adaptableId,
-                    column: column,
-                };
+                const permittedValuesParams = Object.assign(Object.assign({}, this.getAdaptableApi().internalApi.buildBaseContext()), { column: column });
                 return permittedValues(permittedValuesParams);
             }
         }
@@ -140,15 +138,7 @@ export class UserInterfaceApiImpl extends ApiBase {
         if (!editLookUpItem || !gridCell || !gridCell.column) {
             return undefined;
         }
-        return this.adaptable.api.gridApi.internalApi.getEditLookUpValuesForColumn(editLookUpItem, gridCell.column, gridCell);
-    }
-    addColumnMenuItem(userMenuItem) {
-        var _a;
-        (_a = this.getMenuOptions().columnMenuItems) === null || _a === void 0 ? void 0 : _a.push(userMenuItem);
-    }
-    addContextMenuItem(userMenuItem) {
-        var _a;
-        (_a = this.getMenuOptions().contextMenuItems) === null || _a === void 0 ? void 0 : _a.push(userMenuItem);
+        return this.getAdaptableApi().gridApi.internalApi.getEditLookUpValuesForColumn(editLookUpItem, gridCell.column, gridCell);
     }
     getEditableCellStyle() {
         return this.getUserInterfaceOptions().editableCellStyle;
@@ -159,11 +149,7 @@ export class UserInterfaceApiImpl extends ApiBase {
     getAdaptableObjectTags() {
         const objectTags = this.getUserInterfaceOptions().objectTags;
         if (objectTags != null && typeof objectTags === 'function') {
-            return objectTags({
-                adaptableApi: this.adaptable.api,
-                userName: this.getOptions().userName,
-                adaptableId: this.getOptions().adaptableId,
-            });
+            return objectTags(this.getAdaptableApi().internalApi.buildBaseContext());
         }
         else {
             let arr = objectTags;
@@ -183,10 +169,29 @@ export class UserInterfaceApiImpl extends ApiBase {
         return customIcon;
     }
     showLoadingScreen() {
-        this.dispatchAction(PopupRedux.PopupShowLoading());
+        logDeprecation(this.adaptable.logger, 'UserInterfaceApi', 'showLoadingScreen', 'showProgressIndicator');
+        this.showProgressIndicator({ text: 'Loading' });
     }
     hideLoadingScreen() {
-        this.dispatchAction(PopupRedux.PopupHideLoading());
+        logDeprecation(this.adaptable.logger, 'UserInterfaceApi', 'hideLoadingScreen', 'hideProgressIndicator');
+        this.hideProgressIndicator();
+    }
+    showProgressIndicator(config) {
+        if (config.delay) {
+            this.showProgressIndicatorTimeout = setTimeout(() => {
+                this.dispatchAction(SystemProgressIndicatorShow(config));
+            }, config.delay);
+        }
+        else {
+            this.dispatchAction(SystemProgressIndicatorShow(config));
+        }
+    }
+    hideProgressIndicator() {
+        if (this.showProgressIndicatorTimeout) {
+            clearTimeout(this.showProgressIndicatorTimeout);
+            this.showProgressIndicatorTimeout = null;
+        }
+        this.dispatchAction(SystemProgressIndicatorHide());
     }
     openCustomWindowPopup(config) {
         const close = () => {

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

@@ -16,6 +16,7 @@ export declare class ActionRowInternalApi extends ApiBase {
     private buildActionRowFields;
     private showColumnInActionRowForm;
     private buidActionRowButtons;
+    private prepareCreateData;
     private prepareEditData;
     private isColumnEditable;
     private buildFormField;

package/src/Api/Internal/ActionRowInternalApi.js

@@ -42,13 +42,7 @@ export class ActionRowInternalApi extends ApiBase {
             : this.actionRowFormOptions.formDescription;
     }
     buildFormParamContext(type, rowNode) {
-        return {
-            rowNode,
-            adaptableApi: this.getAdaptableApi(),
-            userName: this.getOptions().userName,
-            adaptableId: this.getOptions().adaptableId,
-            type: type,
-        };
+        return Object.assign(Object.assign({ rowNode }, this.getAdaptableApi().internalApi.buildBaseContext()), { type: type });
     }
     buildActionRowFields(actionRowType, rowNode) {
         const relevantColumns = this.getAdaptableApi()
@@ -64,13 +58,8 @@ export class ActionRowInternalApi extends ApiBase {
     showColumnInActionRowForm(adaptableColumn, actionRowType) {
         const showColumnFn = this.getActionRowOptions().actionRowFormOptions.showColumninActionRowForm;
         if (typeof showColumnFn === 'function') {
-            return showColumnFn({
-                adaptableApi: this.adaptable.api,
-                userName: this.getOptions().userName,
-                adaptableId: this.getOptions().adaptableId,
-                adaptableColumn,
-                actionRowType,
-            });
+            return showColumnFn(Object.assign(Object.assign({}, this.getAdaptableApi().internalApi.buildBaseContext()), { adaptableColumn,
+                actionRowType }));
         }
         return true;
     }
@@ -98,28 +87,24 @@ export class ActionRowInternalApi extends ApiBase {
                 // textOutput should not be saved, their values are set to display values
                 // we need to filter out the textOutput fields and add the primaryKey
                 const eventInfo = type === 'rowCreated'
-                    ? {
-                        type: 'rowCreated',
-                        formData: context.formData,
-                        adaptableApi: context.adaptableApi,
-                        userName: this.getOptions().userName,
-                        adaptableId: this.getOptions().adaptableId,
-                        clonedRowNode: rowNode,
-                    }
-                    : {
-                        type: 'rowEdited',
-                        formData: this.prepareEditData(formFields, context),
-                        rowNode: rowNode,
-                        adaptableApi: context.adaptableApi,
-                        userName: this.getOptions().userName,
-                        adaptableId: this.getOptions().adaptableId,
-                    };
+                    ? Object.assign(Object.assign({ type: 'rowCreated', formData: this.prepareCreateData(formFields, context) }, this.getAdaptableApi().internalApi.buildBaseContext()), { clonedRowNode: rowNode }) : Object.assign({ type: 'rowEdited', formData: this.prepareEditData(formFields, context), rowNode: rowNode }, this.getAdaptableApi().internalApi.buildBaseContext());
                 this.getAdaptableApi().eventApi.emit('ActionRowSubmitted', eventInfo);
                 (_b = (_a = this.actionRowFormOptions) === null || _a === void 0 ? void 0 : _a.onFormSubmit) === null || _b === void 0 ? void 0 : _b.call(_a, eventInfo);
             },
         };
         return [cancelButton, saveButton];
     }
+    // private getNullValueForColumn(column: AdaptableColumn) {}
+    prepareCreateData(formFields, context) {
+        // when creating we just omit values that are not set
+        const dataToSave = Object.assign({}, context.formData);
+        for (const formField of formFields) {
+            if (dataToSave[formField.name] === '') {
+                delete dataToSave[formField.name];
+            }
+        }
+        return dataToSave;
+    }
     prepareEditData(formFields, context) {
         const dataToSave = Object.assign({}, context.formData);
         for (const formField of formFields) {
@@ -164,14 +149,8 @@ export class ActionRowInternalApi extends ApiBase {
         return customFieldLabel !== null && customFieldLabel !== void 0 ? customFieldLabel : column.friendlyName;
     }
     buildFormFieldLabelContext(type, column, rowNode) {
-        return {
-            rowNode,
-            column,
-            adaptableApi: this.getAdaptableApi(),
-            userName: this.getOptions().userName,
-            adaptableId: this.getOptions().adaptableId,
-            type: type,
-        };
+        return Object.assign(Object.assign({ rowNode,
+            column }, this.getAdaptableApi().internalApi.buildBaseContext()), { type: type });
     }
     getFieldTypeFromColumnType(column) {
         switch (column.dataType) {
@@ -220,7 +199,7 @@ export class ActionRowInternalApi extends ApiBase {
                 lockVisible: true,
                 suppressColumnsToolPanel: true,
                 suppressFiltersToolPanel: true,
-                suppressMenu: true,
+                suppressHeaderMenuButton: true,
                 suppressMovable: true,
                 filter: false,
                 sortable: false,
@@ -274,13 +253,7 @@ export class ActionRowInternalApi extends ApiBase {
                 tooltip: 'Delete',
                 onClick: (button, context) => {
                     var _a, _b;
-                    const eventInfo = {
-                        type: 'rowDeleted',
-                        rowNode: context.rowNode,
-                        adaptableApi: context.adaptableApi,
-                        userName: context.userName,
-                        adaptableId: context.adaptableId,
-                    };
+                    const eventInfo = Object.assign({ type: 'rowDeleted', rowNode: context.rowNode }, this.getAdaptableApi().internalApi.buildBaseContext());
                     this.getEventApi().emit('ActionRowSubmitted', eventInfo);
                     (_b = (_a = this.getActionRowOptions().actionRowFormOptions).onFormSubmit) === null || _b === void 0 ? void 0 : _b.call(_a, eventInfo);
                 },

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

@@ -72,7 +72,7 @@ export declare class AdaptableInternalApi extends ApiBase {
         includeGroupRows?: boolean;
         filterFn?: (rowNode: IRowNode) => boolean;
     }): void;
-    forAllVisibleRowNodesDo(func: (rowNode: IRowNode) => void, config?: {
+    forAllVisibleRowNodesDo(func: (rowNode: IRowNode, index: number) => void, config?: {
         includeGroupRows?: boolean;
         filterFn?: (rowNode: IRowNode) => boolean;
     }): void;
@@ -89,7 +89,6 @@ export declare class AdaptableInternalApi extends ApiBase {
     destroyFrameworkComponent(containerDomNode: HTMLElement, frameworkComponent: AdaptableFrameworkComponent, componentType: 'toolPanel' | 'toolbar'): void;
     initializeDataChangeHistory(): void;
     executeWithProgressIndicator(label: string, executeFn: () => void, errorHandlingFn?: () => void): void;
-    hideProgressIndicator(): void;
     getCorrectEnglishVariant(wordToSpell: string): string;
     shouldDisplayTagSections(): boolean;
     getAvailableTags(): AdaptableObjectTag[] | undefined;
@@ -105,8 +104,8 @@ export declare class AdaptableInternalApi extends ApiBase {
     getPreviousGroupedColumnsIndex(layoutId: string): {
         [key: string]: number;
     };
-    getValueUsingField(rowData: Record<string, any>, columnValueKey: string): any;
-    setValueUsingField(rowData: Record<string, any>, columnValueKey: string, newValue: any): Record<string, any>;
+    getValueUsingField(rowData: Record<string, any>, fieldName: string): any;
+    setValueUsingField(rowData: Record<string, any>, fieldName: string, newValue: any): Record<string, any>;
     findAdaptableObjectsByLookupCriteria<T extends AdaptableObjectWithScope>({ scope, tag, ids }: AdaptableObjectLookupCriteria, specificAdaptableObjects: T[]): T[];
     buildBaseContext(): BaseContext;
     getActionButtonsAndActionColumn(colDef: ColDef): {

package/src/Api/Internal/AdaptableInternalApi.js

@@ -1,6 +1,5 @@
 import * as PopupRedux from '../../Redux/ActionsReducers/PopupRedux';
 import * as SystemRedux from '../../Redux/ActionsReducers/SystemRedux';
-import { SystemProgressIndicatorHide, SystemProgressIndicatorShow, } from '../../Redux/ActionsReducers/SystemRedux';
 import * as GridRedux from '../../Redux/ActionsReducers/GridRedux';
 import * as DeadRedux from '../../Redux/DeadRedux';
 import { ApiBase } from '../Implementation/ApiBase';
@@ -249,7 +248,7 @@ export class AdaptableInternalApi extends ApiBase {
         }
     }
     executeWithProgressIndicator(label, executeFn, errorHandlingFn) {
-        this.dispatchReduxAction(SystemProgressIndicatorShow(label));
+        this.getAdaptableApi().userInterfaceApi.showProgressIndicator({ text: label, delay: 300 });
         // setTimeout required to give the ProgressIndicator rendering a head-start (see RAF in ProgressIndicator implementation)
         setTimeout(() => {
             try {
@@ -257,14 +256,11 @@ export class AdaptableInternalApi extends ApiBase {
             }
             catch (error) {
                 errorHandlingFn === null || errorHandlingFn === void 0 ? void 0 : errorHandlingFn();
-                this.hideProgressIndicator();
+                this.getUserInterfaceApi().hideProgressIndicator();
                 this.adaptable.logger.error('Unexpected error while executing a function with a progress indicator', error);
             }
         }, 16);
     }
-    hideProgressIndicator() {
-        this.dispatchReduxAction(SystemProgressIndicatorHide());
-    }
     getCorrectEnglishVariant(wordToSpell) {
         if (wordToSpell.includes('our')) {
             return this.getUserInterfaceOptions().englishVariant == 'GB'
@@ -294,11 +290,7 @@ export class AdaptableInternalApi extends ApiBase {
         if (typeof this.adaptable.adaptableOptions.userInterfaceOptions.objectTags === 'function') {
             // sanitize the provided tags, just to be sure that the user does NOT break the UI
             return this.adaptable.adaptableOptions.userInterfaceOptions
-                .objectTags({
-                adaptableApi: this.adaptable.api,
-                userName: this.getOptions().userName,
-                adaptableId: this.getOptions().adaptableId,
-            })
+                .objectTags(this.buildBaseContext())
                 .filter((tag) => typeof tag === 'string');
         }
     }
@@ -315,13 +307,7 @@ export class AdaptableInternalApi extends ApiBase {
         }
         if (typeof this.adaptable.adaptableOptions.layoutOptions.layoutTagOptions
             .autoGenerateTagsForLayouts === 'function') {
-            const autoGenerateTagsForLayoutsContext = {
-                layouts: this.adaptable.api.layoutApi.getLayouts(),
-                objectTags: this.getAdaptableApi().userInterfaceApi.getAdaptableObjectTags(),
-                adaptableApi: this.adaptable.api,
-                userName: this.getOptions().userName,
-                adaptableId: this.getOptions().adaptableId,
-            };
+            const autoGenerateTagsForLayoutsContext = Object.assign({ layouts: this.adaptable.api.layoutApi.getLayouts(), objectTags: this.getAdaptableApi().userInterfaceApi.getAdaptableObjectTags() }, this.buildBaseContext());
             const customGeneratedTags = this.adaptable.adaptableOptions.layoutOptions.layoutTagOptions.autoGenerateTagsForLayouts(autoGenerateTagsForLayoutsContext);
             // sanitize the provided tags, just to be sure that the user does NOT break the UI
             return customGeneratedTags.filter((tag) => typeof tag === 'string');
@@ -366,17 +352,17 @@ export class AdaptableInternalApi extends ApiBase {
         return (_a = SystemRedux.SystemPreviousGroupedColumnsSelector(this.getAdaptableState().System)) === null || _a === void 0 ? void 0 : _a[layoutId];
     }
     // "borrowed" from https://github.com/ag-grid/ag-grid/blob/v28.2.1/community-modules/core/src/ts/utils/object.ts#L205
-    getValueUsingField(rowData, columnValueKey) {
-        if (!rowData || !(columnValueKey === null || columnValueKey === void 0 ? void 0 : columnValueKey.length)) {
+    getValueUsingField(rowData, fieldName) {
+        if (!rowData || !(fieldName === null || fieldName === void 0 ? void 0 : fieldName.length)) {
             return;
         }
-        const isColumnValueKeyNested = columnValueKey === null || columnValueKey === void 0 ? void 0 : columnValueKey.includes('.');
+        const isColumnValueKeyNested = fieldName === null || fieldName === void 0 ? void 0 : fieldName.includes('.');
         // if no '.', then it's not a deep value
         if (!isColumnValueKeyNested) {
-            return rowData[columnValueKey];
+            return rowData[fieldName];
         }
         // otherwise it is a deep value, so need to dig for it
-        const fields = columnValueKey.split('.');
+        const fields = fieldName.split('.');
         let currentObject = rowData;
         for (let i = 0; i < fields.length; i++) {
             if (currentObject == null) {
@@ -387,22 +373,22 @@ export class AdaptableInternalApi extends ApiBase {
         return currentObject;
     }
     // "borrowed" from https://github.com/ag-grid/ag-grid/blob/v28.2.1/community-modules/core/src/ts/valueService/valueService.ts#L236
-    setValueUsingField(rowData, columnValueKey, newValue) {
-        if (!rowData || !(columnValueKey === null || columnValueKey === void 0 ? void 0 : columnValueKey.length)) {
+    setValueUsingField(rowData, fieldName, newValue) {
+        if (!rowData || !(fieldName === null || fieldName === void 0 ? void 0 : fieldName.length)) {
             return;
         }
-        const isColumnValueKeyContainsDots = columnValueKey === null || columnValueKey === void 0 ? void 0 : columnValueKey.includes('.');
+        const isColumnValueKeyContainsDots = fieldName === null || fieldName === void 0 ? void 0 : fieldName.includes('.');
         let valuesAreSame = false;
         if (!isColumnValueKeyContainsDots) {
             // soft comparison to match strings and numbers
-            valuesAreSame = rowData[columnValueKey] == newValue;
+            valuesAreSame = rowData[fieldName] == newValue;
             if (!valuesAreSame) {
-                rowData[columnValueKey] = newValue;
+                rowData[fieldName] = newValue;
             }
         }
         else {
             // otherwise it is a deep value, so need to dig for it
-            const fieldPieces = columnValueKey.split('.');
+            const fieldPieces = fieldName.split('.');
             let currentObject = rowData;
             while (fieldPieces.length > 0 && currentObject) {
                 const fieldPiece = fieldPieces.shift();
@@ -435,7 +421,7 @@ export class AdaptableInternalApi extends ApiBase {
         }
         // lastly filter by scope
         if (scope) {
-            locatedAdaptableObjects = locatedAdaptableObjects.filter((adaptableObject) => this.getAdaptableApi().scopeApi.isScopeInScope(adaptableObject.Scope, scope));
+            locatedAdaptableObjects = locatedAdaptableObjects.filter((adaptableObject) => this.getAdaptableApi().columnScopeApi.isScopeInScope(adaptableObject.Scope, scope));
         }
         return locatedAdaptableObjects;
     }

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

@@ -5,7 +5,7 @@ import { AlertFormContext } from '../../AdaptableOptions/AlertOptions';
 import { AdaptableAlert, AdaptableCellChangedAlert, AdaptableRowChangedAlert } from '../../PredefinedConfig/Common/AdaptableAlert';
 import { CellDataChangedInfo } from '../../PredefinedConfig/Common/CellDataChangedInfo';
 import { GridDataChangedInfo } from '../Events/GridDataChanged';
-import { AdaptableScope } from '../../PredefinedConfig/Common/AdaptableScope';
+import { ColumnScope } from '../../PredefinedConfig/Common/ColumnScope';
 import { AdaptablePredicateDef } from '../../PredefinedConfig/Common/AdaptablePredicate';
 import { AdaptableMessageType } from '../../PredefinedConfig/Common/AdaptableMessageType';
 import { IRowNode } from '@ag-grid-community/core';
@@ -72,7 +72,7 @@ export declare class AlertInternalApi extends ApiBase {
      * Retrieves all Predicate Defs that match given Scope
      * @param scope the Scope to check
      */
-    getAlertPredicateDefsForScope(scope: AdaptableScope): AdaptablePredicateDef[];
+    getAlertPredicateDefsForScope(scope: ColumnScope): AdaptablePredicateDef[];
     /**
      * Returns a description of an Alert Definition
      * @param alertDefinition Alert Definition to use