index.js

const _ = require('lodash')

/**
 * Case Converter Plugin
 *
 * Handles the conversion between the database's snake_cased and a model's camelCased properties automatically. You just
 * need to load it somewhere in your code.
 *
 * @example
 * var bookshelf = Bookshelf(knex);
 * bookshelf.plugin('case-converter');
 *
 * @module plugins/case-converter
 */
module.exports = function caseConverter(bookshelf) {
  const prototype = bookshelf.Model.prototype

  /**
   * Monkey-patched Model class.
   * @extends Model
   */
  bookshelf.Model = bookshelf.Model.extend({
    /**
     * Converts attribute keys to camel case when fetching data from the database.
     * @override
     */
    parse(attrs) {
      const parsedAttributes = prototype.parse.apply(this, arguments)
      return _.mapKeys(parsedAttributes, (value, key) => _.camelCase(key))
    },

    /**
     * Converts attribute keys to snake case just before saving a model to the database. The converted attributes
     * will not be set on the model.
     * @override
     */
    format(attrs) {
      const parsedAttributes = prototype.format.apply(this, arguments)
      return _.mapKeys(parsedAttributes, (value, key) => _.snakeCase(key))
    }
  })
}