@adaptabletools/adaptable-cjs 18.0.0-canary.22 → 18.0.0-canary.23

package/src/AdaptableOptions/GroupingOptions.d.ts

@@ -1,5 +1,3 @@
-import { AdaptableColumn, BaseContext } from '../../types';
-import { KeyCreatorParams } from '@ag-grid-community/core';
 /**
  * Options for managing Row and Column Groups in AdapTable
  */
@@ -19,16 +17,3 @@ export interface GroupingOptions<TData = any> {
      */
     autoOrderGroupedColumns?: boolean;
 }
-/**
- * Context used when setting a value for Balanced Row Groups
- */
-export interface BalancedGroupsKeyContext<TData = any> extends BaseContext {
-    /**
-     * AdapTable Column being grouped
-     */
-    adaptableColumn: AdaptableColumn<TData>;
-    /**
-     * AG Grid's Key Creator Params
-     */
-    params: KeyCreatorParams<TData>;
-}

package/src/Api/CommentApi.d.ts

@@ -24,34 +24,33 @@ export interface CommentApi {
      */
     deleteComment(comment: AdaptableComment, cellAddress: CellAddress): void;
     /**
-     * Get Comments for a particular cell
-     * @param CellAddress
+     * Create a new Comment Thread
+     *
+     * @param commentThread
      */
-    getComments(cellAddress: CellAddress): AdaptableComment[];
+    addCommentThread(commentThread: CommentThread): void;
     /**
      *  Delete all Comments for a particular cell
      * @param cellAddress
      */
     deleteCommentThread(cellAddress: CellAddress): void;
     /**
-     * Return all Comments for a particular cell
+     * Return the Comment Thread for a particular cell
      * @param cellAddress
      */
     getCommentThread(cellAddress: CellAddress): CommentThread | undefined;
     /**
-     * Return all Comment Threads
+     * Return all Comment Threads in the grid
      */
-    getCommentThreads(): CommentThread[];
+    getGridComments(): CommentThread[];
     /**
-     * Create a new Comment Thread
+     * Sets the Comment Threads in the grid
      *
-     * @param commentThread
+     * @param commentThreads new cell comments
      */
-    addCommentThread(commentThread: CommentThread): void;
+    setGridComments(commentThreads: CommentThread[]): void;
     /**
-     * Load all Comment Threads
-     *
-     * @param commentThreads new cell comments
+     * Clear all Comment Threads in the grid
      */
-    loadCommentThreads(commentThreads: CommentThread[]): void;
+    clearGridComments(): void;
 }

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

@@ -6,13 +6,13 @@ import { IAdaptable } from '../../AdaptableInterfaces/IAdaptable';
 export declare class CommentsApiImpl extends ApiBase implements CommentApi {
     internalApi: CommentsInternalApi;
     constructor(adaptable: IAdaptable);
-    getComments(address: CellAddress): AdaptableComment[];
     getCommentThread(address: CellAddress): CommentThread | undefined;
-    getCommentThreads(): CommentThread[];
+    getGridComments(): CommentThread[];
     editComment(comment: AdaptableComment, address: CellAddress): void;
     deleteComment(comment: AdaptableComment, address: CellAddress): void;
     addComment(commentText: AdaptableComment['Value'], address: CellAddress): void;
     addCommentThread(commentThread: CommentThread): void;
     deleteCommentThread(cellAddress: CellAddress): void;
-    loadCommentThreads(cellComments: CommentThread[]): void;
+    setGridComments(cellComments: CommentThread[]): void;
+    clearGridComments(): void;
 }

package/src/Api/Implementation/CommentsApiImpl.js

@@ -12,13 +12,10 @@ class CommentsApiImpl extends ApiBase_1.ApiBase {
         super(adaptable);
         this.internalApi = new CommentsInternalApi_1.CommentsInternalApi(adaptable);
     }
