From 8fd0b29916a2ba933885247cc1e185aca5749cf4 Mon Sep 17 00:00:00 2001
From: Kamil Stasiak <kamilstasiaknew@gmail.com>
Date: Tue, 12 Mar 2024 13:02:26 +0100
Subject: [PATCH] Add JS doc and bump version (#34)

---
 package-lock.json      | 44 ++++++++++++++++++++++++++++++++++++------
 package.json           |  4 ++--
 src/JellyfishClient.ts | 13 +++++++++++++
 yarn.lock              |  8 ++++----
 4 files changed, 57 insertions(+), 12 deletions(-)

diff --git a/package-lock.json b/package-lock.json
index b1e8abea..022c1176 100644
--- a/package-lock.json
+++ b/package-lock.json
@@ -1,15 +1,15 @@
 {
   "name": "@jellyfish-dev/ts-client-sdk",
-  "version": "0.3.0",
+  "version": "0.3.1",
   "lockfileVersion": 3,
   "requires": true,
   "packages": {
     "": {
       "name": "@jellyfish-dev/ts-client-sdk",
-      "version": "0.3.0",
+      "version": "0.3.1",
       "license": "Apache-2.0",
       "dependencies": {
-        "@jellyfish-dev/membrane-webrtc-js": "^0.7.0",
+        "@jellyfish-dev/membrane-webrtc-js": "^0.7.1",
         "events": "^3.3.0",
         "ts-proto": "^1.165.0",
         "typed-emitter": "^2.1.0"
@@ -33,6 +33,38 @@
         "typescript": "^4.9.5"
       }
     },
+    "../membrane-webrtc-js": {
+      "name": "@jellyfish-dev/membrane-webrtc-js",
+      "version": "0.7.0",
+      "extraneous": true,
+      "license": "Apache-2.0",
+      "dependencies": {
+        "events": "^3.3.0",
+        "typed-emitter": "^2.1.0",
+        "uuid": "^9.0.1"
+      },
+      "devDependencies": {
+        "@playwright/test": "^1.41.2",
+        "@types/events": "^3.0.3",
+        "@types/uuid": "^9.0.8",
+        "@typescript-eslint/eslint-plugin": "^7.0.1",
+        "@typescript-eslint/parser": "^7.0.1",
+        "@vitest/coverage-v8": "^1.2.2",
+        "eslint": "^8.56.0",
+        "eslint-config-prettier": "^9.1.0",
+        "eslint-plugin-react-hooks": "^4.6.0",
+        "eslint-plugin-react-refresh": "^0.4.5",
+        "fake-mediastreamtrack": "^1.2.0",
+        "prettier": "3.2.5",
+        "testcontainers": "^10.7.1",
+        "typedoc": "^0.25.8",
+        "typescript": "^5.3.3",
+        "vite": "^5.1.2",
+        "vite-plugin-dts": "^3.7.2",
+        "vitest": "^1.2.2",
+        "zod": "^3.22.4"
+      }
+    },
     "node_modules/@aashutoshrathi/word-wrap": {
       "version": "1.2.6",
       "resolved": "https://registry.npmjs.org/@aashutoshrathi/word-wrap/-/word-wrap-1.2.6.tgz",
@@ -138,9 +170,9 @@
       "dev": true
     },
     "node_modules/@jellyfish-dev/membrane-webrtc-js": {
-      "version": "0.7.0",
-      "resolved": "https://registry.npmjs.org/@jellyfish-dev/membrane-webrtc-js/-/membrane-webrtc-js-0.7.0.tgz",
-      "integrity": "sha512-FEYpL52W1QekhPiv88hJY/0mlZwGu6cWWH/xvjgf1pehCXiyqYv6icIBRsYqRLdgmivVFTaUbQTLIv4Yn7RKYw==",
+      "version": "0.7.1",
+      "resolved": "https://registry.npmjs.org/@jellyfish-dev/membrane-webrtc-js/-/membrane-webrtc-js-0.7.1.tgz",
+      "integrity": "sha512-hcxXJoDt4B+/qRL2Y6dEySAa+hXIwboJTJfrUU2iMulL0HyXkRnSNyy2Fwi+evweDfyKecAM4T1HsX2tgG15Tw==",
       "dependencies": {
         "events": "^3.3.0",
         "typed-emitter": "^2.1.0",
diff --git a/package.json b/package.json
index 950283f7..a8c69ebf 100644
--- a/package.json
+++ b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@jellyfish-dev/ts-client-sdk",
-  "version": "0.3.0",
+  "version": "0.3.1",
   "description": "Typescript client library for Jellyfish.",
   "license": "Apache-2.0",
   "author": "Membrane Team",
@@ -62,7 +62,7 @@
     "typescript": "^4.9.5"
   },
   "dependencies": {
-    "@jellyfish-dev/membrane-webrtc-js": "^0.7.0",
+    "@jellyfish-dev/membrane-webrtc-js": "^0.7.1",
     "events": "^3.3.0",
     "ts-proto": "^1.165.0",
     "typed-emitter": "^2.1.0"
diff --git a/src/JellyfishClient.ts b/src/JellyfishClient.ts
index 8e6cf693..3e66b11c 100644
--- a/src/JellyfishClient.ts
+++ b/src/JellyfishClient.ts
@@ -303,6 +303,19 @@ export class JellyfishClient<PeerMetadata, TrackMetadata> extends (EventEmitter
     this.status = "initialized";
   }
 
+  /**
+   * Retrieves statistics related to the RTCPeerConnection.
+   * These statistics provide insights into the performance and status of the connection.
+   *
+   * @return {Promise<RTCStatsReport>}
+   *
+   * @external RTCPeerConnection#getStats()
+   * @see {@link https://developer.mozilla.org/en-US/docs/Web/API/RTCPeerConnection/getStats | MDN Web Docs: RTCPeerConnection.getStats()}
+   */
+  public async getStatistics(selector?: MediaStreamTrack | null): Promise<RTCStatsReport> {
+    return (await this.webrtc?.getStatistics(selector)) ?? new Map();
+  }
+
   /**
    * Returns a snapshot of currently received remote tracks.
    *
diff --git a/yarn.lock b/yarn.lock
index 3dd27dde..35e994ee 100644
--- a/yarn.lock
+++ b/yarn.lock
@@ -63,10 +63,10 @@
   resolved "https://registry.npmjs.org/@humanwhocodes/object-schema/-/object-schema-2.0.1.tgz"
   integrity sha512-dvuCeX5fC9dXgJn9t+X5atfmgQAzUOWqS1254Gh0m6i8wKd10ebXkfNKiRK+1GWi/yTvvLDHpoxLr0xxxeslWw==
 
-"@jellyfish-dev/membrane-webrtc-js@^0.7.0":
-  version "0.7.0"
-  resolved "https://registry.npmjs.org/@jellyfish-dev/membrane-webrtc-js/-/membrane-webrtc-js-0.7.0.tgz"
-  integrity sha512-FEYpL52W1QekhPiv88hJY/0mlZwGu6cWWH/xvjgf1pehCXiyqYv6icIBRsYqRLdgmivVFTaUbQTLIv4Yn7RKYw==
+"@jellyfish-dev/membrane-webrtc-js@^0.7.1":
+  version "0.7.1"
+  resolved "https://registry.npmjs.org/@jellyfish-dev/membrane-webrtc-js/-/membrane-webrtc-js-0.7.1.tgz"
+  integrity sha512-hcxXJoDt4B+/qRL2Y6dEySAa+hXIwboJTJfrUU2iMulL0HyXkRnSNyy2Fwi+evweDfyKecAM4T1HsX2tgG15Tw==
   dependencies:
     events "^3.3.0"
     typed-emitter "^2.1.0"