@a.izzuddin/ai-chat 0.2.7 → 0.2.9

package/README.md

@@ -13,7 +13,7 @@ A modern, customizable chat widget built with Lit web components. Features a cle
 - 🎯 **TypeScript Support** - Full type safety
 - 📝 **List Formatting** - Automatic rendering of bulleted and numbered lists
 - 💡 **Suggested Questions** - Clickable follow-up questions for better UX
-- 🔗 **Related FAQs** - Display related FAQ references
+<!-- - 🔗 **Related FAQs** - Display related FAQ references (commented out) -->
 - 👋 **Customizable Welcome Message** - Set custom greeting with optional subtitle
 
 ## Quick Start
@@ -117,21 +117,28 @@ import '@a.izzuddin/ai-chat';
   session-id="user-123"
   title="AI Assistant"
   bot-avatar-url="/path/to/avatar.png"
+  widget-icon-url="/path/to/widget-icon.png"
   background-image-url="/path/to/background.png">
 </ai-chat>
 ```
 
+**Note:** The `widget-icon-url` sets a custom icon for the floating widget button (only applies in widget mode).
+
 #### Custom Welcome Message
+The welcome message appears as the first assistant message in the chat instead of a large empty state.
+
 ```html
 <ai-chat
   api-url="https://api.example.com"
   session-id="user-123"
   title="AI Assistant"
-  welcome-message="Hello! How may I assist you?"
-  welcome-subtitle="Ask me anything about our services">
+  welcome-message="Hai, bagaimana saya boleh bantu?"
+  welcome-subtitle="Sila tanya tentang permohonan atau apa-apa berkaitan MySTI">
 </ai-chat>
 ```
 
+The welcome message and subtitle will be combined and displayed as a regular chat message from the assistant.
+
 ### Dark Mode
 ```html
 <ai-chat
@@ -158,9 +165,10 @@ import '@a.izzuddin/ai-chat';
 | `user-message-bg` | string | '#D6E4FF' | User message background |
 | `bot-message-bg` | string | '#F5F5F5' | Bot message background |
 | `bot-avatar-url` | string | '' | Custom bot avatar image |
+| `widget-icon-url` | string | '' | Custom widget button icon (widget mode only) |
 | `background-image-url` | string | '' | Chat background image |
-| `welcome-message` | string | 'How can I help you today?' | Initial welcome message shown when chat is empty |
-| `welcome-subtitle` | string | '' | Optional subtitle text shown below welcome message |
+| `welcome-message` | string | 'How can I help you today?' | Initial message from assistant (appears as first chat message) |
+| `welcome-subtitle` | string | '' | Optional subtitle added to welcome message |
 
 ## API Integration
 
@@ -178,12 +186,6 @@ Expected response format:
 ```json
 {
   "response": "string",
-  "faq_used": [
-    {
-      "no.": "1",
-      "question": "What is MySTI?"
-    }
-  ],
   "suggested_follow_ups": [
     "What are the main objectives of the program?",
     "How can companies apply?",
@@ -192,13 +194,26 @@ Expected response format:
 }
 ```
 
+<!-- FAQ functionality - commented out for now
+{
+  "response": "string",
+  "faq_used": [
+    {
+      "no.": "1",
+      "question": "What is MySTI?"
+    }
+  ],
+  "suggested_follow_ups": [...]
+}
+-->
+
 **Supported field variations:**
-- `faq_used` or `faqs_used` for related FAQs
+<!-- - `faq_used` or `faqs_used` for related FAQs (commented out) -->
 - `suggested_follow_ups` or `suggested_questions` for clickable follow-up questions
 
 ### Response Behavior
 
-- **Related FAQs** - Displayed as non-clickable text references
+<!-- - **Related FAQs** - Displayed as non-clickable text references (commented out) -->
 - **Suggested Questions** - Displayed as clickable buttons that send the question when clicked
 - **List Formatting** - Messages support automatic list rendering:
   - Unordered lists: Lines starting with `-`, `*`, or `•`

package/custom-elements.json

@@ -69,18 +69,7 @@
     {
       "kind": "javascript-module",
       "path": "dist/index.js",
-      "declarations": [
-        {
-          "kind": "variable",
-          "name": "faqs",
-          "default": "void 0"
-        },
-        {
-          "kind": "variable",
-          "name": "suggestedQuestions",
-          "default": "void 0"
-        }
-      ],
+      "declarations": [],
       "exports": []
     },
     {
@@ -221,14 +210,6 @@
             "name": "Message",
             "module": "./components/ai-chat"
           }
