@ministryofjustice/hmpps-mpop-frontend-components-lib 0.0.1

package/README.md

@@ -0,0 +1,2 @@
+# hmpps-mpop-frontend-components-lib
+MPoP front-end library

package/dist/MPoPComponents.d.ts

@@ -0,0 +1,10 @@
+import type { AuthOptions } from '@ministryofjustice/hmpps-rest-client';
+import type { AuthenticationClient } from '@ministryofjustice/hmpps-auth-clients';
+import type Logger from 'bunyan';
+import type { MPoPComponentsConfig } from './types/MPoPComponentsConfig';
+import type { LatestTierResponse } from './types/TierCalculation';
+export default class MPoPComponents {
+    private readonly tierApiRestClient;
+    constructor(authenticationClient: AuthenticationClient, config: MPoPComponentsConfig, logger?: Logger | Console);
+    getTierDetails(authOptions: AuthOptions | string, crn: string): Promise<LatestTierResponse>;
+}

package/dist/SuppressingRestClient.d.ts

@@ -0,0 +1,8 @@
+import type { RestClient, AuthOptions } from '@ministryofjustice/hmpps-rest-client';
+import type Logger from 'bunyan';
+export declare class SuppressingRestClient {
+    private readonly restClient;
+    private readonly logger;
+    constructor(restClient: RestClient, logger: Logger | Console);
+    get<T>(path: string, authOptions: AuthOptions | string): Promise<T | null>;
+}

package/dist/_all.scss

@@ -0,0 +1,4 @@
+// MPOP Frontend Components Library
+// Requires govuk-frontend to be imported first
+
+@import "./mpop/components/supervision-package/supervision-package";

package/dist/index.cjs.js

@@ -0,0 +1,54 @@
+'use strict';
+
+var hmppsRestClient = require('@ministryofjustice/hmpps-rest-client');
+
+class SuppressingRestClient {
+    constructor(restClient, logger) {
+        this.restClient = restClient;
+        this.logger = logger;
+    }
+    async get(path, authOptions) {
+        return this.restClient.get({
+            path,
+            errorHandler: (requestPath, method, error) => {
+                if (error.responseStatus === 404) {
+                    this.logger.debug(`API returned 404 (Not Found) for ${method}: ${requestPath}`);
+                    return null;
+                }
+                throw error;
+            },
+        }, authOptions);
+    }
+}
+
+class MPoPComponents {
+    constructor(authenticationClient, config, logger = console) {
+        this.tierApiRestClient = new SuppressingRestClient(new hmppsRestClient.RestClient('Tier API', config, logger, authenticationClient), logger);
+    }
+    async getTierDetails(authOptions, crn) {
+        var _a;
+        try {
+            const response = await this.tierApiRestClient.get(`/v3/crn/${crn}/tier`, authOptions);
+            if (!response) {
+                return {
+                    calculation: null,
+                    httpStatus: 404,
+                };
+            }
+            return {
+                calculation: response,
+                httpStatus: 200,
+            };
+        }
+        catch (error) {
+            const err = error;
+            return {
+                calculation: null,
+                httpStatus: (_a = err === null || err === void 0 ? void 0 : err.responseStatus) !== null && _a !== void 0 ? _a : 500,
+            };
+        }
+    }
+}
+
+exports.MPoPComponents = MPoPComponents;
+//# sourceMappingURL=index.cjs.js.map

