@defra/forms-engine-plugin 4.0.40 → 4.0.42

package/.server/server/plugins/map/types.d.ts

@@ -0,0 +1,232 @@
+export type MapConfiguration = {
+    ordnanceSurveyApiKey: string;
+};
+/**
+ * Map proxy query params
+ */
+export type MapProxyQuery = {
+    /**
+     * - the proxied url
+     */
+    url: string;
+};
+/**
+ * Map geocode query params
+ */
+export type MapGeocodeQuery = {
+    /**
+     * - name query
+     */
+    query: string;
+};
+/**
+ * Map reverse geocode query params
+ */
+export type MapReverseGeocodeQuery = {
+    /**
+     * - the Easting point
+     */
+    easting: number;
+    /**
+     * - the Northing point
+     */
+    northing: number;
+};
+/**
+ * Map geocode get request
+ */
+export type MapProxyGetRequestRefs = {
+    /**
+     * - Request query
+     */
+    Query: MapProxyQuery;
+};
+/**
+ * Map geocode get request
+ */
+export type MapGeocodeGetRequestRefs = {
+    /**
+     * - Request query
+     */
+    Query: MapGeocodeQuery;
+};
+/**
+ * Map reverst geocode get request
+ */
+export type MapReverseGeocodeGetRequestRefs = {
+    /**
+     * - Request query
+     */
+    Query: MapReverseGeocodeQuery;
+};
+export type MapProxyRequestRefs = MapProxyGetRequestRefs;
+export type MapGeocodeRequestRefs = MapGeocodeGetRequestRefs;
+export type MapReverseGeocodeRequestRefs = MapReverseGeocodeGetRequestRefs;
+export type MapProxyGetRequest = Request<MapGeocodeGetRequestRefs>;
+export type MapGeocodeGetRequest = Request<MapGeocodeGetRequestRefs>;
+export type MapReverseGeocodeGetRequest = Request<MapReverseGeocodeGetRequestRefs>;
+export type MapRequest = MapProxyGetRequest | MapGeocodeGetRequest | MapReverseGeocodeGetRequest;
+export type OsNamesFindResponse = {
+    /**
+     * - Metadata about the search request and results.
+     */
+    header: OsNamesFindHeader;
+    /**
+     * - An array of matched place records from the search.
+     */
+    results: OsNamesFindResult[];
+};
+export type OsNamesFindHeader = {
+    /**
+     * - The query URI (usually same as search text).
+     */
+    uri: string;
+    /**
+     * - The original text query string passed to the API.
+     */
+    query: string;
+    /**
+     * - The response format returned (e.g., "JSON").
+     */
+    format: string;
+    /**
+     * - The maximum number of results requested.
+     */
+    maxresults: number;
+    /**
+     * - The offset used in the search results.
+     */
+    offset: number;
+    /**
+     * - The total number of results that matched the query.
+     */
+    totalresults: number;
+    /**
+     * - The original filter string passed to the API.
+     */
+    filter: string;
+};
+export type OsNamesFindGazetteerEntry = {
+    /**
+     * - Unique identifier for the place/feature.
+     */
+    ID: string;
+    /**
+     * - A URI (identifier) for this named feature.
+     */
+    NAMES_URI: string;
+    /**
+     * - Primary name of the feature.
+     */
+    NAME1: string;
+    /**
+     * - General type classification of the feature.
+     */
+    TYPE: string;
+    /**
+     * - Local or more specific type classification.
+     */
+    LOCAL_TYPE: string;
+    /**
+     * - Easting coordinate (British National Grid).
+     */
+    GEOMETRY_X: number;
+    /**
+     * - Northing coordinate (British National Grid).
+     */
+    GEOMETRY_Y: number;
+    /**
+     * - Most detailed resolution available.
+     */
+    MOST_DETAIL_VIEW_RES: number;
+    /**
+     * - Least detailed resolution available.
+     */
+    LEAST_DETAIL_VIEW_RES: number;
+    /**
+     * - Minimum bounding box X (easting).
+     */
+    MBR_XMIN?: number | undefined;
+    /**
+     * - Minimum bounding box Y (northing).
+     */
+    MBR_YMIN?: number | undefined;
+    /**
+     * - Maximum bounding box X (easting).
+     */
+    MBR_XMAX?: number | undefined;
+    /**
+     * - Maximum bounding box Y (northing).
+     */
+    MBR_YMAX?: number | undefined;
+    /**
+     * - (Optional) District borough.
+     */
+    DISTRICT_BOROUGH?: string | undefined;
+    /**
+     * - (Optional) URI for the district borough.
+     */
+    DISTRICT_BOROUGH_URI?: string | undefined;
+    /**
+     * - (Optional) Type of the district borough.
+     */
+    DISTRICT_BOROUGH_TYPE?: string | undefined;
+    /**
+     * - (Optional) Postcode district.
+     */
+    POSTCODE_DISTRICT?: string | undefined;
+    /**
+     * - (Optional) URI for the postcode district.
+     */
+    POSTCODE_DISTRICT_URI?: string | undefined;
+    /**
+     * - (Optional) Name of associated populated place.
+     */
+    POPULATED_PLACE?: string | undefined;
+    /**
+     * - (Optional) URI of populated place.
+     */
+    POPULATED_PLACE_URI?: string | undefined;
+    /**
+     * - (Optional) Type of populated place.
+     */
+    POPULATED_PLACE_TYPE?: string | undefined;
+    /**
+     * - (Optional) County or unitary authority name.
+     */
+    COUNTY_UNITARY?: string | undefined;
+    /**
+     * - (Optional) URI for county/unitary authority.
+     */
+    COUNTY_UNITARY_URI?: string | undefined;
+    /**
+     * - (Optional) Classification of county/unitary authority.
+     */
+    COUNTY_UNITARY_TYPE?: string | undefined;
+    /**
+     * - (Optional) Region name.
+     */
+    REGION?: string | undefined;
+    /**
+     * - (Optional) URI for region.
+     */
+    REGION_URI?: string | undefined;
+    /**
+     * - (Optional) Country name.
+     */
+    COUNTRY?: string | undefined;
+    /**
+     * - (Optional) URI for country.
+     */
+    COUNTRY_URI?: string | undefined;
+};
+/**
+ * OS names GAZETTEER_ENTRY response
+ */
+export type OsNamesFindResult = {
+    /**
+     * - Gazetteer entry
+     */
+    GAZETTEER_ENTRY: OsNamesFindGazetteerEntry;
+};
+import type { Request } from '@hapi/hapi';

