@adaptabletools/adaptable 23.1.0 → 24.0.0-canary.0

package/src/AdaptableState/Common/ColumnFilter.d.ts

@@ -1,7 +1,6 @@
-import { SuspendableObject, AdaptablePredicate } from '../../types';
-import { TypeHint } from './Types';
+import { SuspendableObject } from '../../types';
 /**
- * Defines a Filter applied on a Column using a Predicate
+ * Defines an AdaptableQL Filter applied on a Column
  */
 export interface ColumnFilter extends SuspendableObject {
     /**
@@ -9,30 +8,24 @@ export interface ColumnFilter extends SuspendableObject {
      */
     ColumnId: string;
     /**
-     * `AdaptablePredicate` which AdaptableQL will evaluate when the Filter is run
+     * AdaptableQL boolean expression evaluated for each row, e.g.
+     *
+     * `[price] > 100 AND [price] < 200 OR [price] = 350`
+     *
+     * Mutually exclusive with {@link ColumnFilter.PreferredFilter}: when
+     * `Expression` is set, `PreferredFilter` is not persisted.
      */
-    Predicates: ColumnFilterPredicate[];
+    Expression?: string;
     /**
-     * Logic used when combining multiple Predicates ('AND'|'OR')
-     * @defaultValue 'AND'
+     * Preferred filter operator when there is no `Expression` (UI seed only —
+     * does not filter rows). Uses AQL operator / function names, the same
+     * vocabulary as `columnFilterOptions.default*ColumnFilter` (e.g. `'IN'`,
+     * `'STARTS_WITH'`, `'EQ'`).
+     *
+     * Mutually exclusive with {@link ColumnFilter.Expression}: set when the
+     * user selects an operator before the filter is complete; removed as
+     * soon as a valid `Expression` is persisted; restored from the current
+     * UI operator when the `Expression` is cleared.
      */
-    PredicatesOperator?: PredicatesOperator;
+    PreferredFilter?: string;
 }
-/**
- * A Predicate used in Column Filtering
- */
-export interface ColumnFilterPredicate extends AdaptablePredicate {
-    PredicateId: TypeHint<string, SystemFilterPredicateId>;
-}
-/**
- * Logic used to join multiple Predicates
- */
-export type PredicatesOperator = 'AND' | 'OR';
-/**
- * Array containing all System Filter Predicates
- */
-export type SystemFilterPredicateIds = SystemFilterPredicateId[];
-/**
- * List of System Predicates available for Filters
- */
-export type SystemFilterPredicateId = 'In' | 'NotIn' | 'Blanks' | 'NonBlanks' | 'Equals' | 'NotEquals' | 'GreaterThan' | 'LessThan' | 'Positive' | 'Negative' | 'Zero' | 'Between' | 'NotBetween' | 'Is' | 'IsNot' | 'Contains' | 'NotContains' | 'StartsWith' | 'EndsWith' | 'Regex' | 'Today' | 'Yesterday' | 'Tomorrow' | 'ThisWeek' | 'ThisMonth' | 'ThisQuarter' | 'ThisYear' | 'InPast' | 'InFuture' | 'Before' | 'After' | 'InRange' | 'On' | 'NotOn' | 'NextWorkDay' | 'LastWorkDay' | 'WorkDay' | 'Holiday' | 'True' | 'False' | 'BooleanToggle';

package/src/AdaptableState/Common/CompactCalculatedColumnEditorInfo.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Session-only state for the compact Calculated Column expression editor
+ * (Standard / Cumulative / Quantile / Window; live updates; not persisted).
+ */
+export interface CompactCalculatedColumnEditorInfo {
+    calculatedColumnId: string;
+}

package/src/AdaptableState/Common/ExtendedLayout.d.ts

@@ -6,7 +6,6 @@ import { FormatColumn } from '../FormatColumnState';
 import { PlusMinusNudge } from '../PlusMinusState';
 import { Shortcut } from '../ShortcutState';
 import { StyledColumn } from '../StyledColumnState';
-import { ReportSchedule } from '../ExportState';
 /**
  * Defines an Extended Layout - provides a Layout and all objects that refer to it
  */
@@ -18,12 +17,12 @@ export interface ExtendedLayout {
     /**
      * Object to be included in the Layout
      */
-    Extensions: LayoutExtension[];
+    Extensions: ExtendedLayoutObject[];
 }
 /**
  * Defines an object being extended in a Layout
  */
