@webex/plugin-meetings 2.59.8 → 2.60.0-next.10

package/README.md

@@ -117,7 +117,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 +331,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 +456,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 +1000,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 +1020,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/dist/annotation/annotation.types.d.ts

@@ -0,0 +1,42 @@
+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 {
+    acceptRequest: (approval: any) => undefined | Promise<void>;
+    declineRequest: (approval: any) => undefined | Promise<void>;
+    closeAnnotation: (requestData: RequestData) => undefined | Promise<void>;
+    approveAnnotation: (requestData: RequestData) => undefined | Promise<void>;
+    cancelApproveAnnotation: (requestData: RequestData, approval: any) => undefined | Promise<void>;
+    sendStrokeData: (strokeData: StrokeData) => void;
+    approvalUrlUpdate: (approvalUrl: string) => void;
+    locusUrlUpdate: (locusUrl: string) => void;
+}
+export type { StrokeData, RequestData, CommandRequestBody, IAnnotationChannel, AnnotationInfo };

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.d.ts

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

package/dist/annotation/constants.js

@@ -0,0 +1,41 @@
+"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 = exports.EVENT_TRIGGERS = {
+  ANNOTATION_STROKE_DATA: 'annotation:strokeData',
+  ANNOTATION_COMMAND: 'annotation:command'
+};
+var ANNOTATION_RESOURCE_TYPE = exports.ANNOTATION_RESOURCE_TYPE = 'AnnotationOnShare';
+var ANNOTATION_RELAY_TYPES = exports.ANNOTATION_RELAY_TYPES = {
+  ANNOTATION_CLIENT: 'annotation.client'
+};
+var ANNOTATION_STATUS = exports.ANNOTATION_STATUS = {
+  NO_ANNOTATION: 'NO_ANNOTATION',
+  RUNNING_ANNOTATION: 'RUNNING_ANNOTATION'
+};
+var ANNOTATION_POLICY = exports.ANNOTATION_POLICY = /*#__PURE__*/function (ANNOTATION_POLICY) {
+  ANNOTATION_POLICY["ANYONE_CAN_ANNOTATE"] = "AnyoneCanAnnotate";
+  ANNOTATION_POLICY["APPROVAL"] = "Approval";
+  ANNOTATION_POLICY["ANNOTATION_NOT_ALLOWED"] = "AnnotationNotAllowed";
+  return ANNOTATION_POLICY;
+}({});
+var ANNOTATION_REQUEST_TYPE = exports.ANNOTATION_REQUEST_TYPE = {
+  ANNOTATION_MESSAGE: 'annotation_message'
+};
+var ANNOTATION_ACTION_TYPE = exports.ANNOTATION_ACTION_TYPE = /*#__PURE__*/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";
+  return ANNOTATION_ACTION_TYPE;
+}({});
+var ANNOTATION = exports.ANNOTATION = 'annotation';
+//# sourceMappingURL=constants.js.map

package/dist/annotation/constants.js.map

