@seayoo-web/gamer-api 2.14.5 → 2.15.1

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@seayoo-web/gamer-api",
   "description": "agent for gamer api",
-  "version": "2.14.5",
+  "version": "2.15.1",
   "type": "module",
   "source": "index.ts",
   "main": "./dist/index.js",
@@ -30,9 +30,9 @@
   "license": "MIT",
   "devDependencies": {
     "@types/node": "^22.13.1",
-    "@seayoo-web/combo-webview": "2.8.0",
     "@seayoo-web/scripts": "3.1.6",
     "@seayoo-web/request": "3.4.2",
+    "@seayoo-web/combo-webview": "2.8.0",
     "@seayoo-web/tsconfig": "1.0.5",
     "@seayoo-web/utils": "4.1.3",
     "@seayoo-web/validator": "2.0.0"

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

@@ -11,6 +11,7 @@ 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 { EventFeatureConfigOfRedeem } from "./feature.redeem";
 import type { EventFeatureConfigOfRegister } from "./feature.register";
 import type { EventFeatureConfigOfShare } from "./feature.share";
 import type { EventFeatureConfigOfSubscribe } from "./feature.subscribe";
@@ -43,5 +44,6 @@ export * from "./feature.vote2";
 export * from "./feature.claimActivationKey";
 export * from "./feature.ugc";
 export * from "./feature.ugcLike";
-export type EventFeatureConfig = EventFeatureConfigOfCashback | EventFeatureConfigOfCheckIn | EventFeatureConfigOfClaimRewards | EventFeatureConfigOfComment | EventFeatureConfigOfFollow | EventFeatureConfigOfGiftCode | EventFeatureConfigOfInvite | EventFeatureConfigOfInvitedRegister | EventFeatureConfigOfLottery | EventFeatureConfigOfLotteryDraw | EventFeatureConfigOfPreregister | EventFeatureConfigOfQuest | EventFeatureConfigOfRegister | EventFeatureConfigOfShare | EventFeatureConfigOfSubscribe | EventFeatureConfigOfSurvey | EventFeatureConfigOfTeam | EventFeatureConfigOfVote | EventFeatureConfigOfVote2 | EventFeatureConfigOfClaimActivationKey | EventFeatureConfigOfZeroChatgpt | EventFeatureConfigOfUgc | EventFeatureConfigOfUgcLike;
-export declare const EventFeatureConfigValidator: import("@seayoo-web/validator").UnionValidator<[import("@seayoo-web/validator").ObjectValidator<EventFeatureConfigOfCashback, false, false>, import("@seayoo-web/validator").ObjectValidator<EventFeatureConfigOfCheckIn, false, false>, import("@seayoo-web/validator").ObjectValidator<EventFeatureConfigOfClaimRewards, false, false>, import("@seayoo-web/validator").ObjectValidator<EventFeatureConfigOfComment, false, false>, import("@seayoo-web/validator").ObjectValidator<EventFeatureConfigOfFollow, false, false>, import("@seayoo-web/validator").ObjectValidator<EventFeatureConfigOfGiftCode, false, false>, import("@seayoo-web/validator").ObjectValidator<EventFeatureConfigOfInvite, false, false>, import("@seayoo-web/validator").ObjectValidator<EventFeatureConfigOfInvitedRegister, false, false>, import("@seayoo-web/validator").ObjectValidator<EventFeatureConfigOfLottery, false, false>, import("@seayoo-web/validator").ObjectValidator<EventFeatureConfigOfLotteryDraw, false, false>, import("@seayoo-web/validator").ObjectValidator<EventFeatureConfigOfPreregister, false, false>, import("@seayoo-web/validator").ObjectValidator<EventFeatureConfigOfQuest, false, false>, import("@seayoo-web/validator").ObjectValidator<EventFeatureConfigOfRegister, false, false>, import("@seayoo-web/validator").ObjectValidator<EventFeatureConfigOfShare, false, false>, import("@seayoo-web/validator").ObjectValidator<EventFeatureConfigOfSubscribe, false, false>, import("@seayoo-web/validator").ObjectValidator<EventFeatureConfigOfSurvey, false, false>, import("@seayoo-web/validator").ObjectValidator<EventFeatureConfigOfTeam, false, false>, import("@seayoo-web/validator").ObjectValidator<EventFeatureConfigOfVote, false, false>, import("@seayoo-web/validator").ObjectValidator<EventFeatureConfigOfVote2, false, false>, import("@seayoo-web/validator").ObjectValidator<EventFeatureConfigOfClaimActivationKey, false, false>, import("@seayoo-web/validator").ObjectValidator<EventFeatureConfigOfZeroChatgpt, false, false>, import("@seayoo-web/validator").ObjectValidator<EventFeatureConfigOfUgc, false, false>, import("@seayoo-web/validator").ObjectValidator<EventFeatureConfigOfUgcLike, false, false>], false, false>;
+export * from "./feature.redeem";
+export type EventFeatureConfig = EventFeatureConfigOfCashback | EventFeatureConfigOfCheckIn | EventFeatureConfigOfClaimRewards | EventFeatureConfigOfComment | EventFeatureConfigOfFollow | EventFeatureConfigOfGiftCode | EventFeatureConfigOfInvite | EventFeatureConfigOfInvitedRegister | EventFeatureConfigOfLottery | EventFeatureConfigOfLotteryDraw | EventFeatureConfigOfPreregister | EventFeatureConfigOfQuest | EventFeatureConfigOfRegister | EventFeatureConfigOfShare | EventFeatureConfigOfSubscribe | EventFeatureConfigOfSurvey | EventFeatureConfigOfTeam | EventFeatureConfigOfVote | EventFeatureConfigOfVote2 | EventFeatureConfigOfClaimActivationKey | EventFeatureConfigOfZeroChatgpt | EventFeatureConfigOfUgc | EventFeatureConfigOfUgcLike | EventFeatureConfigOfRedeem;
+export declare const EventFeatureConfigValidator: import("@seayoo-web/validator").UnionValidator<[import("@seayoo-web/validator").ObjectValidator<EventFeatureConfigOfCashback, false, false>, import("@seayoo-web/validator").ObjectValidator<EventFeatureConfigOfCheckIn, false, false>, import("@seayoo-web/validator").ObjectValidator<EventFeatureConfigOfClaimRewards, false, false>, import("@seayoo-web/validator").ObjectValidator<EventFeatureConfigOfComment, false, false>, import("@seayoo-web/validator").ObjectValidator<EventFeatureConfigOfFollow, false, false>, import("@seayoo-web/validator").ObjectValidator<EventFeatureConfigOfGiftCode, false, false>, import("@seayoo-web/validator").ObjectValidator<EventFeatureConfigOfInvite, false, false>, import("@seayoo-web/validator").ObjectValidator<EventFeatureConfigOfInvitedRegister, false, false>, import("@seayoo-web/validator").ObjectValidator<EventFeatureConfigOfLottery, false, false>, import("@seayoo-web/validator").ObjectValidator<EventFeatureConfigOfLotteryDraw, false, false>, import("@seayoo-web/validator").ObjectValidator<EventFeatureConfigOfPreregister, false, false>, import("@seayoo-web/validator").ObjectValidator<EventFeatureConfigOfQuest, false, false>, import("@seayoo-web/validator").ObjectValidator<EventFeatureConfigOfRegister, false, false>, import("@seayoo-web/validator").ObjectValidator<EventFeatureConfigOfShare, false, false>, import("@seayoo-web/validator").ObjectValidator<EventFeatureConfigOfSubscribe, false, false>, import("@seayoo-web/validator").ObjectValidator<EventFeatureConfigOfSurvey, false, false>, import("@seayoo-web/validator").ObjectValidator<EventFeatureConfigOfTeam, false, false>, import("@seayoo-web/validator").ObjectValidator<EventFeatureConfigOfVote, false, false>, import("@seayoo-web/validator").ObjectValidator<EventFeatureConfigOfVote2, false, false>, import("@seayoo-web/validator").ObjectValidator<EventFeatureConfigOfClaimActivationKey, false, false>, import("@seayoo-web/validator").ObjectValidator<EventFeatureConfigOfZeroChatgpt, false, false>, import("@seayoo-web/validator").ObjectValidator<EventFeatureConfigOfUgc, false, false>, import("@seayoo-web/validator").ObjectValidator<EventFeatureConfigOfUgcLike, false, false>, import("@seayoo-web/validator").ObjectValidator<EventFeatureConfigOfRedeem, false, false>], false, false>;

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

@@ -0,0 +1,24 @@
+import type { EventFeatureBaseConfig } from "./feature.base";
+import type { EventRewardItemConfig } from "./reward";
+declare const featureType: "redeem";
+export interface FeatureRedeemItemConfig {
+    /** 价格，即消耗多少个兑换道具 */
+    price: number;
+    /** 每个用户可兑换的最大数量 */
+    per_user_limit: number;
+    /** 道具 */
+    item: EventRewardItemConfig;
+}
+export declare const FeatureRedeemItemConfigValidator: import("@seayoo-web/validator").ObjectValidator<FeatureRedeemItemConfig, false, false>;
+export interface FeatureRedeemConfig {
+    /** 兑换消耗道具 id */
+    event_item_id: number;
+    /** 兑换列表 */
+    redeem_catalog: FeatureRedeemItemConfig[];
+}
+export type EventFeatureConfigOfRedeem = EventFeatureBaseConfig & {
+    feature_type: typeof featureType;
+    config: FeatureRedeemConfig;
+};
+export declare const EventFeatureConfigOfRedeemValidator: import("@seayoo-web/validator").ObjectValidator<EventFeatureConfigOfRedeem, false, false>;
+export {};

package/types/src/event.d.ts

@@ -432,4 +432,13 @@ export declare class EventApi {
         message: string;
         error: RequestInternalError | "event_not_found" | "feature_not_found";
     } | null>;
+    /**
+     * 查询兑换玩法的物品剩余库存（含用户可兑换数量）
+     *
+     * https://www.kdocs.cn/l/ckWFDcOsYEUA?linkname=gOqT9svLF7
+     */
+    getRedeemItemStocks(featureId: number, requestOptions?: IRequestOptions): Promise<import("./event.engage").RedeemStocksResponse | {
+        message: string;
+        error: RequestInternalError | "event_not_found" | "feature_not_found";
+    } | null>;
 }

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

