@seayoo-web/gamer-api 2.12.5 → 2.13.1

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@seayoo-web/gamer-api",
   "description": "agent for gamer api",
-  "version": "2.12.5",
+  "version": "2.13.1",
   "type": "module",
   "source": "index.ts",
   "main": "./dist/index.js",
@@ -31,16 +31,16 @@
   "devDependencies": {
     "@types/node": "^22.13.1",
     "@seayoo-web/combo-webview": "2.8.0",
-    "@seayoo-web/scripts": "3.1.5",
-    "@seayoo-web/request": "3.4.0",
     "@seayoo-web/tsconfig": "1.0.5",
-    "@seayoo-web/utils": "4.1.3",
-    "@seayoo-web/validator": "1.1.1"
+    "@seayoo-web/request": "3.4.0",
+    "@seayoo-web/scripts": "3.1.5",
+    "@seayoo-web/validator": "1.1.1",
+    "@seayoo-web/utils": "4.1.3"
   },
   "peerDependencies": {
     "@seayoo-web/combo-webview": "^2.8.0",
-    "@seayoo-web/utils": "^4.1.3",
-    "@seayoo-web/validator": "^1.1.1"
+    "@seayoo-web/validator": "^1.1.1",
+    "@seayoo-web/utils": "^4.1.3"
   },
   "scripts": {
     "prebuild": "pnpm -F validator build && pnpm -F request build && pnpm -F combo-webview build",

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

@@ -1,3 +1,4 @@
+import type { EventFeatureConfigOfUgcLike } from "../event";
 import type { EventFeatureConfigOfCashback } from "./feature.cashback";
 import type { EventFeatureConfigOfCheckIn } from "./feature.checkIn";
 import type { EventFeatureConfigOfClaimActivationKey } from "./feature.claimActivationKey";
@@ -41,5 +42,6 @@ export * from "./feature.vote";
 export * from "./feature.vote2";
 export * from "./feature.claimActivationKey";
 export * from "./feature.ugc";
-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;
-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>], false, false>;
+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>;

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

@@ -0,0 +1,12 @@
+import type { EventFeatureBaseConfig } from "./feature.base";
+declare const featureType: "ugc";
+export interface FeatureUgcLikeConfig {
+    /** 关联的投稿玩法 ID */
+    ugc_feature_id: number;
+}
+export type EventFeatureConfigOfUgcLike = EventFeatureBaseConfig & {
+    feature_type: typeof featureType;
+    config: FeatureUgcLikeConfig;
+};
+export declare const EventFeatureConfigOfUgcLikeValidator: import("@seayoo-web/validator").ObjectValidator<EventFeatureConfigOfUgcLike, false, false>;
+export {};

package/types/src/event.d.ts

@@ -373,6 +373,29 @@ export declare class EventApi {
         image_url: string;
     } | {
         message: string;
-        code: RequestInternalError | "event_not_found" | "feature_not_found";
+        error: RequestInternalError | "event_not_found" | "feature_not_found";
+    } | null>;
+    /**
+     * 获取推荐稿件列表，随机显示 N 条被接受的投稿记录
+     *
+     * https://www.kdocs.cn/l/ckWFDcOsYEUA?linkname=WzvcAPjHAh
+     */
+    getUgcRecommendation(featureId: number, requestOptions?: IRequestOptions): Promise<import("./event.engage").UgcRecordResponse | {
+        message: string;
+        error: RequestInternalError | "event_not_found" | "feature_not_found";
+    } | null>;
+    /**
+     * 获取指定活动玩法的 UGC 投稿排行榜数据
+     *
+     * 该接口仅在管理员在 Console 后台完成排行榜结算后才会返回有效数据。
+     * 结算前调用将返回空结果集。
+     * 排行榜结算通常在活动结束后由管理员在 Console 后台手动触发。
+     * 目前前端无法直接在投稿玩法中获得「是否已经结算」的状态。
+     *
+     * https://www.kdocs.cn/l/ckWFDcOsYEUA?linkname=KoB7S8omkC
+     */
+    getUgcLeaderboard(featureId: number, requestOptions?: IRequestOptions): Promise<import("./event.engage").UgcLeaderboardResponse | {
+        message: string;
+        error: RequestInternalError | "event_not_found" | "feature_not_found";
     } | null>;
 }

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

@@ -31,6 +31,7 @@ export * from "./engage.vote2";
 export * from "./engage.claimActivationKey";
 export * from "./engage.zeroChatGPT";
 export * from "./engage.ugc";
+export * from "./engage.ugcLike";
 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 declare const UserEngagementDataValidator: import("@seayoo-web/validator").UnionValidator<[import("@seayoo-web/validator").ObjectValidator<{

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

@@ -75,3 +75,26 @@ export declare const UgcUploadImageValidator: import("@seayoo-web/validator").Ob
     upload_url: string | undefined;
     image_url: string;
 }, false, false>;
+export interface LeaderboardEntry {
+    /** 投稿记录 ID */
+    ugc_id: number;
+    /** 排名 */
+    rank: number;
+    /** 投稿记录获得的总赞数 */
+    total_likes: number;
+    /** 图片 URL 列表 */
+    image_urls?: string[];
+    /** 服务器 ID */
+    server_id?: number;
+    /** 服务器名称 */
+    server_name?: string;
+    /** 角色 ID */
+    role_id?: string;
+    /** 角色名称 */
+    role_name?: string;
+}
+export interface UgcLeaderboardResponse {
+    /** 投稿排行榜列表 */
+    ugcs: Array<LeaderboardEntry>;
+}
+export declare const UgcLeaderboardResponseValidator: import("@seayoo-web/validator").ObjectValidator<UgcLeaderboardResponse, false, false>;

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

@@ -0,0 +1,4 @@
+export type UgcLikeEngagementParam = {
+    /** 投稿记录 ID */
+    ugc_id: number;
+};

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, 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 } from "./engage";
 import type { Reward } from "./reward";
 import type { FeatureType } from "../event.enums";
 import type { ZeroChatGPTEngagementParam } from "./engage.zeroChatGPT";
@@ -32,12 +32,12 @@ export declare const UserEngagementValidator: import("@seayoo-web/validator").Ob
 /**
  * 部分玩法参与时需要提供的参数
  */
-export type EngagementParam = null | PreregisterEngagementParam | LotteryEngagementParam | CommentEngagementParam | ShareEngagementParam | VoteEngagementParam | Vote2EngagementParam | SubscribeEngagementParam | TeamEngagementParam | LotteryDrawEngagementParam | ZeroChatGPTEngagementParam | UgcEngagementParam;
+export type EngagementParam = null | PreregisterEngagementParam | LotteryEngagementParam | CommentEngagementParam | ShareEngagementParam | VoteEngagementParam | Vote2EngagementParam | SubscribeEngagementParam | TeamEngagementParam | LotteryDrawEngagementParam | ZeroChatGPTEngagementParam | UgcEngagementParam | UgcLikeEngagementParam;
 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 : 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 : 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;
 /**

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

@@ -148,6 +148,8 @@ export declare const FeatureType: {
     readonly ZeroChatgpt: "zero_chatgpt";
     /** 投稿 */
     readonly Ugc: "ugc";
+    /** 投稿点赞 */
+    readonly UgcLike: "ugc_like";
 };
 export type FeatureType = ValueOf<typeof FeatureType>;
 export declare const FeatureTypeValidator: import("@seayoo-web/validator").StringValidator<FeatureType, false, false> & {

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

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