@amityco/ts-sdk 0.0.1-beta.13 → 0.0.1-beta.16

package/dist/message/api/createMessage.d.ts

@@ -16,7 +16,7 @@
  * @async
  */
 export declare const createMessage: {
-    <T extends Amity.MessageContentType>(bundle: Pick<Amity.Message<T>, "type" | "channelId" | "data" | "metadata">): Promise<Amity.Cached<Amity.Message>>;
+    <T extends Amity.MessageContentType>(bundle: Pick<Amity.Message<T>, "type" | "channelId" | "data" | "metadata" | "mentionees">): Promise<Amity.Cached<Amity.Message>>;
     /**
      * ```js
      * import { createMessage } from '@amityco/ts-sdk'
@@ -33,6 +33,6 @@ export declare const createMessage: {
      *
      * @category Message API
      */
-    optimistically(bundle: Pick<Amity.Message, 'channelId' | 'type' | 'data' | 'metadata'>): Amity.Cached<Amity.Message> | undefined;
+    optimistically(bundle: Pick<Amity.Message, 'channelId' | 'type' | 'data' | 'metadata' | 'mentionees'>): Amity.Cached<Amity.Message> | undefined;
 };
 //# sourceMappingURL=createMessage.d.ts.map

package/dist/message/api/createMessage.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"createMessage.d.ts","sourceRoot":"","sources":["../../../src/message/api/createMessage.ts"],"names":[],"mappings":"AAQA;;;;;;;;;;;;;;;;GAgBG;AACH,eAAO,MAAM,aAAa;sHAEvB,QAAQ,MAAM,MAAM,CAAC,MAAM,OAAO,CAAC,CAAC;IAoBvC;;;;;;;;;;;;;;;OAeG;2BAEO,KAAK,MAAM,OAAO,EAAE,WAAW,GAAG,MAAM,GAAG,MAAM,GAAG,UAAU,CAAC,GACtE,MAAM,MAAM,CAAC,MAAM,OAAO,CAAC,GAAG,SAAS;CApBzC,CAAA"}
+{"version":3,"file":"createMessage.d.ts","sourceRoot":"","sources":["../../../src/message/api/createMessage.ts"],"names":[],"mappings":"AAQA;;;;;;;;;;;;;;;;GAgBG;AACH,eAAO,MAAM,aAAa;qIAEvB,QAAQ,MAAM,MAAM,CAAC,MAAM,OAAO,CAAC,CAAC;IAoBvC;;;;;;;;;;;;;;;OAeG;2BAEO,KAAK,MAAM,OAAO,EAAE,WAAW,GAAG,MAAM,GAAG,MAAM,GAAG,UAAU,GAAG,YAAY,CAAC,GACrF,MAAM,MAAM,CAAC,MAAM,OAAO,CAAC,GAAG,SAAS;CApBzC,CAAA"}

package/dist/message/api/updateMessage.d.ts

@@ -16,7 +16,7 @@
  * @async
  */
 export declare const updateMessage: {
-    (messageId: Amity.Message['messageId'], patch: Patch<Amity.Message, 'data' | 'metadata'>): Promise<Amity.Cached<Amity.Message>>;
+    (messageId: Amity.Message['messageId'], patch: Patch<Amity.Message, 'data' | 'metadata' | 'mentionees'>): Promise<Amity.Cached<Amity.Message>>;
     /**
      * ```js
      * import { updateMessage } from '@amityco/ts-sdk'
@@ -33,6 +33,6 @@ export declare const updateMessage: {
      *
      * @category Message API
      */
-    optimistically(messageId: Amity.Message['messageId'], patch: Patch<Amity.Message, 'data' | 'metadata'>): Amity.Cached<Amity.Message> | undefined;
+    optimistically(messageId: Amity.Message['messageId'], patch: Patch<Amity.Message, 'data' | 'metadata' | 'mentionees'>): Amity.Cached<Amity.Message> | undefined;
 };
 //# sourceMappingURL=updateMessage.d.ts.map

