https://github.com/kristianmandrup/convert-json-schema-to-mongoose

Convert JSON schema to mongoose 5 schema
https://github.com/kristianmandrup/convert-json-schema-to-mongoose

Last synced: about 1 month ago
JSON representation

Convert JSON schema to mongoose 5 schema

• Host: GitHub
• URL: https://github.com/kristianmandrup/convert-json-schema-to-mongoose
• Owner: kristianmandrup
• License: apache-2.0
• Created: 2018-09-21T12:36:04.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2024-12-03T14:28:18.000Z (about 2 months ago)
• Last Synced: 2024-12-11T19:42:45.288Z (about 1 month ago)
• Language: JavaScript
• Size: 14.6 MB
• Stars: 13
• Watchers: 4
• Forks: 9
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome - kristianmandrup/convert-json-schema-to-mongoose - Convert JSON schema to mongoose 5 schema (JavaScript)

README

        
# JSON Schema to Mongoose Schema

A translation library between [JSON Schema](http://json-schema.org/) and

[Mongoose Schema](http://mongoosejs.com/docs/guide.html). Written in TypeScript.

This project was created from the ashes of `json-schema-converter`. I took away

some features and made it more single purpose and added features to the

conversion.

## Alternatives

Some of the alternatives...

- 2017 [generate-schema-required](https://www.npmjs.com/package/generate-schema-required)

- 2016 [mongoosify](https://www.npmjs.com/package/mongoosify)

- 2016 [mongoose-jsonschema](https://www.npmjs.com/package/mongoose-jsonschema)

- 2015 [goodeggs-json-schema-converter](https://www.npmjs.com/package/goodeggs-json-schema-converter)

- 2014 [json-schema-converter](https://www.npmjs.com/package/json-schema-converter)

- 2014 [json-schema-to-mongoose-schema](https://www.npmjs.com/package/json-schema-to-mongoose-schema)

## Installation

`npm i convert-json-schema-to-mongoose -S`

## Usage

```typescript

import { createMongooseSchema } from 'convert-json-schema-to-mongoose';

// Or use plain javascript

// const createMongooseSchema = require('json-schema-to-mongoose').default;

// example json-schema references

const refs =

{

    yep:

    {

        type: 'string',

        pattern: '^\\d{3}$'

    },

    idSpec: {

        type: 'object',

        properties:

        {

            id:

            {

                $ref: 'yep'

            }

        }

    }

};

// example schema to convert to mongoose schema

const schema =

{

    type: 'object',

    properties:

    {

        id:

        {

            $ref: 'yep'

        },

        address:

        {

            type: 'object',

            properties:

            {

                street: {type: 'string', default: '44', pattern: '^\\d{2}$'},

                houseColor: {type: 'string', default: '[Function=Date.now]', format: 'date-time'}

            }

        }

    }

};

//Convert the schema

const mongooseSchema = createMongooseSchema(refs, schema);

//Alternative syntax, which makes it so you can convert many at one time.

// var jsonSchemas = {commonRef: ..., good: ..., schema: ..., naming: ...}

// var convert = createMongooseSchema(jsonSchemas)

// var schemaNames = ['good', 'schema', 'naming']

// var schemas = _.map(schemaNames, (name) => { return jsonSchemas[name] })

// var mongooseSchemas = _.zipObject(schemaNames, schemas.reduce((mongooseSchemas, schema) => {

//     return mongooseSchemas.concat(convert(schema))

// }, []))

console.dir(mongooseSchema, {depth: null});

const Schema = new mongoose.Schema(mongooseSchema);

```