@amityco/ts-sdk-react-native 6.35.3-e008e09.0 → 6.36.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@amityco/ts-sdk-react-native",
-  "version": "6.35.3-e008e09.0",
+  "version": "6.36.0",
   "license": "CC-BY-ND-4.0",
   "author": "amity.co <developers@amity.co> (https://amity.co)",
   "description": "Amity Social Cloud Typescript SDK",

package/src/@types/core/transport.ts

@@ -34,6 +34,8 @@ declare global {
     type MqttClient = {
       connect: (params: { accessToken: string; userId: string }) => Promise<void>;
       disconnect: () => Promise<void>;
+      reconnect: () => void;
+      listen(callback: (state: Amity.RTEConnectionState) => void): () => void;
       get connected(): boolean;
       on: <T extends keyof Amity.MqttEvents>(
         event: T,

package/src/@types/domains/client.ts

@@ -31,6 +31,16 @@ declare global {
       TERMINATED = 'terminated',
     }
 
+    const enum RTEConnectionStateEnum {
+      CONNECTING = 'connecting', // actively establishing a connection (initial or reconnection)
+      CONNECTED = 'connected', // connected to broker
+      RECONNECTING = 'reconnecting', // lost connection and attempting to reconnect
+      DISCONNECTED = 'disconnected', // disconnected (not currently connected, and not automatically reconnecting)
+      DISCONNECTING = 'disconnecting', // disconnected (not currently connected, and not automatically reconnecting)
+    }
+
+    type RTEConnectionState = `${Amity.RTEConnectionStateEnum}`;
+
     type Client = {
       version: string;
 
@@ -60,6 +70,10 @@ declare global {
 
       accessTokenExpiryWatcher: (sessionHandler: Amity.SessionHandler) => Amity.Unsubscriber;
 
+      onRTEConnectionStateChange: (
+        callback: (state: Amity.RTEConnectionState) => void,
+      ) => (() => void) | undefined;
+
       getFeedSettings: () => Promise<Amity.FeedSettings>;
       getSocialSettings: () => Promise<Amity.SocialSettings>;
       getMessagePreviewSetting: (refresh?: boolean) => Promise<Amity.MessagePreviewSetting>;

package/src/client/api/createClient.ts

@@ -21,6 +21,7 @@ import { getFeedSettings } from './getFeedSettings';
 
 import { accessTokenExpiryWatcher } from './accessTokenExpiryWatcher';
 import { getMarkerSyncConsistentMode } from '../utils/markerSyncEngine';
+import { onRTEConnectionStateChange } from './onRTEConnectionStateChange';
 
 const DEFAULT_DEBUG_SESSION = 'amity';
 
@@ -121,6 +122,8 @@ export const createClient = (
     getSocialSettings,
     getMessagePreviewSetting,
 
+    onRTEConnectionStateChange,
+
     use: () => setActiveClient(client),
 
     isUnreadCountEnabled,

package/src/client/api/index.ts

@@ -21,3 +21,5 @@ export * from './setUploadedFileAccessType';
 
 export * from './registerPushNotification';
 export * from './unregisterPushNotification';
+
+export * from './onRTEConnectionStateChange';

package/src/client/api/onRTEConnectionStateChange.ts

@@ -0,0 +1,24 @@
+import { getActiveClient } from './activeClient';
+
+/**
+ * ```js
+ * import { Client } from '@amityco/ts-sdk'
+ * const unsubscribe = Client.onRTEConnectionStateChange((state) => console.log(state))
+ * unsubscribe()
+ * ```
+ * @param callback The function to call when the event was fired
+ * @returns an {@link Amity.Unsubscriber} function to stop listening
+ *
+ * @category Client API
+ */
+export const onRTEConnectionStateChange = (
+  callback: (state: Amity.RTEConnectionState) => void,
+): (() => void) | undefined => {
+  const client = getActiveClient();
+
+  if (client.mqtt) {
+    return client.mqtt?.listen(callback);
+  }
+
+  return undefined;
+};

package/src/core/transports/mqtt.ts

@@ -50,11 +50,25 @@ export function getMqttOptions(params: {
  */
 export const createMqttTransport = (endpoint: string): Amity.MqttClient => {
   let mqttClient: MqttClient;
+  let currentState: Amity.RTEConnectionState = 'disconnected';
+  const connectionStateListeners: Set<(state: Amity.RTEConnectionState) => void> = new Set();
+
+  const updateConnectionState = (state: Amity.RTEConnectionState) => {
+    if (currentState === state) return;
+
+    currentState = state;
+
+    connectionStateListeners.forEach(listener => {
+      listener(state);
+    });
+  };
 
   async function connect(params: { accessToken: string; userId: string }): Promise<void> {
     const clientId = await getMQTTClientId(params.userId);
+    updateConnectionState('connecting');
 
     if (mqttClient) {
+      updateConnectionState('disconnecting');
       mqttClient.removeAllListeners();
       mqttClient.end(true);
     }
@@ -70,7 +84,7 @@ export const createMqttTransport = (endpoint: string): Amity.MqttClient => {
 
     mqttClient.on('connect', () => {
       mqttClient.options.reconnectPeriod = RETRY_BASE_TIMEOUT;
-
+      updateConnectionState('connected');
       subscribeGlobalTopic();
     });
 
@@ -81,10 +95,12 @@ export const createMqttTransport = (endpoint: string): Amity.MqttClient => {
         case MqttError.BAD_USERNAME_OR_PASSWORD:
         case MqttError.NOT_AUTHORIZED:
           mqttClient.end();
+          updateConnectionState('disconnected');
       }
     });
 
     mqttClient.on('reconnect', () => {
+      updateConnectionState('reconnecting');
       // Double the reconnect period for each attempt
       mqttClient.options.reconnectPeriod = Math.min(
         (mqttClient.options.reconnectPeriod || RETRY_BASE_TIMEOUT) * 2,
@@ -92,6 +108,14 @@ export const createMqttTransport = (endpoint: string): Amity.MqttClient => {
       );
     });
 
+    mqttClient.on('close', () => {
+      updateConnectionState('disconnected');
+    });
+
+    mqttClient.on('disconnect', () => {
+      updateConnectionState('disconnected');
+    });
+
     return new Promise(resolve => mqttClient!.once('connect', () => resolve()));
   }
 
@@ -102,6 +126,21 @@ export const createMqttTransport = (endpoint: string): Amity.MqttClient => {
         return new Promise(resolve => mqttClient?.end(true, undefined, () => resolve()));
       }
     },
+    async reconnect(): Promise<void> {
+      return new Promise(resolve => {
+        mqttClient?.reconnect();
+        resolve();
+      });
+    },
+    listen(callback: (state: Amity.RTEConnectionState) => void): () => void {
+      connectionStateListeners.add(callback);
+
+      if (currentState) callback(currentState);
+
+      return () => {
+        connectionStateListeners.delete(callback);
+      };
+    },
     get connected() {
       return !!mqttClient?.connected;
     },