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

package/src/channel/api/getChannel.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,24 +20,24 @@ import { ingestInCache } from '~/cache/api/ingestInCache'
 export const getChannel = async (
   channelId: Amity.Channel['channelId'],
 ): Promise<Amity.Cached<Amity.Channel>> => {
-  const client = getActiveClient()
-  client.log('channel/getChannel', channelId)
+  const client = getActiveClient();
+  client.log('channel/getChannel', channelId);
 
   // API-FIX: endpoint should not be /list, parameters should be querystring.
   const { data } = await client.http.get<Amity.ChannelPayload>(
     `/api/v3/channels/${encodeURIComponent(channelId)}`,
-  )
+  );
 
-  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 { channels } = data
+  const { channels } = data;
 
   return {
     data: channels.find(channel => channel.channelId === channelId)!,
     cachedAt,
-  }
-}
+  };
+};
 
 /**
  * ```js
@@ -55,18 +55,17 @@ export const getChannel = async (
 getChannel.locally = (
   channelId: Amity.Channel['channelId'],
 ): Amity.Cached<Amity.Channel> | undefined => {
-  const client = getActiveClient()
-  client.log('channel/getChannel.locally', channelId)
+  const client = getActiveClient();
+  client.log('channel/getChannel.locally', channelId);
 
-  if (!client.cache) return
+  if (!client.cache) return;
 
-  const cached = pullFromCache<Amity.Channel>(['channel', 'get', channelId])
+  const cached = pullFromCache<Amity.Channel>(['channel', 'get', channelId]);
 
-  if (!cached)
-    return
+  if (!cached) return;
 
   return {
     data: cached.data,
     cachedAt: cached.cachedAt,
-  }
-}
+  };
+};

package/src/channel/api/getChannels.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 getChannels = async (
   channelIds: Amity.Channel['channelId'][],
 ): Promise<Amity.Cached<Amity.Channel[]>> => {
-  const client = getActiveClient()
-  client.log('channel/getChannels', channelIds)
+  const client = getActiveClient();
+  client.log('channel/getChannels', channelIds);
 
   const encodedChannelIds = channelIds.map(channelId => encodeURIComponent(channelId));
 
   // API-FIX: endpoint should not be /list, parameters should be querystring.
-  const { data } = await client.http.get<Amity.ChannelPayload>(
-    `/api/v3/channels/list`,
-    { params: { channelIds: encodedChannelIds } },
-  )
+  const { data } = await client.http.get<Amity.ChannelPayload>(`/api/v3/channels/list`, {
+    params: { channelIds: encodedChannelIds },
+  });
 
-  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.channels,
-    cachedAt
-  }
-}
+    cachedAt,
+  };
+};
 
 /**
  * ```js
@@ -56,23 +55,22 @@ export const getChannels = async (
 getChannels.locally = (
   channelIds: Amity.Channel['channelId'][],
 ): Amity.Cached<Amity.Channel[]> | undefined => {
-  const client = getActiveClient()
-  client.log('channel/getChannels.locally', channelIds)
+  const client = getActiveClient();
+  client.log('channel/getChannels.locally', channelIds);
 
-  if (!client.cache) return
+  if (!client.cache) return;
 
   const cached = channelIds
     .map(channelId => pullFromCache<Amity.Channel>(['channel', 'get', channelId])!)
-    .filter(Boolean)
+    .filter(Boolean);
 
-  const channels = cached.map(({ data }) => data)
-  const oldest = cached.sort((a, b) => a.cachedAt! < b.cachedAt! ? -1 : 1)?.[0]
+  const channels = cached.map(({ data }) => data);
+  const oldest = cached.sort((a, b) => (a.cachedAt! < b.cachedAt! ? -1 : 1))?.[0];
 
-  if (cached?.length < channelIds.length)
-    return
+  if (cached?.length < channelIds.length) return;
 
   return {
     data: channels,
     cachedAt: oldest.cachedAt,
-  }
-}
+  };
+};

package/src/channel/api/index.ts

@@ -1,18 +1,18 @@
-export * from './queryChannels'
-export * from './getChannels'
-export * from './getChannel'
+export * from './queryChannels';
+export * from './getChannels';
+export * from './getChannel';
 
-export * from './createChannel'
-export * from './updateChannel'
-export * from './deleteChannel'
+export * from './createChannel';
+export * from './updateChannel';
+export * from './deleteChannel';
 
-export * from './joinChannel'
-export * from './leaveChannel'
+export * from './joinChannel';
+export * from './leaveChannel';
 
-export * from './queryChannelMembers'
+export * from './queryChannelMembers';
 
-export * from './addChannelMembers'
-export * from './removeChannelMembers'
+export * from './addChannelMembers';
+export * from './removeChannelMembers';
 
-export * from './addChannelMembersRole'
-export * from './removeChannelMembersRole'
+export * from './addChannelMembersRole';
+export * from './removeChannelMembersRole';

package/src/channel/api/joinChannel.ts

@@ -1,6 +1,6 @@
-import { getActiveClient } from '~/client/api'
+import { getActiveClient } from '~/client/api';
 
-import { ingestInCache } from '~/cache/api/ingestInCache'
+import { ingestInCache } from '~/cache/api/ingestInCache';
 
 /**
  * ```js
@@ -16,22 +16,19 @@ import { ingestInCache } from '~/cache/api/ingestInCache'
  * @category Channel API
  * @async
  */
