@adaptabletools/adaptable 24.0.0-canary.7 → 24.0.0-canary.9

package/src/Api/Events/DataImported.d.ts

@@ -1,19 +1,23 @@
 import { IRowNode } from 'ag-grid-enterprise';
 import { BaseContext } from '../../types';
 /**
- * Object returned by the `DataImported` event
+ * Payload of the `DataImported` event.
+ *
+ * Fires after a data import has been applied to the grid.
+ *
+ * Extends {@link BaseContext}, so `adaptableApi` is included.
  */
 export interface DataImportedInfo extends BaseContext {
     /**
-     * Raw data that was imported
+     * Raw rows that were imported, before they were matched to grid rows.
      */
     importData: any[];
     /**
-     * Rows that were added
+     * Row nodes created by this import.
      */
     addedRows: IRowNode[];
     /**
-     * Rows that were updated
+     * Existing row nodes updated by this import.
      */
     updatedRows: IRowNode[];
 }

package/src/Api/Events/DataSetSelected.d.ts

@@ -1,10 +1,14 @@
 import { BaseContext, DataSet } from '../../types';
 /**
- * Object returned by the `DataSetSelected` event
+ * Payload of the `DataSetSelected` event.
+ *
+ * Fires when a Data Set is selected.
+ *
+ * Extends {@link BaseContext}, so `adaptableApi` is included.
  */
 export interface DataSetSelectedInfo extends BaseContext {
     /**
-     * The DataSet that has been selected
+     * Data Set that was selected.
      */
     dataSet: DataSet;
 }

package/src/Api/Events/Fdc3MessageInfo.d.ts

