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.
213 lines (212 loc) • 9.12 kB
JavaScript
// src/__tests__/synthetic-data/test-data-generator-base.ts
import { NetworkAccessCode } from '../../numbering-plan/network-access-code';
import { Telco, invalidTelcos } from '../../numbering-plan/telco';
import Chance from 'chance';
// Initialize Chance with a seed for reproducibility if needed
const chance = new Chance();
/**
* Base class with common test data generation functionality
*/
export class TestDataGeneratorBase {
/**
* Initialize the mappings of telcos to network codes
*/
static initialize() {
if (this.initialized)
return;
// Create record with empty arrays for each Telco
Object.values(Telco).forEach(telco => {
this._networkCodesByTelco[telco] = [];
});
// Populate based on the explicit mapping
Object.entries(this.networkCodeToTelcoMap).forEach(([codeKey, telco]) => {
// The key is the enum name (e.g., "703"), but we need to convert to the enum value
const networkCode = Number(codeKey);
// Skip invalid telcos && Skip 702 for special handling
if (!invalidTelcos.includes(telco) && networkCode !== NetworkAccessCode.n702) {
// This is an actively used network code - add it to the telco's list
this._networkCodesByTelco[telco].push(networkCode);
// Also add it to the overall valid network codes list
if (!this._allValidNetworkCodes.includes(networkCode)) {
this._allValidNetworkCodes.push(networkCode);
}
}
});
// Special handling for 702 - add to multiple telcos due to sub-ranges
this._networkCodesByTelco[Telco.Smile].push(NetworkAccessCode.n702);
this._networkCodesByTelco[Telco.InterconnectClearinghouse].push(NetworkAccessCode.n702);
this._networkCodesByTelco[Telco.Openskys].push(NetworkAccessCode.n702);
this._networkCodesByTelco[Telco.Visafone].push(NetworkAccessCode.n702);
this._networkCodesByTelco[Telco.Withdrawn].push(NetworkAccessCode.n702);
this._networkCodesByTelco[Telco.Returned].push(NetworkAccessCode.n702);
// Flatten all valid network codes and deduplicate
this._allValidNetworkCodes = Object.values(this._networkCodesByTelco)
.flat()
.filter((value, index, self) => self.indexOf(value) === index);
this._allValidTelcos = Object.values(Telco).filter((telco) => !invalidTelcos.includes(telco));
this.initialized = true;
}
/**
* Valid Nigerian mobile network codes grouped by telco
*/
static get networkCodesByTelco() {
this.initialize();
return this._networkCodesByTelco;
}
/**
* Valid network codes for any Nigerian mobile number
*/
static get allValidNetworkCodes() {
this.initialize();
return this._allValidNetworkCodes;
}
/**
* Valid Telcos for any Nigerian mobile numbering plan
*/
static get allValidTelcos() {
this.initialize();
return this._allValidTelcos;
}
/**
* Generate a random subscriber number appropriate for the given network code
* @param networkCode Optional network code to generate a suitable subscriber number for
* @returns A valid subscriber number as a string
*/
static randomSubscriberNumber(networkCode) {
// Special handling for 702 network code which has multiple sub-ranges
if (networkCode === NetworkAccessCode.n702) {
// Use the existing method for 702 subscriber numbers
// Get all operators from specialCase702 and filter only valid ones
const allOperators = Object.keys(this.specialCase702);
// Filter out withdrawn and returned ranges
const validOperators = allOperators.filter(op => !op.startsWith('Withdrawn') && op !== 'Returned');
const selectedOperator = chance.pickone(validOperators);
return TestDataGeneratorBase.random702SubscriberNumber(selectedOperator);
}
// For all other network codes, generate a standard 7-digit number
return chance.string({ length: 7, pool: '0123456789' });
}
/**
* Generate a subscriber number for a specific operator in the 702 range
*/
static random702SubscriberNumber(operator) {
const range = this.specialCase702[operator];
const subscriberNumber = chance.integer({ min: range.min, max: range.max });
return subscriberNumber.toString().padStart(7, '0');
}
/**
* Get a random valid network code for a specific telco
*/
static randomNetworkCodeForTelco(telco) {
var _a;
this.initialize();
if (invalidTelcos.includes(telco)) {
throw new Error(`Invalid Telcos cannot be used when selecting random network codes. Telco name: ${telco}`);
}
const codes = (_a = TestDataGeneratorBase.networkCodesByTelco[telco]) !== null && _a !== void 0 ? _a : [];
if (codes.length == 0)
throw new Error(`Unexpected error: this telco (${telco}) has no network codes`);
return chance.pickone(codes);
}
/**
* Get a random valid network code
*/
static randomNetworkCode() {
this.initialize();
return chance.pickone(TestDataGeneratorBase.allValidNetworkCodes);
}
/**
* Get a random invalid network code
*/
static randomInvalidNetworkCode() {
return chance.pickone(TestDataGeneratorBase.invalidNetworkCodes);
}
/**
* Shuffle an array using Fisher-Yates algorithm
*/
static shuffleArray(array) {
const result = [...array];
for (let i = result.length - 1; i > 0; i--) {
// eslint-disable-next-line security-node/detect-insecure-randomness
const j = Math.floor(Math.random() * (i + 1));
[], result[j]] = [result[j], result[i]];
}
return result;
}
}
/**
* Explicit mapping of network codes to telcos.
* This provides an independent reference for testing that doesn't
* rely on the same logic used in the production code.
*
* Note: This mapping is based on the NCC documents but maintained
* separately from the production code to ensure test independence.
*/
TestDataGeneratorBase.networkCodeToTelcoMap = {
[]: Telco.SharedVAS,
[]: Telco.Airtel,
// 702 is handled specially for its sub-ranges
[]: Telco.MTN,
[]: Telco.MTN,
[]: Telco.Globacom,
[]: Telco.MTN,
[]: Telco.MTN,
[]: Telco.Airtel,
[]: Telco.Withdrawn,
[]: Telco.Telewyz,
[]: Telco.SharedVAS,
[]: Telco.Mafab,
[]: Telco.Airtel,
[]: Telco.MTN,
[]: Telco.MTel,
[]: Telco.Globacom,
[]: Telco.MTN,
[]: Telco.Globacom,
[]: Telco.Airtel,
[]: Telco.NineMobile,
[]: Telco.MTN,
[]: Telco.Globacom,
[]: Telco.Airtel,
[]: Telco.MTN,
[]: Telco.MTN,
[]: Telco.Globacom,
[]: Telco.MTN,
[]: Telco.NineMobile,
[]: Telco.NineMobile,
[]: Telco.Reserved,
[]: Telco.Airtel,
[]: Telco.Airtel,
[]: Telco.MTN,
[]: Telco.Airtel,
[]: Telco.Globacom,
[]: Telco.MTN,
[]: Telco.Airtel,
[]: Telco.NineMobile,
[]: Telco.NineMobile,
[]: Telco.Airtel,
[]: Telco.Airtel,
[]: Telco.MTN,
[]: Telco.MTN,
[]: Telco.Globacom,
[]: Telco.MTN
};
TestDataGeneratorBase.initialized = false;
TestDataGeneratorBase._networkCodesByTelco = {};
TestDataGeneratorBase._allValidNetworkCodes = [];
TestDataGeneratorBase._allValidTelcos = [];
/**
* Invalid network codes for negative testing
*/
TestDataGeneratorBase.invalidNetworkCodes = [200, 300, 400, 500, 600, 999];
/**
* Special cases within the 702 range
*/
TestDataGeneratorBase.specialCase702 = {
Smile: { min: 0, max: 999999 },
Returned: { min: 1000000, max: 1999999 },
InterconnectClearinghouse: { min: 2000000, max: 2000199 },
Openskys: { min: 3000000, max: 3999999 },
Withdrawn1: { min: 4000000, max: 4999999 },
Visafone: { min: 5000000, max: 6999999 },
Withdrawn2: { min: 7000000, max: 9999999 }
};