@signalwire/js 1.4.1 → 1.5.0-rc.1

package/dist/esm/common/src/BrowserSession.d.ts

@@ -1,7 +1,10 @@
 import BaseSession from './BaseSession';
-import { ICacheDevices, IAudioSettings, IVideoSettings, BroadcastParams, SubscribeParams, IBladeConnectResult } from './util/interfaces';
+import { ICacheDevices, IAudioSettings, IVideoSettings, BroadcastParams, SubscribeParams, IBladeConnectResult, ISignalWireBrowserOptions } from './util/interfaces';
 import { IWebRTCCall } from './webrtc/interfaces';
 export default abstract class BrowserSession extends BaseSession {
+    options: ISignalWireBrowserOptions;
+    constructor(options: ISignalWireBrowserOptions);
+    validateOptions(): boolean;
     calls: {
         [callId: string]: IWebRTCCall;
     };
@@ -60,7 +63,7 @@ export default abstract class BrowserSession extends BaseSession {
     get localElement(): HTMLMediaElement | string | Function;
     set remoteElement(tag: HTMLMediaElement | string | Function);
     get remoteElement(): HTMLMediaElement | string | Function;
-    vertoBroadcast({ nodeId, channel: eventChannel, data }: BroadcastParams): void;
-    vertoSubscribe({ nodeId, channels: eventChannel, handler }: SubscribeParams): Promise<any>;
-    vertoUnsubscribe({ nodeId, channels: eventChannel }: SubscribeParams): Promise<any>;
+    vertoBroadcast({ nodeId, channel: eventChannel, data, }: BroadcastParams): void;
+    vertoSubscribe({ nodeId, channels: eventChannel, handler, }: SubscribeParams): Promise<any>;
+    vertoUnsubscribe({ nodeId, channels: eventChannel, }: SubscribeParams): Promise<any>;
 }

package/dist/esm/common/src/BrowserSession.js

@@ -23,14 +23,16 @@ import BaseSession from './BaseSession';
 import { registerOnce, trigger } from './services/Handler';
 import { SwEvent, SESSION_ID } from './util/constants';
 import { State, DeviceType } from './webrtc/constants';
-import { getDevices, scanResolutions, removeUnsupportedConstraints, checkDeviceIdConstraints, destructSubscribeResponse, getUserMedia, assureDeviceId } from './webrtc/helpers';
+import { getDevices, scanResolutions, removeUnsupportedConstraints, checkDeviceIdConstraints, destructSubscribeResponse, getUserMedia, assureDeviceId, } from './webrtc/helpers';
 import { findElementByType } from './util/helpers';
 import { Unsubscribe, Subscribe, Broadcast } from './messages/Verto';
 import { localStorage } from './util/storage/';
 import { stopStream } from './util/webrtc';
+import { WebRTCOverridesManager } from './webrtc/WebRTC';
 export default class BrowserSession extends BaseSession {
-    constructor() {
-        super(...arguments);
+    constructor(options) {
+        super(options);
+        this.options = options;
         this.calls = {};
         this.autoRecoverCalls = true;
         this._iceServers = [];
@@ -41,6 +43,32 @@ export default class BrowserSession extends BaseSession {
         this._audioConstraints = true;
         this._videoConstraints = false;
         this._speaker = null;
+        WebRTCOverridesManager.getInstance().RTCPeerConnection =
+            options.RTCPeerConnection;
+        WebRTCOverridesManager.getInstance().enumerateDevices =
+            options.enumerateDevices;
+        WebRTCOverridesManager.getInstance().getUserMedia = options.getUserMedia;
+        WebRTCOverridesManager.getInstance().getDisplayMedia =
+            options.getDisplayMedia;
+        WebRTCOverridesManager.getInstance().getSupportedConstraints =
+            options.getSupportedConstraints;
+        WebRTCOverridesManager.getInstance().attachMediaStream =
+            options.attachMediaStream;
+        WebRTCOverridesManager.getInstance().streamIsValid = options.streamIsValid;
+    }
+    validateOptions() {
+        const { RTCPeerConnection, getDisplayMedia, getUserMedia, attachMediaStream, streamIsValid, } = this.options;
+        return (((!RTCPeerConnection &&
+            !getDisplayMedia &&
+            !getUserMedia &&
+            !attachMediaStream &&
+            !streamIsValid) ||
+            (!!RTCPeerConnection &&
+                !!getDisplayMedia &&
+                !!getUserMedia &&
+                !!attachMediaStream &&
+                !!streamIsValid)) &&
+            super.validateOptions());
     }
     get reconnectDelay() {
         return 1000;
@@ -78,18 +106,23 @@ export default class BrowserSession extends BaseSession {
             disconnect: { get: () => super.disconnect }
         });
         return __awaiter(this, void 0, void 0, function* () {
-            Object.keys(this.calls).forEach(k => this.calls[k].setState(State.Purge));
+            Object.keys(this.calls).forEach((k) => this.calls[k].setState(State.Purge));
             this.calls = {};
             yield _super.disconnect.call(this);
         });
     }
     speedTest(bytes) {
         return new Promise((resolve, reject) => {
-            registerOnce(SwEvent.SpeedTest, speedTestResult => {
+            registerOnce(SwEvent.SpeedTest, (speedTestResult) => {
                 const { upDur, downDur } = speedTestResult;
-                const upKps = upDur ? (((bytes * 8) / (upDur / 1000)) / 1024) : 0;
-                const downKps = downDur ? (((bytes * 8) / (downDur / 1000)) / 1024) : 0;
-                resolve({ upDur, downDur, upKps: upKps.toFixed(0), downKps: downKps.toFixed(0) });
+                const upKps = upDur ? (bytes * 8) / (upDur / 1000) / 1024 : 0;
+                const downKps = downDur ? (bytes * 8) / (downDur / 1000) / 1024 : 0;
+                resolve({
+                    upDur,
+                    downDur,
+                    upKps: upKps.toFixed(0),
+                    downKps: downKps.toFixed(0),
+                });
             }, this.uuid);
             bytes = Number(bytes);
             if (!bytes) {
@@ -108,25 +141,25 @@ export default class BrowserSession extends BaseSession {
         });
     }
     getDevices() {
-        return getDevices().catch(error => {
+        return getDevices().catch((error) => {
             trigger(SwEvent.MediaError, error, this.uuid);
             return [];
         });
     }
     getVideoDevices() {
-        return getDevices(DeviceType.Video).catch(error => {
+        return getDevices(DeviceType.Video).catch((error) => {
             trigger(SwEvent.MediaError, error, this.uuid);
             return [];
         });
     }
     getAudioInDevices() {
-        return getDevices(DeviceType.AudioIn).catch(error => {
+        return getDevices(DeviceType.AudioIn).catch((error) => {
             trigger(SwEvent.MediaError, error, this.uuid);
             return [];
         });
     }
     getAudioOutDevices() {
-        return getDevices(DeviceType.AudioOut).catch(error => {
+        return getDevices(DeviceType.AudioOut).catch((error) => {
             trigger(SwEvent.MediaError, error, this.uuid);
             return [];
         });
@@ -142,8 +175,8 @@ export default class BrowserSession extends BaseSession {
                 cache[kind] = {};
                 Object.defineProperty(cache[kind], 'toArray', {
                     value: function () {
-                        return Object.keys(this).map(k => this[k]);
-                    }
+                        return Object.keys(this).map((k) => this[k]);
+                    },
                 });
             });
             const devices = yield this.getDevices();
@@ -218,7 +251,9 @@ export default class BrowserSession extends BaseSession {
     }
     set iceServers(servers) {
         if (typeof servers === 'boolean') {
-            this._iceServers = servers ? [{ urls: ['stun:stun.l.google.com:19302'] }] : [];
+            this._iceServers = servers
+                ? [{ urls: ['stun:stun.l.google.com:19302'] }]
+                : [];
         }
         else {
             this._iceServers = servers;
@@ -245,7 +280,7 @@ export default class BrowserSession extends BaseSession {
     get remoteElement() {
         return this._remoteElement;
     }
-    vertoBroadcast({ nodeId, channel: eventChannel = '', data }) {
+    vertoBroadcast({ nodeId, channel: eventChannel = '', data, }) {
         if (!eventChannel) {
             throw new Error('Invalid channel for broadcast: ' + eventChannel);
         }
@@ -253,11 +288,11 @@ export default class BrowserSession extends BaseSession {
         if (nodeId) {
             msg.targetNodeId = nodeId;
         }
-        this.execute(msg).catch(error => error);
+        this.execute(msg).catch((error) => error);
     }
-    vertoSubscribe({ nodeId, channels: eventChannel = [], handler }) {
+    vertoSubscribe({ nodeId, channels: eventChannel = [], handler, }) {
         return __awaiter(this, void 0, void 0, function* () {
-            eventChannel = eventChannel.filter(channel => channel && !this._existsSubscription(this.relayProtocol, channel));
+            eventChannel = eventChannel.filter((channel) => channel && !this._existsSubscription(this.relayProtocol, channel));
             if (!eventChannel.length) {
                 return {};
             }
@@ -268,15 +303,15 @@ export default class BrowserSession extends BaseSession {
             const response = yield this.execute(msg);
             const { unauthorized = [], subscribed = [] } = destructSubscribeResponse(response);
             if (unauthorized.length) {
-                unauthorized.forEach(channel => this._removeSubscription(this.relayProtocol, channel));
+                unauthorized.forEach((channel) => this._removeSubscription(this.relayProtocol, channel));
             }
-            subscribed.forEach(channel => this._addSubscription(this.relayProtocol, handler, channel));
+            subscribed.forEach((channel) => this._addSubscription(this.relayProtocol, handler, channel));
             return response;
         });
     }
-    vertoUnsubscribe({ nodeId, channels: eventChannel = [] }) {
+    vertoUnsubscribe({ nodeId, channels: eventChannel = [], }) {
         return __awaiter(this, void 0, void 0, function* () {
-            eventChannel = eventChannel.filter(channel => channel && this._existsSubscription(this.relayProtocol, channel));
+            eventChannel = eventChannel.filter((channel) => channel && this._existsSubscription(this.relayProtocol, channel));
             if (!eventChannel.length) {
                 return {};
             }
@@ -286,8 +321,8 @@ export default class BrowserSession extends BaseSession {
             }
             const response = yield this.execute(msg);
             const { unsubscribed = [], notSubscribed = [] } = destructSubscribeResponse(response);
-            unsubscribed.forEach(channel => this._removeSubscription(this.relayProtocol, channel));
-            notSubscribed.forEach(channel => this._removeSubscription(this.relayProtocol, channel));
+            unsubscribed.forEach((channel) => this._removeSubscription(this.relayProtocol, channel));
+            notSubscribed.forEach((channel) => this._removeSubscription(this.relayProtocol, channel));
             return response;
         });
     }

package/dist/esm/common/src/services/Handler.d.ts

@@ -5,4 +5,4 @@ declare const registerOnce: (eventName: string, callback: Function, uniqueId?: s
 declare const deRegister: (eventName: string, callback?: Function | null, uniqueId?: string) => boolean;
 declare const trigger: (eventName: string, data: any, uniqueId?: string, globalPropagation?: boolean) => boolean;
 declare const deRegisterAll: (eventName: string) => void;
-export { trigger, register, registerOnce, deRegister, deRegisterAll, isQueued, queueLength };
+export { trigger, register, registerOnce, deRegister, deRegisterAll, isQueued, queueLength, };

package/dist/esm/common/src/services/Handler.js

@@ -33,7 +33,8 @@ const deRegister = (eventName, callback, uniqueId = GLOBAL) => {
         const len = queue[eventName][uniqueId].length;
         for (let i = len - 1; i >= 0; i--) {
             const fn = queue[eventName][uniqueId][i];
-            if (callback === fn || (fn.prototype && callback === fn.prototype.targetRef)) {
+            if (callback === fn ||
+                (fn.prototype && callback === fn.prototype.targetRef)) {
                 queue[eventName][uniqueId].splice(i, 1);
             }
         }
@@ -75,4 +76,4 @@ const trigger = (eventName, data, uniqueId = GLOBAL, globalPropagation = true) =
 const deRegisterAll = (eventName) => {
     delete queue[eventName];
 };
-export { trigger, register, registerOnce, deRegister, deRegisterAll, isQueued, queueLength };
+export { trigger, register, registerOnce, deRegister, deRegisterAll, isQueued, queueLength, };

package/dist/esm/common/src/util/helpers.d.ts

@@ -18,3 +18,4 @@ export declare const destructResponse: (response: any, nodeId?: string) => {
     [key: string]: any;
 };
 export declare const randomInt: (min: number, max: number) => number;
+export declare const normalizeAsyncAPIs: <T extends object>(target: T, promisifyTargetMethods?: string[], asyncAlternativeSuffix?: string) => T;

package/dist/esm/common/src/util/helpers.js

@@ -4,7 +4,7 @@ export const deepCopy = (obj) => JSON.parse(JSON.stringify(obj));
 export const objEmpty = (obj) => Object.keys(obj).length === 0;
 export const mutateStorageKey = (key) => `${STORAGE_PREFIX}${key}`;
 export const mutateLiveArrayData = (data) => {
-    const [participantId, participantNumber, participantName, codec, mediaJson, participantData] = data;
+    const [participantId, participantNumber, participantName, codec, mediaJson, participantData,] = data;
     let media = {};
     try {
         media = JSON.parse(mediaJson.replace(/ID"/g, 'Id"'));
@@ -12,7 +12,14 @@ export const mutateLiveArrayData = (data) => {
     catch (error) {
         logger.warn('Verto LA invalid media JSON string:', mediaJson);
     }
-    return { participantId: Number(participantId), participantNumber, participantName, codec, media, participantData };
+    return {
+        participantId: Number(participantId),
+        participantNumber,
+        participantName,
+        codec,
+        media,
+        participantData,
+    };
 };
 export const safeParseJson = (value) => {
     if (typeof value !== 'string') {
@@ -71,3 +78,28 @@ export const destructResponse = (response, nodeId = null) => {
 export const randomInt = (min, max) => {
     return Math.floor(Math.random() * (max - min + 1) + min);
 };
+export const normalizeAsyncAPIs = (target, promisifyTargetMethods = [], asyncAlternativeSuffix = 'Async') => {
+    const promisify = new Set(promisifyTargetMethods);
+    return new Proxy(target, {
+        get(obj, prop) {
+            const descriptor = Object.getOwnPropertyDescriptor(obj, prop);
+            if (descriptor && descriptor.get) {
+                return Reflect.get(obj, prop);
+            }
+            if (typeof obj[prop] === 'function') {
+                const impl = obj[`${String(prop)}${asyncAlternativeSuffix}`] || obj[prop];
+                return (...args) => {
+                    const result = impl.apply(obj, args);
+                    if (promisify.has(String(prop)) && !(result instanceof Promise)) {
+                        return Promise.resolve(result);
+                    }
+                    return result;
+                };
+            }
+            return Reflect.get(obj, prop);
+        },
+        set(obj, prop, value) {
+            return Reflect.set(obj, prop, value);
+        },
+    });
+};

package/dist/esm/common/src/util/interfaces.d.ts

@@ -1,3 +1,4 @@
+import { IWebRTCOverridesManager } from '../webrtc/WebRTC';
 interface IMessageBase {
     jsonrpc: string;
     id: string;
@@ -78,6 +79,7 @@ export interface ISignalWireOptions {
     password?: string;
     userVariables?: Object;
 }
+export type ISignalWireBrowserOptions = ISignalWireOptions & Partial<IWebRTCOverridesManager>;
 export interface SubscribeParams {
     channels?: string[];
     protocol?: string;