bookshelf-joi

This is a simple Bookshelf plugin that adds attribute validation with Joi.

This plugin takes the validation part of bookshelf-modelbase and adds some functionality and flexibility.

Prerequisites

Install knex, Bookshelf, Joi and bookshelf-joi:

yarn add knex bookshelf joi bookshelf-joi

Usage

const knex = require('knex')(require('./knexfile'));
const Bookshelf = require('bookshelf')('knex');
const Joi = require('joi');

Bookshelf.plugin(require('bookshelf-joi'));

const User = Bookshelf.Model.extend({
  tableName: 'users',

  buildValidation(model, attrs, options) {
    return {
      first_name: Joi.string().required(),
      last_name: Joi.string().optional(),
    };
  }
});

User.forge({ first_name: 'Lorenzo' }).save(); // Valid

User.forge({}).save(); // Will throw `ValidationError`

User.forge({}).save(null, { validation: false }); // Will skip the validation

buildValidation

This method gets called when the saving event gets emitted, so you get access to all the event parameters. In this way you can do some manipolation, like:

const User = Bookshelf.Model.extend({
  tableName: 'users',

  buildValidation(model, attrs, options) {
    const schema = {
      first_name: Joi.string().required(),
      last_name: Joi.string().optional(),
    };

    if (attr.phone_number) {
      schema.phone_number = Joi.number().required();
    }

    return schema;
  }
});

Configuration

bookshelf-joi can be configured through different paths. The order is: plugin options -> model options -> save method options.

You can supply all the options available in the Joi documentation.

Plugin options

Bookshelf.plugin(require('bookshelf-joi'), {
  joi: {
    abortEarly: true,
    // ...
  },
});

Model options

const User = Bookshelf.Model.extend({
  tableName: 'users',

  joi: {
    abortEarly: true,
    // ...
  },

  buildValidation(model, attrs, options) {
    return {
      first_name: Joi.string().required(),
      last_name: Joi.string().optional(),
    };
  }
});

save method options

User.forge({}).save(null, {
  joi: {
    abortEarly: true,
    // ...
  },
})