Merge pull request #5067 from nohira/feature/add-brevo-sms-provider

feat(provider): add brevo-sms provider

apps/web/src/pages/integrations/components/multi-provider/sort-providers.ts

@@ -73,6 +73,7 @@ const providers: Record<ChannelTypeEnum, ProvidersIdEnum[]> = {
       SmsProviderIdEnum.AzureSms,
       SmsProviderIdEnum.Bandwidth,
       SmsProviderIdEnum.Simpletexting,
+      SmsProviderIdEnum.BrevoSms,
     ].sort(),
   ],
 };

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

@@ -26,6 +26,7 @@ import {
   azureSmsConfig,
   bulkSmsConfig,
   iSendSmsConfig,
+  brevoSmsConfig,
 } from '../credentials';
 import { SmsProviderIdEnum } from '../provider.enum';
 
@@ -252,4 +253,12 @@ export const smsProviders: IProviderConfig[] = [
     docReference: 'https://learn.microsoft.com/en-us/azure/communication-services/quickstarts/sms/receive-sms',
     logoFileName: { light: 'azure-sms.png', dark: 'azure-sms.png' },
   },
+  {
+    id: SmsProviderIdEnum.BrevoSms,
+    displayName: `Brevo`,
+    channel: ChannelTypeEnum.SMS,
+    credentials: brevoSmsConfig,
+    docReference: 'https://developers.brevo.com/reference/sendtransacsms',
+    logoFileName: { light: 'brevo.svg', dark: 'brevo.svg' },
+  },
 ];

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

@@ -1063,3 +1063,13 @@ export const rocketChatConfig: IConfigCredentials[] = [
     required: true,
   },
 ];
+
+export const brevoSmsConfig: IConfigCredentials[] = [
+  {
+    key: CredentialsKeyEnum.ApiKey,
+    displayName: 'API Key',
+    type: 'string',
+    required: true,
+  },
+  ...smsConfigBase,
+];

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

@@ -98,6 +98,7 @@ export enum SmsProviderIdEnum {
   MessageBird = 'messagebird',
   Simpletexting = 'simpletexting',
   AzureSms = 'azure-sms',
+  BrevoSms = 'brevo-sms',
 }
 
 export enum ChatProviderIdEnum {

packages/application-generic/package.json

@@ -114,6 +114,7 @@
     "@novu/twilio": "^0.22.0",
     "@novu/zulip": "^0.22.0",
     "@novu/nexmo": "^0.22.0",
+    "@novu/brevo-sms": "^0.22.0",
     "@novu/rocket-chat": "^0.22.0",
     "@opentelemetry/api": "^1.7.0",
     "@opentelemetry/auto-instrumentations-node": "^0.40.2",

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

@@ -0,0 +1,21 @@
+import { ChannelTypeEnum, ICredentials } from '@novu/shared';
+import { BaseSmsHandler } from './base.handler';
+import { BrevoSmsProvider } from '@novu/brevo-sms';
+
+export class BrevoSmsHandler extends BaseSmsHandler {
+  constructor() {
+    super('brevo-sms', ChannelTypeEnum.SMS);
+  }
+  buildProvider(credentials: ICredentials) {
+    if (!credentials.apiKey || !credentials.from) {
+      throw Error('Invalid credentials');
+    }
+
+    const config = {
+      apiKey: credentials.apiKey,
+      from: credentials.from,
+    };
+
+    this.provider = new BrevoSmsProvider(config);
+  }
+}

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

@@ -25,3 +25,4 @@ export * from './azure-sms.handler';
 export * from './bulk-sms.handler';
 export * from './nexmo.handler';
 export * from './isend-sms.handler';
+export * from './brevo-sms.handler';

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

@@ -27,6 +27,7 @@ import {
   NovuSmsHandler,
   NexmoHandler,
   ISendSmsHandler,
+  BrevoSmsHandler,
 } from './handlers';
 
 export class SmsFactory implements ISmsFactory {
@@ -57,6 +58,7 @@ export class SmsFactory implements ISmsFactory {
     new NovuSmsHandler(),
     new NexmoHandler(),
     new ISendSmsHandler(),
+    new BrevoSmsHandler(),
   ];
 
   getHandler(integration: IntegrationEntity) {

providers/brevo-sms/.czrc

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

providers/brevo-sms/.eslintrc.json

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

providers/brevo-sms/.gitignore

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

providers/brevo-sms/README.md

@@ -0,0 +1,19 @@
+# Novu BrevoSms Provider
+
+A BrevoSms sms provider library for [@novu/stateless](https://github.com/novuhq/novu)
+
+## Usage
+
+```javascript
+import { BrevoSmsProvider } from '@novu/brevo-sms';
+
+const provider = new BrevoSmsProvider({
+  apiKey: process.env.BREVO_API_KEY,
+  from: process.env.BREVO_FROM, // Sender displayed to the recipient
+});
+
+await provider.sendMessage({
+  to: 'My Company',
+  content: 'Message to send',
+});
+```

providers/brevo-sms/jest.config.js

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