feat(jike-client): add isFollowing

Author: sxzz

README.md

@@ -31,6 +31,7 @@
   - [x] 获取被关注列表
   - [x] 关注
   - [x] 取消关注
+  - [x] 是否关注用户
 - 动态帖子
   - [x] 发送动态
   - [x] 获取动态详情

src/client/user.ts

@@ -131,7 +131,7 @@ export class JikeUser<M extends boolean = boolean> {
   }
 
   /**
-   * 查询用户被关注（带关注时间，较慢）
+   * 查询用户被关注，带关注时间。逐个用户查询，耗时较长。
    */
   queryFollowersWithTime(
     option: PaginatedOption<FollowerWithTime, 'followTime', string> = {}
@@ -163,6 +163,38 @@ export class JikeUser<M extends boolean = boolean> {
     )
   }
 
+  /**
+   * 是否关注用户
+   * @param user 用户名或用户实例
+   * @param mode
+   * `following`: 从 当前用户 的 关注 列表查找 目标用户 是否存在；
+   * `follower` : 从 目标用户 的 被关注 列表查找 当前用户 是否存在。
+   *
+   * 为提升查询速度，建议哪个数量少使用哪个。
+   */
+  async isFollowing(user: JikeUser | string, mode: 'following' | 'follower') {
+    const target = typeof user === 'string' ? this.#client.getUser(user) : user
+    const targetUsername = await (mode === 'following'
+      ? target.getUsername()
+      : this.getUsername())
+
+    const includes = (data: User[]) =>
+      data.some((item) => item.username === targetUsername)
+
+    let data: User[]
+    if (mode === 'following') {
+      data = await this.queryFollowings({
+        limit: (opt, item, data) => !includes(data),
+      })
+    } else {
+      data = await target.queryFollowers({
+        limit: (opt, item, data) => !includes(data),
+      })
+    }
+
+    return includes(data)
+  }
+
   /**
    * 查询用户关注
    */

src/client/utils/paginate.ts

@@ -5,9 +5,11 @@ export interface PaginatedOption<
   L extends keyof LimitOptionAll = keyof LimitOptionAll,
   K = unknown
 > {
+  /** @returns `true`: 继续下一页；`false`: 停止获取 */
   limit?: LimitFn<L | 'total', T>
   /**
-   * 当获取下一页时触发，返回 false 将停止获取下一页
+   * 当获取下一页时触发
+   * @returns `false`: 将停止获取下一页
    */
   onNextPage?: (
     currentPage: number,

src/types/entity/profile.ts

@@ -1,3 +1,4 @@
+import type { StoryStatus } from './post'
 import type { LiteralUnion } from '../../utils/typings'
 import type { AvatarImage, BackgroundImage, StatsCount, User } from './user'
 
@@ -112,6 +113,22 @@ export interface Profile {
   isDefaultScreenName?: boolean
   /** 访客信息，仅自己可见 */
   profileVisitInfo?: ProfileVisitInfo
+  /** 是否关注 */
+  following: boolean
+  /** 是否拉黑 */
+  blocking: boolean
+  /** 是否 不看TA的内容 */
+  muting: boolean
+  /** 是否 添加到桌面小组件 */
+  watching: boolean
+  /** 是否特别关心 */
+  isWatching: boolean
+  /** 日记状态 */
+  storyStatus: LiteralUnion<StoryStatus>
+  /** 是否夸夸过 */
+  respected: boolean
+
+  [key: string]: any
 }
 
 /**

tests/jike-client/user.test.ts

@@ -0,0 +1,25 @@
+import { describe, expect, it } from 'vitest'
+import { JikeClient } from '../../src'
+import { config, refreshToken } from '../config'
+
+describe('user', async () => {
+  const client = new JikeClient({ ...config, refreshToken })
+  const username = 'c00cf715-b71b-464b-9dcc-d73e01878137'
+
+  const profile = await client.getUser(username).queryProfile()
+  const { following } = profile.user
+
+  describe('isFollowing should work', () => {
+    it('follower mode should work', async () => {
+      expect(await client.getSelf().isFollowing(username, 'follower')).toBe(
+        following
+      )
+    })
+
+    it('following mode should work', async () => {
+      expect(await client.getSelf().isFollowing(username, 'following')).toBe(
+        following
+      )
+    })
+  })
+})