@amityco/ts-sdk 0.0.1-be4fc2f.0 → 0.0.1-bef76fa.0

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

@@ -0,0 +1,17 @@
+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 userQueryResponse: {
+    data: {
+        users: Amity.User[];
+        files: never[];
+        paging: {
+            previous: string;
+            next: string;
+        };
+    };
+};
+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,IAQ1B,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,iBAAiB;;;;;;;;;CAS7B,CAAC;AACF,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/utils.d.ts

@@ -0,0 +1,3 @@
+export declare const encodeJson: (value: Record<string, any>) => string;
+export declare const pause: (ms?: number) => Promise<unknown>;
+//# 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"}

package/dist/version.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"version.d.ts","sourceRoot":"","sources":["../src/version.ts"],"names":[],"mappings":"AACA,eAAO,MAAM,OAAO,QAAmC,CAAA"}
+{"version":3,"file":"version.d.ts","sourceRoot":"","sources":["../src/version.ts"],"names":[],"mappings":"AAGA,eAAO,MAAM,OAAO,QAAwC,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-be4fc2f.0",
+  "version": "0.0.1-bef76fa.0",
   "license": "CC-BY-ND-4.0",
   "author": "amity.co <developers@amity.co> (https://amity.co)",
   "description": "Amity Social Cloud Typescript SDK",
@@ -28,35 +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",
-    "@rollup/plugin-replace": "^3.0.0",
+    "@rollup/plugin-commonjs": "^22.0.2",
+    "@rollup/plugin-node-resolve": "^13.3.0",
+    "@rollup/plugin-replace": "^4.0.0",
     "@types/axios": "^0.14.0",
-    "@types/debug": "^4.1.5",
-    "@types/node": "^14.0.11",
+    "@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",
+    "jest": "^28.1.0",
     "rimraf": "^3.0.2",
-    "rollup": "^2.56.3",
+    "rollup": "^2.77.2",
     "rollup-plugin-terser": "^7.0.2",
-    "rollup-plugin-typescript2": "^0.30.0",
-    "tslib": "^2.1.0",
-    "typescript": "^4.4.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": "^0.27.2",
+    "debug": "^4.3.4",
+    "js-base64": "^3.7.2",
     "mitt": "^3.0.0",
-    "mqtt": "^4.2.8",
+    "mqtt": "^4.3.7",
+    "qs": "^6.11.0",
     "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,11 +1,11 @@
-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 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';
 
 const config = {
   input: 'src/index.ts',
@@ -24,11 +24,11 @@ const config = {
   onwarn: warning => {
     // 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)
+      console.log(chalk.red('error'), warning.message);
+      process.exit(1);
     }
   },
-}
+};
 
 export default [
   {
@@ -43,6 +43,7 @@ export default [
     plugins: [
       ...config.plugins,
       replace({
+        'process.env.NODE_ENV': `'${process.env.NODE_ENV}'`,
         'process.env.VERSION': `'v${pkg.version}-esm'`,
       }),
     ],
@@ -59,6 +60,7 @@ export default [
     plugins: [
       ...config.plugins,
       replace({
+        'process.env.NODE_ENV': `'${process.env.NODE_ENV}'`,
         'process.env.VERSION': `'v${pkg.version}-cjs'`,
       }),
     ],
@@ -73,9 +75,10 @@ export default [
     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 {
@@ -7,8 +7,6 @@ declare global {
       FATAL = 'fatal',
     }
 
-    type ErrorCode = ServerError | ClientError
-
     const enum ServerError {
       BAD_REQUEST = 400000,
       UNAUTHORIZED = 400100,
@@ -33,6 +31,9 @@ declare global {
       QUERY_IN_PROGRESS = 800170,
       CONNECTION_ERROR = 800210,
       DISCONNECTED = 800211,
+      DISALOOW_UNSYNCED_OBJECT = 800800,
     }
+
+    type ErrorCode = ServerError | ClientError;
   }
 }

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

@@ -1,103 +1,129 @@
-import { IConnectPacket, IDisconnectPacket, IPublishPacket } from 'mqtt'
+/* eslint-disable camelcase */
+import { IConnectPacket, IDisconnectPacket, IPublishPacket } from 'mqtt/dist/mqtt';
 
-export {}
+export {};
 
 declare global {
   namespace Amity {
-    type Listener<T = any> = (params: T) => void
+    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 ObjectListener<T, K extends string[]> =
+      | Listener<T>
+      | ({
+          onEvent?: (event: K[number], params: T) => void;
+        } & {
+          [P in K[number]]?: Listener<T>;
+        });
 
-    type Unsubscriber = () => void
+    type Unsubscriber = () => void;
 
-    type Subscriber<T = any> = (fn: Amity.Listener<T>) => Unsubscriber
+    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.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
-    }
+      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.didMarkSeen': 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,
-    }
+      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
-      'community.joined': Amity.CommunityPayload
-      'community.left': Amity.CommunityPayload
-      'community.userAdded': Amity.CommunityPayload
-      'community.userRemoved': Amity.CommunityPayload
-      'community.userBanned': Amity.CommunityPayload
-      'community.userUnbanned': Amity.CommunityPayload
-    }
+      'community.created': Amity.CommunityPayload;
+      'community.updated': Amity.CommunityPayload;
+      'community.deleted': Amity.CommunityPayload;
+    } & MqttCommunityUserMessageEvents;
 
     type MqttPostMessageEvents = {
-      'post.created': Amity.PostPayload
-      'post.updated': Amity.PostPayload
-      'post.afterDeleted': Amity.PostPayload
-      'post.approved': Amity.PostPayload
-      'post.declined': Amity.PostPayload
-      'post.flagged': Amity.PostPayload
-      'post.unflagged': Amity.PostPayload
-      'post.addReaction': Amity.PostPayload
-      'post.removeReaction': Amity.PostPayload
-    }
+      '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
-      'comment.removeReaction': Amity.CommentPayload
-    }
+      '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
+      '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'>;
+    };
   }
 }