Schema Generation

Single source of truth for type-safe C# and TypeScript types across the entire codebase.

Quick Start

1. Edit ui-schema.json
2. Run:

   cd packages/schemas && pnpm run generate:all

3. Types auto-update in:
   • TypeScript: packages/schemas/src/generated/schema.ts
   • C#: Plugin/Selva.Schema/Models/UISchema.Generated.cs

Adding a Type

{
	"definitions": {
		"MyType": {
			"type": "object",
			"properties": {
				"id": { "type": "string" },
				"name": { "type": "string" }
			},
			"required": ["id", "name"]
		}
	}
}

Adding a Property to an Existing Type

1. Open ui-schema.json
2. Find the type in definitions (e.g., User)
3. Add property to properties:

   "properties": {
     "id": { "type": "string" },
     "name": { "type": "string" },
     "email": { "type": "string" }  // ← New property
   }

4. (Optional) Make it required — Add to required array:

   "required": ["id", "name", "email"]

5. Save and run:

   cd packages/schemas && pnpm run generate:all

6. TypeScript and C# types update automatically ✓

Full Example

{
	"definitions": {
		"User": {
			"type": "object",
			"properties": {
				"id": { "type": "string" },
				"name": { "type": "string" },
				"email": { "type": "string" },
				"age": { "type": "integer" },
				"active": { "type": "boolean" }
			},
			"required": ["id", "name", "email"]
		}
	}
}

Optional properties (age, active) are not in required and become nullable in C# (int?, bool?).

Type Mappings

| JSON | TypeScript | C# (required) | C# (optional) | | --------- | ---------- | ------------- | ------------- | | string | string | string | string | | number | number | double | double? | | integer | number | int | int? | | boolean | boolean | bool | bool? | | array | T[] | List<T> | List<T> |

A property is "required" when it appears in the parent schema's required array.

Discriminated Unions

Define variants with const discriminator:

{
	"Widget": {
		"oneOf": [{ "$ref": "#/definitions/TextWidget" }, { "$ref": "#/definitions/NumberWidget" }]
	},
	"TextWidget": {
		"type": "object",
		"properties": {
			"type": { "type": "string", "const": "text" },
			"placeholder": { "type": "string" }
		}
	},
	"NumberWidget": {
		"type": "object",
		"properties": {
			"type": { "type": "string", "const": "number" },
			"min": { "type": "number" }
		}
	}
}

The C# and TypeScript generators automatically create the classes and converters.