@adaptabletools/adaptable 18.0.2 → 18.0.4

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adaptabletools/adaptable",
-  "version": "18.0.2",
+  "version": "18.0.4",
   "description": "Powerful data-agnostic HTML5 AG Grid extension which provides advanced, cutting-edge functionality to meet all DataGrid requirements",
   "keywords": [
     "web-components",

package/src/AdaptableInterfaces/IAdaptable.d.ts

@@ -48,6 +48,7 @@ export interface DistinctValuesParams {
     visibleRowsOnly?: boolean;
     skipRowNode?: IRowNode;
     permittedValues?: any[];
+    addBlankValue?: boolean;
 }
 export type AdaptableVariant = 'vanilla' | 'react' | 'angular';
 /**
@@ -177,7 +178,7 @@ export interface IAdaptable {
     getDisplayValueFromRowNode(rowNode: IRowNode, columnId: string): string | undefined;
     getDisplayValueFromRawValue(rowNode: IRowNode, columnId: string, rawValue: any): string | undefined;
     getNormalisedValueFromRawValue(rawValue: any, column: AdaptableColumn): string | number | boolean | Date | unknown;
-    getGridCellsForColumn(columnId: string): GridCell[] | undefined;
+    getGridCellsForColumn(columnId: string, includeBlanks?: boolean): GridCell[] | undefined;
     getRowNodesForPrimaryKeys(primaryKeyValues: any[]): IRowNode[];
     getRowNodeForPrimaryKey(primaryKeyValue: any): IRowNode;
     getRowNodeByIndex(index: number): IRowNode;

package/src/AdaptableOptions/AdaptableFrameworkComponent.d.ts

@@ -36,15 +36,27 @@ export type ReactFrameworkComponent = ({ adaptableApi, }: {
  */
 export interface CustomRenderContext extends BaseContext {
     /**
-     * Whether Tool Panel is currently visible
+     * Whether Custom Component is visible
+     *
+     * @deprecated Use `phase` instead
      */
     visible: boolean;
     /**
-     * Current Div Element
+     * Phase of DOM Element lifecycle
+     */
+    phase: 'onMount' | 'onDestroy';
+    /**
+     * Container Div Element
      */
     element: HTMLDivElement;
 }
+/**
+ * Function which is called when rendering/destroying a custom framework-agnostic component
+ */
 export interface CustomRenderFunction {
+    /**
+     * Function to provide bespoke content when NOT using a Framework wrapper
+     */
     (customRenderContext: CustomRenderContext): string | null;
 }
 /**

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

@@ -104,7 +104,15 @@ export declare class AdaptableInternalApi extends ApiBase {
     getPreviousGroupedColumnsIndex(layoutId: string): {
         [key: string]: number;
     };
+    /**
+     * Gets a value from a rowData object using a field name.
+     * Supports deep values (e.g. fieldName = 'address.street')
+     */
     getValueUsingField(rowData: Record<string, any>, fieldName: string): any;
+    /**
+     * Sets a value in a rowData object using a field name.
+     * Supports deep values (e.g. fieldName = 'address.street')
+     */
     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;

package/src/Api/Internal/AdaptableInternalApi.js

@@ -351,6 +351,10 @@ export class AdaptableInternalApi extends ApiBase {
         var _a;
         return (_a = SystemRedux.SystemPreviousGroupedColumnsSelector(this.getAdaptableState().System)) === null || _a === void 0 ? void 0 : _a[layoutId];
     }
+    /**
+     * Gets a value from a rowData object using a field name.
+     * Supports deep values (e.g. fieldName = 'address.street')
+     */
     // "borrowed" from https://github.com/ag-grid/ag-grid/blob/v28.2.1/community-modules/core/src/ts/utils/object.ts#L205
     getValueUsingField(rowData, fieldName) {
         if (!rowData || !(fieldName === null || fieldName === void 0 ? void 0 : fieldName.length)) {
@@ -372,6 +376,10 @@ export class AdaptableInternalApi extends ApiBase {
         }
         return currentObject;
     }
+    /**
+     * Sets a value in a rowData object using a field name.
+     * Supports deep values (e.g. fieldName = 'address.street')
+     */
     // "borrowed" from https://github.com/ag-grid/ag-grid/blob/v28.2.1/community-modules/core/src/ts/valueService/valueService.ts#L236
     setValueUsingField(rowData, fieldName, newValue) {
         if (!rowData || !(fieldName === null || fieldName === void 0 ? void 0 : fieldName.length)) {
@@ -400,6 +408,10 @@ export class AdaptableInternalApi extends ApiBase {
                     }
                 }
                 else {
+                    // NOTE AFL: this was NOT in the original AG Grid code, but we need it to handle inserting deep values (the original implementation only handled updating)
+                    if (currentObject[fieldPiece] == null) {
+                        currentObject[fieldPiece] = {};
+                    }
                     currentObject = currentObject[fieldPiece];
                 }
             }

package/src/Api/Internal/GridInternalApi.js

@@ -6,6 +6,7 @@ import NumberExtensions from '../../Utilities/Extensions/NumberExtensions';
 import { convertAdaptableStyleToCSS } from '../../Utilities/Helpers/StyleHelper';
 import UIHelper from '../../View/UIHelper';
 import { createBaseContext } from '../../Utilities/ObjectFactory';
+import { BLANK_DISTINCT_COLUMN_VALUE } from '../../Utilities/Constants/GeneralConstants';
 export class GridInternalApi extends ApiBase {
     /**
      * Fires Grid Sorted Event
@@ -64,7 +65,7 @@ export class GridInternalApi extends ApiBase {
      * @param columnFilter Current applied filter
      */
     async getDistinctFilterDisplayValuesForColumn(columnId, filter, showFilteredRowsOnly) {
-        var _a;
+        var _a, _b;
         const abColumn = this.getColumnApi().getColumnWithColumnId(columnId);
         if (abColumn == undefined) {
             return {
@@ -72,8 +73,10 @@ export class GridInternalApi extends ApiBase {
                 suppressClientSideFilter: false,
             };
         }
+        const addBlankValue = this.getColumnFilterOptions().valuesFilterOptions.includeBlankFilterValues;
         const distinctValuesParams = {
             visibleRowsOnly: showFilteredRowsOnly,
+            addBlankValue: addBlankValue,
         };
         const { gridCells, suppressClientSideFilter } = await this.getDistinctFilterListValuesForColumn(abColumn, filter, distinctValuesParams);
         const sortedDistinctValues = this.sortDistinctValues(gridCells, abColumn);
@@ -84,12 +87,19 @@ export class GridInternalApi extends ApiBase {
             shouldShowValuesCount = showValuesCountFunction(columnFilterContext);
         }
         if (shouldShowValuesCount) {
-            const allColumnDisplayValues = (_a = this.adaptable
-                .getGridCellsForColumn(columnId)) === null || _a === void 0 ? void 0 : _a.map((gc) => {
-                return gc.displayValue;
-            });
+            const allColumnDisplayValues = addBlankValue
+                ? (_a = this.adaptable.getGridCellsForColumn(columnId, true)) === null || _a === void 0 ? void 0 : _a.map((gc) => {
+                    var _a;
+                    return (_a = gc.displayValue) !== null && _a !== void 0 ? _a : BLANK_DISTINCT_COLUMN_VALUE;
+                })
+                : (_b = this.adaptable.getGridCellsForColumn(columnId)) === null || _b === void 0 ? void 0 : _b.map((gc) => {
+                    return gc.displayValue;
+                });
+            const newsortedDistinctValues = addBlankValue
+                ? sortedDistinctValues
+                : sortedDistinctValues.filter((gc) => gc.displayValue !== undefined);
             return {
-                values: sortedDistinctValues.map((cv) => {
+                values: newsortedDistinctValues.map((cv) => {
                     const label = cv.displayValue +
                         NumberExtensions.WrapInParentheses(ArrayExtensions.getOccurrence(allColumnDisplayValues, cv.displayValue));
                     return {

package/src/Api/UserInterfaceApi.d.ts

@@ -81,8 +81,11 @@ export interface UserInterfaceApi {
      */
     hideLoadingScreen(): void;
     /**
-     *
-     * @param config
+     * Displays a progress indicator
+     * @param config.progressText - text to display in the progress indicator
+     * @param config.render - render function for a custom progress indicator (if not using a framework component)
+     * @param config.frameworkComponent - the framework (React/Angular) component to render as progress indicator
+     * @param config.delay - delay before showing the progress indicator (in milliseconds)
      */
     showProgressIndicator(config: {
         text?: string;
@@ -90,6 +93,9 @@ export interface UserInterfaceApi {
         frameworkComponent?: AdaptableFrameworkComponent;
         delay?: number;
     }): void;
+    /**
+     * Hides the progress indicator
+     */
     hideProgressIndicator(): void;
     /**
      * Opens window with custom content

package/src/Utilities/Services/RowSummaryService.js

@@ -98,6 +98,10 @@ export class RowSummaryService {
             return {
                 Position,
                 RowData: Object.entries(ColumnsMap !== null && ColumnsMap !== void 0 ? ColumnsMap : {}).reduce((acc, [columnId, expression]) => {
+                    var _a, _b;
+                    if (columnId === 'Uuid' || columnId === 'Source') {
+                        return acc;
+                    }
                     const key = `${columnId}-${expression}`;
                     let expressionLiveValue = this.cachedCellSummary.get(key);
                     if (expressionLiveValue) {
@@ -139,7 +143,9 @@ export class RowSummaryService {
                             value = Helper.roundNumber(value, 2);
                         }
                     }
-                    acc[columnId] = value;
+                    const column = this.api.columnApi.getColumnWithColumnId(columnId);
+                    const fieldName = (_b = (_a = column === null || column === void 0 ? void 0 : column.field) !== null && _a !== void 0 ? _a : column === null || column === void 0 ? void 0 : column.columnId) !== null && _b !== void 0 ? _b : columnId;
+                    acc = this.api.internalApi.setValueUsingField(acc, fieldName, value);
                     return acc;
                 }, {
                     [ROW_SUMMARY_ROW_ID]: true,

package/src/View/Components/ExternalRenderer.js

@@ -12,6 +12,7 @@ export const ExternalRenderer = (_a) => {
         if (render) {
             const html = render({
                 visible: true,
+                phase: 'onMount',
                 element,
                 adaptableApi,
                 userName: adaptableApi.optionsApi.getUserName(),
@@ -26,6 +27,7 @@ export const ExternalRenderer = (_a) => {
             if (render) {
                 render({
                     visible: false,
+                    phase: 'onDestroy',
                     element: element,
                     adaptableApi,
                     userName: adaptableApi.optionsApi.getUserName(),

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

@@ -17,6 +17,7 @@ export const CustomToolPanelContent = (props) => {
         if (hasCustomRenderFn(customToolPanel)) {
             const customRenderContext = {
                 visible: true,
+                phase: 'onMount',
                 element,
                 adaptableApi: api,
                 userName: api.optionsApi.getUserName(),
@@ -32,6 +33,7 @@ export const CustomToolPanelContent = (props) => {
             if (hasCustomRenderFn(customToolPanel)) {
                 customToolPanel.render({
                     visible: false,
+                    phase: 'onDestroy',
                     element,
                     adaptableApi: api,
                     userName: api.optionsApi.getUserName(),

package/src/View/Dashboard/CustomToolbar.js

@@ -19,6 +19,7 @@ export const CustomToolbarCmp = (props) => {
         if (props.customToolbar.render) {
             const html = props.customToolbar.render({
                 visible: true,
+                phase: 'onMount',
                 element,
                 adaptableApi,
                 userName: adaptableApi.optionsApi.getUserName(),
@@ -35,6 +36,7 @@ export const CustomToolbarCmp = (props) => {
             if (props.customToolbar.render) {
                 props.customToolbar.render({
                     visible: false,
+                    phase: 'onDestroy',
                     element,
                     adaptableApi,
                     userName: adaptableApi.optionsApi.getUserName(),

package/src/agGrid/AdaptableAgGrid.d.ts

@@ -114,6 +114,11 @@ export declare class AdaptableAgGrid implements IAdaptable {
     renderReactRoot: RenderReactRootFn;
     private unmountReactRoot?;
     private unmountLoadingScreen?;
+    /**
+     * do NOT mutate this array reference, this is passed only initially to AG Grid and we can only change it's internal state
+     */
+    private DANGER_excelStyles;
+    private originalExcelStyles;
     /**
      * Temporary, these are MIGRATION technical debts, and should be removed as soon as possible
      */
@@ -236,9 +241,10 @@ export declare class AdaptableAgGrid implements IAdaptable {
     getDistinctValuesForColumn(column: AdaptableColumn, distinctValuesParams: DistinctValuesParams): GridCell[];
     private getGridCellsForPermittedValues;
     private getDistinctGridCellsForColumn;
+    addBlankValueToGridCell(gridCell: GridCell): void;
     private addDistinctColumnValue;
     private getUniqueGridCells;
-    getGridCellsForColumn(columnId: string): GridCell[] | undefined;
+    getGridCellsForColumn(columnId: string, includeBlanks?: boolean): GridCell[] | undefined;
     getRowNodesForPrimaryKeys(primaryKeyValues: any[]): any[];
     getRowNodeByIndex(index: number): IRowNode;
     getAgGridStatusPanels(): import("@ag-grid-community/core").StatusPanelDef[];

package/src/agGrid/AdaptableAgGrid.js

@@ -147,6 +147,11 @@ export class AdaptableAgGrid {
         this.previousAgGridLayoutState = '';
         this.columnMinMaxValuesCache = {};
         this.renderReactRoot = (node, container) => defaultRenderReactRoot(node, container);
+        /**
+         * do NOT mutate this array reference, this is passed only initially to AG Grid and we can only change it's internal state
+         */
+        this.DANGER_excelStyles = [];
+        this.originalExcelStyles = [];
         /**
          * Temporary, these are MIGRATION technical debts, and should be removed as soon as possible
          */
@@ -535,7 +540,7 @@ export class AdaptableAgGrid {
          */
         this.agGridOptionsService.setGridOptionsProperty(gridOptions, 'context', (original_context) => {
             const userContext = original_context || {};
-            return Object.assign(Object.assign({}, userContext), { __adaptable: this });
+            return Object.assign(Object.assign({}, userContext), { __adaptable: this, adaptableApi: this.api });
         });
         /**
          * `gridId`
@@ -902,8 +907,10 @@ export class AdaptableAgGrid {
          * `excelStyles`
          */
         this.agGridOptionsService.setGridOptionsProperty(gridOptions, 'excelStyles', (original_excelStyles) => {
-            // we need this here just to register the original excelStyles in the service
-            return original_excelStyles;
+            this.originalExcelStyles = original_excelStyles !== null && original_excelStyles !== void 0 ? original_excelStyles : [];
+            this.DANGER_excelStyles = this.originalExcelStyles;
+            // this array reference will be used for the entire AG Grid session
+            return this.DANGER_excelStyles;
         });
         /**
          * `processPivotResultColDef`
@@ -2264,9 +2271,10 @@ export class AdaptableAgGrid {
         if (distinctValuesParams.visibleRowsOnly) {
             this.agGridAdapter.getAgGridApi().forEachNodeAfterFilter((rowNode) => {
                 const gridCell = this.addDistinctColumnValue(rowNode, column.columnId);
-                if (gridCell &&
-                    gridCell.rawValue != undefined &&
-                    gridCell.rowNode !== distinctValuesParams.skipRowNode) {
+                if (gridCell && gridCell.rowNode !== distinctValuesParams.skipRowNode) {
+                    if (gridCell.rawValue == undefined && distinctValuesParams.addBlankValue) {
+                        this.addBlankValueToGridCell(gridCell);
+                    }
                     gridCells.push(gridCell);
                 }
             });
@@ -2275,11 +2283,8 @@ export class AdaptableAgGrid {
             this.agGridAdapter.getAgGridApi().forEachNode((rowNode) => {
                 const gridCell = this.addDistinctColumnValue(rowNode, column.columnId);
                 if (gridCell && gridCell.rowNode !== distinctValuesParams.skipRowNode) {
-                    if (gridCell.rawValue == undefined &&
-                        this.adaptableOptions.columnFilterOptions.valuesFilterOptions.includeBlankFilterValues) {
-                        gridCell.rawValue = BLANK_DISTINCT_COLUMN_VALUE;
-                        gridCell.displayValue = BLANK_DISTINCT_COLUMN_VALUE;
-                        gridCell.normalisedValue = BLANK_DISTINCT_COLUMN_VALUE;
+                    if (gridCell.rawValue == undefined && distinctValuesParams.addBlankValue) {
+                        this.addBlankValueToGridCell(gridCell);
                     }
                     gridCells.push(gridCell);
                 }
@@ -2287,6 +2292,11 @@ export class AdaptableAgGrid {
         }
         return gridCells;
     }
+    addBlankValueToGridCell(gridCell) {
+        gridCell.rawValue = BLANK_DISTINCT_COLUMN_VALUE;
+        gridCell.displayValue = BLANK_DISTINCT_COLUMN_VALUE;
+        gridCell.normalisedValue = BLANK_DISTINCT_COLUMN_VALUE;
+    }
     addDistinctColumnValue(rowNode, columnId) {
         // we do not return the values of the aggregates when in grouping mode
         // otherwise they would appear in the filter dropdown etc....
@@ -2313,12 +2323,19 @@ export class AdaptableAgGrid {
         }
         return uniqueVals.slice(0, this.api.columnFilterApi.internalApi.getFilterValuesMaxNumberOfItems(column));
     }
-    getGridCellsForColumn(columnId) {
+    getGridCellsForColumn(columnId, includeBlanks = false) {
         let returnValues = [];
         this.agGridAdapter.getAgGridApi().forEachNode((rowNode) => {
             const gridCell = this.getGridCellFromRowNode(rowNode, columnId);
-            if (gridCell && gridCell.rawValue != undefined) {
-                returnValues.push(gridCell);
+            if (gridCell) {
+                if (gridCell.rawValue == undefined || gridCell.rawValue == null) {
+                    if (includeBlanks) {
+                        returnValues.push(gridCell);
+                    }
+                }
+                else {
+                    returnValues.push(gridCell);
+                }
             }
         });
         return returnValues;
@@ -3058,7 +3075,9 @@ export class AdaptableAgGrid {
     exportVisualDataToExcel() {
         try {
             const exportExcelStyles = this.ReportService.buildExcelStylesForVisualReports();
-            this.agGridOptionsService.CAREFUL_patchGridOptionsProperty('excelStyles', exportExcelStyles);
+            // set DANGER_excelStyles without changing the array reference
+            this.DANGER_excelStyles.splice(0, this.DANGER_excelStyles.length, ...exportExcelStyles);
+            // this.agGridOptionsService.CAREFUL_patchGridOptionsProperty('excelStyles', exportExcelStyles);
             this.agGridAdapter.getAgGridApi().exportDataAsExcel({
                 sheetName: 'Sheet 1',
                 fileName: this.ReportService.getReportFileName(this.adaptableOptions.adaptableId, 'Excel'),
@@ -3096,7 +3115,7 @@ export class AdaptableAgGrid {
                     return summary;
                 },
             });
-            this.agGridOptionsService.revertGridOptionsPropertyToUserValue('excelStyles');
+            this.DANGER_excelStyles.splice(0, this.DANGER_excelStyles.length, ...this.originalExcelStyles);
         }
         catch (error) {
             this.logger.consoleError('Error exporting visual data to Excel', error);

package/src/agGrid/AgGridOptionsService.d.ts

@@ -9,7 +9,6 @@ export declare class AgGridOptionsService {
     setGridOptionsProperty<T extends keyof GridOptions>(gridOptions: GridOptions, propertyName: T, propertyGetter: (userPropertyValue: GridOptions[T]) => GridOptions[T] | undefined): GridOptions;
     getUserGridOptionsProperty<T extends keyof GridOptions>(propertyName: T): GridOptions[T];
     revertGridOptionsPropertyToUserValue(propertyName: ManagedGridOptionKey): void;
-    CAREFUL_patchGridOptionsProperty<T extends keyof GridOptions>(propertyName: T, value: GridOptions[T]): void;
     revertGridOptionsPropertiesToUserValue<T extends keyof GridOptions>(gridOptions: GridOptions, propertyNames: T[]): void;
     private get agGridAdapter();
 }

package/src/agGrid/AgGridOptionsService.js

@@ -49,19 +49,6 @@ export class AgGridOptionsService {
         const userValue = this.gridOptionsPropertyCache.get(userKey);
         this.agGridAdapter.setGridOption(propertyName, userValue);
     }
-    CAREFUL_patchGridOptionsProperty(propertyName, value) {
-        var _a;
-        // @ts-ignore this is required to set gridOptions peroperties which are marked as initial (writable once, before grid is initialised)
-        const gos = (_a = this.agGridAdapter.getAgGridApi()) === null || _a === void 0 ? void 0 : _a.gos;
-        if (gos) {
-            gos.updateGridOptions({
-                options: {
-                    [propertyName]: value,
-                },
-                source: 'api',
-            });
-        }
-    }
     revertGridOptionsPropertiesToUserValue(gridOptions, propertyNames) {
         for (const propertyName of propertyNames) {
             // see this.setGridOptionsProperty(...)

package/src/env.js

@@ -1,5 +1,5 @@
 export default {
     INFINITE_TABLE_LICENSE_KEY: "StartDate=2021-06-29|EndDate=2030-01-01|Owner=Adaptable|Type=distribution|TS=1624971462479|C=137829811,1004007071,2756196225,1839832928,3994409405,636616862" || '',
-    PUBLISH_TIMESTAMP: 1713453383420 || Date.now(),
-    VERSION: "18.0.2" || '--current-version--',
+    PUBLISH_TIMESTAMP: 1713957370862 || Date.now(),
+    VERSION: "18.0.4" || '--current-version--',
 };

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

@@ -2292,6 +2292,16 @@ export declare const ADAPTABLE_METAMODEL: {
             ref?: undefined;
         })[];
     };
+    CustomRenderFunction: {
+        name: string;
+        kind: string;
+        desc: string;
+        props: {
+            name: string;
+            kind: string;
+            desc: string;
+        }[];
+    };
     CustomSettingsPanel: {
         name: string;
         kind: string;