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

package/rollup.config.js

@@ -1,41 +1,84 @@
-import chalk from 'chalk'
-import commonjs from '@rollup/plugin-commonjs'
-import resolve from '@rollup/plugin-node-resolve'
-import typescript from 'rollup-plugin-typescript2'
+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'
+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') {
-      console.log(chalk.red('error'), warning.message)
-      process.exit(1)
+    // 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.NODE_ENV': `'${process.env.NODE_ENV}'`,
+        '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.NODE_ENV': `'${process.env.NODE_ENV}'`,
+        'process.env.VERSION': `'v${pkg.version}-cjs'`,
+      }),
+    ],
+  },
+  {
+    ...config,
+    output: {
+      format: 'iife',
+      name: 'Amity',
+      file: pkg.unpkg,
+    },
+    plugins: [
+      ...config.plugins,
+      replace({
+        'process.env.NODE_ENV': `'${process.env.NODE_ENV}'`,
+        'process.env.VERSION': `'v${pkg.version}-umd'`,
+      }),
+      terser(),
+    ],
+  },
+];

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

@@ -1,22 +1,74 @@
-export {}
+export {};
 
 declare global {
   namespace Amity {
     /**
-     * The typing of cache allows to distribute the typings properly for each values
-     * of T, so that there will be a proper auto-completion for K = "user" or K = "file"
+     * Union of acceptable types for a chunk of cache key.
+     * Recursive type which allow 3 primitives + array or object of them.
+     *
      * @hidden
      */
-    type Cache = {
-      lookup: Record<string, string>,
-    } & {
-      [K in keyof Amity.Model]?: Amity.Store<Amity.Model[K]>
-    }
+    type Serializable =
+      | string
+      | number
+      | boolean
+      | undefined
+      | Serializable[]
+      | { [key: string]: Serializable };
 
     /**
-     * Possible stores should be restricted to the one to fit in cache
-     * @hidden
+     * Cache key description. Similarly to react-query,
+     * the key is an array of serializable values.
+     */
+    type CacheKey = Serializable[];
+
+    /**
+     * Cache options are separated from CacheEntry for further type
+     * manipulations and passing of options in functions.
+     *
+     * The cache options are:
+     *   - cachedAt(number): used to check is the cached content is still
+     *     considered fresh or not.
+     *
+     *   - offline(boolean): used to determine if the entry must be
+     *     saved in persistent storage on top of the regular caching.
+     */
+    type CacheOptions = {
+      cachedAt: number | undefined;
+      offline?: boolean;
+    };
+
+    type TombstoneCacheOptions = {
+      cachedAt: number;
+    };
+
+    /**
+     * Cache entry wrapper. It contains the cached content
+     * itself (data: T) and also several other properties
+     * through CacheOptions to allow fine tuned control.
+     */
+    type CacheEntry<T extends unknown = unknown> = {
+      key: CacheKey;
+      data: T;
+    } & CacheOptions;
+
+    /**
+     * Minimal CacheEntry alias, used mostly
      */
-    type Domain = keyof Amity.Model
+    type Cached<T extends unknown = unknown> = (T extends Amity.Paged<any, infer K>
+      ? T
+      : { data: T }) & {
+      cachedAt: CacheOptions['cachedAt'];
+    };
+
+    /**
+     * Main interface for the cache data structure. There's no direct
+     * methods there as we want to keep the object easily serializable
+     * (over JSON.stringify/parse) for simple backup/hydration.
+     */
+    type Cache = {
+      data: Record<string, CacheEntry>;
+      persistIf?: (key: CacheKey, data?: any) => boolean;
+    };
   }
 }

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

