Add 'dataschemaversion' field to letter request schemas and update version to 1.1.5 (#32)

Author: m-houston

package-lock.json

@@ -40,5 +40,5 @@
     "test:unit": "jest",
     "prepare": "npm run build"
   },
-  "version": "1.1.4"
+  "version": "1.1.5"
 }

packages/events/package.json

@@ -18,6 +18,7 @@
   "dataschema": "https://notify.nhs.uk/cloudevents/schemas/letter-rendering/letter-request.PREPARED.1.0.0.schema.json",
   "dataschemaversion": "1.0.0",
   "id": "23f1f09c-a555-4d9b-8405-0b33490bc920",
+  "plane": "data",
   "recordedtime": "2025-08-28T08:45:00.000Z",
   "severitynumber": 2,
   "severitytext": "INFO",

packages/events/schemas/examples/letter-request.prepared.json

@@ -8,6 +8,7 @@ describe("EventEnvelope schema validation", () => {
   const baseValidEnvelope: Envelope = {
     dataschema:
       "https://notify.nhs.uk/cloudevents/schemas/letter-rendering/order.read.1.0.0.schema.json",
+    dataschemaversion: "1.0.0",
     specversion: "1.0",
     id: "6f1c2a53-3d54-4a0a-9a0b-0e9ae2d4c111",
     source: "/data-plane/letter-rendering/ordering",
@@ -260,6 +261,7 @@ describe("EventEnvelope schema validation", () => {
       type: "uk.nhs.notify.letter-rendering.letter.created.v1" as const,
       dataschema:
         "https://notify.nhs.uk/cloudevents/schemas/letter-rendering/letter.created.1.0.0.schema.json",
+      dataschemaversion: "1.0.0",
       source: "/data-plane/letter-rendering/letters",
       time: "2025-10-01T10:15:30.000Z",
       data: { status: "CREATED" },
@@ -318,6 +320,7 @@ describe("EventEnvelope schema validation", () => {
         type: "uk.nhs.notify.letter-rendering.order.read.v1" as const,
         dataschema:
           "https://notify.nhs.uk/cloudevents/schemas/letter-rendering/order.read.1.0.0.schema.json",
+        dataschemaversion: "1.0.0",
         source: "/data-plane/letter-rendering/ordering",
         subject: "order/769acdd4",
         time: "2025-10-01T10:15:30.000Z",
@@ -365,6 +368,7 @@ describe("EventEnvelope schema validation", () => {
         type: "uk.nhs.notify.letter-rendering.order.read.v1" as const,
         dataschema:
           "https://notify.nhs.uk/cloudevents/schemas/letter-rendering/order.read.1.0.0.schema.json",
+        dataschemaversion: "1.0.0",
         source: "/data-plane/letter-rendering/ordering",
         subject: "prefix/letter-rendering/order/769acdd4",
         time: "2025-10-01T10:15:30.000Z",

packages/events/src/events/__tests__/event-envelope.test.ts

@@ -16,6 +16,7 @@
   },
   "datacontenttype": "application/json",
   "dataschema": "https://notify.nhs.uk/cloudevents/schemas/letter-rendering/letter-request.prepared.1.0.0.schema.json",
+  "dataschemaversion": "1.0.0",
   "id": "23f1f09c-a555-4d9b-8405-0b33490bc920",
   "plane": "data",
   "recordedtime": "2025-08-28T08:45:00.000Z",

packages/events/src/events/__tests__/testData/letter-request-prepared-valid.json

@@ -16,6 +16,7 @@
   },
   "datacontenttype": "application/json",
   "dataschema": "https://notify.nhs.uk/cloudevents/schemas/letter-rendering/letter-request.prepared.0.1.0.schema.json",
+  "dataschemaversion": "0.1.0",
   "id": "23f1f09c-a555-4d9b-8405-0b33490bc920",
   "plane": "data",
   "recordedtime": "2025-08-28T08:45:00.000Z",

packages/events/src/events/__tests__/testData/letter-request-prepared-with-invalid-major-version.json

@@ -15,6 +15,7 @@
   },
   "datacontenttype": "application/json",
   "dataschema": "https://notify.nhs.uk/cloudevents/schemas/letter-rendering/letter-request.prepared.1.0.0.schema.json",
+  "dataschemaversion": "1.0.0",
   "id": "23f1f09c-a555-4d9b-8405-0b33490bc920",
   "plane": "data",
   "recordedtime": "2025-08-28T08:45:00.000Z",

packages/events/src/events/__tests__/testData/letter-request-prepared-with-missing-fields.json

@@ -13,6 +13,7 @@
   },
   "datacontenttype": "application/json",
   "dataschema": "https://notify.nhs.uk/cloudevents/schemas/letter-rendering/letter-request.prepared.1.0.0.schema.json",
+  "dataschemaversion": "1.0.0",
   "id": "23f1f09c-a555-4d9b-8405-0b33490bc920",
   "plane": "data",
   "recordedtime": "2025-08-28T08:45:00.000Z",

packages/events/src/events/__tests__/testData/letter-request-prepared-with-partial-optional-fields.json

@@ -11,6 +11,7 @@
   },
   "datacontenttype": "application/json",
   "dataschema": "https://notify.nhs.uk/cloudevents/schemas/letter-rendering/letter-request.prepared.1.0.0.schema.json",
+  "dataschemaversion": "1.0.0",
   "id": "23f1f09c-a555-4d9b-8405-0b33490bc920",
   "plane": "data",
   "recordedtime": "2025-08-28T08:45:00.000Z",

packages/events/src/events/__tests__/testData/letter-request-prepared-without-optional-fields.json

@@ -62,6 +62,16 @@ export function EventEnvelope<TData extends z.ZodTypeAny>(
           examples: schemaExamples,
         }),
 
+      dataschemaversion: z
+        .string()
+        .regex(/^1\.\d+\.\d+$/)
+        .meta({
+          title: "Data Schema Version",
+          description:
+            "Version of the data schema in semver format (must match the version suffix in dataschema URI).",
+          examples: ["1.0.0"],
+        }),
+
       source: z
         .string()
         .regex(/^\/data-plane\/(letter-rendering|digital-letters)(?:\/.*)?$/)