@adaptabletools/adaptable 18.0.10-canary.3 → 18.0.10

package/package.json

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

package/src/Api/ColumnApi.d.ts

@@ -1,4 +1,5 @@
 import { AdaptableColumn, AdaptableColumnDataType } from '../../types';
+import { ColDef, ColGroupDef, ColumnPinnedType, IAggFunc } from '@ag-grid-community/core';
 /**
  * Provides run-time access to AdapTable Column related features
  */
@@ -275,4 +276,47 @@ export interface ColumnApi {
      * Returns all columns currently Row Grouped
      */
     getRowGroupedColumns(): AdaptableColumn[];
+    /**
+     * Updates the Column Configuration for a given Column. It will update the current Layout with the new configuration.
+     * @param columnConfiguration - the Column Configuration to set
+     */
+    updateColumnConfiguration(columnConfiguration: ColumnConfig): void;
+    /**
+     * Updates the Column Configurations for a list of Columns. It will update the current Layout with the new configurations.
+     * @param columnConfigurations - the Column Configurations to set
+     */
+    updateColumnConfigurations(columnConfigurations: ColumnConfig[]): void;
+    /**
+     * Sets the Column Definitions for the Grid
+     */
+    setColumnDefinitions(columnDefinitions: (ColDef | ColGroupDef)[]): void;
+}
+/**
+ * Column Configuration
+ */
+export interface ColumnConfig {
+    /** Column Id */
+    colId: string;
+    /** True if the column is hidden */
+    hide?: boolean | null;
+    /** Width of the column in pixels */
+    width?: number;
+    /** Column's flex if flex is set */
+    flex?: number | null;
+    /** Sort applied to the column */
+    sort?: 'asc' | 'desc' | null;
+    /** The order of the sort, if sorting by many columns */
+    sortIndex?: number | null;
+    /** The aggregation function applied */
+    aggFunc?: string | IAggFunc | null;
+    /** True if pivot active */
+    pivot?: boolean | null;
+    /** The order of the pivot, if pivoting by many columns */
+    pivotIndex?: number | null;
+    /** Set if column is pinned */
+    pinned?: ColumnPinnedType;
+    /** True if row group active */
+    rowGroup?: boolean | null;
+    /** The order of the row group, if grouping by many columns */
+    rowGroupIndex?: number | null;
 }

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

@@ -1,8 +1,9 @@
 import { ApiBase } from './ApiBase';
 import { AdaptableColumn, AdaptableColumnDataType } from '../../PredefinedConfig/Common/AdaptableColumn';
-import { ColumnApi } from '../ColumnApi';
+import { ColumnApi, ColumnConfig } from '../ColumnApi';
 import { IAdaptable } from '../../AdaptableInterfaces/IAdaptable';
 import { ColumnInternalApi } from '../Internal/ColumnInternalApi';
+import { ColDef, ColGroupDef } from '@ag-grid-community/core';
 export declare function isAutoRowGroupColumn(columnId: string): boolean;
 export declare function isAutoPivotColumn(columnId: string): boolean;
 export declare class ColumnApiImpl extends ApiBase implements ColumnApi {
@@ -68,4 +69,7 @@ export declare class ColumnApiImpl extends ApiBase implements ColumnApi {
     getColumnTypes(): string[];
     getColumnsByColumnType(columnType: string): AdaptableColumn[];
     getRowGroupedColumns(): AdaptableColumn[];
+    updateColumnConfiguration(columnConfig: ColumnConfig): void;
+    updateColumnConfigurations(columnConfigs: ColumnConfig[]): void;
+    setColumnDefinitions(columnDefinitions: (ColDef | ColGroupDef)[]): void;
 }

package/src/Api/Implementation/ColumnApiImpl.js

@@ -1,9 +1,9 @@
 import { ApiBase } from './ApiBase';
 import * as GeneralConstants from '../../Utilities/Constants/GeneralConstants';
 import * as ModuleConstants from '../../Utilities/Constants/ModuleConstants';
-import ArrayExtensions from '../../Utilities/Extensions/ArrayExtensions';
 import { ColumnInternalApi } from '../Internal/ColumnInternalApi';
 import { createBaseContext } from '../../Utilities/ObjectFactory';
+import ArrayExtensions from '../../Utilities/Extensions/ArrayExtensions';
 export function isAutoRowGroupColumn(columnId) {
     // put this here as there might be other indicators we are not aware of
     // perhaps with non auto groups ?
@@ -363,4 +363,34 @@ export class ColumnApiImpl extends ApiBase {
             return this.getColumnWithColumnId(n);
         });
     }
