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

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';

package/src/comment/api/queryComments.ts

@@ -1,14 +1,9 @@
-import { getActiveClient } from '~/client/api'
-
-import {
-  sortBySegmentNumber,
-  toPage,
-  toToken,
-} from '~/core/query'
-import { pullFromCache, pushToCache } from '~/cache/api'
-import { ingestInCache } from '~/cache/api/ingestInCache'
-import { getResolver } from '~/core/model'
+import { getActiveClient } from '~/client/api';
 
+import { toPage, toToken } from '~/core/query';
+import { pullFromCache, pushToCache } from '~/cache/api';
+import { ingestInCache } from '~/cache/api/ingestInCache';
+import { getResolver } from '~/core/model';
 
 /**
  * ```js
@@ -25,52 +20,59 @@ import { getResolver } from '~/core/model'
  * @async
  */
 export const queryComments = async (query: {
-  referenceType: Amity.Comment['referenceType'],
-  referenceId: Amity.Comment['referenceId'],
-  parentId?: Amity.Comment['commentId'] | null
-  hasFlag?: boolean
-  isDeleted?: Amity.Comment['isDeleted']
-  page?: Amity.Page
+  referenceType: Amity.Comment['referenceType'];
+  referenceId: Amity.Comment['referenceId'];
+  parentId?: Amity.Comment['commentId'] | null;
+  hasFlag?: boolean;
+  isDeleted?: Amity.Comment['isDeleted'];
+  page?: Amity.Page;
 }): Promise<Amity.Cached<Amity.Paged<Amity.Comment>>> => {
-  const client = getActiveClient()
-  client.log('comment/queryComments', query)
+  const client = getActiveClient();
+  client.log('comment/queryComments', query);
 
-  const { page = { limit: 10 }, ...params } = query
+  const { page = { limit: 10 }, ...params } = query;
 
   // const filterByParentId = query.parentId !== undefined
 
   // API-FIX: parameters should be querystring. (1)
   // API-FIX: backend should answer Amity.Response (2)
   // const { data } = await client.http.get<Amity.Response<Amity.PagedResponse<Amity.CommentPayload>>>(
-  const { data } = await client.http.get<Amity.CommentPayload & Amity.Pagination>(`/api/v3/comments`, {
-    params: {
-      ...params,
-      //      filterByParentId, API-FIX: backend does not support this boolean LOL. what the hell seriously.
-      options: {
-        token: toToken(page, 'afterbefore'),
+  const { data } = await client.http.get<Amity.CommentPayload & Amity.Pagination>(
+    `/api/v3/comments`,
+    {
+      params: {
+        ...params,
+        //      filterByParentId, API-FIX: backend does not support this boolean LOL. what the hell seriously.
+        options: {
+          token: toToken(page, 'afterbefore'),
+        },
       },
     },
-  })
+  );
 
   // API-FIX: backend should answer Amity.Response (2)
   // const { paging, comments } = unwrapPayload(data)
-  const { paging, ...payload } = data
-  const { comments } = payload
+  const { paging, ...payload } = data;
+  const { comments } = payload;
 
-  const cachedAt = client.cache && Date.now()
+  const cachedAt = client.cache && Date.now();
 
   if (client.cache) {
-    ingestInCache(payload as Amity.CommentPayload, { cachedAt })
-
-    const cacheKey = ['comment', 'query', { ...params, options: { ...page } } as Amity.Serializable]
-    pushToCache(cacheKey, { comments: comments.map(getResolver('comment')), paging })
+    ingestInCache(payload as Amity.CommentPayload, { cachedAt });
+
+    const cacheKey = [
+      'comment',
+      'query',
+      { ...params, options: { ...page } } as Amity.Serializable,
+    ];
+    pushToCache(cacheKey, { comments: comments.map(getResolver('comment')), paging });
   }
 
-  const nextPage = toPage(paging.next)
-  const prevPage = toPage(paging.previous)
+  const nextPage = toPage(paging.next);
+  const prevPage = toPage(paging.previous);
 
-  return { data: comments, cachedAt, prevPage, nextPage }
-}
+  return { data: comments, cachedAt, prevPage, nextPage };
+};
 
 /**
  * ```js
@@ -88,28 +90,29 @@ export const queryComments = async (query: {
 queryComments.locally = (
   query: Parameters<typeof queryComments>[0],
 ): Amity.Cached<Amity.Paged<Amity.Comment>> | undefined => {
-  const client = getActiveClient()
-  client.log('comment/queryComments.locally', query)
+  const client = getActiveClient();
+  client.log('comment/queryComments.locally', query);
 
-  if (!client.cache) return
+  if (!client.cache) return;
 
-  const { page = { limit: 10 }, ...params } = query
+  const { page = { limit: 10 }, ...params } = query;
 
-  const queryKey = ['comment', 'query', { ...params, options: { ...page }} as Amity.Serializable];
-  const { data, cachedAt } = pullFromCache<{comments: Pick<Amity.Comment, 'commentId'>[]} & Amity.Pagination>(queryKey) ?? {}
+  const queryKey = ['comment', 'query', { ...params, options: { ...page } } as Amity.Serializable];
+  const { data, cachedAt } =
+    pullFromCache<{ comments: Pick<Amity.Comment, 'commentId'>[] } & Amity.Pagination>(queryKey) ??
+    {};
 
-  if (!data?.comments.length)
-    return
+  if (!data?.comments.length) return;
 
   const comments: Amity.Comment[] = data.comments
     .map(commentId => pullFromCache<Amity.Comment>(['comment', 'get', commentId])!)
     .filter(Boolean)
-    .map(({ data }) => data)
+    .map(({ data }) => data);
 
-  const prevPage = toPage(data?.paging.previous)
-  const nextPage = toPage(data?.paging.next)
+  const prevPage = toPage(data?.paging.previous);
+  const nextPage = toPage(data?.paging.next);
 
   return comments.length === data?.comments?.length
     ? { data: comments, cachedAt, prevPage, nextPage }
-    : undefined
-}
+    : undefined;
+};

package/src/comment/api/updateComment.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
@@ -24,21 +24,22 @@ export const updateComment = async (
   commentId: Amity.Comment['commentId'],
   patch: Patch<Amity.Comment, 'data' | 'metadata' | 'mentionees'>,
 ): Promise<Amity.Cached<Amity.Comment>> => {
-  const client = getActiveClient()
-  client.log('user/updateComment', patch)
+  const client = getActiveClient();
+  client.log('user/updateComment', patch);
 
   const { data } = await client.http.put<Amity.CommentPayload>(
-    `/api/v3/comments/${encodeURIComponent(commentId)}`, patch,
-  )
+    `/api/v3/comments/${encodeURIComponent(commentId)}`,
+    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 });
 
-  fireEvent('comment.updated', data)
+  fireEvent('comment.updated', data);
 
-  const { comments } = data
+  const { comments } = data;
   return {
     data: comments.find(comment => comment.commentId === commentId)!,
     cachedAt,
-  }
-}
+  };
+};

package/src/comment/events/index.ts

@@ -1,9 +1,9 @@
-export * from './onCommentCreated'
-export * from './onCommentUpdated'
-export * from './onCommentDeleted'
+export * from './onCommentCreated';
+export * from './onCommentUpdated';
+export * from './onCommentDeleted';
 
-export * from './onCommentFlagged'
-export * from './onCommentUnflagged'
+export * from './onCommentFlagged';
+export * from './onCommentUnflagged';
 
-export * from './onCommentReactionAdded'
-export * from './onCommentReactionRemoved'
+export * from './onCommentReactionAdded';
+export * from './onCommentReactionRemoved';

package/src/comment/events/onCommentCreated.ts

@@ -1,4 +1,4 @@
-import { createCommentEventSubscriber } from './utils'
+import { createCommentEventSubscriber } from './utils';
 
 /**
  * ```js
@@ -15,7 +15,5 @@ import { createCommentEventSubscriber } from './utils'
  *
  * @category Comment Events
  */
-export const onCommentCreated = (
-  callback: Amity.Listener<Amity.Comment>
-): Amity.Unsubscriber =>
-  createCommentEventSubscriber('comment.created', callback)
+export const onCommentCreated = (callback: Amity.Listener<Amity.Comment>): Amity.Unsubscriber =>
+  createCommentEventSubscriber('comment.created', callback);

package/src/comment/events/onCommentDeleted.ts

@@ -1,4 +1,4 @@
-import { createCommentEventSubscriber } from './utils'
+import { createCommentEventSubscriber } from './utils';
 
 /**
  * ```js
@@ -15,7 +15,5 @@ import { createCommentEventSubscriber } from './utils'
  *
  * @category Comment Events
  */
-export const onCommentDeleted = (
-  callback: Amity.Listener<Amity.Comment>
-): Amity.Unsubscriber =>
-  createCommentEventSubscriber('comment.deleted', callback)
+export const onCommentDeleted = (callback: Amity.Listener<Amity.Comment>): Amity.Unsubscriber =>
+  createCommentEventSubscriber('comment.deleted', callback);

package/src/comment/events/onCommentFlagged.ts

@@ -1,4 +1,4 @@
-import { createCommentEventSubscriber } from './utils'
+import { createCommentEventSubscriber } from './utils';
 
 /**
  * ```js
@@ -15,7 +15,5 @@ import { createCommentEventSubscriber } from './utils'
  *
  * @category Comment Events
  */
-export const onCommentFlagged = (
-  callback: Amity.Listener<Amity.Comment>
-): Amity.Unsubscriber =>
-  createCommentEventSubscriber('comment.flagged', callback)
+export const onCommentFlagged = (callback: Amity.Listener<Amity.Comment>): Amity.Unsubscriber =>
+  createCommentEventSubscriber('comment.flagged', callback);

package/src/comment/events/onCommentReactionAdded.ts

@@ -1,8 +1,8 @@
-import { getActiveClient } from '~/client/api'
-import { pullFromCache } from '~/cache/api'
-import { ingestInCache } from '~/cache/api/ingestInCache'
-import { createEventSubscriber } from '~/core/events'
-import { preparePayloadForCache } from '~/reaction/utils'
+import { getActiveClient } from '~/client/api';
+import { pullFromCache } from '~/cache/api';
+import { ingestInCache } from '~/cache/api/ingestInCache';
+import { createEventSubscriber } from '~/core/events';
+import { preparePayloadForCache } from '~/reaction/utils';
 
 /**
  * ```js
@@ -20,29 +20,29 @@ import { preparePayloadForCache } from '~/reaction/utils'
  * @category Comment Events
  */
 export const onCommentReactionAdded = (
-  callback: Amity.Listener<Amity.Comment>
+  callback: Amity.Listener<Amity.Comment>,
 ): Amity.Unsubscriber => {
-  const client = getActiveClient()
+  const client = getActiveClient();
 
   const filter = (payload: Amity.CommentPayload & { reactor: Amity.Reaction }) => {
     if (!client.cache) {
-      callback(payload.comments[0])
+      callback(payload.comments[0]);
     } else {
-      preparePayloadForCache('comment.addReaction', payload)
+      preparePayloadForCache('comment.addReaction', payload);
+      // eslint-disable-next-line @typescript-eslint/no-unused-vars
       const { reactor, ...commentPayload } = payload;
 
-      ingestInCache(commentPayload as Amity.CommentPayload)
+      ingestInCache(commentPayload as Amity.CommentPayload);
 
-      const comment = pullFromCache<Amity.Comment>(['comment', 'get', payload.comments[0].commentId])!
+      const comment = pullFromCache<Amity.Comment>([
+        'comment',
+        'get',
+        payload.comments[0].commentId,
+      ])!;
 
-      callback(comment.data)
+      callback(comment.data);
     }
-  }
+  };
 
-  return createEventSubscriber(
-    client,
-    'comment.addReaction',
-    'comment.addReaction',
-    filter
-  )
-}
+  return createEventSubscriber(client, 'comment.addReaction', 'comment.addReaction', filter);
+};