@adaptabletools/adaptable 15.4.0 → 15.4.2

package/src/Strategy/CalculatedColumnModule.d.ts

@@ -1,7 +1,7 @@
 /// <reference types="react" />
 import { AdaptableModuleBase } from './AdaptableModuleBase';
 import { AdaptableColumn } from '../PredefinedConfig/Common/AdaptableColumn';
-import { AdaptableMenuItem } from '../PredefinedConfig/Common/Menu';
+import { AdaptableMenuItem, ContextMenuContext } from '../PredefinedConfig/Common/Menu';
 import * as CalculatedColumnRedux from '../Redux/ActionsReducers/CalculatedColumnRedux';
 import { TeamSharingImportInfo } from '../PredefinedConfig/TeamSharingState';
 import { CalculatedColumn } from '../PredefinedConfig/CalculatedColumnState';
@@ -16,7 +16,10 @@ export declare class CalculatedColumnModule extends AdaptableModuleBase implemen
     updateOldConfig(): void;
     getExplicitlyReferencedColumnIds(calculatedColumn: CalculatedColumn): string[];
     getReferencedNamedQueryNames(calculatedColumn: CalculatedColumn): string[];
+    private isCalculatedColumn;
     addColumnMenuItems(column: AdaptableColumn): AdaptableMenuItem[] | undefined;
