@adaptabletools/adaptable 18.0.0-canary.6 → 18.0.0-canary.8

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adaptabletools/adaptable",
-  "version": "18.0.0-canary.6",
+  "version": "18.0.0-canary.8",
   "description": "Powerful data-agnostic HTML5 AG Grid extension which provides advanced, cutting-edge functionality to meet all DataGrid requirements",
   "keywords": [
     "web-components",
@@ -60,7 +60,7 @@
     "tinycolor2": "^1.4.2",
     "tslib": "^2.3.0",
     "uuid": "^3.3.2",
-    "react-toastify": "10.0.1"
+    "react-toastify": "9.1.3"
   },
   "peerDependencies": {
     "@ag-grid-community/core": ">=31.1.0"

package/src/Utilities/Services/LicenseService/index.js

@@ -22,17 +22,19 @@ export var LicenseValidityType;
 const SANDPACK_REGEX = /(https):\/\/\d+\-\d+\-\d+\-(sandpack\.codesandbox\.io)/g;
 const SANDBOX_REGEX = /(https):\/\/\S+(\.csb\.app)/g;
 const DEMO_REGEX = /(https):\/\/\S+(\.adaptabletools\.com)/g;
-const origin = typeof window !== 'undefined' ? window.location.origin : '';
+const getOrigin = () => {
+    return typeof window !== 'undefined' ? window.location.origin : '';
+};
 const isInsideSandpack = () => {
-    const [_fullUrl, protocol, sandpackUrl] = Array.from(SANDPACK_REGEX.exec(origin) || []);
+    const [_fullUrl, protocol, sandpackUrl] = Array.from(SANDPACK_REGEX.exec(getOrigin()) || []);
     return protocol === 'https' && sandpackUrl === 'sandpack.codesandbox.io';
 };
 const isInsideSandbox = () => {
-    const [_fullUrl, protocol, sandboxUrl] = Array.from(SANDBOX_REGEX.exec(origin) || []);
+    const [_fullUrl, protocol, sandboxUrl] = Array.from(SANDBOX_REGEX.exec(getOrigin()) || []);
     return protocol === 'https' && sandboxUrl === '.csb.app';
 };
 const isDemoApp = () => {
-    const [_fullUrl, protocol, demoAppUrl] = Array.from(DEMO_REGEX.exec(origin) || []);
+    const [_fullUrl, protocol, demoAppUrl] = Array.from(DEMO_REGEX.exec(getOrigin()) || []);
     return protocol === 'https' && demoAppUrl === '.adaptabletools.com';
 };
 export class LicenseService {

package/src/View/AdaptableView.js

@@ -31,7 +31,7 @@ class AdaptableView extends React.Component {
             , { 
                 // we NEEEEED!!!! this containerId, otherwise, toastify will have memory leaks when the adaptable
                 // instance is destroyed and re-created many times
-                containerId: adaptableOptions.adaptableId, limit: adaptableOptions.notificationsOptions.maxNotifications, closeButton: false, icon: false, theme: "colored" }),
+                containerId: `Toastify-${adaptableOptions.adaptableId}`, limit: adaptableOptions.notificationsOptions.maxNotifications, closeButton: false, icon: false, theme: "colored" }),
             (watermark === null || watermark === void 0 ? void 0 : watermark.show) && React.createElement(LicenseWatermark, null, watermark === null || watermark === void 0 ? void 0 : watermark.text),
             React.createElement(WindowPopups, null),
             React.createElement(FormPopups, null),

package/src/View/Components/Popups/AdaptableToaster.js

