@ministryofjustice/hmpps-connect-dps-components 2.0.0-beta → 2.1.0

package/README.md

@@ -1,25 +1,27 @@
 # hmpps-connect-dps-components
 
 `hmpps-connect-dps-components` is a Node.js client library to simplify the process of incorporating global components 
-within DPS applications.
+within DPS applications. We welcome feedback on this README [here](https://moj.enterprise.slack.com/archives/C04JFG3QJE6)
+in order to improve it.
 
 ## Contents
 
-1. [Publishing to NPM](readme/publishing.md)
+1. [Using the library](#using-the-library)
+2. [For library developers](#for-library-developers)
 
 
-## Implementation
+## Using the library
 
-## Prerequisites
+### Prerequisites
 
 The package assumes adherance to the standard [hmpps-template-typescript](https://github.com/ministryofjustice/hmpps-template-typescript) project.
 It requires:
  - a user object to be available on `res.locals` containing a token, displayName, and authSource.
  - nunjucks to be setup
  - an environment variable to be set for the micro frontend components api called `COMPONENT_API_URL`
- - to be run after helmet middleware
+ - to be run AFTER helmet middleware
 
-## Installation
+### Installation
 
 To install the package, run the following command:
 
@@ -27,13 +29,17 @@ To install the package, run the following command:
 npm install @ministryofjustice/hmpps-connect-dps-components
 ```
 
-## Usage
+### Usage
 
 Currently, the package provides the header and the footer component.
 
-To incorporate use as middleware for appropriate routes within your Express application:
+To incorporate use the middleware for appropriate routes within your Express application:
 
 ```javascript
+    import dpsComponents from '@ministryofjustice/hmpps-connect-dps-components'
+
+    ...
+
     app.use(dpsComponents.getPageComponents({
       dpsUrl: config.serviceUrls.digitalPrison,
       logger,
@@ -55,8 +61,9 @@ It may be sufficient for you app to only request components for GET requests for
 
 may be more appropriate, especially if you use the [PRG pattern](https://en.wikipedia.org/wiki/Post/Redirect/Get) to
 handle form submission. This will help us to reduce the load on the micro frontend components API. You may wish to
-go even further, for example avoiding `GET /api...` routes that don't need components - the Prisoner Profile does
-something like this:
+go even further, for example avoiding routes that don't need components - the Prisoner Profile does
+something like this to avoid the component API call for the following routes: `/api` (provides prisoner images) and `/` 
+(a redirect only route).
 
 ```javascript
     app.get(
@@ -71,8 +78,6 @@ something like this:
     )
 ```
 
-require the components, in which case you should be more specific about which to apply the middleware to. 
-
 There are a [number of options](./src/index.ts) available depending on your requirements.
 
 Add the `hmpps-connect-dps-components` path to the nunjucksSetup.ts file to enable css to be loaded:
@@ -122,7 +127,7 @@ Include reference to the components in your layout.njk file:
 {% endblock %}
 ```
 
-## Extra calls
+### Extra calls
 
 It may be that you need to add some extra requests for the page components for pages that do not fit the normal flow 
 of routes. e.g. in `setUpAuthentication.ts` on the `/autherror` path:
@@ -140,12 +145,12 @@ of routes. e.g. in `setUpAuthentication.ts` on the `/autherror` path:
 
 This will provide a stripped down header for if there is no user object on `res.locals`.
 
-## CSP
+### CSP
 
 The package updates the content-security-middleware to include references to the fe-components API. This package should 
 be run after Helmet to prevent this being overwritten.
 
-## Shared Data 
+### Shared Data 
 
 An optional parameter `includeSharedData: true` can be passed into the `get` method. Setting this will result in a 
 `sharedData` object being added to `res.locals.feComponents` containing data the components have collected to render. 
@@ -158,7 +163,7 @@ This includes:
 This can be useful e.g. for when your service needs access to activeCaseLoad information to prevent extra calls to the 
 api and takes advantage of the caching that the micro frontend api does.
 
-## Populating res.locals.user with the shared case load data
+### Populating res.locals.user with the shared case load data
 
 Many services typically add case load information to the user object on `res.locals`. This library provides some 
 optional middleware which populates:
@@ -178,8 +183,16 @@ app.use(dpsComponents.retrieveCaseLoadData({ logger }))
 
 Again there are a [number of options](./src/index.ts) available depending on your requirements.
 
-## Note
+This middleware checks the `res.locals.user.authSource` so ensure that any mock auth data used in tests includes 
+`auth_source: 'nomis'` in the response.
+
+### Note
 
 In the event of a failure to retrieve the components, the package will populate the html fields with fallback components.
 The `feComponents.sharedData` will not be populated, but if you use the retrieveCaseLoadData middleware (see above) it 
-will either take case load data from the cache or make a call to the Prison API to retrieve it.  
+will either take case load data from the cache or make a call to the Prison API to retrieve it.  
+
+
+## For library developers:
+
+1. [Publishing to NPM](readme/publishing.md)

package/dist/componentsService.js

@@ -10,21 +10,30 @@ const defaultOptions = {
     logger: console,
     timeoutOptions: { response: 2500, deadline: 2500 },
     includeSharedData: false,
+    useFallbacksByDefault: false,
 };
 function getFrontendComponents(requestOptions) {
-    const { logger, timeoutOptions, includeSharedData } = {
+    const { logger, timeoutOptions, includeSharedData, useFallbacksByDefault } = {
         ...defaultOptions,
         ...requestOptions,
     };
     return async (_req, res, next) => {
-        if (!res.locals.user) {
-            logger.info('Using logged out user header');
+        const useFallbacks = (user) => {
             res.locals.feComponents = {
-                header: (0, fallbacks_1.getFallbackHeader)(null, requestOptions),
-                footer: (0, fallbacks_1.getFallbackFooter)(null, requestOptions),
+                header: (0, fallbacks_1.getFallbackHeader)(user, requestOptions),
+                footer: (0, fallbacks_1.getFallbackFooter)(user, requestOptions),
                 cssIncludes: [],
                 jsIncludes: [],
             };
+        };
+        if (!res.locals.user) {
+            logger.info('Using fallback frontend components when no user in context');
+            useFallbacks(null);
+            return next();
+        }
+        if (useFallbacksByDefault) {
+            logger.info('Using fallback frontend components by default');
+            useFallbacks(res.locals.user);
             return next();
         }
         try {
@@ -43,12 +52,7 @@ function getFrontendComponents(requestOptions) {
         }
         catch (error) {
             logger.error('Failed to retrieve front end components, using fallbacks');
-            res.locals.feComponents = {
-                header: (0, fallbacks_1.getFallbackHeader)(res.locals.user, requestOptions),
-                footer: (0, fallbacks_1.getFallbackFooter)(res.locals.user, requestOptions),
-                cssIncludes: [],
-                jsIncludes: [],
-            };
+            useFallbacks(res.locals.user);
             return next();
         }
     };

package/dist/componentsService.js.map

@@ -1 +1 @@
-{"version":3,"file":"componentsService.js","sourceRoot":"","sources":["../src/componentsService.ts"],"names":[],"mappings":";;;;;AACA,gGAAuE;AACvE,iDAAwE;AAExE,kEAAyC;AAKzC,MAAM,cAAc,GAA4B;IAC9C,MAAM,EAAE,OAAO;IACf,cAAc,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE;IAClD,iBAAiB,EAAE,KAAK;CACzB,CAAA;AAED,SAAwB,qBAAqB,CAAC,cAA+B;IAC3E,MAAM,EAAE,MAAM,EAAE,cAAc,EAAE,iBAAiB,EAAE,GAAG;QACpD,GAAG,cAAc;QACjB,GAAG,cAAc;KAClB,CAAA;IAED,OAAO,KAAK,EAAE,IAAI,EAAE,GAAG,EAAE,IAAI,EAAE,EAAE;QAC/B,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC;YACrB,MAAM,CAAC,IAAI,CAAC,8BAA8B,CAAC,CAAA;YAC3C,GAAG,CAAC,MAAM,CAAC,YAAY,GAAG;gBACxB,MAAM,EAAE,IAAA,6BAAiB,EAAC,IAAI,EAAE,cAAc,CAAC;gBAC/C,MAAM,EAAE,IAAA,6BAAiB,EAAC,IAAI,EAAE,cAAc,CAAC;gBAC/C,WAAW,EAAE,EAAE;gBACf,UAAU,EAAE,EAAE;aACf,CAAA;YACD,OAAO,IAAI,EAAE,CAAA;QACf,CAAC;QAED,IAAI,CAAC;YACH,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,4BAAkB,CAAC,aAAa,CACrE,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,EACrB,cAAc,EACd,MAAM,CACP,CAAA;YAED,GAAG,CAAC,MAAM,CAAC,YAAY,GAAG;gBACxB,MAAM,EAAE,MAAM,CAAC,IAAI;gBACnB,MAAM,EAAE,MAAM,CAAC,IAAI;gBACnB,WAAW,EAAE,CAAC,GAAG,MAAM,CAAC,GAAG,EAAE,GAAG,MAAM,CAAC,GAAG,CAAC;gBAC3C,UAAU,EAAE,CAAC,GAAG,MAAM,CAAC,UAAU,EAAE,GAAG,MAAM,CAAC,UAAU,CAAC;aACzD,CAAA;YAED,IAAI,iBAAiB,EAAE,CAAC;gBACtB,GAAG,CAAC,MAAM,CAAC,YAAY,CAAC,UAAU,GAAG,IAAI,CAAA;YAC3C,CAAC;YAED,IAAA,mBAAS,EAAC,GAAG,CAAC,CAAA;YAEd,OAAO,IAAI,EAAE,CAAA;QACf,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,CAAC,KAAK,CAAC,0DAA0D,CAAC,CAAA;YAExE,GAAG,CAAC,MAAM,CAAC,YAAY,GAAG;gBACxB,MAAM,EAAE,IAAA,6BAAiB,EAAC,GAAG,CAAC,MAAM,CAAC,IAAI,EAAE,cAAc,CAAC;gBAC1D,MAAM,EAAE,IAAA,6BAAiB,EAAC,GAAG,CAAC,MAAM,CAAC,IAAI,EAAE,cAAc,CAAC;gBAC1D,WAAW,EAAE,EAAE;gBACf,UAAU,EAAE,EAAE;aACf,CAAA;YAED,OAAO,IAAI,EAAE,CAAA;QACf,CAAC;IACH,CAAC,CAAA;AACH,CAAC;AApDD,wCAoDC"}
+{"version":3,"file":"componentsService.js","sourceRoot":"","sources":["../src/componentsService.ts"],"names":[],"mappings":";;;;;AACA,gGAAuE;AACvE,iDAAwE;AAExE,kEAAyC;AAGzC,MAAM,cAAc,GAA4B;IAC9C,MAAM,EAAE,OAAO;IACf,cAAc,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE;IAClD,iBAAiB,EAAE,KAAK;IACxB,qBAAqB,EAAE,KAAK;CAC7B,CAAA;AAED,SAAwB,qBAAqB,CAAC,cAA+B;IAC3E,MAAM,EAAE,MAAM,EAAE,cAAc,EAAE,iBAAiB,EAAE,qBAAqB,EAAE,GAAG;QAC3E,GAAG,cAAc;QACjB,GAAG,cAAc;KAClB,CAAA;IAED,OAAO,KAAK,EAAE,IAAI,EAAE,GAAG,EAAE,IAAI,EAAE,EAAE;QAC/B,MAAM,YAAY,GAAG,CAAC,IAAe,EAAE,EAAE;YACvC,GAAG,CAAC,MAAM,CAAC,YAAY,GAAG;gBACxB,MAAM,EAAE,IAAA,6BAAiB,EAAC,IAAI,EAAE,cAAc,CAAC;gBAC/C,MAAM,EAAE,IAAA,6BAAiB,EAAC,IAAI,EAAE,cAAc,CAAC;gBAC/C,WAAW,EAAE,EAAE;gBACf,UAAU,EAAE,EAAE;aACf,CAAA;QACH,CAAC,CAAA;QAED,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC;YACrB,MAAM,CAAC,IAAI,CAAC,4DAA4D,CAAC,CAAA;YACzE,YAAY,CAAC,IAAI,CAAC,CAAA;YAClB,OAAO,IAAI,EAAE,CAAA;QACf,CAAC;QAED,IAAI,qBAAqB,EAAE,CAAC;YAC1B,MAAM,CAAC,IAAI,CAAC,+CAA+C,CAAC,CAAA;YAC5D,YAAY,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,CAAA;YAC7B,OAAO,IAAI,EAAE,CAAA;QACf,CAAC;QAED,IAAI,CAAC;YACH,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,4BAAkB,CAAC,aAAa,CACrE,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,EACrB,cAAc,EACd,MAAM,CACP,CAAA;YAED,GAAG,CAAC,MAAM,CAAC,YAAY,GAAG;gBACxB,MAAM,EAAE,MAAM,CAAC,IAAI;gBACnB,MAAM,EAAE,MAAM,CAAC,IAAI;gBACnB,WAAW,EAAE,CAAC,GAAG,MAAM,CAAC,GAAG,EAAE,GAAG,MAAM,CAAC,GAAG,CAAC;gBAC3C,UAAU,EAAE,CAAC,GAAG,MAAM,CAAC,UAAU,EAAE,GAAG,MAAM,CAAC,UAAU,CAAC;aACzD,CAAA;YAED,IAAI,iBAAiB,EAAE,CAAC;gBACtB,GAAG,CAAC,MAAM,CAAC,YAAY,CAAC,UAAU,GAAG,IAAI,CAAA;YAC3C,CAAC;YAED,IAAA,mBAAS,EAAC,GAAG,CAAC,CAAA;YAEd,OAAO,IAAI,EAAE,CAAA;QACf,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,CAAC,KAAK,CAAC,0DAA0D,CAAC,CAAA;YACxE,YAAY,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,CAAA;YAC7B,OAAO,IAAI,EAAE,CAAA;QACf,CAAC;IACH,CAAC,CAAA;AACH,CAAC;AAvDD,wCAuDC"}

package/dist/index.d.ts

@@ -16,6 +16,7 @@ declare const _default: {
      * @param requestOptions.logger - pass in the bunyen logger if you want to use it. Falls back to console if not provided
      * @param requestOptions.timeoutOptions - timeout object for superagent. Defaults to 2500ms
      * @param requestOptions.includeSharedData - adds sharedData to res.locals.feComponents if true. Contains data that the components have collected in order to render, including: activeCaseLoad, caseLoads and available services for user
+     * @param requestOptions.useFallbacksByDefault - if your service requires only the basic fallback header and footer to be used by default, set this to true, it will not attempt to fetch the components from the frontend components service
      */
     getPageComponents: typeof getPageComponents;
     /**

package/dist/index.js

@@ -21,6 +21,7 @@ exports.default = {
      * @param requestOptions.logger - pass in the bunyen logger if you want to use it. Falls back to console if not provided
      * @param requestOptions.timeoutOptions - timeout object for superagent. Defaults to 2500ms
      * @param requestOptions.includeSharedData - adds sharedData to res.locals.feComponents if true. Contains data that the components have collected in order to render, including: activeCaseLoad, caseLoads and available services for user
+     * @param requestOptions.useFallbacksByDefault - if your service requires only the basic fallback header and footer to be used by default, set this to true, it will not attempt to fetch the components from the frontend components service
      */
     getPageComponents: componentsService_1.default,
     /**

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;AAAA,4EAAmD;AACnD,wEAAoD;AAEpD,kBAAe;IACb;;;;;;;;;;;;;;;OAeG;IACH,iBAAiB,EAAjB,2BAAiB;IAEjB;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,oBAAoB,EAApB,yBAAoB;CACrB,CAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;AAAA,4EAAmD;AACnD,wEAAoD;AAEpD,kBAAe;IACb;;;;;;;;;;;;;;;;OAgBG;IACH,iBAAiB,EAAjB,2BAAiB;IAEjB;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,oBAAoB,EAApB,yBAAoB;CACrB,CAAA"}

package/dist/types/RequestOptions.d.ts

@@ -7,5 +7,6 @@ export default interface RequestOptions {
     environmentName?: 'DEV' | 'PRE-PRODUCTION' | 'PRODUCTION';
     logger?: bunyan | typeof console;
     includeSharedData?: boolean;
+    useFallbacksByDefault?: boolean;
     timeoutOptions?: TimeoutOptions;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ministryofjustice/hmpps-connect-dps-components",
-  "version": "2.0.0-beta",
+  "version": "2.1.0",
   "description": "A package to allow the inclusion of connect dps micro frontend components within dps applications",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",