@seayoo-web/gamer-api 2.5.0 → 2.5.2

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@seayoo-web/gamer-api",
   "description": "agent for gamer api",
-  "version": "2.5.0",
+  "version": "2.5.2",
   "type": "module",
   "source": "index.ts",
   "main": "./dist/index.js",
@@ -31,14 +31,14 @@
   "devDependencies": {
     "@types/node": "^22.13.1",
     "@seayoo-web/combo-webview": "^2.5.4",
-    "@seayoo-web/scripts": "^2.6.0",
-    "@seayoo-web/request": "^3.2.0",
+    "@seayoo-web/utils": "^3.6.1",
     "@seayoo-web/tsconfig": "^1.0.4",
-    "@seayoo-web/utils": "^3.6.0"
+    "@seayoo-web/request": "^3.2.0",
+    "@seayoo-web/scripts": "^2.6.0"
   },
   "peerDependencies": {
     "@seayoo-web/combo-webview": "^2.5.4",
-    "@seayoo-web/utils": "^3.6.0"
+    "@seayoo-web/utils": "^3.6.1"
   },
   "scripts": {
     "prebuild": "pnpm -F request build && pnpm -F combo-webview build",

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.d.ts

@@ -73,6 +73,15 @@ export declare class EventApi {
         server_id: string;
         role_id: string;
     }, requestOptions?: IRequestOptions): Promise<import("./event.define").UserFeatureStatus[]>;
+    /**
+     * 获取用户在目标活动下的某个玩法的参与次数
+     *
+     * https://kdocs.cn/l/ckWFDcOsYEUA?linkname=uYCsjWyL36
+     */
+    getUserEngagementCount(featureId: number, option?: {
+        server_id: string;
+        role_id: string;
+    }): Promise<Record<string, number>>;
     /**
      * 获取当前登录用户参与某个玩法的记录
      *
@@ -122,7 +131,7 @@ export declare class EventApi {
         role_name?: string;
     }, requestOptions?: IRequestOptions): Promise<import("./event.define").EngageResponse | {
         message: string;
-        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" | "activation_group_not_found" | "activation_group_expired" | "no_claim_activation_key_eligibility" | "no_activation_key_available";
+        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" | "activation_group_not_found" | "activation_group_expired" | "no_claim_activation_key_eligibility" | "no_activation_key_available" | "activation_key_all_claimed";
     }>;
     /**
      * 用户领取除红包和实物奖励以外的所有奖励

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

@@ -11,6 +11,7 @@ import { type WeixinSubscribeEngagementData } from "./engage.subscribe";
 import { type SurveyEngagementData } from "./engage.survey";
 import { type TeamEngagementData } from "./engage.team";
 import { type VoteEngagementData } from "./engage.vote";
+import { type ZeroChatGPTData } from "./engage.zeroChatGPT";
 export * from "./engage.cashback";
 export * from "./engage.comment";
 export * from "./engage.giftcode";
@@ -26,7 +27,7 @@ export * from "./engage.team";
 export * from "./engage.vote";
 export * from "./engage.claimActivationKey";
 export type EmptyObject = Record<string | number | symbol, never>;
-export type UserEngagementData = PreregisterEngagementData | LotteryEngagementData | SurveyEngagementData | InviteEngagementData | ShareEngagementData | VoteEngagementData | WeixinSubscribeEngagementData | CashbackEngagementData | GiftCodeEngagementData | TeamEngagementData | QuestEngagementData | LotteryDrawEngagementData | ClaimActivationKeyEngagementData | EmptyObject;
+export type UserEngagementData = PreregisterEngagementData | LotteryEngagementData | SurveyEngagementData | InviteEngagementData | ShareEngagementData | VoteEngagementData | WeixinSubscribeEngagementData | CashbackEngagementData | GiftCodeEngagementData | TeamEngagementData | QuestEngagementData | LotteryDrawEngagementData | ClaimActivationKeyEngagementData | ZeroChatGPTData | EmptyObject;
 export declare const UserEngagementDataValidator: import("@seayoo-web/utils").UnionValidator<[import("@seayoo-web/utils").ObjectValidator<{
     platforms: string[];
 }, false, false>, import("@seayoo-web/utils").ObjectValidator<LotteryEngagementData, false, false>, import("@seayoo-web/utils").ObjectValidator<{
@@ -40,7 +41,12 @@ export declare const UserEngagementDataValidator: import("@seayoo-web/utils").Un
         status: /*elided*/ any;
         reward: /*elided*/ any;
     })[];
