@hyperjump/json-schema 1.12.0 → 1.13.0

package/README.md

@@ -800,7 +800,7 @@ following functions are available in addition to the functions available in the
 * **annotation**: (instance: JsonNode, keyword: string, dialect?: string): any[];
 
     Get the annotations for a keyword for the value represented by the JsonNode.
-* **annotatedWith**: (instance: JsonNode, keyword: string, dialect?: string): JsonNode[];
+* **annotatedWith**: (instance: JsonNode, keyword: string, dialect?: string): Generator<JsonNode>;
 
     Get all JsonNodes that are annotated with the given keyword.
 * **setAnnotation**: (instance: JsonNode, keywordId: string, value: any) => JsonNode

package/annotations/annotated-instance.d.ts

@@ -1,4 +1,4 @@
 export const annotation: <A>(instance: JsonNode, keyword: string, dialectUri?: string) => A[];
-export const annotatedWith: <A extends JsonNode>(instance: A, keyword: string, dialectUri?: string) => A[];
+export const annotatedWith: <A extends JsonNode>(instance: A, keyword: string, dialectUri?: string) => Generator<A>;
 
 export * from "../lib/instance.js";

package/annotations/annotated-instance.js

@@ -1,4 +1,3 @@
-import * as JsonPointer from "@hyperjump/json-pointer";
 import * as Instance from "../lib/instance.js";
 import { getKeywordId } from "../lib/keywords.js";
 
@@ -7,43 +6,15 @@ const defaultDialectId = "https://json-schema.org/validation";
 
 export const annotation = (node, keyword, dialect = defaultDialectId) => {
   const keywordUri = getKeywordId(keyword, dialect);
-
-  let currentNode = node.root;
-  const errors = [...invalidSchemas(currentNode)];
-  for (let segment of JsonPointer.pointerSegments(node.pointer)) {
-    segment = segment === "-" && Instance.typeOf(currentNode) === "array" ? Instance.length(currentNode) : segment;
-    currentNode = Instance.step(segment, currentNode);
-    errors.push(...invalidSchemas(currentNode));
-  }
-
-  const annotations = [];
-  for (const schemaLocation in node.annotations[keywordUri]) {
-    if (!errors.some((error) => schemaLocation.startsWith(error))) {
-      annotations.unshift(node.annotations[keywordUri][schemaLocation]);
-    }
-  }
-
-  return annotations;
+  return node.annotations[keywordUri] ?? [];
 };
 
-const invalidSchemas = function* (node) {
-  for (const error in node.errors) {
-    if (node.errors[error] === "https://json-schema.org/evaluation/validate") {
-      yield error;
-    }
-  }
-};
-
-export const annotatedWith = (instance, keyword, dialectId = defaultDialectId) => {
-  const nodes = [];
-
+export const annotatedWith = function* (instance, keyword, dialectId = defaultDialectId) {
   for (const node of Instance.allNodes(instance)) {
     if (annotation(node, keyword, dialectId).length > 0) {
-      nodes.push(node);
+      yield node;
     }
   }
-
-  return nodes;
 };
 
 export * from "../lib/instance.js";

package/draft-04/additionalItems.js

@@ -26,6 +26,8 @@ const interpret = ([numberOfItems, additionalItems], instance, context) => {
   );
 };
 
+const simpleApplicator = true;
+
 const collectEvaluatedItems = (keywordValue, instance, context) => {
   if (!interpret(keywordValue, instance, context)) {
     return false;
@@ -39,4 +41,4 @@ const collectEvaluatedItems = (keywordValue, instance, context) => {
   return evaluatedIndexes;
 };
 
-export default { id, compile, interpret, collectEvaluatedItems };
+export default { id, compile, interpret, simpleApplicator, collectEvaluatedItems };

package/draft-04/dependencies.js

@@ -31,4 +31,6 @@ const interpret = (dependencies, instance, context) => {
   });
 };
 
-export default { id, compile, interpret };
+const simpleApplicator = true;
+
+export default { id, compile, interpret, simpleApplicator };

package/draft-04/items.js

@@ -34,10 +34,12 @@ const interpret = (items, instance, context) => {
   }
 };
 
