@amityco/ts-sdk 0.0.1-be4fc2f.0 → 0.0.1-beta.10

package/src/comment/observers/observeComment.ts

@@ -1,7 +1,6 @@
 import { getActiveClient } from '~/client/api'
 
 import { createQuery, runQuery, queryOptions } from '~/core/query'
-import { getTopic, subscribe } from '~/core/subscription'
 
 import { getComment } from '../api'
 
@@ -33,8 +32,8 @@ import {
  */
 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',
+  callback: Amity.ObjectListener<Amity.Snapshot<Amity.Comment | undefined>, Events>,
+  policy: Amity.QueryPolicy = 'cache_then_server'
 ): Amity.Unsubscriber => {
   const { log } = getActiveClient()
 
@@ -43,43 +42,39 @@ export const observeComment = <Events extends ['onFetch', 'onUpdate', 'onDelete'
 
   // wrapper function to make sure
   const router = (
-    result: Amity.QueryResult<Amity.Comment>,
+    result: Amity.Snapshot<Amity.Comment | undefined>,
     action: Events[number]
   ) => {
-    // filter function
-    if (result.data?.commentId !== commentId) return
+    if (callback instanceof Function) return callback(result)
 
-    if (action === 'onFetch') {
-      try {
-        disposers.push(subscribe(getTopic(result.data)))
-      } catch (error) {
-        console.error(error)
-      }
-    }
+    if (action !== 'onFetch') callback.onEvent?.(action, result)
 
-    if (callback instanceof Function)
-      return callback(result)
+    callback[action]?.(result)
+  }
 
-    if (action !== 'onFetch')
-      callback.onEvent?.(action, result)
+  const realtimeRouter = (
+    result: Amity.Snapshot<Amity.Comment>,
+    action: Events[number]
+  ) => {
+    if (result.data?.commentId !== commentId) return
 
-    callback[action]?.(result)
+    router(result, action)
   }
 
   const disposers: Amity.Unsubscriber[] = []
 
   disposers.push(
-    onCommentUpdated(data => router({ data }, 'onUpdate')),
-    onCommentDeleted(data => router({ data }, 'onDelete')),
-    onCommentFlagged(data => router({ data }, 'onFlagged')),
-    onCommentUnflagged(data => router({ data }, 'onUnflagged')),
-    onCommentReactionAdded(data => router({ data }, 'onReactionAdded')),
-    onCommentReactionRemoved(data => router({ data }, 'onReactionRemoved')),
+    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')),
   )
 
   runQuery(
     createQuery(getComment, commentId),
-    result => result.data && router(result, 'onFetch'),
+    result => (result.data || result.error) && router(result, 'onFetch'),
     queryOptions(policy)
   )
 

package/src/community/api/addCommunityMembers.ts

@@ -1,9 +1,7 @@
 import { getActiveClient } from '~/client/api'
 
-import { decoratePayload } from '~/core/query'
-import { ingestInCache } from '~/core/cache'
+import { ingestInCache } from '~/cache/api/ingestInCache'
 import { fireEvent } from '~/core/events'
-
 /**
  * ```js
  * import { addCommunityMembers } from '@amityco/ts-sdk'
@@ -22,7 +20,7 @@ import { fireEvent } from '~/core/events'
 export const addCommunityMembers = async (
   communityId: Amity.Community['communityId'],
   userIds: Amity.User['userId'][]
-) => {
+): Promise<boolean> => {
   const client = getActiveClient()
   client.log('community/addCommunityMembers', communityId, userIds)
 
@@ -31,8 +29,9 @@ export const addCommunityMembers = async (
     { communityId, userIds }
   )
 
-  decoratePayload(data)
-  ingestInCache(data)
+
+  if (client.cache) ingestInCache(data)
+
   fireEvent('community.userAdded', {
     communities: data.communities!,
   })

package/src/community/api/addCommunityMembersRole.ts

@@ -1,7 +1,6 @@
 import { getActiveClient } from '~/client/api'
 
-import { decoratePayload } from '~/core/query'
-import { ingestInCache } from '~/core/cache'
+import { ingestInCache } from '~/cache/api/ingestInCache'
 
 /**
  * ```js
@@ -23,7 +22,7 @@ export const addCommunityMembersRole = async (
   communityId: Amity.Community['communityId'],
   roleId: Amity.Role['roleId'],
   userIds: Amity.User['userId'][]
-) => {
+): Promise<boolean> => {
   const client = getActiveClient()
   client.log('community/addCommunityMembersRole', communityId, roleId, userIds)
 
@@ -32,8 +31,7 @@ export const addCommunityMembersRole = async (
     { communityId, role: roleId, userIds }
   )
 
-  decoratePayload(data)
-  ingestInCache(data)
+  if (client.cache) ingestInCache(data)
 
   const { communityUsers } = data
   return !!communityUsers.find(

package/src/community/api/createCommunity.ts

@@ -1,7 +1,6 @@
 import { getActiveClient } from '~/client/api'
 
-import { decoratePayload } from '~/core/query'
-import { ingestInCache } from '~/core/cache'
+import { ingestInCache } from '~/cache/api/ingestInCache'
 import { fireEvent } from '~/core/events'
 
 /**
@@ -26,7 +25,7 @@ export const createCommunity = async (
     userIds?: string[]
     categoryIds?: string[]
     isUniqueDisplayName?: boolean
-  }) => {
+  }): Promise<Amity.Cached<Amity.Community>> => {
   const client = getActiveClient()
   client.log('user/createCommunity', bundle)
 
@@ -34,10 +33,14 @@ export const createCommunity = async (
     '/api/v3/communities/', bundle,
   )
 
-  decoratePayload(data)
-  ingestInCache(data)
+  const cachedAt = client.cache && Date.now()
+  if (client.cache) ingestInCache(data, { cachedAt })
+
   fireEvent('community.created', data)
 
   const { communities } = data
-  return communities[0]
+  return {
+    data: communities[0],
+    cachedAt,
+  }
 }

package/src/community/api/deleteCommunity.ts

@@ -19,7 +19,7 @@ import { getCommunity } from './getCommunity'
  */
 export const deleteCommunity = async (
   communityId: Amity.Community['communityId'],
-) => {
+): Promise<Amity.Community> => {
   const client = getActiveClient()
   client.log('community/deleteCommunity', communityId)
 
@@ -29,7 +29,7 @@ export const deleteCommunity = async (
   )
 
   const deleted = await getCommunity(communityId)
-  fireEvent('community.deleted', { communities: [deleted] })
+  fireEvent('community.deleted', { communities: [deleted.data] })
 
-  return deleted
+  return deleted.data
 }

package/src/community/api/getCommunities.ts

@@ -1,8 +1,7 @@
 import { getActiveClient } from '~/client/api'
 
-import { decoratePayload } from '~/core/query'
-import { ingestInCache, pullFromCache } from '~/core/cache'
-import { toRecord } from '~/core/model'
+import { pullFromCache } from '~/cache/api'
+import { ingestInCache } from '~/cache/api/ingestInCache'
 
 /**
  * ```js
@@ -20,7 +19,7 @@ import { toRecord } from '~/core/model'
  */
 export const getCommunities = async (
   communityIds: Amity.Community['communityId'][]
-) => {
+): Promise<Amity.Cached<Amity.Community[]>> => {
   const client = getActiveClient()
   client.log('community/getCommunities', communityIds)
 
@@ -30,11 +29,13 @@ export const getCommunities = async (
     { params: { communityIds } },
   )
 
-  decoratePayload(data)
-  ingestInCache(data)
+  const cachedAt = client.cache && Date.now()
+  if (client.cache) ingestInCache(data, { cachedAt })
 
-  const { communities } = data
-  return toRecord(communities)
+  return {
+    data: data.communities,
+    cachedAt
+  }
 }
 
 /**
@@ -52,12 +53,24 @@ export const getCommunities = async (
  */
 getCommunities.locally = (
   communityIds: Amity.Community['communityId'][]
-) => {
+): Amity.Cached<Amity.Community[]> | undefined => {
   const client = getActiveClient()
   client.log('community/getCommunities.locally', communityIds)
 
-  const cached = pullFromCache('community', ...communityIds) ?? []
+  if (!client.cache) return
 
-  if (cached?.length === communityIds.length)
-    return toRecord(cached)
+  const cached = communityIds
+    .map(communityId => pullFromCache<Amity.Community>(['community', 'get', communityId])!)
+    .filter(Boolean)
+
+  const communities = cached.map(({ data }) => data)
+  const oldest = cached.sort((a, b) => a.cachedAt! < b.cachedAt! ? -1 : 1)?.[0]
+
+  if (cached?.length < communityIds.length)
+    return
+
+  return {
+    data: communities,
+    cachedAt: oldest.cachedAt,
+  }
 }

package/src/community/api/getCommunity.ts

@@ -1,6 +1,7 @@
 import { getActiveClient } from '~/client/api'
-import { ingestInCache, pullFromCache } from '~/core/cache'
-import { decoratePayload } from '~/core/query'
+
+import { pullFromCache } from '~/cache/api'
+import { ingestInCache } from '~/cache/api/ingestInCache'
 
 /**
  * ```js
@@ -18,7 +19,7 @@ import { decoratePayload } from '~/core/query'
  */
 export const getCommunity = async (
   communityId: Amity.Community['communityId']
-) => {
+): Promise<Amity.Cached<Amity.Community>> => {
   const client = getActiveClient()
   client.log('community/getCommunity', communityId)
 
@@ -27,11 +28,15 @@ export const getCommunity = async (
     `/api/v3/communities/${communityId}`,
   )
 
-  decoratePayload(data)
-  ingestInCache(data)
+  const cachedAt = client.cache && Date.now()
+  if (client.cache) ingestInCache(data, { cachedAt })
 
   const { communities } = data
-  return communities.find(community => community.communityId === communityId)!
+
+  return {
+    data: communities.find(community => community.communityId === communityId)!,
+    cachedAt,
+  }
 }
 
 /**
@@ -49,10 +54,19 @@ export const getCommunity = async (
  */
 getCommunity.locally = (
   communityId: Amity.Community['communityId']
-) => {
+): Amity.Cached<Amity.Community> | undefined => {
   const client = getActiveClient()
   client.log('community/getCommunity.locally', communityId)
 
-  const [community] = pullFromCache('community', communityId) ?? []
-  return community
+  if (!client.cache) return
+
+  const cached = pullFromCache<Amity.Community>(['community', 'get', communityId])
+
+  if (!cached)
+    return
+
+  return {
+    data: cached.data,
+    cachedAt: cached.cachedAt,
+  }
 }

package/src/community/api/joinCommunity.ts

@@ -1,7 +1,6 @@
 import { getActiveClient } from '~/client/api'
 
-import { decoratePayload } from '~/core/query'
-import { ingestInCache } from '~/core/cache'
+import { ingestInCache } from '~/cache/api/ingestInCache'
 import { fireEvent } from '~/core/events'
 
 /**
@@ -18,7 +17,9 @@ import { fireEvent } from '~/core/events'
  * @category Community API
  * @async
  */
-export const joinCommunity = async (communityId: Amity.Community['communityId']) => {
+export const joinCommunity = async (
+  communityId: Amity.Community['communityId']
+): Promise<boolean> => {
   const client = getActiveClient()
   client.log('community/joinCommunity', communityId)
 
@@ -26,8 +27,9 @@ export const joinCommunity = async (communityId: Amity.Community['communityId'])
     `/api/v3/communities/${communityId}/join`,
   )
 
-  decoratePayload(data)
-  ingestInCache(data)
+  const cachedAt = client.cache && Date.now()
+  if (client.cache) ingestInCache(data, { cachedAt })
+
   fireEvent('community.joined', {
     communities: data.communities!
   })

package/src/community/api/leaveCommunity.ts

@@ -1,7 +1,6 @@
 import { getActiveClient } from '~/client/api'
 
-import { decoratePayload } from '~/core/query'
-import { ingestInCache } from '~/core/cache'
+import { ingestInCache } from '~/cache/api/ingestInCache'
 import { fireEvent } from '~/core/events'
 
 /**
@@ -18,7 +17,9 @@ import { fireEvent } from '~/core/events'
  * @category Community API
  * @async
  */
-export const leaveCommunity = async (communityId: Amity.Community['communityId']) => {
+export const leaveCommunity = async (
+  communityId: Amity.Community['communityId']
+): Promise<boolean> => {
   const client = getActiveClient()
   client.log('community/leaveCommunity', communityId)
 
@@ -26,8 +27,9 @@ export const leaveCommunity = async (communityId: Amity.Community['communityId']
     `/api/v3/communities/${communityId}/leave`,
   )
 
-  decoratePayload(data)
-  ingestInCache(data)
+  const cachedAt = client.cache && Date.now()
+  if (client.cache) ingestInCache(data, { cachedAt })
+
   fireEvent('community.left', {
     communities: data.communities!,
   })

package/src/community/api/queryCommunities.ts

@@ -1,8 +1,9 @@
 import { getActiveClient } from '~/client/api'
 
-import { decoratePayload, toPage, toToken } from '~/core/query'
-import { ingestInCache } from '~/core/cache'
-import { toRecord } 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
@@ -30,7 +31,7 @@ export const queryCommunities = async (
     sortBy?: ('displayName' | 'firstCreated' | 'lastCreated')
     page?: Amity.Page
   }
-) => {
+): Promise<Amity.Cached<Amity.Paged<Amity.Community>>> => {
   const client = getActiveClient()
   client.log('channel/queryCommunities', query)
 
@@ -56,17 +57,22 @@ export const queryCommunities = async (
     } }
   )
 
-  // API-FIX: backend to response Amity.Response: const { paging, communities } = unwrapPayload(data)
-  const { paging, ...response } = data
+  const { paging, ...payload } = data
+  const { communities } = payload
+
+  const cachedAt = client.cache && Date.now()
 
-  decoratePayload(response as unknown as Record<string, object[]>)
-  ingestInCache(response as unknown as Record<string, object[]>)
+  if (client.cache) {
+    ingestInCache(payload as Amity.CommunityPayload, { cachedAt })
+
+    const cacheKey = ['community', 'query', { ...params, options: { ...page } } as Amity.Serializable]
+    pushToCache(cacheKey, { communities: communities.map(getResolver('community')), paging })
+  }
 
-  const prevPage = toPage(paging?.previous)
-  const nextPage = toPage(paging?.next)
+  const nextPage = toPage(paging.next)
+  const prevPage = toPage(paging.previous)
 
-  const { communities } = response
-  return { data: toRecord(communities), prevPage, nextPage }
+  return { data: communities, cachedAt, prevPage, nextPage }
 }
 
 /**

package/src/community/api/queryCommunityMembers.ts

@@ -1,9 +1,7 @@
 import { getActiveClient } from '~/client/api'
 
-import { decoratePayload, toPage, toToken } from '~/core/query'
-import { ingestInCache } from '~/core/cache'
-
-import { toRecord } from '~/core/model'
+import { toPage, toToken } from '~/core/query'
+import { ingestInCache } from '~/cache/api/ingestInCache'
 
 /**
  * ```js
@@ -25,7 +23,7 @@ export const queryCommunityMembers = async (query: {
   roles?: string[]
   sortBy?: 'firstCreated' | 'lastCreated'
   page?: Amity.Page
-}) => {
+}): Promise<Amity.Cached<Amity.Paged<Amity.Membership<"community">>>> => {
   const client = getActiveClient()
   client.log('community/queryCommunityMembers', query)
 
@@ -42,17 +40,18 @@ export const queryCommunityMembers = async (query: {
     },
   })
 
-  const { paging, ...response } = data
-
-  decoratePayload(response as unknown as Record<string, Object[]>)
-  ingestInCache(response as unknown as Record<string, Object[]>)
+  const { paging, ...payload } = data
+  const { communityUsers } = payload
 
-  const { communityUsers } = response
+  const cachedAt = client.cache && Date.now()
+  if (client.cache) {
+    ingestInCache(payload as Amity.CommunityMembershipPayload, { cachedAt })
+  }
 
   const nextPage = toPage(paging.next)
   const prevPage = toPage(paging.previous)
 
-  return { data: toRecord(communityUsers), nextPage, prevPage }
+  return { data: communityUsers, nextPage, prevPage }
 }
 
 /**

package/src/community/api/removeCommunityMembers.ts

@@ -1,7 +1,6 @@
 import { getActiveClient } from '~/client/api'
 
-import { decoratePayload } from '~/core/query'
-import { ingestInCache } from '~/core/cache'
+import { ingestInCache } from '~/cache/api/ingestInCache'
 import { fireEvent } from '~/core/events'
 
 /**
@@ -22,7 +21,7 @@ import { fireEvent } from '~/core/events'
 export const removeCommunityMembers = async (
   communityId: Amity.Community['communityId'],
   userIds: Amity.User['userId'][]
-) => {
+): Promise<boolean> => {
   const client = getActiveClient()
   client.log('community/removeCommunityMembers', communityId, userIds)
 
@@ -31,8 +30,8 @@ export const removeCommunityMembers = async (
     { data: { communityId, userIds } }
   )
 
-  decoratePayload(data)
-  ingestInCache(data)
+  if (client.cache) ingestInCache(data)
+
   fireEvent('community.userRemoved', {
     communities: data.communities!,
   })

package/src/community/api/removeCommunityMembersRole.ts

@@ -1,7 +1,6 @@
 import { getActiveClient } from '~/client/api'
 
-import { decoratePayload } from '~/core/query'
-import { ingestInCache } from '~/core/cache'
+import { ingestInCache } from '~/cache/api/ingestInCache'
 
 /**
  * ```js
@@ -23,7 +22,7 @@ export const removeCommunityMembersRole = async (
   communityId: Amity.Community['communityId'],
   roleId: Amity.Role['roleId'],
   userIds: Amity.User['userId'][]
-) => {
+): Promise<boolean> => {
   const client = getActiveClient()
   client.log('community/removeCommunityMembersRole', communityId, roleId, userIds)
 
@@ -32,8 +31,7 @@ export const removeCommunityMembersRole = async (
     { data: { communityId, role: roleId, userIds } }
   )
 
-  decoratePayload(data)
-  ingestInCache(data)
+  if (client.cache) ingestInCache(data)
 
   const { communityUsers } = data
   return !!communityUsers.find(

package/src/community/api/updateCommunity.ts

@@ -1,10 +1,8 @@
 import { getActiveClient } from '~/client/api'
 
-import { decoratePayload } from '~/core/query'
-import { ingestInCache } from '~/core/cache'
+import { ingestInCache } from '~/cache/api/ingestInCache'
 import { fireEvent } from '~/core/events'
 
-
 /**
  * ```js
  * import { updateCommunity } from '@amityco/ts-sdk'
@@ -23,7 +21,7 @@ import { fireEvent } from '~/core/events'
 export const updateCommunity = async (
   communityId: Amity.Community['communityId'],
   patch: Patch<Amity.Community, 'displayName' | 'description' | 'avatarFileId' | 'tags' | 'metadata'>,
-) => {
+): Promise<Amity.Cached<Amity.Community>> => {
   const client = getActiveClient()
   client.log('community/updateCommunity', communityId, patch)
 
@@ -31,10 +29,15 @@ export const updateCommunity = async (
     `/api/v3/communities/${communityId}`, patch,
   )
 
-  decoratePayload(data)
-  ingestInCache(data)
+  const cachedAt = client.cache && Date.now()
+  if (client.cache) ingestInCache(data, { cachedAt })
+
   fireEvent('community.updated', data)
 
   const { communities } = data
-  return communities.find(community => community.communityId === communityId)!
+
+  return {
+    data: communities.find(community => community.communityId === communityId)!,
+    cachedAt,
+  }
 }

package/src/community/events/onCommunityCreated.ts

@@ -8,7 +8,7 @@ import { createCommunityEventSubscriber } from './utils'
  * })
  * ```
  *
- * Fired when any {@link Amity.Community} have been created
+ * Fired when a {@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

package/src/community/events/onCommunityDeleted.ts

@@ -8,7 +8,7 @@ import { createCommunityEventSubscriber } from './utils'
  * })
  * ```
  *
- * 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

package/src/community/events/onCommunityJoined.ts

@@ -1,19 +1,19 @@
-import { createCommunityEventSubscriber } from './utils'
+import { createCommunityMemberEventSubscriber } from './utils'
 
 /**
  * ```js
  * import { onCommunityJoined } from '@amityco/ts-sdk'
- * const dispose = onCommunityJoined(community => {
+ * 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>) =>
-  createCommunityEventSubscriber('community.joined', callback)
+export const onCommunityJoined = (callback: (community: Amity.Community, member: Amity.Membership<'community'>) => void) =>
+  createCommunityMemberEventSubscriber('community.joined', callback)

package/src/community/events/onCommunityLeft.ts

@@ -1,19 +1,19 @@
-import { createCommunityEventSubscriber } from './utils'
+import { createCommunityMemberEventSubscriber } from './utils'
 
 /**
  * ```js
  * import { onCommunityLeft } from '@amityco/ts-sdk'
- * const dispose = onCommunityLeft(community => {
+ * 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>) =>
-  createCommunityEventSubscriber('community.left', callback)
+export const onCommunityLeft = (callback: (community: Amity.Community, member: Amity.Membership<'community'>) => void) =>
+  createCommunityMemberEventSubscriber('community.left', callback)