feat: update email bindings

arcjet · Jul 9, 2024 · fd19ae9 · fd19ae9
1 parent 6b2ccf0
commit fd19ae9
Show file tree

Hide file tree

Showing 11 changed files with 350 additions and 75 deletions.
diff --git a/analyze/edge-light.ts b/analyze/edge-light.ts
@@ -6,6 +6,7 @@ import type {
   EmailValidationConfig,
   BotDetectionResult,
   BotType,
+  EmailValidationResult,
 } from "./wasm/arcjet_analyze_js_req.component.js";
 
 import componentCoreWasm from "./wasm/arcjet_analyze_js_req.component.core.wasm?module";
@@ -43,6 +44,31 @@ async function init(context: AnalyzeContext) {
         log.error(msg);
       },
     },
+    "arcjet:js-req/email-validator-overrides": {
+      isFreeEmail(domain) {
+        if (
+          [
+            "gmail.com",
+            "yahoo.com",
+            "hotmail.com",
+            "aol.com",
+            "hotmail.co.uk",
+          ].includes(domain)
+        ) {
+          return "yes";
+        }
+        return "unknown";
+      },
+      isDisposableEmail() {
+        return "unknown";
+      },
+      hasMxRecords() {
+        return "unknown";
+      },
+      hasGravatar() {
+        return "unknown";
+      },
+    },
   };
 
   try {
@@ -97,14 +123,22 @@ export async function isValidEmail(
   context: AnalyzeContext,
   candidate: string,
   options?: EmailValidationConfig,
-) {
+): Promise<EmailValidationResult> {
   const analyze = await init(context);
+  const optionsOrDefault = options || {
+    requireTopLevelDomain: true,
+    allowDomainLiteral: false,
+    blockedEmails: [],
+  };
 
   if (typeof analyze !== "undefined") {
-    return analyze.isValidEmail(candidate, options);
+    return analyze.isValidEmail(candidate, optionsOrDefault);
   } else {
     // TODO: Fallback to JS if we don't have WASM?
-    return true;
+    return {
+      validity: "valid",
+      blocked: [],
+    };
   }
 }
 

diff --git a/analyze/index.ts b/analyze/index.ts
@@ -6,6 +6,7 @@ import type {
   EmailValidationConfig,
   BotDetectionResult,
   BotType,
+  EmailValidationResult,
 } from "./wasm/arcjet_analyze_js_req.component.js";
 
 import { wasm as componentCoreWasm } from "./wasm/arcjet_analyze_js_req.component.core.wasm?js";
@@ -57,6 +58,31 @@ async function init(context: AnalyzeContext) {
         log.error(msg);
       },
     },
+    "arcjet:js-req/email-validator-overrides": {
+      isFreeEmail(domain) {
+        if (
+          [
+            "gmail.com",
+            "yahoo.com",
+            "hotmail.com",
+            "aol.com",
+            "hotmail.co.uk",
+          ].includes(domain)
+        ) {
+          return "yes";
+        }
+        return "unknown";
+      },
+      isDisposableEmail() {
+        return "unknown";
+      },
+      hasMxRecords() {
+        return "unknown";
+      },
+      hasGravatar() {
+        return "unknown";
+      },
+    },
   };
 
   try {
@@ -111,14 +137,22 @@ export async function isValidEmail(
   context: AnalyzeContext,
   candidate: string,
   options?: EmailValidationConfig,
-) {
+): Promise<EmailValidationResult> {
   const analyze = await init(context);
+  const optionsOrDefault = options || {
+    requireTopLevelDomain: true,
+    allowDomainLiteral: false,
+    blockedEmails: [],
+  };
 
   if (typeof analyze !== "undefined") {
-    return analyze.isValidEmail(candidate, options);
+    return analyze.isValidEmail(candidate, optionsOrDefault);
   } else {
     // TODO: Fallback to JS if we don't have WASM?
-    return true;
+    return {
+      validity: "valid",
+      blocked: [],
+    };
   }
 }
 

diff --git a/analyze/wasm/arcjet_analyze_js_req.component.core.wasm b/analyze/wasm/arcjet_analyze_js_req.component.core.wasm
diff --git a/analyze/wasm/arcjet_analyze_js_req.component.core2.wasm b/analyze/wasm/arcjet_analyze_js_req.component.core2.wasm
diff --git a/analyze/wasm/arcjet_analyze_js_req.component.core3.wasm b/analyze/wasm/arcjet_analyze_js_req.component.core3.wasm
diff --git a/analyze/wasm/arcjet_analyze_js_req.component.d.ts b/analyze/wasm/arcjet_analyze_js_req.component.d.ts
@@ -18,18 +18,33 @@ export interface BotDetectionResult {
   botType: BotType,
   botScore: number,
 }
+/**
+* # Variants
+* 
+* ## `"valid"`
+* 
+* ## `"invalid"`
+*/
+export type EmailValidity = 'valid' | 'invalid';
+export interface EmailValidationResult {
+  validity: EmailValidity,
+  blocked: string[],
+}
 export interface EmailValidationConfig {
-  requireTopLevelDomain?: boolean,
-  allowDomainLiteral?: boolean,
+  requireTopLevelDomain: boolean,
+  allowDomainLiteral: boolean,
+  blockedEmails: string[],
 }
+import { ArcjetJsReqEmailValidatorOverrides } from './interfaces/arcjet-js-req-email-validator-overrides.js';
 import { ArcjetJsReqLogger } from './interfaces/arcjet-js-req-logger.js';
 export interface ImportObject {
+  'arcjet:js-req/email-validator-overrides': typeof ArcjetJsReqEmailValidatorOverrides,
   'arcjet:js-req/logger': typeof ArcjetJsReqLogger,
 }
 export interface Root {
   detectBot(headers: string, patternsAdd: string, patternsRemove: string): BotDetectionResult,
   generateFingerprint(request: string, characteristics: string[]): string,
-  isValidEmail(candidate: string, options: EmailValidationConfig | undefined): boolean,
+  isValidEmail(candidate: string, options: EmailValidationConfig): EmailValidationResult,
 }
 
 /**