@seayoo-web/gamer-api 1.1.18 → 2.0.1

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[];
+}

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

@@ -0,0 +1,28 @@
+import { type QuestObjective } from "../event.enums";
+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 declare const QuestEngagementDataValidator: import("@seayoo-web/utils").ObjectValidator<QuestEngagementData, false, false>;

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

@@ -0,0 +1,9 @@
+export interface ShareEngagementData {
+    /** 用户分享到对应的平台 */
+    platform: string;
+}
+export declare const ShareEngagementDataValidator: import("@seayoo-web/utils").ObjectValidator<ShareEngagementData, false, false>;
+export interface ShareEngagementParam {
+    /** 用户分享到对应的平台 */
+    platform: string;
+}

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

@@ -0,0 +1,14 @@
+export interface WeixinSubscribeEngagementData {
+    weixin_openid: string;
+}
+export declare const WeixinSubscribeEngagementDataValidator: import("@seayoo-web/utils").ObjectValidator<WeixinSubscribeEngagementData, false, false>;
+export interface SubscribeEngagementParam {
+    /**
+     * 小程序调用 wx.requestSubscribeMessage 并收到 success 回调后，得到的订阅结果。
+     *
+     * - key 为模版 ID
+     *
+     * - value 为订阅结果。示例 `accept` `reject` `ban` `filter`
+     */
+    subscribe_results: Record<string, string>;
+}

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

@@ -0,0 +1,7 @@
+export interface SurveyEngagementData {
+    /** 用户填写问卷流水号 */
+    serial_number: number;
+}
+export declare const SurveyEngagementDataValidator: import("@seayoo-web/utils").ObjectValidator<{
+    serial_number: number;
+}, false, false>;

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

@@ -0,0 +1,53 @@
+import { type TeamAction, type TeamVisibility } from "../event.enums";
+/** 组队玩法的参与记录 */
+export interface TeamEngagement {
+    /** 组队码 */
+    team_code: string;
+    /** 队长角色名称 */
+    leader_name: string;
+    /** 队员数量 */
+    total_members: number;
+}
+export declare const TeamEngagementValidator: import("@seayoo-web/utils").ObjectValidator<TeamEngagement, false, false>;
+export interface TeamMember {
+    /** 是否为队长 */
+    is_leader: boolean;
+    /** 是否为当前登录用户 */
+    is_myself?: boolean;
+    /** 角色名 */
+    role_name: string;
+    /** 服务器名 */
+    server_name: string;
+}
+export declare const TeamMemberValidator: import("@seayoo-web/utils").ObjectValidator<TeamMember, false, false>;
+export interface TeamEngagementData {
+    /** 组队码 */
+    team_code: string;
+    /** 队伍可见性 */
+    visibility: TeamVisibility;
+    /** 队员信息 */
+    members: TeamMember[];
+}
+export declare const TeamEngagementDataValidator: import("@seayoo-web/utils").ObjectValidator<TeamEngagementData, false, false>;
+export type TeamEngagementParam = {
+    /** 操作类型 */
+    action: typeof TeamAction.ChangeVisibility;
+    /** 组队码 */
+    team_code: string;
+    /** 设置队伍的可见性 */
+    visibility: TeamVisibility;
+} | {
+    /** 操作类型 */
+    action: typeof TeamAction.Assemble;
+    /** 设置队伍的可见性 */
+    visibility?: TeamVisibility;
+} | {
+    action: typeof TeamAction.Join | typeof TeamAction.Disband;
+    /** 组队码 */
+    team_code: string;
+} | {
+    /** 操作类型 */
+    action: typeof TeamAction.Query;
+    /** 组队码 */
+    team_code?: string;
+};

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

@@ -0,0 +1,9 @@
+export interface VoteEngagementData {
+    /** 用户投票选项 */
+    option_sn: string;
+}
+export declare const VoteEngagementDataValidator: import("@seayoo-web/utils").ObjectValidator<VoteEngagementData, false, false>;
+export interface VoteEngagementParam {
+    /** 选项的 sn */
+    option_sn: string;
+}

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