@@ -0,0 +1 @@
+{"version":3,"names":["EVENT_TRIGGERS","exports","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,GAAAC,OAAA,CAAAD,cAAA,GAAG;EAC5BE,sBAAsB,EAAE,uBAAuB;EAC/CC,kBAAkB,EAAE;AACtB,CAAC;AACM,IAAMC,wBAAwB,GAAAH,OAAA,CAAAG,wBAAA,GAAG,mBAAmB;AACpD,IAAMC,sBAAsB,GAAAJ,OAAA,CAAAI,sBAAA,GAAG;EACpCC,iBAAiB,EAAE;AACrB,CAAC;AAEM,IAAMC,iBAAiB,GAAAN,OAAA,CAAAM,iBAAA,GAAG;EAC/BC,aAAa,EAAE,eAAe;EAC9BC,kBAAkB,EAAE;AACtB,CAAC;AAAC,IAEUC,iBAAiB,GAAAT,OAAA,CAAAS,iBAAA,0BAAjBA,iBAAiB;EAAjBA,iBAAiB;EAAjBA,iBAAiB;EAAjBA,iBAAiB;EAAA,OAAjBA,iBAAiB;AAAA;AAMtB,IAAMC,uBAAuB,GAAAV,OAAA,CAAAU,uBAAA,GAAG;EACrCC,kBAAkB,EAAE;AACtB,CAAC;AAAC,IAEgBC,sBAAsB,GAAAZ,OAAA,CAAAY,sBAAA,0BAAtBA,sBAAsB;EAAtBA,sBAAsB;EAAtBA,sBAAsB;EAAtBA,sBAAsB;EAAtBA,sBAAsB;EAAtBA,sBAAsB;EAAtBA,sBAAsB;EAAtBA,sBAAsB;EAAtBA,sBAAsB;EAAA,OAAtBA,sBAAsB;AAAA;AAWjC,IAAMC,UAAU,GAAAb,OAAA,CAAAa,UAAA,GAAG,YAAY"}

package/dist/annotation/index.d.ts

@@ -0,0 +1,117 @@
+import { WebexPlugin } from '@webex/webex-core';
+import { StrokeData, RequestData, IAnnotationChannel } from './annotation.types';
+/**
+ * @description Annotation to handle LLM and Mercury message and locus API
+ * @class
+ */
+declare class AnnotationChannel extends WebexPlugin implements IAnnotationChannel {
+    namespace: string;
+    private seqNum;
+    hasSubscribedToEvents: boolean;
+    approvalUrl: string;
+    locusUrl: string;
+    deviceUrl: string;
+    /**
+     * Initializes annotation module
+     */
+    constructor(...args: any[]);
+    /**
+     * Process Stroke Data
+     * @param {object}  data
+     * @returns {void}
+     */
+    private processStrokeMessage;
+    /** bind all events from mercury
+     * @param {Object} e
+     * @returns {undefined}
+     */
+    private eventCommandProcessor;
+    /** bind all events from llm
+     * @param {Object} e
+     * @returns {undefined}
+     */
+    private eventDataProcessor;
+    /**
+     * Listen to websocket messages
+     * @returns {undefined}
+     */
+    private listenToEvents;
+    /**
+     * set locusUrl
+     * @param {string} locusUrl
+     * @returns {void}
+     */
+    locusUrlUpdate(locusUrl: string): void;
+    /**
+     * set approved url
+     * @param {string} approvalUrl
+     * @returns {void}
+     */
+    approvalUrlUpdate(approvalUrl: string): void;
+    /**
+     * accept request
+     * @param {object} approval
+     * @returns {Promise}
+     */
+    acceptRequest(approval: any): any;
+    /**
+     * presenter declined request annotation
+     * @param {approval} approval
+     * @returns {Promise}
+     */
+    declineRequest(approval: any): any;
+    /**
+     * request approved annotation
+     * @param {RequestData} requestData
+     * @returns {Promise}
+     */
+    approveAnnotation(requestData: RequestData): Promise<void>;
+    /**
+     * cancel approved annotation
+     * @param {object} requestData
+     * @param {object} approval
+     * @returns {Promise}
+     */
+    cancelApproveAnnotation(requestData: RequestData, approval: any): any;
+    /**
+     * close annotation
+     * @param {object} requestData
+     * @returns {Promise}
+     */
+    closeAnnotation(requestData: RequestData): Promise<void>;
+    /**
+     * send annotation command
+     * @param {ANNOTATION_ACTION_TYPE} actionType
+     * @param {RequestData} requestData
+     * @returns {Promise}
+     */
+    private sendAnnotationAction;
+    /**
+     * decrypt data
+     * @param {string} encryptionKeyUrl
+     * @param {string} content encrypted content
+     * @returns {string} decrypted content
+     */
+    private decryptContent;
+    /**
+     * encrypt data
+     * @param {string} encryptionKeyUrl
+     * @param {string} content original content
+     * @returns {string} encrypted content
+     */
+    private encryptContent;
+    /**
+     * Sends stroke data to presenter
+     * @param {StrokeData} strokeData
+     * @returns {void}
+     */
+    sendStrokeData: (strokeData: StrokeData) => void;
+    /**
+     * private encrypted the strokes data
+     * @param {string} encryptedContent
+     * @param {StrokeData} strokeData
+     * @returns {void}
+     */
+    private publishEncrypted;
+}
+export default AnnotationChannel;