@quidgest/chatbot 0.4.0 → 0.5.0

package/dist/components/ChatBot/ChatBot.vue.d.ts

@@ -0,0 +1,53 @@
+import { ChatBotProps, AppliedFieldData } from './types';
+
+declare const _default: import('vue').DefineComponent<import('vue').ExtractPropTypes<__VLS_WithDefaults<__VLS_TypePropsToRuntimeProps<ChatBotProps>, {
+    apiEndpoint: string;
+    userImage: string;
+    chatbotImage: string;
+    userPrompt: string;
+    availableAgents: () => never[];
+    agentData: () => {
+        id: string;
+        formId: string;
+        jobId: string;
+    };
+}>>, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {
+    "apply-fields": (fields: AppliedFieldData[]) => void;
+}, string, import('vue').PublicProps, Readonly<import('vue').ExtractPropTypes<__VLS_WithDefaults<__VLS_TypePropsToRuntimeProps<ChatBotProps>, {
+    apiEndpoint: string;
+    userImage: string;
+    chatbotImage: string;
+    userPrompt: string;
+    availableAgents: () => never[];
+    agentData: () => {
+        id: string;
+        formId: string;
+        jobId: string;
+    };
+}>>> & Readonly<{
+    "onApply-fields"?: ((fields: AppliedFieldData[]) => any) | undefined;
+}>, {
+    apiEndpoint: string;
+    userImage: string;
+    chatbotImage: string;
+    availableAgents: import('./types').AvailableAgents[];
+    agentData: import('./types').AgentData;
+}, {}, {}, {}, string, import('vue').ComponentProvideOptions, true, {}, any>;
+export default _default;
+type __VLS_NonUndefinedable<T> = T extends undefined ? never : T;
+type __VLS_TypePropsToRuntimeProps<T> = {
+    [K in keyof T]-?: {} extends Pick<T, K> ? {
+        type: import('vue').PropType<__VLS_NonUndefinedable<T[K]>>;
+    } : {
+        type: import('vue').PropType<T[K]>;
+        required: true;
+    };
+};
+type __VLS_WithDefaults<P, D> = {
+    [K in keyof Pick<P, keyof P>]: K extends keyof D ? __VLS_Prettify<P[K] & {
+        default: D[K];
+    }> : P[K];
+};
+type __VLS_Prettify<T> = {
+    [K in keyof T]: T[K];
+} & {};

package/dist/components/ChatBot/types.d.ts

@@ -0,0 +1,48 @@
+export type ChatBotProps = {
+    apiEndpoint?: string;
+    controllerEndpoint?: string;
+    username: string;
+    projectPath: string;
+    userImage?: string;
+    chatbotImage?: string;
+    dateFormat: string;
+    agentData?: AgentData;
+    availableAgents?: AvailableAgents[];
+};
+export type AvailableAgents = {
+    key: string;
+    value: string;
+    formId: string;
+};
+export type AgentData = {
+    id: string;
+    jobId: string;
+    formId: string;
+};
+export type FieldData = {
+    name: string;
+    type: string;
+    text: string;
+    applied?: boolean;
+};
+export type AppliedFieldData = {
+    name: string;
+    text: unknown;
+};
+export type ChatMessage = {
+    id: number;
+    message: string;
+    date: Date;
+    sender: ChatBotMessageSender;
+    sessionID: string;
+    imagePreviewUrl?: string;
+    isWelcomeMessage?: boolean;
+    fields?: FieldData[];
+};
+export type ChatBotMessageContent = {
+    content: string;
+    type: string;
+    sessionID: string;
+    imageUrl?: string;
+};
+export type ChatBotMessageSender = 'bot' | 'user';

package/dist/components/ChatBotInput/ChatBotInput.vue.d.ts

