@happyvertical/smrt-fields

中文文档
0.62.1发布于 2026/11/17MITTypeScriptES Module近 30 天下载 1.5万

SMRT 对象的分层字段策略存储和解析器(默认、可见分级、帮助文本)

中文使用文档
文档目录9 节
  1. 安装
  2. 定义安全代码种子
  3. 在服务器上解析
  4. 使用有策略意识的 Svelte 表格
  5. 行政和个人环境
  6. 重要行为
  7. 用法学习
  8. 特色食谱
  9. 示例应用程序

@ 快乐的垂直/ smrt- fields

@happyvertical/smrt-fields 让应用程序调整对象的窗体 默认、标签、帮助、秩序、能见度和锁而不更改 对象的来源。 政策层面的组织和个人选择 代码授权的字段定义.

完整的应用程序和操作指南见 外地政策指导。 。 。 .

安装

pnpm add @happyvertical/smrt-fields

软件包包括 @happyvertical/smrt-users 因为政策写作和 经营者的行动使用其许可和租户环境服务.

定义安全代码种子

装饰模型仍然是一字段的定义. 使用其描述 财务报告和审定财务报表 ui 提示在任何政策行存在之前提供有用的第一个表格.

import { field, SmrtObject, smrt } from '@happyvertical/smrt-core';

@smrt({ packageName: '@acme/billing' })
export class Invoice extends SmrtObject {
  @field({
    required: true,
    description: 'Shown on the customer invoice.',
    ui: { basic: true, group: 'billing', order: 1 },
  })
  title = '';

  @field({ ui: { basic: false, group: 'billing', order: 2 } })
  internalNotes = '';
}

如果没有字段 ui.basic: true,字段开始于基本视图。 曾经 至少一个字段被标记为基本、无标记字段的启动. group 财务报告和审定财务报表 order 属于密码的提示; locked: true 种子一个可以防止的锁 个人控制器. widget (单位:千美元)'textarea' | 'currency' | 'email' | 'url' | 'phone'(中文(简体) ) 是输入的演示文稿提示,对照字段类型验证 构建时间(每个部件都需要文本字段); currency 选择 ISO 4217 代码,例如 'USD'这不是为了钱.

在服务器上解析

当渲染 SSR 或应用一个时, 使用信任服务器代码中的解析器 服务器拥有的工作流程。 它合并了代码 app 承租人祖先 用户.

import { resolveFieldPolicy } from '@happyvertical/smrt-fields';

const policy = await resolveFieldPolicy(
  '@acme/billing:Invoice',
  { tenantId: requestTenant.id, userId: session.user.id, db },
);

const title = policy.fields.title;

生成的客户端 resolveBatch 行动来自租户和用户 从认证的请求上下文。 不接受从 浏览器请求 。 它只返回安全暴露的田地; 敏感, 瞬间,并省略了已读许可字段.

使用有策略意识的 Svelte 表格

对于定制表格,提供解决的政策 FieldPolicyProvider 财务报告和审定财务报表 将每个输入包入 PolicyField。包装器应用可见度,标签,帮助, 和新记录默认值,同时保留您的标记和输入组件.

<script lang="ts">
  import {
    FieldPolicyProvider,
    PolicyField,
  } from '@happyvertical/smrt-fields/svelte';

  let { policy, invoice = $bindable({}) } = $props();
</script>

<FieldPolicyProvider {policy}>
  <PolicyField name="title">
    <input id="title" bind:value={invoice.title} />
  </PolicyField>
</FieldPolicyProvider>

对于生成的表格,注册应用程序生成的收藏 定义一次 ObjectFormSourceRegistry,放在一个 ObjectFormSourceProvider,然后使一个 ObjectForm 由犬类 objectRef登记册验证生成的实地定义和 页:1 resolveBatch 在渲染前回复。 全文见指南 设置,包括外地特定输入渲染器和政策意识表.

行政和个人环境

