ag-grid-community 32.3.2 → 33.0.0

package/dist/types/src/interfaces/iSetFilter.d.ts

@@ -0,0 +1,203 @@
+import type { ColDef, KeyCreatorParams, ValueFormatterParams } from '../entities/colDef';
+import type { IProvidedFilter, IProvidedFilterParams } from '../filter/provided/iProvidedFilter';
+import type { Column } from '../interfaces/iColumn';
+import type { ITooltipParams } from '../tooltip/tooltipComponent';
+import type { AgPromise } from '../utils/promise';
+import type { AgGridCommon } from './iCommon';
+import type { IFilterParams, ProvidedFilterModel } from './iFilter';
+export type SetFilterModelValue = (string | null)[];
+export interface SetFilterModel extends ProvidedFilterModel {
+    filterType?: 'set';
+    values: SetFilterModelValue;
+}
+/**
+ * Interface contract for the public aspects of the SetFilter implementation.
+ * @param V type of value in the Set Filter
+ */
+export interface ISetFilter<V = string> extends IProvidedFilter {
+    /**
+     * Returns a model representing the current state of the filter, or `null` if the filter is
+     * not active.
+     */
+    getModel(): SetFilterModel | null;
+    /**
+     * Sets the state of the filter using the supplied model. Providing `null` as the model will
+     * de-activate the filter.
+     *
+     * **Note:** if you are [providing values asynchronously](/filter-set-filter-list/#asynchronous-values)
+     * to the Set Filter, you need to wait for these changes to be applied before performing any further
+     * actions by waiting on the returned grid promise, e.g.
+     * `filter.setModel({ values: ['a', 'b'] }).then(function() { gridApi.onFilterChanged(); });`
+     */
+    setModel(model: SetFilterModel | null): AgPromise<void>;
+    /** Returns the full list of unique keys used by the Set Filter. */
+    getFilterKeys(): SetFilterModelValue;
+    /** Returns the full list of unique values used by the Set Filter. */
+    getFilterValues(): (V | null)[];
+    /** Sets the values used in the Set Filter on the fly. */
+    setFilterValues(values: (V | null)[]): void;
+    /**
+     * Refreshes the values shown in the filter from the original source. For example, if a
+     * callback was provided, the callback will be executed again and the filter will refresh using
+     * the values returned.
+     */
+    refreshFilterValues(): void;
+    /**
+     * Resets the Set Filter to use values from the grid, rather than any values that have been
+     * provided directly.
+     */
+    resetFilterValues(): void;
+    /** Returns the current mini-filter text. */
+    getMiniFilter(): string | null;
+    /** Sets the text in the Mini Filter at the top of the filter (the 'quick search' in the popup). */
+    setMiniFilter(newMiniFilter: string | null): void;
+    /** Returns the current UI state (potentially un-applied). */
+    getModelFromUi(): SetFilterModel | null;
+}
+/**
+ * @param TData type of data row
+ * @param V type of value in the Set Filter
+ */
+export interface SetFilterValuesFuncParams<TData = any, V = string> extends AgGridCommon<TData, any> {
+    /** The function to call with the values to load into the filter once they are ready. */
+    success: (values: (V | null)[]) => void;
+    /** The column definition from which the set filter is invoked. */
+    colDef: ColDef<TData>;
+    /** Column from which the set filter is invoked. */
+    column: Column;
+}
+/**
+ * @param TData type of data row
+ * @param V type of value in the Set Filter
+ */
+export type SetFilterValuesFunc<TData = any, V = string> = (params: SetFilterValuesFuncParams<TData, V>) => void;
+/**
+ * @param TData type of data row
+ * @param V type of value in the Set Filter
+ */
+export type SetFilterValues<TData = any, V = string> = SetFilterValuesFunc<TData, V> | (V | null)[];
+/**
+ * Parameters provided by the grid to the `init` method of a `SetFilter`.
+ * Do not use in `colDef.filterParams` - see `ISetFilterParams` instead.
+ */
+export type SetFilterParams<TData = any, V = string> = ISetFilterParams<TData, V> & IFilterParams<TData>;
+/**
+ * Parameters used in `colDef.filterParams` to configure a Set Filter (`agSetColumnFilter`).
+ * @param TData type of data row
+ * @param V type of value in the Set Filter
+ */
+export interface ISetFilterParams<TData = any, V = string> extends IProvidedFilterParams {
+    /**
+     * The values to display in the Filter List. If this is not set, the filter will takes its
+     * values from what is loaded in the table.
+     */
+    values?: SetFilterValues<TData, V>;
+    /**
+     * Refresh the values every time the Set filter is opened.
+     */
+    refreshValuesOnOpen?: boolean;
+    /** The height of values in the Filter List in pixels. */
+    cellHeight?: number;
+    /**
+     * If `true`, the Set Filter values will not be sorted. Use this if you are providing your own
+     * values and don't want them sorted as you are providing in the order you want.
+     *
+     * @default false
+     */
+    suppressSorting?: boolean;
+    /**
+     * Similar to the Cell Renderer for the grid. Setting it separately here allows for the value to
+     * be rendered differently in the filter.
+     */
+    cellRenderer?: any;
+    /**
+     * Set to `true` to hide the Mini Filter.
+     *
+     * @default false
+     */
+    suppressMiniFilter?: boolean;
+    /**
+     * Set to `true` to apply the Set Filter immediately when the user is typing in the Mini Filter.
+     *
+     * @default false
+     */
+    applyMiniFilterWhileTyping?: boolean;
+    /**
+     * Set to `true` to remove the Select All checkbox.
+     * @default false
+     */
+    suppressSelectAll?: boolean;
+    /**
+     * By default, when the Set Filter is opened all values are shown selected. Set this to `true`
+     * to instead show all values as de-selected by default.
+     *
+     * This does not work when `excelMode` is enabled.
+     */
+    defaultToNothingSelected?: boolean;
+    /**
+     * Comparator for sorting. If not provided, the Column Definition comparator is used. If Column
+     * Definition comparator is also not provided, the default (grid provided) comparator is used.
+     */
+    comparator?: (a: V | null, b: V | null) => number;
+    /**
+     * If specified, this formats the text before applying the Mini Filter compare logic, useful for
+     * instance to substitute accented characters.
+     */
+    textFormatter?: (from: string) => string;
+    /**
+     * If specified, this formats the value before it is displayed in the Filter List.
+     * If a Key Creator is provided (see `keyCreator`), this must also be provided.
+     */
+    valueFormatter?: (params: ValueFormatterParams) => string;
+    /**
+     * Function to return a string key for a value. This is required when the filter values are complex objects,
+     * or when `treeList = true` and the column is a group column with Tree Data or Grouping enabled.
+     * If not provided, the Column Definition Key Creator is used.
+     */
+    keyCreator?: (params: KeyCreatorParams<TData>) => string;
+    /**
+     * If `true`, hovering over a value in the Set Filter will show a tooltip containing the full,
+     * untruncated value.
+     *
+     * @default false
+     */
+    showTooltips?: boolean;
+    /**
+     * If `true`, enables case-sensitivity in the SetFilter Mini-Filter and Filter List.
+     * @default false
+     */
+    caseSensitive?: boolean;
+    /**
+     * Changes the behaviour of the Set Filter to match that of Excel's AutoFilter.
+     */
+    excelMode?: 'mac' | 'windows';
+    /**
+     * If `true`, the Set Filter List will be displayed in a tree format. If enabled, one of the following must be true:
+     *
+     * - A `treeListPathGetter` is provided to get the tree path for the column values.
+     * - The column values are of type `Date`, in which case the tree will be year -> month -> day.
+     * - Tree Data mode is enabled and the column is the group column. The Filter List will match the tree structure. A Key Creator must be supplied.
+     * - Grouping is enabled and the column is the group column. The Filter List will match the group structure. A Key Creator must be supplied.
+     */
+    treeList?: boolean;
+    /**
+     * Requires `treeList = true`. If provided, this gets the tree path to display in the Set Filter List based on the column values.
+     * Each row must map to a leaf value in the tree.
+     */
+    treeListPathGetter?: (value: V | null) => string[] | null;
+    /**
+     * Requires `treeList = true`. If specified, this formats the tree values before they are displayed in the Filter List.
+     * @param pathKey - The key for the current node in the tree.
+     * @param level - The level of the current node in the tree (starting at 0).
+     * @param parentPathKeys - The keys of the parent nodes up until the current node (exclusive).
+     * This will be an empty array if the node is at the root level.
+     */
+    treeListFormatter?: (pathKey: string | null, level: number, parentPathKeys: (string | null)[]) => string;
+}
+/**
+ * Tooltip params used with the Set Filter Tree List.
+ */
+export interface ISetFilterTreeListTooltipParams extends ITooltipParams {
+    /** Level of the tree (starting at 0). */
+    level: number;
+}

