Chat: Improve MessageBase.type typings (#34058)

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

Author: marker-dao

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

@@ -12,7 +12,7 @@ import {
 
 
 
-import { User } from 'devextreme/ui/chat';
+import { User, MessageType } from 'devextreme/ui/chat';
 
 import {
     DxIntegrationModule,
@@ -102,10 +102,10 @@ export class DxiChatItemComponent 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/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

@@ -11,6 +11,8 @@ Ng.makeMetadata({
   },
   mutations: [
     removeMembers(/\/card_view:/),
+    removeMembers(/\/chat:MessageType/),
+    removeMembers(/\/chat:MessageBase.type/),
     removeMembers(/\/scheduler:Toolbar/),
     removeMembers(/\/stepper:/),
     removeMembers(/\/tree_list:dxTreeListColumnButton.onClick/),

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, DisposingEvent, InitializedEvent, MessageDeletedEvent, MessageDeletingEvent, MessageEditCanceledEvent, MessageEditingStartEvent, MessageEnteredEvent, MessageUpdatedEvent, MessageUpdatingEvent, TypingEndEvent, TypingStartEvent, User as ChatUser } from "devextreme/ui/chat";
+import type { Message, DisposingEvent, InitializedEvent, MessageDeletedEvent, MessageDeletingEvent, MessageEditCanceledEvent, MessageEditingStartEvent, MessageEnteredEvent, MessageUpdatedEvent, MessageUpdatingEvent, TypingEndEvent, TypingStartEvent, User as ChatUser, MessageType } from "devextreme/ui/chat";
 import type { Format } from "devextreme/common";
 
 
@@ -190,7 +190,7 @@ type IItemProps = React.PropsWithChildren<{
   src?: string;
   text?: string;
   timestamp?: Date | number | string;
-  type?: string | undefined;
+  type?: MessageType;
 }>
 const _componentItem = (props: IItemProps) => {
   return React.createElement(NestedOption<IItemProps>, {

packages/devextreme-vue/src/chat.ts

@@ -20,6 +20,7 @@ import {
  TypingEndEvent,
  TypingStartEvent,
  User,
+ MessageType,
 } from "devextreme/ui/chat";
 import {
  DataSourceOptions,
@@ -297,7 +298,7 @@ const DxItemConfig = {
     src: String,
     text: String,
     timestamp: [Date, Number, String],
-    type: String
+    type: String as PropType<MessageType>
   }
 };
 

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

@@ -196,6 +196,13 @@ export type Alert = {
     message?: string;
 };
 
+/**
+ * @docid
+ * @namespace DevExpress.ui.dxChat
+ * @public
+ */
+export type MessageType = 'text' | 'image';
+
 /**
  * @docid
  * @namespace DevExpress.ui.dxChat
@@ -210,11 +217,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

@@ -13,6 +13,7 @@ export {
   MessageUpdatedEvent,
   User,
   Alert,
+  MessageType,
   TextMessage,
   ImageMessage,
   Message,

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

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