@seayoo-web/gamer-api 2.4.4 → 2.4.5

package/dist/index.js

@@ -319,7 +319,7 @@ const Ce = {
   decreased_credit: e.number(),
   expired_credit: e.number(),
   balance_credit: e.number()
-}).lock(), Ge = e.object({
+}).lock(), Ae = e.object({
   id: e.number(),
   change_type: je,
   change_scene: qe,
@@ -361,7 +361,7 @@ const Ce = {
   created_at: e.number(),
   updated_at: e.number(),
   redeemable_quantity: e.number().optional()
-}).lock(), Ae = e.object({
+}).lock(), Ge = e.object({
   ...V(W.shape, "tag"),
   product: ee.clone().optional()
 }).lock(), Vr = e.union(
@@ -400,9 +400,9 @@ const Ce = {
   created_at: e.number(),
   extra_data: e.union(Ne.clone(), Oe.clone()).satisfies().optional()
 }), Me = e.guard(Ee), Q = s({ player: Pe }), Qe = s({ roles: e.array(Y) }), x = s({ role_card: Fe }), K = e.guard(De), H = e.guard(Z), Ke = s({ addresses: e.array(Z) }), He = e.guard(Ie), ze = s({
-  credit_logs: e.array(Ge),
+  credit_logs: e.array(Ae),
   next_token: e.string().optional()
-}), Je = s({ products: e.array(ee) }), Xe = s({ benefits: e.array(W) }), Ye = s({ benefit: Ae }), Ze = s({
+}), Je = s({ products: e.array(ee) }), Xe = s({ benefits: e.array(W) }), Ye = s({ benefit: Ge }), Ze = s({
   redemptions: e.array(Be),
   next_token: e.string().optional()
 });
@@ -678,6 +678,8 @@ const j = {
   WeixinHongbao: "weixin_hongbao",
   /** 礼包码 */
   GiftCode: "gift_code",
+  /** 激活码 */
+  ActivationKey: "activation_key",
   /** 抽奖券 */
   LotteryTicket: "lottery_ticket",
   /** 积分 */
@@ -944,16 +946,16 @@ const j = {
     consume_item_desc: e.string().optional(),
     rewards: e.array(Ft)
   })
-}), It = u.LotteryDraw, Gt = e.object({
+}), It = u.LotteryDraw, At = e.object({
   ...l.shape,
   feature_type: e.string().enum(It),
   config: e.object({
     draw_not_before: e.number(),
     draw_not_after: e.number()
   })
-}), At = u.Preregister, Nt = e.object({
+}), Gt = u.Preregister, Nt = e.object({
   ...l.shape,
-  feature_type: e.string().enum(At)
+  feature_type: e.string().enum(Gt)
 }), Ot = u.Quest, Bt = e.object({
   ...l.shape,
   feature_type: e.string().enum(Ot),
@@ -1032,7 +1034,7 @@ const j = {
   Lt,
   Pt,
   Dt,
-  Gt,
+  At,
   Nt,
   Bt,
   Qt,
@@ -1231,10 +1233,10 @@ const j = {
   claimed_items: e.array(xn)
 }), In = s({
   reward_status: U
-}), Gn = s({
+}), An = s({
   user_rewards: e.array(oe),
   next_token: e.string().optional()
-}), An = s({
+}), Gn = s({
   scene: e.string()
 }), Nn = s({
   params: e.string()
@@ -1469,7 +1471,7 @@ class Pr {
     const { data: n } = await this.req.post(
       "event/user-rewards",
       c({ max_results: 20, ...t, event_id: this.event }),
-      Gn,
+      An,
       r
     );
     return {
@@ -1509,7 +1511,7 @@ class Pr {
    */
   async getUnlimitQrcodeScene(t, r) {
     if (!await this.token.autoLogin()) return null;
-    const { data: n } = await this.req.get("event/unlimit-qrcode-scene", An, {
+    const { data: n } = await this.req.get("event/unlimit-qrcode-scene", Gn, {
       ...r,
       params: { params: t }
     });
@@ -1599,14 +1601,14 @@ const Bn = {
   sort: e.number(),
   mode: Mn,
   member_ids: e.array(e.number())
-}).lock(), G = e.object({
+}).lock(), A = e.object({
   topic_id: e.number(),
   cover_url: e.string(),
   name: e.string(),
   description: e.string(),
   tags: e.array(e.string()),
   post_num: e.number()
-}).lock(), A = e.object({
+}).lock(), G = e.object({
   post_id: e.number(),
   forum: se,
   posted_by: e.string(),
@@ -1620,7 +1622,7 @@ const Bn = {
   comments_num: e.number(),
   liked: e.bool(),
   image_urls: e.array(e.string()),
-  topics: e.array(G),
+  topics: e.array(A),
   event_ids: e.array(e.number()),
   is_pinned: e.bool(),
   is_highlighted: e.bool(),
@@ -1743,10 +1745,10 @@ const Bn = {
   tr,
   nr,
   rr
-).satisfies().lock(), or = s({ forums: e.array(se) }), ar = s({ topics: e.array(G) }), sr = s({ topic: G }), cr = s({ post: A }), z = s({
-  posts: e.array(A),
+).satisfies().lock(), or = s({ forums: e.array(se) }), ar = s({ topics: e.array(A) }), sr = s({ topic: A }), cr = s({ post: G }), z = s({
+  posts: e.array(G),
   next_token: e.string().optional()
-}), ur = s({ post: A, antispam: ce }), lr = s({
+}), ur = s({ post: G, antispam: ce }), lr = s({
   replies: e.array(T),
   next_token: e.string().optional()
 }), mr = s({ reply: T }), dr = s({
@@ -2228,12 +2230,12 @@ export {
   Z as ClubAddressValidator,
   jr as ClubApi,
   W as ClubBenefitSummaryValidator,
-  Ae as ClubBenefitValidator,
+  Ge as ClubBenefitValidator,
   Te as ClubCreditChangeScene,
   qe as ClubCreditChangeSceneValidator,
   Ve as ClubCreditChangeType,
   je as ClubCreditChangeTypeValidator,
-  Ge as ClubCreditLogValidator,
+  Ae as ClubCreditLogValidator,
   Ee as ClubGlobalConfigValidator,
   xe as ClubItemType,
   X as ClubItemTypeValidator,
@@ -2261,7 +2263,7 @@ export {
   xt as EventFeatureConfigOfGiftCodeValidator,
   Lt as EventFeatureConfigOfInviteValidator,
   Pt as EventFeatureConfigOfInvitedRegisterValidator,
-  Gt as EventFeatureConfigOfLotteryDrawValidator,
+  At as EventFeatureConfigOfLotteryDrawValidator,
   Dt as EventFeatureConfigOfLotteryValidator,
   Nt as EventFeatureConfigOfPreregisterValidator,
   Bt as EventFeatureConfigOfQuestValidator,
@@ -2316,7 +2318,7 @@ export {
   Y as PlayerRoleValidator,
   Qn as PostStatus,
   ae as PostStatusValidator,
-  A as PostValidator,
+  G as PostValidator,
   pn as PreregisterEngagementDataValidator,
   Jn as PresignedUrlResponseValidator,
   _n as QuestEngagementDataValidator,
@@ -2347,7 +2349,7 @@ export {
   Er as TeamMemberValidator,
   ct as TeamVisibility,
   ut as TeamVisibilityValidator,
-  G as TopicValidator,
+  A as TopicValidator,
   I as UserEngagementDataValidator,
   Vn as UserEngagementValidator,
   Tn as UserFeatureStatusValidator,

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@seayoo-web/gamer-api",
   "description": "agent for gamer api",
-  "version": "2.4.4",
+  "version": "2.4.5",
   "type": "module",
   "source": "index.ts",
   "main": "./dist/index.js",
@@ -30,10 +30,10 @@
   "license": "MIT",
   "devDependencies": {
     "@types/node": "^22.13.1",
-    "@seayoo-web/tsconfig": "^1.0.4",
     "@seayoo-web/combo-webview": "^2.5.4",
-    "@seayoo-web/request": "^3.2.0",
     "@seayoo-web/scripts": "^2.5.7",
+    "@seayoo-web/request": "^3.2.0",
+    "@seayoo-web/tsconfig": "^1.0.4",
     "@seayoo-web/utils": "^3.6.0"
   },
   "peerDependencies": {

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

@@ -1,6 +1,6 @@
 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" | "external_gift_code" | "void_item", false, false>;
+declare const rewardItemTypeValidator: import("@seayoo-web/utils").StringValidator<"credit" | "activation_key" | "event_item" | "game_item" | "physical_item" | "weixin_hongbao" | "external_gift_code" | "void_item", false, false>;
 declare const featureType: "lottery";
 export interface FeatureLotteryItemConfig {
     /** 抽奖奖励道具 id */

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

@@ -1,5 +1,5 @@
 import { type InferType } from "@seayoo-web/utils";
-declare const rewardItemTypeValidator: import("@seayoo-web/utils").StringValidator<"credit" | "event_item" | "game_item" | "physical_item" | "weixin_hongbao" | "external_gift_code" | "void_item", false, false>;
+declare const rewardItemTypeValidator: import("@seayoo-web/utils").StringValidator<"credit" | "activation_key" | "event_item" | "game_item" | "physical_item" | "weixin_hongbao" | "external_gift_code" | "void_item", false, false>;
 export interface EventRewardItemConfig {
     /** 玩法奖励道具 id */
     reward_item_id: number;

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

@@ -0,0 +1,228 @@
+import { type GamerItemType, EngageAccountType, EventPeriodType, FeatureType, QuestObjective, VoteOptionSource } from "./event.enums";
+export interface EventConfig {
+    /** 活动名称 */
+    event_name: string;
+    /** 面向玩家的富文本活动规则 */
+    rules: string;
+    /** 活动开始时间 */
+    since: number;
+    /** 活动结束时间 */
+    until: number;
+    /** 活动访问人数 */
+    visit_count?: number;
+    /** 活动下玩法列表 */
+    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> | EventFeatureBaseConfig<FeatureType.CheckIn, NoopFeatureConfig>;
+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: Exclude<GamerItemType, GamerItemType.GiftCode | GamerItemType.LotteryTicket>;
+    /** 奖励道具评级，用于前端展示 */
+    reward_item_rating: number;
+}
+export interface RegularReward {
+    engage_count: number;
+    rewards: EventRewardItemConfig[];
+}
+export type FeatureReward = {
+    feature_reward_type: "every";
+    reward_details: EventRewardItemConfig[];
+} | {
+    feature_reward_type: "regular";
+    reward_details: RegularReward[];
+};
+export type NoopFeatureConfig = {} | null;
+export interface EventFeatureBaseConfig<T extends FeatureType = FeatureType, C extends object | null = object> {
+    /** 玩法名称 */
+    feature_name: string;
+    /** 玩法 Id */
+    feature_id: number;
+    /** 玩法描述 */
+    description: string;
+    /** 玩法类型 */
+    feature_type: T;
+    /** 玩法配置 */
+    config?: C;
+    /** 玩法周期，即每多长时间可参与一次 */
+    cycle: EventPeriodType;
+    /** 允许的最大参与次数 */
+    limit: number;
+    /** 玩法开始时间 */
+    since: number;
+    /** 玩法结束时间 */
+    until: number;
+    /** 参与玩法维度账号类型 */
+    engage_account: EngageAccountType;
+    /** 玩法参与奖励 */
+    feature_rewards?: FeatureReward;
+}
+export interface FeatureLotteryItemConfig {
+    /** 抽奖奖励道具 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_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 interface FeatureSurveyConfig {
+    /** 问卷 ID */
+    survey_id: string;
+    /** 问卷 url 地址 */
+    survey_url: string;
+}
+export interface FeatureInviteConfig {
+    /** 邀请玩法配置分享链接 */
+    share_url: string;
+}
+export interface FeatureShareConfig {
+    /** 分享玩法配置分享平台 */
+    share_platform: string;
+    /** 分享玩法配置跳转地址 */
+    jump_url?: string;
+    /** 分享玩法分享平台图标 */
+    icon_url?: string;
+}
+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 interface FeatureSubscribeConfig {
+    /** 一组微信订阅消息模版 ID */
+    weixin_template_ids: string[];
+}
+export interface FeatureCommentConfig {
+    /** 活动配置的弹幕信息，用于快捷选择 */
+    comments: string[];
+    /** 发送频率限制，单位：秒 */
+    send_rate: number;
+}
+export interface FeatureVoteConfig {
+    /** 关联一个或多个投票玩法 ID */
+    vote_feature_ids: number[];
+    /** 关联一个或多个投稿玩法 ID */
+    submission_feature_ids: number[];
+    /** 入围数量 */
+    finalists_amount: number;
+    /** 选项来源 */
+    source: VoteOptionSource;
+    /** 投票选项配置 */
+    options: FeatureVoteOption[];
+    /** 投票入围后用户可获得的奖励 */
+    rewards: EventRewardItemConfig[];
+}
+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 FeatureCashbackConfig {
+    /** 计算充值总额的开始时间 */
+    order_start_time: number;
+    /** 计算充值总额的结束时间 */
+    order_end_time: number;
+    /** 可领取充值返还奖励的开始时间 */
+    claim_rewards_start_time: number;
+    /** 可领取充值返还奖励的结束时间 */
+    claim_rewards_end_time: number;
+}
+export interface FeatureGiftCodeConfig {
+    /** 用于前端显示礼包码兑换后会获得的奖励内容 */
+    gift_items: EventGiftItemConfig[];
+    /** 社媒平台链接 */
+    mp_url?: string;
+    /** 社媒平台二维码 */
+    mp_qrcode_url?: string;
+}
+export interface EventGiftItemConfig {
+    /** 用于前端展示的游戏道具名称 */
+    name: string;
+    /** 用于前端展示的游戏道具图片地址 */
+    icon_url: string;
+    /** 用于前端展示的游戏道具数量 */
+    count: number;
+}
+export interface FeatureQuestConfig {
+    /** 任务目标 */
+    objective: QuestObjective;
+    /** 目标值 */
+    completion_value: number;
+    /** 团队任务配置 */
+    team?: {
+        /** 组队任务 ID */
+        feature_id?: number;
+        /** 目标值 */
+        completion_value: number;
+    };
+}
+export interface FeatureTeamConfig {
+    /** 队伍最大成员数 */
+    max_members: number;
+    /** 队伍最小成员数 */
+    min_members: number;
+}
+export interface FeatureLotteryDrawConfig {
+    /** 可开奖起始时间 */
+    draw_not_before: number;
+    /** 可开奖结束时间 */
+    draw_not_after: number;
+}

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

@@ -11,6 +11,8 @@ export declare const GamerItemType: {
     readonly WeixinHongbao: "weixin_hongbao";
     /** 礼包码 */
     readonly GiftCode: "gift_code";
+    /** 激活码 */
+    readonly ActivationKey: "activation_key";
     /** 抽奖券 */
     readonly LotteryTicket: "lottery_ticket";
     /** 积分 */
@@ -42,6 +44,8 @@ export declare const RewardItemType: {
     readonly WeixinHongbao: "weixin_hongbao";
     /** 礼包码 */
     readonly GiftCode: "gift_code";
+    /** 激活码 */
+    readonly ActivationKey: "activation_key";
     /** 抽奖券 */
     readonly LotteryTicket: "lottery_ticket";
     /** 积分 */