@seayoo-web/gamer-api 1.1.15 → 1.1.17

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@seayoo-web/gamer-api",
   "description": "agent for gamer api",
-  "version": "1.1.15",
+  "version": "1.1.17",
   "type": "module",
   "source": "index.ts",
   "main": "./dist/index.js",
@@ -23,14 +23,14 @@
   "devDependencies": {
     "@types/node": "^22.13.1",
     "@seayoo-web/combo-webview": "^2.5.0",
-    "@seayoo-web/scripts": "^1.3.15",
     "@seayoo-web/request": "^2.1.2",
     "@seayoo-web/tsconfig": "^1.0.3",
-    "@seayoo-web/utils": "^3.2.1"
+    "@seayoo-web/scripts": "^1.3.15",
+    "@seayoo-web/utils": "^3.3.0"
   },
   "peerDependencies": {
     "@seayoo-web/combo-webview": "^2.5.0",
-    "@seayoo-web/utils": "^3.2.1"
+    "@seayoo-web/utils": "^3.3.0"
   },
   "dependencies": {
     "vitest": "^3.0.5"

package/types/src/club.d.ts

@@ -132,7 +132,10 @@ export declare class ClubApi {
         end_time: number;
         /** 游戏账号 ID，游戏外必传 */
         player_id?: string;
-    }): Promise<import("./club.guards").CreditLogListWithToken>;
+    }): Promise<{
+        credit_logs: import("./club.define").ClubCreditLog[];
+        next_token: string | undefined;
+    }>;
     /**
      * 获取自己的俱乐部权益列表
      *
@@ -182,5 +185,8 @@ export declare class ClubApi {
         item_type?: ClubItemType;
         /** 游戏账号 ID，游戏外必传 */
         player_id?: string;
-    }): Promise<import("./club.guards").RedemptionListWithToken>;
+    }): Promise<{
+        redemptions: import("./club.define").Redemption[];
+        next_token: string | undefined;
+    }>;
 }

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