package/dist/types/src/interfaces/iShowRowGroupColsService.d.ts

@@ -0,0 +1,8 @@
+import type { AgColumn } from '../entities/agColumn';
+export interface IShowRowGroupColsService {
+    refresh(): void;
+    getShowRowGroupCols(): AgColumn[];
+    getShowRowGroupCol(id: string): AgColumn | undefined;
+    getSourceColumnsForGroupColumn(groupCol: AgColumn): AgColumn[] | null;
+    isRowGroupDisplayed(column: AgColumn, colId: string): boolean;
+}

package/dist/types/src/interfaces/iSideBar.d.ts

@@ -0,0 +1,62 @@
+import type { ComponentSelector } from '../widgets/component';
+import type { SideBarState } from './gridState';
+import type { IToolPanel } from './iToolPanel';
+export interface ISideBarService {
+    comp: ISideBar;
+    getSelector(): ComponentSelector;
+}
+export interface ISideBar {
+    refresh(): void;
+    setDisplayed(show: boolean): void;
+    setSideBarPosition(position?: 'left' | 'right'): void;
+    isToolPanelShowing(): boolean;
+    openToolPanel(key: string, source?: 'sideBarButtonClicked' | 'sideBarInitializing' | 'api'): void;
+    getToolPanelInstance(key: string): IToolPanel | undefined;
+    close(source?: 'sideBarButtonClicked' | 'sideBarInitializing' | 'api'): void;
+    openedItem(): string | null;
+    isDisplayed(): boolean;
+    getDef(): SideBarDef | undefined;
+    getState(): SideBarState;
+}
+export interface ToolPanelDef {
+    /** The unique ID for this panel. Used in the API and elsewhere to refer to the panel. */
+    id: string;
+    /** The key used for localisation for displaying the label. The label is displayed in the tab button. */
+    labelKey: string;
+    /** The default label if `labelKey` is missing or does not map to valid text through localisation. */
+    labelDefault: string;
+    /**
+     * The min width of the tool panel.
+     * @default 100
+     */
+    minWidth?: number;
+    /** The max width of the tool panel. */
+    maxWidth?: number;
+    /**
+     * The initial width of the tool panel.
+     * @default $side-bar-panel-width (theme variable)
+     */
+    width?: number;
+    /** The key of the icon to be used as a graphical aid beside the label in the side bar. */
+    iconKey: string;
+    /**
+     * The tool panel component to use as the panel.
+     * The provided panels use components `agColumnsToolPanel` and `agFiltersToolPanel`.
+     * To provide your own custom panel component, you reference it here.
+     */
+    toolPanel?: any;
+    /** Customise the parameters provided to the `toolPanel` component. */
+    toolPanelParams?: any;
+}
+export interface SideBarDef {
+    /**
+     * A list of all the panels to place in the side bar. The panels will be displayed in the provided order from top to bottom.
+     */
+    toolPanels?: (ToolPanelDef | string)[];
+    /** The panel (identified by ID) to open by default. If none specified, the side bar is initially displayed closed. */
+    defaultToolPanel?: string;
+    /** To hide the side bar by default, set this to `true`. If left undefined the side bar will be shown. */
+    hiddenByDefault?: boolean;
+    /** Sets the side bar position relative to the grid. */
+    position?: 'left' | 'right';
+}

