fix: issues with interface (#304)

* fix: issues with interface

* fix: make requested changes

Author: spaenleh

eslint.config.mjs

@@ -56,8 +56,6 @@ export default [
       globals: {
         ...globals.browser,
         ...globals.node,
-        ...globals.mocha,
-        ...globals.jest,
         cy: true,
         Cypress: true,
       },
@@ -155,9 +153,9 @@ export default [
       ],
 
       'react/function-component-definition': [
-        2,
+        'error',
         {
-          namedComponents: 'arrow-function',
+          namedComponents: ['function-declaration', 'arrow-function'],
         },
       ],
 

package.json

@@ -112,6 +112,7 @@
     "vite": "6.3.5",
     "vite-plugin-checker": "0.9.3",
     "vite-plugin-istanbul": "7.0.0",
+    "vite-tsconfig-paths": "5.1.4",
     "vitest": "3.2.3"
   },
   "browserslist": {

src/config/appSetting.ts

@@ -1,4 +1,4 @@
-import { ChatBotMessage, GPTVersion } from '@graasp/sdk';
+import { ChatBotMessage } from '@graasp/sdk';
 
 export const SettingsKeys = {
   ChatbotPrompt: 'chatbot-prompt',
@@ -19,7 +19,7 @@ export type ChatbotPromptSettings = {
   [ChatbotPromptSettingsKeys.InitialPrompt]: ChatBotMessage[];
   [ChatbotPromptSettingsKeys.ChatbotCue]: string;
   [ChatbotPromptSettingsKeys.ChatbotName]: string;
-  [ChatbotPromptSettingsKeys.GptVersion]?: GPTVersion;
+  [ChatbotPromptSettingsKeys.GptVersion]?: string;
   // used to allow access using settings[settingKey] syntax
   // [key: string]: unknown;
 };

src/constants.ts

@@ -1,4 +1,7 @@
+import { GPTVersion } from '@graasp/sdk';
+
 export const DEFAULT_BOT_USERNAME = 'Graasp Bot';
+export const DEFAULT_MODEL_VERSION = GPTVersion.GPT_3_5_TURBO;
 export const ANONYMOUS_USER = 'Anonymous';
 
 // UI

src/langs/en.json

@@ -24,9 +24,10 @@
     "CHATBOT_NAME_LABEL": "Chatbot Name",
     "CHATBOT_NAME_HELPER": "This is the name that users will see when they interact with the chatbot",
     "CHATBOT_NAME_DEFAULT_MESSAGE": "by default",
+    "CHATBOT_VERSION_DEFAULT_MESSAGE": "by default",
     "CHATBOT_PROMPT_LABEL": "Chatbot Prompt",
     "CHATBOT_PROMPT_HELPER_LABEL": "In-depth technical description",
-    "CHATBOT_PROMPT_HELPER": "This is the name that users will see when they interact with the chatbot",
+    "CHATBOT_PROMPT_HELPER": "This is a collection of examples of interactions that define the chatbot's personality.",
     "CHATBOT_PROMPT_FORMAT_HELPER": "To describe the initial situation, create an object at the start of the array with 2 keys: 'role' and 'content'. For the initial description the role must be 'system'. Place your description of the initial situation in the 'content' key. Add interaction examples after that. Add one object per message with the role corresponding to either 'assistant' or 'user'.",
     "CHATBOT_PROMPT_FORMAT_EXAMPLE": "Here is an example",
     "CHATBOT_PROMPT_API_REFERENCE": "See the API reference",
@@ -66,7 +67,7 @@
     "GPT_3_5_TURBO_DESCRIPTION": "Optimized for speed and efficiency, suitable for applications where quick interactions are needed.",
     "GPT_4_DESCRIPTION": "Features deeper learning and more comprehensive knowledge, ideal for content creation and technical support.",
     "GPT_4_TURBO_DESCRIPTION": "Combines the depth of GPT-4 with enhanced speed, perfect for high-demand scenarios.",
-    "CHATBOT_MODEL_VERSION_HELPER": "This defines gpt version used within the model, default version is gpt-3.5-turbo-0125.",
+    "CHATBOT_MODEL_VERSION_HELPER": "This defines the  model that will be used. The default is: {{default}}.",
     "RECOMMENDED": "Recommended"
   }
 }

src/modules/common/ChatbotPrompt.tsx

@@ -8,7 +8,7 @@ import {
   buildPrompt,
   useLocalContext,
 } from '@graasp/apps-query-client';
-import { UUID } from '@graasp/sdk';
+import { GPTVersion, UUID } from '@graasp/sdk';
 
 import { AppActionsType } from '@/config/appActions';
 import { AppDataTypes, CommentData } from '@/config/appData';
@@ -51,7 +51,7 @@ const ChatbotPrompt = ({ id }: Props): JSX.Element | null => {
   const chatbotPrompt = chatbotPrompts?.[0];
 
   const { mutateAsync: postChatBot } = mutations.usePostChatBot(
-    chatbotPrompt?.data?.gptVersion,
+    chatbotPrompt?.data?.gptVersion as GPTVersion,
   );
 
   const { data: generalSettings } = hooks.useAppSettings<GeneralSettings>({

src/modules/common/CommentEditor.tsx

@@ -28,7 +28,6 @@ import {
 } from 'lucide-react';
 
 import { CommentAppData } from '@/config/appData';
-// import { DEFAULT_MAX_COMMENT_LENGTH_SETTING } from '@/config/appSetting';
 import {
   COMMENT_EDITOR_BOLD_BUTTON_CYPRESS,
   COMMENT_EDITOR_CANCEL_BUTTON_CYPRESS,

src/modules/common/CommentThread.tsx

@@ -10,6 +10,7 @@ import {
 } from '@mui/material';
 
 import { ChatbotThreadMessage, buildPrompt } from '@graasp/apps-query-client';
+import { GPTVersion } from '@graasp/sdk';
 
 import { AppActionsType } from '@/config/appActions';
 import { AppDataTypes, CommentAppData } from '@/config/appData';
@@ -19,8 +20,6 @@ import {
   GeneralSettings,
   SettingsKeys,
 } from '@/config/appSetting';
-// import { DEFAULT_GENERAL_SETTINGS } from '@/config/settings';
-// import { GENERAL_SETTINGS_NAME } from '@/config/appSettings';
 import { hooks, mutations } from '@/config/queryClient';
 import { COMMENT_THREAD_CONTAINER_CYPRESS } from '@/config/selectors';
 import { buildThread } from '@/utils/comments';
@@ -68,7 +67,7 @@ const CommentThread = ({ children, threadSx }: Props): JSX.Element | null => {
   const chatbotPrompt = chatbotPrompts?.[0];
 
   const { mutateAsync: postChatbot, isLoading } = mutations.usePostChatBot(
-    chatbotPrompt?.data?.gptVersion,
+    chatbotPrompt?.data?.gptVersion as GPTVersion,
   );
 
   const { data: generalSettings } = hooks.useAppSettings<GeneralSettings>({