remove pattern from the stringHandler

Author: arpitkuriyal

src/error-handlers/pattern.js

@@ -0,0 +1,29 @@
+import { getSchema } from "@hyperjump/json-schema/experimental";
+import * as Schema from "@hyperjump/browser";
+import * as Instance from "@hyperjump/json-schema/instance/experimental";
+
+/**
+ * @import { ErrorHandler, ErrorObject } from "../index.d.ts"
+ */
+
+/** @type ErrorHandler */
+const pattern = async (normalizedErrors, instance, localization) => {
+  /** @type ErrorObject[] */
+  const errors = [];
+
+  if (normalizedErrors["https://json-schema.org/keyword/pattern"]) {
+    for (const schemaLocation in normalizedErrors["https://json-schema.org/keyword/pattern"]) {
+      if (!normalizedErrors["https://json-schema.org/keyword/pattern"][schemaLocation]) {
+        const keyword = await getSchema(schemaLocation);
+        errors.push({
+          message: localization.getPatternErrorMessage(Schema.value(keyword)),
+          instanceLocation: Instance.uri(instance),
+          schemaLocation: schemaLocation
+        });
+      }
+    }
+  }
+
+  return errors;
+};
+export default pattern;

src/error-handlers/string-handler.js

@@ -37,17 +37,6 @@ const stringHandler = async (normalizedErrors, instance, localization) => {
     constraints.maxLength = Math.min(constraints.maxLength ?? Number.MAX_VALUE, maxLength);
   }
 
-  for (const schemaLocation in normalizedErrors["https://json-schema.org/keyword/pattern"]) {
-    if (!normalizedErrors["https://json-schema.org/keyword/pattern"][schemaLocation]) {
-      failedSchemaLocations.push(schemaLocation);
-    }
-
-    const keyword = await getSchema(schemaLocation);
-    /** @type string */
-    const pattern = Schema.value(keyword);
-    constraints.pattern = pattern;
-  }
-
   if (failedSchemaLocations.length > 0) {
     return [
       {

src/index.js

@@ -61,7 +61,8 @@ import numberRangeHandler from "./error-handlers/number-range-handler.js";
 import requiredErrorHandler from "./error-handlers/required.js";
 import typeErrorHandler from "./error-handlers/type.js";
 import uniqueItemsErrorHandler from "./error-handlers/uniqueItems.js";
-import stringHandler from "./error-handlers/string-handler.js";
+import stringErrorHandler from "./error-handlers/string-handler.js";
+import patternErrorHandler from "./error-handlers/pattern.js";
 
 /**
  * @import { betterJsonSchemaErrors } from "./index.d.ts"
@@ -131,7 +132,8 @@ addErrorHandler(numberRangeHandler);
 addErrorHandler(requiredErrorHandler);
 addErrorHandler(typeErrorHandler);
 addErrorHandler(uniqueItemsErrorHandler);
-addErrorHandler(stringHandler);
+addErrorHandler(stringErrorHandler);
+addErrorHandler(patternErrorHandler);
 
 export { setNormalizationHandler } from "./normalized-output.js";
 export { addErrorHandler } from "./error-handling.js";

src/keyword-error-message.test.js

@@ -614,7 +614,7 @@ describe("Error messages", async () => {
       {
         schemaLocation: "https://example.com/main#/pattern",
         instanceLocation: "#",
-        message: localization.getStringErrorMessage({ pattern: "^[a-z]+$" })
+        message: localization.getPatternErrorMessage("^[a-z]+$")
       }
     ]);
   });
@@ -883,7 +883,7 @@ describe("Error messages", async () => {
       {
         schemaLocation: "https://example.com/main#/anyOf/1/properties/ID/pattern",
         instanceLocation: "#/ID",
-        message: localization.getStringErrorMessage({ pattern: "^[0-9\\-]+$" })
+        message: localization.getPatternErrorMessage("^[0-9\\-]+$")
       }
     ]);
   });
@@ -1355,7 +1355,7 @@ describe("Error messages", async () => {
     expect(result.errors).to.eql([
       {
         instanceLocation: "#/Foo",
-        message: localization.getStringErrorMessage({ pattern: "^[a-z]*$" }),
+        message: localization.getPatternErrorMessage("^[a-z]*$"),
         schemaLocation: "https://example.com/main#/propertyNames/pattern"
       }
     ]);
@@ -1382,7 +1382,7 @@ describe("Error messages", async () => {
     expect(result.errors).to.eql([
       {
         instanceLocation: "#/Foo",
-        message: localization.getStringErrorMessage({ pattern: "^[a-z]*$" }),
+        message: localization.getPatternErrorMessage("^[a-z]*$"),
         schemaLocation: "https://example.com/main#/propertyNames/pattern"
       }
     ]);
@@ -1409,7 +1409,7 @@ describe("Error messages", async () => {
     expect(result.errors).to.eql([
       {
         instanceLocation: "#*/Foo",
-        message: localization.getStringErrorMessage({ pattern: "^[a-z]*$" }),
+        message: localization.getPatternErrorMessage("^[a-z]*$"),
         schemaLocation: "https://example.com/main#/propertyNames/pattern"
       }
     ]);
