@amityco/ts-sdk 0.0.1-beta.3 → 0.0.1-beta.30

package/src/community/observers/observeCommunity.ts

@@ -1,15 +1,19 @@
-import { createQuery, runQuery } from '~/core/query/query'
+import { createQuery, runQuery } from '~/core/query/query';
 
-import { getActiveClient } from '~/client/api'
+import { getActiveClient } from '~/client/api';
 
-import { getCommunity } from '../api'
+import { getCommunity } from '../api';
 
 import {
   onCommunityUpdated,
   onCommunityDeleted,
   onCommunityJoined,
   onCommunityLeft,
-} from '../events'
+  onCommunityUserAdded,
+  onCommunityUserRemoved,
+  onCommunityUserBanned,
+  onCommunityUserUnbanned,
+} from '../events';
 
 /**
  * ```js
@@ -27,48 +31,74 @@ import {
  *
  * @category Community Observer
  */
-export const observeCommunity = <Events extends ['onFetch', 'onUpdate', 'onDelete', 'onJoin', 'onLeft']>(
+export const observeCommunity = <
+  Events extends [
+    'onFetch',
+    'onUpdate',
+    'onDelete',
+    'onJoin',
+    'onLeft',
+    'onUserAdded',
+    'onUserRemoved',
+    'onUserBanned',
+    'onUserUnbanned',
+  ],
+>(
   communityId: string,
-  callback: Amity.ObjectListener<Amity.QueryResult<Amity.Community>, Events>
+  callback: Amity.ObjectListener<Amity.Snapshot<Amity.Community | undefined>, Events>,
 ): Amity.Unsubscriber => {
-  const { log } = getActiveClient()
+  const { log } = getActiveClient();
 
-  const timestamp = Date.now()
-  log(`observeCommunity(tmpid: ${timestamp}) > listen`)
+  const timestamp = Date.now();
+  log(`observeCommunity(tmpid: ${timestamp}) > listen`);
 
   // wrapper function to make sure
-  const router = (
-    result: Amity.QueryResult<Amity.Community>,
-    action: Events[number]
-  ) => {
-    // filter function
-    if (result.data?.communityId !== communityId) return
+  const router = (result: Amity.Snapshot<Amity.Community | undefined>, action: Events[number]) => {
+    if (callback instanceof Function) return callback(result);
 
-    if (callback instanceof Function)
-      return callback(result)
+    if (action !== 'onFetch') callback.onEvent?.(action, result);
 
-    if (action !== 'onFetch')
-      callback.onEvent?.(action, result)
+    callback[action]?.(result);
+  };
 
-    callback[action]?.(result)
-  }
+  const realtimeRouter = (result: Amity.Snapshot<Amity.Community>, action: Events[number]) => {
+    if (result.data?.communityId !== communityId) return;
 
-  const disposers: Amity.Unsubscriber[] = []
+    router(result, action);
+  };
+
+  const disposers: Amity.Unsubscriber[] = [];
 
   disposers.push(
-    onCommunityUpdated(data => router({ data }, 'onUpdate')),
-    onCommunityDeleted(data => router({ data }, 'onDelete')),
-    onCommunityJoined(data => router({ data }, 'onJoin')),
-    onCommunityLeft(data => router({ data }, 'onLeft')),
-  )
+    onCommunityUpdated(data =>
+      realtimeRouter({ data, loading: false, origin: 'event' }, 'onUpdate'),
+    ),
+    onCommunityDeleted(data =>
+      realtimeRouter({ data, loading: false, origin: 'event' }, 'onDelete'),
+    ),
+    onCommunityJoined(data => realtimeRouter({ data, loading: false, origin: 'event' }, 'onJoin')),
+    onCommunityLeft(data => realtimeRouter({ data, loading: false, origin: 'event' }, 'onLeft')),
+    onCommunityUserAdded(data =>
+      realtimeRouter({ data, loading: false, origin: 'event' }, 'onUserAdded'),
+    ),
+    onCommunityUserRemoved(data =>
+      realtimeRouter({ data, loading: false, origin: 'event' }, 'onUserRemoved'),
+    ),
+    onCommunityUserBanned(data =>
+      realtimeRouter({ data, loading: false, origin: 'event' }, 'onUserBanned'),
+    ),
+    onCommunityUserUnbanned(data =>
+      realtimeRouter({ data, loading: false, origin: 'event' }, 'onUserUnbanned'),
+    ),
+  );
 
   runQuery(
     createQuery(getCommunity, communityId),
-    result => result.data && router(result, 'onFetch')
-  )
+    result => (result.data || result.error) && router(result, 'onFetch'),
+  );
 
   return () => {
-    log(`observeCommunity(tmpid: ${timestamp}) > dispose`)
-    disposers.forEach(fn => fn())
-  }
-}
+    log(`observeCommunity(tmpid: ${timestamp}) > dispose`);
+    disposers.forEach(fn => fn());
+  };
+};

