@ happyvertical/ smrt - 首选项
为 s-m-r-t apps 保存了用户界面首选项:一个页面或应用程序是如何设置的 框是排列的。 组织设置默认值; 每个人可以保留 上面有他们自己的版本 重置返回下一层.
两种有包件的首选船:
overview: 自定义概览页面的布局smrt-svelte/overview(其中部件,顺序,宽度,选项).shell-layout: 应用程序框架的设置来自 AdminShell (导航顺序和能见度、面板状态和宽度、键盘) 快捷键).
应用程序可以注册更多种类. 每类都检查自己的数据 已保存的(任何无效的),和已装载的(任何) 不再适用,则其余适用).
使用下面的存储; 表格的模型不是应用程序 API( 它) 拒绝不从店里来的信件, 也不再返回 个人的偏好).
见 一般事务人员(其他职等) 储存规则和 代理/特惠类 类型 合同.
安装
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
一次 一次吗.
概览 页 次
// +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
而不是掩盖别人的改变:
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);
应用框( 贝壳布局)
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 } 守护它.
其他类型
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,
});