@vonage/client-sdk-video 2.28.3 → 2.28.4

package/README.md

@@ -1,19 +1,19 @@
-# OpenTok.js
+# Vonage Video API
 
-[![npm version](https://badge.fury.io/js/%40opentok%2Fclient.svg)](https://badge.fury.io/js/%40opentok%2Fclient)
+[![npm version](https://badge.fury.io/js/%40vonage%2Fclient-sdk-video.svg)](https://badge.fury.io/js/%40vonage%2Fclient-sdk-video)
 
-The OpenTok.js library lets you use OpenTok-powered video sessions on the web.
+The Vonage Video API library lets you use Vonage-powered video sessions on the web.
 
 ## Installation
 
 ```sh
-yarn add @opentok/client
+yarn add @vonage/client-sdk-video
 ```
 
 or
 
 ```sh
-npm install --save @opentok/client
+npm install --save @vonage/client-sdk-video
 ```
 
 ## Usage
@@ -25,11 +25,11 @@ The library is bundled as a standalone UMD module so it is CommonJS compatible.
 Create your application file `app.js`:
 
 ```js
-const OT = require('@opentok/client');
+const OT = require('@vonage/client-sdk-video');
 const publisher = OT.initPublisher();
 ```
 
-Bundle the application with your favourite bundler. For browserify just run:
+Bundle the application with your favorite bundler. For browserify just run:
 
 ```sh
 browserify app.js > bundle.js
@@ -50,14 +50,14 @@ Include the `dist/js/opentok.min.js` script in your webpage.
 Then use the `OT` object exposed in the global scope.
 
 ```html
-<script src="node_modules/@opentok/client/dist/js/opentok.min.js"></script>
+<script src="node_modules/@vonage/client-sdk-video/dist/js/opentok.min.js"></script>
 <script>
 const publisher = OT.initPublisher();
 </script>
 ```
 
-*Note:* OpenTok.js automatically loads CSS and image files from the TokBox CDN when included in a webpage.
+*Note:* Vonage Video API automatically loads CSS and image files from the TokBox CDN when included in a webpage.
 
 ## Documentation
 
-The API reference and tutorials can be found at https://tokbox.com/developer/sdks/js/
+The API reference and tutorials can be found at https://developer.vonage.com/en/video/client-sdks/web/overview

package/dist/js/opentok.d.ts

@@ -268,6 +268,85 @@ declare namespace OT {
       context?: object
     ): void;
   }
+  
+  // This class is a modified copy of OTEventEmitter that was needed in order to support the template string used for the signal:type event
+  class SessionOTEventEmitter<EventMap> {
+    on<EventName extends keyof EventMap>(
+      eventName: EventName,
+      callback: (event: EventMap[EventName]) => void,
+      context?: object
+    ): void;
+
+    on(
+      eventName: `signal:${string}`,
+      callback: (event: Event<`signal:${string}`, Session> & {
+        type?: string;
+        data?: string;
+        from: Connection | null;
+      }) => void,
+      context?: object
+    ): void;
+
+    on(
+      eventName: string,
+      callback: (event: Event<string, any>) => void,
+      context?: object
+    ): void;
+
+    on(
+      eventMap: object,
+      context?: object
+    ): void;
+
+    once<EventName extends keyof EventMap>(
+      eventName: EventName,
+      callback: (event: EventMap[EventName]) => void,
+      context?: object
+    ): void;
+
+    once(
+      eventName: `signal:${string}`,
+      callback: (event: Event<`signal:${string}`, Session> & {
+        type?: string;
+        data?: string;
+        from: Connection | null;
+      }) => void,
+      context?: object
+    ): void;
+
+    once(
+      eventName: string,
+      callback: (event: Event<string, any>) => void,
+      context?: object
+    ): void;
+
+    once(
+      eventMap: object,
+      context?: object
+    ): void;
+
+    off<EventName extends keyof EventMap>(
+      eventName?: EventName,
+      callback?: (event: EventMap[EventName]) => void,
+      context?: object
+    ): void;
+
+    off(
+      eventName: `signal:${string}`,
+      context?: object
+    ): void;
+
+    off(
+      eventName?: string,
+      callback?: (event: Event<string, any>) => void,
+      context?: object
+    ): void;
+
+    off(
+      eventMap: object,
+      context?: object
+    ): void;
+  }
 
   export class Publisher extends OTEventEmitter<{
     accessAllowed: Event<'accessAllowed', Publisher>;
@@ -384,7 +463,7 @@ declare namespace OT {
     context?: object
   ): void;
 
-  export class Session extends OTEventEmitter<{
+  export class Session extends SessionOTEventEmitter<{
     archiveStarted: Event<'archiveStarted', Session> & {
       id: string;
       name: string;
@@ -597,7 +676,7 @@ declare namespace OT {
     getAudioVolume(): number;
     getImgData(): string | null;
     getStats(callback: (error?: OTError, stats?: SubscriberStats) => void): void;
-    getRtcStatsReport(): Promise<RTCStatsReport>;
+    getRtcStatsReport(): Promise<Map<string, any>>;
     subscribeToCaptions(value: boolean): Promise<void>;
     isSubscribedToCaptions(): boolean;
     isAudioBlocked(): boolean;