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

package/src/constants.ts

@@ -347,7 +347,7 @@ export const EVENT_TRIGGERS = {
   MEETING_SELF_LEFT: 'meeting:self:left',
   NETWORK_QUALITY: 'network:quality',
   MEDIA_NEGOTIATED: 'media:negotiated',
-  MEDIA_INBOUND_AUDIO_ISSUE_DETECTED: 'media:inboundAudio:issueDetected',
+  MEDIA_INBOUND_AUDIO_ISSUE_DETECTED: 'media:inboundAudio:issueDetected', // event.data: InboundAudioIssueEvent
   // the following events apply only to multistream media connections
   ACTIVE_SPEAKER_CHANGED: 'media:activeSpeakerChanged',
   REMOTE_VIDEO_SOURCE_COUNT_CHANGED: 'media:remoteVideoSourceCountChanged',
@@ -793,7 +793,19 @@ export const LOCUSEVENT = {
   RECORDING_STOPPED: 'locus.recording_stopped',
 
   SELF_CHANGED: 'locus.self_changed',
-};
+
+  HASH_TREE_DATA_UPDATED: 'locus.state_message',
+
+  // events generated internally by SDK
+  SDK_LOCUS_FROM_SYNC_MEETINGS: 'jsSdk.locus_from_sync_meetings', // generated for each meeting from response to GET /loci Locus API call
+  SDK_NO_EVENT: 'jsSdk.no_event', // used in cases where eventType is irrelevant
+} as const;
+
+export type LOCUSEVENT = Enum<typeof LOCUSEVENT>;
+
+// HASH_TREE_DATA_UPDATED event can come over Mercury (so it's listed above with other Mercury events),
+// but also over LLM as an event like this:
+export const LOCUS_LLM_EVENT = `event:${LOCUSEVENT.HASH_TREE_DATA_UPDATED}`;
 
 export const MEDIA_TRACK_CONSTRAINT = {
   CURSOR: {

package/src/hashTree/hashTreeParser.ts

@@ -0,0 +1,146 @@
+import {Enum} from '../constants';
+import {ObjectType, HtMeta} from './types';
+import {LocusDTO} from '../locus-info/types';
+
+export interface DataSet {
+  url: string;
+  root: string;
+  version: number;
+  leafCount: number;
+  name: string;
+  idleMs: number;
+  backoff: {
+    maxMs: number;
+    exponent: number;
+  };
+}
+
+export interface HashTreeObject {
+  htMeta: HtMeta;
+  data: Record<string, any>;
+}
+
+export interface RootHashMessage {
+  dataSets: Array<DataSet>;
+}
+export interface HashTreeMessage {
+  dataSets: Array<DataSet>;
+  visibleDataSetsUrl: string; // url from which we can get more info about all data sets - now it seems to be visibleDataSetsUrl
+  locusStateElements?: Array<HashTreeObject>;
+  locusSessionId?: string;
+  locusUrl: string;
+}
+
+interface InternalDataSet extends DataSet {
+  // hashTree?: HashTree; // set only for visible data sets
+  timer?: ReturnType<typeof setTimeout>;
+}
+
+type WebexRequestMethod = (options: Record<string, any>) => Promise<any>;
+
+export const LocusInfoUpdateType = {
+  OBJECTS_UPDATED: 'OBJECTS_UPDATED',
+  MEETING_ENDED: 'MEETING_ENDED',
+} as const;
+
+export type LocusInfoUpdateType = Enum<typeof LocusInfoUpdateType>;
+export type LocusInfoUpdateCallback = (
+  updateType: LocusInfoUpdateType,
+  data?: {updatedObjects: HashTreeObject[]}
+) => void;
+
+/**
+ * This error is thrown if we receive information that the meeting has ended while we're processing some hash messages.
+ * It's handled internally by HashTreeParser and results in MEETING_ENDED being sent up.
+ */
+class MeetingEndedError extends Error {}
+
+/**
+ * Checks if the given hash tree object is of type "self"
+ * @param {HashTreeObject} object object to check
+ * @returns {boolean} True if the object is of type "self", false otherwise
+ */
+export function isSelf(object: HashTreeObject) {
+  return object.htMeta.elementId.type.toLowerCase() === ObjectType.self;
+}
+
+/**
+ * Parses hash tree eventing locus data
+ */
+class HashTreeParser {
+  dataSets: Record<string, InternalDataSet> = {};
+  visibleDataSetsUrl: string; // url from which we can get info about all data sets
+  webexRequest: WebexRequestMethod;
+  locusInfoUpdateCallback: LocusInfoUpdateCallback;
+  visibleDataSets: string[];
+  debugId: string;
+
+  /**
+   * Constructor for HashTreeParser
+   * @param {Object} options
+   * @param {Object} options.initialLocus The initial locus data containing the hash tree information
+   */
+  constructor(options: {
+    initialLocus: {
+      dataSets: Array<DataSet>;
+      locus: any;
+    };
+    webexRequest: WebexRequestMethod;
+    locusInfoUpdateCallback: LocusInfoUpdateCallback;
+    debugId: string;
+  }) {
+    const {locus} = options.initialLocus;
+
+    this.debugId = options.debugId;
+    this.webexRequest = options.webexRequest;
+    this.locusInfoUpdateCallback = options.locusInfoUpdateCallback;
+    this.visibleDataSets = locus?.self?.visibleDataSets || [];
+  }
+
+  /**
+   * Initializes the hash tree parser from a message received from Locus.
+   *
+   * @param {HashTreeMessage} message - initial hash tree message received from Locus
+   * @returns {Promise}
+   */
+  async initializeFromMessage(message: HashTreeMessage) {
+    // todo
+  }
+
+  /**
+   * Initializes the hash tree parser from GET /loci API response by fetching all data sets metadata
+   * first and then doing an initialization sync on each data set
+   *
+   * This function requires that this.visibleDataSets have been already populated correctly by the constructor.
+   *
+   * @param {LocusDTO} locus - locus object received from GET /loci
+   * @returns {Promise}
+   */
+  async initializeFromGetLociResponse(locus: LocusDTO) {
+    // todo
+  }
+
+  /**
+   * This method should be called when we receive a partial locus DTO that contains dataSets and htMeta information
+   * It updates the hash trees with the new leaf data based on the received Locus
+   *
+   * @param {Object} update - The locus update containing data sets and locus information
+   * @returns {void}
+   */
+  handleLocusUpdate(update: {dataSets?: Array<DataSet>; locus: any}): void {
+    // todo
+  }
+
+  /**
+   * Handles incoming hash tree messages, updates the hash trees and calls locusInfoUpdateCallback
+   *
+   * @param {HashTreeMessage} message - The hash tree message containing data sets and objects to be processed
+   * @param {string} [debugText] - Optional debug text to include in logs
+   * @returns {void}
+   */
+  async handleMessage(message: HashTreeMessage, debugText?: string): Promise<void> {
+    // todo
+  }
+}
+
+export default HashTreeParser;

package/src/hashTree/types.ts

@@ -0,0 +1,20 @@
+import {Enum} from '../constants';
+
+// todo: Locus docs have now more types like CONTROL_ENTRY, EMBEDDED_APP, FULL_STATE, INFO, MEDIA_SHARE - need to add support for them once Locus implements them
+export const ObjectType = {
+  participant: 'participant',
+  self: 'self',
+  locus: 'locus',
+  mediaShare: 'mediashare',
+} as const;
+
+export type ObjectType = Enum<typeof ObjectType>;
+
+export interface HtMeta {
+  elementId: {
+    type: ObjectType;
+    id: number;
+    version: number;
+  };
+  dataSetNames: string[];
+}

package/src/index.ts

@@ -18,6 +18,7 @@ import {
 import Meeting from './meeting';
 import MeetingInfoUtil from './meeting-info/utilv2';
 import JoinMeetingError from './common/errors/join-meeting';
+import {SdpResponseTimeoutError} from './common/errors/webex-errors';
 
 registerPlugin('meetings', Meetings, {
   config,
@@ -73,6 +74,7 @@ export {
   Meeting,
   MeetingInfoUtil,
   JoinWebinarError,
+  SdpResponseTimeoutError,
 };
 
 export {RemoteMedia} from './multistream/remoteMedia';