feat(api): add mediaMeta interactive (#74)

Author: Magren0321

src/api/index.ts

@@ -7,6 +7,7 @@ import * as notifications from './notifications'
 import * as comments from './comments'
 import * as upload from './upload'
 import * as stories from './stories'
+import * as mediaMeta from './media-meta'
 
 /**
  * API
@@ -30,6 +31,7 @@ export const api = {
   comments,
   upload,
   stories,
+  mediaMeta,
 }
 /**
  * API 集合

src/api/media-meta.ts

@@ -0,0 +1,24 @@
+import { request, toResponse } from '../request'
+import type { LiteralUnion } from '../utils/typings'
+import type { InteractiveResponse } from '../types/api-responses'
+
+/**
+ * 获取视频地址
+ * @param id 视频id
+ * @param type 类型 如：STORY
+ * @param trigger 触发 如：user
+ */
+export const interactive = async <T = InteractiveResponse>(
+  id: string,
+  type: LiteralUnion<'STORY'>,
+  trigger: LiteralUnion<'user'> = 'user'
+) =>
+  toResponse<T>(
+    request.post('1.0/mediaMeta/interactive', {
+      searchParams: {
+        id,
+        type,
+        trigger,
+      },
+    })
+  )

src/types/api-responses.ts

@@ -194,3 +194,7 @@ export namespace Stories {
     data: Story[]
   }
 }
+
+export interface InteractiveResponse {
+  url: string
+}

src/types/entity/index.ts

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

src/types/entity/other.ts

@@ -1,4 +1,3 @@
-import type { CommonImage } from './common'
 import type { Topic } from './topic'
 import type {
   Picture,
@@ -8,7 +7,6 @@ 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'
@@ -162,43 +160,3 @@ export interface RecommendPost {
   createdAt: Date
   type: string
 }
-
-export interface StoryPicture extends CommonImage {
-  key: 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 Story {
-  type: 'STORY'
-  id: string
-  storyType: LiteralUnion<'PICTURE' | 'VIDEO'>
-  status: LiteralUnion<'PUBLIC'>
-  user: User
-  emoji?: string
-  video?: StoryVideo
-  thumbnailVideo?: StoryVideo
-  picture?: StoryPicture
-  liked: boolean
-  likeCount: number
-  commentCount: number
-  viewerCount: number
-  createdAt: string
-  likedUsers: User[]
-  enablePictureComments: boolean
-  isFeatured: boolean
-}

src/types/entity/story.ts

@@ -0,0 +1,43 @@
+import type { CommonImage } from './common'
+import type { LiteralUnion } from '../../utils/typings'
+import type { User } from './user'
+
+export interface StoryPicture extends CommonImage {
+  key: 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 Story {
+  type: 'STORY'
+  id: string
+  storyType: LiteralUnion<'PICTURE' | 'VIDEO'>
+  status: LiteralUnion<'PUBLIC'>
+  user: User
+  emoji?: string
+  video?: StoryVideo
+  thumbnailVideo?: StoryVideo
+  picture: StoryPicture
+  liked: boolean
+  likeCount: number
+  commentCount: number
+  viewerCount: number
+  createdAt: string
+  likedUsers: User[]
+  enablePictureComments: boolean
+  isFeatured: boolean
+}

tests/api/stories.test.ts

@@ -16,4 +16,13 @@ describe('stories should work', () => {
     )
     expect(isSuccess(result)).toBe(true)
   })
+
+  it('getVideo should word', async () => {
+    const result = await api.mediaMeta.interactive(
+      '627fcab1d505530011e9c7c4',
+      'STORY',
+      'user'
+    )
+    expect(isSuccess(result)).toBe(true)
+  })
 })

typedoc.json

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