-        },
-        {
-          "kind": "js",
-          "name": "FAQ",
-          "declaration": {
-            "name": "FAQ",
-            "module": "./components/ai-chat"
-          }
         }
       ]
     },
@@ -534,6 +515,34 @@
         }
       ]
     },
+    {
+      "kind": "javascript-module",
+      "path": "src/components/AIChat.tsx",
+      "declarations": [
+        {
+          "kind": "function",
+          "name": "AIChat",
+          "parameters": [
+            {
+              "name": "{\n  apiUrl,\n  sessionId = \"default-session\",\n  title = \"My AI Agent\",\n  initialMessages = [],\n  className,\n  onMessageSent,\n  onResponseReceived,\n  onError,\n}",
+              "type": {
+                "text": "AIChatProps"
+              }
+            }
+          ]
+        }
+      ],
+      "exports": [
+        {
+          "kind": "js",
+          "name": "AIChat",
+          "declaration": {
+            "name": "AIChat",
+            "module": "src/components/AIChat.tsx"
+          }
+        }
+      ]
+    },
     {
       "kind": "javascript-module",
       "path": "src/components/ai-chat.ts",
@@ -614,6 +623,16 @@
               "default": "''",
               "attribute": "bot-avatar-url"
             },
+            {
+              "kind": "field",
+              "name": "widgetIconUrl",
+              "privacy": "public",
+              "type": {
+                "text": "string"
+              },
+              "default": "''",
+              "attribute": "widget-icon-url"
+            },
             {
               "kind": "field",
               "name": "backgroundImageUrl",
@@ -741,17 +760,20 @@
               "default": "false"
             },
             {
-              "kind": "field",
-              "name": "messagesEndRef",
-              "type": {
-                "text": "HTMLDivElement | undefined"
-              },
+              "kind": "method",
+              "name": "toggleWidget",
               "privacy": "private"
             },
             {
               "kind": "method",
-              "name": "toggleWidget",
-              "privacy": "private"
+              "name": "clearChat",
+              "privacy": "public",
+              "return": {
+                "type": {
+                  "text": "void"
+                }
+              },
+              "description": "Clear all chat messages and reset to welcome message"
             },
             {
               "kind": "method",
@@ -778,6 +800,46 @@
                 }
               ]
             },
+            {
+              "kind": "method",
+              "name": "getStorageKey",
+              "privacy": "private",
+              "return": {
+                "type": {
+                  "text": "string"
+                }
+              }
+            },
+            {
+              "kind": "method",
+              "name": "saveMessagesToStorage",
+              "privacy": "private",
+              "return": {
+                "type": {
+                  "text": "void"
+                }
+              }
+            },
+            {
+              "kind": "method",
+              "name": "loadMessagesFromStorage",
+              "privacy": "private",
+              "return": {
+                "type": {
+                  "text": "Message[] | null"
+                }
+              }
+            },
+            {
+              "kind": "method",
+              "name": "clearMessagesFromStorage",
+              "privacy": "private",
+              "return": {
+                "type": {
+                  "text": "void"
+                }
+              }
+            },
             {
               "kind": "method",
               "name": "formatMessageContent",
@@ -926,6 +988,14 @@
               "default": "''",
               "fieldName": "botAvatarUrl"
             },
+            {
+              "name": "widget-icon-url",
+              "type": {
+                "text": "string"
+              },
+              "default": "''",
+              "fieldName": "widgetIconUrl"
+            },
             {
               "name": "background-image-url",
               "type": {
@@ -1025,34 +1095,6 @@
           }
         }
       ]
-    },
-    {
-      "kind": "javascript-module",
-      "path": "src/components/AIChat.tsx",
-      "declarations": [
-        {
-          "kind": "function",
-          "name": "AIChat",
-          "parameters": [
-            {
-              "name": "{\n  apiUrl,\n  sessionId = \"default-session\",\n  title = \"My AI Agent\",\n  initialMessages = [],\n  className,\n  onMessageSent,\n  onResponseReceived,\n  onError,\n}",
-              "type": {
-                "text": "AIChatProps"
-              }
-            }
-          ]
-        }
-      ],
-      "exports": [
-        {
-          "kind": "js",
-          "name": "AIChat",
-          "declaration": {
-            "name": "AIChat",
-            "module": "src/components/AIChat.tsx"
-          }
-        }
-      ]
     }
   ]
 }

