@amityco/ts-sdk 0.0.1-beta.25 → 0.0.1-beta.26

package/dist/post/api/queryPosts.d.ts

@@ -13,18 +13,7 @@
  * @async
  */
 export declare const queryPosts: {
-    (query: {
-        targetId: string;
-        targetType: Amity.Post['targetType'];
-        sortBy?: 'lastCreated' | 'firstCreated' | 'lastUpdated' | 'firstUpdated';
-        dataType?: string;
-        isDeleted?: Amity.Post['isDeleted'];
-        hasFlag?: boolean;
-        feedType?: 'reviewing' | 'published';
-        tags?: Amity.Taggable['tags'];
-        matchingOnlyParentPost?: boolean;
-        page?: Amity.PageRaw;
-    }): Promise<Amity.Cached<Amity.Paged<Amity.Post, Amity.PageRaw>>>;
+    (query: Amity.QueryPosts): Promise<Amity.Cached<Amity.Paged<Amity.Post, Amity.PageRaw>>>;
     /**
      * ```js
      * import { queryPosts } from '@amityco/ts-sdk'

package/dist/post/api/queryPosts.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"queryPosts.d.ts","sourceRoot":"","sources":["../../../src/post/api/queryPosts.ts"],"names":[],"mappings":"AAQA;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,UAAU;YAAiB;QACtC,QAAQ,EAAE,MAAM,CAAC;QACjB,UAAU,EAAE,MAAM,IAAI,CAAC,YAAY,CAAC,CAAC;QACrC,MAAM,CAAC,EAAE,aAAa,GAAG,cAAc,GAAG,aAAa,GAAG,cAAc,CAAC;QACzE,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,SAAS,CAAC,EAAE,MAAM,IAAI,CAAC,WAAW,CAAC,CAAC;QACpC,OAAO,CAAC,EAAE,OAAO,CAAC;QAClB,QAAQ,CAAC,EAAE,WAAW,GAAG,WAAW,CAAC;QACrC,IAAI,CAAC,EAAE,MAAM,QAAQ,CAAC,MAAM,CAAC,CAAC;QAC9B,sBAAsB,CAAC,EAAE,OAAO,CAAC;QACjC,IAAI,CAAC,EAAE,MAAM,OAAO,CAAC;KACtB,GAAG,QAAQ,MAAM,MAAM,CAAC,MAAM,KAAK,CAAC,MAAM,IAAI,EAAE,MAAM,OAAO,CAAC,CAAC,CAAC;IAuCjE;;;;;;;;;;;;OAYG;mBAEM,WAAW,iBAAiB,CAAC,CAAC,CAAC,CAAC,GACtC,MAAM,MAAM,CAAC,MAAM,KAAK,CAAC,MAAM,IAAI,EAAE,MAAM,OAAO,CAAC,CAAC,GAAG,SAAS;CAjBlE,CAAC"}
+{"version":3,"file":"queryPosts.d.ts","sourceRoot":"","sources":["../../../src/post/api/queryPosts.ts"],"names":[],"mappings":"AAQA;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,UAAU;YACd,MAAM,UAAU,GACtB,QAAQ,MAAM,MAAM,CAAC,MAAM,KAAK,CAAC,MAAM,IAAI,EAAE,MAAM,OAAO,CAAC,CAAC,CAAC;IAuChE;;;;;;;;;;;;OAYG;mBAEM,WAAW,iBAAiB,CAAC,CAAC,CAAC,CAAC,GACtC,MAAM,MAAM,CAAC,MAAM,KAAK,CAAC,MAAM,IAAI,EAAE,MAAM,OAAO,CAAC,CAAC,GAAG,SAAS;CAjBlE,CAAC"}

package/dist/post/observers/index.d.ts

@@ -1,3 +1,4 @@
 export * from './observePosts';
 export * from './observePost';
+export * from './livePosts';
 //# sourceMappingURL=index.d.ts.map

package/dist/post/observers/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/post/observers/index.ts"],"names":[],"mappings":"AAAA,cAAc,gBAAgB,CAAC;AAC/B,cAAc,eAAe,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/post/observers/index.ts"],"names":[],"mappings":"AAAA,cAAc,gBAAgB,CAAC;AAC/B,cAAc,eAAe,CAAC;AAC9B,cAAc,aAAa,CAAC"}

package/dist/post/observers/livePosts.d.ts

@@ -0,0 +1,22 @@
+/**
+ * ```js
+ * import { livePosts } from '@amityco/ts-sdk'
+ *
+ * let posts = []
+ * const unsub = livePosts({
+ *   targetType: Amity.PostTargetType,
+ *   targetId: Amity.Post['targetId'],
+ * }, response => merge(posts, response.data))
+ * ```
+ *
+ * Observe all mutations on a list of {@link Amity.Post} for a given target object
+ *
+ * @param targetType the type of the target
+ * @param targetId the ID of the target
+ * @param callback the function to call when new data are available
+ * @returns An {@link Amity.Unsubscriber} function to run when willing to stop observing the messages
+ *
+ * @category Posts Live Collection
+ */
+export declare const livePosts: (params: Amity.PostLiveCollection, callback: Amity.LiveCollectionCallback<Amity.Post>, config?: Amity.LiveCollectionConfig) => Amity.Unsubscriber;
+//# sourceMappingURL=livePosts.d.ts.map

package/dist/post/observers/livePosts.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"livePosts.d.ts","sourceRoot":"","sources":["../../../src/post/observers/livePosts.ts"],"names":[],"mappings":"AA+BA;;;;;;;;;;;;;;;;;;;GAmBG;AACH,eAAO,MAAM,SAAS,WACZ,MAAM,kBAAkB,YACtB,MAAM,sBAAsB,CAAC,MAAM,IAAI,CAAC,WACzC,MAAM,oBAAoB,KAClC,MAAM,YAkHR,CAAC"}

