https://github.com/simplyhexagonal/json-schema-to-mongoose-schema

Function to convert JSON Schema (draft v4+) to Mongoose (v5, v6) Schema
https://github.com/simplyhexagonal/json-schema-to-mongoose-schema

Last synced: 25 days ago
JSON representation

Function to convert JSON Schema (draft v4+) to Mongoose (v5, v6) Schema

• Host: GitHub
• URL: https://github.com/simplyhexagonal/json-schema-to-mongoose-schema
• Owner: simplyhexagonal
• Created: 2021-11-16T11:31:10.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2022-05-03T22:27:24.000Z (over 2 years ago)
• Last Synced: 2024-04-14T04:23:04.740Z (9 months ago)
• Language: TypeScript
• Size: 191 KB
• Stars: 2
• Watchers: 0
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md

Awesome Lists containing this project

• awesome - simplyhexagonal/json-schema-to-mongoose-schema - Function to convert JSON Schema (draft v4+) to Mongoose (v5, v6) Schema (TypeScript)

README

        
# JSON Schema to Mongoose Schema

![Tests](https://github.com/simplyhexagonal/json-schema-to-mongoose-schema/workflows/tests/badge.svg)

This package was inspired by [convert-json-schema-to-mongoose](https://github.com/kristianmandrup/convert-json-schema-to-mongoose), but it's a bit more flexible and addresses the following:

- ability to parse JSON schemas that are greater than [JSON-Schema draft-04](https://tools.ietf.org/html/draft-04)

- parses sub-schemas into their own nested `Schema` instances to avoid required properties in them to cause false validation errors on their optional parents

- ability to parse `"anyOf"` properties*

- fully type-safe

- thoroughly tested

_*as long as all alternatives are of `"type": "object"` and properties with the same name have the same value types across alternatives_

There are examples of highly complex valid schemas within the [__fixtures__](https://github.com/simplyhexagonal/json-schema-to-mongoose-schema/tree/main/__fixtures__) directory.

**IMPORTANT:** `$ref` is currently **not** supported.

We use this project along [typescript-json-schema](https://github.com/YousefED/typescript-json-schema) to have our Typescript interfaces be the single

source of truth that generate the JSON schema that we then translate to Mongoose schema for each

entity within our apps.

## Open source notice

This project is open to updates by its users, [I](https://github.com/jeanlescure) ensure that PRs are relevant to the community.

In other words, if you find a bug or want a new feature, please help us by becoming one of the

[contributors](#contributors-) ✌️ ! See the [contributing section](#contributing)

## Like this module? ❤

Please consider:

- [Buying me a coffee](https://www.buymeacoffee.com/jeanlescure) ☕

- Supporting Simply Hexagonal on [Open Collective](https://opencollective.com/simplyhexagonal) 🏆

- Starring this repo on [Github](https://github.com/simplyhexagonal/json-schema-to-mongoose-schema) 🌟

## Install

_(Note: this package depends on lodash and mongoose)_

```sh

pnpm i lodash mongoose @simplyhexagonal/json-schema-to-mongoose-schema

# or

yarn add lodash mongoose @simplyhexagonal/json-schema-to-mongoose-schema

# or

npm install lodash mongoose @simplyhexagonal/json-schema-to-mongoose-schema

```

## Usage

```ts

import jsonSchemaToMongooseSchema from '@simplyhexagonal/json-schema-to-mongoose-schema';

const userSchema = require('./schemas/User.json');

// {

//   "$schema": "http://json-schema.org/draft-07/schema#",

//   "definitions": {

//     "User": {

//       ...

//     }

//   }

// }

const mongooseSchema = jsonSchemaToMongooseSchema(userSchema, 'User');

// Then simply use your newly generated mongoose schema

const model = await mongoose.model(modelName, mongooseSchema);

```

## Contributing

Yes, thank you! This plugin is community-driven, most of its features are from different authors.

Please update the docs and tests and add your name to the `package.json` file.

## Contributors ✨

Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):

  

    
Jean Lescure
🚧 💻 📓 ⚠️ 💡 📖

## License

Copyright (c) 2021-Present [JSON Schema to Mongoose Schema Contributors](https://github.com/simplyhexagonal/json-schema-to-mongoose-schema/#contributors-).


Licensed under the [Apache License 2.0](https://www.apache.org/licenses/LICENSE-2.0).