refactor: tidy up submission_email references (#3633)

theopensystemslab · Sep 6, 2024 · eef7809 · eef7809
1 parent 64e8304
commit eef7809
Show file tree

Hide file tree

Showing 14 changed files with 55 additions and 59 deletions.
diff --git a/api.planx.uk/modules/send/downloadApplicationFiles/index.ts b/api.planx.uk/modules/send/downloadApplicationFiles/index.ts
@@ -17,10 +17,10 @@ export async function downloadApplicationFiles(
 
   try {
     // Confirm that the provided email matches the stored team settings for the provided localAuthority
-    const { notifyPersonalisation } = await getTeamEmailSettings(
+    const { teamSettings } = await getTeamEmailSettings(
       req.query.localAuthority as string,
     );
-    if (notifyPersonalisation.sendToEmail !== req.query.email) {
+    if (teamSettings.submissionEmail !== req.query.email) {
       return next({
         status: 403,
         message:

diff --git a/api.planx.uk/modules/send/email/index.test.ts b/api.planx.uk/modules/send/email/index.test.ts
@@ -49,9 +49,9 @@ describe(`sending an application by email to a planning office`, () => {
       data: {
         teams: [
           {
-            notifyPersonalisation: {
+            teamSettings: {
               emailReplyToId: "abc123",
-              sendToEmail: "[email protected]",
+              submissionEmail: "[email protected]",
             },
           },
         ],
@@ -154,9 +154,9 @@ describe(`sending an application by email to a planning office`, () => {
       data: {
         teams: [
           {
-            notifyPersonalisation: {
+            teamSettings: {
               emailReplyToId: "abc123",
-              sendToEmail: null,
+              submissionEmail: null,
             },
           },
         ],
@@ -206,8 +206,8 @@ describe(`downloading application data received by email`, () => {
       data: {
         teams: [
           {
-            notifyPersonalisation: {
-              sendToEmail: "[email protected]",
+            teamSettings: {
+              submissionEmail: "[email protected]",
             },
           },
         ],

diff --git a/api.planx.uk/modules/send/email/index.ts b/api.planx.uk/modules/send/email/index.ts
@@ -28,9 +28,8 @@ export async function sendToEmail(
 
   try {
     // Confirm this local authority (aka team) has an email configured in teams.submission_email
-    const { notifyPersonalisation } =
-      await getTeamEmailSettings(localAuthority);
-    if (!notifyPersonalisation.sendToEmail) {
+    const { teamSettings } = await getTeamEmailSettings(localAuthority);
+    if (!teamSettings.submissionEmail) {
       return next({
         status: 400,
         message: `Send to email is not enabled for this local authority (${localAuthority})`,
@@ -47,15 +46,15 @@ export async function sendToEmail(
         serviceName: flowName,
         sessionId: payload.sessionId,
         applicantEmail: email,
-        downloadLink: `${process.env.API_URL_EXT}/download-application-files/${payload.sessionId}?email=${notifyPersonalisation.sendToEmail}&localAuthority=${localAuthority}`,
-        ...notifyPersonalisation,
+        downloadLink: `${process.env.API_URL_EXT}/download-application-files/${payload.sessionId}?email=${teamSettings.submissionEmail}&localAuthority=${localAuthority}`,
+        ...teamSettings,
       },
     };
 
     // Send the email
     const response = await sendEmail(
       "submit",
-      notifyPersonalisation.sendToEmail,
+      teamSettings.submissionEmail,
       config,
     );
 
@@ -66,14 +65,14 @@ export async function sendToEmail(
     insertAuditEntry(
       payload.sessionId,
       localAuthority,
-      notifyPersonalisation.sendToEmail,
+      teamSettings.submissionEmail,
       config,
       response,
     );
 
     return res.status(200).send({
       message: `Successfully sent to email`,
-      inbox: notifyPersonalisation.sendToEmail,
+      inbox: teamSettings.submissionEmail,
       govuk_notify_template: "Submit",
     });
   } catch (error) {

diff --git a/api.planx.uk/modules/send/email/service.ts b/api.planx.uk/modules/send/email/service.ts
@@ -1,14 +1,11 @@
 import { gql } from "graphql-request";
 import { $api } from "../../../client/index.js";
-import {
-  NotifyPersonalisation,
-  Session,
-} from "@opensystemslab/planx-core/types";
+import { Session, TeamContactSettings } from "@opensystemslab/planx-core/types";
 import { EmailSubmissionNotifyConfig } from "../../../types.js";
 
 interface GetTeamEmailSettings {
   teams: {
-    notifyPersonalisation: NotifyPersonalisation & { sendToEmail: string };
+    teamSettings: TeamContactSettings;
   }[];
 }
 
@@ -17,12 +14,12 @@ export async function getTeamEmailSettings(localAuthority: string) {
     gql`
       query GetTeamEmailSettings($slug: String) {
         teams(where: { slug: { _eq: $slug } }) {
-          notifyPersonalisation: team_settings {
+          teamSettings: team_settings {
             helpEmail: help_email
             helpPhone: help_phone
             emailReplyToId: email_reply_to_id
             helpOpeningHours: help_opening_hours
-            sendToEmail: submission_email
+            submissionEmail: submission_email
           }
         }
       }

diff --git a/api.planx.uk/package.json b/api.planx.uk/package.json
@@ -11,7 +11,7 @@
   },
   "dependencies": {
     "@airbrake/node": "^2.1.8",
-    "@opensystemslab/planx-core": "git+https://github.com/theopensystemslab/planx-core#931d4db",
+    "@opensystemslab/planx-core": "git+https://github.com/theopensystemslab/planx-core#ec52620",
     "@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
@@ -7,7 +7,7 @@
   "packageManager": "[email protected]",
   "dependencies": {
     "@cucumber/cucumber": "^9.3.0",
-    "@opensystemslab/planx-core": "git+https://github.com/theopensystemslab/planx-core#931d4db",
+    "@opensystemslab/planx-core": "git+https://github.com/theopensystemslab/planx-core#ec52620",
     "axios": "^1.7.4",
     "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#931d4db",
+    "@opensystemslab/planx-core": "git+https://github.com/theopensystemslab/planx-core#ec52620",
     "axios": "^1.7.4",
     "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/e2e/tests/ui-driven/src/helpers/context.ts b/e2e/tests/ui-driven/src/helpers/context.ts
@@ -60,7 +60,7 @@ export async function setUpTestContext(
       name: context.team.name,
       settings: {
         homepage: context.team.settings?.homepage,
-        submissionEmail: context.team.submissionEmail,
+        submissionEmail: context.team.settings?.submissionEmail,
       },
     });
   }

diff --git a/editor.planx.uk/package.json b/editor.planx.uk/package.json
@@ -14,7 +14,7 @@
     "@mui/lab": "5.0.0-alpha.170",
     "@mui/material": "^5.15.10",
     "@mui/utils": "^5.15.11",
-    "@opensystemslab/planx-core": "git+https://github.com/theopensystemslab/planx-core#931d4db",
+    "@opensystemslab/planx-core": "git+https://github.com/theopensystemslab/planx-core#ec52620",
     "@opensystemslab/map": "1.0.0-alpha.2",
     "@tiptap/core": "^2.4.0",
     "@tiptap/extension-bold": "^2.0.3",

diff --git a/editor.planx.uk/pnpm-lock.yaml b/editor.planx.uk/pnpm-lock.yaml
diff --git a/editor.planx.uk/src/types.ts b/editor.planx.uk/src/types.ts
@@ -1,8 +1,8 @@
 import {
   FlowStatus,
   GovUKPayment,
-  NotifyPersonalisation,
   Team,
+  TeamContactSettings,
 } from "@opensystemslab/planx-core/types";
 import { OT } from "@planx/graph/types";
 import { useFormik } from "formik";
@@ -116,7 +116,7 @@ export interface AdminPanelData {
   subdomain?: string;
   planningDataEnabled: boolean;
   article4sEnabled: string;
-  govnotifyPersonalisation?: NotifyPersonalisation;
+  govnotifyPersonalisation?: TeamContactSettings;
   govpayEnabled: boolean;
   sendToEmailAddress?: string;
   bopsSubmissionURL?: string;