Merge pull request #21 from arpitkuriyal/fix/options-param

added options param in the main function

Author: arpitkuriyal

package-lock.json

@@ -38,6 +38,7 @@
   },
   "dependencies": {
     "@hyperjump/browser": "^1.3.1",
-    "@hyperjump/json-schema": "^1.16.0"
+    "@hyperjump/json-schema": "^1.16.0",
+    "leven": "^4.0.0"
   }
 }

package.json

@@ -1,7 +1,7 @@
 export const betterJsonSchemaErrors: (
   instance: Json,
-  schema: SchemaObject,
-  errorOutput: OutputFormat
+  errorOutput: OutputFormat,
+  schemaUri: string
 ) => Promise<BetterJsonSchemaErrors>;
 
 export type BetterJsonSchemaErrors = {
@@ -31,6 +31,7 @@ export type OutputFormat = {
 
 export type OutputUnit = {
   valid?: boolean;
+  keyword?: string;
   absoluteKeywordLocation?: string;
   keywordLocation?: string;
   instanceLocation: string;
@@ -40,6 +41,7 @@ export type OutputUnit = {
 
 export type NormalizedError = {
   valid: false;
+  keyword: string;
   absoluteKeywordLocation: string;
   instanceLocation: string;
 };

src/index.d.ts

@@ -1,21 +1,122 @@
 import { normalizeOutputFormat } from "./normalizeOutputFormat/normalizeOutput.js";
+import * as Schema from "@hyperjump/browser";
+import { getSchema, getKeyword } from "@hyperjump/json-schema/experimental";
+import * as Instance from "@hyperjump/json-pointer";
+import leven from "leven";
 
 /**
- * @import {betterJsonSchemaErrors} from "./index.d.ts"
+ * @import { Browser } from "@hyperjump/browser";
+ * @import { SchemaDocument } from "@hyperjump/json-schema/experimental";
+ * @import { Json } from "@hyperjump/json-pointer";
+ * @import {betterJsonSchemaErrors, OutputUnit } from "./index.d.ts"
  */
 
 /** @type betterJsonSchemaErrors */
-export async function betterJsonSchemaErrors(instance, schema, errorOutput) {
+export async function betterJsonSchemaErrors(instance, errorOutput, schemaUri) {
+  const schema = await getSchema(schemaUri);
   const normalizedErrors = await normalizeOutputFormat(errorOutput, schema);
-
   const errors = [];
   for (const error of normalizedErrors) {
+    const keywordHandler = getKeyword(error.keyword);
+    if (keywordHandler.simpleApplicator) {
+      continue;
+    }
+
+    /** @type Browser<SchemaDocument> */
+    const schema = await getSchema(error.absoluteKeywordLocation);
     errors.push({
-      message: "The instance should be at least 3 characters",
+      message: getErrorMessage(error, schema, instance),
       instanceLocation: error.instanceLocation,
       schemaLocation: error.absoluteKeywordLocation
     });
   }
 
   return { errors };
 }
+
+/** @type (outputUnit: OutputUnit, schema: Browser<SchemaDocument>, instance: Json) => string */
+const getErrorMessage = (outputUnit, schema, instance) => {
+  if (outputUnit.keyword === "https://json-schema.org/keyword/minLength") {
+    return `The instance should be at least ${Schema.value(schema)} characters`;
+  }
+
+  if (outputUnit.keyword === "https://json-schema.org/keyword/maxLength") {
+    return `The instance should be atmost ${Schema.value(schema)} characters long.`;
+  }
+
+  if (outputUnit.keyword === "https://json-schema.org/keyword/type") {
+    const pointer = outputUnit.instanceLocation.replace(/^#/, "");
+    const actualValue = Instance.get(pointer, instance);
+    return `The instance should be of type "${Schema.value(schema)}" but found "${typeof actualValue}".`;
+  }
+
+  if (outputUnit.keyword === "https://json-schema.org/keyword/maximum") {
+    return `The instance should be less than or equal to ${Schema.value(schema)}.`;
+  }
+
+  if (outputUnit.keyword === "https://json-schema.org/keyword/minimum") {
+    return `The instance should be greater than or equal to ${Schema.value(schema)}.`;
+  }
+
+  if (outputUnit.keyword === "https://json-schema.org/keyword/exclusiveMaximum") {
+    return `The instance should be less than ${Schema.value(schema)}.`;
+  }
+
+  if (outputUnit.keyword === "https://json-schema.org/keyword/exclusiveMinimum") {
+    return `The instance should be greater than ${Schema.value(schema)}.`;
+  }
+
+  if (outputUnit.keyword === "https://json-schema.org/keyword/required") {
+    /** @type {Set<string>} */
+    const required = new Set(Schema.value(schema));
+    const pointer = outputUnit.instanceLocation.replace(/^#/, "");
+    const object = /** @type Object */ (Instance.get(pointer, instance));
+    for (const propertyName of Object.keys(object)) {
+      required.delete(propertyName);
+    }
+
+    return `"${outputUnit.instanceLocation}" is missing required property(s): ${[...required].join(", ")}.`;
+  }
+
+  if (outputUnit.keyword === "https://json-schema.org/keyword/multipleOf") {
+    return `The instance should be of multiple of ${Schema.value(schema)}.`;
+  }
+
+  if (outputUnit.keyword === "https://json-schema.org/keyword/maxProperties") {
+    return `The instance should have maximum ${Schema.value(schema)} properties.`;
+  }
+
+  if (outputUnit.keyword === "https://json-schema.org/keyword/minProperties") {
+    return `The instance should have minimum ${Schema.value(schema)} properties.`;
+  }
+
+  if (outputUnit.keyword === "https://json-schema.org/keyword/const") {
+    return `The instance should be equal to ${Schema.value(schema)}.`;
+  }
+
+  if (outputUnit.keyword === "https://json-schema.org/keyword/enum") {
+    /** @type {Array<string>} */
+    const allowedValues = Schema.value(schema);
+    const pointer = outputUnit.instanceLocation.replace(/^#/, "");
+    const currentValue = /** @type {string} */ (Instance.get(pointer, instance));
+
+    const bestMatch = allowedValues
+      .map((value) => ({
+        value,
+        weight: leven(value, currentValue)
+      }))
+      .sort((a, b) => a.weight - b.weight)[0];
+
+    let suggestion = "";
+    if (
+      allowedValues.length === 1
+      || (bestMatch && bestMatch.weight < bestMatch.value.length)
+    ) {
+      suggestion = ` Did you mean "${bestMatch.value}"?`;
+      return `Unexpected value "${currentValue}". ${suggestion}`;
+    }
+
+    return `Unexpected value "${currentValue}". Expected one of: ${allowedValues.join(",")}.`;
+  }
+  throw Error("TODO: Error message not implemented");
+};