@adaptabletools/adaptable 10.0.4-canary.2 → 11.0.0-canary.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adaptabletools/adaptable",
-  "version": "10.0.4-canary.2",
+  "version": "11.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",
   "main": "index.js",
   "typings": "index.d.ts",
@@ -12,13 +12,14 @@
     "lodash-es": "^4.17.15",
     "normalize.css": "^8.0.1",
     "prop-types": "^15.6.2",
+    "re-resizable": "^6.9.1",
     "react": ">=16.8.0",
     "react-beautiful-dnd": "13.1.0",
-    "react-day-picker": "8.0.0-beta.29",
+    "react-day-picker": "8.0.0-beta.37",
     "react-dom": ">=16.8.0",
     "react-redux": "7.2.4",
     "react-remove-scroll": "2.4.2",
-    "react-toastify": "^7.0.4",
+    "react-toastify": "8.1.0",
     "rebass": "^3.2.2",
     "redux": "4.0.5",
     "rxjs": "6.6.7",
@@ -29,7 +30,7 @@
     "uuid": "^3.3.2"
   },
   "peerDependencies": {
-    "@ag-grid-community/all-modules": ">=26.0.0"
+    "@ag-grid-community/all-modules": ">=26.2.0"
   },
   "keywords": [
     "web-components",

package/publishTimestamp.d.ts

@@ -1,2 +1,2 @@
-declare const _default: 1641596554967;
+declare const _default: 1643291530490;
 export default _default;

package/publishTimestamp.js

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

package/src/AdaptableInterfaces/IAdaptable.d.ts

@@ -37,7 +37,7 @@ export interface IAdaptable {
     api: AdaptableApi;
     adaptableOptions: AdaptableOptions;
     adaptableStore: IAdaptableStore;
-    modules: IModuleCollection;
+    adaptableModules: IModuleCollection;
     /**
      * If using AG Grid community (which has no menu)
      */
@@ -121,11 +121,15 @@ export interface IAdaptable {
     getGridData(): any[];
     getFilteredData(): any[];
     loadDataSource(dataSource: any): void;
-    updateRows(dataRows: any[], dataUpdateConfig?: DataUpdateConfig): void;
-    addRows(dataRows: any[], dataUpdateConfig?: DataUpdateConfig): void;
-    deleteRows(dataRows: any[], dataUpdateConfig?: DataUpdateConfig): void;
-    selectColumn(columnId: string): void;
-    selectColumns(columnIds: string[]): void;
+    updateRows(dataRows: any[], dataUpdateConfig?: DataUpdateConfig): Promise<RowNode[]>;
+    addRows(dataRows: any[], dataUpdateConfig?: DataUpdateConfig): Promise<RowNode[]>;
+    deleteRows(dataRows: any[], dataUpdateConfig?: DataUpdateConfig): Promise<RowNode[]>;
+    selectColumn(columnId: string, config?: {
+        keepExistingSelection?: boolean;
+    }): void;
+    selectColumns(columnIds: string[], config?: {
+        keepExistingSelection?: boolean;
+    }): void;
     selectAll(): void;
     deselectAll(): void;
     hideColumn(columnId: string): void;
@@ -185,6 +189,8 @@ export interface IAdaptable {
     canExportToExcel(): boolean;
     exportToExcel(reportData: ReportData, fileName: string): void;
     exportVisualDataToExcel(): void;
+    canGenerateCharts(): boolean;
+    canHaveSparklines(): boolean;
     getCurrentIPPStyle(): IPPStyle;
     getDefaultIPPStyle(): IPPStyle;
     getRowCount(): number;

package/src/AdaptableOptions/AdaptableOptions.d.ts

@@ -18,6 +18,9 @@ import { ToolPanelOptions } from './ToolPanelOptions';
 import { FilterOptions } from './FilterOptions';
 import { QueryLanguageOptions } from './QueryLanguageOptions';
 import { DataChangeHistoryOptions } from './DataChangeHistoryOptions';
+import { SettingsPanelOptions } from './SettingsPanelOptions';
+import { GridOptions, Module } from '@ag-grid-community/all-modules';
+import { FlashingCellOptions } from './FlashingCellOptions';
 /**
  * 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
  */
@@ -69,11 +72,12 @@ export interface AdaptableOptions {
      */
     userName?: string;
     /**
-     * The AG Grid object which AdapTable interacts with.  Note: if using React or Angular Wrapper, no need to populate this property (as `gridOptions` is a separate prop and AdapTable wires up everything)
+     * The AG Grid object which AdapTable interacts with.  Note: if using React or Angular Wrapper, no need to populate this property as AdapTable wires it up differently
      *
      * @defaultValue n/a (Mandatory)
      */
-    vendorGrid?: any;
+    gridOptions?: GridOptions;
+    modules?: Module[];
     /**
      * Options for managing Notifications in AdapTable
      *
@@ -81,7 +85,7 @@ export interface AdaptableOptions {
      */
     notificationsOptions?: NotificationsOptions;
     /**
-     * Options for setting the 'Div' elements in which AdapTable, AG Grid, popups and charts are placed
+     * Options for setting the 'Div' elements in which AdapTable, AG Grid, popups are placed
      */
     containerOptions?: ContainerOptions;
     /**
@@ -108,6 +112,12 @@ export interface AdaptableOptions {
      * @gridInfoContainer
      */
     exportOptions?: ExportOptions;
+    /**
+     * Options for managing Flashing Cells - primarily default values
+     *
+     * @gridInfoContainer
+     */
+    flashingCellOptions?: FlashingCellOptions;
     /**
      * General options to manage AdapTable e.g. grouping behaviour, Primary Keys
      *
@@ -180,4 +190,10 @@ export interface AdaptableOptions {
      * Predicate definitions provided by developers at Design-Time
      */
     customPredicateDefs?: AdaptablePredicateDef[];
+    /**
+     * Setting panel options
+     *
+     * @gridInfoContainer
+     */
+    settingsPanelOptions?: SettingsPanelOptions;
 }

package/src/AdaptableOptions/ContainerOptions.d.ts

@@ -30,13 +30,6 @@ export interface ContainerOptions {
      * @gridInfoItem
      */
     modalContainer?: string;
-    /**
-     * Name of div where charts appear (if null, will be centre of page)
-     *
-     * @defaultValue undefined
-     * @gridInfoItem
-     */
-    chartContainer?: string;
     /**
      * Div to show System Status messages - string Id or HTMLElement
      *

package/src/AdaptableOptions/DashboardOptions.d.ts

@@ -14,13 +14,6 @@ export interface DashboardOptions {
      * @gridInfoItem
      */
     canFloat?: boolean;
-    /**
-     * Shows Modules dropdown in Dashboard Header (the 'home' icon); each item connects to an AdapTable Module, opening its popup screen
-     *
-     * @defaultValue true
-     * @gridInfoItem
-     */
-    showModulesDropdown?: boolean;
     /**
      * Shows Quick Search textbox in the Dashboard Header; the UI component is still subject to the QuickSearch Entitlements
      *
@@ -36,6 +29,10 @@ export interface DashboardOptions {
      * Toolbars provided by Users which contain custom content
      */
     customToolbars?: CustomToolbar[];
+    /**
+     * @defaultValue 'right'
+     */
+    buttonsLocation?: 'left' | 'right';
 }
 /**
  * Custom Toolbar (which AdapTable will manage) enabling devs to populate Dashboard with bepoke content

package/src/AdaptableOptions/DataChangeHistoryOptions.d.ts

@@ -4,14 +4,14 @@ import { DataChangedInfo } from '../PredefinedConfig/Common/DataChangedInfo';
  */
 export interface DataChangeHistoryOptions {
     /**
-     * Whether data change history should be active by default; it may be changed at runtime via the UI controls
+     * Whether data change history should be active by default
      *
      * @defaultValue false
      * @gridInfoItem
      */
     activeByDefault?: boolean;
     /**
-     * Function enabling specific data changes to be included/excluded from the Data Change History
+     * Function specifying which data changes to include in Data Change History
      *
      * @defaultValue undefined (all data changes are logged)
      * @gridInfoItem

package/src/AdaptableOptions/EditOptions.d.ts

@@ -11,7 +11,7 @@ export interface EditOptions {
      */
     validateOnServer?: (dataChangedInfo: DataChangedInfo) => Promise<ValidationResult>;
     /**
-     * Displays message after Server Validation; if true, Info Message appears with ValidationMessage sent by ServerValidation; if there is no Validation Message then no popup is displayed
+     * Displays message after Server Validation
      *
      * @defaultValue true
      * @gridInfoItem
@@ -31,7 +31,7 @@ export interface ValidationResult {
      */
     ValidationMessage?: string;
     /**
-     * Value to use for edit (instead one provided by user); can be previous (i.e. unchanged) value or a new value, or left empty to accept the edit
+     * Cell Value to use for after Server Validation
      */
     NewValue?: any;
 }

package/src/AdaptableOptions/ExportOptions.d.ts

@@ -45,7 +45,7 @@ export interface ExportOptions {
      */
     systemExportDestinations?: SystemExportDestinations;
     /**
-     * Whether to add a timestamp ('yyyyMMdd_HHmmss') as a suffix to exported file name
+     * Whether to add a timestamp as a suffix to exported file name
      *
      * @defaultValue false
      * @gridInfoItem

package/src/AdaptableOptions/FilterOptions.d.ts

@@ -32,7 +32,7 @@ export interface FilterOptions {
      */
     indicateFilteredColumns?: boolean;
     /**
-     * Uses Adaptable's Filter Form in Column header menu for all columns if 'true' (the default) or those listed, in preference to AG Grid's Filter Form
+     * Uses Adaptable's Filter Form in Column Menu for all columns if 'true' (the default) or those listed, in preference to AG Grid's Filter Form
      *
      * @defaultValue true
      */
@@ -45,7 +45,7 @@ export interface FilterOptions {
      */
     useAgGridFilterFormStyle?: boolean;
     /**
-     * Use Adaptable's Quick Filter for all columns if 'true' (the default) or those listed, in preference to AG Grid's Floating Filter
+     * Use Adaptable's Quick Filter Bar for all columns if 'true' (the default) or those listed, in preference to AG Grid's Floating Filter
      *
      * @defaultValue true
      * @gridInfoItem

package/src/AdaptableOptions/FinancePluginOptions.d.ts

@@ -28,7 +28,7 @@ export interface FinancePluginOptions {
  */
 export interface InstrumentColumn {
     /**
-     * Column to be defined as an Instrument - its value will provide the `name` property in the FDC3 message
+     * Column defined as an Instrument - its value provides the `name` property in the FDC3 message
      */
     columnId: string;
     /**

package/src/AdaptableOptions/FlashingCellOptions.d.ts

@@ -0,0 +1,31 @@
+import { AdaptableStyle } from '../PredefinedConfig/Common/AdaptableStyle';
+/**
+ * Properties for Flashing Cell
+ */
+export interface FlashingCellOptions {
+    /**
+     * Should a cell or whole row flash
+     * @defaultValue  'cell'
+     */
+    defaultFlashTarget?: 'row' | 'cell';
+    /**
+     * Style for 'Down' value changes
+     *  @defaultValue  Red BackColour
+     */
+    defaultDownChangeStyle?: AdaptableStyle;
+    /**
+     * Style for 'Up' value changes
+     * @defaultValue  Green BackColour
+     */
+    defaultUpChangeStyle?: AdaptableStyle;
+    /**
+     * Style for 'Neutral' value changes
+     * @defaultValue  Gray BackColour
+     */
+    defaultNeutralChangeStyle?: AdaptableStyle;
+    /**
+     * Duration of Flash - can be number (in ms) or 'always'
+     * @defaultValue 500ms
+     */
+    defaultFlashDuration?: number | 'always';
+}

package/src/AdaptableOptions/GeneralOptions.d.ts

@@ -71,7 +71,7 @@ export interface GeneralOptions {
      */
     customSortComparers?: ColumnValuesComparer[];
     /**
-     * Maintain upper and lower case when performing text operations (applies to both Expressions and Predicates)
+     * Keep case sensitivity when AdapTableQL evaluates string-based Expressions and Predicates
      *
      * @defaultValue false
      * @gridInfoItem

package/src/AdaptableOptions/MenuOptions.d.ts

@@ -39,11 +39,11 @@ export interface MenuOptions {
      */
     contextMenuOrder?: ('aggrid' | 'adaptable' | 'user')[];
     /**
-     * A collection of UserMenuItem objects to be added to the Column Header Menu (the one that appears as a dropdown in each Column Header).
+     * User-defined Menu Items to add to the Column Menu
      */
     columnMenuItems?: UserMenuItem<ColumnMenuContext>[];
     /**
-     * A collection of UserMenuItem objects to be added to the Context Menu (the one that appears when you right-click on a cell, or cells, in the Grid).
+     * User-defined Menu Items to add to the Context Menu
      */
     contextMenuItems?: UserMenuItem<ContextMenuContext>[];
 }

package/src/AdaptableOptions/NotificationsOptions.d.ts

@@ -1,4 +1,4 @@
-import { AlertButton, AlertDefinition, FlashingAlertProperties } from '../PredefinedConfig/AlertState';
+import { AlertButton, AlertDefinition } from '../PredefinedConfig/AlertState';
 import { AdaptableAlert } from '../PredefinedConfig/Common/AdaptableAlert';
 import { ButtonContext } from '../PredefinedConfig/Common/AdaptableButton';
 import { AdaptableForm, AdaptableFormData } from '../PredefinedConfig/Common/AdaptableForm';
@@ -21,12 +21,6 @@ export interface NotificationsOptions {
      * @gridInfoItem
      */
     maxNotifications?: number;
-    /**
-     * Flashing Alert Defaults
-     *
-     * @defaultValue BackColors: Green (up), Red (down), Gray (neutral), Duration: 500ms
-     */
-    flashingAlertDefaultProperties?: FlashingAlertProperties;
     /**
      * Where Notification will appear (if anywhere)
      *
@@ -104,7 +98,7 @@ export interface NotificationsOptions {
      * @defaultValue false
      * @gridInfoItem
      */
-    showSystemStatusMessageAsAlert?: boolean;
+    showSystemStatusMessageNotifications?: boolean;
     /**
      * How many System Status Messages to hold in State; when limit is reached, oldest Message is removed
      *

package/src/AdaptableOptions/SettingsPanelOptions.d.ts

@@ -0,0 +1,87 @@
+import { AdaptableApi, AdaptableFrameworkComponent, AdaptableIcon } from '../../types';
+import { AdaptableSettingsPanel } from '../PredefinedConfig/Common/Types';
+export interface SettingsPanelOptions {
+    /**
+     * Title for the Settings Panel
+     *
+     * @defaultValue 'Settings Panel'
+     * @gridInfoItem
+     */
+    title?: string;
+    /**
+     * Icon for Settings Panel  Can be `ConfigurationIcon`, `ApplicationIcon` or a custom Icon
+     *
+     * @defaultValue 'ConfigurationIcon'
+     */
+    icon?: 'ConfigurationIcon' | 'ApplicationIcon' | AdaptableIcon;
+    /**
+     * Whether a Settings Panel button should always be displayed in `ModuleButtons` area of Dashboard
+     * @defaultValue false
+     * @gridInfoItem
+     */
+    alwaysShowInDashboard?: boolean;
+    /**
+     * Whether a Settings Panel button should always be displayed in `ModuleButtons` area of ToolPanel
+     * @defaultValue false
+     * @gridInfoItem
+     */
+    alwaysShowInToolPanel?: boolean;
+    /**
+     * Ordered items to display at side of Settings Panel
+     */
+    navigation?: {
+        items?: (AdaptableSettingsPanel | string | '-')[];
+    };
+    /**
+     * Initial position of Settings Panel window
+     *
+     * @defaultValue 'Middle of Screen'
+     */
+    position?: {
+        x: number;
+        y: number;
+    };
+    /**
+     * Initial size of Settings Panel
+     *
+     * @defaultValue 'Computed based on size of screen'
+     */
+    size?: {
+        width: number;
+        height: number;
+    };
+    /**
+     * How Settings Panel behaves: can be 'window' (movable, resizable no backdrop) or 'modal' (centre of screen with backdrop)
+     *
+     * @defaultValue 'window'
+     */
+    popupType?: 'modal' | 'window';
+    /**
+     * Custom Settings Panels provided by developers at design-time
+     */
+    customSettingsPanels?: CustomSettingsPanel[];
+}
+export interface CustomSettingsPanel {
+    /**
+     * Name appears in Settings Panel Navigation
+     * To be shown you must include it in settingsPanelOptions.navigation.
+     * By default is added to the end.
+     */
+    name: string;
+    /**
+     * Icon rendered inside settings-panel name, inside the navigation
+     */
+    icon?: AdaptableIcon;
+    /**
+     * Function to provide bespoke content when NOT using a Framework wrapper
+     */
+    render?: ({ visible, node, adaptableApi, }: {
+        visible: boolean;
+        node: HTMLDivElement;
+        adaptableApi: AdaptableApi;
+    }) => string | null;
+    /**
+     * Framework-specific (Angular or React) component to be rendered
+     */
+    frameworkComponent?: AdaptableFrameworkComponent;
+}

package/src/AdaptableOptions/ToolPanelOptions.d.ts

@@ -52,20 +52,6 @@ export interface ToolPanelOptions {
      * @defaultValue ['filters', 'columns', 'adaptable']
      */
     toolPanelOrder?: ('adaptable' | 'columns' | 'filters')[];
-    /**
-     * Display the Modules dropdown
-     *
-     * @defaultValue true
-     * @gridInfoItem
-     */
-    showModulesDropdown?: boolean;
-    /**
-     * Display the Columns dropdown
-     *
-     * @defaultValue true
-     * @gridInfoItem
-     */
-    showColumnsDropdown?: boolean;
     /**
      * Display the Tool Panels dropdown
      *

package/src/AdaptableOptions/UserInterfaceOptions.d.ts

@@ -74,6 +74,11 @@ export interface UserInterfaceOptions {
      * @gridInfoItem
      */
     styleClassNames?: string[];
+    /**
+     * Optional list of Column Types - used primarily for special columns
+     *
+     */
+    columnTypes?: string[];
     /**
      * Provide links to AdapTable documentation (in Module popups and Expression Editor)
      *
@@ -81,6 +86,12 @@ export interface UserInterfaceOptions {
      * @gridInfoItem
      */
     showDocumentationLinks?: boolean;
+    /**
+     * Which sections to show in the Grid Info Screen
+     *
+     * @defaultValue ['GridSummary', 'AdaptableOptions','ColumnInfo']
+     */
+    gridInfoSections?: GridInfoSections;
 }
 export interface BasePermittedValues {
     /**
@@ -201,17 +212,40 @@ export interface BaseParams {
     adaptableApi: AdaptableApi;
 }
 export interface EditLookUpParams extends BaseParams {
+    /**
+     * Column displaying the Edit LookUp
+     */
     column: AdaptableColumn;
+    /**
+     * Cell being edited
+     */
     gridCell: GridCell;
 }
 export interface PermittedValuesParams extends BaseParams {
+    /**
+     * Column whose values are being displayed
+     */
     column: AdaptableColumn;
 }
 export interface FilterPermittedValuesParams extends BaseParams {
+    /**
+     * Column hosting the filter form
+     */
     column: AdaptableColumn;
+    /**
+     * A search string
+     */
     filter: string;
 }
 export interface BulkUpdatePermittedValuesParams extends BaseParams {
+    /**
+     * Column being edited via Bulk Update
+     */
     column: AdaptableColumn;
+    /**
+     * Cells which will be modified in the Bulk Update
+     */
     gridCells: GridCell[];
 }
+export declare type GridInfoSections = GridInfoSection[];
+export declare type GridInfoSection = 'GridSummary' | 'AdaptableOptions' | 'ColumnInfo';

package/src/Api/AdaptableApi.d.ts

@@ -1,4 +1,3 @@
-import { SparklineColumnApi } from './SparklineColumnApi';
 import { AlertApi } from './AlertApi';
 import { PluginsApi } from './PluginsApi';
 import { BulkUpdateApi } from './BulkUpdateApi';
@@ -34,6 +33,8 @@ import { ApplicationApi } from './ApplicationApi';
 import { ScopeApi } from './ScopeApi';
 import { PredicateApi } from './PredicateApi';
 import { DataChangeHistoryApi } from './DataChangeHistoryApi';
+import { FlashingCellApi } from './FlashingCellApi';
+import { ChartingApi } from './ChartingApi';
 /**
  *
  * The `AdaptableApi` provides developers with run-time access to AdapTable.
@@ -45,6 +46,7 @@ export interface AdaptableApi {
      * Provides access to the Alert Module
      */
     alertApi: AlertApi;
+    flashingCellApi: FlashingCellApi;
     /**
      * Provides access to the Application Module
      */
@@ -82,7 +84,7 @@ export interface AdaptableApi {
      */
     dashboardApi: DashboardApi;
     /**
-     * Provides run-time access to the Data Change History Module
+     * Provides run-time access to the Data Changes Module
      **/
     dataChangeHistoryApi: DataChangeHistoryApi;
     /**
@@ -122,7 +124,7 @@ export interface AdaptableApi {
      */
     plusMinusApi: PlusMinusApi;
     /**
-     * Offers access to AdapTable Plugin (e.g. charts, ipushpull, OpenFin etc)
+     * Offers access to AdapTable Plugin (e.g. ipushpull, OpenFin etc)
      */
     pluginsApi: PluginsApi;
     /**
@@ -157,10 +159,6 @@ export interface AdaptableApi {
      * Provides access to the Smart Edit Module
      */
     smartEditApi: SmartEditApi;
-    /**
-     * Provides access to the Sparkline Column in the Charts Plugin
-     */
-    sparklineColumnApi: SparklineColumnApi;
     /**
      * Methods related to displaying System Status and application health messages
      */
@@ -181,6 +179,10 @@ export interface AdaptableApi {
      * Manages User Interface Options where colours, styles and permitted values are configured
      */
     userInterfaceApi: UserInterfaceApi;
+    /**
+     * Provides run-time access to Charting Module and state
+     */
+    chartingApi: ChartingApi;
     /**
      * Api methods used *internally* within AdapTable.
      */