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

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

package/src/comment/events/onCommentReactionRemoved.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 onCommentReactionRemoved = (
-  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.removeReaction', payload)
+      preparePayloadForCache('comment.removeReaction', 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.removeReaction',
-    'comment.removeReaction',
-    filter
-  )
-}
+  return createEventSubscriber(client, 'comment.removeReaction', 'comment.removeReaction', filter);
+};

package/src/comment/events/onCommentUnflagged.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 onCommentUnflagged = (
-  callback: Amity.Listener<Amity.Comment>
-): Amity.Unsubscriber =>
-  createCommentEventSubscriber('comment.unflagged', callback)
+export const onCommentUnflagged = (callback: Amity.Listener<Amity.Comment>): Amity.Unsubscriber =>
+  createCommentEventSubscriber('comment.unflagged', callback);

package/src/comment/events/onCommentUpdated.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 onCommentUpdated = (
-  callback: Amity.Listener<Amity.Comment>
-): Amity.Unsubscriber =>
-  createCommentEventSubscriber('comment.updated', callback)
+export const onCommentUpdated = (callback: Amity.Listener<Amity.Comment>): Amity.Unsubscriber =>
+  createCommentEventSubscriber('comment.updated', callback);

package/src/comment/events/utils.ts

@@ -1,39 +1,38 @@
-import { getActiveClient } from '~/client/api'
-import { createEventSubscriber } from '~/core/events'
-import { queryCache, upsertInCache, pullFromCache } from '~/cache/api'
-import { ingestInCache } from '~/cache/api/ingestInCache'
+import { getActiveClient } from '~/client/api';
+import { createEventSubscriber } from '~/core/events';
+import { queryCache, upsertInCache, pullFromCache } from '~/cache/api';
+import { ingestInCache } from '~/cache/api/ingestInCache';
 
 export const createCommentEventSubscriber = (
   event: keyof Amity.MqttCommentMessageEvents,
-  callback: Amity.Listener<Amity.Comment>
+  callback: Amity.Listener<Amity.Comment>,
 ) => {
-  const client = getActiveClient()
+  const client = getActiveClient();
 
   const filter = (payload: Amity.CommentPayload) => {
     if (!client.cache) {
       // TODO: here we are missing specific properties here!
-      callback(payload.comments[0])
+      callback(payload.comments[0]);
     } else {
-      ingestInCache(payload)
+      ingestInCache(payload);
 
-      const comment = pullFromCache<Amity.Comment>(['comment', 'get', payload.comments[0].commentId])!
+      const comment = pullFromCache<Amity.Comment>([
+        'comment',
+        'get',
+        payload.comments[0].commentId,
+      ])!;
 
       if (['comment.created'].includes(event)) {
         const queries = queryCache(['comment', 'query'])
           // @ts-ignore
-          ?.filter(({key}) => key[2]?.referenceId === comment.data.referenceId);
+          ?.filter(({ key }) => key[2]?.referenceId === comment.data.referenceId);
 
-        queries?.map(({key, data}) => upsertInCache(key, data as any, { cachedAt: -1 }));
+        queries?.map(({ key, data }) => upsertInCache(key, data as any, { cachedAt: -1 }));
       }
 
-      callback(comment.data)
+      callback(comment.data);
     }
-  }
+  };
 
-  return createEventSubscriber(
-    client,
-    event,
-    event,
-    filter
-  )
-}
+  return createEventSubscriber(client, event, event, filter);
+};

package/src/comment/observers/index.ts

@@ -1,2 +1,2 @@
-export * from './observeComments'
-export * from './observeComment'
+export * from './observeComments';
+export * from './observeComment';

package/src/comment/observers/observeComment.ts

@@ -1,8 +1,8 @@
-import { getActiveClient } from '~/client/api'
+import { getActiveClient } from '~/client/api';
 
-import { createQuery, runQuery, queryOptions } from '~/core/query'
+import { createQuery, runQuery, queryOptions } from '~/core/query';
 