-    getComments(address) {
-        return CommentRedux.GetCommentsSelector(this.getAdaptableState().Comment, address);
-    }
     getCommentThread(address) {
         return CommentRedux.GetCellCommentSelector(this.getAdaptableState().Comment, address);
     }
-    getCommentThreads() {
+    getGridComments() {
         var _a;
         return (_a = this.getAdaptableState().Comment.CommentThreads) !== null && _a !== void 0 ? _a : [];
     }
@@ -45,8 +42,11 @@ class CommentsApiImpl extends ApiBase_1.ApiBase {
     deleteCommentThread(cellAddress) {
         this.dispatchAction(CommentRedux.CommentsCellDelete({ cellAddress }));
     }
-    loadCommentThreads(cellComments) {
+    setGridComments(cellComments) {
         this.dispatchAction(CommentRedux.CommentsSet({ commentThread: cellComments }));
     }
+    clearGridComments() {
+        this.setGridComments([]);
+    }
 }
 exports.CommentsApiImpl = CommentsApiImpl;

package/src/Redux/ActionsReducers/CommentsRedux.d.ts

@@ -71,9 +71,5 @@ export declare const CommentsDelete: ({ commentUuid, cellAddress, }: {
     commentUuid: AdaptableComment['Uuid'];
     cellAddress: CellAddress;
 }) => AdaptableCommentsDeleteAction;
-export declare const CommentsReady: (commentstate: CommentState) => NoteReadyAction;
-export declare const GetGridCellCommentsSelector: (state: CommentState, address: CellAddress) => CommentThread;
-export declare const GetCommentsSelector: (state: CommentState, address: CellAddress) => AdaptableComment[] | undefined;
-export declare const GetGetCommentsByUuidSelector: (state: CommentState, uuid: string) => AdaptableComment | undefined;
 export declare const GetCellCommentSelector: (state: CommentState, address: CellAddress) => CommentThread | undefined;
 export declare const CommentsReducer: Redux.Reducer<CommentState>;

package/src/Redux/ActionsReducers/CommentsRedux.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.CommentsReducer = exports.GetCellCommentSelector = exports.GetGetCommentsByUuidSelector = exports.GetCommentsSelector = exports.GetGridCellCommentsSelector = exports.CommentsReady = exports.CommentsDelete = exports.CommentsEdit = exports.CommentsCellDelete = exports.CommentsCellAdd = exports.CommentsAdd = exports.CommentsSet = exports.COMMENTS_LOAD = exports.COMMENTS_READY = exports.COMMENTS_DELETE = exports.COMMENTS_EDIT = exports.COMMENTS_CELL_DELETE = exports.COMMENTS_CELL_ADD = exports.COMMENTS_ADD = void 0;
+exports.CommentsReducer = exports.GetCellCommentSelector = exports.CommentsDelete = exports.CommentsEdit = exports.CommentsCellDelete = exports.CommentsCellAdd = exports.CommentsAdd = exports.CommentsSet = exports.COMMENTS_LOAD = exports.COMMENTS_READY = exports.COMMENTS_DELETE = exports.COMMENTS_EDIT = exports.COMMENTS_CELL_DELETE = exports.COMMENTS_CELL_ADD = exports.COMMENTS_ADD = void 0;
 const tslib_1 = require("tslib");
 const GeneralConstants_1 = require("../../Utilities/Constants/GeneralConstants");
 const ObjectFactory_1 = tslib_1.__importDefault(require("../../Utilities/ObjectFactory"));
@@ -63,44 +63,6 @@ const CommentsDelete = ({ commentUuid, cellAddress, }) => ({
     commentUuid,
 });
 exports.CommentsDelete = CommentsDelete;
-const CommentsReady = (commentstate) => ({
-    type: exports.COMMENTS_READY,
-    commentState: commentstate,
-});
-exports.CommentsReady = CommentsReady;
-const GetGridCellCommentsSelector = (state, address) => {
-    var _a;
-    if (!address) {
-        return null;
-    }
-    return ((_a = state === null || state === void 0 ? void 0 : state.CommentThreads) !== null && _a !== void 0 ? _a : []).find((cellComments) => {
-        return CellPopupService_1.CellPopupService.isSameAddress(cellComments, address);
-    });
-};
-exports.GetGridCellCommentsSelector = GetGridCellCommentsSelector;
-const GetCommentsSelector = (state, address) => {
-    var _a, _b;
-    if (!address) {
-        return [];
-    }
-    const comments = (_b = ((_a = state === null || state === void 0 ? void 0 : state.CommentThreads) !== null && _a !== void 0 ? _a : []).find((cellComments) => {
-        return CellPopupService_1.CellPopupService.isSameAddress(cellComments, address);
-    })) === null || _b === void 0 ? void 0 : _b.Comments;
-    return comments;
-};
-exports.GetCommentsSelector = GetCommentsSelector;
-const GetGetCommentsByUuidSelector = (state, uuid) => {
-    var _a;
-    for (const commentThread of (_a = state.CommentThreads) !== null && _a !== void 0 ? _a : []) {
-        for (const comment of commentThread.Comments) {
-            if (comment.Uuid === uuid) {
-                return comment;
-            }
-        }
-    }
-    return undefined;
-};
-exports.GetGetCommentsByUuidSelector = GetGetCommentsByUuidSelector;
 const GetCellCommentSelector = (state, address) => {
     var _a;
     if (!address) {

package/src/Redux/Store/AdaptableStore.js

@@ -913,8 +913,8 @@ const adaptableMiddleware = (adaptable) => (function(middlewareAPI) {
                         adaptable.refreshCells([node], [columnId], true);
                         requestAnimationFrame(() => {
                             var _a, _b;
-                            const commentThreads = adaptable.api.commentApi.getCommentThreads();
-                            adaptable.api.eventApi.emit('CommentChanged', adaptable.api.commentApi.getCommentThreads());
+                            const commentThreads = adaptable.api.commentApi.getGridComments();
+                            adaptable.api.eventApi.emit('CommentChanged', adaptable.api.commentApi.getGridComments());
                             (_b = (_a = adaptable.api.optionsApi
                                 .getCommentOptions()) === null || _a === void 0 ? void 0 : _a.persistCommentThreads) === null || _b === void 0 ? void 0 : _b.call(_a, commentThreads);
                         });
@@ -922,9 +922,9 @@ const adaptableMiddleware = (adaptable) => (function(middlewareAPI) {
                     return returnAction;
                 }
                 case CommentsRedux.COMMENTS_LOAD: {
-                    const previousCommentThreads = adaptable.api.commentApi.getCommentThreads();
+                    const previousCommentThreads = adaptable.api.commentApi.getGridComments();
                     let returnAction = next(action);
-                    const newCommentThreads = (_j = adaptable.api.commentApi.getCommentThreads()) !== null && _j !== void 0 ? _j : [];
+                    const newCommentThreads = (_j = adaptable.api.commentApi.getGridComments()) !== null && _j !== void 0 ? _j : [];
                     requestAnimationFrame(() => {
                         let addedCommentThreads = [];
                         let deletedCommentThreads = [];

package/src/Strategy/CommentModule.d.ts

@@ -3,7 +3,6 @@ import { AdaptableMenuItem, ContextMenuContext } from '../PredefinedConfig/Commo
 import { AdaptableModuleBase } from './AdaptableModuleBase';
 import { IModule } from './Interface/IModule';
 export declare class CommentModule extends AdaptableModuleBase implements IModule {
-    private adaptable;
     constructor(api: AdaptableApi);
     onAdaptableReady(): void;
     isModuleAvailable(): boolean;

package/src/Strategy/CommentModule.js

@@ -26,7 +26,7 @@ class CommentModule extends AdaptableModuleBase_1.AdaptableModuleBase {
         var _a, _b;
         const commentThreads = await ((_b = (_a = this.api.optionsApi
             .getCommentOptions()) === null || _a === void 0 ? void 0 : _a.loadCommentThreads) === null || _b === void 0 ? void 0 : _b.call(_a, (0, ObjectFactory_1.createBaseContext)(this.api)));
-        this.api.commentApi.loadCommentThreads(commentThreads);
+        this.api.commentApi.setGridComments(commentThreads);
     }
     addContextMenuItems(menuContext) {
         var _a, _b;
@@ -42,17 +42,17 @@ class CommentModule extends AdaptableModuleBase_1.AdaptableModuleBase {
         return items;
     }
     getAddRemoveCommentsMenuItems(menuContext) {
+        var _a;
         const items = [];
-        // does not have note
+        if (!this.api.commentApi.internalApi.areCommentsAvailable()) {
+            return items;
+        }
         const cellAddress = {
             PrimaryKeyValue: menuContext.primaryKeyValue,
             ColumnId: menuContext.adaptableColumn.columnId,
         };
-        const comments = this.api.commentApi.getComments(cellAddress);
-        if (!this.api.commentApi.internalApi.areCommentsAvailable()) {
-            return items;
-        }
-        if (comments) {
+        const cellComments = (_a = this.api.commentApi.getCommentThread(cellAddress)) === null || _a === void 0 ? void 0 : _a.Comments;
+        if (cellComments) {
             items.push(this.createMenuItemClickFunction('comment-remove', 'Remove Comment', this.moduleInfo.Glyph, () => {
                 this.api.commentApi.deleteCommentThread(cellAddress);
             }));

package/src/View/Comments/CommentsEditor.js

@@ -66,13 +66,11 @@ const CommentsEditor = (props) => {
                 const isOwnComment = ((_a = comment === null || comment === void 0 ? void 0 : comment.Author) === null || _a === void 0 ? void 0 : _a.UserName)
                     ? ((_b = comment === null || comment === void 0 ? void 0 : comment.Author) === null || _b === void 0 ? void 0 : _b.UserName) === userId
                     : true; // no owner means it's the current user
-                return (React.createElement(rebass_1.Box, { p: 2, key: (_c = comment.Uuid) !== null && _c !== void 0 ? _c : index, style: {
-                        borderBottom: '1px solid var(--ab-color-primarydark)',
-                    } },
+                return (React.createElement(rebass_1.Box, { p: 2, key: (_c = comment.Uuid) !== null && _c !== void 0 ? _c : index, className: "ab-Comment" },
                     React.createElement(rebass_1.Flex, { mb: 2, alignItems: "center" },
                         React.createElement(rebass_1.Box, null,
-                            React.createElement(rebass_1.Box, { fontSize: 3, fontWeight: "bold" }, (_d = comment === null || comment === void 0 ? void 0 : comment.Author) === null || _d === void 0 ? void 0 : _d.UserName),
-                            comment.Timestamp && (React.createElement(rebass_1.Box, { fontSize: 2 }, (0, dateUtils_1.formatDate)(comment.Timestamp, 'MM.DD.YYYY HH:mm')))),
+                            React.createElement(rebass_1.Box, { "data-name": "comment-username", fontSize: 3, fontWeight: "bold" }, (_d = comment === null || comment === void 0 ? void 0 : comment.Author) === null || _d === void 0 ? void 0 : _d.UserName),
+                            comment.Timestamp && (React.createElement(rebass_1.Box, { "data-name": "comment-timestamp", fontSize: 2 }, (0, dateUtils_1.formatDate)(comment.Timestamp, 'MM.DD.YYYY HH:mm')))),
                         React.createElement(rebass_1.Box, { flex: 1 }),
                         React.createElement(SimpleButton_1.default, { variant: "text", icon: "edit", disabled: !isOwnComment || isReadOnlyModule, onClick: () => setActiveEditingComment(comment.Uuid) }),
                         React.createElement(SimpleButton_1.default, { variant: "text", icon: "delete", disabled: !isOwnComment || isReadOnlyModule, onClick: () => {
@@ -87,7 +85,7 @@ const CommentsEditor = (props) => {
                             }
                         }, onChange: (event) => {
                             adaptable.api.commentApi.editComment(Object.assign(Object.assign({}, comment), { Value: event.target.value }), cellAddress);
-                        } })) : (React.createElement(rebass_1.Text, null, comment.Value)))));
+                        } })) : (React.createElement(rebass_1.Text, { "data-name": "comment-text" }, comment.Value)))));
             })),
         React.createElement(AdaptableInput_1.default, { autoFocus: !comments || comments.length === 0, value: newCommentText, disabled: isReadOnlyModule, onChange: (event) => {
                 setNewCommentText(event.target.value);

package/src/View/Components/Popups/AdaptablePopup/useMenuItems.js

@@ -24,7 +24,7 @@ const useMenuItems = () => {
             item.module !== 'CustomSettingsPanel' &&
             !DefaultSettingsPanel_1.STANDALONE_MODULE_POPUPS.includes(item.module) &&
             item.isVisible);
-        return navigationItems
+        let navItems = navigationItems
             .map((moduleName) => {
             var _a, _b;
             if (moduleName === '-') {
@@ -44,6 +44,14 @@ const useMenuItems = () => {
             return customPanelMenuItem || visibleItems.find((item) => item.module === moduleName);
         })
             .filter(Boolean);
+        // remove sequential '-' items
+        navItems = navItems.filter((item, index) => {
+            if (item === '-' && navItems[index - 1] === '-') {
+                return false;
+            }
+            return true;
+        });
+        return navItems;
     }, [allMenuItems]);
 };
 exports.useMenuItems = useMenuItems;

package/src/agGrid/AdaptableAgGrid.d.ts

@@ -58,7 +58,7 @@ export declare class AdaptableAgGrid implements IAdaptable {
      * once layouts are properly handled with the new aggrid methods & events
      * we can remove this hack
      */
-    private previousAgGridColumnState;
+    private previousAgGridLayoutState;
     _rawAdaptableOptions: AdaptableOptions;
     adaptableOptions: AdaptableOptions;
     _isDetailGrid: boolean;
@@ -310,15 +310,6 @@ export declare class AdaptableAgGrid implements IAdaptable {
     getChartRef(chartId: string): ChartRef;
     setLayout(layout?: Layout): void;
     private getActiveAdaptableAggFuncForCol;
-    /**
-     * Setting layout works by modifing the column state.
-     * The column state is based on the current existing columns.
-     * At this point the column groups do not exist, and the widths from layout are not applied.
-     *
-     * After the col sate is applied and the column groups are created we need
-     * to apply the state again to update the widths of the group columns.
-     */
-    private applyGroupColumnWidth;
     private onRowDataChanged;
     private onCellDataChanged;
     private isUndoChange;

package/src/agGrid/AdaptableAgGrid.js

@@ -148,7 +148,7 @@ class AdaptableAgGrid {
          * once layouts are properly handled with the new aggrid methods & events
          * we can remove this hack
          */
-        this.previousAgGridColumnState = '';
+        this.previousAgGridLayoutState = '';
         this.columnMinMaxValuesCache = {};
         this.renderReactRoot = (node, container) => (0, renderReactRoot_1.renderReactRoot)(node, container);
         /**
@@ -2929,7 +2929,7 @@ class AdaptableAgGrid {
         else {
             (_b = this.agGridAdapter.getAgGridApi()) === null || _b === void 0 ? void 0 : _b.destroy();
         }
-        this.previousAgGridColumnState = '';
+        this.previousAgGridLayoutState = '';
         const gridContainerElement = this.getAgGridContainerElement();
         if (gridContainerElement) {
             gridContainerElement.removeEventListener('keydown', this.agGridListenerKeydown);
@@ -3319,14 +3319,13 @@ class AdaptableAgGrid {
             // as otherwise column order is not preserved properly when
             // going from pivoted to unpivoted layout
             if (shouldUpdatePivoted) {
-                this.agGridAdapter.getAgGridApi().setPivotMode(pivoted);
+                this.agGridAdapter.setGridOption('pivotMode', pivoted);
             }
             const perfApplyColumnState = this.logger.beginPerf('applyColumnState (layout.isChanged)');
             this.agGridAdapter.getAgGridApi().applyColumnState({
                 state: newColumnsState,
                 applyOrder: true,
             });
-            this.applyGroupColumnWidth(layout);
             perfApplyColumnState.end();
             this.api.gridApi.setColumnSorts(layout.ColumnSorts);
             this.agGridAdapter.getAgGridApi().setPivotColumns(layout.PivotColumns || []);
@@ -3383,38 +3382,6 @@ class AdaptableAgGrid {
         }
         return null;
     }
-    /**
-     * Setting layout works by modifing the column state.
-     * The column state is based on the current existing columns.
-     * At this point the column groups do not exist, and the widths from layout are not applied.
-     *
-     * After the col sate is applied and the column groups are created we need
-     * to apply the state again to update the widths of the group columns.
-     */
-    applyGroupColumnWidth(layout) {
-        if (!layout.RowGroupedColumns || !layout.RowGroupedColumns.length) {
-            return;
-        }
-        const groupColumnWithDifferentWidths = this.agGridAdapter
-            .getAgGridApi()
-            .getColumnState()
-            .reduce((acc, col) => {
-            var _a;
-            if (this.api.columnApi.isAutoRowGroupColumn(col.colId)) {
-                const widthInLayout = (_a = layout.ColumnWidthMap) === null || _a === void 0 ? void 0 : _a[col.colId];
-                if (widthInLayout && widthInLayout !== col.width) {
-                    acc.push(Object.assign(Object.assign({}, col), { width: widthInLayout }));
-                }
-            }
-            return acc;
-        }, []);
-        if (groupColumnWithDifferentWidths.length === 0) {
-            return;
-        }
-        this.agGridAdapter.getAgGridApi().applyColumnState({
-            state: groupColumnWithDifferentWidths,
-        });
-    }
     onRowDataChanged({ rowNode, oldData, newData, }) {
         if (oldData == null || oldData == undefined) {
             return;
@@ -3711,15 +3678,18 @@ class AdaptableAgGrid {
         var _a, _b;
         const agGridApi = this.agGridAdapter.getAgGridApi();
         const columnState = agGridApi.getColumnState();
+        const expandedState = agGridApi.getState().rowGroupExpansion || { expandedRowGroupIds: [] };
+        const currentLayoutState = { columnState, expandedState };
         try {
-            const stringifiedState = JSON.stringify(columnState);
-            if (stringifiedState === this.previousAgGridColumnState) {
+            // 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
                 return;
             }
-            this.previousAgGridColumnState = stringifiedState;
+            this.previousAgGridLayoutState = stringifiedLayoutState;
         }
         catch (ex) {
             this.logger.consoleError('Error stringifying column state', ex);

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: 1712232556015 || Date.now(),
-    VERSION: "18.0.0-canary.22" || '--current-version--',
+    PUBLISH_TIMESTAMP: 1712304088550 || Date.now(),
+    VERSION: "18.0.0-canary.23" || '--current-version--',
 };

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

@@ -1358,16 +1358,6 @@ export declare const ADAPTABLE_METAMODEL: {
         kind: string;
         desc: string;
     };
-    BalancedGroupsKeyContext: {
-        name: string;
-        kind: string;
-        desc: string;
-        props: {
-            name: string;
-            kind: string;
-            desc: string;
-        }[];
-    };
     BaseContext: {
         name: string;
         kind: string;