@vizbeetv/sdk-qa 7.8.36 → 7.8.38

package/README.md

@@ -1,11 +1,11 @@
-# @vizbee/sdk-qa
+# @vizbeetv/sdk-qa
 
 Vizbee TV SDK — pre-built platform bundles distributed as a single npm package with subpath exports.
 
 ## Installation
 
 ```sh
-npm install @vizbee/sdk-qa
+npm install @vizbeetv/sdk-qa
 ```
 
 ## Usage
@@ -16,52 +16,46 @@ Import the subpath that matches your target platform. Each subpath resolves to a
 
 ```js
 // ES5 — Tizen 2.x / Chrome 38+ (default)
-import vizbee from '@vizbee/sdk-qa/samsung';
+import vizbee from '@vizbeetv/sdk-qa/samsung';
 
 // ES6 — Tizen 5.5+ / Chrome 72+
-import vizbee from '@vizbee/sdk-qa/samsung/es6';
+import vizbee from '@vizbeetv/sdk-qa/samsung/es6';
 ```
 
 ### LG (WebOS)
 
 ```js
 // ES5 — WebOS 3.x / Chrome 38+ (default)
-import vizbee from '@vizbee/sdk-qa/lg';
+import vizbee from '@vizbeetv/sdk-qa/lg';
 
 // ES6 — WebOS 6+ / Chrome 72+
-import vizbee from '@vizbee/sdk-qa/lg/es6';
+import vizbee from '@vizbeetv/sdk-qa/lg/es6';
 ```
 
 ### Vizio SmartCast
 
 ```js
-import vizbee from '@vizbee/sdk-qa/vizio';
+import vizbee from '@vizbeetv/sdk-qa/vizio';
 ```
 
 ### Xbox
 
 ```js
 // ES5 (default)
-import vizbee from '@vizbee/sdk-qa/xbox';
+import vizbee from '@vizbeetv/sdk-qa/xbox';
 
 // ES6
-import vizbee from '@vizbee/sdk-qa/xbox/es6';
-```
-
-### Chromecast CAF (v3)
-
-```js
-import vizbee from '@vizbee/sdk-qa/chromecast';
+import vizbee from '@vizbeetv/sdk-qa/xbox/es6';
 ```
 
 ### Chromecast v2 (MediaManager)
 
 ```js
 // ES5 (default)
-import vizbee from '@vizbee/sdk-qa/chromecast-v2';
+import vizbee from '@vizbeetv/sdk-qa/chromecast-v2';
 
 // ES6
-import vizbee from '@vizbee/sdk-qa/chromecast-v2/es6';
+import vizbee from '@vizbeetv/sdk-qa/chromecast-v2/es6';
 ```
 
 ## Platform reference
@@ -75,10 +69,40 @@ import vizbee from '@vizbee/sdk-qa/chromecast-v2/es6';
 | `/vizio` | Vizio SmartCast | ES5 |
 | `/xbox`, `/xbox/es5` | Xbox | ES5 |
 | `/xbox/es6` | Xbox | ES6 |
-| `/chromecast` | Chromecast CAF (v3) | ES5 |
 | `/chromecast-v2`, `/chromecast-v2/es5` | Chromecast v2 (MediaManager) | ES5 |
 | `/chromecast-v2/es6` | Chromecast v2 (MediaManager) | ES6 |
 
+## TypeScript
+
+The package ships TypeScript declarations. The default export is the typed SDK
+instance — its `continuity` API (context, adapters, messages) is fully typed —
+and the SDK's public types are also importable as named exports for use in
+annotations:
+
+```ts
+import vizbee, {
+  VideoInfo,
+  PlayerAdapter,
+  SessionState,
+  VizbeeMessagingClient,
+} from '@vizbeetv/sdk-qa/samsung';
+
+// Default export: the SDK instance. Its continuity API is typed end-to-end.
+const ctx = vizbee.continuity.ContinuityContext.getInstance();
+ctx.start('vzb1234567');
+ctx.getAppAdapter().setDeeplinkHandler((video: VideoInfo) => {
+  /* deeplink into video.guid / video.videoUrl … */
+});
+
+// Named exports: use the SDK's types in your own signatures.
+function onSessionState(state: SessionState) { /* ... */ }
+```
+
+The same type surface is exposed from every platform subpath.
+
+> Requires `moduleResolution` set to `bundler`, `node16`, or `nodenext` in your
+> `tsconfig.json` (the same requirement as resolving the platform subpaths).
+
 ## Window globals
 
 Each bundle also sets `window.VizbeeSDK` and `window.vizbee` on load for backward compatibility with existing script-tag consumers. The default export and the window global point to the same object.