Add support for email formats

Author: jdesrosiers

formats/formats-test-suite.spec.ts

@@ -25,18 +25,6 @@ type Test = {
 };
 
 const skip = new Set<string>([
-  // Not supported
-  "|draft2020-12|email.json",
-  "|draft2019-09|email.json",
-  "|draft7|email.json",
-  "|draft6|email.json",
-  "|draft4|email.json",
-
-  // Not supported
-  "|draft2020-12|idn-email.json",
-  "|draft2019-09|idn-email.json",
-  "|draft7|idn-email.json",
-
   // Uses UTS #46 rather than RFC 589[0-5]
   "|draft2020-12|idn-hostname.json|validation of internationalized host names|contains illegal char U+302E Hangul single dot tone mark",
   "|draft2019-09|idn-hostname.json|validation of internationalized host names|contains illegal char U+302E Hangul single dot tone mark",

formats/handlers/email.js

@@ -0,0 +1,43 @@
+const alpha = `[a-zA-Z]`;
+const hexdig = `[\\da-fA-F]`;
+
+// Printable US-ASCII characters not including specials.
+const atext = `[\\w!#$%&'*+\\-/=?^\`{|}~]`;
+const atom = `${atext}+`;
+const dotString = `${atom}(?:\\.${atom})*`;
+
+// Any ASCII graphic or space without blackslash-quoting except double-quote and the backslash itself.
+const qtextSMTP = `[\\x20-\\x21\\x23-\\x5B\\x5D-\\x7E]`;
+// backslash followed by any ASCII graphic or space
+const quotedPairSMTP = `\\\\[\\x20-\\x7E]`;
+const qcontentSMTP = `(?:${qtextSMTP}|${quotedPairSMTP})`;
+const quotedString = `"${qcontentSMTP}*"`;
+
+const localPart = `(?:${dotString}|${quotedString})`; // MAY be case-sensitive
+
+const letDig = `(?:${alpha}|\\d)`;
+const ldhStr = `(?:${letDig}|-)*${letDig}`;
+const subDomain = `${letDig}${ldhStr}?`;
+const domain = `${subDomain}(?:\\.${subDomain})*`;
+
+const decOctet = `(?:\\d|[1-9]\\d|1\\d\\d|2[0-4]\\d|25[0-5])`;
+const ipv4Address = `${decOctet}\\.${decOctet}\\.${decOctet}\\.${decOctet}`;
+
+const h16 = `${hexdig}{1,4}`;
+const ls32 = `(?:${h16}:${h16}|${ipv4Address})`;
+const ipv6Address = `(?:(?:${h16}:){6}${ls32}|::(?:${h16}:){5}${ls32}|(?:${h16})?::(?:${h16}:){4}${ls32}|(?:(?:${h16}:){0,1}${h16})?::(?:${h16}:){3}${ls32}|(?:(?:${h16}:){0,2}${h16})?::(?:${h16}:){2}${ls32}|(?:(?:${h16}:){0,3}${h16})?::(?:${h16}:){1}${ls32}|(?:(?:${h16}:){0,4}${h16})?::${ls32}|(?:(?:${h16}:){0,5}${h16})?::${h16}|(?:(?:${h16}:){0,6}${h16})?::)`;
+const ipv6AddressLiteral = `IPv6:${ipv6Address}`;
+
+const dcontent = `[\\x21-\\x5A\\x5E-\\x7E]`; // Printable US-ASCII excluding "[", "\", "]"
+const generalAddressLiteral = `${ldhStr}:${dcontent}+`;
+
+const addressLiteral = `\\[(?:${ipv4Address}|${ipv6AddressLiteral}|${generalAddressLiteral})]`;
+
+const mailbox = `${localPart}@(?:${domain}|${addressLiteral})`;
+
+export const isEmail = RegExp.prototype.test.bind(new RegExp(`^${mailbox}$`));
+
+export default {
+  id: "https://json-schema.org/format/email",
+  handler: (email) => typeof email !== "string" || isEmail(email)
+};

formats/handlers/idn-email.js

@@ -0,0 +1,55 @@
+import { isIdnHostname } from "./idn-hostname.js";
+
+
+const ucschar = `[\\u{A0}-\\u{D7FF}\\u{F900}-\\u{FDCF}\\u{FDF0}-\\u{FFEF}\\u{10000}-\\u{1FFFD}\\u{20000}-\\u{2FFFD}\\u{30000}-\\u{3FFFD}\\u{40000}-\\u{4FFFD}\\u{50000}-\\u{5FFFD}\\u{60000}-\\u{6FFFD}\\u{70000}-\\u{7FFFD}\\u{80000}-\\u{8FFFD}\\u{90000}-\\u{9FFFD}\\u{A0000}-\\u{AFFFD}\\u{B0000}-\\u{BFFFD}\\u{C0000}-\\u{CFFFD}\\u{D0000}-\\u{DFFFD}\\u{E1000}-\\u{EFFFD}]`;
+
+const alpha = `[a-zA-Z]`;
+const hexdig = `[\\da-fA-F]`;
+
+// Printable US-ASCII characters not including specials.
+const atext = `(?:[\\w!#$%&'*+\\-/=?^\`{|}~]|${ucschar})`;
+const atom = `${atext}+`;
+const dotString = `${atom}(?:\\.${atom})*`;
+
+// Any ASCII graphic or space without blackslash-quoting except double-quote and the backslash itself.
+const qtextSMTP = `(?:[\\x20-\\x21\\x23-\\x5B\\x5D-\\x7E]|${ucschar})`;
+// backslash followed by any ASCII graphic or space
+const quotedPairSMTP = `\\\\[\\x20-\\x7E]`;
+const qcontentSMTP = `(?:${qtextSMTP}|${quotedPairSMTP})`;
+const quotedString = `"${qcontentSMTP}*"`;
+
+const localPart = `(?:${dotString}|${quotedString})`; // MAY be case-sensitive
+
+const letDig = `(?:${alpha}|\\d)`;
+const ldhStr = `(?:${letDig}|-)*${letDig}`;
+const letDigUcs = `(?:${alpha}|\\d|${ucschar})`;
+const ldhStrUcs = `(?:${letDigUcs}|-)*${letDigUcs}`;
+const subDomain = `${letDigUcs}${ldhStrUcs}?`;
+const domain = `${subDomain}(?:\\.${subDomain})*`;
+
+const decOctet = `(?:\\d|[1-9]\\d|1\\d\\d|2[0-4]\\d|25[0-5])`;
+const ipv4Address = `${decOctet}\\.${decOctet}\\.${decOctet}\\.${decOctet}`;
+
+const h16 = `${hexdig}{1,4}`;
+const ls32 = `(?:${h16}:${h16}|${ipv4Address})`;
+const ipv6Address = `(?:(?:${h16}:){6}${ls32}|::(?:${h16}:){5}${ls32}|(?:${h16})?::(?:${h16}:){4}${ls32}|(?:(?:${h16}:){0,1}${h16})?::(?:${h16}:){3}${ls32}|(?:(?:${h16}:){0,2}${h16})?::(?:${h16}:){2}${ls32}|(?:(?:${h16}:){0,3}${h16})?::(?:${h16}:){1}${ls32}|(?:(?:${h16}:){0,4}${h16})?::${ls32}|(?:(?:${h16}:){0,5}${h16})?::${h16}|(?:(?:${h16}:){0,6}${h16})?::)`;
+const ipv6AddressLiteral = `IPv6:${ipv6Address}`;
+
+const dcontent = `[\\x21-\\x5A\\x5E-\\x7E]`; // Printable US-ASCII excluding "[", "\", "]"
+const generalAddressLiteral = `${ldhStr}:${dcontent}+`;
+
+const addressLiteral = `\\[(?:${ipv4Address}|${ipv6AddressLiteral}|${generalAddressLiteral})\\]`;
+
+const mailbox = `(?<localPart>${localPart})@(?:(?<ip>${addressLiteral})|(?<domain>${domain}))`;
+
+const mailboxPattern = new RegExp(`^${mailbox}$`, "u");
+export const isIdnEmail = (email) => {
+  const parsedEmail = mailboxPattern.exec(email)?.groups;
+
+  return !!parsedEmail && (!parsedEmail.domain || isIdnHostname(parsedEmail.domain));
+};
+
+export default {
+  id: "https://json-schema.org/format/idn-email",
+  handler: (email) => typeof email !== "string" || isIdnEmail(email)
+};

formats/index.js

@@ -4,6 +4,8 @@ import dateTime from "./handlers/date-time.js";
 import date from "./handlers/date.js";
 import time from "./handlers/time.js";
 import duration from "./handlers/duration.js";
+import email from "./handlers/email.js";
+import idnEmail from "./handlers/idn-email.js";
 import hostname from "./handlers/hostname.js";
 import idnHostname from "./handlers/idn-hostname.js";
 import ipv4 from "./handlers/ipv4.js";
@@ -23,6 +25,8 @@ addFormat(dateTime);
 addFormat(date);
 addFormat(time);
 addFormat(duration);
+addFormat(email);
+addFormat(idnEmail);
 addFormat(hostname);
 addFormat(idnHostname);
 addFormat(ipv4);