Interweave

Interweave is a platform for creating user interfaces from static JSON. The Interweave configuration objects are meant to be checked into version control and tied closely to database and API changes.

validate

The `validate()' function is a good way to test an object against your configuration. This is useful for validating user input from forms and requests.

1import { validate } from "@interweave/interweave";
2
3// Validate and throw any errors to a console immediately
4// Good for using in a build pipeline
5validate(object, schema);
6
7// Run and collect errors to an object
8// Good for forms and handling form errors
9const errorsObject = validate(object, schema, { returnErrors: true });

Architecture

Flattening and expanding

We will take nested objects, flatten them down into their keys

1{
2    title: "Some Title",
3    description: "some description",
4    author: {
5        name: "mike"
6    }
7}

Error and form object becomes:

1{
2    title: "Some Title",
3    description: "some description",
4    "author.name": "mike"
5}

Then we use those keys to expand back into a wider object before submission:

1{
2    title: "Some Title",
3    description: "some description",
4    author: {
5        name: "mike"
6    }
7}