Make event-envelope match validation done in event publisher lambda

Author: stevebux

internal/events/src/events/event-envelope.ts

@@ -50,6 +50,12 @@ export function EventEnvelope<TData extends z.ZodTypeAny>(
         examples: typeStrings,
       }),
 
+      plane: z.literal("data-plane").meta({
+        title: "plane",
+        description: "Fixed as data-plane",
+        examples: ["data-plane"],
+      }),
+
       dataschema: z
         .string()
         .regex(
@@ -64,6 +70,15 @@ export function EventEnvelope<TData extends z.ZodTypeAny>(
           examples: schemaExamples,
         }),
 
+      dataschemaversion: z
+        .string()
+        .regex(/^1.\d+.\d+$/)
+        .meta({
+          title: "Data Schema URI",
+          description: `Version of the schema that describes the event data\n\nMust match the version in dataschema`,
+          examples:["1.0.0"],
+        }),
+
       source: z
         .string()
         .regex(/^\/data-plane\/supplier-api(?:\/.*)?$/)
@@ -94,13 +109,13 @@ export function EventEnvelope<TData extends z.ZodTypeAny>(
         examples: ["2025-10-01T10:15:30.000Z"],
       }),
 
-      datacontenttype: z.optional(
+      datacontenttype:
         z.literal("application/json").meta({
           title: "Data Content Type",
           description:
             "Media type for the data field (fixed to application/json).",
           examples: ["application/json"],
-        }),
+        },
       ),
 
       traceparent: z

lambdas/letter-updates-transformer/src/mappers/__tests__/letter-mapper.test.ts

@@ -20,6 +20,7 @@ describe("letter-mapper", () => {
     $LetterEvent.parse(event);
     expect(event.type).toBe("uk.nhs.notify.supplier-api.letter.PRINTED.v1");
     expect(event.dataschema).toBe("https://notify.nhs.uk/cloudevents/schemas/supplier-api/letter.PRINTED.1.0.0.schema.json");
+    expect(event.dataschemaversion).toBe("1.0.0");
     expect(event.subject).toBe("letter-origin/supplier-api/letter/id1");
     expect(event.time).toBe("2025-11-24T15:55:18.000Z");
     expect(event.recordedtime).toBe("2025-11-24T15:55:18.000Z");

lambdas/letter-updates-transformer/src/mappers/letter-mapper.ts

@@ -5,11 +5,14 @@ import { randomUUID, randomBytes } from "crypto";
 export function mapLetterToCloudEvent(letter: LetterBase): LetterEvent {
   const now = new Date().toISOString();
   const eventId = randomUUID();
+  const dataschemaversion = '1.0.0';
   return {
     specversion: "1.0",
     id: eventId,
     type: `uk.nhs.notify.supplier-api.letter.${letter.status}.v1`,
-    dataschema: `https://notify.nhs.uk/cloudevents/schemas/supplier-api/letter.${letter.status}.1.0.0.schema.json`,
+    plane: 'data-plane',
+    dataschema: `https://notify.nhs.uk/cloudevents/schemas/supplier-api/letter.${letter.status}.${dataschemaversion}.schema.json`,
+    dataschemaversion,
     source: "/data-plane/supplier-api/letters",
     subject: "letter-origin/supplier-api/letter/" + letter.id,
 
@@ -28,6 +31,7 @@ export function mapLetterToCloudEvent(letter: LetterBase): LetterEvent {
       }
     },
     time: now,
+    datacontenttype: 'application/json',
     traceparent: `00-${randomBytes(16).toString("hex")}-${randomBytes(8).toString("hex")}-01`,
     recordedtime: now,
     severitynumber: 2,