@webex/plugin-meetings 3.8.1 → 3.9.0-webinar5k.1

package/test/unit/spec/meeting/request.js

@@ -826,4 +826,75 @@ describe('plugin-meetings', () => {
       });
     });
   });
+
+  describe('#synchronizeStage', () => {
+    [
+      ['an unset stage', {overrideDefault: false}],
+      [
+        'a minimally set stage',
+        {
+          overrideDefault: true,
+          lockAttendeeViewOnStageOnly: false,
+          stageParameters: {
+            activeSpeakerProportion: 0.5,
+            showActiveSpeaker: {show: false, order: 0},
+            stageManagerType: 0,
+          },
+        },
+      ],
+      [
+        'a fully set stage',
+        {
+          overrideDefault: true,
+          lockAttendeeViewOnStageOnly: true,
+          stageParameters: {
+            activeSpeakerProportion: 0.6,
+            importantParticipants: [
+              {mainCsi: 11111111, participantId: uuidv4(), order: 1},
+              {mainCsi: 22222222, participantId: uuidv4(), order: 2},
+              {mainCsi: 33333333, participantId: uuidv4(), order: 3},
+              {mainCsi: 44444444, participantId: uuidv4(), order: 4},
+              {mainCsi: 55555555, participantId: uuidv4(), order: 5},
+              {mainCsi: 66666666, participantId: uuidv4(), order: 6},
+              {mainCsi: 77777777, participantId: uuidv4(), order: 7},
+              {mainCsi: 88888888, participantId: uuidv4(), order: 8},
+            ],
+            showActiveSpeaker: {show: true, order: 0},
+            stageManagerType: 7,
+          },
+          customLayouts: {
+            background: {url: `https://test.wbx2.com/background/${uuidv4()}.jpg`},
+            logo: {url: `https://test.wbx2.com/logo/${uuidv4()}.png`, position: 'UpperMiddle'},
+          },
+          nameLabelStyle: {
+            accentColor: '#00A3FF',
+            background: {color: 'rgba(0, 163, 255, 1)'},
+            border: {color: 'rgba(0, 163, 255, 1)'},
+            content: {
+              displayName: {color: 'rgba(255, 255, 255, 0.95)'},
+              subtitle: {color: 'rgba(255, 255, 255, 0.7)'},
+            },
+            decoration: {color: 'rgba(255, 255, 255, 0.95)'},
+            fadeOut: {delay: 15},
+            type: 'PrimaryInverted',
+          },
+        },
+      ],
+    ].forEach(([description, videoLayout]) => {
+      it(`sends request to synchronize the stage with ${description} video layout`, async () => {
+        const locusUrl = `https://locus-test.wbx2.com/locus/api/v1/loci/${uuidv4()}`;
+
+        const synchronizePromise = meetingsRequest.synchronizeStage(locusUrl, videoLayout);
+
+        assert.exists(synchronizePromise.then);
+        await synchronizePromise;
+
+        checkRequest({
+          method: 'PATCH',
+          uri: `${locusUrl}/controls`,
+          body: {videoLayout},
+        });
+      });
+    });
+  });
 });

package/test/unit/spec/members/index.js

@@ -176,6 +176,20 @@ describe('plugin-meetings', () => {
         assert.calledOnce(MembersUtil.isInvalidInvitee);
         assert.isFalse(MembersUtil.isInvalidInvitee({email: 'sip:test@cisco.com'}), 'SIP email should be valid');
       });
