@amityco/ts-sdk 0.0.1-cb052d5.0 → 0.0.1-cb5cdb1.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/activeUser.ts

@@ -1,6 +1,6 @@
 import { ASCError } from '~/core/errors';
 
-let activeUser: Pick<Amity.User, '_id' | 'userId' | 'path'> | null = null;
+let activeUser: Pick<Amity.User, '_id' | 'userId' | 'path' | 'displayName'> | null = null;
 
 /**
  * for internal use

package/src/client/api/connectClient.ts

@@ -3,13 +3,39 @@
 import { disconnectClient } from '~/client/api/disconnectClient';
 import { getDeviceId } from '~/core/device';
 import { proxyWebsocketEvents } from '~/core/events';
+import {
+  getUserTopic,
+  getNetworkTopic,
+  getSmartFeedChannelTopic,
+  getSmartFeedMessageTopic,
+  getSmartFeedSubChannelTopic,
+  subscribeTopic,
+} from '~/core/subscription';
+
+import { onUserDeleted } from '~/user/events/onUserDeleted';
 
 import { getActiveClient } from './activeClient';
-import { setActiveUser } from './activeUser';
+import { terminateClient } from './terminateClient';
+import { setActiveUser, getActiveUser } from './activeUser';
+
+import { setSessionState } from './setSessionState';
 
-import { getToken } from './getToken';
 import { onClientBanned } from '../events';
+import { onTokenExpired } from '../events/onTokenExpired';
+import { onTokenTerminated } from '../events/onTokenTerminated';
+
+import { setClientToken } from '../utils/setClientToken';
 
+/*
+ * 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 { connectClient } from '@amityco/ts-sdk/client/api'
@@ -30,48 +56,119 @@ import { onClientBanned } from '../events';
  * @category Client API
  * @async
  */
-export const connectClient = async (params: {
-  userId: Amity.User['userId'];
-  displayName?: Amity.User['displayName'];
-  authToken?: string;
-  deviceId?: Amity.Device['deviceId'];
-}): Promise<boolean> => {
+export const connectClient = async (
+  params: Amity.ConnectClientParams,
+  sessionHandler: Amity.SessionHandler,
+  config?: Amity.ConnectClientConfig,
+): Promise<boolean> => {
   const client = getActiveClient();
-  client.log('client/api/connectClient', { apiKey: client.apiKey, ...params });
+  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 disconnectClient();
+
+    // Remove subscription to ban and delete
+    subscriptions.forEach(fn => fn());
+  }
 
   // default values
   params.deviceId ??= getDeviceId();
 
-  // @ts-ignore: in that particular case, typing can be
-  // ignored since we enforce default values just before.
-  const { accessToken, users } = await getToken(params);
+  try {
+    // @ts-ignore: in that particular case, typing can be
+    // ignored since we enforce default values just before.
+    const { users } = await setClientToken(params);
 
-  // manually setup the token for http transport
-  client.http.defaults.headers.common.Authorization = `Bearer ${accessToken}`;
+    // FIXME: events are duplicated if connectClient is called few times without disconnectClient
+    // wire websocket events to our event emitter
+    proxyWebsocketEvents(client.ws, client.emitter);
 
-  // manually setup the token for ws transport
-  client.ws.io.opts.query = { token: accessToken };
+    // 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();
+    });
 
-  // FIXME: events are duplicated if connectClient is called few times without disconnectClient
-  // wire websocket events to our event emitter
-  proxyWebsocketEvents(client.ws, client.emitter);
+    client.userId = params.userId;
 
-  // 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.sessionHandler = sessionHandler;
 
-  const unsubscribe = onClientBanned(() => {
-    disconnectClient();
-    unsubscribe();
-  });
+    /*
+     * Cannot push to subscriptions as watcher needs to continue working even if
+     * token expires
+     */
+    unsubWatcher = client.accessTokenExpiryWatcher(
+      client.token?.issuedAt!,
+      client.token?.expiresAt!,
+      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) {
+    subscribeTopic(getNetworkTopic());
+    subscribeTopic(getSmartFeedChannelTopic());
+    subscribeTopic(getSmartFeedSubChannelTopic());
+    subscribeTopic(getSmartFeedMessageTopic());
+    // subscribing to user topic is necessary to handle ban event
+    subscribeTopic(getUserTopic(getActiveUser()));
+  }
+
+  subscriptions.push(
+    // GLOBAL_BAN
+    onClientBanned((_: Amity.UserPayload) => {
+      terminateClient();
+
+      subscriptions.forEach(fn => fn());
+
+      unsubWatcher();
+    }),
+
+    onTokenTerminated(_ => {
+      terminateClient();
+
+      subscriptions.forEach(fn => fn());
+
+      unsubWatcher();
+    }),
+
+    onUserDeleted((user: Amity.User) => {
+      if (user.userId === client.userId) {
+        terminateClient();
+
+        subscriptions.forEach(fn => fn());
+
+        unsubWatcher();
+      }
+    }),
+
+    onTokenExpired(state => {
+      setSessionState(state);
 
-  client.userId = params.userId;
-  client.accessToken = accessToken;
+      disconnectClient();
 
-  setActiveUser(users[0]);
+      subscriptions.forEach(fn => fn());
+    }),
+  );
 
   return client.ws.connected;
 };
