CCM-12600: Add sha256 to letters (#606)

Author: RossFaulds171

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

@@ -21,6 +21,7 @@ function createLetter(
     specificationId: "specification1",
     groupId: "group1",
     priority: 10,
+    sha256Hash: "hash1",
     ...overrides,
   };
 }

internal/datastore/src/types.ts

@@ -42,6 +42,7 @@ export const LetterSchemaBase = z.object({
   groupId: z.string(),
   reasonCode: z.string().optional(),
   reasonText: z.string().optional(),
+  sha256Hash: z.string().optional(),
 });
 
 export const LetterSchema = LetterSchemaBase.extend({
@@ -87,6 +88,7 @@ export const PendingLetterSchemaBase = z.object({
   letterId: idRef(LetterSchema, "id"),
   specificationId: z.string(),
   groupId: z.string(),
+  sha256Hash: z.string().optional(),
 });
 
 export const PendingLetterSchema = PendingLetterSchemaBase.extend({

internal/event-builders/src/letter-mapper.ts

@@ -19,7 +19,6 @@ export function mapLetterToCloudEvent(
     dataschemaversion,
     source,
     subject: `letter-origin/letter-rendering/letter/${letter.id}`,
-
     data: {
       domainId: letter.id as LetterStatusChangeEvent["data"]["domainId"],
       status: letter.status,

lambdas/api-handler/src/contracts/letters.ts

@@ -52,6 +52,7 @@ export const GetLetterResponseResourceSchema = z
         groupId: z.string().optional(),
         reasonCode: z.string().optional(),
         reasonText: z.string().optional(),
+        sha256Hash: z.string().optional(),
       })
       .strict(),
   })
@@ -66,6 +67,7 @@ export const GetLettersResponseResourceSchema = z
         status: LetterStatusSchema,
         specificationId: z.string(),
         groupId: z.string().optional(),
+        sha256Hash: z.string().optional(),
       })
       .strict(),
   })

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

@@ -120,6 +120,43 @@ describe("letter-mapper", () => {
     });
   });
 
+  it("maps an internal Letter to a GetLetterResponse with sha256Hash when present", () => {
+    const date = new Date().toISOString();
+    const letter: Letter = {
+      id: "abc123",
+      status: "PENDING",
+      supplierId: "supplier1",
+      specificationId: "spec123",
+      billingRef: "spec123",
+      groupId: "group123",
+      url: "https://example.com/letter/abc123",
+      createdAt: date,
+      updatedAt: date,
+      supplierStatus: "supplier1#PENDING",
+      supplierStatusSk: date,
+      ttl: 123,
+      sha256Hash: "abc123hash",
+      source: "/data-plane/letter-rendering/pdf",
+      subject: "letter-rendering/source/letter/letter-id",
+      specificationBillingId: "billing123",
+    };
+
+    const result: GetLetterResponse = mapToGetLetterResponse(letter);
+
+    expect(result).toEqual({
+      data: {
+        id: "abc123",
+        type: "Letter",
+        attributes: {
+          specificationId: "spec123",
+          status: "PENDING",
+          groupId: "group123",
+          sha256Hash: "abc123hash",
+        },
+      },
+    });
+  });
+
   it("maps an internal Letter to a GetLetterResponse with reasonCode and reasonText when present", () => {
     const date = new Date().toISOString();
     const letter: Letter = {
@@ -209,4 +246,57 @@ describe("letter-mapper", () => {
       ],
     });
   });
+  it("maps an internal Letter collection to a GetLettersResponse with sha256Hash when present", () => {
+    const date = new Date().toISOString();
+    const letter: Letter = {
+      id: "abc123",
+      status: "PENDING",
+      supplierId: "supplier1",
+      specificationId: "spec123",
+      billingRef: "spec123",
+      groupId: "group123",
+      url: "https://example.com/letter/abc123",
+      createdAt: date,
+      updatedAt: date,
+      supplierStatus: "supplier1#PENDING",
+      supplierStatusSk: date,
+      ttl: 123,
+      reasonCode: "R01",
+      reasonText: "Reason text",
+      sha256Hash: "abc123hash",
+      source: "/data-plane/letter-rendering/pdf",
+      subject: "letter-rendering/source/letter/letter-id",
+      specificationBillingId: "billing123",
+    };
+
+    const result: GetLettersResponse = mapToGetLettersResponse([
+      letter,
+      letter,
+    ]);
+
+    expect(result).toEqual({
+      data: [
+        {
+          id: "abc123",
+          type: "Letter",
+          attributes: {
+            specificationId: "spec123",
+            status: "PENDING",
+            groupId: "group123",
+            sha256Hash: "abc123hash",
+          },
+        },
+        {
+          id: "abc123",
+          type: "Letter",
+          attributes: {
+            specificationId: "spec123",
+            status: "PENDING",
+            groupId: "group123",
+            sha256Hash: "abc123hash",
+          },
+        },
+      ],
+    });
+  });
 });

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

@@ -22,6 +22,7 @@ function letterToResourceResponse(letter: LetterBase) {
       groupId: letter.groupId,
       ...(letter.reasonCode != null && { reasonCode: letter.reasonCode }),
       ...(letter.reasonText != null && { reasonText: letter.reasonText }),
+      ...(letter.sha256Hash != null && { sha256Hash: letter.sha256Hash }),
     },
   };
 }
@@ -34,6 +35,7 @@ function letterToGetLettersResourceResponse(letter: LetterBase) {
       status: letter.status,
       specificationId: letter.specificationId,
       groupId: letter.groupId,
+      ...(letter.sha256Hash != null && { sha256Hash: letter.sha256Hash }),
     },
   };
 }

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

@@ -36,6 +36,7 @@ function mapPendingLetterToLetterBase(pending: PendingLetterBase): LetterBase {
     status: "PENDING",
     specificationId: pending.specificationId,
     groupId: pending.groupId,
+    sha256Hash: pending.sha256Hash,
   };
 }
 

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

@@ -191,6 +191,7 @@ function mapLetterToPendingLetter(letter: Letter): InsertPendingLetter {
     specificationId: letter.specificationId,
     groupId: letter.groupId,
     priority: letter.priority,
+    sha256Hash: letter.sha256Hash,
   };
 }
 

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

@@ -132,6 +132,7 @@ function mapToInsertLetter(
       upsertRequest.data.templateId,
     ),
     url: upsertRequest.data.url,
+    sha256Hash: upsertRequest.data.sha256Hash,
     source: upsertRequest.source,
     subject: upsertRequest.subject,
     createdAt: now,

sandbox/data/examples/getLetter/responses/getLetter-24L5eYSWGzCHlGmzNxuqVusPxDg.json

@@ -2,6 +2,7 @@
   "data": {
     "attributes": {
       "groupId": "c5d93f917f5546d08beccf770a915d96",
+      "sha256Hash": "3a7bd3e2360a3d29eea436fcfb7e44c735d117c8f2f1d2d1e4f6e8f7e6e8f7e6",
       "specificationId": "2WL5eYSWGzCHlGmzNxuqVusPxDg",
       "status": "PENDING"
     },