@amityco/ts-sdk 7.9.2-b0506da9.0 → 7.9.2-e5e334a7.0

package/dist/messagePreview/utils/getSubChannelMessagePreviewWithUser.d.ts

@@ -3,7 +3,7 @@ export declare const getSubChannelMessagePreviewWithUser: (subChannel: Amity.Sub
         user: Amity.InternalUser | undefined;
         messagePreviewId: string;
         subChannelName: string;
-        data?: string | Record<string, unknown> | Amity.ContentDataText | Amity.ContentDataFile | Amity.ContentDataImage | Amity.ContentDataVideo | Amity.ContentDataAudio | Amity.ContentDataPoll | Amity.ContentDataStream | Amity.ContentDataClip | undefined;
+        data?: string | Record<string, unknown> | Amity.ContentDataText | Amity.ContentDataFile | Amity.ContentDataImage | Amity.ContentDataVideo | Amity.ContentDataPoll | Amity.ContentDataStream | Amity.ContentDataClip | undefined;
         dataType?: any;
         channelId: string;
         subChannelId: string;

package/dist/postRepository/api/index.d.ts

@@ -10,5 +10,4 @@ export * from './flagPost';
 export * from './unflagPost';
 export * from './isPostFlaggedByMe';
 export * from './createClipPost';
-export * from './createAudioPost';
 //# sourceMappingURL=index.d.ts.map

package/dist/postRepository/api/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/postRepository/api/index.ts"],"names":[],"mappings":"AAAA,cAAc,gBAAgB,CAAC;AAE/B,cAAc,cAAc,CAAC;AAC7B,cAAc,YAAY,CAAC;AAE3B,cAAc,cAAc,CAAC;AAC7B,cAAc,kBAAkB,CAAC;AACjC,cAAc,kBAAkB,CAAC;AAEjC,cAAc,eAAe,CAAC;AAC9B,cAAc,eAAe,CAAC;AAE9B,cAAc,YAAY,CAAC;AAC3B,cAAc,cAAc,CAAC;AAC7B,cAAc,qBAAqB,CAAC;AAEpC,cAAc,kBAAkB,CAAC;AACjC,cAAc,mBAAmB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/postRepository/api/index.ts"],"names":[],"mappings":"AAAA,cAAc,gBAAgB,CAAC;AAE/B,cAAc,cAAc,CAAC;AAC7B,cAAc,YAAY,CAAC;AAE3B,cAAc,cAAc,CAAC;AAC7B,cAAc,kBAAkB,CAAC;AACjC,cAAc,kBAAkB,CAAC;AAEjC,cAAc,eAAe,CAAC;AAC9B,cAAc,eAAe,CAAC;AAE9B,cAAc,YAAY,CAAC;AAC3B,cAAc,cAAc,CAAC;AAC7B,cAAc,qBAAqB,CAAC;AAEpC,cAAc,kBAAkB,CAAC"}

package/dist/utils/linkedObject/postLinkedObject.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"postLinkedObject.d.ts","sourceRoot":"","sources":["../../../src/utils/linkedObject/postLinkedObject.ts"],"names":[],"mappings":"AAiBA,eAAO,MAAM,gBAAgB,SAAU,MAAM,YAAY,KAAG,MAAM,IA8FjE,CAAC"}
+{"version":3,"file":"postLinkedObject.d.ts","sourceRoot":"","sources":["../../../src/utils/linkedObject/postLinkedObject.ts"],"names":[],"mappings":"AAgBA,eAAO,MAAM,gBAAgB,SAAU,MAAM,YAAY,KAAG,MAAM,IAwFjE,CAAC"}

package/dist/utils/postTypePredicate.d.ts

@@ -4,5 +4,4 @@ export declare function isAmityVideoPost(post: Amity.InternalPost): post is Amit
 export declare function isAmityLivestreamPost(post: Amity.InternalPost): post is Amity.Post<'liveStream'>;
 export declare function isAmityPollPost(post: Amity.InternalPost): post is Amity.Post<'poll'>;
 export declare function isAmityClipPost(post: Amity.InternalPost): post is Amity.Post<'clip'>;
