unismsgateway 1.0.0 → 1.1.0

package/README.md

@@ -0,0 +1,70 @@
+
+# Unified Sms Gateway
+
+Most of the time a single project relies on multiple sms Gateway so it can switched if one goes off.
+However, each sms api specification is different from the other, hence the need to create separate implementation
+for each sms gateway.
+
+Unified sms gateway is library that brings most common sms gateways under a Unified api.
+which means you only does one implementation in it works for all supported sms gateway. 
+you just have select or switch your sms platform and your code still works fine like nothing has changed
+
+
+## Usage/Examples
+
+```javascript
+const unisms = require('unismsgateway')
+
+const param = { clientId, // hubtel sms client Id **optional
+                clientSecret, // hubtel sms client secret ** optional
+                username, // username for route sms
+                password, // password for route sms
+                host,  // host address eg. rslr.connectbind.....
+                port} // port defaults to 8080
+
+//init with prefered platform id. route => routemobile, hubtel => hubtel sms
+// more sms services will be added or supported in the future
+const gateway  = unisms.init({platformId:'route', param})
+
+```
+
+### SEND MESSAGE
+```javascript
+
+const testSms = async function(){
+  try{
+    // const gateway = unisms.getSmsPlatform();
+     await gateway.quickSend({From:'xxxxx', To: xxxxxxxx, Content: 'Testing unisms', Type: 0}, (response)=>{
+      console.log(response)
+    }).then(r => {
+      console.log(r)
+    }).catch(err => {
+      console.log(err)
+    })
+  }catch(err){
+    console.log(err)
+  }
+
+
+}
+
+```
+
+
+## supported bulk sms gateways
+
+Hubtel bulk sms (Ghana) using hubtel-sms-extended
+routeMobile sms (India) using routemobilesms
+Nest SMS(Ghana) using nestsms
+
+## Roadmap
+
+- Additional browser support
+
+- Add more third party sms integrations
+
+
+## License
+
+[MIT](https://choosealicense.com/licenses/mit/)
+

package/dist/lib/lib.d.ts

@@ -1,3 +1,9 @@
 import { smsPlatform, IgatewaySettings } 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;

package/dist/lib/lib.js

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

package/dist/lib/platform.d.ts

@@ -15,10 +15,22 @@ export interface IgatewaySettings {
     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"
 }

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.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) {
@@ -21,6 +41,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 +60,17 @@ 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");
         }
     }
 }
 exports.smsPlatform = smsPlatform;
+var AuthTypes;
+(function (AuthTypes) {
+    AuthTypes["factor"] = "factor";
+    AuthTypes["key"] = "key";
+})(AuthTypes = exports.AuthTypes || (exports.AuthTypes = {}));

package/package.json

@@ -1,13 +1,14 @@
 {
   "name": "unismsgateway",
-  "version": "1.0.0",
-  "description": "",
+  "version": "1.1.0",
+  "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",
   "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 +22,7 @@
   },
   "dependencies": {
     "hubtel-sms-extended": "^1.0.2",
-    "routemobilesms": "^1.0.3"
+    "nestsms": "^1.1.2",
+    "routemobilesms": "^1.0.4"
   }
 }