@seayoo-web/gamer-api 2.2.2 → 2.3.1

package/types/src/token.d.ts

@@ -1,93 +0,0 @@
-import { type StorageHelper } from "./utils";
-import type { NetRequestFactory } from "@seayoo-web/request";
-export * from "./token.define";
-/**
- * auth 管理工具 + request 工具
- *
- * 核心概念如下：
- *
- * - [ID Token](https://365.kdocs.cn/l/ctrXywvA1Wfd)
- * - [Gamer Token](https://365.kdocs.cn/l/crZwOsI54RBH)
- * - [Weixin Token](https://kdocs.cn/l/cf2mO2uRLqh9?linkname=YtzQpmRQ0v)
- */
-export declare class AuthToken {
-    private $NetRequest;
-    private $idToken;
-    private $weixinToken;
-    private $gamerToken;
-    req: ReturnType<NetRequestFactory>;
-    storage: StorageHelper;
-    constructor(
-    /**
-     * 服务端点
-     *
-     * https://kdocs.cn/l/cf2mO2uRLqh9?linkname=k2iGGXbfov
-     */
-    endpoint: string, 
-    /** request 工具类 */
-    NetRequest: NetRequestFactory);
-    get NetRequest(): typeof import("@seayoo-web/request").NetRequest;
-    private loadGamerTokenCache;
-    /** 当前是否为登录状态，即是否拥有 gamerToken */
-    get isLoggedIn(): boolean;
-    /** 读取已经设置的 idToken */
-    get idToken(): string;
-    /** 设置从登录组件获取的 Id Token，用于后续请求自动置换 Gamer Token */
-    set idToken(value: string);
-    /** 读取设置 weixinToken */
-    get weixinToken(): string;
-    /**
-     * 设置 Weixin Token，用于后续请求自动置换 Gamer Token
-     *
-     * 仅仅在微信小程序模式下有效
-     */
-    set weixinToken(value: string);
-    /** 读取自动置换的 gamerToken */
-    get gamerToken(): string;
-    /**
-     * 直接写入 Gamer Token，并更新缓存
-     */
-    set gamerToken(value: string);
-    /**
-     * 退出登录，销毁相关 Token
-     */
-    logout(): void;
-    /**
-     * 用世游通行证统一登录能力签发的 ID Token / Weixin Token，自动置换 Gamer Token，成功后会自动设置后续 Request Headers
-     *
-     * [世游通行证统一登录](https://kdocs.cn/l/cf2mO2uRLqh9?linkname=FJXYgqvLHs)
-     *
-     * [世游通行证统一登录 - Web 站点](https://365.kdocs.cn/l/cf57sp1qLlZh)
-     *
-     * [世游通行证统一登录 - 微信小程序](https://365.kdocs.cn/l/ccHVuUs0UsZs)
-     *
-     * - 此方法通常不需要手动调用，在需要登录的接口调用时会自动执行
-     * - 为了提高页面执行速度，可以在设置 Token 后立即调用 autoLogin
-     *
-     * 🔕请求静默进行，无消息提示
-     *
-     * https://kdocs.cn/l/cf2mO2uRLqh9?linkname=ReeJpWraRO
-     */
-    autoLogin(): Promise<boolean>;
-    /**
-     * 获取当前登录用户的 Session 的信息
-     *
-     * 🔕请求静默进行，无消息提示
-     *
-     * https://kdocs.cn/l/cf2mO2uRLqh9?linkname=OdGVCdQxEu
-     */
-    getSession(): Promise<import("./token.define").GamerSession | null>;
-    /**
-     * 实名认证
-     *
-     * https://kdocs.cn/l/cf2mO2uRLqh9?linkname=kZYnwX6RcF
-     */
-    authRealName(option: {
-        /** 用户输入的真实姓名。明文或者密文 */
-        real_name: string;
-        /** 用户输入的身份证号码。明文或者密文 */
-        identity_card: string;
-        /** 预留参数，是否加密 real_name 和 identity_card，加密的密钥应当使用 api 服务的 ECDSA Public Key */
-        encrypted?: boolean;
-    }): Promise<import("./token.define").GamerSession | null>;
-}

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