package/dist/post/observers/observePosts.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"observePosts.d.ts","sourceRoot":"","sources":["../../../src/post/observers/observePosts.ts"],"names":[],"mappings":"AAcA;;;;;;;;;;;;;;;;;;;GAmBG;AACH,eAAO,MAAM,YAAY,WACf;IACN,UAAU,EAAE,MAAM,cAAc,CAAC;IACjC,QAAQ,EAAE,MAAM,IAAI,CAAC,UAAU,CAAC,CAAC;CAClC,YACS,MAAM,cAAc,CAC5B,MAAM,IAAI,EACV;IACE,UAAU;IACV,UAAU;IACV,UAAU;IACV,YAAY;IACZ,YAAY;IACZ,WAAW;IACX,aAAa;IACb,iBAAiB;IACjB,mBAAmB;CACpB,CACF,KACA,MAAM,YA6CR,CAAC"}
+{"version":3,"file":"observePosts.d.ts","sourceRoot":"","sources":["../../../src/post/observers/observePosts.ts"],"names":[],"mappings":"AAcA;;;;;;;;;;;;;;;;;;;GAmBG;AACH,eAAO,MAAM,YAAY,WACf;IACN,UAAU,EAAE,MAAM,cAAc,CAAC;IACjC,QAAQ,EAAE,MAAM,IAAI,CAAC,UAAU,CAAC,CAAC;CAClC,YACS,MAAM,cAAc,CAC5B,MAAM,IAAI,EACV;IACE,UAAU;IACV,UAAU;IACV,UAAU;IACV,YAAY;IACZ,YAAY;IACZ,WAAW;IACX,aAAa;IACb,iBAAiB;IACjB,mBAAmB;CACpB,CACF,KACA,MAAM,YAiCR,CAAC"}

package/dist/post/tests/api/getPost.test.d.ts

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

package/dist/post/tests/api/getPost.test.d.ts.map

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

package/dist/post/tests/api/queryPosts.test.d.ts

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

package/dist/post/tests/api/queryPosts.test.d.ts.map

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

package/dist/reaction/api/queryReactions.d.ts

@@ -19,6 +19,6 @@ export declare const queryReactions: (query: {
     referenceId: Amity.Reaction['referenceId'];
     referenceType: Amity.Reaction['referenceType'];
     reactionName?: Amity.Reaction['reactionName'];
-    page?: Amity.Page;
-}) => Promise<Amity.Paged<Amity.ReactionQuery, Amity.Page>>;
+    page?: Amity.Page<string>;
+}) => Promise<Amity.Paged<Amity.ReactionQuery, Amity.Page<string>>>;
 //# sourceMappingURL=queryReactions.d.ts.map