package/dist/message/api/updateMessage.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"updateMessage.d.ts","sourceRoot":"","sources":["../../../src/message/api/updateMessage.ts"],"names":[],"mappings":"AAMA;;;;;;;;;;;;;;;;GAgBG;AACH,eAAO,MAAM,aAAa;gBACb,MAAM,OAAO,CAAC,WAAW,CAAC,SAC9B,MAAM,MAAM,OAAO,EAAE,MAAM,GAAG,UAAU,CAAC,GAC/C,QAAQ,MAAM,MAAM,CAAC,MAAM,OAAO,CAAC,CAAC;IAmBvC;;;;;;;;;;;;;;;OAeG;8BAEU,MAAM,OAAO,CAAC,WAAW,CAAC,SAC9B,MAAM,MAAM,OAAO,EAAE,MAAM,GAAG,UAAU,CAAC,GAC/C,MAAM,MAAM,CAAC,MAAM,OAAO,CAAC,GAAG,SAAS;CArBzC,CAAA"}
+{"version":3,"file":"updateMessage.d.ts","sourceRoot":"","sources":["../../../src/message/api/updateMessage.ts"],"names":[],"mappings":"AAMA;;;;;;;;;;;;;;;;GAgBG;AACH,eAAO,MAAM,aAAa;gBACb,MAAM,OAAO,CAAC,WAAW,CAAC,SAC9B,MAAM,MAAM,OAAO,EAAE,MAAM,GAAG,UAAU,GAAG,YAAY,CAAC,GAC9D,QAAQ,MAAM,MAAM,CAAC,MAAM,OAAO,CAAC,CAAC;IAmBvC;;;;;;;;;;;;;;;OAeG;8BAEU,MAAM,OAAO,CAAC,WAAW,CAAC,SAC9B,MAAM,MAAM,OAAO,EAAE,MAAM,GAAG,UAAU,GAAG,YAAY,CAAC,GAC9D,MAAM,MAAM,CAAC,MAAM,OAAO,CAAC,GAAG,SAAS;CArBzC,CAAA"}

package/dist/post/api/queryPosts.d.ts

@@ -23,8 +23,8 @@ export declare const queryPosts: {
         feedType?: 'reviewing' | 'published';
         tags?: Amity.Taggable['tags'];
         matchingOnlyParentPost?: boolean;
-        page?: Amity.Page;
-    }): Promise<Amity.Cached<Amity.PagedRaw<Amity.Post>>>;
+        page?: Amity.PageRaw;
+    }): Promise<Amity.Cached<Amity.Paged<Amity.Post, Amity.PageRaw>>>;
     /**
      * ```js
      * import { queryPosts } from '@amityco/ts-sdk'
@@ -38,6 +38,6 @@ export declare const queryPosts: {
      *
      * @category Post API
      */
-    locally(query: Parameters<typeof queryPosts>[0]): Amity.Cached<Amity.PagedRaw<Amity.Post>> | undefined;
+    locally(query: Parameters<typeof queryPosts>[0]): Amity.Cached<Amity.Paged<Amity.Post, Amity.PageRaw>> | undefined;
 };
 //# sourceMappingURL=queryPosts.d.ts.map

