feat(api): add stories (#70)

Author: Magren0321

src/api/index.ts

@@ -6,6 +6,7 @@ import * as personalUpdate from './personal-update'
 import * as notifications from './notifications'
 import * as comments from './comments'
 import * as upload from './upload'
+import * as stories from './stories'
 
 /**
  * API
@@ -17,6 +18,7 @@ import * as upload from './upload'
  * - {@link api/notifications | `notifications`}: 通知
  * - {@link api/comments | `comments`}: 评论
  * - {@link api/upload | `upload`}: 上传
+ * - {@link api/stories | `stories`}: 日记
  */
 export const api = {
   users,
@@ -27,6 +29,7 @@ export const api = {
   notifications,
   comments,
   upload,
+  stories,
 }
 /**
  * API 集合

src/api/stories.ts

@@ -0,0 +1,23 @@
+import { request, toResponse } from '../request'
+import type { Stories } from '../types/api-responses'
+
+/**
+ * 获取关注用户日记列表
+ */
+export const followingFeed = async <T = Stories.FollowingFeedResponse>() =>
+  toResponse<T>(request.get('1.0/stories/followingFeed'))
+
+/**
+ * 获取用户的日记详情
+ * @param username 用户名
+ */
+export const listUserStories = async <T = Stories.ListUserStoriesResponse>(
+  username: string
+) =>
+  toResponse<T>(
+    request.get('1.0/stories/listUserStories', {
+      searchParams: {
+        username,
+      },
+    })
+  )

src/types/api-responses.ts

@@ -7,6 +7,7 @@ import type {
   PostDetail,
   Profile as ProfileEntity,
   RecommendPost,
+  StoryDetails,
   TabIcons,
   User,
 } from './entity'
@@ -179,3 +180,13 @@ export namespace RecommendFeed {
     }
   }
 }
+
+export namespace Stories {
+  export interface FollowingFeedResponse {
+    data: { type: 'USER_STORY'; user: User }[]
+  }
+
+  export interface ListUserStoriesResponse {
+    data: StoryDetails[]
+  }
+}

src/types/entity/other.ts

@@ -7,6 +7,7 @@ import type {
   UrlsInText,
 } from './post'
 import type { User } from './user'
+import type { LiteralUnion } from '../../utils/typings'
 
 export type PostTypeRaw = 'ORIGINAL_POST' | 'REPOST'
 export type TargetType = PostTypeRaw | 'STORY'
@@ -160,3 +161,47 @@ export interface RecommendPost {
   createdAt: Date
   type: string
 }
+
+export interface StoryPic {
+  key: string
+  thumbnailUrl: string
+  smallPicUrl: string
+  middlePicUrl: string
+  picUrl: string
+  format: string
+  cropperPosX: number
+  cropperPosY: number
+  width: number
+  height: number
+}
+export interface StoryVideo {
+  duration: number
+  height: number
+  type: string
+  width: number
+  image: {
+    format: string
+    picUrl: string
+    thumbnailUrl: string
+  }
+}
+
+export interface StoryDetails {
+  id: string
+  type: 'STORY'
+  storyType: LiteralUnion<'PICTURE' | 'VIDEO'>
+  user: User
+  emoji?: string
+  video?: StoryVideo
+  thumbnailVideo?: StoryVideo
+  status: string
+  picture: StoryPic
+  liked: boolean
+  likeCount: number
+  commentCount: number
+  viewerCount: number
+  createdAt: string
+  likedUsers: []
+  enablePictureComments: boolean
+  isFeatured: boolean
+}

tests/api/stories.test.ts

@@ -0,0 +1,19 @@
+import { describe, expect, it } from 'vitest'
+import { api, isSuccess, setApiConfig } from '../../src'
+import { config } from '../config'
+
+describe('stories should work', () => {
+  setApiConfig(config)
+
+  it('followingFeed should work', async () => {
+    const result = await api.stories.followingFeed()
+    expect(isSuccess(result)).toBe(true)
+  })
+
+  it('listUserStories should work', async () => {
+    const result = await api.stories.listUserStories(
+      'c00cf715-b71b-464b-9dcc-d73e01878137'
+    )
+    expect(isSuccess(result)).toBe(true)
+  })
+})

typedoc.json

@@ -8,7 +8,8 @@
     "src/api/user-relation.ts",
     "src/api/users.ts",
     "src/api/comments.ts",
-    "src/api/upload.ts"
+    "src/api/upload.ts",
+    "src/api/stories.ts"
   ],
   "out": "docs",
   "name": "Ⓙ Jike SDK",