Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/saiichihashimoto/mongoose-normalizr
Generate normalizr schemas from mongoose schemas!
https://github.com/saiichihashimoto/mongoose-normalizr
mongoose mongoose-model mongoose-schema normalizr normalizr-entities
Last synced: 3 months ago
JSON representation
Generate normalizr schemas from mongoose schemas!
- Host: GitHub
- URL: https://github.com/saiichihashimoto/mongoose-normalizr
- Owner: saiichihashimoto
- License: mit
- Archived: true
- Created: 2017-12-27T00:59:30.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2020-08-16T06:20:55.000Z (over 4 years ago)
- Last Synced: 2024-09-24T18:01:31.057Z (3 months ago)
- Topics: mongoose, mongoose-model, mongoose-schema, normalizr, normalizr-entities
- Language: JavaScript
- Homepage: https://saiichihashimoto.github.io/mongoose-normalizr/
- Size: 3.54 MB
- Stars: 4
- Watchers: 3
- Forks: 1
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://www.npmjs.com/package/mongoose-normalizr)
[](https://travis-ci.org/saiichihashimoto/mongoose-normalizr)
[](https://coveralls.io/github/saiichihashimoto/mongoose-normalizr?branch=master)
[](https://github.com/semantic-release/semantic-release)
[](http://commitizen.github.io/cz-cli/)
Generate [normalizr](https://www.npmjs.com/package/normalizr) schemas from [mongoose](https://www.npmjs.com/package/mongoose) schemas!
normalizr and mongoose both define relationships between the same objects. Define the mongoose relationships and get the same normalizr relationships without repeating yourself.
# Installation
```bash
npm install --save mongoose-normalizr
```
# Usage
```javascript
import mongoose from 'mongoose';
import normalizr from 'normalizr';
import mongooseNormalizr from 'mongoose-normalizr';
const Foo = mongoose.Schema({
bar: { ref: 'Bar', type: mongoose.Schema.Types.ObjectId },
});
const Bar = mongoose.Schema({
foos: [{ ref: 'Foo', type: mongoose.Schema.Types.ObjectId }],
});
const normalizrs = mongooseNormalizr({
Foo,
Bar,
});
const denormalizedFoo = {
id: 'foo1',
bar: {
id: 'bar1',
foos: [
{
id: 'foo2',
},
{
id: 'foo3',
bar: {
id: 'bar2',
},
},
],
},
};
console.log('normalized:', normalizr.normalize(denormalizedFoo, normalizrs.foos));
```
```json
{
"result": "foo1",
"entities": {
"foos": {
"foo1": {
"id": "foo1",
"bar": "bar1"
},
"foo2": {
"id": "foo2"
},
"foo3": {
"id": "foo3",
"bar": "bar2"
}
},
"bars": {
"bar1": {
"id": "bar1",
"foos": [
"foo2",
"foo3"
]
},
"bar2": {
"id": "bar2"
}
}
}
}
```
# Features
- Built specifically for the browser! *Works server-side, as well.*
- Traverses arrays and objects to find deep references.
- Supports [Subdocuments](http://mongoosejs.com/docs/subdocs.html).
- Supports [Populateable Virtuals](http://mongoosejs.com/docs/populate.html#populate-virtuals).
- Supports [Dynamic References](https://mongoosejs.com/docs/populate.html#dynamic-ref).
- It does this by generating normalizr [Unions](https://github.com/paularmstrong/normalizr/blob/master/docs/api.md#uniondefinition-schemaattribute). *Unions don't [normalize to an id](https://github.com/paularmstrong/normalizr/blob/master/docs/api.md#usage-5) like Entities do.*
- Supports [Discriminators](http://mongoosejs.com/docs/discriminators.html).
- It does this by generating normalizr [Unions](https://github.com/paularmstrong/normalizr/blob/master/docs/api.md#uniondefinition-schemaattribute). *Unions don't [normalize to an id](https://github.com/paularmstrong/normalizr/blob/master/docs/api.md#usage-5) like Entities do.*
- Works on *all* versions of normalizr, all the way back to `0.1.1`.
# ```mongooseNormalizr(schemas)```
- ```schemas```: **required**: An object mapping mongoose model names (**not** collection names) to mongoose schemas. Instead of a mongoose schema, you may supply an object with the following properties:
- ```schema```: **required** The mongoose schema to use.
- ```define```: If `false`, produces an empty normalizr schema and doesn't follow any references. Defaults to value of `enable`.
- ```reference```: If `false`, other produced schemas will ignore references to this schema. Defaults to value of `enable`.
- ```enable```: Shorthand for `define` && `reference`. Defaults to `true`.
See [our tests](https://github.com/saiichihashimoto/mongoose-normalizr/blob/master/src/index.spec.js) for examples!