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

package/rollup.config.js

@@ -2,40 +2,80 @@ import chalk from 'chalk'
 import commonjs from '@rollup/plugin-commonjs'
 import resolve from '@rollup/plugin-node-resolve'
 import typescript from 'rollup-plugin-typescript2'
+import replace from '@rollup/plugin-replace'
+import { terser } from 'rollup-plugin-terser'
 
 import pkg from './package.json'
 
-export default {
+const config = {
   input: 'src/index.ts',
-  output: [
-    {
-      file: pkg.main,
-      format: 'cjs',
-    },
-    {
-      file: pkg.module,
-      format: 'es',
-    },
-    {
-      file: pkg.unpkg,
-      format: 'iife',
-      name: 'Amity',
-
-    }
-  ],
-  external: Object.keys(pkg.dependencies),
   plugins: [
-    resolve(),
+    resolve({
+      jsnext: true,
+      main: true,
+      builtins: false,
+      browser: true,
+    }),
     commonjs(),
     typescript({
       useTsconfigDeclarationDir: true,
     }),
   ],
   onwarn: warning => {
-    // we don't allow circular dependencies
-    if (warning.code === 'CIRCULAR_DEPENDENCY') {
+    // we don't allow circular dependencies other than those that we can not fix such as node_modules
+    if (warning.code === 'CIRCULAR_DEPENDENCY' && !warning.importer.includes('node_modules')) {
       console.log(chalk.red('error'), warning.message)
       process.exit(1)
     }
-  }
-};
+  },
+}
+
+export default [
+  {
+    ...config,
+    output: [
+      {
+        format: 'es',
+        file: pkg.module,
+      },
+    ],
+    external: Object.keys(pkg.dependencies),
+    plugins: [
+      ...config.plugins,
+      replace({
+        'process.env.VERSION': `'v${pkg.version}-esm'`,
+      }),
+    ],
+  },
+  {
+    ...config,
+    output: [
+      {
+        format: 'cjs',
+        file: pkg.main,
+      },
+    ],
+    external: Object.keys(pkg.dependencies),
+    plugins: [
+      ...config.plugins,
+      replace({
+        'process.env.VERSION': `'v${pkg.version}-cjs'`,
+      }),
+    ],
+  },
+  {
+    ...config,
+    output: {
+      format: 'iife',
+      name: 'Amity',
+      file: pkg.unpkg,
+    },
+    plugins: [
+      ...config.plugins,
+      replace({
+        'process.env.VERSION': `'v${pkg.version}-umd'`,
+      }),
+      terser(),
+    ],
+  },
+]

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

