[PRMP-861] [WIP] Add types and request functions for document review (#940)

Author: adamwhitingnhs

app/src/helpers/requests/documentReview.test.ts

@@ -0,0 +1,101 @@
+import { describe, it, expect, vi, beforeEach, afterEach, Mocked } from 'vitest';
+import axios from 'axios';
+import { uploadDocumentForReview, getDocumentReviewStatus } from './documentReview';
+import { AuthHeaders } from '../../types/blocks/authHeaders';
+import { DOCUMENT_UPLOAD_STATE, UploadDocument } from '../../types/pages/UploadDocumentsPage/types';
+import { endpoints } from '../../types/generic/endpoints';
+import { DOCUMENT_TYPE } from '../utils/documentType';
+
+vi.mock('axios');
+const mockedAxios = axios as Mocked<typeof axios>;
+(mockedAxios.get as any) = vi.fn();
+
+describe('documentReview', () => {
+    const mockAuthHeaders: AuthHeaders = {
+        authorization: 'Bearer token',
+        "Content-Type": 'string',
+    };
+
+    const mockDocument: UploadDocument = {
+        id: 'doc-123',
+        versionId: 'v1',
+        docType: DOCUMENT_TYPE.LLOYD_GEORGE,
+        file: { name: 'test-document.pdf' } as File,
+        state: DOCUMENT_UPLOAD_STATE.UPLOADING,
+        attempts: 0,
+    };
+
+    const mockArgs = {
+        document: mockDocument,
+        nhsNumber: '1234567890',
+        baseUrl: 'https://api.example.com',
+        baseHeaders: mockAuthHeaders,
+    };
+
+    beforeEach(() => {
+        vi.clearAllMocks();
+    });
+
+    afterEach(() => {
+        vi.restoreAllMocks();
+    });
+
+    describe('uploadDocumentForReview', () => {
+        it('should successfully upload document for review', async () => {
+            const mockResponse = { data: { reviewId: 'review-123', status: 'pending' } };
+            mockedAxios.post.mockResolvedValue(mockResponse);
+
+            const result = await uploadDocumentForReview(mockArgs);
+
+            expect(mockedAxios.post).toHaveBeenCalledWith(
+                `${mockArgs.baseUrl}${endpoints.DOCUMENT_REVIEW}`,
+                JSON.stringify({
+                    nhsNumber: mockArgs.nhsNumber,
+                    snomedCode: mockArgs.document.docType,
+                    documents: [mockArgs.document.file.name],
+                }),
+                {
+                    headers: mockAuthHeaders,
+                    params: {
+                        patientId: mockArgs.nhsNumber,
+                    },
+                }
+            );
+            expect(result).toEqual(mockResponse.data);
+        });
+
+        it('should throw error when request fails', async () => {
+            const mockError = new Error('Network error');
+            mockedAxios.post.mockRejectedValue(mockError);
+
+            await expect(uploadDocumentForReview(mockArgs)).rejects.toThrow('Network error');
+        });
+    });
+
+    describe('getDocumentReviewStatus', () => {
+        it('should successfully get document review status', async () => {
+            const mockResponse = { data: { status: 'completed', result: 'approved' } };
+            mockedAxios.get.mockResolvedValue(mockResponse);
+
+            const result = await getDocumentReviewStatus(mockArgs);
+
+            expect(mockedAxios.get).toHaveBeenCalledWith(
+                `${mockArgs.baseUrl}${endpoints.DOCUMENT_REVIEW}/${mockArgs.document.id}/${mockArgs.document.versionId}/Status`,
+                {
+                    headers: mockAuthHeaders,
+                    params: {
+                        patientId: mockArgs.nhsNumber,
+                    },
+                }
+            );
+            expect(result).toEqual(mockResponse.data);
+        });
+
+        it('should throw error when status request fails', async () => {
+            const mockError = new Error('Status fetch failed');
+            mockedAxios.get.mockRejectedValue(mockError);
+
+            await expect(getDocumentReviewStatus(mockArgs)).rejects.toThrow('Status fetch failed');
+        });
+    });
+});

app/src/helpers/requests/documentReview.ts

@@ -0,0 +1,69 @@
+import { AuthHeaders } from '../../types/blocks/authHeaders';
+import { endpoints } from '../../types/generic/endpoints';
+import { UploadDocument } from '../../types/pages/UploadDocumentsPage/types';
+
+import axios, { AxiosError } from 'axios';
+import { DocumentReviewDto, DocumentReviewStatusDto } from '../../types/blocks/documentReview';
+
+type DocumentReviewArgs = {
+    document: UploadDocument;
+    nhsNumber: string;
+    baseUrl: string;
+    baseHeaders: AuthHeaders;
+};
+
+export const uploadDocumentForReview = async ({
+    nhsNumber,
+    document,
+    baseUrl,
+    baseHeaders,
+}: DocumentReviewArgs): Promise<DocumentReviewDto> => {
+    const requestBody = {
+        nhsNumber,
+        snomedCode: document.docType,
+        documents: [document.file.name],
+    };
+
+    const gatewayUrl = baseUrl + endpoints.DOCUMENT_REVIEW;
+
+    try {
+        const { data } = await axios.post<DocumentReviewDto>(gatewayUrl, JSON.stringify(requestBody), {
+            headers: {
+                ...baseHeaders,
+            },
+            params: {
+                patientId: nhsNumber,
+            },
+        });
+
+        return data;
+    } catch (e) {
+        const error = e as AxiosError;
+        throw error;
+    }
+};
+
+export const getDocumentReviewStatus = async ({
+    document,
+    baseUrl,
+    baseHeaders,
+    nhsNumber,
+}: DocumentReviewArgs): Promise<DocumentReviewStatusDto> => {
+    const documentStatusUrl = `${baseUrl}${endpoints.DOCUMENT_REVIEW}/${document.id}/${document.versionId}/Status`;
+
+    try {
+        const { data } = await axios.get<DocumentReviewStatusDto>(documentStatusUrl, {
+            headers: {
+                ...baseHeaders,
+            },
+            params: {
+                patientId: nhsNumber,
+            },
+        });
+
+        return data;
+    } catch (e) {
+        const error = e as AxiosError;
+        throw error;
+    }
+};

app/src/types/blocks/documentReview.ts

@@ -0,0 +1,35 @@
+import { DOCUMENT_TYPE } from '../../helpers/utils/documentType';
+
+export type DocumentReviewDto = {
+    id: string;
+    uploadDate: number;
+    files: DocumentReviewFile[];
+    documentSnomedCodeType: DOCUMENT_TYPE;
+    version: string;
+};
+
+type DocumentReviewFile = {
+    fileName: string;
+    presignedUrl: string;
+};
+
+export type DocumentReviewStatusDto = {
+    id: string;
+    status: string;
+    version: string;
+    reviewReason: string;
+};
+
+export enum DocumentReviewStatus {
+    PENDING_REVIEW = "PENDING_REVIEW",
+    APPROVED = "APPROVED",
+    APPROVED_PENDING_DOCUMENTS = "APPROVED_PENDING_DOCUMENTS",
+    REJECTED = "REJECTED",
+    AWAITING_DOCUMENTS = "AWAITING_DOCUMENTS",
+    REJECTED_DUPLICATE = "REJECTED_DUPLICATE",
+    REASSIGNED = "REASSIGNED",
+    REASSIGNED_PATIENT_UNKNOWN = "REASSIGNED_PATIENT_UNKNOWN",
+    NEVER_REVIEWED = "NEVER_REVIEWED",
+    REVIEW_PENDING_UPLOAD = "REVIEW_PENDING_UPLOAD",
+    VIRUS_SCAN_FAILED = "VIRUS_SCAN_FAILED",
+}

app/src/types/generic/endpoints.ts

@@ -19,4 +19,6 @@ export enum endpoints {
 
     ODS_REPORT = '/OdsReport',
     MOCK_LOGIN = 'Auth/MockLogin',
+
+    DOCUMENT_REVIEW = '/DocumentReview',
 }