@amqp-contract/client 0.0.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Benoit Travers
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,55 @@
+# @amqp-contract/client
+
+Type-safe AMQP client for publishing messages using amqp-contract.
+
+## Installation
+
+```bash
+pnpm add @amqp-contract/client amqplib
+```
+
+## Usage
+
+```typescript
+import { createClient } from '@amqp-contract/client';
+import { connect } from 'amqplib';
+import { contract } from './contract';
+
+// Connect to RabbitMQ
+const connection = await connect('amqp://localhost');
+
+// Create client from contract
+const client = createClient(contract);
+await client.connect(connection);
+
+// Publish message with type safety
+await client.publish('orderCreated', {
+  orderId: 'ORD-123',
+  amount: 99.99,
+});
+
+// Clean up
+await client.close();
+```
+
+## API
+
+### `createClient(contract)`
+
+Create a type-safe AMQP client from a contract.
+
+### `AmqpClient.connect(connection)`
+
+Connect to an AMQP broker and set up all exchanges, queues, and bindings defined in the contract.
+
+### `AmqpClient.publish(publisherName, message, options?)`
+
+Publish a message using a defined publisher. The message will be validated against the schema and type-checked at compile time.
+
+### `AmqpClient.close()`
+
+Close the channel and connection.
+
+## License
+
+MIT

package/dist/index.cjs

@@ -0,0 +1,72 @@
+
+//#region src/client.ts
+/**
+* Type-safe AMQP client for publishing messages
+*/
+var AmqpClient = class {
+	channel = null;
+	connection = null;
+	constructor(contract) {
+		this.contract = contract;
+	}
+	/**
+	* Connect to AMQP broker
+	*/
+	async connect(connection) {
+		this.connection = connection;
+		this.channel = await connection.createChannel();
+		if (this.contract.exchanges && this.channel) for (const exchange of Object.values(this.contract.exchanges)) await this.channel.assertExchange(exchange.name, exchange.type, {
+			durable: exchange.durable,
+			autoDelete: exchange.autoDelete,
+			internal: exchange.internal,
+			arguments: exchange.arguments
+		});
+		if (this.contract.queues && this.channel) for (const queue of Object.values(this.contract.queues)) await this.channel.assertQueue(queue.name, {
+			durable: queue.durable,
+			exclusive: queue.exclusive,
+			autoDelete: queue.autoDelete,
+			arguments: queue.arguments
+		});
+		if (this.contract.bindings && this.channel) for (const binding of Object.values(this.contract.bindings)) await this.channel.bindQueue(binding.queue, binding.exchange, binding.routingKey ?? "", binding.arguments);
+	}
+	/**
+	* Publish a message using a defined publisher
+	*/
+	async publish(publisherName, message, options) {
+		if (!this.channel) throw new Error("Client not connected. Call connect() first.");
+		const publishers = this.contract.publishers;
+		if (!publishers) throw new Error("No publishers defined in contract");
+		const publisher = publishers[publisherName];
+		if (!publisher || typeof publisher !== "object") throw new Error(`Publisher "${String(publisherName)}" not found in contract`);
+		const publisherDef = publisher;
+		const validation = publisherDef.message["~standard"].validate(message);
+		if (typeof validation === "object" && validation !== null && "issues" in validation && validation.issues) throw new Error(`Message validation failed: ${JSON.stringify(validation.issues)}`);
+		const validatedMessage = typeof validation === "object" && validation !== null && "value" in validation ? validation.value : message;
+		const routingKey = options?.routingKey ?? publisherDef.routingKey ?? "";
+		const content = Buffer.from(JSON.stringify(validatedMessage));
+		return this.channel.publish(publisherDef.exchange, routingKey, content, options?.options);
+	}
+	/**
+	* Close the connection
+	*/
+	async close() {
+		if (this.channel) {
+			await this.channel.close();
+			this.channel = null;
+		}
+		if (this.connection) {
+			await this.connection.close();
+			this.connection = null;
+		}
+	}
+};
+/**
+* Create a type-safe AMQP client from a contract
+*/
+function createClient(contract) {
+	return new AmqpClient(contract);
+}
+
+//#endregion
+exports.AmqpClient = AmqpClient;
+exports.createClient = createClient;

package/dist/index.d.cts

