CCM-11026: add version to event files, add jsonschema tests

Author: harrim91

lambdas/event-publisher/jest.config.ts

@@ -5,7 +5,7 @@ const config: Config = {
   ...baseJestConfig,
   testEnvironment: 'node',
   moduleNameMapper: {
-    '@nhsdigital/nhs-notify-event-schemas-template-management':
+    '@nhsdigital/nhs-notify-event-schemas-template-management$':
       '<rootDir>/../../packages/event-schemas/src',
   },
 };

lambdas/event-publisher/src/domain/output-schemas.ts

@@ -1,15 +1,15 @@
 import {
-  $TemplateCompletedEvent,
-  $TemplateDeletedEvent,
-  $TemplateDraftedEvent,
+  $TemplateCompletedEventV1,
+  $TemplateDeletedEventV1,
+  $TemplateDraftedEventV1,
 } from '@nhsdigital/nhs-notify-event-schemas-template-management';
 import { z } from 'zod';
 
 // the lambda doesn't necessarily have to only publish TemplateSaved events but
 // that's all it is doing at the moment
 export const $Event = z.discriminatedUnion('type', [
-  $TemplateCompletedEvent,
-  $TemplateDraftedEvent,
-  $TemplateDeletedEvent,
+  $TemplateCompletedEventV1,
+  $TemplateDraftedEventV1,
+  $TemplateDeletedEventV1,
 ]);
 export type Event = z.infer<typeof $Event>;

lambdas/event-publisher/tsconfig.json

