@webex/plugin-meetings 3.0.0-beta.34 → 3.0.0-beta.340

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

@@ -0,0 +1,54 @@
+/**
+ * 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}
+     */
+    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;
+    /**
+     * 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,19 @@ export declare class StatsAnalyzer extends EventsScope {
     statsInterval: NodeJS.Timeout;
     statsResults: any;
     statsStarted: any;
+    successfulCandidatePair: any;
+    localIpAddress: string;
+    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.
      *
@@ -71,6 +77,13 @@ export declare class StatsAnalyzer extends EventsScope {
      * @returns {void}
      */
     updateMediaConnection(mediaConnection: any): void;
+    /**
+     * Returns the local IP address for diagnostics.
+     * this is the local IP of the interface used for the current media connection
+     * a host can have many local Ip Addresses
+     * @returns {string | undefined} The local IP address.
+     */
+    getLocalIpAddress(): string;
     /**
      * Starts the stats analyzer on interval
      *
@@ -162,6 +175,20 @@ export declare class StatsAnalyzer extends EventsScope {
      * @returns {void}
      */
     private processInboundRTPResult;
+    /**
+     * extracts the local Ip address from the statsResult object by looking at stats results candidates
+     * and matches that ID with the successful candidate pair. It looks at the type of local candidate it is
+     * and then extracts the IP address from the relatedAddress or address property based on conditions known in webrtc
+     * note, there are known incompatibilities and it is possible for this to set undefined, or for the IP address to be the public IP address
+     * for example, firefox does not set the relayProtocol, and if the user is behind a NAT it might be the public IP
+     * @private
+     * @param {string} successfulCandidatePairId - The ID of the successful candidate pair.
+     * @param {Object} candidates - the stats result candidates
+     * @returns {void}
+     */
+    extractAndSetLocalIpAddressInfoForDiagnostics: (successfulCandidatePairId: string, candidates: {
+        [key: string]: Record<string, unknown>;
+    }) => void;
     /**
      * Processes remote and local candidate result and stores
      * @private
@@ -173,16 +200,6 @@ export declare class StatsAnalyzer extends EventsScope {
      * @returns {void}
      */
     parseCandidate: (result: any, type: any, isSender: boolean, isRemote: boolean) => void;
-    /**
-     * Process Track results
-     *
-     * @private
-     * @param {*} result
-     * @param {*} mediaType
-     * @returns {void}
-     * @memberof StatsAnalyzer
-     */
-    private processTrackResult;
     /**
      *
      * @private
@@ -193,3 +210,4 @@ export declare class StatsAnalyzer extends EventsScope {
      */
     compareSentAndReceived(result: any, type: any): void;
 }
+export {};

package/dist/types/webinar/collection.d.ts

@@ -0,0 +1,16 @@
+/*!
+ * Copyright (c) 2015-2023 Cisco Systems, Inc. See LICENSE file.
+ */
+declare class WebinarCollection {
+    webinarInfo: any;
+    namespace: string;
+    mainIndex: string;
+    constructor();
+    set(id: any, info: any): void;
+    /**
+     * @param {String} id
+     * @returns {Member}
+     */
+    get(id: string): any;
+}
+export default WebinarCollection;

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

@@ -0,0 +1,5 @@
+/**
+ * @class Webinar
+ */
+declare const Webinar: any;
+export default Webinar;

package/dist/webinar/collection.js

@@ -0,0 +1,44 @@
+"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 _classCallCheck2 = _interopRequireDefault(require("@babel/runtime-corejs2/helpers/classCallCheck"));
+var _createClass2 = _interopRequireDefault(require("@babel/runtime-corejs2/helpers/createClass"));
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime-corejs2/helpers/defineProperty"));
+var _constants = require("../constants");
+/*!
+ * Copyright (c) 2015-2023 Cisco Systems, Inc. See LICENSE file.
+ */
+var WebinarCollection = /*#__PURE__*/function () {
+  function WebinarCollection() {
+    (0, _classCallCheck2.default)(this, WebinarCollection);
+    (0, _defineProperty2.default)(this, "webinarInfo", void 0);
+    (0, _defineProperty2.default)(this, "namespace", _constants.MEETINGS);
+    (0, _defineProperty2.default)(this, "mainIndex", 'sessionId');
+    this.webinarInfo = {};
+  }
+  (0, _createClass2.default)(WebinarCollection, [{
+    key: "set",
+    value: function set(id, info) {
+      this.webinarInfo[id] = info;
+    }
+
+    /**
+     * @param {String} id
+     * @returns {Member}
+     */
+  }, {
+    key: "get",
+    value: function get(id) {
+      return this.webinarInfo[id];
+    }
+  }]);
+  return WebinarCollection;
+}();
+var _default = WebinarCollection;
+exports.default = _default;
+//# sourceMappingURL=collection.js.map

