@webex/plugin-meetings 2.39.0 → 2.39.2

package/dist/networkQualityMonitor/index.d.ts

@@ -0,0 +1,70 @@
+import EventsScope from '../common/events/events-scope';
+/**
+ * Meeting - network quality event
+ * Emitted on each interval of retrieving stats Analyzer data
+ * @event network:quality
+ * @type {Object}
+ * @property {string} mediaType {video|audio}
+ * @property {number} networkQualityScore - value determined in determineUplinkNetworkQuality
+ * @memberof NetworkQualityMonitor
+ */
+/**
+ * NetworkQualityMonitor class that will emit events based on detected quality
+ *
+ * @class NetworkQualityMonitor
+ * @extends {EventsScope}
+ */
+export default class NetworkQualityMonitor extends EventsScope {
+    config: any;
+    frequencyTypes: any;
+    indicatorTypes: any;
+    mediaType: any;
+    networkQualityScore: any;
+    networkQualityStatus: any;
+    /**
+     * Creates a new instance of NetworkQualityMonitor
+     * @constructor
+     * @public
+     * @param {Object} config
+     * @property {Object} indicatorTypes - network properties used to evaluate network quality used as constants
+     * @property {Object} frequencyTypes - frequency properties used as constants {uplink|send} {downlink|receive}
+     * @property {number} networkQualityScore  - 0|1 1 is acceptable 0 is bad/unknown
+     * @property {Object} networkQualityStatus - hash object based on indicatorTypes and frequencyTypes
+     * @property {string} mediaType - audio|video
+     */
+    constructor(config: any);
+    /**
+     * emits NETWORK_QUALITY event on meeting with payload of media type and uplinkNetworkQuality score
+     *
+     * @memberof NetworkQualityMonitor
+     * @returns {void}
+     */
+    emitNetworkQuality(): void;
+    /**
+     * invokes emitNetworkQuality method resets values back to default
+     * @returns {void}
+     * @memberof NetworkQualityMonitor
+     */
+    updateNetworkQualityStatus(): void;
+    /**
+     * filter data to determine uplink network quality, invoked on same interval as stats analyzer remote-inbout-rtp
+     * @param {Object} configObj
+     * @param {string} configObj.mediaType {audio|video}
+     * @param {RTCStats} configObj.remoteRtpResults RTC stats remote obj
+     * @param {Object} configObj.statsAnalyzerCurrentStats statsResults
+     * @returns {void}
+     * @public
+     * @memberof NetworkQualityMonitor
+     */
+    determineUplinkNetworkQuality({ mediaType, remoteRtpResults, statsAnalyzerCurrentStats, }: {
+        mediaType: string;
+        remoteRtpResults: any;
+        statsAnalyzerCurrentStats: object;
+    }): void;
+    /**
+     * Get the current status of network quaility object - networkQualityStatus
+     * @returns {Object}
+     * @public
+     */
+    get networkQualityStats(): any;
+}

package/dist/peer-connection-manager/index.d.ts

@@ -0,0 +1,6 @@
+/**
+ * @export
+ * @public
+ */
+declare const pc: any;
+export default pc;

package/dist/peer-connection-manager/util.d.ts

@@ -0,0 +1,6 @@
+interface IPeerConnectionUtils {
+    convertCLineToIpv4: (sdp: string) => string;
+    adjustH264Profile: (sdp: string, maxFsValue: number) => string;
+}
+declare const PeerConnectionUtils: IPeerConnectionUtils;
+export default PeerConnectionUtils;

package/dist/personal-meeting-room/index.d.ts

