@headwai/chat-bubble 7.5.0 → 8.0.1

package/CHANGELOG.md

@@ -5,23 +5,28 @@ All notable changes to this project will be documented in this file.
 ## [7.5.0] - 2025-11-26
 
 ### Changed
+
 - Use font-size instead of rem as basis for Disclaimer Info
-- Increased size of Chat Bubble Icon in header
+- Increased size of HeadwAI Chat Bubble Icon in header
 - Refactored styling within components to remove inline styles
 
 ## [7.4.0] - 2025-11-26
 
 ### Removed
-- Removed updating Chat Bubble Title with Conversation Title.
+
+- Removed updating HeadwAI Chat Bubble Title with Conversation Title.
 
 ## [7.3.2] - 2025-11-24
+
 - Extract changelog entries to populate GitHub release bodies.
 - Include CHANGELOG.md in the published package files.
 
 ## [7.3.1] - 2025-11-21
+
 - Align Submit Button to the Text Input field
 - Added GitHub Release automation workflow.
 - Added CHANGELOG.md file.
 
 ## [7.3.0] - 2025-11-21
+
 - Initial changelog creation.

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 headwAI GmbH
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.dev.md

@@ -1,4 +1,4 @@
-# Headwai Chat Bubble
+# HeadwAI Chat Bubble
 
 The chat bubble is based on a Svelte integration for the [deep-chat](https://www.npmjs.com/package/deep-chat) component, providing an easy-to-use AI chat interface for your web applications.
 
@@ -37,7 +37,7 @@ cp .env.example .env
 npm run dev
 ```
 
-6. Open embedded Headwai Chat Bubble in Browser
+6. Open embedded HeadwAI Chat Bubble in Browser
 
 ```bash
  http://localhost:5174/
@@ -48,7 +48,7 @@ npm run dev
 
 ## Configuration
 
-The Headwai Chat Bubble can be configured using environment variables or by changing the attributes of the instance.
+The HeadwAI Chat Bubble can be configured using environment variables or by changing the attributes of the instance.
 
 ### Environment Variables
 
@@ -60,7 +60,7 @@ Create a `.env` by copying `.env.example` file in your project root with the fol
 <script>
   // Runtime configuration override
   window.HEADWAI_CHAT_BUBBLE_CONFIG = {
-    apiUrl: 'https://company.localchat.at',
+    apiUrl: 'https://company.headwai-one.at',
     assistantId: 'customer-support-assistant-id',
   };
 </script>
@@ -71,7 +71,7 @@ Create a `.env` by copying `.env.example` file in your project root with the fol
 ```html
 <div
   data-chat-bubble
-  data-chat-bubble-api-url="https://company.localchat.at"
+  data-chat-bubble-api-url="https://company.headwai-one.at"
   data-chat-bubble-user-message-background-color="#ff9500"
   data-chat-bubble-ai-message-background-color="#00c851"
   data-chat-bubble-user-message-text-color="#ffffff"
@@ -80,7 +80,7 @@ Create a `.env` by copying `.env.example` file in your project root with the fol
 ></div>
 ```
 
-## Including Chat Bubble in Customer Websites
+## Including HeadwAI Chat Bubble in Customer Websites
 
 For simple integration instructions, see [README.md](README.md) which provides a streamlined guide for customers.
 
@@ -101,7 +101,7 @@ This project builds a standalone widget that can be integrated into any website.
 
 ```bash
 # Production .env file
-VITE_CHAT_BUBBLE_API_URL=https://company.localchat.at
+VITE_CHAT_BUBBLE_API_URL=https://company.headwai-one.at
 VITE_CHAT_BUBBLE_ASSISTANT_ID=customer-support-assistant-id
 ```
 
@@ -184,7 +184,7 @@ Once published to NPM, your package is automatically available on jsDelivr:
 
 ### APIs Called
 
-The chat bubble makes requests to the following API endpoints:
+The HeadwAI Chat Bubble makes requests to the following API endpoints:
 
 #### 1. Chat Creation API
 
@@ -848,7 +848,7 @@ Origin: http://localhost:5174
 
 ### Configuration Attributes
 
-The chat bubble can be configured using environment variables, data attributes, or runtime configuration. All attributes have fallback defaults.
+The HeadwAI Chat Bubble can be configured using environment variables, data attributes, or runtime configuration. All attributes have fallback defaults.
 
 #### Core API Configuration
 
@@ -887,7 +887,7 @@ The chat bubble can be configured using environment variables, data attributes,
 
 | Attribute     | Environment Variable            | Data Attribute                  | Purpose                    | Default               |
 | ------------- | ------------------------------- | ------------------------------- | -------------------------- | --------------------- |
-| `chatTitle`   | `VITE_CHAT_BUBBLE_CHAT_TITLE`   | `data-chat-bubble-chat-title`   | Title shown in chat header | `Headwai Chat Bubble` |
+| `chatTitle`   | `VITE_CHAT_BUBBLE_CHAT_TITLE`   | `data-chat-bubble-chat-title`   | Title shown in chat header | `HeadwAI Chat Bubble` |
 | `faviconPath` | `VITE_CHAT_BUBBLE_FAVICON_PATH` | `data-chat-bubble-favicon-path` | Path to chat icon/logo     | `./icons/favicon.svg` |
 
 ### API Request Flow and Data Format

package/README.md

@@ -1,19 +1,22 @@
-# Headwai Chat Bubble
+# HeadwAI Chat Bubble
 
 ## Features
 
-- 🚀 Easy integration
-- 💬 Connect to any LocalChat Assistant
-- 📋 Review conversations in LocalChat
+- 🚀 Easy integration into any Website
+- 💬 Connect to any [HeadwAI ONE](https://www.headwai.org/headwai-one) Assistant or [Open WebUI](https://openwebui.com) Model
+- 📋 Review conversations in [HeadwAI ONE](https://www.headwai.org/headwai-one) or [Open WebUI](https://openwebui.com) instance
+- 👍 Give Feedback on messages
+- 📥 Download Conversations in HeadwAI Chat Bubble
+- ✅ Terms of Use Check
+- 🎨 Fully brandable
 - 📱 Responsive design
 - 🎨 Customizable UI components
-- 🔄 Real-time messaging with WebSocket support
 - 🌍 Internationalization (i18n) support - Auto-detects browser language
 - 🇬🇧🇩🇪 Multi-language support (English, German)
 
 ### Easy Website Integration
 
-Add the Headwai Chat Bubble to the respective .html file.
+Add the HeadwAI Chat Bubble to the respective .html file.
 
 ```html
 <!DOCTYPE html>
@@ -24,13 +27,14 @@ Add the Headwai Chat Bubble to the respective .html file.
     <script>
       // Runtime configuration override
       window.HEADWAI_CHAT_BUBBLE_CONFIG = {
-        apiUrl: 'https://company.localchat.at', // required
+        apiUrl: 'https://company.headwai-one.at', // required
+        apiKey: 'your-api-key-here', // conditionally required: required for Open WebUI instances, optional for HeadwAI ONE
         assistantId: 'customer-support-assistant-id', // required
         maxMessages: 0, // optional - 0 means unlimited
         placeholderText: 'Ask your question here!', // optional - default: 'Enter your questions here'
         faviconPath: 'https://cdn.company.at/icons/favicon.svg', // optional - default: '/icons/favicon.svg'
         initialMessage: 'Hey! My name is Supporty, how can I help you?', // optional - default: 'Hey, how can I help you?'
-        chatTitle: 'Customer Support', // optional - default: 'Headwai Chat Bubble'
+        chatTitle: 'Customer Support', // optional - default: 'HeadwAI Chat Bubble'
         userMessageBackgroundColor: '#007bff', // optional - default: '#007bff'
         aiMessageBackgroundColor: '#f1f3f4', // optional - default: '#f1f3f4'
         userMessageTextColor: '#000000', // optional - default: '#000000'
@@ -49,7 +53,7 @@ Add the Headwai Chat Bubble to the respective .html file.
   <body>
     <!-- Your existing content -->
 
-    <!-- Chat Bubble Integration - Auto-initializes! -->
+    <!-- HeadwAI Chat Bubble Integration - Auto-initializes! -->
     <div id="chat-bubble-container"></div>
 
     <!-- Include from jsDelivr CDN -->
@@ -62,7 +66,7 @@ Add the Headwai Chat Bubble to the respective .html file.
 </html>
 ```
 
-Set the configuration of the Headwai Chat Bubble in the `<script>` tag of the `<head>`.
+Set the configuration of the HeadwAI Chat Bubble in the `<script>` tag of the `<head>`.
 Get the desired version of the JavaScript and CSS in your `<body>`.
 
 ```html
@@ -81,17 +85,18 @@ Get the desired version of the JavaScript and CSS in your `<body>`.
 <script src="https://cdn.jsdelivr.net/npm/@headwai/chat-bubble@1.0.0/dist-widget/chat-bubble.js"></script>
 ```
 
-Place the Headwai Chat Bubble into the `<body>` tag. It will apear on the right corner of your website.
+Place the HeadwAI Chat Bubble into the `<body>` tag. It will appear on the right corner of your website.
 
-#### Multiple Headwai Chat Bubbles
+#### Multiple HeadwAI Chat Bubbles
 
 For multiple instances use data attributes of the `<div>` tag for configuration instead.
 
 ```html
-<!-- Chat bubble with specific configuration -->
+<!-- HeadwAI Chat Bubble with specific configuration -->
 <div
   data-chat-bubble
-  data-chat-bubble-api-url="https://company.localchat.at"
+  data-chat-bubble-api-url="https://company.headwai-one.at"
+  data-chat-bubble-api-key="your-api-key-here"
   data-chat-bubble-assistant-id="customer-support-assistant-id"
   data-chat-bubble-max-messages="0"
   data-chat-bubble-placeholder-text="Ask your question here!"
@@ -111,10 +116,11 @@ For multiple instances use data attributes of the `<div>` tag for configuration
   data-chat-bubble-info-message="For help, contact support@example.com"
 ></div>
 
-<!-- Another chat bubble with different config -->
+<!-- Another HeadwAI Chat Bubble with different config -->
 <div
   data-chat-bubble
-  data-chat-bubble-api-url="https://company.localchat.at"
+  data-chat-bubble-api-url="https://company.headwai-one.at"
+  data-chat-bubble-api-key="your-api-key-here"
   data-chat-bubble-assistant-id="faq-assistant-id"
   data-chat-bubble-max-messages="10"
   data-chat-bubble-placeholder-text="Ask about our FAQ..."
@@ -139,35 +145,49 @@ For multiple instances use data attributes of the `<div>` tag for configuration
 
 ## Configuration
 
-The Headwai Chat Bubble can be configured using either the global `window.DEEP_CHAT_CONFIG` object or data attributes on individual chat bubble elements. Below are all available configuration options:
+The HeadwAI Chat Bubble can be configured using either the global `window.HEADWAI_CHAT_BUBBLE_CONFIG` object or data attributes on individual HeadwAI Chat Bubble elements. Below are all available configuration options:
 
 ### Required Configuration
 
 #### `apiUrl`
 
 **Type:** `string` | **Required:** ✅  
-The base URL of your LocalChat API endpoint where the chat bubble will send messages. This is the same URL you access your LocalCaht instance in the Webbrowser.
+The base URL of your HeadwAI ONE or Open WebUI API endpoint where the HeadwAI Chat Bubble will send messages. This is the same URL you access your HeadwAI ONE or Open WebUI instance in the web browser.
 
 ```javascript
-apiUrl: 'https://company.localchat.at';
+apiUrl: 'https://company.headwai-one.at';
 ```
 
+#### `apiKey`
+
+**Type:** `string` | **Required:** ⚠️ (Conditional)  
+API key for authentication with the API. This is **required** when using the HeadwAI Chat Bubble with a plain [Open WebUI](https://github.com/open-webui/open-webui) instance. When used with a HeadwAI ONE instance an API key is not needed.
+
+```javascript
+apiKey: 'your-api-key-here';
+```
+
+**When to use:**
+
+- ✅ **Required** for [Open WebUI](https://openwebui.com) instances
+- ⚠️ **Not Required** for [HeadwAI ONE](https://www.headwai.org/headwai-one) instances.
+
 #### `assistantId`
 
 **Type:** `string` | **Required:** ✅  
-The identifier of the AI assistant to use for generating responses. This should match an assistant configured in your LocalChat instance.
+The identifier of the AI assistant to use for generating responses. This should match an assistant configured in your [HeadwAI ONE](https://www.headwai.org/headwai-one) or a model configured in your [Open WebUI](https://openwebui.com) instance.
 
 ```javascript
 assistantId: 'customer-support-assistant-id';
 ```
 
-1. **Navigate to Assistant**: Login to LocalChat with the dedicated Headwai Chat Bubble user (Or any other user that is allowed to see the desired assistant) and click on the `Workspace` menu, then select `Assistants`. Search for the name of the desired assistant (Or create one). Click onto the edit-`Pen`.
+1. **Navigate to Assistant or Model**: Login to [HeadwAI ONE](https://www.headwai.org/headwai-one) or [Open WebUI](https://openwebui.com) with the dedicated HeadwAI Chat Bubble user (Or any other user that is allowed to see the desired assistant/model) and click on the `Workspace` menu, then select `Assistants` or `Models`. Search for the name of the desired assistant/model (Or create one). Click onto the edit-`Pen`.
 
-  <img src="docs/images/model-edit.png" alt="LocalChat User Menu" width="50%" />
+  <img src="docs/images/model-edit.png" alt="HeadwAI ONE User Menu" width="50%" />
 
-1. **Copy Assistant Id**: Now the assistant is displayed with its `name` and right underneath the `assistant-id`. Copy the `assistant-id`.
+1. **Copy Assistant Id or Model Id**: Now the assistant/model is displayed with its `name` and right underneath the `assistant-id`/`model-id`. Copy the `assistant-id`/`model-id`.
 
-  <img src="docs/images/model-id.png" alt="LocalChat User Menu" width="50%" />
+  <img src="docs/images/model-id.png" alt="HeadwAI ONE User Menu" width="50%" />
 
 ### Optional Configuration
 
@@ -192,7 +212,7 @@ placeholderText: 'Ask your question here!';
 #### `faviconPath`
 
 **Type:** `string` | **Default:** `'/icons/favicon.svg'`  
-Path or URL to the icon displayed on the chat bubble toggle button. Can be a relative path or absolute URL.
+Path or URL to the icon displayed on the HeadwAI Chat Bubble toggle button. Can be a relative path or absolute URL.
 
 ```javascript
 faviconPath: 'https://cdn.company.at/icons/favicon.svg';
@@ -209,7 +229,7 @@ initialMessage: 'Hey! My name is Supporty, how can I help you?';
 
 #### `chatTitle`
 
-**Type:** `string` | **Default:** `'Headwai Chat Bubble'`  
+**Type:** `string` | **Default:** `'HeadwAI Chat Bubble'`  
 The title displayed in the chat window header at the top of the chat interface. After the first AI response, this title will be automatically replaced with a generated title based on the conversation content.
 
 ```javascript
@@ -251,7 +271,7 @@ userMessageBackgroundColor: '#007bff';
 #### `aiMessageBackgroundColor`
 
 **Type:** `string` | **Default:** `'#f1f3f4'`  
-Background color for messages sent by the Headwai Chat Bubble. Accepts any valid CSS color value.
+Background color for messages sent by the HeadwAI Chat Bubble. Accepts any valid CSS color value.
 
 ```javascript
 aiMessageBackgroundColor: '#f1f3f4';
@@ -269,7 +289,7 @@ userMessageTextColor: '#ffffff';
 #### `aiMessageTextColor`
 
 **Type:** `string` | **Default:** `'#000000'`  
-Text color for Headwai Chat Bubble messages. Accepts any valid CSS color value.
+Text color for HeadwAI Chat Bubble messages. Accepts any valid CSS color value.
 
 ```javascript
 aiMessageTextColor: '#333333';
@@ -280,7 +300,7 @@ aiMessageTextColor: '#333333';
 **Type:** `string` | **Default:** `'#667eea'`  
 Primary color used throughout the chat interface. This color is applied to:
 
-- The chat bubble icon background
+- The HeadwAI Chat Bubble icon background
 - The chat header background
 - The submit button background
 
@@ -313,7 +333,7 @@ fontFamily: 'system-ui, -apple-system, sans-serif';
     rel="stylesheet"
   />
 
-  <!-- Your chat bubble configuration -->
+  <!-- Your HeadwAI Chat Bubble configuration -->
   <script>
     window.HEADWAI_CHAT_BUBBLE_CONFIG = {
       // ... other config
@@ -383,9 +403,10 @@ infoMessage: 'This chat service is powered by artificial intelligence and may oc
 
 ### Data Attribute Format
 
-When using data attributes for multiple chat bubbles, convert camelCase property names to kebab-case with the `data-chat-bubble-` prefix:
+When using data attributes for multiple HeadwAI Chat Bubbles, convert camelCase property names to kebab-case with the `data-chat-bubble-` prefix:
 
 - `apiUrl` → `data-chat-bubble-api-url`
+- `apiKey` → `data-chat-bubble-api-key`
 - `chatTitle` → `data-chat-bubble-chat-title`
 - `userMessageBackgroundColor` → `data-chat-bubble-user-message-background-color`
 - `initialMessage` → `data-chat-bubble-initial-message`
@@ -409,3 +430,24 @@ When using data attributes for multiple chat bubbles, convert camelCase property
 />
 <script src="https://cdn.jsdelivr.net/npm/@headwai/chat-bubble@1.2.3/dist-widget/chat-bubble.js"></script>
 ```
+
+## License
+
+This project is licensed under the MIT License – see the [LICENSE](LICENSE) file for details.
+Future versions of this project may be released under a different license.
+
+## Third-Party Software
+
+See [THIRD_PARTY_LICENSES.md](THIRD_PARTY_LICENSES.md) for license information of third-party dependencies.
+
+# Contributing
+
+Thank you for contributing!
+
+By submitting a pull request, you agree to the terms of the
+[Contributor License Agreement (CLA)](CLA.md).
+
+Please ensure that:
+
+- You have the right to submit the contribution
+- Your contribution is your own work

package/dist-widget/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 headwAI GmbH
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/dist-widget/THIRD_PARTY_LICENSES.md

@@ -0,0 +1,44 @@
+# Third-Party Licenses
+
+This project includes third-party software. The following licenses and notices
+apply to the respective components.
+
+---
+
+## deep-chat (v2.3.0)
+
+Copyright (c) Ovidijus Parsiunas
+
+Licensed under the MIT License:
+
+```
+MIT License
+
+Copyright (c) Ovidijus Parsiunas
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+```
+
+---
+
+## Notes
+
+- This file lists third-party components that are directly used by this project.
+- Licenses are reproduced here as required by their respective terms.
+- The inclusion of a license does not imply endorsement by the respective authors.