CCM-11026: PR feedbacks

harrim91 · harrim91 · commit c3794c9ae6dc · 2025-08-05T18:02:37.000+01:00
diff --git a/.github/workflows/pr_closed.yaml b/.github/workflows/pr_closed.yaml
@@ -75,7 +75,7 @@ jobs:
 
       - name: check if local version differs from latest published version
         run: |
-          published_version=$(npm view @nhsdigital/nhs-notify-templates-test-package --json  | jq -r '.["dist-tags"].latest')
+          published_version=$(npm view @nhsdigital/nhs-notify-event-schemas-template-management --json 2>/dev/null | jq -r '.["dist-tags"].latest')
           local_version=$(cat packages/event-schemas/package.json | jq -r '.version')
           if [[ $local_version = $published_version ]]; then
             echo "Local version is the same as the latest published version - skipping publish"
diff --git a/packages/event-schemas/examples/TemplateCompleted/v1/email.json b/packages/event-schemas/examples/TemplateCompleted/v1/email.json
@@ -18,7 +18,7 @@
   "dataschemaversion": "1.0.0",
   "id": "12f1f09c-a555-4d9b-8405-0b33490bc929",
   "plane": "control",
-  "source": "//notify.nhs.uk/app/nhs-notify-template-management-prod/prod",
+  "source": "//notify.nhs.uk/app/nhs-notify-template-management-prod/main",
   "specversion": "1.0",
   "subject": "871b0f4e-0b32-474e-a49a-23fc554bc5a6",
   "time": "2025-07-29T08:50:57.350Z",
diff --git a/packages/event-schemas/examples/TemplateCompleted/v1/letter.json b/packages/event-schemas/examples/TemplateCompleted/v1/letter.json
@@ -31,7 +31,7 @@
   "dataschemaversion": "1.0.0",
   "id": "20f471d0-367d-4914-bee3-2fa5322d67f1",
   "plane": "control",
-  "source": "//notify.nhs.uk/app/nhs-notify-template-management-prod/prod",
+  "source": "//notify.nhs.uk/app/nhs-notify-template-management-prod/main",
   "specversion": "1.0",
   "subject": "91be480d-c667-4741-957a-057b64753762",
   "time": "2025-07-29T10:11:28.078Z",
diff --git a/packages/event-schemas/examples/TemplateCompleted/v1/nhsapp.json b/packages/event-schemas/examples/TemplateCompleted/v1/nhsapp.json
@@ -17,7 +17,7 @@
   "dataschemaversion": "1.0.0",
   "id": "c958dab9-1cb2-4fb8-9990-c48ba1dc5518",
   "plane": "control",
-  "source": "//notify.nhs.uk/app/nhs-notify-template-management-prod/prod",
+  "source": "//notify.nhs.uk/app/nhs-notify-template-management-prod/main",
   "specversion": "1.0",
   "subject": "3a58a370-75ab-4788-a75e-cd2572a68523",
   "time": "2025-07-29T10:05:45.145Z",
diff --git a/packages/event-schemas/examples/TemplateCompleted/v1/sms.json b/packages/event-schemas/examples/TemplateCompleted/v1/sms.json
@@ -17,7 +17,7 @@
   "dataschemaversion": "1.0.0",
   "id": "58d46ca9-dae4-4500-9b9a-9e6547289e69",
   "plane": "control",
-  "source": "//notify.nhs.uk/app/nhs-notify-template-management-prod/prod",
+  "source": "//notify.nhs.uk/app/nhs-notify-template-management-prod/main",
   "specversion": "1.0",
   "subject": "9779f827-0670-48b4-8e96-5cecf893468e",
   "time": "2025-07-29T10:00:53.459Z",
diff --git a/packages/event-schemas/examples/TemplateDeleted/v1/email.json b/packages/event-schemas/examples/TemplateDeleted/v1/email.json
@@ -18,7 +18,7 @@
   "dataschemaversion": "1.0.0",
   "id": "12f1f09c-a555-4d9b-8405-0b33490bc929",
   "plane": "control",
-  "source": "//notify.nhs.uk/app/nhs-notify-template-management-prod/prod",
+  "source": "//notify.nhs.uk/app/nhs-notify-template-management-prod/main",
   "specversion": "1.0",
   "subject": "871b0f4e-0b32-474e-a49a-23fc554bc5a6",
   "time": "2025-07-29T11:13:45.563Z",
