@ministryofjustice/hmpps-connect-dps-components 2.2.0 → 3.0.0-beta.1

package/dist/allocationService.d.ts

@@ -1,3 +1,15 @@
 import { type RequestHandler } from 'express';
-import CaseLoadOptions from './types/CaseLoadOptions';
-export default function retrieveAllocationJobResponsibilities(options?: CaseLoadOptions): RequestHandler;
+import { ApiConfig, AuthenticationClient } from '@ministryofjustice/hmpps-rest-client';
+import AllocationsApiClient from './data/allocationsApi/allocationsApiClient';
+import { ConnectDpsComponentLogger } from './types/ConnectDpsComponentLogger';
+export default class AllocationService {
+    private readonly logger;
+    private readonly allocationsApiClient;
+    constructor(logger: ConnectDpsComponentLogger, allocationsApiClient: AllocationsApiClient);
+    static create({ logger, allocationsApiConfig, authenticationClient, }: {
+        logger?: ConnectDpsComponentLogger;
+        allocationsApiConfig: ApiConfig;
+        authenticationClient: AuthenticationClient;
+    }): AllocationService;
+    retrieveAllocationJobResponsibilities(): RequestHandler;
+}

package/dist/allocationService.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/caseLoadService.d.ts

@@ -1,3 +1,15 @@
 import { type RequestHandler } from 'express';
-import CaseLoadOptions from './types/CaseLoadOptions';
-export default function retrieveCaseLoadData(caseLoadOptions?: CaseLoadOptions): RequestHandler;
+import { ApiConfig, AuthenticationClient } from '@ministryofjustice/hmpps-rest-client';
+import PrisonApiClient from './data/prisonApi/prisonApiClient';
+import { ConnectDpsComponentLogger } from './types/ConnectDpsComponentLogger';
+export default class CaseLoadService {
+    private readonly logger;
+    private readonly prisonApiClient;
+    constructor(logger: ConnectDpsComponentLogger, prisonApiClient: PrisonApiClient);
+    static create({ logger, prisonApiConfig, authenticationClient, }: {
+        logger?: ConnectDpsComponentLogger;
+        prisonApiConfig: ApiConfig;
+        authenticationClient: AuthenticationClient;
+    }): CaseLoadService;
+    retrieveCaseLoadData(): RequestHandler;
+}

package/dist/caseLoadService.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/componentsService.d.ts

@@ -1,3 +1,17 @@
 import { type RequestHandler } from 'express';
+import { ApiConfig, AuthenticationClient } from '@ministryofjustice/hmpps-rest-client';
+import ComponentApiClient from './data/componentApi/componentApiClient';
 import RequestOptions from './types/RequestOptions';
-export default function getFrontendComponents(requestOptions?: RequestOptions): RequestHandler;
+import { ConnectDpsComponentLogger } from './types/ConnectDpsComponentLogger';
+export default class ComponentsService {
+    private readonly logger;
+    private readonly componentApiConfig;
+    private readonly componentApiClient;
+    constructor(logger: ConnectDpsComponentLogger, componentApiConfig: ApiConfig, componentApiClient: ComponentApiClient);
+    static create({ logger, componentApiConfig, authenticationClient, }: {
+        logger?: ConnectDpsComponentLogger;
+        componentApiConfig: ApiConfig;
+        authenticationClient: AuthenticationClient;
+    }): ComponentsService;
+    getFrontendComponents(requestOptions: RequestOptions): RequestHandler;
+}

package/dist/componentsService.test.d.ts

@@ -0,0 +1 @@
+export {};

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

@@ -1,10 +1,10 @@
-import type bunyan from 'bunyan';
-import TimeoutOptions from '../../types/TimeoutOptions';
+import { ApiConfig, AuthenticationClient, RestClient } from '@ministryofjustice/hmpps-rest-client';
 import { PrisonUser } from '../../types/HmppsUser';
 import { AllocationJobResponsibility } from '../../types/AllocationJobResponsibility';
