Merge pull request #691 from MartinHarkins/issue-690-fix-2.25.3-typings

fix typings for issue 690
opentok · Oct 3, 2023 · 1d4af9c · 1d4af9c
2 parents bf5af09 + 693f1e3
commit 1d4af9c
Show file tree

Hide file tree

Showing 4 changed files with 66 additions and 62 deletions.
diff --git a/@types/index.d.ts b/@types/index.d.ts
@@ -71,7 +71,7 @@ declare module "opentok-react-native" {
     code: string;
     message: string;
   }
-  
+
   interface SubscriberAudioStatsEvent {
     audioBytesReceived: number,
     audioPacketsLost: number,
@@ -129,35 +129,6 @@ declare module "opentok-react-native" {
      */
     getSessionInfo?: any
 
-    /**
-     * Used to get capabilities of the client
-     */
-    getCapabilities(): Promise<{
-      canForceMute: boolean;
-      canPublish: boolean;
-      canSubscribe: boolean;
-    }>
-
-    /**
-     * Mutes all streams in the session.
-     */
-    forceMuteAll(excludedStreamIds: string[]): Promise<>
-
-    /**
-     * Mutes a stream in the session.
-     */
-    forceMuteStream(streamId: string): Promise<>
-
-    /**
-     * Disables the force mute state for the session.
-     */
-    disableForceMute(): Promise<>
-
-    /**
-     * Used to report an issue
-     */
-    reportIssue(): Promise<string>
-
     /**
      * Event handlers passed into the native session instance.
      */
@@ -173,9 +144,9 @@ declare module "opentok-react-native" {
     /**
      * EU proxy server URL provided by vonage. Please check https://tokbox.com/developer/guides/eu-proxy/
      */
-     proxyUrl?: string;
+    proxyUrl?: string;
 
-     /**
+    /**
      * Android only - valid options are 'mediaOverlay' or 'onTop'
      */
     androidZOrder?: "mediaOverlay" | "onTop";
@@ -193,15 +164,15 @@ declare module "opentok-react-native" {
     /**
      * Android only - default is false.
      * Deprecated and ignored.
-     
+
      */
     isCamera2Capable?: boolean;
 
     /**
      * Whether to use the allowed IP list feature - default is false
      */
     ipWhitelist?: boolean;
-    
+
     /**
      * Enable Stereo output
      */
@@ -213,9 +184,9 @@ declare module "opentok-react-native" {
       includeServers: 'all' | 'custom';
       transportPolicy: 'all' | 'relay';
       customServers: {
-      urls: string[];
-      username?: string;
-      credential?: string;
+        urls: string[];
+        username?: string;
+        credential?: string;
       }[];
     };
   }
@@ -295,7 +266,36 @@ declare module "opentok-react-native" {
   /**
    * https://github.com/opentok/opentok-react-native/blob/master/docs/OTSession.md
    */
-  export class OTSession extends React.Component<OTSessionProps> {}
+  export class OTSession extends React.Component<OTSessionProps, unknown> {
+    /**
+     * Used to get capabilities of the client
+     */
+    getCapabilities: () => Promise<{
+      canForceMute: boolean;
+      canPublish: boolean;
+      canSubscribe: boolean;
+    }>
+
+    /**
+     * Mutes all streams in the session.
+     */
+    forceMuteAll: (excludedStreamIds: string[]) => Promise<void>
+
+    /**
+     * Mutes a stream in the session.
+     */
+    forceMuteStream: (streamId: string) => Promise<void>
+
+    /**
+     * Disables the force mute state for the session.
+     */
+    disableForceMute: () => Promise<void>
+
+    /**
+     * Used to report an issue
+     */
+    reportIssue: () => Promise<string>
+  }
 
   interface OTPublisherProps extends ViewProps {
     /**
@@ -307,13 +307,6 @@ declare module "opentok-react-native" {
      * Event handlers passed into native publsiher instance
      */
     eventHandlers?: OTPublisherEventHandlers;
-
-    /**
-     * Gets the RTC stats report for the publisher. This is an asynchronous operation.
-     * The OTPublisher object dispatches an rtcStatsReport event when RTC statistics for
-     * the publisher are available.
-     */
-    getRtcStatsReport(): void;
   }
 
   interface OTPublisherProperties {
@@ -401,10 +394,10 @@ declare module "opentok-react-native" {
     otrnError?: CallbackWithParam<any, any>;
 
     /**
-     * Sent when RTC stats reports are available for the publisher, 
+     * Sent when RTC stats reports are available for the publisher,
      * in response to calling the OTPublisher.getRtcStatsReport() method.
      */
-    rtcStatsReport?: CallbackWithParam<PublisherRtcStatsReport[]>, any>;
+    rtcStatsReport?: CallbackWithParam<PublisherRtcStatsReport[], any>;
 
     /**
      * Sent when the publisher starts streaming.
@@ -420,7 +413,14 @@ declare module "opentok-react-native" {
   /**
    * https://github.com/opentok/opentok-react-native/blob/master/docs/OTPublisher.md
    */
-  export class OTPublisher extends React.Component<OTPublisherProps> {}
+  export class OTPublisher extends React.Component<OTPublisherProps, unknown> {
+    /**
+     * Gets the RTC stats report for the publisher. This is an asynchronous operation.
+     * The OTPublisher object dispatches an rtcStatsReport event when RTC statistics for
+     * the publisher are available.
+     */
+    getRtcStatsReport?: () => void;
+  }
 
   interface OTSubscriberProps extends ViewProps {
     /**
@@ -452,13 +452,6 @@ declare module "opentok-react-native" {
      * If set to true, the subscriber can subscribe to it's own publisher stream (default: false)
      */
     subscribeToSelf?: boolean;
-
-    /**
-     * Gets the RTC stats report for the subscriber. This is an asynchronous operation.
-     * The OTSubscriber object dispatches an rtcStatsReport event when RTC statistics for
-     * the publisher are available.
-     */
-    getRtcStatsReport(): void;
   }
 
   interface OTSubscriberProperties {
@@ -505,10 +498,10 @@ declare module "opentok-react-native" {
     otrnError?: CallbackWithParam<any, any>;
 
     /**
-     * Sent when an RTC stats report is available for the subscriber, 
+     * Sent when an RTC stats report is available for the subscriber,
      * in response to calling the OTSubscriber.getRtcStatsReport() method.
      */
-    rtcStatsReport?: CallbackWithParam<RtcStatsReport>, any>;
+    rtcStatsReport?: CallbackWithParam<RtcStatsReport, any>;
 
     /**
      * Sent when a frame of video has been decoded. Although the subscriber will connect in a relatively short time, video can take more time to synchronize. This message is sent after the connected message is sent.
@@ -551,9 +544,16 @@ declare module "opentok-react-native" {
   /**
    * https://github.com/opentok/opentok-react-native/blob/main/docs/OTSubscriber.md#custom-rendering-of-streams
    */
-  export class OTSubscriberView extends React.Component<OTSubscriberViewProps> {}
+  export class OTSubscriberView extends React.Component<OTSubscriberViewProps, unknown> {}
   /**
    * https://github.com/opentok/opentok-react-native/blob/master/docs/OTSubscriber.md
    */
-  export class OTSubscriber extends React.Component<OTSubscriberProps> {}
+  export class OTSubscriber extends React.Component<OTSubscriberProps, unknown> {
+    /**
+     * Gets the RTC stats report for the subscriber. This is an asynchronous operation.
+     * The OTSubscriber object dispatches an rtcStatsReport event when RTC statistics for
+     * the publisher are available.
+     */
+    getRtcStatsReport: () => void;
+  }
 }
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,7 @@
+# 2.25.4 (October 2023)
+
+- [Fix]: Fixes TypeScript definitions  - issue #690.
+
 # 2.25.3 (September 2023)
 
 - [Update]: Add API to implement functionality missing from the OpenTok Android and iOS SDKs:

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "opentok-react-native",
-  "version": "2.25.3",
+  "version": "2.25.4",
   "description": "React Native components for OpenTok iOS and Android SDKs",
   "main": "src/index.js",
   "homepage": "https://www.tokbox.com",