Refactor output and annotation handling to fix bug

Author: jdesrosiers

README.md

@@ -402,9 +402,9 @@ addKeyword({
     // );
   },
 
-  interpret: (implies, instance, ast, dynamicAnchors, quiet) => {
+  interpret: (implies, instance, context) => {
     return implies.reduce((valid, schema) => {
-      return !valid || Validation.interpret(schema, instance, ast, dynamicAnchors, quiet);
+      return !valid || Validation.interpret(schema, instance, context);
     }, true);
   }
 });
@@ -524,23 +524,30 @@ These are available from the `@hyperjump/json-schema/experimental` export.
           is needed for compiling sub-schemas. The `parentSchema` parameter is
           primarily useful for looking up the value of an adjacent keyword that
           might effect this one.
-      * interpret: (compiledKeywordValue: any, instance: JsonNode, ast: AST, dynamicAnchors: object, quiet: boolean, schemaLocation: string) => boolean
+      * interpret: (compiledKeywordValue: any, instance: JsonNode, context: ValidationContext) => boolean
 
           This function takes the value returned by the `compile` function and
           the instance value that is being validated and returns whether the
           value is valid or not. The other parameters are only needed for
           validating sub-schemas.
-      * collectEvaluatedProperties?: (compiledKeywordValue: any, instance: JsonNode, ast: AST, dynamicAnchors: object) => Set\<string> | false
+      * collectEvaluatedProperties?: (compiledKeywordValue: any, instance: JsonNode, context: ValidationContext, isTop?: boolean) => Set\<string> | false
 
           If the keyword is an applicator, it will need to implement this
           function for `unevaluatedProperties` to work as expected.
-      * collectEvaluatedItems?: (compiledKeywordValue: A, instance: JsonNode, ast: AST, dynamicAnchors: object) => Set\<number> | false
+      * collectEvaluatedItems?: (compiledKeywordValue: A, instance: JsonNode, context: ValidationContext, isTop?: boolean) => Set\<number> | false
 
           If the keyword is an applicator, it will need to implement this
           function for `unevaluatedItems` to work as expected.
       * collectExternalIds?: (visited: Set\<string>, parentSchema: Browser, schema: Browser) => Set\<string>
           If the keyword is an applicator, it will need to implement this
-      function to work properly with the [bundle](#bundling) feature.
+          function to work properly with the [bundle](#bundling) feature.
+
+    * **ValidationContext**: object
+      * ast: AST
+      * dynamicAnchors: object
+      * schemaUrl: string
+      * errors: OutputUnit[]
+      * annotations: OutputUnit[]
 * **defineVocabulary**: (id: string, keywords: { [keyword: string]: string }) => void
 
     Define a vocabulary that maps keyword name to keyword URIs defined using

annotations/annotated-instance.d.ts

@@ -1,4 +1,3 @@
-export const setAnnotation: (keywordUri: string, schemaLocation: string, value: string) => void;
 export const annotation: <A>(instance: JsonNode, keyword: string, dialectUri?: string) => A[];
 export const annotatedWith: <A extends JsonNode>(instance: A, keyword: string, dialectUri?: string) => A[];
 

annotations/annotated-instance.js

@@ -5,13 +5,6 @@ import { getKeywordId } from "../lib/keywords.js";
 
 const defaultDialectId = "https://json-schema.org/validation";
 
-export const setAnnotation = (node, keywordUri, schemaLocation, value) => {
-  if (!(keywordUri in node.annotations)) {
-    node.annotations[keywordUri] = {};
-  }
-  node.annotations[keywordUri][schemaLocation] = value;
-};
-
 export const annotation = (node, keyword, dialect = defaultDialectId) => {
   const keywordUri = getKeywordId(keyword, dialect);
 

annotations/index.js

@@ -1,5 +1,6 @@
 import { ValidationError } from "./validation-error.js";
-import { getSchema, compile, interpret as validate, BASIC } from "../lib/experimental.js";
+import { getSchema, compile, BASIC } from "../lib/experimental.js";
+import Validation from "../lib/keywords/validation.js";
 import * as Instance from "../lib/instance.js";
 
 
@@ -12,11 +13,24 @@ export const annotate = async (schemaUri, json = undefined, outputFormat = undef
 };
 
 export const interpret = ({ ast, schemaUri }, instance, outputFormat = BASIC) => {
-  const result = validate({ ast, schemaUri }, instance, outputFormat);
-  if (!result.valid) {
+  const errors = [];
+  const annotations = [];
+  const valid = Validation.interpret(schemaUri, instance, { ast, schemaUri, dynamicAnchors: {}, errors, annotations });
+
+  if (!valid) {
+    const result = outputFormat === BASIC && !valid ? { valid, errors } : { valid };
     throw new ValidationError(result);
   }
 
+  for (const annotation of annotations) {
+    const node = Instance.get(annotation.instanceLocation, instance);
+    const keyword = annotation.keyword;
+    if (!node.annotations[keyword]) {
+      node.annotations[keyword] = [];
+    }
+    node.annotations[keyword].push(annotation.annotation);
+  }
+
   return instance;
 };
 

bundle/generate-snapshots.js

@@ -1,6 +1,6 @@
 import { writeFile, mkdir, rm } from "node:fs/promises";
-import { isCompatible, md5, loadSchemas, testSuite, toOutput, unloadSchemas } from "./test-utils.js";
-import { compile, getSchema, interpret } from "../lib/experimental.js";
+import { isCompatible, md5, loadSchemas, testSuite, unloadSchemas } from "./test-utils.js";
+import { compile, getSchema, Validation } from "../lib/experimental.js";
 import "../stable/index.js";
 import "../draft-2020-12/index.js";
 import "../draft-2019-09/index.js";
@@ -23,11 +23,17 @@ const snapshotGenerator = async (version, dialect) => {
     let testIndex = 0;
     for (const test of testCase.tests) {
       loadSchemas(testCase, mainSchemaUri, dialect);
+
       const schema = await getSchema(mainSchemaUri);
-      const compiledSchema = await compile(schema);
+      const { ast, schemaUri } = await compile(schema);
+
       const instance = Instance.fromJs(test.instance);
-      interpret(compiledSchema, instance);
-      const expectedOutput = toOutput(instance);
+      const errors = [];
+      const annotations = [];
+      const valid = Validation.interpret(schemaUri, instance, { ast, schemaUri, dynamicAnchors: {}, errors, annotations });
+
+      const expectedOutput = { valid, errors, annotations };
+
       unloadSchemas(testCase, mainSchemaUri);
 
       const testId = md5(`${version}|${dialect}|${testCase.description}|${testIndex}`);

bundle/snapshots/0176f79e8816433f3b23683ba5f38ace

@@ -1,9 +1,11 @@
 {
-  "#": {
-    "errors": {
-      "https://bundler.hyperjump.io/main#/type": "https://json-schema.org/keyword/type",
-      "https://bundler.hyperjump.io/main#": "https://json-schema.org/evaluation/validate"
-    },
-    "annotations": {}
-  }
+  "valid": false,
+  "errors": [
+    {
+      "keyword": "https://json-schema.org/keyword/type",
+      "absoluteKeywordLocation": "https://bundler.hyperjump.io/main#/type",
+      "instanceLocation": "#"
+    }
+  ],
+  "annotations": []
 }

bundle/snapshots/01be86475358c8fa8bd0cbb66acffae9

@@ -1,10 +1,12 @@
 {
-  "#": {
-    "errors": {},
-    "annotations": {
-      "https://json-schema.org/keyword/title": {
-        "https://bundler.hyperjump.io/string#": "String"
-      }
+  "valid": true,
+  "errors": [],
+  "annotations": [
+    {
+      "keyword": "https://json-schema.org/keyword/title",
+      "absoluteKeywordLocation": "https://bundler.hyperjump.io/string#/title",
+      "instanceLocation": "#",
+      "annotation": "String"
     }
-  }
+  ]
 }

bundle/snapshots/0257ca47cb26d95af6cddee31dc7ad4c

@@ -1,22 +1,21 @@
 {
-  "#": {
-    "errors": {
-      "https://bundler.hyperjump.io/main#/unevaluatedProperties": "https://json-schema.org/keyword/unevaluatedProperties",
-      "https://bundler.hyperjump.io/main#": "https://json-schema.org/evaluation/validate"
+  "valid": false,
+  "errors": [
+    {
+      "keyword": "https://json-schema.org/keyword/unevaluatedProperties",
+      "absoluteKeywordLocation": "https://bundler.hyperjump.io/main#/unevaluatedProperties",
+      "instanceLocation": "#"
     },
-    "annotations": {}
-  },
-  "#/foo": {
-    "errors": {
-      "https://bundler.hyperjump.io/string#/type": "https://json-schema.org/keyword/type",
-      "https://bundler.hyperjump.io/string#": "https://json-schema.org/evaluation/validate",
-      "https://bundler.hyperjump.io/main#/unevaluatedProperties/$ref": "https://json-schema.org/keyword/ref",
-      "https://bundler.hyperjump.io/main#/unevaluatedProperties": "https://json-schema.org/evaluation/validate"
+    {
+      "keyword": "https://json-schema.org/keyword/ref",
+      "absoluteKeywordLocation": "https://bundler.hyperjump.io/main#/unevaluatedProperties/$ref",
+      "instanceLocation": "#/foo"
     },
-    "annotations": {
-      "https://json-schema.org/keyword/title": {
-        "https://bundler.hyperjump.io/string#": "String"
-      }
+    {
+      "keyword": "https://json-schema.org/keyword/type",
+      "absoluteKeywordLocation": "https://bundler.hyperjump.io/string#/type",
+      "instanceLocation": "#/foo"
     }
-  }
+  ],
+  "annotations": []
 }

bundle/snapshots/02c66554839e629b28f800fe38f4c622

@@ -1,13 +1,11 @@
 {
-  "#": {
-    "errors": {
-      "https://bundler.hyperjump.io/main#/not": "https://json-schema.org/keyword/not",
-      "https://bundler.hyperjump.io/main#": "https://json-schema.org/evaluation/validate"
-    },
-    "annotations": {
-      "https://json-schema.org/keyword/title": {
-        "https://bundler.hyperjump.io/string#": "String"
-      }
+  "valid": false,
+  "errors": [
+    {
+      "keyword": "https://json-schema.org/keyword/not",
+      "absoluteKeywordLocation": "https://bundler.hyperjump.io/main#/not",
+      "instanceLocation": "#"
     }
-  }
+  ],
+  "annotations": []
 }

bundle/snapshots/047b47772606c7120c55e3e5a7630890

@@ -1,10 +1,5 @@
 {
-  "#": {
-    "errors": {},
-    "annotations": {}
-  },
-  "#/0": {
-    "errors": {},
-    "annotations": {}
-  }
+  "valid": true,
+  "errors": [],
+  "annotations": []
 }