@adaptabletools/adaptable 18.1.12-canary.0 → 18.1.13

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adaptabletools/adaptable",
-  "version": "18.1.12-canary.0",
+  "version": "18.1.13",
   "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

@@ -41,7 +41,7 @@ export interface AgGridConfig {
      */
     gridOptions: GridOptions;
     /**
-     * AG Grid Modules
+     * AG Grid Modules to use; provide empty array if using CJS
      */
     modules: Module[];
 }

package/src/AdaptableOptions/AdaptableOptions.d.ts

@@ -94,11 +94,6 @@ export interface AdaptableOptions<TData = any> {
      * Options for managing Action Rows
      */
     actionRowOptions?: ActionRowOptions<TData>;
-    /**
-     * Options for managing AdapTableQL Expressions
-     * @noCodeContainer
-     */
-    expressionOptions?: ExpressionOptions<TData>;
     /**
      * Options for managing Alerts in AdapTable
      *
@@ -125,17 +120,33 @@ export interface AdaptableOptions<TData = any> {
      */
     columnOptions?: ColumnOptions;
     /**
-     * Options for setting the 'Div' elements in which AdapTable, AG Grid, popups are placed
+     * Options for managing Column Filters in AdapTable
+     *
+     * @gridInfoContainer
+     * @noCodeContainer
+     *
      */
-    containerOptions?: ContainerOptions;
+    columnFilterOptions?: ColumnFilterOptions<TData>;
     /**
-     * Options for managing personal Notes
+     * Options for managing AdapTable Column Menu
+     *
+     * @gridInfoContainer
      */
-    noteOptions?: NoteOptions;
+    columnMenuOptions?: ColumnMenuOptions<TData>;
     /**
      * Options for managing collaborative Comments
      */
     commentOptions?: CommentOptions<TData>;
+    /**
+     * Options for setting the 'Div' elements in which AdapTable, AG Grid, popups are placed
+     */
+    containerOptions?: ContainerOptions;
+    /**
+     * Options for managing AdapTable Context Menu
+     *
+     * @gridInfoContainer
+     */
+    contextMenuOptions?: ContextMenuOptions<TData>;
     /**
      * Options for using Custom Sort
      */
@@ -154,6 +165,10 @@ export interface AdaptableOptions<TData = any> {
      * @noCodeContainer
      */
     dataChangeHistoryOptions?: DataChangeHistoryOptions<TData>;
+    /**
+     * Options for managing the Data Import function
+     */
+    dataImportOptions?: DataImportOptions;
     /**
      * Options to manage Data Sets
      */
@@ -176,18 +191,25 @@ export interface AdaptableOptions<TData = any> {
      * @gridInfoContainer
      */
     exportOptions?: ExportOptions;
+    /**
+     * Options for managing AdapTableQL Expressions
+     * @noCodeContainer
+     */
+    expressionOptions?: ExpressionOptions<TData>;
     /**
      * Options for managing FDC3 in AdapTable
      */
     fdc3Options?: Fdc3Options;
     /**
-     * Options for managing Column Filters in AdapTable
+     * Options for managing Flashing Cells - primarily default values
      *
      * @gridInfoContainer
-     * @noCodeContainer
-     *
      */
-    columnFilterOptions?: ColumnFilterOptions<TData>;
+    flashingCellOptions?: FlashingCellOptions;
+    /**
+     * Options for providing Custom Display Formats
+     */
+    formatColumnOptions?: FormatColumnOptions;
     /**
      * Options for managing the Grid Filter in AdapTable
      *
@@ -196,16 +218,6 @@ export interface AdaptableOptions<TData = any> {
      *
      */
     gridFilterOptions?: GridFilterOptions<TData>;
-    /**
-     * Options for managing Flashing Cells - primarily default values
-     *
-     * @gridInfoContainer
-     */
-    flashingCellOptions?: FlashingCellOptions;
-    /**
-     * Options for providing Custom Display Formats
-     */
-    formatColumnOptions?: FormatColumnOptions;
     /**
      * Options related to Row Grouping
      *
@@ -221,17 +233,9 @@ export interface AdaptableOptions<TData = any> {
      */
     layoutOptions?: LayoutOptions;
     /**
-     * Options for managing AdapTable Column Menu
-     *
-     * @gridInfoContainer
-     */
-    columnMenuOptions?: ColumnMenuOptions<TData>;
-    /**
-     * Options for managing AdapTable Context Menu
-     *
-     * @gridInfoContainer
+     * Options for managing personal Notes
      */
-    contextMenuOptions?: ContextMenuOptions<TData>;
+    noteOptions?: NoteOptions;
     /**
      * Options for managing Notifications in AdapTable
      *
@@ -280,10 +284,6 @@ export interface AdaptableOptions<TData = any> {
      * @gridInfoContainer
      */
     userInterfaceOptions?: UserInterfaceOptions<TData>;
-    /**
-     * Options for managing the Data Import function
-     */
-    dataImportOptions?: DataImportOptions;
     /**
      * Used for managing the AdapTable Plugins
      */

package/src/Api/Events/GridDataChanged.d.ts

@@ -1,6 +1,6 @@
 import { IRowNode } from '@ag-grid-community/core';
 import { BaseEventInfo } from './BaseEventInfo';
-export type GridDataChangeTrigger = 'Add' | 'Edit' | 'Delete' | 'Load';
+export type GridDataChangeTrigger = 'Add' | 'Update' | 'Delete' | 'Load';
 /**
  * EventInfo returned by GridDataChanged event
  */ export interface GridDataChangedInfo<TData = any> extends BaseEventInfo {
@@ -13,7 +13,7 @@ export type GridDataChangeTrigger = 'Add' | 'Edit' | 'Delete' | 'Load';
      */
     dataRows: TData[];
     /**
-     * Trigger for row change: Load, Add, Edit, or Delete
+     * Trigger for row change: Load, Add, Update, or Delete
      */
     rowTrigger: GridDataChangeTrigger;
     /**

package/src/Api/Implementation/GridApiImpl.js

@@ -53,13 +53,13 @@ export class GridApiImpl extends ApiBase {
     }
     async updateGridData(dataRows, dataUpdateConfig) {
         const rowNodes = await this.adaptable.updateRows(dataRows, dataUpdateConfig);
-        this.internalApi.fireGridDataChangedEvent(dataRows, rowNodes, 'Edit');
+        this.internalApi.fireGridDataChangedEvent(dataRows, rowNodes, 'Update');
         return rowNodes;
     }
     async addOrUpdateGridData(dataRows, dataUpdateConfig) {
         const { added, updated } = await this.adaptable.addOrUpdateRows(dataRows, dataUpdateConfig);
         if (ArrayExtensions.IsNotNullOrEmpty(updated)) {
-            this.internalApi.fireGridDataChangedEvent(dataRows, updated, 'Edit');
+            this.internalApi.fireGridDataChangedEvent(dataRows, updated, 'Update');
         }
         if (ArrayExtensions.IsNotNullOrEmpty(added)) {
             this.internalApi.fireGridDataChangedEvent(dataRows, added, 'Add');

package/src/Api/Implementation/LayoutApiImpl.js

@@ -38,12 +38,16 @@ export class LayoutApiImpl extends ApiBase {
         return this.getCurrentLayout().RowGroupedColumns;
     }
     setLayout(layoutName) {
-        if (StringExtensions.IsNotNullOrEmpty(layoutName) &&
-            layoutName !== this.getCurrentLayoutName()) {
-            let layout = this.getAdaptableState().Layout.Layouts.find((l) => l.Name == layoutName);
-            if (this.checkItemExists(layout, layoutName, 'Layout')) {
-                this.dispatchAction(LayoutRedux.LayoutSelect(layoutName));
-            }
+        var _a;
+        if (StringExtensions.IsNullOrEmpty(layoutName)) {
+            return;
+        }
+        if (((_a = this.getLayoutOptions()) === null || _a === void 0 ? void 0 : _a.autoSaveLayouts) && layoutName === this.getCurrentLayoutName()) {
+            return;
+        }
+        let layout = this.getLayoutByName(layoutName);
+        if (this.checkItemExists(layout, layoutName, 'Layout')) {
+            this.dispatchAction(LayoutRedux.LayoutSelect(layoutName));
         }
     }
     getCurrentLayout() {

package/src/PredefinedConfig/PredefinedConfig.d.ts

@@ -43,10 +43,6 @@ export interface PredefinedConfig {
      * Supplies a collection of *Custom Sort* objects to allow some columns to be sorted in non-standard (e.g. non alphabetical) ways
      */
     CustomSort?: CustomSortState;
-    /**
-     * Collection of personal Notes that are edited at Cell level
-     */
-    Note?: NoteState;
     /**
      * Large series of properties to give users full control over the look and feel of the *Dashboard* - the section above the grid with toolbars and buttons
      */
@@ -71,14 +67,18 @@ export interface PredefinedConfig {
      * Supplies a collection of *Layout* objects to name and manage groups of column visibility, order and sorts.
      */
     Layout?: LayoutState;
-    /**
-     * Supplies a collection of *PlusMinus* rule objects to stipulate what happens when the user clicks '+' or '-' in a numeric cell
-     */
-    PlusMinus?: PlusMinusState;
     /**
      * Named Queries available for use across multiple AdapTable Modules; and `CurrentQuery` - an Expression to run at start-up
      */
     NamedQuery?: NamedQueryState;
+    /**
+     * Collection of personal Notes that are edited at Cell level
+     */
+    Note?: NoteState;
+    /**
+     * Supplies a collection of *PlusMinus* rule objects to stipulate what happens when the user clicks '+' or '-' in a numeric cell
+     */
+    PlusMinus?: PlusMinusState;
     /**
      * Configues how Quick Search will run i.e. how and whether to highlight matching cells and to filter out non-matching rows
      */

package/src/Strategy/AlertModule.js

@@ -39,7 +39,7 @@ export class AlertModule extends AdaptableModuleBase {
             this.handleCellDataChanged(cellDataChangedInfo);
         });
         this.api.eventApi.on('GridDataChanged', (gridDataChangedInfo) => {
-            if (gridDataChangedInfo.rowTrigger === 'Edit') {
+            if (gridDataChangedInfo.rowTrigger === 'Update') {
                 // changed row alerts should be handled by standard 'AnyChange' Predicate
                 return;
             }

package/src/View/Components/FilterForm/QuickFilterValues.js

@@ -148,6 +148,10 @@ export const QuickFilterValues = (props) => {
                     display: 'flex',
                     flexFlow: 'column',
                     flexWrap: 'nowrap',
+                }, handleClasses: {
+                    right: 'ab-QuickFilter-resize-handle ab-QuickFilter-resize-handle--right',
+                    bottom: 'ab-QuickFilter-resize-handle ab-QuickFilter-resize-handle--bottom',
+                    bottomRight: 'ab-QuickFilter-resize-handle ab-QuickFilter-resize-handle--bottom-right',
                 }, enable: {
                     top: false,
                     right: true,

package/src/agGrid/AdaptableAgGrid.js

@@ -8,7 +8,7 @@ import Emitter from '../Utilities/Emitter';
 import { applyDefaultAdaptableOptions } from './defaultAdaptableOptions';
 import { AgGridAdapter } from './AgGridAdapter';
 import * as GeneralConstants from '../Utilities/Constants/GeneralConstants';
-import { AB_FDC3_COLUMN, AB_SPECIAL_COLUMN, ADAPTABLE_ROW_ACTION_BUTTONS, AUTOGENERATED_PK_COLUMN, DARK_THEME, DEFAULT_LAYOUT, GROUP_PATH_SEPARATOR, HALF_SECOND, LIGHT_THEME, } from '../Utilities/Constants/GeneralConstants';
+import { AB_FDC3_COLUMN, AB_SPECIAL_COLUMN, ADAPTABLE_ROW_ACTION_BUTTONS, AG_GRID_GROUPED_COLUMN, AUTOGENERATED_PK_COLUMN, DARK_THEME, DEFAULT_LAYOUT, GROUP_PATH_SEPARATOR, HALF_SECOND, LIGHT_THEME, } from '../Utilities/Constants/GeneralConstants';
 import { DataService } from '../Utilities/Services/DataService';
 import { AdaptableStore } from '../Redux/Store/AdaptableStore';
 import { AdaptableApiImpl } from '../Api/Implementation/AdaptableApiImpl';
@@ -435,7 +435,7 @@ export class AdaptableAgGrid {
     normaliseLayoutState(state, gridOptions) {
         var _a, _b, _c, _d, _e, _f;
         if (this.shouldCreateDefaultLayout(state, this.adaptableOptions)) {
-            const defaultLayout = this.createDefaultLayout(state, gridOptions.columnDefs);
+            const defaultLayout = this.createDefaultLayout(state, gridOptions.columnDefs, gridOptions.autoGroupColumnDef);
             const layoutState = state.Layout || {};
             const availableLayouts = layoutState.Layouts || [];
             availableLayouts.push(defaultLayout);
@@ -3730,9 +3730,9 @@ export class AdaptableAgGrid {
         }
         return !((_c = layoutState.Layouts) === null || _c === void 0 ? void 0 : _c.length);
     }
-    createDefaultLayout(state, gridOptionsColDefs) {
-        var _a, _b;
-        const allColumnDefs = this.agGridAdapter.getFlattenedColDefs(gridOptionsColDefs);
+    createDefaultLayout(state, agGridColDefs, agGridAutoGroupColDef) {
+        var _a, _b, _c;
+        const allColumnDefs = this.agGridAdapter.getFlattenedColDefs(agGridColDefs);
         const defaultLayout = ObjectFactory.CreateEmptyLayout({
             Name: DEFAULT_LAYOUT,
             Columns: allColumnDefs.map((c) => c.colId),
@@ -3756,12 +3756,23 @@ export class AdaptableAgGrid {
                 return acc;
             }, []),
         });
+        // handle optional 'gridOptions.autoGroupColumnDefs' parameter
+        if (agGridAutoGroupColDef && ((_a = defaultLayout.RowGroupedColumns) === null || _a === void 0 ? void 0 : _a.length)) {
+            defaultLayout.Columns = [AG_GRID_GROUPED_COLUMN, ...defaultLayout.Columns];
+        }
+        if (agGridAutoGroupColDef === null || agGridAutoGroupColDef === void 0 ? void 0 : agGridAutoGroupColDef.pinned) {
+            defaultLayout.PinnedColumnsMap[AG_GRID_GROUPED_COLUMN] =
+                agGridAutoGroupColDef.pinned === true ? 'left' : agGridAutoGroupColDef.pinned;
+        }
+        if (agGridAutoGroupColDef === null || agGridAutoGroupColDef === void 0 ? void 0 : agGridAutoGroupColDef.width) {
+            defaultLayout.ColumnWidthMap[AG_GRID_GROUPED_COLUMN] = agGridAutoGroupColDef.width;
+        }
         // ADD special columns
-        const calculatedColumns = ((_a = state.CalculatedColumn) === null || _a === void 0 ? void 0 : _a.CalculatedColumns) || [];
+        const calculatedColumns = ((_b = state.CalculatedColumn) === null || _b === void 0 ? void 0 : _b.CalculatedColumns) || [];
         if (calculatedColumns.length) {
             defaultLayout.Columns.push(...calculatedColumns.map((c) => c.ColumnId));
         }
-        const freeTextColumns = ((_b = state.FreeTextColumn) === null || _b === void 0 ? void 0 : _b.FreeTextColumns) || [];
+        const freeTextColumns = ((_c = state.FreeTextColumn) === null || _c === void 0 ? void 0 : _c.FreeTextColumns) || [];
         if (freeTextColumns.length) {
             defaultLayout.Columns.push(...freeTextColumns.map((c) => c.ColumnId));
         }
@@ -3778,13 +3789,11 @@ export class AdaptableAgGrid {
         const expandedState = agGridApi.getState().rowGroupExpansion || { expandedRowGroupIds: [] };
         const currentLayoutState = { columnState, expandedState };
         try {
-            // TODO
             const stringifiedLayoutState = JSON.stringify(currentLayoutState);
             if (stringifiedLayoutState === this.previousAgGridLayoutState) {
                 // same grid column state as a previous,
                 // so no need to update, as the layout has already been updated
                 // for this grid column state
-                // console.log('same state as before');
                 return;
             }
             this.previousAgGridLayoutState = stringifiedLayoutState;
@@ -4005,6 +4014,16 @@ export class AdaptableAgGrid {
             const passedColumnDefs = options.columnDefs;
             if (passedColumnDefs) {
                 const colDefsWithSpecialColumns = self.getColumnDefinitionsInclSpecialColumns(passedColumnDefs);
+                const allDisplayedColIds = self.agGridAdapter
+                    .getAgGridApi()
+                    .getAllDisplayedColumns()
+                    .map((col) => col.getColId());
+                // mark as hidden the colDefs of special columns which are not visible
+                self.agGridAdapter.patchColDefs(colDefsWithSpecialColumns, (colDef) => {
+                    if (self.api.columnApi.isSpecialColumn(colDef.colId)) {
+                        colDef.hide = !allDisplayedColIds.includes(colDef.colId);
+                    }
+                });
                 options['columnDefs'] = colDefsWithSpecialColumns;
                 self.logger.info(`Added SpecialColumns on GridOptions.columnDefs update (source=${source})`);
             }

package/src/agGrid/AgGridAdapter.d.ts

@@ -60,6 +60,7 @@ export declare class AgGridAdapter {
      * Mutates the colDefs to ensure that each column has a colId
      */
     assignColumnIdsToColDefs(colDefs?: (ColDef | ColGroupDef)[]): void;
+    patchColDefs(colDefs: (ColDef | ColGroupDef)[], patchFn: (colDef: ColDef) => void): void;
     getDefaultColumnDefinition(): GridOptions['defaultColDef'];
     _agGridApi_getValue(colKey: string | Column, rowNode: IRowNode, gridApi?: GridApi): any;
 }

package/src/agGrid/AgGridAdapter.js

@@ -570,16 +570,25 @@ export class AgGridAdapter {
             if (colDef.field && !colDef.colId) {
                 colDef.colId = colDef.field;
             }
-            if (colDef.children) {
-                colDef.children.forEach((colDef) => assignColId(colDef));
+            if (!colDef.colId) {
+                this.logger.warn('A column is missing the colId - please check ', colDef, 'Either pass a "field" property or a "colId" property.');
             }
-            else {
-                if (!colDef.colId) {
-                    this.logger.warn('A column is missing the colId - please check ', colDef, 'Either pass a "field" property or a "colId" property.');
-                }
+        };
+        this.patchColDefs(colDefs, assignColId);
+    }
+    patchColDefs(colDefs = [], patchFn) {
+        const applyPatch = (colDef) => {
+            if (!colDef) {
+                return;
+            }
+            if (!colDef.children) {
+                patchFn(colDef);
+            }
+            if (colDef.children) {
+                colDef.children.forEach((childColDef) => applyPatch(childColDef));
             }
         };
-        colDefs.forEach((colDef) => assignColId(colDef));
+        colDefs.forEach((colDef) => applyPatch(colDef));
     }
     getDefaultColumnDefinition() {
         var _a, _b;

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: 1721711329974 || Date.now(),
-    VERSION: "18.1.12-canary.0" || '--current-version--',
+    PUBLISH_TIMESTAMP: 1722341695319 || Date.now(),
+    VERSION: "18.1.13" || '--current-version--',
 };