CCM-13752 Added specificationBillingId

Author: nhsd-david-wass

internal/datastore/src/__test__/letter-repository.test.ts

@@ -30,6 +30,7 @@ function createLetter(
     source: "/data-plane/letter-rendering/pdf",
     subject: `client/1/letter-request/${letterId}`,
     billingRef: "specification1",
+    specificationBillingId: "specification1",
   };
 }
 

internal/datastore/src/types.ts

@@ -53,6 +53,7 @@ export const LetterSchema = LetterSchemaBase.extend({
   source: z.string(),
   subject: z.string(),
   billingRef: z.string(),
+  specificationBillingId: z.string(),
 }).describe("Letter");
 
 /**

lambdas/api-handler/src/mappers/__tests__/letter-mapper.test.ts

@@ -28,6 +28,7 @@ describe("letter-mapper", () => {
       ttl: 123,
       source: "/data-plane/letter-rendering/pdf",
       subject: "letter-rendering/source/letter/letter-id",
+      specificationBillingId: "billing123",
     };
 
     const result: PatchLetterResponse = mapToPatchLetterResponse(letter);
@@ -64,6 +65,7 @@ describe("letter-mapper", () => {
       reasonText: "Reason text",
       source: "/data-plane/letter-rendering/pdf",
       subject: "letter-rendering/source/letter/letter-id",
+      specificationBillingId: "billing123",
     };
 
     const result: PatchLetterResponse = mapToPatchLetterResponse(letter);
@@ -100,6 +102,7 @@ describe("letter-mapper", () => {
       ttl: 123,
       source: "/data-plane/letter-rendering/pdf",
       subject: "letter-rendering/source/letter/letter-id",
+      specificationBillingId: "billing123",
     };
 
     const result: GetLetterResponse = mapToGetLetterResponse(letter);
@@ -136,6 +139,7 @@ describe("letter-mapper", () => {
       reasonText: "Reason text",
       source: "/data-plane/letter-rendering/pdf",
       subject: "letter-rendering/source/letter/letter-id",
+      specificationBillingId: "billing123",
     };
 
     const result: GetLetterResponse = mapToGetLetterResponse(letter);
@@ -174,6 +178,7 @@ describe("letter-mapper", () => {
       reasonText: "Reason text",
       source: "/data-plane/letter-rendering/pdf",
       subject: "letter-rendering/source/letter/letter-id",
+      specificationBillingId: "billing123",
     };
 
     const result: GetLettersResponse = mapToGetLettersResponse([

lambdas/api-handler/src/services/__tests__/letter-operations.test.ts

@@ -41,6 +41,7 @@ function makeLetter(id: string, status: Letter["status"]): Letter {
     reasonText: "Reason text",
     source: "/data-plane/letter-rendering/pdf",
     subject: "letter-rendering/source/letter/letter-id",
+    specificationBillingId: "billing123",
   };
 }
 

lambdas/letter-updates-transformer/src/__tests__/letter-updates-transformer.test.ts

@@ -339,6 +339,7 @@ function generateLetter(status: LetterStatus, id?: string): Letter {
     supplierStatus: `supplier1#${status}`,
     supplierStatusSk: "2025-12-10T11:12:54Z#1",
     ttl: 1_234_567_890,
+    specificationBillingId: "billing1",
   };
 }
 

lambdas/update-letter-queue/src/__tests__/update-letter-queue.test.ts

@@ -46,6 +46,7 @@ function generateLetter(status: LetterStatus, id?: string): Letter {
     source: "test-source",
     subject: "test-subject",
     billingRef: "billing-ref-1",
+    specificationBillingId: "billing1",
   };
 }
 

lambdas/upsert-letter/src/handler/__tests__/upsert-handler.test.ts

@@ -97,6 +97,7 @@ function createSupplierStatusChangeEventWithoutSupplier(
       billingRef: "1y3q9v1zzzz",
       status: "RETURNED",
       supplierId: "",
+      specificationBillingId: "billing1",
     },
     datacontenttype: "application/json",
     dataschema:
@@ -151,6 +152,7 @@ function createSupplierStatusChangeEvent(
       billingRef: "1y3q9v1zzzz",
       status: "RETURNED",
       supplierId: "supplier1",
+      specificationBillingId: "billing1",
     },
     datacontenttype: "application/json",
     dataschema:
@@ -211,11 +213,17 @@ describe("createUpsertLetterHandler", () => {
   test("processes all records successfully and returns no batch failures", async () => {
     const v2message = {
       letterEvent: createPreparedV2Event(),
-      supplierSpec: { supplierId: "supplier1", specId: "spec1" },
+      supplierSpec: {
+        supplierId: "supplier1",
+        specId: "spec1",
+      },
     };
     const v1message = {
       letterEvent: createPreparedV1Event(),
-      supplierSpec: { supplierId: "supplier1", specId: "spec1" },
+      supplierSpec: {
+        supplierId: "supplier1",
+        specId: "spec1",
+      },
     };
 
     const evt: SQSEvent = createSQSEvent([
@@ -249,6 +257,7 @@ describe("createUpsertLetterHandler", () => {
     expect(insertedV2Letter.status).toBe("PENDING");
     expect(insertedV2Letter.groupId).toBe("client1campaign1template1");
     expect(insertedV2Letter.source).toBe("/data-plane/letter-rendering/test");
+    expect(insertedV2Letter.specificationBillingId).toBe("spec1");
 
     const insertedV1Letter = (mockedDeps.letterRepo.putLetter as jest.Mock).mock
       .calls[1][0];
@@ -260,6 +269,7 @@ describe("createUpsertLetterHandler", () => {
     expect(insertedV1Letter.status).toBe("PENDING");
     expect(insertedV1Letter.groupId).toBe("client1campaign1template1");
     expect(insertedV1Letter.source).toBe("/data-plane/letter-rendering/test");
+    expect(insertedV1Letter.specificationBillingId).toBe("spec1");
 
     const updatedLetter = (
       mockedDeps.letterRepo.updateLetterStatus as jest.Mock
@@ -472,14 +482,20 @@ describe("createUpsertLetterHandler", () => {
         id: "7b9a03ca-342a-4150-b56b-989109c45615",
         domainId: "ok",
       }),
-      supplierSpec: { supplierId: "supplier1", specId: "spec1" },
+      supplierSpec: {
+        supplierId: "supplier1",
+        specId: "spec1",
+      },
     };
     const message2 = {
       letterEvent: createPreparedV2Event({
         id: "7b9a03ca-342a-4150-b56b-989109c45616",
         domainId: "fail",
       }),
-      supplierSpec: { supplierId: "supplier1", specId: "spec1" },
+      supplierSpec: {
+        supplierId: "supplier1",
+        specId: "spec1",
+      },
     };
     const evt: SQSEvent = createSQSEvent([
       createSqsRecord("ok-msg", JSON.stringify(message1)),

lambdas/upsert-letter/src/handler/upsert-handler.ts

@@ -117,6 +117,7 @@ function mapToInsertLetter(
     createdAt: now,
     updatedAt: now,
     billingRef,
+    specificationBillingId: spec,
   };
 }
 
@@ -235,7 +236,10 @@ export default function createUpsertLetterHandler(deps: Deps): SQSHandler {
           await runUpsert(
             operation,
             letterEvent,
-            supplierSpec ?? { supplierId: "unknown", specId: "unknown" },
+            supplierSpec ?? {
+              supplierId: "unknown",
+              specId: "unknown",
+            },
             deps,
           );
 

scripts/utilities/letter-test-data/src/__test__/helpers/create-letter-helpers.test.ts

@@ -62,6 +62,7 @@ describe("Create letter helpers", () => {
       source: "/data-plane/letter-rendering/letter-test-data",
       subject: "supplier-api/letter-test-data/letterId",
       billingRef: "specificationId",
+      specificationBillingId: "specificationId",
     });
   });
 
@@ -110,6 +111,7 @@ describe("Create letter helpers", () => {
       billingRef: "specificationId",
       source: "/data-plane/letter-rendering/letter-test-data",
       subject: "supplier-api/letter-test-data/letterId",
+      specificationBillingId: "specificationId",
     });
   });
 
@@ -140,6 +142,7 @@ describe("Create letter helpers", () => {
       source: "/data-plane/letter-rendering/letter-test-data",
       subject: "supplier-api/letter-test-data/testLetterId",
       billingRef: "testSpecId",
+      specificationBillingId: "testSpecId",
     });
   });
 });

scripts/utilities/letter-test-data/src/helpers/create-letter-helpers.ts

@@ -49,6 +49,7 @@ export async function createLetter(params: {
     source: "/data-plane/letter-rendering/letter-test-data",
     subject: `supplier-api/letter-test-data/${letterId}`,
     billingRef: specificationId,
+    specificationBillingId: specificationId,
   };
 
   const letterRecord = await letterRepository.putLetter(letter);
@@ -78,6 +79,7 @@ export function createLetterDto(params: {
     source: "/data-plane/letter-rendering/letter-test-data",
     subject: `supplier-api/letter-test-data/${letterId}`,
     billingRef: specificationId,
+    specificationBillingId: specificationId,
   };
 
   return letter;