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

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)

package/src/community/events/onCommunityUpdated.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 { onCommunityUpdated } from '@amityco/ts-sdk'
- * const dispose = onCommunityUpdated(channel => {
+ * const dispose = onCommunityUpdated(community => {
  *   // ...
  * })
  * ```
  *
- * Fired when any {@link Amity.Community} have been updated
+ * Fired when a {@link Amity.Community} has been updated
  *
  * @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 onCommunityUpdated = (callback: Amity.Listener<Amity.Community>) => {
-  const client = getActiveClient()
-
-  const filter = (payload: Amity.CommunityPayload) => {
-    decoratePayload(payload)
-    ingestInCache(payload)
-    callback(payload.communities[0])
-  }
-
-  return createEventSubscriber(
-    client,
-    'onCommunityUpdated',
-    'v3.community.didUpdate',
-    filter
-  )
-}
+export const onCommunityUpdated = (callback: Amity.Listener<Amity.Community>) =>
+  createCommunityEventSubscriber('community.updated', callback)

package/src/community/events/onCommunityUserAdded.ts

@@ -0,0 +1,19 @@
+import { createCommunityMemberEventSubscriber } from './utils'
+
+/**
+ * ```js
+ * import { onCommunityUserAdded } from '@amityco/ts-sdk'
+ * const dispose = onCommunityUserAdded((community, member) => {
+ *   // ...
+ * })
+ * ```
+ *
+ * Fired when a user has been added to a {@link Amity.Community}
+ *
+ * @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 onCommunityUserAdded = (callback: (community: Amity.Community, member: Amity.Membership<'community'>) => void) =>
+  createCommunityMemberEventSubscriber('community.userAdded', callback)

package/src/community/events/onCommunityUserBanned.ts

@@ -0,0 +1,19 @@
+import { createCommunityMemberEventSubscriber } from './utils'
+
+/**
+ * ```js
+ * import { onCommunityUserBanned } from '@amityco/ts-sdk'
+ * const dispose = onCommunityUserBanned((community, member) => {
+ *   // ...
+ * })
+ * ```
+ *
+ * Fired when a user has been banned in a {@link Amity.Community}
+ *
+ * @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 onCommunityUserBanned = (callback: (community: Amity.Community, member: Amity.Membership<'community'>) => void) =>
+  createCommunityMemberEventSubscriber('community.userBanned', callback)

package/src/community/events/onCommunityUserRemoved.ts

@@ -0,0 +1,19 @@
+import { createCommunityMemberEventSubscriber } from './utils'
+
+/**
+ * ```js
+ * import { onCommunityUserRemoved } from '@amityco/ts-sdk'
+ * const dispose = onCommunityUserRemoved((community, member) => {
+ *   // ...
+ * })
+ * ```
+ *
+ * Fired when a user has been removed from a {@link Amity.Community}
+ *
+ * @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 onCommunityUserRemoved = (callback: (community: Amity.Community, member: Amity.Membership<'community'>) => void) =>
+  createCommunityMemberEventSubscriber('community.userRemoved', callback)

package/src/community/events/onCommunityUserUnbanned.ts

@@ -0,0 +1,19 @@
+import { createCommunityMemberEventSubscriber } from './utils'
+
+/**
+ * ```js
+ * import { onCommunityUserUnbanned } from '@amityco/ts-sdk'
+ * const dispose = onCommunityUserUnbanned((community, member) => {
+ *   // ...
+ * })
+ * ```
+ *
+ * Fired when a user has been unbanned in a {@link Amity.Community}
+ *
+ * @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 onCommunityUserUnbanned = (callback: (community: Amity.Community, member: Amity.Membership<'community'>) => void) =>
+  createCommunityMemberEventSubscriber('community.userUnbanned', callback)

package/src/community/events/utils.ts

@@ -0,0 +1,108 @@
+import { getActiveClient } from '~/client/api'
+import { decoratePayload } from '~/core/query'
+import { ingestInCache, pullFromCache } from '~/core/cache'
+import { createEventSubscriber } from '~/core/events'
+import { getResolver, isMatch } from '~/core/model'
+
+export const createCommunityEventSubscriber = (
+  event: keyof Amity.MqttCommunityMessageEvents,
+  callback: Amity.Listener<Amity.Community>
+) => {
+  const client = getActiveClient()
+
+  const filter = (payload: Amity.CommunityPayload) => {
+    const [cached] = pullFromCache('community', payload.communities[0].communityId) ?? []
+
+    decoratePayload(payload)
+    ingestInCache(payload)
+
+    const [community] = pullFromCache('community', payload.communities[0].communityId) ?? []
+
+    if (cached && isMatch(cached, community)) {
+      return
+    }
+
+    callback(community)
+  }
+
+  return createEventSubscriber(
+    client,
+    event,
+    event,
+    filter
+  )
+}
+
+function hasPermission(member: Amity.Membership<'community'>, payload: Amity.CommunityPayload, permission: string) {
+  if (member.permissions.some(x => x === permission)) {
+    return true;
+  }
+
+  return payload.users!
+    .find(user => user.userId === member.userId)!
+    .permissions.some(x => x === permission)
+}
+
+
+function getEventRelatedMember(
+  event: keyof Amity.MqttCommunityUserMessageEvents,
+  payload: Amity.CommunityPayload
+)  {
+  if (event === 'community.joined' || event === 'community.left') {
+    return payload.communityUsers![0];
+  }
+
+  // NOTE: backend returns the one who took the action and the one on whom
+  // the action was taken. We need the 2nd one
+  if (event === 'community.userRemoved') {
+    return payload.communityUsers!.filter(x => x.communityMembership === 'none')[0]
+  }
+
+  if (event === 'community.userBanned') {
+    return payload.communityUsers!.filter(x => x.communityMembership === 'banned')[0]
+  }
+
+  // NOTE: it might be that in certain edge cases permission check won't be enough
+  if (event === 'community.userUnbanned') {
+    return payload.communityUsers!.filter(x => !hasPermission(x, payload, 'BAN_COMMUNITY_USER'))[0]
+  }
+
+  return payload.communityUsers!.filter(x => !hasPermission(x, payload, 'ADD_COMMUNITY_USER'))[0]
+}
+
+export const createCommunityMemberEventSubscriber = (
+  event: keyof Amity.MqttCommunityUserMessageEvents,
+  callback: (community: Amity.Community, member: Amity.Membership<'community'>) => void,
+) => {
+  const client = getActiveClient()
+
+  const filter = (payload: Amity.CommunityPayload) => {
+    const [cachedCommunity] = pullFromCache('community', payload.communities[0].communityId) ?? []
+    const [cachedMember] = pullFromCache(
+      'communityUsers',
+      getResolver('communityUsers')(getEventRelatedMember(event, payload))
+    ) ?? []
+
+    decoratePayload(payload)
+    ingestInCache(payload)
+
+    const [community] = pullFromCache('community', payload.communities[0].communityId) ?? []
+    const [member] = pullFromCache(
+      'communityUsers',
+      getResolver('communityUsers')(getEventRelatedMember(event, payload))
+    ) ?? []
+
+    if (cachedCommunity && isMatch(cachedCommunity, community) && cachedMember && isMatch(cachedMember, member)) {
+      return
+    }
+
+    callback(community, member)
+  }
+
+  return createEventSubscriber(
+    client,
+    event,
+    event,
+    filter
+  )
+}

package/src/community/observers/observeCommunity.ts

@@ -9,6 +9,10 @@ import {
   onCommunityDeleted,
   onCommunityJoined,
   onCommunityLeft,
+  onCommunityUserAdded,
+  onCommunityUserRemoved,
+  onCommunityUserBanned,
+  onCommunityUserUnbanned
 } from '../events'
 
 /**
@@ -27,7 +31,7 @@ import {
  *
  * @category Community Observer
  */
-export const observeCommunity = <Events extends ['onFetch', 'onUpdate', 'onDelete', 'onJoin', 'onLeft']>(
+export const observeCommunity = <Events extends ['onFetch', 'onUpdate', 'onDelete', 'onJoin', 'onLeft', 'onUserAdded', 'onUserRemoved', 'onUserBanned', 'onUserUnbanned']>(
   communityId: string,
   callback: Amity.ObjectListener<Amity.QueryResult<Amity.Community>, Events>
 ): Amity.Unsubscriber => {
@@ -41,9 +45,6 @@ export const observeCommunity = <Events extends ['onFetch', 'onUpdate', 'onDelet
     result: Amity.QueryResult<Amity.Community>,
     action: Events[number]
   ) => {
-    // filter function
-    if (result.data?.communityId !== communityId) return
-
     if (callback instanceof Function)
       return callback(result)
 
@@ -53,18 +54,31 @@ export const observeCommunity = <Events extends ['onFetch', 'onUpdate', 'onDelet
     callback[action]?.(result)
   }
 
+  const realtimeRouter = (
+    result: Amity.QueryResult<Amity.Community>,
+    action: Events[number]
+  ) => {
+    if (result.data?.communityId !== communityId) return
+
+    router(result, action)
+  }
+
   const disposers: Amity.Unsubscriber[] = []
 
   disposers.push(
-    onCommunityUpdated(data => router({ data }, 'onUpdate')),
-    onCommunityDeleted(data => router({ data }, 'onDelete')),
-    onCommunityJoined(data => router({ data }, 'onJoin')),
-    onCommunityLeft(data => router({ data }, 'onLeft')),
+    onCommunityUpdated(data => realtimeRouter({ data }, 'onUpdate')),
+    onCommunityDeleted(data => realtimeRouter({ data }, 'onDelete')),
+    onCommunityJoined(data => realtimeRouter({ data }, 'onJoin')),
+    onCommunityLeft(data => realtimeRouter({ data }, 'onLeft')),
+    onCommunityUserAdded(data => realtimeRouter({ data }, 'onUserAdded')),
+    onCommunityUserRemoved(data => realtimeRouter({ data }, 'onUserRemoved')),
+    onCommunityUserBanned(data => realtimeRouter({ data }, 'onUserBanned')),
+    onCommunityUserUnbanned(data => realtimeRouter({ data }, 'onUserUnbanned')),
   )
 
   runQuery(
     createQuery(getCommunity, communityId),
-    result => result.data && router(result, 'onFetch')
+    result => router(result, 'onFetch')
   )
 
   return () => {

package/src/core/cache/ingest.ts

@@ -1,6 +1,8 @@
-import { pushToCache } from './push'
+import { pullFromCache } from './pull'
+import { mergeInCache } from './merge'
 
-import { storeInterests } from '../model/idResolvers'
+import { getResolver, storeInterests } from '~/core/model'
+import { pushToCache } from '~/core/cache/push'
 
 /**
  * Ingest a payload (v3) into the cache
@@ -19,6 +21,20 @@ export const ingestInCache = (
       const name = storeInterests[key]
       if (!name) return
 
-      pushToCache(name, ...payload[key])
+      payload[key].forEach(model => {
+        const [cached] = pullFromCache(name, getResolver(name)(model)) ?? []
+
+        if (cached) {
+          // > instead of >= - some updates like reactions do not change updatedAt
+          if (cached.updatedAt && cached.updatedAt > model.updatedAt) {
+            return
+          }
+
+          // personal fields like isJoined, myReactions are missed from real time event payload
+          mergeInCache(name, model)
+        } else {
+          pushToCache(name, model)
+        }
+      })
     })
 }