@webex/plugin-meetings 3.0.0-beta.28 → 3.0.0-beta.280

package/dist/types/reachability/index.d.ts

@@ -1,6 +1,39 @@
 /*!
  * Copyright (c) 2015-2020 Cisco Systems, Inc. See LICENSE file.
  */
+export type ReachabilityMetrics = {
+    reachability_public_udp_success: number;
+    reachability_public_udp_failed: number;
+    reachability_public_tcp_success: number;
+    reachability_public_tcp_failed: number;
+    reachability_vmn_udp_success: number;
+    reachability_vmn_udp_failed: number;
+    reachability_vmn_tcp_success: number;
+    reachability_vmn_tcp_failed: number;
+};
+export type TransportResult = {
+    reachable?: 'true' | 'false';
+    latencyInMilliseconds?: string;
+    clientMediaIPs?: string[];
+    untested?: 'true';
+};
+type ReachabilityResult = {
+    udp: TransportResult;
+    tcp: TransportResult;
+    xtls: {
+        untested: 'true';
+    };
+};
+export type ReachabilityResults = Record<string, ReachabilityResult>;
+type InternalReachabilityResults = Record<string, ReachabilityResult & {
+    isVideoMesh?: boolean;
+}>;
+export type ICECandidateResult = {
+    clusterId: string;
+    isVideoMesh: boolean;
+    elapsed?: string | null;
+    publicIPs?: string[];
+};
 /**
  * @class Reachability
  * @export
@@ -23,14 +56,27 @@ export default class Reachability {
      * @async
      * @memberof Reachability
      */
-    gatherReachability(): Promise<unknown>;
+    gatherReachability(): Promise<InternalReachabilityResults>;
+    /**
+     * 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>;
+    /**
+     * 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<ReachabilityResults | undefined>;
     /**
      * fetches reachability data and checks for cluster reachability
      * @returns {boolean}
      * @public
      * @memberof Reachability
      */
-    isAnyClusterReachable(): Promise<boolean>;
+    isAnyPublicClusterReachable(): Promise<boolean>;
     /**
      * Generate peerConnection config settings
      * @param {object} cluster
@@ -94,7 +140,7 @@ export default class Reachability {
      * speed.
      * @private
      * @param {RTCPeerConnection} peerConnection
-     * @param {number} timeout
+     * @param {boolean} isVideoMesh
      * @returns {Promise}
      */
     private iceGatheringState;
@@ -107,20 +153,27 @@ export default class Reachability {
     private logUnreachableClusters;
     /**
      * Calculates time to establish connection
-     * @param {array} iceResults iceResults
+     * @param {Array<ICECandidateResult>} iceResults iceResults
      * @returns {object} reachabilityMap
-     * @private
+     * @protected
      * @memberof Reachability
      */
-    private parseIceResultsToReachabilityResults;
+    protected parseIceResultsToInternalReachabilityResults(iceResults: Array<ICECandidateResult>): InternalReachabilityResults;
     /**
      * fetches reachability data
      * @param {object} clusterList
-     * @returns {Promise<localSDPData>} reachability check results
+     * @returns {Promise<InternalReachabilityResults>} reachability check results
      * @private
      * @memberof Reachability
      */
     private performReachabilityCheck;
+    /**
+     * Adds public IP (client media IPs)
+     * @param {RTCPeerConnection} peerConnection
+     * @param {string} publicIP
+     * @returns {void}
+     */
+    protected addPublicIP(peerConnection: RTCPeerConnection, publicIP?: string | null): void;
     /**
      * Records latency and closes the peerConnection
      * @param {RTCPeerConnection} peerConnection
@@ -138,3 +191,4 @@ export default class Reachability {
      */
     private setup;
 }
+export {};

package/dist/types/reachability/request.d.ts