+
+      it('should accept valid phone with isInternalNumber', async () => {
+        sandbox.spy(MembersUtil, 'isInvalidInvitee');
+
+        const members = createMembers({url: true});
+        
+        await members.addMember({phoneNumber: '+8618578675309', isInternalNumber: false});
+        
+        assert.calledOnce(MembersUtil.isInvalidInvitee);
+        assert.isFalse(MembersUtil.isInvalidInvitee({ phoneNumber: '+8618578675309', isInternalNumber: false }));
+        assert.isTrue(MembersUtil.isInvalidInvitee({ phoneNumber: '18578675309', isInternalNumber: false }));
+        assert.isFalse(MembersUtil.isInvalidInvitee({phoneNumber: '18578675309', isInternalNumber: true}));
+        assert.isTrue(MembersUtil.isInvalidInvitee({phoneNumber: '+8618578675309', isInternalNumber: true}));
+      });
     });
 
     describe('#admitMembers', () => {
@@ -293,7 +307,7 @@ describe('plugin-meetings', () => {
           },
           EVENT_TRIGGERS.MEMBERS_UPDATE,
           {
-            delta: {added: [], updated: []},
+            delta: {added: [], updated: [], removedIds: []},
             full: {},
             isReplace: true,
           }
@@ -465,29 +479,38 @@ describe('plugin-meetings', () => {
       });
     });
 
-    describe('#cancelSIPInvite', () => {
+    describe('#cancelInviteByMemberId', () => {
       const memberId = uuid.v4();
-      it('should invoke cancelSIPInviteOptions from MembersUtil when cancelSIPInvite is called with valid params', async () => {
-        sandbox.spy(MembersUtil, 'cancelSIPInviteOptions');
+      it('should invoke cancelInviteByMemberIdOptions from MembersUtil when cancelInviteByMemberId is called with valid params', async () => {
+        sandbox.spy(MembersUtil, 'cancelInviteByMemberIdOptions');
+
+        const members = createMembers({url: url1});
+
+        await members.cancelInviteByMemberId({memberId});
+        assert.calledOnce(MembersUtil.cancelInviteByMemberIdOptions);
+      });
+
+      it('should invoke cancelInviteByMemberIdOptions from MembersUtil when cancelInviteByMemberId is called with isInternalNumber', async () => {
+        sandbox.spy(MembersUtil, 'cancelInviteByMemberIdOptions');
 
         const members = createMembers({url: url1});
 
-        await members.cancelSIPInvite({memberId});
-        assert.calledOnce(MembersUtil.cancelSIPInviteOptions);
+        await members.cancelInviteByMemberId({memberId, isInternalNumber: true});
+        assert.calledOnce(MembersUtil.cancelInviteByMemberIdOptions);
       });
 
       it('should throw a rejection if there is no locus url', async () => {
         const members = createMembers({url: false});
 
-        assert.isRejected(members.cancelSIPInvite({memberId}));
+        assert.isRejected(members.cancelInviteByMemberId({memberId}));
       });
       
       it('should throw a rejection if memberId is not provided', async () => {
         const members = createMembers({url: url1});
 
-        assert.isRejected(members.cancelSIPInvite({}));
-        assert.isRejected(members.cancelSIPInvite({memberId: null}));
-        assert.isRejected(members.cancelSIPInvite({memberId: undefined}));
+        assert.isRejected(members.cancelInviteByMemberId({}));
+        assert.isRejected(members.cancelInviteByMemberId({memberId: null}));
+        assert.isRejected(members.cancelInviteByMemberId({memberId: undefined}));
       });
     });
 

package/test/unit/spec/members/request.js

@@ -221,7 +221,7 @@ describe('plugin-meetings', () => {
       });
     });
 
-    describe('#cancelSIPInvite', () => {
+    describe('#cancelInviteByMemberId', () => {
       const memberId = uuid.v4();
       it('sends a PUT to the locus endpoint', async () => {
         const options = {
@@ -231,7 +231,7 @@ describe('plugin-meetings', () => {
           locusUrl: url1,
         };
 
-        await membersRequest.cancelSIPInvite(options);
+        await membersRequest.cancelInviteByMemberId(options);
 
         checkRequest({
           method: 'PUT',

package/test/unit/spec/members/utils.js

@@ -302,6 +302,26 @@ describe('plugin-meetings', () => {
         });
       });
 
+      it('returns the correct body with phone number and isInternalNumber', () => {
+        const options = {
+          invitee: {
+            phoneNumber: '1234567890',
+            isInternalNumber: false
+          },
+          alertIfActive: false,
+        };
+
+        assert.deepEqual(MembersUtil.getAddMemberBody(options), {
+          invitees: [
+            {
+              address: '1234567890',
+              isInternalNumber: false
+            },
+          ],
+          alertIfActive: false,
+        });
+      });
+
       it('returns the correct body with fallback to email', () => {
         const options = {
           invitee: {
@@ -391,14 +411,14 @@ describe('plugin-meetings', () => {
       });
     });
 
-    describe('#cancelSIPInviteOptions', () => {
+    describe('#cancelInviteByMemberIdOptions', () => {
       it('returns the correct options', () => {
         const locusUrl = 'TestLocusUrl';
         const memberId = 'test';
-        const invitee = {memberId};
+        const invitee = {memberId, isInternalNumber: false};
 
         assert.deepEqual(
-          MembersUtil.cancelSIPInviteOptions(
+          MembersUtil.cancelInviteByMemberIdOptions(
             invitee,
             locusUrl
           ),
@@ -410,22 +430,22 @@ describe('plugin-meetings', () => {
       });
     });
 
-    describe('#generateCancelSIPInviteRequestParams', () => {
+    describe('#generateCancelInviteByMemberIdRequestParams', () => {
       it('returns the correct params', () => {
         const locusUrl = 'TestLocusUrl';
         const memberId = 'test';
         const options = {
           locusUrl,
-          invitee: {memberId}
+          invitee: {memberId, isInternalNumber: false}
         };
         const body = {
           actionType: 'REMOVE',
-          invitees: [{address: options.invitee.memberId}],
+          invitees: [{address: options.invitee.memberId, isInternalNumber: false}],
         };
 
         const uri = options.locusUrl;
 
-        assert.deepEqual(MembersUtil.generateCancelSIPInviteRequestParams(options), {
+        assert.deepEqual(MembersUtil.generateCancelInviteByMemberIdRequestParams(options), {
           method: HTTP_VERBS.PUT,
           uri,
           body,

package/test/unit/spec/multistream/sendSlotManager.ts

@@ -272,4 +272,63 @@ describe('SendSlotsManager', () => {
             expect(() => sendSlotsManager.getSlot(MediaType.VideoSlides)).to.throw();
         });
     });
+
+    describe('sourceStateOverride', () => {
+      let mediaConnection: MultistreamRoapMediaConnection;
+      beforeEach(() => {
+        mediaConnection = {
+          createSendSlot: sinon.stub().returns({
+            setSourceStateOverride: sinon.stub().resolves(),
+            clearSourceStateOverride: sinon.stub().resolves(),
+          }),
+        } as MultistreamRoapMediaConnection;
+      });
+
+      it(`can set source state override for ${MediaType.VideoMain}`, () => {
+        const slot: any = sendSlotsManager.createSlot(mediaConnection, MediaType.VideoMain);
+
+        const set = () => sendSlotsManager.setSourceStateOverride(MediaType.VideoMain, 'away');
+
+        expect(set).not.to.throw();
+        expect(slot.setSourceStateOverride.calledWith('away')).to.be.true;
+      });
+
+      [MediaType.VideoSlides, MediaType.AudioMain, MediaType.AudioSlides].forEach((mediaType) => {
+        it(`can't set source state override for ${mediaType}`, () => {
+          const slot: any = sendSlotsManager.createSlot(mediaConnection, mediaType);
+
+          const set = () => sendSlotsManager.setSourceStateOverride(mediaType, 'away');
+
+          expect(set).to.throw();
+          expect(slot.setSourceStateOverride.called).to.be.false;
+        });
+      });
+
+      it("can't set source state override for non-existing slot", () => {
+        const set = () => sendSlotsManager.setSourceStateOverride(MediaType.VideoMain, 'away');
+        expect(set).to.throw(`Slot for ${MediaType.VideoMain} does not exist`);
+      });
+
+      it('can clear source state override', () => {
+        const slot: any = sendSlotsManager.createSlot(mediaConnection, MediaType.VideoMain);
+        sendSlotsManager.setSourceStateOverride(MediaType.VideoMain, 'away');
+
+        expect(slot.setSourceStateOverride.calledWith('away')).to.be.true;
+        expect(slot.clearSourceStateOverride.called).to.be.false;
+
+        sendSlotsManager.setSourceStateOverride(MediaType.VideoMain, null);
+        expect(slot.clearSourceStateOverride.called).to.be.true;
+      });
+
+      it("won't set source state override if it didn't change", () => {
+        const slot: any = sendSlotsManager.createSlot(mediaConnection, MediaType.VideoMain);
+        sendSlotsManager.setSourceStateOverride(MediaType.VideoMain, 'away');
+
+        expect(slot.setSourceStateOverride.calledWith('away')).to.be.true;
+        slot.setSourceStateOverride.resetHistory();
+
+        sendSlotsManager.setSourceStateOverride(MediaType.VideoMain, 'away');
+        expect(slot.setSourceStateOverride.called).to.be.false;
+      });
+    });
 });

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

@@ -2764,14 +2764,10 @@ describe('isSubnetReachable', () => {
   });
 
   it('returns true if the subnet is reachable', () => {
-    assert(reachability.isSubnetReachable('1.2.3.4'));
+    assert(reachability.isSubnetReachable('1'));
   });
 
   it(`returns false if the subnet is unreachable`, () => {
-    assert(!reachability.isSubnetReachable('11.2.3.4'));
-  });
-
-  it('returns null if the subnet is not provided', () => {
-    assert.isNull(reachability.isSubnetReachable(undefined));
+    assert(!reachability.isSubnetReachable('11'));
   });
 });

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;