@testrtc/watchrtc-sdk - npm Package Compare versions

Comparing version 1.39.1-beta.2 to 1.39.1-beta.3

lib/interfaces.d.ts

@@ -50,2 +50,3 @@ export interface RTCPeerConnectionInformation {
 export type EventType = "global" | "local" | "log";
+export type Reason = "serverRejectedRetrying" | "serverRejectedNoRetry" | "cantConnectToServer" | "connectedNotResponding" | "disconnectedPrematurely" | "applicationDisconnected" | "clientRejectedNoRetry" | "";
 export interface IEvent {
@@ -107,2 +108,3 @@ name: string;
     connectionStatus: "connected" | "disconnected";
+    reason?: Reason;
 }
@@ -109,0 +111,0 @@ export type StateListener = (event: IStateEvent) => any;

lib/version.d.ts

@@ -1,2 +0,2 @@
-declare const _default: "1.39.1-beta.2";
+declare const _default: "1.39.1-beta.3";
 export default _default;

package.json

 {
   "name": "@testrtc/watchrtc-sdk",
-  "version": "1.39.1-beta.2",
+  "version": "1.39.1-beta.3",
   "description": "Monitor your WebRTC application by collecting WebRTC statistics from end users",
@@ -19,3 +19,5 @@ "main": "lib/index.js",
     "publish-npm": "npm publish",
-    "publish-beta": "npm publish --tag beta"
+    "publish-all-npm": "npm publish && yarn publish-qrtc",
+    "publish-beta": "npm publish --tag beta",
+    "publish-all-beta": "npm publish --tag beta && yarn publish-qrtc"
   },
@@ -22,0 +24,0 @@ "devDependencies": {

README.md

@@ -289,3 +289,12 @@ # watchRTC JS SDK
 - **connectionStatus**: String value. Can be one of `connected` or `disconnected`,
+- **reason**: String value (Optional, only when **connectionStatus** is `disconnected`). The reason of the state change. Can be one of `clientRejectedNoRetry`, `disconnectedPrematurely`, `cantConnectToServer`, `serverRejectedNoRetry` or `applicationDisconnected`.
 
+Here is some additional information about the reasons:
+
+- `clientRejectedNoRetry`: The SDK has been disconnected because the configuration was incorrect. This can happen when the fields `rtcApiKey`, `rtcRoomId` or `rtcPeerId` are missing. The SDK will not try to reconnect automatically.
+- `disconnectedPrematurely`: The SDK has been disconnected because the connection was lost. It will automatically try to reconnect using an exponential backoff mechanism.
+- `cantConnectToServer`: The SDK is disconnected and has failed to connect. It will try to reconnect automatically using an exponential backoff mechanism.
+- `serverRejectedNoRetry`: The SDK has been disconnected because the server has rejected the connection. This can happen when the authentication using the `rtcApiKey` fails. The SDK will not try to reconnect.
+- `applicationDisconnected`: The SDK has been disconnected because the application has called the `disconnect` method or because the SDK automatically disconnects when all peer-connections have been closed. The SDK will not try to reconnect automatically.
+
 _Note_: To stop listening, pass `null` to the `addStateListener()` function. The existing listener will be unsubscribed and removed.
@@ -300,2 +309,10 @@
 
+### 1.39.1.beta-3 (Feb 20, 2024)
+
+- add a reason field to the state listener when the connection status is `disconnected`
+
+### 1.38.3 (Feb 14, 2024)
+
+- official release
+
 ### 1.39.1.beta-2 (Jan 26, 2024)
@@ -302,0 +319,0 @@

No alert changes

Improved metrics

Total package byte prevSize

597911

increased by0.81%

Lines of code

1470

increased by0.27%

Number of lines in readme file

562

increased by3.12%

No dependency changes