@ministryofjustice/hmpps-connect-dps-shared-items 2.0.0 → 2.1.0

package/dist/index.d.ts

@@ -1,3 +1,170 @@
+import Logger from 'bunyan';
+import { ApiConfig } from '@ministryofjustice/hmpps-rest-client';
+
+type ConnectDpsComponentLogger = Logger | typeof console;
+
+interface OsAddress {
+    addressString?: string;
+    buildingNumber?: number;
+    buildingName?: string;
+    subBuildingName?: string;
+    thoroughfareName?: string;
+    dependentLocality?: string;
+    postTown?: string;
+    county?: string;
+    postcode?: string;
+    country?: string;
+    uprn?: number;
+}
+
+interface OsPlacesQueryResponse {
+    header: OsPlacesResponseHeader;
+    results: OsPlacesQueryResult[];
+}
+interface OsPlacesResponseHeader {
+    uri: string;
+    query: string;
+    offset: number;
+    totalresults: number;
+    format: string;
+    dataset: string;
+    lr: string;
+    maxresults: number;
+    matchprecision: number;
+    epoch: string;
+    lastupdate: string;
+    output_srs: string;
+}
+interface OsPlacesQueryResult {
+    DPA?: OsPlacesDeliveryPointAddress;
+    LPI?: OsPlacesLandPropertyIdentifier;
+}
+interface OsPlacesLandPropertyIdentifier {
+    UPRN: number;
+    ADDRESS: string;
+    USRN: number;
+    LPI_KEY: string;
+    ORGANISATION: string;
+    SAO_START_NUMBER: number;
+    SAO_START_SUFFIX: string;
+    SAO_END_NUMBER: number;
+    SAO_END_SUFFIX: string;
+    SAO_TEXT: string;
+    PAO_START_NUMBER: number;
+    PAO_START_SUFFIX: string;
+    PAO_END_NUMBER: number;
+    PAO_END_SUFFIX: string;
+    PAO_TEXT: string;
+    STREET_DESCRIPTION: string;
+    LOCALITY_NAME: string;
+    TOWN_NAME: string;
+    ADMINISTRATIVE_AREA: string;
+    AREA_NAME: string;
+    POSTCODE_LOCATOR: string;
+    RPC: string;
+    X_COORDINATE: number;
+    Y_COORDINATE: number;
+    LNG: number;
+    LAT: number;
+    STATUS: string;
+    LOGICAL_STATUS_CODE: number;
+    CLASSIFICATION_CODE: string;
+    CLASSIFICATION_CODE_DESCRIPTION: string;
+    LOCAL_CUSTODIAN_CODE: number;
+    LOCAL_CUSTODIAN_CODE_DESCRIPTION: string;
+    COUNTRY_CODE: string;
+    COUNTRY_CODE_DESCRIPTION: string;
+    POSTAL_ADDRESS_CODE: string;
+    POSTAL_ADDRESS_CODE_DESCRIPTION: string;
+    BLPU_STATE_CODE: number;
+    BLPU_STATE_CODE_DESCRIPTION: string;
+    TOPOGRAPHY_LAYER_TOID: string;
+    WARD_CODE: string;
+    PARISH_CODE: string;
+    PARENT_UPRN: number;
+    LAST_UPDATE_DATE: string;
+    ENTRY_DATE: string;
+    LEGAL_NAME: string;
+    BLPU_STATE_DATE: string;
+    STREET_STATE_CODE: number;
+    STREET_STATE_CODE_DESCRIPTION: string;
+    STREET_CLASSIFICATION_CODE: string;
+    STREET_CLASSIFICATION_CODE_DESCRIPTION: string;
+    LPI_LOGICAL_STATUS_CODE: number;
+    LPI_LOGICAL_STATUS_CODE_DESCRIPTION: string;
+    LANGUAGE: string;
+    MATCH: number;
+    MATCH_DESCRIPTION: string;
+}
+interface OsPlacesDeliveryPointAddress {
+    UPRN: number;
+    UDPRN: number;
+    ADDRESS: string;
+    ORGANISATION_NAME: string;
+    DEPARTMENT_NAME: string;
+    SUB_BUILDING_NAME: string;
+    BUILDING_NAME: string;
+    BUILDING_NUMBER: number;
+    DEPENDENT_THOROUGHFARE_NAME: string;
+    THOROUGHFARE_NAME: string;
+    DOUBLE_DEPENDENT_LOCALITY: string;
+    DEPENDENT_LOCALITY: string;
+    POST_TOWN: string;
+    POSTCODE: string;
+    RPC: string;
+    X_COORDINATE: number;
+    Y_COORDINATE: number;
+    LNG: number;
+    LAT: number;
+    STATUS: string;
+    LOGICAL_STATUS_CODE: number;
+    CLASSIFICATION_CODE: string;
+    CLASSIFICATION_CODE_DESCRIPTION: string;
+    LOCAL_CUSTODIAN_CODE: number;
+    LOCAL_CUSTODIAN_CODE_DESCRIPTION: string;
+    COUNTRY_CODE: string;
+    COUNTRY_CODE_DESCRIPTION: string;
+    POSTAL_ADDRESS_CODE: string;
+    POSTAL_ADDRESS_CODE_DESCRIPTION: string;
+    BLPU_STATE_CODE: number;
+    BLPU_STATE_CODE_DESCRIPTION: string;
+    TOPOGRAPHY_LAYER_TOID: string;
+    WARD_CODE: string;
+    PARISH_CODE: string;
+    PARENT_UPRN: number;
+    LAST_UPDATE_DATE: string;
+    ENTRY_DATE: string;
+    LEGAL_NAME: string;
+    BLPU_STATE_DATE: string;
+    LANGUAGE: string;
+    MATCH: number;
+    MATCH_DESCRIPTION: string;
+    DELIVERY_POINT_SUFFIX: string;
+}
+
+declare class OsPlacesApiClient {
+    private readonly logger;
+    private readonly config;
+    constructor(logger: ConnectDpsComponentLogger, config: ApiConfig & {
+        apiKey: string;
+    });
+    getAddressesByFreeTextQuery(freeTextQuery: string): Promise<OsPlacesQueryResponse>;
+    getAddressesByUprn(uprn: string): Promise<OsPlacesQueryResponse>;
+    get<T>(path: string, query: Record<string, string>): Promise<T>;
+}
+
+declare class OsPlacesAddressService {
+    private readonly logger;
+    private readonly osPlacesApiClient;
+    constructor(logger: ConnectDpsComponentLogger, osPlacesApiClient: OsPlacesApiClient);
+    getAddressesMatchingQuery(searchQuery: string, sanitisePostcode?: boolean): Promise<OsAddress[]>;
+    getAddressByUprn(uprn: string): Promise<OsAddress | null>;
+    sanitiseUkPostcode(stringContainingPostcode: string): string;
+    private handleResponse;
+    private toOsAddress;
+    private formatAddressString;
+}
+
 type Alert = BasicAlert | PrisonApiAlert | AlertsServiceAlert;
 interface BasicAlert {
     alertType: string;
@@ -67,5 +234,5 @@ interface AlertFlagLabel {
 
 declare function getAlertFlagLabelsForAlerts(prisonerAlerts: Alert[]): AlertFlagLabel[];
 
-export { getAlertFlagLabelsForAlerts };
-export type { Alert, AlertFlagLabel, AlertsServiceAlert, BasicAlert, PrisonApiAlert };
+export { OsPlacesAddressService, OsPlacesApiClient, getAlertFlagLabelsForAlerts };
+export type { Alert, AlertFlagLabel, AlertsServiceAlert, BasicAlert, ConnectDpsComponentLogger, OsAddress, OsPlacesDeliveryPointAddress, OsPlacesLandPropertyIdentifier, OsPlacesQueryResponse, OsPlacesQueryResult, OsPlacesResponseHeader, PrisonApiAlert };

package/dist/index.esm.js

@@ -1,3 +1,129 @@
+import Fuse from 'fuse.js';
+import superagent from 'superagent';
+
+const isBlank = (str) => !str || /^\s*$/.test(str);
+const properCase = (word) => word.length >= 1 ? word[0].toUpperCase() + word.toLowerCase().slice(1) : word;
+/**
+ * Converts a name (first name, last name, middle name, etc.) to proper case equivalent, handling double-barreled names
+ * correctly (i.e. each part in a double-barreled is converted to proper case).
+ * @param name name to be converted.
+ * @returns name converted to proper case.
+ */
+const properCaseName = (name) => (isBlank(name) ? '' : name.split('-').map(properCase).join('-'));
+const convertToTitleCase = (sentence) => isBlank(sentence) ? '' : sentence.split(' ').map(properCaseName).join(' ');
+
+const simplePostCodeRegex = /^[A-Z]{1,2}\d[A-Z\d]? ?\d[A-Z]{2}$/i;
+const stringContainingPostCodeRegex = /^(.*?)([A-Z]{1,2}\d[A-Z\d]? ?)(\d[A-Z]{2})(.*)$/i;
+class OsPlacesAddressService {
+    logger;
+    osPlacesApiClient;
+    constructor(logger, osPlacesApiClient) {
+        this.logger = logger;
+        this.osPlacesApiClient = osPlacesApiClient;
+    }
+    async getAddressesMatchingQuery(searchQuery, sanitisePostcode = true) {
+        const response = await this.osPlacesApiClient.getAddressesByFreeTextQuery(sanitisePostcode ? this.sanitiseUkPostcode(searchQuery) : searchQuery);
+        const rawResults = this.handleResponse(response);
+        const bestMatchResults = new Fuse(rawResults, {
+            shouldSort: true,
+            threshold: 0.2,
+            ignoreLocation: true,
+            keys: [{ name: 'addressString' }],
+        })
+            .search(searchQuery)
+            .map(result => result.item);
+        const queryIsAPostCode = simplePostCodeRegex.test(searchQuery.trim());
+        const buildingNumberSort = (a, b) => a?.addressString && b?.addressString && queryIsAPostCode
+            ? a.addressString.localeCompare(b.addressString, undefined, { numeric: true, sensitivity: 'base' })
+            : 1;
+        // maximum number of properties in a postcode is 100
+        return (bestMatchResults.length ? bestMatchResults : rawResults).sort(buildingNumberSort).slice(0, 100);
+    }
+    async getAddressByUprn(uprn) {
+        const response = await this.osPlacesApiClient.getAddressesByUprn(uprn);
+        const result = this.handleResponse(response);
+        if (result.length === 0)
+            return null;
+        if (result.length > 1)
+            this.logger.info(`Multiple results returned for UPRN`);
+        return result[result.length - 1];
+    }
+    sanitiseUkPostcode(stringContainingPostcode) {
+        const postCodeQuery = stringContainingPostCodeRegex.exec(stringContainingPostcode?.replace(/[^A-Z0-9 ]/gi, ''));
+        if (!postCodeQuery)
+            return stringContainingPostcode;
+        return `${postCodeQuery[1]}${postCodeQuery[2].toUpperCase().trim()} ${postCodeQuery[3].toUpperCase().trim()}${postCodeQuery[4]}`;
+    }
+    handleResponse(response) {
+        if (response.header && response.header.totalresults === 0)
+            return [];
+        return response.results.filter(result => result.DPA).map(result => this.toOsAddress(result.DPA));
+    }
+    toOsAddress(addressResult) {
+        const { UPRN, DEPENDENT_LOCALITY, SUB_BUILDING_NAME, BUILDING_NAME, BUILDING_NUMBER, THOROUGHFARE_NAME, POST_TOWN, POSTCODE, COUNTRY_CODE, LOCAL_CUSTODIAN_CODE_DESCRIPTION, } = addressResult;
+        return {
+            addressString: this.formatAddressString(addressResult),
+            buildingNumber: BUILDING_NUMBER,
+            buildingName: convertToTitleCase(BUILDING_NAME),
+            subBuildingName: convertToTitleCase(SUB_BUILDING_NAME),
+            thoroughfareName: convertToTitleCase(THOROUGHFARE_NAME),
+            dependentLocality: convertToTitleCase(DEPENDENT_LOCALITY),
+            postTown: convertToTitleCase(POST_TOWN),
+            county: convertToTitleCase(LOCAL_CUSTODIAN_CODE_DESCRIPTION),
+            postcode: POSTCODE,
+            country: COUNTRY_CODE,
+            uprn: UPRN,
+        };
+    }
+    formatAddressString(addressResult) {
+        const { ADDRESS, BUILDING_NUMBER, THOROUGHFARE_NAME, POSTCODE } = addressResult;
+        const withoutPostcode = ADDRESS.replace(`, ${POSTCODE}`, '').replace(`${BUILDING_NUMBER}, ${THOROUGHFARE_NAME}`, `${BUILDING_NUMBER} ${THOROUGHFARE_NAME}`);
+        return `${convertToTitleCase(withoutPostcode)}, ${POSTCODE}`;
+    }
+}
+
+class OsPlacesApiClient {
+    logger;
+    config;
+    constructor(logger, config) {
+        this.logger = logger;
+        this.config = config;
+    }
+    async getAddressesByFreeTextQuery(freeTextQuery) {
+        const queryParams = {
+            query: freeTextQuery,
+            lr: 'EN',
+            key: this.config.apiKey,
+        };
+        return this.get('/find', queryParams);
+    }
+    async getAddressesByUprn(uprn) {
+        const queryParams = {
+            uprn,
+            key: this.config.apiKey,
+        };
+        return this.get('/uprn', queryParams);
+    }
+    async get(path, query) {
+        const endpoint = `${this.config.url}${path}`;
+        try {
+            const result = await superagent
+                .get(endpoint)
+                .retry(2, (err, res) => {
+                if (err)
+                    this.logger.info(`Retry handler found API error with ${err.code} ${err.message}`);
+                return undefined; // retry handler only for logging retries, not to influence retry logic
+            })
+                .query(query)
+                .timeout(this.config.timeout);
+            return result.body;
+        }
+        catch (error) {
+            throw Error(`Error calling OS Places API: ${error.message}`);
+        }
+    }
+}
+
 const alertFlagLabels = [
     { alertCodes: ['HA'], classes: 'dps-alert-status dps-alert-status--self-harm', label: 'ACCT open' },
     {
@@ -143,5 +269,5 @@ function getAlertFlagLabelsForAlerts(prisonerAlerts) {
     }, []);
 }
 
-export { getAlertFlagLabelsForAlerts };
+export { OsPlacesAddressService, OsPlacesApiClient, getAlertFlagLabelsForAlerts };
 //# sourceMappingURL=index.esm.js.map

package/dist/index.esm.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.esm.js","sources":["../src/alertFlags/getAlertFlagLabelsForAlerts.ts"],"sourcesContent":["import { Alert, AlertsServiceAlert } from '../types/public/alertFlags/Alert'\nimport { AlertFlagLabel } from '../types/public/alertFlags/AlertFlagLabel'\n\nexport const alertFlagLabels = [\n  { alertCodes: ['HA'], classes: 'dps-alert-status dps-alert-status--self-harm', label: 'ACCT open' },\n  {\n    alertCodes: ['HA1'],\n    classes: 'dps-alert-status dps-alert-status--self-harm',\n    label: 'ACCT post closure',\n  },\n  {\n    alertCodes: ['XSA', 'SA'],\n    classes: 'dps-alert-status dps-alert-status--security',\n    label: 'Staff assaulter',\n  },\n  {\n    alertCodes: ['XA'],\n    classes: 'dps-alert-status dps-alert-status--security',\n    label: 'Arsonist',\n  },\n  {\n    alertCodes: ['PEEP'],\n    classes: 'dps-alert-status dps-alert-status--medical',\n    label: 'PEEP',\n  },\n  {\n    alertCodes: ['HID'],\n    classes: 'dps-alert-status dps-alert-status--medical',\n    label: 'Hidden disability',\n  },\n  { alertCodes: ['XEL'], classes: 'dps-alert-status dps-alert-status--security', label: 'E-list' },\n  { alertCodes: ['XELH'], classes: 'dps-alert-status dps-alert-status--security', label: 'E-list heightened' },\n  { alertCodes: ['XER'], classes: 'dps-alert-status dps-alert-status--security', label: 'Escape risk' },\n  {\n    alertCodes: ['XRF'],\n    classes: 'dps-alert-status dps-alert-status--security',\n    label: 'Risk to females',\n  },\n  { alertCodes: ['XTACT'], classes: 'dps-alert-status dps-alert-status--security', label: 'TACT' },\n  {\n    alertCodes: ['XCO'],\n    classes: 'dps-alert-status dps-alert-status--security',\n    label: 'Corruptor',\n  },\n  {\n    alertCodes: ['XCA'],\n    classes: 'dps-alert-status dps-alert-status--security',\n    label: 'Chemical attacker',\n  },\n  {\n    alertCodes: ['XCI'],\n    classes: 'dps-alert-status dps-alert-status--security',\n    label: 'Concerted indiscipline',\n  },\n  { alertCodes: ['XR'], classes: 'dps-alert-status dps-alert-status--security', label: 'Racist' },\n  {\n    alertCodes: ['RTP', 'RLG'],\n    classes: 'dps-alert-status dps-alert-status--risk',\n    label: 'Risk to LGBT',\n  },\n  {\n    alertCodes: ['XHT'],\n    classes: 'dps-alert-status dps-alert-status--security',\n    label: 'Hostage taker',\n  },\n  {\n    alertCodes: ['XCU'],\n    classes: 'dps-alert-status dps-alert-status--security',\n    label: 'Controlled unlock',\n  },\n  {\n    alertCodes: ['XGANG'],\n    classes: 'dps-alert-status dps-alert-status--security',\n    label: 'Gang member',\n  },\n  { alertCodes: ['CSIP'], classes: 'dps-alert-status dps-alert-status--other', label: 'CSIP' },\n  { alertCodes: ['F1'], classes: 'dps-alert-status dps-alert-status--ex-armed-forces', label: 'Veteran' },\n  {\n    alertCodes: ['LCE'],\n    classes: 'dps-alert-status dps-alert-status--care-leaver',\n    label: 'Care experienced',\n  },\n  {\n    alertCodes: ['RNO121'],\n    classes: 'dps-alert-status dps-alert-status--risk',\n    label: 'No one-to-one',\n  },\n  { alertCodes: ['RCON'], classes: 'dps-alert-status dps-alert-status--risk', label: 'Conflict' },\n  {\n    alertCodes: ['RCDR'],\n    classes: 'dps-alert-status dps-alert-status--quarantined',\n    label: 'Quarantined',\n  },\n  {\n    alertCodes: ['URCU'],\n    classes: 'dps-alert-status dps-alert-status--reverse-cohorting-unit',\n    label: 'Reverse Cohorting Unit',\n  },\n  {\n    alertCodes: ['UPIU'],\n    classes: 'dps-alert-status dps-alert-status--protective-isolation-unit',\n    label: 'Protective Isolation Unit',\n  },\n  { alertCodes: ['USU'], classes: 'dps-alert-status dps-alert-status--shielding-unit', label: 'Shielding Unit' },\n  {\n    alertCodes: ['URS'],\n    classes: 'dps-alert-status dps-alert-status--refusing-to-shield',\n    label: 'Refusing to shield',\n  },\n  {\n    alertCodes: ['RKS'],\n    classes: 'dps-alert-status dps-alert-status--risk-to-known-adults',\n    label: 'Risk to known adults',\n  },\n  { alertCodes: ['VIP'], classes: 'dps-alert-status dps-alert-status--isolated-prisoner', label: 'Isolated' },\n  {\n    alertCodes: ['PVN'],\n    classes: 'dps-alert-status dps-alert-status--multicase dps-alert-status--visor',\n    label: 'ViSOR',\n  },\n  {\n    alertCodes: ['XCDO'],\n    classes: 'dps-alert-status dps-alert-status--security',\n    label: 'Involved in 2024 civil disorder',\n  },\n  {\n    alertCodes: ['XVL'],\n    classes: 'dps-alert-status dps-alert-status--security',\n    label: 'Violent',\n  },\n].sort((a, b) => a.label.localeCompare(b.label))\n\nfunction isAlertsServiceAlert(alert: Alert): alert is AlertsServiceAlert {\n  return typeof alert.alertCode !== 'string'\n}\n\nexport default function getAlertFlagLabelsForAlerts(prisonerAlerts: Alert[]): AlertFlagLabel[] {\n  return alertFlagLabels.reduce(\n    (acc: AlertFlagLabel[], flag: { alertCodes: string[]; classes: string; label: string }) => {\n      const alertIds = prisonerAlerts\n        .filter(alert => {\n          const alertsServiceAlert = isAlertsServiceAlert(alert)\n          const alertIsActive = alertsServiceAlert ? alert.isActive : alert.active && !alert.expired\n          const prisonerAlertCode = alertsServiceAlert ? alert.alertCode.code : alert.alertCode\n\n          return alertIsActive && flag.alertCodes.includes(prisonerAlertCode)\n        })\n        .map(alert => (isAlertsServiceAlert(alert) ? (alert.alertUuid as string) : alert.alertCode))\n\n      return alertIds.length ? [...acc, { ...flag, alertIds }] : acc\n    },\n    [] as AlertFlagLabel[],\n  )\n}\n"],"names":[],"mappings":"AAGO,MAAM,eAAe,GAAG;AAC7B,IAAA,EAAE,UAAU,EAAE,CAAC,IAAI,CAAC,EAAE,OAAO,EAAE,8CAA8C,EAAE,KAAK,EAAE,WAAW,EAAE;AACnG,IAAA;QACE,UAAU,EAAE,CAAC,KAAK,CAAC;AACnB,QAAA,OAAO,EAAE,8CAA8C;AACvD,QAAA,KAAK,EAAE,mBAAmB;AAC3B,KAAA;AACD,IAAA;AACE,QAAA,UAAU,EAAE,CAAC,KAAK,EAAE,IAAI,CAAC;AACzB,QAAA,OAAO,EAAE,6CAA6C;AACtD,QAAA,KAAK,EAAE,iBAAiB;AACzB,KAAA;AACD,IAAA;QACE,UAAU,EAAE,CAAC,IAAI,CAAC;AAClB,QAAA,OAAO,EAAE,6CAA6C;AACtD,QAAA,KAAK,EAAE,UAAU;AAClB,KAAA;AACD,IAAA;QACE,UAAU,EAAE,CAAC,MAAM,CAAC;AACpB,QAAA,OAAO,EAAE,4CAA4C;AACrD,QAAA,KAAK,EAAE,MAAM;AACd,KAAA;AACD,IAAA;QACE,UAAU,EAAE,CAAC,KAAK,CAAC;AACnB,QAAA,OAAO,EAAE,4CAA4C;AACrD,QAAA,KAAK,EAAE,mBAAmB;AAC3B,KAAA;AACD,IAAA,EAAE,UAAU,EAAE,CAAC,KAAK,CAAC,EAAE,OAAO,EAAE,6CAA6C,EAAE,KAAK,EAAE,QAAQ,EAAE;AAChG,IAAA,EAAE,UAAU,EAAE,CAAC,MAAM,CAAC,EAAE,OAAO,EAAE,6CAA6C,EAAE,KAAK,EAAE,mBAAmB,EAAE;AAC5G,IAAA,EAAE,UAAU,EAAE,CAAC,KAAK,CAAC,EAAE,OAAO,EAAE,6CAA6C,EAAE,KAAK,EAAE,aAAa,EAAE;AACrG,IAAA;QACE,UAAU,EAAE,CAAC,KAAK,CAAC;AACnB,QAAA,OAAO,EAAE,6CAA6C;AACtD,QAAA,KAAK,EAAE,iBAAiB;AACzB,KAAA;AACD,IAAA,EAAE,UAAU,EAAE,CAAC,OAAO,CAAC,EAAE,OAAO,EAAE,6CAA6C,EAAE,KAAK,EAAE,MAAM,EAAE;AAChG,IAAA;QACE,UAAU,EAAE,CAAC,KAAK,CAAC;AACnB,QAAA,OAAO,EAAE,6CAA6C;AACtD,QAAA,KAAK,EAAE,WAAW;AACnB,KAAA;AACD,IAAA;QACE,UAAU,EAAE,CAAC,KAAK,CAAC;AACnB,QAAA,OAAO,EAAE,6CAA6C;AACtD,QAAA,KAAK,EAAE,mBAAmB;AAC3B,KAAA;AACD,IAAA;QACE,UAAU,EAAE,CAAC,KAAK,CAAC;AACnB,QAAA,OAAO,EAAE,6CAA6C;AACtD,QAAA,KAAK,EAAE,wBAAwB;AAChC,KAAA;AACD,IAAA,EAAE,UAAU,EAAE,CAAC,IAAI,CAAC,EAAE,OAAO,EAAE,6CAA6C,EAAE,KAAK,EAAE,QAAQ,EAAE;AAC/F,IAAA;AACE,QAAA,UAAU,EAAE,CAAC,KAAK,EAAE,KAAK,CAAC;AAC1B,QAAA,OAAO,EAAE,yCAAyC;AAClD,QAAA,KAAK,EAAE,cAAc;AACtB,KAAA;AACD,IAAA;QACE,UAAU,EAAE,CAAC,KAAK,CAAC;AACnB,QAAA,OAAO,EAAE,6CAA6C;AACtD,QAAA,KAAK,EAAE,eAAe;AACvB,KAAA;AACD,IAAA;QACE,UAAU,EAAE,CAAC,KAAK,CAAC;AACnB,QAAA,OAAO,EAAE,6CAA6C;AACtD,QAAA,KAAK,EAAE,mBAAmB;AAC3B,KAAA;AACD,IAAA;QACE,UAAU,EAAE,CAAC,OAAO,CAAC;AACrB,QAAA,OAAO,EAAE,6CAA6C;AACtD,QAAA,KAAK,EAAE,aAAa;AACrB,KAAA;AACD,IAAA,EAAE,UAAU,EAAE,CAAC,MAAM,CAAC,EAAE,OAAO,EAAE,0CAA0C,EAAE,KAAK,EAAE,MAAM,EAAE;AAC5F,IAAA,EAAE,UAAU,EAAE,CAAC,IAAI,CAAC,EAAE,OAAO,EAAE,oDAAoD,EAAE,KAAK,EAAE,SAAS,EAAE;AACvG,IAAA;QACE,UAAU,EAAE,CAAC,KAAK,CAAC;AACnB,QAAA,OAAO,EAAE,gDAAgD;AACzD,QAAA,KAAK,EAAE,kBAAkB;AAC1B,KAAA;AACD,IAAA;QACE,UAAU,EAAE,CAAC,QAAQ,CAAC;AACtB,QAAA,OAAO,EAAE,yCAAyC;AAClD,QAAA,KAAK,EAAE,eAAe;AACvB,KAAA;AACD,IAAA,EAAE,UAAU,EAAE,CAAC,MAAM,CAAC,EAAE,OAAO,EAAE,yCAAyC,EAAE,KAAK,EAAE,UAAU,EAAE;AAC/F,IAAA;QACE,UAAU,EAAE,CAAC,MAAM,CAAC;AACpB,QAAA,OAAO,EAAE,gDAAgD;AACzD,QAAA,KAAK,EAAE,aAAa;AACrB,KAAA;AACD,IAAA;QACE,UAAU,EAAE,CAAC,MAAM,CAAC;AACpB,QAAA,OAAO,EAAE,2DAA2D;AACpE,QAAA,KAAK,EAAE,wBAAwB;AAChC,KAAA;AACD,IAAA;QACE,UAAU,EAAE,CAAC,MAAM,CAAC;AACpB,QAAA,OAAO,EAAE,8DAA8D;AACvE,QAAA,KAAK,EAAE,2BAA2B;AACnC,KAAA;AACD,IAAA,EAAE,UAAU,EAAE,CAAC,KAAK,CAAC,EAAE,OAAO,EAAE,mDAAmD,EAAE,KAAK,EAAE,gBAAgB,EAAE;AAC9G,IAAA;QACE,UAAU,EAAE,CAAC,KAAK,CAAC;AACnB,QAAA,OAAO,EAAE,uDAAuD;AAChE,QAAA,KAAK,EAAE,oBAAoB;AAC5B,KAAA;AACD,IAAA;QACE,UAAU,EAAE,CAAC,KAAK,CAAC;AACnB,QAAA,OAAO,EAAE,yDAAyD;AAClE,QAAA,KAAK,EAAE,sBAAsB;AAC9B,KAAA;AACD,IAAA,EAAE,UAAU,EAAE,CAAC,KAAK,CAAC,EAAE,OAAO,EAAE,sDAAsD,EAAE,KAAK,EAAE,UAAU,EAAE;AAC3G,IAAA;QACE,UAAU,EAAE,CAAC,KAAK,CAAC;AACnB,QAAA,OAAO,EAAE,sEAAsE;AAC/E,QAAA,KAAK,EAAE,OAAO;AACf,KAAA;AACD,IAAA;QACE,UAAU,EAAE,CAAC,MAAM,CAAC;AACpB,QAAA,OAAO,EAAE,6CAA6C;AACtD,QAAA,KAAK,EAAE,iCAAiC;AACzC,KAAA;AACD,IAAA;QACE,UAAU,EAAE,CAAC,KAAK,CAAC;AACnB,QAAA,OAAO,EAAE,6CAA6C;AACtD,QAAA,KAAK,EAAE,SAAS;AACjB,KAAA;CACF,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;AAEhD,SAAS,oBAAoB,CAAC,KAAY,EAAA;AACxC,IAAA,OAAO,OAAO,KAAK,CAAC,SAAS,KAAK,QAAQ;AAC5C;AAEc,SAAU,2BAA2B,CAAC,cAAuB,EAAA;IACzE,OAAO,eAAe,CAAC,MAAM,CAC3B,CAAC,GAAqB,EAAE,IAA8D,KAAI;QACxF,MAAM,QAAQ,GAAG;aACd,MAAM,CAAC,KAAK,IAAG;AACd,YAAA,MAAM,kBAAkB,GAAG,oBAAoB,CAAC,KAAK,CAAC;YACtD,MAAM,aAAa,GAAG,kBAAkB,GAAG,KAAK,CAAC,QAAQ,GAAG,KAAK,CAAC,MAAM,IAAI,CAAC,KAAK,CAAC,OAAO;AAC1F,YAAA,MAAM,iBAAiB,GAAG,kBAAkB,GAAG,KAAK,CAAC,SAAS,CAAC,IAAI,GAAG,KAAK,CAAC,SAAS;YAErF,OAAO,aAAa,IAAI,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,iBAAiB,CAAC;AACrE,QAAA,CAAC;aACA,GAAG,CAAC,KAAK,KAAK,oBAAoB,CAAC,KAAK,CAAC,GAAI,KAAK,CAAC,SAAoB,GAAG,KAAK,CAAC,SAAS,CAAC,CAAC;QAE9F,OAAO,QAAQ,CAAC,MAAM,GAAG,CAAC,GAAG,GAAG,EAAE,EAAE,GAAG,IAAI,EAAE,QAAQ,EAAE,CAAC,GAAG,GAAG;IAChE,CAAC,EACD,EAAsB,CACvB;AACH;;;;"}
+{"version":3,"file":"index.esm.js","sources":["../src/utils/utils.ts","../src/addressAutosuggest/osPlacesAddressService.ts","../src/addressAutosuggest/osPlacesApiClient.ts","../src/alertFlags/getAlertFlagLabelsForAlerts.ts"],"sourcesContent":["const isBlank = (str: string): boolean => !str || /^\\s*$/.test(str)\n\nconst properCase = (word: string): string =>\n  word.length >= 1 ? word[0].toUpperCase() + word.toLowerCase().slice(1) : word\n\n/**\n * Converts a name (first name, last name, middle name, etc.) to proper case equivalent, handling double-barreled names\n * correctly (i.e. each part in a double-barreled is converted to proper case).\n * @param name name to be converted.\n * @returns name converted to proper case.\n */\nexport const properCaseName = (name: string): string => (isBlank(name) ? '' : name.split('-').map(properCase).join('-'))\n\nexport const convertToTitleCase = (sentence: string): string =>\n  isBlank(sentence) ? '' : sentence.split(' ').map(properCaseName).join(' ')\n","import Fuse from 'fuse.js'\nimport { OsAddress } from '../types/public/addressAutosuggest/osAddress'\nimport { convertToTitleCase } from '../utils/utils'\nimport OsPlacesApiClient from './osPlacesApiClient'\nimport { ConnectDpsComponentLogger } from '../types/public/ConnectDpsComponentLogger'\nimport { OsPlacesDeliveryPointAddress, OsPlacesQueryResponse } from '../types/public/addressAutosuggest/osPlaces'\n\nconst simplePostCodeRegex = /^[A-Z]{1,2}\\d[A-Z\\d]? ?\\d[A-Z]{2}$/i\nconst stringContainingPostCodeRegex = /^(.*?)([A-Z]{1,2}\\d[A-Z\\d]? ?)(\\d[A-Z]{2})(.*)$/i\n\nexport default class OsPlacesAddressService {\n  constructor(\n    private readonly logger: ConnectDpsComponentLogger,\n    private readonly osPlacesApiClient: OsPlacesApiClient,\n  ) {}\n\n  public async getAddressesMatchingQuery(searchQuery: string, sanitisePostcode: boolean = true): Promise<OsAddress[]> {\n    const response = await this.osPlacesApiClient.getAddressesByFreeTextQuery(\n      sanitisePostcode ? this.sanitiseUkPostcode(searchQuery) : searchQuery,\n    )\n\n    const rawResults = this.handleResponse(response)\n\n    const bestMatchResults = new Fuse(rawResults, {\n      shouldSort: true,\n      threshold: 0.2,\n      ignoreLocation: true,\n      keys: [{ name: 'addressString' }],\n    })\n      .search(searchQuery)\n      .map(result => result.item)\n\n    const queryIsAPostCode = simplePostCodeRegex.test(searchQuery.trim())\n    const buildingNumberSort = (a: OsAddress, b: OsAddress) =>\n      a?.addressString && b?.addressString && queryIsAPostCode\n        ? a.addressString.localeCompare(b.addressString, undefined, { numeric: true, sensitivity: 'base' })\n        : 1\n\n    // maximum number of properties in a postcode is 100\n    return (bestMatchResults.length ? bestMatchResults : rawResults).sort(buildingNumberSort).slice(0, 100)\n  }\n\n  public async getAddressByUprn(uprn: string): Promise<OsAddress | null> {\n    const response = await this.osPlacesApiClient.getAddressesByUprn(uprn)\n    const result = this.handleResponse(response)\n\n    if (result.length === 0) return null\n    if (result.length > 1) this.logger.info(`Multiple results returned for UPRN`)\n\n    return result[result.length - 1]\n  }\n\n  public sanitiseUkPostcode(stringContainingPostcode: string) {\n    const postCodeQuery = stringContainingPostCodeRegex.exec(stringContainingPostcode?.replace(/[^A-Z0-9 ]/gi, ''))\n    if (!postCodeQuery) return stringContainingPostcode\n\n    return `${postCodeQuery[1]}${postCodeQuery[2].toUpperCase().trim()} ${postCodeQuery[3].toUpperCase().trim()}${postCodeQuery[4]}`\n  }\n\n  private handleResponse(response: OsPlacesQueryResponse): OsAddress[] {\n    if (response.header && response.header.totalresults === 0) return []\n\n    return response.results.filter(result => result.DPA).map(result => this.toOsAddress(result.DPA!))\n  }\n\n  private toOsAddress(addressResult: OsPlacesDeliveryPointAddress): OsAddress {\n    const {\n      UPRN,\n      DEPENDENT_LOCALITY,\n      SUB_BUILDING_NAME,\n      BUILDING_NAME,\n      BUILDING_NUMBER,\n      THOROUGHFARE_NAME,\n      POST_TOWN,\n      POSTCODE,\n      COUNTRY_CODE,\n      LOCAL_CUSTODIAN_CODE_DESCRIPTION,\n    } = addressResult\n\n    return {\n      addressString: this.formatAddressString(addressResult),\n      buildingNumber: BUILDING_NUMBER,\n      buildingName: convertToTitleCase(BUILDING_NAME),\n      subBuildingName: convertToTitleCase(SUB_BUILDING_NAME),\n      thoroughfareName: convertToTitleCase(THOROUGHFARE_NAME),\n      dependentLocality: convertToTitleCase(DEPENDENT_LOCALITY),\n      postTown: convertToTitleCase(POST_TOWN),\n      county: convertToTitleCase(LOCAL_CUSTODIAN_CODE_DESCRIPTION),\n      postcode: POSTCODE,\n      country: COUNTRY_CODE,\n      uprn: UPRN,\n    }\n  }\n\n  private formatAddressString(addressResult: OsPlacesDeliveryPointAddress) {\n    const { ADDRESS, BUILDING_NUMBER, THOROUGHFARE_NAME, POSTCODE } = addressResult\n    const withoutPostcode = ADDRESS.replace(`, ${POSTCODE}`, '').replace(\n      `${BUILDING_NUMBER}, ${THOROUGHFARE_NAME}`,\n      `${BUILDING_NUMBER} ${THOROUGHFARE_NAME}`,\n    )\n    return `${convertToTitleCase(withoutPostcode)}, ${POSTCODE}`\n  }\n}\n","import superagent from 'superagent'\nimport { ApiConfig } from '@ministryofjustice/hmpps-rest-client'\nimport { OsPlacesQueryResponse } from '../types/public/addressAutosuggest/osPlaces'\nimport { ConnectDpsComponentLogger } from '../types/public/ConnectDpsComponentLogger'\n\nexport default class OsPlacesApiClient {\n  constructor(\n    private readonly logger: ConnectDpsComponentLogger,\n    private readonly config: ApiConfig & { apiKey: string },\n  ) {}\n\n  async getAddressesByFreeTextQuery(freeTextQuery: string): Promise<OsPlacesQueryResponse> {\n    const queryParams: Record<string, string> = {\n      query: freeTextQuery,\n      lr: 'EN',\n      key: this.config.apiKey,\n    }\n\n    return this.get<Promise<OsPlacesQueryResponse>>('/find', queryParams)\n  }\n\n  async getAddressesByUprn(uprn: string): Promise<OsPlacesQueryResponse> {\n    const queryParams: Record<string, string> = {\n      uprn,\n      key: this.config.apiKey,\n    }\n\n    return this.get<Promise<OsPlacesQueryResponse>>('/uprn', queryParams)\n  }\n\n  async get<T>(path: string, query: Record<string, string>): Promise<T> {\n    const endpoint = `${this.config.url}${path}`\n    try {\n      const result = await superagent\n        .get(endpoint)\n        .retry(2, (err, res) => {\n          if (err) this.logger.info(`Retry handler found API error with ${err.code} ${err.message}`)\n          return undefined // retry handler only for logging retries, not to influence retry logic\n        })\n        .query(query)\n        .timeout(this.config.timeout)\n\n      return result.body\n    } catch (error: any) {\n      throw Error(`Error calling OS Places API: ${error.message}`)\n    }\n  }\n}\n","import { Alert, AlertsServiceAlert } from '../types/public/alertFlags/Alert'\nimport { AlertFlagLabel } from '../types/public/alertFlags/AlertFlagLabel'\n\nexport const alertFlagLabels = [\n  { alertCodes: ['HA'], classes: 'dps-alert-status dps-alert-status--self-harm', label: 'ACCT open' },\n  {\n    alertCodes: ['HA1'],\n    classes: 'dps-alert-status dps-alert-status--self-harm',\n    label: 'ACCT post closure',\n  },\n  {\n    alertCodes: ['XSA', 'SA'],\n    classes: 'dps-alert-status dps-alert-status--security',\n    label: 'Staff assaulter',\n  },\n  {\n    alertCodes: ['XA'],\n    classes: 'dps-alert-status dps-alert-status--security',\n    label: 'Arsonist',\n  },\n  {\n    alertCodes: ['PEEP'],\n    classes: 'dps-alert-status dps-alert-status--medical',\n    label: 'PEEP',\n  },\n  {\n    alertCodes: ['HID'],\n    classes: 'dps-alert-status dps-alert-status--medical',\n    label: 'Hidden disability',\n  },\n  { alertCodes: ['XEL'], classes: 'dps-alert-status dps-alert-status--security', label: 'E-list' },\n  { alertCodes: ['XELH'], classes: 'dps-alert-status dps-alert-status--security', label: 'E-list heightened' },\n  { alertCodes: ['XER'], classes: 'dps-alert-status dps-alert-status--security', label: 'Escape risk' },\n  {\n    alertCodes: ['XRF'],\n    classes: 'dps-alert-status dps-alert-status--security',\n    label: 'Risk to females',\n  },\n  { alertCodes: ['XTACT'], classes: 'dps-alert-status dps-alert-status--security', label: 'TACT' },\n  {\n    alertCodes: ['XCO'],\n    classes: 'dps-alert-status dps-alert-status--security',\n    label: 'Corruptor',\n  },\n  {\n    alertCodes: ['XCA'],\n    classes: 'dps-alert-status dps-alert-status--security',\n    label: 'Chemical attacker',\n  },\n  {\n    alertCodes: ['XCI'],\n    classes: 'dps-alert-status dps-alert-status--security',\n    label: 'Concerted indiscipline',\n  },\n  { alertCodes: ['XR'], classes: 'dps-alert-status dps-alert-status--security', label: 'Racist' },\n  {\n    alertCodes: ['RTP', 'RLG'],\n    classes: 'dps-alert-status dps-alert-status--risk',\n    label: 'Risk to LGBT',\n  },\n  {\n    alertCodes: ['XHT'],\n    classes: 'dps-alert-status dps-alert-status--security',\n    label: 'Hostage taker',\n  },\n  {\n    alertCodes: ['XCU'],\n    classes: 'dps-alert-status dps-alert-status--security',\n    label: 'Controlled unlock',\n  },\n  {\n    alertCodes: ['XGANG'],\n    classes: 'dps-alert-status dps-alert-status--security',\n    label: 'Gang member',\n  },\n  { alertCodes: ['CSIP'], classes: 'dps-alert-status dps-alert-status--other', label: 'CSIP' },\n  { alertCodes: ['F1'], classes: 'dps-alert-status dps-alert-status--ex-armed-forces', label: 'Veteran' },\n  {\n    alertCodes: ['LCE'],\n    classes: 'dps-alert-status dps-alert-status--care-leaver',\n    label: 'Care experienced',\n  },\n  {\n    alertCodes: ['RNO121'],\n    classes: 'dps-alert-status dps-alert-status--risk',\n    label: 'No one-to-one',\n  },\n  { alertCodes: ['RCON'], classes: 'dps-alert-status dps-alert-status--risk', label: 'Conflict' },\n  {\n    alertCodes: ['RCDR'],\n    classes: 'dps-alert-status dps-alert-status--quarantined',\n    label: 'Quarantined',\n  },\n  {\n    alertCodes: ['URCU'],\n    classes: 'dps-alert-status dps-alert-status--reverse-cohorting-unit',\n    label: 'Reverse Cohorting Unit',\n  },\n  {\n    alertCodes: ['UPIU'],\n    classes: 'dps-alert-status dps-alert-status--protective-isolation-unit',\n    label: 'Protective Isolation Unit',\n  },\n  { alertCodes: ['USU'], classes: 'dps-alert-status dps-alert-status--shielding-unit', label: 'Shielding Unit' },\n  {\n    alertCodes: ['URS'],\n    classes: 'dps-alert-status dps-alert-status--refusing-to-shield',\n    label: 'Refusing to shield',\n  },\n  {\n    alertCodes: ['RKS'],\n    classes: 'dps-alert-status dps-alert-status--risk-to-known-adults',\n    label: 'Risk to known adults',\n  },\n  { alertCodes: ['VIP'], classes: 'dps-alert-status dps-alert-status--isolated-prisoner', label: 'Isolated' },\n  {\n    alertCodes: ['PVN'],\n    classes: 'dps-alert-status dps-alert-status--multicase dps-alert-status--visor',\n    label: 'ViSOR',\n  },\n  {\n    alertCodes: ['XCDO'],\n    classes: 'dps-alert-status dps-alert-status--security',\n    label: 'Involved in 2024 civil disorder',\n  },\n  {\n    alertCodes: ['XVL'],\n    classes: 'dps-alert-status dps-alert-status--security',\n    label: 'Violent',\n  },\n].sort((a, b) => a.label.localeCompare(b.label))\n\nfunction isAlertsServiceAlert(alert: Alert): alert is AlertsServiceAlert {\n  return typeof alert.alertCode !== 'string'\n}\n\nexport default function getAlertFlagLabelsForAlerts(prisonerAlerts: Alert[]): AlertFlagLabel[] {\n  return alertFlagLabels.reduce(\n    (acc: AlertFlagLabel[], flag: { alertCodes: string[]; classes: string; label: string }) => {\n      const alertIds = prisonerAlerts\n        .filter(alert => {\n          const alertsServiceAlert = isAlertsServiceAlert(alert)\n          const alertIsActive = alertsServiceAlert ? alert.isActive : alert.active && !alert.expired\n          const prisonerAlertCode = alertsServiceAlert ? alert.alertCode.code : alert.alertCode\n\n          return alertIsActive && flag.alertCodes.includes(prisonerAlertCode)\n        })\n        .map(alert => (isAlertsServiceAlert(alert) ? (alert.alertUuid as string) : alert.alertCode))\n\n      return alertIds.length ? [...acc, { ...flag, alertIds }] : acc\n    },\n    [] as AlertFlagLabel[],\n  )\n}\n"],"names":[],"mappings":";;;AAAA,MAAM,OAAO,GAAG,CAAC,GAAW,KAAc,CAAC,GAAG,IAAI,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC;AAEnE,MAAM,UAAU,GAAG,CAAC,IAAY,KAC9B,IAAI,CAAC,MAAM,IAAI,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,GAAG,IAAI,CAAC,WAAW,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,GAAG,IAAI;AAE/E;;;;;AAKG;AACI,MAAM,cAAc,GAAG,CAAC,IAAY,MAAc,OAAO,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AAEjH,MAAM,kBAAkB,GAAG,CAAC,QAAgB,KACjD,OAAO,CAAC,QAAQ,CAAC,GAAG,EAAE,GAAG,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC;;ACP5E,MAAM,mBAAmB,GAAG,qCAAqC;AACjE,MAAM,6BAA6B,GAAG,kDAAkD;AAE1E,MAAO,sBAAsB,CAAA;AAEtB,IAAA,MAAA;AACA,IAAA,iBAAA;IAFnB,WAAA,CACmB,MAAiC,EACjC,iBAAoC,EAAA;QADpC,IAAA,CAAA,MAAM,GAAN,MAAM;QACN,IAAA,CAAA,iBAAiB,GAAjB,iBAAiB;IACjC;AAEI,IAAA,MAAM,yBAAyB,CAAC,WAAmB,EAAE,mBAA4B,IAAI,EAAA;QAC1F,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,iBAAiB,CAAC,2BAA2B,CACvE,gBAAgB,GAAG,IAAI,CAAC,kBAAkB,CAAC,WAAW,CAAC,GAAG,WAAW,CACtE;QAED,MAAM,UAAU,GAAG,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC;AAEhD,QAAA,MAAM,gBAAgB,GAAG,IAAI,IAAI,CAAC,UAAU,EAAE;AAC5C,YAAA,UAAU,EAAE,IAAI;AAChB,YAAA,SAAS,EAAE,GAAG;AACd,YAAA,cAAc,EAAE,IAAI;AACpB,YAAA,IAAI,EAAE,CAAC,EAAE,IAAI,EAAE,eAAe,EAAE,CAAC;SAClC;aACE,MAAM,CAAC,WAAW;aAClB,GAAG,CAAC,MAAM,IAAI,MAAM,CAAC,IAAI,CAAC;QAE7B,MAAM,gBAAgB,GAAG,mBAAmB,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,EAAE,CAAC;AACrE,QAAA,MAAM,kBAAkB,GAAG,CAAC,CAAY,EAAE,CAAY,KACpD,CAAC,EAAE,aAAa,IAAI,CAAC,EAAE,aAAa,IAAI;cACpC,CAAC,CAAC,aAAa,CAAC,aAAa,CAAC,CAAC,CAAC,aAAa,EAAE,SAAS,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,WAAW,EAAE,MAAM,EAAE;cAChG,CAAC;;QAGP,OAAO,CAAC,gBAAgB,CAAC,MAAM,GAAG,gBAAgB,GAAG,UAAU,EAAE,IAAI,CAAC,kBAAkB,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE,GAAG,CAAC;IACzG;IAEO,MAAM,gBAAgB,CAAC,IAAY,EAAA;QACxC,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,iBAAiB,CAAC,kBAAkB,CAAC,IAAI,CAAC;QACtE,MAAM,MAAM,GAAG,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC;AAE5C,QAAA,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC;AAAE,YAAA,OAAO,IAAI;AACpC,QAAA,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC;AAAE,YAAA,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAA,kCAAA,CAAoC,CAAC;QAE7E,OAAO,MAAM,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC;IAClC;AAEO,IAAA,kBAAkB,CAAC,wBAAgC,EAAA;AACxD,QAAA,MAAM,aAAa,GAAG,6BAA6B,CAAC,IAAI,CAAC,wBAAwB,EAAE,OAAO,CAAC,cAAc,EAAE,EAAE,CAAC,CAAC;AAC/G,QAAA,IAAI,CAAC,aAAa;AAAE,YAAA,OAAO,wBAAwB;AAEnD,QAAA,OAAO,CAAA,EAAG,aAAa,CAAC,CAAC,CAAC,CAAA,EAAG,aAAa,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC,IAAI,EAAE,CAAA,CAAA,EAAI,aAAa,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC,IAAI,EAAE,GAAG,aAAa,CAAC,CAAC,CAAC,EAAE;IAClI;AAEQ,IAAA,cAAc,CAAC,QAA+B,EAAA;QACpD,IAAI,QAAQ,CAAC,MAAM,IAAI,QAAQ,CAAC,MAAM,CAAC,YAAY,KAAK,CAAC;AAAE,YAAA,OAAO,EAAE;AAEpE,QAAA,OAAO,QAAQ,CAAC,OAAO,CAAC,MAAM,CAAC,MAAM,IAAI,MAAM,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,MAAM,IAAI,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,GAAI,CAAC,CAAC;IACnG;AAEQ,IAAA,WAAW,CAAC,aAA2C,EAAA;QAC7D,MAAM,EACJ,IAAI,EACJ,kBAAkB,EAClB,iBAAiB,EACjB,aAAa,EACb,eAAe,EACf,iBAAiB,EACjB,SAAS,EACT,QAAQ,EACR,YAAY,EACZ,gCAAgC,GACjC,GAAG,aAAa;QAEjB,OAAO;AACL,YAAA,aAAa,EAAE,IAAI,CAAC,mBAAmB,CAAC,aAAa,CAAC;AACtD,YAAA,cAAc,EAAE,eAAe;AAC/B,YAAA,YAAY,EAAE,kBAAkB,CAAC,aAAa,CAAC;AAC/C,YAAA,eAAe,EAAE,kBAAkB,CAAC,iBAAiB,CAAC;AACtD,YAAA,gBAAgB,EAAE,kBAAkB,CAAC,iBAAiB,CAAC;AACvD,YAAA,iBAAiB,EAAE,kBAAkB,CAAC,kBAAkB,CAAC;AACzD,YAAA,QAAQ,EAAE,kBAAkB,CAAC,SAAS,CAAC;AACvC,YAAA,MAAM,EAAE,kBAAkB,CAAC,gCAAgC,CAAC;AAC5D,YAAA,QAAQ,EAAE,QAAQ;AAClB,YAAA,OAAO,EAAE,YAAY;AACrB,YAAA,IAAI,EAAE,IAAI;SACX;IACH;AAEQ,IAAA,mBAAmB,CAAC,aAA2C,EAAA;QACrE,MAAM,EAAE,OAAO,EAAE,eAAe,EAAE,iBAAiB,EAAE,QAAQ,EAAE,GAAG,aAAa;QAC/E,MAAM,eAAe,GAAG,OAAO,CAAC,OAAO,CAAC,CAAA,EAAA,EAAK,QAAQ,CAAA,CAAE,EAAE,EAAE,CAAC,CAAC,OAAO,CAClE,CAAA,EAAG,eAAe,CAAA,EAAA,EAAK,iBAAiB,CAAA,CAAE,EAC1C,CAAA,EAAG,eAAe,CAAA,CAAA,EAAI,iBAAiB,CAAA,CAAE,CAC1C;QACD,OAAO,CAAA,EAAG,kBAAkB,CAAC,eAAe,CAAC,CAAA,EAAA,EAAK,QAAQ,EAAE;IAC9D;AACD;;ACjGa,MAAO,iBAAiB,CAAA;AAEjB,IAAA,MAAA;AACA,IAAA,MAAA;IAFnB,WAAA,CACmB,MAAiC,EACjC,MAAsC,EAAA;QADtC,IAAA,CAAA,MAAM,GAAN,MAAM;QACN,IAAA,CAAA,MAAM,GAAN,MAAM;IACtB;IAEH,MAAM,2BAA2B,CAAC,aAAqB,EAAA;AACrD,QAAA,MAAM,WAAW,GAA2B;AAC1C,YAAA,KAAK,EAAE,aAAa;AACpB,YAAA,EAAE,EAAE,IAAI;AACR,YAAA,GAAG,EAAE,IAAI,CAAC,MAAM,CAAC,MAAM;SACxB;QAED,OAAO,IAAI,CAAC,GAAG,CAAiC,OAAO,EAAE,WAAW,CAAC;IACvE;IAEA,MAAM,kBAAkB,CAAC,IAAY,EAAA;AACnC,QAAA,MAAM,WAAW,GAA2B;YAC1C,IAAI;AACJ,YAAA,GAAG,EAAE,IAAI,CAAC,MAAM,CAAC,MAAM;SACxB;QAED,OAAO,IAAI,CAAC,GAAG,CAAiC,OAAO,EAAE,WAAW,CAAC;IACvE;AAEA,IAAA,MAAM,GAAG,CAAI,IAAY,EAAE,KAA6B,EAAA;QACtD,MAAM,QAAQ,GAAG,CAAA,EAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAA,EAAG,IAAI,CAAA,CAAE;AAC5C,QAAA,IAAI;YACF,MAAM,MAAM,GAAG,MAAM;iBAClB,GAAG,CAAC,QAAQ;iBACZ,KAAK,CAAC,CAAC,EAAE,CAAC,GAAG,EAAE,GAAG,KAAI;AACrB,gBAAA,IAAI,GAAG;AAAE,oBAAA,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAA,mCAAA,EAAsC,GAAG,CAAC,IAAI,IAAI,GAAG,CAAC,OAAO,CAAA,CAAE,CAAC;gBAC1F,OAAO,SAAS,CAAA;AAClB,YAAA,CAAC;iBACA,KAAK,CAAC,KAAK;AACX,iBAAA,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC;YAE/B,OAAO,MAAM,CAAC,IAAI;QACpB;QAAE,OAAO,KAAU,EAAE;YACnB,MAAM,KAAK,CAAC,CAAA,6BAAA,EAAgC,KAAK,CAAC,OAAO,CAAA,CAAE,CAAC;QAC9D;IACF;AACD;;AC5CM,MAAM,eAAe,GAAG;AAC7B,IAAA,EAAE,UAAU,EAAE,CAAC,IAAI,CAAC,EAAE,OAAO,EAAE,8CAA8C,EAAE,KAAK,EAAE,WAAW,EAAE;AACnG,IAAA;QACE,UAAU,EAAE,CAAC,KAAK,CAAC;AACnB,QAAA,OAAO,EAAE,8CAA8C;AACvD,QAAA,KAAK,EAAE,mBAAmB;AAC3B,KAAA;AACD,IAAA;AACE,QAAA,UAAU,EAAE,CAAC,KAAK,EAAE,IAAI,CAAC;AACzB,QAAA,OAAO,EAAE,6CAA6C;AACtD,QAAA,KAAK,EAAE,iBAAiB;AACzB,KAAA;AACD,IAAA;QACE,UAAU,EAAE,CAAC,IAAI,CAAC;AAClB,QAAA,OAAO,EAAE,6CAA6C;AACtD,QAAA,KAAK,EAAE,UAAU;AAClB,KAAA;AACD,IAAA;QACE,UAAU,EAAE,CAAC,MAAM,CAAC;AACpB,QAAA,OAAO,EAAE,4CAA4C;AACrD,QAAA,KAAK,EAAE,MAAM;AACd,KAAA;AACD,IAAA;QACE,UAAU,EAAE,CAAC,KAAK,CAAC;AACnB,QAAA,OAAO,EAAE,4CAA4C;AACrD,QAAA,KAAK,EAAE,mBAAmB;AAC3B,KAAA;AACD,IAAA,EAAE,UAAU,EAAE,CAAC,KAAK,CAAC,EAAE,OAAO,EAAE,6CAA6C,EAAE,KAAK,EAAE,QAAQ,EAAE;AAChG,IAAA,EAAE,UAAU,EAAE,CAAC,MAAM,CAAC,EAAE,OAAO,EAAE,6CAA6C,EAAE,KAAK,EAAE,mBAAmB,EAAE;AAC5G,IAAA,EAAE,UAAU,EAAE,CAAC,KAAK,CAAC,EAAE,OAAO,EAAE,6CAA6C,EAAE,KAAK,EAAE,aAAa,EAAE;AACrG,IAAA;QACE,UAAU,EAAE,CAAC,KAAK,CAAC;AACnB,QAAA,OAAO,EAAE,6CAA6C;AACtD,QAAA,KAAK,EAAE,iBAAiB;AACzB,KAAA;AACD,IAAA,EAAE,UAAU,EAAE,CAAC,OAAO,CAAC,EAAE,OAAO,EAAE,6CAA6C,EAAE,KAAK,EAAE,MAAM,EAAE;AAChG,IAAA;QACE,UAAU,EAAE,CAAC,KAAK,CAAC;AACnB,QAAA,OAAO,EAAE,6CAA6C;AACtD,QAAA,KAAK,EAAE,WAAW;AACnB,KAAA;AACD,IAAA;QACE,UAAU,EAAE,CAAC,KAAK,CAAC;AACnB,QAAA,OAAO,EAAE,6CAA6C;AACtD,QAAA,KAAK,EAAE,mBAAmB;AAC3B,KAAA;AACD,IAAA;QACE,UAAU,EAAE,CAAC,KAAK,CAAC;AACnB,QAAA,OAAO,EAAE,6CAA6C;AACtD,QAAA,KAAK,EAAE,wBAAwB;AAChC,KAAA;AACD,IAAA,EAAE,UAAU,EAAE,CAAC,IAAI,CAAC,EAAE,OAAO,EAAE,6CAA6C,EAAE,KAAK,EAAE,QAAQ,EAAE;AAC/F,IAAA;AACE,QAAA,UAAU,EAAE,CAAC,KAAK,EAAE,KAAK,CAAC;AAC1B,QAAA,OAAO,EAAE,yCAAyC;AAClD,QAAA,KAAK,EAAE,cAAc;AACtB,KAAA;AACD,IAAA;QACE,UAAU,EAAE,CAAC,KAAK,CAAC;AACnB,QAAA,OAAO,EAAE,6CAA6C;AACtD,QAAA,KAAK,EAAE,eAAe;AACvB,KAAA;AACD,IAAA;QACE,UAAU,EAAE,CAAC,KAAK,CAAC;AACnB,QAAA,OAAO,EAAE,6CAA6C;AACtD,QAAA,KAAK,EAAE,mBAAmB;AAC3B,KAAA;AACD,IAAA;QACE,UAAU,EAAE,CAAC,OAAO,CAAC;AACrB,QAAA,OAAO,EAAE,6CAA6C;AACtD,QAAA,KAAK,EAAE,aAAa;AACrB,KAAA;AACD,IAAA,EAAE,UAAU,EAAE,CAAC,MAAM,CAAC,EAAE,OAAO,EAAE,0CAA0C,EAAE,KAAK,EAAE,MAAM,EAAE;AAC5F,IAAA,EAAE,UAAU,EAAE,CAAC,IAAI,CAAC,EAAE,OAAO,EAAE,oDAAoD,EAAE,KAAK,EAAE,SAAS,EAAE;AACvG,IAAA;QACE,UAAU,EAAE,CAAC,KAAK,CAAC;AACnB,QAAA,OAAO,EAAE,gDAAgD;AACzD,QAAA,KAAK,EAAE,kBAAkB;AAC1B,KAAA;AACD,IAAA;QACE,UAAU,EAAE,CAAC,QAAQ,CAAC;AACtB,QAAA,OAAO,EAAE,yCAAyC;AAClD,QAAA,KAAK,EAAE,eAAe;AACvB,KAAA;AACD,IAAA,EAAE,UAAU,EAAE,CAAC,MAAM,CAAC,EAAE,OAAO,EAAE,yCAAyC,EAAE,KAAK,EAAE,UAAU,EAAE;AAC/F,IAAA;QACE,UAAU,EAAE,CAAC,MAAM,CAAC;AACpB,QAAA,OAAO,EAAE,gDAAgD;AACzD,QAAA,KAAK,EAAE,aAAa;AACrB,KAAA;AACD,IAAA;QACE,UAAU,EAAE,CAAC,MAAM,CAAC;AACpB,QAAA,OAAO,EAAE,2DAA2D;AACpE,QAAA,KAAK,EAAE,wBAAwB;AAChC,KAAA;AACD,IAAA;QACE,UAAU,EAAE,CAAC,MAAM,CAAC;AACpB,QAAA,OAAO,EAAE,8DAA8D;AACvE,QAAA,KAAK,EAAE,2BAA2B;AACnC,KAAA;AACD,IAAA,EAAE,UAAU,EAAE,CAAC,KAAK,CAAC,EAAE,OAAO,EAAE,mDAAmD,EAAE,KAAK,EAAE,gBAAgB,EAAE;AAC9G,IAAA;QACE,UAAU,EAAE,CAAC,KAAK,CAAC;AACnB,QAAA,OAAO,EAAE,uDAAuD;AAChE,QAAA,KAAK,EAAE,oBAAoB;AAC5B,KAAA;AACD,IAAA;QACE,UAAU,EAAE,CAAC,KAAK,CAAC;AACnB,QAAA,OAAO,EAAE,yDAAyD;AAClE,QAAA,KAAK,EAAE,sBAAsB;AAC9B,KAAA;AACD,IAAA,EAAE,UAAU,EAAE,CAAC,KAAK,CAAC,EAAE,OAAO,EAAE,sDAAsD,EAAE,KAAK,EAAE,UAAU,EAAE;AAC3G,IAAA;QACE,UAAU,EAAE,CAAC,KAAK,CAAC;AACnB,QAAA,OAAO,EAAE,sEAAsE;AAC/E,QAAA,KAAK,EAAE,OAAO;AACf,KAAA;AACD,IAAA;QACE,UAAU,EAAE,CAAC,MAAM,CAAC;AACpB,QAAA,OAAO,EAAE,6CAA6C;AACtD,QAAA,KAAK,EAAE,iCAAiC;AACzC,KAAA;AACD,IAAA;QACE,UAAU,EAAE,CAAC,KAAK,CAAC;AACnB,QAAA,OAAO,EAAE,6CAA6C;AACtD,QAAA,KAAK,EAAE,SAAS;AACjB,KAAA;CACF,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;AAEhD,SAAS,oBAAoB,CAAC,KAAY,EAAA;AACxC,IAAA,OAAO,OAAO,KAAK,CAAC,SAAS,KAAK,QAAQ;AAC5C;AAEc,SAAU,2BAA2B,CAAC,cAAuB,EAAA;IACzE,OAAO,eAAe,CAAC,MAAM,CAC3B,CAAC,GAAqB,EAAE,IAA8D,KAAI;QACxF,MAAM,QAAQ,GAAG;aACd,MAAM,CAAC,KAAK,IAAG;AACd,YAAA,MAAM,kBAAkB,GAAG,oBAAoB,CAAC,KAAK,CAAC;YACtD,MAAM,aAAa,GAAG,kBAAkB,GAAG,KAAK,CAAC,QAAQ,GAAG,KAAK,CAAC,MAAM,IAAI,CAAC,KAAK,CAAC,OAAO;AAC1F,YAAA,MAAM,iBAAiB,GAAG,kBAAkB,GAAG,KAAK,CAAC,SAAS,CAAC,IAAI,GAAG,KAAK,CAAC,SAAS;YAErF,OAAO,aAAa,IAAI,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,iBAAiB,CAAC;AACrE,QAAA,CAAC;aACA,GAAG,CAAC,KAAK,KAAK,oBAAoB,CAAC,KAAK,CAAC,GAAI,KAAK,CAAC,SAAoB,GAAG,KAAK,CAAC,SAAS,CAAC,CAAC;QAE9F,OAAO,QAAQ,CAAC,MAAM,GAAG,CAAC,GAAG,GAAG,EAAE,EAAE,GAAG,IAAI,EAAE,QAAQ,EAAE,CAAC,GAAG,GAAG;IAChE,CAAC,EACD,EAAsB,CACvB;AACH;;;;"}

package/dist/types/public/ConnectDpsComponentLogger.d.ts

@@ -0,0 +1,2 @@
+import type Logger from 'bunyan';
+export type ConnectDpsComponentLogger = Logger | typeof console;

package/dist/types/public/addressAutosuggest/index.d.ts

@@ -0,0 +1,2 @@
+export type { default as OsPlacesAddressService } from '../../../addressAutosuggest/osPlacesAddressService';
+export type { default as OsPlacesApiClient } from '../../../addressAutosuggest/osPlacesApiClient';

package/dist/types/public/addressAutosuggest/osAddress.d.ts

@@ -0,0 +1,13 @@
+export interface OsAddress {
+    addressString?: string;
+    buildingNumber?: number;
+    buildingName?: string;
+    subBuildingName?: string;
+    thoroughfareName?: string;
+    dependentLocality?: string;
+    postTown?: string;
+    county?: string;
+    postcode?: string;
+    country?: string;
+    uprn?: number;
+}

package/dist/types/public/addressAutosuggest/osPlaces.d.ts

@@ -0,0 +1,124 @@
+export interface OsPlacesQueryResponse {
+    header: OsPlacesResponseHeader;
+    results: OsPlacesQueryResult[];
+}
+export interface OsPlacesResponseHeader {
+    uri: string;
+    query: string;
+    offset: number;
+    totalresults: number;
+    format: string;
+    dataset: string;
+    lr: string;
+    maxresults: number;
+    matchprecision: number;
+    epoch: string;
+    lastupdate: string;
+    output_srs: string;
+}
+export interface OsPlacesQueryResult {
+    DPA?: OsPlacesDeliveryPointAddress;
+    LPI?: OsPlacesLandPropertyIdentifier;
+}
+export interface OsPlacesLandPropertyIdentifier {
+    UPRN: number;
+    ADDRESS: string;
+    USRN: number;
+    LPI_KEY: string;
+    ORGANISATION: string;
+    SAO_START_NUMBER: number;
+    SAO_START_SUFFIX: string;
+    SAO_END_NUMBER: number;
+    SAO_END_SUFFIX: string;
+    SAO_TEXT: string;
+    PAO_START_NUMBER: number;
+    PAO_START_SUFFIX: string;
+    PAO_END_NUMBER: number;
+    PAO_END_SUFFIX: string;
+    PAO_TEXT: string;
+    STREET_DESCRIPTION: string;
+    LOCALITY_NAME: string;
+    TOWN_NAME: string;
+    ADMINISTRATIVE_AREA: string;
+    AREA_NAME: string;
+    POSTCODE_LOCATOR: string;
+    RPC: string;
+    X_COORDINATE: number;
+    Y_COORDINATE: number;
+    LNG: number;
+    LAT: number;
+    STATUS: string;
+    LOGICAL_STATUS_CODE: number;
+    CLASSIFICATION_CODE: string;
+    CLASSIFICATION_CODE_DESCRIPTION: string;
+    LOCAL_CUSTODIAN_CODE: number;
+    LOCAL_CUSTODIAN_CODE_DESCRIPTION: string;
+    COUNTRY_CODE: string;
+    COUNTRY_CODE_DESCRIPTION: string;
+    POSTAL_ADDRESS_CODE: string;
+    POSTAL_ADDRESS_CODE_DESCRIPTION: string;
+    BLPU_STATE_CODE: number;
+    BLPU_STATE_CODE_DESCRIPTION: string;
+    TOPOGRAPHY_LAYER_TOID: string;
+    WARD_CODE: string;
+    PARISH_CODE: string;
+    PARENT_UPRN: number;
+    LAST_UPDATE_DATE: string;
+    ENTRY_DATE: string;
+    LEGAL_NAME: string;
+    BLPU_STATE_DATE: string;
+    STREET_STATE_CODE: number;
+    STREET_STATE_CODE_DESCRIPTION: string;
+    STREET_CLASSIFICATION_CODE: string;
+    STREET_CLASSIFICATION_CODE_DESCRIPTION: string;
+    LPI_LOGICAL_STATUS_CODE: number;
+    LPI_LOGICAL_STATUS_CODE_DESCRIPTION: string;
+    LANGUAGE: string;
+    MATCH: number;
+    MATCH_DESCRIPTION: string;
+}
+export interface OsPlacesDeliveryPointAddress {
+    UPRN: number;
+    UDPRN: number;
+    ADDRESS: string;
+    ORGANISATION_NAME: string;
+    DEPARTMENT_NAME: string;
+    SUB_BUILDING_NAME: string;
+    BUILDING_NAME: string;
+    BUILDING_NUMBER: number;
+    DEPENDENT_THOROUGHFARE_NAME: string;
+    THOROUGHFARE_NAME: string;
+    DOUBLE_DEPENDENT_LOCALITY: string;
+    DEPENDENT_LOCALITY: string;
+    POST_TOWN: string;
+    POSTCODE: string;
+    RPC: string;
+    X_COORDINATE: number;
+    Y_COORDINATE: number;
+    LNG: number;
+    LAT: number;
+    STATUS: string;
+    LOGICAL_STATUS_CODE: number;
+    CLASSIFICATION_CODE: string;
+    CLASSIFICATION_CODE_DESCRIPTION: string;
+    LOCAL_CUSTODIAN_CODE: number;
+    LOCAL_CUSTODIAN_CODE_DESCRIPTION: string;
+    COUNTRY_CODE: string;
+    COUNTRY_CODE_DESCRIPTION: string;
+    POSTAL_ADDRESS_CODE: string;
+    POSTAL_ADDRESS_CODE_DESCRIPTION: string;
+    BLPU_STATE_CODE: number;
+    BLPU_STATE_CODE_DESCRIPTION: string;
+    TOPOGRAPHY_LAYER_TOID: string;
+    WARD_CODE: string;
+    PARISH_CODE: string;
+    PARENT_UPRN: number;
+    LAST_UPDATE_DATE: string;
+    ENTRY_DATE: string;
+    LEGAL_NAME: string;
+    BLPU_STATE_DATE: string;
+    LANGUAGE: string;
+    MATCH: number;
+    MATCH_DESCRIPTION: string;
+    DELIVERY_POINT_SUFFIX: string;
+}

package/dist/utils/utils.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Converts a name (first name, last name, middle name, etc.) to proper case equivalent, handling double-barreled names
+ * correctly (i.e. each part in a double-barreled is converted to proper case).
+ * @param name name to be converted.
+ * @returns name converted to proper case.
+ */
+export declare const properCaseName: (name: string) => string;
+export declare const convertToTitleCase: (sentence: string) => string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ministryofjustice/hmpps-connect-dps-shared-items",
-  "version": "2.0.0",
+  "version": "2.1.0",
   "description": "A package to share Connect DPS functionality across applications",
   "main": "./dist/index.cjs",
   "module": "./dist/index.esm.js",
@@ -55,17 +55,25 @@
     "@rollup/plugin-typescript": "^12.1.4",
     "@tsconfig/node22": "^22.0.2",
     "@types/jest": "^29.5.14",
+    "@types/superagent": "^8.1.9",
     "@typescript-eslint/eslint-plugin": "^8.41.0",
     "eslint-import-resolver-typescript": "^4.4.4",
     "eslint-plugin-no-only-tests": "^3.3.0",
+    "govuk-frontend": "^5.11.2",
     "jest": "^29.7.0",
     "jest-html-reporter": "^3.10.2",
     "jest-junit": "^16.0.0",
     "lint-staged": "^16.1.5",
+    "nock": "^14.0.10",
     "rollup": "^4.49.0",
     "rollup-plugin-dts": "^6.2.3",
     "ts-jest": "^29.4.1",
     "tslib": "^2.8.1"
   },
-  "dependencies": {}
+  "dependencies": {
+    "@ministryofjustice/hmpps-rest-client": "^0.0.1",
+    "@types/bunyan": "^1.8.11",
+    "fuse.js": "^7.1.0",
+    "superagent": "^10.2.3"
+  }
 }

package/readme/publishing.md

@@ -13,9 +13,9 @@ The process to publish a change is as follows:
   semantic versioning, see https://semver.org/)
 * Commit the changes, push the branch and raise a PR
 * Once the PR has been merged to `main`, [create a new release](https://github.com/ministryofjustice/hmpps-connect-dps-shared-items-package/releases/new):
-    * Select the `Choose a tag` dropdown and create a new tag entering the new version number (this must start with a `v`, e.g. `v0.0.1`)
-    * Enter a release title with the following format `<version>: <short title>` e.g. `v0.0.1: First Release`
+    * Select the `Choose a tag` dropdown and create a new tag entering the new version number (e.g. `0.0.1`)
+    * Enter the version number as the release title (e.g. `0.0.1`)
     * Enter a more detailed description of the release
     * Click `Publish release`
 
-CircleCI is configured to trigger on the tagged release and publish to NPM.
+GitHub Actions is configured to trigger on the tagged release and publish to NPM.