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

package/README.md

@@ -0,0 +1,2 @@
+# hmpps-arns-frontend-components-lib
+ARNS front-end library for risk score visualisations

package/dist/ArnsComponents.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 { ArnsComponentsConfig } from './types/ArnsComponentsConfig';
+import type { RiskData } from './types/RiskData';
+export default class ArnsComponents {
+    private readonly restClient;
+    constructor(authenticationClient: AuthenticationClient, config: ArnsComponentsConfig, logger?: Logger | Console);
+    getRiskData(authOptions: AuthOptions | string, identifierType: string, identifierValue: string): Promise<RiskData>;
+}

package/dist/_all.scss

@@ -0,0 +1,5 @@
+// ARNS Frontend Components Library
+// Import this file into your project's main SCSS file
+// Requires govuk-frontend to be imported first
+
+@import "./arns/components/badge/predictor-badge";

package/dist/arns/components/badge/_predictor-badge.scss

@@ -0,0 +1,66 @@
+$very-high-score-colour: #942514;
+$very-high-score-colour--light: #ffac9f;
+$very-high-score-colour__text: #711a0d;
+$high-score-colour: #d4351c;
+$high-score-colour--light: #f6d7d2;
+$high-score-colour__text: #942514;
+$medium-score-colour: #f47738;
+$medium-score-colour--light: #f9e8bd;
+$medium-score-colour__text: #a34e00;
+$low-score-colour: #85994b;
+$low-score-colour--light: #dee9bd;
+$low-score-colour__text: #485b10;
+
+@mixin predictor-badge-base($primary-colour, $secondary-colour, $text-colour) {
+  display: inline-flex;
+  outline: 2px solid $primary-colour;
+
+  & .predictor-badge__type_and_level {
+    @include govuk-font(19, "regular");
+    color: $text-colour;
+
+    padding: 2px 10px;
+  }
+
+  & .predictor-badge__score {
+    @include govuk-font(19, "bold");
+    color: govuk-colour("black");
+
+    background-color: $secondary-colour;
+    border-left: 2px solid $primary-colour;
+
+    padding: 2px 2px;
+    align-content: center;
+  }
+
+  & .predictor-badge__static_or_dynamic {
+    @include govuk-font(19, "regular");
+    color: #282D30;
+
+    background-color: #E5E6E7;
+    border-left: 2px solid $primary-colour;
+
+    padding: 2px 2px;
+    align-content: center;
+  }
+}
+
+.predictor-badge--very-high {
+  @include predictor-badge-base(
+      $very-high-score-colour,
+      $very-high-score-colour--light,
+      $very-high-score-colour__text
+  );
+}
+
+.predictor-badge--high {
+  @include predictor-badge-base($high-score-colour, $high-score-colour--light, $high-score-colour__text);
+}
+
+.predictor-badge--medium {
+  @include predictor-badge-base($medium-score-colour, $medium-score-colour--light, $medium-score-colour__text);
+}
+
+.predictor-badge--low {
+  @include predictor-badge-base($low-score-colour, $low-score-colour--light, $low-score-colour__text);
+}

package/dist/arns/components/badge/macro.njk

