@progress/kendo-angular-conversational-ui 19.1.1-develop.2 → 19.1.1

package/ai-prompt/aiprompt.component.d.ts

@@ -12,7 +12,18 @@ import { AIPromptToolbarActionsDirective } from "./templates/toolbar-actions.tem
 import { ToolbarNavigationService } from "./common/toolbar-navigation.service";
 import * as i0 from "@angular/core";
 /**
- * Represents the Kendo UI AIPrompt component for Angular.
+ * Represents the [Kendo UI AIPrompt component for Angular](slug:overview_aiprompt).
+ *
+ * @example
+ * ```html
+ * <kendo-aiprompt
+ *   [promptCommands]="commands"
+ *   [promptSuggestions]="suggestions"
+ *   [promptOutputs]="outputs"
+ *   [showOutputRating]="true"
+ *   (promptRequest)="onPromptRequest($event)">
+ * </kendo-aiprompt>
+ * ```
  */
 export declare class AIPromptComponent implements AfterViewInit, OnDestroy {
     private localization;
@@ -36,50 +47,50 @@ export declare class AIPromptComponent implements AfterViewInit, OnDestroy {
     set activeView(idx: number);
     get activeView(): number;
     /**
-     * The collection of commands that will be rendered in the Command view.
+     * Sets the collection of commands to render in the **Command** view.
      */
     set promptCommands(value: Array<PromptCommand>);
     /**
-     * The collection of suggestions that will be rendered in the Prompt view.
+     * Sets the collection of suggestions to render in the **Prompt** view.
      */
     set promptSuggestions(value: Array<string>);
     /**
-     * The collection of generated prompt outputs that will be rendered in the Output view.
+     * Sets the collection of generated prompt outputs to render in the **Output** view.
      */
     set promptOutputs(value: Array<PromptOutput>);
     /**
-     * Specifies if the rating buttons in each Output view card will be rendered.
-     * By default, rating buttons are not rendered.
-     *
+     * Specifies if the rating buttons appear in each **Output** view card.
+     * By default, the rating buttons do not appear.
      * @default false
      */
     set showOutputRating(value: boolean);
     /**
-     * Fires when the `activeView` property of the component is updated.
-     * Used to provide a two-way binding for the `activeView` property.
+     * Fires when the `activeView` property is updated.
+     * Use this event for two-way binding of the `activeView` property.
      */
     activeViewChange: EventEmitter<number>;
     /**
-     * Fires each time the user clicks the Prompt view Generate button or the Output view Retry button.
-     * To distinguish the source element, use the event's `isRetry` field.
+     * Fires when the user clicks the **Generate** button in the **Prompt** view or the **Retry** button in the **Output** view.
+     * Use the event's `isRetry` field to determine the source element.
      */
     promptRequest: EventEmitter<PromptRequestEvent>;
     /**
-     * Fires each time the user clicks a Command view command. Exposes the selected command as event data.
+     * Fires when the user clicks a **Command** view command.
+     * The event data contains the selected command.
      */
     commandExecute: EventEmitter<CommandExecuteEvent>;
     /**
-     * Fires each time the user clicks any Output view Copy button.
+     * Fires when the user clicks a **Copy** button in any **Output** view card.
      */
     outputCopy: EventEmitter<PromptOutput>;
     /**
-     * Fires each time the user clicks a rating button in any Output view card.
+     * Fires when the user clicks a rating button in any **Output** view card.
      */
     outputRatingChange: EventEmitter<OutputRatingChangeEvent>;
     ngAfterViewInit(): void;
     ngOnDestroy(): void;
     /**
-     * Focuses the first focusable element in the AIPrompt.
+     * Focuses the first focusable element in the AIPrompt component.
      */
     focus(): void;
     private subs;

package/ai-prompt/aiprompt.module.d.ts

@@ -12,24 +12,21 @@ import * as i6 from "./localization/custom-messages.component";
 import * as i7 from "./templates/toolbar-actions.template";
 import * as i8 from "./common/toolbar-focusable.directive";
 /**
- * The [NgModule](link:site.data.urls.angular['ngmodules']) for the AIPrompt component.
+ * Represents the [`NgModule`](link:site.data.urls.angular['ngmodules']) for the AIPrompt component.
  *
  * @example
- * ```ts-no-run
+ * ```ts
  * import { NgModule } from '@angular/core';
- * import { Component } from '@angular/core';
  * import { BrowserModule } from '@angular/platform-browser';
- *
  * import { AIPromptModule } from '@progress/kendo-angular-conversational-ui';
- * import { AppComponent }   from './app.component';
+ * import { AppComponent } from './app.component';
  *
- * _@NgModule({
- *   imports:      [ BrowserModule, AIPromptModule ],
- *   declarations: [ AppComponent ],
- *   bootstrap:    [ AppComponent ]
+ * @NgModule({
+ *   imports: [BrowserModule, AIPromptModule],
+ *   declarations: [AppComponent],
+ *   bootstrap: [AppComponent]
  * })
- *
- * export class AppModule { }
+ * export class AppModule {}
  * ```
  */
 export declare class AIPromptModule {

package/ai-prompt/localization/custom-messages.component.d.ts

@@ -6,8 +6,18 @@ import { LocalizationService } from '@progress/kendo-angular-l10n';
 import { Messages } from './messages';
 import * as i0 from "@angular/core";
 /**
- * Custom component messages override the default component messages.
- * ([see example]({% slug globalization_chat %}#toc-custom-messages)).
+ * Represents the custom messages component of the AIPrompt.
+ *
+ * Use this component to override default messages for the AIPrompt
+ * ([see example](slug:globalization_chat#custom-messages)).
+ *
+ * @example
+ * ```html
+ * <kendo-aiprompt-messages
+ *   promptView="My prompt view"
+ *   outputView="My output view">
+ * </kendo-aiprompt-messages>
+ * ```
  */
 export declare class AIPromptCustomMessagesComponent extends Messages {
     protected service: LocalizationService;

package/ai-prompt/localization/messages.d.ts

@@ -9,39 +9,39 @@ import * as i0 from "@angular/core";
  */
 export declare class Messages extends ComponentMessages {
     /**
-     * The Toolbar button text for the Prompt view.
+     * Sets the Toolbar button text for the **Prompt** view.
      */
     promptView: string;
     /**
-     * The Toolbar button text for the Output view.
+     * Sets the Toolbar button text for the **Output** view.
      */
     outputView: string;
     /**
-     * The text for the Generate button in the Prompt view.
+     * Sets the text for the **Generate** button in the **Prompt** view.
      */
     generateOutput: string;
     /**
-     * The placeholder text for the Prompt View text area.
+     * Sets the placeholder text for the **Prompt** view text area.
      */
     promptPlaceholder: string;
     /**
-     * The Copy button text in each Output view card.
+     * Sets the text for the **Copy** button text in each **Output** view card.
      */
     copyOutput: string;
     /**
-     * The Retry button text in each Output view card.
+     * Sets the **Retry** button text in each **Output** view card.
      */
     retryGeneration: string;
     /**
-     * The title of each Output view card.
+     * Sets the title of each card in the **Output** view.
      */
     outputTitle: string;
     /**
-     * The title of each Output view retry card.
+     * Sets the title of each retry card in the **Output** view.
      */
     outputRetryTitle: string;
     /**
-     * The title of the Prompt suggestions button.
+     * Sets the title of the **Prompt suggestions** button.
      */
     promptSuggestions: string;
     static ɵfac: i0.ɵɵFactoryDeclaration<Messages, never>;

package/ai-prompt/models/command-execute-event.d.ts

@@ -5,16 +5,16 @@
 import { AIPromptComponent } from "../aiprompt.component";
 import { PromptCommand } from "./command.interface";
 /**
- * Arguments for the `commandExecute` event of the AIPrompt.
- * ([see example]({% slug events_aiprompt %})).
+ * Represents the arguments for the `commandExecute` event of the AIPrompt
+ * ([see example](slug:events_aiprompt)).
  */
 export interface CommandExecuteEvent {
     /**
-     * The selected command.
+     * Contains information about the selected command.
      */
     command: PromptCommand;
     /**
-     * The AIPrompt component instance.
+     * Represents the instance of the AIPrompt component.
      */
     sender: AIPromptComponent;
     /**

package/ai-prompt/models/command.interface.d.ts

@@ -4,11 +4,11 @@
 *-------------------------------------------------------------------------------------------*/
 import { SVGIcon } from "@progress/kendo-svg-icons";
 /**
- * An interface for the AIPrompt commands rendered in the Command View.
+ * Defines the interface for the AIPrompt commands rendered in the Command view.
  */
 export interface PromptCommand {
     /**
-     * The unique identifier of the command.
+     * Represents the unique identifier of the command.
      */
     id: string | number;
     /**
@@ -16,11 +16,11 @@ export interface PromptCommand {
      */
     text?: string;
     /**
-     * Specifies the name of the [font icon](slug:icons#icons-list) that will be rendered for the command.
+     * Specifies the name of the [font icon](slug:icons#icons-list) to render for the command.
      */
     icon?: string;
     /**
-     * Specifies the name of the [SVG icon]({% slug svgicon_list %}) that will be rendered for the command.
+     * Specifies the name of the [SVG icon](slug:svgicon_list) to render for the command.
      */
     svgIcon?: SVGIcon;
     /**

package/ai-prompt/models/output-rating-change-event.d.ts

@@ -4,16 +4,16 @@
 *-------------------------------------------------------------------------------------------*/
 import { PromptOutput, PromptOutputRating } from "./prompt-output.interface";
 /**
- * Arguments for the `outputRatingChange` event of the AIPrompt.
- * ([see example]({% slug events_aiprompt %})).
+ * Represents the arguments for the `outputRatingChange` event of the AIPrompt
+ * ([see example](slug:events_aiprompt)).
  */
 export interface OutputRatingChangeEvent {
     /**
-     * The selected command.
+     * Specifies the prompt output for which the rating changes.
      */
     promptOutput: PromptOutput;
     /**
-     * The prompt output rating.
+     * Specifies the prompt output rating.
      */
     rating: PromptOutputRating;
 }

package/ai-prompt/models/prompt-output.interface.d.ts

@@ -3,35 +3,35 @@
 * Licensed under commercial license. See LICENSE.md in the project root for more information
 *-------------------------------------------------------------------------------------------*/
 /**
- * An interface for the AIPrompt outputs rendered in the Output View.
+ * Defines the interface for the AIPrompt outputs rendered in the **Output** view.
  */
 export interface PromptOutput {
     /**
-     * The unique identifier of the prompt output.
+     * Represents the unique identifier of the prompt output.
      */
     id: number | string;
     /**
-     * The text content of the prompt output.
+     * Represents the text content of the prompt output.
      */
     output: string;
     /**
-     * The prompt that initiated the output generation.
+     * Represents the prompt that initiates the output generation.
      */
     prompt: string;
     /**
-     * An optional custom title for the prompt section.
+     * Specifies an optional custom title for the prompt section.
      */
     title?: string;
     /**
-     * Specifies if the prompt generation was initiated via the retry button.
+     * Specifies if the prompt generation is initiated with the **Retry** button.
      */
     isRetry?: boolean;
     /**
-     * Optionally specifies a command id, if the prompt generation was triggered via a command.
+     * (Optional) Specifies a command id, if the prompt generation is triggered via a command.
      */
     commandId?: string | number;
     /**
-     * Optionally specifies the rating for the prompt output.
+     * (Optional) Specifies the rating for the prompt output.
      */
     rating?: PromptOutputRating;
 }

package/ai-prompt/models/prompt-request-event.d.ts

@@ -4,20 +4,20 @@
 *-------------------------------------------------------------------------------------------*/
 import { AIPromptComponent } from "../aiprompt.component";
 /**
- * Arguments for the `promptRequest` event of the AIPrompt.
- * ([see example]({% slug events_aiprompt %})).
+ * Represents the arguments for the `promptRequest` event of the AIPrompt
+ * ([see example](slug:events_aiprompt)).
  */
 export interface PromptRequestEvent {
     /**
-     * The user prompt input.
+     * Represents the user prompt input.
      */
     prompt: string;
     /**
-     * The AIPrompt component instance.
+     * Represents the instance of the AIPrompt component.
      */
     sender: AIPromptComponent;
     /**
-     * Specifies if the event is triggered by the retry button.
+     * Specifies if the event is triggered by the **Retry** button.
      */
     isRetry: boolean;
 }

package/ai-prompt/templates/toolbar-actions.template.d.ts

@@ -5,10 +5,20 @@
 import { TemplateRef } from '@angular/core';
 import * as i0 from "@angular/core";
 /**
- * Represents a template that allows you to define additional ToolBar actions.
- * The actions will be rendered right after all views' ToolBar buttons.
+ * Represents a template for additional Toolbar actions.
+ * The actions appear after the Toolbar buttons for all views.
+ *
  * To define the template, nest an `<ng-template>` tag
  * with the `kendoAIPromptToolbarActionsTemplate` directive inside the `<kendo-aiprompt>` tag.
+ *
+ * @example
+ * ```html
+ * <kendo-aiprompt>
+ *   <ng-template kendoAIPromptToolbarActionsTemplate>
+ *     <button kendoButton>Custom Action</button>
+ *   </ng-template>
+ * </kendo-aiprompt>
+ * ```
  */
 export declare class AIPromptToolbarActionsDirective {
     templateRef: TemplateRef<any>;

package/ai-prompt/views/base-view.d.ts

@@ -20,18 +20,18 @@ export declare abstract class BaseView {
     template: TemplateRef<any>;
     constructor(viewType: ViewType, localization: LocalizationService);
     /**
-     * The text of the ToolBar button corresponding to the view.
+     * Sets the text for the Toolbar button of the current view.
      */
     set buttonText(value: string);
     get buttonText(): string;
     /**
-    * The font icon of the ToolBar button corresponding to the view.
-    */
+     * Sets the font icon for the Toolbar button of the current view.
+     */
     set icon(value: string);
     get icon(): string;
     /**
-    * The SVG icon of the ToolBar button corresponding to the view.
-    */
+     * Sets the SVG icon for the Toolbar button of the current view.
+     */
     set svgIcon(value: SVGIcon);
     get svgIcon(): SVGIcon;
     /**

package/ai-prompt/views/command-view.component.d.ts

@@ -9,7 +9,14 @@ import { BaseView } from './base-view';
 import { AIPromptService } from '../common/aiprompt.service';
 import * as i0 from "@angular/core";
 /**
- * The component for rendering the AIPrompt Command View.
+ * Represents the component that renders the **Command** view of the AIPrompt.
+ *
+ * @example
+ * ```html
+ * <kendo-aiprompt-command-view
+ *      buttonText="My command view">
+ * </kendo-aiprompt-command-view>
+ * ```
  */
 export declare class CommandViewComponent extends BaseView implements OnInit {
     private service;

package/ai-prompt/views/custom-view.component.d.ts

@@ -7,7 +7,17 @@ import { LocalizationService } from '@progress/kendo-angular-l10n';
 import { BaseView } from './base-view';
 import * as i0 from "@angular/core";
 /**
- * The component for rendering an AIPrompt Custom View.
+ * Represents the component that renders a **Custom** view in the AIPrompt.
+ *
+ * @example
+ * ```html
+ * <kendo-aiprompt-custom-view [viewTemplate]="customTemplate">
+ * </kendo-aiprompt-custom-view>
+ *
+ * <ng-template #customTemplate>
+ *   <div>Custom content here</div>
+ * </ng-template>
+ * ```
  */
 export declare class CustomViewComponent extends BaseView {
     constructor(localization: LocalizationService);

package/ai-prompt/views/output-view.component.d.ts

@@ -8,7 +8,14 @@ import { PromptOutput } from '../models/prompt-output.interface';
 import { AIPromptService } from '../common/aiprompt.service';
 import * as i0 from "@angular/core";
 /**
- * The component for rendering the AIPrompt Output View.
+ * Represents the component that renders the **Output** view of the AIPrompt.
+ *
+ * @example
+ * ```html
+ * <kendo-aiprompt-output-view
+ *      buttonText="My output view">
+ * </kendo-aiprompt-output-view>
+ * ```
  */
 export declare class OutputViewComponent extends BaseView {
     private service;

package/ai-prompt/views/prompt-view.component.d.ts

@@ -8,7 +8,14 @@ import { BaseView } from './base-view';
 import { AIPromptService } from '../common/aiprompt.service';
 import * as i0 from "@angular/core";
 /**
- * The component for rendering the AIPrompt Prompt View.
+ * Represents the component that renders the **Prompt** view of the AIPrompt.
+ *
+ * @example
+ * ```html
+ * <kendo-aiprompt-prompt-view
+ *      buttonText="My prompt view">
+ * </kendo-aiprompt-prompt-view>
+ * ```
  */
 export declare class PromptViewComponent extends BaseView {
     private service;

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

@@ -3,29 +3,28 @@
 * Licensed under commercial license. See LICENSE.md in the project root for more information
 *-------------------------------------------------------------------------------------------*/
 /**
- * The button type of the quick action ([see example]({% slug suggested_actions_chat %})).
+ * Specifies the button type of a quick action ([see example](slug:suggested_actions_chat)).
  * * `openUrl`—Opens a new browser window with the specified URL.
  * * `reply`—Sends the action value as a reply in the Chat.
- * * `call`—Treats a value as a phone number. Similar to clicking a [telephone link](https://css-tricks.com/the-current-state-of-telephone-links/).
- * * other—Handled by user code in the [`ExecuteActionEvent`]({% slug api_conversational-ui_executeactionevent %}).
+ * * `call`—Treats the value as a phone number. Similar to clicking a [telephone link](https://css-tricks.com/the-current-state-of-telephone-links/).
+ * * other—Handled by user code in the [`executeAction`](slug:api_conversational-ui_chatcomponent#executeaction) event.
  */
 export type ActionType = 'openUrl' | 'reply' | 'call' | string;
 /**
  * Defines a quick action for a message.
- * The value is interpreted according to the specified action type.
+ * The value is interpreted according to the specified `ActionType`.
  */
 export interface Action {
     /**
-     * A predefined or custom (string) type for the action.
+     * Sets a predefined or custom type for the action.
      */
     type: ActionType;
     /**
-     * The value which is associated with the action.
+     * Sets the value associated with the action.
      */
     value: any;
     /**
-     * An optional title for the quick action.
-     * If omitted, the Chat displays the value instead.
+     * Sets the title for the quick action. If not set, the Chat displays the value.
      */
     title?: string;
 }

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

@@ -3,33 +3,31 @@
 * Licensed under commercial license. See LICENSE.md in the project root for more information
 *-------------------------------------------------------------------------------------------*/
 /**
- * Represents a message attachment ([see example]({% slug attachments_chat %})).
- *
+ * Represents a message attachment ([see example](slug:attachments_chat)).
  */
 export interface Attachment {
     /**
-     * The content type identifier for the attachment.
-     * Typically a MIME type. Can also be any string.
+     * Sets the content type identifier for the attachment. Typically a MIME type or any string.
      */
     contentType: string;
     /**
-     * The content of the attachment.
+     * Sets the content of the attachment.
      */
     content: any;
     /**
-     * (Optional) The title of the attachment.
+     * Sets the title of the attachment.
      */
     title?: string;
     /**
-     * (Optional) The subtitle of the attachment.
+     * Sets the subtitle of the attachment.
      */
     subtitle?: string;
 }
 /**
- * Specifies the layout for the message attachments ([see examples]({% slug attachments_chat %}#toc-display-modes)).
+ * Specifies the layout for the message attachments ([see examples](slug:attachments_chat#display-modes)).
  *
  * The supported values are:
- * * `"list"`—A vertical list.
- * * `"carousel"`—A horizontal, scrollable list. Also called a card deck.
+ * * `list`—A vertical list.
+ * * `carousel`—A horizontal, scrollable list. Also called a card deck.
  */
 export type AttachmentLayout = 'list' | 'carousel';

package/chat/api/execute-action-event.d.ts

@@ -6,16 +6,18 @@ import { PreventableEvent } from "./preventable-event";
 import { Message } from "./message.interface";
 import { Action } from "./action.interface";
 /**
- * Arguments for the `executeAction` event. The `executeAction` event fires when the user clicks
- * a quick action button. Calling `preventDefault()` suppresses the built-in action handler.
+ * Represents the arguments for the `executeAction` event.
+ *
+ * The `executeAction` event fires when the user clicks a quick action button.
+ * Call `preventDefault()` to suppress the built-in action handler.
  */
 export declare class ExecuteActionEvent extends PreventableEvent {
     /**
-     * The action that will be executed.
+     * Represents the action to execute.
      */
     action: Action;
     /**
-     * The message that contains the action.
+     * Represents the message that contains the action.
      */
     message: Message;
     /**

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

@@ -8,49 +8,43 @@ import { User } from './user.interface';
 /**
  * Represents a Chat message ([see example](slug:overview_convui)).
  *
- * > * You are required to provide the `author` field.
- * > * [Local users]({% slug api_conversational-ui_chatcomponent %}#toc-user) are displayed to the
- * right in left-to-right languages and to the left in right-to-left languages.
- * > * If `typing` is set to `true`, the Chat displays a typing indicator instead of text.
+ * > * 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 {
     /**
-     * The author of the message.
+     * Sets the author of the message.
      */
     author: User;
     /**
-     * The layout that will be used for displaying message attachments (if any).
+     * Sets the layout for displaying message attachments.
      */
     attachmentLayout?: AttachmentLayout;
     /**
-     * (Optional) The message attachments.
+     * Sets the message attachments.
      */
     attachments?: Attachment[];
     /**
-     * The suggested quick actions that will be displayed below this message.
+     * Sets the suggested quick actions to display below this message.
      *
-     * > Suggested actions are displayed only for the last message in the conversation.
+     * > Suggested actions appear only for the last message in the conversation.
      */
     suggestedActions?: Action[];
     /**
-     * An optional status string for the message.
-     * The status is displayed when the message is selected—either
-     * by clicking on it or by using the keyboard navigation shortcuts.
+     * Sets the status string for the message. The status appears when the message is selected by clicking or through keyboard navigation.
      */
     status?: string;
     /**
-     * (Optional) The text for the message.
-     * For example, certain messages can contain
-     * only attachments or quick actions.
+     * Sets the text for the message. Some messages may contain only attachments or quick actions.
      */
     text?: string;
     /**
-     * The time at which the message was composed.
+     * Sets the time when the message was composed.
      */
     timestamp?: Date;
     /**
-     * A Boolean value which indicates if the message is still being typed by the user.
-     * If set to `true`, the Chat displays a typing indicator instead of the actual message.
+     * Indicates if the message is still being typed by the user. If `true`, the Chat shows a typing indicator.
      */
     typing?: boolean;
 }

package/chat/api/post-message-event.d.ts

@@ -4,15 +4,14 @@
 *-------------------------------------------------------------------------------------------*/
 import { Message } from './message.interface';
 /**
- * Arguments for the `SendMessage` event.
- *
+ * Describes the arguments for the `sendMessage` event.
  */
 export declare class SendMessageEvent {
     /**
-     * The message which contains the metadata and the user input.
+     * Represents the message that contains the metadata and user input.
      *
-     * > The Chat does not automatically append the message to its data.
-     * > For more information, refer to the article on [data binding]({% slug databinding_chat %}).
+     * > The Chat does not automatically add the message to its data.
+     * > For more information, see [Data Binding](slug:databinding_chat).
      */
     message: Message;
     /**