@webex/plugin-meetings 3.0.0-beta.4 → 3.0.0-beta.400

package/README.md

@@ -98,6 +98,8 @@ return webex.meetings.create(locusObj, 'LOCUS_ID').then((meeting) ==> {...});
 
 We want to sync our meetings collection with the server.
 
+To keep only Locus meetings with an locus url that is still active:
+
 ```js
 let existingMeetings;
 // Sync Meetings From Server
@@ -107,6 +109,16 @@ webex.meetings.syncMeetings().then(() => {
 });
 ```
 
+Or, to keep meetings with an locus url that is still active and any meeting without a locus url:
+```js
+let existingMeetings;
+// Sync Meetings From Server
+webex.meetings.syncMeetings({keepOnlyLocusMeetings: false}).then(() => {
+  // Existing meetings live in the meeting collection
+  existingMeetings = webex.meetings.getAllMeetings();
+});
+```
+
 ##### Get a Meeting
 
 ```js
@@ -117,7 +129,7 @@ webex.meetings.getMeetingByType('SIP_URI', sipUri);
 
 ```js
 webex.meetings.personalMeetingRoom; // the personal meeting room instance
-webex.meetings.reachability; // the reachability instance, not initialized until after setReachability is called
+webex.meetings.reachability; // the reachability instance
 webex.meetings.meetingCollection; // the collection of meetings instance
 webex.meetings.meetingInfo; // the meeting info instance
 ```
@@ -331,7 +343,6 @@ webex.meetings.on('meeting:added', (addedMeeting) => {
     addedMeeting.join().then(() => {});
   }
 ```
-
 ##### Reject an incoming meeting
 
 When listening to an added meeting, to determine if it is an "incoming" meeting, check the type property of the meeting:
@@ -457,6 +468,51 @@ audioOutputSelect.onchange = function () {
   attachSinkId(document.getElementById('remoteaudio'), audioOutputSelect.value);
 };
 ```
+##### Availabel joining options
+```
+/**
+   * Make a network request to join a meeting
+   * @param {Object} options
+   * @param {String} options.sipUri
+   * @param {String} options.deviceUrl
+   * @param {String} options.locusUrl
+   * @param {String} options.resourceId,
+   * @param {String} options.correlationId
+   * @param {boolean} options.ensureConversation
+   * @param {boolean} options.moderator
+   * @param {boolean} options.pin
+   * @param {boolean} options.moveToResource
+   * @param {Object} options.roapMessage
+   * @param {boolean} options.breakoutsSupported
+   * @param {String} options.locale,
+   * @param {Array} options.deviceCapabilities
+   * @param {boolean} options.liveAnnotationSupported
+   * @returns {Promise}
+   */
+```
+##### options.deviceCapabilities
+This option provides toggles that Locus service needs, and those toggles will control the performance or features of the meetings to be joined, see examples:
+###### Breakout Sessions
+```
+  if (breakoutsSupported) {
+    deviceCapabilities.push(BREAKOUTS.BREAKOUTS_SUPPORTED);
+  }
+```
+###### Live Annotation
+```
+  if (liveAnnotationSupported) {
+    deviceCapabilities.push(ANNOTATION.ANNOTATION_ON_SHARE_SUPPORTED);
+  }
+```
+###### Audio Disclaimer
+```
+const joinOptions = {
+    locale: 'en_UK', // audio disclaimer language
+    deviceCapabilities: ['SERVER_AUDIO_ANNOUNCEMENT_SUPPORTED'], // audio disclaimer toggle
+  };
+
+  const joinMeeting = () => { meeting.join(joinOptions)}
+```
 
 ##### Record
 
@@ -956,9 +1012,6 @@ meeting.on('media:ready', (media) => {
   if (media.type === 'remoteShare') {
     document.getElementById('sharevideo').srcObject = media.stream;
   }
-  if (media.type === 'localShare') {
-    document.getElementById('localshare').srcObject = media.stream;
-  }
 });
 ```
 
