@signalwire/js 1.3.0-dev.0 → 1.3.0

package/README.md

@@ -1,7 +1,9 @@
-# SignalWire JavaScript SDK
+# SignalWire JavaScript SDK v1
 
 
-[![Build Status](https://ci.signalwire.com/api/badges/signalwire/signalwire-node/status.svg)](https://ci.signalwire.com/signalwire/signalwire-node) ![NPM](https://img.shields.io/npm/v/@signalwire/js.svg?color=brightgreen)
+[![Build Status](https://ci.signalwire.com/api/badges/signalwire/signalwire-node/status.svg)](https://ci.signalwire.com/signalwire/signalwire-node) ![NPM](https://img.shields.io/npm/v/@signalwire/js/legacy.svg?color=brightgreen)
+
+> :warning: For the **latest version** of the JavaScript SDK, please see [signalwire/signalwire-js](https://github.com/signalwire/signalwire-js).
 
 The JavaScript SDK transforms your standard browser into a realtime media engine, enabling developers to directly make audio and video calls to phone numbers, SIP endpoints, and other browsers. Using the JavaScript SDK you can add immersive, scalable communication - from video conferences and softphones to click-to-call and mobile gaming - all available right in your own web pages and applications.
 

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

@@ -1,27 +1,26 @@
 import * as log from 'loglevel';
 import Connection from './services/Connection';
 import BaseMessage from '../../common/src/messages/BaseMessage';
-import { BroadcastParams, ISignalWireOptions, SubscribeParams, IBladeAuthorization } from './util/interfaces';
+import { BroadcastParams, ISignalWireOptions, SubscribeParams, IBladeConnectResult } from './util/interfaces';
 export default abstract class BaseSession {
     options: ISignalWireOptions;
     uuid: string;
     sessionid: string;
-    subscriptions: Map<string, boolean>;
+    subscriptions: {
+        [channel: string]: any;
+    };
     nodeid: string;
     master_nodeid: string;
+    expiresAt: number;
+    signature: string;
     relayProtocol: string;
     contexts: string[];
     timeoutErrorCode: number;
-    authorization: IBladeAuthorization;
     protected connection: Connection;
     protected _jwtAuth: boolean;
-    protected _checkJWTExpirationTimeout: number;
-    protected _refreshTokenNotificationDiff: number;
-    protected _expiredDiffSeconds: number;
     protected _doKeepAlive: boolean;
     protected _keepAliveTimeout: any;
     protected _reconnectTimeout: any;
-    protected _checkTokenExpirationTimeout: any;
     protected _autoReconnect: boolean;
     protected _idle: boolean;
     private _executeQueue;
@@ -29,11 +28,6 @@ export default abstract class BaseSession {
     constructor(options: ISignalWireOptions);
     get __logger(): log.Logger;
     get connected(): boolean;
-    get signature(): string;
-    get scopeId(): string;
-    get resource(): string;
-    get scopes(): string[];
-    get expiresAt(): number;
     get expired(): boolean;
     get reconnectDelay(): number;
     execute(msg: BaseMessage): any;
@@ -49,6 +43,7 @@ export default abstract class BaseSession {
     connect(): Promise<void>;
     protected _handleLoginError(error: any): void;
     protected _onSocketOpen(): Promise<void>;
+    protected _handleBladeConnectResponse(response: IBladeConnectResult): void;
     protected _onSocketCloseOrError(event: any): void;
     protected _onSocketMessage(response: any): void;
     protected _removeSubscription(protocol: string, channel?: string): void;
@@ -58,7 +53,7 @@ export default abstract class BaseSession {
     private _detachListeners;
     private _emptyExecuteQueues;
     private _closeConnection;
-    protected _checkTokenExpiration(): void;
+    private _checkTokenExpiration;
     private _keepAlive;
     static on(eventName: string, callback: any): void;
     static off(eventName: string): void;

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

@@ -14,7 +14,7 @@ import Setup from './services/Setup';
 import { deRegister, register, trigger, deRegisterAll } from './services/Handler';
 import BroadcastHandler from './services/BroadcastHandler';
 import { ADD, REMOVE, SwEvent, BladeMethod } from './util/constants';
-import { Notification } from './webrtc/constants';
+import { NOTIFICATION_TYPE } from './webrtc/constants';
 import { Subscription, Connect, Reauthenticate, Ping } from './messages/Blade';
 import { isFunction, randomInt } from './util/helpers';
 import { sessionStorage } from './util/storage/';
@@ -24,15 +24,14 @@ export default class BaseSession {
         this.options = options;
         this.uuid = uuidv4();
         this.sessionid = '';
-        this.subscriptions = new Map();
+        this.subscriptions = {};
+        this.expiresAt = 0;
+        this.signature = null;
         this.relayProtocol = null;
         this.contexts = [];
         this.timeoutErrorCode = -32000;
         this.connection = null;
         this._jwtAuth = false;
-        this._checkJWTExpirationTimeout = 30 * 1000;
-        this._refreshTokenNotificationDiff = 120;
-        this._expiredDiffSeconds = 0;
         this._doKeepAlive = false;
         this._autoReconnect = true;
         this._idle = false;
@@ -54,28 +53,8 @@ export default class BaseSession {
     get connected() {
         return this.connection && this.connection.connected;
     }
-    get signature() {
-        return this.authorization ? this.authorization.signature : null;
-    }
-    get scopeId() {
-        return this.authorization ? this.authorization.scope_id : null;
-    }
-    get resource() {
-        return this.authorization ? this.authorization.resource : null;
-    }
-    get scopes() {
-        return this.authorization ? this.authorization.scopes : [];
-    }
-    get expiresAt() {
-        return this.authorization ? +this.authorization.expires_at : 0;
-    }
     get expired() {
-        if (this.expiresAt) {
-            const now = Math.floor(Date.now() / 1000);
-            const diff = this.expiresAt - now;
-            return diff <= this._expiredDiffSeconds;
-        }
-        return false;
+        return this.expiresAt && this.expiresAt <= (Date.now() / 1000);
     }
     get reconnectDelay() {
         return randomInt(6, 2) * 1000;
@@ -131,16 +110,13 @@ export default class BaseSession {
     disconnect() {
         return __awaiter(this, void 0, void 0, function* () {
             clearTimeout(this._reconnectTimeout);
-            this.subscriptions.clear();
+            this.subscriptions = {};
             this._autoReconnect = false;
             this.relayProtocol = null;
             this._closeConnection();
             yield sessionStorage.removeItem(this.signature);
             this._executeQueue = [];
             this._detachListeners();
-            this.off(SwEvent.Ready);
-            this.off(SwEvent.Notification);
-            this.off(SwEvent.Error);
         });
     }
     on(eventName, callback) {
@@ -161,7 +137,8 @@ export default class BaseSession {
                 else {
                     const br = new Reauthenticate(this.options.project, token, this.sessionid);
                     const response = yield this.execute(br);
-                    this.authorization = response.authorization || null;
+                    const { authorization: { expires_at = null } = {} } = response;
+                    this.expiresAt = +expires_at || 0;
                 }
             }
             catch (error) {
@@ -193,8 +170,9 @@ export default class BaseSession {
             const response = yield this.execute(bc).catch(this._handleLoginError);
             if (response) {
                 this._autoReconnect = true;
-                const { sessionid, nodeid, master_nodeid, authorization } = response;
-                this.authorization = authorization;
+                const { sessionid, nodeid, master_nodeid, authorization: { expires_at = null, signature = null } = {} } = response;
+                this.expiresAt = +expires_at || 0;
+                this.signature = signature;
                 this.relayProtocol = yield Setup(this);
                 this._checkTokenExpiration();
                 this.sessionid = sessionid;
@@ -203,26 +181,28 @@ export default class BaseSession {
                 this._emptyExecuteQueues();
                 this._pong = null;
                 this._keepAlive();
+                this._handleBladeConnectResponse(response);
                 trigger(SwEvent.Ready, this, this.uuid);
                 logger.info('Session Ready!');
             }
         });
     }
+    _handleBladeConnectResponse(response) {
+    }
     _onSocketCloseOrError(event) {
         logger.error(`Socket ${event.type} ${event.message}`);
         if (this.relayProtocol) {
             deRegisterAll(this.relayProtocol);
         }
         for (const sub in this.subscriptions) {
-            const protocol = sub.split('|')[0];
-            deRegisterAll(protocol);
+            deRegisterAll(sub);
         }
-        this.subscriptions.clear();
+        this.subscriptions = {};
         this.contexts = [];
         if (this.expired) {
             this._idle = true;
             this._autoReconnect = false;
-            this.authorization = null;
+            this.expiresAt = 0;
         }
         if (this._autoReconnect) {
             this._reconnectTimeout = setTimeout(() => this.connect(), this.reconnectDelay);
@@ -244,25 +224,33 @@ export default class BaseSession {
             return;
         }
         if (channel) {
+            delete this.subscriptions[protocol][channel];
             deRegister(protocol, null, channel);
         }
         else {
+            delete this.subscriptions[protocol];
             deRegisterAll(protocol);
         }
-        this.subscriptions.delete(`${protocol}|${channel}`);
     }
     _addSubscription(protocol, handler = null, channel) {
         if (this._existsSubscription(protocol, channel)) {
             return;
         }
+        if (!this._existsSubscription(protocol)) {
+            this.subscriptions[protocol] = {};
+        }
+        this.subscriptions[protocol][channel] = {};
         if (isFunction(handler)) {
             register(protocol, handler, channel);
         }
-        this.subscriptions.set(`${protocol}|${channel}`, true);
     }
     _existsSubscription(protocol, channel) {
-        const sub = `${protocol}|${channel}`;
-        return this.subscriptions.has(sub);
+        if (this.subscriptions.hasOwnProperty(protocol)) {
+            if (!channel || (channel && this.subscriptions[protocol].hasOwnProperty(channel))) {
+                return true;
+            }
+        }
+        return false;
     }
     _attachListeners() {
         this._detachListeners();
@@ -292,7 +280,6 @@ export default class BaseSession {
         clearTimeout(this._keepAliveTimeout);
         if (this.connection) {
             this.connection.close();
-            this.connection = null;
         }
     }
     _checkTokenExpiration() {
@@ -300,12 +287,12 @@ export default class BaseSession {
             return;
         }
         const diff = this.expiresAt - (Date.now() / 1000);
-        if (diff <= this._refreshTokenNotificationDiff) {
-            trigger(SwEvent.Notification, { type: Notification.RefreshToken, session: this }, this.uuid, false);
+        if (diff <= 60) {
+            logger.warn('Your JWT is going to expire. You should refresh it to keep the session live.');
+            trigger(SwEvent.Notification, { type: NOTIFICATION_TYPE.refreshToken, session: this }, this.uuid, false);
         }
-        clearTimeout(this._checkTokenExpirationTimeout);
         if (!this.expired) {
-            this._checkTokenExpirationTimeout = setTimeout(this._checkTokenExpiration, this._checkJWTExpirationTimeout);
+            setTimeout(this._checkTokenExpiration, 30 * 1000);
         }
     }
     _keepAlive() {

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

@@ -1,40 +1,28 @@
 import BaseSession from './BaseSession';
-import { IAudioSettings, IVideoSettings, BroadcastParams, SubscribeParams } from './util/interfaces';
-import BaseMessage from './messages/BaseMessage';
-import WebRTCCall from './webrtc/WebRTCCall';
-import { IConferenceInfo, IVertoConferenceListParams } from './webrtc/interfaces';
-import Conference from './webrtc/Conference';
+import { ICacheDevices, IAudioSettings, IVideoSettings, BroadcastParams, SubscribeParams, IBladeConnectResult } from './util/interfaces';
+import { IWebRTCCall } from './webrtc/interfaces';
 export default abstract class BrowserSession extends BaseSession {
     calls: {
-        [callId: string]: WebRTCCall;
+        [callId: string]: IWebRTCCall;
     };
-    conferences: {
-        [confUuid: string]: Conference;
-    };
-    channelToCallIds: Map<string, string[]>;
     micId: string;
     micLabel: string;
     camId: string;
     camLabel: string;
     autoRecoverCalls: boolean;
-    incognito: boolean;
-    conferenceListBootstrap?: () => void;
     private _iceServers;
     private _localElement;
     private _remoteElement;
     protected _jwtAuth: boolean;
+    protected _devices: ICacheDevices;
     protected _audioConstraints: boolean | MediaTrackConstraints;
     protected _videoConstraints: boolean | MediaTrackConstraints;
     protected _speaker: string;
-    protected _purgeTimeout: any;
-    protected _experimental: boolean;
-    get callIds(): string[];
-    addChannelCallIdEntry(channel: string, callId: string): void;
-    removeChannelCallIdEntry(channel: string, callId: string): void;
     get reconnectDelay(): number;
+    protected _handleBladeConnectResponse(response: IBladeConnectResult): void;
     connect(): Promise<void>;
     checkPermissions(audio?: boolean, video?: boolean): Promise<boolean>;
-    purge(): void;
+    logout(): void;
     disconnect(): Promise<void>;
     speedTest(bytes: number): Promise<unknown>;
     getDevices(): Promise<MediaDeviceInfo[]>;
@@ -42,10 +30,18 @@ export default abstract class BrowserSession extends BaseSession {
     getAudioInDevices(): Promise<MediaDeviceInfo[]>;
     getAudioOutDevices(): Promise<MediaDeviceInfo[]>;
     validateDeviceId(id: string, label: string, kind: MediaDeviceInfo['kind']): Promise<string>;
-    validateVideoDevice(id: string, label: string): Promise<string>;
-    validateAudioInDevice(id: string, label: string): Promise<string>;
-    validateAudioOutDevice(id: string, label: string): Promise<string>;
+    refreshDevices(): Promise<ICacheDevices>;
+    get devices(): ICacheDevices;
     getDeviceResolutions(deviceId: string): Promise<any[]>;
+    get videoDevices(): {
+        [deviceId: string]: MediaDeviceInfo;
+    };
+    get audioInDevices(): {
+        [deviceId: string]: MediaDeviceInfo;
+    };
+    get audioOutDevices(): {
+        [deviceId: string]: MediaDeviceInfo;
+    };
     get mediaConstraints(): {
         audio: boolean | MediaTrackConstraints;
         video: boolean | MediaTrackConstraints;
@@ -64,40 +60,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, data }: BroadcastParams): any;
-    vertoSubscribe({ nodeId, channels, handler }: SubscribeParams): Promise<any>;
-    vertoUnsubscribe({ nodeId, channels, handler }: SubscribeParams): Promise<any>;
-    listConf(): any;
-    vertoConferenceList(params: IVertoConferenceListParams): Promise<IConferenceInfo[]>;
-    vertoLayoutList(options?: {
-        fullList?: boolean;
-    }): Promise<{
-        id: string;
-        label: string;
-        type: string;
-        reservationIds: string[];
-        belongsToAGroup: boolean;
-    }[]>;
-    watchVertoConferences: (params: IVertoConferenceListParams) => Promise<IConferenceInfo[]>;
-    _watchRoomsNotificationHandler: (event: any) => void;
-    unwatchVertoConferences: () => Promise<void>;
-    private _detachChannels;
-    dispatchConferenceUpdate(params: any): void;
-    _jsApi(params?: {}): any;
-    _wrapInExecute(message: BaseMessage): BaseMessage;
-    execute(message: BaseMessage): any;
-    protected _onSocketOpen(): Promise<void>;
-    protected _onSocketCloseOrError(event: any): void;
-    watchVertoConferenceList: () => Promise<void>;
-    unwatchVertoConferenceList: () => Promise<void>;
-    vertoSubscribeToConference({ infoChannel, modChannel, laChannel }: {
-        infoChannel?: string;
-        modChannel?: string;
-        laChannel?: string;
-    }): Promise<void>;
-    vertoUnsubscribeFromConference({ infoChannel, modChannel, laChannel }: {
-        infoChannel?: string;
-        modChannel?: string;
-        laChannel?: string;
-    }): Promise<void>;
+    vertoBroadcast({ nodeId, channel: eventChannel, data }: BroadcastParams): void;
+    vertoSubscribe({ nodeId, channels: eventChannel, handler }: SubscribeParams): Promise<any>;
+    vertoUnsubscribe({ nodeId, channels: eventChannel }: SubscribeParams): Promise<any>;
 }