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

package/src/channel/events/onMemberAdded.ts

@@ -1,7 +1,7 @@
-import { getActiveClient } from '~/client/api'
-import { createEventSubscriber } from '~/core/events'
+import { getActiveClient } from '~/client/api';
+import { createEventSubscriber } from '~/core/events';
 
-import { ingestInCache } from '~/cache/api/ingestInCache'
+import { ingestInCache } from '~/cache/api/ingestInCache';
 
 /**
  * ```js
@@ -19,17 +19,12 @@ import { ingestInCache } from '~/cache/api/ingestInCache'
  * @category Channel Events
  */
 export const onMemberAdded = (callback: Amity.Listener<Amity.Channel>) => {
-  const client = getActiveClient()
+  const client = getActiveClient();
 
   const filter = (payload: Amity.ChannelPayload) => {
-    ingestInCache(payload)
-    callback(payload.channels[0])
-  }
+    ingestInCache(payload);
+    callback(payload.channels[0]);
+  };
 
-  return createEventSubscriber(
-    client,
-    'onMemberAdded',
-    'v3.channel.didAddUsers',
-    filter
-  )
-}
+  return createEventSubscriber(client, 'onMemberAdded', 'v3.channel.didAddUsers', filter);
+};

package/src/channel/events/onMemberRemoved.ts

@@ -1,7 +1,7 @@
-import { getActiveClient } from '~/client/api'
-import { createEventSubscriber } from '~/core/events'
+import { getActiveClient } from '~/client/api';
+import { createEventSubscriber } from '~/core/events';
 
-import { ingestInCache } from '~/cache/api/ingestInCache'
+import { ingestInCache } from '~/cache/api/ingestInCache';
 
 /**
  * ```js
@@ -19,17 +19,12 @@ import { ingestInCache } from '~/cache/api/ingestInCache'
  * @category Channel Events
  */
 export const onMemberRemoved = (callback: Amity.Listener<Amity.Channel>) => {
-  const client = getActiveClient()
+  const client = getActiveClient();
 
   const filter = (payload: Amity.ChannelPayload) => {
-    ingestInCache(payload)
-    callback(payload.channels[0])
-  }
+    ingestInCache(payload);
+    callback(payload.channels[0]);
+  };
 
-  return createEventSubscriber(
-    client,
-    'onMemberRemoved',
-    'v3.channel.didRemoveUsers',
-    filter
-  )
-}
+  return createEventSubscriber(client, 'onMemberRemoved', 'v3.channel.didRemoveUsers', filter);
+};

package/src/channel/observers/index.ts

@@ -1 +1 @@
-export * from './observeChannel'
+export * from './observeChannel';

package/src/channel/observers/observeChannel.ts

@@ -1,8 +1,8 @@
-import { createQuery, runQuery } from '~/core/query/query'
+import { createQuery, runQuery } from '~/core/query/query';
 
-import { getActiveClient } from '~/client/api'
+import { getActiveClient } from '~/client/api';
 
-import { getChannel } from '../api'
+import { getChannel } from '../api';
 
 import {
   onChannelUpdated,
@@ -11,7 +11,7 @@ import {
   onChannelLeft,
   onMemberAdded,
   onMemberRemoved,
-} from '../events'
+} from '../events';
 
 /**
  * ```js
@@ -37,33 +37,30 @@ export const observeChannel = <
     'onJoin',
     'onLeft',
     'onMemberAdded',
-    'onMemberRemoved'
-  ]
+    'onMemberRemoved',
+  ],
 >(
   channelId: string,
-  callback: Amity.ObjectListener<Amity.Snapshot<Amity.Channel>, Events>
+  callback: Amity.ObjectListener<Amity.Snapshot<Amity.Channel>, Events>,
 ): Amity.Unsubscriber => {
-  const { log } = getActiveClient()
+  const { log } = getActiveClient();
 
-  const timestamp = Date.now()
-  log(`observeChannel(tmpid: ${timestamp}) > listen`)
+  const timestamp = Date.now();
+  log(`observeChannel(tmpid: ${timestamp}) > listen`);
 
   // wrapper function to make sure
-  const router = (
-    result: Amity.Snapshot<Amity.Channel>,
-    action: Events[number]
-  ) => {
+  const router = (result: Amity.Snapshot<Amity.Channel>, action: Events[number]) => {
     // filter function
-    if (result.data?.channelId !== channelId) return
+    if (result.data?.channelId !== channelId) return;
 
-    if (callback instanceof Function) return callback(result)
+    if (callback instanceof Function) return callback(result);
 
-    if (action !== 'onFetch') callback.onEvent?.(action, result)
+    if (action !== 'onFetch') callback.onEvent?.(action, result);
 
-    callback[action]?.(result)
-  }
+    callback[action]?.(result);
+  };
 
-  const disposers: Amity.Unsubscriber[] = []
+  const disposers: Amity.Unsubscriber[] = [];
 
   disposers.push(
     onChannelUpdated(data => router({ data, loading: false, origin: 'event' }, 'onUpdate')),
@@ -71,16 +68,13 @@ export const observeChannel = <
     onChannelJoined(data => router({ data, loading: false, origin: 'event' }, 'onJoin')),
     onChannelLeft(data => router({ data, loading: false, origin: 'event' }, 'onLeft')),
     onMemberAdded(data => router({ data, loading: false, origin: 'event' }, 'onMemberAdded')),
-    onMemberRemoved(data => router({ data, loading: false, origin: 'event' }, 'onMemberRemoved'))
-  )
+    onMemberRemoved(data => router({ data, loading: false, origin: 'event' }, 'onMemberRemoved')),
+  );
 
-  runQuery(
-    createQuery(getChannel, channelId),
-    result => result.data && router(result, 'onFetch')
-  )
+  runQuery(createQuery(getChannel, channelId), result => result.data && router(result, 'onFetch'));
 
   return () => {
-    log(`observeChannel(tmpid: ${timestamp}) > dispose`)
-    disposers.forEach(fn => fn())
-  }
-}
+    log(`observeChannel(tmpid: ${timestamp}) > dispose`);
+    disposers.forEach(fn => fn());
+  };
+};

package/src/client/api/activeClient.ts

@@ -1,6 +1,6 @@
-import { ASCError } from '~/core/errors'
+import { ASCError } from '~/core/errors';
 
-let activeClient: Amity.Client | null = null
+let activeClient: Amity.Client | null = null;
 
 /**
  * Get the active client
@@ -15,11 +15,11 @@ export const getActiveClient = () => {
       'There is no active client',
       Amity.ClientError.UNKNOWN_ERROR,
       Amity.ErrorLevel.FATAL,
-    )
+    );
   }
 
-  return activeClient!
-}
+  return activeClient!;
+};
 
 /**
  * Sets the active client
@@ -29,5 +29,5 @@ export const getActiveClient = () => {
  * @hidden
  */
 export const setActiveClient = (client: Amity.Client) => {
-  activeClient = client
-}
+  activeClient = client;
+};