package/dist/index.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.cjs.js","sources":["../src/SuppressingRestClient.ts","../src/MPoPComponents.ts"],"sourcesContent":[null,null],"names":["RestClient"],"mappings":";;;;MAGa,qBAAqB,CAAA;IAChC,WAAA,CACmB,UAAsB,EACtB,MAAwB,EAAA;QADxB,IAAA,CAAA,UAAU,GAAV,UAAU;QACV,IAAA,CAAA,MAAM,GAAN,MAAM;IACtB;AAEH,IAAA,MAAM,GAAG,CAAI,IAAY,EAAE,WAAiC,EAAA;AAC1D,QAAA,OAAO,IAAI,CAAC,UAAU,CAAC,GAAG,CACxB;YACE,IAAI;YACJ,YAAY,EAAE,CAAC,WAAW,EAAE,MAAM,EAAE,KAAK,KAAI;AAC3C,gBAAA,IAAI,KAAK,CAAC,cAAc,KAAK,GAAG,EAAE;oBAChC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAA,iCAAA,EAAoC,MAAM,CAAA,EAAA,EAAK,WAAW,CAAA,CAAE,CAAC;AAC/E,oBAAA,OAAO,IAAI;gBACb;AACA,gBAAA,MAAM,KAAK;YACb,CAAC;SACF,EACD,WAAW,CACZ;IACH;AACD;;ACfa,MAAO,cAAc,CAAA;AAGjC,IAAA,WAAA,CACE,oBAA0C,EAC1C,MAA4B,EAC5B,SAA2B,OAAO,EAAA;QAElC,IAAI,CAAC,iBAAiB,GAAG,IAAI,qBAAqB,CAChD,IAAIA,0BAAU,CAAC,UAAU,EAAE,MAAM,EAAE,MAAM,EAAE,oBAAoB,CAAC,EAChE,MAAM,CACP;IACH;AAEA,IAAA,MAAM,cAAc,CAAC,WAAiC,EAAE,GAAW,EAAA;;AACjE,QAAA,IAAI;AACF,YAAA,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,iBAAiB,CAAC,GAAG,CAAa,WAAW,GAAG,CAAA,KAAA,CAAO,EAAE,WAAW,CAAC;YAEjG,IAAI,CAAC,QAAQ,EAAE;gBACb,OAAO;AACL,oBAAA,WAAW,EAAE,IAAI;AACjB,oBAAA,UAAU,EAAE,GAAG;iBAChB;YACH;YAEA,OAAO;AACL,gBAAA,WAAW,EAAE,QAAQ;AACrB,gBAAA,UAAU,EAAE,GAAG;aAChB;QACH;QAAE,OAAO,KAAK,EAAE;YACd,MAAM,GAAG,GAAG,KAEJ;YAER,OAAO;AACL,gBAAA,WAAW,EAAE,IAAI;gBACjB,UAAU,EAAE,CAAA,EAAA,GAAA,GAAG,KAAA,IAAA,IAAH,GAAG,uBAAH,GAAG,CAAE,cAAc,MAAA,IAAA,IAAA,EAAA,KAAA,MAAA,GAAA,EAAA,GAAI,GAAG;aACvC;QACH;IACF;AACD;;;;"}

package/dist/index.d.ts

@@ -0,0 +1,27 @@
+import { ApiConfig, AuthOptions } from '@ministryofjustice/hmpps-rest-client';
+import { AuthenticationClient } from '@ministryofjustice/hmpps-auth-clients';
+import Logger from 'bunyan';
+
+interface MPoPComponentsConfig extends ApiConfig {
+}
+
+type LatestTier = {
+    tierScore: string;
+    calculationId: string;
+    calculationDate: string;
+    changeReason: string;
+    provisional: boolean;
+};
+type LatestTierResponse = {
+    calculation: LatestTier | null;
+    httpStatus: number;
+};
+
+declare class MPoPComponents {
+    private readonly tierApiRestClient;
+    constructor(authenticationClient: AuthenticationClient, config: MPoPComponentsConfig, logger?: Logger | Console);
+    getTierDetails(authOptions: AuthOptions | string, crn: string): Promise<LatestTierResponse>;
+}
+
+export { MPoPComponents };
+export type { MPoPComponentsConfig };

package/dist/index.esm.js

