@novice1/routing 1.0.11 → 1.1.3

package/README.md

@@ -19,7 +19,7 @@ A JSON object can be sent as the `path` parameter when using route methods (`get
 - `name`: (string)
 - `description`: (string)
 - `parameters`: (object)
-- `responses`: (object)
+- `responses`: (any)
 - `tags`: (string[])
 - `auth`: (boolean)
 - `preValidators`: (function[])
@@ -161,6 +161,24 @@ routerParent.setValidatorsIfNone(function (req, res, next) {
 })
 ```
 
+## Notes
+
+### Typescript
+
+This package extends `Request` interface from [express](https://www.npmjs.com/package/express) so you can always extend it more depending on your needs.
+
+Example:
+```ts
+declare global {
+  namespace Express {
+    interface Request {
+      // add a property
+      session?: Record<string, any>;
+    }
+  }
+}
+```
+
 ## References
 
 - [Express](https://expressjs.com/)

package/index.d.ts

@@ -0,0 +1,5 @@
+/// <reference path='lib/router.d.ts' />
+
+import routing from './lib/router';
+
+export = routing;

package/lib/layer.js

@@ -1,113 +1,124 @@
-var inherits = require('util').inherits;
-var flatten = require('array-flatten');
-var ExpressLayer = require("express/lib/router/layer");
-
-function Layer() {
-  var args = Array.from(arguments);
-  ExpressLayer.apply(this, args);
-
-  this.get_meta = get_meta;
-  this.set_auth = set_auth;
-  this.set_auth_if_none = set_auth_if_none;
-  this.set_validators = set_validators;
-  this.set_validators_if_none = set_validators_if_none;
-  this.meta_path = args[0];
-}
-
-inherits(Layer, ExpressLayer);
-
-function get_meta(path) {
-  var v = [];
-  if(path) {
-    path += this.meta_path;
-    path = path.replace(/\/{2,}/g, '/');
-  } else {
-    path = this.meta_path;
-  }
-  if (this.route) {
-    var tmpMeta = {
-      path: `${path}`,
-      methods: this.route.methods
-    };
-    if(this.route.meta) {
-      Object.keys(this.route.meta).forEach(
-        k => {
-          tmpMeta[k] = this.route.meta[k]
-        }
-      );
-    }
-    v.push(tmpMeta);
-  }
-
-  if (this.handle && this.handle.stack) {
-    this.handle.stack.forEach(layer => {
-      if (layer && typeof layer.get_meta === 'function') {
-        v.push.apply(v,flatten(layer.get_meta(path)));
-      }
-    });
-  }
-
-  return v;
-}
-
-function set_auth() {
-  if (this.route) {
-    if(typeof this.route.setAuth === 'function') {
-      var args = flatten(Array.prototype.slice.call(arguments));
-      this.route.setAuth.apply(this.route, args);
-    }
-  }
-
-  if (this.handle && typeof this.handle.setAuthHandlers === 'function') {
-    var argsForRouter = flatten(Array.prototype.slice.call(arguments));
-    argsForRouter.shift();
-    this.handle.setAuthHandlers.apply(this.handle, argsForRouter);
-  }
-}
-
-function set_auth_if_none() {
-  if (this.route) {
-    if(typeof this.route.hasAuth === 'function' && !this.route.hasAuth()) {
-      var args = flatten(Array.prototype.slice.call(arguments));
-      this.route.setAuth.apply(this.route, args);
-    }
-  }
-
-  if (this.handle && typeof this.handle.setAuthHandlersIfNone === 'function') {
-    var argsForRouter = flatten(Array.prototype.slice.call(arguments));
-    argsForRouter.shift();
-    this.handle.setAuthHandlersIfNone.apply(this.handle, argsForRouter);
-  }
-}
-
-function set_validators() {
-  if (this.route) {
-    if(typeof this.route.setValidators === 'function') {
-      var args = flatten(Array.prototype.slice.call(arguments));
-      this.route.setAuth.apply(this.route, args);
-    }
-  }
-
-  if (this.handle && typeof this.handle.setValidators === 'function') {
-    var argsForRouter = flatten(Array.prototype.slice.call(arguments));
-    argsForRouter.shift();
-    this.handle.setValidators.apply(this.handle, argsForRouter);
-  }
-}
-
-function set_validators_if_none() {
-  if (this.route) {
-    if(typeof this.route.hasValidators === 'function' && !this.route.hasValidators()) {
-      var args = flatten(Array.prototype.slice.call(arguments));
-      this.route.setValidators.apply(this.route, args);
-    }
-  }
-
-  if (this.handle && typeof this.handle.setValidatorsIfNone === 'function') {
-    var argsForRouter = flatten(Array.prototype.slice.call(arguments));
-    argsForRouter.shift();
-    this.handle.setValidatorsIfNone.apply(this.handle, argsForRouter);
-  }
-}
-
+var inherits = require('util').inherits;
+var { flatten } = require('array-flatten');
+var ExpressLayer = require("express/lib/router/layer");
+var toArray = require('./utils/toArray');
+
+function Layer() {
+  var args = Array.from(arguments);
+  ExpressLayer.apply(this, args);
+
+  this.get_meta = get_meta;
+  this.set_auth = set_auth;
+  this.set_auth_if_none = set_auth_if_none;
+  this.set_validators = set_validators;
+  this.set_validators_if_none = set_validators_if_none;
+  this.meta_path = args[0];
+}
+
+inherits(Layer, ExpressLayer);
+
+function get_meta(path) {
+  var v = [];
+  // can only generate for string paths
+  var metaPaths = toArray(this.meta_path);
+  metaPaths.forEach(
+    metaPath => {
+      var loopPath = path;
+      if(loopPath) {
+        if (typeof metaPath !== 'string') {
+          return;
+        }
+        loopPath += metaPath;
+        loopPath = loopPath.replace(/\/{2,}/g, '/');
+      } else {
+        loopPath = metaPath;
+      }
+      if (this.route) {
+        var tmpMeta = {
+          path: loopPath,
+          methods: this.route.methods
+        };
+        if(this.route.meta) {
+          Object.keys(this.route.meta).forEach(
+            k => {
+              tmpMeta[k] = this.route.meta[k]
+            }
+          );
+        }
+        v.push(tmpMeta);
+      }
+    
+      if (this.handle && this.handle.stack && typeof loopPath === 'string') {
+        this.handle.stack.forEach(layer => {
+          if (layer && typeof layer.get_meta === 'function') {
+            v.push.apply(v,flatten(layer.get_meta(loopPath)));
+          }
+        });
+      }
+    }
+  );
+
+  return v;
+}
+
+function set_auth() {
+  if (this.route) {
+    if(typeof this.route.setAuth === 'function') {
+      var args = flatten(Array.prototype.slice.call(arguments));
+      this.route.setAuth.apply(this.route, args);
+    }
+  }
+
+  if (this.handle && typeof this.handle.setAuthHandlers === 'function') {
+    var argsForRouter = flatten(Array.prototype.slice.call(arguments));
+    argsForRouter.shift();
+    this.handle.setAuthHandlers.apply(this.handle, argsForRouter);
+  }
+}
+
+function set_auth_if_none() {
+  if (this.route) {
+    if(typeof this.route.hasAuth === 'function' && !this.route.hasAuth()) {
+      var args = flatten(Array.prototype.slice.call(arguments));
+      this.route.setAuth.apply(this.route, args);
+    }
+  }
+
+  if (this.handle && typeof this.handle.setAuthHandlersIfNone === 'function') {
+    var argsForRouter = flatten(Array.prototype.slice.call(arguments));
+    argsForRouter.shift();
+    this.handle.setAuthHandlersIfNone.apply(this.handle, argsForRouter);
+  }
+}
+
+function set_validators() {
+  if (this.route) {
+    if(typeof this.route.setValidators === 'function') {
+      var args = flatten(Array.prototype.slice.call(arguments));
+      this.route.setAuth.apply(this.route, args);
+    }
+  }
+
+  if (this.handle && typeof this.handle.setValidators === 'function') {
+    var argsForRouter = flatten(Array.prototype.slice.call(arguments));
+    argsForRouter.shift();
+    this.handle.setValidators.apply(this.handle, argsForRouter);
+  }
+}
+
+function set_validators_if_none() {
+  if (this.route) {
+    if(typeof this.route.hasValidators === 'function' && !this.route.hasValidators()) {
+      var args = flatten(Array.prototype.slice.call(arguments));
+      this.route.setValidators.apply(this.route, args);
+    }
+  }
+
+  if (this.handle && typeof this.handle.setValidatorsIfNone === 'function') {
+    var argsForRouter = flatten(Array.prototype.slice.call(arguments));
+    argsForRouter.shift();
+    this.handle.setValidatorsIfNone.apply(this.handle, argsForRouter);
+  }
+}
+
 module.exports = Layer;

package/lib/route/createLayers.js

@@ -1,39 +1,39 @@
-// var Layer = require("./layer"); // no need for extra methods if layer is inside a Route
-var Layer = require("express/lib/router/layer");
-
-/**
- * @description returns Layers in opposite order
- * @param {string} type type of layer
- * @param {string} method 
- * @param {object} layerOptions 
- * @param {Function[]} handles 
- * @param {any} dispatchBind
- * @returns {Layer[]}
- */
-function createLayers(type, method, layerOptions, handles, dispatchBind) {
-  var layers = [];
-
-  handles.forEach(
-    handle => {
-    /**
-     * @todo review the layer arguments
-     */
-    var layer = new Layer(
-      "/", // TO REVIEW: '/' OR this.path ?
-      layerOptions,
-      dispatchBind
-    );
-
-    layer.handle = handle;
-    layer.name = handle.name;
-    layer.method = method;
-    // layer[type] = true;
-    layer.type = type;
-
-    layers.unshift(layer);
-  });
-
-  return layers;
-}
-
-module.exports = createLayers;
+// var Layer = require("./layer"); // no need for extra methods if layer is inside a Route
+var Layer = require("express/lib/router/layer");
+
+/**
+ * @description returns Layers in opposite order
+ * @param {string} type type of layer
+ * @param {string} method 
+ * @param {object} layerOptions 
+ * @param {Function[]} handles 
+ * @param {any} dispatchBind
+ * @returns {Layer[]}
+ */
+function createLayers(type, method, layerOptions, handles, dispatchBind) {
+  var layers = [];
+
+  handles.forEach(
+    handle => {
+    /**
+     * @todo review the layer arguments
+     */
+    var layer = new Layer(
+      "/", // TO REVIEW: '/' OR this.path ?
+      layerOptions,
+      dispatchBind
+    );
+
+    layer.handle = handle;
+    layer.name = handle.name;
+    layer.method = method;
+    // layer[type] = true;
+    layer.type = type;
+
+    layers.unshift(layer);
+  });
+
+  return layers;
+}
+
+module.exports = createLayers;

package/lib/route/metadataMiddleware.js

@@ -1,34 +1,33 @@
-var extend = require('extend'); 
-
-/**
- * 
- * @param {string} method 
- * @param {string} path 
- * @param {object} meta
- * @returns {Function}
- */
-function createMetadataMiddleware(method, path, meta) {
-  var requestMeta = {
-    method: method
-  };
-  if (path && path.indexOf("//") == 0) {
-    path = path.replace("//", "/");
-  }
-  requestMeta.path = path;
-
-  if (meta) {
-    ['auth', "name", "description", 'tags', "parameters", "responses"].forEach(
-      p => {
-        if (typeof meta[p] !== 'undefined')
-          requestMeta[p] = meta[p];
-      }
-    );
-  }
-
-  return function noviceRouteMetadataMiddleware(req, res, next) {
-    req.meta = extend(true, {}, requestMeta);
-    next();
-  };
-}
-
+var extend = require('extend'); 
+
+/**
+ * 
+ * @param {string} method 
+ * @param {string} path 
+ * @param {object} meta
+ * @returns {Function}
+ */
+function createMetadataMiddleware(method, path, meta) {
+  var requestMeta = {
+    method: method
+  };
+  if (path && typeof path === 'string' && path.indexOf('//') == 0) {
+    path = path.replace('//', '/');
+  }
+  requestMeta.path = path;
+
+  if (meta) {
+    ['auth', 'name', 'description', 'tags', 'parameters', 'responses'].forEach(
+      (p) => {
+        if (typeof meta[p] !== 'undefined') requestMeta[p] = meta[p];
+      }
+    );
+  }
+
+  return function noviceRouteMetadataMiddleware(req, res, next) {
+    req.meta = extend(true, {}, requestMeta);
+    next();
+  };
+}
+
 module.exports = createMetadataMiddleware;