@amityco/ts-sdk-react-native 6.7.1-80c1951.0

package/src/client/api/accessTokenExpiryWatcher.ts

@@ -0,0 +1,85 @@
+import { fireEvent } from '~/core/events';
+import { scheduleTask } from '~/core/microtasks';
+import { MINUTE, ACCESS_TOKEN_WATCHER_INTERVAL } from '~/utils/constants';
+
+import { renewal } from './renewal';
+
+const ABOUT_TO_EXPIRE_THRESHOLD = 80 / 100;
+const COMPENSATED_DELAY = 5 * MINUTE;
+
+/*
+ * a helper function to check if the token has expires
+ *
+ * @param token to be checked
+ * @returns boolean indicating if token expires
+ *
+ * @category private
+ */
+export const isExpired = (expiresAt: Amity.Tokens['expiresAt']): boolean =>
+  Date.now() > Date.parse(expiresAt) - COMPENSATED_DELAY;
+
+/*
+ * a helper function to check if the token is about to expire
+ *
+ * @param token to be checked
+ * @returns boolean indicating if token is aboutToExpire
+ *
+ * @category private
+ */
+export const isAboutToExpire = (params: {
+  expiresAt: Amity.Tokens['expiresAt'];
+  issuedAt: Amity.Tokens['issuedAt'];
+}): boolean => {
+  const { expiresAt, issuedAt } = params;
+
+  const expires = Date.parse(expiresAt);
+  const issued = Date.parse(issuedAt);
+  const now = Date.now();
+
+  const duration = expires - issued - COMPENSATED_DELAY;
+  const aboutToExpireAt = issued + duration * ABOUT_TO_EXPIRE_THRESHOLD;
+
+  return now > aboutToExpireAt && now < expires;
+};
+
+/*
+ * Monitors time to expire of token and updates session state to aboutToExpire
+ *
+ * @returns intervalId to be cleared after trigger
+ *
+ * @category private
+ */
+export const accessTokenExpiryWatcher = (
+  expiresAt: Amity.Tokens['expiresAt'],
+  issuedAt: Amity.Tokens['issuedAt'],
+  sessionHandler: Amity.SessionHandler,
+): Amity.Unsubscriber => {
+  const interval: ReturnType<typeof setInterval> = setInterval(() => {
+    if (isExpired(expiresAt)) {
+      /*
+       * the event handler will take care of updating session state
+       * Note, this will also clear the interval id, so this event will only be
+       * fired once
+       */
+      fireEvent('tokenExpired', Amity.SessionStates.TOKEN_EXPIRED);
+
+      /*
+       * https://ekoapp.atlassian.net/wiki/spaces/UP/pages/2082537485/ASC+Core+-+Session+Management+3.0#Automatically-initiate-renewal-flow
+       *
+       * Why sechduled task?
+       * Since fireEvent is scheduled, it will be called
+       * after sessionHandler leading to an invalid state change from
+       * establishing to tokenExpired
+       */
+      scheduleTask(() => sessionHandler.sessionWillRenewAccessToken(renewal()));
+
+      return;
+    }
+
+    if (isAboutToExpire({ expiresAt, issuedAt })) {
+      sessionHandler.sessionWillRenewAccessToken(renewal());
+    }
+  }, ACCESS_TOKEN_WATCHER_INTERVAL);
+
+  return (): void => clearInterval(interval);
+};

package/src/client/api/activeClient.ts

@@ -0,0 +1,33 @@
+import { ASCError } from '~/core/errors';
+
+let activeClient: Amity.Client | null = null;
+
+/**
+ * Get the active client
+ *
+ * @returns the active client instance
+ *
+ * @hidden
+ */
+export const getActiveClient = () => {
+  if (!activeClient) {
+    throw new ASCError(
+      'There is no active client',
+      Amity.ClientError.UNKNOWN_ERROR,
+      Amity.ErrorLevel.FATAL,
+    );
+  }
+
+  return activeClient!;
+};
+
+/**
+ * Sets the active client
+ *
+ * @param client the client to assume as currently active client
+ *
+ * @hidden
+ */
+export const setActiveClient = (client: Amity.Client) => {
+  activeClient = client;
+};

package/src/client/api/activeUser.ts

