@adaptabletools/adaptable-cjs 19.2.3 → 20.0.0-canary.0

package/src/AdaptableOptions/QuickSearchOptions.d.ts

@@ -1,15 +1,20 @@
-import { AdaptableColumn } from '../PredefinedConfig/Common/AdaptableColumn';
 import { BaseContext, GridCell } from '../types';
 /**
  * Options for configuring Quick Search
  */
 export interface QuickSearchOptions<TData = any> {
     /**
-     * Function enabling specific Columns to be excluded from Quick Search
+     * Determines whether Quick Search should be applied to a given cell
      *
-     * @defaultValue undefined
+     * @param quickSearchContext Contains quick search text and current Grid Cell
      */
-    excludeColumnFromQuickSearch?: (column: AdaptableColumn<TData>) => boolean;
+    isCellSearchable?: (quickSearchContext: QuickSearchContext) => boolean;
+    /**
+     * Runs custom Quick Search with bespoke evaluation
+     *
+     * @param quickSearchContext Contains quick search text and current Grid Cell
+     */
+    runCustomQuickSearch?: (quickSearchContext: QuickSearchContext) => boolean;
     /**
      * Value to use as placeholder in QuickSearch controls (e.g. in Dashboard)
      *
@@ -25,29 +30,13 @@ export interface QuickSearchOptions<TData = any> {
      */
     clearQuickSearchOnStartUp?: boolean;
     /**
-     * Filters the quick search results so only matching rows are displayed
+     * Filters quick search results so only matching rows are displayed
      *
      * @defaultValue false
      * @gridInfoItem
      * @noCodeItem
      */
     filterResultsAfterQuickSearch?: boolean;
-    /**
-     * Include Aggregrated Columns in Group Rows when Quick Searching (highlight only)
-     *
-     * @defaultValue false
-     * @gridInfoItem
-     * @noCodeItem
-     */
-    runQuickSearchOnRowGroups?: boolean;
-    /**
-     * Include Pivot columns when Quick Searching (highlight only)
-     *
-     * @defaultValue true
-     * @gridInfoItem
-     * @noCodeItem
-     */
-    runQuickSearchOnPivotColumns?: boolean;
     /**
      * Run Quick Search using Case Sensitivity
      *
@@ -55,13 +44,7 @@ export interface QuickSearchOptions<TData = any> {
      * @gridInfoItem
      * @noCodeItem
      */
-    runQuickSearchWithCaseSensitivity?: boolean;
-    /**
-     * Determines whether Quick Search is applied to a given cell
-     *
-     * @param quickSearchContext Context of the Quick Search and Cell
-     */
-    runBespokeQuickSearch?(quickSearchContext: QuickSearchContext): boolean;
+    isQuickSearchCaseSensitive?: boolean;
 }
 /**
  * Context used when applying Quick Search in bespoke fashion

package/src/AdaptableOptions/RowFormOptions.d.ts

@@ -0,0 +1,116 @@
+import { IRowNode } from 'ag-grid-enterprise';
+import { RowFormSubmittedInfo, AdaptableButton, AdaptableColumn, BaseContext, FormContext } from '../types';
+/**
+ * Options related to Dynamic Row Forms in AdapTable
+ */
+export interface RowFormOptions<TData = any> {
+    /**
+     * Whether AdapTable automatically updates AG Grid data model with created/edited/deleted rows
+     * @defaultValue true
+     */
+    autoHandle?: boolean;
+    /**
+     * Prevents direct editing in Grid cells even for editable columns
+     * @defaultValue false
+     */
+    disableInlineEditing?: boolean;
+    /**
+     * Function called when auto-handling 'create' or 'clone' Command Button; returned row value should be a valid pk value
+     * @defaultValue undefined
+     */
+    setPrimaryKeyValue?: (context: SetPrimaryKeyValueContext<TData>) => any;
+    /**
+     * Custom form title provider
+     * @defaultValue 'Create New Row'/'Edit Row'
+     */
+    rowFormTitle?: string | ((context: RowFormTitleContext<TData>) => string);
+    /**
+     * Custom form description provider
+     * @defaultValue undefined
+     */
+    rowFormDescription?: string | ((context: RowFormTitleContext<TData>) => string);
+    /**
+     * Custom form field label provider
+     * @defaultValue undefined
+     */
+    rowFormFieldLabel?: (context: RowFormFieldContext<TData>) => string;
+    /**
+     * Custom form buttons; if provided, need to handle form submission explicitly
+     */
+    rowFormButtons?: AdaptableButton<RowFormContext<TData>>[];
+    /**
+     * Event fired when a Row Form is submitted via a standard button provided by AdapTable; this is not invoked when custom form buttons are provided
+     *
+     * @param rowFormSubmittedInfo the form submitted info
+     * @defaultValue undefined
+     */
+    onRowFormSubmit?: (rowFormSubmittedInfo: RowFormSubmittedInfo<TData>) => void;
+    /**
+     * Is given Column displayed in Row Form
+     * @defaultValue true
+     */
+    includeColumnInRowForm?: (rowFormColumnContext: RowFormColumnContext) => boolean;
+}
+/**
+ * Context passed into a Row Form - can be `CreateRowFormContext` or `EditRowFormContext`
+ */
+export type RowFormContext<TData = any> = CreateRowFormContext<TData> | EditRowFormContext<TData>;
+/**
+ * Context used in a Create Row Form
+ */
+export interface CreateRowFormContext<TData = any> extends FormContext {
+    /**
+     * Type of the Context
+     */
+    type: Extract<RowFormType, 'rowCreated'>;
+    /**
+     * The RowNode being cloned
+     */
+    clonedRowNode?: IRowNode<TData>;
+}
+/**
+ * Context used in an Edit Row Form
+ */
+export interface EditRowFormContext<TData = any> extends FormContext {
+    /**
+     * Type of the Context
+     */
+    type: Extract<RowFormType, 'rowEdited'>;
+    /**
+     * The RowNode being edited
+     */
+    rowNode: IRowNode<TData>;
+}
+/**
+ * Context used for overriding Title and Description of Row Form
+ */
+export interface RowFormTitleContext<TData = any> extends BaseContext {
+    type: Extract<RowFormType, 'rowEdited' | 'rowCreated'>;
+    rowNode?: IRowNode<TData>;
+}
+/**
+ * Context used for overriding Field elements in Row Form
+ */
+export interface RowFormFieldContext<TData = any> extends RowFormTitleContext {
+    column: AdaptableColumn<TData>;
+}
+export type RowFormType = 'rowCreated' | 'rowEdited' | 'rowDeleted';
+export interface RowFormColumnContext extends BaseContext {
+    /**
+     * Column to be displayed
+     */
+    adaptableColumn: AdaptableColumn;
+    /**
+     * Type of Row Form
+     */
+    rowFormType: RowFormType;
+}
+/**
+ * Context for the setPrimaryKeyValue function
+ */
+export interface SetPrimaryKeyValueContext<TData = any> extends BaseContext {
+    /**
+     * Data in the row being created or cloned
+     */
+    rowData: TData;
+}

