@ministryofjustice/hmpps-connect-dps-components 2.0.0 → 2.2.0

package/README.md

@@ -159,6 +159,7 @@ This includes:
 - activeCaseLoad (the active caseload of the user)
 - caseLoads (all caseloads the user has access to)
 - services (information on services the user has access to used for global navigation)
+- allocationJobResponsibilities (the allocation policy codes the user has the associated job responsibility for. Allocation policy codes are: `KEY_WORKER`, meaning the user is a key worker and `PERSONAL_OFFICER`, meaning the user is a personal officer.)
 
 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.
@@ -170,7 +171,7 @@ optional middleware which populates:
 - `res.locals.user.caseLoads` with all case loads the user has access to
 - `res.locals.user.activeCaseLoad` with the active case load of the user
 - `res.locals.user.activeCaseLoadId` with the id of the active case load
- 
+
 It uses the `sharedData` object if it is present and caches in `req.session` so that any subsequent routes that do not 
 use the component middleware can still use the data. If there is no data in the cache, it will fall back to making a 
 call to Prison API to retrieve the data using the user token.
@@ -186,6 +187,30 @@ Again there are a [number of options](./src/index.ts) available depending on you
 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.
 
+### Populating res.locals.user with the shared allocation job responsibilities
+
+This library also provides an optional middleware which populates:
+- `res.locals.user.allocationJobResponsibilities` the allocation policy codes the user has the associated job responsibility for. Allocation policy codes are: `KEY_WORKER`, meaning the user is a key worker and `PERSONAL_OFFICER`, meaning the user is a personal officer.
+
+Similar to shared case load data, it uses the `sharedData` object if it is present and caches in `req.session` so that any subsequent routes that do not
+use the component middleware can still use the data. If there is no data in the cache, it will fall back to making a
+call to Allocations API to retrieve the data using the user token.
+
+To enable this, add the middleware after the component middleware as follows:
+
+```javascript
+app.use(dpsComponents.retrieveAllocationJobResponsibilities({ logger }))
+```
+
+This should go after `dpsComponents.retrieveCaseLoadData` so that `res.locals.user.activeCaseLoadId` will be populated.
+It also requires `ALLOCATIONS_API_URL` to be configured in the environment variables.
+
+Again there are a [number of options](./src/index.ts) available depending on your requirements.
+
+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. It also checks the `res.locals.user.activeCaseLoadId`, which is required for retrieving allocation job responsibilities.
+
+
 ### Note
 
 In the event of a failure to retrieve the components, the package will populate the html fields with fallback components.

package/dist/allocationService.d.ts

@@ -0,0 +1,3 @@
+import { type RequestHandler } from 'express';
+import CaseLoadOptions from './types/CaseLoadOptions';
+export default function retrieveAllocationJobResponsibilities(options?: CaseLoadOptions): RequestHandler;

package/dist/allocationService.js

@@ -0,0 +1,48 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const allocationsApiClient_1 = __importDefault(require("./data/allocationsApi/allocationsApiClient"));
+const config_1 = __importDefault(require("./config"));
+const defaultOptions = {
+    logger: console,
+    timeoutOptions: { response: 2500, deadline: 2500 },
+};
+function retrieveAllocationJobResponsibilities(options) {
+    const { logger, timeoutOptions } = {
+        ...defaultOptions,
+        ...options,
+    };
+    if (!config_1.default.apis.allocationsApi.url)
+        throw new Error('Environment variable ALLOCATIONS_API_URL must be defined for this middleware to work correctly');
+    return async (req, res, next) => {
+        if (!req.session)
+            throw new Error('User session required in order to cache allocation job responsibilities');
+        if (!res.locals.user.token)
+            throw new Error('Caseload details needs to be populated before retrieving allocation job responsibilities. Please run retrieveCaseLoadData before retrieveAllocationJobResponsibilities.');
+        if (res.locals.user && res.locals.user.authSource === 'nomis') {
+            try {
+                // Update cache with values from res.feComponents.sharedData if present
+                if (res.locals.feComponents && res.locals.feComponents.sharedData) {
+                    req.session.allocationJobResponsibilities = res.locals.feComponents.sharedData.allocationJobResponsibilities;
+                }
+                // If cache is empty, fetch data from Prison API
+                if (!req.session.allocationJobResponsibilities) {
+                    logger.info(`Falling back to Allocations API to retrieve job responsibilities for: ${res.locals.user.username}`);
+                    const allocationPolicies = await allocationsApiClient_1.default.getStaffAllocationPolicies(res.locals.user, timeoutOptions, logger);
+                    req.session.allocationJobResponsibilities = allocationPolicies.policies;
+                }
+                // Populate res.locals.user with values from cache
+                res.locals.user.allocationJobResponsibilities = req.session.allocationJobResponsibilities;
+            }
+            catch (error) {
+                logger.error(error, `Failed to retrieve allocation job responsibilities for: ${res.locals.user.username}`);
+                return next(error);
+            }
+        }
+        return next();
+    };
+}
+exports.default = retrieveAllocationJobResponsibilities;
+//# sourceMappingURL=allocationService.js.map

