CCM-12352: add events for letter status changed

Author: m-houston

.editorconfig

@@ -67,3 +67,6 @@ trim_trailing_whitespace = unset
 indent_style = unset
 indent_size = unset
 generated_code = true
+
+[/internal/events/**/*.schema.json]
+insert_final_newline = unset

.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

@@ -4,7 +4,7 @@
     "@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",
@@ -19,7 +19,7 @@
     "testcontainers": "^11.4.0",
     "ts-jest": "^29.4.0",
     "ts-node": "^10.9.2",
-    "typescript": "^5.8.2"
+    "typescript": "^5.8.3"
   },
   "license": "MIT",
   "main": "src/index.ts",

internal/datastore/src/types.ts

@@ -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(),
@@ -48,7 +48,7 @@ export type LetterBase = z.infer<typeof LetterSchemaBase>;
 
 export const MISchema = z.object({
   id: z.string(),
-  supplierId: idRef(SupplierSchema),
+  supplierId: idRef(SupplierSchema, 'id'),
   specificationId: z.string(),
   groupId: z.string(),
   lineItem: z.string(),

internal/events/.spectral.yaml

@@ -0,0 +1 @@
+extends: ["spectral:oas", "spectral:asyncapi", "spectral:arazzo"]

internal/events/jest.config.ts

@@ -0,0 +1,10 @@
+export default {
+  preset: "ts-jest",
+  testEnvironment: "node",
+  testMatch: ["**/__tests__/**/*.ts", "**/?(*.)+(spec|test).ts"],
+  testPathIgnorePatterns: ["<rootDir>/dist/"],
+  moduleFileExtensions: ["ts", "js", "json", "node"],
+  transform: {
+    "^.+\\.ts$": ["ts-jest", { tsconfig: "<rootDir>/tsconfig.jest.json" }],
+  },
+};

internal/events/package.json

@@ -1,10 +1,12 @@
 {
   "dependencies": {
+    "@asyncapi/bundler": "^0.6.4",
     "@internal/helpers": "*",
-    "zod": "^4.0.14"
+    "zod": "^4.1.11"
   },
   "description": "Schemas for NHS Notify Supplier API events",
   "devDependencies": {
+    "@stoplight/spectral-cli": "^6.15.0",
     "@stylistic/eslint-plugin": "^3.1.0",
     "@tsconfig/node22": "^22.0.2",
     "@types/jest": "^29.5.14",
@@ -15,21 +17,33 @@
     "jest": "^29.7.0",
     "ts-jest": "^29.4.0",
     "ts-node": "^10.9.2",
-    "typescript": "^5.8.2",
-    "zod-mermaid": "^1.0.9"
+    "typescript": "^5.8.3"
   },
   "license": "MIT",
   "main": "dist/index.js",
-  "name": "nhs-notify-schemas-supplier-api",
+  "name": "@nhsdigital/nhs-notify-event-schemas-supplier-api",
   "private": true,
+  "publishConfig": {
+    "registry": "https://npm.pkg.github.com"
+  },
+  "repository": "[email protected]:NHSDigital/nhs-notify-supplier-api.git",
   "scripts": {
     "build": "tsc",
-    "generate-diagrams": "ts-node src/cli/generateDiagrams.ts",
-    "lint": "eslint .",
+    "dev": "ts-node src/index.ts",
+    "gen:asyncapi": "mkdir -p ./dist/asyncapi && ts-node src/cli/bundle-asyncapi.ts",
+    "gen:jsonschema": "ts-node src/cli/generate-json.ts",
+    "lint": "npm run lint:node && npm run lint:schema",
     "lint:fix": "eslint . --fix",
+    "lint:node": "eslint .",
+    "lint:schema": "spectral lint client-config/client-config.yaml",
+    "prebuild": "rm -rf dist && npm run gen:asyncapi",
+    "pregen:asyncapi": "npm run gen:jsonschema",
+    "pregen:jsonschema": "rm -rf ./client-config/json",
+    "prelint:schema": "npm run gen:jsonschema",
+    "start": "node dist/index.js",
     "test": "jest",
-    "typecheck": "tsc --noEmit"
+    "test:unit": "jest"
   },
   "types": "dist/index.d.ts",
-  "version": "0.1.0"
+  "version": "1.0.0"
 }

internal/events/schemas/domain/letter-status-change.schema.json

@@ -0,0 +1,39 @@
+{
+  "type": "object",
+  "properties": {
+    "domainId": {
+      "type": "string"
+    },
+    "sourceSubject": {
+      "type": "string"
+    },
+    "status": {
+      "type": "string",
+      "enum": [
+        "PENDING",
+        "ACCEPTED",
+        "REJECTED",
+        "PRINTED",
+        "ENCLOSED",
+        "CANCELLED",
+        "DISPATCHED",
+        "FAILED",
+        "RETURNED",
+        "DESTROYED",
+        "FORWARDED",
+        "DELIVERED"
+      ]
+    },
+    "reasonCode": {
+      "type": "string"
+    },
+    "reasonText": {
+      "type": "string"
+    }
+  },
+  "required": [
+    "domainId",
+    "sourceSubject",
+    "status"
+  ]
+}