@azure/communication-chat 1.1.1 → 1.1.2-alpha.20220113.1

package/CHANGELOG.md

@@ -1,8 +1,20 @@
 # Release History
 
+## 1.1.2 (Unreleased)
+
+### Breaking Changes
+
+- Prohibit sending the typing notification request within 8 seconds of the previous request.
+
+### Features Added
+
+- Updated to @azure/communication-signaling@1.0.0-beta.12.
+- Added two new events realTimeNotificationConnected and realTimeNotificationDisconnected that allow the developer to know when the connection to the call server is active
+
 ## 1.1.1 (2021-10-19)
 
 ### Features Added
+
 - Updated to @azure/communication-signaling@1.0.0-beta.11.
 - Added `signalingClientOptions` in `ClientOptions`.
 

package/dist/index.js

@@ -3,40 +3,14 @@
 Object.defineProperty(exports, '__esModule', { value: true });
 
 var tslib = require('tslib');
-var logger$1 = require('@azure/logger');
-var events = require('events');
-var communicationSignaling = require('@azure/communication-signaling');
-var coreTracing = require('@azure/core-tracing');
 var communicationCommon = require('@azure/communication-common');
 var coreClient = require('@azure/core-client');
+var logger$1 = require('@azure/logger');
+var coreTracing = require('@azure/core-tracing');
 var coreRestPipeline = require('@azure/core-rest-pipeline');
+var events = require('events');
 var uuid = require('uuid');