@@ -35,8 +35,6 @@ export interface ClubPlayer {
     member_id: string;
     /** Combo ID */
     player_id: string;
-    /** 游戏账号类型 */
-    type: "primary" | "secondary";
     /** 成长值 */
     exp: number;
     /** 等级 */

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

@@ -6,6 +6,7 @@ export declare const enum Gender {
     /** 女 */
     Female = "female"
 }
+export declare const GenderValidator: import("@seayoo-web/utils").StringValidator<Gender, false, false>;
 /** 俱乐部积分变化类型 */
 export declare const enum ClubCreditChangeType {
     /** 积分增加 */
@@ -15,6 +16,7 @@ export declare const enum ClubCreditChangeType {
     /** 积分过期 */
     Expired = "expired"
 }
+export declare const ClubCreditChangeTypeValidator: import("@seayoo-web/utils").StringValidator<ClubCreditChangeType, false, false>;
 /** 积分变动场景 */
 export declare const enum ClubCreditChangeSence {
     /** 游戏内购买 */
@@ -30,6 +32,7 @@ export declare const enum ClubCreditChangeSence {
     /** 运营活动 */
     Event = "event"
 }
+export declare const ClubCreditChangeSenceValidator: import("@seayoo-web/utils").StringValidator<ClubCreditChangeSence, false, false>;
 export declare const enum ClubItemType {
     /** 游戏内奖励 */
     GameReward = "game_reward",
@@ -38,11 +41,13 @@ export declare const enum ClubItemType {
     /** 虚拟商品 */
     Virtual = "virtual"
 }
+export declare const ClubItemTypeValidator: import("@seayoo-web/utils").StringValidator<ClubItemType, false, false>;
 export declare const enum ClubRedemptionStatus {
     /** 待发放 */
     Pending = "pending",
     /** 已发放 */
-    issued = "issued",
+    Issued = "issued",
     /** 发放失败 */
-    failed = "failed"
+    Failed = "failed"
 }
+export declare const ClubRedemptionStatusValidator: import("@seayoo-web/utils").StringValidator<ClubRedemptionStatus, false, false>;

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

@@ -1,43 +1,43 @@
 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 declare function isClubPlayerResponse(data: unknown): data is {
+export declare const isClubConfigResponse: (data: unknown) => data is ClubGlobalConfig;
+export declare const isClubPlayer: (data: unknown) => data is ClubPlayer;
+export declare const isClubPlayerResponse: (data: unknown) => data is {
     player: ClubPlayer;
 };
 export type VerifyLinkSecondaryPlayerOtpResponse = ServerBaseInfo & RoleBaseInfo;
-export declare function isGetRolesResponse(data: unknown): data is {
+export declare const isPlayerRole: (data: unknown) => data is PlayerRole;
+export declare const isGetRolesResponse: (data: unknown) => data is {
     roles: PlayerRole[];
 };
-export declare function isRoleCardResponse(data: unknown): data is {
+export declare const isPlayerRoleCard: (data: unknown) => data is PlayerRoleCard;
+export declare const isRoleCardResponse: (data: unknown) => data is {
     role_card: PlayerRoleCard;
 };
-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 {
+export declare const isUserProfile: (data: unknown) => data is ClubUserProfile;
+export declare const isClubAddress: (data: unknown) => data is ClubAddress;
+export declare const isGetAddressesResponse: (data: unknown) => data is {
     addresses: ClubAddress[];
 };
-export declare function isUserCredit(data: unknown): data is ClubUserCredit;
-export interface CreditLogListWithToken {
-    /** 用户积分变动记录 */
+export declare const isUserCredit: (data: unknown) => data is ClubUserCredit;
+export declare const isCreditLog: (data: unknown) => data is ClubCreditLog;
+export declare const isCreditLogListWithToken: (data: unknown) => data is {
     credit_logs: ClubCreditLog[];
-    /** 下一页的 token，用于 cursor 分页机制，若无值，则表示没有更多数据了 */
-    next_token?: string;
-}
-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 {
+    next_token: string | undefined;
+};
+export declare const isClubProduct: (data: unknown) => data is ClubProduct;
+export declare const isGetProductsResponse: (data: unknown) => data is {
+    products: ClubProduct[];
+};
+export declare const isBenefitSummary: (data: unknown) => data is ClubBenefitSummary;
+export declare const isGetBenefitsResponse: (data: unknown) => data is {
     benefits: ClubBenefitSummary[];
 };
-export declare function isGetBenefitResponse(data: unknown): data is {
+export declare const isBenefit: (data: unknown) => data is ClubBenefit;
+export declare const isGetBenefitResponse: (data: unknown) => data is {
     benefit: ClubBenefit;
 };
-export declare function isClubProduct(data: unknown): data is ClubProduct;
-export declare function isGetProductsResponse(data: unknown): data is {
-    products: ClubProduct[];
-};
-export interface RedemptionListWithToken {
-    /** 兑换记录列表 */
+export declare const isRedemption: (data: unknown) => data is Redemption;
+export declare const isRedemptionListWithToken: (data: unknown) => data is {
     redemptions: Redemption[];
-    /** 下一页的 token，用于 cursor 分页机制，若无值，则表示没有更多数据了 */
-    next_token?: string;
-}
-export declare function isRedemptionListWithToken(data: unknown): data is RedemptionListWithToken;
+    next_token: string | undefined;
+};

package/types/src/community.d.ts

@@ -56,7 +56,10 @@ export declare class CommunityApi {
          * - post_like 帖子点赞数排序
          */
         sort_key?: "post_time_desc" | "post_like";
-    }): Promise<import("./community.guards").PostListWithToken | {
+    }): Promise<{
+        posts: import("./community.define").Post[];
+        next_token: string | undefined;
+    } | {
         error: RequestInteralError | "forum_not_found" | "topic_not_found";
     }>;
     /**
@@ -64,7 +67,10 @@ export declare class CommunityApi {
      *
      * https://kdocs.cn/l/cbggfJodHLIz?linkname=yXubbZuDlC
      */
-    getPinnedPosts(forumId: number, maxResults: number, nextToken?: string): Promise<import("./community.guards").PostListWithToken | {
+    getPinnedPosts(forumId: number, maxResults: number, nextToken?: string): Promise<{
+        posts: import("./community.define").Post[];
+        next_token: string | undefined;
+    } | {
         error: RequestInteralError | "forum_not_found";
     }>;
     /**
@@ -87,8 +93,8 @@ export declare class CommunityApi {
         image_urls?: string[];
         topic_ids?: number[];
     }): Promise<{
-        post?: import("./community.define").Post;
-        antispam?: import("./community.define").Antispam;
+        post: import("./community.define").Post | undefined;
+        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";
     }>;
@@ -106,7 +112,10 @@ export declare class CommunityApi {
         max_results: number;
         /** 分页token */
         next_token?: string;
-    }): Promise<import("./community.guards").CommentListWithToken | {
+    }): Promise<{
+        comments: import("./community.define").Comment[];
+        next_token: string | undefined;
+    } | {
         error: RequestInteralError | "post_not_found" | "post_deleted";
     }>;
     /**
@@ -130,8 +139,8 @@ export declare class CommunityApi {
         /** 评论内容图片地址 */
         image_url?: string;
     }): Promise<{
-        comment?: import("./community.define").Comment;
-        antispam?: import("./community.define").Antispam;
+        comment: import("./community.define").Comment | undefined;
+        antispam: import("./community.define").Antispam | undefined;
     } | {
         error: RequestInteralError | "moderation_check_text_error" | "moderation_check_image_error" | "unknown_moderation_suggestion" | "invalid_content_length" | "forum_disabled" | "post_not_found" | "post_already_deleted";
     }>;
@@ -149,7 +158,12 @@ export declare class CommunityApi {
         query_value: string;
         /** 分页标识，不传默认首次查询 */
         next_token?: string;
-    }): Promise<import("./community.guards").ReplyListWithToken>;
+    }): Promise<{
+        replies: import("./community.define").Reply[];
+        next_token: string | undefined;
+    } | {
+        replies: never[];
+    }>;
     /**
      * 根据回复 id 获取回复详情
      *
@@ -216,11 +230,7 @@ export declare class CommunityApi {
         filename: string;
         /** 资源文件内容的 SHA-256 哈希值，用于校验上传对象的完整性 */
         content_sha256: string;
-    }): Promise<{
-        image_url: string;
-        upload_url: string;
-        existed: boolean;
-    } | null>;
+    }): Promise<import("./community.define").PresignUrlResponse | null>;
     /**
      * 获取用户社区通知
      *
@@ -237,7 +247,9 @@ export declare class CommunityApi {
         next_token?: string;
     }): Promise<{
         notifications: import("./community.define").Notification[];
-        next_token?: string;
+        next_token: string | undefined;
+    } | {
+        notifications: never[];
     }>;
     /**
      * 获取用户未读通知数量

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

@@ -135,7 +135,7 @@ export interface Reply {
     /** 点赞数量 */
     like_num: number;
     /** 当前用户是否点赞 */