@@ -0,0 +1,47 @@
+import { StatelessWebexPlugin } from '@webex/webex-core';
+/**
+ * @class PersonalMeetingRoom
+ */
+export default class PersonalMeetingRoom extends StatelessWebexPlugin {
+    link: any;
+    meetingInfo: any;
+    name: any;
+    personalMeetingRoomRequest: any;
+    pmr: any;
+    sipUri: any;
+    userId: any;
+    meetingLink: any;
+    number: any;
+    namespace: string;
+    /**
+     *
+     * @param {Object} attrs
+     * @param {Object} options
+     */
+    constructor(attrs: any, options: any);
+    /**
+     * claims a pmr and updates the cached PMR values
+     * @param {String} link
+     * @param {String} pin
+     * @param {Boolean} [preferred] defaults to true to set this claimed PMR as the preferred
+     * @returns {Promise}
+     * @public
+     * @memberof PersonalMeetingRoom
+     */
+    claim(link: string, pin: string, preferred?: boolean): any;
+    /**
+     * @param {Object} body the response body from meeting info request
+     * @returns {undefined}
+     * @private
+     * @memberof PersonalMeetingRoom
+     */
+    private set;
+    /**
+     * TODO: implement TTL for syncing and caching so to not request again and again
+     * @param {Object} options
+     * @returns {Promise}
+     * @public
+     * @memberof PersonalMeetingRoom
+     */
+    get(): any;
+}

package/dist/personal-meeting-room/request.d.ts

@@ -0,0 +1,14 @@
+import { StatelessWebexPlugin } from '@webex/webex-core';
+/**
+ * @class MeetingInfoRequest
+ */
+export default class PersonalMeetingRoomRequest extends StatelessWebexPlugin {
+    namespace: string;
+    /**
+     *
+     * @param {Object} options with format of {userId, passcode, meetingAddress, preferred}
+     * @returns {Promise} returns a promise that resolves/rejects the result of the request
+     * @memberof PersonalMeetingRoomRequest
+     */
+    claimPmr(options: any): any;
+}

package/dist/personal-meeting-room/util.d.ts

@@ -0,0 +1,2 @@
+declare const PersonalMeetingRoomUtil: any;
+export default PersonalMeetingRoomUtil;

package/dist/reachability/index.d.ts

@@ -0,0 +1,139 @@
+/*!
+ * Copyright (c) 2015-2020 Cisco Systems, Inc. See LICENSE file.
+ */
+/**
+ * @class Reachability
+ * @export
+ */
+export default class Reachability {
+    webex: object;
+    reachabilityRequest: any;
+    clusterLatencyResults: any;
+    /**
+     * Creates an instance of Reachability.
+     * @param {object} webex
+     * @memberof Reachability
+     */
+    constructor(webex: object);
+    /**
+     * fetches reachability data
+     * @returns {Object} reachability data
+     * @public
+     * @async
+     * @memberof Reachability
+     */
+    gatherReachability(): Promise<unknown>;
+    /**
+     * fetches reachability data and checks for cluster reachability
+     * @returns {boolean}
+     * @public
+     * @memberof Reachability
+     */
+    isAnyClusterReachable(): boolean;
+    /**
+     * Generate peerConnection config settings
+     * @param {object} cluster
+     * @returns {object} peerConnectionConfig
+     * @private
+     * @memberof Reachability
+     */
+    private buildPeerConnectionConfig;
+    /**
+     * Creates an RTCPeerConnection
+     * @param {object} cluster
+     * @returns {RTCPeerConnection} peerConnection
+     * @private
+     * @memberof Reachability
+     */
+    private createPeerConnection;
+    /**
+     * Gets total elapsed time
+     * @param {RTCPeerConnection} peerConnection
+     * @returns {Number} Milliseconds
+     * @private
+     * @memberof Reachability
+     */
+    private getElapsedTime;
+    /**
+     * creates offer and generates localSDP
+     * @param {object} clusterList cluster List
+     * @returns {Promise} Reachability latency results
+     * @private
+     * @memberof Reachability
+     */
+    private getLocalSDPForClusters;
+    /**
+     * Get list of all unreachable clusters
+     * @returns {array} Unreachable clusters
+     * @private
+     * @memberof Reachability
+     */
+    private getUnreachablClusters;
+    /**
+     * Attach an event handler for the icegatheringstatechange
+     * event and measure latency.
+     * @param {RTCPeerConnection} peerConnection
+     * @returns {undefined}
+     * @private
+     * @memberof Reachability
+     */
+    private handleIceGatheringStateChange;
+    /**
+     * Attach an event handler for the icecandidate
+     * event and measure latency.
+     * @param {RTCPeerConnection} peerConnection
+     * @returns {undefined}
+     * @private
+     * @memberof Reachability
+     */
+    private handleOnIceCandidate;
+    /**
+     * An event handler on an RTCPeerConnection when the state of the ICE
+     * candidate gathering process changes. Used to measure connection
+     * speed.
+     * @private
+     * @param {RTCPeerConnection} peerConnection
+     * @param {number} timeout
+     * @returns {Promise}
+     */
+    private iceGatheringState;
+    /**
+     * Make a log of unreachable clusters.
+     * @returns {undefined}
+     * @private
+     * @memberof Reachability
+     */
+    private logUnreachableClusters;
+    /**
+     * Calculates time to establish connection
+     * @param {array} iceResults iceResults
+     * @returns {object} reachabilityMap
+     * @private
+     * @memberof Reachability
+     */
+    private parseIceResultsToReachabilityResults;
+    /**
+     * fetches reachability data
+     * @param {object} clusterList
+     * @returns {Promise<localSDPData>} reachability check results
+     * @private
+     * @memberof Reachability
+     */
+    private performReachabilityCheck;
+    /**
+     * Records latency and closes the peerConnection
+     * @param {RTCPeerConnection} peerConnection
+     * @param {number} elapsed Latency in milliseconds
+     * @returns {undefined}
+     * @private
+     * @memberof Reachability
+     */
+    private setLatencyAndClose;
+    /**
+     * utility function
+     * @returns {undefined}
+     * @private
+     * @memberof Reachability
+     */
+    private setup;
+}