@@ -1,3 +1,4 @@
+import { IP_VERSION } from '../constants';
 export interface ClusterNode {
     isVideoMesh: boolean;
     udp: Array<string>;
@@ -19,12 +20,15 @@ declare class ReachabilityRequest {
      */
     constructor(webex: object);
     /**
-     * gets the cluster information
+     * Gets the cluster information
      *
-     * @param {boolean} includeVideoMesh whether to include the video mesh clusters in the result or not
+     * @param {IP_VERSION} ipVersion information about current ip network we're on
      * @returns {Promise}
      */
-    getClusters: () => Promise<ClusterList>;
+    getClusters: (ipVersion?: IP_VERSION) => Promise<{
+        clusters: ClusterList;
+        joinCookie: any;
+    }>;
     /**
      * gets remote SDP For Clusters
      * @param {Object} localSDPList localSDPs for the cluster

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

@@ -58,6 +58,15 @@ export default class ReconnectionManager {
      * @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

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

@@ -1,3 +1,4 @@
+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
@@ -20,6 +21,13 @@ export default class RecordingController {
      * @memberof RecordingInfo
      */
     private displayHints;
+    /**
+     * @instance
+     * @type {Object}
+     * @private
+     * @memberof RecordingInfo
+     */
+    private selfUserPolicies;
     /**
      * @instance
      * @type {string}
@@ -62,7 +70,6 @@ export default class RecordingController {
     });
     /**
      * @param {MeetingRequest} request
-     * @param {LocusInfo} info
      * @returns {void}
      * @private
      * @memberof RecordingController
@@ -94,6 +101,13 @@ export default class RecordingController {
      * @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}

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

@@ -1,9 +1,10 @@
+import { SELF_POLICY } from '../constants';
 import RecordingAction from './enums';
 declare const _default: {
-    canUserStart: (displayHints: string[]) => boolean;
-    canUserPause: (displayHints: string[]) => boolean;
-    canUserResume: (displayHints: string[]) => boolean;
-    canUserStop: (displayHints: string[]) => boolean;
+    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;

package/dist/types/roap/request.d.ts

@@ -1,14 +1,19 @@
 import { StatelessWebexPlugin } from '@webex/webex-core';
+import { IP_VERSION } from '../constants';
+import { LocusMediaRequest } from '../meeting/locusMediaRequest';
 /**
  * @class RoapRequest
  */
 export default class RoapRequest extends StatelessWebexPlugin {
     /**
-     * Joins a meeting via ROAP
+     * Returns reachability data.
      * @param {Object} localSdp
-     * @returns {Promise} returns a promise that resolves/rejects whatever the request does
+     * @returns {Object}
      */
-    attachRechabilityData(localSdp: any): Promise<any>;
+    attachReachabilityData(localSdp: any): Promise<{
+        localSdp: any;
+        joinCookie: any;
+    }>;
     /**
      * Sends a ROAP message
      * @param {Object} options
@@ -16,20 +21,19 @@ export default class RoapRequest extends StatelessWebexPlugin {
      * @param {String} options.locusSelfUrl
      * @param {String} options.mediaId
      * @param {String} options.correlationId
-     * @param {Boolean} options.audioMuted
-     * @param {Boolean} options.videoMuted
      * @param {String} options.meetingId
-     * @param {Boolean} options.preferTranscoding
+     * @param {IP_VERSION} options.ipVersion only required for offers
      * @returns {Promise} returns the response/failure of the request
      */
     sendRoap(options: {
         roapMessage: any;
         locusSelfUrl: string;
         mediaId: string;
-        correlationId: string;
-        audioMuted: boolean;
-        videoMuted: boolean;
         meetingId: string;
-        preferTranscoding?: boolean;
-    }): Promise<any>;
+        ipVersion?: IP_VERSION;
+        locusMediaRequest?: LocusMediaRequest;
+    }): Promise<{
+        mediaConnections: any;
+        locus: any;
+    }>;
 }

package/dist/types/roap/turnDiscovery.d.ts