package/.server/server/plugins/map/types.js

@@ -0,0 +1,120 @@
+/**
+ * @typedef {{
+ *   ordnanceSurveyApiKey: string
+ * }} MapConfiguration
+ */
+
+//
+// Route types
+//
+
+/**
+ * Map proxy query params
+ * @typedef {object} MapProxyQuery
+ * @property {string} url - the proxied url
+ */
+
+/**
+ * Map geocode query params
+ * @typedef {object} MapGeocodeQuery
+ * @property {string} query - name query
+ */
+
+/**
+ * Map reverse geocode query params
+ * @typedef {object} MapReverseGeocodeQuery
+ * @property {number} easting - the Easting point
+ * @property {number} northing - the Northing point
+ */
+
+/**
+ * Map geocode get request
+ * @typedef {object} MapProxyGetRequestRefs
+ * @property {MapProxyQuery} Query - Request query
+ */
+
+/**
+ * Map geocode get request
+ * @typedef {object} MapGeocodeGetRequestRefs
+ * @property {MapGeocodeQuery} Query - Request query
+ */
+
+/**
+ * Map reverst geocode get request
+ * @typedef {object} MapReverseGeocodeGetRequestRefs
+ * @property {MapReverseGeocodeQuery} Query - Request query
+ */
+
+/**
+ * @typedef {MapProxyGetRequestRefs} MapProxyRequestRefs
+ * @typedef {MapGeocodeGetRequestRefs} MapGeocodeRequestRefs
+ * @typedef {MapReverseGeocodeGetRequestRefs} MapReverseGeocodeRequestRefs
+ * @typedef {Request<MapGeocodeGetRequestRefs>} MapProxyGetRequest
+ * @typedef {Request<MapGeocodeGetRequestRefs>} MapGeocodeGetRequest
+ * @typedef {Request<MapReverseGeocodeGetRequestRefs>} MapReverseGeocodeGetRequest
+ * @typedef {MapProxyGetRequest | MapGeocodeGetRequest | MapReverseGeocodeGetRequest} MapRequest
+ */
+
+//
+// Service types
+//
+
+/**
+ * @typedef {object} OsNamesFindResponse
+ * @property {OsNamesFindHeader} header - Metadata about the search request and results.
+ * @property {OsNamesFindResult[]} results - An array of matched place records from the search.
+ */
+
+/**
+ * @typedef {object} OsNamesFindHeader
+ * @property {string} uri - The query URI (usually same as search text).
+ * @property {string} query - The original text query string passed to the API.
+ * @property {string} format - The response format returned (e.g., "JSON").
+ * @property {number} maxresults - The maximum number of results requested.
+ * @property {number} offset - The offset used in the search results.
+ * @property {number} totalresults - The total number of results that matched the query.
+ * @property {string} filter - The original filter string passed to the API.
+ */
+
+/**
+ * @typedef {object} OsNamesFindGazetteerEntry
+ * @property {string} ID - Unique identifier for the place/feature.
+ * @property {string} NAMES_URI - A URI (identifier) for this named feature.
+ * @property {string} NAME1 - Primary name of the feature.
+ * @property {string} TYPE - General type classification of the feature.
+ * @property {string} LOCAL_TYPE - Local or more specific type classification.
+ * @property {number} GEOMETRY_X - Easting coordinate (British National Grid).
+ * @property {number} GEOMETRY_Y - Northing coordinate (British National Grid).
+ * @property {number} MOST_DETAIL_VIEW_RES - Most detailed resolution available.
+ * @property {number} LEAST_DETAIL_VIEW_RES - Least detailed resolution available.
+ * @property {number} [MBR_XMIN] - Minimum bounding box X (easting).
+ * @property {number} [MBR_YMIN] - Minimum bounding box Y (northing).
+ * @property {number} [MBR_XMAX] - Maximum bounding box X (easting).
+ * @property {number} [MBR_YMAX] - Maximum bounding box Y (northing).
+ * @property {string} [DISTRICT_BOROUGH] - (Optional) District borough.
+ * @property {string} [DISTRICT_BOROUGH_URI] - (Optional) URI for the district borough.
+ * @property {string} [DISTRICT_BOROUGH_TYPE] - (Optional) Type of the district borough.
+ * @property {string} [POSTCODE_DISTRICT] - (Optional) Postcode district.
+ * @property {string} [POSTCODE_DISTRICT_URI] - (Optional) URI for the postcode district.
+ * @property {string} [POPULATED_PLACE] - (Optional) Name of associated populated place.
+ * @property {string} [POPULATED_PLACE_URI] - (Optional) URI of populated place.
+ * @property {string} [POPULATED_PLACE_TYPE] - (Optional) Type of populated place.
+ * @property {string} [COUNTY_UNITARY] - (Optional) County or unitary authority name.
+ * @property {string} [COUNTY_UNITARY_URI] - (Optional) URI for county/unitary authority.
+ * @property {string} [COUNTY_UNITARY_TYPE] - (Optional) Classification of county/unitary authority.
+ * @property {string} [REGION] - (Optional) Region name.
+ * @property {string} [REGION_URI] - (Optional) URI for region.
+ * @property {string} [COUNTRY] - (Optional) Country name.
+ * @property {string} [COUNTRY_URI] - (Optional) URI for country.
+ */
+
+/**
+ * OS names GAZETTEER_ENTRY response
+ * @typedef {object} OsNamesFindResult
+ * @property {OsNamesFindGazetteerEntry} GAZETTEER_ENTRY - Gazetteer entry
+ */
+
+/**
+ * @import { Request } from '@hapi/hapi'
+ */
+//# sourceMappingURL=types.js.map

