@seayoo-web/gamer-api 1.1.18 → 2.0.0

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

@@ -1,187 +1,376 @@
+import { type ValueOf } from "@seayoo-web/utils";
 /** 道具类型 */
-export declare const enum GamerItemType {
+export declare const GamerItemType: {
     /** 活动道具 */
-    EventItem = "event_item",
+    readonly EventItem: "event_item";
     /** 游戏内道具 */
-    GameItem = "game_item",
+    readonly GameItem: "game_item";
     /** 实物 */
-    PhysicalItem = "physical_item",
+    readonly PhysicalItem: "physical_item";
     /** 微信红包 */
-    WeixinHongbao = "weixin_hongbao",
+    readonly WeixinHongbao: "weixin_hongbao";
     /** 礼包码 */
-    GiftCode = "gift_code",
+    readonly GiftCode: "gift_code";
     /** 抽奖券 */
-    LotteryTicket = "lottery_ticket",
+    readonly LotteryTicket: "lottery_ticket";
+    /** 积分 */
+    readonly Credit: "credit";
     /** 空奖励 */
-    VoidItem = "void_item"
-}
+    readonly VoidItem: "void_item";
+};
+export type GamerItemType = ValueOf<typeof GamerItemType>;
+export declare const GamerItemTypeValidator: import("@seayoo-web/utils").StringValidator<GamerItemType, false, false> & {
+    pattern: never;
+    url: never;
+    dataUri: never;
+    enum: never;
+    disallow: never;
+    optional: never;
+    maybeNull: never;
+    lock: never;
+};
+export declare const RewardItemType: {
+    /** 活动道具 */
+    readonly EventItem: "event_item";
+    /** 游戏内道具 */
+    readonly GameItem: "game_item";
+    /** 实物 */
+    readonly PhysicalItem: "physical_item";
+    /** 微信红包 */
+    readonly WeixinHongbao: "weixin_hongbao";
+    /** 礼包码 */
+    readonly GiftCode: "gift_code";
+    /** 抽奖券 */
+    readonly LotteryTicket: "lottery_ticket";
+    /** 积分 */
+    readonly Credit: "credit";
+    /** 空奖励 */
+    readonly VoidItem: "void_item";
+};
+export type RewardItemType = GamerItemType;
+export declare const RewardItemTypeValidator: import("@seayoo-web/utils").StringValidator<GamerItemType, false, false> & {
+    pattern: never;
+    url: never;
+    dataUri: never;
+    enum: never;
+    disallow: never;
+    optional: never;
+    maybeNull: never;
+    lock: never;
+};
 /** 参与活动的账号类型 */
-export declare const enum EngageAccountType {
+export declare const EngageAccountType: {
     /** 世游通行证 ID / Combo ID */
-    UserId = "user_id",
+    readonly UserId: "user_id";
     /** 游戏角色 ID */
-    RoleId = "role_id"
-}
+    readonly RoleId: "role_id";
+};
+export type EngageAccountType = ValueOf<typeof EngageAccountType>;
+export declare const EngageAccountTypeValidator: import("@seayoo-web/utils").StringValidator<EngageAccountType, false, false> & {
+    pattern: never;
+    url: never;
+    dataUri: never;
+    enum: never;
+    disallow: never;
+    optional: never;
+    maybeNull: never;
+    lock: never;
+};
 /** 玩法刷新周期类型 */
-export declare const enum EventPeriodType {
-    None = "none",
-    Daily = "daily",
-    Weekly = "weekly",
-    Monthly = "monthly"
-}
+export declare const EventPeriodType: {
+    readonly None: "none";
+    readonly Daily: "daily";
+    readonly Weekly: "weekly";
+    readonly Monthly: "monthly";
+};
+export type EventPeriodType = ValueOf<typeof EventPeriodType>;
+export declare const EventPeriodTypeValidator: import("@seayoo-web/utils").StringValidator<EventPeriodType, false, false> & {
+    pattern: never;
+    url: never;
+    dataUri: never;
+    enum: never;
+    disallow: never;
+    optional: never;
+    maybeNull: never;
+    lock: never;
+};
 /** 活动玩法类型 */
