feat(api): add list comment

Author: sxzz

README.md

@@ -51,7 +51,8 @@
 - [动态广场](http://jike-sdk.sxzz.moe/modules/api_recommend_feed.html)
   - [x] [获取动态推荐](http://jike-sdk.sxzz.moe/functions/api_recommend_feed.list.html)
 - [评论](http://jike-sdk.sxzz.moe/modules/api_comments.html)
-  - [x] [获取评论](http://jike-sdk.sxzz.moe/functions/api_comments.listPrimary.html)
+  - [x] [获取动态下评论](http://jike-sdk.sxzz.moe/functions/api_comments.listPrimary.html)
+  - [x] [获取评论](http://jike-sdk.sxzz.moe/functions/api_comments.list.html)
   - [x] [发送评论](http://jike-sdk.sxzz.moe/functions/api_comments.add.html) （发送子评论）
   - [x] [点赞](http://jike-sdk.sxzz.moe/functions/api_comments.like.html)
   - [x] [取消点赞](http://jike-sdk.sxzz.moe/functions/api_comments.unlike.html)

src/api/comments.ts

@@ -1,6 +1,11 @@
 import { request, toResponse } from '../request'
 import { type PostTypeRaw } from '../types/entity'
-import { type AddCommentOption, type ListCommentOption } from '../types/options'
+import {
+  type AddCommentOption,
+  type ListCommentMoreKey,
+  type ListPrimaryCommentOption,
+  type PaginationOption,
+} from '../types/options'
 import { type Comments } from '../types/api-responses'
 
 export const add = <T = Comments.AddResponse>(
@@ -52,7 +57,7 @@ export const remove = <T = Comments.RemoveResponse>(
 export const listPrimary = <T = Comments.ListPrimaryResponse>(
   targetType: PostTypeRaw,
   targetId: string,
-  option: ListCommentOption = {}
+  option: ListPrimaryCommentOption = {}
 ) =>
   toResponse<T>(
     request.post('1.0/comments/listPrimary', {
@@ -65,3 +70,19 @@ export const listPrimary = <T = Comments.ListPrimaryResponse>(
       },
     })
   )
+
+export const list = <T = Comments.ListResponse>(
+  targetType: PostTypeRaw,
+  threadId: string,
+  option: PaginationOption<ListCommentMoreKey> = {}
+) =>
+  toResponse<T>(
+    request.post('1.0/comments/list', {
+      json: {
+        targetType,
+        threadId,
+        limit: option.limit ?? 20,
+        loadMoreKey: option.loadMoreKey,
+      },
+    })
+  )

src/client/post.ts

@@ -1,7 +1,7 @@
 import {
   type AddCommentOption,
-  type ListCommentMoreKey,
-  type ListCommentOption,
+  type ListPrimaryCommentMoreKey,
+  type ListPrimaryCommentOption,
   type PostType,
 } from '../types/options'
 import { type Comment, type Post, type User } from '../types/entity'
@@ -143,10 +143,10 @@ export class JikePost {
    * 查询评论
    */
   queryComments(
-    order?: ListCommentOption['order'],
-    option: PaginatedOption<Comment, 'createdAt', ListCommentMoreKey> = {}
+    order?: ListPrimaryCommentOption['order'],
+    option: PaginatedOption<Comment, 'createdAt', ListPrimaryCommentMoreKey> = {}
   ) {
-    const fetcher: PaginatedFetcher<Comment, ListCommentMoreKey> = async (
+    const fetcher: PaginatedFetcher<Comment, ListPrimaryCommentMoreKey> = async (
       lastKey
     ) => {
       const result = await this.apiClient.comments.listPrimary(

src/types/api-responses.ts

@@ -15,6 +15,10 @@ import {
   type Topic,
   type User,
 } from './entity'
+import {
+  type ListCommentMoreKey,
+  type ListPrimaryCommentMoreKey,
+} from './options'
 
 export namespace Posts {
   export interface CreateResponse {
@@ -196,10 +200,12 @@ export namespace Comments {
 
   export interface ListPrimaryResponse {
     data: Comment[]
-    loadMoreKey?: {
-      key: string
-      partition: string
-    }
+    loadMoreKey?: ListPrimaryCommentMoreKey
+  }
+
+  export interface ListResponse {
+    data: Comment[]
+    loadMoreKey?: ListCommentMoreKey
   }
 }
 

src/types/options.ts

@@ -79,22 +79,27 @@ export interface AddCommentOption {
   replyToCommentId?: string
 }
 
-export interface ListCommentMoreKey {
+export interface ListPrimaryCommentMoreKey {
   key: string
   partition: string
 }
 /**
- * @description 获取评论选项
+ * @description 获取主要评论选项
  */
-export interface ListCommentOption
-  extends PaginationOption<ListCommentMoreKey> {
+export interface ListPrimaryCommentOption
+  extends PaginationOption<ListPrimaryCommentMoreKey> {
   /**
    * 排序
    * @default `LIKES`
    */
   order?: 'LIKES' | 'TIME'
 }
 
+export interface ListCommentMoreKey {
+  skip: number
+  partition: LiteralUnion<'NORMAL'>
+}
+
 /**
  * @description 获取动态广场选项
  */

tests/api/posts.test.ts

@@ -38,13 +38,19 @@ describe('posts should work', () => {
 })
 
 describe('comment should work', () => {
-  it('get should work', async () => {
+  it('list should work', async () => {
     const result = await api.comments.listPrimary(
       'ORIGINAL_POST',
-      '61c0d39877abf80010426ba3'
+      '65071ec94101002b06c3469d'
     )
     expect(isSuccess(result)).toBe(true)
     expect(result.data.data.length).greaterThan(0)
+
+    const comments = await api.comments.list(
+      'ORIGINAL_POST',
+      result.data.data[0].threadId
+    )
+    expect(comments.data.data.length).greaterThan(0)
   })
 
   it('like should work', async () => {
@@ -75,7 +81,7 @@ describe('new post should work', () => {
       { topicId: '5be41ae2a666dd00172d6072' }
     )
     expect(isSuccess(result)).toBe(true)
-    expect(result.data.toast).toBe('发送成功')
+    expect(result.data.toast).a('string')
     expect(result.data.data.id).a('string')
     id = result.data.data.id
   })
@@ -87,14 +93,14 @@ describe('new post should work', () => {
       `测试评论${Math.random()}`
     )
     expect(isSuccess(result)).toBe(true)
-    expect(result.data.toast).toBe('发送成功')
+    expect(result.data.toast).a('string')
     expect(result.data.data.id).a('string')
   })
 
   it('remove should work', async () => {
     const result = await api.posts.remove(PostType.ORIGINAL, id)
     expect(isSuccess(result)).toBe(true)
-    expect(result.data.toast).toBe('删除成功')
+    expect(result.data.toast).a('string')
   })
 
   it('listLikedUsers should work', async () => {