@@ -0,0 +1,25 @@
+{#
+ARNS Predictor Badge Component
+
+Displays risk predictor score badges.
+
+Usage:
+  In route handler:
+    const riskData = await arnsComponents.getRiskData(token, 'crn', 'X123456')
+    res.render('page', { riskData })
+
+  In template:
+    {% from "components/badge/macro.njk" import predictorBadge %}
+    {{ predictorBadge({ data: riskData }) }}
+
+  With options:
+    {{ predictorBadge({ data: riskData, showScore: true }) }}
+
+@param {object} params
+@param {RiskData} params.data - Risk data from ArnsComponents.getRiskData()
+@param {boolean} [params.showScore=false] - Whether to display the percentage score
+@param {string} [params.classes] - Additional CSS classes
+#}
+{% macro predictorBadge(params) %}
+  {%- include "./template.njk" -%}
+{% endmacro %}

package/dist/arns/components/badge/template.njk

@@ -0,0 +1,59 @@
+{#
+  ARNS Predictor Badge Component
+
+  Displays risk predictor score badges.
+
+  Usage:
+    In route handler:
+      const riskData = await arnsComponents.getRiskData(token, 'crn', 'X123456')
+      res.render('page', { riskData })
+
+    In template:
+      {% from "components/badge/macro.njk" import predictorBadge %}
+      {{ predictorBadge({ data: riskData }) }}
+
+    With options:
+      {{ predictorBadge({ data: riskData, showScore: true }) }}
+
+  @param {object} params
+  @param {RiskData} params.data - Risk data from ArnsComponents.getRiskData()
+  @param {boolean} [params.showScore=false] - Whether to display the percentage score
+  @param {string} [params.classes] - Additional CSS classes
+#}
+
+{% set badges = params.data.badges if params.data else [] %}
+{% set showScore = params.showScore if params.showScore else false %}
+
+{% if badges and badges.length %}
+<div class="predictor-badges{% if params.classes %} {{ params.classes }}{% endif %}">
+  {% for entry in badges %}
+    {% for key, predictor in entry %}
+      {% if predictor %}
+        {% set badgeClass = '' %}
+        {% switch predictor.level %}
+          {% case 'VERY_HIGH' %}
+            {% set badgeClass = 'predictor-badge--very-high' %}
+          {% case 'HIGH' %}
+            {% set badgeClass = 'predictor-badge--high' %}
+          {% case 'MEDIUM' %}
+            {% set badgeClass = 'predictor-badge--medium' %}
+          {% case 'LOW' %}
+            {% set badgeClass = 'predictor-badge--low' %}
+        {% endswitch %}
+
+        <div class="{{ badgeClass }}">
+          <span class="predictor-badge__type_and_level">{{ predictor.type | upper }} <strong>{{ predictor.level | replace('_', ' ') }}</strong></span>
+
+          {% if showScore and predictor.score %}
+            <span class="predictor-badge__score">{{ predictor.score }}%</span>
+          {% endif %}
+
+          {% if predictor.staticOrDynamic %}
+            <span class="predictor-badge__static_or_dynamic">{{ predictor.staticOrDynamic | capitalize }}</span>
+          {% endif %}
+        </div>
+      {% endif %}
+    {% endfor %}
+  {% endfor %}
+</div>
+{% endif %}

package/dist/components/badge/transformation.d.ts

@@ -0,0 +1,3 @@
+import { AllPredictorVersionedDto } from '../../types/dtos/allPredictorVersionedDto';
+import { BadgeEntry } from '../../types/badgeData';
+export declare function transformBadgeData(dto: AllPredictorVersionedDto[]): BadgeEntry[];

package/dist/index.cjs.js

@@ -0,0 +1,187 @@
+'use strict';
+
+var hmppsRestClient = require('@ministryofjustice/hmpps-rest-client');
+
+function transformBadgeData(dto) {
+    const badgeEntries = [];
+    dto.forEach(listEntry => {
+        if (listEntry.outputVersion === '1') {
+            const ogrs3 = listEntry.output.groupReconvictionScore;
+            const ovp = listEntry.output.violencePredictorScore;
+            const ogp = listEntry.output.generalPredictorScore;
+            const rsr = listEntry.output.riskOfSeriousRecidivismScore;
+            const osp = listEntry.output.sexualPredictorScore;
+            if (ogrs3) {
+                const entry = {
+                    ogrs3PredictorScore: {
+                        level: ogrs3.scoreLevel,
+                        score: ogrs3.twoYears,
+                        type: 'OGRS3',
+                        staticOrDynamic: null,
+                        completedDate: listEntry.completedDate.toString(),
+                    },
+                };
+                badgeEntries.push(entry);
+            }
+            if (ovp) {
+                const entry = {
+                    ovpPredictorScore: {
+                        level: ovp.ovpRisk,
+                        score: ovp.twoYears,
+                        type: 'OVP',
+                        staticOrDynamic: null,
+                        completedDate: listEntry.completedDate.toString(),
+                    },
+                };
+                badgeEntries.push(entry);
+            }
+            if (ogp) {
+                const entry = {
+                    ogpPredictorScore: {
+                        level: ogp.ogpRisk,
+                        score: ogp.ogp2Year,
+                        type: 'OGP',
+                        staticOrDynamic: null,
+                        completedDate: listEntry.completedDate.toString(),
+                    },
+                };
+                badgeEntries.push(entry);
+            }
+            if (rsr) {
+                const entry = {
+                    rsrPredictorScore: {
+                        level: rsr.scoreLevel,
+                        score: rsr.percentageScore,
+                        type: 'RSR',
+                        staticOrDynamic: rsr.staticOrDynamic,
+                        completedDate: listEntry.completedDate.toString(),
+                    },
+                };
+                badgeEntries.push(entry);
+            }
+            if (osp) {
+                const entry = {
+                    ospdcPredictorScore: {
+                        level: osp.ospIndecentScoreLevel,
+                        score: osp.ospIndecentPercentageScore,
+                        type: 'OSP/DC',
+                        staticOrDynamic: null,
+                        completedDate: listEntry.completedDate.toString(),
+                    },
+                };
+                badgeEntries.push(entry);
+            }
+            if (osp) {
+                const entry = {
+                    ospiicPredictorScore: {
+                        level: osp.ospIndecentScoreLevel,
+                        score: osp.ospIndecentPercentageScore,
+                        type: 'OSP/IIC',
+                        staticOrDynamic: null,
+                        completedDate: listEntry.completedDate.toString(),
+                    },
+                };
+                badgeEntries.push(entry);
+            }
+        }
+        else if (listEntry.outputVersion === '2') {
+            const ogrs4 = listEntry.output.allReoffendingPredictor;
+            const ovp2 = listEntry.output.violentReoffendingPredictor;
+            const snsv = listEntry.output.seriousViolentReoffendingPredictor;
+            const ospdc = listEntry.output.directContactSexualReoffendingPredictor;
+            const ospiic = listEntry.output.indirectImageContactSexualReoffendingPredictor;
+            const rsr = listEntry.output.combinedSeriousReoffendingPredictor;
+            if (ogrs4) {
+                const entry = {
+                    allReoffendingPredictor: {
+                        level: ogrs4.band,
+                        score: ogrs4.score,
+                        type: 'All reoffending predictor',
+                        staticOrDynamic: ogrs4.staticOrDynamic,
+                        completedDate: listEntry.completedDate.toString(),
+                    },
+                };
+                badgeEntries.push(entry);
+            }
+            if (ovp2) {
+                const entry = {
+                    violentReoffendingPredictor: {
+                        level: ovp2.band,
+                        score: ovp2.score,
+                        type: 'Violent reoffending predictor',
+                        staticOrDynamic: ovp2.staticOrDynamic,
+                        completedDate: listEntry.completedDate.toString(),
+                    },
+                };
+                badgeEntries.push(entry);
+            }
+            if (snsv) {
+                const entry = {
+                    seriousViolentReoffendingPredictor: {
+                        level: snsv.band,
+                        score: snsv.score,
+                        type: 'Serious violent reoffending predictor',
+                        staticOrDynamic: snsv.staticOrDynamic,
+                        completedDate: listEntry.completedDate.toString(),
+                    },
+                };
+                badgeEntries.push(entry);
+            }
+            if (ospdc) {
+                const entry = {
+                    directContactSexualReoffendingPredictor: {
+                        level: ospdc.band,
+                        score: ospdc.score,
+                        type: 'Direct contact sexual reoffending predictor',
+                        staticOrDynamic: null,
+                        completedDate: listEntry.completedDate.toString(),
+                    },
+                };
+                badgeEntries.push(entry);
+            }
+            if (ospiic) {
+                const entry = {
+                    indirectImageContactSexualReoffendingPredictor: {
+                        level: ospiic.band,
+                        score: ospiic.score,
+                        type: 'Indirect image contact sexual reoffending predictor',
+                        staticOrDynamic: null,
+                        completedDate: listEntry.completedDate.toString(),
+                    },
+                };
+                badgeEntries.push(entry);
+            }
+            if (rsr) {
+                const entry = {
+                    combinedSeriousReoffendingPredictor: {
+                        level: rsr.band,
+                        score: rsr.score,
+                        type: 'Combined serious reoffending predictor',
+                        staticOrDynamic: rsr.staticOrDynamic,
+                        completedDate: listEntry.completedDate.toString(),
+                    },
+                };
+                badgeEntries.push(entry);
+            }
+        }
+        else
+            throw new Error('unexpected version');
+    });
+    return badgeEntries;
+}
+
+class ArnsComponents {
+    constructor(authenticationClient, config, logger = console) {
+        this.restClient = new hmppsRestClient.RestClient('ARNS API', config, logger, authenticationClient);
+    }
+    async getRiskData(authOptions, identifierType, identifierValue) {
+        const response = await this.restClient.get({ path: `/risks/predictors/all/${identifierType}/${identifierValue}` }, authOptions);
+        return {
+            badges: transformBadgeData(response),
+            raw: response,
+        };
+    }
+}
+
+exports.ArnsComponents = ArnsComponents;
+//# sourceMappingURL=index.cjs.js.map

package/dist/index.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.cjs.js","sources":["../src/components/badge/transformation.ts","../src/ArnsComponents.ts"],"sourcesContent":[null,null],"names":["RestClient"],"mappings":";;;;AAGM,SAAU,kBAAkB,CAAC,GAA+B,EAAA;IAChE,MAAM,YAAY,GAAiB,EAAE;AAErC,IAAA,GAAG,CAAC,OAAO,CAAC,SAAS,IAAG;AACtB,QAAA,IAAI,SAAS,CAAC,aAAa,KAAK,GAAG,EAAE;AACnC,YAAA,MAAM,KAAK,GAAG,SAAS,CAAC,MAAM,CAAC,sBAAsB;AACrD,YAAA,MAAM,GAAG,GAAG,SAAS,CAAC,MAAM,CAAC,sBAAsB;AACnD,YAAA,MAAM,GAAG,GAAG,SAAS,CAAC,MAAM,CAAC,qBAAqB;AAClD,YAAA,MAAM,GAAG,GAAG,SAAS,CAAC,MAAM,CAAC,4BAA4B;AACzD,YAAA,MAAM,GAAG,GAAG,SAAS,CAAC,MAAM,CAAC,oBAAoB;YAEjD,IAAI,KAAK,EAAE;AACT,gBAAA,MAAM,KAAK,GAAe;AACxB,oBAAA,mBAAmB,EAAE;wBACnB,KAAK,EAAE,KAAK,CAAC,UAAU;wBACvB,KAAK,EAAE,KAAK,CAAC,QAAQ;AACrB,wBAAA,IAAI,EAAE,OAAO;AACb,wBAAA,eAAe,EAAE,IAAI;AACrB,wBAAA,aAAa,EAAE,SAAS,CAAC,aAAa,CAAC,QAAQ,EAAE;AAClD,qBAAA;iBACF;AACD,gBAAA,YAAY,CAAC,IAAI,CAAC,KAAK,CAAC;YAC1B;YAEA,IAAI,GAAG,EAAE;AACP,gBAAA,MAAM,KAAK,GAAe;AACxB,oBAAA,iBAAiB,EAAE;wBACjB,KAAK,EAAE,GAAG,CAAC,OAAO;wBAClB,KAAK,EAAE,GAAG,CAAC,QAAQ;AACnB,wBAAA,IAAI,EAAE,KAAK;AACX,wBAAA,eAAe,EAAE,IAAI;AACrB,wBAAA,aAAa,EAAE,SAAS,CAAC,aAAa,CAAC,QAAQ,EAAE;AAClD,qBAAA;iBACF;AACD,gBAAA,YAAY,CAAC,IAAI,CAAC,KAAK,CAAC;YAC1B;YAEA,IAAI,GAAG,EAAE;AACP,gBAAA,MAAM,KAAK,GAAe;AACxB,oBAAA,iBAAiB,EAAE;wBACjB,KAAK,EAAE,GAAG,CAAC,OAAO;wBAClB,KAAK,EAAE,GAAG,CAAC,QAAQ;AACnB,wBAAA,IAAI,EAAE,KAAK;AACX,wBAAA,eAAe,EAAE,IAAI;AACrB,wBAAA,aAAa,EAAE,SAAS,CAAC,aAAa,CAAC,QAAQ,EAAE;AAClD,qBAAA;iBACF;AACD,gBAAA,YAAY,CAAC,IAAI,CAAC,KAAK,CAAC;YAC1B;YAEA,IAAI,GAAG,EAAE;AACP,gBAAA,MAAM,KAAK,GAAe;AACxB,oBAAA,iBAAiB,EAAE;wBACjB,KAAK,EAAE,GAAG,CAAC,UAAU;wBACrB,KAAK,EAAE,GAAG,CAAC,eAAe;AAC1B,wBAAA,IAAI,EAAE,KAAK;wBACX,eAAe,EAAE,GAAG,CAAC,eAAe;AACpC,wBAAA,aAAa,EAAE,SAAS,CAAC,aAAa,CAAC,QAAQ,EAAE;AAClD,qBAAA;iBACF;AACD,gBAAA,YAAY,CAAC,IAAI,CAAC,KAAK,CAAC;YAC1B;YAEA,IAAI,GAAG,EAAE;AACP,gBAAA,MAAM,KAAK,GAAe;AACxB,oBAAA,mBAAmB,EAAE;wBACnB,KAAK,EAAE,GAAG,CAAC,qBAAqB;wBAChC,KAAK,EAAE,GAAG,CAAC,0BAA0B;AACrC,wBAAA,IAAI,EAAE,QAAQ;AACd,wBAAA,eAAe,EAAE,IAAI;AACrB,wBAAA,aAAa,EAAE,SAAS,CAAC,aAAa,CAAC,QAAQ,EAAE;AAClD,qBAAA;iBACF;AACD,gBAAA,YAAY,CAAC,IAAI,CAAC,KAAK,CAAC;YAC1B;YAEA,IAAI,GAAG,EAAE;AACP,gBAAA,MAAM,KAAK,GAAe;AACxB,oBAAA,oBAAoB,EAAE;wBACpB,KAAK,EAAE,GAAG,CAAC,qBAAqB;wBAChC,KAAK,EAAE,GAAG,CAAC,0BAA0B;AACrC,wBAAA,IAAI,EAAE,SAAS;AACf,wBAAA,eAAe,EAAE,IAAI;AACrB,wBAAA,aAAa,EAAE,SAAS,CAAC,aAAa,CAAC,QAAQ,EAAE;AAClD,qBAAA;iBACF;AACD,gBAAA,YAAY,CAAC,IAAI,CAAC,KAAK,CAAC;YAC1B;QACF;AAAO,aAAA,IAAI,SAAS,CAAC,aAAa,KAAK,GAAG,EAAE;AAC1C,YAAA,MAAM,KAAK,GAAG,SAAS,CAAC,MAAM,CAAC,uBAAuB;AACtD,YAAA,MAAM,IAAI,GAAG,SAAS,CAAC,MAAM,CAAC,2BAA2B;AACzD,YAAA,MAAM,IAAI,GAAG,SAAS,CAAC,MAAM,CAAC,kCAAkC;AAChE,YAAA,MAAM,KAAK,GAAG,SAAS,CAAC,MAAM,CAAC,uCAAuC;AACtE,YAAA,MAAM,MAAM,GAAG,SAAS,CAAC,MAAM,CAAC,8CAA8C;AAC9E,YAAA,MAAM,GAAG,GAAG,SAAS,CAAC,MAAM,CAAC,mCAAmC;YAEhE,IAAI,KAAK,EAAE;AACT,gBAAA,MAAM,KAAK,GAAe;AACxB,oBAAA,uBAAuB,EAAE;wBACvB,KAAK,EAAE,KAAK,CAAC,IAAI;wBACjB,KAAK,EAAE,KAAK,CAAC,KAAK;AAClB,wBAAA,IAAI,EAAE,2BAA2B;wBACjC,eAAe,EAAE,KAAK,CAAC,eAAe;AACtC,wBAAA,aAAa,EAAE,SAAS,CAAC,aAAa,CAAC,QAAQ,EAAE;AAClD,qBAAA;iBACF;AACD,gBAAA,YAAY,CAAC,IAAI,CAAC,KAAK,CAAC;YAC1B;YAEA,IAAI,IAAI,EAAE;AACR,gBAAA,MAAM,KAAK,GAAe;AACxB,oBAAA,2BAA2B,EAAE;wBAC3B,KAAK,EAAE,IAAI,CAAC,IAAI;wBAChB,KAAK,EAAE,IAAI,CAAC,KAAK;AACjB,wBAAA,IAAI,EAAE,+BAA+B;wBACrC,eAAe,EAAE,IAAI,CAAC,eAAe;AACrC,wBAAA,aAAa,EAAE,SAAS,CAAC,aAAa,CAAC,QAAQ,EAAE;AAClD,qBAAA;iBACF;AACD,gBAAA,YAAY,CAAC,IAAI,CAAC,KAAK,CAAC;YAC1B;YAEA,IAAI,IAAI,EAAE;AACR,gBAAA,MAAM,KAAK,GAAe;AACxB,oBAAA,kCAAkC,EAAE;wBAClC,KAAK,EAAE,IAAI,CAAC,IAAI;wBAChB,KAAK,EAAE,IAAI,CAAC,KAAK;AACjB,wBAAA,IAAI,EAAE,uCAAuC;wBAC7C,eAAe,EAAE,IAAI,CAAC,eAAe;AACrC,wBAAA,aAAa,EAAE,SAAS,CAAC,aAAa,CAAC,QAAQ,EAAE;AAClD,qBAAA;iBACF;AACD,gBAAA,YAAY,CAAC,IAAI,CAAC,KAAK,CAAC;YAC1B;YAEA,IAAI,KAAK,EAAE;AACT,gBAAA,MAAM,KAAK,GAAe;AACxB,oBAAA,uCAAuC,EAAE;wBACvC,KAAK,EAAE,KAAK,CAAC,IAAI;wBACjB,KAAK,EAAE,KAAK,CAAC,KAAK;AAClB,wBAAA,IAAI,EAAE,6CAA6C;AACnD,wBAAA,eAAe,EAAE,IAAI;AACrB,wBAAA,aAAa,EAAE,SAAS,CAAC,aAAa,CAAC,QAAQ,EAAE;AAClD,qBAAA;iBACF;AACD,gBAAA,YAAY,CAAC,IAAI,CAAC,KAAK,CAAC;YAC1B;YAEA,IAAI,MAAM,EAAE;AACV,gBAAA,MAAM,KAAK,GAAe;AACxB,oBAAA,8CAA8C,EAAE;wBAC9C,KAAK,EAAE,MAAM,CAAC,IAAI;wBAClB,KAAK,EAAE,MAAM,CAAC,KAAK;AACnB,wBAAA,IAAI,EAAE,qDAAqD;AAC3D,wBAAA,eAAe,EAAE,IAAI;AACrB,wBAAA,aAAa,EAAE,SAAS,CAAC,aAAa,CAAC,QAAQ,EAAE;AAClD,qBAAA;iBACF;AACD,gBAAA,YAAY,CAAC,IAAI,CAAC,KAAK,CAAC;YAC1B;YAEA,IAAI,GAAG,EAAE;AACP,gBAAA,MAAM,KAAK,GAAe;AACxB,oBAAA,mCAAmC,EAAE;wBACnC,KAAK,EAAE,GAAG,CAAC,IAAI;wBACf,KAAK,EAAE,GAAG,CAAC,KAAK;AAChB,wBAAA,IAAI,EAAE,wCAAwC;wBAC9C,eAAe,EAAE,GAAG,CAAC,eAAe;AACpC,wBAAA,aAAa,EAAE,SAAS,CAAC,aAAa,CAAC,QAAQ,EAAE;AAClD,qBAAA;iBACF;AACD,gBAAA,YAAY,CAAC,IAAI,CAAC,KAAK,CAAC;YAC1B;QACF;;AAAO,YAAA,MAAM,IAAI,KAAK,CAAC,oBAAoB,CAAC;AAC9C,IAAA,CAAC,CAAC;AAEF,IAAA,OAAO,YAAY;AACrB;;AC3Kc,MAAO,cAAc,CAAA;AAGjC,IAAA,WAAA,CACE,oBAA0C,EAC1C,MAA4B,EAC5B,SAA2B,OAAO,EAAA;AAElC,QAAA,IAAI,CAAC,UAAU,GAAG,IAAIA,0BAAU,CAAC,UAAU,EAAE,MAAM,EAAE,MAAM,EAAE,oBAAoB,CAAC;IACpF;AAEA,IAAA,MAAM,WAAW,CACf,WAAiC,EACjC,cAAsB,EACtB,eAAuB,EAAA;QAEvB,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,GAAG,CACxC,EAAE,IAAI,EAAE,CAAA,sBAAA,EAAyB,cAAc,CAAA,CAAA,EAAI,eAAe,EAAE,EAAE,EACtE,WAAW,CACZ;QAED,OAAO;AACL,YAAA,MAAM,EAAE,kBAAkB,CAAC,QAAQ,CAAC;AACpC,YAAA,GAAG,EAAE,QAAQ;SACd;IACH;AACD;;;;"}

package/dist/index.d.ts

@@ -0,0 +1,126 @@
+import { ApiConfig, AuthOptions } from '@ministryofjustice/hmpps-rest-client';
+import { AuthenticationClient } from '@ministryofjustice/hmpps-auth-clients';
+import Logger from 'bunyan';
+
+interface ArnsComponentsConfig extends ApiConfig {
+}
+
+declare enum StaticOrDynamic {
+    STATIC = "STATIC",
+    DYNAMIC = "DYNAMIC"
+}
+
+declare enum BandLevel {
+    LOW = "LOW",
+    MEDIUM = "MEDIUM",
+    HIGH = "HIGH",
+    VERY_HIGH = "VERY_HIGH",
+    NOT_APPLICABLE = "NOT_APPLICABLE"
+}
+
+interface BadgeData {
+    level: `${BandLevel}`;
+    score: number;
+    type: string;
+    staticOrDynamic: `${StaticOrDynamic}`;
+    completedDate: string;
+}
+interface BadgeEntry {
+    [key: string]: BadgeData;
+}
+
+declare enum AssessmentStatusDto {
+    COMPLETE = "COMPLETE",
+    LOCKED_INCOMPLETE = "LOCKED_INCOMPLETE"
+}
+
+interface BasePredictorDto {
+    score: number;
+    band: `${BandLevel}`;
+}
+
+interface StaticOrDynamicPredictorDto extends BasePredictorDto {
+    staticOrDynamic: `${StaticOrDynamic}`;
+}
+
+interface VersionedStaticOrDynamicPredictorDto extends StaticOrDynamicPredictorDto {
+    algorithmVersion: string;
+}
+
+interface OgrScoreDto {
+    oneYear: number;
+    twoYears: number;
+    scoreLevel: `${BandLevel}`;
+}
+
+interface OvpScoreDto {
+    ovpStaticWeightedScore: number;
+    ovpDynamicWeightedScore: number;
+    ovpTotalWeightedScore: number;
+    oneYear: number;
+    twoYears: number;
+    ovpRisk: `${BandLevel}`;
+}
+
+interface OgpScoreDto {
+    ogpStaticWeightedScore: number;
+    ogpDynamicWeightedScore: number;
+    ogpTotalWeightedScore: number;
+    ogp1Year: number;
+    ogp2Year: number;
+    ogpRisk: `${BandLevel}`;
+}
+
+declare enum RsrScoreSourceDto {
+    OASYS = "OASYS"
+}
+
+interface RsrScoreDto {
+    percentageScore: number;
+    staticOrDynamic: `${StaticOrDynamic}`;
+    source: `${RsrScoreSourceDto}`;
+    algorithmVersion: string;
+    scoreLevel: `${BandLevel}`;
+}
+
+interface OspScoreDto {
+    ospIndecentPercentageScore: number;
+    ospContactPercentageScore: number;
+    ospIndecentScoreLevel: `${BandLevel}`;
+    ospContactScoreLevel: `${BandLevel}`;
+}
+
+interface AllPredictorDto {
+    allReoffendingPredictor?: StaticOrDynamicPredictorDto;
+    violentReoffendingPredictor?: StaticOrDynamicPredictorDto;
+    seriousViolentReoffendingPredictor?: StaticOrDynamicPredictorDto;
+    directContactSexualReoffendingPredictor?: BasePredictorDto;
+    indirectImageContactSexualReoffendingPredictor?: BasePredictorDto;
+    combinedSeriousReoffendingPredictor?: VersionedStaticOrDynamicPredictorDto;
+    groupReconvictionScore?: OgrScoreDto;
+    violencePredictorScore?: OvpScoreDto;
+    generalPredictorScore?: OgpScoreDto;
+    riskOfSeriousRecidivismScore?: RsrScoreDto;
+    sexualPredictorScore?: OspScoreDto;
+}
+
+interface AllPredictorVersionedDto {
+    completedDate: string;
+    status: `${AssessmentStatusDto}`;
+    outputVersion: string;
+    output?: AllPredictorDto;
+}
+
+interface RiskData {
+    badges: BadgeEntry[];
+    raw: AllPredictorVersionedDto[];
+}
+
+declare class ArnsComponents {
+    private readonly restClient;
+    constructor(authenticationClient: AuthenticationClient, config: ArnsComponentsConfig, logger?: Logger | Console);
+    getRiskData(authOptions: AuthOptions | string, identifierType: string, identifierValue: string): Promise<RiskData>;
+}
+
+export { ArnsComponents };
+export type { ArnsComponentsConfig, BadgeData, BadgeEntry, RiskData };

package/dist/index.esm.js

@@ -0,0 +1,185 @@
+import { RestClient } from '@ministryofjustice/hmpps-rest-client';
+
+function transformBadgeData(dto) {
+    const badgeEntries = [];
+    dto.forEach(listEntry => {
+        if (listEntry.outputVersion === '1') {
+            const ogrs3 = listEntry.output.groupReconvictionScore;
+            const ovp = listEntry.output.violencePredictorScore;
+            const ogp = listEntry.output.generalPredictorScore;
+            const rsr = listEntry.output.riskOfSeriousRecidivismScore;
+            const osp = listEntry.output.sexualPredictorScore;
+            if (ogrs3) {
+                const entry = {
+                    ogrs3PredictorScore: {
+                        level: ogrs3.scoreLevel,
+                        score: ogrs3.twoYears,
+                        type: 'OGRS3',
+                        staticOrDynamic: null,
+                        completedDate: listEntry.completedDate.toString(),
+                    },
+                };
+                badgeEntries.push(entry);
+            }
+            if (ovp) {
+                const entry = {
+                    ovpPredictorScore: {
+                        level: ovp.ovpRisk,
+                        score: ovp.twoYears,
+                        type: 'OVP',
+                        staticOrDynamic: null,
+                        completedDate: listEntry.completedDate.toString(),
+                    },
+                };
+                badgeEntries.push(entry);
+            }
+            if (ogp) {
+                const entry = {
+                    ogpPredictorScore: {
+                        level: ogp.ogpRisk,
+                        score: ogp.ogp2Year,
+                        type: 'OGP',
+                        staticOrDynamic: null,
+                        completedDate: listEntry.completedDate.toString(),
+                    },
+                };
+                badgeEntries.push(entry);
+            }
+            if (rsr) {
+                const entry = {
+                    rsrPredictorScore: {
+                        level: rsr.scoreLevel,
+                        score: rsr.percentageScore,
+                        type: 'RSR',
+                        staticOrDynamic: rsr.staticOrDynamic,
+                        completedDate: listEntry.completedDate.toString(),
+                    },
+                };
+                badgeEntries.push(entry);
+            }
+            if (osp) {
+                const entry = {
+                    ospdcPredictorScore: {
+                        level: osp.ospIndecentScoreLevel,
+                        score: osp.ospIndecentPercentageScore,
+                        type: 'OSP/DC',
+                        staticOrDynamic: null,
+                        completedDate: listEntry.completedDate.toString(),
+                    },
+                };
+                badgeEntries.push(entry);
+            }
+            if (osp) {
+                const entry = {
+                    ospiicPredictorScore: {
+                        level: osp.ospIndecentScoreLevel,
+                        score: osp.ospIndecentPercentageScore,
+                        type: 'OSP/IIC',
+                        staticOrDynamic: null,
+                        completedDate: listEntry.completedDate.toString(),
+                    },
+                };
+                badgeEntries.push(entry);
+            }
+        }
+        else if (listEntry.outputVersion === '2') {
+            const ogrs4 = listEntry.output.allReoffendingPredictor;
+            const ovp2 = listEntry.output.violentReoffendingPredictor;
+            const snsv = listEntry.output.seriousViolentReoffendingPredictor;
+            const ospdc = listEntry.output.directContactSexualReoffendingPredictor;
+            const ospiic = listEntry.output.indirectImageContactSexualReoffendingPredictor;
+            const rsr = listEntry.output.combinedSeriousReoffendingPredictor;
+            if (ogrs4) {
+                const entry = {
+                    allReoffendingPredictor: {
+                        level: ogrs4.band,
+                        score: ogrs4.score,
+                        type: 'All reoffending predictor',
+                        staticOrDynamic: ogrs4.staticOrDynamic,
+                        completedDate: listEntry.completedDate.toString(),
+                    },
+                };
+                badgeEntries.push(entry);
+            }
+            if (ovp2) {
+                const entry = {
+                    violentReoffendingPredictor: {
+                        level: ovp2.band,
+                        score: ovp2.score,
+                        type: 'Violent reoffending predictor',
+                        staticOrDynamic: ovp2.staticOrDynamic,
+                        completedDate: listEntry.completedDate.toString(),
+                    },
+                };
+                badgeEntries.push(entry);
+            }
+            if (snsv) {
+                const entry = {
+                    seriousViolentReoffendingPredictor: {
+                        level: snsv.band,
+                        score: snsv.score,
+                        type: 'Serious violent reoffending predictor',
+                        staticOrDynamic: snsv.staticOrDynamic,
+                        completedDate: listEntry.completedDate.toString(),
+                    },
+                };
+                badgeEntries.push(entry);
+            }
+            if (ospdc) {
+                const entry = {
+                    directContactSexualReoffendingPredictor: {
+                        level: ospdc.band,
+                        score: ospdc.score,
+                        type: 'Direct contact sexual reoffending predictor',
+                        staticOrDynamic: null,
+                        completedDate: listEntry.completedDate.toString(),
+                    },
+                };
+                badgeEntries.push(entry);
+            }
+            if (ospiic) {
+                const entry = {
+                    indirectImageContactSexualReoffendingPredictor: {
+                        level: ospiic.band,
+                        score: ospiic.score,
+                        type: 'Indirect image contact sexual reoffending predictor',
+                        staticOrDynamic: null,
+                        completedDate: listEntry.completedDate.toString(),
+                    },
+                };
+                badgeEntries.push(entry);
+            }
+            if (rsr) {
+                const entry = {
+                    combinedSeriousReoffendingPredictor: {
+                        level: rsr.band,
+                        score: rsr.score,
+                        type: 'Combined serious reoffending predictor',
+                        staticOrDynamic: rsr.staticOrDynamic,
+                        completedDate: listEntry.completedDate.toString(),
+                    },
+                };
+                badgeEntries.push(entry);
+            }
+        }
+        else
+            throw new Error('unexpected version');
+    });
+    return badgeEntries;
+}
+
+class ArnsComponents {
+    constructor(authenticationClient, config, logger = console) {
+        this.restClient = new RestClient('ARNS API', config, logger, authenticationClient);
+    }
+    async getRiskData(authOptions, identifierType, identifierValue) {
+        const response = await this.restClient.get({ path: `/risks/predictors/all/${identifierType}/${identifierValue}` }, authOptions);
+        return {
+            badges: transformBadgeData(response),
+            raw: response,
+        };
+    }
+}
+
+export { ArnsComponents };
+//# sourceMappingURL=index.esm.js.map

package/dist/index.esm.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.esm.js","sources":["../src/components/badge/transformation.ts","../src/ArnsComponents.ts"],"sourcesContent":[null,null],"names":[],"mappings":";;AAGM,SAAU,kBAAkB,CAAC,GAA+B,EAAA;IAChE,MAAM,YAAY,GAAiB,EAAE;AAErC,IAAA,GAAG,CAAC,OAAO,CAAC,SAAS,IAAG;AACtB,QAAA,IAAI,SAAS,CAAC,aAAa,KAAK,GAAG,EAAE;AACnC,YAAA,MAAM,KAAK,GAAG,SAAS,CAAC,MAAM,CAAC,sBAAsB;AACrD,YAAA,MAAM,GAAG,GAAG,SAAS,CAAC,MAAM,CAAC,sBAAsB;AACnD,YAAA,MAAM,GAAG,GAAG,SAAS,CAAC,MAAM,CAAC,qBAAqB;AAClD,YAAA,MAAM,GAAG,GAAG,SAAS,CAAC,MAAM,CAAC,4BAA4B;AACzD,YAAA,MAAM,GAAG,GAAG,SAAS,CAAC,MAAM,CAAC,oBAAoB;YAEjD,IAAI,KAAK,EAAE;AACT,gBAAA,MAAM,KAAK,GAAe;AACxB,oBAAA,mBAAmB,EAAE;wBACnB,KAAK,EAAE,KAAK,CAAC,UAAU;wBACvB,KAAK,EAAE,KAAK,CAAC,QAAQ;AACrB,wBAAA,IAAI,EAAE,OAAO;AACb,wBAAA,eAAe,EAAE,IAAI;AACrB,wBAAA,aAAa,EAAE,SAAS,CAAC,aAAa,CAAC,QAAQ,EAAE;AAClD,qBAAA;iBACF;AACD,gBAAA,YAAY,CAAC,IAAI,CAAC,KAAK,CAAC;YAC1B;YAEA,IAAI,GAAG,EAAE;AACP,gBAAA,MAAM,KAAK,GAAe;AACxB,oBAAA,iBAAiB,EAAE;wBACjB,KAAK,EAAE,GAAG,CAAC,OAAO;wBAClB,KAAK,EAAE,GAAG,CAAC,QAAQ;AACnB,wBAAA,IAAI,EAAE,KAAK;AACX,wBAAA,eAAe,EAAE,IAAI;AACrB,wBAAA,aAAa,EAAE,SAAS,CAAC,aAAa,CAAC,QAAQ,EAAE;AAClD,qBAAA;iBACF;AACD,gBAAA,YAAY,CAAC,IAAI,CAAC,KAAK,CAAC;YAC1B;YAEA,IAAI,GAAG,EAAE;AACP,gBAAA,MAAM,KAAK,GAAe;AACxB,oBAAA,iBAAiB,EAAE;wBACjB,KAAK,EAAE,GAAG,CAAC,OAAO;wBAClB,KAAK,EAAE,GAAG,CAAC,QAAQ;AACnB,wBAAA,IAAI,EAAE,KAAK;AACX,wBAAA,eAAe,EAAE,IAAI;AACrB,wBAAA,aAAa,EAAE,SAAS,CAAC,aAAa,CAAC,QAAQ,EAAE;AAClD,qBAAA;iBACF;AACD,gBAAA,YAAY,CAAC,IAAI,CAAC,KAAK,CAAC;YAC1B;YAEA,IAAI,GAAG,EAAE;AACP,gBAAA,MAAM,KAAK,GAAe;AACxB,oBAAA,iBAAiB,EAAE;wBACjB,KAAK,EAAE,GAAG,CAAC,UAAU;wBACrB,KAAK,EAAE,GAAG,CAAC,eAAe;AAC1B,wBAAA,IAAI,EAAE,KAAK;wBACX,eAAe,EAAE,GAAG,CAAC,eAAe;AACpC,wBAAA,aAAa,EAAE,SAAS,CAAC,aAAa,CAAC,QAAQ,EAAE;AAClD,qBAAA;iBACF;AACD,gBAAA,YAAY,CAAC,IAAI,CAAC,KAAK,CAAC;YAC1B;YAEA,IAAI,GAAG,EAAE;AACP,gBAAA,MAAM,KAAK,GAAe;AACxB,oBAAA,mBAAmB,EAAE;wBACnB,KAAK,EAAE,GAAG,CAAC,qBAAqB;wBAChC,KAAK,EAAE,GAAG,CAAC,0BAA0B;AACrC,wBAAA,IAAI,EAAE,QAAQ;AACd,wBAAA,eAAe,EAAE,IAAI;AACrB,wBAAA,aAAa,EAAE,SAAS,CAAC,aAAa,CAAC,QAAQ,EAAE;AAClD,qBAAA;iBACF;AACD,gBAAA,YAAY,CAAC,IAAI,CAAC,KAAK,CAAC;YAC1B;YAEA,IAAI,GAAG,EAAE;AACP,gBAAA,MAAM,KAAK,GAAe;AACxB,oBAAA,oBAAoB,EAAE;wBACpB,KAAK,EAAE,GAAG,CAAC,qBAAqB;wBAChC,KAAK,EAAE,GAAG,CAAC,0BAA0B;AACrC,wBAAA,IAAI,EAAE,SAAS;AACf,wBAAA,eAAe,EAAE,IAAI;AACrB,wBAAA,aAAa,EAAE,SAAS,CAAC,aAAa,CAAC,QAAQ,EAAE;AAClD,qBAAA;iBACF;AACD,gBAAA,YAAY,CAAC,IAAI,CAAC,KAAK,CAAC;YAC1B;QACF;AAAO,aAAA,IAAI,SAAS,CAAC,aAAa,KAAK,GAAG,EAAE;AAC1C,YAAA,MAAM,KAAK,GAAG,SAAS,CAAC,MAAM,CAAC,uBAAuB;AACtD,YAAA,MAAM,IAAI,GAAG,SAAS,CAAC,MAAM,CAAC,2BAA2B;AACzD,YAAA,MAAM,IAAI,GAAG,SAAS,CAAC,MAAM,CAAC,kCAAkC;AAChE,YAAA,MAAM,KAAK,GAAG,SAAS,CAAC,MAAM,CAAC,uCAAuC;AACtE,YAAA,MAAM,MAAM,GAAG,SAAS,CAAC,MAAM,CAAC,8CAA8C;AAC9E,YAAA,MAAM,GAAG,GAAG,SAAS,CAAC,MAAM,CAAC,mCAAmC;YAEhE,IAAI,KAAK,EAAE;AACT,gBAAA,MAAM,KAAK,GAAe;AACxB,oBAAA,uBAAuB,EAAE;wBACvB,KAAK,EAAE,KAAK,CAAC,IAAI;wBACjB,KAAK,EAAE,KAAK,CAAC,KAAK;AAClB,wBAAA,IAAI,EAAE,2BAA2B;wBACjC,eAAe,EAAE,KAAK,CAAC,eAAe;AACtC,wBAAA,aAAa,EAAE,SAAS,CAAC,aAAa,CAAC,QAAQ,EAAE;AAClD,qBAAA;iBACF;AACD,gBAAA,YAAY,CAAC,IAAI,CAAC,KAAK,CAAC;YAC1B;YAEA,IAAI,IAAI,EAAE;AACR,gBAAA,MAAM,KAAK,GAAe;AACxB,oBAAA,2BAA2B,EAAE;wBAC3B,KAAK,EAAE,IAAI,CAAC,IAAI;wBAChB,KAAK,EAAE,IAAI,CAAC,KAAK;AACjB,wBAAA,IAAI,EAAE,+BAA+B;wBACrC,eAAe,EAAE,IAAI,CAAC,eAAe;AACrC,wBAAA,aAAa,EAAE,SAAS,CAAC,aAAa,CAAC,QAAQ,EAAE;AAClD,qBAAA;iBACF;AACD,gBAAA,YAAY,CAAC,IAAI,CAAC,KAAK,CAAC;YAC1B;YAEA,IAAI,IAAI,EAAE;AACR,gBAAA,MAAM,KAAK,GAAe;AACxB,oBAAA,kCAAkC,EAAE;wBAClC,KAAK,EAAE,IAAI,CAAC,IAAI;wBAChB,KAAK,EAAE,IAAI,CAAC,KAAK;AACjB,wBAAA,IAAI,EAAE,uCAAuC;wBAC7C,eAAe,EAAE,IAAI,CAAC,eAAe;AACrC,wBAAA,aAAa,EAAE,SAAS,CAAC,aAAa,CAAC,QAAQ,EAAE;AAClD,qBAAA;iBACF;AACD,gBAAA,YAAY,CAAC,IAAI,CAAC,KAAK,CAAC;YAC1B;YAEA,IAAI,KAAK,EAAE;AACT,gBAAA,MAAM,KAAK,GAAe;AACxB,oBAAA,uCAAuC,EAAE;wBACvC,KAAK,EAAE,KAAK,CAAC,IAAI;wBACjB,KAAK,EAAE,KAAK,CAAC,KAAK;AAClB,wBAAA,IAAI,EAAE,6CAA6C;AACnD,wBAAA,eAAe,EAAE,IAAI;AACrB,wBAAA,aAAa,EAAE,SAAS,CAAC,aAAa,CAAC,QAAQ,EAAE;AAClD,qBAAA;iBACF;AACD,gBAAA,YAAY,CAAC,IAAI,CAAC,KAAK,CAAC;YAC1B;YAEA,IAAI,MAAM,EAAE;AACV,gBAAA,MAAM,KAAK,GAAe;AACxB,oBAAA,8CAA8C,EAAE;wBAC9C,KAAK,EAAE,MAAM,CAAC,IAAI;wBAClB,KAAK,EAAE,MAAM,CAAC,KAAK;AACnB,wBAAA,IAAI,EAAE,qDAAqD;AAC3D,wBAAA,eAAe,EAAE,IAAI;AACrB,wBAAA,aAAa,EAAE,SAAS,CAAC,aAAa,CAAC,QAAQ,EAAE;AAClD,qBAAA;iBACF;AACD,gBAAA,YAAY,CAAC,IAAI,CAAC,KAAK,CAAC;YAC1B;YAEA,IAAI,GAAG,EAAE;AACP,gBAAA,MAAM,KAAK,GAAe;AACxB,oBAAA,mCAAmC,EAAE;wBACnC,KAAK,EAAE,GAAG,CAAC,IAAI;wBACf,KAAK,EAAE,GAAG,CAAC,KAAK;AAChB,wBAAA,IAAI,EAAE,wCAAwC;wBAC9C,eAAe,EAAE,GAAG,CAAC,eAAe;AACpC,wBAAA,aAAa,EAAE,SAAS,CAAC,aAAa,CAAC,QAAQ,EAAE;AAClD,qBAAA;iBACF;AACD,gBAAA,YAAY,CAAC,IAAI,CAAC,KAAK,CAAC;YAC1B;QACF;;AAAO,YAAA,MAAM,IAAI,KAAK,CAAC,oBAAoB,CAAC;AAC9C,IAAA,CAAC,CAAC;AAEF,IAAA,OAAO,YAAY;AACrB;;AC3Kc,MAAO,cAAc,CAAA;AAGjC,IAAA,WAAA,CACE,oBAA0C,EAC1C,MAA4B,EAC5B,SAA2B,OAAO,EAAA;AAElC,QAAA,IAAI,CAAC,UAAU,GAAG,IAAI,UAAU,CAAC,UAAU,EAAE,MAAM,EAAE,MAAM,EAAE,oBAAoB,CAAC;IACpF;AAEA,IAAA,MAAM,WAAW,CACf,WAAiC,EACjC,cAAsB,EACtB,eAAuB,EAAA;QAEvB,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,GAAG,CACxC,EAAE,IAAI,EAAE,CAAA,sBAAA,EAAyB,cAAc,CAAA,CAAA,EAAI,eAAe,EAAE,EAAE,EACtE,WAAW,CACZ;QAED,OAAO;AACL,YAAA,MAAM,EAAE,kBAAkB,CAAC,QAAQ,CAAC;AACpC,YAAA,GAAG,EAAE,QAAQ;SACd;IACH;AACD;;;;"}

package/dist/types/ArnsComponentsConfig.d.ts

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

package/dist/types/RiskData.d.ts

@@ -0,0 +1,6 @@
+import { BadgeEntry } from './badgeData';
+import { AllPredictorVersionedDto } from './dtos/allPredictorVersionedDto';
+export interface RiskData {
+    badges: BadgeEntry[];
+    raw: AllPredictorVersionedDto[];
+}

package/dist/types/badgeData.d.ts

@@ -0,0 +1,12 @@
+import { StaticOrDynamic } from './staticOrDynamic';
+import { BandLevel } from './bandLevel';
+export interface BadgeData {
+    level: `${BandLevel}`;
+    score: number;
+    type: string;
+    staticOrDynamic: `${StaticOrDynamic}`;
+    completedDate: string;
+}
+export interface BadgeEntry {
+    [key: string]: BadgeData;
+}

package/dist/types/bandLevel.d.ts

@@ -0,0 +1,7 @@
+export declare enum BandLevel {
+    LOW = "LOW",
+    MEDIUM = "MEDIUM",
+    HIGH = "HIGH",
+    VERY_HIGH = "VERY_HIGH",
+    NOT_APPLICABLE = "NOT_APPLICABLE"
+}

package/dist/types/dtos/allPredictorDto.d.ts

@@ -0,0 +1,21 @@
+import { BasePredictorDto } from './basePredictorDto';
+import { StaticOrDynamicPredictorDto } from './staticOrDynamicPredictorDto';
+import { VersionedStaticOrDynamicPredictorDto } from './versionedStaticOrDynamicPredictorDto';
+import { OgrScoreDto } from './ogrScoreDto';
+import { OvpScoreDto } from './ovpScoreDto';
+import { OgpScoreDto } from './ogpScoreDto';
+import { RsrScoreDto } from './rsrScoreDto';
+import { OspScoreDto } from './ospScoreDto';
+export interface AllPredictorDto {
+    allReoffendingPredictor?: StaticOrDynamicPredictorDto;
+    violentReoffendingPredictor?: StaticOrDynamicPredictorDto;
+    seriousViolentReoffendingPredictor?: StaticOrDynamicPredictorDto;
+    directContactSexualReoffendingPredictor?: BasePredictorDto;
+    indirectImageContactSexualReoffendingPredictor?: BasePredictorDto;
+    combinedSeriousReoffendingPredictor?: VersionedStaticOrDynamicPredictorDto;
+    groupReconvictionScore?: OgrScoreDto;
+    violencePredictorScore?: OvpScoreDto;
+    generalPredictorScore?: OgpScoreDto;
+    riskOfSeriousRecidivismScore?: RsrScoreDto;
+    sexualPredictorScore?: OspScoreDto;
+}

package/dist/types/dtos/allPredictorVersionedDto.d.ts

@@ -0,0 +1,8 @@
+import { AssessmentStatusDto } from './assessmentStatusDto';
+import { AllPredictorDto } from './allPredictorDto';
+export interface AllPredictorVersionedDto {
+    completedDate: string;
+    status: `${AssessmentStatusDto}`;
+    outputVersion: string;
+    output?: AllPredictorDto;
+}

package/dist/types/dtos/assessmentStatusDto.d.ts

@@ -0,0 +1,4 @@
+export declare enum AssessmentStatusDto {
+    COMPLETE = "COMPLETE",
+    LOCKED_INCOMPLETE = "LOCKED_INCOMPLETE"
+}

package/dist/types/dtos/basePredictorDto.d.ts

@@ -0,0 +1,5 @@
+import { BandLevel } from '../bandLevel';
+export interface BasePredictorDto {
+    score: number;
+    band: `${BandLevel}`;
+}

package/dist/types/dtos/ogpScoreDto.d.ts

@@ -0,0 +1,9 @@
+import { BandLevel } from '../bandLevel';
+export interface OgpScoreDto {
+    ogpStaticWeightedScore: number;
+    ogpDynamicWeightedScore: number;
+    ogpTotalWeightedScore: number;
+    ogp1Year: number;
+    ogp2Year: number;
+    ogpRisk: `${BandLevel}`;
+}

package/dist/types/dtos/ogrScoreDto.d.ts

@@ -0,0 +1,6 @@
+import { BandLevel } from '../bandLevel';
+export interface OgrScoreDto {
+    oneYear: number;
+    twoYears: number;
+    scoreLevel: `${BandLevel}`;
+}

package/dist/types/dtos/ospScoreDto.d.ts

@@ -0,0 +1,7 @@
+import { BandLevel } from '../bandLevel';
+export interface OspScoreDto {
+    ospIndecentPercentageScore: number;
+    ospContactPercentageScore: number;
+    ospIndecentScoreLevel: `${BandLevel}`;
+    ospContactScoreLevel: `${BandLevel}`;
+}

package/dist/types/dtos/ovpScoreDto.d.ts

@@ -0,0 +1,9 @@
+import { BandLevel } from '../bandLevel';
+export interface OvpScoreDto {
+    ovpStaticWeightedScore: number;
+    ovpDynamicWeightedScore: number;
+    ovpTotalWeightedScore: number;
+    oneYear: number;
+    twoYears: number;
+    ovpRisk: `${BandLevel}`;
+}

package/dist/types/dtos/rsrScoreDto.d.ts

@@ -0,0 +1,10 @@
+import { StaticOrDynamic } from '../staticOrDynamic';
+import { BandLevel } from '../bandLevel';
+import { RsrScoreSourceDto } from './rsrScoreSourceDto';
+export interface RsrScoreDto {
+    percentageScore: number;
+    staticOrDynamic: `${StaticOrDynamic}`;
+    source: `${RsrScoreSourceDto}`;
+    algorithmVersion: string;
+    scoreLevel: `${BandLevel}`;
+}

package/dist/types/dtos/rsrScoreSourceDto.d.ts

@@ -0,0 +1,3 @@
+export declare enum RsrScoreSourceDto {
+    OASYS = "OASYS"
+}

package/dist/types/dtos/staticOrDynamicPredictorDto.d.ts

@@ -0,0 +1,5 @@
+import { StaticOrDynamic } from '../staticOrDynamic';
+import { BasePredictorDto } from './basePredictorDto';
+export interface StaticOrDynamicPredictorDto extends BasePredictorDto {
+    staticOrDynamic: `${StaticOrDynamic}`;
+}

package/dist/types/dtos/versionedStaticOrDynamicPredictorDto.d.ts

@@ -0,0 +1,4 @@
+import { StaticOrDynamicPredictorDto } from './staticOrDynamicPredictorDto';
+export interface VersionedStaticOrDynamicPredictorDto extends StaticOrDynamicPredictorDto {
+    algorithmVersion: string;
+}

package/dist/types/staticOrDynamic.d.ts

@@ -0,0 +1,4 @@
+export declare enum StaticOrDynamic {
+    STATIC = "STATIC",
+    DYNAMIC = "DYNAMIC"
+}

package/package.json

@@ -0,0 +1,122 @@
+{
+  "name": "@ministryofjustice/hmpps-arns-frontend-components-lib",
+  "version": "0.0.1",
+  "description": "ARNS front-end library for risk score visualisations",
+  "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: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",
+    "precommit:secrets": "gitleaks git --pre-commit --redact --staged --verbose --config .gitleaks/config.toml",
+    "precommit:lint": "node_modules/.bin/lint-staged",
+    "precommit:verify": "npm run typecheck",
+    "setup": "npm ci && hmpps-npm-script-run-allowlist"
+  },
+  "lint-staged": {
+    "*.{ts,css}": [
+      "prettier --write",
+      "eslint --fix"
+    ],
+    "*.json": [
+      "prettier --write"
+    ]
+  },
+  "jest": {
+    "transform": {
+      "^.+\\.tsx?$": [
+        "ts-jest",
+        {
+          "isolatedModules": true
+        }
+      ]
+    },
+    "testMatch": [
+      "<rootDir>/**/**/?(*.)(cy|test).{ts,js,jsx,mjs}"
+    ],
+    "testEnvironment": "node",
+    "reporters": [
+      "default",
+      [
+        "jest-junit",
+        {
+          "outputDirectory": "test_results/jest/"
+        }
+      ],
+      [
+        "./node_modules/jest-html-reporter",
+        {
+          "outputPath": "test_results/unit-test-reports.html"
+        }
+      ]
+    ],
+    "moduleFileExtensions": [
+      "web.js",
+      "js",
+      "json",
+      "node",
+      "ts"
+    ]
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/ministryofjustice/hmpps-arns-frontend-components-lib.git"
+  },
+  "keywords": [],
+  "author": "",
+  "license": "ISC",
+  "type": "commonjs",
+  "bugs": {
+    "url": "https://github.com/ministryofjustice/hmpps-arns-frontend-components-lib/issues"
+  },
+  "homepage": "https://github.com/ministryofjustice/hmpps-arns-frontend-components-lib#readme",
+  "devDependencies": {
+    "@ministryofjustice/eslint-config-hmpps": "^1.0.2",
+    "@ministryofjustice/hmpps-npm-script-allowlist": "0.0.3",
+    "@ministryofjustice/hmpps-precommit-hooks": "^1.0.2",
+    "@rollup/plugin-node-resolve": "^16.0.3",
+    "@rollup/plugin-typescript": "^12.3.0",
+    "@types/bunyan": "^1.8.11",
+    "@types/jest": "^30.0.0",
+    "@types/superagent": "^8.1.9",
+    "@types/supertest": "^6.0.3",
+    "@typescript-eslint/eslint-plugin": "^8.53.1",
+    "cheerio": "^1.0.0",
+    "eslint-import-resolver-typescript": "^4.4.4",
+    "eslint-plugin-no-only-tests": "^3.3.0",
+    "express": "^5.2.1",
+    "govuk-frontend": "^5.14.0",
+    "jest": "^30.2.0",
+    "jest-html-reporter": "^4.3.0",
+    "jest-junit": "^16.0.0",
+    "lint-staged": "^16.1.2",
+    "nock": "^14.0.10",
+    "rollup": "^4.56.0",
+    "rollup-plugin-copy": "^3.5.0",
+    "rollup-plugin-dts": "^6.3.0",
+    "supertest": "^7.1.1",
+    "ts-jest": "^29.3.4",
+    "tslib": "^2.8.1",
+    "typescript": "^5.9.3"
+  },
+  "dependencies": {
+    "@ministryofjustice/hmpps-auth-clients": "^1.0.1",
+    "@ministryofjustice/hmpps-rest-client": "^1.0.0",
+    "@types/express": "^5.0.6",
+    "@types/node": "22.19.7",
+    "@types/nunjucks": "^3.2.6",
+    "nunjucks": "^3.2.4",
+    "superagent": "^10.3.0"
+  }
+}