@noildm/contracts 1.0.5 → 1.0.7

package/contracts/exchanges/mail.exchange.ts

@@ -0,0 +1,6 @@
+import { RabbitExchangeConfig } from '../shared/rabbit-exchange-config.interface';
+
+export const EXCHANGE_MAIL: RabbitExchangeConfig = {
+  name: 'mail',
+  type: 'direct',
+};

package/contracts/queues/mail/request-type.ts

@@ -0,0 +1,11 @@
+export interface SendMailRequest {
+  from?: string;
+
+  toEmail: string;
+
+  subject: string;
+
+  text: string;
+
+  html?: string;
+}

package/contracts/queues/mail/send-mail.contract.ts

@@ -0,0 +1,14 @@
+import { EXCHANGE_MAIL } from "../../exchanges/mail.exchange";
+import { AmqpBaseRequest } from "../../shared/amqp-base-request.interface";
+import { QueueDeclaration } from "../../shared/queue-declaration.interface";
+import { SendMailRequest } from "./request-type";
+
+export namespace SendMailContract {
+  export const queue: QueueDeclaration<unknown> = {
+    exchange: EXCHANGE_MAIL,
+    queue: `${EXCHANGE_MAIL.name}-send`,
+    routingKey: `${EXCHANGE_MAIL.name}-send`,
+    queueOptions: { durable: true },
+  };
+  export type request = AmqpBaseRequest<SendMailRequest>;
+}

package/contracts/shared/amqp-base-request.interface.ts

@@ -0,0 +1,8 @@
+export interface AmqpBaseRequest<T = unknown> {
+  type: string;
+  payload: T;
+  requestId: string;
+  timeStamp: string;
+  exchange?: string;
+  routingKey?: string;
+}

package/contracts/shared/amqp-base-response.interface.ts

@@ -0,0 +1,8 @@
+import { AmqpBaseRequest } from './amqp-base-request.interface';
+
+export interface AmqpBaseResponse<T = unknown> extends AmqpBaseRequest<T> {
+  error?: {
+    code: string;
+    message: string;
+  };
+}

package/contracts/shared/queue-declaration.interface.ts

@@ -0,0 +1,31 @@
+import { RabbitExchangeConfig } from "./rabbit-exchange-config.interface";
+
+interface QueueOptions<ConsumeOptions> {
+  durable?: boolean;
+  exclusive?: boolean;
+  autoDelete?: boolean;
+  arguments?: any;
+  messageTtl?: number;
+  expires?: number;
+  deadLetterExchange?: string;
+  deadLetterRoutingKey?: string;
+  maxLength?: number;
+  maxPriority?: number;
+  bindQueueArguments?: any;
+  /**
+   * Set this to the name of the channel you want to consume messages from to enable this feature.
+   *
+   * If channel does not exist or you haven't specified one, it will use the default channel.
+   *
+   * For channel to exist it needs to be created in module config.
+   */
+  channel?: string;
+  consumerOptions?: ConsumeOptions;
+}
+
+export interface QueueDeclaration<ConsumeOptions> {
+  exchange: RabbitExchangeConfig;
+  routingKey: string;
+  queue: string;
+  queueOptions: QueueOptions<ConsumeOptions>;
+}

package/contracts/shared/rabbit-exchange-config.interface.ts

@@ -0,0 +1,13 @@
+export interface RabbitExchangeConfig {
+  name: string;
+  type: 'topic' | 'direct' | 'fanout';
+  options?: AssertExchange;
+}
+
+interface AssertExchange {
+  durable?: boolean;
+  internal?: boolean;
+  autoDelete?: boolean;
+  alternateExchange?: string;
+  arguments?: unknown | unknown[];
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@noildm/contracts",
-  "version": "1.0.5",
+  "version": "1.0.7",
   "description": "Protobuf and RabbitMQ contracts",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -12,7 +12,8 @@
   "files": [
     "proto",
     "gen",
-    "dist"
+    "dist",
+    "contracts"
   ],
   "dependencies": {
     "@bufbuild/buf": "^1.65.0",