+const simpleApplicator = true;
+
 const collectEvaluatedItems = (items, instance, context) => {
   return interpret(items, instance, context) && (typeof items === "string"
     ? collectSet(range(0, Instance.length(instance)))
     : collectSet(range(0, items.length)));
 };
 
-export default { id, compile, interpret, collectEvaluatedItems };
+export default { id, compile, interpret, simpleApplicator, collectEvaluatedItems };

package/draft-06/index.d.ts

@@ -2,9 +2,10 @@ import type { Json } from "@hyperjump/json-pointer";
 import type { JsonSchemaType } from "../lib/common.js";
 
 
-export type JsonSchemaDraft06 = boolean | {
+export type JsonSchemaDraft06Ref = {
   $ref: string;
-} | {
+};
+export type JsonSchemaDraft06Object = {
   $schema?: "http://json-schema.org/draft-06/schema#";
   $id?: string;
   title?: string;
@@ -43,5 +44,6 @@ export type JsonSchemaDraft06 = boolean | {
   oneOf?: JsonSchemaDraft06[];
   not?: JsonSchemaDraft06;
 };
+export type JsonSchemaDraft06 = boolean | JsonSchemaDraft06Ref | JsonSchemaDraft06Object;
 
 export * from "../lib/index.js";

package/draft-2019-09/index.d.ts

@@ -2,7 +2,7 @@ import type { Json } from "@hyperjump/json-pointer";
 import type { JsonSchemaType } from "../lib/common.js";
 
 
-export type JsonSchemaDraft201909 = boolean | {
+export type JsonSchemaDraft201909Object = {
   $schema?: "https://json-schema.org/draft/2019-09/schema";
   $id?: string;
   $anchor?: string;
@@ -61,5 +61,6 @@ export type JsonSchemaDraft201909 = boolean | {
   contentEncoding?: string;
   contentSchema?: JsonSchemaDraft201909;
 };
+export type JsonSchemaDraft201909 = boolean | JsonSchemaDraft201909Object;
 
 export * from "../lib/index.js";

package/draft-2020-12/dynamicRef.js

@@ -21,8 +21,10 @@ const evaluate = (strategy, [id, fragment, ref], instance, context) => {
   }
 };
 
+const simpleApplicator = true;
+
 const interpret = (...args) => evaluate(Validation.interpret, ...args);
 const collectEvaluatedProperties = (...args) => evaluate(Validation.collectEvaluatedProperties, ...args);
 const collectEvaluatedItems = (...args) => evaluate(Validation.collectEvaluatedItems, ...args);
 
-export default { id, compile, interpret, collectEvaluatedProperties, collectEvaluatedItems };
+export default { id, compile, interpret, simpleApplicator, collectEvaluatedProperties, collectEvaluatedItems };

package/draft-2020-12/index.d.ts

@@ -2,7 +2,7 @@ import type { Json } from "@hyperjump/json-pointer";
 import type { JsonSchemaType } from "../lib/common.js";
 
 
-export type JsonSchemaDraft202012 = boolean | {
+export type JsonSchemaDraft202012Object = {
   $schema?: "https://json-schema.org/draft/2020-12/schema";
   $id?: string;
   $anchor?: string;
@@ -62,5 +62,6 @@ export type JsonSchemaDraft202012 = boolean | {
   contentEncoding?: string;
   contentSchema?: JsonSchemaDraft202012;
 };
+export type JsonSchemaDraft202012 = boolean | JsonSchemaDraft202012Object;
 
 export * from "../lib/index.js";

package/lib/experimental.d.ts

@@ -18,7 +18,7 @@ export type CompiledSchema = {
 
 type AST = {
   metaData: Record<string, MetaData>;
-} & Record<string, Node<Node<unknown>[] | boolean>>;
+} & Record<string, Node<unknown>[] | boolean>;
 
 type Node<A> = [keywordId: string, schemaUri: string, keywordValue: A];
 
@@ -73,7 +73,7 @@ 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;
+  annotation?: <B>(compiledKeywordValue: A, instance: JsonNode) => B | undefined;
 };
 
 export type ValidationContext = {
@@ -81,6 +81,7 @@ export type ValidationContext = {
   dynamicAnchors: Anchors;
   errors: OutputUnit[];
   annotations: OutputUnit[];
+  outputFormat: OutputFormat;
 };
 
 export const Validation: Keyword<string>;

package/lib/keywords/contentEncoding.js

@@ -1,10 +1,18 @@
 import * as Browser from "@hyperjump/browser";
+import * as Instance from "../instance.js";
 
 
 const id = "https://json-schema.org/keyword/contentEncoding";
 
 const compile = (schema) => Browser.value(schema);
 const interpret = () => true;
-const annotation = (contentEncoding) => contentEncoding;
+
+const annotation = (contentEncoding, instance) => {
+  if (Instance.typeOf(instance) !== "string") {
+    return;
+  }
+
+  return contentEncoding;
+};
 
 export default { id, compile, interpret, annotation };

package/lib/keywords/contentMediaType.js

@@ -1,10 +1,18 @@
 import * as Browser from "@hyperjump/browser";
+import * as Instance from "../instance.js";
 
 
 const id = "https://json-schema.org/keyword/contentMediaType";
 
 const compile = (schema) => Browser.value(schema);
 const interpret = () => true;
-const annotation = (contentMediaType) => contentMediaType;
+
+const annotation = (contentMediaType, instance) => {
+  if (Instance.typeOf(instance) !== "string") {
+    return;
+  }
+
+  return contentMediaType;
+};
 
 export default { id, compile, interpret, annotation };

package/lib/keywords/contentSchema.js

@@ -1,10 +1,25 @@
 import { canonicalUri } from "../schema.js";
+import * as Browser from "@hyperjump/browser";
+import * as Instance from "../instance.js";
+import { getKeywordName } from "../keywords.js";
 
 
 const id = "https://json-schema.org/keyword/contentSchema";
 
-const compile = (contentSchema) => canonicalUri(contentSchema);
+const compile = async (contentSchema, _ast, parentSchema) => {
+  const contentMediaTypeKeyword = getKeywordName(contentSchema.document.dialectId, "https://json-schema.org/keyword/contentMediaType");
+  const contentMediaType = await Browser.step(contentMediaTypeKeyword, parentSchema);
+  return Browser.value(contentMediaType) && canonicalUri(contentSchema);
+};
+
 const interpret = () => true;
-const annotation = (contentSchema) => contentSchema;
+
+const annotation = (contentSchema, instance) => {
+  if (Instance.typeOf(instance) !== "string") {
+    return;
+  }
+
+  return contentSchema;
+};
 
 export default { id, compile, interpret, annotation };

package/lib/keywords/validation.js

@@ -85,15 +85,18 @@ const interpret = (url, instance, { ast, dynamicAnchors, errors, annotations, ou
             }
             errors.push(...context.errors);
           } else {
-            if (keywordHandler.annotation) {
-              schemaAnnotations.push({
+            const annotation = keywordHandler.annotation?.(keywordValue, instance);
+            if (annotation !== undefined) {
+              schemaAnnotations.unshift({
                 keyword: keywordId,
                 absoluteKeywordLocation: schemaUri,
                 instanceLocation: Instance.uri(instance),
-                annotation: keywordHandler.annotation(keywordValue)
+                annotation: annotation
               });
             }
-            schemaAnnotations.push(...context.annotations);
+            for (const contextAnnotation of context.annotations) {
+              schemaAnnotations.unshift(contextAnnotation);
+            }
           }
           break;
         case DETAILED: {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hyperjump/json-schema",
-  "version": "1.12.0",
+  "version": "1.13.0",
   "description": "A JSON Schema validator with support for custom keywords, vocabularies, and dialects",
   "type": "module",
   "main": "./stable/index.js",

package/stable/index.d.ts

@@ -2,6 +2,8 @@ import type { Json } from "@hyperjump/json-pointer";
 import type { JsonSchemaType } from "../lib/common.js";
 
 
+export type JsonSchemaType = JsonSchemaType;
+
 export type JsonSchema = boolean | {
   $schema?: "https://json-schema.org/validation";
   $id?: string;