Fix: Add support for format keyword across all JSON Schema dialects (#95)

* fixed:format test failure

Signed-off-by: Diya <[email protected]>

* fix lint error

* removed repition in format test

* fixed repetition and lint errors

---------

Signed-off-by: Diya <[email protected]>

Author: srivastava-diya

src/error-handlers/format.js

@@ -11,16 +11,32 @@ const format = async (normalizedErrors, instance, localization) => {
   /** @type ErrorObject[] */
   const errors = [];
 
-  if (normalizedErrors["https://json-schema.org/keyword/format"]) {
-    for (const schemaLocation in normalizedErrors["https://json-schema.org/keyword/format"]) {
-      if (!normalizedErrors["https://json-schema.org/keyword/format"][schemaLocation]) {
-        const keyword = await getSchema(schemaLocation);
-        errors.push({
-          message: localization.getFormatErrorMessage(Schema.value(keyword)),
-          instanceLocation: Instance.uri(instance),
-          schemaLocation: schemaLocation
-        });
+  const formats = [
+    "https://json-schema.org/keyword/draft-2020-12/format",
+    "https://json-schema.org/keyword/draft-2019-09/format",
+    "https://json-schema.org/keyword/draft-07/format",
+    "https://json-schema.org/keyword/draft-06/format",
+    "https://json-schema.org/keyword/draft-04/format"
+  ];
+
+  for (const formatKeyword of formats) {
+    if (!normalizedErrors[formatKeyword]) {
+      continue;
+    }
+
+    for (const schemaLocation in normalizedErrors[formatKeyword]) {
+      const valid = normalizedErrors[formatKeyword][schemaLocation];
+      if (valid) {
+        continue;
       }
+
+      const keyword = await getSchema(schemaLocation);
+
+      errors.push({
+        message: localization.getFormatErrorMessage(Schema.value(keyword)),
+        instanceLocation: Instance.uri(instance),
+        schemaLocation
+      });
     }
   }
 

src/index.js

@@ -50,6 +50,7 @@ import arrayRangeErrorHandler from "./error-handlers/array-range-handler.js";
 import constErrorHandler from "./error-handlers/const.js";
 import containsErrorHandler from "./error-handlers/contains.js";
 import enumErrorHandler from "./error-handlers/enum.js";
+import format from "./normalization-handlers/format.js";
 import formatErrorHandler from "./error-handlers/format.js";
 import multipleOfErrorHandler from "./error-handlers/multipleOf.js";
 import notErrorHandler from "./error-handlers/not.js";
@@ -83,6 +84,11 @@ setNormalizationHandler("https://json-schema.org/keyword/dependentSchema", depen
 setNormalizationHandler("https://json-schema.org/keyword/definitions", definitions);
 setNormalizationHandler("https://json-schema.org/keyword/else", elseKeyword);
 setNormalizationHandler("https://json-schema.org/keyword/enum", enumKeyword);
+setNormalizationHandler("https://json-schema.org/keyword/draft-2020-12/format", format);
+setNormalizationHandler("https://json-schema.org/keyword/draft-2019-09/format", format);
+setNormalizationHandler("https://json-schema.org/keyword/draft-07/format", format);
+setNormalizationHandler("https://json-schema.org/keyword/draft-06/format", format);
+setNormalizationHandler("https://json-schema.org/keyword/draft-04/format", format);
 setNormalizationHandler("https://json-schema/keyword/exclusiveMaximum", exclusiveMaximum);
 setNormalizationHandler("https://json-schema/keyword/exclusiveMinimum", exclusiveMinimum);
 setNormalizationHandler("https://json-schema.org/keyword/items", items);

src/keyword-error-message.test.js

@@ -4,6 +4,10 @@ import { registerSchema } from "@hyperjump/json-schema/draft-2020-12";
 import { unregisterSchema } from "@hyperjump/json-schema";
 import { getSchemaDescription } from "./schema-descriptions.js";
 import { Localization } from "./localization.js";
+import "@hyperjump/json-schema/draft-04";
+import "@hyperjump/json-schema/draft-06";
+import "@hyperjump/json-schema/draft-2019-09";
+import "@hyperjump/json-schema/draft-07";
 
 /**
  * @import { OutputFormat} from "./index.d.ts"
@@ -639,33 +643,43 @@ describe("Error messages", async () => {
     }]);
   });
 
-  test("format: email", async () => {
-    registerSchema({
-      $schema: "https://json-schema.org/draft/2020-12/schema",
-      format: "email"
-    }, schemaUri);
+  const dialects = [
+    { name: "draft-2020-12", schema: "https://json-schema.org/draft/2020-12/schema" },
+    { name: "draft-2019-09", schema: "https://json-schema.org/draft/2019-09/schema" },
+    { name: "draft-07", schema: "http://json-schema.org/draft-07/schema" },
+    { name: "draft-06", schema: "http://json-schema.org/draft-06/schema" },
+    { name: "draft-04", schema: "http://json-schema.org/draft-04/schema" }
+  ];
+
+  for (const { name, schema } of dialects) {
+    test(`format: email (${name})`, async () => {
+      registerSchema({
+        $schema: schema,
+        format: "email"
+      }, schemaUri);
+
+      const instance = "not-an-email";
+      const output = {
+        valid: false,
+        errors: [
+          {
+            absoluteKeywordLocation: "https://example.com/main#/format",
+            instanceLocation: "#"
+          }
+        ]
+      };
 
-    const instance = "not-an-email";
-    const output = {
-      valid: false,
-      errors: [
+      const result = await betterJsonSchemaErrors(output, schemaUri, instance);
+
+      expect(result.errors).to.eql([
         {
-          absoluteKeywordLocation: "https://example.com/main#/format",
-          instanceLocation: "#"
+          schemaLocation: "https://example.com/main#/format",
+          instanceLocation: "#",
+          message: localization.getFormatErrorMessage("email")
         }
-      ]
-    };
-
-    const result = await betterJsonSchemaErrors(output, schemaUri, instance);
-    expect(result.errors).to.eql([
-      {
-        schemaLocation: "https://example.com/main#/format",
-        instanceLocation: "#",
-        message: localization.getFormatErrorMessage("email")
-      }
-    ]);
-  });
-
+      ]);
+    });
+  }
   test("pattern", async () => {
     registerSchema({
       $schema: "https://json-schema.org/draft/2020-12/schema",

src/normalization-handlers/format.js

@@ -0,0 +1,12 @@
+/**
+ * @import { KeywordHandler } from "../index.d.ts"
+ */
+
+/** @type KeywordHandler */
+const format = {
+  appliesTo() {
+    return true;
+  }
+};
+
+export default format;