@quidgest/chatbot 0.0.8 → 0.1.0

package/dist/style.css

@@ -1 +1 @@
-.q-chatbot{width:100%;padding:1rem;display:flex;flex-direction:column;height:100%}.q-chatbot input{line-height:1.5rem}.q-chatbot .q-input-group .i-text__field{border-radius:0;flex:1}.q-chatbot__content{background-color:#fff;border:1px solid #eaebec;height:100%;width:100%;display:flex;gap:.75rem;flex-direction:column;overflow:hidden}.q-chatbot__footer-container{padding:.8rem}.q-chatbot__send-container{padding-bottom:.25rem;display:flex;justify-content:flex-end}.q-chatbot__send-container .q-chatbot__send{border-radius:1rem}.q-chatbot__footer{position:sticky;padding:0 .5rem;border:1px solid #eaebec;border-radius:.25rem;bottom:0;width:100%;display:flex;flex-direction:column;gap:.25rem}.q-chatbot__footer .q-chatbot__input{min-height:50px;max-height:100px;border-bottom:1px solid #eaebec;overflow-y:auto}.q-chatbot__footer .q-text-area{max-height:100%;overflow-y:auto}.q-chatbot__footer .q-text-area .q-field__control{border:none}.q-chatbot__messages-container{display:flex;flex-direction:column;flex-grow:1;padding:0 1rem 2rem;gap:1.5rem;overflow-y:auto}.q-chatbot__messages-wrapper{display:flex;max-width:100%;gap:.2rem}.q-chatbot__tools{display:flex;flex-direction:row;justify-content:end;max-width:100%}.q-chatbot__message-wrapper{display:flex;flex-direction:column;gap:.2rem}.q-chatbot__message-container{display:flex;flex-direction:row;align-items:center;gap:.5rem}.q-chatbot__messages-wrapper_right{justify-content:flex-end}.q-chatbot__profile{border-radius:50%;height:2rem;width:2rem}.q-chatbot__message{min-width:4rem;display:flex;align-items:center;padding:.3rem .5rem;background-color:#eaebec;white-space:normal;min-height:2rem}.q-chatbot__messages-wrapper_right .q-chatbot__message{background-color:#018bd233}.q-chatbot__sender{white-space:nowrap;color:#7c858d;font-size:.7rem}@keyframes dotPulse{0%{opacity:.5}50%{opacity:1}to{opacity:.5}}
+.svg-icon[data-v-695796d5]{display:inline-flex;width:16px;height:14px}.svg-icon[data-v-695796d5] svg{width:100%;height:100%}.q-chatbot{width:100%;padding:1rem;display:flex;flex-direction:column;height:100%}.q-chatbot input{line-height:1.5rem}.q-chatbot .q-input-group .i-text__field{border-radius:0;flex:1}.q-chatbot__content{background-color:#fff;border:1px solid #eaebec;height:100%;width:100%;display:flex;gap:.75rem;flex-direction:column;overflow:hidden}.q-chatbot__footer-container{padding:.8rem}.q-chatbot__send-container{padding-bottom:.25rem;display:flex;justify-content:space-between;width:100%}.q-chatbot__send-container .q-chatbot__send,.q-chatbot__send-container .q-chatbot__upload{border-radius:1rem}.q-chatbot__send-container .spacer{flex-grow:1}.q-chatbot__footer{position:sticky;padding:0 .5rem;border:1px solid #eaebec;border-radius:.25rem;bottom:0;width:100%;display:flex;flex-direction:column;gap:.25rem}.q-chatbot__footer-disabled{background-color:rgb(var(--q-theme-neutral-light-rgb)/.25);cursor:not-allowed}.q-chatbot__footer .q-chatbot__input{min-height:50px;max-height:100px;border-bottom:1px solid #eaebec;overflow-y:auto}.q-chatbot__footer .q-text-area{max-height:100%;overflow-y:auto}.q-chatbot__footer .q-text-area .q-field__control{border:none}.q-chatbot__upload-container{display:flex;justify-content:flex-start;padding:.25rem 0}.q-chatbot__upload-container .q-chatbot__upload{border-radius:1rem}.q-chatbot__messages-container{display:flex;flex-direction:column;flex-grow:1;padding:0 1rem 2rem;gap:1.5rem;overflow-y:auto}.q-chatbot__messages-wrapper{display:flex;max-width:100%;gap:.2rem}.q-chatbot__tools{display:flex;flex-direction:row;justify-content:end;max-width:100%}.q-chatbot__message-wrapper{display:flex;flex-direction:column;gap:.2rem}.q-chatbot__message-container{display:flex;flex-direction:column;gap:.25rem}.q-chatbot__messages-wrapper_right{justify-content:flex-end}.q-chatbot__messages-wrapper_right .q-chatbot__message-container{align-items:flex-end}.q-chatbot__messages-wrapper_right .q-chatbot__message-wrapper{display:flex;align-items:flex-end}.q-chatbot__profile.q-icon__img{border-radius:50%;height:2rem;width:2rem}.q-chatbot__message{display:flex;align-items:center;padding:.3rem .5rem;background-color:#eaebec;width:fit-content;white-space:normal;min-height:2rem;word-wrap:break-word;word-break:break-word;border-radius:0 .5rem .5rem}.q-chatbot__messages-wrapper_right .q-chatbot__message{background-color:#018bd233;border-radius:.5rem 0 .5rem .5rem}.q-chatbot__sender{white-space:nowrap;color:#7c858d;font-size:.7rem}.q-chatbot__retry-button{align-items:center;display:flex}.q-chatbot__image-preview{position:relative;display:inline-block}.q-chatbot__image-preview img{max-height:100px;width:auto;border-radius:8px;margin:10px 0}.q-chatbot__remove-image{position:absolute;top:5px;right:5px;background-color:#00000080;color:#fff;border-radius:50%;padding:5px;cursor:pointer;font-size:12px;border:none}.hidden-input{display:none}.pulsing-dots{display:flex;align-items:center;justify-content:center;gap:.1rem}.dot{font-size:20px;line-height:1;animation:pulse 1s infinite;color:var(--q-theme-primary)}@keyframes pulse{0%,to{transform:scale(.8);opacity:.6}50%{transform:scale(1);opacity:1}}

package/dist/types/chatbot.type.d.ts

@@ -0,0 +1,14 @@
+import { ResourceStrings } from './texts.type';
+
+export type ChatBotProps = {
+    apiEndpoint?: string;
+    controllerEndpoint?: string;
+    texts?: ResourceStrings;
+    username: string;
+    projectPath: string;
+    userImage?: string;
+    chatbotImage?: string;
+    dateFormat?: string;
+    mode?: ChatBotMode;
+};
+export type ChatBotMode = 'chat' | 'agent';

package/dist/types/message.type.d.ts

@@ -2,9 +2,15 @@ export type ChatBotMessage = {
     id: number;
     message: string;
     date: Date;
-    sender: 'bot' | 'user';
+    sender: ChatBotMessageSender;
+    sessionID: string;
+    imagePreviewUrl?: string;
+    isWelcomeMessage?: boolean;
 };
 export type ChatBotMessageContent = {
     content: string;
     type: string;
+    sessionID: string;
+    imageUrl?: string;
 };
+export type ChatBotMessageSender = 'bot' | 'user';

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@quidgest/chatbot",
     "private": false,
-    "version": "0.0.8",
+    "version": "0.1.0",
     "type": "module",
     "license": "UNLICENSED",
     "main": "dist/index.cjs",
@@ -32,23 +32,24 @@
         "lint:fix": "eslint . --fix && prettier --write --list-different src"
     },
     "dependencies": {
-        "axios": "^1.6.7"
+        "axios": "^1.6.7",
+        "uuid": "^11.0.5"
     },
     "devDependencies": {
-        "@types/node": "^20.11.13",
-        "@vitejs/plugin-vue": "^4.5.2",
-        "eslint": "^9.8.0",
+        "@types/node": "^20.16.1",
+        "@vitejs/plugin-vue": "^4.6.2",
+        "eslint": "^9.9.0",
         "eslint-plugin-prettier": "^5.2.1",
         "prettier": "^3.3.3",
-        "rimraf": "^5.0.5",
-        "sass": "^1.70.0",
-        "typescript": "^5.2.2",
-        "vite": "^5.0.8",
-        "vite-plugin-dts": "^3.7.3",
-        "vue-tsc": "^1.8.25"
+        "rimraf": "^5.0.10",
+        "sass": "^1.77.8",
+        "typescript": "^5.5.4",
+        "vite": "^5.4.2",
+        "vite-plugin-dts": "^3.9.1",
+        "vue-tsc": "^1.8.27"
     },
     "peerDependencies": {
-        "@quidgest/ui": "^0.14.17",
+        "@quidgest/ui": "^0.14.19",
         "vue": "3.5.13"
     }
 }

