@novice1/routing 1.0.11 → 1.1.3

package/lib/utils/toArray.js

@@ -1,28 +1,29 @@
-/**
- * 
- * @param {*} value 
- * @param {string} [type] 
- * @param {Function} [fn]
- * @param {boolean} [throwErrorIfFoundUnvalidType]
- */
-function toArray(value, type, fn, throwErrorIfFoundUnvalidType) {
-  if (!Array.isArray(value)) {
-    value = [value];
-  }
-
-  if (type && throwErrorIfFoundUnvalidType) {
-    if(value.some(v => typeof v !== type)){
-      throw new TypeError(`Expected type '${type}'`);
-    }
-  }
-  if (type && !throwErrorIfFoundUnvalidType) {
-    value = value.filter(v => typeof v === type);
-  }
-  if (typeof fn === 'function') {
-    value = value.filter(fn);
-  }
-
-  return value;
-}
-
+/**
+ * 
+ * @param {*} value 
+ * @param {string} [type] 
+ * @param {Function} [fn]
+ * @param {boolean} [throwErrorIfFoundUnvalidType]
+ * @returns {Array}
+ */
+function toArray(value, type, fn, throwErrorIfFoundUnvalidType) {
+  if (!Array.isArray(value)) {
+    value = [value];
+  }
+
+  if (type && throwErrorIfFoundUnvalidType) {
+    if(value.some(v => typeof v !== type)){
+      throw new TypeError(`Expected type '${type}'`);
+    }
+  }
+  if (type && !throwErrorIfFoundUnvalidType) {
+    value = value.filter(v => typeof v === type);
+  }
+  if (typeof fn === 'function') {
+    value = value.filter(fn);
+  }
+
+  return value;
+}
+
 module.exports = toArray;

package/package.json

@@ -1,29 +1,32 @@
-{
-  "name": "@novice1/routing",
-  "private": false,
-  "version": "1.0.11",
-  "description": "",
-  "main": "index.js",
-  "keywords": [
-    "routing",
-    "express",
-    "route",
-    "router"
-  ],
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/kisiwu/novice-routing.git"
-  },
-  "scripts": {
-    "test": "kaukau --config test/config/testconfig.js"
-  },
-  "author": "demingongo",
-  "license": "MIT",
-  "dependencies": {
-    "express": "^4.17.1",
-    "extend": "^3.0.2"
-  },
-  "devDependencies": {
-    "kaukau": "^0.2.2"
-  }
-}
+{
+  "name": "@novice1/routing",
+  "private": false,
+  "version": "1.1.3",
+  "description": "",
+  "main": "index.js",
+  "keywords": [
+    "routing",
+    "express",
+    "route",
+    "router"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/kisiwu/novice-routing.git"
+  },
+  "scripts": {
+    "test": "kaukau --config test/config/testconfig.js"
+  },
+  "author": "demingongo",
+  "license": "MIT",
+  "dependencies": {
+    "array-flatten": "^3.0.0",
+    "express": "^4.17.3",
+    "extend": "^3.0.2"
+  },
+  "devDependencies": {
+    "@types/express": "^4.17.13",
+    "chai": "^4.3.6",
+    "kaukau": "^2.0.0"
+  }
+}

package/.github/workflows/nodejs.yml

@@ -1,29 +0,0 @@
-name: Node CI
-
-on:
-  push:
-    branches: 
-      - master
-
-jobs:
-  build:
-
-    runs-on: ubuntu-latest
-
-    strategy:
-      matrix:
-        node-version: [10.x, 12.x, 14.x, 15.x]
-
-    steps:
-    - uses: actions/checkout@v1
-    - name: Use Node.js ${{ matrix.node-version }}
-      uses: actions/setup-node@v1
-      with:
-        node-version: ${{ matrix.node-version }}
-    - name: npm install, build, and test
-      run: |
-        npm ci
-        npm run build --if-present
-        npm test
-      env:
-        CI: true

package/test/config/testconfig.js

@@ -1,17 +0,0 @@
-module.exports = {
-	"enableLogs": false,
-	"exitOnFail": true,
-	"directory": "test/tests",
-	"options": {
-		"bail": false,
-		"fullTrace": true,
-		"grep": "",
-		"ignoreLeaks": false,
-		"reporter": "spec",
-		"retries": 0,
-		"slow": 100,
-		"timeout": 2000,
-		"ui": "bdd",
-		"color": true
-	}
-};

package/test/tests/00_setup.js

@@ -1,3 +0,0 @@
-require('chai/register-assert');  // Using Assert style
-require('chai/register-expect');  // Using Expect style
-require('chai/register-should');  // Using Should style

package/test/tests/01_test_register.js

