@seayoo-web/captcha 1.0.0

package/README.md

@@ -0,0 +1 @@
+# Captcha

package/dist/index.js

@@ -0,0 +1,59 @@
+var d = Object.defineProperty;
+var h = (a, t, e) => t in a ? d(a, t, { enumerable: !0, configurable: !0, writable: !0, value: e }) : a[t] = e;
+var n = (a, t, e) => h(a, typeof t != "symbol" ? t + "" : t, e);
+import { useConsole as p, EventBus as w, usePromise as l, loadJS as u } from "@seayoo-web/utils";
+const y = p("CaptchaSDK");
+let s;
+async function i() {
+  return "TencentCaptcha" in window && window.TencentCaptcha ? window.TencentCaptcha : s ? await s : (s = u("https://turing.captcha.qcloud.com/TJCaptcha.js").then(() => window.TencentCaptcha ?? null), await s);
+}
+class m {
+  /**
+   * 创建验证码实例，创建后立即开始加载腾讯天御 SDK
+   */
+  constructor(t) {
+    n(this, "sdk", null);
+    n(this, "isReady", !1);
+    n(this, "event", new w());
+    i().then((e) => {
+      if (!e)
+        y.error("Load TencentCaptcha Error!");
+      else {
+        const { captchaAppId: r, ...c } = t;
+        this.sdk = new e(
+          r,
+          (o) => {
+            this.event.emit("done", o);
+          },
+          {
+            ...c,
+            ready: (o) => {
+              this.isReady = !0, this.event.emit("ready", o);
+            }
+          }
+        );
+      }
+    });
+  }
+  /** 提前加载腾讯 js sdk */
+  static preloadSDK() {
+    i();
+  }
+  async ready() {
+    if (this.isReady)
+      return;
+    const { promise: t, resolve: e } = l();
+    this.event.once("ready", e), await t;
+  }
+  async show() {
+    var t;
+    await this.ready(), (t = this.sdk) == null || t.show();
+  }
+  async destroy() {
+    var t;
+    await this.ready(), (t = this.sdk) == null || t.destroy();
+  }
+}
+export {
+  m as TencentCaptchaAgent
+};

package/package.json

@@ -0,0 +1,41 @@
+{
+  "name": "@seayoo-web/captcha",
+  "description": "captcha agent",
+  "version": "1.0.0",
+  "type": "module",
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "source": "./index.ts",
+  "types": "./types/index.d.ts",
+  "files": [
+    "dist",
+    "types",
+    "README.md"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "engines": {
+    "node": ">=18"
+  },
+  "keywords": [
+    "captcha"
+  ],
+  "author": "web@seayoo.com",
+  "license": "MIT",
+  "devDependencies": {
+    "@seayoo-web/scripts": "^1.0.6",
+    "@seayoo-web/tsconfig": "^1.0.2",
+    "@seayoo-web/utils": "^2.2.0"
+  },
+  "peerDependencies": {
+    "@seayoo-web/utils": "^2.2.0"
+  },
+  "scripts": {
+    "build": "vite build && tsc --emitDeclarationOnly",
+    "type-check": "tsc --noEmit",
+    "lint": "eslint ./src/**/*.ts",
+    "lint:fix": "eslint ./src/**/*.{ts,js} --fix",
+    "prepublish": "pnpm lint:fix && pnpm build"
+  }
+}

package/types/index.d.ts

@@ -0,0 +1 @@
+export * from "./src/tencent";

package/types/src/tencent.d.ts

@@ -0,0 +1,127 @@
+/** 对腾讯的sdk做简单声明 */
+declare global {
+    interface Window {
+        TencentCaptcha?: TencentCaptchaSDK;
+    }
+}
+interface VerifyResult {
+    /**
+     * 验证结果。等于 2 时表示用户关闭，不等于 0 表示失败
+     */
+    ret: number;
+    /**
+     * 验证票据，验证成功的票据，当且仅当 ret = 0 时 ticket 有值
+     *
+     * 请求验证码发生错误，验证码自动返回 trerror_ 前缀的容灾票据
+     */
+    ticket: string;
+    /**
+     * 本次验证的随机串
+     */
+    randstr: string;
+    /**
+     * 自定义透传参数
+     */
+    bizState?: unknown;
+    /**
+     *  验证码校验接口耗时（ms）
+     */
+    verifyDuration: number;
+    /**
+     *  操作校验成功耗时（用户动作+校验完成）(ms)
+     */
+    actionDuration: number;
+    /**
+     * 链路 sid
+     */
+    sid: string;
+}
+interface TencentCaptchaSDK {
+    new (captchaAppId: string, callback: (result: VerifyResult) => void, option?: Omit<TencentCaptchaOption, "captchaAppId"> & {
+        showFn?: () => void;
+    }): TencentCaptchaSDKIns;
+}
+interface TencentCaptchaSDKIns {
+    /** 显示验证码，可以反复调用 */
+    show(): void;
+    /** 隐藏验证码，可以反复调用 */
+    destroy(): void;
+    /** 获取验证成功后的 ticket */
+    getTicket(): {
+        CaptchaAppId: string;
+        ticket: string;
+    };
+}
+interface TencentCaptchaOption {
+    captchaAppId: string;
+    /**
+     * 验证码相关资源加载完成的回调，回调参数为验证码实际的宽高（单位：px）
+     *
+     * 该参数仅为查看验证码宽高使用
+     */
+    ready?: (info: {
+        sdkView: {
+            width: number;
+            height: number;
+        };
+    }) => void;
+    /**
+     * 开启自适应深夜模式或强制深夜模式
+     *
+     * - true 开启自适应深夜模式
+     * - "force" 强制深夜模式
+     */
+    enableDarkMode?: boolean | "force";
+    /**
+     * 仅支持移动端原生 webview 调用时传入，用来设置验证码 loading 加载弹窗的大小
+     *
+     * 💡注意，此参数调整的并非验证码弹窗大小
+     */
+    sdkOpts?: {
+        width: number;
+        height: number;
+    };
+    /**
+     * 隐藏帮助按钮或自定义帮助按钮链接
+     */
+    needFeedBack?: boolean | `https://${string}`;
+    /**
+     * 是否在验证码加载过程中显示 loading 框。默认 true
+     *
+     * 💡 如果隐藏 loading，则对应的 loading 半透蒙层也会一并隐藏
+     */
+    loading?: boolean;
+    /**
+     * 指定验证码提示文案的语言，优先级高于控制台配置。大小写不敏感。
+     */
+    userLanguage?: string;
+    /**
+     * 验证码展示方式，默认 "popup"
+     *
+     * - popup 弹出式，以浮层形式居中弹出展示验证码
+     * - embed 嵌入式，以嵌入指定容器元素中的方式展示验证码
+     */
+    type?: "popup" | "embed";
+    /**
+     * CaptchaAppId 加密校验串，详见 [CaptchaAppid 加密校验能力接入指引](https://cloud.tencent.com/document/product/1110/36841#c6a3e517-4962-4932-9bf8-9fb10fd03166)
+     */
+    aidEncrypted?: string;
+}
+/**
+ * 腾讯天御验证码
+ */
+export declare class TencentCaptchaAgent {
+    private sdk;
+    private isReady;
+    private event;
+    /** 提前加载腾讯 js sdk */
+    static preloadSDK(): void;
+    /**
+     * 创建验证码实例，创建后立即开始加载腾讯天御 SDK
+     */
+    constructor(option: Omit<TencentCaptchaOption, "ready">);
+    ready(): Promise<void>;
+    show(): Promise<void>;
+    destroy(): Promise<void>;
+}
+export {};