@@ -0,0 +1,30 @@
+import { ASCError } from '~/core/errors';
+
+let activeUser: Amity.ActiveUser | null = null;
+
+/* begin_public_function
+  id: client.get_current_user
+*/
+/**
+ * for internal use
+ */
+export const getActiveUser = () => {
+  if (!activeUser) {
+    throw new ASCError(
+      'Connect client first',
+      Amity.ClientError.UNKNOWN_ERROR,
+      Amity.ErrorLevel.FATAL,
+    );
+  }
+
+  return activeUser!;
+};
+/* end_public_function */
+
+export const setActiveUser = (user: Amity.ActiveUser) => {
+  activeUser = {
+    _id: user._id,
+    userId: user.userId,
+    path: user.path,
+  };
+};

package/src/client/api/createClient.ts

@@ -0,0 +1,109 @@
+import { VERSION } from '~/version';
+
+import { createLogger } from '~/core/debug';
+
+import { API_REGIONS, computeUrl } from '~/client/utils/endpoints';
+import {
+  createHttpTransport,
+  createMqttTransport,
+  createWebsocketTransport,
+} from '~/core/transports';
+
+import { createEventEmitter } from '~/core/events';
+
+import { getActiveClient, setActiveClient } from './activeClient';
+import { getFeedSettings } from './getFeedSettings';
+
+import { accessTokenExpiryWatcher } from './accessTokenExpiryWatcher';
+
+const DEFAULT_DEBUG_SESSION = 'amity';
+
+/**
+ * ```js
+ * import { createClient } from '@amityco/ts-sdk-react-native'
+ * const client = createClient(apiKey, 'https://asc.server/', 'myClient')
+ * ```
+ *
+ * Creates a new {@link Amity.Client} instance
+ *
+ * @param apiKey for the {@link Amity.Client} instance
+ * @param apiRegion endpoint to connect to
+ * @param apiEndpoint custom endpoint in case you don't want to use a preset endpoint
+ * @param param.debugSession session's identifier for the client's logger instance
+ * @returns A {@link Amity.Client} instance
+ *
+ * @category Client API
+ * */
+export const createClient = (
+  apiKey: string,
+  apiRegion: typeof API_REGIONS[keyof typeof API_REGIONS] = API_REGIONS.SG,
+  {
+    debugSession = DEFAULT_DEBUG_SESSION,
+    apiEndpoint,
+  }: {
+    debugSession?: string;
+    apiEndpoint?: { http?: string; mqtt?: string };
+  } = {},
+): Amity.Client => {
+  const log = createLogger(debugSession);
+
+  log('client/api/createClient', {
+    apiKey: apiKey.replace(/.{5}$/g, 'xxxxx'),
+    apiRegion,
+  });
+
+  const httpEndpoint = apiEndpoint?.http ?? computeUrl('http', apiRegion);
+  const mqttEndpoint = apiEndpoint?.mqtt ?? computeUrl('mqtt', apiRegion);
+
+  const http = createHttpTransport(httpEndpoint);
+  const ws = createWebsocketTransport(httpEndpoint);
+  const mqtt = createMqttTransport(mqttEndpoint);
+
+  const emitter = createEventEmitter();
+
+  /*
+   * Since v6 cache is enabled by defafult
+   */
+  const cache = { data: {} };
+
+  const sessionState = Amity.SessionStates.NOT_LOGGED_IN;
+  const sessionHandler = undefined;
+
+  const client = {
+    version: `${VERSION}`,
+    apiKey,
+
+    /*
+     * SDK Components
+     */
+    log,
+    cache,
+
+    /*
+     * Network components
+     */
+    http,
+    ws,
+    mqtt,
+    emitter,
+
+    /*
+     * Session Components
+     */
+    sessionState,
+    accessTokenExpiryWatcher,
+    sessionHandler,
+
+    getFeedSettings,
+
+    use: () => setActiveClient(client),
+  };
+
+  try {
+    return getActiveClient();
+  } catch {
+    setActiveClient(client);
+  }
+
+  return client;
+};

package/src/client/api/getChatSettings.ts

@@ -0,0 +1,22 @@
+import { getActiveClient } from './activeClient';
+
+/**
+ * ```js
+ * import { getChatSettings } from '@amityco/ts-sdk-react-native'
+ * const chatSettings = await getChatSettings()
+ * ```
+ *
+ * Fetches a {@link Amity.ChatSettings} object
+ *
+ * @returns A Promise of {@link Amity.ChatSettings} object
+ *
+ * @category Client API
+ * @async
+ */
+export const getChatSettings = async (): Promise<Amity.ChatSettings> => {
+  const client = getActiveClient();
+
+  const { data } = await client.http.get<Amity.ChatSettings>(`/api/v3/network-settings/chat`);
+
+  return data;
+};

package/src/client/api/getFeedSettings.ts

@@ -0,0 +1,29 @@
+import { getActiveClient } from './activeClient';
+
+/**
+ * ```js
+ * import { getFeedSettings } from '@amityco/ts-sdk-react-native'
+ * const feedSettings = await getFeedSettings()
+ * const postFeedSetting = feedSettings.post
+ * ```
+ *
+ * Fetches a {@link Amity.FeedSettings} object
+ *
+ * @returns A Promise of {@link Amity.FeedSettings} object
+ *
+ * @category Client API
+ * @async
+ */
+export const getFeedSettings = async (): Promise<Amity.FeedSettings> => {
+  const client = getActiveClient();
+
+  const { data } = await client.http.get<Amity.FeedSettingPayload>(
+    `/api/v3/network-settings/feed-setting`,
+  );
+
+  return Object.fromEntries(
+    data.feedSettings.map(({ feedType, contentSettings }) => {
+      return [feedType, contentSettings];
+    }),
+  );
+};

package/src/client/api/getSocialSettings.ts

@@ -0,0 +1,24 @@
+import { getActiveClient } from './activeClient';
+
+/**
+ * ```js
+ * import { getSocialSettings } from '@amityco/ts-sdk-react-native'
+ * const socialSettings = await getSocialSettings()
+ * ```
+ *
+ * Fetches a {@link Amity.SocialSettings} object
+ *
+ * @returns A Promise of {@link Amity.SocialSettings} object
+ *
+ * @category Client API
+ * @async
+ */
+export const getSocialSettings = async (): Promise<Amity.SocialSettings> => {
+  const client = getActiveClient();
+
+  const { data } = await client.http.get<{ socialNetworkSetting: Amity.SocialSettings }>(
+    `/api/v3/network-settings/social`,
+  );
+
+  return data.socialNetworkSetting;
+};

package/src/client/api/getToken.ts

@@ -0,0 +1,41 @@
+import { getActiveClient } from './activeClient';
+
+import { getDeviceInfo } from '~/core/device';
+
+/**
+ * Retrieves a pair of {@link Amity.Tokens} necessary for connection
+ *
+ * @param params.userId The userId to use to issue a token
+ * @param params.displayName The user's displayName
+ * @param params.deviceId The user's device Id (can be manually set for native users)
+ * @param params.authToken The authentication token - necessary when network option is set to secure
+ * @return The accessToken for the given userId
+ *
+ * @category Client API
+ * @hidden
+ */
+export const getToken = async (params: {
+  userId: Amity.User['userId'];
+  displayName: Amity.User['displayName'];
+  authToken?: string;
+  deviceId: Amity.Device['deviceId'];
+}) => {
+  const client = getActiveClient();
+  client.log('client/api/getToken', params);
+
+  const deviceInfo = getDeviceInfo();
+
+  const { data } = await client.http.post<Amity.Tokens & { users: Amity.User[] }>(
+    '/api/v4/sessions',
+    {
+      ...params,
+      deviceInfo,
+    },
+    {
+      // @ts-ignore
+      headers: { 'X-API-Key': client.apiKey },
+    },
+  );
+
+  return data;
+};

package/src/client/api/index.ts

@@ -0,0 +1,15 @@
+export { getActiveClient } from './activeClient';
+export * from './activeUser';
+
+export * from './createClient';
+
+export * from './login';
+export * from './logout';
+
+export * from './isConnected';
+
+export * from './getFeedSettings';
+
+export * from './renewal';
+
+export * from './markerSync';

package/src/client/api/isConnected.ts

