@webex/plugin-meetings 3.10.0-next.9 → 3.10.0-webex-services-ready.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (73) hide show
  1. package/dist/breakouts/breakout.js +1 -1
  2. package/dist/breakouts/index.js +1 -1
  3. package/dist/constants.js +11 -3
  4. package/dist/constants.js.map +1 -1
  5. package/dist/hashTree/constants.js +20 -0
  6. package/dist/hashTree/constants.js.map +1 -0
  7. package/dist/hashTree/hashTree.js +515 -0
  8. package/dist/hashTree/hashTree.js.map +1 -0
  9. package/dist/hashTree/hashTreeParser.js +1266 -0
  10. package/dist/hashTree/hashTreeParser.js.map +1 -0
  11. package/dist/hashTree/types.js +22 -0
  12. package/dist/hashTree/types.js.map +1 -0
  13. package/dist/hashTree/utils.js +48 -0
  14. package/dist/hashTree/utils.js.map +1 -0
  15. package/dist/interpretation/index.js +1 -1
  16. package/dist/interpretation/siLanguage.js +1 -1
  17. package/dist/locus-info/index.js +529 -75
  18. package/dist/locus-info/index.js.map +1 -1
  19. package/dist/locus-info/types.js +7 -0
  20. package/dist/locus-info/types.js.map +1 -0
  21. package/dist/meeting/index.js +63 -22
  22. package/dist/meeting/index.js.map +1 -1
  23. package/dist/meeting/util.js +1 -0
  24. package/dist/meeting/util.js.map +1 -1
  25. package/dist/meetings/index.js +112 -70
  26. package/dist/meetings/index.js.map +1 -1
  27. package/dist/metrics/constants.js +3 -1
  28. package/dist/metrics/constants.js.map +1 -1
  29. package/dist/reachability/clusterReachability.js +44 -358
  30. package/dist/reachability/clusterReachability.js.map +1 -1
  31. package/dist/reachability/reachability.types.js +14 -1
  32. package/dist/reachability/reachability.types.js.map +1 -1
  33. package/dist/reachability/reachabilityPeerConnection.js +445 -0
  34. package/dist/reachability/reachabilityPeerConnection.js.map +1 -0
  35. package/dist/types/constants.d.ts +26 -21
  36. package/dist/types/hashTree/constants.d.ts +8 -0
  37. package/dist/types/hashTree/hashTree.d.ts +129 -0
  38. package/dist/types/hashTree/hashTreeParser.d.ts +260 -0
  39. package/dist/types/hashTree/types.d.ts +27 -0
  40. package/dist/types/hashTree/utils.d.ts +9 -0
  41. package/dist/types/locus-info/index.d.ts +95 -56
  42. package/dist/types/locus-info/types.d.ts +54 -0
  43. package/dist/types/meeting/index.d.ts +22 -9
  44. package/dist/types/meetings/index.d.ts +9 -2
  45. package/dist/types/metrics/constants.d.ts +2 -0
  46. package/dist/types/reachability/clusterReachability.d.ts +10 -88
  47. package/dist/types/reachability/reachability.types.d.ts +12 -1
  48. package/dist/types/reachability/reachabilityPeerConnection.d.ts +111 -0
  49. package/dist/webinar/index.js +1 -1
  50. package/package.json +22 -21
  51. package/src/constants.ts +13 -1
  52. package/src/hashTree/constants.ts +9 -0
  53. package/src/hashTree/hashTree.ts +463 -0
  54. package/src/hashTree/hashTreeParser.ts +1161 -0
  55. package/src/hashTree/types.ts +32 -0
  56. package/src/hashTree/utils.ts +42 -0
  57. package/src/locus-info/index.ts +571 -106
  58. package/src/locus-info/types.ts +53 -0
  59. package/src/meeting/index.ts +78 -27
  60. package/src/meeting/util.ts +1 -0
  61. package/src/meetings/index.ts +104 -51
  62. package/src/metrics/constants.ts +2 -0
  63. package/src/reachability/clusterReachability.ts +50 -347
  64. package/src/reachability/reachability.types.ts +15 -1
  65. package/src/reachability/reachabilityPeerConnection.ts +416 -0
  66. package/test/unit/spec/hashTree/hashTree.ts +655 -0
  67. package/test/unit/spec/hashTree/hashTreeParser.ts +1532 -0
  68. package/test/unit/spec/hashTree/utils.ts +103 -0
  69. package/test/unit/spec/locus-info/index.js +722 -4
  70. package/test/unit/spec/meeting/index.js +120 -20
  71. package/test/unit/spec/meeting/utils.js +77 -0
  72. package/test/unit/spec/meetings/index.js +71 -26
  73. package/test/unit/spec/reachability/clusterReachability.ts +281 -138
