@rtrvr-ai/rover 1.1.2 → 1.2.1

package/README.md

@@ -104,7 +104,8 @@ const RoverWidget = dynamic(() => import('./RoverWidget'), { ssr: false });
 | `apiKey` | `string` | — | API key from Rover Workspace |
 | `siteKeyId` | `string` | — | Site key ID from Workspace |
 | `authToken` | `string` | — | Optional bearer token override (takes precedence over `apiKey` when both are set) |
-| `apiBase` | `string` | `https://extensionrouter.rtrvr.ai` | Optional API base override. For custom domain routing you can pass the base directly (no `/extensionRouter` suffix required). |
+| `visitor` | `{ name?: string; email?: string }` | — | Optional visitor profile for greeting personalization. Recommended flow is async updates via `identify(...)` after login/user hydration. |
+| `apiBase` | `string` | `https://extensionrouter.rtrvr.ai` | Optional API base override. Workspace snippets keep the managed default; code integrations can pass a custom base directly (no `/extensionRouter` suffix required). |
 | `allowedDomains` | `string[]` | `[]` | Hostnames where Rover may operate |
 | `domainScopeMode` | `'registrable_domain' \| 'host_only'` | `'registrable_domain'` | Domain matching strategy |
 | `externalNavigationPolicy` | `'open_new_tab_notice' \| 'block' \| 'allow'` | `'open_new_tab_notice'` | External navigation policy |
@@ -121,10 +122,10 @@ const RoverWidget = dynamic(() => import('./RoverWidget'), { ssr: false });
 | `checkpointing.onStateChange` | `(payload) => void` | — | Checkpoint lifecycle updates (`active`, `paused_auth`) |
 | `checkpointing.onError` | `(payload) => void` | — | Checkpoint request error callback |
 | `telemetry.enabled` | `boolean` | `true` | Enable runtime telemetry batching |
-| `telemetry.sampleRate` | `number` | `1` | Event sampling ratio (0..1) |
-| `telemetry.flushIntervalMs` | `number` | `12000` | Telemetry flush cadence |
-| `telemetry.maxBatchSize` | `number` | `30` | Max events per telemetry request |
-| `telemetry.includePayloads` | `boolean` | `false` | Include richer event payloads |
+| `telemetry.sampleRate` | `number` | `1` | Sampling ratio (`1` = all events, `0.1` ≈ 10%) |
+| `telemetry.flushIntervalMs` | `number` | `12000` | Flush cadence for buffered telemetry events |
+| `telemetry.maxBatchSize` | `number` | `30` | Maximum number of telemetry events sent per flush request |
+| `telemetry.includePayloads` | `boolean` | `false` | Include richer per-event payload details (debug/tool context). Increases telemetry volume and may include sensitive runtime content. |
 | `apiMode` | `boolean` | auto (`true` when `apiKey` exists) | Force API execution mode |
 | `apiToolsConfig.mode` | `'allowlist' \| 'profile' \| 'none'` | `'none'` | API additional tool exposure mode |
 | `tools.web.enableExternalWebContext` | `boolean` | `false` | External tab cloud context fallback |
@@ -141,6 +142,11 @@ const RoverWidget = dynamic(() => import('./RoverWidget'), { ssr: false });
 | `ui.thoughtStyle` | `'concise_cards' \| 'minimal'` | `'concise_cards'` | Thought rendering style |
 | `ui.panel.resizable` | `boolean` | `true` | Panel resizable preference |
 | `ui.showTaskControls` | `boolean` | `true` | Show new/end task controls |
+| `ui.shortcuts` | `RoverShortcut[]` | `[]` | Suggested journeys (max 100 stored, max 12 rendered by default; lower site-key policy caps are enforced) |
+| `ui.greeting` | `{ text?, delay?, duration?, disabled? }` | — | Greeting bubble config (`{name}` token supported) |
+
+When a site key is used, Rover also fetches cloud site config via `roverGetSiteConfig` (shortcuts + greeting).  
+If the same field exists in both cloud config and boot config, boot config wins.
 
 If you enable `tools.web.scrapeMode: 'on_demand'`, use a site key capability profile that includes cloud scrape support.
 
@@ -174,6 +180,7 @@ rover.send('Hello');
 | `getState()` | Get current runtime state |
 | `update(config)` | Update configuration without rebooting |
 | `registerTool(def, handler)` | Register a client-side tool |
+| `identify(visitor)` | Update visitor profile after boot (for async login/user hydration) |
 | `on(event, handler)` | Subscribe to events (returns unsubscribe fn) |
 
 ## Events