# @happyvertical/smrt-preferences 中文文档

规范地址：https://npmcn.com/package/%40happyvertical/smrt-preferences/

版本：0\.62\.1
npm 元数据更新时间：2026-11-17T07:54:43.358Z
中文译文更新时间：2026-11-17T10:40:32.356Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40happyvertical/smrt-preferences
原文对照：https://npmcn.com/package/%40happyvertical/smrt-preferences/?lang=original
项目主页：https://github.com/happyvertical/smrt#readme
源码仓库：https://github.com/happyvertical/smrt

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

- 包体积（解压后）：281 kB，43 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：6 个
- 首次发布：2026-10-15T06:15:25.756Z
- 最新版本发布：2026-11-17T07:54:43.102Z
- 近 30 天下载量：13293（2026-10-17 至 2026-11-15，npm 官方下载统计）
- 已发布版本数：103（近 12 个月 103 个）

## 中文简介

用户界面偏好(概览布局、外壳布局)的租户默认和每个用户的超标,每个注册类型验证

## 安装

```sh
npm install @happyvertical/smrt-preferences
```

也可以使用：`pnpm add @happyvertical/smrt-preferences`、`yarn add @happyvertical/smrt-preferences`、`bun add @happyvertical/smrt-preferences`

## README

# @ happyvertical/ smrt - 首选项

为 s-m-r-t apps 保存了用户界面首选项:一个页面或应用程序是如何设置的 框是排列的。 组织设置默认值; 每个人可以保留 上面有他们自己的版本 重置返回下一层.

两种有包件的首选船:

-   **`overview`**: 自定义概览页面的布局 [`smrt-svelte/overview`](https://npmcn.com/package/%40happyvertical/smrt-svelte/agents/overview-surfaces.md) (其中部件,顺序,宽度,选项).
-   **`shell-layout`**: 应用程序框架的设置来自 AdminShell (导航顺序和能见度、面板状态和宽度、键盘) 快捷键).

应用程序可以注册更多种类. 每类都检查自己的数据 已保存的(任何无效的),和已装载的(任何) 不再适用,则其余适用).

使用下面的存储; 表格的模型不是应用程序 API( 它) 拒绝不从店里来的信件, 也不再返回 个人的偏好).

见 [一般事务人员(其他职等)](https://npmcn.com/package/%40happyvertical/smrt-preferences/AGENTS.md) 储存规则和 [代理/特惠类](https://npmcn.com/package/%40happyvertical/smrt-preferences/agents/preference-kinds.md) 类型 合同.

## 安装

```bash
pnpm add @happyvertical/smrt-preferences
```

首选项存在于 `_smrt_ui_preferences` 页:1 创建它与您 正常移徙`smrt db:migrate`); 软件包从不创建表格 运行时间. `smrt db:status --parity` 报告它像任何其他的表格.

## 权限

| 权限 | 让一个人 |
| --- | --- |
| `overviews.customize` | 更改或重置组织的默认页面布局 |
| `overviews.personalize` | 保存并重置自己的页面布局 |
| `shell.customize` | 更改或重置组织的默认应用框架 |
| `shell.personalize` | 保留并重置自己的应用程序框架设置 |

店里读到这些 从签名人的许可设置 请求上下文。 如果您的应用程序通过租赁进入了租户的背景 SvelteKit 或 Express 适配器, 配置它的 `resolvePermissions` (或让 `createSessionHandler()` 从 `@happyvertical/smrt-users` 输入上下文 与 `enterTenantContext`;没有它,适配器提供空的 权限设定,包括所有者在内的所有人被拒绝.

当角色权限被播种时,所有者和管理员都会收到全部四个. 成员 观众们得享受这两件事 `personalize` 权限; 对于创建的角色 在此软件包安装之前, 运行 `seedDefaultRolePersonalizationPermissions()` 从 `@happyvertical/smrt-users` 一次 一次吗.

## 概览 页 次

```ts
// +page.server.ts
import { createOverviewStore } from '@happyvertical/smrt-preferences';
import { eventsHome, widgets } from '$lib/overviews';

export const load = async ({ locals }) => {
  const overviews = createOverviewStore({ db: locals.db });
  // Runs inside the request's tenant context; each widget loader receives
  // the capabilities passed here and must authorize through them.
  const overview = await overviews.loadPage(eventsHome, widgets, {
    locale: locals.locale,
    db: locals.db,
  });
  return { overview };
};
```

保存已装入的页面的修订版; stale 修订版返回 `conflict` 而不是掩盖别人的改变:

```ts
const saved = await overviews.save(eventsHome, widgets, {
  scope: 'user',
  override,
  revision,
});
// saved.ok, or saved.reason: 'invalid' (with issues), 'conflict', 'not_allowed'
await overviews.reset(eventsHome, { scope: 'user', revision });
const result = await overviews.loadWidget(eventsHome, widgets, widget, ctx);
```

## 应用框( 贝壳布局)

```ts
import {
  createPreferenceStore,
  createShellSettingsPreferences,
} from '@happyvertical/smrt-preferences';

const shell = createShellSettingsPreferences(createPreferenceStore({ db }));

// Remote functions the browser's ShellSettingsAdapter calls.
export const readShellSettings = async () => (await shell.read('admin')).delta;
export const writeShellSettings = (delta: unknown) =>
  shell.write('admin', delta);
```

`read` 将组织默认与个人自己的设置合并. `write` 无需修改即可写入最近存储的值,因为 shell 的适配器不携带一个; 通过 `{ revision }` 守护它.

## 其他类型

```ts
import {
  createPreferenceStore,
  registerPreferenceKind,
} from '@happyvertical/smrt-preferences';

registerPreferenceKind({
  kind: 'board-columns',
  formatVersion: 1,
  permissions: { tenant: 'boards.customize', user: 'boards.personalize' },
  validate: (payload, ctx) => checkColumns(payload, ctx),
});

const preferences = createPreferenceStore({ db });
const state = await preferences.load('board-columns', 'projects.board');
await preferences.save('board-columns', 'projects.board', {
  scope: 'user',
  payload,
  revision: state.user?.revision ?? null,
});
```

## 常见问题

### @happyvertical/smrt-preferences 是什么？

用户界面偏好\(概览布局、外壳布局\)的租户默认和每个用户的超标,每个注册类型验证

### 如何安装 @happyvertical/smrt-preferences？

在项目目录运行 npm install @happyvertical/smrt-preferences，或使用 pnpm add / yarn add / bun add。

### @happyvertical/smrt-preferences 支持 TypeScript 吗？

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

### @happyvertical/smrt-preferences 支持 ESM 还是 CommonJS？

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

### @happyvertical/smrt-preferences 可以商用吗？

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

### @happyvertical/smrt-preferences 的下载量有多少？

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

### @happyvertical/smrt-preferences 还在维护吗？

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