@@ -2,7 +2,7 @@
   "compilerOptions": {
     "baseUrl": ".",
     "paths": {
-      "@nhsdigital/nhs-notify-event-schemas-template-management": [
+      "@nhsdigital/nhs-notify-event-schemas-template-management$": [
         "../../packages/event-schemas/src"
       ]
     },

package-lock.json

@@ -1 +1,63 @@
-# Template Management Schemas
+# Template Management Event Schemas
+
+Zod validators, TypeScript type definitions, JSON Schemas and Sample Events for events emitted by Template Management service
+
+## Installation
+
+To install this package from GitHub package registry, you will need to configure an `.npmrc` file with the following:
+
+```txt
+//npm.pkg.github.com/:_authToken=<GITHUB_TOKEN>
+@nhsdigital:registry=https://npm.pkg.github.com
+```
+
+where `GITHUB_TOKEN` is a classic PAT with the `packages:read` scope.
+
+Then run `npm install @nhsdigital/nhs-notify-event-schemas-template-management`
+
+## Events
+
+- `TemplateCompleted`
+- `TemplateDeleted`
+- `TemplateDrafted`
+
+## Usage
+
+### Zod Validators
+
+Zod validators for each event type are exported along with an accompanying type definition:
+
+```ts
+import {
+  $TemplateCompletedEvent,
+  $TemplateDeletedEvent,
+  $TemplateDraftedEvent,
+  type TemplateCompletedEvent,
+  type TemplateDeletedEvent,
+  type TemplateDraftedEvent,
+} from '@nhsdigital/nhs-notify-event-schemas-template-management';
+
+$TemplateCompletedEvent.parse(event);
+$TemplateDeletedEvent.parse(event);
+$TemplateDraftedEvent.parse(event);
+```
+
+### JSON Schemas
+
+JSON Schema files for each event type are included in the package. These are generated from the Zod schemas and can be imported as follows:
+
+```ts
+import TemplateCompletedEventV1Schema from '@nhsdigital/nhs-notify-event-schemas-template-management/schemas/TemplateCompleted/v1.json';
+import TemplateDeletedEventV1Schema from '@nhsdigital/nhs-notify-event-schemas-template-management/schemas/TemplateDeleted/v1.json';
+import TemplateDraftedEventV1Schema from '@nhsdigital/nhs-notify-event-schemas-template-management/schemas/TemplateDrafted/v1.json';
+```
+
+### Sample Events
+
+A number of sample event files are also included for each event type. These can be imported as follows:
+
+```ts
+import EmailTemplateCompletedEvent from '@nhsdigital/nhs-notify-event-schemas-template-management/examples/TemplateCompleted/v1/email.json';
+import SmsTemplateDeletedEventV1Schema from '@nhsdigital/nhs-notify-event-schemas-template-management/examples/TemplateDeleted/v1/sms.json';
+import NhsAppTemplateDraftedEventV1Schema from '@nhsdigital/nhs-notify-event-schemas-template-management/examples/TemplateDrafted/v1/nhsapp.json';
+```

packages/event-schemas/.gitignore

@@ -2,19 +2,22 @@
 
 import fs from 'node:fs';
 import path from 'node:path';
-import { $TemplateCompletedEvent } from '../../src/events/template-completed';
+import { $TemplateCompletedEventV1 } from '../../src/events/template-completed';
 
-const examplesDir = path.resolve(__dirname, '../../examples/TemplateCompleted');
+const examplesDir = path.resolve(
+  __dirname,
+  '../../examples/TemplateCompleted/v1'
+);
 
-describe('TemplateCompletedEvent schema', () => {
+describe('TemplateCompletedEventV1 Zod 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);
+      const result = $TemplateCompletedEventV1.safeParse(event);
 
       if (!result.success) {
         console.log(result.error);

packages/event-schemas/README.md

@@ -2,19 +2,22 @@
 
 import fs from 'node:fs';
 import path from 'node:path';
-import { $TemplateDeletedEvent } from '../../src/events/template-deleted';
+import { $TemplateDeletedEventV1 } from '../../src/events/template-deleted';
 
-const examplesDir = path.resolve(__dirname, '../../examples/TemplateDeleted');
+const examplesDir = path.resolve(
+  __dirname,
+  '../../examples/TemplateDeleted/v1'
+);
 
-describe('TemplateCompletedEvent schema', () => {
+describe('TemplateCompletedEventV1 Zod 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);
+      const result = $TemplateDeletedEventV1.safeParse(event);
 
       if (!result.success) {
         console.log(result.error);

packages/event-schemas/__tests__/events/template-completed.test.ts

@@ -2,19 +2,22 @@
 
 import fs from 'node:fs';
 import path from 'node:path';
-import { $TemplateDraftedEvent } from '../../src/events/template-drafted';
+import { $TemplateDraftedEventV1 } from '../../src/events/template-drafted';
 
-const examplesDir = path.resolve(__dirname, '../../examples/TemplateDrafted');
+const examplesDir = path.resolve(
+  __dirname,
+  '../../examples/TemplateDrafted/v1'
+);
 
-describe('TemplateDraftedEvent schema', () => {
+describe('TemplateDraftedEventV1 Zod 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);
+      const result = $TemplateDraftedEventV1.safeParse(event);
 
       if (!result.success) {
         console.log(result.error);

packages/event-schemas/__tests__/events/template-deleted.test.ts

@@ -0,0 +1,36 @@
+/* eslint-disable security/detect-non-literal-fs-filename */
+
+import fs from 'node:fs';
+import path from 'node:path';
+import { Ajv2020 } from 'ajv/dist/2020';
+import addFormats from 'ajv-formats';
+
+import TemplateCompletedEventV1Schema from '../../schemas/TemplateCompleted/v1.json';
+
+const examplesDir = path.resolve(
+  __dirname,
+  '../../examples/TemplateCompleted/v1'
+);
+
+describe('TemplateCompletedEventV1 JSON 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 ajv = new Ajv2020();
+      addFormats(ajv);
+      const validate = ajv.compile(TemplateCompletedEventV1Schema);
+
+      const valid = validate(event);
+
+      if (!valid) {
+        console.log(validate.errors);
+      }
+
+      expect(valid).toBe(true);
+    }
+  );
+});