CCM-11600: cli interface for supplier repo

masl2 · masl2 · commit d8587e139c9b · 2025-10-30T15:48:17.000Z
diff --git a/internal/datastore/src/index.ts b/internal/datastore/src/index.ts
@@ -1,4 +1,5 @@
 export * from './types';
 export * from './mi-repository';
 export * from './letter-repository';
+export * from './supplier-repository';
 export * from './types';
diff --git a/package.json b/package.json
@@ -79,7 +79,7 @@
   "workspaces": [
     "lambdas/*",
     "internal/*",
-    "scripts/test-data",
+    "scripts/utilities/*",
     "docs"
   ]
 }
diff --git a/scripts/utilities/letter-test-data/.eslintignore b/scripts/utilities/letter-test-data/.eslintignore
diff --git a/scripts/utilities/letter-test-data/.gitignore b/scripts/utilities/letter-test-data/.gitignore
diff --git a/scripts/utilities/letter-test-data/README.md b/scripts/utilities/letter-test-data/README.md
diff --git a/scripts/utilities/letter-test-data/jest.config.ts b/scripts/utilities/letter-test-data/jest.config.ts
diff --git a/scripts/utilities/letter-test-data/package.json b/scripts/utilities/letter-test-data/package.json
@@ -13,7 +13,7 @@
     "jest-mock-extended": "^4.0.0",
     "typescript": "^5.8.3"
   },