-declare const _default: {
-    getStaffAllocationPolicies(user: PrisonUser, timeoutOptions: TimeoutOptions, log: bunyan | typeof console): Promise<{
+import { ConnectDpsComponentLogger } from '../../types/ConnectDpsComponentLogger';
+export default class AllocationsApiClient extends RestClient {
+    constructor(logger: ConnectDpsComponentLogger, config: ApiConfig, authenticationClient: AuthenticationClient);
+    getStaffAllocationPolicies(user: PrisonUser): Promise<{
         policies: AllocationJobResponsibility[];
     }>;
-};
-export default _default;
+}

package/dist/data/componentApi/componentApiClient.d.ts

@@ -1,12 +1,12 @@
-import type bunyan from 'bunyan';
+import { ApiConfig, AuthenticationClient, RestClient } from '@ministryofjustice/hmpps-rest-client';
 import AvailableComponent from '../../types/AvailableComponent';
 import Component from '../../types/Component';
-import TimeoutOptions from '../../types/TimeoutOptions';
+import { ConnectDpsComponentLogger } from '../../types/ConnectDpsComponentLogger';
 import { ComponentsSharedData } from '../../types/HeaderFooterSharedData';
 export type ComponentsApiResponse<T extends AvailableComponent[]> = Record<T[number], Component> & {
     meta: ComponentsSharedData[T[number]];
 };
-declare const _default: {
-    getComponents<T extends AvailableComponent[]>(userToken: string, timeoutOptions: TimeoutOptions, log: bunyan | typeof console): Promise<ComponentsApiResponse<T>>;
-};
-export default _default;
+export default class ComponentApiClient extends RestClient {
+    constructor(logger: ConnectDpsComponentLogger, config: ApiConfig, authenticationClient: AuthenticationClient);
+    getComponents<T extends AvailableComponent[]>(userToken: string): Promise<ComponentsApiResponse<T>>;
+}

package/dist/data/prisonApi/prisonApiClient.d.ts

@@ -1,7 +1,7 @@
-import type bunyan from 'bunyan';
-import TimeoutOptions from '../../types/TimeoutOptions';
+import { ApiConfig, AuthenticationClient, RestClient } from '@ministryofjustice/hmpps-rest-client';
 import CaseLoad from '../../types/CaseLoad';
-declare const _default: {
-    getUserCaseLoads(userToken: string, timeoutOptions: TimeoutOptions, log: bunyan | typeof console): Promise<CaseLoad[]>;
-};
-export default _default;
+import { ConnectDpsComponentLogger } from '../../types/ConnectDpsComponentLogger';
+export default class PrisonApiClient extends RestClient {
+    constructor(logger: ConnectDpsComponentLogger, config: ApiConfig, authenticationClient: AuthenticationClient);
+    getUserCaseLoads(userToken: string): Promise<CaseLoad[]>;
+}

package/dist/index.cjs

@@ -0,0 +1,246 @@
+'use strict';
+
+var hmppsRestClient = require('@ministryofjustice/hmpps-rest-client');
+var nunjucks = require('nunjucks');
+
+class ComponentApiClient extends hmppsRestClient.RestClient {
+    constructor(logger, config, authenticationClient) {
+        super('Component API Client', config, logger, authenticationClient);
+    }
+    async getComponents(userToken) {
+        return this.get({
+            path: `/components`,
+            query: 'component=header&component=footer',
+            headers: { 'x-user-token': userToken },
+        }, hmppsRestClient.asSystem());
+    }
+}
+
+function getFallbackHeader(user, requestOptions) {
+    const { dpsUrl, environmentName, authUrl, supportUrl } = requestOptions;
+    return nunjucks.render('dpsComponents/header-bar.njk', {
+        isPrisonUser: !user || user.authSource === 'nomis',
+        user,
+        dpsUrl,
+        environmentName,
+        authUrl,
+        supportUrl,
+        name: initialiseName(user?.displayName),
+    });
+}
+function getFallbackFooter(user, requestOptions) {
+    const { supportUrl, authUrl } = requestOptions;
+    return nunjucks.render('dpsComponents/footer.njk', {
+        isPrisonUser: !user || user.authSource === 'nomis',
+        supportUrl,
+        authUrl,
+    });
+}
+function initialiseName(fullName) {
+    if (!fullName)
+        return null;
+    const array = fullName.split(' ');
+    return `${array[0][0]}. ${array.reverse()[0]}`;
+}
+
+function updateCsp(feComponentsUrl, res) {
+    const csp = res.getHeaders()['content-security-policy'];
+    const allDirectives = csp?.split(';') ?? [];
+    const directivesToUpdate = ['script-src', 'style-src', 'img-src', 'font-src'];
+    const updatedCspDirectives = allDirectives.map(directive => {
+        // if directive is not in cspToUpdate or includes fe components url already return as is
+        if (directive.includes(feComponentsUrl) || !directivesToUpdate.some(p => directive.includes(`${p} `)))
+            return directive;
+        // if directive is in cspToUpdate and does not have fe components url, add in
+        return `${directive} ${feComponentsUrl}`;
+    });
+    const requiredAndNotPresent = directivesToUpdate
+        .filter(p => !updatedCspDirectives.find(directive => directive.includes(`${p} `)))
+        .map(p => `${p} 'self' ${feComponentsUrl}`);
+    res.set('content-security-policy', [...updatedCspDirectives, ...requiredAndNotPresent].join(';'));
+}
+
+const defaultOptions = {
+    logger: console,
+    timeoutOptions: { response: 2500, deadline: 2500 },
+    includeSharedData: false,
+    useFallbacksByDefault: false,
+};
+class ComponentsService {
+    logger;
+    componentApiConfig;
+    componentApiClient;
+    constructor(logger, componentApiConfig, componentApiClient) {
+        this.logger = logger;
+        this.componentApiConfig = componentApiConfig;
+        this.componentApiClient = componentApiClient;
+    }
+    static create({ logger = console, componentApiConfig, authenticationClient, }) {
+        return new ComponentsService(logger, componentApiConfig, new ComponentApiClient(logger, componentApiConfig, authenticationClient));
+    }
+    getFrontendComponents(requestOptions) {
+        const requestOptionsWithDefaults = {
+            ...defaultOptions,
+            ...requestOptions,
+        };
+        const { includeSharedData, useFallbacksByDefault } = {
+            ...defaultOptions,
+            ...requestOptions,
+        };
+        return async (_req, res, next) => {
+            const useFallbacks = (user) => {
+                res.locals.feComponents = {
+                    header: getFallbackHeader(user, requestOptionsWithDefaults),
+                    footer: getFallbackFooter(user, requestOptionsWithDefaults),
+                    cssIncludes: [],
+                    jsIncludes: [],
+                };
+            };
+            if (!res.locals.user) {
+                this.logger.info('Using fallback frontend components when no user in context');
+                useFallbacks(null);
+                return next();
+            }
+            if (useFallbacksByDefault) {
+                this.logger.info('Using fallback frontend components by default');
+                useFallbacks(res.locals.user);
+                return next();
+            }
+            try {
+                const { header, footer, meta } = await this.componentApiClient.getComponents(res.locals.user.token);
+                res.locals.feComponents = {
+                    header: header.html,
+                    footer: footer.html,
+                    cssIncludes: [...header.css, ...footer.css],
+                    jsIncludes: [...header.javascript, ...footer.javascript],
+                };
+                if (includeSharedData) {
+                    res.locals.feComponents.sharedData = meta;
+                }
+                updateCsp(this.componentApiConfig.url, res);
+                return next();
+            }
+            catch (_error) {
+                this.logger.error('Failed to retrieve front end components, using fallbacks');
+                useFallbacks(res.locals.user);
+                return next();
+            }
+        };
+    }
+}
+
+class PrisonApiClient extends hmppsRestClient.RestClient {
+    constructor(logger, config, authenticationClient) {
+        super('Prison API Client', config, logger, authenticationClient);
+    }
+    async getUserCaseLoads(userToken) {
+        return this.get({
+            path: '/api/users/me/caseloads',
+            query: { allCaseloads: true },
+        }, hmppsRestClient.asUser(userToken));
+    }
+}
+
+class CaseLoadService {
+    logger;
+    prisonApiClient;
+    constructor(logger, prisonApiClient) {
+        this.logger = logger;
+        this.prisonApiClient = prisonApiClient;
+    }
+    static create({ logger = console, prisonApiConfig, authenticationClient, }) {
+        return new CaseLoadService(logger, new PrisonApiClient(logger, prisonApiConfig, authenticationClient));
+    }
+    retrieveCaseLoadData() {
+        return async (req, res, next) => {
+            if (!req.session)
+                throw new Error('User session required in order to cache case loads');
+            if (res.locals.user && res.locals.user.token && 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.caseLoads = res.locals.feComponents.sharedData.caseLoads;
+                        req.session.activeCaseLoad = res.locals.feComponents.sharedData.activeCaseLoad;
+                        req.session.activeCaseLoadId = res.locals.feComponents.sharedData.activeCaseLoad?.caseLoadId;
+                    }
+                    // If cache is empty, fetch data from Prison API
+                    if (!req.session.caseLoads) {
+                        this.logger.info(`Falling back to Prison API to retrieve case loads for: ${res.locals.user.username}`);
+                        const userCaseLoads = await this.prisonApiClient.getUserCaseLoads(res.locals.user.token);
+                        const caseLoads = userCaseLoads.filter(caseload => caseload.type !== 'APP');
+                        const activeCaseLoad = caseLoads.find((caseLoad) => caseLoad.currentlyActive);
+                        req.session.caseLoads = caseLoads;
+                        req.session.activeCaseLoad = activeCaseLoad;
+                        req.session.activeCaseLoadId = activeCaseLoad?.caseLoadId;
+                    }
+                    // Populate res.locals.user with values from cache
+                    res.locals.user.caseLoads = req.session.caseLoads;
+                    res.locals.user.activeCaseLoad = req.session.activeCaseLoad;
+                    res.locals.user.activeCaseLoadId = req.session.activeCaseLoadId;
+                }
+                catch (error) {
+                    this.logger.error(error, `Failed to retrieve case loads for: ${res.locals.user.username}`);
+                    return next(error);
+                }
+            }
+            return next();
+        };
+    }
+}
+
+class AllocationsApiClient extends hmppsRestClient.RestClient {
+    constructor(logger, config, authenticationClient) {
+        super('Allocations API Client', config, logger, authenticationClient);
+    }
+    async getStaffAllocationPolicies(user) {
+        return this.get({
+            path: `/prisons/${user.activeCaseLoadId}/staff/${user.userId}/job-classifications`,
+        }, hmppsRestClient.asSystem());
+    }
+}
+
+class AllocationService {
+    logger;
+    allocationsApiClient;
+    constructor(logger, allocationsApiClient) {
+        this.logger = logger;
+        this.allocationsApiClient = allocationsApiClient;
+    }
+    static create({ logger = console, allocationsApiConfig, authenticationClient, }) {
+        return new AllocationService(logger, new AllocationsApiClient(logger, allocationsApiConfig, authenticationClient));
+    }
+    retrieveAllocationJobResponsibilities() {
+        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) {
+                        this.logger.info(`Falling back to Allocations API to retrieve job responsibilities for: ${res.locals.user.username}`);
+                        const allocationPolicies = await this.allocationsApiClient.getStaffAllocationPolicies(res.locals.user);
+                        req.session.allocationJobResponsibilities = allocationPolicies.policies;
+                    }
+                    // Populate res.locals.user with values from cache
+                    res.locals.user.allocationJobResponsibilities = req.session.allocationJobResponsibilities;
+                }
+                catch (error) {
+                    this.logger.error(error, `Failed to retrieve allocation job responsibilities for: ${res.locals.user.username}`);
+                    return next(error);
+                }
+            }
+            return next();
+        };
+    }
+}
+
+exports.AllocationService = AllocationService;
+exports.CaseLoadService = CaseLoadService;
+exports.ComponentsService = ComponentsService;
+//# sourceMappingURL=index.cjs.map

