Server Driven UI

A library for server-driven UI development. It provides TypeScript types generated from JSON Schema definitions and Form Builder components to create dynamic forms and UIs that can be configured from the server-side.

Project setup

pnpm install

JSON Schema Type Generation

TypeScript types are automatically generated from JSON Schema files in the src/schema directory.

Root schema files that start with @ (e.g. @pager-form.json) are used as entry points for type generation. Referenced schemas without @ are only included when referenced by a root schema to prevent duplicate type definitions.

The generated TypeScript types are combined into a single file at src/schema/generated/index.ts.

To generate types, run:

pnpm codegen:json-schema

Run examples

pnpm storybook

Run tests

# unit tests
pnpm test

CLI Usage

The SDUI CLI allows you to manage your SDUI configuration.

Build

To build the SDUI CLI, run the following command:

pnpm build:cli

Initialize a new configuration

Create a new configuration file in your project:

npx sdui init

This will create a default sdui.config.json file in your current directory.

Generate types

To generate types from JSON Schema files, run the following command:

npx sdui gen

By default, this will look for a sdui.config.json file in your current directory. To specify a different configuration file:

npx sdui gen --config path/to/config.json

Example

The /example folder containers an example.schema.json file and a handler, example.handler.ts.

The config file in sdui.config.json is set to generate types in this directory.

sdui.config.json
example/
├── example.handler.ts 
└── example.schema.json

After building the cli (pnpm build:cli) and running npx sdui gen, types for this example will be created with a resulting directory structure.

sdui.config.json
example/
├── example.handler.ts 
├── example.schema.gen.ts
└── example.schema.json

Investigating the example.schema.gen.ts will reveal a properly typed response from the form, and the example.handler.ts can be implemented with type confidence.