@webex/plugin-meetings 3.7.0-wxcc.1 → 3.8.0

package/dist/roap/index.d.ts

@@ -0,0 +1,86 @@
+import { StatelessWebexPlugin } from '@webex/webex-core';
+import TurnDiscovery, { TurnDiscoveryResult } from './turnDiscovery';
+import Meeting from '../meeting';
+export { type TurnDiscoveryResult, type TurnServerInfo, type TurnDiscoverySkipReason, } from './turnDiscovery';
+/**
+ * Roap options
+ * @typedef {Object} RoapOptions
+ * @property {String} sdp
+ * @property {Meeting} meeting
+ * @property {Number} seq
+ * @property {Number} tieBreaker
+ *  @property {Boolean} reconnect
+ */
+/**
+ * @typedef {Object} SeqOptions
+ * @property {String} correlationId
+ * @property {String} mediaId
+ * @property {Number} seq
+ */
+/**
+ * @class Roap
+ * @export
+ * @private
+ */
+export default class Roap extends StatelessWebexPlugin {
+    attrs: any;
+    lastRoapOffer: any;
+    options: any;
+    roapHandler: any;
+    roapRequest: any;
+    turnDiscovery: TurnDiscovery;
+    /**
+     *
+     * @param {Object} attrs
+     * @param {Object} options
+     */
+    constructor(attrs: any, options: any);
+    /**
+     *
+     * @param {SeqOptions} options
+     * @returns {null}
+     * @memberof Roap
+     */
+    sendRoapOK(options: any): Promise<any>;
+    /**
+     * Sends a ROAP answer...
+     * @param {SeqOptions} options
+     * @param {Boolean} options.audioMuted
+     * @param {Boolean} options.videoMuted
+     * @returns {Promise}
+     * @memberof Roap
+     */
+    sendRoapAnswer(options: any): any;
+    /**
+     * Sends a ROAP error...
+     * @param {Object} options
+     * @returns {Promise}
+     * @memberof Roap
+     */
+    sendRoapError(options: any): any;
+    /**
+     * sends a roap media request
+     * @param {RoapOptions} options
+     * @returns {Promise}
+     * @memberof Roap
+     */
+    sendRoapMediaRequest(options: any): any;
+    /**
+     * Performs a TURN server discovery procedure, which involves exchanging
+     * some roap messages with the server. This exchange has to be done before
+     * any other roap messages are sent
+     *
+     * @param {Meeting} meeting
+     * @param {Boolean} isReconnecting should be set to true if this is a new
+     *                                 media connection just after a reconnection
+     * @param {Boolean} [isForced]
+     * @returns {Promise}
+     */
+    doTurnDiscovery(meeting: Meeting, isReconnecting: boolean, isForced?: boolean): Promise<TurnDiscoveryResult>;
+    generateTurnDiscoveryRequestMessage(meeting: Meeting, isForced: boolean): Promise<{
+        roapMessage?: object;
+        turnDiscoverySkippedReason: string;
+    }>;
+    handleTurnDiscoveryHttpResponse(meeting: Meeting, httpResponse: object): Promise<TurnDiscoveryResult>;
+    abortTurnDiscovery(): void;
+}

package/dist/roap/request.d.ts