package/dist/reachability/request.d.ts

@@ -0,0 +1,35 @@
+export interface ClusterNode {
+    isVideoMesh: boolean;
+    udp: Array<string>;
+    tcp: Array<string>;
+    xtls: Array<string>;
+}
+export type ClusterList = {
+    [key: string]: ClusterNode;
+};
+/**
+ * @class ReachabilityRequest
+ */
+declare class ReachabilityRequest {
+    webex: any;
+    /**
+     * Creates an instance of ReachabilityRequest.
+     * @param {object} webex
+     * @memberof ReachabilityRequest
+     */
+    constructor(webex: object);
+    /**
+     * gets the cluster information
+     *
+     * @param {boolean} includeVideoMesh whether to include the video mesh clusters in the result or not
+     * @returns {Promise}
+     */
+    getClusters: () => Promise<ClusterList>;
+    /**
+     * gets remote SDP For Clusters
+     * @param {Object} localSDPList localSDPs for the cluster
+     * @returns {Object}
+     */
+    remoteSDPForClusters: (localSDPList: object) => any;
+}
+export default ReachabilityRequest;

package/dist/reactions/reactions.d.ts

@@ -0,0 +1,4 @@
+import { Reaction, ReactionType, SkinTone, SkinToneType } from './reactions.type';
+declare const Reactions: Record<ReactionType, Reaction>;
+declare const SkinTones: Record<SkinToneType, SkinTone>;
+export { Reactions, SkinTones };

package/dist/reactions/reactions.type.d.ts

@@ -0,0 +1,32 @@
+export type EmoticonData = {
+    type: string;
+    codepoints?: string;
+    shortcodes?: string;
+};
+export type SkinTone = EmoticonData;
+export type Reaction = EmoticonData & {
+    tone?: SkinTone;
+};
+export declare enum ReactionType {
+    smile = "smile",
+    sad = "sad",
+    wow = "wow",
+    haha = "haha",
+    celebrate = "celebrate",
+    clap = "clap",
+    thumbs_up = "thumbs_up",
+    thumbs_down = "thumbs_down",
+    heart = "heart",
+    fire = "fire",
+    prayer = "prayer",
+    speed_up = "speed_up",
+    slow_down = "slow_down"
+}
+export declare enum SkinToneType {
+    normal = "normal",
+    light = "light",
+    medium_light = "medium_light",
+    medium = "medium",
+    medium_dark = "medium_dark",
+    dark = "dark"
+}

package/dist/reconnection-manager/index.d.ts

