@seayoo-web/gamer-api 1.1.18 → 2.0.1

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

@@ -0,0 +1,23 @@
+import { type EngageAccountType, type EventPeriodType } from "../event.enums";
+import { type FeatureReward } from "./reward";
+export interface EventFeatureBaseConfig {
+    /** 玩法名称 */
+    feature_name: string;
+    /** 玩法 Id */
+    feature_id: number;
+    /** 玩法描述 */
+    description: string;
+    /** 玩法周期，即每多长时间可参与一次 */
+    cycle: EventPeriodType;
+    /** 允许的最大参与次数 */
+    limit: number;
+    /** 玩法开始时间 */
+    since: number;
+    /** 玩法结束时间 */
+    until: number;
+    /** 参与玩法维度账号类型 */
+    engage_account: EngageAccountType;
+    /** 玩法参与奖励 */
+    feature_rewards?: FeatureReward;
+}
+export declare const EventFeatureBaseConfigValidator: import("@seayoo-web/utils").ObjectValidator<EventFeatureBaseConfig, false, false>;

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

@@ -0,0 +1,18 @@
+import { type EventFeatureBaseConfig } from "./feature.base";
+declare const featureType: "cashback";
+export interface FeatureCashbackConfig {
+    /** 计算充值总额的开始时间 */
+    order_start_time: number;
+    /** 计算充值总额的结束时间 */
+    order_end_time: number;
+    /** 可领取充值返还奖励的开始时间 */
+    claim_rewards_start_time: number;
+    /** 可领取充值返还奖励的结束时间 */
+    claim_rewards_end_time: number;
+}
+export type EventFeatureConfigOfCashback = EventFeatureBaseConfig & {
+    feature_type: typeof featureType;
+    config: FeatureCashbackConfig;
+};
+export declare const EventFeatureConfigOfCashbackValidator: import("@seayoo-web/utils").ObjectValidator<EventFeatureConfigOfCashback, false, false>;
+export {};

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

@@ -0,0 +1,7 @@
+import { type EventFeatureBaseConfig } from "./feature.base";
+declare const featureType: "check_in";
+export type EventFeatureConfigOfCheckIn = EventFeatureBaseConfig & {
+    feature_type: typeof featureType;
+};
+export declare const EventFeatureConfigOfCheckInValidator: import("@seayoo-web/utils").ObjectValidator<EventFeatureConfigOfCheckIn, false, false>;
+export {};

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

@@ -0,0 +1,7 @@
+import { type EventFeatureBaseConfig } from "./feature.base";
+declare const featureType: "claim_rewards";
+export type EventFeatureConfigOfClaimRewards = EventFeatureBaseConfig & {
+    feature_type: typeof featureType;
+};
+export declare const EventFeatureConfigOfClaimRewardsValidator: import("@seayoo-web/utils").ObjectValidator<EventFeatureConfigOfClaimRewards, false, false>;
+export {};

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

@@ -0,0 +1,14 @@
+import { type EventFeatureBaseConfig } from "./feature.base";
+declare const featureType: "comment";
+export interface FeatureCommentConfig {
+    /** 活动配置的弹幕信息，用于快捷选择 */
+    comments: string[];
+    /** 发送频率限制，单位：秒 */
+    send_rate: number;
+}
+export type EventFeatureConfigOfComment = EventFeatureBaseConfig & {
+    feature_type: typeof featureType;
+    config: FeatureCommentConfig;
+};
+export declare const EventFeatureConfigOfCommentValidator: import("@seayoo-web/utils").ObjectValidator<EventFeatureConfigOfComment, false, false>;
+export {};

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

