@amityco/ts-sdk 0.0.1-beta.5 → 0.0.1-beta.9

package/src/comment/events/onCommentCreated.ts

@@ -1,8 +1,4 @@
-import { getActiveClient } from '~/client/api'
-import { createEventSubscriber } from '~/core/events'
-
-import { decoratePayload } from '~/core/query'
-import { ingestInCache } from '~/core/cache'
+import { createCommentEventSubscriber } from './utils'
 
 /**
  * ```js
@@ -12,7 +8,7 @@ import { ingestInCache } from '~/core/cache'
  * })
  * ```
  *
- * Fired when an {@link Amity.Comment} has been created
+ * Fired when {@link Amity.Comment} has been created
  *
  * @param callback The function to call when the event was fired
  * @returns an {@link Amity.Unsubscriber} function to stop listening
@@ -21,19 +17,5 @@ import { ingestInCache } from '~/core/cache'
  */
 export const onCommentCreated = <T extends Amity.CommentContentType>(
   callback: Amity.Listener<Amity.Comment<T>>
-): Amity.Unsubscriber => {
-  const client = getActiveClient()
-
-  const filter = (payload: Amity.CommentPayload<T>) => {
-    decoratePayload(payload)
-    ingestInCache(payload)
-    callback(payload.comments[0])
-  }
-
-  return createEventSubscriber(
-    client,
-    'message/onCommentCreated',
-    'v3.comment.didCreate',
-    filter
-  )
-}
+): Amity.Unsubscriber =>
+  createCommentEventSubscriber('comment.created', callback)

package/src/comment/events/onCommentDeleted.ts

@@ -1,8 +1,4 @@
-import { getActiveClient } from '~/client/api'
-import { createEventSubscriber } from '~/core/events'
-
-import { decoratePayload } from '~/core/query'
-import { ingestInCache } from '~/core/cache'
+import { createCommentEventSubscriber } from './utils'
 
 /**
  * ```js
@@ -12,7 +8,7 @@ import { ingestInCache } from '~/core/cache'
  * })
  * ```
  *
- * Fired when an {@link Amity.Comment} has been deleted
+ * Fired when a {@link Amity.Comment} has been deleted
  *
  * @param callback The function to call when the event was fired
  * @returns an {@link Amity.Unsubscriber} function to stop listening
@@ -21,19 +17,5 @@ import { ingestInCache } from '~/core/cache'
  */
 export const onCommentDeleted = <T extends Amity.CommentContentType>(
   callback: Amity.Listener<Amity.Comment<T>>
-): Amity.Unsubscriber => {
-  const client = getActiveClient()
-
-  const filter = (payload: Amity.CommentPayload<T>) => {
-    decoratePayload(payload)
-    ingestInCache(payload)
-    callback(payload.comments[0])
-  }
-
-  return createEventSubscriber(
-    client,
-    'message/onCommentDeleted',
-    'v3.comment.didDelete',
-    filter
-  )
-}
+): Amity.Unsubscriber =>
+  createCommentEventSubscriber('comment.deleted', callback)

package/src/comment/events/onCommentFlagged.ts

@@ -0,0 +1,21 @@
+import { createCommentEventSubscriber } from './utils'
+
+/**
+ * ```js
+ * import { onCommentFlagged } from '@amityco/ts-sdk'
+ * const dispose = onCommentFlagged(comment => {
+ *   // ...
+ * })
+ * ```
+ *
+ * Fired when a {@link Amity.Comment} has been flagged
+ *
+ * @param callback The function to call when the event was fired
+ * @returns an {@link Amity.Unsubscriber} function to stop listening
+ *
+ * @category Comment Events
+ */
+export const onCommentFlagged = <T extends Amity.CommentContentType>(
+  callback: Amity.Listener<Amity.Comment<T>>
+): Amity.Unsubscriber =>
+  createCommentEventSubscriber('comment.flagged', callback)

package/src/comment/events/onCommentReactionAdded.ts

