@auth-link/web 0.0.1 → 0.0.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +26 -4
- package/LICENSE +21 -0
- package/README.md +1386 -120
- package/dist/index.js +50 -11
- package/dist/index.js.map +2 -2
- package/dist/react.js.map +2 -2
- package/dist/types/core.d.ts +13 -2
- package/dist/types/index.d.ts +1 -0
- package/dist/vue.js +12 -3
- package/dist/vue.js.map +2 -2
- package/docs/README.en.md +180 -25
- package/docs/README.ja.md +199 -44
- package/docs/README.zh-CN.md +251 -58
- package/docs/go-vue.en.md +254 -0
- package/docs/go-vue.ja.md +254 -0
- package/docs/go-vue.zh-CN.md +258 -0
- package/examples/vue-cms.vue +109 -0
- package/package.json +5 -3
package/docs/README.zh-CN.md
CHANGED
|
@@ -4,28 +4,11 @@
|
|
|
4
4
|
|
|
5
5
|
**AuthLink 官方前端组件包**,帮助网站接入手机绑定与 App 确认流程,支持 React 18/19、Vue 3.3+、TypeScript 和 ESM。
|
|
6
6
|
|
|
7
|
+
## Go + Vue 完整接入
|
|
7
8
|
|
|
8
|
-
|
|
9
|
+
按实际 CMS 流程接入,推荐先读 [Go + Vue:从登录、绑定到确认发布](./go-vue.zh-CN.md),完整组件见 [Vue CMS 示例](../examples/vue-cms.vue)。
|
|
9
10
|
|
|
10
|
-
|
|
11
|
-
import { openAuthLinkBind, openAuthLinkConfirm, requestKey } from '@auth-link/web';
|
|
12
|
-
import '@auth-link/web/styles.css';
|
|
13
|
-
|
|
14
|
-
// 在按钮事件中创建请求,再打开弹窗;client 为前文的同源客户端。
|
|
15
|
-
const ticket = await client.create('confirm', { idempotencyKey: requestKey() });
|
|
16
|
-
const modal = openAuthLinkConfirm({
|
|
17
|
-
ticket, client, locale: 'zh-CN',
|
|
18
|
-
onConfirmed: result => console.log(result.requestId),
|
|
19
|
-
onRejected: result => console.log(result.code), // REJECTED,此时弹窗已关闭
|
|
20
|
-
onClose: () => console.log('已关闭'),
|
|
21
|
-
});
|
|
22
|
-
// 绑定使用 openAuthLinkBind({ ticket: bindingTicket, client })。
|
|
23
|
-
// modal.close(); modal.setLocale('ja');
|
|
24
|
-
```
|
|
25
|
-
|
|
26
|
-
React / Vue 的 AuthLinkBind、AuthLinkConfirm 挂载后也直接打开弹窗,不再内嵌在页面。React 用 onClose、Vue 用 @close 清空 ticket 并卸载组件。服务端渲染不创建弹窗或请求。支持手机窄屏、内容滚动、关闭按钮及 Escape;要求浏览器支持原生 dialog.showModal()。弹窗挂到 document.body,主题变量请配置在 :root 或 .authlink-dialog。
|
|
27
|
-
|
|
28
|
-
关闭只停止前端查询,不拒绝或撤销服务端请求;请求仍按原有效期结束。确认成功或拒绝后弹窗自动关闭,分别回调 onConfirmed 或 onRejected,不触发用户关闭回调。直接调用时,页面卸载须执行 modal.destroy() 清理,它不触发用户关闭回调。切换语言用 modal.setLocale(),不会重建鉴权请求。
|
|
11
|
+
顺序是:网站登录 → Go `/api/session` 返回 `authenticated` 与 `csrf` → Vue 通过 `csrfToken: () => session.csrf` 配置跨域客户端 → 创建 bind/confirm → Go 验证并消费结果后落库 → Vue 清理弹窗 → 独立业务接口再校验已保存回执并发布。`baseUrl` 是 Go 业务 API,`authLinkOrigin` 是 AuthLink API;租户密钥始终留在 Go 后台。带文章 ID/版本的确认通过网站自己的 fetch 创建并用 `validateTicket` 校验,SDK 的 `create` 只发送 purpose。
|
|
29
12
|
|
|
30
13
|
|
|
31
14
|
## 功能
|
|
@@ -41,7 +24,7 @@ React / Vue 的 AuthLinkBind、AuthLinkConfirm 挂载后也直接打开弹窗,
|
|
|
41
24
|
|
|
42
25
|
## 接入步骤
|
|
43
26
|
|
|
44
|
-
1.
|
|
27
|
+
1. 在应用后台完成站点租户配置,并实现本文的创建请求、查询结果两个业务后台接口(同源或显式配置的跨域后台)。
|
|
45
28
|
2. 安装包、导入样式,创建指向应用后台的客户端。
|
|
46
29
|
3. 用户点击绑定或验证时创建请求,将返回的 ticket 交给 React/Vue 组件。
|
|
47
30
|
4. 用户在 App 确认后,应用后台验证并消费结果,组件收到可信确认事件。
|
|
@@ -64,46 +47,228 @@ React / Vue 的 AuthLinkBind、AuthLinkConfirm 挂载后也直接打开弹窗,
|
|
|
64
47
|
npm install @auth-link/web
|
|
65
48
|
```
|
|
66
49
|
|
|
67
|
-
##
|
|
50
|
+
## 创建应用客户端(默认同源 Cookie 模式)
|
|
51
|
+
|
|
52
|
+
`readCsrfTokenFromYourCms` 是接入方函数,不是包里的导出;名称不要求与你的网站框架一致,也不要求使用 CMS。它只读取**你的网站后台提供的 CSRF token**,用于保护携带登录 cookie 的请求,不是 AuthLink 租户 API key、登录 cookie 或手机核对码。
|
|
53
|
+
|
|
54
|
+
下面采用页面 meta 标签的方式。后台需要先准备 token:
|
|
55
|
+
|
|
56
|
+
1. 优先复用网站框架现有的 CSRF 机制;没有现成机制时,在服务端为当前登录 session 生成并保存密码学安全随机 token,例如 Node 的 `randomBytes(32).toString('base64url')`。不要在浏览器随机生成一个值,也不要使用所有用户共用的固定字符串。
|
|
57
|
+
2. 服务端使用当前 session 的 token 渲染下面的标签,正确转义 HTML 属性;`{{ csrfToken }}` 表示服务器模板变量,不是可直接照抄的 token。包含会话 token 的页面不能被公开缓存。
|
|
58
|
+
3. 创建和查询接口都读取 `X-CSRF-Token`,与同一登录 session 保存的 token 校验;缺失、不匹配或请求来源不符合网站要求时拒绝请求。仅让前端发送这个头,并不会自动启用后台校验。
|
|
59
|
+
4. 登录、退出或会话/token 更新后,让页面重新取得当前 token。SPA 也可以由网站实现同源会话初始化接口返回 token,再通过 `csrfToken` 回调提供;这不是 SDK 自带接口。
|
|
60
|
+
|
|
61
|
+
```html
|
|
62
|
+
<!-- 由你的网站后台渲染到当前用户的页面 head 中 -->
|
|
63
|
+
<meta name="csrf-token" content="{{ csrfToken }}">
|
|
64
|
+
```
|
|
65
|
+
|
|
66
|
+
新建 `authlink-client.ts`:
|
|
68
67
|
|
|
69
68
|
```ts
|
|
70
|
-
|
|
69
|
+
// authlink-client.ts
|
|
70
|
+
import { createAuthLinkClient } from '@auth-link/web';
|
|
71
71
|
import '@auth-link/web/styles.css';
|
|
72
72
|
|
|
73
|
-
//
|
|
73
|
+
// The application server renders this meta element using the current session's
|
|
74
|
+
// CSRF token. This function only reads that token; it does not generate one.
|
|
75
|
+
export function readCsrfTokenFromYourCms(): string {
|
|
76
|
+
const token = document.querySelector<HTMLMetaElement>('meta[name="csrf-token"]')?.content;
|
|
77
|
+
if (!token) throw new Error('Missing CSRF token; load the authenticated application page first.');
|
|
78
|
+
return token;
|
|
79
|
+
}
|
|
80
|
+
|
|
74
81
|
export const client = createAuthLinkClient({
|
|
75
82
|
baseUrl: '/api/authlink',
|
|
76
|
-
csrfToken:
|
|
77
|
-
|
|
83
|
+
csrfToken: readCsrfTokenFromYourCms,
|
|
84
|
+
// Replace this example with the configured AuthLink service origin.
|
|
85
|
+
authLinkOrigin: 'https://auth.example.com',
|
|
86
|
+
});
|
|
87
|
+
```
|
|
88
|
+
|
|
89
|
+
把 `https://auth.example.com` 换成实际 AuthLink 服务来源。SDK 会在每次请求时调用读取函数,自动把值放入 `X-CSRF-Token`,并携带同源登录 cookie;前端不需要读取 HttpOnly 登录 cookie。若网站框架默认使用其他 CSRF 头名,可用 `csrfHeaderName` 配成后台期望的头名,或者实现自定义 `AuthLinkClient`。
|
|
90
|
+
|
|
91
|
+
`create` 只传用途,网站账号由后台登录 session 决定。客户端通常只初始化一次;用户点击按钮时才创建请求。完整调用见下方 React 示例,不要把 `client.create()` 放在模块加载、React effect 或 Vue watch 中。
|
|
92
|
+
|
|
93
|
+
## 前后端分离与跨域后台(0.0.2 起)
|
|
94
|
+
|
|
95
|
+
默认仍使用同源 `/api/authlink`。直接访问另一个后台来源时,同时配置完整 `baseUrl` 和 `allowedBackendOrigins`,例如网页在 `https://www.example.com`,业务后台在 `https://api.example.com`。来源是协议、主机和端口的组合;同一主域名下不同子域名也属于跨域。
|
|
96
|
+
|
|
97
|
+
`allowedBackendOrigins` 是前端明确授权的**业务后台来源**,不能带路径、通配符、用户名或密码,不能来自用户输入。生产环境使用 HTTPS;HTTP 仅允许 localhost / 127.0.0.1 / [::1] 开发环境,端口必须匹配。SDK 会先校验目标再读取凭据,并拒绝 HTTP 重定向。`authLinkOrigin` 则用于校验二维码中的 AuthLink 服务来源,两者作用不同,可按需要同时配置。
|
|
98
|
+
|
|
99
|
+
### 跨域 Cookie / session
|
|
100
|
+
|
|
101
|
+
下面给出完整的初始化函数。`GET /api/session` 是接入网站自己实现的示例会话接口,不是包或 AuthLink 服务自带的接口;它应根据现有登录 cookie 返回 `{ "csrfToken": "当前会话的真实CSRF token" }`,设置 `Cache-Control: no-store` 并配置下文的 CORS。部署时将路径换成网站实际的会话初始化接口。
|
|
102
|
+
|
|
103
|
+
这里的 `csrfToken` 是通用示例选定的 JSON 字段名。Go CMS 实例实际返回 `{ authenticated: true, csrf: '…' }`;读取 `session.csrf` 并交给同名 SDK 配置回调即可,无须改动后台响应。完整映射见上方 Go + Vue 指南。
|
|
104
|
+
|
|
105
|
+
```ts
|
|
106
|
+
import { createAuthLinkClient } from '@auth-link/web';
|
|
107
|
+
|
|
108
|
+
/** /api/session is an example endpoint implemented by your application backend. */
|
|
109
|
+
export async function createSessionBackendClient(backendOrigin: string) {
|
|
110
|
+
const response = await fetch(`${backendOrigin}/api/session`, {
|
|
111
|
+
credentials: 'include', cache: 'no-store', redirect: 'error',
|
|
112
|
+
});
|
|
113
|
+
if (!response.ok) throw new Error('Session initialization failed');
|
|
114
|
+
const session: unknown = await response.json();
|
|
115
|
+
if (!session || typeof session !== 'object' || !('csrfToken' in session) ||
|
|
116
|
+
typeof session.csrfToken !== 'string' || !session.csrfToken) {
|
|
117
|
+
throw new Error('The session endpoint must return { csrfToken: string }');
|
|
118
|
+
}
|
|
119
|
+
let currentCsrfToken = session.csrfToken;
|
|
120
|
+
return {
|
|
121
|
+
client: createAuthLinkClient({
|
|
122
|
+
baseUrl: `${backendOrigin}/api/authlink`,
|
|
123
|
+
allowedBackendOrigins: [backendOrigin],
|
|
124
|
+
credentials: 'include',
|
|
125
|
+
csrfToken: () => currentCsrfToken,
|
|
126
|
+
}),
|
|
127
|
+
// Call after your application's session/token refresh; recreate on account changes.
|
|
128
|
+
updateCsrfToken(value: string) { currentCsrfToken = value; },
|
|
129
|
+
};
|
|
130
|
+
}
|
|
131
|
+
```
|
|
132
|
+
|
|
133
|
+
登录后调用 `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 策略的开关。
|
|
134
|
+
|
|
135
|
+
### 跨域 Bearer token / JWT
|
|
136
|
+
|
|
137
|
+
传入网站自己的登录状态对象;网站完成登录或刷新后更新这个对象的 `accessToken`。回调会在每次创建和轮询时重新读取最新 token,无需重建弹窗。
|
|
138
|
+
|
|
139
|
+
```ts
|
|
140
|
+
import { createAuthLinkClient } from '@auth-link/web';
|
|
141
|
+
|
|
142
|
+
/** auth is your website's existing login state, updated by its login/refresh flow. */
|
|
143
|
+
export function createBearerBackendClient(backendOrigin: string, auth: { accessToken: string }) {
|
|
144
|
+
return createAuthLinkClient({
|
|
145
|
+
baseUrl: `${backendOrigin}/api/authlink`,
|
|
146
|
+
allowedBackendOrigins: [backendOrigin],
|
|
147
|
+
credentials: 'omit',
|
|
148
|
+
accessToken: () => auth.accessToken,
|
|
149
|
+
});
|
|
150
|
+
}
|
|
151
|
+
```
|
|
152
|
+
|
|
153
|
+
`accessToken` 必须是接入网站的用户登录 token,不能是 AuthLink 租户 API key。SDK 自动添加 `Authorization: Bearer ...`。纯 Bearer 模式默认 `credentials: 'omit'`,可不传 `csrfToken`;后台应仅按 Bearer token 认证,不回退到 Cookie 登录。若显式设置 `credentials: 'include'` 或 `'same-origin'` 混用 Cookie,仍须提供并校验 `csrfToken`。
|
|
154
|
+
|
|
155
|
+
### 后台 CORS 配置
|
|
156
|
+
|
|
157
|
+
后台需处理浏览器发出的 `OPTIONS` 预检,并在预检、实际响应和错误响应中返回相应 CORS 头。会话初始化接口也需要这些设置。以下假设前端来源是 `https://www.example.com`:
|
|
158
|
+
|
|
159
|
+
```http
|
|
160
|
+
Access-Control-Allow-Origin: https://www.example.com
|
|
161
|
+
Access-Control-Allow-Credentials: true
|
|
162
|
+
Access-Control-Allow-Methods: GET, POST, OPTIONS
|
|
163
|
+
Access-Control-Allow-Headers: Content-Type, X-CSRF-Token, Idempotency-Key, Authorization
|
|
164
|
+
Vary: Origin
|
|
165
|
+
```
|
|
166
|
+
|
|
167
|
+
携带 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)。
|
|
168
|
+
|
|
169
|
+
### 请求客户端配置
|
|
170
|
+
|
|
171
|
+
| 配置 | 说明 |
|
|
172
|
+
| --- | --- |
|
|
173
|
+
| `baseUrl` | 业务后台前缀,默认 `/api/authlink`;跨域时填写完整地址 |
|
|
174
|
+
| `allowedBackendOrigins` | 额外允许的精确后台来源数组,默认只允许当前网页同源 |
|
|
175
|
+
| `credentials` | Cookie 模式默认 `same-origin`;提供 `accessToken` 时默认 `omit`;跨域 Cookie 显式设置 `include` |
|
|
176
|
+
| `csrfToken` | 每次请求读取 CSRF token 的同步或异步函数;Cookie 模式必填 |
|
|
177
|
+
| `csrfHeaderName` | CSRF 请求头名,默认 `X-CSRF-Token`,例如可设为 `X-XSRF-TOKEN` |
|
|
178
|
+
| `accessToken` | 每次请求读取网站 Bearer token 的同步或异步函数;不要包含 `Bearer ` 前缀 |
|
|
179
|
+
| `headers` | 额外的 `HeadersInit` 或返回它的同步/异步函数,可传工作区等自定义头 |
|
|
180
|
+
| `authLinkOrigin` | 核对二维码中的 AuthLink 服务来源,与业务后台来源独立 |
|
|
181
|
+
| `fetch` | 可选 fetch 实现;仍受目标来源和协议校验约束 |
|
|
182
|
+
|
|
183
|
+
SDK 管理 `Accept`、`Content-Type`、`Authorization`、`Idempotency-Key` 和配置的 CSRF 头,`headers` 不能覆盖这些字段,否则报 `RESERVED_HEADER`。用 `accessToken` 设置 Bearer token,用 `csrfHeaderName` 适配后台框架。`ClientOptions` 可从根入口导入为 TypeScript 类型。
|
|
184
|
+
|
|
185
|
+
未授权来源报 `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`,具体原因需查看浏览器开发者工具。
|
|
186
|
+
|
|
187
|
+
## 直接调用弹窗(React、Vue 或原生 JavaScript)
|
|
188
|
+
|
|
189
|
+
```ts
|
|
190
|
+
import { openAuthLinkBind, openAuthLinkConfirm, requestKey } from '@auth-link/web';
|
|
191
|
+
import { client } from './authlink-client';
|
|
192
|
+
import '@auth-link/web/styles.css';
|
|
193
|
+
|
|
194
|
+
// 在按钮事件中创建请求,再打开弹窗;client 为上文 authlink-client.ts 导出的同源客户端。
|
|
195
|
+
const ticket = await client.create('confirm', { idempotencyKey: requestKey() });
|
|
196
|
+
const modal = openAuthLinkConfirm({
|
|
197
|
+
ticket, client, locale: 'zh-CN',
|
|
198
|
+
onConfirmed: result => console.log(result.requestId),
|
|
199
|
+
onRejected: result => console.log(result.code), // REJECTED,此时弹窗已关闭
|
|
200
|
+
onClose: () => console.log('已关闭'),
|
|
78
201
|
});
|
|
79
|
-
//
|
|
80
|
-
|
|
81
|
-
const ticket = await client.create('bind', { idempotencyKey: key });
|
|
82
|
-
// 创建响应丢失时复用 key 重试,不能每次重试都生成新 key。
|
|
202
|
+
// 绑定使用 openAuthLinkBind({ ticket: bindingTicket, client })。
|
|
203
|
+
// modal.close(); modal.setLocale('ja');
|
|
83
204
|
```
|
|
84
205
|
|
|
85
|
-
|
|
206
|
+
React / Vue 的 AuthLinkBind、AuthLinkConfirm 挂载后也直接打开弹窗,不再内嵌在页面。React 用 onClose、Vue 用 @close 清空 ticket 并卸载组件。服务端渲染不创建弹窗或请求。支持手机窄屏、内容滚动、关闭按钮及 Escape;要求浏览器支持原生 dialog.showModal()。弹窗挂到 document.body,主题变量请配置在 :root 或 .authlink-dialog。
|
|
207
|
+
|
|
208
|
+
关闭只停止前端查询,不拒绝或撤销服务端请求;请求仍按原有效期结束。确认成功或拒绝后弹窗自动关闭,分别回调 onConfirmed 或 onRejected,不触发用户关闭回调。直接调用时,页面卸载须执行 modal.destroy() 清理,它不触发用户关闭回调。切换语言用 modal.setLocale(),不会重建鉴权请求。
|
|
209
|
+
|
|
86
210
|
|
|
87
211
|
## React
|
|
88
212
|
|
|
213
|
+
下面的 `showBound` 也是接入方函数,负责更新页面提示和清空 `ticket`,从而卸载弹窗;它不向后台提交“绑定成功”,也不保存绑定。绑定及确认记录必须在后台查询结果接口验证、消费并保存后,才返回 `confirmed`。
|
|
214
|
+
|
|
215
|
+
这个示例包含按钮、请求创建、结果提示和弹窗清理,不再依赖未定义的 `showBound`、`showRejected` 等函数。使用 `<AuthLinkPanel mode="bind" />` 绑定,使用 `<AuthLinkPanel mode="confirm" />` 请求手机确认。
|
|
216
|
+
|
|
89
217
|
```tsx
|
|
218
|
+
"use client";
|
|
219
|
+
import { useRef, useState } from 'react';
|
|
220
|
+
import { requestKey } from '@auth-link/web';
|
|
221
|
+
import type { Mode, Ticket } from '@auth-link/web';
|
|
90
222
|
import { AuthLinkBind, AuthLinkConfirm } from '@auth-link/web/react';
|
|
91
|
-
import
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
223
|
+
import { client } from './authlink-client';
|
|
224
|
+
|
|
225
|
+
export function AuthLinkPanel({ mode }: { mode: Mode }) {
|
|
226
|
+
const [ticket, setTicket] = useState<Ticket | null>(null);
|
|
227
|
+
const [busy, setBusy] = useState(false);
|
|
228
|
+
const [message, setMessage] = useState('');
|
|
229
|
+
const key = useRef<string | null>(null);
|
|
230
|
+
const creating = useRef(false);
|
|
231
|
+
function finish(message: string) {
|
|
232
|
+
setTicket(null);
|
|
233
|
+
setMessage(message);
|
|
234
|
+
}
|
|
235
|
+
function showBound(requestId: string) {
|
|
236
|
+
// UI feedback only. The backend has already verified and saved the binding.
|
|
237
|
+
finish(`手机绑定成功(请求 ${requestId})`);
|
|
238
|
+
}
|
|
239
|
+
function showConfirmed(requestId: string) {
|
|
240
|
+
finish(`手机确认成功(请求 ${requestId})`);
|
|
241
|
+
}
|
|
242
|
+
const start = async () => {
|
|
243
|
+
if (creating.current || ticket) return;
|
|
244
|
+
creating.current = true;
|
|
245
|
+
setBusy(true);
|
|
246
|
+
setMessage('');
|
|
247
|
+
try {
|
|
248
|
+
key.current ??= requestKey();
|
|
249
|
+
setTicket(await client.create(mode, { idempotencyKey: key.current }));
|
|
250
|
+
key.current = null;
|
|
251
|
+
} catch { setMessage('请求未完成,可重试同一次创建。'); }
|
|
252
|
+
finally { creating.current = false; setBusy(false); }
|
|
253
|
+
};
|
|
254
|
+
const Component = mode === 'bind' ? AuthLinkBind : AuthLinkConfirm;
|
|
255
|
+
return <>
|
|
256
|
+
{!ticket && <button type="button" disabled={busy} onClick={() => void start()}>开始验证</button>}
|
|
257
|
+
{ticket && <Component ticket={ticket} client={client}
|
|
258
|
+
onConfirmed={result => result.purpose === 'bind' ? showBound(result.requestId) : showConfirmed(result.requestId)}
|
|
259
|
+
onClose={() => finish('已关闭')}
|
|
260
|
+
onRejected={() => finish('手机已拒绝本次请求')}
|
|
261
|
+
onExpired={() => finish('请求已过期,请重新发起')}
|
|
262
|
+
onError={error => setMessage(error.message)} />}
|
|
263
|
+
<p role="status">{message}</p>
|
|
264
|
+
</>;
|
|
104
265
|
}
|
|
105
266
|
```
|
|
106
267
|
|
|
268
|
+
`requestId` 用于展示或追踪本次请求,不是授权凭据。`showBound` 也可以按网站需求显示 toast、重新查询已有的账号状态接口或导航到绑定管理页。刷新页面后,应重新从后台读取真实绑定状态,不能只依赖 React state 或 localStorage。其他业务接口仍需在后台检查权限。
|
|
269
|
+
|
|
270
|
+
创建失败时示例保留同一个幂等键;再次点击会重试同一次创建。创建成功后清空幂等键,新的用户操作才创建新请求。关闭、成功、拒绝和过期都会清空 ticket;网络错误保留弹窗,供其重试当前请求。
|
|
271
|
+
|
|
107
272
|
确认组件默认只显示动态数字;`showQr` 可额外显示扫码入口。绑定组件始终显示二维码。`onRefresh` 可提供重新创建请求的函数;仅过期后显示该按钮。组件自身的“重试”只恢复当前请求,不创建第二个请求。
|
|
108
273
|
|
|
109
274
|
未指定 `locale` 时使用简体中文;不支持的语言代码也回退到简体中文。组件根元素设置对应的 `lang`,语言切换不会重新创建鉴权请求。
|
|
@@ -114,25 +279,47 @@ React 入口保留 `"use client"`,可用于 Next.js 客户端组件。导入
|
|
|
114
279
|
|
|
115
280
|
```vue
|
|
116
281
|
<script setup lang="ts">
|
|
282
|
+
import { ref, shallowRef } from 'vue';
|
|
283
|
+
import { requestKey } from '@auth-link/web';
|
|
284
|
+
import type { Confirmation, Mode, Ticket } from '@auth-link/web';
|
|
117
285
|
import { AuthLinkBind, AuthLinkConfirm } from '@auth-link/web/vue';
|
|
118
|
-
import
|
|
119
|
-
|
|
120
|
-
|
|
121
|
-
|
|
122
|
-
|
|
286
|
+
import { client } from './authlink-client';
|
|
287
|
+
const props = defineProps<{ mode: Mode }>();
|
|
288
|
+
const ticket = shallowRef<Ticket | null>(null);
|
|
289
|
+
const busy = ref(false);
|
|
290
|
+
const message = ref('');
|
|
291
|
+
let key: string | null = null;
|
|
292
|
+
function finish(text: string) { ticket.value = null; message.value = text; }
|
|
293
|
+
function confirmed(result: Confirmation) {
|
|
294
|
+
finish(`${result.purpose === 'bind' ? '已绑定' : '已确认'}(请求 ${result.requestId})`);
|
|
295
|
+
}
|
|
296
|
+
async function start() {
|
|
297
|
+
if (busy.value) return;
|
|
298
|
+
busy.value = true;
|
|
299
|
+
key ??= requestKey();
|
|
300
|
+
try {
|
|
301
|
+
ticket.value = await client.create(props.mode, { idempotencyKey: key });
|
|
302
|
+
key = null;
|
|
303
|
+
} catch { message.value = '请求未完成,可重试同一次创建。'; }
|
|
304
|
+
finally { busy.value = false; }
|
|
305
|
+
}
|
|
123
306
|
</script>
|
|
124
307
|
|
|
125
308
|
<template>
|
|
126
|
-
<
|
|
127
|
-
|
|
309
|
+
<button v-if="!ticket" type="button" :disabled="busy" @click="start">开始验证</button>
|
|
310
|
+
<AuthLinkBind v-else-if="mode === 'bind'" :ticket="ticket" :client="client"
|
|
311
|
+
@confirmed="confirmed" @close="finish('已关闭')" @rejected="finish('手机已拒绝本次请求')"
|
|
312
|
+
@expired="finish('请求已过期,请重新发起')" @error="message = '网络异常,请重试。'" />
|
|
128
313
|
<AuthLinkConfirm v-else :ticket="ticket" :client="client"
|
|
129
|
-
|
|
314
|
+
@confirmed="confirmed" @close="finish('已关闭')" @rejected="finish('手机已拒绝本次请求')"
|
|
315
|
+
@expired="finish('请求已过期,请重新发起')" @error="message = '网络异常,请重试。'" />
|
|
316
|
+
<p role="status">{{ message }}</p>
|
|
130
317
|
</template>
|
|
131
318
|
```
|
|
132
319
|
|
|
133
320
|
拒绝时返回 `{ status: 'rejected', code: 'REJECTED', requestId, purpose }`。`REJECTED` 是 SDK 业务状态码,不是 HTTP 状态码或授权凭证。组件自动关闭,不再显示“已拒绝 / 重新发起”面板,也不触发 `onClose`;提示和重新发起由接入网站在回调中决定。React / Vue 请在 `onRejected` / `@rejected` 中清空 ticket、卸载组件。无 UI 的 hook 仍保留 `snapshot.status === 'rejected'`,供自定义界面使用。
|
|
134
321
|
|
|
135
|
-
|
|
322
|
+
此示例在过期后清空 ticket,用户可再次点击按钮发起请求。如果需要在过期弹窗内提供重新发起按钮,可自行传入 `onRefresh`,在回调中创建新请求并更新 ticket。`useAuthLink(() => options)` composable 与 React 的 `useAuthLink(options)` hook 可用于自定义界面,返回 `snapshot` 和 `retry`;Vue 的 snapshot 是浅 ref。
|
|
136
323
|
|
|
137
324
|
## 选择弹窗样式
|
|
138
325
|
|
|
@@ -194,19 +381,19 @@ openAuthLinkConfirm({ ticket, client, variant: 'B' });
|
|
|
194
381
|
| `@auth-link/web/vue` | Vue 组件和 `useAuthLink` |
|
|
195
382
|
| `@auth-link/web/styles.css` | 组件样式,需显式导入 |
|
|
196
383
|
|
|
197
|
-
|
|
384
|
+
## 应用后台接口约定
|
|
198
385
|
|
|
199
386
|
默认前缀 `/api/authlink`;下面两个接口由接入方实现,**不是直接把浏览器请求转发到租户密钥 API**。
|
|
200
387
|
|
|
201
388
|
### `POST /requests`
|
|
202
389
|
|
|
203
|
-
|
|
390
|
+
浏览器按所选模式携带网站登录凭据:Cookie 模式发送 session cookie 和配置的 CSRF 头,Bearer 模式发送 `Authorization`。创建还发送稳定的 `Idempotency-Key`,body:
|
|
204
391
|
|
|
205
392
|
```json
|
|
206
393
|
{"purpose":"bind"}
|
|
207
394
|
```
|
|
208
395
|
|
|
209
|
-
|
|
396
|
+
后台从经过验证的 session 或 Bearer token 取得用户 ID,创建并持久保存 state、创建/消费幂等键、用户/session 关联,然后调用 AuthLink 服务端创建请求。返回其公开 ticket:
|
|
210
397
|
|
|
211
398
|
```ts
|
|
212
399
|
type Ticket = {
|
|
@@ -225,7 +412,7 @@ type Ticket = {
|
|
|
225
412
|
|
|
226
413
|
### `POST /requests/{requestId}/result`
|
|
227
414
|
|
|
228
|
-
|
|
415
|
+
同样验证登录身份(Cookie 模式还需 CSRF)和请求归属。后台调用 AuthLink 状态接口,将 `displayCode` 原样返回,不能缓存跨过 `validUntil`。新代码由后台实时获取,不是前端自行生成。
|
|
229
416
|
|
|
230
417
|
尚未完成时返回 `{requestId,status,displayCode?}`;状态可为 new / pending / approved / consumed / rejected / expired。`approved` 不能触发成功事件。
|
|
231
418
|
|
|
@@ -256,7 +443,9 @@ type Ticket = {
|
|
|
256
443
|
|
|
257
444
|
## 样式与语言
|
|
258
445
|
|
|
259
|
-
CSS 单独导入,所有类使用 `authlink-`
|
|
446
|
+
CSS 单独导入,所有类使用 `authlink-` 前缀。弹窗挂载到 `document.body`,可在 `:root` 或 `.authlink-dialog` 覆盖 `--authlink-foreground`、`--authlink-background`、`--authlink-accent`、`--authlink-muted`。面板语言见下表,默认简体中文。
|
|
447
|
+
|
|
448
|
+
React / Vue 均支持 `className`;Vue 还支持字符串、数组和对象形式的 `class`,与 `className` 合并。“重新发起”按钮使用父组件最新传入的 `onRefresh` 回调。
|
|
260
449
|
|
|
261
450
|
|
|
262
451
|
| Code | Language |
|
|
@@ -280,3 +469,7 @@ CSS 单独导入,所有类使用 `authlink-` 前缀。可在宿主容器覆盖
|
|
|
280
469
|
## 兼容性
|
|
281
470
|
|
|
282
471
|
React 18.2+ / 19、Vue 3.3+、TypeScript、ESM。React 和 Vue 是可选 peer,只安装所用框架。构建工具环境需 Node 22.13+。
|
|
472
|
+
|
|
473
|
+
## 许可证
|
|
474
|
+
|
|
475
|
+
MIT。完整许可文本见 `LICENSE`,打包包含的第三方库归属说明见 `THIRD_PARTY_NOTICES.md`。
|