/
chatClient.ts
437 lines (387 loc) · 13.7 KB
/
chatClient.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
// Copyright (c) Microsoft Corporation.
// Licensed under the MIT license.
/// <reference lib="esnext.asynciterable" />
import { logger } from "./models/logger";
import { EventEmitter } from "events";
import { SDK_VERSION } from "./constants";
import { CommunicationUserCredential } from "@azure/communication-common";
import {
SignalingClient,
ChatEventId,
ChatMessageReceivedEvent,
ChatMessageEditedEvent,
ChatMessageDeletedEvent,
ReadReceiptReceivedEvent,
TypingIndicatorReceivedEvent
} from "@azure/communication-signaling";
import { getSignalingClient } from "./signaling/signalingClient";
import { createCommunicationUserCredentialPolicy } from "./credential/communicationUserCredentialPolicy";
import { ChatApiClient } from "./generated/src/chatApiClient";
import {
InternalPipelineOptions,
createPipelineFromOptions,
operationOptionsToRequestOptionsBase
} from "@azure/core-http";
import "@azure/core-paging";
import { PagedAsyncIterableIterator } from "@azure/core-paging";
import { CanonicalCode } from "@opentelemetry/api";
import { createSpan } from "./tracing";
import { ChatThreadClient } from "./chatThreadClient";
import {
ChatClientOptions,
CreateChatThreadOptions,
GetChatThreadOptions,
ListChatThreadsOptions,
DeleteChatThreadOptions
} from "./models/options";
import { GetChatThreadResponse, ListPageSettings, OperationResponse } from "./models/models";
import {
mapToChatThreadSdkModel,
attachHttpResponse,
mapToChatThreadMemberRestModel
} from "./models/mappers";
import { ChatThreadInfo } from "./generated/src/models";
import { CreateChatThreadRequest } from "./models/requests";
export { ChatThreadInfo } from "./generated/src/models";
/**
* The client to do chat operations
*/
export class ChatClient {
private readonly tokenCredential: CommunicationUserCredential;
private readonly clientOptions: ChatClientOptions;
private readonly api: ChatApiClient;
private readonly signalingClient: SignalingClient | undefined = undefined;
private readonly emitter = new EventEmitter();
private isRealtimeNotificationsStarted: boolean = false;
/**
* Creates an instance of the ChatClient for a given resource and user.
*
* @param url The url of the Communication Services resouce.
* @param credential The user credential. Use AzureCommunicationUserCredential from @azure/communication-common to create a credential.
* @param options Additional client options.
*/
constructor(
private readonly url: string,
credential: CommunicationUserCredential,
options: ChatClientOptions = {}
) {
this.tokenCredential = credential;
this.clientOptions = { ...options };
const libInfo = `azsdk-js-communication-chat/${SDK_VERSION}`;
if (!options.userAgentOptions) {
options.userAgentOptions = {};
}
const userAgentOptions = { ...options.userAgentOptions };
if (options.userAgentOptions.userAgentPrefix) {
userAgentOptions.userAgentPrefix = `${options.userAgentOptions.userAgentPrefix} ${libInfo}`;
} else {
userAgentOptions.userAgentPrefix = libInfo;
}
const internalPipelineOptions: InternalPipelineOptions = {
...{ ...options, userAgentOptions },
...{
loggingOptions: {
logger: logger.info
}
}
};
const authPolicy = createCommunicationUserCredentialPolicy(this.tokenCredential);
const pipeline = createPipelineFromOptions(internalPipelineOptions, authPolicy);
this.api = new ChatApiClient(this.url, pipeline);
this.signalingClient = getSignalingClient(credential, logger);
}
/**
* Returns ChatThreadClient with the specific thread id.
* @param threadId Thread ID for the ChatThreadClient
*/
public async getChatThreadClient(threadId: string): Promise<ChatThreadClient> {
return new ChatThreadClient(threadId, this.url, this.tokenCredential, this.clientOptions);
}
/**
* Creates a chat thread.
* Returns thread client with the id of the created thread.
* @param request Request for creating a chat thread.
* @param options Operation options.
*/
public async createChatThread(
request: CreateChatThreadRequest,
options: CreateChatThreadOptions = {}
): Promise<ChatThreadClient> {
const { span, updatedOptions } = createSpan("ChatClient-CreateChatThread", options);
try {
const response = await this.api.createChatThread(
{
topic: request.topic,
members: request.members?.map((member) => mapToChatThreadMemberRestModel(member))
},
operationOptionsToRequestOptionsBase(updatedOptions)
);
const multiStatusResponses = response.multipleStatus ?? [];
const threadId = multiStatusResponses.find((r) => r.type === "Thread" && r.statusCode === 201)
?.id;
if (threadId) {
return this.getChatThreadClient(threadId);
}
throw new Error("Chat thread creation failed.");
} catch (e) {
span.setStatus({
code: CanonicalCode.UNKNOWN,
message: e.message
});
throw e;
} finally {
span.end();
}
}
/**
* Gets a chat thread.
* Returns the chat thread.
* @param threadId The ID of the thread to get.
* @param options Operation options.
*/
public async getChatThread(
threadId: string,
options: GetChatThreadOptions = {}
): Promise<GetChatThreadResponse> {
const { span, updatedOptions } = createSpan("ChatClient-GetChatThread", options);
try {
const response = await this.api.getChatThread(
threadId,
operationOptionsToRequestOptionsBase(updatedOptions)
);
const thread = mapToChatThreadSdkModel(response);
return attachHttpResponse(thread, response._response);
} catch (e) {
span.setStatus({
code: CanonicalCode.UNKNOWN,
message: e.message
});
throw e;
} finally {
span.end();
}
}
private async *listChatThreadsPage(
continuationState: ListPageSettings,
options: ListChatThreadsOptions = {}
): AsyncIterableIterator<ChatThreadInfo[]> {
const requestOptions = operationOptionsToRequestOptionsBase(options);
if (!continuationState.continuationToken) {
const currentSetResponse = await this.api.listChatThreads(requestOptions);
continuationState.continuationToken = currentSetResponse.nextLink;
if (currentSetResponse.value) {
yield currentSetResponse.value;
}
}
while (continuationState.continuationToken) {
const currentSetResponse = await this.api.listChatThreadsNext(
continuationState.continuationToken,
requestOptions
);
continuationState.continuationToken = currentSetResponse.nextLink;
if (currentSetResponse.value) {
yield currentSetResponse.value;
} else {
break;
}
}
}
private async *listChatThreadsAll(
options: ListChatThreadsOptions
): AsyncIterableIterator<ChatThreadInfo> {
for await (const page of this.listChatThreadsPage({}, options)) {
yield* page;
}
}
/**
* Gets the list of chat threads of a user.
* @param options List chat threads options.
*/
public listChatThreads(
options: ListChatThreadsOptions = {}
): PagedAsyncIterableIterator<ChatThreadInfo> {
const { span, updatedOptions } = createSpan("ChatClient-ListChatThreads", options);
try {
const iter = this.listChatThreadsAll(updatedOptions);
return {
next() {
return iter.next();
},
[Symbol.asyncIterator]() {
return this;
},
byPage: (settings: ListPageSettings = {}) => {
return this.listChatThreadsPage(settings, updatedOptions);
}
};
} catch (e) {
span.setStatus({
code: CanonicalCode.UNKNOWN,
message: e.message
});
throw e;
} finally {
span.end();
}
}
/**
* Deletes a chat thread.
* @param threadId The ID of the thread to delete.
* @param options Operation options.
*/
public async deleteChatThread(
threadId: string,
options: DeleteChatThreadOptions = {}
): Promise<OperationResponse> {
const { span, updatedOptions } = createSpan("ChatClient-DeleteChatThread", options);
try {
return await this.api.deleteChatThread(
threadId,
operationOptionsToRequestOptionsBase(updatedOptions)
);
} catch (e) {
span.setStatus({
code: CanonicalCode.UNKNOWN,
message: e.message
});
throw e;
} finally {
span.end();
}
}
/**
* Start receiving realtime notifications.
* Call this function before subscribing to any event.
*/
public async startRealtimeNotifications(): Promise<void> {
if (this.signalingClient === undefined) {
throw new Error("Realtime notifications are only supported in the browser.");
}
if (this.isRealtimeNotificationsStarted) {
return;
}
this.isRealtimeNotificationsStarted = true;
this.signalingClient.start();
this.subscribeToSignalingEvents();
}
/**
* Stop receiving realtime notifications.
* This function would unsubscribe to all events.
*/
public async stopRealtimeNotifications(): Promise<void> {
if (this.signalingClient === undefined) {
throw new Error("Realtime notifications are only supported in the browser.");
}
this.isRealtimeNotificationsStarted = false;
this.signalingClient.stop();
this.emitter.removeAllListeners();
}
/**
* Subscribe function for chatMessageReceived.
* The initial sender will also receive this event.
* You need to call startRealtimeNotifications before subscribing to any event.
* @param event The ChatMessageReceivedEvent.
* @param listener The listener to handle the event.
*/
public on(event: "chatMessageReceived", listener: (e: ChatMessageReceivedEvent) => void): void;
/**
* Subscribe function for chatMessageEdited.
* The initial sender will also receive this event.
* @param event The ChatMessageEditedEvent.
* @param listener The listener to handle the event.
*/
public on(event: "chatMessageEdited", listener: (e: ChatMessageEditedEvent) => void): void;
/**
* Subscribe function for chatMessageDeleted.
* The initial sender will also receive this event.
* @param event The ChatMessageDeletedEvent.
* @param listener The listener to handle the event.
*/
public on(event: "chatMessageDeleted", listener: (e: ChatMessageDeletedEvent) => void): void;
/**
* Subscribe function for typingIndicatorReceived.
* The initial sender will also receive this event.
* @param event The TypingIndicatorReceivedEvent.
* @param listener The listener to handle the event.
*/
public on(
event: "typingIndicatorReceived",
listener: (e: TypingIndicatorReceivedEvent) => void
): void;
/**
* Subscribe function for readReceiptReceived.
* @param event The ReadReceiptReceivedEvent.
* @param listener The listener to handle the event.
*/
public on(event: "readReceiptReceived", listener: (e: ReadReceiptReceivedEvent) => void): void;
public on(event: ChatEventId, listener: (e: any) => void): void {
if (this.signalingClient === undefined) {
throw new Error("Realtime notifications are only supported in the browser.");
}
if (!this.isRealtimeNotificationsStarted) {
throw new Error(
"You must call startRealtimeNotifications before you can subscribe to events."
);
}
this.emitter.on(event, listener);
}
/**
* Unsubscribe from chatMessageReceived.
* @param event The ChatMessageReceivedEvent.
* @param listener The listener to handle the event.
*/
public off(event: "chatMessageReceived", listener: (e: ChatMessageReceivedEvent) => void): void;
/**
* Unsubscribe from chatMessageEdited.
* @param event The ChatMessageEditedEvent.
* @param listener The listener to handle the event.
*/
public off(event: "chatMessageEdited", listener: (e: ChatMessageEditedEvent) => void): void;
/**
* Unsubscribe from chatMessageDeleted.
* @param event The ChatMessageDeletedEvent.
* @param listener The listener to handle the event.
*/
public off(event: "chatMessageDeleted", listener: (e: ChatMessageDeletedEvent) => void): void;
/**
* Unsubscribe from typingIndicatorReceived.
* @param event The TypingIndicatorReceivedEvent.
* @param listener The listener to handle the event.
*/
public off(
event: "typingIndicatorReceived",
listener: (e: TypingIndicatorReceivedEvent) => void
): void;
/**
* Unsubscribe from readReceiptReceived.
* @param event The ReadReceiptReceivedEvent.
* @param listener The listener to handle the event.
*/
public off(event: "readReceiptReceived", listener: (e: ReadReceiptReceivedEvent) => void): void;
public off(event: ChatEventId, listener: (e: any) => void): void {
if (this.signalingClient === undefined) {
throw new Error("Realtime notifications are only supported in the browser.");
}
this.emitter.removeListener(event, listener);
}
private subscribeToSignalingEvents(): void {
if (this.signalingClient === undefined) {
throw new Error("Realtime notifications are only supported in the browser.");
}
this.signalingClient.on("chatMessageReceived", (payload) => {
this.emitter.emit("chatMessageReceived", payload);
});
this.signalingClient.on("chatMessageEdited", (payload) => {
this.emitter.emit("chatMessageEdited", payload);
});
this.signalingClient.on("chatMessageDeleted", (payload) => {
this.emitter.emit("chatMessageDeleted", payload);
});
this.signalingClient.on("typingIndicatorReceived", (payload) => {
this.emitter.emit("typingIndicatorReceived", payload);
});
this.signalingClient.on("readReceiptReceived", (payload) => {
this.emitter.emit("readReceiptReceived", payload);
});
}
}