feat: add option to skipValidation when using `/digital-planning-appl…

…ication` admin endpoint (#3021)

api.planx.uk/modules/admin/session/digitalPlanningData.test.ts

@@ -66,4 +66,15 @@ describe("Digital Planning Application payload admin endpoint", () => {
         expect(res.body).toEqual(expectedPlanningPermissionPayload),
       );
   });
+
+  it("returns an invalid JSON payload if the skipValidation query param is set", async () => {
+    await supertest(app)
+      .get(endpoint`123`.concat("?skipValidation=true"))
+      .set(authHeader({ role: "platformAdmin" }))
+      .expect(200)
+      .expect("content-type", "application/json; charset=utf-8")
+      .then((res) =>
+        expect(res.body).toEqual(expectedPlanningPermissionPayload),
+      );
+  });
 });

api.planx.uk/modules/admin/session/digitalPlanningData.ts

@@ -11,6 +11,11 @@ import { $api } from "../../../client";
  *      - admin
  *    parameters:
  *      - $ref: '#/components/parameters/sessionId'
+ *      - in: query
+ *        name: skipValidation
+ *        type: boolean
+ *        required: false
+ *        description: If invalid JSON data should still be returned, instead of logging validation errors
  *    security:
  *      - bearerAuth: []
  */
@@ -20,9 +25,17 @@ export const getDigitalPlanningApplicationPayload = async (
   next: NextFunction,
 ) => {
   try {
+    let skipValidation = false;
+    if (req.query?.skipValidation) {
+      skipValidation =
+        (req.query.skipValidation as string).toLowerCase() === "true";
+    }
+
     const data = await $api.export.digitalPlanningDataPayload(
       req.params.sessionId,
+      skipValidation,
     );
+
     res.set("content-type", "application/json");
     return res.send(data);
   } catch (error) {

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#7ff62e4",
+    "@opensystemslab/planx-core": "git+https://github.com/theopensystemslab/planx-core#15bde6b",
     "@types/isomorphic-fetch": "^0.0.36",
     "adm-zip": "^0.5.10",
     "aws-sdk": "^2.1467.0",

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#7ff62e4",
+    "@opensystemslab/planx-core": "git+https://github.com/theopensystemslab/planx-core#15bde6b",
     "axios": "^1.6.8",
     "dotenv": "^16.3.1",
     "dotenv-expand": "^10.0.0",

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#7ff62e4",
+    "@opensystemslab/planx-core": "git+https://github.com/theopensystemslab/planx-core#15bde6b",
     "axios": "^1.6.8",
     "dotenv": "^16.3.1",
     "eslint": "^8.56.0",

editor.planx.uk/package.json

@@ -12,7 +12,7 @@
     "@mui/material": "^5.15.2",
     "@mui/utils": "^5.15.2",
     "@opensystemslab/map": "^0.8.1",
-    "@opensystemslab/planx-core": "git+https://github.com/theopensystemslab/planx-core#7ff62e4",
+    "@opensystemslab/planx-core": "git+https://github.com/theopensystemslab/planx-core#15bde6b",
     "@tiptap/core": "^2.0.3",
     "@tiptap/extension-bold": "^2.0.3",
     "@tiptap/extension-bubble-menu": "^2.1.13",