Upgrade dependencies

.github/workflows/test.yml

@@ -0,0 +1,20 @@
+name: Build And Test
+
+on: [push]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        node-version: ['14.21.3', '21.7.3']
+
+    steps:
+      - uses: actions/checkout@v4
+      - name: Use Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: '20.x'
+      - run: npm install
+      - run: npm test

.gitignore

@@ -1,3 +1,6 @@
 node_modules/
+coverage.html
+*.log
 yarn.lock
-coverage.html
+package-lock.json
+.idea

CHANGELOG.md

@@ -0,0 +1,46 @@
+# hapi-auto-route Change Log
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](http://keepachangelog.com/) and this project adheres to [Semantic Versioning](http://semver.org/).
+
+## 3.0.0
+
+- `routes_dir` requires an absolute path and must set in plugin registration.
+- Updates dependencies.
+- Updates documentation.
+
+### 3.1.0
+
+- `routes_dir` accepts an array of parameters.
+- Updates documentation.
+
+### 3.0.1
+
+- Updates documentation.
+
+### 3.0.2
+
+- add dependency on @hapi/hoek
+
+### 3.0.3
+
+- Update documentation
+
+### 3.0.4
+
+- Fix unpublished version
+
+
+### 2.0.3
+
+- Fix issues [#10](https://github.com/sitrakary/hapi-auto-route/issues/10).
+- Fix lint errors.
+
+### 2.0.2
+
+- Fix issues [#5](https://github.com/sitrakary/hapi-auto-route/issues/5).
+
+### 2.0.1
+
+- Update dependencies.

LICENCE.md → LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2018 Sitraka Ratsimba
+Copyright (c) 2024 Sitraka Ratsimba
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the
@@ -17,4 +17,4 @@ MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
 LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
 OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

@@ -1,16 +1,17 @@
 # hapi-auto-route
 
-[![Semver](http://img.shields.io/SemVer/2.0.0.png)](http://semver.org/spec/v2.0.0.html)
-[![Dependency Status](https://david-dm.org/sitrakary/hapi-auto-route.svg)](https://david-dm.org/sitrakary/hapi-auto-route)
-[![devDependency Status](https://david-dm.org/sitrakay/hapi-auto-route/dev-status.svg)](https://david-dm.org/sitrakay/hapi-auto-route#info=devDependencies)
+![npm](https://img.shields.io/npm/v/hapi-auto-route?style=for-the-badge)
+![Travis (.org)](https://img.shields.io/travis/sitraka-hq/hapi-auto-route?style=for-the-badge)
 
 [![NPM](https://nodei.co/npm/hapi-auto-route.png?downloads=true&downloadRank=true&stars=true)](https://nodei.co/npm/hapi-auto-route/)
 
-hapi-auto-route is a hapi plugin that lets you load route objects automatically from a directory.
+hapi-auto-route is a hapi plugin that lets you load route objects automatically by specifying the root directory/directories containing the routes. And allow routes path to be prefixed.
+
+Maintainer: [Sitraka Ratsimba](https://github.com/cooxe)
 
 ## Installation
 
-For Hapi `v17.x.x`:
+For Hapi `>= v17`:
 
 ```bash
 npm i -S hapi-auto-route
@@ -38,27 +39,33 @@ package.json
 ```javascript
 // routes/home.js
 'use strict';
-
+ 
 module.exports = {
     method: 'GET',
     path: '/',
-    handler: (request, h) => 'Hello';
-}
+    handler: (request, h) => 'Hello'
+};
 ```
 
 ```javascript
 // server.js
 'use strict';
 
-const Hapi = require('hapi');
+const Path = require('path');
+const Hapi = require('@hapi/hapi');
 
 const server = Hapi.Server({
   port: 3000,
   host: 'localhost'
 });
 
 const init = async () => {
-    await server.register(require('hapi-auto-route'));
+    await server.register({
+      plugin: require('hapi-auto-route'),
+      options: {
+        routes_dir: Path.join(__dirname, 'routes')
+      }
+     });
     await server.start();
     console.log(`Server is running at: ${server.info.uri}`);
 };
@@ -73,17 +80,19 @@ init();
 
 Now, you can start the server and see `Hello` at `http://localhost:3000`.
 
+You can also provide an array of absolute paths if you want to auto-import from multiple base directories.
+
 
 ## API
 
-- `routes_dir`: directory where routes are located. `routes_dir` should be relative to `process.cwd()`. Defaults to `'routes'`.
+- `routes_dir`: absolute path(s) to routes directory/directories. `required`
 - `pattern`: glob pattern used to find route files. Defaults to `**/!(_)*.js`.
-- `use_prefix`: Use directory tree as prefix. Defaults to `true`.
+- `use_prefix`: Use directory tree as prefix. Defaults to `false`.
 
 ## Contributing
 
 If you find a bug in the source code or a mistake in the documentation, you can help us by [submitting an issue](https://github.com/sitrakay/hapi-auto-route/issues) or a [pull request](https://github.com/sitrakay/hapi-auto-route/pulls) with a fix.
 
 ## Licence
 
-This project is licensed under the MIT License - see the [LICENSE.txt](https://github.com/sitrakay/hapi-auto-route/blob/master/LICENCE.md) file for details.
+This project is licensed under the MIT License - see the [LICENSE](https://github.com/sitrakay/hapi-auto-route/blob/master/LICENSE) file for details.

index.js

@@ -1,27 +1,28 @@
 'use strict';
 
-const { promisify } = require('util');
-const Route = require('./lib/route.js');
-const Option = require('./lib/option');
+const Path = require('path');
+
+const AutoRoute = require('./lib/auto-route');
 
 exports.plugin = {
     pkg: require('./package.json'),
     register: async (server, options) => {
 
-        let routes = [];
-        const valideOptions = Option.validate(options);
-        const getAllRoute = promisify(Route.getAll);
-        const files = await getAllRoute(valideOptions);
-        files.forEach((file) => {
+        const opts = AutoRoute.validateOptions(options);
+
+        let prefixes = [];
+
+        const files = await AutoRoute.getFiles(opts.routes_dir, opts.pattern);
+        let routes = AutoRoute.getRoutes(files);
+
+        if (opts.use_prefix) {
+            prefixes = AutoRoute.getPrefixes(files, Path.resolve(opts.routes_dir));
+            routes = AutoRoute.updatePaths(prefixes, routes, server.settings.router.stripTrailingSlash);
+        }
 
-            routes = Route.load(valideOptions, file);
-            if (valideOptions.use_prefix) {
-                routes.forEach((route) => {
+        routes.forEach((route) => {
 
-                    route.path = Route.getPathPrefix(valideOptions, file) + route.path;
-                });
-            }
-            server.route(routes);
+            server.route(route);
         });
     }
 };

lib/auto-route.js

@@ -0,0 +1,101 @@
+'use strict';
+
+const Glob = require('glob');
+const Hoek = require('@hapi/hoek');
+const Joi = require('joi');
+const Path = require('path');
+const Util = require('util');
+const Prefix = require('./prefix');
+
+module.exports.getFiles = (baseDir, pattern) => {
+
+    if (Array.isArray(baseDir)) {
+        return new Promise((resolve) => {
+
+            Promise.all(baseDir.map((d) => this.getFiles(d, pattern)))
+                .then((value) => resolve(Hoek.flatten(value)));
+        });
+    }
+
+    const absolutePattern = Path.join(baseDir, pattern);
+    const glob = Util.promisify(Glob);
+    return glob(absolutePattern, {});
+};
+
+module.exports.getRoutes = (filepaths) => {
+
+    const routeSchema = Joi.object().keys({
+        method: Joi.string().required(),
+        path: Joi.string().required()
+        // Technically handler is required as well, either in the method or in its options, but that gets sticky with plugins.
+    }).xor('handler', 'options').unknown(true);
+
+    const multipleRoutesAllowed = Joi.alternatives(routeSchema, Joi.array().items(routeSchema));
+
+    const files = filepaths.map((p) => require(Path.resolve(p)));
+
+    const routes = files.filter((file) => {
+
+        const result = multipleRoutesAllowed.validate(file);
+        return !Object.keys(result).includes('error');
+    });
+
+    return routes.map((file) => Hoek.clone(file));
+};
+
+module.exports.getPrefixes = (files, baseDir) => {
+
+    return files.map((file) => {
+
+        return Prefix.parse(file, baseDir).reduce((current, next) => {
+
+            return current + '/' + next;
+        }, '');
+    });
+};
+
+module.exports.updatePaths = (prefixes, routes, stripTrailingSlash) => {
+
+    const update = (route, index, removeTrailingSlash) => {
+
+        const newRoute = Hoek.clone(route);
+
+        if (prefixes[index] === '/') {
+            return newRoute;
+        }
+
+        newRoute.path = prefixes[index] + route.path;
+        if (removeTrailingSlash && newRoute.path.endsWith('/')) {
+            newRoute.path = newRoute.path.slice(0, -1);
+        }
+
+        return newRoute;
+    };
+
+    return routes.map((route, index) => {
+
+        if (Array.isArray(route)) {
+            return route.map((innerRoute, _index) => {
+
+                return update(innerRoute, index, stripTrailingSlash);
+            });
+        }
+
+        return update(route, index, stripTrailingSlash);
+    });
+};
+
+module.exports.validateOptions = (options) => {
+
+    const optionsSchema = Joi.object().keys({
+        routes_dir: Joi.alternatives().try(Joi.string(), Joi.array().items(Joi.string())).required(),
+        pattern: Joi.string().default('**/!(_)*.js'),
+        use_prefix: Joi.boolean().default(false)
+    });
+
+    const result = optionsSchema.validate(options);
+
+    Hoek.assert(!Object.keys(result).includes('error'), 'Invalid options are passed to hapi-auto-route');
+
+    return result.value;
+};

lib/prefix.js

@@ -0,0 +1,28 @@
+'use strict';
+
+const Path = require('path');
+const Hoek = require('@hapi/hoek');
+
+module.exports.parse = (file, baseDir) => {
+
+    Hoek.assert(Path.isAbsolute(baseDir), 'baseDir must be an absolute path');
+
+    const absolutePath = Path.dirname(Path.relative(baseDir, file));
+    const prefixes = absolutePath.split(Path.sep);
+    return prefixes.map((prefix) => {
+
+        return prefix === '.' ? '' : prefix;
+    });
+};
+
+module.exports.joinPrefix = (prefixes) => {
+
+    return prefixes.reduce((joined, prefix) => {
+
+        if (prefix === '') {
+            return '';
+        }
+
+        return joined + '/' + prefix;
+    }, '');
+};