@contartec/generic-model/lib/models/genericSchema.js

[](https://circleci.com/gh/contartec/generic-model) [![Maintainability](https://api.codeclimate.com/v1/badges/4947cbae75df68

'use strict'

const mongoose = require('mongoose')
const mongooseLifecycle = require('mongoose-lifecycle')

const GenericModel = require('./GenericModel')

const EVENTS = [
  'save',
  'remove',
  'count',
  'deleteMany',
  'deleteOne',
  'find',
  'findOne',
  'findOneAndDelete',
  'findOneAndRemove',
  'findOneAndUpdate',
  'remove',
  'update',
  'updateOne',
  'updateMany'
]

/**
 * Inits the [`GenericModel`]{@link GenericModel} as a `mongoose` class (using/inheriting `mongoose.Schema`, obviously)
 * 
 * @description
 *  Besides preparing `GenericModel` to be happily inherited as a `mongoose.Schema` super class:
 * 
 *  - Enable `Lambda` like functionality for `db` connections
 *  - Broadcast model events (see [`mongoose-lifecycle`]{@link https://www.npmjs.com/package/mongoose-lifecycle}) 
 * 
 * @param {mongoose.Schema} schema The `mongoose` schema object
 * @param {Object} options The `schema` options
 * @param {Function} [dbConnectFunction] The `db` connect `function` (for `Lambda` and alikes, see {@link https://mongoosejs.com/docs/lambda.html})
 * 
 * @return {Object} The [`GenericModel`]{@link GenericModel} and its [`Schema`]{@link https://mongoosejs.com/docs/api/schema.html#schema_Schema}
 * 
 * @see {@link https://mongoosejs.com/docs/guide.html}
 * 
 * @example
 * 
 * // db.js
 * const mongoose = require('mongoose')
 * 
 * module.exports = () => mongoose.connect(process.env.MONGODB_URL)
 * 
 * // You.js
 * const db = require('./db')
 * 
 * const SCHEMA = {
 *    name: String,
 *    life: Number,
 *    ...
 * }
 * 
 * const OPTIONS = {
 *    _id     : true,
 *    strict  : false,
 *    ...
 * }
 * 
 * const { GenericModel, GenericSchema } = require('lib/models/GenericSchema')(SCHEMA, OPTIONS, db)
 * 
 * module.exports = mongoose.model('You', GenericSchema)
 * 
 * // file.js
 * const You = require('./You')
 * 
 * You.save({ name: 'you' })
 * 
 * const you = await You.getOne({ name: 'you' })
 * // {
 * //   _id : idRandom,
 * //   name: 'you'
 * // }
 * 
 * you.name = 'arpel'
 * 
 * await you.save()
 * 
 * await You.getAll()
 * // [(1)]
 *
 * await You.find()
 * // [(1)]
 * 
 * @example
 * 
 * // You.js
 * const { GenericModel, GenericSchema } = require('lib/models/GenericSchema')(SCHEMA, OPTIONS)
 * 
 * class You extends GenericModel {
 *    arpel() {
 *      this.name = 'arpel'
 * 
 *      return this.save()
 *    }
 * 
 *    static async arpel() {
 *      return You.save({ name: 'arpel' })
 *    }
 * }
 * 
 * module.exports = mongoose.model('You', GenericSchema)
 * 
 * // file.js
 * const You = require('./You')
 * 
 * const you = new You()
 *
 * await you.arpel()
 * await You.arpel()
 * 
 * You.getCount({ name: 'arpel' })
 * // 2
 *
 * You.count({ name: 'arpel' })
 * // 2
*/
function genericSchema(schema, options, dbConnectFunction) {
  const GenericSchema = new mongoose.Schema(schema, options)
  
  if (dbConnectFunction) {
    EVENTS
      .forEach(event => {
        GenericSchema
          .pre(event, dbConnectFunction)
      })
  }

  GenericSchema
    .loadClass(GenericModel)
    .plugin(mongooseLifecycle)

  return { GenericModel, GenericSchema }
}

module.exports = genericSchema