package/src/AdaptableOptions/SettingsPanelOptions.d.ts

@@ -1,6 +1,6 @@
 import { AdaptableFrameworkComponent, AdaptableIcon } from '../../types';
 import { AdaptableSettingsPanel } from '../PredefinedConfig/Common/Types';
-import { CustomRenderContext } from './AdaptableFrameworkComponent';
+import { CustomRenderContext } from '../agGrid/AdaptableFrameworkComponent';
 /**
  * Options for managing the AdapTable Settings Panel
  */
@@ -64,7 +64,7 @@ export interface SettingsPanelOptions {
         height: number;
     };
     /**
-     * How Settings Panel behaves: can be 'window' (movable, resizable no backdrop) or 'modal' (centre of screen with backdrop)
+     * Whether Settings Panel is 'window' (i.e. movable, resizable, no backdrop) or 'modal' (centre of screen with backdrop)
      *
      * @defaultValue 'window'
      */
@@ -91,7 +91,7 @@ export interface CustomSettingsPanel {
      */
     render?: (customRenderContext: CustomRenderContext) => string | null;
     /**
-     * Framework-specific (Angular or React) component to be rendered
+     * Framework-specific (Angular, React or Vue) component to be rendered
      */
     frameworkComponent?: AdaptableFrameworkComponent;
 }