@@ -6,6 +6,7 @@ import type { LotteryEngagementData } from "./engage.lottery";
 import type { LotteryDrawEngagementData } from "./engage.lotteryDraw";
 import type { PreregisterEngagementData } from "./engage.preregister";
 import type { QuestEngagementData } from "./engage.quest";
+import type { RedeemEngagementData } from "./engage.redeem";
 import type { ShareEngagementData } from "./engage.share";
 import type { WeixinSubscribeEngagementData } from "./engage.subscribe";
 import type { SurveyEngagementData } from "./engage.survey";
@@ -32,8 +33,9 @@ export * from "./engage.claimActivationKey";
 export * from "./engage.zeroChatGPT";
 export * from "./engage.ugc";
 export * from "./engage.ugcLike";
+export * from "./engage.redeem";
 export type EmptyObject = Record<string | number | symbol, never>;
-export type UserEngagementData = PreregisterEngagementData | LotteryEngagementData | SurveyEngagementData | InviteEngagementData | ShareEngagementData | VoteEngagementData | Vote2EngagementData | WeixinSubscribeEngagementData | CashbackEngagementData | GiftCodeEngagementData | TeamEngagementData | QuestEngagementData | LotteryDrawEngagementData | ClaimActivationKeyEngagementData | ZeroChatGPTData | UgcEngagementData | EmptyObject;
+export type UserEngagementData = PreregisterEngagementData | LotteryEngagementData | SurveyEngagementData | InviteEngagementData | ShareEngagementData | VoteEngagementData | Vote2EngagementData | WeixinSubscribeEngagementData | CashbackEngagementData | GiftCodeEngagementData | TeamEngagementData | QuestEngagementData | LotteryDrawEngagementData | ClaimActivationKeyEngagementData | ZeroChatGPTData | UgcEngagementData | RedeemEngagementData | EmptyObject;
 export declare const UserEngagementDataValidator: import("@seayoo-web/validator").UnionValidator<[import("@seayoo-web/validator").ObjectValidator<{
     platforms: string[];
 }, false, false>, import("@seayoo-web/validator").ObjectValidator<LotteryEngagementData, false, false>, import("@seayoo-web/validator").ObjectValidator<{
@@ -52,7 +54,7 @@ export declare const UserEngagementDataValidator: import("@seayoo-web/validator"
         role: /*elided*/ any;
         content: /*elided*/ any;
     }[];
-}, false, false>, import("@seayoo-web/validator").ObjectValidator<UgcEngagementData, false, false>, import("@seayoo-web/validator").CustomValidator<EmptyObject, false, false>], false, false> & {
+}, false, false>, import("@seayoo-web/validator").ObjectValidator<UgcEngagementData, false, false>, import("@seayoo-web/validator").ObjectValidator<RedeemEngagementData, false, false>, import("@seayoo-web/validator").CustomValidator<EmptyObject, false, false>], false, false> & {
     desc: never;
     optional: never;
     maybeNull: never;

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

@@ -0,0 +1,25 @@
+export interface RedeemEngagementData {
+    item_id: number;
+    item_count: number;
+    redeem_count: number;
+}
+export declare const RedeemEngagementDataValidator: import("@seayoo-web/validator").ObjectValidator<RedeemEngagementData, false, false>;
+export interface RedeemEngagementParam {
+    /** 道具 id */
+    item_id: number;
+    /** 兑换的数量 */
+    redeem_count: number;
+}
+export type RedeemEngagementError = "item_stock_not_enough";
+export interface RedeemStock {
+    /** 道具 ID */
+    item_id: number;
+    /** 剩余库存 */
+    item_stock: number;
+    /** 用户剩余可兑换次数 */
+    user_limit: number;
+}
+export interface RedeemStocksResponse {
+    item_stocks: Array<RedeemStock>;
+}
+export declare const RedeemStocksResponseValidator: import("@seayoo-web/validator").ObjectValidator<RedeemStocksResponse, false, false>;

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

@@ -1,4 +1,4 @@
-import type { UserEngagementData, CommentEngagementParam, PreregisterEngagementParam, LotteryEngagementParam, LotteryDrawEngagementParam, ShareEngagementParam, SubscribeEngagementParam, TeamEngagementParam, VoteEngagementParam, Vote2EngagementParam, UgcEngagementParam, UgcLikeEngagementParam, Vote2EngagementError, LotteryEngagementError, ClaimActivationKeyEngagementError, LotteryDrawEngagementError, TeamEngagementError, GiftCodeEngagementError } from "./engage";
+import type { UserEngagementData, CommentEngagementParam, PreregisterEngagementParam, LotteryEngagementParam, LotteryDrawEngagementParam, ShareEngagementParam, SubscribeEngagementParam, TeamEngagementParam, VoteEngagementParam, Vote2EngagementParam, UgcEngagementParam, UgcLikeEngagementParam, Vote2EngagementError, LotteryEngagementError, ClaimActivationKeyEngagementError, LotteryDrawEngagementError, TeamEngagementError, GiftCodeEngagementError, RedeemEngagementParam, RedeemEngagementError } from "./engage";
 import type { Reward } from "./reward";
 import type { FeatureType } from "../event.enums";
 import type { ZeroChatGPTEngagementParam } from "./engage.zeroChatGPT";
@@ -38,10 +38,10 @@ export type EngagementFeatureType = FeatureType | unknown;
 /**
  * 根据玩法类型推导需要提交的参数数据类型
  */
-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 : [T] extends ["ugc"] ? UgcEngagementParam : [T] extends ["ugc_like"] ? UgcLikeEngagementParam : EngagementParam;
+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 : [T] extends ["ugc"] ? UgcEngagementParam : [T] extends ["ugc_like"] ? UgcLikeEngagementParam : [T] extends ["redeem"] ? RedeemEngagementParam : 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 EngagementError = EngagementCommonError | TeamEngagementError | Vote2EngagementError | ClaimActivationKeyEngagementError | LotteryDrawEngagementError | LotteryEngagementError | GiftCodeEngagementError | RedeemEngagementError;
 /**
  * 根据玩法类型推导额外的错误字段
  */
-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;
+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 : [T] extends ["redeem"] ? RedeemEngagementError : EngagementError) | EngagementCommonError;

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

