@seayoo-web/gamer-api 1.0.0 → 1.0.3

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

@@ -0,0 +1,73 @@
+import type { Antispam, Forum, Post, Topic, Comment, Reply, Notification } from "./community.define";
+export declare function isGetForumsResponse(data: unknown): data is {
+    forums: Forum[];
+};
+export declare function isGetTopicsResponse(data: unknown): data is {
+    topics: Topic[];
+};
+export declare function isGetTopicResponse(data: unknown): data is {
+    topic: Topic;
+};
+export interface PostListWithToken {
+    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;
+};
+export declare function isCommentResponse(data: unknown): data is {
+    comment: Comment;
+};
+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 interface ReplyListWithToken {
+    replies: Reply[];
+    next_token?: string;
+}
+export declare function isRelyListResponse(data: unknown): data is ReplyListWithToken;
+export declare function 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 function isNotification(data: unknown): data is Notification;
+export declare function isNotificationListWithToken(data: unknown): data is {
+    /** 通知列表 */
+    notifications: Notification[];
+    /** 分页标识，返回空表示后续没有数据了 */
+    next_token?: string;
+};
+export declare function isUnreadNotificationsCountResponse(data: unknown): data is {
+    /** 系统通知未读数量 */
+    system: number;
+    /** 评论我的通知未读数量 */
+    comment: number;
+    /** 收到的赞通知未读数量 */
+    like: number;
+};

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