@@ -1,52 +0,0 @@
-var router = require('../../index')();
-
-describe("Define routes and meta", () => {
-
-  router.all('/*', function allMiddleware (req, res, next) {
-    next()
-  });
-  // define the about route
-  router.get({
-    path: '/about',
-    name: 'about',
-    tags: ['About']
-  }, function aboutToDo(req, res) {
-    res.json(req.meta)
-  });
-  // define the post route
-  router.post({
-    path: '/post',
-    name: 'Post',
-    description: 'Post a comment',
-    tags: 'Comments'
-  }, function postToDo(req, res) {
-    res.json(req.meta)
-  });
-
-  it("should have registered 'all' route", function() {
-    expect(router.stack[0].route.path).to.equal('/*');
-  });
-
-  it("should have registered 'get' route", function() {
-    expect(router.stack[1].route.path).to.equal('/about');
-  });
-
-  it("should have registered 'post' route", function() {
-    expect(router.stack[2].route.path).to.equal('/post');
-  });
-
-  it("should have registered 'get' meta", function() {
-    expect(router.stack[1].route.meta.name).to.equal('about');
-    expect(router.stack[1].route.meta.tags)
-      .to.be.an('array', 'meta.tags in not an array')
-      .to.eql(['About']);
-  });
-
-  it("should have registered 'post' meta", function() {
-    expect(router.stack[2].route.meta.name).to.equal('Post');
-    expect(router.stack[2].route.meta.description).to.equal('Post a comment');
-    expect(router.stack[2].route.meta.tags)
-      .to.be.an('array', 'meta.tags in not an array')
-      .to.eql(['Comments']);
-  });
-});

package/test/tests/02_test_route_method.js

@@ -1,29 +0,0 @@
-var router = require('../../index')();
-
-describe("Define routes and meta with 'route' method", () => {
-  // define the homepage
-  router.route({
-    path: '/',
-    description: 'homepage for example',
-    name: 'homepage',
-    tags: ['Index', 'Examples']
-  }).get(function one(req, res, next) {
-    next();
-  }, function two(req, res) {
-    res.send('home page')
-  }).post(function two(req, res) {
-    res.send('post to home page')
-  });
-
-  it("should have registered route", function() {
-    expect(router.stack[0].route.path).to.equal('/');
-  });
-
-  it("should have registered meta", function() {
-    expect(router.stack[0].route.meta.name).to.equal('homepage');
-    expect(router.stack[0].route.meta.description).to.equal('homepage for example');
-    expect(router.stack[0].route.meta.tags)
-      .to.be.an('array', 'meta.tags in not an array')
-      .to.eql(['Index', 'Examples']);
-  });
-});

package/test/tests/03_test_auth.js

@@ -1,73 +0,0 @@
-var router = require('../../index')();
-
-describe("Define 'auth' routes and register middlewares using 'setAuthHandlers'", () => {
-
-  // register handlers for authentication
-  // for all routes with:
-  //   - 'auth' set to true
-  //   - registered to this router
-  router.setAuthHandlersIfNone(function authMiddleware(req, res, next){
-    // auth user
-    next();
-  },function authMiddleware2(req, res, next){
-    // auth user
-    next();
-  });
-
-  // define a route with 'auth' set to false/undefined
-  router.get({
-    path: '/comments',
-    name: 'Comments',
-    description: 'List of comment',
-    tags: 'Comments'
-  }, function list(req, res) {
-    res.json(req.meta)
-  });
-
-  // define a route with 'auth' set to true
-  router.put({
-    path: '/comments/:id',
-    name: 'Edit comment',
-    description: 'Update a comment',
-    auth: true,
-    tags: 'Comments'
-  }, function update(req, res) {
-    res.json(req.meta)
-  });
-
-
-  it("should NOT have added 'auth' Layers for route with 'auth' to false", function() {
-    expect(router.stack[0].route.meta.name).to.equal('Comments');
-    expect(router.stack[0].route.stack)
-      .to.be.an('array', 'route is missing stack of Layers')
-      .to.have.lengthOf(2);
-    //- check Layers
-    expect(router.stack[0].route.stack[0].type)
-      .to.be.an('undefined');
-    expect(router.stack[0].route.stack[1].type)
-      .to.be.an('undefined');
-  });
-
-  it("should have added 'auth' Layers for route with 'auth' to true", function() {
-    expect(router.stack[1].route.meta.name).to.equal('Edit comment');
-    expect(router.stack[1].route.stack)
-      .to.be.an('array', 'route is missing stack of Layers')
-      .to.have.lengthOf(4, 'number of Layers is different than expected');
-
-    //- check Layers
-    expect(router.stack[1].route.stack[0].type)
-      .to.be.an('undefined');
-    expect(router.stack[1].route.stack[1].type)
-      .to.eql('auth');
-    expect(router.stack[1].route.stack[2].type)
-      .to.eql('auth');
-    expect(router.stack[1].route.stack[3].type)
-      .to.be.an('undefined');
-
-    //- check if the right handlers are in the 'auth' Layers
-    expect(router.stack[1].route.stack[1].name)
-      .to.eql('authMiddleware');
-    expect(router.stack[1].route.stack[2].name)
-      .to.eql('authMiddleware2');
-  });
-});

