@seayoo-web/gamer-api 1.0.0

package/README.md

@@ -0,0 +1,11 @@
+# Gamer Api Agent
+
+```js
+import { GamerApi, GamerApiForWeixin } from "@seayoo-web/gamer-api";
+
+// 在页面中使用
+const gamerApi1 = new GamerApi(Endpoint, eventId);
+
+// 在小程序中使用
+const gamerApi2 = new GamerApiForWeixin(Endpoint, eventId);
+```

package/dist/event-CXcuEQsA.js

@@ -0,0 +1,648 @@
+var m = Object.defineProperty;
+var g = (e, r, t) => r in e ? m(e, r, { enumerable: !0, configurable: !0, writable: !0, value: t }) : e[r] = t;
+var s = (e, r, t) => g(e, typeof r != "symbol" ? r + "" : r, t);
+import { useConsole as f, isPlainObject as n, pruneObject as u } from "@seayoo-web/utils";
+function y(e, r) {
+  const t = e.replace(/(?:^https?:\/\/|\/*$)/gi, ""), i = r ? `/${r}` : "";
+  return `https://${(t + i).replace(/\/{2,}/g, "")}`;
+}
+const _e = f("GamerApiSDK");
+class me {
+  constructor(r, t, i) {
+    s(this, "idToken", "");
+    s(this, "gamerToken", "");
+    s(this, "req");
+    this.req = i({
+      baseURL: y(r, t),
+      timeout: 1e4,
+      responseRule: {
+        ok: { resolve: "body" },
+        failed: {
+          resolve: "json",
+          statusField: "error",
+          messageField: "message"
+        }
+      },
+      requestTransformer: (_) => {
+        this.gamerToken && (_.headers.Authorization = `Bearer ${this.gamerToken}`);
+      }
+    });
+  }
+  /** 设置从登录组件获取的 Id Token，用于后续请求自动置换 Gamer Token */
+  setIdToken(r) {
+    return r !== this.idToken && (this.gamerToken = "", this.idToken = r), this;
+  }
+  /** 读取已经设置的 idToken */
+  getIdToken() {
+    return this.idToken;
+  }
+  /** 读取自动置换的 gamerToken */
+  getGamerToken() {
+    return this.gamerToken;
+  }
+  /**
+   * 获取当前 Session 的信息
+   *
+   * https://kdocs.cn/l/cf2mO2uRLqh9?linkname=OdGVCdQxEu
+   */
+  async getSession() {
+    if (await this.autoLogin()) return null;
+    const { data: r } = await this.req.get("session", p);
+    return r;
+  }
+  /**
+   * 根据手机号白名单，检查手机号是否允许登录某个游戏
+   *
+   * https://kdocs.cn/l/cf2mO2uRLqh9?linkname=OWGSPF3Ysl
+   */
+  async verifyMobileAllowed(r) {
+    const { data: t } = await this.req.get("verify-mobile-allowed", v, {
+      params: { mobile: r }
+    });
+    return t;
+  }
+}
+function ge(e) {
+  return n(e, "gamer_token") && typeof e.gamer_token == "string";
+}
+function p(e) {
+  return n(e);
+}
+function v(e) {
+  return n(e, "allowed", "registered");
+}
+function w(e) {
+  return n(
+    e,
+    "default_avatar_url",
+    "official_avatar_urls",
+    "default_nickname",
+    "default_bio",
+    "default_role_avatar_url",
+    "level_configs",
+    "level_valid_days",
+    "benefit_description",
+    "exp_description",
+    "credit_description",
+    "send_role_mail_rate_limit"
+  ) && Array.isArray(e.level_configs) && e.level_configs.every(
+    (r) => n(r, "exp", "level", "title")
+  );
+}
+function l(e) {
+  return n(
+    e,
+    "member_id",
+    "player_id",
+    "type",
+    "exp",
+    "level",
+    "credit",
+    "credit_expiring",
+    "level_change_time",
+    "level_expire_time"
+  ) && typeof e.player_id == "string";
+}
+function a(e) {
+  return n(e, "player") && l(e.player);
+}
+function d(e) {
+  return n(e, "players") && Array.isArray(e.players) && e.players.every(l);
+}
+function h(e) {
+  return n(e, "servers") && Array.isArray(e.servers) && e.servers.every((r) => n(r, "server_id", "server_name"));
+}
+function A(e) {
+  return n(e, "ticket") && typeof e.ticket == "string";
+}
+function b(e) {
+  return n(e, "role_id", "role_name", "server_id", "server_name");
+}
+class fe {
+  /**
+   * 创建 ClubApi 实例
+   *
+   * @param baseRequest - Gamer 通用的 request 工具实例，baseUrl 仅仅包含 endpoint + version
+   * @param autoLogin - 自动登录函数，由上层组件提供
+   */
+  constructor(r, t) {
+    s(this, "req");
+    s(this, "autoLogin");
+    this.req = r, this.autoLogin = t;
+  }
+  /**
+   * 获取俱乐部配置
+   *
+   * https://kdocs.cn/l/cgp4gSBMbOf1?linkname=tuhsPt3ihp
+   */
+  async getClubConfig() {
+    const { data: r } = await this.req.get("club/config", w);
+    return r;
+  }
+  /**
+   * 用于游戏内嵌 Web 页面获取当前登录的游戏账号在俱乐部中的信息
+   *
+   * https://kdocs.cn/l/cgp4gSBMbOf1?linkname=hIDfaMlT7m
+   */
+  async getCurrentPlayer() {
+    if (!await this.autoLogin()) return null;
+    const { data: r } = await this.req.get("club/current-player", a);
+    return (r == null ? void 0 : r.player) ?? null;
+  }
+  /**
+   * 获取俱乐部当前关联的所有游戏账号
+   *
+   * https://kdocs.cn/l/cgp4gSBMbOf1?linkname=yccPUuagkA
+   */
+  async getPlayers() {
+    if (!await this.autoLogin()) return null;
+    const { data: r } = await this.req.get("club/players", d);
+    return (r == null ? void 0 : r.players) || [];
+  }
+  /**
+   * 俱乐部关联游戏主账号。在俱乐部查询不到主游戏账号信息时，前端自行调用。
+   *
+   * https://kdocs.cn/l/cgp4gSBMbOf1?linkname=SfGAm3mOyp
+   */
+  async linkPrimaryPlayer() {
+    if (!await this.autoLogin()) return null;
+    const { data: r } = await this.req.post("club/link-primary-player", {}, a);
+    return (r == null ? void 0 : r.player) ?? null;
+  }
+  /**
+   * 获取关联副游戏账号时所需的游戏服务器列表
+   *
+   * https://kdocs.cn/l/cgp4gSBMbOf1?linkname=cBqJkplCAN
+   */
+  async getSecondaryServers() {
+    if (!await this.autoLogin()) return [];
+    const { data: r } = await this.req.get("club/secondary-servers", h);
+    return (r == null ? void 0 : r.servers) || [];
+  }
+  /**
+   * 通过角色邮件，向游戏角色发送验证码，用于游戏外关联副游戏账号至俱乐部会员
+   *
+   * https://kdocs.cn/l/cgp4gSBMbOf1?linkname=mG7yRPapRv
+   */
+  async createLinkSecondaryPlayerOtp(r, t) {
+    if (!await this.autoLogin()) return null;
+    const { data: i } = await this.req.post(
+      "club/create-link-secondary-player-otp",
+      {
+        server_id: r,
+        role_id: t
+      },
+      A
+    );
+    return (i == null ? void 0 : i.ticket) ?? null;
+  }
+  /**
+   * 验证角色邮件收到的验证码
+   *
+   * https://kdocs.cn/l/cgp4gSBMbOf1?linkname=BhEdxXC5E4
+   */
+  async verifyLinkSecondaryPlayerOtp(r, t) {
+    if (!await this.autoLogin()) return null;
+    const { data: i } = await this.req.post(
+      "club/verify-link-secondary-player-otp",
+      { ticket: r, otp: t },
+      b
+    );
+    return i;
+  }
+  /**
+   * 关联副游戏账号至俱乐部会员，适用于游戏外环境
+   *
+   * https://kdocs.cn/l/cgp4gSBMbOf1?linkname=QNi2C2D0vO
+   */
+  async linkSecondaryPlayerWithTicket(r) {
+    if (!await this.autoLogin()) return null;
+    const { data: t } = await this.req.post("club/link-secondary-player", { ticket: r }, a);
+    return (t == null ? void 0 : t.player) || null;
+  }
+  /**
+   * 关联副游戏账号至俱乐部会员，适用于游戏内嵌页环境
+   *
+   * https://kdocs.cn/l/cgp4gSBMbOf1?linkname=QNi2C2D0vO
+   */
+  async linkSecondaryPlayerWithIdToken(r) {
+    if (!await this.autoLogin()) return null;
+    const { data: t } = await this.req.post("club/link-secondary-player", { id_token: r }, a);
+    return (t == null ? void 0 : t.player) || null;
+  }
+}
+function k(e) {
+  return n(e, "event_name", "rules", "since", "until", "visit_count", "features") && Array.isArray(e.features) && e.features.every(C);
+}
+function C(e) {
+  if (!L(e))
+    return !1;
+  switch (e.feature_type) {
+    case "preregister":
+    case "claim_rewards":
+    case "register":
+    case "invited_register":
+      return !0;
+    case "lottery":
+      return S(e.config);
+    case "survey":
+      return F(e.config);
+    case "invite":
+      return R(e.config);
+    case "share":
+      return P(e.config);
+    case "follow":
+      return T(e.config);
+    case "weixin_subscribe":
+      return x(e.config);
+    case "comment":
+      return D(e.config);
+    case "vote":
+      return U(e.config);
+    case "cashback":
+      return $(e.config);
+    case "gift_code":
+      return I(e.config);
+    case "quest":
+      return j(e.config);
+    case "team":
+      return O(e.config);
+    case "lottery_draw":
+      return V(e.config);
+  }
+}
+function c(e) {
+  return n(
+    e,
+    "reward_item_id",
+    "reward_amount",
+    "reward_item_name",
+    "reward_item_icon_url",
+    "reward_item_type"
+  );
+}
+function q(e) {
+  return n(e, "feature_reward_type", "reward_details") && (e.feature_reward_type === "every" ? Array.isArray(e.reward_details) && e.reward_details.every(c) : e.feature_reward_type === "regular" ? n(e.reward_details, "engage_count", "rewards") && Array.isArray(e.reward_details.rewards) && e.reward_details.rewards.every(c) : !1);
+}
+function L(e) {
+  return n(
+    e,
+    "feature_id",
+    "feature_name",
+    "feature_type",
+    "cycle",
+    "description",
+    "limit",
+    "since",
+    "until",
+    "engage_account_type",
+    "feature_rewards"
+  ) && Array.isArray(e.feature_rewards) && e.feature_rewards.every(q);
+}
+function E(e) {
+  return n(
+    e,
+    "reward_item_id",
+    "reward_item_name",
+    "reward_item_type",
+    "reward_item_icon_url",
+    "reward_amount",
+    "reward_remaining_stock"
+  );
+}
+function S(e) {
+  return n(
+    e,
+    "consume_item_id",
+    "consume_item_name",
+    "consume_item_icon_url",
+    "consume_item_count",
+    "rewards"
+  ) && Array.isArray(e.rewards) && e.rewards.every(E);
+}
+function F(e) {
+  return n(e, "survey_id", "survey_url");
+}
+function R(e) {
+  return n(e, "share_url");
+}
+function P(e) {
+  return n(e, "share_platform");
+}
+function T(e) {
+  return n(e, "platform");
+}
+function x(e) {
+  return n(e, "weixin_template_ids") && Array.isArray(e.weixin_template_ids) && e.weixin_template_ids.every((r) => typeof r == "string");
+}
+function D(e) {
+  return n(e, "comments", "send_rate") && Array.isArray(e.comments) && e.comments.every((r) => typeof r == "string");
+}
+function U(e) {
+  return n(
+    e,
+    "vote_feature_ids",
+    "submission_feature_ids",
+    "finalists_amount",
+    "source",
+    "options",
+    "rewards"
+  ) && Array.isArray(e.vote_feature_ids) && Array.isArray(e.submission_feature_ids) && Array.isArray(e.options) && e.options.every(G) && Array.isArray(e.rewards) && e.rewards.every(c);
+}
+function G(e) {
+  return n(e, "sn", "name", "amount", "jump_url", "last_vote_time", "finalists") && ("img_urls" in e ? Array.isArray(e.img_urls) : !0) && ("video_urls" in e ? Array.isArray(e.video_urls) : !0) && ("descriptions" in e ? Array.isArray(e.descriptions) : !0);
+}
+function $(e) {
+  return n(
+    e,
+    "order_start_time",
+    "order_end_time",
+    "claim_rewards_start_time",
+    "claim_rewards_end_time"
+  );
+}
+function I(e) {
+  return n(e, "gift_items") && Array.isArray(e.gift_items) && e.gift_items.every(Q);
+}
+function Q(e) {
+  return n(e, "name", "count", "icon_url");
+}
+function j(e) {
+  return n(e, "objective", "completion_value") && ("team" in e ? n(e.team, "completion_value") : !0);
+}
+function O(e) {
+  return n(e, "min_members", "max_members");
+}
+function V(e) {
+  return n(e, "draw_not_after", "draw_not_before");
+}
+function o(e) {
+  return n(e, "count");
+}
+function B(e) {
+  return n(e, "engagements") && Array.isArray(e.engagements) && (e.engagements.every(
+    (r) => n(r, "user_id", "name", "avatar_url", "comment", "video_note", "created_at")
+  ) || e.engagements.every((r) => n(r, "objective", "leader_name", "total_members")));
+}
+function W(e) {
+  return n(e, "first_visit") && typeof e.first_visit == "boolean";
+}
+function M(e) {
+  return n(e, "status") && Array.isArray(e.status) && e.status.every((r) => n(r, "feature_id", "can_engage", "has_unclaimed_rewards"));
+}
+function z(e) {
+  return n(e, "engagements") && Array.isArray(e.engagements) && e.engagements.every(K);
+}
+function K(e) {
+  if (!n(
+    e,
+    "engagement_id",
+    "sequence",
+    "feature_id",
+    "reward_id",
+    "reward_status",
+    "reward_source",
+    "created_at"
+  ))
+    return !1;
+  if (!("data" in e))
+    return !0;
+  const r = e.data;
+  return H(r) || J(r) || N(r) || X(r) || Y(r) || Z(r) || ee(r) || re(r) || te(r) || ne(r) || ie(r) || se(r);
+}
+function H(e) {
+  return n(e, "platforms") && Array.isArray(e.platforms);
+}
+function J(e) {
+  return n(e, "lottery_count");
+}
+function N(e) {
+  return n(e, "serial_number");
+}
+function X(e) {
+  return n(e, "user_id", "name", "avatar_url");
+}
+function Y(e) {
+  return n(e, "platform");
+}
+function Z(e) {
+  return n(e, "option_sn");
+}
+function ee(e) {
+  return n(e, "weixin_openid");
+}
+function re(e) {
+  return n(e, "cashback_total_amount", "game_item_count", "order_total_amount");
+}
+function te(e) {
+  return n(e, "gift_code");
+}
+function ne(e) {
+  return n(e, "team_code", "visibility", "members") && Array.isArray(e.members) && e.members.every(
+    (r) => n(r, "is_leader", "role_name", "server_name")
+  );
+}
+function ie(e) {
+  return n(e, "objective", "progress") ? "team" in e ? n(e.team, "progress", "players") && Array.isArray(e.team.players) && e.team.players.every(
+    (r) => n(
+      r,
+      "user_id",
+      "role_name",
+      "is_leader"
+    )
+  ) : !0 : !1;
+}
+function se(e) {
+  return !n(e, "tickets") || !("status" in e) ? !1 : e.status === "unknown" || e.status === "pending" ? !0 : "reward" in e ? n(
+    e.reward,
+    "reward_id",
+    "reward_item_id",
+    "reward_item_name",
+    "reward_source",
+    "reward_item_type",
+    "reward_item_icon_url",
+    "reward_amount",
+    "reward_status",
+    "event_id",
+    "event_name",
+    "feature_id",
+    "engagement_id",
+    "feature_type",
+    "receive_time"
+  ) && ("extra_data" in e.reward ? n(e.reward.extra_data) : !0) : !1;
+}
+function ae(e) {
+  return n(e, "scene");
+}
+function ue(e) {
+  return n(e, "params");
+}
+function oe(e) {
+  return n(e, "img") && typeof e.img == "string";
+}
+class ye {
+  /**
+   * 创建 EventApi 实例
+   *
+   * @param baseRequest - Gamer 通用的 request 工具实例，baseUrl 仅仅包含 endpoint + version
+   * @param autoLogin - 自动登录函数，由上层组件提供
+   */
+  constructor(r, t) {
+    s(this, "req");
+    s(this, "autoLogin");
+    s(this, "event", 0);
+    this.req = r, this.autoLogin = t;
+  }
+  /**
+   * 设置 Event Id，以供后续 api 请求中使用
+   */
+  setEventId(r) {
+    return this.event = r, this;
+  }
+  /**
+   * 获取运营活动的基础配置信息
+   *
+   * https://kdocs.cn/l/ckWFDcOsYEUA?linkname=wFXxtdNKPm
+   */
+  async getEventConfig() {
+    const { data: r } = await this.req.get(`event/${this.event}/event-config`, k);
+    return r;
+  }
+  /**
+   * 获取某个玩法参与用户数量
+   *
+   * https://kdocs.cn/l/ckWFDcOsYEUA?linkname=ejPOcWMvT1
+   */
+  async getEngagementsUserCount(r) {
+    const { data: t } = await this.req.get(`event/${this.event}/feature-engagement-count`, o, {
+      params: { feature_id: r, type: "user" }
+    });
+    return (t == null ? void 0 : t.count) ?? null;
+  }
+  /**
+   * 获取某个玩法参与次数
+   *
+   * https://kdocs.cn/l/ckWFDcOsYEUA?linkname=ejPOcWMvT1
+   */
+  async getEngagementsCount(r) {
+    const { data: t } = await this.req.get(`event/${this.event}/feature-engagement-count`, o, {
+      params: { feature_id: r, type: "engagement" }
+    });
+    return (t == null ? void 0 : t.count) ?? null;
+  }
+  /**
+   * 获取某个玩法的参与记录（和特定用户无关）
+   *
+   * https://kdocs.cn/l/ckWFDcOsYEUA?linkname=THtZ4ewIQW
+   */
+  async getEngagements(r) {
+    const { data: t } = await this.req.get(`event/${this.event}/feature-engagements`, B, {
+      params: { feature_id: r }
+    });
+    return (t == null ? void 0 : t.engagements) || [];
+  }
+  /**
+   * 用户访问某个活动，需要先设置 idToken / weixinToken，返回是否
+   *
+   * https://kdocs.cn/l/ckWFDcOsYEUA?linkname=DWtJrnrBCn
+   */
+  async userVisit(r) {
+    if (!await this.autoLogin()) return null;
+    const { data: t } = await this.req.post(`event/${this.event}/visit`, u(r || {}), W);
+    return t ? { ...t } : null;
+  }
+  /**
+   * 获取用户在目标活动下的所有玩法的参与状态，用于前端进一步确定如何执行交互逻辑
+   *
+   * https://kdocs.cn/l/ckWFDcOsYEUA?linkname=WzX5BrMNpL
+   */
+  async getUserFeatureStatus(r, t) {
+    if (!await this.autoLogin()) return [];
+    const { data: i } = await this.req.get("event/user-feature-status", M, {
+      params: u({
+        event_id: this.event,
+        server_id: r,
+        role_id: t
+      })
+    });
+    return (i == null ? void 0 : i.status) || [];
+  }
+  /**
+   * 获取当前登录用户参与某个玩法的记录
+   *
+   * https://kdocs.cn/l/ckWFDcOsYEUA?linkname=WSbAeDZc8F
+   */
+  async getUserEngagements(r) {
+    if (!await this.autoLogin()) return [];
+    const { data: t } = await this.req.get(`event/${this.event}/user-engagements`, z, {
+      params: { feature_id: r }
+    });
+    return (t == null ? void 0 : t.engagements) || [];
+  }
+  /**
+   * 查询用户活动道具数量。注意，这里只能是活动道具
+   *
+   * https://kdocs.cn/l/ckWFDcOsYEUA?linkname=mnGCTeTgMb
+   */
+  async getUserItemCount(r) {
+    if (!await this.autoLogin()) return null;
+    const { data: t } = await this.req.get(`event/${this.event}/user-item-count`, o, {
+      params: { item_id: r }
+    });
+    return (t == null ? void 0 : t.count) ?? null;
+  }
+  /**
+   * 填写实物奖励收货地址
+   *
+   * https://kdocs.cn/l/ckWFDcOsYEUA?linkname=QIwGhnaexb
+   */
+  async submitUserRewardAddress(r) {
+    if (!await this.autoLogin()) return null;
+    const { ok: t } = await this.req.post(`event/${this.event}/user-reward-address`, r);
+    return t;
+  }
+  /**
+   * 小程序码携带参数最多 32 个可见字符，若前端携带参数过长，则将参数保存在 api 中，并返回符合小程序码要求的 scene
+   *
+   * https://kdocs.cn/l/ckWFDcOsYEUA?linkname=TbEeyUmZzN
+   *
+   * @param params - 前端扫描二维码打开小程序所需参数
+   */
+  async getUnlimitQrcodeScene(r) {
+    if (!await this.autoLogin()) return null;
+    const { data: t } = await this.req.get("event/unlimit-qrcode-scene", ae, {
+      params: { params: r }
+    });
+    return (t == null ? void 0 : t.scene) ?? null;
+  }
+  /**
+   * 根据小程序码携带 scene 值，获取对应的前端所需参数
+   *
+   * https://kdocs.cn/l/ckWFDcOsYEUA?linkname=SzWPFZDQBV
+   *
+   * @param scene - 小程序码 scene 值
+   */
+  async getParamsByQrcodeScene(r) {
+    const { data: t } = await this.req.get("event/params-by-qrcode-scene", ue, {
+      params: { scene: r }
+    });
+    return (t == null ? void 0 : t.params) ?? null;
+  }
+  /**
+   * 生成不限制的带参数的小程序码
+   *
+   * https://kdocs.cn/l/ckWFDcOsYEUA?linkname=Rvmoq8iIy0
+   */
+  async generateUnlimitQrcode(r) {
+    if (!await this.autoLogin()) return null;
+    const { data: t } = await this.req.post("event/unlimit-qrcode", u(r), oe);
+    return (t == null ? void 0 : t.img) ?? null;
+  }
+}
+export {
+  fe as C,
+  ye as E,
+  me as G,
+  _e as c,
+  ge as i
+};

package/dist/index.js

@@ -0,0 +1,42 @@
+var a = Object.defineProperty;
+var h = (i, s, e) => s in i ? a(i, s, { enumerable: !0, configurable: !0, writable: !0, value: e }) : i[s] = e;
+var r = (i, s, e) => h(i, typeof s != "symbol" ? s + "" : s, e);
+import { NetRequest as o } from "@seayoo-web/request";
+import { G as u, E as c, C as m, c as g, i as k } from "./event-CXcuEQsA.js";
+class T extends u {
+  constructor(e, t) {
+    super(e, (t == null ? void 0 : t.version) || "v1", o);
+    /** event api 集合 */
+    r(this, "event");
+    /** club api 集合 */
+    r(this, "club");
+    const n = this.autoLogin.bind(this);
+    this.event = new c(this.req, n), this.club = new m(this.req, n), t != null && t.eventId && this.event.setEventId(t.eventId);
+  }
+  /**
+   * 用世游通行证统一登录能力签发的 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()
+   * ```
+   */
+  async autoLogin() {
+    if (this.gamerToken)
+      return !0;
+    if (!this.idToken)
+      return g.error("Missing idToken when call autoLogin()"), !1;
+    const { data: e } = await this.req.post("login-with-token", { id_token: this.idToken }, k);
+    return this.gamerToken = (e == null ? void 0 : e.gamer_token) || "", !!this.gamerToken;
+  }
+}
+export {
+  T as GamerApi
+};