@@ -0,0 +1,52 @@
+import { RestClient } from '@ministryofjustice/hmpps-rest-client';
+
+class SuppressingRestClient {
+    constructor(restClient, logger) {
+        this.restClient = restClient;
+        this.logger = logger;
+    }
+    async get(path, authOptions) {
+        return this.restClient.get({
+            path,
+            errorHandler: (requestPath, method, error) => {
+                if (error.responseStatus === 404) {
+                    this.logger.debug(`API returned 404 (Not Found) for ${method}: ${requestPath}`);
+                    return null;
+                }
+                throw error;
+            },
+        }, authOptions);
+    }
+}
+
+class MPoPComponents {
+    constructor(authenticationClient, config, logger = console) {
+        this.tierApiRestClient = new SuppressingRestClient(new RestClient('Tier API', config, logger, authenticationClient), logger);
+    }
+    async getTierDetails(authOptions, crn) {
+        var _a;
+        try {
+            const response = await this.tierApiRestClient.get(`/v3/crn/${crn}/tier`, authOptions);
+            if (!response) {
+                return {
+                    calculation: null,
+                    httpStatus: 404,
+                };
+            }
+            return {
+                calculation: response,
+                httpStatus: 200,
+            };
+        }
+        catch (error) {
+            const err = error;
+            return {
+                calculation: null,
+                httpStatus: (_a = err === null || err === void 0 ? void 0 : err.responseStatus) !== null && _a !== void 0 ? _a : 500,
+            };
+        }
+    }
+}
+
+export { MPoPComponents };
+//# sourceMappingURL=index.esm.js.map

package/dist/index.esm.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.esm.js","sources":["../src/SuppressingRestClient.ts","../src/MPoPComponents.ts"],"sourcesContent":[null,null],"names":[],"mappings":";;MAGa,qBAAqB,CAAA;IAChC,WAAA,CACmB,UAAsB,EACtB,MAAwB,EAAA;QADxB,IAAA,CAAA,UAAU,GAAV,UAAU;QACV,IAAA,CAAA,MAAM,GAAN,MAAM;IACtB;AAEH,IAAA,MAAM,GAAG,CAAI,IAAY,EAAE,WAAiC,EAAA;AAC1D,QAAA,OAAO,IAAI,CAAC,UAAU,CAAC,GAAG,CACxB;YACE,IAAI;YACJ,YAAY,EAAE,CAAC,WAAW,EAAE,MAAM,EAAE,KAAK,KAAI;AAC3C,gBAAA,IAAI,KAAK,CAAC,cAAc,KAAK,GAAG,EAAE;oBAChC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAA,iCAAA,EAAoC,MAAM,CAAA,EAAA,EAAK,WAAW,CAAA,CAAE,CAAC;AAC/E,oBAAA,OAAO,IAAI;gBACb;AACA,gBAAA,MAAM,KAAK;YACb,CAAC;SACF,EACD,WAAW,CACZ;IACH;AACD;;ACfa,MAAO,cAAc,CAAA;AAGjC,IAAA,WAAA,CACE,oBAA0C,EAC1C,MAA4B,EAC5B,SAA2B,OAAO,EAAA;QAElC,IAAI,CAAC,iBAAiB,GAAG,IAAI,qBAAqB,CAChD,IAAI,UAAU,CAAC,UAAU,EAAE,MAAM,EAAE,MAAM,EAAE,oBAAoB,CAAC,EAChE,MAAM,CACP;IACH;AAEA,IAAA,MAAM,cAAc,CAAC,WAAiC,EAAE,GAAW,EAAA;;AACjE,QAAA,IAAI;AACF,YAAA,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,iBAAiB,CAAC,GAAG,CAAa,WAAW,GAAG,CAAA,KAAA,CAAO,EAAE,WAAW,CAAC;YAEjG,IAAI,CAAC,QAAQ,EAAE;gBACb,OAAO;AACL,oBAAA,WAAW,EAAE,IAAI;AACjB,oBAAA,UAAU,EAAE,GAAG;iBAChB;YACH;YAEA,OAAO;AACL,gBAAA,WAAW,EAAE,QAAQ;AACrB,gBAAA,UAAU,EAAE,GAAG;aAChB;QACH;QAAE,OAAO,KAAK,EAAE;YACd,MAAM,GAAG,GAAG,KAEJ;YAER,OAAO;AACL,gBAAA,WAAW,EAAE,IAAI;gBACjB,UAAU,EAAE,CAAA,EAAA,GAAA,GAAG,KAAA,IAAA,IAAH,GAAG,uBAAH,GAAG,CAAE,cAAc,MAAA,IAAA,IAAA,EAAA,KAAA,MAAA,GAAA,EAAA,GAAI,GAAG;aACvC;QACH;IACF;AACD;;;;"}

