GridCore: add public types for AIAssistant

Author: anna-shakhova

packages/devextreme/js/__internal/grids/grid_core/ai_assistant/__tests__/ai_assistant_view_controller.integration.test.ts

@@ -6,29 +6,14 @@ import {
   it,
   jest,
 } from '@jest/globals';
-import type { Properties as DataGridProperties } from '@js/ui/data_grid';
 
 import {
   afterTest,
   beforeTest,
-  createDataGrid as commonCreateDataGrid,
+  createDataGrid,
   type DataGridInstance,
 } from '../../__tests__/__mock__/helpers/utils';
 
-// TODO remove when types added to public dts
-interface AIAssistantDataGridProperties extends DataGridProperties {
-  aiAssistant?: {
-    enabled?: boolean;
-    title?: string;
-  };
-}
-
-// TODO remove when types added to public dts
-const createDataGrid = (
-  options: AIAssistantDataGridProperties = {},
-// eslint-disable-next-line @typescript-eslint/no-explicit-any
-): ReturnType<typeof commonCreateDataGrid> => commonCreateDataGrid(options as any);
-
 const AI_ASSISTANT_BUTTON_SELECTOR = '.dx-datagrid-ai-assistant-button';
 const HIDDEN_CLASS = 'dx-hidden';
 

packages/devextreme/js/__internal/grids/grid_core/m_types.ts

@@ -4,9 +4,7 @@ import type { GridBase, GridBaseOptions, SelectionBase } from '@js/common/grids'
 import type { Component } from '@js/core/component';
 import type { PropertyType } from '@js/core/index';
 import type { dxElementWrapper } from '@js/core/renderer';
-import type { Properties as ChatOptions } from '@js/ui/chat';
 import type { Properties as DataGridOptions } from '@js/ui/data_grid';
-import type { Properties as PopupOptions } from '@js/ui/popup';
 import type { Properties as TreeListdOptions } from '@js/ui/tree_list';
 import type Widget from '@js/ui/widget/ui.widget';
 
@@ -129,14 +127,6 @@ export interface InternalGridOptions extends GridBaseOptions<InternalGrid, unkno
   loadItemsOnExportingSelectedItems?: boolean | undefined;
 
   selection?: InternalSelection;
-
-  // TODO move to public d.ts
-  aiAssistant?: {
-    enabled?: boolean;
-    title?: string;
-    popup?: PopupOptions;
-    chat?: ChatOptions;
-  };
 }
 
 // todo: move to upper .d.ts files

packages/devextreme/js/common/grids.d.ts

