keystone/admin/server/app/createDynamicRouter.js

Web Application Framework and Admin GUI / Content Management System built on Express.js and Mongoose

var bodyParser = require('body-parser');
var express = require('express');

var uploads = require('../../../lib/uploads');

module.exports = function createDynamicRouter (keystone) {
	// ensure keystone nav has been initialised
	// TODO: move this elsewhere (on demand generation, or client-side?)
	if (!keystone.nav) {
		keystone.nav = keystone.initNav();
	}

	var router = express.Router();
	var IndexRoute = require('../routes/index');
	var SigninRoute = require('../routes/signin');
	var SignoutRoute = require('../routes/signout');

	// Use bodyParser and multer to parse request bodies and file uploads
	router.use(bodyParser.json({}));
	router.use(bodyParser.urlencoded({ extended: true }));
	uploads.configure(router);

	// Bind the request to the keystone instance
	router.use(function (req, res, next) {
		req.keystone = keystone;
		next();
	});

	// Pre adminroutes middleware
	if (typeof keystone.get('pre:adminroutes') === 'function') {
		keystone.get('pre:adminroutes')(router);
	}
	router.use(function (req, res, next) {
		keystone.callHook('pre:adminroutes', req, res, next);
	});

	if (keystone.get('healthchecks')) {
		router.use('/server-health', require('./createHealthchecksHandler')(keystone));
	}

	// Init API request helpers
	router.use('/api', require('../middleware/apiError'));
	router.use('/api', require('../middleware/logError'));

	// #1: Session API
	// TODO: this should respect keystone auth options
	router.get('/api/session', require('../api/session/get'));
	router.post('/api/session/signin', require('../api/session/signin'));
	router.post('/api/session/signout', require('../api/session/signout'));

	// #2: Session Routes
	// Bind auth middleware (generic or custom) to * routes, allowing
	// access to the generic signin page if generic auth is used
	if (keystone.get('auth') === true) {
		// TODO: poor separation of concerns; settings should be defaulted elsewhere
		if (!keystone.get('signout url')) {
			keystone.set('signout url', '/' + keystone.get('admin path') + '/signout');
		}
		if (!keystone.get('signin url')) {
			keystone.set('signin url', '/' + keystone.get('admin path') + '/signin');
		}
		if (!keystone.nativeApp || !keystone.get('session')) {
			router.all('*', keystone.session.persist);
		}
		router.all('/signin', SigninRoute);
		router.all('/signout', SignoutRoute);
		router.use(keystone.session.keystoneAuth);
	} else if (typeof keystone.get('auth') === 'function') {
		router.use(keystone.get('auth'));
	}

	// #3: Home route
	router.get('/', IndexRoute);

	// #4: Cloudinary and S3 specific APIs
	// TODO: poor separation of concerns; should / could this happen elsewhere?
	if (keystone.get('cloudinary config')) {
		router.get('/api/cloudinary/get', require('../api/cloudinary').get);
		router.get('/api/cloudinary/autocomplete', require('../api/cloudinary').autocomplete);
		router.post('/api/cloudinary/upload', require('../api/cloudinary').upload);
	}
	if (keystone.get('s3 config')) {
		router.post('/api/s3/upload', require('../api/s3').upload);
	}

	// #5: Core Lists API
	var initList = require('../middleware/initList');

	// lists
	router.all('/api/counts', require('../api/counts'));
	router.get('/api/:list', initList, require('../api/list/get'));
	router.get('/api/:list/:format(export.csv|export.json)', initList, require('../api/list/download'));
	router.post('/api/:list/create', initList, require('../api/list/create'));
	router.post('/api/:list/update', initList, require('../api/list/update'));
	router.post('/api/:list/delete', initList, require('../api/list/delete'));
	// items
	router.get('/api/:list/:id', initList, require('../api/item/get'));
	router.post('/api/:list/:id', initList, require('../api/item/update'));
	router.post('/api/:list/:id/delete', initList, require('../api/list/delete'));
	router.post('/api/:list/:id/sortOrder/:sortOrder/:newOrder', initList, require('../api/item/sortOrder'));

	// #6: List Routes
	router.all('/:list/:page([0-9]{1,5})?', IndexRoute);
	router.all('/:list/:item', IndexRoute);

	// TODO: catch 404s and errors with Admin-UI specific handlers

	return router;
};