@webex/plugin-meetings 3.0.0-beta.1 → 3.0.0-beta.104

package/dist/types/controls-options-manager/constants.d.ts

@@ -0,0 +1,4 @@
+declare const ENABLED = "enabled";
+declare const CAN_SET = "canSet";
+declare const CAN_UNSET = "canUnset";
+export { ENABLED, CAN_SET, CAN_UNSET };

package/dist/types/controls-options-manager/enums.d.ts

@@ -0,0 +1,13 @@
+declare enum Setting {
+    disallowUnmute = "DisallowUnmute",
+    muteOnEntry = "MuteOnEntry",
+    muted = "Muted"
+}
+declare enum Control {
+    audio = "audio",
+    reactions = "reactions",
+    shareControl = "shareControl",
+    viewTheParticipantList = "viewTheParticipantList"
+}
+export { Control, Setting };
+export default Setting;

package/dist/types/controls-options-manager/index.d.ts

@@ -0,0 +1,136 @@
+import MeetingRequest from '../meeting/request';
+import { ControlConfig } from './types';
+/**
+ * docs
+ * https://sqbu-github.cisco.com/pages/WebExSquared/locus/guides/mute.html
+ * https://confluence-eng-gpk2.cisco.com/conf/display/LOCUS/Hard+Mute+and+Audio+Privacy#HardMuteandAudioPrivacy-SelfMuteonEntry
+ * https://confluence-eng-gpk2.cisco.com/conf/pages/viewpage.action?spaceKey=UC&title=WEBEX-124454%3A+UCF%3A+Hard+mute+support+for+Teams+joining+Webex+meeting
+ * https://jira-eng-gpk2.cisco.com/jira/browse/SPARK-180867
+ * https://jira-eng-gpk2.cisco.com/jira/browse/SPARK-393351
+ */
+/**
+ * @description ControlsOptionsManager is responsible for handling the behavior of participant controls when somebody joins a meeting
+ * @export
+ * @private
+ * @class Recording
+ */
+export default class ControlsOptionsManager {
+    /**
+     * @instance
+     * @type {MeetingRequest}
+     * @private
+     * @memberof ControlsOptionsManager
+     */
+    private request;
+    /**
+     * @instance
+     * @type {Array}
+     * @private
+     * @memberof ControlsOptionsManager
+     */
+    private displayHints;
+    /**
+     * @instance
+     * @type {string}
+     * @private
+     * @memberof ControlsOptionsManager
+     */
+    private locusUrl;
+    /**
+     * @param {MeetingRequest} request
+     * @param {Object} options
+     * @constructor
+     * @memberof ControlsOptionsManager
+     */
+    constructor(request: MeetingRequest, options?: {
+        locusUrl: string;
+        displayHints?: Array<string>;
+    });
+    /**
+     * @param {MeetingRequest} request
+     * @returns {void}
+     * @private
+     * @memberof ControlsOptionsManager
+     */
+    private initialize;
+    /**
+     * @param {Object} options
+     * @returns {void}
+     * @public
+     * @memberof ControlsOptionsManager
+     */
+    set(options?: {
+        locusUrl: string;
+        displayHints?: Array<string>;
+    }): void;
+    /**
+     * @param {string} url
+     * @returns {void}
+     * @public
+     * @memberof ControlsOptionsManager
+     */
+    setLocusUrl(url: string): void;
+    /**
+     * @param {Array} hints
+     * @returns {void}
+     * @public
+     * @memberof ControlsOptionsManager
+     */
+    setDisplayHints(hints: Array<string>): void;
+    /**
+     * @returns {string}
+     * @public
+     * @memberof ControlsOptionsManager
+     */
+    getLocusUrl(): string;
+    /**
+     * @returns {Array}
+     * @public
+     * @memberof ControlsOptionsManager
+     */
+    getDisplayHints(): string[];
+    /**
+     * @param {Object} options
+     * @returns {void}
+     * @private
+     * @memberof ControlsOptionsManager
+     */
+    private extract;
+    /**
+     * Set controls for this meeting.
+     *
+     * @param {Array<ControlConfig>} controls - Spread Array of ControlConfigs
+     * @returns {Promise<Array<any>>}- Promise resolving if the request was successful.
+     */
+    update(...controls: Array<ControlConfig>): Promise<any>;
+    /**
+     * @param {Setting} setting
+     * @private
+     * @memberof ControlsOptionsManager
+     * @returns {Promise}
+     */
+    private setControls;
+    /**
+     * @public
+     * @param {boolean} enabled
+     * @memberof ControlsOptionsManager
+     * @returns {Promise}
+     */
+    setMuteOnEntry(enabled: boolean): Promise<any>;
+    /**
+     * @public
+     * @param {boolean} enabled
+     * @memberof ControlsOptionsManager
+     * @returns {Promise}
+     */
+    setDisallowUnmute(enabled: boolean): Promise<any>;
+    /**
+     * @public
+     * @param {boolean} mutedEnabled
+     * @param {boolean} disallowUnmuteEnabled
+     * @param {boolean} muteOnEntryEnabled
+     * @memberof ControlsOptionsManager
+     * @returns {Promise}
+     */
+    setMuteAll(mutedEnabled: boolean, disallowUnmuteEnabled: boolean, muteOnEntryEnabled: boolean): Promise<any>;
+}