package/dist/post/api/queryPosts.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"queryPosts.d.ts","sourceRoot":"","sources":["../../../src/post/api/queryPosts.ts"],"names":[],"mappings":"AAQA;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,UAAU;YACd;QACL,QAAQ,EAAE,MAAM,CAAC;QACjB,UAAU,EAAE,MAAM,IAAI,CAAC,YAAY,CAAC,CAAC;QACrC,MAAM,CAAC,EAAE,aAAa,GAAG,cAAc,GAAG,aAAa,GAAG,cAAc,CAAA;QACxE,QAAQ,CAAC,EAAE,MAAM,CAAA;QACjB,SAAS,CAAC,EAAE,MAAM,IAAI,CAAC,WAAW,CAAC,CAAA;QACnC,OAAO,CAAC,EAAE,OAAO,CAAA;QACjB,QAAQ,CAAC,EAAE,WAAW,GAAG,WAAW,CAAA;QACpC,IAAI,CAAC,EAAE,MAAM,QAAQ,CAAC,MAAM,CAAC,CAAC;QAC9B,sBAAsB,CAAC,EAAE,OAAO,CAAA;QAChC,IAAI,CAAC,EAAE,MAAM,IAAI,CAAA;KAClB,GACA,QAAQ,MAAM,MAAM,CAAC,MAAM,QAAQ,CAAC,MAAM,IAAI,CAAC,CAAC,CAAC;IAuCpD;;;;;;;;;;;;OAYG;mBAEM,WAAW,iBAAiB,CAAC,CAAC,CAAC,CAAC,GACtC,MAAM,MAAM,CAAC,MAAM,QAAQ,CAAC,MAAM,IAAI,CAAC,CAAC,GAAG,SAAS;CAjBtD,CAAA"}
+{"version":3,"file":"queryPosts.d.ts","sourceRoot":"","sources":["../../../src/post/api/queryPosts.ts"],"names":[],"mappings":"AAQA;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,UAAU;YACd;QACL,QAAQ,EAAE,MAAM,CAAC;QACjB,UAAU,EAAE,MAAM,IAAI,CAAC,YAAY,CAAC,CAAC;QACrC,MAAM,CAAC,EAAE,aAAa,GAAG,cAAc,GAAG,aAAa,GAAG,cAAc,CAAA;QACxE,QAAQ,CAAC,EAAE,MAAM,CAAA;QACjB,SAAS,CAAC,EAAE,MAAM,IAAI,CAAC,WAAW,CAAC,CAAA;QACnC,OAAO,CAAC,EAAE,OAAO,CAAA;QACjB,QAAQ,CAAC,EAAE,WAAW,GAAG,WAAW,CAAA;QACpC,IAAI,CAAC,EAAE,MAAM,QAAQ,CAAC,MAAM,CAAC,CAAC;QAC9B,sBAAsB,CAAC,EAAE,OAAO,CAAA;QAChC,IAAI,CAAC,EAAE,MAAM,OAAO,CAAA;KACrB,GACA,QAAQ,MAAM,MAAM,CAAC,MAAM,KAAK,CAAC,MAAM,IAAI,EAAE,MAAM,OAAO,CAAC,CAAC,CAAC;IAuChE;;;;;;;;;;;;OAYG;mBAEM,WAAW,iBAAiB,CAAC,CAAC,CAAC,CAAC,GACtC,MAAM,MAAM,CAAC,MAAM,KAAK,CAAC,MAAM,IAAI,EAAE,MAAM,OAAO,CAAC,CAAC,GAAG,SAAS;CAjBlE,CAAA"}

package/dist/utils/env.d.ts

@@ -0,0 +1,5 @@
+/// <reference types="node" />
+export declare const safeProcess: Partial<NodeJS.Process>;
+export declare function getEnv(): NodeJS.ProcessEnv;
+export declare const isProduction: boolean;
+//# sourceMappingURL=env.d.ts.map

package/dist/utils/env.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"env.d.ts","sourceRoot":"","sources":["../../src/utils/env.ts"],"names":[],"mappings":";AAEA,eAAO,MAAiB,WAAW,yBAAyD,CAAA;AAE5F,wBAAgB,MAAM,sBAAmC;AAEzD,eAAO,MAAM,YAAY,SAA6C,CAAA"}