使用 FieldPolicyGearProvider 与生成的适配器 getEditorState,创建、更新和删除动作。 其身份来源于 ; 适配器方法故意不接受租户或用户代号. 使用 FieldPolicyGearButton 或者说 showPolicyGear 打开 ObjectForm 将曝光 编辑.

对于设置目标,服务器使用 buildFieldPolicySettingsCatalog() 浏览器将它通过 FieldPolicyControlPanel东道方供应路线、运输、确认和 行政壳适配器. fieldPolicyControlPanelNavItem() 财务报告和审定财务报表 registerFieldPolicyFocusTool() 结构接合,所以字段不 使用特定应用程序外壳.

fields.policy.manage 允许应用和租户管理. fields.policy.personalize 仅允许当前用户的个人选择. 主办方仍必须建立可信赖的经认证的主要上下文 在指定运营商目的地之前执行路由许可.

重要行为

  • 政策一行很稀少: null 表示继承下层. 删除一行 完全重设范围.
  • defaultValue 是JSON编码的有线频道 带有平原的服务器代码 值应当使用 defaultValueRaw 或者说 setDefaultValue()。 。 。 .
  • 没有可用的设备, 所需的字段无法隐藏或移动到高级 已解决默认 。 解析力将一个必需的,无默认的场带回 基本作为安全网.
  • App和房客排可能会锁上一块地 坚定的组织政策 锁定、拒绝个人写作和不适用旧的个人行.
  • 拒绝敏感、短暂和可读的默认 字段。 引用默认必须使用有效的 UUID, 除非该引用 声明文本 id 类型.

用法学习

可选用途捕获记录 经认证的租户成员,并将合格模式转化为 管理人审查的租户政策建议。 它从来不自动应用 建议. ObjectForm (一) 只有在东道方确认持久性之后才提出报告; 浏览器只对低心率布尔和参考字段进行中转, 而遥测失败绝不会影响保存的提交.

操作员可以明确进行休眠维护和建议时间表 与 ensureFieldUsageLearningSchedules({ db })。学习循环保留 总量和使用保守阈值;其接受/取消的建议 队列限制为 fields.policy.manage见 外地政策指导 用于捕获、隐私、保留和时间表合同.

特色食谱

软件包宣布了一个特性食谱, fields.form-customization (单位:千美元)FormCustomizationRecipe页:1 src/form-customization.recipe.md它的管理屏幕是 settings-panel 表面 @happyvertical/smrt-fields/svelte#FieldPolicyControlPanel· ; 主机仍然提供设置目录 shell 和生成客户端 上述适配器。 食谱宣布 runtime: 'server': 软件包 root 条目仍然导入仅用于节点的助手(# 3618),而 /svelte 组件只生成在服务器上解决的策略.

示例应用程序

实地政策走进现在的架构 smrt-saas-starter (单位:千美元)绑定拉力请求, (中文(简体) ), s-r-t 0.40.61) 显示所有者/管理者控件和成员配置 个人形式在工作申请中流动. smrt 启动 是当前模板.

版本与发布记录

@happyvertical/smrt-fields 共发布 220 个版本,首次发布于 2026/08/06;过去 12 个月发布了 220 个版本。

版本发布日期距今
0.62.1latest2026/11/17今天
0.62.02026/11/17今天
0.61.62026/11/161 天前
0.61.52026/11/161 天前
0.61.42026/11/161 天前
0.61.32026/11/152 天前

关于 @happyvertical/smrt-fields 的常见问题

@happyvertical/smrt-fields 是什么?

SMRT 对象的分层字段策略存储和解析器(默认、可见分级、帮助文本)

如何安装 @happyvertical/smrt-fields?

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

@happyvertical/smrt-fields 支持 TypeScript 吗?

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

@happyvertical/smrt-fields 支持 ESM 还是 CommonJS?

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

@happyvertical/smrt-fields 可以商用吗?

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

@happyvertical/smrt-fields 的下载量有多少?

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

@happyvertical/smrt-fields 还在维护吗?

最新版本 0.62.1 发布于 2026/11/17(今天);至今共发布 220 个版本,其中过去 12 个月发布了 220 个;首次发布于 2026/08/06。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。