@seayoo-web/gamer-api 4.2.2 → 4.3.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@seayoo-web/gamer-api",
-  "version": "4.2.2",
+  "version": "4.3.2",
   "description": "agent for gamer api",
   "license": "MIT",
   "author": "web@seayoo.com",
@@ -27,17 +27,17 @@
   },
   "devDependencies": {
     "@types/node": "^22.13.1",
-    "@seayoo-web/scripts": "4.3.6",
-    "@seayoo-web/utils": "4.4.1",
     "@seayoo-web/combo-webview": "2.9.7",
     "@seayoo-web/request": "4.1.0",
+    "@seayoo-web/scripts": "4.3.6",
     "@seayoo-web/tsconfig": "1.0.6",
+    "@seayoo-web/utils": "4.4.1",
     "@seayoo-web/validator": "2.3.0"
   },
   "peerDependencies": {
     "@seayoo-web/combo-webview": "^2.9.7",
-    "@seayoo-web/validator": "^2.3.0",
-    "@seayoo-web/utils": "^4.4.1"
+    "@seayoo-web/utils": "^4.4.1",
+    "@seayoo-web/validator": "^2.3.0"
   },
   "engines": {
     "node": ">=22"

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

@@ -12,6 +12,7 @@ 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 { EventFeatureConfigOfReferral } from "./feature.referral";
 import type { EventFeatureConfigOfRegister } from "./feature.register";
 import type { EventFeatureConfigOfShare } from "./feature.share";
 import type { EventFeatureConfigOfSubscribe } from "./feature.subscribe";
@@ -45,5 +46,6 @@ export * from "./feature.claimActivationKey";
 export * from "./feature.ugc";
 export * from "./feature.ugcLike";
 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>;
+export * from "./feature.referral";
+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 | EventFeatureConfigOfReferral;
+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>, import("@seayoo-web/validator").ObjectValidator<EventFeatureConfigOfReferral, false, false>], false, false>;

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

@@ -0,0 +1,22 @@
+import { type Reward } from "../event.engage";
+import type { EventFeatureBaseConfig } from "./feature.base";
+declare const featureType: "referral";
+export interface FeatureReferralConfig {
+    /** 允许返回的最近被邀请人最大数量 */
+    max_recent_invitees: number;
+    /** 分级奖励配置 */
+    referral_tier: FeatureReferralTierItem[];
+}
+export interface FeatureReferralTierItem {
+    /** 邀请数量要求 */
+    required_invitees: number;
+    /** 奖励 */
+    rewards: Reward[];
+}
+export declare const FeatureReferralTierItemValidator: import("@seayoo-web/validator").ObjectValidator<FeatureReferralTierItem, false, false>;
+export type EventFeatureConfigOfReferral = EventFeatureBaseConfig & {
+    feature_type: typeof featureType;
+    config: FeatureReferralConfig;
+};
+export declare const EventFeatureConfigOfReferralValidator: import("@seayoo-web/validator").ObjectValidator<EventFeatureConfigOfReferral, false, false>;
+export {};

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

@@ -7,6 +7,7 @@ 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 { ReferralEngagementData } from "./engage.referral";
 import type { ShareEngagementData } from "./engage.share";
 import type { WeixinSubscribeEngagementData } from "./engage.subscribe";
 import type { SurveyEngagementData } from "./engage.survey";
@@ -34,8 +35,9 @@ export * from "./engage.zeroChatGPT";
 export * from "./engage.ugc";
 export * from "./engage.ugcLike";
 export * from "./engage.redeem";
+export * from "./engage.referral";
 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 | RedeemEngagementData | EmptyObject;
