cfworker/json-schema

Form validator implementation based on @cfworker/json-schema.

Installation

npm

npm i @sjsf/cfworker-validator

pnpm

pnpm add @sjsf/cfworker-validator

yarn

yarn add @sjsf/cfworker-validator

bun

bun add @sjsf/cfworker-validator

deno

deno add @sjsf/cfworker-validator

Required peer dependencies: @cfworker/json-schema@4.1.0 @sjsf/form@3.5.0

Example

Basic None Actions

+page.sveltedemo-schema.ts

<script lang="ts">
  import { createFormValidator } from "@sjsf/cfworker-validator";
  import {
    BasicForm,
    createForm,
    getValueSnapshot,
    ON_ARRAY_CHANGE,
    ON_CHANGE,
    ON_INPUT,
  } from "@sjsf/form";

  import * as defaults from "$lib/sjsf/defaults";

  import { initialValue, schema, uiSchema } from "../demo-schema";

  const form = createForm({
    ...defaults,
    schema,
    uiSchema,
    validator: createFormValidator,
    fieldsValidationMode: ON_INPUT | ON_CHANGE | ON_ARRAY_CHANGE,
    initialValue,
  });
</script>

<BasicForm {form} novalidate />

<pre>{JSON.stringify(getValueSnapshot(form), null, 2)}</pre>

Caveats

• data-url and color formats are ignored.

• By itself this validator does not support undefined values. But we use the valueToJSON function with the following default implementation to fix it, consider this overhead.

  const valueToJSON = (v: FormValue) =>
    v === undefined || v === null
      ? null
      : typeof v === "object"
        ? JSON.parse(JSON.stringify(v))
        : v;

  It will also lead to incorrect error text (e.g. Instance type "null" is invalid. Expected "string") where you would like to see the text this field is required. This can be fixed using error transformation.

Async validation

This validator does not support async validation.