package/dist/types/src/interfaces/iSortModelItem.d.ts

@@ -0,0 +1,6 @@
+export interface SortModelItem {
+    /** Column Id to apply the sort to. */
+    colId: string;
+    /** Sort direction */
+    sort: 'asc' | 'desc';
+}

package/dist/types/src/interfaces/iSortOption.d.ts

@@ -0,0 +1,5 @@
+import type { Column } from './iColumn';
+export interface SortOption {
+    sort: 'asc' | 'desc';
+    column: Column;
+}

package/dist/types/src/interfaces/iSparklineCellRendererParams.d.ts

@@ -0,0 +1,6 @@
+import type { AgChartInstance, AgSparklineOptions } from 'ag-charts-types';
+import type { ICellRendererParams } from '../rendering/cellRenderers/iCellRenderer';
+export interface ISparklineCellRendererParams<TData = any, TContext = any> extends ICellRendererParams<TData, TContext> {
+    sparklineOptions?: AgSparklineOptions;
+    createSparkline?: (options: AgSparklineOptions) => AgChartInstance<AgSparklineOptions>;
+}

package/dist/types/src/interfaces/iStickyRows.d.ts

@@ -0,0 +1,17 @@
+import type { BeanStub } from '../context/beanStub';
+import type { RowNode } from '../entities/rowNode';
+import type { RowCtrl } from '../rendering/row/rowCtrl';
+export interface IStickyRowFeature {
+    stickyTopRowCtrls: RowCtrl[];
+    stickyBottomRowCtrls: RowCtrl[];
+    refreshStickyNode(stickRowNode: RowNode): void;
+    checkStickyRows(): boolean;
+    extraTopHeight: number;
+    extraBottomHeight: number;
+    resetOffsets(): void;
+    destroyStickyCtrls(): void;
+    ensureRowHeightsValid(): boolean;
+}
+export interface IStickyRowService {
+    createStickyRowFeature(ctrl: BeanStub, createRowCon: (rowNode: RowNode, animate: boolean, afterScroll: boolean) => RowCtrl, destroyRowCtrls: (rowCtrlsMap: Record<string, RowCtrl> | null | undefined, animate: boolean) => void): IStickyRowFeature | undefined;
+}