@@ -0,0 +1,24 @@
+import { getActiveClient } from './activeClient';
+
+/**
+ * ```js
+ * import { isConnected } from '@amityco/ts-sdk-react-native'
+ * const connected = isConnected()
+ * ```
+ *
+ * Checks if a {@link Amity.Client} instance is connected to ASC servers
+ *
+ * @returns a success boolean if connected
+ *
+ * @category Client API
+ */
+export const isConnected = (): boolean => {
+  const client = getActiveClient();
+  client.log('client/api/isConnected', client);
+
+  return !!(
+    client.userId &&
+    String(client.http.defaults.headers.common?.Authorization)?.length &&
+    client.ws.connected
+  );
+};

package/src/client/api/login.ts

@@ -0,0 +1,175 @@
+/* eslint-disable no-param-reassign */
+import { modifyMqttConnection } from '~/client/utils/modifyMqttConnection';
+/* eslint-disable require-atomic-updates */
+import { getDeviceId } from '~/core/device';
+import { proxyWebsocketEvents } from '~/core/events';
+import { onChannelDeleted } from '~/channelRepsitory/events/onChannelDeleted';
+import { onChannelMemberBanned } from '~/channelRepsitory/events/onChannelMemberBanned';
+
+import { markReadEngineOnLoginHandler } from '~/subChannelRepository/utils/markReadEngine';
+import { onUserDeleted } from '~/userRepository/events/onUserDeleted';
+
+import { logout } from './logout';
+
+import { getActiveClient } from './activeClient';
+import { terminateClient } from './terminateClient';
+import { setActiveUser } from './activeUser';
+
+import { setSessionState } from './setSessionState';
+
+import { onClientBanned } from '../events';
+import { onTokenExpired } from '../events/onTokenExpired';
+import { onTokenTerminated } from '../events/onTokenTerminated';
+
+import { setClientToken } from '../utils/setClientToken';
+import { removeChannelMarkerCache } from '../utils/removeChannelMarkerCache';
+
+/*
+ * declared earlier to accomodate case when logging in with a different user
+ * than the one already connected, in which case the existing subscriptions need
+ * to be cleared
+ */
+const subscriptions: Amity.Unsubscriber[] = [];
+
+/* begin_public_function
+  id: client.login
+*/
+/**
+ * ```js
+ * import { login } from '@amityco/ts-sdk-react-native/client/api'
+ * const success = await login({
+ *   userId: 'XYZ123456789',
+ * })
+ * ```
+ *
+ * Connects an {@link Amity.Client} instance to ASC servers
+ *
+ * @param params the connect parameters
+ * @param params.userId the user ID for the current session
+ * @param params.displayName the user's displayName for the current session
+ * @param params.deviceId Manual override of the user's device id (for device management)
+ * @param params.authToken The authentication token - necessary when network option is set to secure
+ * @returns a success boolean if connected
+ *
+ * @category Client API
+ * @async
+ */
+export const login = async (
+  params: Amity.ConnectClientParams,
+  sessionHandler: Amity.SessionHandler,
+  config?: Amity.ConnectClientConfig,
+): Promise<boolean> => {
+  const client = getActiveClient();
+  let unsubWatcher: Amity.Unsubscriber;
+
+  client.log('client/api/connectClient', {
+    apiKey: client.apiKey,
+    sessionState: client.sessionState,
+    ...params,
+  });
+
+  // if connecting to a different userId than the one that is connected currently
+  if (client.userId && client.userId !== params.userId) {
+    await logout();
+
+    // Remove subscription to ban and delete
+    subscriptions.forEach(fn => fn());
+  }
+
+  // default values
+  params.deviceId ??= getDeviceId();
+
+  try {
+    // @ts-ignore: in that particular case, typing can be
+    // ignored since we enforce default values just before.
+    const { users } = await setClientToken(params);
+
+    // FIXME: events are duplicated if connectClient is called few times without disconnectClient
+    // wire websocket events to our event emitter
+    proxyWebsocketEvents(client.ws, client.emitter);
+
+    // TODO: in phase 2, this should not be necessary. we should have WS
+    // to be connected "on demand" rather than "by default"
+    await new Promise(resolve => {
+      client.ws.once('connect', resolve);
+      client.ws.open();
+    });
+
+    client.userId = params.userId;
+
+    client.sessionHandler = sessionHandler;
+
+    /*
+     * Cannot push to subscriptions as watcher needs to continue working even if
+     * token expires
+     */
+    unsubWatcher = client.accessTokenExpiryWatcher(
+      client.token?.expiresAt!,
+      client.token?.issuedAt!,
+      sessionHandler!,
+    );
+
+    setActiveUser(users[0]);
+  } catch (error) {
+    /*
+     * if getting token failed session state reverts to initial state when app
+     * is first launched
+     */
+    setSessionState(Amity.SessionStates.NOT_LOGGED_IN);
+
+    // pass error down tree so the calling function handle it
+    throw error;
+  }
+
+  if (config?.disableRTE !== true) {
+    await modifyMqttConnection();
+  }
+
+  subscriptions.push(
+    // GLOBAL_BAN
+    onClientBanned((_: Amity.UserPayload) => {
+      terminateClient(Amity.TokenTerminationReason.GLOBAL_BAN);
+
+      subscriptions.forEach(fn => fn());
+
+      unsubWatcher();
+    }),
+
+    onTokenTerminated(_ => {
+      terminateClient();
+
+      subscriptions.forEach(fn => fn());
+
+      unsubWatcher();
+    }),
+
+    onUserDeleted((user: Amity.User) => {
+      if (user.userId === client.userId) {
+        terminateClient(Amity.TokenTerminationReason.USER_DELETED);
+
+        subscriptions.forEach(fn => fn());
+
+        unsubWatcher();
+      }
+    }),
+
+    onTokenExpired(state => {
+      setSessionState(state);
+
+      logout();
+
+      subscriptions.forEach(fn => fn());
+    }),
+
+    // NOTE: This is a temporary solution to handle the channel marker when the user is forced to leave
+    // the channel because currently backend can't handle this, so every time a user is banned from
+    // a channel or the channel is deleted the channel's unread count will not be reset to zero
+    onChannelDeleted(removeChannelMarkerCache),
+    onChannelMemberBanned(removeChannelMarkerCache),
+
+    markReadEngineOnLoginHandler(),
+  );
+
+  return client.ws.connected;
+};
+/* end_public_function */

