vue-router-middleware-plugin

A vue.js plugin to implement a middleware pipeline for vue-router.

It can have many use cases like protecting a route or to request an API to populate the store before a route is loaded. The plugin utilizes vue-router navigation guards to implement easy to use, readable and more organized middlewares for your routes.

Please Note: Due to the very limited scope of this module, I do not anticipate need to making many changes to it. Expect long stretches of zero updates—that does not mean that the module is outdated.

Installation

Install using NPM

npm i -S vue-router-middleware-plugin

Install using Yarn

yarn add vue-router-middleware-plugin

Usage

Create a middleware, auth.js

import store from '~/store'

export default ({ to, from, redirect }) => {
  if (!store.getters.isLoggedIn) {
    redirect('/login')
    // or
    redirect(from)
    // or
    redirect(false)
  }
}

Note: Properties to and from are the same as in a vue router navigation gaurds. In v2.0.0 functin next has been replaced by redirect which can be called to redirect to a route. Now, there's no need to call next in each middleware to resolve it.

Register the plugin in your application.

import Vue from 'vue'
import MiddlewarePlugin from 'vue-router-middleware-plugin'
import router from '~/router'
import AuthMiddleware from '~router/middlewares/auth'
import LoggerMiddleware from '~router/middlewares/logger'

Vue.use(MiddlewarePlugin, router)

// register a globabl middleware
Vue.use(MiddlewarePlugin, { router, middleware: AuthMiddleware })

// register multiple globabl middlewares
Vue.use(MiddlewarePlugin, {
  router,
  middleware: [AuthMiddleware, LoggerMiddleware]
})

Note:: As the name suggests a global middleware will be resolved before each route.

Attach route middlewares in router.js

import ExampleMiddleware from './middlewares/example'
import AnotherMiddleware from './middlewares/another'

.
.
.
const routes = [
  {
    path: '/dashboard',
    component: DashboardView,
    meta: {
      // attavh a middleware to a route
      middleware: ExampleMiddleware
    }
  },
  {
    path: '/profile',
    component: ProfileView,
    meta: {
      // you may also use an array for multiple middlewares
      middleware: [ExampleMiddleware, AnotherMiddleware]
    }
  },
  .
  .
  .
]

Note: Global middlewares have precedence over route middlewares

If the user tries to access /profile route, the attached middlewares will be resolved in a synchronous order:

AuthMiddleware > LoggerMiddleware > ExampleMiddleware > AnotherMiddleware

AuthMiddleware and LoggerMiddleware will be resolved before profile route middlewares because they are global middlewares.

Ignore global middlewares in router.js

import AuthMiddleware from './middlewares/auth'
import LoggerMiddleware from './middlewares/logger'
import ExampleMiddleware from './middlewares/example'
import AnotherMiddleware from './middlewares/another'

.
.
.
const routes = [
  .
  .
  .
  {
    path: '/login',
    component: LoginView,
    meta: {
      middleware: {
        ignore: AuthMiddleware
      }
    }
  },
  {
    path: '/register',
    component: RegisterView,
    meta: {
      // you may also attach a middleware to this route
      middleware: {
        ignore: AuthMiddleware
        attach: AnotherMiddleware
      }
    }
  },

  {
    path: '/about',
    component: AboutView,
    meta: {
      // you may also use an array for multiple middlewares
      middleware: {
        ignore: [AuthMiddleware, LoggerMiddleware]
        attach: [ExampleMiddleware, AnotherMiddleware]
      }
    }
  }
]

New features

v1.2.0: Custom Middleware properties

You can now pass custom properties in plugin option context which will be accessible to the middleware.

import Vue from 'vue'
import MiddlewarePlugin from 'vue-router-middleware-plugin'
import router from '~/router'
import store from '~/store'

Vue.use(MiddlewarePlugin, {
  router,
  // context must be an object
  context: {
    version: process.env.VERSION
  }
})

In any middleware, version will be added to context

export default ({ version }) => {
  console.log('version:', version)
}

v2.0.0: New property in middleware context

• Middlewares don't need to be resolved by calling next.
• A new function redirect, added to the middleware context.
• Breaking Change: Function next removed from middleware context.

Roadmap

• v1.0.0 - Route Middlewares.
• v1.1.0 - Global Middlewares.
• v1.2.0 - Middleware context - custom properties.
• v2.0.0 - Middleware Pipeline (rebuild).
• TBD - Auto importing middlewares.

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

License

MIT