@seayoo-web/gamer-api 1.0.0 → 1.0.3

package/dist/wx.js

@@ -1,119 +0,0 @@
-var a = Object.defineProperty;
-var h = (n, i, e) => i in n ? a(n, i, { enumerable: !0, configurable: !0, writable: !0, value: e }) : n[i] = e;
-var o = (n, i, e) => h(n, typeof i != "symbol" ? i + "" : i, e);
-import { NetRequest as k } from "@seayoo-web/request/wx";
-import { G as c, E as u, C as g, c as w, i as x } from "./event-CXcuEQsA.js";
-import { isPlainObject as l } from "@seayoo-web/utils";
-function m(n) {
-  return l(n, "openid", "unionid", "weixin_token");
-}
-class T {
-  /**
-   * 创建 WeixinApi 实例
-   *
-   * @param baseRequest - Gamer 通用的 request 工具实例，baseUrl 仅仅包含 endpoint + version
-   * @param autoLogin - 自动登录函数，由上层组件提供
-   */
-  constructor(i, e) {
-    o(this, "req");
-    o(this, "autoLogin");
-    this.req = i, this.autoLogin = e;
-  }
-  /**
-   * 微信静默登录，获取 weixinToken / openid / unionid，其中 weixinToken 应该被缓存
-   *
-   * 使用场景为：
-   *
-   * - 用户通过任意途径打开小程序的任意页面后，如果本地缓存中不存在微信用户身份信息，则自动调用此 API。
-   * - 调用成功后，应当使用存储能力将 response 中的微信用户身份信息缓存在本地。
-   *
-   * 小程序不应当频繁调用此 API。
-   *
-   * 由于小程序的存储是以用户维度隔离的，每个微信用户在每个小程序下只需要成功调用一次此 API。
-   *
-   * [API文档 weixin/login](https://kdocs.cn/l/cf2mO2uRLqh9?linkname=x17CeNlDQx)
-   *
-   * @param wxcode - 微信小程序调用 wx.login 获得的登录凭证
-   * @param appid - 微信小程序的 Appid，后端 api 可以从请求的 referer 中提取，后续会删除此参数
-   */
-  async login(i, e) {
-    const { data: t, code: s, message: r } = await this.req.post(
-      "weixin/login",
-      { code: i, appid: e },
-      m,
-      {
-        message: !1
-      }
-    );
-    return t ?? { error: s, message: r };
-  }
-  /**
-   * 关联游戏账号
-   *
-   * 用于从游戏内跳转至小程序时，将微信用户身份和游戏内身份关联起来，使得后续的企业微信客服流程能够知道该微信用户在游戏内的身份。
-   *
-   * https://kdocs.cn/l/cf2mO2uRLqh9?linkname=ci73N833Mk
-   *
-   * @param weixinToken 调用 login 后，得到的 Weixin Token
-   * @param gameCode 从游戏内跳转至小程序时，通过请求参数 query 携带的 game_code
-   */
-  async linkPlayer(i, e) {
-    const { ok: t, code: s, message: r } = await this.req.post("weixin/link-player", {
-      weixin_token: i,
-      game_code: e
-    });
-    return t || { error: s, message: r };
-  }
-}
-class L extends c {
-  constructor(e, t) {
-    super(e, (t == null ? void 0 : t.version) || "v1", k);
-    o(this, "weixinToken", "");
-    /** event api 集合 */
-    o(this, "event");
-    /** club api 集合 */
-    o(this, "club");
-    /** weixin api 集合 */
-    o(this, "weixin");
-    const s = this.autoLogin.bind(this);
-    this.event = new u(this.req, s), this.club = new g(this.req, s), this.weixin = new T(this.req, s);
-  }
-  /**设置 Weixin Token，用于后续请求自动置换 Gamer Token */
-  setWeixinToken(e) {
-    return this.weixinToken !== e && (this.weixinToken = e, this.gamerToken = ""), this;
-  }
-  /** 读取设置 wexinToken */
-  getWexinToken() {
-    return this.weixinToken;
-  }
-  /**
-   * 用世游通行证统一登录能力签发的 idToken 和 weixinToken，自动置换 gamerToken，成功后会自动设置后续 Request Headers
-   *
-   * [世游通行证统一登录](https://kdocs.cn/l/cf2mO2uRLqh9?linkname=FJXYgqvLHs)
-   *
-   * [世游通行证统一登录 - 微信小程序](https://365.kdocs.cn/l/ccHVuUs0UsZs)
-   *
-   * - 此方法通常不需要手动调用，在需要登录的接口调用时会自动执行
-   * - 为了提高页面执行速度，可以在 setIdToken + setWeixinToken 后立即调用 autoLogin，比如
-   *
-   * @example
-   * ``` js
-   *  gamerApi.setIdToken("xxxxx").setWeixinToken("yyyyyy").autoLogin()
-   * ```
-   */
-  async autoLogin() {
-    if (this.gamerToken)
-      return !0;
-    if (!this.weixinToken || !this.idToken)
-      return w.error("Missing idToken / weixinToken when call autoLogin()"), !1;
-    const { data: e } = await this.req.post(
-      "login-with-token",
-      { id_token: this.idToken, weixin_token: this.weixinToken },
-      x
-    );
-    return this.gamerToken = (e == null ? void 0 : e.gamer_token) || "", !!this.gamerToken;
-  }
-}
-export {
-  L as GamerApi
-};