@@ -0,0 +1,39 @@
+import { StatelessWebexPlugin } from '@webex/webex-core';
+import { IP_VERSION } from '../constants';
+import { LocusMediaRequest } from '../meeting/locusMediaRequest';
+/**
+ * @class RoapRequest
+ */
+export default class RoapRequest extends StatelessWebexPlugin {
+    /**
+     * Returns reachability data.
+     * @param {Object} localSdp
+     * @returns {Object}
+     */
+    attachReachabilityData(localSdp: any): Promise<{
+        localSdp: any;
+        joinCookie: any;
+    }>;
+    /**
+     * Sends a ROAP message
+     * @param {Object} options
+     * @param {Object} options.roapMessage
+     * @param {String} options.locusSelfUrl
+     * @param {String} options.mediaId
+     * @param {String} options.correlationId
+     * @param {String} options.meetingId
+     * @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;
+        meetingId: string;
+        ipVersion?: IP_VERSION;
+        locusMediaRequest?: LocusMediaRequest;
+    }): Promise<{
+        mediaConnections: any;
+        locus: any;
+    }>;
+}

package/dist/roap/state.js

@@ -0,0 +1,126 @@
+"use strict";
+
+var _Object$defineProperty = require("@babel/runtime-corejs2/core-js/object/define-property");
+var _interopRequireDefault = require("@babel/runtime-corejs2/helpers/interopRequireDefault");
+_Object$defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _javascriptStateMachine = _interopRequireDefault(require("javascript-state-machine"));
+var _loggerProxy = _interopRequireDefault(require("../common/logs/logger-proxy"));
+var _constants = require("../constants");
+var shouldStep = function shouldStep(roap, meeting) {
+  var messageType = roap.msg.messageType;
+  if (meeting) {
+    if (messageType === _constants._OFFER_ && roap.remote && meeting.shareStatus === _constants._REQUESTED_) {
+      // The peer-connection is waiting for answer but got an offer Reset. Try to
+      // send the offer later after you accept the answer
+      return false;
+    }
+    // Assuming the mercury event has come first before the response for the event
+    // we have to wait for the response and trigger the ROAP request later on
+    if (!meeting.mediaProperties.peerConnection && messageType === _constants._ANSWER_) {
+      return false;
+    }
+  }
+  _loggerProxy.default.logger.log('Roap:state#shouldStep --> RoapStateMachine: PeerConnectionState, ', meeting.mediaProperties.peerConnection.signalingState);
+  _loggerProxy.default.logger.log('Roap:state#shouldStep --> RoapStateMachine: success save proceeding with transition, ', roap.msg);
+  return true;
+};
+var handleTransition = function handleTransition(value, signal, meeting) {
+  _loggerProxy.default.logger.log("Roap:state#handleTransition --> current ".concat(value, " to ").concat(signal));
+  switch (value) {
+    case _constants.ROAP.ROAP_STATE.INIT:
+      if (signal === _constants.ROAP.ROAP_SIGNAL.RX_OFFER) {
+        return _constants.ROAP.ROAP_STATE.WAIT_TX_ANSWER;
+      }
+      if (signal === _constants.ROAP.ROAP_SIGNAL.TX_OFFER) {
+        return _constants.ROAP.ROAP_STATE.WAIT_RX_ANSWER;
+      }
+      return value;
+    case _constants.ROAP.ROAP_STATE.WAIT_RX_OFFER:
+      return value;
+    case _constants.ROAP.ROAP_STATE.WAIT_RX_ANSWER:
+      if (signal === _constants.ROAP.ROAP_SIGNAL.RX_ANSWER) {
+        // There is a race condition where the /call response comes after mercury event from the server
+        // As mercury sends roap event if it didnt get back a response. We can send the roap ok after that
+        if (meeting.mediaId) {
+          return _constants.ROAP.ROAP_STATE.WAIT_TX_OK;
+        }
+        _loggerProxy.default.logger.error('Roap:state#handleTransition --> Race Condition no mediaId, continuing.');
+        return value;
+      }
+      if (signal === _constants.ROAP.ROAP_SIGNAL.RX_OFFER) {
+        return _constants.ROAP.ROAP_STATE.GLARE;
+      }
+      return value;
+    case _constants.ROAP.ROAP_STATE.WAIT_TX_OFFER:
+      return value;
+    case _constants.ROAP.ROAP_STATE.WAIT_TX_ANSWER:
+      if (signal === _constants.ROAP.ROAP_SIGNAL.TX_ANSWER) {
+        return _constants.ROAP.ROAP_STATE.WAIT_RX_OK;
+      }
+      return value;
+    case _constants.ROAP.ROAP_STATE.WAIT_TX_OK:
+      if (signal === _constants.ROAP.ROAP_SIGNAL.TX_OK) {
+        return _constants.ROAP.ROAP_STATE.INIT;
+      }
+      return value;
+    case _constants.ROAP.ROAP_STATE.WAIT_RX_OK:
+      if (signal === _constants.ROAP.ROAP_SIGNAL.RX_OK) {
+        return _constants.ROAP.ROAP_STATE.INIT;
+      }
+      return value;
+    case _constants.ROAP.ROAP_STATE.ERROR:
+      // eslint-disable-next-line no-warning-comments
+      // TODO: resolve error state. Add a signal constant and handle the cleanup
+      return _constants.ROAP.ROAP_STATE.INIT;
+    case _constants.ROAP.ROAP_STATE.GLARE:
+      return _constants.ROAP.ROAP_STATE.WAIT_RX_ANSWER;
+    default:
+      return value;
+  }
+};
+var RoapStateMachine = {
+  /**
+   * @param {Roap} roapRef
+   * initializes the state machine
+   * @returns {StateMachine} an instance of a state machine
+   */
+  createState: function createState() {
+    var RoapState = _javascriptStateMachine.default.factory({
+      init: _constants.ROAP.ROAP_STATE.INIT,
+      transitions: [{
+        name: _constants.ROAP.ROAP_TRANSITIONS.STEP,
+        from: '*',
+        /**
+         * Method to handle the transitions between states
+         * @param {String} signal
+         * @param {Meeting} meeting instance of a Meeting
+         * @param {Object} roap
+         * @returns {String} new state value
+         */
+        to: function to(signal, meeting, roap) {
+          var value = this.state;
+          if (!shouldStep(roap, meeting)) {
+            return value;
+          }
+          return handleTransition(value, signal, meeting);
+        }
+      }],
+      methods: {
+        /**
+         * Event that fires after we've transitioned to a new state
+         * @param {Object} transition
+         * @returns {null}
+         */
+        onAfterStep: function onAfterStep(transition) {
+          _loggerProxy.default.logger.log("Roap:state#onAfterStep --> RoapStateMachine->onAfterStep#fired! State changed from '".concat(transition.from, "' to '").concat(transition.to, "' with transition '").concat(transition.transition, "''."));
+        }
+      }
+    });
+    return new RoapState();
+  }
+};
+var _default = exports.default = RoapStateMachine;
+//# sourceMappingURL=state.js.map

package/dist/roap/state.js.map