-export interface LayoutExtension {
+export interface ExtendedLayoutObject {
     /**
      * Module to which Extended Object belongs
      */
@@ -36,15 +35,49 @@ export interface LayoutExtension {
 /**
  * Types of Adaptable Objects that can added to Extended Layouts
  */
-export type LayoutExtensionObject = AlertDefinition | CustomSort | FlashingCellDefinition | FormatColumn | PlusMinusNudge | StyledColumn | Shortcut | ReportSchedule;
+export type LayoutExtensionObject = AlertDefinition | CustomSort | FlashingCellDefinition | FormatColumn | PlusMinusNudge | StyledColumn | Shortcut;
 /**
  * Modules which can provide objects in Extended Layouts
  */
-export type LayoutExtensionModule = 'Alert' | 'CustomSort' | 'FlashingCell' | 'FormatColumn' | 'FreeTextColumn' | 'PlusMinus' | 'Export' | 'Shortcut' | 'StyledColumn';
+export type LayoutExtensionModule = 'Alert' | 'CustomSort' | 'FlashingCell' | 'FormatColumn' | 'PlusMinus' | 'Shortcut' | 'StyledColumn';
 /**
- * Configuration for API methods which load objects that can be Layout extensions
+ * Lists the Adaptable Objects (by Name) which are extended into a Layout
  */
-export interface LayoutExtendedConfig {
-    includeLayoutNotExtendedObjects?: boolean;
-    extendedLayoutName?: string;
+export interface LayoutExtension {
+    /**
+     * Name of the Layout being extended (Mandatory)
+     */
+    LayoutName: string;
+    /**
+     * Names of Alert Definitions which apply in this Layout
+     */
+    Alert?: string[];
+    /**
+     * Names of Custom Sorts which apply in this Layout
+     */
+    CustomSort?: string[];
+    /**
+     * Names of Flashing Cell Definitions which apply in this Layout
+     */
+    FlashingCell?: string[];
+    /**
+     * Names of Format Columns which apply in this Layout
+     */
+    FormatColumn?: string[];
+    /**
+     * Names of Plus Minus Nudges which apply in this Layout
+     */
+    PlusMinus?: string[];
+    /**
+     * Names of Shortcuts which apply in this Layout
+     */
+    Shortcut?: string[];
+    /**
+     * Names of Styled Columns which apply in this Layout
+     */
+    StyledColumn?: string[];
 }
+/**
+ * Names of the objects, per Module, which are extended into a single Layout
+ */
+export type LayoutExtensionInfo = Omit<LayoutExtension, 'LayoutName'>;

package/src/AdaptableState/Common/FormulaTraceInfo.d.ts

@@ -0,0 +1,54 @@
+/**
+ * Number of distinct colors available for formula-trace highlights.
+ * Colors cycle when an expression references more columns than this.
+ */
+export declare const FORMULA_TRACE_PALETTE_SIZE = 8;
+/**
+ * One column referenced by the calculated-column formula currently being traced.
+ */
+export interface FormulaTraceEntry {
+    /**
+     * Column Id referenced by a COL(...) node in the expression
+     */
+    columnId: string;
+    /**
+     * Index into the formula-trace palette (0 .. FORMULA_TRACE_PALETTE_SIZE - 1)
+     */
+    colorIndex: number;
+    /**
+     * Whether the column is currently visible in the grid / layout
+     */
+    isVisible: boolean;
+}
+/**
+ * Session state describing an active Excel-style formula trace for a calculated cell.
+ * Stored in Internal Redux (not persisted).
+ */
+export interface FormulaTraceInfo {
+    /**
+     * Column Id of the calculated column being inspected
+     */
+    calculatedColumnId: string;
+    /**
+     * Friendly name (or Column Id fallback) shown in the popup header
+     */
+    calculatedColumnFriendlyName: string;
+    /**
+     * Raw AdaptableQL expression text for the calculated column
+     */
+    expression: string;
+    /**
+     * Primary key of the row that was inspected (also used to anchor the popup).
+     * For aggregated expressions highlights are column-wide, but the PK is still
+     * kept so the popup can attach to the clicked cell.
+     */
+    primaryKeyValue: any;
+    /**
+     * True when the formula is an AggregatedExpression (whole-column highlight)
+     */
+    isAggregated: boolean;
+    /**
+     * Direct COL(...) references, ordered by first appearance in the expression
+     */
+    entries: FormulaTraceEntry[];
+}

package/src/AdaptableState/Common/FormulaTraceInfo.js

@@ -0,0 +1 @@
+export const FORMULA_TRACE_PALETTE_SIZE = 8;

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

@@ -16,11 +16,11 @@ export type AdaptableContextMenuItemName = (typeof ADAPTABLE_CONTEXT_MENU_ITEMS)
 /**
  * List of Shipped Adaptable Column Menu Items
  */
-export declare const ADAPTABLE_COLUMN_MENU_ITEMS: readonly ["calculated-column-edit", "cell-summary-show", "chart-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-group", "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", "select-column-group", "select-grid-group", "select-group", "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", "styled-column-bullet-chart-add", "styled-column-bullet-chart-edit", "styled-column-rating-add", "styled-column-rating-edit", "styled-column-range-bar-add", "styled-column-range-bar-edit", "styled-column-icon-add", "styled-column-icon-edit", "system-status-show", "_navbar", "separator"];
+export declare const ADAPTABLE_COLUMN_MENU_ITEMS: readonly ["calculated-column-group", "calculated-column-edit", "calculated-column-delete", "cell-summary-show", "chart-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-group", "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", "select-column-group", "select-grid-group", "select-group", "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", "styled-column-bullet-chart-add", "styled-column-bullet-chart-edit", "styled-column-rating-add", "styled-column-rating-edit", "styled-column-range-bar-add", "styled-column-range-bar-edit", "styled-column-icon-add", "styled-column-icon-edit", "system-status-show", "_navbar", "separator"];
 /**
  * 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-group", "column-filter-on-cell-value", "column-filter-clear", "column-filter-suspend", "column-filter-unsuspend", "column-info-show", "comment-add", "comment-remove", "comment-show", "dashboard-group", "dashboard-collapse", "dashboard-configure", "dashboard-dock", "dashboard-expand", "dashboard-float", "dashboard-hide", "dashboard-show", "data-import", "edit-group", "export-group", "export-all-data", "export-all-data-excel-download", "export-all-data-visualexcel-download", "export-all-data-csv", "export-all-data-csv-download", "export-all-data-csv-clipboard", "export-all-data-json", "export-all-data-json-download", "export-all-data-json-clipboard", "export-current-layout", "export-current-layout-excel-download", "export-current-layout-visualexcel-download", "export-current-layout-csv", "export-current-layout-csv-download", "export-current-layout-csv-clipboard", "export-current-layout-json", "export-current-layout-json-download", "export-current-layout-json-clipboard", "export-selected-data", "export-selected-data-excel-download", "export-selected-data-visualexcel-download", "export-selected-data-csv", "export-selected-data-csv-download", "export-selected-data-csv-clipboard", "export-selected-data-json", "export-selected-data-json-download", "export-selected-data-json-clipboard", "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", "note-show", "settings-panel-open", "smart-edit-apply", "system-status-show"];
+export declare const ADAPTABLE_CONTEXT_MENU_ITEMS: readonly ["menu-group", "alert-clear", "bulk-update-apply", "calculated-column-group", "calculated-column-edit", "calculated-column-delete", "calculated-column-show-formula", "cell-summary-show", "column-group", "column-filter-group", "column-filter-on-cell-value", "column-filter-clear", "column-filter-suspend", "column-filter-unsuspend", "column-info-show", "comment-add", "comment-remove", "comment-show", "dashboard-group", "dashboard-collapse", "dashboard-configure", "dashboard-dock", "dashboard-expand", "dashboard-float", "dashboard-hide", "dashboard-show", "data-import", "edit-group", "export-group", "export-all-data", "export-all-data-excel-download", "export-all-data-visualexcel-download", "export-all-data-csv", "export-all-data-csv-download", "export-all-data-csv-clipboard", "export-all-data-json", "export-all-data-json-download", "export-all-data-json-clipboard", "export-current-layout", "export-current-layout-excel-download", "export-current-layout-visualexcel-download", "export-current-layout-csv", "export-current-layout-csv-download", "export-current-layout-csv-clipboard", "export-current-layout-json", "export-current-layout-json-download", "export-current-layout-json-clipboard", "export-selected-data", "export-selected-data-excel-download", "export-selected-data-visualexcel-download", "export-selected-data-csv", "export-selected-data-csv-download", "export-selected-data-csv-clipboard", "export-selected-data-json", "export-selected-data-json-download", "export-selected-data-json-clipboard", "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", "note-show", "note-type", "note-type-info", "note-type-warning", "note-type-error", "note-type-success", "settings-panel-open", "smart-edit-apply", "system-status-show"];
 /**
  *  Menu item used by Adaptable in Context Menus
  */

package/src/AdaptableState/Common/Menu.js

@@ -1,5 +1,7 @@
 export const ADAPTABLE_COLUMN_MENU_ITEMS = [
+    'calculated-column-group',
     'calculated-column-edit',
+    'calculated-column-delete',
     'cell-summary-show',
     'chart-show',
     'column-group',
@@ -65,7 +67,10 @@ export const ADAPTABLE_CONTEXT_MENU_ITEMS = [
     'menu-group',
     'alert-clear',
     'bulk-update-apply',
+    'calculated-column-group',
     'calculated-column-edit',
+    'calculated-column-delete',
+    'calculated-column-show-formula',
     'cell-summary-show',
     'column-group',
     'column-filter-group',
@@ -129,6 +134,11 @@ export const ADAPTABLE_CONTEXT_MENU_ITEMS = [
     'note-add',
     'note-remove',
     'note-show',
+    'note-type',
+    'note-type-info',
+    'note-type-warning',
+    'note-type-error',
+    'note-type-success',
     'settings-panel-open',
     'smart-edit-apply',
     'system-status-show',

package/src/AdaptableState/Common/MenuItem.d.ts

@@ -4,7 +4,7 @@ import { AdaptableMenuItem, AdaptableContextMenuItemName, AdaptableColumnMenuIte
 import { AdaptableModule } from './Types';
 import { AdaptableIcon, AdaptableSystemIconName } from './AdaptableIcon';
 export declare class MenuItemDoReduxAction<MENU_TYPE_NAME extends AdaptableColumnMenuItemName | AdaptableContextMenuItemName = AdaptableColumnMenuItemName | AdaptableContextMenuItemName> implements AdaptableMenuItem<MENU_TYPE_NAME> {
-    constructor(name: MENU_TYPE_NAME, label: string, module: AdaptableModule, reduxAction: Redux.Action, icon: AdaptableSystemIconName, isVisible: boolean);
+    constructor(name: MENU_TYPE_NAME, label: string, module: AdaptableModule, reduxAction: Redux.Action, icon: AdaptableSystemIconName | AdaptableIcon, isVisible: boolean);
     name: MENU_TYPE_NAME;
     reduxAction: Redux.Action;
     label: string;
@@ -13,7 +13,7 @@ export declare class MenuItemDoReduxAction<MENU_TYPE_NAME extends AdaptableColum
     icon: AdaptableIcon;
 }
 export declare class MenuItemDoClickFunction<MENU_TYPE_NAME extends AdaptableColumnMenuItemName | AdaptableContextMenuItemName = AdaptableColumnMenuItemName | AdaptableContextMenuItemName> implements AdaptableMenuItem<MENU_TYPE_NAME> {
-    constructor(name: MENU_TYPE_NAME, label: string, module: AdaptableModule, clickFunction: () => void, icon: AdaptableSystemIconName, isVisible: boolean);
+    constructor(name: MENU_TYPE_NAME, label: string, module: AdaptableModule, clickFunction: () => void, icon: AdaptableSystemIconName | AdaptableIcon, isVisible: boolean);
     name: MENU_TYPE_NAME;
     onClick: () => void;
     label: string;
@@ -22,7 +22,7 @@ export declare class MenuItemDoClickFunction<MENU_TYPE_NAME extends AdaptableCol
     icon: AdaptableIcon;
 }
 export declare class MenuItemShowPopup<MENU_TYPE_NAME extends AdaptableColumnMenuItemName | AdaptableContextMenuItemName = AdaptableColumnMenuItemName | AdaptableContextMenuItemName> implements AdaptableMenuItem<MENU_TYPE_NAME> {
-    constructor(name: MENU_TYPE_NAME, label: string, module: AdaptableModule, componentName: string, icon: AdaptableSystemIconName, isVisible: boolean, popupParams?: ModuleParams);
+    constructor(name: MENU_TYPE_NAME, label: string, module: AdaptableModule, componentName: string, icon: AdaptableSystemIconName | AdaptableIcon, isVisible: boolean, popupParams?: ModuleParams);
     name: MENU_TYPE_NAME;
     reduxAction: Redux.Action;
     label: string;

package/src/AdaptableState/Common/MenuItem.js

@@ -5,9 +5,7 @@ export class MenuItemDoReduxAction {
         this.label = label;
         this.category = module;
         this.isVisible = isVisible;
-        this.icon = {
-            name: icon,
-        };
+        this.icon = typeof icon === 'string' ? { name: icon } : icon;
         this.reduxAction = reduxAction;
     }
     name;
@@ -23,9 +21,7 @@ export class MenuItemDoClickFunction {
         this.label = label;
         this.category = module;
         this.isVisible = isVisible;
-        this.icon = {
-            name: icon,
-        };
+        this.icon = typeof icon === 'string' ? { name: icon } : icon;
         this.onClick = clickFunction;
     }
     name;
@@ -41,9 +37,7 @@ export class MenuItemShowPopup {
         this.label = label;
         this.category = module;
         this.isVisible = isVisible;
-        this.icon = {
-            name: icon,
-        };
+        this.icon = typeof icon === 'string' ? { name: icon } : icon;
         this.reduxAction = PopupRedux.PopupShowScreen(module, componentName, popupParams);
     }
     name;

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

@@ -2,7 +2,7 @@ import { TypeHint } from './Types';
 import { SuspendableObject } from './SuspendableObject';
 export declare const ROW_SUMMARY_ROW_ID = "__ROW_SUMMARY_ROW_ID";
 export declare const WEIGHTED_AVERAGE_AGGREGATED_FUNCTION = "WEIGHTED_AVERAGE";
-export declare const summarySupportedExpressions: readonly ["MIN", "MAX", "SUM", "AVG", "COUNT", "MEDIAN", "MODE", "DISTINCT", "ONLY", "STD_DEVIATION", "WEIGHTED_AVERAGE"];
+export declare const summarySupportedExpressions: readonly ["MIN", "MAX", "SUM", "PRODUCT", "AVG", "COUNT", "MEDIAN", "MODE", "DISTINCT", "ONLY", "STD_DEVIATION", "WEIGHTED_AVERAGE"];
 export type SystemSummarySupportedExpression = (typeof summarySupportedExpressions)[number];
 export type SummarySupportedExpression = TypeHint<string, SystemSummarySupportedExpression>;
 /**

package/src/AdaptableState/Common/RowSummary.js

@@ -4,6 +4,7 @@ export const summarySupportedExpressions = [
     'MIN',
     'MAX',
     'SUM',
+    'PRODUCT',
     'AVG',
     'COUNT',
     'MEDIAN',

package/src/AdaptableState/Common/SpecialColumnSettings.d.ts

@@ -4,9 +4,16 @@ import { AdaptableColumnDataType } from './AdaptableColumn';
  */
 export interface SpecialColumnSettings {
     /**
-     *  Expression's return value DataType, only mandatory property
+     *  Expression's / column value DataType used by AdapTable (AQL, filters, etc.).
+     *  Only mandatory property.
      */
     DataType: AdaptableColumnDataType;
+    /**
+     * Optional AG Grid `cellDataType` when it differs from `DataType`
+     * (e.g. app-registered `currency` / `percentage` from `dataTypeDefinitions`).
+     * When unset, the ColDef uses `DataType`.
+     */
+    CellDataType?: string;
     /**
      * Preferred (pixel) Column Width; if unset, calculated dynamically by AG Grid
      */

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

@@ -6,7 +6,7 @@ export type AdaptableDashboardToolbars = AdaptableDashboardToolbar[];
 /**
  * List of all the Toolbars that Adaptable provides
  */
-export type AdaptableDashboardToolbar = 'Alert' | 'BulkUpdate' | 'CellSummary' | 'Charting' | 'DataChangeHistory' | 'DataSet' | 'Export' | 'ColumnFilter' | 'IPushPull' | 'Layout' | 'GridFilter' | 'OpenFin' | 'QuickSearch' | 'SmartEdit' | 'StateManagement' | 'SystemStatus' | 'Theme';
+export type AdaptableDashboardToolbar = 'Alert' | 'BulkUpdate' | 'CellSummary' | 'Charting' | 'DataChangeHistory' | 'DataSet' | 'Export' | 'ColumnFilter' | 'IPushPull' | 'Layout' | 'GridFilter' | 'Note' | 'OpenFin' | 'QuickSearch' | 'SmartEdit' | 'StateManagement' | 'SystemStatus' | 'Theme';
 export declare const ALL_TOOLBARS: AdaptableDashboardToolbar[];
 /**
  * Modules which can appear in the AdapTable Status Bar
@@ -17,7 +17,7 @@ export type AdaptableToolPanels = AdaptableToolPanel[];
 /**
  * Modules which can appear as AdapTable Tool Panels
  */
-export type AdaptableToolPanel = 'Alert' | 'BulkUpdate' | 'CellSummary' | 'Charting' | 'Dashboard' | 'DataChangeHistory' | 'Export' | 'ColumnFilter' | 'GridFilter' | 'IPushPull' | 'Layout' | 'OpenFin' | 'QuickSearch' | 'SmartEdit' | 'StateManagement' | 'SystemStatus' | 'Theme';
+export type AdaptableToolPanel = 'Alert' | 'BulkUpdate' | 'CellSummary' | 'Charting' | 'Dashboard' | 'DataChangeHistory' | 'Export' | 'ColumnFilter' | 'GridFilter' | 'IPushPull' | 'Layout' | 'Note' | 'OpenFin' | 'QuickSearch' | 'SmartEdit' | 'StateManagement' | 'SystemStatus' | 'Theme';
 export declare const ALL_TOOL_PANELS: AdaptableToolPanels;
 /**
  * Adaptable Module Button collection
@@ -34,12 +34,12 @@ export type AdaptableStateKey = keyof AdaptablePersistentState | 'OpenFin' | 'IP
 /**
  * Modules provided by AdapTable, subject to Entitlements and usually have Initial Adaptable State
  */
-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' | 'SettingsPanel' | 'Shortcut' | 'SmartEdit' | 'StyledColumn' | 'StateManagement' | 'StatusBar' | 'SystemStatus' | 'TeamSharing' | 'Theme' | 'ToolPanel' | 'Note' | 'DataImport' | 'GridFilter' | 'NamedQuery';
+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' | 'SettingsPanel' | 'Shortcut' | 'SmartEdit' | 'StyledColumn' | 'StateManagement' | 'StatusBar' | 'SystemStatus' | 'TeamSharing' | 'Theme' | 'ToolPanel' | 'Note' | 'DataImport' | 'GridFilter' | 'NamedQuery' | 'Expression';
 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' | 'Shortcut' | 'StateManagement' | 'StatusBar' | 'StyledColumn' | 'SystemStatus' | 'TeamSharing' | 'Theme' | 'ToolPanel' | 'Note' | 'DataImport' | 'GridFilter' | 'NamedQuery' | 'Comment';
+export type AdaptableSettingsPanel = 'Alert' | 'BulkUpdate' | 'CalculatedColumn' | 'CellSummary' | 'Charting' | 'SmartEdit' | 'CustomSort' | 'Dashboard' | 'DataChangeHistory' | 'DataSet' | 'Export' | 'ColumnFilter' | 'FlashingCell' | 'FormatColumn' | 'FreeTextColumn' | 'GridInfo' | 'ColumnInfo' | 'Layout' | 'PlusMinus' | 'QuickSearch' | 'Shortcut' | 'StateManagement' | 'StatusBar' | 'StyledColumn' | 'SystemStatus' | 'TeamSharing' | 'Theme' | 'ToolPanel' | 'Note' | 'DataImport' | 'GridFilter' | 'NamedQuery' | 'Comment';
 export type TypeHint<Base, Literals> = (Base & {
     __subType?: true;
 }) | Literals;
@@ -48,3 +48,38 @@ export type AdaptableQLModules = AdaptableQLModule[];
  * Modules which leverage AdapTableQL; can be used to set remote evaluation
  */
 export type AdaptableQLModule = 'Alert' | 'CalculatedColumn' | 'ColumnFilter' | 'GridFilter';
+/**
+ * Modules that host or evaluate **standard** (per-row) AdapTableQL expressions —
+ * Expression Editor, Query Builder, ColumnFilter operators, etc.
+ *
+ * Use this — not the full {@link AdaptableModule} union — when declaring
+ * `isAvailable` on standard expression functions so authors can only list
+ * modules where those expressions actually run.
+ *
+ * Aggregated expressions use {@link AdaptableAggregatedExpressionModule}.
+ * Distinct from {@link AdaptableQLModule}, which is the smaller set used for
+ * remote / external evaluation.
+ */
+export type AdaptableStandardExpressionModule = 'Alert' | 'CalculatedColumn' | 'ColumnFilter' | 'Export' | 'FlashingCell' | 'FormatColumn' | 'GridFilter' | 'NamedQuery' | 'PlusMinus' | 'StyledColumn';
+/** All {@link AdaptableStandardExpressionModule} values (stable order). */
+export declare const ADAPTABLE_STANDARD_EXPRESSION_MODULES: readonly AdaptableStandardExpressionModule[];
+/**
+ * Modules that host **aggregated** AdapTableQL expressions for custom
+ * `isAvailable` authoring: Alert Aggregated and Calculated Column Aggregated.
+ *
+ * Layout Row Summary and Cell Summary are intentionally omitted — they use
+ * fixed summary UIs (not the Expression Editor). System aggregations still
+ * evaluate there via internal availability policy; Cell Summary customs use
+ * {@link CustomCellSummaryOperation} instead.
+ */
+export type AdaptableAggregatedExpressionModule = 'Alert' | 'CalculatedColumn';
+/** All {@link AdaptableAggregatedExpressionModule} values (stable order). */
+export declare const ADAPTABLE_AGGREGATED_EXPRESSION_MODULES: readonly AdaptableAggregatedExpressionModule[];
+/**
+ * Modules that evaluate aggregated scalars in product code, including Layout
+ * Row Summary and Cell Summary. Wider than
+ * {@link AdaptableAggregatedExpressionModule} so system availability policy
+ * can keep built-in aggs on those hosts without offering them as custom
+ * `isAvailable` targets.
+ */
+export type AggregatedExpressionHostModule = AdaptableAggregatedExpressionModule | 'Layout' | 'CellSummary';

package/src/AdaptableState/Common/Types.js

@@ -11,6 +11,7 @@ export const ALL_TOOLBARS = [
     'Layout',
     'ColumnFilter',
     'GridFilter',
+    'Note',
     'OpenFin',
     'QuickSearch',
     'SmartEdit',
@@ -63,6 +64,7 @@ export const ALL_TOOL_PANELS = [
     'GridFilter',
     'IPushPull',
     'Layout',
+    'Note',
     'OpenFin',
     'QuickSearch',
     'SmartEdit',
@@ -107,3 +109,16 @@ export const ALL_MODULES = [
     ModuleConstants.ColumnFilterModuleId,
     ModuleConstants.NamedQueryModuleId,
 ];
+export const ADAPTABLE_STANDARD_EXPRESSION_MODULES = [
+    'Alert',
+    'CalculatedColumn',
+    'ColumnFilter',
+    'Export',
+    'FlashingCell',
+    'FormatColumn',
+    'GridFilter',
+    'NamedQuery',
+    'PlusMinus',
+    'StyledColumn',
+];
+export const ADAPTABLE_AGGREGATED_EXPRESSION_MODULES = ['Alert', 'CalculatedColumn'];

package/src/AdaptableState/DashboardState.d.ts

@@ -38,8 +38,12 @@ export interface DashboardState extends BaseState {
      */
     FloatingPosition?: AdaptableCoordinate;
     /**
-     * Buttons which open the Settings Panel screen for associated AdapTable Module
-     * @defaultValue ['SettingsPanel']
+     * Module shortcut buttons in the Dashboard header (actions zone).
+     *
+     * Opening the Settings Panel itself is handled by the fixed Home control (application icon or
+     * configuration icon) on the left of the Dashboard — do not include `'SettingsPanel'` here.
+     *
+     * @defaultValue `[]`
      */
     ModuleButtons?: AdaptableModuleButtons;
     /**

package/src/AdaptableState/ExportState.d.ts

@@ -3,7 +3,6 @@ import { Schedule } from './Common/Schedule';
 import { ColumnScope } from './Common/ColumnScope';
 import { AdaptableColumnBase } from './Common/AdaptableColumn';
 import { AdaptableObject } from './Common/AdaptableObject';
-import { AdaptableBooleanQuery } from './Common/AdaptableQuery';
 import { TypeHint } from './Common/Types';
 import { ExportDestinationType } from '../AdaptableOptions/ExportOptions';
 import { SuspendableObject } from './Common/SuspendableObject';
@@ -49,9 +48,9 @@ export interface Report extends AdaptableObject {
      */
     Scope?: ColumnScope;
     /**
-     * Query to use; only required if `ReportRowScope` is 'ExpressionRows'
+     * AdapTableQL boolean expression selecting the rows to export; only required if `ReportRowScope` is 'ExpressionRows'
      */
-    Query?: AdaptableBooleanQuery;
+    Expression?: string;
 }
 /**
  * A timed export for a report — when to run, format and destination

package/src/AdaptableState/FlashingCellState.d.ts

@@ -1,9 +1,6 @@
 import { BaseState } from './BaseState';
 import { AdaptableStyle } from './Common/AdaptableStyle';
-import { AdaptableColumnPredicate, ColumnScope } from '../types';
-import { XOR } from '../Utilities/Extensions/TypeExtensions';
-import { AdaptableBooleanQuery } from './Common/AdaptableQuery';
-import { TypeHint } from './Common/Types';
+import { ColumnScope } from '../types';
 import { AdaptableObject, SuspendableObject } from '../../types';
 /**
  * Adaptable State Section for Flashing Cell module
@@ -14,22 +11,16 @@ export interface FlashingCellState extends BaseState {
      */
     FlashingCellDefinitions?: FlashingCellDefinition[];
 }
-/**
- * Predicates available when using Flashing Cells
- */
-export interface FlashingCellDefinitionPredicate extends AdaptableColumnPredicate {
-    PredicateId: TypeHint<string, SystemFlashingCellPredicateId>;
-}
-/**
- * The Flashing Cell Rule - either an AdaptablePredicate or an AdaptableQuery
- */
-export type FlashingCellRule = XOR<{
-    Predicates: FlashingCellDefinitionPredicate[];
-}, AdaptableBooleanQuery>;
 /**
  * What should flash? row, cell or aggregated cell
  */
 export type FlashTargetTypes = 'row' | 'cell' | 'aggFuncCell';
+/**
+ * Flashing Cell rule flavour: Change (this edit vs previous value, including
+ * any / percent / absolute change and value comparisons) or Observable
+ * (live history over time — `CHANGE_COUNT`, `PREVIOUS`, …).
+ */
+export type FlashingCellType = 'Change' | 'Observable';
 /**
  * The Flashing Cell Definition
  */
@@ -38,14 +29,21 @@ export interface FlashingCellDefinition extends AdaptableObject, SuspendableObje
      * Name of the Flashing Cell Definition
      */
     Name: string;
+    /**
+     * Rule flavour — Change (default) or Observable.
+     * Existing definitions without a Type are stamped `Change` on upgrade.
+     */
+    Type?: FlashingCellType;
     /**
      * Which Columns, DataTypes or Column Types can Flash
      */
     Scope: ColumnScope;
     /**
-     * When Flashing Cell should be triggered
+     * AdapTableQL boolean expression deciding when the Flashing Cell is triggered
+     * (evaluated per data change for Change; against live history for Observable),
+     * e.g. `ANY_CHANGE([price])` or `CHANGE_COUNT{[price], WITHIN(5m)} > 3`
      */
-    Rule: FlashingCellRule;
+    Rule: string;
     /**
      * Should a cell or whole row flash
      * @defaultValue  'cell'
@@ -72,11 +70,3 @@ export interface FlashingCellDefinition extends AdaptableObject, SuspendableObje
      */
     FlashDuration?: number | 'always';
 }
-/**
- * Array containing all System Flashing Cell Predicates
- */
-export type SystemFlashingCellPredicateIds = SystemFlashingCellPredicateId[];
-/**
- * List of System Predicates available for Flashing Cells
- */
-export type SystemFlashingCellPredicateId = 'Blanks' | 'NonBlanks' | 'Equals' | 'NotEquals' | 'GreaterThan' | 'LessThan' | 'Positive' | 'Negative' | 'Zero' | 'Between' | 'NotBetween' | 'Is' | 'IsNot' | 'Contains' | 'NotContains' | 'StartsWith' | 'EndsWith' | 'Regex' | 'Today' | 'Yesterday' | 'Tomorrow' | 'ThisWeek' | 'ThisMonth' | 'ThisQuarter' | 'ThisYear' | 'InPast' | 'InFuture' | 'Before' | 'After' | 'On' | 'NotOn' | 'NextWorkDay' | 'LastWorkDay' | 'WorkDay' | 'Holiday' | 'True' | 'False' | 'PercentChange' | 'In' | 'NotIn' | 'AnyChange';

package/src/AdaptableState/FormatColumnState.d.ts

@@ -3,10 +3,6 @@ import { AdaptableStyle } from './Common/AdaptableStyle';
 import { DisplayFormat } from './Common/AdaptableFormatPresets';
 import { ColumnScope } from './Common/ColumnScope';
 import { RowScope } from './Common/RowScope';
-import { XOR } from '../Utilities/Extensions/TypeExtensions';
-import { TypeHint } from './Common/Types';
-import { AdaptableBooleanQuery, LayoutExtendedConfig } from '../types';
-import { AdaptableColumnPredicate } from './Common/AdaptablePredicate';
 import { SuspendableObject } from '../types';
 /**
  * Adaptable State Section for Format Column Module
@@ -36,9 +32,9 @@ export interface FormatColumn extends SuspendableObject {
      */
     Target?: FormatColumnTarget;
     /**
-     * Rule to decide whether to apply Format; if undefined Format is always applied
+     * AdapTableQL boolean expression (evaluated per row) deciding whether to apply the Format, e.g. `[price] > 100`; if undefined the Format is always applied
      */
-    Rule?: FormatColumnRule;
+    Rule?: string;
     /**
      * AdapTable Style to apply
      */
@@ -68,30 +64,10 @@ export type FormatColumnTarget = 'cell' | 'columnHeader';
  * Defines Column Group Scope
  */
 export type ColumnGroupScope = 'Expanded' | 'Collapsed' | 'Both';
-/**
- * The Format Column Rule - can be either a Predicate or a BooleanExpression
- */
-export type FormatColumnRule = XOR<{
-    Predicates: FormatColumnPredicate[];
-}, AdaptableBooleanQuery>;
-/**
- * Predicate used when creating a Format Column
- */
-export interface FormatColumnPredicate extends AdaptableColumnPredicate {
-    PredicateId: TypeHint<string, SystemFormatColumnPredicateId>;
-}
-/**
- * Array containing all System Format Column Predicates
- */
-export type SystemFormatColumnPredicateIds = SystemFormatColumnPredicateId[];
-/**
- * List of System Predicates available for Format Columns
- */
-export type SystemFormatColumnPredicateId = 'Blanks' | 'NonBlanks' | 'Equals' | 'NotEquals' | 'GreaterThan' | 'LessThan' | 'Positive' | 'Negative' | 'Zero' | 'Between' | 'NotBetween' | 'Is' | 'IsNot' | 'Contains' | 'NotContains' | 'StartsWith' | 'EndsWith' | 'Regex' | 'Today' | 'Yesterday' | 'Tomorrow' | 'ThisWeek' | 'ThisMonth' | 'ThisQuarter' | 'ThisYear' | 'InPast' | 'InFuture' | 'Before' | 'After' | 'On' | 'NotOn' | 'NextWorkDay' | 'LastWorkDay' | 'WorkDay' | 'Holiday' | 'True' | 'False' | 'In' | 'NotIn';
 /**
  * Config for api methods that get Format Columns
  */
-export interface FormatColumnConfig extends LayoutExtendedConfig {
+export interface FormatColumnConfig {
     includeSuspended?: boolean;
     includeReadOnly?: boolean;
     target?: FormatColumnTarget;