@amityco/ts-sdk 0.0.1-003998f.0

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

@@ -0,0 +1,74 @@
+export declare const channelRaw1: Amity.ChannelRaw;
+export declare const channelRaw2: Amity.ChannelRaw;
+export declare const channelRaw3: Amity.ChannelRaw;
+export declare const channel11: Amity.Channel;
+export declare const channel12: Amity.Channel;
+export declare const channel21: Amity.Channel;
+export declare const channelUser1: Amity.Membership<'channel'>;
+export declare const channelUser2: Amity.Membership<'channel'>;
+export declare const channelUser3: Amity.Membership<'channel'>;
+export declare const channelUser4: Amity.Membership<'channel'>;
+export declare const channelUser5: Amity.Membership<'channel'>;
+export declare const channelUser6: Amity.Membership<'channel'>;
+export declare const channelUser7: Amity.Membership<'channel'>;
+export declare const channelQueryResponse: {
+    data: {
+        paging: {
+            previous: string;
+            next: string;
+        };
+        channels: Amity.Channel<any>[];
+        channelUsers: never[];
+        files: never[];
+        users: never[];
+    };
+};
+export declare const channelQueryResponsePage2: {
+    data: {
+        paging: {
+            previous: string;
+            next: string;
+        };
+        channels: Amity.Channel<any>[];
+        channelUsers: never[];
+        files: never[];
+        users: never[];
+    };
+};
+export declare const channelUserQueryResponse: {
+    data: {
+        paging: {
+            previous: string;
+            next: string;
+        };
+        channels: Amity.Channel<any>[];
+        channelUsers: Amity.Membership<"channel">[];
+        users: never[];
+        files: never[];
+    };
+};
+export declare const channelUserQueryResponsePage2: {
+    data: {
+        paging: {
+            previous: string;
+            next: string;
+        };
+        channels: Amity.Channel<any>[];
+        channelUsers: Amity.Membership<"channel">[];
+        users: never[];
+        files: never[];
+    };
+};
+export declare const channelUserQueryResponsePage3: {
+    data: {
+        paging: {
+            previous: string;
+            next: string;
+        };
+        channels: Amity.Channel<any>[];
+        channelUsers: Amity.Membership<"channel">[];
+        users: never[];
+        files: never[];
+    };
+};
+//# sourceMappingURL=channel.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"channel.d.ts","sourceRoot":"","sources":["../../../../src/utils/tests/dummy/channel.ts"],"names":[],"mappings":"AASA,eAAO,MAAM,WAAW,EAAE,KAAK,CAAC,UAQ/B,CAAC;AAEF,eAAO,MAAM,WAAW,EAAE,KAAK,CAAC,UAQ/B,CAAC;AAEF,eAAO,MAAM,WAAW,EAAE,KAAK,CAAC,UAM/B,CAAC;AAEF,eAAO,MAAM,SAAS,EAAE,KAAK,CAAC,OAK7B,CAAC;AAEF,eAAO,MAAM,SAAS,EAAE,KAAK,CAAC,OAI7B,CAAC;AAEF,eAAO,MAAM,SAAS,EAAE,KAAK,CAAC,OAO7B,CAAC;AAEF,eAAO,MAAM,YAAY,EAAE,KAAK,CAAC,UAAU,CAAC,SAAS,CAYpD,CAAC;AAEF,eAAO,MAAM,YAAY,EAAE,KAAK,CAAC,UAAU,CAAC,SAAS,CAKpD,CAAC;AAEF,eAAO,MAAM,YAAY,EAAE,KAAK,CAAC,UAAU,CAAC,SAAS,CAapD,CAAC;AAEF,eAAO,MAAM,YAAY,EAAE,KAAK,CAAC,UAAU,CAAC,SAAS,CAGpD,CAAC;AAEF,eAAO,MAAM,YAAY,EAAE,KAAK,CAAC,UAAU,CAAC,SAAS,CAYpD,CAAC;AAEF,eAAO,MAAM,YAAY,EAAE,KAAK,CAAC,UAAU,CAAC,SAAS,CAYpD,CAAC;AAEF,eAAO,MAAM,YAAY,EAAE,KAAK,CAAC,UAAU,CAAC,SAAS,CAGpD,CAAC;AAEF,eAAO,MAAM,oBAAoB;;;;;;;;;;;CAQhC,CAAC;AAEF,eAAO,MAAM,yBAAyB;;;;;;;;;;;CAQrC,CAAC;AAEF,eAAO,MAAM,wBAAwB;;;;;;;;;;;CAQpC,CAAC;AAEF,eAAO,MAAM,6BAA6B;;;;;;;;;;;CAQzC,CAAC;AAEF,eAAO,MAAM,6BAA6B;;;;;;;;;;;CAQzC,CAAC"}

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

