@amityco/ts-sdk 0.0.1-e5fb0d2.0 → 0.0.1-e643f6f.0

package/dist/utils/tests/dummy/user.d.ts

@@ -0,0 +1,98 @@
+export declare const user11: Amity.User;
+export declare const user12: Amity.User;
+export declare const user13: Amity.User;
+export declare const user14: Amity.User;
+export declare const user21: Amity.User;
+export declare const user22: Amity.User;
+export declare const userQueryResponse: {
+    data: {
+        users: Amity.User[];
+        files: never[];
+        paging: {
+            previous: string;
+            next: string;
+        };
+    };
+};
+export declare const userQueryResponsePage2: {
+    data: {
+        users: Amity.User[];
+        files: never[];
+        paging: {
+            previous: string;
+            next: string;
+        };
+    };
+};
+export declare const flaggedUser: {
+    userId: string;
+    flagCount: number;
+    _id: string;
+    displayName?: string | undefined;
+    avatarFileId?: string | undefined;
+    avatarCustomUrl?: string | undefined;
+    description?: string | undefined;
+    metadata?: Record<string, any> | undefined;
+    tags?: string[] | undefined;
+    hashFlag: {
+        bits: number;
+        hashes: number;
+        hash: string;
+    } | null;
+    roles: string[];
+    permissions: Amity.Permission[];
+    createdAt: string;
+    updatedAt?: string | undefined;
+    deletedAt?: string | undefined;
+    isDeleted?: boolean | undefined;
+    path: string;
+};
+export declare const flaggedUserQueryResponse: {
+    data: {
+        users: {
+            userId: string;
+            flagCount: number;
+            _id: string;
+            displayName?: string | undefined;
+            avatarFileId?: string | undefined;
+            avatarCustomUrl?: string | undefined;
+            description?: string | undefined;
+            metadata?: Record<string, any> | undefined;
+            tags?: string[] | undefined;
+            hashFlag: {
+                bits: number;
+                hashes: number;
+                hash: string;
+            } | null;
+            roles: string[];
+            permissions: Amity.Permission[];
+            createdAt: string;
+            updatedAt?: string | undefined;
+            deletedAt?: string | undefined;
+            isDeleted?: boolean | undefined;
+            path: string;
+        }[];
+        files: never[];
+    };
+};
+export declare const userUpdateResponse: {
+    data: {
+        users: {
+            isDeleted: boolean;
+            displayName: string;
+            userId: string;
+            metadata: {};
+            roles: never[];
+            permissions: never[];
+            flagCount: number;
+            hashFlag: null;
+            avatarCustomUrl: string;
+            avatarFileId: null;
+            isGlobalBan: boolean;
+        }[];
+        files: never[];
+    };
+};
+export declare const users: Amity.User[];
+export declare const userPayload: Amity.UserPayload;
+//# sourceMappingURL=user.d.ts.map

package/dist/utils/tests/dummy/user.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"user.d.ts","sourceRoot":"","sources":["../../../../src/utils/tests/dummy/user.ts"],"names":[],"mappings":"AAEA,eAAO,MAAM,MAAM,EAAE,KAAK,CAAC,IAS1B,CAAC;AAEF,eAAO,MAAM,MAAM,EAAE,KAAK,CAAC,IAG1B,CAAC;AAEF,eAAO,MAAM,MAAM,EAAE,KAAK,CAAC,IAG1B,CAAC;AAEF,eAAO,MAAM,MAAM,EAAE,KAAK,CAAC,IAG1B,CAAC;AAEF,eAAO,MAAM,MAAM,EAAE,KAAK,CAAC,IAI1B,CAAC;AAEF,eAAO,MAAM,MAAM,EAAE,KAAK,CAAC,IAG1B,CAAC;AAEF,eAAO,MAAM,iBAAiB;;;;;;;;;CAS7B,CAAC;AAEF,eAAO,MAAM,sBAAsB;;;;;;;;;CASlC,CAAC;AAEF,eAAO,MAAM,WAAW;;;;;;;;;;;;;;;;;;;;;;CAIvB,CAAC;AAEF,eAAO,MAAM,wBAAwB;;;;;;;;;;;;;;;;;;;;;;;;;;;CAKpC,CAAC;AAEF,eAAO,MAAM,kBAAkB;;;;;;;;;;;;;;;;;CAmB9B,CAAC;AAEF,eAAO,MAAM,KAAK,cAAmC,CAAC;AAGtD,eAAO,MAAM,WAAW,EAAE,KAAK,CAAC,WAG/B,CAAC"}

package/dist/utils/tests/index.d.ts

@@ -0,0 +1,4 @@
+export * from './utils';
+export * from './dummy';
+export * from './client';
+//# sourceMappingURL=index.d.ts.map

package/dist/utils/tests/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/utils/tests/index.ts"],"names":[],"mappings":"AAAA,cAAc,SAAS,CAAC;AACxB,cAAc,SAAS,CAAC;AACxB,cAAc,UAAU,CAAC"}