@@ -0,0 +1,38 @@
+import { type EventFeatureConfigOfCashback } from "./feature.cashback";
+import { type EventFeatureConfigOfCheckIn } from "./feature.checkIn";
+import { type EventFeatureConfigOfClaimRewards } from "./feature.claimRewards";
+import { type EventFeatureConfigOfComment } from "./feature.comment";
+import { type EventFeatureConfigOfFollow } from "./feature.follow";
+import { type EventFeatureConfigOfGiftCode } from "./feature.giftcode";
+import { type EventFeatureConfigOfInvite } from "./feature.invite";
+import { type EventFeatureConfigOfInvitedRegister } from "./feature.invitedRegister";
+import { type EventFeatureConfigOfLottery } from "./feature.lottery";
+import { type EventFeatureConfigOfLotteryDraw } from "./feature.lotteryDraw";
+import { type EventFeatureConfigOfPreregister } from "./feature.preregister";
+import { type EventFeatureConfigOfQuest } from "./feature.quest";
+import { type EventFeatureConfigOfRegister } from "./feature.register";
+import { type EventFeatureConfigOfShare } from "./feature.share";
+import { type EventFeatureConfigOfSubscribe } from "./feature.subscribe";
+import { type EventFeatureConfigOfSurvey } from "./feature.survey";
+import { type EventFeatureConfigOfTeam } from "./feature.team";
+import { type EventFeatureConfigOfVote } from "./feature.vote";
+export * from "./feature.cashback";
+export * from "./feature.checkIn";
+export * from "./feature.claimRewards";
+export * from "./feature.comment";
+export * from "./feature.follow";
+export * from "./feature.giftcode";
+export * from "./feature.invite";
+export * from "./feature.invitedRegister";
+export * from "./feature.lottery";
+export * from "./feature.lotteryDraw";
+export * from "./feature.preregister";
+export * from "./feature.quest";
+export * from "./feature.register";
+export * from "./feature.share";
+export * from "./feature.subscribe";
+export * from "./feature.survey";
+export * from "./feature.team";
+export * from "./feature.vote";
+export type EventFeatureConfig = EventFeatureConfigOfCashback | EventFeatureConfigOfCheckIn | EventFeatureConfigOfClaimRewards | EventFeatureConfigOfComment | EventFeatureConfigOfFollow | EventFeatureConfigOfGiftCode | EventFeatureConfigOfInvite | EventFeatureConfigOfInvitedRegister | EventFeatureConfigOfLottery | EventFeatureConfigOfLotteryDraw | EventFeatureConfigOfPreregister | EventFeatureConfigOfQuest | EventFeatureConfigOfRegister | EventFeatureConfigOfShare | EventFeatureConfigOfSubscribe | EventFeatureConfigOfSurvey | EventFeatureConfigOfTeam | EventFeatureConfigOfVote;
+export declare const EventFeatureConfigValidator: import("@seayoo-web/utils").UnionValidator<[import("@seayoo-web/utils").ObjectValidator<EventFeatureConfigOfCashback, false, false>, import("@seayoo-web/utils").ObjectValidator<EventFeatureConfigOfCheckIn, false, false>, import("@seayoo-web/utils").ObjectValidator<EventFeatureConfigOfClaimRewards, false, false>, import("@seayoo-web/utils").ObjectValidator<EventFeatureConfigOfComment, false, false>, import("@seayoo-web/utils").ObjectValidator<EventFeatureConfigOfFollow, false, false>, import("@seayoo-web/utils").ObjectValidator<EventFeatureConfigOfGiftCode, false, false>, import("@seayoo-web/utils").ObjectValidator<EventFeatureConfigOfInvite, false, false>, import("@seayoo-web/utils").ObjectValidator<EventFeatureConfigOfInvitedRegister, false, false>, import("@seayoo-web/utils").ObjectValidator<EventFeatureConfigOfLottery, false, false>, import("@seayoo-web/utils").ObjectValidator<EventFeatureConfigOfLotteryDraw, false, false>, import("@seayoo-web/utils").ObjectValidator<EventFeatureConfigOfPreregister, false, false>, import("@seayoo-web/utils").ObjectValidator<EventFeatureConfigOfQuest, false, false>, import("@seayoo-web/utils").ObjectValidator<EventFeatureConfigOfRegister, false, false>, import("@seayoo-web/utils").ObjectValidator<EventFeatureConfigOfShare, false, false>, import("@seayoo-web/utils").ObjectValidator<EventFeatureConfigOfSubscribe, false, false>, import("@seayoo-web/utils").ObjectValidator<EventFeatureConfigOfSurvey, false, false>, import("@seayoo-web/utils").ObjectValidator<EventFeatureConfigOfTeam, false, false>, import("@seayoo-web/utils").ObjectValidator<EventFeatureConfigOfVote, false, false>], false, false>;

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