-export declare const enum FeatureType {
+export declare const FeatureType: {
     /** 预约 */
-    Preregister = "preregister",
+    readonly Preregister: "preregister";
     /** 抽奖 */
-    Lottery = "lottery",
+    readonly Lottery: "lottery";
     /** 问卷 */
-    Survey = "survey",
+    readonly Survey: "survey";
     /** 邀请 */
-    Invite = "invite",
+    readonly Invite: "invite";
     /** 分享 */
-    Share = "share",
+    readonly Share: "share";
     /** 关注社交媒体 */
-    Follow = "follow",
+    readonly Follow: "follow";
     /** 微信小程序订阅消息 */
-    Subscribe = "weixin_subscribe",
+    readonly Subscribe: "weixin_subscribe";
     /** 弹幕/评论 */
-    Comment = "comment",
+    readonly Comment: "comment";
     /** 投票 */
-    Vote = "vote",
+    readonly Vote: "vote";
     /** 礼包码 */
-    GiftCode = "gift_code",
+    readonly GiftCode: "gift_code";
     /** 注册 */
-    Register = "register",
+    readonly Register: "register";
     /** 受邀注册 */
-    InvitedRegister = "invited_register",
+    readonly InvitedRegister: "invited_register";
     /** 领奖 */
-    ClaimRewards = "claim_rewards",
+    readonly ClaimRewards: "claim_rewards";
     /** 充值返还 */
-    Cashback = "cashback",
+    readonly Cashback: "cashback";
     /** 任务 */
-    Quest = "quest",
+    readonly Quest: "quest";
     /** 组队 */
-    Team = "team",
+    readonly Team: "team";
     /** 开奖 */
-    LotteryDraw = "lottery_draw",
+    readonly LotteryDraw: "lottery_draw";
     /** 签到 */
-    CheckIn = "check_in"
-}
+    readonly CheckIn: "check_in";
+};
+export type FeatureType = ValueOf<typeof FeatureType>;
+export declare const FeatureTypeValidator: import("@seayoo-web/utils").StringValidator<FeatureType, false, false> & {
+    pattern: never;
+    url: never;
+    dataUri: never;
+    enum: never;
+    disallow: never;
+    optional: never;
+    maybeNull: never;
+    lock: never;
+};
 /** 任务玩法的目标类型 */
-export declare const enum QuestObjective {
+export declare const QuestObjective: {
     /** 累计游戏内活跃值 */
-    Active = "player_active_points",
+    readonly Active: "player_active_points";
     /** 累计登录，单位 人天 */
-    Login = "player_login_days",
+    readonly Login: "player_login_days";
     /** 累计充值金额 */
-    OrderAmount = "order_total_amount",
+    readonly OrderAmount: "order_total_amount";
     /** 社区发帖数量 */
-    Posts = "community_posts",
+    readonly Posts: "community_posts";
     /** 社区评论数量 */
-    Comments = "community_comments"
-}
+    readonly Comments: "community_comments";
+};
+export type QuestObjective = ValueOf<typeof QuestObjective>;
+export declare const QuestObjectiveValidator: import("@seayoo-web/utils").StringValidator<QuestObjective, false, false> & {
+    pattern: never;
+    url: never;
+    dataUri: never;
+    enum: never;
+    disallow: never;
+    optional: never;
+    maybeNull: never;
+    lock: never;
+};
 /** 投票数据来源 */
-export declare const enum VoteOptionSource {
+export declare const VoteOptionSource: {
     /** 官方上传 */
-    System = "system",
+    readonly System: "system";
     /** 用户投稿 */
-    UserSubmission = "user_submission",
+    readonly UserSubmission: "user_submission";
     /** 投票入围 */
-    Shortlisted = "shortlisted"
-}
+    readonly Shortlisted: "shortlisted";
+};
+export type VoteOptionSource = ValueOf<typeof VoteOptionSource>;
+export declare const VoteOptionSourceValidator: import("@seayoo-web/utils").StringValidator<VoteOptionSource, false, false> & {
+    pattern: never;
+    url: never;
+    dataUri: never;
+    enum: never;
+    disallow: never;
+    optional: never;
+    maybeNull: never;
+    lock: never;
+};
 /**
- * 奖励领取状态(不含发货状态和领取失败)
+ * 奖励状态
  */