package/dist/reaction/api/queryReactions.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"queryReactions.d.ts","sourceRoot":"","sources":["../../../src/reaction/api/queryReactions.ts"],"names":[],"mappings":"AAIA;;;;;;;;;;;;;;;;KAgBK;AACL,eAAO,MAAM,cAAc,UAAiB;IAC1C,WAAW,EAAE,MAAM,QAAQ,CAAC,aAAa,CAAC,CAAC;IAC3C,aAAa,EAAE,MAAM,QAAQ,CAAC,eAAe,CAAC,CAAC;IAC/C,YAAY,CAAC,EAAE,MAAM,QAAQ,CAAC,cAAc,CAAC,CAAC;IAC9C,IAAI,CAAC,EAAE,MAAM,IAAI,CAAC;CACnB,KAAG,QAAQ,MAAM,KAAK,CAAC,MAAM,aAAa,EAAE,MAAM,IAAI,CAAC,CAyBvD,CAAC"}
+{"version":3,"file":"queryReactions.d.ts","sourceRoot":"","sources":["../../../src/reaction/api/queryReactions.ts"],"names":[],"mappings":"AAIA;;;;;;;;;;;;;;;;KAgBK;AACL,eAAO,MAAM,cAAc,UAAiB;IAC1C,WAAW,EAAE,MAAM,QAAQ,CAAC,aAAa,CAAC,CAAC;IAC3C,aAAa,EAAE,MAAM,QAAQ,CAAC,eAAe,CAAC,CAAC;IAC/C,YAAY,CAAC,EAAE,MAAM,QAAQ,CAAC,cAAc,CAAC,CAAC;IAC9C,IAAI,CAAC,EAAE,MAAM,IAAI,CAAC,MAAM,CAAC,CAAC;CAC3B,KAAG,QAAQ,MAAM,KAAK,CAAC,MAAM,aAAa,EAAE,MAAM,IAAI,CAAC,MAAM,CAAC,CAAC,CAyB/D,CAAC"}

package/dist/role/api/queryRoles.d.ts

