chore: account for title boundaries in document templates (#2696)

theopensystemslab · Jan 24, 2024 · ecf5970 · ecf5970
1 parent 185e2a0
commit ecf5970
Show file tree

Hide file tree

Showing 12 changed files with 66 additions and 45 deletions.
diff --git a/api.planx.uk/modules/admin/session/html.ts b/api.planx.uk/modules/admin/session/html.ts
@@ -2,6 +2,7 @@ import { generateApplicationHTML } from "@opensystemslab/planx-core";
 import { $api } from "../../../client";
 import type { RequestHandler } from "express";
 import type { PlanXExportData } from "@opensystemslab/planx-core/types";
+import { DrawBoundaryUserAction } from "@opensystemslab/planx-core/dist/templates/html/map/Map";
 
 type HTMLExportHandler = RequestHandler<{ sessionId: string }, string>;
 
@@ -27,10 +28,14 @@ export const getHTMLExport: HTMLExportHandler = async (req, res, next) => {
     const boundingBox = session.data.passport.data[
       "property.boundary.site.buffered"
     ] as unknown as GeoJSON.Feature;
+    const userAction = session.data.passport.data?.[
+      "drawBoundary.action"
+    ] as unknown as DrawBoundaryUserAction | undefined;
 
     const html = generateApplicationHTML({
       planXExportData: responses as PlanXExportData[],
       boundingBox,
+      userAction,
     });
 
     res.header("Content-type", "text/html");
@@ -70,10 +75,14 @@ export const getRedactedHTMLExport: HTMLExportHandler = async (
     const boundingBox = session.data.passport.data[
       "property.boundary.site.buffered"
     ] as unknown as GeoJSON.Feature;
+    const userAction = session.data.passport.data?.[
+      "drawBoundary.action"
+    ] as unknown as DrawBoundaryUserAction | undefined;
 
     const html = generateApplicationHTML({
       planXExportData: redactedResponses as PlanXExportData[],
       boundingBox,
+      userAction,
     });
 
     res.header("Content-type", "text/html");

diff --git a/api.planx.uk/modules/send/utils/exportZip.ts b/api.planx.uk/modules/send/utils/exportZip.ts
@@ -110,10 +110,12 @@ export async function buildSubmissionExportZip({
   }
 
   const boundingBox = passport.data["property.boundary.site.buffered"];
+  const userAction = passport.data?.["drawBoundary.action"];
   // generate and add an HTML overview document for the submission to zip
   const overviewHTML = generateApplicationHTML({
     planXExportData: responses as PlanXExportData[],
     boundingBox,
+    userAction,
   });
   await zip.addFile({
     name: "Overview.htm",
@@ -124,6 +126,7 @@ export async function buildSubmissionExportZip({
   const redactedOverviewHTML = generateApplicationHTML({
     planXExportData: redactedResponses as PlanXExportData[],
     boundingBox,
+    userAction,
   });
   await zip.addFile({
     name: "RedactedOverview.htm",
@@ -133,6 +136,7 @@ export async function buildSubmissionExportZip({
   // add an optional GeoJSON file to zip
   const geojson = passport?.data?.["property.boundary.site"];
   if (geojson) {
+    if (userAction) geojson["properties"]["planx_user_action"] = userAction;
     const geoBuff = Buffer.from(JSON.stringify(geojson, null, 2));
     zip.addFile({
       name: "LocationPlanGeoJSON.geojson",
@@ -143,6 +147,7 @@ export async function buildSubmissionExportZip({
     const boundaryHTML = generateMapHTML({
       geojson,
       boundingBox,
+      userAction,
     });
     await zip.addFile({
       name: "LocationPlan.htm",

diff --git a/api.planx.uk/package.json b/api.planx.uk/package.json
@@ -4,7 +4,7 @@
   "private": true,
   "dependencies": {
     "@airbrake/node": "^2.1.8",
-    "@opensystemslab/planx-core": "git+https://github.com/theopensystemslab/planx-core#4b625d9",
+    "@opensystemslab/planx-core": "git+https://github.com/theopensystemslab/planx-core#9bf211f",
     "@types/isomorphic-fetch": "^0.0.36",
     "adm-zip": "^0.5.10",
     "aws-sdk": "^2.1467.0",

diff --git a/api.planx.uk/pnpm-lock.yaml b/api.planx.uk/pnpm-lock.yaml
diff --git a/e2e/tests/api-driven/package.json b/e2e/tests/api-driven/package.json
@@ -6,7 +6,7 @@
   },
   "dependencies": {
     "@cucumber/cucumber": "^9.3.0",
-    "@opensystemslab/planx-core": "git+https://github.com/theopensystemslab/planx-core#4b625d9",
+    "@opensystemslab/planx-core": "git+https://github.com/theopensystemslab/planx-core#9bf211f",
     "axios": "^1.6.0",
     "dotenv": "^16.3.1",
     "dotenv-expand": "^10.0.0",

diff --git a/e2e/tests/api-driven/pnpm-lock.yaml b/e2e/tests/api-driven/pnpm-lock.yaml
diff --git a/e2e/tests/ui-driven/package.json b/e2e/tests/ui-driven/package.json
@@ -8,7 +8,7 @@
     "postinstall": "./install-dependencies.sh"
   },
   "dependencies": {
-    "@opensystemslab/planx-core": "git+https://github.com/theopensystemslab/planx-core#4b625d9",
+    "@opensystemslab/planx-core": "git+https://github.com/theopensystemslab/planx-core#9bf211f",
     "axios": "^1.6.2",
     "dotenv": "^16.3.1",
     "eslint": "^8.56.0",

diff --git a/e2e/tests/ui-driven/pnpm-lock.yaml b/e2e/tests/ui-driven/pnpm-lock.yaml
diff --git a/editor.planx.uk/package.json b/editor.planx.uk/package.json
@@ -14,7 +14,7 @@
     "@mui/styles": "^5.15.2",
     "@mui/utils": "^5.15.2",
     "@opensystemslab/map": "^0.7.9",
-    "@opensystemslab/planx-core": "git+https://github.com/theopensystemslab/planx-core#4b625d9",
+    "@opensystemslab/planx-core": "git+https://github.com/theopensystemslab/planx-core#9bf211f",
     "@tiptap/core": "^2.0.3",
     "@tiptap/extension-bold": "^2.0.3",
     "@tiptap/extension-bubble-menu": "^2.1.13",

diff --git a/editor.planx.uk/pnpm-lock.yaml b/editor.planx.uk/pnpm-lock.yaml
diff --git a/editor.planx.uk/src/@planx/components/FindProperty/Public/Map.tsx b/editor.planx.uk/src/@planx/components/FindProperty/Public/Map.tsx
@@ -126,7 +126,7 @@ export default function PlotNewAddress(props: PlotNewAddressProps): FCReturn {
           drawType="Point"
           geojsonData={JSON.stringify(props?.boundary)}
           geojsonColor="#efefef"
-          geojsonBuffer="10"
+          geojsonBuffer={10}
           resetControlImage="trash"
           showScale
           showNorthArrow

diff --git a/editor.planx.uk/src/@planx/components/shared/Preview/SummaryList.tsx b/editor.planx.uk/src/@planx/components/shared/Preview/SummaryList.tsx
@@ -411,7 +411,7 @@ function DrawBoundary(props: ComponentProps) {
               geojsonData={JSON.stringify(geodata)}
               geojsonColor="#ff0000"
               geojsonFill
-              geojsonBuffer="20"
+              geojsonBuffer={20}
               osProxyEndpoint={`${process.env.REACT_APP_API_URL}/proxy/ordnance-survey`}
               hideResetControl
               staticMode