@progress/kendo-vue-conversational-ui 5.3.0-dev.202410141143 → 5.3.0-develop.1

package/index.d.mts

@@ -0,0 +1,378 @@
+/**
+ * @license
+ *-------------------------------------------------------------------------------------------
+ * Copyright © 2024 Progress Software Corporation. All rights reserved.
+ * Licensed under commercial license. See LICENSE.md in the package root for more information
+ *-------------------------------------------------------------------------------------------
+ */
+import { ComponentOptionsMixin } from 'vue';
+import { ComponentProvideOptions } from 'vue';
+import { DefineComponent } from 'vue';
+import { ExtractPropTypes } from 'vue';
+import { PropType } from 'vue';
+import { PublicProps } from 'vue';
+import { SVGIcon } from '@progress/kendo-svg-icons';
+import { SVGIcon as SVGIcon_2 } from '@progress/kendo-vue-common';
+
+/**
+ * @hidden
+ */
+export declare const AIPrompt: DefineComponent<ExtractPropTypes<    {
+activeView: {
+type: PropType<string>;
+required: true;
+};
+dir: PropType<string>;
+toolbarItems: PropType<AIPromptToolbarItemInterface[]>;
+outputs: PropType<AIPromptOutputInterface[]>;
+promptPlaceholder: PropType<string>;
+}>, {}, {
+contextState: AIPromptContextInterface;
+}, {}, {
+onStateAction(action: StateActionInterface): void;
+onActiveViewChange(event: string): void;
+onPromptRequest(prompt?: string, outputItem?: AIPromptOutputInterface): void;
+onCommandExecute(event: AIPromptCommandInterface): void;
+}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<ExtractPropTypes<    {
+activeView: {
+type: PropType<string>;
+required: true;
+};
+dir: PropType<string>;
+toolbarItems: PropType<AIPromptToolbarItemInterface[]>;
+outputs: PropType<AIPromptOutputInterface[]>;
+promptPlaceholder: PropType<string>;
+}>> & Readonly<{}>, {}, {}, {}, {}, string, () => {
+kendoAIPrompt: any;
+}, true, {}, any>;
+
+/**
+ * An interface for the Command view command.
+ */
+export declare interface AIPromptCommandInterface extends CommandItemInterface {
+    /**
+     * Collection with nested commands.
+     */
+    children?: CommandItemInterface[];
+}
+
+/**
+ * @hidden
+ */
+export declare const AIPromptCommandsView: DefineComponent<ExtractPropTypes<    {
+commands: PropType<AIPromptCommandInterface[]>;
+}>, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<ExtractPropTypes<    {
+commands: PropType<AIPromptCommandInterface[]>;
+}>> & Readonly<{}>, {}, {}, {}, {}, string, ComponentProvideOptions, true, {}, any>;
+
+/**
+ * The props of the AIPromptCommandsView component.
+ */
+export declare interface AIPromptCommandsViewProps {
+    /**
+     * The collection of commands that will be rendered in the Command view.
+     */
+    commands?: AIPromptCommandInterface[];
+    /**
+     * Fires each time the user clicks over a Command view command. Exposes the selected command as event data.
+     */
+    onCommandexecute?: (command: CommandItemInterface) => void;
+}
+
+/**
+ * @hidden
+ */
+export declare const AIPromptContent: DefineComponent<    {}, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<{}> & Readonly<{}>, {}, {}, {}, {}, string, ComponentProvideOptions, true, {}, any>;
+
+/**
+ * The AIPrompt context that is passed to the view.
+ */
+declare interface AIPromptContextInterface {
+    activeView?: string;
+    onPromptRequest?: (prompt?: string, outputItem?: AIPromptOutputInterface) => void;
+    onCommandExecute?: (command: AIPromptCommandInterface) => void;
+    onActiveViewChange?: (view: string) => void;
+    onStateAction?: (action: StateActionInterface) => void;
+}
+
+/**
+ * @hidden
+ */
+export declare const AIPromptFooter: DefineComponent<    {}, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<{}> & Readonly<{}>, {}, {}, {}, {}, string, ComponentProvideOptions, true, {}, any>;
+
+/**
+ * @hidden
+ */
+export declare const AIPromptHeader: DefineComponent<ExtractPropTypes<    {
+activeView: PropType<string>;
+toolbarItems: PropType<AIPromptToolbarItemInterface[]>;
+onActiveviewchange: PropType<(event: any) => void>;
+}>, {}, {}, {}, {
+handleClick(viewName: string): void;
+}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<ExtractPropTypes<    {
+activeView: PropType<string>;
+toolbarItems: PropType<AIPromptToolbarItemInterface[]>;
+onActiveviewchange: PropType<(event: any) => void>;
+}>> & Readonly<{}>, {}, {}, {}, {}, string, ComponentProvideOptions, true, {}, any>;
+
+export declare interface AIPromptOutputInterface {
+    /**
+     * The unique identifier of the command.
+     */
+    id: string | number;
+    /**
+     * An optional custom title for the prompt output.
+     */
+    title?: string;
+    /**
+     * An optional custom sub title for the prompt output.
+     */
+    subTitle?: string;
+    /**
+     * The prompt that initiated the output generation.
+     */
+    prompt?: string;
+    /**
+     * The class of the prompt that is rendered on the output card.
+     */
+    class?: string;
+    /**
+     * The text content of the prompt output.
+     */
+    responseContent: string;
+    /**
+     * Specifies if the prompt generation was initiated via the retry button.
+     */
+    isRetry?: boolean;
+    /**
+     * The prompt output rating.
+     */
+    ratingType?: AIPromptOutputRating;
+    /**
+     * Optionally specifies a command, if the prompt generation was triggered via a command.
+     */
+    command?: AIPromptCommandInterface;
+}
+
+/**
+ * Enum option for the output rating
+ */
+export declare enum AIPromptOutputRating {
+    /**
+     * Positive output rating
+     */
+    positive = "positive",
+    /**
+     * Negative output rating
+     */
+    negative = "negative"
+}
+
+/**
+ * @hidden
+ */
+export declare const AIPromptOutputView: DefineComponent<ExtractPropTypes<    {
+outputs: PropType<AIPromptOutputInterface[]>;
+outputCard: PropType<string | Function>;
+showOutputRating: PropType<boolean>;
+}>, {}, {
+copiedIndex: number;
+copyButtonIcon: SVGIcon;
+}, {}, {
+retryPrompt(output: AIPromptOutputInterface): void;
+copyToClipboard(output: AIPromptOutputInterface, index: number): void;
+outputRating(output: AIPromptOutputInterface, ratingType: AIPromptOutputRating): void;
+}, ComponentOptionsMixin, ComponentOptionsMixin, {
+copy: any;
+retry: any;
+rating: any;
+}, string, PublicProps, Readonly<ExtractPropTypes<    {
+outputs: PropType<AIPromptOutputInterface[]>;
+outputCard: PropType<string | Function>;
+showOutputRating: PropType<boolean>;
+}>> & Readonly<{
+onCopy?: (...args: any[] | unknown[]) => any;
+onRating?: (...args: any[] | unknown[]) => any;
+onRetry?: (...args: any[] | unknown[]) => any;
+}>, {}, {}, {}, {}, string, ComponentProvideOptions, true, {}, any>;
+
+/**
+ * The props of the AIPromptOutputView component.
+ */
+export declare interface AIPromptOutputViewProps {
+    /**
+     * The collection of generated prompt outputs that will be rendered in the Output view.
+     */
+    outputs?: AIPromptOutputInterface[];
+    /**
+     * Represents a template that allows you to define custom Card .It accepts string of a named slot or a render function.
+     * The custom fields will override the default one.
+     */
+    outputCard?: string | Function;
+    /**
+     * Specifies if the rating buttons in each card will be rendered.
+     * By default, rating buttons are not rendered.
+     *
+     * @default false
+     */
+    showOutputRating?: boolean;
+    /**
+     * Fires each time the user clicks Retry button in the card.
+     */
+    onRetry?: (output: AIPromptOutputInterface) => void;
+    /**
+     * Fires each time the user clicks Copy button in the card.
+     */
+    onCopy?: (content: string) => void;
+    /**
+     * Fires each time the user clicks a rating button in the card.
+     */
+    onRating?: (output: AIPromptOutputInterface, ratingType: AIPromptOutputRating) => void;
+}
+
+/**
+ * The props of the AIPrompt component.
+ */
+export declare interface AIPromptProps {
+    /**
+     * Name of the active view.
+     */
+    activeView: string;
+    /**
+     * Collection with items that will override the default Toolbar items.
+     */
+    toolbarItems?: AIPromptToolbarItemInterface[];
+    /**
+     * The collection of generated prompt outputs that will be rendered in the Output view.
+     */
+    outputs?: AIPromptOutputInterface[];
+    /**
+     * The placeholder text for the Prompt view textarea.
+     */
+    promptPlaceholder?: string;
+    /**
+     * The direction of the Prompt.
+     */
+    dir?: string;
+    /**
+     * The onActiveViewChange event handler of the Kendo UI for Vue AIPrompt component.
+     * Fires when active view is changed. Exposes the name of the new active view as event data.
+     */
+    onActiveviewchange?: (name: string) => void;
+    /**
+     * The onCommandExecute event handler of the Kendo UI for Vue AIPrompt component.
+     * Fires each time the user clicks a command in the Command view. Exposes the selected command as event data.
+     */
+    onCommandexecute?: (command: AIPromptCommandInterface) => void;
+    /**
+     * The onPromptRequest event handler of the Kendo UI for Vue AIPrompt component.
+     * Fires when user clicks the `Generate` button in the Prompt view.
+     */
+    onPromptrequest?: (prompt?: string, outputItem?: AIPromptOutputInterface) => void;
+}
+
+/**
+ * An interface for the AIPromptToolbarItem.
+ */
+export declare interface AIPromptToolbarItemInterface {
+    /**
+     * Defines the name of the view witch is related to.
+     */
+    name: string;
+    /**
+     * Defines the svgIcon used in the Toolbar button.
+     */
+    buttonIcon?: SVGIcon;
+    /**
+     * Defines the text used in the Toolbar button.
+     */
+    buttonText?: string;
+    /**
+     * Defines custom content for the item. It can be either a name of a named slot or a rendered function.
+     */
+    content?: string | Function | Object;
+}
+
+/**
+ * @hidden
+ */
+export declare const AIPromptView: DefineComponent<ExtractPropTypes<    {
+promptInput: PropType<any>;
+generateButton: PropType<any>;
+promptValue: PropType<string>;
+promptSuggestions: PropType<string[]>;
+}>, {}, {
+value: string;
+}, {
+computedValue(): any;
+}, {
+handleOnRequest(): void;
+handleSuggestionSelect(suggestion: string): void;
+onTextChange(event: any): void;
+}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<ExtractPropTypes<    {
+promptInput: PropType<any>;
+generateButton: PropType<any>;
+promptValue: PropType<string>;
+promptSuggestions: PropType<string[]>;
+}>> & Readonly<{}>, {}, {}, {}, {}, string, ComponentProvideOptions, true, {}, any>;
+
+/**
+ * @hidden
+ */
+export declare const AIPromptViewRender: DefineComponent<ExtractPropTypes<    {
+name: PropType<string>;
+}>, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<ExtractPropTypes<    {
+name: PropType<string>;
+}>> & Readonly<{}>, {}, {}, {}, {}, string, ComponentProvideOptions, true, {}, any>;
+
+/**
+ * The props of the AIPromptViewRender component.
+ */
+export declare interface AIPromptViewRenderProps {
+    /**
+     * Specifies the name of the view.
+     */
+    name: string;
+}
+
+/**
+ * @hidden
+ */
+declare interface CommandItemInterface {
+    /**
+     * The unique identifier of the command.
+     */
+    id: string;
+    /**
+     * Specifies the command text.
+     */
+    text: string;
+    /**
+     * Specifies the name of the SVG icon that will be rendered for the command.
+     */
+    svgIcon?: SVGIcon_2;
+}
+
+/**
+ * Specifies the default values for Commands view Toolbar.
+ */
+export declare const commandsViewDefaults: AIPromptToolbarItemInterface;
+
+/**
+ * Specifies the default values for Output view Toolbar.
+ */
+export declare const outputViewDefaults: AIPromptToolbarItemInterface;
+
+/**
+ * Specifies the default values for Prompt view Toolbar.
+ */
+export declare const promptViewDefaults: AIPromptToolbarItemInterface;
+
+/**
+ * @hidden
+ */
+declare interface StateActionInterface {
+    activeView: string;
+}
+
+export { }