cevro-messenger-sdk 0.1.11 → 0.1.13

package/README.md

@@ -35,7 +35,6 @@ All options are passed inside `window.cevroSettings` in the snippet above:
 | `workspaceId` | `string` | Yes | Your Cevro workspace ID |
 | `brandId` | `string` | Yes | Brand ID for the workspace |
 | `player` | `object` | No | Authenticated user information (see below) |
-| `agentId` | `string` | No | Route conversations to a specific agent |
 | `alignment` | `'left' \| 'right'` | No | Horizontal position of the widget |
 | `verticalPadding` | `number` | No | Padding from bottom (px) |
 | `horizontalPadding` | `number` | No | Padding from edge (px) |
@@ -113,9 +112,35 @@ window.cevroSettings = {
 };
 ```
 
+All properties are optional. Set just `primaryColor` to derive all accent colors automatically, or override individual properties via `theme` for full control. Theme can also be managed from the admin dashboard (**Settings → Cevro → Appearance**).
+
+| Property | Type | Description |
+|----------|------|-------------|
+| `backgroundColor` | `string` | Main background color |
+| `backgroundSecondaryColor` | `string` | Secondary/alternate background |
+| `textColor` | `string` | Primary text color |
+| `textSecondaryColor` | `string` | Secondary/muted text color |
+| `borderColor` | `string` | Border color |
+| `userMessageBackgroundColor` | `string` | User message bubble background |
+| `userMessageTextColor` | `string` | User message text color |
+| `agentMessageBackgroundColor` | `string` | Agent/AI message bubble background |
+| `agentMessageTextColor` | `string` | Agent/AI message text color |
+| `headerBackgroundColor` | `string` | Header background color |
+| `headerTextColor` | `string` | Header text color |
+| `inputBackgroundColor` | `string` | Input field background color |
+| `launcherBackgroundColor` | `string` | Launcher button background |
+| `launcherIconColor` | `string` | Launcher button icon color |
+| `launcherHoverShadowColor` | `string` | Launcher hover shadow color |
+| `sendButtonBackgroundColor` | `string` | Send button background |
+| `sendButtonIconColor` | `string` | Send button icon color |
+| `fileButtonBackgroundColor` | `string` | File button background |
+| `fileButtonIconColor` | `string` | File button icon color |
+| `borderRadius` | `number` | Border radius in pixels |
+| `shadowColor` | `string` | Shadow color (e.g. `'rgba(0,0,0,0.2)'`) |
+
 ### Locale
 
-Override default UI texts via `locale`:
+The widget language is detected automatically from the player's browser. To override specific UI texts, use `locale`:
 
 ```javascript
 window.cevroSettings = {
@@ -151,45 +176,24 @@ Cevro('shutdown', { clearVisitorData: true }); // Remove and clear visitor data
 Cevro('getUnreadCount');                // Get unread message count
 Cevro('getVisitorId');                  // Get current visitor ID
 
-// Update player data (e.g., after login)
-Cevro('update', {
+// Identify a player after login (soft re-init, no flicker)
+Cevro('identify', {
   playerId: 'user-123',
   email: 'user@example.com',
   firstName: 'John',
+  playerHash: 'hmac-hash-for-verification',
+  customAttributes: { vipLevel: 'gold' },
 });
 
-// Subscribe to events
-Cevro('on', 'message:received', function(data) {
-  console.log('New message:', data.message.body);
+// Update SDK config
+Cevro('update', {
+  player: {
+    playerId: 'user-123',
+    email: 'user@example.com',
+  },
 });
 ```
 
-Commands can be queued before the SDK finishes loading — they will be replayed automatically.
-
-## Events
-
-| Event | Payload | Description |
-|-------|---------|-------------|
-| `boot` | - | Widget initialized |
-| `ready` | - | WebSocket connected and ready |
-| `show` | - | Chat window opened |
-| `hide` | - | Chat window closed |
-| `shutdown` | - | Widget removed |
-| `session:initialized` | `{ sessionId, contactId, ticketId, isNewSession, isNewTicket }` | Session created/restored |
-| `message:received` | `{ ticketId, message }` | New message from agent/AI |
-| `message:sent` | `{ message }` | Message sent |
-| `unread_count_change` | `{ count }` | Unread count changed |
-| `conversation:started` | `{ ticketId }` | New conversation started |
-| `conversation:updated` | `{ ticketId, status }` | Conversation status changed |
-| `chat:new_started` | - | New chat started after previous closed |
-| `typing:start` | `{ ticketId, actor }` | Agent/AI started typing |
-| `typing:stop` | `{ ticketId, actor }` | Agent/AI stopped typing |
-| `error` | `{ type, error, message? }` | An error occurred |
-| `connection:open` | - | WebSocket connected |
-| `connection:close` | - | WebSocket disconnected |
-| `connection:error` | `{ error }` | WebSocket error |
-| `appearance:updated` | `WidgetAppearance` | Widget appearance config updated |
-
 ## License
 
 MIT