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

package/src/core/device.ts

@@ -1,9 +1,9 @@
 // TODO: find a way to uniquely identify the device
 // import { getStorage } from './storage'
-import { safeProcess } from '~/utils/env'
+import { safeProcess } from '~/utils/env';
 
 /** @hidden */
-const VERSION = '11.0.0'
+const VERSION = '11.0.0';
 
 /** @hidden */
 export const getDeviceId = () => {
@@ -12,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 (safeProcess.versions?.node)
-    return safeProcess.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
@@ -16,10 +18,9 @@ export class ASCError extends Error {
     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.ErrorCode,
-    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);
   }
 }
 
@@ -54,7 +52,7 @@ export class ASCUnknownError extends ASCError {
     code: Amity.ErrorCode = Amity.ClientError.UNKNOWN_ERROR,
     level: Amity.ErrorLevel = Amity.ErrorLevel.FATAL,
   ) {
-    super('Unexpected error', code, level)
+    super('Unexpected error', code, level);
   }
 }
 
@@ -66,15 +64,14 @@ export class ASCConnectionError extends ASCError {
   /**
    * @param message A custom error message
    */
-  constructor(
-    public readonly event: string,
-    message: string = 'SDK client is having connection issues',
-  ) {
+  constructor(public readonly event: string, message = 'SDK client is having connection issues') {
     super(
       `${message} (${event})`,
-      event === 'disconnected' ? Amity.ClientError.DISCONNECTED : Amity.ClientError.CONNECTION_ERROR,
+      event === 'disconnected'
+        ? Amity.ClientError.DISCONNECTED
+        : Amity.ClientError.CONNECTION_ERROR,
       Amity.ErrorLevel.ERROR,
-    )
+    );
   }
 }
 
@@ -87,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,8 +1,9 @@
-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'
+import { scheduleTask } from './microtasks';
 
 // need to sync up the list
 const WS_EVENTS = [
@@ -24,7 +25,7 @@ const WS_EVENTS = [
   'v3.message.didCreate',
   'v3.message.didUpdate',
   'v3.message.didDelete',
-] as const
+] as const;
 
 const MQTT_EVENTS = [
   'connect',
@@ -33,13 +34,13 @@ const MQTT_EVENTS = [
   'error',
   'close',
   'end',
-  'reconnect'
+  '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
@@ -53,22 +54,27 @@ export const createEventEmitter = () => {
  */
 export const proxyWebsocketEvents = (ws: Amity.Client['ws'], emitter: Amity.Client['emitter']) => {
   WS_EVENTS.forEach(event => {
-    ws.on(event, (param: Amity.Events[typeof event]) => emitter.emit(event, param))
-  })
-}
+    ws.on(event, (param: Amity.Events[typeof event]) => emitter.emit(event, param));
+  });
+};
 
