@speedup/notification-sms-smsir
Version:
SMS notification implementation for SMS.ir
206 lines (205 loc) • 9.68 kB
JavaScript
"use strict";
/**
* SMS sender
*/
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
return new (P || (P = Promise))(function (resolve, reject) {
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
step((generator = generator.apply(thisArg, _arguments || [])).next());
});
};
var __generator = (this && this.__generator) || function (thisArg, body) {
var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
function verb(n) { return function (v) { return step([n, v]); }; }
function step(op) {
if (f) throw new TypeError("Generator is already executing.");
while (_) try {
if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
if (y = 0, t) op = [op[0] & 2, t.value];
switch (op[0]) {
case 0: case 1: t = op; break;
case 4: _.label++; return { value: op[1], done: false };
case 5: _.label++; y = op[1]; op = [0]; continue;
case 7: op = _.ops.pop(); _.trys.pop(); continue;
default:
if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
if (t[2]) _.ops.pop();
_.trys.pop(); continue;
}
op = body.call(thisArg, _);
} catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
}
};
var __importDefault = (this && this.__importDefault) || function (mod) {
return (mod && mod.__esModule) ? mod : { "default": mod };
};
Object.defineProperty(exports, "__esModule", { value: true });
var axios_1 = __importDefault(require("axios"));
var ms_1 = __importDefault(require("ms"));
var AUTH_TOKEN_HEADER_KEY = 'x-sms-ir-secure-token';
var DEFAULT_AUTH_TIMEOUT = '30m'; // default is 30 minutes
var SMSSender = /** @class */ (function () {
function SMSSender(config) {
/**
* Authentication information
*/
this.cache = {
/**
* Current credit
*/
credit: 0,
/**
* Last authentication retry
*/
lastAuthRetry: 0,
/**
* Current authentication token
*/
authToken: ''
};
if (!config) {
throw new Error('config cannot be null or empty');
}
this.config = config;
this.httpClient = axios_1.default.create({
baseURL: 'https://restfulsms.com/api',
headers: {
'Content-Type': 'application/json'
},
timeout: ms_1.default('10s')
});
}
/**
* Renew the authentication token
*/
SMSSender.prototype.renewToken = function () {
return __awaiter(this, void 0, void 0, function () {
var authResponse;
return __generator(this, function (_a) {
switch (_a.label) {
case 0:
// not reached the threshold
if (Date.now() - this.cache.lastAuthRetry < ms_1.default(this.config.authTimeout || DEFAULT_AUTH_TIMEOUT)) {
return [2 /*return*/];
}
return [4 /*yield*/, this.httpClient.post('/Token', {
UserApiKey: this.config.apiKey,
SecretKey: this.config.secret
}, {
validateStatus: function (status) { return status === 201; }
})];
case 1:
authResponse = _a.sent();
if (!authResponse.data.IsSuccessful) {
throw new Error("Invalid response: " + authResponse.data.Message);
}
// attach token & update the interval
this.cache.authToken = authResponse.data.TokenKey;
this.cache.lastAuthRetry = Date.now();
return [2 /*return*/];
}
});
});
};
/**
* Retrieve current balance
*/
SMSSender.prototype.currentBalance = function () {
return __awaiter(this, void 0, void 0, function () {
var balanceResponse;
var _a;
return __generator(this, function (_b) {
switch (_b.label) {
case 0:
// renew token
return [4 /*yield*/, this.renewToken()];
case 1:
// renew token
_b.sent();
return [4 /*yield*/, this.httpClient.get('/credit', {
headers: (_a = {},
_a[AUTH_TOKEN_HEADER_KEY] = this.cache.authToken,
_a),
validateStatus: function (status) { return status === 201; }
})];
case 2:
balanceResponse = _b.sent();
if (!balanceResponse.data.IsSuccessful) {
throw new Error("Invalid response: " + balanceResponse.data.Message);
}
this.cache.credit = balanceResponse.data.Credit;
return [2 /*return*/, this.cache.credit];
}
});
});
};
/**
* Send a message to a specific user
* @param phoneNumber Target phone number
* @param message Message content
* @param config Send configuration
*/
SMSSender.prototype.send = function (phoneNumber, message, config) {
return __awaiter(this, void 0, void 0, function () {
var currentCredit, sendResponse, msg;
var _a;
return __generator(this, function (_b) {
switch (_b.label) {
case 0:
if (!config) {
throw new Error('config cannot be null or empty');
}
// renew token
return [4 /*yield*/, this.renewToken()];
case 1:
// renew token
_b.sent();
return [4 /*yield*/, this.currentBalance()];
case 2:
currentCredit = _b.sent();
if (currentCredit < 1) {
throw new Error("Current credit is less than 1. So it's not acceptable. Current credit: " + currentCredit);
}
return [4 /*yield*/, this.httpClient.post('/MessageSend', {
Messages: [message],
MobileNumbers: [phoneNumber],
LineNumber: config === null || config === void 0 ? void 0 : config.lineNumber,
SendDateTime: config === null || config === void 0 ? void 0 : config.sendDateTime,
CanContinueInCaseOfError: config === null || config === void 0 ? void 0 : config.canContinueInCaseOfError
}, {
headers: (_a = {},
_a[AUTH_TOKEN_HEADER_KEY] = this.cache.authToken,
_a),
validateStatus: function (status) { return status === 201; }
})];
case 3:
sendResponse = _b.sent();
if (!sendResponse.data.IsSuccessful) {
throw new Error("Invalid response: " + sendResponse.data.Message);
}
// retrieve current balance again
return [4 /*yield*/, this.currentBalance()];
case 4:
// retrieve current balance again
_b.sent();
msg = sendResponse.data.Ids[0];
return [2 /*return*/, {
messageId: msg.ID,
phoneNumber: msg.MobileNo,
batchKey: sendResponse.data.BatchKey
}];
}
});
});
};
return SMSSender;
}());
exports.default = SMSSender;