@@ -0,0 +1,17 @@
+import { ChatBotInputProps, ChatBotImage } from './types';
+
+declare const _default: import('vue').DefineComponent<import('vue').ExtractPropTypes<__VLS_TypePropsToRuntimeProps<ChatBotInputProps>>, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {
+    sendMessage: (prompt: string, image?: ChatBotImage | undefined) => void;
+}, string, import('vue').PublicProps, Readonly<import('vue').ExtractPropTypes<__VLS_TypePropsToRuntimeProps<ChatBotInputProps>>> & Readonly<{
+    onSendMessage?: ((prompt: string, image?: ChatBotImage | undefined) => any) | undefined;
+}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, true, {}, any>;
+export default _default;
+type __VLS_NonUndefinedable<T> = T extends undefined ? never : T;
+type __VLS_TypePropsToRuntimeProps<T> = {
+    [K in keyof T]-?: {} extends Pick<T, K> ? {
+        type: import('vue').PropType<__VLS_NonUndefinedable<T[K]>>;
+    } : {
+        type: import('vue').PropType<T[K]>;
+        required: true;
+    };
+};

package/dist/components/ChatBotInput/index.d.ts

@@ -0,0 +1,5 @@
+import { default as ChatBotInput } from './ChatBotInput.vue';
+import { ChatBotInputProps, ChatBotImage } from './types';
+
+export { ChatBotInput };
+export type { ChatBotInputProps, ChatBotImage };

package/dist/components/ChatBotInput/types.d.ts

@@ -0,0 +1,28 @@
+export type ChatBotInputProps = {
+    /**
+     * If the footer is disabled or not
+     */
+    disabled?: boolean;
+    /**
+     * If the footer is loading or not
+     */
+    loading?: boolean;
+    /**
+     * The message to be sent
+     */
+    userPrompt?: string;
+    /**
+     * The agent to be used
+     */
+    agentId?: string;
+};
+export type ChatBotImage = {
+    /**
+     * The image URL
+     */
+    previewUrl: string;
+    /**
+     * The file object
+     */
+    file: File;
+};

package/dist/components/ChatBotMessage/ChatBotMessage.vue.d.ts

@@ -0,0 +1,41 @@
+import { ChatBotMessageProps } from './';
+import { AppliedFieldData, FieldData } from '../ChatBot/types';
+
+declare const _default: import('vue').DefineComponent<import('vue').ExtractPropTypes<__VLS_WithDefaults<__VLS_TypePropsToRuntimeProps<ChatBotMessageProps>, {
+    sender: string;
+    userImage: undefined;
+    date: () => Date;
+    fields: () => never[];
+}>>, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {
+    "apply-fields": (fields: AppliedFieldData[]) => void;
+}, string, import('vue').PublicProps, Readonly<import('vue').ExtractPropTypes<__VLS_WithDefaults<__VLS_TypePropsToRuntimeProps<ChatBotMessageProps>, {
+    sender: string;
+    userImage: undefined;
+    date: () => Date;
+    fields: () => never[];
+}>>> & Readonly<{
+    "onApply-fields"?: ((fields: AppliedFieldData[]) => any) | undefined;
+}>, {
+    date: Date;
+    sender: import('../ChatBot/types').ChatBotMessageSender;
+    userImage: string;
+    fields: FieldData[];
+}, {}, {}, {}, string, import('vue').ComponentProvideOptions, true, {}, any>;
+export default _default;
+type __VLS_NonUndefinedable<T> = T extends undefined ? never : T;
+type __VLS_TypePropsToRuntimeProps<T> = {
+    [K in keyof T]-?: {} extends Pick<T, K> ? {
+        type: import('vue').PropType<__VLS_NonUndefinedable<T[K]>>;
+    } : {
+        type: import('vue').PropType<T[K]>;
+        required: true;
+    };
+};
+type __VLS_WithDefaults<P, D> = {
+    [K in keyof Pick<P, keyof P>]: K extends keyof D ? __VLS_Prettify<P[K] & {
+        default: D[K];
+    }> : P[K];
+};
+type __VLS_Prettify<T> = {
+    [K in keyof T]: T[K];
+} & {};

package/dist/components/ChatBotMessage/ChatBotMessageButtons.vue.d.ts

@@ -0,0 +1,21 @@
+import { ChatBotMessageButtonsProps } from './';
+
+declare const _default: import('vue').DefineComponent<import('vue').ExtractPropTypes<__VLS_TypePropsToRuntimeProps<ChatBotMessageButtonsProps>>, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {
+    "submit-feedback": (feedback: number, comment: string) => void;
+    "copy-response": () => void;
+    "apply-all": () => void;
+}, string, import('vue').PublicProps, Readonly<import('vue').ExtractPropTypes<__VLS_TypePropsToRuntimeProps<ChatBotMessageButtonsProps>>> & Readonly<{
+    "onSubmit-feedback"?: ((feedback: number, comment: string) => any) | undefined;
+    "onCopy-response"?: (() => any) | undefined;
+    "onApply-all"?: (() => any) | undefined;
+}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, true, {}, any>;
+export default _default;
+type __VLS_NonUndefinedable<T> = T extends undefined ? never : T;
+type __VLS_TypePropsToRuntimeProps<T> = {
+    [K in keyof T]-?: {} extends Pick<T, K> ? {
+        type: import('vue').PropType<__VLS_NonUndefinedable<T[K]>>;
+    } : {
+        type: import('vue').PropType<T[K]>;
+        required: true;
+    };
+};

package/dist/components/ChatBotMessage/index.d.ts

@@ -0,0 +1,6 @@
+import { default as ChatBotMessage } from './ChatBotMessage.vue';
+import { ChatBotMessageProps, ChatBotMessageButtonsProps } from './types';
+import { default as ChatBotMessageButtons } from './ChatBotMessageButtons.vue';
+
+export { ChatBotMessage, ChatBotMessageButtons };
+export type { ChatBotMessageProps, ChatBotMessageButtonsProps };

package/dist/components/ChatBotMessage/types.d.ts

@@ -0,0 +1,46 @@
+import { ChatBotMessageSender, FieldData } from '../ChatBot/types';
+
+export type ChatBotMessageProps = {
+    sender?: ChatBotMessageSender;
+    message?: string;
+    date?: Date;
+    loading?: boolean;
+    /**
+     * Project locale
+     */
+    dateFormat: string;
+    /**
+     * Image preview URL
+     */
+    imagePreviewUrl?: string;
+    /**
+     * Default api endpoint
+     */
+    apiEndpoint: string;
+    /**
+     * Session ID
+     */
+    sessionID?: string;
+    /**
+     * User image
+     */
+    userImage: string;
+    /**
+     * Chatbot image
+     */
+    chatbotImage: string;
+    /**
+     * Flag to mark welcome messages
+     */
+    isWelcomeMessage?: boolean;
+    /**
+     * Additional fields for the message
+     */
+    fields?: FieldData[];
+};
+export type ChatBotMessageButtonsProps = {
+    loading: boolean;
+    showButtons: boolean;
+    dateFormat: string;
+    date?: Date;
+};

package/dist/components/ChatToolBar/ChatToolBar.vue.d.ts

@@ -0,0 +1,39 @@
+import { ChatToolBarProps } from './types';
+
+declare const _default: import('vue').DefineComponent<import('vue').ExtractPropTypes<__VLS_WithDefaults<__VLS_TypePropsToRuntimeProps<ChatToolBarProps>, {
+    availableAgents: () => never[];
+}>>, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {
+    clear: () => void;
+    "change-chat": (value: {
+        key: string;
+        formId: string;
+    }) => void;
+}, string, import('vue').PublicProps, Readonly<import('vue').ExtractPropTypes<__VLS_WithDefaults<__VLS_TypePropsToRuntimeProps<ChatToolBarProps>, {
+    availableAgents: () => never[];
+}>>> & Readonly<{
+    onClear?: (() => any) | undefined;
+    "onChange-chat"?: ((value: {
+        key: string;
+        formId: string;
+    }) => any) | undefined;
+}>, {
+    availableAgents: import('../ChatBot/types').AvailableAgents[];
+}, {}, {}, {}, string, import('vue').ComponentProvideOptions, true, {}, any>;
+export default _default;
+type __VLS_NonUndefinedable<T> = T extends undefined ? never : T;
+type __VLS_TypePropsToRuntimeProps<T> = {
+    [K in keyof T]-?: {} extends Pick<T, K> ? {
+        type: import('vue').PropType<__VLS_NonUndefinedable<T[K]>>;
+    } : {
+        type: import('vue').PropType<T[K]>;
+        required: true;
+    };
+};
+type __VLS_WithDefaults<P, D> = {
+    [K in keyof Pick<P, keyof P>]: K extends keyof D ? __VLS_Prettify<P[K] & {
+        default: D[K];
+    }> : P[K];
+};
+type __VLS_Prettify<T> = {
+    [K in keyof T]: T[K];
+} & {};