package/types/src/base.d.ts

@@ -1,64 +0,0 @@
-import type { NetRequestFactory } from "@seayoo-web/request";
-/**
- * [Gamer 系统架构](https://365.kdocs.cn/l/chWSTMvxyyCW?from=koa)
- *
- * [世游用户运营 api 服务](https://365.kdocs.cn/l/cf2mO2uRLqh9)
- */
-export declare abstract class GamerBaseApi {
-    protected idToken: string;
-    protected gamerToken: string;
-    protected req: ReturnType<NetRequestFactory>;
-    constructor(endpoint: string, version: string, request: NetRequestFactory);
-    /** 设置从登录组件获取的 Id Token，用于后续请求自动置换 Gamer Token */
-    setIdToken(idToken: string): this;
-    /** 读取已经设置的 idToken */
-    getIdToken(): string;
-    /** 读取自动置换的 gamerToken */
-    getGamerToken(): string;
-    /**
-     * 根据 ID Token / Weixin Token 自动置换 Gamer Token
-     *
-     * ⚠️ 此方法需要覆盖，根据不同的场景 token 做具体实现
-     *
-     * [世游通行证的统一登录机制](https://kdocs.cn/l/cf2mO2uRLqh9?linkname=FJXYgqvLHs)
-     */
-    abstract autoLogin(): Promise<boolean>;
-    /**
-     * 获取当前 Session 的信息
-     *
-     * https://kdocs.cn/l/cf2mO2uRLqh9?linkname=OdGVCdQxEu
-     */
-    getSession(): Promise<GamerSession | null>;
-    /**
-     * 根据手机号白名单，检查手机号是否允许登录某个游戏
-     *
-     * https://kdocs.cn/l/cf2mO2uRLqh9?linkname=OWGSPF3Ysl
-     */
-    verifyMobileAllowed(mobile: string): Promise<VerifyMobileResult | null>;
-}
-export declare function isGamerTokenResponse(data: unknown): data is {
-    gamer_token: string;
-};
-interface GamerSession {
-    /** 世游通行证 ID */
-    seayoo_user_id?: string;
-    /** 手机号码（掩码形式） */
-    seayoo_mobile?: string;
-    /** 世游通行证用户实名信息（掩码形式） */
-    seayoo_real_name?: string;
-    /** Combo ID */
-    combo_id?: string;
-    /**
-     * combo_id 背后的 IdP
-     *
-     * 取值参见 [Combo Client REST API 中的 idp](https://kdocs.cn/l/cg0cfHzazsta?linkname=ZVDdf1pe48)，仅当 combo_id 有值时才有值
-     */
-    combo_idp?: string;
-}
-interface VerifyMobileResult {
-    /** 手机号是否允许登录此游戏（游戏 ID 由 Request Header 的 Origin 或 Referer 决定） */
-    allowed: boolean;
-    /** 手机号是否已注册世游通行证 */
-    registered: boolean;
-}
-export {};

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

