@adaptabletools/adaptable 16.0.0-canary.7 → 16.0.0-canary.9

package/src/PredefinedConfig/AdaptableState.d.ts

@@ -3,7 +3,6 @@ import { GridState } from './GridState';
 import { SystemState } from './SystemState';
 import { AlertState } from './AlertState';
 import { CalculatedColumnState } from './CalculatedColumnState';
-import { ConditionalStyleState } from './ConditionalStyleState';
 import { CustomSortState } from './CustomSortState';
 import { DashboardState } from './DashboardState';
 import { ExportState } from './ExportState';
@@ -24,6 +23,7 @@ import { FlashingCellState } from './FlashingCellState';
 import { StatusBarState } from './StatusBarState';
 import { ChartingState } from './ChartingState';
 import { StyledColumnState } from './StyledColumnState';
+import { CommentsState } from './CommentsState';
 /**
  * The main state object of Adaptable
  */
@@ -38,7 +38,6 @@ export interface AdaptablePersistentState {
     Alert: AlertState;
     FlashingCell: FlashingCellState;
     CalculatedColumn: CalculatedColumnState;
-    ConditionalStyle: ConditionalStyleState;
     CustomSort: CustomSortState;
     Dashboard: DashboardState;
     Export: ExportState;
@@ -56,6 +55,7 @@ export interface AdaptablePersistentState {
     Theme: ThemeState;
     ToolPanel: ToolPanelState;
     Charting: ChartingState;
+    Comments: CommentsState;
 }
 /**
  * The state which is available in the internal Redux store but never persisted

package/src/PredefinedConfig/CommentsState.d.ts

@@ -0,0 +1,29 @@
+import { AdaptableObject } from '../types';
+import { ConfigState } from './ConfigState';
+/**
+ * Comment that can be applied to a Cell in AdapTable
+ */
+export interface AdaptableComment extends AdaptableObject {
+    Timestamp: number;
+    Value: string;
+    Author: {
+        UserName: string;
+    };
+    PrimaryKeyValue: any;
+    ColumnId: string;
+    AdaptableId: string;
+}
+export declare type AdaptableComments = AdaptableComment[];
+/**
+ * Predefined Configuration for Styled Column Module
+ */
+export interface CommentsState extends ConfigState {
+    /**
+     * Collection of Special Column Styles
+     */
+    Comments?: AdaptableComments;
+}
+export declare type CommentPosition = {
+    PrimaryKeyValue: string | number;
+    ColumnId: string;
+};

package/src/PredefinedConfig/CommentsState.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -22,11 +22,11 @@ export interface AdaptableObject {
     Tags?: AdaptableObjectTag[];
 }
 /**
- * AdaptableObjectTag Object Tag - currently supporting only plain string values, but open for future extensions, if ever needed.
+ * AdaptableObjectTag Object Tag - currently supporting only plain string values, but open for future extensions, if needed
  */
 export declare type AdaptableObjectTag = string;
 /**
- * Lookup criteria for finding specific AdaptableObjects. All given criteria will be composed with an AND operator.
+ * Lookup criteria for finding specific Adaptable Objects; all given criteria will be composed with an AND operator
  */
 export interface AdaptableObjectLookupCriteria {
     /**

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

@@ -3,9 +3,9 @@ import { BaseEventInfo } from '../../Api/Events/BaseEventInfo';
 import { FDC3Intent_Depr } from '../../types';
 /**
  * General-purpose context type, as defined by [FDC3](https://fdc3.finos.org/docs/1.0/context-intro).
- * A context object is a well-understood datum that is streamable between FDC3 participants. As a result
- * it has a field describing what type it is, and data indicating its identity. Use this as a base
- * to derive your own with any custom properties or metadata.
+ * A context object is a well-understood datum that is streamable between FDC3 participants.
+ * As a result it has a field describing what type it is, and data indicating its identity.
+ * Use this as a base to derive your own with any custom properties or metadata.
  */
 /**
  * General-purpose context type, as defined by FDC3

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

@@ -34,12 +34,12 @@ export declare type AdaptableStateKey = keyof AdaptablePersistentState | 'OpenFi
 /**
  * Modules provided by AdapTable, subject to Entitlements and usually have Predefined Config
  */
-export declare type AdaptableModule = 'Alert' | 'BulkUpdate' | 'CalculatedColumn' | 'CellSummary' | 'Charting' | 'CustomSort' | 'Dashboard' | 'DataChangeHistory' | 'DataSet' | 'Export' | 'Fdc3' | 'Filter' | 'FlashingCell' | 'FormatColumn' | 'FreeTextColumn' | 'Glue42' | 'GridInfo' | 'IPushPull' | 'Layout' | 'OpenFin' | 'PlusMinus' | 'Query' | 'QuickSearch' | 'Schedule' | 'SettingsPanel' | 'Shortcut' | 'SmartEdit' | 'StyledColumn' | 'StateManagement' | 'StatusBar' | 'SystemStatus' | 'TeamSharing' | 'Theme' | 'ToolPanel';
+export declare type AdaptableModule = 'Alert' | 'BulkUpdate' | 'CalculatedColumn' | 'CellSummary' | 'Charting' | 'CustomSort' | 'Dashboard' | 'DataChangeHistory' | 'DataSet' | 'Export' | 'Fdc3' | 'Filter' | 'FlashingCell' | 'FormatColumn' | 'FreeTextColumn' | 'Glue42' | 'GridInfo' | 'IPushPull' | 'Layout' | 'OpenFin' | 'PlusMinus' | 'Query' | 'QuickSearch' | 'Schedule' | 'SettingsPanel' | 'Shortcut' | 'SmartEdit' | 'StyledColumn' | 'StateManagement' | 'StatusBar' | 'SystemStatus' | 'TeamSharing' | 'Theme' | 'ToolPanel' | 'Comments';
 export declare const ALL_MODULES: AdaptableModule[];
 /**
  * Modules which can appear in the Settings Panel
  */
-export declare type AdaptableSettingsPanel = 'Alert' | 'CalculatedColumn' | 'Charting' | 'CustomSort' | 'Dashboard' | 'DataChangeHistory' | 'DataSet' | 'Export' | 'Filter' | 'FlashingCell' | 'FormatColumn' | 'FreeTextColumn' | 'GridInfo' | 'Layout' | 'PlusMinus' | 'Query' | 'QuickSearch' | 'Schedule' | 'Shortcut' | 'StateManagement' | 'StatusBar' | 'StyledColumn' | 'SystemStatus' | 'TeamSharing' | 'Theme' | 'ToolPanel';
+export declare type AdaptableSettingsPanel = 'Alert' | 'CalculatedColumn' | 'Charting' | 'CustomSort' | 'Dashboard' | 'DataChangeHistory' | 'DataSet' | 'Export' | 'Filter' | 'FlashingCell' | 'FormatColumn' | 'FreeTextColumn' | 'GridInfo' | 'Layout' | 'PlusMinus' | 'Query' | 'QuickSearch' | 'Schedule' | 'Shortcut' | 'StateManagement' | 'StatusBar' | 'StyledColumn' | 'SystemStatus' | 'TeamSharing' | 'Theme' | 'ToolPanel' | 'Comments';
 export declare type TypeHint<Base, Literals> = (Base & {
     __subType?: true;
 }) | Literals;

package/src/PredefinedConfig/Common/Types.js

@@ -81,6 +81,7 @@ exports.ALL_MODULES = [
     ModuleConstants.BulkUpdateModuleId,
     ModuleConstants.CalculatedColumnModuleId,
     ModuleConstants.CellSummaryModuleId,
+    ModuleConstants.CommentsModuleId,
     ModuleConstants.ChartingModuleId,
     ModuleConstants.CustomSortModuleId,
     ModuleConstants.DashboardModuleId,

package/src/PredefinedConfig/PredefinedConfig.d.ts

@@ -19,6 +19,7 @@ import { QueryState } from './QueryState';
 import { StatusBarState } from './StatusBarState';
 import { ChartingState } from './ChartingState';
 import { StyledColumnState } from './StyledColumnState';
+import { CommentsState } from './CommentsState';
 /**
  * This is the main Predefined Config interface which developers will populate at design-time
  */
@@ -47,6 +48,7 @@ export interface PredefinedConfig {
      * Supplies a collection of *Custom Sort* objects to allow some columns to be sorted in non-standard (e.g. non alphabetical) ways
      */
     CustomSort?: CustomSortState;
+    Comments?: CommentsState;
     /**
      * Large series of properties to give users full control over the look and feel of the *Dashboard* - the section above the grid with toolbars and buttons
      */

package/src/PredefinedConfig/SystemState.d.ts

@@ -14,6 +14,7 @@ import { AdaptableFlashingCell } from './Common/AdaptableFlashingCell';
 import { TypeUuid } from './Uuid';
 import { SummaryOperation } from './Common/Enums';
 import { ChartModel } from '@ag-grid-community/core';
+import { CommentPosition } from './CommentsState';
 export type { IPushPullReport, IPushPullDomain };
 export type { Glue42Report };
 export type { OpenFinReport };
@@ -97,6 +98,10 @@ export interface SystemState extends InternalState, IPushPullState, Glue42State,
     QuickSearch?: {
         floatingVisible?: boolean;
     };
+    Comments?: {
+        editMode?: boolean;
+        popupPosition?: CommentPosition | null;
+    };
 }
 export interface ProgressIndicator {
     active: boolean;

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

@@ -0,0 +1,31 @@
+import { AdaptableComment, CommentsState } from '../../PredefinedConfig/CommentsState';
+import * as Redux from 'redux';
+/**
+ * @ReduxAction A Comment has been added
+ */
+export declare const COMMENTS_ADD = "COMMENTS_ADD";
+/**
+ * @ReduxAction A Comment has been edited
+ */
+export declare const COMMENTS_EDIT = "COMMENTS_EDIT";
+/**
+ * @ReduxAction A Comment has been deleted
+ */
+export declare const COMMENTS_DELETE = "COMMENTS_DELETE";
+export interface AdaptableCommentAction extends Redux.Action {
+    adaptableComment: AdaptableComment;
+}
+export interface AdaptableCommentAddAction extends AdaptableCommentAction {
+}
+export interface AdaptableCommentEditAction extends AdaptableCommentAction {
+}
+export interface AdaptableCommentDeleteAction extends AdaptableCommentAction {
+}
+export declare const CommentsAdd: (adaptableComment: AdaptableComment) => AdaptableCommentAddAction;
+export declare const CommentsEdit: (adaptableComment: AdaptableComment) => AdaptableCommentEditAction;
+export declare const CommentsDelete: (adaptableComment: AdaptableComment) => AdaptableCommentDeleteAction;
+export declare const GetCommentsSelector: (state: CommentsState, config?: {
+    PrimaryKeyValue: string | number;
+    ColumnId: string;
+}) => import("../../PredefinedConfig/CommentsState").AdaptableComments;
+export declare const CommentsReducer: Redux.Reducer<CommentsState>;

package/src/Redux/ActionsReducers/CommentsRedux.js

@@ -0,0 +1,83 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CommentsReducer = exports.GetCommentsSelector = exports.CommentsDelete = exports.CommentsEdit = exports.CommentsAdd = exports.COMMENTS_DELETE = exports.COMMENTS_EDIT = exports.COMMENTS_ADD = void 0;
+const tslib_1 = require("tslib");
+const AdaptableHelper_1 = tslib_1.__importDefault(require("../../Utilities/Helpers/AdaptableHelper"));
+const GeneralConstants_1 = require("../../Utilities/Constants/GeneralConstants");
+/**
+ * @ReduxAction A Comment has been added
+ */
+exports.COMMENTS_ADD = 'COMMENTS_ADD';
+/**
+ * @ReduxAction A Comment has been edited
+ */
+exports.COMMENTS_EDIT = 'COMMENTS_EDIT';
+/**
+ * @ReduxAction A Comment has been deleted
+ */
+exports.COMMENTS_DELETE = 'COMMENTS_DELETE';
+const CommentsAdd = (adaptableComment) => ({
+    type: exports.COMMENTS_ADD,
+    adaptableComment,
+});
+exports.CommentsAdd = CommentsAdd;
+const CommentsEdit = (adaptableComment) => ({
+    type: exports.COMMENTS_EDIT,
+    adaptableComment,
+});
+exports.CommentsEdit = CommentsEdit;
+const CommentsDelete = (adaptableComment) => ({
+    type: exports.COMMENTS_DELETE,
+    adaptableComment,
+});
+exports.CommentsDelete = CommentsDelete;
+const GetCommentsSelector = (state, config) => {
+    var _a, _b;
+    if (!config) {
+        return (_a = state === null || state === void 0 ? void 0 : state.Comments) !== null && _a !== void 0 ? _a : [];
+    }
+    return ((_b = state === null || state === void 0 ? void 0 : state.Comments) !== null && _b !== void 0 ? _b : []).filter((comment) => {
+        if (comment.PrimaryKeyValue === config.PrimaryKeyValue &&
+            comment.ColumnId === config.ColumnId) {
+            // happy check
+            return true;
+        }
+        // Primary keys retreived from the grid dom are always strings, so we must also consider them strings
+        if ((typeof config.PrimaryKeyValue === 'number' && typeof comment.PrimaryKeyValue === 'string') ||
+            (typeof config.PrimaryKeyValue === 'string' && typeof comment.PrimaryKeyValue === 'number')) {
+            return (comment.PrimaryKeyValue.toString() === config.PrimaryKeyValue.toString() &&
+                comment.ColumnId === config.ColumnId);
+        }
+        return false;
+    });
+};
+exports.GetCommentsSelector = GetCommentsSelector;
+const initialState = {
+    Comments: GeneralConstants_1.EMPTY_ARRAY,
+};
+const CommentsReducer = (state = initialState, action) => {
+    let adaptableComments;
+    switch (action.type) {
+        case exports.COMMENTS_ADD: {
+            const actionAdaptableComment = action
+                .adaptableComment;
+            AdaptableHelper_1.default.addUuidAndSource(actionAdaptableComment);
+            adaptableComments = [].concat(state.Comments);
+            adaptableComments.push(actionAdaptableComment);
+            return Object.assign(Object.assign({}, state), { Comments: adaptableComments });
+        }
+        case exports.COMMENTS_EDIT: {
+            const actionAdaptableComment = action
+                .adaptableComment;
+            return Object.assign(Object.assign({}, state), { Comments: state.Comments.map((abObject) => abObject.Uuid === actionAdaptableComment.Uuid ? actionAdaptableComment : abObject) });
+        }
+        case exports.COMMENTS_DELETE: {
+            const actionAdaptableComment = action
+                .adaptableComment;
+            return Object.assign(Object.assign({}, state), { Comments: state.Comments.filter((abObject) => abObject.Uuid !== actionAdaptableComment.Uuid) });
+        }
+        default:
+            return state;
+    }
+};
+exports.CommentsReducer = CommentsReducer;

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

@@ -14,7 +14,7 @@ import { SummaryOperation } from '../../PredefinedConfig/Common/Enums';
 import { CellDataChangedInfo } from '../../PredefinedConfig/Common/CellDataChangedInfo';
 import { RowsHighlightInfo } from '../../PredefinedConfig/Common/RowsHighlightInfo';
 import { SmartEditOperation } from '../../AdaptableOptions/EditOptions';
-import { DataSet } from '../../types';
+import { CommentPosition, DataSet } from '../../types';
 import { ChartModel } from '@ag-grid-community/core';
 export declare const FLASHING_CELL_ROW_KEY = "__ROW";
 export declare const SYSTEM_ALERT_ADD = "SYSTEM_ALERT_ADD";
@@ -74,6 +74,8 @@ export declare const SYSTEM_SET_PREVIOUS_GROUPED_COLUMN_INDEX = "SYSTEM_SET_PREV
 export declare const SYSTEM_SET_QUICK_SEARCH_FLOATING_VISIBILITY = "SYSTEM_SET_QUICK_SEARCH_FLOATING_VISIBILITY";
 export declare const SYSTEM_VISUAL_EXPORT_BEGIN = "SYSTEM_VISUAL_EXPORT_BEGIN";
 export declare const SYSTEM_VISUAL_EXPORT_END = "SYSTEM_VISUAL_EXPORT_END";
+export declare const SYSTEM_COMMENTS_SHOW = "SYSTEM_COMMENTS_SHOW";
+export declare const SYSTEM_COMMENTS_HIDE = "SYSTEM_COMMENTS_HIDE";
 export interface SystemHighlightCellAddAction extends Redux.Action {
     cellHighlightInfo: CellHighlightInfo;
 }
@@ -253,6 +255,12 @@ export interface SystemVisualExportEndAction extends Redux.Action {
 export interface SystemQuickSearchFloatingVisibilityAction extends Redux.Action {
     visible: boolean;
 }
+export interface SystemCommentsShowAction extends Redux.Action {
+    cellPosition: CommentPosition;
+    editMode?: boolean;
+}
+export interface SystemCommentsHideAction extends Redux.Action {
+}
 export declare const SystemHighlightCellAdd: (cellHighlightInfo: CellHighlightInfo) => SystemHighlightCellAddAction;
 export declare const SystemHighlightCellDelete: (primaryKeyValue: CellHighlightInfo['primaryKeyValue'], columnId: CellHighlightInfo['columnId']) => SystemHighlightCellDeleteAction;
 export declare const SystemHighlightCellDeleteAll: () => SystemHighlightCellDeleteAllAction;
@@ -310,7 +318,11 @@ export declare const SystemDisableDeleteConfirmation: () => SystemDisableDeleteC
 export declare const SystemVisualExportBegin: () => SystemVisualExportBeginAction;
 export declare const SystemVisualExportEnd: () => SystemVisualExportEndAction;
 export declare const SystemQuickSearchFloatingVisibility: (visible: boolean) => SystemQuickSearchFloatingVisibilityAction;
+export declare const SystemCommentsShow: (cellPosition: CommentPosition, editMode?: boolean) => SystemCommentsShowAction;
+export declare const SystemCommentsHide: () => SystemCommentsHideAction;
 export declare const SystemDisableDeleteConfirmationSelector: (state: SystemState) => boolean;
 export declare const SystemPreviousGroupedColumnsSelector: (state: SystemState) => Record<string, Record<string, number>>;
 export declare const SystemQuickSearchFloatingVisibilitySelector: (state: SystemState) => boolean;
+export declare const SystemCommentsSelector: (state: SystemState) => CommentPosition;
+export declare const SystemCommentsEditModeSelector: (state: SystemState) => boolean;
 export declare const SystemReducer: Redux.Reducer<SystemState>;

package/src/Redux/ActionsReducers/SystemRedux.js

@@ -1,8 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SYSTEM_DISABLE_DELETE_CONFIRMATION = exports.SYSTEM_FILTER_FORM_HIDE = exports.SYSTEM_QUICK_FILTER_BAR_HIDE = exports.SYSTEM_QUICK_FILTER_BAR_SHOW = exports.SYSTEM_SETTINGS_PANEL_SET = exports.SYSTEM_DATA_CHANGE_HISTORY_RESUME = exports.SYSTEM_DATA_CHANGE_HISTORY_SUSPEND = exports.SYSTEM_DATA_CHANGE_HISTORY_DISABLE = exports.SYSTEM_DATA_CHANGE_HISTORY_ENABLE = exports.SYSTEM_DATA_CHANGE_HISTORY_CLEAR_ROW = exports.SYSTEM_DATA_CHANGE_HISTORY_UNDO = exports.SYSTEM_DATA_CHANGE_HISTORY_ADD = exports.SYSTEM_LICENSE_DISABLE_PERSISTENCE = exports.SYSTEM_LICENSE_SHOW_WATERMARK = exports.SYSTEM_PROGRESS_INDICATOR_HIDE = exports.SYSTEM_PROGRESS_INDICATOR_SHOW = exports.SYSTEM_CELL_SUMMARY_CHANGE_OPERATION = exports.SYSTEM_CACHED_QUERY_ADD = exports.SYSTEM_SET_LAST_APPLIED_SHORTCUT = exports.SYSTEM_SET_NEW_COLUMN_LIST_ORDER = exports.SYSTEM_HIGHLIGHT_ROW_DELETE_ALL = exports.SYSTEM_HIGHLIGHT_ROWS_DELETE = exports.SYSTEM_HIGHLIGHT_ROW_DELETE = exports.SYSTEM_HIGHLIGHT_ROWS_ADD = exports.SYSTEM_HIGHLIGHT_ROW_ADD = exports.SYSTEM_HIGHLIGHT_CELL_DELETE_ALL = exports.SYSTEM_HIGHLIGHT_CELL_DELETE = exports.SYSTEM_HIGHLIGHT_CELL_ADD = exports.SYSTEM_BULK_UPDATE_CHANGE_VALUE = exports.SYSTEM_BULK_UPDATE_SET_PREVIEW = exports.SYSTEM_BULK_UPDATE_SET_VALID_SELECTION = exports.SYSTEM_BULK_UPDATE_CHECK_CELL_SELECTION = exports.SYSTEM_SMART_EDIT_CHANGE_OPERATION = exports.SYSTEM_SMART_EDIT_CHANGE_VALUE = exports.SYSTEM_SMARTEDIT_SET_PREVIEW = exports.SYSTEM_SMARTEDIT_SET_VALID_SELECTION = exports.SYSTEM_SMARTEDIT_FETCH_PREVIEW = exports.SYSTEM_SMARTEDIT_CHECK_CELL_SELECTION = exports.SYSTEM_STATUS_MESSAGE_INFO_DELETE_ALL = exports.SYSTEM_STATUS_MESSAGE_INFO_DELETE = exports.SYSTEM_STATUS_MESSAGE_INFO_ADD = exports.SYSTEM_FLASHING_CELL_DELETE_ALL = exports.SYSTEM_FLASHING_CELL_DELETE = exports.SYSTEM_FLASHING_CELL_ADD = exports.SYSTEM_ALERT_REMOVE_ROW_HIGHLIGHT = exports.SYSTEM_ALERT_REMOVE_CELL_HIGHLIGHT = exports.SYSTEM_ALERT_DELETE_ALL = exports.SYSTEM_ALERT_DELETE = exports.SYSTEM_ALERT_ADD = exports.FLASHING_CELL_ROW_KEY = void 0;
-exports.SystemDataChangeHistorySuspend = exports.SystemDataChangeHistoryDisable = exports.SystemDataChangeHistoryEnable = exports.SystemDataChangeHistoryClearRow = exports.SystemDataChangeHistoryUndo = exports.SystemDataChangeHistoryAdd = exports.SystemLicenseDisablePersistence = exports.SystemLicenseShowWatermark = exports.SystemProgressIndicatorHide = exports.SystemProgressIndicatorShow = exports.SystemCellSummaryChangeOperation = exports.SystemCachedQueryAdd = exports.SetLastAppliedShortcut = exports.SetNewColumnListOrder = exports.BulkUpdateChangeValue = exports.BulkUpdateSetPreview = exports.BulkUpdateSetValidSelection = exports.BulkUpdateCheckCellSelection = exports.SmartEditSetPreview = exports.SmartEditSetValidSelection = exports.SmartEditCheckCellSelection = exports.SmartEditChangeOperation = exports.SmartEditChangeValue = exports.SystemStatusMessageInfoDeleteAll = exports.SystemStatusMessageInfoDelete = exports.SystemStatusMessageInfoAdd = exports.SystemFlashingCellDeleteAll = exports.SystemFlashingCellDelete = exports.SystemFlashingCellAdd = exports.SystemAlertRemoveRowHighlight = exports.SystemAlertRemoveCellHighlight = exports.SystemAlertDeleteAll = exports.SystemAlertDelete = exports.SystemAlertAdd = exports.SystemHighlightRowDeleteAll = exports.SystemHighlightRowsDelete = exports.SystemHighlightRowDelete = exports.SystemHighlightRowsAdd = exports.SystemHighlightRowAdd = exports.SystemHighlightCellDeleteAll = exports.SystemHighlightCellDelete = exports.SystemHighlightCellAdd = exports.SYSTEM_VISUAL_EXPORT_END = exports.SYSTEM_VISUAL_EXPORT_BEGIN = exports.SYSTEM_SET_QUICK_SEARCH_FLOATING_VISIBILITY = exports.SYSTEM_SET_PREVIOUS_GROUPED_COLUMN_INDEX = exports.SYSTEM_CHARTING_SET_CURRENT_CHART_MODELS = exports.SYSTEM_DATA_SET_SELECT = exports.DASHBOARD_REFRESH = exports.SYSTEM_LAYOUT_SHOW_NOT_ASSOCIATED_OBJECTS = void 0;
-exports.SystemReducer = exports.SystemQuickSearchFloatingVisibilitySelector = exports.SystemPreviousGroupedColumnsSelector = exports.SystemDisableDeleteConfirmationSelector = exports.SystemQuickSearchFloatingVisibility = exports.SystemVisualExportEnd = exports.SystemVisualExportBegin = exports.SystemDisableDeleteConfirmation = exports.SystemSetPreviousGroupedColumnsIndex = exports.SystemChartingCurrentChartModelsSelector = exports.SystemChartingSetCurrentChartModels = exports.SystemDataSetSelect = exports.SystemDashboardRefresh = exports.SystemLayoutShowNotAssociatedObjects = exports.SystemFilterFormHide = exports.SystemQuickFilterBarHide = exports.SystemQuickFilterBarShow = exports.SystemSettingsPanelSet = exports.SystemDataChangeHistoryResume = void 0;
+exports.SystemDataChangeHistoryEnable = exports.SystemDataChangeHistoryClearRow = exports.SystemDataChangeHistoryUndo = exports.SystemDataChangeHistoryAdd = exports.SystemLicenseDisablePersistence = exports.SystemLicenseShowWatermark = exports.SystemProgressIndicatorHide = exports.SystemProgressIndicatorShow = exports.SystemCellSummaryChangeOperation = exports.SystemCachedQueryAdd = exports.SetLastAppliedShortcut = exports.SetNewColumnListOrder = exports.BulkUpdateChangeValue = exports.BulkUpdateSetPreview = exports.BulkUpdateSetValidSelection = exports.BulkUpdateCheckCellSelection = exports.SmartEditSetPreview = exports.SmartEditSetValidSelection = exports.SmartEditCheckCellSelection = exports.SmartEditChangeOperation = exports.SmartEditChangeValue = exports.SystemStatusMessageInfoDeleteAll = exports.SystemStatusMessageInfoDelete = exports.SystemStatusMessageInfoAdd = exports.SystemFlashingCellDeleteAll = exports.SystemFlashingCellDelete = exports.SystemFlashingCellAdd = exports.SystemAlertRemoveRowHighlight = exports.SystemAlertRemoveCellHighlight = exports.SystemAlertDeleteAll = exports.SystemAlertDelete = exports.SystemAlertAdd = exports.SystemHighlightRowDeleteAll = exports.SystemHighlightRowsDelete = exports.SystemHighlightRowDelete = exports.SystemHighlightRowsAdd = exports.SystemHighlightRowAdd = exports.SystemHighlightCellDeleteAll = exports.SystemHighlightCellDelete = exports.SystemHighlightCellAdd = exports.SYSTEM_COMMENTS_HIDE = exports.SYSTEM_COMMENTS_SHOW = exports.SYSTEM_VISUAL_EXPORT_END = exports.SYSTEM_VISUAL_EXPORT_BEGIN = exports.SYSTEM_SET_QUICK_SEARCH_FLOATING_VISIBILITY = exports.SYSTEM_SET_PREVIOUS_GROUPED_COLUMN_INDEX = exports.SYSTEM_CHARTING_SET_CURRENT_CHART_MODELS = exports.SYSTEM_DATA_SET_SELECT = exports.DASHBOARD_REFRESH = exports.SYSTEM_LAYOUT_SHOW_NOT_ASSOCIATED_OBJECTS = void 0;
+exports.SystemReducer = exports.SystemCommentsEditModeSelector = exports.SystemCommentsSelector = exports.SystemQuickSearchFloatingVisibilitySelector = exports.SystemPreviousGroupedColumnsSelector = exports.SystemDisableDeleteConfirmationSelector = exports.SystemCommentsHide = exports.SystemCommentsShow = exports.SystemQuickSearchFloatingVisibility = exports.SystemVisualExportEnd = exports.SystemVisualExportBegin = exports.SystemDisableDeleteConfirmation = exports.SystemSetPreviousGroupedColumnsIndex = exports.SystemChartingCurrentChartModelsSelector = exports.SystemChartingSetCurrentChartModels = exports.SystemDataSetSelect = exports.SystemDashboardRefresh = exports.SystemLayoutShowNotAssociatedObjects = exports.SystemFilterFormHide = exports.SystemQuickFilterBarHide = exports.SystemQuickFilterBarShow = exports.SystemSettingsPanelSet = exports.SystemDataChangeHistoryResume = exports.SystemDataChangeHistorySuspend = exports.SystemDataChangeHistoryDisable = void 0;
 const GeneralConstants_1 = require("../../Utilities/Constants/GeneralConstants");
 const Enums_1 = require("../../PredefinedConfig/Common/Enums");
 const Helper_1 = require("../../Utilities/Helpers/Helper");
@@ -91,6 +91,9 @@ exports.SYSTEM_SET_QUICK_SEARCH_FLOATING_VISIBILITY = 'SYSTEM_SET_QUICK_SEARCH_F
 // Data Export (Report)
 exports.SYSTEM_VISUAL_EXPORT_BEGIN = 'SYSTEM_VISUAL_EXPORT_BEGIN';
 exports.SYSTEM_VISUAL_EXPORT_END = 'SYSTEM_VISUAL_EXPORT_END';
+// Comments
+exports.SYSTEM_COMMENTS_SHOW = 'SYSTEM_COMMENTS_SHOW';
+exports.SYSTEM_COMMENTS_HIDE = 'SYSTEM_COMMENTS_HIDE';
 const SystemHighlightCellAdd = (cellHighlightInfo) => ({
     type: exports.SYSTEM_HIGHLIGHT_CELL_ADD,
     cellHighlightInfo: cellHighlightInfo,
@@ -362,6 +365,16 @@ const SystemQuickSearchFloatingVisibility = (visible) => ({
     visible,
 });
 exports.SystemQuickSearchFloatingVisibility = SystemQuickSearchFloatingVisibility;
+const SystemCommentsShow = (cellPosition, editMode) => ({
+    type: exports.SYSTEM_COMMENTS_SHOW,
+    editMode,
+    cellPosition,
+});
+exports.SystemCommentsShow = SystemCommentsShow;
+const SystemCommentsHide = () => ({
+    type: exports.SYSTEM_COMMENTS_HIDE,
+});
+exports.SystemCommentsHide = SystemCommentsHide;
 const SystemDisableDeleteConfirmationSelector = (state) => {
     return state.DisableDeleteConfirmation;
 };
@@ -375,6 +388,16 @@ const SystemQuickSearchFloatingVisibilitySelector = (state) => {
     return (_a = state === null || state === void 0 ? void 0 : state.QuickSearch) === null || _a === void 0 ? void 0 : _a.floatingVisible;
 };
 exports.SystemQuickSearchFloatingVisibilitySelector = SystemQuickSearchFloatingVisibilitySelector;
+const SystemCommentsSelector = (state) => {
+    var _a;
+    return (_a = state === null || state === void 0 ? void 0 : state.Comments) === null || _a === void 0 ? void 0 : _a.popupPosition;
+};
+exports.SystemCommentsSelector = SystemCommentsSelector;
+const SystemCommentsEditModeSelector = (state) => {
+    var _a;
+    return (_a = state === null || state === void 0 ? void 0 : state.Comments) === null || _a === void 0 ? void 0 : _a.editMode;
+};
+exports.SystemCommentsEditModeSelector = SystemCommentsEditModeSelector;
 const initialState = {
     AdaptableAlerts: GeneralConstants_1.EMPTY_ARRAY,
     AdaptableFlashingCells: {},
@@ -762,6 +785,18 @@ const SystemReducer = (state = initialState, action) => {
             const typedAction = action;
             return Object.assign(Object.assign({}, state), { QuickSearch: Object.assign(Object.assign({}, state.QuickSearch), { floatingVisible: typedAction.visible }) });
         }
+        case exports.SYSTEM_COMMENTS_SHOW: {
+            const typedAction = action;
+            return Object.assign(Object.assign({}, state), { Comments: {
+                    editMode: typedAction.editMode,
+                    popupPosition: typedAction.cellPosition
+                } });
+        }
+        case exports.SYSTEM_COMMENTS_HIDE: {
+            return Object.assign(Object.assign({}, state), { Comments: {
+                    popupPosition: null,
+                } });
+        }
         default:
             return state;
     }

package/src/Redux/Store/AdaptableStore.js

@@ -11,7 +11,6 @@ const PopupRedux_1 = require("../ActionsReducers/PopupRedux");
 const PluginsRedux = tslib_1.__importStar(require("../ActionsReducers/PluginsRedux"));
 const AlertRedux = tslib_1.__importStar(require("../ActionsReducers/AlertRedux"));
 const FlashingCellRedux = tslib_1.__importStar(require("../ActionsReducers/FlashingCellRedux"));
-const DeadRedux = tslib_1.__importStar(require("../DeadRedux"));
 const SmartEditRedux = tslib_1.__importStar(require("../ActionsReducers/SmartEditRedux"));
 const BulkUpdateRedux = tslib_1.__importStar(require("../ActionsReducers/BulkUpdateRedux"));
 const CustomSortRedux = tslib_1.__importStar(require("../ActionsReducers/CustomSortRedux"));
@@ -26,6 +25,7 @@ const QuickSearchRedux = tslib_1.__importStar(require("../ActionsReducers/QuickS
 const ThemeRedux = tslib_1.__importStar(require("../ActionsReducers/ThemeRedux"));
 const FormatColumnRedux = tslib_1.__importStar(require("../ActionsReducers/FormatColumnRedux"));
 const StyledColumnRedux = tslib_1.__importStar(require("../ActionsReducers/StyledColumnRedux"));
+const CommentsRedux = tslib_1.__importStar(require("../ActionsReducers/CommentsRedux"));
 const ApplicationRedux = tslib_1.__importStar(require("../ActionsReducers/ApplicationRedux"));
 const FreeTextColumnRedux = tslib_1.__importStar(require("../ActionsReducers/FreeTextColumnRedux"));
 const LayoutRedux = tslib_1.__importStar(require("../ActionsReducers/LayoutRedux"));
@@ -148,11 +148,7 @@ class AdaptableStore {
             Query: QueryRedux.QueryReducer,
             Charting: ChartingRedux.ChartingReducer,
             StyledColumn: StyledColumnRedux.StyledColumnReducer,
-            // dead reducers
-            PercentBar: DeadRedux.PercentBarReducer,
-            UpdatedRow: DeadRedux.UpdatedRowReducer,
-            GradientColumn: DeadRedux.GradientColumnReducer,
-            ConditionalStyle: DeadRedux.ConditionalStyleReducer,
+            Comments: CommentsRedux.CommentsReducer,
         };
         // allow plugins to participate in the root reducer
         adaptable.forPlugins((plugin) => {
@@ -841,6 +837,24 @@ const adaptableMiddleware = (adaptable) => function (middlewareAPI) {
                     adaptable.api.themeApi.applyCurrentTheme();
                     return returnAction;
                 }
+                /*******************
+                 * Comments ACTIONS
+                 *******************/
+                /**
+                 * Use Case: Comment has been edited/deleted/added
+                 * Action: Triangle can be removed/added
+                 */
+                case CommentsRedux.COMMENTS_ADD:
+                case CommentsRedux.COMMENTS_EDIT:
+                case CommentsRedux.COMMENTS_DELETE: {
+                    let returnAction = next(action);
+                    const node = adaptable.api.gridApi.getRowNodeForPrimaryKey(returnAction.adaptableComment.PrimaryKeyValue);
+                    adaptable.refreshCells([node], [returnAction.adaptableComment.ColumnId], true);
+                    if (action.type == CommentsRedux.COMMENTS_DELETE) {
+                        adaptable.api.commentsApi.hideComment();
+                    }
+                    return returnAction;
+                }
                 /*******************
                  * SCHEDULE ACTIONS
                  *******************/

package/src/Strategy/CommentsModule.d.ts

@@ -0,0 +1,23 @@
+import { AdaptableApi } from '../Api/AdaptableApi';
+import { AdaptableMenuItem, ContextMenuContext } from '../PredefinedConfig/Common/Menu';
+import { CommentPosition } from '../types';
+import { AdaptableModuleBase } from './AdaptableModuleBase';
+import { IModule } from './Interface/IModule';
+/**
+ * In the first iteration a cell can have only one comment, the
+ * comments is a list to allow further development.
+ */
+export declare class CommentsModule extends AdaptableModuleBase implements IModule {
+    private adaptable;
+    constructor(api: AdaptableApi);
+    isModuleAvailable(): boolean;
+    handleAdaptableReady(): void;
+    addContextMenuItems(menuContext: ContextMenuContext): AdaptableMenuItem[] | undefined;
+    private getAddRemoveCommentMenuItems;
+    getCellPositionFromEvent(event: MouseEvent): null | {
+        PrimaryKeyValue: string | number;
+        ColumnId: string;
+    };
+    handleMouseEnter(event: MouseEvent): void;
+    handleCellSelected(cellPosition: CommentPosition): void;
+}

package/src/Strategy/CommentsModule.js

@@ -0,0 +1,141 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CommentsModule = void 0;
+const tslib_1 = require("tslib");
+const ModuleConstants = tslib_1.__importStar(require("../Utilities/Constants/ModuleConstants"));
+const AdaptableModuleBase_1 = require("./AdaptableModuleBase");
+/**
+ * In the first iteration a cell can have only one comment, the
+ * comments is a list to allow further development.
+ */
+class CommentsModule extends AdaptableModuleBase_1.AdaptableModuleBase {
+    constructor(api) {
+        super(ModuleConstants.CommentsModuleId, ModuleConstants.CommentsFriendlyName, 'comment', 'CommentsPopup', 'Comments', api);
+        this.adaptable = api.internalApi.getAdaptableInstance();
+        this.adaptable.api.eventApi.on('AdaptableReady', () => this.handleAdaptableReady());
+    }
+    isModuleAvailable() {
+        // FIXME remove this once Comments feature is public
+        return false;
+    }
+    handleAdaptableReady() {
+        if (!this.isModuleAvailable()) {
+            return;
+        }
+        this.adaptable._on('MouseEnter', (event) => this.handleMouseEnter(event));
+        this.api.eventApi.on('SelectionChanged', (params) => {
+            const cells = params.selectedCellInfo.gridCells;
+            if ((cells === null || cells === void 0 ? void 0 : cells.length) === 1) {
+                const selectedCell = cells[0];
+                const cellSelected = {
+                    PrimaryKeyValue: selectedCell.primaryKeyValue,
+                    ColumnId: selectedCell.column.columnId,
+                };
+                this.handleCellSelected(cellSelected);
+            }
+        });
+    }
+    addContextMenuItems(menuContext) {
+        var _a, _b;
+        if (!this.isModuleAvailable()) {
+            return undefined;
+        }
+        const items = [];
+        const isCellCommentable = (_b = (_a = this.adaptable.api.optionsApi) === null || _a === void 0 ? void 0 : _a.getUserInterfaceOptions()) === null || _b === void 0 ? void 0 : _b.isCellCommentable;
+        if (!isCellCommentable ||
+            isCellCommentable({
+                adaptableApi: this.adaptable.api,
+                primaryKeyValue: menuContext.primaryKeyValue,
+                columnId: menuContext.adaptableColumn.columnId,
+                userName: this.adaptable.api.optionsApi.getUserName(),
+                adaptableId: this.adaptable.adaptableOptions.adaptableId,
+            }))
+            items.push(...this.getAddRemoveCommentMenuItems(menuContext));
+        return items;
+    }
+    getAddRemoveCommentMenuItems(menuContext) {
+        var _a;
+        const items = [];
+        // does not have comment
+        const [comment] = (_a = this.adaptable.api.commentsApi.getCellComments({
+            PrimaryKeyValue: menuContext.primaryKeyValue,
+            ColumnId: menuContext.adaptableColumn.columnId,
+        })) !== null && _a !== void 0 ? _a : [];
+        if (comment) {
+            items.push(this.createColumnMenuItemClickFunction('Remove Comment', this.moduleInfo.Glyph, () => {
+                this.api.commentsApi.deleteComment(comment);
+            }));
+        }
+        else {
+            items.push(this.createColumnMenuItemClickFunction('Add Comment', this.moduleInfo.Glyph, () => {
+                // add an empty one
+                this.api.commentsApi.addComment('', menuContext.primaryKeyValue, menuContext.adaptableColumn.columnId);
+                this.api.commentsApi.showComment({
+                    PrimaryKeyValue: menuContext.primaryKeyValue,
+                    ColumnId: menuContext.adaptableColumn.columnId,
+                }, true);
+            }));
+        }
+        return items;
+    }
+    getCellPositionFromEvent(event) {
+        var _a, _b;
+        const target = event.target;
+        if (!((_b = (_a = target === null || target === void 0 ? void 0 : target.classList) === null || _a === void 0 ? void 0 : _a.contains) === null || _b === void 0 ? void 0 : _b.call(_a, 'ag-cell'))) {
+            return null;
+        }
+        try {
+            return {
+                PrimaryKeyValue: target.parentElement.getAttribute('row-id'),
+                ColumnId: target.getAttribute('col-id'),
+            };
+        }
+        catch (e) {
+            return null;
+        }
+    }
+    handleMouseEnter(event) {
+        var _a;
+        const editMode = this.adaptable.api.commentsApi.getCommentPopupEditMode();
+        if (editMode) {
+            // ignore
+            return;
+        }
+        const cellPosition = this.getCellPositionFromEvent(event);
+        const openCommentPosition = this.adaptable.api.commentsApi.getOpenCommentPosition();
+        // Hovering over someting that is not a cell and there is no open comment
+        if (!cellPosition && openCommentPosition) {
+            // need to close if the new cell does not have a comment
+            this.adaptable.api.commentsApi.hideComment();
+        }
+        else if ((_a = this.adaptable.api.commentsApi.getCellComments(cellPosition)) === null || _a === void 0 ? void 0 : _a.length) {
+            this.adaptable.api.commentsApi.showComment(cellPosition, false);
+        }
+    }
+    handleCellSelected(cellPosition) {
+        // if already opened - do nothing
+        const openCommentPosition = this.adaptable.api.commentsApi.getOpenCommentPosition();
+        if ((openCommentPosition === null || openCommentPosition === void 0 ? void 0 : openCommentPosition.PrimaryKeyValue) === cellPosition.PrimaryKeyValue &&
+            (openCommentPosition === null || openCommentPosition === void 0 ? void 0 : openCommentPosition.ColumnId) === cellPosition.ColumnId) {
+            return;
+        }
+        // if open but this has no comment, close
+        const cellComments = this.adaptable.api.commentsApi.getCellComments(cellPosition);
+        if (openCommentPosition && !(cellComments === null || cellComments === void 0 ? void 0 : cellComments.length)) {
+            // hide only if in edit mode
+            // because if you select a cell and move the mouse fast over another cell
+            // with a comment, you do not want to close that comment
+            // the selection is debounced, so the moment goes over the new cell this event is triggered
+            if (this.adaptable.api.commentsApi.getCommentPopupEditMode()) {
+                this.adaptable.api.commentsApi.hideComment();
+            }
+            return;
+        }
+        // if open but the new selection has a comment open that one in edit mode (because of click)
+        if (openCommentPosition && (cellComments === null || cellComments === void 0 ? void 0 : cellComments.length)) {
+            this.adaptable.api.commentsApi.showComment(cellPosition, true);
+            return;
+        }
+    }
+}
+exports.CommentsModule = CommentsModule;

package/src/Strategy/FormatColumnModule.d.ts

@@ -15,7 +15,6 @@ export declare class FormatColumnModule extends AdaptableModuleBase implements I
     getReferencedNamedQueryNames(formatColumn: FormatColumn): string[];
     updateOldConfig(): void;
     private updateFormatColumnSingleToMultiplePredicates;
-    private updateConditionalStylesColumnsOldConfig;
     addColumnMenuItems(column: AdaptableColumn): AdaptableMenuItem[] | undefined;
     getTeamSharingAction(): TeamSharingImportInfo<FormatColumn>;
     toView(formatColumn: FormatColumn): AdaptableObjectView;