@amityco/ts-sdk 0.0.1-beta.8 → 0.0.1-beta.9

package/src/user/events/onUserUpdated.ts

@@ -1,8 +1,4 @@
-import { getActiveClient } from '~/client/api'
-import { createEventSubscriber } from '~/core/events'
-
-import { decoratePayload } from '~/core/query'
-import { ingestInCache } from '~/core/cache'
+import { createUserEventSubscriber } from './utils'
 
 /**
  * ```js
@@ -12,28 +8,12 @@ import { ingestInCache } from '~/core/cache'
  * })
  * ```
  *
- * Fired when any {@link Amity.User} have been updated
+ * Fired when a {@link Amity.User} has been updated
  *
  * @param callback The function to call when the event was fired
  * @returns an {@link Amity.Unsubscriber} function to stop listening
  *
  * @category User Events
  */
-export const onUserUpdated = (
-  callback: Amity.Listener<Amity.User>
-) => {
-  const client = getActiveClient()
-
-  const filter = (payload: Amity.UserPayload) => {
-    decoratePayload(payload)
-    ingestInCache(payload)
-    callback(payload.users[0])
-  }
-
-  return createEventSubscriber(
-    client,
-    'user/onUserUpdate',
-    'v3.user.didUpdate',
-    filter
-  )
-}
+export const onUserUpdated = (callback: Amity.Listener<Amity.User>) =>
+  createUserEventSubscriber('user.updated', callback)

package/src/user/events/utils.ts

@@ -0,0 +1,24 @@
+import { getActiveClient } from '~/client/api'
+import { decoratePayload } from '~/core/query'
+import { ingestInCache } from '~/core/cache'
+import { createEventSubscriber } from '~/core/events'
+
+export const createUserEventSubscriber = (
+  event: keyof Amity.MqttUserMessageEvents,
+  callback: Amity.Listener<Amity.User>
+) => {
+  const client = getActiveClient()
+
+  const filter = (payload: Amity.UserPayload) => {
+    decoratePayload(payload)
+    ingestInCache(payload)
+    callback(payload.users[0])
+  }
+
+  return createEventSubscriber(
+    client,
+    event,
+    event,
+    filter
+  )
+}

package/src/user/observers/observeUser.ts

@@ -3,7 +3,12 @@ import { createQuery, runQuery } from '~/core/query/query'
 import { getActiveClient } from '~/client/api'
 
 import { getUser } from '../api'
-import { onUserUpdated } from '../events'
+import {
+  onUserUpdated,
+  onUserFlagged,
+  onUserUnflagged,
+  onUserFlagCleared,
+} from '../events'
 
 /**
  * ```js
@@ -20,7 +25,7 @@ import { onUserUpdated } from '../events'
  * Observe all mutation on a given {@link Amity.User}
  * @category User Observer
  */