@@ -0,0 +1,12 @@
+export declare const follow11: Amity.FollowStatus;
+export declare const follow12: Amity.FollowStatus;
+export declare const follow13: Amity.FollowStatus;
+export declare const follow21: Amity.FollowStatus;
+export declare const follow22: Amity.FollowStatus;
+export declare const follow23: Amity.FollowStatus;
+export declare const follows: {
+    userId: string;
+    page1: Amity.FollowStatus[];
+    page2: Amity.FollowStatus[];
+};
+//# sourceMappingURL=follow.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"follow.d.ts","sourceRoot":"","sources":["../../../../src/utils/tests/dummy/follow.ts"],"names":[],"mappings":"AAQA,eAAO,MAAM,QAAQ,EAAE,KAAK,CAAC,YAK5B,CAAC;AAGF,eAAO,MAAM,QAAQ,EAAE,KAAK,CAAC,YAK5B,CAAC;AAGF,eAAO,MAAM,QAAQ,EAAE,KAAK,CAAC,YAK5B,CAAC;AAGF,eAAO,MAAM,QAAQ,EAAE,KAAK,CAAC,YAK5B,CAAC;AAGF,eAAO,MAAM,QAAQ,EAAE,KAAK,CAAC,YAK5B,CAAC;AAGF,eAAO,MAAM,QAAQ,EAAE,KAAK,CAAC,YAK5B,CAAC;AAEF,eAAO,MAAM,OAAO;;;;CAInB,CAAC"}

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

@@ -0,0 +1,11 @@
+export declare const date: string;
+export declare const rolesAndPermissions: {
+    roles: never[];
+    permissions: never[];
+};
+export * from './user';
+export * from './post';
+export * from './follow';
+export * from './channel';
+export * from './message';
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/utils/tests/dummy/index.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,IAAI,QAA2B,CAAC;AAC7C,eAAO,MAAM,mBAAmB;;;CAAiC,CAAC;AAElE,cAAc,QAAQ,CAAC;AACvB,cAAc,QAAQ,CAAC;AACvB,cAAc,UAAU,CAAC;AACzB,cAAc,WAAW,CAAC;AAC1B,cAAc,WAAW,CAAC"}

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

@@ -0,0 +1,19 @@
+export declare const message11: Amity.Message;
+export declare const messages: {
+    channelId: string;
+    page1: string[];
+    page2: string[];
+    page3: string[];
+};
+export declare const messageQueryResponse: {
+    data: {
+        messages: Amity.Message<any>[];
+        files: never[];
+        users: never[];
+        paging: {
+            previous: string;
+            next: string;
+        };
+    };
+};
+//# sourceMappingURL=message.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"message.d.ts","sourceRoot":"","sources":["../../../../src/utils/tests/dummy/message.ts"],"names":[],"mappings":"AAEA,eAAO,MAAM,SAAS,EAAE,KAAK,CAAC,OAc7B,CAAC;AAEF,eAAO,MAAM,QAAQ;;;;;CAKpB,CAAC;AAEF,eAAO,MAAM,oBAAoB;;;;;;;;;;CAUhC,CAAC"}

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

@@ -0,0 +1,9 @@
+export declare const post1: Amity.Post;
+export declare const posts: {
+    targetId: string;
+    targetType: Amity.PostTargetType;
+    page1: string[];
+    page2: string[];
+    page3: string[];
+};
+//# sourceMappingURL=post.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"post.d.ts","sourceRoot":"","sources":["../../../../src/utils/tests/dummy/post.ts"],"names":[],"mappings":"AAEA,eAAO,MAAM,KAAK,EAAE,KAAK,CAAC,IAoBzB,CAAC;AAEF,eAAO,MAAM,KAAK;;;;;;CAMjB,CAAC"}

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

@@ -0,0 +1,15 @@
+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;
+        };
+    };
+};
+//# 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"}

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,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":"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

