letter data - auto fix

Author: nhsd-david-wass

scripts/utilities/letter-test-data/jest.config.ts

@@ -1,7 +1,7 @@
-import type { Config } from 'jest';
+import type { Config } from "jest";
 
 export const baseJestConfig: Config = {
-  preset: 'ts-jest',
+  preset: "ts-jest",
 
   // Automatically clear mock calls, instances, contexts and results before every test
   clearMocks: true,
@@ -10,10 +10,10 @@ export const baseJestConfig: Config = {
   collectCoverage: true,
 
   // The directory where Jest should output its coverage files
-  coverageDirectory: './.reports/unit/coverage',
+  coverageDirectory: "./.reports/unit/coverage",
 
   // Indicates which provider should be used to instrument code for coverage
-  coverageProvider: 'babel',
+  coverageProvider: "babel",
 
   coverageThreshold: {
     global: {
@@ -24,38 +24,38 @@ export const baseJestConfig: Config = {
     },
   },
 
-  coveragePathIgnorePatterns: ['/__tests__/'],
-  transform: { '^.+\\.ts$': 'ts-jest' },
-  testPathIgnorePatterns: ['.build'],
-  testMatch: ['**/?(*.)+(spec|test).[jt]s?(x)'],
+  coveragePathIgnorePatterns: ["/__tests__/"],
+  transform: { "^.+\\.ts$": "ts-jest" },
+  testPathIgnorePatterns: [".build"],
+  testMatch: ["**/?(*.)+(spec|test).[jt]s?(x)"],
 
   // Use this configuration option to add custom reporters to Jest
   reporters: [
-    'default',
+    "default",
     [
-      'jest-html-reporter',
+      "jest-html-reporter",
       {
-        pageTitle: 'Test Report',
-        outputPath: './.reports/unit/test-report.html',
+        pageTitle: "Test Report",
+        outputPath: "./.reports/unit/test-report.html",
         includeFailureMsg: true,
       },
     ],
   ],
 
   // The test environment that will be used for testing
-  testEnvironment: 'jsdom',
+  testEnvironment: "jsdom",
 };
 
 const utilsJestConfig = {
   ...baseJestConfig,
 
-  testEnvironment: 'node',
+  testEnvironment: "node",
 
   coveragePathIgnorePatterns: [
     ...(baseJestConfig.coveragePathIgnorePatterns ?? []),
-    'cli/index.ts',
-    'helpers/s3_helpers.ts',
-    'letter-repo-factory.ts',
+    "cli/index.ts",
+    "helpers/s3_helpers.ts",
+    "letter-repo-factory.ts",
   ],
 };
 

scripts/utilities/letter-test-data/src/__test__/helpers/create_letter_helpers.test.ts

@@ -1,6 +1,9 @@
 import { LetterRepository } from "@internal/datastore/src/letter-repository";
 import { LetterStatusType } from "@internal/datastore";
-import { createLetter, createLetterDto } from "../../helpers/create_letter_helpers";
+import {
+  createLetter,
+  createLetterDto,
+} from "../../helpers/create_letter_helpers";
 import { uploadFile } from "../../helpers/s3_helpers";
 
 jest.mock("../../helpers/s3_helpers");

scripts/utilities/letter-test-data/src/cli/index.ts

@@ -1,8 +1,11 @@
 import { hideBin } from "yargs/helpers";
-import yargs from 'yargs';
+import yargs from "yargs";
 import { LetterStatusType } from "@internal/datastore/src/types";
-import { randomUUID } from "crypto";
-import { createLetter, createLetterDto } from "../helpers/create_letter_helpers";
+import { randomUUID } from "node:crypto";
+import {
+  createLetter,
+  createLetterDto,
+} from "../helpers/create_letter_helpers";
 import { createLetterRepository } from "../infrastructure/letter-repo-factory";
 import { uploadFile } from "../helpers/s3_helpers";
 
@@ -60,17 +63,17 @@ async function main() {
         },
       },
       async (argv) => {
-        const supplierId = argv.supplierId;
+        const { supplierId } = argv;
         const letterId = argv.letterId ? argv.letterId : randomUUID();
         const bucketName = `nhs-${argv.awsAccountId}-eu-west-2-${argv.environment}-supapi-test-letters`;
         const targetFilename = `${letterId}.pdf`;
         const groupId = argv.groupId ? argv.groupId : randomUUID();
         const specificationId = argv.specificationId
           ? argv.specificationId
           : randomUUID();
-        const status = argv.status;
-        const environment = argv.environment;
-        const ttlHours = argv.ttlHours;
+        const { status } = argv;
+        const { environment } = argv;
+        const { ttlHours } = argv;
         const letterRepository = createLetterRepository(environment, ttlHours);
 
         createLetter({
@@ -114,7 +117,7 @@ async function main() {
           demandOption: false,
           default: 336,
         },
-        "count": {
+        count: {
           type: "number",
           demandOption: true,
         },
@@ -137,41 +140,46 @@ async function main() {
         },
       },
       async (argv) => {
-
         // set batch ID
         const batchId = randomUUID();
 
         // parse args
-        const supplierId = argv.supplierId;
+        const { supplierId } = argv;
         const groupId = argv.groupId ? argv.groupId : randomUUID();
         const specificationId = argv.specificationId
           ? argv.specificationId
           : randomUUID();
-        const status = argv.status;
-        const environment = argv.environment;
-        const ttlHours = argv.ttlHours;
+        const { status } = argv;
+        const { environment } = argv;
+        const { ttlHours } = argv;
         const letterRepository = createLetterRepository(environment, ttlHours);
-        const count = argv.count;
-
+        const { count } = argv;
 
         // Upload a test file for this batch
         const bucketName = `nhs-${argv.awsAccountId}-eu-west-2-${argv.environment}-supapi-test-letters`;
         const targetFilename = `${batchId}-${status}.pdf`;
         const url = `s3://${bucketName}/${batchId}/${targetFilename}`;
-        await uploadFile(bucketName, batchId, "../../test_letter.pdf", targetFilename);
+        await uploadFile(
+          bucketName,
+          batchId,
+          "../../test_letter.pdf",
+          targetFilename,
+        );
 
         // Create letter DTOs
-        let letterDtos = [];
+        const letterDtos = [];
         for (let i = 0; i < count; i++) {
-          letterDtos.push(createLetterDto({
-            letterId: randomUUID(),
-            supplierId,
-            groupId,
-            specificationId,
-            status: status as LetterStatusType,
-            url,
-          }));
-        };
+          letterDtos.push(
+            createLetterDto({
+              letterId: randomUUID(),
+              supplierId,
+              groupId,
+              specificationId,
+              status: status as LetterStatusType,
+              url,
+            }),
+          );
+        }
 
         // Upload Letters
         await letterRepository.putLetterBatch(letterDtos);
@@ -184,8 +192,8 @@ async function main() {
 }
 
 if (require.main === module) {
-  main().catch((err) => {
-    console.error(err);
+  main().catch((error) => {
+    console.error(error);
     process.exitCode = 1;
   });
 }

scripts/utilities/letter-test-data/src/helpers/create_letter_helpers.ts

@@ -1,6 +1,6 @@
 import {
-  LetterRepository,
   Letter,
+  LetterRepository,
   LetterStatusType,
 } from "@internal/datastore";
 import { uploadFile } from "./s3_helpers";
@@ -16,14 +16,14 @@ export async function createLetter(params: {
   letterRepository: LetterRepository;
 }) {
   const {
-    letterId,
     bucketName,
-    supplierId,
-    targetFilename,
-    specificationId,
     groupId,
-    status,
+    letterId,
     letterRepository,
+    specificationId,
+    status,
+    supplierId,
+    targetFilename,
   } = params;
 
   await uploadFile(
@@ -39,7 +39,7 @@ export async function createLetter(params: {
     specificationId,
     groupId,
     url: `s3://${bucketName}/${supplierId}/${targetFilename}`,
-    status: status,
+    status,
     createdAt: new Date().toISOString(),
     updatedAt: new Date().toISOString(),
   };
@@ -56,22 +56,16 @@ export function createLetterDto(params: {
   status: LetterStatusType;
   url: string;
 }) {
-  const {
-    letterId,
-    supplierId,
-    specificationId,
-    groupId,
-    status,
-    url,
-  } = params;
+  const { groupId, letterId, specificationId, status, supplierId, url } =
+    params;
 
   const letter: Omit<Letter, "ttl" | "supplierStatus" | "supplierStatusSk"> = {
     id: letterId,
     supplierId,
     specificationId,
     groupId,
-    url: url,
-    status: status,
+    url,
+    status,
     createdAt: new Date().toISOString(),
     updatedAt: new Date().toISOString(),
   };

scripts/utilities/letter-test-data/src/helpers/s3_helpers.ts

@@ -1,9 +1,13 @@
-import { S3Client, PutObjectCommand } from "@aws-sdk/client-s3";
-import { readFileSync } from "fs";
-import path from "path";
+import { PutObjectCommand, S3Client } from "@aws-sdk/client-s3";
+import { readFileSync } from "node:fs";
+import path from "node:path";
 
-
-export async function uploadFile(bucketName: string, supplierId: string, sourceFilename: string, targetFilename: string) {
+export async function uploadFile(
+  bucketName: string,
+  supplierId: string,
+  sourceFilename: string,
+  targetFilename: string,
+) {
   try {
     const s3 = new S3Client();
     const filePath = path.join(__dirname, sourceFilename);
@@ -18,7 +22,7 @@ export async function uploadFile(bucketName: string, supplierId: string, sourceF
 
     const command = new PutObjectCommand(uploadParams);
     return await s3.send(command);
-  } catch (err) {
-    console.error("Error uploading file:", err);
+  } catch (error) {
+    console.error("Error uploading file:", error);
   }
 }

scripts/utilities/letter-test-data/src/infrastructure/letter-repo-factory.ts

@@ -1,9 +1,12 @@
-import { DynamoDBClient } from '@aws-sdk/client-dynamodb';
-import { DynamoDBDocumentClient } from '@aws-sdk/lib-dynamodb';
-import { pino } from 'pino';
-import { LetterRepository } from '@internal/datastore';
+import { DynamoDBClient } from "@aws-sdk/client-dynamodb";
+import { DynamoDBDocumentClient } from "@aws-sdk/lib-dynamodb";
+import { pino } from "pino";
+import { LetterRepository } from "@internal/datastore";
 
-export function createLetterRepository(environment: string, ttlHours:number): LetterRepository {
+export function createLetterRepository(
+  environment: string,
+  ttlHours: number,
+): LetterRepository {
   const ddbClient = new DynamoDBClient({});
   const docClient = DynamoDBDocumentClient.from(ddbClient);
   const log = pino();