@adaptabletools/adaptable 18.1.12-canary.0 → 18.1.12

package/package.json

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

@@ -3778,13 +3778,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 +4003,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: 1721914534022 || Date.now(),
+    VERSION: "18.1.12" || '--current-version--',
 };