@happyvertical/smrt-comments

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

SMRT 应用程序的记录注释和引用钩

中文使用文档

@happyvertical/smrt-comments (英语)

租户范围多元形态记录评论,提及通知成分, 和浏览器安全 RecordComments Svelte组件.

使用 CommentService 使用可信任的服务器 { tenantId, userId } 演员 从经认证的会话和 authorizeRecord 调用。 回电 必须核实该记录是否属于该租户,并且该演员可以阅读 或评论它。 两者 create 财务报告和审定财务报表 listForRecord 要求作出该决定 身体不能凌驾于角色之上. CreateCommentInput 只有房客, 作者、记录类型/身份、身体、提及和可选 idempotencyKey。服务忽略了额外的运行时间 属性,生成其自己的UUID/slug,并插入一行新而无自然键 收养。 呼叫者提供的身份、上下文、数据库和构建器选项 永远无法坚持下去. CommentOptions 仍然是单独信任的模式 水分类型. 直接模型/收集API具有持久性 原始的可信任代码,而不是授权边界. 生成API,MCP, 并且CLI访问被禁用.

const comments = new CommentService({
  db,
  actor: { tenantId: session.tenantId, userId: session.userId },
  authorizeRecord: access => records.authorize(access),
  participation: {
    // Supplies trusted membership and entitlement facts.
    authorize: request => entitlements.authorize(request),
  },
  mentionNotifications: createCommentMentionNotifications({
    notifications: new UserNotificationService({ db }), // smrt-messages
    canNotify: mention => records.recipientMayRead(mention),
  }),
});

participation 是一个可选的服务器侧权限适配器。 它得到信任 身份、记录/行动投入和返回 { allowed, member?, snapshot? }。 。 。 . 仅字面 allowed: true 允许参与; members_only 还要求 member: true。每个新评论中保留了不可改变的 JSON 快照.

