CCM-8585: make files required in DTO

Author: alexnuttall

infrastructure/terraform/modules/backend-api/spec.tmpl.json

@@ -508,7 +508,7 @@
           }
         }
       },
-      "LetterProperties": {
+      "CreateLetterProperties": {
         "type": "object",
         "required": [
           "letterType",
@@ -520,12 +520,27 @@
           },
           "language": {
             "$ref": "#/components/schemas/Language"
-          },
-          "files": {
-            "$ref": "#/components/schemas/LetterFiles"
           }
         }
       },
+      "LetterProperties": {
+        "allOf": [
+          {
+            "$ref": "#/components/schemas/CreateLetterProperties"
+          },
+          {
+            "type": "object",
+            "required": [
+              "files"
+            ],
+            "properties": {
+              "files": {
+                "$ref": "#/components/schemas/LetterFiles"
+              }
+            }
+          }
+        ]
+      },
       "BaseTemplate": {
         "type": "object",
         "required": [
@@ -559,7 +574,7 @@
                 "$ref": "#/components/schemas/SmsProperties"
               },
               {
-                "$ref": "#/components/schemas/LetterProperties"
+                "$ref": "#/components/schemas/CreateLetterProperties"
               }
             ]
           }
@@ -594,7 +609,7 @@
                 "$ref": "#/components/schemas/SmsProperties"
               },
               {
-                "$ref": "#/components/schemas/LetterProperties"
+                "$ref": "#/components/schemas/CreateLetterProperties"
               }
             ]
           }

lambdas/backend-api/src/__tests__/templates/app/template-client.test.ts

@@ -3,6 +3,7 @@ import {
   LetterFiles,
   TemplateDto,
   UpdateTemplate,
+  ValidatedCreateTemplate,
 } from 'nhs-notify-backend-client';
 import {
   DatabaseTemplate,
@@ -237,7 +238,7 @@ describe('templateClient', () => {
         },
       };
 
-      const dataWithFiles: CreateTemplate = {
+      const dataWithFiles: ValidatedCreateTemplate = {
         templateType: 'LETTER',
         name: 'name',
         language: 'en',
@@ -490,7 +491,7 @@ describe('templateClient', () => {
         },
       };
 
-      const dataWithFiles: CreateTemplate = {
+      const dataWithFiles: ValidatedCreateTemplate = {
         templateType: 'LETTER',
         name: 'name',
         language: 'en',
@@ -589,7 +590,7 @@ describe('templateClient', () => {
         },
       };
 
-      const dataWithFiles: CreateTemplate = {
+      const dataWithFiles: ValidatedCreateTemplate = {
         templateType: 'LETTER',
         name: 'name',
         language: 'en',
@@ -682,7 +683,7 @@ describe('templateClient', () => {
         },
       };
 
-      const dataWithFiles: CreateTemplate = {
+      const dataWithFiles: ValidatedCreateTemplate = {
         templateType: 'LETTER',
         name: 'name',
         language: 'en',

lambdas/backend-client/src/schemas/template-schema.ts

@@ -1,6 +1,7 @@
 import { z } from 'zod';
 import {
   BaseTemplate,
+  CreateLetterProperties,
   CreateTemplate,
   EmailProperties,
   FileDetails,
@@ -102,14 +103,17 @@ const $SmsProperties = schemaFor<SmsProperties>()(
   })
 );
 
-const $LetterProperties = schemaFor<LetterProperties>()(
+const $CreateLetterProperties = schemaFor<CreateLetterProperties>()(
   z.object({
     letterType: z.enum(LETTER_TYPE_LIST),
     language: z.enum(LANGUAGE_LIST),
-    files: $LetterFiles.optional(),
   })
 );
 
+const $LetterProperties = schemaFor<LetterProperties>()(
+  $CreateLetterProperties.extend({ files: $LetterFiles })
+);
+
 export const $BaseTemplateSchema = schemaFor<BaseTemplate>()(
   z.object({
     name: z.string().trim().min(1),

lambdas/backend-client/src/types/generated/types.gen.ts

@@ -69,10 +69,13 @@ export type SmsProperties = {
   message: string;
 };
 
-export type LetterProperties = {
+export type CreateLetterProperties = {
   letterType: LetterType;
   language: Language;
-  files?: LetterFiles;
+};
+
+export type LetterProperties = CreateLetterProperties & {
+  files: LetterFiles;
 };
 
 export type BaseTemplate = {
@@ -81,11 +84,16 @@ export type BaseTemplate = {
 };
 
 export type CreateTemplate = BaseTemplate &
-  (NhsAppProperties | EmailProperties | SmsProperties | LetterProperties);
+  (NhsAppProperties | EmailProperties | SmsProperties | CreateLetterProperties);
 
 export type UpdateTemplate = BaseTemplate & {
   templateStatus: TemplateStatus;
-} & (NhsAppProperties | EmailProperties | SmsProperties | LetterProperties);
+} & (
+    | NhsAppProperties
+    | EmailProperties
+    | SmsProperties
+    | CreateLetterProperties
+  );
 
 export type TemplateDto = BaseTemplate & {
   id: string;