@seayoo-web/gamer-api 2.12.4 → 2.12.6

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@seayoo-web/gamer-api",
   "description": "agent for gamer api",
-  "version": "2.12.4",
+  "version": "2.12.6",
   "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/tsconfig": "1.0.5",
     "@seayoo-web/request": "3.4.0",
     "@seayoo-web/scripts": "3.1.5",
+    "@seayoo-web/tsconfig": "1.0.5",
     "@seayoo-web/utils": "4.1.3",
     "@seayoo-web/validator": "1.1.1"
   },
   "peerDependencies": {
+    "@seayoo-web/combo-webview": "^2.8.0",
     "@seayoo-web/utils": "^4.1.3",
-    "@seayoo-web/validator": "^1.1.1",
-    "@seayoo-web/combo-webview": "^2.8.0"
+    "@seayoo-web/validator": "^1.1.1"
   },
   "scripts": {
     "prebuild": "pnpm -F validator build && pnpm -F request build && pnpm -F combo-webview build",

package/types/src/event.d.ts

@@ -343,8 +343,7 @@ export declare class EventApi {
      *
      * https://www.kdocs.cn/l/ckWFDcOsYEUA?linkname=biEwrNKhAF
      */
-    getUgcRecord(option: {
-        feature_id: number;
+    getUgcRecord(featureId: number, option: {
         /** 查询返回最大参与记录数 默认20*/
         max_results?: number;
         /** 分页标识，不传默认首页查询 */
@@ -362,8 +361,7 @@ export declare class EventApi {
      *
      * https://www.kdocs.cn/l/ckWFDcOsYEUA?linkname=xhGGpJEbol
      */
-    ugcUploadImage(option: {
-        feature_id: number;
+    ugcUploadImage(featureId: number, option: {
         image_type: "png" | "jpg" | "jpeg";
         /** 媒体文件大小 */
         size: number;
@@ -375,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.ugc.d.ts

@@ -52,6 +52,8 @@ export interface UgcRecord {
     role_name?: string;
     /** 投稿记录获得的总赞数 */
     total_likes?: number;
+    /** 投稿记录创建时间，Unix timestamp in seconds */
+    created_at: number;
 }
 export interface UgcRecordResponse {
     /** 稿件列表 */
@@ -73,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.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;