Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

refactor(email): update email template routes and file paths #1334

Open
wants to merge 2 commits into
base: dev
Choose a base branch
from
Open

refactor(email): update email template routes and file paths #1334

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ddfcb07
refactor(email): update email template routes and file paths
Jayflashy Mar 1, 2025
fca27f3
Merge branch 'dev' into fix/refactor-email-templates-endpoint
Jayflashy Mar 1, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 10 additions & 10 deletions src/modules/email/email.controller.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { Controller, Post, Get, Body, Res, Patch, Param, UseGuards } from '@nestjs/common';
import { Controller, Post, Get, Body, Res, Patch, Param, UseGuards, Delete } from '@nestjs/common';
import { Response } from 'express';
import { EmailService } from './email.service';
import { UpdateTemplateDto, createTemplateDto, getTemplateDto } from './dto/email.dto';
Expand All @@ -21,7 +21,7 @@ export class EmailController {
@ApiOperation({ summary: 'Store a new email template' })
@ApiResponse({ status: 201, description: 'Template created successfully', type: CreateTemplateResponseDto })
@ApiResponse({ status: 400, description: 'Invalid HTML format', type: ErrorResponseDto })
@Post('store-template')
@Post('templates')
async storeTemplate(@Body() body: createTemplateDto, @Res() res: Response): Promise<any> {
const response = await this.emailService.createTemplate(body);
res.status(response.status_code).send(response);
Expand All @@ -32,7 +32,7 @@ export class EmailController {
@ApiResponse({ status: 400, description: 'Invalid HTML format', type: ErrorResponseDto })
@ApiResponse({ status: 404, description: 'Template not found', type: ErrorResponseDto })
@ApiParam({ name: 'templateName', required: true, description: 'The name of the template to update' })
@Patch('update-template/:templateName')
@Patch('templates/:templateName')
async updateTemplate(
@Param('templateName') name: string,
@Body() body: UpdateTemplateDto,
Expand All @@ -46,24 +46,24 @@ export class EmailController {
@ApiResponse({ status: 200, description: 'Template retrieved successfully', type: GetTemplateResponseDto })
@ApiResponse({ status: 404, description: 'Template not found', type: ErrorResponseDto })
@UseGuards(SuperAdminGuard)
@Post('get-template')
async getTemplate(@Body() body: getTemplateDto, @Res() res: Response): Promise<any> {
const response = await this.emailService.getTemplate(body);
@Get('templates/:templateName')
async getTemplate(@Param('templateName') name: string, @Res() res: Response): Promise<any> {
const response = await this.emailService.getTemplate({ templateName: name });
res.status(response.status_code).send(response);
}

@ApiOperation({ summary: 'Delete an email template' })
@ApiResponse({ status: 200, description: 'Template deleted successfully', type: DeleteTemplateResponseDto })
@ApiResponse({ status: 404, description: 'Template not found', type: ErrorResponseDto })
@Post('delete-template')
async deleteTemplate(@Body() body: getTemplateDto, @Res() res: Response): Promise<any> {
const response = await this.emailService.deleteTemplate(body);
@Delete('templates/:templateName')
async deleteTemplate(@Param('templateName') name: string, @Res() res: Response): Promise<any> {
const response = await this.emailService.deleteTemplate({ templateName: name });
res.status(response.status_code).send(response);
}

@ApiOperation({ summary: 'Retrieve all email templates' })
@ApiResponse({ status: 200, description: 'Templates retrieved successfully', type: GetAllTemplatesResponseDto })
@Get('get-all-templates')
@Get('templates')
async getAllTemplates(@Res() res: Response): Promise<any> {
const response = await this.emailService.getAllTemplates();
res.status(response.status_code).send(response);
Expand Down
4 changes: 2 additions & 2 deletions src/modules/email/email.service.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -175,7 +175,7 @@ describe('EmailService', () => {

expect(htmlValidator).toHaveBeenCalledWith({ data: compiledTemplate });
expect(fsWriteFileMock).toHaveBeenCalledWith(
`./src/modules/email/templates/${templateName}.hbs`,
`./src/modules/email/hng-templates/${templateName}.hbs`,
compiledTemplate,
'utf-8'
);
Expand Down Expand Up @@ -255,7 +255,7 @@ describe('EmailService', () => {
const result = await service.deleteTemplate(templateInfo);

expect(result).toEqual({
status_code: HttpStatus.OK,
status_code: HttpStatus.NO_CONTENT,
message: 'Template deleted successfully',
});
});
Expand Down
4 changes: 2 additions & 2 deletions src/modules/email/email.service.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -172,7 +172,7 @@ export class EmailService {
);
}

const templatePath = `./src/modules/email/templates/${templateName}.hbs`;
const templatePath = `./src/modules/email/hng-templates/${templateName}.hbs`;

if (!fs.existsSync(templatePath)) {
throw new CustomHttpException(SYS_MSG.EMAIL_TEMPLATES.TEMPLATE_NOT_FOUND, HttpStatus.NOT_FOUND);
Expand Down Expand Up @@ -211,7 +211,7 @@ export class EmailService {
try {
await deleteFile(`./src/modules/email/hng-templates/${templateInfo.templateName}.hbs`);
return {
status_code: HttpStatus.OK,
status_code: HttpStatus.NO_CONTENT,
message: 'Template deleted successfully',
};
} catch (error) {
Expand Down