@@ -15,10 +15,10 @@
  */
 export declare const queryRoles: {
     (query?: {
-        displayName?: string | undefined;
-        sortBy?: "displayName" | "firstCreated" | "lastCreated" | undefined;
-        page?: Amity.Page | undefined;
-    } | undefined): Promise<Amity.Cached<Amity.Paged<Amity.Role>>>;
+        displayName?: Amity.Role['displayName'];
+        sortBy?: 'displayName' | 'firstCreated' | 'lastCreated';
+        page?: Amity.Page;
+    }): Promise<Amity.Cached<Amity.Paged<Amity.Role>>>;
     /**
      * ```js
      * import { queryRoles } from '@amityco/ts-sdk'

package/dist/role/api/queryRoles.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"queryRoles.d.ts","sourceRoot":"","sources":["../../../src/role/api/queryRoles.ts"],"names":[],"mappings":"AAKA;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,UAAU;;;;;oBAInB,QAAQ,MAAM,MAAM,CAAC,MAAM,KAAK,CAAC,MAAM,IAAI,CAAC,CAAC,CAAC;IA8BlD;;;;;;;;;;;;;OAaG;mBAC0B,WAAW,iBAAiB,CAAC,CAAC,CAAC,CAAC;CAhB5D,CAAC"}
+{"version":3,"file":"queryRoles.d.ts","sourceRoot":"","sources":["../../../src/role/api/queryRoles.ts"],"names":[],"mappings":"AAKA;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,UAAU;aAAkB;QACvC,WAAW,CAAC,EAAE,MAAM,IAAI,CAAC,aAAa,CAAC,CAAC;QACxC,MAAM,CAAC,EAAE,aAAa,GAAG,cAAc,GAAG,aAAa,CAAC;QACxD,IAAI,CAAC,EAAE,MAAM,IAAI,CAAC;KACnB,GAAG,QAAQ,MAAM,MAAM,CAAC,MAAM,KAAK,CAAC,MAAM,IAAI,CAAC,CAAC,CAAC;IA8BlD;;;;;;;;;;;;;OAaG;mBAC0B,WAAW,iBAAiB,CAAC,CAAC,CAAC,CAAC;CAhB5D,CAAC"}

package/dist/stream/api/queryStreams.d.ts

@@ -14,13 +14,13 @@
  */
 export declare const queryStreams: {
     (query?: {
-        isLive?: boolean | undefined;
-        statuses?: Amity.StreamStatus[] | undefined;
-        userPublicIds?: string[] | undefined;
-        sortBy?: "lastCreated" | "firstCreated" | undefined;
+        isLive?: boolean;
+        statuses?: Amity.StreamStatus[];
+        userPublicIds?: Amity.User['userId'][];
+        sortBy?: 'lastCreated' | 'firstCreated';
         isDeleted?: Amity.Stream['isDeleted'];
-        page?: Amity.Page | undefined;
-    } | undefined): Promise<Amity.Cached<Amity.Paged<Amity.Stream>>>;
+        page?: Amity.Page;
+    }): Promise<Amity.Cached<Amity.Paged<Amity.Stream>>>;
     /**
      * ```js
      * import { queryStreams } from '@amityco/ts-sdk'

package/dist/stream/api/queryStreams.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"queryStreams.d.ts","sourceRoot":"","sources":["../../../src/stream/api/queryStreams.ts"],"names":[],"mappings":"AAKA;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,YAAY;;;;;;oBAKX,MAAM,MAAM,CAAC,WAAW,CAAC;;oBAEnC,QAAQ,MAAM,MAAM,CAAC,MAAM,KAAK,CAAC,MAAM,MAAM,CAAC,CAAC,CAAC;IAgCpD;;;;;;;;;;;;OAYG;mBAC4B,WAAW,mBAAmB,CAAC,CAAC,CAAC,CAAC;CAfhE,CAAC"}
+{"version":3,"file":"queryStreams.d.ts","sourceRoot":"","sources":["../../../src/stream/api/queryStreams.ts"],"names":[],"mappings":"AAKA;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,YAAY;aAAkB;QACzC,MAAM,CAAC,EAAE,OAAO,CAAC;QACjB,QAAQ,CAAC,EAAE,MAAM,YAAY,EAAE,CAAC;QAChC,aAAa,CAAC,EAAE,MAAM,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC;QACvC,MAAM,CAAC,EAAE,aAAa,GAAG,cAAc,CAAC;QACxC,SAAS,CAAC,EAAE,MAAM,MAAM,CAAC,WAAW,CAAC,CAAC;QACtC,IAAI,CAAC,EAAE,MAAM,IAAI,CAAC;KACnB,GAAG,QAAQ,MAAM,MAAM,CAAC,MAAM,KAAK,CAAC,MAAM,MAAM,CAAC,CAAC,CAAC;IAgCpD;;;;;;;;;;;;OAYG;mBAC4B,WAAW,mBAAmB,CAAC,CAAC,CAAC,CAAC;CAfhE,CAAC"}

package/dist/utils/constants.d.ts

@@ -0,0 +1,3 @@
+export declare const COLLECTION_DEFAULT_PAGINATION_LIMIT = 5;
+export declare const COLLECTION_DEFAULT_CACHING_POLICY: Amity.QueryPolicy;
+//# sourceMappingURL=constants.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../../src/utils/constants.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,mCAAmC,IAAI,CAAC;AACrD,eAAO,MAAM,iCAAiC,EAAE,KAAK,CAAC,WAAiC,CAAC"}

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

@@ -0,0 +1,3 @@
+declare const client: Amity.Client;
+export default client;
+//# sourceMappingURL=client.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../../../src/utils/tests/client.ts"],"names":[],"mappings":"AAEA,QAAA,MAAM,MAAM,cAA4B,CAAC;AAEzC,eAAe,MAAM,CAAC"}

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

@@ -0,0 +1,8 @@
+export declare const userPosts: {
+    targetId: string;
+    targetType: Amity.PostTargetType;
+    page1: string[];
+    page2: string[];
+    page3: string[];
+};
+//# sourceMappingURL=dummy.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"dummy.d.ts","sourceRoot":"","sources":["../../../src/utils/tests/dummy.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,SAAS;;;;;;CAMrB,CAAC"}

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

@@ -0,0 +1,3 @@
+export { userPosts } from './dummy';
+export { default as client } 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,OAAO,EAAE,SAAS,EAAE,MAAM,SAAS,CAAC;AACpC,OAAO,EAAE,OAAO,IAAI,MAAM,EAAE,MAAM,UAAU,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-beta.25",
+  "version": "0.0.1-beta.26",
   "license": "CC-BY-ND-4.0",
   "author": "amity.co <developers@amity.co> (https://amity.co)",
   "description": "Amity Social Cloud Typescript SDK",
@@ -28,34 +28,39 @@
     "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": "^21.0.3",
-    "@rollup/plugin-node-resolve": "^13.0.4",
+    "@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": "^17.0.23",
+    "@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.31.2",
-    "tslib": "^2.1.0",
-    "typescript": "^4.6.3"
+    "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",
+    "@react-native-async-storage/async-storage": "^1.17.7",
+    "agentkeepalive": "^4.2.1",
     "axios": "0.21.1",
-    "debug": "^4.3.1",
-    "js-base64": "^3.6.1",
+    "debug": "^4.3.4",
+    "js-base64": "^3.7.2",
     "mitt": "^3.0.0",
-    "mqtt": "^4.2.8",
+    "mqtt": "^4.3.7",
     "react-native-uuid": "^2.0.1",
-    "socket.io-client": "2.2.0"
+    "socket.io-client": "2.2.0",
+    "ts-jest": "^28.0.3"
   }
 }

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

@@ -0,0 +1,28 @@
+export {};
+
+declare global {
+  namespace Amity {
+    type LiveCollection<T extends any> = {
+      data: T[];
+      onNextPage: () => void;
+      hasNextPage: boolean;
+      error?: any;
+      loading: 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/paging.ts

@@ -18,7 +18,7 @@ declare global {
       before?: never;
     };
 
-    type Page = PrevPage<number> | NextPage<number>;
+    type Page<T extends number | string = number> = PrevPage<T> | NextPage<T>;
 
     /*
       updatedAt is here because if you need sort by updatedAt you

package/src/@types/domains/comment.ts

@@ -5,6 +5,16 @@ declare global {
     type CommentContentType = 'text';
     type CommentReferenceType = 'content' | 'post';
 
+    type CommentActionType =
+      | 'onFetch'
+      | 'onCreate'
+      | 'onUpdate'
+      | 'onDelete'
+      | 'onFlagged'
+      | 'onUnflagged'
+      | 'onReactionAdded'
+      | 'onReactionRemoved';
+
     type Comment<T extends CommentContentType = any> = {
       commentId: string;
       userId: string;
@@ -23,5 +33,26 @@ declare global {
       Amity.SoftDelete &
       Amity.Subscribable &
       Amity.Mentionable<'user'>;
+
+    type QueryComments = {
+      referenceType: Amity.Comment['referenceType'];
+      referenceId: Amity.Comment['referenceId'];
+      sortBy?: 'lastCreated' | 'firstCreated' | 'lastUpdated' | 'firstUpdated';
+      parentId?: Amity.Comment['commentId'] | null;
+      hasFlag?: boolean;
+      isDeleted?: Amity.Comment['isDeleted'];
+      page?: Amity.Page;
+    };
+
+    type CommentLiveCollection = Amity.LiveCollectionParams<
+      Omit<QueryComments, 'sortBy' | 'page'> & {
+        sortBy?: 'lastCreated' | 'firstCreated';
+      }
+    >;
+
+    type CommentLiveCollectionCache = Amity.LiveCollectionCache<
+      Amity.Comment['commentId'],
+      Pick<QueryComments, 'page'>
+    >;
   }
 }

package/src/@types/domains/post.ts

@@ -7,6 +7,18 @@ declare global {
 
     type PostContentType = 'text' | 'image' | 'file' | 'video' | 'liveStream' | 'poll';
 
+    type PostActionType =
+      | 'onFetch'
+      | 'onCreate'
+      | 'onUpdate'
+      | 'onDelete'
+      | 'onApproved'
+      | 'onDeclined'
+      | 'onFlagged'
+      | 'onUnflagged'
+      | 'onReactionAdded'
+      | 'onReactionRemoved';
+
     type Post<T extends PostContentType = any> = {
       postId: string;
       postedUserId: Amity.User['userId']; // API-FIX: it should be "userId"
@@ -29,5 +41,30 @@ declare global {
       Amity.SoftDelete &
       Amity.Subscribable &
       Amity.Mentionable<'user'>;
+
+    type QueryPosts = {
+      targetId: string;
+      targetType: Amity.Post['targetType'];
+      sortBy?: 'lastCreated' | 'firstCreated' | 'lastUpdated' | 'firstUpdated';
+      dataType?: string;
+      isDeleted?: Amity.Post['isDeleted'];
+      hasFlag?: boolean;
+      feedType?: 'reviewing' | 'published';
+      tags?: Amity.Taggable['tags'];
+      matchingOnlyParentPost?: boolean;
+      page?: Amity.PageRaw;
+    };
+
+    // Omit sortBy explained in asc-3398
+    type PostLiveCollection = Amity.LiveCollectionParams<
+      Omit<QueryPosts, 'sortBy' | 'page'> & {
+        sortBy?: 'lastCreated' | 'firstCreated';
+      }
+    >;
+
+    type PostLiveCollectionCache = Amity.LiveCollectionCache<
+      Amity.Post['postId'],
+      Pick<QueryPosts, 'page'>
+    >;
   }
 }

package/src/@types/index.ts

@@ -8,6 +8,7 @@ import './core/events'; // sdk events definitions
 import './core/paging'; // createQuery, runQuery
 import './core/query'; // createQuery, runQuery
 import './core/cache'; // cache.pull('user', ...)
+import './core/live';
 
 // domains
 import './domains/client'; // client definition

package/src/comment/api/queryComments.ts

@@ -19,15 +19,9 @@ import { getResolver } from '~/core/model';
  * @category Comment API
  * @async
  */