@@ -12,7 +12,7 @@ export const showToast = (props) => {
     });
     const adaptableOptions = props.api.optionsApi.getAdaptableOptions();
     const toastProps = ObjectFactory.CreateToastOptions(adaptableOptions.notificationsOptions, {
-        containerId: adaptableOptions.adaptableId,
+        containerId: `Toastify-${adaptableOptions.adaptableId}`,
         onClose: () => {
             off();
         },

package/src/View/DataChangeHistory/DataChangeHistoryGrid.js

@@ -1,9 +1,10 @@
 import * as React from 'react';
-import { useAdaptable } from '../AdaptableContext';
 import { useEffect, useRef, useState } from 'react';
+import { useAdaptable } from '../AdaptableContext';
 import usePrevious from '../../components/utils/usePrevious';
 import { DataChangeHistoryModuleId } from '../../Utilities/Constants/ModuleConstants';
 import { buildActionColumnButton } from './buildActionColumnButton';
+import { AdaptableAgGrid } from '../../agGrid/AdaptableAgGrid';
 export const DataChangeHistoryGrid = (props) => {
     const { changeHistoryLog, adaptableContainerId, agGridContainerId, onUndoChange, onClearRow } = props;
     const mainAdaptableInstance = useAdaptable();
@@ -20,13 +21,12 @@ export const DataChangeHistoryGrid = (props) => {
             const gridOptions = buildGridOptions(mainAdaptableInstance, changeHistoryLog);
             const adaptableOptions = buildAdaptableOptions(mainAdaptableInstance, gridOptions, adaptableContainerId, agGridContainerId, undoChangeEnabled, onUndoChange, onClearRow);
             const modules = mainAdaptableInstance.getAgGridRegisteredModules();
-            const agGridConfig = {
+            const dataChangeHistoryAdaptableApi = await AdaptableAgGrid._initInternal({
+                variant: 'vanilla',
+                adaptableOptions,
                 gridOptions,
-                modules: modules,
-            };
-            // to avoid direct dependency to Adaptable.ts and thus creating a circular dependency;
-            const adaptableInitFn = Object.getPrototypeOf(mainAdaptableInstance).constructor.init;
-            const dataChangeHistoryAdaptableApi = await adaptableInitFn(adaptableOptions, agGridConfig);
+                modules,
+            });
             setAdaptableApi(dataChangeHistoryAdaptableApi);
         };
         initializeAdaptableGrid();

package/src/View/Layout/TransposedPopup.js

@@ -94,7 +94,7 @@ export const TransposedPopup = (props) => {
             },
             layoutOptions: {
                 createDefaultLayout: false,
-                autoSizeColumnsInLayout: false,
+                autoSizeColumnsInLayout: true,
             },
             predefinedConfig: {
                 Layout: {

package/src/agGrid/ActionColumnRenderer.js

@@ -5,7 +5,7 @@ import { renderWithAdaptableContext } from '../View/renderWithAdaptableContext';
 const ActionButtons = (props) => {
     const { buttons, adaptableApi, context, rerender } = props;
     return (React.createElement(React.Fragment, null, buttons.map((button, index) => {
-        var _a, _b;
+        var _a, _b, _c, _d, _e, _f;
         if (button.hidden && button.hidden(button, context)) {
             return;
         }
@@ -27,7 +27,8 @@ const ActionButtons = (props) => {
             }, 16);
         };
         const disabled = button.disabled && button.disabled(button, context);
-        return (React.createElement(SimpleButton, { key: button.Uuid, "data-name": `action-button-${index + 1}`, variant: (_a = buttonStyle === null || buttonStyle === void 0 ? void 0 : buttonStyle.variant) !== null && _a !== void 0 ? _a : 'text', disabled: disabled, tooltip: buttonTooltip, icon: buttonIcon, tone: (_b = buttonStyle === null || buttonStyle === void 0 ? void 0 : buttonStyle.tone) !== null && _b !== void 0 ? _b : 'none', onClick: handleClick, className: buttonStyle === null || buttonStyle === void 0 ? void 0 : buttonStyle.className, accessLevel: 'Full' }, buttonLabel));
+        const identifier = (_d = (_c = (_a = button.label) !== null && _a !== void 0 ? _a : (_b = button.icon) === null || _b === void 0 ? void 0 : _b.name) !== null && _c !== void 0 ? _c : button.tooltip) !== null && _d !== void 0 ? _d : `${index + 1}`;
+        return (React.createElement(SimpleButton, { key: button.Uuid, "data-name": `action-button-${identifier}`, variant: (_e = buttonStyle === null || buttonStyle === void 0 ? void 0 : buttonStyle.variant) !== null && _e !== void 0 ? _e : 'text', disabled: disabled, tooltip: buttonTooltip, icon: buttonIcon, tone: (_f = buttonStyle === null || buttonStyle === void 0 ? void 0 : buttonStyle.tone) !== null && _f !== void 0 ? _f : 'none', onClick: handleClick, className: buttonStyle === null || buttonStyle === void 0 ? void 0 : buttonStyle.className, accessLevel: 'Full' }, buttonLabel));
     })));
 };
 export const ReactActionColumnRenderer = (props) => {

package/src/agGrid/AdaptableAgGrid.d.ts

@@ -27,7 +27,7 @@ import { AgGridOptionsService } from './AgGridOptionsService';
 import { AgGridColumnAdapter } from './AgGridColumnAdapter';
 import { RowEditService } from '../Utilities/Services/RowEditService';
 export type AdaptableVariant = 'vanilla' | 'react' | 'angular';
-export type AdaptableLifecycleState = 'initial' | 'preprocessOptions' | 'initAdaptableState' | 'setupAgGrid' | 'initAgGrid' | 'ready' | 'ready' | 'preDestroyed';
+export type AdaptableLifecycleState = 'initial' | 'preprocessOptions' | 'initAdaptableState' | 'setupAgGrid' | 'initAgGrid' | 'available' | 'ready' | 'preDestroyed';
 type RenderAgGridFrameworkComponentResult = false | GridApi;
 interface AdaptableInitInternalConfig<TData = any> {
     variant: AdaptableVariant;
@@ -115,6 +115,7 @@ export declare class AdaptableAgGrid implements IAdaptable {
     private static collectInstance;
     private static dismissInstance;
     get isReady(): boolean;
+    get isAvailable(): boolean;
     get isDestroyed(): boolean;
     _emit: (eventName: string, data?: any) => Promise<any>;
     _emitSync: (eventName: string, data?: any) => any;
@@ -125,9 +126,9 @@ export declare class AdaptableAgGrid implements IAdaptable {
      * @private
      */
     static _initInternal(config: AdaptableInitInternalConfig): Promise<AdaptableApi>;
+    private _initAdaptableAgGrid;
     private normaliseLayoutState;
     private normaliseToolPanelState;
-    private _initAdaptableAgGrid;
     applyColumnFiltering(): void;
     applyGridFiltering(): void;
     private refreshColDefs;

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, AUTOGENERATED_PK_COLUMN, BLANK_DISTINCT_COLUMN_VALUE, 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, AUTOGENERATED_PK_COLUMN, BLANK_DISTINCT_COLUMN_VALUE, 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';
@@ -191,6 +191,9 @@ export class AdaptableAgGrid {
     get isReady() {
         return this.lifecycleState === 'ready';
     }
+    get isAvailable() {
+        return this.lifecycleState === 'available' || this.lifecycleState === 'ready';
+    }
     get isDestroyed() {
         return this.lifecycleState === 'preDestroyed';
     }
@@ -242,73 +245,6 @@ export class AdaptableAgGrid {
             return doInit(adaptableInstance);
         }
     }
-    normaliseLayoutState(state, config) {
-        var _a, _b, _c;
-        if (this.shouldCreateDefaultLayout(state, this.adaptableOptions)) {
-            const defaultLayout = this.createDefaultLayout(state, config.gridOptions.columnDefs);
-            const layoutState = state.Layout || {};
-            const availableLayouts = layoutState.Layouts || [];
-            availableLayouts.push(defaultLayout);
-            layoutState.Layouts = availableLayouts;
-            layoutState.CurrentLayout = defaultLayout.Name;
-            state.Layout = layoutState;
-        }
-        else {
-            const layoutState = state.Layout;
-            // ensure CurrentLayout is valid
-            if (!layoutState.CurrentLayout ||
-                !layoutState.Layouts.find((l) => l.Name === layoutState.CurrentLayout)) {
-                layoutState.CurrentLayout = (_b = (_a = layoutState.Layouts) === null || _a === void 0 ? void 0 : _a[0]) === null || _b === void 0 ? void 0 : _b.Name;
-            }
-        }
-        // for the initial state, we need to dynamically add the ActionRowColumn (if necessary)
-        // for subsequent layout changes, the `Adaptable.setLayout()` method handles this
-        // this is a serious code smell, hopefully we will delete `setLayout()` at some point
-        const actionRowColDefs = this.api.actionRowApi.internalApi.getColDefsForActionRowColumns();
-        actionRowColDefs.forEach((actionRowColDef) => {
-            const currentLayout = state.Layout.Layouts.find((l) => l.Name === state.Layout.CurrentLayout);
-            if (currentLayout && !currentLayout.Columns.includes(actionRowColDef.colId)) {
-                currentLayout.Columns.push(actionRowColDef.colId);
-                currentLayout.PinnedColumnsMap = currentLayout.PinnedColumnsMap || {};
-                currentLayout.PinnedColumnsMap[actionRowColDef.colId] = actionRowColDef.pinned;
-            }
-        });
-        /**
-         * Viewport mode does not support a few
-         * features instead of complicating the
-         * logic where layout is applied, it is easier and
-         * less error prone to just remove it.
-         */
-        if (config.gridOptions.rowModelType === 'viewport') {
-            (_c = state.Layout.Layouts) === null || _c === void 0 ? void 0 : _c.forEach((layout) => {
-                if (layout.RowGroupedColumns) {
-                    delete layout.RowGroupedColumns;
-                }
-                if (layout.AggregationColumns) {
-                    delete layout.AggregationColumns;
-                }
-                if (layout.PivotColumns) {
-                    delete layout.PivotColumns;
-                    delete layout.EnablePivot;
-                }
-            });
-        }
-        return state;
-    }
-    normaliseToolPanelState(state) {
-        var _a, _b, _c;
-        if ((_a = state === null || state === void 0 ? void 0 : state.ToolPanel) === null || _a === void 0 ? void 0 : _a.ToolPanels) {
-            return state;
-        }
-        // no predefined config provided, we will display all the panels collapsed (custom & module)
-        const defaultToolPanels = [];
-        (_c = (_b = this.adaptableOptions.toolPanelOptions) === null || _b === void 0 ? void 0 : _b.customToolPanels) === null || _c === void 0 ? void 0 : _c.forEach((customToolPanel) => defaultToolPanels.push({ Name: customToolPanel.name }));
-        ALL_TOOL_PANELS.forEach((moduleToolPanel) => defaultToolPanels.push({ Name: moduleToolPanel }));
-        const toolPanelState = state.ToolPanel || {};
-        toolPanelState.ToolPanels = defaultToolPanels;
-        state.ToolPanel = toolPanelState;
-        return state;
-    }
     async _initAdaptableAgGrid(config) {
         var _a, _b;
         // Phase 1: Preprocess Adaptable Options
@@ -383,6 +319,8 @@ export class AdaptableAgGrid {
         }
         this.forPlugins((plugin) => plugin.afterInitServices(this));
         this.forPlugins((plugin) => plugin.afterInitModules(this, this.adaptableModules));
+        // do this now so it sets module entitlements
+        this.EntitlementService.setModulesEntitlements();
         /**
          * At this point it's mandatory to have the ALL the Adaptable blocks initialized:
          * Store, APIs, Services, Modules
@@ -409,7 +347,10 @@ export class AdaptableAgGrid {
         /**
          * At this point AG Grid is initialized!
          */
-        this.updateColumnModelAndRefreshGrid();
+        this.deriveAdaptableColumnStateFromAgGrid();
+        this.agGridColumnAdapter.setupColumns();
+        // we need this because we need the internal Column state to be ready before doing any extra business logic
+        this.lifecycleState = 'available';
         this.api.themeApi.applyCurrentTheme();
         this.validatePrimaryKey();
         this.embedColumnMenu = this.agGridAdapter.isModulePresent(ModuleNames.MenuModule);
@@ -419,8 +360,8 @@ export class AdaptableAgGrid {
         this.applyColumnFiltering();
         this.addGridEventListeners();
         this.temporaryAdaptableStateUpdates();
-        // do this now so it sets module entitlements
-        this.EntitlementService.setModulesEntitlements();
+        this.redrawBody();
+        this.refreshHeader();
         // create the module menu (for use in the dashboard and the toolpanel)
         // TODO see #create-create-module-menu - make sure it's the same here and there
         this.ModuleService.createModuleMenus();
@@ -441,6 +382,75 @@ export class AdaptableAgGrid {
         perfInitAdaptableAgGrid.end();
         return Promise.resolve(this.api);
     }
+    normaliseLayoutState(state, config) {
+        var _a, _b, _c, _d, _e, _f;
+        if (this.shouldCreateDefaultLayout(state, this.adaptableOptions)) {
+            const defaultLayout = this.createDefaultLayout(state, config.gridOptions.columnDefs);
+            const layoutState = state.Layout || {};
+            const availableLayouts = layoutState.Layouts || [];
+            availableLayouts.push(defaultLayout);
+            layoutState.Layouts = availableLayouts;
+            layoutState.CurrentLayout = defaultLayout.Name;
+            state.Layout = layoutState;
+        }
+        else {
+            const layoutState = state.Layout;
+            // ensure CurrentLayout is valid
+            if (!layoutState.CurrentLayout ||
+                !layoutState.Layouts.find((l) => l.Name === layoutState.CurrentLayout)) {
+                layoutState.CurrentLayout = (_b = (_a = layoutState.Layouts) === null || _a === void 0 ? void 0 : _a[0]) === null || _b === void 0 ? void 0 : _b.Name;
+            }
+        }
+        // for the initial state, we need to dynamically add the ActionRowColumn (if necessary)
+        // for subsequent layout changes, the `Adaptable.setLayout()` method handles this
+        // this is a serious code smell, hopefully we will delete `setLayout()` at some point
+        const hasActionRowButtons = !!((_c = this.adaptableOptions.actionRowOptions) === null || _c === void 0 ? void 0 : _c.actionRowButtons);
+        if (hasActionRowButtons) {
+            const currentLayout = state.Layout.Layouts.find((l) => l.Name === state.Layout.CurrentLayout);
+            if (currentLayout && !currentLayout.Columns.includes(ADAPTABLE_ROW_ACTION_BUTTONS)) {
+                currentLayout.Columns.push(ADAPTABLE_ROW_ACTION_BUTTONS);
+                const columnPosition = (_e = (_d = this.adaptableOptions.actionRowOptions) === null || _d === void 0 ? void 0 : _d.actionRowButtonOptions) === null || _e === void 0 ? void 0 : _e.position;
+                currentLayout.PinnedColumnsMap = currentLayout.PinnedColumnsMap || {};
+                currentLayout.PinnedColumnsMap[ADAPTABLE_ROW_ACTION_BUTTONS] =
+                    columnPosition === 'pinnedRight' ? 'right' : 'left';
+            }
+        }
+        /**
+         * Viewport mode does not support a few
+         * features instead of complicating the
+         * logic where layout is applied, it is easier and
+         * less error prone to just remove it.
+         */
+        if (config.gridOptions.rowModelType === 'viewport') {
+            (_f = state.Layout.Layouts) === null || _f === void 0 ? void 0 : _f.forEach((layout) => {
+                if (layout.RowGroupedColumns) {
+                    delete layout.RowGroupedColumns;
+                }
+                if (layout.AggregationColumns) {
+                    delete layout.AggregationColumns;
+                }
+                if (layout.PivotColumns) {
+                    delete layout.PivotColumns;
+                    delete layout.EnablePivot;
+                }
+            });
+        }
+        return state;
+    }
+    normaliseToolPanelState(state) {
+        var _a, _b, _c;
+        if ((_a = state === null || state === void 0 ? void 0 : state.ToolPanel) === null || _a === void 0 ? void 0 : _a.ToolPanels) {
+            return state;
+        }
+        // no predefined config provided, we will display all the panels collapsed (custom & module)
+        const defaultToolPanels = [];
+        (_c = (_b = this.adaptableOptions.toolPanelOptions) === null || _b === void 0 ? void 0 : _b.customToolPanels) === null || _c === void 0 ? void 0 : _c.forEach((customToolPanel) => defaultToolPanels.push({ Name: customToolPanel.name }));
+        ALL_TOOL_PANELS.forEach((moduleToolPanel) => defaultToolPanels.push({ Name: moduleToolPanel }));
+        const toolPanelState = state.ToolPanel || {};
+        toolPanelState.ToolPanels = defaultToolPanels;
+        state.ToolPanel = toolPanelState;
+        return state;
+    }
     applyColumnFiltering() {
         if (this.api.columnFilterApi.isQuickFilterAvailable()) {
             if (this.api.columnFilterApi.isQuickFilterVisible()) {
@@ -588,7 +598,7 @@ export class AdaptableAgGrid {
          */
         this.agGridOptionsService.setGridOptionsProperty(gridOptions, 'isExternalFilterPresent', (original_isExternalFilterPresent) => {
             return (params) => {
-                if (this.isDestroyed) {
+                if (!this.isAvailable) {
                     return true;
                 }
                 const columnFilters = this.api.columnFilterApi.getActiveColumnFilters();
@@ -605,7 +615,7 @@ export class AdaptableAgGrid {
          */
         this.agGridOptionsService.setGridOptionsProperty(gridOptions, 'doesExternalFilterPass', (original_doesExternalFilterPass) => {
             return (node) => {
-                if (this.isDestroyed) {
+                if (!this.isAvailable) {
                     return true;
                 }
                 // first we assess a Grid Filter (if its running locally)
@@ -916,7 +926,8 @@ export class AdaptableAgGrid {
                 const gridRoot = agGridApi.ctrlsService.gridBodyCtrl.eGridBody;
                 const gridContainer = gridRoot === null || gridRoot === void 0 ? void 0 : gridRoot.closest('[class*="ag-theme"]');
                 if (!gridContainer) {
-                    this.logger.consoleError('No AG Grid container element found in the DOM. Please provide a valid container element in `ContainerOptions.agGridContainer`');
+                    this.logger.consoleError(`No AG Grid container could be derived from the Adaptable framework wrapper.
+            Please contact AdapTable Support and in the meantime provide a valid container element in 'ContainerOptions.agGridContainer'!`);
                 }
                 this.DANGER_USE_GETTER_agGridContainerElement = gridContainer;
             }

package/src/agGrid/AgGridAdapter.d.ts

@@ -7,6 +7,7 @@ import { ColGroupDef } from '@ag-grid-community/core/dist/esm/es6/entities/colDe
 export declare class AgGridAdapter {
     private adaptableInstance;
     private DANGER_USE_GETTER_gridApi;
+    private DANGER_gridApi_from_args;
     initialGridOptions: GridOptions;
     constructor(adaptableInstance: AdaptableAgGrid);
     private get adaptableOptions();
@@ -15,6 +16,12 @@ export declare class AgGridAdapter {
     destroy(): void;
     setAgGridApi(gridApi: GridApi): void;
     getAgGridApi(skipLogging?: boolean): GridApi | undefined;
+    /**
+     * When AG Grid is rendered the first time, the AG GridApi is not yet set in the Adaptable context (as it's set only AFTER the grid is fully initialised)
+     * yet we need it when evaluating custom GridOptions properties on the first render.
+     * to handle this edge case, we try to extract the AG GridApi from the invocation arguments
+     */
+    grabAgGridApiOnTheFly(args: unknown): void;
     getLiveGridOptions(): GridOptions | undefined;
     updateGridOptions(options: ManagedGridOptions): void;
     setGridOption<Key extends ManagedGridOptionKey>(key: Key, value: GridOptions[Key]): void;

package/src/agGrid/AgGridAdapter.js

@@ -1,4 +1,4 @@
-import { ModuleRegistry, } from '@ag-grid-community/core';
+import { GridApi, ModuleRegistry, } from '@ag-grid-community/core';
 import { ADAPTABLE_FDC3_ACTION_COLUMN_FRIENDLY_NAME, ADAPTABLE_ROW_ACTION_BUTTONS, ADAPTABLE_ROW_ACTION_BUTTONS_FRIENDLY_NAME, } from '../Utilities/Constants/GeneralConstants';
 import { createUuid } from '../PredefinedConfig/Uuid';
 import ArrayExtensions from '../Utilities/Extensions/ArrayExtensions';
@@ -26,10 +26,30 @@ export class AgGridAdapter {
         if (this.DANGER_USE_GETTER_gridApi) {
             return this.DANGER_USE_GETTER_gridApi;
         }
+        if (this.DANGER_gridApi_from_args) {
+            return this.DANGER_gridApi_from_args;
+        }
         if (!skipLogging) {
             console.error('AgGridApi is not available yet');
         }
     }
+    /**
+     * When AG Grid is rendered the first time, the AG GridApi is not yet set in the Adaptable context (as it's set only AFTER the grid is fully initialised)
+     * yet we need it when evaluating custom GridOptions properties on the first render.
+     * to handle this edge case, we try to extract the AG GridApi from the invocation arguments
+     */
+    grabAgGridApiOnTheFly(args) {
+        var _a, _b;
+        if (this.DANGER_USE_GETTER_gridApi) {
+            return;
+        }
+        if (Array.isArray(args) &&
+            typeof ((_a = args[0]) === null || _a === void 0 ? void 0 : _a.api) === 'object' &&
+            ((_b = args[0]) === null || _b === void 0 ? void 0 : _b.api) instanceof GridApi) {
+            this.DANGER_gridApi_from_args = args[0].api;
+        }
+    }
+    // TODO AFL check if this is still needed if GridAPI offers the `getOption` method
     // do NOT ever mutate the returned object!!
     getLiveGridOptions() {
         var _a, _b;

package/src/agGrid/AgGridOptionsService.d.ts

@@ -8,4 +8,5 @@ export declare class AgGridOptionsService {
     destroy(): void;
     setGridOptionsProperty<T extends keyof GridOptions>(gridOptions: GridOptions, propertyName: T, propertyGetter: (userPropertyValue: GridOptions[T]) => GridOptions[T] | undefined): GridOptions;
     revertGridOptionsPropertiesToUserValue<T extends keyof GridOptions>(gridOptions: GridOptions, propertyNames: T[]): void;
+    private get agGridAdapter();
 }

package/src/agGrid/AgGridOptionsService.js

@@ -30,6 +30,7 @@ export class AgGridOptionsService {
                 if (this.adaptableInstance.isDestroyed) {
                     return;
                 }
+                this.agGridAdapter.grabAgGridApiOnTheFly(args);
                 return previousValue(...args);
             };
         }
@@ -47,4 +48,7 @@ export class AgGridOptionsService {
             gridOptions[propertyName] = userValue;
         }
     }
+    get agGridAdapter() {
+        return this.adaptableInstance.agGridAdapter;
+    }
 }

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: 1710607821606 || Date.now(),
-    VERSION: "18.0.0-canary.6" || '--current-version--',
+    PUBLISH_TIMESTAMP: 1710788423776 || Date.now(),
+    VERSION: "18.0.0-canary.8" || '--current-version--',
 };

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

@@ -5299,6 +5299,33 @@ export declare const ADAPTABLE_METAMODEL: {
             ref: string;
         }[];
     };
+    UpgradeConfig: {
+        name: string;
+        kind: string;
+        desc: string;
+        props: ({
+            name: string;
+            kind: string;
+            desc: string;
+            isOpt?: undefined;
+            defVal?: undefined;
+            ref?: undefined;
+        } | {
+            name: string;
+            kind: string;
+            desc: string;
+            isOpt: boolean;
+            defVal: string;
+            ref: string;
+        } | {
+            name: string;
+            kind: string;
+            desc: string;
+            isOpt: boolean;
+            defVal: string;
+            ref?: undefined;
+        })[];
+    };
     UserColumnMenuItem: {
         name: string;
         kind: string;

package/src/metamodel/adaptable.metamodel.js

@@ -4409,6 +4409,12 @@ export const ADAPTABLE_METAMODEL = {
                 "desc": "Callback function invoked when a batch successfully updates",
                 "isOpt": true
             },
+            {
+                "name": "flushAsync",
+                "kind": "b",
+                "desc": "Whether to flush async updates.",
+                "isOpt": true
+            },
             {
                 "name": "runAsync",
                 "kind": "b",
@@ -8972,6 +8978,33 @@ export const ADAPTABLE_METAMODEL = {
             }
         ]
     },
+    "UpgradeConfig": {
+        "name": "UpgradeConfig",
+        "kind": "I",
+        "desc": "The upgrade config object",
+        "props": [
+            {
+                "name": "fromVersion",
+                "kind": "n",
+                "desc": "The version to upgrade from"
+            },
+            {
+                "name": "logger",
+                "kind": "R",
+                "desc": "The logger object",
+                "isOpt": true,
+                "defVal": "The console object",
+                "ref": "unknown"
+            },
+            {
+                "name": "toVersion",
+                "kind": "n",
+                "desc": "The version to upgrade to",
+                "isOpt": true,
+                "defVal": "The current version"
+            }
+        ]
+    },
     "UserColumnMenuItem": {
         "name": "UserColumnMenuItem",
         "kind": "I",
@@ -9154,6 +9187,27 @@ export const ADAPTABLE_METAMODEL = {
                 "desc": "Custom column values for Values Column Filter and Grid Filter Builder",
                 "isOpt": true
             },
+            {
+                "name": "loadingScreenDelay",
+                "kind": "n",
+                "desc": "Delay in milliseconds before Loading Screen appears. `showLoadingScreen` must be true for this to take effect",
+                "isOpt": true,
+                "defVal": "200"
+            },
+            {
+                "name": "loadingScreenText",
+                "kind": "s",
+                "desc": "Text to display in Loading Screen.",
+                "isOpt": true,
+                "defVal": "'Retrieving your settings and setting up the grid...'"
+            },
+            {
+                "name": "loadingScreenTitle",
+                "kind": "s",
+                "desc": "Title to display in Loading Screen.",
+                "isOpt": true,
+                "defVal": "'Initialising Grid'"
+            },
             {
                 "name": "objectTags",
                 "kind": "u",