@auth-link/web 0.0.0-stage → 0.0.2

package/README.md

@@ -1,3 +1,1265 @@
-# Temporary Holding Version
+# AuthLink Web
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+[English](#english) | [简体中文](#简体中文) | [日本語](#日本語)
+
+## English
+
+Responsive dialogs for **AuthLink phone binding and mobile confirmation**, with direct function calls and React / Vue components. Display binding QR codes, synchronized six-digit matching codes, countdowns and confirmation results in any web application. No particular site platform is required.
+
+### Features
+
+- Phone-binding QR codes generated locally in the browser.
+- Matching numbers that update every 30 seconds, synchronized with the AuthLink app.
+- Confirmation, rejection, expiry and error callbacks.
+- React components and hook, Vue components and composable, and framework-independent tools.
+- 13 interface languages, **Simplified Chinese by default**, with per-component language selection.
+- TypeScript declarations, separate CSS and optional React/Vue peer dependencies.
+
+This is a browser integration library. It works with your application backend, the AuthLink service and the mobile app. The service verifies the original phone’s hardware-backed proof after the user approves in the app. Screen-lock checks and system passkeys are not required. Installing the library alone does not create an authentication service.
+
+### Install
+
+```sh
+npm install @auth-link/web
+```
+
+Compatibility: React 18.2+ / 19, Vue 3.3+, TypeScript, ESM. Install only the framework you use. The package declares Node 22.13+ for tooling.
+
+### Browser integration
+
+1. Configure your backend's AuthLink tenant credentials.
+2. Implement the two application backend endpoints below (same-origin or explicitly allowed cross-origin), authenticated to the current website user.
+3. Create a request on a user action and pass its ticket to a component.
+4. Your backend verifies and consumes the result before returning a confirmed response.
+
+The browser can call this library directly. Tenant credentials and result consumption belong on your backend; never embed a tenant API key in frontend code. The supplied client defaults to same-origin and also supports explicitly allowed cross-origin backends. You can supply a custom `AuthLinkClient` to integrate another transport while preserving server-side credential handling and verification.
+
+### Create a client (default same-origin session mode)
+
+`readCsrfTokenFromYourCms` is application code, not an SDK export. It reads a CSRF token issued by your own backend for the current logged-in session; it must not generate one in the browser or return an AuthLink API key. The name does not require a CMS.
+
+Reuse your framework's existing CSRF mechanism. Otherwise, generate a cryptographically random token on the server (for example, Node's `randomBytes(32).toString('base64url')`), persist it in the session, and render it into the authenticated page with HTML attribute escaping. `{{ csrfToken }}` below is a server-template variable, not a literal value. Do not publicly cache pages containing session tokens.
+
+```html
+<meta name="csrf-token" content="{{ csrfToken }}">
+```
+
+The SDK reads the token for every request, sends it as `X-CSRF-Token`, and includes same-origin session cookies. Your backend must validate that header against the token in the same session on both creation and result routes, reject missing/mismatched tokens, and check the expected request origin. Sending a header alone does not provide CSRF protection. Obtain a fresh token after login/session changes; a SPA may supply a token returned by its own same-origin session bootstrap endpoint. If your framework expects another header name, set `csrfHeaderName` or provide a custom `AuthLinkClient`.
+
+Create `authlink-client.ts`:
+
+```ts
+// authlink-client.ts
+import { createAuthLinkClient } from '@auth-link/web';
+import '@auth-link/web/styles.css';
+
+// The application server renders this meta element using the current session's
+// CSRF token. This function only reads that token; it does not generate one.
+export function readCsrfTokenFromYourCms(): string {
+  const token = document.querySelector<HTMLMetaElement>('meta[name="csrf-token"]')?.content;
+  if (!token) throw new Error('Missing CSRF token; load the authenticated application page first.');
+  return token;
+}
+
+export const client = createAuthLinkClient({
+  baseUrl: '/api/authlink',
+  csrfToken: readCsrfTokenFromYourCms,
+  // Replace this example with the configured AuthLink service origin.
+  authLinkOrigin: 'https://auth.example.com',
+});
+```
+
+Replace `https://auth.example.com` with the configured AuthLink origin. Create requests only in user event handlers, as in the React example below.
+
+### Separate frontend and backend origins (since 0.0.2)
+
+The default is still same-origin `/api/authlink`. For direct cross-origin requests, configure an absolute `baseUrl` and exact `allowedBackendOrigins`, for example frontend `https://www.example.com` and application API `https://api.example.com`. Subdomains and different ports are different origins. Entries must be origins only, without paths, wildcards or embedded credentials, and must come from trusted configuration. HTTPS is required except for explicitly allowed HTTP loopback development origins (localhost, 127.0.0.1, [::1]).
+
+The SDK validates the destination before evaluating credentials and refuses redirects. `authLinkOrigin` separately validates the AuthLink service origin encoded in the QR; it is not the application API allowlist.
+
+#### Cross-origin session cookies
+
+This complete initialization function uses an example `GET /api/session` endpoint that **your application implements**, returning `{ "csrfToken": "current-session-token" }` for the authenticated session with `Cache-Control: no-store` and CORS enabled. Replace that path with your existing session endpoint.
+
+```ts
+import { createAuthLinkClient } from '@auth-link/web';
+
+/** /api/session is an example endpoint implemented by your application backend. */
+export async function createSessionBackendClient(backendOrigin: string) {
+  const response = await fetch(`${backendOrigin}/api/session`, {
+    credentials: 'include', cache: 'no-store', redirect: 'error',
+  });
+  if (!response.ok) throw new Error('Session initialization failed');
+  const session: unknown = await response.json();
+  if (!session || typeof session !== 'object' || !('csrfToken' in session) ||
+      typeof session.csrfToken !== 'string' || !session.csrfToken) {
+    throw new Error('The session endpoint must return { csrfToken: string }');
+  }
+  let currentCsrfToken = session.csrfToken;
+  return {
+    client: createAuthLinkClient({
+      baseUrl: `${backendOrigin}/api/authlink`,
+      allowedBackendOrigins: [backendOrigin],
+      credentials: 'include',
+      csrfToken: () => currentCsrfToken,
+    }),
+    // Call after your application's session/token refresh; recreate on account changes.
+    updateCsrfToken(value: string) { currentCsrfToken = value; },
+  };
+}
+```
+
+After login, call `await createSessionBackendClient('https://api.example.com')` and pass the returned `client` to the existing components. Call the returned `updateCsrfToken(newToken)` when your session refreshes its CSRF token. Close old dialogs and recreate session state on logout/account changes. Cross-origin cookies require `credentials: 'include'`, but their SameSite, Secure, domain/path and browser third-party cookie restrictions still apply. Cross-origin does not necessarily mean cross-site. Truly cross-site cookies typically require `SameSite=None; Secure`, and browser policy may still block them.
+
+#### Cross-origin Bearer / JWT
+
+Pass your website's existing mutable login state. Its login/refresh flow updates `auth.accessToken`; the callback reads it on every creation and poll.
+
+```ts
+import { createAuthLinkClient } from '@auth-link/web';
+
+/** auth is your website's existing login state, updated by its login/refresh flow. */
+export function createBearerBackendClient(backendOrigin: string, auth: { accessToken: string }) {
+  return createAuthLinkClient({
+    baseUrl: `${backendOrigin}/api/authlink`,
+    allowedBackendOrigins: [backendOrigin],
+    credentials: 'omit',
+    accessToken: () => auth.accessToken,
+  });
+}
+```
+
+This must be the website user's login token, never an AuthLink tenant API key. The SDK adds `Authorization: Bearer ...`. With `accessToken`, credentials default to `omit` and CSRF can be omitted for a backend that exclusively authenticates Bearer tokens without cookie fallback. Explicit `include` or `same-origin` credentials require a CSRF provider even with Bearer authentication.
+
+#### Backend CORS
+
+Handle `OPTIONS` preflight and return appropriate CORS headers on preflight, actual responses and errors, including the session bootstrap endpoint. For a frontend at `https://www.example.com`:
+
+```http
+Access-Control-Allow-Origin: https://www.example.com
+Access-Control-Allow-Credentials: true
+Access-Control-Allow-Methods: GET, POST, OPTIONS
+Access-Control-Allow-Headers: Content-Type, X-CSRF-Token, Idempotency-Key, Authorization
+Vary: Origin
+```
+
+Credentialed CORS cannot use `Access-Control-Allow-Origin: *`. Match a server-side origin allowlist before returning the current allowed origin; do not reflect arbitrary origins. Preflight generally has no login credentials: validate its origin/method/headers, then authenticate the actual request and validate CSRF for cookies and request ownership. Add custom CSRF/extra headers to `Access-Control-Allow-Headers`. The SDK cannot enable backend CORS or read results using `no-cors`. See [MDN CORS](https://developer.mozilla.org/en-US/docs/Web/HTTP/Guides/CORS).
+
+#### Transport options
+
+| Option | Behavior |
+| --- | --- |
+| `baseUrl` | Application API prefix, defaults to `/api/authlink`; absolute for cross-origin |
+| `allowedBackendOrigins` | Additional exact application backend origins; same-origin remains allowed |
+| `credentials` | Defaults to `same-origin`, or `omit` with `accessToken`; use `include` for cross-origin cookies |
+| `csrfToken` | Per-request sync/async token callback, required for cookie/session mode |
+| `csrfHeaderName` | Defaults to `X-CSRF-Token`, configurable for framework integration |
+| `accessToken` | Per-request sync/async website login token callback, without the `Bearer ` prefix |
+| `headers` | Extra `HeadersInit`, or sync/async callback returning it |
+| `authLinkOrigin` | Trusted QR service origin, independent of the application API origin |
+| `fetch` | Optional implementation; destination validation still applies |
+
+Custom headers cannot override SDK-managed `Accept`, `Content-Type`, `Authorization`, `Idempotency-Key` or the configured CSRF header (`RESERVED_HEADER`). Use `accessToken` for Bearer auth and `csrfHeaderName` to adapt framework CSRF validation. Import `ClientOptions` from the root entry for configuration types.
+
+Unlisted origins produce `BACKEND_ORIGIN_NOT_ALLOWED` (replacing `CMS_ORIGIN_REQUIRED`); invalid allowlist entries or URLs produce `INVALID_BACKEND_ORIGIN` / `INVALID_BASE_URL`. Missing login/CSRF tokens produce `ACCESS_TOKEN_REQUIRED` / `CSRF_REQUIRED`. Cancellation and the 10-second timeout also cover async credential providers. Browser CORS failures normally surface as `NETWORK_ERROR`; inspect browser developer tools for details.
+
+### Open a dialog directly (React, Vue or plain JavaScript)
+
+```ts
+import { openAuthLinkBind, openAuthLinkConfirm, requestKey } from '@auth-link/web';
+import { client } from './authlink-client';
+import '@auth-link/web/styles.css';
+
+// Call in your button handler, after your backend creates the request.
+const ticket = await client.create('confirm', { idempotencyKey: requestKey() });
+const modal = openAuthLinkConfirm({
+  ticket, client, locale: 'en',
+  onConfirmed: result => console.log('Confirmed:', result.requestId),
+  onRejected: result => console.log(result.code), // REJECTED; dialog already closed
+  onClose: () => console.log('Dialog closed'),
+});
+// Bind instead: openAuthLinkBind({ ticket: bindingTicket, client }).
+// modal.close(); modal.setLocale('ja');
+```
+
+The dialog adapts to mobile widths, has a scrollable height, keyboard Escape and an accessible close button. Native `<dialog>` provides modal focus handling; a browser with `showModal()` is required. Closing aborts browser observation and restores focus/scroll. It does not reject, delete or undo the server request. Its original expiry still applies. Confirmation and rejection automatically close the dialog before delivering `onConfirmed` or `onRejected`; it does not emit a user-close callback. Always call `modal.destroy()` when the owning page/component unmounts; this cleans up without emitting `onClose`.
+
+### React
+
+`showBound(requestId)` is application UI code: it sets a message and clears the ticket to unmount the dialog. The example also defines all rejection, expiry and close handlers. Use `<AuthLinkPanel mode="bind" />` or `<AuthLinkPanel mode="confirm" />`.
+
+```tsx
+"use client";
+import { useRef, useState } from 'react';
+import { requestKey } from '@auth-link/web';
+import type { Mode, Ticket } from '@auth-link/web';
+import { AuthLinkBind, AuthLinkConfirm } from '@auth-link/web/react';
+import { client } from './authlink-client';
+
+export function AuthLinkPanel({ mode }: { mode: Mode }) {
+  const [ticket, setTicket] = useState<Ticket | null>(null);
+  const [busy, setBusy] = useState(false);
+  const [message, setMessage] = useState('');
+  const key = useRef<string | null>(null);
+  const creating = useRef(false);
+  function finish(message: string) {
+    setTicket(null);
+    setMessage(message);
+  }
+  function showBound(requestId: string) {
+    // UI feedback only. The backend has already verified and saved the binding.
+    finish(`Phone bound (request ${requestId})`);
+  }
+  function showConfirmed(requestId: string) {
+    finish(`Confirmed (request ${requestId})`);
+  }
+  const start = async () => {
+    if (creating.current || ticket) return;
+    creating.current = true;
+    setBusy(true);
+    setMessage('');
+    try {
+      key.current ??= requestKey();
+      setTicket(await client.create(mode, { idempotencyKey: key.current }));
+      key.current = null;
+    } catch { setMessage('Request failed; retry the same creation.'); }
+    finally { creating.current = false; setBusy(false); }
+  };
+  const Component = mode === 'bind' ? AuthLinkBind : AuthLinkConfirm;
+  return <>
+    {!ticket && <button type="button" disabled={busy} onClick={() => void start()}>Start verification</button>}
+    {ticket && <Component ticket={ticket} client={client}
+      onConfirmed={result => result.purpose === 'bind' ? showBound(result.requestId) : showConfirmed(result.requestId)}
+      onClose={() => finish('Closed')}
+      onRejected={() => finish('Request rejected on the phone')}
+      onExpired={() => finish('Request expired; start again')}
+      onError={error => setMessage(error.message)} />}
+    <p role="status">{message}</p>
+  </>;
+}
+```
+
+The backend must verify, consume and persist the binding/confirmation before returning `confirmed`. `showBound` does not grant access or save a binding. You can instead show a toast, reload your own account-status API or navigate to a management page. Reload real binding state from the backend after a page refresh; never treat a callback, local state or localStorage as authorization. The example retains the same creation idempotency key after a failed request.
+
+
+Mounting either component opens a dialog; unmount it in `onClose` (for example, clear the selected ticket). SSR renders no dialog and makes no requests. Omit `locale` for Simplified Chinese. Use `locale="zh-CN"` for Simplified Chinese or another code from the language table. Keep `client` and `ticket` stable between renders. The React entry preserves `"use client"`; SSR rendering does not create requests.
+
+### Vue
+
+```vue
+<script setup lang="ts">
+import { AuthLinkBind, AuthLinkConfirm } from '@auth-link/web/vue';
+import type { Ticket, Confirmation } from '@auth-link/web';
+import { client } from './authlink-client';
+
+defineProps<{ ticket: Ticket }>();
+function confirmed(result: Confirmation) {
+  console.log('Confirmed request:', result.requestId);
+}
+</script>
+
+<template>
+  <AuthLinkBind v-if="ticket.purpose === 'bind'" :ticket="ticket" :client="client"
+    @confirmed="confirmed" />
+  <AuthLinkConfirm v-else :ticket="ticket" :client="client" locale="ja"
+    @confirmed="confirmed" />
+</template>
+```
+
+Use `:locale="selectedLanguage"` to switch languages without creating a new verification request. Mounting opens the dialog. Use `@close` to clear the selected ticket. Vue exposes `confirmed`, `rejected`, `expired`, `error` and `close` events.
+
+### Choose a layout
+
+Set `variant` when opening a dialog or mounting a component. Omit it for **A**.
+
+| Value | Desktop | Mobile |
+| --- | --- | --- |
+| `A` (default) | Minimal centered card with a thin code-refresh progress bar | Centered card |
+| `B` | QR and matching code in two columns | Vertical layout |
+| `C` | Compact card with footer cancellation | Bottom sheet with safe-area padding |
+
+```ts
+openAuthLinkBind({ ticket, client }); // A, Simplified Chinese by default
+openAuthLinkConfirm({ ticket, client, variant: 'B' });
+// modal.setVariant('C'); // Presentation only; preserves the request and polling.
+```
+
+```tsx
+<AuthLinkBind ticket={ticket} client={client} variant="C" />
+```
+
+```vue
+<AuthLinkConfirm :ticket="ticket" :client="client" variant="B" />
+```
+
+All layouts show a thin progress bar and a static “Code updates automatically every 30 seconds” caption. The footer normally says “Waiting for your phone”; only in the last 30 seconds does it switch to an amber “Request expiring soon · 00:29” warning. Code changes fade in briefly, respect reduced-motion preferences, and never extend the request expiry.
+
+All variants use the same verification, expiry and callbacks. `variant` changes can be reactive in React and Vue without restarting observation. Invalid runtime values fall back to A. The footer Cancel control in B/C has the same behavior as the close icon: it closes observation, without rejecting the server request. Confirmation still dismisses the dialog automatically. A uses a subtle close icon; all close controls retain a 44px hit target and keyboard focus indication.
+
+### Component options
+
+| Option | Type | Meaning |
+| --- | --- | --- |
+| `ticket` | `Ticket`, required | Existing request returned by your backend |
+| `client` | `AuthLinkClient`, required | Client that queries your backend |
+| `locale` | `Locale` | Interface language; defaults to `zh-CN` |
+| `variant` | `DialogVariant` | `A` (default), `B` or `C`; changes layout only |
+| `showQr` | `boolean` | Optional QR on confirmation panels; binding panels always show it |
+| `intervalMs` | `number` | Polling interval, 250–10000 ms; default 1500 ms |
+| `onRefresh` | `() => void` | Create a new request from the expiry panel and replace the ticket |
+
+| React callback / Vue event | Argument | Meaning |
+| --- | --- | --- |
+| `onConfirmed` / `confirmed` | `Confirmation` | Backend has verified and consumed the result |
+| `onRejected` / `rejected` | `Rejection` | Phone rejected; dialog closes automatically |
+| `onExpired` / `expired` | None | Request expired |
+| `onClose` / `close` | None | Dialog closed; unmount the component / clear its ticket |
+| `onError` / `error` | `Error` | Network, response validation or callback failure |
+
+Rejection returns `{ status: 'rejected', code: 'REJECTED', requestId, purpose }`. `REJECTED` is an SDK business status, not an HTTP status code or an authorization receipt. The SDK closes the dialog without showing a rejection/retry panel or firing `onClose`. Handle any message or new request in your website's callback. In React/Vue, clear the selected ticket in `onRejected` / `@rejected` to unmount the component. Headless hooks retain `snapshot.status === 'rejected'` for custom UI.
+
+`useAuthLink(options)` for React and `useAuthLink(() => options)` for Vue expose `snapshot` and `retry` for custom interfaces. Vue's snapshot is a shallow ref. Retry resumes the same request; `onRefresh` creates a new one through your code.
+
+### Backend contract
+
+The default prefix is `/api/authlink`. Both endpoints authenticate the website user using session cookies plus the configured CSRF header, or Bearer authentication. Creation also sends a stable `Idempotency-Key`. Derive the account from the validated session/token rather than a browser-supplied account ID.
+
+```ts
+import type { Ticket, Result } from '@auth-link/web';
+
+// POST /api/authlink/requests
+// Body: { purpose: 'bind' | 'confirm' }
+// Response: Ticket
+
+// POST /api/authlink/requests/{requestId}/result
+// Body: {}
+// Response: Result
+```
+
+```json
+{
+  "status": "confirmed",
+  "requestId": "<request-id>",
+  "verificationId": "<verification-id>",
+  "purpose": "confirm",
+  "authenticationPolicy": "device-presence.v1",
+  "expiresAt": "<same-expiry-as-ticket>"
+}
+```
+
+Creation returns the public ticket from AuthLink: `requestId`, `purpose`, `qr`, `pairingCode`, `expiresAt` and the current `displayCode`. The display frame contains `value`, `serverTime`, `validUntil`, `periodSeconds: 30`. A confirmation ticket requires a display frame.
+
+The result endpoint verifies the authenticated user and request ownership (plus CSRF for cookie mode) and forwards pending states and the current display frame. States `new`, `pending`, `approved` and `consumed` alone do not trigger success. Before returning `confirmed`, your backend must consume the AuthLink result with its saved state and stable consume idempotency key, check the complete receipt and persist confirmation for the correct session. Persist idempotence using request/verification IDs.
+
+### Languages
+
+| Code | Language |
+| --- | --- |
+| `en` | English |
+| `zh-CN` | 简体中文 (default) |
+| `zh-TW` | 繁體中文 |
+| `ja` | 日本語 |
+| `bn` | বাংলা |
+| `es` | Español |
+| `fil` | Filipino |
+| `hi` | हिन्दी |
+| `id` | Bahasa Indonesia |
+| `ms` | Bahasa Melayu |
+| `pt` | Português |
+| `th` | ไทย |
+| `vi` | Tiếng Việt |
+
+Missing or unsupported locale codes fall back to Simplified Chinese. The panel sets its root `lang` attribute. Import `supportedLocales` from the root entry to get the supported codes. Language selection changes display text only, never the verification request or matching numbers. Documentation is available in English, Chinese and Japanese through the links above.
+
+### Styles and entry points
+
+Explicitly import `@auth-link/web/styles.css`. Override `--authlink-foreground`, `--authlink-background`, `--authlink-accent` and `--authlink-muted` on `:root` or `.authlink-dialog`; dialogs are mounted under `document.body`. All component classes use the `authlink-` prefix.
+
+React and Vue accept `className` for the dialog. Vue also accepts standard string, array or object `class` attributes, combined with `className`. Refresh buttons use the latest `onRefresh` callback supplied by the parent.
+
+| Import | Contents |
+| --- | --- |
+| `@auth-link/web` | Client, request key, supported locales, types and core tools |
+| `@auth-link/web/react` | React components and hook |
+| `@auth-link/web/vue` | Vue components and composable |
+| `@auth-link/web/styles.css` | Component styles |
+
+### Security and timing
+
+- Matching numbers are for visual comparison with the app, not standalone passwords or authorization proofs.
+- The browser receives only public tickets and current display frames, never generation seeds, device keys or tenant secrets.
+- A request lasts at most 120 seconds; rotating the code does not extend it. Backend and app must support AuthLink mobile protocol 7.
+- Countdown uses server time and a monotonic clock. Expired numbers are hidden even if a network call stalls; a short update gap at rotation is expected.
+- Component unmount/request changes abort polling. Confirmation is deduplicated per mounted instance; your backend still needs persistent idempotence.
+- Frontend callbacks update UI. Protected APIs must rely on trusted backend records, never a JavaScript callback or a browser-supplied success flag.
+- QR generation is local; backend SVG is not injected and no third-party QR service receives the ticket. Allow `img-src 'self' data:` in your CSP.
+
+### License
+
+MIT. See `LICENSE` for the full license text and `THIRD_PARTY_NOTICES.md` for bundled third-party attribution.
+
+---
+
+## 简体中文
+
+**AuthLink 官方前端组件包**，帮助网站接入手机绑定与 App 确认流程，支持 React 18/19、Vue 3.3+、TypeScript 和 ESM。
+
+
+### 功能
+
+- **扫码绑定**：网站显示二维码，用户使用 AuthLink App 扫码并确认绑定。
+- **手机确认**：电脑与 App 显示同步变化的六位数字，每 30 秒更新，用户核对后在 App 内批准。
+- **结果通知**：提供确认成功、拒绝、过期和错误事件，方便网站更新界面。
+- **框架支持**：React 组件与 hook、Vue 组件与 composable，以及无框架客户端。
+- **多语言与主题**：支持下表中的 13 种语言，默认简体中文；独立 CSS 和可覆盖的主题变量。
+- **生命周期管理**：请求切换或组件卸载时取消轮询，数字过期后自动隐藏。
+
+此包是 AuthLink 的网页接入层，需要配套应用后台、AuthLink 服务和手机 App。完整 AuthLink 流程校验原手机硬件密钥证明及 App 内批准，不要求系统通行密钥、指纹或锁屏；安装此包本身不会建立鉴权服务。
+
+### 接入步骤
+
+1. 在应用后台完成站点租户配置，并实现本文的创建请求、查询结果两个业务后台接口（同源或显式配置的跨域后台）。
+2. 安装包、导入样式，创建指向应用后台的客户端。
+3. 用户点击绑定或验证时创建请求，将返回的 ticket 交给 React/Vue 组件。
+4. 用户在 App 确认后，应用后台验证并消费结果，组件收到可信确认事件。
+
+租户密钥只保存在应用服务端。用户是否能够继续调用受保护接口，也必须由应用后台判断。
+
+### 流程
+
+应用后台根据当前登录用户创建 `bind` 或 `confirm` 请求，前端拿到 ticket 后交给组件。组件只轮询应用后台。应用后台在验证归属、state、双重认证策略并消费一次性结果后，才返回 `confirmed`。
+
+定时数字用于电脑与手机核对；用户仍在 AuthLink App 内完成 原手机硬件密钥校验和 App 内批准。它不是用户输入网站的 TOTP 登录密码，不能单独授权。请求最长 120 秒；数字变化不延长请求有效期。前端不生成数字、不接收生成 seed，不在数字更新时新建请求。
+
+需要配套更新后的 Go 服务和客户端协议 7。服务端与 App 必须使用当前单一协议，不能只升级网页。
+
+### 安装
+
+在应用项目中安装：
+
+```sh
+npm install @auth-link/web
+```
+
+### 创建应用客户端（默认同源 Cookie 模式）
+
+`readCsrfTokenFromYourCms` 是接入方函数，不是包里的导出；名称不要求与你的网站框架一致，也不要求使用 CMS。它只读取**你的网站后台提供的 CSRF token**，用于保护携带登录 cookie 的请求，不是 AuthLink 租户 API key、登录 cookie 或手机核对码。
+
+下面采用页面 meta 标签的方式。后台需要先准备 token：
+
+1. 优先复用网站框架现有的 CSRF 机制；没有现成机制时，在服务端为当前登录 session 生成并保存密码学安全随机 token，例如 Node 的 `randomBytes(32).toString('base64url')`。不要在浏览器随机生成一个值，也不要使用所有用户共用的固定字符串。
+2. 服务端使用当前 session 的 token 渲染下面的标签，正确转义 HTML 属性；`{{ csrfToken }}` 表示服务器模板变量，不是可直接照抄的 token。包含会话 token 的页面不能被公开缓存。
+3. 创建和查询接口都读取 `X-CSRF-Token`，与同一登录 session 保存的 token 校验；缺失、不匹配或请求来源不符合网站要求时拒绝请求。仅让前端发送这个头，并不会自动启用后台校验。
+4. 登录、退出或会话/token 更新后，让页面重新取得当前 token。SPA 也可以由网站实现同源会话初始化接口返回 token，再通过 `csrfToken` 回调提供；这不是 SDK 自带接口。
+
+```html
+<!-- 由你的网站后台渲染到当前用户的页面 head 中 -->
+<meta name="csrf-token" content="{{ csrfToken }}">
+```
+
+新建 `authlink-client.ts`：
+
+```ts
+// authlink-client.ts
+import { createAuthLinkClient } from '@auth-link/web';
+import '@auth-link/web/styles.css';
+
+// The application server renders this meta element using the current session's
+// CSRF token. This function only reads that token; it does not generate one.
+export function readCsrfTokenFromYourCms(): string {
+  const token = document.querySelector<HTMLMetaElement>('meta[name="csrf-token"]')?.content;
+  if (!token) throw new Error('Missing CSRF token; load the authenticated application page first.');
+  return token;
+}
+
+export const client = createAuthLinkClient({
+  baseUrl: '/api/authlink',
+  csrfToken: readCsrfTokenFromYourCms,
+  // Replace this example with the configured AuthLink service origin.
+  authLinkOrigin: 'https://auth.example.com',
+});
+```
+
+把 `https://auth.example.com` 换成实际 AuthLink 服务来源。SDK 会在每次请求时调用读取函数，自动把值放入 `X-CSRF-Token`，并携带同源登录 cookie；前端不需要读取 HttpOnly 登录 cookie。若网站框架默认使用其他 CSRF 头名，可用 `csrfHeaderName` 配成后台期望的头名，或者实现自定义 `AuthLinkClient`。
+
+`create` 只传用途，网站账号由后台登录 session 决定。客户端通常只初始化一次；用户点击按钮时才创建请求。完整调用见下方 React 示例，不要把 `client.create()` 放在模块加载、React effect 或 Vue watch 中。
+
+### 前后端分离与跨域后台（0.0.2 起）
+
+默认仍使用同源 `/api/authlink`。直接访问另一个后台来源时，同时配置完整 `baseUrl` 和 `allowedBackendOrigins`，例如网页在 `https://www.example.com`，业务后台在 `https://api.example.com`。来源是协议、主机和端口的组合；同一主域名下不同子域名也属于跨域。
+
+`allowedBackendOrigins` 是前端明确授权的**业务后台来源**，不能带路径、通配符、用户名或密码，不能来自用户输入。生产环境使用 HTTPS；HTTP 仅允许 localhost / 127.0.0.1 / [::1] 开发环境，端口必须匹配。SDK 会先校验目标再读取凭据，并拒绝 HTTP 重定向。`authLinkOrigin` 则用于校验二维码中的 AuthLink 服务来源，两者作用不同，可按需要同时配置。
+
+#### 跨域 Cookie / session
+
+下面给出完整的初始化函数。`GET /api/session` 是接入网站自己实现的示例会话接口，不是包或 AuthLink 服务自带的接口；它应根据现有登录 cookie 返回 `{ "csrfToken": "当前会话的真实CSRF token" }`，设置 `Cache-Control: no-store` 并配置下文的 CORS。部署时将路径换成网站实际的会话初始化接口。
+
+```ts
+import { createAuthLinkClient } from '@auth-link/web';
+
+/** /api/session is an example endpoint implemented by your application backend. */
+export async function createSessionBackendClient(backendOrigin: string) {
+  const response = await fetch(`${backendOrigin}/api/session`, {
+    credentials: 'include', cache: 'no-store', redirect: 'error',
+  });
+  if (!response.ok) throw new Error('Session initialization failed');
+  const session: unknown = await response.json();
+  if (!session || typeof session !== 'object' || !('csrfToken' in session) ||
+      typeof session.csrfToken !== 'string' || !session.csrfToken) {
+    throw new Error('The session endpoint must return { csrfToken: string }');
+  }
+  let currentCsrfToken = session.csrfToken;
+  return {
+    client: createAuthLinkClient({
+      baseUrl: `${backendOrigin}/api/authlink`,
+      allowedBackendOrigins: [backendOrigin],
+      credentials: 'include',
+      csrfToken: () => currentCsrfToken,
+    }),
+    // Call after your application's session/token refresh; recreate on account changes.
+    updateCsrfToken(value: string) { currentCsrfToken = value; },
+  };
+}
+```
+
+登录后调用 `await createSessionBackendClient('https://api.example.com')`，把返回的 `client` 交给现有 React/Vue 组件。网站刷新 CSRF token 时调用返回的 `updateCsrfToken(newToken)`；退出或切换账号时关闭旧弹窗，清理旧状态并重新初始化。`credentials: 'include'` 才会让跨域请求携带后台 cookie，但仍受 cookie 的 SameSite、Secure、Domain/Path 及浏览器第三方 Cookie 策略约束；跨域不一定跨站。真正跨站的 cookie 通常需要 `SameSite=None; Secure`，浏览器仍可能阻止第三方 Cookie。不能把 `include` 当成绕过 Cookie 策略的开关。
+
+#### 跨域 Bearer token / JWT
+
+传入网站自己的登录状态对象；网站完成登录或刷新后更新这个对象的 `accessToken`。回调会在每次创建和轮询时重新读取最新 token，无需重建弹窗。
+
+```ts
+import { createAuthLinkClient } from '@auth-link/web';
+
+/** auth is your website's existing login state, updated by its login/refresh flow. */
+export function createBearerBackendClient(backendOrigin: string, auth: { accessToken: string }) {
+  return createAuthLinkClient({
+    baseUrl: `${backendOrigin}/api/authlink`,
+    allowedBackendOrigins: [backendOrigin],
+    credentials: 'omit',
+    accessToken: () => auth.accessToken,
+  });
+}
+```
+
+`accessToken` 必须是接入网站的用户登录 token，不能是 AuthLink 租户 API key。SDK 自动添加 `Authorization: Bearer ...`。纯 Bearer 模式默认 `credentials: 'omit'`，可不传 `csrfToken`；后台应仅按 Bearer token 认证，不回退到 Cookie 登录。若显式设置 `credentials: 'include'` 或 `'same-origin'` 混用 Cookie，仍须提供并校验 `csrfToken`。
+
+#### 后台 CORS 配置
+
+后台需处理浏览器发出的 `OPTIONS` 预检，并在预检、实际响应和错误响应中返回相应 CORS 头。会话初始化接口也需要这些设置。以下假设前端来源是 `https://www.example.com`：
+
+```http
+Access-Control-Allow-Origin: https://www.example.com
+Access-Control-Allow-Credentials: true
+Access-Control-Allow-Methods: GET, POST, OPTIONS
+Access-Control-Allow-Headers: Content-Type, X-CSRF-Token, Idempotency-Key, Authorization
+Vary: Origin
+```
+
+携带 Cookie 时不能把 `Access-Control-Allow-Origin` 配为 `*`；多个允许来源应匹配白名单后返回当前来源，不能无条件反射任意 Origin。预检通常不携带登录凭据，因此先验证 Origin、请求方法和请求头，再对实际请求验证登录身份、CSRF（Cookie 模式）和归属。若改了 CSRF 头名或添加自定义头，也要加入 `Access-Control-Allow-Headers`。SDK 不能替后台开启 CORS，也不能用 `no-cors` 读取验证结果。见 [MDN CORS](https://developer.mozilla.org/en-US/docs/Web/HTTP/Guides/CORS)。
+
+#### 请求客户端配置
+
+| 配置 | 说明 |
+| --- | --- |
+| `baseUrl` | 业务后台前缀，默认 `/api/authlink`；跨域时填写完整地址 |
+| `allowedBackendOrigins` | 额外允许的精确后台来源数组，默认只允许当前网页同源 |
+| `credentials` | Cookie 模式默认 `same-origin`；提供 `accessToken` 时默认 `omit`；跨域 Cookie 显式设置 `include` |
+| `csrfToken` | 每次请求读取 CSRF token 的同步或异步函数；Cookie 模式必填 |
+| `csrfHeaderName` | CSRF 请求头名，默认 `X-CSRF-Token`，例如可设为 `X-XSRF-TOKEN` |
+| `accessToken` | 每次请求读取网站 Bearer token 的同步或异步函数；不要包含 `Bearer ` 前缀 |
+| `headers` | 额外的 `HeadersInit` 或返回它的同步/异步函数，可传工作区等自定义头 |
+| `authLinkOrigin` | 核对二维码中的 AuthLink 服务来源，与业务后台来源独立 |
+| `fetch` | 可选 fetch 实现；仍受目标来源和协议校验约束 |
+
+SDK 管理 `Accept`、`Content-Type`、`Authorization`、`Idempotency-Key` 和配置的 CSRF 头，`headers` 不能覆盖这些字段，否则报 `RESERVED_HEADER`。用 `accessToken` 设置 Bearer token，用 `csrfHeaderName` 适配后台框架。`ClientOptions` 可从根入口导入为 TypeScript 类型。
+
+未授权来源报 `BACKEND_ORIGIN_NOT_ALLOWED`（替代旧版的 `CMS_ORIGIN_REQUIRED`），非法来源/地址分别报 `INVALID_BACKEND_ORIGIN` / `INVALID_BASE_URL`；缺少当前登录 token 报 `ACCESS_TOKEN_REQUIRED`，缺少必要 CSRF 报 `CSRF_REQUIRED`。凭据读取也受请求取消和 10 秒超时控制。网络层的 CORS 错误由浏览器拦截，SDK 通常只能报告 `NETWORK_ERROR`，具体原因需查看浏览器开发者工具。
+
+### 直接调用弹窗（React、Vue 或原生 JavaScript）
+
+```ts
+import { openAuthLinkBind, openAuthLinkConfirm, requestKey } from '@auth-link/web';
+import { client } from './authlink-client';
+import '@auth-link/web/styles.css';
+
+// 在按钮事件中创建请求，再打开弹窗；client 为上文 authlink-client.ts 导出的同源客户端。
+const ticket = await client.create('confirm', { idempotencyKey: requestKey() });
+const modal = openAuthLinkConfirm({
+  ticket, client, locale: 'zh-CN',
+  onConfirmed: result => console.log(result.requestId),
+  onRejected: result => console.log(result.code), // REJECTED，此时弹窗已关闭
+  onClose: () => console.log('已关闭'),
+});
+// 绑定使用 openAuthLinkBind({ ticket: bindingTicket, client })。
+// modal.close(); modal.setLocale('ja');
+```
+
+React / Vue 的 AuthLinkBind、AuthLinkConfirm 挂载后也直接打开弹窗，不再内嵌在页面。React 用 onClose、Vue 用 @close 清空 ticket 并卸载组件。服务端渲染不创建弹窗或请求。支持手机窄屏、内容滚动、关闭按钮及 Escape；要求浏览器支持原生 dialog.showModal()。弹窗挂到 document.body，主题变量请配置在 :root 或 .authlink-dialog。
+
+关闭只停止前端查询，不拒绝或撤销服务端请求；请求仍按原有效期结束。确认成功或拒绝后弹窗自动关闭，分别回调 onConfirmed 或 onRejected，不触发用户关闭回调。直接调用时，页面卸载须执行 modal.destroy() 清理，它不触发用户关闭回调。切换语言用 modal.setLocale()，不会重建鉴权请求。
+
+
+### React
+
+下面的 `showBound` 也是接入方函数，负责更新页面提示和清空 `ticket`，从而卸载弹窗；它不向后台提交“绑定成功”，也不保存绑定。绑定及确认记录必须在后台查询结果接口验证、消费并保存后，才返回 `confirmed`。
+
+这个示例包含按钮、请求创建、结果提示和弹窗清理，不再依赖未定义的 `showBound`、`showRejected` 等函数。使用 `<AuthLinkPanel mode="bind" />` 绑定，使用 `<AuthLinkPanel mode="confirm" />` 请求手机确认。
+
+```tsx
+"use client";
+import { useRef, useState } from 'react';
+import { requestKey } from '@auth-link/web';
+import type { Mode, Ticket } from '@auth-link/web';
+import { AuthLinkBind, AuthLinkConfirm } from '@auth-link/web/react';
+import { client } from './authlink-client';
+
+export function AuthLinkPanel({ mode }: { mode: Mode }) {
+  const [ticket, setTicket] = useState<Ticket | null>(null);
+  const [busy, setBusy] = useState(false);
+  const [message, setMessage] = useState('');
+  const key = useRef<string | null>(null);
+  const creating = useRef(false);
+  function finish(message: string) {
+    setTicket(null);
+    setMessage(message);
+  }
+  function showBound(requestId: string) {
+    // UI feedback only. The backend has already verified and saved the binding.
+    finish(`手机绑定成功（请求 ${requestId}）`);
+  }
+  function showConfirmed(requestId: string) {
+    finish(`手机确认成功（请求 ${requestId}）`);
+  }
+  const start = async () => {
+    if (creating.current || ticket) return;
+    creating.current = true;
+    setBusy(true);
+    setMessage('');
+    try {
+      key.current ??= requestKey();
+      setTicket(await client.create(mode, { idempotencyKey: key.current }));
+      key.current = null;
+    } catch { setMessage('请求未完成，可重试同一次创建。'); }
+    finally { creating.current = false; setBusy(false); }
+  };
+  const Component = mode === 'bind' ? AuthLinkBind : AuthLinkConfirm;
+  return <>
+    {!ticket && <button type="button" disabled={busy} onClick={() => void start()}>开始验证</button>}
+    {ticket && <Component ticket={ticket} client={client}
+      onConfirmed={result => result.purpose === 'bind' ? showBound(result.requestId) : showConfirmed(result.requestId)}
+      onClose={() => finish('已关闭')}
+      onRejected={() => finish('手机已拒绝本次请求')}
+      onExpired={() => finish('请求已过期，请重新发起')}
+      onError={error => setMessage(error.message)} />}
+    <p role="status">{message}</p>
+  </>;
+}
+```
+
+`requestId` 用于展示或追踪本次请求，不是授权凭据。`showBound` 也可以按网站需求显示 toast、重新查询已有的账号状态接口或导航到绑定管理页。刷新页面后，应重新从后台读取真实绑定状态，不能只依赖 React state 或 localStorage。其他业务接口仍需在后台检查权限。
+
+创建失败时示例保留同一个幂等键；再次点击会重试同一次创建。创建成功后清空幂等键，新的用户操作才创建新请求。关闭、成功、拒绝和过期都会清空 ticket；网络错误保留弹窗，供其重试当前请求。
+
+确认组件默认只显示动态数字；`showQr` 可额外显示扫码入口。绑定组件始终显示二维码。`onRefresh` 可提供重新创建请求的函数；仅过期后显示该按钮。组件自身的“重试”只恢复当前请求，不创建第二个请求。
+
+未指定 `locale` 时使用简体中文；不支持的语言代码也回退到简体中文。组件根元素设置对应的 `lang`，语言切换不会重新创建鉴权请求。
+
+React 入口保留 `"use client"`，可用于 Next.js 客户端组件。导入包和 SSR 渲染不会创建请求。将 client 与 ticket 保持为稳定对象，例如模块级 client 和 React state 中的 ticket。卸载/切换 ticket 会取消旧轮询；StrictMode 不会创建额外请求。
+
+### Vue
+
+```vue
+<script setup lang="ts">
+import { ref, shallowRef } from 'vue';
+import { requestKey } from '@auth-link/web';
+import type { Confirmation, Mode, Ticket } from '@auth-link/web';
+import { AuthLinkBind, AuthLinkConfirm } from '@auth-link/web/vue';
+import { client } from './authlink-client';
+const props = defineProps<{ mode: Mode }>();
+const ticket = shallowRef<Ticket | null>(null);
+const busy = ref(false);
+const message = ref('');
+let key: string | null = null;
+function finish(text: string) { ticket.value = null; message.value = text; }
+function confirmed(result: Confirmation) {
+  finish(`${result.purpose === 'bind' ? '已绑定' : '已确认'}（请求 ${result.requestId}）`);
+}
+async function start() {
+  if (busy.value) return;
+  busy.value = true;
+  key ??= requestKey();
+  try {
+    ticket.value = await client.create(props.mode, { idempotencyKey: key });
+    key = null;
+  } catch { message.value = '请求未完成，可重试同一次创建。'; }
+  finally { busy.value = false; }
+}
+</script>
+
+<template>
+  <button v-if="!ticket" type="button" :disabled="busy" @click="start">开始验证</button>
+  <AuthLinkBind v-else-if="mode === 'bind'" :ticket="ticket" :client="client"
+    @confirmed="confirmed" @close="finish('已关闭')" @rejected="finish('手机已拒绝本次请求')"
+    @expired="finish('请求已过期，请重新发起')" @error="message = '网络异常，请重试。'" />
+  <AuthLinkConfirm v-else :ticket="ticket" :client="client"
+    @confirmed="confirmed" @close="finish('已关闭')" @rejected="finish('手机已拒绝本次请求')"
+    @expired="finish('请求已过期，请重新发起')" @error="message = '网络异常，请重试。'" />
+  <p role="status">{{ message }}</p>
+</template>
+```
+
+拒绝时返回 `{ status: 'rejected', code: 'REJECTED', requestId, purpose }`。`REJECTED` 是 SDK 业务状态码，不是 HTTP 状态码或授权凭证。组件自动关闭，不再显示“已拒绝 / 重新发起”面板，也不触发 `onClose`；提示和重新发起由接入网站在回调中决定。React / Vue 请在 `onRejected` / `@rejected` 中清空 ticket、卸载组件。无 UI 的 hook 仍保留 `snapshot.status === 'rejected'`，供自定义界面使用。
+
+此示例在过期后清空 ticket，用户可再次点击按钮发起请求。如果需要在过期弹窗内提供重新发起按钮，可自行传入 `onRefresh`，在回调中创建新请求并更新 ticket。`useAuthLink(() => options)` composable 与 React 的 `useAuthLink(options)` hook 可用于自定义界面，返回 `snapshot` 和 `retry`；Vue 的 snapshot 是浅 ref。
+
+### 选择弹窗样式
+
+初始化时通过 `variant` 选择样式，**不传时默认 A**。
+
+| 参数值 | 电脑端 | 手机端 |
+| --- | --- | --- |
+| `A`（默认） | 极简居中卡片、细线数字更新进度条 | 居中卡片 |
+| `B` | 二维码和核对码左右分栏 | 自动纵向排列 |
+| `C` | 紧凑卡片、底部取消入口 | 底部弹层，适配安全区域 |
+
+```ts
+openAuthLinkBind({ ticket, client }); // 默认 A、简体中文
+openAuthLinkConfirm({ ticket, client, variant: 'B' });
+// modal.setVariant('C'); // 只更新显示，不重建请求、不重启查询
+```
+
+```tsx
+<AuthLinkBind ticket={ticket} client={client} variant="C" />
+```
+
+```vue
+<AuthLinkConfirm :ticket="ticket" :client="client" variant="B" />
+```
+
+三套样式统一使用细进度条和固定文案“核对码每 30 秒自动更新”，不显示数字更新秒数。底部通常显示“等待手机确认”；仅最后 30 秒改为柔和橙色“请求即将过期 · 00:29”。新核对码轻微淡入，遵守系统减少动态效果设置；数字刷新不延长请求有效期。
+
+三套样式使用相同的鉴权、过期和回调逻辑。React / Vue 可响应式切换 `variant`，不会重新发起请求；无效的运行时值回退到 A。B / C 的底部“取消”和右上角关闭行为一致，仅停止前端观察，不会替用户拒绝服务端请求。确认成功仍自动关闭。关闭图标保留 44px 点击区域和键盘焦点提示。
+
+### 组件参数与事件
+
+`AuthLinkBind` 用于绑定二维码，`AuthLinkConfirm` 用于手机确认。两者使用相同的主要参数：
+
+| 参数 | 类型 | 说明 |
+| --- | --- | --- |
+| `ticket` | `Ticket`，必填 |应用后台创建的当前请求；组件不会自行创建请求 |
+| `client` | `AuthLinkClient`，必填 | 查询应用后台结果的客户端 |
+| `locale` | `Locale`，见下表 | 界面语言，默认 `zh-CN` |
+| `variant` | `DialogVariant` | `A`（默认）、`B` 或 `C`；只改变布局 |
+| `showQr` | `boolean` | 确认组件是否额外显示二维码；绑定组件始终显示 |
+| `intervalMs` | `number` | 结果轮询间隔，默认 1500 毫秒 |
+| `onRefresh` | `() => void` | 过期后，由网站重新创建请求并更新 ticket |
+
+| React 回调 / Vue 事件 | 参数 | 触发时机 |
+| --- | --- | --- |
+| `onConfirmed` / `confirmed` | `Confirmation` |应用后台完成结果验证和消费后 |
+| `onRejected` / `rejected` | `Rejection` | 手机拒绝请求，弹窗自动关闭 |
+| `onExpired` / `expired` | 无 | 请求已过期 |
+| `onError` / `error` | `Error` | 网络错误、响应校验失败或成功回调执行失败等 |
+
+业务处理以 `requestId` / `verificationId` 做持久化幂等。前端成功事件用于展示状态，不能作为后台接口放行凭据。
+
+### 导入入口
+
+| 入口 | 用途 |
+| --- | --- |
+| `@auth-link/web` | `createAuthLinkClient`、`requestKey`、公开类型及无框架工具 |
+| `@auth-link/web/react` | React 组件和 `useAuthLink` |
+| `@auth-link/web/vue` | Vue 组件和 `useAuthLink` |
+| `@auth-link/web/styles.css` | 组件样式，需显式导入 |
+
+### 应用后台接口约定
+
+默认前缀 `/api/authlink`；下面两个接口由接入方实现，**不是直接把浏览器请求转发到租户密钥 API**。
+
+#### `POST /requests`
+
+浏览器按所选模式携带网站登录凭据：Cookie 模式发送 session cookie 和配置的 CSRF 头，Bearer 模式发送 `Authorization`。创建还发送稳定的 `Idempotency-Key`，body：
+
+```json
+{"purpose":"bind"}
+```
+
+后台从经过验证的 session 或 Bearer token 取得用户 ID，创建并持久保存 state、创建/消费幂等键、用户/session 关联，然后调用 AuthLink 服务端创建请求。返回其公开 ticket：
+
+```ts
+type Ticket = {
+  requestId: string;
+  purpose: 'bind' | 'confirm';
+  qr: string; // AuthLink 返回的 QR JSON，不是 HTML
+  pairingCode: string;
+  expiresAt: string;
+  displayCode: {
+    value: string; // 六位数字，保留前导零
+    serverTime: string; validUntil: string;
+    periodSeconds: 30;
+  };
+};
+```
+
+#### `POST /requests/{requestId}/result`
+
+同样验证登录身份（Cookie 模式还需 CSRF）和请求归属。后台调用 AuthLink 状态接口，将 `displayCode` 原样返回，不能缓存跨过 `validUntil`。新代码由后台实时获取，不是前端自行生成。
+
+尚未完成时返回 `{requestId,status,displayCode?}`；状态可为 new / pending / approved / consumed / rejected / expired。`approved` 不能触发成功事件。
+
+收到 approved / consumed 后，后台使用保存的稳定消费幂等键调用 `/consume`，核对完整结果，在自己数据库事务中记录此次 session 的确认，再返回已验证的回执。组件确认所需最小字段：
+
+```json
+{
+  "status":"confirmed",
+  "requestId":"43字符请求ID",
+  "verificationId":"43字符结果ID",
+  "purpose":"confirm",
+  "authenticationPolicy":"device-presence.v1",
+  "expiresAt":"与创建请求完全一致的期限"
+}
+```
+
+服务端必须在同一事务内记录已验证的确认结果，并校验请求归属。网页事件只用于更新界面；受保护接口必须依赖后台的可信确认记录，不能依赖 JS 回调或浏览器传来的 confirmed。
+
+### 数字、时钟与安全
+
+- 每个请求独立派生数字生成 seed；seed 只通过 claim 发给手机，并纳入设备签名上下文。网页只得到当前数字、服务端时间和本步期限。
+- 倒计时使用服务端时间锚点和单调时钟；本机系统时钟错误不直接导致倒计时漂移。网络延迟仍有影响，跨步时可能短暂显示“正在更新数字”，稳定后再核对。
+- 旧数字一过本步期限就隐藏，即使网络请求仍未返回。整个请求过期、拒绝或失败会隐藏数字和二维码。
+- 组件按请求检查成功结果、用途、双重认证策略和有效期。取消、卸载和切换请求后，旧响应不能触发成功回调。
+- 每个组件实例对同一请求只发一次成功事件；刷新或重新挂载不替代网站持久化幂等。
+- 包不接收网站业务授权内容，不提供 apiKey 配置，不执行支付/授权等业务操作。
+- 二维码在浏览器内生成，忽略后台 qrSvg，不使用 innerHTML；不上传给第三方图片服务。应用 CSP 需允许 `img-src 'self' data:`。
+
+### 样式与语言
+
+CSS 单独导入，所有类使用 `authlink-` 前缀。弹窗挂载到 `document.body`，可在 `:root` 或 `.authlink-dialog` 覆盖 `--authlink-foreground`、`--authlink-background`、`--authlink-accent`、`--authlink-muted`。面板语言见下表，默认简体中文。
+
+React / Vue 均支持 `className`；Vue 还支持字符串、数组和对象形式的 `class`，与 `className` 合并。“重新发起”按钮使用父组件最新传入的 `onRefresh` 回调。
+
+
+| Code | Language |
+| --- | --- |
+| `en` | English |
+| `zh-CN` | 简体中文 (default) |
+| `zh-TW` | 繁體中文 |
+| `ja` | 日本語 |
+| `bn` | বাংলা |
+| `es` | Español |
+| `fil` | Filipino |
+| `hi` | हिन्दी |
+| `id` | Bahasa Indonesia |
+| `ms` | Bahasa Melayu |
+| `pt` | Português |
+| `th` | ไทย |
+| `vi` | Tiếng Việt |
+
+可以从根入口导入 `supportedLocales` 获取支持列表。文档默认英文，另有中文与日文版本。
+
+### 兼容性
+
+React 18.2+ / 19、Vue 3.3+、TypeScript、ESM。React 和 Vue 是可选 peer，只安装所用框架。构建工具环境需 Node 22.13+。
+
+### 许可证
+
+MIT。完整许可文本见 `LICENSE`，打包包含的第三方库归属说明见 `THIRD_PARTY_NOTICES.md`。
+
+---
+
+## 日本語
+
+**AuthLink のスマートフォン登録とアプリでの確認**を Web サイトに組み込む React / Vue コンポーネントです。登録用 QR コード、同期する 6 桁の照合コード、カウントダウン、確認結果を表示します。特定のサイト基盤には依存しません。
+
+### 主な機能
+
+- ブラウザー内で生成するスマートフォン登録用 QR コード。
+- アプリと同期し、30 秒ごとに更新される照合コード。
+- 承認・拒否・期限切れ・エラーのイベント。
+- React コンポーネントと hook、Vue コンポーネントと composable、フレームワーク非依存の API。
+- **簡体字中国語を既定とする 13 言語**。コンポーネントごとに指定可能。
+- TypeScript、独立した CSS、任意の React / Vue peer dependency。
+
+本パッケージはブラウザー用の接続ライブラリです。サイトのバックエンド、AuthLink サービス、モバイルアプリと併用します。AuthLink はアプリ内の承認と元の端末のハードウェア証明を検証します。システムのパスキー、指紋認証、画面ロックは要求しません。
+
+### インストール
+
+```sh
+npm install @auth-link/web
+```
+
+対応環境：React 18.2+ / 19、Vue 3.3+、TypeScript、ESM。利用するフレームワークだけをインストールしてください。ツール環境には Node 22.13+ が必要です。
+
+### 接続の流れ
+
+1. サイトのバックエンドに AuthLink のテナント資格情報を設定します。
+2. 下記の業務バックエンド（同一オリジンまたは明示的に許可した別オリジン）の作成・結果取得 API を実装します。
+3. ユーザー操作でリクエストを作成し、取得した ticket をコンポーネントに渡します。
+4. バックエンドが結果を検証・消費した後に確認完了を返します。
+
+ブラウザーからこのライブラリを呼び出せますが、テナント API キーと結果の消費処理は必ずサーバー側に置きます。標準クライアントは既定の同一オリジンと、明示的に許可した別オリジンに対応します。独自の通信方式では `AuthLinkClient` を実装できますが、資格情報と検証をブラウザーに移さないでください。
+
+### クライアント作成（既定の同一オリジン Cookie モード）
+
+`readCsrfTokenFromYourCms` は SDK のエクスポートではなく、接続先サイトで実装する関数です。現在のログインセッションに対してバックエンドが発行した CSRF token を読み取ります。CMS は必須ではありません。ブラウザーで値を生成したり、AuthLink の API キーを返したりしないでください。
+
+既存フレームワークの CSRF 機構を優先してください。独自に実装する場合は、サーバーで暗号学的乱数（Node の `randomBytes(32).toString('base64url')` など）を生成し、セッションに保存して HTML 属性をエスケープしたうえでページに埋め込みます。下記の `{{ csrfToken }}` はサーバーテンプレートの変数です。このページを公開キャッシュしないでください。
+
+```html
+<meta name="csrf-token" content="{{ csrfToken }}">
+```
+
+SDK は各リクエストで token を読み取り、`X-CSRF-Token` と同一オリジンのセッション cookie を送信します。作成 API と結果 API の両方で、バックエンドが同じセッションの token と照合し、欠落・不一致や不正なリクエスト元を拒否する必要があります。ログインやセッション変更後は最新 token を取得してください。SPA ではサイト独自の同一オリジン初期化 API から取得する方法も使えます。別のヘッダー名を使うフレームワークでは`csrfHeaderName` または独自 `AuthLinkClient` で適合します。
+
+`authlink-client.ts` を作成します：
+
+```ts
+// authlink-client.ts
+import { createAuthLinkClient } from '@auth-link/web';
+import '@auth-link/web/styles.css';
+
+// The application server renders this meta element using the current session's
+// CSRF token. This function only reads that token; it does not generate one.
+export function readCsrfTokenFromYourCms(): string {
+  const token = document.querySelector<HTMLMetaElement>('meta[name="csrf-token"]')?.content;
+  if (!token) throw new Error('Missing CSRF token; load the authenticated application page first.');
+  return token;
+}
+
+export const client = createAuthLinkClient({
+  baseUrl: '/api/authlink',
+  csrfToken: readCsrfTokenFromYourCms,
+  // Replace this example with the configured AuthLink service origin.
+  authLinkOrigin: 'https://auth.example.com',
+});
+```
+
+`https://auth.example.com` は実際の AuthLink オリジンに置き換えてください。リクエストは下記の React 例のようにユーザー操作で作成します。
+
+### フロントエンドとバックエンドの別オリジン対応（0.0.2 以降）
+
+既定は同一オリジンの `/api/authlink` です。別オリジンの業務 API に直接接続するには完全な `baseUrl` と `allowedBackendOrigins` を指定します。例：フロントエンド `https://www.example.com`、バックエンド `https://api.example.com`。サブドメインやポートが異なる場合も別オリジンです。許可リストにはパス、ワイルドカード、ユーザー名・パスワードを含めず、信頼する固定設定を使います。HTTPS が必須で、開発用 HTTP loopback（localhost / 127.0.0.1 / [::1]）のみ例外です。
+
+SDK は認証情報を読む前に接続先を検証し、リダイレクトを拒否します。`authLinkOrigin` は QR 内の AuthLink サービスオリジンの検証用で、業務 API の許可リストとは別です。
+
+#### 別オリジンの Cookie / session
+
+下記の `GET /api/session` はサイトで実装する例示 API で、SDK が提供する API ではありません。ログイン session の `{ "csrfToken": "現在のtoken" }` を返し、`Cache-Control: no-store` と CORS を設定します。既存サイトの API パスに適合してください。
+
+```ts
+import { createAuthLinkClient } from '@auth-link/web';
+
+/** /api/session is an example endpoint implemented by your application backend. */
+export async function createSessionBackendClient(backendOrigin: string) {
+  const response = await fetch(`${backendOrigin}/api/session`, {
+    credentials: 'include', cache: 'no-store', redirect: 'error',
+  });
+  if (!response.ok) throw new Error('Session initialization failed');
+  const session: unknown = await response.json();
+  if (!session || typeof session !== 'object' || !('csrfToken' in session) ||
+      typeof session.csrfToken !== 'string' || !session.csrfToken) {
+    throw new Error('The session endpoint must return { csrfToken: string }');
+  }
+  let currentCsrfToken = session.csrfToken;
+  return {
+    client: createAuthLinkClient({
+      baseUrl: `${backendOrigin}/api/authlink`,
+      allowedBackendOrigins: [backendOrigin],
+      credentials: 'include',
+      csrfToken: () => currentCsrfToken,
+    }),
+    // Call after your application's session/token refresh; recreate on account changes.
+    updateCsrfToken(value: string) { currentCsrfToken = value; },
+  };
+}
+```
+
+ログイン後に `await createSessionBackendClient('https://api.example.com')` を呼び、返された `client` を既存コンポーネントに渡します。CSRF token 更新時は `updateCsrfToken(newToken)` を呼びます。ログアウトやアカウント切替時は古いダイアログを閉じ、状態を再初期化します。別オリジン Cookie には `credentials: 'include'` が必要ですが、SameSite、Secure、domain/path、ブラウザーの第三者 Cookie 制限も適用されます。別オリジンと cross-site は同じではありません。cross-site Cookie には通常 `SameSite=None; Secure` が必要で、ブラウザーによっては引き続き拒否されます。
+
+#### Bearer token / JWT
+
+サイトの既存ログイン状態を渡してください。ログイン・更新処理で `auth.accessToken` を更新すると、SDK は作成・ポーリングのたびに最新値を読み取ります。
+
+```ts
+import { createAuthLinkClient } from '@auth-link/web';
+
+/** auth is your website's existing login state, updated by its login/refresh flow. */
+export function createBearerBackendClient(backendOrigin: string, auth: { accessToken: string }) {
+  return createAuthLinkClient({
+    baseUrl: `${backendOrigin}/api/authlink`,
+    allowedBackendOrigins: [backendOrigin],
+    credentials: 'omit',
+    accessToken: () => auth.accessToken,
+  });
+}
+```
+
+これはサイト利用者のログイン token であり、AuthLink のテナント API キーではありません。SDK が `Authorization: Bearer ...` を付加します。`accessToken` 指定時は既定で `credentials: 'omit'` となり、Cookie にフォールバックせず Bearer のみで認証するバックエンドでは CSRF を省略できます。`include` / `same-origin` を明示して Cookie を併用する場合は CSRF の提供・検証も必要です。
+
+#### バックエンドの CORS
+
+`OPTIONS` プリフライトを処理し、実リクエスト・エラー応答・session 初期化 API にも必要な CORS ヘッダーを返します。フロントエンドが `https://www.example.com` の例：
+
+```http
+Access-Control-Allow-Origin: https://www.example.com
+Access-Control-Allow-Credentials: true
+Access-Control-Allow-Methods: GET, POST, OPTIONS
+Access-Control-Allow-Headers: Content-Type, X-CSRF-Token, Idempotency-Key, Authorization
+Vary: Origin
+```
+
+Cookie を使う場合 `Access-Control-Allow-Origin: *` は使用できません。バックエンドの許可リストと一致する Origin のみ返し、任意の値を反射しないでください。プリフライトには通常ログイン認証情報がないため、まず Origin・メソッド・ヘッダーを検証し、実リクエストで本人確認・CSRF（Cookie モード）・所有者を検証します。独自ヘッダーや CSRF ヘッダー名は `Access-Control-Allow-Headers` に追加します。SDK はサーバーの CORS 設定を代行できず、`no-cors` で結果を読めません。[MDN CORS](https://developer.mozilla.org/en-US/docs/Web/HTTP/Guides/CORS) を参照してください。
+
+#### クライアント設定
+
+| 設定 | 説明 |
+| --- | --- |
+| `baseUrl` | 業務 API の接頭辞、既定 `/api/authlink`；別オリジン時は完全 URL |
+| `allowedBackendOrigins` | 追加許可する正確な業務 API オリジンの配列 |
+| `credentials` | 既定 `same-origin`、`accessToken` 指定時 `omit`；別オリジン Cookie は `include` |
+| `csrfToken` | リクエストごとの同期/非同期取得関数；Cookie モードは必須 |
+| `csrfHeaderName` | 既定 `X-CSRF-Token`、フレームワークに合わせて変更可能 |
+| `accessToken` | サイトのログイン token 取得関数；`Bearer ` 接頭辞は付けない |
+| `headers` | 追加 `HeadersInit`、またはそれを返す同期/非同期関数 |
+| `authLinkOrigin` | QR 内の信頼するサービスオリジン。業務 API オリジンとは別 |
+| `fetch` | 任意の fetch 実装；接続先検証は維持 |
+
+追加ヘッダーは SDK 管理の `Accept`、`Content-Type`、`Authorization`、`Idempotency-Key`、設定済み CSRF ヘッダーを上書きできません（`RESERVED_HEADER`）。`accessToken` と `csrfHeaderName` を使用してください。設定型 `ClientOptions` はルートエントリーからインポートできます。
+
+未許可オリジンは `BACKEND_ORIGIN_NOT_ALLOWED`（旧 `CMS_ORIGIN_REQUIRED` に代わる）、不正な許可設定/URL は `INVALID_BACKEND_ORIGIN` / `INVALID_BASE_URL`、token 不足は `ACCESS_TOKEN_REQUIRED` / `CSRF_REQUIRED` となります。非同期の認証情報取得にも取消しと 10 秒タイムアウトが適用されます。CORS の詳細な失敗理由は開発者ツールで確認してください。SDK では通常 `NETWORK_ERROR` になります。
+
+### 関数でダイアログを開く（React / Vue / JavaScript）
+
+```ts
+import { openAuthLinkBind, openAuthLinkConfirm, requestKey } from '@auth-link/web';
+import { client } from './authlink-client';
+import '@auth-link/web/styles.css';
+
+const ticket = await client.create('confirm', { idempotencyKey: requestKey() });
+const modal = openAuthLinkConfirm({
+  ticket, client, locale: 'ja',
+  onConfirmed: result => console.log(result.requestId),
+  onClose: () => console.log('Closed'),
+});
+// 登録: openAuthLinkBind({ ticket: bindingTicket, client })
+// modal.close(); modal.setLocale('en');
+```
+
+React / Vue コンポーネントもマウント時にダイアログを開きます。React の onClose、Vue の @close で ticket を消去してアンマウントしてください。SSR はダイアログも通信も生成しません。スマートフォンの画面幅、スクロール、閉じるボタン、Escape に対応し、ネイティブ dialog.showModal() が必要です。body 直下に表示するため、テーマ変数は :root または .authlink-dialog に設定します。
+
+閉じてもサーバーのリクエストを拒否・取消しません。元の有効期限は維持されます。承認・拒否時は自動で閉じ、onConfirmed または onRejected を通知します。ユーザー操作の onClose は通知しません。関数で開いた場合はページ破棄時に modal.destroy() を呼んで通信と UI を解除してください。destroy() は onClose を通知しません。modal.setLocale() はリクエストを作り直さずに言語を切り替えます。
+
+
+### React
+
+`showBound(requestId)` はサイトの表示更新用関数です。メッセージを更新し、ticket を消去してダイアログをアンマウントします。下記には拒否・期限切れ・閉じる処理も含まれます。`<AuthLinkPanel mode="bind" />` または `<AuthLinkPanel mode="confirm" />` で使います。
+
+```tsx
+"use client";
+import { useRef, useState } from 'react';
+import { requestKey } from '@auth-link/web';
+import type { Mode, Ticket } from '@auth-link/web';
+import { AuthLinkBind, AuthLinkConfirm } from '@auth-link/web/react';
+import { client } from './authlink-client';
+
+export function AuthLinkPanel({ mode }: { mode: Mode }) {
+  const [ticket, setTicket] = useState<Ticket | null>(null);
+  const [busy, setBusy] = useState(false);
+  const [message, setMessage] = useState('');
+  const key = useRef<string | null>(null);
+  const creating = useRef(false);
+  function finish(message: string) {
+    setTicket(null);
+    setMessage(message);
+  }
+  function showBound(requestId: string) {
+    // UI feedback only. The backend has already verified and saved the binding.
+    finish(`Phone bound (request ${requestId})`);
+  }
+  function showConfirmed(requestId: string) {
+    finish(`Confirmed (request ${requestId})`);
+  }
+  const start = async () => {
+    if (creating.current || ticket) return;
+    creating.current = true;
+    setBusy(true);
+    setMessage('');
+    try {
+      key.current ??= requestKey();
+      setTicket(await client.create(mode, { idempotencyKey: key.current }));
+      key.current = null;
+    } catch { setMessage('Request failed; retry the same creation.'); }
+    finally { creating.current = false; setBusy(false); }
+  };
+  const Component = mode === 'bind' ? AuthLinkBind : AuthLinkConfirm;
+  return <>
+    {!ticket && <button type="button" disabled={busy} onClick={() => void start()}>Start verification</button>}
+    {ticket && <Component ticket={ticket} client={client}
+      onConfirmed={result => result.purpose === 'bind' ? showBound(result.requestId) : showConfirmed(result.requestId)}
+      onClose={() => finish('Closed')}
+      onRejected={() => finish('Request rejected on the phone')}
+      onExpired={() => finish('Request expired; start again')}
+      onError={error => setMessage(error.message)} />}
+    <p role="status">{message}</p>
+  </>;
+}
+```
+
+バックエンドは結果を検証・消費・保存してから `confirmed` を返します。`showBound` は権限付与や紐付け保存を行いません。通知、サイトのアカウント状態 API の再取得、管理ページへの移動などに置き換えられます。ページ再読み込み後はサーバーから状態を取得し、コールバックや localStorage を認可に使わないでください。作成失敗時には同じ冪等キーを再利用します。
+
+
+`locale` を省略すると簡体字中国語です。日本語は `locale="ja"`、簡体字中国語は `locale="zh-CN"` を指定します。client と ticket はレンダー間で安定したオブジェクトにしてください。React エントリーは `"use client"` を保持し、SSR ではリクエストを作成しません。
+
+### Vue
+
+```vue
+<script setup lang="ts">
+import { AuthLinkBind, AuthLinkConfirm } from '@auth-link/web/vue';
+import type { Ticket, Confirmation } from '@auth-link/web';
+import { client } from './authlink-client';
+
+defineProps<{ ticket: Ticket }>();
+function confirmed(result: Confirmation) {
+  console.log('Confirmed request:', result.requestId);
+}
+</script>
+
+<template>
+  <AuthLinkBind v-if="ticket.purpose === 'bind'" :ticket="ticket" :client="client"
+    @confirmed="confirmed" />
+  <AuthLinkConfirm v-else :ticket="ticket" :client="client" locale="ja"
+    @confirmed="confirmed" />
+</template>
+```
+
+`:locale="selectedLanguage"` で表示言語を切り替えられます。言語切り替えによって新しい認証リクエストは作成されません。
+
+### レイアウトの選択
+
+初期化時の `variant` で選択します。省略時は **A** です。
+
+| 値 | デスクトップ | モバイル |
+| --- | --- | --- |
+| `A`（既定） | ミニマルなカードと細いコード更新バー | 中央のカード |
+| `B` | QR と照合コードの二列表示 | 縦並び |
+| `C` | コンパクトなカードとキャンセル操作 | セーフエリア対応のボトムシート |
+
+```ts
+openAuthLinkBind({ ticket, client }); // A、既定言語は簡体字中国語
+openAuthLinkConfirm({ ticket, client, variant: 'B' });
+// modal.setVariant('C');
+```
+
+```tsx
+<AuthLinkBind ticket={ticket} client={client} variant="C" />
+```
+
+```vue
+<AuthLinkConfirm :ticket="ticket" :client="client" variant="B" />
+```
+
+すべてのレイアウトで細い進捗バーと「照合コードは30秒ごとに自動更新」を表示します。通常は「スマートフォンの確認待ち」を表示し、残り30秒になったときだけオレンジ色の期限警告と 00:29 形式に切り替わります。コード変更時の短いフェードはモーション低減設定に従い、リクエスト期限は延長されません。
+
+React / Vue では表示中にも変更でき、リクエストやポーリングは再作成されません。未対応の値は A に戻ります。B / C のキャンセル操作は閉じるアイコンと同じく表示の監視を停止し、サーバーのリクエストは拒否しません。確認成功時は自動で閉じます。閉じる操作のタッチ領域は 44px で、キーボードのフォーカス表示も維持します。
+
+### コンポーネントの設定
+
+| 設定 | 型 | 説明 |
+| --- | --- | --- |
+| `ticket` | `Ticket`、必須 | バックエンドで作成したリクエスト |
+| `client` | `AuthLinkClient`、必須 | バックエンドの結果を取得するクライアント |
+| `locale` | `Locale` | 既定は `zh-CN` |
+| `variant` | `DialogVariant` | `A`（既定）、`B`、`C` |
+| `showQr` | `boolean` | 確認画面にも QR を表示。登録画面では常に表示 |
+| `intervalMs` | `number` | 250～10000 ミリ秒。既定は 1500 ミリ秒 |
+| `onRefresh` | `() => void` | 期限切れ後、新規作成して ticket を更新する処理 |
+
+| React コールバック / Vue イベント | 引数 | 意味 |
+| --- | --- | --- |
+| `onConfirmed` / `confirmed` | `Confirmation` | バックエンドによる検証と消費が完了 |
+| `onRejected` / `rejected` | `Rejection` | 拒否時はダイアログを自動で閉じる |
+| `onExpired` / `expired` | なし | 有効期限切れ |
+| `onError` / `error` | `Error` | 通信・応答検証・コールバックのエラー |
+
+拒否時は `{ status: 'rejected', code: 'REJECTED', requestId, purpose }` を返します。`REJECTED` は SDK の業務ステータスで、HTTP ステータスや承認証明ではありません。拒否・再試行画面は表示せず、`onClose` も通知しません。メッセージや新規作成はサイト側で処理してください。React / Vue では `onRejected` / `@rejected` で ticket を解除してコンポーネントを破棄します。ヘッドレス hook の `snapshot.status` は `rejected` のままです。
+
+独自 UI には React の `useAuthLink(options)`、Vue の `useAuthLink(() => options)` を利用できます。返される値は `snapshot` と `retry` です。Vue の snapshot は shallow ref です。retry は既存リクエストを再開し、onRefresh はサイト側のコードで新規作成します。
+
+### バックエンド API
+
+既定の接頭辞は `/api/authlink` です。両 API で Cookie + 設定した CSRF ヘッダー、または Bearer token による本人確認とリクエスト所有者を検証してください。作成時は `Idempotency-Key` も送信されます。サイトのユーザー ID は検証済みセッション/token から決定します。
+
+```ts
+import type { Ticket, Result } from '@auth-link/web';
+
+// POST /api/authlink/requests
+// Body: { purpose: 'bind' | 'confirm' }
+// Response: Ticket
+
+// POST /api/authlink/requests/{requestId}/result
+// Body: {}
+// Response: Result
+```
+
+```json
+{
+  "status": "confirmed",
+  "requestId": "<request-id>",
+  "verificationId": "<verification-id>",
+  "purpose": "confirm",
+  "authenticationPolicy": "device-presence.v1",
+  "expiresAt": "<same-expiry-as-ticket>"
+}
+```
+
+作成 API は AuthLink の公開 ticket（`requestId`、`purpose`、`qr`、`pairingCode`、`expiresAt`、現在の `displayCode`）を返します。displayCode は `value`、`serverTime`、`validUntil`、`periodSeconds: 30` を持ちます。確認用 ticket には displayCode が必要です。
+
+結果 API は未完了状態と最新の表示コードを返します。`new` / `pending` / `approved` / `consumed` だけでは成功イベントは発火しません。`confirmed` を返す前に、バックエンドは保存した state と消費用冪等キーで AuthLink の結果を消費し、完全な受領情報を検証して正しいセッションに記録します。requestId / verificationId による永続的な冪等処理が必要です。
+
+### 対応言語
+
+| Code | Language |
+| --- | --- |
+| `en` | English |
+| `zh-CN` | 简体中文 (default) |
+| `zh-TW` | 繁體中文 |
+| `ja` | 日本語 |
+| `bn` | বাংলা |
+| `es` | Español |
+| `fil` | Filipino |
+| `hi` | हिन्दी |
+| `id` | Bahasa Indonesia |
+| `ms` | Bahasa Melayu |
+| `pt` | Português |
+| `th` | ไทย |
+| `vi` | Tiếng Việt |
+
+未指定・未対応の言語コードは簡体字中国語にフォールバックします。ルート要素には `lang` が設定されます。ルートエントリーの `supportedLocales` で一覧を取得できます。言語変更は表示文言だけに作用し、数字やリクエストは変更しません。ドキュメントは英語・中国語・日本語で提供します。
+
+### スタイルとエントリー
+
+`@auth-link/web/styles.css` を明示的に読み込みます。ダイアログは `document.body` に追加されるため、`:root` または `.authlink-dialog` で `--authlink-foreground`、`--authlink-background`、`--authlink-accent`、`--authlink-muted` を上書きします。クラス名の接頭辞は `authlink-` です。
+
+React / Vue はダイアログの `className` に対応します。Vue は文字列・配列・オブジェクト形式の `class` も受け取り、`className` と結合します。再作成ボタンは親が渡した最新の `onRefresh` を呼び出します。
+
+| エントリー | 内容 |
+| --- | --- |
+| `@auth-link/web` | クライアント、冪等キー、対応言語、型、基本 API |
+| `@auth-link/web/react` | React コンポーネントと hook |
+| `@auth-link/web/vue` | Vue コンポーネントと composable |
+| `@auth-link/web/styles.css` | スタイル |
+
+### セキュリティと有効期限
+
+- 数字はアプリとの目視照合用です。数字だけで認証や承認はできません。
+- ブラウザーに生成 seed、端末秘密鍵、テナント秘密情報を渡しません。
+- リクエストは最大 120 秒。コード更新で期限は延長されません。サービスとアプリはモバイルプロトコル 7 に対応する必要があります。
+- サーバー時刻と単調増加時計で残り時間を計算し、通信が止まっても期限切れの数字は隠します。更新境界で短い待ち時間が生じる場合があります。
+- アンマウントや ticket 変更で監視を中止します。インスタンス内のイベント重複防止とは別に、バックエンドで永続的な冪等処理が必要です。
+- フロントエンドのイベントは UI 更新用です。保護 API はバックエンドの信頼できる記録で判断します。
+- QR はローカル生成し、バックエンドの SVG を挿入しません。CSP は `img-src 'self' data:` を許可してください。
+
+### ライセンス
+
+MIT。ライセンス全文は `LICENSE`、同梱ライブラリの帰属表示は `THIRD_PARTY_NOTICES.md` を参照してください。