package/src/assets/copy.svg

@@ -0,0 +1,7 @@
+<svg
+    xmlns="http://www.w3.org/2000/svg"
+    viewBox="0 0 24 24">
+    <path
+        fill="currentColor"
+        d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm3 4H8c-1.1 0-2 .9-2 2v14c0 1.1.9 2 2 2h11c1.1 0 2-.9 2-2V7c0-1.1-.9-2-2-2zm0 16H8V7h11v14z" />
+</svg>

package/src/assets/styles/styles.scss

@@ -35,13 +35,22 @@
     &__send-container {
         padding-bottom: .25rem;
         display: flex;
-        justify-content: flex-end;
+        justify-content: space-between;
+        width: 100%;
 
         & .q-chatbot__send {
             border-radius: 1rem;
         }
+
+        & .q-chatbot__upload {
+            border-radius: 1rem;
+        }
+
+        & .spacer {
+            flex-grow: 1;
+        }
     }
-    
+
     &__footer {
         position: sticky;
         padding: 0 .5rem;
@@ -52,23 +61,39 @@
         display: flex;
         flex-direction: column;
         gap: .25rem;
-    
+
+        &-disabled {
+            background-color: rgb(var(--q-theme-neutral-light-rgb) / 0.25);
+            cursor: not-allowed;
+        }
+
         & .q-chatbot__input {
-          min-height: 50px;
-          max-height: 100px;
-          border-bottom: 1px solid #eaebec;
-          overflow-y: auto;
+            min-height: 50px;
+            max-height: 100px;
+            border-bottom: 1px solid #eaebec;
+            overflow-y: auto;
         }
-    
+
         & .q-text-area {
             max-height: 100%;
             overflow-y: auto;
-            
+
             & .q-field__control {
                 border: none;
             }
         }
-      }
+    }
+
+    &__upload-container {
+        display: flex;
+        justify-content: flex-start;
+        padding: .25rem 0;
+        
+        & .q-chatbot__upload {
+            border-radius: 1rem;
+        }
+    }
+
     &__messages-container {
         display: flex;
         flex-direction: column;
@@ -103,33 +128,45 @@
 
     &__message-container {
         display: flex;
-        flex-direction: row;
-        align-items: center;
-        gap: 0.5rem;
+        flex-direction: column;
+        gap: 0.25rem;
     }
 
     &__messages-wrapper_right {
         justify-content: flex-end;
+
+        .q-chatbot__message-container {
+            align-items: flex-end;
+        }
+
+        .q-chatbot__message-wrapper {
+            display: flex;
+            align-items: flex-end;
+        }
     }
 
-    &__profile {
+    &__profile.q-icon__img {
         border-radius: 50%;
         height: 2rem;
         width: 2rem;
     }
 
     &__message {
-        min-width: 4rem;
         display: flex;
         align-items: center;
         padding: 0.3rem 0.5rem;
         background-color: #eaebec;
+        width: fit-content;
         white-space: normal;
         min-height: 2rem;
+        word-wrap: break-word;
+        word-break: break-word;
+        border-radius: 0 0.5rem 0.5rem 0.5rem;
     }
 
     &__messages-wrapper_right .q-chatbot__message {
         background-color: rgba(#018bd2, 20%);
+        border-radius: 0.5rem 0 0.5rem 0.5rem;
     }
 
     &__sender {
@@ -137,16 +174,63 @@
         color: #7c858d;
         font-size: 0.7rem;
     }
-}
 
-@keyframes dotPulse {
-    0% {
-        opacity: 0.5;
+    &__retry-button {
+        align-items: center;
+        display: flex;
     }
-    50% {
-        opacity: 1;
+
+    &__image-preview {
+        position: relative;
+        display: inline-block;
+
+        img {
+            max-height: 100px;
+            width: auto;
+            border-radius: 8px;
+            margin: 10px 0;
+        }
     }
-    100% {
-        opacity: 0.5;
+
+    &__remove-image {
+        position: absolute;
+        top: 5px;
+        right: 5px;
+        background-color: rgba(0, 0, 0, 0.5);
+        color: white;
+        border-radius: 50%;
+        padding: 5px;
+        cursor: pointer;
+        font-size: 12px;
+        border: none;
     }
 }
+
+.hidden-input {
+    display: none;
+}
+
+.pulsing-dots {
+    display: flex;
+    align-items: center;
+    justify-content: center;
+    gap: 0.1rem;
+}
+
+.dot {
+    font-size: 20px;
+    line-height: 1;
+    animation: pulse 1s infinite;
+    color: var(--q-theme-primary);
+}
+
+@keyframes pulse {
+    0%, 100% {
+      transform: scale(0.8);
+      opacity: 0.6;
+    }
+    50% {
+      transform: scale(1);
+      opacity: 1;
+    }
+}

package/src/assets/thumbDown.svg

@@ -0,0 +1,9 @@
+<svg
+    id="Layer_1"
+    class="q-icon q-icon__svg"
+    xmlns="http://www.w3.org/2000/svg"
+    viewBox="0 0 21.86 19.87">
+    <path
+        fill="currentColor"
+        d="M17.89,11.92h3.97V0h-3.97M13.91,0H4.97c-.82,0-1.53.5-1.83,1.21L.14,8.22c-.09.23-.14.47-.14.73v1.99c0,1.1.89,1.99,1.99,1.99h6.27l-.94,4.54c-.02.1-.03.2-.03.31,0,.42.17.78.44,1.05l1.05,1.05,6.54-6.55c.37-.36.59-.85.59-1.4V1.99c0-1.1-.89-1.99-1.99-1.99Z" />
+</svg>

package/src/assets/thumbUp.svg

@@ -0,0 +1,9 @@
+<svg
+    id="Layer_1"
+    class="q-icon q-icon__svg"
+    xmlns="http://www.w3.org/2000/svg"
+    viewBox="0 0 21.7 19.73">
+    <path
+        fill="currentColor"
+        d="M21.7,8.88c0-1.09-.89-1.97-1.97-1.97h-6.23l.95-4.51c.02-.1.03-.21.03-.32,0-.4-.17-.78-.43-1.05l-1.05-1.04-6.49,6.49c-.36.36-.58.86-.58,1.4v9.86c0,1.09.88,1.97,1.97,1.97h8.88c.82,0,1.52-.49,1.82-1.2l2.98-6.95c.09-.23.14-.46.14-.72v-1.97M0,19.73h3.95V7.89H0v11.84Z" />
+</svg>

package/src/components/CBMessage.vue

@@ -1,13 +1,115 @@
+<template>
+    <div class="q-chatbot__message-container">
+        <!-- Chatbot Image -->
+        <q-icon
+            type="img"
+            :icon="messageImage"
+            :alt="props.texts.senderImage"
+            class="q-chatbot__profile" />
+
+        <div class="q-chatbot__message-wrapper">
+            <div
+                v-if="props.imagePreviewUrl && props.imagePreviewUrl.length > 0"
+                class="q-chatbot__image-preview">
+                <img
+                    :src="props.imagePreviewUrl"
+                    :alt="props.texts.imagePreview" />
+            </div>
+            <!-- Message body -->
+            <div class="q-chatbot__message">
+                <!-- When loading is true, show bouncing dots animation -->
+                <pulse-dots v-if="loading" />
+                <template v-else>
+                    <div
+                        class="q-chatbot__text"
+                        v-if="props.sender === 'bot'"
+                        v-html="props.message"></div>
+                    <div
+                        class="q-chatbot__text"
+                        v-else>
+                        {{ props.message }}
+                    </div>
+                </template>
+            </div>
+            <q-dialog
+                v-model="showDialog"
+                :buttons="commentButtons"
+                :text="props.texts.commentDialogTitle">
+                <template #body.append>
+                    <q-text-field
+                        v-model="feedbackComment"
+                        :maxLength="150"
+                        size="large"
+                        :placeholder="props.texts.commentPlaceholder" />
+                </template>
+            </q-dialog>
+
+            <!-- Thumbs up and down buttons, only for bot messages -->
+            <div
+                v-if="isBotMessageAndNotDefault"
+                class="q-chatbot__feedback-buttons">
+                <q-button-group>
+                    <q-button
+                        :title="props.texts.goodResponse"
+                        borderless
+                        :disabled="loading"
+                        b-style="secondary"
+                        @click="openFeedbackDialog(1)">
+                        <span v-html="thumbUpSvg" class="svg-icon"></span>
+                    </q-button>
+                    <q-button
+                        :title="props.texts.badResponse"
+                        borderless
+                        :disabled="loading"
+                        b-style="secondary"
+                        @click="openFeedbackDialog(0)">
+                        <span v-html="thumbDownSvg" class="svg-icon"></span>
+                    </q-button>
+                    <q-button
+                        :title="props.texts.copyResponse"
+                        borderless
+                        :disabled="loading"
+                        b-style="secondary"
+                        @click="copyResponse">
+                        <span v-html="copySvg" class="svg-icon"></span>
+                    </q-button>
+                </q-button-group>
+            </div>
+            <div class="q-chatbot__sender">
+                {{ messageDate }}
+            </div>
+        </div>
+    </div>
+</template>
+
 <script setup lang="ts">
-    import { computed } from 'vue'
-    import ChatBotIcon from '@/assets/chatbot.png'
-    import { QLineLoader } from '@quidgest/ui/components'
+    import { computed, ref } from 'vue'
+    import {
+        QButton,
+        QIcon,
+        QDialog,
+        QTextField
+    } from '@quidgest/ui/components'
+    import PulseDots from '@/components/PulseDots.vue'
+    import type { ChatBotMessageSender } from '@/types/message.type'
+    import { ResourceStrings } from '@/types/texts.type'
+    import Axios from 'axios'
+    
+    // Importando o conteúdo dos arquivos SVG como strings
+    import thumbUpSvgFile from '@/assets/thumbUp.svg?raw'
+    import thumbDownSvgFile from '@/assets/thumbDown.svg?raw'
+    import copySvgFile from '@/assets/copy.svg?raw'
+    
+    // Armazenando o conteúdo SVG como strings
+    const thumbUpSvg = thumbUpSvgFile;
+    const thumbDownSvg = thumbDownSvgFile;
+    const copySvg = copySvgFile;
 
     export interface CBMessageProps {
         /*
          * Sender of the message
          */
-        sender?: 'bot' | 'user'
+        sender?: ChatBotMessageSender
 
         /*
          * Message to be displayed
@@ -28,27 +130,105 @@
          * Project locale
          */
         dateFormat?: string
+
+        /**
+         * Image preview URL
+         */
+        imagePreviewUrl?: string
+
+        /**
+         * Default chatBot texts
+         */
+        texts?: ResourceStrings
+
+        /**
+         * Default api endpoint
+         */
+        apiEndpoint?: String
+
+        /**
+         * Session ID
+         */
+        sessionID?: String
+
+        /**
+         * User image
+         */
+        userImage: string
+
+        /**
+         * Chatbot image
+         */
+        chatbotImage: string
+        
+        /**
+         * Flag to mark welcome messages
+         */
+        isWelcomeMessage?: boolean
     }
 
     const props = withDefaults(defineProps<CBMessageProps>(), {
         sender: 'user',
-        date: () => new Date()
+        userImage: undefined,
+        date: () => new Date(),
+        texts: () => ({
+            commentDialogTitle: 'Would you like to add a comment?',
+            commentPlaceholder: 'Type your comment here (optional)...',
+            goodResponse: 'Good response',
+            badResponse: 'Bad response',
+            copyResponse: 'Copy response',
+            submitButton: 'Submit',
+            cancelButton: 'Cancel',
+            senderImage: 'Sender Image',
+            imagePreview: 'Image preview'
+        })
     })
 
+    const showDialog = ref(false)
+    const feedbackComment = ref('')
+    const currentFeedback = ref<number | null>(null)
+    const commentButtons = [
+        {
+            id: 'confirm-btn',
+            action: submitFeedback,
+            props: {
+                label: props.texts.submitButton,
+                'b-style': 'primary'
+            }
+        },
+        {
+            id: 'cancel-btn',
+            props: {
+                label: props.texts.cancelButton,
+                'b-style': 'danger'
+            }
+        }
+    ]
+
     const senderName = computed(() => {
         return props.sender === 'bot' ? 'GenioBot' : 'You'
     })
 
+    const isBotMessageAndNotDefault = computed(() => {
+        return props.sender === 'bot' &&
+            !Object.values(props.texts || {}).includes(props.message || '') &&
+            !props.isWelcomeMessage
+    })
+
     const getLocaleDate = computed(() => {
         if (!props.dateFormat) return props.date.toLocaleString()
 
         return formatDate(props.date, props.dateFormat)
     })
 
-    const messageHeader = computed(() => {
+    const messageDate = computed(() => {
         return `${senderName.value} ${getLocaleDate.value}`
     })
 
+    const messageImage = computed(() =>
+        props.sender === 'bot' ? props.chatbotImage : props.userImage
+    )
+
     function formatDate(date: Date, format: string) {
         const day = date.getDate().toString().padStart(2, '0')
         const month = (date.getMonth() + 1).toString().padStart(2, '0')
@@ -65,40 +245,55 @@
             .replace('mm', minutes)
             .replace('ss', seconds)
     }
-</script>
 
-<template>
-    <div class="q-chatbot__message-container">
-        <!-- Chatbot Image -->
-        <img
-            v-if="props.sender === 'bot'"
-            :src="ChatBotIcon"
-            alt="Chatbot"
-            class="q-chatbot__profile" />
+    function openFeedbackDialog(feedback: number) {
+        showDialog.value = true
+        feedbackComment.value = ''
+        currentFeedback.value = feedback
+    }
 
-        <div class="q-chatbot__message-wrapper">
-            <!-- Message header -->
-            <div
-                v-if="!loading"
-                class="q-chatbot__sender">
-                {{ messageHeader }}
-            </div>
+    function submitFeedback() {
+        if (currentFeedback.value != null) {
+            handleFeedback(currentFeedback.value, feedbackComment.value)
+        }
+    }
+    function handleFeedback(feedback: number, comment: string) {
+        Axios.post(props.apiEndpoint + '/prompt/feedback', {
+            messageSessionID: props.sessionID,
+            feedbackValue: feedback,
+            feedbackComment: comment
+        }).catch((error) => {
+            console.error('Error sending message feedback: ', error)
+        })
+    }
 
-            <!-- Message body -->
-            <div class="q-chatbot__message">
-                <QLineLoader v-if="loading" />
-                <template v-else>
-                    <div
-                        class="q-chatbot__text"
-                        v-if="props.sender == 'bot'"
-                        v-html="props.message"></div>
-                    <div
-                        class="q-chatbot__text"
-                        v-else>
-                        {{ props.message }}
-                    </div>
-                </template>
-            </div>
-        </div>
-    </div>
-</template>
+    function copyResponse() {
+        if (!props.message) return
+
+        navigator.clipboard
+            .writeText(props.message)
+            .then(() => {
+                console.log('Message copied to clipboard')
+            })
+            .catch((error) => {
+                console.error(
+                    'Failed to copy message to clipboard: ',
+                    error
+                )
+            })
+    }
+</script>
+
+<style scoped>
+
+    .svg-icon {
+        display: inline-flex;
+        width: 16px;
+        height: 14px;
+    }
+    
+    .svg-icon :deep(svg) {
+        width: 100%;
+        height: 100%;
+    }
+</style>