+    addContextMenuItems(menuContext: ContextMenuContext): AdaptableMenuItem[] | undefined;
+    createEditCalculatedColumnMenuItem(column: AdaptableColumn): AdaptableMenuItem[];
     getTeamSharingAction(): TeamSharingImportInfo<CalculatedColumn>;
     toView(calculateColumn: CalculatedColumn): {
         items: AdaptableObjectItemView[];

package/src/Strategy/CalculatedColumnModule.js

@@ -10,6 +10,7 @@ const CalculatedColumnWizard_1 = require("../View/CalculatedColumn/Wizard/Calcul
 const ArrayExtensions_1 = tslib_1.__importDefault(require("../Utilities/Extensions/ArrayExtensions"));
 const getObjectTagsViewItems_1 = require("./Utilities/getObjectTagsViewItems");
 const getCalculatedColumnSettingsTags_1 = require("../View/CalculatedColumn/Utilities/getCalculatedColumnSettingsTags");
+const Helper_1 = tslib_1.__importDefault(require("../Utilities/Helpers/Helper"));
 class CalculatedColumnModule extends AdaptableModuleBase_1.AdaptableModuleBase {
     constructor(api) {
         super(ModuleConstants.CalculatedColumnModuleId, ModuleConstants.CalculatedColumnFriendlyName, 'chart-and-grid', 'CalculatedColumnPopup', 'Create bespoke columns whose cell value is derived dynamically from an Expression', api);
@@ -51,22 +52,38 @@ class CalculatedColumnModule extends AdaptableModuleBase_1.AdaptableModuleBase {
         var _a;
         return ((_a = this.api.queryApi.internalApi.getReferencedNamedQueryNames(this.api.queryLanguageApi.getAdaptableQueryExpression(calculatedColumn.Query))) !== null && _a !== void 0 ? _a : []);
     }
-    addColumnMenuItems(column) {
-        if (column && this.isModuleEditable()) {
-            if (this.api.calculatedColumnApi
+    isCalculatedColumn(column) {
+        return (column &&
+            Helper_1.default.objectExists(this.api.calculatedColumnApi
                 .getCalculatedColumns()
-                .find((cc) => cc.ColumnId == column.columnId)) {
-                let popupParam = {
-                    column: column,
-                    action: 'Edit',
-                    source: 'ColumnMenu',
-                };
-                return [
-                    this.createColumnMenuItemShowPopup('Edit Calculated Column', this.moduleInfo.Popup, this.moduleInfo.Glyph, popupParam),
-                ];
-            }
+                .find((cc) => cc.ColumnId == column.columnId)));
+    }
+    addColumnMenuItems(column) {
+        if (this.isModuleEditable() && this.isCalculatedColumn(column)) {
+            return this.createEditCalculatedColumnMenuItem(column);
         }
     }
+    addContextMenuItems(menuContext) {
+        if (!this.isModuleAvailable()) {
+            return;
+        }
+        if (this.isModuleEditable() &&
+            this.isCalculatedColumn(menuContext.adaptableColumn) &&
+            !menuContext.isRowGroupColumn &&
+            menuContext.isSingleSelectedCell) {
+            return this.createEditCalculatedColumnMenuItem(menuContext.adaptableColumn);
+        }
+    }
+    createEditCalculatedColumnMenuItem(column) {
+        let popupParam = {
+            column: column,
+            action: 'Edit',
+            source: 'ColumnMenu',
+        };
+        return [
+            this.createColumnMenuItemShowPopup('Edit Calculated Column', this.moduleInfo.Popup, this.moduleInfo.Glyph, popupParam),
+        ];
+    }
     getTeamSharingAction() {
         return {
             ModuleEntities: this.api.calculatedColumnApi.getCalculatedColumns(),

package/src/Strategy/Interface/ISmartEditModule.d.ts

@@ -2,9 +2,9 @@ import { IModule } from './IModule';
 import { IModuleActionReturn } from './IModuleActionReturn';
 import { MathOperation } from '../../PredefinedConfig/Common/Enums';
 import { PreviewInfo } from '../../Utilities/Interface/Preview';
-import { GridCell } from '../../PredefinedConfig/Selection/GridCell';
+import { CellUpdateRequest } from '../../PredefinedConfig/Selection/GridCell';
 export interface ISmartEditModule extends IModule {
     CheckCorrectCellSelection(): IModuleActionReturn<boolean>;
     BuildPreviewValues(smartEditValue: number, smartEditOperation: MathOperation): PreviewInfo;
-    ApplySmartEdit(newValues: GridCell[]): void;
+    ApplySmartEdit(cellUpdateRequests: CellUpdateRequest[]): void;
 }

package/src/Strategy/PlusMinusModule.js

@@ -144,7 +144,16 @@ class PlusMinusModule extends AdaptableModuleBase_1.AdaptableModuleBase {
         });
         this.ShowErrorPreventMessage(failedPreventEdits);
         if (ArrayExtensions_1.ArrayExtensions.IsNotNullOrEmpty(successfulValues)) {
-            this.api.plusMinusApi.applyPlusMinus(successfulValues);
+            const cellUpdateRequests = [];
+            successfulValues.forEach((gridCell) => {
+                cellUpdateRequests.push({
+                    columnId: gridCell.column.columnId,
+                    newValue: gridCell.normalisedValue,
+                    primaryKeyValue: gridCell.primaryKeyValue,
+                    rowNode: gridCell.rowNode,
+                });
+            });
+            this.api.plusMinusApi.applyPlusMinus(cellUpdateRequests);
         }
         return shouldApplyPlusMinus;
     }

package/src/Strategy/SmartEditModule.d.ts

@@ -2,7 +2,7 @@ import { AdaptableModuleBase } from './AdaptableModuleBase';
 import { IModuleActionReturn } from './Interface/IModuleActionReturn';
 import { ISmartEditModule } from './Interface/ISmartEditModule';
 import { PreviewInfo } from '../Utilities/Interface/Preview';
-import { GridCell } from '../PredefinedConfig/Selection/GridCell';
+import { CellUpdateRequest } from '../PredefinedConfig/Selection/GridCell';
 import { AdaptableMenuItem, ContextMenuContext } from '../PredefinedConfig/Common/Menu';
 import { AdaptableApi } from '../Api/AdaptableApi';
 import { AccessLevel } from '../PredefinedConfig/Common/Entitlement';
@@ -11,7 +11,7 @@ export declare class SmartEditModule extends AdaptableModuleBase implements ISma
     constructor(api: AdaptableApi);
     getViewAccessLevel(): AccessLevel;
     addContextMenuItems(menuContext: ContextMenuContext): AdaptableMenuItem[] | undefined;
-    ApplySmartEdit(newValues: GridCell[]): void;
+    ApplySmartEdit(cellUpdateRequests: CellUpdateRequest[]): void;
     CheckCorrectCellSelection(): IModuleActionReturn<boolean>;
     BuildPreviewValues(smartEditValue: number, smartEditOperation: SmartEditOperation): PreviewInfo;
 }

package/src/Strategy/SmartEditModule.js

@@ -41,8 +41,8 @@ class SmartEditModule extends AdaptableModuleBase_1.AdaptableModuleBase {
         }
         return [menuItemShowPopup];
     }
-    ApplySmartEdit(newValues) {
-        this.api.smartEditApi.applySmartEdit(newValues);
+    ApplySmartEdit(cellUpdateRequests) {
+        this.api.smartEditApi.applySmartEdit(cellUpdateRequests);
     }
     CheckCorrectCellSelection() {
         let selectedCellInfo = this.api.gridApi.getSelectedCellInfo();

package/src/Utilities/Helpers/FormatHelper.js

@@ -113,7 +113,7 @@ function StringFormatter(input, options = {}) {
         return undefined;
     }
     if (options.Empty) {
-        return '';
+        return ' ';
     }
     let s = preparedInput;
     if (options.Prefix !== undefined) {

package/src/Utilities/Helpers/PreviewHelper.d.ts

@@ -1,11 +1,13 @@
 import { PreviewResult, PreviewValidationSummary, PreviewInfo } from '../Interface/Preview';
-import { GridCell } from '../../PredefinedConfig/Selection/GridCell';
+import { CellUpdateRequest, GridCell } from '../../PredefinedConfig/Selection/GridCell';
 export declare function GetPreviewValidationSummary(previewResults: PreviewResult[]): PreviewValidationSummary;
 export declare function GetValidationMessage(previewInfo: PreviewInfo, newValue: string): string;
 export declare function GetCellInfosFromPreview(previewInfo: PreviewInfo, bypassValidationWarnings: boolean): GridCell[];
+export declare function GetCellUpdateRequestsFromPreview(previewInfo: PreviewInfo, bypassValidationWarnings: boolean): CellUpdateRequest[];
 export declare const PreviewHelper: {
     GetPreviewValidationSummary: typeof GetPreviewValidationSummary;
     GetValidationMessage: typeof GetValidationMessage;
     GetCellInfosFromPreview: typeof GetCellInfosFromPreview;
+    GetCellUpdateRequestsFromPreview: typeof GetCellUpdateRequestsFromPreview;
 };
 export default PreviewHelper;

package/src/Utilities/Helpers/PreviewHelper.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.PreviewHelper = exports.GetCellInfosFromPreview = exports.GetValidationMessage = exports.GetPreviewValidationSummary = void 0;
+exports.PreviewHelper = exports.GetCellUpdateRequestsFromPreview = exports.GetCellInfosFromPreview = exports.GetValidationMessage = exports.GetPreviewValidationSummary = void 0;
 const StringExtensions_1 = require("../Extensions/StringExtensions");
 function GetPreviewValidationSummary(previewResults) {
     let hasAnyValidation = false;
@@ -65,9 +65,39 @@ function GetCellInfosFromPreview(previewInfo, bypassValidationWarnings) {
     return newValues;
 }
 exports.GetCellInfosFromPreview = GetCellInfosFromPreview;
+function GetCellUpdateRequestsFromPreview(previewInfo, bypassValidationWarnings) {
+    let newValues = [];
+    if (bypassValidationWarnings) {
+        for (let previewResult of previewInfo.previewResults) {
+            if (previewResult.validationRules.length == 0) {
+                newValues.push({
+                    primaryKeyValue: previewResult.id,
+                    newValue: previewResult.computedValue,
+                    rowNode: previewResult.rowNode,
+                    columnId: previewInfo.column.columnId,
+                });
+            }
+        }
+    }
+    else {
+        previewInfo.previewResults
+            .filter((p) => p.validationRules.length == 0)
+            .forEach((pr) => {
+            newValues.push({
+                primaryKeyValue: pr.id,
+                columnId: previewInfo.column.columnId,
+                newValue: pr.computedValue,
+                rowNode: pr.rowNode,
+            });
+        });
+    }
+    return newValues;
+}
+exports.GetCellUpdateRequestsFromPreview = GetCellUpdateRequestsFromPreview;
 exports.PreviewHelper = {
     GetPreviewValidationSummary,
     GetValidationMessage,
     GetCellInfosFromPreview,
+    GetCellUpdateRequestsFromPreview,
 };
 exports.default = exports.PreviewHelper;

package/src/Utilities/Helpers/StyleHelper.d.ts

@@ -1,5 +1,9 @@
 import { AdaptableStyle } from '../../types';
 export declare const AgGridCellStyleProperties: readonly ["backgroundColor", "color", "fontWeight", "fontStyle", "fontSize", "borderColor"];
+export declare const normalizeStyleForAgGrid: (style: Record<string, any>) => {
+    [x: string]: any;
+};
+export declare const sanitizeStyle: (style: Record<string, any>) => Record<string, any>;
 export declare const convertAdaptableStyleToCSS: (style: AdaptableStyle) => {
     [cssProperty: string]: string;
 };

package/src/Utilities/Helpers/StyleHelper.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getVariableColor = exports.toStyle = exports.convertCSSAbsoluteFontSizeToPt = exports.convertAdaptableStyleToCSS = exports.AgGridCellStyleProperties = void 0;
+exports.getVariableColor = exports.toStyle = exports.convertCSSAbsoluteFontSizeToPt = exports.convertAdaptableStyleToCSS = exports.sanitizeStyle = exports.normalizeStyleForAgGrid = exports.AgGridCellStyleProperties = void 0;
 const EnumExtensions_1 = require("../Extensions/EnumExtensions");
 // required for hacky fix for https://github.com/AdaptableTools/adaptable/issues/2119
 exports.AgGridCellStyleProperties = [
@@ -11,6 +11,30 @@ exports.AgGridCellStyleProperties = [
     'fontSize',
     'borderColor',
 ];
+// see https://github.com/AdaptableTools/adaptable/issues/2119
+// since v29 AG Grid ignores style properties with null or undefined values
+// Fix: pass empty string instead of null/undefined
+const normalizeStyleForAgGrid = (style) => {
+    const normalizedStyle = Object.assign({}, style);
+    exports.AgGridCellStyleProperties.forEach((cellStylePropKey) => {
+        if (normalizedStyle[cellStylePropKey] == null) {
+            normalizedStyle[cellStylePropKey] = '';
+        }
+    });
+    return normalizedStyle;
+};
+exports.normalizeStyleForAgGrid = normalizeStyleForAgGrid;
+// the inverse of normalizeStyleForAgGrid, see comments above
+const sanitizeStyle = (style) => {
+    const sanitizedStyle = {};
+    Object.keys(style).forEach((key) => {
+        if (style[key] != null && style[key] !== '') {
+            sanitizedStyle[key] = style[key];
+        }
+    });
+    return sanitizedStyle;
+};
+exports.sanitizeStyle = sanitizeStyle;
 const convertAdaptableStyleToCSS = (style) => {
     let result = {};
     if (style.BackColor !== undefined && style.BackColor !== null) {

package/src/agGrid/Adaptable.d.ts

@@ -199,7 +199,6 @@ export declare class Adaptable implements IAdaptable {
     setSelectedCells(): SelectedCellInfo | undefined;
     setSelectedRows(): SelectedRowInfo | undefined;
     setDataValue(value: any, column: AdaptableColumn, primaryKeyValue: any, rowNode?: IRowNode): void;
-    setCellValue(cellDataChangedInfo: CellDataChangedInfo): void;
     cancelEdit(): void;
     isCellEditable(rowNode: IRowNode, column: Column): boolean;
     getGridCellsForColumn(columnId: string): GridCell[] | undefined;

package/src/agGrid/Adaptable.js

@@ -1779,9 +1779,6 @@ class Adaptable {
             }
         }
     }
-    setCellValue(cellDataChangedInfo) {
-        this.setDataValue(cellDataChangedInfo.newValue, cellDataChangedInfo.column, cellDataChangedInfo.primaryKeyValue, cellDataChangedInfo.rowNode);
-    }
     cancelEdit() {
         this.gridOptions.api.stopEditing(true);
     }
@@ -3277,13 +3274,7 @@ class Adaptable {
             const cellStyle = (params) => {
                 const isQuickSearchActive = hasQuickSearchStyle && this.isQuickSearchActive(abColumn, params);
                 const result = Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign({}, this.getReadOnlyCellStyle(abColumn, params)), this.getEditableCellStyle(abColumn, params)), (typeof userCellStyle === 'function' ? userCellStyle(params) : userCellStyle)), this.getFormatColumnAndStyledColumnCellStyle(abColumn, colId, params)), (isQuickSearchActive ? quickSearchStyle : {})), this.getAlertCellStyle(abColumn, params)), this.getFlashingCellStyle(abColumn, params)), this.getCellHighlightStyle(abColumn, params));
-                // see https://github.com/AdaptableTools/adaptable/issues/2119
-                StyleHelper_1.AgGridCellStyleProperties.forEach((cellStylePropKey) => {
-                    if (result[cellStylePropKey] == null) {
-                        result[cellStylePropKey] = '';
-                    }
-                });
-                return result;
+                return (0, StyleHelper_1.normalizeStyleForAgGrid)(result);
             };
             return cellStyle;
         });
@@ -3614,7 +3605,7 @@ class Adaptable {
                     }
                     // we allowed it go reach this point
                     // just to run isCellEditable
-                    // and since this has already run and we have no other valitaions
+                    // and since this has already run and we have no other validations
                     // just assign the new value and exit
                     if (field) {
                         params.data[field] = params.newValue;
@@ -4654,8 +4645,9 @@ class Adaptable {
                         }
                         return result;
                     }, {}));
-                    if (Object.values(adaptableStyle).some((style) => style != null)) {
-                        excelStyles.push(this.convertCSSToExcelStyle(adaptableStyle));
+                    const sanitizedAdaptableStyle = (0, StyleHelper_1.sanitizeStyle)(adaptableStyle);
+                    if (Object.values(sanitizedAdaptableStyle).some((style) => style != null)) {
+                        excelStyles.push(this.convertCSSToExcelStyle(sanitizedAdaptableStyle));
                     }
                     const excelDataType = this.api.exportApi.internalApi.getExcelDataType(colDef === null || colDef === void 0 ? void 0 : colDef.type);
                     const rawValue = this.getRawValueFromRowNode(node, column.getId());

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

@@ -1387,6 +1387,22 @@ export declare const ADAPTABLE_METAMODEL: {
         kind: string;
         desc: string;
     };
+    CellUpdateRequest: {
+        name: string;
+        kind: string;
+        desc: string;
+        props: ({
+            name: string;
+            kind: string;
+            desc: string;
+            isOpt?: undefined;
+        } | {
+            name: string;
+            kind: string;
+            desc: string;
+            isOpt: boolean;
+        })[];
+    };
     ChartContainer: {
         name: string;
         kind: string;