package/src/AdaptableOptions/ToolPanelOptions.d.ts

@@ -1,5 +1,5 @@
 import { AdaptableObject } from '../PredefinedConfig/Common/AdaptableObject';
-import { AdaptableFrameworkComponent } from './AdaptableFrameworkComponent';
+import { AdaptableFrameworkComponent } from '../agGrid/AdaptableFrameworkComponent';
 import { AdaptableButton } from '../PredefinedConfig/Common/AdaptableButton';
 import { ToolPanelState } from '../PredefinedConfig/ToolPanelState';
 import { BaseContext, CustomRenderContext } from '../types';
@@ -45,7 +45,7 @@ export interface CustomToolPanel extends AdaptableObject {
      */
     render?: (customRenderContext: CustomRenderContext) => string | null;
     /**
-     * Framework-specific (Angular or React) component to be rendered
+     * Framework-specific (Angular, React or Vue) component to be rendered
      */
     frameworkComponent?: AdaptableFrameworkComponent;
 }

package/src/AdaptableOptions/UserInterfaceOptions.d.ts

@@ -1,10 +1,8 @@
 import { AdaptableIcon } from '../PredefinedConfig/Common/AdaptableIcon';
 import { DateInputOptions } from './DateInputOptions';
-import { ColumnScope } from '../PredefinedConfig/Common/ColumnScope';
-import { AdaptableColumn } from '../PredefinedConfig/Common/AdaptableColumn';
 import { AdaptableObjectTag } from '../PredefinedConfig/Common/AdaptableObject';
 import { AdaptableStyle } from '../PredefinedConfig/Common/AdaptableStyle';
-import { AlternativeModuleName, BaseContext, GridCell } from '../../types';
+import { AlternativeModuleName, BaseContext } from '../../types';
 /**
  * Options for managing the User Interface of AdapTable
  */