package/src/community/utils/index.ts

@@ -0,0 +1 @@
+export * from './payload';

package/src/community/utils/payload.ts

@@ -0,0 +1,44 @@
+import { CommunityPostSettingMaps, DefaultCommunityPostSetting } from '~/@types';
+
+const getMatchPostSetting = (value: {
+  needApprovalOnPostCreation: Amity.RawCommunity['needApprovalOnPostCreation'];
+  onlyAdminCanPost: Amity.RawCommunity['onlyAdminCanPost'];
+}): Amity.Community['postSetting'] =>
+  Object.keys(CommunityPostSettingMaps).find(
+    key =>
+      value.needApprovalOnPostCreation ===
+        CommunityPostSettingMaps[key].needApprovalOnPostCreation &&
+      value.onlyAdminCanPost === CommunityPostSettingMaps[key].onlyAdminCanPost,
+  ) ?? DefaultCommunityPostSetting;
+
+/*
+ * Unpack community payload by mapping payload field to postSetting value.
+ */
+export const unpackCommunityPayload = <T extends Amity.CommunityPayload>({
+  communities,
+  ...restPayload
+}: T) => ({
+  communities: communities.map<Amity.Community>(
+    ({ needApprovalOnPostCreation, onlyAdminCanPost, ...restCommunityPayload }) => ({
+      postSetting: getMatchPostSetting({
+        needApprovalOnPostCreation,
+        onlyAdminCanPost,
+      }),
+      ...restCommunityPayload,
+    }),
+  ),
+  ...restPayload,
+});
+
+/*
+ * Repack community payload by mapping postSetting to the actual value.
+ */
+export const packCommunityPayload = <
+  T extends { postSetting?: Amity.Community['postSetting']; [k: string]: any },
+>({
+  postSetting = undefined,
+  ...restParam
+}: T) => ({
+  ...restParam,
+  ...(postSetting ? CommunityPostSettingMaps[postSetting] : undefined),
+});

package/src/core/debug.ts

@@ -1,4 +1,6 @@
-import debug from 'debug'
+import debug from 'debug';
+
+import { isProduction } from '~/utils/env';
 
 /**
  * Creates a pre-configured logger instance
@@ -10,17 +12,15 @@ import debug from 'debug'
  * @hidden
  */
 export const createLogger = (session?: string) => {
-  const active = (
-      `${session?.trim()}`.length > 0
-    && process.env.NODE_ENV !== 'production'
-  )
+  const active = `${session?.trim()}`.length > 0 && !isProduction;
 
-  const logger = debug(session!)
+  const logger = debug(session!);
 
   const print = (topic: string, ...args: any[]) => {
-    active && logger(topic, args)
-  }
+    active && logger(topic, args);
+  };
 
-  print.__instance__ = logger
-  return print
-}
+  // eslint-disable-next-line no-underscore-dangle
+  print.__instance__ = logger;
+  return print;
+};

package/src/core/device.ts

@@ -1,8 +1,9 @@
 // TODO: find a way to uniquely identify the device
 // import { getStorage } from './storage'
+import { safeProcess } from '~/utils/env';
 
 /** @hidden */
