Merge pull request #4650 from parveshsaini/feature/add-simpletexting-sms

feat(provider): added simple-texting SMS provider
novuhq · Oct 31, 2023 · 46e67a7 · 46e67a7 · github-actions · Oct 31, 2023
2 parents 96cc7c8 + 1c83d0f
commit 46e67a7
Show file tree

Hide file tree

Showing 25 changed files with 482 additions and 210 deletions.
diff --git a/.cspell.json b/.cspell.json
@@ -520,7 +520,9 @@
     "IDEMPOTENCY", 
     "Idempotency",
     "messagebird",
-    "Datetime"
+    "Datetime",
+    "simpletexting",
+    "Simpletexting"
   ],
   "flagWords": [],
   "patterns": [

diff --git a/apps/web/public/static/images/providers/dark/simpletexting.png b/apps/web/public/static/images/providers/dark/simpletexting.png
diff --git a/apps/web/public/static/images/providers/dark/square/simpletexting.svg b/apps/web/public/static/images/providers/dark/square/simpletexting.svg
diff --git a/apps/web/public/static/images/providers/light/simpletexting.png b/apps/web/public/static/images/providers/light/simpletexting.png
diff --git a/apps/web/public/static/images/providers/light/square/simpletexting.svg b/apps/web/public/static/images/providers/light/square/simpletexting.svg
diff --git a/apps/web/src/pages/integrations/components/multi-provider/sort-providers.ts b/apps/web/src/pages/integrations/components/multi-provider/sort-providers.ts
@@ -69,6 +69,7 @@ const providers: Record<ChannelTypeEnum, ProvidersIdEnum[]> = {
       SmsProviderIdEnum.AfricasTalking,
       SmsProviderIdEnum.Novu,
       SmsProviderIdEnum.Bandwidth,
+      SmsProviderIdEnum.Simpletexting,
     ].sort(),
   ],
 };

diff --git a/libs/shared/src/consts/providers/channels/sms.ts b/libs/shared/src/consts/providers/channels/sms.ts
@@ -20,6 +20,7 @@ import {
   sendchampConfig,
   genericSmsConfig,
   clickSendConfig,
+  simpleTextingConfig,
   bandwidthConfig,
   messagebirdConfig,
   bulkSmsConfig,
@@ -216,6 +217,14 @@ export const smsProviders: IProviderConfig[] = [
     docReference: 'https://developers.clicksend.com/docs/rest/v3/?javascript--nodejs#send-sms',
     logoFileName: { light: 'clicksend.png', dark: 'clicksend.png' },
   },
+  {
+    id: SmsProviderIdEnum.Simpletexting,
+    displayName: `SimpleTexting`,
+    channel: ChannelTypeEnum.SMS,
+    credentials: simpleTextingConfig,
+    docReference: 'https://simpletexting.com/api/docs/v2/',
+    logoFileName: { light: 'simpletexting.png', dark: 'simpletexting.png' },
+  },
   {
     id: SmsProviderIdEnum.Bandwidth,
     displayName: `Bandwidth`,

diff --git a/libs/shared/src/consts/providers/credentials/provider-credentials.ts b/libs/shared/src/consts/providers/credentials/provider-credentials.ts
@@ -803,6 +803,16 @@ export const clickSendConfig: IConfigCredentials[] = [
   ...smsConfigBase,
 ];
 
+export const simpleTextingConfig: IConfigCredentials[] = [
+  {
+    key: CredentialsKeyEnum.ApiKey,
+    displayName: 'API Key',
+    type: 'text',
+    required: true,
+  },
+  ...smsConfigBase,
+];
+
 export const bandwidthConfig: IConfigCredentials[] = [
   {
     key: CredentialsKeyEnum.User,

diff --git a/libs/shared/src/consts/providers/provider.enum.ts b/libs/shared/src/consts/providers/provider.enum.ts
@@ -85,6 +85,7 @@ export enum SmsProviderIdEnum {
   Clicksend = 'clicksend',
   Bandwidth = 'bandwidth',
   MessageBird = 'messagebird',
+  Simpletexting = 'simpletexting',
 }
 
 export enum ChatProviderIdEnum {

diff --git a/packages/application-generic/package.json b/packages/application-generic/package.json
@@ -89,6 +89,7 @@
     "@novu/sendchamp": "^0.21.0",
     "@novu/sendgrid": "^0.21.0",
     "@novu/sendinblue": "^0.21.0",
+    "@novu/simpletexting": "^0.21.0",
     "@novu/ses": "^0.21.0",
     "@novu/shared": "^0.21.0",
     "@novu/slack": "^0.21.0",

diff --git a/packages/application-generic/src/factories/sms/handlers/index.ts b/packages/application-generic/src/factories/sms/handlers/index.ts
@@ -16,6 +16,7 @@ export * from './sms-central.handler';
 export * from './africas-talking.handler';
 export * from './sendchamp.handler';
 export * from './clicksend.handler';
+export * from './simpletexting.handler';
 export * from './bandwidth.handler';
 export * from './novu.handler';
 export * from './generic-sms.handler';

diff --git a/packages/application-generic/src/factories/sms/handlers/simpletexting.handler.ts b/packages/application-generic/src/factories/sms/handlers/simpletexting.handler.ts
@@ -0,0 +1,18 @@
+import { ChannelTypeEnum, ICredentials } from '@novu/shared';
+import { SimpletextingSmsProvider } from '@novu/simpletexting';
+import { BaseSmsHandler } from './base.handler';
+
+export class SimpletextingSmsHandler extends BaseSmsHandler {
+  constructor() {
+    super('simpletexting', ChannelTypeEnum.SMS);
+  }
+
+  buildProvider(credentials: ICredentials) {
+    const config = {
+      apiKey: credentials.apiKey,
+      accountPhone: credentials.from,
+    };
+
+    this.provider = new SimpletextingSmsProvider(config);
+  }
+}
diff --git a/packages/application-generic/src/factories/sms/sms.factory.ts b/packages/application-generic/src/factories/sms/sms.factory.ts
@@ -19,10 +19,11 @@ import {
   AfricasTalkingSmsHandler,
   SendchampSmsHandler,
   ClicksendSmsHandler,
+  SimpletextingSmsHandler,
   BandwidthHandler,
-  NovuSmsHandler,
   GenericSmsHandler,
   MessageBirdHandler,
+  NovuSmsHandler,
 } from './handlers';
 
 export class SmsFactory implements ISmsFactory {
@@ -45,10 +46,11 @@ export class SmsFactory implements ISmsFactory {
     new AfricasTalkingSmsHandler(),
     new SendchampSmsHandler(),
     new ClicksendSmsHandler(),
+    new SimpletextingSmsHandler(),
     new BandwidthHandler(),
-    new NovuSmsHandler(),
     new GenericSmsHandler(),
     new MessageBirdHandler(),
+    new NovuSmsHandler(),
   ];
 
   getHandler(integration: IntegrationEntity) {