@happyvertical/smrt-approvals

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

SMRT框架的批准决定门:有修订约束的单一用途核准,且达到法定人数,到期,以及仅附加事件分类账

中文使用文档
文档目录8 节
  1. 安装
  2. 概念
  3. 使用量
  4. 保证
  5. 权限
  6. 发展
  7. 许可证
  8. 可选的自我核准

@happyvertical/smrt - 批准书

用于 s -m 包定义批准 类型; 请求人打开一个对一个主题进行修改的请求; 符合资格的人决定; 消费者消费批准一次并 然后自己行动 这不是工作流程引擎:没有 阶段,没有执行人,也没有补偿.

安装

pnpm add @happyvertical/smrt-approvals

概念

型号目的
ApprovalRequest一个主题修改的大门:种类,主题类型和代号,修订散列,请求者,地位,法定人数,到期,决定和消费时间戳,租户.
ApprovalEvent仅附加分类账 : created, (中文(简体) ), approved, (中文(简体) ), rejected, (中文(简体) ), changes_requested, (中文(简体) ), cancelled, (中文(简体) ), expired, (中文(简体) ), consumed有演员和理性 出真言之来源.
ApprovalPolicy租户的收紧方式是:更高的法定人数,更短的到期时间,或者需要另外一次许可. 它永远不能放松包默认值.

状态从 pending 改为 approved, (中文(简体) ), rejected, (中文(简体) ), changes_requested, (中文(简体) ), cancelled,或 expired核准的请求一次性消费(保留 approved 地位和收益 consumedAt)或过期未结. 请求 ; 请求者打开新请求 修订.

使用量

import {
  ApprovalService,
  defineApprovalKind,
} from '@happyvertical/smrt-approvals';

// In the owning package. Register `social.approve-post` with
// registerPermissionDefinitions from @happyvertical/smrt-users.
export const publishPost = defineApprovalKind({
  key: 'social.post.publish',
  subject: '@happyvertical/smrt-social:SocialPost',
  permission: 'social.approve-post',
  defaults: { requiredApprovals: 1, ttlMs: 7 * 24 * 60 * 60 * 1000 },
});

const approvals = new ApprovalService({ db });

// Any principal type may request: human, agent, or service.
const opened = await approvals.requestApproval(author, {
  kind: publishPost,
  subjectId: post.id,
  subjectRevisionHash: revisionHash(post),
  requestKey: `publish:${post.id}:${revisionHash(post)}`,
});

// Only a human of the same tenant holding the
// kind's permission, may decide, once.
await approvals.decide(editor, opened.request.id, { decision: 'approve' });

// The consumer presents the revision it is about to act on.
const used = await approvals.consume(publisher, opened.request.id, revisionHash(post));
if (used.outcome === 'transitioned') {
  await publish(post);
}

校长是 { id, tenantId, type: 'human' | 'agent' | 'service', can(slug) }, (中文(简体) ), 从 PermissionResolver.resolvePermissions(userId, tenantId) 内 生产或生产 approvalPrincipalFromPermissions() 在测试.

每个过渡返回 { outcome, request, refusal? }。 。 。 . outcome 实值 transitioned, (中文(简体) ), already_applied (一等兵) requestKey 重放),或 refused 输入原因, 如 not_pending, (中文(简体) ), expired, (中文(简体) ), self_approval, (中文(简体) ), not_human, (中文(简体) ), forbidden, (中文(简体) ), already_decided, (中文(简体) ), revision_mismatch, (中文(简体) ), already_consumed, (中文(简体) ), unbacked_approval,或 not_found。拒绝书写 没什么.

在自己的交易中消耗,所以域名和 消费共同承诺,通过 { transaction: tx } 改为 consume打开 SQLite 和 DuckDB 打开交易 withEmbeddedWriteTransaction 从 @happyvertical/smrt-core (或 SmrtObject.withTransaction()),不是一个生的 db.transaction(),因此它保持了嵌入式写入队列.

过期 : expire(principal, id) 财务报告和审定财务报表 expireDue(principal) 记录过期 申请截止日期已过;工作可以打电话给他们。 决定和决定 在最后期限之后的消费甚至在扫荡之前就被拒绝.

保证

  • 每一次过渡都是有戒备的 UPDATE (id, 租户, 预期) 状态、版本、到期)加上在同一交易中插入一个事件. 同时期的双重批准或双重消费完全只有一个赢家; 失败者被彻底拒绝 写什么.
  • 法定人数从分类账中计算出不同的核准人;一个行动者决定一次.
  • 每一个读写时的租户都孤立:另一个租户的身份证 实值 not_found。 。 。 .
  • 生成的REST和MCP表面是 list 财务报告和审定财务报表 get 只有,没有 生成 CLI。 无法更新或删除事件 .
  • 仅 ApprovalService 可以创建请求和事件: 已建行 直接( e)new ApprovalRequest(...), (中文(简体) ), ApprovalRequestCollection.create(...), (中文(简体) ), 手写 ApprovalEvent)在模型层被拒绝. consume 也拒绝批准它的活动 分类账不退( e)unbacked_approval) (中文(简体) ).

权限

粘贴赠款
每发子弹决定这种要求.
approvals.cancel-any取消别人的待决请求.
approvals.manage-policy撰写租户政策(仅限人).

发展

pnpm --filter @happyvertical/smrt-approvals test
pnpm --filter @happyvertical/smrt-approvals typecheck
pnpm --filter @happyvertical/smrt-approvals test:postgres

见 一般事务人员(其他职等) 财务报告和审定财务报表 代理人/核准人 设计变化无常.

许可证

麻省理工学院

可选的自我核准

设定 selfApprovalPermission: 'content.approve-self' 内 defineApprovalKind 改为 允许人类请求者持有那颗子弹 和所有正常的决定权限 批准、拒绝或请求根据自己的请求修改。 让它保留 默认 self_approval 拒绝。 自我决定记录 selfApproved: true 财务报告和审定财务报表 selfApprovalPermission 它的永恒事件。 其批准数为一票 并且可以正常消费;更大的法定人数仍然需要其他人类. 在运行新活动栏前为两个新活动栏部署明确的迁移 服务。 现有无标记的自我事件不算数. 记录表决 授权,如果许可随后改变,就像普通的批准一样.

版本与发布记录

@happyvertical/smrt-approvals 共发布 103 个版本,首次发布于 2026/10/15;过去 12 个月发布了 103 个版本。

版本发布日期距今
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-approvals 的常见问题

@happyvertical/smrt-approvals 是什么?

SMRT框架的批准决定门:有修订约束的单一用途核准,且达到法定人数,到期,以及仅附加事件分类账

如何安装 @happyvertical/smrt-approvals?

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

@happyvertical/smrt-approvals 支持 TypeScript 吗?

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

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

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

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

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

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

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

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

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