package/dist/version.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"version.d.ts","sourceRoot":"","sources":["../src/version.ts"],"names":[],"mappings":"AACA,eAAO,MAAM,OAAO,QAAmC,CAAA"}
+{"version":3,"file":"version.d.ts","sourceRoot":"","sources":["../src/version.ts"],"names":[],"mappings":"AAGA,eAAO,MAAM,OAAO,QAAwC,CAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@amityco/ts-sdk",
-  "version": "0.0.1-beta.13",
+  "version": "0.0.1-beta.16",
   "license": "CC-BY-ND-4.0",
   "author": "amity.co <developers@amity.co> (https://amity.co)",
   "description": "Amity Social Cloud Typescript SDK",

package/src/@types/core/cache.ts

@@ -49,11 +49,11 @@ declare global {
      * Minimal CacheEntry alias, used mostly
      */
      type Cached<T extends unknown = unknown> = (
-      T extends (Amity.PagedRaw<any> | Amity.Paged<any>)
+      T extends Amity.Paged<any, infer K>
         ? T
         : { data: T }
      ) & {
-      cachedAt?: CacheOptions['cachedAt']
+      cachedAt: CacheOptions['cachedAt']
     }
 
     /**

package/src/@types/core/events.ts

@@ -6,7 +6,7 @@ declare global {
   namespace Amity {
     type Listener<T = any> = (params: T) => void
 
-    type ObjectListener<T, K extends string[]> = {
+    type ObjectListener<T, K extends string[]> = Listener<T> | {
       onEvent?: (event: K[number], params: T) => void
     } & {
       [P in K[number]]?: Listener<T>
@@ -96,10 +96,21 @@ declare global {
       'user.flagCleared': Amity.UserPayload
     }
 
+    type MqttFollowMessageEvents = {
+      'follow.created': Amity.FollowStatus
+      'follow.requested': Amity.FollowStatus
+      'follow.accepted': Amity.FollowStatus
+      'follow.unfollowed': Amity.FollowStatus
+      'follow.requestCanceled': Amity.FollowStatus
+      'follow.requestDeclined': Amity.FollowStatus
+      'follow.followerDeleted': Amity.FollowStatus
+    }
+
     type MqttMessageEvents = MqttCommunityMessageEvents
       & MqttPostMessageEvents
       & MqttCommentMessageEvents
       & MqttUserMessageEvents
+      & MqttFollowMessageEvents
 
     type Events = WsEvents & MqttEvents & MqttMessageEvents
   }

package/src/@types/core/model.ts

@@ -23,6 +23,9 @@ declare global {
       'comment': Amity.Comment
 
       'stream': Amity.Stream
+
+      'follow': Amity.FollowStatus
+      'followCount': Amity.FollowCount
     }
 
     /**
@@ -48,6 +51,9 @@ declare global {
       'comment': Pick<Amity.Comment, 'commentId'>
 
       'stream': Pick<Amity.Stream, 'streamId'>
+
+      'follow': Pick<Amity.FollowStatus, 'from' | 'to'>
+      'followCount': Pick<Amity.FollowCount, 'userId'>
     }
   }
 }

package/src/@types/core/paging.ts

@@ -2,6 +2,32 @@ export {}
 
 declare global {
   namespace Amity {
+    type PaginationStyles = 'skiplimit' | 'afterbefore' | 'afterbeforeraw'
+
+    type PageLimit = {
+      limit: number
+    }
+
+    type PrevPage<T extends number | string> = PageLimit & {
+      after?: never
+      before?: T
+    }
+
+    type NextPage<T extends number | string> = PageLimit & {
+      after?: T
+      before?: never
+    }
+
+    type Page = PrevPage<number> | NextPage<number>
+
+    /*
+      updatedAt is here because if you need sort by updatedAt you
+      need to include this data in query also
+    */
+    type PageRaw = (PrevPage<string> | NextPage<string>) & {
+      updatedAt?: string
+    }
+
     type SkipLimitPagination = {
       skip?: number
       limit?: number
@@ -22,54 +48,13 @@ declare global {
       last?: number
     }
 
-    type PrevPage = {
-      after?: never
-      before?: number
-      limit: number
-    }
-
-    type NextPage = {
-      after?: number
-      before?: never
-      limit: number
-    }
-
-    type Page = (PrevPage | NextPage)
-
-    type Pages = {
-      nextPage?: Page | null
-      prevPage?: Page | null
-    }
-
-    type Paged<T> = { data: T[] } & Pages
-
-    type AfterBeforeRawPagination = {
-      before?: string
-      after?: string
-      updatedAt?: string
-    }
-
-    type PrevPageRaw = {
-      after?: never
-      before?: string
-      limit: number
-      updatedAt?: string
-    }
-
-    type NextPageRaw = {
-      after?: string
-      before?: never
-      limit: number
-      updatedAt?: string
-    }
-
-    type PageRaw = (PrevPageRaw | NextPageRaw)
+    type AfterBeforeRawPagination = PageRaw
 
-    type PagesRaw = {
-      nextPage?: PageRaw | null
-      prevPage?: PageRaw | null
+    type Pages<T extends (Page | PageRaw)> = {
+      nextPage?: T
+      prevPage?: T
     }
 
-    type PagedRaw<T> = { data: T[] } & PagesRaw
+    type Paged<T, K extends (Page | PageRaw) = Page> = { data: T[] } & Pages<K>
   }
 }

package/src/@types/core/payload.ts

@@ -98,5 +98,19 @@ declare global {
     }
 
     type GlobalFeedPayload = Amity.PostPayload
+
+    type FollowersPayload = {
+      follows: Amity.FollowStatus[]
+    }
+    & UserPayload
+
+    type FollowStatusPayload = {
+      follows: Amity.FollowStatus[]
+    }
+
+    type FollowInfoPayload = {
+      follows: Amity.FollowStatus[]
+      followCounts: Amity.FollowCount[]
+    }
   }
 }

package/src/@types/core/query.ts