-import { getComment } from '../api'
+import { getComment } from '../api';
 
 import {
   onCommentUpdated,
@@ -11,8 +11,7 @@ import {
   onCommentUnflagged,
   onCommentReactionAdded,
   onCommentReactionRemoved,
-} from '../events'
-
+} from '../events';
 
 /**
  * ```js
@@ -30,56 +29,68 @@ import {
  *
  * @category Comment Observer
  */
-export const observeComment = <Events extends ['onFetch', 'onUpdate', 'onDelete', 'onFlagged', 'onUnflagged', 'onReactionAdded', 'onReactionRemoved']>(
+export const observeComment = <
+  Events extends [
+    'onFetch',
+    'onUpdate',
+    'onDelete',
+    'onFlagged',
+    'onUnflagged',
+    'onReactionAdded',
+    'onReactionRemoved',
+  ],
+>(
   commentId: string,
   callback: Amity.ObjectListener<Amity.Snapshot<Amity.Comment | undefined>, Events>,
-  policy: Amity.QueryPolicy = 'cache_then_server'
+  policy: Amity.QueryPolicy = 'cache_then_server',
 ): Amity.Unsubscriber => {
-  const { log } = getActiveClient()
+  const { log } = getActiveClient();
 
-  const timestamp = Date.now()
-  log(`observeComment(tmpid: ${timestamp}) > listen`)
+  const timestamp = Date.now();
+  log(`observeComment(tmpid: ${timestamp}) > listen`);
 
   // wrapper function to make sure
-  const router = (
-    result: Amity.Snapshot<Amity.Comment | undefined>,
-    action: Events[number]
-  ) => {
-    if (callback instanceof Function) return callback(result)
+  const router = (result: Amity.Snapshot<Amity.Comment | undefined>, action: Events[number]) => {
+    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 realtimeRouter = (
-    result: Amity.Snapshot<Amity.Comment>,
-    action: Events[number]
-  ) => {
-    if (result.data?.commentId !== commentId) return
+  const realtimeRouter = (result: Amity.Snapshot<Amity.Comment>, action: Events[number]) => {
+    if (result.data?.commentId !== commentId) return;
 
-    router(result, action)
-  }
+    router(result, action);
+  };
 
-  const disposers: Amity.Unsubscriber[] = []
+  const disposers: Amity.Unsubscriber[] = [];
 
   disposers.push(
     onCommentUpdated(data => realtimeRouter({ data, loading: false, origin: 'event' }, 'onUpdate')),
     onCommentDeleted(data => realtimeRouter({ data, loading: false, origin: 'event' }, 'onDelete')),
-    onCommentFlagged(data => realtimeRouter({ data, loading: false, origin: 'event' }, 'onFlagged')),
-    onCommentUnflagged(data => realtimeRouter({ data, loading: false, origin: 'event' }, 'onUnflagged')),
-    onCommentReactionAdded(data => realtimeRouter({ data, loading: false, origin: 'event' }, 'onReactionAdded')),
-    onCommentReactionRemoved(data => realtimeRouter({ data, loading: false, origin: 'event' }, 'onReactionRemoved')),
-  )
+    onCommentFlagged(data =>
+      realtimeRouter({ data, loading: false, origin: 'event' }, 'onFlagged'),
+    ),
+    onCommentUnflagged(data =>
+      realtimeRouter({ data, loading: false, origin: 'event' }, 'onUnflagged'),
+    ),
+    onCommentReactionAdded(data =>
+      realtimeRouter({ data, loading: false, origin: 'event' }, 'onReactionAdded'),
+    ),
+    onCommentReactionRemoved(data =>
+      realtimeRouter({ data, loading: false, origin: 'event' }, 'onReactionRemoved'),
+    ),
+  );
 
   runQuery(
     createQuery(getComment, commentId),
     result => (result.data || result.error) && router(result, 'onFetch'),
-    queryOptions(policy)
-  )
+    queryOptions(policy),
+  );
 
   return () => {
-    log(`observeComment(tmpid: ${timestamp}) > dispose`)
-    disposers.forEach(fn => fn())
-  }
-}
+    log(`observeComment(tmpid: ${timestamp}) > dispose`);
+    disposers.forEach(fn => fn());
+  };
+};