@@ -1503,8 +1503,7 @@ describe("Error messages", async () => {
       $schema: "https://json-schema.org/draft/2020-12/schema",
       allOf: [
         { minLength: 3 },
-        { maxLength: 5 },
-        { pattern: "^[a-z]+$" }
+        { maxLength: 5 }
       ]
     }, schemaUri);
 
@@ -1521,10 +1520,6 @@ describe("Error messages", async () => {
         {
           absoluteKeywordLocation: "https://example.com/main#/allOf/1/maxLength",
           instanceLocation: "#"
-        },
-        {
-          absoluteKeywordLocation: "https://example.com/main#/allOf/2/pattern",
-          instanceLocation: "#"
         }
       ]
     };
@@ -1533,11 +1528,10 @@ describe("Error messages", async () => {
     expect(result.errors).to.eql([{
       schemaLocation: [
         "https://example.com/main#/allOf/0/minLength",
-        "https://example.com/main#/allOf/1/maxLength",
-        "https://example.com/main#/allOf/2/pattern"
+        "https://example.com/main#/allOf/1/maxLength"
       ],
       instanceLocation: "#",
-      message: localization.getStringErrorMessage({ minLength: 3, maxLength: 5, pattern: "^[a-z]+$" })
+      message: localization.getStringErrorMessage({ minLength: 3, maxLength: 5 })
     }]);
   });
 });

src/localization.js

@@ -18,7 +18,6 @@ import { FluentBundle, FluentResource } from "@fluent/bundle";
  * @typedef {{
  *   minLength?: number;
  *   maxLength?: number;
- *   pattern?: string;
  * }} StringConstraints
  */
 
@@ -119,10 +118,6 @@ export class Localization {
       messages.push(this._formatMessage("string-error-maxLength", constraints));
     }
 
-    if (constraints.pattern) {
-      messages.push(this._formatMessage("string-error-pattern", constraints));
-    }
-
     return this._formatMessage("string-error", {
       constraints: new Intl.ListFormat(this.locale, { type: "conjunction" }).format(messages)
     });
@@ -176,6 +171,11 @@ export class Localization {
     return this._formatMessage("format-error", { format });
   }
 
+  /** @type (pattern: string) => string */
+  getPatternErrorMessage(pattern) {
+    return this._formatMessage("pattern-error", { pattern });
+  }
+
   /** @type (constraints: ContainsConstraints) => string */
   getContainsErrorMessage(constraints) {
     if (constraints.maxContains) {

src/normalization-handlers/contains.js

@@ -1,5 +1,6 @@
 import { evaluateSchema } from "../normalized-output.js";
 import * as Instance from "@hyperjump/json-schema/instance/experimental";
+
 /**
  * @import { KeywordHandler, NormalizedOutput } from "../index.d.ts"
  * @import { EvaluatedItemsContext } from "./unevaluatedItems.js"

src/translations/en-US.ftl

@@ -3,7 +3,6 @@ type-error = The instance should be of type {$expected} but found {$actual}.
 string-error = Expected a string {$constraints}.
 string-error-minLength = at least {$minLength} characters long
 string-error-maxLength = at most {$maxLength} characters long
-string-error-pattern = to match the pattern {$pattern}
 
 number-error = Expected a number {$constraints}.
 number-error-minimum = greater than {$minimum}
@@ -20,6 +19,7 @@ max-items-error = The instance should contain a maximum of {$limit} items in the
 min-items-error = The instance should contain a minimum of {$limit} items in the array.
 unique-items-error = The instance should have unique items in the array.
 format-error = The instance should match the format: {$format}.
+pattern-error = The instance should match the pattern: {$pattern}.
 
 contains-error-min = The array must contain at least {$minContains -> 
   [one] item that passes