@seayoo-web/gamer-api 1.0.0 → 1.0.3

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@seayoo-web/gamer-api",
   "description": "agent for gamer api",
-  "version": "1.0.0",
+  "version": "1.0.3",
   "type": "module",
   "source": "index.ts",
   "main": "./dist/index.js",
@@ -12,18 +12,6 @@
     "types",
     "README.md"
   ],
-  "exports": {
-    ".": {
-      "types": "./types/index.d.ts",
-      "import": "./dist/index.js",
-      "default": "./dist/index.js"
-    },
-    "./wx": {
-      "types": "./types/wx.d.ts",
-      "import": "./dist/wx.js",
-      "default": "./dist/wx.js"
-    }
-  },
   "publishConfig": {
     "access": "public"
   },
@@ -34,13 +22,15 @@
   "license": "MIT",
   "devDependencies": {
     "@types/node": "^22.13.1",
-    "@seayoo-web/request": "^2.0.8",
+    "@seayoo-web/combo-webview": "^2.4.4",
     "@seayoo-web/tsconfig": "^1.0.2",
-    "@seayoo-web/utils": "^2.0.1"
+    "@seayoo-web/request": "^2.1.0",
+    "@seayoo-web/utils": "^3.0.7",
+    "@seayoo-web/scripts": "^1.2.6"
   },
   "peerDependencies": {
-    "@seayoo-web/request": "^2.0.8",
-    "@seayoo-web/utils": "^2.0.1"
+    "@seayoo-web/combo-webview": "^2.4.4",
+    "@seayoo-web/utils": "^3.0.7"
   },
   "scripts": {
     "build": "vite build && tsc --emitDeclarationOnly",

package/types/index.d.ts

@@ -1,29 +1,5 @@
-import { GamerBaseApi } from "./src/base";
-import { ClubApi } from "./src/club";
-import { EventApi } from "./src/event";
-export declare class GamerApi extends GamerBaseApi {
-    /** event api 集合 */
-    event: EventApi;
-    /** club api 集合 */
-    club: ClubApi;
-    constructor(endpoint: string, option?: {
-        version?: string;
-        eventId?: number;
-    });
-    /**
-     * 用世游通行证统一登录能力签发的 ID Token，自动置换 Gamer Token，成功后会自动设置后续 Request Headers
-     *
-     * [世游通行证统一登录](https://kdocs.cn/l/cf2mO2uRLqh9?linkname=FJXYgqvLHs)
-     *
-     * [世游通行证统一登录 - Web 站点](https://365.kdocs.cn/l/cf57sp1qLlZh)
-     *
-     * - 此方法通常不需要手动调用，在需要登录的接口调用时会自动执行
-     * - 为了提高页面执行速度，可以在 setIdToken 后立即调用 autoLogin，比如
-     *
-     * @example
-     * ``` js
-     *  gamerApi.setIdToken("xxxxx").autoLogin()
-     * ```
-     */
-    autoLogin(): Promise<boolean>;
-}
+export * from "./src/token";
+export * from "./src/club";
+export * from "./src/event";
+export * from "./src/community";
+export * from "./src/weixin";

package/types/src/club.d.ts

@@ -1,67 +1,186 @@
-import type { AutoLoginHandler } from "./utils";
-import type { NetRequestFactory } from "@seayoo-web/request";
+import { type RequestInteralError } 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";
+import type { AuthToken } from "./token";
+export * from "./club.enums";
+export * from "./club.define";
 export declare class ClubApi {
+    private token;
     private req;
-    private autoLogin;
-    /**
-     * 创建 ClubApi 实例
-     *
-     * @param baseRequest - Gamer 通用的 request 工具实例，baseUrl 仅仅包含 endpoint + version
-     * @param autoLogin - 自动登录函数，由上层组件提供
-     */
-    constructor(baseRequest: ReturnType<NetRequestFactory>, autoLogin: AutoLoginHandler);
+    constructor(authToken: AuthToken);
     /**
      * 获取俱乐部配置
      *
      * https://kdocs.cn/l/cgp4gSBMbOf1?linkname=tuhsPt3ihp
      */
-    getClubConfig(): Promise<import("./club.guards").ClubGlobalConfig | null>;
+    getConfig(): Promise<import("./club.define").ClubGlobalConfig | null>;
     /**
-     * 用于游戏内嵌 Web 页面获取当前登录的游戏账号在俱乐部中的信息
+     * 用于游戏内嵌 Web 页面和微信小程序获取当前登录的游戏账号在俱乐部中的信息。
      *
      * https://kdocs.cn/l/cgp4gSBMbOf1?linkname=hIDfaMlT7m
      */
-    getCurrentPlayer(): Promise<import("./club.guards").ClubPlayer | null>;
+    getCurrentPlayer(): Promise<import("./club.define").ClubPlayer | {
+        error: RequestInteralError | "seayoo_account_already_deleted" | "player_not_found";
+    }>;
+    /**
+     * 俱乐部用户关联游戏账号
+     *
+     * 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";
+    }>;
+    /**
+     * 获取俱乐部关联的游戏账号下的角色列表
+     *
+     * https://kdocs.cn/l/cgp4gSBMbOf1?linkname=nwu4FiGM9V
+     */
+    getRoles(playerId: string, forceReload?: boolean): Promise<import("./club.define").PlayerRole[]>;
+    /**
+     * 获取俱乐部会员的角色卡片数据
+     *
+     * https://kdocs.cn/l/cgp4gSBMbOf1?linkname=A1Wr7kUXnS
+     */
+    getRoleCard(memberId: string): Promise<import("./club.define").PlayerRoleCard | null>;
+    /**
+     * 设置自己的角色卡片
+     *
+     * https://kdocs.cn/l/cgp4gSBMbOf1?linkname=XgMf6OFE5i
+     */
+    setRoleCard(option: {
+        player_id: string;
+        server_id: string;
+        role_id: string;
+    }): Promise<import("./club.define").PlayerRoleCard | null>;
+    /**
+     * 强制刷新自己的角色卡片，从游戏内获取最新数据
+     *
+     * https://kdocs.cn/l/cgp4gSBMbOf1?linkname=RPdJquwmgv
+     */
+    refreshRoleCard(): Promise<import("./club.define").PlayerRoleCard | null>;
+    /**
+     * 获取俱乐部用户的信息
+     *
+     * https://kdocs.cn/l/cgp4gSBMbOf1?linkname=TMWBCFcOr2
+     */
+    getUserProfile(memberId: string): Promise<ClubUserProfile | null>;
+    /**
+     * 修改自己的俱乐部用户信息
+     *
+     * https://kdocs.cn/l/cgp4gSBMbOf1?linkname=Qt822A57jd
+     */
+    updateUserProfile(option: ClubUserProfile): Promise<ClubUserProfile | {
+        error: RequestInteralError | "player_not_found" | "sensitive_nickname" | "sensitive_bio" | "sensitive_avatar";
+    }>;
+    /**
+     * 获取自己的俱乐部收货地址列表
+     *
+     * https://kdocs.cn/l/cgp4gSBMbOf1?linkname=NowUIynMVn
+     */
+    getAddresses(): Promise<ClubAddress[]>;
+    /**
+     * 增加俱乐部收货地址
+     *
+     * https://kdocs.cn/l/cgp4gSBMbOf1?linkname=TaGIIYDRYA
+     */
+    addAddress(option: Omit<SomePartial<ClubAddress, "is_default">, "address_id">): Promise<ClubAddress | null>;
+    /**
+     * 修改自己的俱乐部收货地址
+     *
+     * https://kdocs.cn/l/cgp4gSBMbOf1?linkname=p9FlJhHnWN
+     */
+    updateAddress(option: SomePartial<ClubAddress, "is_default">): Promise<ClubAddress | {
+        error: RequestInteralError | "address_not_found";
+    }>;
+    /**
+     * 删除自己的俱乐部收货地址
+     *
+     * https://kdocs.cn/l/cgp4gSBMbOf1?linkname=MEEOBdf8rm
+     */
+    deleteAddress(addressId: number): Promise<boolean | null>;
     /**
-     * 获取俱乐部当前关联的所有游戏账号
+     * 获取俱乐部积分统计信息
      *
-     * https://kdocs.cn/l/cgp4gSBMbOf1?linkname=yccPUuagkA
+     * https://kdocs.cn/l/cgp4gSBMbOf1?linkname=x4uxtGstRL
      */
-    getPlayers(): Promise<import("./club.guards").ClubPlayer[] | null>;
+    getUserCredit(option: {
+        /** 开始时间的秒时间戳 */
+        start_time: number;
+        /** 结束时间的秒时间戳 */
+        end_time: number;
+        /** 游戏账号 ID，游戏外必传 */
+        player_id?: string;
+    }): Promise<import("./club.define").ClubUserCredit | {
+        error: RequestInteralError | "player_not_found";
+    }>;
     /**
-     * 俱乐部关联游戏主账号。在俱乐部查询不到主游戏账号信息时，前端自行调用。
+     * 获取自己的俱乐部积分变动记录
      *
-     * https://kdocs.cn/l/cgp4gSBMbOf1?linkname=SfGAm3mOyp
+     * https://kdocs.cn/l/cgp4gSBMbOf1?linkname=lQFgF689P8
      */
-    linkPrimaryPlayer(): Promise<import("./club.guards").ClubPlayer | null>;
+    getCreditLogs(option: {
+        /** 单次获取数量 */
+        max_results?: number;
+        /** 分页游标；首次请求为空 */
+        next_token?: string;
+        /** 积分变动类型 */
+        change_type?: ClubCreditChangeType;
+        /** 开始时间的秒时间戳 */
+        start_time: number;
+        /** 结束时间的秒时间戳 */
+        end_time: number;
+        /** 游戏账号 ID，游戏外必传 */
+        player_id?: string;
+    }): Promise<import("./club.guards").CreditLogListWithToken>;
     /**
-     * 获取关联副游戏账号时所需的游戏服务器列表
+     * 获取自己的俱乐部权益列表
      *
-     * https://kdocs.cn/l/cgp4gSBMbOf1?linkname=cBqJkplCAN
+     * https://kdocs.cn/l/cgp4gSBMbOf1?linkname=UFSDGvqkdV
      */
-    getSecondaryServers(): Promise<import("./club.guards").Server[]>;
+    getBenefits(): Promise<import("./club.define").ClubBenefitSummary[]>;
     /**
-     * 通过角色邮件，向游戏角色发送验证码，用于游戏外关联副游戏账号至俱乐部会员
+     * 获取某个权益详细信息
      *
-     * https://kdocs.cn/l/cgp4gSBMbOf1?linkname=mG7yRPapRv
+     * https://kdocs.cn/l/cgp4gSBMbOf1?linkname=XKto0MeaHF
      */
-    createLinkSecondaryPlayerOtp(serverId: string, roleId: string): Promise<string | null>;
+    getBenefit(benefitId: number): Promise<import("./club.define").ClubBenefit | null>;
     /**
-     * 验证角色邮件收到的验证码
+     * 获取商城商品列表
      *
-     * https://kdocs.cn/l/cgp4gSBMbOf1?linkname=BhEdxXC5E4
+     * https://kdocs.cn/l/cgp4gSBMbOf1?linkname=r3vC3PzfMQ
      */
-    verifyLinkSecondaryPlayerOtp(ticket: string, otp: string): Promise<import("./club.guards").VerifyLinkSecondaryPlayerOtpResponse | null>;
+    getProducts(): Promise<import("./club.define").ClubProduct[]>;
     /**
-     * 关联副游戏账号至俱乐部会员，适用于游戏外环境
+     * 兑换商城商品
      *
-     * https://kdocs.cn/l/cgp4gSBMbOf1?linkname=QNi2C2D0vO
+     * https://kdocs.cn/l/cgp4gSBMbOf1?linkname=LWcMVwX3OY
      */
-    linkSecondaryPlayerWithTicket(ticket: string): Promise<import("./club.guards").ClubPlayer | null>;
+    redeemProduct(option: {
+        /** 商品 ID */
+        product_id: number;
+        /** 商品数量 */
+        quantity: number;
+        /** 兑换参数，由 product_id 对应的 item_type 决定 */
+        params?: RedeemParams;
+        /** 游戏账号 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";
+    }>;
     /**
-     * 关联副游戏账号至俱乐部会员，适用于游戏内嵌页环境
+     * 获取兑换记录
      *
-     * https://kdocs.cn/l/cgp4gSBMbOf1?linkname=QNi2C2D0vO
+     * https://kdocs.cn/l/cgp4gSBMbOf1?linkname=Ml6mLgT4cM
      */
-    linkSecondaryPlayerWithIdToken(idToken: string): Promise<import("./club.guards").ClubPlayer | null>;
+    getRedemptions(option: {
+        /** 单次获取数量 */
+        max_results?: number;
+        /** 分页游标；首次请求为空 */
+        next_token?: string;
+        /** 物品类型 */
+        item_type?: ClubItemType;
+        /** 游戏账号 ID，游戏外必传 */
+        player_id?: string;
+    }): Promise<import("./club.guards").RedemptionListWithToken>;
 }

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

@@ -0,0 +1,271 @@
+import type { ClubCreditChangeSence, ClubCreditChangeType, ClubItemType, ClubRedemptionStatus, Gender } from "./club.enums";
+export interface ClubGlobalConfig {
+    /** 俱乐部默认头像地址 */
+    default_avatar_url: string;
+    /** 俱乐部官方头像库地址 */
+    official_avatar_urls: string[];
+    /** 俱乐部默认昵称 */
+    default_nickname: string;
+    /** 俱乐部默认签名 */
+    default_bio: string;
+    /** 俱乐部默认用户角色头像地址 */
+    default_role_avatar_url: string;
+    /** 俱乐部等级配置 */
+    level_configs: {
+        /** 俱乐部等级 */
+        level: number;
+        /** 等级对应的成长值 */
+        exp: number;
+        /** 俱乐部等级对应的称号 */
+        title: string;
+    }[];
+    /** 俱乐部等级有效期 */
+    level_valid_days: number;
+    /** 俱乐部权益描述 */
+    benefit_description: string;
+    /** 俱乐部成长值描述 */
+    exp_description: string;
+    /** 俱乐部积分规则描述 */
+    credit_description: string;
+    /** 发送角色邮件的频次限制，单位：秒 */
+    send_role_mail_rate_limit: number;
+}
+export interface ClubPlayer {
+    /** 俱乐部会员 ID（世游通行证 ID） */
+    member_id: string;
+    /** Combo ID */
+    player_id: string;
+    /** 游戏账号类型 */
+    type: "primary" | "secondary";
+    /** 成长值 */
+    exp: number;
+    /** 等级 */
+    level: number;
+    /** 用户积分余额 */
+    credit: number;
+    /** 月底即将过期积分数量 */
+    credit_expiring: number;
+    /** 等级变动时间 */
+    level_change_time: number;
+    /** 等级过期时间 */
+    level_expire_time: number;
+}
+export interface ServerBaseInfo {
+    /** 服务器 ID */
+    server_id: string;
+    /** 服务器名称 */
+    server_name: string;
+}
+export interface RoleBaseInfo {
+    /** 角色 ID */
+    role_id: string;
+    /** 角色昵称 */
+    role_name: string;
+}
+export interface PlayerRole extends RoleBaseInfo, ServerBaseInfo {
+    /** 角色等级 */
+    role_level: number;
+    /** 最后一次登录时间 */
+    last_login_time: number;
+}
+export type PlayerRoleCard = PlayerRole & {
+    /** 角色战力 */
+    role_fighting: number;
+    /** 宗门 ID */
+    kin_id?: string;
+    /** 宗门名称 */
+    kin_name?: string;
+    /** 宗门职位 */
+    kin_position?: string;
+};
+export interface ClubUserProfile {
+    /** 用户昵称 */
+    name: string;
+    /** 用户头像 */
+    avatar_url: string;
+    /** 个性签名 */
+    bio: string;
+    /** 性别 */
+    gender: Gender;
+    /** 出生日期 */
+    birthday: {
+        year: number;
+        month: number;
+        day: number;
+    };
+}
+export interface ClubAddress {
+    /** 收货地址 ID */
+    address_id: number;
+    /** 收件人 */
+    recipient: string;
+    /** 手机号 */
+    mobile: string;
+    /** 省 */
+    province: string;
+    /** 市 */
+    city: string;
+    /** 区 / 县 */
+    district: string;
+    /** 详细地址 */
+    address: string;
+    /** 是否默认地址 */
+    is_default: boolean;
+}
+export interface ClubUserCredit {
+    /** 增加积分数 */
+    increased_credit: number;
+    /** 减少积分数 */
+    decreased_credit: number;
+    /** 过期积分数 */
+    expired_credit: number;
+    /** 积分余额 */
+    balance_credit: number;
+}
+export interface ClubCreditLog {
+    /** 记录 ID */
+    id: number;
+    /** 变动类型 */
+    change_type: ClubCreditChangeType;
+    /** 变动场景 */
+    change_scene: ClubCreditChangeSence;
+    /** 变动值 */
+    change_credit: number;
+    /** 变动后的积分余额 */
+    balance: number;
+    /** 变动时间 */
+    change_time: number;
+}
+export interface ClubBenefitSummary {
+    /** 权益 ID */
+    benefit_id: number;
+    /** 权益名称 */
+    name: string;
+    /** 权益图片 */
+    img_url: string;
+    /** 权益描述 */
+    description: string;
+    /** 权益最小等级 */
+    min_level: number;
+    /** 权益最大等级 */
+    max_level: number;
+    /** 权益关联商品 id， -1 表示未关联商品 */
+    product_id: number;
+    /** 权益标签 */
+    tag: string;
+}
+export interface ClubProduct {
+    /** 商品 ID */
+    product_id: number;
+    /** 分类 ID */
+    catalog_id: number;
+    /** 分类名称 */
+    catalog_name: string;
+    /** 物品类型 */
+    item_type: ClubItemType;
+    /** 商品名称 */
+    name: string;
+    /** 商品图片地址 */
+    img_url: string;
+    /** 商品描述 */
+    description: string;
+    /** 商品标签 */
+    tag: string;
+    /** 兑换价格 */
+    price: number;
+    /** 库存数量，-1 代表无库存数量限制 */
+    stock: number;
+    /** 已兑换数量 */
+    redeem_quantity: number;
+    /** 上架时间，闭区间，-1 代表无上架时间限制 */
+    not_visible_before: number;
+    /** 下架时间，闭区间，-1 代表无下架时间限制 */
+    not_visible_after: number;
+    /** 可兑换开始时间，闭区间，-1 代表无兑换开始时间限制 */
+    not_before: number;
+    /** 可兑换结束时间，闭区间，-1 代表无兑换结束时间限制 */
+    not_after: number;
+    /** 可兑换最低等级 闭区间，-1代表没有等级最低要求 */
+    min_level: number;
+    /** 可兑换最高等级，闭区间，-1 代表没有等级最高要求 */
+    max_level: number;
+    /** 每人每天的兑换上限，-1 代表无上限 */
+    limit_daily: number;
+    /** 每人每月的兑换上限，-1 代表无上限 */
+    limit_monthly: number;
+    /** 每人每年的兑换上限，-1 代表无上限 */
+    limit_yearly: number;
+    /** 每人总量的兑换上限，-1 代表无上限 */
+    limit_total: number;
+    /** 商品显示权重 数值越大越靠前 */
+    weight: number;
+    /** 商品创建时间 */
+    created_at: number;
+    /** 商品更新时间 */
+    updated_at: number;
+}
+export type ClubBenefit = Omit<ClubBenefitSummary, "tag"> & {
+    /** 权益关联的商品详细信息 */
+    product?: ClubProduct;
+};
+/** 兑换参数 */
+export type RedeemParams = RedeemParamsOfGameReward | RedeemParamsOfPhysical;
+interface RedeemParamsOfGameReward {
+    server_id: string;
+    role_id: string;
+}
+interface RedeemParamsOfPhysical {
+    address_id: number;
+}
+export interface Redemption {
+    /** 兑换记录 ID */
+    redemption_id: number;
+    /** 游戏账号 */
+    player_id: string;
+    /** 商品 ID */
+    product_id: number;
+    /** 商品名称 */
+    name: string;
+    /** 商品图片地址 */
+    img_url: string;
+    /** 物品类型 */
+    item_type: ClubItemType;
+    /** 商品分类 ID */
+    catalog_id: number;
+    /** 商品分类名称 */
+    catalog_name: string;
+    /** 兑换商品数量 */
+    quantity: number;
+    /** 订单金额 */
+    amount: number;
+    /** 订单状态 */
+    status: ClubRedemptionStatus;
+    /** 创建时间 */
+    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 {};

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

@@ -0,0 +1,48 @@
+export declare const enum Gender {
+    /** 未知 */
+    Unknown = "unknown",
+    /** 男 */
+    Male = "male",
+    /** 女 */
+    Female = "female"
+}
+/** 俱乐部积分变化类型 */
+export declare const enum ClubCreditChangeType {
+    /** 积分增加 */
+    Increase = "increase",
+    /** 积分减少 */
+    Decrease = "decrease",
+    /** 积分过期 */
+    Expired = "expired"
+}
+/** 积分变动场景 */
+export declare const enum ClubCreditChangeSence {
+    /** 游戏内购买 */
+    Order = "order",
+    /** 游戏内消耗 */
+    Consumption = "consumption",
+    /** 商城兑换 */
+    Redeem = "redeem",
+    /** 积分过期 */
+    Expire = "expire",
+    /** 管理后台调整 */
+    Admin = "admin",
+    /** 运营活动 */
+    Event = "event"
+}
+export declare const enum ClubItemType {
+    /** 游戏内奖励 */
+    GameReward = "game_reward",
+    /** 实物商品 */
+    Physical = "physical",
+    /** 虚拟商品 */
+    Virtual = "virtual"
+}
+export declare const enum ClubRedemptionStatus {
+    /** 待发放 */
+    Pending = "pending",
+    /** 已发放 */
+    issued = "issued",
+    /** 发放失败 */
+    failed = "failed"
+}