@amityco/ts-sdk 0.0.1-beta.12 → 0.0.1-beta.15

package/src/core/query/paging.ts

@@ -1,4 +1,3 @@
-// @ts-ignore
 import { encode, decode } from 'js-base64'
 
 /**
@@ -22,7 +21,7 @@ export const isSkipLimit = (json: Object): json is Amity.SkipLimitPagination =>
  * @hidden
  */
 export const isAfterBefore = (json: Object): json is Amity.AfterBeforePagination => (
-  ['after', 'before', 'first', 'last'].some(prop => prop in json)
+  ['after', 'before', 'first', 'last', 'limit'].some(prop => prop in json)
 )
 
 /**
@@ -34,7 +33,7 @@ export const isAfterBefore = (json: Object): json is Amity.AfterBeforePagination
  * @hidden
  */
 export const isAfterBeforeRaw = (json: Object): json is Amity.AfterBeforeRawPagination => (
-  ['after', 'before'].some(prop => prop in json)
+  'limit' in json
 )
 
 /**
@@ -63,9 +62,8 @@ export const isPaged = <T extends unknown>(payload: any): payload is Amity.Paged
  * @hidden
  */
 export const toToken = (
-  paging: Amity.Page | undefined,
-  style: 'skiplimit' | 'afterbefore' | 'afterbeforeraw',
-
+  paging: Amity.Page | Amity.PageRaw | undefined,
+  style: Amity.PaginationStyles,
 ): Amity.Token | undefined => {
   if (!paging || !Object.keys(paging).length)
     return
@@ -79,7 +77,7 @@ export const toToken = (
       limit: paging.limit,
     }
   }
