Fix the Output type

Author: jdesrosiers

annotations/index.d.ts

@@ -1,4 +1,4 @@
-import type { OutputFormat, OutputUnit, ValidationOptions } from "../lib/index.js";
+import type { OutputFormat, Output, ValidationOptions } from "../lib/index.js";
 import type { CompiledSchema } from "../lib/experimental.js";
 import type { JsonNode } from "../lib/json-node.js";
 import type { Json } from "@hyperjump/json-pointer";
@@ -15,7 +15,7 @@ export type Annotator = (value: Json, options?: OutputFormat | ValidationOptions
 export const interpret: (compiledSchema: CompiledSchema, value: JsonNode, options?: OutputFormat | ValidationOptions) => JsonNode;
 
 export class ValidationError extends Error {
-  public output: OutputUnit;
+  public output: Output;
 
-  public constructor(output: OutputUnit);
+  public constructor(output: Output);
 }

bundle/test-suite.spec.ts

@@ -20,7 +20,7 @@ import "../draft-04/index.js";
 import { bundle, URI, UUID } from "./index.js";
 
 import type { BundleOptions } from "./index.js";
-import type { OutputUnit } from "../lib/index.js";
+import type { Output } from "../lib/index.js";
 import type { ValidationContext } from "../lib/experimental.js";
 
 
@@ -82,7 +82,7 @@ const testRunner = (version: number, dialect: string) => {
 
                 const testId = md5(`${version}|${dialect}|${testCase.description}|${testIndex}`);
                 const expectedOutputJson = await readFile(`./bundle/snapshots/${testId}`, "utf-8");
-                const expectedOutput = JSON.parse(expectedOutputJson) as OutputUnit;
+                const expectedOutput = JSON.parse(expectedOutputJson) as Output;
                 expect(output).to.eql(expectedOutput);
               });
             });

lib/experimental.d.ts

@@ -1,12 +1,12 @@
 import type { Browser, Document } from "@hyperjump/browser";
-import type { Validator, OutputUnit, OutputFormat, SchemaObject } from "./index.js";
+import type { Validator, Output, OutputUnit, OutputFormat, SchemaObject } from "./index.js";
 import type { JsonNode } from "./instance.js";
 
 
 // Compile/interpret
 export const compile: (schema: Browser<SchemaDocument>) => Promise<CompiledSchema>;
 export const interpret: (
-  (compiledSchema: CompiledSchema, value: JsonNode, outputFormat?: OutputFormat) => OutputUnit
+  (compiledSchema: CompiledSchema, value: JsonNode, outputFormat?: OutputFormat) => Output
 ) & (
   (compiledSchema: CompiledSchema) => Validator
 );

lib/index.d.ts

@@ -23,12 +23,19 @@ export type ValidationOptions = {
 };
 
 export const validate: (
-  (url: string, value: Json, options?: OutputFormat | ValidationOptions) => Promise<OutputUnit>
+  (url: string, value: Json, options?: OutputFormat | ValidationOptions) => Promise<Output>
 ) & (
   (url: string) => Promise<Validator>
 );
 
-export type Validator = (value: Json, options?: OutputFormat | ValidationOptions) => OutputUnit;
+export type Validator = (value: Json, options?: OutputFormat | ValidationOptions) => Output;
+
+export type Output = {
+  valid: true;
+} | {
+  valid: false;
+  errors?: OutputUnit[];
+};
 
 export type OutputUnit = {
   keyword: string;
@@ -49,7 +56,7 @@ export const setShouldValidateSchema: (isEnabled: boolean) => void;
 export const getShouldValidateSchema: () => boolean;
 
 export class InvalidSchemaError extends Error {
-  public output: OutputUnit;
+  public output: Output;
 
-  public constructor(output: OutputUnit);
+  public constructor(output: Output);
 }