refactor(api)!: rename topic to topics

Author: sxzz

CONTRIBUTING.md

@@ -27,7 +27,7 @@ setApiConfig({
   deviceId: '<device-id>', // 请自行替换
 })
 
-api.topic
+api.topics
   .getTabsSquareFeed('562dfeb0daf87d13002cad92', {
     limit: 10,
   })
@@ -62,13 +62,13 @@ export const config = {
 }
 ```
 
-2. 新建测试文件, 如 `tests/api/topic.test.ts`, 编写测试代码
+2. 新建测试文件, 如 `tests/api/topics.test.ts`, 编写测试代码
 
 3. 执行测试用例
 
 ```shell
 pnpm run test
 
-# 测试指定的测试文件, 如只测试新增的 topic.test.ts
-pnpm run test topic
-```
+# 测试指定的测试文件, 如只测试新增的 topics.test.ts
+pnpm run test topics
+```

src/api/index.ts

@@ -8,7 +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'
+import * as topics from './topics'
 
 /**
  * API
@@ -21,7 +21,7 @@ import * as topic from './topic'
  * - {@link api/comments | `comments`}: 评论
  * - {@link api/upload | `upload`}: 上传
  * - {@link api/stories | `stories`}: 日记
- * - {@link api/topic | `topic`}: 圈子
+ * - {@link api/topics | `topics`}: 圈子
  */
 export const api = {
   users,
@@ -34,7 +34,7 @@ export const api = {
   upload,
   stories,
   mediaMeta,
-  topic,
+  topics,
 }
 /**
  * API 集合

src/api/topic.ts renamed to src/api/topics.ts

@@ -1,13 +1,13 @@
 import { request, toResponse } from '../request'
-import type { Topic } from '../types/api-responses'
+import type { Topics } from '../types/api-responses'
 import type { PaginationOption } from '../types/options'
 
 /**
  * 获取圈子动态
  * @param topicId 圈子 id
  * @param option 选项
  */
-export const getTabsSquareFeed = <T = Topic.GetTabsSquareFeedResponse>(
+export const getTabsSquareFeed = <T = Topics.GetTabsSquareFeedResponse>(
   topicId: string,
   // NOTE: suppressed 应该传 false，但不知道这个参数是什么意思
   option: PaginationOption<{ lastId: string; suppressed: boolean }> = {}
@@ -27,7 +27,7 @@ export const getTabsSquareFeed = <T = Topic.GetTabsSquareFeedResponse>(
  * @param topicId 圈子 id
  * @param option 选项
  */
-export const getTabsSelectedFeed = <T = Topic.GetTabsSelectedFeedResponse>(
+export const getTabsSelectedFeed = <T = Topics.GetTabsSelectedFeedResponse>(
   topicId: string,
   option: PaginationOption<{ offset: number }> = {}
 ) =>

src/types/api-responses.ts

@@ -211,7 +211,7 @@ export interface InteractiveResponse {
   url: string
 }
 
-export namespace Topic {
+export namespace Topics {
   // 圈子动态
   export interface GetTabsSquareFeedResponse {
     data: SquareFeed[]

src/types/entity/index.ts

@@ -3,7 +3,6 @@ export * from './notification'
 export * from './other'
 export * from './post'
 export * from './profile'
-export * from './topic'
-export * from './user'
 export * from './story'
 export * from './topic'
+export * from './user'

tests/api/topic.test.ts renamed to tests/api/topics.test.ts

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

typedoc.json

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