@@ -0,0 +1,24 @@
+import { type EventFeatureBaseConfig } from "./feature.base";
+declare const featureType: "follow";
+export interface FeatureFollowConfig {
+    /**
+     * 社交媒体平台的标识
+     *
+     * 比如 `bilibili`, `douyin`, `xiaohongshu`, `weibo`, `weixin_official_account`, `qq`
+     */
+    platform: string;
+    /** 社交媒体平台 icon */
+    platform_icon?: string;
+    /** 跳转链接 */
+    link?: string;
+    /** 二维码链接地址 */
+    qr_code_url?: string;
+    /** 社交媒体平台描述 */
+    platform_desc?: string;
+}
+export type EventFeatureConfigOfFollow = EventFeatureBaseConfig & {
+    feature_type: typeof featureType;
+    config: FeatureFollowConfig;
+};
+export declare const EventFeatureConfigOfFollowValidator: import("@seayoo-web/utils").ObjectValidator<EventFeatureConfigOfFollow, false, false>;
+export {};

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

@@ -0,0 +1,24 @@
+import { type EventFeatureBaseConfig } from "./feature.base";
+declare const featureType: "gift_code";
+export interface EventGiftItemConfig {
+    /** 用于前端展示的游戏道具名称 */
+    name: string;
+    /** 用于前端展示的游戏道具图片地址 */
+    icon_url: string;
+    /** 用于前端展示的游戏道具数量 */
+    count: number;
+}
+export interface FeatureGiftCodeConfig {
+    /** 用于前端显示礼包码兑换后会获得的奖励内容 */
+    gift_items: EventGiftItemConfig[];
+    /** 社媒平台链接 */
+    mp_url?: string;
+    /** 社媒平台二维码 */
+    mp_qrcode_url?: string;
+}
+export type EventFeatureConfigOfGiftCode = EventFeatureBaseConfig & {
+    feature_type: typeof featureType;
+    config: FeatureGiftCodeConfig;
+};
+export declare const EventFeatureConfigOfGiftCodeValidator: import("@seayoo-web/utils").ObjectValidator<EventFeatureConfigOfGiftCode, false, false>;
+export {};

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

@@ -0,0 +1,12 @@
+import { type EventFeatureBaseConfig } from "./feature.base";
+declare const featureType: "invite";
+export interface FeatureInviteConfig {
+    /** 邀请玩法配置分享链接 */
+    share_url: string;
+}
+export type EventFeatureConfigOfInvite = EventFeatureBaseConfig & {
+    feature_type: typeof featureType;
+    config: FeatureInviteConfig;
+};
+export declare const EventFeatureConfigOfInviteValidator: import("@seayoo-web/utils").ObjectValidator<EventFeatureConfigOfInvite, false, false>;
+export {};

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

@@ -0,0 +1,7 @@
+import { type EventFeatureBaseConfig } from "./feature.base";
+declare const featureType: "invited_register";
+export type EventFeatureConfigOfInvitedRegister = EventFeatureBaseConfig & {
+    feature_type: typeof featureType;
+};
+export declare const EventFeatureConfigOfInvitedRegisterValidator: import("@seayoo-web/utils").ObjectValidator<EventFeatureConfigOfInvitedRegister, false, false>;
+export {};

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

