CCM-12875: Updated package.json and headers

Author: ScottFullerton-NHSE

lambdas/pdm-mock-api/README.md

@@ -9,8 +9,6 @@ The PDM Mock API simulates two key PDM endpoints following the FHIR R4 DocumentR
 - **POST /patient-data-manager/FHIR/R4/DocumentReference** - Create a new DocumentReference
 - **GET /patient-data-manager/FHIR/R4/DocumentReference/{id}** - Retrieve a specific DocumentReference
 
-The mock includes the same authentication mechanism used in the PDS mock, requiring a Bearer token in the Authorization header.
-
 ## API Endpoints
 
 ### POST /patient-data-manager/FHIR/R4/DocumentReference
@@ -22,19 +20,26 @@ Creates a new PDM DocumentReference.
 ```bash
 curl -X POST https://<api-gateway-url>/patient-data-manager/FHIR/R4/DocumentReference \
   -H "Authorization: Bearer <token>" \
-  -H "Content-Type: application/json" \
-  -d '{"id": "custom-id"}'
+  -H "Content-Type: application/fhir+json" \
+  -H "X-Request-ID: 4a0e5f18-1747-4438-ac52-5ba2c21575f5" \
+  -d '{}'
 ```
 
+**Headers:**
+
+- `Authorization: Bearer <token>` - Required authentication token (default: `mock-pdm-token`)
+- `Content-Type: application/fhir+json` - Required content type
+- `X-Request-ID: <UUID>` - This uuid will be used as the DocumentReference `id` in the response.
+
 **Response (201 Created):**
 
 ```json
 {
   "resourceType": "DocumentReference",
-  "id": "c7a74264-cf34-31b1-a395-811fa375cec6",
+  "id": "4a0e5f18-1747-4438-ac52-5ba2c21575f5",
   "meta": {
     "versionId": "1",
-    "lastUpdated": "2025-11-26T16:50:48.338244Z"
+    "lastUpdated": "2025-11-27T16:50:48.338244Z"
   },
   "status": "current",
   "subject": {
@@ -54,6 +59,8 @@ curl -X POST https://<api-gateway-url>/patient-data-manager/FHIR/R4/DocumentRefe
 }
 ```
 
+**Note:** The `id` in the response matches the `X-Request-ID` header value.
+
 ### GET /patient-data-manager/FHIR/R4/DocumentReference/{id}
 
 Retrieves a specific PDM DocumentReference by ID.
@@ -62,9 +69,17 @@ Retrieves a specific PDM DocumentReference by ID.
 
 ```bash
 curl https://<api-gateway-url>/patient-data-manager/FHIR/R4/DocumentReference/test-id \
-  -H "Authorization: Bearer <token>"
+  -H "Authorization: Bearer <token>" \
+  -H "Content-Type: application/fhir+json" \
+  -H "X-Request-ID: 848b67ea-eeaa-3620-a388-e4e8594ff2e3"
 ```
 
