@amityco/ts-sdk 0.0.1-beta.16 → 0.0.1-beta.19

package/src/client/api/createClient.ts

@@ -1,13 +1,17 @@
-import { VERSION } from '~/version'
+import { VERSION } from '~/version';
 
-import { createLogger } from '~/core/debug'
+import { createLogger } from '~/core/debug';
 
-import { API_REGIONS, computeUrl } from '~/client/utils/endpoints'
-import { createHttpTransport, createMqttTransport, createWebsocketTransport } from '~/core/transports'
+import { API_REGIONS, computeUrl } from '~/client/utils/endpoints';
+import {
+  createHttpTransport,
+  createMqttTransport,
+  createWebsocketTransport,
+} from '~/core/transports';
 
-import { createEventEmitter } from '~/core/events'
+import { createEventEmitter } from '~/core/events';
 
-import { getActiveClient, setActiveClient } from './activeClient'
+import { getActiveClient, setActiveClient } from './activeClient';
 
 /**
  * ```js
@@ -23,24 +27,24 @@ import { getActiveClient, setActiveClient } from './activeClient'
  * @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: string = 'amity'
+  debugSession = 'amity',
 ): Amity.Client => {
-  const log = createLogger(debugSession)
+  const log = createLogger(debugSession);
 
   log('client/api/createClient', {
     apiKey: apiKey.replace(/.{5}$/g, 'xxxxx'),
     apiRegion,
-  })
+  });
 
-  const http = createHttpTransport(computeUrl('http', apiRegion))
-  const ws = createWebsocketTransport(computeUrl('http', apiRegion))
+  const http = createHttpTransport(computeUrl('http', apiRegion));
+  const ws = createWebsocketTransport(computeUrl('http', apiRegion));
   const mqtt = createMqttTransport(computeUrl('mqtt', apiRegion));
 
-  const emitter = createEventEmitter()
+  const emitter = createEventEmitter();
 
   const client = {
     version: `${VERSION}`,
@@ -52,13 +56,13 @@ export const createClient = (
     mqtt,
     emitter,
     use: () => setActiveClient(client),
-  }
+  };
 
   try {
-    getActiveClient()
+    getActiveClient();
   } catch {
-    setActiveClient(client)
+    setActiveClient(client);
   }
 
-  return client
-}
+  return client;
+};

package/src/client/api/disconnectClient.ts

@@ -1,4 +1,4 @@
-import { getActiveClient } from './activeClient'
+import { getActiveClient } from './activeClient';
 
 /**
  * ```js
@@ -15,21 +15,21 @@ import { getActiveClient } from './activeClient'
  * @async
  */
 export const disconnectClient = async (): Promise<boolean> => {
-  const client = getActiveClient()
-  client.log('client/api/disconnectClient')
+  const client = getActiveClient();
+  client.log('client/api/disconnectClient');
 
   await new Promise(resolve => {
-    client.ws.once('disconnect', resolve)
-    client.ws.disconnect()
-    client.mqtt.disconnect()
-  })
+    client.ws.once('disconnect', resolve);
+    client.ws.disconnect();
+    client.mqtt.disconnect();
+  });
 
-  client.emitter.all.clear()
+  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.accessToken = undefined
+  client.ws.removeAllListeners();
+  client.mqtt.removeAllListeners();
+  client.userId = undefined;
+  client.accessToken = undefined;
 
-  return !client.ws.connected
-}
+  return !client.ws.connected;
+};

package/src/client/api/getToken.ts

@@ -1,6 +1,6 @@
-import { getActiveClient } from './activeClient'
+import { getActiveClient } from './activeClient';
 
-import { getDeviceInfo } from '~/core/device'
+import { getDeviceInfo } from '~/core/device';
 
 /**
  * Retrieves a pair of {@link Amity.Tokens} necessary for connection
@@ -15,22 +15,27 @@ import { getDeviceInfo } from '~/core/device'
  * @hidden
  */
 export const getToken = async (params: {
-  userId: Amity.User['userId'],
-  displayName: Amity.User['displayName'],
-  authToken?: string,
-  deviceId: Amity.Device['deviceId'],
+  userId: Amity.User['userId'];
+  displayName: Amity.User['displayName'];
+  authToken?: string;
+  deviceId: Amity.Device['deviceId'];
 }) => {
-  const client = getActiveClient()
-  client.log('client/api/getToken', params)
+  const client = getActiveClient();
+  client.log('client/api/getToken', params);
 
-  const deviceInfo = await getDeviceInfo()
+  const deviceInfo = await getDeviceInfo();
 
-  const { data } = await client.http.post<Amity.Tokens & { users: Amity.User[] }>('/v1/device', {
-    ...params, deviceInfo,
-  } , {
-    //@ts-ignore
-    headers: { 'X-API-Key': client.apiKey }
-  })
+  const { data } = await client.http.post<Amity.Tokens & { users: Amity.User[] }>(
+    '/v1/device',
+    {
+      ...params,
+      deviceInfo,
+    },
+    {
+      // @ts-ignore
+      headers: { 'X-API-Key': client.apiKey },
+    },
+  );
 
-  return data
-}
+  return data;
+};

