feat(providers): add new messente sms connector

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

@@ -20,6 +20,7 @@ export * from './isendpro-sms.handler';
 export * from './kannel.handler';
 export * from './maqsam.handler';
 export * from './messagebird.handler';
+export * from './messente.handler';
 export * from './mobishastra.handler';
 export * from './nexmo.handler';
 export * from './novu.handler';

libs/application-generic/src/factories/sms/handlers/messente.handler.ts

@@ -0,0 +1,15 @@
+import { MessenteSmsProvider } from '@novu/providers';
+import { ChannelTypeEnum, ICredentials, SmsProviderIdEnum } from '@novu/shared';
+import { BaseSmsHandler } from './base.handler';
+
+export class MessenteSmsHandler extends BaseSmsHandler {
+  constructor() {
+    super(SmsProviderIdEnum.Messente, ChannelTypeEnum.SMS);
+  }
+  buildProvider(credentials: ICredentials) {
+    this.provider = new MessenteSmsProvider({
+      username: credentials.user,
+      password: credentials.password,
+    });
+  }
+}

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

@@ -22,6 +22,7 @@ import {
   KannelSmsHandler,
   MaqsamHandler,
   MessageBirdHandler,
+  MessenteSmsHandler,
   MobishastraHandler,
   NexmoHandler,
   NovuSmsHandler,
@@ -81,6 +82,7 @@ export class SmsFactory implements ISmsFactory {
     new BulkSmsHandler(),
     new ISendProSmsHandler(),
     new CmTelecomHandler(),
+    new MessenteSmsHandler(),
   ];
 
   getHandler(integration: Pick<IntegrationEntity, 'credentials' | 'channel' | 'providerId' | 'configurations'>) {

packages/framework/src/schemas/providers/sms/index.ts

@@ -42,4 +42,5 @@ export const smsProviderSchemas = {
   imedia: genericProviderSchemas,
   sinch: genericProviderSchemas,
   'isendpro-sms': genericProviderSchemas,
+  messente: genericProviderSchemas,
 } as const satisfies Record<SmsProviderIdEnum, { output: JsonSchema }>;

packages/framework/src/shared.ts

@@ -161,6 +161,7 @@ export enum SmsProviderIdEnum {
   IMedia = 'imedia',
   Sinch = 'sinch',
   ISendProSms = 'isendpro-sms',
+  Messente = 'messente',
 }
 
 export enum ChatProviderIdEnum {

packages/providers/package.json

@@ -74,6 +74,7 @@
     "qs": "^6.11.0",
     "resend": "^6.0.3",
     "sms77-client": "^2.14.0",
+    "messente_api": "^2.5.0",
     "svix": "^1.29.0",
     "telnyx": "^1.23.0",
     "twilio": "^4.19.3",

packages/providers/src/lib/sms/index.ts

@@ -20,6 +20,7 @@ export * from './isendpro-sms/isendpro-sms.provider';
 export * from './kannel/kannel.provider';
 export * from './maqsam/maqsam.provider';
 export * from './messagebird/messagebird.provider';
+export * from './messente/messente.provider';
 export * from './mobishastra/mobishastra.provider';
 export * from './nexmo/nexmo.provider';
 export * from './plivo/plivo.provider';

packages/providers/src/lib/sms/messente/messente.provider.ts

@@ -0,0 +1,96 @@
+import * as messente from 'messente_api';
+
+import { SmsProviderIdEnum } from "@novu/shared";
+import {
+  ChannelTypeEnum,
+  ISendMessageSuccessResponse,
+  ISmsOptions,
+  ISmsProvider,
+} from "@novu/stateless";
+import { BaseProvider, CasingEnum } from "../../../base.provider";
+import { WithPassthrough } from "../../../utils/types";
+
+type MessageChannel = 'sms' | 'viber' | 'whatsapp';
+
+interface MessagePayload {
+  readonly channel: MessageChannel;
+  readonly text: string;
+  readonly sender: string;
+}
+
+interface SendMessageRequest {
+  readonly to: string;
+  readonly messages: MessagePayload[];
+}
+
+interface MessageResponse {
+  readonly channel: MessageChannel;
+  readonly message_id: string;
+  readonly sender: string;
+}
+
+interface SendMessageResponse {
+  readonly to: string;
+  readonly messages: MessageResponse[];
+}
+
+export class MessenteSmsProvider extends BaseProvider implements ISmsProvider {
+  id = SmsProviderIdEnum.Messente;
+  channelType = ChannelTypeEnum.SMS as ChannelTypeEnum.SMS;
+  protected casing: CasingEnum = CasingEnum.CAMEL_CASE;
+  readonly #messente: messente.OmnimessageApi;
+
+  constructor(private readonly config: {
+    readonly username: string;
+    readonly password: string;
+  }) {
+    super();
+
+    const { instance } = messente.ApiClient;
+    const basicAuth = instance.authentications["basicAuth"];
+
+    basicAuth.username = config.username;
+    basicAuth.password = config.password;
+
+    this.#messente = new messente.OmnimessageApi();
+  }
+
+  async sendMessage(
+    options: ISmsOptions,
+    bridgeProviderData: WithPassthrough<Record<string, unknown>> = {},
+  ): Promise<ISendMessageSuccessResponse> {
+    const params = this.transform<SendMessageRequest>(bridgeProviderData, {
+      to: options.to,
+      messages: [
+        {
+          channel: 'sms',
+          text: options.content,
+          sender: options.from,
+        },
+      ],
+    }).body;
+
+    const response = await new Promise<SendMessageResponse>((resolve, reject) => {
+      this.#messente.sendOmnimessage(
+        {
+          to: params.to,
+          messages: params.messages,
+        },
+        (error: Error | null, data: SendMessageResponse) => {
+          if (error) {
+            reject(error);
+          } else {
+            resolve(data);
+          }
+        },
+      );
+    });
+
+    const [{ message_id }] = response.messages;
+
+    return {
+      id: message_id,
+      date: new Date().toISOString(),
+    };
+  }
+}

packages/providers/src/lib/sms/messente/messente.test.provider.spec.ts

@@ -0,0 +1,84 @@
+import { expect, test, vi } from 'vitest';
+import { MessenteSmsProvider } from './messente.provider';
+
+const sendOmnimessageMock = vi.hoisted(() => vi.fn());
+
+vi.mock('messente_api', () => ({
+  ApiClient: {
+    instance: {
+      authentications: {
+        basicAuth: { username: '', password: '' },
+      },
+    },
+  },
+  OmnimessageApi: vi.fn(() => ({
+    sendOmnimessage: sendOmnimessageMock,
+  })),
+}));
+
+test('should trigger messente library correctly', async () => {
+  sendOmnimessageMock.mockImplementation((_params, callback) => {
+    callback(null, {
+      to: '+176543',
+      messages: [{ channel: 'sms', message_id: 'test-message-id', sender: '+112345' }],
+    });
+  });
+
+  const provider = new MessenteSmsProvider({
+    username: 'test-username',
+    password: 'test-password',
+  });
+
+  const response = await provider.sendMessage({
+    to: '+176543',
+    content: 'SMS Content',
+    from: '+112345',
+  });
+
+  expect(sendOmnimessageMock).toHaveBeenCalledWith(
+    {
+      to: '+176543',
+      messages: [{ channel: 'sms', text: 'SMS Content', sender: '+112345' }],
+    },
+    expect.any(Function)
+  );
+  expect(response.id).toBe('test-message-id');
+});
+
+test('should trigger messente library correctly with _passthrough', async () => {
+  sendOmnimessageMock.mockImplementation((_params, callback) => {
+    callback(null, {
+      to: '+299999',
+      messages: [{ channel: 'sms', message_id: 'passthrough-message-id', sender: '+112345' }],
+    });
+  });
+
+  const provider = new MessenteSmsProvider({
+    username: 'test-username',
+    password: 'test-password',
+  });
+
+  const response = await provider.sendMessage(
+    {
+      to: '+176543',
+      content: 'SMS Content',
+      from: '+112345',
+    },
+    {
+      _passthrough: {
+        body: {
+          to: '+299999',
+        },
+      },
+    }
+  );
+
+  expect(sendOmnimessageMock).toHaveBeenCalledWith(
+    {
+      to: '+299999',
+      messages: [{ channel: 'sms', text: 'SMS Content', sender: '+112345' }],
+    },
+    expect.any(Function)
+  );
+  expect(response.id).toBe('passthrough-message-id');
+});

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

@@ -23,6 +23,7 @@ import {
   kannelConfig,
   maqsamConfig,
   messagebirdConfig,
+  messenteConfig,
   mobishastraConfig,
   nexmoConfig,
   plivoConfig,
@@ -350,4 +351,12 @@ export const smsProviders: IProviderConfig[] = [
     docReference: 'https://developers.cm.com/messaging/docs/sms',
     logoFileName: { light: 'cm-telecom.svg', dark: 'cm-telecom.svg' },
   },
+  {
+    id: SmsProviderIdEnum.Messente,
+    displayName: 'Messente',
+    channel: ChannelTypeEnum.SMS,
+    credentials: messenteConfig,
+    docReference: 'https://messente.com/docs',
+    logoFileName: { light: 'messente.svg', dark: 'messente.svg' },
+  }
 ];

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

@@ -1446,3 +1446,23 @@ export const cmTelecomConfig: IConfigCredential[] = [
   },
   ...smsConfigBase,
 ];
+
+export const messenteConfig: IConfigCredential[] = [
+  {
+    key: CredentialsKeyEnum.User,
+    displayName: 'Username',
+    description: 'Your Messente API username',
+    links: [{ text: 'Check Messente documentation', url: 'https://dashboard.messente.com/api-settings' }],
+    type: 'string',
+    required: true,
+  },
+  {
+    key: CredentialsKeyEnum.Password,
+    displayName: 'Password',
+    description: 'Your Messente API password',
+    links: [{ text: 'Check Messente documentation', url: 'https://dashboard.messente.com/api-settings' }],
+    type: 'string',
+    required: true,
+  },
+  ...smsConfigBase,
+];

packages/shared/src/types/providers.ts

@@ -124,6 +124,7 @@ export enum SmsProviderIdEnum {
   Sinch = 'sinch',
   ISendProSms = 'isendpro-sms',
   CmTelecom = 'cm-telecom',
+  Messente = 'messente',
 }
 
 export enum ChatProviderIdEnum {