revert(releases) change back to prefixed expected value (#25)

jitsi · Oct 18, 2022 · fc88a22 · fc88a22
1 parent 29a10b8
commit fc88a22
Show file tree

Hide file tree

Showing 9 changed files with 13 additions and 11 deletions.
diff --git a/README.md b/README.md
@@ -94,7 +94,7 @@ Optional. Information regarding the devices used during the call.
 Optional. Details about the participant that started the meeting.
 
 ###### `release`
-Optional. Information regarding the `stage.8x8.vc` or `8x8.vc` release version.
+Optional. Information regarding the `stage.8x8.vc` or `8x8.vc` release version. Expects the following format: `release-1234`.
 
 ###### `spinner`
 Optional. Custom loading view while the IFrame is loading.

diff --git a/example/package-lock.json b/example/package-lock.json
diff --git a/example/src/App.jsx b/example/src/App.jsx
@@ -205,11 +205,12 @@ const App = () => {
             <JaaSMeeting
                 roomName = { generateRoomName() }
 
-                // Update this with the version of interest
+                // Update this with the `8x8.vc` or `stage.8x8.vc` version of interest
                 // and avoid mixing up different domains and release versions
                 // on the same page at the same time, as only the first
                 // external api script will be loaded.
-                // release = '3446'
+                // release = 'release-1234'
+
                 useStaging = { true }
                 getIFrameRef = { handleJaaSIFrameRef } />
             {renderButtons()}

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
     "name": "@jitsi/react-sdk",
-    "version": "1.1.0",
+    "version": "1.2.0",
     "description": "React SDK for the Jitsi Meet IFrame",
     "main": "lib/index.js",
     "types": "lib/index.d.ts",

diff --git a/src/components/JitsiMeeting.tsx b/src/components/JitsiMeeting.tsx
@@ -70,7 +70,7 @@ const JitsiMeeting = ({
             invitees,
             devices,
             userInfo,
-            ...release ? { release: `release-${release}` } : {},
+            release,
             parentNode: meetingRef.current
         });
         setLoading(false);

diff --git a/src/init.ts b/src/init.ts
@@ -10,7 +10,7 @@ const loadExternalApi = async (
     }
 
     const script: HTMLScriptElement = document.createElement('script');
-    const releaseParam: string = release ? `?release=release-${release}` : '';
+    const releaseParam: string = release ? `?release=${release}` : '';
 
     script.async = true;
     script.src = `https://${domain}/external_api.js${releaseParam}`;
@@ -30,7 +30,7 @@ let scriptPromise: Promise<JitsiMeetExternalApi>;
  * with mixed domains and release version at the same time.
  *
  * @param {string} domain - The domain of the external API
- * @param {string} release - The Jitsi Meet release
+ * @param {string} release - The Jitsi Meet release. Expected format: 'release-1234'
  * @returns {Promise<JitsiMeetExternalApi>} - The JitsiMeetExternalAPI or an error
  */
 export const fetchExternalApi = (

diff --git a/src/types/IMeetingProps.ts b/src/types/IMeetingProps.ts
@@ -73,6 +73,7 @@ export default interface IMeetingProps {
 
     /**
      * The `stage.8x8.vc` or `8x8.vc` release version to test.
+     * Expects the following format: `release-1234`.
      */
     release?: string;
 

diff --git a/src/types/JitsiMeetExternalApi.ts b/src/types/JitsiMeetExternalApi.ts
@@ -94,7 +94,7 @@ export type JitsiMeetExternalApi = {
 
             /**
              * The `stage.8x8.vc` or `8x8.vc` release version to test.
-             * Expects the following format: `release-${string}`.
+             * Expects the following format: `release-1234`.
              */
             release?: string,
-Original file line number
+Diff line change
@@ Expand Up / @@ -73,6 +73,7 @@ export default interface IMeetingProps { @@
         /**
          * The `stage.8x8.vc` or `8x8.vc` release version to test.
+         * Expects the following format: `release-1234`.
          */
         release?: string;
@@ Expand Down @@