@@ -0,0 +1 @@
+{"version":3,"names":["_javascriptStateMachine","_interopRequireDefault","require","_loggerProxy","_constants","shouldStep","roap","meeting","messageType","msg","_OFFER_","remote","shareStatus","_REQUESTED_","mediaProperties","peerConnection","_ANSWER_","LoggerProxy","logger","log","signalingState","handleTransition","value","signal","concat","ROAP","ROAP_STATE","INIT","ROAP_SIGNAL","RX_OFFER","WAIT_TX_ANSWER","TX_OFFER","WAIT_RX_ANSWER","WAIT_RX_OFFER","RX_ANSWER","mediaId","WAIT_TX_OK","error","GLARE","WAIT_TX_OFFER","TX_ANSWER","WAIT_RX_OK","TX_OK","RX_OK","ERROR","RoapStateMachine","createState","RoapState","StateMachine","factory","init","transitions","name","ROAP_TRANSITIONS","STEP","from","to","state","methods","onAfterStep","transition","_default","exports","default"],"sources":["state.ts"],"sourcesContent":["import StateMachine from 'javascript-state-machine';\n\nimport LoggerProxy from '../common/logs/logger-proxy';\nimport {ROAP, _OFFER_, _ANSWER_, _REQUESTED_} from '../constants';\nimport Meeting from '../meeting';\n\nconst shouldStep = (roap, meeting) => {\n  const {messageType} = roap.msg;\n\n  if (meeting) {\n    if (messageType === _OFFER_ && roap.remote && meeting.shareStatus === _REQUESTED_) {\n      // The peer-connection is waiting for answer but got an offer Reset. Try to\n      // send the offer later after you accept the answer\n      return false;\n    }\n    // Assuming the mercury event has come first before the response for the event\n    // we have to wait for the response and trigger the ROAP request later on\n    if (!meeting.mediaProperties.peerConnection && messageType === _ANSWER_) {\n      return false;\n    }\n  }\n  LoggerProxy.logger.log(\n    'Roap:state#shouldStep --> RoapStateMachine: PeerConnectionState, ',\n    meeting.mediaProperties.peerConnection.signalingState\n  );\n  LoggerProxy.logger.log(\n    'Roap:state#shouldStep --> RoapStateMachine: success save proceeding with transition, ',\n    roap.msg\n  );\n\n  return true;\n};\n\nconst handleTransition = (value, signal, meeting) => {\n  LoggerProxy.logger.log(`Roap:state#handleTransition --> current ${value} to ${signal}`);\n\n  switch (value) {\n    case ROAP.ROAP_STATE.INIT:\n      if (signal === ROAP.ROAP_SIGNAL.RX_OFFER) {\n        return ROAP.ROAP_STATE.WAIT_TX_ANSWER;\n      }\n      if (signal === ROAP.ROAP_SIGNAL.TX_OFFER) {\n        return ROAP.ROAP_STATE.WAIT_RX_ANSWER;\n      }\n\n      return value;\n\n    case ROAP.ROAP_STATE.WAIT_RX_OFFER:\n      return value;\n\n    case ROAP.ROAP_STATE.WAIT_RX_ANSWER:\n      if (signal === ROAP.ROAP_SIGNAL.RX_ANSWER) {\n        // There is a race condition where the /call response comes after mercury event from the server\n        // As mercury sends roap event if it didnt get back a response. We can send the roap ok after that\n        if (meeting.mediaId) {\n          return ROAP.ROAP_STATE.WAIT_TX_OK;\n        }\n        LoggerProxy.logger.error(\n          'Roap:state#handleTransition --> Race Condition no mediaId, continuing.'\n        );\n\n        return value;\n      }\n\n      if (signal === ROAP.ROAP_SIGNAL.RX_OFFER) {\n        return ROAP.ROAP_STATE.GLARE;\n      }\n\n      return value;\n\n    case ROAP.ROAP_STATE.WAIT_TX_OFFER:\n      return value;\n\n    case ROAP.ROAP_STATE.WAIT_TX_ANSWER:\n      if (signal === ROAP.ROAP_SIGNAL.TX_ANSWER) {\n        return ROAP.ROAP_STATE.WAIT_RX_OK;\n      }\n\n      return value;\n\n    case ROAP.ROAP_STATE.WAIT_TX_OK:\n      if (signal === ROAP.ROAP_SIGNAL.TX_OK) {\n        return ROAP.ROAP_STATE.INIT;\n      }\n\n      return value;\n\n    case ROAP.ROAP_STATE.WAIT_RX_OK:\n      if (signal === ROAP.ROAP_SIGNAL.RX_OK) {\n        return ROAP.ROAP_STATE.INIT;\n      }\n\n      return value;\n\n    case ROAP.ROAP_STATE.ERROR:\n      // eslint-disable-next-line no-warning-comments\n      // TODO: resolve error state. Add a signal constant and handle the cleanup\n      return ROAP.ROAP_STATE.INIT;\n\n    case ROAP.ROAP_STATE.GLARE:\n      return ROAP.ROAP_STATE.WAIT_RX_ANSWER;\n    default:\n      return value;\n  }\n};\n\nconst RoapStateMachine = {\n  /**\n   * @param {Roap} roapRef\n   * initializes the state machine\n   * @returns {StateMachine} an instance of a state machine\n   */\n  createState() {\n    const RoapState = StateMachine.factory({\n      init: ROAP.ROAP_STATE.INIT,\n      transitions: [\n        {\n          name: ROAP.ROAP_TRANSITIONS.STEP,\n          from: '*',\n          /**\n           * Method to handle the transitions between states\n           * @param {String} signal\n           * @param {Meeting} meeting instance of a Meeting\n           * @param {Object} roap\n           * @returns {String} new state value\n           */\n          to(signal: string, meeting: Meeting, roap: object) {\n            const value = this.state;\n\n            if (!shouldStep(roap, meeting)) {\n              return value;\n            }\n\n            return handleTransition(value, signal, meeting);\n          },\n        },\n      ],\n      methods: {\n        /**\n         * Event that fires after we've transitioned to a new state\n         * @param {Object} transition\n         * @returns {null}\n         */\n        onAfterStep(transition: any) {\n          LoggerProxy.logger.log(\n            `Roap:state#onAfterStep --> RoapStateMachine->onAfterStep#fired! State changed from '${transition.from}' to '${transition.to}' with transition '${transition.transition}''.`\n          );\n        },\n      },\n    });\n\n    return new RoapState();\n  },\n};\n\nexport default RoapStateMachine;\n"],"mappings":";;;;;;;;AAAA,IAAAA,uBAAA,GAAAC,sBAAA,CAAAC,OAAA;AAEA,IAAAC,YAAA,GAAAF,sBAAA,CAAAC,OAAA;AACA,IAAAE,UAAA,GAAAF,OAAA;AAGA,IAAMG,UAAU,GAAG,SAAbA,UAAUA,CAAIC,IAAI,EAAEC,OAAO,EAAK;EACpC,IAAOC,WAAW,GAAIF,IAAI,CAACG,GAAG,CAAvBD,WAAW;EAElB,IAAID,OAAO,EAAE;IACX,IAAIC,WAAW,KAAKE,kBAAO,IAAIJ,IAAI,CAACK,MAAM,IAAIJ,OAAO,CAACK,WAAW,KAAKC,sBAAW,EAAE;MACjF;MACA;MACA,OAAO,KAAK;IACd;IACA;IACA;IACA,IAAI,CAACN,OAAO,CAACO,eAAe,CAACC,cAAc,IAAIP,WAAW,KAAKQ,mBAAQ,EAAE;MACvE,OAAO,KAAK;IACd;EACF;EACAC,oBAAW,CAACC,MAAM,CAACC,GAAG,CACpB,mEAAmE,EACnEZ,OAAO,CAACO,eAAe,CAACC,cAAc,CAACK,cACzC,CAAC;EACDH,oBAAW,CAACC,MAAM,CAACC,GAAG,CACpB,uFAAuF,EACvFb,IAAI,CAACG,GACP,CAAC;EAED,OAAO,IAAI;AACb,CAAC;AAED,IAAMY,gBAAgB,GAAG,SAAnBA,gBAAgBA,CAAIC,KAAK,EAAEC,MAAM,EAAEhB,OAAO,EAAK;EACnDU,oBAAW,CAACC,MAAM,CAACC,GAAG,4CAAAK,MAAA,CAA4CF,KAAK,UAAAE,MAAA,CAAOD,MAAM,CAAE,CAAC;EAEvF,QAAQD,KAAK;IACX,KAAKG,eAAI,CAACC,UAAU,CAACC,IAAI;MACvB,IAAIJ,MAAM,KAAKE,eAAI,CAACG,WAAW,CAACC,QAAQ,EAAE;QACxC,OAAOJ,eAAI,CAACC,UAAU,CAACI,cAAc;MACvC;MACA,IAAIP,MAAM,KAAKE,eAAI,CAACG,WAAW,CAACG,QAAQ,EAAE;QACxC,OAAON,eAAI,CAACC,UAAU,CAACM,cAAc;MACvC;MAEA,OAAOV,KAAK;IAEd,KAAKG,eAAI,CAACC,UAAU,CAACO,aAAa;MAChC,OAAOX,KAAK;IAEd,KAAKG,eAAI,CAACC,UAAU,CAACM,cAAc;MACjC,IAAIT,MAAM,KAAKE,eAAI,CAACG,WAAW,CAACM,SAAS,EAAE;QACzC;QACA;QACA,IAAI3B,OAAO,CAAC4B,OAAO,EAAE;UACnB,OAAOV,eAAI,CAACC,UAAU,CAACU,UAAU;QACnC;QACAnB,oBAAW,CAACC,MAAM,CAACmB,KAAK,CACtB,wEACF,CAAC;QAED,OAAOf,KAAK;MACd;MAEA,IAAIC,MAAM,KAAKE,eAAI,CAACG,WAAW,CAACC,QAAQ,EAAE;QACxC,OAAOJ,eAAI,CAACC,UAAU,CAACY,KAAK;MAC9B;MAEA,OAAOhB,KAAK;IAEd,KAAKG,eAAI,CAACC,UAAU,CAACa,aAAa;MAChC,OAAOjB,KAAK;IAEd,KAAKG,eAAI,CAACC,UAAU,CAACI,cAAc;MACjC,IAAIP,MAAM,KAAKE,eAAI,CAACG,WAAW,CAACY,SAAS,EAAE;QACzC,OAAOf,eAAI,CAACC,UAAU,CAACe,UAAU;MACnC;MAEA,OAAOnB,KAAK;IAEd,KAAKG,eAAI,CAACC,UAAU,CAACU,UAAU;MAC7B,IAAIb,MAAM,KAAKE,eAAI,CAACG,WAAW,CAACc,KAAK,EAAE;QACrC,OAAOjB,eAAI,CAACC,UAAU,CAACC,IAAI;MAC7B;MAEA,OAAOL,KAAK;IAEd,KAAKG,eAAI,CAACC,UAAU,CAACe,UAAU;MAC7B,IAAIlB,MAAM,KAAKE,eAAI,CAACG,WAAW,CAACe,KAAK,EAAE;QACrC,OAAOlB,eAAI,CAACC,UAAU,CAACC,IAAI;MAC7B;MAEA,OAAOL,KAAK;IAEd,KAAKG,eAAI,CAACC,UAAU,CAACkB,KAAK;MACxB;MACA;MACA,OAAOnB,eAAI,CAACC,UAAU,CAACC,IAAI;IAE7B,KAAKF,eAAI,CAACC,UAAU,CAACY,KAAK;MACxB,OAAOb,eAAI,CAACC,UAAU,CAACM,cAAc;IACvC;MACE,OAAOV,KAAK;EAChB;AACF,CAAC;AAED,IAAMuB,gBAAgB,GAAG;EACvB;AACF;AACA;AACA;AACA;EACEC,WAAW,WAAXA,WAAWA,CAAA,EAAG;IACZ,IAAMC,SAAS,GAAGC,+BAAY,CAACC,OAAO,CAAC;MACrCC,IAAI,EAAEzB,eAAI,CAACC,UAAU,CAACC,IAAI;MAC1BwB,WAAW,EAAE,CACX;QACEC,IAAI,EAAE3B,eAAI,CAAC4B,gBAAgB,CAACC,IAAI;QAChCC,IAAI,EAAE,GAAG;QACT;AACV;AACA;AACA;AACA;AACA;AACA;QACUC,EAAE,WAAFA,EAAEA,CAACjC,MAAc,EAAEhB,OAAgB,EAAED,IAAY,EAAE;UACjD,IAAMgB,KAAK,GAAG,IAAI,CAACmC,KAAK;UAExB,IAAI,CAACpD,UAAU,CAACC,IAAI,EAAEC,OAAO,CAAC,EAAE;YAC9B,OAAOe,KAAK;UACd;UAEA,OAAOD,gBAAgB,CAACC,KAAK,EAAEC,MAAM,EAAEhB,OAAO,CAAC;QACjD;MACF,CAAC,CACF;MACDmD,OAAO,EAAE;QACP;AACR;AACA;AACA;AACA;QACQC,WAAW,WAAXA,WAAWA,CAACC,UAAe,EAAE;UAC3B3C,oBAAW,CAACC,MAAM,CAACC,GAAG,wFAAAK,MAAA,CACmEoC,UAAU,CAACL,IAAI,YAAA/B,MAAA,CAASoC,UAAU,CAACJ,EAAE,yBAAAhC,MAAA,CAAsBoC,UAAU,CAACA,UAAU,QACzK,CAAC;QACH;MACF;IACF,CAAC,CAAC;IAEF,OAAO,IAAIb,SAAS,CAAC,CAAC;EACxB;AACF,CAAC;AAAC,IAAAc,QAAA,GAAAC,OAAA,CAAAC,OAAA,GAEalB,gBAAgB","ignoreList":[]}