-export const joinChannel = async (
-  channelId: Amity.Channel['channelId']
-): Promise<boolean> => {
-  const client = getActiveClient()
-  client.log('channel/joinChannel', channelId)
+export const joinChannel = async (channelId: Amity.Channel['channelId']): Promise<boolean> => {
+  const client = getActiveClient();
+  client.log('channel/joinChannel', channelId);
 
   const { data } = await client.http.post<Amity.ChannelMembershipPayload>(
     `/api/v3/channels/${encodeURIComponent(channelId)}/join`,
-  )
+  );
 
-  if (client.cache) ingestInCache(data)
+  if (client.cache) ingestInCache(data);
 
-  const { channelUsers } = data
+  const { channelUsers } = data;
 
-  return !!channelUsers.find(channelUser => (
-    channelUser.channelId === channelId
-    && channelUser.membership === 'member'
-  ))
-}
+  return !!channelUsers.find(
+    channelUser => channelUser.channelId === channelId && channelUser.membership === 'member',
+  );
+};

package/src/channel/api/leaveChannel.ts

@@ -1,6 +1,6 @@
-import { getActiveClient } from '~/client/api'
+import { getActiveClient } from '~/client/api';
 
-import { ingestInCache } from '~/cache/api/ingestInCache'
+import { ingestInCache } from '~/cache/api/ingestInCache';
 
 /**
  * ```js
@@ -16,22 +16,19 @@ import { ingestInCache } from '~/cache/api/ingestInCache'
  * @category Channel API
  * @async
  */
-export const leaveChannel = async (
-  channelId: Amity.Channel['channelId']
-): Promise<boolean> => {
-  const client = getActiveClient()
-  client.log('channel/leaveChannel', channelId)
+export const leaveChannel = async (channelId: Amity.Channel['channelId']): Promise<boolean> => {
+  const client = getActiveClient();
+  client.log('channel/leaveChannel', channelId);
 
   const { data } = await client.http.delete<Amity.ChannelMembershipPayload>(
     `/api/v3/channels/${encodeURIComponent(channelId)}/leave`,
-  )
+  );
 
-  if (client.cache) ingestInCache(data)
+  if (client.cache) ingestInCache(data);
 
-  const { channelUsers } = data
+  const { channelUsers } = data;
 
-  return !!channelUsers.find(channelUser => (
-    channelUser.channelId === channelId
-    && channelUser.membership !== 'member'
-  ))
-}
+  return !!channelUsers.find(
+    channelUser => channelUser.channelId === channelId && channelUser.membership !== 'member',
+  );
+};

package/src/channel/api/queryChannelMembers.ts

@@ -1,7 +1,7 @@
-import { getActiveClient } from '~/client/api'
+import { getActiveClient } from '~/client/api';
 
