feat(EMS-3687): application submission - xlsx - how was contract awar…

…ded (#2907)

* feat(EMS-3687): application submission - xlsx - how was contract awarded

* feat(EMS-3687): add missing content string

* chore(e2e): fix typo

CHANGELOG.md

@@ -2,7 +2,6 @@
 
 ## [2.34.0](https://github.com/UK-Export-Finance/exip/compare/v2.33.0...v2.34.0) (2024-08-06)
 
-
 ### Features
 
 * **EMS-3722-3723:** data migration - eligibility, export contract ([#2901](https://github.com/UK-Export-Finance/exip/issues/2901)) ([0c16bc1](https://github.com/UK-Export-Finance/exip/commit/0c16bc18b52bf1a6a0737a124d693203a8eba96a))

e2e-tests/insurance/cypress/e2e/journeys/check-your-answers/export-contract/change-your-answers/how-the-contract-was-awarded/change-your-answers-how-the-contract-was-awarded-from-other-method.spec.js

@@ -60,7 +60,7 @@ context(
         beforeEach(() => {
           cy.navigateToUrl(url);
 
-          // select DIRECT_AWARD
+          // change to DIRECT_AWARD
           summaryList.field(FIELD_ID).changeLink().click();
           cy.completeAndSubmitHowWasTheContractAwardedForm({ directAward: true });
 

e2e-tests/insurance/cypress/e2e/journeys/export-contract/change-your-answers/how-the-contract-was-awarded/change-your-answers-how-the-contract-was-awarded-from-other-method.spec.js

@@ -47,7 +47,7 @@ context(
         beforeEach(() => {
           cy.navigateToUrl(checkYourAnswersUrl);
 
-          // select DIRECT_AWARD
+          // change to DIRECT_AWARD
           summaryList.field(FIELD_ID).changeLink().click();
           cy.completeAndSubmitHowWasTheContractAwardedForm({ directAward: true });
 

src/api/content-strings/fields/insurance/export-contract/index.ts

@@ -41,6 +41,9 @@ export const EXPORT_CONTRACT_FIELDS = {
           TEXT: OTHER.VALUE,
         },
       },
+      SUMMARY: {
+        TITLE: 'How was the contract awarded',
+      },
     },
   },
   ABOUT_GOODS_OR_SERVICES: {

src/api/generate-xlsx/map-application-to-XLSX/map-export-contract/index.test.ts

@@ -2,6 +2,7 @@ import mapExportContract from '.';
 import FIELD_IDS from '../../../constants/field-ids/insurance/export-contract';
 import { XLSX } from '../../../content-strings';
 import xlsxRow from '../helpers/xlsx-row';
+import mapHowWasTheContractAwarded from './map-how-was-the-contract-awarded';
 import mapFinalDestination from './map-final-destination';
 import mapPrivateMarket from './map-private-market';
 import mapAgent from './map-agent';
@@ -28,6 +29,8 @@ describe('api/generate-xlsx/map-application-to-xlsx/map-export-contract', () =>
     const expected = [
       xlsxRow(String(FIELDS.EXPORT_CONTRACT[DESCRIPTION]), exportContract[DESCRIPTION]),
 
+      mapHowWasTheContractAwarded(exportContract),
+
       ...mapFinalDestination(exportContract, mockCountries),
 
       xlsxRow(String(FIELDS.EXPORT_CONTRACT[PAYMENT_TERMS_DESCRIPTION]), exportContract[PAYMENT_TERMS_DESCRIPTION]),

src/api/generate-xlsx/map-application-to-XLSX/map-export-contract/index.ts

@@ -1,6 +1,7 @@
 import FIELD_IDS from '../../../constants/field-ids/insurance/export-contract';
 import { XLSX } from '../../../content-strings';
 import xlsxRow from '../helpers/xlsx-row';
+import mapHowWasTheContractAwarded from './map-how-was-the-contract-awarded';
 import mapFinalDestination from './map-final-destination';
 import mapPrivateMarket from './map-private-market';
 import mapAgent from './map-agent';
@@ -31,6 +32,8 @@ const mapExportContract = (application: Application, countries: Array<Country>)
   const mapped = [
     xlsxRow(String(FIELDS.EXPORT_CONTRACT[DESCRIPTION]), exportContract[DESCRIPTION]),
 
+    mapHowWasTheContractAwarded(exportContract),
+
     ...mapFinalDestination(exportContract, countries),
 
     xlsxRow(String(FIELDS.EXPORT_CONTRACT[PAYMENT_TERMS_DESCRIPTION]), exportContract[PAYMENT_TERMS_DESCRIPTION]),

src/api/generate-xlsx/map-application-to-XLSX/map-export-contract/map-how-was-the-contract-awarded/index.test.ts

@@ -0,0 +1,110 @@
+import mapHowWasTheContractAwarded from '.';
+import { EXPORT_CONTRACT_AWARD_METHOD } from '../../../../constants';
+import FIELD_IDS from '../../../../constants/field-ids/insurance/export-contract';
+import { EXPORT_CONTRACT_FIELDS } from '../../../../content-strings/fields/insurance/export-contract';
+import xlsxRow from '../../helpers/xlsx-row';
+import { invalidId, mockApplication } from '../../../../test-mocks';
+
+const { OPEN_TENDER, DIRECT_AWARD, COMPETITIVE_BIDDING, NEGOTIATED_CONTRACT, OTHER } = EXPORT_CONTRACT_AWARD_METHOD;
+
+const CONTENT_STRINGS = EXPORT_CONTRACT_FIELDS.HOW_WAS_THE_CONTRACT_AWARDED;
+
+const {
+  HOW_WAS_THE_CONTRACT_AWARDED: { AWARD_METHOD, OTHER_AWARD_METHOD },
+} = FIELD_IDS;
+
+const { exportContract } = mockApplication;
+
+const expectedTitle = `${String(CONTENT_STRINGS[AWARD_METHOD].SUMMARY?.TITLE)}?`;
+
+describe('api/generate-xlsx/map-application-to-xlsx/map-export-contract/map-how-was-the-contract-awarded', () => {
+  describe(`when awardMethodId is ${OTHER.DB_ID}`, () => {
+    const mockExportContract = {
+      ...exportContract,
+      awardMethodId: OTHER.DB_ID,
+    };
+
+    it('should return a mapped field', () => {
+      const result = mapHowWasTheContractAwarded(mockExportContract);
+
+      const expected = xlsxRow(expectedTitle, mockExportContract[OTHER_AWARD_METHOD]);
+
+      expect(result).toEqual(expected);
+    });
+  });
+
+  describe(`when awardMethodId is ${NEGOTIATED_CONTRACT.DB_ID}`, () => {
+    const mockExportContract = {
+      ...exportContract,
+      awardMethodId: NEGOTIATED_CONTRACT.DB_ID,
+    };
+
+    it('should return a mapped field', () => {
+      const result = mapHowWasTheContractAwarded(mockExportContract);
+
+      const expected = xlsxRow(expectedTitle, NEGOTIATED_CONTRACT.VALUE);
+
+      expect(result).toEqual(expected);
+    });
+  });
+
+  describe(`when awardMethodId is ${OPEN_TENDER.DB_ID}`, () => {
+    const mockExportContract = {
+      ...exportContract,
+      awardMethodId: OPEN_TENDER.DB_ID,
+    };
+
+    it('should return a mapped field', () => {
+      const result = mapHowWasTheContractAwarded(mockExportContract);
+
+      const expected = xlsxRow(expectedTitle, OPEN_TENDER.VALUE);
+
+      expect(result).toEqual(expected);
+    });
+  });
+
+  describe(`when awardMethodId is ${DIRECT_AWARD.DB_ID}`, () => {
+    const mockExportContract = {
+      ...exportContract,
+      awardMethodId: DIRECT_AWARD.DB_ID,
+    };
+
+    it('should return a mapped field', () => {
+      const result = mapHowWasTheContractAwarded(mockExportContract);
+
+      const expected = xlsxRow(expectedTitle, DIRECT_AWARD.VALUE);
+
+      expect(result).toEqual(expected);
+    });
+  });
+
+  describe(`when awardMethodId is ${COMPETITIVE_BIDDING.DB_ID}`, () => {
+    const mockExportContract = {
+      ...exportContract,
+      awardMethodId: COMPETITIVE_BIDDING.DB_ID,
+    };
+
+    it('should return a mapped field', () => {
+      const result = mapHowWasTheContractAwarded(mockExportContract);
+
+      const expected = xlsxRow(expectedTitle, COMPETITIVE_BIDDING.VALUE);
+
+      expect(result).toEqual(expected);
+    });
+  });
+
+  describe('when an award method is not recognised', () => {
+    const mockExportContract = {
+      ...exportContract,
+      awardMethodId: invalidId,
+    };
+
+    it('should return a mapped field with en empty answer', () => {
+      const result = mapHowWasTheContractAwarded(mockExportContract);
+
+      const expected = xlsxRow(expectedTitle, '');
+
+      expect(result).toEqual(expected);
+    });
+  });
+});

src/api/generate-xlsx/map-application-to-XLSX/map-export-contract/map-how-was-the-contract-awarded/index.ts

@@ -0,0 +1,43 @@
+import { EXPORT_CONTRACT_AWARD_METHOD } from '../../../../constants';
+import FIELD_IDS from '../../../../constants/field-ids/insurance/export-contract';
+import { EXPORT_CONTRACT_FIELDS } from '../../../../content-strings/fields/insurance/export-contract';
+import xlsxRow from '../../helpers/xlsx-row';
+import { ApplicationExportContract } from '../../../../types';
+
+const { OTHER } = EXPORT_CONTRACT_AWARD_METHOD;
+
+const CONTENT_STRINGS = EXPORT_CONTRACT_FIELDS.HOW_WAS_THE_CONTRACT_AWARDED;
+
+const {
+  HOW_WAS_THE_CONTRACT_AWARDED: { AWARD_METHOD, OTHER_AWARD_METHOD },
+} = FIELD_IDS;
+
+/**
+ * mapHowWasTheContractAwarded
+ * Map an application's export contract - AWARD_METHOD answers into an object for XLSX generation
+ * @param {ApplicationExportContract} application: Application export contract
+ * @returns {Object} xlsxRow
+ */
+const mapHowWasTheContractAwarded = (exportContract: ApplicationExportContract) => {
+  const submittedMethodId = exportContract.awardMethodId;
+
+  let answer;
+
+  if (submittedMethodId === OTHER.DB_ID) {
+    answer = exportContract[OTHER_AWARD_METHOD];
+  } else {
+    const allMethods = Object.values(EXPORT_CONTRACT_AWARD_METHOD);
+
+    const method = allMethods.find((methodObj) => methodObj.DB_ID === submittedMethodId);
+
+    if (method) {
+      answer = method.VALUE;
+    }
+  }
+
+  const title = `${String(CONTENT_STRINGS[AWARD_METHOD].SUMMARY?.TITLE)}?`;
+
+  return xlsxRow(title, answer);
+};
+
+export default mapHowWasTheContractAwarded;

src/api/test-mocks/index.ts

@@ -20,6 +20,8 @@ const {
 
 const now = new Date();
 
+export const invalidId = 'invalid-id';
+
 export const mockAccount = {
   firstName: 'first',
   lastName: 'last',

src/api/types/application-types/index.ts

@@ -216,6 +216,7 @@ export interface ApplicationPrivateMarket extends Relationship {
 
 export interface ApplicationExportContract extends Relationship {
   agent: ApplicationExportContractAgent;
+  awardMethodId: string;
   id: string;
   finalDestinationKnown?: boolean;
   finalDestinationCountryCode?: string;