package/src/client/api/logout.ts

@@ -0,0 +1,66 @@
+import { getActiveClient } from './activeClient';
+import { setSessionState } from './setSessionState';
+
+/* begin_public_function
+  id: client.logout
+*/
+/**
+ * ```js
+ * import { disconnectClient } from '@amityco/ts-sdk-react-native'
+ * const success = await disconnectClient()
+ * ```
+ *
+ * Disconnects an {@link Amity.Client} instance from ASC servers
+ *
+ * @returns a success boolean if disconnected
+ *
+ * @category Client API
+ * @async
+ */
+export const logout = async (): Promise<boolean> => {
+  const client = getActiveClient();
+
+  client.log('client/api/disconnectClient');
+
+  await new Promise(resolve => {
+    client.ws.once('disconnect', resolve);
+    client.ws.disconnect();
+    client.mqtt.disconnect();
+  });
+
+  /*
+   * for cases when session state is terminated (example on ban) or token expired,
+   * the terminating block will set session state to terminated or for the or
+   * in the case of expired token the same happens
+   *
+   * establishing state also ignored in cases where accessTokenExpiryWatcher
+   * calls renewal. There is a possibility that renewal will be called before
+   * disconnectClient finishes execution
+   *
+   * IMPORTANT: call this before `emitter.all.clear()`, otherwise the session
+   * event will never be triggered
+   */
+  if (client.sessionState === Amity.SessionStates.ESTABLISHED)
+    setSessionState(Amity.SessionStates.NOT_LOGGED_IN);
+
+  client.emitter.all.clear();
+  // FIXME: it removes listener in ws.ts, it breaks global ban event
+  client.ws.removeAllListeners();
+  client.mqtt.removeAllListeners();
+  client.userId = undefined;
+  client.token = undefined;
+
+  client.http.defaults.headers.common.Authorization = '';
+  client.ws.io.opts.query = { token: '' };
+
+  /*
+   * Cache should be usable if tokenExpired
+   * https://ekoapp.atlassian.net/wiki/spaces/UP/pages/2082537485/ASC+Core+-+Session+Management+3.0#SDK-usability-based-on-Session-State
+   */
+  if (client.sessionState !== Amity.SessionStates.TOKEN_EXPIRED && client.cache) {
+    client.cache = { data: {} };
+  }
+
+  return !client.ws.connected;
+};
+/* end_public_function */