@deway-ai/web-sdk 0.52.0 → 0.53.0

package/README.md

@@ -2,11 +2,13 @@
 
 [![Accessibility](https://img.shields.io/badge/accessibility-WCAG%202.1%20AA-green)](./documentation/accessibility/compliance.md)
 
-A lightweight TypeScript SDK for adding an AI-powered user engagement engine by Deway to your web app.
+**Software should adapt to users — not the other way around.**
+
+Deway is your AI assistant that learns your product, embedding proactive guidance directly into your web app. Scale expert knowledge across your entire user base with real-time, intelligent assistance that continuously improves with every interaction.
 
 ## Quick Install with AI Assistant
 
-Copy and paste this prompt to your AI coding assistant (Claude, Copilot, etc.) to get Deway set up with best practices:
+Let AI help AI. Copy this prompt to your coding assistant (Claude, Copilot, etc.) to get Deway integrated with best practices for your specific framework:
 
 ```text
 Install and integrate the Deway Web SDK (@deway-ai/web-sdk) into my project.
@@ -38,6 +40,8 @@ FIRST analyze my project structure and detect the framework and package manager.
 
 ## Installation
 
+Add Deway to your project with your preferred package manager:
+
 ```bash
 npm install @deway-ai/web-sdk
 # or
@@ -58,11 +62,11 @@ Deway.init({
     appKey: 'your-app-key'
 });
 
-// Identify a user
+// Identify users for personalized experiences
 Deway.identify('user-123');
 ```
 
-**Note:** While methods can be called immediately (they're queued until initialization completes), best practice is to call `Deway.init()` early in your app lifecycle.
+**Note:** Methods can be called immediately and are queued until initialization completes. For best results, call `Deway.init()` early in your app lifecycle to start learning user patterns from the first interaction.
 
 ### HTML/JavaScript Integration
 
@@ -80,27 +84,29 @@ Deway.identify('user-123');
 
 ## Configuration
 
+Deway keeps configuration simple—just provide your app key and we handle the rest:
+
 ```typescript
 Deway.init({
     appKey: string,                               // Required: Your Deway app key
 });
 ```
 
-**Note:** Most configuration options (themes, feature flags, prompts, etc.) are managed remotely and automatically fetched during initialization. Only the fields above are configurable by SDK callers.
+**Why so simple?** Themes, feature flags, AI prompts, and behavior settings are managed remotely and adapt automatically. This lets you iterate on user experiences without SDK updates or app deployments.
 
 ## API Reference
 
 ### `Deway.init(config)`
 
-Initialize the SDK with configuration options. Should be called early in your app lifecycle (commands are queued until initialization completes).
+Start learning your product and embedding intelligent guidance into your app. Call this early in your app lifecycle to begin building user-specific insights (commands are queued until initialization completes).
 
 ### `Deway.identify(userId)`
 
-Associate a user ID with the current session for personalized experiences.
+Connect a user ID to enable personalized, context-aware assistance that adapts to their unique journey.
 
 ### `Deway.reportEvent(name, params)`
 
-Report a custom event with the given name and parameters.
+Track custom events to help Deway understand your product's unique workflows and provide smarter, context-aware guidance.
 
 **Parameters:**
 
@@ -120,7 +126,7 @@ Deway.reportEvent('Product Purchased', {
 
 ### `Deway.setUserProfile(userProfile)`
 
-Set or update the user profile for the currently identified user.
+Enrich user profiles to enable deeper personalization and more intelligent assistance tailored to each user's context.
 
 **Parameters:**
 
@@ -147,7 +153,7 @@ Deway.setUserProfile({
 
 ### `Deway.show(config?)`
 
-Show the AI chat interface. Optional configuration:
+Display the AI assistant interface that adapts to your users' needs. Choose the appearance that fits your product best.
 
 ```typescript
 interface EntrypointWidgetConfig {
@@ -156,16 +162,16 @@ interface EntrypointWidgetConfig {
 ```
 
 **Appearance Modes:**
-- `"bookmark"`: Edge-pinned vertical tab (default)
-- `"bubble"`: Floating ellipsoid pill at bottom-right corner
+- `"bookmark"`: Edge-pinned vertical tab for persistent, non-intrusive access (default)
+- `"bubble"`: Floating ellipsoid pill at bottom-right for prominent visibility
 
 ### `Deway.hide()`
 
-Hide the AI chat interface.
+Temporarily hide the AI assistant interface while keeping the intelligent learning active in the background.
 
 ### `Deway.openChat()`
 
-Programmatically opens the chat interface. This is equivalent to the user clicking the entrypoint widget (bubble or bookmark).
+Programmatically open the chat interface to guide users exactly when they need assistance. Perfect for contextual help triggers.
 
 **Example:**
 
@@ -196,6 +202,8 @@ Clean up SDK resources and stop all tracking.
 
 ## Framework Examples
 
+Deway adapts seamlessly to your framework of choice. Here's how to integrate intelligent user assistance into popular frameworks:
+
 ### React
 
 ```tsx
@@ -208,7 +216,7 @@ function App() {
             appKey: 'your-app-key'
         });
 
-        // Identify user when available
+        // Enable personalized assistance when user is known
         if (user?.id) {
             Deway.identify(user.id);
         }
@@ -253,56 +261,59 @@ export class AppComponent implements OnInit {
 }
 ```
 
-## Features
+## What You Get
 
-- **AI-powered user engagement and assistance**: Interactive chat interface for user support
-- **Automatic user behavior analysis**: Intelligent tracking and understanding of user interactions
-- **Remote configuration management**: Feature flags, themes, and prompts managed remotely
-- **Dual appearance modes**: Edge-pinned bookmark or floating bubble display
-- **Framework-agnostic integration**: Works with React, Vue, Angular, and vanilla JavaScript
-- **Full TypeScript support**: Complete type definitions included
-- **Lightweight loader**: ~5KB loader shell with dynamic backend loading
-- **Offline resilience**: Backend bundle cached locally for faster loads
+- **Proactive AI Guidance**: Intelligent assistance that learns your product and adapts to each user's journey
+- **Real-time Issue Prevention**: Detect and resolve problems before users encounter them
+- **Continuous Learning**: Self-improving knowledge graph that gets smarter with every interaction
+- **Scaled Expert Knowledge**: Give every user the experience of having a dedicated specialist
+- **Seamless Integration**: Works with React, Vue, Angular, and vanilla JavaScript
+- **Zero Configuration Overhead**: Feature flags, themes, and AI prompts managed remotely
+- **Performance First**: ~5KB loader with dynamic backend loading and offline resilience
+- **Full TypeScript Support**: Complete type definitions for a superior developer experience
 
-## Edge Cases & Internal Behavior
+## How Deway Adapts for You
 
-### Error Handling
+### Graceful Error Handling
 
-The SDK handles all errors internally. Callers don't need try-catch blocks around SDK methods. Failed operations are logged to the console and retried automatically when appropriate.
+The SDK handles all errors internally with intelligent recovery. No try-catch blocks needed—failed operations are logged and retried automatically so your app stays resilient.
 
-### State Persistence
+### Persistent User Context
 
-User identification and settings persist across page reloads via localStorage. Once a user is identified, they remain identified until `Deway.destroy()` is called or localStorage is cleared.
+User identification and preferences persist across sessions via localStorage. Once identified, users receive continuous personalized assistance until you explicitly call `Deway.destroy()` or clear storage.
 
-### Multiple init() Calls
+### Idempotent Initialization
 
-Calling `Deway.init()` multiple times is safe. Subsequent calls after the first are ignored.
+Multiple `Deway.init()` calls are safe and ignored after the first. The SDK adapts to your initialization patterns without breaking.
 
-### Automatic Retries
+### Smart Retry Logic
 
-Failed API calls and uploads are automatically retried with exponential backoff. No manual intervention is required.
+Failed network operations automatically retry with exponential backoff. The SDK handles connectivity issues gracefully—no manual intervention required.
 
-### Command Queue
+### Intelligent Command Queuing
 
-All SDK methods can be called immediately, even before initialization completes. The loader queues commands and executes them automatically once the backend bundle loads and `Deway.init()` completes.
+Call SDK methods immediately without waiting for initialization. Commands queue automatically and execute once the backend loads—your code stays simple while Deway handles the complexity.
 
 ## Troubleshooting
 
 ### Interface doesn't appear
 
-- Verify `Deway.init()` was called with valid `appKey`
-- Check if auto-show is enabled in your remote configuration, or manually call `Deway.show()`
-- Check browser console for initialization errors
-- Verify the SDK completed initialization with `Deway.isInitialized()`
+Deway adapts its visibility to your configuration. Check these common solutions:
+- Verify `Deway.init()` was called with a valid `appKey`
+- Enable auto-show in your remote configuration, or call `Deway.show()` manually
+- Confirm initialization completed using `Deway.isInitialized()`
+- Check browser console for initialization errors—the SDK logs helpful guidance
 
 ### User identification not working
 
-- Ensure `Deway.init()` is called before `Deway.identify()`
-- User ID must be a non-empty string
-- Check browser console for error logs
+For personalized experiences to activate:
+- Call `Deway.init()` before `Deway.identify()`—initialization must complete first
+- Ensure user ID is a non-empty string
+- Check browser console for diagnostic logs—Deway provides clear error messages
 
 ### Commands not executing
 
-- The SDK queues commands called before initialization
-- Commands execute automatically once `Deway.init()` completes
-- Check browser console for errors during initialization
+Deway's intelligent command queue handles this automatically:
+- Commands called before initialization are queued and execute once ready
+- Check `Deway.isInitialized()` to confirm the SDK is ready
+- Review browser console for any initialization errors—Deway adapts and retries when possible

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@deway-ai/web-sdk",
-  "version": "0.52.0",
+  "version": "0.53.0",
   "type": "module",
   "description": "Deway's Web SDK",
   "main": "dist/loader.umd.js",