feat(provider): add clicksend sms provider

.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#ClickSend-v3-API-SMS',
+    logoFileName: { light: 'clicksend.png', dark: 'clicksend.png' },
+  },
 ];

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

@@ -740,3 +740,24 @@ export const sendchampConfig: IConfigCredentials[] = [
   },
   ...smsConfigBase,
 ];
+
+export const clickSendConfig: IConfigCredentials[] = [
+  {
+    key: CredentialsKeyEnum.ApiKey,
+    displayName: 'API Key',
+    type: 'text',
+    required: true,
+  },
+  {
+    key: CredentialsKeyEnum.User,
+    displayName: 'Username',
+    type: 'text',
+    required: true,
+  },
+  {
+    key: CredentialsKeyEnum.From,
+    displayName: 'From',
+    type: 'string',
+    required: true,
+  },
+];

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

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

packages/application-generic/package.json

@@ -51,6 +51,7 @@
     "@novu/apns": "^0.20.0-alpha.0",
     "@novu/burst-sms": "^0.20.0-alpha.0",
     "@novu/clickatell": "^0.20.0-alpha.0",
+    "@novu/clicksend": "^0.20.0-alpha.0",
     "@novu/dal": "^0.20.0-alpha.0",
     "@novu/discord": "^0.20.0-alpha.0",
     "@novu/email-webhook": "^0.20.0-alpha.0",

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

@@ -0,0 +1,23 @@
+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) {
+    if (!credentials.user || !credentials.apiKey || !credentials.from) {
+      throw Error('Invalid credentials');
+    }
+
+    const config = {
+      apiKey: credentials.apiKey,
+      username: credentials.user,
+      from: credentials.from,
+    };
+
+    this.provider = new ClicksendSmsProvider(config);
+  }
+}

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

@@ -16,3 +16,4 @@ export * from './sms-central.handler';
 export * from './africas-talking.handler';
 export * from './sendchamp.handler';
 export * from './novu.handler';
+export * from './clicksend.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(),
   ];
 

providers/clicksend/.czrc

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

providers/clicksend/.eslintrc.json

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

providers/clicksend/.gitignore

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

providers/clicksend/README.md

@@ -0,0 +1,14 @@
+# Novu Clicksend Provider
+
+A Clicksend sms provider library for [@novu/node](https://github.com/novuhq/novu)
+
+## Usage
+
+```javascript
+import { ClicksendSmsProvider } from '@novu/clicksend'
+
+const provider = new ClicksendSmsProvider({
+    apiKey: process.env.CLICKSEND_API_KEY,
+    username: process.env.CLICKSEND_USERNAME,
+    from: process.env.CLICKSEND_FROM
+```

providers/clicksend/jest.config.js

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

providers/clicksend/package.json

@@ -0,0 +1,83 @@
+{
+  "name": "@novu/clicksend",
+  "version": "0.20.0-alpha.0",
+  "description": "A clicksend 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"
+  },
+  "engines": {
+    "node": ">=13.0.0 <17.0.0",
+    "pnpm": "^7.26.0"
+  },
+  "dependencies": {
+    "@novu/stateless": "0.20.0-alpha.0",
+    "axios": "^1.5.1",
+    "clicksend": "^5.0.37"
+  },
+  "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/clicksend/src/index.ts

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

providers/clicksend/src/lib/clicksend.provider.spec.ts

@@ -0,0 +1,35 @@
+import { ClicksendSmsProvider } from './clicksend.provider';
+
+const mockConfig = {
+  apiKey: '<api-key>',
+  username: 'test-username',
+  from: 'clicksend',
+};
+
+const mockNovuMessage = {
+  to: '+61411111111',
+  content: 'sms content',
+};
+
+test('should trigger clicksend library correctly', async () => {
+  const smsProvider = new ClicksendSmsProvider(mockConfig);
+
+  const spy = jest
+    .spyOn(smsProvider, 'sendMessage')
+    .mockImplementation(async () => {
+      return {
+        id: 'BF7AD270-0DE2-418B-B606-71D527D9C1AE',
+        date: new Date().toISOString(),
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+      } as any;
+    });
+
+  await smsProvider.sendMessage(mockNovuMessage);
+
+  expect(spy).toHaveBeenCalled();
+
+  expect(spy).toHaveBeenCalledWith({
+    to: '+61411111111',
+    content: 'sms content',
+  });
+});

providers/clicksend/src/lib/clicksend.provider.ts

@@ -0,0 +1,43 @@
+import {
+  ChannelTypeEnum,
+  ISendMessageSuccessResponse,
+  ISmsOptions,
+  ISmsProvider,
+} from '@novu/stateless';
+
+// eslint-disable-next-line import/extensions
+const api = require('clicksend/api');
+
+export class ClicksendSmsProvider implements ISmsProvider {
+  id = 'clicksend';
+  channelType = ChannelTypeEnum.SMS as ChannelTypeEnum.SMS;
+
+  constructor(
+    private config: {
+      apiKey: string;
+      username: string;
+      from?: string;
+    }
+  ) {}
+
+  async sendMessage(
+    options: ISmsOptions
+  ): Promise<ISendMessageSuccessResponse> {
+    const smsApi = new api.SMSApi(this.config.username, this.config.apiKey);
+
+    const smsMessage = new api.SmsMessage();
+    smsMessage.from = this.config.from;
+    smsMessage.to = options.to;
+    smsMessage.body = options.content;
+
+    const smsCollection = new api.SmsMessageCollection();
+    smsCollection.messages = [smsMessage];
+
+    const response = await smsApi.smsSendPost(smsCollection);
+
+    return {
+      id: response.body.data.messages[0].message_id,
+      date: response.body.data.messages[0].date,
+    };
+  }
+}

providers/clicksend/tsconfig.json

@@ -0,0 +1,10 @@
+{
+  "extends": "../../tsconfig.json",
+  "compilerOptions": {
+    "outDir": "build/main",
+    "rootDir": "src",
+    "types": ["node", "jest"]
+  },
+  "include": ["src/**/*.ts"],
+  "exclude": ["node_modules/**"]
+}