Chat: Improve MessageBase.type typings (#34048)

Co-authored-by: marker dao ® <youdontknow@marker-dao.eth>

Author: marker-dao

packages/devextreme-angular/src/ui/chat/nested/chat-item-dxi.ts

@@ -14,7 +14,7 @@ import {
 
 
 
-import type { Attachment, User } from 'devextreme/ui/chat';
+import type { Attachment, User, MessageType } from 'devextreme/ui/chat';
 
 import {
     DxIntegrationModule,
@@ -119,10 +119,10 @@ export class DxiChatChatItemComponent extends CollectionNestedOption {
     }
 
     @Input()
-    get type(): string | undefined {
+    get type(): MessageType {
         return this._getOption('type');
     }
-    set type(value: string | undefined) {
+    set type(value: MessageType) {
         this._setOption('type', value);
     }
 

packages/devextreme-angular/src/ui/chat/nested/item-dxi.ts

@@ -18,7 +18,7 @@ import {
 import { DOCUMENT } from '@angular/common';
 
 
-import type { Attachment, User } from 'devextreme/ui/chat';
+import type { Attachment, User, MessageType } from 'devextreme/ui/chat';
 import type { ButtonType } from 'devextreme/common';
 
 import {
@@ -130,10 +130,10 @@ export class DxiChatItemComponent extends CollectionNestedOption implements Afte
     }
 
     @Input()
-    get type(): string | undefined | ButtonType {
+    get type(): MessageType | ButtonType | string {
         return this._getOption('type');
     }
-    set type(value: string | undefined | ButtonType) {
+    set type(value: MessageType | ButtonType | string) {
         this._setOption('type', value);
     }
 

packages/devextreme-angular/src/ui/nested/base/button-group-item-dxi.ts

@@ -98,10 +98,10 @@ export abstract class DxiButtonGroupItem extends CollectionNestedOption {
         this._setOption('stylingMode', value);
     }
 
-    get type(): ButtonType | string | undefined {
+    get type(): ButtonType | string {
         return this._getOption('type');
     }
-    set type(value: ButtonType | string | undefined) {
+    set type(value: ButtonType | string) {
         this._setOption('type', value);
     }
 

packages/devextreme-metadata/make-angular-metadata.ts

@@ -51,6 +51,8 @@ Ng.makeMetadata({
     removeMembers(/\/grids:AIAssistant/),
     removeMembers(/\/calendar:dxCalendarOptions.todayButtonText/),
     removeMembers(/\/card_view:/),
+    removeMembers(/\/chat:MessageType/),
+    removeMembers(/\/chat:MessageBase.type/),
     removeMembers(/\/chat:TextMessage.attachments/),
     removeMembers(
       /\/chat:dxChatOptions\.(fileUploaderOptions|inputFieldText|sendButtonOptions|speechToTextOptions|suggestions|onAttachmentDownloadClick)/,

packages/devextreme-react/src/chat.ts

@@ -8,7 +8,7 @@ import dxChat, {
 import { Component as BaseComponent, IHtmlOptions, ComponentRef, NestedComponentMeta } from "./core/component";
 import NestedOption from "./core/nested-option";
 
-import type { Message, AttachmentDownloadClickEvent, DisposingEvent, InitializedEvent, MessageDeletedEvent, MessageDeletingEvent, MessageEditCanceledEvent, MessageEditingStartEvent, MessageEnteredEvent, MessageUpdatedEvent, MessageUpdatingEvent, TypingEndEvent, TypingStartEvent, Attachment as ChatAttachment, User as ChatUser, SendButtonAction, SendButtonClickEvent } from "devextreme/ui/chat";
+import type { Message, AttachmentDownloadClickEvent, DisposingEvent, InitializedEvent, MessageDeletedEvent, MessageDeletingEvent, MessageEditCanceledEvent, MessageEditingStartEvent, MessageEnteredEvent, MessageUpdatedEvent, MessageUpdatingEvent, TypingEndEvent, TypingStartEvent, Attachment as ChatAttachment, User as ChatUser, MessageType, SendButtonAction, SendButtonClickEvent } from "devextreme/ui/chat";
 import type { DisposingEvent as FileUploaderDisposingEvent, InitializedEvent as FileUploaderInitializedEvent, BeforeSendEvent, ContentReadyEvent, DropZoneEnterEvent, DropZoneLeaveEvent, FilesUploadedEvent, OptionChangedEvent, ProgressEvent, UploadAbortedEvent, UploadedEvent, UploadErrorEvent, UploadStartedEvent, ValueChangedEvent, UploadHttpMethod, FileUploadMode } from "devextreme/ui/file_uploader";
 import type { DisposingEvent as SpeechToTextDisposingEvent, InitializedEvent as SpeechToTextInitializedEvent, ContentReadyEvent as SpeechToTextContentReadyEvent, OptionChangedEvent as SpeechToTextOptionChangedEvent, CustomSpeechRecognizer as SpeechToTextCustomSpeechRecognizer, EndEvent, ErrorEvent, ResultEvent, StartClickEvent, StopClickEvent, SpeechRecognitionConfig as SpeechToTextSpeechRecognitionConfig } from "devextreme/ui/speech_to_text";
 import type { DisposingEvent as ButtonGroupDisposingEvent, InitializedEvent as ButtonGroupInitializedEvent, ContentReadyEvent as ButtonGroupContentReadyEvent, OptionChangedEvent as ButtonGroupOptionChangedEvent, dxButtonGroupItem, ItemClickEvent, SelectionChangedEvent } from "devextreme/ui/button_group";
@@ -187,7 +187,7 @@ type IChatItemProps = React.PropsWithChildren<{
   src?: string;
   text?: string;
   timestamp?: Date | number | string;
-  type?: string | undefined;
+  type?: MessageType;
 }>
 const _componentChatItem = (props: IChatItemProps) => {
   return React.createElement(NestedOption<IChatItemProps>, {
@@ -367,7 +367,7 @@ type IItemProps = React.PropsWithChildren<{
   src?: string;
   text?: string;
   timestamp?: Date | number | string;
-  type?: string | undefined | ButtonType;
+  type?: MessageType | ButtonType | string;
   disabled?: boolean;
   elementAttr?: Record<string, any>;
   hint?: string;

packages/devextreme-vue/src/chat.ts

@@ -25,6 +25,7 @@ import {
  SendButtonProperties,
  User,
  Attachment,
+ MessageType,
  SendButtonAction,
  SendButtonClickEvent,
 } from "devextreme/ui/chat";
@@ -359,7 +360,7 @@ const DxChatItemConfig = {
     src: String,
     text: String,
     timestamp: [Date, Number, String],
-    type: String
+    type: String as PropType<MessageType>
   }
 };
 
@@ -618,7 +619,7 @@ const DxItemConfig = {
     template: {},
     text: String,
     timestamp: [Date, Number, String],
-    type: String as PropType<string | ButtonType>,
+    type: String as PropType<MessageType | ButtonType | string>,
     visible: Boolean
   }
 };

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

@@ -249,6 +249,13 @@ export type Attachment = {
     [key: string]: any;
 };
 
+/**
+ * @docid
+ * @namespace DevExpress.ui.dxChat
+ * @public
+ */
+export type MessageType = 'text' | 'image';
+
 /**
  * @docid
  * @namespace DevExpress.ui.dxChat
@@ -263,11 +270,9 @@ export type MessageBase = {
     id?: number | string;
     /**
      * @docid
-     * @default undefined
-     * @type string|undefined
      * @public
      */
-    type?: 'text' | 'image' | undefined;
+    type?: MessageType;
     /**
      * @docid
      * @public

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

@@ -17,6 +17,7 @@ export {
   User,
   Alert,
   Attachment,
+  MessageType,
   TextMessage,
   ImageMessage,
   Message,

packages/devextreme/ts/dx.all.d.ts

@@ -34518,7 +34518,7 @@ declare module DevExpress.ui.dxChat {
     /**
      * [descr:MessageBase.type]
      */
-    type?: 'text' | 'image' | undefined;
+    type?: MessageType;
     /**
      * [descr:MessageBase.timestamp]
      */
@@ -34534,6 +34534,10 @@ declare module DevExpress.ui.dxChat {
 
     [key: string]: any;
   };
+  /**
+   * [descr:MessageType]
+   */
+  export type MessageType = 'text' | 'image';
   /**
    * [descr:SendButtonProperties]
    */