@@ -0,0 +1,40 @@
+import { Connection, Options } from "amqplib";
+import { ClientInferPublisherInput, ContractDefinition, InferPublisherNames } from "@amqp-contract/contract";
+
+//#region src/client.d.ts
+
+/**
+ * Options for publishing a message
+ */
+interface PublishOptions {
+  routingKey?: string;
+  options?: Options.Publish;
+}
+/**
+ * Type-safe AMQP client for publishing messages
+ */
+declare class AmqpClient<TContract extends ContractDefinition> {
+  private readonly contract;
+  private channel;
+  private connection;
+  constructor(contract: TContract);
+  /**
+   * Connect to AMQP broker
+   */
+  connect(connection: Connection): Promise<void>;
+  /**
+   * Publish a message using a defined publisher
+   */
+  publish<TName extends InferPublisherNames<TContract>>(publisherName: TName, message: ClientInferPublisherInput<TContract, TName>, options?: PublishOptions): Promise<boolean>;
+  /**
+   * Close the connection
+   */
+  close(): Promise<void>;
+}
+/**
+ * Create a type-safe AMQP client from a contract
+ */
+declare function createClient<TContract extends ContractDefinition>(contract: TContract): AmqpClient<TContract>;
+//#endregion
+export { AmqpClient, type PublishOptions, createClient };
+//# sourceMappingURL=index.d.cts.map

package/dist/index.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.cts","names":[],"sources":["../src/client.ts"],"sourcesContent":[],"mappings":";;;;;;;AAUA;AAQa,UARI,cAAA,CAQM;EAAmB,UAAA,CAAA,EAAA,MAAA;EAID,OAAA,CAAA,EAV7B,OAAA,CAAQ,OAUqB;;;;;AAoDtB,cAxDN,UAwDM,CAAA,kBAxDuB,kBAwDvB,CAAA,CAAA;EACoB,iBAAA,QAAA;EAAW,QAAA,OAAA;EAArC,QAAA,UAAA;EACC,WAAA,CAAA,QAAA,EAtD2B,SAsD3B;EACT;;;EA8DW,OAAA,CAAA,UAAY,EAhHA,UAgHA,CAAA,EAhHiB,OAgHjB,CAAA,IAAA,CAAA;EAAmB;;;EAE5C,OAAA,CAAA,cApE2B,mBAoE3B,CApE+C,SAoE/C,CAAA,CAAA,CAAA,aAAA,EAnEgB,KAmEhB,EAAA,OAAA,EAlEU,yBAkEV,CAlEoC,SAkEpC,EAlE+C,KAkE/C,CAAA,EAAA,OAAA,CAAA,EAjEW,cAiEX,CAAA,EAhEE,OAgEF,CAAA,OAAA,CAAA;EAAU;;;WAjBI;;;;;iBAeD,+BAA+B,8BACnC,YACT,WAAW"}

package/dist/index.d.mts

@@ -0,0 +1,40 @@
+import { Connection, Options } from "amqplib";
+import { ClientInferPublisherInput, ContractDefinition, InferPublisherNames } from "@amqp-contract/contract";
+
+//#region src/client.d.ts
+
+/**
+ * Options for publishing a message
+ */
+interface PublishOptions {
+  routingKey?: string;
+  options?: Options.Publish;
+}
+/**
+ * Type-safe AMQP client for publishing messages
+ */
+declare class AmqpClient<TContract extends ContractDefinition> {
+  private readonly contract;
+  private channel;
+  private connection;
+  constructor(contract: TContract);
+  /**
+   * Connect to AMQP broker
+   */
+  connect(connection: Connection): Promise<void>;
+  /**
+   * Publish a message using a defined publisher
+   */
+  publish<TName extends InferPublisherNames<TContract>>(publisherName: TName, message: ClientInferPublisherInput<TContract, TName>, options?: PublishOptions): Promise<boolean>;
+  /**
+   * Close the connection
+   */
+  close(): Promise<void>;
+}
+/**
+ * Create a type-safe AMQP client from a contract
+ */
+declare function createClient<TContract extends ContractDefinition>(contract: TContract): AmqpClient<TContract>;
+//#endregion
+export { AmqpClient, type PublishOptions, createClient };
+//# sourceMappingURL=index.d.mts.map

