@seayoo-web/gamer-api 2.4.5 → 2.5.1

package/package.json

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

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,11 +131,13 @@ 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";
     }>;
     /**
      * 用户领取除红包和实物奖励以外的所有奖励
      *
+     * @deprecated 请优先使用 `claimRewardsV2` 接口
+     *
      * https://kdocs.cn/l/ckWFDcOsYEUA?linkname=lCGuqgvUDP
      */
     claimRewards(params: {
@@ -144,6 +155,26 @@ export declare class EventApi {
         message: string;
         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";
     }>;
+    /**
+     * 用户领取除红包和实物奖励以外的所有奖励
+     *
+     * https://kdocs.cn/l/ckWFDcOsYEUA?linkname=vdc4SrqXjF
+     */
+    claimRewardsV2(params: {
+        /** 用户参与记录 ID */
+        engagement_id: number;
+        /** 产生奖励的来源 */
+        reward_source: RewardSource;
+        /** 游戏服务器 ID，领取游戏道具时为必填 */
+        server_id?: string | number;
+        /** 游戏角色 ID，领取游戏道具时为必填 */
+        role_id?: string;
+        /** 游戏角色名 */
+        role_name?: string;
+    }, requestOptions?: IRequestOptions): Promise<import("./event.engage").UserReward[] | {
+        message: string;
+        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";
+    }>;
     /**
      * 用户领取红包奖励
      *

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.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;
@@ -20,6 +23,9 @@ export declare const isEngageResponse: (data: unknown) => data is import("./even
 export declare const isClaimRewardsResponse: (data: unknown) => data is {
     claimed_items: import("./event.define").ClaimedItem[];
 };
+export declare const isClaimRewardsV2Response: (data: unknown) => data is {
+    rewards: import("./event.engage").UserReward[];
+};
 export declare const isClaimWeixinHongbaoResponse: (data: unknown) => data is {
     reward_status: import("./event.enums").ClaimRewardStatus;
 };