@@ -0,0 +1,67 @@
+{
+  "name": "@amityco/ts-sdk",
+  "version": "0.0.1-003998f.0",
+  "license": "CC-BY-ND-4.0",
+  "author": "amity.co <developers@amity.co> (https://amity.co)",
+  "description": "Amity Social Cloud Typescript SDK",
+  "keywords": [
+    "amity",
+    "amity.co",
+    "social",
+    "messaging",
+    "chat",
+    "video",
+    "ts",
+    "js"
+  ],
+  "main": "./dist/index.cjs.js",
+  "module": "./dist/index.esm.js",
+  "unpkg": "./dist/index.umd.js",
+  "types": "./dist/index.d.ts",
+  "sideEffects": false,
+  "engines": {
+    "node": ">=12",
+    "npm": ">=6"
+  },
+  "scripts": {
+    "clean": "rimraf ./dist",
+    "prebuild": "yarn run clean",
+    "build": "rollup -c ./rollup.config.js",
+    "prewatch": "yarn run clean",
+    "watch": "rollup -w -c ./rollup.config.js",
+    "test": "jest",
+    "test:coverage": "jest --coverage --silent"
+  },
+  "devDependencies": {
+    "@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.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.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.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.3.7",
+    "qs": "^6.11.0",
+    "react-native-uuid": "^2.0.1",
+    "socket.io-client": "2.2.0",
+    "ts-jest": "^28.0.3"
+  }
+}

package/rollup.config.js

@@ -0,0 +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 replace from '@rollup/plugin-replace';
+import { terser } from 'rollup-plugin-terser';
+
+import pkg from './package.json';
+
+const config = {
+  input: 'src/index.ts',
+  plugins: [
+    resolve({
+      jsnext: true,
+      main: true,
+      builtins: false,
+      browser: true,
+    }),
+    commonjs(),
+    typescript({
+      useTsconfigDeclarationDir: true,
+    }),
+  ],
+  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);
+    }
+  },
+};
+
+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

@@ -0,0 +1,74 @@
+export {};
+
+declare global {
+  namespace Amity {
+    /**
+     * Union of acceptable types for a chunk of cache key.
+     * Recursive type which allow 3 primitives + array or object of them.
+     *
+     * @hidden
+     */
+    type Serializable =
+      | string
+      | number
+      | boolean
+      | undefined
+      | Serializable[]
+      | { [key: string]: Serializable };
+
+    /**
+     * 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 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

@@ -0,0 +1,39 @@
+export {};
+
+declare global {
+  namespace Amity {
+    const enum ErrorLevel {
+      ERROR = 'error',
+      FATAL = 'fatal',
+    }
+
+    const enum ServerError {
+      BAD_REQUEST = 400000,
+      UNAUTHORIZED = 400100,
+      PERMISSION_DENIED = 400301,
+      ITEM_NOT_FOUND = 400400,
+      CONFLICT = 400900,
+      FORBIDDEN = 400300,
+      USER_IS_MUTED = 400302,
+      CHANNEL_IS_MUTED = 400303,
+      CHANNEL_BAN = 400304,
+      GLOBAL_BAN = 400312,
+      NUMBER_OF_MEMBERS_EXCEEDED = 400305,
+      MAX_REPETITION_EXCEEDED = 400307,
+      BAN_WORD_FOUND = 400308,
+      LINK_NOT_ALLOWED = 400309,
+      BUSINESS_ERROR = 500000,
+    }
+
+    const enum ClientError {
+      UNKNOWN_ERROR = 800000,
+      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

@@ -0,0 +1,135 @@
+/* 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 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.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 MqttChannelUserMessageEvents = {
+      'channel.membersAdded': Amity.ChannelMembershipPayload;
+      'channel.membersRemoved': Amity.ChannelMembershipPayload;
+      'channel.banned': Amity.ChannelMembershipPayload;
+      'channel.unbanned': Amity.ChannelMembershipPayload;
+    };
+
+    type MqttChannelMessageEvents = {
+      'channel.created': Amity.ChannelPayload;
+      'channel.updated': Amity.ChannelPayload;
+      'channel.deleted': Amity.ChannelPayload;
+      'channel.joined': Amity.ChannelPayload;
+      'channel.leave': Amity.ChannelPayload;
+      'channel.setMuted': Amity.ChannelPayload;
+    } & MqttChannelUserMessageEvents;
+
+    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 = MqttChannelMessageEvents &
+      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 };
+  }
+}