@@ -0,0 +1,52 @@
+import { getActiveClient } from '~/client/api'
+import { decoratePayload } from '~/core/query'
+import { ingestInCache, pullFromCache } from '~/core/cache'
+import { createEventSubscriber } from '~/core/events'
+import { preparePayloadForCache } from '~/reaction/utils'
+import { isMatch } from '~/core/model'
+
+/**
+ * ```js
+ * import { onCommentReactionAdded } from '@amityco/ts-sdk'
+ * const dispose = onCommentReactionAdded(comment => {
+ *   // ...
+ * })
+ * ```
+ *
+ * Fired when a {@link Amity.Comment} has been reacted
+ *
+ * @param callback The function to call when the event was fired
+ * @returns an {@link Amity.Unsubscriber} function to stop listening
+ *
+ * @category Comment Events
+ */
+export const onCommentReactionAdded = <T extends Amity.CommentContentType>(
+  callback: Amity.Listener<Amity.Comment<T>>
+): Amity.Unsubscriber => {
+  const client = getActiveClient()
+
+  const filter = (payload: Amity.CommentPayload<T> & { reactor: Amity.Reaction }) => {
+    const [cached] = pullFromCache('comment', payload.comments[0].commentId) ?? []
+
+    const { reactor, ...commentPayload } = payload;
+
+    decoratePayload(commentPayload as Amity.CommentPayload<T>)
+    preparePayloadForCache('comment.addReaction', payload)
+    ingestInCache(commentPayload as Amity.CommentPayload<T>)
+
+    const [comment] = pullFromCache('comment', payload.comments[0].commentId) ?? []
+
+    if (cached && isMatch(cached, comment)) {
+      return
+    }
+
+    callback(comment)
+  }
+
+  return createEventSubscriber(
+    client,
+    'comment.addReaction',
+    'comment.addReaction',
+    filter
+  )
+}

package/src/comment/events/onCommentReactionRemoved.ts

@@ -0,0 +1,52 @@
+import { getActiveClient } from '~/client/api'
+import { decoratePayload } from '~/core/query'
+import { ingestInCache, pullFromCache } from '~/core/cache'
+import { createEventSubscriber } from '~/core/events'
+import { preparePayloadForCache } from '~/reaction/utils'
+import { isMatch } from '~/core/model'
+
+/**
+ * ```js
+ * import { onCommentReactionRemoved } from '@amityco/ts-sdk'
+ * const dispose = onCommentReactionRemoved(comment => {
+ *   // ...
+ * })
+ * ```
+ *
+ * Fired when a reaction has been removed from a {@link Amity.Comment}
+ *
+ * @param callback The function to call when the event was fired
+ * @returns an {@link Amity.Unsubscriber} function to stop listening
+ *
+ * @category Comment Events
+ */
+export const onCommentReactionRemoved = <T extends Amity.CommentContentType>(
+  callback: Amity.Listener<Amity.Comment<T>>
+): Amity.Unsubscriber => {
+  const client = getActiveClient()
+
+  const filter = (payload: Amity.CommentPayload<T> & { reactor: Amity.Reaction }) => {
+    const [cached] = pullFromCache('comment', payload.comments[0].commentId) ?? []
+
+    const { reactor, ...commentPayload } = payload;
+
+    decoratePayload(commentPayload as Amity.CommentPayload<T>)
+    preparePayloadForCache('comment.removeReaction', payload)
+    ingestInCache(commentPayload as Amity.CommentPayload<T>)
+
+    const [comment] = pullFromCache('comment', payload.comments[0].commentId) ?? []
+
+    if (cached && isMatch(cached, comment)) {
+      return
+    }
+
+    callback(comment)
+  }
+
+  return createEventSubscriber(
+    client,
+    'comment.removeReaction',
+    'comment.removeReaction',
+    filter
+  )
+}

package/src/comment/events/onCommentUnflagged.ts

