@progress/kendo-angular-conversational-ui 20.0.0-develop.3 → 20.0.0-develop.5

package/chat/api/action.interface.d.ts

@@ -3,7 +3,7 @@
 * Licensed under commercial license. See LICENSE.md in the project root for more information
 *-------------------------------------------------------------------------------------------*/
 /**
- * Specifies the button type of a quick action ([see example](slug:suggested_actions_chat)).
+ * Specifies the button type of a quick action ([see example](slug:message_chat)).
  * * `openUrl`—Opens a new browser window with the specified URL.
  * * `reply`—Sends the action value as a reply in the Chat.
  * * `call`—Treats the value as a phone number. Similar to clicking a [telephone link](https://css-tricks.com/the-current-state-of-telephone-links/).

package/chat/api/attachment.interface.d.ts

@@ -24,7 +24,7 @@ export interface Attachment {
     subtitle?: string;
 }
 /**
- * Specifies the layout for the message attachments ([see examples](slug:attachments_chat#display-modes)).
+ * Specifies the layout for the message attachments.
  *
  * The supported values are:
  * * `list`—A vertical list.

package/chat/api/chat-file-interface.d.ts

@@ -0,0 +1,41 @@
+/**-----------------------------------------------------------------------------------------
+* Copyright © 2025 Progress Software Corporation. All rights reserved.
+* Licensed under commercial license. See LICENSE.md in the project root for more information
+*-------------------------------------------------------------------------------------------*/
+/**
+ * Represents the files that are part of the Message.
+ */
+export interface ChatFile {
+    /**
+     * Unique identifier for the file.
+     */
+    id: string | number;
+    /**
+     * File name.
+     */
+    name: string;
+    /**
+     * File size in bytes.
+     */
+    size: number;
+    /**
+     * MIME type, e.g., 'application/pdf'
+     */
+    type: string;
+    /**
+     * File extension, e.g., '.pdf', '.jpg'.
+     */
+    extension: string;
+    /**
+     * An in-memory representation of the file.
+     */
+    rawFile?: File;
+    /**
+     * Optional URL to download/view the file.
+     */
+    url?: string;
+    /**
+     * Optional preview image URL.
+     */
+    thumbnailUrl?: string;
+}

package/chat/api/chat-suggestion.interface.d.ts

@@ -0,0 +1,25 @@
+/**-----------------------------------------------------------------------------------------
+* Copyright © 2025 Progress Software Corporation. All rights reserved.
+* Licensed under commercial license. See LICENSE.md in the project root for more information
+*-------------------------------------------------------------------------------------------*/
+/**
+ * Represents the Chat Suggestions that can be displayed above the MessageBox.
+ */
+export interface ChatSuggestion {
+    /**
+     * Unique identifier for the suggestion.
+     */
+    id: string | number;
+    /**
+     * Display text for the suggestion.
+     */
+    text: string;
+    /**
+     * Optional description for the suggestion.
+     */
+    description?: string;
+    /**
+     * Whether the suggestion is disabled.
+     */
+    disabled?: boolean;
+}

package/chat/api/file-action.d.ts

@@ -0,0 +1,42 @@
+/**-----------------------------------------------------------------------------------------
+* Copyright © 2025 Progress Software Corporation. All rights reserved.
+* Licensed under commercial license. See LICENSE.md in the project root for more information
+*-------------------------------------------------------------------------------------------*/
+import { SVGIcon } from "@progress/kendo-svg-icons";
+import { ChatFile } from "./chat-file-interface";
+/**
+ * Defines the structure of a file action in the Chat message.
+ * These actions can be used to perform specific operations on files.
+ */
+export interface FileAction {
+    /**
+     * Unique identifier for the action.
+     */
+    id: string | number;
+    /**
+     * Display text for the action.
+     */
+    label: string;
+    /**
+     * Icon name for the action.
+     */
+    icon?: string;
+    /**
+     * SVG icon object for the action.
+     */
+    svgIcon?: SVGIcon;
+    /**
+     * Whether the action is disabled.
+     */
+    disabled?: boolean;
+}
+export interface FileActionEvent {
+    /**
+     * The file action that was triggered.
+     */
+    action: FileAction;
+    /**
+     * The file associated with the action.
+     */
+    file: ChatFile;
+}

package/chat/api/file-download-event.interface.d.ts

@@ -0,0 +1,21 @@
+/**-----------------------------------------------------------------------------------------
+* Copyright © 2025 Progress Software Corporation. All rights reserved.
+* Licensed under commercial license. See LICENSE.md in the project root for more information
+*-------------------------------------------------------------------------------------------*/
+import { ChatFile } from "./chat-file-interface";
+import { Message } from "./message.interface";
+/**
+ * Represents the arguments for the `download` event.
+ */
+export interface FileDownloadEvent {
+    /**
+     * The file associated with the action.
+     * One file for download from the context menu.
+     * Multiple when the event is triggered by a click on the 'Download all' button.
+     */
+    files: ChatFile[];
+    /**
+     * The message associated with the download action.
+     */
+    message: Message;
+}

package/chat/api/index.d.ts

