@webex/plugin-meetings 3.8.1-next.8 → 3.8.1

package/README.md

@@ -30,9 +30,9 @@ This is a plugin for the Cisco Webex JS SDK . Please see our [developer portal](
 
 ## API Docs and Sample App
 
-API Docs: <https://webex.github.io/webex-js-sdk/api/>
-Hosted Sample App: <https://webex.github.io/webex-js-sdk/samples/browser-plugin-meetings/>
-See <https://github.com/webex/webex-js-sdk/tree/master/docs/samples/browser-plugin-meetings> for the sample app code vs the readme
+API Docs: https://webex.github.io/webex-js-sdk/api/
+Hosted Sample App: https://webex.github.io/webex-js-sdk/samples/browser-plugin-meetings/
+See https://github.com/webex/webex-js-sdk/tree/master/docs/samples/browser-plugin-meetings for the sample app code vs the readme
 
 #### Device Registration
 
@@ -110,7 +110,6 @@ 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
@@ -344,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:
@@ -470,9 +468,7 @@ audioOutputSelect.onchange = function () {
   attachSinkId(document.getElementById('remoteaudio'), audioOutputSelect.value);
 };
 ```
-
-##### Available joining options
-
+##### Availabel joining options
 ```
 /**
    * Make a network request to join a meeting
@@ -494,29 +490,21 @@ audioOutputSelect.onchange = function () {
    * @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
@@ -707,7 +695,7 @@ webex.meetings.personalMeetingRoom.get().then((pmr) => {
 
 #### Usage of Webex Devices
 
-For details on how to use the devices see <https://github.com/webex/webex-js-sdk/tree/master/packages/node_modules/%40webex/plugin-device-manager>
+For details on how to use the devices see https://github.com/webex/webex-js-sdk/tree/master/packages/node_modules/%40webex/plugin-device-manager
 
 ##### Leave a Meeting Using a Device
 
@@ -797,7 +785,7 @@ meeting.reconnect();
 
 #### Scheduled Meetings
 
-For scheduled meetings see <https://github.com/webex/webex-js-sdk/tree/master/packages/node_modules/%40webex/internal-plugin-calendar>
+For scheduled meetings see https://github.com/webex/webex-js-sdk/tree/master/packages/node_modules/%40webex/internal-plugin-calendar
 
 #### Member
 
@@ -1199,14 +1187,13 @@ meeting.members.on(...)
 ```
 
 There are several events submitted by this package that you can subscribe to.
-
-| Event Name               | Description                                                                       |
-| ------------------------ | --------------------------------------------------------------------------------- |
-| `members:update`         | Fired when a member in the collection has been updated                            |
+| Event Name | Description |
+|---|---|
+| `members:update` | Fired when a member in the collection has been updated |
 | `members:content:update` | Fired when a member in the collection has a changed content stream (share screen) |
-| `members:host:update`    | Fired when a member in the collection has a changed host value                    |
-| `members:self:update`    | Fired when a member in the collection has a changed self value                    |
-| ---                      | ---                                                                               |
+| `members:host:update` | Fired when a member in the collection has a changed host value |
+| `members:self:update` | Fired when a member in the collection has a changed self value |
+|---|---|
 
 `members:update` has the following payload
 
@@ -1265,4 +1252,4 @@ Pull requests welcome. Please see [CONTRIBUTING.md](https://github.com/webex/web
 
 ## License
 
-© 2016-2025 Cisco and/or its affiliates. All Rights Reserved.
+© 2016-2020 Cisco and/or its affiliates. All Rights Reserved.

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/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/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;

package/dist/breakouts/breakout.d.ts

@@ -0,0 +1,8 @@
+/*!
+ * Copyright (c) 2015-2023 Cisco Systems, Inc. See LICENSE file.
+ */
+/**
+ * @class
+ */
+declare const Breakout: any;
+export default Breakout;

package/dist/breakouts/breakout.js

@@ -209,7 +209,7 @@ var Breakout = _webexCore.WebexPlugin.extend({
       sessionId: this.sessionId
     });
   },
-  version: "3.8.1-next.8"
+  version: "3.8.1"
 });
 var _default = exports.default = Breakout;
 //# sourceMappingURL=breakout.js.map

package/dist/breakouts/collection.d.ts

@@ -0,0 +1,5 @@
+/*!
+ * Copyright (c) 2015-2023 Cisco Systems, Inc. See LICENSE file.
+ */
+declare const BreakoutCollection: any;
+export default BreakoutCollection;