+    updateColumnConfiguration(columnConfig) {
+        const columnExists = this.doesColumnExist(columnConfig.colId);
+        if (!columnExists) {
+            this.logWarn(`Column with id ${columnConfig.colId} does not exist, could NOT update configuration`);
+            return;
+        }
+        const columnState = columnConfig;
+        const agGridApi = this.adaptable.agGridAdapter.getAgGridApi();
+        agGridApi.applyColumnState({
+            state: [columnState],
+        });
+    }
+    updateColumnConfigurations(columnConfigs) {
+        const existingColumnConfigs = columnConfigs.filter((cc) => this.doesColumnExist(cc.colId));
+        const notExistingColumnIds = columnConfigs
+            .filter((cc) => !this.doesColumnExist(cc.colId))
+            .map((cc) => cc.colId);
+        notExistingColumnIds.forEach((colId) => {
+            this.logWarn(`Column with id ${colId} does not exist, could NOT update configuration`);
+        });
+        const columnStates = existingColumnConfigs;
+        const agGridApi = this.adaptable.agGridAdapter.getAgGridApi();
+        agGridApi.applyColumnState({
+            state: columnStates,
+        });
+    }
+    setColumnDefinitions(columnDefinitions) {
+        const agGridApi = this.adaptable.agGridAdapter.getAgGridApi();
+        agGridApi.setGridOption('columnDefs', columnDefinitions);
+    }
 }

package/src/agGrid/AdaptableAgGrid.d.ts