-}, false, false>, import("@seayoo-web/utils").ObjectValidator<ClaimActivationKeyEngagementData, false, false>, import("@seayoo-web/utils").CustomValidator<EmptyObject, false, false>], false, false> & {
+}, false, false>, import("@seayoo-web/utils").ObjectValidator<ClaimActivationKeyEngagementData, false, false>, import("@seayoo-web/utils").ObjectValidator<{
+    conversations: {
+        role: /*elided*/ any;
+        content: /*elided*/ any;
+    }[];
+}, false, false>, import("@seayoo-web/utils").CustomValidator<EmptyObject, false, false>], false, false> & {
     optional: never;
     maybeNull: never;
     key: never;

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

@@ -32,7 +32,11 @@ export interface UserReward {
     feature_type: FeatureType;
     /** 领奖时间 */
     receive_time: number;
-    /** 提供额外扩展信息，比如收获地址等 */
+    /**
+     * 提供额外扩展信息，比如收获地址等，由 reward_item_type 值决定
+     *
+     * https://kdocs.cn/l/ckWFDcOsYEUA?linkname=merUzJsVYH
+     */
     extra_data?: Record<string, unknown>;
 }
 export declare const UserRewardValidator: import("@seayoo-web/utils").ObjectValidator<UserReward, false, false>;

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

@@ -0,0 +1,21 @@
+export type ZeroChatGPTEngagementParam = {
+    /** 聊天内容 */
+    content: string;
+};
+export type Conversation = {
+    role: string;
+    content: string;
+};
+export type ZeroChatGPTData = {
+    conversations: Conversation[];
+};
+export declare const ConversationValidator: import("@seayoo-web/utils").ObjectValidator<{
+    role: string;
+    content: string;
+}, false, false>;
+export declare const ZeroChatGPTDataValidator: import("@seayoo-web/utils").ObjectValidator<{
+    conversations: {
+        role: /*elided*/ any;
+        content: /*elided*/ any;
+    }[];
+}, false, false>;

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

@@ -1,6 +1,7 @@
 import { type UserEngagementData, type CommentEngagementParam, type PreregisterEngagementParam, type LotteryEngagementParam, type LotteryDrawEngagementParam, type ShareEngagementParam, type SubscribeEngagementParam, type TeamEngagementParam, type VoteEngagementParam } from "./engage";
 import { type Reward } from "./reward";
 import type { FeatureType } from "../event.enums";
+import type { ZeroChatGPTEngagementParam } from "./engage.zeroChatGPT";
 export * from "./engage";
 export * from "./reward";
 export type UserEngagement = {
@@ -31,9 +32,9 @@ export declare const UserEngagementValidator: import("@seayoo-web/utils").Object
 /**
  * 部分玩法参与时需要提供的参数
  */
-export type EngagementParam = PreregisterEngagementParam | LotteryEngagementParam | CommentEngagementParam | ShareEngagementParam | VoteEngagementParam | SubscribeEngagementParam | TeamEngagementParam | LotteryDrawEngagementParam;
+export type EngagementParam = PreregisterEngagementParam | LotteryEngagementParam | CommentEngagementParam | ShareEngagementParam | VoteEngagementParam | SubscribeEngagementParam | TeamEngagementParam | LotteryDrawEngagementParam | ZeroChatGPTEngagementParam;
 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 : [T] extends ["team"] ? TeamEngagementParam : [T] extends ["lottery_draw"] ? LotteryDrawEngagementParam : null;
+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 : [T] extends ["team"] ? TeamEngagementParam : [T] extends ["lottery_draw"] ? LotteryDrawEngagementParam : [T] extends ["zero_chatgpt"] ? ZeroChatGPTEngagementParam : null;

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

@@ -142,6 +142,8 @@ export declare const FeatureType: {
     readonly CheckIn: "check_in";
     /** 领取激活码 */
     readonly ClaimActivationKey: "claim_activation_key";
+    /** 不朽箴言特有的 AI 聊天 */
+    readonly ZeroChatgpt: "zero_chatgpt";
 };
 export type FeatureType = ValueOf<typeof FeatureType>;
 export declare const FeatureTypeValidator: import("@seayoo-web/utils").StringValidator<FeatureType, false, false> & {

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

@@ -12,6 +12,9 @@ export declare const isEngagementsResponse: (data: unknown) => data is {
 export declare const isUserFeatureStatusResponse: (data: unknown) => data is {
     status: import("./event.define").UserFeatureStatus[];
 };
+export declare const isEngagementCountResponse: (data: unknown) => data is {
+    engagements_counts: Record<string, number>;
+};
 export declare const isUserEngagementsResponse: (data: unknown) => data is {
     engagements: import("./event.engage").UserEngagement[];
     next_token: string | undefined;