feat(api): add recommend feed

Author: sxzz

README.md

@@ -35,6 +35,8 @@
   - [x] 分享动态
   - [x] 点赞
   - [x] 取消点赞
+- 动态广场
+  - [x] 获取动态推荐
 - 评论
   - [x] 获取评论
   - [x] 发送评论

src/api/comments.ts

@@ -49,7 +49,7 @@ export const listPrimary = <T = Comments.ListPrimaryResponse>(
         targetType,
         targetId,
         order: option.order ?? 'LIKES',
-        limit: option.limit,
+        limit: option.limit ?? 10,
         loadMoreKey: option.loadMoreKey,
       },
     })

src/api/index.ts

@@ -1,6 +1,7 @@
 import * as users from './users'
 import * as userRelation from './user-relation'
 import * as posts from './posts'
+import * as recommendFeed from './recommend-feed'
 import * as personalUpdate from './personal-update'
 import * as notifications from './notifications'
 import * as comments from './comments'
@@ -11,6 +12,7 @@ import * as upload from './upload'
  * - {@link api/users | `users`}: 用户
  * - {@link api/user-relation | `userRelation`}: 用户关系
  * - {@link api/posts | `posts`}: 动态
+ * - {@link api/recommend-feed | `recommendFeed`}: 动态
  * - {@link api/personal-update | `personalUpdate`}: 主页
  * - {@link api/notifications | `notifications`}: 通知
  * - {@link api/comments | `comments`}: 评论
