@webex/plugin-meetings 3.6.0 → 3.7.0-next.10

package/test/unit/spec/webinar/index.ts

@@ -29,32 +29,145 @@ describe('plugin-meetings', () => {
             });
         });
 
-        describe('#webcastUrlUpdate', () => {
-            it('sets the webcast url', () => {
-                webinar.webcastUrlUpdate('newUrl');
+        describe('#updateWebcastUrl', () => {
+            it('sets the webcast instance url', () => {
+                webinar.updateWebcastUrl({resources: {webcastInstance: {url:'newUrl'}}});
 
-                assert.equal(webinar.webcastUrl, 'newUrl');
+                assert.equal(webinar.webcastInstanceUrl, 'newUrl');
             });
         });
 
-        describe('#webinarAttendeesSearchingUrlUpdate', () => {
-            it('sets the webinarAttendeesSearching url', () => {
-                webinar.webinarAttendeesSearchingUrlUpdate('newUrl');
 
-                assert.equal(webinar.webinarAttendeesSearchingUrl, 'newUrl');
-            });
+        describe('#updateCanManageWebcast', () => {
+          it('sets the webcast instance url when valid', () => {
+            webinar.updateWebcastUrl({resources: {webcastInstance: {url:'newUrl'}}});
+            assert.equal(webinar.webcastInstanceUrl, 'newUrl', 'webcast instance URL should be updated');
+          });
+
+          it('handles missing resources gracefully', () => {
+              webinar.updateWebcastUrl({});
+              assert.isUndefined(webinar.webcastInstanceUrl, 'webcast instance URL should be undefined');
+          });
+
+          it('handles missing webcastInstance gracefully', () => {
+              webinar.updateWebcastUrl({resources: {}});
+              assert.isUndefined(webinar.webcastInstanceUrl, 'webcast instance URL should be undefined');
+          });
+
+          it('handles missing URL gracefully', () => {
+              webinar.updateWebcastUrl({resources: {webcastInstance: {}}});
+              assert.isUndefined(webinar.webcastInstanceUrl, 'webcast instance URL should be undefined');
+          });
         });
 
-        describe('#updateCanManageWebcast', () => {
-          it('update canManageWebcast', () => {
-            webinar.updateCanManageWebcast(true);
+      describe('#updateRoleChanged', () => {
+        it('updates roles when promoted from attendee to panelist', () => {
+          const payload = {
+            oldRoles: ['ATTENDEE'],
+            newRoles: ['PANELIST']
+          };
+
+          const result = webinar.updateRoleChanged(payload);
 
-            assert.equal(webinar.canManageWebcast, true);
+          assert.equal(webinar.selfIsPanelist, true, 'self should be a panelist');
+          assert.equal(webinar.selfIsAttendee, false, 'self should not be an attendee');
+          assert.equal(webinar.canManageWebcast, false, 'self should not have manage webcast capability');
+          assert.equal(result.isPromoted, true, 'should indicate promotion');
+          assert.equal(result.isDemoted, false, 'should not indicate demotion');
+        });
 
-            webinar.updateCanManageWebcast(false);
+        it('updates roles when demoted from panelist to attendee', () => {
+          const payload = {
+            oldRoles: ['PANELIST'],
+            newRoles: ['ATTENDEE']
+          };
 
-            assert.equal(webinar.canManageWebcast, false);
+          const result = webinar.updateRoleChanged(payload);
+
+          assert.equal(webinar.selfIsPanelist, false, 'self should not be a panelist');
+          assert.equal(webinar.selfIsAttendee, true, 'self should be an attendee');
+          assert.equal(webinar.canManageWebcast, false, 'self should not have manage webcast capability');
+          assert.equal(result.isPromoted, false, 'should not indicate promotion');
+          assert.equal(result.isDemoted, true, 'should indicate demotion');
+        });
+
+        it('updates roles when promoted to moderator', () => {
+          const payload = {
+            oldRoles: ['PANELIST'],
+            newRoles: ['MODERATOR']
+          };
+
+          const result = webinar.updateRoleChanged(payload);
+
+          assert.equal(webinar.selfIsPanelist, false, 'self should not be a panelist');
+          assert.equal(webinar.selfIsAttendee, false, 'self should not be an attendee');
+          assert.equal(webinar.canManageWebcast, true, 'self should have manage webcast capability');
+          assert.equal(result.isPromoted, false, 'should not indicate promotion');
+          assert.equal(result.isDemoted, false, 'should not indicate demotion');
+        });
+
+        it('updates roles when unchanged (remains as panelist)', () => {
+          const payload = {
+            oldRoles: ['PANELIST'],
+            newRoles: ['PANELIST']
+          };
+
+          const result = webinar.updateRoleChanged(payload);
+
+          assert.equal(webinar.selfIsPanelist, true, 'self should remain a panelist');
+          assert.equal(webinar.selfIsAttendee, false, 'self should not be an attendee');
+          assert.equal(webinar.canManageWebcast, false, 'self should not have manage webcast capability');
+          assert.equal(result.isPromoted, false, 'should not indicate promotion');
+          assert.equal(result.isDemoted, false, 'should not indicate demotion');
+        });
+      });
+
+      describe("#setPracticeSessionState", () => {
+        [true, false].forEach((enabled) => {
+          it(`sends a PATCH request to ${enabled ? "enable" : "disable"} the practice session`, async () => {
+            const result = await webinar.setPracticeSessionState(enabled);
+            assert.calledOnce(webex.request);
+            assert.calledWith(webex.request, {
+              method: "PATCH",
+              uri: `${webinar.locusUrl}/controls`,
+              body: {
+                practiceSession: { enabled }
+              }
+            });
+            assert.equal(result, "REQUEST_RETURN_VALUE", "should return the resolved value from the request");
           });
         });
+
+        it('handles API call failures gracefully', async () => {
+          webex.request.rejects(new Error('API_ERROR'));
+          const errorLogger = sinon.stub(LoggerProxy.logger, 'error');
+
+          try {
+            await webinar.setPracticeSessionState(true);
+            assert.fail('setPracticeSessionState should throw an error');
+          } catch (error) {
+            assert.equal(error.message, 'API_ERROR', 'should throw the correct error');
+            assert.calledOnce(errorLogger);
+            assert.calledWith(errorLogger, 'Meeting:webinar#setPracticeSessionState failed', sinon.match.instanceOf(Error));
+          }
+
+          errorLogger.restore();
+        });
+      });
+
+      describe('#updatePracticeSessionStatus', () => {
+        it('sets PS state true', () => {
+          webinar.updatePracticeSessionStatus({enabled: true});
+
+          assert.equal(webinar.practiceSessionEnabled, true);
+        });
+        it('sets PS state true', () => {
+          webinar.updatePracticeSessionStatus({enabled: false});
+
+          assert.equal(webinar.practiceSessionEnabled, false);
+        });
+      });
+
+
     })
 })

package/dist/annotation/annotation.types.d.ts

@@ -1,42 +0,0 @@
-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

@@ -1,31 +0,0 @@
-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

@@ -1,117 +0,0 @@
-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

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

package/dist/breakouts/collection.d.ts

@@ -1,5 +0,0 @@
-/*!
- * 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

@@ -1,15 +0,0 @@
-/**
- * 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

@@ -1,8 +0,0 @@
-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

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

package/dist/breakouts/request.d.ts

@@ -1,22 +0,0 @@
-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

@@ -1,15 +0,0 @@
-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

@@ -1,9 +0,0 @@
-/// <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

@@ -1,48 +0,0 @@
-/**
- * @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

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

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

@@ -1,15 +0,0 @@
-/**
- * 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

@@ -1,16 +0,0 @@
-/**
- * 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

@@ -1,17 +0,0 @@
-/**
- * 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

@@ -1,15 +0,0 @@
-/**
- * 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

@@ -1,14 +0,0 @@
-/**
- * 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/password-error.d.ts

@@ -1,15 +0,0 @@
-/**
- * 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

@@ -1,14 +0,0 @@
-/**
- * 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);
-}