@@ -979,9 +1032,6 @@ meeting.on('media:stopped', (media) => {
   if (media.type === 'remoteAudio') {
     document.getElementById('remoteaudio').srcObject = null;
   }
-  if (media.type === 'localShare') {
-    document.getElementById('localshare').srcObject = null;
-  }
   if (media.type === 'remoteShare') {
     document.getElementById('sharevideo').srcObject = null;
   }

package/UPGRADING.md

@@ -25,7 +25,7 @@ When using the phone plugin, this was handled automatically for you via `webex.p
 With the meetings plugin, we provide the same method:
 
 ```js
-webex.meetings.register()
+webex.meetings.register();
 ```
 
 ## Dialing
@@ -56,7 +56,7 @@ await myMeeting.join();
 ### Joining a one-on-one meeting
 
 ```js
-let destination = "testuser@webex.bot";
+let destination = 'testuser@webex.bot';
 
 const myMeeting = await webex.meetings.create(destination);
 
@@ -92,7 +92,7 @@ const mediaSettings = {
   receiveShare: true,
   sendVideo: true,
   sendAudio: true,
-  sendShare: false
+  sendShare: false,
 };
 
 const mediaStreams = await meeting.getMediaStreams(mediaSettings);
@@ -117,7 +117,7 @@ Once you have your local streams and shares, you need to add the media to the me
 const mediaResponse = await meeting.addMedia({
   localShare,
   localStream,
-  mediaSettings
+  mediaSettings,
 });
 ```
 
@@ -130,20 +130,20 @@ Just like the phone plugin, the meeting object will emit events that the develop
 ```js
 myMeeting.on('media:ready', (media) => {
   // Handle media streams
-})
+});
 ```
 
 This event is emitted when a media stream is ready to be rendered. It contains an object with two properties:
 
-* `stream` the actual media stream that can be used in an html srcObject
-* `type` the type of stream that is ready (`local`, `remoteVideo`, etc)
+- `stream` the actual media stream that can be used in an html srcObject
+- `type` the type of stream that is ready (`local`, `remoteVideo`, etc)
 
 ### `media:stopped`
 
 ```js
 myMeeting.on('media:stopped', (media) => {
   // Remove media streams
-})
+});
 ```
 
 This event is emitted when a stream has stopped sending. It has a `type` property to know which media to remove from the DOM.
@@ -197,7 +197,7 @@ With a meeting object, you use these functions:
 const mediaStreams = await meeting.getMediaStreams(mediaSettings);
 const [localStream, localShare] = mediaStreams;
 // Then, update share
-meeting.updateShare({sendShare: true, receiveShare:true, stream: localShare})
+meeting.updateShare({sendShare: true, receiveShare: true, stream: localShare});
 ```
 
 ### Stop Sending Share

package/browsers.js

@@ -4,7 +4,6 @@
 
 // eslint-disable-next-line strict
 
-
 /* eslint camelcase: [0] */
 module.exports = function createBrowsers() {
   if (process.env.SC_TUNNEL_IDENTIFIER || process.env.SAUCE) {
@@ -19,14 +18,14 @@ module.exports = function createBrowsers() {
           args: [
             '--disable-features=WebRtcHideLocalIpsWithMdns',
             '--use-fake-device-for-media-stream',
-            '--use-fake-ui-for-media-stream'
-          ]
+            '--use-fake-ui-for-media-stream',
+          ],
         },
         flags: [
           '--disable-features=WebRtcHideLocalIpsWithMdns',
           '--use-fake-device-for-media-stream',
-          '--use-fake-ui-for-media-stream'
-        ]
+          '--use-fake-ui-for-media-stream',
+        ],
       },
       sl_edge_latest_Win_10: {
         base: 'SauceLabs',
@@ -38,9 +37,9 @@ module.exports = function createBrowsers() {
           args: [
             '--disable-features=WebRtcHideLocalIpsWithMdns',
             '--use-fake-device-for-media-stream',
-            '--use-fake-ui-for-media-stream'
-          ]
-        }
+            '--use-fake-ui-for-media-stream',
+          ],
+        },
       },
       // sl_firefox_latest_linux: {
       //   base: 'SauceLabs',
@@ -54,8 +53,8 @@ module.exports = function createBrowsers() {
         browserName: 'Safari',
         version: 'latest',
         'webkit:WebRTC': {
-          DisableInsecureMediaCapture: true
-        }
+          DisableInsecureMediaCapture: true,
+        },
       },
       sl_firefox_macOS_Catalina: {
         base: 'SauceLabs',
@@ -63,10 +62,7 @@ module.exports = function createBrowsers() {
         browserName: 'Firefox',
         extendedDebugging: true,
         'moz:firefoxOptions': {
-          args: [
-            '-start-debugger-server',
-            '9222'
-          ],
+          args: ['-start-debugger-server', '9222'],
           prefs: {
             'devtools.chrome.enabled': true,
             'devtools.debugger.prompt-connection': false,
@@ -76,10 +72,10 @@ module.exports = function createBrowsers() {
             'media.getusermedia.screensharing.enabled': true,
             'media.navigator.permission.disabled': true,
             'media.navigator.streams.fake': true,
-            'media.peerconnection.video.h264_enabled': true
-          }
-        }
-      }
+            'media.peerconnection.video.h264_enabled': true,
+          },
+        },
+      },
       // sl_firefox_latest_win7: {
       //   base: `SauceLabs`,
       //   platform: `Windows 7`,