-
-// Copyright (c) Microsoft Corporation.
-const logger = logger$1.createClientLogger("communication-chat");
-
-// Copyright (c) Microsoft Corporation.
-const getSignalingClient = (credential, logger, options) => {
-    var _a;
-    if (typeof navigator !== "undefined" && navigator.product === "ReactNative") {
-        // In React Native
-        return new communicationSignaling.CommunicationSignalingClient(credential, logger, {
-            environment: (_a = options === null || options === void 0 ? void 0 : options.environment) !== null && _a !== void 0 ? _a : undefined
-        });
-    }
-    // In node js
-    return undefined;
-};
-
-// Copyright (c) Microsoft Corporation.
-/**
- * Creates a span using the global tracer.
- * @internal
- */
-const createSpan = coreTracing.createSpanFunction({
-    packagePrefix: "Azure.Communication",
-    namespace: "Microsoft.Communication"
-});
+var communicationSignaling = require('@azure/communication-signaling');
 
 // Copyright (c) Microsoft Corporation.
 const mapToCreateChatThreadOptionsRestModel = (options) => {
@@ -58,7 +32,7 @@ const mapToChatParticipantRestModel = (chatParticipant) => {
 const mapToAddChatParticipantsRequestRestModel = (addParticipantsRequest) => {
     var _a;
     return {
-        participants: (_a = addParticipantsRequest.participants) === null || _a === void 0 ? void 0 : _a.map((participant) => mapToChatParticipantRestModel(participant))
+        participants: (_a = addParticipantsRequest.participants) === null || _a === void 0 ? void 0 : _a.map((participant) => mapToChatParticipantRestModel(participant)),
     };
 };
 /**
@@ -1958,7 +1932,7 @@ class ChatApiClientContext extends coreClient.ServiceClient {
         const defaults = {
             requestContentType: "application/json; charset=utf-8"
         };
-        const packageDetails = `azsdk-js-azure-communication-chat/1.1.0`;
+        const packageDetails = `azsdk-js-azure-communication-chat/1.1.2`;
         const userAgentPrefix = options.userAgentOptions && options.userAgentOptions.userAgentPrefix
             ? `${options.userAgentOptions.userAgentPrefix} ${packageDetails}`
             : `${packageDetails}`;
@@ -1993,6 +1967,19 @@ class ChatApiClient extends ChatApiClientContext {
     }
 }
 
+// Copyright (c) Microsoft Corporation.
+const logger = logger$1.createClientLogger("communication-chat");
+
+// Copyright (c) Microsoft Corporation.
+/**
+ * Creates a span using the global tracer.
+ * @internal
+ */
+const createSpan = coreTracing.createSpanFunction({
+    packagePrefix: "Azure.Communication",
+    namespace: "Microsoft.Communication",
+});
+
 // Copyright (c) Microsoft Corporation.
 /**
  * Creates a new CommunicationTokenCredentialPolicy factory.
@@ -2002,9 +1989,9 @@ class ChatApiClient extends ChatApiClientContext {
 const createCommunicationTokenCredentialPolicy = (credential) => {
     const policyOptions = {
         credential: {
-            getToken: (_scopes, options) => credential.getToken({ abortSignal: options === null || options === void 0 ? void 0 : options.abortSignal })
+            getToken: (_scopes, options) => credential.getToken({ abortSignal: options === null || options === void 0 ? void 0 : options.abortSignal }),
         },
-        scopes: []
+        scopes: [],
     };
     return coreRestPipeline.bearerTokenAuthenticationPolicy(policyOptions);
 };
@@ -2022,8 +2009,8 @@ class ChatThreadClient {
         this.tokenCredential = credential;
         const internalPipelineOptions = Object.assign(Object.assign({}, options), {
             loggingOptions: {
-                logger: logger.info
-            }
+                logger: logger.info,
+            },
         });
         this.client = new ChatApiClient(this.endpoint, Object.assign({ endpoint: this.endpoint }, internalPipelineOptions));
         const authPolicy = createCommunicationTokenCredentialPolicy(this.tokenCredential);
@@ -2043,7 +2030,7 @@ class ChatThreadClient {
         catch (e) {
             span.setStatus({
                 code: coreTracing.SpanStatusCode.ERROR,
-                message: e.message
+                message: e.message,
             });
             throw e;
         }
@@ -2064,7 +2051,7 @@ class ChatThreadClient {
         catch (e) {
             span.setStatus({
                 code: coreTracing.SpanStatusCode.ERROR,
-                message: e.message
+                message: e.message,
             });
             throw e;
         }
@@ -2089,7 +2076,7 @@ class ChatThreadClient {
         catch (e) {
             span.setStatus({
                 code: coreTracing.SpanStatusCode.ERROR,
-                message: e.message
+                message: e.message,
             });
             throw e;
         }
@@ -2112,7 +2099,7 @@ class ChatThreadClient {
         catch (e) {
             span.setStatus({
                 code: coreTracing.SpanStatusCode.ERROR,
-                message: e.message
+                message: e.message,
             });
             throw e;
         }
@@ -2177,13 +2164,13 @@ class ChatThreadClient {
                 },
                 byPage: (settings = {}) => {
                     return this.listMessagesPage(settings, updatedOptions);
-                }
+                },
             };
         }
         catch (e) {
             span.setStatus({
                 code: coreTracing.SpanStatusCode.ERROR,
-                message: e.message
+                message: e.message,
             });
             throw e;
         }
@@ -2204,7 +2191,7 @@ class ChatThreadClient {
         catch (e) {
             span.setStatus({
                 code: coreTracing.SpanStatusCode.ERROR,
-                message: e.message
+                message: e.message,
             });
             throw e;
         }
@@ -2225,7 +2212,7 @@ class ChatThreadClient {
         catch (e) {
             span.setStatus({
                 code: coreTracing.SpanStatusCode.ERROR,
-                message: e.message
+                message: e.message,
             });
             throw e;
         }
@@ -2247,7 +2234,7 @@ class ChatThreadClient {
         catch (e) {
             span.setStatus({
                 code: coreTracing.SpanStatusCode.ERROR,
-                message: e.message
+                message: e.message,
             });
             throw e;
         }
@@ -2312,13 +2299,13 @@ class ChatThreadClient {
                 },
                 byPage: (settings = {}) => {
                     return this.listParticipantsPage(settings, updatedOptions);
-                }
+                },
             };
         }
         catch (e) {
             span.setStatus({
                 code: coreTracing.SpanStatusCode.ERROR,
-                message: e.message
+                message: e.message,
             });
             throw e;
         }
@@ -2339,7 +2326,7 @@ class ChatThreadClient {
         catch (e) {
             span.setStatus({
                 code: coreTracing.SpanStatusCode.ERROR,
-                message: e.message
+                message: e.message,
             });
             throw e;
         }
@@ -2359,8 +2346,8 @@ class ChatThreadClient {
             const dateNow = new Date();
             const { senderDisplayName } = updatedOptions, restOptions = tslib.__rest(updatedOptions, ["senderDisplayName"]);
             if (this.canPostTypingNotification(dateNow)) {
-                await this.client.chatThread.sendTypingNotification(this.threadId, Object.assign({ sendTypingNotificationRequest: { senderDisplayName: senderDisplayName } }, restOptions));
                 this.timeOfLastTypingRequest = dateNow;
+                await this.client.chatThread.sendTypingNotification(this.threadId, Object.assign({ sendTypingNotificationRequest: { senderDisplayName: senderDisplayName } }, restOptions));
                 return true;
             }
             logger.info(`Typing Notification NOT Send. [thread_id=${this.threadId}]`);
@@ -2369,7 +2356,7 @@ class ChatThreadClient {
         catch (e) {
             span.setStatus({
                 code: coreTracing.SpanStatusCode.ERROR,
-                message: e.message
+                message: e.message,
             });
             throw e;
         }
@@ -2391,7 +2378,7 @@ class ChatThreadClient {
         catch (e) {
             span.setStatus({
                 code: coreTracing.SpanStatusCode.ERROR,
-                message: e.message
+                message: e.message,
             });
             throw e;
         }
@@ -2456,13 +2443,13 @@ class ChatThreadClient {
                 },
                 byPage: (settings = {}) => {
                     return this.listReadReceiptsPage(settings, updatedOptions);
-                }
+                },
             };
         }
         catch (e) {
             span.setStatus({
                 code: coreTracing.SpanStatusCode.ERROR,
-                message: e.message
+                message: e.message,
             });
             throw e;
         }
@@ -2493,6 +2480,19 @@ function generateUuid() {
     return uuid.v4();
 }
 
+// Copyright (c) Microsoft Corporation.
+const getSignalingClient = (credential, logger, options) => {
+    var _a;
+    if (typeof navigator !== "undefined" && navigator.product === "ReactNative") {
+        // In React Native
+        return new communicationSignaling.CommunicationSignalingClient(credential, logger, {
+            environment: (_a = options === null || options === void 0 ? void 0 : options.environment) !== null && _a !== void 0 ? _a : undefined,
+        });
+    }
+    // In node js
+    return undefined;
+};
+
 // Copyright (c) Microsoft Corporation.
 /**
  * The client to do chat operations
@@ -2514,8 +2514,8 @@ class ChatClient {
         this.clientOptions = Object.assign({}, options);
         const internalPipelineOptions = Object.assign(Object.assign({}, options), {
             loggingOptions: {
-                logger: logger.info
-            }
+                logger: logger.info,
+            },
         });
         this.client = new ChatApiClient(this.endpoint, Object.assign({ endpoint: this.endpoint }, internalPipelineOptions));
         const authPolicy = createCommunicationTokenCredentialPolicy(this.tokenCredential);
@@ -2544,14 +2544,14 @@ class ChatClient {
             const updatedRestModelOptions = mapToCreateChatThreadOptionsRestModel(updatedOptions);
             const result = await this.client.chat.createChatThread({
                 topic: request.topic,
-                participants: (_b = options.participants) === null || _b === void 0 ? void 0 : _b.map((participant) => mapToChatParticipantRestModel(participant))
+                participants: (_b = options.participants) === null || _b === void 0 ? void 0 : _b.map((participant) => mapToChatParticipantRestModel(participant)),
             }, updatedRestModelOptions);
             return mapToCreateChatThreadResultSdkModel(result);
         }
         catch (e) {
             span.setStatus({
                 code: coreTracing.SpanStatusCode.ERROR,
-                message: e.message
+                message: e.message,
             });
             throw e;
         }
@@ -2615,13 +2615,13 @@ class ChatClient {
                 },
                 byPage: (settings = {}) => {
                     return this.listChatThreadsPage(settings, updatedOptions);
-                }
+                },
             };
         }
         catch (e) {
             span.setStatus({
                 code: coreTracing.SpanStatusCode.ERROR,
-                message: e.message
+                message: e.message,
             });
             throw e;
         }
@@ -2642,7 +2642,7 @@ class ChatClient {
         catch (e) {
             span.setStatus({
                 code: coreTracing.SpanStatusCode.ERROR,
-                message: e.message
+                message: e.message,
             });
             throw e;
         }
@@ -2681,7 +2681,9 @@ class ChatClient {
         if (this.signalingClient === undefined) {
             throw new Error("Realtime notifications are only supported in the browser.");
         }
-        if (!this.isRealtimeNotificationsStarted) {
+        if (!this.isRealtimeNotificationsStarted &&
+            event !== "realTimeNotificationConnected" &&
+            event !== "realTimeNotificationDisconnected") {
             throw new Error("You must call startRealtimeNotifications before you can subscribe to events.");
         }
         this.emitter.on(event, listener);
@@ -2696,6 +2698,14 @@ class ChatClient {
         if (this.signalingClient === undefined) {
             throw new Error("Realtime notifications are only supported in the browser.");
         }
+        this.signalingClient.on("connectionChanged", (payload) => {
+            if (payload === 2 /* Connected */) {
+                this.emitter.emit("realTimeNotificationConnected");
+            }
+            else if (payload === 3 /* Disconnected */) {
+                this.emitter.emit("realTimeNotificationDisconnected");
+            }
+        });
         this.signalingClient.on("chatMessageReceived", (payload) => {
             this.emitter.emit("chatMessageReceived", payload);
         });