validateSchema

This async function validates that the input schema meets several essential requirements based on the provided builder, such as having a valid structure, correct references in relationships, proper relationship constraints, valid attributes, accurate entity types, and valid IDs.

In most cases, you'll call this function on the server side to validate the incoming built schema from the client.

Reference

validateSchema(schema, builder)

Use the validateSchema function to validate the input schema:

"use server";

import { validateSchema } from "@coltorapps/builder";

import { formBuilder } from "./form-builder";

export async function validateFormSchema(schema: unknown) {
  const result = await validateSchema(schema, formBuilder);

  if (result.success) {
    /*
    | The `result.data` contains a valid schema
    | that can be stored in the database.
    */
  } else {
    /*
    | The `result.reason` holds the reason for
    | validation failure.
    */
  }
}

Parameters

validateSchema accepts two parameters:

Returns

validateSchema returns a union of two possible objects, depending on the validation outcome. This function never throws errors, meaning that you only need to narrow down its result based on the value of the success key.

In case of successful validation, you receive the following object:

In case of failed validation, you receive the following object:

The reason object will contain the following properties:

Error Codes

In case of a failed validation, the failure reason code can be one of the following:

Most of the time, when validating your schema on the server side, you will likely want to address InvalidEntitiesAttributes and, if applicable, InvalidSchema.