@@ -0,0 +1,129 @@
1
+ import { ObjectType } from './types';
2
+ export type LeafDataItem = {
3
+ type: ObjectType;
4
+ id: number;
5
+ version: number;
6
+ };
7
+ /**
8
+ * HashTree is a data structure that organizes items into leaves based on their IDs,
9
+ */
10
+ declare class HashTree {
11
+ leaves: Array<Record<string, Record<number, LeafDataItem>>>;
12
+ leafHashes: Array<string>;
13
+ readonly numLeaves: number;
14
+ /**
15
+ * Constructs a new HashTree.
16
+ * @param {LeafDataItem[]} leafData Initial data to populate the tree.
17
+ * @param {number} numLeaves The number of leaf nodes in the tree. Must be 0 or a power of 2.
18
+ * @throws {Error} If numLeaves is not 0 or a power of 2.
19
+ */
20
+ constructor(leafData: LeafDataItem[], numLeaves: number);
21
+ /**
22
+ * Internal logic for adding or updating an item, without computing the leaf hash.
23
+ * @param {LeafDataItem} item The item to add or update.
24
+ * @returns {{put: boolean, index: (number|null)}} Object indicating if put and the leaf index.
25
+ * @private
26
+ */
27
+ private _putItemInternal;
28
+ /**
29
+ * Adds or updates a single item in the hash tree.
30
+ * @param {LeafDataItem} item The item to add or update.
31
+ * @returns {boolean} True if the item was added or updated, false otherwise (e.g., older version or tree has 0 leaves).
32
+ */
33
+ putItem(item: LeafDataItem): boolean;
34
+ /**
35
+ * Adds or updates multiple items in the hash tree.
36
+ * @param {LeafDataItem[]} items The array of items to add or update.
37
+ * @returns {boolean[]} An array of booleans indicating success for each item.
38
+ */
39
+ putItems(items: LeafDataItem[]): boolean[];
40
+ /**
41
+ * Internal logic for removing an item, without computing the leaf hash.
42
+ * @param {LeafDataItem} item The item to remove.
43
+ * @returns {{removed: boolean, index: (number|null)}} Object indicating if removed and the leaf index.
44
+ * @private
45
+ */
46
+ private _removeItemInternal;
47
+ /**
48
+ * Removes a single item from the hash tree.
49
+ * The removal is based on matching type, id, and the provided item's version
50
+ * being greater than or equal to the existing item's version.
51
+ * @param {LeafDataItem} item The item to remove.
52
+ * @returns {boolean} True if the item was removed, false otherwise.
53
+ */
54
+ removeItem(item: LeafDataItem): boolean;
55
+ /**
56
+ * Removes multiple items from the hash tree.
57
+ * @param {LeafDataItem[]} items The array of items to remove.
58
+ * @returns {boolean[]} An array of booleans indicating success for each item.
59
+ */
60
+ removeItems(items: LeafDataItem[]): boolean[];
61
+ /**
62
+ * Updates multiple items in the hash tree.
63
+ * This method can handle both updating and removing items based on the `operation` flag.
64
+ *
65
+ * @param {object[]} itemUpdates An array of objects containing `operation` flag and the `item` to update.
66
+ * @returns {boolean[]} An array of booleans indicating success for each operation.
67
+ */
68
+ updateItems(itemUpdates: {
69
+ operation: 'update' | 'remove';
70
+ item: LeafDataItem;
71
+ }[]): boolean[];
72
+ /**
73
+ * Computes the hash for a specific leaf.
74
+ * The hash is based on the sorted items within the leaf.
75
+ * @param {number} index The index of the leaf to compute the hash for.
76
+ * @returns {void}
77
+ */
78
+ computeLeafHash(index: number): void;
79
+ /**
80
+ * Computes all internal and leaf node hashes of the tree.
81
+ * Internal node hashes are computed bottom-up from the leaf hashes.
82
+ * @returns {string[]} An array of hash strings, with internal node hashes first, followed by leaf hashes.
83
+ * Returns `[EMPTY_HASH]` if the tree has 0 leaves.
84
+ */
85
+ computeTreeHashes(): string[];
86
+ /**
87
+ * Returns all hashes in the tree (internal nodes then leaf nodes).
88
+ * @returns {string[]} An array of hash strings.
89
+ */
90
+ getHashes(): string[];
91
+ /**
92
+ * Computes and returns the hash value of the root node.
93
+ * @returns {string} The root hash of the entire tree. Returns `EMPTY_HASH` if the tree has 0 leaves.
94
+ */
95
+ getRootHash(): string;
96
+ /**
97
+ * Gets the number of leaves in the tree.
98
+ * @returns {number} The number of leaves.
99
+ */
100
+ getLeafCount(): number;
101
+ /**
102
+ * Calculates the total number of items stored in the tree.
103
+ * @returns {number} The total number of items.
104
+ */
105
+ getTotalItemCount(): number;
106
+ /**
107
+ * Retrieves all data items from a specific leaf.
108
+ * @param {number} leafIndex The index of the leaf.
109
+ * @returns {LeafDataItem[]} An array of LeafDataItem in the specified leaf, sorted by ID,
110
+ * or an empty array if the index is invalid or leaf is empty.
111
+ */
112
+ getLeafData(leafIndex: number): LeafDataItem[];
113
+ /**
114
+ * Resizes the HashTree to have a new number of leaf nodes, redistributing all existing items.
115
+ * @param {number} newNumLeaves The new number of leaf nodes (must be 0 or a power of 2).
116
+ * @returns {boolean} true if the tree was resized, false if the size didn't change.
117
+ * @throws {Error} if newNumLeaves is not 0 or a power of 2.
118
+ */
119
+ resize(newNumLeaves: number): boolean;
120
+ /**
121
+ * Compares the tree's leaf hashes with an external set of hashes and returns the indices of differing leaf nodes.
122
+ * The externalHashes array is expected to contain all node hashes (internal followed by leaves),
123
+ * similar to the output of getHashes().
124
+ * @param {string[]} externalHashes An array of hash strings (internal node hashes then leaf hashes).
125
+ * @returns {number[]} An array of indices of the leaf nodes that have different hashes.
126
+ */
127
+ diffHashes(externalHashes: string[]): number[];
128
+ }
129
+ export default HashTree;
@@ -0,0 +1,260 @@
1
+ import HashTree from './hashTree';
2
+ import { Enum } from '../constants';
3
+ import { HtMeta } from './types';
4
+ import { LocusDTO } from '../locus-info/types';
5
+ export interface DataSet {
6
+ url: string;
7
+ root: string;
8
+ version: number;
9
+ leafCount: number;
10
+ name: string;
11
+ idleMs: number;
12
+ backoff: {
13
+ maxMs: number;
14
+ exponent: number;
15
+ };
16
+ }
17
+ export interface HashTreeObject {
18
+ htMeta: HtMeta;
19
+ data: Record<string, any>;
20
+ }
21
+ export interface RootHashMessage {
22
+ dataSets: Array<DataSet>;
23
+ }
24
+ export interface HashTreeMessage {
25
+ dataSets: Array<DataSet>;
26
+ visibleDataSetsUrl: string;
27
+ locusStateElements?: Array<HashTreeObject>;
28
+ locusSessionId?: string;
29
+ locusUrl: string;
30
+ }
31
+ interface InternalDataSet extends DataSet {
32
+ hashTree?: HashTree;
33
+ timer?: ReturnType<typeof setTimeout>;
34
+ }
35
+ type WebexRequestMethod = (options: Record<string, any>) => Promise<any>;
36
+ export declare const LocusInfoUpdateType: {
37
+ readonly OBJECTS_UPDATED: "OBJECTS_UPDATED";
38
+ readonly MEETING_ENDED: "MEETING_ENDED";
39
+ };
40
+ export type LocusInfoUpdateType = Enum<typeof LocusInfoUpdateType>;
41
+ export type LocusInfoUpdateCallback = (updateType: LocusInfoUpdateType, data?: {
42
+ updatedObjects: HashTreeObject[];
43
+ }) => void;
44
+ /**
45
+ * Checks if the given hash tree object is of type "self"
46
+ * @param {HashTreeObject} object object to check
47
+ * @returns {boolean} True if the object is of type "self", false otherwise
48
+ */
49
+ export declare function isSelf(object: HashTreeObject): boolean;
50
+ /**
51
+ * Parses hash tree eventing locus data
52
+ */
53
+ declare class HashTreeParser {
54
+ dataSets: Record<string, InternalDataSet>;
55
+ visibleDataSetsUrl: string;
56
+ webexRequest: WebexRequestMethod;
57
+ locusInfoUpdateCallback: LocusInfoUpdateCallback;
58
+ visibleDataSets: string[];
59
+ debugId: string;
60
+ /**
61
+ * Constructor for HashTreeParser
62
+ * @param {Object} options
63
+ * @param {Object} options.initialLocus The initial locus data containing the hash tree information
64
+ */
65
+ constructor(options: {
66
+ initialLocus: {
67
+ dataSets: Array<DataSet>;
68
+ locus: any;
69
+ };
70
+ webexRequest: WebexRequestMethod;
71
+ locusInfoUpdateCallback: LocusInfoUpdateCallback;
72
+ debugId: string;
73
+ });
74
+ /**
75
+ * Initializes a new visible data set by creating a hash tree for it, adding it to all the internal structures,
76
+ * and sending an initial sync request to Locus with empty leaf data - that will trigger Locus to gives us all the data
77
+ * from that dataset (in the response or via messages).
78
+ *
79
+ * @param {DataSet} dataSet The new data set to be added
80
+ * @returns {Promise}
81
+ */
82
+ private initializeNewVisibleDataSet;
83
+ /**
84
+ * Sends a special sync request to Locus with all leaves empty - this is a way to get all the data for a given dataset.
85
+ *
86
+ * @param {string} datasetName - name of the dataset for which to send the request
87
+ * @param {string} debugText - text to include in logs
88
+ * @returns {Promise}
89
+ */
90
+ private sendInitializationSyncRequestToLocus;
91
+ /**
92
+ * Queries Locus for information about all the data sets
93
+ *
94
+ * @param {string} url - url from which we can get info about all data sets
95
+ * @returns {Promise}
96
+ */
97
+ private getAllDataSetsMetadata;
98
+ /**
99
+ * Initializes the hash tree parser from a message received from Locus.
100
+ *
101
+ * @param {HashTreeMessage} message - initial hash tree message received from Locus
102
+ * @returns {Promise}
103
+ */
104
+ initializeFromMessage(message: HashTreeMessage): Promise<void>;
105
+ /**
106
+ * Initializes the hash tree parser from GET /loci API response by fetching all data sets metadata
107
+ * first and then doing an initialization sync on each data set
108
+ *
109
+ * This function requires that this.visibleDataSets have been already populated correctly by the constructor.
110
+ *
111
+ * @param {LocusDTO} locus - locus object received from GET /loci
112
+ * @returns {Promise}
113
+ */
114
+ initializeFromGetLociResponse(locus: LocusDTO): Promise<void>;
115
+ /**
116
+ * Initializes data sets by doing an initialization sync on each visible data set that doesn't have a hash tree yet.
117
+ *
118
+ * @param {DataSet[]} dataSets Array of DataSet objects to initialize
119
+ * @param {string} debugText Text to include in logs for debugging purposes
120
+ * @returns {Promise}
121
+ */
122
+ private initializeDataSets;
123
+ /**
124
+ * Each dataset exists at a different place in the dto
125
+ * iterate recursively over the locus and if it has a htMeta key,
126
+ * create an object with the type, id and version and add it to the appropriate leafData array
127
+ *
128
+ * @param {any} locus - The current part of the locus being processed
129
+ * @param {Object} [options]
130
+ * @param {boolean} [options.copyData=false] - Whether to copy the data for each leaf into returned result
131
+ * @returns {any} - An object mapping dataset names to arrays of leaf data
132
+ */
133
+ private analyzeLocusHtMeta;
134
+ /**
135
+ * Checks if the provided hash tree message indicates the end of the meeting and that there won't be any more updates.
136
+ *
137
+ * @param {HashTreeMessage} message - The hash tree message to check
138
+ * @returns {boolean} - Returns true if the message indicates the end of the meeting, false otherwise
139
+ */
140
+ private isEndMessage;
141
+ /**
142
+ * Handles the root hash heartbeat message
143
+ *
144
+ * @param {RootHashMessage} message - The root hash heartbeat message
145
+ * @returns {void}
146
+ */
147
+ private handleRootHashHeartBeatMessage;
148
+ /**
149
+ * This method should be called when we receive a partial locus DTO that contains dataSets and htMeta information
150
+ * It updates the hash trees with the new leaf data based on the received Locus
151
+ *
152
+ * @param {Object} update - The locus update containing data sets and locus information
153
+ * @returns {void}
154
+ */
155
+ handleLocusUpdate(update: {
156
+ dataSets?: Array<DataSet>;
157
+ locus: any;
158
+ }): void;
159
+ /**
160
+ * Updates the internal data set information based on the received data set from Locus.
161
+ *
162
+ * @param {DataSet} receivedDataSet - The latest data set information received from Locus to update the internal state.
163
+ * @returns {void}
164
+ */
165
+ private updateDataSetInfo;
166
+ /**
167
+ * Checks for changes in the visible data sets based on the updated objects.
168
+ * @param {HashTreeObject[]} updatedObjects - The list of updated hash tree objects.
169
+ * @returns {Object} An object containing the removed and added visible data sets.
170
+ */
171
+ private checkForVisibleDataSetChanges;
172
+ /**
173
+ * Deletes the hash tree for the specified data set.
174
+ *
175
+ * @param {string} dataSetName name of the data set to delete
176
+ * @returns {void}
177
+ */
178
+ private deleteHashTree;
179
+ /**
180
+ * Adds entries to the passed in updateObjects array
181
+ * for the changes that result from removing visible data sets and creates hash
182
+ * trees for the new visible data sets, but without populating the hash trees.
183
+ *
184
+ * This function is synchronous. If we are missing information about some new
185
+ * visible data sets and they require async initialization, the names of these data sets
186
+ * are returned in an array.
187
+ *
188
+ * @param {string[]} removedDataSets - The list of removed data sets.
189
+ * @param {string[]} addedDataSets - The list of added data sets.
190
+ * @param {HashTreeObject[]} updatedObjects - The list of updated hash tree objects to which changes will be added.
191
+ * @returns {string[]} names of data sets that couldn't be initialized synchronously
192
+ */
193
+ private processVisibleDataSetChanges;
194
+ /**
195
+ * Adds entries to the passed in updateObjects array
196
+ * for the changes that result from adding and removing visible data sets.
197
+ *
198
+ * @param {HashTreeMessage} message - The hash tree message that triggered the visible data set changes.
199
+ * @param {string[]} addedDataSets - The list of added data sets.
200
+ * @returns {Promise<void>}
201
+ */
202
+ private initializeNewVisibleDataSets;
203
+ /**
204
+ * Parses incoming hash tree messages, updates the hash trees and returns information about the changes
205
+ *
206
+ * @param {HashTreeMessage} message - The hash tree message containing data sets and objects to be processed
207
+ * @param {string} [debugText] - Optional debug text to include in logs
208
+ * @returns {Promise}
209
+ */
210
+ private parseMessage;
211
+ /**
212
+ * Handles incoming hash tree messages, updates the hash trees and calls locusInfoUpdateCallback
213
+ *
214
+ * @param {HashTreeMessage} message - The hash tree message containing data sets and objects to be processed
215
+ * @param {string} [debugText] - Optional debug text to include in logs
216
+ * @returns {void}
217
+ */
218
+ handleMessage(message: HashTreeMessage, debugText?: string): Promise<void>;
219
+ /**
220
+ * Calls the updateInfo callback if there are any updates to report
221
+ *
222
+ * @param {Object} updates parsed from a Locus message
223
+ * @returns {void}
224
+ */
225
+ private callLocusInfoUpdateCallback;
226
+ /**
227
+ * Calculates a weighted backoff time that should be used for syncs
228
+ *
229
+ * @param {Object} backoff - The backoff configuration containing maxMs and exponent
230
+ * @returns {number} - A weighted backoff time based on the provided configuration, using algorithm supplied by Locus team
231
+ */
232
+ private getWeightedBackoffTime;
233
+ /**
234
+ * Runs the sync algorithm for the given data set.
235
+ *
236
+ * @param {DataSet} receivedDataSet - The data set to run the sync algorithm for.
237
+ * @returns {void}
238
+ */
239
+ private runSyncAlgorithm;
240
+ /**
241
+ * Stops all timers for the data sets to prevent any further sync attempts.
242
+ * @returns {void}
243
+ */
244
+ private stopAllTimers;
245
+ /**
246
+ * Gets the current hashes from the locus for a specific data set.
247
+ * @param {string} dataSetName
248
+ * @returns {string[]}
249
+ */
250
+ private getHashesFromLocus;
251
+ /**
252
+ * Sends a sync request to Locus for the specified data set.
253
+ *
254
+ * @param {InternalDataSet} dataSet The data set to sync.
255
+ * @param {Record<number, LeafDataItem[]>} mismatchedLeavesData The mismatched leaves data to include in the sync request.
256
+ * @returns {Promise<HashTreeMessage|null>}
257
+ */
258
+ private sendSyncRequestToLocus;
259
+ }
260
+ export default HashTreeParser;
@@ -0,0 +1,27 @@
1
+ import { Enum } from '../constants';
2
+ export declare const ObjectType: {
3
+ readonly participant: "participant";
4
+ readonly self: "self";
5
+ readonly locus: "locus";
6
+ readonly mediaShare: "mediashare";
7
+ readonly info: "info";
8
+ readonly fullState: "fullstate";
9
+ readonly links: "links";
10
+ };
11
+ export type ObjectType = Enum<typeof ObjectType>;
12
+ export declare const ObjectTypeToLocusKeyMap: {
13
+ links: string;
14
+ info: string;
15
+ fullstate: string;
16
+ self: string;
17
+ participant: string;
18
+ mediashare: string;
19
+ };
20
+ export interface HtMeta {
21
+ elementId: {
22
+ type: ObjectType;
23
+ id: number;
24
+ version: number;
25
+ };
26
+ dataSetNames: string[];
27
+ }
@@ -0,0 +1,9 @@
1
+ /**
2
+ * Analyzes given part of Locus DTO recursively and delete any nested objects that have their own htMeta
3
+ *
4
+ * @param {Object} currentLocusPart part of locus DTO to analyze
5
+ * @param {Object} parent parent object
6
+ * @param {string|number} currentKey key of the parent object that currentLocusPart is
7
+ * @returns {void}
8
+ */
9
+ export declare const deleteNestedObjectsWithHtMeta: (currentLocusPart: any, parent?: any, currentKey?: string | number) => void;
@@ -1,45 +1,15 @@
1
1
  import EventsScope from '../common/events/events-scope';
