{"id":51173246,"url":"https://github.com/btravstack/amqp-contract","last_synced_at":"2026-06-27T02:02:21.347Z","repository":{"id":328248540,"uuid":"1114794412","full_name":"btravstack/amqp-contract","owner":"btravstack","description":"Type-safe contracts for AMQP/RabbitMQ messaging with TypeScript","archived":false,"fork":false,"pushed_at":"2026-06-26T00:03:39.000Z","size":3085,"stargazers_count":18,"open_issues_count":6,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2026-06-26T00:14:45.728Z","etag":null,"topics":["amqp","amqplib","arktype","asyncapi","contract","messaging","nodejs","rabbitmq","schema","standard-schema","typescript","valibot","validation","zod"],"latest_commit_sha":null,"homepage":"https://btravstack.github.io/amqp-contract/","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/btravstack.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":"AGENTS.md","dco":null,"cla":null}},"created_at":"2025-12-11T22:32:32.000Z","updated_at":"2026-06-25T23:07:43.000Z","dependencies_parsed_at":"2026-05-03T19:01:57.997Z","dependency_job_id":null,"html_url":"https://github.com/btravstack/amqp-contract","commit_stats":null,"previous_names":["btravers/amqp-contract","btravstack/amqp-contract"],"tags_count":310,"template":false,"template_full_name":null,"purl":"pkg:github/btravstack/amqp-contract","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/btravstack%2Famqp-contract","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/btravstack%2Famqp-contract/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/btravstack%2Famqp-contract/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/btravstack%2Famqp-contract/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/btravstack","download_url":"https://codeload.github.com/btravstack/amqp-contract/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/btravstack%2Famqp-contract/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":34839005,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-06-27T02:00:06.362Z","response_time":126,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["amqp","amqplib","arktype","asyncapi","contract","messaging","nodejs","rabbitmq","schema","standard-schema","typescript","valibot","validation","zod"],"created_at":"2026-06-27T02:02:20.570Z","updated_at":"2026-06-27T02:02:21.337Z","avatar_url":"https://github.com/btravstack.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cdiv align=\"center\"\u003e\n\n# amqp-contract\n\n**Type-safe contracts for [AMQP](https://www.amqp.org/)/[RabbitMQ](https://www.rabbitmq.com/) messaging with [TypeScript](https://www.typescriptlang.org/)**\n\n[![CI](https://github.com/btravstack/amqp-contract/actions/workflows/ci.yml/badge.svg)](https://github.com/btravstack/amqp-contract/actions/workflows/ci.yml)\n[![npm version](https://img.shields.io/npm/v/@amqp-contract/contract.svg?logo=npm)](https://www.npmjs.com/package/@amqp-contract/contract)\n[![npm downloads](https://img.shields.io/npm/dm/@amqp-contract/contract.svg)](https://www.npmjs.com/package/@amqp-contract/contract)\n[![TypeScript](https://img.shields.io/badge/TypeScript-6.0-blue?logo=typescript)](https://www.typescriptlang.org/)\n[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)\n\n[**Documentation**](https://btravstack.github.io/amqp-contract) · [**Get Started**](https://btravstack.github.io/amqp-contract/guide/getting-started) · [**Examples**](https://btravstack.github.io/amqp-contract/examples/)\n\n\u003c/div\u003e\n\n## Why amqp-contract?\n\nDefine your AMQP contracts once — get **type safety**, **autocompletion**, and **runtime validation** everywhere.\n\n- 🔒 **End-to-end type safety** — TypeScript knows your message shapes\n- 🔄 **Reliable retry** — Built-in exponential backoff with Dead Letter Queue support\n- 📄 **AsyncAPI compatible** — Generate documentation from your contracts\n\n## Quick Example\n\n```typescript\nimport {\n  defineContract,\n  defineEventConsumer,\n  defineEventPublisher,\n  defineExchange,\n  defineMessage,\n  defineQueue,\n} from \"@amqp-contract/contract\";\nimport { TypedAmqpClient } from \"@amqp-contract/client\";\nimport { TypedAmqpWorker } from \"@amqp-contract/worker\";\nimport { ok } from \"unthrown\";\nimport { z } from \"zod\";\n\n// 1. Define resources with Dead Letter Exchange and retry configuration\nconst ordersExchange = defineExchange(\"orders\");\nconst ordersDlx = defineExchange(\"orders-dlx\");\nconst orderProcessingQueue = defineQueue(\"order-processing\", {\n  deadLetter: { exchange: ordersDlx, routingKey: \"order.failed\" },\n  retry: { mode: \"ttl-backoff\", maxRetries: 3, initialDelayMs: 1000 }, // Retry configured at queue level\n});\n\n// 2. Define message with schema validation\nconst orderMessage = defineMessage(\n  z.object({\n    orderId: z.string(),\n    amount: z.number(),\n  }),\n);\n\n// 3. Event pattern: publisher broadcasts, consumers subscribe\nconst orderCreatedEvent = defineEventPublisher(ordersExchange, orderMessage, {\n  routingKey: \"order.created\",\n});\n\n// 4. Define contract - only publishers and consumers needed\n//    Exchanges, queues, and bindings are automatically extracted\nconst contract = defineContract({\n  publishers: {\n    orderCreated: orderCreatedEvent,\n  },\n  consumers: {\n    processOrder: defineEventConsumer(orderCreatedEvent, orderProcessingQueue),\n  },\n});\n\n// 6. Type-safe publishing with validation\nconst client = (\n  await TypedAmqpClient.create({\n    contract,\n    urls: [\"amqp://localhost\"],\n  })\n).unwrap();\n\nawait client.publish(\"orderCreated\", {\n  orderId: \"ORD-123\", // ✅ TypeScript knows!\n  amount: 99.99,\n});\n\n// 7. Type-safe consuming with automatic retry (configured at queue level)\nconst worker = (\n  await TypedAmqpWorker.create({\n    contract,\n    handlers: {\n      processOrder: ({ payload }) =\u003e {\n        console.log(payload.orderId); // ✅ TypeScript knows!\n        return ok(undefined).toAsync();\n      },\n    },\n    urls: [\"amqp://localhost\"],\n  })\n).unwrap();\n```\n\n## Installation\n\n```bash\npnpm add @amqp-contract/contract @amqp-contract/client @amqp-contract/worker unthrown\n```\n\n[`unthrown`](https://github.com/btravstack/unthrown) is exposed in the public types (`AsyncResult\u003cvoid, HandlerError\u003e`), so consumers need it directly to construct handler results.\n\n## Documentation\n\n📖 **[Full Documentation →](https://btravstack.github.io/amqp-contract)**\n\n- [Get Started](https://btravstack.github.io/amqp-contract/guide/getting-started) — Get running in 5 minutes\n- [Core Concepts](https://btravstack.github.io/amqp-contract/guide/core-concepts) — Understand the fundamentals\n- [Examples](https://btravstack.github.io/amqp-contract/examples/) — Real-world usage patterns\n\n## Packages\n\n| Package                                        | Description                           |\n| ---------------------------------------------- | ------------------------------------- |\n| [@amqp-contract/contract](./packages/contract) | Contract builder and type definitions |\n| [@amqp-contract/client](./packages/client)     | Type-safe client for publishing       |\n| [@amqp-contract/worker](./packages/worker)     | Type-safe worker with retry support   |\n| [@amqp-contract/asyncapi](./packages/asyncapi) | AsyncAPI 3.0 generator                |\n\n## Contributing\n\nSee [CONTRIBUTING.md](./CONTRIBUTING.md).\n\n## License\n\nMIT\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbtravstack%2Famqp-contract","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbtravstack%2Famqp-contract","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbtravstack%2Famqp-contract/lists"}