[KIWI-2035] - Update name assignment logic

.secrets.baseline

@@ -337,7 +337,7 @@
         "filename": "src/tests/unit/services/ExperianService.test.ts",
         "hashed_secret": "640ab2bae07bedc4c163f679a746f7ab7fb5d1fa",
         "is_verified": false,
-        "line_number": 102
+        "line_number": 103
       }
     ],
     "src/tests/unit/services/HmrcTokenRequestProcessor.test.ts": [
@@ -414,5 +414,5 @@
       }
     ]
   },
-  "generated_at": "2024-11-08T13:43:44Z"
+  "generated_at": "2024-11-12T11:22:11Z"
 }

src/services/ExperianService.ts

@@ -37,7 +37,7 @@ export class ExperianService {
 
 	 // eslint-disable-next-line max-lines-per-function
 	 async verify(
-    	{ verifyAccountPayload, givenName, surname, birthDate, uuid }: { verifyAccountPayload: any; givenName: string; surname: string; birthDate: string; uuid: string }, 
+    	{ verifyAccountPayload, firstName, surname, birthDate, uuid }: { verifyAccountPayload: any; firstName: string; surname: string; birthDate: string; uuid: string }, 
     	experianUsername: string,
     	experianPassword: string,
     	experianClientId: string,
@@ -82,7 +82,8 @@ export class ExperianService {
     							},
     							names: [
     								{
-    									firstName: givenName,
+    									firstName: firstName,
+										middleNames: "",
     									surName: surname
     								}
     							]

src/services/PersonInfoRequestProcessor.ts

@@ -7,7 +7,7 @@ import { MessageCodes } from "../models/enums/MessageCodes";
 import { EnvironmentVariables } from "../utils/Constants";
 import { createDynamoDbClient } from "../utils/DynamoDBFactory";
 import { checkEnvironmentVariable } from "../utils/EnvironmentVariables";
-import { getNameByType } from "../utils/PersonIdentityUtils";
+import { getFullName } from "../utils/PersonIdentityUtils";
 import { Response } from "../utils/Response";
 import { APIGatewayProxyResult } from "aws-lambda";
 
@@ -62,7 +62,7 @@ export class PersonInfoRequestProcessor {
   		return Response(HttpCodesEnum.UNAUTHORIZED, `No person found with the session id: ${sessionId}`);
   	}
 
-  	const name = getNameByType(person.name);
+  	const name = getFullName(person.name);
   	const encryptedResponseValue = this.encryptResponse({ name });
 
   	return Response(HttpCodesEnum.OK, encryptedResponseValue);

src/services/VerifyAccountRequestProcessor.ts

@@ -14,7 +14,7 @@ import { CopCheckResult, ExperianCheckResult, ISessionItem } from "../models/ISe
 import { EnvironmentVariables, Constants } from "../utils/Constants";
 import { createDynamoDbClient } from "../utils/DynamoDBFactory";
 import { checkEnvironmentVariable } from "../utils/EnvironmentVariables";
-import { getNameByType } from "../utils/PersonIdentityUtils";
+import { getFirstName, getLastName, getFullName } from "../utils/PersonIdentityUtils";
 import { Response } from "../utils/Response";
 import { buildCoreEventFields } from "../utils/TxmaEvent";
 import { VerifyAccountPayload } from "../type/VerifyAccountPayload";
@@ -109,8 +109,8 @@ export class VerifyAccountRequestProcessor {
 			  return Response(HttpCodesEnum.UNAUTHORIZED, "Too many attempts");
 		  }
 
-		  const givenName = getNameByType(person.name, "GivenName");
-		  const surname = getNameByType(person.name, "FamilyName");
+		  const firstName = getFirstName(person.name);
+		  const surname = getLastName(person.name);
 		  const birthDate = person.birthDate[0].value;
 
 		  this.logger.appendKeys({ govuk_signin_journey_id: session.clientSessionId });
@@ -120,7 +120,7 @@ export class VerifyAccountRequestProcessor {
 		  const coreEventFields = buildCoreEventFields(session, this.issuer, clientIpAddress);
 
 		  const verifyResponse = await this.ExperianService.verify(
-			  { verifyAccountPayload, givenName, surname, birthDate, uuid: vendorUuid },
+			  { verifyAccountPayload, firstName, surname, birthDate, uuid: vendorUuid },
 			  ssmParams.experianUsername,
 			  ssmParams.experianPassword,
 			  ssmParams.experianClientId,
@@ -143,20 +143,20 @@ export class VerifyAccountRequestProcessor {
   			evidence: [
   				{
   					txn: verifyResponse?.expRequestId,
+  					attemptNum: session.attemptCount ?? 1,
   				},
   			],
   		},
   		restricted: {
-  			Experian_request_details: [
-  				{
-  					name:`${givenName} ${surname}`,
-  					sortCode: verifyAccountPayload?.sort_code,
-  					accountNumber: verifyAccountPayload?.account_number,
-  					attemptNum: session.attemptCount ?? 1,
-  				},
-  			],
+  			name: person.name,
+  			birthDate: person.birthDate,
+  			bankAccount: [{
+  				sortCode: verifyAccountPayload?.sort_code,
+  				accountNumber: verifyAccountPayload?.account_number,
+  			}],
   		},
   	}, encodedHeader);
+
 
 		  await this.BavService.sendToTXMA(this.txmaQueueUrl, {
 			  event_name: TxmaEventNames.BAV_EXPERIAN_RESPONSE_RECEIVED,
@@ -211,7 +211,7 @@ export class VerifyAccountRequestProcessor {
   		return Response(HttpCodesEnum.UNAUTHORIZED, "Too many attempts");
   	}
 
-  	const name = getNameByType(person.name);
+  	const name = getFullName(person.name);
   	this.logger.appendKeys({ govuk_signin_journey_id: session.clientSessionId });
   	const timeOfRequest = absoluteTimeNow();
 

src/tests/unit/services/ExperianService.test.ts

@@ -62,6 +62,7 @@ const experianPayload = {
 					names: [
 		  {
 							firstName: "First",
+							middleNames: "",
 							surName: "Last",
 		  },
 					],
@@ -121,9 +122,8 @@ describe("Experian service", () => {
 			account_number: "12345678",
 			sort_code: "123456",
 		};
-		const accountNumber = "12345678";
-		const sortCode = "123456";
-		const givenName = "First";
+
+		const firstName = "First";
 		const surname = "Last";
 		const uuid = "uuid";
 		const birthDate = "DATE";
@@ -135,7 +135,7 @@ describe("Experian service", () => {
 
 			mockDynamoDbClient.send = jest.fn().mockResolvedValue({ Item: storedExperianToken });
 
-			const response = await experianServiceTest.verify({ verifyAccountPayload, givenName, surname, birthDate, uuid },
+			const response = await experianServiceTest.verify({ verifyAccountPayload, firstName, surname, birthDate, uuid },
 				clientUsername,
 				clientPassword,
 				clientId,
@@ -179,7 +179,7 @@ describe("Experian service", () => {
 
 			mockDynamoDbClient.send = jest.fn().mockResolvedValue({ Item: storedExperianToken });
 
-			const response = await experianServiceTest.verify({ verifyAccountPayload, givenName, surname, birthDate, uuid },
+			const response = await experianServiceTest.verify({ verifyAccountPayload, firstName, surname, birthDate, uuid },
 				clientUsername,
 				clientPassword,
 				clientId,
@@ -220,7 +220,7 @@ describe("Experian service", () => {
 			jest.spyOn(axios, "post").mockResolvedValueOnce({ data: errorResponse });
 			mockDynamoDbClient.send = jest.fn().mockResolvedValueOnce({ Item: storedExperianToken });
 
-			await experianServiceTest.verify({ verifyAccountPayload, givenName, surname, birthDate, uuid }, clientUsername,
+			await experianServiceTest.verify({ verifyAccountPayload, firstName, surname, birthDate, uuid }, clientUsername,
 				clientPassword,
 				clientId,
 				clientSecret,
@@ -239,7 +239,7 @@ describe("Experian service", () => {
 			jest.spyOn(axios, "post").mockResolvedValueOnce({ data: errorResponse });
 			mockDynamoDbClient.send = jest.fn().mockResolvedValueOnce({ Item: storedExperianToken });
 
-			await experianServiceTest.verify({ verifyAccountPayload, givenName, surname, birthDate, uuid }, clientUsername,
+			await experianServiceTest.verify({ verifyAccountPayload, firstName, surname, birthDate, uuid }, clientUsername,
 				clientPassword,
 				clientId,
 				clientSecret,

src/tests/unit/services/VerifyAccountRequestProcessorExperian.test.ts

@@ -215,7 +215,7 @@ describe("VerifyAccountRequestProcessor", () => {
 				ssmParams,
 			);
 
-			expect(mockExperianService.verify).toHaveBeenCalledWith({ verifyAccountPayload, birthDate: "12-01-1986", givenName: "Frederick Joseph", surname: "Flintstone", uuid: vendorUuid },
+			expect(mockExperianService.verify).toHaveBeenCalledWith({ verifyAccountPayload, birthDate: "12-01-1986", firstName: "Frederick", surname: "Flintstone", uuid: vendorUuid },
 				"123456",
     			"12345678",
     			"clientId",
@@ -230,19 +230,18 @@ describe("VerifyAccountRequestProcessor", () => {
 					evidence: [
 				 		{
 					 		txn: "1234568",
+							attemptNum: 1,
 						},
 					],
 				},
-				restricted:{
-  				"Experian_request_details": [
-					 {
-  						name: "Frederick Joseph Flintstone",
-  						sortCode: verifyAccountPayload.sort_code,
-  						accountNumber: verifyAccountPayload.account_number,
-  						attemptNum: 1,
-					 },
-  				],
-		 		},
+				 restricted: {
+					name: person.name,
+					birthDate: person.birthDate,
+					bankAccount: [{
+						sortCode: verifyAccountPayload.sort_code,
+						accountNumber: verifyAccountPayload.account_number,
+					}],
+				},
 				timestamp: 1585695600,
 				event_timestamp_ms: 1585695600000,
 				user:  {
@@ -292,7 +291,7 @@ describe("VerifyAccountRequestProcessor", () => {
 				{ sessionId, accountNumber: "12345678", sortCode: verifyAccountPayload.sort_code },
 				process.env.PERSON_IDENTITY_TABLE_NAME,
 			);
-			expect(mockExperianService.verify).toHaveBeenCalledWith({ verifyAccountPayload, birthDate: "12-01-1986", givenName: "Frederick Joseph", surname: "Flintstone", uuid: vendorUuid },
+			expect(mockExperianService.verify).toHaveBeenCalledWith({ verifyAccountPayload, birthDate: "12-01-1986", firstName: "Frederick", surname: "Flintstone", uuid: vendorUuid },
 				"123456",
     			"12345678",
     			"clientId",

src/tests/unit/utils/PersonIdentityUtils.test.ts

@@ -1,33 +1,62 @@
-import { getNameByType } from "../../../utils/PersonIdentityUtils";
+import { getFirstName, getMiddleNames, getLastName, getFullName } from "../../../utils/PersonIdentityUtils";
 
 describe("PersonIdentityUtils", () => {
-	describe("#getNameByType", () => {
-		it("returns all full name if no name type provided", () => {
-			const result = getNameByType([{ nameParts: [
-				{ type: "GivenName", value: "First" },
-				{ type: "GivenName", value: "Middle" },
-				{ type: "FamilyName", value: "Last" },
-			] }]);
-			expect(result).toBe("First Middle Last");
-		});
-
-		it("returns name based on type - GivenName", () => {
-			const result = getNameByType([{ nameParts: [
-				{ type: "GivenName", value: "First" },
-				{ type: "GivenName", value: "Middle" },
-				{ type: "FamilyName", value: "Last" },
-			] }], "GivenName");
-			expect(result).toBe("First Middle");
-		});
-
-		it("returns name based on type - FamilyName", () => {
-			const result = getNameByType([{ nameParts: [
-				{ type: "GivenName", value: "First" },
-				{ type: "GivenName", value: "Middle" },
-				{ type: "FamilyName", value: "Last" },
-			] }], "FamilyName");
-			expect(result).toBe("Last");
-		});
 
+	it("returns all full name", () => {
+		const result = getFullName([{ nameParts: [
+			{ type: "GivenName", value: "First" },
+			{ type: "GivenName", value: "Middle" },
+			{ type: "FamilyName", value: "Last" },
+		] }]);
+		expect(result).toBe("First Middle Last");
 	});
+
+	it("returns first name", () => {
+		const result = getFirstName([{ nameParts: [
+			{ type: "GivenName", value: "First" },
+			{ type: "GivenName", value: "Middle" },
+			{ type: "FamilyName", value: "Last" },
+		] }]);
+		expect(result).toBe("First");
+	});
+
+
+	it("returns middle name", () => {
+		const result = getMiddleNames([{ nameParts: [
+			{ type: "GivenName", value: "First" },
+			{ type: "GivenName", value: "Middle" },
+			{ type: "FamilyName", value: "Last" },
+		] }]);
+		expect(result).toBe("Middle");
+	});
+
+	it("returns multiple middle names", () => {
+		const result = getMiddleNames([{ nameParts: [
+			{ type: "GivenName", value: "First" },
+			{ type: "GivenName", value: "MiddleOne" },
+			{ type: "GivenName", value: "MiddleTwo" },
+			{ type: "FamilyName", value: "Last" },
+		] }]);
+		expect(result).toBe("MiddleOne MiddleTwo");
+	});
+
+	it("returns empty string if no middle names provided", () => {
+		const result = getMiddleNames([{ nameParts: [
+			{ type: "GivenName", value: "First" },
+			{ type: "GivenName", value: "" },
+			{ type: "FamilyName", value: "Last" },
+		] }]);
+		expect(result).toBe("");
+	});
+
+	it("returns last name", () => {
+		const result = getLastName([{ nameParts: [
+			{ type: "GivenName", value: "First" },
+			{ type: "GivenName", value: "MiddleOne" },
+			{ type: "GivenName", value: "MiddleTwo" },
+			{ type: "FamilyName", value: "Last" },
+		] }]);
+		expect(result).toBe("Last");
+	});
+
 });

src/utils/PersonIdentityUtils.ts

@@ -1,8 +1,32 @@
 import { PersonIdentityName } from "../models/PersonIdentityItem";
 
-export const getNameByType = (name: PersonIdentityName[], targetType?: string): string => {
+export const getFirstName = (name: PersonIdentityName[]): string => {
+	return name[0]?.nameParts[0].value;
+};
+
+export const getMiddleNames = (name: PersonIdentityName[]): string => {
+	const nameParts = name[0]?.nameParts
+	  .filter((part) => part.type === "GivenName")
+	  .slice(1)
+	  .reduce((nameArray: string[], { value }) => {
+			nameArray.push(value);
+			return nameArray;
+	  }, []) || [];
+	return nameParts.join(" ");
+};
+
+export const getLastName = (name: PersonIdentityName[]): string => {
+	const nameParts = name[0]?.nameParts
+	  .filter((part) => part.type === "FamilyName")
+	  .reduce((nameArray: string[], { value }) => {
+			nameArray.push(value);
+			return nameArray;
+	  }, []) || [];
+	return nameParts.join(" ");
+};
+
+export const getFullName = (name: PersonIdentityName[]): string => {
 	const nameParts = name[0]?.nameParts
-	  .filter((part) => !targetType || part.type === targetType) // Filter if targetType is provided
 	  .reduce((nameArray: string[], { value }) => {
 			nameArray.push(value);
 			return nameArray;