package/dist/allocationService.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"allocationService.js","sourceRoot":"","sources":["../src/allocationService.ts"],"names":[],"mappings":";;;;;AAEA,sGAA6E;AAC7E,sDAA6B;AAE7B,MAAM,cAAc,GAAoB;IACtC,MAAM,EAAE,OAAO;IACf,cAAc,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE;CACnD,CAAA;AAED,SAAwB,qCAAqC,CAAC,OAAyB;IACrF,MAAM,EAAE,MAAM,EAAE,cAAc,EAAE,GAAG;QACjC,GAAG,cAAc;QACjB,GAAG,OAAO;KACX,CAAA;IAED,IAAI,CAAC,gBAAM,CAAC,IAAI,CAAC,cAAc,CAAC,GAAG;QACjC,MAAM,IAAI,KAAK,CAAC,gGAAgG,CAAC,CAAA;IAEnH,OAAO,KAAK,EAAE,GAAG,EAAE,GAAG,EAAE,IAAI,EAAE,EAAE;QAC9B,IAAI,CAAC,GAAG,CAAC,OAAO;YAAE,MAAM,IAAI,KAAK,CAAC,yEAAyE,CAAC,CAAA;QAC5G,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK;YACxB,MAAM,IAAI,KAAK,CACb,yKAAyK,CAC1K,CAAA;QAEH,IAAI,GAAG,CAAC,MAAM,CAAC,IAAI,IAAI,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,UAAU,KAAK,OAAO,EAAE,CAAC;YAC9D,IAAI,CAAC;gBACH,uEAAuE;gBACvE,IAAI,GAAG,CAAC,MAAM,CAAC,YAAY,IAAI,GAAG,CAAC,MAAM,CAAC,YAAY,CAAC,UAAU,EAAE,CAAC;oBAClE,GAAG,CAAC,OAAO,CAAC,6BAA6B,GAAG,GAAG,CAAC,MAAM,CAAC,YAAY,CAAC,UAAU,CAAC,6BAA6B,CAAA;gBAC9G,CAAC;gBAED,gDAAgD;gBAChD,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,6BAA6B,EAAE,CAAC;oBAC/C,MAAM,CAAC,IAAI,CACT,yEAAyE,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,EAAE,CACpG,CAAA;oBACD,MAAM,kBAAkB,GAAG,MAAM,8BAAoB,CAAC,0BAA0B,CAC9E,GAAG,CAAC,MAAM,CAAC,IAAI,EACf,cAAc,EACd,MAAM,CACP,CAAA;oBACD,GAAG,CAAC,OAAO,CAAC,6BAA6B,GAAG,kBAAkB,CAAC,QAAQ,CAAA;gBACzE,CAAC;gBAED,kDAAkD;gBAClD,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,6BAA6B,GAAG,GAAG,CAAC,OAAO,CAAC,6BAA6B,CAAA;YAC3F,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,MAAM,CAAC,KAAK,CAAC,KAAK,EAAE,2DAA2D,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAA;gBAC1G,OAAO,IAAI,CAAC,KAAK,CAAC,CAAA;YACpB,CAAC;QACH,CAAC;QAED,OAAO,IAAI,EAAE,CAAA;IACf,CAAC,CAAA;AACH,CAAC;AA9CD,wDA8CC"}