package/dist/index.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.mts","names":[],"sources":["../src/client.ts"],"sourcesContent":[],"mappings":";;;;;;;AAUA;AAQa,UARI,cAAA,CAQM;EAAmB,UAAA,CAAA,EAAA,MAAA;EAID,OAAA,CAAA,EAV7B,OAAA,CAAQ,OAUqB;;;;;AAoDtB,cAxDN,UAwDM,CAAA,kBAxDuB,kBAwDvB,CAAA,CAAA;EACoB,iBAAA,QAAA;EAAW,QAAA,OAAA;EAArC,QAAA,UAAA;EACC,WAAA,CAAA,QAAA,EAtD2B,SAsD3B;EACT;;;EA8DW,OAAA,CAAA,UAAY,EAhHA,UAgHA,CAAA,EAhHiB,OAgHjB,CAAA,IAAA,CAAA;EAAmB;;;EAE5C,OAAA,CAAA,cApE2B,mBAoE3B,CApE+C,SAoE/C,CAAA,CAAA,CAAA,aAAA,EAnEgB,KAmEhB,EAAA,OAAA,EAlEU,yBAkEV,CAlEoC,SAkEpC,EAlE+C,KAkE/C,CAAA,EAAA,OAAA,CAAA,EAjEW,cAiEX,CAAA,EAhEE,OAgEF,CAAA,OAAA,CAAA;EAAU;;;WAjBI;;;;;iBAeD,+BAA+B,8BACnC,YACT,WAAW"}

package/dist/index.mjs

@@ -0,0 +1,71 @@
+//#region src/client.ts
+/**
+* Type-safe AMQP client for publishing messages
+*/
+var AmqpClient = class {
+	channel = null;
+	connection = null;
+	constructor(contract) {
+		this.contract = contract;
+	}
+	/**
+	* Connect to AMQP broker
+	*/
+	async connect(connection) {
+		this.connection = connection;
+		this.channel = await connection.createChannel();
+		if (this.contract.exchanges && this.channel) for (const exchange of Object.values(this.contract.exchanges)) await this.channel.assertExchange(exchange.name, exchange.type, {
+			durable: exchange.durable,
+			autoDelete: exchange.autoDelete,
+			internal: exchange.internal,
+			arguments: exchange.arguments
+		});
+		if (this.contract.queues && this.channel) for (const queue of Object.values(this.contract.queues)) await this.channel.assertQueue(queue.name, {
+			durable: queue.durable,
+			exclusive: queue.exclusive,
+			autoDelete: queue.autoDelete,
+			arguments: queue.arguments
+		});
+		if (this.contract.bindings && this.channel) for (const binding of Object.values(this.contract.bindings)) await this.channel.bindQueue(binding.queue, binding.exchange, binding.routingKey ?? "", binding.arguments);
+	}
+	/**
+	* Publish a message using a defined publisher
+	*/
+	async publish(publisherName, message, options) {
+		if (!this.channel) throw new Error("Client not connected. Call connect() first.");
+		const publishers = this.contract.publishers;
+		if (!publishers) throw new Error("No publishers defined in contract");
+		const publisher = publishers[publisherName];
+		if (!publisher || typeof publisher !== "object") throw new Error(`Publisher "${String(publisherName)}" not found in contract`);
+		const publisherDef = publisher;
+		const validation = publisherDef.message["~standard"].validate(message);
+		if (typeof validation === "object" && validation !== null && "issues" in validation && validation.issues) throw new Error(`Message validation failed: ${JSON.stringify(validation.issues)}`);
+		const validatedMessage = typeof validation === "object" && validation !== null && "value" in validation ? validation.value : message;
+		const routingKey = options?.routingKey ?? publisherDef.routingKey ?? "";
+		const content = Buffer.from(JSON.stringify(validatedMessage));
+		return this.channel.publish(publisherDef.exchange, routingKey, content, options?.options);
+	}
+	/**
+	* Close the connection
+	*/
+	async close() {
+		if (this.channel) {
+			await this.channel.close();
+			this.channel = null;
+		}
+		if (this.connection) {
+			await this.connection.close();
+			this.connection = null;
+		}
+	}
+};
+/**
+* Create a type-safe AMQP client from a contract
+*/
+function createClient(contract) {
+	return new AmqpClient(contract);
+}
+
+//#endregion
+export { AmqpClient, createClient };
+//# sourceMappingURL=index.mjs.map

