@webex/plugin-meetings 3.2.0 → 3.3.0

package/dist/reachability/clusterReachability.d.ts

@@ -1,110 +0,0 @@
-import { ClusterNode } from './request';
-export type TransportResult = {
-    result: 'reachable' | 'unreachable' | 'untested';
-    latencyInMilliseconds?: number;
-    clientMediaIPs?: string[];
-};
-export type ClusterReachabilityResult = {
-    udp: TransportResult;
-    tcp: TransportResult;
-    xtls: TransportResult;
-};
-/**
- * A class that handles reachability checks for a single cluster.
- */
-export declare class ClusterReachability {
-    private numUdpUrls;
-    private numTcpUrls;
-    private numXTlsUrls;
-    private result;
-    private pc?;
-    private defer;
-    private startTimestamp;
-    readonly isVideoMesh: boolean;
-    readonly name: any;
-    /**
-     * Constructor for ClusterReachability
-     * @param {string} name cluster name
-     * @param {ClusterNode} clusterInfo information about the media cluster
-     */
-    constructor(name: string, clusterInfo: ClusterNode);
-    /**
-     * Gets total elapsed time, can be called only after start() is called
-     * @returns {Number} Milliseconds
-     */
-    private getElapsedTime;
-    /**
-     * Generate peerConnection config settings
-     * @param {ClusterNode} cluster
-     * @returns {RTCConfiguration} peerConnectionConfig
-     */
-    private buildPeerConnectionConfig;
-    /**
-     * Creates an RTCPeerConnection
-     * @param {ClusterNode} clusterInfo information about the media cluster
-     * @returns {RTCPeerConnection} peerConnection
-     */
-    private createPeerConnection;
-    /**
-     * @returns {ClusterReachabilityResult} reachability result for this cluster
-     */
-    getResult(): ClusterReachabilityResult;
-    /**
-     * Closes the peerConnection
-     *
-     * @returns {void}
-     */
-    private closePeerConnection;
-    /**
-     * Resolves the defer, indicating that reachability checks for this cluster are completed
-     *
-     * @returns {void}
-     */
-    private finishReachabilityCheck;
-    /**
-     * Adds public IP (client media IPs)
-     * @param {string} protocol
-     * @param {string} publicIP
-     * @returns {void}
-     */
-    private addPublicIP;
-    /**
-     * Registers a listener for the iceGatheringStateChange event
-     *
-     * @returns {void}
-     */
-    private registerIceGatheringStateChangeListener;
-    /**
-     * Checks if we have the results for all the protocols (UDP and TCP)
-     *
-     * @returns {boolean} true if we have all results, false otherwise
-     */
-    private haveWeGotAllResults;
-    /**
-     * Stores the latency in the result for the given protocol and marks it as reachable
-     *
-     * @param {string} protocol
-     * @param {number} latency
-     * @returns {void}
-     */
-    private storeLatencyResult;
-    /**
-     * Registers a listener for the icecandidate event
-     *
-     * @returns {void}
-     */
-    private registerIceCandidateListener;
-    /**
-     * Starts the process of doing UDP and TCP reachability checks on the media cluster.
-     * XTLS reachability checking is not supported.
-     *
-     * @returns {Promise}
-     */
-    start(): Promise<ClusterReachabilityResult>;
-    /**
-     * Starts the process of gathering ICE candidates
-     *
-     * @returns {Promise} promise that's resolved once reachability checks for this cluster are completed or timeout is reached
-     */
-    private gatherIceCandidates;
-}

package/dist/reachability/index.d.ts

