# @12-apps/onboarding 中文文档

规范地址：https://npmcn.com/package/%4012-apps/onboarding/

版本：2\.7\.0
npm 元数据更新时间：2026-08-25T00:32:22.506Z
中文译文更新时间：2026-11-05T19:58:00.599Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%4012-apps/onboarding
原文对照：https://npmcn.com/package/%4012-apps/onboarding/?lang=original
项目主页：https://github.com/12-apps/shared-packages#readme
源码仓库：https://github.com/12-apps/shared-packages

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

- 包体积（解压后）：204 kB，56 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=22\.0\.0
- 运行依赖：2 个
- peer 依赖：@12-apps/wiring \>=1\.3\.0，hono \>=4\.0\.0，react \>=19\.0\.0
- 首次发布：2026-07-17T22:34:49.850Z
- 最新版本发布：2026-08-25T00:32:22.178Z
- 近 30 天下载量：32604（2026-10-04 至 2026-11-02，npm 官方下载统计）
- 已发布版本数：44（近 12 个月 44 个）

## 中文简介

上载可重复使用 : React supper + Guided Sector 和 API 绑定上载 Store (.), 主机挂载进度表 (./ server: Create ApiOnboarding - GET/PATCH Progress with save/diission/ reset),一个Hono适配器 (./hono),以及软件包所有

## 安装

```sh
npm install @12-apps/onboarding
```

也可以使用：`pnpm add @12-apps/onboarding`、`yarn add @12-apps/onboarding`、`bun add @12-apps/onboarding`

## README

# @ 12- apps/ 登机

可重复使用、可续用、每个用户x租户 **登入进度** 供引导者使用 流动——任何应用程序/页面都可以采用一个小型系统.

-   **坚持用户停止的准确步骤** 每个地貌不透明 有效载荷,所以一个新鲜的恢复了它们离开的地方(不是开始).
-   **持久性-不可知性**: 向注入的 UI + 钩子聊天 `OnboardingStore`, (中文(简体) ), 所以你支持Prisma服务器的动作 TRPC、REST之类的.
-   船舶a **Prisma 帮助工具** (单位:千美元)`createOnboardingRepository`对于普通案件, (单位:千美元) **`GuidedSection`** 将国家约束在 `@12-apps/ui`是因为 `SectionOnboarding` +分阶.

两只船都一半在这里(12至23日):屏幕和端点持续 通过,每个工厂. **[采用.md](https://npmcn.com/package/%4012-apps/onboarding/ADOPTING.md) 是否通过 合同** ——配置表,被咬的接线规则,以及B阶段注释 给一个已经有桌子的宿主.

## 出口

| 条目 | 导出 | 什麽 |
| --- | --- | --- |
| `.` | `OnboardingProvider` 编号 : `useOnboarding` | 客户端状态,通过注入突变 `OnboardingStore`。 。 。 . |
| `.` | `GuidedSection` | 登陆英雄 – 按步法师(步法师) – 完成总结,由坚持状态所驱动. |
| `.` | `createOnboardingApiStore` 编号 : `fetchOnboardingState` | 被捆绑到包的OWN端点的商店,因此每个主机中一次声明了URL,身体形状和日期复兴. |
| `.` | 类型 | `OnboardingStore`, (中文(简体) ), `OnboardingStateSnapshot`, (中文(简体) ), `GuidedStep`, (中文(简体) ), `GuidedNav`,, , , , , , , , |
| `./server` | `createApiOnboarding({ db })` | 进展表面作为框架中立的路线描述符—— `GET` 财务报告和审定财务报表 `PATCH` 与 `save` 编号 : `dismiss` 编号 : `reset`。 。 。 . |
| `./server` | `createOnboardingRepository(getPrisma)` | Prisma 读取/写入其下的帮助(data-commerce + 开始/完成印花). |
| `./hono` | `onboardingRouter({ db, resolveActor })` | 与可挂的Hono路由器相同的表面. `hono` 是一个可选的对等点. |
| `prisma/` | `onboarding.prisma` + 其迁移 | 套装 OWNS的 `OnboardingState` 模型——一个主机同步它(从下到下)而不是重制. |

## 数据模型随包而来

不要用手把模型复制进你的计划 使用 Prisma 的多文件计划 文件夹并同步软件包本身的部分内容——一个字节的 CCOPY,从不 symlink(一个相通的迁移被Prisma悄悄地跳过):

```bash
node node_modules/@12-apps/onboarding/scripts/sync-onboarding-schema.mjs prisma/schema
```

移民船只在 `prisma/migrations/`里面的言辞,都是有戒备的 - 如此的东道主已经 `onboarding_states` 应用为无操作,没有 `prisma migrate resolve` 跳个舞 见Adopting.md.

## 接线

```ts
// server: one mount. The host keeps only who is calling, and where data lives.
const onboarding = onboardingRouter({
  db: async () => (await getPrismaClient()) as unknown as OnboardingPrisma,
  featureKeys: ['ai_integration'],
  resolveActor: (c) => resolveActorFor(c), // → { userId, clientId } | null
});
app.route('/api/admin/:tenantSlug', onboarding.router);

// browser: the package's own store, against those endpoints
const store = createOnboardingApiStore({ apiBase, featureKey: 'ai_integration' });
const initial = await fetchOnboardingState({ apiBase, featureKey: 'ai_integration' });

<OnboardingProvider featureKey="ai_integration" store={store} initialState={initial}>
  <GuidedSection steps={steps} title="…" configuredSummary={…} />
</OnboardingProvider>
```

其持久性不是这些路径的主机( localStorage, tRPC, 服务器动作) 仍然通过自己的 `OnboardingStore` ——接缝不变.

## 常见问题

### @12-apps/onboarding 是什么？

上载可重复使用 : React supper \+ Guided Sector 和 API 绑定上载 Store \(\.\), 主机挂载进度表 \(\./ server: Create ApiOnboarding - GET/PATCH Progress with save/diission/ reset\),一个Hono适配器 \(\./hono\),以及软件包所有

### 如何安装 @12-apps/onboarding？

在项目目录运行 npm install @12-apps/onboarding，或使用 pnpm add / yarn add / bun add。

### @12-apps/onboarding 支持 TypeScript 吗？

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

### @12-apps/onboarding 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### @12-apps/onboarding 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=22\.0\.0。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @12-apps/onboarding 可以商用吗？

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

### @12-apps/onboarding 的下载量有多少？

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

### @12-apps/onboarding 还在维护吗？

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