Skip to content

Commit d895675

Browse files
ClareJonesBJSSClareJonesBJSS
committed
CCM-11445: Change 'create letter' to 'upload letter' across the board
1 parent bf4d4b5 commit d895675

File tree

58 files changed

+225
-223
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

58 files changed

+225
-223
lines changed

‎.eslintrc.json‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,8 @@
7373
}
7474
],
7575
"no-empty-function": "off",
76-
"unicorn/prefer-module": "off"
76+
"unicorn/prefer-module": "off",
77+
"sonarjs/todo-tag": "off"
7778
},
7879
"overrides": [
7980
{

‎frontend/src/__tests__/app/upload-letter-template/__snapshots__/page.test.tsx.snap‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
// Jest Snapshot v1, https://goo.gl/fbAQLP
22

3-
exports[`CreateLetterTemplatePage should render CreateLetterTemplatePage 1`] = `
3+
exports[`UploadLetterTemplatePage should render UploadLetterTemplatePage 1`] = `
44
<LetterTemplateForm
55
initialState={
66
{

‎frontend/src/__tests__/app/upload-letter-template/page.test.tsx‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
/**
22
* @jest-environment node
33
*/
4-
import CreateLetterTemplatePage, {
4+
import UploadLetterTemplatePage, {
55
generateMetadata,
66
} from '@app/upload-letter-template/page';
77
import content from '@content/content';
@@ -18,12 +18,12 @@ jest.mock('@utils/server-features');
1818
const mockGetSessionServer = jest.mocked(getSessionServer);
1919
const mockFetchClient = jest.mocked(fetchClient);
2020

21-
describe('CreateLetterTemplatePage', () => {
21+
describe('UploadLetterTemplatePage', () => {
2222
beforeEach(() => {
2323
jest.resetAllMocks();
2424
});
2525

26-
it('should render CreateLetterTemplatePage', async () => {
26+
it('should render UploadLetterTemplatePage', async () => {
2727
mockGetSessionServer.mockResolvedValueOnce({
2828
accessToken: 'mocktoken',
2929
clientId: 'client1',
@@ -35,7 +35,7 @@ describe('CreateLetterTemplatePage', () => {
3535
},
3636
});
3737

38-
const page = await CreateLetterTemplatePage();
38+
const page = await UploadLetterTemplatePage();
3939

4040
expect(await generateMetadata()).toEqual({ title: pageTitle });
4141
expect(page).toMatchSnapshot();
@@ -53,7 +53,7 @@ describe('CreateLetterTemplatePage', () => {
5353
},
5454
});
5555

56-
await CreateLetterTemplatePage();
56+
await UploadLetterTemplatePage();
5757

5858
expect(mockGetSessionServer).toHaveBeenCalled();
5959
expect(mockFetchClient).toHaveBeenCalled();
@@ -73,7 +73,7 @@ describe('CreateLetterTemplatePage', () => {
7373
},
7474
});
7575

76-
await CreateLetterTemplatePage();
76+
await UploadLetterTemplatePage();
7777

7878
expect(mockRedirect).toHaveBeenCalledWith(
7979
'/upload-letter-template/client-id-and-campaign-id-required',
@@ -95,7 +95,7 @@ describe('CreateLetterTemplatePage', () => {
9595
},
9696
});
9797

98-
await CreateLetterTemplatePage();
98+
await UploadLetterTemplatePage();
9999

100100
expect(mockRedirect).toHaveBeenCalledWith(
101101
'/upload-letter-template/client-id-and-campaign-id-required',

‎frontend/src/__tests__/components/forms/LetterTemplateForm.test.tsx/server-action.test.ts‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,24 @@
11
import { getMockFormData } from '@testhelpers';
2-
import { createLetterTemplate } from '@utils/form-actions';
2+
import { uploadLetterTemplate } from '@utils/form-actions';
33
import { redirect } from 'next/navigation';
44
import { processFormActions } from '@forms/LetterTemplateForm/server-action';
5-
import { CreateLetterTemplate } from 'nhs-notify-web-template-management-utils';
5+
import { UploadLetterTemplate } from 'nhs-notify-web-template-management-utils';
66

77
jest.mock('@utils/amplify-utils');
88
jest.mock('@utils/form-actions');
99
jest.mock('next/navigation');
1010

11-
const createLetterTemplateMock = jest.mocked(createLetterTemplate);
11+
const uploadLetterTemplateMock = jest.mocked(uploadLetterTemplate);
1212
const redirectMock = jest.mocked(redirect);
1313

14-
const initialState: CreateLetterTemplate = {
14+
const initialState: UploadLetterTemplate = {
1515
templateType: 'LETTER',
1616
name: 'name',
1717
letterType: 'x0',
1818
language: 'en',
1919
};
2020

21-
describe('CreateLetterTemplate server actions', () => {
21+
describe('UploadLetterTemplate server actions', () => {
2222
beforeEach(jest.resetAllMocks);
2323

2424
it('upload-letter-template - should return response when no template name, letter type, language or pdf file', async () => {
@@ -43,7 +43,7 @@ describe('CreateLetterTemplate server actions', () => {
4343
});
4444

4545
test('should create the template and redirect', async () => {
46-
createLetterTemplateMock.mockResolvedValue({
46+
uploadLetterTemplateMock.mockResolvedValue({
4747
...initialState,
4848
id: 'new-template-id',
4949
templateStatus: 'NOT_YET_SUBMITTED',
@@ -84,7 +84,7 @@ describe('CreateLetterTemplate server actions', () => {
8484
})
8585
);
8686

87-
expect(createLetterTemplateMock).toHaveBeenCalledWith(
87+
expect(uploadLetterTemplateMock).toHaveBeenCalledWith(
8888
{
8989
...initialState,
9090
name: 'template-name',
@@ -102,7 +102,7 @@ describe('CreateLetterTemplate server actions', () => {
102102
});
103103

104104
test('should throw error on editing existing template', async () => {
105-
createLetterTemplateMock.mockResolvedValue({
105+
uploadLetterTemplateMock.mockResolvedValue({
106106
...initialState,
107107
id: 'new-template-id',
108108
templateStatus: 'NOT_YET_SUBMITTED',

‎frontend/src/__tests__/utils/form-actions.test.ts‎

Lines changed: 25 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
* @jest-environment node
33
*/
44
import {
5-
CreateLetterTemplate,
5+
UploadLetterTemplate,
66
CreateUpdateNHSAppTemplate,
77
NHSAppTemplate,
88
} from 'nhs-notify-web-template-management-utils';
@@ -11,7 +11,7 @@ import {
1111
saveTemplate,
1212
getTemplate,
1313
getTemplates,
14-
createLetterTemplate,
14+
uploadLetterTemplate,
1515
setTemplateToDeleted,
1616
setTemplateToSubmitted,
1717
requestTemplateProof,
@@ -110,7 +110,7 @@ describe('form-actions', () => {
110110
);
111111
});
112112

113-
test('createLetterTemplate', async () => {
113+
test('uploadLetterTemplate', async () => {
114114
const responseData = {
115115
templateType: 'LETTER',
116116
id: 'new-template-id',
@@ -134,11 +134,11 @@ describe('form-actions', () => {
134134
updatedAt: '2025-01-13T10:19:25.579Z',
135135
} satisfies TemplateDto;
136136

137-
mockedTemplateClient.createLetterTemplate.mockResolvedValueOnce({
137+
mockedTemplateClient.uploadLetterTemplate.mockResolvedValueOnce({
138138
data: responseData,
139139
});
140140

141-
const createLetterTemplateInput: CreateLetterTemplate = {
141+
const uploadLetterTemplateInput: UploadLetterTemplate = {
142142
templateType: 'LETTER',
143143
name: 'name',
144144
letterType: 'x0',
@@ -152,14 +152,14 @@ describe('form-actions', () => {
152152
type: 'text/csv',
153153
});
154154

155-
const response = await createLetterTemplate(
156-
createLetterTemplateInput,
155+
const response = await uploadLetterTemplate(
156+
uploadLetterTemplateInput,
157157
pdf,
158158
csv
159159
);
160160

161-
expect(mockedTemplateClient.createLetterTemplate).toHaveBeenCalledWith(
162-
createLetterTemplateInput,
161+
expect(mockedTemplateClient.uploadLetterTemplate).toHaveBeenCalledWith(
162+
uploadLetterTemplateInput,
163163
'token',
164164
pdf,
165165
csv
@@ -168,7 +168,7 @@ describe('form-actions', () => {
168168
expect(response).toEqual(responseData);
169169
});
170170

171-
test('createLetterTemplate accepts empty csv', async () => {
171+
test('uploadLetterTemplate accepts empty csv', async () => {
172172
const responseData = {
173173
templateType: 'LETTER',
174174
id: 'new-template-id',
@@ -187,11 +187,11 @@ describe('form-actions', () => {
187187
updatedAt: '2025-01-13T10:19:25.579Z',
188188
} satisfies TemplateDto;
189189

190-
mockedTemplateClient.createLetterTemplate.mockResolvedValueOnce({
190+
mockedTemplateClient.uploadLetterTemplate.mockResolvedValueOnce({
191191
data: responseData,
192192
});
193193

194-
const createLetterTemplateInput: CreateLetterTemplate = {
194+
const uploadLetterTemplateInput: UploadLetterTemplate = {
195195
templateType: 'LETTER',
196196
name: 'name',
197197
letterType: 'x0',
@@ -205,14 +205,14 @@ describe('form-actions', () => {
205205
type: 'text/csv',
206206
});
207207

208-
const response = await createLetterTemplate(
209-
createLetterTemplateInput,
208+
const response = await uploadLetterTemplate(
209+
uploadLetterTemplateInput,
210210
pdf,
211211
csv
212212
);
213213

214-
expect(mockedTemplateClient.createLetterTemplate).toHaveBeenCalledWith(
215-
createLetterTemplateInput,
214+
expect(mockedTemplateClient.uploadLetterTemplate).toHaveBeenCalledWith(
215+
uploadLetterTemplateInput,
216216
'token',
217217
pdf,
218218
undefined
@@ -221,8 +221,8 @@ describe('form-actions', () => {
221221
expect(response).toEqual(responseData);
222222
});
223223

224-
test('createLetterTemplate - should throw error when saving unexpectedly fails', async () => {
225-
mockedTemplateClient.createLetterTemplate.mockResolvedValueOnce({
224+
test('uploadLetterTemplate - should throw error when saving unexpectedly fails', async () => {
225+
mockedTemplateClient.uploadLetterTemplate.mockResolvedValueOnce({
226226
error: {
227227
errorMeta: {
228228
code: 400,
@@ -231,7 +231,7 @@ describe('form-actions', () => {
231231
},
232232
});
233233

234-
const createLetterTemplateInput: CreateLetterTemplate = {
234+
const uploadLetterTemplateInput: UploadLetterTemplate = {
235235
templateType: 'LETTER',
236236
name: 'name',
237237
letterType: 'x0',
@@ -246,25 +246,25 @@ describe('form-actions', () => {
246246
});
247247

248248
await expect(
249-
createLetterTemplate(createLetterTemplateInput, pdf, csv)
249+
uploadLetterTemplate(uploadLetterTemplateInput, pdf, csv)
250250
).rejects.toThrow('Failed to create new letter template');
251251

252-
expect(mockedTemplateClient.createLetterTemplate).toHaveBeenCalledWith(
253-
createLetterTemplateInput,
252+
expect(mockedTemplateClient.uploadLetterTemplate).toHaveBeenCalledWith(
253+
uploadLetterTemplateInput,
254254
'token',
255255
pdf,
256256
csv
257257
);
258258
});
259259

260-
test('createLetterTemplate - should throw error when no token', async () => {
260+
test('uploadLetterTemplate - should throw error when no token', async () => {
261261
authIdTokenServerMock.mockReset();
262262
authIdTokenServerMock.mockResolvedValueOnce({
263263
accessToken: undefined,
264264
clientId: undefined,
265265
});
266266

267-
const createLetterTemplateInput: CreateLetterTemplate = {
267+
const uploadLetterTemplateInput: UploadLetterTemplate = {
268268
templateType: 'LETTER',
269269
name: 'name',
270270
letterType: 'x0',
@@ -279,7 +279,7 @@ describe('form-actions', () => {
279279
});
280280

281281
await expect(
282-
createLetterTemplate(createLetterTemplateInput, pdf, csv)
282+
uploadLetterTemplate(uploadLetterTemplateInput, pdf, csv)
283283
).rejects.toThrow('Failed to get access token');
284284
});
285285

‎frontend/src/app/upload-letter-template/page.tsx‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
import { Metadata } from 'next';
2-
import { CreateLetterTemplate } from 'nhs-notify-web-template-management-utils';
2+
import { UploadLetterTemplate } from 'nhs-notify-web-template-management-utils';
33
import { LetterTemplateForm } from '@forms/LetterTemplateForm/LetterTemplateForm';
44
import { getSessionServer } from '@utils/amplify-utils';
55
import { redirect, RedirectType } from 'next/navigation';
@@ -14,8 +14,8 @@ export async function generateMetadata(): Promise<Metadata> {
1414
};
1515
}
1616

17-
const CreateLetterTemplatePage = async () => {
18-
const initialState: CreateLetterTemplate = {
17+
const UploadLetterTemplatePage = async () => {
18+
const initialState: UploadLetterTemplate = {
1919
templateType: 'LETTER',
2020
name: '',
2121
letterType: 'x0',
@@ -46,4 +46,4 @@ const CreateLetterTemplatePage = async () => {
4646
return <LetterTemplateForm initialState={initialState} />;
4747
};
4848

49-
export default CreateLetterTemplatePage;
49+
export default UploadLetterTemplatePage;

‎frontend/src/components/forms/LetterTemplateForm/LetterTemplateForm.tsx‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ import { TemplateNameGuidance } from '@molecules/TemplateNameGuidance';
1717
import {
1818
alphabeticalLanguageList,
1919
alphabeticalLetterTypeList,
20-
CreateLetterTemplate,
20+
UploadLetterTemplate,
2121
FormErrorState,
2222
isRightToLeft,
2323
PageComponentProps,
@@ -27,13 +27,13 @@ import { useTextInput } from '@hooks/use-text-input.hook';
2727
import { NHSNotifyMain } from '@atoms/NHSNotifyMain/NHSNotifyMain';
2828
import { NHSNotifyButton } from '@atoms/NHSNotifyButton/NHSNotifyButton';
2929
import FileUpload from '@atoms/FileUpload/FileUpload';
30-
import { $CreateLetterTemplateForm } from './form-schema';
30+
import { $UploadLetterTemplateForm } from './form-schema';
3131
import { validate } from '@utils/client-validate-form';
3232
import { Language } from 'nhs-notify-backend-client';
3333
import Link from 'next/link';
3434

3535
export const LetterTemplateForm: FC<
36-
PageComponentProps<CreateLetterTemplate>
36+
PageComponentProps<UploadLetterTemplate>
3737
> = ({ initialState }) => {
3838
const {
3939
backLinkText,
@@ -88,7 +88,7 @@ export const LetterTemplateForm: FC<
8888
const templateCsvError =
8989
validationError?.fieldErrors.letterTemplateCsv?.join(', ');
9090

91-
const validateForm = validate($CreateLetterTemplateForm, setValidationError);
91+
const validateForm = validate($UploadLetterTemplateForm, setValidationError);
9292

9393
const formGroupClasses = [
9494
'nhsuk-u-margin-bottom-6',

‎frontend/src/components/forms/LetterTemplateForm/form-schema.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ const {
88
},
99
} = content;
1010

11-
export const $CreateLetterTemplateForm = z.object({
11+
export const $UploadLetterTemplateForm = z.object({
1212
letterTemplateName: z
1313
.string({ message: form.letterTemplateName.error.empty })
1414
.min(1, { message: form.letterTemplateName.error.empty }),

0 commit comments

Comments
 (0)