feat(middleware-context): add plugin option context

user can add custom properties in context option which will be accessible to the middleware in
context object

Author: iodsfx3d

.travis.yml

@@ -15,6 +15,7 @@ before_install:
 before_script:
   - npm prune
 script:
+  - npm run test
   - npm run build
 after_success:
   - bash <(curl -s https://codecov.io/bash)

README.md

@@ -156,14 +156,42 @@ const routes = [
     }
   }
 ]
+```
+
+### 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.
 
+```javascript
+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: { store }
+})
+```
+
+In the middleware
+
+```javascript
+export default ({ next, store }) => {
+  store.commit('app/commit', true)
+  next()
+}
 ```
 
 ## Roadmap
 
-- [x] **v1.0.0** - Route Middlewares
-- [x] **v1.1.0** - Global Middlewares
-- [ ] **v1.2.0** - Auto importing middlewares.
+- [x] **v1.0.0** - Route Middlewares.
+- [x] **v1.1.0** - Global Middlewares.
+- [x] **v1.2.0** - Middleware context - custom properties.
+- [ ] **TBD** - Auto importing middlewares.
 
 ## Contributing
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "vue-router-middleware-plugin",
-  "version": "1.0.2",
+  "version": "0.0.0-development",
   "description": "A vue.js plugin to implement a middleware pipeline between your routes.",
   "main": "build/index.js",
   "types": "build/index.d.ts",
@@ -10,7 +10,7 @@
   "scripts": {
     "type-check": "tslint-config-prettier-check ./tslint.json",
     "type-check:watch": "tsc --noEmit --watch",
-    "prebuild": "npm run precommit",
+    "prebuild": "npm run lint",
     "build": "npm run build:types && npm run build:js",
     "build:types": "tsc --emitDeclarationOnly",
     "build:js": "babel src --out-dir build --extensions \".ts,.tsx\" --source-maps inline",

src/install.ts

@@ -1,5 +1,6 @@
 import { middlewarePipeline } from './helpers/middlewarePipeline'
 import { retuenMiddlewareArray } from './helpers/returnMiddlewareArray'
+import { BasePluginError } from './lib/Exceptions/BasePluginError'
 import { OptionsMissingPluginError } from './lib/Exceptions/OptionsMissingPluginError'
 import { Middleware } from './types/MiddlewareTypes'
 import { Install, PluginOptions } from './types/PluginTypes'
@@ -18,15 +19,29 @@ export const install: Install<Router | PluginOptions> = (
 ) => {
   let router: Router
   let middlewares: Middleware[] = []
+  let context: RouteContext = {}
 
   if (options && (options as PluginOptions).router) {
-    const { router: _router, middleware } = options as PluginOptions
+    const {
+      router: _router,
+      middleware,
+      context: _context
+    } = options as PluginOptions
     router = _router
 
     /* istanbul ignore if */
     if (middleware !== undefined) {
       middlewares = retuenMiddlewareArray(middleware)
     }
+
+    if (_context !== undefined) {
+      /* istanbul ignore if */
+      if (typeof _context === 'object') {
+        context = { ..._context }
+      } else {
+        throw new BasePluginError('invalid context provided in plugin options')
+      }
+    }
   } else {
     router = options as Router
   }
@@ -61,7 +76,7 @@ export const install: Install<Router | PluginOptions> = (
         }
       }
       if (middlewares.length) {
-        const context: RouteContext = { to, from, next }
+        context = { ...context, to, from, next }
         const routeResolver = middlewarePipeline(
           context,
           middlewares

src/types/PluginTypes.ts

@@ -6,4 +6,5 @@ export type Install<T> = (vue: Vue, router?: T) => void
 export interface PluginOptions {
   router: Router
   middleware?: Middleware[] | Middleware
+  context?: { [key: string]: any }
 }

src/types/VueTypes.ts

@@ -18,9 +18,10 @@ export interface Router {
 // route types
 export type RouteResolver = (arg?: boolean | string | Route) => void
 export interface RouteContext {
-  to: Route
-  from: Route
-  next: RouteResolver
+  to?: Route
+  from?: Route
+  next?: RouteResolver
+  [key: string]: any
 }
 export interface RouteMeta {
   middleware?: Middleware[] | Middleware | MiddlewarePipeline

tests/install.spec.ts

@@ -1,11 +1,9 @@
 //
 import { install } from '../src/install'
-// exceptions
+import { BasePluginError } from '../src/lib/Exceptions/BasePluginError'
 import { OptionsMissingPluginError } from '../src/lib/Exceptions/OptionsMissingPluginError'
 import { PluginOptions } from '../src/types/PluginTypes'
-// types
 import { Router, Vue } from '../src/types/VueTypes'
-// test utils
 import { expectErrorClass, VueRouter } from '../src/utils/testUtils'
 
 describe('installation checks', () => {
@@ -15,13 +13,23 @@ describe('installation checks', () => {
     expectErrorClass(() => install(dummyVue), OptionsMissingPluginError)
   })
 
-  const router: Router = new VueRouter()
   it('accepts router as plugin option', () => {
+    const router: Router = new VueRouter()
     install(dummyVue, router)
   })
 
-  const pluginOptions: PluginOptions = { router }
   it('accepts options object as plugin option', () => {
+    const router: Router = new VueRouter()
+    const pluginOptions: PluginOptions = { router }
     install(dummyVue, pluginOptions)
   })
+
+  it('raises exception if invalid context provided in plugin options', () => {
+    const router: Router = new VueRouter()
+    const pluginOptions: PluginOptions = ({
+      context: 1,
+      router
+    } as unknown) as PluginOptions
+    expectErrorClass(() => install(dummyVue, pluginOptions), BasePluginError)
+  })
 })