Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/chialab/schema-model
Generate Model classes based on JSON Schema definition.
https://github.com/chialab/schema-model
json-schema
Last synced: about 1 month ago
JSON representation
Generate Model classes based on JSON Schema definition.
- Host: GitHub
- URL: https://github.com/chialab/schema-model
- Owner: chialab
- License: mit
- Created: 2017-03-09T15:25:14.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2022-02-12T18:14:26.000Z (almost 3 years ago)
- Last Synced: 2024-11-08T11:52:46.349Z (about 2 months ago)
- Topics: json-schema
- Language: JavaScript
- Homepage: https://www.chialab.io/p/schema-model
- Size: 245 KB
- Stars: 11
- Watchers: 3
- Forks: 2
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
SchemaModel • Generate Model classes based on JSON Schema definition.
---
## Install
```sh
$ npm install @chialab/schema-model
# or
$ yarn add @chialab/schema-model
```
Use via cdn:
```html
```
## Usage
The `SchemaModel` object can be extended or use as factory to create Model classes dynamically.
### Extend the base model
```js
import SchemaModel from '@chialab/schema-model';
class PersonModel extends SchemaModel {
static get schema() {
return {
type: 'object',
properties: {
id: {
type: 'number',
},
firstName: {
type: 'string',
},
lastName: {
type: 'string',
},
married: {
type: 'boolean',
},
},
required: ['id'],
};
}
}
let person = new PersonModel({
id: 1,
});
```
### As factory
```js
const PersonModel = SchemaModel.create({
type: 'object',
properties: {
id: {
type: 'number',
},
firstName: {
type: 'string',
},
lastName: {
type: 'string',
},
married: {
type: 'boolean',
},
},
required: ['id'],
});
let person = new PersonModel({
id: 1,
});
```
## Validation
SchemaModel uses [tv4](https://github.com/geraintluff/tv4) to validate model data on creation and update.
### Get the validation state
Use the `.validate` method to retrieve the validation state of the model.
```js
let person = new PersonModel();
let validation = person.validate();
console.log(validation.valid); // --> false
console.log(validation.error.message); // --> 'Missing required property: id'
```
### Creation and update
When a set of data is pass to the constructor or to the `.set` method, the model will try to validate them. If the validation fails, an exception is thrown and the new data **will not** be set.
```js
try {
let person = new PersonModel({ firstName: 'Alan' });
} catch (err) {
console.log(err.message); // --> 'Missing required property: id'
}
```
```js
try {
let person = new PersonModel({ id: 1, firstName: 'Alan' });
person.set({
lastName: 10,
});
} catch (err) {
console.log(err.message); // --> 'Invalid type: number (expected string)'
}
```
### Skip validation
By the way, you can disabled the auto validation passing `validate: false` as option for constructor/set.
```js
let person = new PersonModel({ firstName: 'Alan' }, { validate: false });
let validation = person.validate();
console.log(validation.valid); // --> false
console.log(validation.error.message); // --> 'Missing required property: id'
```
## Getting and setting data
In order to get an object representing model data, you can use the `.toJSON` helper, which converts all model instances in javascript plain objects:
```js
let person = new PersonModel({ id: 1, firstName: 'Alan' });
console.log(person); // --> PersonModel{ id: 1, firstName: 'Alan' }
console.log(person.toJSON()); // --> { id: 1, firstName: 'Alan' }
```
You can access a property of the model using the `.get` method, or accessing directly to its reference:
```js
let person = new PersonModel({ id: 1, firstName: 'Alan' });
console.log(person.get('id')); // --> 1
console.log(person.firstName); // --> 'Alan'
```
By the way, you should always use the `.set` method to update the model:
```js
let person = new PersonModel({ id: 1, firstName: 'Alan' });
// ok!
person.set({
lastName: 'Turing',
});
// no no no
person.lastName = 'Turing';
```
### Define getters and setters
Using ES2015 classes (or `Object.defineProperty` programmatically), you can define a custom getter and setter for a property:
```js
import SchemaModel from '@chialab/schema-model';
class PersonModel extends SchemaModel {
static get schema() {
return {
type: 'object',
properties: {
id: {
type: 'number',
},
firstName: {
type: 'string',
},
lastName: {
type: 'string',
},
married: {
type: 'boolean',
},
},
required: ['id'],
};
}
set married(married) {
// passing the `internal: true` options you can set a private property.
this.set('married', !!married, { internal: true });
}
get married() {
// setup a default value for a property
return this.get('married', { internal: true }) || false;
}
}
let person = new PersonModel({
id: 1,
});
console.log(person.married); // --> false
person.set({ married: true });
console.log(person.married); // --> true
```
## Development
[](https://github.com/chialab/schema-model/actions?query=workflow%3ABuild)
[](https://codecov.io/gh/chialab/schema-model)
[](https://app.saucelabs.com/u/chialab-sl-013)
### Requirements
In order to build and test SchemaModel, the following requirements are needed:
* [NodeJS](https://nodejs.org/) (>= 10.0.0)
* [Yarn](https://yarnpkg.com)
* [RNA](https://github.com/chialab/rna-cli) (>= 3.0.0)
### Build the project
Install the dependencies and run the `build` script:
```
$ yarn install
$ yarn build
```
This will generate the UMD and ESM bundles in the `dist` folder, as well as the declaration file.
### Test the project
Run the `test` script:
```
$ yarn test
```
---
## License
SchemaModel is released under the [MIT](https://github.com/chialab/schema-model/blob/master/LICENSE) license.