@@ -4,7 +4,15 @@
 *-------------------------------------------------------------------------------------------*/
 export * from './action.interface';
 export * from './attachment.interface';
+export * from './chat-file-interface';
+export * from './chat-suggestion.interface';
 export * from './execute-action-event';
+export * from './message-action';
+export * from './message-toolbar-visibility';
+export * from './message-width-mode';
 export * from './message.interface';
 export * from './post-message-event';
 export * from './user.interface';
+export * from './file-action';
+export * from './file-download-event.interface';
+export * from './send-button-settings';

package/chat/api/message-action.d.ts

@@ -0,0 +1,42 @@
+/**-----------------------------------------------------------------------------------------
+* Copyright © 2025 Progress Software Corporation. All rights reserved.
+* Licensed under commercial license. See LICENSE.md in the project root for more information
+*-------------------------------------------------------------------------------------------*/
+import { SVGIcon } from "@progress/kendo-svg-icons";
+import { Message } from "./message.interface";
+/**
+ * Defines the structure of a message action in the Chat interface.
+ * These actions can be used to perform specific operations on messages.
+ */
+export interface MessageAction {
+    /**
+     * Unique identifier for the action.
+     */
+    id: string | number;
+    /**
+     * Display text for the action.
+     */
+    label: string;
+    /**
+     * Icon name for the action.
+     */
+    icon?: string;
+    /**
+     * SVG icon object for the action.
+     */
+    svgIcon?: SVGIcon;
+    /**
+     * Whether the action is disabled.
+     */
+    disabled?: boolean;
+}
+export interface MessageActionEvent {
+    /**
+     * The action that was triggered.
+     */
+    action: MessageAction;
+    /**
+     * The message associated with the action.
+     */
+    message: Message;
+}

package/{esm2022/chat/chat.directives.mjs → chat/api/message-toolbar-visibility.d.ts}

@@ -2,7 +2,7 @@
 * Copyright © 2025 Progress Software Corporation. All rights reserved.
 * Licensed under commercial license. See LICENSE.md in the project root for more information
 *-------------------------------------------------------------------------------------------*/
-export { ChatComponent } from './chat.component';
-export { AttachmentTemplateDirective } from './attachment-template.directive';
-export { MessageTemplateDirective } from './message-template.directive';
-export { ChatMessageBoxTemplateDirective } from './message-box.directive';
+/**
+ * Represents the visibility options for the message toolbar.
+ */
+export type MessageToolbarVisibility = 'always' | 'hover' | 'hidden';

package/chat/api/message-width-mode.d.ts

@@ -0,0 +1,10 @@
+/**-----------------------------------------------------------------------------------------
+* Copyright © 2025 Progress Software Corporation. All rights reserved.
+* Licensed under commercial license. See LICENSE.md in the project root for more information
+*-------------------------------------------------------------------------------------------*/
+/**
+ * Defines the possible modes for message width in the chat component.
+ * - `full`: The message takes the full width of the chat container.
+ * - `standard`: (Default) The message width is standard, allowing for a more compact layout.
+ */
+export type MessageWidthMode = 'full' | 'standard';

package/chat/api/message.interface.d.ts

@@ -4,27 +4,45 @@
 *-------------------------------------------------------------------------------------------*/
 import { Action } from './action.interface';
 import { Attachment, AttachmentLayout } from './attachment.interface';
