Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/wmfs/json-schema-builder
Generate JSON-Schema schemas via a UI-orientated DSL.
https://github.com/wmfs/json-schema-builder
package tymly
Last synced: 3 months ago
JSON representation
Generate JSON-Schema schemas via a UI-orientated DSL.
- Host: GitHub
- URL: https://github.com/wmfs/json-schema-builder
- Owner: wmfs
- License: mit
- Created: 2019-01-04T15:29:21.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2024-10-19T01:46:47.000Z (3 months ago)
- Last Synced: 2024-10-20T23:27:00.173Z (3 months ago)
- Topics: package, tymly
- Language: JavaScript
- Homepage:
- Size: 216 KB
- Stars: 12
- Watchers: 7
- Forks: 1
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# json-schema-builder
[](https://tymly.io/)
[](https://www.npmjs.com/package/@wmfs/json-schema-builder)
[](https://circleci.com/gh/wmfs/json-schema-builder)
[](https://codecov.io/gh/wmfs/json-schema-builder)
[](https://www.codefactor.io/repository/github/wmfs/json-schema-builder)
[](https://dependabot.com/)
[](http://commitizen.github.io/cz-cli/)
[](https://standardjs.com)
[](https://github.com/wmfs/json-schema-builder/blob/master/README.md)
> Generate JSON-Schema schemas via a UI-orientated DSL.
# Why?
If you're building some high-level, user-facing tool to produce JSON Schema objects, chances are your internal representation will be more array-like...
This package is intended to take that internal DSL and turn it into a valid JSON-Schema schema.
* Here `typeHint` should be one of the [types supported by tymly-data-types](https://github.com/wmfs/tymly-data-types#reference).
# Installation
``` bash
npm install @wmfs/json-schema-builder --save
```
``` javascript
const jsonSchemaBuilder = require('@wmfs/json-schema-builder')
const jsonSchema = jsonSchemaBuilder.dslToJsonSchema(
{
title: 'Pizza',
description: 'A model for storing details of a pizza (recipe, price etc.)',
propertyHints: [
{
key: 'code',
typeHint: 'text',
example: 'CHEESE_TOMATO',
required: true,
title: 'Unique code of the pizza',
minLength: 3,
maxLength: 15,
primary: true
},
{
key: 'label',
typeHint: 'text',
required: true,
example: 'Cheese & Tomato',
title: 'Customer-facing label'
},
{
key: 'popularitySeq',
typeHint: 'integer',
required: true,
title: 'Integer value to order lists by',
minimum: 1
},
{
key: 'imageUri',
typeHint: 'uri',
required: true,
example: 'https://tinyurl.com/y8r5bbu5',
title: 'URI to an enticing photo of the pizza'
},
{
key: 'crusts',
typeHint: 'text',
choiceSet: {
NORMAL: 'Normal',
STUFFED: 'Stuffed',
HOT_DOG: 'Hot Dog'
},
multiple: true,
default: ['NORMAL', 'STUFFED'],
title: 'Offer which crust options?',
required: true
},
{
key: 'vegetarian',
typeHint: 'boolean',
required: true,
default: false,
title: 'Is the pizza suitable for vegetarians?'
},
{
key: 'allergens',
typeHint: 'text',
example: ['Gluten', 'Wheat', 'Milk'],
multiple: true,
uniqueItems: true,
title: 'List of allergens present in pizza'
},
{
key: 'availabilityEnd',
typeHint: 'date',
example: '2019-12-31',
required: false,
title: 'Date when pizza is no longer available.'
},
{
key: 'reviews',
typeHint: 'object',
multiple: true,
title: 'Favourable customer reviews',
propertyHints: [
{
key: 'username',
example: 'joebloggs4',
typeHint: 'text',
required: true,
title: 'Who wrote the review'
},
{
key: 'review',
example: 'Lovely stuff!',
typeHint: 'text',
required: true,
title: 'Something nice to say'
},
{
key: 'rating',
title: 'Star rating (0=Awful 5=Great)',
example: 5,
typeHint: 'integer',
required: true,
minimum: 0,
maximum: 5,
default: 5
}
]
}
]
})
/*
// Which returns...
// ----------------
//
{
"$schema": "http://json-schema.org/draft-06/schema#",
"title": "Pizza",
"description": "A model for storing details of a pizza (recipe, price etc.)",
"type": "object",
"properties": {
"code": {
"type": "string",
"title": "Unique code of the pizza",
"examples": [
"CHEESE_TOMATO"
],
"minLength": 3,
"maxLength": 15
},
"label": {
"type": "string",
"title": "Customer-facing label",
"examples": [
"Cheese & Tomato"
]
},
"popularitySeq": {
"type": "integer",
"title": "Integer value to order lists by",
"minimum": 1
},
"imageUri": {
"type": "string",
"format": "uri",
"title": "URI to an enticing photo of the pizza",
"examples": [
"https://tinyurl.com/y8r5bbu5"
]
},
"crusts": {
"type": "array",
"title": "Offer which crust options?",
"default": [
"NORMAL",
"STUFFED"
],
"items": {
"type": "string",
"enum": [
"NORMAL",
"STUFFED",
"HOT_DOG"
]
}
},
"vegetarian": {
"type": "boolean",
"title": "Is the pizza suitable for vegetarians?",
"default": false
},
"allergens": {
"type": "array",
"title": "List of allergens present in pizza",
"examples": [
[
"Gluten",
"Wheat",
"Milk"
]
],
"uniqueItems": true,
"items": {
"type": "string"
}
},
"availabilityEnd": {
"type": "string",
"format": "date-time",
"title": "Date when pizza is no longer available.",
"examples": [
"2019-12-31"
]
},
"reviews": {
"type": "array",
"title": "Favourable customer reviews",
"items": {
"type": "object",
"properties": {
"username": {
"type": "string",
"title": "Who wrote the review",
"examples": [
"joebloggs4"
]
},
"review": {
"type": "string",
"title": "Something nice to say",
"examples": [
"Lovely stuff!"
]
},
"rating": {
"type": "integer",
"title": "Star rating (0=Awful 5=Great)",
"default": 5,
"examples": [
5
],
"minimum": 0,
"maximum": 5
}
},
"required": [
"username",
"review",
"rating"
]
}
}
},
"required": [
"code",
"label",
"popularitySeq",
"imageUri",
"crusts",
"vegetarian"
],
"primaryKey": [
"code"
]
}
*/
```
## Testing
``` bash
npm test
```
## License
[MIT](https://github.com/wmfs/json-schema-builder/blob/master/LICENSE)