-export declare function isAmityAudioPost(post: Amity.InternalPost): post is Amity.Post<'audio'>;
 //# sourceMappingURL=postTypePredicate.d.ts.map

package/dist/utils/postTypePredicate.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"postTypePredicate.d.ts","sourceRoot":"","sources":["../../src/utils/postTypePredicate.ts"],"names":[],"mappings":"AAAA,wBAAgB,gBAAgB,CAAC,IAAI,EAAE,KAAK,CAAC,YAAY,GAAG,IAAI,IAAI,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAOtF;AAED,wBAAgB,eAAe,CAAC,IAAI,EAAE,KAAK,CAAC,YAAY,GAAG,IAAI,IAAI,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAOpF;AAED,wBAAgB,gBAAgB,CAAC,IAAI,EAAE,KAAK,CAAC,YAAY,GAAG,IAAI,IAAI,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAQtF;AAED,wBAAgB,qBAAqB,CAAC,IAAI,EAAE,KAAK,CAAC,YAAY,GAAG,IAAI,IAAI,KAAK,CAAC,IAAI,CAAC,YAAY,CAAC,CAOhG;AAED,wBAAgB,eAAe,CAAC,IAAI,EAAE,KAAK,CAAC,YAAY,GAAG,IAAI,IAAI,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAOpF;AAED,wBAAgB,eAAe,CAAC,IAAI,EAAE,KAAK,CAAC,YAAY,GAAG,IAAI,IAAI,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAOpF;AAED,wBAAgB,gBAAgB,CAAC,IAAI,EAAE,KAAK,CAAC,YAAY,GAAG,IAAI,IAAI,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAOtF"}
+{"version":3,"file":"postTypePredicate.d.ts","sourceRoot":"","sources":["../../src/utils/postTypePredicate.ts"],"names":[],"mappings":"AAAA,wBAAgB,gBAAgB,CAAC,IAAI,EAAE,KAAK,CAAC,YAAY,GAAG,IAAI,IAAI,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAOtF;AAED,wBAAgB,eAAe,CAAC,IAAI,EAAE,KAAK,CAAC,YAAY,GAAG,IAAI,IAAI,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAOpF;AAED,wBAAgB,gBAAgB,CAAC,IAAI,EAAE,KAAK,CAAC,YAAY,GAAG,IAAI,IAAI,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAQtF;AAED,wBAAgB,qBAAqB,CAAC,IAAI,EAAE,KAAK,CAAC,YAAY,GAAG,IAAI,IAAI,KAAK,CAAC,IAAI,CAAC,YAAY,CAAC,CAOhG;AAED,wBAAgB,eAAe,CAAC,IAAI,EAAE,KAAK,CAAC,YAAY,GAAG,IAAI,IAAI,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAOpF;AAED,wBAAgB,eAAe,CAAC,IAAI,EAAE,KAAK,CAAC,YAAY,GAAG,IAAI,IAAI,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAOpF"}

package/dist/utils/tests/dummy/comment.d.ts

@@ -23,7 +23,7 @@ export declare const generateComment: (params?: Partial<Amity.InternalComment>)
     referenceType: Amity.CommentReferenceType;
     dataType?: any;
     dataTypes?: any[] | undefined;