package/dist/types/src/interfaces/iToolPanel.d.ts

@@ -0,0 +1,54 @@
+import type { AgGridCommon } from './iCommon';
+import type { IComponent } from './iComponent';
+export interface BaseToolPanelParams<TData = any, TContext = any, TState = any> extends AgGridCommon<TData, TContext> {
+    /** The tool-panel-specific initial state as provided in grid options if applicable */
+    initialState?: TState | undefined;
+}
+export interface IToolPanelParams<TData = any, TContext = any, TState = any> extends BaseToolPanelParams<TData, TContext, TState> {
+    /** If tool panel is saving and restoring state, this should be called after the state is updated */
+    onStateUpdated: () => void;
+}
+export interface IToolPanel<TData = any, TContext = any, TState = any> {
+    /**
+     * Called when `api.refreshToolPanel()` is called (with the current params).
+     * Also called when the `sideBar` grid option is updated (with the updated params).
+     * When `sideBar` is updated, if this method returns `true`,
+     * then the grid will take no further action.
+     * Otherwise, the tool panel will be destroyed and recreated.
+     */
+    refresh(params: IToolPanelParams<TData, TContext, TState>): boolean | void;
+    /** If saving and restoring state, this should return the current state */
+    getState?(): TState | undefined;
+}
+export interface IToolPanelComp<TData = any, TContext = any, TState = any> extends IToolPanel<TData, TContext, TState>, IComponent<IToolPanelParams<TData, TContext, TState>> {
+}
+export interface IToolPanelColumnCompParams {
+    /** Suppress Column Move */
+    suppressColumnMove: boolean;
+    /** Suppress Row Groups section */
+    suppressRowGroups: boolean;
+    /** Suppress Values section */
+    suppressValues: boolean;
+    /** Suppress Column Labels (Pivot) section */
+    suppressPivots: boolean;
+    /** Suppress Pivot Mode selection */
+    suppressPivotMode: boolean;
+    /** Suppress Column Filter section */
+    suppressColumnFilter: boolean;
+    /** Suppress Select / Un-select all widget */
+    suppressColumnSelectAll: boolean;
+    /** Suppress Expand / Collapse all widget */
+    suppressColumnExpandAll: boolean;
+    /** By default, column groups start expanded. Pass `true` to default to contracted groups */
+    contractColumnSelection: boolean;
+    /** Suppress updating the layout of columns as they are rearranged in the grid */
+    suppressSyncLayoutWithGrid: boolean;
+}
+export interface IToolPanelFiltersCompParams {
+    /** To suppress Expand / Collapse All */
+    suppressExpandAll: boolean;
+    /** To suppress the Filter Search */
+    suppressFilterSearch: boolean;
+    /** Suppress updating the layout of columns as they are rearranged in the grid */
+    suppressSyncLayoutWithGrid: boolean;
+}

