Refactor and cleanup for formats

jdesrosiers · jdesrosiers · commit 1b752878c149 · 2025-10-09T16:13:56.000-07:00
diff --git a/draft-04/format.js b/draft-04/format.js
@@ -9,7 +9,7 @@ const id = "https://json-schema.org/keyword/draft-04/format";
 const compile = (schema) => Browser.value(schema);
 
 const interpret = (format, instance) => {
-  if (!getShouldValidateFormat()) {
+  if (getShouldValidateFormat() === false) {
     return true;
   }
 
@@ -22,7 +22,7 @@ const annotation = (format) => format;
 const formats = {
   "date-time": "https://json-schema.org/format/date-time",
   "email": "https://json-schema.org/format/email",
-  "hostname": "https://json-schema.org/format/draft-04/hostname",
+  "hostname": "https://json-schema.org/format/hostname",
   "ipv4": "https://json-schema.org/format/ipv4",
   "ipv6": "https://json-schema.org/format/ipv6",
   "uri": "https://json-schema.org/format/uri"
diff --git a/draft-04/hostname.js b/draft-04/hostname.js
diff --git a/draft-04/index.js b/draft-04/index.js
@@ -1,4 +1,4 @@
-import { addFormat, addKeyword, defineVocabulary, loadDialect } from "../lib/keywords.js";
+import { addKeyword, defineVocabulary, loadDialect } from "../lib/keywords.js";
 import { registerSchema } from "../lib/index.js";
 import metaSchema from "./schema.js";
 import additionalItems from "./additionalItems.js";
@@ -11,7 +11,6 @@ import format from "./format.js";
 import maximum from "./maximum.js";
 import minimum from "./minimum.js";
 import ref from "./ref.js";
-import hostname from "./hostname.js";
 
 
 addKeyword(additionalItems);
@@ -25,8 +24,6 @@ addKeyword(items);
 addKeyword(format);
 addKeyword(ref);
 
-addFormat(hostname);
-
 const jsonSchemaVersion = "http://json-schema.org/draft-04/schema";
 
 defineVocabulary(jsonSchemaVersion, {
diff --git a/draft-06/format.js b/draft-06/format.js
@@ -9,7 +9,7 @@ const id = "https://json-schema.org/keyword/draft-06/format";
 const compile = (schema) => Browser.value(schema);
 
 const interpret = (format, instance) => {
-  if (!getShouldValidateFormat()) {
+  if (getShouldValidateFormat() === false) {
     return true;
   }
 
diff --git a/draft-07/format.js b/draft-07/format.js
@@ -9,7 +9,7 @@ const id = "https://json-schema.org/keyword/draft-07/format";
 const compile = (schema) => Browser.value(schema);
 
 const interpret = (format, instance) => {
-  if (!getShouldValidateFormat()) {
+  if (getShouldValidateFormat() === false) {
     return true;
   }
 
@@ -24,9 +24,9 @@ const formats = {
   "date": "https://json-schema.org/format/date",
   "time": "https://json-schema.org/format/time",
   "email": "https://json-schema.org/format/email",
-  "idn-email": "https://json-schema.org/format/idn-email",
-  "hostname": "https://json-schema.org/format/hostname",
-  "idn-hostname": "https://json-schema.org/format/idn-hostname",
+  "idn-email": "https://json-schema.org/format/idn-email(partial)",
+  "hostname": "https://json-schema.org/format/a-label(partial)",
+  "idn-hostname": "https://json-schema.org/format/idn-hostname(partial)",
   "ipv4": "https://json-schema.org/format/ipv4",
   "ipv6": "https://json-schema.org/format/ipv6",
   "uri": "https://json-schema.org/format/uri",
diff --git a/draft-2019-09/format-assertion.js b/draft-2019-09/format-assertion.js
@@ -9,16 +9,12 @@ const id = "https://json-schema.org/keyword/draft-2019-09/format-assertion";
 const compile = (schema) => Browser.value(schema);
 
 const interpret = (format, instance) => {
-  if (!getShouldValidateFormat()) {
+  if (getShouldValidateFormat() === false) {
     return true;
   }
 
   const handler = getFormatHandler(formats[format]);
-  if (!handler) {
-    throw Error(`The '${format}' format is not supported.`);
-  }
-
-  return handler(Instance.value(instance));
+  return handler?.(Instance.value(instance)) ?? true;
 };
 
 const annotation = (format) => format;
@@ -29,9 +25,9 @@ const formats = {
   "time": "https://json-schema.org/format/time",
   "duration": "https://json-schema.org/format/duration",
   "email": "https://json-schema.org/format/email",
-  "idn-email": "https://json-schema.org/format/idn-email",
-  "hostname": "https://json-schema.org/format/hostname",
-  "idn-hostname": "https://json-schema.org/format/idn-hostname",
+  "idn-email": "https://json-schema.org/format/idn-email(partial)",
+  "hostname": "https://json-schema.org/format/a-label(partial)",
+  "idn-hostname": "https://json-schema.org/format/idn-hostname(partial)",
   "ipv4": "https://json-schema.org/format/ipv4",
   "ipv6": "https://json-schema.org/format/ipv6",
   "uri": "https://json-schema.org/format/uri",
diff --git a/draft-2019-09/format.js b/draft-2019-09/format.js
@@ -0,0 +1,44 @@
+import * as Browser from "@hyperjump/browser";
+import * as Instance from "../lib/instance.js";
+import { getShouldValidateFormat } from "../lib/configuration.js";
+import { getFormatHandler } from "../lib/keywords.js";
+
+
+const id = "https://json-schema.org/keyword/draft-2019-09/format";
+
+const compile = (schema) => Browser.value(schema);
+
+const interpret = (format, instance) => {
+  if (!getShouldValidateFormat()) {
+    return true;
+  }
+
+  const handler = getFormatHandler(formats[format]);
+  return handler?.(Instance.value(instance)) ?? true;
+};
+
+const annotation = (format) => format;
+
+const formats = {
+  "date-time": "https://json-schema.org/format/date-time",
+  "date": "https://json-schema.org/format/date",
+  "time": "https://json-schema.org/format/time",
+  "duration": "https://json-schema.org/format/duration",
+  "email": "https://json-schema.org/format/email",
+  "idn-email": "https://json-schema.org/format/idn-email(partial)",
+  "hostname": "https://json-schema.org/format/a-label(partial)",
+  "idn-hostname": "https://json-schema.org/format/idn-hostname(partial)",
+  "ipv4": "https://json-schema.org/format/ipv4",
+  "ipv6": "https://json-schema.org/format/ipv6",
+  "uri": "https://json-schema.org/format/uri",
+  "uri-reference": "https://json-schema.org/format/uri-reference",
+  "iri": "https://json-schema.org/format/iri",
+  "iri-reference": "https://json-schema.org/format/iri-reference",
+  "uuid": "https://json-schema.org/format/uuid",
+  "uri-template": "https://json-schema.org/format/uri-template",
+  "json-pointer": "https://json-schema.org/format/json-pointer",
+  "relative-json-pointer": "https://json-schema.org/format/relative-json-pointer",
+  "regex": "https://json-schema.org/format/regex"
+};
+
+export default { id, compile, interpret, annotation, formats };
diff --git a/draft-2019-09/index.js b/draft-2019-09/index.js
@@ -12,13 +12,15 @@ import contentMetaSchema from "./meta/content.js";
 import additionalItems from "../draft-04/additionalItems.js";
 import items from "../draft-04/items.js";
 import formatAssertion from "./format-assertion.js";
+import format from "./format.js";
 import recursiveAnchor from "./recursiveAnchor.js";
 import recursiveRef from "../draft-2020-12/dynamicRef.js";
 
 
 addKeyword(additionalItems);
 addKeyword(items);
 addKeyword(formatAssertion);
+addKeyword(format);
 addKeyword(recursiveAnchor);
 addKeyword(recursiveRef);
 
diff --git a/draft-2020-12/format-assertion.js b/draft-2020-12/format-assertion.js
@@ -1,9 +1,9 @@
 import * as Browser from "@hyperjump/browser";
-import * as Instance from "../instance.js";
-import { getFormatHandler } from "../keywords.js";
+import * as Instance from "../lib/instance.js";
+import { getFormatHandler } from "../lib/keywords.js";
 
 
-const id = "https://json-schema.org/keyword/format-assertion";
+const id = "https://json-schema.org/keyword/draft-2020-12/format-assertion";
 
 const compile = (schema) => Browser.value(schema);
 
@@ -25,7 +25,7 @@ const formats = {
   "duration": "https://json-schema.org/format/duration",
   "email": "https://json-schema.org/format/email",
   "idn-email": "https://json-schema.org/format/idn-email",
-  "hostname": "https://json-schema.org/format/hostname",
+  "hostname": "https://json-schema.org/format/a-label",
   "idn-hostname": "https://json-schema.org/format/idn-hostname",
   "ipv4": "https://json-schema.org/format/ipv4",
   "ipv6": "https://json-schema.org/format/ipv6",
diff --git a/draft-2020-12/index.js b/draft-2020-12/index.js
@@ -13,10 +13,14 @@ import unevaluatedMetaSchema from "./meta/unevaluated.js";
 
 import dynamicAnchor from "./dynamicAnchor.js";
 import dynamicRef from "./dynamicRef.js";
+import format from "../draft-2019-09/format.js";
+import formatAssertion from "./format-assertion.js";
 
 
 addKeyword(dynamicRef);
 addKeyword(dynamicAnchor);
+addKeyword(format);
+addKeyword(formatAssertion);
 
 defineVocabulary("https://json-schema.org/draft/2020-12/vocab/core", {
   "$anchor": "https://json-schema.org/keyword/anchor",
@@ -81,11 +85,11 @@ defineVocabulary("https://json-schema.org/draft/2020-12/vocab/meta-data", {
 });
 
 defineVocabulary("https://json-schema.org/draft/2020-12/vocab/format-annotation", {
-  "format": "https://json-schema.org/keyword/format"
+  "format": "https://json-schema.org/keyword/draft-2019-09/format"
 });
 
 defineVocabulary("https://json-schema.org/draft/2020-12/vocab/format-assertion", {
-  "format": "https://json-schema.org/keyword/format-assertion"
+  "format": "https://json-schema.org/keyword/draft-2020-12/format-assertion"
 });
 
 defineVocabulary("https://json-schema.org/draft/2020-12/vocab/content", {
diff --git a/formats/handlers/a-label.js b/formats/handlers/a-label.js
@@ -0,0 +1,24 @@
+import tr46 from "tr46";
+
+
+const label = `[A-Za-z0-9-]{1,63}`;
+const domain = `${label}(?:\\.${label})*`;
+
+const domainPattern = new RegExp(`^${domain}$`);
+
+const parserOptions = {
+  checkBidi: true,
+  checkJoiners: true,
+  checkHyphens: true
+};
+
+export const isALabel = (hostname) => {
+  return domainPattern.test(hostname)
+    && hostname.length < 256
+    && !tr46.toUnicode(hostname, parserOptions).error;
+};
+
+export default {
+  id: "https://json-schema.org/format/a-label(partial)",
+  handler: (hostname) => typeof hostname !== "string" || isALabel(hostname)
+};
diff --git a/formats/handlers/hostname.js b/formats/handlers/hostname.js
@@ -1,21 +1,10 @@
-import tr46 from "tr46";
-
-
-const label = `[A-Za-z0-9-]{1,63}`;
+const label = `(?!-)[A-Za-z0-9-]{1,63}(?<!-)`;
 const domain = `${label}(?:\\.${label})*`;
 
 const domainPattern = new RegExp(`^${domain}$`);
 
-const parserOptions = {
-  checkBidi: true,
-  checkJoiners: true,
-  checkHyphens: true
-};
-
 export const isHostname = (hostname) => {
-  return domainPattern.test(hostname)
-    && hostname.length < 256
-    && !tr46.toUnicode(hostname, parserOptions).error;
+  return domainPattern.test(hostname) && hostname.length < 256;
 };
 
 export default {
diff --git a/formats/handlers/idn-email.js b/formats/handlers/idn-email.js
@@ -50,6 +50,6 @@ export const isIdnEmail = (email) => {
 };
 
 export default {
-  id: "https://json-schema.org/format/idn-email",
+  id: "https://json-schema.org/format/idn-email(partial)",
   handler: (email) => typeof email !== "string" || isIdnEmail(email)
 };
diff --git a/formats/handlers/idn-hostname.js b/formats/handlers/idn-hostname.js
@@ -1,5 +1,5 @@
 import tr46 from "tr46";
-import { isHostname } from "./hostname.js";
+import { isALabel } from "./a-label.js";
 
 
 export const isIdnHostname = (hostname) => {
@@ -9,10 +9,10 @@ export const isIdnHostname = (hostname) => {
     return false;
   }
 
-  return isHostname(asciiHostname);
+  return isALabel(asciiHostname);
 };
 
 export default {
-  id: "https://json-schema.org/format/idn-hostname",
+  id: "https://json-schema.org/format/idn-hostname(partial)",
   handler: (hostname) => typeof hostname !== "string" || isIdnHostname(hostname)
 };
diff --git a/formats/index.js b/formats/index.js
@@ -1,5 +1,6 @@
 import { addFormat } from "../lib/keywords.js";
 
+import aLabel from "./handlers/a-label.js";
 import dateTime from "./handlers/date-time.js";
 import date from "./handlers/date.js";
 import time from "./handlers/time.js";
@@ -21,6 +22,7 @@ import relativeJsonPointer from "./handlers/relative-json-pointer.js";
 import regex from "./handlers/regex.js";
 
 
+addFormat(aLabel);
 addFormat(dateTime);
 addFormat(date);
 addFormat(time);
diff --git a/lib/configuration.js b/lib/configuration.js
@@ -10,7 +10,7 @@ export const setShouldValidateSchema = (isEnabled) => {
   shouldValidateSchema = isEnabled;
 };
 
-let shouldValidateFormat = false;
+let shouldValidateFormat;
 export const getShouldValidateFormat = () => shouldValidateFormat;
 export const setShouldValidateFormat = (isEnabled) => {
   shouldValidateFormat = isEnabled;
diff --git a/lib/keywords.js b/lib/keywords.js
@@ -94,7 +94,7 @@ export const loadDialect = (dialectId, dialect, allowUnknownKeywords = false, is
         if (!dialect[vocabularyId]) {
           if (vocabularyId === "https://json-schema.org/draft/2019-09/vocab/format") {
             // Handle inconsistent 2019-09 behavior
-            keywordId = "https://json-schema.org/keyword/format";
+            keywordId = "https://json-schema.org/keyword/draft-2019-09/format";
           } else if (!(keywordId in _keywords)) {
             // Allow keyword to be ignored
             keywordId = `https://json-schema.org/keyword/unknown#${keyword}`;
diff --git a/lib/keywords/format.js b/lib/keywords/format.js
@@ -1,6 +1,5 @@
 import * as Browser from "@hyperjump/browser";
 import * as Instance from "../instance.js";
-import { getShouldValidateFormat } from "../configuration.js";
 import { getFormatHandler } from "../keywords.js";
 
 
@@ -9,12 +8,12 @@ const id = "https://json-schema.org/keyword/format";
 const compile = (schema) => Browser.value(schema);
 
 const interpret = (format, instance) => {
-  if (!getShouldValidateFormat()) {
-    return true;
+  const handler = getFormatHandler(formats[format]);
+  if (!handler) {
+    throw Error(`The '${format}' format is not supported.`);
   }
 
-  const handler = getFormatHandler(formats[format]);
-  return handler?.(Instance.value(instance)) ?? true;
+  return handler(Instance.value(instance));
 };
 
 const annotation = (format) => format;
@@ -25,9 +24,9 @@ const formats = {
   "time": "https://json-schema.org/format/time",
   "duration": "https://json-schema.org/format/duration",
   "email": "https://json-schema.org/format/email",
-  "idn-email": "https://json-schema.org/format/idn-email",
-  "hostname": "https://json-schema.org/format/hostname",
-  "idn-hostname": "https://json-schema.org/format/idn-hostname",
+  "idn-email": "https://json-schema.org/format/idn-email(partial)",
+  "hostname": "https://json-schema.org/format/a-label(partial)",
+  "idn-hostname": "https://json-schema.org/format/idn-hostname(partial)",
   "ipv4": "https://json-schema.org/format/ipv4",
   "ipv6": "https://json-schema.org/format/ipv6",
   "uri": "https://json-schema.org/format/uri",
diff --git a/openapi-3-0/index.js b/openapi-3-0/index.js
@@ -38,7 +38,7 @@ defineVocabulary(jsonSchemaVersion, {
   "exclusiveMaximum": "https://json-schema.org/keyword/draft-04/exclusiveMaximum",
   "exclusiveMinimum": "https://json-schema.org/keyword/draft-04/exclusiveMinimum",
   "externalDocs": "https://spec.openapis.org/oas/3.0/keyword/externalDocs",
-  "format": "https://json-schema.org/keyword/format",
+  "format": "https://json-schema.org/keyword/draft-04/format",
   "items": "https://json-schema.org/keyword/draft-04/items",
   "maxItems": "https://json-schema.org/keyword/maxItems",
   "maxLength": "https://json-schema.org/keyword/maxLength",
diff --git a/stable/index.js b/stable/index.js
diff --git a/stable/json-schema-test-suite/tests/format.json b/stable/json-schema-test-suite/tests/format.json
diff --git a/stable/meta/format-annotation.js b/stable/meta/format-annotation.js
diff --git a/stable/meta/format.js b/stable/meta/format.js
diff --git a/stable/validation.js b/stable/validation.js

Original file line number	Diff line number	Diff line change
`@@ -9,7 +9,7 @@ const id = "https://json-schema.org/keyword/draft-06/format";`
`9`	`9`	`const compile = (schema) => Browser.value(schema);`
`10`	`10`
`11`	`11`	`const interpret = (format, instance) => {`
`12`		`- if (!getShouldValidateFormat()) {`
	`12`	`+ if (getShouldValidateFormat() === false) {`
`13`	`13`	`return true;`
`14`	`14`	`}`
`15`	`15`