add type decleration

Author: mfbx9da4

README.md

@@ -1 +1,14 @@
 # Email Validator
+
+, , disposable email blacklists, DNS records and SMTP server response.
+
+- Validates RFC compliant regex.
+- Validates common typos e.g. [email protected].
+- Validates email was not generated by disposable email service.
+- Validates MX records are present on DNS.
+- Validates SMTP server is running and mailbox exists.
+- Native typescript support
+
+```
+yarn add deep-email-validator
+```

package.json

@@ -1,13 +1,23 @@
 {
-  "name": "email-validator",
-  "version": "0.1.0",
+  "name": "deep-email-validator",
+  "version": "0.1.2",
   "description": "Validates emails based on regex, common typos, disposable email blacklists, DNS records and SMTP server response.",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
   "repository": {
     "type": "git",
     "url": "https://github.com/mfbx9da4/email-validator"
   },
   "author": "David Alberto Adler",
   "license": "MIT",
+  "keywords": [
+    "email-validation",
+    "email-typos",
+    "email-regex",
+    "disposable-emails",
+    "smtp",
+    "mx-records"
+  ],
   "scripts": {
     "start": "yarn serve",
     "build": "tsc",

src/output/output.ts

@@ -1,37 +1,45 @@
-export type ValidatorOutput = {
+import { ElementType } from '../types'
+
+const OrderedLevels = ['regex', 'typo', 'disposable', 'mx', 'smtp'] as const
+
+export type SubOutputFormat = {
   valid: boolean
   reason?: string
 }
 
-const NullOutputFormat = {
+const NullOutputFormat: OutputFormat = {
   valid: true,
   validators: {
-    regex: { valid: true } as ValidatorOutput,
-    typo: { valid: true } as ValidatorOutput,
-    disposable: { valid: true } as ValidatorOutput,
-    mx: { valid: true } as ValidatorOutput,
-    smtp: { valid: true } as ValidatorOutput,
+    regex: { valid: true },
+    typo: { valid: true },
+    disposable: { valid: true },
+    mx: { valid: true },
+    smtp: { valid: true },
   },
 }
-
-export type OutputFormat = typeof NullOutputFormat
-
-type Levels = keyof OutputFormat['validators']
+type Level = ElementType<typeof OrderedLevels>
+export type OutputFormat = SubOutputFormat & {
+  validators: {
+    [K in Level]: SubOutputFormat
+  }
+}
 
 export const createOutput = (
-  failLevel?: Levels,
+  failLevel?: Level,
   failReason?: string
 ): OutputFormat => {
-  const levels = Object.typedKeys(NullOutputFormat.validators)
-  const out: OutputFormat = NullOutputFormat
-  for (let i = 0; i < levels.length; i++) {
-    const level = levels[i]
+  const out = NullOutputFormat
+  let valid = true
+  for (let i = 0; i < OrderedLevels.length; i++) {
+    const level = OrderedLevels[i]
     let reason
     if (level === failLevel) {
-      out.valid = false
+      valid = false
+      out.valid = valid
       reason = failReason
+      out.reason = failLevel
     }
-    out.validators[level] = { valid: out.valid, reason }
+    out.validators[level] = { valid: valid, reason }
   }
   return out
 }

src/types.ts

@@ -1,7 +1,10 @@
-export {}
 declare global {
   interface ObjectConstructor {
     typedKeys<T>(o: T): Array<keyof T>
   }
 }
 Object.typedKeys = Object.keys as any
+
+export type ElementType<
+  T extends ReadonlyArray<unknown>
+> = T extends ReadonlyArray<infer ElementType> ? ElementType : never

test/__snapshots__/index.test.ts.snap

@@ -1,63 +1,66 @@
 // Jest Snapshot v1, https://goo.gl/fbAQLP
 
-exports[`validation tests bad username 1`] = `
+exports[`validation tests fails with bad dns 1`] = `
 Object {
+  "reason": "mx",
   "valid": false,
   "validators": Object {
     "disposable": Object {
       "reason": undefined,
-      "valid": false,
+      "valid": true,
     },
     "mx": Object {
-      "reason": undefined,
+      "reason": "MX record not found",
       "valid": false,
     },
     "regex": Object {
       "reason": undefined,
-      "valid": false,
+      "valid": true,
     },
     "smtp": Object {
-      "reason": "Invalid Mailbox",
+      "reason": undefined,
       "valid": false,
     },
     "typo": Object {
       "reason": undefined,
-      "valid": false,
+      "valid": true,
     },
   },
 }
 `;
 
-exports[`validation tests fails with bad dns 1`] = `
+exports[`validation tests fails with bad mailbox 1`] = `
 Object {
+  "reason": "smtp",
   "valid": false,
   "validators": Object {
     "disposable": Object {
       "reason": undefined,
-      "valid": false,
+      "valid": true,
     },
     "mx": Object {
-      "reason": "MX record not found",
-      "valid": false,
+      "reason": undefined,
+      "valid": true,
     },
     "regex": Object {
       "reason": undefined,
-      "valid": false,
+      "valid": true,
     },
     "smtp": Object {
-      "reason": undefined,
+      "reason": "Invalid Mailbox",
       "valid": false,
     },
     "typo": Object {
       "reason": undefined,
-      "valid": false,
+      "valid": true,
     },
   },
 }
 `;
 
 exports[`validation tests fails with bad regex 1`] = `
 Object {
+  "reason": "regex",
   "valid": false,
   "validators": Object {
     "disposable": Object {
@@ -84,8 +87,9 @@ Object {
 }
 `;
 
-exports[`validation tests fails with bad username 1`] = `
+exports[`validation tests fails with common typo 1`] = `
 Object {
+  "reason": "typo",
   "valid": false,
   "validators": Object {
     "disposable": Object {
@@ -98,26 +102,27 @@ Object {
     },
     "regex": Object {
       "reason": undefined,
-      "valid": false,
+      "valid": true,
     },
     "smtp": Object {
-      "reason": "Invalid Mailbox",
+      "reason": undefined,
       "valid": false,
     },
     "typo": Object {
-      "reason": undefined,
+      "reason": "Likely typo, suggested email: [email protected]",
       "valid": false,
     },
   },
 }
 `;
 
-exports[`validation tests fails with common typo 1`] = `
+exports[`validation tests fails with disposable email 1`] = `
 Object {
+  "reason": "disposable",
   "valid": false,
   "validators": Object {
     "disposable": Object {
-      "reason": undefined,
+      "reason": "Email was created using a disposable email service",
       "valid": false,
     },
     "mx": Object {
@@ -126,15 +131,15 @@ Object {
     },
     "regex": Object {
       "reason": undefined,
-      "valid": false,
+      "valid": true,
     },
     "smtp": Object {
       "reason": undefined,
       "valid": false,
     },
     "typo": Object {
-      "reason": "Likely typo, suggested email: [email protected]",
-      "valid": false,
+      "reason": undefined,
+      "valid": true,
     },
   },
 }

test/index.test.ts

@@ -10,11 +10,17 @@ describe('validation tests', () => {
     const res = await validate('[email protected]')
     expect(res).toMatchSnapshot()
   })
-  // it('fails with bad dns', async () => {
-  //   const res = await validate('[email protected]')
-  //   expect(res).toMatchSnapshot()
-  // })
-  it('fails with bad username', async () => {
+  it('fails with disposable email', async () => {
+    const res = await validate('[email protected]')
+    expect(res).toMatchSnapshot()
+  })
+
+  it('fails with bad dns', async () => {
+    const res = await validate('[email protected]')
+    expect(res).toMatchSnapshot()
+  })
+
+  it('fails with bad mailbox', async () => {
     const res = await validate('[email protected]')
     expect(res).toMatchSnapshot()
   })

tsconfig.json

@@ -5,6 +5,7 @@
     "allowSyntheticDefaultImports": true,
     "target": "es6",
     "noImplicitAny": true,
+    "declaration": true,
     "moduleResolution": "node",
     "sourceMap": true,
     "strict": true,