package/dist/roap/turnDiscovery.d.ts

@@ -0,0 +1,155 @@
+import { Enum } from '../constants';
+import RoapRequest from './request';
+import Meeting from '../meeting';
+declare const TurnDiscoverySkipReason: {
+    readonly missingHttpResponse: "missing http response";
+    readonly reachability: "reachability";
+    readonly alreadyInProgress: "already in progress";
+};
+export type TurnDiscoverySkipReason = Enum<typeof TurnDiscoverySkipReason> | string | undefined;
+export type TurnServerInfo = {
+    url: string;
+    username: string;
+    password: string;
+};
+export type TurnDiscoveryResult = {
+    turnServerInfo?: TurnServerInfo;
+    turnDiscoverySkippedReason: TurnDiscoverySkipReason;
+};
+/**
+ * Handles the process of finding out TURN server information from Linus.
+ * This is achieved by sending a TURN_DISCOVERY_REQUEST.
+ */
+export default class TurnDiscovery {
+    private roapRequest;
+    private defer?;
+    private turnInfo;
+    private responseTimer?;
+    /**
+     * Constructor
+     *
+     * @param {RoapRequest} roapRequest
+     */
+    constructor(roapRequest: RoapRequest);
+    /**
+     * waits for TURN_DISCOVERY_RESPONSE message to arrive
+     *
+     * @returns {Promise}
+     * @private
+     * @memberof Roap
+     */
+    private waitForTurnDiscoveryResponse;
+    /**
+     * Handles TURN_DISCOVERY_RESPONSE roap message. Use it if the roap message comes over the websocket,
+     * otherwise use handleTurnDiscoveryHttpResponse() if it comes in the http response.
+     *
+     * @param {Object} roapMessage
+     * @param {string} from string to indicate how we got the response (used just for logging)
+     * @returns {void}
+     * @public
+     * @memberof Roap
+     */
+    handleTurnDiscoveryResponse(roapMessage: any, from: string): void;
+    /**
+     * Generates TURN_DISCOVERY_REQUEST roap message. When this method returns a roapMessage, it means that a TURN discovery process has started.
+     * It needs be ended by calling handleTurnDiscoveryHttpResponse() once you get a response from the backend. If you don't get any response
+     * or want to abort, you need to call abort().
+     *
+     * @param {Meeting} meeting
+     * @param {boolean} isForced
+     * @returns {Object}
+     */
+    generateTurnDiscoveryRequestMessage(meeting: Meeting, isForced: boolean): Promise<{
+        roapMessage?: object;
+        turnDiscoverySkippedReason: TurnDiscoverySkipReason;
+    }>;
+    /**
+     * Handles any errors that occur during TURN discovery without re-throwing them.
+     *
+     * @param {Meeting} meeting
+     * @param {Error} error
+     * @returns {TurnDiscoveryResult}
+     */
+    private handleTurnDiscoveryFailure;
+    /**
+     * Handles TURN_DISCOVERY_RESPONSE roap message that came in http response. If the response is not valid,
+     * it returns an object with turnServerInfo set to undefined. In that case you need to call abort()
+     * to end the TURN discovery process.
+     *
+     * @param {Meeting} meeting
+     * @param {Object|undefined} httpResponse can be undefined to indicate that we didn't get the response
+     * @returns {Promise<TurnDiscoveryResult>}
+     * @memberof Roap
+     */
+    handleTurnDiscoveryHttpResponse(meeting: Meeting, httpResponse?: object): Promise<TurnDiscoveryResult>;
+    /**
+     * Aborts current TURN discovery. This method needs to be called if you called generateTurnDiscoveryRequestMessage(),
+     * but then never got any response from the server.
+     * @returns {void}
+     */
+    abort(): void;
+    /**
+     * Parses the TURN_DISCOVERY_RESPONSE roap message out of the http response
+     * and returns it.
+     *
+     * @param {Meeting} meeting
+     * @param {any} httpResponse
+     * @returns {any}
+     */
+    private parseHttpTurnDiscoveryResponse;
+    /**
+     * sends the TURN_DISCOVERY_REQUEST roap request
+     *
+     * @param {Meeting} meeting
+     * @param {Boolean} isReconnecting
+     * @returns {Promise}
+     * @private
+     * @memberof Roap
+     */
+    private sendRoapTurnDiscoveryRequest;
+    /**
+     * Sends the OK message that server expects to receive
+     * after it sends us TURN_DISCOVERY_RESPONSE
+     *
+     * @param {Meeting} meeting
+     * @returns {Promise}
+     */
+    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:
+     * client                             server
+     *  | -----TURN_DISCOVERY_REQUEST-----> |
+     *  | <----TURN_DISCOVERY_RESPONSE----- |
+     *  | --------------OK----------------> |
+     *
+     * This TURN discovery roap exchange is always done with seq=0.
+     * The RoapMediaConnection SDP exchange always starts with seq=1,
+     * so it works fine no matter if TURN discovery is done or not.
+     *
+     * @param {Meeting} meeting
+     * @param {Boolean} [isReconnecting] should be set to true if this is a new
+     *                                 media connection just after a reconnection
+     * @param {Boolean} [isForced]
+     * @returns {Promise}
+     */
+    doTurnDiscovery(meeting: Meeting, isReconnecting?: boolean, isForced?: boolean): Promise<TurnDiscoveryResult>;
+}
+export {};