package/dist/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.mjs","names":["contract: TContract"],"sources":["../src/client.ts"],"sourcesContent":["import type { Channel, Connection as AmqpConnection, Options } from 'amqplib';\nimport type {\n  ClientInferPublisherInput,\n  ContractDefinition,\n  InferPublisherNames,\n} from '@amqp-contract/contract';\n\n/**\n * Options for publishing a message\n */\nexport interface PublishOptions {\n  routingKey?: string;\n  options?: Options.Publish;\n}\n\n/**\n * Type-safe AMQP client for publishing messages\n */\nexport class AmqpClient<TContract extends ContractDefinition> {\n  private channel: Channel | null = null;\n  private connection: AmqpConnection | null = null;\n\n  constructor(private readonly contract: TContract) {}\n\n  /**\n   * Connect to AMQP broker\n   */\n  async connect(connection: AmqpConnection): Promise<void> {\n    this.connection = connection;\n    this.channel = await (\n      connection as unknown as { createChannel(): Promise<Channel> }\n    ).createChannel();\n\n    // Setup exchanges\n    if (this.contract.exchanges && this.channel) {\n      for (const exchange of Object.values(this.contract.exchanges)) {\n        await this.channel.assertExchange(exchange.name, exchange.type, {\n          durable: exchange.durable,\n          autoDelete: exchange.autoDelete,\n          internal: exchange.internal,\n          arguments: exchange.arguments,\n        });\n      }\n    }\n\n    // Setup queues\n    if (this.contract.queues && this.channel) {\n      for (const queue of Object.values(this.contract.queues)) {\n        await this.channel.assertQueue(queue.name, {\n          durable: queue.durable,\n          exclusive: queue.exclusive,\n          autoDelete: queue.autoDelete,\n          arguments: queue.arguments,\n        });\n      }\n    }\n\n    // Setup bindings\n    if (this.contract.bindings && this.channel) {\n      for (const binding of Object.values(this.contract.bindings)) {\n        await this.channel.bindQueue(\n          binding.queue,\n          binding.exchange,\n          binding.routingKey ?? '',\n          binding.arguments\n        );\n      }\n    }\n  }\n\n  /**\n   * Publish a message using a defined publisher\n   */\n  async publish<TName extends InferPublisherNames<TContract>>(\n    publisherName: TName,\n    message: ClientInferPublisherInput<TContract, TName>,\n    options?: PublishOptions\n  ): Promise<boolean> {\n    if (!this.channel) {\n      throw new Error('Client not connected. Call connect() first.');\n    }\n\n    const publishers = this.contract.publishers as Record<string, unknown>;\n    if (!publishers) {\n      throw new Error('No publishers defined in contract');\n    }\n\n    const publisher = publishers[publisherName as string];\n    if (!publisher || typeof publisher !== 'object') {\n      throw new Error(`Publisher \"${String(publisherName)}\" not found in contract`);\n    }\n\n    const publisherDef = publisher as {\n      exchange: string;\n      routingKey?: string;\n      message: { '~standard': { validate: (value: unknown) => unknown } };\n    };\n\n    // Validate message using schema\n    const validation = publisherDef.message['~standard'].validate(message);\n    if (\n      typeof validation === 'object' &&\n      validation !== null &&\n      'issues' in validation &&\n      validation.issues\n    ) {\n      throw new Error(`Message validation failed: ${JSON.stringify(validation.issues)}`);\n    }\n\n    const validatedMessage =\n      typeof validation === 'object' && validation !== null && 'value' in validation\n        ? validation.value\n        : message;\n\n    // Publish message\n    const routingKey = options?.routingKey ?? publisherDef.routingKey ?? '';\n    const content = Buffer.from(JSON.stringify(validatedMessage));\n\n    return this.channel.publish(publisherDef.exchange, routingKey, content, options?.options);\n  }\n\n  /**\n   * Close the connection\n   */\n  async close(): Promise<void> {\n    if (this.channel) {\n      await this.channel.close();\n      this.channel = null;\n    }\n    if (this.connection) {\n      await (this.connection as unknown as { close(): Promise<void> }).close();\n      this.connection = null;\n    }\n  }\n}\n\n/**\n * Create a type-safe AMQP client from a contract\n */\nexport function createClient<TContract extends ContractDefinition>(\n  contract: TContract\n): AmqpClient<TContract> {\n  return new AmqpClient(contract);\n}\n"],"mappings":";;;;AAkBA,IAAa,aAAb,MAA8D;CAC5D,AAAQ,UAA0B;CAClC,AAAQ,aAAoC;CAE5C,YAAY,AAAiBA,UAAqB;EAArB;;;;;CAK7B,MAAM,QAAQ,YAA2C;AACvD,OAAK,aAAa;AAClB,OAAK,UAAU,MACb,WACA,eAAe;AAGjB,MAAI,KAAK,SAAS,aAAa,KAAK,QAClC,MAAK,MAAM,YAAY,OAAO,OAAO,KAAK,SAAS,UAAU,CAC3D,OAAM,KAAK,QAAQ,eAAe,SAAS,MAAM,SAAS,MAAM;GAC9D,SAAS,SAAS;GAClB,YAAY,SAAS;GACrB,UAAU,SAAS;GACnB,WAAW,SAAS;GACrB,CAAC;AAKN,MAAI,KAAK,SAAS,UAAU,KAAK,QAC/B,MAAK,MAAM,SAAS,OAAO,OAAO,KAAK,SAAS,OAAO,CACrD,OAAM,KAAK,QAAQ,YAAY,MAAM,MAAM;GACzC,SAAS,MAAM;GACf,WAAW,MAAM;GACjB,YAAY,MAAM;GAClB,WAAW,MAAM;GAClB,CAAC;AAKN,MAAI,KAAK,SAAS,YAAY,KAAK,QACjC,MAAK,MAAM,WAAW,OAAO,OAAO,KAAK,SAAS,SAAS,CACzD,OAAM,KAAK,QAAQ,UACjB,QAAQ,OACR,QAAQ,UACR,QAAQ,cAAc,IACtB,QAAQ,UACT;;;;;CAQP,MAAM,QACJ,eACA,SACA,SACkB;AAClB,MAAI,CAAC,KAAK,QACR,OAAM,IAAI,MAAM,8CAA8C;EAGhE,MAAM,aAAa,KAAK,SAAS;AACjC,MAAI,CAAC,WACH,OAAM,IAAI,MAAM,oCAAoC;EAGtD,MAAM,YAAY,WAAW;AAC7B,MAAI,CAAC,aAAa,OAAO,cAAc,SACrC,OAAM,IAAI,MAAM,cAAc,OAAO,cAAc,CAAC,yBAAyB;EAG/E,MAAM,eAAe;EAOrB,MAAM,aAAa,aAAa,QAAQ,aAAa,SAAS,QAAQ;AACtE,MACE,OAAO,eAAe,YACtB,eAAe,QACf,YAAY,cACZ,WAAW,OAEX,OAAM,IAAI,MAAM,8BAA8B,KAAK,UAAU,WAAW,OAAO,GAAG;EAGpF,MAAM,mBACJ,OAAO,eAAe,YAAY,eAAe,QAAQ,WAAW,aAChE,WAAW,QACX;EAGN,MAAM,aAAa,SAAS,cAAc,aAAa,cAAc;EACrE,MAAM,UAAU,OAAO,KAAK,KAAK,UAAU,iBAAiB,CAAC;AAE7D,SAAO,KAAK,QAAQ,QAAQ,aAAa,UAAU,YAAY,SAAS,SAAS,QAAQ;;;;;CAM3F,MAAM,QAAuB;AAC3B,MAAI,KAAK,SAAS;AAChB,SAAM,KAAK,QAAQ,OAAO;AAC1B,QAAK,UAAU;;AAEjB,MAAI,KAAK,YAAY;AACnB,SAAO,KAAK,WAAqD,OAAO;AACxE,QAAK,aAAa;;;;;;;AAQxB,SAAgB,aACd,UACuB;AACvB,QAAO,IAAI,WAAW,SAAS"}

package/package.json

@@ -0,0 +1,66 @@
+{
+  "name": "@amqp-contract/client",
+  "version": "0.0.1",
+  "description": "Client utilities for publishing messages using amqp-contract",
+  "keywords": [
+    "amqp",
+    "typescript",
+    "contract",
+    "client",
+    "rabbitmq"
+  ],
+  "homepage": "https://github.com/btravers/amqp-contract#readme",
+  "bugs": {
+    "url": "https://github.com/btravers/amqp-contract/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/btravers/amqp-contract.git",
+    "directory": "packages/client"
+  },
+  "license": "MIT",
+  "author": "Benoit TRAVERS <benoit.travers.fr@gmail.com>",
+  "type": "module",
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/index.d.mts",
+        "default": "./dist/index.mjs"
+      },
+      "require": {
+        "types": "./dist/index.d.cts",
+        "default": "./dist/index.cjs"
+      }
+    },
+    "./package.json": "./package.json"
+  },
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.mts",
+  "files": [
+    "dist"
+  ],
+  "dependencies": {
+    "@amqp-contract/contract": "0.0.1"
+  },
+  "devDependencies": {
+    "@types/amqplib": "0.10.8",
+    "@types/node": "24.10.2",
+    "@vitest/coverage-v8": "4.0.15",
+    "amqplib": "0.10.9",
+    "tsdown": "0.17.2",
+    "typescript": "5.9.3",
+    "vitest": "4.0.15",
+    "@amqp-contract/tsconfig": "0.0.0"
+  },
+  "peerDependencies": {
+    "amqplib": ">=0.10.0"
+  },
+  "scripts": {
+    "build": "tsdown src/index.ts --format cjs,esm --dts --clean",
+    "dev": "tsdown src/index.ts --format cjs,esm --dts --watch",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "typecheck": "tsc --noEmit"
+  }
+}