tom-microservice 3.7.1 → 3.9.0

package/README.md

@@ -62,6 +62,10 @@ To view details for a command at any time use `tom --help`
 
 ### from Node.js
 
+#### as process
+
+You can interact with **tom** 🐶 from Node.js user code:
+
 ```js
 // First of all you need to declare a configuration file.
 const config = {/* See configuration section */}
@@ -73,6 +77,37 @@ const tom = require('tom-microservice')(config)
 const { payment, email } = tom
 ```
 
+#### as HTTP router
+
+Additionally, you can get the **tom** 🐶 HTTP router in standalone way:
+
+```js
+const { createRoutes } = require('tom-microservice')
+const config = {/* See configuration section */}
+
+const router = createRoutes(config, ({ tom, router, send }) => {
+  router
+    .get('/ping', (req, res) => send(res, 200, 'healthy'))
+})
+```
+
+#### as HTTP server
+
+You can also intialize **tom** 🐶 HTTP server from code:
+
+```js
+const { listen, createRoutes } = require('tom-microservice')
+
+const config = {/* See configuration section */}
+
+const router = createRoutes(config, ({ tom, router, send }) => {
+  router
+    .get('/ping', (req, res) => send(res, 200, 'healthy'))
+})
+
+listen(config, { routes })
+```
+
 ## Configuration
 
 !> Combine with [miconfig](https://www.npmjs.com/package/miconfig) for loading different settings based on environment.
@@ -431,7 +466,7 @@ See [cors](https://github.com/expressjs/cors#configuration-options) for more inf
 Type: `string` </br>
 Default: `undefined`
 
-When you provide it, all request to **tom** 🐶 needs to be authenticated using `x-api-key` header and the value provided.
+When you provide it, all request to **tom** 🐶 needs to be authenticated using `req.headers[`x-api-key`] or `req.query.apiKey` and the value provided.
 
 You can use [randomkeygen.com](https://randomkeygen.com) for that.
 

package/bin/listen.js

@@ -7,8 +7,9 @@ const { createServer } = require('http')
 const PORT =
   process.env.PORT || process.env.port || process.env.TOM_PORT || 3000
 
-module.exports = async (tomConfig, { port = PORT } = {}) => {
-  const routes = require('../src/routes')(tomConfig)
+module.exports = async (tomConfig, { port = PORT, routes } = {}) => {
+  if (!routes) routes = require('../src/routes')(tomConfig)
+
   const server = createServer(routes)
 
   server.listen(port, () => {

package/package.json

@@ -2,7 +2,7 @@
   "name": "tom-microservice",
   "description": "Tom creates customers, subscriptions plans & send notifications.",
   "homepage": "https://tom.js.org",
-  "version": "3.7.1",
+  "version": "3.9.0",
   "main": "src",
   "bin": {
     "tom": "bin/index.js"

package/src/routes.js

@@ -1,6 +1,6 @@
 'use strict'
 
-const { get, eq, forEach } = require('lodash')
+const { eq, forEach, noop } = require('lodash')
 const { buffer, text } = require('http-body')
 const requestIp = require('request-ip')
 const toQuery = require('to-query')()
@@ -78,7 +78,8 @@ const createRouter = () => {
   if (TOM_API_KEY) {
     router.use((req, res, next) => {
       if (UNAUTHENTICATED_PATHS.includes(req.path)) return next()
-      const apiKey = get(req, 'headers.x-api-key')
+      const apiKey = req.headers['x-api-key'] ?? req.query.apiKey
+
       return eq(apiKey, TOM_API_KEY)
         ? next()
         : send.fail(
@@ -92,15 +93,15 @@ const createRouter = () => {
   }
 
   router
-    .get('/', (req, res) => send(res, 204))
-    .get('/robots.txt', (req, res) => send(res, 204))
-    .get('/favicon.ico', (req, res) => send(res, 204))
-    .get('/ping', (req, res) => send(res, 200, 'pong'))
+    .get('/', (_, res) => send(res, 204))
+    .get('/robots.txt', (_, res) => send(res, 204))
+    .get('/favicon.ico', (_, res) => send(res, 204))
+    .get('/ping', (_, res) => send(res, 200, 'pong'))
 
   return router
 }
 
-module.exports = tomConfig => {
+module.exports = (tomConfig, fn = noop) => {
   if (!tomConfig) throw TypeError('You need to provide tom configuration file.')
 
   const router = createRouter()
@@ -116,5 +117,7 @@ module.exports = tomConfig => {
     })
   })
 
+  fn({ tom, router, send })
+
   return router
 }