initialize the normalizeOutput for betterJsonSchemaErrors

Author: arpitkuriyal

package-lock.json

@@ -37,6 +37,7 @@
     "vitest": "*"
   },
   "dependencies": {
+    "@hyperjump/browser": "^1.3.1",
     "@hyperjump/json-schema": "^1.14.1"
   }
 }

package.json

@@ -1 +1,45 @@
-export const hello: string;
+export const betterJsonSchemaErrors: (
+  instance: Json,
+  schema: SchemaObject,
+  errorOutput: OutputFormat
+) => BetterJsonSchemaErrors;
+
+export type BetterJsonSchemaErrors = {
+  errors: ErrorObject[];
+};
+
+export type ErrorObject = {
+  schemaLocation: string;
+  instanceLocation: string;
+  message: string;
+};
+
+export type Json = string | number | boolean | null | JsonObject | Json[];
+export type JsonObject = {
+  [property: string]: Json;
+};
+
+export type SchemaFragment = string | number | boolean | null | SchemaObject | SchemaFragment[];
+export type SchemaObject = {
+  [keyword: string]: SchemaFragment;
+};
+
+export type OutputFormat = {
+  valid: boolean;
+  errors: OutputUnit[];
+};
+
+export type OutputUnit = {
+  valid?: boolean;
+  absoluteKeywordLocation?: string;
+  keywordLocation?: string;
+  instanceLocation: string;
+  error?: string;
+  errors?: OutputUnit[];
+};
+
+export type NormalizedError = {
+  valid: false;
+  absoluteKeywordLocation: string;
+  instanceLocation: string;
+};

src/index.d.ts

@@ -1,6 +1,21 @@
+import { normalizeOutputFormat } from "./normalizeOutputFormat/normalizeOutput.js";
+
 /**
- * @import * as API from "./index.d.ts"
+ * @import {betterJsonSchemaErrors} from "./index.d.ts"
  */
 
-/** @type API.hello */
-export const hello = "world";
+/** @type betterJsonSchemaErrors */
+export function betterJsonSchemaErrors(instance, schema, errorOutput) {
+  const normalizedErrors = normalizeOutputFormat(errorOutput);
+
+  const errors = [];
+  for (const error of normalizedErrors) {
+    errors.push({
+      message: "The instance should be at least 3 characters",
+      instanceLocation: error.instanceLocation,
+      schemaLocation: error.absoluteKeywordLocation
+    });
+  }
+
+  return { errors };
+}

src/index.js

@@ -1,8 +1,6 @@
 import { describe, expect, test } from "vitest";
-import { hello } from "./index.js";
 
 describe("Better JSON Schema Errors", () => {
   test("greeting", () => {
-    expect(hello).to.equal("world");
   });
 });

src/index.test.js renamed to src/index.test.ts

@@ -0,0 +1,52 @@
+/**
+ * @import {OutputFormat, OutputUnit, NormalizedError } from "../index.d.ts"
+ */
+
+/** @type {(errorOutput: OutputFormat) => NormalizedError[]} */
+export function normalizeOutputFormat(errorOutput) {
+  /** @type NormalizedError[] */
+  const output = [];
+  if (!errorOutput || errorOutput.valid !== false) {
+    throw new Error("error Output must follow Draft 2019-09");
+  }
+
+  /** @type {(errorOutput: OutputUnit) => void} */
+  function collectErrors(error) {
+    if (error.valid) return;
+
+    if (!("instanceLocation" in error) || !("absoluteKeywordLocation" in error || "keywordLocation" in error)) {
+      throw new Error("error Output must follow Draft 2019-09");
+    }
+
+    // TODO: Convert keywordLocation to absoluteKeywordLocation
+    error.absoluteKeywordLocation ??= "https://example.com/main#/minLength";
+
+    output.push({
+      valid: false,
+      absoluteKeywordLocation: error.absoluteKeywordLocation,
+      instanceLocation: normalizeInstanceLocation(error.instanceLocation)
+    });
+
+    if (error.errors) {
+      for (const nestedError of error.errors) {
+        collectErrors(nestedError);
+      }
+    }
+  }
+
+  if (!errorOutput.errors) {
+    throw new Error("error Output must follow Draft 2019-09");
+  }
+
+  for (const err of errorOutput.errors) {
+    collectErrors(err);
+  }
+
+  return output;
+}
+
+/** @type (location: string) => string */
+function normalizeInstanceLocation(location) {
+  if (location.startsWith("/") || location === "") return "#" + location;
+  return location;
+}