package/src/client/api/index.ts

@@ -1,8 +1,8 @@
-export { getActiveClient } from './activeClient'
+export { getActiveClient } from './activeClient';
 
-export * from './createClient'
+export * from './createClient';
 
-export * from './connectClient'
-export * from './disconnectClient'
+export * from './connectClient';
+export * from './disconnectClient';
 
-export * from './isConnected'
+export * from './isConnected';

package/src/client/api/isConnected.ts

@@ -1,4 +1,4 @@
-import { getActiveClient } from './activeClient'
+import { getActiveClient } from './activeClient';
 
 /**
  * ```js
@@ -13,12 +13,12 @@ import { getActiveClient } from './activeClient'
  * @category Client API
  */
 export const isConnected = (): boolean => {
-  const client = getActiveClient()
-  client.log('client/api/isConnected', client)
+  const client = getActiveClient();
+  client.log('client/api/isConnected', client);
 
   return !!(
-       client.userId
-    && client.http.defaults.headers.common?.['Authorization']?.length
-    && client.ws.connected
-  )
-}
+    client.userId &&
+    client.http.defaults.headers.common?.Authorization?.length &&
+    client.ws.connected
+  );
+};

package/src/client/events/index.ts

@@ -1,4 +1,4 @@
-export * from './onConnectionError'
+export * from './onConnectionError';
 
-export * from './onClientDisconnected'
-export * from './onClientBanned'
+export * from './onClientDisconnected';
+export * from './onClientBanned';

package/src/client/events/onClientBanned.ts

@@ -1,4 +1,4 @@
-import { onConnectionError } from './onConnectionError'
+import { onConnectionError } from './onConnectionError';
 
 /**
  * ```js
@@ -15,10 +15,8 @@ import { onConnectionError } from './onConnectionError'
  *
  * @category Client Events
  */
-export const onClientBanned = (
-  callback: Amity.Listener<void>,
-): Amity.Unsubscriber => {
+export const onClientBanned = (callback: Amity.Listener<void>): Amity.Unsubscriber => {
   return onConnectionError(({ code }) => {
-    code === Amity.ServerError.GLOBAL_BAN && callback()
-  })
-}
+    code === Amity.ServerError.GLOBAL_BAN && callback();
+  });
+};

package/src/client/events/onClientDisconnected.ts

@@ -1,4 +1,4 @@
-import { onConnectionError } from './onConnectionError'
+import { onConnectionError } from './onConnectionError';
 
 /**
  * ```js
@@ -15,10 +15,8 @@ import { onConnectionError } from './onConnectionError'
  *
  * @category Client Events
  */
-export const onClientDisconnected = (
-  callback: Amity.Listener<void>,
-): Amity.Unsubscriber => {
+export const onClientDisconnected = (callback: Amity.Listener<void>): Amity.Unsubscriber => {
   return onConnectionError(({ code }) => {
-    code === Amity.ClientError.DISCONNECTED && callback()
-  })
-}
+    code === Amity.ClientError.DISCONNECTED && callback();
+  });
+};

package/src/client/events/onConnectionError.ts

@@ -1,8 +1,8 @@
-import { getActiveClient } from '~/client/api/activeClient'
+import { getActiveClient } from '~/client/api/activeClient';
 
-import { createEventSubscriber } from '~/core/events'
+import { createEventSubscriber } from '~/core/events';
 
-import { ASCError, ASCConnectionError } from '~/core/errors'
+import { ASCError, ASCConnectionError } from '~/core/errors';
 
 const EVENTS = [
   'disconnected',
@@ -10,7 +10,7 @@ const EVENTS = [
   'connect_error',
   'reconnect_error',
   'reconnect_failed',
-] as const
+] as const;
 
 /**
  * ```js
@@ -27,27 +27,20 @@ const EVENTS = [
  *
  * @category Client Events
  */