-import { toPage, toToken } from '~/core/query'
-import { ingestInCache } from '~/cache/api/ingestInCache'
+import { toPage, toToken } from '~/core/query';
+import { ingestInCache } from '~/cache/api/ingestInCache';
 
 /**
  * ```js
@@ -16,44 +16,45 @@ import { ingestInCache } from '~/cache/api/ingestInCache'
  *
  * @category Channel API
  * @async
- **/
+ * */
 export const queryChannelMembers = async (query: {
-  channelId: string
-  membership?: 'all' | 'muted' | 'banned' | 'member&banned'
-  roles?: string[]
-  sortBy?: 'firstCreated' | 'lastCreated'
-  page?: Amity.Page
-}): Promise<Amity.Cached<Amity.Paged<Amity.Membership<"channel">>>> => {
-  const client = getActiveClient()
-  client.log('channel/queryChannelMembers', query)
+  channelId: string;
+  membership?: 'all' | 'muted' | 'banned' | 'member&banned';
+  roles?: string[];
+  sortBy?: 'firstCreated' | 'lastCreated';
+  page?: Amity.Page;
+}): Promise<Amity.Cached<Amity.Paged<Amity.Membership<'channel'>>>> => {
+  const client = getActiveClient();
+  client.log('channel/queryChannelMembers', query);
 
-  const { page, channelId, membership, ...params } = query ?? {}
+  const { page, channelId, membership, ...params } = query ?? {};
 
-  const { data } = await client.http.get<
-    Amity.ChannelMembershipPayload & Amity.Pagination
-  >(`/api/v3/channels/${encodeURIComponent(channelId)}/users`, {
-    params: {
-      ...params,
-      filter: membership,
-      options: {
-        token: toToken(page, 'skiplimit'),
+  const { data } = await client.http.get<Amity.ChannelMembershipPayload & Amity.Pagination>(
+    `/api/v3/channels/${encodeURIComponent(channelId)}/users`,
+    {
+      params: {
+        ...params,
+        filter: membership,
+        options: {
+          token: toToken(page, 'skiplimit'),
+        },
       },
     },
-  })
+  );
 
-  const { paging, ...payload } = data
-  const { channelUsers } = payload
+  const { paging, ...payload } = data;
+  const { channelUsers } = payload;
 
-  const cachedAt = client.cache && Date.now()
+  const cachedAt = client.cache && Date.now();
   if (client.cache) {
-    ingestInCache(payload as Amity.ChannelMembershipPayload)
+    ingestInCache(payload as Amity.ChannelMembershipPayload);
   }
 
-  const nextPage = toPage(paging.next)
-  const prevPage = toPage(paging.previous)
+  const nextPage = toPage(paging.next);
+  const prevPage = toPage(paging.previous);
 
-  return { data: channelUsers, cachedAt, nextPage, prevPage }
-}
+  return { data: channelUsers, cachedAt, nextPage, prevPage };
+};
 
 /**
  * ```js
@@ -68,11 +69,9 @@ export const queryChannelMembers = async (query: {
  *
  * @category Post API
  */
-queryChannelMembers.locally = (
-  query: Parameters<typeof queryChannelMembers>[0]
-) => {
-  const client = getActiveClient()
-  client.log('channel/queryChannelMembers', query)
+queryChannelMembers.locally = (query: Parameters<typeof queryChannelMembers>[0]) => {
+  const client = getActiveClient();
+  client.log('channel/queryChannelMembers', query);
 
   // TODO
-}
+};

package/src/channel/api/queryChannels.ts

@@ -1,9 +1,9 @@
-import { getActiveClient } from '~/client/api'
+import { getActiveClient } from '~/client/api';
 
-import { toPage, toToken } from '~/core/query'
-import { pushToCache } from '~/cache/api'
-import { ingestInCache } from '~/cache/api/ingestInCache'
-import { getResolver } from '~/core/model'
+import { toPage, toToken } from '~/core/query';
+import { pushToCache } from '~/cache/api';
+import { ingestInCache } from '~/cache/api/ingestInCache';
+import { getResolver } from '~/core/model';
 
 /**
  * ```js
@@ -20,57 +20,57 @@ import { getResolver } from '~/core/model'
  * @category Channel API
  * @async
  */
-export const queryChannels = async (
-  query?: {
-    displayName?: string
-    membership?: 'all' | 'member' | 'notMember'
-    sortBy?: ('displayName' | 'firstCreated' | 'lastCreated')
-    types?: Amity.ChannelType
-    page?: Amity.Page
-  }
-): Promise<Amity.Cached<Amity.Paged<Amity.Channel>>> => {
-  const client = getActiveClient()
-  client.log('channel/queryChannels', query)
+export const queryChannels = async (query?: {
+  displayName?: string;
+  membership?: 'all' | 'member' | 'notMember';
+  sortBy?: 'displayName' | 'firstCreated' | 'lastCreated';
+  types?: Amity.ChannelType;
+  page?: Amity.Page;
+}): Promise<Amity.Cached<Amity.Paged<Amity.Channel>>> => {
+  const client = getActiveClient();
+  client.log('channel/queryChannels', query);
 
   // safe decapsulation
-  const {
-    page = { limit: 10 },
-    displayName,
-    membership,
-    ...params
-  } = query ?? {}
+  const { page = { limit: 10 }, displayName, membership, ...params } = query ?? {};
 
   // API-FIX: parameters should be querystring.
   // API-FIX: backend doesnt answer Amity.Response
   // const { data } = await client.http.get<Amity.Response<Amity.Paged<ChannelPayload>>>(
   const { data } = await client.http.get<Amity.ChannelPayload & Amity.Pagination>(
-    `/api/v3/channels`, { params: {
-      ...params,
-      keyword: displayName,
-      filter: membership,
-      options: {
-        token: toToken(page, 'skiplimit'),
+    `/api/v3/channels`,
+    {
+      params: {
+        ...params,
+        keyword: displayName,
+        filter: membership,
+        options: {
+          token: toToken(page, 'skiplimit'),
+        },
       },
-    } }
-  )
+    },
+  );
 
-  const { paging, ...payload } = data
-  const { channels } = payload
+  const { paging, ...payload } = data;
+  const { channels } = payload;
 
-  const cachedAt = client.cache && Date.now()
+  const cachedAt = client.cache && Date.now();
 
   if (client.cache) {
-    ingestInCache(payload as Amity.ChannelPayload, { cachedAt })
+    ingestInCache(payload as Amity.ChannelPayload, { cachedAt });
 
-    const cacheKey = ['channel', 'query', { ...params, options: { ...page } } as Amity.Serializable]
-    pushToCache(cacheKey, { channels: channels.map(getResolver('channel')), paging })
+    const cacheKey = [
+      'channel',
+      'query',
+      { ...params, options: { ...page } } as Amity.Serializable,
+    ];
+    pushToCache(cacheKey, { channels: channels.map(getResolver('channel')), paging });
   }
 
-  const nextPage = toPage(paging.next)
-  const prevPage = toPage(paging.previous)
+  const nextPage = toPage(paging.next);
+  const prevPage = toPage(paging.previous);
 
-  return { data: channels, cachedAt, prevPage, nextPage }
-}
+  return { data: channels, cachedAt, prevPage, nextPage };
+};
 
 /**
  * ```js
@@ -85,12 +85,9 @@ export const queryChannels = async (
  *
  * @category Channel API
  */
-queryChannels.locally = (
-  query: Parameters<typeof queryChannels>[0],
-) => {
-  const client = getActiveClient()
-  client.log('channel/queryChannels.locally', query)
+queryChannels.locally = (query: Parameters<typeof queryChannels>[0]) => {
+  const client = getActiveClient();
+  client.log('channel/queryChannels.locally', query);
 
   // TODO
-
-}
+};

package/src/channel/api/removeChannelMembers.ts

@@ -1,7 +1,7 @@
-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';
 
 /**
  * ```js
@@ -20,25 +20,24 @@ import { fireEvent } from '~/core/events'
  */
 export const removeChannelMembers = async (
   channelId: Amity.Channel['channelId'],
-  userIds: Amity.User['userId'][]
+  userIds: Amity.User['userId'][],
 ): Promise<boolean> => {
-  const client = getActiveClient()
-  client.log('channel/removeChannelMembers', channelId, userIds)
+  const client = getActiveClient();
+  client.log('channel/removeChannelMembers', channelId, userIds);
 
   const { data } = await client.http.delete<Amity.ChannelMembershipPayload>(
     `/api/v3/channels/${encodeURIComponent(channelId)}/users`,
-    { data: { channelId, userIds } }
-  )
+    { data: { channelId, userIds } },
+  );
 
-  if (client.cache) ingestInCache(data)
+  if (client.cache) ingestInCache(data);
 
   fireEvent('v3.channel.didRemoveUsers', {
     channels: data.channels!,
-  })
+  });
 
