@apolitical/server 2.5.2-rc.1 → 2.5.4-beta.1

package/CHANGELOG.md

@@ -5,6 +5,14 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [2.5.4] - 2022-07-08
+### Added
+- Generating apolitical-auth token function
+
+## [2.5.3] - 2022-06-29
+### Changed
+- Pipelines ref
+
 ## [2.5.2] - 2022-06-08
 ### Added
 - Probes prefix to support custom path

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@apolitical/server",
-  "version": "2.5.2-rc.1",
+  "version": "2.5.4-beta.1",
   "description": "Node.js module to encapsulate Apolitical's express server setup",
   "author": "Apolitical Group Limited <engineering@apolitical.co>",
   "license": "MIT",

package/src/config.js

@@ -1,6 +1,6 @@
 'use strict';
 
-const { NODE_ENV, LOG_LEVEL } = process.env;
+const { NODE_ENV, LOG_LEVEL, SESSION_SECRET } = process.env;
 
 const NAME = 'apolitical-server';
 const VERSION = '2.5.0';
@@ -9,6 +9,7 @@ const ADMIN_ROLE = 'administrator';
 module.exports = {
   NODE_ENV,
   LOG_LEVEL,
+  SESSION_SECRET,
   LOGGER_OPTIONS: {
     logLevel: LOG_LEVEL,
     labels: {
@@ -69,6 +70,8 @@ module.exports = {
       COOKIE_KEY: 'apolitical_auth',
       NAME: 'jwt',
       SESSION: { session: false },
+      ADMIN_ROLE,
+      ISSUER: NAME,
     },
     AUTH0: {
       CACHE: true,

package/src/container.js

@@ -33,6 +33,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');
 // Loaders
 const documentationLoader = require('./loaders/documentation.loader');
 const expressLoader = require('./loaders/express.loader');
@@ -87,6 +88,7 @@ container.register({
   jwtEncodeHelper: asFunction(jwtEncodeHelper).singleton(),
   jwtPassportHelper: asFunction(jwtPassportHelper).singleton(),
   loggerHelper: asFunction(loggerHelper).singleton(),
+  optsHelper: asFunction(optsHelper).singleton(),
   // Loaders
   documentationLoader: asFunction(documentationLoader).singleton(),
   expressLoader: asFunction(expressLoader).singleton(),

package/src/helpers/opts.helper.js

@@ -0,0 +1,50 @@
+'use strict';
+
+module.exports = ({ jwtEncodeHelper, config }) => {
+  const { SESSION_SECRET } = config.SERVER;
+  const {
+    APOLITICAL: { ISSUER, ADMIN_ROLE, COOKIE_KEY },
+  } = config.JWT;
+
+  function generateAdminToken() {
+    const token = jwtEncodeHelper(SESSION_SECRET, {
+      role: ADMIN_ROLE,
+      admin: true,
+      iss: ISSUER,
+      exp: Math.floor(Date.now() / 1000) + 90 * 24 * 3600,
+    });
+    return token;
+  }
+
+  function buildHeaders({ authToken }) {
+    const headers = {};
+    if (typeof authToken === 'boolean' && authToken) {
+      // When authToken is a boolean then generate an admin token
+      const adminToken = generateAdminToken();
+      Object.assign(headers, { Cookie: `${COOKIE_KEY}=${adminToken}` });
+    } else if (typeof authToken === 'string' && authToken) {
+      // When authToken is a string then use the it as the token
+      Object.assign(headers, { Cookie: `${COOKIE_KEY}=${authToken}` });
+    }
+    return headers;
+  }
+
+  function buildOptions({ headers, params, validateStatus, data }) {
+    const opts = {};
+    if (headers) {
+      Object.assign(opts, { headers: buildHeaders(headers) });
+    }
+    if (params) {
+      Object.assign(opts, { params });
+    }
+    if (validateStatus) {
+      Object.assign(opts, { validateStatus });
+    }
+    if (data) {
+      Object.assign(opts, { data });
+    }
+    return opts;
+  }
+
+  return buildOptions;
+};

package/src/services/server.service.js

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