@gate-forge/http-contract

中文文档
0.19.2发布于 2026/11/10Apache-2.0TypeScriptES Module构建来源已验证近 30 天下载 2977

Framework-neutral canonical HTTP contract: HttpContractFact schema, typed block codes, path/method normalization, and the deterministic frontend-call <-> server-route join engine (ADR 0004 D1-D4).

原始使用文档
文档目录3 节
  1. Contract facts
  2. Canonical normalization (ADR 0004 D2)
  3. Join engine (ADR 0004 D3, phase 3 literal precedence)

@gate-forge/http-contract

Framework-neutral canonical HTTP contract for Gateforge (ADR 0004): the strict HttpContractFact schema, typed outcome codes, canonical path/method normalization, and the deterministic frontend-call ↔ server-route join engine.

This package owns no framework parsing (detector packs own that) and no classification (@gate-forge/core owns that). Every export is a pure function; identical inputs produce byte-identical outputs under any input permutation.

Contract facts

A fact is one discovered HTTP surface, serialized by detector packs as GPP/3 resources of kind http.contract (evidence-only; never classified directly, never a business resource):

interface HttpContractFact {
  schemaVersion: 1;
  role: 'server-route' | 'frontend-call';
  method: 'GET'|'HEAD'|'POST'|'PUT'|'PATCH'|'DELETE'|'OPTIONS'|'ANY';
  normalizedPath: string;   // canonical positional form
  rawPath: string;          // exactly as written in source
  framework: string;        // 'fastapi' | 'fetch' | 'axios' | ...
  handlerSymbol?: string;   // server routes
  requestSchemaSymbols?: string[];
  responseSchemaSymbols?: string[];
  callsites?: string[];     // frontend calls
  source: { file: string; line: number; col: number };
}

Canonical normalization (ADR 0004 D2)

normalizeHttpPath strips query/fragment, collapses slashes, converts ${expr} and FastAPI {name} / {name:type} to {}, {name:path} converters and * catch-alls to {*}, and canonicalizes absolute URLs only for configured same-origin hosts. Parameter names are never part of an identity. Unresolvable shapes return HTTP_PATH_DYNAMIC — never a guess.

normalizeHttpMethod uppercases concrete verbs and returns null for dynamic methods (callers must emit HTTP_METHOD_DYNAMIC; defaulting to GET is forbidden).

Join engine (ADR 0004 D3, phase 3 literal precedence)

joinFrontendCalls(routes, calls) implements exactly-one cardinality: equal method, equal segment count, position-wise match where a frontend {} matches any single route segment and a route {*} matches one or more trailing segments.

Candidates are then partitioned by match quality before the exactly-one check (literal precedence): a match is literal when it consumed no slot generality — every position is exact segment equality, counting a route {} mirrored by the call's own {} — and parameter otherwise (route {} absorbing a call literal, a call {} relaxed onto a route literal, or any {*} absorption; a wildcard match is never literal). If any literal matches exist they are THE candidates; parameter-only matches are considered only when zero literal matches exist.

Why: routers resolve literal path segments before parameterized ones at runtime (FastAPI included), so /messages/search never reaches /messages/{} with id="search". The static join mirrors that runtime truth: a template call /messages/${id} joins /messages/{} despite literal siblings, and a literal call joins the literal route.

Zero matches → FRONTEND_ROUTE_UNWIRED; more than one distinct surviving candidate (in either tier) → FRONTEND_ROUTE_AMBIGUOUS. There is no scoring and no first-match-wins beyond the documented partition. Duplicate identical routes collapse into one endpoint carrying every source.

版本与发布记录

@gate-forge/http-contract 共发布 46 个版本,首次发布于 2026/09/17;过去 12 个月发布了 46 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
0.19.2latest2026/11/105 天前
0.19.12026/11/106 天前
0.19.02026/10/2917 天前
0.18.32026/10/2522 天前
0.18.22026/10/2125 天前
0.18.12026/10/2125 天前

关于 @gate-forge/http-contract 的常见问题

@gate-forge/http-contract 是什么?

Framework-neutral canonical HTTP contract: HttpContractFact schema, typed block codes, path/method normalization, and the deterministic frontend-call <-> server-route join engine (ADR 0004 D1-D4).

如何安装 @gate-forge/http-contract?

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

@gate-forge/http-contract 支持 TypeScript 吗?

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

@gate-forge/http-contract 支持 ESM 还是 CommonJS?

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

@gate-forge/http-contract 需要什么版本的 Node.js?

package.json 的 engines 字段要求 Node.js >=20。版本不符时 npm 默认只给出警告,开启 engine-strict 后会拒绝安装。

@gate-forge/http-contract 可以商用吗?

@gate-forge/http-contract 使用 Apache-2.0 许可。宽松许可:允许商业使用、修改和再分发,并附带明确的专利授权;分发时需保留许可与 NOTICE 文件,修改过的文件要注明改动。以上为概括,不构成法律意见,请以许可原文为准。

@gate-forge/http-contract 的下载量有多少?

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

@gate-forge/http-contract 还在维护吗?

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