@@ -1,4 +1,4 @@
-export {}
+export {};
 
 declare global {
   namespace Amity {
@@ -15,8 +15,9 @@ declare global {
       CONFLICT = 400900,
       FORBIDDEN = 400300,
       USER_IS_MUTED = 400302,
-      USER_IS_BANNED = 400304,
       CHANNEL_IS_MUTED = 400303,
+      CHANNEL_BAN = 400304,
+      GLOBAL_BAN = 400312,
       NUMBER_OF_MEMBERS_EXCEEDED = 400305,
       MAX_REPETITION_EXCEEDED = 400307,
       BAN_WORD_FOUND = 400308,
@@ -29,6 +30,10 @@ declare global {
       INVALID_PARAMETERS = 800110,
       QUERY_IN_PROGRESS = 800170,
       CONNECTION_ERROR = 800210,
+      DISCONNECTED = 800211,
+      DISALOOW_UNSYNCED_OBJECT = 800800,
     }
+
+    type ErrorCode = ServerError | ClientError;
   }
 }

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

@@ -1,60 +1,128 @@
-export {}
+/* eslint-disable camelcase */
+import { IConnectPacket, IDisconnectPacket, IPublishPacket } from 'mqtt/dist/mqtt';
+
+export {};
 
 declare global {
   namespace Amity {
-    type Listener<T = any> = (params: T) => void
-
-    type ObjectListener<T, K extends string[]> = Listener<T> | {
-      onEvent?: (event: K[number], params: T) => void
-    } & {
-      [P in K[number]]?: Listener<T>
-    }
-
-    type Unsubscriber = () => void
-
-    type Subscriber<T = any> = (fn: Amity.Listener<T>) => Unsubscriber
-
-    type Events = {
-      disconnected: string | undefined
-      'v3.user.didUpdate': Amity.UserPayload
-
-      'v3.channel.didCreate': Amity.ChannelPayload
-      'v3.channel.didUpdate': Amity.ChannelPayload
-      'v3.channel.didDelete': Amity.ChannelPayload
-      'v3.channel.didJoin': Amity.ChannelPayload
-      'v3.channel.didLeave': Amity.ChannelPayload
-      'v3.channel.didAddUsers': Amity.ChannelPayload
-      'v3.channel.didRemoveUsers': Amity.ChannelPayload
-      'v3.channel.didBan': Amity.ChannelPayload
-      'v3.channel.didUnban': Amity.ChannelPayload
-
-      'v3.message.didCreate': Amity.MessagePayload
-      'v3.message.didUpdate': Amity.MessagePayload
-      'v3.message.didDelete': Amity.MessagePayload
-
-      'video-streaming.didRecord': Amity.StreamPayload
-      'video-streaming.didStart': Amity.StreamPayload
-      'video-streaming.didStop': Amity.StreamPayload
-
-      // 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 Listener<T = any> = (params: T) => void;
+
+    type ObjectListener<T, K extends string[]> =
+      | Listener<T>
+      | ({
+          onEvent?: (event: K[number], params: T) => void;
+        } & {
+          [P in K[number]]?: Listener<T>;
+        });
+
+    type Unsubscriber = () => void;
+
+    type Subscriber<T = any> = (fn: Amity.Listener<T>) => Unsubscriber;
+
+    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.channel.didCreate': Amity.ChannelPayload;
+      'v3.channel.didUpdate': Amity.ChannelPayload;
+      'v3.channel.didDelete': Amity.ChannelPayload;
+      'v3.channel.didJoin': Amity.ChannelPayload;
+      'v3.channel.didLeave': Amity.ChannelPayload;
+      'v3.channel.didAddUsers': Amity.ChannelMembershipPayload;
+      'v3.channel.didRemoveUsers': Amity.ChannelMembershipPayload;
+      'v3.channel.didBan': Amity.ChannelPayload;
+      'v3.channel.didUnban': Amity.ChannelPayload;
+
+      'v3.message.didFetch': Amity.MessagePayload;
+      'v3.message.didCreate': Amity.MessagePayload;
+      'v3.message.didUpdate': Amity.MessagePayload;
+      'v3.message.didDelete': Amity.MessagePayload;
+
+      '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.CommunityMembershipPayload;
+      'community.left': Amity.CommunityMembershipPayload;
+      'community.userAdded': Amity.CommunityMembershipPayload;
+      'community.userRemoved': Amity.CommunityMembershipPayload;
+      'community.userBanned': Amity.CommunityMembershipPayload;
+      'community.userUnbanned': Amity.CommunityMembershipPayload;
+    };
+
+    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.fetched': Amity.UserPayload;
+      'user.updated': Amity.UserPayload;
+      'user.deleted': Amity.UserPayload; // received from network topic
+      'user.flagged': Amity.UserPayload;
+      'user.unflagged': Amity.UserPayload;
+      'user.flagCleared': Amity.UserPayload;
+    };
+
+    type MqttFollowMessageEvents = {
+      'follow.created': Amity.FollowersPayload | Amity.FollowStatusPayload;
+      'follow.requested': Amity.FollowersPayload | Amity.FollowStatusPayload;
+      'follow.accepted': Amity.FollowersPayload | Amity.FollowStatusPayload;
+      'follow.unfollowed': Amity.FollowersPayload | Amity.FollowStatusPayload;
+      'follow.requestCanceled': Amity.FollowersPayload | Amity.FollowStatusPayload;
+      'follow.requestDeclined': Amity.FollowersPayload | Amity.FollowStatusPayload;
+      'follow.followerDeleted': Amity.FollowersPayload | Amity.FollowStatusPayload;
+    };
+
+    type MqttMessageEvents = MqttCommunityMessageEvents &
+      MqttPostMessageEvents &
+      MqttCommentMessageEvents &
+      MqttUserMessageEvents &
+      MqttFollowMessageEvents;
+
+    type LocalEvents = {
+      'poll.updated': Amity.PollPayload;
+      'poll.deleted': Amity.PollPayload;
+    };
+
+    type Events = WsEvents & MqttEvents & MqttMessageEvents & LocalEvents;
   }
 }

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