+**Headers:**
+
+- `Authorization: Bearer <token>` - Required authentication token (default: `mock-pdm-token`)
+- `Content-Type: application/fhir+json` - Required content type
+- `X-Request-ID: <uuid>` - Used for request tracking and correlation.
+
 **Response (200 OK):**
 
 ```json
@@ -96,6 +111,29 @@ curl https://<api-gateway-url>/patient-data-manager/FHIR/R4/DocumentReference/te
 
 ## Error Scenarios
 
+### Missing X-Request-ID Header
+
+Both GET and POST endpoints require the `X-Request-ID` header. If it's missing, a 400 error is returned:
+
+**Response (400 Bad Request):**
+
+```json
+{
+  "resourceType": "OperationOutcome",
+  "issue": [
+    {
+      "severity": "error",
+      "code": "required",
+      "details": {
+        "text": "Missing X-Request-ID header"
+      }
+    }
+  ]
+}
+```
+
+### Error Scenarios
+
 The mock API supports triggering specific error responses for testing. Use these special resource IDs:
 
 | Resource ID              | Status Code | Error Code          | Description                     |

lambdas/pdm-mock-api/package.json

@@ -14,11 +14,10 @@
     "jest-mock-extended": "^3.0.7",
     "typescript": "^5.9.3"
   },
-  "main": "dist/index.js",
-  "name": "pdm-mock-api",
+  "name": "nhs-notify-digital-letters-pdm-mock-api",
   "private": true,
   "scripts": {
-    "build": "rm -rf dist && npx esbuild --bundle --minify --sourcemap --target=es2020 --platform=node --loader:.node=file --entry-names=[name] --outdir=dist src/index.ts",
+    "lambda-build": "rm -rf dist && npx esbuild --bundle --minify --sourcemap --target=es2020 --platform=node --loader:.node=file --entry-names=[name] --outdir=dist src/index.ts",
     "lint": "eslint .",
     "lint:fix": "eslint . --fix",
     "test:unit": "jest",

lambdas/pdm-mock-api/src/__tests__/container.test.ts

@@ -58,6 +58,9 @@ describe('Container', () => {
     const mockEvent = {
       pathParameters: { id: 'test-id' },
       requestContext: { requestId: 'test-request' },
+      headers: {
+        'X-Request-ID': 'container-test-1234-5678-9abc-def012345678',
+      },
     };
 
     const result = await container.getResourceHandler(mockEvent as never);

lambdas/pdm-mock-api/src/__tests__/handlers.test.ts

@@ -56,7 +56,11 @@ describe('GET Resource Handler', () => {
 
   it('should return a mock resource for valid resource ID', async () => {
     const handler = createGetResourceHandler(mockLogger);
-    const event = createMockEvent();
+    const event = createMockEvent({
+      headers: {
+        'X-Request-ID': 'get-test-1234-5678-9abc-def012345678',
+      },
+    });
 
     const response = await handler(event);
 
@@ -81,7 +85,12 @@ describe('GET Resource Handler', () => {
 
   it('should return 400 error when resource ID is missing', async () => {
     const handler = createGetResourceHandler(mockLogger);
-    const event = createMockEvent({ pathParameters: null });
+    const event = createMockEvent({
+      pathParameters: null,
+      headers: {
+        'X-Request-ID': 'missing-id-test-1234-5678-9abc-def012345678',
+      },
+    });
 
     const response = await handler(event);
 
@@ -93,7 +102,12 @@ describe('GET Resource Handler', () => {
 
   it('should return empty response for empty-response scenario', async () => {
     const handler = createGetResourceHandler(mockLogger);
-    const event = createMockEvent({ pathParameters: { id: 'empty-response' } });
+    const event = createMockEvent({
+      pathParameters: { id: 'empty-response' },
+      headers: {
+        'X-Request-ID': 'empty-response-test-1234-5678-9abc-def012345678',
+      },
+    });
 
     const response = await handler(event);
 
@@ -143,7 +157,12 @@ describe('GET Resource Handler', () => {
     for (const { expectedCode, expectedStatus, id } of errorCases) {
       it(`should return ${expectedStatus} error for ${id}`, async () => {
         const handler = createGetResourceHandler(mockLogger);
-        const event = createMockEvent({ pathParameters: { id } });
+        const event = createMockEvent({
+          pathParameters: { id },
+          headers: {
+            'X-Request-ID': `${id}-test-1234-5678-9abc-def012345678`,
+          },
+        });
 
         const response = await handler(event);
 
@@ -154,6 +173,20 @@ describe('GET Resource Handler', () => {
       });
     }
   });
+
+  it('should return 400 error when X-Request-ID header is missing', async () => {
+    const handler = createGetResourceHandler(mockLogger);
+    const event = createMockEvent();
+
+    const response = await handler(event);
+
+    expect(response.statusCode).toBe(400);
+    const body = JSON.parse(response.body);
+    expect(body.resourceType).toBe('OperationOutcome');
+    expect(body.issue[0].severity).toBe('error');
+    expect(body.issue[0].code).toBe('required');
+    expect(body.issue[0].details.text).toBe('Missing X-Request-ID header');
+  });
 });
 
 describe('POST Create Resource Handler', () => {
@@ -163,9 +196,13 @@ describe('POST Create Resource Handler', () => {
 
   it('should create a new resource with provided ID', async () => {
     const handler = createCreateResourceHandler(mockLogger);
+    const xRequestId = 'custom-id-1234-5678-9abc-def012345678';
     const event = createMockEvent({
       httpMethod: 'POST',
       body: JSON.stringify({ id: 'custom-id' }),
+      headers: {
+        'X-Request-ID': xRequestId,
+      },
     });
 
     const response = await handler(event);
@@ -175,54 +212,76 @@ describe('POST Create Resource Handler', () => {
 
     const body = JSON.parse(response.body);
     expect(body.resourceType).toBe('DocumentReference');
-    expect(body.id).toBeDefined();
-    expect(body.id).toMatch(
-      /^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/i,
-    );
+    expect(body.id).toBe(xRequestId);
     expect(body.status).toBe('current');
     expect(body.meta).toBeDefined();
     expect(body.meta.versionId).toBe('1');
     expect(body.meta.lastUpdated).toBeDefined();
   });
 
-  it('should create a new resource with generated ID when not provided', async () => {
+  it('should use X-Request-ID header as resource ID when provided', async () => {
     const handler = createCreateResourceHandler(mockLogger);
+    const xRequestId = '4a0e5f18-1747-4438-ac52-5ba2c21575f5';
     const event = createMockEvent({
       httpMethod: 'POST',
       body: JSON.stringify({}),
+      headers: {
+        'X-Request-ID': xRequestId,
+        'Content-Type': 'application/fhir+json',
+      },
     });
 
     const response = await handler(event);
 
     expect(response.statusCode).toBe(201);
+    const body = JSON.parse(response.body);
+    expect(body.id).toBe(xRequestId);
+  });
+
+  it('should return 400 error when X-Request-ID header is missing', async () => {
+    const handler = createCreateResourceHandler(mockLogger);
+    const event = createMockEvent({
+      httpMethod: 'POST',
+      body: JSON.stringify({}),
+      headers: {},
+    });
 
+    const response = await handler(event);
+
+    expect(response.statusCode).toBe(400);
     const body = JSON.parse(response.body);
-    expect(body.id).toMatch(
-      /^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/i,
-    );
+    expect(body.resourceType).toBe('OperationOutcome');
+    expect(body.issue[0].severity).toBe('error');
+    expect(body.issue[0].code).toBe('required');
+    expect(body.issue[0].details.text).toBe('Missing X-Request-ID header');
   });
 
-  it('should handle empty body', async () => {
+  it('should handle empty body with X-Request-ID header', async () => {
     const handler = createCreateResourceHandler(mockLogger);
+    const xRequestId = 'aabbccdd-1111-2222-3333-444455556666';
     const event = createMockEvent({
       httpMethod: 'POST',
       body: null,
+      headers: {
+        'X-Request-ID': xRequestId,
+      },
     });
 
     const response = await handler(event);
 
     expect(response.statusCode).toBe(201);
     const body = JSON.parse(response.body);
-    expect(body.id).toMatch(
-      /^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/i,
-    );
+    expect(body.id).toBe(xRequestId);
   });
 
   it('should return 400 error for invalid JSON', async () => {
     const handler = createCreateResourceHandler(mockLogger);
     const event = createMockEvent({
       httpMethod: 'POST',
       body: 'invalid-json{',
+      headers: {
+        'X-Request-ID': 'invalid-json-test-1234-5678-9abc-def012345678',
+      },
     });
 
     const response = await handler(event);
@@ -238,6 +297,9 @@ describe('POST Create Resource Handler', () => {
     const event = createMockEvent({
       httpMethod: 'POST',
       body: JSON.stringify({ emptyResponse: true }),
+      headers: {
+        'X-Request-ID': 'empty-test-1234-5678-9abc-def012345678',
+      },
     });
 
     const response = await handler(event);
@@ -251,6 +313,9 @@ describe('POST Create Resource Handler', () => {
     const event = createMockEvent({
       httpMethod: 'POST',
       body: JSON.stringify({ triggerError: 'error-409-conflict' }),
+      headers: {
+        'X-Request-ID': 'error-test-1234-5678-9abc-def012345678',
+      },
     });
 
     const response = await handler(event);