@@ -0,0 +1,21 @@
+import { createCommentEventSubscriber } from './utils'
+
+/**
+ * ```js
+ * import { onCommentUnflagged } from '@amityco/ts-sdk'
+ * const dispose = onCommentUnflagged(comment => {
+ *   // ...
+ * })
+ * ```
+ *
+ * Fired when a flag has been removed from a {@link Amity.Comment}
+ *
+ * @param callback The function to call when the event was fired
+ * @returns an {@link Amity.Unsubscriber} function to stop listening
+ *
+ * @category Comment Events
+ */
+export const onCommentUnflagged = <T extends Amity.CommentContentType>(
+  callback: Amity.Listener<Amity.Comment<T>>
+): Amity.Unsubscriber =>
+  createCommentEventSubscriber('comment.unflagged', callback)

package/src/comment/events/onCommentUpdated.ts

@@ -1,8 +1,4 @@
-import { getActiveClient } from '~/client/api'
-import { createEventSubscriber } from '~/core/events'
-
-import { decoratePayload } from '~/core/query'
-import { ingestInCache } from '~/core/cache'
+import { createCommentEventSubscriber } from './utils'
 
 /**
  * ```js
@@ -12,7 +8,7 @@ import { ingestInCache } from '~/core/cache'
  * })
  * ```
  *
- * Fired when an {@link Amity.Comment} has been updated
+ * Fired when a {@link Amity.Comment} has been updated
  *
  * @param callback The function to call when the event was fired
  * @returns an {@link Amity.Unsubscriber} function to stop listening
@@ -21,19 +17,5 @@ import { ingestInCache } from '~/core/cache'
  */
 export const onCommentUpdated = <T extends Amity.CommentContentType>(
   callback: Amity.Listener<Amity.Comment<T>>
-): Amity.Unsubscriber => {
-  const client = getActiveClient()
-
-  const filter = (payload: Amity.CommentPayload<T>) => {
-    decoratePayload(payload)
-    ingestInCache(payload)
-    callback(payload.comments[0])
-  }
-
-  return createEventSubscriber(
-    client,
-    'message/onCommentUpdated',
-    'v3.comment.didUpdate',
-    filter
-  )
-}
+): Amity.Unsubscriber =>
+  createCommentEventSubscriber('comment.updated', callback)

package/src/comment/events/utils.ts

@@ -0,0 +1,34 @@
+import { getActiveClient } from '~/client/api'
+import { decoratePayload } from '~/core/query'
+import { ingestInCache, pullFromCache } from '~/core/cache'
+import { createEventSubscriber } from '~/core/events'
+import { isMatch } from '~/core/model'
+
+export const createCommentEventSubscriber = <T extends Amity.CommentContentType>(
+  event: keyof Amity.MqttCommentMessageEvents,
+  callback: Amity.Listener<Amity.Comment<T>>
+) => {
+  const client = getActiveClient()
+
+  const filter = (payload: Amity.CommentPayload<T>) => {
+    const [cached] = pullFromCache('comment', payload.comments[0].commentId) ?? []
+
+    decoratePayload(payload)
+    ingestInCache(payload)
+
+    const [comment] = pullFromCache('comment', payload.comments[0].commentId) ?? []
+
+    if (cached && isMatch(cached, comment)) {
+      return
+    }
+
+    callback(comment)
+  }
+
+  return createEventSubscriber(
+    client,
+    event,
+    event,
+    filter
+  )
+}

package/src/comment/observers/observeComment.ts

@@ -7,6 +7,10 @@ import { getComment } from '../api'
 import {
   onCommentUpdated,
   onCommentDeleted,
+  onCommentFlagged,
+  onCommentUnflagged,
+  onCommentReactionAdded,
+  onCommentReactionRemoved,
 } from '../events'
 
 