package/dist/webinar/collection.js.map

@@ -0,0 +1 @@
+{"version":3,"names":["WebinarCollection","MEETINGS","webinarInfo","id","info"],"sources":["collection.ts"],"sourcesContent":["/*!\n * Copyright (c) 2015-2023 Cisco Systems, Inc. See LICENSE file.\n */\n\nimport {MEETINGS} from '../constants';\n\nclass WebinarCollection {\n  webinarInfo: any;\n\n  namespace = MEETINGS;\n\n  mainIndex = 'sessionId';\n\n  constructor() {\n    this.webinarInfo = {};\n  }\n\n  set(id, info) {\n    this.webinarInfo[id] = info;\n  }\n\n  /**\n   * @param {String} id\n   * @returns {Member}\n   */\n  get(id: string) {\n    return this.webinarInfo[id];\n  }\n}\n\nexport default WebinarCollection;\n"],"mappings":";;;;;;;;;;;AAIA;AAJA;AACA;AACA;AAFA,IAMMA,iBAAiB;EAOrB,6BAAc;IAAA;IAAA;IAAA,iDAJFC,mBAAQ;IAAA,iDAER,WAAW;IAGrB,IAAI,CAACC,WAAW,GAAG,CAAC,CAAC;EACvB;EAAC;IAAA;IAAA,OAED,aAAIC,EAAE,EAAEC,IAAI,EAAE;MACZ,IAAI,CAACF,WAAW,CAACC,EAAE,CAAC,GAAGC,IAAI;IAC7B;;IAEA;AACF;AACA;AACA;EAHE;IAAA;IAAA,OAIA,aAAID,EAAU,EAAE;MACd,OAAO,IAAI,CAACD,WAAW,CAACC,EAAE,CAAC;IAC7B;EAAC;EAAA;AAAA;AAAA,eAGYH,iBAAiB;AAAA"}

package/dist/webinar/index.js

@@ -0,0 +1,69 @@
+"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 _webexCore = require("@webex/webex-core");
+var _constants = require("../constants");
+var _collection = _interopRequireDefault(require("./collection"));
+/*!
+ * Copyright (c) 2015-2023 Cisco Systems, Inc. See LICENSE file.
+ */
+
+/**
+ * @class Webinar
+ */
+var Webinar = _webexCore.WebexPlugin.extend({
+  namespace: _constants.MEETINGS,
+  collections: {
+    webinar: _collection.default
+  },
+  props: {
+    locusUrl: 'string',
+    // appears current webinar's locus url
+    webcastUrl: 'string',
+    // current webinar's webcast url
+    webinarAttendeesSearchingUrl: 'string',
+    // current webinarAttendeesSearching url
+    canManageWebcast: 'boolean' // appears the ability to manage webcast
+  },
+  /**
+   * Update the current locus url of the webinar
+   * @param {string} locusUrl // locus url
+   * @returns {void}
+   */
+  locusUrlUpdate: function locusUrlUpdate(locusUrl) {
+    this.set('locusUrl', locusUrl);
+  },
+  /**
+   * Update the current webcast url of the meeting
+   * @param {string} webcastUrl // webcast url
+   * @returns {void}
+   */
+  webcastUrlUpdate: function webcastUrlUpdate(webcastUrl) {
+    this.set('webcastUrl', webcastUrl);
+  },
+  /**
+   * Update the current webinarAttendeesSearching url of the meeting
+   * @param {string} webinarAttendeesSearchingUrl // webinarAttendeesSearching url
+   * @returns {void}
+   */
+  webinarAttendeesSearchingUrlUpdate: function webinarAttendeesSearchingUrlUpdate(webinarAttendeesSearchingUrl) {
+    this.set('webinarAttendeesSearchingUrl', webinarAttendeesSearchingUrl);
+  },
+  /**
+   * Update whether self has capability to manage start/stop webcast (only host can manage it)
+   * @param {boolean} canManageWebcast
+   * @returns {void}
+   */
+  updateCanManageWebcast: function updateCanManageWebcast(canManageWebcast) {
+    this.set('canManageWebcast', canManageWebcast);
+  },
+  version: "3.0.0-beta.340"
+});
+var _default = Webinar;
+exports.default = _default;
+//# sourceMappingURL=index.js.map