@@ -46,9 +46,17 @@ declare global {
     }
 
     type Snapshot<T> = (
-      T extends Amity.Cached<infer K> ? { data: K } :
-      T extends (Amity.PagedRaw<any> | Amity.Paged<any>) ? T :
-      { data: T }
+      T extends Amity.Cached<infer T2>
+        ? T2 extends Amity.Paged<infer T3, infer T4>
+          ? { data: T3[] | undefined } & Pages<T4> & { cachedAt?: CacheOptions['cachedAt'] }
+          : { data: T2 }  & { cachedAt?: CacheOptions['cachedAt'] }
+        : T extends Amity.Paged<infer T3, infer T4>
+          ? { data: T3[] | undefined } & Pages<T4>
+          : { data: T | undefined }
     ) & SnapshotOptions
+
+    type RunQueryOptions<T> = T extends Amity.AsyncFunc<infer Args, infer Returned>
+      ? Omit<Amity.Snapshot<Returned>, 'data'>
+      : never
   }
 }

package/src/@types/domains/client.ts

@@ -18,7 +18,6 @@ declare global {
 
       apiKey?: string
       userId?: string
-      _internalUserId?: string
       accessToken?: string
 
       use: () => void

package/src/@types/domains/comment.ts

@@ -5,8 +5,6 @@ declare global {
     type CommentContentType = ('text')
     type CommentReferenceType = ('content' | 'post')
 
-    type CommentMentionType = keyof MentionTypes
-
     type Comment<T extends CommentContentType = any> = {
       commentId: string
       userId: string
@@ -24,6 +22,6 @@ declare global {
     & Amity.Timestamps
     & Amity.SoftDelete
     & Amity.Subscribable
-    & Amity.Mentionable<CommentMentionType>
+    & Amity.Mentionable<'user'>
   }
 }

package/src/@types/domains/follow.ts

@@ -0,0 +1,25 @@
+export {}
+
+declare global {
+  namespace Amity {
+    type FollowStatus = {
+      from: Amity.User['userId']
+      to: Amity.User['userId']
+      status: 'pending' | 'accepted' | 'none'
+    }
+    & Amity.CreatedAt
+    & Amity.UpdatedAt
+
+    type FollowCount = {
+      userId: Amity.User['userId']
+      followerCount: number
+      followingCount: number
+      pendingCount: number
+    }
+
+    type FollowInfo = {
+      status?: FollowStatus['status']
+    }
+    & FollowCount
+  }
+}

package/src/@types/domains/mention.ts

@@ -0,0 +1,26 @@
+export {}
+
+declare global {
+  namespace Amity {
+    type Mention = {
+      type: "user" | "channel"
+    }
+
+    type ChannelMention = Mention & {
+      type: "channel"
+    }
+
+    type UserMention = Mention & {
+      type: "user", userIds: string[]
+    }
+
+    type MentionType = {
+      "channel": ChannelMention
+      "user": UserMention
+    }
+
+    type Mentionable<T extends keyof MentionType = 'channel' | 'user'> = {
+      mentionees?: (MentionType[T])[]
+    }
+  }
+}

package/src/@types/domains/message.ts

@@ -22,5 +22,6 @@ declare global {
     & Amity.Timestamps
     & Amity.SoftDelete
     & Amity.Reactable
+    & Amity.Mentionable<'user' | 'channel'>
   }
 }

package/src/@types/domains/partials.ts

@@ -52,13 +52,5 @@ declare global {
     type Subscribable = {
       path: string
     }
-
-    type MentionTypes = {
-      user: { userIds: Amity.User['userId'][] }
-    }
-
-    type Mentionable<T extends keyof MentionTypes> = {
-      mentionees?: {type: T & MentionTypes}[]
-    }
   }
 }

package/src/@types/domains/post.ts

