@webex/media-helpers 3.0.1-next.4 → 3.0.1-next.5

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-export { getDevices, LocalStream, LocalDisplayStream, LocalSystemAudioStream, LocalStreamEventNames, StreamEventNames, RemoteStream, type ServerMuteReason, LocalMicrophoneStreamEventNames, LocalCameraStreamEventNames, LocalMicrophoneStream, LocalCameraStream, createMicrophoneStream, createCameraStream, createDisplayStream, createDisplayStreamWithAudio, type VideoContentHint, } from './webrtc-core';
+export { getDevices, LocalStream, LocalDisplayStream, LocalSystemAudioStream, LocalStreamEventNames, StreamEventNames, RemoteStream, RemoteStreamEventNames, type ServerMuteReason, LocalMicrophoneStreamEventNames, LocalCameraStreamEventNames, LocalMicrophoneStream, LocalCameraStream, createMicrophoneStream, createCameraStream, createDisplayStream, createDisplayStreamWithAudio, type VideoContentHint, } from './webrtc-core';
 export { NoiseReductionEffect, VirtualBackgroundEffect } from '@webex/web-media-effects';
 export type { NoiseReductionEffectOptions, VirtualBackgroundEffectOptions, } from '@webex/web-media-effects';
 export { FacingMode, DisplaySurface, PresetCameraConstraints } from './constants';

package/dist/index.js

@@ -81,6 +81,12 @@ Object.defineProperty(exports, "RemoteStream", {
     return _webrtcCore.RemoteStream;
   }
 });
