@comms-id/relay

中文文档
0.1.0发布于 2026/10/03SEE LICENSE IN LICENSETypeScriptES Module零依赖

Server relay for Comms.ID products: your backend forwards your own users' requests, signed as your registered app

此软件包已被标记为弃用

Removed. Use public visitor mode: the pk attribute on each Comms.ID live element (cdn.comms.id/<product>/latest.js). Nothing to install.

原始使用文档

@comms-id/relay

Forward your own users' requests to a Comms.ID product from your own server. Your server signs each call as your registered app, so the browser never holds a credential.

// app/api/comms-id/[product]/[operation]/route.ts (Next.js)
import { createNextRelay } from "@comms-id/relay/next";
import { addressProduct } from "@comms-id/address/descriptor";

export const { POST } = createNextRelay({
  products: [addressProduct],
  // Your rule: who may use this route. Return true, false (401), or your own Response.
  allow: async (request) => isSignedIn(request),
  signer,
});
// Hono
import { relayHandler } from "@comms-id/relay/hono";

app.post("/comms-id/:product/:operation", relayHandler({ products: [addressProduct], allow, signer }));

The relay reaches only the operations that your product descriptors list. It does not forward any other path, and it does not send your users' cookies or Authorization header to Comms.ID.

Proprietary software; see LICENSE.

版本与发布记录

@comms-id/relay 共发布 1 个版本,首次发布于 2026/10/03;过去 12 个月发布了 1 个版本。

版本发布日期距今
0.1.0latest2026/10/031 个月前

关于 @comms-id/relay 的常见问题

@comms-id/relay 是什么?

通信的服务器中继。ID产品:你的后端转发你自己的用户请求,作为你注册的应用程序签名注意:该包已被作者标记为弃用——Removed. Use public visitor mode: the pk attribute on each Comms.ID live element (cdn.comms.id/<product>/latest.js). Nothing to install.

如何安装 @comms-id/relay?

在项目目录运行 npm install @comms-id/relay,或使用 pnpm add / yarn add / bun add。

@comms-id/relay 支持 TypeScript 吗?

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

@comms-id/relay 支持 ESM 还是 CommonJS?

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

@comms-id/relay 可以商用吗?

@comms-id/relay 使用 SEE LICENSE IN LICENSE 许可。许可条款写在包内的独立文件中,请阅读该文件确认可否商用。以上为概括,不构成法律意见,请以许可原文为准。

@comms-id/relay 还在维护吗?

最新版本 0.1.0 发布于 2026/10/03(1 个月前);至今共发布 1 个版本,其中过去 12 个月发布了 1 个;首次发布于 2026/10/03。作者已将其标记为弃用,新项目建议寻找替代方案。