-export const observeUser = <Events extends ['onFetch', 'onUpdate']>(
+export const observeUser = <Events extends ['onFetch', 'onUpdate', 'onFlagged', 'onUnflagged', 'onFlagCleared']>(
   userId: string,
   callback: Amity.ObjectListener<Amity.QueryResult<Amity.User>, Events>,
 ): Amity.Unsubscriber => {
@@ -49,7 +54,10 @@ export const observeUser = <Events extends ['onFetch', 'onUpdate']>(
   const disposers: Amity.Unsubscriber[] = []
 
   disposers.push(
-    onUserUpdated(data => router({ data }, 'onUpdate'))
+    onUserUpdated(data => router({ data }, 'onUpdate')),
+    onUserFlagged(data => router({ data }, 'onFlagged')),
+    onUserUnflagged(data => router({ data }, 'onUnflagged')),
+    onUserFlagCleared(data => router({ data }, 'onFlagCleared'))
   )
 
   runQuery(

package/dist/core/transports.d.ts

@@ -1,49 +0,0 @@
-/// <reference types="socket.io-client" />
-/**
- * Creates a pre-configured axios instance
- *
- * @param endpoint The ASC rest api server's URL
- * @returns A pre-configured axios instance
- *
- * @category Transport
- * @hidden
- */
-export declare const createHttpTransport: (endpoint?: string) => import("axios").AxiosInstance;
-/**
- * Creates a pre-configured socket.io instance
- *
- * @param endpoint The socket.io server's URL
- * @returns A pre-configured (non-connected) socket.io client instance
- *
- * @category Transport
- * @hidden
- */
-export declare const createWebsocketTransport: (endpoint?: string) => SocketIOClient.Socket;
-/**
- * Unwraps v3 server payload (for error handling and type extraction)
- *
- * @param response A typical "v3" response (related to backend's service strategy)
- *
- * @returns The data returned by the backend
- * @throws An error related to backend's rejection
- *
- * @category Transport
- * @hidden
- */
-export declare const unwrapPayload: <T>(response: Amity.Response<T>) => T;
-/**
- * Promisify a websocket event emission - resulting in a synchronous http-like XHR (ws legacy)
- *
- * @param client The current client for which to send the event with
- * @param event The websocket event name
- * @param data The event's payload
- *
- * @returns The data returned by the backend
- * @throws An error related to backend's rejection
- *
- * @category Transport
- * @async
- * @hidden
- */
-export declare const synchronousWSCall: <T>(client: Amity.Client, event: string, data?: Object | undefined) => Promise<T | undefined>;
-//# sourceMappingURL=transports.d.ts.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"transports.d.ts","sourceRoot":"","sources":["../../src/core/transports.ts"],"names":[],"mappings":";AAgCA;;;;;;;;GAQG;AACH,eAAO,MAAM,mBAAmB,cAAc,MAAM,kCA2BnD,CAAA;AAED;;;;;;;;GAQG;AACH,eAAO,MAAM,wBAAwB,cAAc,MAAM,0BAaxD,CAAA;AAED;;;;;;;;;;GAUG;AACH,eAAO,MAAM,aAAa,uCAWzB,CAAA;AAED;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,iBAAiB,cACpB,MAAM,MAAM,SACb,MAAM,sDAgBd,CAAA"}

package/src/core/transports.ts

@@ -1,151 +0,0 @@
-import axios from 'axios'
-import HttpAgent, { HttpsAgent } from 'agentkeepalive'
-
-import io from 'socket.io-client'
-
-import {
-  ASCApiError,
-  ASCUnknownError,
-  ASCConnectionError,
-} from './errors'
-
-/**
- * Axios param serializer (for querystring)
- * @hidden
- */
-const stringify = (params: object, prefix?: string): string => {
-  return Object.entries(params)
-    .filter(([, value]) => value !== undefined)
-    .map(([name, value]) => {
-      const key = prefix ? `${prefix}[${name}]` : name
-
-      if (Array.isArray(value)) {
-        return value.map(item => `${key}[]=${item}`).join('&')
-      } else if (typeof value !== 'object') {
-        return `${key}=${value}`
-      }
-
-      return stringify(value, prefix ?? name)
-    })
-    .join('&')
-}
-
-/**
- * Creates a pre-configured axios instance
- *
- * @param endpoint The ASC rest api server's URL
- * @returns A pre-configured axios instance
- *
- * @category Transport
- * @hidden
- */
-export const createHttpTransport = (endpoint: string = 'https://api.amity.co') => {
-  const options = {
-    maxSockets: 100,
-    maxFreeSockets: 10,
-    timeout: 60000,
-    freeSocketTimeout: 30000,
-  }
-
-  const instance = axios.create({
-    baseURL: endpoint,
-    httpAgent: new HttpAgent(options),
-    httpsAgent: new HttpsAgent(options),
-    paramsSerializer: stringify,
-  })
-
-  instance.interceptors.response.use(
-    (response) => response,
-    (error) => {
-      const { response } = error
-      console.error(response?.data ?? error)
-
-      if (response)
-        unwrapPayload(response.data)
-    }
-  )
-
-  return instance
-}
-
-/**
- * Creates a pre-configured socket.io instance
- *
- * @param endpoint The socket.io server's URL
- * @returns A pre-configured (non-connected) socket.io client instance
- *
- * @category Transport
- * @hidden
- */
-export const createWebsocketTransport = (endpoint: string = 'https://api.ekomedia.technology') => {
-  const socket = io(endpoint, {
-    autoConnect: false,
-    reconnectionDelay: 2000,
-    transports: ['websocket'],
-  })
-
-  socket.on('disconnect', (reason: string) => {
-    if (reason === 'io server disconnect')
-      socket.connect()
-  })
-
-  return socket
-}
-
-/**
- * Unwraps v3 server payload (for error handling and type extraction)
- *
- * @param response A typical "v3" response (related to backend's service strategy)
- *
- * @returns The data returned by the backend
- * @throws An error related to backend's rejection
- *
- * @category Transport
- * @hidden
- */
-export const unwrapPayload = <T>(response: Amity.Response<T>): T => {
-  if (response.status === 'success') {
-    return response.data
-  } else if (response.status === 'fail') {
-    throw new ASCUnknownError(response.code)
-  } else if (response.status === 'error') {
-    throw new ASCApiError(response.message, response.code, Amity.ErrorLevel.ERROR)
-  }
-
-  // unjust, but helps force uncast "T | undefined" to allow deconstruction without warnings
-  return undefined as unknown as T
-}
-
-/**
- * Promisify a websocket event emission - resulting in a synchronous http-like XHR (ws legacy)
- *
- * @param client The current client for which to send the event with
- * @param event The websocket event name
- * @param data The event's payload
- *
- * @returns The data returned by the backend
- * @throws An error related to backend's rejection
- *
- * @category Transport
- * @async
- * @hidden
- */
-export const synchronousWSCall = async <T>(
-  client: Amity.Client,
-  event: string,
-  data?: Object,
-)=> {
-  const { ws } = client
-
-  const value = await new Promise<T | undefined>((resolve, reject) => {
-    ws.emit(event, data, (response: Amity.Response<T>) => {
-      try {
-        resolve(unwrapPayload(response))
-      } catch (error) {
-        reject(error)
-      }
-    })
-  })
-
-  return value
-}