Skip to content

Commit cd32d94

Browse files
author
marker dao ®
committed
refactor(chat.d.ts && make-angular-metadata.ts): Reorder by alphabet && Remove useless type tag && Remove useless removeMembers call
1 parent 1c7d91d commit cd32d94

3 files changed

Lines changed: 123 additions & 125 deletions

File tree

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

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -49,10 +49,9 @@ Ng.makeMetadata({
4949
removeMembers(/\/grids:ColumnBase.ai/),
5050
removeMembers(/\/calendar:dxCalendarOptions.todayButtonText/),
5151
removeMembers(/\/card_view:/),
52-
removeMembers(/\/chat:SendButton/),
5352
removeMembers(/\/chat:TextMessage.attachments/),
5453
removeMembers(
55-
/\/chat:dxChatOptions\.(fileUploaderOptions|inputFieldText|sendButtonOptions|onAttachmentDownloadClick|speechToTextOptions)/,
54+
/\/chat:dxChatOptions\.(fileUploaderOptions|inputFieldText|sendButtonOptions|speechToTextOptions|onAttachmentDownloadClick)/,
5655
),
5756
removeMembers(/\/form:dxFormOptions\.(aiIntegration|onSmartPasting|onSmartPasted|smartPaste)/),
5857
removeMembers(/\/form:dxFormSimpleItem\.aiOptions/),

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

Lines changed: 57 additions & 58 deletions
Original file line numberDiff line numberDiff line change
@@ -399,34 +399,23 @@ export interface dxChatOptions extends WidgetOptions<dxChat> {
399399
activeStateEnabled?: boolean;
400400
/**
401401
* @docid
402-
* @type dxFileUploaderOptions
403-
* @public
404-
*/
405-
fileUploaderOptions?: Omit<FileUploaderProperties, 'dialogTrigger' | 'showFileList' | 'uploadMode' | 'value'>;
406-
/**
407-
* @docid
408-
* @default true
409-
* @public
410-
*/
411-
focusStateEnabled?: boolean;
412-
/**
413-
* @docid
414-
* @default true
402+
* @default []
415403
* @public
416404
*/
417-
hoverStateEnabled?: boolean;
405+
alerts?: Array<Alert>;
418406
/**
419407
* @docid
420-
* @default { id: new Guid().toString() }
408+
* @type string | Array<Message> | Store | DataSource | DataSourceOptions | null
409+
* @default null
421410
* @public
422411
*/
423-
user?: User;
412+
dataSource?: DataSourceLike<Message> | null;
424413
/**
425414
* @docid
426-
* @fires dxChatOptions.onOptionChanged
415+
* @default 'shortdate'
427416
* @public
428417
*/
429-
items?: Array<Message>;
418+
dayHeaderFormat?: Format;
430419
/**
431420
* @docid
432421
* @public
@@ -437,13 +426,13 @@ export interface dxChatOptions extends WidgetOptions<dxChat> {
437426
* @default false
438427
* @public
439428
*/
440-
allowUpdating?: boolean | ((options: { component?: dxChat; message?: Message }) => boolean);
429+
allowDeleting?: boolean | ((options: { component?: dxChat; message?: Message }) => boolean);
441430
/**
442431
* @docid
443432
* @default false
444433
* @public
445434
*/
446-
allowDeleting?: boolean | ((options: { component?: dxChat; message?: Message }) => boolean);
435+
allowUpdating?: boolean | ((options: { component?: dxChat; message?: Message }) => boolean);
447436
};
448437
/**
449438
* @docid
@@ -454,29 +443,22 @@ export interface dxChatOptions extends WidgetOptions<dxChat> {
454443
emptyViewTemplate?: template | null | ((data: EmptyViewTemplateData, itemElement: DxElement) => string | UserDefinedElement);
455444
/**
456445
* @docid
457-
* @type string | Array<Message> | Store | DataSource | DataSourceOptions | null
458-
* @default null
459-
* @public
460-
*/
461-
dataSource?: DataSourceLike<Message> | null;
462-
/**
463-
* @docid
464-
* @default 'shortdate'
446+
* @type dxFileUploaderOptions
465447
* @public
466448
*/
467-
dayHeaderFormat?: Format;
449+
fileUploaderOptions?: Omit<FileUploaderProperties, 'dialogTrigger' | 'showFileList' | 'uploadMode' | 'value'>;
468450
/**
469451
* @docid
470452
* @default true
471453
* @public
472454
*/
473-
reloadOnChange?: boolean;
455+
focusStateEnabled?: boolean;
474456
/**
475457
* @docid
476-
* @default []
458+
* @default true
477459
* @public
478460
*/
479-
alerts?: Array<Alert>;
461+
hoverStateEnabled?: boolean;
480462
/**
481463
* @docid
482464
* @default ""
@@ -486,10 +468,10 @@ export interface dxChatOptions extends WidgetOptions<dxChat> {
486468
inputFieldText?: TextAreaProperties['value'];
487469
/**
488470
* @docid
489-
* @type SendButtonProperties
471+
* @fires dxChatOptions.onOptionChanged
490472
* @public
491473
*/
492-
sendButtonOptions?: SendButtonProperties;
474+
items?: Array<Message>;
493475
/**
494476
* @docid
495477
* @default null
@@ -505,34 +487,39 @@ export interface dxChatOptions extends WidgetOptions<dxChat> {
505487
messageTimestampFormat?: Format;
506488
/**
507489
* @docid
508-
* @default []
490+
* @default true
509491
* @public
510492
*/
511-
typingUsers?: Array<User>;
493+
reloadOnChange?: boolean;
512494
/**
513495
* @docid
514-
* @default true
515496
* @public
516497
*/
517-
showDayHeaders?: boolean;
498+
sendButtonOptions?: SendButtonProperties;
518499
/**
519500
* @docid
520501
* @default true
521502
* @public
522503
*/
523-
showUserName?: boolean;
504+
showAvatar?: boolean;
524505
/**
525506
* @docid
526507
* @default true
527508
* @public
528509
*/
529-
showAvatar?: boolean;
510+
showDayHeaders?: boolean;
530511
/**
531512
* @docid
532513
* @default true
533514
* @public
534515
*/
535516
showMessageTimestamp?: boolean;
517+
/**
518+
* @docid
519+
* @default true
520+
* @public
521+
*/
522+
showUserName?: boolean;
536523
/**
537524
* @docid
538525
* @default false
@@ -545,6 +532,18 @@ export interface dxChatOptions extends WidgetOptions<dxChat> {
545532
* @public
546533
*/
547534
speechToTextOptions?: Omit<SpeechToTextProperties, 'stylingMode' | 'type'>;
535+
/**
536+
* @docid
537+
* @default []
538+
* @public
539+
*/
540+
typingUsers?: Array<User>;
541+
/**
542+
* @docid
543+
* @default { id: new Guid().toString() }
544+
* @public
545+
*/
546+
user?: User;
548547
/**
549548
* @docid
550549
* @default undefined
@@ -564,75 +563,75 @@ export interface dxChatOptions extends WidgetOptions<dxChat> {
564563
/**
565564
* @docid
566565
* @default undefined
567-
* @type_function_param1 e:{ui/chat:MessageEnteredEvent}
566+
* @type_function_param1 e:{ui/chat:MessageDeletedEvent}
568567
* @action
569568
* @public
570569
*/
571-
onMessageEntered?: ((e: MessageEnteredEvent) => void) | undefined;
570+
onMessageDeleted?: ((e: MessageDeletedEvent) => void) | undefined;
572571
/**
573572
* @docid
574573
* @default undefined
575-
* @type_function_param1 e:{ui/chat:TypingStartEvent}
574+
* @type_function_param1 e:{ui/chat:MessageDeletingEvent}
576575
* @action
577576
* @public
578577
*/
579-
onTypingStart?: ((e: TypingStartEvent) => void) | undefined;
578+
onMessageDeleting?: ((e: MessageDeletingEvent) => void) | undefined;
580579
/**
581580
* @docid
582581
* @default undefined
583-
* @type_function_param1 e:{ui/chat:TypingEndEvent}
582+
* @type_function_param1 e:{ui/chat:MessageEditCanceledEvent}
584583
* @action
585584
* @public
586585
*/
587-
onTypingEnd?: ((e: TypingEndEvent) => void) | undefined;
586+
onMessageEditCanceled?: ((e: MessageEditCanceledEvent) => void) | undefined;
588587
/**
589588
* @docid
590589
* @default undefined
591-
* @type_function_param1 e:{ui/chat:MessageDeletingEvent}
590+
* @type_function_param1 e:{ui/chat:MessageEditingStartEvent}
592591
* @action
593592
* @public
594593
*/
595-
onMessageDeleting?: ((e: MessageDeletingEvent) => void) | undefined;
594+
onMessageEditingStart?: ((e: MessageEditingStartEvent) => void) | undefined;
596595
/**
597596
* @docid
598597
* @default undefined
599-
* @type_function_param1 e:{ui/chat:MessageDeletedEvent}
598+
* @type_function_param1 e:{ui/chat:MessageEnteredEvent}
600599
* @action
601600
* @public
602601
*/
603-
onMessageDeleted?: ((e: MessageDeletedEvent) => void) | undefined;
602+
onMessageEntered?: ((e: MessageEnteredEvent) => void) | undefined;
604603
/**
605604
* @docid
606605
* @default undefined
607-
* @type_function_param1 e:{ui/chat:MessageEditingStartEvent}
606+
* @type_function_param1 e:{ui/chat:MessageUpdatedEvent}
608607
* @action
609608
* @public
610609
*/
611-
onMessageEditingStart?: ((e: MessageEditingStartEvent) => void) | undefined;
610+
onMessageUpdated?: ((e: MessageUpdatedEvent) => void) | undefined;
612611
/**
613612
* @docid
614613
* @default undefined
615-
* @type_function_param1 e:{ui/chat:MessageEditCanceledEvent}
614+
* @type_function_param1 e:{ui/chat:MessageUpdatingEvent}
616615
* @action
617616
* @public
618617
*/
619-
onMessageEditCanceled?: ((e: MessageEditCanceledEvent) => void) | undefined;
618+
onMessageUpdating?: ((e: MessageUpdatingEvent) => void) | undefined;
620619
/**
621620
* @docid
622621
* @default undefined
623-
* @type_function_param1 e:{ui/chat:MessageUpdatingEvent}
622+
* @type_function_param1 e:{ui/chat:TypingEndEvent}
624623
* @action
625624
* @public
626625
*/
627-
onMessageUpdating?: ((e: MessageUpdatingEvent) => void) | undefined;
626+
onTypingEnd?: ((e: TypingEndEvent) => void) | undefined;
628627
/**
629628
* @docid
630629
* @default undefined
631-
* @type_function_param1 e:{ui/chat:MessageUpdatedEvent}
630+
* @type_function_param1 e:{ui/chat:TypingStartEvent}
632631
* @action
633632
* @public
634633
*/
635-
onMessageUpdated?: ((e: MessageUpdatedEvent) => void) | undefined;
634+
onTypingStart?: ((e: TypingStartEvent) => void) | undefined;
636635
}
637636

638637
/**

0 commit comments

Comments
 (0)