Merge pull request #4473 from parveshsaini/feature/clicksend-sms-prov…

…ider-addition

feat(provider): clicksend sms provider addition

.cspell.json

@@ -508,7 +508,9 @@
     "autodocs",
     "stackalt",
     "mediumdark",
-    "Docgen"
+    "Docgen",
+    "clicksend",
+    "Clicksend"
   ],
   "flagWords": [],
   "patterns": [

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

@@ -18,6 +18,7 @@ import {
   termiiConfig,
   africasTalkingConfig,
   sendchampConfig,
+  clickSendConfig,
 } from '../credentials';
 import { SmsProviderIdEnum } from '../provider.enum';
 
@@ -179,4 +180,12 @@ export const smsProviders: IProviderConfig[] = [
     docReference: 'https://docs.novu.co/channels-and-providers/sms/sendchamp',
     logoFileName: { light: 'sendchamp.svg', dark: 'sendchamp.svg' },
   },
+  {
+    id: SmsProviderIdEnum.Clicksend,
+    displayName: `Clicksend`,
+    channel: ChannelTypeEnum.SMS,
+    credentials: clickSendConfig,
+    docReference: 'https://developers.clicksend.com/docs/rest/v3/?javascript--nodejs#send-sms',
+    logoFileName: { light: 'clicksend.png', dark: 'clicksend.png' },
+  },
 ];

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

@@ -750,3 +750,20 @@ export const sendchampConfig: IConfigCredentials[] = [
   },
   ...smsConfigBase,
 ];
+
+export const clickSendConfig: IConfigCredentials[] = [
+  {
+    key: CredentialsKeyEnum.User,
+    displayName: 'Username',
+    description: 'Your Clicksend API username',
+    type: 'text',
+    required: true,
+  },
+  {
+    key: CredentialsKeyEnum.ApiKey,
+    displayName: 'API Key',
+    type: 'text',
+    required: true,
+  },
+  ...smsConfigBase,
+];

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

@@ -72,6 +72,7 @@ export enum SmsProviderIdEnum {
   AfricasTalking = 'africas-talking',
   Novu = 'novu-sms',
   Sendchamp = 'sendchamp',
+  Clicksend = 'clicksend',
 }
 
 export enum ChatProviderIdEnum {

packages/application-generic/package.json

@@ -94,6 +94,7 @@
     "@novu/termii": "^0.20.0-alpha.1",
     "@novu/testing": "^0.20.0-alpha.1",
     "@novu/twilio": "^0.20.0-alpha.1",
+    "@novu/clicksend": "^0.20.0-alpha.1",
     "@sentry/node": "^7.12.1",
     "analytics-node": "^6.2.0",
     "bullmq": "^3.10.2",

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

@@ -0,0 +1,18 @@
+import { ChannelTypeEnum, ICredentials } from '@novu/shared';
+import { ClicksendSmsProvider } from '@novu/clicksend';
+import { BaseSmsHandler } from './base.handler';
+
+export class ClicksendSmsHandler extends BaseSmsHandler {
+  constructor() {
+    super('clicksend', ChannelTypeEnum.SMS);
+  }
+
+  buildProvider(credentials: ICredentials) {
+    const config = {
+      username: credentials.user,
+      apiKey: credentials.apiKey,
+    };
+
+    this.provider = new ClicksendSmsProvider(config);
+  }
+}

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

@@ -15,4 +15,5 @@ export * from './kannel.handler';
 export * from './sms-central.handler';
 export * from './africas-talking.handler';
 export * from './sendchamp.handler';
+export * from './clicksend.handler';
 export * from './novu.handler';

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

@@ -18,6 +18,7 @@ import {
   SmsCentralHandler,
   AfricasTalkingSmsHandler,
   SendchampSmsHandler,
+  ClicksendSmsHandler,
   NovuSmsHandler,
 } from './handlers';
 
@@ -40,6 +41,7 @@ export class SmsFactory implements ISmsFactory {
     new SmsCentralHandler(),
     new AfricasTalkingSmsHandler(),
     new SendchampSmsHandler(),
+    new ClicksendSmsHandler(),
     new NovuSmsHandler(),
   ];