@@ -1,11 +1,17 @@
 import { BaseContext } from '../../types';
 import { AppIdentifier, Context, ContextMetadata, Intent } from '@finos/fdc3';
 /**
- * EventInfo returned by FDC3 Message events
+ * Payload of the `Fdc3Message` event.
+ *
+ * A sent message ({@link Fdc3MessageSentInfo}, `direction: 'sent'`) or a received message ({@link Fdc3MessageReceivedInfo}, `direction: 'received'`).
  */
 export type Fdc3MessageInfo = Fdc3MessageSentInfo | Fdc3MessageReceivedInfo;
 /**
- * Event Info for FDC3 Sent Message Event
+ * A message AdapTable sent through FDC3.
+ *
+ * `eventType` is `RaiseIntent`, `RaiseIntentForContext` or `BroadcastMessage`. `intent` is set for `RaiseIntent`.
+ *
+ * Extends {@link BaseContext}, so `adaptableApi` is included.
  */
 export interface Fdc3MessageSentInfo extends BaseContext {
     /**
@@ -13,7 +19,7 @@ export interface Fdc3MessageSentInfo extends BaseContext {
      */
     direction: 'sent';
     /**
-     * Event Type: `RaiseIntent`, `RaiseIntentForContext, `BroadcastMessage`
+     * What was sent: `RaiseIntent`, `RaiseIntentForContext` or `BroadcastMessage`.
      */
     eventType: 'RaiseIntent' | 'RaiseIntentForContext' | 'BroadcastMessage';
     /**
@@ -30,7 +36,11 @@ export interface Fdc3MessageSentInfo extends BaseContext {
     app?: AppIdentifier;
 }
 /**
- * Event Info for FDC3 Received Message Event
+ * A message AdapTable received through FDC3.
+ *
+ * `eventType` is `IntentRaised` or `ContextBroadcast`. `intent` is set for `IntentRaised`.
+ *
+ * Extends {@link BaseContext}, so `adaptableApi` is included.
  */
 export interface Fdc3MessageReceivedInfo extends BaseContext {
     /**

package/src/Api/Events/FlashingCellDisplayed.d.ts

@@ -1,11 +1,15 @@
 import { AdaptableFlashingCell } from '../../AdaptableState/Common/AdaptableFlashingCell';
 import { BaseContext } from '../../types';
 /**
- * Object returned by the `FlashingCellDisplayed` event
+ * Payload of the `FlashingCellDisplayed` event.
+ *
+ * Fires when a cell or row flashes.
+ *
+ * Extends {@link BaseContext}, so `adaptableApi` is included.
  */
 export interface FlashingCellDisplayedInfo extends BaseContext {
     /**
-     * Details of the Cell (or row) which has just flashed
+     * What flashed: the cell or row, and the change that caused the flash.
      */
     flashingCell: AdaptableFlashingCell;
 }

package/src/Api/Events/GridFilterApplied.d.ts

@@ -1,14 +1,22 @@
 import { BaseContext, GridFilter } from '../../types';
 /**
- * EventInfo returned by the GridFilterApplied event
+ * Payload of the `GridFilterApplied` event.
+ *
+ * Fires when the Grid Filter on the current Layout is set, cleared, suspended or unsuspended.
+ *
+ * Extends {@link BaseContext}, so `adaptableApi` is included.
  */
 export interface GridFilterAppliedInfo extends BaseContext {
     /**
-     * Current Grid Filter
+     * Grid Filter on the current Layout after this change.
+     *
+     * `undefined` when the Layout has no Grid Filter (including after it is cleared).
      */
     gridFilter: GridFilter | undefined;
     /**
-     * AST for Current Grid Filter Expression
+     * AST of `gridFilter.Expression`.
+     *
+     * `null` when the Layout has no Grid Filter.
      */
     gridFilterExpressionAST: any;
 }

package/src/Api/Events/GridSorted.d.ts

@@ -1,11 +1,15 @@
 import { AdaptableSortState } from '../../AdaptableState/Common/AdaptableSortState';
 import { BaseContext } from '../../types';
 /**
- * EventInfo returned by GridSorted event
+ * Payload of the `GridSorted` event.
+ *
+ * Fires when the grid sort changes, including a Custom Sort. The payload is the sort state after the change.
+ *
+ * Extends {@link BaseContext}, so `adaptableApi` is included.
  */
 export interface GridSortedInfo extends BaseContext {
     /**
-     * Current sort state in the Grid
+     * Column sorts and Custom Sorts after this change.
      */
     adaptableSortState: AdaptableSortState;
 }

package/src/Api/Events/LayoutChanged.d.ts

@@ -1,19 +1,25 @@
 import { LayoutState } from '../../AdaptableState/LayoutState';
 import { BaseContext } from '../../types';
 /**
- * EventInfo returned by LayoutChanged event
+ * Payload of the `LayoutChanged` event.
+ *
+ * Fires when Layout State changes: the current Layout is ready, added, edited, saved, deleted or selected, and when a Column Filter or the Grid Filter on the current Layout changes.
+ *
+ * Extends {@link BaseContext}, so `adaptableApi` is included.
  */
 export interface LayoutChangedInfo extends BaseContext {
     /**
-     * What caused Layout State to change
+     * Which action caused this change. See {@link LayoutChangedAction}.
      */
     actionName: LayoutChangedAction;
     /**
-     * Previous Layout State
+     * Layout State before this change.
+     *
+     * Absent for `LAYOUT_READY`, which fires once after startup and has no previous state.
      */
     oldLayoutState: LayoutState | undefined;
     /**
-     * Current Layout State
+     * Layout State after this change.
      */
     newLayoutState: LayoutState;
     /**
@@ -38,6 +44,31 @@ export interface LayoutChangedInfo extends BaseContext {
  */
 export type LayoutChangedArea = 'Columns' | 'ColumnPinning' | 'ColumnHeaders' | 'ColumnSorting' | 'RowGrouping' | 'Aggregations' | 'RowSummaries' | 'RowSelection' | 'ColumnFilter' | 'GridFilter' | 'Pivoting';
 /**
- * Trigger for Layout Changed Event
+ * Why a `LayoutChanged` event fired.
+ *
+ * Identity of the Layout:
+ * - `LAYOUT_READY` — once after startup, for the Layout that is already current. `oldLayoutState` is absent and `changedAreas` is omitted.
+ * - `LAYOUT_ADD` — a Layout was added. `changedAreas` is omitted.
+ * - `LAYOUT_EDIT` — a Layout was edited.
+ * - `LAYOUT_SAVE` — a Layout was saved, including auto-save after grid edits (sort, grouping, columns, and so on). `changedAreas` lists the facets that actually changed.
+ * - `LAYOUT_DELETE` — a Layout was deleted. `changedAreas` is omitted.
+ * - `LAYOUT_SELECT` — a different Layout was selected. `changedAreas` is omitted.
+ *
+ * Column Filters on the current Layout. `changedAreas` is always `['ColumnFilter']`:
+ * - `LAYOUT_COLUMN_FILTER_ADD` — a Column Filter was added
+ * - `LAYOUT_COLUMN_FILTER_EDIT` — a Column Filter was edited
+ * - `LAYOUT_COLUMN_FILTER_SET` — Column Filters were set
+ * - `LAYOUT_COLUMN_FILTER_CLEAR` — a Column Filter was cleared
+ * - `LAYOUT_COLUMN_FILTER_CLEAR_ALL` — all Column Filters were cleared
+ * - `LAYOUT_COLUMN_FILTER_SUSPEND` — a Column Filter was suspended
+ * - `LAYOUT_COLUMN_FILTER_SUSPEND_ALL` — all Column Filters were suspended
+ * - `LAYOUT_COLUMN_FILTER_UNSUSPEND` — a Column Filter was unsuspended
+ * - `LAYOUT_COLUMN_FILTER_UNSUSPEND_ALL` — all Column Filters were unsuspended
+ *
+ * Grid Filter on the current Layout. `changedAreas` is always `['GridFilter']`:
+ * - `LAYOUT_GRID_FILTER_SET` — the Grid Filter was set
+ * - `LAYOUT_GRID_FILTER_CLEAR` — the Grid Filter was cleared
+ * - `LAYOUT_GRID_FILTER_SUSPEND` — the Grid Filter was suspended
+ * - `LAYOUT_GRID_FILTER_UNSUSPEND` — the Grid Filter was unsuspended
  */
 export type LayoutChangedAction = 'LAYOUT_READY' | 'LAYOUT_ADD' | 'LAYOUT_EDIT' | 'LAYOUT_SAVE' | 'LAYOUT_DELETE' | 'LAYOUT_SELECT' | 'LAYOUT_COLUMN_FILTER_ADD' | 'LAYOUT_COLUMN_FILTER_EDIT' | 'LAYOUT_COLUMN_FILTER_SET' | 'LAYOUT_COLUMN_FILTER_CLEAR' | 'LAYOUT_COLUMN_FILTER_CLEAR_ALL' | 'LAYOUT_COLUMN_FILTER_SUSPEND' | 'LAYOUT_COLUMN_FILTER_SUSPEND_ALL' | 'LAYOUT_COLUMN_FILTER_UNSUSPEND' | 'LAYOUT_COLUMN_FILTER_UNSUSPEND_ALL' | 'LAYOUT_GRID_FILTER_SET' | 'LAYOUT_GRID_FILTER_CLEAR' | 'LAYOUT_GRID_FILTER_SUSPEND' | 'LAYOUT_GRID_FILTER_UNSUSPEND';

package/src/Api/Events/LiveDataChanged.d.ts

@@ -1,19 +1,33 @@
 import { Report } from '../../AdaptableState/ExportState';
 import { BaseContext } from '../../types';
 /**
- * EventInfo returned by LiveDataChanged event
+ * Payload of the `LiveDataChanged` event.
+ *
+ * Fires for the ipushpull and OpenFin live-report plugins: when the destination connects or disconnects, a snapshot is sent, or live data starts, stops or is pushed.
+ *
+ * Extends {@link BaseContext}, so `adaptableApi` is included.
  */
 export interface LiveDataChangedInfo extends BaseContext {
     /**
-     * Which Adaptable partner is the export destination for the live data
+     * Destination this change belongs to: `OpenFin` or `ipushpull`.
      */
     reportDestination: 'OpenFin' | 'ipushpull';
     /**
-     * What triggered the event to fire
+     * What happened:
+     * - `Connected` — the destination session started. `liveReport` is omitted.
+     * - `Disconnected` — the destination session ended. `liveReport` is omitted.
+     * - `SnapshotSent` — a one-off snapshot was sent. `liveReport` is omitted.
+     * - `LiveDataStarted` — a report started streaming. `liveReport` is that report.
+     * - `LiveDataStopped` — streaming stopped. `liveReport` is the report that was live.
+     * - `LiveDataUpdated` — a new snapshot of the live report was pushed. `liveReport` is that report.
      */
     liveDataTrigger: 'Connected' | 'Disconnected' | 'SnapshotSent' | 'LiveDataStarted' | 'LiveDataStopped' | 'LiveDataUpdated';
     /**
-     * The Report which is currently live - only used if the Trigger is LiveData related
+     * The ipushpull or OpenFin report this change is about.
+     *
+     * Set for `LiveDataStarted`, `LiveDataStopped` and `LiveDataUpdated`. Omitted for `Connected`, `Disconnected` and `SnapshotSent`.
+     *
+     * This is the plugin report (an ipushpull report or an OpenFin report), not a {@link LiveReport}.
      */
     liveReport?: any;
 }
@@ -30,7 +44,9 @@ export interface LiveReport {
      */
     report: Report;
     /**
-     * Where the live data is being sent
+     * Where the live data is being sent.
+     *
+     * `OpenfinExcel` is the OpenFin value on this object. {@link LiveDataChangedInfo.reportDestination} uses `OpenFin` for the same destination.
      */
     reportDestination: 'OpenfinExcel' | 'ipushpull';
 }

package/src/Api/Events/NoteChanged.d.ts

@@ -5,7 +5,11 @@ import { BaseContext } from '../../types';
  */
 export type NoteChangedAction = 'Added' | 'Edited' | 'Deleted';
 /**
- * EventInfo returned by the NoteChanged event
+ * Payload of the `NoteChanged` event.
+ *
+ * Fires when a Note is added, edited or deleted. `actionName` is `Added`, `Edited` or `Deleted`.
+ *
+ * Extends {@link BaseContext}, so `adaptableApi` is included.
  */
 export interface NoteChangedInfo extends BaseContext {
     /**

package/src/Api/Events/ReportScheduleRan.d.ts

@@ -1,15 +1,19 @@
 import { ReportSchedule } from '../../AdaptableState/ExportState';
 import { BaseContext } from '../../types';
 /**
- * EventInfo returned by the ReportScheduleRan event
+ * Payload of the `ReportScheduleRan` event.
+ *
+ * Fires when a scheduled report runs.
+ *
+ * Extends {@link BaseContext}, so `adaptableApi` is included.
  */
 export interface ReportScheduleRanInfo extends BaseContext {
     /**
-     * Report schedule that was triggered (if applicable)
+     * The schedule that just ran.
      */
     reportSchedule?: ReportSchedule;
     /**
-     * ISO datetime when Schedule ran (useful for logging)
+     * When this run started, as an ISO datetime (`new Date().toISOString()`).
      */
     RanAt: string;
 }

package/src/Api/Events/RowChanged.d.ts

@@ -1,11 +1,15 @@
 import { BaseContext } from '../../types';
 import { RowDataChangedInfo } from '../../AdaptableState/Common/RowDataChangedInfo';
 /**
- * EventInfo returned by the RowChanged event
+ * Payload of the `RowChanged` event.
+ *
+ * Fires when rows are added, updated, deleted or loaded.
+ *
+ * Extends {@link BaseContext}, so `adaptableApi` is included.
  */
 export interface RowChangedInfo extends BaseContext {
     /**
-     * Object providing full information of the Row that changed
+     * Rows that changed, and whether they were added, updated, deleted or loaded.
      */
     rowDataChange: RowDataChangedInfo;
 }

package/src/Api/Events/RowFormSubmitted.d.ts

@@ -2,53 +2,69 @@ import { AdaptableFormData } from '../../AdaptableState/Common/AdaptableForm';
 import { IRowNode } from 'ag-grid-enterprise';
 import { BaseContext } from '../../types';
 /**
- * Info passed into RowFormSubmitted Event - can be `CreatedRowInfo`, `EditedRowInfo` or `DeletedRowInfo`
+ * Payload of the `RowFormSubmitted` event.
+ *
+ * Discriminate on `type`: `rowCreated` ({@link CreatedRowInfo}), `rowEdited` ({@link EditedRowInfo}) or `rowDeleted` ({@link DeletedRowInfo}).
+ *
+ * The event fires when the form is submitted, before the grid row is added, updated or deleted.
  */
 export type RowFormSubmittedInfo<TData = any> = CreatedRowInfo<TData> | EditedRowInfo<TData> | DeletedRowInfo<TData>;
 /**
- *  Info passed into RowFormSubmitted Event for Created Rows
+ * Create (or clone) form was submitted.
+ *
+ * The new row is added after this event, from `formData`. `rowNode` is not set.
+ *
+ * Extends {@link BaseContext}, so `adaptableApi` is included.
  */
 export interface CreatedRowInfo<TData = any> extends BaseContext {
     /**
-     * Specifies its a Created Row Form
+     * Always `rowCreated`.
      */
     type: 'rowCreated';
     /**
-     * Data entered in the Form
+     * Values entered in the form. Empty strings are omitted.
      */
     formData: AdaptableFormData;
     /**
-     * Node being added
+     * Not set for a created row. The row does not exist yet; it is added from `formData` after this event.
      */
     rowNode?: IRowNode<TData>;
 }
 /**
- * Info passed into RowFormSubmitted Event for Edited Rows
+ * Edit form was submitted.
+ *
+ * The row is updated from `formData` after this event.
+ *
+ * Extends {@link BaseContext}, so `adaptableApi` is included.
  */
 export interface EditedRowInfo<TData = any> extends BaseContext {
     /**
-     * Specifies its an Edited Row Form
+     * Always `rowEdited`.
      */
     type: 'rowEdited';
     /**
-     * Data entered in the Form
+     * Values entered in the form.
      */
     formData: AdaptableFormData;
     /**
-     * Node being edited
+     * Row being edited. It is still the row in the grid when this event fires.
      */
     rowNode: IRowNode<TData>;
 }
 /**
- * Info passed into RowFormSubmitted Event for Deleted Rows
+ * Delete was confirmed.
+ *
+ * The row is deleted after this event. There is no form data.
+ *
+ * Extends {@link BaseContext}, so `adaptableApi` is included.
  */
 export interface DeletedRowInfo<TData = any> extends BaseContext {
     /**
-     * Specifies its a Deleted Row Form
+     * Always `rowDeleted`.
      */
     type: 'rowDeleted';
     /**
-     * Node being deleted
+     * Row about to be deleted. It is still in the grid when this event fires.
      */
     rowNode: IRowNode<TData>;
 }

package/src/Api/Events/RowSelectionChanged.d.ts

@@ -1,11 +1,15 @@
 import { SelectedRowInfo } from '../../AdaptableState/Selection/SelectedRowInfo';
 import { BaseContext } from '../../types';
 /**
- * Event Info published by RowSelectionChanged event
+ * Payload of the `RowSelectionChanged` event.
+ *
+ * Fires when the row selection changes, after AdapTable has updated its selected-row state. Cell selection does not fire this event.
+ *
+ * Extends {@link BaseContext}, so `adaptableApi` is included.
  */
 export interface RowSelectionChangedInfo extends BaseContext {
     /**
-     * Details of Rows currently selected in the Grid
+     * Rows selected after this change. `gridRows` is empty when nothing is selected.
      */
     selectedRowInfo: SelectedRowInfo;
 }

package/src/Api/Events/SystemStatusMessageDisplayed.d.ts

@@ -1,11 +1,15 @@
 import { SystemStatusMessageInfo } from '../../AdaptableState/Common/SystemStatusMessageInfo';
 import { BaseContext } from '../../types';
 /**
- * Object returned by SystemStatusMessageDisplayed Event
+ * Payload of the `SystemStatusMessageDisplayed` event.
+ *
+ * Fires when a System Status message is displayed.
+ *
+ * Extends {@link BaseContext}, so `adaptableApi` is included.
  */
 export interface SystemStatusMessageDisplayedInfo extends BaseContext {
     /**
-     * Details of the System Status Message and Type
+     * Message text, type (`Success`, `Info`, `Warning` or `Error`) and when it was sent.
      */
     systemStatusMessageInfo: SystemStatusMessageInfo;
 }

package/src/Api/Events/TeamSharingEntityChanged.d.ts

@@ -1,11 +1,15 @@
 import { SharedEntity } from '../../AdaptableState/TeamSharingState';
 import { BaseContext } from '../../types';
 /**
- * EventInfo returned by TeamSharingEntityChanged event
+ * Payload of the `TeamSharingEntityChanged` event.
+ *
+ * Fires when an active shared entity has a newer revision and Team Sharing update notifications run.
+ *
+ * Extends {@link BaseContext}, so `adaptableApi` is included.
  */
 export interface TeamSharingEntityChangedInfo extends BaseContext {
     /**
-     * Object containing the Shared Entity that has changed
+     * Shared entity whose revision changed.
      */
     sharedEntity: SharedEntity;
 }

package/src/Api/Events/ThemeSelected.d.ts

@@ -1,11 +1,15 @@
 import { SystemThemeName } from '../../AdaptableState/ThemeState';
 import { BaseContext } from '../../types';
 /**
- * Object returned by the `ThemeSelected` event
+ * Payload of the `ThemeSelected` event.
+ *
+ * Fires when a shipped theme is selected, applied at startup, or re-applied. `theme` is `light`, `dark` or `os`.
+ *
+ * Extends {@link BaseContext}, so `adaptableApi` is included.
  */
 export interface ThemeSelectedInfo extends BaseContext {
     /**
-     * Shipped theme that is now active: `light`, `dark`, or `os`
+     * Shipped theme that is now active: `light`, `dark` or `os`.
      */
     theme: SystemThemeName;
 }