package/test/tests/04_test_set_validators.js

@@ -1,74 +0,0 @@
-var router = require('../../index')();
-
-describe("Register middlewares using 'setValidators'", () => {
-
-  router.setAuthHandlers(function authMiddleware(req, res, next){
-    // auth user
-    next();
-  },function authMiddleware2(req, res, next){
-    // auth user
-    next();
-  });
-
-  router.setValidators(function customValidator(req, res, next){
-    next();
-  });
-
-  // define a route with 'auth' set to false/undefined
-  router.get({
-    path: '/comments',
-    name: 'Comments',
-    description: 'List of comment',
-    tags: 'Comments'
-  }, function list(req, res) {
-    res.json(req.meta)
-  });
-
-  // define a route with 'auth' set to true
-  router.put({
-    path: '/comments/:id',
-    name: 'Edit comment',
-    description: 'Update a comment',
-    auth: true,
-    tags: 'Comments'
-  }, function update(req, res) {
-    res.json(req.meta)
-  });
-
-
-  it("should have added 'validator' Layers", function() {
-    expect(router.stack[0].route.meta.name).to.equal('Comments');
-    expect(router.stack[0].route.stack)
-      .to.be.an('array', 'route is missing stack of Layers')
-      .to.have.lengthOf(3);
-    //- check Layers
-    expect(router.stack[0].route.stack[0].type)
-      .to.be.an('undefined');
-    expect(router.stack[0].route.stack[1].type)
-      .to.eql('validator');
-    expect(router.stack[0].route.stack[2].type)
-      .to.be.an('undefined');
-  });
-
-  it("should have added 'validator' Layers after 'auth' Layers", function() {
-    expect(router.stack[1].route.meta.name).to.equal('Edit comment');
-    expect(router.stack[1].route.stack)
-      .to.be.an('array', 'route is missing stack of Layers')
-      .to.have.lengthOf(5, 'number of Layers is different than expected');
-
-    //- check Layers
-    expect(router.stack[1].route.stack[0].type)
-      .to.be.an('undefined');
-    expect(router.stack[1].route.stack[1].type)
-      .to.eql('auth');
-    expect(router.stack[1].route.stack[2].type)
-      .to.eql('auth');
-    expect(router.stack[1].route.stack[3].type)
-      .to.eql('validator');
-    expect(router.stack[1].route.stack[4].type)
-      .to.be.an('undefined');
-
-    expect(router.stack[1].route.stack[3].name)
-      .to.eql('customValidator');
-  });
-});

package/test/tests/05_test_set_pre_validators.js

@@ -1,49 +0,0 @@
-var router = require('../../index')();
-
-describe("Register middlewares with meta 'preValidators'", () => {
-
-  router.setAuthHandlers(function authMiddleware(req, res, next){
-    // auth user
-    next();
-  },function authMiddleware2(req, res, next){
-    // auth user
-    next();
-  });
-
-  router.setValidators(function customValidator(req, res, next){
-    next();
-  });
-
-  // define a route with preValidators
-  router.get({
-    path: '/comments',
-    name: 'Comments',
-    description: 'List of comment',
-    auth: true,
-    preValidators: function prevalidator(req, res, next) {next()},
-    tags: 'Comments'
-  }, function list(req, res) {
-    res.json(req.meta)
-  });
-
-
-  it("should have added 'preValidator' layers before 'validator' Layers and after 'auth' Layers", function() {
-    expect(router.stack[0].route.meta.name).to.equal('Comments');
-    expect(router.stack[0].route.stack)
-      .to.be.an('array', 'route is missing stack of Layers')
-      .to.have.lengthOf(6, 'number of Layers is not correct');
-    //- check Layers
-    expect(router.stack[0].route.stack[0].type)
-      .to.be.an('undefined');
-    expect(router.stack[0].route.stack[1].type)
-      .to.eql('auth');
-    expect(router.stack[0].route.stack[2].type)
-      .to.eql('auth');
-    expect(router.stack[0].route.stack[3].type)
-      .to.eql('preValidator');
-    expect(router.stack[0].route.stack[4].type)
-      .to.eql('validator');
-    expect(router.stack[0].route.stack[5].type)
-      .to.be.an('undefined');
-  });
-});