-const VERSION = '11.0.0'
+const VERSION = '11.0.0';
 
 /** @hidden */
 export const getDeviceId = () => {
@@ -11,28 +12,27 @@ export const getDeviceId = () => {
   // and do things automatically
   // https://www.npmjs.com/package/react-native-device-info#getuniqueid
   // how to make sure that the react native package will not be included when build is for web
-  return `ascWebSdk#${Math.random().toString(16)}`
-}
+  return `ascWebSdk#${Math.random().toString(16)}`;
+};
 
 /** @hidden */
 export const getDeviceModel = () => {
-  if (process?.versions?.node)
-    return process.versions.node
+  if (safeProcess.versions?.node) return safeProcess.versions.node;
 
   if (navigator)
-    return `${navigator.product.toLowerCase()}#${navigator.userAgent ?? 'unknown_agent'}`
+    return `${navigator.product.toLowerCase()}#${navigator.userAgent ?? 'unknown_agent'}`;
 
-  return 'unknown_model'
-}
+  return 'unknown_model';
+};
 
 /** @hidden */
 export const getDeviceInfo = (): Amity.Device['deviceInfo'] => {
-  const model = getDeviceModel()
+  const model = getDeviceModel();
 
   return {
     version: VERSION,
     // TODO: replace with: kind: process.versions ? 'node' : 'web', when backend has fixed this
     kind: 'web',
     model,
-  }
-}
+  };
+};

package/src/core/errors.ts

@@ -1,10 +1,12 @@
+/* eslint-disable max-classes-per-file */
 /**
  * Generic ASC error
  * @category Errors
  */
 export class ASCError extends Error {
-  readonly type: string = 'ASC'
-  readonly timestamp: number = Date.now()
+  readonly type: string = 'ASC';
+
+  readonly timestamp: number = Date.now();
 
   /**
    * @param message A custom error message
@@ -13,13 +15,12 @@ export class ASCError extends Error {
    */
   constructor(
     message: string,
-    public readonly code: Amity.ClientError,
+    public readonly code: Amity.ErrorCode,
     public readonly level: Amity.ErrorLevel,
   ) {
-    super(`Amity SDK (${code}): ${message}`)
+    super(`Amity SDK (${code}): ${message}`);
 
-    if (Error.captureStackTrace)
-      Error.captureStackTrace(this, ASCError)
+    if (Error.captureStackTrace) Error.captureStackTrace(this, ASCError);
   }
 }
 
