# @autional/core 中文文档

规范地址：https://npmcn.com/package/%40autional/core/

版本：0\.4\.2
npm 元数据更新时间：2026-11-06T12:14:02.167Z
中文译文更新时间：2026-11-07T06:20:17.253Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40autional/core
原文对照：https://npmcn.com/package/%40autional/core/?lang=original

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：529 kB，51 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：0 个
- 首次发布：2026-06-28T15:33:17.870Z
- 最新版本发布：2026-11-06T10:28:31.162Z
- 近 30 天下载量：2275（2026-10-07 至 2026-11-05，npm 官方下载统计）
- 已发布版本数：15（近 12 个月 15 个）

## 中文简介

缓冲 Core SDK — 框架不可知符号管理, API 客户端, 和认证流

## 安装

```sh
npm install @autional/core
```

也可以使用：`pnpm add @autional/core`、`yarn add @autional/core`、`bun add @autional/core`

## README

# @ autional/ 核心

Autental Core SDK——框架-不可知符号管理,API客户端,以及认证流.

## 里面的东西

-   **`Autional`** ——主要客户端:登录,注册,登录,OAuth,令牌刷新,设备流程,会话管理,分级升级,门户URL,租户切换,事件系统
-   **`ApiClient`** – HTTP 客户端带有自动令牌注入, 预请求刷新, 401 上刷新, 和 snake case/ camelCase 转换
-   **`AuthClient`** ——密码传输预处理和PoW Captcha解析的认证电话
-   **`Discovery`** - OIDC 取取发现文件
-   **`TokenManager`** ——取用/再现代币存储,JWT解码,过期跟踪
-   **`TabSync`** ——通过广播频道进行跨台会话同步
-   **`browserPlatform` 编号 : `sessionStoragePlatform` 编号 : `memoryPlatform`** ——现成平台装订(localStorage/会话Storage/内存)
-   **`DpopManager`** —— OAuth 符号端点的选入 DPoP (RFC 9449) 校验生成
-   **`buildPortalUrl` 编号 : `extractTenantSlugFromIssuer`** 租户涕丸和控制台门户URL助手

## 安装

```bash
npm install @autional/core
```

## 快速启动

```ts
import { Autional, browserPlatform } from '@autional/core';

const autional = new Autional({
  appId: 'my-app',
  issuer: 'https://auth.example.com',
  platform: browserPlatform,
});

await autional.initialize();

await autional.login({ email: 'user@example.com', password: 's3cret' });

const profile = await autional.api.get('/profile/api/v1/profiles/me');
console.log(profile);
```

## 密码传输

`processPasswordForTransmission` 以 4 种模式为租户策略进行预处理密码 :

| 模式 | 运输 | 说明 |
| --- | --- | --- |
| `plain` | 原始密码 | 无处理 |
| `hash` | SHA-256(密码+) | " + 租户 (d) 国家 |
| `symmetric` | ECDH + AES-256-GCM | 密钥交换, 加密 |
| `asymmetric` | RSA- OAEP | 加密公用钥匙 |

SDK从 `TenantAuthConfig.passwordPolicy.mode` 并自动应用在登录/登记/更改-密码上.

## 会话账户 自助服务

同样的呼唤 `Autional` 财务报告和审定财务报表 `AuthClient`数字 :

| 打电话 | 目的 |
| --- | --- |
| `getSessions()` 编号 : `revokeSession(id)` 编号 : `revokeOtherSessions()` | 列出/撤销我的会话( E)`isCurrentSession` 从JWT标记 `sid`(中文(简体) ) |
| `reauthenticate(password)` | 用于敏感操作(单用,5分钟)的加速符 |
| `deleteAccount(password)` | GDPR 消除——内部进行升级并发送 `X-StepUp-Token` |
| `forgotPassword()` 编号 : `resetPassword()` 编号 : `sendVerificationEmail()` 编号 : `verifyEmail()` | 密码重置和电子邮件校验 |
| `updateProfile({ username?, mfaEnabled?, metadata? })` | 部分配置更新 |
| `revokeTokens()` | RFC 7009 取消访问/更新令牌(SSO) `logout()` 在重定向前自动取消, 时间框为1.5 s) |

