@seayoo-web/gamer-api 1.0.1 → 1.0.4

package/types/src/club.guards.d.ts

@@ -1,75 +1,43 @@
-export interface ClubGlobalConfig {
-    /** 俱乐部默认头像地址 */
-    default_avatar_url: string;
-    /** 俱乐部官方头像库地址 */
-    official_avatar_urls: string[];
-    /** 俱乐部默认昵称 */
-    default_nickname: string;
-    /** 俱乐部默认签名 */
-    default_bio: string;
-    /** 俱乐部默认用户角色头像地址 */
-    default_role_avatar_url: string;
-    /** 俱乐部等级配置 */
-    level_configs: {
-        /** 俱乐部等级 */
-        level: number;
-        /** 等级对应的成长值 */
-        exp: number;
-        /** 俱乐部等级对应的称号 */
-        title: string;
-    }[];
-    /** 俱乐部等级有效期 */
-    level_valid_days: number;
-    /** 俱乐部权益描述 */
-    benefit_description: string;
-    /** 俱乐部成长值描述 */
-    exp_description: string;
-    /** 俱乐部积分规则描述 */
-    credit_description: string;
-    /** 发送角色邮件的频次限制，单位：秒 */
-    send_role_mail_rate_limit: number;
-}
+import type { ClubAddress, ClubBenefit, ClubBenefitSummary, ClubGlobalConfig, ClubPlayer, ClubProduct, ClubCreditLog, PlayerRole, PlayerRoleCard, Redemption, RoleBaseInfo, ServerBaseInfo, ClubUserCredit, ClubUserProfile } from "./club.define";
 export declare function isClubConfigResponse(data: unknown): data is ClubGlobalConfig;
-export interface ClubPlayer {
-    /** 俱乐部会员 ID（世游通行证 ID） */
-    member_id: string;
-    /** Combo ID */
-    player_id: string;
-    /** 游戏账号类型 */
-    type: "primary" | "secondary";
-    /** 成长值 */
-    exp: number;
-    /** 等级 */
-    level: number;
-    /** 用户积分余额 */
-    credit: number;
-    /** 月底即将过期积分数量 */
-    credit_expiring: number;
-    /** 等级变动时间 */
-    level_change_time: number;
-    /** 等级过期时间 */
-    level_expire_time: number;
-}
 export declare function isClubPlayerResponse(data: unknown): data is {
     player: ClubPlayer;
 };
