@adaptabletools/adaptable 18.1.15-canary.0 → 19.0.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adaptabletools/adaptable",
-  "version": "18.1.15-canary.0",
+  "version": "19.0.0",
   "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/DataChangeHistoryOptions.d.ts

@@ -26,7 +26,7 @@ export interface DataChangeHistoryOptions<TData = any> {
      */
     changeHistoryButton?: DataChangeHistoryButton<TData> | DataChangeHistoryButton<TData>[];
     /**
-     * Whether to show all changes for each cell or just the last one
+     * Show all changes for each Cell or just the last one
      * @defaultValue true
      */
     showLastDataChangeOnly?: boolean;

package/src/Api/GridApi.d.ts

@@ -33,14 +33,6 @@ export interface GridApi {
      * Retrieves visible data from the grid (filtered and sorted)
      */
     getVisibleData(): any[];
-    /**
-     * @deprecated use `loadGridData()` instead
-     */
-    resetGridData(data: any[]): void;
-    /**
-     * @deprecated use `loadGridData()` instead
-     */
-    setInitialGridData(data: any): void;
     /**
      * Loads data into grid and fire a `GridDataChanged.trigger='Load'` event
      * @param data data to load
@@ -360,12 +352,6 @@ export interface GridApi {
      * Whether AdapTable instance can be Row Grouped
      */
     isGridGroupable(): boolean;
-    /**
-     * Whether AdapTable instance offers row selection
-     *
-     * @deprecated use `isGridRowSelectable()` instead
-     */
-    isGridSelectable(): boolean;
     /**
      * Whether AdapTable instance offers row selection
      */
@@ -536,12 +522,6 @@ export interface GridApi {
      * Returns AG Grid Row Model Type
      */
     getAgGridRowModelType(): RowModelType;
-    /**
-     * Returns number of visible rows in Data Source
-     *
-     * @deprecated use `getRowCount()` instead
-     */
-    getVisibleRowCount(): number;
     /**
      * Opens a window with a transposed view of Grid
      */

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

@@ -21,8 +21,6 @@ export declare class GridApiImpl extends ApiBase implements GridApi {
     getVariant(): AdaptableVariant;
     getGridState(): GridState;
     loadGridData(dataSource: any): void;
-    resetGridData(dataSource: any[]): void;
-    setInitialGridData(data: any): void;
     getGridData(): any[];
     getFilteredData(): any[];
     getVisibleData(): any[];
@@ -94,7 +92,6 @@ export declare class GridApiImpl extends ApiBase implements GridApi {
     expandRowGroupsForValues(columnValues: any[]): void;
     isGridPivotable(): boolean;
     isGridGroupable(): boolean;
-    isGridSelectable(): boolean;
     isGridRowSelectable(): boolean;
     isGridRangeSelectable(): boolean;
     isGridRowGrouped(): boolean;
@@ -136,7 +133,6 @@ export declare class GridApiImpl extends ApiBase implements GridApi {
     getGridContainerElement(): HTMLElement | null;
     openGridInfoSettingsPanel(): void;
     getAgGridRowModelType(): RowModelType;
-    getVisibleRowCount(): number;
     showTransposedView(transposeConfig?: TransposeConfig): void;
     getAllAgGridColumns(): Column<any>[];
 }

package/src/Api/Implementation/GridApiImpl.js

@@ -4,7 +4,6 @@ import { SystemHighlightCellAdd, SystemHighlightCellDelete, SystemHighlightCellD
 import * as ModuleConstants from '../../Utilities/Constants/ModuleConstants';
 import { GridInternalApi } from '../Internal/GridInternalApi';
 import ArrayExtensions from '../../Utilities/Extensions/ArrayExtensions';
-import { logDeprecation } from '../../Utilities/logDeprecation';
 import { WINDOW_SHOW_TRANSPOSED_VIEW } from '../../View/Components/Popups/WindowPopups/windowFactory';
 import { ROW_SUMMARY_ROW_ID } from '../../PredefinedConfig/Common/RowSummary';
 export class GridApiImpl extends ApiBase {
@@ -28,14 +27,6 @@ export class GridApiImpl extends ApiBase {
         const allRowNodes = this.getAllRowNodes();
         this.internalApi.fireGridDataChangedEvent(dataSource, allRowNodes, 'Load');
     }
-    resetGridData(dataSource) {
-        logDeprecation(this.adaptable.logger, 'GridApi', 'resetGridData', 'loadGridData');
-        this.loadGridData(dataSource);
-    }
-    setInitialGridData(data) {
-        logDeprecation(this.adaptable.logger, 'GridApi', 'setInitialGridData', 'loadGridData');
-        this.loadGridData(data);
-    }
     getGridData() {
         return this.adaptable.getGridData();
     }
@@ -359,10 +350,6 @@ export class GridApiImpl extends ApiBase {
     isGridGroupable() {
         return !this.getAdaptableApi().internalApi.isGridInTreeMode();
     }
-    isGridSelectable() {
-        logDeprecation(this.adaptable.logger, 'GridApi', 'isGridSelectable', 'isGridRowSelectable');
-        return this.isGridRowSelectable();
-    }
     isGridRowSelectable() {
         return this.adaptable.isGridRowSelectable();
     }
@@ -544,10 +531,6 @@ export class GridApiImpl extends ApiBase {
     getAgGridRowModelType() {
         return this.adaptable.getAgGridRowModelType();
     }
-    getVisibleRowCount() {
-        logDeprecation(this.adaptable.logger, 'GridApi', 'getVisibleRowCount', 'getRowCount');
-        return this.getRowCount();
-    }
     showTransposedView(transposeConfig = {}) {
         var _a, _b, _c, _d, _e;
         const transposedColumnId = (_a = transposeConfig.transposedColumnId) !== null && _a !== void 0 ? _a : this.getAdaptableApi().optionsApi.getPrimaryKey();

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

@@ -6,6 +6,7 @@ import { ColumnSort } from '../../PredefinedConfig/Common/ColumnSort';
 import { ModuleParams } from '../../View/Components/SharedProps/ModuleViewPopupProps';
 import { IAdaptable } from '../../AdaptableInterfaces/IAdaptable';
 import { LayoutInternalApi } from '../Internal/LayoutInternalApi';
+import { ExtendedLayoutInfo } from '../../PredefinedConfig/Common/ExtendedLayoutInfo';
 export declare class LayoutApiImpl extends ApiBase implements LayoutApi {
     internalApi: LayoutInternalApi;
     constructor(adaptable: IAdaptable);
@@ -22,6 +23,7 @@ export declare class LayoutApiImpl extends ApiBase implements LayoutApi {
     getCurrentLayoutColumnSort(columnId: string): ColumnSort['SortOrder'] | null;
     getCurrentLayoutName(): string;
     getLayoutByName(layoutName: string): Layout | null;
+    getExtendedLayoutByName(layoutName: string): ExtendedLayoutInfo | undefined;
     getLayouts(): Layout[];
     getLayoutById(id: Layout['Uuid']): Layout;
     saveCurrentLayout(): void;

package/src/Api/Implementation/LayoutApiImpl.js

@@ -74,6 +74,67 @@ export class LayoutApiImpl extends ApiBase {
             }
         }
     }
+    getExtendedLayoutByName(layoutName) {
+        const layout = this.getLayoutByName(layoutName);
+        if (!layout) {
+            return undefined;
+        }
+        const config = {
+            includeLayoutNotAssociatedObjects: true,
+            associatedWithLayout: layoutName,
+        };
+        // cannot see a better way than to go through this module by module...
+        let extensions = [];
+        this.getAlertApi()
+            .getAlertDefinitions(config)
+            .forEach((obj) => {
+            extensions.push({ Module: 'Alert', Object: obj });
+        });
+        this.getCustomSortApi()
+            .getCustomSorts(config)
+            .forEach((obj) => {
+            extensions.push({ Module: 'CustomSort', Object: obj });
+        });
+        this.getFlashingCellApi()
+            .getFlashingCellDefinitions(config)
+            .forEach((obj) => {
+            extensions.push({ Module: 'FlashingCell', Object: obj });
+        });
+        this.getFormatColumnApi()
+            .getFormatColumns(config)
+            .forEach((obj) => {
+            extensions.push({ Module: 'FormatColumn', Object: obj });
+        });
+        this.getPlusMinusApi()
+            .getAllPlusMinus(config)
+            .forEach((obj) => {
+            extensions.push({ Module: 'PlusMinus', Object: obj });
+        });
+        this.getScheduleApi()
+            .getReminderSchedules(config)
+            .forEach((obj) => {
+            extensions.push({ Module: 'Schedule', Object: obj });
+        });
+        this.getScheduleApi()
+            .getReportSchedules(config)
+            .forEach((obj) => {
+            extensions.push({ Module: 'Schedule', Object: obj });
+        });
+        this.getShortcutApi()
+            .getShortcuts(config)
+            .forEach((obj) => {
+            extensions.push({ Module: 'Shortcut', Object: obj });
+        });
+        this.getStyledColumnApi()
+            .getStyledColumns(config)
+            .forEach((obj) => {
+            extensions.push({ Module: 'StyledColumn', Object: obj });
+        });
+        return {
+            Layout: layout,
+            Extensions: extensions,
+        };
+    }
     getLayouts() {
         var _a;
         return (_a = this.getAdaptableState().Layout.Layouts) !== null && _a !== void 0 ? _a : [];

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

@@ -29,8 +29,6 @@ export declare class UserInterfaceApiImpl extends ApiBase implements UserInterfa
     getReadOnlyCellStyle(): AdaptableStyle | undefined;
     getAdaptableObjectTags(): AdaptableObjectTag[] | undefined;
     getCustomIconDefinition(iconName: string): import("../../types").AdaptableIcon | import("../../types").CustomIcon;
-    showLoadingScreen(): void;
-    hideLoadingScreen(): void;
     showProgressIndicator(config: ProgressIndicatorConfig): void;
     hideProgressIndicator(): void;
     openCustomWindowPopup(config: CustomWindowConfig): {

package/src/Api/Implementation/UserInterfaceApiImpl.js

@@ -1,7 +1,6 @@
 import * as PopupRedux from '../../Redux/ActionsReducers/PopupRedux';
 import { SystemProgressIndicatorHide, SystemProgressIndicatorShow, } from '../../Redux/ActionsReducers/SystemRedux';
 import { ArrayExtensions } from '../../Utilities/Extensions/ArrayExtensions';
-import { logDeprecation } from '../../Utilities/logDeprecation';
 import { CUSTOM_WINDOW_FACTORY_ID } from '../../View/Components/Popups/WindowPopups/WindowPopups';
 import { UserInterfaceInternalApi } from '../Internal/UserInterfaceInternalApi';
 import { ApiBase } from './ApiBase';
@@ -168,14 +167,6 @@ export class UserInterfaceApiImpl extends ApiBase {
         }
         return customIcon;
     }
-    showLoadingScreen() {
-        logDeprecation(this.adaptable.logger, 'UserInterfaceApi', 'showLoadingScreen', 'showProgressIndicator');
-        this.showProgressIndicator({ text: 'Loading' });
-    }
-    hideLoadingScreen() {
-        logDeprecation(this.adaptable.logger, 'UserInterfaceApi', 'hideLoadingScreen', 'hideProgressIndicator');
-        this.hideProgressIndicator();
-    }
     showProgressIndicator(config) {
         if (config.delay) {
             this.showProgressIndicatorTimeout = setTimeout(() => {

package/src/Api/LayoutApi.d.ts

@@ -1,4 +1,5 @@
 import { AdaptableColumn, ColumnSort } from '../../types';
+import { ExtendedLayoutInfo } from '../PredefinedConfig/Common/ExtendedLayoutInfo';
 import { LayoutState, Layout } from '../PredefinedConfig/LayoutState';
 /**
  * Provides run-time access to the Layout Module and associated state
@@ -56,6 +57,12 @@ export interface LayoutApi {
      * @returns layout
      */
     getLayoutByName(layoutName: string): Layout | null;
+    /**
+     * Retrieves Layout with the given name
+     * @param layoutName Layout to retrieve
+     * @returns layout
+     */
+    getExtendedLayoutByName(layoutName: string): ExtendedLayoutInfo | undefined;
     /**
      * Retrieves all Layouts in Adaptable State
      * @returns layouts

package/src/Api/UserInterfaceApi.d.ts

@@ -71,16 +71,6 @@ export interface UserInterfaceApi {
      * @param name name of Icon
      */
     getCustomIconDefinition(name: string): AdaptableIcon | undefined;
-    /**
-     * Displays the popup that says getting data and initialising grid
-     * @deprecated use `showProgressIndicator()` instead
-     */
-    showLoadingScreen(): void;
-    /**
-     * Hides the popup that says getting data and initialising grid
-     * @deprecated use `hideProgressIndicator()` instead
-     */
-    hideLoadingScreen(): void;
     /**
      * Displays a progress indicator
      * @param config.progressText - text to display in the progress indicator

package/src/PredefinedConfig/Common/ExtendedLayoutInfo.d.ts

@@ -0,0 +1,12 @@
+import { AdaptableModule, AdaptableObject, Layout } from '../../types';
+/**
+ * Defines an Extended Layout - provides a Layout and all objects that refer to it
+ */
+export interface ExtendedLayoutInfo {
+    Layout: Layout;
+    Extensions: LayoutExtension[];
+}
+export interface LayoutExtension {
+    Module: AdaptableModule;
+    Object: AdaptableObject;
+}

package/src/PredefinedConfig/FormatColumnState.d.ts

@@ -45,10 +45,6 @@ export interface FormatColumn extends SuspendableObject {
      * Which types of Rows should be formatted (data, grouped, summary)
      */
     RowScope?: RowScope;
-    /**
-     * @deprecated FormatColumns now apply to Group Rows by default; use RowScope for more control
-     */
-    IncludeGroupedRows?: never;
 }
 /**
  * The Format Column Rule - can be either a Predicate or a BooleanExpression

package/src/Strategy/DashboardModule.js

@@ -1,6 +1,7 @@
 import { AdaptableModuleBase } from './AdaptableModuleBase';
 import * as ModuleConstants from '../Utilities/Constants/ModuleConstants';
 import * as DashboardRedux from '../Redux/ActionsReducers/DashboardRedux';
+import ArrayExtensions from '../Utilities/Extensions/ArrayExtensions';
 export class DashboardModule extends AdaptableModuleBase {
     constructor(api) {
         super(ModuleConstants.DashboardModuleId, ModuleConstants.DashboardFriendlyName, 'dashboard', 'DashboardPopup', 'The Dashboard - usually placed above the Grid - is designed to provide quick access to commonly required AdapTable functionalty', api);
@@ -26,22 +27,25 @@ export class DashboardModule extends AdaptableModuleBase {
     buildMenuItems() {
         if (this.isModuleAvailable()) {
             let menuItems = [];
+            const dashboardState = this.api.dashboardApi.getDashboardState();
             if (this.isModuleEditable()) {
                 menuItems.push(this.createMenuItemClickFunction('dashboard-configure', 'Configure', 'settings', () => this.api.dashboardApi.openDashboardSettingsPanel()));
             }
-            if (this.api.dashboardApi.getDashboardState().IsCollapsed) {
-                menuItems.push(this.createMenuItemReduxAction('dashboard-expand', 'Expand', 'expand', DashboardRedux.DashboardSetIsCollapsed(false)));
+            if (ArrayExtensions.IsNotNullOrEmpty(dashboardState.Tabs)) {
+                if (dashboardState.IsCollapsed) {
+                    menuItems.push(this.createMenuItemReduxAction('dashboard-expand', 'Expand', 'expand', DashboardRedux.DashboardSetIsCollapsed(false)));
+                }
+                else {
+                    menuItems.push(this.createMenuItemReduxAction('dashboard-collapse', 'Collapse', 'collapse', DashboardRedux.DashboardSetIsCollapsed(true)));
+                }
             }
-            else {
-                menuItems.push(this.createMenuItemReduxAction('dashboard-collapse', 'Collapse', 'collapse', DashboardRedux.DashboardSetIsCollapsed(true)));
-            }
-            if (this.api.dashboardApi.getDashboardState().IsFloating) {
+            if (dashboardState.IsFloating) {
                 menuItems.push(this.createMenuItemReduxAction('dashboard-dock', 'Dock', 'dock', DashboardRedux.DashboardSetIsFloating(false)));
             }
             else if (this.api.optionsApi.getDashboardOptions().canFloat) {
                 menuItems.push(this.createMenuItemReduxAction('dashboard-float', 'Float', 'dock', DashboardRedux.DashboardSetIsFloating(true)));
             }
-            if (this.api.dashboardApi.getDashboardState().IsHidden) {
+            if (dashboardState.IsHidden) {
                 menuItems.push(this.createMenuItemReduxAction('dashboard-show', 'Show', 'visibility-on-bold', DashboardRedux.DashboardSetIsHidden(false)));
             }
             else {

package/src/View/Dashboard/DashboardViewPanel.js

@@ -3,6 +3,7 @@ import * as React from 'react';
 import { CheckBox } from '../../components/CheckBox';
 import { connect } from 'react-redux';
 import { Flex } from 'rebass';
+import ArrayExtensions from '../../Utilities/Extensions/ArrayExtensions';
 class DashboardViewPanelComponent extends React.Component {
     constructor(props) {
         super(props);
@@ -11,7 +12,7 @@ class DashboardViewPanelComponent extends React.Component {
         const elementType = this.props.viewType === 'Toolbar' ? 'DashboardToolbar' : 'ToolPanel';
         return (React.createElement(Flex, { flexDirection: "row", className: `ab-${elementType}__Dashboard__wrap`, flexWrap: this.props.viewType === 'ToolPanel' ? 'wrap' : 'nowrap' },
             ' ',
-            React.createElement(CheckBox, { className: `ab-${elementType}__Dashboard__collapsed-check`, marginTop: 0, fontSize: 2, padding: 1, checked: this.props.IsCollapsed, onChange: (checked) => this.props.onSetDashboardCollapsed(checked) }, "Collapse"),
+            ArrayExtensions.IsNotNullOrEmpty(this.props.api.dashboardApi.getDashboardState().Tabs) && (React.createElement(CheckBox, { className: `ab-${elementType}__Dashboard__collapsed-check`, marginTop: 0, fontSize: 2, padding: 1, checked: this.props.IsCollapsed, onChange: (checked) => this.props.onSetDashboardCollapsed(checked) }, "Collapse")),
             '',
             this.props.api.optionsApi.getDashboardOptions().canFloat && (React.createElement(CheckBox, { className: `ab-${elementType}__Dashboard__collapsed-check`, marginTop: 0, fontSize: 2, padding: 1, checked: this.props.IsFloating, onChange: (checked) => this.props.onSetDashboardFloating(checked) }, "Float")),
             ' ',

package/src/agGrid/AdaptableAgGrid.d.ts

@@ -42,6 +42,7 @@ interface AdaptableInitInternalConfig<TData = any> {
 export declare class AdaptableAgGrid implements IAdaptable {
     logger: AdaptableLogger;
     private _id;
+    private _agGridId;
     lifecycleState: AdaptableLifecycleState;
     variant: AdaptableVariant;
     private emitter;

package/src/agGrid/AdaptableAgGrid.js

@@ -99,10 +99,15 @@ const GridOptionsService_updateGridOptions = GridOptionsService.prototype.update
 const EventService_Prototype = EventService.prototype;
 const EventService_wireBeans = EventService_Prototype.wireBeans;
 // AG GRID obfuscates its internals, this is (currently) the best way to get hold of its internal services
-let DANGER_AG_GRID_BEANS;
+const DANGER_AG_GRID_BEANS_MAP = {};
 EventService_Prototype.wireBeans = function (beans) {
+    var _a;
     EventService_wireBeans.apply(this, arguments);
-    DANGER_AG_GRID_BEANS = beans;
+    const gridId = (_a = beans === null || beans === void 0 ? void 0 : beans.context) === null || _a === void 0 ? void 0 : _a.getGridId();
+    if (!gridId) {
+        console.error('CRITICAL: No gridId found in beans, this should never happen!');
+    }
+    DANGER_AG_GRID_BEANS_MAP[gridId] = beans;
 };
 LocalEventService_Prototype.dispatchEvent = function (event) {
     LocalEventService_dispatchEvent.apply(this, arguments);
@@ -579,7 +584,9 @@ export class AdaptableAgGrid {
          * `gridId`
          */
         this.agGridOptionsService.setGridOptionsProperty(gridOptions, 'gridId', (original_gridId) => {
-            return original_gridId || this.adaptableOptions.adaptableId;
+            const agGridId = original_gridId || this.adaptableOptions.adaptableId;
+            this._agGridId = agGridId;
+            return agGridId;
         });
         /**
          *  `getRowId`
@@ -3025,7 +3032,7 @@ export class AdaptableAgGrid {
                 }
             }
         }
-        DANGER_AG_GRID_BEANS = null;
+        DANGER_AG_GRID_BEANS_MAP[this._agGridId] = null;
         if ((config === null || config === void 0 ? void 0 : config.destroyApi) === true) {
             (_b = this.agGridAdapter.getAgGridApi()) === null || _b === void 0 ? void 0 : _b.destroy();
         }
@@ -4046,6 +4053,10 @@ export class AdaptableAgGrid {
         };
     }
     DANGER_getPrivateAgGridBeans() {
-        return DANGER_AG_GRID_BEANS;
+        const beans = DANGER_AG_GRID_BEANS_MAP[this._agGridId];
+        if (!beans) {
+            this.logger.consoleError('Could not get hold of AgGridBeans! This is a critical error and will prevent Adaptable from working correctly.');
+        }
+        return beans;
     }
 }

package/src/agGrid/AgGridMenuAdapter.js

@@ -376,11 +376,11 @@ export class AgGridMenuAdapter {
             icon: 'export-data',
         }));
         return this.normalizeMenuGroup(this.buildMenuGroupParent('Export', [
-            ...visualDataExportItems,
             ...allDataExportItems,
             ...currentDataExportItems,
             ...selectedCellsExportItems,
             ...selectedRowsExportItems,
+            ...visualDataExportItems,
         ], {
             label: 'Export',
             icon: 'export',
@@ -471,19 +471,19 @@ export class AgGridMenuAdapter {
             ],
         };
         /*
-            const calculatedColumnMenuItem: AdaptableMenuItem = {
-              name: 'calculated-column-group',
-              label: 'Calculated Column',
-              module: 'CalculatedColumn',
-              isVisible: true,
-              icon: {
-                name: 'columns',
-              },
-              subItems: [
-                ...calculatedColumnMenuItems,
-              ],
-            };
-            */
+        const calculatedColumnMenuItem: AdaptableMenuItem = {
+          name: 'calculated-column-group',
+          label: 'Calculated Column',
+          module: 'CalculatedColumn',
+          isVisible: true,
+          icon: {
+            name: 'columns',
+          },
+          subItems: [
+            ...calculatedColumnMenuItems,
+          ],
+        };
+        */
         const columnMenuItem = {
             name: 'column-group',
             label: 'Column',

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: 1724081698262 || Date.now(),
-    VERSION: "18.1.15-canary.0" || '--current-version--',
+    PUBLISH_TIMESTAMP: 1724773387137 || Date.now(),
+    VERSION: "19.0.0" || '--current-version--',
 };

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

@@ -3251,6 +3251,11 @@ export declare const ADAPTABLE_METAMODEL: {
             noCode?: undefined;
         })[];
     };
+    ExtendedLayoutInfo: {
+        name: string;
+        kind: string;
+        desc: string;
+    };
     ExternalChartingContext: {
         name: string;
         kind: string;