monastery-js

Features

• User friendly API design, built around the awesome Monk
• Simple CRUD operations with model population
• Model validation deriving from your schema
• Custom error messages can be defined in your schema
• Normalised error responses ready for client consumption
• Automatic mongodb index setup

Install

This repository is distributed with NPM. After installing NPM, you can install Monastery via:

$ npm install --save monastery-js

Usage

// Initialise a monastery manager
const db = require('monastery-js')('localhost/mydb')
// const db = require('monastery-js')('user:pass@localhost:port/mydb')

// Define a model
db.model('user', {
  fields: {
    name: { type: 'string' },
    pets: [{ type: 'string' }],
    address: { city: { type: 'string', minLength: 10 } },
    points: [[{ type: 'number' }]]
  }
})

// Insert some data
db.user.insert({
  data: {
    name: 'Martin Luther',
    pets: ['sparky', 'tiny'],
    address: { city: 'Eisleben' },
    points: [[1, 5], [3, 1]]
  }

}).then(data => {
  // valid data..

}).catch(errs => {
  // [{
  //   detail: "Value needs to be at least 10 characters long.",
  //   status: "400",
  //   title: "address.city",
  //   meta: {
  //     field: "city",
  //     model: "user",
  //     rule: "minLength"
  //   }
  // }]
})

Debugging

This package uses Debug which allows you to see different levels of output:

$ DEBUG=monastery:info
# or show all levels of output, currently shows the same output as above
$ DEBUG=monastery:*

Contributing

Coming soon...

License

Copyright 2020 Ricky Boyce. Code released under the MIT license.