package/dist/caseLoadService.js

@@ -4,6 +4,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 const prisonApiClient_1 = __importDefault(require("./data/prisonApi/prisonApiClient"));
+const config_1 = __importDefault(require("./config"));
 const defaultOptions = {
     logger: console,
     timeoutOptions: { response: 2500, deadline: 2500 },
@@ -13,6 +14,8 @@ function retrieveCaseLoadData(caseLoadOptions) {
         ...defaultOptions,
         ...caseLoadOptions,
     };
+    if (!config_1.default.apis.prisonApi.url)
+        throw new Error('Environment variable PRISON_API_URL must be defined for this middleware to work correctly');
     return async (req, res, next) => {
         var _a;
         if (!req.session)

package/dist/caseLoadService.js.map

@@ -1 +1 @@
-{"version":3,"file":"caseLoadService.js","sourceRoot":"","sources":["../src/caseLoadService.ts"],"names":[],"mappings":";;;;;AAGA,uFAA8D;AAE9D,MAAM,cAAc,GAAoB;IACtC,MAAM,EAAE,OAAO;IACf,cAAc,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE;CACnD,CAAA;AAED,SAAwB,oBAAoB,CAAC,eAAiC;IAC5E,MAAM,EAAE,MAAM,EAAE,cAAc,EAAE,GAAG;QACjC,GAAG,cAAc;QACjB,GAAG,eAAe;KACnB,CAAA;IAED,OAAO,KAAK,EAAE,GAAG,EAAE,GAAG,EAAE,IAAI,EAAE,EAAE;;QAC9B,IAAI,CAAC,GAAG,CAAC,OAAO;YAAE,MAAM,IAAI,KAAK,CAAC,oDAAoD,CAAC,CAAA;QAEvF,IAAI,GAAG,CAAC,MAAM,CAAC,IAAI,IAAI,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,UAAU,KAAK,OAAO,EAAE,CAAC;YAC9D,IAAI,CAAC;gBACH,uEAAuE;gBACvE,IAAI,GAAG,CAAC,MAAM,CAAC,YAAY,IAAI,GAAG,CAAC,MAAM,CAAC,YAAY,CAAC,UAAU,EAAE,CAAC;oBAClE,GAAG,CAAC,OAAO,CAAC,SAAS,GAAG,GAAG,CAAC,MAAM,CAAC,YAAY,CAAC,UAAU,CAAC,SAAS,CAAA;oBACpE,GAAG,CAAC,OAAO,CAAC,cAAc,GAAG,GAAG,CAAC,MAAM,CAAC,YAAY,CAAC,UAAU,CAAC,cAAc,CAAA;oBAC9E,GAAG,CAAC,OAAO,CAAC,gBAAgB,GAAG,MAAA,GAAG,CAAC,MAAM,CAAC,YAAY,CAAC,UAAU,CAAC,cAAc,0CAAE,UAAU,CAAA;gBAC9F,CAAC;gBAED,gDAAgD;gBAChD,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,SAAS,EAAE,CAAC;oBAC3B,MAAM,CAAC,IAAI,CAAC,0DAA0D,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAA;oBACjG,MAAM,aAAa,GAAG,MAAM,yBAAe,CAAC,gBAAgB,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,EAAE,cAAc,EAAE,MAAM,CAAC,CAAA;oBAC3G,MAAM,SAAS,GAAG,aAAa,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAC,QAAQ,CAAC,IAAI,KAAK,KAAK,CAAC,CAAA;oBAC3E,MAAM,cAAc,GAAG,SAAS,CAAC,IAAI,CAAC,CAAC,QAAkB,EAAE,EAAE,CAAC,QAAQ,CAAC,eAAe,CAAC,CAAA;oBAEvF,GAAG,CAAC,OAAO,CAAC,SAAS,GAAG,SAAS,CAAA;oBACjC,GAAG,CAAC,OAAO,CAAC,cAAc,GAAG,cAAc,CAAA;oBAC3C,GAAG,CAAC,OAAO,CAAC,gBAAgB,GAAG,cAAc,aAAd,cAAc,uBAAd,cAAc,CAAE,UAAU,CAAA;gBAC3D,CAAC;gBAED,kDAAkD;gBAClD,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,SAAS,GAAG,GAAG,CAAC,OAAO,CAAC,SAAS,CAAA;gBACjD,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,cAAc,GAAG,GAAG,CAAC,OAAO,CAAC,cAAc,CAAA;gBAC3D,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,gBAAgB,GAAG,GAAG,CAAC,OAAO,CAAC,gBAAgB,CAAA;YACjE,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,MAAM,CAAC,KAAK,CAAC,KAAK,EAAE,sCAAsC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAA;gBACrF,OAAO,IAAI,CAAC,KAAK,CAAC,CAAA;YACpB,CAAC;QACH,CAAC;QAED,OAAO,IAAI,EAAE,CAAA;IACf,CAAC,CAAA;AACH,CAAC;AA1CD,uCA0CC"}
+{"version":3,"file":"caseLoadService.js","sourceRoot":"","sources":["../src/caseLoadService.ts"],"names":[],"mappings":";;;;;AAGA,uFAA8D;AAC9D,sDAA6B;AAE7B,MAAM,cAAc,GAAoB;IACtC,MAAM,EAAE,OAAO;IACf,cAAc,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE;CACnD,CAAA;AAED,SAAwB,oBAAoB,CAAC,eAAiC;IAC5E,MAAM,EAAE,MAAM,EAAE,cAAc,EAAE,GAAG;QACjC,GAAG,cAAc;QACjB,GAAG,eAAe;KACnB,CAAA;IAED,IAAI,CAAC,gBAAM,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG;QAC5B,MAAM,IAAI,KAAK,CAAC,2FAA2F,CAAC,CAAA;IAE9G,OAAO,KAAK,EAAE,GAAG,EAAE,GAAG,EAAE,IAAI,EAAE,EAAE;;QAC9B,IAAI,CAAC,GAAG,CAAC,OAAO;YAAE,MAAM,IAAI,KAAK,CAAC,oDAAoD,CAAC,CAAA;QAEvF,IAAI,GAAG,CAAC,MAAM,CAAC,IAAI,IAAI,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,UAAU,KAAK,OAAO,EAAE,CAAC;YAC9D,IAAI,CAAC;gBACH,uEAAuE;gBACvE,IAAI,GAAG,CAAC,MAAM,CAAC,YAAY,IAAI,GAAG,CAAC,MAAM,CAAC,YAAY,CAAC,UAAU,EAAE,CAAC;oBAClE,GAAG,CAAC,OAAO,CAAC,SAAS,GAAG,GAAG,CAAC,MAAM,CAAC,YAAY,CAAC,UAAU,CAAC,SAAS,CAAA;oBACpE,GAAG,CAAC,OAAO,CAAC,cAAc,GAAG,GAAG,CAAC,MAAM,CAAC,YAAY,CAAC,UAAU,CAAC,cAAc,CAAA;oBAC9E,GAAG,CAAC,OAAO,CAAC,gBAAgB,GAAG,MAAA,GAAG,CAAC,MAAM,CAAC,YAAY,CAAC,UAAU,CAAC,cAAc,0CAAE,UAAU,CAAA;gBAC9F,CAAC;gBAED,gDAAgD;gBAChD,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,SAAS,EAAE,CAAC;oBAC3B,MAAM,CAAC,IAAI,CAAC,0DAA0D,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAA;oBACjG,MAAM,aAAa,GAAG,MAAM,yBAAe,CAAC,gBAAgB,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,EAAE,cAAc,EAAE,MAAM,CAAC,CAAA;oBAC3G,MAAM,SAAS,GAAG,aAAa,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAC,QAAQ,CAAC,IAAI,KAAK,KAAK,CAAC,CAAA;oBAC3E,MAAM,cAAc,GAAG,SAAS,CAAC,IAAI,CAAC,CAAC,QAAkB,EAAE,EAAE,CAAC,QAAQ,CAAC,eAAe,CAAC,CAAA;oBAEvF,GAAG,CAAC,OAAO,CAAC,SAAS,GAAG,SAAS,CAAA;oBACjC,GAAG,CAAC,OAAO,CAAC,cAAc,GAAG,cAAc,CAAA;oBAC3C,GAAG,CAAC,OAAO,CAAC,gBAAgB,GAAG,cAAc,aAAd,cAAc,uBAAd,cAAc,CAAE,UAAU,CAAA;gBAC3D,CAAC;gBAED,kDAAkD;gBAClD,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,SAAS,GAAG,GAAG,CAAC,OAAO,CAAC,SAAS,CAAA;gBACjD,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,cAAc,GAAG,GAAG,CAAC,OAAO,CAAC,cAAc,CAAA;gBAC3D,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,gBAAgB,GAAG,GAAG,CAAC,OAAO,CAAC,gBAAgB,CAAA;YACjE,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,MAAM,CAAC,KAAK,CAAC,KAAK,EAAE,sCAAsC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAA;gBACrF,OAAO,IAAI,CAAC,KAAK,CAAC,CAAA;YACpB,CAAC;QACH,CAAC;QAED,OAAO,IAAI,EAAE,CAAA;IACf,CAAC,CAAA;AACH,CAAC;AA7CD,uCA6CC"}

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;AAEzC,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/config.d.ts

@@ -6,6 +6,9 @@ declare const _default: {
         prisonApi: {
             url: string;
         };
+        allocationsApi: {
+            url: string;
+        };
     };
 };
 export default _default;

package/dist/config.js

@@ -20,6 +20,9 @@ exports.default = {
         prisonApi: {
             url: get('PRISON_API_URL', null),
         },
+        allocationsApi: {
+            url: get('ALLOCATIONS_API_URL', null),
+        },
     },
 };
 //# sourceMappingURL=config.js.map