-export const onConnectionError = (
-  callback: Amity.Listener<ASCError>,
-): Amity.Unsubscriber => {
-  const client = getActiveClient()
+export const onConnectionError = (callback: Amity.Listener<ASCError>): Amity.Unsubscriber => {
+  const client = getActiveClient();
 
-  const subscribers = EVENTS.map(event => (
-    createEventSubscriber(
-      client,
-      `client/onConnectionError(${event})`,
-      event,
-      (response) => {
-        const error = response?.code
-          ? new ASCError(response.message, response.code, Amity.ErrorLevel.FATAL)
-          : new ASCConnectionError(event)
+  const subscribers = EVENTS.map(event =>
+    createEventSubscriber(client, `client/onConnectionError(${event})`, event, response => {
+      const error = response?.code
+        ? new ASCError(response.message, response.code, Amity.ErrorLevel.FATAL)
+        : new ASCConnectionError(event);
 
-        callback(error)
-      },
-    )
-  ))
+      callback(error);
+    }),
+  );
 
   return () => {
-    subscribers.forEach(fn => fn())
-  }
-}
+    subscribers.forEach(fn => fn());
+  };
+};

package/src/client/utils/endpoints.ts

@@ -2,13 +2,13 @@ export const API_REGIONS = {
   EU: 'eu',
   SG: 'sg',
   US: 'us',
-} as const
+} as const;
 
 const URLS = {
   http: 'https://api.{region}.amity.co',
   mqtt: 'wss://sse.{region}.amity.co:443/mqtt',
-} as const
+} as const;
 
 export function computeUrl(type: keyof typeof URLS, region: string) {
-  return URLS[type].replace('{region}', region)
+  return URLS[type].replace('{region}', region);
 }

package/src/comment/api/createComment.ts

@@ -1,9 +1,9 @@
-import { getActiveClient } from '~/client/api'
+import { getActiveClient } from '~/client/api';
 
-import { ingestInCache } from '~/cache/api/ingestInCache'
-import { fireEvent } from '~/core/events'
+import { ingestInCache } from '~/cache/api/ingestInCache';
+import { fireEvent } from '~/core/events';
 
-import { getPost } from '~/post/api/getPost'
+import { getPost } from '~/post/api/getPost';
 
 /**
  * ```js
@@ -20,26 +20,27 @@ import { getPost } from '~/post/api/getPost'
  * @async
  */
 export const createComment = async <T extends Amity.CommentContentType>(
-  bundle: Pick<Amity.Comment<T>, 'referenceType' | 'referenceId' | 'parentId' | 'data' | 'metadata' | 'mentionees'>,
+  bundle: Pick<
+    Amity.Comment<T>,
+    'referenceType' | 'referenceId' | 'parentId' | 'data' | 'metadata' | 'mentionees'
+  >,
 ): Promise<Amity.Cached<Amity.Comment>> => {
-  const client = getActiveClient()
-  client.log('comment/createComment', bundle)
+  const client = getActiveClient();
+  client.log('comment/createComment', bundle);
 
-  const { data } = await client.http.post<Amity.CommentPayload>(
-    '/api/v3/comments', bundle,
-  )
+  const { data } = await client.http.post<Amity.CommentPayload>('/api/v3/comments', bundle);
 
-  const cachedAt = client.cache && Date.now()
-  if (client.cache) ingestInCache(data, { cachedAt })
+  const cachedAt = client.cache && Date.now();
+  if (client.cache) ingestInCache(data, { cachedAt });
 
-  const post = await getPost(bundle.referenceId)
+  const post = await getPost(bundle.referenceId);
 
-  fireEvent('post.updated', { posts: [post.data] })
-  fireEvent('comment.created', data)
+  fireEvent('post.updated', { posts: [post.data] });
+  fireEvent('comment.created', data);
 
-  const { comments } = data
+  const { comments } = data;
   return {
     data: comments[0],
     cachedAt,
-  }
-}
+  };
+};

package/src/comment/api/deleteComment.ts

@@ -1,11 +1,10 @@
-import { getActiveClient } from '~/client/api'
+import { getActiveClient } from '~/client/api';
 