@@ -97,17 +93,16 @@ module.exports = function createBrowsers() {
         'media.getusermedia.screensharing.enabled': true,
         'media.navigator.permission.disabled': true,
         'media.navigator.streams.fake': true,
-        'media.peerconnection.video.h264_enabled': true
-      }
+        'media.peerconnection.video.h264_enabled': true,
+      },
     },
     ChromeH264: {
       base: 'ChromeHeadless',
       flags: [
         '--disable-features=WebRtcHideLocalIpsWithMdns',
         '--use-fake-device-for-media-stream',
-        '--use-fake-ui-for-media-stream'
-      ]
-    }
+        '--use-fake-ui-for-media-stream',
+      ],
+    },
   };
 };
-

package/dist/annotation/annotation.types.js

@@ -0,0 +1,7 @@
+"use strict";
+
+var _Object$defineProperty = require("@babel/runtime-corejs2/core-js/object/define-property");
+_Object$defineProperty(exports, "__esModule", {
+  value: true
+});
+//# sourceMappingURL=annotation.types.js.map

package/dist/annotation/annotation.types.js.map

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

package/dist/annotation/constants.js

@@ -0,0 +1,49 @@
+"use strict";
+
+var _Object$defineProperty = require("@babel/runtime-corejs2/core-js/object/define-property");
+_Object$defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.EVENT_TRIGGERS = exports.ANNOTATION_STATUS = exports.ANNOTATION_RESOURCE_TYPE = exports.ANNOTATION_REQUEST_TYPE = exports.ANNOTATION_RELAY_TYPES = exports.ANNOTATION_POLICY = exports.ANNOTATION_ACTION_TYPE = exports.ANNOTATION = void 0;
+var EVENT_TRIGGERS = {
+  ANNOTATION_STROKE_DATA: 'annotation:strokeData',
+  ANNOTATION_COMMAND: 'annotation:command'
+};
+exports.EVENT_TRIGGERS = EVENT_TRIGGERS;
+var ANNOTATION_RESOURCE_TYPE = 'AnnotationOnShare';
+exports.ANNOTATION_RESOURCE_TYPE = ANNOTATION_RESOURCE_TYPE;
+var ANNOTATION_RELAY_TYPES = {
+  ANNOTATION_CLIENT: 'annotation.client'
+};
+exports.ANNOTATION_RELAY_TYPES = ANNOTATION_RELAY_TYPES;
+var ANNOTATION_STATUS = {
+  NO_ANNOTATION: 'NO_ANNOTATION',
+  RUNNING_ANNOTATION: 'RUNNING_ANNOTATION'
+};
+exports.ANNOTATION_STATUS = ANNOTATION_STATUS;
+var ANNOTATION_POLICY;
+exports.ANNOTATION_POLICY = ANNOTATION_POLICY;
+(function (ANNOTATION_POLICY) {
+  ANNOTATION_POLICY["ANYONE_CAN_ANNOTATE"] = "AnyoneCanAnnotate";
+  ANNOTATION_POLICY["APPROVAL"] = "Approval";
+  ANNOTATION_POLICY["ANNOTATION_NOT_ALLOWED"] = "AnnotationNotAllowed";
+})(ANNOTATION_POLICY || (exports.ANNOTATION_POLICY = ANNOTATION_POLICY = {}));
+var ANNOTATION_REQUEST_TYPE = {
+  ANNOTATION_MESSAGE: 'annotation_message'
+};
+exports.ANNOTATION_REQUEST_TYPE = ANNOTATION_REQUEST_TYPE;
+var ANNOTATION_ACTION_TYPE;
+exports.ANNOTATION_ACTION_TYPE = ANNOTATION_ACTION_TYPE;
+(function (ANNOTATION_ACTION_TYPE) {
+  ANNOTATION_ACTION_TYPE["REQUESTED"] = "REQUESTED";
+  ANNOTATION_ACTION_TYPE["ACCEPTED"] = "ACCEPTED";
+  ANNOTATION_ACTION_TYPE["DECLINED"] = "DECLINED";
+  ANNOTATION_ACTION_TYPE["OFFERED"] = "OFFERED";
+  ANNOTATION_ACTION_TYPE["CANCELED"] = "CANCELED";
+  ANNOTATION_ACTION_TYPE["EXPIRED"] = "EXPIRED";
+  ANNOTATION_ACTION_TYPE["REVOKED"] = "REVOKED";
+  ANNOTATION_ACTION_TYPE["CLOSED"] = "CLOSED";
+})(ANNOTATION_ACTION_TYPE || (exports.ANNOTATION_ACTION_TYPE = ANNOTATION_ACTION_TYPE = {}));
+var ANNOTATION = 'annotation';
+exports.ANNOTATION = ANNOTATION;
+//# sourceMappingURL=constants.js.map