-export const proxyMqttEvents = (mqttClient: Amity.Client['mqtt'], emitter: Amity.Client['emitter']) => {
+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))
-  })
+    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)
-  })
-}
+    emitter.emit(message.eventType, message.data);
+  });
+};
 
 /**
  * Standardize the subscription of SSE through web sockets
@@ -88,53 +94,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: Object) => void,
+  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);
-      }
+  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()
-  scheduleTask(() => { emitter.emit(event, payload) })
-}
+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

@@ -1,5 +1,6 @@
-let tasks: Function[] = []
-let timer: NodeJS.Timeout
+/* eslint-disable @typescript-eslint/ban-types */
+let tasks: Function[] = [];
+let timer: NodeJS.Timeout;
 
 /**
  * Add a function to run just before the next tick
@@ -7,14 +8,14 @@ let timer: NodeJS.Timeout
  * @param task function to schedule for later execution
  */
 export const scheduleTask = (task: Function) => {
-  clearTimeout(timer)
-  tasks.push(task)
+  clearTimeout(timer);
+  tasks.push(task);
 
   timer = setTimeout(() => {
-    tasks.forEach(fn => fn())
-    tasks = []
-  }, 0)
-}
+    tasks.forEach(fn => fn());
+    tasks = [];
+  }, 0);
+};
 
 /**
  * Cancel the scheduling operation
@@ -22,6 +23,6 @@ export const scheduleTask = (task: Function) => {
  * @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)
-}
+  tasks = tasks.filter(fn => fn !== task);
+  if (!tasks.length) clearTimeout(timer);
+};

package/src/core/model/idResolvers.ts

@@ -4,9 +4,9 @@
  * 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]]: (model: Amity.Minimal[K]) => string
-}
+type Resolvers<T extends Amity.Domain[] = Amity.Domain[]> = {
+  [K in T[number]]: (model: Amity.Minimal[K]) => string;
+};
 
 /** @hidden */
 const idResolvers: Resolvers = {
@@ -19,6 +19,7 @@ const idResolvers: Resolvers = {
   message: ({ messageId }) => messageId,
 
   community: ({ communityId }) => communityId,
+  category: ({ categoryId }) => categoryId,
   communityUsers: ({ communityId, userId }) => `${communityId}#${userId}`,
   post: ({ postId }) => postId,
   comment: ({ commentId }) => commentId,
@@ -27,7 +28,7 @@ const idResolvers: Resolvers = {
 
   follow: ({ from, to }) => `${from}#${to}`,
   followCount: ({ userId }) => userId,
-}
+};
 
 /**
  * Retrieve the id resolver matching a domain name
@@ -35,6 +36,4 @@ const idResolvers: Resolvers = {
  * @param name the domain name for the resolve
  * @returns an idResolver function for the given domain name
  */
- export const getResolver = <T extends Amity.Domain>(name: T) => (
-  idResolvers[name]
-)
+export const getResolver = <T extends Amity.Domain>(name: T) => idResolvers[name];

package/src/core/model/identifyModel.ts

@@ -5,9 +5,9 @@
  * adding new models.
  * @hidden
  */
- type Criterias<T extends Amity.Domain[] = Amity.Domain[]> = {
-  [K in T[number]]: (keyof Amity.Model[K])[]
-}
+type Criterias<T extends Amity.Domain[] = Amity.Domain[]> = {
+  [K in T[number]]: (keyof Amity.Model[K])[];
+};
 
 /**
  * Identification criterias
@@ -19,7 +19,7 @@
  *
  * @hidden
  */
-const CRITERIAS: Criterias  = {
+const CRITERIAS: Criterias = {
   file: ['fileId', 'attributes'],
   user: ['userId', 'avatarFileId'],
   role: ['roleId'],
@@ -27,19 +27,20 @@ const CRITERIAS: Criterias  = {
   channelUsers: ['channelId', 'userId', 'membership'],
   message: ['messageId'],
   community: ['communityId', 'onlyAdminCanPost'],
+  category: ['categoryId'],
   communityUsers: ['userId', 'communityId', 'communityMembership'],
   post: ['postId', 'feedId'],
   comment: ['commentId', 'referenceId'],
   stream: ['streamId'],
   follow: ['from', 'to'],
-  followCount: ['userId', 'followerCount']
-}
+  followCount: ['userId', 'followerCount'],
+};
 
 /** @hidden */
 const hasKeys = (object: Record<string, unknown>, needles: string[]) => {
-  const haystack = Object.keys(object)
-  return needles.every(needle => haystack.includes(needle))
-}
+  const haystack = Object.keys(object);
+  return needles.every(needle => haystack.includes(needle));
+};
 
 /**
  * Finds the name of the store for a given unknown model
@@ -50,6 +51,7 @@ const hasKeys = (object: Record<string, unknown>, needles: string[]) => {
 export const identifyModel = (model: Record<string, unknown>) => {
   // we cannot avoid "as" in here because Object.entries does not
   // allow anything else than "string" as key in the iterator type
-  const criterias = Object.entries(CRITERIAS) as [Amity.Domain, string[]][]
-  return criterias.find(([_, keys]) => hasKeys(model, keys))?.[0]
-}
+  const criterias = Object.entries(CRITERIAS) as [Amity.Domain, string[]][];
+  // eslint-disable-next-line @typescript-eslint/no-unused-vars
+  return criterias.find(([_, keys]) => hasKeys(model, keys))?.[0];
+};

package/src/core/model/index.ts

@@ -1,11 +1,11 @@
-export * from './idResolvers'
-export * from './identifyModel'
+export * from './idResolvers';
+export * from './identifyModel';
 
 /**
  * A map of v3 response keys to a store name.
  * @hidden
  */
- export const PAYLOAD2MODEL: Record<string, Amity.Domain> = {
+export const PAYLOAD2MODEL: Record<string, Amity.Domain> = {
   users: 'user',
   files: 'file',
   roles: 'role',
@@ -15,6 +15,7 @@ export * from './identifyModel'
   messages: 'message',
 
   communities: 'community',
+  categories: 'category',
   communityUsers: 'communityUsers',
   posts: 'post',
   postChildren: 'post',
@@ -22,5 +23,5 @@ export * from './identifyModel'
   videoStreamings: 'stream',
 
   follows: 'follow',
-  followCounts: 'followCount'
-}
+  followCounts: 'followCount',
+};

package/src/core/query/filtering.ts

@@ -12,6 +12,8 @@
  *
  * @hidden
  */
-export const filterByPropEquality = <T = {}>(collection: T[], key: keyof T, value: any) => (
-  value !== undefined ? collection.filter(item => item[key] === value) : collection
-)
+export const filterByPropEquality = <T = Record<string, unknown>>(
+  collection: T[],
+  key: keyof T,
+  value: any,
+) => (value !== undefined ? collection.filter(item => item[key] === value) : collection);

package/src/core/query/index.ts

@@ -1,4 +1,4 @@
-export * from './query'
-export * from './filtering'
-export * from './sorting'
-export * from './paging'
+export * from './query';
+export * from './filtering';
+export * from './sorting';
+export * from './paging';

package/src/core/query/paging.ts

@@ -1,4 +1,4 @@
-import { encode, decode } from 'js-base64'
+import { encode, decode } from 'js-base64';
 
 /**
  * Type guard to find if the a given decoded backend token uses "skip/limit" pagination style
@@ -8,9 +8,8 @@ import { encode, decode } from 'js-base64'
  *
  * @hidden
  */
-export const isSkipLimit = (json: Object): json is Amity.SkipLimitPagination => (
-  ['skip', 'limit'].some(prop => prop in json)
-)
+export const isSkipLimit = (json: Record<string, unknown>): json is Amity.SkipLimitPagination =>
+  ['skip', 'limit'].some(prop => prop in json);
 
 /**
  * Type guard to find if the a given decoded backend token uses "after/before" pagination style
@@ -20,9 +19,8 @@ export const isSkipLimit = (json: Object): json is Amity.SkipLimitPagination =>
  *
  * @hidden
  */
-export const isAfterBefore = (json: Object): json is Amity.AfterBeforePagination => (
-  ['after', 'before', 'first', 'last', 'limit'].some(prop => prop in json)
-)
+export const isAfterBefore = (json: Record<string, unknown>): json is Amity.AfterBeforePagination =>
+  ['after', 'before', 'first', 'last', 'limit'].some(prop => prop in json);
 
 /**
  * Type guard to find if the a given decoded backend token uses v4 or newer "after/before" pagination style
@@ -32,9 +30,9 @@ export const isAfterBefore = (json: Object): json is Amity.AfterBeforePagination
  *
  * @hidden
  */
-export const isAfterBeforeRaw = (json: Object): json is Amity.AfterBeforeRawPagination => (
-  'limit' in json
-)
+export const isAfterBeforeRaw = (
+  json: Record<string, unknown>,
+): json is Amity.AfterBeforeRawPagination => 'limit' in json;
 
 /**
  * Type guard to find if the a given object is wrapped around Amity.Paged<>
@@ -46,11 +44,11 @@ export const isAfterBeforeRaw = (json: Object): json is Amity.AfterBeforeRawPagi
  */
 export const isPaged = <T extends unknown>(payload: any): payload is Amity.Paged<T, any> => {
   return (
-     payload?.hasOwnProperty('data')
-  && payload?.hasOwnProperty('nextPage')
-  && payload?.hasOwnProperty('prevPage')
-  )
-}
+    payload?.hasOwnProperty('data') &&
+    payload?.hasOwnProperty('nextPage') &&
+    payload?.hasOwnProperty('prevPage')
+  );
+};
 
 /**
  * Converts a paging object into a b64 string token
@@ -65,53 +63,48 @@ export const toToken = (
   paging: Amity.Page | Amity.PageRaw | undefined,
   style: Amity.PaginationStyles,
 ): Amity.Token | undefined => {
-  if (!paging || !Object.keys(paging).length)
-    return
+  if (!paging || !Object.keys(paging).length) return;
 
-  let payload = {}
+  let payload = {};
 
   // TODO: refactor this clean
   if (style === 'skiplimit') {
     payload = {
       skip: paging.after ?? 0,
       limit: paging.limit,
-    }
-  }
-  else if (style === 'afterbefore' && isAfterBefore(paging)) {
+    };
+  } else if (style === 'afterbefore' && isAfterBefore(paging)) {
     /*
       Caution: this testing style is only valid because
       our backend expects nothing else than a number as
       "before" or "after" value. if that would change,
       we'd need to move toward a more simple: `!paging.before`
     */
