Restore support for DETAILED output

Author: jdesrosiers

annotations/index.js

@@ -1,3 +1,4 @@
+import { FLAG } from "../lib/index.js";
 import { ValidationError } from "./validation-error.js";
 import { getSchema, compile, BASIC } from "../lib/experimental.js";
 import Validation from "../lib/keywords/validation.js";
@@ -15,10 +16,11 @@ export const annotate = async (schemaUri, json = undefined, outputFormat = undef
 export const interpret = ({ ast, schemaUri }, instance, outputFormat = BASIC) => {
   const errors = [];
   const annotations = [];
-  const valid = Validation.interpret(schemaUri, instance, { ast, schemaUri, dynamicAnchors: {}, errors, annotations });
+  const context = { ast, schemaUri, dynamicAnchors: {}, errors, annotations, outputFormat };
+  const valid = Validation.interpret(schemaUri, instance, context);
 
   if (!valid) {
-    const result = outputFormat === BASIC && !valid ? { valid, errors } : { valid };
+    const result = outputFormat === FLAG || valid ? { valid } : { valid, errors };
     throw new ValidationError(result);
   }
 

bundle/generate-snapshots.js

@@ -1,6 +1,6 @@
 import { writeFile, mkdir, rm } from "node:fs/promises";
 import { isCompatible, md5, loadSchemas, testSuite, unloadSchemas } from "./test-utils.js";
-import { compile, getSchema, Validation } from "../lib/experimental.js";
+import { BASIC, compile, getSchema, Validation } from "../lib/experimental.js";
 import "../stable/index.js";
 import "../draft-2020-12/index.js";
 import "../draft-2019-09/index.js";
@@ -30,7 +30,8 @@ const snapshotGenerator = async (version, dialect) => {
       const instance = Instance.fromJs(test.instance);
       const errors = [];
       const annotations = [];
-      const valid = Validation.interpret(schemaUri, instance, { ast, schemaUri, dynamicAnchors: {}, errors, annotations });
+      const context = { ast, schemaUri, dynamicAnchors: {}, errors, annotations, outputFormat: BASIC };
+      const valid = Validation.interpret(schemaUri, instance, context);
 
       const expectedOutput = { valid, errors, annotations };
 

bundle/test-suite.spec.ts

@@ -2,7 +2,7 @@ import { readFile } from "node:fs/promises";
 import { describe, it, expect, beforeAll, afterAll } from "vitest";
 import { isCompatible, md5, loadSchemas, unloadSchemas, testSuite } from "./test-utils.js";
 import { registerSchema, unregisterSchema } from "../lib/index.js";
-import { compile, getKeywordName, getSchema, Validation } from "../lib/experimental.js";
+import { BASIC, compile, getKeywordName, getSchema, Validation } from "../lib/experimental.js";
 import * as Instance from "../lib/instance.js";
 import "../stable/index.js";
 import "../draft-2020-12/index.js";
@@ -62,7 +62,8 @@ const testRunner = (version: number, dialect: string) => {
                 const instance = Instance.fromJs(test.instance);
                 const errors: OutputUnit[] = [];
                 const annotations: OutputUnit[] = [];
-                const valid = Validation.interpret(schemaUri, instance, { ast, schemaUri, dynamicAnchors: {}, errors, annotations });
+                const context = { ast, schemaUri, dynamicAnchors: {}, errors, annotations, outputFormat: BASIC };
+                const valid = Validation.interpret(schemaUri, instance, context);
 
                 const output = { valid, errors, annotations };
 

lib/core.js

@@ -13,7 +13,7 @@ import { getKeywordName } from "./keywords.js";
 import Validation from "./keywords/validation.js";
 
 
-export const FLAG = "FLAG", BASIC = "BASIC";
+export const FLAG = "FLAG", BASIC = "BASIC", DETAILED = "DETAILED";
 setMetaSchemaOutputFormat(FLAG);
 
 export const validate = async (url, value = undefined, outputFormat = undefined) => {
@@ -32,8 +32,9 @@ export const compile = async (schema) => {
 
 export const interpret = curry(({ ast, schemaUri }, instance, outputFormat = FLAG) => {
   const errors = [];
-  const valid = Validation.interpret(schemaUri, instance, { ast, schemaUri, dynamicAnchors: {}, errors, annotations: [] });
-  return outputFormat === BASIC && !valid ? { valid, errors } : { valid };
+  const context = { ast, schemaUri, dynamicAnchors: {}, errors, annotations: [], outputFormat };
+  const valid = Validation.interpret(schemaUri, instance, context);
+  return outputFormat === FLAG || valid ? { valid } : { valid, errors };
 });
 
 const metaValidators = {};

lib/experimental.d.ts

@@ -32,6 +32,7 @@ type Anchors = Record<string, string>;
 
 // Output Formats
 export const BASIC: "BASIC";
+export const DETAILED: "DETAILED";
 
 // Schema
 export const getSchema: (uri: string, browser?: Browser) => Promise<Browser<SchemaDocument>>;

lib/experimental.js

@@ -1,4 +1,4 @@
-export { compile, interpret, BASIC } from "./core.js";
+export { compile, interpret, BASIC, DETAILED } from "./core.js";
 export {
   addKeyword, getKeyword, getKeywordByName, getKeywordName, getKeywordId,
   defineVocabulary,

lib/keywords/itemPattern.js

@@ -39,7 +39,7 @@ const compile = async (schema, ast) => {
     .reduce(union);
 };
 
-const evaluate = (strategy) => (nfa, instance, context) => {
+const evaluate = (strategy, nfa, instance, context) => {
   if (Instance.typeOf(instance) !== "array") {
     return true;
   }
@@ -84,8 +84,8 @@ const transition = (strategy, transitions, instance, context) => {
   }
 };
 
-const interpret = evaluate(Validation.interpret);
-const collectEvalatedProperties = evaluate(Validation.collectEvaluatedProperties);
-const collectEvalatedItems = evaluate(Validation.collectEvaluatedItems);
+const interpret = (...args) => evaluate(Validation.interpret, ...args);
+const collectEvalatedProperties = (...args) => evaluate(Validation.collectEvaluatedProperties, ...args);
+const collectEvalatedItems = (...args) => evaluate(Validation.collectEvaluatedItems, ...args);
 
 export default { id, compile, interpret, collectEvalatedProperties, collectEvalatedItems };

lib/keywords/validation.js

@@ -4,7 +4,8 @@ import { append as pointerAppend } from "@hyperjump/json-pointer";
 import { publishAsync } from "../pubsub.js";
 import * as Instance from "../instance.js";
 import { toAbsoluteUri } from "../common.js";
-import { canonicalUri, getKeyword, getKeywordByName } from "../experimental.js";
+import { canonicalUri, getKeyword, getKeywordByName, BASIC, DETAILED } from "../experimental.js";
+import { FLAG } from "../index.js";
 
 
 const id = "https://json-schema.org/evaluation/validate";
@@ -44,7 +45,7 @@ const compile = async (schema, ast) => {
   return url;
 };
 
-const interpret = (url, instance, { ast, dynamicAnchors, errors, annotations }) => {
+const interpret = (url, instance, { ast, dynamicAnchors, errors, annotations, outputFormat }) => {
   dynamicAnchors = { ...ast.metaData[toAbsoluteUri(url)].dynamicAnchors, ...dynamicAnchors };
 
   if (typeof ast[url] === "boolean") {
@@ -63,15 +64,24 @@ const interpret = (url, instance, { ast, dynamicAnchors, errors, annotations })
 
     let isSchemaValid = true;
     for (const [keywordId, schemaUri, keywordValue] of ast[url]) {
-      const context = { ast, dynamicAnchors, schemaUri, errors: [], annotations: [] };
+      const context = { ast, dynamicAnchors, schemaUri, errors: [], annotations: [], outputFormat };
       if (!getKeyword(keywordId).interpret(keywordValue, instance, context)) {
         isSchemaValid = false;
-        errors.push({
+        if (outputFormat === FLAG) {
+          continue;
+        }
+
+        const outputUnit = {
           keyword: keywordId,
           absoluteKeywordLocation: schemaUri,
           instanceLocation: Instance.uri(instance)
-        });
-        errors.push(...context.errors);
+        };
+        errors.push(outputUnit);
+        if (outputFormat === DETAILED && context.errors.length > 0) {
+          outputUnit.errors = context.errors;
+        } else if (outputFormat === BASIC) {
+          errors.push(...context.errors);
+        }
       } else {
         schemaAnnotations.push(...context.annotations);
       }