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

package/src/role/api/queryRoles.ts

@@ -1,8 +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
@@ -23,11 +22,11 @@ export const queryRoles = async (query?: {
   displayName?: Amity.Role['displayName']
   sortBy?: 'displayName' | 'firstCreated' | 'lastCreated'
   page?: Amity.Page
-}) => {
+}): Promise<Amity.Cached<Amity.Paged<Amity.Role>>> => {
   const client = getActiveClient()
   client.log('role/queryRoles', query)
 
-  const { page, displayName, sortBy, ...params } = query ?? {}
+  const { page = { limit: 10 }, displayName, sortBy, ...params } = query ?? {}
 
   // API-FIX: parameters should be querystring.
   const { data } = await client.http.get<Amity.RolePayload & Amity.Pagination>(
@@ -44,17 +43,16 @@ export const queryRoles = async (query?: {
     }
   )
 
-  // unpacking
-  const { paging, ...response } = data
+  const { paging, ...payload } = data
+  const { roles } = payload
 
-  decoratePayload(response as unknown as Record<string, any[]>)
-  ingestInCache(response as unknown as Record<string, any[]>)
+  const cachedAt = client.cache && Date.now()
+  if (client.cache) ingestInCache(payload as Amity.RolePayload, { cachedAt })
 
-  const prevPage = toPage(paging.previous)
   const nextPage = toPage(paging.next)
+  const prevPage = toPage(paging.previous)
 
-  const { roles } = response
-  return { data: toRecord(roles), prevPage, nextPage }
+  return { data: roles, cachedAt, prevPage, nextPage }
 }
 
 /**

package/src/stream/api/createStream.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
@@ -19,7 +18,7 @@ import { ingestInCache } from '~/core/cache'
  */
 export const createStream = async (
   bundle: Pick<Amity.Stream, 'title' | 'thumbnailFileId' | 'description'> & { isSecure?: boolean }
-) => {
+): Promise<Amity.Cached<Amity.Stream>> => {
   const client = getActiveClient()
   client.log('stream/createStream', bundle)
 
@@ -27,9 +26,13 @@ export const createStream = async (
     '/api/v3/video-streaming', bundle,
   )
 
-  decoratePayload(data)
-  ingestInCache(data)
+  const cachedAt = client.cache && Date.now()
+  if (client.cache) ingestInCache(data, { cachedAt })
 
   const { videoStreamings } = data
-  return videoStreamings[0]!
+
+  return {
+    data: videoStreamings[0],
+    cachedAt,
+  }
 }

package/src/stream/api/deleteStream.ts

@@ -1,5 +1,9 @@
 import { getActiveClient } from '~/client/api'
 
+import { upsertInCache } from '~/cache/api'
+
+import { getStream } from './getStream'
+
 // import { unwrapPayload } from '~/core/transports'
 
 /**
@@ -18,10 +22,12 @@ import { getActiveClient } from '~/client/api'
  */
 export const deleteStream = async (
   streamId: Amity.Stream['streamId'],
-) => {
+): Promise<boolean> => {
   const client = getActiveClient()
   client.log('stream/deleteStream', streamId)
 
+  let stream = await getStream(streamId)
+
   // API-FIX: it returns { success: boolean } but seems it should be Amity.Response<{ success: boolean }
   // API-FIX: swagger docs are wrong!
   const { data } = await client.http.delete<{ success: boolean }>(
@@ -29,6 +35,9 @@ export const deleteStream = async (
   )
 
   const { success } = data // unwrapPayload(data)
+  const deleted = { ...stream.data, isDeleted: true }
+
+  upsertInCache(['stream', 'get', streamId], deleted)
 
   return success
 }

package/src/stream/api/disposeStream.ts

@@ -1,6 +1,6 @@
 import { getActiveClient } from '~/client/api'
-import { ingestInCache } from '~/core/cache'
-import { decoratePayload } from '~/core/query'
+
+import { ingestInCache } from '~/cache/api/ingestInCache'
 
 /**
  * ```js
@@ -19,7 +19,7 @@ import { decoratePayload } from '~/core/query'
  */
 export const disposeStream = async (
   streamId: Amity.Stream['streamId'],
-) => {
+): Promise<Amity.Cached<Amity.Stream>> => {
   const client = getActiveClient()
   client.log('stream/disposeStream', streamId)
 
@@ -27,9 +27,13 @@ export const disposeStream = async (
     `/api/v3/video-streaming/${streamId}/streaming-url`
   )
 
-  decoratePayload(data)
-  ingestInCache(data)
+  const cachedAt = client.cache && Date.now()
+  if (client.cache) ingestInCache(data, { cachedAt })
 
   const { videoStreamings } = data
-  return videoStreamings.find(stream => stream.streamId === streamId)!
+
+  return {
+    data: videoStreamings.find(stream => stream.streamId === streamId)!,
+    cachedAt,
+  }
 }

package/src/stream/api/getStream.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 getStream = async (
   streamId: Amity.Stream['streamId'],
-) => {
+): Promise<Amity.Cached<Amity.Stream>> => {
   const client = getActiveClient()
   client.log('stream/getStream', streamId)
 
@@ -26,12 +27,15 @@ export const getStream = async (
     `/api/v3/video-streaming/${streamId}`
   )
 
-  decoratePayload(data)
-  ingestInCache(data)
+  const cachedAt = client.cache && Date.now()
+  if (client.cache) ingestInCache(data, { cachedAt })
 
   const { videoStreamings } = data
-  return videoStreamings.find(stream => stream.streamId === streamId)!
-}
+
+  return {
+    data: videoStreamings.find(stream => stream.streamId === streamId)!,
+    cachedAt,
+  }}
 
 /**
  * ```js
@@ -48,10 +52,19 @@ export const getStream = async (
  */
  getStream.locally = (
   streamId: Amity.Stream['streamId']
-) => {
+): Amity.Cached<Amity.Stream> | undefined => {
   const client = getActiveClient()
   client.log('stream/getStream', streamId)
 
-  const [stream] = pullFromCache('stream', streamId) ?? []
-  return stream
+  if (!client.cache) return
+
+  const cached = pullFromCache<Amity.Stream>(['stream', 'get', streamId])
+
+  if (!cached)
+    return
+
+  return {
+    data: cached.data,
+    cachedAt: cached.cachedAt,
+  }
 }

package/src/stream/api/queryStreams.ts

@@ -1,8 +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
@@ -27,7 +26,7 @@ export const queryStreams = async (
     isDeleted?: Amity.Stream['isDeleted']
     page?: Amity.Page
   }
-) => {
+): Promise<Amity.Cached<Amity.Paged<Amity.Stream>>> => {
   const client = getActiveClient()
   client.log('stream/queryStreams', query)
 
@@ -44,16 +43,16 @@ export const queryStreams = async (
 
   // API-FIX: backend to response Amity.Response: const { paging, videoStreamings } = unwrapPayload(data)
   // API-FIX: seems returned data has a results identifier on top of data, like no other apis, and this is beautiful
-  const { paging, results } = data
+  const { paging, results: payload } = data
+  const { videoStreamings } = payload
 
-  decoratePayload(results as unknown as Record<string, any[]>)
-  ingestInCache(results as unknown as Record<string, any[]>)
+  const cachedAt = client.cache && Date.now()
+  if (client.cache) ingestInCache(payload as Amity.StreamPayload, { cachedAt })
 
-  const prevPage = toPage(paging?.previous)
-  const nextPage = toPage(paging?.next)
+  const nextPage = toPage(paging.next)
+  const prevPage = toPage(paging.previous)
 
-  const { videoStreamings } = results
-  return { data: toRecord(videoStreamings), prevPage, nextPage }
+  return { data: videoStreamings, cachedAt, prevPage, nextPage }
 }
 
 /**

package/src/stream/api/updateStream.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 updateStream = async (
   streamId: Amity.Stream['streamId'],
   patch: Patch<Amity.Stream, 'title' | 'thumbnailFileId' | 'description' | 'metadata'>
-) => {
+): Promise<Amity.Cached<Amity.Stream>> => {
   const client = getActiveClient()
   client.log('stream/updateStream', streamId, patch)
 
@@ -30,9 +29,13 @@ export const updateStream = async (
     patch
   )
 
-  decoratePayload(data)
-  ingestInCache(data)
+  const cachedAt = client.cache && Date.now()
+  if (client.cache) ingestInCache(data, { cachedAt })
 
   const { videoStreamings } = data
-  return videoStreamings.find(stream => stream.streamId === streamId)!
+
+  return {
+    data: videoStreamings.find(stream => stream.streamId === streamId)!,
+    cachedAt,
+  }
 }

package/src/stream/events/onStreamRecorded.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
@@ -25,7 +24,6 @@ export const onStreamRecorded = (
   const client = getActiveClient()
 
   const filter = (payload: Amity.StreamPayload) => {
-    decoratePayload(payload)
     ingestInCache(payload)
     callback(payload.videoStreamings[0])
   }

package/src/stream/events/onStreamStarted.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
@@ -25,7 +24,6 @@ export const onStreamStarted = (
   const client = getActiveClient()
 
   const filter = (payload: Amity.StreamPayload) => {
-    decoratePayload(payload)
     ingestInCache(payload)
     callback(payload.videoStreamings[0])
   }

package/src/stream/events/onStreamStopped.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
@@ -25,7 +24,6 @@ export const onStreamStopped = (
   const client = getActiveClient()
 
   const filter = (payload: Amity.StreamPayload) => {
-    decoratePayload(payload)
     ingestInCache(payload)
     callback(payload.videoStreamings[0])
   }

package/src/user/api/getUser.ts

@@ -1,12 +1,12 @@
 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
  * import { getUser } from '@amityco/ts-sdk'
- * const user = await getUser('foobar')
+ * const { data: user } = await getUser('foobar')
  * ```
  *
  * Fetches a {@link Amity.User} object
@@ -19,7 +19,7 @@ import { decoratePayload } from '~/core/query'
  */
 export const getUser = async (
   userId: Amity.User['userId'],
-) => {
+): Promise<Amity.Cached<Amity.User>> => {
   const client = getActiveClient()
   client.log('user/getUser', userId)
 
@@ -28,17 +28,21 @@ export const getUser = async (
     `/api/v3/users/${userId}`,
   )
 
-  decoratePayload(data)
-  ingestInCache(data)
+  const cachedAt = client.cache && Date.now()
+  if (client.cache) ingestInCache(data, { cachedAt })
 
   const { users } = data
-  return users.find(user => user.userId === userId)!
+
+  return {
+    data: users.find(user => user.userId === userId)!,
+    cachedAt,
+  }
 }
 
 /**
  * ```js
  * import { getUser } from '@amityco/ts-sdk'
- * const user = getUser.locally('foobar')
+ * const { data: user } = getUser.locally('foobar')
  * ```
  *
  * Fetches a {@link Amity.User} object from cache
@@ -50,10 +54,9 @@ export const getUser = async (
  */
 getUser.locally = (
   userId: Amity.User['userId'],
-) => {
+): Amity.Cached<Amity.User> | undefined => {
   const client = getActiveClient()
   client.log('user/getUser.locally', userId)
 
-  const [user] = pullFromCache('user', userId) ?? []
-  return user
+  return client.cache && pullFromCache<Amity.User>(['user', 'get', userId])
 }

package/src/user/api/getUsers.ts

@@ -1,13 +1,12 @@
 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
  * import { getUsers } from '@amityco/ts-sdk'
- * const users = await getUsers(['foo', 'bar'])
+ * const { data: users } = await getUsers(['foo', 'bar'])
  * ```
  *
  * Fetches a collection of {@link Amity.User} objects
@@ -20,7 +19,7 @@ import { toRecord } from '~/core/model'
  */
 export const getUsers = async (
   userIds: Amity.User['userId'][],
-) => {
+): Promise<Amity.Cached<Amity.User[]>> => {
   const client = getActiveClient()
   client.log('user/getUsers', userIds)
 
@@ -30,17 +29,19 @@ export const getUsers = async (
     { params: { userIds } },
   )
 
-  decoratePayload(data)
-  ingestInCache(data)
+  const cachedAt = client.cache && Date.now()
+  if (client.cache) ingestInCache(data, { cachedAt })
 
-  const { users } = data
-  return toRecord(users)
+  return {
+    data: data.users,
+    cachedAt
+  }
 }
 
 /**
  * ```js
  * import { getUsers } from '@amityco/ts-sdk'
- * const users = getUsers.locally!(['foo', 'bar'])
+ * const { data: users } = getUsers.locally!(['foo', 'bar'])
  * ```
  *
  * Fetches a collection of {@link Amity.User} objects from cache
@@ -52,9 +53,24 @@ export const getUsers = async (
  */
 getUsers.locally = (
   userIds: Amity.User['userId'][],
-) => {
-  const cached = pullFromCache('user', ...userIds) ?? []
+): Amity.Cached<Amity.User[]> | undefined => {
+  const client = getActiveClient()
+  client.log('user/getUsers.locally', userIds)
+
+  if (!client.cache) return
+
+  const cached = userIds
+    .map(userId => pullFromCache<Amity.User>(['user', 'get', userId])!)
+    .filter(Boolean)
+
+  const users = cached.map(({ data }) => data)
+  const oldest = cached.sort((a, b) => a.cachedAt! < b.cachedAt! ? -1 : 1)?.[0]
+
+  if (cached?.length < userIds.length)
+    return
 
-  if (cached?.length === userIds.length)
-    return toRecord(cached)
+  return {
+    data: users,
+    cachedAt: oldest.cachedAt,
+  }
 }

package/src/user/api/queryUsers.ts

@@ -1,13 +1,15 @@
 import { getActiveClient } from '~/client/api'
 
-import { decoratePayload, toPage, toToken } from '~/core/query'
-import { ingestInCache, pullFromCache } from '~/core/cache'
-import { toRecord } from '~/core/model'
+import { toPage, toToken } from '~/core/query'
+
+import { pullFromCache, pushToCache } from '~/cache/api'
+import { ingestInCache } from '~/cache/api/ingestInCache'
+import { getResolver } from '~/core/model'
 
 /**
  * ```js
  * import { queryUsers } from '@amityco/ts-sdk'
- * const { users, previous, next } = await queryUsers({ keyword: 'foo' })
+ * const { data: users, prevPage, nextPage } = await queryUsers({ displayName: 'foo' })
  * ```
  *
  * Queries a paginable list of {@link Amity.User} objects
@@ -20,13 +22,13 @@ import { toRecord } from '~/core/model'
  * @async
  */
 export const queryUsers = async (
-  query?: {
+  query: {
     displayName?: Amity.User['displayName']
     filter?: 'all' | 'flagged'
     sortBy?: 'displayName' | 'firstCreated' | 'lastCreated'
     page?: Amity.Page
-  }
-) => {
+  } = {}
+): Promise<Amity.Cached<Amity.Paged<Amity.User>>> => {
   const client = getActiveClient()
   client.log('user/queryUsers', query)
 
@@ -36,7 +38,7 @@ export const queryUsers = async (
     filter = 'all',
     sortBy = 'displayName',
     ...params
-  } = query ?? {}
+  } = query
 
   // API-FIX: parameters should be querystring.
   const { data } = await client.http.get<Amity.UserPayload & Amity.Pagination>(
@@ -52,22 +54,28 @@ export const queryUsers = async (
   )
 
   // unpacking
-  const { paging, ...response } = data
+  const { paging, ...payload } = data
+  const { users } = 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.UserPayload, { cachedAt })
+
+    const cacheKey = ['user', 'query', query as Amity.Serializable]
+    pushToCache(cacheKey, { users: users.map(getResolver('user')), paging })
+  }
 
   const prevPage = toPage(paging.previous)
   const nextPage = toPage(paging.next)
 
-  const { users } = response
-  return { data: toRecord(users), prevPage, nextPage }
+  return { data: users, cachedAt, prevPage, nextPage }
 }
 
 /**
  * ```js
  * import { queryUsers } from '@amityco/ts-sdk'
- * const users = queryUsers.locally({ keyword: 'foo' })
+ * const { data: users } = queryUsers.locally({ keyword: 'foo' })
  * ```
  *
  * Queries a paginable list of {@link Amity.User} objects from cache
@@ -79,10 +87,25 @@ export const queryUsers = async (
  * @category User API
  */
 queryUsers.locally = (
-  query: Parameters<typeof queryUsers>[0],
-) => {
+  query: Parameters<typeof queryUsers>[0] = {},
+): Amity.Cached<Amity.Paged<Amity.User>> | undefined => {
   const client = getActiveClient()
   client.log('user/queryUsers.locally', query)
 
-  // TODO
+  if (!client.cache) return
+
+  const queryKey = ['user', 'query', query as Amity.Serializable];
+  const { data, cachedAt } = pullFromCache<{users: Pick<Amity.User, 'userId'>[]} & Amity.Pagination>(queryKey) ?? {}
+
+  const users: Amity.User[] = data?.users
+    .map(userId => pullFromCache<Amity.User>(['user', 'get', userId])!)
+    .filter(Boolean)
+    .map(({ data }) => data) ?? []
+
+  const prevPage = toPage(data?.paging.previous)
+  const nextPage = toPage(data?.paging.next)
+
+  return users.length > 0 && users.length === data?.users?.length
+    ? { data: users, cachedAt, prevPage, nextPage }
+    : undefined
 }

package/src/user/api/updateUser.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 updateUser = async (
   userId: Amity.User['userId'],
   patch: Patch<Amity.User, 'displayName' | 'description' | 'avatarFileId' | 'metadata'>,
-) => {
+): Promise<Amity.Cached<Amity.User>> => {
   const client = getActiveClient()
   client.log('user/updateUser', userId, patch)
 
@@ -36,9 +35,13 @@ export const updateUser = async (
     `/api/v3/users/`, { userId, ...patch, createNewUserWhenNotFound: false },
   )
 
-  decoratePayload(data)
-  ingestInCache(data)
-  // no need for event, fired by server
+  const cachedAt = client.cache && Date.now()
+  if (client.cache) ingestInCache(data, { cachedAt })
 
-  return data.users.find(user => user.userId === userId)!
+  const { users } = data
+
+  return {
+    data: users.find(user => user.userId === userId)!,
+    cachedAt,
+  }
 }

package/src/user/events/onUserFlagCleared.ts

@@ -8,7 +8,7 @@ import { createUserEventSubscriber } from './utils'
  * })
  * ```
  *
- * Fired when any {@link Amity.User} have been updated
+ * Fired when flags have been cleared for a {@link Amity.User}
  *
  * @param callback The function to call when the event was fired
  * @returns an {@link Amity.Unsubscriber} function to stop listening

package/src/user/events/onUserFlagged.ts

@@ -8,7 +8,7 @@ import { createUserEventSubscriber } from './utils'
  * })
  * ```
  *
- * Fired when any {@link Amity.User} have been updated
+ * Fired when a {@link Amity.User} has been flagged
  *
  * @param callback The function to call when the event was fired
  * @returns an {@link Amity.Unsubscriber} function to stop listening

package/src/user/events/onUserUnflagged.ts

@@ -8,7 +8,7 @@ import { createUserEventSubscriber } from './utils'
  * })
  * ```
  *
- * Fired when any {@link Amity.User} have been updated
+ * Fired when a flag has been removed from a {@link Amity.User}
  *
  * @param callback The function to call when the event was fired
  * @returns an {@link Amity.Unsubscriber} function to stop listening