@seayoo-web/gamer-api 1.1.6 → 1.1.8

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@seayoo-web/gamer-api",
   "description": "agent for gamer api",
-  "version": "1.1.6",
+  "version": "1.1.8",
   "type": "module",
   "source": "index.ts",
   "main": "./dist/index.js",
@@ -24,13 +24,13 @@
     "@types/node": "^22.13.1",
     "@seayoo-web/combo-webview": "^2.5.0",
     "@seayoo-web/tsconfig": "^1.0.3",
-    "@seayoo-web/scripts": "^1.3.9",
-    "@seayoo-web/utils": "^3.0.10",
-    "@seayoo-web/request": "^2.1.2"
+    "@seayoo-web/request": "^2.1.2",
+    "@seayoo-web/utils": "^3.1.1",
+    "@seayoo-web/scripts": "^1.3.15"
   },
   "peerDependencies": {
     "@seayoo-web/combo-webview": "^2.5.0",
-    "@seayoo-web/utils": "^3.0.10"
+    "@seayoo-web/utils": "^3.1.1"
   },
   "scripts": {
     "build": "vite build && tsc --emitDeclarationOnly",

package/types/src/event.d.ts

@@ -64,6 +64,8 @@ export declare class EventApi {
      *
      * 💡活动下包含 engage_account_type 为 role_id 的玩法时，前端需要提供 server_id 和 role_id
      *
+     * 🔕请求静默进行，无消息提示
+     *
      * https://kdocs.cn/l/ckWFDcOsYEUA?linkname=WzX5BrMNpL
      */
     getUserFeatureStatus(option?: {
@@ -74,8 +76,30 @@ export declare class EventApi {
      * 获取当前登录用户参与某个玩法的记录
      *
      * https://kdocs.cn/l/ckWFDcOsYEUA?linkname=WSbAeDZc8F
+     *
+     * @deprecated 请改用 getUserEngagementsV2
      */
     getUserEngagements(featureId: number): Promise<import("./event.define").UserEngagement[]>;
+    /**
+     * 获取当前登录用户参与某个玩法的记录
+     *
+     * https://kdocs.cn/l/ckWFDcOsYEUA?linkname=NFDdV1dwWb
+     */
+    getUserEngagementsV2(featureId: number, option?: {
+        /** 单页返回的最大数量，默认 10 */
+        max_results?: number;
+        next_token?: string;
+        /** 是否返回参与获得的记录，默认 false */
+        return_rewards?: string;
+        /**
+         * 当玩法的 engage_account_type 为 role_id 时，可提供 server_id 和 role_id 获取具体角色的参与记录
+         */
+        server_id?: string;
+        /**
+         * 当玩法的 engage_account_type 为 role_id 时，可提供 server_id 和 role_id 获取具体角色的参与记录
+         */
+        role_id?: string;
+    }): Promise<import("./event.define").UserEngagementV2[]>;
     /**
      * 用户参与某个玩法（需要先调用 visit 接口）
      *

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

@@ -1,4 +1,4 @@
-import type { CliamRewardStatus, FeatureType, GamerItemType, LotteryDrawAction, LotteryTicketStatus, QuestObjective, RewardSoure, RewardStatusPrefix, RewardStatusSuffix, TeamAction, TeamVisibility } from "./event.enums";
+import type { CliamRewardStatus, FeatureType, GamerItemType, LotteryDrawAction, LotteryTicketStatus, QuestObjective, RewardSoure, RewardStatusPrefix, RewardStatusSuffix, RewardStatusSuffixV2, TeamAction, TeamVisibility } from "./event.enums";
 export interface VerifyMobileResult {
     /** 手机号是否允许登录此游戏（游戏 ID 由 Request Header 的 Origin 或 Referer 决定） */
     allowed: boolean;
@@ -39,6 +39,9 @@ export interface UserFeatureStatus {
     /** 是否有已获得但尚未领取的玩法参与奖励 */
     has_unclaimed_rewards: boolean;
 }
+/**
+ * 用户参与记录，已经作废
+ */
 export interface UserEngagement {
     /** 参与记录 ID */
     engagement_id: number;
@@ -68,6 +71,37 @@ export interface UserEngagement {
     role_id?: string;
     created_at: number;
 }
+export type UserEngagementV2 = Pick<UserEngagement, "engagement_id" | "feature_id" | "sequence" | "data" | "server_id" | "role_id" | "created_at"> & {
+    user_id: number;
+    /** 参与奖励列表 */
+    rewards?: Reward[];
+};
+export interface Reward {
+    /** 用户奖励记录 id */
+    reward_id: number;
+    /** 奖励道具 id */
+    reward_item_id: number;
+    /** 奖励道具类型  */
+    reward_item_type: GamerItemType;
+    /** 奖励道具数量 */
+    reward_count: number;
+    /** 奖励状态 */
+    reward_status: RewardStatusSuffixV2;
+    /** 奖励来源 */
+    reward_source: RewardSoure;
+    /** 奖励道具名称 */
+    reward_item_name: string;
+    /** 奖励道具图片地址 */
+    reward_item_icon_url: string;
+    /** 奖励道具描述 */
+    reward_item_desc?: string;
+    /** 奖励道具评级，用于前端展示 */
+    reward_item_rating: number;
+    /** 领奖时间 */
+    receive_time: number;
+    /** 提供额外扩展信息，比如收获地址等 */
+    extra_data?: Record<string, unknown>;
+}
 export interface PreregisterEngagementData {
     /** 用户预约平台 */
     platforms: string[];

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

@@ -88,19 +88,35 @@ export declare const enum VoteOptionSource {
     /** 投票入围 */
     Shortlisted = "shortlisted"
 }
-/** 奖励领取状态(不含发货状态和领取失败) */
+/**
+ * 奖励领取状态(不含发货状态和领取失败)
+ */
 export declare const enum RewardStatusPrefix {
     /** 未获得奖励 */
     Ineligible = "ineligible",
     /** 奖励未领取 */
-    Unaccalimed = "unaccalimed",
+    Unclaimed = "unaccalimed",
     /** 奖励已领取 */
     Received = "received"
 }
-/** 已获得实物奖励的奖励状态 */
+/**
+ * 已获得实物奖励的奖励状态
+ *
+ * @deprecated
+ */
 export declare const enum RewardStatusSuffix {
     /** 奖励未领取 */
-    Unaccalimed = "unaccalimed",
+    Unclaimed = "unaccalimed",
+    /** 奖励已领取 */
+    Received = "received",
+    /** 奖励发放失败 */
+    Failed = "failed",
+    /** 奖励已发货 */
+    Delivered = "delivered"
+}
+export declare const enum RewardStatusSuffixV2 {
+    /** 奖励未领取 */
+    Unclaimed = "unclaimed",
     /** 奖励已领取 */
     Received = "received",
     /** 奖励发放失败 */

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

@@ -1,4 +1,4 @@
-import type { ClaimedItem, CommentEngagement, EngageResponse, TeamEngagement, UserEngagement, UserFeatureStatus, UserReward, VerifyMobileResult } from "./event.define";
+import type { ClaimedItem, CommentEngagement, EngageResponse, Reward, TeamEngagement, UserEngagement, UserEngagementV2, UserFeatureStatus, UserReward, VerifyMobileResult } from "./event.define";
 import type { CliamRewardStatus } from "./event.enums";
 export declare function isVerifyMobileResponse(data: unknown): data is VerifyMobileResult;
 export declare function isCommonCountResponse(data: unknown): data is {
@@ -16,6 +16,11 @@ export declare function isUserFeatureStatusResponse(data: unknown): data is {
 export declare function isUserEngagementsResponse(data: unknown): data is {
     engagements: UserEngagement[];
 };
+export declare function isUserEngagementsV2Response(data: unknown): data is {
+    engagements: UserEngagementV2[];
+};
+export declare function isUserEngagementV2(data: unknown): data is UserEngagementV2;
+export declare function isReward(data: unknown): data is Reward;
 export declare function isEngageResponse(data: unknown): data is EngageResponse;
 export declare function isClaimRewardsResponse(data: unknown): data is {
     claimed_items: ClaimedItem[];

package/types/src/token.d.ts

@@ -62,11 +62,15 @@ export declare class AuthToken {
      * - 此方法通常不需要手动调用，在需要登录的接口调用时会自动执行
      * - 为了提高页面执行速度，可以在设置 Token 后立即调用 autoLogin
      *
+     * 🔕请求静默进行，无消息提示
+     *
      * https://kdocs.cn/l/cf2mO2uRLqh9?linkname=ReeJpWraRO
      */
     autoLogin(): Promise<boolean>;
     /**
-     * 获取当前 Session 的信息
+     * 获取当前登录用户的 Session 的信息
+     *
+     * 🔕请求静默进行，无消息提示
      *
      * https://kdocs.cn/l/cf2mO2uRLqh9?linkname=OdGVCdQxEu
      */

package/types/src/utils.d.ts

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

package/types/src/weixin.d.ts

@@ -41,6 +41,8 @@ export declare class WeixinApi {
      * - 由于小程序的存储是以用户维度隔离的，每个微信用户在每个小程序下只要成功调用一次此 API 就会缓存请求结果。
      * - 微信公众号网页授权请使用 webLogin 方法
      *
+     * 🔕请求静默进行，无消息提示
+     *
      * https://kdocs.cn/l/cf2mO2uRLqh9?linkname=GwIZ0givCb
      */
     login(): Promise<import("./weixin.define").WeixinLoginResponse | {
@@ -72,6 +74,8 @@ export declare class WeixinApi {
      *
      * 用于从游戏内跳转至小程序时，将微信用户身份和游戏内身份关联起来，使得后续的企业微信客服流程能够知道该微信用户在游戏内的身份。
      *
+     * 🔕请求静默进行，无消息提示
+     *
      * https://kdocs.cn/l/cf2mO2uRLqh9?linkname=ci73N833Mk
      *
      * @param weixinToken 调用 login 后，得到的 weixinToken，如果 weixinToken 为空则跳过不处理