CCM-11025: add schemas package

Author: harrim91

.github/workflows/stage-4-acceptance.yaml

@@ -75,3 +75,26 @@ jobs:
       targetAccountGroup: nhs-notify-template-management-dev
       targetComponent: sandbox
       terraformAction: destroy
+
+  publish-test-package:
+    name: Publish test package
+    needs: sandbox-tear-down
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Use Node.js 20
+        uses: actions/setup-node@v4
+        with:
+          node-version: '20.18.2'
+          registry-url: 'https://npm.pkg.github.com'
+
+      - name: Install dependencies
+        run: npm install
+
+      - name: Publish to GitHub Packages
+        run: npm publish --workspace packages/schemas
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }}

package-lock.json

@@ -55,6 +55,7 @@
     "lambdas/backend-client",
     "lambdas/download-authorizer",
     "lambdas/sftp-letters",
+    "packages/schemas",
     "tests/accessibility",
     "tests/test-team",
     "utils/backend-config",

package.json

@@ -0,0 +1,21 @@
+# MIT Licence
+
+Copyright (c) 2025 Crown Copyright NHS England.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

packages/schemas/LICENCE

@@ -0,0 +1 @@
+# Template Management Schemas

packages/schemas/README.md

@@ -0,0 +1,27 @@
+import fs from 'node:fs';
+import path from 'node:path';
+import { $TemplateCompletedEvent } from '../../src/events/TemplateCompleted';
+
+const examplesDir = path.resolve(
+  __dirname,
+  '../../sample-events/TemplateCompleted'
+);
+
+describe('TemplateCompletedEvent schema', () => {
+  it.each(fs.readdirSync(examplesDir))(
+    'parses sample event %s without errors',
+    (filename) => {
+      const event = JSON.parse(
+        fs.readFileSync(path.join(examplesDir, filename), 'utf8')
+      );
+
+      const result = $TemplateCompletedEvent.safeParse(event);
+
+      if (!result.success) {
+        console.log(result.error);
+      }
+
+      expect(result.success).toBe(true);
+    }
+  );
+});

packages/schemas/__tests__/events/TemplateCompleted.test.ts

@@ -0,0 +1,27 @@
+import fs from 'node:fs';
+import path from 'node:path';
+import { $TemplateDeletedEvent } from '../../src/events/TemplateDeleted';
+
+const examplesDir = path.resolve(
+  __dirname,
+  '../../sample-events/TemplateDeleted'
+);
+
+describe('TemplateCompletedEvent schema', () => {
+  it.each(fs.readdirSync(examplesDir))(
+    'parses sample event %s without errors',
+    (filename) => {
+      const event = JSON.parse(
+        fs.readFileSync(path.join(examplesDir, filename), 'utf8')
+      );
+
+      const result = $TemplateDeletedEvent.safeParse(event);
+
+      if (!result.success) {
+        console.log(result.error);
+      }
+
+      expect(result.success).toBe(true);
+    }
+  );
+});

packages/schemas/__tests__/events/TemplateDeleted.test.ts

@@ -0,0 +1,27 @@
+import fs from 'node:fs';
+import path from 'node:path';
+import { $TemplateDraftedEvent } from '../../src/events/TemplateDrafted';
+
+const examplesDir = path.resolve(
+  __dirname,
+  '../../sample-events/TemplateDrafted'
+);
+
+describe('TemplateDraftedEvent schema', () => {
+  it.each(fs.readdirSync(examplesDir))(
+    'parses sample event %s without errors',
+    (filename) => {
+      const event = JSON.parse(
+        fs.readFileSync(path.join(examplesDir, filename), 'utf8')
+      );
+
+      const result = $TemplateDraftedEvent.safeParse(event);
+
+      if (!result.success) {
+        console.log(result.error);
+      }
+
+      expect(result.success).toBe(true);
+    }
+  );
+});

packages/schemas/__tests__/events/TemplateDrafted.test.ts

@@ -0,0 +1,9 @@
+import type { Config } from 'jest';
+import { baseJestConfig } from 'nhs-notify-web-template-management-utils';
+
+const config: Config = {
+  ...baseJestConfig,
+  testEnvironment: 'node',
+};
+
+export default config;

packages/schemas/jest.config.ts

@@ -0,0 +1,53 @@
+{
+  "author": "NHS Notify contributors",
+  "description": "Zod validators, TypeScript type definitions and JSON Schemas for Template Management",
+  "devDependencies": {
+    "@swc/core": "^1.11.13",
+    "@swc/jest": "^0.2.37",
+    "@tsconfig/node20": "^20.1.5",
+    "@types/jest": "^29.5.14",
+    "jest": "^29.7.0",
+    "tsx": "^4.19.3",
+    "typescript": "^5.8.2",
+    "zod": "^4.0.5"
+  },
+  "exports": {
+    ".": {
+      "default": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    },
+    "./event-schemas/*.json": {
+      "default": "./dist/event-schemas/*.json"
+    },
+    "./sample-events/*.json": {
+      "default": "./sample-events/*.json"
+    }
+  },
+  "files": [
+    "dist",
+    "sample-events"
+  ],
+  "license": "MIT",
+  "main": "./dist/index.js",
+  "name": "@nhsdigital/nhs-notify-templates-test-package",
+  "peerDependencies": {
+    "zod": "^4.0.5"
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://npm.pkg.github.com"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/NHSDigital/nhs-notify-web-template-management.git"
+  },
+  "scripts": {
+    "build": "npm run clean && tsc && tsx scripts/generate-json-schemas.ts",
+    "clean": "rm -rf dist",
+    "prepublishOnly": "npm run build",
+    "test:unit": "jest"
+  },
+  "type": "commonjs",
+  "types": "./dist/index.d.ts",
+  "version": "1.0.0"
+}