@@ -61,6 +61,9 @@ import {
 
 import { LoadPanelIndicatorProperties } from '../ui/load_panel';
 
+import {
+  Properties as ChatProperties,
+} from '../ui/chat';
 import {
   Properties as PopupProperties,
 } from '../ui/popup';
@@ -79,6 +82,59 @@ import { PositionConfig } from './core/animation';
 import { PagerBase } from '../ui/pagination';
 import { AIIntegration } from './ai-integration';
 
+/**
+ * @docid
+ * @public
+ * @namespace DevExpress.common.grids
+ */
+export type AIAssistant = {
+  /**
+   * @docid
+   * @public
+   */
+  aiIntegration?: AIIntegration;
+  /**
+   * @docid
+   * @public
+   * @type dxChatOptions
+   */
+  chat?: ChatProperties;
+  /**
+   * @docid
+   * @default false
+   */
+  enabled?: boolean;
+  /**
+   * @docid
+   * @public
+   * @type dxPopupOptions
+   */
+  popup?: PopupProperties;
+  /**
+   * @docid
+   * @default 'AI Assistant'
+   */
+  title?: string;
+};
+
+/**
+ * @docid
+ * @hidden
+ * @namespace DevExpress.common.grids
+ */
+export type AIAssistantRequestCreatingInfo = {
+  /**
+   * @docid
+   * @type object
+   */
+  context: Record<string, any>;
+  /**
+   * @docid
+   * @type object
+   */
+  responseSchema: Record<string, any>;
+};
+
 /**
  * @docid
  * @hidden
@@ -1940,6 +1996,11 @@ interface GridBaseOptionsBlank<TComponent extends GridBase<TRowData, TKey>, TRow
  * @type object
  */
 export type GridBaseOptions<TComponent extends GridBase<TRowData, TKey>, TRowData = any, TKey = any> = Omit<GridBaseOptionsBlank<TComponent, TRowData, TKey>, 'focusStateEnabled'> & {
+  /**
+   * @docid
+   * @public
+   */
+  aiAssistant?: AIAssistant;
   /**
    * @docid
    * @default undefined
@@ -2145,6 +2206,15 @@ export type GridBaseOptions<TComponent extends GridBase<TRowData, TKey>, TRowDat
    * @public
    */
   noDataText?: string;
+  /**
+   * @docid
+   * @default null
+   * @type_function_param1 e:object
+   * @type_function_param1_field component:this
+   * @action
+   * @public
+   */
+  onAIAssistantRequestCreating?: ((e: EventInfo<TComponent> & Cancelable & AIAssistantRequestCreatingInfo) => void);
   /**
    * @docid
    * @default null

packages/devextreme/js/ui/data_grid.d.ts

@@ -41,46 +41,47 @@ import {
 } from '../localization';
 
 import {
-    AdaptiveDetailRowPreparingInfo,
-    ColumnBase as ComponentColumnBase,
-    ColumnButtonBase as ComponentColumnButtonBase,
-    GridsContextMenuTarget,
-    EditingBase as ComponentEditingBase,
-    EditingTextsBase as ComponentEditingTextsBase,
-    DataChangeInfo,
-    DataErrorOccurredInfo,
-    DragDropInfo,
-    DragReorderInfo,
-    DragStartEventInfo,
-    FilterPanel as ComponentFilterPanel,
-    FilterPanelCustomizeTextArg as ComponentFilterPanelCustomizeTextArg,
-    GridBase,
-    GridBaseOptions,
-    GroupExpandMode,
-    KeyDownInfo,
-    NewRowInfo,
-    NewRowPosition,
-    PagingBase as ComponentPaging,
-    ReducedNativeEventInfo,
-    RowDragging as ComponentRowDragging,
-    RowDraggingEventInfo,
-    RowDraggingTemplateData,
-    RowInsertedInfo,
-    RowInsertingInfo,
-    RowKeyInfo,
-    RowRemovedInfo,
-    RowRemovingInfo,
-    RowUpdatedInfo,
-    RowUpdatingInfo,
-    RowValidatingInfo,
-    SavingInfo,
-    ScrollingBase as ComponentScrollingBase,
-    SelectionBase as ComponentSelectionBase,
-    SelectionChangedInfo,
-    SelectionColumnDisplayMode,
-    SummaryType,
-    ToolbarPreparingInfo,
-    AIColumnRequestCreatingInfo,
+  AdaptiveDetailRowPreparingInfo,
+  ColumnBase as ComponentColumnBase,
+  ColumnButtonBase as ComponentColumnButtonBase,
+  GridsContextMenuTarget,
+  EditingBase as ComponentEditingBase,
+  EditingTextsBase as ComponentEditingTextsBase,
+  DataChangeInfo,
+  DataErrorOccurredInfo,
+  DragDropInfo,
+  DragReorderInfo,
+  DragStartEventInfo,
+  FilterPanel as ComponentFilterPanel,
+  FilterPanelCustomizeTextArg as ComponentFilterPanelCustomizeTextArg,
+  GridBase,
+  GridBaseOptions,
+  GroupExpandMode,
+  KeyDownInfo,
+  NewRowInfo,
+  NewRowPosition,
+  PagingBase as ComponentPaging,
+  ReducedNativeEventInfo,
+  RowDragging as ComponentRowDragging,
+  RowDraggingEventInfo,
+  RowDraggingTemplateData,
+  RowInsertedInfo,
+  RowInsertingInfo,
+  RowKeyInfo,
+  RowRemovedInfo,
+  RowRemovingInfo,
+  RowUpdatedInfo,
+  RowUpdatingInfo,
+  RowValidatingInfo,
+  SavingInfo,
+  ScrollingBase as ComponentScrollingBase,
+  SelectionBase as ComponentSelectionBase,
+  SelectionChangedInfo,
+  SelectionColumnDisplayMode,
+  SummaryType,
+  ToolbarPreparingInfo,
+  AIColumnRequestCreatingInfo,
+  AIAssistantRequestCreatingInfo,
 } from '../common/grids';
 
 export {
@@ -258,6 +259,14 @@ export type GridBaseColumn<TRowData = any> = ColumnBase<TRowData>;
  */
 export type GridBaseColumnButton = ColumnButtonBase;
 
+/**
+ * @docid _ui_data_grid_AIAssistantRequestCreatingEvent
+ * @public
+ * @type object
+ * @inherits EventInfo,Cancelable,AIAssistantRequestCreatingInfo
+ */
+export type AIAssistantRequestCreatingEvent<TRowData = any, TKey = any> = EventInfo<dxDataGrid<TRowData, TKey>> & Cancelable & AIAssistantRequestCreatingInfo;
+
 /**
  * @docid _ui_data_grid_AdaptiveDetailRowPreparingEvent
  * @public
@@ -2446,6 +2455,7 @@ export type Row<TRowData = any, TKey = any> = {
 
 /** @public */
 export type ExplicitTypes<TRowData, TKey> = {
+  AIAssistantRequestCreatingEvent: AIAssistantRequestCreatingEvent<TRowData, TKey>;
   AdaptiveDetailRowPreparingEvent: AdaptiveDetailRowPreparingEvent<TRowData, TKey>;
   CellClickEvent: CellClickEvent<TRowData, TKey>;
   CellDblClickEvent: CellDblClickEvent<TRowData, TKey>;
@@ -2546,6 +2556,11 @@ type EventsIntegrityCheckingHelper = CheckedEvents<FilterOutHidden<Properties>,
 * @hidden
 */
 type Events = {
+/**
+ * @docid dxDataGridOptions.onAIAssistantRequestCreating
+ * @type_function_param1 e:{ui/data_grid:AIAssistantRequestCreatingEvent}
+ */
+onAIAssistantRequestCreating?: ((e: AIAssistantRequestCreatingEvent) => void);
 /**
  * @docid dxDataGridOptions.onAdaptiveDetailRowPreparing
  * @type_function_param1 e:{ui/data_grid:AdaptiveDetailRowPreparingEvent}

packages/devextreme/js/ui/data_grid_types.d.ts

@@ -112,6 +112,7 @@ export {
   RowDraggingReorderEvent,
   ColumnButtonClickEvent,
   AIColumnRequestCreatingEvent,
+  AIAssistantRequestCreatingEvent,
   ColumnButtonTemplateData,
   ColumnCellTemplateData,
   ColumnEditCellTemplateData,

packages/devextreme/js/ui/tree_list.d.ts

@@ -62,6 +62,7 @@ import {
     SelectionChangedInfo,
     ToolbarPreparingInfo,
     AIColumnRequestCreatingInfo,
+    AIAssistantRequestCreatingInfo,
 } from '../common/grids';
 
 import { dxToolbarItem } from './toolbar';
@@ -181,6 +182,14 @@ export type TreeListFilterMode = 'fullBranch' | 'withAncestors' | 'matchOnly';
 /** @public */
 export type Scrollable = Omit<dxScrollable, '_templateManager' | '_cancelOptionChange' | '_getTemplate' | '_invalidate' | '_refresh' | '_notifyOptionChanged' | '_createElement'>;
 
+/**
+* @docid _ui_tree_list_AIAssistantRequestCreatingEvent
+* @public
+* @type object
+* @inherits EventInfo,Cancelable,AIAssistantRequestCreatingInfo
+*/
+export type AIAssistantRequestCreatingEvent<TRowData = any, TKey = any> = EventInfo<dxTreeList<TRowData, TKey>> & Cancelable & AIAssistantRequestCreatingInfo;
+
 /**
  * @docid _ui_tree_list_AdaptiveDetailRowPreparingEvent
  * @public
@@ -1799,6 +1808,7 @@ export type Row<TRowData = any, TKey = any> = {
 
 /** @public */
 export type ExplicitTypes<TRowData, TKey> = {
+  AIAssistantRequestCreatingEvent: AIAssistantRequestCreatingEvent<TRowData, TKey>;
   AdaptiveDetailRowPreparingEvent: AdaptiveDetailRowPreparingEvent<TRowData, TKey>;
   CellClickEvent: CellClickEvent<TRowData, TKey>;
   CellDblClickEvent: CellDblClickEvent<TRowData, TKey>;
@@ -1876,6 +1886,11 @@ type EventsIntegrityCheckingHelper = CheckedEvents<FilterOutHidden<Properties>,
 */
 type Events = {
 /**
+ * @docid dxTreeListOptions.onAIAssistantRequestCreating
+ * @type_function_param1 e:{ui/tree_list:AIAssistantRequestCreatingEvent}
+ */
+onAIAssistantRequestCreating?: ((e: AIAssistantRequestCreatingEvent) => void);
+ /**
  * @docid dxTreeListOptions.onAdaptiveDetailRowPreparing
  * @type_function_param1 e:{ui/tree_list:AdaptiveDetailRowPreparingEvent}
  */

packages/devextreme/js/ui/tree_list_types.d.ts

@@ -106,6 +106,7 @@ export {
   RowDraggingReorderEvent,
   ColumnButtonClickEvent,
   AIColumnRequestCreatingEvent,
+  AIAssistantRequestCreatingEvent,
   ColumnButtonTemplateData,
   ColumnCellTemplateData,
   ColumnEditCellTemplateData,