@ybgnb/bili-api 0.0.1 → 0.0.2

package/dist/service/relation/relation.d.ts

@@ -0,0 +1,190 @@
+import { BaseService } from '../base.js';
+import { type Relation, type RelationAct, type RelationStat, type RelationTag } from '../../types/modules/user/relation.js';
+import type { BizRequestOptions } from '../../types/core/request.js';
+import type { OnPageFetched, PageOptions } from '../../types/core/page.js';
+/**
+ * 用户关系的服务（关注、粉丝、黑名单）
+ */
+export declare class RelationService extends BaseService {
+    get userService(): import("../user/user.js").UserService;
+    /**
+     * 构建分页器（公共逻辑）- 根据分组获取用户关系列表
+     * @param tag           分组标识（number 或 RelationTag 对象）
+     * @param pageOptions   分页选项
+     * @param bizOptions    业务请求选项
+     * @protected
+     */
+    protected buildRelationPager(tag: number | RelationTag, pageOptions?: PageOptions, bizOptions?: BizRequestOptions): import("../../index.js").PageApi<Relation, Relation[]>;
+    /**
+     * 根据分组获取用户关系列表（单个分页数据）
+     * @param tag           分组标识（number 或 RelationTag 对象）
+     * @param pageOptions   分页选项
+     * @param bizOptions    业务请求选项
+     */
+    fetchRelationPage(tag: number | RelationTag, pageOptions?: PageOptions, bizOptions?: BizRequestOptions): Promise<Relation[] | null>;
+    /**
+     * 根据分组获取用户关系列表（循环获取所有分页数据）
+     * @param tag             分组标识（number 或 RelationTag 对象）
+     * @param pageOptions     分页选项
+     * @param onPageFetched   分页数据获取后的回调函数
+     * @param bizOptions      业务请求选项
+     */
+    fetchRelationAll(tag: number | RelationTag, pageOptions?: PageOptions, onPageFetched?: OnPageFetched, bizOptions?: BizRequestOptions): Promise<Relation[]>;
+    /**
+     * 查询用户与自己关系（互相关系）
+     * @param mid         对方uid
+     * @param options  业务选项
+     * @return relation：目标用户对于当前用户的关系；   be_relation：当前用户对于目标用户的关系
+     */
+    getRelation(mid: number, options?: BizRequestOptions): Promise<{
+        relation: Relation;
+        be_relation: Relation;
+    }>;
+    /**
+     * 获取关注分组
+     */
+    getFollowTags(options?: BizRequestOptions): Promise<RelationTag[]>;
+    /**
+     * 通过关注分组获取关注列表
+     */
+    getFollowingsByTag(tag: RelationTag, pageOptions?: PageOptions, onPageFetched?: OnPageFetched, options?: BizRequestOptions): Promise<Relation[]>;
+    /**
+     * 创建关注分组
+     */
+    createFollowTag(tagName: string, options?: BizRequestOptions): Promise<Pick<RelationTag, "tagid">>;
+    /**
+     * 更新关注分组
+     */
+    updateFollowTag(tag: Pick<RelationTag, 'tagid' | 'name'>, options?: BizRequestOptions): Promise<void>;
+    /**
+     * 删除关注分组
+     */
+    deleteFollowTag(tagId: number, options?: BizRequestOptions): Promise<void>;
+    /**
+     * 按关注分组列表获取所有的关注
+     */
+    getFollowsGroupedByTag(pageOptions?: PageOptions, onPageFetched?: OnPageFetched, options?: BizRequestOptions): Promise<RelationTag[]>;
+    /**
+     * 构建分页器（公共逻辑）- 获取关注列表
+     * @param uid           用户id，为空则获取当前用户
+     * @param pageOptions   分页选项
+     * @param bizOptions    业务请求选项
+     * @protected
+     */
+    protected buildFollowingsPager(uid?: number, pageOptions?: PageOptions, bizOptions?: BizRequestOptions): import("../../index.js").PageApi<Relation, Relation[]>;
+    /**
+     * 获取关注列表（单个分页数据。只能获取他人前100条数据）
+     * @param uid           用户id，为空则获取当前用户
+     * @param pageOptions   分页选项
+     * @param bizOptions    业务请求选项
+     */
+    fetchFollowingsPage(uid?: number, pageOptions?: PageOptions, bizOptions?: BizRequestOptions): Promise<Relation[] | null>;
+    /**
+     * 获取关注列表（循环获取所有分页数据。只能获取他人前100条数据）
+     * @param uid             用户id，为空则获取当前用户
+     * @param pageOptions     分页选项
+     * @param onPageFetched   分页数据获取后的回调函数
+     * @param bizOptions      业务请求选项
+     */
+    fetchFollowingsAll(uid?: number, pageOptions?: PageOptions, onPageFetched?: OnPageFetched, bizOptions?: BizRequestOptions): Promise<Relation[]>;
+    /**
+     * 关注用户
+     * @description （新号容易风控，需要前往APP/网页手动关注一下别人触发一次手机号验证。建议使用几天后再操作）
+     * @param mid         目标uid
+     * @param options  业务选项
+     */
+    followUser(mid: number, options?: BizRequestOptions): Promise<void>;
+    /**
+     * 取关用户
+     * @description （短时间内批量取关可能风控。需要前往APP/网页手动关注一下别人触发一次手机号验证）
+     * @param mid         目标uid
+     * @param options  业务选项
+     */
+    unFollowUser(mid: number, options?: BizRequestOptions): Promise<void>;
+    /**
+     * 复制关注到分组
+     * @param fids        待复制的用户 mid 列表，上限可能为20
+     * @param tagids      目标分组 id 列表
+     * @param options
+     */
+    copyUsersToTag(fids: number[], tagids: number[], options?: BizRequestOptions): Promise<void>;
+    /**
+     * 构建分页器（公共逻辑）- 获取粉丝列表
+     * @param uid           用户id，为空则获取当前用户
+     * @param pageOptions   分页选项
+     * @param bizOptions    业务请求选项
+     * @protected
+     */
+    protected buildFansPager(uid?: number, pageOptions?: PageOptions, bizOptions?: BizRequestOptions): import("../../index.js").PageApi<Relation, Relation[]>;
+    /**
+     * 获取粉丝列表（单个分页数据，只能获取他人前100条数据）
+     * @param uid           用户id，为空则获取当前用户
+     * @param pageOptions   分页选项
+     * @param bizOptions    业务请求选项
+     */
+    fetchFansPage(uid?: number, pageOptions?: PageOptions, bizOptions?: BizRequestOptions): Promise<Relation[] | null>;
+    /**
+     * 获取粉丝列表（循环获取所有分页数据，只能获取他人前100条数据）
+     * @param uid             用户id，为空则获取当前用户
+     * @param pageOptions     分页选项
+     * @param onPageFetched   分页数据获取后的回调函数
+     * @param bizOptions      业务请求选项
+     */
+    fetchFansAll(uid?: number, pageOptions?: PageOptions, onPageFetched?: OnPageFetched, bizOptions?: BizRequestOptions): Promise<Relation[]>;
+    /**
+     * 移除粉丝
+     * @param mid         目标uid
+     * @param options  业务选项
+     */
+    removeFan(mid: number, options?: BizRequestOptions): Promise<void>;
+    /**
+     * 获取用户关系状态数
+     */
+    getStat(mid: number, options?: BizRequestOptions): Promise<RelationStat>;
+    /**
+     * 防止风控
+     */
+    preventRiskControl(relationMid: number, options?: BizRequestOptions): Promise<void>;
+    /**
+     * 修改用户关系
+     * @param relationMid         对方uid
+     * @param relationAct         关系操作类型
+     * @param preventRiskControl  防止风控
+     * @param options          业务选项
+     * @protected
+     */
+    modify(relationMid: number, relationAct: RelationAct, preventRiskControl?: boolean, options?: BizRequestOptions): Promise<void>;
+    /**
+     * 拉黑用户
+     * @param mid     目标uid
+     * @param options 业务选项
+     */
+    blockUser(mid: number, options?: BizRequestOptions): Promise<void>;
+    /**
+     * 取消拉黑用户
+     * @param mid         目标uid
+     * @param options  业务选项
+     */
+    unBlockUser(mid: number, options?: BizRequestOptions): Promise<void>;
+    /**
+     * 构建分页器（公共逻辑）- 获取黑名单列表
+     * @param pageOptions   分页选项
+     * @param bizOptions    业务请求选项
+     * @protected
+     */
+    protected buildBlocksPager(pageOptions?: PageOptions, bizOptions?: BizRequestOptions): import("../../index.js").PageApi<Relation, Relation[]>;
+    /**
+     * 获取黑名单列表（单个分页数据）
+     * @param pageOptions   分页选项
+     * @param bizOptions    业务请求选项
+     */
+    fetchBlocksPage(pageOptions?: PageOptions, bizOptions?: BizRequestOptions): Promise<Relation[] | null>;
+    /**
+     * 获取黑名单列表（循环获取所有分页数据）
+     * @param pageOptions     分页选项
+     * @param onPageFetched   分页数据获取后的回调函数
+     * @param bizOptions      业务请求选项
+     */
+    fetchBlocksAll(pageOptions?: PageOptions, onPageFetched?: OnPageFetched, bizOptions?: BizRequestOptions): Promise<Relation[]>;
+}
+//# sourceMappingURL=relation.d.ts.map