@@ -0,0 +1,40 @@
+import { type InferType } from "@seayoo-web/utils";
+import { type EventFeatureBaseConfig } from "./feature.base";
+declare const rewardItemTypeValidator: import("@seayoo-web/utils").StringValidator<"credit" | "event_item" | "game_item" | "physical_item" | "weixin_hongbao" | "void_item", false, false>;
+declare const featureType: "lottery";
+export interface FeatureLotteryItemConfig {
+    /** 抽奖奖励道具 id */
+    reward_item_id: number;
+    /** 抽奖奖励道具名称 */
+    reward_item_name: string;
+    /** 抽奖奖励道具类型   */
+    reward_item_type: InferType<typeof rewardItemTypeValidator>;
+    /** 抽奖奖励道具图片地址 */
+    reward_item_icon_url: string;
+    /** 抽奖奖励道具描述 */
+    reward_item_desc?: string;
+    /** 抽奖奖励道具数量 */
+    reward_amount: number;
+    /** 抽奖奖励道具库存 */
+    reward_remaining_stock: number;
+}
+export interface FeatureLotteryConfig {
+    /** 抽奖消耗道具 id */
+    consume_item_id: number;
+    /** 抽奖消耗道具名称 */
+    consume_item_name: number;
+    /** 抽奖消耗道具图片地址 */
+    consume_item_icon_url: string;
+    /** 抽奖消耗道具数量配置 */
+    consume_item_count: number;
+    /** 抽奖消耗道具描述 */
+    consume_item_desc?: string;
+    /** 抽奖配置奖励列表  */
+    rewards: FeatureLotteryItemConfig[];
+}
+export type EventFeatureConfigOfLottery = EventFeatureBaseConfig & {
+    feature_type: typeof featureType;
+    config: FeatureLotteryConfig;
+};
+export declare const EventFeatureConfigOfLotteryValidator: import("@seayoo-web/utils").ObjectValidator<EventFeatureConfigOfLottery, false, false>;
+export {};

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

@@ -0,0 +1,14 @@
+import { type EventFeatureBaseConfig } from "./feature.base";
+declare const featureType: "lottery_draw";
+export interface FeatureLotteryDrawConfig {
+    /** 可开奖起始时间 */
+    draw_not_before: number;
+    /** 可开奖结束时间 */
+    draw_not_after: number;
+}
+export type EventFeatureConfigOfLotteryDraw = EventFeatureBaseConfig & {
+    feature_type: typeof featureType;
+    config: FeatureLotteryDrawConfig;
+};
+export declare const EventFeatureConfigOfLotteryDrawValidator: import("@seayoo-web/utils").ObjectValidator<EventFeatureConfigOfLotteryDraw, false, false>;
+export {};

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

@@ -0,0 +1,7 @@
+import { type EventFeatureBaseConfig } from "./feature.base";
+declare const featureType: "preregister";
+export type EventFeatureConfigOfPreregister = EventFeatureBaseConfig & {
+    feature_type: typeof featureType;
+};
+export declare const EventFeatureConfigOfPreregisterValidator: import("@seayoo-web/utils").ObjectValidator<EventFeatureConfigOfPreregister, false, false>;
+export {};

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

@@ -0,0 +1,22 @@
+import { type QuestObjective } from "../event.enums";
+import { type EventFeatureBaseConfig } from "./feature.base";
+declare const featureType: "quest";
+export interface FeatureQuestConfig {
+    /** 任务目标 */
+    objective: QuestObjective;
+    /** 目标值 */
+    completion_value: number;
+    /** 团队任务配置 */
+    team?: {
+        /** 组队任务 ID */
+        feature_id?: number;
+        /** 目标值 */
+        completion_value: number;
+    };
+}
+export type EventFeatureConfigOfQuest = EventFeatureBaseConfig & {
+    feature_type: typeof featureType;
+    config: FeatureQuestConfig;
+};
+export declare const EventFeatureConfigOfQuestValidator: import("@seayoo-web/utils").ObjectValidator<EventFeatureConfigOfQuest, false, false>;
+export {};

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

