@adaptabletools/adaptable-cjs 18.0.0-canary.3 → 18.0.0-canary.30

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

@@ -19,6 +19,10 @@ export interface AdaptableColumnBase extends AdaptableObject {
      * DataType of the Column
      */
     dataType: AdaptableColumnDataType;
+    /**
+     * Column Types of the Column
+     */
+    columnTypes?: string[];
 }
 export declare const isValidOrderForColumnGroups: ({ oldColumns, newColumns, }: {
     oldColumns: AdaptableColumn[];

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

@@ -54,4 +54,4 @@ export interface AdaptableBaseIcon {
 /**
  * All AdapTable System Icon names
  */
-export type AdaptableSystemIconName = 'add' | 'alert' | 'building' | 'laptop' | 'arrow-down' | 'arrow-left' | 'arrow-right' | 'arrow-up' | 'arrow-up-long' | 'arrow-down-long' | 'arrow-expand' | 'paperclip' | 'unfilled-circle' | 'boolean-list' | 'broadcast' | 'brush' | 'spanner' | 'edit-table' | 'chart-and-grid' | 'calendar' | 'call' | 'cells' | 'fdc3' | 'flag' | 'chart' | 'chat' | 'check' | 'check-circle' | 'checked' | 'clone' | 'close' | 'cloud-upload' | 'collapse' | 'column-add' | 'columns' | 'filter-list' | 'comment' | 'comments' | 'contains' | 'dashboard' | 'data-set' | 'date-range' | 'delete' | 'division' | 'dock' | 'dollar' | 'drag' | 'edit' | 'ends-with' | 'equals' | 'equation' | 'error' | 'expand' | 'exponent' | 'export' | 'export-data' | 'fast-backward' | 'fast-forward' | 'filter' | 'lightning' | 'folder' | 'folder-open' | 'folder-shared' | 'color-palette' | 'horizontal-lines' | 'function' | 'greater-than' | 'greater-than-or-equal' | 'history' | 'home' | 'import-export' | 'info' | 'brain' | 'download' | 'grid' | 'interactions' | 'less-than' | 'less-than-or-equal' | 'list' | 'logout' | 'mail' | 'menu' | 'minus' | 'multiplication' | 'money' | 'newpage' | 'news' | 'filled-circle' | 'not-contains' | 'not-equal' | 'open-in-new' | 'order' | 'organisation' | 'pause' | 'percent' | 'percent-tag' | 'person' | 'contact' | 'pie-chart' | 'play' | 'plus' | 'add-circle' | 'search' | 'search-table' | 'quote' | 'refresh' | 'regex' | 'reminder' | 'save' | 'schedule' | 'science' | 'settings' | 'link' | 'sort-asc' | 'sort-desc' | 'spark-line' | 'resume' | 'starts-with' | 'assignment' | 'statusbar' | 'stop' | 'traffic-lights' | 'tab-unselected' | 'theme' | 'clipboard' | 'target' | 'triangle-down' | 'triangle-up' | 'unchecked' | 'undo' | 'downloaded' | 'upload' | 'warning' | 'gradient' | 'badge' | 'italic' | 'bold' | 'align-left' | 'align-right' | 'align-center' | 'align-justify' | 'underline' | 'strikethrough' | 'overline' | 'case-upper' | 'case-lower' | 'case-sentence' | 'visibility-on' | 'visibility-off' | 'visibility-off-bold' | 'visibility-on-bold' | 'note' | 'import' | 'grid-filter';
+export type AdaptableSystemIconName = 'add' | 'alert' | 'building' | 'laptop' | 'arrow-down' | 'arrow-left' | 'arrow-right' | 'arrow-up' | 'arrow-up-long' | 'arrow-down-long' | 'arrow-expand' | 'paperclip' | 'unfilled-circle' | 'boolean-list' | 'broadcast' | 'brush' | 'spanner' | 'edit-table' | 'chart-and-grid' | 'calendar' | 'call' | 'cells' | 'fdc3' | 'flag' | 'chart' | 'chat' | 'check' | 'check-circle' | 'checked' | 'clone' | 'close' | 'cloud-upload' | 'collapse' | 'column-add' | 'columns' | 'filter-list' | 'copy' | 'comment' | 'comments' | 'contains' | 'dashboard' | 'data-set' | 'date-range' | 'delete' | 'division' | 'dock' | 'dollar' | 'drag' | 'edit' | 'ends-with' | 'equals' | 'equation' | 'error' | 'expand' | 'exponent' | 'export' | 'export-data' | 'fast-backward' | 'fast-forward' | 'filter' | 'filter-off' | 'lightning' | 'folder' | 'folder-open' | 'folder-shared' | 'color-palette' | 'horizontal-lines' | 'function' | 'greater-than' | 'greater-than-or-equal' | 'history' | 'home' | 'import-export' | 'info' | 'brain' | 'download' | 'grid' | 'interactions' | 'less-than' | 'less-than-or-equal' | 'list' | 'logout' | 'mail' | 'menu' | 'minus' | 'multiplication' | 'money' | 'newpage' | 'news' | 'filled-circle' | 'not-contains' | 'not-equal' | 'open-in-new' | 'order' | 'organisation' | 'pause' | 'percent' | 'percent-tag' | 'person' | 'contact' | 'pie-chart' | 'play' | 'plus' | 'add-circle' | 'search' | 'search-table' | 'select-all' | 'select-off' | 'select-fwd' | 'quote' | 'refresh' | 'regex' | 'reminder' | 'save' | 'schedule' | 'science' | 'settings' | 'link' | 'sort-asc' | 'sort-desc' | 'spark-line' | 'resume' | 'starts-with' | 'assignment' | 'statusbar' | 'stop' | 'traffic-lights' | 'tab-unselected' | 'theme' | 'clipboard' | 'target' | 'triangle-down' | 'triangle-up' | 'unchecked' | 'undo' | 'downloaded' | 'upload' | 'warning' | 'gradient' | 'badge' | 'italic' | 'bold' | 'align-left' | 'align-right' | 'align-center' | 'align-justify' | 'underline' | 'strikethrough' | 'overline' | 'case-upper' | 'case-lower' | 'case-sentence' | 'visibility-on' | 'visibility-off' | 'visibility-off-bold' | 'visibility-on-bold' | 'note' | 'import' | 'grid-filter' | 'grid-info' | 'rows';

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

@@ -8,7 +8,10 @@ export type ScopeDataTypes<Type = ScopeDataType> = {
 export type ScopeColumnIds = {
     ColumnIds: string[];
 };
+export type ScopeColumnTypes = {
+    ColumnTypes: string[];
+};
 /**
  * Defines where a given Object / Module is active
  */
-export type AdaptableScope<Type = ScopeDataType> = ScopeAll | ScopeDataTypes<Type> | ScopeColumnIds;
+export type AdaptableScope<Type = ScopeDataType> = ScopeAll | ScopeDataTypes<Type> | ScopeColumnIds | ScopeColumnTypes;

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

@@ -16,3 +16,4 @@ export interface WeightedAverageAggregation {
  * Defines which Columns in a Layout display Aggregated values when Row-Grouped
  */
 export type AggregationColumns = Record<string, string | true | WeightedAverageAggregation>;
+export declare const isWeightedAverageAggregation: (aggFunc: AggregationColumns[keyof AggregationColumns]) => aggFunc is WeightedAverageAggregation;

package/src/PredefinedConfig/Common/AggregationColumns.js

@@ -1,4 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.WEIGHTED_AVERAGE_AGG_FN_NAME = void 0;
+exports.isWeightedAverageAggregation = exports.WEIGHTED_AVERAGE_AGG_FN_NAME = void 0;
 exports.WEIGHTED_AVERAGE_AGG_FN_NAME = 'weightedAvg';
+const isWeightedAverageAggregation = (aggFunc) => {
+    return (aggFunc === null || aggFunc === void 0 ? void 0 : aggFunc.type) === 'weightedAverage';
+};
+exports.isWeightedAverageAggregation = isWeightedAverageAggregation;

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

@@ -1,4 +1,5 @@
 import { BaseContext } from '../../../types';
+import { AdaptableColumn } from '../../types';
 import { SelectedCellInfo } from '../Selection/SelectedCellInfo';
 /**
  * Defines the Summary operations provides for Selected Cells
@@ -14,6 +15,8 @@ export interface CellSummmary {
     Count: number | undefined;
     Only: string | undefined;
     Std_Deviation: number | undefined;
+    Oldest: Date | undefined;
+    Newest: Date | undefined;
     [key: string]: any;
 }
 /**
@@ -38,19 +41,7 @@ export interface CellSummaryOperationContext<TData = any> extends BaseContext {
      */
     selectedCellInfo: SelectedCellInfo<TData>;
     /**
-     * All values of selected cells
+     * Currently selected Column
      */
-    allValues: any[];
-    /**
-     * Any numeric columns in current selection
-     */
-    numericColumns: string[];
-    /**
-     * Any numeric values in current selection
-     */
-    numericValues: number[];
-    /**
-     * Count of currently selected cells
-     */
-    distinctCount: number;
+    selectedColumn: AdaptableColumn;
 }

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

@@ -6,6 +6,10 @@ export interface DataUpdateConfig {
      * Whether data should be updated asynchronously
      */
     runAsync?: boolean;
+    /**
+     * Whether to flush async updates
+     */
+    flushAsync?: boolean;
     /**
      * Callback function invoked when a batch successfully updates
      */

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

@@ -59,8 +59,11 @@ export declare enum SummaryOperation {
     Max = "Max",
     Min = "Min",
     Count = "Count",
+    Newest = "Newest",
+    Oldest = "Oldest",
     Std_Deviation = "Std Deviation",
-    Only = "Only"
+    Only = "Only",
+    Weighted_Average = "Weighted Avg"
 }
 export declare enum FilterOnDataChangeOptions {
     Always = "Always",

package/src/PredefinedConfig/Common/Enums.js

@@ -76,8 +76,11 @@ var SummaryOperation;
     SummaryOperation["Max"] = "Max";
     SummaryOperation["Min"] = "Min";
     SummaryOperation["Count"] = "Count";
+    SummaryOperation["Newest"] = "Newest";
+    SummaryOperation["Oldest"] = "Oldest";
     SummaryOperation["Std_Deviation"] = "Std Deviation";
     SummaryOperation["Only"] = "Only";
+    SummaryOperation["Weighted_Average"] = "Weighted Avg";
 })(SummaryOperation = exports.SummaryOperation || (exports.SummaryOperation = {}));
 var FilterOnDataChangeOptions;
 (function (FilterOnDataChangeOptions) {

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

@@ -74,7 +74,7 @@ export declare const Fdc3StandardIntents: ("StartCall" | "StartChat" | "StartEma
 /**
  * All FDC3 standard intents
  */
-export type Fdc3StandardIntentType = typeof Fdc3StandardIntents[number];
+export type Fdc3StandardIntentType = (typeof Fdc3StandardIntents)[number];
 /**
  * Custom FDC3 intent
  */
@@ -86,4 +86,4 @@ export type Fdc3IntentType = Fdc3StandardIntentType | Fdc3CustomIntentType;
 /**
  * Valid context for a given FDC3 intent
  */
-export type CompatibleContext<F extends Fdc3StandardIntentType> = typeof Fdc3IntentConfiguration[F]['contexts'][number];
+export type CompatibleContext<F extends Fdc3StandardIntentType> = (typeof Fdc3IntentConfiguration)[F]['contexts'][number];

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

@@ -5,12 +5,26 @@ import { SelectedCellInfo } from '../Selection/SelectedCellInfo';
 import { SelectedRowInfo } from '../Selection/SelectedRowInfo';
 import { Column, IRowNode } from '@ag-grid-community/core';
 import { AdaptableIcon, BaseContext } from '../../types';
+export type AdaptableColumnMenuItemName = (typeof ADAPTABLE_COLUMN_MENU_ITEMS)[number];
+export type AdaptableContextMenuItemName = (typeof ADAPTABLE_CONTEXT_MENU_ITEMS)[number];
+/**
+ * List of Shipped Adaptable Column Menu Items
+ */
+export declare const ADAPTABLE_COLUMN_MENU_ITEMS: readonly ["calculated-column-edit", "cell-summary-show", "column-group", "column-filter-group", "column-filter-bar-hide", "column-filter-bar-show", "column-filter-clear", "column-filter-suspend", "column-filter-unsuspend", "column-info-show", "custom-sort-add", "custom-sort-edit", "dashboard-collapse", "dashboard-configure", "dashboard-dock", "dashboard-expand", "dashboard-float", "dashboard-hide", "dashboard-show", "data-import", "flashing-cell-add", "flashing-cell-delete", "format-column-add", "format-column-edit", "free-text-column-edit", "grid-group", "grid-info-show", "layout-column-caption-change", "layout-column-hide", "layout-edit", "layout-column-select", "layout-column-select-preserve", "layout-column-select-reset", "layout-grid-select", "plus-minus-add", "settings-panel-open", "styling-group", "styled-column-badge-add", "styled-column-badge-edit", "styled-column-gradient-add", "styled-column-gradient-edit", "styled-column-percent-bar-add", "styled-column-percent-bar-edit", "styled-column-sparkline-add", "styled-column-sparkline-edit", "system-status-show", "_navbar"];
+/**
+ * List of Shipped Adaptable Context Menu Items
+ */
+export declare const ADAPTABLE_CONTEXT_MENU_ITEMS: readonly ["menu-group", "alert-clear", "bulk-update-apply", "calculated-column-edit", "cell-summary-show", "column-group", "column-filter-on-cell-value", "column-filter-clear", "column-filter-suspend", "column-filter-unsuspend", "column-info-show", "comment-add", "comment-remove", "dashboard-collapse", "dashboard-configure", "dashboard-dock", "dashboard-expand", "dashboard-float", "dashboard-hide", "dashboard-show", "data-import", "edit-group", "export-visual-data-excel", "export-all-data-excel", "export-all-data-csv", "export-all-data-clipboard", "export-all-data-json", "export-all-data-table", "export-current-data-excel", "export-current-data-csv", "export-current-data-clipboard", "export-current-data-json", "export-current-data-table", "export-selected-cells-excel", "export-selected-cells-csv", "export-selected-cells-clipboard", "export-selected-cells-json", "export-selected-cells-table", "export-selected-rows-excel", "export-selected-rows-csv", "export-selected-rows-clipboard", "export-selected-rows-json", "export-selected-rows-table", "fdc3-broadcast", "fdc3-raise-intent", "flashing-cell-clear", "flashing-row-clear", "grid-group", "grid-info-show", "layout-aggregated-view", "layout-auto-size", "layout-clear-selection", "layout-edit", "layout-select-all", "note-add", "note-remove", "settings-panel-open", "smart-edit-apply", "system-status-show"];
 /**
  * Menu item used by Adaptable in both Column and Context Menus
  */
 export interface AdaptableMenuItem {
     /**
-     * Name that appears in the menu
+     * Unique name for the Menu Item
+     */
+    name: AdaptableColumnMenuItemName | AdaptableContextMenuItemName;
+    /**
+     * Text that appears in the menu
      */
     label: string;
     /**

package/src/PredefinedConfig/Common/Menu.js

@@ -1,2 +1,119 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.ADAPTABLE_CONTEXT_MENU_ITEMS = exports.ADAPTABLE_COLUMN_MENU_ITEMS = void 0;
+/**
+ * List of Shipped Adaptable Column Menu Items
+ */
+exports.ADAPTABLE_COLUMN_MENU_ITEMS = [
+    'calculated-column-edit',
+    'cell-summary-show',
+    'column-group',
+    'column-filter-group',
+    'column-filter-bar-hide',
+    'column-filter-bar-show',
+    'column-filter-clear',
+    'column-filter-suspend',
+    'column-filter-unsuspend',
+    'column-info-show',
+    'custom-sort-add',
+    'custom-sort-edit',
+    'dashboard-collapse',
+    'dashboard-configure',
+    'dashboard-dock',
+    'dashboard-expand',
+    'dashboard-float',
+    'dashboard-hide',
+    'dashboard-show',
+    'data-import',
+    'flashing-cell-add',
+    'flashing-cell-delete',
+    'format-column-add',
+    'format-column-edit',
+    'free-text-column-edit',
+    'grid-group',
+    'grid-info-show',
+    'layout-column-caption-change',
+    'layout-column-hide',
+    'layout-edit',
+    'layout-column-select',
+    'layout-column-select-preserve',
+    'layout-column-select-reset',
+    'layout-grid-select',
+    'plus-minus-add',
+    'settings-panel-open',
+    'styling-group',
+    'styled-column-badge-add',
+    'styled-column-badge-edit',
+    'styled-column-gradient-add',
+    'styled-column-gradient-edit',
+    'styled-column-percent-bar-add',
+    'styled-column-percent-bar-edit',
+    'styled-column-sparkline-add',
+    'styled-column-sparkline-edit',
+    'system-status-show',
+    '_navbar', // used in SettingsPanel navigation bar and in Dashboard Module buttons
+];
+/**
+ * List of Shipped Adaptable Context Menu Items
+ */
+exports.ADAPTABLE_CONTEXT_MENU_ITEMS = [
+    'menu-group',
+    'alert-clear',
+    'bulk-update-apply',
+    'calculated-column-edit',
+    'cell-summary-show',
+    'column-group',
+    'column-filter-on-cell-value',
+    'column-filter-clear',
+    'column-filter-suspend',
+    'column-filter-unsuspend',
+    'column-info-show',
+    'comment-add',
+    'comment-remove',
+    'dashboard-collapse',
+    'dashboard-configure',
+    'dashboard-dock',
+    'dashboard-expand',
+    'dashboard-float',
+    'dashboard-hide',
+    'dashboard-show',
+    'data-import',
+    'edit-group',
+    'export-visual-data-excel',
+    'export-all-data-excel',
+    'export-all-data-csv',
+    'export-all-data-clipboard',
+    'export-all-data-json',
+    'export-all-data-table',
+    'export-current-data-excel',
+    'export-current-data-csv',
+    'export-current-data-clipboard',
+    'export-current-data-json',
+    'export-current-data-table',
+    'export-selected-cells-excel',
+    'export-selected-cells-csv',
+    'export-selected-cells-clipboard',
+    'export-selected-cells-json',
+    'export-selected-cells-table',
+    'export-selected-rows-excel',
+    'export-selected-rows-csv',
+    'export-selected-rows-clipboard',
+    'export-selected-rows-json',
+    'export-selected-rows-table',
+    'fdc3-broadcast',
+    'fdc3-raise-intent',
+    'flashing-cell-clear',
+    'flashing-row-clear',
+    'grid-group',
+    'grid-info-show',
+    'layout-aggregated-view',
+    'layout-auto-size',
+    'layout-clear-selection',
+    'layout-edit',
+    'layout-select-all',
+    'note-add',
+    'note-remove',
+    'settings-panel-open',
+    'smart-edit-apply',
+    'system-status-show',
+];

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

@@ -0,0 +1,21 @@
+export declare const ROW_SUMMARY_ROW_ID = "__ROW_SUMMARY_ROW_ID";
+export declare const WEIGHTED_AVERAGE_AGGREATED_FUNCTION = "WEIGHTED_AVERAGE";
+export declare const summarySupportedExpressions: readonly ["MIN", "MAX", "SUM", "AVG", "COUNT", "MEDIAN", "MODE", "DISTINCT", "ONLY", "OLDEST", "NEWEST", "STD_DEVIATION", "WEIGHTED_AVERAGE"];
+export type SummarySupportedExpression = (typeof summarySupportedExpressions)[number];
+/**
+ * Position of Row Summary - 'Top' or 'Bottom'
+ */
+export type RowSummaryPosition = 'Top' | 'Bottom';
+/**
+ * Defines a Row Summary used in a Layout
+ */
+export interface RowSummary {
+    /**
+     * Where Row Summary appears - 'Top' or 'Bottom'
+     */
+    Position?: RowSummaryPosition;
+    /**
+     * Map of Columns with Summary Expressions
+     */
+    ColumnsMap: Record<string, SummarySupportedExpression>;
+}

package/src/PredefinedConfig/Common/RowSummary.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.summarySupportedExpressions = exports.WEIGHTED_AVERAGE_AGGREATED_FUNCTION = exports.ROW_SUMMARY_ROW_ID = void 0;
+exports.ROW_SUMMARY_ROW_ID = '__ROW_SUMMARY_ROW_ID';
+exports.WEIGHTED_AVERAGE_AGGREATED_FUNCTION = 'WEIGHTED_AVERAGE';
+exports.summarySupportedExpressions = [
+    'MIN',
+    'MAX',
+    'SUM',
+    'AVG',
+    'COUNT',
+    'MEDIAN',
+    'MODE',
+    'DISTINCT',
+    'ONLY',
+    'OLDEST',
+    'NEWEST',
+    'STD_DEVIATION',
+    exports.WEIGHTED_AVERAGE_AGGREATED_FUNCTION,
+];

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

@@ -0,0 +1,30 @@
+/**
+ * Config used when transposing a Grid
+ */
+export interface TransposeConfig {
+    /**
+     * Column to use to do transposition
+     * @defaultValue Primary Key Column
+     */
+    transposedColumnId?: string;
+    /**
+     * Hide the Transposed Column
+     * @defaultValue true
+     */
+    hideTransposedColumn?: boolean;
+    /**
+     * Only show curerntly visible Columns
+     * @defaultValue false
+     */
+    visibleColumns?: boolean;
+    /**
+     * Only show curerntly visible Rows
+     * @defaultValue false
+     */
+    visibleRows?: boolean;
+    /**
+     * Autosize columns in transposed view
+     * @defaultValue true
+     */
+    autosize?: boolean;
+}

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

@@ -11,7 +11,7 @@ export declare const ALL_TOOLBARS: AdaptableDashboardToolbar[];
 /**
  * Modules which can appear in the AdapTable Status Bar
  */
-export type AdaptableStatusBarPanel = 'Alert' | 'CalculatedColumn' | 'BulkUpdate' | 'CellSummary' | 'Charting' | 'CustomSort' | 'Dashboard' | 'DataChangeHistory' | 'DataImport' | 'DataSet' | 'Export' | 'ColumnFilter' | 'GridFilter' | 'FlashingCell' | 'FormatColumn' | 'FreeTextColumn' | 'GridInfo' | 'Layout' | 'PlusMinus' | 'QuickSearch' | 'Schedule' | 'SettingsPanel' | 'SmartEdit' | 'Shortcut' | 'StateManagement' | 'StatusBar' | 'SystemStatus' | 'TeamSharing' | 'Theme' | 'ToolPanel';
+export type AdaptableStatusBarPanel = 'Alert' | 'CalculatedColumn' | 'BulkUpdate' | 'CellSummary' | 'Charting' | 'Comment' | 'CustomSort' | 'Dashboard' | 'DataChangeHistory' | 'DataImport' | 'DataSet' | 'Export' | 'ColumnFilter' | 'GridFilter' | 'FlashingCell' | 'FormatColumn' | 'FreeTextColumn' | 'GridInfo' | 'Layout' | 'Note' | 'PlusMinus' | 'QuickSearch' | 'Schedule' | 'SettingsPanel' | 'SmartEdit' | 'Shortcut' | 'StateManagement' | 'StatusBar' | 'SystemStatus' | 'TeamSharing' | 'Theme' | 'ToolPanel';
 export declare const ALL_STATUS_SUB_PANELS: AdaptableStatusBarPanel[];
 export type AdaptableToolPanels = AdaptableToolPanel[];
 /**
@@ -28,18 +28,18 @@ export type AdaptableModuleButtons = AdaptableModuleButton[];
 /**
  * List of all the Module buttons Adaptable provides - each Module has a popup for which this is a shortcut button
  */
-export type AdaptableModuleButton = 'Alert' | 'BulkUpdate' | 'CalculatedColumn' | 'CellSummary' | 'CustomSort' | 'Dashboard' | 'DataChangeHistory' | 'DataImport' | 'DataSet' | 'Export' | 'ColumnFilter' | 'GridFilter' | 'NamedQuery' | 'FlashingCell' | 'FormatColumn' | 'FreeTextColumn' | 'GridInfo' | 'Layout' | 'OpenFin' | 'PlusMinus' | 'QuickSearch' | 'Schedule' | 'SettingsPanel' | 'Shortcut' | 'SmartEdit' | 'StyledColumn' | 'StateManagement' | 'StatusBar' | 'SystemStatus' | 'TeamSharing' | 'Theme';
+export type AdaptableModuleButton = 'Alert' | 'BulkUpdate' | 'CalculatedColumn' | 'CellSummary' | 'Comment' | 'CustomSort' | 'Dashboard' | 'DataChangeHistory' | 'DataImport' | 'DataSet' | 'Export' | 'ColumnFilter' | 'GridFilter' | 'NamedQuery' | 'FlashingCell' | 'FormatColumn' | 'FreeTextColumn' | 'GridInfo' | 'Layout' | 'Note' | 'OpenFin' | 'PlusMinus' | 'QuickSearch' | 'Schedule' | 'SettingsPanel' | 'Shortcut' | 'SmartEdit' | 'StyledColumn' | 'StateManagement' | 'StatusBar' | 'SystemStatus' | 'TeamSharing' | 'Theme';
 export type AdaptableStateKeys = AdaptableStateKey[];
 export type AdaptableStateKey = keyof AdaptablePersistentState | 'OpenFin' | 'IPushPull';
 /**
  * Modules provided by AdapTable, subject to Entitlements and usually have Predefined Config
  */
-export type AdaptableModule = 'Alert' | 'BulkUpdate' | 'CalculatedColumn' | 'CellSummary' | 'Charting' | 'CustomSort' | 'Dashboard' | 'DataChangeHistory' | 'DataSet' | 'Export' | 'Fdc3' | 'ColumnFilter' | 'FlashingCell' | 'FormatColumn' | 'FreeTextColumn' | 'GridInfo' | 'ColumnInfo' | 'IPushPull' | 'Layout' | 'OpenFin' | 'PlusMinus' | 'QuickSearch' | 'Schedule' | 'SettingsPanel' | 'Shortcut' | 'SmartEdit' | 'StyledColumn' | 'StateManagement' | 'StatusBar' | 'SystemStatus' | 'TeamSharing' | 'Theme' | 'ToolPanel' | 'Notes' | 'DataImport' | 'GridFilter' | 'NamedQuery' | 'Comments';
+export type AdaptableModule = 'Alert' | 'BulkUpdate' | 'CalculatedColumn' | 'CellSummary' | 'Charting' | 'Comment' | 'CustomSort' | 'Dashboard' | 'DataChangeHistory' | 'DataSet' | 'Export' | 'Fdc3' | 'ColumnFilter' | 'FlashingCell' | 'FormatColumn' | 'FreeTextColumn' | 'GridInfo' | 'ColumnInfo' | 'IPushPull' | 'Layout' | 'OpenFin' | 'PlusMinus' | 'QuickSearch' | 'Schedule' | 'SettingsPanel' | 'Shortcut' | 'SmartEdit' | 'StyledColumn' | 'StateManagement' | 'StatusBar' | 'SystemStatus' | 'TeamSharing' | 'Theme' | 'ToolPanel' | 'Note' | 'DataImport' | 'GridFilter' | 'NamedQuery';
 export declare const ALL_MODULES: AdaptableModule[];
 /**
  * Modules which can appear in the Settings Panel
  */
-export type AdaptableSettingsPanel = 'Alert' | 'CalculatedColumn' | 'Charting' | 'CustomSort' | 'Dashboard' | 'DataChangeHistory' | 'DataSet' | 'Export' | 'ColumnFilter' | 'FlashingCell' | 'FormatColumn' | 'FreeTextColumn' | 'GridInfo' | 'ColumnInfo' | 'Layout' | 'PlusMinus' | 'QuickSearch' | 'Schedule' | 'Shortcut' | 'StateManagement' | 'StatusBar' | 'StyledColumn' | 'SystemStatus' | 'TeamSharing' | 'Theme' | 'ToolPanel' | 'Notes' | 'DataImport' | 'GridFilter' | 'NamedQuery' | 'Comments';
+export type AdaptableSettingsPanel = 'Alert' | 'CalculatedColumn' | 'Charting' | 'CustomSort' | 'Dashboard' | 'DataChangeHistory' | 'DataSet' | 'Export' | 'ColumnFilter' | 'FlashingCell' | 'FormatColumn' | 'FreeTextColumn' | 'GridInfo' | 'ColumnInfo' | 'Layout' | 'PlusMinus' | 'QuickSearch' | 'Schedule' | 'Shortcut' | 'StateManagement' | 'StatusBar' | 'StyledColumn' | 'SystemStatus' | 'TeamSharing' | 'Theme' | 'ToolPanel' | 'Note' | 'DataImport' | 'GridFilter' | 'NamedQuery' | 'Comment';
 export type TypeHint<Base, Literals> = (Base & {
     __subType?: true;
 }) | Literals;

package/src/PredefinedConfig/Common/Types.js

@@ -30,6 +30,7 @@ exports.ALL_STATUS_SUB_PANELS = [
     'BulkUpdate',
     'CalculatedColumn',
     'CellSummary',
+    'Comment',
     'CustomSort',
     'Charting',
     'Dashboard',
@@ -44,6 +45,7 @@ exports.ALL_STATUS_SUB_PANELS = [
     'FreeTextColumn',
     'GridInfo',
     'Layout',
+    'Note',
     'PlusMinus',
     'QuickSearch',
     'Schedule',
@@ -81,7 +83,8 @@ exports.ALL_MODULES = [
     ModuleConstants.BulkUpdateModuleId,
     ModuleConstants.CalculatedColumnModuleId,
     ModuleConstants.CellSummaryModuleId,
-    ModuleConstants.NotesModuleId,
+    ModuleConstants.NoteModuleId,
+    ModuleConstants.CommentModuleId,
     ModuleConstants.ChartingModuleId,
     ModuleConstants.CustomSortModuleId,
     ModuleConstants.DashboardModuleId,

package/src/PredefinedConfig/FormatColumnState.d.ts

@@ -41,10 +41,15 @@ export interface FormatColumn extends SuspendableObject {
      */
     CellAlignment?: 'Left' | 'Right' | 'Center';
     /**
-     * Whether to Format the Column in Grouped Rows
+     * Interop.io to Format the Column in Grouped Rows
      * @defaultValue false
      */
     IncludeGroupedRows?: boolean;
+    /**
+     * Interop.io to include Row Summary Rows
+     * @defaultValue false
+     */
+    IncludeRowSummaries?: boolean;
 }
 /**
  * The Format Column Rule - can be either a Predicate or a BooleanExpression

package/src/PredefinedConfig/LayoutState.d.ts

@@ -3,6 +3,7 @@ import { AdaptableObject } from './Common/AdaptableObject';
 import { ColumnSort } from './Common/ColumnSort';
 import { ColumnFilter, GridFilter } from '../types';
 import { AggregationColumns } from './Common/AggregationColumns';
+import { RowSummary } from './Common/RowSummary';
 /**
  * Predefined Configuration for the Layout Module
  */
@@ -82,4 +83,8 @@ export interface Layout extends AdaptableObject {
      * Whether to include the aggFunc name in the column header: e.g. 'sum(Bank Balance)' will just be 'Bank Balance'
      */
     SuppressAggFuncInHeader?: boolean;
+    /**
+     * Row Summaries - Pinned Rows that display Aggregation Info for a whole column
+     */
+    RowSummaries?: RowSummary[];
 }

package/src/PredefinedConfig/{NotesState.d.ts → NoteState.d.ts}

@@ -1,5 +1,14 @@
 import { AdaptableObject } from '../types';
 import { ConfigState } from './ConfigState';
+/**
+ * Predefined Configuration for Note Module
+ */
+export interface NoteState extends ConfigState {
+    /**
+     * Collection of AdapTable Notes
+     */
+    Notes?: AdaptableNotes;
+}
 /**
  * Note that can be applied to a Cell in AdapTable
  */
@@ -7,17 +16,11 @@ export interface AdaptableNote extends AdaptableObject {
     /**
      * When Note was made
      */
-    Timestamp: number;
-    /**
-     * Value of the Note
-     */
-    Value: string;
+    Timestamp?: number;
     /**
-     * Author of the Note
+     * Content of the Note
      */
-    Author: {
-        UserName: string;
-    };
+    Text: string;
     /**
      * Value in Grid's Primary Key Column
      */
@@ -26,21 +29,8 @@ export interface AdaptableNote extends AdaptableObject {
      * Id of Column containing the Note
      */
     ColumnId: string;
-    /**
-     * Id of this AdapTable instance
-     */
-    AdaptableId: string;
 }
 /**
  * Collection of Cell Notes
  */
 export type AdaptableNotes = AdaptableNote[];
-/**
- * Predefined Configuration for Notes Module
- */
-export interface NotesState extends ConfigState {
-    /**
-     * Collection of AdapTable Notes
-     */
-    Notes?: AdaptableNotes;
-}

package/src/PredefinedConfig/PopupState.d.ts

@@ -1,4 +1,4 @@
-import { ScreenPopup, ConfirmationPopup, PromptPopup, LoadingPopup, WindowPopup, FormPopup } from '../Utilities/Interface/MessagePopups';
+import { ScreenPopup, ConfirmationPopup, PromptPopup, WindowPopup, FormPopup } from '../Utilities/Interface/MessagePopups';
 import { InternalState } from './InternalState';
 /**
  * Internal state to manage open popups - NOT persisted by Redux
@@ -9,5 +9,4 @@ export interface PopupState extends InternalState {
     FormPopup: FormPopup;
     ConfirmationPopup: ConfirmationPopup;
     PromptPopup: PromptPopup;
-    LoadingPopup: LoadingPopup;
 }

package/src/PredefinedConfig/PredefinedConfig.d.ts

@@ -17,7 +17,7 @@ import { ToolPanelState } from './ToolPanelState';
 import { StatusBarState } from './StatusBarState';
 import { ChartingState } from './ChartingState';
 import { StyledColumnState } from './StyledColumnState';
-import { NotesState } from './NotesState';
+import { NoteState } from './NoteState';
 import { NamedQueryState } from '../types';
 /**
  * This is the main Predefined Config interface which developers will populate at design-time
@@ -44,9 +44,9 @@ export interface PredefinedConfig {
      */
     CustomSort?: CustomSortState;
     /**
-     * Collection of notes that can be edited on cell level
+     * Collection of personal Notes that are edited at Cell level
      */
-    Notes?: NotesState;
+    Note?: NoteState;
     /**
      * 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/Selection/GridCell.d.ts

@@ -1,5 +1,18 @@
 import { IRowNode } from '@ag-grid-community/core';
 import { AdaptableColumn } from '../Common/AdaptableColumn';
+/**
+ * Very lightweight object to define an AdapTable Cell
+ */
+export type CellAddress = {
+    /**
+     * Value in Primary Key Column
+     */
+    PrimaryKeyValue: string | number;
+    /**
+     * Id of Column containing the Note
+     */
+    ColumnId: string;
+};
 /**
  * Defines a Cell in Adaptable - every cell is an intersection of a Column Id and a Primary Key Value
  */

package/src/PredefinedConfig/StyledColumnState.d.ts

@@ -41,6 +41,11 @@ export interface StyledColumn extends SuspendableObject {
      * @defaultValue false
      */
     IncludeGroupedRows?: boolean;
+    /**
+     * Includes Row Summaries in Styled Column
+     * @defaultValue false
+     */
+    IncludeRowSummaries?: boolean;
 }
 /**
  * Style used to display Percent Bars in Special Column Style