-    if (!isNaN(paging?.before!)) {
+    if (!Number.isNaN(paging?.before!)) {
       payload = {
         before: paging.before,
         last: paging.limit,
-      }
-    } else if (!isNaN(paging?.after!)) {
+      };
+    } else if (!Number.isNaN(paging?.after!)) {
       payload = {
         after: paging.after,
         first: paging.limit,
-      }
-    } else if (!isNaN(paging?.limit!)) {
+      };
+    } else if (!Number.isNaN(paging?.limit!)) {
       payload = {
         last: paging.limit,
-      }
+      };
     }
-  }
-  else if (style === 'afterbeforeraw') {
-    payload = paging
+  } else if (style === 'afterbeforeraw') {
+    payload = paging;
   }
 
   // avoid sending {} as it seems backend flips when we do
-  if (!Object.keys(payload).length)
-    return
+  if (!Object.keys(payload).length) return;
 
   // don't try catch, let it throw
-  return encode(JSON.stringify(payload))
-}
-
+  return encode(JSON.stringify(payload));
+};
 
 /**
  * Converts a b64 string token into a paging object
@@ -122,32 +115,34 @@ export const toToken = (
  * @hidden
  */
 export const toPage = (token?: Amity.Token): Amity.Page | undefined => {
-  if (!token) return undefined
+  if (!token) return undefined;
 
   // don't try catch, let it throw
-  const json = JSON.parse(decode(token))
+  const json = JSON.parse(decode(token));
 
   if (isSkipLimit(json)) {
     return {
       after: json.skip,
       limit: json.limit!,
-    } as Amity.NextPage<number>
-  } else if (isAfterBefore(json)) {
+    } as Amity.NextPage<number>;
+  }
+  if (isAfterBefore(json)) {
     if ('before' in json) {
       return {
         before: json.before,
         limit: json.last,
-      } as Amity.PrevPage<number>
-    } else if ('after' in json) {
+      } as Amity.PrevPage<number>;
+    }
+    if ('after' in json) {
       return {
         after: json.after,
         limit: json.first,
-      } as Amity.NextPage<number>
+      } as Amity.NextPage<number>;
     }
   }
 
-  return undefined
-}
+  return undefined;
+};
 
 /**
  * Converts a b64 string token into a paging object
@@ -158,14 +153,14 @@ export const toPage = (token?: Amity.Token): Amity.Page | undefined => {
  * @hidden
  */
 export const toPageRaw = (token?: Amity.Token): Amity.PageRaw | undefined => {
-  if (!token) return undefined
+  if (!token) return undefined;
 
   // don't try catch, let it throw
-  const json = JSON.parse(decode(token))
+  const json = JSON.parse(decode(token));
 
   if (isAfterBeforeRaw(json)) {
-    return json as Amity.PageRaw
+    return json as Amity.PageRaw;
   }
 
-  return undefined
-}
+  return undefined;
+};