package/dist/annotation/constants.js.map

@@ -0,0 +1 @@
+{"version":3,"names":["EVENT_TRIGGERS","ANNOTATION_STROKE_DATA","ANNOTATION_COMMAND","ANNOTATION_RESOURCE_TYPE","ANNOTATION_RELAY_TYPES","ANNOTATION_CLIENT","ANNOTATION_STATUS","NO_ANNOTATION","RUNNING_ANNOTATION","ANNOTATION_POLICY","ANNOTATION_REQUEST_TYPE","ANNOTATION_MESSAGE","ANNOTATION_ACTION_TYPE","ANNOTATION"],"sources":["constants.ts"],"sourcesContent":["export const EVENT_TRIGGERS = {\n  ANNOTATION_STROKE_DATA: 'annotation:strokeData',\n  ANNOTATION_COMMAND: 'annotation:command',\n};\nexport const ANNOTATION_RESOURCE_TYPE = 'AnnotationOnShare';\nexport const ANNOTATION_RELAY_TYPES = {\n  ANNOTATION_CLIENT: 'annotation.client',\n};\n\nexport const ANNOTATION_STATUS = {\n  NO_ANNOTATION: 'NO_ANNOTATION',\n  RUNNING_ANNOTATION: 'RUNNING_ANNOTATION',\n};\n\nexport enum ANNOTATION_POLICY {\n  ANYONE_CAN_ANNOTATE = 'AnyoneCanAnnotate',\n  APPROVAL = 'Approval',\n  ANNOTATION_NOT_ALLOWED = 'AnnotationNotAllowed',\n}\n\nexport const ANNOTATION_REQUEST_TYPE = {\n  ANNOTATION_MESSAGE: 'annotation_message',\n};\n\nexport const enum ANNOTATION_ACTION_TYPE {\n  REQUESTED = 'REQUESTED',\n  ACCEPTED = 'ACCEPTED',\n  DECLINED = 'DECLINED',\n  OFFERED = 'OFFERED',\n  CANCELED = 'CANCELED',\n  EXPIRED = 'EXPIRED',\n  REVOKED = 'REVOKED',\n  CLOSED = 'CLOSED',\n}\n\nexport const ANNOTATION = 'annotation';\n"],"mappings":";;;;;;;AAAO,IAAMA,cAAc,GAAG;EAC5BC,sBAAsB,EAAE,uBAAuB;EAC/CC,kBAAkB,EAAE;AACtB,CAAC;AAAC;AACK,IAAMC,wBAAwB,GAAG,mBAAmB;AAAC;AACrD,IAAMC,sBAAsB,GAAG;EACpCC,iBAAiB,EAAE;AACrB,CAAC;AAAC;AAEK,IAAMC,iBAAiB,GAAG;EAC/BC,aAAa,EAAE,eAAe;EAC9BC,kBAAkB,EAAE;AACtB,CAAC;AAAC;AAAA,IAEUC,iBAAiB;AAAA;AAAA,WAAjBA,iBAAiB;EAAjBA,iBAAiB;EAAjBA,iBAAiB;EAAjBA,iBAAiB;AAAA,GAAjBA,iBAAiB,iCAAjBA,iBAAiB;AAMtB,IAAMC,uBAAuB,GAAG;EACrCC,kBAAkB,EAAE;AACtB,CAAC;AAAC;AAAA,IAEgBC,sBAAsB;AAAA;AAAA,WAAtBA,sBAAsB;EAAtBA,sBAAsB;EAAtBA,sBAAsB;EAAtBA,sBAAsB;EAAtBA,sBAAsB;EAAtBA,sBAAsB;EAAtBA,sBAAsB;EAAtBA,sBAAsB;EAAtBA,sBAAsB;AAAA,GAAtBA,sBAAsB,sCAAtBA,sBAAsB;AAWjC,IAAMC,UAAU,GAAG,YAAY;AAAC"}