@@ -1,109 +0,0 @@
-/*!
- * Copyright (c) 2015-2020 Cisco Systems, Inc. See LICENSE file.
- */
-import ReachabilityRequest from './request';
-import { ClusterReachability, ClusterReachabilityResult } from './clusterReachability';
-export type ReachabilityMetrics = {
-    reachability_public_udp_success: number;
-    reachability_public_udp_failed: number;
-    reachability_public_tcp_success: number;
-    reachability_public_tcp_failed: number;
-    reachability_public_xtls_success: number;
-    reachability_public_xtls_failed: number;
-    reachability_vmn_udp_success: number;
-    reachability_vmn_udp_failed: number;
-    reachability_vmn_tcp_success: number;
-    reachability_vmn_tcp_failed: number;
-    reachability_vmn_xtls_success: number;
-    reachability_vmn_xtls_failed: number;
-};
-/**
- * This is the type that matches what backend expects us to send to them. It is a bit weird, because
- * it uses strings instead of booleans and numbers, but that's what they require.
- */
-export type TransportResultForBackend = {
-    reachable?: 'true' | 'false';
-    latencyInMilliseconds?: string;
-    clientMediaIPs?: string[];
-    untested?: 'true';
-};
-export type ReachabilityResultForBackend = {
-    udp: TransportResultForBackend;
-    tcp: TransportResultForBackend;
-    xtls: TransportResultForBackend;
-};
-export type ReachabilityResultsForBackend = Record<string, ReachabilityResultForBackend>;
-export type ReachabilityResults = Record<string, ClusterReachabilityResult & {
-    isVideoMesh?: boolean;
-}>;
-/**
- * @class Reachability
- * @export
- */
-export default class Reachability {
-    namespace: string;
-    webex: object;
-    reachabilityRequest: ReachabilityRequest;
-    clusterReachability: {
-        [key: string]: ClusterReachability;
-    };
-    /**
-     * Creates an instance of Reachability.
-     * @param {object} webex
-     * @memberof Reachability
-     */
-    constructor(webex: object);
-    /**
-     * Gets a list of media clusters from the backend and performs reachability checks on all the clusters
-     * @returns {Promise<ReachabilityResults>} reachability results
-     * @public
-     * @memberof Reachability
-     */
-    gatherReachability(): Promise<ReachabilityResults>;
-    /**
-     * Returns statistics about last reachability results. The returned value is an object
-     * with a flat list of properties so that it can be easily sent with metrics
-     *
-     * @returns {Promise} Promise with metrics values, it never rejects/throws.
-     */
-    getReachabilityMetrics(): Promise<ReachabilityMetrics>;
-    /**
-     * Maps our internal transport result to the format that backend expects
-     * @param {TransportResult} transportResult
-     * @returns {TransportResultForBackend}
-     */
-    private mapTransportResultToBackendDataFormat;
-    /**
-     * Reachability results as an object in the format that backend expects
-     *
-     * @returns {any} reachability results that need to be sent to the backend
-     */
-    getReachabilityResults(): Promise<ReachabilityResultsForBackend | undefined>;
-    /**
-     * fetches reachability data and checks for cluster reachability
-     * @returns {boolean}
-     * @public
-     * @memberof Reachability
-     */
-    isAnyPublicClusterReachable(): Promise<boolean>;
-    /**
-     * Get list of all unreachable clusters
-     * @returns {array} Unreachable clusters
-     * @private
-     * @memberof Reachability
-     */
-    private getUnreachableClusters;
-    /**
-     * Make a log of unreachable clusters.
-     * @returns {undefined}
-     * @private
-     * @memberof Reachability
-     */
-    private logUnreachableClusters;
-    /**
-     * Performs reachability checks for all clusters
-     * @param {ClusterList} clusterList
-     * @returns {Promise<ReachabilityResults>} reachability check results
-     */
-    private performReachabilityChecks;
-}

package/dist/reachability/request.d.ts

@@ -1,39 +0,0 @@
-import { IP_VERSION } from '../constants';
-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 {IP_VERSION} ipVersion information about current ip network we're on
-     * @returns {Promise}
-     */
-    getClusters: (ipVersion?: IP_VERSION) => Promise<{
-        clusters: ClusterList;
-        joinCookie: any;
-    }>;
-    /**
-     * gets remote SDP For Clusters
-     * @param {Object} localSDPList localSDPs for the cluster
-     * @returns {Object}
-     */
-    remoteSDPForClusters: (localSDPList: object) => any;
-}
-export default ReachabilityRequest;

