@seayoo-web/gamer-api 2.10.9 → 2.10.10

package/dist/index.js

@@ -1465,7 +1465,7 @@ class Yr {
   /**
    * 用户参与某个玩法
    *
-   * 💡可以设置泛型参数来快速确定 engagementParam 数据类型
+   * 💡可以设置泛型参数来快速确定 engagementParam 数据类型和返回值
    *
    * 💡需要先调用 `visit` 接口提交访问信息
    *
@@ -1486,7 +1486,6 @@ class Yr {
     return o ?? {
       message: p,
       error: g
-      //  您的道具数量不足，请先获取足够的道具
     };
   }
   /**

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@seayoo-web/gamer-api",
   "description": "agent for gamer api",
-  "version": "2.10.9",
+  "version": "2.10.10",
   "type": "module",
   "source": "index.ts",
   "main": "./dist/index.js",
@@ -30,11 +30,11 @@
   "license": "MIT",
   "devDependencies": {
     "@types/node": "^22.13.1",
+    "@seayoo-web/request": "3.4.0",
     "@seayoo-web/combo-webview": "2.7.0",
+    "@seayoo-web/scripts": "3.1.3",
     "@seayoo-web/tsconfig": "1.0.5",
     "@seayoo-web/utils": "4.1.3",
-    "@seayoo-web/request": "3.4.0",
-    "@seayoo-web/scripts": "3.1.3",
     "@seayoo-web/validator": "1.1.1"
   },
   "peerDependencies": {

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

@@ -1,6 +1,6 @@
 import { type InferType } from "@seayoo-web/validator";
 import { type EventFeatureBaseConfig } from "./feature.base";
-declare const rewardItemTypeValidator: import("@seayoo-web/validator").StringValidator<"event_item" | "game_item" | "physical_item" | "weixin_hongbao" | "activation_key" | "credit" | "external_gift_code" | "void_item", false, false>;
+declare const rewardItemTypeValidator: import("@seayoo-web/validator").StringValidator<"activation_key" | "event_item" | "game_item" | "physical_item" | "weixin_hongbao" | "credit" | "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/validator";
-declare const rewardItemTypeValidator: import("@seayoo-web/validator").StringValidator<"event_item" | "game_item" | "physical_item" | "weixin_hongbao" | "gift_code" | "activation_key" | "lottery_ticket" | "credit" | "external_gift_code" | "void_item", false, false>;
+declare const rewardItemTypeValidator: import("@seayoo-web/validator").StringValidator<"activation_key" | "gift_code" | "event_item" | "game_item" | "physical_item" | "weixin_hongbao" | "lottery_ticket" | "credit" | "external_gift_code" | "void_item", false, false>;
 export interface EventRewardItemConfig {
     /** 玩法奖励道具 id */
     reward_item_id: number;

package/types/src/event.d.ts

@@ -1,4 +1,4 @@
-import type { EngagementFeatureType, InferEngagementParam } from "./event.define";
+import type { EngagementFeatureType, InferEngagementError, InferEngagementParam } from "./event.define";
 import type { GamerItemType, RewardSource } from "./event.enums";
 import type { AuthToken } from "./token";
 import type { RequestInternalError, IRequestOptions } from "@seayoo-web/request";
@@ -110,7 +110,7 @@ export declare class EventApi {
     /**
      * 用户参与某个玩法
      *
-     * 💡可以设置泛型参数来快速确定 engagementParam 数据类型
+     * 💡可以设置泛型参数来快速确定 engagementParam 数据类型和返回值
      *
      * 💡需要先调用 `visit` 接口提交访问信息
      *
@@ -129,7 +129,7 @@ export declare class EventApi {
         role_name?: string;
     }, requestOptions?: IRequestOptions): Promise<import("./event.define").EngageResponse | {
         message: string;
-        error: RequestInternalError | "event_not_found" | "visit_record_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" | "vote_not_started" | "vote_already_ended" | "vote_candidate_not_found" | "consume_item_not_enough";
+        error: RequestInternalError | InferEngagementError<T>;
     }>;
     /**
      * 用户领取除红包和实物奖励以外的所有奖励

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

@@ -3,3 +3,4 @@ export interface ClaimActivationKeyEngagementData {
     activation_key: string;
 }
 export declare const ClaimActivationKeyEngagementDataValidator: import("@seayoo-web/validator").ObjectValidator<ClaimActivationKeyEngagementData, false, false>;
+export type ClaimActivationKeyEngagementError = "activation_group_not_found" | "activation_group_expired" | "no_claim_activation_key_eligibility" | "no_activation_key_available";

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

@@ -20,3 +20,4 @@ export interface CommentEngagementParam {
     /** 用户发布弹幕的视频点 */
     video_note?: number;
 }
+export type CommentEngagementError = "comment_too_frequently";

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

@@ -3,3 +3,4 @@ export interface GiftCodeEngagementData {
     gift_code: string;
 }
 export declare const GiftCodeEngagementDataValidator: import("@seayoo-web/validator").ObjectValidator<GiftCodeEngagementData, false, false>;
+export type GiftCodeEngagementError = "unique_gift_code_is_empty";

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

@@ -7,3 +7,4 @@ export interface LotteryEngagementParam {
     /** 用户抽奖次数 */
     lottery_count: number;
 }
+export type LotteryEngagementError = "lottery_reward_is_empty";

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

@@ -38,3 +38,4 @@ export type LotteryDrawEngagementParam = {
     /** 抽奖券 */
     ticket: string;
 };
+export type LotteryDrawEngagementError = "draw_lottery_ticket_not_start" | "draw_lottery_ticket_is_ended" | "lottery_ticket_not_found" | "invalid_engage_lottery_draw_ticket";

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

@@ -40,3 +40,4 @@ export type QuestProgress = {
     team?: QuestProgressTeam;
 };
 export declare const QuestProgressValidator: import("@seayoo-web/validator").ObjectValidator<QuestProgress, false, false>;
+export type QuestEngagementError = "player_created_at_out_of_range" | "query_user_order_total_amount_err";

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

@@ -51,3 +51,4 @@ export type TeamEngagementParam = {
     /** 组队码 */
     team_code?: string;
 };
+export type TeamEngagementError = "team_not_found" | "team_is_full" | "user_had_joined_a_team" | "join_team_conflict" | "team_has_been_disbanded" | "exceeded_assembled_team_limit" | "change_team_visibility_not_allowed" | "disband_team_not_allowed";

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

@@ -36,3 +36,4 @@ export interface CandidateVote {
     my_votes: number;
 }
 export declare const CandidateVoteValidator: import("@seayoo-web/validator").ObjectValidator<CandidateVote, false, false>;
+export type Vote2EngagementError = "vote_not_started" | "vote_already_ended" | "vote_candidate_not_found" | "consume_item_not_enough";

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

@@ -1,4 +1,4 @@
-import { type UserEngagementData, type CommentEngagementParam, type PreregisterEngagementParam, type LotteryEngagementParam, type LotteryDrawEngagementParam, type ShareEngagementParam, type SubscribeEngagementParam, type TeamEngagementParam, type VoteEngagementParam, type Vote2EngagementParam } from "./engage";
+import { type UserEngagementData, type CommentEngagementParam, type PreregisterEngagementParam, type LotteryEngagementParam, type LotteryDrawEngagementParam, type ShareEngagementParam, type SubscribeEngagementParam, type TeamEngagementParam, type VoteEngagementParam, type Vote2EngagementParam, type Vote2EngagementError, type LotteryEngagementError, type ClaimActivationKeyEngagementError, type LotteryDrawEngagementError, type TeamEngagementError, type GiftCodeEngagementError } from "./engage";
 import { type Reward } from "./reward";
 import type { FeatureType } from "../event.enums";
 import type { ZeroChatGPTEngagementParam } from "./engage.zeroChatGPT";
@@ -37,4 +37,10 @@ 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 ["vote2"] ? Vote2EngagementParam : [T] extends ["weixin_subscribe"] ? SubscribeEngagementParam : [T] extends ["team"] ? TeamEngagementParam : [T] extends ["lottery_draw"] ? LotteryDrawEngagementParam : [T] extends ["zero_chatgpt"] ? ZeroChatGPTEngagementParam : null;
+export type InferEngagementParam<T extends EngagementFeatureType> = [T] extends ["preregister"] ? PreregisterEngagementParam : [T] extends ["lottery"] ? LotteryEngagementParam : [T] extends ["comment"] ? CommentEngagementParam : [T] extends ["share"] ? ShareEngagementParam : [T] extends ["vote"] ? VoteEngagementParam : [T] extends ["vote2"] ? Vote2EngagementParam : [T] extends ["weixin_subscribe"] ? SubscribeEngagementParam : [T] extends ["team"] ? TeamEngagementParam : [T] extends ["lottery_draw"] ? LotteryDrawEngagementParam : [T] extends ["zero_chatgpt"] ? ZeroChatGPTEngagementParam : EngagementParam;
+export type EngagementCommonError = "invalid_token" | "event_not_found" | "feature_not_found" | "visit_record_not_found" | "event_not_started" | "event_already_ended" | "engage_feature_reached_limit" | "invalid_merchant_parameter" | "budget_not_enough" | "combo_id_not_found";
+export type EngagementError = EngagementCommonError | TeamEngagementError | Vote2EngagementError | ClaimActivationKeyEngagementError | LotteryDrawEngagementError | LotteryEngagementError | GiftCodeEngagementError;
+/**
+ * 根据玩法类型推导额外的错误字段
+ */
+export type InferEngagementError<T extends EngagementFeatureType> = ([T] extends ["vote2"] ? Vote2EngagementError : [T] extends ["claim_activation_key"] ? ClaimActivationKeyEngagementError : [T] extends ["lottery"] ? LotteryEngagementError : [T] extends ["lottery_draw"] ? LotteryDrawEngagementError : [T] extends ["team"] ? TeamEngagementError : [T] extends ["gift_code"] ? GiftCodeEngagementError : EngagementError) | EngagementCommonError;