unismsgateway 1.0.3 → 1.2.1

package/README.md

@@ -46,6 +46,29 @@ const testSms = async function(){
   }
 
 
+}
+
+```
+
+### SEND PERSONALIZED MESSAGE
+```javascript
+
+const testSms = async function(){
+  try{
+    // const gateway = unisms.getSmsPlatform();
+     await gateway.sendPersonalized({From:'xxxxx', 
+                                    To: {to: 233XXXXXXXXX, values: ['Alpha', 65332]},  // [{to: 233XXXXXXXXX, values: ['Alpha', 65332]}, {to: 211XXXXXXXXX, values: ['James', 2000]}, ]
+                                    Content: 'Testing unisms', 
+                                    Type: 0}).then(r => {
+      console.log(r)
+    }).catch(err => {
+      console.log(err)
+    })
+  }catch(err){
+    console.log(err)
+  }
+
+
 }
 
 ```
@@ -55,8 +78,7 @@ const testSms = async function(){
 
 Hubtel bulk sms (Ghana) using hubtel-sms-extended
 routeMobile sms (India) using routemobilesms
-
-
+Nest SMS(Ghana) using nestsms
 
 ## Roadmap
 

package/dist/lib/lib.d.ts

@@ -1,3 +1,10 @@
-import { smsPlatform, IgatewaySettings } from './platform';
+import { smsPlatform, IgatewaySettings, IQuickSendPersonalized } from './platform';
 export declare function init(settings: IgatewaySettings): smsPlatform;
 export declare function getSmsPlatform(): smsPlatform;
+export declare function quickSend(param: {
+    From: string;
+    To: number;
+    Content: string;
+    Type?: number;
+}, callback?: Function): any;
+export declare function sendPersonalized(body: IQuickSendPersonalized): any;

package/dist/lib/lib.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getSmsPlatform = exports.init = void 0;
+exports.sendPersonalized = exports.quickSend = exports.getSmsPlatform = exports.init = void 0;
 const platform_1 = require("./platform");
 let smsplatform;
 function init(settings) {
@@ -13,3 +13,11 @@ function getSmsPlatform() {
     return smsplatform;
 }
 exports.getSmsPlatform = getSmsPlatform;
+function quickSend(param, callback) {
+    return smsplatform.quickSend(param, callback);
+}
+exports.quickSend = quickSend;
+function sendPersonalized(body) {
+    return smsplatform.sendPersonalized(body);
+}
+exports.sendPersonalized = sendPersonalized;

package/dist/lib/platform.d.ts

@@ -9,16 +9,43 @@ export declare class smsPlatform {
         Content: string;
         Type?: number;
     }, callback?: Function): any;
+    sendPersonalized(body: IQuickSendPersonalized): any;
 }
 export interface IgatewaySettings {
     platformId: string;
     param: IgatewayParam;
 }
 export interface IgatewayParam {
-    host?: string;
+    host: string;
     port?: number;
     username?: string;
     password?: string;
     clientId?: string;
     clientSecret?: string;
+    version: string;
+    authModel: AuthModel;
+}
+export interface AuthModel {
+    type: AuthTypes;
+    username?: string;
+    password?: string;
+    key?: string;
+}
+export declare enum AuthTypes {
+    factor = "factor",
+    key = "key"
+}
+export interface IQuickSendPersonalized {
+    From: string;
+    Content: string;
+    Type: MessageTypes;
+    To: IPersonalizedDestination | IPersonalizedDestination[];
+}
+export interface IPersonalizedDestination {
+    to: number;
+    values: (string | number)[];
+}
+export declare enum MessageTypes {
+    Text = 0,
+    flash = 1
 }

package/dist/lib/platform.js

@@ -1,9 +1,29 @@
 "use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.smsPlatform = void 0;
+exports.MessageTypes = exports.AuthTypes = exports.smsPlatform = void 0;
 // const routesms = require('routesms')
 const hubtel_sms_extended_1 = require("hubtel-sms-extended");
 const routemobilesms_1 = require("routemobilesms");
+const nestsms = __importStar(require("nestsms"));
 // routeSms.engine
 class smsPlatform {
     constructor(settings) {
@@ -12,7 +32,13 @@ class smsPlatform {
     init() {
         if (this._settings.platformId === 'route') {
             // this._sms = routesms;
-            this._sms = new routemobilesms_1.routeSms({ host: 'rslr.connectbind.com', username: 'nety-dntc', password: '@Alpha12', protocol: 'http', port: 8080 });
+            this._sms = new routemobilesms_1.routeSms({
+                host: this._settings.param.host,
+                username: this._settings.param.username,
+                password: this._settings.param.password,
+                protocol: 'http',
+                port: 8080
+            });
             // this._sms = routeSms;
             // console.log(this._sms, this._sms.connection)  
             // this._sms.connection = this._settings.param;
@@ -21,6 +47,14 @@ class smsPlatform {
             // console.log(this._settings)
             this._sms = new hubtel_sms_extended_1.HubtelSms({ clientId: this._settings.param.clientId, clientSecret: this._settings.param.clientSecret });
         }
+        else if (this._settings.platformId === 'nest') {
+            // console.log(this._settings)
+            this._sms = nestsms.init({
+                host: this._settings.param.host,
+                version: this._settings.param.version,
+                authModel: this._settings.param.authModel
+            });
+        }
         // console.log({sms: this._sms})
         return this;
     }
@@ -32,9 +66,28 @@ class smsPlatform {
         else if (this._settings.platformId === 'hubtel') {
             return this._sms.quickSend(param);
         }
+        else if (this._settings.platformId === 'nest') {
+            return this._sms.quickSend(param);
+        }
         else {
             throw new Error("Platform ID not recognised");
         }
     }
+    sendPersonalized(body) {
+        if (this._settings.platformId !== 'nest') {
+            throw new Error("Specified platform does not support personalisation");
+        }
+        return this._sms.sendPersonalized(body);
+    }
 }
 exports.smsPlatform = smsPlatform;
+var AuthTypes;
+(function (AuthTypes) {
+    AuthTypes["factor"] = "factor";
+    AuthTypes["key"] = "key";
+})(AuthTypes = exports.AuthTypes || (exports.AuthTypes = {}));
+var MessageTypes;
+(function (MessageTypes) {
+    MessageTypes[MessageTypes["Text"] = 0] = "Text";
+    MessageTypes[MessageTypes["flash"] = 1] = "flash";
+})(MessageTypes = exports.MessageTypes || (exports.MessageTypes = {}));

package/package.json

@@ -1,13 +1,18 @@
 {
   "name": "unismsgateway",
-  "version": "1.0.3",
+  "version": "1.2.1",
   "description": "A unified sms gateway library that brings access to multiple sms gateways under a single API",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/RazakAlpha/unismsgateway"
+  },
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1",
     "build": "tsc",
-    "prepublish": "npm run build"
+    "prepublish": "npm run build",
+    "publish": "git push --tags && npm publish"
   },
   "files": [
     "dist/**/*"
@@ -21,6 +26,7 @@
   },
   "dependencies": {
     "hubtel-sms-extended": "^1.0.2",
+    "nestsms": "^1.2.1",
     "routemobilesms": "^1.0.4"
   }
 }