@webex/plugin-meetings 3.10.0-next.1 → 3.10.0-next.10

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

@@ -1,45 +1,15 @@
 import EventsScope from '../common/events/events-scope';
-export type LocusDTO = {
-    controls?: any;
-    fullState?: {
-        active: boolean;
-        count: number;
-        lastActive: string;
-        locked: boolean;
-        sessionId: string;
-        seessionIds: string[];
-        startTime: number;
-        state: string;
-        type: string;
+import { LOCUSEVENT } from '../constants';
+import HashTreeParser, { DataSet, HashTreeMessage, HashTreeObject } from '../hashTree/hashTreeParser';
+import { LocusDTO } from './types';
+export type LocusLLMEvent = {
+    data: {
+        eventType: typeof LOCUSEVENT.HASH_TREE_DATA_UPDATED;
+        stateElementsMessage: HashTreeMessage;
     };
-    host?: {
-        id: string;
-        incomingCallProtocols: any[];
-        isExternal: boolean;
-        name: string;
-        orgId: string;
-    };
-    info?: any;
-    links?: any;
-    mediaShares?: any[];
-    meetings?: any[];
-    participants: any[];
-    replaces?: any[];
-    self?: any;
-    sequence?: {
-        dirtyParticipants: number;
-        entries: number[];
-        rangeEnd: number;
-        rangeStart: number;
-        sequenceHash: number;
-        sessionToken: string;
-        since: string;
-        totalParticipants: number;
-    };
-    syncUrl?: string;
-    url?: string;
 };
 export type LocusApiResponseBody = {
+    dataSets?: DataSet[];
     locus: LocusDTO;
 };
 /**
@@ -80,6 +50,9 @@ export default class LocusInfo extends EventsScope {
     resources: any;
     mainSessionLocusCache: any;
     self: any;
+    hashTreeParser?: HashTreeParser;
+    hashTreeObjectId2ParticipantId: Map<number, string>;
+    classicVsHashTreeMismatchMetricCounter: number;
     /**
      * Constructor
      * @param {function} updateMeeting callback to update the meeting object from an object
@@ -90,6 +63,7 @@ export default class LocusInfo extends EventsScope {
     constructor(updateMeeting: any, webex: any, meetingId: any);
     /**
      * Does a Locus sync. It tries to get the latest delta DTO or if it can't, it falls back to getting the full Locus DTO.
+     * WARNING: This function must not be used for hash tree based Locus meetings.
      *
      * @param {Meeting} meeting
      * @param {boolean} isLocusUrlChanged
@@ -121,11 +95,28 @@ export default class LocusInfo extends EventsScope {
      */
     init(locus?: any): void;
     /**
-     * @param {Object} locus
+     * Creates the HashTreeParser instance.
+     * @param {Object} initial locus data
+     * @returns {void}
+     */
+    private createHashTreeParser;
+    /**
+     * @param {Object} data - data to initialize locus info with. It may be from a join or GET /loci response or from a Mercury event that triggers a creation of meeting object
      * @returns {undefined}
      * @memberof LocusInfo
      */
-    initialSetup(locus: object): void;
+    initialSetup(data: {
+        trigger: 'join-response';
+        locus: LocusDTO;
+        dataSets?: DataSet[];
+    } | {
+        trigger: 'locus-message';
+        locus?: LocusDTO;
+        hashTreeMessage?: HashTreeMessage;
+    } | {
+        trigger: 'get-loci-response';
+        locus?: LocusDTO;
+    }): Promise<void>;
     /**
      * Handles HTTP response from Locus API call.
      * @param {Meeting} meeting meeting object
@@ -133,6 +124,39 @@ export default class LocusInfo extends EventsScope {
      * @returns {void}
      */
     handleLocusAPIResponse(meeting: any, responseBody: LocusApiResponseBody): void;
+    /**
+     *
+     * @param {HashTreeObject} object data set object
+     * @param {any} locus
+     * @returns {void}
+     */
+    updateLocusFromHashTreeObject(object: HashTreeObject, locus: LocusDTO): LocusDTO;
+    /**
+     * Sends a metric when we receive something from Locus that uses hash trees while we
+     * expect classic deltas or the other way around.
+     * @param {Meeting} meeting
+     * @param {string} message
+     * @returns {void}
+     */
+    sendClassicVsHashTreeMismatchMetric(meeting: any, message: string): void;
+    /**
+     * Handles a hash tree message received from Locus.
+     *
+     * @param {Meeting} meeting - The meeting object
+     * @param {eventType} eventType - The event type
+     * @param {HashTreeMessage} message incoming hash tree message
+     * @returns {void}
+     */
+    private handleHashTreeMessage;
+    /**
+     * Callback registered with HashTreeParser to receive locus info updates.
+     * Updates our locus info based on the data parsed by the hash tree parser.
+     *
+     * @param {LocusInfoUpdateType} updateType - The type of update received.
+     * @param {Object} [data] - Additional data for the update, if applicable.
+     * @returns {void}
+     */
+    private updateFromHashTree;
     /**
      * @param {Meeting} meeting
      * @param {Object} data
@@ -148,14 +172,39 @@ export default class LocusInfo extends EventsScope {
      * @memberof LocusInfo
      */
     emitScoped(scope?: any, eventName?: string, args?: any): boolean;
+    /**
+     * Function for handling full locus when it's using hash trees (so not the "classic" one).
+     *
+     * @param {object} locus locus object
+     * @param {string} eventType locus event
+     * @param {DataSet[]} dataSets
+     * @returns {void}
+     */
+    private onFullLocusWithHashTrees;
+    /**
+     * Function for handling full locus when it's the "classic" one (not hash trees)
+     *
+     * @param {object} locus locus object
+     * @param {string} eventType locus event
+     * @returns {void}
+     */
+    private onFullLocusClassic;
     /**
      * updates the locus with full locus object
      * @param {object} locus locus object
-     * @param {string} eventType particulat locus event
+     * @param {string} eventType locus event
+     * @param {DataSet[]} dataSets
      * @returns {object} null
      * @memberof LocusInfo
      */
-    onFullLocus(locus: any, eventType?: string): void;
+    onFullLocus(locus: any, eventType?: string, dataSets?: Array<DataSet>): void;
+    /**
+     * Common part of handling full locus, used by both classic and hash tree based locus handling
+     * @param {object} locus locus object
+     * @param {string} eventType locus event
+     * @returns {void}
+     */
+    private onFullLocusCommon;
     /**
      * @param {String} eventType
      * @returns {undefined}

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

@@ -0,0 +1,45 @@
+import { HtMeta } from '../hashTree/types';
+export type LocusDTO = {
+    controls?: any;
+    fullState?: {
+        active: boolean;
+        count: number;
+        lastActive: string;
+        locked: boolean;
+        sessionId: string;
+        seessionIds: string[];
+        startTime: number;
+        state: string;
+        type: string;
+    };
+    host?: {
+        id: string;
+        incomingCallProtocols: any[];
+        isExternal: boolean;
+        name: string;
+        orgId: string;
+    };
+    htMeta?: HtMeta;
+    info?: any;
+    jsSdkMeta?: {
+        removedParticipantIds: string[];
+    };
+    links?: any;
+    mediaShares?: any[];
+    meetings?: any[];
+    participants: any[];
+    replaces?: any[];
+    self?: any;
+    sequence?: {
+        dirtyParticipants: number;
+        entries: number[];
+        rangeEnd: number;
+        rangeStart: number;
+        sequenceHash: number;
+        sessionToken: string;
+        since: string;
+        totalParticipants: number;
+    };
+    syncUrl?: string;
+    url?: string;
+};

package/dist/types/meeting/index.d.ts

@@ -23,6 +23,8 @@ import { LocusMediaRequest } from './locusMediaRequest';
 import { BrbState } from './brbState';
 import { SetStageOptions } from './request.type';
 import { Invitee } from './type';
+import { DataSet } from '../hashTree/hashTreeParser';
+import { LocusDTO } from '../locus-info/types';
 export type CaptionData = {
     id: string;
     isFinal: boolean;
@@ -1034,25 +1036,30 @@ export default class Meeting extends StatelessWebexPlugin {
      */
     setSipUri(sipUri: string): void;
     /**
-     * Set the locus info the class instance
-     * @param {Object} locus
-     * @param {Array} locus.mediaConnections
-     * @param {String} locus.locusUrl
-     * @param {String} locus.locusId
-     * @param {String} locus.mediaId
-     * @param {Object} locus.host
+     * Set the locus info the class instance. Should be called with the parsed locus
+     * we got in the join response.
+     *
+     * @param {Object} data
+     * @param {Array} data.mediaConnections
+     * @param {String} data.locusUrl
+     * @param {String} data.locusId
+     * @param {String} data.mediaId
+     * @param {Object} data.host
      * @todo change name to genertic parser
      * @returns {undefined}
      * @private
      * @memberof Meeting
      */
-    setLocus(locus: {
+    setLocus(data: {
+        locus: LocusDTO;
         mediaConnections: Array<any>;
         locusUrl: string;
         locusId: string;
         mediaId: string;
         host: object;
-    } | any): void;
+        selfId: string;
+        dataSets: DataSet[];
+    }): void;
     /**
      * Upload logs for the current meeting
      * @param {object} options file name and function name
@@ -1269,6 +1276,12 @@ export default class Meeting extends StatelessWebexPlugin {
     startTranscription(options?: {
         spokenLanguage?: string;
     }): Promise<void>;
+    /** Handles Locus LLM events
+     *
+     * @param {LocusLLMEvent} event - The Locus LLM event to process
+     * @returns {void}
+     */
+    private processLocusLLMEvent;
     /**
      * Callback called when a relay event is received from meeting LLM Connection
      * @param {RelayEvent} e Event object coming from LLM Connection

package/dist/types/meetings/index.d.ts

@@ -5,10 +5,17 @@ import { WebexPlugin } from '@webex/webex-core';
 import { DeviceRegistrationOptions } from '@webex/internal-plugin-device';
 import * as mediaHelpersModule from '@webex/media-helpers';
 import 'webrtc-adapter';
-import { DESTINATION_TYPE } from '../constants';
+import { LOCUSEVENT, DESTINATION_TYPE } from '../constants';
 import { CallStateForMetrics } from '../meeting';
 import Reachability from '../reachability';
 import { INoiseReductionEffect, IVirtualBackgroundEffect, MeetingRegistrationStatus } from './meetings.types';
+import { HashTreeMessage } from '../hashTree/hashTreeParser';
+export type LocusEvent = {
+    eventType: LOCUSEVENT;
+    locusUrl?: string;
+    locus?: any;
+    stateElementsMessage?: HashTreeMessage;
+};
 /**
  * Meetings Ready Event
  * Emitted when the meetings instance on webex is ready
@@ -129,7 +136,7 @@ export default class Meetings extends WebexPlugin {
      * @private
      * @memberof Meetings
      */
-    getCorrespondingMeetingByLocus(data: any): any;
+    getCorrespondingMeetingByLocus(data: LocusEvent): any;
     /**
      * handle locus events and takes meeting actions with them as they come in
      * @param {Object} data a locus event

package/dist/types/metrics/constants.d.ts

@@ -84,5 +84,7 @@ declare const BEHAVIORAL_METRICS: {
     VERIFY_REGISTRATION_ID_ERROR: string;
     JOIN_FORBIDDEN_ERROR: string;
     MEDIA_ISSUE_DETECTED: string;
+    LOCUS_CLASSIC_VS_HASH_TREE_MISMATCH: string;
+    LOCUS_HASH_TREE_UNSUPPORTED_OPERATION: string;
 };
 export { BEHAVIORAL_METRICS as default };

package/dist/webinar/collection.js

@@ -21,7 +21,7 @@ var WebinarCollection = /*#__PURE__*/function () {
     (0, _defineProperty2.default)(this, "mainIndex", 'sessionId');
     this.webinarInfo = {};
   }
-  (0, _createClass2.default)(WebinarCollection, [{
+  return (0, _createClass2.default)(WebinarCollection, [{
     key: "set",
     value: function set(id, info) {
       this.webinarInfo[id] = info;
@@ -37,7 +37,6 @@ var WebinarCollection = /*#__PURE__*/function () {
       return this.webinarInfo[id];
     }
   }]);
-  return WebinarCollection;
 }();
 var _default = exports.default = WebinarCollection;
 //# sourceMappingURL=collection.js.map

package/dist/webinar/collection.js.map

@@ -1 +1 @@
-{"version":3,"names":["_constants","require","WebinarCollection","_classCallCheck2","default","_defineProperty2","MEETINGS","webinarInfo","_createClass2","key","value","set","id","info","get","_default","exports"],"sources":["collection.ts"],"sourcesContent":["/*!\n * Copyright (c) 2015-2023 Cisco Systems, Inc. See LICENSE file.\n */\n\nimport {MEETINGS} from '../constants';\n\nclass WebinarCollection {\n  webinarInfo: any;\n\n  namespace = MEETINGS;\n\n  mainIndex = 'sessionId';\n\n  constructor() {\n    this.webinarInfo = {};\n  }\n\n  set(id, info) {\n    this.webinarInfo[id] = info;\n  }\n\n  /**\n   * @param {String} id\n   * @returns {Member}\n   */\n  get(id: string) {\n    return this.webinarInfo[id];\n  }\n}\n\nexport default WebinarCollection;\n"],"mappings":";;;;;;;;;;;AAIA,IAAAA,UAAA,GAAAC,OAAA;AAJA;AACA;AACA;AAFA,IAMMC,iBAAiB;EAOrB,SAAAA,kBAAA,EAAc;IAAA,IAAAC,gBAAA,CAAAC,OAAA,QAAAF,iBAAA;IAAA,IAAAG,gBAAA,CAAAD,OAAA;IAAA,IAAAC,gBAAA,CAAAD,OAAA,qBAJFE,mBAAQ;IAAA,IAAAD,gBAAA,CAAAD,OAAA,qBAER,WAAW;IAGrB,IAAI,CAACG,WAAW,GAAG,CAAC,CAAC;EACvB;EAAC,IAAAC,aAAA,CAAAJ,OAAA,EAAAF,iBAAA;IAAAO,GAAA;IAAAC,KAAA,EAED,SAAAC,IAAIC,EAAE,EAAEC,IAAI,EAAE;MACZ,IAAI,CAACN,WAAW,CAACK,EAAE,CAAC,GAAGC,IAAI;IAC7B;;IAEA;AACF;AACA;AACA;EAHE;IAAAJ,GAAA;IAAAC,KAAA,EAIA,SAAAI,IAAIF,EAAU,EAAE;MACd,OAAO,IAAI,CAACL,WAAW,CAACK,EAAE,CAAC;IAC7B;EAAC;EAAA,OAAAV,iBAAA;AAAA;AAAA,IAAAa,QAAA,GAAAC,OAAA,CAAAZ,OAAA,GAGYF,iBAAiB"}
+{"version":3,"names":["_constants","require","WebinarCollection","_classCallCheck2","default","_defineProperty2","MEETINGS","webinarInfo","_createClass2","key","value","set","id","info","get","_default","exports"],"sources":["collection.ts"],"sourcesContent":["/*!\n * Copyright (c) 2015-2023 Cisco Systems, Inc. See LICENSE file.\n */\n\nimport {MEETINGS} from '../constants';\n\nclass WebinarCollection {\n  webinarInfo: any;\n\n  namespace = MEETINGS;\n\n  mainIndex = 'sessionId';\n\n  constructor() {\n    this.webinarInfo = {};\n  }\n\n  set(id, info) {\n    this.webinarInfo[id] = info;\n  }\n\n  /**\n   * @param {String} id\n   * @returns {Member}\n   */\n  get(id: string) {\n    return this.webinarInfo[id];\n  }\n}\n\nexport default WebinarCollection;\n"],"mappings":";;;;;;;;;;;AAIA,IAAAA,UAAA,GAAAC,OAAA;AAJA;AACA;AACA;AAFA,IAMMC,iBAAiB;EAOrB,SAAAA,kBAAA,EAAc;IAAA,IAAAC,gBAAA,CAAAC,OAAA,QAAAF,iBAAA;IAAA,IAAAG,gBAAA,CAAAD,OAAA;IAAA,IAAAC,gBAAA,CAAAD,OAAA,qBAJFE,mBAAQ;IAAA,IAAAD,gBAAA,CAAAD,OAAA,qBAER,WAAW;IAGrB,IAAI,CAACG,WAAW,GAAG,CAAC,CAAC;EACvB;EAAC,WAAAC,aAAA,CAAAJ,OAAA,EAAAF,iBAAA;IAAAO,GAAA;IAAAC,KAAA,EAED,SAAAC,GAAGA,CAACC,EAAE,EAAEC,IAAI,EAAE;MACZ,IAAI,CAACN,WAAW,CAACK,EAAE,CAAC,GAAGC,IAAI;IAC7B;;IAEA;AACF;AACA;AACA;EAHE;IAAAJ,GAAA;IAAAC,KAAA,EAIA,SAAAI,GAAGA,CAACF,EAAU,EAAE;MACd,OAAO,IAAI,CAACL,WAAW,CAACK,EAAE,CAAC;IAC7B;EAAC;AAAA;AAAA,IAAAG,QAAA,GAAAC,OAAA,CAAAZ,OAAA,GAGYF,iBAAiB","ignoreList":[]}