@webex/plugin-meetings 2.59.3 → 2.59.4-next.1

package/dist/metrics/index.d.ts

@@ -1,152 +0,0 @@
-/**
- * @description Metrics handles all the call metrics events
- * @export
- * @class Metrics
- */
-declare class Metrics {
-    static instance: Metrics;
-    _events: any;
-    keys: any;
-    meetingCollection: any;
-    webex: any;
-    /**
-     * Create Metrics Object
-     * @constructor
-     * @public
-     * @memberof Meetings
-     */
-    constructor();
-    /**
-     * Initializes the Metrics singleton with a meeting Collection.
-     *
-     * @param {Object} meetingCollection meetings object
-     * @param {Object} webex  webex SDK object
-     *
-     * @returns {void}
-     */
-    initialSetup(meetingCollection: object, webex: object): void;
-    /**
-     * poste Meeting event metrics
-     * @param {object} options {meetingId/meeting} as a json object
-     * @param {Meeting} options.meeting Meeting object
-     * @param {String} options.meetingId
-     * @param {object} options.data
-     * @param {object} options.event
-     * @returns {object} null
-     */
-    postEvent(options: {
-        meeting?: any;
-        meetingId?: string;
-        data?: object;
-        event?: any;
-    } | any): void;
-    /**
-     *  Docs for Call analyzer metrics
-     *   https://sqbu-github.cisco.com/WebExSquared/call-analyzer/wiki
-     *   https://sqbu-github.cisco.com/WebExSquared/event-dictionary/blob/master/diagnostic-events.raml
-     */
-    initPayload(eventType: any, identifiers: any, options: any): any;
-    /**
-     * get the payload specific for a media quality event through call analyzer
-     * @param {String} eventType the event name
-     * @param {Object} identifiers contains the identifiers needed for CA
-     * @param {String} identifiers.correlationId
-     * @param {String} identifiers.locusUrl
-     * @param {String} identifiers.locusId
-     * @param {Object} options
-     * @param {Object} options.intervalData
-     * @param {String} options.clientType
-     * @returns {Object}
-     * @public
-     * @memberof Metrics
-     */
-    initMediaPayload(eventType: string, identifiers: {
-        correlationId: string;
-        locusUrl: string;
-        locusId: string;
-    }, options?: {
-        intervalData: object;
-        clientType: string;
-    } | any): {
-        eventId: any;
-        version: number;
-        origin: {
-            audioSetupDelay: any;
-            videoSetupDelay: any;
-            name: string;
-            networkType: any;
-            userAgent: string;
-            clientInfo: {
-                clientType: any;
-                clientVersion: string;
-                localNetworkPrefix: string;
-                os: any;
-                osVersion: any;
-                subClientType: any;
-                browser: any;
-                browserVersion: any;
-            };
-        };
-        originTime: {
-            triggered: string;
-        };
-        senderCountryCode: any;
-        event: {
-            name: string;
-            canProceed: boolean;
-            identifiers: {
-                correlationId: string;
-                locusUrl: string;
-                locusId: string;
-            };
-            intervals: any[];
-            joinTimes: any;
-            eventData: {
-                webClientDomain: any;
-            };
-            sourceMetadata: {
-                applicationSoftwareType: string;
-                applicationSoftwareVersion: any;
-                mediaEngineSoftwareType: any;
-                mediaEngineSoftwareVersion: any;
-                startTime: string;
-            };
-        };
-    };
-    /**
-     * This function Parses a Locus error and returns a diagnostic event payload.
-     * It should keep updating from:
-     * https://sqbu-github.cisco.com/WebExSquared/spark-client-framework/blob/master/spark-client-framework/Adapters/TelephonyAdapter/TelephonyAdapter.cpp#L920
-     *
-     * @param {Object} err the error Object from Locus response
-     * @param {boolean} showToUser true if a toast is shown to user
-     * @returns {{showToUser: boolean, category: string, errorDescription: string,
-     *  errorCode: number, errorData: *, fatal: boolean, name: string}}
-     */
-    parseLocusError(err: any, showToUser: boolean): any;
-    generateErrorPayload(errorCode: any, shownToUser: any, name: any, err: any): any;
-    /**
-     * Returns a formated string of the user agent.
-     *
-     * @returns {string} formatted user agent information
-     */
-    userAgentToString(): string;
-    /**
-     * Uploads given metric to the Metrics service as an Behavioral metric.
-     * Metadata about the environment such as browser, OS, SDK and their versions
-     * are automatically added when the metric is sent.
-     *
-     * The Metrics service will send an Behavioral metric to InfluxDB for
-     * aggregation.
-     * See https://confluence-eng-gpk2.cisco.com/conf/display/WBXT/Getting+started+with+Metrics+Service.
-     *
-     * @param {string} metricName  Name of the metric (measurement) to send
-     * @param {Object} metricFields  Key-valye pairs of data or values about this metric
-     * @param {Object} metricTags  Key-value pairs of metric metadata
-     *
-     * @returns {void}
-     */
-    sendBehavioralMetric(metricName: string, metricFields?: object, metricTags?: object): void;
-}
-declare const instance: Metrics;
-export default instance;

package/dist/networkQualityMonitor/index.d.ts

@@ -1,70 +0,0 @@
-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

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

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

@@ -1,6 +0,0 @@
-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

@@ -1,47 +0,0 @@
-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

@@ -1,14 +0,0 @@
-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

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

package/dist/reachability/index.d.ts

@@ -1,139 +0,0 @@
-/*!
- * 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

@@ -1,35 +0,0 @@
-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

@@ -1,4 +0,0 @@
-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

@@ -1,32 +0,0 @@
-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

@@ -1,112 +0,0 @@
-/*!
- * 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

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