-  else if (style === 'afterbefore') {
+  else if (style === 'afterbefore' && isAfterBefore(paging)) {
     /*
       Caution: this testing style is only valid because
       our backend expects nothing else than a number as
@@ -114,6 +112,7 @@ export const toToken = (
   return encode(JSON.stringify(payload))
 }
 
+
 /**
  * Converts a b64 string token into a paging object
  *
@@ -170,37 +169,3 @@ export const toPageRaw = (token?: Amity.Token): Amity.PageRaw | null => {
 
   return null
 }
-
-/**
- * Slices a collection according to its paging
- *
- * @param type the type of collection (for unique id identification with after/before)
- * @param collection the collection to slice
- * @param paging the paging object
- * @returns the sliced collection according to the paging definition
- *
- * @hidden
- */
-export const sliceByPaging = <K extends Amity.Domain, T extends Amity.Model[K]>(
-  type: K, collection: T[], page?: Amity.Page
-) => {
-  console.log('slice by paging', page)
-  if (!page) return collection.slice()
-
-  let start: number | undefined = 0
-  let end: number | undefined = undefined
-
-  // next page behavior
-  if (page.after) {
-    start = page.after
-    end = start + page.limit
-  // prev page behavior
-  } else if (page.before) {
-    end = page.before + 1
-    start = end > page.limit ? end - page.limit : 0
-  }
-
-  const paged = collection.slice(start, end)
-
-  return paged.length === page.limit ? paged : undefined
-}

package/src/core/query/query.ts

@@ -170,7 +170,7 @@ const isEmpty = (local: any) => {
  */
 export const runQuery = <Args extends any[], Returned extends any>(
   { func, args }: Amity.Query<Args, Returned>,
-  callback?: (args: Amity.Snapshot<Returned | undefined>) => void,
+  callback?: (args: Amity.Snapshot<Returned>) => void,
   options: Amity.QueryOptions = queryOptions('cache_then_server')
 ) => {
   let local: Returned | undefined
@@ -193,7 +193,7 @@ export const runQuery = <Args extends any[], Returned extends any>(
 
     const shouldAbort = isCachable(local) && isFresh(local, options.lifeSpan)
 
-    callback?.(createSnapshot(local , {
+    callback?.(createSnapshot<Returned>(local , {
       origin: 'local',
       loading: !(isFetcher(func) && shouldAbort)
     }))
@@ -201,7 +201,7 @@ export const runQuery = <Args extends any[], Returned extends any>(
     if (shouldAbort)
       return
   } else {
-    callback?.(createSnapshot(undefined, {
+    callback?.(createSnapshot<Returned>(undefined, {
       origin: 'local',
       loading: true
     }))
@@ -213,7 +213,7 @@ export const runQuery = <Args extends any[], Returned extends any>(
 //      isLocal(local) && syncInCache(local, fresh)
 
       callback?.(
-        createSnapshot(fresh, {
+        createSnapshot<Returned>(fresh, {
           origin: 'server',
           loading: false,
         })
@@ -221,7 +221,7 @@ export const runQuery = <Args extends any[], Returned extends any>(
     })
     .catch(error => {
       callback?.(
-        createSnapshot(undefined, {
+        createSnapshot<Returned>(undefined, {
           origin: 'server',
           loading: false,
           error,

package/src/core/subscription.ts

@@ -61,13 +61,13 @@ export function subscribeTopic(
   topic: string,
   callback?: Amity.Listener<ASCError | void>
 ): Amity.Unsubscriber {
-  const { mqtt, emitter, accessToken, user } = getActiveClient()
+  const { mqtt, emitter, accessToken, _internalUserId } = getActiveClient()
 
-  if (mqttAccessToken !== accessToken || mqttUserId !== user!._id) {
+  if (mqttAccessToken !== accessToken || mqttUserId !== _internalUserId) {
     mqttAccessToken = accessToken!
-    mqttUserId = user!._id
+    mqttUserId = _internalUserId!
 
-    mqtt.connect({ accessToken: accessToken!, userId: user!._id })
+    mqtt.connect({ accessToken: mqttAccessToken, userId: mqttUserId })
     proxyMqttEvents(mqtt, emitter)
   }
 

package/src/feed/api/queryGlobalFeed.ts

@@ -2,6 +2,8 @@ import { getActiveClient } from '~/client/api/activeClient'
 
 import { toPage, toToken } from '~/core/query'
 import { ingestInCache } from '~/cache/api/ingestInCache'
+import { pullFromCache, pushToCache } from '~/cache/api'
+import { getResolver } from '~/core/model'
 
 /**
  * ```js
@@ -19,15 +21,16 @@ import { ingestInCache } from '~/cache/api/ingestInCache'
  **/
 export const queryGlobalFeed = async (query?: {
   dataTypes?: ('video' | 'image' | 'file' | 'liveStream')[]
+  useCustomRanking?: boolean
   page?: Amity.Page
-}): Promise<Amity.Paged<Amity.Post>> => {
+}): Promise<Amity.Cached<Amity.Paged<Amity.Post>>> => {
   const client = getActiveClient()
   client.log('feed/queryGlobalFeed', query)
 
-  const { page, ...params } = query ?? {}
+  const { useCustomRanking, page, ...params } = query ?? {}
 
   const { data } = await client.http.get<Amity.PostPayload & Amity.Pagination>(
-    `/api/v4/me/global-feeds`, { params: {
+    useCustomRanking ? `/api/v5/me/global-feeds` : `/api/v4/me/global-feeds`, { params: {
       ...params,
       options: {
         token: toToken(page, 'skiplimit')
@@ -38,10 +41,60 @@ export const queryGlobalFeed = async (query?: {
   const { paging, ...payload } = data
   const { posts } = payload
 
-  if (client.cache) ingestInCache(payload as Amity.PostPayload)
+  const cachedAt = client.cache && Date.now()
+
+  if (client.cache) {
+    ingestInCache(payload as Amity.PostPayload)
+
+    const cacheKey = ['globalFeed', 'query', { ...params, useCustomRanking, options: { ...page } } as Amity.Serializable]
+    pushToCache(cacheKey, { posts: posts.map(getResolver('post')), paging })
+  }
 
   const nextPage = toPage(paging.next)
   const prevPage = toPage(paging.previous)
 
-  return { data: posts, prevPage, nextPage }
+  return { data: posts, cachedAt, prevPage, nextPage }
+}
+
+/**
+ * ```js
+ * import { queryGlobalFeed } from '@amityco/ts-sdk'
+ * const posts = await queryGlobalFeed.locally()
+ * ```
+ *
+ * Queries a paginable list of {@link Amity.Post} objects from cache
+ *
+ * @param query The query parameters
+ * @returns A page of {@link Amity.Post} objects
+ *
+ * @category Feed API
+ * @async
+ **/
+queryGlobalFeed.locally = (
+  query: Parameters<typeof queryGlobalFeed>[0],
+): Amity.Cached<Amity.Paged<Amity.Post>> | undefined => {
+  const client = getActiveClient()
+  client.log('post/queryGlobalFeed.locally', query)
+
+  if (!client.cache) return
+
+  const { useCustomRanking, page, ...params } = query ?? {}
+
+  const queryKey = ['globalFeed', 'query', { ...params, useCustomRanking, options: { ...page }} as Amity.Serializable];
+  const { data, cachedAt } = pullFromCache<{ posts: string[] } & Amity.Pagination>(queryKey) ?? {}
+
+  if (!data?.posts.length)
+    return
+
+  const posts: Amity.Post[] = data.posts
+    .map(postId => pullFromCache<Amity.Post>(['post', 'get', postId])!)
+    .filter(Boolean)
+    .map(({ data }) => data)
+
+  const prevPage = toPage(data?.paging.previous)
+  const nextPage = toPage(data?.paging.next)
+
+  return posts.length === data?.posts?.length
+    ? { data: posts, cachedAt, prevPage, nextPage }
+    : undefined
 }

package/src/index.ts

@@ -10,6 +10,7 @@ export * from './cache/api'
 
 export * from './client/api'
 export * from './client/events'
+export { API_REGIONS } from './client/utils/endpoints'
 
 // asc core
 export * from './user/api'

package/src/message/api/createMessage.ts

@@ -24,7 +24,7 @@ import { fireEvent } from '~/core/events'
  * @async
  */
 export const createMessage = async <T extends Amity.MessageContentType>(
-  bundle: Pick<Amity.Message<T>, 'channelId' | 'type' | 'data' | 'metadata'>
+  bundle: Pick<Amity.Message<T>, 'channelId' | 'type' | 'data' | 'metadata' | 'mentionees'>
 ): Promise<Amity.Cached<Amity.Message>> => {
   const client = getActiveClient()
   client.log('user/createMessage', bundle)
@@ -62,7 +62,7 @@ export const createMessage = async <T extends Amity.MessageContentType>(
  * @category Message API
  */
 createMessage.optimistically = (
-  bundle: Pick<Amity.Message, 'channelId' | 'type' | 'data' | 'metadata'>
+  bundle: Pick<Amity.Message, 'channelId' | 'type' | 'data' | 'metadata' | 'mentionees'>
 ): Amity.Cached<Amity.Message> | undefined => {
   const client = getActiveClient()
   client.log('user/createMessage.locally', bundle)

package/src/message/api/updateMessage.ts

@@ -23,7 +23,7 @@ import { fireEvent } from '~/core/events'
  */
 export const updateMessage = async (
   messageId: Amity.Message['messageId'],
-  patch: Patch<Amity.Message, 'data' | 'metadata'>,
+  patch: Patch<Amity.Message, 'data' | 'metadata' | 'mentionees'>,
 ): Promise<Amity.Cached<Amity.Message>> => {
   const client = getActiveClient()
   client.log('user/updateMessage', patch)
@@ -61,7 +61,7 @@ export const updateMessage = async (
  */
 updateMessage.optimistically = (
   messageId: Amity.Message['messageId'],
-  patch: Patch<Amity.Message, 'data' | 'metadata'>,
+  patch: Patch<Amity.Message, 'data' | 'metadata' | 'mentionees'>,
 ): Amity.Cached<Amity.Message> | undefined => {
   const client = getActiveClient()
   client.log('user/updateMessage', patch)

package/src/post/api/createPost.ts

@@ -22,19 +22,21 @@ import { fireEvent } from '~/core/events'
  * @async
  */
 export const createPost = async <T extends Amity.PostContentType | string>(
-  bundle: Pick<Amity.Post, 'targetType' | 'targetId' | 'metadata'> & {
-    dataType?: T, data: { [k: string]: any }
+  bundle: Pick<Amity.Post, 'targetType' | 'targetId' | 'metadata' | 'mentionees'> & {
+    dataType?: T,
+    data?: { [k: string]: any },
+    attachments?: { type: T, fileId: Amity.File['fileId'] }[]
   },
 ): Promise<Amity.Cached<Amity.Post>> => {
   const client = getActiveClient()
   client.log('post/createPost', bundle)
 
   // API-FIX: backend rejects that we pass the dataType manually T_T
-  if (!bundle.dataType || ['text', 'image', 'file'].includes(bundle.dataType))
+  if (!bundle.dataType || ['text', 'image', 'file', 'video'].includes(bundle.dataType))
     delete bundle.dataType
 
   const { data } = await client.http.post<Amity.PostPayload>(
-    '/api/v3/posts', bundle
+    '/api/v4/posts', bundle
   )
 
   const cachedAt = client.cache && Date.now()

package/src/post/api/queryPosts.ts

@@ -1,6 +1,6 @@
 import { getActiveClient } from '~/client/api'
 
-import { toPageRaw, toToken } from '~/core/query'
+import { toToken, toPageRaw } from '~/core/query'
 
 import { pullFromCache, pushToCache } from '~/cache/api'
 import { ingestInCache } from '~/cache/api/ingestInCache'
@@ -31,9 +31,9 @@ export const queryPosts = async (
     feedType?: 'reviewing' | 'published'
     tags?: Amity.Taggable['tags'],
     matchingOnlyParentPost?: boolean
-    page?: Amity.Page
+    page?: Amity.PageRaw
   }
-): Promise<Amity.Cached<Amity.PagedRaw<Amity.Post>>> => {
+): Promise<Amity.Cached<Amity.Paged<Amity.Post>>> => {
   const client = getActiveClient()
   client.log('post/queryPosts', query)
 
@@ -41,7 +41,7 @@ export const queryPosts = async (
 
   // API-FIX: parameters should be querystring. (1)
   // API-FIX: backend should answer Amity.Response (2)
-  // const { data } = await client.http.get<Amity.Response<Amity.PagedRawResponse<Amity.PostPayload>>>(
+  // const { data } = await client.http.get<Amity.Response<Amity.PagedResponse<Amity.PostPayload>>>(
   const { data } = await client.http.get<Amity.PostPayload & Amity.Pagination>(
     `/api/v4/posts`, { params: {
       ...params,
@@ -87,7 +87,7 @@ export const queryPosts = async (
  */
 queryPosts.locally = (
   query: Parameters<typeof queryPosts>[0],
-): Amity.Cached<Amity.PagedRaw<Amity.Post>> | undefined => {
+): Amity.Cached<Amity.Paged<Amity.Post>> | undefined => {
   const client = getActiveClient()
   client.log('post/queryPosts.locally', query)
 

package/src/post/api/updatePost.ts

@@ -22,13 +22,13 @@ import { fireEvent } from '~/core/events'
  */
 export const updatePost = async (
   postId: Amity.Post['postId'],
-  patch: Patch<Amity.Post, 'data' | 'metadata'>,
+  patch: Patch<Amity.Post, 'data' | 'metadata' | 'mentionees'>,
 ): Promise<Amity.Cached<Amity.Post>> => {
   const client = getActiveClient()
   client.log('user/updatePost', patch)
 
   const { data } = await client.http.put<Amity.PostPayload>(
-    `/api/v3/posts/${encodeURIComponent(postId)}`, patch,
+    `/api/v4/posts/${encodeURIComponent(postId)}`, patch,
   )
 
   const cachedAt = client.cache && Date.now()

package/src/utils/env.ts

@@ -0,0 +1,7 @@
+const theGlobal = globalThis || global || window;
+
+export const { process: safeProcess = {} }: { process: Partial<NodeJS.Process> } = theGlobal
+
+export function getEnv() { return safeProcess.env ?? {} }
+
+export const isProduction = safeProcess.env?.NODE_ENV === 'production'

package/src/version.ts

@@ -1,2 +1,4 @@
 // used in createClient
-export const VERSION = process.env.VERSION ?? '__dev__'
+import { safeProcess } from '~/utils/env'
+
+export const VERSION = safeProcess.env?.VERSION ?? '__dev__'

package/dist/core/network.d.ts

@@ -1,11 +0,0 @@
-export declare const API_ENDPOINT: {
-    readonly EU: "eu";
-    readonly SG: "sg";
-    readonly US: "us";
-};
-export declare enum UrlTemplate {
-    HTTP = "https://api.{region}.amity.co",
-    MQTT = "wss://sse.{region}.amity.co:443/mqtt"
-}
-export declare const getUrlFromTemplate: (template: UrlTemplate, region: string) => string;
-//# sourceMappingURL=network.d.ts.map

package/dist/core/network.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"network.d.ts","sourceRoot":"","sources":["../../src/core/network.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,YAAY;;;;CAIf,CAAA;AAEV,oBAAY,WAAW;IACrB,IAAI,kCAAkC;IACtC,IAAI,yCAAyC;CAC9C;AAED,eAAO,MAAM,kBAAkB,aAAe,WAAW,UAAU,MAAM,WAExE,CAAA"}

package/src/core/network.ts

@@ -1,14 +0,0 @@
-export const API_ENDPOINT = {
-  EU: 'eu',
-  SG: 'sg',
-  US: 'us',
-} as const
-
-export enum UrlTemplate {
-  HTTP = 'https://api.{region}.amity.co',
-  MQTT = 'wss://sse.{region}.amity.co:443/mqtt',
-}
-
-export const getUrlFromTemplate = ( template: UrlTemplate, region: string ) => {
-  return template.replace( '{region}', region);
-}