https://github.com/offlinehacker/justmodel
Extendable immutable typescript models with validation and change tracking
https://github.com/offlinehacker/justmodel
javascript javascript-library library models nodejs nodejs-library
Last synced: 10 days ago
JSON representation
Extendable immutable typescript models with validation and change tracking
- Host: GitHub
- URL: https://github.com/offlinehacker/justmodel
- Owner: offlinehacker
- License: mit
- Created: 2017-06-14T23:49:35.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2017-10-10T16:08:56.000Z (over 7 years ago)
- Last Synced: 2025-03-15T04:46:20.500Z (3 months ago)
- Topics: javascript, javascript-library, library, models, nodejs, nodejs-library
- Language: TypeScript
- Homepage:
- Size: 238 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# justmodel
[](http://badge.fury.io/js/justmodel)
[](https://greenkeeper.io/)
[](https://travis-ci.org/offlinehacker/justmodel)
[](https://coveralls.io/github/offlinehacker/justmodel)
[](https://david-dm.org/offlinehacker/justmodel?type=dev)
Extendable immutable javascript models with validation and change tracking
## Description
JustModel is a modern extendable model library written in typescript,
that provides several features that every model library should have:
### Static typed data types
Justmodel has fully typed models when working with typescript and flowtype,
that provide type safety when working with models.
```javascript
import { Model } from 'justmodel';
type User = {
username: string;
password: string;
};
class UserModel extends Model {}
const user = new UserModel().create({username: 'username'}) // <-- property password is missing in type
```
### Immutable and non-immutable operations
All operations are immutable by default, except is in place mutation methods are used
```javascript
let mutatedUser = user.update({password: 'newpassword'});
user === mutatedUser // <-- false as immutable operation was used
muetatedUser = user.updateInPlace({password: 'newpassword'});
user === mutatedUser // <-- true as model was mutated in place
```
### Data validation with create, update and load joi schemas
```javascript
class UserModel extends Model {
get schema() {
return Joi.object({
username: Joi.string(),
password: Joi.string().required(),
hashedPassword: Joi.string().hex()
}).xor('password', 'hashedPassword');
}
get createSchema() {
return this.schema.requiredKeys(['password']);
}
}
const user = new UserModel().create({
username: 'user'
}); // <-- validation error as password is missing
```
### Change detection
Just model tracks changes on models and provides method that gets old value
or tells if change was made compared to initial value. This is very usefull if
doing update oprations on model and need to know if values have changed.
```javascript
const model = new UserModel().load(data);
model.updateInPlace(req.data);
if (model.hasChanged('password')) {
// check old password for example
}
```
### Insallation
```bash
npm install --save justmodel
```
### Example
```javascript
import { Model } from 'justmodel';
class UserModel extends Model {
get schema() {
return Joi.object({
username: Joi.string().min(4).max(20).lowercase(),
password: Joi.string().required().min(8),
email: Joi.string().email().required(),
hashedPassword: Joi.string().hex()
});
}
get createSchema() {
return this.schema.requiredKeys(['password']);
}
value() {
return this._data.delete('password').toJS();
}
}
const user = new UserModel().create({
username: 'user',
password: 'mypassword',
email: '[email protected]'
});
checkWeakPasswords(user);
user.updateInPlace({
hashedPassword: hashPassword(user.password)
});
if(user.hasChanged('email')) {
return sendChangeEmail(user);
}
save(user);
```
### Development
- `npm t`: Run test suite
- `npm start`: Runs `npm run build` in watch mode
- `npm run test:watch`: Run test suite in [interactive watch mode](http://facebook.github.io/jest/docs/cli.html#watch)
- `npm run test:prod`: Run linting and generate coverage
- `npm run build`: Generage bundles and typings, create docs
- `npm run lint`: Lints code
- `npm run commit`: Commit using conventional commit style ([husky](https://github.com/typicode/husky) will tell you to use it if you haven't :wink:)
## Credits
Made with :heart: by [@offlinehacker](https://twitter.com/offlinehacker)