Merge pull request #32 from information-security/master

Added `additionalTopLevelDomains` option that enables support for cus…

Author: mfbx9da4

src/index.ts

@@ -19,7 +19,7 @@ export async function validate(
   }
 
   if (options.validateTypo) {
-    const typoResponse = await checkTypo(email)
+    const typoResponse = await checkTypo(email, options.additionalTopLevelDomains)
     if (typoResponse) return createOutput('typo', typoResponse)
   }
 

src/options/options.ts

@@ -17,8 +17,12 @@ type Options = {
   validateSMTP: boolean
 }
 
-export type ValidatorOptions = Partial<Options> & { email: string }
-type ValidatorOptionsFinal = Options & { email: string }
+type MailCheckOptions = {
+  additionalTopLevelDomains?: string[]
+}
+
+export type ValidatorOptions = Partial<Options> & { email: string } & MailCheckOptions
+type ValidatorOptionsFinal = Options & { email: string } & MailCheckOptions
 
 export function getOptions(
   emailOrOptions: string | ValidatorOptions

src/typo/typo.ts

@@ -6,15 +6,21 @@ type TypoSuggestion = {
   full: string
 }
 
-export const checkTypo = async (email: string): Promise<string | undefined> =>
+export const checkTypo = async (email: string, additionalTLDs?: string[]): Promise<string | undefined> =>
   new Promise(r =>
+  {
+    let topLevelDomains = undefined
+    if (additionalTLDs && additionalTLDs.length > 0) {
+        topLevelDomains = [...mailCheck.defaultTopLevelDomains, ...additionalTLDs]
+    }
     mailCheck.run({
       email,
+      topLevelDomains: topLevelDomains,
       suggested: (suggestion: TypoSuggestion) => {
         r(`Likely typo, suggested email: ${suggestion.full}`)
       },
       empty: function() {
         r()
       },
     })
-  )
+  })

test/__snapshots__/index.test.ts.snap

@@ -316,3 +316,26 @@ Object {
   },
 }
 `;
+
+exports[`validation tests passes with custom TLD 1`] = `
+Object {
+  "valid": true,
+  "validators": Object {
+    "disposable": Object {
+      "valid": true,
+    },
+    "mx": Object {
+      "valid": true,
+    },
+    "regex": Object {
+      "valid": true,
+    },
+    "smtp": Object {
+      "valid": true,
+    },
+    "typo": Object {
+      "valid": true,
+    },
+  },
+}
+`;

test/index.test.ts

@@ -120,4 +120,19 @@ describe('validation tests', () => {
     },
     elevenSeconds
   )
+
+  it(
+    'passes with custom TLD',
+    async () => {
+      const res = await validate({
+        email: 'info@utob.ir',
+        validateSMTP: false,
+        additionalTopLevelDomains: ['ir']
+      })
+      expect(res.valid).toBe(true)
+      expect(every(values(res.validators), x => x && x.valid)).toBe(true)
+      expect(res).toMatchSnapshot()
+    },
+    elevenSeconds
+  )
 })