@@ -0,0 +1,112 @@
+/*!
+ * Copyright (c) 2015-2020 Cisco Systems, Inc. See LICENSE file.
+ */
+import Meeting from '../meeting';
+/**
+ * @export
+ * @class ReconnectionManager
+ */
+export default class ReconnectionManager {
+    autoRejoinEnabled: any;
+    iceState: any;
+    maxRejoinAttempts: any;
+    meeting: any;
+    rejoinAttempts: any;
+    shareStatus: any;
+    status: any;
+    tryCount: any;
+    webex: any;
+    /**
+     * @param {Meeting} meeting
+     */
+    constructor(meeting: Meeting);
+    /**
+     * Sets the iceState to connected and clears any disconnect timeouts and
+     * related timeout data within the iceState.
+     *
+     * @returns {undefined}
+     * @public
+     * @memberof ReconnectionManager
+     */
+    iceReconnected(): void;
+    /**
+     * Set the iceState to disconnected and generates a timeout that waits for the
+     * iceState to reconnect and then resolves. If the ice state is already
+     * processing a reconnect, it immediately resolves. Rejects if the timeout
+     * duration is reached.
+     *
+     * @returns {Promise<undefined>}
+     * @public
+     * @memberof ReconnectionManager
+     */
+    waitForIceReconnect(): Promise<void>;
+    /**
+     * @returns {undefined}
+     * @public
+     * @memberof ReconnectionManager
+     */
+    reset(): void;
+    /**
+     * @returns {undefined}
+     * @public
+     * @memberof ReconnectionManager
+     */
+    cleanUp(): void;
+    /**
+     * @returns {Boolean}
+     * @throws {ReconnectionError}
+     * @private
+     * @memberof ReconnectionManager
+     */
+    private validate;
+    /**
+     * Initiates a media reconnect for the active meeting
+     * @param {Object} reconnectOptions
+     * @param {boolean} [reconnectOptions.networkDisconnect=false] indicates if a network disconnect event happened
+     * @param {boolean} [reconnectOptions.networkRetry=false] indicates if we are retrying the reconnect
+     * @returns {Promise}
+     * @public
+     * @memberof ReconnectionManager
+     */
+    reconnect({ networkDisconnect, networkRetry, }?: {
+        networkDisconnect?: boolean;
+        networkRetry?: boolean;
+    }): any;
+    /**
+     * @param {Object} reconnectOptions
+     * @param {boolean} [reconnectOptions.networkDisconnect=false] indicates if a network disconnect event happened
+     * @returns {Promise}
+     * @throws {NeedsRetryError}
+     * @private
+     * @memberof ReconnectionManager
+     */
+    private executeReconnection;
+    /**
+     * Rejoins a meeting after detecting the member was in a LEFT state
+     *
+     * @async
+     * @param {boolean} wasSharing
+     * @returns {Promise}
+     */
+    rejoinMeeting(wasSharing?: boolean): Promise<void>;
+    /**
+     * @returns {Promise}
+     * @private
+     * @memberof ReconnectionManager
+     */
+    reconnectMedia(): Promise<any>;
+    /**
+     * Attempt to Reconnect Mercury Websocket
+     * @returns {Promise}
+     * @private
+     * @memberof ReconnectionManager
+     */
+    private reconnectMercuryWebSocket;
+    /**
+     * @param {Meeting} meeting
+     * @returns {undefined}
+     * @private
+     * @memberof ReconnectionManager
+     */
+    private static setupPeerConnection;
+}

package/dist/recording-controller/enums.d.ts

@@ -0,0 +1,7 @@
+declare enum RecordingAction {
+    Start = "Start",
+    Stop = "Stop",
+    Pause = "Pause",
+    Resume = "Resume"
+}
+export default RecordingAction;

package/dist/recording-controller/index.d.ts

