Added transactional SMS flow

.gitignore

@@ -7,4 +7,6 @@ npm-debug.log
 *.sublime-project
 *.sublime-workspace
 .vscode
-out/
+out/
+.devcontainer
+test.js

CHANGELOG.md

@@ -8,3 +8,6 @@
 - followed some basic eslint rules
 - Modified Readme with aysnc/await examples
 - Error handling
+
+#### 2.0.3 (Jan 15, 2022)
+- Added support for Transactional SMS flow

index.js

@@ -5,7 +5,8 @@
 'use-strict';
 
 const msg91OTP = require('./src/msg91OTP');
+const msg91SMS = require('./src/msg91SMS');
 
 module.exports = {
-  msg91OTP,
+  msg91OTP,msg91SMS,
 };

package.json

@@ -1,6 +1,6 @@
 {
   "name": "msg91-lib",
-  "version": "2.0.2",
+  "version": "2.0.3",
   "description": "Unofficial msg91 library to send OTP & messages",
   "main": "index.js",
   "scripts": {

src/errorUtility.js

@@ -7,6 +7,8 @@ const errorCodes = {};
 requestError('BAD_REQUEST_DATA', '%s', 400);
 requestError('NO_AUTH_KEY', 'You need to pass MSG91 auth key.', 400);
 requestError('NO_TEMPLATE_ID', 'You need to pass MSG91 valid template ID.', 400);
+requestError('NO_FLOW_ID', 'You need to pass MSG91 valid flow ID.', 400);
+requestError('NO_SENDER_ID', 'You need to pass MSG91 valid sender ID.', 400);
 
 function requestError(code, message, statusCode = 400, error_data = {}, Base = Error) {
   if (!code) throw new Error('Backend error code must not be empty');

src/msg91SMS.js

@@ -0,0 +1,61 @@
+'use strict';
+
+const makeRequest = require('./requestUtility');
+const { errorCodes } = require('./errorUtility');
+class Msg91Sms {
+  /**
+   * Creates a new SendSMS instance
+   * @param {string} authKey Authentication key.
+   * @param {string} FlowId of message to send.
+   */
+  constructor(args = {}) {
+    if (!args.authKey) throw new errorCodes['NO_AUTH_KEY']();
+    /*
+     * if (!args.flowId) throw new errorCodes['NO_FLOW_ID']();
+     * if (!args.senderId) throw new errorCodes['NO_SENDER_ID'](); 
+     */
+    this.authKey = args.authKey;
+
+    this.baseUrl = args.baseUrl || 'https://api.msg91.com/api';
+    this.apiVersion = args.apiVersion || 'v5';
+
+    this.APIs = {
+      sendSms: { url: `${this.baseUrl}/${this.apiVersion}/flow`, method: 'POST' },
+    };
+
+    this.send = this.send.bind(this);
+    // this.makeRequest = this.makeRequest.bind(this);
+  }
+
+  /**
+   * Send Otp to given mobile number
+   * @param {string} contactNumber receiver's mobile number along with country code
+   * @param {object, optional} args
+   * @param {object, optional} custom_vars custom varaiables for DLT templates
+   * Return promise
+   */
+  async send(contactNumber, args = {}, custom_vars = {}) {
+    const smsParams = {
+      mobiles: contactNumber,
+      flow_id: args.flow_id,
+      sender: args.sender,
+    };
+    for (const [key, value] of Object.entries(custom_vars))
+      smsParams[key]=value;
+
+    const options = {
+      url: this.APIs['sendSms'].url,
+      method: this.APIs['sendSms'].method,
+      params: '',
+      headers:  {
+        'authkey': this.authKey,
+        'Content-Type': 'application/json',
+      },
+      postData: JSON.stringify(smsParams),
+    };
+    return await makeRequest(options);
+  }
+
+}
+
+module.exports = Msg91Sms;

types/index.d.ts

@@ -27,3 +27,25 @@ declare class Msg91Otp {
 }
 
 export { Msg91Otp as msg91OTP };
+
+interface IMsg91SmsConstructorArgs {
+  authKey: string;
+  templateId: string;
+  baseUrl?: string;
+  apiVersion?: string;
+  otpExpiry?: number;
+  otpLength?: number;
+}
+
+interface IMsg91SendSmsArgs {
+  flow_id: string;
+  sender: string;
+}
+
+declare class Msg91Sms {
+  constructor(args: IMsg91SmsConstructorArgs);
+
+  send(contactNumber: string | number, args?: IMsg91SendSmsArgs, custom_vars?: any): Promise<any>;
+}
+
+export { Msg91Sms as msg91SMS };