Inheritable and nestable data Objects with intuitive validation schema in your JS-Project. Target is to create Contracts like Rubys Trailblazer-Reform for your JS-Frontend like React, Vue or any other JS project (also backend).
- RELIABLE: Heimdall Contracts got 100% test coverage.
- REUSABLE: Contracts can be reused in other contracts. Thanks to validation context and inheritance you can reuse contracts with different validation rules.
- EXTENSIBLE: You can extend the validation schema with your own validators.
- INTUITIVE: The validation schema is intuitive and easy to understand.
- INDEPENDENT: Heimdall Contracts are independent of any other library. It is not tied to any state management system or framework.
- TESTABLE: Contracts are easy to test. Just take a look at the tests. ;)
- DOCUMENTED: The documentation is written in a way that you can understand it without any prior knowledge.
- FLEXIBLE: You can use Heimdall Contracts in any JS project. It is not tied to any framework or state management system.
- LIGHTWEIGHT: Heimdall Contracts is lightweight. It has no dependencies and is only 3.1kb minified and gzipped.
- TRANSLATABLE: You can use your own translation library or use the included i18next integration for error messages.
First lets build a signup data contract!
class SignupContract extends ContractBase {
defineSchema() {
return (
{
...super.defineSchema(), // optional: used for inheritance ;)
...{
name: {dType: "String", presence: true},
agb: {dType: "Boolean", default: false, only: true},
email: {dType: "String", presence: true, isEmail: true},
username: {dType: "String", presence: true, min: 8},
password: {dType: "String", presence: true, min: 8},
passwordRepeat: {
dType: "String", presence: true,
validate: (value, contract) => {
return value === contract.password ? true : false // for custom error message return string instead of false.
// custom validation translation is not implemented yet, so you have to return the error message in the language you want to display it
}
},
address: {
street: {dType: "String", presence: true},
streetNumber: {dType: "Number", presence: true},
plz: {dType: "String", presence: true},
city: {dType: "String", presence: true},
}
}
}
)
}
}Now you can simply instantiate your contract like this:
const signUpContract = new SignupContract()Accessing and assigning single values is pretty straight forward:
signUpContract.name = "Kirill"
signUpContract.address.street = "Uhlandstr. 36"
console.log(
signUpContract.name
)
console.log(
signUpContract.address.street
)If the data is coming as JSON or as an nested Object from your API or State Management System for example, you can assign it like that:
signUpContract.name = "Kirill"
signUpContract.address.street = "Uhlandstr. 36"
console.log(
signUpContract.name
)
console.log(
signUpContract.address.street
)Inherit from your base class and define your contracts! Have Fun!
- Installation & Getting Started
- General Usage
- Configuration
- API
- Schema
- Mixed type Arrays
- Validation
- Localization
It is possible to do validations only if a specific context is set. It is a quality o life feature and could also be implemented through validateIf.
class SubContextContract extends ContractBase {
defineSchema() {
return (
{
...super.defineSchema(),
...{
numberWithoutContext: {dType: "Number", min: 10},
number: {dType: "Boolean", only: true, on: "contextA"}
}
}
)
}
}
class ContextContract extends ContractBase {
defineSchema() {
return (
{
...super.defineSchema(),
...{
numberWithoutContext: {dType: "Number", min: 10},
number: {dType: "Number", min: 10, on: "contextA"},
string: {dType: "String", match: /^[a-zA-Z0-9\s]*$/, on: ["contextA", "contextB"]},
addressSimple: {
plz: {presence: true, dType: "String", on: "contextA"}
},
sub: {dType: "Contract", contract: SubContextContract, allowBlank: false, on: "contextB"},
addressesContracted: {dType: "Array", min: 2, arrayOf: SubContextContract, allowBlank: false, on: "contextB"}, // this context will skip only outer validations like "min: 2" in this example
subsContractedWithInner: {dType: "Array", min: 3, arrayOf: SubContextContract, allowBlank: false, on: "contextB", innerValidate: {on: "contextB"}} // use innerValidate to skip validations of nested contract
}
}
)
}
}As you can see, every attribute can have one or more contexts through on attribute.
The context will also be passed to the nested contracts.
const contextContract = new ContextContract()
contextContract.assign(data)
contextContract.isValid("contextA") // context will be set to contextA
contextContract.isValid(["contextA", "contextB"]) // use multiple contexts
contextContract.isValid() // context = undefined
contextContract.isValid("matchAnyContext") // magic context to match all contexts- [x] implement arrays of mixed types
- [ ] add beautiful custom localization
- [ ] rethink renderAs and parseAs (maybe implement some sort of data reforming schema)
- [ ] switch from (value, isRequired, dType, depth, contract) to ({value, isRequired, dType, depth, contract}) in validations
- [ ] add example for i18next
- [ ] add JSDoc
- [ ] add TS types
- [ ] add reader and writer hooks
- [ ] add validation modes: validate all (default), stop on first error, stop on first error per attribute
- Fork it (https://github.com/your-github-user/schemas/fork)
- Create your feature branch (
git checkout -b my-new-feature) - Commit your changes (
git commit -am 'Add some feature') - Push to the branch (
git push origin my-new-feature) - Create a new Pull Request
If you have ideas on how to develop heimdall or what features it is missing, I would love to hear about it!
- @ikaru5 Kirill Kulikov - creator, maintainer
Copyright (c) 2020 Kirill Kulikov k.kulikov94@gmail.com
heimdall-contract is released under the MIT License.