@adaptabletools/adaptable-cjs 19.2.1 → 19.2.2-canary.1

package/package.json

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

package/src/AdaptableOptions/ActionRowOptions.d.ts

@@ -1,11 +1,11 @@
 import { IRowNode } from '@ag-grid-community/core';
 import { ActionColumnContext, ActionRowSubmittedInfo, AdaptableButton, AdaptableColumn, BaseContext, FormContext } from '../types';
 /**
- * Options related to Action Rows, Action Row Buttons and Action Row Forms
+ * Options relating to Action Rows, Action Row Buttons and Action Row Forms
  */
 export interface ActionRowOptions<TData = any> {
     /**
-     * Action buttons to display for each row
+     * Action Row Buttons to display
      * @defaultValue undefined
      */
     actionRowButtons?: ((context: ActionRowButtonsContext) => ActionRowButtonType[]) | ActionRowButtonType[];
@@ -15,7 +15,7 @@ export interface ActionRowOptions<TData = any> {
      */
     actionRowButtonOptions?: ActionRowButtonOptions<TData>;
     /**
-     * Options for managing the Form which the Action Row displays
+     * Options for managing the Form which some Action Row buttons opens
      * @defaultValue undefined
      */
     actionRowFormOptions?: ActionRowFormOptions<TData>;
@@ -30,13 +30,13 @@ export interface ActionRowOptions<TData = any> {
      */
     disableInlineEditing?: boolean;
     /**
-     * Function called when auto-handling 'create' or 'clone' Action Row Button; returned row value should be valid pk value
+     * Function called when auto-handling 'create' or 'clone' Action Row Button; returned row value should be a valid pk value
      * @defaultValue undefined
      */
     setPrimaryKeyValue?: (context: SetPrimaryKeyValueContext<TData>) => any;
 }
 /**
- * The context for the SetPrimaryKeyValueContext function
+ * Context for the setPrimaryKeyValue function
  */
 export interface SetPrimaryKeyValueContext<TData = any> extends BaseContext {
     /**
@@ -54,7 +54,7 @@ export interface ActionRowButtonOptions<TData = any> {
      */
     customConfiguration?: (context: ActionRowButtonConfigurationContext) => Partial<AdaptableButton<ActionColumnContext<TData>>> | undefined;
     /**
-     * Action Row Buttons position: 'pinnedLeft' | 'pinnedRight
+     * Action Row Buttons position: 'pinnedLeft' or 'pinnedRight
      * @defaultValue 'pinnedLeft'
      */
     position?: 'pinnedLeft' | 'pinnedRight';

package/src/AdaptableOptions/SettingsPanelOptions.d.ts

@@ -17,6 +17,11 @@ export interface SettingsPanelOptions {
      * @defaultValue `ConfigurationIcon`
      */
     icon?: 'ConfigurationIcon' | 'ApplicationIcon' | AdaptableIcon;
+    /**
+     * Whether to show Icons for each Module in the Setting Panel
+     * @defaultValue true
+     * @gridInfoItem
+     */
     showModuleIcons?: boolean;
     /**
      * Whether a Settings Panel button should always be displayed in `ModuleButtons` area of Dashboard

package/src/Api/Implementation/AdaptableApiImpl.js

@@ -111,7 +111,8 @@ class AdaptableApiImpl {
         this.internalApi = new AdaptableInternalApi_1.AdaptableInternalApi(adaptable);
     }
     get agGridApi() {
-        return this.adaptable.agGridAdapter.getAgGridApi();
+        var _a, _b;
+        return (_b = (_a = this.adaptable) === null || _a === void 0 ? void 0 : _a.agGridAdapter) === null || _b === void 0 ? void 0 : _b.getAgGridApi();
     }
     /**
      * This is only meant to be called by the Adaptable instance.
@@ -122,6 +123,9 @@ class AdaptableApiImpl {
         }
         this.destroyed = true;
         this.eventApi.destroy();
+        this.exportApi.internalApi.destroy();
+        this.internalApi = null;
+        this.adaptable = null;
         this.optionsApi = null;
         this.alertApi = null;
         this.applicationApi = null;
@@ -162,6 +166,18 @@ class AdaptableApiImpl {
         this.toolPanelApi = null;
         this.userInterfaceApi = null;
         this.fdc3Api = null;
+        this.actionColumnApi = null;
+        this.actionRowApi = null;
+        this.calendarApi = null;
+        this.columnFilterApi = null;
+        this.columnMenuApi = null;
+        this.commentApi = null;
+        this.contextMenuApi = null;
+        this.dataImportApi = null;
+        this.entitlementApi = null;
+        this.gridFilterApi = null;
+        this.noteApi = null;
+        this.styledColumnApi = null;
     }
     destroy(config) {
         this.adaptable.destroy(config);

package/src/agGrid/AdaptableAgGrid.d.ts

@@ -125,6 +125,7 @@ export declare class AdaptableAgGrid implements IAdaptable {
      */
     private adaptableStatusPanelKeys;
     _PRIVATE_adaptableJSXElement: JSX.Element;
+    private DANGER_updateGridOptionsMonkeyPatcher;
     constructor();
     static forEachAdaptable(fn: (adaptable: AdaptableAgGrid) => void): void;
     private static collectInstance;

package/src/agGrid/AdaptableAgGrid.js

@@ -3078,6 +3078,7 @@ class AdaptableAgGrid {
             }
         }
         DANGER_AG_GRID_BEANS_MAP[this._agGridId] = null;
+        this.DANGER_updateGridOptionsMonkeyPatcher = null;
         if ((config === null || config === void 0 ? void 0 : config.destroyApi) === true || (config === null || config === void 0 ? void 0 : config.destroyAgGrid) === true) {
             (_b = this.agGridAdapter.getAgGridApi()) === null || _b === void 0 ? void 0 : _b.destroy();
         }
@@ -3107,53 +3108,58 @@ class AdaptableAgGrid {
         this.columnMinMaxValuesCache = null;
         this.lifecycleState = 'preDestroyed';
         AdaptableAgGrid.dismissInstance(this);
+        // !! this has to be before clearing up references to container and/or adaptableOptions
+        if (config === null || config === void 0 ? void 0 : config.unmount) {
+            const abContainerElement = this.getAdaptableContainerElement();
+            if (abContainerElement != null) {
+                (_g = this.unmountReactRoot) === null || _g === void 0 ? void 0 : _g.call(this);
+            }
+            this.unmountReactRoot = null;
+        }
         this.DANGER_USE_GETTER_adaptableContainerElement = null;
         this.DANGER_USE_GETTER_agGridContainerElement = null;
-        (_g = this.adaptableStore) === null || _g === void 0 ? void 0 : _g.destroy();
+        this.debouncedSaveGridLayout = null;
+        this.debouncedSetColumnIntoStore = null;
+        this.debouncedSetSelectedCells = null;
+        this.debouncedSetSelectedRows = null;
+        (_h = this.adaptableStore) === null || _h === void 0 ? void 0 : _h.destroy();
         this.adaptableStore = null;
-        (_h = this.adaptableModules) === null || _h === void 0 ? void 0 : _h.clear();
+        (_j = this.adaptableModules) === null || _j === void 0 ? void 0 : _j.clear();
         this.adaptableModules = null;
         this.adaptableOptions = null;
         this.adaptableStatusPanelKeys = null;
-        (_k = (_j = this.CalculatedColumnExpressionService) === null || _j === void 0 ? void 0 : _j.destroy) === null || _k === void 0 ? void 0 : _k.call(_j);
+        (_l = (_k = this.CalculatedColumnExpressionService) === null || _k === void 0 ? void 0 : _k.destroy) === null || _l === void 0 ? void 0 : _l.call(_k);
         this.CalculatedColumnExpressionService = null;
-        (_m = (_l = this.DataService) === null || _l === void 0 ? void 0 : _l.destroy) === null || _m === void 0 ? void 0 : _m.call(_l);
+        (_o = (_m = this.DataService) === null || _m === void 0 ? void 0 : _m.destroy) === null || _o === void 0 ? void 0 : _o.call(_m);
         this.DataService = null;
-        (_p = (_o = this.Fdc3Service) === null || _o === void 0 ? void 0 : _o.destroy) === null || _p === void 0 ? void 0 : _p.call(_o);
+        (_q = (_p = this.Fdc3Service) === null || _p === void 0 ? void 0 : _p.destroy) === null || _q === void 0 ? void 0 : _q.call(_p);
         this.Fdc3Service = null;
-        (_r = (_q = this.ModuleService) === null || _q === void 0 ? void 0 : _q.destroy) === null || _r === void 0 ? void 0 : _r.call(_q);
+        (_s = (_r = this.ModuleService) === null || _r === void 0 ? void 0 : _r.destroy) === null || _s === void 0 ? void 0 : _s.call(_r);
         this.ModuleService = null;
-        (_t = (_s = this.ValidationService) === null || _s === void 0 ? void 0 : _s.destroy) === null || _t === void 0 ? void 0 : _t.call(_s);
+        (_u = (_t = this.ValidationService) === null || _t === void 0 ? void 0 : _t.destroy) === null || _u === void 0 ? void 0 : _u.call(_t);
         this.ValidationService = null;
-        (_v = (_u = this.QueryLanguageService) === null || _u === void 0 ? void 0 : _u.destroy) === null || _v === void 0 ? void 0 : _v.call(_u);
+        (_w = (_v = this.QueryLanguageService) === null || _v === void 0 ? void 0 : _v.destroy) === null || _w === void 0 ? void 0 : _w.call(_v);
         this.QueryLanguageService = null;
-        (_x = (_w = this.AlertService) === null || _w === void 0 ? void 0 : _w.destroy) === null || _x === void 0 ? void 0 : _x.call(_w);
+        (_y = (_x = this.AlertService) === null || _x === void 0 ? void 0 : _x.destroy) === null || _y === void 0 ? void 0 : _y.call(_x);
         this.AlertService = null;
-        (_z = (_y = this.TeamSharingService) === null || _y === void 0 ? void 0 : _y.destroy) === null || _z === void 0 ? void 0 : _z.call(_y);
+        (_0 = (_z = this.TeamSharingService) === null || _z === void 0 ? void 0 : _z.destroy) === null || _0 === void 0 ? void 0 : _0.call(_z);
         this.TeamSharingService = null;
-        (_1 = (_0 = this.RowEditService) === null || _0 === void 0 ? void 0 : _0.destroy) === null || _1 === void 0 ? void 0 : _1.call(_0);
+        (_2 = (_1 = this.RowEditService) === null || _1 === void 0 ? void 0 : _1.destroy) === null || _2 === void 0 ? void 0 : _2.call(_1);
         this.RowEditService = null;
-        (_3 = (_2 = this.MetamodelService) === null || _2 === void 0 ? void 0 : _2.destroy) === null || _3 === void 0 ? void 0 : _3.call(_2);
+        (_4 = (_3 = this.MetamodelService) === null || _3 === void 0 ? void 0 : _3.destroy) === null || _4 === void 0 ? void 0 : _4.call(_3);
         this.MetamodelService = null;
-        (_5 = (_4 = this.LicenseService) === null || _4 === void 0 ? void 0 : _4.destroy) === null || _5 === void 0 ? void 0 : _5.call(_4);
+        (_6 = (_5 = this.LicenseService) === null || _5 === void 0 ? void 0 : _5.destroy) === null || _6 === void 0 ? void 0 : _6.call(_5);
         this.LicenseService = null;
-        (_7 = (_6 = this.FlashingCellService) === null || _6 === void 0 ? void 0 : _6.destroy) === null || _7 === void 0 ? void 0 : _7.call(_6);
+        (_8 = (_7 = this.FlashingCellService) === null || _7 === void 0 ? void 0 : _7.destroy) === null || _8 === void 0 ? void 0 : _8.call(_7);
         this.FlashingCellService = null;
-        (_9 = (_8 = this.ThemeService) === null || _8 === void 0 ? void 0 : _8.destroy) === null || _9 === void 0 ? void 0 : _9.call(_8);
+        (_10 = (_9 = this.ThemeService) === null || _9 === void 0 ? void 0 : _9.destroy) === null || _10 === void 0 ? void 0 : _10.call(_9);
         this.ThemeService = null;
-        (_11 = (_10 = this.ChartingService) === null || _10 === void 0 ? void 0 : _10.destroy) === null || _11 === void 0 ? void 0 : _11.call(_10);
+        (_12 = (_11 = this.ChartingService) === null || _11 === void 0 ? void 0 : _11.destroy) === null || _12 === void 0 ? void 0 : _12.call(_11);
         this.ChartingService = null;
-        (_13 = (_12 = this.CellPopupService) === null || _12 === void 0 ? void 0 : _12.destroy) === null || _13 === void 0 ? void 0 : _13.call(_12);
+        (_14 = (_13 = this.CellPopupService) === null || _13 === void 0 ? void 0 : _13.destroy) === null || _14 === void 0 ? void 0 : _14.call(_13);
         this.CellPopupService = null;
-        (_14 = this.unmountLoadingScreen) === null || _14 === void 0 ? void 0 : _14.call(this);
+        (_15 = this.unmountLoadingScreen) === null || _15 === void 0 ? void 0 : _15.call(this);
         this.unmountLoadingScreen = null;
-        if (config === null || config === void 0 ? void 0 : config.unmount) {
-            const abContainerElement = this.getAdaptableContainerElement();
-            if (abContainerElement != null) {
-                (_15 = this.unmountReactRoot) === null || _15 === void 0 ? void 0 : _15.call(this);
-            }
-            this.unmountReactRoot = null;
-        }
     }
     canExportToExcel() {
         return this.agGridAdapter.isModulePresent(core_1.ModuleNames.ExcelExportModule);
@@ -4074,6 +4080,7 @@ class AdaptableAgGrid {
             };
         });
     }
+    // #gridOpts_monkey_patch
     // we need to intercept some of the GridOptions updates and refresh the Adaptable state
     monkeyPatchingGridOptionsUpdates(agGridApi) {
         var _a;
@@ -4082,7 +4089,7 @@ class AdaptableAgGrid {
             this.logger.consoleError('Could not get hold of GridOptionsService! This is a critical error and will prevent Adaptable from working correctly.');
         }
         const self = this;
-        gridOptionsService.updateGridOptions = function ({ options, force, source = 'api', }) {
+        this.DANGER_updateGridOptionsMonkeyPatcher = function ({ options, force, source = 'api', }) {
             // `columnDefs`
             const passedColumnDefs = options.columnDefs;
             if (passedColumnDefs) {
@@ -4109,6 +4116,7 @@ class AdaptableAgGrid {
             // we mutated the options array, so it's OK to use the 'arguments' object
             GridOptionsService_updateGridOptions.apply(this, arguments);
         };
+        gridOptionsService.updateGridOptions = this.DANGER_updateGridOptionsMonkeyPatcher;
     }
     DANGER_getPrivateAgGridBeans() {
         const beans = DANGER_AG_GRID_BEANS_MAP[this._agGridId];

package/src/agGrid/AgGridOptionsService.js

@@ -12,6 +12,7 @@ class AgGridOptionsService {
         this.colDefPropertyCache.clear();
         this.gridOptionsPropertyCache = null;
         this.colDefPropertyCache = null;
+        this.adaptableInstance = null;
     }
     setGridOptionsProperty(gridOptions, propertyName, propertyGetter) {
         if (this.adaptableInstance.lifecycleState === 'preDestroyed') {

package/src/env.js

@@ -2,6 +2,6 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.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: 1732629462338 || Date.now(),
-    VERSION: "19.2.1" || '--current-version--',
+    PUBLISH_TIMESTAMP: 1732886841433 || Date.now(),
+    VERSION: "19.2.2-canary.1" || '--current-version--',
 };