@@ -49,7 +49,24 @@ export default class TurnDiscovery {
      * @param {Meeting} meeting
      * @returns {Promise}
      */
-    sendRoapOK(meeting: Meeting): Promise<any>;
+    sendRoapOK(meeting: Meeting): Promise<{
+        mediaConnections: any;
+        locus: any;
+    }>;
+    /**
+     * Gets the reason why reachability is skipped.
+     *
+     * @param {Meeting} meeting
+     * @returns {Promise<string>} Promise with empty string if reachability is not skipped or a reason if it is skipped
+     */
+    private getSkipReason;
+    /**
+     * Checks if TURN discovery is skipped.
+     *
+     * @param {Meeting} meeting
+     * @returns {Boolean} true if TURN discovery is being skipped, false if it is being done
+     */
+    isSkipped(meeting: any): Promise<boolean>;
     /**
      * Retrieves TURN server information from the backend by doing
      * a roap message exchange:

package/dist/types/rtcMetrics/constants.d.ts

@@ -0,0 +1,4 @@
+declare const RTC_METRICS: {
+    APP_ID: string;
+};
+export { RTC_METRICS as default };

package/dist/types/rtcMetrics/index.d.ts

@@ -0,0 +1,47 @@
+/**
+ * Rtc Metrics
+ */
+export default class RtcMetrics {
+    /**
+     * Array of MetricData items to be sent to the metrics service.
+     */
+    metricsQueue: any[];
+    intervalId: number;
+    webex: any;
+    meetingId: string;
+    correlationId: string;
+    /**
+     * Initialize the interval.
+     *
+     * @param {object} webex - The main `webex` object.
+     * @param {string} meetingId - The meeting id.
+     * @param {string} correlationId - The correlation id.
+     */
+    constructor(webex: any, meetingId: any, correlationId: any);
+    /**
+     * Check to see if the metrics queue has any items.
+     *
+     * @returns {void}
+     */
+    private checkMetrics;
+    /**
+     * Add metrics items to the metrics queue.
+     *
+     * @param {object} data - An object with a payload array of metrics items.
+     *
+     * @returns {void}
+     */
+    addMetrics(data: any): void;
+    /**
+     * Clear the metrics interval.
+     *
+     * @returns {void}
+     */
+    closeMetrics(): void;
+    /**
+     * Send metrics to the metrics service.
+     *
+     * @returns {void}
+     */
+    private sendMetrics;
+}

package/dist/types/statsAnalyzer/index.d.ts

@@ -1,5 +1,6 @@
 /// <reference types="node" />
 import EventsScope from '../common/events/events-scope';
+import { ReceiveSlot } from '../multistream/receiveSlot';
 export declare const EVENTS: {
     MEDIA_QUALITY: string;
     LOCAL_MEDIA_STARTED: string;
@@ -7,6 +8,7 @@ export declare const EVENTS: {
     REMOTE_MEDIA_STARTED: string;
     REMOTE_MEDIA_STOPPED: string;
 };
+type ReceiveSlotCallback = (csi: number) => ReceiveSlot | undefined;
 /**
  * Stats Analyzer class that will emit events based on detected quality
  *
@@ -28,15 +30,17 @@ export declare class StatsAnalyzer extends EventsScope {
     statsInterval: NodeJS.Timeout;
     statsResults: any;
     statsStarted: any;
+    receiveSlotCallback: ReceiveSlotCallback;
     /**
      * Creates a new instance of StatsAnalyzer
      * @constructor
      * @public
      * @param {Object} config SDK Configuration Object
+     * @param {Function} receiveSlotCallback Callback used to access receive slots.
      * @param {Object} networkQualityMonitor class for assessing network characteristics (jitter, packetLoss, latency)
      * @param {Object} statsResults Default properties for stats
      */
-    constructor(config: any, networkQualityMonitor?: object, statsResults?: object);
+    constructor(config: any, receiveSlotCallback?: ReceiveSlotCallback, networkQualityMonitor?: object, statsResults?: object);
     /**
      * Resets cumulative stats arrays.
      *
@@ -193,3 +197,4 @@ export declare class StatsAnalyzer extends EventsScope {
      */
     compareSentAndReceived(result: any, type: any): void;
 }
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@webex/plugin-meetings",
-  "version": "3.0.0-beta.28",
+  "version": "3.0.0-beta.280",
   "description": "",
   "license": "Cisco EULA (https://www.cisco.com/c/en/us/products/end-user-license-agreement.html)",
   "contributors": [
@@ -32,31 +32,33 @@
     "build": "yarn run -T tsc --declaration true --declarationDir ./dist/types"
   },
   "devDependencies": {
-    "@webex/plugin-meetings": "3.0.0-beta.28",
-    "@webex/test-helper-chai": "3.0.0-beta.28",
-    "@webex/test-helper-mocha": "3.0.0-beta.28",
-    "@webex/test-helper-mock-webex": "3.0.0-beta.28",
-    "@webex/test-helper-retry": "3.0.0-beta.28",
-    "@webex/test-helper-test-users": "3.0.0-beta.28",
+    "@webex/plugin-meetings": "3.0.0-beta.280",
+    "@webex/test-helper-chai": "3.0.0-beta.280",
+    "@webex/test-helper-mocha": "3.0.0-beta.280",
+    "@webex/test-helper-mock-webex": "3.0.0-beta.280",
+    "@webex/test-helper-retry": "3.0.0-beta.280",
+    "@webex/test-helper-test-users": "3.0.0-beta.280",
     "chai": "^4.3.4",
     "chai-as-promised": "^7.1.1",
     "jsdom-global": "3.0.2",
     "sinon": "^9.2.4",
-    "typed-emitter": "^2.1.0"
+    "typed-emitter": "^2.1.0",
+    "typescript": "^4.7.4"
   },
   "dependencies": {
-    "@webex/common": "3.0.0-beta.28",
-    "@webex/internal-media-core": "1.33.2",
-    "@webex/internal-plugin-conversation": "3.0.0-beta.28",
-    "@webex/internal-plugin-device": "3.0.0-beta.28",
-    "@webex/internal-plugin-llm": "3.0.0-beta.28",
-    "@webex/internal-plugin-mercury": "3.0.0-beta.28",
-    "@webex/internal-plugin-metrics": "3.0.0-beta.28",
-    "@webex/internal-plugin-support": "3.0.0-beta.28",
-    "@webex/internal-plugin-user": "3.0.0-beta.28",
-    "@webex/plugin-people": "3.0.0-beta.28",
-    "@webex/plugin-rooms": "3.0.0-beta.28",
-    "@webex/webex-core": "3.0.0-beta.28",
+    "@webex/common": "3.0.0-beta.280",
+    "@webex/internal-media-core": "2.0.6",
+    "@webex/internal-plugin-conversation": "3.0.0-beta.280",
+    "@webex/internal-plugin-device": "3.0.0-beta.280",
+    "@webex/internal-plugin-llm": "3.0.0-beta.280",
+    "@webex/internal-plugin-mercury": "3.0.0-beta.280",
+    "@webex/internal-plugin-metrics": "3.0.0-beta.280",
+    "@webex/internal-plugin-support": "3.0.0-beta.280",
+    "@webex/internal-plugin-user": "3.0.0-beta.280",
+    "@webex/media-helpers": "3.0.0-beta.280",
+    "@webex/plugin-people": "3.0.0-beta.280",
+    "@webex/plugin-rooms": "3.0.0-beta.280",
+    "@webex/webex-core": "3.0.0-beta.280",
     "ampersand-collection": "^2.0.2",
     "bowser": "^2.11.0",
     "btoa": "^1.2.1",
@@ -64,6 +66,7 @@
     "global": "^4.4.0",
     "ip-anonymize": "^0.1.0",
     "javascript-state-machine": "^3.1.0",
+    "jsonwebtoken": "^8.5.1",
     "lodash": "^4.17.21",
     "sdp-transform": "^2.12.0",
     "uuid": "^3.3.2",

package/src/annotation/annotation.types.ts

@@ -0,0 +1,50 @@
+import {ANNOTATION_POLICY} from './constants';
+
+/**
+ * Type for an StrokeData Object
+ */
+type StrokeData = {
+  deviceId: string;
+  toUserId: string;
+  requesterId: string;
+  content: string;
+  shareInstanceId: string;
+  encryptionKeyUrl: string;
+  version: string;
+};
+
+type RequestData = {
+  toUserId: string;
+  toDeviceUrl: string;
+  shareInstanceId: string;
+};
+
+type CommandRequestBody = {
+  actionType: string;
+  resourceType: string;
+  shareInstanceId: string;
+  receivers?: any[];
+};
+/**
+ * Type for an annotation Object include annotation version and privilege
+ */
+type AnnotationInfo = {
+  version: string;
+  policy: ANNOTATION_POLICY;
+};
+
+interface IAnnotationChannel {
+  // === below is for presenter
+  acceptRequest: (approval) => undefined | Promise<void>;
+  declineRequest: (approval) => undefined | Promise<void>;
+  closeAnnotation: (requestData: RequestData) => undefined | Promise<void>;
+  // === below is for attendee
+  approveAnnotation: (requestData: RequestData) => undefined | Promise<void>;
+  cancelApproveAnnotation: (requestData: RequestData, approval) => undefined | Promise<void>;
+  sendStrokeData: (strokeData: StrokeData) => void;
+  // =====
+  approvalUrlUpdate: (approvalUrl: string) => void;
+  locusUrlUpdate: (locusUrl: string) => void;
+}
+
+export type {StrokeData, RequestData, CommandRequestBody, IAnnotationChannel, AnnotationInfo};

package/src/annotation/constants.ts

@@ -0,0 +1,36 @@
+export const EVENT_TRIGGERS = {
+  ANNOTATION_STROKE_DATA: 'annotation:strokeData',
+  ANNOTATION_COMMAND: 'annotation:command',
+};
+export const ANNOTATION_RESOURCE_TYPE = 'AnnotationOnShare';
+export const ANNOTATION_RELAY_TYPES = {
+  ANNOTATION_CLIENT: 'annotation.client',
+};
+
+export const ANNOTATION_STATUS = {
+  NO_ANNOTATION: 'NO_ANNOTATION',
+  RUNNING_ANNOTATION: 'RUNNING_ANNOTATION',
+};
+
+export enum ANNOTATION_POLICY {
+  ANYONE_CAN_ANNOTATE = 'AnyoneCanAnnotate',
+  APPROVAL = 'Approval',
+  ANNOTATION_NOT_ALLOWED = 'AnnotationNotAllowed',
+}
+
+export const ANNOTATION_REQUEST_TYPE = {
+  ANNOTATION_MESSAGE: 'annotation_message',
+};
+
+export const enum ANNOTATION_ACTION_TYPE {
+  REQUESTED = 'REQUESTED',
+  ACCEPTED = 'ACCEPTED',
+  DECLINED = 'DECLINED',
+  OFFERED = 'OFFERED',
+  CANCELED = 'CANCELED',
+  EXPIRED = 'EXPIRED',
+  REVOKED = 'REVOKED',
+  CLOSED = 'CLOSED',
+}
+
+export const ANNOTATION = 'annotation';