CCM-12352: Internal package refactor (#198)

* Refactor datastore package

* Clean up tests

* Make markdownlint config separate for specification docs

* Update documentation for run functions

* Fixup after merging main

* Update after main merge

* Replace newly introduced cross-package reference

* Remove generated README.md

* Restore dataschema diagram generation

* Add diagram for Supplier datastore schema

* Update package-lock conflicts

* update lock

---------

Co-authored-by: Mark Slowey <[email protected]>

Author: m-houston

.markdownlint.jsonc

@@ -0,0 +1,11 @@
+// SEE: https://github.com/DavidAnson/markdownlint/blob/main/schema/.markdownlint.yaml
+{
+  // https://github.com/DavidAnson/markdownlint/blob/main/doc/md013.md
+  "MD013": false,
+  // https://github.com/DavidAnson/markdownlint/blob/main/doc/md024.md
+  "MD024": {
+    "siblings_only": true
+  },
+  // https://github.com/DavidAnson/markdownlint/blob/main/doc/md033.md
+  "MD033": false
+}

.syncpackrc

@@ -0,0 +1,10 @@
+{
+  "versionGroups": [
+    {
+      "dependencies": ["@internal/**", "@nhsdigital/nhs-notify-event-schemas-supplier-api"],
+      "specifierTypes": ["*"],
+      "label": "Internal deps",
+      "isIgnored": true
+    }
+  ]
+}

internal/datastore/jest.config.ts

@@ -15,6 +15,11 @@ export const baseJestConfig: Config = {
   // Indicates which provider should be used to instrument code for coverage
   coverageProvider: 'babel',
 
+  // Module name mapper to handle TypeScript path aliases
+  moduleNameMapper: {
+    '^@internal/helpers$': '<rootDir>/../helpers/src'
+  },
+
   coverageThreshold: {
     global: {
       branches: 100,

internal/datastore/package.json

@@ -2,8 +2,9 @@
   "dependencies": {
     "@aws-sdk/client-dynamodb": "^3.858.0",
     "@aws-sdk/lib-dynamodb": "^3.858.0",
+    "@internal/helpers": "*",
     "pino": "^9.7.0",
-    "zod": "^4.0.14"
+    "zod": "^4.1.11"
   },
   "devDependencies": {
     "@stylistic/eslint-plugin": "^3.1.0",
@@ -18,15 +19,15 @@
     "testcontainers": "^11.4.0",
     "ts-jest": "^29.4.0",
     "ts-node": "^10.9.2",
-    "typescript": "^5.8.2",
+    "typescript": "^5.8.3",
     "zod-mermaid": "^1.0.9"
   },
   "license": "MIT",
   "main": "src/index.ts",
-  "name": "datastore",
+  "name": "@internal/datastore",
   "private": true,
   "scripts": {
-    "diagrams": "ts-node src/cli/diagrams.ts",
+    "diagrams": "tsx src/cli/diagrams.ts",
     "lint": "eslint .",
     "lint:fix": "eslint . --fix",
     "test:unit": "jest",

internal/datastore/src/cli/diagrams.ts

@@ -1,4 +1,4 @@
-import { LetterSchema, MISchema } from '../types';
+import {LetterSchema, MISchema, SupplierSchema} from '../types';
 import { generateMermaidDiagram } from 'zod-mermaid';
 import * as fs from 'node:fs';
 
@@ -11,7 +11,7 @@ This document contains the mermaid diagrams for the data store schemas used in t
 The schemas are generated from Zod definitions and provide a visual representation of the data structure.
 `);
 
-for (const [name, schema] of Object.entries({ Letter: [LetterSchema], MI: [MISchema] })) {
+for (const [name, schema] of Object.entries({ Letter: [LetterSchema], MI: [MISchema], Supplier: [SupplierSchema] })) {
   const mermaid = generateMermaidDiagram(schema);
   fs.writeSync(out, `
 ## ${name} schema

internal/datastore/src/types.md

@@ -31,7 +31,7 @@ erDiagram
 erDiagram
     MI {
         string id
-        string supplierId "ref: Supplier"
+        string supplierId
         string specificationId
         string groupId
         string lineItem
@@ -40,7 +40,16 @@ erDiagram
         string createdAt
         string updatedAt
     }
+```
+
+## Supplier schema
+
+```mermaid
+erDiagram
     Supplier {
+        string id
+        string name
+        string apimId
+        string status "enum: ENABLED, DISABLED"
     }
-    MI }o--|| Supplier : "supplierId"
 ```

internal/datastore/src/types.ts

@@ -1,5 +1,5 @@
 import { z } from 'zod';
-import { idRef } from 'zod-mermaid';
+import { idRef } from '@internal/helpers';
 
 export const SupplerStatus = z.enum(['ENABLED', 'DISABLED']);
 
@@ -29,7 +29,7 @@ export const LetterSchemaBase = z.object({
 });
 
 export const LetterSchema = LetterSchemaBase.extend({
-  supplierId: z.string(),
+  supplierId: idRef(SupplierSchema, 'id'),
   url: z.url(),
   createdAt: z.string(),
   updatedAt: z.string(),
@@ -57,7 +57,7 @@ export const MISchemaBase = z.object({
 });
 
 export const MISchema = MISchemaBase.extend({
-  supplierId: idRef(SupplierSchema),
+  supplierId: idRef(SupplierSchema, 'id'),
   createdAt: z.string(),
   updatedAt: z.string(),
   ttl: z.int(),

internal/datastore/tsconfig.json

@@ -1,8 +1,6 @@
 {
-  "compilerOptions": {
-    "isolatedModules": true
-  },
-  "extends": "@tsconfig/node22/tsconfig.json",
+  "compilerOptions": {},
+  "extends": "../../tsconfig.base.json",
   "include": [
     "src/**/*",
     "jest.config.ts"

internal/helpers/.gitignore

@@ -0,0 +1,24 @@
+# Dependency directories
+node_modules/
+
+# Built output
+dist/
+
+# Coverage directory used by tools like istanbul
+coverage/
+
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+# Editor directories and files
+.idea/
+.vscode/
+*.suo
+*.ntvs*
+*.njsproj
+*.sln
+*.sw?

internal/helpers/jest.config.ts

@@ -0,0 +1,15 @@
+import type { Config } from "jest";
+
+const config: Config = {
+  preset: "ts-jest",
+  testEnvironment: "node",
+  testMatch: ["**/src/__tests__/**/*.ts?(x)", "**/src/?(*.)+(spec|test).ts?(x)"],
+  collectCoverageFrom: ["src/**/*.ts"],
+  coveragePathIgnorePatterns: ["/node_modules/", "__tests__"],
+  testPathIgnorePatterns: ["/node_modules/", "/dist/"],
+  transform: {
+    "^.+\\.tsx?$": ["ts-jest", {  }]
+  }
+};
+
+export default config;