Merge pull request #4687 from ayushshukla7777/messagebird

feat: Added MessageBird SMS client

.cspell.json

@@ -518,7 +518,9 @@
     "ryver",
     "idempotency", 
     "IDEMPOTENCY", 
-    "Idempotency"
+    "Idempotency",
+    "messagebird",
+    "Datetime"
   ],
   "flagWords": [],
   "patterns": [

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

@@ -21,6 +21,7 @@ import {
   genericSmsConfig,
   clickSendConfig,
   bandwidthConfig,
+  messagebirdConfig,
 } from '../credentials';
 import { SmsProviderIdEnum } from '../provider.enum';
 
@@ -76,6 +77,14 @@ export const smsProviders: IProviderConfig[] = [
     docReference: 'https://docs.novu.co/channels-and-providers/sms/telnyx',
     logoFileName: { light: 'telnyx.png', dark: 'telnyx.png' },
   },
+  {
+    id: SmsProviderIdEnum.MessageBird,
+    displayName: 'MessageBird',
+    channel: ChannelTypeEnum.SMS,
+    credentials: messagebirdConfig,
+    docReference: 'https://developers.messagebird.com/quickstarts/sms-overview/',
+    logoFileName: { light: 'messagebird.png', dark: 'messagebird.png' },
+  },
   {
     id: SmsProviderIdEnum.Twilio,
     displayName: 'Twilio',

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

@@ -422,6 +422,16 @@ export const twilioConfig: IConfigCredentials[] = [
   ...smsConfigBase,
 ];
 
+export const messagebirdConfig: IConfigCredentials[] = [
+  {
+    key: CredentialsKeyEnum.AccessKey,
+    displayName: 'Access key',
+    type: 'string',
+    required: true,
+  },
+  ...smsConfigBase,
+];
+
 export const slackConfig: IConfigCredentials[] = [
   {
     key: CredentialsKeyEnum.ApplicationId,

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

@@ -33,6 +33,7 @@ export enum CredentialsKeyEnum {
   DatePath = 'datePath',
   AuthenticateByToken = 'authenticateByToken',
   AuthenticationTokenKey = 'authenticationTokenKey',
+  AccessKey = 'accessKey',
 }
 
 export enum EmailProviderIdEnum {
@@ -81,6 +82,7 @@ export enum SmsProviderIdEnum {
   GenericSms = 'generic-sms',
   Clicksend = 'clicksend',
   Bandwidth = 'bandwidth',
+  MessageBird = 'messagebird',
 }
 
 export enum ChatProviderIdEnum {

libs/shared/src/entities/integration/credential.interface.ts

@@ -31,4 +31,5 @@ export interface ICredentials {
   datePath?: string;
   authenticateByToken?: boolean;
   authenticationTokenKey?: string;
+  accessKey?: string;
 }

packages/application-generic/package.json

@@ -72,6 +72,7 @@
     "@novu/mandrill": "^0.21.0",
     "@novu/maqsam": "^0.21.0",
     "@novu/mattermost": "^0.21.0",
+    "@novu/messagebird": "^0.21.0",
     "@novu/ms-teams": "^0.21.0",
     "@novu/netcore": "^0.21.0",
     "@novu/nodemailer": "^0.21.0",

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

@@ -19,3 +19,4 @@ export * from './clicksend.handler';
 export * from './bandwidth.handler';
 export * from './novu.handler';
 export * from './generic-sms.handler';
+export * from './messagebird.handler';

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

@@ -0,0 +1,14 @@
+import { MessageBirdSmsProvider } from '@novu/messagebird';
+import { ChannelTypeEnum, ICredentials } from '@novu/shared';
+import { BaseSmsHandler } from './base.handler';
+
+export class MessageBirdHandler extends BaseSmsHandler {
+  constructor() {
+    super('messagebird', ChannelTypeEnum.SMS);
+  }
+  buildProvider(credentials: ICredentials) {
+    this.provider = new MessageBirdSmsProvider({
+      access_key: credentials.accessKey,
+    });
+  }
+}

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

@@ -22,6 +22,7 @@ import {
   BandwidthHandler,
   NovuSmsHandler,
   GenericSmsHandler,
+  MessageBirdHandler,
 } from './handlers';
 
 export class SmsFactory implements ISmsFactory {
@@ -47,6 +48,7 @@ export class SmsFactory implements ISmsFactory {
     new BandwidthHandler(),
     new NovuSmsHandler(),
     new GenericSmsHandler(),
+    new MessageBirdHandler(),
   ];
 
   getHandler(integration: IntegrationEntity) {

providers/messagebird/.czrc

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

providers/messagebird/.eslintrc.json

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

providers/messagebird/.gitignore

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

providers/messagebird/README.md

@@ -0,0 +1,13 @@
+# Novu Messagebird Provider
+
+A Messagebird sms provider library for [@novu/node](https://github.com/novuhq/novu)
+
+## Usage
+
+```javascript
+import { MessageBirdProvider } from '@novu/messagebird';
+
+const provider = new MailgunEmailProvider({
+  access_key: process.env.MESSAGEBIRD_ACCESS_KEY,
+});
+```

providers/messagebird/jest.config.js

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

providers/messagebird/package.json

@@ -0,0 +1,78 @@
+{
+  "name": "@novu/messagebird",
+  "version": "0.21.0",
+  "description": "A messagebird wrapper for novu",
+  "main": "build/main/index.js",
+  "typings": "build/main/index.d.ts",
+  "module": "build/module/index.js",
+  "private": false,
+  "repository": "https://github.com/novuhq/novu",
+  "license": "MIT",
+  "keywords": [],
+  "scripts": {
+    "prebuild": "rimraf build",
+    "build": "run-p build:*",
+    "build:main": "tsc -p tsconfig.json",
+    "build:module": "tsc -p tsconfig.module.json",
+    "fix": "run-s fix:*",
+    "fix:prettier": "prettier \"src/**/*.ts\" --write",
+    "fix:lint": "eslint src --ext .ts --fix",
+    "test": "run-s test:*",
+    "lint": "eslint src --ext .ts",
+    "test:unit": "jest src",
+    "watch:build": "tsc -p tsconfig.json -w",
+    "watch:test": "jest src --watch",
+    "reset-hard": "git clean -dfx && git reset --hard && yarn",
+    "prepare-release": "run-s reset-hard test"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "@novu/stateless": "0.16.3",
+    "messagebird": "^4.0.1"
+  },
+  "devDependencies": {
+    "@istanbuljs/nyc-config-typescript": "~1.0.1",
+    "@types/jest": "~27.5.2",
+    "cspell": "~6.19.2",
+    "jest": "~27.5.1",
+    "npm-run-all": "^4.1.5",
+    "nyc": "~15.1.0",
+    "prettier": "~2.8.0",
+    "rimraf": "~3.0.2",
+    "ts-jest": "~27.1.5",
+    "ts-node": "~10.9.1",
+    "typescript": "4.9.5"
+  },
+  "files": [
+    "build/main",
+    "build/module",
+    "!**/*.spec.*",
+    "!**/*.json",
+    "CHANGELOG.md",
+    "LICENSE",
+    "README.md"
+  ],
+  "ava": {
+    "failFast": true,
+    "timeout": "60s",
+    "typescript": {
+      "rewritePaths": {
+        "src/": "build/main/"
+      }
+    },
+    "files": [
+      "!build/module/**"
+    ]
+  },
+  "prettier": {
+    "singleQuote": true
+  },
+  "nyc": {
+    "extends": "@istanbuljs/nyc-config-typescript",
+    "exclude": [
+      "**/*.spec.js"
+    ]
+  }
+}

providers/messagebird/src/index.ts

@@ -0,0 +1 @@
+export * from './lib/messagebird.provider';