package/dist/types/src/interfaces/iUserCompDetails.d.ts

@@ -0,0 +1,17 @@
+import type { AgPromise } from '../utils/promise';
+import type { IComponent } from './iComponent';
+export interface UserCompDetails<TComp extends IComponent<any> = any> {
+    componentClass: any;
+    componentFromFramework: boolean;
+    params: any;
+    type: ComponentType;
+    popupFromSelector?: boolean;
+    popupPositionFromSelector?: 'over' | 'under';
+    newAgStackInstance: () => AgPromise<TComp>;
+}
+export interface ComponentType<TComp = any> {
+    name: string;
+    cellRenderer?: boolean;
+    mandatoryMethods?: (keyof TComp & string)[];
+    optionalMethods?: (keyof TComp & string)[];
+}

package/dist/types/src/interfaces/masterDetail.d.ts

@@ -0,0 +1,56 @@
+import type { GridApi } from '../api/gridApi';
+import type { Bean } from '../context/bean';
+import type { GridOptions } from '../entities/gridOptions';
+import type { RowNode } from '../entities/rowNode';
+import type { ICellRendererParams } from '../rendering/cellRenderers/iCellRenderer';
+import type { RowCtrl } from '../rendering/row/rowCtrl';
+import type { IRowNode } from './iRowNode';
+export interface IDetailCellRenderer<TData = any> {
+    addOrRemoveCssClass(cssClassName: string, on: boolean): void;
+    addOrRemoveDetailGridCssClass(cssClassName: string, on: boolean): void;
+    setDetailGrid(gridOptions: GridOptions<TData>): void;
+    setRowData(rowData: TData[]): void;
+    getGui(): HTMLElement;
+}
+export interface IDetailCellRendererParams<TData = any, TDetail = any> extends ICellRendererParams<TData> {
+    /**
+     * Provide Grid Options to use for the Detail Grid.
+     */
+    detailGridOptions: GridOptions<TDetail>;
+    /** A function that provides what rows to display in the Detail Grid. */
+    getDetailRowData: GetDetailRowData<TData, TDetail>;
+    /** Defines how to refresh the Detail Grids as data is changing in the Master Grid. */
+    refreshStrategy: 'rows' | 'everything' | 'nothing';
+    /** Allows changing the template used around the Detail Grid. */
+    template: string | TemplateFunc<TData>;
+    /** @deprecated v32.2 This property is no longer used */
+    agGridReact: any;
+    /** @deprecated v32.2 This property is no longer used */
+    frameworkComponentWrapper: any;
+    pinned: 'left' | 'right' | null | undefined;
+}
+export interface GetDetailRowData<TData = any, TDetail = any> {
+    (params: GetDetailRowDataParams<TData, TDetail>): void;
+}
+export interface GetDetailRowDataParams<TData = any, TDetail = any> {
+    /** Row node for the details request. */
+    node: IRowNode<TData>;
+    /** Data for the current row. */
+    data: TData;
+    /** Success callback: pass the rows back for the grid request.  */
+    successCallback(rowData: TDetail[]): void;
+}
+interface TemplateFunc<TData = any> {
+    (params: ICellRendererParams<TData>): string;
+}
+export interface IDetailCellRendererCtrl extends Bean {
+    init(comp: IDetailCellRenderer, params: IDetailCellRendererParams): void;
+    registerDetailWithMaster(api: GridApi): void;
+    refresh(): boolean;
+}
+export interface IMasterDetailService {
+    setupDetailRowAutoHeight(rowCtrl: RowCtrl, eDetailGui: HTMLElement): void;
+    /** Used by flatten stage to get or create a detail node from a master node */
+    getDetail(masterNode: RowNode): RowNode | null;
+}
+export {};

package/dist/types/src/interfaces/menuItem.d.ts

