Flux Capacitor - Bootstrapper

Bootstrapping utils for the Flux Capacitor. Setting up a flux capacitor HTTP service in a simple, yet customizable way by using feature middlewares.

Usage

This will set up a flux capacitor service with RESTful routes for reading data, dispatching events and pushing realtime updates using a websocket:

1const authorize = require('flux-capacitor-boot/authorize')
2const { connectTo } = require('flux-capacitor-sequelize')
3const {
4  bootstrap, createExpressApp, createDispatcher, createStore, createWebSocket, use
5} = require('flux-capacitor-boot/express')
6
7const commands = require('./commands')
8const createCollections = require('./collections')
9const rootReducer = require('./reducers')
10
11bootstrap([
12  use.app(createExpressApp()),
13  use.store(createStore(rootReducer, connectTo(process.env.DB_CONNECTION, createCollections))),
14  use.route('/dispatch/:commandName', createDispatcher(commands), (req) => authorize.allow()),
15  use.route('/events(/:id)?', createReadRoute('events', { sortBy: 'timestamp', sortOrder: 'DESC' })),
16  use.route('/notes(/:id)?', createReadRoute('notes')),
17  use.route('/websocket', createWebSocket())
18]).listen(process.env.PORT)

Customize

1const { bootstrap, use } = require('flux-capacitor-boot/express')
2
3bootstrap([
4  ...
5
6  // Optionally add custom express middlewares you need:
7  use.expressMiddleware([ someMiddleware ]),
8
9  // `use.*` just returns a function of this type:
10  ({ app, store }) => Promise.resolve({ app, store })
11])

If you want to use an existing express app or want to use some custom app then just pass it to use.app() instead of using createExpressApp():

1const bodyParser = require('body-parser')
2const express = require('express')
3const { bootstrap, use } = require('flux-capacitor-boot/express')
4
5const app = express()
6
7bootstrap([
8  use.app(app),
9  use.expressMiddleware([ bodyParser.json() ]),   // the dispatcher needs this middleware, createExpressApp() would have set it up for us
10  ...
11])

Authorization

1const authorize = require('flux-capacitor-boot/authorize')
2const { bootstrap, createWebSocket, use } = require('flux-capacitor-boot/express')
3
4bootstrap([
5  use.route('/some/route', someHandler, authorizeRoute),
6  use.route('/websocket', createWebSocket(authorizeEventPropagation))
7])
8
9// Must return authorize.allow() or authorize.deny(Error) or a promise.
10function authorizeRoute (req) {
11  if (!req.user) {
12    return authorize.deny('You are not logged in or there is no express middleware for authentication set.')
13  }
14
15  if (req.user === 'John') {
16    return authorize.allow()
17  } else {
18    // Can also pass an error object to `authorize.deny()`
19    return authorize.deny('Only John is allowed to use this route.')
20  }
21}
22
23function authorizeEventPropagation (event, websocket) {
24  return authorize.allow()
25}

Flux Capacitor

Find it here 👉 Flux Capacitor

License

Released under the terms of the MIT license.