@flop-labs/contracts

中文文档
0.1.2发布于 2026/11/08MIT OR Apache-2.0TypeScriptES Module零依赖近 30 天下载 2960

为FLOP的公开推断生成的结构合同 HTTP API

中文使用文档

@flop-labs/ 合同

结构类型、JSON Schema出口和FLOP的断言验证器 大众HTTP API. 0.1.0版本覆盖 listModels, (中文(简体) ), getModel还有JSON createChatCompletion 有效载荷和流出框架 services/rest-gateway/openapi.yaml。 。 。 . 未放出地表还包括精确的ID证书收件查询.

npm install @flop-labs/contracts
import { assertModelList, type ModelList } from "@flop-labs/contracts";

const response = await fetch("https://api.flop.network/v1/models");
const value: unknown = await response.json();
assertModelList(value);
const models: ModelList = value;

输出 : Model, (中文(简体) ), ModelList (另见: ModelListResponse, (中文(简体) ), ModelResponse, (中文(简体) ), ChatCompletionRequest, (中文(简体) ), ChatCompletionResponse, (中文(简体) ), ChatCompletionChunk,以及 ChatCompletionStreamError; 它们的 assert* 函数 财务报告和审定财务报表 *Schema 对象。 无效的数据抛出 ContractValidationError; 其内容 包含合同名称,从不包含提交的值.

CredentialReceipt, (中文(简体) ), CredentialReceiptError 财务报告和审定财务报表 CredentialReceiptRequestId (单位:千美元) 导出 assert* 函数和 *Schema 对象,从 GET /keys/me/receipts/{request_id}收据是当前范围分类账观察; 它不会重写原完成检查站。 精确终端分配 使用情况 settled_spend_raw 原始 FLOP 单元中的十进制字符串(10^18 生= 1 FLOP). 无法获取的值仍然是无效的 。 集合频道事件不是单独支付 或为每个请求烧掉交易。 参见客户的康复 实例权威, 状态、保留和手动重放规则.

验证检查结构,无胁迫、默认插入或删除 字段。 答复允许延期,包括收货证据,与 源计划允许。 验证信封不能验证其证据, 核实收据,或确定结算/结算。 请求验证如下 aPI计划. ChatCompletionStreamUsage 财务报告和审定财务报表 ChatCompletionToolCallFragment 也有种类, assert* 函数和 *Schema 对象. assertChatCompletionStreamError 带式封面 经纪人出错(包括估计用法和重试提示),会话过期,以及 收到调节失败; 它不验证任意的 HTTP 错误机构 .

OpenAPI 3.1 将SSE 线体作为字符串和参考解码数据计划模型 结束 x-sse-data-schema文字 [DONE] 是一个框架监视器而不是 a JSON块。 结构断言验证单个框架; @flop-labs/client 进一步强制执行命令、身份一致性、完整的工具调用组装, 还有终极行为. 估计错误的使用不会通过验证而成为收款证据.

公布的无害环境管理软件包没有运行时间依赖性。 类型生成方式 json-schema-to-typescript; AJV 生成独立的 JSON Schema 2020-12 验证符。 如果验证器开始需要运行时的助手, 生成失败 , 所以计划改变不能无声地引入依赖性.

从寄存器根 :

pnpm --filter @flop-labs/contracts generate
pnpm --filter @flop-labs/contracts check:generated
pnpm --filter @flop-labs/contracts build
pnpm --filter @flop-labs/contracts test

生成的文件会被检查进去 。 编辑 Cononical OpenAPI 计划,再生, 并共同审查其对消费者的影响。 Schema 身份和软件包 版本描述此合同文物; 它们不维护服务器或运行时间 兼容性.

版本与发布记录

@flop-labs/contracts 共发布 3 个版本,首次发布于 2026/10/29;过去 12 个月发布了 3 个版本。

版本发布日期距今
0.1.2latest2026/11/087 天前
0.1.12026/10/2917 天前
0.0.0-stage2026/10/2917 天前

关于 @flop-labs/contracts 的常见问题

@flop-labs/contracts 是什么?

为FLOP的公开推断生成的结构合同 HTTP API

如何安装 @flop-labs/contracts?

在项目目录运行 npm install @flop-labs/contracts,或使用 pnpm add / yarn add / bun add。

@flop-labs/contracts 支持 TypeScript 吗?

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

@flop-labs/contracts 支持 ESM 还是 CommonJS?

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

@flop-labs/contracts 需要什么版本的 Node.js?

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

@flop-labs/contracts 可以商用吗?

@flop-labs/contracts 使用 MIT OR Apache-2.0 许可。可在 MIT、Apache-2.0 中任选其一遵守。选择 MIT 时,宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@flop-labs/contracts 的下载量有多少?

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

@flop-labs/contracts 还在维护吗?

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