+export type UserEngagementData = PreregisterEngagementData | LotteryEngagementData | SurveyEngagementData | InviteEngagementData | ShareEngagementData | VoteEngagementData | Vote2EngagementData | WeixinSubscribeEngagementData | CashbackEngagementData | GiftCodeEngagementData | TeamEngagementData | QuestEngagementData | LotteryDrawEngagementData | ClaimActivationKeyEngagementData | ZeroChatGPTData | UgcEngagementData | RedeemEngagementData | ReferralEngagementData | 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<{
@@ -56,7 +58,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").ObjectValidator<RedeemEngagementData, 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").ObjectValidator<ReferralEngagementData, false, false>, import("@seayoo-web/validator").CustomValidator<EmptyObject, false, false>], false, false> & {
     optional: never;
     maybeNull: never;
     key: never;

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

@@ -0,0 +1,48 @@
+import { type UserReward } from "./engage.lotteryDraw.reward";
+import type { ReferralAction } from "../event.enums";
+export interface ReferralInvite {
+    avatar_url?: string;
+    role_name: string;
+    server_name: string;
+}
+export declare const ReferralInviteValidator: import("@seayoo-web/validator").ObjectValidator<ReferralInvite, false, false>;
+export interface ReferralEngagementData {
+    /** 邀请码 */
+    referral_code?: string;
+    /** 已邀请人数（真实邀请人数） */
+    invitee_count?: number;
+    /** 被邀请人列表，受 max_recent_invitees 配置限制返回条数 */
+    invitees?: ReferralInvite[];
+}
+export declare const ReferralEngagementDataValidator: import("@seayoo-web/validator").ObjectValidator<ReferralEngagementData, false, false>;
+export type ReferralEngagementParam = {
+    /** 操作类型 */
+    action: typeof ReferralAction.Share;
+} | {
+    /** 操作类型 */
+    action: typeof ReferralAction.Join;
+    /** 邀请码 */
+    referral_code: string;
+} | {
+    /** 操作类型 */
+    action: typeof ReferralAction.Query;
+};
+export type ReferralEngagementError = "referral_code_required" | "referral_code_invalid" | "referral_code_not_found" | "cannot_invite_self" | "user_already_invited";
+export interface GenerateReferralRewardsResponse {
+    /** 已邀请人数 */
+    invitee_count?: number;
+    /** 本次获得的奖励 */
+    generated_rewards?: UserReward[];
+    /** 阶梯邀请奖励状态 */
+    referral_tier_status?: ReferralTierStatus[];
+}
+export interface ReferralTierStatus {
+    /** 邀请邀请人数 */
+    required_invitees: number;
+    /** 是否已解锁（达到邀请人数要求） */
+    unlocked: boolean;
+    /** 是否已获得 */
+    generated: boolean;
+}
+export declare const ReferralTierStatusValidator: import("@seayoo-web/validator").ObjectValidator<ReferralTierStatus, false, false>;
+export declare const GenerateReferralRewardsResponseValidator: import("@seayoo-web/validator").ObjectValidator<GenerateReferralRewardsResponse, false, false>;

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

@@ -1,5 +1,6 @@
 import type { FeatureType } from "../event.enums";
 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 { ReferralEngagementError, ReferralEngagementParam } from "./engage.referral";
 import type { ZeroChatGPTEngagementParam } from "./engage.zeroChatGPT";
 import type { Reward } from "./reward";
 export * from "./engage";
@@ -32,15 +33,15 @@ export declare const UserEngagementValidator: import("@seayoo-web/validator").Ob
 /**
  * 部分玩法参与时需要提供的参数
  */
-export type EngagementParam = null | PreregisterEngagementParam | LotteryEngagementParam | CommentEngagementParam | ShareEngagementParam | VoteEngagementParam | Vote2EngagementParam | SubscribeEngagementParam | TeamEngagementParam | LotteryDrawEngagementParam | ZeroChatGPTEngagementParam | UgcEngagementParam | UgcLikeEngagementParam;
+export type EngagementParam = null | PreregisterEngagementParam | LotteryEngagementParam | CommentEngagementParam | ShareEngagementParam | VoteEngagementParam | Vote2EngagementParam | SubscribeEngagementParam | TeamEngagementParam | LotteryDrawEngagementParam | ZeroChatGPTEngagementParam | UgcEngagementParam | UgcLikeEngagementParam | RedeemEngagementParam | ReferralEngagementParam;
 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 | null : [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 InferEngagementParam<T extends EngagementFeatureType> = [T] extends ["preregister"] ? PreregisterEngagementParam : [T] extends ["lottery"] ? LotteryEngagementParam : [T] extends ["comment"] ? CommentEngagementParam : [T] extends ["share"] ? ShareEngagementParam | null : [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 : [T] extends ["referral"] ? ReferralEngagementParam : 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 | RedeemEngagementError;
+export type EngagementError = EngagementCommonError | TeamEngagementError | Vote2EngagementError | ClaimActivationKeyEngagementError | LotteryDrawEngagementError | LotteryEngagementError | GiftCodeEngagementError | RedeemEngagementError | ReferralEngagementError;
 /**
  * 根据玩法类型推导额外的错误字段
  */
-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;
+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 : [T] extends ["referral"] ? ReferralEngagementError : EngagementError) | EngagementCommonError;

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

@@ -156,6 +156,8 @@ export declare const FeatureType: {
     readonly UgcLike: "ugc_like";
     /** 兑换 */
     readonly Redeem: "redeem";
+    /** 裂变拉新 */
+    readonly Referral: "referral";
 };
 export type FeatureType = ValueOf<typeof FeatureType>;
 export declare const FeatureTypeValidator: import("@seayoo-web/validator").StringValidator<FeatureType, false, false> & {
@@ -370,6 +372,26 @@ export declare const TeamActionValidator: import("@seayoo-web/validator").String
     maybeNull: never;
     lock: never;
 };
+/** 裂变玩法操作类型 */
+export declare const ReferralAction: {
+    /** 获取邀请码 */
+    readonly Share: "share";
+    /** 被邀请人参与 */
+    readonly Join: "join";
+    /** 查询邀请码、已邀人数、被邀请人列表 */
+    readonly Query: "query";
+};
+export type ReferralAction = ValueOf<typeof ReferralAction>;
+export declare const ReferralActionValidator: import("@seayoo-web/validator").StringValidator<ReferralAction, false, false> & {
+    pattern: never;
+    url: never;
+    dataUri: never;
+    enum: never;
+    disallow: never;
+    optional: never;
+    maybeNull: never;
+    lock: never;
+};
 /** 抽奖券玩法操作类型 */
 export declare const LotteryDrawAction: {
     /** 查询抽奖券 */

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

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

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

@@ -4,7 +4,7 @@ import type { GamerItemType, RewardSource, RewardStatus, UgcReviewStatus } from
 import type { RequestOptions, RequestInternalError } from "@seayoo-web/request";
 type ApiInstance = InstanceType<typeof EventApi>;
 /** 支持的 api 方法，用于 TS 类型输入提示 */
-export type ApiMethodNames = "verifyMobileAllowed" | "getConfig" | "getEngagementsUserCount" | "getEngagementsCount" | "getEngagements" | "visit" | "getUserFeatureStatus" | "getUserEngagementCount" | "getUserEngagements" | "engage" | "claimRewards" | "submitUserRewardAddress" | "getUnlimitQrcodeScene" | "getParamsByQrcodeScene" | "generateUnlimitQrcode" | "getQuestProgress" | "vote2Rewards" | "getVote2Leaderboard" | "getCashbackQuery" | "getUgcRecord" | "getUgcMyCount" | "claimRewardsV2" | "claimWeixinHongbao" | "verifyActivationKey" | "getUserRewards" | "getUserRewardsCount" | "getUserItemCount" | "ugcUploadImage" | "getUgcRecommendation" | "getUgcs" | "getUgcLeaderboard" | "getRedeemItemStocks";
+export type ApiMethodNames = "verifyMobileAllowed" | "getConfig" | "getEngagementsUserCount" | "getEngagementsCount" | "getEngagements" | "visit" | "getUserFeatureStatus" | "getUserEngagementCount" | "getUserEngagements" | "engage" | "claimRewards" | "submitUserRewardAddress" | "getUnlimitQrcodeScene" | "getParamsByQrcodeScene" | "generateUnlimitQrcode" | "getQuestProgress" | "vote2Rewards" | "getVote2Leaderboard" | "getCashbackQuery" | "getUgcRecord" | "getUgcMyCount" | "claimRewardsV2" | "claimWeixinHongbao" | "verifyActivationKey" | "getUserRewards" | "getUserRewardsCount" | "getUserItemCount" | "ugcUploadImage" | "getUgcRecommendation" | "getUgcs" | "getUgcLeaderboard" | "getRedeemItemStocks" | "generateReferralRewards";
 /**
  * 根据手机号白名单，检查手机号是否允许登录某个游戏
  *
@@ -450,4 +450,13 @@ export declare function getRedeemItemStocks(this: ApiInstance, featureId: number
     message: string;
     error: RequestInternalError | "event_not_found" | "feature_not_found";
 } | null>;
+/**
+ * 在裂变玩法中，生成阶梯奖励；奖励仍通过通用领奖接口领取
+ *
+ * https://www.kdocs.cn/l/cdB3gn8J4a9S?linkname=JHR4LeqsmE
+ */
+export declare function generateReferralRewards(this: ApiInstance, featureId: number, requestOptions?: RequestOptions): Promise<import("./event.engage").GenerateReferralRewardsResponse | {
+    message: string;
+    error: string;
+} | null>;
 export {};

package/types/src/ggd.d.ts

@@ -6,24 +6,28 @@ export declare class GGDPublicApi {
     req: ReturnType<NetRequestFactory>;
     constructor(endpoint: string, NetRequest: NetRequestFactory);
     /**
-     * 获取鹅鸭杀房间内详情，参数 `invitationCode` 默认从 url query 的 `invitation_code` 参数读取
+     * 获取鹅鸭杀房间内详情
+     *
+     * - 参数 `invitationCode` 默认从 url query 的 `invitation_code` 参数读取
+     * - 参数 `serverId` 默认从 url query 的 `server_id` 参数读取
+     * - 参数 `expiresAt` 默认从 url query 的 `expires_at` 参数读取
      *
      * 接口文档 https://www.kdocs.cn/l/cf2mO2uRLqh9?linkname=vpkahwYfte
      *
      * 响应依据 GM 协议 https://www.kdocs.cn/l/cnZbBuB5x12C?linkname=pRQPKz6vUa
      */
-    describeRoomByCode(invitationCode?: string): Promise<{
+    describeRoomByCode(invitationCode?: string, serverId?: number | string, expiresAt?: number | string): Promise<{
         room_id: string;
         inviter_role_id: number;
         room_status: import("./ggd.enums").GGDRoomStatus;
-        room_mode: string;
-        room_tags: string[];
-        max_members: number;
+        room_mode: string | undefined;
+        room_tags: string[] | undefined;
+        max_members: number | undefined;
         members: {
             role_id: /*elided*/ any;
             role_name: /*elided*/ any;
             avatar_url: /*elided*/ any;
-        }[];
+        }[] | undefined;
     } | {
         error: RequestInternalError | "room_not_found" | "invitation_code_invalid" | "invitation_code_expired";
         message: string;

package/types/src/ggd.enum.d.ts

@@ -1,22 +0,0 @@
-import type { ValueOf } from "@seayoo-web/utils";
-/** 房间状态 */
-export declare const GGDRoomStatus: {
-    /** 等待中 */
-    readonly Waiting: 1;
-    /** 游戏中 */
-    readonly Playing: 2;
-};
-export type GGDRoomStatus = ValueOf<typeof GGDRoomStatus>;
-export declare const GGDRoomStatusValidator: import("@seayoo-web/validator").NumberValidator<GGDRoomStatus, false, false> & {
-    int: never;
-    min: never;
-    max: never;
-    allowNaN: never;
-    allowInfinity: never;
-    unsafe: never;
-    enum: never;
-    disallow: never;
-    optional: never;
-    maybeNull: never;
-    lock: never;
-};