package/dist/utils/tests/liveObject.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=liveObject.test.d.ts.map

package/dist/utils/tests/liveObject.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"liveObject.test.d.ts","sourceRoot":"","sources":["../../../src/utils/tests/liveObject.test.ts"],"names":[],"mappings":""}

package/dist/utils/tests/utils.d.ts

@@ -0,0 +1,4 @@
+export declare const encodeJson: (value: Record<string, any>) => string;
+export declare const pause: (ms?: number) => Promise<unknown>;
+export declare const deepCopy: <T>(value: T) => T;
+//# sourceMappingURL=utils.d.ts.map

package/dist/utils/tests/utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../../src/utils/tests/utils.ts"],"names":[],"mappings":"AAEA,eAAO,MAAM,UAAU,UAAW,OAAO,MAAM,EAAE,GAAG,CAAC,WAAkC,CAAC;AAOxF,eAAO,MAAM,KAAK,mCAGd,CAAC;AAEL,eAAO,MAAM,QAAQ,oBAAwD,CAAC"}

package/dist/version.d.ts

@@ -0,0 +1,2 @@
+export declare const VERSION: string;
+//# sourceMappingURL=version.d.ts.map

package/dist/version.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"version.d.ts","sourceRoot":"","sources":["../src/version.ts"],"names":[],"mappings":"AASA,eAAO,MAAM,OAAO,QAAe,CAAC"}

package/jest.config.ts

@@ -0,0 +1,15 @@
+export default {
+  clearMocks: true,
+  collectCoverageFrom: ['**/*.ts', '!**/*.test.ts'],
+  coverageDirectory: '../coverage',
+  coveragePathIgnorePatterns: ['/node_modules/', '/dist/', '/@types/'],
+  coverageReporters: ['lcov', 'text', 'text-summary'],
+  globals: {
+    'ts-jest': {
+      useESM: true,
+    },
+  },
+  moduleNameMapper: { '~/(.*)$': '<rootDir>/$1' },
+  preset: 'ts-jest/presets/default-esm',
+  rootDir: 'src',
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@amityco/ts-sdk",
-  "version": "0.0.1-e5fb0d2.0",
+  "version": "0.0.1-e643f6f.0",
   "license": "CC-BY-ND-4.0",
   "author": "amity.co <developers@amity.co> (https://amity.co)",
   "description": "Amity Social Cloud Typescript SDK",
@@ -28,32 +28,40 @@
     "prebuild": "yarn run clean",
     "build": "rollup -c ./rollup.config.js",
     "prewatch": "yarn run clean",
-    "watch": "rollup -w -c ./rollup.config.js"
+    "watch": "rollup -w -c ./rollup.config.js",
+    "test": "jest",
+    "test:coverage": "jest --coverage --silent"
   },
   "devDependencies": {
-    "@rollup/plugin-commonjs": "^20.0.0",
-    "@rollup/plugin-node-resolve": "^13.0.4",
-    "@types/axios": "^0.14.0",
-    "@types/debug": "^4.1.5",
-    "@types/node": "^14.0.11",
+    "@rollup/plugin-commonjs": "^22.0.2",
+    "@rollup/plugin-node-resolve": "^13.3.0",
+    "@rollup/plugin-replace": "^4.0.0",
+    "@types/debug": "^4.1.7",
+    "@types/jest": "^27.5.1",
+    "@types/node": "^18.6.4",
     "@types/socket.io-client": "^1.4.34",
     "chalk": "^4.1.2",
     "concurrently": "^6.1.0",
+    "form-data": "^4.0.0",
+    "jest": "^28.1.0",
+    "nock": "^13.3.0",
     "rimraf": "^3.0.2",
-    "rollup": "^2.56.3",
-    "rollup-plugin-typescript2": "^0.30.0",
-    "tslib": "^2.1.0",
-    "typescript": "^4.4.2"
+    "rollup": "^2.77.2",
+    "rollup-plugin-terser": "^7.0.2",
+    "rollup-plugin-typescript2": "^0.32.1",
+    "tslib": "^2.4.0",
+    "typescript": "^4.7.4"
   },
   "dependencies": {
-    "@react-native-async-storage/async-storage": "^1.15.5",
-    "agentkeepalive": "^4.1.3",
-    "axios": "^0.21.1",
-    "debug": "^4.3.1",
-    "js-base64": "^3.6.1",
+    "@react-native-async-storage/async-storage": "^1.17.7",
+    "agentkeepalive": "^4.2.1",
+    "axios": "^1.2.3",
+    "debug": "^4.3.4",
+    "js-base64": "^3.7.2",
     "mitt": "^3.0.0",
+    "mqtt": "^4.3.7",
     "react-native-uuid": "^2.0.1",
     "socket.io-client": "2.2.0",
-    "typescript": "^4.4.2"
+    "ts-jest": "^28.0.3"
   }
 }

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,11 @@ declare global {
       INVALID_PARAMETERS = 800110,
       QUERY_IN_PROGRESS = 800170,
       CONNECTION_ERROR = 800210,
+      DISCONNECTED = 800211,
+      TOKEN_EXPIRED = 800403,
+      DISALOOW_UNSYNCED_OBJECT = 800800,
     }
