validateSchemaShape

This 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, accurate entity types, and valid IDs.

It performs all the tasks of validateSchema, except it skips attributes values and custom schema validations, making this function synchronous.

In most cases, you wouldn't typically use this method, as it doesn't validate attributes values. However, you may find it useful occasionally.

Reference

validateSchemaShape(schema, builder)

Use the validateSchemaShape function to validate the input schema:

"use server";

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

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

export async function validateFormSchema(schema: unknown) {
  const result = validateSchemaShape(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

validateSchemaShape accepts two parameters:

Returns

validateSchemaShape 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: