chore: cleanup

Author: bacalj

README.md

@@ -107,17 +107,12 @@ When using the JavaScript API in plain HTML/JS (requires standalone bundle), you
 ```javascript
 const botController = qaBot({...});
 
-// Add a message to the chat
 botController.addMessage("Hello World!");
-
-// Set user login status
 botController.setBotIsLoggedIn(true);
-
-// Control chat window (floating mode only)
+// (floating mode only)
 botController.openChat();
 botController.closeChat();
 botController.toggleChat();
-
 // Cleanup
 botController.destroy();
 ```

local-demo.js

@@ -56,7 +56,6 @@ function updateBotLoginStatus(isLoggedIn) {
 function setupLoginCheckbox() {
     const loginCheckbox = document.getElementById('user-logged-in');
     if (loginCheckbox) {
-        // Initialize checkbox state based on current cookie
         loginCheckbox.checked = isUserLoggedIn();
 
         loginCheckbox.addEventListener('change', (e) => {

src/components/BotController.js

@@ -56,7 +56,8 @@ const BotController = React.forwardRef(({
     }
   });
 
-  // Set up the simplified imperative API (only addMessage)
+  // An imperative method to add a message to bot
+  // wrapping react-chatbotify `insertMessage`
   useImperativeHandle(ref, () => ({
     // Add a message to the chat
     addMessage: (message) => {
@@ -65,8 +66,6 @@ const BotController = React.forwardRef(({
       }
     }
   }), [messages]);
-
-  // This component doesn't render anything
   return null;
 });
 

src/components/QABot.js

@@ -10,18 +10,11 @@ import useUpdateHeader from '../hooks/useUpdateHeader';
 import useRingEffect from '../hooks/useRingEffect';
 import { DEFAULT_CONFIG } from '../config/constants';
 
-/**
- * Generate a unique session ID
- * @returns {string} A unique session identifier
- */
+
 const generateSessionId = () => {
   return `qa_bot_session_${uuidv4()}`;
 };
 
-/**
- * Get or create a session ID from localStorage
- * @returns {string} A session identifier
- */
 const getOrCreateSessionId = () => {
   // Check if we already have a session ID in localStorage
   for (let i = 0; i < localStorage.length; i++) {
@@ -33,12 +26,19 @@ const getOrCreateSessionId = () => {
       }
     }
   }
-
-  // No existing session found, generate a new one
   const newSessionId = generateSessionId();
   localStorage.setItem(newSessionId, newSessionId);
   return newSessionId;
 };
+
+const buildWelcomeMessage = (isLoggedIn, welcomeMessage) => {
+  if (isLoggedIn) {
+    return welcomeMessage || DEFAULT_CONFIG.WELCOME_MESSAGE;
+  } else {
+    return DEFAULT_CONFIG.WELCOME_MESSAGE_LOGGED_OUT;
+  }
+}
+
 /**
  * Q&A Bot Component (Controlled)
  *
@@ -53,15 +53,6 @@ const getOrCreateSessionId = () => {
  * @param {string}    [props.welcome='Hello! What can I help you with?'] - Welcome message
  * @returns {JSX.Element}
  */
-
-const buildWelcomeMessage = (isLoggedIn, welcomeMessage) => {
-  if (isLoggedIn) {
-    return welcomeMessage || DEFAULT_CONFIG.WELCOME_MESSAGE;
-  } else {
-    return DEFAULT_CONFIG.WELCOME_MESSAGE_LOGGED_OUT;
-  }
-}
-
 const QABot = React.forwardRef((props, botRef) => {
   const {
     apiKey,
@@ -120,10 +111,8 @@ const QABot = React.forwardRef((props, botRef) => {
     isLoggedIn: isBotLoggedIn
   });
 
-  // Use the AI query handling hook
   const handleQuery = useHandleAIQuery(finalApiKey, sessionId, setCurrentQueryId);
 
-  // Use the chat flow hook
   const flow = useChatFlow({
     welcomeMessage,
     isBotLoggedIn,

src/config/constants.js

@@ -1,4 +1,3 @@
-// Default configuration values for the QA Bot
 export const DEFAULT_CONFIG = {
   LOGIN_URL: '/login',
   PROMPT_TEXT: 'Questions should stand alone and not refer to previous ones.',
@@ -8,24 +7,20 @@ export const DEFAULT_CONFIG = {
   WELCOME_MESSAGE_LOGOUT_TRANSITION: 'You have been logged out.',
   API_ENDPOINT: 'https://access-ai.ccs.uky.edu/api/query',
 
-  // Error messages
   ERRORS: {
     API_UNAVAILABLE: 'Unable to contact the Q&A Bot. Please try again later.',
   },
 
-  // Behavior configuration
   BEHAVIOR: {
     SHOW_RATING_AFTER_FAILED_QUERY: true
   },
 
-  // Theme defaults
   THEME: {
     PRIMARY_COLOR: '#1a5b6e',
     SECONDARY_COLOR: '#107180',
     FONT_FAMILY: 'Arial, sans-serif'
   },
 
-  // Chat bot UI defaults
   CHATBOT: {
     TITLE: 'ACCESS Q&A Bot',
     AVATAR_URL: 'https://support.access-ci.org/themes/contrib/asp-theme/images/icons/ACCESS-arrrow.svg',

src/hooks/useGetLastUserQuery.js

@@ -11,7 +11,6 @@ const useGetLastUserQuery = () => {
       const history = JSON.parse(historyString);
       if (!Array.isArray(history)) return null;
 
-      // Find the most recent USER message (latest timestamp)
       let latestUserMessage = null;
       let latestTimestamp = null;
 

src/hooks/useHandleAIQuery.js

@@ -29,8 +29,6 @@ const useHandleAIQuery = (apiKey, sessionId, setCurrentQueryId) => {
       'X-Query-ID': actualQueryId
     };
 
-    // console.log('| 📫 headers for AI query:', headers);
-
     try {
       const requestOptions = {
         method: 'POST',

src/hooks/useRingEffect.js

@@ -24,11 +24,10 @@ const useRingEffect = (ringEffect, containerRef) => {
       }
     }, 500); // 500ms delay to make sure its rendered and gain user attention
 
-    // Cleanup function
     return () => {
       clearTimeout(timeoutId);
     };
-  }, [ringEffect, containerRef]); // Only run when ringEffect or containerRef changes
+  }, [ringEffect, containerRef]);
 };
 
 export default useRingEffect;

src/hooks/useThemeColors.js

@@ -19,7 +19,7 @@ const useThemeColors = (containerRef, defaultColors = {}) => {
           return containerValue.trim();
         }
 
-        // Then check parent (useful for web component shadow DOM)
+        // Then check parent
         if (containerRef.current.parentElement) {
           const parentStyle = getComputedStyle(containerRef.current.parentElement);
           const parentValue = parentStyle.getPropertyValue(name);

src/lib.js

@@ -64,7 +64,6 @@ export function qaBot(config) {
   const root = ReactDOM.createRoot(config.target);
   let wrapperRef = { current: null };
 
-  // Mount React component directly
   root.render(
     <React.StrictMode>
       <ProgrammaticQABot
@@ -80,7 +79,6 @@ export function qaBot(config) {
     </React.StrictMode>
   );
 
-  // Return controller object that delegates to the wrapper
   return {
     addMessage: (message) => wrapperRef.current?.addMessage(message),
     setBotIsLoggedIn: (status) => wrapperRef.current?.setBotIsLoggedIn(status),
@@ -93,6 +91,4 @@ export function qaBot(config) {
     }
   };
 }
-
-// Default export - prioritize qaBot function for standalone usage
 export default qaBot;