package/dist/roap/util.js

@@ -0,0 +1,75 @@
+"use strict";
+
+var _Object$defineProperty = require("@babel/runtime-corejs2/core-js/object/define-property");
+var _interopRequireDefault = require("@babel/runtime-corejs2/helpers/interopRequireDefault");
+_Object$defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _promise = _interopRequireDefault(require("@babel/runtime-corejs2/core-js/promise"));
+var _peerConnectionManager = _interopRequireDefault(require("../peer-connection-manager"));
+var _constants = require("../constants");
+var _loggerProxy = _interopRequireDefault(require("../common/logs/logger-proxy"));
+var _parameter = _interopRequireDefault(require("../common/errors/parameter"));
+var RoapUtil = {};
+var ROAP_ANSWER = _constants._ANSWER_.toLowerCase();
+RoapUtil.shouldHandleMedia = function (meeting) {
+  var offer = meeting.mediaProperties.peerConnection && meeting.mediaProperties.peerConnection.signalingState === _constants.SDP.HAVE_LOCAL_OFFER;
+  if (offer) {
+    return false;
+  }
+  return true;
+};
+RoapUtil.handleError = function (pc) {
+  return _peerConnectionManager.default.rollBackLocalDescription({
+    peerConnection: pc
+  }).then(function () {
+    return _promise.default.resolve(true);
+  }).catch(function (err) {
+    _loggerProxy.default.logger.error("Roap:util#handleError --> ".concat(err));
+    return _promise.default.reject(err);
+  });
+};
+RoapUtil.findError = function (messageType, errorType, type) {
+  return (type === _constants.ROAP.RECEIVE_ROAP_MSG || type === _constants.ROAP.SEND_ROAP_MSG) && messageType === _constants._ERROR_ && errorType === _constants._CONFLICT_;
+};
+RoapUtil.ensureMeeting = function (meeting, type) {
+  if (type === _constants.ROAP.RECEIVE_ROAP_MSG || type === _constants.ROAP.SEND_ROAP_MSG || type === _constants.ROAP.SEND_ROAP_MSG_SUCCESS) {
+    if (!meeting) {
+      return false;
+    }
+  }
+  return true;
+};
+RoapUtil.updatePeerConnection = function (meeting, session) {
+  return _peerConnectionManager.default.updatePeerConnection({
+    offerSdp: session.OFFER.sdps,
+    peerConnection: meeting.mediaProperties.peerConnection
+  }, {
+    meetingId: meeting.id,
+    remoteQualityLevel: meeting.mediaProperties.remoteQualityLevel
+  }).then(function (res) {
+    meeting.roap.lastRoapOffer = session.OFFER.sdps;
+    return res;
+  });
+};
+RoapUtil.setRemoteDescription = function (meeting, session) {
+  _loggerProxy.default.logger.info("Roap:util#setRemoteDescription --> Transmit WAIT_TX_OK, correlationId: ".concat(meeting.correlationId));
+  if (!(meeting && meeting.mediaProperties.peerConnection)) {
+    _loggerProxy.default.logger.error("Roap:util#setRemoteDescription --> DANGER no media or screen peer connection, correlationId: ".concat(meeting.correlationId));
+    return _promise.default.reject(new _parameter.default('Must provide a media or screen peer connection'));
+  }
+  return _peerConnectionManager.default.setRemoteSessionDetails(meeting.mediaProperties.peerConnection, ROAP_ANSWER, session.ANSWER.sdps[0], meeting.id).then(function () {
+    _loggerProxy.default.logger.info("Roap:util#setRemoteDescription --> Success for correlationId: ".concat(meeting.correlationId));
+    return {
+      seq: session.ANSWER.seq,
+      mediaId: meeting.mediaId,
+      correlationId: meeting.correlationId
+    };
+  }).catch(function (err) {
+    _loggerProxy.default.logger.error("Roap:util#setRemoteDescription --> ".concat(err));
+    throw err;
+  });
+};
+var _default = exports.default = RoapUtil;
+//# sourceMappingURL=util.js.map