-export const queryComments = async (query: {
-  referenceType: Amity.Comment['referenceType'];
-  referenceId: Amity.Comment['referenceId'];
-  sortBy?: 'lastCreated' | 'firstCreated' | 'lastUpdated' | 'firstUpdated';
-  parentId?: Amity.Comment['commentId'] | null;
-  hasFlag?: boolean;
-  isDeleted?: Amity.Comment['isDeleted'];
-  page?: Amity.Page;
-}): Promise<Amity.Cached<Amity.Paged<Amity.Comment>>> => {
+export const queryComments = async (
+  query: Amity.QueryComments,
+): Promise<Amity.Cached<Amity.Paged<Amity.Comment>>> => {
   const client = getActiveClient();
   client.log('comment/queryComments', query);
 

package/src/comment/observers/index.ts

@@ -1,2 +1,3 @@
 export * from './observeComments';
 export * from './observeComment';
+export * from './liveComments';

package/src/comment/observers/liveComments.ts

@@ -0,0 +1,169 @@
+/* eslint-disable no-use-before-define */
+import { getResolver } from '~/core/model';
+import { getActiveClient } from '~/client/api';
+import { pushToCache, pullFromCache } from '~/cache/api';
+import {
+  createQuery,
+  runQuery,
+  queryOptions,
+  filterByPropEquality,
+  sortByFirstCreated,
+  sortByLastCreated,
+} from '~/core/query';
+
+import {
+  COLLECTION_DEFAULT_CACHING_POLICY,
+  COLLECTION_DEFAULT_PAGINATION_LIMIT,
+} from '~/utils/constants';
+
+import {
+  onCommentCreated,
+  onCommentUpdated,
+  onCommentDeleted,
+  onCommentFlagged,
+  onCommentUnflagged,
+  onCommentReactionAdded,
+  onCommentReactionRemoved,
+} from '../events';
+import { queryComments } from '../api';
+
+/**
+ * ```js
+ * import { liveComments } from '@amityco/ts-sdk'
+ *
+ * let comments = []
+ * const unsub = liveComments({
+ *   referenceType: Amity.Comment['referenceType'];
+ *   referenceId: Amity.Comment['referenceId'];
+ * }, response => merge(comments, response.data))
+ * ```
+ *
+ * Observe all mutations on a list of {@link Amity.Comment} for a given target object
+ *
+ * @param referenceType the type of the target
+ * @param referenceId the ID of the target
+ * @param callback the function to call when new data are available
+ * @returns An {@link Amity.Unsubscriber} function to run when willing to stop observing the messages
+ *
+ * @category Comments Live Collection
+ */
+export const liveComments = (
+  params: Amity.CommentLiveCollection,
+  callback: Amity.LiveCollectionCallback<Amity.Comment>,
+  config?: Amity.LiveCollectionConfig,
+): Amity.Unsubscriber => {
+  const { log, cache } = getActiveClient();
+
+  if (!cache) {
+    console.log('For using Live Collection feature you need to enable Cache!');
+  }
+
+  const timestamp = Date.now();
+  log(`liveComments(tmpid: ${timestamp}) > listen`);
+
+  const { limit: queryLimit, ...queryParams } = params;
+
+  const limit = queryLimit ?? COLLECTION_DEFAULT_PAGINATION_LIMIT;
+  const { policy = COLLECTION_DEFAULT_CACHING_POLICY } = config ?? {};
+
+  const disposers: Amity.Unsubscriber[] = [];
+  const cacheKey = [
+    'comment',
+    'collection',
+    { referenceId: params.referenceType, referenceType: params.referenceId },
+  ];
+
+  const responder = (data: Amity.CommentLiveCollectionCache) => {
+    let comments: Amity.Comment[] =
+      data.data
+        .map(commentId => pullFromCache<Amity.Comment>(['comment', 'get', commentId])!)
+        .filter(Boolean)
+        .map(({ data }) => data) ?? [];
+
+    comments = filterByPropEquality(comments, 'isDeleted', params.isDeleted);
+
+    const sortBy = params.sortBy ? params.sortBy : 'lastCreated';
+
+    comments = comments.sort(sortBy === 'lastCreated' ? sortByLastCreated : sortByFirstCreated);
+
+    callback({
+      onNextPage: onFetch,
+      data: comments,
+      hasNextPage: !!data.params?.page,
+      loading: data.loading,
+      error: data.error,
+    });
+  };
+
+  const realtimeRouter = (comment: Amity.Comment, action: Amity.CommentActionType) => {
+    const collection = pullFromCache<Amity.CommentLiveCollectionCache>(cacheKey)?.data;
+
+    if (
+      params.referenceId !== comment.referenceId ||
+      params.referenceType !== comment.referenceType ||
+      !collection
+    )
+      return;
+
+    if (action === 'onCreate') {
+      collection.data = [...new Set([comment.commentId, ...collection.data])];
+    } else if (action === 'onDelete') {
+      collection.data = collection.data.filter(p => p !== comment.commentId);
+    }
+
+    pushToCache(cacheKey, collection);
+
+    responder(collection);
+  };
+
+  const onFetch = () => {
+    const collection = pullFromCache<Amity.CommentLiveCollectionCache>(cacheKey)?.data;
+
+    const comments = collection?.data ?? [];
+
+    if (comments.length > 0 && !collection?.params?.page) return;
+
+    const query = createQuery(queryComments, {
+      ...queryParams,
+      page: collection?.params?.page ?? { limit },
+    });
+
+    runQuery(
+      query,
+      ({ data: result, error, loading, prevPage: page }) => {
+        const data = {
+          loading,
+          error,
+          params: { page },
+          data: comments,
+        };
+
+        if (result) {
+          data.data = [...new Set([...comments, ...result.map(getResolver('comment'))])];
+        }
+
+        pushToCache(cacheKey, data);
+
+        responder(data);
+      },
+      queryOptions(policy),
+    );
+  };
+
+  disposers.push(
+    onCommentCreated(comment => realtimeRouter(comment, 'onCreate')),
+    onCommentUpdated(comment => realtimeRouter(comment, 'onUpdate')),
+    onCommentDeleted(comment => realtimeRouter(comment, 'onDelete')),
+    onCommentFlagged(comment => realtimeRouter(comment, 'onFlagged')),
+    onCommentUnflagged(comment => realtimeRouter(comment, 'onUnflagged')),
+    onCommentReactionAdded(comment => realtimeRouter(comment, 'onReactionAdded')),
+    onCommentReactionRemoved(comment => realtimeRouter(comment, 'onReactionRemoved')),
+  );
+
+  onFetch();
+
+  return () => {
+    log(`liveComments(tmpid: ${timestamp}) > dispose`);
+    disposers.forEach(fn => fn());
+  };
+};

package/src/comment/observers/observeComments.ts

@@ -48,17 +48,7 @@ export const observeComments = (
 
   const disposers: Amity.Unsubscriber[] = [];
 
-  const router = (
-    comment: Amity.Comment,
-    action:
-      | 'onCreate'
-      | 'onUpdate'
-      | 'onDelete'
-      | 'onFlagged'
-      | 'onUnflagged'
-      | 'onReactionAdded'
-      | 'onReactionRemoved',
-  ) => {
+  const router = (comment: Amity.Comment, action: Exclude<Amity.CommentActionType, 'onFetch'>) => {
     if (comment.referenceId !== postId) return;
 
     if (callback instanceof Function) return callback(comment);