-export declare const enum RewardStatusPrefix {
+export declare const RewardStatus: {
     /** 未获得奖励 */
-    Ineligible = "ineligible",
-    /** 奖励未领取 */
-    Unclaimed = "unaccalimed",
-    /** 奖励已领取 */
-    Received = "received"
-}
-/**
- * 已获得实物奖励的奖励状态
- *
- * @deprecated
- */
-export declare const enum RewardStatusSuffix {
+    readonly Ineligible: "ineligible";
     /** 奖励未领取 */
-    Unclaimed = "unaccalimed",
+    readonly Unclaimed: "unclaimed";
     /** 奖励已领取 */
-    Received = "received",
+    readonly Received: "received";
     /** 奖励发放失败 */
-    Failed = "failed",
+    readonly Failed: "failed";
     /** 奖励已发货 */
-    Delivered = "delivered"
-}
-export declare const enum RewardStatusSuffixV2 {
+    readonly Delivered: "delivered";
+};
+export type RewardStatus = ValueOf<typeof RewardStatus>;
+export declare const RewardStatusValidator: import("@seayoo-web/utils").StringValidator<RewardStatus, false, false> & {
+    pattern: never;
+    url: never;
+    dataUri: never;
+    enum: never;
+    disallow: never;
+    optional: never;
+    maybeNull: never;
+    lock: never;
+};
+/**
+ * 已获得奖励的奖励状态，不含有未领取状态
+ */
+export declare const RewardStatusSuffix: {
     /** 奖励未领取 */
-    Unclaimed = "unclaimed",
+    readonly Unclaimed: "unclaimed";
     /** 奖励已领取 */
-    Received = "received",
+    readonly Received: "received";
     /** 奖励发放失败 */
-    Failed = "failed",
+    readonly Failed: "failed";
     /** 奖励已发货 */
-    Delivered = "delivered"
-}
-export declare const enum CliamRewardStatus {
+    readonly Delivered: "delivered";
+};
+export type RewardStatusSuffix = ValueOf<typeof RewardStatusSuffix>;
+export declare const RewardStatusSuffixValidator: import("@seayoo-web/utils").StringValidator<RewardStatusSuffix, false, false> & {
+    pattern: never;
+    url: never;
+    dataUri: never;
+    enum: never;
+    disallow: never;
+    optional: never;
+    maybeNull: never;
+    lock: never;
+};
+/**
+ * 奖励状态，兼容后端拼写错误的版本
+ */
+export declare const ClaimRewardStatus: {
     /** 未获得奖励 */
-    Ineligible = "ineligible",
+    readonly Ineligible: "ineligible";
+    /**
+     * 奖励未领取，拼写错误以兼容后端历史版本，检查请使用 Unclaimed
+     *
+     * @deprecated
+     */
+    readonly UnclaimedErr: "unaccalimed";
     /** 奖励未领取 */
-    Unaccalimed = "unaccalimed",
+    readonly Unclaimed: "unclaimed";
     /** 奖励已领取 */
-    Received = "received",
+    readonly Received: "received";
     /** 奖励发放失败 */
-    Failed = "failed"
-}
+    readonly Failed: "failed";
+    /** 奖励已发货 */
+    readonly Delivered: "delivered";
+};
+export declare const ClaimRewardStatusValidator: import("@seayoo-web/utils").StringValidator<ClaimRewardStatus, false, false> & {
+    pattern: never;
+    url: never;
+    dataUri: never;
+    enum: never;
+    disallow: never;
+    optional: never;
+    maybeNull: never;
+    lock: never;
+};
+export type ClaimRewardStatus = ValueOf<typeof ClaimRewardStatus>;
 /** 奖励来源 */
-export declare const enum RewardSoure {
+export declare const RewardSource: {
     /** 玩法产出奖励 */
-    Output = "output",
+    readonly Output: "output";
     /** 玩法参与奖励 */
-    Engage = "engage"
-}
+    readonly Engage: "engage";
+};
+export type RewardSource = ValueOf<typeof RewardSource>;
+export declare const RewardSourceValidator: import("@seayoo-web/utils").StringValidator<RewardSource, false, false> & {
+    pattern: never;
+    url: never;
+    dataUri: never;
+    enum: never;
+    disallow: never;
+    optional: never;
+    maybeNull: never;
+    lock: never;
+};
 /** 组队玩法中队伍的可见性 */
-export declare const enum TeamVisibility {
+export declare const TeamVisibility: {
     /** 私有队伍 */
-    Private = "private",
+    readonly Private: "private";
     /** 公开队伍 */
-    Public = "public"
-}
+    readonly Public: "public";
+};
+export type TeamVisibility = ValueOf<typeof TeamVisibility>;
+export declare const TeamVisibilityValidator: import("@seayoo-web/utils").StringValidator<TeamVisibility, false, false> & {
+    pattern: never;
+    url: never;
+    dataUri: never;
+    enum: never;
+    disallow: never;
+    optional: never;
+    maybeNull: never;
+    lock: never;
+};
 /** 抽奖券状态 */
