@eco-foundation/eco-message-contracts (英语)

信息信封, defineContract(),以及Eco的AMQP的活式跨服务有效载荷计划 公交车. 无AMQP依赖性 ——如果只需要定义,发布形状,或 分析合同。 运输在 @eco-foundation/eco-messaging,哪个 宣布此软件包为对等点 .

pnpm add @eco-foundation/eco-message-contracts

要求数 zod (单位:千美元)^3.25 || ^4)作同业相. 说明 3.25 楼层:一个宣告更老范围的服务 即使其锁文件已经解决了更新的问题,也必须提高声明范围.

合约是什么

合同将有效载荷计划与其路线、确定性特性及其出版联系在一起 因此,这四个事实不能在共享活动的各种服务中分道扬镳.

import * as z from 'zod/v4';
import { defineContract } from '@eco-foundation/eco-message-contracts';

export const InventorySnapshot = defineContract({
  eventType: 'inventory.snapshot',
  routingKey: 'inventory.snapshot',
  bindingPattern: 'inventory.snapshot',
  schema: z.object({
    aggregateId: z.string().min(1),
    snapshotVersion: z.number().int().nonnegative(),
    actualBalance: z.string(), // decimal amount in base units, as a string wire type
  }),
  schemaVersion: 1,
  // Deterministic identity: the SAME logical event always resolves to the same messageId,
  // which is what makes an outbox retry safe rather than a duplicate.
  identity: (p) => `${p.aggregateId}:${p.snapshotVersion}`,
  // Optional: enforce apply-in-order-within-scope. A stale or out-of-order redelivery is
  // rejected before the handler runs, rather than being left to regress state.
  ordering: {
    field: 'snapshotVersion',
    version: (p) => p.snapshotVersion,
    scope: (p) => p.aggregateId,
  },
  delivery: 'required',
});

delivery 可能是静态的或依赖有效载荷的,以及 resolvePublicationPolicy(validatedPayload) 实值 单项录取决定由此产生. A 类 required 合同还必须声明 durability: 'caller-ledger' 直接出版——否则在达到 任何呼叫站点都能悄悄绕过 并不是一条规则.

已宣布的字段名称被验证为针对计划 定义时间输入一个字 digestExcludes 或一个 ordering.field 不存在的是模块负载失败,而不是 沉默无效的声明.

每个静态路由键也被曝光为 routingKeyTemplate。对于出自有效载荷的密钥,添加一个 明确模板,例如 <chainId>.inventory.snapshot;内置目录需要用于 每份合同并公布在生成的 计划索引中,用于兼容性检查.

那个信封

buildEnvelope, (中文(简体) ), readEnvelope, (中文(简体) ), envelopeToHeaders,则 ENVELOPE_HEADERS 常数是 犬形信封表面。 每个消息都包含一个消息ID,因果关系和关联ID,事件 类型、 schema 版本、 源服务、 尝试计数和 W3C 上下文.

readEnvelope 返回受到歧视的结果,而不是扔出,所以一个不正确的信封是一个 价值是消费者可以故意停车,而不是在热路中例外.

现场合同

9艘合同船与包裹一起出口 ALL_CONTRACTS 和描述 BALANCE_EVENTS_CATALOG (其中记录了每个公司的生产者和消费者,所以目录回答: "如果我改变这个,谁打破" 没有代码搜索:

结算-风险合同签有不可改变的观察;其版本的内在语义和身份语义都包含在计分索引和相容性门中. 共享的有效/无效矢量导出于 @eco-foundation/eco-message-contracts/fixtures/fulfilled-unproven-v1。 。 。 .

拆卸有效载荷版本

断开版本使用真实的解析器,而不是标题允许列表. 定义每个历史计划 defineVersionAdapter(schema, upcast) 下级 legacyVersions;消费者打电话 parseVersion(envelope.schemaVersion, body) 处理器只接收峡谷电流形状.

payloadDigest

payloadDigest(contract, payload) 答案是:"这个出版物是否包含任何消费者可以实际 ”——对于一个其版本凸起是无条件的,否则会重新产生a的生产者来说 新版本下的终端快照。 以下列方式宣布不适用: digestExcludes, (中文(简体) ), 应用于 仅为根,则数组从不排序(顺序是身份的一部分)。 数值 JSON 无法忠实地代表自己,却被拒绝走一条令人发指的道路,而不是默默地抹去.

非TypeScript消费者

油球船的版本,语言中立的JSON Schema文物, 所以服务另一种语言 针入已公布的软件包(或卖出文件),而不是重新执行方案:

• @eco-foundation/eco-message-contracts/schema → schema/generated/index.json,合同和 带有 per-verse schema 路径的信封索引.
• @eco-foundation/eco-message-contracts/conformance • 机器可读符合条款 AMQP有线映射,并重放验证的送出载体.

这些阴谋是故意的 别 拒绝未知字段:消费者必须容忍添加字段 新制作人,所以验证不是一个相容性陷阱.

文档

这些包是标准的参考执行,而不是其定义. 定义 是非 TypeScript 服务可以针对的两种语言不可知文档——读取它们 在更改信封头、 队列地貌、 和解语义、 或持久出版规则之前 :

• 信使符合配置 ——电线和消费者.
• 推前坚持和还水 ——制片人.
• 合同的改版和所有权 ——使有效载荷需要变化,以及消费者首先推出的订单.
• 仓库读取器 安装矩阵、对等范围,以及 完整的交通指南.

变化在 变动情况。 。 。 .