vtseditor
Version:
225 lines (181 loc) • 6.95 kB
Markdown
# VTS & VTS-Editor
[](https://discord.gg/52PQ2mbWQD)
[](https://deepwiki.com/stefanwerfling/vtseditor)
<hr>
## 📦 VTS — Type-Safe Data Validation in TypeScript
<p align="center">
<img src="doc/images/vtslogo.png" width="300px" style="border-radius: 15px;transition: transform .2s;object-fit: cover;">
<br><br>
Vts is a data type validation library written entirely in TypeScript. Its main focus lies on validating the types of the
given data (e.g. "is x a string") and not so much on validating the data itself (e.g. "is the length of the string x
equal to y") to ensure that external data is compatible with your own source code.
<br><br>
The package consists of some basic type guarded validator methods like isString() and isFunction() that can be accessed
via the main Vts object. Most of these validators are also encapsulated in schema classes which can be used to create
complex schemas. The main strategy when validating those complex schemas is to be as strict as possible.
</p>
### 🧰 Key Features
* ✅ Simple validators like isString(), isFunction(), etc.
* 🧠 Strict type guards for maximum safety and reliability.
* 🧱 Composable schema classes for defining structured, reusable validation logic.
* 💡 Built with TypeScript types in mind — works seamlessly with typeof, instanceof, and conditional typing.
[Read more by VTS project: https://github.com/OpenSourcePKG/vts](https://github.com/OpenSourcePKG/vts)
<hr>
## 🎨 VTS-Editor
The VTS Editor is a graphical tool for building and managing VTS schemas visually. It provides a drag-and-drop interface where developers can create, modify, and connect schema definitions without writing raw code.
With the editor, you can:
* 📄 Define new schema types with fields and inheritance.
* 🔗 Create references between schemas (e.g. nested types or extensions).
* 💾 Export/import schemas as JSON
* 🔍 Get an overview of schema structure and dependencies at a glance.
* ⚙️ Automatically generate TypeScript schema and type files
* ✅ Drag and Drop
* 🧠 AI Provider support
This is especially useful for large projects, team collaboration, or when sharing schema definitions with non-developers.
### Screenshots
#### Schema in use
<img src="doc/images/screenshot1.png" alt="Screenshot 1" width="450px" />
#### Schema with Extend
<img src="doc/images/screenshot2.png" alt="Screenshot 2" width="450px" />
#### Schema edit
<img src="doc/images/screenshot_edit1.png" alt="Screenshot Edit 1" width="450px" />
#### Schema field edit
<img src="doc/images/screenshot_edit2.png" alt="Screenshot Edit 2" width="450px" />
#### AI Schema create
<img src="doc/images/screenshotai1.jpeg" alt="Screenshot AI Create" width="450px" />
### Output
The schemas are generated in Typescript and the result is the schema/enum and the type:
```typescript
// Import section - automatically generated
import {ExtractSchemaResultType, Vts} from 'vts';
import {SchemaName1, SchemaName2} from './relative/path.js';
import {ExternalSchema} from 'external-package';
// Enum definitions (if present)
export enum StatusEnum {
'active' = 'active',
'inactive' = 'inactive',
}
// Schema definitions
export const UserSchema = Vts.object({
id: Vts.string({description: 'User identifier'}),
status: Vts.enum(StatusEnum),
profile: ProfileSchema,
}, {
description: 'User entity schema',
objectSchema: {
ignoreAdditionalItems: true
}
});
// TypeScript type definitions (optional)
export type User = ExtractSchemaResultType<typeof UserSchema>;
```
### Install
1. install the vts editor
##### Github
a) for your project:
```shell
npm install --save-dev git+https://github.com/stefanwerfling/vtseditor.git
```
b) or for global:
```shell
npm install -g git+https://github.com/stefanwerfling/vtseditor.git
```
##### npm
a) for your project:
```shell
npm install --save-dev vtseditor
```
b) or for global:
```shell
npm install -g vtseditor
```
2. create your config ```vtseditor.json``` example:
```json
{
"projects": [
{
"schemaPath": "./schemas/schema.json",
"code": {
"schemaPrefix": "Schema",
"createTypes": true,
"createIndex": true,
"codeComment": true,
"codeIndent": " "
},
"autoGenerate": false,
"destinationPath": "./schemas/src",
"destinationClear": false,
"scripts": {
"before_generate": [],
"after_generate": [
{
"path": "./schemas",
"script": "npm run compile"
}
]
}
}
],
"server": {
"port": 5173
},
"browser": {
"open": true
}
}
```
Read more by [Config-Description](doc/Config.md).
3. start the vts editor
```shell
npx vtseditor
```
4. open the vts editor in your browser: http://localhost:5173
5. create your schemas, have fun
### 🧠 Configuring AI Providers in VTS Editor
The **VTS Editor** can connect to different AI providers to help you generate or refine your schemas 🚀.
Currently supported providers are:
- **Gemini (Google AI Studio)**
- **LocalAI (self-hosted)**
- **OpenAI**
Read more by [Config-AI-Description](doc/ConfigAI.md).
### 🛠️ Contributing
Contributions welcome! Feel free to submit issues, suggestions, or pull requests.
# Supported by
Special thanks to the following companys:
<!-- prettier-ignore-start -->
<!-- markdownlint-disable -->
<table>
<tr>
<td align="center">
<a href="https://jb.gg/OpenSourceSupport">
<img src="https://resources.jetbrains.com/storage/products/company/brand/logos/jb_beam.png" width="80" alt=""/>
<br /><sub><b>JetBrains</b></sub>
</a>
</td>
<td align="center">
<a href="https://github.com/OpenSourcePKG">
<img src="https://raw.githubusercontent.com/OpenSourcePKG/.github/main/profile/pegenaulogo250.png" width="80" alt=""/>
<br /><sub><b>Pegenau GmbH & Co. KG</b></sub>
</a>
</td>
</tr>
</table>
# Contributors
Special thanks to the following contributors:
<!-- prettier-ignore-start -->
<!-- markdownlint-disable -->
<table>
<tr>
<td align="center">
<a href="https://github.com/Choppel">
<img src="https://avatars.githubusercontent.com/u/14126324?v=4" width="80" alt=""/>
<br /><sub><b>Choppel</b></sub>
</a>
</td>
</tr>
</table>
<!-- markdownlint-enable -->
<!-- prettier-ignore-end -->