npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@simplyhexagonal/json-schema-to-mongoose-schema

v1.2.5

Published

Type-safe function to convert JSON Schema (draft v4+) to Mongoose (v5, v6) Schema

Downloads

271

Readme

JSON Schema to Mongoose Schema

Tests

This package was inspired by 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
  • 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 directory.

IMPORTANT: $ref is currently not supported.

We use this project along 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 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 ✌️ ! See the contributing section

Like this module? ❤

Please consider:

Install

(Note: this package depends on lodash and mongoose)

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

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):

License

Copyright (c) 2021-Present JSON Schema to Mongoose Schema Contributors. Licensed under the Apache License 2.0.