feat: add topic (#83)

* feat(api): 新增 topic api

* 新增 getTabsSquareFeed, getTabsSelectedFeed
* 更新 README.md, 新增 Development.md 便于新人参与开发

* style(Development.md): lint:fix

* fix: fix type & file change rollback

* style: add newline at end of file

Co-authored-by: jpsong <[email protected]>

Author: yes1am

src/api/index.ts

@@ -8,6 +8,7 @@ import * as comments from './comments'
 import * as upload from './upload'
 import * as stories from './stories'
 import * as mediaMeta from './media-meta'
+import * as topic from './topic'
 
 /**
  * API
@@ -20,6 +21,7 @@ import * as mediaMeta from './media-meta'
  * - {@link api/comments | `comments`}: 评论
  * - {@link api/upload | `upload`}: 上传
  * - {@link api/stories | `stories`}: 日记
+ * - {@link api/topic | `topic`}: 圈子
  */
 export const api = {
   users,
@@ -32,6 +34,7 @@ export const api = {
   upload,
   stories,
   mediaMeta,
+  topic,
 }
 /**
  * API 集合

src/api/topic.ts

@@ -0,0 +1,42 @@
+import { request, toResponse } from '../request'
+import type { Topic } from '../types/api-responses'
+import type { PaginationOption } from '../types/options'
+
+/**
+ * 获取圈子动态
+ * @param topicId 圈子 id
+ * @param option 选项
+ */
+export const getTabsSquareFeed = <T = Topic.GetTabsSquareFeedResponse>(
+  topicId: string,
+  // NOTE: suppressed 应该传 false，但不知道这个参数是什么意思
+  option: PaginationOption<{ lastId: string; suppressed: boolean }> = {}
+) =>
+  toResponse<T>(
+    request.post('1.0/topics/tabs/square/feed', {
+      json: {
+        topicId,
+        limit: option.limit ?? 10,
+        loadMoreKey: option.loadMoreKey,
+      },
+    })
+  )
+
+/**
+ * 获取圈子热门动态
+ * @param topicId 圈子 id
+ * @param option 选项
+ */
+export const getTabsSelectedFeed = <T = Topic.GetTabsSelectedFeedResponse>(
+  topicId: string,
+  option: PaginationOption<{ offset: number }> = {}
+) =>
+  toResponse<T>(
+    request.post('1.0/topics/tabs/selected/feed', {
+      json: {
+        topicId,
+        limit: option.limit ?? 10,
+        loadMoreKey: option.loadMoreKey,
+      },
+    })
+  )

src/types/api-responses.ts

@@ -9,6 +9,7 @@ import type {
   PersonalPost,
   Profile as ProfileEntity,
   RecommendPost,
+  SquareFeed,
   Story,
   TabIcons,
   User,
@@ -209,3 +210,22 @@ export namespace Stories {
 export interface InteractiveResponse {
   url: string
 }
+
+export namespace Topic {
+  // 圈子动态
+  export interface GetTabsSquareFeedResponse {
+    data: SquareFeed[]
+    loadMoreKey?: {
+      lastId: string
+      suppressed: boolean
+    }
+  }
+
+  // 圈子热门动态
+  export interface GetTabsSelectedFeedResponse {
+    data: SquareFeed[]
+    loadMoreKey?: {
+      offset: number
+    }
+  }
+}

src/types/entity/common.ts

@@ -9,6 +9,17 @@ export interface CommonImage {
   format: LiteralUnion<'jpeg' | 'heic' | 'png'>
 }
 
+// 地图 POI
+export interface Poi {
+  poiId: string // id
+  name: string
+  location: number[] // 经纬度
+  countryname: string // 国家
+  pname: string // 省份
+  cityname: string // 城市
+  formattedAddress: string
+}
+
 export type Ref =
   | ''
   | 'FOLLOWINGS_FEED_FOLLOW_SECTION'

src/types/entity/index.ts

@@ -6,3 +6,4 @@ export * from './profile'
 export * from './topic'
 export * from './user'
 export * from './story'
+export * from './topic'

src/types/entity/topic.ts

@@ -1,5 +1,6 @@
 import type { LiteralUnion } from '../../utils'
-import type { CommonImage, Ref } from './common'
+import type { CommonImage, Poi, Ref } from './common'
+import type { OriginalPost } from './post'
 
 export interface Topic {
   type: 'TOPIC'
@@ -76,3 +77,9 @@ export interface SquarePicture extends CommonImage {
   livePhoto: any
   themes: any
 }
+
+export interface SquareFeed extends OriginalPost {
+  poi?: Poi
+  isSuppressed: boolean
+  subtitle: string
+}

tests/api/topic.test.ts

@@ -0,0 +1,22 @@
+import { describe, expect, it } from 'vitest'
+import { api, isSuccess, setApiConfig } from '../../src'
+import { config } from '../config'
+
+describe('topic should work', () => {
+  setApiConfig(config)
+
+  const topicId = '562dfeb0daf87d13002cad92' // 深圳吃喝玩乐圈子
+  const limit = 10
+
+  it('getTabsSquareFeed should work', async () => {
+    const result = await api.topic.getTabsSquareFeed(topicId, { limit })
+    expect(isSuccess(result)).toBe(true)
+    expect(result.data.data.length).toBe(limit)
+  })
+
+  it('getTabsSelectedFeed should work', async () => {
+    const result = await api.topic.getTabsSelectedFeed(topicId, { limit })
+    expect(isSuccess(result)).toBe(true)
+    expect(result.data.data.length).toBe(limit)
+  })
+})

typedoc.json

@@ -10,7 +10,8 @@
     "src/api/comments.ts",
     "src/api/upload.ts",
     "src/api/stories.ts",
-    "src/api/media-meta.ts"
+    "src/api/media-meta.ts",
+    "src/api/topic.ts"
   ],
   "out": "docs",
   "name": "Ⓙ Jike SDK",