目前支持敏感端点( 分步、 删除账户) `plain` 财务报告和审定财务报表 `hash` 只有传输模式 .

## 复会和复会

`syncTabs` 默认状态。 一个成功的更新广播 `TOKEN_REFRESHED` 所以其他的标签重新读取存储器——一个 stale 刷新符符会绊倒服务器的活符再用检测,并取消整个活符家族. 注销和 `TOKEN_REUSE` 广播 `LOGOUT` 签出每个标签. `tokenExpirySkew` (秒,默认为30, `0` 禁用)在访问令牌即将到期时请求前刷新; 失败的预更新保存会话完好无损—— 只有服务器报告的再使用( 身份) `40000502` / OAuth 密码 `invalid_grant` 带有 `reused` 说明)仍然清除和广播 `LOGOUT`。 。 。 .

## 设备流程(RFC 8628)

`loginWithDeviceCode({ onUserCode })` 覆盖设备受限制的环境: 它显示用户代码和校验 URI, 服务器上的民调 `interval`后退时 `slow_down`,并接受 `AbortSignal`。 。 。 . `requestDeviceCode()` 是双相变体。 验证页由认证域提供( Y)`/device`) (中文(简体) ).

## DPoP(RFC 9449——选入)

`new Autional({ dpop: true })` 将信使绑定在P-256键上(通过平台存储, `DpopManager`) (中文(简体) ). 证明只到 OAuth 令牌- 家族端点: 令牌 / 刷新 / 撤销 / 用户info( 客户端- 证书授权 `loginWithClientCredentials` 在此发行时不包含 DPop 。 需要 WebCrypto 和服务器端的 DPOP 支持 .

## 租户污名和门户 URL

`tenantSlug` 驱动租户范围门户链接 : `getPortalUrl('admin' | 'user' | 'security' | 'platform' | 'authenticator')` 附录 `/<slug>/`· ; `developer` 财务报告和审定财务报表 `status` 是全球性的. `createTrialTenant()` 返回弹片; `buildPortalUrl` 编号 : `extractTenantSlugFromIssuer` 用于自定义目的导出 - `buildPortalUrl` 只支持共享基础( e)`api.`编号 :`auth.`\- 前置主机; 租户- subdomain 或 IP 基准返回 `null`。 。 。 .

## 项目设置

关于框架整合,请为您的框架取个例子: [`examples/react-autional.ts`](https://npmcn.com/package/examples/react-autional.ts), (中文(简体) ), [`examples/vue-autional.ts`](https://npmcn.com/package/examples/vue-autional.ts),或 [`examples/next-autional.ts`](https://npmcn.com/package/examples/next-autional.ts)复制到 `src/autional.ts`编辑 `appId` 财务报告和审定财务报表 `issuer`。 。 。 .

见 [根 SDK 读取器](https://npmcn.com/package/README.md) 用于完整文档.

## 常见问题

### @autional/core 是什么？

缓冲 Core SDK — 框架不可知符号管理, API 客户端, 和认证流

### 如何安装 @autional/core？

在项目目录运行 npm install @autional/core，或使用 pnpm add / yarn add / bun add。

### @autional/core 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @autional/core 支持 ESM 还是 CommonJS？

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

### @autional/core 可以商用吗？

@autional/core 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @autional/core 的下载量有多少？

根据 npm 官方下载统计，@autional/core 在 2026/10/07 – 2026/11/05 这 30 天内被下载 2,275 次，日均约 76 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @autional/core 还在维护吗？

最新版本 0\.4\.2 发布于 2026/11/06（1 天前）；至今共发布 15 个版本，其中过去 12 个月发布了 15 个；首次发布于 2026/06/28。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。