Fix letter schema

Author: francisco-videira-nhs

infrastructure/terraform/components/api/resources/spec.tmpl.json

@@ -115,7 +115,7 @@ export class LetterRepository {
           ':status': status,
           ':updatedAt': new Date().toISOString(),
           ':supplierStatus': `${supplierId}#${status}`,
-          ':ttl': Math.floor(Date.now() / 1000 + 60 * 60 * this.config.ttlHours)
+          ':ttl': Math.floor(Date.now() / 1000 + 60 * 60 * this.config.ttlHours) // TODO CCM-11188: refresh TTL on update?
         },
         ReturnValues: 'ALL_NEW'
       }));

internal/datastore/src/letter-repository.ts

@@ -43,7 +43,7 @@ export function buildApiError(params: {
   detail: ApiErrorDetail | string;
 }): ApiError {
   return {
-    id: randomUUID(),
+    id: randomUUID(), // TODO CCM-11188: correlation ID?
     code: params.code,
     links: { about: 'https://digital.nhs.uk/developer/api-catalogue/nhs-notify-supplier' },
     status: params.status,

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

@@ -18,9 +18,10 @@ export const LetterApiStatusSchema = z.enum([
 export type LetterApiStatus = z.infer<typeof LetterApiStatusSchema>;
 
 export const LetterApiAttributesSchema = z.object({
-  reasonCode: z.number(),
-  reasonText: z.string(),
-  requestedProductionStatus: z.enum(["ACTIVE", "HOLD", "CANCEL"]),
+  reasonCode: z.number().optional(),
+  reasonText: z.string().optional(),
+  requestedProductionStatus: z.enum(["ACTIVE", "HOLD", "CANCEL"]).optional(),
+  specificationId: z.string(),
   status: LetterApiStatusSchema,
 });
 

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

@@ -34,6 +34,7 @@ function makeLetterApiDocument(id: string, status: LetterApiStatus) : LetterApiD
         reasonCode: 123,
         reasonText: "Reason text",
         requestedProductionStatus: "ACTIVE",
+        specificationId: "spec1",
         status
       },
       id,

lambdas/api-handler/src/handlers/__tests__/patch-letters.test.ts

@@ -27,6 +27,7 @@ describe('toApiLetter', () => {
           reasonCode: 123,
           reasonText: 'Reason text',
           requestedProductionStatus: 'ACTIVE',
+          specificationId: 'spec123',
           status: 'PENDING'
         }
       }

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

@@ -7,9 +7,10 @@ export function toApiLetter(letter: Letter): LetterApiDocument {
       id: letter.id,
       type: 'Letter',
       attributes: {
-        reasonCode: 123, // TODO CCM-11188: map from DB if stored
-        reasonText: 'Reason text', // TODO CCM-11188: map from DB if stored
-        requestedProductionStatus: 'ACTIVE', // TODO CCM-11188: map from DB if stored
+        reasonCode: 123, // TODO CCM-11188
+        reasonText: 'Reason text', // TODO CCM-11188
+        requestedProductionStatus: 'ACTIVE', // TODO CCM-11188
+        specificationId: letter.specificationId,
         status: letter.status
       }
     }

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

@@ -8,6 +8,7 @@ function makeLetterApiResource(id: string, status: LetterApiStatus) : LetterApiR
         reasonCode: 123,
         reasonText: "Reason text",
         requestedProductionStatus: "ACTIVE",
+        specificationId: "spec123",
         status
       },
       id,