门洞

@botiverse/porthole: 显示 HTML 代理写( 部件、 整页、 MCP Apps 视图) 在你的应用程序里,安全。 一个配置给框架 其隔离,它的CSP, 一个主题外壳 它可能调用的主机函数( 每一个在门后) , 您的代理读取的手册 .

npm install @botiverse/porthole

节点24或后起,或云花工. 浏览器部分是纯 ES 模块,没有 依赖关系(捆绑或服务) dist/ 带有导入地图:docs/ADOPting.md 第4节.

显示内容的两种方式

• 不透明,在页面中. 不需要服务器: 内容运行在一个不透明的沙箱框架 源代码。 对于对话中的部件.
• 服务,以自己的出身. 每个页面,或每个对话的部件,都有来源 喜欢 a-<id>.example-usercontent.com,这样它就可以保持存储,打开 在干净的地址在一个 新建标签, 仅由您的应用程序设置 。 东道主工具包(createContentHost)是服务器侧; 您的应用程序只写它的政策: 哪些页面存在, 哪些人可能看到它们 .

两分钟内试试看

软件包装了一个完整的应用程序, 同样的代码在节点和工人:

PORTHOLE_SECRET=$(npx porthole secret) node node_modules/@botiverse/porthole/examples/node/server.mjs
# open http://localhost:8790: a stored page, served on http://a-hello.content.localhost:8790

• examples/app.mjs: app(政策,路线,页面),运行时间不可知.
• examples/node/server.mjs (单位:千美元)nodeServer, (中文(简体) ), examples/workers/ (单位:千美元)contentHostFor,带有D1 移徙和移徙 wrangler.jsonc) (中文(简体) ).
• examples/conformance/:Porthole的相容套房逆向运行,在三台发动机上.
• examples/mcp/server.mjs:代理工具(显示,引导,检查)作为MCP服务器.

最小的不透明显示

import { createHost, presets } from "@botiverse/porthole";

const host = createHost(presets.inlineWidget());
const display = host.mount(document.getElementById("widget"), {
  displayId: "w1",
  title: "A chart",
  scheme: "light",
});
display.setContent("<p>Hello from an agent</p>");

在反应中 : <PortholeProvider> 周围 <PortholeFrame config displayId title scheme content /> 从 @botiverse/porthole/react。 。 。 .

由许多文件制成的页面

已送达的页面可能带有自己的文件: 构建的输出、 带有图像的报告、 a 读取其数据的仪表板(0.6). 商店按路径回答一个表和字节 页面的相对地址是自己的版本:

source: async (id, version) => ({
  files: { "index.html": { size: 397, sha256: "…" }, "assets/app.js": { size: 142870, sha256: "…" } },
  read: (path) => myStore.bytes(id, version, path),        // Uint8Array or a stream, whole
}),
entry: {
  // "/v/3/<file>" is version 3, any other path the latest's: answer with the version's own address.
  at: async (scope, path) => {
    const at = versionedAddress(path), version = at?.version ?? (await latestOf(scope));
    return at && { instance: pageOf(scope, version), base: versionBase(version), file: at.file, pinned: true };
  },
},

每个文件只从清单中提供 由Porthole自己的表格输入, nosniff,带有CSP 打开了这个版本的路径,没有其他来源; checkFileSet 检查一个版本 出版时的路径和限制, lintFiles 财务报告和审定财务报表 checkPage({ files }) 是经纪人的 边 docs/ADOPTING.md §由许多文件所制成的页面.

作为应用程序的一页:能力运行时间

与 runtime: "1" 在其配置(0.7)中,一个页面通过一个全球地址到达其主机,因为 及其查看器级别允许的:

const db = await porthole.use("db");                 // a frozen namespace, or null: draw without it
const votes = db && (await db.query("votes")).docs;  // a refusal rejects with error.code and a sentence

主机保留服务:它的处理者(db, (中文(简体) ), artifact, (中文(简体) ), assets, (中文(简体) ), comments· ; user 这是 观者, declareCapabilities 在出版时,观众的级别 在其访问 (单位:千美元)Grant.level),以及资产存储 /server 服务于 /_blob/<id>。 。 。 . defineRuntimeConformance 检查处理者。 类型: types/runtime/v1/*.d.ts.docs/Apping.md § 能力 运行时间.

经纪人得到什么

import { admitContent, checkTool, guideTool, showTool } from "@botiverse/porthole";

const tools = [showTool(config), guideTool(config), checkTool(config)]; // name, description, JSON Schema
const admitted = admitContent(config, html); // refuses only what certainly fails, saying what to change

checkPage (单位:千美元)@botiverse/porthole/check在电话和桌面上运行真实的沙盒中的一页 宽度,光和黑暗, 在别人看到它之前, 并告诉特工什么打破 在几行. examples/mcp/server.mjs 电线将工具作为 MCP 服务器.

下一个读取

• 文件/记录: 开始, 一步步: 服务器, 页面, 其 CSP,工人,地方发展,代理的工具,符合性,故障排除.
• 选择外出: 哪些内容可以装入(已关闭,库) CDN,来自任何https站点的被动介质,每个关卡打开什么,重新打开的风险.
• 文档/THREAT MODEL.md: 港洞保护的是什么,谁保护谁;每个港洞 使用,它保证什么, 剩下的给你,和没有覆盖.
• 文件/DESIGN.md:如何运作. 文件/决定.md为什么, 由P-数字(代码引用它们).

子路径

npx porthole secret 做一个秘密; npx porthole d1-schema 打印 D1 迁移.

阿帕奇2.0 (英语). /server 还提供下列文件的副本: 图.js 4.5.1(MIT)和 D3级 7.9.0 (ISC) 为活部件(P079),每个部件配有许可证 (单位:千美元)/__porthole/lib/<name>@<version>/从 src/libraries/files.generated.ts他们的警告, 和那些包 他们的文件捆绑 第三次议会 NoTICES.md。 。 。 .

发现弱点了吗? 私下报告,作为 警卫 说 从不公开 问题.