package/dist/components/ChatToolBar/index.d.ts

@@ -0,0 +1,5 @@
+import { default as ChatToolBar } from './ChatToolBar.vue';
+import { ChatToolBarProps } from './types';
+
+export { ChatToolBar };
+export type { ChatToolBarProps };

package/dist/components/ChatToolBar/types.d.ts

@@ -0,0 +1,16 @@
+import { AvailableAgents } from '../ChatBot/types';
+
+export type ChatToolBarProps = {
+    /**
+     * If true, the toolbar will be disabled and not clickable.
+     */
+    disabled?: boolean;
+    /**
+     * Availabe Agents to select from.
+     */
+    availableAgents?: AvailableAgents[];
+    /**
+     * The currently selected agent.
+     */
+    selectedAgentKey?: string;
+};

package/dist/components/FieldPreview/FieldPreview.vue.d.ts

@@ -0,0 +1,17 @@
+import { FieldPreviewProps } from './types';
+
+declare const _default: import('vue').DefineComponent<import('vue').ExtractPropTypes<__VLS_TypePropsToRuntimeProps<FieldPreviewProps>>, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {
+    apply: (text: unknown) => void;
+}, string, import('vue').PublicProps, Readonly<import('vue').ExtractPropTypes<__VLS_TypePropsToRuntimeProps<FieldPreviewProps>>> & Readonly<{
+    onApply?: ((text: unknown) => any) | undefined;
+}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, true, {}, any>;
+export default _default;
+type __VLS_NonUndefinedable<T> = T extends undefined ? never : T;
+type __VLS_TypePropsToRuntimeProps<T> = {
+    [K in keyof T]-?: {} extends Pick<T, K> ? {
+        type: import('vue').PropType<__VLS_NonUndefinedable<T[K]>>;
+    } : {
+        type: import('vue').PropType<T[K]>;
+        required: true;
+    };
+};

package/dist/components/FieldPreview/index.d.ts

@@ -0,0 +1,5 @@
+import { default as FieldPreview } from './FieldPreview.vue';
+import { FieldPreviewProps } from './types';
+
+export { FieldPreview };
+export type { FieldPreviewProps };

package/dist/components/FieldPreview/types.d.ts

@@ -0,0 +1,7 @@
+export type FieldPreviewProps = {
+    name: string;
+    text: string;
+    type: string;
+    disabled?: boolean;
+    applied?: boolean;
+};

package/dist/components/MarkdownRender/MarkdownRender.vue.d.ts

@@ -0,0 +1,13 @@
+import { MarkdownRenderProps } from './types';
+
+declare const _default: import('vue').DefineComponent<import('vue').ExtractPropTypes<__VLS_TypePropsToRuntimeProps<MarkdownRenderProps>>, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<import('vue').ExtractPropTypes<__VLS_TypePropsToRuntimeProps<MarkdownRenderProps>>> & Readonly<{}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, true, {}, any>;
+export default _default;
+type __VLS_NonUndefinedable<T> = T extends undefined ? never : T;
+type __VLS_TypePropsToRuntimeProps<T> = {
+    [K in keyof T]-?: {} extends Pick<T, K> ? {
+        type: import('vue').PropType<__VLS_NonUndefinedable<T[K]>>;
+    } : {
+        type: import('vue').PropType<T[K]>;
+        required: true;
+    };
+};

