Amqp provider based on #3812

libs/shared/src/consts/providers/channels/sms.ts

@@ -1,23 +1,24 @@
 import { IProviderConfig } from '../provider.interface';
 import {
-  gupshupConfig,
-  nexmoConfig,
-  plivoConfig,
-  sms77Config,
-  snsConfig,
-  telnyxConfig,
-  twilioConfig,
-  firetextConfig,
-  infobipSMSConfig,
+  africasTalkingConfig,
+  amqpSmsConfig,
   burstSmsConfig,
   clickatellConfig,
+  firetextConfig,
   fortySixElksConfig,
+  gupshupConfig,
+  infobipSMSConfig,
   kannelConfig,
   maqsamConfig,
+  nexmoConfig,
+  plivoConfig,
+  sendchampConfig,
+  sms77Config,
   smsCentralConfig,
+  snsConfig,
+  telnyxConfig,
   termiiConfig,
-  africasTalkingConfig,
-  sendchampConfig,
+  twilioConfig,
 } from '../credentials';
 import { SmsProviderIdEnum } from '../provider.enum';
 
@@ -179,4 +180,12 @@ export const smsProviders: IProviderConfig[] = [
     docReference: 'https://sendchamp.readme.io/reference/api-structure',
     logoFileName: { light: 'sendchamp.svg', dark: 'sendchamp.svg' },
   },
+  {
+    id: SmsProviderIdEnum.AmqpSms,
+    displayName: 'Amqp',
+    channel: ChannelTypeEnum.SMS,
+    credentials: amqpSmsConfig,
+    docReference: '',
+    logoFileName: { light: 'amqp-sms.svg', dark: 'amqp-sms.svg' },
+  },
 ];

libs/shared/src/consts/providers/credentials/provider-credentials.ts

@@ -740,3 +740,36 @@ export const sendchampConfig: IConfigCredentials[] = [
   },
   ...smsConfigBase,
 ];
+
+export const amqpSmsConfig: IConfigCredentials[] = [
+  {
+    key: CredentialsKeyEnum.ApiKey,
+    displayName: 'Amqp Queue',
+    type: 'text',
+    required: true,
+  },
+  {
+    key: CredentialsKeyEnum.Host,
+    displayName: 'Amqp Host',
+    type: 'text',
+    required: true,
+  },
+  {
+    key: CredentialsKeyEnum.Port,
+    displayName: 'Amqp port',
+    type: 'text',
+    required: true,
+  },
+  {
+    key: CredentialsKeyEnum.User,
+    displayName: 'Amqp user',
+    type: 'text',
+    required: true,
+  },
+  {
+    key: CredentialsKeyEnum.Password,
+    displayName: 'Amqp password',
+    type: 'password',
+    required: true,
+  },
+];

libs/shared/src/consts/providers/provider.enum.ts

@@ -71,6 +71,7 @@ export enum SmsProviderIdEnum {
   AfricasTalking = 'africas-talking',
   Novu = 'novu-sms',
   Sendchamp = 'sendchamp',
+  AmqpSms = 'amqp-sms',
 }
 
 export enum ChatProviderIdEnum {

packages/application-generic/package.json

@@ -91,6 +91,7 @@
     "@novu/termii": "^0.18.0",
     "@novu/testing": "^0.18.0",
     "@novu/twilio": "^0.18.0",
+    "@novu/amqp-sms": "0.16.3",
     "@sentry/node": "^7.12.1",
     "analytics-node": "^6.2.0",
     "bullmq": "^3.10.2",

packages/application-generic/src/factories/sms/handlers/amqp-sms.handler.ts

@@ -0,0 +1,19 @@
+import { ChannelTypeEnum } from '@novu/shared';
+import { BaseSmsHandler } from './base.handler';
+import { AmqpSmsProvider } from '@novu/amqp-sms';
+
+export class AmqpSmsHandler extends BaseSmsHandler {
+  constructor() {
+    super('amqp-sms', ChannelTypeEnum.SMS);
+  }
+
+  buildProvider(credentials: any) {
+    this.provider = new AmqpSmsProvider({
+      apiKey: credentials.apiKey,
+      host: credentials.host,
+      port: credentials.port,
+      user: credentials.user,
+      password: credentials.password,
+    });
+  }
+}

packages/application-generic/src/factories/sms/handlers/index.ts

@@ -16,3 +16,4 @@ export * from './sms-central.handler';
 export * from './africas-talking.handler';
 export * from './sendchamp.handler';
 export * from './novu.handler';
+export * from './amqp-sms.handler';

packages/application-generic/src/factories/sms/sms.factory.ts

@@ -19,6 +19,7 @@ import {
   AfricasTalkingSmsHandler,
   SendchampSmsHandler,
   NovuSmsHandler,
+  AmqpSmsHandler,
 } from './handlers';
 
 export class SmsFactory implements ISmsFactory {
@@ -41,6 +42,7 @@ export class SmsFactory implements ISmsFactory {
     new AfricasTalkingSmsHandler(),
     new SendchampSmsHandler(),
     new NovuSmsHandler(),
+    new AmqpSmsHandler(),
   ];
 
   getHandler(integration: IntegrationEntity) {

providers/amqp-sms/.czrc

@@ -0,0 +1,3 @@
+{
+  "path": "cz-conventional-changelog"
+}

providers/amqp-sms/.eslintrc.json

@@ -0,0 +1,3 @@
+{
+  "extends": "../../.eslintrc.js"
+}

providers/amqp-sms/.gitignore

@@ -0,0 +1,9 @@
+.idea/*
+.nyc_output
+build
+node_modules
+test
+src/**.js
+coverage
+*.log
+package-lock.json

providers/amqp-sms/README.md

@@ -0,0 +1,9 @@
+# Novu AmqpSms Provider
+
+A AmqpSms sms provider library for [@novu/node](https://github.com/novuhq/novu)
+
+## Usage
+
+```javascript
+    FILL IN THE INITIALIZATION USAGE
+```

providers/amqp-sms/jest.config.js

@@ -0,0 +1,5 @@
+/** @type {import('ts-jest/dist/types').InitialOptionsTsJest} */
+module.exports = {
+  preset: 'ts-jest',
+  testEnvironment: 'node',
+};