@seayoo-web/gamer-api 1.1.18 → 2.0.1

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@seayoo-web/gamer-api",
   "description": "agent for gamer api",
-  "version": "1.1.18",
+  "version": "2.0.1",
   "type": "module",
   "source": "index.ts",
   "main": "./dist/index.js",
@@ -22,15 +22,15 @@
   "license": "MIT",
   "devDependencies": {
     "@types/node": "^22.13.1",
-    "@seayoo-web/scripts": "^1.3.15",
     "@seayoo-web/combo-webview": "^2.5.0",
-    "@seayoo-web/request": "^2.1.2",
+    "@seayoo-web/scripts": "^2.0.1",
+    "@seayoo-web/request": "^3.0.0",
     "@seayoo-web/tsconfig": "^1.0.3",
-    "@seayoo-web/utils": "^3.3.0"
+    "@seayoo-web/utils": "^3.4.3"
   },
   "peerDependencies": {
     "@seayoo-web/combo-webview": "^2.5.0",
-    "@seayoo-web/utils": "^3.3.0"
+    "@seayoo-web/utils": "^3.4.3"
   },
   "dependencies": {
     "vitest": "^3.0.5"

package/types/src/club.d.ts

@@ -1,4 +1,4 @@
-import { type RequestInteralError } from "@seayoo-web/request";
+import { type RequestInternalError } from "@seayoo-web/request";
 import { type SomePartial } from "@seayoo-web/utils";
 import type { ClubAddress, ClubUserProfile, RedeemParams } from "./club.define";
 import type { ClubCreditChangeType, ClubItemType } from "./club.enums";
@@ -21,7 +21,7 @@ export declare class ClubApi {
      * https://kdocs.cn/l/cgp4gSBMbOf1?linkname=hIDfaMlT7m
      */
     getCurrentPlayer(): Promise<import("./club.define").ClubPlayer | {
-        error: RequestInteralError | "seayoo_account_already_deleted" | "player_not_found";
+        error: RequestInternalError | "seayoo_account_already_deleted" | "player_not_found";
     }>;
     /**
      * 俱乐部用户关联游戏账号
@@ -29,7 +29,7 @@ export declare class ClubApi {
      * https://kdocs.cn/l/cgp4gSBMbOf1?linkname=Dpb9JAKqzG
      */
     linkPlayer(): Promise<import("./club.define").ClubPlayer | {
-        error: RequestInteralError | "seayoo_user_id_has_combo_id" | "combo_id_has_seayoo_user_id";
+        error: RequestInternalError | "seayoo_user_id_has_combo_id" | "combo_id_has_seayoo_user_id";
     }>;
     /**
      * 获取俱乐部关联的游戏账号下的角色列表
@@ -71,7 +71,7 @@ export declare class ClubApi {
      * https://kdocs.cn/l/cgp4gSBMbOf1?linkname=Qt822A57jd
      */
     updateUserProfile(option: ClubUserProfile): Promise<ClubUserProfile | {
-        error: RequestInteralError | "player_not_found" | "sensitive_nickname" | "sensitive_bio" | "sensitive_avatar";
+        error: RequestInternalError | "player_not_found" | "sensitive_nickname" | "sensitive_bio" | "sensitive_avatar";
     }>;
     /**
      * 获取自己的俱乐部收货地址列表
@@ -91,7 +91,7 @@ export declare class ClubApi {
      * https://kdocs.cn/l/cgp4gSBMbOf1?linkname=p9FlJhHnWN
      */
     updateAddress(option: SomePartial<ClubAddress, "is_default">): Promise<ClubAddress | {
-        error: RequestInteralError | "address_not_found";
+        error: RequestInternalError | "address_not_found";
     }>;
     /**
      * 删除自己的俱乐部收货地址
@@ -112,7 +112,7 @@ export declare class ClubApi {
         /** 游戏账号 ID，游戏外必传 */
         player_id?: string;
     }): Promise<import("./club.define").ClubUserCredit | {
-        error: RequestInteralError | "player_not_found";
+        error: RequestInternalError | "player_not_found";
     }>;
     /**
      * 获取自己的俱乐部积分变动记录
@@ -153,7 +153,10 @@ export declare class ClubApi {
      *
      * https://kdocs.cn/l/cgp4gSBMbOf1?linkname=r3vC3PzfMQ
      */