@@ -1,10 +1,12 @@
+import { IConnectPacket, IDisconnectPacket, IPublishPacket } from 'mqtt'
+
 export {}
 
 declare global {
   namespace Amity {
     type Listener<T = any> = (params: T) => void
 
-    type ObjectListener<T, K extends string[]> = Listener<T> | {
+    type ObjectListener<T, K extends string[]> = {
       onEvent?: (event: K[number], params: T) => void
     } & {
       [P in K[number]]?: Listener<T>
@@ -14,15 +16,13 @@ declare global {
 
     type Subscriber<T = any> = (fn: Amity.Listener<T>) => Unsubscriber
 
-    type Events = {
+    type WsEvents = {
       disconnected: Amity.ErrorResponse | undefined
       error: Amity.ErrorResponse | undefined,
       connect_error: Amity.ErrorResponse | undefined,
       reconnect_error: Amity.ErrorResponse | undefined,
       reconnect_failed: Amity.ErrorResponse | undefined,
 
-      'v3.user.didUpdate': Amity.UserPayload
-
       'v3.channel.didCreate': Amity.ChannelPayload
       'v3.channel.didUpdate': Amity.ChannelPayload
       'v3.channel.didDelete': Amity.ChannelPayload
@@ -40,26 +40,67 @@ declare global {
       'video-streaming.didRecord': Amity.StreamPayload
       'video-streaming.didStart': Amity.StreamPayload
       'video-streaming.didStop': Amity.StreamPayload
+    }
+
+    type MqttEvents = {
+      connect: IConnectPacket,
+      message: [topic: string, payload: Buffer, packet: IPublishPacket]
+      disconnect: IDisconnectPacket,
+      error: Error,
+      close: Error,
+      end: undefined,
+      reconnect: undefined,
+    }
+
+    type MqttCommunityUserMessageEvents = {
+      'community.joined': Amity.CommunityPayload
+      'community.left': Amity.CommunityPayload
+      'community.userAdded': Amity.CommunityPayload
+      'community.userRemoved': Amity.CommunityPayload
+      'community.userBanned': Amity.CommunityPayload
+      'community.userUnbanned': Amity.CommunityPayload
+    }
 
-      // these events have a different shape because they're not supported
-      // by backend yet. since all is internal and wrapped in emitter,
-      // it should be fairly easy and non-breaking to refactor this if
-      // backend were to add events later on.
-      'v3.community.didCreate': Amity.CommunityPayload
-      'v3.community.didUpdate': Amity.CommunityPayload
-      'v3.community.didDelete': Amity.CommunityPayload
-      'v3.community.didJoin': Amity.CommunityPayload
-      'v3.community.didLeave': Amity.CommunityPayload
-      'v3.community.didAddUsers': Amity.CommunityPayload
-      'v3.community.didRemoveUsers': Amity.CommunityPayload
-
-      'v3.post.didCreate': Amity.PostPayload
-      'v3.post.didUpdate': Amity.PostPayload
-      'v3.post.didDelete': Amity.PostPayload
-
-      'v3.comment.didCreate': Amity.CommentPayload
-      'v3.comment.didUpdate': Amity.CommentPayload
-      'v3.comment.didDelete': Amity.CommentPayload
+    type MqttCommunityMessageEvents = {
+      'community.created': Amity.CommunityPayload,
+      'community.updated': Amity.CommunityPayload
+      'community.deleted': Amity.CommunityPayload
+    } & MqttCommunityUserMessageEvents
+
+    type MqttPostMessageEvents = {
+      'post.created': Amity.PostPayload
+      'post.updated': Amity.PostPayload
+      'post.deleted': Amity.PostPayload
+      'post.approved': Amity.PostPayload
+      'post.declined': Amity.PostPayload
+      'post.flagged': Amity.PostPayload
+      'post.unflagged': Amity.PostPayload
+      'post.addReaction': Amity.PostPayload & { reactor: Amity.Reaction }
+      'post.removeReaction': Amity.PostPayload & { reactor: Amity.Reaction }
+    }
+
+    type MqttCommentMessageEvents = {
+      'comment.created': Amity.CommentPayload
+      'comment.updated': Amity.CommentPayload
+      'comment.deleted': Amity.CommentPayload
+      'comment.flagged': Amity.CommentPayload
+      'comment.unflagged': Amity.CommentPayload
+      'comment.addReaction': Amity.CommentPayload & { reactor: Amity.Reaction }
+      'comment.removeReaction': Amity.CommentPayload & { reactor: Amity.Reaction }
     }
+
+    type MqttUserMessageEvents = {
+      'user.updated': Amity.UserPayload
+      'user.flagged': Amity.UserPayload
+      'user.unflagged': Amity.UserPayload
+      'user.flagCleared': Amity.UserPayload
+    }
+
+    type MqttMessageEvents = MqttCommunityMessageEvents
+      & MqttPostMessageEvents
+      & MqttCommentMessageEvents
+      & MqttUserMessageEvents
+
+    type Events = WsEvents & MqttEvents & MqttMessageEvents
   }
 }

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

@@ -1,3 +1,5 @@
+import { ASCError } from '~/core/errors'
+
 export {}
 
 declare global {
@@ -28,5 +30,17 @@ declare global {
         next?: Token
       }
     }
+
+    type MqttClient = {
+      connect: (params: { accessToken: string, userId: string }) => Promise<void>
+      disconnect: () => Promise<void>
+      get connected(): boolean
+      on: <T extends keyof Amity.MqttEvents>(event: T, handler: (payload: Amity.MqttEvents[T]) => void) => void
+      once: <T extends keyof Amity.MqttEvents>(event: T, handler: (payload: Amity.MqttEvents[T]) => void) => void
+      off: <T extends keyof Amity.MqttEvents>(event: T, handler?: (payload: Amity.MqttEvents[T]) => void) => void
+      removeAllListeners: () => void
+      subscribe: (topic: string, callback?: Amity.Listener<ASCError | void>) => Amity.Unsubscriber
+      unsubscribe: (topic: string) => void
+    }
   }
 }

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

@@ -6,8 +6,11 @@ declare global {
     type Logger = (topic: string, ...args: any[]) => void
 
     type Client = {
+      version: string
+
       log: Logger
       http: AxiosInstance
+      mqtt: Amity.MqttClient
       ws: SocketIOClient.Socket
       emitter: Emitter<Amity.Events>
 
@@ -15,6 +18,8 @@ declare global {
 
       apiKey?: string
       userId?: string
+      user?: Amity.User
+      accessToken?: string
 
       use: () => void
     }

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

@@ -22,5 +22,6 @@ declare global {
     & Amity.Timestamps
     & Amity.SoftDelete
     & Amity.Syncable
+    & Amity.Subscribable
   }
 }

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

@@ -31,5 +31,6 @@ declare global {
     & Amity.Timestamps
     & Amity.SoftDelete
     & Amity.Syncable
+    & Amity.Subscribable
   }
 }

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

@@ -13,12 +13,12 @@ declare global {
     } & (
       T extends 'channel' ? {
         channelId: Amity.Channel['channelId']
-        membership: 'member' | 'notMember' | 'banned'
+        membership: 'member' | 'none' | 'banned'
         readToSegment: number
       } :
       T extends 'community' ? {
         communityId: Amity.Community['communityId']
-        communityMembership: 'member' | 'notMember' | 'banned'
+        communityMembership: 'member' | 'none' | 'banned'
       } :
       never
     )

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

@@ -48,5 +48,9 @@ declare global {
         roles: Amity.Role['displayName'][]
         permissions: Amity.Permission[]
     }
+
+    type Subscribable = {
+      path: string
+    }
   }
 }

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

@@ -27,5 +27,6 @@ declare global {
       Amity.Timestamps &
       Amity.SoftDelete &
       Amity.Syncable
+      & Amity.Subscribable
   }
 }

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

