@seayoo-web/gamer-api 1.1.18 → 2.0.0

package/types/src/event.d.ts

@@ -1,8 +1,7 @@
-import type { EngagementInfo } from "./event.define";
-import type { GamerItemType, RewardSoure } from "./event.enums";
+import { ClaimRewardStatus, type GamerItemType, type RewardSource } from "./event.enums";
+import type { EngagementFeatureType, InferEngagementParam } from "./event.define";
 import type { AuthToken } from "./token";
-import type { RequestInteralError } from "@seayoo-web/request";
-export * from "./event.config";
+import type { RequestInternalError } from "@seayoo-web/request";
 export * from "./event.define";
 export * from "./event.enums";
 /** EventApi */
@@ -38,9 +37,11 @@ export declare class EventApi {
     /**
      * 获取某个玩法的参与记录（和特定用户无关）
      *
+     * 💡目前仅支持 Comment / Team 两个玩法的参与数据
+     *
      * https://kdocs.cn/l/ckWFDcOsYEUA?linkname=THtZ4ewIQW
      */
-    getEngagements(featureId: number): Promise<import("./event.define").CommentEngagement[] | import("./event.define").TeamEngagement[]>;
+    getEngagements(featureId: number): Promise<import("./event.engage").CommentEngagement[] | import("./event.engage").TeamEngagement[]>;
     /**
      * 用户访问某个活动或玩法
      *
@@ -50,19 +51,18 @@ export declare class EventApi {
         feature_id?: number;
         server_id?: string;
         role_id?: string;
-        /** 来源标识 */
         utm_source?: string;
         /** 邀请人的世游通行证 ID */
         invited_by?: string;
     }): Promise<{
         first_visit: boolean;
     } | {
-        error: RequestInteralError | "event_not_found" | "feature_not_found" | "invalid_server_id" | "invalid_role_id";
+        error: RequestInternalError | "event_not_found" | "feature_not_found" | "invalid_server_id" | "invalid_role_id";
     }>;
     /**
      * 获取用户在目标活动下的所有玩法的参与状态，用于前端进一步确定如何执行交互逻辑
      *
-     * 💡活动下包含 engage_account_type 为 role_id 的玩法时，前端需要提供 server_id 和 role_id
+     * 💡活动下包含 engage_account_type 为 role_id 的玩法时，需要提供 server_id 和 role_id
      *
      * 🔕请求静默进行，无消息提示
      *
@@ -75,21 +75,17 @@ export declare class EventApi {
     /**
      * 获取当前登录用户参与某个玩法的记录
      *
-     * https://kdocs.cn/l/ckWFDcOsYEUA?linkname=WSbAeDZc8F
-     *
-     * @deprecated 请改用 getUserEngagementsV2
-     */
-    getUserEngagements(featureId: number): Promise<import("./event.define").UserEngagement[]>;
-    /**
-     * 获取当前登录用户参与某个玩法的记录
+     * 💡当玩法的 engage_account_type 为 role_id 时，可提供 server_id 和 role_id 获取具体角色的参与记录
      *
      * https://kdocs.cn/l/ckWFDcOsYEUA?linkname=NFDdV1dwWb
      */
-    getUserEngagementsV2(featureId: number, option?: {
-        /** 单页返回的最大数量，默认 10 */
+    getUserEngagements(featureId: number, option?: {
+        /** 单页返回的最大数量，默认 20 */
         max_results?: number;
         next_token?: string;
-        /** 是否返回参与获得的记录，默认 false */
+        /**
+         * 是否返回参与奖记录，默认 false
+         */
         return_rewards?: boolean;
         /**
          * 当玩法的 engage_account_type 为 role_id 时，可提供 server_id 和 role_id 获取具体角色的参与记录
@@ -99,17 +95,20 @@ export declare class EventApi {
          * 当玩法的 engage_account_type 为 role_id 时，可提供 server_id 和 role_id 获取具体角色的参与记录
          */
         role_id?: string;
-    }): Promise<import("./event.define").UserEngagementV2[]>;
+    }): Promise<never[] | {
+        engagements: import("./event.engage").UserEngagement[];
+        next_token: string;
+    }>;
     /**
-     * 用户参与某个玩法（需要先调用 visit 接口）
+     * 用户参与某个玩法
+     *
+     * 💡可以设置泛型参数来快速确定 engagementParam 数据类型
+     *
+     * 💡需要先调用 `visit` 接口提交访问信息
      *
      * https://kdocs.cn/l/ckWFDcOsYEUA?linkname=vuOyrcry3S
      */
-    engage(option: {
-        /** 活动玩法 ID */
-        feature_id: number;
-        /** 用户参数数据 */
-        engagement: EngagementInfo;
+    engage<T extends EngagementFeatureType = unknown>(featureId: number, engagementParam: InferEngagementParam<T>, option?: {
         /**
          * 联的游戏账号 ID，如果传该参数后端需验证 player_id 是否从属于当前用户。
          *
@@ -121,23 +120,26 @@ export declare class EventApi {
         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";
+        error: RequestInternalError | "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: {
+    claimRewards(params: {
         /** 用户参与记录 ID */
         engagement_id: number;
         /** 产生奖励的来源 */
-        reward_source: RewardSoure;
+        reward_source: RewardSource;
+        /** 游戏服务器 ID，领取游戏道具时为必填 */
         server_id?: number;
+        /** 游戏角色 ID，领取游戏道具时为必填 */
         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";
+        error: RequestInternalError | "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";
     }>;
     /**
      * 用户领取红包奖励
@@ -145,9 +147,9 @@ export declare class EventApi {
      * https://kdocs.cn/l/ckWFDcOsYEUA?linkname=aQLhlOAB4Q
      */
     claimWeixinHongbao(rewardId: number): Promise<{
-        reward_status: import("./event.enums").CliamRewardStatus;
+        reward_status: ClaimRewardStatus;
     } | {
-        error: RequestInteralError | "invalid_weixin_openid" | "event_not_started" | "event_already_ended" | "no_rewards_to_claim" | "reward_received" | "invalid_merchant_parameter" | "budget_not_enough";
+        error: RequestInternalError | "invalid_weixin_openid" | "event_not_started" | "event_already_ended" | "no_rewards_to_claim" | "reward_received" | "invalid_merchant_parameter" | "budget_not_enough";
     }>;
     /**
      * 查询用户活动奖励列表
@@ -157,11 +159,17 @@ export declare class EventApi {
     getUserRewards(option: {
         /** 活动玩法 ID */
         feature_id?: number;
-        /** 奖励类型 */
-        reward_types?: Exclude<GamerItemType, GamerItemType.VoidItem>[];
-    }): Promise<import("./event.define").UserReward[]>;
+        /** 奖励类型，不支持传递空奖励 `void_item` */
+        reward_types?: Exclude<GamerItemType, typeof GamerItemType.VoidItem>[];
+        /** 单次查询的数量，默认 20 */
+        max_results?: number;
+        next_token?: string;
+    }): Promise<never[] | {
+        user_rewards: import("./event.engage/reward").UserReward[];
+        next_token: string;
+    }>;
     /**
-     * 查询用户活动道具数量。注意，这里只能是活动道具
+     * 查询用户活动道具数量。💡 注意，这里只能是活动道具
      *
      * https://kdocs.cn/l/ckWFDcOsYEUA?linkname=mnGCTeTgMb
      */