package/dist/config.js.map

@@ -1 +1 @@
-{"version":3,"file":"config.js","sourceRoot":"","sources":["../src/config.ts"],"names":[],"mappings":";;AAAA,MAAM,UAAU,GAAG,OAAO,CAAC,GAAG,CAAC,QAAQ,KAAK,YAAY,CAAA;AAExD,SAAS,GAAG,CAAC,IAAY,EAAE,QAAgB,EAAE,OAAO,GAAG,EAAE,mBAAmB,EAAE,KAAK,EAAE;IACnF,MAAM,WAAW,GAAG,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,CAAA;IACrC,IAAI,WAAW,KAAK,SAAS,EAAE,CAAC;QAC9B,OAAO,WAAW,CAAA;IACpB,CAAC;IACD,IAAI,QAAQ,KAAK,SAAS,IAAI,CAAC,CAAC,UAAU,IAAI,CAAC,OAAO,CAAC,mBAAmB,CAAC,EAAE,CAAC;QAC5E,OAAO,QAAQ,CAAA;IACjB,CAAC;IACD,MAAM,IAAI,KAAK,CAAC,mBAAmB,IAAI,EAAE,CAAC,CAAA;AAC5C,CAAC;AAED,MAAM,oBAAoB,GAAG,EAAE,mBAAmB,EAAE,IAAI,EAAE,CAAA;AAE1D,kBAAe;IACb,IAAI,EAAE;QACJ,YAAY,EAAE;YACZ,GAAG,EAAE,GAAG,CAAC,mBAAmB,EAAE,sBAAsB,EAAE,oBAAoB,CAAC;SAC5E;QACD,SAAS,EAAE;YACT,GAAG,EAAE,GAAG,CAAC,gBAAgB,EAAE,IAAI,CAAC;SACjC;KACF;CACF,CAAA"}
+{"version":3,"file":"config.js","sourceRoot":"","sources":["../src/config.ts"],"names":[],"mappings":";;AAAA,MAAM,UAAU,GAAG,OAAO,CAAC,GAAG,CAAC,QAAQ,KAAK,YAAY,CAAA;AAExD,SAAS,GAAG,CAAC,IAAY,EAAE,QAAgB,EAAE,OAAO,GAAG,EAAE,mBAAmB,EAAE,KAAK,EAAE;IACnF,MAAM,WAAW,GAAG,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,CAAA;IACrC,IAAI,WAAW,KAAK,SAAS,EAAE,CAAC;QAC9B,OAAO,WAAW,CAAA;IACpB,CAAC;IACD,IAAI,QAAQ,KAAK,SAAS,IAAI,CAAC,CAAC,UAAU,IAAI,CAAC,OAAO,CAAC,mBAAmB,CAAC,EAAE,CAAC;QAC5E,OAAO,QAAQ,CAAA;IACjB,CAAC;IACD,MAAM,IAAI,KAAK,CAAC,mBAAmB,IAAI,EAAE,CAAC,CAAA;AAC5C,CAAC;AAED,MAAM,oBAAoB,GAAG,EAAE,mBAAmB,EAAE,IAAI,EAAE,CAAA;AAE1D,kBAAe;IACb,IAAI,EAAE;QACJ,YAAY,EAAE;YACZ,GAAG,EAAE,GAAG,CAAC,mBAAmB,EAAE,sBAAsB,EAAE,oBAAoB,CAAC;SAC5E;QACD,SAAS,EAAE;YACT,GAAG,EAAE,GAAG,CAAC,gBAAgB,EAAE,IAAI,CAAC;SACjC;QACD,cAAc,EAAE;YACd,GAAG,EAAE,GAAG,CAAC,qBAAqB,EAAE,IAAI,CAAC;SACtC;KACF;CACF,CAAA"}

