CCM-11602: letters schema

Author: simonlabarere

internal/datastore/src/letter-repository.ts

@@ -6,7 +6,7 @@ import {
   UpdateCommand,
   UpdateCommandOutput
 } from '@aws-sdk/lib-dynamodb';
-import { Letter, LetterSchema } from './types';
+import { Letter, LetterSchema, LettersSchema } from './types';
 import { Logger } from 'pino';
 
 export type PagingOptions = Partial<{
@@ -130,15 +130,16 @@ export class LetterRepository {
     return LetterSchema.parse(result.Attributes);
   }
 
-  async getLetterIdsBySupplier(supplierId: string): Promise<string[]> {
+  async getLettersBySupplier(supplierId: string, status: string, size: number, cursor?: string): Promise<Letter[]> {
     const result = await this.ddbClient.send(new QueryCommand({
       TableName: this.config.lettersTableName,
-      KeyConditionExpression: 'supplierId = :supplierId',
+      IndexName: 'supplierStatus-index',
+      KeyConditionExpression: 'supplierStatus = :supplierStatus',
+      Limit: size,
       ExpressionAttributeValues: {
-        ':supplierId': supplierId
-      },
-      ProjectionExpression: 'id'
+        ':supplierStatus': `${supplierId}#${status}`
+      }
     }));
-    return (result.Items ?? []).map(item => item.id);
+    return LettersSchema.parse(result.Items);
   }
 }

internal/datastore/src/types.ts

@@ -19,7 +19,7 @@ export const LetterStatus = z.enum([
 
 export const LetterSchema = z.object({
   id: z.string(),
-  supplierId: idRef(SupplierSchema),
+  supplierId: z.string(),
   specificationId: z.string(),
   groupId: z.string(),
   url: z.url(),
@@ -30,6 +30,8 @@ export const LetterSchema = z.object({
   ttl: z.int()
 }).describe('Letter');
 
+export const LettersSchema = z.array(LetterSchema);
+
 /**
  * Letter is the type used for storing letters in the database.
  * The supplierStatus is a composite key combining supplierId and status.

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

@@ -1,19 +1,43 @@
 import { APIGatewayProxyHandler } from 'aws-lambda';
 import { getLetterIdsForSupplier } from '../services/letter-operations';
 import { createLetterRepository } from '../infrastructure/letter-repo-factory';
+import { Letter } from '../../../../internal/datastore/src';
 
 const letterRepo = createLetterRepository();
 
 export const getLetters: APIGatewayProxyHandler = async (event) => {
 
   if (event.path === '/letters') {
 
-    // default to supplier1 for now
-    const supplierId = event.headers['nhsd-apim-apikey'];
+    const supplierId = event.headers['nhsd-supplier-id'];
 
-    const letterIds = await getLetterIdsForSupplier(supplierId, letterRepo);
+    if (!supplierId) {
+      return {
+        statusCode: 400,
+        body: "Bad Request: Missing supplier ID"
+      };
+    }
 
-    const response = createGetLettersResponse(event.path, letterIds);
+    const status = event.queryStringParameters?.status;
+
+    if (!status) {
+      return {
+        statusCode: 400,
+        body: "Bad Request: Missing required query parameter 'status'",
+      };
+    }
+
+    let size = event.queryStringParameters?.size;
+
+    if (!size) {
+      size = '10';
+    }
+
+    const cursor = event.queryStringParameters?.cursor;
+
+    const letters = await getLetterIdsForSupplier(supplierId, status, Number(size), letterRepo, cursor);
+
+    const response = createGetLettersResponse(event.path, letters, supplierId);
 
     return {
       statusCode: 200,
@@ -35,19 +59,24 @@ interface GetLettersLinks {
   prev?: string;
 }
 
-interface Resource {
-  type: string;
-  id: string;
-}
+type LetterResponse = Omit<Letter, "supplierId" | "supplierStatus" | "ttl">;
+
 
 interface GetLettersResponse {
   links: GetLettersLinks;
-  data: Resource[];
+  data: {
+    type: 'Letters';
+    supplierId: string;
+    attributes: {
+      letters: Array<LetterResponse>;
+    }
+  };
 }
 
 function createGetLettersResponse(
   baseUrl: string,
-  letters: string[]
+  letters: Letter[],
+  supplierId: string,
 ): GetLettersResponse {
   return {
     links: {
@@ -57,9 +86,20 @@ function createGetLettersResponse(
       next: `${baseUrl}?page=1`,
       prev: `${baseUrl}?page=1`
     },
-    data: letters.map((letterId) => ({
-      type: "letter",
-      id: letterId,
-    })),
+    data: {
+      type: 'Letters',
+      supplierId,
+      attributes: {
+        letters: letters.map((letter) => ({
+          id: letter.id,
+          specificationId: letter.specificationId,
+          groupId: letter.groupId,
+          url: letter.url,
+          status: letter.status,
+          createdAt: letter.createdAt,
+          updatedAt: letter.updatedAt,
+        })),
+      }
+  }
   };
 }

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

@@ -4,9 +4,9 @@ import { LetterApiResource, LetterApiDocument } from '../contracts/letter-api';
 import { toApiLetter } from '../mappers/letter-mapper';
 
 
-export const getLetterIdsForSupplier = async (supplierId: string, letterRepo: LetterRepository): Promise<string[]> => {
+export const getLettersForSupplier = async (supplierId: string, status: string, size: number, letterRepo: LetterRepository, cursor?: string): Promise<string[]> => {
 
-  return await letterRepo.getLetterIdsBySupplier(supplierId);
+  return await letterRepo.getLettersBySupplier(supplierId, status, size, cursor);
 }
 
 export const patchLetterStatus = async (letterToUpdate: LetterApiResource, letterId: string, supplierId: string, letterRepo: LetterRepository): Promise<LetterApiDocument> => {