diff --git a/packages/event-schemas/examples/TemplateDeleted/v1/letter.json b/packages/event-schemas/examples/TemplateDeleted/v1/letter.json
@@ -31,7 +31,7 @@
   "dataschemaversion": "1.0.0",
   "id": "20f471d0-367d-4914-bee3-2fa5322d67f1",
   "plane": "control",
-  "source": "//notify.nhs.uk/app/nhs-notify-template-management-prod/prod",
+  "source": "//notify.nhs.uk/app/nhs-notify-template-management-prod/main",
   "specversion": "1.0",
   "subject": "91be480d-c667-4741-957a-057b64753762",
   "time": "2025-07-29T11:15:22.776Z",
diff --git a/packages/event-schemas/examples/TemplateDeleted/v1/nhsapp.json b/packages/event-schemas/examples/TemplateDeleted/v1/nhsapp.json
@@ -17,7 +17,7 @@
   "dataschemaversion": "1.0.0",
   "id": "c958dab9-1cb2-4fb8-9990-c48ba1dc5518",
   "plane": "control",
-  "source": "//notify.nhs.uk/app/nhs-notify-template-management-prod/prod",
+  "source": "//notify.nhs.uk/app/nhs-notify-template-management-prod/main",
   "specversion": "1.0",
   "subject": "3a58a370-75ab-4788-a75e-cd2572a68523",
   "time": "2025-07-29T11:16:24.519Z",
diff --git a/packages/event-schemas/examples/TemplateDeleted/v1/sms.json b/packages/event-schemas/examples/TemplateDeleted/v1/sms.json
@@ -17,7 +17,7 @@
   "dataschemaversion": "1.0.0",
   "id": "58d46ca9-dae4-4500-9b9a-9e6547289e69",
   "plane": "control",
-  "source": "//notify.nhs.uk/app/nhs-notify-template-management-prod/prod",
+  "source": "//notify.nhs.uk/app/nhs-notify-template-management-prod/main",
   "specversion": "1.0",
   "subject": "9779f827-0670-48b4-8e96-5cecf893468e",
   "time": "2025-07-29T11:17:41.773Z",
diff --git a/packages/event-schemas/examples/TemplateDrafted/v1/email.json b/packages/event-schemas/examples/TemplateDrafted/v1/email.json
@@ -18,7 +18,7 @@
   "dataschemaversion": "1.0.0",
   "id": "12f1f09c-a555-4d9b-8405-0b33490bc929",
   "plane": "control",
-  "source": "//notify.nhs.uk/app/nhs-notify-template-management-prod/prod",
+  "source": "//notify.nhs.uk/app/nhs-notify-template-management-prod/main",
   "specversion": "1.0",
   "subject": "871b0f4e-0b32-474e-a49a-23fc554bc5a6",
   "time": "2025-07-29T08:45:00.000Z",
diff --git a/packages/event-schemas/examples/TemplateDrafted/v1/letter.json b/packages/event-schemas/examples/TemplateDrafted/v1/letter.json
@@ -19,7 +19,7 @@
   "dataschemaversion": "1.0.0",
   "id": "20f471d0-367d-4914-bee3-2fa5322d67f1",
   "plane": "control",
-  "source": "//notify.nhs.uk/app/nhs-notify-template-management-prod/prod",
+  "source": "//notify.nhs.uk/app/nhs-notify-template-management-prod/main",
   "specversion": "1.0",
   "subject": "91be480d-c667-4741-957a-057b64753762",
   "time": "2025-07-29T10:11:13.881Z",
diff --git a/packages/event-schemas/examples/TemplateDrafted/v1/nhsapp.json b/packages/event-schemas/examples/TemplateDrafted/v1/nhsapp.json
@@ -17,7 +17,7 @@
   "dataschemaversion": "1.0.0",
   "id": "c958dab9-1cb2-4fb8-9990-c48ba1dc5518",
   "plane": "control",
-  "source": "//notify.nhs.uk/app/nhs-notify-template-management-prod/prod",
+  "source": "//notify.nhs.uk/app/nhs-notify-template-management-prod/main",
   "specversion": "1.0",
   "subject": "3a58a370-75ab-4788-a75e-cd2572a68523",
   "time": "2025-07-29T10:04:32.738Z",
diff --git a/packages/event-schemas/examples/TemplateDrafted/v1/sms.json b/packages/event-schemas/examples/TemplateDrafted/v1/sms.json
@@ -17,7 +17,7 @@
   "dataschemaversion": "1.0.0",
   "id": "58d46ca9-dae4-4500-9b9a-9e6547289e69",
   "plane": "control",
