feat(providers): tnz sms

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

@@ -30,3 +30,4 @@ export * from './sns.handler';
 export * from './telnyx.handler';
 export * from './termii.handler';
 export * from './twilio.handler';
+export * from './tnz-sms.handler';

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

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

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

@@ -30,6 +30,7 @@ import {
   SnsHandler,
   TelnyxHandler,
   TermiiSmsHandler,
+  TnzSmsHandler,
   TwilioHandler,
 } from './handlers';
 import { ISmsFactory, ISmsHandler } from './interfaces';
@@ -67,6 +68,7 @@ export class SmsFactory implements ISmsFactory {
     new EazySmsHandler(),
     new MobishastraHandler(),
     new AfroSmsHandler(),
+    new TnzSmsHandler(),
   ];
 
   getHandler(integration: IntegrationEntity) {

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

@@ -37,4 +37,5 @@ export const smsProviderSchemas = {
   termii: genericProviderSchemas,
   twilio: twilioProviderSchemas,
   'afro-message': genericProviderSchemas,
+  'tnz-sms': genericProviderSchemas,
 } as const satisfies Record<SmsProviderIdEnum, { output: JsonSchema }>;

packages/framework/src/shared.ts

@@ -157,6 +157,7 @@ export enum SmsProviderIdEnum {
   EazySms = 'eazy-sms',
   Mobishastra = 'mobishastra',
   AfroSms = 'afro-message',
+  Tnz = 'tnz-sms',
 }
 
 export enum ChatProviderIdEnum {

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

@@ -31,3 +31,4 @@ export * from './telnyx/telnyx.interface';
 export * from './telnyx/telnyx.provider';
 export * from './termii/termii.provider';
 export * from './twilio/twilio.provider';
+export * from './tnz-sms/tnz-sms.provider';

packages/providers/src/lib/sms/tnz-sms/tnz-sms.provider.ts

@@ -0,0 +1,95 @@
+import { ChannelTypeEnum, ISendMessageSuccessResponse, ISmsOptions, ISmsProvider } from '@novu/stateless';
+import axios, { AxiosInstance } from 'axios';
+import { SmsProviderIdEnum } from '@novu/shared';
+import { BaseProvider, CasingEnum } from '../../../base.provider';
+import { WithPassthrough } from '../../../utils/types';
+
+export class TnzSmsProvider extends BaseProvider implements ISmsProvider {
+  id = SmsProviderIdEnum.Tnz;
+  channelType = ChannelTypeEnum.SMS as ChannelTypeEnum.SMS;
+  protected casing: CasingEnum = CasingEnum.PASCAL_CASE;
+  private readonly BASE_URL = 'https://api.tnz.co.nz/api/v2.04/send/';
+  private axiosInstance: AxiosInstance;
+
+  constructor(
+    private config: {
+      authToken: string;
+    }
+  ) {
+    super();
+
+    // Handle auth token format - accept either just the token or full "Basic TOKEN" format
+    const authToken = this.config.authToken.startsWith('Basic ')
+      ? this.config.authToken
+      : `Basic ${this.config.authToken}`;
+
+    this.axiosInstance = axios.create({
+      baseURL: this.BASE_URL,
+      headers: {
+        'Content-Type': "application/json; encoding='utf-8'",
+        Accept: "application/json; encoding='utf-8'",
+        Authorization: authToken,
+      },
+    });
+  }
+
+  async sendMessage(
+    options: ISmsOptions,
+    bridgeProviderData: WithPassthrough<Record<string, unknown>> = {}
+  ): Promise<ISendMessageSuccessResponse> {
+    const { to, content, customData } = options;
+
+    const destination = { Recipient: to };
+    const messageData = {
+      Message: content,
+      Destinations: [destination],
+    };
+
+    // Add optional TNZ fields if provided in customData
+    if (customData) {
+      const optionalFields = [
+        'MessageID',
+        'Reference',
+        'WebhookCallbackURL',
+        'WebhookCallbackFormat',
+        'SendTime',
+        'TimeZone',
+        'SubAccount',
+        'Department',
+        'ChargeCode',
+        'FromNumber',
+        'SMSEmailReply',
+        'CharacterConversion',
+        'Files',
+      ];
+
+      for (const field of optionalFields) {
+        if (customData[field] !== undefined) {
+          messageData[field] = customData[field];
+        }
+      }
+    }
+
+    const payload = { MessageData: messageData };
+
+    const data = this.transform(bridgeProviderData, payload);
+
+    try {
+      const response = await this.axiosInstance.post('sms', data.body);
+
+      if (response.data.Result === 'Success' || response.data.MessageID) {
+        return {
+          id: response.data.MessageID,
+          date: new Date().toISOString(),
+        };
+      } else {
+        throw new Error('Unexpected response format from TNZ API');
+      }
+    } catch (error) {
+      if (error.response?.data?.ErrorMessage) {
+        throw new Error(`TNZ API Error: ${error.response.data.ErrorMessage}`);
+      }
+      throw error;
+    }
+  }
+}