ParticipationService 拥有可重复使用的租户/目标政策选择、禁令和 原子固定窗率保留. 所有评论服务 创建引用它, 即使没有权利适配器。 配置 ParticipationPolicyCollection 财务报告和审定财务报表 ParticipationBanCollection 在下方可信任的行政服务器路径 withTenant;这些型号没有显示自动API/CLI/MCP操作. 迁移 所有注释包模型在部署前。 缺少策略默认打开; 准确 (recordType, recordId, action) 政策取代租户违约 (空白记录对. 模式为 open, (中文(简体) ), pre_moderated, (中文(简体) ), members_only, (中文(简体) ), closed。 。 。 . 重复适用的政策未能关闭。 禁令目标可能是空白的(整个租户) (a) 无效期满是指无限期。 禁止决定不披露理由.

maxActions: 0 禁用配额; 否则设置正整数 windowSeconds。 。 。 . 在协调世界时的固定时期,配额是每个租户、行动者、行动和选定的政策范围 窗口。 租户政策在记录上享有配额。 持续使用的柜台 受限制的原子突起; 保留和保护的突变发生或回滚 一起来 永不删除活动速率桶 。 政策编辑影响随后 检查, 而不是已经授权的交易; 更改窗口长度开始 a 新建配额命名空间 。 受信任的行政人员拥有政策和保留桶.

反应/弹出导入 ParticipationService 中性类型 @happyvertical/smrt-comments/participation启用 execute(request, (tx, decision) => mutationUsing(tx)) 为了一个新的突变。 在现有交易使用范围内 executeInTransaction(tx, request, callback) 并传播错误,所以所有者 倒地滚回. authorize 检查当前的许可而不需支出配额。 这个 消费者拥有其耐久的一能约束: 后再播放保留变异 重新授权和调用 execute 只是为了真正的新变异 评论 已执行此构成 。 这里没有订阅或新闻规则.

CommentService.edit 保留先前的机构并重新检查记录/参与许可, 禁止和同一交易中的评论-行动配额。 编辑支出配额和 保留时间后的原始快照. report 附上温和报告, 财务报告和审定财务报表 moderate 在更改前检查主机的记录级节制权限 可见度。 读者接受授权的预测; 主机过滤非可见行 他们的观众. ModerationQueue 接受待决/报告的预测和 onmoderate 调回; 浏览器不能授予节制权限 .

消息服务是通过结构界面组成的;没有 对消息的运行时间依赖 . canNotify 必须检查受援成员 在披露评论之前记录访问。 通知使用稳定的每个评论 源引用 适配器重放 。 上面提到的是UUID,它是被复制的, 并限于50;自觉不通知。 没有适配器表示没有通知. 单个注释插入前提及验证完成; 无效或超限 提到没有保留行。 注释在通知送达前被保存. 拒产假 所保存的注释。 与 idempotencyKey,重试 create 同样的钥匙 内容在不创建其他注释的情况下恢复发送。 没有钥匙, 重新装入并重试交付,而不是创建另一个注释. 组件提醒用户在讨论前刷新和检查 拒绝时,再次张贴。 交付和持久性是分开的,除非主机两者组成相同 外部交易。 见 一能创造 键 约束性、打字冲突、保留和交易要求.

导入 RecordComments 从 @happyvertical/smrt-comments/svelte核准出入证 评论预测,a onsubmit(body) 调用,和 a contextKey 包含 现任房客,演员和唱片身份。 随时改变密钥 这些身份变化:它清除了草稿/错误并忽略了过时的提交 已完成。 主机拥有加载,认证,提及选择和刷新. 组件会生成纯文本 . RecordCommentsRecipe 声明 comments.records 模拟食谱 comments 编目组. 这个 有意没有全球导航或部分:讨论需要 已经授权的父记录, 而通用注释列表将丢失 上下文。 主办方将其嵌入了记录细节页面. 目录帮助解释张贴 并提到没有保证 提取器或交货配置. 食谱宣布 runtime: both:记录组件运行在浏览器中, 运行在服务器上。 它的游乐场表面 出口 RecordCommentsPlayground,使用 仅在当地张贴. recordCommentsDemo 提供相同的样本预测 结束 demoSeed; 重新挂载预览。 没有发出通知. 没有路由、设置面板或 shell 部件: 没有能够提供授权的 父记录上下文。 由于主机的记录访问, 无法声明提供者 并提到政策是回调,而不是一个可选择的外部提供者.

验证 : pnpm --filter @happyvertical/smrt-comments test 覆盖 SQLite 和 DuckDB (英语). pnpm --filter @happyvertical/smrt-comments test:postgres 添加 PostgreSQL 使用存储器的可支配数据库包装和普通的CI角色.

密钥重置在保存存储时使用单独的罐装 租户和作者参考。 UUID 外壳在信任的演员背景中变化 重复使用相同的注释,包括在通用收件保留后。 未按键的遗产 SQLite 上市范围仍为原租户拼写;按键行被合并 使用同等的UUID租户,而不折叠任意的文字租户身份证.

行政政策/禁止租户、行为者和目标身份使用小写UUID; 请求的UUID在执行前是canonical化的. 文本标识符保留大小写 . 线索预测可能包括: parentCommentId; 供应 onreply(parentId, body) 允许回复作曲。 主机回调持续使用该父机代号回复.

当当前政策或应享权利时,编辑到可见的注释返回待决 需要预改;编辑时从未恢复隐藏或被删除的注释.

报告使用单独的 report 参与动作,所以主机可以配置 报告具体限制,而不将它们与配额挂钩。 禁令和应享权利 检查适用于每次报告尝试。 只有可见的评论是可报告的。 每个 演员/评论配对保留一份报告,包括在通用收据清理之后; 重审报告,而不消耗配额,也不取而代之.

无父母键创建文摘通过升级保存了原始v1形状. 在授权编辑后, 重新播放对照保留来验证原始创建机构 修改历史并返回当前注释; 编辑的内容不是新创建 载荷。 在保留按键注释时必须保留修订历史 .

提及发送仅限于可见的评论,包括按键回放. 待定, 隐藏和被删除的身体从没有到达提及适配器. 核准没有 自动发送通知; 主机可能明确重试原始按键 批准后创建以收回交货。 调和使用保存的生命周期 a 已锁定并重新装入的行,保留了已换行和缓存无效. 家长评论UUID在查取,坚持和重试散列之前,是可口的. 只回复嵌入器仅在选择回复目标时显示作曲者.

版本与发布记录

@happyvertical/smrt-comments 共发布 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-comments 的常见问题

@happyvertical/smrt-comments 是什么?

SMRT 应用程序的记录注释和引用钩

如何安装 @happyvertical/smrt-comments?

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

@happyvertical/smrt-comments 支持 TypeScript 吗?

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

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

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

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

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

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

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

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

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