package/.server/server/plugins/map/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","names":[],"sources":["../../../../src/server/plugins/map/types.js"],"sourcesContent":["/**\n * @typedef {{\n *   ordnanceSurveyApiKey: string\n * }} MapConfiguration\n */\n\n//\n// Route types\n//\n\n/**\n * Map proxy query params\n * @typedef {object} MapProxyQuery\n * @property {string} url - the proxied url\n */\n\n/**\n * Map geocode query params\n * @typedef {object} MapGeocodeQuery\n * @property {string} query - name query\n */\n\n/**\n * Map reverse geocode query params\n * @typedef {object} MapReverseGeocodeQuery\n * @property {number} easting - the Easting point\n * @property {number} northing - the Northing point\n */\n\n/**\n * Map geocode get request\n * @typedef {object} MapProxyGetRequestRefs\n * @property {MapProxyQuery} Query - Request query\n */\n\n/**\n * Map geocode get request\n * @typedef {object} MapGeocodeGetRequestRefs\n * @property {MapGeocodeQuery} Query - Request query\n */\n\n/**\n * Map reverst geocode get request\n * @typedef {object} MapReverseGeocodeGetRequestRefs\n * @property {MapReverseGeocodeQuery} Query - Request query\n */\n\n/**\n * @typedef {MapProxyGetRequestRefs} MapProxyRequestRefs\n * @typedef {MapGeocodeGetRequestRefs} MapGeocodeRequestRefs\n * @typedef {MapReverseGeocodeGetRequestRefs} MapReverseGeocodeRequestRefs\n * @typedef {Request<MapGeocodeGetRequestRefs>} MapProxyGetRequest\n * @typedef {Request<MapGeocodeGetRequestRefs>} MapGeocodeGetRequest\n * @typedef {Request<MapReverseGeocodeGetRequestRefs>} MapReverseGeocodeGetRequest\n * @typedef {MapProxyGetRequest | MapGeocodeGetRequest | MapReverseGeocodeGetRequest} MapRequest\n */\n\n//\n// Service types\n//\n\n/**\n * @typedef {object} OsNamesFindResponse\n * @property {OsNamesFindHeader} header - Metadata about the search request and results.\n * @property {OsNamesFindResult[]} results - An array of matched place records from the search.\n */\n\n/**\n * @typedef {object} OsNamesFindHeader\n * @property {string} uri - The query URI (usually same as search text).\n * @property {string} query - The original text query string passed to the API.\n * @property {string} format - The response format returned (e.g., \"JSON\").\n * @property {number} maxresults - The maximum number of results requested.\n * @property {number} offset - The offset used in the search results.\n * @property {number} totalresults - The total number of results that matched the query.\n * @property {string} filter - The original filter string passed to the API.\n */\n\n/**\n * @typedef {object} OsNamesFindGazetteerEntry\n * @property {string} ID - Unique identifier for the place/feature.\n * @property {string} NAMES_URI - A URI (identifier) for this named feature.\n * @property {string} NAME1 - Primary name of the feature.\n * @property {string} TYPE - General type classification of the feature.\n * @property {string} LOCAL_TYPE - Local or more specific type classification.\n * @property {number} GEOMETRY_X - Easting coordinate (British National Grid).\n * @property {number} GEOMETRY_Y - Northing coordinate (British National Grid).\n * @property {number} MOST_DETAIL_VIEW_RES - Most detailed resolution available.\n * @property {number} LEAST_DETAIL_VIEW_RES - Least detailed resolution available.\n * @property {number} [MBR_XMIN] - Minimum bounding box X (easting).\n * @property {number} [MBR_YMIN] - Minimum bounding box Y (northing).\n * @property {number} [MBR_XMAX] - Maximum bounding box X (easting).\n * @property {number} [MBR_YMAX] - Maximum bounding box Y (northing).\n * @property {string} [DISTRICT_BOROUGH] - (Optional) District borough.\n * @property {string} [DISTRICT_BOROUGH_URI] - (Optional) URI for the district borough.\n * @property {string} [DISTRICT_BOROUGH_TYPE] - (Optional) Type of the district borough.\n * @property {string} [POSTCODE_DISTRICT] - (Optional) Postcode district.\n * @property {string} [POSTCODE_DISTRICT_URI] - (Optional) URI for the postcode district.\n * @property {string} [POPULATED_PLACE] - (Optional) Name of associated populated place.\n * @property {string} [POPULATED_PLACE_URI] - (Optional) URI of populated place.\n * @property {string} [POPULATED_PLACE_TYPE] - (Optional) Type of populated place.\n * @property {string} [COUNTY_UNITARY] - (Optional) County or unitary authority name.\n * @property {string} [COUNTY_UNITARY_URI] - (Optional) URI for county/unitary authority.\n * @property {string} [COUNTY_UNITARY_TYPE] - (Optional) Classification of county/unitary authority.\n * @property {string} [REGION] - (Optional) Region name.\n * @property {string} [REGION_URI] - (Optional) URI for region.\n * @property {string} [COUNTRY] - (Optional) Country name.\n * @property {string} [COUNTRY_URI] - (Optional) URI for country.\n */\n\n/**\n * OS names GAZETTEER_ENTRY response\n * @typedef {object} OsNamesFindResult\n * @property {OsNamesFindGazetteerEntry} GAZETTEER_ENTRY - Gazetteer entry\n */\n\n/**\n * @import { Request } from '@hapi/hapi'\n */\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;;AAEA;AACA;AACA;;AAEA;AACA;AACA;AACA;AACA;;AAEA;AACA;AACA;AACA;AACA;;AAEA;AACA;AACA;AACA;AACA;AACA;;AAEA;AACA;AACA;AACA;AACA;;AAEA;AACA;AACA;AACA;AACA;;AAEA;AACA;AACA;AACA;AACA;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAEA;AACA;AACA;;AAEA;AACA;AACA;AACA;AACA;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAEA;AACA;AACA;AACA;AACA;;AAEA;AACA;AACA","ignoreList":[]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@defra/forms-engine-plugin",
-  "version": "4.0.40",
+  "version": "4.0.42",
   "description": "Defra forms engine",
   "type": "module",
   "files": [
@@ -72,6 +72,7 @@
   "dependencies": {
     "@defra/forms-model": "^3.0.603",
     "@defra/hapi-tracing": "^1.29.0",
+    "@defra/interactive-map": "^0.0.3-alpha",
     "@elastic/ecs-pino-format": "^1.5.0",
     "@hapi/boom": "^10.0.1",
     "@hapi/catbox": "^12.1.1",
@@ -96,6 +97,7 @@
     "date-fns": "^4.1.0",
     "dotenv": "^17.2.3",
     "expr-eval-fork": "^3.0.0",
+    "geodesy": "^2.4.0",
     "govuk-frontend": "^5.13.0",
     "hapi-pino": "^13.0.0",
     "hapi-pulse": "^3.0.1",