package/dist/service/relation/relation.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"relation.d.ts","sourceRoot":"","sources":["../../../src/service/relation/relation.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,YAAY,CAAA;AACxC,OAAO,EACL,KAAK,QAAQ,EACb,KAAK,WAAW,EAEhB,KAAK,YAAY,EACjB,KAAK,WAAW,EACjB,MAAM,sCAAsC,CAAA;AAE7C,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,6BAA6B,CAAA;AAIpE,OAAO,KAAK,EAAE,aAAa,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAA;AAG1E;;GAEG;AACH,qBAAa,eAAgB,SAAQ,WAAW;IAC9C,IAAI,WAAW,0CAEd;IAED;;;;;;OAMG;IACH,SAAS,CAAC,kBAAkB,CAAC,GAAG,EAAE,MAAM,GAAG,WAAW,EAAE,WAAW,CAAC,EAAE,WAAW,EAAE,UAAU,CAAC,EAAE,iBAAiB;IAiBjH;;;;;OAKG;IAEG,iBAAiB,CAAC,GAAG,EAAE,MAAM,GAAG,WAAW,EAAE,WAAW,CAAC,EAAE,WAAW,EAAE,UAAU,CAAC,EAAE,iBAAiB;IAI5G;;;;;;OAMG;IAEG,gBAAgB,CACpB,GAAG,EAAE,MAAM,GAAG,WAAW,EACzB,WAAW,CAAC,EAAE,WAAW,EACzB,aAAa,CAAC,EAAE,aAAa,EAC7B,UAAU,CAAC,EAAE,iBAAiB;IAKhC;;;;;OAKG;IAEG,WAAW,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,iBAAiB;kBAC5B,QAAQ;qBAAe,QAAQ;;IAY7D;;OAEG;IAEH,aAAa,CAAC,OAAO,CAAC,EAAE,iBAAiB;IAIzC;;OAEG;IAEH,kBAAkB,CAChB,GAAG,EAAE,WAAW,EAChB,WAAW,CAAC,EAAE,WAAW,EACzB,aAAa,CAAC,EAAE,aAAa,EAC7B,OAAO,CAAC,EAAE,iBAAiB;IAK7B;;OAEG;IAEH,eAAe,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,iBAAiB;IAS5D;;OAEG;IAEH,eAAe,CAAC,GAAG,EAAE,IAAI,CAAC,WAAW,EAAE,OAAO,GAAG,MAAM,CAAC,EAAE,OAAO,CAAC,EAAE,iBAAiB;IAOrF;;OAEG;IAEH,eAAe,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,iBAAiB;IAS1D;;OAEG;IAEG,sBAAsB,CAAC,WAAW,CAAC,EAAE,WAAW,EAAE,aAAa,CAAC,EAAE,aAAa,EAAE,OAAO,CAAC,EAAE,iBAAiB;IAQlH;;;;;;OAMG;IACH,SAAS,CAAC,oBAAoB,CAAC,GAAG,CAAC,EAAE,MAAM,EAAE,WAAW,CAAC,EAAE,WAAW,EAAE,UAAU,CAAC,EAAE,iBAAiB;IAetG;;;;;OAKG;IAEG,mBAAmB,CAAC,GAAG,CAAC,EAAE,MAAM,EAAE,WAAW,CAAC,EAAE,WAAW,EAAE,UAAU,CAAC,EAAE,iBAAiB;IAIjG;;;;;;OAMG;IAEG,kBAAkB,CACtB,GAAG,CAAC,EAAE,MAAM,EACZ,WAAW,CAAC,EAAE,WAAW,EACzB,aAAa,CAAC,EAAE,aAAa,EAC7B,UAAU,CAAC,EAAE,iBAAiB;IAKhC;;;;;OAKG;IAEG,UAAU,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,iBAAiB;IAIzD;;;;;OAKG;IAEG,YAAY,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,iBAAiB;IAI3D;;;;;OAKG;IAEH,cAAc,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,EAAE,OAAO,CAAC,EAAE,iBAAiB;IAS5E;;;;;;OAMG;IACH,SAAS,CAAC,cAAc,CAAC,GAAG,CAAC,EAAE,MAAM,EAAE,WAAW,CAAC,EAAE,WAAW,EAAE,UAAU,CAAC,EAAE,iBAAiB;IAehG;;;;;OAKG;IAEG,aAAa,CAAC,GAAG,CAAC,EAAE,MAAM,EAAE,WAAW,CAAC,EAAE,WAAW,EAAE,UAAU,CAAC,EAAE,iBAAiB;IAI3F;;;;;;OAMG;IAEG,YAAY,CAChB,GAAG,CAAC,EAAE,MAAM,EACZ,WAAW,CAAC,EAAE,WAAW,EACzB,aAAa,CAAC,EAAE,aAAa,EAC7B,UAAU,CAAC,EAAE,iBAAiB;IAKhC;;;;OAIG;IACG,SAAS,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,iBAAiB;IAIxD;;OAEG;IAEG,OAAO,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,iBAAiB;IAStD;;OAEG;IAEG,kBAAkB,CAAC,WAAW,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,iBAAiB;IAoCzE;;;;;;;OAOG;IAEG,MAAM,CACV,WAAW,EAAE,MAAM,EACnB,WAAW,EAAE,WAAW,EACxB,kBAAkB,GAAE,OAAc,EAClC,OAAO,CAAC,EAAE,iBAAiB;IA2B7B;;;;OAIG;IAEG,SAAS,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,iBAAiB;IAIxD;;;;OAIG;IAEG,WAAW,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,iBAAiB;IAI1D;;;;;OAKG;IACH,SAAS,CAAC,gBAAgB,CAAC,WAAW,CAAC,EAAE,WAAW,EAAE,UAAU,CAAC,EAAE,iBAAiB;IAUpF;;;;OAIG;IAEG,eAAe,CAAC,WAAW,CAAC,EAAE,WAAW,EAAE,UAAU,CAAC,EAAE,iBAAiB;IAI/E;;;;;OAKG;IAEG,cAAc,CAAC,WAAW,CAAC,EAAE,WAAW,EAAE,aAAa,CAAC,EAAE,aAAa,EAAE,UAAU,CAAC,EAAE,iBAAiB;CAG9G"}