@@ -1,6 +1,4 @@
-export type EGameItemType = "event_item" | "game_item" | "physical_item" | "weixin_hongbao" | "gift_code" | "lottery_ticket" | "void_item";
-export type EFeatureType = "preregister" | "lottery" | "survey" | "invite" | "share" | "follow" | "weixin_subscribe" | "comment" | "vote" | "cashback" | "gift_code" | "register" | "invited_register" | "claim_rewards" | "quest" | "team" | "lottery_draw";
-export type EQuestObjective = "player_active_points" | "player_login_days" | "order_total_amount" | "community_posts" | "community_comments";
+import { type GamerItemType, EngageAccountType, EventPeriodType, FeatureType, QuestObjective, VoteOptionSource } from "./event.enums";
 export interface EventConfig {
     /** 活动名称 */
     event_name: string;
@@ -16,7 +14,7 @@ export interface EventConfig {
     features: EventFeatureConfig[];
 }
 export declare function isEventConfig(data: unknown): data is EventConfig;
-type EventFeatureConfig = EventFeatureBaseConfig<"preregister", NoopFeatureConfig> | EventFeatureBaseConfig<"lottery", FeatureLotteryConfig> | EventFeatureBaseConfig<"survey", FeatureSurveyConfig> | EventFeatureBaseConfig<"invite", FeatureInviteConfig> | EventFeatureBaseConfig<"share", FeatureShareConfig> | EventFeatureBaseConfig<"follow", FeatureFollowConfig> | EventFeatureBaseConfig<"weixin_subscribe", FeatureSubscribeConfig> | EventFeatureBaseConfig<"comment", FeatureCommentConfig> | EventFeatureBaseConfig<"vote", FeatureVoteConfig> | EventFeatureBaseConfig<"cashback", FeatureCashbackConfig> | EventFeatureBaseConfig<"gift_code", FeatureGiftCodeConfig> | EventFeatureBaseConfig<"register", NoopFeatureConfig> | EventFeatureBaseConfig<"invited_register", NoopFeatureConfig> | EventFeatureBaseConfig<"claim_rewards", NoopFeatureConfig> | EventFeatureBaseConfig<"quest", FeatureQuestConfig> | EventFeatureBaseConfig<"team", FeatureTeamConfig> | EventFeatureBaseConfig<"lottery_draw", FeatureLotteryDrawConfig>;
+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>;
 interface EventRewardItemConfig {
     /** 玩法奖励道具 id */
     reward_item_id: number;
@@ -29,7 +27,7 @@ interface EventRewardItemConfig {
     /** 玩法奖励道具描述 */
     reward_item_desc?: string;
     /** 玩法奖励道具类型  */
-    reward_item_type: EGameItemType;
+    reward_item_type: Exclude<GamerItemType, GamerItemType.GiftCode | GamerItemType.LotteryTicket>;
 }
 type FeatureReward = {
     feature_reward_type: "every";
@@ -42,7 +40,7 @@ type FeatureReward = {
     }[];
 };
 export type NoopFeatureConfig = {} | null;
-interface EventFeatureBaseConfig<T extends EFeatureType = EFeatureType, C extends object | null = object> {
+interface EventFeatureBaseConfig<T extends FeatureType = FeatureType, C extends object | null = object> {
     /** 玩法名称 */
     feature_name: string;
     /** 玩法 Id */
@@ -54,15 +52,15 @@ interface EventFeatureBaseConfig<T extends EFeatureType = EFeatureType, C extend
     /** 玩法配置 */
     config: C;
     /** 玩法周期，即每多长时间可参与一次 */
-    cycle: "none" | "daily" | "weekly" | "monthly";
+    cycle: EventPeriodType;
     /** 允许的最大参与次数 */
     limit: number;
     /** 玩法开始时间 */
     since: number;
     /** 玩法结束时间 */
     until: number;
-    /** 参与玩法维度账号类型 user_id（世游通行证 ID / Combo ID） 或 role_id（游戏角色 ID） */
-    engage_account_type: "user_id" | "role_id";
+    /** 参与玩法维度账号类型 */
+    engage_account_type: EngageAccountType;
     /** 玩法参与奖励 */
     feature_rewards: FeatureReward;
 }
@@ -72,7 +70,7 @@ interface FeatureLotteryItemConfig {
     /** 抽奖奖励道具名称 */
     reward_item_name: string;
     /** 抽奖奖励道具类型   */
-    reward_item_type: Exclude<EGameItemType, "gift_code" | "lottery_ticket">;
+    reward_item_type: Exclude<GamerItemType, GamerItemType.GiftCode | GamerItemType.LotteryTicket>;
     /** 抽奖奖励道具图片地址 */
     reward_item_icon_url: string;
     /** 抽奖奖励道具描述 */
@@ -148,7 +146,7 @@ interface FeatureVoteConfig {
     /** 入围数量 */
     finalists_amount: number;
     /** 选项来源 */
-    source: "system" | "user_submission" | "shortlisted";
+    source: VoteOptionSource;
     /** 投票选项配置 */
     options: FeatureVoteOption[];
     /** 投票入围后用户可获得的奖励 */
@@ -202,7 +200,7 @@ interface EventGiftItemConfig {
 }
 interface FeatureQuestConfig {
     /** 任务目标 */
-    objective: EQuestObjective;
+    objective: QuestObjective;
     /** 目标值 */
     completion_value: number;
     /** 团队任务配置 */

package/types/src/event.d.ts

@@ -1,27 +1,28 @@
-import type { AutoLoginHandler } from "./utils";
-import type { NetRequestFactory } from "@seayoo-web/request";
+import type { EngagementInfo } from "./event.define";
+import type { GamerItemType, RewardSoure } from "./event.enums";
+import type { AuthToken } from "./token";
+import type { RequestInteralError } from "@seayoo-web/request";
+export type { EventConfig } from "./event.config";
+export * from "./event.define";
+export * from "./event.enums";
 /** EventApi */
 export declare class EventApi {
-    private req;
-    private autoLogin;
+    private token;
     private event;
+    private req;
+    constructor(authToken: AuthToken, eventId: number);
     /**
-     * 创建 EventApi 实例
+     * 根据手机号白名单，检查手机号是否允许登录某个游戏
      *
-     * @param baseRequest - Gamer 通用的 request 工具实例，baseUrl 仅仅包含 endpoint + version
-     * @param autoLogin - 自动登录函数，由上层组件提供
-     */
-    constructor(baseRequest: ReturnType<NetRequestFactory>, autoLogin: AutoLoginHandler);
-    /**
-     * 设置 Event Id，以供后续 api 请求中使用
+     * https://kdocs.cn/l/cf2mO2uRLqh9?linkname=OWGSPF3Ysl
      */
-    setEventId(event: number): this;
+    verifyMobileAllowed(mobile: string): Promise<import("./event.define").VerifyMobileResult | null>;
     /**
      * 获取运营活动的基础配置信息
      *
      * https://kdocs.cn/l/ckWFDcOsYEUA?linkname=wFXxtdNKPm
      */
-    getEventConfig(): Promise<import("./event.config").EventConfig | null>;
+    getConfig(): Promise<import("./event.config").EventConfig | null>;
     /**
      * 获取某个玩法参与用户数量
      *
@@ -39,13 +40,13 @@ export declare class EventApi {
      *
      * https://kdocs.cn/l/ckWFDcOsYEUA?linkname=THtZ4ewIQW
      */
-    getEngagements(featureId: number): Promise<import("./event.other").CommentEngagement[] | import("./event.other").TeamEngagement[]>;
+    getEngagements(featureId: number): Promise<import("./event.define").CommentEngagement[] | import("./event.define").TeamEngagement[]>;
     /**
-     * 用户访问某个活动，需要先设置 idToken / weixinToken，返回是否
+     * 用户访问某个活动或玩法
      *
      * https://kdocs.cn/l/ckWFDcOsYEUA?linkname=DWtJrnrBCn
      */
-    userVisit(option?: {
+    visit(option?: {
         feature_id?: number;
         server_id?: string;
         role_id?: string;
@@ -55,19 +56,86 @@ export declare class EventApi {
         invited_by?: string;
     }): Promise<{
         first_visit: boolean;
-    } | null>;
+    } | {
+        error: RequestInteralError | "event_not_found" | "feature_not_found" | "invalid_server_id" | "invalid_role_id";
+    }>;
     /**
      * 获取用户在目标活动下的所有玩法的参与状态，用于前端进一步确定如何执行交互逻辑
      *
+     * 💡活动下包含 engage_account_type 为 role_id 的玩法时，前端需要提供 server_id 和 role_id
+     *
      * https://kdocs.cn/l/ckWFDcOsYEUA?linkname=WzX5BrMNpL
      */
-    getUserFeatureStatus(serverId?: string, roleId?: string): Promise<import("./event.other").UserFeatureStatus[]>;
+    getUserFeatureStatus(option?: {
+        server_id: string;
+        role_id: string;
+    }): Promise<import("./event.define").UserFeatureStatus[]>;
     /**
      * 获取当前登录用户参与某个玩法的记录
      *
      * https://kdocs.cn/l/ckWFDcOsYEUA?linkname=WSbAeDZc8F
      */
-    getUserEngagements(featureId: number): Promise<import("./event.other").UserEngagement[]>;
+    getUserEngagements(featureId: number): Promise<import("./event.define").UserEngagement[]>;
+    /**
+     * 用户参与某个玩法（需要先调用 visit 接口）
+     *
+     * https://kdocs.cn/l/ckWFDcOsYEUA?linkname=vuOyrcry3S
+     */
+    engage(option: {
+        /** 活动玩法 ID */
+        feature_id: number;
+        /** 用户参数数据 */
+        engagement: EngagementInfo;
+        /**
+         * 联的游戏账号 ID，如果传该参数后端需验证 player_id 是否从属于当前用户。
+         *
+         * 参考 club 模块的 getPlayers 方法
+         */
+        player_id?: string;
+        server_id?: string;
+        server_name?: string;
+        role_id?: string;
+        role_name?: string;
+    }): Promise<import("./event.define").EngageResponse | {
+        error: RequestInteralError | "event_not_found" | "feature_not_found" | "invalid_weixin_appid" | "invalid_weixin_openid" | "event_not_started" | "event_already_ended" | "engage_feature_reached_limit" | "comment_too_frequently" | "lottery_reward_is_empty" | "invalid_merchant_parameter" | "budget_not_enough" | "combo_id_not_found" | "query_user_order_total_amount_err" | "unique_gift_code_is_empty" | "player_created_at_out_of_range" | "user_had_joined_a_team" | "team_is_full" | "disband_team_not_allowed" | "change_team_visibility_not_allowed" | "team_not_found" | "join_team_conflict" | "team_has_been_disbanded" | "exceeded_assembled_team_limit" | "invalid_engage_lottery_draw_ticket" | "lottery_ticket_not_found" | "draw_lottery_ticket_not_start" | "draw_lottery_ticket_is_ended";
+    }>;
+    /**
+     * 用户领取除红包和实物奖励以外的所有奖励
+     *
+     * https://kdocs.cn/l/ckWFDcOsYEUA?linkname=lCGuqgvUDP
+     */
+    claimRewards(option: {
+        /** 用户参与记录 ID */
+        engagement_id: number;
+        /** 产生奖励的来源 */
+        reward_source: RewardSoure;
+        server_id?: string;
+        role_id?: string;
+        role_name?: string;
+    }): Promise<import("./event.define").ClaimedItem[] | {
+        error: RequestInteralError | "invalid_server_id" | "invalid_role_id" | "event_not_found" | "engagement_not_found" | "event_not_started" | "event_already_ended" | "claim_rewards_not_started" | "claim_rewards_already_ended" | "no_rewards_to_claim" | "reward_received" | "claim_reward_error";
+    }>;
+    /**
+     * 用户领取红包奖励
+     *
+     * https://kdocs.cn/l/ckWFDcOsYEUA?linkname=aQLhlOAB4Q
+     */
+    claimWeixinHongbao(rewardId: number): Promise<{
+        reward_status: import("./event.enums").CliamRewardStatus;
+    } | {
+        error: RequestInteralError | "invalid_weixin_openid" | "event_not_started" | "event_already_ended" | "no_rewards_to_claim" | "reward_received" | "invalid_merchant_parameter" | "budget_not_enough";
+    }>;
+    /**
+     * 查询用户活动奖励列表
+     *
+     * https://kdocs.cn/l/ckWFDcOsYEUA?linkname=qj12eIgYQG
+     */
+    getUserRewards(option: {
+        /** 活动玩法 ID */
+        feature_id?: number;
+        /** 奖励类型 */
+        reward_types?: Exclude<GamerItemType, GamerItemType.VoidItem>[];
+    }): Promise<import("./event.define").UserReward[]>;
     /**
      * 查询用户活动道具数量。注意，这里只能是活动道具
      *
@@ -80,15 +148,21 @@ export declare class EventApi {
      * https://kdocs.cn/l/ckWFDcOsYEUA?linkname=QIwGhnaexb
      */
     submitUserRewardAddress(option: {
+        /** 用户奖励记录 id */
         reward_id: number;
         /** ⚠️ 用户收货地址 id，后续会删除 */
         address_id?: number;
-        /** 收件人昵称 */
+        /** 收件人称呼 */
         recipient: string;
+        /** 收件人手机号 */
         mobile: string;
+        /** 收件地址所在省 */
         province: string;
+        /** 收件地址所在市 */
         city: string;
+        /** 收件地址所在街道 */
         district: string;
+        /** 详细收货地址 */
         address: string;
     }): Promise<boolean | null>;
     /**
@@ -108,7 +182,7 @@ export declare class EventApi {
      */
     getParamsByQrcodeScene(scene: string): Promise<string | null>;
     /**
-     * 生成不限制的带参数的小程序码
+     * 生成不限制的带参数的小程序码（data URI格式的小程序码）
      *
      * https://kdocs.cn/l/ckWFDcOsYEUA?linkname=Rvmoq8iIy0
      */

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

@@ -0,0 +1,295 @@
+import type { CliamRewardStatus, FeatureType, GamerItemType, LotteryDrawAction, LotteryTicketStatus, QuestObjective, RewardSoure, RewardStatusPrefix, RewardStatusSuffix, TeamAction, TeamVisibility } from "./event.enums";
+export interface VerifyMobileResult {
+    /** 手机号是否允许登录此游戏（游戏 ID 由 Request Header 的 Origin 或 Referer 决定） */
+    allowed: boolean;
+    /** 手机号是否已注册世游通行证 */
+    registered: boolean;
+}
+export interface CommentEngagement {
+    /** 用户世游通行证 ID */
+    user_id: string;
+    /** 用户昵称 */
+    name: string;
+    /** 用户头像地址 */
+    avatar_url: string;
+    /** 评论信息 */
+    comment: string;
+    /** 用户发布弹幕的视频点 */
+    video_note: number;
+    /** 用户发布弹幕的时间 */
+    created_at: number;
+}
+export interface TeamEngagement {
+    /** 组队码 */
+    team_code: string;
+    /** 队长角色名称 */
+    leader_name: string;
+    /** 队员数量 */
+    total_members: number;
+}
+export interface UserFeatureStatus {
+    /** 玩法 ID */
+    feature_id: number;
+    /**
+     * 是否可参与玩法。false 代表当前已不可再参与。
+     *
+     * 💡注意这里的语义是已经达到了参与次数的上限，不能再调用 engage，而不是没有资格参与。
+     */
+    can_engage: boolean;
+    /** 是否有已获得但尚未领取的玩法参与奖励 */
+    has_unclaimed_rewards: boolean;
+}
+export interface UserEngagement {
+    /** 参与记录 ID */
+    engagement_id: number;
+    /** 玩法参与次数 */
+    sequence: number;
+    /** 玩法 ID */
+    feature_id: number;
+    /** 奖励 ID */
+    reward_id: number;
+    /** 奖励状态 */
+    reward_status: RewardStatusPrefix;
+    /** 奖励来源 */
+    reward_source: RewardSoure;
+    /** 附带的数据，由 feature_id 的类型决定 */
+    data?: PreregisterEngagementData | LotteryEngagementData | SurveyEngagementData | InviteEngagementData | ShareEngagementData | VoteEngagementData | WeixinSubscribeEngagementData | CashbackEngagementData | GiftCodeEngagementData | TeamEngagementData | QuestEngagementData | LotteryDrawEngagementData;
+    server_id?: string;
+    role_id?: string;
+    created_at: number;
+}
+export interface PreregisterEngagementData {
+    /** 用户预约平台 */
+    platforms: string[];
+}
+export interface LotteryEngagementData {
+    /** 用户抽奖次数 */
+    lottery_count: number;
+}
+export interface SurveyEngagementData {
+    /** 用户填写问卷流水号 */
+    serial_number: number;
+}
+export interface InviteEngagementData {
+    /** 被邀请人的世游通行证 ID */
+    user_id: string;
+    /** 被邀请人昵称 */
+    name?: string;
+    /** 被邀请人头像地址 */
+    avatar_url?: string;
+}
+export interface ShareEngagementData {
+    /** 用户分享到对应的平台 */
+    platform: string;
+}
+export interface VoteEngagementData {
+    /** 用户投票选项 */
+    option_sn: string;
+}
+export interface WeixinSubscribeEngagementData {
+    weixin_openid: string;
+}
+export interface CashbackEngagementData {
+    /** 用户充值订单总金额（分） */
+    order_total_amount: `${number}` | number;
+    /** 充值返还的总金额（分） */
+    cashback_total_amount: `${number}` | number;
+    /** 充值返还的总金额所对应的游戏道具数量 */
+    game_item_count: `${number}` | number;
+}
+export interface GiftCodeEngagementData {
+    /** 礼包码 */
+    gift_code: string;
+}
+export interface TeamEngagementData {
+    /** 组队码 */
+    team_code: string;
+    /** 队伍可见性 */
+    visibility: TeamVisibility;
+    /** 队员信息 */
+    members: {
+        /** 是否为队长 */
+        is_leader: boolean;
+        /** 角色名 */
+        role_name: string;
+        /** 服务器名 */
+        server_name: string;
+    }[];
+}
+export interface QuestEngagementData {
+    /** 任务目标 */
+    objective: QuestObjective;
+    /** 个人任务进度值 */
+    progress: number;
+    /** 个人任务目标值 */
+    completion_value?: number;
+    /** 组队任务进度信息 */
+    team?: {
+        /** 进度值 */
+        progress: number;
+        /** 目标值 */
+        completion_value?: number;
+        /** 队伍信息 */
+        players: {
+            /** 用户 id，含当前用户 */
+            user_id: number;
+            /** 角色名 */
+            role_name: string;
+            /** 是否为队长 */
+            is_leader: boolean;
+            /** 进度值 */
+            progress?: number;
+        }[];
+    };
+}
+export interface LotteryDrawEngagementData {
+    tickets: ({
+        /** 抽奖券 */
+        ticket: string;
+        /** 抽奖券状态 */
+        status: LotteryTicketStatus.Unknown | LotteryTicketStatus.Pending;
+    } | {
+        /** 抽奖券 */
+        ticket: string;
+        /** 抽奖券状态 */
+        status: Exclude<LotteryTicketStatus, LotteryTicketStatus.Unknown | LotteryTicketStatus.Pending>;
+        /** 抽奖券奖励物品，status = drawn 时 reward_id = 0 */
+        reward: UserReward;
+    })[];
+}
+export interface UserReward {
+    /** 用户奖励记录 id */
+    reward_id: number;
+    /** 奖励道具 id */
+    reward_item_id: number;
+    /** 产生奖励的来源 */
+    reward_source: RewardSoure;
+    /** 奖励道具名称 */
+    reward_item_name: string;
+    /** 奖励道具类型  */
+    reward_item_type: GamerItemType;
+    /** 奖励道具图片地址 */
+    reward_item_icon_url: string;
+    /** 奖励道具描述 */
+    reward_item_desc?: string;
+    /** 奖励道具数量 */
+    reward_amount: number;
+    /** 奖励状态 */
+    reward_status: RewardStatusSuffix;
+    /** 活动 ID */
+    event_id: number;
+    /** 活动名称 */
+    event_name: string;
+    /** 活动玩法 ID */
+    feature_id: number;
+    /** 参与记录 ID */
+    engagement_id: number;
+    /** 玩法类型 */
+    feature_type: FeatureType;
+    /** 领奖时间 */
+    receive_time: number;
+    /** 提供额外扩展信息，比如收获地址等 */
+    extra_data?: Record<string, unknown>;
+}
+export type EngagementInfo = PreregisterEngagementInfo | LotteryEngagementInfo | CommentEngagementInfo | ShareEngagementInfo | VoteEngagementInfo | SubscribeEngagementInfo | TeamEngagementInfo | LotteryDrawEngagementInfo;
+export interface PreregisterEngagementInfo {
+    /** 用户预约平台 */
+    platforms: string[];
+}
+export interface LotteryEngagementInfo {
+    /** 用户抽奖次数 */
+    lottery_count: number;
+}
+export interface CommentEngagementInfo {
+    /** 用户发送弹幕内容 */
+    comment: string;
+    /** 用户发布弹幕的视频点 */
+    video_note?: number;
+}
+export interface ShareEngagementInfo {
+    /** 用户分享到对应的平台 */
+    platform: string;
+}
+export interface VoteEngagementInfo {
+    /** 选项的 sn */
+    option_sn: string;
+}
+export interface SubscribeEngagementInfo {
+    /**
+     * 小程序调用 wx.requestSubscribeMessage 并收到 success 回调后，得到的订阅结果。
+     *
+     * - key 为模版 ID
+     *
+     * - value 为订阅结果。示例 accept reject ban filter
+     */
+    subscribe_results: Record<string, string>;
+}
+export type TeamEngagementInfo = {
+    /** 操作类型 */
+    action: TeamAction.ChangeVisibility;
+    /** 组队码 */
+    team_code: string;
+    /** 设置队伍的可见性 */
+    visibility: TeamVisibility;
+} | {
+    /** 操作类型 */
+    action: TeamAction.Assemble;
+    /** 设置队伍的可见性 */
+    visibility?: TeamVisibility;
+} | {
+    action: TeamAction.Join | TeamAction.Disband;
+    /** 组队码 */
+    team_code: string;
+} | {
+    /** 操作类型 */
+    action: TeamAction.Query;
+    /** 组队码 */
+    team_code?: string;
+};
+export type LotteryDrawEngagementInfo = {
+    /** 参与抽奖券的动作类型 */
+    action: Exclude<LotteryDrawAction, LotteryDrawAction.Claim>;
+} | {
+    /** 参与抽奖券的动作类型 */
+    action: LotteryDrawAction.Claim;
+    /** 抽奖券 */
+    ticket: string;
+};
+export interface EngageReward {
+    /** 用户奖励记录 id（微信红包类型奖励需要前端请求一次领奖 api） */
+    reward_id: number;
+    /** 奖励道具 id */
+    reward_item_id: number;
+    /** 奖励道具名称 */
+    reward_item_name: string;
+    /** 奖励道具类型 */
+    reward_item_type: Exclude<GamerItemType, GamerItemType.GiftCode | GamerItemType.LotteryTicket>;
+    /** 奖励道具图片地址 */
+    reward_item_icon_url: string;
+    /** 奖励道具描述 */
+    reward_item_desc?: string;
+    /** 奖励道具数量 */
+    reward_amount: number;
+    /** 奖励状态 */
+    reward_status: RewardStatusSuffix;
+    /** 产生奖励的来源 */
+    reward_source: RewardSoure;
+    /** 提供额外扩展信息，例如：礼包码的值等 */
+    extra_data?: Record<string, unknown>;
+}
+export interface EngageResponse {
+    /** 当前参与记录 ID */
+    engagement_id: number;
+    /** 用户玩法参与记录 */
+    engagement?: UserEngagement;
+    /** 用户参与玩法得到的奖励 */
+    rewards?: EngageReward[];
+    /** 参与玩法后是否需要微信扫码 */
+    scan?: boolean;
+}
+export interface ClaimedItem {
+    /** 用户奖励记录 id */
+    reward_id: number;
+    /** 领取后的奖励状态 */
+    reward_status: CliamRewardStatus;
+}