-    getProducts(): Promise<import("./club.define").ClubProduct[]>;
+    getProducts(option?: {
+        /** 游戏账号 ID，游戏外必传 */
+        player_id?: string;
+    }): Promise<import("./club.define").ClubProduct[]>;
     /**
      * 兑换商城商品
      *
@@ -169,7 +172,7 @@ export declare class ClubApi {
         /** 游戏账号 ID，游戏外必传 */
         player_id?: string;
     }): Promise<true | {
-        error: RequestInteralError | "mall_product_not_found" | "credit_not_found" | "role_not_found" | "player_level_not_enough" | "credit_balance_not_enough" | "redeem_product_quantity_exceeds_limit" | "redeem_quantity_over_stock" | "redeem_quantity_over_daily_limit" | "redeem_quantity_over_month_limit" | "redeem_quantity_over_year_limit" | "redeem_quantity_over_total_limit" | "club_redeem_condition_dissatisfied";
+        error: RequestInternalError | "mall_product_not_found" | "credit_not_found" | "role_not_found" | "player_level_not_enough" | "credit_balance_not_enough" | "redeem_product_quantity_exceeds_limit" | "redeem_quantity_over_stock" | "redeem_quantity_over_daily_limit" | "redeem_quantity_over_month_limit" | "redeem_quantity_over_year_limit" | "redeem_quantity_over_total_limit" | "club_redeem_condition_dissatisfied";
     }>;
     /**
      * 获取兑换记录

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

@@ -1,5 +1,5 @@
-import type { ClubCreditChangeSence, ClubCreditChangeType, ClubItemType, ClubRedemptionStatus, Gender } from "./club.enums";
-export interface ClubGlobalConfig {
+import { ClubCreditChangeScene, ClubCreditChangeType, ClubItemType, ClubRedemptionStatus, Gender } from "./club.enums";
+export type ClubGlobalConfig = {
     /** 俱乐部默认头像地址 */
     default_avatar_url: string;
     /** 俱乐部官方头像库地址 */