package/dist/breakouts/edit-lock-error.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Extended Error object to signify breakout related errors
+ */
+export default class BreakoutEditLockedError extends Error {
+    code: any;
+    error: any;
+    sdkMessage: any;
+    /**
+     *
+     * @constructor
+     * @param {String} [message]
+     * @param {Object} [error]
+     */
+    constructor(message?: string, error?: any);
+}

package/dist/breakouts/events.d.ts

@@ -0,0 +1,8 @@
+import { ClientEvent } from '@webex/internal-plugin-metrics';
+declare const breakoutEvent: {
+    onBreakoutMoveRequest: (eventInfo: any, submitClientEvent: any) => void;
+    onBreakoutMoveResponse: (eventInfo: any, submitClientEvent: any) => void;
+    onBreakoutJoinResponse: (eventInfo: any, submitClientEvent: any) => void;
+    postMoveCallAnalyzer: (event: ClientEvent['name'], eventInfo: any, submitClientEvent: any) => void;
+};
+export default breakoutEvent;

package/dist/breakouts/index.d.ts

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

package/dist/breakouts/index.js

@@ -1110,7 +1110,7 @@ var Breakouts = _webexCore.WebexPlugin.extend({
       this.trigger(_constants.BREAKOUTS.EVENTS.ASK_RETURN_TO_MAIN);
     }
   },
-  version: "3.8.1-next.8"
+  version: "3.8.1"
 });
 var _default = exports.default = Breakouts;
 //# sourceMappingURL=index.js.map

package/dist/breakouts/request.d.ts

@@ -0,0 +1,22 @@
+import { StatelessWebexPlugin } from '@webex/webex-core';
+/**
+ * @class BreakoutRequest
+ */
+export default class BreakoutRequest extends StatelessWebexPlugin {
+    /**
+     * Broadcast message to all breakout session's participants
+     * @param {String} url
+     * @param {String} message
+     * @param {Object} options
+     * @param {string} groupId
+     * @param {string} sessionId
+     * @returns {Promise}
+     */
+    broadcast({ url, message, options, groupId, sessionId, }: {
+        url: string;
+        message: string;
+        options?: object;
+        groupId: string;
+        sessionId?: string;
+    }): any;
+}

package/dist/breakouts/utils.d.ts

@@ -0,0 +1,15 @@
+export declare const getBroadcastRoles: (options: any) => string[];
+/**
+ * Deals with all kinds of errors of breakout service
+ * @param {object} error // one of the breakout service error
+ * @param {string} position // position of the error occur
+ * @returns {object}
+ */
+export declare const boServiceErrorHandler: (error: any, position: string) => any;
+/**
+ *
+ * @param {object} breakout
+ * @param {string} newSessionType
+ * @returns {boolean}
+ */
+export declare const isSessionTypeChangedFromSessionToMain: (breakout: any, newSessionType: any) => boolean;

package/dist/common/browser-detection.d.ts

@@ -0,0 +1,9 @@
+/// <reference types="lodash" />
+declare const _default: ((agent?: any) => {
+    getOSName: () => any;
+    getOSVersion: () => any;
+    getBrowserName: () => any;
+    getBrowserVersion: () => any;
+    isBrowser: (name: any) => boolean;
+}) & import("lodash").MemoizedFunction;
+export default _default;

package/dist/common/collection.d.ts

@@ -0,0 +1,48 @@
+/**
+ * @class Collection
+ */
+export default class Collection {
+    namespace: string;
+    propertyName: string;
+    /**
+     * @param {String} property
+     * @memberof Collection
+     */
+    constructor(property: string);
+    /**
+     * @param {String} id ID of the thing stuffed into the collection at id location
+     * @returns {Any} returns whatever is being stuffed into the collection
+     * @public
+     * @memberof Collection
+     */
+    get(id: string): any;
+    /**
+     * @param {String} id the id of the meeting info instance to add to the collection
+     * @param {Any} value the thing to set in the collection
+     * @returns {Any} returns the thing just put in the collection
+     * @public
+     * @memberof Collection
+     */
+    set(id: string, value: any): any;
+    /**
+     * remove the thing at the id
+     * @param {String} id ID of the thing you wish to delete from the collection
+     * @returns {undefined}
+     * @public
+     * @memberof Collection
+     */
+    delete(id: string): void;
+    /**
+     * @returns {Object} returns an object map of things stuffed into the collection
+     * @public
+     * @memberof Collection
+     */
+    getAll(): any;
+    /**
+     * @param {Object} set the replacement object
+     * @returns {Object} returns an object map of things stuffed into the collection
+     * @public
+     * @memberof Collection
+     */
+    setAll(set: object): any;
+}

package/dist/common/config.d.ts

@@ -0,0 +1,2 @@
+declare const StaticConfig: any;
+export default StaticConfig;