package/dist/webinar/index.js.map

@@ -0,0 +1 @@
+{"version":3,"names":["Webinar","WebexPlugin","extend","namespace","MEETINGS","collections","webinar","WebinarCollection","props","locusUrl","webcastUrl","webinarAttendeesSearchingUrl","canManageWebcast","locusUrlUpdate","set","webcastUrlUpdate","webinarAttendeesSearchingUrlUpdate","updateCanManageWebcast"],"sources":["index.ts"],"sourcesContent":["/*!\n * Copyright (c) 2015-2023 Cisco Systems, Inc. See LICENSE file.\n */\nimport {WebexPlugin} from '@webex/webex-core';\nimport {MEETINGS} from '../constants';\n\nimport WebinarCollection from './collection';\n\n/**\n * @class Webinar\n */\nconst Webinar = WebexPlugin.extend({\n  namespace: MEETINGS,\n  collections: {\n    webinar: WebinarCollection,\n  },\n\n  props: {\n    locusUrl: 'string', // appears current webinar's locus url\n    webcastUrl: 'string', // current webinar's webcast url\n    webinarAttendeesSearchingUrl: 'string', // current webinarAttendeesSearching url\n    canManageWebcast: 'boolean', // appears the ability to manage webcast\n  },\n\n  /**\n   * Update the current locus url of the webinar\n   * @param {string} locusUrl // locus url\n   * @returns {void}\n   */\n  locusUrlUpdate(locusUrl) {\n    this.set('locusUrl', locusUrl);\n  },\n\n  /**\n   * Update the current webcast url of the meeting\n   * @param {string} webcastUrl // webcast url\n   * @returns {void}\n   */\n  webcastUrlUpdate(webcastUrl) {\n    this.set('webcastUrl', webcastUrl);\n  },\n\n  /**\n   * Update the current webinarAttendeesSearching url of the meeting\n   * @param {string} webinarAttendeesSearchingUrl // webinarAttendeesSearching url\n   * @returns {void}\n   */\n  webinarAttendeesSearchingUrlUpdate(webinarAttendeesSearchingUrl) {\n    this.set('webinarAttendeesSearchingUrl', webinarAttendeesSearchingUrl);\n  },\n\n  /**\n   * Update whether self has capability to manage start/stop webcast (only host can manage it)\n   * @param {boolean} canManageWebcast\n   * @returns {void}\n   */\n  updateCanManageWebcast(canManageWebcast) {\n    this.set('canManageWebcast', canManageWebcast);\n  },\n});\n\nexport default Webinar;\n"],"mappings":";;;;;;;;AAGA;AACA;AAEA;AANA;AACA;AACA;;AAMA;AACA;AACA;AACA,IAAMA,OAAO,GAAGC,sBAAW,CAACC,MAAM,CAAC;EACjCC,SAAS,EAAEC,mBAAQ;EACnBC,WAAW,EAAE;IACXC,OAAO,EAAEC;EACX,CAAC;EAEDC,KAAK,EAAE;IACLC,QAAQ,EAAE,QAAQ;IAAE;IACpBC,UAAU,EAAE,QAAQ;IAAE;IACtBC,4BAA4B,EAAE,QAAQ;IAAE;IACxCC,gBAAgB,EAAE,SAAS,CAAE;EAC/B,CAAC;EAED;AACF;AACA;AACA;AACA;EACEC,cAAc,0BAACJ,QAAQ,EAAE;IACvB,IAAI,CAACK,GAAG,CAAC,UAAU,EAAEL,QAAQ,CAAC;EAChC,CAAC;EAED;AACF;AACA;AACA;AACA;EACEM,gBAAgB,4BAACL,UAAU,EAAE;IAC3B,IAAI,CAACI,GAAG,CAAC,YAAY,EAAEJ,UAAU,CAAC;EACpC,CAAC;EAED;AACF;AACA;AACA;AACA;EACEM,kCAAkC,8CAACL,4BAA4B,EAAE;IAC/D,IAAI,CAACG,GAAG,CAAC,8BAA8B,EAAEH,4BAA4B,CAAC;EACxE,CAAC;EAED;AACF;AACA;AACA;AACA;EACEM,sBAAsB,kCAACL,gBAAgB,EAAE;IACvC,IAAI,CAACE,GAAG,CAAC,kBAAkB,EAAEF,gBAAgB,CAAC;EAChD,CAAC;EAAA;AACH,CAAC,CAAC;AAAC,eAEYZ,OAAO;AAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@webex/plugin-meetings",
-  "version": "3.0.0-beta.34",
+  "version": "3.0.0-beta.340",
   "description": "",
   "license": "Cisco EULA (https://www.cisco.com/c/en/us/products/end-user-license-agreement.html)",
   "contributors": [
@@ -32,12 +32,13 @@
     "build": "yarn run -T tsc --declaration true --declarationDir ./dist/types"
   },
   "devDependencies": {
-    "@webex/plugin-meetings": "3.0.0-beta.34",
-    "@webex/test-helper-chai": "3.0.0-beta.34",
-    "@webex/test-helper-mocha": "3.0.0-beta.34",
-    "@webex/test-helper-mock-webex": "3.0.0-beta.34",
-    "@webex/test-helper-retry": "3.0.0-beta.34",
-    "@webex/test-helper-test-users": "3.0.0-beta.34",
+    "@peculiar/webcrypto": "^1.4.3",
+    "@webex/plugin-meetings": "3.0.0-beta.340",
+    "@webex/test-helper-chai": "3.0.0-beta.340",
+    "@webex/test-helper-mocha": "3.0.0-beta.340",
+    "@webex/test-helper-mock-webex": "3.0.0-beta.340",
+    "@webex/test-helper-retry": "3.0.0-beta.340",
+    "@webex/test-helper-test-users": "3.0.0-beta.340",
     "chai": "^4.3.4",
     "chai-as-promised": "^7.1.1",
     "jsdom-global": "3.0.2",
@@ -46,18 +47,19 @@
     "typescript": "^4.7.4"
   },
   "dependencies": {
-    "@webex/common": "3.0.0-beta.34",
-    "@webex/internal-media-core": "1.35.0",
-    "@webex/internal-plugin-conversation": "3.0.0-beta.34",
-    "@webex/internal-plugin-device": "3.0.0-beta.34",
-    "@webex/internal-plugin-llm": "3.0.0-beta.34",
-    "@webex/internal-plugin-mercury": "3.0.0-beta.34",
-    "@webex/internal-plugin-metrics": "3.0.0-beta.34",
-    "@webex/internal-plugin-support": "3.0.0-beta.34",
-    "@webex/internal-plugin-user": "3.0.0-beta.34",
-    "@webex/plugin-people": "3.0.0-beta.34",
-    "@webex/plugin-rooms": "3.0.0-beta.34",
-    "@webex/webex-core": "3.0.0-beta.34",
+    "@webex/common": "3.0.0-beta.340",
+    "@webex/internal-media-core": "2.2.4",
+    "@webex/internal-plugin-conversation": "3.0.0-beta.340",
+    "@webex/internal-plugin-device": "3.0.0-beta.340",
+    "@webex/internal-plugin-llm": "3.0.0-beta.340",
+    "@webex/internal-plugin-mercury": "3.0.0-beta.340",
+    "@webex/internal-plugin-metrics": "3.0.0-beta.340",
+    "@webex/internal-plugin-support": "3.0.0-beta.340",
+    "@webex/internal-plugin-user": "3.0.0-beta.340",
+    "@webex/media-helpers": "3.0.0-beta.340",
+    "@webex/plugin-people": "3.0.0-beta.340",
+    "@webex/plugin-rooms": "3.0.0-beta.340",
+    "@webex/webex-core": "3.0.0-beta.340",
     "ampersand-collection": "^2.0.2",
     "bowser": "^2.11.0",
     "btoa": "^1.2.1",
@@ -65,6 +67,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';