Merge pull request #103 from Dashron/feat/commonMiddlewareFunction

Feat/common middleware function

Author: Dashron

example/ts/src/server.ts

@@ -7,7 +7,7 @@
  */
 
 import { Road, Response, RemoveTrailingSlashMiddleware, CookieMiddleware,
-	StoreValsMiddleware, ParseBodyMiddleware, RouterMiddleware } from 'roads';
+	StoreValsMiddleware, ParseBodyMiddleware, RouterMiddleware, attachCommonMiddleware } from 'roads';
 
 import { Server } from 'roads-server';
 import addLayout from './middleware/addLayout';
@@ -22,11 +22,9 @@ road.use(function (method, url, body, headers, next) {
 	return next();
 });
 
-road.use(RemoveTrailingSlashMiddleware.middleware);
+attachCommonMiddleware(road);
 road.use(CookieMiddleware.serverMiddleware);
-road.use(StoreValsMiddleware.middleware);
 road.use(addLayout);
-road.use(ParseBodyMiddleware.middleware);
 
 const router = new RouterMiddleware.Router(road);
 applyPublicRotues(router);

package.json

@@ -1,6 +1,6 @@
 {
   "name": "roads",
-  "version": "8.0.0-alpha.2",
+  "version": "8.0.0-alpha.3",
   "author": {
     "name": "Aaron Hedges",
     "email": "[email protected]",

src/index.ts

@@ -1,14 +1,32 @@
+import Road from './core/road';
+
 export { default as Response } from './core/response';
 export { default as Road } from './core/road';
 export { default as RoadsPJAX } from './client/pjax';
 export { default as Request } from './client/request';
 
 export * as ApplyToContextMiddleware from './middleware/applyToContext';
+// This is not part of the common middleware because it uses different middleware depending on client or server
 export * as CookieMiddleware from './middleware/cookieMiddleware';
+// This is not part of the common middleware because it requires configuration
 export * as CorsMiddleware from './middleware/cors';
 export * as RemoveTrailingSlashMiddleware from './middleware/removeTrailingSlash';
+import * as RemoveTrailingSlashMiddleware from './middleware/removeTrailingSlash';
 export * as ParseBodyMiddleware from './middleware/parseBody';
+import * as ParseBodyMiddleware from './middleware/parseBody';
+// This is not part of the common middleware because it requires configuration
 export * as RerouteMiddleware from './middleware/reroute';
 export * as StoreValsMiddleware from './middleware/storeVals';
+import * as StoreValsMiddleware from './middleware/storeVals';
 export * as ModifiedSinceMiddleware from './middleware/modifiedSince';
-export * as RouterMiddleware from './middleware/router';
+import * as ModifiedSinceMiddleware from './middleware/modifiedSince';
+// This is not part of the common middleware because it requires configuration,
+//  and should happen after all user-provided middleware
+export * as RouterMiddleware from './middleware/router';
+
+export function attachCommonMiddleware(road: Road) {
+	road.use(RemoveTrailingSlashMiddleware.middleware);
+	road.use(StoreValsMiddleware.middleware);
+	road.use(ParseBodyMiddleware.middleware);
+	road.use(ModifiedSinceMiddleware.middleware);
+}

todo.md

@@ -3,6 +3,7 @@
    2. Ensure browserify is entirely gone from all examples
    3. Document the router request chain
    4. Document the new context typing
+   5. Common middleware function
 
 # Future
 1. Figure out a way to have better typing on headers