+import { ChatFile } from './chat-file-interface';
 import { User } from './user.interface';
 /**
- * Represents a Chat message ([see example](slug:overview_convui)).
+ * Represents a Chat message ([see example](slug:databinding_chat)).
  *
- * > * You must provide the `author` field.
- * > * [Local users](slug:api_conversational-ui_chatcomponent#user) appear on the right in left-to-right languages and on the left in right-to-left languages.
- * > * If `typing` is `true`, the Chat shows a typing indicator instead of text.
  */
 export interface Message {
+    /**
+     * Sets a unique ID for the message.
+     */
+    id?: string | number;
+    /**
+     * Sets the text content for the message. Some messages may contain only attachments or quick actions.
+     */
+    text?: string;
     /**
      * Sets the author of the message.
      */
     author: User;
     /**
-     * Sets the layout for displaying message attachments.
+     * Sets the time when the message was composed.
      */
-    attachmentLayout?: AttachmentLayout;
+    timestamp?: Date;
+    /**
+     * Sets the current status of the message. The status appears when the message is selected by clicking or through keyboard navigation.
+     */
+    status?: string;
+    /**
+     * Sets the array of files attached to the message.
+     */
+    files?: ChatFile[];
     /**
      * Sets the message attachments.
      */
     attachments?: Attachment[];
+    /**
+     * Sets the layout for displaying message attachments.
+     */
+    attachmentLayout?: AttachmentLayout;
     /**
      * Sets the suggested quick actions to display below this message.
      *
@@ -32,17 +50,17 @@ export interface Message {
      */
     suggestedActions?: Action[];
     /**
-     * Sets the status string for the message. The status appears when the message is selected by clicking or through keyboard navigation.
+     * Indicates if the message is pinned. Pinned messages are displayed at the top of the conversation.
      */
-    status?: string;
+    isPinned?: boolean;
     /**
-     * Sets the text for the message. Some messages may contain only attachments or quick actions.
+     * Sets the ID of the message to which this message is a reply.
      */
-    text?: string;
+    replyToId?: string | number;
     /**
-     * Sets the time when the message was composed.
+     * Indicates if the message has been deleted.
      */
-    timestamp?: Date;
+    isDeleted?: boolean;
     /**
      * Indicates if the message is still being typed by the user. If `true`, the Chat shows a typing indicator.
      */

package/chat/api/send-button-settings.d.ts

@@ -0,0 +1,15 @@
+/**-----------------------------------------------------------------------------------------
+* Copyright © 2025 Progress Software Corporation. All rights reserved.
+* Licensed under commercial license. See LICENSE.md in the project root for more information
+*-------------------------------------------------------------------------------------------*/
+import { ButtonSettings } from '@progress/kendo-angular-buttons';
+/**
+ * Defines the settings for the Send button in the Chat component.
+ * These settings can be customized to change the appearance and behavior of the button.
+ */
+export interface SendButtonSettings extends ButtonSettings {
+    /**
+     * Specifies the class applied to the Button.
+     */
+    buttonClass?: string;
+}

package/chat/api/user.interface.d.ts

@@ -20,4 +20,8 @@ export interface User {
      * To allow unsafe values, such as a blob URI, [mark the value as a `SafeUrl`](https://angular.io/guide/security#bypass-security-apis).
      */
     avatarUrl?: string | SafeUrl;
+    /**
+     * An avatar image alt text for the user.
+     */
+    avatarAltText?: string;
 }

package/chat/attachment.component.d.ts

@@ -3,7 +3,7 @@
 * Licensed under commercial license. See LICENSE.md in the project root for more information
 *-------------------------------------------------------------------------------------------*/
 import { Attachment } from './api/attachment.interface';
-import { AttachmentTemplateDirective } from './attachment-template.directive';
+import { AttachmentTemplateDirective } from './templates/attachment-template.directive';
 import * as i0 from "@angular/core";
 /**
  * @hidden

package/chat/cards/hero-card.component.d.ts

@@ -6,7 +6,7 @@ import { EventEmitter } from '@angular/core';
 import { Action } from '../api/action.interface';
 import * as i0 from "@angular/core";
 /**
- * Represents a Hero Card component ([see example](slug:dialogflow_chat)).
+ * Represents a Hero Card component ([see example](slug:integrations_chat#travel-agent-chat-bot)).
  * Hero cards host a single large image and action buttons with text content.
  *
  * @example

package/chat/chat-file.component.d.ts

@@ -0,0 +1,34 @@
+/**-----------------------------------------------------------------------------------------
+* Copyright © 2025 Progress Software Corporation. All rights reserved.
+* Licensed under commercial license. See LICENSE.md in the project root for more information
+*-------------------------------------------------------------------------------------------*/
+import { EventEmitter } from '@angular/core';
+import { ChatItem } from './chat-item';
+import { ChatFile } from './api/chat-file-interface';
+import { FileInfo } from '@progress/kendo-angular-upload';
+import { SVGIcon } from '@progress/kendo-angular-icons';
+import { LocalizationService } from '@progress/kendo-angular-l10n';
+import * as i0 from "@angular/core";
+/**
+ * @hidden
+ */
+export declare class ChatFileComponent extends ChatItem {
+    private localization;
+    chatFile: ChatFile;
+    removable: boolean;
+    fileActions: any;
+    remove: EventEmitter<ChatFile>;
+    actionClick: EventEmitter<any>;
+    actionsToggle: EventEmitter<boolean>;
+    actionButtonClick: EventEmitter<MouseEvent>;
+    deleteIcon: SVGIcon;
+    moreIcon: SVGIcon;
+    constructor(localization: LocalizationService);
+    fileThumbnail(extension: string): SVGIcon;
+    fileGroupClass(extension: string): string;
+    getTotalFilesSizeMessage(file: FileInfo): string;
+    textFor(key: string): string;
+    focus(): void;
+    static ɵfac: i0.ɵɵFactoryDeclaration<ChatFileComponent, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<ChatFileComponent, "li[chatFile]", never, { "chatFile": { "alias": "chatFile"; "required": false; }; "removable": { "alias": "removable"; "required": false; }; "fileActions": { "alias": "fileActions"; "required": false; }; }, { "remove": "remove"; "actionClick": "actionClick"; "actionsToggle": "actionsToggle"; "actionButtonClick": "actionButtonClick"; }, never, never, true, never>;
+}

package/chat/chat-item.d.ts

@@ -7,5 +7,6 @@
  */
 export declare abstract class ChatItem {
     selected: boolean;
+    hovered: boolean;
     abstract focus(): void;
 }

package/chat/chat-view.d.ts

@@ -47,7 +47,7 @@ export type ViewItem = MessageGroup | AttachmentGroup | ActionGroup | DateMarker
 /**
  * @hidden
  */
-export declare const isAuthor: (user: User, msg: Message) => boolean;
+export declare const isAuthor: (authorId: string | number, msg: Message) => boolean;
 /**
  * @hidden
  */