-    data?: string | Record<string, unknown> | Amity.ContentDataText | Amity.ContentDataFile | Amity.ContentDataImage | Amity.ContentDataVideo | Amity.ContentDataAudio | Amity.ContentDataPoll | Amity.ContentDataStream | Amity.ContentDataClip | undefined;
+    data?: string | Record<string, unknown> | Amity.ContentDataText | Amity.ContentDataFile | Amity.ContentDataImage | Amity.ContentDataVideo | Amity.ContentDataPoll | Amity.ContentDataStream | Amity.ContentDataClip | undefined;
     metadata?: Record<string, any> | undefined;
     flagCount: number;
     hashFlag: {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@amityco/ts-sdk",
-  "version": "7.9.2-b0506da9.0",
+  "version": "7.9.2-e5e334a7.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

@@ -76,6 +76,8 @@ declare global {
       getMarkerSyncConsistentMode: () => boolean;
 
       prefixDeviceIdKey?: string;
+
+      getDeviceId: () => Promise<string>;
     };
 
     type Device = {
@@ -94,10 +96,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 +162,11 @@ declare global {
       deviceId?: Amity.Device['deviceId'];
     };
 
+    type ConnectClientAsVisitorParams = {
+      authSignature?: string;
+      authSignatureExpiresAt?: string;
+    };
+
     type ConnectClientConfig = {
       disableRTE: boolean;
     };

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

@@ -33,7 +33,6 @@ declare global {
       | 'json'
       | 'liveStream'
       | 'clip'
-      | 'audio'
       | string;
 
     type ContentFeedType = ValueOf<typeof ContentFeedType>;
@@ -72,14 +71,6 @@ declare global {
       displayMode?: Amity.ClipDisplayMode;
     };
 
-    type ContentDataAudio = {
-      fileId: Amity.File<'audio'>['fileId'];
-      fileURL: URL;
-      accessType: Amity.FileAccessType;
-      altText?: string;
-      attributes: { [key: string]: any };
-    };
-
     type ContentDataPoll = {
       pollId: Amity.Poll['pollId'];
     };
@@ -96,8 +87,6 @@ declare global {
       ? ContentDataImage
       : T extends 'video'
       ? ContentDataVideo
-      : T extends 'audio'
-      ? ContentDataAudio
       : T extends 'poll'
       ? ContentDataPoll
       : T extends 'liveStream'

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

@@ -3,7 +3,6 @@ export const FileType = Object.freeze({
   IMAGE: 'image',
   VIDEO: 'video',
   CLIP: 'clip',
-  AUDIO: 'audio',
 });
 
 export const VideoResolution = Object.freeze({
@@ -59,8 +58,6 @@ declare global {
 
     type ClipMetadata = Record<string, never>;
 
-    type AudioMetadata = Record<string, never>;
-
     type MetadataFor<T extends FileType> = T extends 'file'
       ? FileMetadata
       : T extends 'image'
@@ -69,8 +66,6 @@ declare global {
       ? VideoMetadata
       : T extends 'clip'
       ? ClipMetadata
-      : T extends 'audio'
-      ? AudioMetadata
       : never;
 
     type File<T extends FileType = any> = Amity.FilePayload<T>;

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

@@ -88,7 +88,6 @@ declare global {
       getPollInfo: () => Amity.Poll | undefined;
       getLivestreamInfo: () => Amity.Stream | undefined;
       getClipInfo: () => Amity.File<'clip'> | undefined;
-      getAudioInfo: () => Amity.File<'audio'> | undefined;
     };
 
     type Post<T extends PostContentType = any> = Amity.InternalPost<T> & Amity.PostLinkObject;

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/categoryRepository/api/getCategory.ts

@@ -37,7 +37,9 @@ export const getCategory = async (
   const { categories } = data;
 
   return {
-    data: LinkedObject.category(categories.find(category => category.categoryId === categoryId)!),
+    data: LinkedObject.category(
+      (categories ?? []).find(category => category.categoryId === categoryId)!,
+    ),
     cachedAt,
   };
 };

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/createClient.ts

@@ -3,11 +3,7 @@ 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 { createHttpTransport, createMqttTransport } from '~/core/transports';
 
 import { createEventEmitter } from '~/core/events';
 
@@ -21,6 +17,7 @@ import { getFeedSettings } from './getFeedSettings';
 
 import { accessTokenExpiryWatcher } from './accessTokenExpiryWatcher';
 import { getMarkerSyncConsistentMode } from '../utils/markerSyncEngine';
+import { getDeviceId } from '~/core/device';
 
 const DEFAULT_DEBUG_SESSION = 'amity';
 
@@ -121,6 +118,7 @@ export const createClient = (
     validateTexts,
     getFeedSettings,
     getSocialSettings,
+    getDeviceId,
     getMessagePreviewSetting,
 
     use: () => setActiveClient(client),

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 */