package/src/client/api/activeUser.ts

@@ -1,6 +1,6 @@
-import { ASCError } from '~/core/errors'
+import { ASCError } from '~/core/errors';
 
-let activeUser: Pick<Amity.User, '_id' | 'userId' | 'path'> | null = null
+let activeUser: Pick<Amity.User, '_id' | 'userId' | 'path'> | null = null;
 
 /**
  * for internal use
@@ -11,16 +11,16 @@ export const getActiveUser = () => {
       'Connect client first',
       Amity.ClientError.UNKNOWN_ERROR,
       Amity.ErrorLevel.FATAL,
-    )
+    );
   }
 
-  return activeUser!
-}
+  return activeUser!;
+};
 
 export const setActiveUser = (user: Amity.User) => {
   activeUser = {
     _id: user._id,
     userId: user.userId,
     path: user.path,
-  }
-}
+  };
+};

package/src/client/api/connectClient.ts

@@ -1,12 +1,14 @@
-import { disconnectClient } from '~/client/api/disconnectClient'
-import { getDeviceId } from '~/core/device'
-import { proxyMqttEvents, proxyWebsocketEvents } from '~/core/events'
+/* eslint-disable no-param-reassign */
+/* eslint-disable require-atomic-updates */
+import { disconnectClient } from '~/client/api/disconnectClient';
+import { getDeviceId } from '~/core/device';
+import { proxyWebsocketEvents } from '~/core/events';
 
-import { getActiveClient } from './activeClient'
-import { setActiveUser } from './activeUser'
+import { getActiveClient } from './activeClient';
+import { setActiveUser } from './activeUser';
 
-import { getToken } from './getToken'
-import { onClientBanned } from '../events'
+import { getToken } from './getToken';
+import { onClientBanned } from '../events';
 
 /**
  * ```js
@@ -28,48 +30,48 @@ import { onClientBanned } from '../events'
  * @async
  */
 export const connectClient = 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'];
 }): Promise<boolean> => {
-  const client = getActiveClient()
-  client.log('client/api/connectClient', {apiKey: client.apiKey, ...params})
+  const client = getActiveClient();
+  client.log('client/api/connectClient', { apiKey: client.apiKey, ...params });
 
   // default values
-  params.displayName ??= params.userId
-  params.deviceId ??= getDeviceId()
+  params.displayName ??= params.userId;
+  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)
+  const { accessToken, users } = await getToken(params);
 
   // manually setup the token for http transport
-  client.http.defaults.headers.common['Authorization'] = `Bearer ${accessToken}`
+  client.http.defaults.headers.common.Authorization = `Bearer ${accessToken}`;
 
   // manually setup the token for ws transport
-  client.ws.io.opts.query = {token: accessToken}
+  client.ws.io.opts.query = { token: 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)
+  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.ws.once('connect', resolve);
+    client.ws.open();
+  });
 
   const unsubscribe = onClientBanned(() => {
-    disconnectClient()
-    unsubscribe()
-  })
+    disconnectClient();
+    unsubscribe();
+  });
 
-  client.userId = params.userId
-  client.accessToken = accessToken
+  client.userId = params.userId;
+  client.accessToken = accessToken;
 
-  setActiveUser(users[0])
+  setActiveUser(users[0]);
 
-  return client.ws.connected
-}
+  return client.ws.connected;
+};

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);
 }