Merge pull request #4 from adia-technology/error-handling

Exported CountryCode, added additional error handling

Author: michaldudak

CHANGELOG.md

@@ -1,5 +1,10 @@
 # Changelog
 
+## 0.2.0
+
+* Made `CountryCode` type public.
+* Improved error handling.
+
 ## 0.1.1
 
 Removed dependencies from the bundle.

package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@adia-technology/international-ssn-validator",
-	"version": "0.1.1",
+	"version": "0.2.0",
 	"description": "A utility to validate social security number of different countries.",
 	"main": "dist/index.js",
 	"module": "dist/index.es2015.js",

src/index.ts

@@ -1,15 +1,20 @@
 import { validateSwissSsn } from './validateSwissSsn';
 import { validateUsSsn } from './validateUsSsn';
 
-type CountryCode = 'us' | 'ch';
+export type CountryCode = 'us' | 'ch';
 
 export function validateSsn(ssn : string, countryCode : CountryCode) : boolean {
-    switch (countryCode) {
-        case 'us':
-            return validateUsSsn(ssn);
-        case 'ch':
-            return validateSwissSsn(ssn);
-        default:
-            throw new Error('');
-    }
+
+	if (countryCode == null || countryCode as string === '') {
+		throw new Error('countryCode was not provided');
+	}
+
+	switch (countryCode) {
+		case 'us':
+			return validateUsSsn(ssn);
+		case 'ch':
+			return validateSwissSsn(ssn);
+		default:
+			throw new Error(`'${countryCode}' country code is not supported.`);
+	}
 }

src/validateSwissSsn.ts

@@ -3,10 +3,10 @@ import AhvValidator from 'ahv13-validator';
 const ahvRegex = /^756\.\d{4}\.\d{4}\.\d{2}$/;
 
 export function validateSwissSsn(ssn ?: string) : boolean {
-    if (ssn == null || !ahvRegex.test(ssn)) {
-        return false;
-    }
+	if (ssn == null || !ahvRegex.test(ssn)) {
+		return false;
+	}
 
-    let ahvValidator = new AhvValidator();
-    return ahvValidator.isValid(ssn);
+	let ahvValidator = new AhvValidator();
+	return ahvValidator.isValid(ssn);
 }

test/index.test.ts

@@ -1,4 +1,4 @@
-import { validateSsn } from '../src';
+import { validateSsn, CountryCode } from '../src';
 
 test('Given empty SSN, result should not be valid', () => {
 	let invalidSsn = '';
@@ -75,3 +75,12 @@ test('Given valid US SSN, when validateSsn called with "ch" country code, result
 	let validUsSsn = "011-23-4567";
 	expect(validateSsn(validUsSsn, 'ch')).toBe(false);
 });
+
+test('Given unsupported countryCode, validateSsn should throw an error', () => {
+	expect(() => validateSsn('000', 'pl' as CountryCode)).toThrowError("'pl' country code is not supported.");
+});
+
+test('Given empty or null countryCode, validateSsn should throw an error', () => {
+	expect(() => validateSsn('000', '' as CountryCode)).toThrowError('countryCode was not provided');
+	expect(() => validateSsn('000', null)).toThrowError('countryCode was not provided');
+});