+/* end_public_function */

package/src/client/api/createClient.ts

@@ -12,6 +12,11 @@ import {
 import { createEventEmitter } from '~/core/events';
 
 import { getActiveClient, setActiveClient } from './activeClient';
+import { getFeedSettings } from './getFeedSettings';
+
+import { accessTokenExpiryWatcher } from './accessTokenExpiryWatcher';
+
+const DEFAULT_DEBUG_SESSION = 'amity';
 
 /**
  * ```js
@@ -23,7 +28,8 @@ import { getActiveClient, setActiveClient } from './activeClient';
  *
  * @param apiKey for the {@link Amity.Client} instance
  * @param apiRegion endpoint to connect to
- * @param debugSession session's identifier for the client's logger instance
+ * @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
@@ -31,7 +37,13 @@ import { getActiveClient, setActiveClient } from './activeClient';
 export const createClient = (
   apiKey: string,
   apiRegion: typeof API_REGIONS[keyof typeof API_REGIONS] = API_REGIONS.SG,
-  debugSession = 'amity',
+  {
+    debugSession = DEFAULT_DEBUG_SESSION,
+    apiEndpoint,
+  }: {
+    debugSession?: string;
+    apiEndpoint?: { http?: string; mqtt?: string };
+  } = {},
 ): Amity.Client => {
   const log = createLogger(debugSession);
 
@@ -40,12 +52,18 @@ export const createClient = (
     apiRegion,
   });
 
-  const http = createHttpTransport(computeUrl('http', apiRegion));
-  const ws = createWebsocketTransport(computeUrl('http', apiRegion));
-  const mqtt = createMqttTransport(computeUrl('mqtt', 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();
 
+  const sessionState = Amity.SessionStates.NOT_LOGGED_IN;
+  const sessionHandler = undefined;
+
   const client = {
     version: `${VERSION}`,
 
@@ -55,11 +73,16 @@ export const createClient = (
     ws,
     mqtt,
     emitter,
+    accessTokenExpiryWatcher,
     use: () => setActiveClient(client),
+
+    sessionState,
+    sessionHandler,
+    getFeedSettings,
   };
 
   try {
-    getActiveClient();
+    return getActiveClient();
   } catch {
     setActiveClient(client);
   }

package/src/client/api/disconnectClient.ts

@@ -1,5 +1,9 @@
 import { getActiveClient } from './activeClient';
+import { setSessionState } from './setSessionState';
 
+/* begin_public_function
+  id: client.logout
+*/
 /**
  * ```js
  * import { disconnectClient } from '@amityco/ts-sdk'
@@ -8,7 +12,6 @@ import { getActiveClient } from './activeClient';
  *
  * Disconnects an {@link Amity.Client} instance from ASC servers
  *
- * @param client The {@link Amity.Client} instance to disconnect
  * @returns a success boolean if disconnected
  *
  * @category Client API
@@ -16,6 +19,7 @@ import { getActiveClient } from './activeClient';
  */
 export const disconnectClient = async (): Promise<boolean> => {
   const client = getActiveClient();
+
   client.log('client/api/disconnectClient');
 
   await new Promise(resolve => {
@@ -29,7 +33,31 @@ export const disconnectClient = async (): Promise<boolean> => {
   client.ws.removeAllListeners();
   client.mqtt.removeAllListeners();
   client.userId = undefined;
-  client.accessToken = undefined;
+  client.token = undefined;
+
+  client.http.defaults.headers.common.Authorization = '';
+  client.ws.io.opts.query = { token: '' };
+
+  /*
+   * 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
+   */
+  if (client.sessionState === Amity.SessionStates.ESTABLISHED)
+    setSessionState(Amity.SessionStates.NOT_LOGGED_IN);
+
+  /*
+   * 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 */

package/src/client/api/getChatSettings.ts

@@ -0,0 +1,22 @@
+import { getActiveClient } from './activeClient';
+
+/**
+ * ```js
+ * import { getChatSettings } from '@amityco/ts-sdk'
+ * 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'
+ * 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'
+ * 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

@@ -5,10 +5,10 @@ import { getDeviceInfo } from '~/core/device';
 /**
  * Retrieves a pair of {@link Amity.Tokens} necessary for connection
  *
- * @param userId The userId to use to issue a token
- * @param displayName The user's displayName
- * @param deviceId The user's device Id (can be manually set for native users)
- * @param authToken The authentication token - necessary when network option is set to secure
+ * @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
@@ -23,10 +23,10 @@ export const getToken = async (params: {
   const client = getActiveClient();
   client.log('client/api/getToken', params);
 
-  const deviceInfo = await getDeviceInfo();
+  const deviceInfo = getDeviceInfo();
 
   const { data } = await client.http.post<Amity.Tokens & { users: Amity.User[] }>(
-    '/v1/device',
+    '/api/v4/sessions',
     {
       ...params,
       deviceInfo,

package/src/client/api/index.ts

@@ -6,3 +6,7 @@ export * from './connectClient';
 export * from './disconnectClient';
 
 export * from './isConnected';
+
+export * from './getFeedSettings';
+
+export * from './renewal';

package/src/client/api/isConnected.ts

@@ -18,7 +18,7 @@ export const isConnected = (): boolean => {
 
   return !!(
     client.userId &&
-    client.http.defaults.headers.common?.Authorization?.length &&
+    String(client.http.defaults.headers.common?.Authorization)?.length &&
     client.ws.connected
   );
 };

package/src/client/api/renewal.ts

@@ -0,0 +1,78 @@
+import { getDeviceId } from '~/core/device';
+import { ACCESS_TOKEN_WATCHER_INTERVAL } from '~/utils/constants';
+
+import { getActiveUser } from './activeUser';
+import { setClientToken as refreshToken } from '../utils/setClientToken';
+import { getActiveClient } from './activeClient';
+import { connectClient } from './connectClient';
+
+/* begin_public_function
+  id: client.renew_access_token
+*/
+/*
+ * Renewal defintion accepted by SessionHandler interface
+ *
+ * Tech Spec:
+ * https://ekoapp.atlassian.net/wiki/spaces/UP/pages/2082537485/ASC+Core+-+Session+Management+3.0#Session-Handler
+ *
+ * @category private
+ */
+export const renewal = (): Amity.AccessTokenRenewal => {
+  let tokenRenewed = false;
+  let renewTimeoutId: ReturnType<typeof setTimeout>;
+
+  const client = getActiveClient();
+
+  client.log('initiating access token renewal');
+  /*
+   * Renews a token if it is hasn't been renewed before. Also marks token as
+   * renewed once done
+   * Per instance of Renewal, only one renewal is allowed
+   */
+  const renewToken = async (authToken?: Amity.ConnectClientParams['authToken']): Promise<void> => {
+    const { userId, displayName } = getActiveUser();
+    const deviceId = getDeviceId();
+
+    const params = { userId, displayName, authToken, deviceId };
+
+    if (client.sessionState === Amity.SessionStates.TOKEN_EXPIRED) {
+      // sessionHandler will never be empty when renewal is instantiatied
+      await connectClient(params, client.sessionHandler!);
+    } else {
+      // about to expire
+
+      // @ts-ignore: in that particular case, typing can be
+      // ignored since we enforce default values just before.
+      await refreshToken(params);
+    }
+
+    tokenRenewed = true;
+
+    if (renewTimeoutId) clearTimeout(renewTimeoutId);
+  };
+
+  return {
+    renew: () => {
+      if (tokenRenewed) {
+        console.log("'renew' method can be called only once per renewal instance");
+        return;
+      }
+      renewToken();
+    },
+
+    renewWithAuthToken: (authToken: string) => {
+      if (tokenRenewed) {
+        console.log("'renewWithAuthToken' method can be called only once per renewal instance");
+        return;
+      }
+      renewToken(authToken);
+    },
+
+    unableToRetrieveAuthToken: () => {
+      renewTimeoutId = setTimeout(() => {
+        client.sessionHandler?.sessionWillRenewAccessToken(renewal());
+      }, ACCESS_TOKEN_WATCHER_INTERVAL);
+    },
+  };
+};
+/* end_public_function */