@@ -26,7 +30,7 @@ import {
  *
  * @category Comment Observer
  */
-export const observeComment = <Events extends ['onFetch', 'onUpdate', 'onDelete']>(
+export const observeComment = <Events extends ['onFetch', 'onUpdate', 'onDelete', 'onFlagged', 'onUnflagged', 'onReactionAdded', 'onReactionRemoved']>(
   commentId: string,
   callback: Amity.ObjectListener<Amity.QueryResult<Amity.Comment>, Events>,
   policy: Amity.QueryPolicy = 'cache_then_server',
@@ -41,9 +45,6 @@ export const observeComment = <Events extends ['onFetch', 'onUpdate', 'onDelete'
     result: Amity.QueryResult<Amity.Comment>,
     action: Events[number]
   ) => {
-    // filter function
-    if (result.data?.commentId !== commentId) return
-
     if (callback instanceof Function)
       return callback(result)
 
@@ -53,16 +54,29 @@ export const observeComment = <Events extends ['onFetch', 'onUpdate', 'onDelete'
     callback[action]?.(result)
   }
 
+  const realtimeRouter = (
+    result: Amity.QueryResult<Amity.Comment>,
+    action: Events[number]
+  ) => {
+    if (result.data?.commentId !== commentId) return
+
+    router(result, action)
+  }
+
   const disposers: Amity.Unsubscriber[] = []
 
   disposers.push(
-    onCommentUpdated(data => router({ data }, 'onUpdate')),
-    onCommentDeleted(data => router({ data }, 'onDelete')),
+    onCommentUpdated(data => realtimeRouter({ data }, 'onUpdate')),
+    onCommentDeleted(data => realtimeRouter({ data }, 'onDelete')),
+    onCommentFlagged(data => realtimeRouter({ data }, 'onFlagged')),
+    onCommentUnflagged(data => realtimeRouter({ data }, 'onUnflagged')),
+    onCommentReactionAdded(data => realtimeRouter({ data }, 'onReactionAdded')),
+    onCommentReactionRemoved(data => realtimeRouter({ data }, 'onReactionRemoved')),
   )
 
   runQuery(
     createQuery(getComment, commentId),
-    result => result.data && router(result, 'onFetch'),
+    result => router(result, 'onFetch'),
     queryOptions(policy)
   )
 

package/src/comment/observers/observeComments.ts

@@ -4,6 +4,10 @@ import {
   onCommentCreated,
   onCommentUpdated,
   onCommentDeleted,
+  onCommentFlagged,
+  onCommentUnflagged,
+  onCommentReactionAdded,
+  onCommentReactionRemoved,
 } from '../events'
 
 /**
@@ -26,7 +30,7 @@ export const observeComments = (
   postId: Amity.Post['postId'],
   callback: Amity.ObjectListener<
     Amity.Comment,
-    ['onCreate', 'onUpdate', 'onDelete']
+    ['onCreate', 'onUpdate', 'onDelete', 'onFlagged', 'onUnflagged', 'onReactionAdded', 'onReactionRemoved']
   >
 ): Amity.Unsubscriber => {
   const { log } = getActiveClient()
@@ -38,7 +42,7 @@ export const observeComments = (
 
   const router = (
     comment: Amity.Comment,
-    action: 'onCreate' | 'onUpdate' | 'onDelete'
+    action: 'onCreate' | 'onUpdate' | 'onDelete' | 'onFlagged' | 'onUnflagged' | 'onReactionAdded' | 'onReactionRemoved'
   ) => {
     if (comment.referenceId !== postId) return
 
@@ -51,7 +55,11 @@ export const observeComments = (
   disposers.push(
     onCommentCreated(comment => router(comment, 'onCreate')),
     onCommentUpdated(comment => router(comment, 'onUpdate')),
-    onCommentDeleted(comment => router(comment, 'onDelete'))
+    onCommentDeleted(comment => router(comment, 'onDelete')),
+    onCommentFlagged(comment => router(comment, 'onFlagged')),
+    onCommentUnflagged(comment => router(comment, 'onUnflagged')),
+    onCommentReactionAdded(comment => router(comment, 'onReactionAdded')),
+    onCommentReactionRemoved(comment => router(comment, 'onReactionRemoved')),
   )
 
   return () => {

package/src/community/api/addCommunityMembers.ts

@@ -33,7 +33,7 @@ export const addCommunityMembers = async (
 
   decoratePayload(data)
   ingestInCache(data)
-  fireEvent('v3.community.didAddUsers', {
+  fireEvent('community.userAdded', {
     communities: data.communities!,
   })
 

package/src/community/api/createCommunity.ts

@@ -36,7 +36,7 @@ export const createCommunity = async (
 
   decoratePayload(data)
   ingestInCache(data)
-  fireEvent('v3.community.didCreate', data)
+  fireEvent('community.created', data)
 
   const { communities } = data
   return communities[0]

package/src/community/api/deleteCommunity.ts

@@ -29,7 +29,7 @@ export const deleteCommunity = async (
   )
 
   const deleted = await getCommunity(communityId)
-  fireEvent('v3.community.didDelete', { communities: [deleted] })
+  fireEvent('community.deleted', { communities: [deleted] })
 
   return deleted
 }

package/src/community/api/joinCommunity.ts

@@ -28,7 +28,7 @@ export const joinCommunity = async (communityId: Amity.Community['communityId'])
 
   decoratePayload(data)
   ingestInCache(data)
-  fireEvent('v3.community.didJoin', {
+  fireEvent('community.joined', {
     communities: data.communities!
   })
 

package/src/community/api/leaveCommunity.ts

@@ -28,7 +28,7 @@ export const leaveCommunity = async (communityId: Amity.Community['communityId']
 
   decoratePayload(data)
   ingestInCache(data)
-  fireEvent('v3.community.didJoin', {
+  fireEvent('community.left', {
     communities: data.communities!,
   })
 

package/src/community/api/removeCommunityMembers.ts

@@ -33,7 +33,7 @@ export const removeCommunityMembers = async (
 
   decoratePayload(data)
   ingestInCache(data)
-  fireEvent('v3.community.didRemoveUsers', {
+  fireEvent('community.userRemoved', {
     communities: data.communities!,
   })
 

package/src/community/api/updateCommunity.ts

@@ -33,7 +33,7 @@ export const updateCommunity = async (
 
   decoratePayload(data)
   ingestInCache(data)
-  fireEvent('v3.community.didUpdate', data)
+  fireEvent('community.updated', data)
 
   const { communities } = data
   return communities.find(community => community.communityId === communityId)!

package/src/community/events/index.ts

@@ -4,3 +4,8 @@ export * from './onCommunityDeleted'
 
 export * from './onCommunityJoined'
 export * from './onCommunityLeft'
+
+export * from './onCommunityUserAdded'
+export * from './onCommunityUserRemoved'
+export * from './onCommunityUserBanned'
+export * from './onCommunityUserUnbanned'

package/src/community/events/onCommunityCreated.ts

@@ -1,37 +1,19 @@
-import { getActiveClient } from '~/client/api'
-import { createEventSubscriber } from '~/core/events'
-
-import { decoratePayload } from '~/core/query'
-import { ingestInCache } from '~/core/cache'
+import { createCommunityEventSubscriber } from './utils'
 
 /**
  * ```js
  * import { onCommunityCreated } from '@amityco/ts-sdk'
- * const dispose = onCommunityCreated(channel => {
+ * const dispose = onCommunityCreated(community => {
  *   // ...
  * })
  * ```
  *
- * Fired when any {@link Amity.Community} have been created
+ * Fired when {@link Amity.Community} have been created
  *
  * @param callback The function to call when the event was fired
  * @returns an {@link Amity.Unsubscriber} function to stop listening
  *
  * @category Community Events
  */
-export const onCommunityCreated = (callback: Amity.Listener<Amity.Community>) => {
-  const client = getActiveClient()
-
-  const filter = (payload: Amity.CommunityPayload) => {
-    decoratePayload(payload)
-    ingestInCache(payload)
-    callback(payload.communities[0])
-  }
-
-  return createEventSubscriber(
-    client,
-    'onCommunityCreated',
-    'v3.community.didCreate',
-    filter
-  )
-}
+export const onCommunityCreated = (callback: Amity.Listener<Amity.Community>) =>
+  createCommunityEventSubscriber('community.created', callback)

package/src/community/events/onCommunityDeleted.ts

@@ -1,37 +1,19 @@
-import { getActiveClient } from '~/client/api'
-import { createEventSubscriber } from '~/core/events'
-
-import { decoratePayload } from '~/core/query'
-import { ingestInCache } from '~/core/cache'
+import { createCommunityEventSubscriber } from './utils'
 
 /**
  * ```js
  * import { onCommunityDeleted } from '@amityco/ts-sdk'
- * const dispose = onCommunityDeleted(channel => {
+ * const dispose = onCommunityDeleted(community => {
  *   // ...
  * })
  * ```
  *
- * Fired when any {@link Amity.Community} have been deleted
+ * Fired when a {@link Amity.Community} has been deleted
  *
  * @param callback The function to call when the event was fired
  * @returns an {@link Amity.Unsubscriber} function to stop listening
  *
  * @category Community Events
  */
-export const onCommunityDeleted = (callback: Amity.Listener<Amity.Community>) => {
-  const client = getActiveClient()
-
-  const filter = (payload: Amity.CommunityPayload) => {
-    decoratePayload(payload)
-    ingestInCache(payload)
-    callback(payload.communities[0])
-  }
-
-  return createEventSubscriber(
-    client,
-    'onCommunityDeleted',
-    'v3.community.didDelete',
-    filter
-  )
-}
+export const onCommunityDeleted = (callback: Amity.Listener<Amity.Community>) =>
+  createCommunityEventSubscriber('community.deleted', callback)

package/src/community/events/onCommunityJoined.ts

@@ -1,37 +1,19 @@
-import { getActiveClient } from '~/client/api'
-import { createEventSubscriber } from '~/core/events'
-
-import { decoratePayload } from '~/core/query'
-import { ingestInCache } from '~/core/cache'
+import { createCommunityMemberEventSubscriber } from './utils'
 
 /**
  * ```js
  * import { onCommunityJoined } from '@amityco/ts-sdk'
- * const dispose = onCommunityJoined(channel => {
+ * const dispose = onCommunityJoined((community, member) => {
  *   // ...
  * })
  * ```
  *
- * Fired when any {@link Amity.Community} was joined
+ * Fired when a {@link Amity.Community} has been joined
  *
  * @param callback The function to call when the event was fired
  * @returns an {@link Amity.Unsubscriber} function to stop listening
  *
  * @category Community Events
  */
-export const onCommunityJoined = (callback: Amity.Listener<Amity.Community>) => {
-  const client = getActiveClient()
-
-  const filter = (payload: Amity.CommunityPayload) => {
-    decoratePayload(payload)
-    ingestInCache(payload)
-    callback(payload.communities[0])
-  }
-
-  return createEventSubscriber(
-    client,
-    'onCommunityJoined',
-    'v3.community.didJoin',
-    filter
-  )
-}
+export const onCommunityJoined = (callback: (community: Amity.Community, member: Amity.Membership<'community'>) => void) =>
+  createCommunityMemberEventSubscriber('community.joined', callback)

package/src/community/events/onCommunityLeft.ts

@@ -1,37 +1,19 @@
-import { getActiveClient } from '~/client/api'
-import { createEventSubscriber } from '~/core/events'
-
-import { decoratePayload } from '~/core/query'
-import { ingestInCache } from '~/core/cache'
+import { createCommunityMemberEventSubscriber } from './utils'
 
 /**
  * ```js
  * import { onCommunityLeft } from '@amityco/ts-sdk'
- * const dispose = onCommunityLeft(channel => {
+ * const dispose = onCommunityLeft((community, member) => {
  *   // ...
  * })
  * ```
  *
- * Fired when any {@link Amity.Community} was left
+ * Fired when a {@link Amity.Community} has been left
  *
  * @param callback The function to call when the event was fired
  * @returns an {@link Amity.Unsubscriber} function to stop listening
  *
  * @category Community Events
  */
-export const onCommunityLeft = (callback: Amity.Listener<Amity.Community>) => {
-  const client = getActiveClient()
-
-  const filter = (payload: Amity.CommunityPayload) => {
-    decoratePayload(payload)
-    ingestInCache(payload)
-    callback(payload.communities[0])
-  }
-
-  return createEventSubscriber(
-    client,
-    'onCommunityLeft',
-    'v3.community.didLeave',
-    filter
-  )
-}
+export const onCommunityLeft = (callback: (community: Amity.Community, member: Amity.Membership<'community'>) => void) =>
+  createCommunityMemberEventSubscriber('community.left', callback)