-  "name": "nhs-notify-supplier-api-data-generator",
+  "name": "nhs-notify-supplier-api-letter-test-data-utility",
   "private": true,
   "scripts": {
     "cli": "tsx ./src/cli/index.ts",
diff --git a/scripts/utilities/letter-test-data/src/__test__/helpers/create_letter_helpers.test.ts b/scripts/utilities/letter-test-data/src/__test__/helpers/create_letter_helpers.test.ts
diff --git a/scripts/utilities/letter-test-data/src/cli/index.ts b/scripts/utilities/letter-test-data/src/cli/index.ts
@@ -1,5 +1,5 @@
 import { hideBin } from "yargs/helpers";
-import yargs from "yargs/yargs";
+import yargs from 'yargs';
 import { LetterStatusType } from "@internal/datastore/src/types";
 import { randomUUID } from "crypto";
 import { createLetter, createLetterDto } from "../helpers/create_letter_helpers";
diff --git a/scripts/utilities/letter-test-data/src/helpers/create_letter_helpers.ts b/scripts/utilities/letter-test-data/src/helpers/create_letter_helpers.ts
@@ -33,7 +33,7 @@ export async function createLetter(params: {
     targetFilename,
   );
 
-  const letter: Omit<Letter, "ttl" | "supplierStatus"> = {
+  const letter: Omit<Letter, "ttl" | "supplierStatus" | "supplierStatusSk"> = {
     id: letterId,
     supplierId,
     specificationId,
diff --git a/scripts/utilities/letter-test-data/src/helpers/s3_helpers.ts b/scripts/utilities/letter-test-data/src/helpers/s3_helpers.ts
diff --git a/scripts/utilities/letter-test-data/src/infrastructure/letter-repo-factory.ts b/scripts/utilities/letter-test-data/src/infrastructure/letter-repo-factory.ts
@@ -1,6 +1,6 @@
 import { DynamoDBClient } from '@aws-sdk/client-dynamodb';
 import { DynamoDBDocumentClient } from '@aws-sdk/lib-dynamodb';
-import pino from 'pino';
+import { pino } from 'pino';
 import { LetterRepository } from '@internal/datastore';
 
 export function createLetterRepository(environment: string, ttlHours:number): LetterRepository {
@@ -9,7 +9,7 @@ export function createLetterRepository(environment: string, ttlHours:number): Le
   const log = pino();
   const config = {
     lettersTableName: `nhs-${environment}-supapi-letters`,
-    ttlHours: ttlHours,
+    lettersTtlHours: ttlHours,
   };
 
   return new LetterRepository(docClient, log, config);
diff --git a/scripts/utilities/letter-test-data/test_letter.pdf b/scripts/utilities/letter-test-data/test_letter.pdf
diff --git a/scripts/utilities/letter-test-data/tsconfig.json b/scripts/utilities/letter-test-data/tsconfig.json
@@ -1,6 +1,6 @@
 {
   "compilerOptions": {},
-  "extends": "../../tsconfig.base.json",
+  "extends": "../../../tsconfig.base.json",
   "include": [
     "src/**/*",
     "jest.config.ts"
diff --git a/scripts/utilities/supplier-data/.eslintignore b/scripts/utilities/supplier-data/.eslintignore
@@ -0,0 +1 @@
+dist
diff --git a/scripts/utilities/supplier-data/.gitignore b/scripts/utilities/supplier-data/.gitignore
@@ -0,0 +1,4 @@
+coverage
+node_modules
+dist
+.reports
diff --git a/scripts/utilities/supplier-data/README.md b/scripts/utilities/supplier-data/README.md
@@ -0,0 +1,30 @@
+# Test letter generator
+
+Simple scripts to manipulate supplier data within the Suppliers table via the internal datastore definitions.
+
+## Usage
+
+Log in the desired AWS account and then run the command below. You may need to set the AWS_REGION envar (eu-west-2)
+
+Note that the AWS account ID is required in order to resolve the bucket name.
+
+```bash
+npm run cli -- put-supplier \
+  --id supplier-id \
+  --name supplier \
+  --apimId supplier-apim-id \
+  --status ENABLED
+  --environment pr147 \
+```
+
+```bash
+npm run cli -- get-supplier-by-id \
+  --id supplier-id \
+  --environment main \
+```
+
+```bash
+npm run cli -- get-supplier-by-apim-id \
+  --apimId apim-supplier-id
+  --environment main \
+```
diff --git a/scripts/utilities/supplier-data/jest.config.ts b/scripts/utilities/supplier-data/jest.config.ts
@@ -0,0 +1,61 @@
+import type { Config } from 'jest';
+
+export const baseJestConfig: Config = {
+  preset: 'ts-jest',
+
+  // Automatically clear mock calls, instances, contexts and results before every test
+  clearMocks: true,
+
+  // Indicates whether the coverage information should be collected while executing the test
+  collectCoverage: true,
+
+  // The directory where Jest should output its coverage files
+  coverageDirectory: './.reports/unit/coverage',
+
+  // Indicates which provider should be used to instrument code for coverage
+  coverageProvider: 'babel',
+
+  coverageThreshold: {
+    global: {
+      branches: 100,
+      functions: 100,
+      lines: 100,
+      statements: -10,
+    },
+  },
+
+  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',
+    [
+      'jest-html-reporter',
+      {
+        pageTitle: 'Test Report',
+        outputPath: './.reports/unit/test-report.html',
+        includeFailureMsg: true,
+      },
+    ],
+  ],
+
+  // The test environment that will be used for testing
+  testEnvironment: 'jsdom',
+};
+
+const utilsJestConfig = {
+  ...baseJestConfig,
+
+  testEnvironment: 'node',
+
+  coveragePathIgnorePatterns: [
+    ...(baseJestConfig.coveragePathIgnorePatterns ?? []),
+    'cli/index.ts',
+    'suppliers-repo-factory.ts',
+  ],
+};
+
+export default utilsJestConfig;
diff --git a/scripts/utilities/supplier-data/package.json b/scripts/utilities/supplier-data/package.json
@@ -0,0 +1,25 @@
+{
+  "dependencies": {
+    "@internal/datastore": "*",
+    "esbuild": "^0.25.11",
+    "pino": "^9.7.0",
+    "yargs": "^17.7.2"
+  },
+  "devDependencies": {
+    "@tsconfig/node22": "^22.0.2",
+    "@types/jest": "^30.0.0",
+    "jest": "^30.2.0",
+    "jest-mock-extended": "^4.0.0",
+    "typescript": "^5.8.3"
+  },
+  "name": "nhs-notify-supplier-api-suppliers-data-utility",
+  "private": true,
+  "scripts": {
+    "cli": "tsx ./src/cli/index.ts",
+    "lint": "eslint .",
+    "lint:fix": "eslint . --fix",
+    "test:unit": "echo \"Supplier data utility has no unit tests\"",
+    "typecheck": "tsc --noEmit"
+  },
+  "version": "0.0.1"
+}
diff --git a/scripts/utilities/supplier-data/src/cli/index.ts b/scripts/utilities/supplier-data/src/cli/index.ts
@@ -0,0 +1,120 @@
+import { hideBin } from "yargs/helpers";
+import yargs from 'yargs';
+import { LetterStatusType } from "@internal/datastore/src/types";
+import { randomUUID } from "crypto";
+import { createSupplierRepository } from "../infrastructure/suppliers-repo-factory";
+
+
+
+async function main() {
+  await yargs(hideBin(process.argv))
+    .command(
+      "put-supplier",
+      "Create or update a supplier",
+      {
+        environment: {
+          type: "string",
+          demandOption: true,
+        },
+        "id": {
+          type: "string",
+          demandOption: true,
+        },
+        "name": {
+          type: "string",
+          demandOption: false,
+        },
+        "apimId": {
+          type: "string",
+          demandOption: false,
+        },
+        status: {
+          type: "string",
+          demandOption: true,
+          choices: [
+            "ENABLED",
+            "DISABLED"
+          ],
+        },
+      },
+      async (argv) => {
+        // parse args
+        const id = argv.id;
+        const name = argv.name;
+        const apimId = argv.apimId;
+        const status = argv.status as "ENABLED" | "DISABLED";
+
+        const environment = argv.environment;
+
+        const supplierRepository = createSupplierRepository(environment);
+
+        const putResult = await supplierRepository.putSupplier({
+          id,
+          name,
+          apimId,
+          status,
+        });
+
+        console.log(`PUT successful ${JSON.stringify(putResult)}`);
+      }
+    )
+    .command(
+      "get-supplier-by-id",
+      "Get a supplier by their Supplier ID",
+      {
+        "id": {
+          type: "string",
+          demandOption: true,
+        },
+        environment: {
+          type: "string",
+          demandOption: true,
+        },
+      },
+      async (argv) => {
+
+        const id = argv.id;
+        const environment = argv.environment;
+
+        const supplierRepository = createSupplierRepository(environment);
+
+        const getResult = await supplierRepository.getSupplierById(id);
+
+        console.log(`GET successful: ${JSON.stringify(getResult)}`);
+      },
+    )
+    .command(
+      "get-supplier-by-apim-id",
+      "Get a supplier by their APIM ID",
+      {
+        "apimId": {
+          type: "string",
+          demandOption: true,
+        },
+        environment: {
+          type: "string",
+          demandOption: true,
+        },
+      },
+      async (argv) => {
+
+        const apimId = argv.apimId;
+        const environment = argv.environment;
+
+        const supplierRepository = createSupplierRepository(environment);
+
+        const getResult = await supplierRepository.getSupplierByApimId(apimId);
+
+        console.log(`GET successful: ${JSON.stringify(getResult)}`);
+      },
+    )
+    .demandCommand(1)
+    .parse();
+}
+
+if (require.main === module) {
+  main().catch((err) => {
+    console.error(err);
+    process.exitCode = 1;
+  });
+}
diff --git a/scripts/utilities/supplier-data/src/infrastructure/suppliers-repo-factory.ts b/scripts/utilities/supplier-data/src/infrastructure/suppliers-repo-factory.ts
@@ -0,0 +1,15 @@
+import { DynamoDBClient } from '@aws-sdk/client-dynamodb';
+import { DynamoDBDocumentClient } from '@aws-sdk/lib-dynamodb';
+import { pino } from 'pino';
+import { SupplierRepository } from '@internal/datastore';
+
+export function createSupplierRepository(environment: string): SupplierRepository {
+  const ddbClient = new DynamoDBClient({});
+  const docClient = DynamoDBDocumentClient.from(ddbClient);
+  const log = pino();
+  const config = {
+    suppliersTableName: `nhs-${environment}-supapi-suppliers`,
+  };
+
+  return new SupplierRepository(docClient, log, config);
+}
diff --git a/scripts/utilities/supplier-data/tsconfig.json b/scripts/utilities/supplier-data/tsconfig.json
@@ -0,0 +1,8 @@
+{
+  "compilerOptions": {},
+  "extends": "../../../tsconfig.base.json",
+  "include": [
+    "src/**/*",
+    "jest.config.ts"
+  ]
+}

Original file line number	Diff line number	Diff line change
`@@ -79,7 +79,7 @@`
`79`	`79`	`"workspaces": [`
`80`	`80`	`"lambdas/*",`
`81`	`81`	`"internal/*",`
`82`		`- "scripts/test-data",`
	`82`	`+ "scripts/utilities/*",`
`83`	`83`	`"docs"`
`84`	`84`	`]`
`85`	`85`	`}`