@@ -32,12 +33,9 @@ export class ASCApiError extends ASCError {
    * @param code A normalized error code
    * @param level A normalized failure level descriptor
    */
-  constructor(
-    message: string,
-    code: Amity.ClientError,
-    level: Amity.ErrorLevel,
-  ) {
-    super(message, code, level)
+  // eslint-disable-next-line no-useless-constructor
+  constructor(message: string, code: Amity.ErrorCode, level: Amity.ErrorLevel) {
+    super(message, code, level);
   }
 }
 
@@ -51,10 +49,10 @@ export class ASCUnknownError extends ASCError {
    * @param level A normalized failure level descriptor
    */
   constructor(
-    code: Amity.ClientError = Amity.ClientError.UNKNOWN_ERROR,
+    code: Amity.ErrorCode = Amity.ClientError.UNKNOWN_ERROR,
     level: Amity.ErrorLevel = Amity.ErrorLevel.FATAL,
   ) {
-    super('Unexpected error', code, level)
+    super('Unexpected error', code, level);
   }
 }
 
@@ -66,8 +64,14 @@ export class ASCConnectionError extends ASCError {
   /**
    * @param message A custom error message
    */
-  constructor(message: string = 'SDK client is having connection issues') {
-    super(message, Amity.ClientError.CONNECTION_ERROR, Amity.ErrorLevel.ERROR)
+  constructor(public readonly event: string, message = 'SDK client is having connection issues') {
+    super(
+      `${message} (${event})`,
+      event === 'disconnected'
+        ? Amity.ClientError.DISCONNECTED
+        : Amity.ClientError.CONNECTION_ERROR,
+      Amity.ErrorLevel.ERROR,
+    );
   }
 }
 
@@ -80,6 +84,6 @@ export class ASCInvalidParameterError extends ASCError {
    * @param message A custom error message
    */
   constructor(message: string) {
-    super(message, Amity.ClientError.INVALID_PARAMETERS, Amity.ErrorLevel.ERROR)
+    super(message, Amity.ClientError.INVALID_PARAMETERS, Amity.ErrorLevel.ERROR);
   }
 }

package/src/core/events.ts

@@ -1,15 +1,21 @@
-import mitt from 'mitt'
+/* eslint-disable @typescript-eslint/no-unused-vars */
+import mitt from 'mitt';
 
-import { getActiveClient } from '~/client/api/activeClient'
+import { getActiveClient } from '~/client/api/activeClient';
+
+import { scheduleTask } from './microtasks';
 
 // need to sync up the list
-const EVENTS = [
+const WS_EVENTS = [
   'disconnected',
+  'error',
+  'connect_error',
+  'reconnect_error',
+  'reconnect_failed',
 
-  'v3.user.didUpdate',
-
-  'v3.channel.didUpdate',
+  'v3.channel.didCreate',
   'v3.channel.didUpdate',
+  'v3.channel.didDelete',
   'v3.channel.didJoin',
   'v3.channel.didLeave',
   'v3.channel.didAddUsers',
@@ -20,12 +26,22 @@ const EVENTS = [
   'v3.message.didCreate',
   'v3.message.didUpdate',
   'v3.message.didDelete',
-] as const
+] as const;
+
+const MQTT_EVENTS = [
+  'connect',
+  'message',
+  'disconnect',
+  'error',
+  'close',
+  'end',
+  'reconnect',
+] as const;
 
 /** @hidden */
 export const createEventEmitter = () => {
-  return mitt<Amity.Events>()
-}
+  return mitt<Amity.Events>();
+};
 
 /**
  * Wraps the websocket events into the client's event emitter for
@@ -38,10 +54,28 @@ export const createEventEmitter = () => {
  * @hidden
  */
 export const proxyWebsocketEvents = (ws: Amity.Client['ws'], emitter: Amity.Client['emitter']) => {
-  EVENTS.forEach(event => {
-    ws.on(event, (param: Amity.Events[typeof event]) => emitter.emit(event, param))
-  })
-}
+  WS_EVENTS.forEach(event => {
+    ws.on(event, (param: Amity.Events[typeof event]) => emitter.emit(event, param));
+  });
+};
+
+export const proxyMqttEvents = (
+  mqttClient: Amity.Client['mqtt'],
+  emitter: Amity.Client['emitter'],
+) => {
+  MQTT_EVENTS.forEach(event => {
+    mqttClient.on(event, (...params: any[]) =>
+      emitter.emit(event, params.length === 1 ? params[0] : params),
+    );
+  });
+
+  // @ts-ignore
+  mqttClient.on('message', (topic: string, payload: Buffer) => {
+    const message = JSON.parse(payload.toString());
+
+    emitter.emit(message.eventType, message.data);
+  });
+};
 
 /**
  * Standardize the subscription of SSE through web sockets
@@ -61,33 +95,47 @@ export const createEventSubscriber = <T extends keyof Amity.Events>(
   event: T,
   fn: Amity.Listener<Amity.Events[T]>,
 ): Amity.Unsubscriber => {
-  const { log, emitter } = client
+  const { log, emitter } = client;
 
-  const timestamp = Date.now()
-  log(`${namespace}(tmpid: ${timestamp}) > listen`)
+  const timestamp = Date.now();
+  log(`${namespace}(tmpid: ${timestamp}) > listen`);
 
   const handler = (...payload: Parameters<typeof fn>) => {
-    log(`${namespace}(tmpid: ${timestamp}) > trigger`, payload)
-    fn(...payload)
-  }
+    log(`${namespace}(tmpid: ${timestamp}) > trigger`, payload);
+    fn(...payload);
+  };
 
-  emitter.on(event, handler)
+  emitter.on(event, handler);
 
   return () => {
-    log(`${namespace}(tmpid: ${timestamp}) > dispose`)
-    emitter.off(event, handler)
-  }
-}
+    log(`${namespace}(tmpid: ${timestamp}) > dispose`);
+    emitter.off(event, handler);
+  };
+};
+
+export const createMqttMessageSubscriber = <T extends keyof Amity.Events>(
+  client: Amity.Client,
+  namespace: string,
+  event: string,
+  fn: (params: Record<string, unknown>) => void,
+): Amity.Unsubscriber => {
+  return createEventSubscriber(client, namespace, 'message', ([topic, message]) => {
+    const payload = JSON.parse(message.toString());
+
+    if (payload.eventType === event) {
+      fn(payload.data);
+    }
+  });
+};
 
 /**
  * Wrapper around dispatch event
  *
  * @hidden
  */
-export const fireEvent = <T extends keyof Amity.Events>(
-  event: T,
-  payload: Amity.Events[T],
-) => {
-  const { emitter } = getActiveClient()
-  setTimeout(() => { emitter.emit(event, payload) }, 0)
-}
+export const fireEvent = <T extends keyof Amity.Events>(event: T, payload: Amity.Events[T]) => {
+  const { emitter } = getActiveClient();
+  scheduleTask(() => {
+    emitter.emit(event, payload);
+  });
+};

package/src/core/microtasks.ts

@@ -0,0 +1,28 @@
+/* eslint-disable @typescript-eslint/ban-types */
+let tasks: Function[] = [];
+let timer: NodeJS.Timeout;
+
+/**
+ * Add a function to run just before the next tick
+ *
+ * @param task function to schedule for later execution
+ */
+export const scheduleTask = (task: Function) => {
+  clearTimeout(timer);
+  tasks.push(task);
+
+  timer = setTimeout(() => {
+    tasks.forEach(fn => fn());
+    tasks = [];
+  }, 0);
+};
+
+/**
+ * Cancel the scheduling operation
+ *
+ * @param task function to be removed from later execution
+ */
+export const cancelTask = (task: Function) => {
+  tasks = tasks.filter(fn => fn !== task);
+  if (!tasks.length) clearTimeout(timer);
+};

package/src/core/model/idResolvers.ts

@@ -1,23 +1,14 @@
 /**
- * A resolver function is a function which, given a minimal version of a model T
- * can compute a string which is capable of identifying the given model uniquely
- * @hidden
- */
-type Resolver<T extends Amity.Domain> = (model: Amity.Minimal[T]) => string
-
-/**
- * Manually computed type to output a dictionary of { Domain: Amity.Resolver<Model> }
- * with proper typing based on T
- * @hidden
+ * Manually computed type which links each key with a function
+ * used to return the object's unique id. The type is computed
+ * to avoid using any and give some typing security at the
+ * resolver's level.
  */
 type Resolvers<T extends Amity.Domain[] = Amity.Domain[]> = {
-  [K in T[number]]: Resolver<K>
-}
+  [K in T[number]]: (model: Amity.Minimal[K]) => string;
+};
 