-  const { channelUsers } = data
+  const { channelUsers } = data;
   return !!channelUsers.find(
-    channelUser =>
-      channelUser.channelId === channelId && channelUser.membership !== 'member'
-  )
-}
+    channelUser => channelUser.channelId === channelId && channelUser.membership !== 'member',
+  );
+};

package/src/channel/api/removeChannelMembersRole.ts

@@ -1,6 +1,6 @@
-import { getActiveClient } from '~/client/api'
+import { getActiveClient } from '~/client/api';
 
-import { ingestInCache } from '~/cache/api/ingestInCache'
+import { ingestInCache } from '~/cache/api/ingestInCache';
 
 /**
  * ```js
@@ -21,21 +21,20 @@ import { ingestInCache } from '~/cache/api/ingestInCache'
 export const removeChannelMembersRole = async (
   channelId: Amity.Channel['channelId'],
   roleId: Amity.Role['roleId'],
-  userIds: Amity.User['userId'][]
+  userIds: Amity.User['userId'][],
 ): Promise<boolean> => {
-  const client = getActiveClient()
-  client.log('channel/removeChannelMembersRole', channelId, roleId, userIds)
+  const client = getActiveClient();
+  client.log('channel/removeChannelMembersRole', channelId, roleId, userIds);
 
   const { data } = await client.http.delete<Amity.ChannelMembershipPayload>(
     `/api/v3/channels/${encodeURIComponent(channelId)}/users/roles`,
-    { data: { channelId, role: roleId, userIds } }
-  )
+    { data: { channelId, role: roleId, userIds } },
+  );
 
-  if (client.cache) ingestInCache(data)
+  if (client.cache) ingestInCache(data);
 
-  const { channelUsers } = data
+  const { channelUsers } = data;
   return !!channelUsers.find(
-    channelUser =>
-      channelUser.channelId === channelId && !channelUser.roles.includes(roleId)
-  )
-}
+    channelUser => channelUser.channelId === channelId && !channelUser.roles.includes(roleId),
+  );
+};

package/src/channel/api/updateChannel.ts

@@ -1,6 +1,6 @@
-import { getActiveClient } from '~/client/api'
+import { getActiveClient } from '~/client/api';
 
-import { ingestInCache } from '~/cache/api/ingestInCache'
+import { ingestInCache } from '~/cache/api/ingestInCache';
 
 /**
  * ```js
@@ -21,20 +21,21 @@ export const updateChannel = async (
   channelId: Amity.Channel['channelId'],
   patch: Patch<Amity.Channel, 'displayName' | 'description' | 'avatarFileId' | 'metadata'>,
 ): Promise<Amity.Cached<Amity.Channel>> => {
-  const client = getActiveClient()
-  client.log('channel/updateChannel', channelId, patch)
+  const client = getActiveClient();
+  client.log('channel/updateChannel', channelId, patch);
 
   const { data } = await client.http.put<Amity.ChannelPayload>(
-    `/api/v3/channels/${encodeURIComponent(channelId)}`, patch,
-  )
+    `/api/v3/channels/${encodeURIComponent(channelId)}`,
+    patch,
+  );
 
-  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 { channels } = data
+  const { channels } = data;
 
   return {
     data: channels.find(channel => channel.channelId === channelId)!,
     cachedAt,
-  }
-}
+  };
+};

package/src/channel/events/index.ts

@@ -1,6 +1,6 @@
-export * from './onChannelUpdated'
-export * from './onChannelDeleted'
-export * from './onChannelJoined'
-export * from './onChannelLeft'
-export * from './onMemberAdded'
-export * from './onMemberRemoved'
+export * from './onChannelUpdated';
+export * from './onChannelDeleted';
+export * from './onChannelJoined';
+export * from './onChannelLeft';
+export * from './onMemberAdded';
+export * from './onMemberRemoved';