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

package/src/Api/Implementation/InternalApiImpl.js

@@ -1,654 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.InternalApiImpl = void 0;
-const tslib_1 = require("tslib");
-const PopupRedux = tslib_1.__importStar(require("../../Redux/ActionsReducers/PopupRedux"));
-const SystemRedux = tslib_1.__importStar(require("../../Redux/ActionsReducers/SystemRedux"));
-const SystemRedux_1 = require("../../Redux/ActionsReducers/SystemRedux");
-const GridRedux = tslib_1.__importStar(require("../../Redux/ActionsReducers/GridRedux"));
-const AlertRedux = tslib_1.__importStar(require("../../Redux/ActionsReducers/AlertRedux"));
-const DeadRedux = tslib_1.__importStar(require("../../Redux/DeadRedux"));
-const ApiBase_1 = require("./ApiBase");
-const StringExtensions_1 = tslib_1.__importDefault(require("../../Utilities/Extensions/StringExtensions"));
-const GeneralConstants_1 = require("../../Utilities/Constants/GeneralConstants");
-const LoggingHelper_1 = require("../../Utilities/Helpers/LoggingHelper");
-const ArrayExtensions_1 = tslib_1.__importDefault(require("../../Utilities/Extensions/ArrayExtensions"));
-const AdaptableAlert_1 = require("../../PredefinedConfig/Common/AdaptableAlert");
-const waitForCondition_1 = require("../../Utilities/waitForCondition");
-const AdaptableIconComponent_1 = require("../../components/AdaptableIconComponent");
-class InternalApiImpl extends ApiBase_1.ApiBase {
-    getSystemState() {
-        return this.getAdaptableState().System;
-    }
-    getAdaptableFormFromAlertForm(alertForm, context, defaultMessageType) {
-        var _a, _b;
-        const api = this.adaptable.api;
-        let adaptableAlertForm;
-        let isActionForm = false;
-        if (typeof alertForm === 'string') {
-            const alertForms = this.getAlertOptions().alertForms || [];
-            adaptableAlertForm = (_a = alertForms.find((f) => f.name === alertForm)) === null || _a === void 0 ? void 0 : _a.form;
-        }
-        else {
-            adaptableAlertForm = Object.assign(Object.assign({}, alertForm), { buttons: (alertForm.Buttons || []).map((alertButton) => {
-                    return Object.assign(Object.assign({}, alertButton), { onClick: () => {
-                            api.alertApi.executeAlertButton(alertButton, context);
-                        } });
-                }) });
-            isActionForm = true;
-        }
-        if (!adaptableAlertForm) {
-            return;
-        }
-        if (adaptableAlertForm && adaptableAlertForm.buttons) {
-            // dont mutate the form, but clone it
-            adaptableAlertForm = Object.assign({}, adaptableAlertForm);
-            adaptableAlertForm.buttons = (_b = adaptableAlertForm.buttons) === null || _b === void 0 ? void 0 : _b.map((button) => {
-                let buttonStyle = isActionForm
-                    ? button.ButtonStyle
-                    : this.getStyleForButton(button, context);
-                if (defaultMessageType && !(buttonStyle === null || buttonStyle === void 0 ? void 0 : buttonStyle.tone)) {
-                    // force the button tone to be the alert tone, if the tone is missing from button style (or button style non-existent)
-                    buttonStyle = Object.assign(Object.assign({}, buttonStyle), { tone: defaultMessageType.toLowerCase() });
-                }
-                let label = isActionForm
-                    ? button.Label
-                    : this.getLabelForButton(button, context);
-                return Object.assign(Object.assign({}, button), { buttonStyle,
-                    label });
-            });
-        }
-        return adaptableAlertForm;
-    }
-    getAdaptableAlerts() {
-        var _a;
-        return (_a = this.getSystemState().AdaptableAlerts) !== null && _a !== void 0 ? _a : [];
-    }
-    getAdaptableCellChangedAlerts() {
-        return this.getAdaptableAlerts().filter(AdaptableAlert_1.isAdaptableCellChangedAlert);
-    }
-    getAdaptableRowChangedAlerts() {
-        return this.getAdaptableAlerts().filter(AdaptableAlert_1.isAdaptableRowChangedAlert);
-    }
-    getAdaptableAlertWithHighlightCell(columnId, rowNode) {
-        // only alerts triggered by cell changes are relevant for HighlightCell actions
-        return this.getAdaptableCellChangedAlerts().find((alert) => {
-            var _a, _b, _c, _d;
-            return ((_a = alert.alertDefinition.AlertProperties) === null || _a === void 0 ? void 0 : _a.HighlightCell) &&
-                ((_c = (_b = alert.cellDataChangedInfo) === null || _b === void 0 ? void 0 : _b.column) === null || _c === void 0 ? void 0 : _c.columnId) === columnId &&
-                ((_d = alert.cellDataChangedInfo) === null || _d === void 0 ? void 0 : _d.rowNode) === rowNode;
-        });
-    }
-    getAdaptableAlertWithHighlightRow(rowNode) {
-        let alertWithRowHighlight;
-        alertWithRowHighlight = this.getAdaptableRowChangedAlerts().find((alert) => {
-            var _a, _b;
-            if ((_a = alert.alertDefinition.AlertProperties) === null || _a === void 0 ? void 0 : _a.HighlightRow) {
-                if ((_b = alert.gridDataChangedInfo) === null || _b === void 0 ? void 0 : _b.rowNodes.map((rowNode) => rowNode.id).includes(rowNode.id)) {
-                    return alert;
-                }
-            }
-        });
-        if (alertWithRowHighlight) {
-            return alertWithRowHighlight;
-        }
-        alertWithRowHighlight = this.getAdaptableCellChangedAlerts().find((alert) => {
-            var _a, _b;
-            if ((_a = alert.alertDefinition.AlertProperties) === null || _a === void 0 ? void 0 : _a.HighlightRow) {
-                if (((_b = alert.cellDataChangedInfo) === null || _b === void 0 ? void 0 : _b.rowNode.id) == rowNode.id) {
-                    return alert;
-                }
-            }
-        });
-        return alertWithRowHighlight;
-    }
-    isAlertDefinitionForAddedRowChangeEvent(alertDefinition) {
-        var _a, _b;
-        const addedRowPredicate = 'AddedRow';
-        return ((_b = (_a = alertDefinition === null || alertDefinition === void 0 ? void 0 : alertDefinition.Rule) === null || _a === void 0 ? void 0 : _a.Predicate) === null || _b === void 0 ? void 0 : _b.PredicateId) === addedRowPredicate;
-    }
-    isAlertDefinitionForRemovedRowChangeEvent(alertDefinition) {
-        var _a, _b;
-        const removedRowPredicate = 'RemovedRow';
-        return ((_b = (_a = alertDefinition === null || alertDefinition === void 0 ? void 0 : alertDefinition.Rule) === null || _a === void 0 ? void 0 : _a.Predicate) === null || _b === void 0 ? void 0 : _b.PredicateId) === removedRowPredicate;
-    }
-    getAdaptableFlashingCellFor(primaryKey, columnId) {
-        var _a;
-        const { AdaptableFlashingCells: AdaptableFlashingAlerts, AdaptableFlashingCellsMap: AdaptableFlashingAlertsMap, } = this.getSystemState();
-        const forPrimaryKey = (_a = AdaptableFlashingAlerts[primaryKey]) !== null && _a !== void 0 ? _a : {};
-        const toFlashingAlert = (uuid) => { var _a; return uuid ? (_a = AdaptableFlashingAlertsMap[uuid]) !== null && _a !== void 0 ? _a : null : null; };
-        const adaptableFlashingCell = columnId
-            ? toFlashingAlert(forPrimaryKey[columnId])
-            : toFlashingAlert(forPrimaryKey[SystemRedux_1.FLASHING_CELL_ROW_KEY]);
-        if ((adaptableFlashingCell === null || adaptableFlashingCell === void 0 ? void 0 : adaptableFlashingCell.flashingCellDefinition) &&
-            !this.isObjectAvailableInLayout(adaptableFlashingCell.flashingCellDefinition, 'FlashingCell', this.getAdaptableApi().layoutApi.getCurrentLayout())) {
-            return;
-        }
-        return adaptableFlashingCell;
-    }
-    addSystemStatusMessageInfo(systemStatusMessageInfo) {
-        const maxMessagesInStore = this.getNotificationsOptions().maxSystemMessagesInStore;
-        this.dispatchAction(SystemRedux.SystemStatusMessageInfoAdd(systemStatusMessageInfo, maxMessagesInStore));
-    }
-    getSystemStatusMessageInfos() {
-        return this.getSystemState().SystemStatusMessages;
-    }
-    // Popup Redux Actions
-    showPopupConfirmation(confirmation) {
-        this.dispatchAction(PopupRedux.PopupShowConfirmation(confirmation));
-    }
-    showLoadingScreen() {
-        this.dispatchAction(PopupRedux.PopupShowLoading());
-    }
-    hideLoadingScreen() {
-        this.dispatchAction(PopupRedux.PopupHideLoading());
-    }
-    showPopupScreen(module, componentName, popupParams, popupProps) {
-        this.dispatchAction(PopupRedux.PopupShowScreen(module, componentName, popupParams, popupProps));
-    }
-    hidePopupScreen() {
-        this.dispatchAction(PopupRedux.PopupHideScreen());
-    }
-    setColumns(columns) {
-        this.dispatchAction(GridRedux.GridSetColumns(columns));
-    }
-    setSettingPanelModuleMenuItems(menuItems) {
-        this.dispatchAction(GridRedux.SetSettingPanelModuleMenuItems(menuItems));
-    }
-    setModuleButtonMenuItems(menuItems) {
-        this.dispatchAction(GridRedux.SetModuleButtonMenuItems(menuItems));
-    }
-    setSelectedCells(selectedCellInfo) {
-        this.dispatchAction(GridRedux.GridSetSelectedCells(selectedCellInfo));
-    }
-    setSelectedRows(selectedRowInfo) {
-        this.dispatchAction(GridRedux.GridSetSelectedRows(selectedRowInfo));
-    }
-    setPivotModeOn() {
-        this.dispatchAction(GridRedux.SetPivotModeOn());
-    }
-    setPivotModeOff() {
-        this.dispatchAction(GridRedux.SetPivotModeOff());
-    }
-    isGridInPivotMode() {
-        return this.getAdaptableState().Grid.IsGridInPivotMode;
-    }
-    setTreeModeOn() {
-        this.dispatchAction(GridRedux.SetTreeModeOn());
-    }
-    setTreeModeOff() {
-        this.dispatchAction(GridRedux.SetTreeModeOff());
-    }
-    isGridInTreeMode() {
-        return this.getAdaptableState().Grid.IsGridInTreeMode;
-    }
-    addAdaptableColumn(AdaptableColumn) {
-        this.dispatchAction(GridRedux.GridAddColumn(AdaptableColumn));
-    }
-    addAdaptableColumns(AdaptableColumns) {
-        this.dispatchAction(GridRedux.GridAddColumns(AdaptableColumns));
-    }
-    removeAdaptableColumn(colId) {
-        const col = this.getAdaptableState().Grid.Columns.find((c) => c.columnId === colId);
-        if (col) {
-            this.dispatchAction(GridRedux.GridRemoveColumn(col));
-        }
-    }
-    setGridCells(gridCells) {
-        if (ArrayExtensions_1.default.IsNotNullOrEmpty(gridCells)) {
-            gridCells.forEach((gc) => {
-                this.setGridCell(gc);
-            });
-        }
-    }
-    setToolbarTitle() {
-        let toolbarTitle = this.adaptable.api.dashboardApi.getDashboardState().DashboardTitle;
-        if (StringExtensions_1.default.IsNullOrEmpty(toolbarTitle)) {
-            toolbarTitle = this.adaptable.adaptableOptions.adaptableId;
-            if (toolbarTitle == GeneralConstants_1.ADAPTABLE_ID) {
-                toolbarTitle = 'Adaptable ';
-            }
-        }
-        return toolbarTitle;
-    }
-    setGridCell(gridCell) {
-        const cellDataChangedInfo = this.createDataChangedInfoFromGridCell(gridCell);
-        this.adaptable.setCellValue(cellDataChangedInfo);
-    }
-    buildDataChangedInfo(config) {
-        var _a;
-        return Object.assign(Object.assign({}, config), { rowData: (_a = config.rowNode) === null || _a === void 0 ? void 0 : _a.data, changedAt: Date.now() });
-    }
-    createDataChangedInfoFromGridCell(gridCell) {
-        let currentValue = this.adaptable.getDisplayValue(gridCell.primaryKeyValue, gridCell.column.columnId);
-        const currentRowNode = this.adaptable.getRowNodeForPrimaryKey(gridCell.primaryKeyValue);
-        const cellDataChangedInfo = this.buildDataChangedInfo({
-            oldValue: currentValue,
-            newValue: gridCell.rawValue,
-            column: gridCell.column,
-            primaryKeyValue: gridCell.primaryKeyValue,
-            rowNode: currentRowNode,
-        });
-        return cellDataChangedInfo;
-    }
-    setLastAppliedShortCut(gridCell) {
-        this.dispatchAction(SystemRedux.SetLastAppliedShortcut(gridCell));
-    }
-    updateCurrentDraftLayout(layout) {
-        this.dispatchAction(GridRedux.LayoutUpdateCurrentDraft(layout));
-    }
-    getPrimaryKey() {
-        return this.adaptable.adaptableOptions.primaryKey;
-    }
-    getAdaptableInstance() {
-        return this.adaptable;
-    }
-    getAgGridInstance() {
-        return this.adaptable.adaptableOptions.gridOptions;
-    }
-    getPredefinedConfig() {
-        return this.adaptable.adaptableOptions.predefinedConfig;
-    }
-    getState() {
-        return this.getAdaptableState();
-    }
-    getAdaptableOptions() {
-        return this.getOptions();
-    }
-    getValidationService() {
-        return this.adaptable.ValidationService;
-    }
-    getModuleService() {
-        return this.adaptable.ModuleService;
-    }
-    getDataService() {
-        return this.adaptable.DataService;
-    }
-    getReportService() {
-        return this.adaptable.ReportService;
-    }
-    getCalculatedColumnExpressionService() {
-        return this.adaptable.CalculatedColumnExpressionService;
-    }
-    getEntitlementService() {
-        return this.adaptable.EntitlementService;
-    }
-    getQueryLanguageService() {
-        return this.adaptable.QueryLanguageService;
-    }
-    getAlertService() {
-        return this.adaptable.AlertService;
-    }
-    getTeamSharingService() {
-        return this.adaptable.TeamSharingService;
-    }
-    getMetamodelService() {
-        return this.adaptable.MetamodelService;
-    }
-    getRowEditService() {
-        return this.adaptable.RowEditService;
-    }
-    getModules() {
-        return this.adaptable.adaptableModules;
-    }
-    getModuleFriendlyName(adaptableModule) {
-        var _a, _b;
-        return ((_b = (_a = this.adaptable.ModuleService.getModuleInfoByModule(adaptableModule)) === null || _a === void 0 ? void 0 : _a.FriendlyName) !== null && _b !== void 0 ? _b : adaptableModule);
-    }
-    runModuleInAdaptableQL(adaptableQLModule) {
-        const adaptableQLModules = this.getAdaptableQLOptions().externallyEvaluatedModules;
-        return !adaptableQLModules.includes(adaptableQLModule);
-    }
-    evaluateExpressionInAdaptableQL(module, expression) {
-        var _a;
-        // temporary, until `externallyEvaluatedModules` is removed completely
-        const externallyEvaluatedModules = this.getAdaptableQLOptions().externallyEvaluatedModules;
-        if (externallyEvaluatedModules === null || externallyEvaluatedModules === void 0 ? void 0 : externallyEvaluatedModules.length) {
-            // fallback to deprecated property
-            return this.runModuleInAdaptableQL(module);
-        }
-        const evaluateExpressionExternallyFn = (_a = this.getAdaptableQLOptions()) === null || _a === void 0 ? void 0 : _a.evaluateAdaptableQLExternally;
-        if (typeof evaluateExpressionExternallyFn !== 'function') {
-            return true;
-        }
-        const context = {
-            adaptableApi: this.getAdaptableApi(),
-            module,
-        };
-        if (expression) {
-            context.expression = expression;
-            context.referencedColumns = this.getAdaptableApi()
-                .queryLanguageApi.getColumnsFromExpression(expression)
-                .map((columnId) => this.getAdaptableApi().columnApi.getColumnFromId(columnId));
-        }
-        return evaluateExpressionExternallyFn(context);
-    }
-    forAllRowNodesDo(func) {
-        this.adaptable.forAllRowNodesDo(func);
-    }
-    forAllVisibleRowNodesDo(func) {
-        this.adaptable.forAllVisibleRowNodesDo(func);
-    }
-    buildStandaloneColumnHeader(column) {
-        return this.adaptable.buildStandaloneColumnHeader(column);
-    }
-    clearFlashingCellState() {
-        this.dispatchAction(AlertRedux.AlertClearFlashingCells());
-    }
-    clearUpdatedRowState() {
-        this.dispatchAction(DeadRedux.UpdatedRowClear());
-    }
-    clearGradientColumnState() {
-        this.dispatchAction(DeadRedux.GradientColumnClear());
-    }
-    clearPercentBarState() {
-        this.dispatchAction(DeadRedux.PercentBarClear());
-    }
-    getCustomSortComparer(column) {
-        var _a;
-        return (_a = this.getGeneralOptions().customSortComparers) === null || _a === void 0 ? void 0 : _a.find((csc) => this.adaptable.api.scopeApi.isColumnInScope(column, csc.scope));
-    }
-    getLabelForButton(button, context) {
-        if (!button.label) {
-            return '';
-        }
-        if (button.label != null && typeof button.label === 'function') {
-            return button.label(button, context);
-        }
-        else {
-            return button.label;
-        }
-    }
-    getTooltipForButton(button, context) {
-        if (!button.tooltip) {
-            return '';
-        }
-        if (button.tooltip != null && typeof button.tooltip === 'function') {
-            return button.tooltip(button, context);
-        }
-        else {
-            return button.tooltip;
-        }
-    }
-    getStyleForButton(button, context) {
-        if (!button.buttonStyle) {
-            return undefined;
-        }
-        if (button.buttonStyle != null && typeof button.buttonStyle === 'function') {
-            return button.buttonStyle(button, context);
-        }
-        else {
-            return button.buttonStyle;
-        }
-    }
-    getIconForButton(button, context, defaultWidthHeight) {
-        var _a, _b;
-        if (!button.icon) {
-            return;
-        }
-        let buttonIcon;
-        if (button.icon != null && typeof button.icon === 'function') {
-            buttonIcon = button.icon(button, context);
-        }
-        else {
-            buttonIcon = button.icon;
-        }
-        if (!buttonIcon) {
-            return;
-        }
-        if ((0, AdaptableIconComponent_1.isAdaptableInternalIcon)(buttonIcon) || (0, AdaptableIconComponent_1.isAdaptableExternalIcon)(buttonIcon)) {
-            const defaultIconWidth = (_a = defaultWidthHeight === null || defaultWidthHeight === void 0 ? void 0 : defaultWidthHeight.width) !== null && _a !== void 0 ? _a : 'var(--ab-cmp-simple-button__width)';
-            const defaultIconHeight = (_b = defaultWidthHeight === null || defaultWidthHeight === void 0 ? void 0 : defaultWidthHeight.height) !== null && _b !== void 0 ? _b : 'var(--ab-cmp-simple-button__height)';
-            const buttonIconStyle = Object.assign({}, { width: defaultIconWidth, height: defaultIconHeight }, buttonIcon.style);
-            buttonIcon.style = buttonIconStyle;
-        }
-        return buttonIcon;
-    }
-    isDocumentationLinksDisplayed() {
-        return this.adaptable.adaptableOptions.userInterfaceOptions.showDocumentationLinks;
-    }
-    // the row data which is used to preview the expression evaluation (usually the first row data)
-    getQueryPreviewData() {
-        var _a;
-        const firstRowNode = this.adaptable.api.gridApi.getFirstRowNode();
-        if (firstRowNode == undefined) {
-            return {};
-        }
-        const firstRowData = (_a = Object.assign({}, firstRowNode === null || firstRowNode === void 0 ? void 0 : firstRowNode.data)) !== null && _a !== void 0 ? _a : {};
-        // handle CalcCols which are not persisted in the rowModel
-        this.adaptable.api.calculatedColumnApi.getAllCalculatedColumn().forEach((calculatedColumn) => {
-            const columnRawValue = this.adaptable.api.gridApi.getRawValueFromRowNode(firstRowNode, calculatedColumn.ColumnId);
-            firstRowData[calculatedColumn.ColumnId] = columnRawValue;
-        });
-        // handle FreeTextCols which are not persisted in the rowModel
-        this.adaptable.api.freeTextColumnApi.getAllFreeTextColumn().forEach((freeTextColumn) => {
-            const columnRawValue = this.adaptable.api.gridApi.getRawValueFromRowNode(firstRowNode, freeTextColumn.ColumnId);
-            firstRowData[freeTextColumn.ColumnId] = columnRawValue;
-        });
-        return firstRowData;
-    }
-    getLocalTeamSharingEntities() {
-        return this.getAdaptableState().TeamSharing.SharedEntities;
-    }
-    waitForTeamSharingImportEnd() {
-        // we have no deterministic means to ensure the teamsharing import is finished (because the import actions are opaque and may have side-effects)
-        // therefore we will listen for state changes and
-        // if the state was unchanged in the last `waitForStableState` ms, we assume/hope the import is finished
-        const waitForStableState = 1000;
-        const waitThreshold = 5000;
-        return new Promise((resolve, reject) => {
-            let pollTimer;
-            // stop the poll after `waitThreshold` ms, if the state hasn't stabilised until now, it probably never will...
-            let breakTimer = setTimeout(() => {
-                unsubscribe === null || unsubscribe === void 0 ? void 0 : unsubscribe();
-                clearTimeout(pollTimer);
-                reject(false);
-            }, waitThreshold);
-            // poll state for changes:
-            const unsubscribe = this.adaptable.api.eventApi.on('AdaptableStateChanged', () => {
-                clearTimeout(pollTimer);
-                pollTimer = setTimeout(() => {
-                    // state is stable, cleanup all subscriptions before returning
-                    unsubscribe();
-                    clearTimeout(breakTimer);
-                    resolve(true);
-                }, waitForStableState);
-            });
-        });
-    }
-    createFrameworkComponent(containerDomNode, frameworkComponent, componentType) {
-        const createComponentFn = () => 
-        // delegate the logic to framework wrapper
-        this.adaptable._emit('FrameworkComponentChange', {
-            command: 'create',
-            containerDomNode,
-            frameworkComponent,
-            componentType,
-        });
-        if (this.adaptable.isInitialised) {
-            createComponentFn();
-        }
-        else {
-            // adaptable may not be initialized yet if the framework component is part of the initial render
-            // AFL 2021.10.14 - not really sure if this is necessary anymore?! (see the other changes in this commit)
-            (0, waitForCondition_1.waitForCondition)(() => this.adaptable.isInitialised).then(() => {
-                createComponentFn();
-            });
-        }
-    }
-    destroyFrameworkComponent(containerDomNode, frameworkComponent, componentType) {
-        this.adaptable._emit('FrameworkComponentChange', {
-            command: 'destroy',
-            containerDomNode,
-            frameworkComponent,
-            componentType,
-        });
-    }
-    initializeDataChangeHistory() {
-        if (this.adaptable.adaptableOptions.dataChangeHistoryOptions.activeByDefault) {
-            this.dispatchAction(SystemRedux.SystemDataChangeHistoryEnable());
-        }
-        else {
-            this.dispatchAction(SystemRedux.SystemDataChangeHistoryDisable());
-        }
-    }
-    isTextComparisonCaseSensitive() {
-        return this.adaptable.adaptableOptions.adaptableQLOptions.caseSensitiveTextComparisons;
-    }
-    executeWithProgressIndicator(label, executeFn) {
-        this.dispatchReduxAction((0, SystemRedux_1.SystemProgressIndicatorShow)(label));
-        // setTimeout required to give the ProgressIndicator rendering a head-start (see RAF in ProgressIndicator implementation)
-        setTimeout(() => {
-            try {
-                executeFn();
-            }
-            catch (error) {
-                this.hideProgressIndicator();
-                (0, LoggingHelper_1.LogAdaptableError)('Unexpected error while executing a function with a progress indicator', error);
-            }
-        }, 16);
-    }
-    hideProgressIndicator() {
-        this.dispatchReduxAction((0, SystemRedux_1.SystemProgressIndicatorHide)());
-    }
-    getCorrectEnglishVariant(wordToSpell) {
-        if (wordToSpell.includes('our')) {
-            return this.getGeneralOptions().englishVariant == 'GB'
-                ? wordToSpell
-                : wordToSpell.replace('our', 'or');
-        }
-        return wordToSpell;
-    }
-    hasLayoutSpecificObjects() {
-        const layoutTagOptions = this.getAdaptableOptions().layoutOptions.layoutTagOptions;
-        if (!layoutTagOptions) {
-            return false;
-        }
-        if (layoutTagOptions.autoCheckTagsForLayouts == true ||
-            typeof (layoutTagOptions === null || layoutTagOptions === void 0 ? void 0 : layoutTagOptions.isObjectAvailableInLayout) === 'function') {
-            return true;
-        }
-        return false;
-    }
-    isObjectAvailableInLayout(object, module, layout) {
-        var _a;
-        if (!this.hasLayoutSpecificObjects()) {
-            return true;
-        }
-        const layoutTagOptions = this.getAdaptableOptions().layoutOptions.layoutTagOptions;
-        if ((layoutTagOptions === null || layoutTagOptions === void 0 ? void 0 : layoutTagOptions.autoCheckTagsForLayouts) == true) {
-            return ArrayExtensions_1.default.IsNullOrEmpty(object.Tags) ? true : (_a = object.Tags) === null || _a === void 0 ? void 0 : _a.includes(layout.Name);
-        }
-        const context = {
-            adaptableObject: object,
-            module,
-            layout,
-            adaptableApi: this.getAdaptableApi(),
-        };
-        return layoutTagOptions === null || layoutTagOptions === void 0 ? void 0 : layoutTagOptions.isObjectAvailableInLayout(context);
-    }
-    showLayoutNotAssociatedObjects() {
-        return this.getAdaptableState().System.ShowLayoutNotAssociatedObjects;
-    }
-    shouldDisplayTagSections() {
-        return this.getAvailableTags() != undefined;
-    }
-    getAvailableTags() {
-        const layoutTags = this.getLayoutTags();
-        const objectTags = this.getObjectTags();
-        if (!layoutTags && !objectTags) {
-            return;
-        }
-        return [...(layoutTags || []), ...(objectTags || [])];
-    }
-    getObjectTags() {
-        if (!this.adaptable.adaptableOptions.userInterfaceOptions.objectTags) {
-            return;
-        }
-        if (Array.isArray(this.adaptable.adaptableOptions.userInterfaceOptions.objectTags)) {
-            return this.adaptable.adaptableOptions.userInterfaceOptions.objectTags;
-        }
-        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,
-            })
-                .filter((tag) => typeof tag === 'string');
-        }
-    }
-    getLayoutTags() {
-        var _a;
-        if (!((_a = this.adaptable.adaptableOptions.layoutOptions.layoutTagOptions) === null || _a === void 0 ? void 0 : _a.autoGenerateTagsForLayouts)) {
-            return;
-        }
-        if (this.adaptable.adaptableOptions.layoutOptions.layoutTagOptions.autoGenerateTagsForLayouts ===
-            true) {
-            return this.adaptable.api.layoutApi.getAllLayout().map((layout) => {
-                return layout.Name;
-            });
-        }
-        if (typeof this.adaptable.adaptableOptions.layoutOptions.layoutTagOptions
-            .autoGenerateTagsForLayouts === 'function') {
-            const autoGenerateTagsForLayoutsContext = {
-                layouts: this.adaptable.api.layoutApi.getAllLayout(),
-                objectTags: this.getAdaptableApi().userInterfaceApi.getAdaptableObjectTags(),
-                adaptableApi: this.adaptable.api,
-            };
-            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');
-        }
-    }
-    // General way to get to store from inside Adaptable...
-    dispatchReduxAction(action) {
-        this.dispatchAction(action);
-    }
-    // doing it this way to avoid having to expose Module Params which is internal
-    showSettingsPanel(module, moduleParams) {
-        this.showModulePopup(module, moduleParams);
-    }
-    getLabelForTag(adaptableObjectTag) {
-        // not very interesting right now, but useful later when tag is not only a plain string
-        return adaptableObjectTag;
-    }
-    getValueForTag(adaptableObjectTag) {
-        // not very interesting right now, but useful later when tag is not only a plain string
-        return adaptableObjectTag;
-    }
-    getEditLookUpValuesForColumn(editLookUpItem, column, gridCell) {
-        if (!editLookUpItem || !column) {
-            return undefined;
-        }
-        let editLookUpValues = editLookUpItem.values;
-        // first do the function then get hardcoded items
-        if (editLookUpValues != null && typeof editLookUpValues === 'function') {
-            const editLookUpContext = {
-                adaptableApi: this.adaptable.api,
-                column: column,
-                gridCell,
-            };
-            return editLookUpValues(editLookUpContext);
-        }
-        else {
-            let arr = editLookUpValues;
-            if (arr && ArrayExtensions_1.default.IsNotNullOrEmpty(arr)) {
-                return arr;
-            }
-        }
-        // if no hard-coded values or function provided then just get the distinct values for the column
-        // this will use the columnApi method that first looks for permitted values and then distinct values
-        return this.adaptable.api.columnApi.getDistinctDisplayValuesForColumn(column.columnId);
-    }
-    getAdaptableQueryExpressionText(query) {
-        var _a;
-        if (!query) {
-            return '';
-        }
-        const displayColumnFriendlyNames = (_a = this.adaptable.adaptableOptions.adaptableQLOptions) === null || _a === void 0 ? void 0 : _a.displayColumnFriendlyNamesForExpressions;
-        return displayColumnFriendlyNames
-            ? this.adaptable.api.queryLanguageApi.getAdaptableQueryExpressionWithColumnFriendlyNames(query)
-            : this.adaptable.api.queryLanguageApi.getAdaptableQueryExpression(query);
-    }
-}
-exports.InternalApiImpl = InternalApiImpl;