package/dist/index.d.mts

@@ -2,15 +2,11 @@ import * as lit_html from 'lit-html';
 import * as lit from 'lit';
 import { LitElement, PropertyValues } from 'lit';
 
-interface FAQ {
-    "no.": string;
-    question: string;
-}
 interface Message {
     id: string;
     role: 'user' | 'assistant';
     content: string;
-    faqs?: FAQ[];
+    faqs?: any[];
     suggestedQuestions?: string[];
 }
 /**
@@ -60,6 +56,7 @@ declare class AIChat extends LitElement {
     mode: 'fullscreen' | 'widget';
     initialMessages: Message[];
     botAvatarUrl: string;
+    widgetIconUrl: string;
     backgroundImageUrl: string;
     widgetWidth: string;
     widgetHeight: string;
@@ -73,7 +70,6 @@ declare class AIChat extends LitElement {
     private input;
     private isLoading;
     private isOpen;
-    private messagesEndRef?;
     static properties: {
         apiUrl: {
             type: StringConstructor;
@@ -101,6 +97,10 @@ declare class AIChat extends LitElement {
             type: StringConstructor;
             attribute: string;
         };
+        widgetIconUrl: {
+            type: StringConstructor;
+            attribute: string;
+        };
         backgroundImageUrl: {
             type: StringConstructor;
             attribute: string;
@@ -140,7 +140,16 @@ declare class AIChat extends LitElement {
     };
     constructor();
     private toggleWidget;
+    /**
+     * Clear all chat messages and reset to welcome message
+     * @public
+     */
+    clearChat(): void;
     private lightenColor;
+    private getStorageKey;
+    private saveMessagesToStorage;
+    private loadMessagesFromStorage;
+    private clearMessagesFromStorage;
     private formatMessageContent;
     connectedCallback(): void;
     updated(changedProperties: PropertyValues): void;
@@ -157,4 +166,4 @@ declare global {
     }
 }
 
-export { AIChat, type FAQ, type Message };
+export { AIChat, type Message };

package/dist/index.d.ts

@@ -2,15 +2,11 @@ import * as lit_html from 'lit-html';
 import * as lit from 'lit';
 import { LitElement, PropertyValues } from 'lit';
 
-interface FAQ {
-    "no.": string;
-    question: string;
-}
 interface Message {
     id: string;
     role: 'user' | 'assistant';
     content: string;
-    faqs?: FAQ[];
+    faqs?: any[];
     suggestedQuestions?: string[];
 }
 /**
@@ -60,6 +56,7 @@ declare class AIChat extends LitElement {
     mode: 'fullscreen' | 'widget';
     initialMessages: Message[];
     botAvatarUrl: string;
+    widgetIconUrl: string;
     backgroundImageUrl: string;
     widgetWidth: string;
     widgetHeight: string;
@@ -73,7 +70,6 @@ declare class AIChat extends LitElement {
     private input;
     private isLoading;
     private isOpen;
-    private messagesEndRef?;
     static properties: {
         apiUrl: {
             type: StringConstructor;
@@ -101,6 +97,10 @@ declare class AIChat extends LitElement {
             type: StringConstructor;
             attribute: string;
         };
+        widgetIconUrl: {
+            type: StringConstructor;
+            attribute: string;
+        };
         backgroundImageUrl: {
             type: StringConstructor;
             attribute: string;
@@ -140,7 +140,16 @@ declare class AIChat extends LitElement {
     };
     constructor();
     private toggleWidget;
+    /**
+     * Clear all chat messages and reset to welcome message
+     * @public
+     */
+    clearChat(): void;
     private lightenColor;
+    private getStorageKey;
+    private saveMessagesToStorage;
+    private loadMessagesFromStorage;
+    private clearMessagesFromStorage;
     private formatMessageContent;
     connectedCallback(): void;
     updated(changedProperties: PropertyValues): void;
@@ -157,4 +166,4 @@ declare global {
     }
 }
 
-export { AIChat, type FAQ, type Message };
+export { AIChat, type Message };