CCM-12869: Add initial schemas and events for supplier configuration (#37)

* Feature: Add initial schemas and events for supplier configuration

* Fix: dependencies

* Remove domain prefix from subject in event envelope

* Remove documentation examples
+ fix event-builder tests

* Remove generated files from git

* Add contract events

* Remove stray readme

* Add supplier model events

* Refactor contract references to volume group in schemas and events

* Add volume group events and update JSON generation

* Refactor status handling to use $EnvironmentStatus across configurations

* Update tests

* Add approval status validation and update enums in specifications

* Update deliverySLA to deliveryDays and change status references to PROD

* Refactor colour property to restrict to WHITE and update description

* Add DISABLED status to various entities and update related schemas

* Add optional description to PackSpecification and update tests

* Add duplex field validation to PackSpecification and update tests

* Add ATTACHMENT type to PackSpecification $Insert schema

* Add constraints validation to PackSpecification and related tests

* Rename specification-supplier.test.ts to supplier-pack.test.ts

* Enhance constraint validation by adding GREATER_THAN_OR_EQUAL and LESS_THAN_OR_EQUAL options; update billingId metadata in PackSpecification

Author: m-houston

package-lock.json

@@ -1,8 +1,8 @@
 {
   "dependencies": {
-    "@nhsdigital/nhs-notify-supplier-config-schemas": "1.0.0",
+    "@nhsdigital/nhs-notify-event-schemas-supplier-config": "1.0.0",
     "csv-parse": "^5.6.0",
-    "zod": "^4.0.17"
+    "zod": "^4.1.12"
   },
   "devDependencies": {
     "@swc/core": "^1.11.13",
@@ -12,7 +12,7 @@
     "esbuild": "^0.25.9",
     "jest": "^29.7.0",
     "jest-mock-extended": "^3.0.7",
-    "typescript": "^5.8.2"
+    "typescript": "^5.9.3"
   },
   "name": "nhs-notify-supplier-config-event-builder",
   "private": true,

packages/event-builder/package.json

@@ -0,0 +1,45 @@
+import packageJson from "@nhsdigital/nhs-notify-event-schemas-supplier-config/package.json";
+import { Config, buildEventSource, configFromEnv } from "../config";
+
+describe("config.ts", () => {
+  const originalEnv = process.env;
+
+  beforeEach(() => {
+    jest.resetModules();
+    process.env = { ...originalEnv }; // shallow copy
+    delete process.env.EVENT_ENV;
+    delete process.env.EVENT_SERVICE;
+    delete process.env.EVENT_DATASCHEMAVERSION;
+  });
+
+  afterAll(() => {
+    process.env = originalEnv; // restore
+  });
+
+  it("returns defaults when env vars are not set", () => {
+    const cfg = configFromEnv();
+    expect(cfg.EVENT_ENV).toBe("dev");
+    expect(cfg.EVENT_SERVICE).toBe("events");
+    expect(cfg.EVENT_DATASCHEMAVERSION).toBe(packageJson.version);
+  });
+
+  it("applies overrides from environment variables", () => {
+    process.env.EVENT_ENV = "prod";
+    process.env.EVENT_SERVICE = "supplier";
+    process.env.EVENT_DATASCHEMAVERSION = "9.9.9";
+    const cfg = configFromEnv();
+    expect(cfg.EVENT_ENV).toBe("prod");
+    expect(cfg.EVENT_SERVICE).toBe("supplier");
+    expect(cfg.EVENT_DATASCHEMAVERSION).toBe("9.9.9");
+  });
+
+  it("buildEventSource constructs expected path", () => {
+    const cfg: Config = {
+      EVENT_ENV: "int",
+      EVENT_SERVICE: "allocations",
+      EVENT_DATASCHEMAVERSION: packageJson.version,
+    };
+    const src = buildEventSource(cfg);
+    expect(src).toBe("/control-plane/supplier-config/int/allocations");
+  });
+});

packages/event-builder/src/__tests__/config.test.ts

@@ -1,12 +1,20 @@
 import { z } from "zod";
+import packageJson from "@nhsdigital/nhs-notify-event-schemas-supplier-config/package.json";
+
+const dataschemaversion = packageJson.version;
 
 const $Config = z.object({
-  EVENT_SOURCE: z.string(),
+  EVENT_ENV: z.string().default("dev"),
+  EVENT_SERVICE: z.string().default("events"),
+  EVENT_DATASCHEMAVERSION: z.string().default(dataschemaversion),
 });
+export type Config = z.infer<typeof $Config>;
 
-export const loadConfig = () => {
+export const configFromEnv = () => {
   return $Config.parse(process.env);
 };
 
-export const eventSource =
-  "//notify.nhs.uk/app/nhs-notify-supplier-config-dev/main";
+export const buildEventSource = (config: Config) => {
+  const { EVENT_ENV, EVENT_SERVICE } = config;
+  return `/control-plane/supplier-config/${EVENT_ENV}/${EVENT_SERVICE}`;
+};

packages/event-builder/src/config.ts

@@ -1,6 +1,8 @@
 {
   "compilerOptions": {
-    "baseUrl": "./src/"
+    "baseUrl": "./src/",
+    "isolatedModules": true,
+    "resolveJsonModule": true
   },
   "exclude": [
     "node_modules"

packages/event-builder/tsconfig.json

@@ -0,0 +1 @@
+output/

packages/events/.gitignore

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

packages/events/.spectral.yaml

@@ -0,0 +1,43 @@
+module.exports = {
+  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__/'],
+
+  // 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,
+      },
+    ],
+  ],
+
+  testEnvironment: 'node',
+  testMatch: ['**/__tests__/**/*test.ts'],
+  moduleFileExtensions: ['ts', 'js', 'json', 'node'],
+};

packages/events/jest.config.js

@@ -1,30 +1,35 @@
 {
   "author": "",
   "dependencies": {
-    "zod": "^4.0.5"
+    "zod": "^4.1.12"
   },
   "description": "Schemas for NHS Notify configuration",
   "devDependencies": {
-    "@types/jest": "^30.0.0",
+    "@types/jest": "^29.5.14",
     "@types/node": "^22.13.4",
-    "jest": "^30.0.4",
+    "jest": "^29.7.0",
     "ts-jest": "^29.4.0",
     "ts-node": "^10.9.2",
-    "typescript": "^5.7.3"
+    "typescript": "^5.9.3",
+    "zod-mermaid": "^1.3.0"
   },
-  "main": "src/index.ts",
-  "name": "@nhsdigital/nhs-notify-supplier-config-schemas",
+  "main": "dist/index.js",
+  "name": "@nhsdigital/nhs-notify-event-schemas-supplier-config",
   "publishConfig": {
     "registry": "https://npm.pkg.github.com"
   },
   "repository": "git@github.com:NHSDigital/nhs-notify-supplier-config.git",
   "scripts": {
-    "build": "tsc",
+    "build": "tsc -p ./tsconfig.build.json",
     "dev": "ts-node src/index.ts",
-    "json": "ts-node src/cli/generate-json.ts",
+    "examples": "ts-node src/examples/specification-examples.ts",
+    "gen:erd": "ts-node src/cli/generate-erd.ts",
+    "gen:json": "ts-node src/cli/generate-json.ts",
+    "prepare": "npm run build",
     "start": "node dist/index.js",
     "test": "jest",
     "test:unit": "jest"
   },
+  "types": "dist/index.d.ts",
   "version": "1.0.0"
 }

packages/schemas/package.json packages/events/package.jsonpackages/schemas/package.json renamed to packages/events/package.json

@@ -0,0 +1 @@
+*.schema.json