@@ -156,7 +156,7 @@ export declare class AdaptableAgGrid implements IAdaptable {
      * Either initializes the AG Grid instance or delegates it to the framework wrappers (React/Anglar)
      */
     private initializeAgGrid;
-    private getAllColumnDefinitions;
+    private getColumnDefinitionsInclSpecialColumns;
     private getSpecialColDefs;
     private enhanceColDefsWithSpecialColumns;
     useRowNodeLookUp(): boolean;
@@ -348,5 +348,6 @@ export declare class AdaptableAgGrid implements IAdaptable {
     private restoreUnGroupColumnOrder;
     private onSortChanged;
     private getColumnSorts;
+    private monkeyPatchingGridOptionsUpdates;
 }
 export {};

package/src/agGrid/AdaptableAgGrid.js

@@ -1,6 +1,6 @@
 import throttle from 'lodash/throttle';
 import debounce from 'lodash/debounce';
-import { createGrid, Events, ModuleNames, RowNode, } from '@ag-grid-community/core';
+import { createGrid, Events, ModuleNames, RowNode, GridOptionsService, } from '@ag-grid-community/core';
 import { AdaptableLogger } from './AdaptableLogger';
 import { PrimaryKeyDocsLink } from '../Utilities/Constants/DocumentationLinkConstants';
 import StringExtensions from '../Utilities/Extensions/StringExtensions';
@@ -99,6 +99,7 @@ import { removeUuidAndSource } from '../Utilities/Helpers/AdaptableHelper';
 import { buildSortedColumnStateForLayout } from './buildSortedColumnStateForLayout';
 const RowNodeProto = RowNode.prototype;
 const RowNode_dispatchLocalEvent = RowNodeProto.dispatchLocalEvent;
+const GridOptionsService_updateGridOptions = GridOptionsService.prototype.updateGridOptions;
 /**
  * AgGrid does not expose 'cellChanged' and 'dataChanged'
  * so we have to override `dispatchLocalEvent`
@@ -339,7 +340,7 @@ export class AdaptableAgGrid {
         this.lifecycleState = 'setupAgGrid';
         const gridOptions = config.gridOptions;
         // Needed here because special column defs are required for deriving the adaptable column state
-        const columnDefs = this.getAllColumnDefinitions(gridOptions.columnDefs || []);
+        const columnDefs = this.getColumnDefinitionsInclSpecialColumns(gridOptions.columnDefs || []);
         gridOptions.columnDefs = columnDefs;
         this.setInitialGridOptions(gridOptions, config.variant);
         gridOptions.initialState = this.mapAdaptableStateToAgGridState(this.adaptableStore.TheStore.getState(), gridOptions.columnDefs);
@@ -347,12 +348,14 @@ export class AdaptableAgGrid {
         this.agGridAdapter.initialGridOptions = gridOptions;
         const perfInitAgGrid = this.logger.beginPerf(`initAgGrid()`);
         const agGridApi = await this.initializeAgGrid(gridOptions, config.modules, config.renderAgGridFrameworkComponent);
-        (_b = this.unmountLoadingScreen) === null || _b === void 0 ? void 0 : _b.call(this);
-        perfInitAgGrid.end();
         if (agGridApi === false) {
             this.logger.consoleError(`Adaptable failed to initialize AG Grid!`);
             return Promise.reject('Adaptable failed to initialize AG Grid!');
         }
+        (_b = this.unmountLoadingScreen) === null || _b === void 0 ? void 0 : _b.call(this);
+        perfInitAgGrid.end();
+        // we need to intercept several AG Grid Api methods and trigger Adaptale state changes
+        this.monkeyPatchingGridOptionsUpdates(agGridApi);
         this.agGridAdapter.setAgGridApi(agGridApi);
         this.logger.info(`Registered AG Grid modules: `, this.agGridAdapter.getRegisteredModuleNames().sort());
         /**
@@ -505,8 +508,8 @@ export class AdaptableAgGrid {
     //   this.checkShouldClearExistingFiltersOrSearches();
     //   this.applyColumnFiltering();
     // }
-    refreshColDefs() {
-        const freshColDefs = this.getAllColumnDefinitions();
+    refreshColDefs(agGridColDefs) {
+        const freshColDefs = this.getColumnDefinitionsInclSpecialColumns(agGridColDefs);
         this.agGridAdapter.setGridOption('columnDefs', freshColDefs);
     }
     showQuickFilter() {
@@ -1037,7 +1040,7 @@ export class AdaptableAgGrid {
         const agGridApi = createGrid(agGridContainer, gridOptions, gridParams);
         return agGridApi;
     }
-    getAllColumnDefinitions(agGridColDefs) {
+    getColumnDefinitionsInclSpecialColumns(agGridColDefs) {
         const allColDefs = this.enhanceColDefsWithSpecialColumns(agGridColDefs !== null && agGridColDefs !== void 0 ? agGridColDefs : this.agGridAdapter.getAgGridApi().getColumnDefs());
         return allColDefs;
     }
@@ -3931,4 +3934,20 @@ export class AdaptableAgGrid {
             };
         });
     }
+    // we need to intercept some of the GridOptions updates and refresh the Adaptable state
+    monkeyPatchingGridOptionsUpdates(agGridApi) {
+        // @ts-ignore
+        const gridOptionsService = agGridApi.gos;
+        const self = this;
+        gridOptionsService.updateGridOptions = function ({ options, force, source = 'api', }) {
+            const passedColumnDefs = options.columnDefs;
+            if (passedColumnDefs) {
+                const colDefsWithSpecialColumns = self.getColumnDefinitionsInclSpecialColumns(passedColumnDefs);
+                options['columnDefs'] = colDefsWithSpecialColumns;
+                self.logger.info(`Added SpecialColumns on GridOptions.columnDefs update (source=${source})`);
+            }
+            // we mutated the options array, so it's OK to use the 'arguments' object
+            GridOptionsService_updateGridOptions.apply(this, arguments);
+        };
+    }
 }

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: 1715934602622 || Date.now(),
-    VERSION: "18.0.10-canary.3" || '--current-version--',
+    PUBLISH_TIMESTAMP: 1715954480588 || Date.now(),
+    VERSION: "18.0.10" || '--current-version--',
 };