package/dist/roap/util.js.map

@@ -0,0 +1 @@
+{"version":3,"names":["_peerConnectionManager","_interopRequireDefault","require","_constants","_loggerProxy","_parameter","RoapUtil","ROAP_ANSWER","_ANSWER_","toLowerCase","shouldHandleMedia","meeting","offer","mediaProperties","peerConnection","signalingState","SDP","HAVE_LOCAL_OFFER","handleError","pc","PeerConnectionManager","rollBackLocalDescription","then","_promise","default","resolve","catch","err","LoggerProxy","logger","error","concat","reject","findError","messageType","errorType","type","ROAP","RECEIVE_ROAP_MSG","SEND_ROAP_MSG","_ERROR_","_CONFLICT_","ensureMeeting","SEND_ROAP_MSG_SUCCESS","updatePeerConnection","session","offerSdp","OFFER","sdps","meetingId","id","remoteQualityLevel","res","roap","lastRoapOffer","setRemoteDescription","info","correlationId","ParameterError","setRemoteSessionDetails","ANSWER","seq","mediaId","_default","exports"],"sources":["util.ts"],"sourcesContent":["import PeerConnectionManager from '../peer-connection-manager';\nimport {_ANSWER_, _ERROR_, _CONFLICT_, ROAP, SDP} from '../constants';\nimport LoggerProxy from '../common/logs/logger-proxy';\nimport ParameterError from '../common/errors/parameter';\n\nconst RoapUtil: any = {};\nconst ROAP_ANSWER = _ANSWER_.toLowerCase();\n\nRoapUtil.shouldHandleMedia = (meeting) => {\n  const offer =\n    meeting.mediaProperties.peerConnection &&\n    meeting.mediaProperties.peerConnection.signalingState === SDP.HAVE_LOCAL_OFFER;\n\n  if (offer) {\n    return false;\n  }\n\n  return true;\n};\n\nRoapUtil.handleError = (pc) =>\n  PeerConnectionManager.rollBackLocalDescription({peerConnection: pc})\n    .then(() => Promise.resolve(true))\n    .catch((err) => {\n      LoggerProxy.logger.error(`Roap:util#handleError --> ${err}`);\n\n      return Promise.reject(err);\n    });\n\nRoapUtil.findError = (messageType, errorType, type) =>\n  (type === ROAP.RECEIVE_ROAP_MSG || type === ROAP.SEND_ROAP_MSG) &&\n  messageType === _ERROR_ &&\n  errorType === _CONFLICT_;\n\nRoapUtil.ensureMeeting = (meeting, type) => {\n  if (\n    type === ROAP.RECEIVE_ROAP_MSG ||\n    type === ROAP.SEND_ROAP_MSG ||\n    type === ROAP.SEND_ROAP_MSG_SUCCESS\n  ) {\n    if (!meeting) {\n      return false;\n    }\n  }\n\n  return true;\n};\n\nRoapUtil.updatePeerConnection = (meeting, session) =>\n  PeerConnectionManager.updatePeerConnection(\n    {\n      offerSdp: session.OFFER.sdps,\n      peerConnection: meeting.mediaProperties.peerConnection,\n    },\n    {\n      meetingId: meeting.id,\n      remoteQualityLevel: meeting.mediaProperties.remoteQualityLevel,\n    }\n  ).then((res) => {\n    meeting.roap.lastRoapOffer = session.OFFER.sdps;\n\n    return res;\n  });\n\nRoapUtil.setRemoteDescription = (meeting, session) => {\n  LoggerProxy.logger.info(\n    `Roap:util#setRemoteDescription --> Transmit WAIT_TX_OK, correlationId: ${meeting.correlationId}`\n  );\n  if (!(meeting && meeting.mediaProperties.peerConnection)) {\n    LoggerProxy.logger.error(\n      `Roap:util#setRemoteDescription --> DANGER no media or screen peer connection, correlationId: ${meeting.correlationId}`\n    );\n\n    return Promise.reject(new ParameterError('Must provide a media or screen peer connection'));\n  }\n\n  return PeerConnectionManager.setRemoteSessionDetails(\n    meeting.mediaProperties.peerConnection,\n    ROAP_ANSWER,\n    session.ANSWER.sdps[0],\n    meeting.id\n  )\n    .then(() => {\n      LoggerProxy.logger.info(\n        `Roap:util#setRemoteDescription --> Success for correlationId: ${meeting.correlationId}`\n      );\n\n      return {\n        seq: session.ANSWER.seq,\n        mediaId: meeting.mediaId,\n        correlationId: meeting.correlationId,\n      };\n    })\n    .catch((err) => {\n      LoggerProxy.logger.error(`Roap:util#setRemoteDescription --> ${err}`);\n      throw err;\n    });\n};\n\nexport default RoapUtil;\n"],"mappings":";;;;;;;;;AAAA,IAAAA,sBAAA,GAAAC,sBAAA,CAAAC,OAAA;AACA,IAAAC,UAAA,GAAAD,OAAA;AACA,IAAAE,YAAA,GAAAH,sBAAA,CAAAC,OAAA;AACA,IAAAG,UAAA,GAAAJ,sBAAA,CAAAC,OAAA;AAEA,IAAMI,QAAa,GAAG,CAAC,CAAC;AACxB,IAAMC,WAAW,GAAGC,mBAAQ,CAACC,WAAW,CAAC,CAAC;AAE1CH,QAAQ,CAACI,iBAAiB,GAAG,UAACC,OAAO,EAAK;EACxC,IAAMC,KAAK,GACTD,OAAO,CAACE,eAAe,CAACC,cAAc,IACtCH,OAAO,CAACE,eAAe,CAACC,cAAc,CAACC,cAAc,KAAKC,cAAG,CAACC,gBAAgB;EAEhF,IAAIL,KAAK,EAAE;IACT,OAAO,KAAK;EACd;EAEA,OAAO,IAAI;AACb,CAAC;AAEDN,QAAQ,CAACY,WAAW,GAAG,UAACC,EAAE;EAAA,OACxBC,8BAAqB,CAACC,wBAAwB,CAAC;IAACP,cAAc,EAAEK;EAAE,CAAC,CAAC,CACjEG,IAAI,CAAC;IAAA,OAAMC,QAAA,CAAAC,OAAA,CAAQC,OAAO,CAAC,IAAI,CAAC;EAAA,EAAC,CACjCC,KAAK,CAAC,UAACC,GAAG,EAAK;IACdC,oBAAW,CAACC,MAAM,CAACC,KAAK,8BAAAC,MAAA,CAA8BJ,GAAG,CAAE,CAAC;IAE5D,OAAOJ,QAAA,CAAAC,OAAA,CAAQQ,MAAM,CAACL,GAAG,CAAC;EAC5B,CAAC,CAAC;AAAA;AAENrB,QAAQ,CAAC2B,SAAS,GAAG,UAACC,WAAW,EAAEC,SAAS,EAAEC,IAAI;EAAA,OAChD,CAACA,IAAI,KAAKC,eAAI,CAACC,gBAAgB,IAAIF,IAAI,KAAKC,eAAI,CAACE,aAAa,KAC9DL,WAAW,KAAKM,kBAAO,IACvBL,SAAS,KAAKM,qBAAU;AAAA;AAE1BnC,QAAQ,CAACoC,aAAa,GAAG,UAAC/B,OAAO,EAAEyB,IAAI,EAAK;EAC1C,IACEA,IAAI,KAAKC,eAAI,CAACC,gBAAgB,IAC9BF,IAAI,KAAKC,eAAI,CAACE,aAAa,IAC3BH,IAAI,KAAKC,eAAI,CAACM,qBAAqB,EACnC;IACA,IAAI,CAAChC,OAAO,EAAE;MACZ,OAAO,KAAK;IACd;EACF;EAEA,OAAO,IAAI;AACb,CAAC;AAEDL,QAAQ,CAACsC,oBAAoB,GAAG,UAACjC,OAAO,EAAEkC,OAAO;EAAA,OAC/CzB,8BAAqB,CAACwB,oBAAoB,CACxC;IACEE,QAAQ,EAAED,OAAO,CAACE,KAAK,CAACC,IAAI;IAC5BlC,cAAc,EAAEH,OAAO,CAACE,eAAe,CAACC;EAC1C,CAAC,EACD;IACEmC,SAAS,EAAEtC,OAAO,CAACuC,EAAE;IACrBC,kBAAkB,EAAExC,OAAO,CAACE,eAAe,CAACsC;EAC9C,CACF,CAAC,CAAC7B,IAAI,CAAC,UAAC8B,GAAG,EAAK;IACdzC,OAAO,CAAC0C,IAAI,CAACC,aAAa,GAAGT,OAAO,CAACE,KAAK,CAACC,IAAI;IAE/C,OAAOI,GAAG;EACZ,CAAC,CAAC;AAAA;AAEJ9C,QAAQ,CAACiD,oBAAoB,GAAG,UAAC5C,OAAO,EAAEkC,OAAO,EAAK;EACpDjB,oBAAW,CAACC,MAAM,CAAC2B,IAAI,2EAAAzB,MAAA,CACqDpB,OAAO,CAAC8C,aAAa,CACjG,CAAC;EACD,IAAI,EAAE9C,OAAO,IAAIA,OAAO,CAACE,eAAe,CAACC,cAAc,CAAC,EAAE;IACxDc,oBAAW,CAACC,MAAM,CAACC,KAAK,iGAAAC,MAAA,CAC0EpB,OAAO,CAAC8C,aAAa,CACvH,CAAC;IAED,OAAOlC,QAAA,CAAAC,OAAA,CAAQQ,MAAM,CAAC,IAAI0B,kBAAc,CAAC,gDAAgD,CAAC,CAAC;EAC7F;EAEA,OAAOtC,8BAAqB,CAACuC,uBAAuB,CAClDhD,OAAO,CAACE,eAAe,CAACC,cAAc,EACtCP,WAAW,EACXsC,OAAO,CAACe,MAAM,CAACZ,IAAI,CAAC,CAAC,CAAC,EACtBrC,OAAO,CAACuC,EACV,CAAC,CACE5B,IAAI,CAAC,YAAM;IACVM,oBAAW,CAACC,MAAM,CAAC2B,IAAI,kEAAAzB,MAAA,CAC4CpB,OAAO,CAAC8C,aAAa,CACxF,CAAC;IAED,OAAO;MACLI,GAAG,EAAEhB,OAAO,CAACe,MAAM,CAACC,GAAG;MACvBC,OAAO,EAAEnD,OAAO,CAACmD,OAAO;MACxBL,aAAa,EAAE9C,OAAO,CAAC8C;IACzB,CAAC;EACH,CAAC,CAAC,CACD/B,KAAK,CAAC,UAACC,GAAG,EAAK;IACdC,oBAAW,CAACC,MAAM,CAACC,KAAK,uCAAAC,MAAA,CAAuCJ,GAAG,CAAE,CAAC;IACrE,MAAMA,GAAG;EACX,CAAC,CAAC;AACN,CAAC;AAAC,IAAAoC,QAAA,GAAAC,OAAA,CAAAxC,OAAA,GAEalB,QAAQ","ignoreList":[]}