package/dist/mpop/components/supervision-package/_supervision-package.scss

@@ -0,0 +1,22 @@
+$supervision-package-border-colour: govuk-colour("mid-grey");
+$supervision-package-accent-colour: govuk-colour("blue");
+
+.supervision-package {
+  border-top: 5px solid $supervision-package-accent-colour;
+  border-right: 1px solid $supervision-package-border-colour;
+  border-bottom: 1px solid $supervision-package-border-colour;
+  border-left: 1px solid $supervision-package-border-colour;
+
+  padding-top: govuk-spacing(4);
+  padding-right: govuk-spacing(4);
+  padding-left: govuk-spacing(4);
+
+  margin-bottom: govuk-spacing(6);
+}
+
+.app-tier-header {
+  display: flex;
+  align-items: center;
+  gap: govuk-spacing(2);
+  margin-bottom: govuk-spacing(3);
+}

package/dist/mpop/components/supervision-package/macro.njk

@@ -0,0 +1,3 @@
+{% macro supervisionPackage(params) %}
+    {% include "./template.njk" %}
+{% endmacro %}

package/dist/mpop/components/supervision-package/template.njk

@@ -0,0 +1,31 @@
+<div class="govuk-width-container supervision-package">
+    <h2 class="govuk-heading-m">{{ params.heading or "Supervision package" }}</h2>
+
+    <div class="govuk-grid-row">
+        <div class="govuk-grid-column-two-thirds">
+            <div class="app-tier-header">
+                <h3 class="govuk-heading-s govuk-!-margin-bottom-0">
+                    Tier {{ params.tierScore }}
+                </h3>
+
+                {% if params.provisional %}
+                    <strong class="govuk-tag govuk-tag--orange">Provisional</strong>
+                {% endif %}
+            </div>
+
+            {% if params.provisional %}
+                <p class="govuk-body">
+                    We will calculate the supervision package once the tier is confirmed.
+                </p>
+            {% endif %}
+
+            {% if params.historyHref %}
+                <p class="govuk-body">
+                    <a href="{{ params.historyHref }}" class="govuk-link govuk-link--no-visited-state">
+                        {{ params.historyText or "View tier change history" }}
+                    </a>
+                </p>
+            {% endif %}
+        </div>
+    </div>
+</div>

package/dist/types/MPoPComponentsConfig.d.ts

@@ -0,0 +1,3 @@
+import type { ApiConfig } from '@ministryofjustice/hmpps-rest-client';
+export interface MPoPComponentsConfig extends ApiConfig {
+}

package/dist/types/TierCalculation.d.ts

@@ -0,0 +1,11 @@
+export type LatestTier = {
+    tierScore: string;
+    calculationId: string;
+    calculationDate: string;
+    changeReason: string;
+    provisional: boolean;
+};
+export type LatestTierResponse = {
+    calculation: LatestTier | null;
+    httpStatus: number;
+};

package/package.json

