Add the validate function

Author: jdesrosiers

src/index.d.ts

@@ -157,3 +157,39 @@ export type ContainsRange = {
   minContains?: number;
   maxContains?: number;
 };
+
+/**
+ * Validate an instance against a schema and get error messages in one step instead
+ * of getting output from validation and passing it to jsonSchemaErrors. The
+ * function is curried so you can compile the schema one time and evaluate multiple
+ * instances against the same compiled schema.
+ *
+ * Ideally, this function should be in @hyperjump/json-schema instead and this will
+ * be removed in the future.
+ *
+ * @deprecated
+ */
+export const validate: (
+  (schemaUri: string) => Promise<EvaluateInstance>
+) & (
+  (schemaUri: string, instance: Json, options?: ValidationOptions) => Promise<ValidationResult>
+);
+
+export type EvaluateInstance = (instance: Json, options?: ValidationOptions) => Promise<ValidationResult>;
+
+export type ValidationOptions = {
+  /**
+   * A locale identifier in the form of "{language}-{region}".
+   *
+   * @example "en-US"
+   */
+  locale?: string;
+  plugins?: EvaluationPlugin[];
+};
+
+export type ValidationResult = {
+  valid: true;
+} | {
+  valid: false;
+  errors: JsonSchemaErrors;
+};

src/index.js

@@ -173,5 +173,6 @@ export {
   evaluateSchema,
   getErrors,
   jsonSchemaErrors,
-  setNormalizationHandler
+  setNormalizationHandler,
+  validate
 } from "./json-schema-errors.js";

src/json-schema-errors.js

@@ -1,14 +1,15 @@
-import { compile, getKeyword, getSchema } from "@hyperjump/json-schema/experimental";
+import { compile, getKeyword, getSchema, Validation } from "@hyperjump/json-schema/experimental";
 import * as Instance from "@hyperjump/json-schema/instance/experimental";
 import * as Schema from "@hyperjump/browser";
 import { pointerSegments } from "@hyperjump/json-pointer";
 import { toAbsoluteIri } from "@hyperjump/uri";
 import { Localization } from "./localization.js";
+import { JsonSchemaErrorsOutputPlugin } from "./output-plugin.js";
 
 /**
  * @import * as API from "./index.d.ts"
  * @import { Browser } from "@hyperjump/browser";
- * @import { SchemaDocument } from "@hyperjump/json-schema/experimental";
+ * @import { SchemaDocument, CompiledSchema } from "@hyperjump/json-schema/experimental";
  * @import { JsonNode } from "@hyperjump/json-schema/instance/experimental"
  */
 
@@ -194,3 +195,53 @@ export const getErrors = async (normalizedErrors, rootInstance, localization) =>
 
   return errors;
 };
+
+/**
+ * @overload
+ * @param {string} schemaUri
+ * @returns {Promise<API.EvaluateInstance>}
+ *
+ * @overload
+ * @param {string} schemaUri
+ * @param {API.Json} instance
+ * @param {API.JsonSchemaErrorsOptions} [options]
+ * @returns {Promise<API.ValidationResult>}
+ *
+ * @param {string} schemaUri
+ * @param {API.Json} instance
+ * @param {API.JsonSchemaErrorsOptions} [options]
+ */
+export const validate = async (schemaUri, instance, options) => {
+  const schema = await getSchema(schemaUri);
+  const compiledSchema = await compile(schema);
+
+  if (instance === undefined) {
+    /** @type API.EvaluateInstance */
+    return (instance, options) => {
+      return evaluateCompiledSchema(compiledSchema, instance, options);
+    };
+  } else {
+    return evaluateCompiledSchema(compiledSchema, instance, options);
+  }
+};
+
+/** @type (compiledSchema: CompiledSchema, instance: API.Json, options?: API.ValidationOptions) => Promise<API.ValidationResult> */
+const evaluateCompiledSchema = async (compiledSchema, instance, options = {}) => {
+  const localization = await Localization.forLocale(options.locale ?? "en-US");
+  const jsonNode = Instance.fromJs(instance);
+  const outputPlugin = new JsonSchemaErrorsOutputPlugin();
+  const context = {
+    ast: compiledSchema.ast,
+    plugins: [...compiledSchema.ast.plugins, outputPlugin, ...options.plugins ?? []]
+  };
+  const valid = Validation.interpret(compiledSchema.schemaUri, jsonNode, context);
+
+  if (valid) {
+    return { valid };
+  } else {
+    return {
+      valid,
+      errors: await getErrors(outputPlugin.output, jsonNode, localization)
+    };
+  }
+};

src/output-plugin.js

@@ -14,6 +14,11 @@ import * as Instance from "@hyperjump/json-schema/instance/experimental";
 
 /** @implements EvaluationPlugin<ErrorsContext> */
 export class JsonSchemaErrorsOutputPlugin {
+  constructor() {
+    /** @type NormalizedOutput */
+    this.output = {};
+  }
+
   /** @type NonNullable<EvaluationPlugin<ErrorsContext>["beforeSchema"]> */
   beforeSchema(_url, _instance, context) {
     context.output = {};