2
- export type LocusDTO = {
3
- controls?: any;
4
- fullState?: {
5
- active: boolean;
6
- count: number;
7
- lastActive: string;
8
- locked: boolean;
9
- sessionId: string;
10
- seessionIds: string[];
11
- startTime: number;
12
- state: string;
13
- type: string;
2
+ import { LOCUSEVENT } from '../constants';
3
+ import HashTreeParser, { DataSet, HashTreeMessage, HashTreeObject } from '../hashTree/hashTreeParser';
4
+ import { Links, LocusDTO } from './types';
5
+ export type LocusLLMEvent = {
6
+ data: {
7
+ eventType: typeof LOCUSEVENT.HASH_TREE_DATA_UPDATED;
8
+ stateElementsMessage: HashTreeMessage;
14
9
  };
15
- host?: {
16
- id: string;
17
- incomingCallProtocols: any[];
18
- isExternal: boolean;
19
- name: string;
20
- orgId: string;
21
- };
22
- info?: any;
23
- links?: any;
24
- mediaShares?: any[];
25
- meetings?: any[];
26
- participants: any[];
27
- replaces?: any[];
28
- self?: any;
29
- sequence?: {
30
- dirtyParticipants: number;
31
- entries: number[];
32
- rangeEnd: number;
33
- rangeStart: number;
34
- sequenceHash: number;
35
- sessionToken: string;
36
- since: string;
37
- totalParticipants: number;
38
- };
39
- syncUrl?: string;
40
- url?: string;
41
10
  };
42
11
  export type LocusApiResponseBody = {
12
+ dataSets?: DataSet[];
43
13
  locus: LocusDTO;
44
14
  };
45
15
  /**
@@ -76,10 +46,12 @@ export default class LocusInfo extends EventsScope {
76
46
  mediaShares: any;
77
47
  replace: any;
78
48
  url: any;
79
- services: any;
80
- resources: any;
49
+ links?: Links;
81
50
  mainSessionLocusCache: any;
82
51
  self: any;
52
+ hashTreeParser?: HashTreeParser;
53
+ hashTreeObjectId2ParticipantId: Map<number, string>;
54
+ classicVsHashTreeMismatchMetricCounter: number;
83
55
  /**
84
56
  * Constructor
85
57
  * @param {function} updateMeeting callback to update the meeting object from an object
@@ -90,6 +62,7 @@ export default class LocusInfo extends EventsScope {
90
62
  constructor(updateMeeting: any, webex: any, meetingId: any);
91
63
  /**
92
64
  * 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.
65
+ * WARNING: This function must not be used for hash tree based Locus meetings.
93
66
  *
94
67
  * @param {Meeting} meeting
95
68
  * @param {boolean} isLocusUrlChanged
@@ -121,11 +94,28 @@ export default class LocusInfo extends EventsScope {
121
94
  */
122
95
  init(locus?: any): void;
123
96
  /**
124
- * @param {Object} locus
97
+ * Creates the HashTreeParser instance.
98
+ * @param {Object} initial locus data
99
+ * @returns {void}
100
+ */
101
+ private createHashTreeParser;
102
+ /**
103
+ * @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
125
104
  * @returns {undefined}
126
105
  * @memberof LocusInfo
127
106
  */
128
- initialSetup(locus: object): void;
107
+ initialSetup(data: {
108
+ trigger: 'join-response';
109
+ locus: LocusDTO;
110
+ dataSets?: DataSet[];
111
+ } | {
112
+ trigger: 'locus-message';
113
+ locus?: LocusDTO;
114
+ hashTreeMessage?: HashTreeMessage;
115
+ } | {
116
+ trigger: 'get-loci-response';
117
+ locus?: LocusDTO;
118
+ }): Promise<void>;
129
119
  /**
130
120
  * Handles HTTP response from Locus API call.
131
121
  * @param {Meeting} meeting meeting object
@@ -133,6 +123,39 @@ export default class LocusInfo extends EventsScope {
133
123
  * @returns {void}
134
124
  */
135
125
  handleLocusAPIResponse(meeting: any, responseBody: LocusApiResponseBody): void;
126
+ /**
127
+ *
128
+ * @param {HashTreeObject} object data set object
129
+ * @param {any} locus
130
+ * @returns {void}
131
+ */
132
+ updateLocusFromHashTreeObject(object: HashTreeObject, locus: LocusDTO): LocusDTO;
133
+ /**
134
+ * Sends a metric when we receive something from Locus that uses hash trees while we
135
+ * expect classic deltas or the other way around.
136
+ * @param {Meeting} meeting
137
+ * @param {string} message
138
+ * @returns {void}
139
+ */
140
+ sendClassicVsHashTreeMismatchMetric(meeting: any, message: string): void;
141
+ /**
142
+ * Handles a hash tree message received from Locus.
143
+ *
144
+ * @param {Meeting} meeting - The meeting object
145
+ * @param {eventType} eventType - The event type
146
+ * @param {HashTreeMessage} message incoming hash tree message
147
+ * @returns {void}
148
+ */
149
+ private handleHashTreeMessage;
150
+ /**
151
+ * Callback registered with HashTreeParser to receive locus info updates.
152
+ * Updates our locus info based on the data parsed by the hash tree parser.
153
+ *
154
+ * @param {LocusInfoUpdateType} updateType - The type of update received.
155
+ * @param {Object} [data] - Additional data for the update, if applicable.
156
+ * @returns {void}
157
+ */
158
+ private updateFromHashTree;
136
159
  /**
137
160
  * @param {Meeting} meeting
138
161
  * @param {Object} data
@@ -148,14 +171,39 @@ export default class LocusInfo extends EventsScope {
148
171
  * @memberof LocusInfo
149
172
  */
150
173
  emitScoped(scope?: any, eventName?: string, args?: any): boolean;
174
+ /**
175
+ * Function for handling full locus when it's using hash trees (so not the "classic" one).
176
+ *
177
+ * @param {object} locus locus object
178
+ * @param {string} eventType locus event
179
+ * @param {DataSet[]} dataSets
180
+ * @returns {void}
181
+ */
182
+ private onFullLocusWithHashTrees;
183
+ /**
184
+ * Function for handling full locus when it's the "classic" one (not hash trees)
185
+ *
186
+ * @param {object} locus locus object
187
+ * @param {string} eventType locus event
188
+ * @returns {void}
189
+ */
190
+ private onFullLocusClassic;
151
191
  /**
152
192
  * updates the locus with full locus object
153
193
  * @param {object} locus locus object
154
- * @param {string} eventType particulat locus event
194
+ * @param {string} eventType locus event
195
+ * @param {DataSet[]} dataSets
155
196
  * @returns {object} null
156
197
  * @memberof LocusInfo
157
198
  */
158
- onFullLocus(locus: any, eventType?: string): void;
199
+ onFullLocus(locus: any, eventType?: string, dataSets?: Array<DataSet>): void;
200
+ /**
201
+ * Common part of handling full locus, used by both classic and hash tree based locus handling
202
+ * @param {object} locus locus object
203
+ * @param {string} eventType locus event
204
+ * @returns {void}
205
+ */
206
+ private onFullLocusCommon;
159
207
  /**
160
208
  * @param {String} eventType
161
209
  * @returns {undefined}
@@ -229,21 +277,12 @@ export default class LocusInfo extends EventsScope {
229
277
  */
230
278
  updateCreated(created: object): void;
231
279
  /**
232
- * @param {Object} services
233
- * @returns {undefined}
234
- * @memberof LocusInfo
235
- */
236
- updateServices(services: Record<'breakout' | 'record', {
237
- url: string;
238
- }>): void;
239
- /**
240
- * @param {Object} resources
280
+ * Updates links and emits appropriate events if services or resources have changed
281
+ * @param {Object} links
241
282
  * @returns {undefined}
242
283
  * @memberof LocusInfo
243
284
  */
244
- updateResources(resources: Record<'webcastInstance', {
245
- url: string;
246
- }>): void;
285
+ updateLinks(links?: Links): void;
247
286
  /**
248
287
  * @param {Object} fullState
249
288
  * @returns {undefined}
@@ -0,0 +1,54 @@
1
+ import { HtMeta } from '../hashTree/types';
2
+ export type LocusFullState = {
3
+ active: boolean;
4
+ count: number;
5
+ lastActive: string;
6
+ locked: boolean;
7
+ sessionId: string;
8
+ seessionIds: string[];
9
+ startTime: number;
10
+ state: string;
11
+ type: string;
12
+ };
13
+ export type Links = {
14
+ services: Record<'breakout' | 'record', {
15
+ url: string;
16
+ }>;
17
+ resources: Record<'webcastInstance' | 'visibleDataSets', {
18
+ url: string;
19
+ }>;
20
+ };
21
+ export type LocusDTO = {
22
+ controls?: any;
23
+ fullState?: LocusFullState;
24
+ host?: {
25
+ id: string;
26
+ incomingCallProtocols: any[];
27
+ isExternal: boolean;
28
+ name: string;
29
+ orgId: string;
30
+ };
31
+ htMeta?: HtMeta;
32
+ info?: any;
33
+ jsSdkMeta?: {
34
+ removedParticipantIds: string[];
35
+ };
36
+ links?: Links;
37
+ mediaShares?: any[];
38
+ meetings?: any[];
39
+ participants: any[];
40
+ replaces?: any[];
41
+ self?: any;
42
+ sequence?: {
43
+ dirtyParticipants: number;
44
+ entries: number[];
45
+ rangeEnd: number;
46
+ rangeStart: number;
47
+ sequenceHash: number;
48
+ sessionToken: string;
49
+ since: string;
50
+ totalParticipants: number;
51
+ };
52
+ syncUrl?: string;
53
+ url?: string;
54
+ };