route-depot

About

A number of http routers adding routes immediately attach to the router which means you can't add routes out of order. The route depot allows you to specify the priortity, as well as have an info bank of all the routes that can be filtered, decorated, and/or wrap the request handlers. It was originally designed to deal with the pain points of registering controllers and ensuring contexts are maintained.

Install

npm install route-depot

Example

'use strict';

const express    = require('express');
const RouteDepot = require('route-depot');

const depot = RouteDepot.express();
const warehouse = RouteDepot.warehouse();

depot.plugin('route', function(route) {
  return route;
});

// Handy plugin that allows us to add
// controller before methods to middlewares
depot.plugin('attach', function(route) {
  if (!route.isController) {
    return route;
  }

  const ctrl = route.context;

  if (ctrl.before) {
    route.middleware.push(
      ctrl.before.bind(ctrl)
    );
  }

  return route;
});

const Ctrl = {
  name: '2-B-Or-Not-2-B',
  before: function(req, res, next) {
    console.log('before-b');
    next();
  },
  getB: function(req, res) {
    console.log(this);
    res.json(this);
  },
  getAllCats : function(req, res) {
    res.json({d: ['fluffy', 'mittens']})
  },
  routes : {
    'GET  /b' : 'getB',
    'GET /cats' : 'getAllCats'
  }
}

depot.controller('/', Ctrl);

depot.get('/', function(req, res) {
  res.send('I am root');
});

depot.get('/single', function(req, res) {
  res.send('If yur not first yur last!');
});

depot.get('/single', function(req, res) {
  res.send('I be first!');
}, {priority: 1});

const app = express();

depot.couple(app);

app.listen(3000, function () {
  console.log('Example app listening on port 3000!');
});

What good is a route-depot without a place to also store routes? For working with middleware you can use the warehouse!

'use strict';

const express      = require('express');
const RouteDepot   = require('route-depot');
const chromelogger = require('chromelogger');

const depot = RouteDepot.express();
const warehouse = RouteDepot.warehouse();

warehouse.add('dev', [
  function test(a) {
    return function(req, res, next) {
      console.log('TEST-MW');
      next();
    };
  },
  
  chromelogger.middleware,

  function noCache(req, res, next) {
    console.log('no-cache!');
    res.setHeader('Cache-Control', 'no-cache, no-store, must-revalidate');
    res.setHeader('Pragma', 'no-cache'); // HTTP 1.0.
    res.setHeader('Expires', '0'); // Pro
    next();
  }
]);

warehouse.add('acl', function(group) {
    return function(req, res, next) { 
      if (req.user.group !== group) {
        return res.send(401, 'You are not a member of the appropriate group');
      }

      next();
    };
});

const app    = express();
const router = express.Router();

const mwDev = warehouse.get('dev');
const wares = warehouse.weld('dev-friends', ['dev', 'acl:friends']);

warehouse.couple(wares, router);

app.get('/', function(req, res) {
  res.send('yay');
});

app.use('/', router);

app.listen(3000, function () {
  console.log('Example app listening on port 3000!');
});