@@ -0,0 +1,47 @@
+import { type UserEngagementData } from "./engage";
+import { type LotteryEngagementParam } from "./engage.lottery";
+import { type LotteryDrawEngagementParam } from "./engage.lotteryDraw";
+import { type ShareEngagementParam } from "./engage.share";
+import { type SubscribeEngagementParam } from "./engage.subscribe";
+import { type TeamEngagementParam } from "./engage.team";
+import { type VoteEngagementParam } from "./engage.vote";
+import { type Reward } from "./reward";
+import type { CommentEngagementParam } from "./engage.comment";
+import type { PreregisterEngagementParam } from "./engage.preregister";
+import type { FeatureType } from "../event.enums";
+export * from "./engage";
+export * from "./reward";
+export type UserEngagement = {
+    /** 参与记录 ID */
+    engagement_id: number;
+    /** 用户 ID */
+    user_id: string;
+    /** 活动 ID */
+    event_id: number;
+    /** 玩法 ID */
+    feature_id: number;
+    /** 玩法参与次数 */
+    sequence: number;
+    /** 附带的数据，由 feature_id 的类型决定 */
+    data?: UserEngagementData;
+    server_id?: string;
+    role_id?: string;
+    created_at: number;
+    /** 参与奖励列表 */
+    rewards?: Reward[];
+};
+export declare const UserEngagementValidator: import("@seayoo-web/utils").ObjectValidator<UserEngagement, false, false> & {
+    plain: never;
+    optional: never;
+    maybeNull: never;
+    lock: never;
+};
+/**
+ * 用户参与时需要提供的参数信息
+ */
+export type EngagementParam = PreregisterEngagementParam | LotteryEngagementParam | CommentEngagementParam | ShareEngagementParam | VoteEngagementParam | SubscribeEngagementParam | TeamEngagementParam | LotteryDrawEngagementParam;
+export type EngagementFeatureType = FeatureType | unknown;
+/**
+ * 根据玩法类型推导需要提交的参数数据类型
+ */
+export type InferEngagementParam<T extends EngagementFeatureType> = [unknown] extends [T] ? EngagementParam : [T] extends ["preregister"] ? PreregisterEngagementParam : [T] extends ["lottery"] ? LotteryEngagementParam : [T] extends ["comment"] ? CommentEngagementParam : [T] extends ["share"] ? ShareEngagementParam : [T] extends ["vote"] ? VoteEngagementParam : [T] extends ["weixin_subscribe"] ? SubscribeEngagementParam : null;

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

@@ -0,0 +1,89 @@
+import { ClaimRewardStatus, GamerItemType, RewardItemType, type FeatureType, type RewardSource, type RewardStatusSuffix } from "../event.enums";
+import { type UserEngagementData } from "./engage";
+export interface Reward {
+    /** 用户奖励记录 id */
+    reward_id: number;
+    /** 奖励道具 id */
+    reward_item_id: number;
+    /** 奖励道具类型  */
+    reward_item_type: RewardItemType;
+    /** 奖励道具数量 */
+    reward_count: number;
+    /** 奖励状态 */
+    reward_status: RewardStatusSuffix;
+    /** 奖励来源 */
+    reward_source: RewardSource;
+    /** 奖励道具名称 */
+    reward_item_name: string;
+    /** 奖励道具图片地址 */
+    reward_item_icon_url: string;
+    /** 奖励道具描述 */
+    reward_item_desc?: string;
+    /** 奖励道具评级，用于前端展示 */
+    reward_item_rating: number;
+    /** 领奖时间 */
+    receive_time: number;
+    /** 提供额外扩展信息 */
+    extra_data?: UserEngagementData | Record<string, unknown>;
+}
+export declare const RewardValidator: import("@seayoo-web/utils").ObjectValidator<Reward, false, false>;
+export interface UserReward {
+    /** 用户奖励记录 id */
+    reward_id: number;
+    /** 奖励道具 id */
+    reward_item_id: number;
+    /** 产生奖励的来源 */
+    reward_source: RewardSource;
+    /** 奖励道具名称 */
+    reward_item_name: string;
+    /** 奖励道具类型  */
+    reward_item_type: GamerItemType;
+    /** 奖励道具图片地址 */
+    reward_item_icon_url: string;
+    /** 奖励道具描述 */
+    reward_item_desc?: string;
+    /** 奖励道具评级，用于前端展示 */
+    reward_item_rating: number;
+    /** 奖励道具数量 */
+    reward_amount: number;
+    /** 奖励状态 */
+    reward_status: ClaimRewardStatus;
+    /** 活动 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 declare const UserRewardValidator: import("@seayoo-web/utils").ObjectValidator<UserReward, false, false>;
+export interface EngageReward {
+    /** 用户奖励记录 id（微信红包类型奖励需要前端请求一次领奖 api） */
+    reward_id: number;
+    /** 奖励道具 id */
+    reward_item_id: number;
+    /** 奖励道具名称 */
+    reward_item_name: string;
+    /** 奖励道具类型 */
+    reward_item_type: RewardItemType;
+    /** 奖励道具图片地址 */
+    reward_item_icon_url: string;
+    /** 奖励道具描述 */
+    reward_item_desc?: string;
+    /** 奖励道具数量 */
+    reward_amount: number;
+    /** 奖励状态 */
+    reward_status: RewardStatusSuffix;
+    /** 产生奖励的来源 */
+    reward_source: RewardSource;
+    /** 提供额外扩展信息，例如：礼包码的值等 */
+    extra_data?: Record<string, unknown>;
+}
+export declare const EngageRewardValidator: import("@seayoo-web/utils").ObjectValidator<EngageReward, false, false>;