package/dist/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.cjs","sources":["../src/data/componentApi/componentApiClient.ts","../src/utils/fallbacks.ts","../src/utils/updateCsp.ts","../src/componentsService.ts","../src/data/prisonApi/prisonApiClient.ts","../src/caseLoadService.ts","../src/data/allocationsApi/allocationsApiClient.ts","../src/allocationService.ts"],"sourcesContent":["import { ApiConfig, asSystem, AuthenticationClient, RestClient } from '@ministryofjustice/hmpps-rest-client'\nimport AvailableComponent from '../../types/AvailableComponent'\nimport Component from '../../types/Component'\nimport { ConnectDpsComponentLogger } from '../../types/ConnectDpsComponentLogger'\nimport { ComponentsSharedData } from '../../types/HeaderFooterSharedData'\n\nexport type ComponentsApiResponse<T extends AvailableComponent[]> = Record<T[number], Component> & {\n  meta: ComponentsSharedData[T[number]] // TODO: rename 'meta' in the API response\n}\n\nexport default class ComponentApiClient extends RestClient {\n  constructor(logger: ConnectDpsComponentLogger, config: ApiConfig, authenticationClient: AuthenticationClient) {\n    super('Component API Client', config, logger, authenticationClient)\n  }\n\n  async getComponents<T extends AvailableComponent[]>(userToken: string): Promise<ComponentsApiResponse<T>> {\n    return this.get<ComponentsApiResponse<T>>(\n      {\n        path: `/components`,\n        query: 'component=header&component=footer',\n        headers: { 'x-user-token': userToken },\n      },\n      asSystem(),\n    )\n  }\n}\n","import nunjucks from 'nunjucks'\nimport RequestOptions from '../types/RequestOptions'\nimport { HmppsUser } from '../types/HmppsUser'\n\nexport function getFallbackHeader(user: HmppsUser | null, requestOptions: RequestOptions): string {\n  const { dpsUrl, environmentName, authUrl, supportUrl } = requestOptions\n\n  return nunjucks.render('dpsComponents/header-bar.njk', {\n    isPrisonUser: !user || user.authSource === 'nomis',\n    user,\n    dpsUrl,\n    environmentName,\n    authUrl,\n    supportUrl,\n    name: initialiseName(user?.displayName),\n  })\n}\n\nexport function getFallbackFooter(user: HmppsUser | null, requestOptions: RequestOptions): string {\n  const { supportUrl, authUrl } = requestOptions\n  return nunjucks.render('dpsComponents/footer.njk', {\n    isPrisonUser: !user || user.authSource === 'nomis',\n    supportUrl,\n    authUrl,\n  })\n}\n\nfunction initialiseName(fullName?: string): string | null {\n  if (!fullName) return null\n\n  const array = fullName.split(' ')\n  return `${array[0][0]}. ${array.reverse()[0]}`\n}\n","import { type Response } from 'express'\n\nexport default function updateCsp(feComponentsUrl: string, res: Response) {\n  const csp = res.getHeaders()['content-security-policy']\n  const allDirectives = csp?.split(';') ?? []\n  const directivesToUpdate = ['script-src', 'style-src', 'img-src', 'font-src']\n\n  const updatedCspDirectives = allDirectives.map(directive => {\n    // if directive is not in cspToUpdate or includes fe components url already return as is\n    if (directive.includes(feComponentsUrl as string) || !directivesToUpdate.some(p => directive.includes(`${p} `)))\n      return directive\n\n    // if directive is in cspToUpdate and does not have fe components url, add in\n    return `${directive} ${feComponentsUrl}`\n  })\n\n  const requiredAndNotPresent = directivesToUpdate\n    .filter(p => !updatedCspDirectives.find(directive => directive.includes(`${p} `)))\n    .map(p => `${p} 'self' ${feComponentsUrl}`)\n\n  res.set('content-security-policy', [...updatedCspDirectives, ...requiredAndNotPresent].join(';'))\n}\n","import { type NextFunction, type Request, type Response, type RequestHandler } from 'express'\nimport { ApiConfig, AuthenticationClient } from '@ministryofjustice/hmpps-rest-client'\nimport ComponentApiClient from './data/componentApi/componentApiClient'\nimport { getFallbackFooter, getFallbackHeader } from './utils/fallbacks'\nimport RequestOptions from './types/RequestOptions'\nimport updateCsp from './utils/updateCsp'\nimport { HmppsUser } from './types/HmppsUser'\nimport { ConnectDpsComponentLogger } from './types/ConnectDpsComponentLogger'\n\nconst defaultOptions: Partial<RequestOptions> = {\n  logger: console,\n  timeoutOptions: { response: 2500, deadline: 2500 },\n  includeSharedData: false,\n  useFallbacksByDefault: false,\n}\n\nexport default class ComponentsService {\n  constructor(\n    private readonly logger: ConnectDpsComponentLogger,\n    private readonly componentApiConfig: ApiConfig,\n    private readonly componentApiClient: ComponentApiClient,\n  ) {}\n\n  static create({\n    logger = console,\n    componentApiConfig,\n    authenticationClient,\n  }: {\n    logger?: ConnectDpsComponentLogger\n    componentApiConfig: ApiConfig\n    authenticationClient: AuthenticationClient\n  }) {\n    return new ComponentsService(\n      logger,\n      componentApiConfig,\n      new ComponentApiClient(logger, componentApiConfig, authenticationClient),\n    )\n  }\n\n  getFrontendComponents(requestOptions: RequestOptions): RequestHandler {\n    const requestOptionsWithDefaults = {\n      ...defaultOptions,\n      ...requestOptions,\n    }\n    const { includeSharedData, useFallbacksByDefault } = {\n      ...defaultOptions,\n      ...requestOptions,\n    }\n\n    return async (_req: Request, res: Response, next: NextFunction) => {\n      const useFallbacks = (user: HmppsUser | null) => {\n        res.locals.feComponents = {\n          header: getFallbackHeader(user, requestOptionsWithDefaults),\n          footer: getFallbackFooter(user, requestOptionsWithDefaults),\n          cssIncludes: [],\n          jsIncludes: [],\n        }\n      }\n\n      if (!res.locals.user) {\n        this.logger.info('Using fallback frontend components when no user in context')\n        useFallbacks(null)\n        return next()\n      }\n\n      if (useFallbacksByDefault) {\n        this.logger.info('Using fallback frontend components by default')\n        useFallbacks(res.locals.user)\n        return next()\n      }\n\n      try {\n        const { header, footer, meta } = await this.componentApiClient.getComponents(res.locals.user.token as string)\n\n        res.locals.feComponents = {\n          header: header.html,\n          footer: footer.html,\n          cssIncludes: [...header.css, ...footer.css],\n          jsIncludes: [...header.javascript, ...footer.javascript],\n        }\n\n        if (includeSharedData) {\n          res.locals.feComponents.sharedData = meta\n        }\n\n        updateCsp(this.componentApiConfig.url, res)\n\n        return next()\n      } catch (_error) {\n        this.logger.error('Failed to retrieve front end components, using fallbacks')\n        useFallbacks(res.locals.user)\n        return next()\n      }\n    }\n  }\n}\n","import { ApiConfig, asUser, AuthenticationClient, RestClient } from '@ministryofjustice/hmpps-rest-client'\nimport CaseLoad from '../../types/CaseLoad'\nimport { ConnectDpsComponentLogger } from '../../types/ConnectDpsComponentLogger'\n\nexport default class PrisonApiClient extends RestClient {\n  constructor(logger: ConnectDpsComponentLogger, config: ApiConfig, authenticationClient: AuthenticationClient) {\n    super('Prison API Client', config, logger, authenticationClient)\n  }\n\n  async getUserCaseLoads(userToken: string): Promise<CaseLoad[]> {\n    return this.get<CaseLoad[]>(\n      {\n        path: '/api/users/me/caseloads',\n        query: { allCaseloads: true },\n      },\n      asUser(userToken),\n    )\n  }\n}\n","import { type RequestHandler } from 'express'\nimport { ApiConfig, AuthenticationClient } from '@ministryofjustice/hmpps-rest-client'\nimport CaseLoad from './types/CaseLoad'\nimport PrisonApiClient from './data/prisonApi/prisonApiClient'\nimport { ConnectDpsComponentLogger } from './types/ConnectDpsComponentLogger'\n\nexport default class CaseLoadService {\n  constructor(\n    private readonly logger: ConnectDpsComponentLogger,\n    private readonly prisonApiClient: PrisonApiClient,\n  ) {}\n\n  static create({\n    logger = console,\n    prisonApiConfig,\n    authenticationClient,\n  }: {\n    logger?: ConnectDpsComponentLogger\n    prisonApiConfig: ApiConfig\n    authenticationClient: AuthenticationClient\n  }) {\n    return new CaseLoadService(logger, new PrisonApiClient(logger, prisonApiConfig, authenticationClient))\n  }\n\n  retrieveCaseLoadData(): RequestHandler {\n    return async (req, res, next) => {\n      if (!req.session) throw new Error('User session required in order to cache case loads')\n\n      if (res.locals.user && res.locals.user.token && res.locals.user.authSource === 'nomis') {\n        try {\n          // Update cache with values from res.feComponents.sharedData if present\n          if (res.locals.feComponents && res.locals.feComponents.sharedData) {\n            req.session.caseLoads = res.locals.feComponents.sharedData.caseLoads\n            req.session.activeCaseLoad = res.locals.feComponents.sharedData.activeCaseLoad\n            req.session.activeCaseLoadId = res.locals.feComponents.sharedData.activeCaseLoad?.caseLoadId\n          }\n\n          // If cache is empty, fetch data from Prison API\n          if (!req.session.caseLoads) {\n            this.logger.info(`Falling back to Prison API to retrieve case loads for: ${res.locals.user.username}`)\n            const userCaseLoads = await this.prisonApiClient.getUserCaseLoads(res.locals.user.token)\n            const caseLoads = userCaseLoads.filter(caseload => caseload.type !== 'APP')\n            const activeCaseLoad = caseLoads.find((caseLoad: CaseLoad) => caseLoad.currentlyActive)\n\n            req.session.caseLoads = caseLoads\n            req.session.activeCaseLoad = activeCaseLoad\n            req.session.activeCaseLoadId = activeCaseLoad?.caseLoadId\n          }\n\n          // Populate res.locals.user with values from cache\n          res.locals.user.caseLoads = req.session.caseLoads\n          res.locals.user.activeCaseLoad = req.session.activeCaseLoad\n          res.locals.user.activeCaseLoadId = req.session.activeCaseLoadId\n        } catch (error) {\n          this.logger.error(error, `Failed to retrieve case loads for: ${res.locals.user.username}`)\n          return next(error)\n        }\n      }\n\n      return next()\n    }\n  }\n}\n","import { ApiConfig, asSystem, AuthenticationClient, RestClient } from '@ministryofjustice/hmpps-rest-client'\nimport { PrisonUser } from '../../types/HmppsUser'\nimport { AllocationJobResponsibility } from '../../types/AllocationJobResponsibility'\nimport { ConnectDpsComponentLogger } from '../../types/ConnectDpsComponentLogger'\n\nexport default class AllocationsApiClient extends RestClient {\n  constructor(logger: ConnectDpsComponentLogger, config: ApiConfig, authenticationClient: AuthenticationClient) {\n    super('Allocations API Client', config, logger, authenticationClient)\n  }\n\n  async getStaffAllocationPolicies(user: PrisonUser): Promise<{ policies: AllocationJobResponsibility[] }> {\n    return this.get<{ policies: AllocationJobResponsibility[] }>(\n      {\n        path: `/prisons/${user.activeCaseLoadId}/staff/${user.userId}/job-classifications`,\n      },\n      asSystem(),\n    )\n  }\n}\n","import { type RequestHandler } from 'express'\nimport { ApiConfig, AuthenticationClient } from '@ministryofjustice/hmpps-rest-client'\nimport AllocationsApiClient from './data/allocationsApi/allocationsApiClient'\nimport { ConnectDpsComponentLogger } from './types/ConnectDpsComponentLogger'\n\nexport default class AllocationService {\n  constructor(\n    private readonly logger: ConnectDpsComponentLogger,\n    private readonly allocationsApiClient: AllocationsApiClient,\n  ) {}\n\n  static create({\n    logger = console,\n    allocationsApiConfig,\n    authenticationClient,\n  }: {\n    logger?: ConnectDpsComponentLogger\n    allocationsApiConfig: ApiConfig\n    authenticationClient: AuthenticationClient\n  }) {\n    return new AllocationService(logger, new AllocationsApiClient(logger, allocationsApiConfig, authenticationClient))\n  }\n\n  public retrieveAllocationJobResponsibilities(): RequestHandler {\n    return async (req, res, next) => {\n      if (!req.session) throw new Error('User session required in order to cache allocation job responsibilities')\n      if (!res.locals.user.token)\n        throw new Error(\n          'Caseload details needs to be populated before retrieving allocation job responsibilities. Please run retrieveCaseLoadData before retrieveAllocationJobResponsibilities.',\n        )\n\n      if (res.locals.user && res.locals.user.authSource === 'nomis') {\n        try {\n          // Update cache with values from res.feComponents.sharedData if present\n          if (res.locals.feComponents && res.locals.feComponents.sharedData) {\n            req.session.allocationJobResponsibilities = res.locals.feComponents.sharedData.allocationJobResponsibilities\n          }\n\n          // If cache is empty, fetch data from Prison API\n          if (!req.session.allocationJobResponsibilities) {\n            this.logger.info(\n              `Falling back to Allocations API to retrieve job responsibilities for: ${res.locals.user.username}`,\n            )\n            const allocationPolicies = await this.allocationsApiClient.getStaffAllocationPolicies(res.locals.user)\n            req.session.allocationJobResponsibilities = allocationPolicies.policies\n          }\n\n          // Populate res.locals.user with values from cache\n          res.locals.user.allocationJobResponsibilities = req.session.allocationJobResponsibilities\n        } catch (error) {\n          this.logger.error(\n            error,\n            `Failed to retrieve allocation job responsibilities for: ${res.locals.user.username}`,\n          )\n          return next(error)\n        }\n      }\n\n      return next()\n    }\n  }\n}\n"],"names":["RestClient","asSystem","asUser"],"mappings":";;;;;AAUc,MAAO,kBAAmB,SAAQA,0BAAU,CAAA;AACxD,IAAA,WAAA,CAAY,MAAiC,EAAE,MAAiB,EAAE,oBAA0C,EAAA;QAC1G,KAAK,CAAC,sBAAsB,EAAE,MAAM,EAAE,MAAM,EAAE,oBAAoB,CAAC;IACrE;IAEA,MAAM,aAAa,CAAiC,SAAiB,EAAA;QACnE,OAAO,IAAI,CAAC,GAAG,CACb;AACE,YAAA,IAAI,EAAE,CAAA,WAAA,CAAa;AACnB,YAAA,KAAK,EAAE,mCAAmC;AAC1C,YAAA,OAAO,EAAE,EAAE,cAAc,EAAE,SAAS,EAAE;SACvC,EACDC,wBAAQ,EAAE,CACX;IACH;AACD;;ACrBK,SAAU,iBAAiB,CAAC,IAAsB,EAAE,cAA8B,EAAA;IACtF,MAAM,EAAE,MAAM,EAAE,eAAe,EAAE,OAAO,EAAE,UAAU,EAAE,GAAG,cAAc;AAEvE,IAAA,OAAO,QAAQ,CAAC,MAAM,CAAC,8BAA8B,EAAE;QACrD,YAAY,EAAE,CAAC,IAAI,IAAI,IAAI,CAAC,UAAU,KAAK,OAAO;QAClD,IAAI;QACJ,MAAM;QACN,eAAe;QACf,OAAO;QACP,UAAU;AACV,QAAA,IAAI,EAAE,cAAc,CAAC,IAAI,EAAE,WAAW,CAAC;AACxC,KAAA,CAAC;AACJ;AAEM,SAAU,iBAAiB,CAAC,IAAsB,EAAE,cAA8B,EAAA;AACtF,IAAA,MAAM,EAAE,UAAU,EAAE,OAAO,EAAE,GAAG,cAAc;AAC9C,IAAA,OAAO,QAAQ,CAAC,MAAM,CAAC,0BAA0B,EAAE;QACjD,YAAY,EAAE,CAAC,IAAI,IAAI,IAAI,CAAC,UAAU,KAAK,OAAO;QAClD,UAAU;QACV,OAAO;AACR,KAAA,CAAC;AACJ;AAEA,SAAS,cAAc,CAAC,QAAiB,EAAA;AACvC,IAAA,IAAI,CAAC,QAAQ;AAAE,QAAA,OAAO,IAAI;IAE1B,MAAM,KAAK,GAAG,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC;AACjC,IAAA,OAAO,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA,EAAA,EAAK,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,EAAE;AAChD;;AC9Bc,SAAU,SAAS,CAAC,eAAuB,EAAE,GAAa,EAAA;IACtE,MAAM,GAAG,GAAG,GAAG,CAAC,UAAU,EAAE,CAAC,yBAAyB,CAAC;IACvD,MAAM,aAAa,GAAG,GAAG,EAAE,KAAK,CAAC,GAAG,CAAC,IAAI,EAAE;IAC3C,MAAM,kBAAkB,GAAG,CAAC,YAAY,EAAE,WAAW,EAAE,SAAS,EAAE,UAAU,CAAC;IAE7E,MAAM,oBAAoB,GAAG,aAAa,CAAC,GAAG,CAAC,SAAS,IAAG;;QAEzD,IAAI,SAAS,CAAC,QAAQ,CAAC,eAAyB,CAAC,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAAC,CAAC,IAAI,SAAS,CAAC,QAAQ,CAAC,CAAA,EAAG,CAAC,CAAA,CAAA,CAAG,CAAC,CAAC;AAC7G,YAAA,OAAO,SAAS;;AAGlB,QAAA,OAAO,CAAA,EAAG,SAAS,CAAA,CAAA,EAAI,eAAe,EAAE;AAC1C,IAAA,CAAC,CAAC;IAEF,MAAM,qBAAqB,GAAG;SAC3B,MAAM,CAAC,CAAC,IAAI,CAAC,oBAAoB,CAAC,IAAI,CAAC,SAAS,IAAI,SAAS,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAA,CAAA,CAAG,CAAC,CAAC;SAChF,GAAG,CAAC,CAAC,IAAI,CAAA,EAAG,CAAC,CAAA,QAAA,EAAW,eAAe,CAAA,CAAE,CAAC;AAE7C,IAAA,GAAG,CAAC,GAAG,CAAC,yBAAyB,EAAE,CAAC,GAAG,oBAAoB,EAAE,GAAG,qBAAqB,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AACnG;;ACZA,MAAM,cAAc,GAA4B;AAC9C,IAAA,MAAM,EAAE,OAAO;IACf,cAAc,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE;AAClD,IAAA,iBAAiB,EAAE,KAAK;AACxB,IAAA,qBAAqB,EAAE,KAAK;CAC7B;AAEa,MAAO,iBAAiB,CAAA;AAEjB,IAAA,MAAA;AACA,IAAA,kBAAA;AACA,IAAA,kBAAA;AAHnB,IAAA,WAAA,CACmB,MAAiC,EACjC,kBAA6B,EAC7B,kBAAsC,EAAA;QAFtC,IAAA,CAAA,MAAM,GAAN,MAAM;QACN,IAAA,CAAA,kBAAkB,GAAlB,kBAAkB;QAClB,IAAA,CAAA,kBAAkB,GAAlB,kBAAkB;IAClC;IAEH,OAAO,MAAM,CAAC,EACZ,MAAM,GAAG,OAAO,EAChB,kBAAkB,EAClB,oBAAoB,GAKrB,EAAA;AACC,QAAA,OAAO,IAAI,iBAAiB,CAC1B,MAAM,EACN,kBAAkB,EAClB,IAAI,kBAAkB,CAAC,MAAM,EAAE,kBAAkB,EAAE,oBAAoB,CAAC,CACzE;IACH;AAEA,IAAA,qBAAqB,CAAC,cAA8B,EAAA;AAClD,QAAA,MAAM,0BAA0B,GAAG;AACjC,YAAA,GAAG,cAAc;AACjB,YAAA,GAAG,cAAc;SAClB;AACD,QAAA,MAAM,EAAE,iBAAiB,EAAE,qBAAqB,EAAE,GAAG;AACnD,YAAA,GAAG,cAAc;AACjB,YAAA,GAAG,cAAc;SAClB;QAED,OAAO,OAAO,IAAa,EAAE,GAAa,EAAE,IAAkB,KAAI;AAChE,YAAA,MAAM,YAAY,GAAG,CAAC,IAAsB,KAAI;AAC9C,gBAAA,GAAG,CAAC,MAAM,CAAC,YAAY,GAAG;AACxB,oBAAA,MAAM,EAAE,iBAAiB,CAAC,IAAI,EAAE,0BAA0B,CAAC;AAC3D,oBAAA,MAAM,EAAE,iBAAiB,CAAC,IAAI,EAAE,0BAA0B,CAAC;AAC3D,oBAAA,WAAW,EAAE,EAAE;AACf,oBAAA,UAAU,EAAE,EAAE;iBACf;AACH,YAAA,CAAC;AAED,YAAA,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,EAAE;AACpB,gBAAA,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,4DAA4D,CAAC;gBAC9E,YAAY,CAAC,IAAI,CAAC;gBAClB,OAAO,IAAI,EAAE;YACf;YAEA,IAAI,qBAAqB,EAAE;AACzB,gBAAA,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,+CAA+C,CAAC;AACjE,gBAAA,YAAY,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC;gBAC7B,OAAO,IAAI,EAAE;YACf;AAEA,YAAA,IAAI;gBACF,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,IAAI,CAAC,kBAAkB,CAAC,aAAa,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,KAAe,CAAC;AAE7G,gBAAA,GAAG,CAAC,MAAM,CAAC,YAAY,GAAG;oBACxB,MAAM,EAAE,MAAM,CAAC,IAAI;oBACnB,MAAM,EAAE,MAAM,CAAC,IAAI;oBACnB,WAAW,EAAE,CAAC,GAAG,MAAM,CAAC,GAAG,EAAE,GAAG,MAAM,CAAC,GAAG,CAAC;oBAC3C,UAAU,EAAE,CAAC,GAAG,MAAM,CAAC,UAAU,EAAE,GAAG,MAAM,CAAC,UAAU,CAAC;iBACzD;gBAED,IAAI,iBAAiB,EAAE;oBACrB,GAAG,CAAC,MAAM,CAAC,YAAY,CAAC,UAAU,GAAG,IAAI;gBAC3C;gBAEA,SAAS,CAAC,IAAI,CAAC,kBAAkB,CAAC,GAAG,EAAE,GAAG,CAAC;gBAE3C,OAAO,IAAI,EAAE;YACf;YAAE,OAAO,MAAM,EAAE;AACf,gBAAA,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,0DAA0D,CAAC;AAC7E,gBAAA,YAAY,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC;gBAC7B,OAAO,IAAI,EAAE;YACf;AACF,QAAA,CAAC;IACH;AACD;;AC3Fa,MAAO,eAAgB,SAAQD,0BAAU,CAAA;AACrD,IAAA,WAAA,CAAY,MAAiC,EAAE,MAAiB,EAAE,oBAA0C,EAAA;QAC1G,KAAK,CAAC,mBAAmB,EAAE,MAAM,EAAE,MAAM,EAAE,oBAAoB,CAAC;IAClE;IAEA,MAAM,gBAAgB,CAAC,SAAiB,EAAA;QACtC,OAAO,IAAI,CAAC,GAAG,CACb;AACE,YAAA,IAAI,EAAE,yBAAyB;AAC/B,YAAA,KAAK,EAAE,EAAE,YAAY,EAAE,IAAI,EAAE;AAC9B,SAAA,EACDE,sBAAM,CAAC,SAAS,CAAC,CAClB;IACH;AACD;;ACZa,MAAO,eAAe,CAAA;AAEf,IAAA,MAAA;AACA,IAAA,eAAA;IAFnB,WAAA,CACmB,MAAiC,EACjC,eAAgC,EAAA;QADhC,IAAA,CAAA,MAAM,GAAN,MAAM;QACN,IAAA,CAAA,eAAe,GAAf,eAAe;IAC/B;IAEH,OAAO,MAAM,CAAC,EACZ,MAAM,GAAG,OAAO,EAChB,eAAe,EACf,oBAAoB,GAKrB,EAAA;AACC,QAAA,OAAO,IAAI,eAAe,CAAC,MAAM,EAAE,IAAI,eAAe,CAAC,MAAM,EAAE,eAAe,EAAE,oBAAoB,CAAC,CAAC;IACxG;IAEA,oBAAoB,GAAA;QAClB,OAAO,OAAO,GAAG,EAAE,GAAG,EAAE,IAAI,KAAI;YAC9B,IAAI,CAAC,GAAG,CAAC,OAAO;AAAE,gBAAA,MAAM,IAAI,KAAK,CAAC,oDAAoD,CAAC;YAEvF,IAAI,GAAG,CAAC,MAAM,CAAC,IAAI,IAAI,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,IAAI,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,UAAU,KAAK,OAAO,EAAE;AACtF,gBAAA,IAAI;;AAEF,oBAAA,IAAI,GAAG,CAAC,MAAM,CAAC,YAAY,IAAI,GAAG,CAAC,MAAM,CAAC,YAAY,CAAC,UAAU,EAAE;AACjE,wBAAA,GAAG,CAAC,OAAO,CAAC,SAAS,GAAG,GAAG,CAAC,MAAM,CAAC,YAAY,CAAC,UAAU,CAAC,SAAS;AACpE,wBAAA,GAAG,CAAC,OAAO,CAAC,cAAc,GAAG,GAAG,CAAC,MAAM,CAAC,YAAY,CAAC,UAAU,CAAC,cAAc;AAC9E,wBAAA,GAAG,CAAC,OAAO,CAAC,gBAAgB,GAAG,GAAG,CAAC,MAAM,CAAC,YAAY,CAAC,UAAU,CAAC,cAAc,EAAE,UAAU;oBAC9F;;AAGA,oBAAA,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,SAAS,EAAE;AAC1B,wBAAA,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAA,uDAAA,EAA0D,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAA,CAAE,CAAC;AACtG,wBAAA,MAAM,aAAa,GAAG,MAAM,IAAI,CAAC,eAAe,CAAC,gBAAgB,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC;AACxF,wBAAA,MAAM,SAAS,GAAG,aAAa,CAAC,MAAM,CAAC,QAAQ,IAAI,QAAQ,CAAC,IAAI,KAAK,KAAK,CAAC;AAC3E,wBAAA,MAAM,cAAc,GAAG,SAAS,CAAC,IAAI,CAAC,CAAC,QAAkB,KAAK,QAAQ,CAAC,eAAe,CAAC;AAEvF,wBAAA,GAAG,CAAC,OAAO,CAAC,SAAS,GAAG,SAAS;AACjC,wBAAA,GAAG,CAAC,OAAO,CAAC,cAAc,GAAG,cAAc;wBAC3C,GAAG,CAAC,OAAO,CAAC,gBAAgB,GAAG,cAAc,EAAE,UAAU;oBAC3D;;AAGA,oBAAA,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,SAAS,GAAG,GAAG,CAAC,OAAO,CAAC,SAAS;AACjD,oBAAA,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,cAAc,GAAG,GAAG,CAAC,OAAO,CAAC,cAAc;AAC3D,oBAAA,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,gBAAgB,GAAG,GAAG,CAAC,OAAO,CAAC,gBAAgB;gBACjE;gBAAE,OAAO,KAAK,EAAE;AACd,oBAAA,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,EAAE,CAAA,mCAAA,EAAsC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAA,CAAE,CAAC;AAC1F,oBAAA,OAAO,IAAI,CAAC,KAAK,CAAC;gBACpB;YACF;YAEA,OAAO,IAAI,EAAE;AACf,QAAA,CAAC;IACH;AACD;;ACzDa,MAAO,oBAAqB,SAAQF,0BAAU,CAAA;AAC1D,IAAA,WAAA,CAAY,MAAiC,EAAE,MAAiB,EAAE,oBAA0C,EAAA;QAC1G,KAAK,CAAC,wBAAwB,EAAE,MAAM,EAAE,MAAM,EAAE,oBAAoB,CAAC;IACvE;IAEA,MAAM,0BAA0B,CAAC,IAAgB,EAAA;QAC/C,OAAO,IAAI,CAAC,GAAG,CACb;YACE,IAAI,EAAE,YAAY,IAAI,CAAC,gBAAgB,CAAA,OAAA,EAAU,IAAI,CAAC,MAAM,CAAA,oBAAA,CAAsB;SACnF,EACDC,wBAAQ,EAAE,CACX;IACH;AACD;;ACba,MAAO,iBAAiB,CAAA;AAEjB,IAAA,MAAA;AACA,IAAA,oBAAA;IAFnB,WAAA,CACmB,MAAiC,EACjC,oBAA0C,EAAA;QAD1C,IAAA,CAAA,MAAM,GAAN,MAAM;QACN,IAAA,CAAA,oBAAoB,GAApB,oBAAoB;IACpC;IAEH,OAAO,MAAM,CAAC,EACZ,MAAM,GAAG,OAAO,EAChB,oBAAoB,EACpB,oBAAoB,GAKrB,EAAA;AACC,QAAA,OAAO,IAAI,iBAAiB,CAAC,MAAM,EAAE,IAAI,oBAAoB,CAAC,MAAM,EAAE,oBAAoB,EAAE,oBAAoB,CAAC,CAAC;IACpH;IAEO,qCAAqC,GAAA;QAC1C,OAAO,OAAO,GAAG,EAAE,GAAG,EAAE,IAAI,KAAI;YAC9B,IAAI,CAAC,GAAG,CAAC,OAAO;AAAE,gBAAA,MAAM,IAAI,KAAK,CAAC,yEAAyE,CAAC;AAC5G,YAAA,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK;AACxB,gBAAA,MAAM,IAAI,KAAK,CACb,yKAAyK,CAC1K;AAEH,YAAA,IAAI,GAAG,CAAC,MAAM,CAAC,IAAI,IAAI,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,UAAU,KAAK,OAAO,EAAE;AAC7D,gBAAA,IAAI;;AAEF,oBAAA,IAAI,GAAG,CAAC,MAAM,CAAC,YAAY,IAAI,GAAG,CAAC,MAAM,CAAC,YAAY,CAAC,UAAU,EAAE;AACjE,wBAAA,GAAG,CAAC,OAAO,CAAC,6BAA6B,GAAG,GAAG,CAAC,MAAM,CAAC,YAAY,CAAC,UAAU,CAAC,6BAA6B;oBAC9G;;AAGA,oBAAA,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,6BAA6B,EAAE;AAC9C,wBAAA,IAAI,CAAC,MAAM,CAAC,IAAI,CACd,CAAA,sEAAA,EAAyE,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAA,CAAE,CACpG;AACD,wBAAA,MAAM,kBAAkB,GAAG,MAAM,IAAI,CAAC,oBAAoB,CAAC,0BAA0B,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC;wBACtG,GAAG,CAAC,OAAO,CAAC,6BAA6B,GAAG,kBAAkB,CAAC,QAAQ;oBACzE;;AAGA,oBAAA,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,6BAA6B,GAAG,GAAG,CAAC,OAAO,CAAC,6BAA6B;gBAC3F;gBAAE,OAAO,KAAK,EAAE;AACd,oBAAA,IAAI,CAAC,MAAM,CAAC,KAAK,CACf,KAAK,EACL,CAAA,wDAAA,EAA2D,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAA,CAAE,CACtF;AACD,oBAAA,OAAO,IAAI,CAAC,KAAK,CAAC;gBACpB;YACF;YAEA,OAAO,IAAI,EAAE;AACf,QAAA,CAAC;IACH;AACD;;;;;;"}

package/dist/index.d.ts

@@ -1,67 +1,153 @@
-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
-     *
-     * Adds stringified html for each component along with lists of css javascript links.
-     *
-     * Expects nunjucks and res.locals.user to be set up inline with the hmpps-template-typescript project
-     *
-     * @param requestOptions - config object for request
-     * @param requestOptions.dpsUrl - url to the dps homepage to be used in the header
-     * @param requestOptions.authUrl - if your service has users with non-nomis auth sources, pass in the url to the auth service for the home link
-     * @param requestOptions.supportUrl - if your service has users with non-nomis auth sources, pass in the support url for the support link
-     * @param requestOptions.environmentName - if you require environment tags on the fallback banner "DEV", "PRE-PRODUCTION" or "PRODUCTION" can be passed in
-     * @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;
-    /**
-     * Ensures that:
-     * - `res.locals.user.caseLoads`
-     * - `res.locals.user.activeCaseLoad`
-     * - `res.locals.user.activeCaseLoadId`
-     * are set for NOMIS users (or will propagate an error).  It will also attempt to cache in `req.session.caseLoads`,
-     * `req.session.activeCaseLoad` and `req.session.activeCaseLoadId` (this is so that extra requests to Prison 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 Prison 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
-     */
-    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;
+import { RequestHandler } from 'express';
+import { ApiConfig, AuthenticationClient, RestClient } from '@ministryofjustice/hmpps-rest-client';
+import Logger from 'bunyan';
+
+type ConnectDpsComponentLogger = Logger | typeof console;
+
+interface TimeoutOptions {
+    response: number;
+    deadline: number;
+}
+
+interface RequestOptions {
+    dpsUrl: string;
+    authUrl?: string;
+    supportUrl?: string;
+    environmentName?: 'DEV' | 'PRE-PRODUCTION' | 'PRODUCTION';
+    logger?: Logger | typeof console;
+    includeSharedData?: boolean;
+    useFallbacksByDefault?: boolean;
+    timeoutOptions?: TimeoutOptions;
+}
+
+declare function getFrontendComponents({ logger, componentApiConfig, authenticationClient, }: {
+    logger?: ConnectDpsComponentLogger;
+    componentApiConfig: ApiConfig;
+    authenticationClient: AuthenticationClient;
+}): (requestOptions: RequestOptions) => RequestHandler;
+
+type AvailableComponent = 'header' | 'footer';
+
+interface Component {
+    html: string;
+    css: string[];
+    javascript: string[];
+}
+
+interface CaseLoad {
+    caseLoadId: string;
+    description: string;
+    type: string;
+    caseloadFunction: string;
+    currentlyActive: boolean;
+}
+
+interface Service {
+    id: string;
+    heading: string;
+    description: string;
+    href: string;
+    navEnabled: boolean;
+}
+
+type AllocationJobResponsibility = 'KEY_WORKER' | 'PERSONAL_OFFICER';
+
+interface HeaderFooterSharedData {
+    activeCaseLoad?: CaseLoad;
+    caseLoads: CaseLoad[];
+    services: Service[];
+    allocationJobResponsibilities: AllocationJobResponsibility[];
+}
+interface ComponentsSharedData {
+    header: HeaderFooterSharedData;
+    footer: HeaderFooterSharedData;
+}
+
+type ComponentsApiResponse<T extends AvailableComponent[]> = Record<T[number], Component> & {
+    meta: ComponentsSharedData[T[number]];
 };
-export default _default;
+declare class ComponentApiClient extends RestClient {
+    constructor(logger: ConnectDpsComponentLogger, config: ApiConfig, authenticationClient: AuthenticationClient);
+    getComponents<T extends AvailableComponent[]>(userToken: string): Promise<ComponentsApiResponse<T>>;
+}
+
+declare class ComponentsService {
+    private readonly logger;
+    private readonly componentApiConfig;
+    private readonly componentApiClient;
+    constructor(logger: ConnectDpsComponentLogger, componentApiConfig: ApiConfig, componentApiClient: ComponentApiClient);
+    static create({ logger, componentApiConfig, authenticationClient, }: {
+        logger?: ConnectDpsComponentLogger;
+        componentApiConfig: ApiConfig;
+        authenticationClient: AuthenticationClient;
+    }): ComponentsService;
+    getFrontendComponents(requestOptions: RequestOptions): RequestHandler;
+}
+
+declare class PrisonApiClient extends RestClient {
+    constructor(logger: ConnectDpsComponentLogger, config: ApiConfig, authenticationClient: AuthenticationClient);
+    getUserCaseLoads(userToken: string): Promise<CaseLoad[]>;
+}
+
+declare class CaseLoadService {
+    private readonly logger;
+    private readonly prisonApiClient;
+    constructor(logger: ConnectDpsComponentLogger, prisonApiClient: PrisonApiClient);
+    static create({ logger, prisonApiConfig, authenticationClient, }: {
+        logger?: ConnectDpsComponentLogger;
+        prisonApiConfig: ApiConfig;
+        authenticationClient: AuthenticationClient;
+    }): CaseLoadService;
+    retrieveCaseLoadData(): RequestHandler;
+}
+
+type AuthSource = 'nomis' | 'delius' | 'external' | 'azuread';
+/**
+ * These are the details that all user types share.
+ */
+interface BaseUser {
+    authSource: AuthSource;
+    username: string;
+    userId: string;
+    name: string;
+    displayName: string;
+    token?: string;
+    backLink?: string;
+}
+/**
+ * Prison users are those that have a user account in NOMIS.
+ * HMPPS Auth automatically grants these users a `ROLE_PRISON` role.
+ * Prison users have an additional numerical staffId. The userId is
+ * a stringified version of the staffId. Some teams may need to separately
+ * retrieve the user case load (which prisons that a prison user has access
+ * to) and store it here, an example can be found in `hmpps-prisoner-profile`.
+ */
+interface PrisonUser extends BaseUser {
+    authSource: 'nomis';
+    staffId: number;
+    caseLoads: CaseLoad[];
+    activeCaseLoad?: CaseLoad;
+    activeCaseLoadId?: string;
+    allocationJobResponsibilities?: AllocationJobResponsibility[];
+}
+
+declare class AllocationsApiClient extends RestClient {
+    constructor(logger: ConnectDpsComponentLogger, config: ApiConfig, authenticationClient: AuthenticationClient);
+    getStaffAllocationPolicies(user: PrisonUser): Promise<{
+        policies: AllocationJobResponsibility[];
+    }>;
+}
+
+declare class AllocationService {
+    private readonly logger;
+    private readonly allocationsApiClient;
+    constructor(logger: ConnectDpsComponentLogger, allocationsApiClient: AllocationsApiClient);
+    static create({ logger, allocationsApiConfig, authenticationClient, }: {
+        logger?: ConnectDpsComponentLogger;
+        allocationsApiConfig: ApiConfig;
+        authenticationClient: AuthenticationClient;
+    }): AllocationService;
+    retrieveAllocationJobResponsibilities(): RequestHandler;
+}
+
+export { AllocationService, CaseLoadService, ComponentsService, getFrontendComponents };