@@ -0,0 +1,96 @@
+{
+  "name": "@ministryofjustice/hmpps-mpop-frontend-components-lib",
+  "version": "0.0.1",
+  "description": "MPOP front-end components library",
+  "main": "./dist/index.cjs.js",
+  "module": "./dist/index.esm.js",
+  "types": "./dist/index.d.ts",
+  "sass": "./dist/_all.scss",
+  "files": [
+    "dist/**/*"
+  ],
+  "scripts": {
+    "prepare": "hmpps-precommit-hooks-prepare",
+    "build": "rollup -c rollup.config.ts --bundleConfigAsCjs",
+    "clean": "rm -rf ./dist/ && find . -name '.eslintcache' -delete",
+    "test": "jest",
+    "test:coverage": "jest --coverage",
+    "test:ci": "jest --runInBand --passWithNoTests",
+    "typecheck": "tsc --noEmit",
+    "lint": "eslint . --cache --max-warnings 0",
+    "lint:fix": "eslint . --cache --max-warnings 0 --fix",
+    "security_audit": "npx audit-ci --config audit-ci.json",
+    "setup": "npm ci && hmpps-npm-script-run-allowlist",
+    "preview": "tsx scripts/preview.ts",
+    "preview:api": "tsx scripts/preview-api.ts"
+  },
+  "lint-staged": {
+    "*.{ts,css}": [
+      "prettier --write",
+      "eslint --fix"
+    ],
+    "*.json": [
+      "prettier --write"
+    ]
+  },
+  "jest": {
+    "transform": {
+      "^.+\\.(ts|js|mjs|tsx|jsx)$": "babel-jest"
+    },
+    "transformIgnorePatterns": [
+      "/node_modules/(?!(@exodus|@csstools|jsdom|parse5|abab|entities|nunjucks|@asamuzakjp)/)"
+    ],
+    "testMatch": [
+      "<rootDir>/**/**/?(*.)(cy|test).{ts,js,jsx,mjs}"
+    ],
+    "testEnvironment": "node",
+    "moduleFileExtensions": [
+      "web.js",
+      "js",
+      "json",
+      "node",
+      "ts"
+    ]
+  },
+  "keywords": [],
+  "author": "",
+  "license": "ISC",
+  "devDependencies": {
+    "@babel/core": "^7.29.7",
+    "@babel/preset-env": "^7.29.7",
+    "@babel/preset-typescript": "^7.29.7",
+    "@ministryofjustice/eslint-config-hmpps": "1.0.3",
+    "@ministryofjustice/hmpps-npm-script-allowlist": "0.0.6",
+    "@ministryofjustice/hmpps-precommit-hooks": "3.0.1",
+    "@rollup/plugin-node-resolve": "^16.0.3",
+    "@rollup/plugin-typescript": "^12.3.0",
+    "@types/bunyan": "^1.8.11",
+    "@types/jest": "^30.0.0",
+    "@types/jsdom": "^28.0.3",
+    "@types/node": "25.9.1",
+    "@typescript-eslint/eslint-plugin": "8.60.1",
+    "babel-jest": "^30.4.1",
+    "dotenv": "17.4.2",
+    "eslint-import-resolver-typescript": "4.4.5",
+    "eslint-plugin-no-only-tests": "3.4.0",
+    "govuk-frontend": "^6.2.0",
+    "jest": "^30.4.2",
+    "jsdom": "^29.1.1",
+    "lint-staged": "17.0.7",
+    "nunjucks": "^3.2.4",
+    "prettier": "3.8.3",
+    "rollup": "^4.61.1",
+    "rollup-plugin-copy": "3.5.0",
+    "rollup-plugin-dts": "^6.4.1",
+    "tslib": "^2.8.1",
+    "tsx": "4.22.4",
+    "typescript": "^6.0.3"
+  },
+  "type": "commonjs",
+  "dependencies": {
+    "@ministryofjustice/hmpps-auth-clients": "^1.0.2",
+    "@ministryofjustice/hmpps-rest-client": "^1.2.1",
+    "@types/nunjucks": "3.2.6",
+    "sass": "^1.100.0"
+  }
+}