-    liked: number;
+    liked: boolean;
     /** 回复的目标 */
     reply_to: ReplyTo;
     /** 回复发布时间 */
@@ -153,6 +153,14 @@ export interface ReplyTo {
     /** 回复者的头像 */
     avatar_url: string;
 }
+export interface PresignUrlResponse {
+    /** 资源文件的真实地址 */
+    image_url: string;
+    /** 媒体文件临时上传地址（有效期 5min） */
+    upload_url: string;
+    /** 媒体文件是否已存在，已存在无需上传 */
+    existed: boolean;
+}
 export interface NotificationBase {
     /** 通知的 ID */
     notification_id: string;
@@ -197,12 +205,6 @@ export interface NotificationPaylodReply {
     /** 回复内容 */
     reply_content: string;
 }
-export interface NotificationPaylodReplyToReply {
-    /** 回复的回复 ID */
-    reply_to_reply_id: number;
-    /** 回复的回复内容 */
-    reply_to_reply_content: string;
-}
 export interface NotificationSystem extends NotificationBase, NotificationPaylodSystem {
     notification_type: NotificationType.System;
 }
@@ -218,10 +220,14 @@ export interface NotificationCommentReply extends NotificationBase, Notification
 export interface NotificationComment extends NotificationBase, NotificationPaylodComment, NotificationPaylodPost {
     notification_type: NotificationType.CommentLiked | NotificationType.CommentDeleted;
 }
-export interface NotificationReplyReplied extends NotificationBase, NotificationPaylodReply, NotificationPaylodReplyToReply {
+export interface NotificationReplyReplied extends NotificationBase, NotificationPaylodReply {
     notification_type: NotificationType.ReplyReplied;
     /** 评论 ID */
     comment_id: number;
+    /** 回复的回复 ID */
+    reply_to_reply_id: number;
+    /** 回复的回复内容 */
+    reply_to_reply_content: string;
 }
 export interface NotificationReply extends NotificationBase, NotificationPaylodReply, NotificationPaylodComment {
     notification_type: NotificationType.ReplyLiked | NotificationType.ReplyDeleted;

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

@@ -5,6 +5,7 @@ export declare const enum ForumMode {
     /** 指定用户可发帖 */
     Limit = "limit"
 }
+export declare const ForumModeValidator: import("@seayoo-web/utils").StringValidator<ForumMode, false, false>;
 /** 社区帖子状态 */
 export declare const enum PostStatus {
     /** 待审核（仅自己可见） */
@@ -16,6 +17,7 @@ export declare const enum PostStatus {
     /** 嫌疑（仅自己可见） */
     Suspect = "suspect"
 }
+export declare const PostStatusValidator: import("@seayoo-web/utils").StringValidator<PostStatus, false, false>;
 /** 社区通知分类 */
 export declare const enum NotificationCategory {
     /** 系统通知 */
@@ -25,6 +27,7 @@ export declare const enum NotificationCategory {
     /** 点赞通知 */
     Like = "like"
 }
+export declare const NotificationCategoryValidator: import("@seayoo-web/utils").StringValidator<NotificationCategory, false, false>;
 /** 社区通知类型 */
 export declare const enum NotificationType {
     /** 系统通知 */
@@ -52,3 +55,4 @@ export declare const enum NotificationType {
     /** 回复被删除 */
     ReplyDeleted = "reply_deleted"
 }
+export declare const NotificationTypeValidator: import("@seayoo-web/utils").StringValidator<NotificationType, false, false>;

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

@@ -1,73 +1,60 @@
-import type { Antispam, Forum, Post, Topic, Comment, Reply, Notification } from "./community.define";
-export declare function isGetForumsResponse(data: unknown): data is {
+import type { Antispam, Forum, Post, Topic, Comment, Reply, ReplyTo, Notification, PresignUrlResponse } from "./community.define";
+export declare const isForum: (data: unknown) => data is Forum;
+export declare const isGetForumsResponse: (data: unknown) => data is {
     forums: Forum[];
 };
-export declare function isGetTopicsResponse(data: unknown): data is {
+export declare const isTopic: (data: unknown) => data is Topic;
+export declare const isGetTopicsResponse: (data: unknown) => data is {
     topics: Topic[];
 };
-export declare function isGetTopicResponse(data: unknown): data is {
+export declare const isGetTopicResponse: (data: unknown) => data is {
     topic: Topic;
 };
-export interface PostListWithToken {
+export declare const isPost: (data: unknown) => data is Post;
+export declare const isGetPostsResponse: (data: unknown) => data is {
     posts: Post[];
-    next_token: string;
-}
-export declare function isGetPostsResponse(data: unknown): data is PostListWithToken;
-export declare function isGetPostResponse(data: unknown): data is {
-    post: Post;
-};
-export declare function isCreatePostResponse(data: unknown): data is {
-    /** 帖子信息 */
-    post?: Post;
-    /** 安全检测信息 */
-    antispam?: Antispam;
+    next_token: string | undefined;
 };
-export declare function isCommentResponse(data: unknown): data is {
-    comment: Comment;
+export declare const isGetPostResponse: (data: unknown) => data is {
+    post: Post;
 };
-export interface CommentListWithToken {
-    comments: Comment[];
-    next_token?: string;
-}
-export declare function isCommentListResponse(data: unknown): data is CommentListWithToken;
-export declare function isCreateCommentResponse(data: unknown): data is {
-    /** 评论 */
-    comment?: Comment;
-    /** 安全检测信息 */
-    antispam?: Antispam;
+export declare const isAntispam: (data: unknown) => data is Antispam;
+export declare const isCreatePostResponse: (data: unknown) => data is {
+    post: Post | undefined;
+    antispam: Antispam;
 };
-export interface ReplyListWithToken {
+export declare const isReplyTo: (data: unknown) => data is ReplyTo;
+export declare const isReply: (data: unknown) => data is Reply;
+export declare const isRelyListResponse: (data: unknown) => data is {
     replies: Reply[];
-    next_token?: string;
-}
-export declare function isRelyListResponse(data: unknown): data is ReplyListWithToken;
-export declare function isRelyResponse(data: unknown): data is {
+    next_token: string | undefined;
+};
+export declare const isRelyResponse: (data: unknown) => data is {
     reply: Reply;
 };
 export declare function isCreateReplyResponse(data: unknown): data is {
     reply?: Reply;
     antispam?: Antispam;
 };
-export declare function isGetPresignUrlResponse(data: unknown): data is {
-    /** 资源文件的真实地址 */
-    image_url: string;
-    /** 媒体文件临时上传地址（有效期 5min） */
-    upload_url: string;
-    /** 媒体文件是否已存在，已存在无需上传 */
-    existed: boolean;
+export declare const isComment: (data: unknown) => data is Comment;
+export declare const isCommentResponse: (data: unknown) => data is {
+    comment: Comment;
+};
+export declare const isCommentListResponse: (data: unknown) => data is {
+    comments: Comment[];
+    next_token: string | undefined;
+};
+export declare const isCreateCommentResponse: (data: unknown) => data is {
+    comment: Comment | undefined;
+    antispam: Antispam | undefined;
 };
-export declare function isNotification(data: unknown): data is Notification;
-export declare function isNotificationListWithToken(data: unknown): data is {
-    /** 通知列表 */
+export declare const isGetPresignUrlResponse: (data: unknown) => data is PresignUrlResponse;
+export declare const isNotificationListWithToken: (data: unknown) => data is {
     notifications: Notification[];
-    /** 分页标识，返回空表示后续没有数据了 */
-    next_token?: string;
+    next_token: string | undefined;
 };
-export declare function isUnreadNotificationsCountResponse(data: unknown): data is {
-    /** 系统通知未读数量 */
+export declare const isUnreadNotificationsCountResponse: (data: unknown) => data is {
     system: number;
-    /** 评论我的通知未读数量 */
     comment: number;
-    /** 收到的赞通知未读数量 */
     like: number;
 };

package/types/src/event.config.d.ts

@@ -14,7 +14,7 @@ export interface EventConfig {
     features: EventFeatureConfig[];
 }
 export declare function isEventConfig(data: unknown): data is EventConfig;
-export type EventFeatureConfig = EventFeatureBaseConfig<FeatureType.Preregister, NoopFeatureConfig> | EventFeatureBaseConfig<FeatureType.Lottery, FeatureLotteryConfig> | EventFeatureBaseConfig<FeatureType.Survey, FeatureSurveyConfig> | EventFeatureBaseConfig<FeatureType.Invite, FeatureInviteConfig> | EventFeatureBaseConfig<FeatureType.Share, FeatureShareConfig> | EventFeatureBaseConfig<FeatureType.Follow, FeatureFollowConfig> | EventFeatureBaseConfig<FeatureType.Subscribe, FeatureSubscribeConfig> | EventFeatureBaseConfig<FeatureType.Comment, FeatureCommentConfig> | EventFeatureBaseConfig<FeatureType.Vote, FeatureVoteConfig> | EventFeatureBaseConfig<FeatureType.Cashback, FeatureCashbackConfig> | EventFeatureBaseConfig<FeatureType.GiftCode, FeatureGiftCodeConfig> | EventFeatureBaseConfig<FeatureType.Register, NoopFeatureConfig> | EventFeatureBaseConfig<FeatureType.InvitedRegister, NoopFeatureConfig> | EventFeatureBaseConfig<FeatureType.ClaimRewards, NoopFeatureConfig> | EventFeatureBaseConfig<FeatureType.Quest, FeatureQuestConfig> | EventFeatureBaseConfig<FeatureType.Team, FeatureTeamConfig> | EventFeatureBaseConfig<FeatureType.LotteryDraw, FeatureLotteryDrawConfig>;
+export type EventFeatureConfig = EventFeatureBaseConfig<FeatureType.Preregister, NoopFeatureConfig> | EventFeatureBaseConfig<FeatureType.Lottery, FeatureLotteryConfig> | EventFeatureBaseConfig<FeatureType.Survey, FeatureSurveyConfig> | EventFeatureBaseConfig<FeatureType.Invite, FeatureInviteConfig> | EventFeatureBaseConfig<FeatureType.Share, FeatureShareConfig> | EventFeatureBaseConfig<FeatureType.Follow, FeatureFollowConfig> | EventFeatureBaseConfig<FeatureType.Subscribe, FeatureSubscribeConfig> | EventFeatureBaseConfig<FeatureType.Comment, FeatureCommentConfig> | EventFeatureBaseConfig<FeatureType.Vote, FeatureVoteConfig> | EventFeatureBaseConfig<FeatureType.Cashback, FeatureCashbackConfig> | EventFeatureBaseConfig<FeatureType.GiftCode, FeatureGiftCodeConfig> | EventFeatureBaseConfig<FeatureType.Register, NoopFeatureConfig> | EventFeatureBaseConfig<FeatureType.InvitedRegister, NoopFeatureConfig> | EventFeatureBaseConfig<FeatureType.ClaimRewards, NoopFeatureConfig> | EventFeatureBaseConfig<FeatureType.Quest, FeatureQuestConfig> | EventFeatureBaseConfig<FeatureType.Team, FeatureTeamConfig> | EventFeatureBaseConfig<FeatureType.LotteryDraw, FeatureLotteryDrawConfig> | EventFeatureBaseConfig<FeatureType.CheckIn, NoopFeatureConfig>;
 export interface EventRewardItemConfig {
     /** 玩法奖励道具 id */
     reward_item_id: number;

package/types/src/event.d.ts

@@ -133,7 +133,7 @@ export declare class EventApi {
         engagement_id: number;
         /** 产生奖励的来源 */
         reward_source: RewardSoure;
-        server_id?: string;
+        server_id?: number;
         role_id?: string;
         role_name?: string;
     }): Promise<import("./event.define").ClaimedItem[] | {

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

@@ -64,7 +64,9 @@ export declare const enum FeatureType {
     /** 组队 */
     Team = "team",
     /** 开奖 */
-    LotteryDraw = "lottery_draw"
+    LotteryDraw = "lottery_draw",
+    /** 签到 */
+    CheckIn = "check_in"
 }
 /** 任务玩法的目标类型 */
 export declare const enum QuestObjective {