-export declare function isClubPlayersResponse(data: unknown): data is {
-    players: ClubPlayer[];
+export type VerifyLinkSecondaryPlayerOtpResponse = ServerBaseInfo & RoleBaseInfo;
+export declare function isGetRolesResponse(data: unknown): data is {
+    roles: PlayerRole[];
+};
+export declare function isRoleCardResponse(data: unknown): data is {
+    role_card: PlayerRoleCard;
 };
-export interface Server {
-    server_id: string;
-    server_name: string;
+export declare function isUserProfile(data: unknown): data is ClubUserProfile;
+export declare function isClubAddress(data: unknown): data is ClubAddress;
+export declare function isGetAddressesResponse(data: unknown): data is {
+    addresses: ClubAddress[];
+};
+export declare function isUserCredit(data: unknown): data is ClubUserCredit;
+export interface CreditLogListWithToken {
+    /** 用户积分变动记录 */
+    credit_logs: ClubCreditLog[];
+    /** 下一页的 token，用于 cursor 分页机制，若无值，则表示没有更多数据了 */
+    next_token?: string;
 }
-export declare function isGetSecondaryServersResponse(data: unknown): data is {
-    servers: Server[];
+export declare function isCreditLogListWithToken(data: unknown): data is CreditLogListWithToken;
+export declare function isBenefitSummary(data: unknown): data is ClubBenefitSummary;
+export declare function isGetBenefitsResponse(data: unknown): data is {
+    benefits: ClubBenefitSummary[];
+};
+export declare function isGetBenefitResponse(data: unknown): data is {
+    benefit: ClubBenefit;
 };
-export declare function isCreateLinkSecondaryPlayerOtpResponse(data: unknown): data is {
-    ticket: string;
+export declare function isClubProduct(data: unknown): data is ClubProduct;
+export declare function isGetProductsResponse(data: unknown): data is {
+    products: ClubProduct[];
 };
-export interface VerifyLinkSecondaryPlayerOtpResponse {
-    role_id: string;
-    role_name: string;
-    server_id: string;
-    server_name: string;
+export interface RedemptionListWithToken {
+    /** 兑换记录列表 */
+    redemptions: Redemption[];
+    /** 下一页的 token，用于 cursor 分页机制，若无值，则表示没有更多数据了 */
+    next_token?: string;
 }
-export declare function isVerifyLinkSecondaryPlayerOtpResponse(data: unknown): data is VerifyLinkSecondaryPlayerOtpResponse;
+export declare function isRedemptionListWithToken(data: unknown): data is RedemptionListWithToken;

package/types/src/community.d.ts

@@ -0,0 +1,258 @@
+import type { NotificationCategory } from "./community.enums";
+import type { AuthToken } from "./token";
+import type { RequestInteralError } from "@seayoo-web/request";
+export * from "./community.enums";
+export * from "./community.define";
+export declare class CommunityApi {
+    private token;
+    private req;
+    constructor(authToken: AuthToken);
+    /**
+     * 获取社区版块列表，仅返回启用状态的版块
+     *
+     * https://kdocs.cn/l/cbggfJodHLIz?linkname=QaqUa2K0z0
+     */
+    getForums(): Promise<import("./community.define").Forum[]>;
+    /**
+     * 获取社区话题列表，仅返回启用状态的话题
+     *
+     * https://kdocs.cn/l/cbggfJodHLIz?linkname=mIwpymAQom
+     */
+    getTopics(): Promise<import("./community.define").Topic[]>;
+    /**
+     * 根据话题 ID 获取社区话题信息
+     *
+     * https://kdocs.cn/l/cbggfJodHLIz?linkname=Jvw7xMK31K
+     */
+    getTopic(topicId: number): Promise<import("./community.define").Topic | {
+        error: RequestInteralError | "topic_not_enabled" | "topic_not_found";
+    }>;
+    /**
+     * 获取社区帖子列表
+     *
+     * https://kdocs.cn/l/cbggfJodHLIz?linkname=XKI9lDVrPq
+     */
+    getPosts(option: {
+        /** 查询返回最大帖子数 */
+        max_results: number;
+        /** 查询类型 */
+        query_type: "all" | "forum" | "topic" | "user";
+        /**
+         * 查询对应的值
+         *
+         * - 论坛ID
+         * - 话题ID
+         * - 用户ID
+         */
+        query_value?: string | number;
+        /** 搜索内容 */
+        search_value?: string;
+        /** 分页标识，不传默认首次查询 */
+        next_token?: string;
+        /**
+         * 帖子排序键，默认按照发布时间倒序
+         *
+         * - post_time_desc 帖子发布时间倒序
+         * - post_like 帖子点赞数排序
+         */
+        sort_key?: "post_time_desc" | "post_like";
+    }): Promise<import("./community.guards").PostListWithToken | {
+        error: RequestInteralError | "forum_not_found" | "topic_not_found";
+    }>;
+    /**
+     * 获取社区置顶帖子列表
+     *
+     * https://kdocs.cn/l/cbggfJodHLIz?linkname=yXubbZuDlC
+     */
+    getPinnedPosts(forumId: number, maxResults: number, nextToken?: string): Promise<import("./community.guards").PostListWithToken | {
+        error: RequestInteralError | "forum_not_found";
+    }>;
+    /**
+     * 根据帖子 id 获取帖子详情
+     *
+     * https://kdocs.cn/l/cbggfJodHLIz?linkname=hj1AZy5rcP
+     */
+    getPost(postId: number): Promise<import("./community.define").Post | {
+        error: RequestInteralError | "post_deleted";
+    }>;
+    /**
+     * 发布帖子
+     *
+     * https://kdocs.cn/l/cbggfJodHLIz?linkname=M5okHBuaVk
+     */
+    post(option: {
+        forum_id: number;
+        content: string;
+        title?: string;
+        image_urls?: string[];
+        topic_ids?: number[];
+    }): Promise<{
+        post?: import("./community.define").Post;
+        antispam?: import("./community.define").Antispam;
+    } | {
+        error: RequestInteralError | "post_body_too_long" | "post_subject_too_long" | "post_tag_already_exists" | "moderation_check_text_error" | "moderation_check_image_error" | "unknown_moderation_suggestion" | "invalid_content_length" | "forum_disabled" | "not_allowed_to_post" | "please_real_name" | "post_tag_not_exists";
+    }>;
+    /**
+     * 获取社区帖子评论列表
+     *
+     * https://kdocs.cn/l/cbggfJodHLIz?linkname=djKbX7lFdp
+     */
+    getComments(option: {
+        /** 查询类型 */
+        query_type: "post" | "user";
+        /** 帖子 ID 或 用户 ID */
+        query_value: string | number;
+        /** 查询返回的数量 */
+        max_results: number;
+        /** 分页token */
+        next_token?: string;
+    }): Promise<import("./community.guards").CommentListWithToken | {
+        error: RequestInteralError | "post_not_found" | "post_deleted";
+    }>;
+    /**
+     * 根据评论 id 获取评论详情
+     *
+     * https://kdocs.cn/l/cbggfJodHLIz?linkname=RIc7oxVGae
+     */
+    getComment(commentId: number): Promise<import("./community.define").Comment | {
+        error: RequestInteralError | "comment_not_found" | "comment_deleted";
+    }>;
+    /**
+     * 帖子下发表评论
+     *
+     * https://kdocs.cn/l/cbggfJodHLIz?linkname=Nv7lk0nTmr
+     */
+    comment(option: {
+        /** 帖子 ID */
+        post_id: number;
+        /** 评论内容 */
+        content: string;
+        /** 评论内容图片地址 */
+        image_url?: string;
+    }): Promise<{
+        comment?: import("./community.define").Comment;
+        antispam?: import("./community.define").Antispam;
+    } | {
+        error: RequestInteralError | "moderation_check_text_error" | "moderation_check_image_error" | "unknown_moderation_suggestion" | "invalid_content_length" | "forum_disabled" | "post_not_found" | "post_already_deleted";
+    }>;
+    /**
+     * 获取社区帖子评论回复列表
+     *
+     * https://kdocs.cn/l/cbggfJodHLIz?linkname=sVKBbY83MY
+     */
+    getReplies(option: {
+        /** 查询返回最大回复数 */
+        max_results?: number;
+        /** 查询类型 */
+        query_type: "comment" | "user";
+        /** 查询对应的值 */
+        query_value: string;
+        /** 分页标识，不传默认首次查询 */
+        next_token?: string;
+    }): Promise<import("./community.guards").ReplyListWithToken>;
+    /**
+     * 根据回复 id 获取回复详情
+     *
+     * https://kdocs.cn/l/cbggfJodHLIz?linkname=kxhcSXD3MG
+     */
+    getReply(replyId: number): Promise<import("./community.define").Reply | {
+        error: RequestInteralError | "reply_not_found" | "reply_deleted";
+    }>;
+    /**
+     * 回复帖子评论或回复
+     *
+     * https://kdocs.cn/l/cbggfJodHLIz?linkname=KA8WpTX2pg
+     */
+    reply(option: {
+        /** 评论 ID */
+        comment_id: number;
+        /** 评论内容 */
+        content: string;
+        /** 回复的回复 ID (仅当回复回复的时候需要) */
+        reply_id?: number;
+    }): Promise<{
+        reply?: import("./community.define").Reply;
+        antispam?: import("./community.define").Antispam;
+    } | {
+        error: RequestInteralError | "moderation_check_text_error" | "moderation_check_image_error" | "comment_not_found" | "comment_deleted" | "reply_not_found" | "reply_deleted";
+    }>;
+    /**
+     * 对 帖子/评论/回复 点赞
+     *
+     * https://kdocs.cn/l/cbggfJodHLIz?linkname=CR3m6PyXfZ
+     */
+    like(option: {
+        /** 点赞目标类型 */
+        target_type: "post" | "comment" | "reply";
+        /** 目标 ID */
+        target_id: number;
+    }): Promise<true | {
+        error: RequestInteralError | "post_not_found" | "post_deleted" | "comment_not_found" | "comment_deleted" | "reply_not_found" | "reply_deleted";
+    }>;
+    /**
+     * 对 帖子/评论/回复 取消点赞
+     *
+     * https://kdocs.cn/l/cbggfJodHLIz?linkname=CR3m6PyXfZ
+     */
+    unlike(option: {
+        /** 点赞目标类型 */
+        target_type: "post" | "comment" | "reply";
+        /** 目标 ID */
+        target_id: number;
+    }): Promise<true | {
+        error: RequestInteralError | "post_not_found" | "post_deleted" | "comment_not_found" | "comment_deleted" | "reply_not_found" | "reply_deleted";
+    }>;
+    /**
+     * 获取资源预上传地址
+     *
+     * https://kdocs.cn/l/cbggfJodHLIz?linkname=dWWhpoShxZ
+     */
+    getMediaPresignUrl(option: {
+        /** 资源文件大小 */
+        content_length: number;
+        /** 资源文件 MIME 类型  */
+        content_type: string;
+        /** 资源文件名 */
+        filename: string;
+        /** 资源文件内容的 SHA-256 哈希值，用于校验上传对象的完整性 */
+        content_sha256: string;
+    }): Promise<{
+        image_url: string;
+        upload_url: string;
+        existed: boolean;
+    } | null>;
+    /**
+     * 获取用户社区通知
+     *
+     * 了解更多[通知的分类](https://kdocs.cn/l/cbggfJodHLIz?linkname=AiCR5khgOr)。
+     *
+     * https://kdocs.cn/l/cbggfJodHLIz?linkname=W5lceDgbBG
+     */
+    getNotifications(option: {
+        /** 社区通知分类 */
+        category: NotificationCategory;
+        /** 查询返回最大通知数量 */
+        max_results?: number;
+        /** 分页标识，不传默认首次查询 */
+        next_token?: string;
+    }): Promise<{
+        notifications: import("./community.define").Notification[];
+        next_token?: string;
+    }>;
+    /**
+     * 获取用户未读通知数量
+     *
+     * https://kdocs.cn/l/cbggfJodHLIz?linkname=CwIOMjAfMU
+     */
+    getUnreadNotificationsCount(): Promise<{
+        system: number;
+        comment: number;
+        like: number;
+    } | null>;
+    /**
+     * 社区用户将通知标为已读
+     *
+     * https://kdocs.cn/l/cbggfJodHLIz?linkname=TCJQxnOjJe
+     */
+    clearUnreadNotifications(category: NotificationCategory): Promise<boolean>;
+}

package/types/src/community.define.d.ts

@@ -0,0 +1,231 @@
+import type { NotificationType, ForumMode, PostStatus } from "./community.enums";
+export interface Forum {
+    /** 版块 id */
+    forum_id: number;
+    /** 版块图标 */
+    icon_url: string;
+    /** 版块名称 */
+    name: string;
+    /** 版块标签 */
+    tags: string[];
+    /** 版块排序权重, 数值越大排序越靠前 */
+    sort: number;
+    /** 发帖模式 */
+    mode: ForumMode;
+    /** 指定可发帖的用户 id */
+    member_ids: number[];
+}
+export interface Topic {
+    /** 话题 ID */
+    topic_id: number;
+    /** 话题图标，可能是空字符串 */
+    cover_url: string;
+    /** 话题名称 */
+    name: string;
+    /** 话题描述 */
+    description: string;
+    /** 话题标签 */
+    tags: string[];
+    /** 话题下帖子数量 */
+    post_num: number;
+}
+export interface Post {
+    /** 帖子 ID */
+    post_id: number;
+    /** 版块信息 */
+    forum: Forum;
+    /** 帖子发布者的 ID */
+    posted_by: string;
+    /** 帖子发布者的昵称 */
+    nickname: string;
+    /** 帖子发布者的头像 */
+    avatar_url: string;
+    /** 帖子标题 */
+    title?: string;
+    /** 帖子内容，富文本 HTML 格式 */
+    content: string;
+    /** 帖子内容，纯文本格式 */
+    summary: string;
+    /** 点赞数量 */
+    like_num: number;
+    /** 评论数量 */
+    comments_num: number;
+    /** 当前用户是否点赞 */
+    liked: boolean;
+    /** 帖子图片地址 */
+    image_urls: string[];
+    /** 帖子关联话题 */
+    topics: Topic[];
+    /** 帖子关联活动 ids */
+    event_ids: number[];
+    /** 帖子是否置顶 */
+    is_pinned: boolean;
+    /** 帖子是否标精 */
+    is_highlighted: boolean;
+    /** 帖子状态 */
+    status: PostStatus;
+    /** 帖子发布时间 */
+    create_time: number;
+}
+export interface Antispam {
+    /** 安全检测返回异常提示 */
+    err_msg?: string;
+}
+export interface Comment {
+    /** 评论 ID */
+    comment_id: number;
+    /** 帖子 ID */
+    post_id: number;
+    /** 帖子标题 */
+    post_subject?: string;
+    /** 帖子概要 */
+    post_summary?: string;
+    /** 帖子的首张图片地址 */
+    post_image_url?: string;
+    /** 帖子发布者的 ID */
+    posted_by?: string;
+    /** 帖子发布者的昵称 */
+    posted_by_nickname?: string;
+    /** 帖子发布者的头像 */
+    posted_by_avatar_url?: string;
+    /** 评论发布者的 ID */
+    commented_by: string;
+    /** 评论发布者的昵称 */
+    nickname: string;
+    /** 评论发布者的头像 */
+    avatar_url: string;
+    /** 评论内容 */
+    content: string;
+    /** 点赞数量 */
+    like_num: number;
+    /** 回复数量 */
+    reply_num: number;
+    /** 当前用户是否点赞 */
+    liked: boolean;
+    /** 评论图片地址 */
+    image_url: string;
+    /** 评论发布时间 */
+    create_time: number;
+    /** 评论状态 */
+    status: PostStatus;
+    /** 评论下最新两条回复 */
+    replies?: Reply[];
+}
+export interface Reply {
+    /** 回复 ID */
+    reply_id: number;
+    /** 评论 ID */
+    comment_id: number;
+    /** 评论内容 */
+    comment_content?: string;
+    /** 评论发布者的 ID */
+    commented_by?: string;
+    /** 评论发布者的昵称 */
+    commented_by_nickname?: string;
+    /** 评论发布者的头像 */
+    commented_by_avatar_url?: string;
+    /** 回复者的 ID */
+    replied_by: string;
+    /** 回复者的昵称 */
+    nickname: string;
+    /** 回复者的头像 */
+    avatar_url: string;
+    /** 回复内容 */
+    content: string;
+    /** 点赞数量 */
+    like_num: number;
+    /** 当前用户是否点赞 */
+    liked: number;
+    /** 回复的目标 */
+    reply_to: ReplyTo;
+    /** 回复发布时间 */
+    create_time: number;
+}
+export interface ReplyTo {
+    /** 回复 ID */
+    reply_id: number;
+    /** 回复内容 */
+    reply_content?: string;
+    /** 回复者的 ID */
+    replied_by: string;
+    /** 回复者的昵称 */
+    nickname: string;
+    /** 回复者的头像 */
+    avatar_url: string;
+}
+interface NotificationBase {
+    /** 通知的 ID */
+    notification_id: string;
+    /** 通知类型 */
+    notification_type: NotificationType;
+    /** 通知是否已读 */
+    is_read: boolean;
+    /** 通知产生时间 */
+    create_time: number;
+    /** 触发通知的用户 ID，系统管理员 ID 为 "0" */
+    origin_user_id: string;
+    /** 触发通知的用户昵称，如果是系统管理员也会包含此字段，会使用系统配置中管理员的信息 */
+    origin_user_name: string;
+    /** 触发通知的用户头像 */
+    origin_user_avatar_url: string;
+}
+interface NotificationPaylodSystem {
+    /** 系统通知的标题 */
+    system_message_subject: string;
+    /** 系统通知的内容 */
+    system_message_content: string;
+}
+interface NotificationPaylodPost {
+    /** 帖子 ID */
+    post_id: number;
+    /** 帖子标题 */
+    post_subject: string;
+    /** 帖子概要 */
+    post_summary: string;
+    /** 帖子的首张图片地址 */
+    post_image_url: string;
+}
+interface NotificationPaylodComment {
+    /** 评论 ID */
+    comment_id: number;
+    /** 评论内容 */
+    comment_content: string;
+}
+interface NotificationPaylodReply {
+    /** 回复 ID */
+    reply_id: number;
+    /** 回复内容 */
+    reply_content: string;
+}
+interface NotificationPaylodReplyToReply {
+    /** 回复的回复 ID */
+    reply_to_reply_id: number;
+    /** 回复的回复内容 */
+    reply_to_reply_content: string;
+}
+export interface NotificationSystem extends NotificationBase, NotificationPaylodSystem {
+    notification_type: NotificationType.System;
+}
+export interface NotificationPost extends NotificationBase, NotificationPaylodPost {
+    notification_type: NotificationType.PostPinned | NotificationType.PostHighlighted | NotificationType.PostDeleted | NotificationType.PostLiked;
+}
+export interface NotificationPostComment extends NotificationBase, NotificationPaylodPost, NotificationPaylodComment {
+    notification_type: NotificationType.PostCommented;
+}
+export interface NotificationCommentReply extends NotificationBase, NotificationPaylodComment, NotificationPaylodReply {
+    notification_type: NotificationType.CommentReplied;
+}
+export interface NotificationComment extends NotificationBase, NotificationPaylodComment, NotificationPaylodPost {
+    notification_type: NotificationType.CommentLiked | NotificationType.CommentDeleted;
+}
+export interface NotificationReplyReplied extends NotificationBase, NotificationPaylodReply, NotificationPaylodReplyToReply {
+    notification_type: NotificationType.ReplyReplied;
+    /** 评论 ID */
+    comment_id: number;
+}
+export interface NotificationReply extends NotificationBase, NotificationPaylodReply, NotificationPaylodComment {
+    notification_type: NotificationType.ReplyLiked | NotificationType.ReplyDeleted;
+}
+/** 社区通知 */
+export type Notification = NotificationSystem | NotificationPost | NotificationPostComment | NotificationCommentReply | NotificationComment | NotificationReplyReplied | NotificationReply;
+export {};

package/types/src/community.enums.d.ts

@@ -0,0 +1,54 @@
+/** 社区板块模式 */
+export declare const enum ForumMode {
+    /** 所有人均可以发帖 */
+    All = "all",
+    /** 指定用户可发帖 */
+    Limit = "limit"
+}
+/** 社区帖子状态 */
+export declare const enum PostStatus {
+    /** 待审核（仅自己可见） */
+    Pending = "pending",
+    /** 审核通过 */
+    Approved = "approved",
+    /** 审核不通过 */
+    Failed = "failed",
+    /** 嫌疑（仅自己可见） */
+    Suspect = "suspect"
+}
+/** 社区通知分类 */
+export declare const enum NotificationCategory {
+    /** 系统通知 */
+    System = "system",
+    /** 评论我的 */
+    Comment = "comment",
+    /** 点赞通知 */
+    Like = "like"
+}
+/** 社区通知类型 */
+export declare const enum NotificationType {
+    /** 系统通知 */
+    System = "system",
+    /** 帖子被置顶 */
+    PostPinned = "post_pinned",
+    /** 帖子被加精 */
+    PostHighlighted = "post_highlighted",
+    /** 帖子被删除 */
+    PostDeleted = "post_deleted",
+    /** 帖子被评论 */
+    PostCommented = "post_commented",
+    /** 帖子被点赞 */
+    PostLiked = "post_liked",
+    /** 评论被回复 */
+    CommentReplied = "comment_replied",
+    /** 评论被点赞 */
+    CommentLiked = "comment_liked",
+    /** 评论被删除 */
+    CommentDeleted = "comment_deleted",
+    /** 回复被回复 */
+    ReplyReplied = "reply_replied",
+    /** 回复被点赞 */
+    ReplyLiked = "reply_liked",
+    /** 回复被删除 */
+    ReplyDeleted = "reply_deleted"
+}