-import { dropFromCache } from '~/cache/api'
-import { upsertInCache } from '~/cache/api'
-import { fireEvent } from '~/core/events'
+import { dropFromCache, upsertInCache } from '~/cache/api';
+import { fireEvent } from '~/core/events';
 
-import { getComment } from './getComment'
-import { getPost } from '~/post/api/getPost'
+import { getComment } from './getComment';
+import { getPost } from '~/post/api/getPost';
 
 /**
  * ```js
@@ -23,39 +22,39 @@ import { getPost } from '~/post/api/getPost'
  */
 export const deleteComment = async (
   commentId: Amity.Comment['commentId'],
-  permanent: boolean = false,
+  permanent = false,
 ): Promise<Amity.Comment> => {
-  const client = getActiveClient()
-  client.log('comment/deleteComment', commentId)
+  const client = getActiveClient();
+  client.log('comment/deleteComment', commentId);
 
-  const comment = await getComment(commentId)
+  const comment = await getComment(commentId);
 
   // API-FIX: This endpoint has not been implemented yet.
   await client.http.delete<{ success: boolean }>(
-    `/api/v4/comments/${encodeURIComponent(commentId)}`, {
+    `/api/v4/comments/${encodeURIComponent(commentId)}`,
+    {
       params: {
         commentId,
         permanent,
       },
     },
-  )
+  );
 
   // to support hard deletion
-  const deleted = { ...comment.data, isDeleted: true }
+  const deleted = { ...comment.data, isDeleted: true };
 
-  const post = await getPost(comment.data.referenceId)
-
-  fireEvent('post.updated', { posts: [post.data] })
-  fireEvent('comment.deleted', { comments: [deleted] })
+  const post = await getPost(comment.data.referenceId);
 
+  fireEvent('post.updated', { posts: [post.data] });
+  fireEvent('comment.deleted', { comments: [deleted] });
 
   if (permanent) {
     setTimeout(() => {
-      dropFromCache(['comment', 'get', commentId], true)
-    }, 0)
+      dropFromCache(['comment', 'get', commentId], true);
+    }, 0);
   } else {
-    upsertInCache(['comment', 'get', commentId], {isDeleted: true})
+    upsertInCache(['comment', 'get', commentId], { isDeleted: true });
   }
 
-  return deleted
-}
+  return deleted;
+};

package/src/comment/api/getComment.ts

@@ -1,7 +1,7 @@
-import { getActiveClient } from '~/client/api'
+import { getActiveClient } from '~/client/api';
 
-import { pullFromCache, dropFromCache } from '~/cache/api'
-import { ingestInCache } from '~/cache/api/ingestInCache'
+import { pullFromCache, dropFromCache } from '~/cache/api';
+import { ingestInCache } from '~/cache/api/ingestInCache';
 
 /**
  * ```js
@@ -18,10 +18,10 @@ import { ingestInCache } from '~/cache/api/ingestInCache'
  * @async
  */
 export const getComment = async (
-  commentId: Amity.Comment['commentId']
+  commentId: Amity.Comment['commentId'],
 ): Promise<Amity.Cached<Amity.Comment>> => {
-  const client = getActiveClient()
-  client.log('comment/getComment', commentId)
+  const client = getActiveClient();
+  client.log('comment/getComment', commentId);
 
   let data: Amity.CommentPayload;
 
@@ -29,26 +29,26 @@ export const getComment = async (
     // API-FIX: endpoint should not be /list, parameters should be querystring.
     const response = await client.http.get<Amity.CommentPayload>(
       `/api/v3/comments/${encodeURIComponent(commentId)}`,
-    )
+    );
 
     data = response.data;
   } catch (error) {
-    if ((error as Amity.ErrorResponse)?.code  === Amity.ServerError.ITEM_NOT_FOUND) {
-      dropFromCache(['comment', 'get', commentId], true)
+    if ((error as Amity.ErrorResponse)?.code === Amity.ServerError.ITEM_NOT_FOUND) {
+      dropFromCache(['comment', 'get', commentId], true);
     }
 
     throw error;
   }
 
-  const cachedAt = client.cache && Date.now()
-  if (client.cache) ingestInCache(data, { cachedAt })
+  const cachedAt = client.cache && Date.now();
+  if (client.cache) ingestInCache(data, { cachedAt });
 
-  const { comments } = data
+  const { comments } = data;
   return {
     data: comments.find(comment => comment.commentId === commentId)!,
     cachedAt,
-  }
-}
+  };
+};
 
 /**
  * ```js
@@ -64,20 +64,19 @@ export const getComment = async (
  * @category Comment API
  */
 getComment.locally = (
-  commentId: Amity.Comment['commentId']
+  commentId: Amity.Comment['commentId'],
 ): Amity.Cached<Amity.Comment> | undefined => {
-  const client = getActiveClient()
-  client.log('comment/getComment.locally', commentId)
+  const client = getActiveClient();
+  client.log('comment/getComment.locally', commentId);
 
-  if (!client.cache) return
+  if (!client.cache) return;
 
-  const cached = pullFromCache<Amity.Comment>(['comment', 'get', commentId])
+  const cached = pullFromCache<Amity.Comment>(['comment', 'get', commentId]);
 
-  if (!cached)
-    return
+  if (!cached) return;
 
   return {
     data: cached.data,
     cachedAt: cached.cachedAt,
-  }
-}
+  };
+};

