feat(DTFS-7052): added GET /geospatial/addresses/postcode endpoint for Ordnance Survey API data

.cspell.json

@@ -51,7 +51,19 @@
     "ukef",
     "venv",
     "VNET",
-    "CICD"
+    "CICD",
+    "DPA",
+    "UPRN",
+    "UDPRN",
+    "BLPU",
+    "TOID",
+    "EPSG",
+    "WOGAN",
+    "osgb",
+    "HJLNP",
+    "Zabd",
+    "hjlnp",
+    "BLPUs"
   ],
   "dictionaries": [
     "en-gb",

.env.sample

@@ -38,4 +38,10 @@ APIM_INFORMATICA_URL=
 APIM_INFORMATICA_USERNAME=
 APIM_INFORMATICA_PASSWORD=
 APIM_INFORMATICA_MAX_REDIRECTS=
-APIM_INFORMATICA_TIMEOUT=
+APIM_INFORMATICA_TIMEOUT= # in milliseconds
+
+# ORDNANCE SURVEY
+ORDNANCE_SURVEY_URL=https://api.os.uk
+ORDNANCE_SURVEY_KEY=
+ORDNANCE_SURVEY_MAX_REDIRECTS=
+ORDNANCE_SURVEY_TIMEOUT= # in milliseconds

.eslintrc.json

@@ -15,14 +15,14 @@
     "plugin:eslint-comments/recommended",
     "plugin:optimize-regex/recommended",
     "plugin:switch-case/recommended",
-    "plugin:security/recommended",
+    "plugin:security/recommended-legacy",
     "plugin:import/recommended",
     "plugin:import/typescript",
     "prettier"
   ],
   "parserOptions": {
     "project": "tsconfig.json",
-    "ecmaVersion": 2020,
+    "ecmaVersion": "latest",
     "sourceType": "module"
   },
   "env": {
@@ -110,7 +110,10 @@
     "consistent-return": "off",
     "no-unused-vars": "off",
     "unused-imports/no-unused-imports": "error",
-    "unused-imports/no-unused-vars": "error",
+    "unused-imports/no-unused-vars": [
+      "error",
+      { "vars": "all", "varsIgnorePattern": "^_", "args": "after-used", "argsIgnorePattern": "^_" }
+    ],
     "@typescript-eslint/no-unused-vars": "off",
     "@typescript-eslint/ban-ts-comment": "off",
     "@typescript-eslint/no-explicit-any": "off",

README.md

@@ -155,3 +155,7 @@
 1. `fix:` which represents bug fixes, and correlates to a [SemVer](https://semver.org/) **patch**.
 2. `feat:` which represents a new feature, and correlates to a [SemVer](https://semver.org/) **minor**.
 3. `feat!:`, `fix!:` or `refactor!:`, etc., which represent a breaking change (indicated by the `!`) and will result in a [SemVer](https://semver.org/) **major**.
+
+### Special notes for .env settings
+
+- ORDNANCE_SURVEY_URL - Domain [https://api.os.co.uk](https://api.os.co.uk) redirects to [https://api.os.uk](https://api.os.uk), so please use [https://api.os.uk](https://api.os.uk).

docker-compose.yml

@@ -33,6 +33,10 @@ services:
       APIM_INFORMATICA_PASSWORD:
       APIM_INFORMATICA_MAX_REDIRECTS:
       APIM_INFORMATICA_TIMEOUT:
+      ORDNANCE_SURVEY_URL:
+      ORDNANCE_SURVEY_KEY:
+      ORDNANCE_SURVEY_MAX_REDIRECTS:
+      ORDNANCE_SURVEY_TIMEOUT:
       API_KEY:
     healthcheck:
       test: ["CMD", "curl", "-f", "http://localhost:${PORT}"]

jest.config.ts

@@ -12,6 +12,7 @@ const defaultSettings = {
     '@ukef/config/(.*)': '<rootDir>/../src/config/$1',
     '@ukef/database/(.*)': '<rootDir>/../src/modules/database/$1',
     '@ukef/helpers/(.*)': '<rootDir>/../src/helpers/$1',
+    '@ukef/helper-modules/(.*)': '<rootDir>/../src/helper-modules/$1',
     '@ukef/modules/(.*)': '<rootDir>/../src/modules/$1',
     '@ukef/auth/(.*)': '<rootDir>/../src/modules/auth/$1',
     '@ukef/(.*)': '<rootDir>/../src/$1',