package/dist/types/controls-options-manager/types.d.ts

@@ -0,0 +1,37 @@
+import { Control } from './enums';
+export interface ControlProperties {
+    /**
+     * A list of additional properties that apply to various specific settings.
+     *
+     * @remarks
+     * The values stored here, per the service, are fully ambiguous, an can vary
+     * depending on which control scope is being configured.
+     */
+    [key: string]: boolean;
+}
+export interface AudioProperties {
+    muted?: boolean;
+    disallowUnmute?: boolean;
+    muteOnEntry?: boolean;
+}
+export interface ReactionsProperties {
+    enabled?: boolean;
+    showDisplayNameWithReactions?: boolean;
+}
+export interface ShareControlProperties {
+    control?: 'ANYONE' | 'MODERATOR_PRESENTER';
+}
+export interface ViewTheParticipantListProperties {
+    enabled?: boolean;
+}
+export type Properties = AudioProperties | ReactionsProperties | ShareControlProperties | ViewTheParticipantListProperties;
+export interface ControlConfig<Props = Properties> {
+    /**
+     * The scope of the control within this object.
+     */
+    scope: Control;
+    /**
+     * The properties to assign to this control.
+     */
+    properties: Props;
+}

package/dist/types/controls-options-manager/util.d.ts

@@ -0,0 +1 @@
+export default Utils;

package/dist/types/index.d.ts

@@ -0,0 +1,7 @@
+import Meetings from './meetings';
+export { LocalTrack, LocalDisplayTrack, LocalTrackEvents, type TrackMuteEvent, type ServerMuteReason, LocalMicrophoneTrackEvents, LocalCameraTrackEvents, LocalMicrophoneTrack, LocalCameraTrack, createMicrophoneTrack, createCameraTrack, createDisplayTrack, } from '@webex/media-helpers';
+export default Meetings;
+export * as CONSTANTS from './constants';
+export * as REACTIONS from './reactions/reactions';
+export { RemoteMedia } from './multistream/remoteMedia';
+export { default as TriggerProxy } from './common/events/trigger-proxy';

package/dist/types/locus-info/controlsUtils.d.ts

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

package/dist/types/locus-info/embeddedAppsUtils.d.ts

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

package/dist/types/locus-info/fullState.d.ts

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

package/dist/types/locus-info/hostUtils.d.ts

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

package/dist/types/locus-info/index.d.ts