package/dist/components/MarkdownRender/index.d.ts

@@ -0,0 +1,5 @@
+import { default as MarkdownRender } from './MarkdownRender.vue';
+import { MarkdownRenderProps } from './types';
+
+export { MarkdownRender };
+export type { MarkdownRenderProps };

package/dist/components/MarkdownRender/types.d.ts

@@ -0,0 +1,7 @@
+import { Options, PluginSimple } from 'markdown-it';
+
+export interface MarkdownRenderProps {
+    source: string;
+    options?: Options;
+    plugins?: PluginSimple[];
+}

package/dist/composables/useChatApi.d.ts

@@ -0,0 +1,23 @@
+import { ChatBotMessageContent } from '../components/ChatBot/types';
+
+type RequestResponse<T> = {
+    data: T | null;
+    error: Error | null;
+};
+export declare function useChatApi(apiEndpoint: string): {
+    isLoading: import('vue').Ref<boolean, boolean>;
+    lastError: import('vue').Ref<Error | null, Error | null>;
+    getChatData: (username: string, project: string, agentID: string, formId: string) => Promise<RequestResponse<{
+        success: boolean;
+        history: ChatBotMessageContent[];
+    }>>;
+    clearChatData: (username: string, project: string, agentID: string, formId: string) => Promise<RequestResponse<{
+        success: boolean;
+    }>>;
+    getFieldSuggestionData: (jobId: string, onChunk: (chunk: string) => void, onMetaData: (metadata: Record<string, unknown>) => void) => Promise<void>;
+    sendPrompt: (formData: FormData, onChunk: (chunk: string) => void, onError?: (error: Error) => void) => Promise<void>;
+    handleFeedback: (feedback: number, comment: string, sessionID: string) => Promise<RequestResponse<{
+        success: boolean;
+    }>>;
+};
+export {};

package/dist/composables/useChatMessages.d.ts

@@ -0,0 +1,11 @@
+import { Ref } from 'vue';
+import { ChatMessage, ChatBotMessageSender } from '../components/ChatBot/types';
+
+export declare function useChatMessages(): {
+    messages: Ref<ChatMessage[], ChatMessage[]>;
+    nextMessageId: Ref<number, number>;
+    addChatMessage: (message: string, sender?: ChatBotMessageSender, imagePreviewUrl?: string | null, sessionID?: string, isWelcomeMessage?: boolean) => void;
+    getLastMessage: () => ChatMessage | undefined;
+    clearMessages: () => void;
+    getMessages: () => ChatMessage[];
+};

package/dist/composables/useSSE.d.ts

@@ -0,0 +1,10 @@
+import { AxiosRequestConfig } from 'axios';
+
+type SSEvents = {
+    onMessage?: (message: string) => void;
+    onError?: (error: Error) => void;
+    onFieldMetadata?: (metadata: Record<string, unknown>) => void;
+    onDone?: () => void;
+};
+export declare function useSSE(config: AxiosRequestConfig, handlers: SSEvents): Promise<void>;
+export {};

package/dist/composables/useTexts.d.ts

@@ -0,0 +1,26 @@
+export declare function useTexts(): {
+    copy: string;
+    apply: string;
+    applyAll: string;
+    chatbotTitle: string;
+    sendMessage: string;
+    clearChat: string;
+    inputLabel: string;
+    imageUpload: string;
+    imageUploadQButton: string;
+    goodResponse: string;
+    badResponse: string;
+    initialMessage: string;
+    initialAgentMessage: string;
+    loginError: string;
+    botIsSick: string;
+    commentDialogTitle: string;
+    commentPlaceholder: string;
+    copyResponse: string;
+    submitButton: string;
+    cancelButton: string;
+    senderImage: string;
+    imagePreview: string;
+    regenerateResponse: string;
+    generatingResponse: string;
+};

package/dist/index.d.ts

@@ -1,3 +1,3 @@
-import { default as ChatBot } from './components/ChatBot.vue';
+import { default as ChatBot } from './components/ChatBot/ChatBot.vue';
 
 export default ChatBot;