@@ -1,31 +0,0 @@
-export type PopupFn = (option: {
-    title?: string;
-    content: string;
-    cancelText?: string;
-    confirmText: string;
-    onCancel?: () => void;
-    onConfirm: () => void;
-}) => void;
-export type ToastFn = (content: string, timeout?: number) => void;
-export interface GamerSession {
-    /** 世游通行证 ID */
-    seayoo_user_id?: string;
-    /** 手机号码（掩码形式） */
-    seayoo_mobile?: string;
-    /**
-     * 世游通行证用户实名信息（掩码形式）；即将去除此字段，使用 has_real_name 代替
-     * https://kdocs.cn/l/cf2mO2uRLqh9?linkname=OdGVCdQxEu
-     * @deprecated
-     */
-    seayoo_real_name?: string;
-    /** 是否已经具有世游通行证用户实名信息 */
-    has_real_name?: boolean;
-    /** 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;
-}

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

@@ -1,5 +0,0 @@
-import type { GamerSession } from "./token.define";
-export declare function isGamerTokenResponse(data: unknown): data is {
-    gamer_token: string;
-};
-export declare function isGetSessionResponse(data: unknown): data is GamerSession;

package/types/src/utils.d.ts

@@ -1,12 +0,0 @@
-export declare const console: Pick<Console, "log" | "error" | "warn">;
-/** 检测是否在 combo webview */
-export declare function inComboWebview(): boolean;
-export declare function isRootEndpoint(path: string): boolean;
-export declare function getWeixinLoginCode(): Promise<string>;
-export type StorageHelper = {
-    set(key: string, value: string): void;
-    get(key: string): string;
-    remove(key: string): void;
-};
-export declare const localStorageHelper: StorageHelper;
-export declare const weixinStorageHelper: StorageHelper;

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

@@ -1,46 +0,0 @@
-export interface WeixinLoginResponse {
-    /** 微信小程序下，用户的 open_id */
-    open_id: string;
-    /** 微信小程序所在的微信开放平台账号下，用户的 union_id */
-    union_id: string;
-    /**
-     * Gamer 为这个微信小程序用户签发的 Weixin Token。长期有效
-     *
-     * 对 Weixin Token 的详细描述请阅读 [世游用户运营 - JWT 场景与规范](https://365.kdocs.cn/l/cbxbzWc6zSgY)
-     */
-    weixin_token: string;
-}
-export declare const isWeixinSignResponse: (data: unknown) => data is {
-    nonce_str: string;
-    timestamp: number;
-    signature: string;
-};
-/**
- * 微信web登录错误码
- *
- * https://developers.weixin.qq.com/doc/offiaccount/OA_Web_Apps/Wechat_webpage_authorization.html
- */
-export declare const enum WeixinWebLoginErrorCode {
-    /** redirect_uri域名与后台配置不一致 */
-    RedirectUriDisMatch = "10003",
-    /** 不支持微信开放平台的 Appid，请使用公众号Appid */
-    AppidError = "10016",
-    /** 公众号未授权第三方平台，请检查授权状态 */
-    AuthorizationError = "10015",
-    /** 此公众号并没有这些 scope 的权限 */
-    NoRightForScope = "10005",
-    /** 操作太频繁了，请稍后重试 */
-    Frequently = "10009",
-    /** 此公众号被封禁 */
-    AppBanded = "10004",
-    /** 必须关注此测试号 */
-    ShouldFollow = "10006",
-    /** scope不能为空 */
-    ScopeNull = "10010",
-    /** redirect_uri不能为空 */
-    RedirectUriNull = "10011",
-    /** appid不能为空 */
-    AppidNull = "10012",
-    /** state不能为空 */
-    StateNull = "10013"
-}

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

@@ -1,2 +0,0 @@
-import type { WeixinLoginResponse } from "./weixin.define";
-export declare function isWeixinLoginResponse(data: unknown): data is WeixinLoginResponse;