package/dist/data/allocationsApi/allocationsApiClient.d.ts

@@ -0,0 +1,10 @@
+import type bunyan from 'bunyan';
+import TimeoutOptions from '../../types/TimeoutOptions';
+import { PrisonUser } from '../../types/HmppsUser';
+import { AllocationJobResponsibility } from '../../types/AllocationJobResponsibility';
+declare const _default: {
+    getStaffAllocationPolicies(user: PrisonUser, timeoutOptions: TimeoutOptions, log: bunyan | typeof console): Promise<{
+        policies: AllocationJobResponsibility[];
+    }>;
+};
+export default _default;

package/dist/data/allocationsApi/allocationsApiClient.js

@@ -0,0 +1,23 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const superagent_1 = __importDefault(require("superagent"));
+const config_1 = __importDefault(require("../../config"));
+exports.default = {
+    async getStaffAllocationPolicies(user, timeoutOptions, log) {
+        const result = await superagent_1.default
+            .get(`${config_1.default.apis.allocationsApi.url}/prisons/${user.activeCaseLoadId}/staff/${user.userId}/job-classifications`)
+            .agent(this.agent)
+            .retry(2, (err, _res) => {
+            if (err)
+                log.info(`Retry handler found API error with ${err.code} ${err.message}`);
+            return undefined; // retry handler only for logging retries, not to influence retry logic
+        })
+            .auth(user.token, { type: 'bearer' })
+            .timeout(timeoutOptions);
+        return result.body;
+    },
+};
+//# sourceMappingURL=allocationsApiClient.js.map