package/src/comment/api/getComments.ts

@@ -1,7 +1,7 @@
-import { getActiveClient } from '~/client/api'
+import { getActiveClient } from '~/client/api';
 
-import { pullFromCache } from '~/cache/api'
-import { ingestInCache } from '~/cache/api/ingestInCache'
+import { pullFromCache } from '~/cache/api';
+import { ingestInCache } from '~/cache/api/ingestInCache';
 
 /**
  * ```js
@@ -20,25 +20,24 @@ import { ingestInCache } from '~/cache/api/ingestInCache'
 export const getComments = async (
   commentIds: Amity.Comment['commentId'][],
 ): Promise<Amity.Cached<Amity.Comment[]>> => {
-  const client = getActiveClient()
-  client.log('comment/getComments', commentIds)
+  const client = getActiveClient();
+  client.log('comment/getComments', commentIds);
 
-  const encodedCommentIds = commentIds.map(commentId => encodeURIComponent(commentId))
+  const encodedCommentIds = commentIds.map(commentId => encodeURIComponent(commentId));
 
   // API-FIX: endpoint should not be /list, parameters should be querystring.
-  const { data } = await client.http.get<Amity.CommentPayload>(
-    `/api/v3/comments/list`,
-    { params: { commentIds: encodedCommentIds } },
-  )
+  const { data } = await client.http.get<Amity.CommentPayload>(`/api/v3/comments/list`, {
+    params: { commentIds: encodedCommentIds },
+  });
 
-  const cachedAt = client.cache && Date.now()
-  if (client.cache) ingestInCache(data, { cachedAt })
+  const cachedAt = client.cache && Date.now();
+  if (client.cache) ingestInCache(data, { cachedAt });
 
   return {
     data: data.comments,
-    cachedAt
-  }
-}
+    cachedAt,
+  };
+};
 
 /**
  * ```js
@@ -54,25 +53,24 @@ export const getComments = async (
  * @category Comment API
  */
 getComments.locally = (
-  commentIds: Amity.Comment['commentId'][]
+  commentIds: Amity.Comment['commentId'][],
 ): Amity.Cached<Amity.Comment[]> | undefined => {
-  const client = getActiveClient()
-  client.log('comment/getComments.locally', commentIds)
+  const client = getActiveClient();
+  client.log('comment/getComments.locally', commentIds);
 
-  if (!client.cache) return
+  if (!client.cache) return;
 
   const cached = commentIds
     .map(commentId => pullFromCache<Amity.Comment>(['comment', 'get', commentId])!)
-    .filter(Boolean)
+    .filter(Boolean);
 
-  const comments = cached.map(({ data }) => data)
-  const oldest = cached.sort((a, b) => a.cachedAt! < b.cachedAt! ? -1 : 1)?.[0]
+  const comments = cached.map(({ data }) => data);
+  const oldest = cached.sort((a, b) => (a.cachedAt! < b.cachedAt! ? -1 : 1))?.[0];
 
-  if (cached?.length < commentIds.length)
-    return
+  if (cached?.length < commentIds.length) return;
 
   return {
     data: comments,
     cachedAt: oldest.cachedAt,
-  }
-}
+  };
+};

package/src/comment/api/index.ts

@@ -1,7 +1,7 @@
-export * from './queryComments'
-export * from './getComments'
-export * from './getComment'
+export * from './queryComments';
+export * from './getComments';
+export * from './getComment';
 
-export * from './createComment'
-export * from './updateComment'
-export * from './deleteComment'
+export * from './createComment';
+export * from './updateComment';
+export * from './deleteComment';