@@ -0,0 +1,34 @@
+export {};
+
+declare global {
+  namespace Amity {
+    type LiveObject<T extends any> = {
+      data: T;
+      error?: any;
+      loading: boolean;
+      origin?: 'local' | 'server' | 'event';
+    };
+
+    type LiveObjectCallback<T extends any> = Amity.Listener<LiveObject<T>>;
+
+    type LiveCollection<T extends any> = LiveObject<T[]> & {
+      onNextPage: () => void;
+      hasNextPage: boolean;
+    };
+
+    type LiveCollectionCallback<T extends any> = Amity.Listener<LiveCollection<T>>;
+
+    type LiveCollectionConfig = {
+      policy?: Exclude<Amity.QueryPolicy, 'no_fetch'>;
+    };
+
+    type LiveCollectionParams<T extends any> = T & {
+      limit?: number;
+    };
+
+    type LiveCollectionCache<T extends any, U extends any> = Pick<
+      LiveCollection<T>,
+      'data' | 'error' | 'loading'
+    > & { params: U };
+  }
+}

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

@@ -1,4 +1,4 @@
-export {}
+export {};
 
 declare global {
   namespace Amity {
@@ -7,21 +7,29 @@ declare global {
      * @hidden
      */
     type Model = {
-      'user': Amity.User
-      'file': Amity.File
-      'role': Amity.Role
+      user: Amity.User;
+      file: Amity.File;
+      role: Amity.Role;
 
-      'channel': Amity.Channel
-      'channelUsers': Amity.Membership<'channel'>
-      'message': Amity.Message
+      channel: Amity.Channel;
+      channelUsers: Amity.Membership<'channel'>;
+      message: Amity.Message;
 
-      'community': Amity.Community
-      'communityUsers': Amity.Membership<'community'>
-      'post': Amity.Post
-      'comment': Amity.Comment
+      community: Amity.Community;
+      category: Amity.Category;
+      communityUsers: Amity.Membership<'community'>;
+      post: Amity.Post;
+      comment: Amity.Comment;
+      poll: Amity.Poll;
+      reaction: Amity.Reaction;
 
-      'stream': Amity.Stream
-    }
+      stream: Amity.Stream;
+
+      follow: Amity.FollowStatus;
+      followCount: Amity.FollowCount;
+    };
+
+    type Domain = keyof Model;
 
     /**
      * Definition of the minimal set of properties necessary to identify
@@ -29,23 +37,26 @@ declare global {
      * @hidden
      */
     type Minimal = {
-      'user': Pick<Amity.User, 'userId'>
-      'file': Pick<Amity.File, 'fileId'>
-      'role': Pick<Amity.Role, 'roleId'>
-
-      'channel': Pick<Amity.Channel, 'channelId'>
-      'channelUsers': Pick<Amity.Membership<'channel'>, 'channelId' | 'userId'>
-      'message': Pick<Amity.Message, 'messageId'>
-
-      'community': Pick<Amity.Community, 'communityId'>
-      'communityUsers': Pick<
-        Amity.Membership<'community'>,
-        'communityId' | 'userId'
-      >
-      'post': Pick<Amity.Post, 'postId'>
-      'comment': Pick<Amity.Comment, 'commentId'>
-
-      'stream': Pick<Amity.Stream, 'streamId'>
-    }
+      user: Pick<Amity.User, 'userId'>;
+      file: Pick<Amity.File, 'fileId'>;
+      role: Pick<Amity.Role, 'roleId'>;
+
+      channel: Pick<Amity.Channel, 'channelId'>;
+      channelUsers: Pick<Amity.Membership<'channel'>, 'channelId' | 'userId'>;
+      message: Pick<Amity.Message, 'messageId'>;
+
+      community: Pick<Amity.Community, 'communityId'>;
+      category: Pick<Amity.Category, 'categoryId'>;
+      communityUsers: Pick<Amity.Membership<'community'>, 'communityId' | 'userId'>;
+      post: Pick<Amity.Post, 'postId'>;
+      comment: Pick<Amity.Comment, 'commentId'>;
+      poll: Pick<Amity.Poll, 'pollId'>;
+      reaction: Pick<Amity.Reaction, 'reactionId'>;
+
+      stream: Pick<Amity.Stream, 'streamId'>;
+
+      follow: Pick<Amity.FollowStatus, 'from' | 'to'>;
+      followCount: Pick<Amity.FollowCount, 'userId'>;
+    };
   }
 }

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

