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

package/src/channel/api/joinChannel.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
@@ -17,7 +16,9 @@ import { ingestInCache } from '~/core/cache'
  * @category Channel API
  * @async
  */
-export const joinChannel = async (channelId: Amity.Channel['channelId']) => {
+export const joinChannel = async (
+  channelId: Amity.Channel['channelId']
+): Promise<boolean> => {
   const client = getActiveClient()
   client.log('channel/joinChannel', channelId)
 
@@ -25,9 +26,7 @@ export const joinChannel = async (channelId: Amity.Channel['channelId']) => {
     `/api/v3/channels/${channelId}/join`,
   )
 
-  decoratePayload(data)
-  ingestInCache(data)
-  // no need for event, fired by server
+  if (client.cache) ingestInCache(data)
 
   const { channelUsers } = data
 

package/src/channel/api/leaveChannel.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
@@ -17,7 +16,9 @@ import { ingestInCache } from '~/core/cache'
  * @category Channel API
  * @async
  */
-export const leaveChannel = async (channelId: Amity.Channel['channelId']) => {
+export const leaveChannel = async (
+  channelId: Amity.Channel['channelId']
+): Promise<boolean> => {
   const client = getActiveClient()
   client.log('channel/leaveChannel', channelId)
 
@@ -25,9 +26,7 @@ export const leaveChannel = async (channelId: Amity.Channel['channelId']) => {
     `/api/v3/channels/${channelId}/leave`,
   )
 
-  decoratePayload(data)
-  ingestInCache(data)
-  // no need for event, fired by server
+  if (client.cache) ingestInCache(data)
 
   const { channelUsers } = data
 

package/src/channel/api/queryChannelMembers.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 queryChannelMembers = async (query: {
   roles?: string[]
   sortBy?: 'firstCreated' | 'lastCreated'
   page?: Amity.Page
-}) => {
+}): Promise<Amity.Cached<Amity.Paged<Amity.Membership<"channel">>>> => {
   const client = getActiveClient()
   client.log('channel/queryChannelMembers', query)
 
@@ -43,17 +41,17 @@ export const queryChannelMembers = 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 { channelUsers } = payload
 
-  const { channelUsers } = response
+  if (client.cache) {
+    ingestInCache(payload as Amity.ChannelMembershipPayload)
+  }
 
   const nextPage = toPage(paging.next)
   const prevPage = toPage(paging.previous)
 
-  return { data: toRecord(channelUsers), nextPage, prevPage }
+  return { data: channelUsers, nextPage, prevPage }
 }
 
 /**

package/src/channel/api/queryChannels.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
@@ -27,13 +28,13 @@ export const queryChannels = async (
     types?: Amity.ChannelType
     page?: Amity.Page
   }
-) => {
+): Promise<Amity.Cached<Amity.Paged<Amity.Channel>>> => {
   const client = getActiveClient()
   client.log('channel/queryChannels', query)
 
   // safe decapsulation
   const {
-    page,
+    page = { limit: 10 },
     displayName,
     membership,
     ...params
@@ -53,16 +54,22 @@ export const queryChannels = async (
     } }
   )
 
-  const { paging, ...response } = data
+  const { paging, ...payload } = data
+  const { channels } = payload
+
+  const cachedAt = client.cache && Date.now()
 
-  decoratePayload(response as unknown as Record<string, any[]>)
-  ingestInCache(response as unknown as Record<string, any[]>)
+  if (client.cache) {
+    ingestInCache(payload as Amity.ChannelPayload, { cachedAt })
+
+    const cacheKey = ['channel', 'query', { ...params, options: { ...page } } as Amity.Serializable]
+    pushToCache(cacheKey, { channels: channels.map(getResolver('channel')), paging })
+  }
 
-  const prevPage = toPage(paging?.previous)
-  const nextPage = toPage(paging?.next)
+  const nextPage = toPage(paging.next)
+  const prevPage = toPage(paging.previous)
 
-  const { channels } = response
-  return { data: toRecord(channels), prevPage, nextPage }
+  return { data: channels, cachedAt, prevPage, nextPage }
 }
 
 /**

package/src/channel/api/removeChannelMembers.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 removeChannelMembers = async (
   channelId: Amity.Channel['channelId'],
   userIds: Amity.User['userId'][]
-) => {
+): Promise<boolean> => {
   const client = getActiveClient()
   client.log('channel/removeChannelMembers', channelId, userIds)
 
@@ -31,8 +30,8 @@ export const removeChannelMembers = async (
     { data: { channelId, userIds } }
   )
 
-  decoratePayload(data)
-  ingestInCache(data)
+  if (client.cache) ingestInCache(data)
+
   fireEvent('v3.channel.didRemoveUsers', {
     channels: data.channels!,
   })

package/src/channel/api/removeChannelMembersRole.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 removeChannelMembersRole = async (
   channelId: Amity.Channel['channelId'],
   roleId: Amity.Role['roleId'],
   userIds: Amity.User['userId'][]
-) => {
+): Promise<boolean> => {
   const client = getActiveClient()
   client.log('channel/removeChannelMembersRole', channelId, roleId, userIds)
 
@@ -32,8 +31,7 @@ export const removeChannelMembersRole = async (
     { data: { channelId, role: roleId, userIds } }
   )
 
-  decoratePayload(data)
-  ingestInCache(data)
+  if (client.cache) ingestInCache(data)
 
   const { channelUsers } = data
   return !!channelUsers.find(

package/src/channel/api/updateChannel.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
@@ -21,7 +20,7 @@ import { ingestInCache } from '~/core/cache'
 export const updateChannel = async (
   channelId: Amity.Channel['channelId'],
   patch: Patch<Amity.Channel, 'displayName' | 'description' | 'avatarFileId' | 'metadata'>,
-) => {
+): Promise<Amity.Cached<Amity.Channel>> => {
   const client = getActiveClient()
   client.log('channel/updateChannel', channelId, patch)
 
@@ -29,10 +28,13 @@ export const updateChannel = async (
     `/api/v3/channels/${channelId}`, patch,
   )
 
-  decoratePayload(data)
-  ingestInCache(data)
-  // no need for event, fired by server
+  const cachedAt = client.cache && Date.now()
+  if (client.cache) ingestInCache(data, { cachedAt })
 
   const { channels } = data
-  return channels.find(channel => channel.channelId === channelId)!
+
+  return {
+    data: channels.find(channel => channel.channelId === channelId)!,
+    cachedAt,
+  }
 }

package/src/channel/events/onChannelDeleted.ts

@@ -1,8 +1,7 @@
 import { getActiveClient } from '~/client/api'
 import { createEventSubscriber } from '~/core/events'
 
-import { decoratePayload } from '~/core/query'
-import { ingestInCache } from '~/core/cache'
+import { ingestInCache } from '~/cache/api/ingestInCache'
 
 /**
  * ```js
@@ -23,7 +22,6 @@ export const onChannelDeleted = (callback: Amity.Listener<Amity.Channel>) => {
   const client = getActiveClient()
 
   const filter = (payload: Amity.ChannelPayload) => {
-    decoratePayload(payload)
     ingestInCache(payload)
     callback(payload.channels[0])
   }

package/src/channel/events/onChannelJoined.ts

@@ -1,8 +1,7 @@
 import { getActiveClient } from '~/client/api'
 import { createEventSubscriber } from '~/core/events'
 
-import { decoratePayload } from '~/core/query'
-import { ingestInCache } from '~/core/cache'
+import { ingestInCache } from '~/cache/api/ingestInCache'
 
 /**
  * ```js
@@ -23,7 +22,6 @@ export const onChannelJoined = (callback: Amity.Listener<Amity.Channel>) => {
   const client = getActiveClient()
 
   const filter = (payload: Amity.ChannelPayload) => {
-    decoratePayload(payload)
     ingestInCache(payload)
     callback(payload.channels[0])
   }

package/src/channel/events/onChannelLeft.ts

@@ -1,8 +1,7 @@
 import { getActiveClient } from '~/client/api'
 import { createEventSubscriber } from '~/core/events'
 
-import { decoratePayload } from '~/core/query'
-import { ingestInCache } from '~/core/cache'
+import { ingestInCache } from '~/cache/api/ingestInCache'
 
 /**
  * ```js
@@ -23,7 +22,6 @@ export const onChannelLeft = (callback: Amity.Listener<Amity.Channel>) => {
   const client = getActiveClient()
 
   const filter = (payload: Amity.ChannelPayload) => {
-    decoratePayload(payload)
     ingestInCache(payload)
     callback(payload.channels[0])
   }

package/src/channel/events/onChannelUpdated.ts

@@ -1,8 +1,7 @@
 import { getActiveClient } from '~/client/api'
 import { createEventSubscriber } from '~/core/events'
 
-import { decoratePayload } from '~/core/query'
-import { ingestInCache } from '~/core/cache'
+import { ingestInCache } from '~/cache/api/ingestInCache'
 
 /**
  * ```js
@@ -23,7 +22,6 @@ export const onChannelUpdated = (callback: Amity.Listener<Amity.Channel>) => {
   const client = getActiveClient()
 
   const filter = (payload: Amity.ChannelPayload) => {
-    decoratePayload(payload)
     ingestInCache(payload)
     callback(payload.channels[0])
   }

package/src/channel/events/onMemberAdded.ts

@@ -1,8 +1,7 @@
 import { getActiveClient } from '~/client/api'
 import { createEventSubscriber } from '~/core/events'
 
-import { decoratePayload } from '~/core/query'
-import { ingestInCache } from '~/core/cache'
+import { ingestInCache } from '~/cache/api/ingestInCache'
 
 /**
  * ```js
@@ -23,7 +22,6 @@ export const onMemberAdded = (callback: Amity.Listener<Amity.Channel>) => {
   const client = getActiveClient()
 
   const filter = (payload: Amity.ChannelPayload) => {
-    decoratePayload(payload)
     ingestInCache(payload)
     callback(payload.channels[0])
   }

package/src/channel/events/onMemberRemoved.ts

@@ -1,8 +1,7 @@
 import { getActiveClient } from '~/client/api'
 import { createEventSubscriber } from '~/core/events'
 
-import { decoratePayload } from '~/core/query'
-import { ingestInCache } from '~/core/cache'
+import { ingestInCache } from '~/cache/api/ingestInCache'
 
 /**
  * ```js
@@ -23,7 +22,6 @@ export const onMemberRemoved = (callback: Amity.Listener<Amity.Channel>) => {
   const client = getActiveClient()
 
   const filter = (payload: Amity.ChannelPayload) => {
-    decoratePayload(payload)
     ingestInCache(payload)
     callback(payload.channels[0])
   }

package/src/channel/observers/observeChannel.ts

@@ -30,10 +30,18 @@ import {
  * @category Channel Observer
  */
 export const observeChannel = <
-  Events extends ['onFetch', 'onUpdate', 'onDelete', 'onJoin', 'onLeft', 'onMemberAdded', 'onMemberRemoved']
+  Events extends [
+    'onFetch',
+    'onUpdate',
+    'onDelete',
+    'onJoin',
+    'onLeft',
+    'onMemberAdded',
+    'onMemberRemoved'
+  ]
 >(
   channelId: string,
-  callback: Amity.ObjectListener<Amity.QueryResult<Amity.Channel>, Events>
+  callback: Amity.ObjectListener<Amity.Snapshot<Amity.Channel>, Events>
 ): Amity.Unsubscriber => {
   const { log } = getActiveClient()
 
@@ -42,17 +50,15 @@ export const observeChannel = <
 
   // wrapper function to make sure
   const router = (
-    result: Amity.QueryResult<Amity.Channel>,
+    result: Amity.Snapshot<Amity.Channel>,
     action: Events[number]
   ) => {
     // filter function
     if (result.data?.channelId !== channelId) return
 
-    if (callback instanceof Function)
-      return callback(result)
+    if (callback instanceof Function) return callback(result)
 
-    if (action !== 'onFetch')
-      callback.onEvent?.(action, result)
+    if (action !== 'onFetch') callback.onEvent?.(action, result)
 
     callback[action]?.(result)
   }
@@ -60,17 +66,17 @@ export const observeChannel = <
   const disposers: Amity.Unsubscriber[] = []
 
   disposers.push(
-    onChannelUpdated(data => router({ data }, 'onUpdate')),
-    onChannelDeleted(data => router({ data }, 'onDelete')),
-    onChannelJoined(data => router({ data }, 'onJoin')),
-    onChannelLeft(data => router({ data }, 'onLeft')),
-    onMemberAdded(data => router({ data }, 'onMemberAdded')),
-    onMemberRemoved(data => router({ data }, 'onMemberRemoved')),
+    onChannelUpdated(data => router({ data, loading: false, origin: 'event' }, 'onUpdate')),
+    onChannelDeleted(data => router({ data, loading: false, origin: 'event' }, 'onDelete')),
+    onChannelJoined(data => router({ data, loading: false, origin: 'event' }, 'onJoin')),
+    onChannelLeft(data => router({ data, loading: false, origin: 'event' }, 'onLeft')),
+    onMemberAdded(data => router({ data, loading: false, origin: 'event' }, 'onMemberAdded')),
+    onMemberRemoved(data => router({ data, loading: false, origin: 'event' }, 'onMemberRemoved'))
   )
 
   runQuery(
     createQuery(getChannel, channelId),
-    result => result.data && router(result, 'onFetch'),
+    result => result.data && router(result, 'onFetch')
   )
 
   return () => {

package/src/client/api/connectClient.ts

@@ -1,3 +1,4 @@
+import { disconnectClient } from '~/client/api/disconnectClient'
 import { getDeviceId } from '~/core/device'
 import { proxyMqttEvents, proxyWebsocketEvents } from '~/core/events'
 
@@ -40,7 +41,7 @@ export const connectClient = async (params: {
 
   // @ts-ignore: in that particular case, typing can be
   // ignored since we enforce default values just before.
-  const { accessToken } = await getToken(params)
+  const { accessToken, users } = await getToken(params)
 
   // manually setup the token for http transport
   client.http.defaults.headers.common['Authorization'] = `Bearer ${accessToken}`
@@ -48,14 +49,11 @@ export const connectClient = async (params: {
   // manually setup the token for ws transport
   client.ws.io.opts.query = {token: accessToken}
 
+  // FIXME: events are duplicated if connectClient is called few times without disconnectClient
   // wire websocket events to our event emitter
   proxyWebsocketEvents(client.ws, client.emitter)
 
-  // TODO connect on demand
-  await client.mqtt.connect({ accessToken, userId: params.userId })
-  proxyMqttEvents(client.mqtt, client.emitter)
-
-  // TODO: in phase 2, this should not be necessary. we should have WS, MQTT
+  // TODO: in phase 2, this should not be necessary. we should have WS
   // to be connected "on demand" rather than "by default"
   await new Promise(resolve => {
     client.ws.once('connect', resolve)
@@ -63,11 +61,13 @@ export const connectClient = async (params: {
   })
 
   const unsubscribe = onClientBanned(() => {
-    client.mqtt.disconnect()
+    disconnectClient()
     unsubscribe()
   })
 
   client.userId = params.userId
+  client.user = users[0]
+  client.accessToken = accessToken
 
   return client.ws.connected
 }

package/src/client/api/disconnectClient.ts

@@ -25,9 +25,12 @@ export const disconnectClient = async (): Promise<boolean> => {
   })
 
   client.emitter.all.clear()
+  // FIXME: it removes listener in ws.ts, it breaks global ban event
   client.ws.removeAllListeners()
   client.mqtt.removeAllListeners()
   client.userId = undefined
+  client.user = undefined
+  client.accessToken = undefined
 
   return !client.ws.connected
 }

package/src/client/api/getToken.ts

@@ -1,6 +1,6 @@
 import { getActiveClient } from './activeClient'
 
-import { getDeviceId, getDeviceInfo } from '~/core/device'
+import { getDeviceInfo } from '~/core/device'
 
 /**
  * Retrieves a pair of {@link Amity.Tokens} necessary for connection
@@ -25,9 +25,10 @@ export const getToken = async (params: {
 
   const deviceInfo = await getDeviceInfo()
 
-  const { data } = await client.http.post<Amity.Tokens>('/v1/device', {
+  const { data } = await client.http.post<Amity.Tokens & { users: Amity.User[] }>('/v1/device', {
     ...params, deviceInfo,
   } , {
+    //@ts-ignore
     headers: { 'X-API-Key': client.apiKey }
   })
 

package/src/client/api/index.ts

@@ -1,7 +1,8 @@
 export { getActiveClient } from './activeClient'
+
 export * from './createClient'
+
 export * from './connectClient'
 export * from './disconnectClient'
+
 export * from './isConnected'
-export * from './enableCache'
-export * from './clearCache'

package/src/comment/api/createComment.ts

@@ -1,7 +1,6 @@
 import { getActiveClient } from '~/client/api'
 
-import { decoratePayload } from '~/core/query'
-import { ingestInCache, mutateCache } from '~/core/cache'
+import { ingestInCache } from '~/cache/api/ingestInCache'
 import { fireEvent } from '~/core/events'
 
 import { getPost } from '~/post/api/getPost'
@@ -22,7 +21,7 @@ import { getPost } from '~/post/api/getPost'
  */
 export const createComment = async <T extends Amity.CommentContentType>(
   bundle: Pick<Amity.Comment<T>, 'referenceType' | 'referenceId' | 'parentId' | 'data' | 'metadata'>,
-) => {
+): Promise<Amity.Cached<Amity.Comment>> => {
   const client = getActiveClient()
   client.log('comment/createComment', bundle)
 
@@ -30,14 +29,18 @@ export const createComment = async <T extends Amity.CommentContentType>(
     '/api/v3/comments', bundle,
   )
 
-  decoratePayload(data)
-  ingestInCache(data)
+
+  const cachedAt = client.cache && Date.now()
+  if (client.cache) ingestInCache(data, { cachedAt })
 
   const post = await getPost(bundle.referenceId)
 
-  fireEvent('post.updated', { posts: [post] })
+  fireEvent('post.updated', { posts: [post.data] })
   fireEvent('comment.created', data)
 
   const { comments } = data
-  return comments[0]
+  return {
+    data: comments[0],
+    cachedAt,
+  }
 }

package/src/comment/api/deleteComment.ts

@@ -1,9 +1,10 @@
 import { getActiveClient } from '~/client/api'
+
+import { dropFromCache } from '~/cache/api'
+import { upsertInCache } from '~/cache/api'
 import { fireEvent } from '~/core/events'
-import { dropFromCache, mergeInCache } from '~/core/cache'
 
 import { getComment } from './getComment'
-
 import { getPost } from '~/post/api/getPost'
 
 /**
@@ -23,7 +24,7 @@ import { getPost } from '~/post/api/getPost'
 export const deleteComment = async (
   commentId: Amity.Comment['commentId'],
   permanent: boolean = false,
-) => {
+): Promise<Amity.Comment> => {
   const client = getActiveClient()
   client.log('comment/deleteComment', commentId)
 
@@ -40,20 +41,20 @@ export const deleteComment = async (
   )
 
   // to support hard deletion
-  const deleted = { ...comment, isDeleted: true }
+  const deleted = { ...comment.data, isDeleted: true }
 
-  const post = await getPost(comment.referenceId)
+  const post = await getPost(comment.data.referenceId)
 
-  fireEvent('post.updated', { posts: [post] })
+  fireEvent('post.updated', { posts: [post.data] })
   fireEvent('comment.deleted', { comments: [deleted] })
 
 
   if (permanent) {
     setTimeout(() => {
-      dropFromCache('comment', {commentId})
+      dropFromCache(['comment', 'get', commentId], true)
     }, 0)
   } else {
-    mergeInCache('comment', {commentId, isDeleted: true})
+    upsertInCache(['comment', 'get', commentId], {isDeleted: true})
   }
 
   return deleted