-export declare const enum LotteryTicketStatus {
+export declare const LotteryTicketStatus: {
     /** 未知状态 */
-    Unknown = "unknown",
+    readonly Unknown: "unknown";
     /** 等待开奖 */
-    Pending = "pending",
+    readonly Pending: "pending";
     /** 已开奖，待领奖 */
-    Drawn = "drawn",
+    readonly Drawn: "drawn";
     /** 已领奖 */
-    Claimed = "claimed",
+    readonly Claimed: "claimed";
     /** 领奖失败 */
-    Fail = "fail"
-}
+    readonly Fail: "fail";
+};
+export type LotteryTicketStatus = ValueOf<typeof LotteryTicketStatus>;
+export declare const LotteryTicketStatusValidator: import("@seayoo-web/utils").StringValidator<LotteryTicketStatus, false, false> & {
+    pattern: never;
+    url: never;
+    dataUri: never;
+    enum: never;
+    disallow: never;
+    optional: never;
+    maybeNull: never;
+    lock: never;
+};
 /** 组队玩法队伍操作类型 */
-export declare const enum TeamAction {
+export declare const TeamAction: {
     /** 发起组队 */
-    Assemble = "assemble",
+    readonly Assemble: "assemble";
     /** 加入队伍 */
-    Join = "join",
+    readonly Join: "join";
     /** 解散队伍 */
-    Disband = "disband",
+    readonly Disband: "disband";
     /** 修改队伍可见性 */
-    ChangeVisibility = "change_visibility",
+    readonly ChangeVisibility: "change_visibility";
     /** 查询组队信息 */
-    Query = "query"
-}
+    readonly Query: "query";
+};
+export type TeamAction = ValueOf<typeof TeamAction>;
+export declare const TeamActionValidator: import("@seayoo-web/utils").StringValidator<TeamAction, false, false> & {
+    pattern: never;
+    url: never;
+    dataUri: never;
+    enum: never;
+    disallow: never;
+    optional: never;
+    maybeNull: never;
+    lock: never;
+};
 /** 抽奖券玩法操作类型 */
-export declare const enum LotteryDrawAction {
+export declare const LotteryDrawAction: {
     /** 查询抽奖券 */
-    Query = "query",
+    readonly Query: "query";
     /** 开奖 */
-    Draw = "draw",
+    readonly Draw: "draw";
     /** 领奖 */
-    Claim = "claim"
-}
+    readonly Claim: "claim";
+};
+export type LotteryDrawAction = ValueOf<typeof LotteryDrawAction>;
+export declare const LotteryDrawActionValidator: import("@seayoo-web/utils").StringValidator<LotteryDrawAction, false, false> & {
+    pattern: never;
+    url: never;
+    dataUri: never;
+    enum: never;
+    disallow: never;
+    optional: never;
+    maybeNull: never;
+    lock: never;
+};

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