@@ -0,0 +1,7 @@
+import { type EventFeatureBaseConfig } from "./feature.base";
+declare const featureType: "register";
+export type EventFeatureConfigOfRegister = EventFeatureBaseConfig & {
+    feature_type: typeof featureType;
+};
+export declare const EventFeatureConfigOfRegisterValidator: import("@seayoo-web/utils").ObjectValidator<EventFeatureConfigOfRegister, false, false>;
+export {};

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

@@ -0,0 +1,16 @@
+import { type EventFeatureBaseConfig } from "./feature.base";
+declare const featureType: "share";
+export interface FeatureShareConfig {
+    /** 分享玩法配置分享平台 */
+    share_platform: string;
+    /** 分享玩法配置跳转地址 */
+    jump_url?: string;
+    /** 分享玩法分享平台图标 */
+    icon_url?: string;
+}
+export type EventFeatureConfigOfShare = EventFeatureBaseConfig & {
+    feature_type: typeof featureType;
+    config: FeatureShareConfig;
+};
+export declare const EventFeatureConfigOfShareValidator: import("@seayoo-web/utils").ObjectValidator<EventFeatureConfigOfShare, false, false>;
+export {};

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

@@ -0,0 +1,12 @@
+import { type EventFeatureBaseConfig } from "./feature.base";
+declare const featureType: "weixin_subscribe";
+export interface FeatureSubscribeConfig {
+    /** 一组微信订阅消息模版 ID */
+    weixin_template_ids: string[];
+}
+export type EventFeatureConfigOfSubscribe = EventFeatureBaseConfig & {
+    feature_type: typeof featureType;
+    config: FeatureSubscribeConfig;
+};
+export declare const EventFeatureConfigOfSubscribeValidator: import("@seayoo-web/utils").ObjectValidator<EventFeatureConfigOfSubscribe, false, false>;
+export {};

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

@@ -0,0 +1,14 @@
+import { type EventFeatureBaseConfig } from "./feature.base";
+declare const featureType: "survey";
+export interface FeatureSurveyConfig {
+    /** 问卷 ID */
+    survey_id: string;
+    /** 问卷 url 地址 */
+    survey_url: string;
+}
+export type EventFeatureConfigOfSurvey = EventFeatureBaseConfig & {
+    feature_type: typeof featureType;
+    config: FeatureSurveyConfig;
+};
+export declare const EventFeatureConfigOfSurveyValidator: import("@seayoo-web/utils").ObjectValidator<EventFeatureConfigOfSurvey, false, false>;
+export {};

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

@@ -0,0 +1,14 @@
+import { type EventFeatureBaseConfig } from "./feature.base";
+declare const featureType: "team";
+export interface FeatureTeamConfig {
+    /** 队伍最大成员数 */
+    max_members: number;
+    /** 队伍最小成员数 */
+    min_members: number;
+}
+export type EventFeatureConfigOfTeam = EventFeatureBaseConfig & {
+    feature_type: typeof featureType;
+    config: FeatureTeamConfig;
+};
+export declare const EventFeatureConfigOfTeamValidator: import("@seayoo-web/utils").ObjectValidator<EventFeatureConfigOfTeam, false, false>;
+export {};

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