@@ -0,0 +1,315 @@
+import EventsScope from '../common/events/events-scope';
+/**
+ * @description LocusInfo extends ChildEmitter to convert locusInfo info a private emitter to parent object
+ * @export
+ * @private
+ * @class LocusInfo
+ */
+export default class LocusInfo extends EventsScope {
+    compareAndUpdateFlags: any;
+    emitChange: any;
+    locusParser: any;
+    meetingId: any;
+    parsedLocus: any;
+    updateMeeting: any;
+    webex: any;
+    aclUrl: any;
+    baseSequence: any;
+    created: any;
+    deltaParticipants: any;
+    identities: any;
+    membership: any;
+    participants: any;
+    participantsUrl: any;
+    replaces: any;
+    scheduledMeeting: any;
+    sequence: any;
+    controls: any;
+    conversationUrl: any;
+    embeddedApps: any;
+    fullState: any;
+    host: any;
+    info: any;
+    roles: any;
+    mediaShares: any;
+    replace: any;
+    url: any;
+    services: any;
+    mainSessionLocusCache: any;
+    /**
+     * Constructor
+     * @param {boolean} updateMeeting true if the meeting should be updated
+     * @param {object} webex
+     * @param {string} meetingId
+     * @returns {undefined}
+     */
+    constructor(updateMeeting: any, webex: any, meetingId: any);
+    /**
+     * Apply locus delta data to meeting
+     * @param {string} action Locus delta action
+     * @param {Locus} locus
+     * @param {Meeting} meeting
+     * @returns {undefined}
+     */
+    applyLocusDeltaData(action: string, locus: any, meeting: any): void;
+    /**
+     * Adds locus delta to parser's queue
+     * and registers a function handler
+     * to recieve parsed actions from queue.
+     * @param {Locus} locus
+     * @param {Meeting} meeting
+     * @returns {undefined}
+     */
+    handleLocusDelta(locus: any, meeting: any): void;
+    /**
+     * @param {Locus} locus
+     * @returns {undefined}
+     * @memberof LocusInfo
+     */
+    init(locus?: any): void;
+    /**
+     * @param {Object} locus
+     * @returns {undefined}
+     * @memberof LocusInfo
+     */
+    initialSetup(locus: object): void;
+    /**
+     * @param {Meeting} meeting
+     * @param {Object} data
+     * @returns {undefined}
+     * @memberof LocusInfo
+     */
+    parse(meeting: any, data: any): void;
+    /**
+     * @param {String} scope
+     * @param {String} eventName
+     * @param {Array} args
+     * @returns {undefined}
+     * @memberof LocusInfo
+     */
+    emitScoped(scope?: any, eventName?: string, args?: any): boolean;
+    /**
+     * updates the locus with full locus object
+     * @param {object} locus locus object
+     * @param {string} eventType particulat locus event
+     * @returns {object} null
+     * @memberof LocusInfo
+     */
+    onFullLocus(locus: any, eventType?: string): void;
+    /**
+     * @param {String} eventType
+     * @returns {undefined}
+     * @memberof LocusInfo
+     */
+    handleOneOnOneEvent(eventType: string): void;
+    /**
+     * @param {Object} locus
+     * @returns {undefined}
+     * @memberof LocusInfo
+     */
+    onDeltaLocus(locus: any): void;
+    /**
+     * @param {Object} locus
+     * @returns {undefined}
+     * @memberof LocusInfo
+     */
+    updateLocusInfo(locus: any): void;
+    /**
+     * @param {Array} participants
+     * @param {Object} self
+     * @returns {Array}
+     * @memberof LocusInfo
+     */
+    getLocusPartner(participants: Array<any>, self: any): any;
+    /**
+     * @returns {undefined}
+     * @memberof LocusInfo
+     */
+    isMeetingActive(): void;
+    /**
+     * checks if the host permissions have changed while in the meeting
+     * This would be the case if your role as host or moderator has been updated
+     * @returns {undefined}
+     * @memberof LocusInfo
+     */
+    compareAndUpdate(): void;
+    /**
+     * compared the self object to check if the user has host permissions
+     * @returns {undefined}
+     * @memberof LocusInfo
+     */
+    compareSelfAndHost(): void;
+    /**
+     * Update the deltaParticipants property of this object based on a list of
+     * provided participants.
+     *
+     * @param {Array} [participants] - The participants to update against.
+     * @returns {void}
+     */
+    updateParticipantDeltas(participants?: Array<any>): void;
+    /**
+     * update meeting's members
+     * @param {Object} participants new participants object
+     * @param {Boolean} isReplace is replace the whole members
+     * @returns {Array} updatedParticipants
+     * @memberof LocusInfo
+     */
+    updateParticipants(participants: object, isReplace?: boolean): void;
+    /**
+     * @param {Object} controls
+     * @param {Object} self
+     * @returns {undefined}
+     * @memberof LocusInfo
+     */
+    updateControls(controls: object, self: object): void;
+    /**
+     * @param {String} conversationUrl
+     * @param {Object} info
+     * @returns {undefined}
+     * @memberof LocusInfo
+     */
+    updateConversationUrl(conversationUrl: string, info: any): void;
+    /**
+     * @param {Object} created
+     * @returns {undefined}
+     * @memberof LocusInfo
+     */
+    updateCreated(created: object): void;
+    /**
+     * @param {Object} services
+     * @returns {undefined}
+     * @memberof LocusInfo
+     */
+    updateServices(services: Record<'breakout' | 'record', {
+        url: string;
+    }>): void;
+    /**
+     * @param {Object} fullState
+     * @returns {undefined}
+     * @memberof LocusInfo
+     */
+    updateFullState(fullState: object): void;
+    /**
+     * handles when the locus.host is updated
+     * @param {Object} host the locus.host property
+     * @returns {undefined}
+     * @memberof LocusInfo
+     * emits internal event locus_info_update_host
+     */
+    updateHostInfo(host: object): void;
+    /**
+     * @param {Object} info
+     * @param {Object} self
+     * @returns {undefined}
+     * @memberof LocusInfo
+     */
+    updateMeetingInfo(info: object, self?: object): void;
+    /**
+     * @param {Object} embeddedApps
+     * @returns {undefined}
+     * @memberof LocusInfo
+     */
+    updateEmbeddedApps(embeddedApps: object): void;
+    /**
+     * handles when the locus.mediaShares is updated
+     * @param {Object} mediaShares the locus.mediaShares property
+     * @returns {undefined}
+     * @memberof LocusInfo
+     * emits internal event locus_info_update_media_shares
+     */
+    updateMediaShares(mediaShares: object): void;
+    /**
+     * @param {String} participantsUrl
+     * @returns {undefined}
+     * @memberof LocusInfo
+     */
+    updateParticipantsUrl(participantsUrl: string): void;
+    /**
+     * @param {Object} replace
+     * @returns {undefined}
+     * @memberof LocusInfo
+     */
+    updateReplace(replace: object): void;
+    /**
+     * handles when the locus.self is updated
+     * @param {Object} self the locus.mediaShares property
+     * @param {Array} participants the locus.participants property
+     * @returns {undefined}
+     * @memberof LocusInfo
+     * emits internal events self_admitted_guest, self_unadmitted_guest, locus_info_update_self
+     */
+    updateSelf(self: any, participants: Array<any>): void;
+    /**
+     * handles when the locus.url is updated
+     * @param {String} url
+     * @returns {undefined}
+     * emits internal event locus_info_update_url
+     */
+    updateLocusUrl(url: string): void;
+    /**
+     * @param {String} aclUrl
+     * @returns {undefined}
+     * @memberof LocusInfo
+     */
+    updateAclUrl(aclUrl: string): void;
+    /**
+     * @param {Number} baseSequence
+     * @returns {undefined}
+     * @memberof LocusInfo
+     */
+    updateBasequence(baseSequence: number): void;
+    /**
+     * @param {Number} sequence
+     * @returns {undefined}
+     * @memberof LocusInfo
+     */
+    updateSequence(sequence: number): void;
+    /**
+     * @param {Object} membership
+     * @returns {undefined}
+     * @memberof LocusInfo
+     */
+    updateMemberShip(membership: object): void;
+    /**
+     * @param {Array} identities
+     * @returns {undefined}
+     * @memberof LocusInfo
+     */
+    updateIdentifiers(identities: Array<any>): void;
+    /**
+     * check the locus is main session's one or not, if is main session's, update main session cache
+     * @param {Object} locus
+     * @returns {undefined}
+     * @memberof LocusInfo
+     */
+    updateLocusCache(locus: any): void;
+    /**
+     * if return from breakout to main session, need to use cached main session DTO since locus won't send the full locus (participants)
+     * if join breakout from main session, need to query main locus url (if response with 403 means no privilege, need to clear the cache)
+     * @param {Object} newLocus
+     * @returns {Object}
+     * @memberof LocusInfo
+     */
+    getTheLocusToUpdate(newLocus: any): any;
+    /**
+     * merge participants by participant id
+     * @param {Array} participants
+     * @param {Array} sourceParticipants
+     * @returns {Array} merged participants
+     * @memberof LocusInfo
+     */
+    mergeParticipants(participants: any, sourceParticipants: any): any;
+    /**
+     * need cache main sessions' participants since locus will not send the full list when cohost/host leave breakout
+     * @param {Object} mainLocus
+     * @returns {undefined}
+     * @memberof LocusInfo
+     */
+    updateMainSessionLocusCache(mainLocus: any): void;
+    /**
+     * clear main session cache
+     * @returns {undefined}
+     * @memberof LocusInfo
+     */
+    clearMainSessionLocusCache(): void;
+}

package/dist/types/locus-info/infoUtils.d.ts

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

package/dist/types/locus-info/mediaSharesUtils.d.ts

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