@adatechnology/module-http

中文文档
0.1.1发布于 2026/09/04MITTypeScriptESM + CJS近 30 天下载 2633

Framework-agnostic HTTP layer for pluggable modules — declarative route table, fetch and uWebSockets adapters, OpenAPI generation

原始使用文档
文档目录8 节
  1. Instalação
  2. Declarar rotas
  3. Montar
  4. O que o despachante faz por você
  5. SSE
  6. Armadilhas do uWS que o adaptador encapsula
  7. Testar os dois adaptadores
  8. Licença

@adatechnology/module-http

Camada HTTP compartilhada pelos módulos plugáveis. Rota é dado, não código: o módulo declara uma tabela sem nenhum tipo de framework, e dela saem três consumidores que por construção não divergem — adaptador fetch, adaptador uWebSockets e paths OpenAPI.

Nasceu extraído do notification-module quando o catalog-module precisou do mesmo encanamento.

Instalação

bun add @adatechnology/module-http

uWebSockets.js é peer opcional — só quem importa /uws precisa dele.

Declarar rotas

import type { ModuleRoute } from '@adatechnology/module-http'

const routes: ModuleRoute[] = [
  {
    method: 'GET',
    path: '/products/:id',
    scope: 'admin',
    operationId: 'getProduct',
    summary: 'Detalhe de um produto',
    async handler(context) {
      const product = await getProduct(context.auth!.companyId, context.params.id!)
      return { kind: 'json', status: 200, body: { data: product } }
    },
  },
]

Montar

// Bun.serve, Hono, router próprio
import { createModuleFetchRouter } from '@adatechnology/module-http/fetch'
const http = createModuleFetchRouter({ routes, basePath: '/v1', authResolver })
if (http.match(request)) return http.handle(request)

// uWebSockets.js
import { mountModuleRoutes } from '@adatechnology/module-http/uws'
mountModuleRoutes({ app, routes, basePath: '/v1', authResolver })

O que o despachante faz por você

Casa a rota, valida body/query com zod, resolve identidade, checa escopo, chama o handler e converte exceção em resposta. Os adaptadores só traduzem transporte — é o que torna o teste de contrato compartilhado possível e impede os dois de divergirem.

  • 401 sem identidade, 403 com identidade e sem escopo — a distinção diz ao cliente se ele faz login ou pede acesso
  • ZodError vira 400 com todos os problemas de uma vez
  • Erro desconhecido vira 500 genérico, sem stack para o cliente
  • details do erro de domínio fica no log, nunca na resposta

Erro de domínio é reconhecido pela forma ({ statusCode, code, message }), não por instanceof — cada módulo tem hierarquia autocontida, e checar por herança inverteria a direção da dependência.

SSE

return {
  kind: 'stream',
  heartbeatSeconds: 25,
  async subscribe(emit) {
    emit({ event: 'unread-count', data: JSON.stringify({ count }) })
    return { close: () => {} }
  },
}

⚠️ O idleTimeout do Bun.serve precisa ser MAIOR que o heartbeat. Menor, a conexão morre antes do primeiro batimento e a tela mostra dado velho sem erro nenhum.

Armadilhas do uWS que o adaptador encapsula

  1. res fica inválido após o abort — onAborted marca a flag antes de qualquer escrita assíncrona
  2. Todo req é lido síncrono, antes do primeiro await; depois o objeto é reciclado
  3. O ArrayBuffer do onData é reaproveitado no chunk seguinte — daí a cópia
  4. Escrita fora de cork() gera um pacote de rede por chamada

Testar os dois adaptadores

import { createUwsHarness } from '@adatechnology/module-http/testing'

Dublê do uWS que não exige o addon instalado.

Licença

MIT © Ada Technology

版本与发布记录

@adatechnology/module-http 共发布 5 个版本,首次发布于 2026/08/04;过去 12 个月发布了 5 个版本。

版本发布日期距今
0.1.1latest2026/09/042 个月前
0.1.02026/09/022 个月前
0.1.0-rc.3rc2026/08/192 个月前
0.1.0-rc.22026/08/182 个月前
0.1.0-rc.12026/08/043 个月前

关于 @adatechnology/module-http 的常见问题

@adatechnology/module-http 是什么?

Framework-agnostic HTTP layer for pluggable modules — declarative route table, fetch and uWebSockets adapters, OpenAPI generation

如何安装 @adatechnology/module-http?

在项目目录运行 npm install @adatechnology/module-http,或使用 pnpm add / yarn add / bun add。

@adatechnology/module-http 支持 TypeScript 吗?

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

@adatechnology/module-http 支持 ESM 还是 CommonJS?

同时提供 ES Module 与 CommonJS 入口,import 和 require() 都可以使用,打包工具会自动选择合适的版本。

@adatechnology/module-http 可以商用吗?

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

@adatechnology/module-http 的下载量有多少?

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

@adatechnology/module-http 还在维护吗?

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