@@ -0,0 +1,44 @@
+import { type VoteOptionSource } from "../event.enums";
+import { type EventFeatureBaseConfig } from "./feature.base";
+import { type EventRewardItemConfig } from "./reward";
+declare const featureType: "vote";
+export interface FeatureVoteOption {
+    /** 选项标识 */
+    sn: string;
+    /** 选项名称 */
+    name: string;
+    /** 选项图片地址 */
+    img_urls?: string[];
+    /** 选项视频地址 */
+    video_urls?: string[];
+    /** 选项描述文本 */
+    descriptions?: string[];
+    /** 跳转地址 */
+    jump_url: string;
+    /** 选项投票数量 */
+    amount: number;
+    /** 选项是否入围 */
+    finalists: boolean;
+    /** 最后投票时间秒级时间戳 */
+    last_vote_time: number;
+}
+export interface FeatureVoteConfig {
+    /** 关联一个或多个投票玩法 ID */
+    vote_feature_ids: number[];
+    /** 关联一个或多个投稿玩法 ID */
+    submission_feature_ids: number[];
+    /** 入围数量 */
+    finalists_amount: number;
+    /** 选项来源 */
+    source: VoteOptionSource;
+    /** 投票选项配置 */
+    options: FeatureVoteOption[];
+    /** 投票入围后用户可获得的奖励 */
+    rewards: EventRewardItemConfig[];
+}
+export type EventFeatureConfigOfVote = EventFeatureBaseConfig & {
+    feature_type: typeof featureType;
+    config: FeatureVoteConfig;
+};
+export declare const EventFeatureConfigOfVoteValidator: import("@seayoo-web/utils").ObjectValidator<EventFeatureConfigOfVote, false, false>;
+export {};

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

@@ -0,0 +1,23 @@
+import { type EventFeatureConfig } from "./feature";
+export * from "./feature";
+export * from "./reward";
+export interface EventConfig {
+    /** 活动名称 */
+    event_name: string;
+    /** 面向玩家的富文本活动规则 */
+    rules: string;
+    /** 活动开始时间 */
+    since: number;
+    /** 活动结束时间 */
+    until: number;
+    /** 活动访问人数 */
+    visit_count?: number;
+    /** 活动下玩法列表 */
+    features: EventFeatureConfig[];
+}
+export declare const EventConfigValidator: import("@seayoo-web/utils").ObjectValidator<EventConfig, false, false> & {
+    plain: never;
+    optional: never;
+    maybeNull: never;
+    lock: never;
+};

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

@@ -0,0 +1,55 @@
+import { type InferType } from "@seayoo-web/utils";
+declare const rewardItemTypeValidator: import("@seayoo-web/utils").StringValidator<"credit" | "event_item" | "game_item" | "physical_item" | "weixin_hongbao" | "void_item", false, false>;
+export interface EventRewardItemConfig {
+    /** 玩法奖励道具 id */
+    reward_item_id: number;
+    /** 玩法奖励道具数量 */
+    reward_amount: number;
+    /** 玩法奖励道具名称 */
+    reward_item_name: string;
+    /** 玩法奖励道具图片地址 */
+    reward_item_icon_url: string;
+    /** 玩法奖励道具描述 */
+    reward_item_desc?: string;
+    /** 玩法奖励道具类型  */
+    reward_item_type: InferType<typeof rewardItemTypeValidator>;
+    /** 奖励道具评级，用于前端展示 */
+    reward_item_rating: number;
+}
+export declare const EventRewardItemConfigValidator: import("@seayoo-web/utils").ObjectValidator<EventRewardItemConfig, false, false> & {
+    plain: never;
+    optional: never;
+    maybeNull: never;
+    lock: never;
+};
+export interface RegularReward {
+    engage_count: number;
+    rewards: EventRewardItemConfig[];
+}
+export declare const RegularRewardValidator: import("@seayoo-web/utils").ObjectValidator<RegularReward, false, false> & {
+    plain: never;
+    optional: never;
+    maybeNull: never;
+    lock: never;
+};
+export type FeatureReward = {
+    feature_reward_type: "every";
+    reward_details: EventRewardItemConfig[];
+} | {
+    feature_reward_type: "regular";
+    reward_details: RegularReward[];
+};
+export declare const FeatureRewardValidator: import("@seayoo-web/utils").UnionValidator<[import("@seayoo-web/utils").ObjectValidator<{
+    feature_reward_type: "every";
+    reward_details: EventRewardItemConfig[];
+}, false, false>, import("@seayoo-web/utils").ObjectValidator<{
+    feature_reward_type: "regular";
+    reward_details: RegularReward[];
+}, false, false>], false, false> & {
+    optional: never;
+    maybeNull: never;
+    key: never;
+    satisfies: never;
+    lock: never;
+};
+export {};