package/dist/rtcMetrics/constants.d.ts

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

package/dist/rtcMetrics/constants.js

@@ -0,0 +1,11 @@
+"use strict";
+
+var _Object$defineProperty = require("@babel/runtime-corejs2/core-js/object/define-property");
+_Object$defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var RTC_METRICS = exports.default = {
+  APP_ID: 'FFB51ED5-4319-4C55-8303-B1F2FCCDE231'
+};
+//# sourceMappingURL=constants.js.map

package/dist/rtcMetrics/constants.js.map

@@ -0,0 +1 @@
+{"version":3,"names":["RTC_METRICS","exports","default","APP_ID"],"sources":["constants.ts"],"sourcesContent":["const RTC_METRICS = {APP_ID: 'FFB51ED5-4319-4C55-8303-B1F2FCCDE231'};\n\nexport {RTC_METRICS as default};\n"],"mappings":";;;;;;;AAAA,IAAMA,WAAW,GAAAC,OAAA,CAAAC,OAAA,GAAG;EAACC,MAAM,EAAE;AAAsC,CAAC"}

package/dist/rtcMetrics/index.d.ts

@@ -0,0 +1,61 @@
+/**
+ * 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;
+    connectionId: 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}
+     */
+    sendMetricsInQueue(): void;
+    /**
+     * 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;
+    /**
+     * Anonymize IP addresses.
+     *
+     * @param {array} stats - An RTCStatsReport organized into an array of strings.
+     * @returns {string}
+     */
+    anonymizeIp(stats: string): string;
+    /**
+     * Set a new connection id.
+     *
+     * @returns {void}
+     */
+    private setNewConnectionId;
+    /**
+     * Send metrics to the metrics service.
+     *
+     * @returns {void}
+     */
+    private sendMetrics;
+}