@@ -3,6 +3,7 @@ export {}
 declare global {
   namespace Amity {
     type User = {
+      _id: string
       userId: string
       displayName?: string
       avatarFileId?: Amity.File<'image'>['fileId']
@@ -14,5 +15,6 @@ declare global {
     & Amity.Accredited
     & Amity.Timestamps
     & Amity.Syncable
+    & Amity.Subscribable
   }
 }

package/src/client/api/connectClient.ts

@@ -1,9 +1,11 @@
+import { disconnectClient } from '~/client/api/disconnectClient'
 import { getDeviceId } from '~/core/device'
-import { proxyWebsocketEvents } from '~/core/events'
+import { proxyMqttEvents, proxyWebsocketEvents } from '~/core/events'
 
 import { getActiveClient } from './activeClient'
 
 import { getToken } from './getToken'
+import { onClientBanned } from '../events'
 
 /**
  * ```js
@@ -39,7 +41,7 @@ export const connectClient = async (params: {
 
   // @ts-ignore: in that particular case, typing can be
   // ignored since we enforce default values just before.
-  const { accessToken } = await getToken(params)
+  const { accessToken, users } = await getToken(params)
 
   // manually setup the token for http transport
   client.http.defaults.headers.common['Authorization'] = `Bearer ${accessToken}`
@@ -47,6 +49,7 @@ export const connectClient = async (params: {
   // manually setup the token for ws transport
   client.ws.io.opts.query = {token: accessToken}
 
+  // FIXME: events are duplicated if connectClient is called few times without disconnectClient
   // wire websocket events to our event emitter
   proxyWebsocketEvents(client.ws, client.emitter)
 
@@ -57,7 +60,14 @@ export const connectClient = async (params: {
     client.ws.open()
   })
 
+  const unsubscribe = onClientBanned(() => {
+    disconnectClient()
+    unsubscribe()
+  })
+
   client.userId = params.userId
+  client.user = users[0]
+  client.accessToken = accessToken
 
   return client.ws.connected
 }

package/src/client/api/createClient.ts

@@ -1,16 +1,13 @@
+import { VERSION } from '~/version'
+
 import { createLogger } from '~/core/debug'
 
-import {
-  createHttpTransport,
-  createWebsocketTransport,
-} from '~/core/transports'
+import { API_ENDPOINT, getUrlFromTemplate, UrlTemplate } from '~/core/network'
+import { createHttpTransport, createMqttTransport, createWebsocketTransport } from '~/core/transports'
 
 import { createEventEmitter } from '~/core/events'
 
-import {
-  getActiveClient,
-  setActiveClient,
-} from './activeClient'
+import { getActiveClient, setActiveClient } from './activeClient'
 
 /**
  * ```js
@@ -29,8 +26,8 @@ import {
  **/
 export const createClient = (
   apiKey: string,
-  apiEndpoint: string = 'https://api.amity.co',
-  debugSession: string = 'amity',
+  apiEndpoint: typeof API_ENDPOINT[keyof typeof API_ENDPOINT]|string = API_ENDPOINT.SG,
+  debugSession: string = 'amity'
 ): Amity.Client => {
   const log = createLogger(debugSession)
 
@@ -39,18 +36,29 @@ export const createClient = (
     apiEndpoint,
   })
 
-  const http = createHttpTransport(apiEndpoint)
-  const ws = createWebsocketTransport(apiEndpoint)
+  const http = createHttpTransport(getUrlFromTemplate(UrlTemplate.HTTP, apiEndpoint))
+  const ws = createWebsocketTransport(getUrlFromTemplate(UrlTemplate.HTTP, apiEndpoint))
+  const mqtt = createMqttTransport(getUrlFromTemplate(UrlTemplate.MQTT, apiEndpoint));
 
   const emitter = createEventEmitter()
 
   const client = {
-    apiKey, log, http, ws, emitter,
+    version: `${VERSION}`,
+
+    apiKey,
+    log,
+    http,
+    ws,
+    mqtt,
+    emitter,
     use: () => setActiveClient(client),
   }
 
-  try { getActiveClient() }
-  catch { setActiveClient(client) }
+  try {
+    getActiveClient()
+  } catch {
+    setActiveClient(client)
+  }
 
   return client
 }

package/src/client/api/disconnectClient.ts

@@ -21,11 +21,16 @@ export const disconnectClient = async (): Promise<boolean> => {
   await new Promise(resolve => {
     client.ws.once('disconnect', resolve)
     client.ws.disconnect()
+    client.mqtt.disconnect()
   })
 
   client.emitter.all.clear()
+  // FIXME: it removes listener in ws.ts, it breaks global ban event
   client.ws.removeAllListeners()
+  client.mqtt.removeAllListeners()
   client.userId = undefined
+  client.user = undefined
+  client.accessToken = undefined
 
   return !client.ws.connected
 }

package/src/client/api/getToken.ts

@@ -1,6 +1,6 @@
 import { getActiveClient } from './activeClient'
 
-import { getDeviceId, getDeviceInfo } from '~/core/device'
+import { getDeviceInfo } from '~/core/device'
 
 /**
  * Retrieves a pair of {@link Amity.Tokens} necessary for connection
@@ -25,9 +25,10 @@ export const getToken = async (params: {
 
   const deviceInfo = await getDeviceInfo()
 
-  const { data } = await client.http.post<Amity.Tokens>('/v1/device', {
+  const { data } = await client.http.post<Amity.Tokens & { users: Amity.User[] }>('/v1/device', {
     ...params, deviceInfo,
   } , {
+    //@ts-ignore
     headers: { 'X-API-Key': client.apiKey }
   })
 

package/src/client/events/onConnectionError.ts

@@ -1,4 +1,4 @@
-import { getActiveClient } from '~/client/api'
+import { getActiveClient } from '~/client/api/activeClient'
 
 import { createEventSubscriber } from '~/core/events'
 

package/src/comment/api/createComment.ts

@@ -35,8 +35,8 @@ export const createComment = async <T extends Amity.CommentContentType>(
 
   const post = await getPost(bundle.referenceId)
 
-  fireEvent('v3.post.didUpdate', { posts: [post] })
-  fireEvent('v3.comment.didCreate', data)
+  fireEvent('post.updated', { posts: [post] })
+  fireEvent('comment.created', data)
 
   const { comments } = data
   return comments[0]

package/src/comment/api/deleteComment.ts

@@ -1,5 +1,6 @@
 import { getActiveClient } from '~/client/api'
 import { fireEvent } from '~/core/events'
+import { dropFromCache, mergeInCache } from '~/core/cache'
 
 import { getComment } from './getComment'
 
@@ -21,20 +22,39 @@ import { getPost } from '~/post/api/getPost'
  */
 export const deleteComment = async (
   commentId: Amity.Comment['commentId'],
+  permanent: boolean = false,
 ) => {
   const client = getActiveClient()
   client.log('comment/deleteComment', commentId)
 
+  const comment = await getComment(commentId)
+
   // API-FIX: This endpoint has not been implemented yet.
   await client.http.delete<{ success: boolean }>(
-    `/api/v3/comments/${commentId}`,
+    `/api/v4/comments/${commentId}`, {
+      params: {
+        commentId,
+        permanent,
+      },
+    },
   )
 
-  const deleted = await getComment(commentId)
-  const post = await getPost(deleted.referenceId)
+  // to support hard deletion
+  const deleted = { ...comment, isDeleted: true }
+
+  const post = await getPost(comment.referenceId)
+
+  fireEvent('post.updated', { posts: [post] })
+  fireEvent('comment.deleted', { comments: [deleted] })
+
 
-  fireEvent('v3.post.didUpdate', { posts: [post] })
-  fireEvent('v3.comment.didDelete', { comments: [deleted] })
+  if (permanent) {
+    setTimeout(() => {
+      dropFromCache('comment', {commentId})
+    }, 0)
+  } else {
+    mergeInCache('comment', {commentId, isDeleted: true})
+  }
 
   return deleted
 }

package/src/comment/api/getComment.ts

@@ -1,6 +1,6 @@
 import { getActiveClient } from '~/client/api'
 
-import { ingestInCache, pullFromCache } from '~/core/cache'
+import { ingestInCache, pullFromCache, dropFromCache } from '~/core/cache'
 import { decoratePayload } from '~/core/query'
 
 /**
@@ -23,10 +23,22 @@ export const getComment = async (
   const client = getActiveClient()
   client.log('comment/getComment', commentId)
 
-  // API-FIX: endpoint should not be /list, parameters should be querystring.
-  const { data } = await client.http.get<Amity.CommentPayload>(
-    `/api/v3/comments/${commentId}`,
-  )
+  let data: Amity.CommentPayload;
+
+  try {
+    // API-FIX: endpoint should not be /list, parameters should be querystring.
+    const response = await client.http.get<Amity.CommentPayload>(
+      `/api/v3/comments/${commentId}`,
+    )
+
+    data = response.data;
+  } catch (error) {
+    if ((error as Amity.ErrorResponse)?.code  === Amity.ServerError.ITEM_NOT_FOUND) {
+      dropFromCache('comment', {commentId})
+    }
+
+    throw error;
+  }
 
   decoratePayload(data)
   ingestInCache(data)

package/src/comment/api/queryComments.ts

@@ -94,8 +94,6 @@ queryComments.locally = (
     page = { before: 0, limit: 5 },
   } = query
 
-  if (isNaN(page.after!) && isNaN(page.before!))
-    page.before = 0;
 
   if (isNaN(page.limit))
     page.limit = 5
@@ -140,8 +138,8 @@ queryComments.locally = (
     beforeIndex !== -1 ? beforeIndex : undefined,
   )
 
-  // nothing left after slicing
-  if (!slice.length)
+  // check if slice data is correct (complete)
+  if (slice.length < page.limit)
     return
 
   if (!isNaN(page.after!) && !isNaN(page.before!)) {
@@ -150,6 +148,8 @@ queryComments.locally = (
     slice = slice.slice(0, page.limit)
   } else if (!isNaN(page.before!)) {
     slice = slice.slice(-page.limit)
+  } else {
+    slice = slice.slice(-page.limit)
   }
 
   for (let i = 0; i < slice.length - 1; i++)
@@ -160,10 +160,11 @@ queryComments.locally = (
     ? { before: slice[0].segmentNumber, limit: page.limit }
     : undefined
 
-  const nextPage = {
-    after: slice[slice.length - 1].segmentNumber,
-    limit: page.limit,
-  }
+  const nextPage = slice[slice.length - 1].segmentNumber < comments[comments.length - 1].segmentNumber
+    ? {
+      after: slice[slice.length - 1].segmentNumber,
+      limit: page.limit,
+    } : undefined
 
   return { data: toRecord(slice), nextPage, prevPage }
 }

package/src/comment/api/updateComment.ts

@@ -34,7 +34,7 @@ export const updateComment = async (
 
   decoratePayload(data)
   ingestInCache(data)
-  fireEvent('v3.comment.didUpdate', data)
+  fireEvent('comment.updated', data)
 
   const { comments } = data
   return comments.find(comment => comment.commentId === commentId)!

package/src/comment/events/index.ts

@@ -1,3 +1,9 @@
 export * from './onCommentCreated'
 export * from './onCommentUpdated'
 export * from './onCommentDeleted'
+
+export * from './onCommentFlagged'
+export * from './onCommentUnflagged'
+
+export * from './onCommentReactionAdded'
+export * from './onCommentReactionRemoved'