@@ -158,6 +158,8 @@ export declare const FeatureType: {
     readonly Ugc: "ugc";
     /** 投稿点赞 */
     readonly UgcLike: "ugc_like";
+    /** 兑换 */
+    readonly Redeem: "redeem";
 };
 export type FeatureType = ValueOf<typeof FeatureType>;
 export declare const FeatureTypeValidator: import("@seayoo-web/validator").StringValidator<FeatureType, false, false> & {
@@ -193,8 +195,12 @@ export declare const QuestObjective: {
     readonly PlayerLevel: "player_level";
     /** 活动道具累计获取 */
     readonly EventItems: "event_items";
-    /**游戏内任务 */
+    /** 游戏内任务 */
     readonly GameTask: "game_task";
+    /** 游戏内充值金额 */
+    readonly OrderAmountInApp: "order_in_app_total_amount";
+    /** 支付中心充值金额 */
+    readonly OrderAmountInPayCenter: "order_seayoo_web_total_amount";
 };
 export type QuestObjective = ValueOf<typeof QuestObjective>;
 export declare const QuestObjectiveValidator: import("@seayoo-web/validator").StringValidator<QuestObjective, false, false> & {
@@ -282,7 +288,7 @@ export declare const RewardStatusSuffixValidator: import("@seayoo-web/validator"
     lock: never;
 };
 /**
- * 奖励状态，兼容后端拼写错误的版本
+ * 奖励状态
  */
 export declare const ClaimRewardStatus: {
     /** 未获得奖励 */

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

@@ -61,3 +61,4 @@ export declare const isUgcUploadImageResponse: (data: unknown) => data is {
     image_url: string;
 };
 export declare const isUgcLeaderboardResponse: (data: unknown) => data is import("./event.engage").UgcLeaderboardResponse;
+export declare const isRedeemItemStockResponse: (data: unknown) => data is import("./event.engage").RedeemStocksResponse;

package/types/src/utils.d.ts

@@ -1,4 +1,4 @@
-export declare const console: Pick<Console, "error" | "log" | "warn">;
+export declare const console: Pick<Console, "log" | "error" | "warn">;
 /** 检测是否在 combo webview */
 export declare function inComboWebview(): boolean;
 export declare function isRootEndpoint(path: string): boolean;