fi-schemas v4.1.0

Fi Schemas

Mongoose schema loader for Node.js applications.

Installing

npm install --save fi-schemas

Usage

const schemas = require('fi-schemas');

schemas.load(config).then(/* ... */)

Initialization

This module exports a Function that resturns a Promise and you must call it with a configuration Object after intializing and connecting Mongoose:

const mongoose = require('mongoose');

const options = {
  useMongoClient: true
};

mongoose.connect('mongodb://localhost/your-database-name', options);

  .then(() => schemas.load(config)) // Configures self and loads schemas

  .then(() => {
    console.log('Schemas registered!');

    mongoose.model('you-model-name-here');
  })

  .catch(err => {
    throw err;
  });

Configuration

An Object with the following parameters:

Schemas

The schema files inside your config.basedir folder must export a Function that returns the compiled Mongoose Schema. In short, they should be like this:

'use strict';

const schemas = require('fi-schemas');

module.exports = (Schema) => {

  const schema = new Schema(schemas.partial('user'));

  schema.add({

    roles: {
      type: String,
      enum: ['ROLE.ADMIN', 'ROLE.USER']
    }

  });

  return schema;

};

The first parameter will always be mongoose.Schema so you can create your schema. The rest of the parameters will be the ones you define in the config.arguments Array.

Example

const config = {
  arguments = [
    /* Second argument */
    'A string',

    /* Third argument */
    function aFunction() {
      //...
    }
  ]
};

Will be passed as:

/* mongoose.Schema will always be the first argument */
module.exports = (Schema, aString, aFunction) => {

  const schema = new Schema({

    //...

  });

  return schema;

};

Partials

Any .js file inside the partialsdir path will be ignored and won't be registered as a model. This is useful if you have shared objects between your schemas so you can require them freely without having duplicate collections on your database.

You can export anything that you found useful from this modules, usually, objects.

Naming

The schema names will be generated from their name relative to the config.basedir defined folder and the slashes will be replaced with dots. So, if config.basedir equals to /app/schemas and config.partialsdir equals to /app/schemas/partials then the Mongoose model and mongo collection names will be as follows:

This is done in order to maintain concistency and provide an easy way of grouping your schemas and collection names.

Example configuration

'use strict';

module.exports = {

  debug: require('debug')('app:schemas'),

  partialsdir: path.normalize(path.join(__dirname, 'schemas', 'partials')),

  basedir: path.normalize(path.join(__dirname, 'schemas')),

  // Here you can set a default options object to use in all of your schemas...
  arguments: [{

    timestamps: true

  }]

};

API

The module provides the following methods: