@happyvertical/smrt-prompts

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

输入 SMRT 的即时登记、超解和租户意识即时设置

中文使用文档
文档目录9 节
  1. 安装
  2. 快开始
  3. 这个软件包提供了什么
  4. 生成的表面
  5. 管理 UI
  6. 消费者食谱
  7. 消费者仍然拥有的
  8. 快速密钥是持续存在的标识符
  9. 文档

@ happyvertical/ smrt- promps( 欢快快快快快快快快快快快快快快快快快快快快快快快快快快快快快快快快快快快快快快快快快快快快快快快快快快快快快快快快快快快快快快快快快快快快快快快快快快快快快快快快快快快快快快快快快快快快快快快快快快快快快快快快快快快快快快快快快快快快快快快快快快快快快快快快快快快快快快快快快快快快快快快快快快快快快快快快快快快快快快快快快快快快快快快快快快快快快快快快快快快快快快快快快快快快快快快快快快快快快快快快快快快快快快快快快快快快快快快快快快快快快快快快快快快快快快快快快快快快

输入了即时定义, 租户意识即时超标, 运行时间即时解析 s -m -r -t 应用程序 .

安装

pnpm add @happyvertical/smrt-prompts

快开始

import { definePrompt, resolvePrompt } from '@happyvertical/smrt-prompts';

// 1. Register a prompt's defaults at startup
definePrompt({
  key: 'projects.issue.incorporateFeedback',
  template: 'Rewrite the issue body incorporating this feedback: {feedback}',
  ai: {
    // An inference tier (`cheap | good | great | best | auto`) or a profile
    // named in config. With no `inference` config every tier runs on the
    // app's configured AI client.
    profile: 'great',
    params: { temperature: 0.4 },
  },
});

// 2. Resolve at runtime (auto-uses tenant context from AsyncLocalStorage)
const resolved = await resolvePrompt('projects.issue.incorporateFeedback', {
  vars: { feedback: '...' },
});

// resolved.template — the merged template with overrides applied
// resolved.ai     — the merged AI configuration (profile, model, params)

这个软件包提供了什么

  • definePrompt() 在全球进程登记册中立即进行编码登记
  • resolvePrompt() 分层解析:代码默认 / 配置上覆盖 / 存储的应用程序上覆盖 / 存储的租户上覆盖 / 运行时间上覆盖
  • PromptOverride ——应用级和租户级快速设置模型,存储于 _smrt_prompt_overrides
  • PromptOverrideService 编号 : PromptSettingsService ——管理屏幕的已授权写入路径和读/写助手(见下文"管理UI")
  • 命名的 AI 配置文件 装入自 packages.prompts 配置 – 在配置中提示选择配置名, 配置解析到提供者/ 模式
  • 跟踪呼吁和努力 ——每个型号呼叫都带有一个即时键: trackedPromptCall(resolved) 将解析结果变成核心跟踪客户端的论据 ai: { effort } 设置提示的推理努力( e)low 改为 max概念: AI 运行
  • TTL 缓存 键 (key, tenantId),在覆盖保存/删除时无效

Stored 覆盖支持部分字段,因此应用程序只能覆盖模板,配置文件,模型,或者AI params,而无需formod 剩下的快取.

生成的表面

PromptOverride 拥有生成的REST航道、MCP工具和CLI的船舶 关闭命令( e)api: false, (中文(简体) ), cli: false, (中文(简体) ), mcp: false) (中文(简体) ). 覆盖行为 每个范围的授权状态,所以只从服务器代码写入 结束 PromptOverrideService,它要求授权人 您绑定 当前调用器在每次写入和失败之前 :

const service = new PromptOverrideService(overrides, (request) =>
  request.scopeType === 'tenant' && request.scopeId === session.tenantId &&
  session.permissions.has('prompts.manage'),
);
await service.setTemplateOverride(key, 'tenant', session.tenantId, 'New text.');

管理 UI

软件包将设置屏幕传送到如此耗用应用程序的屏幕上,不是每个程序重建 内容: PromptSettingsService (根导出) 产生行,和 PromptSettingsPanel (单位:千美元) ./svelte 子路径)让他们。 根导出 保持Svelte免费,所以只有服务器的消费者不会受到影响; svelte 是一个 可选对等依赖.

消费者食谱

1. 在代码中登记提示 (见上文快速启动),包括 editable 如果您希望租户或整个应用程序的默认值是压倒性的:

definePrompt({
  key: 'projects.issue.incorporateFeedback',
  template: 'Rewrite the issue body incorporating this feedback: {feedback}',
  description: 'Rewrites an issue body from reviewer feedback.',
  editable: { template: true },
});

2. 装入服务器载荷中的行. 负载在哪里  权限 检查生命——该包没有做出授权决定:

// src/routes/settings/prompts/+page.server.ts
export async function load(event) {
  const auth = requirePermission(event, APP_PERMISSIONS.tenantAdmin);
  const settings = await PromptSettingsService.create({ db });
  return {
    tenantId: auth.tenantId,
    prompts: await settings.listPromptSettings({ tenantId: auth.tenantId }),
  };
}

listPromptSettings() 返回一个 PromptSettingsRow 按登记人数计算 键 — 被请求租户的有效模板, 原始覆盖文本 每个范围appTemplate编号 :tenantTemplate),什么是回溯每个范围 生产(appDefaultTemplate编号 :inheritedTemplate),以及 supplyingLevel编辑 线条结构可以分配到面板上 PromptSettingsView,所以没有 需要绘制地图.

3. 小组:

<script lang="ts">
  import { PromptSettingsPanel } from '@happyvertical/smrt-prompts/svelte';
  let { data, form } = $props();
</script>

<PromptSettingsPanel
  prompts={data.prompts}
  contextKey={data.tenantId}
  formAction="?/savePrompt"
  message={form?.message}
  error={form?.error}
/>

面板是演示式的:它取出行和回调,不取出任何内容 授权什么。 每行生成密钥、描述、有效文本和 哪个级别提供了它, 加上租户范围的复选框+文本编辑器 (和,何时) showApp编号 :appEditable 设定了应用范围。 未检查框 返回范围——旁边的预览文本确切显示返回的内容 生产。 供应 onSave 改为 formAction 从客户端驱动它 处理者.

4. 使用您本人的许可检查连接写作. setPromptOverride() 拒绝任何没有定义的密钥以及定义中的任何字段 editable 配置不允许,然后代表 PromptOverrideService,哪个 询问您的授权人并关闭失败 :

export const actions = {
  savePrompt: async (event) => {
    const auth = requirePermission(event, APP_PERMISSIONS.tenantAdmin);
    const form = await event.request.formData();
    const settings = await PromptSettingsService.create(
      { db },
      {
        // Your decision, bound to this caller. Returning anything but `true` denies.
        authorize: (request) =>
          request.scopeType === 'tenant' && request.scopeId === auth.tenantId,
      },
    );

    try {
      await settings.setTenantPromptOverride(
        String(form.get('key') ?? ''),
        auth.tenantId,
        form.has('tenantOverride') ? String(form.get('tenantTemplate') ?? '') : null,
      );
    } catch (error) {
      if (error instanceof UnknownPromptKeyError) return fail(400, { error: 'Unknown prompt.' });
      if (error instanceof PromptFieldNotEditableError) return fail(400, { error: 'Not editable.' });
      if (error instanceof InvalidPromptScopeError) return fail(400, { error: 'Invalid scope.' });
      if (error instanceof PromptOverrideAuthorizationError) return fail(403, { error: 'Not permitted.' });
      throw error;
    }
    return { message: 'Prompt overrides saved.' };
  },
};

构建服务 无 a 一个 authorize 选项 只读 : 每封信都无法关闭 PromptOverrideAuthorizationError。这是一个负载的正确形状 函数.

消费者仍然拥有的

  • 路线、导航条目和页壳;
  • 允许检查负载和动作;
  • 页:1 authorize 回调( 此软件包从未决定谁可以写入 ) ;
  • 解决会话 tenantId URL或表格中的租户身份 字段是一个选择器,而不是授权;
  • 以 definePrompt() 启动时.

快速密钥是持续存在的标识符

覆盖按精确键存储 key 字符串并以此解决 运行时的字符串 . 重命名一个关键孤儿, (中文(简体) ), 默不作声地将所有租户恢复到登记默认状态——变化看起来 在diff中无害, 并显示为快速文本神秘地重置。 处理a 键为不可移动的已运出。 重命名需要重写的数据迁移 _smrt_prompt_overrides.key,而不是编辑.

文档

版本与发布记录

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

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

@happyvertical/smrt-prompts 是什么?

输入 SMRT 的即时登记、超解和租户意识即时设置

如何安装 @happyvertical/smrt-prompts?

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

@happyvertical/smrt-prompts 支持 TypeScript 吗?

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

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

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

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

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

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

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

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

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