@@ -20,6 +22,7 @@ export const api = {
   users,
   userRelation,
   posts,
+  recommendFeed,
   personalUpdate,
   notifications,
   comments,

src/api/recommend-feed.ts

@@ -0,0 +1,20 @@
+import { toResponse, request } from '../request'
+import type { ListRecommendFeedOption } from '../types/options'
+import type { RecommendFeed } from '../types/api-responses'
+
+/**
+ * 获取动态广场
+ * @param option 选项
+ */
+export const list = <T = RecommendFeed.ListResponse>(
+  option: ListRecommendFeedOption = {}
+) =>
+  toResponse<T>(
+    request.post('1.0/recommendFeed/list', {
+      json: {
+        limit: option.limit ?? 10,
+        trigger: option.trigger ?? 'auto',
+        loadMoreKey: option.loadMoreKey,
+      },
+    })
+  )

src/types/api-responses.ts

@@ -6,6 +6,7 @@ import type {
   SimpleUser,
   TabIcons,
   User,
+  RecommendPost,
 } from './entity'
 
 export namespace Posts {
@@ -34,7 +35,7 @@ export namespace Notifications {
 export namespace UserRelation {
   export interface GetFollowingListResponse {
     data: SimpleUser[]
-    loadMoreKey: {
+    loadMoreKey?: {
       createdAt: string
     }
   }
@@ -111,7 +112,7 @@ export namespace Users {
 export namespace PersonalUpdate {
   export interface SingleResponse {
     data: PostDetail[]
-    loadMoreKey: {
+    loadMoreKey?: {
       lastId: string
     }
   }
@@ -125,7 +126,7 @@ export namespace Comments {
 
   export interface ListPrimaryResponse {
     data: Comment[]
-    loadMoreKey: {
+    loadMoreKey?: {
       key: string
       partition: string
     }
@@ -137,3 +138,13 @@ export namespace Upload {
     uptoken: string
   }
 }
+
+export namespace RecommendFeed {
+  export interface ListResponse {
+    data: RecommendPost[]
+    toastMessage: string
+    loadMoreKey?: {
+      page: number
+    }
+  }
+}

src/types/entity.ts

@@ -487,10 +487,7 @@ export interface LinkInfo {
   source: string
 }
 
-export interface ReadTrackInfo {
-  recommendReason: string
-  recommendReasonPolicy: string
-}
+export type ReadTrackInfo = Record<string, any>
 
 export interface ActionItem {
   type: string
@@ -588,3 +585,52 @@ export interface Comment {
   deletable: boolean
   pinnable: boolean
 }
+
+export interface AdditionalInfo {
+  grayGroup: string
+  interestType: string
+  keywords: string
+  pictureClassifications: string
+  posterId: string
+  recallTag: string
+  recommendId: string
+  recommendTime: string
+  topicId: string
+}
+
+export interface Payload {
+  id: string
+  feedType: string
+  type: string
+  key: string
+  reason: string
+  readTrackInfo: ReadTrackInfo
+}
+
+export interface Reason {
+  key: string
+  text: string
+  payload: Payload
+}
+
+export interface DislikeMenu {
+  title: string
+  subtitle: string
+  reasons: Reason[]
+}
+
+export interface RecommendPost {
+  id: string
+  readTrackInfo: ReadTrackInfo
+  dislikeMenu: DislikeMenu
+  user: SimpleUser
+  topic: Topic
+  content: string
+  pictures: Picture[]
+  likeCount: number
+  commentCount: number
+  repostCount: number
+  shareCount: number
+  createdAt: Date
+  type: string
+}

src/types/options.ts

@@ -1,9 +1,9 @@
 /**
- * 分页选项
+ * @description 分页选项
  */
-export interface PaginationOption<T = any> {
+export interface PaginationOption<T = Record<string, any>> {
   /**
-   * 最大记录数
+   * @description 最大记录数
    * @default 10
    */
   limit?: number
@@ -14,41 +14,50 @@ export interface PaginationOption<T = any> {
   loadMoreKey?: Partial<T>
 }
 
+/**
+ * @description 动态类型
+ */
 export enum PostType {
-  /** 动态 */
+  /** 原帖 */
   ORIGINAL = 'originalPosts',
   /** 转发 */
   REPOST = 'reposts',
 }
 
+/**
+ * @description 发送动态选项
+ */
 export interface CreatePostOption {
   /**
-   * 同步到个人主页
-   * @default true
+   * @description 是否同步到个人主页
+   * @default `true`
    */
   syncToPersonalUpdates?: boolean
   /**
-   * 图片 key 列表
-   * @default []
+   * @description 图片 key 列表
+   * @default `[]`
    */
   pictureKeys?: string[]
 
   /**
-   * 圈子 ID
-   * @default undefined
+   * @description 圈子 ID
+   * @default `undefined`
    */
   topicId?: string
 }
 
+/**
+ * @description 发送评论选项
+ */
 export interface AddCommentOption {
   /**
-   * 同步到个人主页
-   * @default false
+   * @description 同步到个人主页
+   * @default `false`
    */
   syncToPersonalUpdates?: boolean
   /**
-   * 图片 key 列表
-   * @default []
+   * @description 图片 key 列表
+   * @default `[]`
    */
   pictureKeys?: string[]
 }
@@ -57,6 +66,26 @@ export interface ListCommentMoreKey {
   key: string
   partition: string
 }
-export type ListCommentOption = PaginationOption<ListCommentMoreKey> & {
+/**
+ * @description 获取评论选项
+ */
+export interface ListCommentOption
+  extends PaginationOption<ListCommentMoreKey> {
+  /**
+   * 排序
+   * @default `LIKES`
+   */
   order?: 'LIKES' | 'TIME'
 }
+
+/**
+ * @description 获取动态广场选项
+ */
+export interface ListRecommendFeedOption
+  extends PaginationOption<{ page: number }> {
+  /**
+   * @description 触发方式
+   * @default `auto`
+   */
+  trigger?: string
+}

tests/api/recommend-feed.test.ts

@@ -0,0 +1,14 @@
+import { describe, it, expect } from 'vitest'
+import { setApiConfig, api } from '../../src'
+import { config } from '../config'
+
+setApiConfig(config)
+
+describe('comment should work', () => {
+  it('list should work', async () => {
+    const result = await api.recommendFeed.list()
+    expect(result.status).toBe(200)
+    expect(result.data.success).toBe(true)
+    expect(result.data.data.length).greaterThan(0)
+  })
+})

typedoc.json

@@ -4,6 +4,7 @@
     "src/api/notifications.ts",
     "src/api/personal-update.ts",
     "src/api/posts.ts",
+    "src/api/recommend-feed.ts",
     "src/api/user-relation.ts",
     "src/api/users.ts",
     "src/api/comments.ts",