package/dist/reachability/util.d.ts

@@ -1,15 +0,0 @@
-/**
- * Converts a stun url to a turn url
- *
- * @param {string} stunUrl url of a stun server
- * @param {'tcp'|'udp'} protocol what protocol to use for the turn server
- * @returns {string} url of a turn server
- */
-export declare function convertStunUrlToTurn(stunUrl: string, protocol: 'udp' | 'tcp'): string;
-/**
- * Converts a stun url to a turns url
- *
- * @param {string} stunUrl url of a stun server
- * @returns {string} url of a turns server
- */
-export declare function convertStunUrlToTurnTls(stunUrl: string): string;

package/dist/reactions/constants.d.ts

@@ -1,3 +0,0 @@
-export declare const REACTION_RELAY_TYPES: {
-    readonly REACTION: "react";
-};

package/dist/reactions/reactions.d.ts

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

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

@@ -1,52 +0,0 @@
-import { REACTION_RELAY_TYPES } from './constants';
-export type EmoticonData = {
-    type: string;
-    codepoints?: string;
-    shortcodes?: string;
-};
-export type SkinTone = EmoticonData;
-export type Reaction = EmoticonData & {
-    tone?: SkinTone;
-};
-export declare enum ReactionServerType {
-    smile = "smile",
-    sad = "sad",
-    wow = "wow",
-    haha = "haha",
-    celebrate = "celebrate",
-    clap = "clap",
-    thumb_up = "thumb_up",
-    thumb_down = "thumb_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"
-}
-export type Sender = {
-    participantId: string;
-};
-export type ProcessedReaction = {
-    reaction: Reaction;
-    sender: {
-        id: Sender['participantId'];
-        name: string;
-    };
-};
-type RelayEventData = {
-    relayType: (typeof REACTION_RELAY_TYPES)['REACTION'];
-    reaction: Reaction;
-    sender: Sender;
-};
-export type RelayEvent = {
-    data: RelayEventData;
-};
-export {};

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

@@ -1,136 +0,0 @@
-/*!
- * Copyright (c) 2015-2020 Cisco Systems, Inc. See LICENSE file.
- */
-import { RECONNECTION_STATE } from '../constants';
-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);
-    /**
-     * @public
-     * @memberof ReconnectionManager
-     * @returns {void}
-     */
-    resetReconnectionTimer(): void;
-    /**
-     * 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;
-    /**
-     * Stop the local share stream.
-     *
-     * @param {string} reason a {@link SHARE_STOPPED_REASON}
-     * @returns {undefined}
-     * @private
-     * @memberof ReconnectionManager
-     */
-    private stopLocalShareStream;
-    /**
-     * @public
-     * @memberof ReconnectionManager
-     * @returns {Boolean} true if reconnection operation is in progress
-     */
-    isReconnectInProgress(): boolean;
-    /**
-     * Sets the reconnection status
-     *
-     * @public
-     * @param {RECONNECTION_STATE} status
-     * @memberof ReconnectionManager
-     * @returns {undefined}
-     */
-    setStatus(status: RECONNECTION_STATE): 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<void>;
-    /**
-     * Attempt to Reconnect Mercury Websocket
-     * @returns {Promise}
-     * @private
-     * @memberof ReconnectionManager
-     */
-    private reconnectMercuryWebSocket;
-}

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

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

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

@@ -1,207 +0,0 @@
-import { SELF_POLICY } from '../constants';
-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 {Object}
-     * @private
-     * @memberof RecordingInfo
-     */
-    private selfUserPolicies;
-    /**
-     * @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
-     * @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 {Object} selfUserPolicies
-     * @returns {void}
-     * @public
-     * @memberof RecordingController
-     */
-    setUserPolicy(selfUserPolicies: Record<SELF_POLICY, boolean>): 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

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