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

package/src/follow/observers/observeFollowings.ts

@@ -0,0 +1,78 @@
+import { getActiveClient } from '~/client/api'
+
+import {
+  onFollowerRequested,
+  onFollowRequestAccepted,
+  onFollowRequestDeclined,
+  onFollowRequestCanceled,
+  onUserFollowed,
+  onUserUnfollowed,
+  onFollowerDeleted
+} from '../events'
+
+/**
+ * ```js
+ * import { observeFollowings } from '@amityco/ts-sdk'
+ *
+ * let followings = []
+ * const unsub = observeFollowers('userId', follower => merge(followings, following))
+ * ```
+ *
+ * Observe all mutations on a list of followings {@link Amity.FollowStatus} for a given user
+ *
+ * @param userId the ID of the {@link Amity.User}
+ * @param callback the function to call when new data are available
+ * @returns An {@link Amity.Unsubscriber} function to run when willing to stop observing the messages
+ *
+ * @category Follow Observer
+ */
+export const observeFollowings = <Events extends [
+  'onRequested',
+  'onAccepted',
+  'onDeclined',
+  'onCanceled',
+  'onFollowed',
+  'onUnfollowed',
+  'onDeleted',
+]>(
+  userId: Amity.User['userId'],
+  callback: Amity.ObjectListener<Amity.FollowStatus, Events>
+): Amity.Unsubscriber => {
+  const { log } = getActiveClient()
+
+  const timestamp = Date.now()
+  log(`observeFollowings(tmpid: ${timestamp}) > listen`)
+
+  const disposers: Amity.Unsubscriber[] = []
+
+  const router = (
+    status: Amity.FollowStatus,
+    action: Events[number],
+  ) => {
+    if (status.to !== userId) {
+      return;
+    }
+
+    if (callback instanceof Function) {
+      return callback(status)
+    }
+
+    callback.onEvent?.(action, status)
+    callback[action]?.(status)
+  }
+
+  disposers.push(
+    onFollowerRequested(x => router(x, 'onRequested')),
+    onFollowRequestAccepted(x => router(x, 'onAccepted')),
+    onFollowRequestDeclined(x => router(x, 'onDeclined')),
+    onFollowRequestCanceled(x => router(x, 'onCanceled')),
+    onUserFollowed(x => router(x, 'onFollowed')),
+    onUserUnfollowed(x => router(x, 'onUnfollowed')),
+    onFollowerDeleted(x => router(x, 'onDeleted')),
+  )
+
+  return () => {
+    log(`observeFollowings(tmpid: ${timestamp}) > dispose`)
+    disposers.forEach(fn => fn())
+  }
+}

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'
@@ -43,6 +44,10 @@ export * from './community/observers'
 
 export * from './feed/api'
 
+export * from './follow/api'
+export * from './follow/events'
+export * from './follow/observers'
+
 export * from './post/api'
 export * from './post/events'
 export * from './post/observers'

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/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, Amity.PageRaw>>> => {
   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, Amity.PageRaw>> | undefined => {
   const client = getActiveClient()
   client.log('post/queryPosts.locally', query)
 

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);
-}