@@ -30,26 +28,6 @@ export interface UserInterfaceOptions<TData = any> {
      * Options for managing and customizing date inputs in AdapTable
      */
     dateInputOptions?: DateInputOptions;
-    /**
-     * List of Column values to display (e.g. in Filter, Custom Sort etc.)
-     */
-    permittedValues?: PermittedValues<TData>[];
-    /**
-     * Dropdown values displayed when column is being edited
-     */
-    editLookUpItems?: EditLookUpPermittedValues<TData>[];
-    /**
-     * Custom column values for Values Column Filter and Grid Filter Builder
-     */
-    filterPermittedValues?: FilterPermittedValues<TData>[];
-    /**
-     * Custom column values for defining Custom Sort
-     */
-    customSortPermittedValues?: CustomSortPermittedValues<TData>[];
-    /**
-     * Custom column values for editing via bulk-update
-     */
-    bulkUpdatePermittedValues?: BulkUpdatePermittedValues<TData>[];
     /**
      * Colours to display in Colour Picker (in place of AdapTable's default set); can be hardcoded list or function
      */
@@ -110,13 +88,22 @@ export interface UserInterfaceOptions<TData = any> {
      */
     alternativeModuleNames?: AlternativeModuleName[];
     /**
-     * Display Loading message when AdapTable starts
+     * Options for showing Loading Screen (during initialisation)
+     */
+    loadingScreenOptions?: LoadingScreenOptions;
+}
+/**
+ * Options for the Loading Screen shown when AdapTable is initialising
+ */
+export interface LoadingScreenOptions<TData = any> {
+    /**
+     * Display Loading message when AdapTable initialises
      * @defaultValue true
      * @noCodeItem
      */
     showLoadingScreen?: boolean;
     /**
-     * Delay in milliseconds before Loading Screen appears. `showLoadingScreen` must be true for this to take effect
+     * Delay in ms before Loading Screen appears (`showLoadingScreen` must be true)
      *
      * @defaultValue 200
      */
@@ -129,105 +116,10 @@ export interface UserInterfaceOptions<TData = any> {
     /**
      * Text to display in Loading Screen.
      *
-     * @defaultValue 'Retrieving your settings and setting up the grid...'
+     * @defaultValue 'Retrieving your settings and setting up Grid...'
      */
     loadingScreenText?: string;
 }
-/**
- * Base class for all Permitted Values related objects
- */
-export interface BasePermittedValues {
-    /**
-     * Scope where Values will appear (Mandatory property)
-     */
-    scope: ColumnScope;
-}
-/**
- * Permitted/possible values, when column values can be selected (e.g. sort, bulk-update)
- */
-export interface PermittedValues<TData = any> extends BasePermittedValues {
-    /**
-     * Values to display: either hardcoded list or a function that returns a list
-     */
-    values?: any[] | ((context: PermittedValuesContext<TData>) => any[]);
-}
-/**
- * Used to define permitted values for inline column editor
- */
-export interface EditLookUpPermittedValues<TData = any> extends BasePermittedValues {
-    /**
-     * Values to display in Edit Look Up: either hardcoded list or a function that returns a list
-     */
-    values?: any[] | ((context: EditLookUpContext<TData>) => any[]);
-}
-/**
- * Used to define values inside the Filter Bar and Filter Form
- */
-export interface FilterPermittedValues<TData = any> extends BasePermittedValues {
-    /**
-     * Prevents AdapTable from filtering the list of values client-side; When true, values is called each time the search bar is changed
-     * @defaultValue false
-     */
-    suppressFilterSearchBar?: boolean;
-    /**
-     * Function returning Values to display in 'IN' Filter - can be async
-     */
-    values: (context: FilterPermittedValuesContext<TData>) => any[] | Promise<any[]>;
-}
-/**
- * Custom column values for Custom Sort
- */
-export interface CustomSortPermittedValues<TData = any> extends BasePermittedValues {
-    /**
-     * Function returning Values to display in Custom Sort Wizard - can be async
-     */
-    values: (context: PermittedValuesContext<TData>) => any[] | Promise<any[]>;
-}
-/**
- * User to define permitted values when updating cells via bulk update
- */
-export interface BulkUpdatePermittedValues<TData = any> extends BasePermittedValues {
-    /**
-     * Function returning Values to display in Bulk Update Wizard - can be async
-     */
-    values: (context: BulkUpdatePermittedValuesContext<TData>) => any[] | Promise<any[]>;
-}
-/**
- * Context used when getting PermittedValues via a function
- */
-export interface PermittedValuesContext<TData = any> extends BaseContext {
-    /**
-     * Column whose values are being displayed
-     */
-    column: AdaptableColumn<TData>;
-}
-/**
- * Context used when getting EditLookUpPermittedValues via a function
- */
-export interface EditLookUpContext<TData = any> extends PermittedValuesContext {
-    /**
-     * Cell being edited
-     */
-    gridCell?: GridCell<TData>;
-}
-/**
- * Context used when getting FilterPermittedValues via a function
- */
-export interface FilterPermittedValuesContext<TData = any> extends PermittedValuesContext<TData> {
-    /**
-     * A search string
-     */
-    searchFilter: string;
-}
-/**
- * Context used when getting BulkUpdatePermittedValues via a function
- */
-export interface BulkUpdatePermittedValuesContext<TData = any> extends PermittedValuesContext<TData> {
-    /**
-     * Cells which will be modified in the Bulk Update
-     */
-    gridCells: GridCell<TData>[];
-}
 /**
  * Context used when evaluating Object Tags
  */

package/src/Api/ActionColumnApi.d.ts

@@ -7,4 +7,9 @@ export interface ActionColumnApi {
      * Retrieves the Action Columns provided in Action Column Options
      */
     getActionColumns(): ActionColumn[];
+    /**
+     * Returns Action Column with given Id
+     * @param columnId id of Action Column
+     */
+    getActionColumnForColumnId(columnId: string): ActionColumn | undefined;
 }

package/src/Api/AdaptableApi.d.ts

@@ -1,4 +1,4 @@
-import { GridApi as AgGridApi } from '@ag-grid-community/core';
+import { GridApi as AgGridApi } from 'ag-grid-enterprise';
 import { AlertApi } from './AlertApi';
 import { PluginsApi } from './PluginsApi';
 import { BulkUpdateApi } from './BulkUpdateApi';
@@ -39,16 +39,15 @@ import { StatusBarApi } from './StatusBarApi';
 import { StyledColumnApi } from './StyledColumnApi';
 import { OptionsApi } from './OptionsApi';
 import { ActionColumnApi } from './ActionColumnApi';
-import { ActionRowApi } from './ActionRowApi';
 import { NoteApi } from './NoteApi';
 import { Fdc3Api } from './Fdc3Api';
 import { DataImportApi } from './DataImportApi';
-import { GridFilterApi } from './GridFilterApi';
 import { NamedQueryApi } from './NamedQueryApi';
-import { ColumnFilterApi } from './ColumnFilterApi';
+import { FilterApi } from './FilterApi';
 import { CommentApi } from './CommentApi';
 import { ColumnMenuApi } from './ColumnMenuApi';
 import { ContextMenuApi } from './ContextMenuApi';
+import { RowFormApi } from './RowFormApi';
 /**
  * Provides developers with run-time access to AdapTable.  Contains many classes each dedicated to a specific AdapTable Module or functionality
  */
@@ -61,10 +60,6 @@ export interface AdaptableApi {
      * Provides access to Action Columns
      */
     actionColumnApi: ActionColumnApi;
-    /**
-     * Provides access to Action Rows
-     */
-    actionRowApi: ActionRowApi;
     /**
      * Provides access to the Alert Module
      */
@@ -130,9 +125,9 @@ export interface AdaptableApi {
      */
     exportApi: ExportApi;
     /**
-     * Provides access to the Column Filter Module
+     * Provides access to Filtering in AdapTable
      */
-    columnFilterApi: ColumnFilterApi;
+    filterApi: FilterApi;
     /**
      * Provides access to the Flashing Cell Module
      */
@@ -181,6 +176,10 @@ export interface AdaptableApi {
      * Provides access to the Quick Search Module
      */
     quickSearchApi: QuickSearchApi;
+    /**
+     * Creates Row Forms
+     */
+    rowFormApi: RowFormApi;
     /**
      * Provides access to the Schedule Module
      */
@@ -226,7 +225,7 @@ export interface AdaptableApi {
      */
     toolPanelApi: ToolPanelApi;
     /**
-     * Manages User Interface Options where colours, styles and permitted values are configured
+     * Manages User Interface Options where colours, styles and custom column values are configured
      */
     userInterfaceApi: UserInterfaceApi;
     /**
@@ -253,10 +252,6 @@ export interface AdaptableApi {
      * Manages the FDC3 capabilities of AdapTable
      */
     fdc3Api: Fdc3Api;
-    /**
-     * Manages grid filter
-     */
-    gridFilterApi: GridFilterApi;
     /**
      * Cleanup method - call only for vanilla JavaScript components, as framework components handle cleanup on destroy/unmount. By default, it unmounts the Adaptable component and destroys the AG Grid instance.
      * @param config - optional configuration object
@@ -277,10 +272,6 @@ export interface DestroyConfig {
      * @defaultValue true
      */
     unmount: boolean;
-    /**
-     * @deprecated use `destroyAgGrid` instead
-     */
-    destroyApi?: boolean;
     /**
      * Destroy the AgGrid instance
      *

package/src/Api/AlertApi.d.ts

@@ -91,12 +91,12 @@ export interface AlertApi {
      * Displays given Alert as a Toast
      * @param alert the Alert to show as a Toast
      */
-    showAdaptableAlertAsToast(alert: AdaptableAlert): void;
+    displayAdaptableAlertNotification(alert: AdaptableAlert): void;
     /**
      * Displays the given Adaptable Alert
      * @param alert The Alert which should be displayed
      */
-    showAdaptableAlert(alertToShow: AdaptableAlert): Promise<void>;
+    displayAdaptableAlert(alertToShow: AdaptableAlert): Promise<void>;
     /**
      * Creates Alert based on given parameters and displays it.
      * @param alertHeader Header of the Alert (if shown in a popup its the Title of the Window)

package/src/Api/CalculatedColumnApi.d.ts

@@ -11,6 +11,10 @@ export interface CalculatedColumnApi {
      * Retrieves all Calculated Columns in Adaptable State
      */
     getCalculatedColumns(): CalculatedColumn[];
+    /**
+     * Retrieves all Aggregated Calculated Columns in Adaptable State
+     */
+    getAggregatedCalculatedColumns(): CalculatedColumn[];
     /**
      * Retrieves Calculated Column by the technical ID (from `CalculatedColumnState`)
      * @param id - Calculated Column state unique identifier

package/src/Api/CellSummaryApi.d.ts

@@ -1,20 +1,20 @@
-import { CellSummaryOperation } from '../PredefinedConfig/Common/CellSummary';
+import { CustomCellSummaryOperation } from '../PredefinedConfig/Common/CellSummary';
 /**
  *  Provides run-time access to the Cell Summary Module
  */
 export interface CellSummaryApi {
     /**
-     * Retrieves all Cell Summary Definitions from Cell Summary State
+     * Retrieves all Custom Cell Summary Operations
      */
-    getCellSummaryOperationDefinitions(): CellSummaryOperation[];
+    getCustomCellSummaryOperations(): CustomCellSummaryOperation[];
     /**
      * Retrieves currently selected Cell Summary Operation
      */
-    getCurrentCellSummaryOperation(): CellSummaryOperation | string;
+    getCurrentCellSummaryOperation(): CustomCellSummaryOperation | string;
     /**
      * Sets the currently selected Cell Summary Operation
      */
-    setCurrentCellSummaryOperation(operation: CellSummaryOperation | string): void;
+    setCurrentCellSummaryOperation(operation: CustomCellSummaryOperation | string): void;
     /**
      * Opens Cell Summary Settings Panel with
      */
@@ -26,5 +26,5 @@ export interface CellSummaryApi {
     /**
      * Retrieves the value of the given Cell Summary Operation
      */
-    getCellSummaryOperationValue(operation: CellSummaryOperation | string): any;
+    getCellSummaryOperationValue(operation: CustomCellSummaryOperation | string): any;
 }

package/src/Api/ChartingApi.d.ts

@@ -1,4 +1,4 @@
-import { ChartModel, ChartRef } from '@ag-grid-community/core';
+import { ChartModel, ChartRef } from 'ag-grid-enterprise';
 import { ExternalChartDefinition } from '../PredefinedConfig/ChartingState';
 import { ChartContainer, ChartDefinition } from '../types';
 import { ChartingOpenState } from './Events/ChartChanged';