feat(reports): add pdf report export#200
Open
Nekolandd wants to merge 1 commit into
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Adds PDF export for security findings reports at
src/modules/reports/pdf/, allowing stakeholders to download executive security summaries as PDF files.Implements a new
ReportsModulewith a download endpoint that reuses existingReportingServicedata and renders it through a dedicated PDF template usingpdfkit.Type of Change
Related Issues
Fixes #129
Changes Made
src/modules/reports/pdf/pdf-report.service.tsusingpdfkitsrc/modules/reports/pdf/pdf-report.template.ts(executive summary, severity breakdown, top affected chains)GET /api/reports/security/pdf(optional?days=7) returns downloadable PDF viaStreamableFilesrc/modules/reports/reports.module.tsregistered inapps/backend/src/app.module.tsapps/backend/tsconfig.app.jsonincludessrc/modules/reportsfor backend compilationpdfkit+@types/pdfkitTesting
npm run test:backend -- --testPathPatterns=reports)eslint+prettier --write)prettier --writeon reports files)npm run build)How to verify:
npm run prisma:generatenpm run buildnpm run test:backend -- --testPathPatterns=reportsManual download test (with backend running):
curl -o report.pdf "http://localhost:3000/api/reports/security/pdf?days=7"Checklist
Additional Context
src/modules/reports/pdf/as specified in Add PDF Report Export #129.ReportingService.getSecurityReport()from the existing reporting module inapps/backend/src/modules/reporting/.src/modules/reportsimports reporting types/services fromapps/backend/;tsconfig.app.jsonwas updated to compile the new module.pdfkitis used for server-side PDF generation.