@@ -0,0 +1,137 @@
+import type { IMenuActionParams } from './iCallbackParams';
+import type { AgGridCommon } from './iCommon';
+import type { IComponent } from './iComponent';
+export interface MenuItemLeafDef<TData = any, TContext = any> {
+    /** Name of the menu item. */
+    name: string;
+    /** Set to `true` to display the menu item as disabled. */
+    disabled?: boolean;
+    /**
+     * Shortcut text displayed inside menu item.
+     * Setting this doesn’t actually create a keyboard shortcut binding.
+     */
+    shortcut?: string;
+    /** Function that gets executed when item is chosen. */
+    action?: (params: IMenuActionParams<TData, TContext>) => void;
+    /** Set to true to provide a check beside the option. */
+    checked?: boolean;
+    /** The icon to display, either a DOM element or HTML string. */
+    icon?: Element | string;
+    /** CSS classes to apply to the menu item. */
+    cssClasses?: string[];
+    /** Tooltip text to be displayed for the menu item. */
+    tooltip?: string;
+    /**
+     * If `true`, will keep the menu open when the item is selected.
+     * Note that if this item has a sub menu,
+     * it will always remain open regardless of this property.
+     */
+    suppressCloseOnSelect?: boolean;
+}
+export interface MenuItemDef<TData = any, TContext = any> extends MenuItemLeafDef<TData, TContext> {
+    /**
+     * If this item is a sub menu, contains a list of menu item definitions */
+    subMenu?: (MenuItemDef<TData, TContext> | string)[];
+    /**
+     * Provide a custom menu item component.
+     * See [Menu Item Component](https://www.ag-grid.com/javascript-data-grid/component-menu-item/#implementing-a-menu-item-component) for framework specific implementation details.
+     */
+    menuItem?: any;
+    /**
+     * Parameters to be passed to the custom menu item component specified in `menuItem`.
+     */
+    menuItemParams?: any;
+}
+export interface IMenuConfigParams {
+    /**
+     * Suppress the grid-provided tooltip on hover.
+     */
+    suppressTooltip?: boolean;
+    /**
+     * Suppress handling of click events. If `true`, the component will need to implement its own click event handler.
+     * The grid will no longer handle performing the action and opening the sub menu (if appropriate).
+     */
+    suppressClick?: boolean;
+    /** Suppress handling of mouse down events. */
+    suppressMouseDown?: boolean;
+    /**
+     * Suppress handling of mouseenter and mouseleave events, If `true`,
+     * The grid will no longer update the active status of the menu item or open sub menus.
+     */
+    suppressMouseOver?: boolean;
+    /**
+     * Suppress handling of keyboard events to select the current item. If `true`,
+     * the grid will not select the menu item on Enter or Space.
+     */
+    suppressKeyboardSelect?: boolean;
+    /**
+     * Suppress setting tabindex on the root element. If `true`,
+     * will need to set tabindex elsewhere for keyboard navigation to work.
+     */
+    suppressTabIndex?: boolean;
+    /**
+     * Suppress setting Aria properties on the root element.
+     */
+    suppressAria?: boolean;
+    /**
+     * Suppress setting CSS classes on the root element. If `true` and
+     * mixing custom menu item components with grid-provided ones,
+     * will need to style with table display rules, as well as adding active and disabled styling.
+     */
+    suppressRootStyles?: boolean;
+    /**
+     * Suppress focusing the root element when made active. If `true`,
+     * will need to handle keyboard navigation.
+     */
+    suppressFocus?: boolean;
+}
+export interface BaseMenuItemParams<TData = any, TContext = any> extends MenuItemDef, AgGridCommon<TData, TContext> {
+    /** Level within the menu tree (starts at 0). */
+    level: number;
+    /** Returns `true` if another sub menu is open. */
+    isAnotherSubMenuOpen: () => boolean;
+    /**
+     * Open the sub menu for this item.
+     * @param activateFirstItem If `true`, activate the first item in the sub menu.
+     */
+    openSubMenu: (activateFirstItem?: boolean) => void;
+    /** Close the sub menu for this item. */
+    closeSubMenu: () => void;
+    /** Close the entire menu. */
+    closeMenu: (event?: KeyboardEvent | MouseEvent) => void;
+    /**
+     * Updates the grid-provided tooltip this component.
+     * @param tooltip The value to be displayed by the tooltip
+     * @param shouldDisplayTooltip A function returning a boolean that allows the tooltip to be displayed conditionally. This option does not work when `enableBrowserTooltips={true}`.
+     */
+    updateTooltip: (tooltip?: string, shouldDisplayTooltip?: () => boolean) => void;
+}
+export interface IMenuItemParams<TData = any, TContext = any> extends BaseMenuItemParams<TData, TContext> {
+    /**
+     * Callback to let the menu know that the current item has become active.
+     * Required if updating the active status within the menu item.
+     */
+    onItemActivated: () => void;
+}
+export interface BaseMenuItem {
+    /** Called when the item is selected, e.g. clicked or Enter is pressed. */
+    select?(): void;
+    /**
+     * Configure the default grid behaviour for this item, including styling,
+     * and mouse and keyboard interactions.
+     *
+     * @returns `true` to use all default behaviour, `false` to use no default behaviour
+     * (equivalent to `configureDefaults` not being defined),
+     * or `IMenuConfigParams` to choose what default behaviour to use.
+     */
+    configureDefaults?(): boolean | IMenuConfigParams;
+}
+export interface IMenuItem extends BaseMenuItem {
+    /** Called when the item is activated/deactivated, either via mouseover or keyboard navigation. */
+    setActive?(active: boolean): void;
+    /** If the item has a sub menu, called when the sub menu is opened/closed. */
+    setExpanded?(expanded: boolean): void;
+}
+export interface IMenuItemComp<TData = any, TContext = any> extends IComponent<IMenuItemParams<TData, TContext>>, IMenuItem {
+}
+export type DefaultMenuItem = 'pinSubMenu' | 'pinLeft' | 'pinRight' | 'clearPinned' | 'valueAggSubMenu' | 'autoSizeThis' | 'autoSizeAll' | 'rowGroup' | 'rowUnGroup' | 'resetColumns' | 'expandAll' | 'contractAll' | 'copy' | 'copyWithHeaders' | 'copyWithGroupHeaders' | 'cut' | 'paste' | 'export' | 'csvExport' | 'excelExport' | 'separator' | 'pivotChart' | 'chartRange' | 'columnFilter' | 'columnChooser' | 'sortAscending' | 'sortDescending' | 'sortUnSort' | 'separator';