@@ -29,8 +29,14 @@ export interface ClubGlobalConfig {
     credit_description: string;
     /** 发送角色邮件的频次限制，单位：秒 */
     send_role_mail_rate_limit: number;
-}
-export interface ClubPlayer {
+};
+export declare const ClubGlobalConfigValidator: import("@seayoo-web/utils").ObjectValidator<ClubGlobalConfig, false, false> & {
+    plain: never;
+    optional: never;
+    maybeNull: never;
+    lock: never;
+};
+export type ClubPlayer = {
     /** 俱乐部会员 ID（世游通行证 ID） */
     member_id: string;
     /** Combo ID */
@@ -47,25 +53,49 @@ export interface ClubPlayer {
     level_change_time: number;
     /** 等级过期时间 */
     level_expire_time: number;
-}
-export interface ServerBaseInfo {
+};
+export declare const ClubPlayerValidator: import("@seayoo-web/utils").ObjectValidator<ClubPlayer, false, false> & {
+    plain: never;
+    optional: never;
+    maybeNull: never;
+    lock: never;
+};
+export type ServerBaseInfo = {
     /** 服务器 ID */
     server_id: string;
     /** 服务器名称 */
     server_name: string;
-}
-export interface RoleBaseInfo {
+};
+export declare const ServerBaseInfoValidator: import("@seayoo-web/utils").ObjectValidator<ServerBaseInfo, false, false> & {
+    plain: never;
+    optional: never;
+    maybeNull: never;
+    lock: never;
+};
+export type RoleBaseInfo = {
     /** 角色 ID */
     role_id: string;
     /** 角色昵称 */
     role_name: string;
-}
-export interface PlayerRole extends RoleBaseInfo, ServerBaseInfo {
+};
+export declare const RoleBaseInfoValidator: import("@seayoo-web/utils").ObjectValidator<RoleBaseInfo, false, false> & {
+    plain: never;
+    optional: never;
+    maybeNull: never;
+    lock: never;
+};
+export type PlayerRole = RoleBaseInfo & ServerBaseInfo & {
     /** 角色等级 */
     role_level: number;
     /** 最后一次登录时间 */
     last_login_time: number;
-}
+};
+export declare const PlayerRoleValidator: import("@seayoo-web/utils").ObjectValidator<PlayerRole, false, false> & {
+    plain: never;
+    optional: never;
+    maybeNull: never;
+    lock: never;
+};
 export type PlayerRoleCard = PlayerRole & {
     /** 角色战力 */
     role_fighting: number;
@@ -76,7 +106,13 @@ export type PlayerRoleCard = PlayerRole & {
     /** 宗门职位 */
     kin_position?: string;
 };
-export interface ClubUserProfile {
+export declare const PlayerRoleCardValidator: import("@seayoo-web/utils").ObjectValidator<PlayerRoleCard, false, false> & {
+    plain: never;
+    optional: never;
+    maybeNull: never;
+    lock: never;
+};
+export type ClubUserProfile = {
     /** 用户昵称 */
     name: string;
     /** 用户头像 */
@@ -91,8 +127,14 @@ export interface ClubUserProfile {
         month: number;
         day: number;
     };
-}
-export interface ClubAddress {
+};
+export declare const ClubUserProfileValidator: import("@seayoo-web/utils").ObjectValidator<ClubUserProfile, false, false> & {
+    plain: never;
+    optional: never;
+    maybeNull: never;
+    lock: never;
+};
+export type ClubAddress = {
     /** 收货地址 ID */
     address_id: number;
     /** 收件人 */
@@ -109,8 +151,14 @@ export interface ClubAddress {
     address: string;
     /** 是否默认地址 */
     is_default: boolean;
-}
-export interface ClubUserCredit {
+};
+export declare const ClubAddressValidator: import("@seayoo-web/utils").ObjectValidator<ClubAddress, false, false> & {
+    plain: never;
+    optional: never;
+    maybeNull: never;
+    lock: never;
+};
+export type ClubUserCredit = {
     /** 增加积分数 */
     increased_credit: number;
     /** 减少积分数 */
@@ -119,22 +167,34 @@ export interface ClubUserCredit {
     expired_credit: number;
     /** 积分余额 */
     balance_credit: number;
-}
-export interface ClubCreditLog {
+};
+export declare const ClubUserCreditValidator: import("@seayoo-web/utils").ObjectValidator<ClubUserCredit, false, false> & {
+    plain: never;
+    optional: never;
+    maybeNull: never;
+    lock: never;
+};
+export type ClubCreditLog = {
     /** 记录 ID */
     id: number;
     /** 变动类型 */
     change_type: ClubCreditChangeType;
     /** 变动场景 */
-    change_scene: ClubCreditChangeSence;
+    change_scene: ClubCreditChangeScene;
     /** 变动值 */
     change_credit: number;
     /** 变动后的积分余额 */
     balance: number;
     /** 变动时间 */
     change_time: number;
-}
-export interface ClubBenefitSummary {
+};
+export declare const ClubCreditLogValidator: import("@seayoo-web/utils").ObjectValidator<ClubCreditLog, false, false> & {
+    plain: never;
+    optional: never;
+    maybeNull: never;
+    lock: never;
+};
+export type ClubBenefitSummary = {
     /** 权益 ID */
     benefit_id: number;
     /** 权益名称 */
@@ -151,8 +211,14 @@ export interface ClubBenefitSummary {
     product_id: number;
     /** 权益标签 */
     tag: string;
-}
-export interface ClubProduct {
+};
+export declare const ClubBenefitSummaryValidator: import("@seayoo-web/utils").ObjectValidator<ClubBenefitSummary, false, false> & {
+    plain: never;
+    optional: never;
+    maybeNull: never;
+    lock: never;
+};
+export type ClubProduct = {
     /** 商品 ID */
     product_id: number;
     /** 分类 ID */
@@ -201,21 +267,80 @@ export interface ClubProduct {
     created_at: number;
     /** 商品更新时间 */
     updated_at: number;
-}
+    /** 当前可以兑换的数量 -1 代表不限制兑换数量 (只有关联了player的账号才会返回这个数据) */
+    redeemable_quantity?: number;
+};
+export declare const ClubProductValidator: import("@seayoo-web/utils").ObjectValidator<ClubProduct, false, false> & {
+    plain: never;
+    optional: never;
+    maybeNull: never;
+    lock: never;
+};
 export type ClubBenefit = Omit<ClubBenefitSummary, "tag"> & {
     /** 权益关联的商品详细信息 */
     product?: ClubProduct;
 };
+export declare const ClubBenefitValidator: import("@seayoo-web/utils").ObjectValidator<ClubBenefit, false, false> & {
+    plain: never;
+    optional: never;
+    maybeNull: never;
+    lock: never;
+};
 /** 兑换参数 */
-export type RedeemParams = RedeemParamsOfGameReward | RedeemParamsOfPhysical;
-interface RedeemParamsOfGameReward {
+export type RedeemParams = {
+    server_id: string;
+    role_id: string;
+} | {
+    address_id: number;
+};
+export declare const RedeemParamsValidator: import("@seayoo-web/utils").UnionValidator<[import("@seayoo-web/utils").ObjectValidator<{
     server_id: string;
     role_id: string;
-}
-interface RedeemParamsOfPhysical {
+}, false, false>, import("@seayoo-web/utils").ObjectValidator<{
     address_id: number;
-}
-export interface Redemption {
+}, false, false>], false, false> & {
+    optional: never;
+    maybeNull: never;
+    key: never;
+    satisfies: never;
+    lock: never;
+};
+export type ExtraPhysicalShipment = {
+    /** 收件人 */
+    recipient: string;
+    /** 手机号 */
+    mobile: string;
+    /** 省 */
+    province: string;
+    /** 市 */
+    city: string;
+    /** 区 / 县 */
+    district: string;
+    /** 收件地址 */
+    address: string;
+    /** 快递公司名称 */
+    express_company: string;
+    /** 快递公司单号 */
+    express_number: string;
+};
+export declare const ExtraPhysicalShipmentValidator: import("@seayoo-web/utils").ObjectValidator<ExtraPhysicalShipment, false, false> & {
+    plain: never;
+    optional: never;
+    maybeNull: never;
+    lock: never;
+};
+export type ExtraGameReward = {
+    server_id: string;
+    role_id: string;
+    role_name: string;
+};
+export declare const ExtraGameRewardValidator: import("@seayoo-web/utils").ObjectValidator<ExtraGameReward, false, false> & {
+    plain: never;
+    optional: never;
+    maybeNull: never;
+    lock: never;
+};
+export type Redemption = {
     /** 兑换记录 ID */
     redemption_id: number;
     /** 游戏账号 */
@@ -242,28 +367,5 @@ export interface Redemption {
     created_at: number;
     /** 额外附加数据 */
     extra_data?: ExtraPhysicalShipment | ExtraGameReward;
-}
-export interface ExtraPhysicalShipment {
-    /** 收件人 */
-    recipient: string;
-    /** 手机号 */
-    mobile: string;
-    /** 省 */
-    province: string;
-    /** 市 */
-    city: string;
-    /** 区 / 县 */
-    district: string;
-    /** 收件地址 */
-    address: string;
-    /** 快递公司名称 */
-    express_company: string;
-    /** 快递公司单号 */
-    express_number: string;
-}
-export interface ExtraGameReward {
-    server_id: string;
-    role_id: string;
-    role_name: string;
-}
-export {};
+};
+export declare const RedemptionValidator: import("@seayoo-web/utils").ObjectValidator<Redemption, false, false>;

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

@@ -1,53 +1,104 @@
-export declare const enum Gender {
+import { type ValueOf } from "@seayoo-web/utils";
+export declare const Gender: {
     /** 未知 */
-    Unknown = "unknown",
+    readonly Unknown: "unknown";
     /** 男 */
-    Male = "male",
+    readonly Male: "male";
     /** 女 */
-    Female = "female"
-}
-export declare const GenderValidator: import("@seayoo-web/utils").StringValidator<Gender, false, false>;
+    readonly Female: "female";
+};
+export type Gender = ValueOf<typeof Gender>;
+export declare const GenderValidator: import("@seayoo-web/utils").StringValidator<Gender, false, false> & {
+    pattern: never;
+    url: never;
+    dataUri: never;
+    enum: never;
+    disallow: never;
+    optional: never;
+    maybeNull: never;
+    lock: never;
+};
 /** 俱乐部积分变化类型 */
-export declare const enum ClubCreditChangeType {
+export declare const ClubCreditChangeType: {
     /** 积分增加 */
-    Increase = "increase",
+    readonly Increase: "increase";
     /** 积分减少 */
-    Decrease = "decrease",
+    readonly Decrease: "decrease";
     /** 积分过期 */
-    Expired = "expired"
-}
-export declare const ClubCreditChangeTypeValidator: import("@seayoo-web/utils").StringValidator<ClubCreditChangeType, false, false>;
+    readonly Expired: "expired";
+};
+export type ClubCreditChangeType = ValueOf<typeof ClubCreditChangeType>;
+export declare const ClubCreditChangeTypeValidator: import("@seayoo-web/utils").StringValidator<ClubCreditChangeType, false, false> & {
+    pattern: never;
+    url: never;
+    dataUri: never;
+    enum: never;
+    disallow: never;
+    optional: never;
+    maybeNull: never;
+    lock: never;
+};
 /** 积分变动场景 */
-export declare const enum ClubCreditChangeSence {
+export declare const ClubCreditChangeScene: {
     /** 游戏内购买 */
-    Order = "order",
+    readonly Order: "order";
     /** 游戏内消耗 */
-    Consumption = "consumption",
+    readonly Consumption: "consumption";
     /** 商城兑换 */
-    Redeem = "redeem",
+    readonly Redeem: "redeem";
     /** 积分过期 */
-    Expire = "expire",
+    readonly Expire: "expire";
     /** 管理后台调整 */
-    Admin = "admin",
+    readonly Admin: "admin";
     /** 运营活动 */
-    Event = "event"
-}
-export declare const ClubCreditChangeSenceValidator: import("@seayoo-web/utils").StringValidator<ClubCreditChangeSence, false, false>;
-export declare const enum ClubItemType {
+    readonly Event: "event";
+};
+export type ClubCreditChangeScene = ValueOf<typeof ClubCreditChangeScene>;
+export declare const ClubCreditChangeSceneValidator: import("@seayoo-web/utils").StringValidator<ClubCreditChangeScene, false, false> & {
+    pattern: never;
+    url: never;
+    dataUri: never;
+    enum: never;
+    disallow: never;
+    optional: never;
+    maybeNull: never;
+    lock: never;
+};
+export declare const ClubItemType: {
     /** 游戏内奖励 */
-    GameReward = "game_reward",
+    readonly GameReward: "game_reward";
     /** 实物商品 */
-    Physical = "physical",
+    readonly Physical: "physical";
     /** 虚拟商品 */
-    Virtual = "virtual"
-}
-export declare const ClubItemTypeValidator: import("@seayoo-web/utils").StringValidator<ClubItemType, false, false>;
-export declare const enum ClubRedemptionStatus {
+    readonly Virtual: "virtual";
+};
+export type ClubItemType = ValueOf<typeof ClubItemType>;
+export declare const ClubItemTypeValidator: import("@seayoo-web/utils").StringValidator<ClubItemType, false, false> & {
+    pattern: never;
+    url: never;
+    dataUri: never;
+    enum: never;
+    disallow: never;
+    optional: never;
+    maybeNull: never;
+    lock: never;
+};
+export declare const ClubRedemptionStatus: {
     /** 待发放 */
-    Pending = "pending",
+    readonly Pending: "pending";
     /** 已发放 */
-    Issued = "issued",
+    readonly Issued: "issued";
     /** 发放失败 */
-    Failed = "failed"
-}
-export declare const ClubRedemptionStatusValidator: import("@seayoo-web/utils").StringValidator<ClubRedemptionStatus, false, false>;
+    readonly Failed: "failed";
+};
+export type ClubRedemptionStatus = ValueOf<typeof ClubRedemptionStatus>;
+export declare const ClubRedemptionStatusValidator: import("@seayoo-web/utils").StringValidator<ClubRedemptionStatus, false, false> & {
+    pattern: never;
+    url: never;
+    dataUri: never;
+    enum: never;
+    disallow: never;
+    optional: never;
+    maybeNull: never;
+    lock: never;
+};

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

@@ -1,43 +1,33 @@
-import type { ClubAddress, ClubBenefit, ClubBenefitSummary, ClubGlobalConfig, ClubPlayer, ClubProduct, ClubCreditLog, PlayerRole, PlayerRoleCard, Redemption, RoleBaseInfo, ServerBaseInfo, ClubUserCredit, ClubUserProfile } from "./club.define";
-export declare const isClubConfigResponse: (data: unknown) => data is ClubGlobalConfig;
-export declare const isClubPlayer: (data: unknown) => data is ClubPlayer;
+export declare const isClubConfigResponse: (data: unknown) => data is import("./club.define").ClubGlobalConfig;
 export declare const isClubPlayerResponse: (data: unknown) => data is {
-    player: ClubPlayer;
+    player: import("./club.define").ClubPlayer;
 };
-export type VerifyLinkSecondaryPlayerOtpResponse = ServerBaseInfo & RoleBaseInfo;
-export declare const isPlayerRole: (data: unknown) => data is PlayerRole;
 export declare const isGetRolesResponse: (data: unknown) => data is {
-    roles: PlayerRole[];
+    roles: import("./club.define").PlayerRole[];
 };
-export declare const isPlayerRoleCard: (data: unknown) => data is PlayerRoleCard;
 export declare const isRoleCardResponse: (data: unknown) => data is {
-    role_card: PlayerRoleCard;
+    role_card: import("./club.define").PlayerRoleCard;
 };
-export declare const isUserProfile: (data: unknown) => data is ClubUserProfile;
-export declare const isClubAddress: (data: unknown) => data is ClubAddress;
+export declare const isUserProfile: (data: unknown) => data is import("./club.define").ClubUserProfile;
+export declare const isClubAddress: (data: unknown) => data is import("./club.define").ClubAddress;
 export declare const isGetAddressesResponse: (data: unknown) => data is {
-    addresses: ClubAddress[];
+    addresses: import("./club.define").ClubAddress[];
 };
-export declare const isUserCredit: (data: unknown) => data is ClubUserCredit;
-export declare const isCreditLog: (data: unknown) => data is ClubCreditLog;
+export declare const isUserCredit: (data: unknown) => data is import("./club.define").ClubUserCredit;
 export declare const isCreditLogListWithToken: (data: unknown) => data is {
-    credit_logs: ClubCreditLog[];
+    credit_logs: import("./club.define").ClubCreditLog[];
     next_token: string | undefined;
 };
-export declare const isClubProduct: (data: unknown) => data is ClubProduct;
 export declare const isGetProductsResponse: (data: unknown) => data is {
-    products: ClubProduct[];
+    products: import("./club.define").ClubProduct[];
 };
-export declare const isBenefitSummary: (data: unknown) => data is ClubBenefitSummary;
 export declare const isGetBenefitsResponse: (data: unknown) => data is {
-    benefits: ClubBenefitSummary[];
+    benefits: import("./club.define").ClubBenefitSummary[];
 };
-export declare const isBenefit: (data: unknown) => data is ClubBenefit;
 export declare const isGetBenefitResponse: (data: unknown) => data is {
-    benefit: ClubBenefit;
+    benefit: import("./club.define").ClubBenefit;
 };
-export declare const isRedemption: (data: unknown) => data is Redemption;
 export declare const isRedemptionListWithToken: (data: unknown) => data is {
-    redemptions: Redemption[];
+    redemptions: import("./club.define").Redemption[];
     next_token: string | undefined;
 };