nigerian-mobile-validator
Version:
The most rigorous, up-to-date library for validating Nigerian mobile numbers. Fully NCC-compliant, and security-focused, with enterprise-grade features to prevent the business risks of validation failures in regulated industries.
155 lines (154 loc) • 6.51 kB
JavaScript
;
// src/number-validation/batch-validator.ts
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
var desc = Object.getOwnPropertyDescriptor(m, k);
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
desc = { enumerable: true, get: function() { return m[k]; } };
}
Object.defineProperty(o, k2, desc);
}) : (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;
};
var __importDefault = (this && this.__importDefault) || function (mod) {
return (mod && mod.__esModule) ? mod : { "default": mod };
};
Object.defineProperty(exports, "__esModule", { value: true });
exports.batchValidate = void 0;
const fs = __importStar(require("fs"));
const nigerian_mobile_number_validator_1 = require("../../number-validation/nigerian-mobile-number-validator");
const csv_writer_1 = require("csv-writer");
const chance_1 = __importDefault(require("chance"));
const test_data_generator_base_1 = require("../synthetic-data/test-data-generator-base");
// Initialize Chance with a seed for reproducibility if needed
const chance = new chance_1.default();
/**
* Implementation of BatchValidationResults
*/
class BatchValidationResultsImpl {
constructor(results, validCount, invalidCount, processingTimeMs) {
this.results = results;
this.validCount = validCount;
this.invalidCount = invalidCount;
this.processingTimeMs = processingTimeMs;
}
async exportToCsv(filePath) {
const csvWriter = (0, csv_writer_1.createObjectCsvWriter)({
path: filePath,
header: [
{ id: 'number', title: 'PHONE_NUMBER' },
{ id: 'valid', title: 'IS_VALID' },
{ id: 'status', title: 'STATUS' },
{ id: 'message', title: 'MESSAGE' },
{ id: 'telco', title: 'TELCO' },
{ id: 'networkCode', title: 'NETWORK_CODE' },
{ id: 'msisdn', title: 'INTERNATIONAL_FORMAT' }
]
});
const records = this.results.map(result => {
var _a, _b, _c;
return ({
number: result.userProvidedDigits,
valid: result.validationSucceeded ? 'YES' : 'NO',
status: result.validationStatus,
message: result.validationSucceeded ? 'Success' : result.userMessage,
telco: result.validationSucceeded ? (_a = result.mobileNumber) === null || _a === void 0 ? void 0 : _a.telco : '',
networkCode: result.validationSucceeded ? (_b = result.mobileNumber) === null || _b === void 0 ? void 0 : _b.networkCode : '',
msisdn: result.validationSucceeded ? (_c = result.mobileNumber) === null || _c === void 0 ? void 0 : _c.msisdn : ''
});
});
await csvWriter.writeRecords(records);
}
}
/**
* Validates a batch of Nigerian mobile numbers
*/
async function batchValidate(numbers, options = {}) {
var _a, _b;
const startTime = performance.now();
const validator = (_a = options.validator) !== null && _a !== void 0 ? _a : new nigerian_mobile_number_validator_1.NigerianMobileNumberValidator();
const concurrency = (_b = options.concurrency) !== null && _b !== void 0 ? _b : 1000;
let validCount = 0;
let invalidCount = 0;
// Process in chunks to avoid memory issues with large arrays
const results = [];
// Process in batches based on concurrency
for (let i = 0; i < numbers.length; i += concurrency) {
const chunk = numbers.slice(i, i + concurrency);
const chunkResults = chunk.map(number => {
const result = validator.validate(number);
if (result.validationSucceeded) {
validCount++;
}
else {
invalidCount++;
}
return result;
});
results.push(...chunkResults);
}
const endTime = performance.now();
const processingTimeMs = endTime - startTime;
// Clean up if we created the validator
if (!options.validator) {
validator.dispose();
}
return new BatchValidationResultsImpl(results, validCount, invalidCount, processingTimeMs);
}
exports.batchValidate = batchValidate;
/**
* Additional methods for batch validation
*/
batchValidate.fromFile = async function (filePath, options = {}) {
try {
const data = await fs.promises.readFile(filePath, 'utf8');
const numbers = data
.split(/\r?\n/)
.map(line => line.trim())
.filter(line => line.length > 0);
return batchValidate(numbers, options);
}
catch (error) {
if (options.continueOnError) {
return new BatchValidationResultsImpl([], 0, 0, 0);
}
throw error;
}
};
/**
* Performance testing for batch validation
*/
batchValidate.benchmark = async function (sampleSize = 10000) {
// Generate test phone numbers (mix of valid and invalid)
const networkCodes = test_data_generator_base_1.TestDataGeneratorBase.allValidNetworkCodes.concat(test_data_generator_base_1.TestDataGeneratorBase.invalidNetworkCodes);
const numbers = [];
for (let i = 0; i < sampleSize; i++) {
const networkCode = chance.pickone(networkCodes);
const subscriberNumber = test_data_generator_base_1.TestDataGeneratorBase.randomSubscriberNumber(networkCode);
numbers.push(`0${networkCode}${subscriberNumber}`);
}
const startTime = performance.now();
await batchValidate(numbers);
const endTime = performance.now();
const totalTimeMs = endTime - startTime;
const validationsPerSecond = Math.floor((sampleSize / totalTimeMs) * 1000);
const averageValidationTimeMs = totalTimeMs / sampleSize;
return {
validationsPerSecond,
averageValidationTimeMs,
totalTimeMs
};
};