@amityco/ts-sdk 7.9.2 → 7.9.3-26ea573.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@amityco/ts-sdk",
-  "version": "7.9.2",
+  "version": "7.9.3-26ea573.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/errors.ts

@@ -23,6 +23,8 @@ declare global {
       BAN_WORD_FOUND = 400308,
       LINK_NOT_ALLOWED = 400309,
       BUSINESS_ERROR = 500000,
+      VISITOR_PERMISSION_DENIED = 403999,
+      BOT_PERMISSION_DENIED = 403998,
     }
 
     const enum ClientError {

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

@@ -94,10 +94,20 @@ declare global {
       expiresAt: string;
     };
 
+    type SessionResponse = Tokens & {
+      users: Amity.RawUser[];
+      userType: Amity.UserType;
+    };
+
     type AccessTokenRenewal = {
       renew: () => void;
       renewWithAuthToken: (authToken: string) => void;
       unableToRetrieveAuthToken: () => void;
+      renewWithAuthSignature: ({
+        authSignature,
+        authSignatureExpiresAt,
+      }: Amity.ConnectClientAsVisitorParams) => void;
+      unableToRetrieveAuthSignature: () => void;
     };
 
     interface SessionHandler {
@@ -150,6 +160,11 @@ declare global {
       deviceId?: Amity.Device['deviceId'];
     };
 
+    type ConnectClientAsVisitorParams = {
+      authSignature?: string;
+      authSignatureExpiresAt?: string;
+    };
+
     type ConnectClientConfig = {
       disableRTE: boolean;
     };

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

@@ -1,5 +1,11 @@
 import { AmityUserSearchMatchType } from '~/userRepository';
 
+export const enum UserTypeEnum {
+  SIGNED_IN = 'signed-in',
+  VISITOR = 'visitor',
+  BOT = 'bot',
+}
+
 export {};
 
 declare global {
@@ -29,6 +35,8 @@ declare global {
       | 'onUnflagged'
       | 'onFlagCleared';
 
+    type UserType = `${UserTypeEnum}`;
+
     type RawUser = {
       _id: string;
       userId: string;

package/src/@types/index.ts

@@ -46,3 +46,4 @@ export * from './domains/pinnedPost';
 export * from './domains/liveReaction';
 export * from './domains/feed';
 export * from './domains/hashtag';
+export * from './domains/user';

package/src/client/api/activeUser.ts

@@ -7,6 +7,7 @@ let activeUser: Amity.ActiveUser | null = null;
 */
 /**
  * for internal use
+ * @deprecated please use getCurrentUser api instead.
  */
 export const getActiveUser = () => {
   if (!activeUser) {

package/src/client/api/getBotToken.ts

@@ -0,0 +1,44 @@
+import { getActiveClient } from './activeClient';
+
+import { getDeviceInfo } from '~/core/device';
+
+/**
+ * Retrieves a pair of {@link Amity.Tokens} necessary for connection
+ *
+ * @param param get bot token param
+ * @param params.deviceId The user's device Id (can be manually set for native users)
+ * @param options get bot token options
+ * @param options.setAccessTokenCookie The authentication token - necessary when network option is set to secure
+ * @return The accessToken for the given userId
+ *
+ * @category Client API
+ * @hidden
+ */
+export const getBotToken = async ({
+  params,
+  options,
+}: {
+  params: { deviceId: string };
+  options?: { setAccessTokenCookie?: boolean };
+}) => {
+  const client = getActiveClient();
+  client.log('client/api/getBotToken');
+
+  const deviceInfo = getDeviceInfo();
+
+  const { data } = await client.http.post<Amity.SessionResponse>(
+    '/api/v5/sessions/bot',
+    {
+      ...params,
+      deviceInfo,
+    },
+    {
+      headers: {
+        'X-API-Key': client.apiKey,
+        'set-access-token-cookie': options?.setAccessTokenCookie || false,
+      },
+    },
+  );
+
+  return data;
+};

package/src/client/api/getCurrentUser.ts

@@ -0,0 +1,32 @@
+import { ASCError } from '~/core/errors';
+import { getActiveClient } from './activeClient';
+import { pullFromCache } from '~/cache/api';
+import { userLinkedObject } from '~/utils/linkedObject/userLinkedObject';
+
+/* begin_public_function
+  id: client.get_current_user
+*/
+export const getCurrentUser = (): Amity.User => {
+  const client = getActiveClient();
+
+  if (!client) {
+    throw new ASCError(
+      'Connect client first',
+      Amity.ClientError.UNKNOWN_ERROR,
+      Amity.ErrorLevel.FATAL,
+    );
+  }
+
+  const cache = pullFromCache<Amity.User>(['user', 'get', client.userId])?.data!;
+
+  if (!cache) {
+    throw new ASCError(
+      'Connect client first',
+      Amity.ClientError.UNKNOWN_ERROR,
+      Amity.ErrorLevel.FATAL,
+    );
+  }
+
+  return userLinkedObject(cache);
+};
+/* end_public_function */

package/src/client/api/getCurrentUserType.ts

@@ -0,0 +1,23 @@
+import { ASCError } from '~/core/errors';
+
+let currentUserType: Amity.UserType | null = null;
+
+/* begin_public_function
+  id: client.get_current_user_type
+*/
+export const getCurrentUserType = () => {
+  if (!currentUserType) {
+    throw new ASCError(
+      'Connect client first',
+      Amity.ClientError.UNKNOWN_ERROR,
+      Amity.ErrorLevel.FATAL,
+    );
+  }
+
+  return currentUserType!;
+};
+/* end_public_function */
+
+export const setCurrentUserType = (userType: Amity.UserType) => {
+  currentUserType = userType;
+};

package/src/client/api/getToken.ts

@@ -31,7 +31,7 @@ export const getToken = async ({
 
   const deviceInfo = getDeviceInfo();
 
-  const { data } = await client.http.post<Amity.Tokens & { users: Amity.InternalUser[] }>(
+  const { data } = await client.http.post<Amity.SessionResponse>(
     '/api/v5/sessions',
     {
       ...params,

package/src/client/api/getVisitorToken.ts

@@ -0,0 +1,47 @@
+import { getActiveClient } from './activeClient';
+
+import { getDeviceInfo } from '~/core/device';
+
+/**
+ * Retrieves a pair of {@link Amity.Tokens} necessary for connection
+ *
+ * @param params get visitor token param
+ * @param params.deviceId The user's device Id (can be manually set for native users)
+ * @param params.authSignature The authenitcation signature - necessary when network option is set to secure
+ * @param params.authSignatureExpiresAt Expire time of the authenitcation signature
+ * @param options get bot token options
+ * @param options.setAccessTokenCookie The authentication token - necessary when network option is set to secure
+ * @return The accessToken for the given userId
+ *
+ *
+ * @category Client API
+ * @hidden
+ */
+export const getVisitorToken = async ({
+  params,
+  options,
+}: {
+  params: Amity.ConnectClientAsVisitorParams & { deviceId: string };
+  options?: { setAccessTokenCookie?: boolean };
+}) => {
+  const client = getActiveClient();
+  client.log('client/api/getVisitorToken', params);
+
+  const deviceInfo = getDeviceInfo();
+
+  const { data } = await client.http.post<Amity.SessionResponse>(
+    '/api/v5/sessions/visitor',
+    {
+      ...params,
+      deviceInfo,
+    },
+    {
+      headers: {
+        'X-API-Key': client.apiKey,
+        'set-access-token-cookie': options?.setAccessTokenCookie || false,
+      },
+    },
+  );
+
+  return data;
+};

package/src/client/api/index.ts

@@ -25,3 +25,9 @@ export * from './fetchLinkPreview';
 export * from './getSocialSettings';
 
 export * from './getShareableLinkConfiguration';
+
+export * from './loginAsVisitor';
+export * from './loginAsBot';
+
+export * from './getCurrentUser';
+export * from './getCurrentUserType';

package/src/client/api/login.ts

@@ -2,7 +2,6 @@
 import { modifyMqttConnection } from '~/client/utils/modifyMqttConnection';
 /* eslint-disable require-atomic-updates */
 import { getDeviceId } from '~/core/device';
-import { proxyWebsocketEvents } from '~/core/events';
 import { onChannelDeleted } from '~/channelRepository/events/onChannelDeleted';
 import { onChannelMemberBanned } from '~/channelRepository/events/onChannelMemberBanned';
 
@@ -29,6 +28,8 @@ import { removeChannelMarkerCache } from '../utils/removeChannelMarkerCache';
 import { initializeMessagePreviewSetting } from '../utils/messagePreviewEngine';
 import { ASCError } from '~/core/errors';
 import SessionWatcher from '../utils/SessionWatcher';
+import { setCurrentUserType } from './getCurrentUserType';
+import { setCurrentUser } from '../utils/setCurrentUser';
 
 /*
  * declared earlier to accomodate case when logging in with a different user
@@ -91,7 +92,7 @@ export const login = async (
   const defaultDeviceId = await getDeviceId();
 
   try {
-    const { users } = await setClientToken({
+    const { users, userType } = await setClientToken({
       params: {
         ...params,
         displayName: params?.displayName,
@@ -117,7 +118,7 @@ export const login = async (
       return false;
     }
 
-    if (user.isGlobalBanned) {
+    if (user.isGlobalBan) {
       terminateClient(Amity.TokenTerminationReason.GLOBAL_BAN);
       return false;
     }
@@ -132,7 +133,7 @@ export const login = async (
      */
     unsubWatcher = client.accessTokenExpiryWatcher(sessionHandler);
 
-    setActiveUser(user);
+    setCurrentUser({ user, userType });
   } catch (error) {
     /*
      * if getting token failed session state reverts to initial state when app

package/src/client/api/loginAsBot.ts

@@ -0,0 +1,126 @@
+/* eslint-disable no-param-reassign */
+import { modifyMqttConnection } from '~/client/utils/modifyMqttConnection';
+/* eslint-disable require-atomic-updates */
+import { getDeviceId } from '~/core/device';
+import { logout } from './logout';
+
+import { getActiveClient } from './activeClient';
+import { terminateClient } from './terminateClient';
+import { setActiveUser } from './activeUser';
+
+import { onTokenExpired } from '../events/onTokenExpired';
+import { onTokenTerminated } from '../events/onTokenTerminated';
+import { initializeMessagePreviewSetting } from '../utils/messagePreviewEngine';
+
+import SessionWatcher from '../utils/SessionWatcher';
+import { setBotClientToken } from '../utils/setBotClientToken';
+import { setCurrentUserType } from './getCurrentUserType';
+import { setCurrentUser } from '../utils/setCurrentUser';
+
+/*
+ * 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.loginAsBot
+*/
+/**
+ * ```js
+ * import { loginAsBot } from '@amityco/ts-sdk/client/api'
+ * const success = await loginAsBot({
+    sessionHandler: {
+      sessionWillRenewAccessToken(renewal: Amity.AccessTokenRenewal) {
+       ...
+    }
+ * })
+ * ```
+ *
+ * Connects an {@link Amity.Client} instance to ASC servers
+ *
+ * @param params. the connect parameters
+ * @param params.sessionHandler
+ * @returns a success boolean if connected
+ *
+ * @category Client API
+ * @async
+ */
+
+export const loginAsBot = async (params: {
+  sessionHandler: Amity.SessionHandler;
+}): Promise<boolean> => {
+  const client = getActiveClient();
+  let unsubWatcher: Amity.Unsubscriber;
+
+  client.log('client/api/connectClient', {
+    apiKey: client.apiKey,
+    sessionState: client.sessionState,
+  });
+
+  // generate deviceId
+  const deviceId = await getDeviceId();
+  let user: Amity.RawUser;
+
+  try {
+    const { users, userType } = await setBotClientToken({
+      params: {
+        deviceId,
+      },
+      options: {
+        setAccessTokenCookie: true,
+      },
+    });
+
+    [user] = users;
+
+    client.userId = user.userId;
+
+    client.sessionHandler = params.sessionHandler;
+
+    /*
+     * Cannot push to subscriptions as watcher needs to continue working even if
+     * token expires
+     */
+    unsubWatcher = client.accessTokenExpiryWatcher(params.sessionHandler);
+
+    setCurrentUser({ user, userType });
+  } catch (error) {
+    /*
+     * if getting token failed session state reverts to initial state when app
+     * is first launched
+     */
+    SessionWatcher.getInstance().setSessionState(Amity.SessionStates.NOT_LOGGED_IN);
+
+    // pass error down tree so the calling function handle it
+    throw error;
+  }
+
+  await initializeMessagePreviewSetting();
+
+  if (subscriptions.length === 0) {
+    // handling internal SDK events
+    subscriptions.push(
+      onTokenTerminated(_ => {
+        terminateClient();
+
+        subscriptions.forEach(fn => fn());
+
+        unsubWatcher();
+      }),
+
+      onTokenExpired(state => {
+        SessionWatcher.getInstance().setSessionState(state);
+
+        logout();
+
+        subscriptions.forEach(fn => fn());
+      }),
+    );
+  }
+
+  return true;
+};
+
+/* end_public_function */

package/src/client/api/loginAsVisitor.ts

@@ -0,0 +1,131 @@
+/* eslint-disable no-param-reassign */
+import { modifyMqttConnection } from '~/client/utils/modifyMqttConnection';
+/* eslint-disable require-atomic-updates */
+import { getDeviceId } from '~/core/device';
+import { logout } from './logout';
+
+import { getActiveClient } from './activeClient';
+import { terminateClient } from './terminateClient';
+import { setActiveUser } from './activeUser';
+
+import { onTokenExpired } from '../events/onTokenExpired';
+import { onTokenTerminated } from '../events/onTokenTerminated';
+import { initializeMessagePreviewSetting } from '../utils/messagePreviewEngine';
+
+import SessionWatcher from '../utils/SessionWatcher';
+import { setVisitorClientToken } from '../utils/setVisitorClientToken';
+import { setCurrentUserType } from './getCurrentUserType';
+import { setCurrentUser } from '../utils/setCurrentUser';
+
+/*
+ * 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.loginAsVisitor
+*/
+/**
+ * ```js
+ * import { loginAsVisitor } from '@amityco/ts-sdk/client/api'
+ * const success = await loginAsVisitor({
+    sessionHandler: {
+      sessionWillRenewAccessToken(renewal: Amity.AccessTokenRenewal) {
+       ...
+    }
+ * })
+ * ```
+ *
+ * Connects an {@link Amity.Client} instance to ASC servers
+ *
+ * @param params. the connect parameters
+ * @param params.authSignature The authenitcation signature - necessary when network option is set to secure
+ * @param params.authSignatureExpiresAt Expire time of the authenitcation signature
+ * @param params.sessionHandler
+ * @returns a success boolean if connected
+ *
+ * @category Client API
+ * @async
+ */
+
+export const loginAsVisitor = async (
+  params: Amity.ConnectClientAsVisitorParams & {
+    sessionHandler: Amity.SessionHandler;
+  },
+): Promise<boolean> => {
+  const client = getActiveClient();
+  let unsubWatcher: Amity.Unsubscriber;
+  client.log('client/api/connectClient', {
+    apiKey: client.apiKey,
+    sessionState: client.sessionState,
+    ...params,
+  });
+
+  // generate deviceId
+  const deviceId = await getDeviceId();
+  let user: Amity.RawUser;
+
+  try {
+    const { users, userType } = await setVisitorClientToken({
+      params: {
+        ...params,
+        deviceId,
+      },
+      options: {
+        setAccessTokenCookie: true,
+      },
+    });
+
+    [user] = users;
+
+    client.userId = user.userId;
+
+    client.sessionHandler = params.sessionHandler;
+
+    /*
+     * Cannot push to subscriptions as watcher needs to continue working even if
+     * token expires
+     */
+    unsubWatcher = client.accessTokenExpiryWatcher(params.sessionHandler);
+
+    setCurrentUser({ user, userType });
+  } catch (error) {
+    /*
+     * if getting token failed session state reverts to initial state when app
+     * is first launched
+     */
+    SessionWatcher.getInstance().setSessionState(Amity.SessionStates.NOT_LOGGED_IN);
+
+    // pass error down tree so the calling function handle it
+    throw error;
+  }
+
+  await initializeMessagePreviewSetting();
+
+  if (subscriptions.length === 0) {
+    // handling internal SDK events
+    subscriptions.push(
+      onTokenTerminated(_ => {
+        terminateClient();
+
+        subscriptions.forEach(fn => fn());
+
+        unsubWatcher();
+      }),
+
+      onTokenExpired(state => {
+        SessionWatcher.getInstance().setSessionState(state);
+
+        logout();
+
+        subscriptions.forEach(fn => fn());
+      }),
+    );
+  }
+
+  return true;
+};
+
+/* end_public_function */

package/src/client/api/renewal.ts

@@ -1,10 +1,12 @@
 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 { setVisitorClientToken as refreshVisitorToken } from '../utils/setVisitorClientToken';
 import { getActiveClient } from './activeClient';
 import { login } from './login';
+import { loginAsVisitor } from './loginAsVisitor';
+import { getCurrentUser } from './getCurrentUser';
 
 /* begin_public_function
   id: client.renew_access_token
@@ -30,7 +32,7 @@ export const renewal = (): Amity.AccessTokenRenewal => {
    * Per instance of Renewal, only one renewal is allowed
    */
   const renewToken = async (authToken?: Amity.ConnectClientParams['authToken']): Promise<void> => {
-    const { userId, displayName } = getActiveUser();
+    const { userId, displayName } = getCurrentUser();
     const deviceId = await getDeviceId();
 
     const params = { userId, displayName, authToken, deviceId };
@@ -53,6 +55,30 @@ export const renewal = (): Amity.AccessTokenRenewal => {
     if (renewTimeoutId) clearTimeout(renewTimeoutId);
   };
 
+  const renewVisitorToken = async ({
+    authSignature,
+    authSignatureExpiresAt,
+  }: Amity.ConnectClientAsVisitorParams): Promise<void> => {
+    const deviceId = await getDeviceId();
+
+    if (client.sessionState === Amity.SessionStates.TOKEN_EXPIRED && client.sessionHandler) {
+      await loginAsVisitor({ sessionHandler: client.sessionHandler });
+    } else {
+      // about to expire
+
+      await refreshVisitorToken({
+        params: { authSignature, authSignatureExpiresAt, deviceId },
+        options: {
+          setAccessTokenCookie: true,
+        },
+      });
+    }
+
+    tokenRenewed = true;
+
+    if (renewTimeoutId) clearTimeout(renewTimeoutId);
+  };
+
   return {
     renew: () => {
       if (tokenRenewed) {
@@ -75,6 +101,20 @@ export const renewal = (): Amity.AccessTokenRenewal => {
         client.sessionHandler?.sessionWillRenewAccessToken(renewal());
       }, ACCESS_TOKEN_WATCHER_INTERVAL);
     },
+
+    renewWithAuthSignature: (params: Amity.ConnectClientAsVisitorParams) => {
+      if (tokenRenewed) {
+        console.log("'renew' method can be called only once per renewal instance");
+        return;
+      }
+      renewVisitorToken(params);
+    },
+
+    unableToRetrieveAuthSignature: () => {
+      renewTimeoutId = setTimeout(() => {
+        client.sessionHandler?.sessionWillRenewAccessToken(renewal());
+      }, ACCESS_TOKEN_WATCHER_INTERVAL);
+    },
   };
 };
 /* end_public_function */

package/src/client/utils/setBotClientToken.ts

@@ -0,0 +1,35 @@
+import { getActiveClient } from '../api/activeClient';
+import { setSessionState } from '../api/setSessionState';
+import { getBotToken } from '../api/getBotToken';
+
+/**
+ * A util to set or refresh client token
+ * @param options get bot token options
+ * @param options.setAccessTokenCookie The authentication token - necessary when network option is set to secure
+ * @returns token & user info
+ *
+ * @category private
+ * @async
+ */
+export const setBotClientToken = async (params: Parameters<typeof getBotToken>[0]) => {
+  const client = getActiveClient();
+  // begin establishing session
+  setSessionState(Amity.SessionStates.ESTABLISHING);
+
+  const { accessToken, users, expiresAt, issuedAt, userType } = await getBotToken(params);
+
+  // manually setup the token for http transport
+  client.http.defaults.headers.common.Authorization = `Bearer ${accessToken}`;
+
+  client.http.defaults.metadata = {
+    tokenExpiry: expiresAt,
+    isGlobalBanned: false,
+    isUserDeleted: false,
+  };
+
+  client.token = { accessToken, issuedAt, expiresAt };
+
+  setSessionState(Amity.SessionStates.ESTABLISHED);
+
+  return { accessToken, users, userType };
+};

package/src/client/utils/setClientToken.ts

@@ -19,7 +19,7 @@ export const setClientToken = async (params: Parameters<typeof getToken>[0]) =>
   // begin establishing session
   setSessionState(Amity.SessionStates.ESTABLISHING);
 
-  const { accessToken, users, expiresAt, issuedAt } = await getToken(params);
+  const { accessToken, users, expiresAt, issuedAt, userType } = await getToken(params);
 
   // manually setup the token for http transport
   client.http.defaults.headers.common.Authorization = `Bearer ${accessToken}`;
@@ -42,5 +42,5 @@ export const setClientToken = async (params: Parameters<typeof getToken>[0]) =>
 
   setSessionState(Amity.SessionStates.ESTABLISHED);
 
-  return { accessToken, users };
+  return { accessToken, users, userType };
 };