@vizbeetv/sdk-qa 7.8.37 → 7.8.38

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (30) hide show
  1. package/README.md +31 -7
  2. package/chromecast-v2/es5/index.js +1 -1
  3. package/chromecast-v2/es6/index.js +1 -1
  4. package/lg/es5/index.js +1 -1
  5. package/lg/es6/index.js +1 -1
  6. package/package.json +54 -15
  7. package/samsung/es5/index.js +1 -1
  8. package/samsung/es6/index.js +1 -1
  9. package/types/index.d.ts +486 -0
  10. package/types/vtvsdk/src/core/session/SessionState.d.ts +45 -0
  11. package/types/vtvsdk/src/core/session/SessionStateListener.d.ts +23 -0
  12. package/types/vtvsdk/src/core/session/base/VizbeeMessagingClient.d.ts +38 -0
  13. package/types/vtvsdk/src/core/session/base/VizbeePresenceClient.d.ts +7 -0
  14. package/types/vtvsdk/src/core/session/bicast/VizbeeBicastMemberPresenceClientImpl.d.ts +17 -0
  15. package/types/vtvsdk/src/core/session/bicast/VizbeeBicastMessagingClientImpl.d.ts +54 -0
  16. package/types/vtvsdk/src/core/session/bicast/VizbeeBicastSession.d.ts +25 -0
  17. package/types/vtvsdk/src/core/session/bicast/VizbeeBicastSessionManager.d.ts +63 -0
  18. package/types/vtvsdk/src/core/session/bicast/VizbeePresenceManager.d.ts +24 -0
  19. package/types/vtvsdk/src/core/session/models/MemberInfo.d.ts +39 -0
  20. package/types/vtvsdk/src/core/session/models/MemberType.d.ts +49 -0
  21. package/types/vtvsdk/src/core/session/models/VizbeeDevice.d.ts +26 -0
  22. package/types/vtvsdk/src/core/session/models/VizbeeDeviceType.d.ts +10 -0
  23. package/types/vtvsdk/src/core/session/models/presence/PresenceEventResult.d.ts +11 -0
  24. package/types/vtvsdk/src/core/sync/presence/Device.d.ts +34 -0
  25. package/types/vtvsdk/src/core/sync/presence/DeviceType.d.ts +6 -0
  26. package/types/vtvsdk/src/core/sync/presence/PresenceEvent.d.ts +4 -0
  27. package/types/vtvsdk/src/core/sync/presence/PresenceEventResult.d.ts +8 -0
  28. package/vizio/index.js +1 -1
  29. package/xbox/es5/index.js +1 -1
  30. package/xbox/es6/index.js +1 -1
package/README.md CHANGED
@@ -48,12 +48,6 @@ import vizbee from '@vizbeetv/sdk-qa/xbox';
48
48
  import vizbee from '@vizbeetv/sdk-qa/xbox/es6';
49
49
  ```
50
50
 
51
- ### Chromecast CAF (v3)
52
-
53
- ```js
54
- import vizbee from '@vizbeetv/sdk-qa/chromecast';
55
- ```
56
-
57
51
  ### Chromecast v2 (MediaManager)
58
52
 
59
53
  ```js
@@ -75,10 +69,40 @@ import vizbee from '@vizbeetv/sdk-qa/chromecast-v2/es6';
75
69
  | `/vizio` | Vizio SmartCast | ES5 |
76
70
  | `/xbox`, `/xbox/es5` | Xbox | ES5 |
77
71
  | `/xbox/es6` | Xbox | ES6 |
78
- | `/chromecast` | Chromecast CAF (v3) | ES5 |
79
72
  | `/chromecast-v2`, `/chromecast-v2/es5` | Chromecast v2 (MediaManager) | ES5 |
80
73
  | `/chromecast-v2/es6` | Chromecast v2 (MediaManager) | ES6 |
81
74
 
75
+ ## TypeScript
76
+
77
+ The package ships TypeScript declarations. The default export is the typed SDK
78
+ instance — its `continuity` API (context, adapters, messages) is fully typed —
79
+ and the SDK's public types are also importable as named exports for use in
80
+ annotations:
81
+
82
+ ```ts
83
+ import vizbee, {
84
+ VideoInfo,
85
+ PlayerAdapter,
86
+ SessionState,
87
+ VizbeeMessagingClient,
88
+ } from '@vizbeetv/sdk-qa/samsung';
89
+
90
+ // Default export: the SDK instance. Its continuity API is typed end-to-end.
91
+ const ctx = vizbee.continuity.ContinuityContext.getInstance();
92
+ ctx.start('vzb1234567');
93
+ ctx.getAppAdapter().setDeeplinkHandler((video: VideoInfo) => {
94
+ /* deeplink into video.guid / video.videoUrl … */
95
+ });
96
+
97
+ // Named exports: use the SDK's types in your own signatures.
98
+ function onSessionState(state: SessionState) { /* ... */ }
99
+ ```
100
+
101
+ The same type surface is exposed from every platform subpath.
102
+
103
+ > Requires `moduleResolution` set to `bundler`, `node16`, or `nodenext` in your
104
+ > `tsconfig.json` (the same requirement as resolving the platform subpaths).
105
+
82
106
  ## Window globals
83
107
 
84
108
  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.