Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/webiny/commodo
Commodo is a library of higher order functions (HOFs) that let you create and compose rich data models
https://github.com/webiny/commodo
complex-models composable database modelling models odm orm schema validation
Last synced: 2 days ago
JSON representation
Commodo is a library of higher order functions (HOFs) that let you create and compose rich data models
- Host: GitHub
- URL: https://github.com/webiny/commodo
- Owner: webiny
- License: mit
- Created: 2019-04-23T08:17:54.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-01-06T01:48:39.000Z (almost 2 years ago)
- Last Synced: 2024-10-30T11:04:59.248Z (10 days ago)
- Topics: complex-models, composable, database, modelling, models, odm, orm, schema, validation
- Language: JavaScript
- Homepage: https://www.github.com/webiny/commodo
- Size: 3.67 MB
- Stars: 46
- Watchers: 10
- Forks: 11
- Open Issues: 19
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://prettier.io)
[](https://github.com/webiny/webiny-js/blob/master/LICENSE)
[](http://semver.org)
[](https://lerna.js.org/)
[](http://commitizen.github.io/cz-cli/)
[](https://gitter.im/webiny/webiny-js)
Commodo is a library of [higher order functions (HOFs)](https://en.wikipedia.org/wiki/Higher-order_function) that let you create and compose rich data models.
## 📹 Videos
Wanna get up to speed quickly? Check out the [Commodo videos here](https://www.youtube.com/watch?v=i9xRDdqCzjk&list=PL9HlKSQaEuXRU5rPOlv3vPWeWew7-bMep)!
## Quick example
##### A simple model
The following example shows how to create a simple data model, which you can later use to validate data (e.g. data received as body of an HTTP request):
```javascript
import { withFields, string, number, boolean } from "@commodo/fields";
const Animal = withFields({
name: string({
validation: value => {
if (!value) {
throw Error("A pet must have a name!");
}
}
}),
age: number(),
isAwesome: boolean(),
about: fields({
value: {},
instanceOf: withFields({
type: string({ value: "cat" }),
dangerous: boolean({ value: true })
})()
})
})();
const animal = new Animal();
animal.populate({ age: "7" }); // Throws data type error, cannot populate a string with number.
animal.populate({ age: 7 });
await animal.validate(); // Throws a validation error - name must be defined.
animal.name = "Garfield";
await animal.validate(); // All good.
```
##### More complex model
Using other HOFs, you can create more complex models, that have a name, attached hooks, and even storage layer, so that you can easily save the data to the database:
```javascript
import { withFields, string, number, boolean, fields, onSet } from "@commodo/fields";
import { withName } from "@commodo/name";
import { withHooks } from "@commodo/hooks";
import { withStorage } from "@commodo/fields-storage";
import { MongoDbDriver, withId } from "@commodo/fields-storage-mongodb";
import { compose } from "ramda";
// Define User and Verification models.
const Verification = compose(
withFields({
verified: boolean(),
verifiedOn: string()
})
)();
const User = compose(
withFields({
firstName: string(),
lastName: string(),
email: compose(
onSet(value => value.toLowerCase())
)(string()),
age: number(),
scores: number({ list: true }),
enabled: boolean({ value: false }),
verification: fields({ instanceOf: Verification })
}),
withHooks({
async beforeCreate() {
if (await User.count({ query: { email: this.email } })) {
throw Error("User with same e-mail already exists.");
}
}
}),
withName("User"), // Utilized by storage layer, to determine collection / table name.
withId(),
withStorage({
driver: new MongoDbDriver({ database })
})
)();
const user = new User();
user.populate({
firstName: "Adrian",
lastName: "Smith",
email: "[email protected]",
enabled: true,
scores: [34, 66, 99],
verification: {
verified: true,
verifiedOn: "2019-01-01"
}
});
await user.save();
```
## Is Commodo an ORM/ODM?
Fundamentally, Commodo is not an ORM/ODM, but can very quickly become one, by utilizing an additional HOF. You can use the already provided [@commodo/fields-storage](https://github.com/webiny/commodo/tree/master/packages/fields-storage) or even create your own if you don't like the existing one.
Using HOFs is a very flexible approach for defining your data models, because you can append only the functionality you actually need and will use.
## Core packages:
The following section shows all of the useful higher order functions that you can use right now.
| Package | Short Description | Version |
| :--- | :---: | :---: |
| [@commodo/fields](./packages/fields) | The starting point of every model. Provides base `string`, `number`, `boolean` and `model` fields. | [](https://www.npmjs.com/package/@commodo/fields) |
| [@commodo/name](./packages/name) | Assign a name to your models. | [](https://www.npmjs.com/package/@commodo/name) |
| [@commodo/hooks](./packages/hooks) | Provides methods for defining and triggering hooks on your models. | [](https://www.npmjs.com/package/@commodo/hooks) |
| [@commodo/fields-storage](./packages/fields-storage) | Enables saving models to a database (with an appropriate driver, e.g. MySQL). | [](https://www.npmjs.com/package/@commodo/fields-storage) |
## Additional packages:
| Package | Short Description | Version |
| :--- | :---: | :---: |
| [@commodo/fields-storage-ref](./packages/fields-storage-ref) | Provides `ref` field, for saving references to other models saved in database. | [](https://www.npmjs.com/package/repropose) |
| [@commodo/fields-storage-mongodb](./packages/fields-storage-mongodb) | A MongoDB driver for @commodo/fields-storage package. | [](https://www.npmjs.com/package/repropose) |
| [@commodo/fields-storage-soft-delete](./packages/fields-storage-soft-delete) | Introduces deleted boolean field to mark whether a model was deleted or not, instead of physically deleting the entry in the storage. | [](https://www.npmjs.com/package/@commodo/fields-storage-soft-delete) |
## Community packages:
| Package | Short Description | Version |
| :--- | :---: | :---: |
| [commodo-fields-date](https://github.com/doitadrian/commodo-fields-date) | Provides `date` field, for saving dates. | [](https://www.npmjs.com/package/commodo-fields-date) |
| [commodo-fields-object](https://github.com/doitadrian/commodo-fields-object) | Provides `object` field, for saving plain objects. | [](https://www.npmjs.com/package/commodo-fields-object) |
| [commodo-fields-int](https://github.com/doitadrian/commodo-fields-int) | Provides `int` field, for saving integer numbers. | [](https://www.npmjs.com/package/commodo-fields-int) |
| [commodo-fields-float](https://github.com/doitadrian/commodo-fields-float) | Provides `float` field, for saving float numbers. | [](https://www.npmjs.com/package/commodo-fields-float) |
| [commodo-fields-storage-crud-logs](https://github.com/doitadrian/commodo-fields-storage-crud-logs) | Adds and automatically manages `createdOn`, `updatedOn`, `savedOn` fields. | [](https://www.npmjs.com/package/commodo-fields-storage-crud-logs) |
## Contributing
Please see our [Contributing Guideline](/CONTRIBUTING.md) which explains repo organization, linting, testing, and other steps.
## License
This project is licensed under the terms of the [MIT license](/LICENSE.md).