@spinajs/queue-amqp-transport 2.0.482

package/README.md

@@ -0,0 +1,75 @@
+# `@spinajs/queue-amqp-transport`
+
+AMQP 0-9-1 ( RabbitMQ ) transport for the [`@spinajs/queue`](../queue) module. Lets you publish and
+consume queue messages ( jobs & events ) through an AMQP compatible broker.
+
+## Topology
+
+The transport maps the queue `channel` string onto AMQP primitives using a simple, STOMP compatible
+convention:
+
+| Channel prefix      | AMQP primitive            | Semantics                                            |
+| ------------------- | ------------------------- | --------------------------------------------------- |
+| `/topic/...`        | `fanout` exchange         | Events / pub-sub. Every subscriber gets every message. |
+| anything else       | durable work queue        | Jobs. A message is delivered to a single consumer.  |
+
+The topic prefix can be changed per connection via `options.topicPrefix`.
+
+- **Transient event subscription** – an exclusive, auto-deleted, server-named queue bound to the fanout exchange.
+- **Durable event subscription** – a stable, durable queue named after `subscriptionId`; messages keep
+  accumulating while no consumer is attached and are delivered on re-subscribe.
+
+## Usage
+
+Register the transport in your queue configuration:
+
+```js
+import '@spinajs/queue-amqp-transport';
+
+const config = {
+  queue: {
+    default: 'amqp',
+    routing: {
+      // optional per-message channel routing
+      MyEvent: '/topic/my-events',
+      MyJob: '/queue/my-jobs',
+    },
+    connections: [
+      {
+        name: 'amqp',
+        transport: 'AmqpQueueClient',
+        host: 'localhost',
+        port: 5672,
+        login: 'guest',
+        password: 'guest',
+        defaultTopicChannel: '/topic/default',
+        defaultQueueChannel: '/queue/default',
+        options: {
+          // forwarded to amqplib connect ( heartbeat, vhost, tls ... )
+          vhost: '/',
+          // topicPrefix: '/topic/',
+        },
+      },
+    ],
+  },
+};
+```
+
+`host` may also be a full url ( `amqp://user:pass@host/vhost` ), in which case the discrete
+`port`/`login`/`password` fields are ignored.
+
+## Not yet supported
+
+Delayed / scheduled delivery ( `ScheduleDelay`, `ScheduleCron`, `SchedulePeriod`, `ScheduleRepeat` ) is
+not implemented yet — RabbitMQ requires the delayed-message plugin or a TTL + dead-letter topology for
+this. When these fields are set the message is delivered immediately and a warning is logged.
+
+## Tests
+
+The test suite expects a running RabbitMQ broker. By default it connects to `localhost:5672`; override
+with `AMQP_HOST` / `AMQP_PORT` environment variables.
+
+```
+docker run -d --name rabbitmq -p 5672:5672 -p 15672:15672 rabbitmq:3-management
+npm test
+```

package/package.json

@@ -0,0 +1,68 @@
+{
+  "name": "@spinajs/queue-amqp-transport",
+  "version": "2.0.482",
+  "description": "spinajs queue transport based on AMQP 0-9-1 ( RabbitMQ ). Sends & reads queue messages ( jobs & events ) from an amqp compatible broker.",
+  "main": "lib/cjs/index.js",
+  "module": "lib/mjs/index.js",
+  "exports": {
+    ".": {
+      "types": "./lib/mjs/index.d.ts",
+      "import": "./lib/mjs/index.js",
+      "require": "./lib/cjs/index.js"
+    }
+  },
+  "type": "module",
+  "private": false,
+  "publishConfig": { "access": "public" },
+  "engines": {
+    "node": ">=16.11"
+  },
+  "scripts": {
+    "build": "npm run clean && npm run compile",
+    "compile": "tsc -b tsconfig.mjs.json",
+    "compile:cjs": "tsc -b tsconfig.cjs.json",
+    "rimraf": "./node_modules/rimraf/bin.js",
+    "clean": "rimraf lib/ && rimraf tsconfig.tsbuildinfo",
+    "test": "ts-mocha -p tsconfig.json test/**/*.test.ts",
+    "coverage": "nyc npm run test",
+    "build-docs": "rimraf docs && typedoc --options typedoc.json src/",
+    "format": "prettier --write \"src/**/*.ts\"",
+    "lint": "eslint -c .eslintrc.cjs --ext .ts src --fix",
+    "preversion": "npm run lint",
+    "version": "npm run format && git add -A src"
+  },
+  "files": [
+    "lib/**/*"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/spinajs/main.git"
+  },
+  "keywords": [
+    "spinajs",
+    "queue",
+    "amqp",
+    "rabbitmq"
+  ],
+  "author": "SpinaJS <spinajs@coderush.pl> (https://github.com/spinajs/main)",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/spinajs/main/issues"
+  },
+  "homepage": "https://github.com/spinajs/main#readme",
+  "devDependencies": {
+    "@types/amqplib": "^0.10.8",
+    "@types/luxon": "^3.6.1",
+    "@types/node": "^18.11.18"
+  },
+  "dependencies": {
+    "@spinajs/configuration": "^2.0.482",
+    "@spinajs/di": "^2.0.482",
+    "@spinajs/exceptions": "^2.0.482",
+    "@spinajs/log": "^2.0.482",
+    "@spinajs/queue": "^2.0.482",
+    "amqplib": "^0.10.9",
+    "@spinajs/util": "^2.0.482"
+  },
+  "gitHead": "002dc553b0ffffd72193d0121ac425a4083bc9ee"
+}