@sprout_ai_labs/sidekick 1.2.4 → 1.2.6

package/README.md

@@ -18,6 +18,7 @@ A Vue 3 plugin providing responsive chat components with custom Sidekick brandin
 - 🔔 **Error Handling**: Built-in snackbar notifications for errors and success messages
 - 📝 **Markdown Support**: Rich text rendering in messages
 - 🔍 **KB Sources**: Citation support for knowledge base sources
+- 📊 **Analytics Control**: Optional analytics tracking with standalone mode support
 
 ## Demo
 
@@ -163,6 +164,7 @@ interface SidekickChatOptions {
   skipDesignSystem?: boolean // Optional: Skip design system installation
   baseUrl?: string // Optional: Custom backend URL (overrides mode)
   deviceSource?: 'mobile' | 'web' // Optional: Device type (default: 'web')
+  standalone?: boolean // Optional: Disable analytics tracking (default: false)
 }
 ```
 
@@ -176,6 +178,7 @@ interface SidekickChatOptions {
 - **`baseUrl`**: Custom backend URL (takes precedence over `mode`)
 - **`deviceSource`**: Device type identifier (`'mobile'` or `'web'`, default: `'web'`)
 - **`skipDesignSystem`**: Skip design system installation if already installed
+- **`standalone`**: Disable analytics tracking when `true` (default: `false`)
 
 ### Environment Variables
 
@@ -227,6 +230,16 @@ app.use(SproutSidekickPlugin, {
 })
 ```
 
+**Standalone mode (disable analytics):**
+
+```javascript
+app.use(SproutSidekickPlugin, {
+  mode: 'PROD', // Required
+  appName: 'My App', // Required
+  standalone: true, // Disables all analytics tracking
+})
+```
+
 **Priority Order for Backend URL:**
 
 1. `baseUrl` (if provided) - highest priority
@@ -237,6 +250,32 @@ app.use(SproutSidekickPlugin, {
 Both `mode` and `appName` are **required**. The plugin will throw an error at installation time if either is missing.
 :::
 
+### Analytics Tracking
+
+By default, the plugin tracks analytics for all chat interactions. You can disable analytics by setting `standalone: true`:
+
+```javascript
+// Analytics enabled (default)
+app.use(SproutSidekickPlugin, {
+  mode: 'PROD',
+  appName: 'My App',
+  // standalone: false (default)
+})
+
+// Analytics disabled
+app.use(SproutSidekickPlugin, {
+  mode: 'PROD',
+  appName: 'My App',
+  standalone: true, // All analytics calls are skipped
+})
+```
+
+When `standalone: true` is set:
+- All analytics logging is disabled
+- No data is sent to the analytics endpoints
+- Feature flag validation calls are skipped
+- Perfect for development, testing, or privacy-focused implementations
+
 ### Design System Handling
 
 The plugin automatically detects if the Sprout Design System is already installed in your application to prevent duplicate installations. This ensures optimal performance and avoids conflicts.
@@ -301,6 +340,7 @@ interface SidekickChatOptions {
   skipDesignSystem?: boolean
   baseUrl?: string
   deviceSource?: 'mobile' | 'web'
+  standalone?: boolean
 }
 
 // Chat message