Feat eazy sms

apps/api/src/app/integrations/dtos/credentials.dto.ts

@@ -201,4 +201,9 @@ export class CredentialsDto implements ICredentials {
   @IsString()
   @IsOptional()
   externalLink?: string;
+
+  @ApiPropertyOptional()
+  @IsString()
+  @IsOptional()
+  channelId?: string;
 }

apps/web/src/pages/integrations/components/multi-provider/sort-providers.ts

@@ -75,6 +75,7 @@
       SmsProviderIdEnum.Simpletexting,
       SmsProviderIdEnum.BrevoSms,
       SmsProviderIdEnum.ISendSms,
+      SmsProviderIdEnum.EazySms,
     ].sort(),
   ],
 };

libs/dal/src/repositories/integration/integration.schema.ts

@@ -58,6 +58,7 @@ const integrationSchema = new Schema<IntegrationDBModel>(
       state: Schema.Types.String,
       externalLink: Schema.Types.String,
       apiToken: Schema.Types.String,
+      channelId: Schema.Types.String,
     },
     active: {
       type: Schema.Types.Boolean,

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

@@ -28,6 +28,7 @@
   iSendSmsConfig,
   ringCentralConfig,
   brevoSmsConfig,
+  eazySmsConfig,
 } from '../credentials';
 import { SmsProviderIdEnum } from '../provider.enum';
 
@@ -271,4 +272,12 @@
     docReference: 'https://developers.brevo.com/reference/sendtransacsms',
     logoFileName: { light: 'brevo.svg', dark: 'brevo.svg' },
   },
+  {
+    id: SmsProviderIdEnum.EazySms,
+    displayName: `Eazy`,
+    channel: ChannelTypeEnum.SMS,
+    credentials: eazySmsConfig,
+    docReference: 'https://developers.eazy.im/#678805af-be7b-4487-93a4-c1007b7920f5',
+    logoFileName: { light: 'eazy-sms.svg', dark: 'eazy-sms.svg' },
+  },
 ];

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

@@ -1104,3 +1104,19 @@
   },
   ...smsConfigBase,
 ];
+
+export const eazySmsConfig: IConfigCredentials[] = [
+  {
+    key: CredentialsKeyEnum.ApiKey,
+    displayName: 'API Key',
+    type: 'string',
+    required: true,
+  },
+  {
+    key: CredentialsKeyEnum.channelId,
+    displayName: 'SMS Channel Id',
+    type: 'string',
+    required: true,
+    description: 'Your SMS Channel Id',
+  },
+];

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

@@ -44,6 +44,7 @@
   imageUrl = 'imageUrl',
   state = 'state',
   externalLink = 'externalLink',
+  channelId = 'channelId',
 }
 
 export enum EmailProviderIdEnum {
@@ -100,6 +101,7 @@
   AzureSms = 'azure-sms',
   RingCentral = 'ring-central',
   BrevoSms = 'brevo-sms',
+  EazySms = 'eazy-sms',
 }
 
 export enum ChatProviderIdEnum {

libs/shared/src/entities/integration/credential.interface.ts

@@ -42,4 +42,5 @@ export interface ICredentials {
   imageUrl?: string;
   state?: string;
   externalLink?: string;
+  channelId?: string;
 }

packages/application-generic/package.json

@@ -118,6 +118,7 @@
     "@novu/testing": "^0.24.1",
     "@novu/twilio": "^0.24.1",
     "@novu/zulip": "^0.24.1",
+    "@novu/eazy-sms": "^0.24.1",
     "@opentelemetry/api": "^1.7.0",
     "@opentelemetry/auto-instrumentations-node": "^0.40.2",
     "@opentelemetry/context-async-hooks": "^1.19.0",

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

@@ -0,0 +1,17 @@
+import { ChannelTypeEnum, ICredentials } from '@novu/shared';
+import { EazySmsProvider } from '@novu/eazy-sms';
+import { BaseSmsHandler } from './base.handler';
+
+export class EazySmsHandler extends BaseSmsHandler {
+  constructor() {
+    super('eazy-sms', ChannelTypeEnum.SMS);
+  }
+
+  buildProvider(credentials: ICredentials) {
+    const config = {
+      apiKey: credentials.apiKey,
+      channelId: credentials.channelId,
+    };
+    this.provider = new EazySmsProvider(config);
+  }
+}

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

@@ -27,3 +27,4 @@ export * from './nexmo.handler';
 export * from './isend-sms.handler';
 export * from './ring-central.handler';
 export * from './brevo-sms.handler';
+export * from './eazy-sms.handler';

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

@@ -29,6 +29,7 @@ import {
   ISendSmsHandler,
   RingCentralHandler,
   BrevoSmsHandler,
+  EazySmsHandler,
 } from './handlers';
 
 export class SmsFactory implements ISmsFactory {
@@ -61,6 +62,7 @@ export class SmsFactory implements ISmsFactory {
     new ISendSmsHandler(),
     new RingCentralHandler(),
     new BrevoSmsHandler(),
+    new EazySmsHandler(),
   ];
 
   getHandler(integration: IntegrationEntity) {

providers/eazy-sms/.czrc

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

providers/eazy-sms/.eslintrc.json

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

providers/eazy-sms/.gitignore

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

providers/eazy-sms/README.md

@@ -0,0 +1,14 @@
+# Novu Eazy SMS Provider
+
+A EazySms sms provider library for [@novu/node](https://github.com/novuhq/novu)
+
+## Usage
+
+```javascript
+import { EazySmsProvider } from '@novu/eazy-sms';
+
+const provider = new EazySmsProvider({
+    apiKey: process.env.API_KEY,
+    channelId: process.env.CHANNEL_ID,
+});
+```

providers/eazy-sms/jest.config.js

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

providers/eazy-sms/package.json

@@ -0,0 +1,78 @@
+{
+  "name": "@novu/eazy-sms",
+  "version": "0.24.1",
+  "description": "A eazy-sms 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"
+  },
+  "dependencies": {
+    "@novu/stateless": "0.24.1",
+    "axios": "^1.6.0"
+  },
+  "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/eazy-sms/src/index.ts

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

providers/eazy-sms/src/lib/eazy-sms.provider.spec.ts

@@ -0,0 +1,31 @@
+import { EazySmsProvider } from './eazy-sms.provider';
+
+const mockConfig = {
+  apiKey: 'test-key',
+  channelId: '[email protected]',
+};
+
+const mockSMSMessage = {
+  to: '1234567890',
+  content: 'sms content',
+};
+
+test('should trigger eazy-sms library correctly', async () => {
+  const smsProvider = new EazySmsProvider(mockConfig);
+  const spy = jest
+    .spyOn(smsProvider, 'sendMessage')
+    .mockImplementation(async () => {
+      return {
+        id: '2574a339-86ff',
+        date: new Date().toISOString(),
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+      } as any;
+    });
+
+  await smsProvider.sendMessage(mockSMSMessage);
+  expect(spy).toHaveBeenCalled();
+  expect(spy).toHaveBeenCalledWith({
+    content: 'sms content',
+    to: '1234567890',
+  });
+});