package/dist/types/src/interfaces/serverSideTransaction.d.ts

@@ -0,0 +1,61 @@
+import type { IRowNode } from './iRowNode';
+export interface ServerSideTransaction<TData = any> {
+    /**
+     * The Row Store to apply the transaction to, ie what group level.
+     * eg ['Ireland','2002'] to update the child store found after expanding Ireland and 2002 groups.
+     * Passing in blank to empty applies the transaction to the top level.
+     */
+    route?: string[];
+    /** Index position to add at. If missing, rows will be added to the end. */
+    addIndex?: number;
+    /** Rows to add */
+    add?: TData[];
+    /** Rows to remove */
+    remove?: TData[];
+    /** Rows to update */
+    update?: TData[];
+}
+export interface ServerSideTransactionResult<TData = any> {
+    /** The status of applying the transaction. */
+    status: ServerSideTransactionResultStatus;
+    /** If rows were added, the newly created Row Nodes for those rows. */
+    add?: IRowNode<TData>[];
+    /** If rows were removed, the deleted Row Nodes. */
+    remove?: IRowNode<TData>[];
+    /** If rows were updated, the updated Row Nodes. */
+    update?: IRowNode<TData>[];
+}
+export declare enum ServerSideTransactionResultStatus {
+    /** Transaction was successfully applied */
+    Applied = "Applied",
+    /**
+     * Store was not found, transaction not applied.
+     * Either invalid route, or the parent row has not yet been expanded.
+     */
+    StoreNotFound = "StoreNotFound",
+    /**
+     * Store is loading, transaction not applied.
+     */
+    StoreLoading = "StoreLoading",
+    /**
+     * Store is loading (as max loads exceeded), transaction not applied.
+     */
+    StoreWaitingToLoad = "StoreWaitingToLoad",
+    /**
+     * Store load attempt failed, transaction not applied.
+     */
+    StoreLoadingFailed = "StoreLoadingFailed",
+    /**
+     * Store is type Partial, which doesn't accept transactions
+     */
+    StoreWrongType = "StoreWrongType",
+    /**
+     * Transaction was cancelled, due to grid.
+     * Callback isApplyServerSideTransaction() returning false
+     */
+    Cancelled = "Cancelled",
+    /**
+     * Store has not started yet, transaction not applied
+     */
+    StoreNotStarted = "StoreNotStarted"
+}