@@ -1,151 +0,0 @@
-import type { EFeatureType, EGameItemType, EQuestObjective } from "./event.config";
-export declare function isCommonCountResponse(data: unknown): data is {
-    count: number;
-};
-interface EngamentsResponse {
-    engagements: CommentEngagement[] | TeamEngagement[];
-}
-export interface CommentEngagement {
-    /** 用户世游通行证 ID */
-    user_id: string;
-    /** 用户昵称 */
-    name: string;
-    /** 用户头像地址 */
-    avatar_url: string;
-    /** 评论信息 */
-    comment: string;
-    /** 用户发布弹幕的视频点 */
-    video_note: number;
-    /** 用户发布弹幕的时间 */
-    created_at: number;
-}
-export interface TeamEngagement {
-    /** 组队码 */
-    objective: string;
-    /** 队长角色名称 */
-    leader_name: string;
-    /** 队员数量 */
-    total_members: number;
-}
-export declare function isEngamentsResponse(data: unknown): data is EngamentsResponse;
-export declare function isUserVisitResponse(data: unknown): data is {
-    first_visit: boolean;
-};
-interface UserFeatureStatusResponse {
-    status: UserFeatureStatus[];
-}
-export interface UserFeatureStatus {
-    feature_id: number;
-    can_engage: boolean;
-    has_unclaimed_rewards: boolean;
-}
-export declare function isUserFeatureStatusResponse(data: unknown): data is UserFeatureStatusResponse;
-interface UserEngagementsResponse {
-    engagements: UserEngagement[];
-}
-export declare function isUserEngagementsResponse(data: unknown): data is UserEngagementsResponse;
-export interface UserEngagement {
-    engagement_id: number;
-    sequence: number;
-    feature_id: number;
-    reward_id: number;
-    reward_status: "ineligible" | "unaccalimed" | "received";
-    reward_source: "output" | "engage";
-    data?: PreregisterEngagementData | LotteryEngagementData | SurveyEngagementData | InviteEngagementData | ShareEngagementData | VoteEngagementData | WeixinSubscribeEngagementData | CashbackEngagementData | GiftCodeEngagementData | TeamEngagementData | QuestEngagementData | LotteryDrawEngagementData;
-    server_id?: string;
-    role_id?: string;
-    created_at: number;
-}
-interface PreregisterEngagementData {
-    platforms: string[];
-}
-interface LotteryEngagementData {
-    lottery_count: number;
-}
-interface SurveyEngagementData {
-    serial_number: number;
-}
-interface InviteEngagementData {
-    user_id: string;
-    name: string;
-    avatar_url: string;
-}
-interface ShareEngagementData {
-    platform: string;
-}
-interface VoteEngagementData {
-    option_sn: string;
-}
-interface WeixinSubscribeEngagementData {
-    weixin_openid: string;
-}
-interface CashbackEngagementData {
-    order_total_amount: string | number;
-    cashback_total_amount: string | number;
-    game_item_count: string | number;
-}
-interface GiftCodeEngagementData {
-    gift_code: string;
-}
-interface TeamEngagementData {
-    team_code: string;
-    visibility: "private" | "public";
-    members: {
-        is_leader: boolean;
-        role_name: string;
-        server_name: string;
-    }[];
-}
-interface QuestEngagementData {
-    objective: EQuestObjective;
-    progress: number;
-    completion_value?: number;
-    team?: {
-        progress: number;
-        completion_value?: number;
-        players: {
-            user_id: number;
-            role_name: string;
-            is_leader: boolean;
-            progress?: number;
-        }[];
-    };
-}
-interface LotteryDrawEngagementData {
-    tickets: ({
-        ticket: string;
-        status: "unknown" | "pending";
-    } | {
-        ticket: string;
-        status: "drawn" | "claimed" | "fail";
-        reward: LotteryDrawUserReward;
-    })[];
-}
-interface LotteryDrawUserReward {
-    reward_id: number;
-    reward_item_id: number;
-    reward_item_name: string;
-    reward_source: "output" | "engage";
-    reward_item_type: EGameItemType;
-    reward_item_icon_url: string;
-    reward_item_desc?: string;
-    reward_amount: number;
-    reward_status: "unaccalimed" | "received" | "failed" | "delivered";
-    event_id: number;
-    event_name: string;
-    feature_id: number;
-    engagement_id: number;
-    feature_type: EFeatureType;
-    receive_time: number;
-    extra_data?: Record<string, unknown>;
-}
-export declare function isGetUnlimitQrcodeSceneResponse(data: unknown): data is {
-    scene: string;
-};
-export declare function isGetParamsByQrcodeSceneResponse(data: unknown): data is {
-    params: string;
-};
-export declare function isGenerateUnlimitQrcodeResponse(data: unknown): data is {
-    img: string;
-};
-export {};