@@ -7,8 +7,6 @@ declare global {
 
     type PostContentType = ('text' | 'image' | 'file' | 'video')
 
-    type PostMentionType = keyof MentionTypes
-
     type Post<T extends PostContentType = any> = {
       postId: string
       postedUserId: User['userId'] // API-FIX: it should be "userId"
@@ -30,6 +28,6 @@ declare global {
     & Amity.Timestamps
     & Amity.SoftDelete
     & Amity.Subscribable
-    & Amity.Mentionable<PostMentionType>
+    & Amity.Mentionable<'user'>
   }
 }

package/src/@types/index.ts

@@ -13,6 +13,7 @@ import './core/cache' // cache.pull('user', ...)
 import './domains/client' // client definition
 
 import './domains/user'
+import './domains/follow'
 import './domains/file'
 
 import './domains/partials' // small model partials (CreatedAt, etc...)
@@ -29,3 +30,5 @@ import './domains/post'
 import './domains/comment'
 
 import './domains/stream'
+
+import './domains/mention'

package/src/channel/api/createChannel.ts

@@ -17,7 +17,7 @@ import { ingestInCache } from '~/cache/api/ingestInCache'
  * @async
  */
 export const createChannel = async <T extends Amity.ChannelType>(
-  bundle: { type: T, userIds?: Amity.User['userId'] }
+  bundle: { type: T, userIds?: Amity.User['userId'][] }
   & Pick<Amity.Channel<T>, 'displayName' | 'avatarFileId' | 'tags' | 'metadata'>
 ): Promise<Amity.Cached<Amity.Channel>> => {
   const client = getActiveClient()

package/src/channel/api/queryChannelMembers.ts

@@ -44,6 +44,7 @@ export const queryChannelMembers = async (query: {
   const { paging, ...payload } = data
   const { channelUsers } = payload
 
+  const cachedAt = client.cache && Date.now()
   if (client.cache) {
     ingestInCache(payload as Amity.ChannelMembershipPayload)
   }
@@ -51,7 +52,7 @@ export const queryChannelMembers = async (query: {
   const nextPage = toPage(paging.next)
   const prevPage = toPage(paging.previous)
 
-  return { data: channelUsers, nextPage, prevPage }
+  return { data: channelUsers, cachedAt, nextPage, prevPage }
 }
 
 /**

package/src/client/api/activeUser.ts

@@ -0,0 +1,26 @@
+import { ASCError } from '~/core/errors'
+
+let activeUser: Pick<Amity.User, '_id' | 'userId' | 'path'> | null = null
+
+/**
+ * for internal use
+ */
+export const getActiveUser = () => {
+  if (!activeUser) {
+    throw new ASCError(
+      'Connect client first',
+      Amity.ClientError.UNKNOWN_ERROR,
+      Amity.ErrorLevel.FATAL,
+    )
+  }
+
+  return activeUser!
+}
+
+export const setActiveUser = (user: Amity.User) => {
+  activeUser = {
+    _id: user._id,
+    userId: user.userId,
+    path: user.path,
+  }
+}

package/src/client/api/connectClient.ts

@@ -3,6 +3,7 @@ import { getDeviceId } from '~/core/device'
 import { proxyMqttEvents, proxyWebsocketEvents } from '~/core/events'
 
 import { getActiveClient } from './activeClient'
+import { setActiveUser } from './activeUser'
 
 import { getToken } from './getToken'
 import { onClientBanned } from '../events'
@@ -66,8 +67,9 @@ export const connectClient = async (params: {
   })
 
   client.userId = params.userId
-  client._internalUserId = users[0]._id
   client.accessToken = accessToken
 
+  setActiveUser(users[0])
+
   return client.ws.connected
 }

package/src/client/api/createClient.ts

@@ -2,7 +2,7 @@ import { VERSION } from '~/version'
 
 import { createLogger } from '~/core/debug'
 
-import { API_ENDPOINT, getUrlFromTemplate, UrlTemplate } from '~/core/network'
+import { API_REGIONS, computeUrl } from '~/client/utils/endpoints'
 import { createHttpTransport, createMqttTransport, createWebsocketTransport } from '~/core/transports'
 
 import { createEventEmitter } from '~/core/events'
@@ -18,7 +18,7 @@ import { getActiveClient, setActiveClient } from './activeClient'
  * Creates a new {@link Amity.Client} instance
  *
  * @param apiKey for the {@link Amity.Client} instance
- * @param apiEndpoint endpoint to connect to
+ * @param apiRegion endpoint to connect to
  * @param debugSession session's identifier for the client's logger instance
  * @returns A {@link Amity.Client} instance
  *
@@ -26,19 +26,19 @@ import { getActiveClient, setActiveClient } from './activeClient'
  **/
 export const createClient = (
   apiKey: string,
-  apiEndpoint: typeof API_ENDPOINT[keyof typeof API_ENDPOINT]|string = API_ENDPOINT.SG,
+  apiRegion: typeof API_REGIONS[keyof typeof API_REGIONS] = API_REGIONS.SG,
   debugSession: string = 'amity'
 ): Amity.Client => {
   const log = createLogger(debugSession)
 
   log('client/api/createClient', {
     apiKey: apiKey.replace(/.{5}$/g, 'xxxxx'),
-    apiEndpoint,
+    apiRegion,
   })
 
-  const http = createHttpTransport(getUrlFromTemplate(UrlTemplate.HTTP, apiEndpoint))
-  const ws = createWebsocketTransport(getUrlFromTemplate(UrlTemplate.HTTP, apiEndpoint))
-  const mqtt = createMqttTransport(getUrlFromTemplate(UrlTemplate.MQTT, apiEndpoint));
+  const http = createHttpTransport(computeUrl('http', apiRegion))
+  const ws = createWebsocketTransport(computeUrl('http', apiRegion))
+  const mqtt = createMqttTransport(computeUrl('mqtt', apiRegion));
 
   const emitter = createEventEmitter()
 

package/src/client/utils/endpoints.ts

@@ -0,0 +1,14 @@
+export const API_REGIONS = {
+  EU: 'eu',
+  SG: 'sg',
+  US: 'us',
+} as const
+
+const URLS = {
+  http: 'https://api.{region}.amity.co',
+  mqtt: 'wss://sse.{region}.amity.co:443/mqtt',
+} as const
+
+export function computeUrl(type: keyof typeof URLS, region: string) {
+  return URLS[type].replace('{region}', region)
+}

package/src/community/api/getRecommendedCommunities.ts

@@ -0,0 +1,86 @@
+import { getActiveClient } from '~/client/api'
+
+import { getResolver } from '~/core/model'
+import { pullFromCache, pushToCache } from '~/cache/api'
+import { ingestInCache } from '~/cache/api/ingestInCache'
+
+/**
+ * ```js
+ * import { getRecommendedCommunities } from '@amityco/ts-sdk'
+ * const communities = await getRecommendedCommunities()
+ * ```
+ *
+ * Gets a list of recommended {@link Amity.Community} objects
+ *
+ * @param query The query parameters
+ * @returns A list of {@link Amity.Community} objects
+ *
+ * @category Community API
+ * @async
+ */
+export const getRecommendedCommunities = async (
+  query?: Partial<Amity.PageLimit>
+): Promise<Amity.Cached<Amity.Community[]>> => {
+  const client = getActiveClient()
+  client.log('channel/getRecommendedCommunities', query)
+
+  const { limit = 5 } = query ?? {}
+
+  // API-FIX: backend doesnt answer Amity.Response
+  // const { data } = await client.http.get<Amity.Response<CommunityPayload>>(
+  const { data } = await client.http.get<Amity.CommunityPayload>(
+    `/api/v3/communities/recommended`, { params: { options: { limit }}}
+  )
+
+  const { communities } = data
+
+  const cachedAt = client.cache && Date.now()
+
+  if (client.cache) {
+    ingestInCache(data, { cachedAt })
+
+    const cacheKey = ['community', 'recommended', { params: { options: { limit }} }]
+    pushToCache(cacheKey, { communities: communities.map(getResolver('community')) })
+  }
+
+  return { data: communities, cachedAt }
+}
+
+/**
+ * ```js
+ * import { getRecommendedCommunities } from '@amityco/ts-sdk'
+ * const communities = getRecommendedCommunities.locally()
+ * ```
+ *
+ * Gets a list of recommended {@link Amity.Community} objects from cache
+ *
+ * @param query The query parameters
+ * @returns communities
+ *
+ * @category Community API
+ */
+getRecommendedCommunities.locally = (
+  query: Parameters<typeof getRecommendedCommunities>[0],
+): Amity.Cached<Amity.Community[]> | undefined => {
+  const client = getActiveClient()
+  client.log('community/getRecommendedCommunities.locally', query)
+
+  if (!client.cache) return
+
+  const { limit = 5 } = query ?? {}
+
+  const queryKey = ['community', 'recommended', { params: { options: { limit }} }];
+  const { data, cachedAt } = pullFromCache<{communities: Pick<Amity.Community, 'communityId'>[]}>(queryKey) ?? {}
+
+  if (!data?.communities.length)
+    return
+
+  const communities: Amity.Community[] = data.communities
+    .map(communityId => pullFromCache<Amity.Community>(['community', 'get', communityId])!)
+    .filter(Boolean)
+    .map(({ data }) => data)
+
+  return communities.length === data?.communities?.length
+    ? { data: communities, cachedAt }
+    : undefined
+}