package/dist/data/allocationsApi/allocationsApiClient.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"allocationsApiClient.js","sourceRoot":"","sources":["../../../src/data/allocationsApi/allocationsApiClient.ts"],"names":[],"mappings":";;;;;AACA,4DAAmC;AAEnC,0DAAiC;AAIjC,kBAAe;IACb,KAAK,CAAC,0BAA0B,CAC9B,IAAgB,EAChB,cAA8B,EAC9B,GAA4B;QAE5B,MAAM,MAAM,GAAG,MAAM,oBAAU;aAC5B,GAAG,CACF,GAAG,gBAAM,CAAC,IAAI,CAAC,cAAc,CAAC,GAAG,YAAY,IAAI,CAAC,gBAAgB,UAAU,IAAI,CAAC,MAAM,sBAAsB,CAC9G;aACA,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC;aACjB,KAAK,CAAC,CAAC,EAAE,CAAC,GAAG,EAAE,IAAI,EAAE,EAAE;YACtB,IAAI,GAAG;gBAAE,GAAG,CAAC,IAAI,CAAC,sCAAsC,GAAG,CAAC,IAAI,IAAI,GAAG,CAAC,OAAO,EAAE,CAAC,CAAA;YAClF,OAAO,SAAS,CAAA,CAAC,uEAAuE;QAC1F,CAAC,CAAC;aACD,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC;aACpC,OAAO,CAAC,cAAc,CAAC,CAAA;QAE1B,OAAO,MAAM,CAAC,IAAI,CAAA;IACpB,CAAC;CACF,CAAA"}