-  "source": "//notify.nhs.uk/app/nhs-notify-template-management-prod/prod",
+  "source": "//notify.nhs.uk/app/nhs-notify-template-management-prod/main",
   "specversion": "1.0",
   "subject": "9779f827-0670-48b4-8e96-5cecf893468e",
   "time": "2025-07-29T09:45:42.472Z",
diff --git a/packages/event-schemas/src/events/template-completed.ts b/packages/event-schemas/src/events/template-completed.ts
@@ -1,9 +1,9 @@
 import { z } from 'zod';
-import { $Template, $TemplateStatus } from '../template';
+import { $TemplateEventV1Data, $TemplateStatus } from '../template';
 import { $NHSNotifyEventEnvelope } from '../event-envelope';
 
 export const $TemplateCompletedEventV1Data = z.intersection(
-  $Template,
+  $TemplateEventV1Data,
   z.object({
     templateStatus: $TemplateStatus.extract(['SUBMITTED']),
   })
diff --git a/packages/event-schemas/src/events/template-deleted.ts b/packages/event-schemas/src/events/template-deleted.ts
@@ -1,9 +1,9 @@
 import { z } from 'zod';
-import { $Template, $TemplateStatus } from '../template';
+import { $TemplateEventV1Data, $TemplateStatus } from '../template';
 import { $NHSNotifyEventEnvelope } from '../event-envelope';
 
 export const $TemplateDeletedEventV1Data = z.intersection(
-  $Template,
+  $TemplateEventV1Data,
   z.object({
     templateStatus: $TemplateStatus.extract(['DELETED']),
   })
diff --git a/packages/event-schemas/src/events/template-drafted.ts b/packages/event-schemas/src/events/template-drafted.ts
@@ -1,9 +1,9 @@
 import { z } from 'zod';
-import { $Template, $TemplateStatus } from '../template';
+import { $TemplateEventV1Data, $TemplateStatus } from '../template';
 import { $NHSNotifyEventEnvelope } from '../event-envelope';
 
 export const $TemplateDraftedEventV1Data = z.intersection(
-  $Template,
+  $TemplateEventV1Data,
   z.object({
     templateStatus: $TemplateStatus.exclude(['SUBMITTED', 'DELETED']),
   })
diff --git a/packages/event-schemas/src/template.ts b/packages/event-schemas/src/template.ts
@@ -49,7 +49,7 @@ const letterTypes = ['q4', 'x0', 'x1'];
 
 export const $TemplateStatus = z.enum(templateStatuses);
 
-const $TemplateBase = z.object({
+const $TemplateEventV1BaseData = z.object({
   owner: z.string(),
   id: z.string(),
   clientId: z.string().optional(),
@@ -61,18 +61,18 @@ const $TemplateBase = z.object({
   updatedBy: z.string().optional(),
 });
 
-const $EmailTemplate = $TemplateBase.extend({
+const $EmailTemplateEventV1Data = $TemplateEventV1BaseData.extend({
   message: z.string(),
   subject: z.string(),
   templateType: z.literal('EMAIL'),
 });
 
-const $NhsAppTemplate = $TemplateBase.extend({
+const $NhsAppTemplateEventV1Data = $TemplateEventV1BaseData.extend({
   message: z.string(),
   templateType: z.literal('NHS_APP'),
 });
 
-const $LetterTemplate = $TemplateBase.extend({
+const $LetterTemplateEventV1Data = $TemplateEventV1BaseData.extend({
   files: z.object({
     proofs: z
       .record(
@@ -88,16 +88,14 @@ const $LetterTemplate = $TemplateBase.extend({
   letterType: z.enum(letterTypes),
 });
 
-const $SmsTemplate = $TemplateBase.extend({
+const $SmsTemplateEventV1Data = $TemplateEventV1BaseData.extend({
   message: z.string(),
   templateType: z.literal('SMS'),
 });
 
-export const $Template = z.discriminatedUnion('templateType', [
-  $EmailTemplate,
-  $NhsAppTemplate,
-  $LetterTemplate,
-  $SmsTemplate,
+export const $TemplateEventV1Data = z.discriminatedUnion('templateType', [
+  $EmailTemplateEventV1Data,
+  $NhsAppTemplateEventV1Data,
+  $LetterTemplateEventV1Data,
+  $SmsTemplateEventV1Data,
 ]);
-
-export type Template = z.infer<typeof $Template>;