-/**
- * Dictionary of resolver functions for each model
- * @hidden
- */
+/** @hidden */
 const idResolvers: Resolvers = {
   user: ({ userId }) => userId,
   file: ({ fileId }) => fileId,
@@ -28,39 +19,23 @@ const idResolvers: Resolvers = {
   message: ({ messageId }) => messageId,
 
   community: ({ communityId }) => communityId,
+  category: ({ categoryId }) => categoryId,
   communityUsers: ({ communityId, userId }) => `${communityId}#${userId}`,
   post: ({ postId }) => postId,
   comment: ({ commentId }) => commentId,
+  poll: ({ pollId }) => pollId,
+  reaction: ({ reactionId }) => reactionId,
 
   stream: ({ streamId }) => streamId,
-}
+
+  follow: ({ from, to }) => `${from}#${to}`,
+  followCount: ({ userId }) => userId,
+};
 
 /**
  * Retrieve the id resolver matching a domain name
  *
  * @param name the domain name for the resolve
- * @returns an idResolver for the given domain name
+ * @returns an idResolver function for the given domain name
  */
-export const getResolver = <T extends Amity.Domain>(name: T) => (
-  idResolvers[name] as Resolver<T>
-)
-
-/**
- * A map of v3 response keys to a store name.
- * @hidden
- */
-export const storeInterests: Record<string, Amity.Domain> = {
-  users: 'user',
-  files: 'file',
-  roles: 'role',
-
-  channels: 'channel',
-  channelUsers: 'channelUsers',
-  messages: 'message',
-
-  communities: 'community',
-  communityUsers: 'communityUsers',
-  posts: 'post',
-  postChildren: 'post',
-  comments: 'comment',
-}
+export const getResolver = <T extends Amity.Domain>(name: T) => idResolvers[name];