Optional reason data

Author: francisco-videira-nhs

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

@@ -91,7 +91,7 @@ describe('API Lambda handler', () => {
         {
           id: "l3",
           type: "Letter",
-          attributes: { status: "PENDING", specificationId: "s1", groupId: 'g1', reasonCode: 123, reasonText: "Reason text" }
+          attributes: { status: "PENDING", specificationId: "s1", groupId: 'g1' }
         }
       ],
     };

lambdas/api-handler/src/handlers/get-letters.ts

@@ -40,7 +40,7 @@ export const getLetters: APIGatewayProxyHandler = async (event) => {
     );
 
     const response = {
-      data: letters.map((letter: LetterBase) => (mapLetterBaseToApiResource(letter)))
+      data: letters.map((letter: LetterBase) => (mapLetterBaseToApiResource(letter, { excludeOptional: true })))
     };
 
     log.info({

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

@@ -1,7 +1,6 @@
 import { mapLetterBaseToApiDocument, mapLetterBaseToApiResource } from '../letter-mapper';
-import { Letter, LetterBase } from '../../../../../internal/datastore';
-import { LetterApiDocument } from '../../contracts/letter-api';
-import { ZodError } from "zod";
+import { Letter } from '../../../../../internal/datastore';
+import { LetterApiDocument, LetterApiResource } from '../../contracts/letter-api';
 
 describe('letter-mapper', () => {
   it('maps a Letter to LetterApiDocument', () => {
@@ -34,7 +33,7 @@ describe('letter-mapper', () => {
     });
   });
 
-  it('maps a Letter to LetterApiDocument with reasonCode and reasonText', () => {
+  it('maps a Letter to LetterApiDocument with reasonCode and reasonText when present', () => {
     const letter: Letter = {
       id: 'abc123',
       status: 'PENDING',
@@ -51,7 +50,7 @@ describe('letter-mapper', () => {
       reasonText: 'Reason text'
     };
 
-    const result: LetterApiDocument = mapLetterBaseToApiDocument(letter);
+    const result: LetterApiDocument = mapLetterBaseToApiDocument(letter, {excludeOptional:false});
 
     expect(result).toEqual({
       data: {
@@ -67,4 +66,69 @@ describe('letter-mapper', () => {
       }
     });
   });
+
+  it('maps a Letter to LetterApiDocument without reasonCode and reasonText when present', () => {
+    const letter: Letter = {
+      id: 'abc123',
+      status: 'PENDING',
+      supplierId: 'supplier1',
+      specificationId: 'spec123',
+      groupId: 'group123',
+      url: 'https://example.com/letter/abc123',
+      createdAt: new Date().toISOString(),
+      updatedAt: new Date().toISOString(),
+      supplierStatus: 'supplier1#PENDING',
+      supplierStatusSk: Date.now().toString(),
+      ttl: 123,
+      reasonCode: 123,
+      reasonText: 'Reason text'
+    };
+
+    const result: LetterApiDocument = mapLetterBaseToApiDocument(letter, {excludeOptional: true});
+
+    expect(result).toEqual({
+      data: {
+        id: 'abc123',
+        type: 'Letter',
+        attributes: {
+          specificationId: 'spec123',
+          status: 'PENDING',
+          groupId: 'group123'
+        }
+      }
+    });
+  });
+
+
+  it('maps a Letter to LetterApiResource with reasonCode and reasonText when present', () => {
+    const letter: Letter = {
+      id: 'abc123',
+      status: 'PENDING',
+      supplierId: 'supplier1',
+      specificationId: 'spec123',
+      groupId: 'group123',
+      url: 'https://example.com/letter/abc123',
+      createdAt: new Date().toISOString(),
+      updatedAt: new Date().toISOString(),
+      supplierStatus: 'supplier1#PENDING',
+      supplierStatusSk: Date.now().toString(),
+      ttl: 123,
+      reasonCode: 123,
+      reasonText: 'Reason text'
+    };
+
+    const result: LetterApiResource = mapLetterBaseToApiResource(letter);
+
+    expect(result).toEqual({
+      id: 'abc123',
+      type: 'Letter',
+      attributes: {
+        specificationId: 'spec123',
+        status: 'PENDING',
+        groupId: 'group123',
+        reasonCode: 123,
+        reasonText: 'Reason text'
+      }
+    });
+  });
 });

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

@@ -1,22 +1,22 @@
 import { LetterBase } from "../../../../internal/datastore";
 import { LetterApiDocument, LetterApiDocumentSchema, LetterApiResource, LetterApiResourceSchema } from '../contracts/letter-api';
 
-export function mapLetterBaseToApiDocument(letterBase: LetterBase): LetterApiDocument {
+export function mapLetterBaseToApiDocument(letterBase: LetterBase, opts: { excludeOptional: boolean } = { excludeOptional: false }): LetterApiDocument {
   return LetterApiDocumentSchema.parse({
-    data: mapLetterBaseToApiResource(letterBase)
+    data: mapLetterBaseToApiResource(letterBase, opts)
   });
 }
 
-export function mapLetterBaseToApiResource(letterBase: LetterBase): LetterApiResource {
+export function mapLetterBaseToApiResource(letterBase: LetterBase, opts: { excludeOptional: boolean } = { excludeOptional: false }): LetterApiResource {
   return LetterApiResourceSchema.parse({
     id: letterBase.id,
     type: 'Letter',
     attributes: {
       status: letterBase.status,
       specificationId: letterBase.specificationId,
       groupId: letterBase.groupId,
-      ...(letterBase.reasonCode && { reasonCode: letterBase.reasonCode }),
-      ...(letterBase.reasonText && { reasonText: letterBase.reasonText })
+      ...(letterBase.reasonCode && !opts.excludeOptional && { reasonCode: letterBase.reasonCode }),
+      ...(letterBase.reasonText && !opts.excludeOptional && { reasonText: letterBase.reasonText })
     }
   });
 }