+
+    type ErrorCode = ServerError | ClientError;
   }
 }

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

@@ -1,60 +1,165 @@
-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;
+
+      '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;
+      'user.didGlobalBan': Amity.UserPayload;
+    };
+
+    type MqttChannelUserEvents = {
+      'channel.joined': Amity.ChannelMembershipPayload;
+      'channel.left': Amity.ChannelMembershipPayload;
+      'channel.membersAdded': Amity.ChannelMembershipPayload;
+      'channel.membersRemoved': Amity.ChannelMembershipPayload;
+      'channel.banned': Amity.ChannelMembershipPayload;
+      'channel.unbanned': Amity.ChannelMembershipPayload;
+    };
+
+    type MqttChannelEvents = {
+      'channel.created': Amity.ChannelPayload;
+      'channel.updated': Amity.ChannelPayload;
+      'channel.deleted': Amity.ChannelPayload;
+      'channel.setMuted': Amity.ChannelPayload;
+    } & MqttChannelUserEvents;
+
+    type MqttSubChannelEvents = {
+      'message-feed.created': Amity.SubChannelPayload;
+      'message-feed.updated': Amity.SubChannelPayload;
+      'message-feed.deleted': Amity.SubChannelPayload;
+    };
+
+    type MqttMessageEvents = {
+      'message.created': Amity.MessagePayload;
+      'message.updated': Amity.MessagePayload;
+      'message.deleted': Amity.MessagePayload;
+      'message.flagged': Amity.MessagePayload;
+      'message.unflagged': Amity.MessagePayload;
+      'message.flagCleared': Amity.MessagePayload;
+      'message.reactionAdded': Amity.MessagePayload;
+      'message.reactionRemoved': Amity.MessagePayload;
+    };
+
+    type MqttCommunityUserEvents = {
+      'community.joined': Amity.CommunityMembershipPayload;
+      'community.left': Amity.CommunityMembershipPayload;
+      'community.userAdded': Amity.CommunityMembershipPayload;
+      'community.userRemoved': Amity.CommunityMembershipPayload;
+      'community.userChanged': Amity.CommunityMembershipPayload;
+      'community.userBanned': Amity.CommunityMembershipPayload;
+      'community.userUnbanned': Amity.CommunityMembershipPayload;
+      'community.roleAdded': Amity.CommunityMembershipPayload;
+      'community.roleRemoved': Amity.CommunityMembershipPayload;
+    };
+
+    type MqttCommunityEvents = {
+      'community.created': Amity.CommunityPayload;
+      'community.updated': Amity.CommunityPayload;
+      'community.deleted': Amity.CommunityPayload;
+    } & MqttCommunityUserEvents;
+
+    type MqttPostEvents = {
+      '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 MqttCommentEvents = {
+      '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 MqttUserEvents = {
+      '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 MqttFollowEvents = {
+      '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 MqttRTE = MqttChannelEvents &
+      MqttSubChannelEvents &
+      MqttMessageEvents &
+      MqttCommunityEvents &
+      MqttPostEvents &
+      MqttCommentEvents &
+      MqttUserEvents &
+      MqttFollowEvents;
+
+    type LocalEvents = {
+      'local.channel.updated': MakeRequired<Amity.ProcessedChannelPayload, 'channels'>;
+      'local.message.created': MakeRequired<Amity.ProcessedMessagePayload, 'messages'>;
+      'local.message.updated': MakeRequired<Amity.ProcessedMessagePayload, 'messages'>;
+      'local.message.deleted': MakeRequired<Amity.ProcessedMessagePayload, 'messages'>;
+      'local.message.fetched': MakeRequired<Amity.ProcessedMessagePayload, 'messages'>;
+      'local.message-feed.fetched': MakeRequired<Amity.ProcessedSubChannelPayload, 'messageFeeds'>;
+      'local.message-feed.deleted': MakeRequired<Amity.ProcessedSubChannelPayload, 'messageFeeds'>;
+      'poll.updated': MakeRequired<Amity.PollPayload, 'polls'>;
+      'poll.deleted': MakeRequired<Amity.PollPayload, 'polls'>;
+
+      sessionStateChange: Amity.SessionStates;
+      // used by accessTokenExpiryWatcher
+      tokenExpired: Amity.SessionStates.TOKEN_EXPIRED;
+      tokenTerminated: Amity.SessionStates.TERMINATED;
+    };
+
+    type Events = WsEvents & MqttEvents & MqttRTE & LocalEvents;
   }
 }