@apolitical/server 2.7.0-rc.2 → 2.7.0-rc.3

package/CHANGELOG.md

@@ -8,6 +8,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ## [2.7.0] - 2022-08-22
 ### Added
 - Strict routing parameter to allow treating "/foo" and "/foo/" as different
+- New `buildQueryString` function to the `request` helper 
 
 ## [2.6.0] - 2022-07-25
 ### Updated

package/README.md

@@ -27,10 +27,10 @@ This section covers how to use most of the functionally exposed by the __Apoliti
 First of all, include the __Apolitical Server__:
 
 ```js
-const { start, stop, jwt, errors, middlewares } = require('@apolitical/server');
+const { start, stop, jwt, errors, middlewares, request } = require('@apolitical/server');
 ```
 
-Bear in mind, the `start`, `stop`, `jwt`, `errors` and `middlewares` variables will be used and explained in the examples listed below.
+Bear in mind, the `start`, `stop`, `jwt`, `errors`, `middlewares`, `request` variables will be used and explained in the examples listed below.
 
 ### Quickstart
 
@@ -249,14 +249,15 @@ The `swaggerDocument` variable can be provided when starting the server to defin
 
 For usage examples, see [jwt.apolitical.spec.js](tests/../test/integration/jwt.apolitical.spec.js) test cases.
 
-### Options helper
+### Request Helper
 
-The __Apolitical Server__ comes with an optsHelper function that can be used to generate an apolitical_auth header cookie when needed. This functionality is especially useful to generate an admin token when making request from one api to another.
+The __Apolitical Server__ comes with a request helper functions.
 
-```js
+One of those functions is `buildOptions` that can be used to generate an `apolitical_auth` header cookie when needed. This functionality is especially useful to generate an admin token when making request from one api to another.
 
+```js
 // Instantiate the hellper with a session secret
-const { buildOptions } = optsHelper({ sessionSecret: 'hello' });
+const { buildOptions } = request({ sessionSecret: 'hello' });
 
 // If generating an admin token: authToken must be truthy boolean
 buildOptions({ headers: { authToken: true }})
@@ -265,3 +266,11 @@ buildOptions({ headers: { authToken: true }})
 buildOptions({ headers: { authToken: 'some-token' }})
 ```
 
+Also, you can use `buildQueryString` to stringify a query variable from a valid Express `req.query` object:
+
+```js
+const { buildQueryString } = request({});
+
+// Build query string from request query object
+const queryString = buildQueryString(req.query);
+```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@apolitical/server",
-  "version": "2.7.0-rc.2",
+  "version": "2.7.0-rc.3",
   "description": "Node.js module to encapsulate Apolitical's express server setup",
   "author": "Apolitical Group Limited <engineering@apolitical.co>",
   "license": "MIT",
@@ -44,6 +44,7 @@
     "passport": "0.6.0",
     "passport-jwt": "4.0.0",
     "prerender-node": "3.5.0",
+    "qs": "6.11.0",
     "swagger-ui-express": "4.4.0"
   },
   "devDependencies": {

package/src/container.js

@@ -19,6 +19,7 @@ const morgan = require('morgan');
 const passport = require('passport');
 const passportJwt = require('passport-jwt');
 const prerender = require('prerender-node');
+const qs = require('qs');
 const swaggerUi = require('swagger-ui-express');
 // Internal Modules
 const apoliticalLogger = require('@apolitical/logger');
@@ -33,7 +34,7 @@ const jwtDecodeHelper = require('./helpers/jwt/decode.helper');
 const jwtEncodeHelper = require('./helpers/jwt/encode.helper');
 const jwtPassportHelper = require('./helpers/jwt/passport.helper');
 const loggerHelper = require('./helpers/logger.helper');
-const optsHelper = require('./helpers/opts.helper');
+const requestHelper = require('./helpers/request.helper');
 // Loaders
 const documentationLoader = require('./loaders/documentation.loader');
 const expressLoader = require('./loaders/express.loader');
@@ -74,6 +75,7 @@ container.register({
   passport: asValue(passport),
   passportJwt: asValue(passportJwt),
   prerender: asValue(prerender),
+  qs: asValue(qs),
   swaggerUi: asValue(swaggerUi),
   // Internal Modules
   apoliticalLogger: asValue(apoliticalLogger),
@@ -88,7 +90,7 @@ container.register({
   jwtEncodeHelper: asFunction(jwtEncodeHelper).singleton(),
   jwtPassportHelper: asFunction(jwtPassportHelper).singleton(),
   loggerHelper: asFunction(loggerHelper).singleton(),
-  optsHelper: asFunction(optsHelper).singleton(),
+  requestHelper: asFunction(requestHelper).singleton(),
   // Loaders
   documentationLoader: asFunction(documentationLoader).singleton(),
   expressLoader: asFunction(expressLoader).singleton(),

package/src/helpers/{opts.helper.js → request.helper.js}

@@ -1,7 +1,7 @@
 'use strict';
 
 module.exports =
-  ({ jwtEncodeHelper, config }) =>
+  ({ qs, jwtEncodeHelper, config }) =>
   ({ sessionSecret }) => {
     const {
       APOLITICAL: { ISSUER, ADMIN_ROLE, COOKIE_KEY },
@@ -47,5 +47,10 @@ module.exports =
       return opts;
     }
 
-    return { buildOptions };
+    function buildQueryString({ query = {} } = {}) {
+      const queryString = qs.stringify(query);
+      return queryString ? `?${queryString}` : '';
+    }
+
+    return { buildOptions, buildQueryString };
   };

package/src/services/server.service.js

@@ -7,7 +7,7 @@ module.exports = ({
   healthService: { registerShutdown },
   jwtService,
   serverError,
-  optsHelper,
+  requestHelper,
 }) => {
   // Register shutdown to clean up any resources used by the express app
   registerShutdown(shutdown);
@@ -21,6 +21,6 @@ module.exports = ({
       authentication: authenticationMiddleware,
       authorisation: authorisationMiddleware,
     },
-    request: optsHelper,
+    request: requestHelper,
   };
 };