package/dist/common/errors/captcha-error.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Extended Error object to signify captcha related errors
+ */
+export default class CaptchaError extends Error {
+    code: any;
+    error: any;
+    sdkMessage: any;
+    /**
+     *
+     * @constructor
+     * @param {String} [message]
+     * @param {Object} [error]
+     */
+    constructor(message?: string, error?: any);
+}

package/dist/common/errors/intent-to-join.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Extended Error object to signify the intent to join for unclaimed PMR scenarios
+ */
+export default class IntentToJoinError extends Error {
+    code: any;
+    error: any;
+    joinIntentRequired: any;
+    sdkMessage: any;
+    /**
+     *
+     * @constructor
+     * @param {String} [message]
+     * @param {Object} [error]
+     */
+    constructor(message?: string, error?: any);
+}

package/dist/common/errors/join-meeting.d.ts

@@ -0,0 +1,17 @@
+/**
+ * Extended Error object to signify a join meeting error
+ */
+export default class JoinMeetingError extends Error {
+    code: any;
+    error: any;
+    joinOptions: any;
+    sdkMessage: any;
+    /**
+     *
+     * @constructor
+     * @param {Object} [options]
+     * @param {String} [message]
+     * @param {Object} [error]
+     */
+    constructor(options?: object, message?: string, error?: any);
+}

package/dist/common/errors/media.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Extended Error object for media errors
+ */
+export default class MediaError extends Error {
+    code: any;
+    error: any;
+    sdkMessage: any;
+    /**
+     *
+     * @constructor
+     * @param {String} [message]
+     * @param {Object} [error]
+     */
+    constructor(message?: string, error?: any);
+}

package/dist/common/errors/no-meeting-info.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Extended Error object for general parameter errors
+ */
+export default class NoMeetingInfoError extends Error {
+    code: any;
+    error: any;
+    sdkMessage: any;
+    /**
+     * @constructor
+     * @param {String} [message]
+     * @param {Object} [error]
+     */
+    constructor(message?: string, error?: any);
+}

package/dist/common/errors/parameter.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Extended Error object for general parameter errors
+ */
+export default class ParameterError extends Error {
+    sdkMessage: string;
+    error: null;
+    code: number;
+    /**
+     *
+     * @constructor
+     * @param {String} [message]
+     * @param {Object} [error]
+     */
+    constructor(message?: string, error?: any);
+}

package/dist/common/errors/password-error.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Extended Error object to signify password related errors
+ */
+export default class PasswordError extends Error {
+    code: any;
+    error: any;
+    sdkMessage: any;
+    /**
+     *
+     * @constructor
+     * @param {String} [message]
+     * @param {Object} [error]
+     */
+    constructor(message?: string, error?: any);
+}

package/dist/common/errors/permission.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Extended Error object for general parameter errors
+ */
+export default class PermissionError extends Error {
+    code: any;
+    error: any;
+    sdkMessage: any;
+    /**
+     * @constructor
+     * @param {String} [message]
+     * @param {Object} [error]
+     */
+    constructor(message?: string, error?: any);
+}

package/dist/common/errors/reclaim-host-role-error.d.ts

@@ -0,0 +1,60 @@
+/**
+ * Extended Error object for reclaim host role empty or wrong key
+ */
+export declare class ReclaimHostEmptyWrongKeyError extends Error {
+    sdkMessage: string;
+    error: null;
+    code: number;
+    /**
+     *
+     * @constructor
+     * @param {String} [message]
+     * @param {Object} [error]
+     */
+    constructor(message?: string, error?: any);
+}
+/**
+ * Extended Error object for reclaim host role not supported
+ */
+export declare class ReclaimHostNotSupportedError extends Error {
+    sdkMessage: string;
+    error: null;
+    code: number;
+    /**
+     *
+     * @constructor
+     * @param {String} [message]
+     * @param {Object} [error]
+     */
+    constructor(message?: string, error?: any);
+}
+/**
+ * Extended Error object for reclaim host role not allowed for other participants
+ */
+export declare class ReclaimHostNotAllowedError extends Error {
+    sdkMessage: string;
+    error: null;
+    code: number;
+    /**
+     *
+     * @constructor
+     * @param {String} [message]
+     * @param {Object} [error]
+     */
+    constructor(message?: string, error?: any);
+}
+/**
+ * Extended Error object for reclaim host role when user is host already
+ */
+export declare class ReclaimHostIsHostAlreadyError extends Error {
+    sdkMessage: string;
+    error: null;
+    code: number;
+    /**
+     *
+     * @constructor
+     * @param {String} [message]
+     * @param {Object} [error]
+     */
+    constructor(message?: string, error?: any);
+}