@@ -174,8 +182,8 @@ export declare class EventApi {
     submitUserRewardAddress(option: {
         /** 用户奖励记录 id */
         reward_id: number;
-        /** ⚠️ 用户收货地址 id，后续会删除 */
-        address_id?: number;
+        /** 用户收货地址 id */
+        address_id: number;
         /** 收件人称呼 */
         recipient: string;
         /** 收件人手机号 */
@@ -206,11 +214,12 @@ export declare class EventApi {
      */
     getParamsByQrcodeScene(scene: string): Promise<string | null>;
     /**
-     * 生成不限制的带参数的小程序码（data URI格式的小程序码）
+     * 生成不限制的带参数的小程序码（dataURI 格式的小程序码图片）
      *
      * https://kdocs.cn/l/ckWFDcOsYEUA?linkname=Rvmoq8iIy0
      */
     generateUnlimitQrcode(option: {
+        /** 小程序 appid */
         app_id: string;
         /**
          * 小程序码所携带参数

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

@@ -1,32 +1,15 @@
-import type { CliamRewardStatus, FeatureType, GamerItemType, LotteryDrawAction, LotteryTicketStatus, QuestObjective, RewardSoure, RewardStatusPrefix, RewardStatusSuffix, RewardStatusSuffixV2, TeamAction, TeamVisibility } from "./event.enums";
+import { type UserEngagementData } from "./event.engage";
+import { type EngageReward } from "./event.engage/reward";
+import { type ClaimRewardStatus } from "./event.enums";
+export * from "./event.config";
+export * from "./event.engage";
 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 declare const VerifyMobileResultValidator: import("@seayoo-web/utils").ObjectValidator<VerifyMobileResult, false, false>;
 export interface UserFeatureStatus {
     /** 玩法 ID */
     feature_id: number;
@@ -39,302 +22,30 @@ export interface UserFeatureStatus {
     /** 是否有已获得但尚未领取的玩法参与奖励 */
     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_item_amount: number;
-    /** 道具名称 */
-    reward_item_name: string;
-    /** 道具描述 */
-    reward_item_desc: string;
-    /** 道具图标 */
-    reward_item_icon_url: string;
-    /** 道具评级 */
-    reward_item_rating: number;
-    /** 奖励来源 */
-    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 type UserEngagementV2 = Pick<UserEngagement, "engagement_id" | "feature_id" | "sequence" | "data" | "server_id" | "role_id" | "created_at"> & {
-    user_id: number;
-    /** 参与奖励列表 */
-    rewards?: Reward[];
-};
-export interface Reward {
-    /** 用户奖励记录 id */
-    reward_id: number;
-    /** 奖励道具 id */
-    reward_item_id: number;
-    /** 奖励道具类型  */
-    reward_item_type: GamerItemType;
-    /** 奖励道具数量 */
-    reward_count: number;
-    /** 奖励状态 */
-    reward_status: RewardStatusSuffixV2;
-    /** 奖励来源 */
-    reward_source: RewardSoure;
-    /** 奖励道具名称 */
-    reward_item_name: string;
-    /** 奖励道具图片地址 */
-    reward_item_icon_url: string;
-    /** 奖励道具描述 */
-    reward_item_desc?: string;
-    /** 奖励道具评级，用于前端展示 */
-    reward_item_rating: number;
-    /** 领奖时间 */
-    receive_time: number;
-    /** 提供额外扩展信息，比如收获地址等 */
-    extra_data?: Record<string, unknown>;
-}
-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 | EmptyInfo;
-export type EmptyInfo = Record<string, never>;
-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 declare const UserFeatureStatusValidator: import("@seayoo-web/utils").ObjectValidator<UserFeatureStatus, false, false>;
 export interface EngageResponse {
     /** 当前参与记录 ID */
     engagement_id: number;
-    /** 用户玩法参与记录 */
-    engagement?: UserEngagement;
+    /** 用户玩法参与记录(部分通用数据以兼容新旧版本数据结构) */
+    engagement?: {
+        user_id: string;
+        feature_id: number;
+        sequence: number;
+        server_id: string;
+        role_id: string;
+        /** 附带的数据，由 feature_id 的类型决定 */
+        data?: UserEngagementData;
+    };
     /** 用户参与玩法得到的奖励 */
     rewards?: EngageReward[];
     /** 参与玩法后是否需要微信扫码 */
     scan?: boolean;
 }
+export declare const EngageResponseValidator: import("@seayoo-web/utils").ObjectValidator<EngageResponse, false, false>;
 export interface ClaimedItem {
     /** 用户奖励记录 id */
     reward_id: number;
     /** 领取后的奖励状态 */
-    reward_status: CliamRewardStatus;
+    reward_status: ClaimRewardStatus;
 }
+export declare const ClaimedItemValidator: import("@seayoo-web/utils").ObjectValidator<ClaimedItem, false, false>;

package/types/src/event.engage/engage.cashback.d.ts

@@ -0,0 +1,9 @@
+export interface CashbackEngagementData {
+    /** 用户充值订单总金额（分） */
+    order_total_amount: `${number}` | number;
+    /** 充值返还的总金额（分） */
+    cashback_total_amount: `${number}` | number;
+    /** 充值返还的总金额所对应的游戏道具数量 */
+    game_item_count: `${number}` | number;
+}
+export declare const CashbackEngagementDataValidator: import("@seayoo-web/utils").ObjectValidator<CashbackEngagementData, false, false>;

package/types/src/event.engage/engage.comment.d.ts

@@ -0,0 +1,22 @@
+/** 评论玩法的参与记录 */
+export interface CommentEngagement {
+    /** 用户世游通行证 ID */
+    user_id: string;
+    /** 用户昵称 */
+    name: string;
+    /** 用户头像地址 */
+    avatar_url: string;
+    /** 评论信息 */
+    comment: string;
+    /** 用户发布弹幕的视频点 */
+    video_note: number;
+    /** 用户发布弹幕的时间 */
+    created_at: number;
+}
+export declare const CommentEngagementValidator: import("@seayoo-web/utils").ObjectValidator<CommentEngagement, false, false>;
+export interface CommentEngagementParam {
+    /** 用户发送弹幕内容 */
+    comment: string;
+    /** 用户发布弹幕的视频点 */
+    video_note?: number;
+}

package/types/src/event.engage/engage.giftcode.d.ts

@@ -0,0 +1,5 @@
+export interface GiftCodeEngagementData {
+    /** 礼包码 */
+    gift_code: string;
+}
+export declare const GiftCodeEngagementDataValidator: import("@seayoo-web/utils").ObjectValidator<GiftCodeEngagementData, false, false>;

package/types/src/event.engage/engage.invite.d.ts

@@ -0,0 +1,9 @@
+export interface InviteEngagementData {
+    /** 被邀请人的世游通行证 ID */
+    user_id: string;
+    /** 被邀请人昵称 */
+    name?: string;
+    /** 被邀请人头像地址 */
+    avatar_url?: string;
+}
+export declare const InviteEngagementDataValidator: import("@seayoo-web/utils").ObjectValidator<InviteEngagementData, false, false>;

package/types/src/event.engage/engage.lottery.d.ts

@@ -0,0 +1,9 @@
+export interface LotteryEngagementData {
+    /** 用户抽奖次数 */
+    lottery_count: number;
+}
+export declare const LotteryEngagementDataValidator: import("@seayoo-web/utils").ObjectValidator<LotteryEngagementData, false, false>;
+export interface LotteryEngagementParam {
+    /** 用户抽奖次数 */
+    lottery_count: number;
+}

package/types/src/event.engage/engage.lotteryDraw.d.ts

@@ -0,0 +1,40 @@
+import { type InferType } from "@seayoo-web/utils";
+import { LotteryTicketStatus, type LotteryDrawAction } from "../event.enums";
+import { type UserReward } from "./reward";
+declare const noRewardStatus: import("@seayoo-web/utils").StringValidator<"unknown" | "pending", false, false>;
+export type LotteryDrawTicket = {
+    /** 抽奖券 */
+    ticket: string;
+    /** 抽奖券状态 */
+    status: InferType<typeof noRewardStatus>;
+} | {
+    /** 抽奖券 */
+    ticket: string;
+    /** 抽奖券状态 */
+    status: Exclude<LotteryTicketStatus, InferType<typeof noRewardStatus>>;
+    /** 抽奖券奖励物品，status = drawn 时 reward_id = 0 */
+    reward: UserReward;
+};
+export interface LotteryDrawEngagementData {
+    tickets: LotteryDrawTicket[];
+}
+export declare const LotteryDrawEngagementDataValidator: import("@seayoo-web/utils").ObjectValidator<{
+    tickets: ({
+        ticket: /*elided*/ any;
+        status: /*elided*/ any;
+    } | {
+        ticket: /*elided*/ any;
+        status: /*elided*/ any;
+        reward: /*elided*/ any;
+    })[];
+}, false, false>;
+export type LotteryDrawEngagementParam = {
+    /** 参与抽奖券的动作类型 */
+    action: Exclude<LotteryDrawAction, typeof LotteryDrawAction.Claim>;
+} | {
+    /** 参与抽奖券的动作类型 */
+    action: typeof LotteryDrawAction.Claim;
+    /** 抽奖券 */
+    ticket: string;
+};
+export {};

package/types/src/event.engage/engage.preregister.d.ts

@@ -0,0 +1,11 @@
+export interface PreregisterEngagementData {
+    /** 用户预约平台 */
+    platforms: string[];
+}
+export declare const PreregisterEngagementDataValidator: import("@seayoo-web/utils").ObjectValidator<{
+    platforms: string[];
+}, false, false>;
+export interface PreregisterEngagementParam {
+    /** 用户预约平台 */
+    platforms: string[];
+}