package/types/src/wexin.d.ts

@@ -1,48 +0,0 @@
-import { type AutoLoginHandler } from "./utils";
-import type { NetRequestFactory } from "@seayoo-web/request";
-export declare class WeixinApi {
-    private req;
-    private autoLogin;
-    /**
-     * 创建 WeixinApi 实例
-     *
-     * @param baseRequest - Gamer 通用的 request 工具实例，baseUrl 仅仅包含 endpoint + version
-     * @param autoLogin - 自动登录函数，由上层组件提供
-     */
-    constructor(baseRequest: ReturnType<NetRequestFactory>, autoLogin: AutoLoginHandler);
-    /**
-     * 微信静默登录，获取 weixinToken / openid / unionid，其中 weixinToken 应该被缓存
-     *
-     * 使用场景为：
-     *
-     * - 用户通过任意途径打开小程序的任意页面后，如果本地缓存中不存在微信用户身份信息，则自动调用此 API。
-     * - 调用成功后，应当使用存储能力将 response 中的微信用户身份信息缓存在本地。
-     *
-     * 小程序不应当频繁调用此 API。
-     *
-     * 由于小程序的存储是以用户维度隔离的，每个微信用户在每个小程序下只需要成功调用一次此 API。
-     *
-     * [API文档 weixin/login](https://kdocs.cn/l/cf2mO2uRLqh9?linkname=x17CeNlDQx)
-     *
-     * @param wxcode - 微信小程序调用 wx.login 获得的登录凭证
-     * @param appid - 微信小程序的 Appid，后端 api 可以从请求的 referer 中提取，后续会删除此参数
-     */
-    login(wxcode: string, appid: string): Promise<import("./weixin.guards").WeixinLoginResponse | {
-        error: string;
-        message: string;
-    }>;
-    /**
-     * 关联游戏账号
-     *
-     * 用于从游戏内跳转至小程序时，将微信用户身份和游戏内身份关联起来，使得后续的企业微信客服流程能够知道该微信用户在游戏内的身份。
-     *
-     * https://kdocs.cn/l/cf2mO2uRLqh9?linkname=ci73N833Mk
-     *
-     * @param weixinToken 调用 login 后，得到的 Weixin Token
-     * @param gameCode 从游戏内跳转至小程序时，通过请求参数 query 携带的 game_code
-     */
-    linkPlayer(weixinToken: string, gameCode: string): Promise<true | {
-        error: string;
-        message: string;
-    }>;
-}

package/types/wx.d.ts

@@ -1,36 +0,0 @@
-import { GamerBaseApi } from "./src/base";
-import { ClubApi } from "./src/club";
-import { EventApi } from "./src/event";
-import { WeixinApi } from "./src/wexin";
-export declare class GamerApi extends GamerBaseApi {
-    private weixinToken;
-    /** event api 集合 */
-    event: EventApi;
-    /** club api 集合 */
-    club: ClubApi;
-    /** weixin api 集合 */
-    weixin: WeixinApi;
-    constructor(endpoint: string, option?: {
-        version?: string;
-    });
-    /**设置 Weixin Token，用于后续请求自动置换 Gamer Token */
-    setWeixinToken(weixinToken: string): this;
-    /** 读取设置 wexinToken */
-    getWexinToken(): string;
-    /**
-     * 用世游通行证统一登录能力签发的 idToken 和 weixinToken，自动置换 gamerToken，成功后会自动设置后续 Request Headers
-     *
-     * [世游通行证统一登录](https://kdocs.cn/l/cf2mO2uRLqh9?linkname=FJXYgqvLHs)
-     *
-     * [世游通行证统一登录 - 微信小程序](https://365.kdocs.cn/l/ccHVuUs0UsZs)
-     *
-     * - 此方法通常不需要手动调用，在需要登录的接口调用时会自动执行
-     * - 为了提高页面执行速度，可以在 setIdToken + setWeixinToken 后立即调用 autoLogin，比如
-     *
-     * @example
-     * ``` js
-     *  gamerApi.setIdToken("xxxxx").setWeixinToken("yyyyyy").autoLogin()
-     * ```
-     */
-    autoLogin(): Promise<boolean>;
-}