@seayoo-web/gamer-api 2.3.2 → 2.3.3

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@seayoo-web/gamer-api",
   "description": "agent for gamer api",
-  "version": "2.3.2",
+  "version": "2.3.3",
   "type": "module",
   "source": "index.ts",
   "main": "./dist/index.js",
@@ -30,11 +30,11 @@
   "license": "MIT",
   "devDependencies": {
     "@types/node": "^22.13.1",
+    "@seayoo-web/combo-webview": "^2.5.4",
     "@seayoo-web/tsconfig": "^1.0.4",
+    "@seayoo-web/utils": "^3.5.2",
     "@seayoo-web/request": "^3.2.0",
-    "@seayoo-web/scripts": "^2.5.7",
-    "@seayoo-web/combo-webview": "^2.5.4",
-    "@seayoo-web/utils": "^3.5.2"
+    "@seayoo-web/scripts": "^2.5.7"
   },
   "peerDependencies": {
     "@seayoo-web/combo-webview": "^2.5.4",

package/types/index.d.ts

@@ -0,0 +1,5 @@
+export * from "./src/token";
+export * from "./src/club";
+export * from "./src/event";
+export * from "./src/community";
+export * from "./src/weixin";

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

@@ -0,0 +1,371 @@
+import { ClubCreditChangeScene, ClubCreditChangeType, ClubItemType, ClubRedemptionStatus, Gender } from "./club.enums";
+export type 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 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 */
+    player_id: string;
+    /** 成长值 */
+    exp: number;
+    /** 等级 */
+    level: number;
+    /** 用户积分余额 */
+    credit: number;
+    /** 月底即将过期积分数量 */
+    credit_expiring: number;
+    /** 等级变动时间 */
+    level_change_time: number;
+    /** 等级过期时间 */
+    level_expire_time: number;
+};
+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 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 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;
+    /** 宗门 ID */
+    kin_id?: string;
+    /** 宗门名称 */
+    kin_name?: string;
+    /** 宗门职位 */
+    kin_position?: string;
+};
+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;
+    /** 用户头像 */
+    avatar_url: string;
+    /** 个性签名 */
+    bio: string;
+    /** 性别 */
+    gender: Gender;
+    /** 出生日期 */
+    birthday: {
+        year: number;
+        month: number;
+        day: number;
+    };
+};
+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;
+    /** 收件人 */
+    recipient: string;
+    /** 手机号 */
+    mobile: string;
+    /** 省 */
+    province: string;
+    /** 市 */
+    city: string;
+    /** 区 / 县 */
+    district: string;
+    /** 详细地址 */
+    address: string;
+    /** 是否默认地址 */
+    is_default: boolean;
+};
+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;
+    /** 减少积分数 */
+    decreased_credit: number;
+    /** 过期积分数 */
+    expired_credit: number;
+    /** 积分余额 */
+    balance_credit: number;
+};
+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: ClubCreditChangeScene;
+    /** 变动值 */
+    change_credit: number;
+    /** 变动后的积分余额 */
+    balance: number;
+    /** 变动时间 */
+    change_time: number;
+};
+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;
+    /** 权益名称 */
+    name: string;
+    /** 权益图片 */
+    img_url: string;
+    /** 权益描述 */
+    description: string;
+    /** 权益最小等级 */
+    min_level: number;
+    /** 权益最大等级 */
+    max_level: number;
+    /** 权益关联商品 id， -1 表示未关联商品 */
+    product_id: number;
+    /** 权益标签 */
+    tag: string;
+};
+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 */
+    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;
+    /** 当前可以兑换的数量 -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 = {
+    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;
+}, false, false>, import("@seayoo-web/utils").ObjectValidator<{
+    address_id: number;
+}, 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;
+    /** 游戏账号 */
+    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 declare const RedemptionValidator: import("@seayoo-web/utils").ObjectValidator<Redemption, false, false>;

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

@@ -0,0 +1,104 @@
+import { type ValueOf } from "@seayoo-web/utils";
+export declare const Gender: {
+    /** 未知 */
+    readonly Unknown: "unknown";
+    /** 男 */
+    readonly Male: "male";
+    /** 女 */
+    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 ClubCreditChangeType: {
+    /** 积分增加 */
+    readonly Increase: "increase";
+    /** 积分减少 */
+    readonly Decrease: "decrease";
+    /** 积分过期 */
+    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 ClubCreditChangeScene: {
+    /** 游戏内购买 */
+    readonly Order: "order";
+    /** 游戏内消耗 */
+    readonly Consumption: "consumption";
+    /** 商城兑换 */
+    readonly Redeem: "redeem";
+    /** 积分过期 */
+    readonly Expire: "expire";
+    /** 管理后台调整 */
+    readonly Admin: "admin";
+    /** 运营活动 */
+    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: {
+    /** 游戏内奖励 */
+    readonly GameReward: "game_reward";
+    /** 实物商品 */
+    readonly Physical: "physical";
+    /** 虚拟商品 */
+    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: {
+    /** 待发放 */
+    readonly Pending: "pending";
+    /** 已发放 */
+    readonly Issued: "issued";
+    /** 发放失败 */
+    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

@@ -0,0 +1,33 @@
+export declare const isClubConfigResponse: (data: unknown) => data is import("./club.define").ClubGlobalConfig;
+export declare const isClubPlayerResponse: (data: unknown) => data is {
+    player: import("./club.define").ClubPlayer;
+};
+export declare const isGetRolesResponse: (data: unknown) => data is {
+    roles: import("./club.define").PlayerRole[];
+};
+export declare const isRoleCardResponse: (data: unknown) => data is {
+    role_card: import("./club.define").PlayerRoleCard;
+};
+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: import("./club.define").ClubAddress[];
+};
+export declare const isUserCredit: (data: unknown) => data is import("./club.define").ClubUserCredit;
+export declare const isCreditLogListWithToken: (data: unknown) => data is {
+    credit_logs: import("./club.define").ClubCreditLog[];
+    next_token: string | undefined;
+};
+export declare const isGetProductsResponse: (data: unknown) => data is {
+    products: import("./club.define").ClubProduct[];
+};
+export declare const isGetBenefitsResponse: (data: unknown) => data is {
+    benefits: import("./club.define").ClubBenefitSummary[];
+};
+export declare const isGetBenefitResponse: (data: unknown) => data is {
+    benefit: import("./club.define").ClubBenefit;
+};
+export declare const isRedemptionListWithToken: (data: unknown) => data is {
+    redemptions: import("./club.define").Redemption[];
+    next_token: string | undefined;
+};