Improve setting annotation in keyword handler

Author: jdesrosiers

README.md

@@ -547,6 +547,10 @@ These are available from the `@hyperjump/json-schema/experimental` export.
       * 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.
+      * annotation?: (compiledKeywordValue: any) => any
+
+          If the keyword is an annotation, it will need to implement this
+          function to return the annotation.
 
     * **ValidationContext**: object
       * ast: AST
@@ -696,7 +700,7 @@ Schema.
 
 ### Usage
 An annotated JSON document is represented as a
-(JsonNode)[#/instance-api-experimental] AST. You can use this AST to traverse
+(JsonNode)[#instance-api-experimental] AST. You can use this AST to traverse
 the data structure and get annotations for the values it represents.
 
 ```javascript

annotations/index.js

@@ -16,7 +16,7 @@ export const annotate = async (schemaUri, json = undefined, outputFormat = undef
 export const interpret = ({ ast, schemaUri }, instance, outputFormat = BASIC) => {
   const errors = [];
   const annotations = [];
-  const context = { ast, schemaUri, dynamicAnchors: {}, errors, annotations, outputFormat };
+  const context = { ast, dynamicAnchors: {}, errors, annotations, outputFormat };
   const valid = Validation.interpret(schemaUri, instance, context);
 
   if (!valid) {

bundle/generate-snapshots.js

@@ -30,7 +30,7 @@ const snapshotGenerator = async (version, dialect) => {
       const instance = Instance.fromJs(test.instance);
       const errors = [];
       const annotations = [];
-      const context = { ast, schemaUri, dynamicAnchors: {}, errors, annotations, outputFormat: BASIC };
+      const context = { ast, dynamicAnchors: {}, errors, annotations, outputFormat: BASIC };
       const valid = Validation.interpret(schemaUri, instance, context);
 
       const expectedOutput = { valid, errors, annotations };

bundle/test-suite.spec.ts

@@ -60,7 +60,7 @@ const testRunner = (version: number, dialect: string) => {
                 const instance = Instance.fromJs(test.instance);
                 const errors: OutputUnit[] = [];
                 const annotations: OutputUnit[] = [];
-                const context = { ast, schemaUri, dynamicAnchors: {}, errors, annotations, outputFormat: BASIC };
+                const context = { ast, dynamicAnchors: {}, errors, annotations, outputFormat: BASIC };
                 const valid = Validation.interpret(schemaUri, instance, context);
 
                 const output = { valid, errors, annotations };

lib/core.js

@@ -32,7 +32,7 @@ export const compile = async (schema) => {
 
 export const interpret = curry(({ ast, schemaUri }, instance, outputFormat = FLAG) => {
   const errors = [];
-  const context = { ast, schemaUri, dynamicAnchors: {}, errors, annotations: [], outputFormat };
+  const context = { ast, dynamicAnchors: {}, errors, annotations: [], outputFormat };
   const valid = Validation.interpret(schemaUri, instance, context);
   return outputFormat === FLAG || valid ? { valid } : { valid, errors };
 });

lib/experimental.d.ts

@@ -73,11 +73,11 @@ export type Keyword<A> = {
   collectEvaluatedProperties?: (compiledKeywordValue: A, instance: JsonNode, context: ValidationContext, isTop?: boolean) => Set<string> | false;
   collectEvaluatedItems?: (compiledKeywordValue: A, instance: JsonNode, context: ValidationContext, isTop?: boolean) => Set<number> | false;
   collectExternalIds?: (visited: Set<string>, parentSchema: Browser<SchemaDocument>, schema: Browser<SchemaDocument>) => Promise<Set<string>>;
+  annotation?: <B>(compiledKeywordValue: A) => B;
 };
 
 export type ValidationContext = {
   ast: AST;
-  schemaUri: string;
   dynamicAnchors: Anchors;
   errors: OutputUnit[];
   annotations: OutputUnit[];

lib/keywords/contentEncoding.js

@@ -1,19 +1,10 @@
 import * as Browser from "@hyperjump/browser";
-import * as Instance from "../../annotations/annotated-instance.js";
 
 
 const id = "https://json-schema.org/keyword/contentEncoding";
 
 const compile = (schema) => Browser.value(schema);
+const interpret = () => true;
+const annotation = (contentEncoding) => contentEncoding;
 
-const interpret = (contentEncoding, instance, { annotations, schemaUri }) => {
-  annotations.push({
-    keyword: id,
-    absoluteKeywordLocation: schemaUri,
-    instanceLocation: Instance.uri(instance),
-    annotation: contentEncoding
-  });
-  return true;
-};
-
-export default { id, compile, interpret };
+export default { id, compile, interpret, annotation };

lib/keywords/contentMediaType.js

@@ -1,19 +1,10 @@
 import * as Browser from "@hyperjump/browser";
-import * as Instance from "../../annotations/annotated-instance.js";
 
 
 const id = "https://json-schema.org/keyword/contentMediaType";
 
 const compile = (schema) => Browser.value(schema);
+const interpret = () => true;
+const annotation = (contentMediaType) => contentMediaType;
 
-const interpret = (contentMediaType, instance, { annotations, schemaUri }) => {
-  annotations.push({
-    keyword: id,
-    absoluteKeywordLocation: schemaUri,
-    instanceLocation: Instance.uri(instance),
-    annotation: contentMediaType
-  });
-  return true;
-};
-
-export default { id, compile, interpret };
+export default { id, compile, interpret, annotation };

lib/keywords/contentSchema.js

@@ -1,19 +1,10 @@
 import { canonicalUri } from "../schema.js";
-import * as Instance from "../../annotations/annotated-instance.js";
 
 
 const id = "https://json-schema.org/keyword/contentSchema";
 
 const compile = (contentSchema) => canonicalUri(contentSchema);
+const interpret = () => true;
+const annotation = (contentSchema) => contentSchema;
 
-const interpret = (contentSchema, instance, { annotations, schemaUri }) => {
-  annotations.push({
-    keyword: id,
-    absoluteKeywordLocation: schemaUri,
-    instanceLocation: Instance.uri(instance),
-    annotation: contentSchema
-  });
-  return true;
-};
-
-export default { id, compile, interpret };
+export default { id, compile, interpret, annotation };

lib/keywords/default.js

@@ -1,19 +1,10 @@
 import * as Browser from "@hyperjump/browser";
-import * as Instance from "../../annotations/annotated-instance.js";
 
 
 const id = "https://json-schema.org/keyword/default";
 
 const compile = (schema) => Browser.value(schema);
+const interpret = () => true;
+const annotation = (value) => value;
 
-const interpret = (value, instance, { annotations, schemaUri }) => {
-  annotations.push({
-    keyword: id,
-    absoluteKeywordLocation: schemaUri,
-    instanceLocation: Instance.uri(instance),
-    annotation: value
-  });
-  return true;
-};
-
-export default { id, compile, interpret };
+export default { id, compile, interpret, annotation };