@@ -0,0 +1,193 @@
+import MeetingRequest from '../meeting/request';
+/**
+ * @description Recording manages the recording functionality of the meeting object, there should only be one instantation of recording per meeting
+ * @export
+ * @private
+ * @class Recording
+ */
+export default class RecordingController {
+    /**
+     * @instance
+     * @type {MeetingRequest}
+     * @private
+     * @memberof RecordingController
+     */
+    private request;
+    /**
+     * @instance
+     * @type {Array}
+     * @private
+     * @memberof RecordingInfo
+     */
+    private displayHints;
+    /**
+     * @instance
+     * @type {string}
+     * @private
+     * @memberof RecordingInfo
+     */
+    private serviceUrl;
+    /**
+     * @instance
+     * @type {string}
+     * @private
+     * @memberof RecordingInfo
+     */
+    private sessionId;
+    /**
+     * @instance
+     * @type {string}
+     * @private
+     * @memberof RecordingInfo
+     */
+    private locusUrl;
+    /**
+     * @instance
+     * @type {string}
+     * @private
+     * @memberof RecordingInfo
+     */
+    private locusId;
+    /**
+     * @param {MeetingRequest} request
+     * @param {Object} options
+     * @constructor
+     * @memberof RecordingController
+     */
+    constructor(request: MeetingRequest, options?: {
+        serviceUrl?: string;
+        sessionId: string;
+        locusUrl: string;
+        displayHints?: Array<string>;
+    });
+    /**
+     * @param {MeetingRequest} request
+     * @param {LocusInfo} info
+     * @returns {void}
+     * @private
+     * @memberof RecordingController
+     */
+    private initialize;
+    /**
+     * @param {Object} options
+     * @returns {void}
+     * @public
+     * @memberof RecordingController
+     */
+    set(options?: {
+        serviceUrl?: string;
+        sessionId: string;
+        locusUrl: string;
+        displayHints?: Array<string>;
+    }): void;
+    /**
+     * @param {string} url
+     * @returns {void}
+     * @public
+     * @memberof RecordingController
+     */
+    setLocusUrl(url: string): void;
+    /**
+     * @param {Array} hints
+     * @returns {void}
+     * @public
+     * @memberof RecordingController
+     */
+    setDisplayHints(hints: Array<string>): void;
+    /**
+     * @param {string} id
+     * @returns {void}
+     * @public
+     * @memberof RecordingController
+     */
+    setSessionId(id: string): void;
+    /**
+     * @param {string} url
+     * @returns {void}
+     * @public
+     * @memberof RecordingController
+     */
+    setServiceUrl(url: string): void;
+    /**
+     * @returns {string}
+     * @public
+     * @memberof RecordingController
+     */
+    getLocusUrl(): string;
+    /**
+     * @returns {string}
+     * @public
+     * @memberof RecordingController
+     */
+    getLocusId(): string;
+    /**
+     * @returns {string}
+     * @public
+     * @memberof RecordingController
+     */
+    getSessionId(): string;
+    /**
+     * @returns {string}
+     * @public
+     * @memberof RecordingController
+     */
+    getServiceUrl(): string;
+    /**
+     * @returns {Array}
+     * @public
+     * @memberof RecordingController
+     */
+    getDisplayHints(): string[];
+    /**
+     * @param {Object} options
+     * @returns {void}
+     * @private
+     * @memberof RecordingController
+     */
+    private extract;
+    /**
+     * @param {RecordingAction} action
+     * @private
+     * @memberof RecordingController
+     * @returns {Promise}
+     */
+    private recordingService;
+    /**
+     * @param {RecordingAction} action
+     * @private
+     * @memberof RecordingController
+     * @returns {Promise}
+     */
+    private recordingControls;
+    /**
+     * @param {RecordingAction} action
+     * @private
+     * @memberof RecordingController
+     * @returns {Promise}
+     */
+    private recordingFacade;
+    /**
+     * @private
+     * @memberof RecordingController
+     * @returns {Promise}
+     */
+    startRecording(): Promise<any>;
+    /**
+     * @private
+     * @memberof RecordingController
+     * @returns {Promise}
+     */
+    stopRecording(): Promise<any>;
+    /**
+     * @private
+     * @memberof RecordingController
+     * @returns {Promise}
+     */
+    pauseRecording(): Promise<any>;
+    /**
+     * @private
+     * @memberof RecordingController
+     * @returns {Promise}
+     */
+    resumeRecording(): Promise<any>;
+}

package/dist/recording-controller/util.d.ts

@@ -0,0 +1,13 @@
+import RecordingAction from './enums';
+declare const _default: {
+    canUserStart: (displayHints: string[]) => boolean;
+    canUserPause: (displayHints: string[]) => boolean;
+    canUserResume: (displayHints: string[]) => boolean;
+    canUserStop: (displayHints: string[]) => boolean;
+    deriveRecordingStates: (action: RecordingAction) => {
+        recording: boolean;
+        paused: boolean;
+    };
+    extractLocusId: (url: string) => string;
+};
+export default _default;