@auth-link/web 0.0.4 → 1.1.0

package/docs/README.en.md

@@ -1,405 +1,62 @@
-# AuthLink Web
+# AuthLink Web 1.1
 
-**English** | [简体中文](./README.zh-CN.md) | [日本語](./README.ja.md)
+[English](README.en.md) · [简体中文](README.zh-CN.md) · [日本語](README.ja.md)
 
-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.
+## Direct rotating-code verification
 
-## Go backend + Vue walkthrough
+The app directly displays a six-digit rotating code. No per-action approval, authorization requestId, businessId or polling is required. First-time enrollment still scans a QR and verifies the phone; entering its current code on the website completes binding.
 
-Start with [Go + Vue: login, binding and confirmed publication](./go-vue.en.md) and the [complete Vue CMS example](../examples/vue-cms.vue).
-
-The flow is site login → Go `/api/session` returns authenticated/csrf → configure the cross-origin client with `csrfToken: () => session.csrf` → create bind/confirm → Go consumes, validates and commits the receipt → Vue dismisses the dialog → a separate business API checks the saved receipt and publishes. `baseUrl` targets Go; `authLinkOrigin` identifies AuthLink. Tenant keys stay in Go. Use your own fetch plus `validateTicket` for post/version fields; SDK create() sends purpose only.
-
-## 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
+The CMS backend must reserve one immutable pending action per session before opening the prompt. Another tab cannot replace it. Obtain the user from the server session and check CSRF and business permissions. Verify the passcode on the server and atomically commit verificationId with the saved operation before returning success. onVerified only updates the UI.
 
 ```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 }}">
+npm install @auth-link/web@^1.1.0
 ```
 
-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 { openPasscode, createPasscodeClient } 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,
-  // AuthLink production API origin.
-  authLinkOrigin: 'https://api.getauthlink.com',
+const client = createPasscodeClient({ baseUrl: '/api', csrfToken: () => csrfToken });
+const modal = openPasscode({
+  client, expiresAt: pending.expiresAt, locale: 'zh-CN', variant: 'B',
+  // First-time enrollment only:
+  // bindingQr: pending.bindingQr, authLinkOrigin: 'https://api.getauthlink.com',
+  onVerified: result => updateUI(result.verificationId),
 });
+// modal.setLocale('en'); modal.setVariant('C'); modal.destroy();
 ```
 
-AuthLink production uses `https://api.getauthlink.com`. Keep `baseUrl` pointed at your own application backend; the AuthLink website domain is not an API endpoint. For a separately hosted AuthLink service, use that service’s configured 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.
-
-`csrfToken` is the JSON property chosen for this generic example. The Go CMS walkthrough uses `{ authenticated: true, csrf: '…' }` instead; map session.csrf to the SDK csrfToken callback without renaming your backend response.
-
-```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.
+The default client posts only {passcode} to POST /api/auth with current CMS credentials and CSRF. To submit a form at the same time, supply your own client.verify callback and send {form,passcode} to your CMS. The CMS checks the form against its saved snapshot; never send tenant keys or passcode seeds to the browser.
 
-### 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';
+## Options and callbacks
 
-// 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');
-```
+Required: client.verify(passcode, signal) and expiresAt (the pending CMS action deadline). Optional: locale, variant A/B/C, bindingQr and authLinkOrigin for first enrollment only, onVerified, onError, onClose, onExpired. Success contains status, verificationId, authenticationPolicy and expiresAt; it has no requestId or businessId.
 
-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`.
+Cookie authentication requires CSRF. Bearer authentication uses accessToken with credentials=omit. For a cross-origin CMS explicitly set allowedBackendOrigins. Bare HTTPS origins are required outside loopback development.
 
-## React
+## React and Vue
 
-`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" />`.
+The React component takes the same options. Vue emits verified, error, close and expired. Keep client references stable. Thirteen languages remain supported; Simplified Chinese is the default. A is minimal, B is split, C is compact.
 
 ```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>
-  </>;
-}
+import { AuthLinkPasscode } from '@auth-link/web/react';
+// Keep client stable (for example with useMemo).
+<AuthLinkPasscode client={client} expiresAt={pending.expiresAt}
+  locale="zh-CN" variant="B" onVerified={updateUI} />
 ```
-
-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 setup>
+import { AuthLinkPasscode } from '@auth-link/web/vue';
 </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" />
+  <AuthLinkPasscode :client="client" :expires-at="pending.expiresAt"
+    locale="zh-CN" variant="B" @verified="updateUI" />
 </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
+## Errors and cleanup
 
-- 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.
+A used code cannot authorize a second action, even in another session. After sign-in or first enrollment, wait for the next code. PASSCODE_INVALID/PASSCODE_USED/PASSCODE_LOCKED are validation errors, not success. Retain the same backend idempotency key and original code when a result is unknown; retries must not repeat the business action.
 
-## License
+destroy() aborts browser work and clears timers without a close callback. close() also calls onClose. Closing a dialog does not roll back server work: your CMS must manage cancellation and its pending slot. Waiting and local expiry never poll.
 
-MIT. See `LICENSE` for the full license text and `THIRD_PARTY_NOTICES.md` for bundled third-party attribution.
+The older openAuthLink / Ticket / Consume workflow remains available for the earlier protocol; new apps use openPasscode / AuthLinkPasscode and the backend Authenticate/authenticate method. No old-binding migration is provided.