@@ -0,0 +1,60 @@
+export {};
+
+declare global {
+  namespace Amity {
+    type PaginationStyles = 'skiplimit' | 'afterbefore' | 'afterbeforeraw';
+
+    type PageLimit = {
+      limit: number;
+    };
+
+    type PrevPage<T extends number | string> = PageLimit & {
+      after?: never;
+      before?: T;
+    };
+
+    type NextPage<T extends number | string> = PageLimit & {
+      after?: T;
+      before?: never;
+    };
+
+    type Page<T extends number | string = number> = PrevPage<T> | NextPage<T>;
+
+    /*
+      updatedAt is here because if you need sort by updatedAt you
+      need to include this data in query also
+    */
+    type PageRaw = (PrevPage<string> | NextPage<string>) & {
+      updatedAt?: string;
+    };
+
+    type SkipLimitPagination = {
+      skip?: number;
+      limit?: number;
+    };
+
+    /*
+      WARNING:
+      in traditional "before/after" pagination, 'before' and 'after'
+      normally should be strings representing the unique id of the
+      resource. for some reason, our backend uses a number instead,
+      bound to "channelSegment" (for message) and "segmentNumber" (
+      for comments). so we have to cast this as number.
+    */
+    type AfterBeforePagination = {
+      before?: number;
+      after?: number;
+      first?: number;
+      last?: number;
+    };
+
+    type AfterBeforeRawPagination = PageRaw;
+
+    type Pages<T extends Page | PageRaw> = {
+      nextPage?: T;
+      prevPage?: T;
+    };
+
+    type Paged<T, K extends Page | PageRaw = Page> = { data: T[] } & Pages<K>;
+  }
+}