package/dist/index.d.ts

@@ -1,5 +1,6 @@
 import getPageComponents from './componentsService';
 import retrieveCaseLoadData from './caseLoadService';
+import retrieveAllocationJobResponsibilities from './allocationService';
 declare const _default: {
     /**
      * Returns a request handler for adding header and footer frontend components to res.locals
@@ -16,6 +17,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;
     /**
@@ -41,5 +43,25 @@ declare const _default: {
      * @param caseLoadOptions.timeoutOptions - timeout object for superagent. Defaults to 2500ms
      */
     retrieveCaseLoadData: typeof retrieveCaseLoadData;
+    /**
+     * Ensures that:
+     * - `res.locals.user.allocationJobResponsibilities`
+     * is set for NOMIS users (or will propagate an error).  It will also attempt to cache in `req.session.allocationJobResponsibilities`
+     * (this is so that extra requests to Allocations API are not required for routes that do not need frontend components,
+     * such as image data, or if the frontend component API errors or is temporarily down).
+     *
+     * It will do the following in priority order, and will attempt the next if the previous fails:
+     *
+     *  * Use values from `res.feComponents.sharedData` if present (and cache in `req.session`)
+     *  * Use cached data from `req.session`
+     *  * Fetch data from Allocations API as a fallback and cache in `req.session`
+     *
+     * Expects res.locals.user to be set up inline with the hmpps-template-typescript project
+     *
+     * @param caseLoadOptions - config object for request
+     * @param caseLoadOptions.logger - pass in the bunyen logger if you want to use it. Falls back to console if not provided
+     * @param caseLoadOptions.timeoutOptions - timeout object for superagent. Defaults to 2500ms
+     */
+    retrieveAllocationJobResponsibilities: typeof retrieveAllocationJobResponsibilities;
 };
 export default _default;

package/dist/index.js

@@ -5,6 +5,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 const componentsService_1 = __importDefault(require("./componentsService"));
 const caseLoadService_1 = __importDefault(require("./caseLoadService"));
+const allocationService_1 = __importDefault(require("./allocationService"));
 exports.default = {
     /**
      * Returns a request handler for adding header and footer frontend components to res.locals
@@ -21,6 +22,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,
     /**
@@ -46,5 +48,25 @@ exports.default = {
      * @param caseLoadOptions.timeoutOptions - timeout object for superagent. Defaults to 2500ms
      */
     retrieveCaseLoadData: caseLoadService_1.default,
+    /**
+     * Ensures that:
+     * - `res.locals.user.allocationJobResponsibilities`
+     * is set for NOMIS users (or will propagate an error).  It will also attempt to cache in `req.session.allocationJobResponsibilities`
+     * (this is so that extra requests to Allocations API are not required for routes that do not need frontend components,
+     * such as image data, or if the frontend component API errors or is temporarily down).
+     *
+     * It will do the following in priority order, and will attempt the next if the previous fails:
+     *
+     *  * Use values from `res.feComponents.sharedData` if present (and cache in `req.session`)
+     *  * Use cached data from `req.session`
+     *  * Fetch data from Allocations API as a fallback and cache in `req.session`
+     *
+     * Expects res.locals.user to be set up inline with the hmpps-template-typescript project
+     *
+     * @param caseLoadOptions - config object for request
+     * @param caseLoadOptions.logger - pass in the bunyen logger if you want to use it. Falls back to console if not provided
+     * @param caseLoadOptions.timeoutOptions - timeout object for superagent. Defaults to 2500ms
+     */
+    retrieveAllocationJobResponsibilities: allocationService_1.default,
 };
 //# sourceMappingURL=index.js.map

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;AACpD,4EAAuE;AAEvE,kBAAe;IACb;;;;;;;;;;;;;;;;OAgBG;IACH,iBAAiB,EAAjB,2BAAiB;IAEjB;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,oBAAoB,EAApB,yBAAoB;IAEpB;;;;;;;;;;;;;;;;;;OAkBG;IACH,qCAAqC,EAArC,2BAAqC;CACtC,CAAA"}