@@ -1,42 +1,38 @@
-import type { ClaimedItem, CommentEngagement, EngageResponse, Reward, TeamEngagement, UserEngagement, UserEngagementV2, UserFeatureStatus, UserReward, VerifyMobileResult } from "./event.define";
-import type { CliamRewardStatus } from "./event.enums";
-export declare function isVerifyMobileResponse(data: unknown): data is VerifyMobileResult;
-export declare function isCommonCountResponse(data: unknown): data is {
+export declare const isEventConfig: (data: unknown) => data is import("./event.config").EventConfig;
+export declare const isVerifyMobileResponse: (data: unknown) => data is import("./event.define").VerifyMobileResult;
+export declare const isCommonCountResponse: (data: unknown) => data is {
     count: number;
 };
-export declare function isEngamentsResponse(data: unknown): data is {
-    engagements: CommentEngagement[] | TeamEngagement[];
-};
-export declare function isUserVisitResponse(data: unknown): data is {
+export declare const isUserVisitResponse: (data: unknown) => data is {
     first_visit: boolean;
 };
-export declare function isUserFeatureStatusResponse(data: unknown): data is {
-    status: UserFeatureStatus[];
+export declare const isEngagementsResponse: (data: unknown) => data is {
+    engagements: import("./event.engage").CommentEngagement[] | import("./event.engage").TeamEngagement[];
 };
-export declare function isUserEngagementsResponse(data: unknown): data is {
-    engagements: UserEngagement[];
+export declare const isUserFeatureStatusResponse: (data: unknown) => data is {
+    status: import("./event.define").UserFeatureStatus[];
 };
-export declare function isUserEngagementsV2Response(data: unknown): data is {
-    engagements: UserEngagementV2[];
+export declare const isUserEngagementsResponse: (data: unknown) => data is {
+    engagements: import("./event.engage").UserEngagement[];
+    next_token: string | undefined;
 };
-export declare function isUserEngagementV2(data: unknown): data is UserEngagementV2;
-export declare function isReward(data: unknown): data is Reward;
-export declare function isEngageResponse(data: unknown): data is EngageResponse;
-export declare function isClaimRewardsResponse(data: unknown): data is {
-    claimed_items: ClaimedItem[];
+export declare const isEngageResponse: (data: unknown) => data is import("./event.define").EngageResponse;
+export declare const isClaimRewardsResponse: (data: unknown) => data is {
+    claimed_items: import("./event.define").ClaimedItem[];
 };
-export declare function isClaimWeixinHongbaoResponse(data: unknown): data is {
-    reward_status: CliamRewardStatus;
+export declare const isClaimWeixinHongbaoResponse: (data: unknown) => data is {
+    reward_status: import("./event.enums").ClaimRewardStatus;
 };
-export declare function isGetUserRewardsResponse(data: unknown): data is {
-    user_rewards: UserReward[];
+export declare const isGetUserRewardsResponse: (data: unknown) => data is {
+    user_rewards: import("./event.engage/reward").UserReward[];
+    next_token: string | undefined;
 };
-export declare function isGetUnlimitQrcodeSceneResponse(data: unknown): data is {
+export declare const isGetUnlimitQrcodeSceneResponse: (data: unknown) => data is {
     scene: string;
 };
-export declare function isGetParamsByQrcodeSceneResponse(data: unknown): data is {
+export declare const isGetParamsByQrcodeSceneResponse: (data: unknown) => data is {
     params: string;
 };
-export declare function isGenerateUnlimitQrcodeResponse(data: unknown): data is {
+export declare const isGenerateUnlimitQrcodeResponse: (data: unknown) => data is {
     img: string;
 };

package/types/src/token.d.ts

@@ -27,12 +27,12 @@ export declare class AuthToken {
     NetRequest: NetRequestFactory);
     private loadGamerTokenCache;
     /** 当前是否为登录状态，即是否拥有 gamerToken */
-    get isLogined(): boolean;
+    get isLoggedIn(): boolean;
     /** 读取已经设置的 idToken */
     get idToken(): string;
     /** 设置从登录组件获取的 Id Token，用于后续请求自动置换 Gamer Token */
     set idToken(value: string);
-    /** 读取设置 wexinToken */
+    /** 读取设置 weixinToken */
     get weixinToken(): string;
     /**
      * 设置 Weixin Token，用于后续请求自动置换 Gamer Token

package/types/src/weixin.d.ts

@@ -1,6 +1,6 @@
 import type { AuthToken } from "./token";
 import type { WeixinWebLoginErrorCode } from "./weixin.define";
-import type { RequestInteralError } from "@seayoo-web/request";
+import type { RequestInternalError } from "@seayoo-web/request";
 export * from "./weixin.define";
 export declare class WeixinApi {
     private token;
@@ -25,7 +25,7 @@ export declare class WeixinApi {
      *
      * 如果没有缓存或缓存数据错误，则需要调用 [wx.login](https://developers.weixin.qq.com/miniprogram/dev/api/open-api/login/wx.login.html) 后调用 login 方法
      *
-     * 也可以直接调用 login 方法，并传入 wxcode 的读取函数
+     * 也可以直接调用 login 方法，并传入 weixin code 的读取函数
      */
     getLoginCache(): Promise<import("./weixin.define").WeixinLoginResponse | null>;
     /**
@@ -46,7 +46,7 @@ export declare class WeixinApi {
      * https://kdocs.cn/l/cf2mO2uRLqh9?linkname=GwIZ0givCb
      */
     login(): Promise<import("./weixin.define").WeixinLoginResponse | {
-        error: RequestInteralError | "invalid_weixin_appid" | "invalid_weixin_code";
+        error: RequestInternalError | "invalid_weixin_appid" | "invalid_weixin_code";
     }>;
     /**
      * 在微信内嵌网页中调用微信公众号授权登录【暂未启用】
@@ -67,7 +67,7 @@ export declare class WeixinApi {
     webLogin(scope?: "snsapi_base" | "snsapi_userinfo"): Promise<import("./weixin.define").WeixinLoginResponse | {
         error: WeixinWebLoginErrorCode;
     } | {
-        error: RequestInteralError | "invalid_weixin_appid" | "invalid_weixin_code";
+        error: RequestInternalError | "invalid_weixin_appid" | "invalid_weixin_code";
     } | undefined>;
     /**
      * 关联游戏账号，无返回值，全程静默

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

@@ -29,7 +29,7 @@ export declare const enum WeixinWebLoginErrorCode {
     /** 此公众号被封禁 */
     AppBanded = "10004",
     /** 必须关注此测试号 */
-    ShouldFllow = "10006",
+    ShouldFollow = "10006",
     /** scope不能为空 */
     ScopeNull = "10010",
     /** redirect_uri不能为空 */