Skip to content

Commit d3c8e7e

Browse files
committed
rename to DatabaseTemplate
1 parent bbecabc commit d3c8e7e

File tree

8 files changed

+39
-39
lines changed

8 files changed

+39
-39
lines changed

infrastructure/terraform/modules/backend-api/module_lambda_send_letter_proof.tf

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ module "lambda_send_letter_proof" {
2121
INTERNAL_BUCKET_NAME = module.s3bucket_internal.id
2222
NODE_OPTIONS = "--enable-source-maps",
2323
REGION = var.region
24-
SEND_LOCK_TTL_MS = 50 * 1000
24+
SEND_LOCK_TTL_MS = 50 * 1000 # this must be less than the visibility timeout
2525
SFTP_ENVIRONMENT = local.sftp_environment
2626
TEMPLATES_TABLE_NAME = aws_dynamodb_table.templates.name
2727
}

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

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ import {
99
import { TemplateRepository } from '@backend-api/templates/infra';
1010
import { TemplateClient } from '@backend-api/templates/app/template-client';
1111
import { LetterUploadRepository } from '@backend-api/templates/infra/letter-upload-repository';
12-
import { MergedTemplate } from 'nhs-notify-web-template-management-utils';
12+
import { DatabaseTemplate } from 'nhs-notify-web-template-management-utils';
1313

1414
jest.mock('node:crypto');
1515
jest.mock('nhs-notify-web-template-management-utils/logger');
@@ -140,7 +140,7 @@ describe('templateClient', () => {
140140
templateStatus: 'NOT_YET_SUBMITTED',
141141
};
142142

143-
const template: MergedTemplate = {
143+
const template: DatabaseTemplate = {
144144
...expectedTemplateDto,
145145
owner,
146146
version: 1,
@@ -184,7 +184,7 @@ describe('templateClient', () => {
184184
templateStatus: 'NOT_YET_SUBMITTED',
185185
};
186186

187-
const template: MergedTemplate = {
187+
const template: DatabaseTemplate = {
188188
...expectedTemplateDto,
189189
owner,
190190
version: 1,
@@ -251,7 +251,7 @@ describe('templateClient', () => {
251251

252252
const creationTime = '2025-03-12T08:41:08.805Z';
253253

254-
const initialCreatedTemplate: MergedTemplate = {
254+
const initialCreatedTemplate: DatabaseTemplate = {
255255
...dataWithFiles,
256256
id: templateId,
257257
createdAt: creationTime,
@@ -263,7 +263,7 @@ describe('templateClient', () => {
263263

264264
const updateTime = '2025-03-12T08:41:33.666Z';
265265

266-
const finalTemplate: MergedTemplate = {
266+
const finalTemplate: DatabaseTemplate = {
267267
...initialCreatedTemplate,
268268
templateStatus: 'PENDING_VALIDATION',
269269
updatedAt: updateTime,
@@ -544,7 +544,7 @@ describe('templateClient', () => {
544544
});
545545

546546
mocks.templateRepository.create.mockResolvedValueOnce({
547-
data: {} as unknown as MergedTemplate,
547+
data: {} as unknown as DatabaseTemplate,
548548
});
549549

550550
const result = await templateClient.createLetterTemplate(
@@ -602,7 +602,7 @@ describe('templateClient', () => {
602602
templateStatus: 'PENDING_VALIDATION',
603603
};
604604

605-
const initialCreatedTemplate: MergedTemplate = {
605+
const initialCreatedTemplate: DatabaseTemplate = {
606606
...expectedTemplateDto,
607607
templateStatus: 'PENDING_UPLOAD',
608608
owner,
@@ -693,7 +693,7 @@ describe('templateClient', () => {
693693
templateStatus: 'PENDING_VALIDATION',
694694
};
695695

696-
const initialCreatedTemplate: MergedTemplate = {
696+
const initialCreatedTemplate: DatabaseTemplate = {
697697
...expectedTemplateDto,
698698
templateStatus: 'PENDING_UPLOAD',
699699
owner,
@@ -787,7 +787,7 @@ describe('templateClient', () => {
787787

788788
const creationTime = '2025-03-12T08:41:08.805Z';
789789

790-
const initialCreatedTemplate: MergedTemplate = {
790+
const initialCreatedTemplate: DatabaseTemplate = {
791791
...dataWithFiles,
792792
id: templateId,
793793
createdAt: creationTime,
@@ -799,7 +799,7 @@ describe('templateClient', () => {
799799

800800
const updateTime = '2025-03-12T08:41:33.666Z';
801801

802-
const finalTemplate: MergedTemplate = {
802+
const finalTemplate: DatabaseTemplate = {
803803
...initialCreatedTemplate,
804804
templateStatus: 'PENDING_VALIDATION',
805805
updatedAt: updateTime,
@@ -975,7 +975,7 @@ describe('templateClient', () => {
975975
templateStatus: 'NOT_YET_SUBMITTED',
976976
};
977977

978-
const template: MergedTemplate = {
978+
const template: DatabaseTemplate = {
979979
...expectedTemplateDto,
980980
owner,
981981
version: 1,
@@ -1087,7 +1087,7 @@ describe('templateClient', () => {
10871087
templateStatus: 'NOT_YET_SUBMITTED',
10881088
};
10891089

1090-
const template: MergedTemplate = {
1090+
const template: DatabaseTemplate = {
10911091
...templateDTO,
10921092
owner,
10931093
version: 1,
@@ -1357,7 +1357,7 @@ describe('templateClient', () => {
13571357
templateType: 'SMS',
13581358
};
13591359

1360-
const template: MergedTemplate = {
1360+
const template: DatabaseTemplate = {
13611361
...expectedTemplateDto,
13621362
owner,
13631363
version: 1,

lambdas/backend-api/src/__tests__/templates/infra/template-repository.test.ts

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ import {
1919
import { logger } from 'nhs-notify-web-template-management-utils/logger';
2020
import { TemplateRepository } from '../../../templates/infra';
2121
import { marshall } from '@aws-sdk/util-dynamodb';
22-
import { MergedTemplate } from 'nhs-notify-web-template-management-utils';
22+
import { DatabaseTemplate } from 'nhs-notify-web-template-management-utils';
2323

2424
jest.mock('nhs-notify-web-template-management-utils/logger');
2525
jest.mock('node:crypto');
@@ -80,25 +80,25 @@ const databaseTemplateProperties = {
8080
updatedAt: '2024-12-27T00:00:00.000Z',
8181
};
8282

83-
const emailTemplate: MergedTemplate = {
83+
const emailTemplate: DatabaseTemplate = {
8484
templateType: 'EMAIL',
8585
...emailProperties,
8686
...databaseTemplateProperties,
8787
};
8888

89-
const smsTemplate: MergedTemplate = {
89+
const smsTemplate: DatabaseTemplate = {
9090
templateType: 'SMS',
9191
...smsProperties,
9292
...databaseTemplateProperties,
9393
};
9494

95-
const nhsAppTemplate: MergedTemplate = {
95+
const nhsAppTemplate: DatabaseTemplate = {
9696
templateType: 'NHS_APP',
9797
...nhsAppProperties,
9898
...databaseTemplateProperties,
9999
};
100100

101-
const letterTemplate: MergedTemplate = {
101+
const letterTemplate: DatabaseTemplate = {
102102
templateType: 'LETTER',
103103
...letterProperties,
104104
...databaseTemplateProperties,
@@ -570,7 +570,7 @@ describe('templateRepository', () => {
570570
const id = 'abc-def-ghi-jkl-123';
571571
const owner = 'real-owner';
572572

573-
const databaseTemplate: MergedTemplate = {
573+
const databaseTemplate: DatabaseTemplate = {
574574
id,
575575
owner,
576576
version: 1,
@@ -681,7 +681,7 @@ describe('templateRepository', () => {
681681
const id = 'abc-def-ghi-jkl-123';
682682
const owner = 'real-owner';
683683

684-
const databaseTemplate: MergedTemplate = {
684+
const databaseTemplate: DatabaseTemplate = {
685685
id,
686686
owner,
687687
version: 1,
@@ -798,7 +798,7 @@ describe('templateRepository', () => {
798798
const id = 'abc-def-ghi-jkl-123';
799799
const owner = 'real-owner';
800800

801-
const databaseTemplate: MergedTemplate = {
801+
const databaseTemplate: DatabaseTemplate = {
802802
id,
803803
owner,
804804
version: 1,

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ import { TemplateRepository } from '@backend-api/templates/infra';
1515
import { LETTER_MULTIPART } from 'nhs-notify-backend-client/src/schemas/constants';
1616
import {
1717
$CreateUpdateLetterTemplate,
18-
MergedTemplate,
18+
DatabaseTemplate,
1919
} from 'nhs-notify-web-template-management-utils';
2020
import { logger } from 'nhs-notify-web-template-management-utils/logger';
2121
import { LetterUploadRepository } from '../infra/letter-upload-repository';
@@ -344,7 +344,7 @@ export class TemplateClient implements ITemplateClient {
344344
}
345345

346346
private mapDatabaseObjectToDTO(
347-
databaseTemplate: MergedTemplate
347+
databaseTemplate: DatabaseTemplate
348348
): TemplateDto | undefined {
349349
const { owner: _1, version: _2, ...templateDTO } = databaseTemplate;
350350

lambdas/backend-api/src/templates/infra/template-repository.ts

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ import {
2424
} from '@aws-sdk/lib-dynamodb';
2525
import { ApplicationResult, failure, success, calculateTTL } from '../../utils';
2626
import { logger } from 'nhs-notify-web-template-management-utils/logger';
27-
import { MergedTemplate } from 'nhs-notify-web-template-management-utils';
27+
import { DatabaseTemplate } from 'nhs-notify-web-template-management-utils';
2828

2929
type WithAttachments<T> = T extends { templateType: 'LETTER' }
3030
? T & { files: LetterFiles }
@@ -58,7 +58,7 @@ export class TemplateRepository {
5858
async get(
5959
templateId: string,
6060
owner: string
61-
): Promise<ApplicationResult<MergedTemplate>> {
61+
): Promise<ApplicationResult<DatabaseTemplate>> {
6262
try {
6363
const response = await this.client.send(
6464
new GetCommand({
@@ -71,7 +71,7 @@ export class TemplateRepository {
7171
return failure(ErrorCase.TEMPLATE_NOT_FOUND, 'Template not found');
7272
}
7373

74-
const item = response.Item as MergedTemplate;
74+
const item = response.Item as DatabaseTemplate;
7575

7676
if (item.templateStatus === 'DELETED') {
7777
return failure(ErrorCase.TEMPLATE_NOT_FOUND, 'Template not found');
@@ -87,9 +87,9 @@ export class TemplateRepository {
8787
template: WithAttachments<ValidatedCreateUpdateTemplate>,
8888
owner: string,
8989
initialStatus: TemplateStatus = 'NOT_YET_SUBMITTED'
90-
): Promise<ApplicationResult<MergedTemplate>> {
90+
): Promise<ApplicationResult<DatabaseTemplate>> {
9191
const date = new Date().toISOString();
92-
const entity: MergedTemplate = {
92+
const entity: DatabaseTemplate = {
9393
...template,
9494
id: randomUUID(),
9595
owner,
@@ -115,7 +115,7 @@ export class TemplateRepository {
115115
template: ValidatedCreateUpdateTemplate,
116116
owner: string,
117117
expectedStatus: TemplateStatus
118-
): Promise<ApplicationResult<MergedTemplate>> {
118+
): Promise<ApplicationResult<DatabaseTemplate>> {
119119
const updateExpression = [
120120
'#name = :name',
121121
...this.getChannelAttributeExpressions(template),
@@ -241,7 +241,7 @@ export class TemplateRepository {
241241
templateId: string,
242242
status: Exclude<TemplateStatus, 'SUBMITTED' | 'DELETED'>,
243243
owner: string
244-
): Promise<ApplicationResult<MergedTemplate>> {
244+
): Promise<ApplicationResult<DatabaseTemplate>> {
245245
const updateExpression = ['#templateStatus = :newStatus'];
246246

247247
const expressionAttributeValues: Record<string, string | number> = {
@@ -262,7 +262,7 @@ export class TemplateRepository {
262262
}
263263
}
264264

265-
async list(owner: string): Promise<ApplicationResult<MergedTemplate[]>> {
265+
async list(owner: string): Promise<ApplicationResult<DatabaseTemplate[]>> {
266266
try {
267267
const input: QueryCommandInput = {
268268
TableName: this.templatesTableName,
@@ -278,7 +278,7 @@ export class TemplateRepository {
278278
FilterExpression: '#status <> :deletedStatus',
279279
};
280280

281-
const items: MergedTemplate[] = [];
281+
const items: DatabaseTemplate[] = [];
282282

283283
do {
284284
// eslint-disable-next-line no-await-in-loop
@@ -288,7 +288,7 @@ export class TemplateRepository {
288288

289289
input.ExclusiveStartKey = LastEvaluatedKey;
290290

291-
items.push(...(Items as MergedTemplate[]));
291+
items.push(...(Items as DatabaseTemplate[]));
292292
} while (input.ExclusiveStartKey);
293293

294294
return success(items);
@@ -395,7 +395,7 @@ export class TemplateRepository {
395395
try {
396396
const response = await this.client.send(new UpdateCommand(input));
397397

398-
return success(response.Attributes as MergedTemplate);
398+
return success(response.Attributes as DatabaseTemplate);
399399
} catch (error) {
400400
if (error instanceof ConditionalCheckFailedException) {
401401
if (!error.Item || error.Item.templateStatus.S === 'DELETED') {
31.6 MB
Binary file not shown.

utils/entity-update-command-builder/src/template-update-builder.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
import type { TemplateStatus } from 'nhs-notify-backend-client';
22
import { BuilderOptionalArgs } from './types/builders';
3-
import { MergedTemplate } from 'nhs-notify-web-template-management-utils';
3+
import { DatabaseTemplate } from 'nhs-notify-web-template-management-utils';
44
import { UpdateCommandBuilder } from './common/update-command-builder';
55

6-
export class TemplateUpdateBuilder extends UpdateCommandBuilder<MergedTemplate> {
6+
export class TemplateUpdateBuilder extends UpdateCommandBuilder<DatabaseTemplate> {
77
constructor(
88
tableName: string,
99
owner: string,

utils/utils/src/types.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -112,7 +112,7 @@ export type GuardDutyMalwareScanStatusPassed = Extract<
112112
'NO_THREATS_FOUND'
113113
>;
114114

115-
export type MergedTemplate = {
115+
export type DatabaseTemplate = {
116116
createdAt: string;
117117
files?: LetterFiles;
118118
id: string;
@@ -133,7 +133,7 @@ type DbOnlyTemplateProperties = {
133133
};
134134

135135
type AssertExtendsMerged<
136-
T extends Omit<MergedTemplate, keyof DbOnlyTemplateProperties>,
136+
T extends Omit<DatabaseTemplate, keyof DbOnlyTemplateProperties>,
137137
> = T;
138138

139139
// assigned only for the purpose of the assertion

0 commit comments

Comments
 (0)