@centive/aria-sdk 0.7.8 → 0.8.0

package/README.md

@@ -250,12 +250,88 @@ You don't need to manage any of these - the SDK handles them internally:
 | **Auto-Reconnect** | Exponential backoff (1s → 30s max), up to 10 attempts |
 | **Session Refresh** | Refreshes 5 minutes before expiry |
 | **Tab Visibility** | Only refreshes when tab is active |
-| **Session Persistence** | Survives page navigation, widget close/reopen |
+| **Session Persistence** | Video and session survive page navigation when SDK is at root level |
 | **Error Recovery** | Automatic retries with backoff |
 | **UI Rendering** | Mounts trigger button and widget to DOM |
 
 ---
 
+## Important: SDK Placement for Session Persistence
+
+For the video session to persist across page navigation (no black screen when switching pages), ensure the SDK is initialized at the **root level** of your application, outside of any route-specific components.
+
+### Correct Placement
+
+```tsx
+// App.tsx or _app.tsx - SDK at root level
+import { Aria } from '@centive/aria-sdk';
+
+// Initialize once at app startup (outside component or in useEffect with empty deps)
+Aria.init({
+  websocketUrl: 'wss://your-server.com/ws',
+  userId: 'user_123',
+});
+
+function App() {
+  return (
+    <Router>
+      <Routes>
+        <Route path="/" element={<HomePage />} />
+        <Route path="/dashboard" element={<DashboardPage />} />
+        <Route path="/settings" element={<SettingsPage />} />
+        {/* SDK persists across all routes - video stays connected */}
+      </Routes>
+    </Router>
+  );
+}
+```
+
+### Incorrect Placement (causes video to reset on navigation)
+
+```tsx
+// DON'T initialize inside route components - this will reinitialize on every navigation!
+function SettingsPage() {
+  useEffect(() => {
+    Aria.init({ ... }); // Bad - reinitializes when navigating to this page
+  }, []);
+  
+  return <div>Settings</div>;
+}
+```
+
+### For React Provider Pattern
+
+If using the Provider pattern, wrap your entire app at the root:
+
+```tsx
+// Correct - Provider at root, outside Router
+function App() {
+  return (
+    <AriaProvider config={config}>
+      <Router>
+        <Routes>
+          <Route path="/" element={<HomePage />} />
+          <Route path="/settings" element={<SettingsPage />} />
+        </Routes>
+      </Router>
+    </AriaProvider>
+  );
+}
+```
+
+```tsx
+// Incorrect - Provider inside routes (will remount on navigation!)
+function SettingsPage() {
+  return (
+    <AriaProvider config={config}>
+      <SettingsContent />
+    </AriaProvider>
+  );
+}
+```
+
+---
+
 ## Security Best Practices
 
 ### Do

package/dist/components/AriaAssistant.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"AriaAssistant.d.ts","sourceRoot":"","sources":["../../src/components/AriaAssistant.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,EAAE,EAAE,MAAM,OAAO,CAAC;AAOhC,UAAU,kBAAkB;IAC1B,uDAAuD;IACvD,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,oDAAoD;IACpD,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,sCAAsC;IACtC,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED,eAAO,MAAM,aAAa,EAAE,EAAE,CAAC,kBAAkB,CA+DhD,CAAC"}
+{"version":3,"file":"AriaAssistant.d.ts","sourceRoot":"","sources":["../../src/components/AriaAssistant.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,EAAE,EAAE,MAAM,OAAO,CAAC;AAOhC,UAAU,kBAAkB;IAC1B,uDAAuD;IACvD,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,oDAAoD;IACpD,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,sCAAsC;IACtC,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED,eAAO,MAAM,aAAa,EAAE,EAAE,CAAC,kBAAkB,CA8DhD,CAAC"}

package/dist/components/AriaStandaloneUI.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"AriaStandaloneUI.d.ts","sourceRoot":"","sources":["../../src/components/AriaStandaloneUI.tsx"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,OAAO,EAA4C,KAAK,EAAE,EAAE,MAAM,OAAO,CAAC;AAgB1E,OAAO,KAAK,EAOV,KAAK,EACN,MAAM,SAAS,CAAC;AAOjB,UAAU,qBAAqB;IAC7B,KAAK,EAAE,KAAK,CAAC;IACb,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,SAAS,EAAE,WAAW,CAAC;CACxB;AAED,eAAO,MAAM,gBAAgB,EAAE,EAAE,CAAC,qBAAqB,CA2dtD,CAAC;AAk5BF,eAAe,gBAAgB,CAAC"}
+{"version":3,"file":"AriaStandaloneUI.d.ts","sourceRoot":"","sources":["../../src/components/AriaStandaloneUI.tsx"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,OAAO,EAA4C,KAAK,EAAE,EAAE,MAAM,OAAO,CAAC;AAgB1E,OAAO,KAAK,EAOV,KAAK,EACN,MAAM,SAAS,CAAC;AAOjB,UAAU,qBAAqB;IAC7B,KAAK,EAAE,KAAK,CAAC;IACb,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,SAAS,EAAE,WAAW,CAAC;CACxB;AAED,eAAO,MAAM,gBAAgB,EAAE,EAAE,CAAC,qBAAqB,CA8etD,CAAC;AAk5BF,eAAe,gBAAgB,CAAC"}

package/dist/context/AriaProvider.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"AriaProvider.d.ts","sourceRoot":"","sources":["../../src/context/AriaProvider.tsx"],"names":[],"mappings":"AAAA,OAAO,EAA4C,KAAK,EAAE,EAAE,KAAK,SAAS,EAAE,MAAM,OAAO,CAAC;AAW1F,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AAK7C,UAAU,iBAAiB;IACzB,MAAM,EAAE,aAAa,CAAC;IACtB,QAAQ,CAAC,EAAE,SAAS,CAAC;CACtB;AAMD,eAAO,MAAM,YAAY,EAAE,EAAE,CAAC,iBAAiB,CA0jB9C,CAAC"}
+{"version":3,"file":"AriaProvider.d.ts","sourceRoot":"","sources":["../../src/context/AriaProvider.tsx"],"names":[],"mappings":"AAAA,OAAO,EAA4C,KAAK,EAAE,EAAE,KAAK,SAAS,EAAE,MAAM,OAAO,CAAC;AAW1F,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AAK7C,UAAU,iBAAiB;IACzB,MAAM,EAAE,aAAa,CAAC;IACtB,QAAQ,CAAC,EAAE,SAAS,CAAC;CACtB;AAMD,eAAO,MAAM,YAAY,EAAE,EAAE,CAAC,iBAAiB,CAmkB9C,CAAC"}