@adaptabletools/adaptable 11.3.0 → 12.0.0-canary.0

package/index.css

@@ -2290,6 +2290,9 @@ template {
   --ab-cmp-adaptable-object-compact-list-item__background: var(--ab-color-defaultbackground);
   --ab-cmp-adaptable-object-compact-list-item__padding: var(--ab-space-1);
   --ab-cmp-adaptable-object-compact-list-item__margin-bottom: var(--ab-space-2);
+  --ab-cmp-adaptable-object-compact-list__header__padding: var(--ab-space-2);
+  --ab-cmp-adaptable-object-compact-list__header__margin-bottom: var(--ab-space-1);
+  --ab-cmp-adaptable-object-compact-list__header__font-size: var(--ab-font-size-4);
   --ab-cmp-adaptable-object-compact-list-item-name__width: 80px;
   --ab-cmp-adaptable-object-compact-list-item-name__padding: var(--ab-space-1);
   --ab-cmp-adaptable-object-compact-list-item-name__margin-right: var(--ab-space-1);
@@ -2310,7 +2313,8 @@ template {
   --ab-cmp-adaptable-statusbar-sub-panel__padding: var(--ab-space-1) var(--ab-space-2);
   --ab-cmp-adaptable-statusbar-sub-panel-icon__background-color-hover: var(--ab-color-primary);
   --ab-cmp-adaptable-statusbar__color: var(--ab-color-text-on-primary);
-  --ab-cmp-adaptable-statusbar__font-weight: 400; }
+  --ab-cmp-adaptable-statusbar__font-weight: 400;
+  --ab-cmp-adaptable-statusbar__border: 1px solid var(--ab-color-primary); }
 
 .ab-Radio-input:focus + svg rect {
   stroke: var(--ab-color-accent);
@@ -3702,7 +3706,19 @@ html.ab--theme-dark .ab-ListBoxFilterForm--aggrid-style {
 
 .ab-Adaptable-Object-Compact-List {
   padding: var(--ab-cmp-adaptable-object-compact-list__padding);
-  background: var(--ab-cmp-adaptable-object-compact-list__background); }
+  background: var(--ab-cmp-adaptable-object-compact-list__background);
+  max-height: 70vh; }
+
+.ab-Adaptable-Object-Compact-List .ab-Adaptable-Object-Compact-List__Header {
+    padding: var(--ab-cmp-adaptable-object-compact-list__header__padding);
+    margin-bottom: var(--ab-cmp-adaptable-object-compact-list__header__margin-bottom); }
+
+.ab-Adaptable-Object-Compact-List .ab-Adaptable-Object-Compact-List__Title {
+    font-size: var(--ab-font-size-4); }
+
+.ab-Adaptable-Object-Compact-List .ab-Adaptable-Object-Compact-List__Body {
+    overflow: auto;
+    height: 100%; }
 
 .ab-Adaptable-Object-Compact-List .ab-Adaptable-Object-Compact-List__Item {
     padding: var(--ab-cmp-adaptable-object-compact-list-item__padding);
@@ -3719,13 +3735,19 @@ html.ab--theme-dark .ab-ListBoxFilterForm--aggrid-style {
     font-size: var(--ab-cmp-adaptable-object-compact-list-item-name__font-size); }
 
 .ab-StatusBar {
-  display: flex; }
+  display: flex;
+  border-right: var(--ab-cmp-adaptable-statusbar__border);
+  border-left: var(--ab-cmp-adaptable-statusbar__border); }
 
 .ab-StatusBar__SubPanel {
   padding: var(--ab-cmp-adaptable-statusbar-sub-panel__padding);
   border: 0;
   background: none;
-  font-weight: 400; }
+  font-weight: 400;
+  border-right: var(--ab-cmp-adaptable-statusbar__border); }
+
+.ab-StatusBar__SubPanel:last-child {
+    border-right: 0; }
 
 .ab-StatusBar__SubPanel,
   .ab-StatusBar__SubPanel .ab-SimpleButton {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adaptabletools/adaptable",
-  "version": "11.3.0",
+  "version": "12.0.0-canary.0",
   "description": "Powerful data-agnostic HTML5 datagrid add-on that sits on top of an underlying grid component and provides all the rich functionality that advanced users expect from their DataGrids and Data Tables",
   "keywords": [
     "web-components",

package/publishTimestamp.d.ts

@@ -1,2 +1,2 @@
-declare const _default: 1653559619721;
+declare const _default: 1654532122066;
 export default _default;

package/publishTimestamp.js

@@ -1,3 +1,3 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.default = 1653559619721;
+exports.default = 1654532122066;

package/src/AdaptableInterfaces/IAdaptable.d.ts

@@ -49,6 +49,10 @@ export interface IAdaptable {
      * Avoid unnecessary store calls and rendering
      */
     isInitialised: boolean;
+    /**
+     * TRUE if the Adaptable custom tool panel (side-bar) is displayed
+     */
+    hasAdaptableToolPanel: boolean;
     /**
      * Set to true when adaptable is destroyed.
      */
@@ -141,7 +145,6 @@ export interface IAdaptable {
     autoSizeAllColumns(): void;
     updateColumnsIntoStore(): void;
     setColumnOrder(visibleColumnList: string[]): void;
-    getUserDefinedHeaderName(columnId: string): string;
     getPrimaryKeyValueFromRowNode(rowNode: RowNode): any;
     getColumnValueDisplayValuePairList(columnId: string, visibleRowsOnly: boolean, onlyIncludeIds?: {
         [key: string]: boolean;

package/src/AdaptableOptions/ActionOptions.d.ts

@@ -0,0 +1 @@
+export {};

package/src/AdaptableOptions/AdaptableFrameworkComponent.d.ts

@@ -29,3 +29,8 @@ export declare type AngularFrameworkComponent<T = unknown> = {
 export declare type ReactFrameworkComponent = ({ adaptableApi, }: {
     adaptableApi: AdaptableApi;
 }) => ReactElement;
+export interface CustomRenderContext {
+    visible: boolean;
+    element: HTMLDivElement;
+    adaptableApi: AdaptableApi;
+}

package/src/AdaptableOptions/AdaptableOptions.d.ts

@@ -9,7 +9,6 @@ import { AdaptablePlugin } from './AdaptablePlugin';
 import { SearchOptions } from './SearchOptions';
 import { ExportOptions } from './ExportOptions';
 import { TeamSharingOptions } from './TeamSharingOptions';
-import { AdaptablePredicateDef } from '../PredefinedConfig/Common/AdaptablePredicate';
 import { MenuOptions } from './MenuOptions';
 import { EntitlementOptions } from './EntitlementOptions';
 import { NotificationsOptions } from './NotificationsOptions';
@@ -22,7 +21,7 @@ import { GridOptions, Module } from '@ag-grid-community/all-modules';
 import { FlashingCellOptions } from './FlashingCellOptions';
 import { AlertOptions } from './AlertOptions';
 import { AdaptableQLOptions } from './AdaptableQLOptions';
-import { FormatColumnOptions } from './FormatColumnOptions';
+import { ColumnOptions } from './ColumnOptions';
 /**
  * Group of property options enabling developers to set up AdapTable at design time to fit precise requirements - provides AG Grid, Predefined Config and other information required to ensure a full, rich user experience
  */
@@ -97,9 +96,9 @@ export interface AdaptableOptions {
      */
     containerOptions?: ContainerOptions;
     /**
-     * Predicate definitions provided by developers at Design-Time
+     * Options for managing Columns
      */
-    customPredicateDefs?: AdaptablePredicateDef[];
+    columnOptions?: ColumnOptions;
     /**
      * Options related to managing the Dashboard in AdapTable
      *
@@ -142,12 +141,6 @@ export interface AdaptableOptions {
      * @gridInfoContainer
      */
     flashingCellOptions?: FlashingCellOptions;
-    /**
-     * Options for managing format columns
-     *
-     * @gridInfoContainer
-     */
-    formatColumnOptions?: FormatColumnOptions;
     /**
      * General options to manage AdapTable e.g. grouping behaviour, Primary Keys
      *

package/src/AdaptableOptions/AdaptableQLOptions.d.ts

@@ -1,4 +1,5 @@
 import { ExpressionFunctionMap } from '../parser/src/types';
+import { AdaptablePredicateDef } from '../PredefinedConfig/Common/AdaptablePredicate';
 import { AdaptableModule, AdaptableQLModules } from '../PredefinedConfig/Common/Types';
 /**
  * Options for managing AdaptableQL - the Adaptable Query Lanaguage which evaluates Predicates and Expressions
@@ -23,6 +24,10 @@ export interface AdaptableQLOptions {
      *
      */
     expressionOptions?: ExpressionOptions;
+    /**
+     * Definitions for Custom provided Predicates
+     */
+    customPredicateDefs?: AdaptablePredicateDef[];
 }
 /**
  * Options for managing Expressions using AdapTableQL

package/src/AdaptableOptions/AlertOptions.d.ts

@@ -52,7 +52,7 @@ export interface AlertOptions {
     /**
      * Function providing Message to display in Alert; if empty, AdapTable provides dynamically
      */
-    alertMessageText?: (alertDefinition: AlertDefinition, cellDataChangedInfo?: CellDataChangedInfo) => string | undefined;
+    alertMessageText?: (alertMessageContext: AlertMessageContext) => string | undefined;
 }
 /**
  * Handles a Form Button Action
@@ -93,3 +93,16 @@ export interface AlertButtonContext extends BaseContext {
      */
     formData?: AdaptableFormData;
 }
+/**
+ * Context used for creating bespoke Alert messages
+ */
+export interface AlertMessageContext {
+    /**
+     * Current Alert Definition
+     */
+    alertDefinition: AlertDefinition;
+    /**
+     * Data change that might have triggered the Alert
+     */
+    cellDataChangedInfo?: CellDataChangedInfo;
+}

package/src/AdaptableOptions/ColumnOptions.d.ts

@@ -0,0 +1,49 @@
+import { Column } from '@ag-grid-community/all-modules';
+/**
+ * Options related to managing Columns in Adaptable.
+ */
+export interface ColumnOptions {
+    /**
+     * Provide an alternative Friendly Name for a Column
+     */
+    columnFriendlyName?: (columnFriendlyNameContext: ColumnFriendlyNameContext) => string | undefined;
+    /**
+     * Optional list of Column Types - used primarily for Special Columns
+     */
+    columnTypes?: string[];
+    /**
+     * Show warning if AdapTable cannot find a column
+     *
+     * @defaultValue true
+     * @gridInfoItem
+     */
+    showMissingColumnsWarning?: boolean;
+    /**
+     * Order Grouped Column automatically, deriving from Adaptable State if available (CustomSort or Layout ColumnSort)
+     *
+     * The default group order will be derived from (in the specified priority): 1. an active CustomSort,  2. the defined ColDef Comparator, 3. current Layout ColumnSort or 4. alphanumerically
+     * @defaultValue true
+     * @gridInfoItem
+     */
+    autoOrderGroupedColumns?: boolean;
+    /**
+     * Automatically removes a column from the grid when it becomes Row Grouped
+     *
+     * @defaultValue false
+     * @gridInfoItem
+     */
+    hideColumnWhenGrouped?: boolean;
+}
+/**
+ * Context used when setting a Column Friendly Name
+ */
+export interface ColumnFriendlyNameContext {
+    /**
+     * Id of the Column
+     */
+    colId: string;
+    /**
+     * AG Grid ColDef for the Column
+     */
+    agColumn: Column;
+}

package/src/AdaptableOptions/DashboardOptions.d.ts

@@ -1,8 +1,7 @@
-import { AdaptableApi } from '../Api/AdaptableApi';
 import { AdaptableButton } from '../PredefinedConfig/Common/AdaptableButton';
 import { AdaptableObject } from '../PredefinedConfig/Common/AdaptableObject';
 import { DashboardState } from '../PredefinedConfig/DashboardState';
-import { BaseContext } from '../types';
+import { BaseContext, CustomRenderContext } from '../types';
 import { AdaptableFrameworkComponent } from './AdaptableFrameworkComponent';
 /**
  * Options related to the Dashboard in Adaptable.
@@ -63,11 +62,7 @@ export interface CustomToolbar extends AdaptableObject {
     /**
      * Function to provide custom content when NOT using a Framework wrapper
      */
-    render?: ({ visible, node, adaptableApi, }: {
-        visible: boolean;
-        node: HTMLDivElement;
-        adaptableApi: AdaptableApi;
-    }) => string | null;
+    render?: (customRenderContext: CustomRenderContext) => string | null;
     /**
      * The Framework-specific (Angular or React) component to be rendered
      */

package/src/AdaptableOptions/DataChangeHistoryOptions.d.ts

@@ -1,4 +1,19 @@
 import { CellDataChangedInfo } from '../PredefinedConfig/Common/CellDataChangedInfo';
+import { ActionColumnButtonContext, AdaptableButton } from '../types';
+export declare type AdaptableDataChangeHistoryAction = 'undo';
+export interface DataChangeHistoryContext extends ActionColumnButtonContext {
+    /**
+     * Helper function to undo the change.
+     */
+    undoDataChange: () => void;
+    /**
+     * If the change references a group node.
+     */
+    isGroupNode: boolean;
+}
+export interface DataChangeHistoryButton extends AdaptableButton<DataChangeHistoryContext> {
+    Action?: AdaptableDataChangeHistoryAction;
+}
 /**
  * Options to manage the 'Data Change History Module', which provides an overview of all previous changes, giving the possibility to undo specific changes
  */
@@ -17,4 +32,8 @@ export interface DataChangeHistoryOptions {
      * @gridInfoItem
      */
     showDataChange?: (cellDataChangedInfo: CellDataChangedInfo) => boolean;
+    /**
+     * Action button definition. Can be used to implement undo functionality.
+     */
+    actionColumnButton?: DataChangeHistoryButton | DataChangeHistoryButton[];
 }

package/src/AdaptableOptions/EditOptions.d.ts

@@ -53,11 +53,11 @@ export declare type SmartEditCustomOperation = {
     /**
      * Name of the Custom Operation (as appears in AdapTable UI)
      */
-    Name: string;
+    name: string;
     /**
      * Custom Operation function - returns a number
      */
-    Operation: (context: SmartEditOperationContext) => number;
+    operation: (context: SmartEditOperationContext) => number;
 };
 export declare type SmartEditOperation = SmartEditCustomOperation | MathOperation;
 /**

package/src/AdaptableOptions/EntitlementOptions.d.ts

@@ -9,7 +9,7 @@ export interface EntitlementOptions {
      *
      * @gridInfoItem
      */
-    moduleEntitlements?: Entitlement[] | ((adaptableModule: AdaptableModule, userName: string, adaptableId: string, defaultAccessLevel: AccessLevel) => AccessLevel | undefined);
+    moduleEntitlements?: Entitlement[] | ((entitlementContext: EntitlementContext) => AccessLevel | undefined);
     /**
      * AccessLevel to use when an Entitlement is not explicitly set; can be hardcoded value or a function to invoke
      *
@@ -18,3 +18,9 @@ export interface EntitlementOptions {
      */
     defaultAccessLevel?: AccessLevel | ((userName: string, adaptableId: string) => AccessLevel);
 }
+export interface EntitlementContext {
+    adaptableModule: AdaptableModule;
+    userName: string;
+    adaptableId: string;
+    defaultAccessLevel: AccessLevel;
+}

package/src/AdaptableOptions/ExportOptions.d.ts

@@ -81,7 +81,7 @@ export interface CustomDestination {
     /**
      * Function invoked when export is applied (used if no form is supplied)
      */
-    onExport?: (report: Report, reportData: ReportData) => void;
+    onExport?: (reportContext: ReportContext) => void;
 }
 /**
  * Context required by functions when using an Export Button
@@ -106,3 +106,7 @@ export interface ExportButtonContext extends BaseContext {
 }
 export declare type SystemExportDestinations = SystemExportDestination[];
 export declare type SystemExportDestination = 'Excel' | 'CSV' | 'Clipboard' | 'JSON';
+export interface ReportContext extends BaseContext {
+    report: Report;
+    reportData: ReportData;
+}

package/src/AdaptableOptions/FilterOptions.d.ts

@@ -1,6 +1,6 @@
 import { AdaptableColumn } from '../PredefinedConfig/Common/AdaptableColumn';
 import { FilterActionOnDataChange } from '../PredefinedConfig/Common/FilterActionOnDataChange';
-import { SystemFilterPredicateId, SystemFilterPredicateIds } from '../PredefinedConfig/FilterState';
+import { SystemFilterPredicateId, SystemFilterPredicateIds } from '../../types';
 import { StrictExtract } from '../Utilities/Extensions/TypeExtensions';
 /**
  * Options for managing Filtering in AdapTable
@@ -145,4 +145,9 @@ export interface FilterOptions {
      * Which Adaptable System Filter Predicates are available
      */
     systemFilters?: SystemFilterPredicateIds;
+    /**
+     * Whether to display Quick Filter Bar between Column Header and the Grid (provided its been setup)
+     * @defaultValue  true
+     */
+    showQuickFilter?: boolean;
 }

package/src/AdaptableOptions/GeneralOptions.d.ts

@@ -1,4 +1,4 @@
-import { AdaptableScope } from '../../types';
+import { AdaptableForm, AdaptableObject, AdaptableScope, BaseContext } from '../../types';
 import { AdaptableComparerFunction } from '../PredefinedConfig/Common/AdaptableComparerFunction';
 import { AlternativeModuleName } from '../PredefinedConfig/Common/AlternativeModuleName';
 import { CellSummaryOperation } from '../PredefinedConfig/Common/CellSummary';
@@ -20,13 +20,6 @@ export interface GeneralOptions {
      * @deprecated starting with Adaptable v10
      */
     hideEmptyGroupRows?: boolean;
-    /**
-     * Show warning if AdapTable cannot find a column
-     *
-     * @defaultValue true
-     * @gridInfoItem
-     */
-    showMissingColumnsWarning?: boolean;
     /**
      * Show aggregated totals row at top of Grid when row grouping
      *
@@ -34,21 +27,6 @@ export interface GeneralOptions {
      * @gridInfoItem
      */
     showGroupingTotalsAsHeader?: boolean;
-    /**
-     * Order Grouped Column automatically, deriving from Adaptable State if available (CustomSort or Layout ColumnSort)
-     *
-     * The default group order will be derived from (in the specified priority): 1. an active CustomSort,  2. the defined ColDef Comparator, 3. current Layout ColumnSort or 4. alphanumerically
-     * @defaultValue true
-     * @gridInfoItem
-     */
-    autoOrderGroupedColumns?: boolean;
-    /**
-     * Automatically removes a column from the grid when it becomes Row Grouped
-     *
-     * @defaultValue false
-     * @gridInfoItem
-     */
-    hideColumnWhenGrouped?: boolean;
     /**
      * Alternative names to use for Adaptable Modules in toolbars and menus
      *
@@ -77,6 +55,10 @@ export interface GeneralOptions {
      * CustomSort column comparer functions
      */
     customSortComparers?: ColumnValuesComparer[];
+    /**
+     * Collection of Data Sets to provide Data to AdapTable
+     */
+    dataSets?: DataSet[];
 }
 /**
  * Comparer object for Column Values - used for custom sorting
@@ -91,3 +73,20 @@ export interface ColumnValuesComparer {
      */
     comparer: AdaptableComparerFunction;
 }
+/**
+ * Defines a Data Set object that can provide data to AdapTable
+ */
+export interface DataSet extends AdaptableObject {
+    /**
+     * Name of Data Set
+     */
+    name: string;
+    /**
+     * Describes the Data Set
+     */
+    description: string;
+    /**
+     * Params for Data Set popup form
+     */
+    form?: AdaptableForm<BaseContext>;
+}

package/src/AdaptableOptions/{MasterDetailAgGridPluginOptions.d.ts → MasterDetailPluginOptions.d.ts}

@@ -1,10 +1,8 @@
 import { AdaptableOptions, AdaptableApi } from '../types';
 /**
- * Plugin Options used when creating a Master / Detail grid
- *
- * Passed into the plugin as the only argument.
+ * Plugin Options used when creating a Master / Detail grid - passed into the plugin as the only argument.
  */
-export interface MasterDetailAgGridPluginOptions {
+export interface MasterDetailPluginOptions {
     /**
      * `AdaptableOptions` object to use for child Data Grids; **all** will share the same behaviour and State
      */

package/src/AdaptableOptions/SettingsPanelOptions.d.ts

@@ -1,5 +1,6 @@
-import { AdaptableApi, AdaptableFrameworkComponent, AdaptableIcon } from '../../types';
+import { AdaptableFrameworkComponent, AdaptableIcon } from '../../types';
 import { AdaptableSettingsPanel } from '../PredefinedConfig/Common/Types';
+import { CustomRenderContext } from './AdaptableFrameworkComponent';
 export interface SettingsPanelOptions {
     /**
      * Title for the Settings Panel
@@ -76,11 +77,7 @@ export interface CustomSettingsPanel {
     /**
      * Function to provide bespoke content when NOT using a Framework wrapper
      */
-    render?: ({ visible, node, adaptableApi, }: {
-        visible: boolean;
-        node: HTMLDivElement;
-        adaptableApi: AdaptableApi;
-    }) => string | null;
+    render?: (customRenderContext: CustomRenderContext) => string | null;
     /**
      * Framework-specific (Angular or React) component to be rendered
      */

package/src/AdaptableOptions/ToolPanelOptions.d.ts

@@ -1,55 +1,12 @@
 import { AdaptableObject } from '../PredefinedConfig/Common/AdaptableObject';
-import { AdaptableApi } from '../Api/AdaptableApi';
 import { AdaptableFrameworkComponent } from './AdaptableFrameworkComponent';
 import { AdaptableButton } from '../PredefinedConfig/Common/AdaptableButton';
 import { ToolPanelState } from '../PredefinedConfig/ToolPanelState';
-import { BaseContext } from '../types';
+import { BaseContext, CustomRenderContext } from '../types';
 /**
  * Options related to managing the AdapTable ToolPanel Component
  */
 export interface ToolPanelOptions {
-    /**
-     * Displays Adaptable ToolPanel Component (only if AG Grid Sidebar is provided)
-     *
-     * @defaultValue true
-     * @gridInfoItem
-     */
-    showAdaptableToolPanel?: boolean;
-    /**
-     * Title for AdapTable ToolPanel Component - appears vertically at side
-     *
-     * @defaultValue 'AdapTable'
-     * @gridInfoItem
-     */
-    adaptableToolPanelTitle?: string;
-    /**
-     * Key of icon to be used (beside the label) for Adaptable ToolPanel Component
-     *
-     * @defaultValue 'menu'
-     * @gridInfoItem
-     */
-    iconKey?: string;
-    /**
-     * The initial width of AdapTable ToolPanel
-     * @defaultValue var(--ab-cmp-toolpanel__width)
-     */
-    width?: number;
-    /**
-     * The min width of AdapTable ToolPanel
-     * @defaultValue var(--ab-cmp-toolpanel__width)
-     */
-    minWidth?: number;
-    /**
-     * The max width of AdapTable ToolPanel
-     * @defaultValue undefined
-     */
-    maxWidth?: number;
-    /**
-     * Order of displayed ToolPanels in Sidebar
-     *
-     * @defaultValue ['filters', 'columns', 'adaptable']
-     */
-    toolPanelOrder?: ('adaptable' | 'columns' | 'filters')[];
     /**
      * Display the Tool Panels dropdown
      *
@@ -85,11 +42,7 @@ export interface CustomToolPanel extends AdaptableObject {
     /**
      * Function to provide bespoke content when NOT using a Framework wrapper
      */
-    render?: ({ visible, node, adaptableApi, }: {
-        visible: boolean;
-        node: HTMLDivElement;
-        adaptableApi: AdaptableApi;
-    }) => string | null;
+    render?: (customRenderContext: CustomRenderContext) => string | null;
     /**
      * Framework-specific (Angular or React) component to be rendered
      */