+Object.defineProperty(exports, "RemoteStreamEventNames", {
+  enumerable: true,
+  get: function () {
+    return _webrtcCore.RemoteStreamEventNames;
+  }
+});
 Object.defineProperty(exports, "StreamEventNames", {
   enumerable: true,
   get: function () {

package/dist/webrtc-core.d.ts

@@ -1,6 +1,6 @@
 import { AudioDeviceConstraints, LocalDisplayStream, LocalSystemAudioStream, LocalMicrophoneStream as WcmeLocalMicrophoneStream, LocalCameraStream as WcmeLocalCameraStream, VideoDeviceConstraints } from '@webex/internal-media-core';
 import { TypedEvent, WithEventsDummyType } from '@webex/ts-events';
-export { getDevices, LocalStream, LocalDisplayStream, LocalSystemAudioStream, LocalStreamEventNames, StreamEventNames, RemoteStream, type VideoContentHint, } from '@webex/internal-media-core';
+export { getDevices, LocalStream, LocalDisplayStream, LocalSystemAudioStream, LocalStreamEventNames, StreamEventNames, RemoteStream, RemoteStreamEventNames, type VideoContentHint, } from '@webex/internal-media-core';
 export type ServerMuteReason = 'remotelyMuted' | 'clientRequestFailed' | 'localUnmuteRequired';
 export declare enum LocalMicrophoneStreamEventNames {
     ServerMuted = "muted:byServer"
@@ -21,7 +21,7 @@ declare class _LocalMicrophoneStream extends WcmeLocalMicrophoneStream {
      * @returns true if user is allowed to unmute the track, false otherwise
      */
     isUnmuteAllowed(): boolean;
-    setMuted(muted: boolean): void;
+    setUserMuted(muted: boolean): void;
 }
 declare class _LocalCameraStream extends WcmeLocalCameraStream {
     private unmuteAllowed;
@@ -30,7 +30,7 @@ declare class _LocalCameraStream extends WcmeLocalCameraStream {
      * @returns true if user is allowed to unmute the track, false otherwise
      */
     isUnmuteAllowed(): boolean;
-    setMuted(muted: boolean): void;
+    setUserMuted(muted: boolean): void;
 }
 export declare const createMicrophoneStream: (constraints?: AudioDeviceConstraints) => Promise<{
     on<K extends LocalMicrophoneStreamEventNames.ServerMuted, E extends LocalMicrophoneStreamEvents[K] extends infer T ? T extends LocalMicrophoneStreamEvents[K] ? T extends TypedEvent<infer X extends (...args: any[]) => void> ? X : never : never : never>(eventName: K, handler: E): void;

package/dist/webrtc-core.js

@@ -35,6 +35,12 @@ Object.defineProperty(exports, "RemoteStream", {
     return _internalMediaCore.RemoteStream;
   }
 });
+Object.defineProperty(exports, "RemoteStreamEventNames", {
+  enumerable: true,
+  get: function () {
+    return _internalMediaCore.RemoteStreamEventNames;
+  }
+});
 Object.defineProperty(exports, "StreamEventNames", {
   enumerable: true,
   get: function () {
@@ -80,21 +86,21 @@ class _LocalMicrophoneStream extends _internalMediaCore.LocalMicrophoneStream {
   isUnmuteAllowed() {
     return this.unmuteAllowed;
   }
-  setMuted(muted) {
+  setUserMuted(muted) {
     if (!muted) {
       if (!this.isUnmuteAllowed()) {
         throw new Error('Unmute is not allowed');
       }
     }
-    return super.setMuted(muted);
+    return super.setUserMuted(muted);
   }
 
   /**
    * @internal
    */
   setServerMuted(muted, reason) {
-    if (muted !== this.muted) {
-      this.setMuted(muted);
+    if (muted !== this.userMuted) {
+      this.setUserMuted(muted);
       this[LocalMicrophoneStreamEventNames.ServerMuted].emit(muted, reason);
     }
   }
@@ -116,21 +122,21 @@ class _LocalCameraStream extends _internalMediaCore.LocalCameraStream {
   isUnmuteAllowed() {
     return this.unmuteAllowed;
   }
-  setMuted(muted) {
+  setUserMuted(muted) {
     if (!muted) {
       if (!this.isUnmuteAllowed()) {
         throw new Error('Unmute is not allowed');
       }
     }
-    return super.setMuted(muted);
+    return super.setUserMuted(muted);
   }
 
   /**
    * @internal
    */
   setServerMuted(muted, reason) {
-    if (muted !== this.muted) {
-      this.setMuted(muted);
+    if (muted !== this.userMuted) {
+      this.setUserMuted(muted);
       this[LocalCameraStreamEventNames.ServerMuted].emit(muted, reason);
     }
   }

package/jest.config.js

@@ -1,6 +1,3 @@
 const config = require('@webex/jest-config-legacy');
 
-module.exports = {
-  ...config,
-  testEnvironment: 'jsdom',
-};
+module.exports = config;

package/package.json

@@ -22,7 +22,7 @@
     "deploy:npm": "yarn npm publish"
   },
   "dependencies": {
-    "@webex/internal-media-core": "2.2.9",
+    "@webex/internal-media-core": "2.3.0",
     "@webex/ts-events": "^1.1.0",
     "@webex/web-media-effects": "^2.15.6"
   },
@@ -38,10 +38,11 @@
     "@webex/eslint-config-legacy": "0.0.0",
     "@webex/jest-config-legacy": "0.0.0",
     "@webex/legacy-tools": "0.0.0",
-    "@webex/test-helper-chai": "3.0.0-next.4",
-    "@webex/test-helper-mock-webex": "3.0.0-next.4",
+    "@webex/test-helper-chai": "3.0.0-next.5",
+    "@webex/test-helper-mock-webex": "3.0.0-next.5",
     "eslint": "^8.24.0",
+    "jsdom-global": "3.0.2",
     "sinon": "^9.2.4"
   },
-  "version": "3.0.1-next.4"
+  "version": "3.0.1-next.5"
 }

package/src/index.ts

@@ -6,6 +6,7 @@ export {
   LocalStreamEventNames,
   StreamEventNames,
   RemoteStream,
+  RemoteStreamEventNames,
   type ServerMuteReason,
   LocalMicrophoneStreamEventNames,
   LocalCameraStreamEventNames,

package/src/webrtc-core.ts

@@ -23,12 +23,13 @@ export {
   LocalStreamEventNames,
   StreamEventNames,
   RemoteStream,
+  RemoteStreamEventNames,
   type VideoContentHint,
 } from '@webex/internal-media-core';
 
 export type ServerMuteReason =
   | 'remotelyMuted' // other user has remotely muted us
-  | 'clientRequestFailed' // client called setMuted() but server request failed
+  | 'clientRequestFailed' // client called setUserMuted() but server request failed
   | 'localUnmuteRequired'; // server forced the client to be unmuted
 
 // these events are in addition to WCME events. This will be properly typed once webrtc-core event types inheritance is fixed
@@ -74,22 +75,22 @@ class _LocalMicrophoneStream extends WcmeLocalMicrophoneStream {
     return this.unmuteAllowed;
   }
 
-  setMuted(muted: boolean): void {
+  setUserMuted(muted: boolean): void {
     if (!muted) {
       if (!this.isUnmuteAllowed()) {
         throw new Error('Unmute is not allowed');
       }
     }
 
-    return super.setMuted(muted);
+    return super.setUserMuted(muted);
   }
 
   /**
    * @internal
    */
   setServerMuted(muted: boolean, reason: ServerMuteReason) {
-    if (muted !== this.muted) {
-      this.setMuted(muted);
+    if (muted !== this.userMuted) {
+      this.setUserMuted(muted);
       this[LocalMicrophoneStreamEventNames.ServerMuted].emit(muted, reason);
     }
   }
@@ -116,22 +117,22 @@ class _LocalCameraStream extends WcmeLocalCameraStream {
     return this.unmuteAllowed;
   }
 
-  setMuted(muted: boolean): void {
+  setUserMuted(muted: boolean): void {
     if (!muted) {
       if (!this.isUnmuteAllowed()) {
         throw new Error('Unmute is not allowed');
       }
     }
 
-    return super.setMuted(muted);
+    return super.setUserMuted(muted);
   }
 
   /**
    * @internal
    */
   setServerMuted(muted: boolean, reason: ServerMuteReason) {
-    if (muted !== this.muted) {
-      this.setMuted(muted);
+    if (muted !== this.userMuted) {
+      this.setUserMuted(muted);
       this[LocalCameraStreamEventNames.ServerMuted].emit(muted, reason);
     }
   }

package/test/unit/spec/webrtc-core.js

@@ -1,3 +1,4 @@
+import 'jsdom-global/register';
 import {assert, expect} from '@webex/test-helper-chai';
 import sinon from 'sinon';
 import {
@@ -53,22 +54,22 @@ describe('media-helpers', () => {
 
         it('by default allows unmuting', async () => {
           assert.equal(stream.isUnmuteAllowed(), true);
-          await stream.setMuted(false);
+          await stream.setUserMuted(false);
         });
 
-        it('rejects setMute(false) if unmute is not allowed', async () => {
-          await stream.setUnmuteAllowed(false);
+        it('rejects setUserMuted(false) if unmute is not allowed', async () => {
+          stream.setUnmuteAllowed(false);
 
           assert.equal(stream.isUnmuteAllowed(), false);
-          const fn = () => stream.setMuted(false);
+          const fn = () => stream.setUserMuted(false);
           expect(fn).to.throw(/Unmute is not allowed/);
         });
 
-        it('resolves setMute(false) if unmute is allowed', async () => {
-          await stream.setUnmuteAllowed(true);
+        it('resolves setUserMuted(false) if unmute is allowed', async () => {
+          stream.setUnmuteAllowed(true);
 
           assert.equal(stream.isUnmuteAllowed(), true);
-          await stream.setMuted(false);
+          await stream.setUserMuted(false);
         });
 
         it('returns a reasonable length string from JSON.stringify()', () => {
@@ -81,16 +82,16 @@ describe('media-helpers', () => {
           });
 
           const checkSetServerMuted = async (startMute, setMute, expectedCalled) => {
-            await stream.setMuted(startMute);
+            await stream.setUserMuted(startMute);
 
-            assert.equal(stream.muted, startMute);
+            assert.equal(stream.userMuted, startMute);
 
             const handler = sinon.fake();
             stream.on(event.ServerMuted, handler);
 
             await stream.setServerMuted(setMute, 'remotelyMuted');
 
-            assert.equal(stream.muted, setMute);
+            assert.equal(stream.userMuted, setMute);
             if (expectedCalled) {
               assert.calledOnceWithExactly(handler, setMute, 'remotelyMuted');
             } else {