package/dist/types/AllocationJobResponsibility.d.ts

@@ -0,0 +1 @@
+export type AllocationJobResponsibility = 'KEY_WORKER' | 'PERSONAL_OFFICER';

package/dist/types/AllocationJobResponsibility.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=AllocationJobResponsibility.js.map

package/dist/types/AllocationJobResponsibility.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"AllocationJobResponsibility.js","sourceRoot":"","sources":["../../src/types/AllocationJobResponsibility.ts"],"names":[],"mappings":""}

package/dist/types/HeaderFooterSharedData.d.ts

@@ -1,9 +1,11 @@
 import CaseLoad from './CaseLoad';
 import Service from './Service';
+import { AllocationJobResponsibility } from './AllocationJobResponsibility';
 export default interface HeaderFooterSharedData {
     activeCaseLoad?: CaseLoad;
     caseLoads: CaseLoad[];
     services: Service[];
+    allocationJobResponsibilities: AllocationJobResponsibility[];
 }
 export interface ComponentsSharedData {
     header: HeaderFooterSharedData;

package/dist/types/HmppsUser.d.ts

@@ -1,4 +1,5 @@
 import CaseLoad from './CaseLoad';
+import { AllocationJobResponsibility } from './AllocationJobResponsibility';
 export type AuthSource = 'nomis' | 'delius' | 'external' | 'azuread';
 /**
  * These are the details that all user types share.
@@ -26,6 +27,7 @@ export interface PrisonUser extends BaseUser {
     caseLoads: CaseLoad[];
     activeCaseLoad?: CaseLoad;
     activeCaseLoadId?: string;
+    allocationJobResponsibilities?: AllocationJobResponsibility[];
 }
 /**
  * Probation users are those that have a user account in nDelius.

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",
+  "version": "2.2.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",
@@ -63,31 +63,31 @@
   "homepage": "https://github.com/ministryofjustice/hmpps-connect-dps-components#readme",
   "devDependencies": {
     "@types/bunyan": "^1.8.11",
-    "@types/express": "^4.17.21",
+    "@types/express": "^4.17.22",
     "@types/jest": "^29.5.14",
     "@types/superagent": "^8.1.9",
-    "@types/supertest": "^6.0.2",
+    "@types/supertest": "^6.0.3",
     "@typescript-eslint/eslint-plugin": "^6.21.0",
     "cheerio": "^1.0.0",
     "eslint": "^8.57.1",
     "eslint-config-airbnb-base": "^15.0.0",
     "eslint-config-prettier": "^9.1.0",
-    "eslint-import-resolver-typescript": "^3.6.3",
+    "eslint-import-resolver-typescript": "^3.10.1",
     "eslint-plugin-cypress": "^2.15.2",
     "eslint-plugin-import": "^2.31.0",
     "eslint-plugin-no-only-tests": "^3.3.0",
-    "eslint-plugin-prettier": "^5.2.1",
-    "express": "^4.21.1",
-    "govuk-frontend": "^5.7.1",
+    "eslint-plugin-prettier": "^5.4.0",
+    "express": "^4.21.2",
+    "govuk-frontend": "^5.10.1",
     "jest": "^29.7.0",
     "jest-html-reporter": "^3.10.2",
     "jest-junit": "^16.0.0",
     "nock": "^13.5.6",
-    "supertest": "^7.0.0",
-    "ts-jest": "^29.2.5"
+    "supertest": "^7.1.1",
+    "ts-jest": "^29.3.4"
   },
   "dependencies": {
-    "@types/node": "^20.17.6",
+    "@types/node": "^20.17.48",
     "@types/nunjucks": "^3.2.6",
     "nunjucks": "^3.2.4",
     "superagent": "^9.0.2"