Compare commits

...

102 Commits

Author SHA1 Message Date
9cb964379f chore: Add DocumentService.Client project reference to Tests 2026-08-11 10:30:24 +02:00
4363b5e961 test: Update integration tests to use moved request DTOs 2026-08-11 10:30:15 +02:00
0059a70055 test: Add unit tests for DocumentService.Client 2026-08-11 10:30:05 +02:00
d08e40d551 chore: Add DocumentService.Client project reference to API 2026-08-11 10:29:55 +02:00
757f56b9f8 refactor: Move request DTOs to DocumentService.Client.Models namespace 2026-08-11 10:29:44 +02:00
8c72502913 chore: Add DocumentService.Client project configuration 2026-08-11 10:29:34 +02:00
058cb9327d feat: Add specialized client implementations for PDF operations 2026-08-11 10:29:24 +02:00
14250f0b4b feat: Add DocumentService.Client base infrastructure 2026-08-11 10:29:14 +02:00
b3a07f1348 Add interfaces and DTOs for PDF operations support
Introduced multiple interfaces and DTOs to support a wide range of
PDF-related operations, including attachment handling, conversion,
validation, annotation, stamping, and metadata extraction.

Key changes:
- Added `DocumentServiceClientOptions` for HTTP client config.
- Introduced `IPdfAttachmentClient` for attachment operations.
- Added `IPdfConversionClient` for PDF/A conversion (marked obsolete).
- Added `IPdfOperationsClient` for merge, annotate, and stamp ops.
- Introduced `IPdfValidationClient` for PDF and PDF/A validation.
- Added `ISwissQrCodeClient` for Swiss QR Code extraction.
- Added `IZugferdClient` for ZUGFeRD detection and extraction.
- Created request DTOs for Base64-encoded operations.
- Added enums for annotation, stamp, and validation configurations.

These changes provide a flexible and extensible foundation for
interacting with PDF documents, supporting both multipart and
Base64-encoded inputs, and ensuring type safety with enums and records.
2026-07-30 16:59:54 +02:00
d477eb5a28 Add DocumentService.Client project to solution
Introduced a new `DocumentService.Client` project targeting `net462`, `net480`, and `net8.0`. The project includes metadata for NuGet packaging, such as `PackageId`, `Authors`, and `Company`, and references `Microsoft.Extensions.DependencyInjection` and `Microsoft.Extensions.Logging`.

Updated `DocumentService.sln` to include the new project, its build configurations, and solution folder associations.

Added `icon.png` as the NuGet package icon and included it in the project file.
2026-07-30 14:15:31 +02:00
3da6ca8323 Remove DocumentOperator.sln and associated projects
The `DocumentOperator.sln` file was completely removed, along with all associated projects (`DocumentService.API`, `DocumentService.Application`, `DocumentService.Infrastructure`, `DocumentService.Domain`, `DocumentService.Tests`) and solution folders (`Solution Items`, `fake-pfd`, `core`, `presentation`, `infrastructure`, `src`, `tests`).

Markdown files (`AGENTS.md`, `CONTROLLER_ENDPOINTS.md`, `REQUIRED_FEATURES.md`) and PDF files (`form.pdf`, `multi-page.pdf`, `one-page.pdf`, `with-image.pdf`) were also deleted.

Solution configurations, platform settings, project nesting, and the `SolutionGuid` were removed, indicating the solution is no longer part of the codebase. This change may be part of a restructuring, migration, or deprecation effort.
2026-07-30 14:04:55 +02:00
0e88b349d7 Rebrand project: DocumentOperator to DocumentService
This commit implements a complete rebranding of the project:
- Updated all namespaces from `DocumentOperator` to `DocumentService`.
- Renamed file paths, embedded resources, and test data references.
- Updated configuration keys, logging paths, and Redis instance names.
- Revised documentation to reflect the new project name.
- Modified project and solution files to align with the new structure.
- Updated class names, DTOs, commands, queries, and handlers.
- Adjusted middleware, controllers, and API endpoints.
- Updated Swagger metadata and API titles to `DocumentService API`.
- Refactored test namespaces, resource paths, and embedded resources.
- Updated build and deployment configurations for the new name.
- Replaced all references to `DocumentOperator` in comments and literals.

These changes ensure consistency across the codebase and documentation.
2026-07-30 14:02:56 +02:00
b6bb894257 Refactor: Rename DocumentOperator to DocumentService
Renamed and restructured project references across the solution
to replace `DocumentOperator` projects with `DocumentService`
projects. Updated all `.csproj` files to reflect the new project
names and references.

Modified the solution file (`DocumentOperator.sln`) to remove
`DocumentOperator` projects and add corresponding `DocumentService`
projects, including `DocumentService.API`, `DocumentService.Application`,
`DocumentService.Infrastructure`, `DocumentService.Domain`, and
`DocumentService.Tests`.

This change aligns the project structure with the new naming
convention or organizational standards.
2026-07-30 14:01:29 +02:00
9cff7ee459 Add new projects and update solution structure
Added the following projects to `DocumentOperator.sln`:
- `core`, `presentation`, `infrastructure`, `src`, `tests`
Updated `GlobalSection(NestedProjects)` to define hierarchical
relationships between projects for better organization. Nested
projects include `core`, `presentation`, and `infrastructure`
under `src`, among others.
2026-07-30 13:46:06 +02:00
a6694bfce7 Add PDF attachment and PDF/A conversion features
Introduced endpoints for embedding attachments in PDFs and converting
between standard PDFs and PDF/A formats. Added `PdfAttachmentController`
and `PdfConversionController` with multipart/form-data and Base64-based
support. Implemented commands, handlers, and validators for these
operations.

Extended `IPdfProcessor` with methods for adding attachments and
PDF/A conversion. Partially implemented functionality in
`DevExpressPdfProcessor`, including `ConvertFromPdfAAsync`.

Added `attachment.xml` and `withoutAttachment.pdf` as resources for
testing. Marked endpoints as `[Obsolete]` to indicate incomplete
implementation. Improved validation and error handling for commands.
2026-07-30 13:43:55 +02:00
a242458d2f Add support for XML file output in ZUGFeRD extraction
Enhanced `ExtractZugferdFromFile` and `ExtractZugferdFromBase64`
methods to support output as an XML file (`application/xml`)
or JSON (default). Introduced `asFile` and `format` query
parameters to control the output format. Updated XML
documentation and `ProducesResponseType` attributes to reflect
these changes. Default values for `CancellationToken` were
set to `default` for improved usability.
2026-07-30 10:47:48 +02:00
94123cd1be Add ZUGFeRD detection and extraction functionality
Introduced `ZugferdController` to handle ZUGFeRD-related operations, including detection and extraction of ZUGFeRD XML from PDFs via file upload or Base64-encoded payloads. Integrated `MediatR` for query/command handling.

Added `ZugferdSettings` for configurable file names and patterns, and updated `appsettings.json` and `Program.cs` to support this configuration.

Implemented `HasZugferdQuery` and `ExtractZugferdCommand` with their respective handlers and validators. Added DTOs (`ZugferdCheckResult`, `ZugferdExtractionResult`) for operation results.

Included `ZUGFeRD-Example.pdf` for testing and integrated `Serilog.Ui.Core.Extensions` for logging.
2026-07-30 10:16:43 +02:00
080c2ac2a0 refactor(api): Pass IConfiguration to AddApplication
- Update AddApplication call with builder.Configuration parameter
- Required for license key reading from appsettings.json
2026-07-21 16:52:32 +02:00
97122d0bbd feat(license): Configure MediatR + AutoMapper with LuckyPennySoft license
- Read LuckyPennySoftLicenseKey from appsettings.json
- Set MediatR config.LicenseKey
- Set AutoMapper cfg.LicenseKey
- AddApplication now requires IConfiguration parameter
2026-07-21 16:52:27 +02:00
e9d1586266 chore(deps): Add Microsoft.Extensions.Configuration packages
- Microsoft.Extensions.Configuration.Abstractions 10.0.10
- Microsoft.Extensions.Configuration.Binder 10.0.10
- Required for reading appsettings.json in Application layer
2026-07-21 16:52:21 +02:00
2804993ea6 feat(api): Enable conditional Swagger/Scalar in production
Program.cs changes:
- Add Scalar.AspNetCore using
- Register SwaggerSettings with Options Pattern
- Pass IConfiguration to AddSwaggerDocumentation()
- Conditional middleware: Development OR EnableInProduction=true
- Add Swagger UI with custom endpoint configuration
- Add Scalar UI at /scalar/v1 (DeepSpace theme, C# HttpClient target)

Access URLs:
- Swagger UI: https://localhost:7186/swagger
- Scalar UI: https://localhost:7186/scalar/v1
- Serilog UI: https://localhost:7186/serilog-ui

Production behavior: Swagger+Scalar enabled by default (configurable)
2026-07-21 15:01:56 +02:00
06a9dc7385 chore(deps): Add Scalar.AspNetCore 1.2.58 package
- Modern Swagger UI alternative with better UX
- DeepSpace theme
- C# HttpClient code generation support
2026-07-21 15:01:46 +02:00
4b5c763f24 refactor(swagger): Read SwaggerConfiguration from appsettings
- Update AddSwaggerDocumentation to accept IConfiguration parameter
- Read SwaggerSettings from configuration (Title/Version/Description)
- Replace hardcoded values with dynamic settings
- Add Microsoft.Extensions.Options using for IOptions support
2026-07-21 15:01:38 +02:00
559c726118 feat(swagger): Configure Swagger settings in appsettings.json
- Add SwaggerSettings section with EnableInProduction: true
- Title: DocumentOperator API
- Version: v1
- Description: PDF document processing service using DevExpress
- Production Swagger enabled by default
2026-07-21 15:01:29 +02:00
1106a86ec3 feat(swagger): Add SwaggerSettings configuration class
- Add SwaggerSettings with EnableInProduction flag (default: true)
- Title, Version, Description configurable via appsettings.json
- Enables production Swagger access for debugging/testing
2026-07-21 15:01:22 +02:00
89436406ce Add PDF Stamp Operation feature with endpoints and tests
Implemented the "PDF Stamp Operation" feature, allowing users to add text, image, or predefined stamps to PDF documents.

- Added `FEATURE_7_PLAN.md` with detailed implementation plan.
- Introduced enums (`StampType`, `PredefinedStampType`, `StampPlacement`) in the domain layer.
- Added `AddStampAsync` method to `IPdfProcessor` interface.
- Implemented `AddStampAsync` in `DevExpressPdfProcessor` using DevExpress API.
- Created unit tests for `AddStampAsync` covering various scenarios.
- Added `AddStampCommand` in the application layer with validation rules.
- Created two new endpoints in `PdfOperationsController` for multipart and Base64 inputs.
- Added DTOs for handling endpoint requests.
- Wrote integration tests for endpoints to ensure correctness.
- Updated `AGENTS.md` and added DevExpress API references.
- Documented challenges, considerations, and estimated effort.

This commit completes the "PDF Stamp Operation" feature with full test coverage and documentation.
2026-07-21 14:45:30 +02:00
c96cbbc8d3 ee
Add IIS publish profile for Web Deploy packaging

Added `IISProfile.pubxml` to configure publishing via Web Deploy.
Set the publish method to `Package` and specified build settings
(`Release`, `Any CPU`). Configured the output package location,
enabled single-file packaging, and set the IIS app path to
`DocumentOperator.API`. Target framework updated to .NET 8.0.
2026-07-21 14:44:21 +02:00
9b85e55cd4 docs: Update AGENTS.md for Feature 7 completion + Serilog.UI
Updates:
- Mark stamp endpoint as DONE in Current Status table
- Add Serilog.UI packages to Key Libraries table
- Update test count (Feature 7 instead of Feature 6)
- Add Serilog UI URL to Build/Run section
- Document log viewer access at /serilog-ui
2026-07-21 14:39:40 +02:00
536413bafe feat(logging): Configure Serilog SQLite sink + UI
appsettings.json:
- Add Application:LogDirectory configuration
- Add Serilog WriteTo.SQLite sink (logs.db in LogDirectory)
- Logs table with UTC timestamps

Program.cs:
- Add Serilog.UI usings
- Configure Serilog.UI with SQLite provider
- Mount UI at /serilog-ui endpoint

Web-based log viewer accessible at: https://localhost:7186/serilog-ui
2026-07-21 14:39:32 +02:00
b37ccc8538 chore: Add Serilog.UI packages + versioning metadata
Packages:
- Serilog.Sinks.SQLite 7.0.0 (SQLite log persistence)
- Serilog.UI 3.2.0 (Web-based log viewer)
- Serilog.UI.SqliteProvider 1.1.0 (SQLite provider for Serilog.UI)

Versioning metadata:
- Version: 1.0.0
- Authors/Company: Digital Data GmbH
- Copyright: 2026
- Description: PDF document processing service using DevExpress
2026-07-21 14:39:24 +02:00
d0606f3605 feat(stamp): Add Application layer (AddStampCommand with handler/validator)
- Vertical slice: Command + Handler + Validator in single file
- Validation rules enforce StampType-specific required fields
- Text stamps: Text + FontName + FontSize required
- Image stamps: ImageBytes required
- Predefined stamps: PredefinedType required
- Supports Origin, Rotation, Opacity, Placement, Size parameters
2026-07-21 14:39:03 +02:00
c037ad8446 feat(stamp): Add IPdfProcessor.AddStampAsync interface
- Add AddStampAsync method signature to IPdfProcessor interface
- Parameters: pdfBytes, stampType, pages, position, text/image/predefined params
- Supports Origin (TopLeft/BottomLeft), Rotation, Opacity, Placement
2026-07-21 14:38:29 +02:00
e2bec710e0 feat(stamp): Add Domain value objects for stamp operations
- Add StampType enum (Text, Image, Predefined)
- Add PredefinedStampType enum (CONFIDENTIAL, APPROVED, DRAFT, etc.)
- Add StampPlacement enum (Foreground, Background)
- All enums in DocumentOperator.Domain namespace
2026-07-21 14:38:22 +02:00
61b11fc216 feat(annotation): Add Origin/Width/Height to API endpoints
- Update AddAnnotationFromFile/AddAnnotationFromBase64 endpoints
- Add Origin parameter to multipart/JSON request DTOs
- Add Width/Height as alternative to X2/Y2 in requests
- Calculate X2/Y2 from Width/Height if provided
- XML documentation updated with new parameters
2026-07-21 14:38:14 +02:00
c4ec0c2b48 feat(annotation): Implement coordinate system conversion in DevExpressPdfProcessor
- Add Y-axis conversion for TopLeft origin (bottomLeftY = pageHeight - topLeftY)
- Origin parameter support in AddAnnotationAsync
- Preserves existing BottomLeft behavior as default
2026-07-21 14:38:08 +02:00
eed9d46e19 feat(annotation): Add Origin/Width/Height parameters to AddAnnotationCommand
- Add Origin parameter (default: BottomLeft)
- Add Width/Height as alternatives to X2/Y2
- Validation: Either (X2+Y2) OR (Width+Height) required, not both
- FluentValidation rules enforce mutual exclusivity
2026-07-21 14:38:01 +02:00
c1bb3abeef feat(annotation): Add AnnotationOrigin value object
- Add AnnotationOrigin enum (BottomLeft/TopLeft)
- BottomLeft = PDF native coordinate system (default)
- TopLeft = UI-friendly coordinate system (requires Y-axis conversion)
- Shared with stamp operations for consistency
2026-07-21 14:37:54 +02:00
d72d41ec2d test(integration): Add 10 integration tests for annotation endpoints + update docs
Integration tests:
- 5 happy path tests (TextMarkup, FreeText, StickyNote, Circle, Square) with multipart + Base64 mix
- 5 validation error tests (invalid Base64, page number, missing content/style, invalid color)
- All existing 7 merge tests retained (now 17 total in PdfOperationsControllerTests)

Documentation updates (AGENTS.md):
- Update test count: 82 -> 101 passed, 7 skipped
- Update PdfOperationsController status: 1/N -> 2/3 endpoints (merge + annotate DONE, stamp TODO)
- Add test breakdown by feature (6 features listed)
- Update 'Run tests' section with Feature 6 mention

Test results: 101 PASSED, 7 SKIPPED, 0 FAILED
2026-07-21 12:28:59 +02:00
d4107f6f89 feat(api): Add annotation endpoints to PdfOperationsController
- Add POST /api/pdf/operations/annotate (multipart/form-data)
- Add POST /api/pdf/operations/annotate (application/json with Base64)
- Create AddAnnotationMultipartRequest DTO (wrapper for 10+ form parameters)
- Create AddAnnotationBase64Command DTO (Base64 PDF + annotation parameters)
- Add unique operation names (AnnotateFromFile, AnnotateFromBase64) for Swagger
- Rename MergePdfsRequest -> MergePdfsBase64Request for clarity
- Add Name attributes to merge endpoints (MergeFromFiles, MergeFromBase64) to fix Swagger conflict
- Base64 FormatException wrapped in BadRequestException
2026-07-21 12:28:43 +02:00
22ac2889af feat(application): Add AddAnnotationCommand with handler and validator
- Create AddAnnotationCommand (Command/Handler/Validator merged in single file)
- Use primary constructors for handler (IPdfProcessor dependency)
- FluentValidation rules: stream required, pageNumber > 0, content for FreeText/StickyNote
- Validate textMarkupStyle required for TextMarkup annotations
- Validate color format (6-digit hex) and rectangle coordinates (X2>X1, Y2>Y1)
2026-07-21 12:28:30 +02:00
a23c78ec3a test(infrastructure): Add 12 unit tests for AddAnnotationAsync
- 5 happy path tests (one per annotation type)
- 7 validation error tests (empty stream, invalid position, page number, content, style, color)
- All tests passing (12/12)
- Total unit tests: 37 (25 previous + 12 annotation)
2026-07-21 12:28:17 +02:00
41f97ce533 feat(infrastructure): Implement DevExpressPdfProcessor.AddAnnotationAsync
- Implement AddAnnotationAsync using DevExpress PdfDocumentProcessor
- Add 5 private helper methods (one per annotation type)
- Add ParseColor helper (hex string to PdfRGBColor)
- Validation: content required for FreeText/StickyNote, style for TextMarkup
- Default colors: Yellow for TextMarkup, Red for others
- Handle DevExpress API quirks (TextMarkupStyle.StrikeOut capitalization)
2026-07-21 12:28:05 +02:00
25fbea205f feat(infrastructure): Add IPdfProcessor.AddAnnotationAsync interface
- Add AddAnnotationAsync method with 8 parameters
- Support Stream-based PDF input (Position=0 required)
- Accept annotation type, page number, rectangle coordinates
- Optional parameters: content, author, color (hex), textMarkupStyle
- Returns annotated PDF as byte array
2026-07-21 12:27:52 +02:00
e95f070b9b feat(domain): Add annotation value objects for Feature 6
- Add AnnotationType enum (TextMarkup, FreeText, StickyNote, Circle, Square)
- Add TextMarkupStyle enum (Highlight, Underline, Strikeout)
- Support 5 annotation types as per CONTROLLER_ENDPOINTS.md requirements
2026-07-21 12:27:41 +02:00
aafe46a738 docs: Update AGENTS.md for Feature 5 (PDF Merge) completion
- Update test count: 82 passed, 7 skipped (was 62 passed)
- Update PdfOperationsController status: Partial (1/N endpoints), 7 tests
- Add PdfOperationsController Status section with merge endpoint details
- Mark merge endpoint as DONE (Phase 1, Priority 5)
- List remaining Phase 2 endpoints: stamp, annotate
2026-07-21 10:22:04 +02:00
0bec759396 test: Add 7 integration tests for PdfOperationsController merge endpoint
Multipart tests (4):
- POST_Merge_Multipart_TwoPdfs_Returns200WithMergedPdf
- POST_Merge_Multipart_ThreePdfs_Returns200
- POST_Merge_Multipart_SinglePdf_Returns400
- POST_Merge_Multipart_CorruptedPdf_Returns400Or500 (flexible assertion)

Base64 tests (3):
- POST_Merge_Base64_TwoPdfs_Returns200WithMergedPdf
- POST_Merge_Base64_ThreePdfs_Returns200
- POST_Merge_Base64_SinglePdf_Returns400

Skipped tests (2):
- POST_Merge_Multipart_WithPageRanges_Returns200 (multipart List<string?> binding complex)
- POST_Merge_Multipart_InvalidPageRange_Returns400 (page ranges work via JSON endpoint)
2026-07-21 10:21:46 +02:00
5c3fafff1b feat: Add PdfOperationsController with dual-input merge endpoints
- Add PdfOperationsController.cs with route '/api/pdf/operations'
- MergeFromFiles: POST /merge (multipart/form-data) - accepts List<IFormFile>
- MergeFromBase64: POST /merge (application/json) - accepts MergePdfsRequest DTO
- Returns merged PDF as FileContentResult (application/pdf)
- Supports optional page ranges via JSON endpoint only (multipart binding complex)
- XML documentation with response codes (200, 400, 500)
- Uses primary constructor pattern
2026-07-21 10:21:27 +02:00
bc273c7f4f feat: Add MergePdfsCommand with merged Command/Handler/Validator
- Add MergePdfsCommand.cs (Vertical Slice pattern)
- Command: IRequest<byte[]> with PdfStreams + PageRanges properties
- Handler: Calls IPdfProcessor.MergePdfsAsync, uses primary constructor
- Validator: Validates minimum 2 PDFs, page ranges count matches PDF count
- All 3 classes in single file (Command/Handler/Validator merged)
2026-07-21 10:21:10 +02:00
e12b64a517 test: Add 10 unit tests for MergePdfsAsync + LoadTestPdfAsStream helper
Unit tests (10):
- MergePdfsAsync_TwoPdfs_ReturnsMergedPdf
- MergePdfsAsync_ThreePdfs_ReturnsMergedPdf
- MergePdfsAsync_WithNullPageRanges_MergesAllPages
- MergePdfsAsync_WithEmptyPageRanges_MergesAllPages
- MergePdfsAsync_WithRangeFormat_MergesSelectedPages
- MergePdfsAsync_SinglePdf_ThrowsBadRequestException
- MergePdfsAsync_InvalidPageRangeCount_ThrowsBadRequestException
- MergePdfsAsync_InvalidPageRangeFormat_ThrowsBadRequestException
- MergePdfsAsync_PageNumberOutOfRange_ThrowsBadRequestException
- MergePdfsAsync_StreamNotAtPositionZero_ThrowsBadRequestException

Helper:
- Add LoadTestPdfAsStream helper for Stream-returning test setup
2026-07-21 10:20:53 +02:00
3598c5f9c6 feat: Implement DevExpressPdfProcessor.MergePdfsAsync with page range support
- Implement MergePdfsAsync: merges multiple PDFs with optional page ranges
- Add ParsePageRange helper: parses '1-3,5' format, validates page numbers
- Stream-based pipeline (no byte[] buffering)
- Validates: Position = 0, minimum 2 PDFs, page ranges count
- Uses DevExpress PdfDocumentProcessor for actual merge operation
- Returns merged PDF as byte array
2026-07-21 10:20:35 +02:00
522de8a863 feat: Add IPdfProcessor.MergePdfsAsync interface
- Add MergePdfsAsync method to IPdfProcessor interface
- Parameters: IReadOnlyList<Stream> pdfStreams, IReadOnlyList<string?>? pageRanges
- Returns: Task<byte[]> (merged PDF)
- Validates: Minimum 2 PDFs, stream Position = 0, page ranges count matches PDF count
- Supports optional page ranges (e.g., '1-3,5' or null for all pages)
2026-07-21 10:20:18 +02:00
cb552e54e7 docs: Update AGENTS.md - PdfAttachmentController 2/3 endpoints, 62 tests 2026-07-21 09:27:14 +02:00
fa4e55242d fix: Update SwissQrCode test - ArgumentException to BadRequestException 2026-07-21 09:26:51 +02:00
e14044c48a test: Add PdfAttachmentController extract endpoint integration tests (6 tests) 2026-07-21 09:26:43 +02:00
34e38f19e5 feat: Add PdfAttachmentController extract endpoints (multipart + Base64) 2026-07-21 09:26:34 +02:00
61b1595258 test: Add ExtractAttachmentsAsync unit tests (ZIP validation, edge cases) 2026-07-21 09:26:27 +02:00
26458a4017 feat: Implement DevExpressPdfProcessor.ExtractAttachmentsAsync with ZIP packaging 2026-07-21 09:26:18 +02:00
2c673ea98e feat: Add IPdfProcessor.ExtractAttachmentsAsync interface method 2026-07-21 09:26:11 +02:00
1989ca7ef7 feat: Add ExtractPdfAttachments Application layer (Command/Handler/Validator merged) 2026-07-21 09:26:04 +02:00
0f4d860176 test(integration): migrate integration tests to Controller DTOs and update assertions
Test Changes:
- Use Controller DTOs (ValidatePdfBase64Request, ValidatePdfABase64Request, CheckPdfAttachmentsRequest, ExtractSwissQrCodeBase64Request)
- Remove direct Query object usage in HTTP tests (architectural violation)
- Update imports: DocumentOperator.API.Controllers namespace

Assertion Updates:
- Invalid Base64 tests: case-insensitive regex (?i)base.?64 (FormatException message contains 'Base-64' with hyphen)
- Empty PDF tests: regex match for 'Base64|empty|stream' (flexible validation error matching)
- Corrupted PDF test: Expect 500 Internal Server Error (DevExpress exception propagates naturally)

Result: 52 tests pass, 6 skipped (IBAN validation - DevExpress limitation)
2026-07-20 16:33:19 +02:00
645dfceafa test(unit): migrate unit tests to Stream API
Application Handler Tests:
- ValidatePdfHandlerTests: PdfStream = new MemoryStream(pdfBytes)
- ValidatePdfAQueryHandlerTests: PdfStream = new MemoryStream(pdfBytes)
- CheckPdfAttachmentsQueryHandlerTests: PdfStream = new MemoryStream(pdfBytes)
- Remove Base64/PdfBytes property usage

Infrastructure Tests:
- DevExpressSwissQrCodeProcessorTests: LoadTestPdf() returns Stream
- All test methods use 'using var stream' pattern
- Add test: ExtractSwissQrCodeAsync_StreamNotAtBeginning_ThrowsBadRequestException

Result: All unit tests pass with Stream-based API
2026-07-20 16:33:00 +02:00
07be9b9f02 refactor(domain): remove obsolete exception types
Deleted:
- PdfProcessingException: Obsolete, DevExpress exceptions now propagate naturally
- SwissQrCodeNotFoundException: Moved to Application layer (feature-specific exception)

Rationale:
- PdfProcessingException was wrapping library exceptions unnecessarily
- Better to let infrastructure exceptions propagate → middleware handles as 500
- SwissQrCodeNotFoundException is application-level concern, not domain
2026-07-20 16:32:36 +02:00
a1e8575018 refactor(api): remove generic exception handling from middleware
Remove FormatException/ArgumentException handling:
- These are framework exceptions, not application-specific
- May come from internal libraries (false positives for 400 Bad Request)
- Controllers now wrap Base64 conversion with BadRequestException explicitly

Remove PdfProcessingException handling:
- Exception type removed (obsolete)
- DevExpress exceptions now propagate naturally → 500 Internal Server Error

Current exception mapping:
- ValidationException (FluentValidation) → 400 Bad Request
- BadRequestException (custom) → 400 Bad Request
- NotFoundException (custom) → 404 Not Found
- SwissQrCodeNotFoundException (custom) → 404 Not Found
- All others → 500 Internal Server Error
2026-07-20 16:32:19 +02:00
b4befde418 refactor(api): migrate controllers to Stream API with Base64 validation
PdfValidationController:
- ValidateFromFile: IFormFile.OpenReadStream() direct usage (no byte[] copy)
- ValidateFromBase64: try-catch Convert.FromBase64String → BadRequestException
- ValidatePdfAFromFile: IFormFile.OpenReadStream() direct usage
- ValidatePdfAFromBase64: try-catch Convert.FromBase64String → BadRequestException

PdfAttachmentController:
- CheckAttachmentsFromBase64: try-catch Convert.FromBase64String → BadRequestException

SwissQrCodeController:
- ExtractFromBase64: try-catch Convert.FromBase64String → BadRequestException

All controllers: Add using DocumentOperator.Domain.Common.Exceptions for BadRequestException
2026-07-20 16:32:03 +02:00
1af158840e refactor(infrastructure): implement Stream-based PDF processing
DevExpressPdfProcessor:
- ValidateAsync, ValidatePdfAAsync, CheckAttachmentsAsync: Stream parameters
- Defensive Position=0 validation (BadRequestException for seekable streams not at beginning)
- Remove unsafe Position reset (non-seekable stream compatibility)
- Remove PdfProcessingException wrapping (let DevExpress exceptions propagate naturally)

DevExpressSwissQrCodeProcessor:
- ExtractSwissQrCodeAsync: Stream parameter
- Defensive Position=0 validation
- Remove unsafe Position reset

Memory optimization: MemoryStream.TryGetBuffer fast path for byte[] extraction
2026-07-20 16:31:47 +02:00
5dc2e38507 refactor(application): update processor interfaces for Stream API
- IPdfProcessor: ValidateAsync, ValidatePdfAAsync, CheckAttachmentsAsync now accept Stream
- ISwissQrCodeProcessor: ExtractSwissQrCodeAsync now accepts Stream
- Update XML documentation: Position=0 requirement, non-seekable stream support
- Exception documentation: BadRequestException for validation errors (stream empty/invalid/wrong position)
2026-07-20 16:31:31 +02:00
c93488c29f refactor(application): migrate all queries to Stream-based API
- Replace byte[] and Base64String with required Stream PdfStream
- Simplify validators: remove XOR/Base64 validation, only check NotNull
- Affected queries: ValidatePdfQuery, ValidatePdfAQuery, CheckPdfAttachmentsQuery, ExtractSwissQrCodeQuery
- Memory efficiency: direct stream usage, no intermediate byte[] copies
2026-07-20 16:31:14 +02:00
251ecc34d9 test: Add tests for CheckPdfAttachments feature
- Unit tests for CheckPdfAttachmentsQueryHandler (3 tests)
- Integration tests for PdfAttachmentController (14 tests covering both multipart and JSON endpoints)
- Tests verify: attachment detection, metadata extraction, empty PDF handling, validation errors
- All tests using Stream API (mocks with It.IsAny<Stream>())
- Total: 17 new tests, all passing
2026-07-20 11:56:19 +02:00
9db15f7025 feat: Add PdfAttachmentController with CheckAttachments endpoints
- Add POST /api/pdf/attachments/check endpoint (multipart/form-data)
- Add POST /api/pdf/attachments/check endpoint (application/json with Base64)
- Dual input support: IFormFile (file upload) and Base64 JSON
- Controller converts IFormFile → byte[] and sends to MediatR
- Complete XML documentation with Swagger examples
- Primary constructor pattern used
2026-07-20 11:56:12 +02:00
364b755f95 feat: Add CheckPdfAttachments feature - Application layer
- Add CheckPdfAttachmentsQuery with dual input support (byte[] + Base64)
- Add CheckPdfAttachmentsQueryHandler with IPdfProcessor integration
- Add CheckPdfAttachmentsQueryValidator with FluentValidation rules
- Add AttachmentCheckResult DTO for API response
- Handler converts byte[] → MemoryStream for IPdfProcessor.CheckAttachmentsAsync()
- AutoMapper maps AttachmentInfo → AttachmentCheckResult
2026-07-20 11:56:03 +02:00
f2e6ef0260 chore: Remove obsolete Domain enums (DocumentOperationType, ProcessingStatus)
- These enums were part of initial scaffolding but never used
- Domain layer cleanup - removing unused code
2026-07-20 11:55:55 +02:00
8aff3138ff test: Fix obsolete exception expectations in SwissQrCodeProcessor tests
- SwissQrCodeNotFoundException → NotFoundException (obsolete exception replaced)
- PdfProcessingException → ArgumentException (DevExpress throws ArgumentException for invalid PDFs)
- ArgumentNullException → NullReferenceException (actual behavior of current implementation)
2026-07-20 11:55:48 +02:00
58f9b07af3 test: Update Application handler unit tests for Stream API
- Update mock setups: It.IsAny<byte[]>() → It.IsAny<Stream>()
- Update mock verifications: Verify Stream parameter instead of byte[]
- Remove obsolete namespace imports (Domain.Models.ValueObjects)
- Update exception expectations (BadRequestException instead of PdfProcessingException)
2026-07-20 11:55:41 +02:00
468dca46d4 test: Update DevExpressPdfProcessor unit tests for Stream API
- Add ToStream() helper method to convert byte[] → MemoryStream
- Update all test method calls to use ToStream(pdfBytes)
- Fix null/empty stream tests (use Stream directly instead of byte[])
- Update exception expectations (ArgumentNullException for null streams, BadRequestException for empty streams)
- Update namespace imports (Application.Common.DTOs instead of Domain.Models.ValueObjects)
2026-07-20 11:55:33 +02:00
e13e85182a refactor: Update Application handlers to convert byte[] to Stream
- ValidatePdfQueryHandler: Convert byte[] → MemoryStream before calling IPdfProcessor
- ValidatePdfAQueryHandler: Same pattern
- Update AutoMapper namespace imports (remove Domain.Models.ValueObjects references)
2026-07-20 11:55:25 +02:00
1de781748b refactor: Update DevExpressPdfProcessor to use Stream parameters
- All 3 methods (ValidateAsync, ValidatePdfAAsync, CheckAttachmentsAsync) now accept Stream
- Add ArgumentNullException.ThrowIfNull() checks for null streams
- Implement fast-path optimization: reuse MemoryStream buffer when possible
- Implement slow-path fallback: copy stream to byte[] for DevExpress API compatibility
- Fix namespace collision: use fully qualified Application.Common.DTOs.PdfMetadata
2026-07-20 11:55:17 +02:00
73a7afe257 refactor: Change IPdfProcessor interface from byte[] to Stream
- ValidateAsync(byte[]) → ValidateAsync(Stream)
- ValidatePdfAAsync(byte[]) → ValidatePdfAAsync(Stream)
- CheckAttachmentsAsync(byte[]) → CheckAttachmentsAsync(Stream)
- Reason: Stream-based processing reduces memory footprint and enables pipeline parallelization
2026-07-20 11:55:08 +02:00
d123bc996e refactor: Move DTOs from Domain to Application layer
- Move PdfMetadata, PdfAMetadata from Domain.Models.ValueObjects to Application.Common.DTOs
- Move AttachmentInfo, AttachmentMetadata from Domain.Models.ValueObjects to Application.Common.DTOs
- Reason: DTOs belong in Application layer, Domain should have zero external dependencies (Clean Architecture)
2026-07-20 11:55:01 +02:00
4085a88485 Update XML docs for raw param in SwissQrCodeController
Removed detailed description of the `raw` parameter in XML
documentation for two methods in `SwissQrCodeController`.
Updated `<returns>` tag to simplify the explanation by
removing conditional details based on the `raw` parameter.
These changes affect methods handling multipart/form-data
PDF input and Base64 JSON input.
2026-07-20 10:51:30 +02:00
88984c8887 Refactor and streamline codebase
- Removed `<Folder>` elements in `DocumentOperator.Domain.csproj`
  and replaced them with `<Compile Remove>`, `<EmbeddedResource Remove>`,
  and `<None Remove>` to exclude specific directories.
- Removed unused `using DocumentOperator.Domain.Exceptions;` directive.
- Simplified `Split` method syntax for delimiter specification.
- Updated `return` statements to use concise parameter syntax.
- Removed page number validation logic in `DevExpressSwissQrCodeProcessor`.
- Replaced default page scanning logic with modern range expression.
- Overall, improved code clarity, reduced redundancy, and modernized syntax.
2026-07-20 09:46:44 +02:00
a315fbf890 feat: Add raw parameter to SwissQrCodeController endpoints
- Add 'raw' query parameter to both ExtractFromFile and ExtractFromBase64 methods
- Returns raw QR text lines when raw=true, parsed Bill object when raw=false (default)
- Remove obsolete 'references' parameter (not part of QR extraction logic)
- Add XML documentation for raw parameter
- Update ExceptionHandlingMiddleware to handle BadRequestException
2026-07-16 15:48:09 +02:00
1a89887056 test: Update tests for tuple return type and new API structure
- Update unit tests to assert (Bill, string[]) tuple return
- Update integration tests for new response structure (Bill + RawLines)
- Fix exception message assertion in DevExpressSwissQrCodeProcessorTests
- All 34 tests passing, 6 skipped (require real Swiss QR Bill PDFs)
2026-07-16 15:47:56 +02:00
a729df6fda refactor: Make Domain exceptions serializable and add XML docs
- Add [Serializable] attribute to all custom exceptions
- Add protected constructors for serialization support
- Add XML documentation comments
- Update SwissQrCodeNotFoundException message format
2026-07-16 15:47:44 +02:00
88bde13422 refactor: Refactor DevExpressSwissQrCodeProcessor to use Codecrete QRBill parser
- Change return type to tuple (Bill, string[])
- Remove custom parsing methods (ParseSwissQrBillContent, MapAddress, DetermineReferenceType)
- Use Codecrete QRBill.DecodeQrCodeText() for parsing
- Add SkiaSharp.QrCode v1.0.0 for QR decoding
- Remove obsolete ZXing and System.Drawing dependencies
- Add StringExtensions for QR code detection
- Raw lines properly split and trimmed from QR text
2026-07-16 15:47:33 +02:00
889144f144 feat: Add AutoMapper mappings for Codecrete Bill to DTOs
- Add Bill -> SwissQrBillDto mapping
- Add Address -> AddressDto mapping
- Add AlternativeScheme -> AlternativeSchemeDto mapping
- Document AutoMapper policy in comments
2026-07-16 15:47:19 +02:00
35016f02e1 refactor: Update Application layer for Codecrete Bill integration
- Change SwissQrCodeExtractionResult to use Bill + RawLines
- Update ISwissQrCodeProcessor to return tuple (Bill, string[])
- Add Codecrete.SwissQRBill.Generator v3.4.0 package reference
- Update ExtractSwissQrCodeQuery handler to use AutoMapper for Bill->DTO mapping
- Remove References property from query (not needed for QR extraction)
2026-07-16 15:47:09 +02:00
e321963487 refactor: Remove SwissQrCodeData domain value object
- Delete SwissQrCodeData.cs and AddressData
- Migrating to direct use of Codecrete Bill class
2026-07-16 15:46:55 +02:00
711f1a2660 feat: Add SwissQrBillDto and BadRequestException
- Add SwissQrBillDto, AddressDto, AlternativeSchemeDto for Codecrete Bill mapping
- Add BadRequestException to Domain exceptions
- DTOs include [Obsolete] warnings for deprecated fields (AddressLine1/2)
2026-07-16 15:46:44 +02:00
386a124a4e Add DualInputDocumentFilter for Swagger content merging
Introduced the `DualInputDocumentFilter` class to merge Swagger operations with the same path but different `[Consumes]` attributes (`multipart/form-data` and `application/json`) into a single operation. This ensures both content types are visible in the Swagger UI.

Updated `SwaggerConfiguration.cs` to:
- Resolve conflicting actions by keeping the first variant.
- Register the `DualInputDocumentFilter` to enable content type merging.
2026-07-13 16:04:55 +02:00
f7433111a7 test: Add PDF/A validation tests and manual testing guide
- Add unit tests for ValidatePdfAQueryHandler (4 tests)
- Add integration tests for PDF/A validation endpoint (6 tests)
- Fix FluentValidation: Add Base64 format validation to ValidatePdfAQueryValidator
- Update AGENTS.md: Document 3-folder test structure rationale and test count (30 tests)
- Add DocumentOperator.API/README.md: 16 manual test scenarios for all endpoints

Test coverage:
- Unit: ValidatePdfAQueryHandler (compliant, non-compliant, encrypted, exceptions)
- Integration: PDF/A endpoint (multipart + Base64, validation, error handling)
- Manual: Step-by-step Swagger UI testing guide for all features

All 30 automated tests passing.
2026-07-09 14:01:57 +02:00
cd50d45bd5 feat: Add PDF/A validation endpoint (Feature 3)
Domain layer:

  - PdfAMetadata value object (isValid, pdfVersion, pageCount, encrypted, pdfaVersion, pdfaCompliant, errors, warnings)

Infrastructure layer:

  - IPdfProcessor.ValidatePdfAAsync() interface method

  - DevExpressPdfProcessor.ValidatePdfAAsync() implementation

  - DetectEncryption() - scans PDF raw data for /Encrypt keyword

  - DetectPdfAConformance() - parses XMP metadata (pdfaid:part, pdfaid:conformance)

  - Validation: encrypted PDF cannot be PDF/A compliant

Application layer:

  - ValidatePdfAQuery + ValidatePdfAQueryHandler (co-located)

  - ValidatePdfAQueryValidator (FluentValidation: PdfBytes XOR Base64Pdf)

  - PdfAValidationResult DTO

  - AutoMapper: PdfAMetadata -> PdfAValidationResult

API layer:

  - PdfValidationController.ValidatePdfAFromFile() (multipart/form-data)

  - PdfValidationController.ValidatePdfAFromBase64() (application/json)

  - XML documentation with response codes

Result:

  - POST /api/pdf/validation/validate-pdfa (both multipart and JSON)

  - Returns: conformance level, errors, warnings

  - Build: 0 errors, 4 warnings (DevExpress eval)

  - Tests: 20/20 passing

Next: Integration tests + Swagger test case
2026-07-09 12:59:24 +02:00
1ff7cbea11 add example PDFs 2026-07-09 12:53:49 +02:00
dc0af68d26 docs: Update API specification based on Marvin/Marlon feedback
CONTROLLER_ENDPOINTS.md changes:

  - Binary stream output for all operations (NO outputPath, NO base64)

  - PDF Operations: merge, stamp, annotate → return application/pdf stream

  - PDF Conversion: to-pdfa, from-pdfa → return application/pdf stream

  - Attachment Extraction: extract → return application/zip stream

  - Add Attachment endpoint (Phase 2): embed files in PDF/PDF/A-3

  - Swiss QR Code endpoint documented (already implemented)

  - PdfRenderController REMOVED (moved to .NET client library)

AGENTS.md changes:

  - Current Status: SwissQrCodeController  DONE (2 tests)

  - Current Status: PdfValidationController  Partial (4 tests)

  - Phase reorganization:

    - Phase 1: validate, validate-pdfa, check, extract (SwissQR), extract (attachments), merge

    - Phase 2: stamp, annotate, add-attachment

    - Phase 3: to-pdfa, from-pdfa

  - Removed PdfRenderController from all phases

Design decisions (team consensus):

  - Server endpoints stay granular (validate, check, extract separate)

  - Combined operations (validateANDextract) → .NET client library

  - Binary streams avoid filesystem dependencies

  - No base64 overhead (~33%), client library handles conversions

Result: Clean API spec, memory-based operations, client convenience layer
2026-07-08 15:46:10 +02:00
45bc90b8b8 test: Update integration tests for Controller-based API
Integration test updates:

  - PdfValidationControllerTests.cs (new)

    - Test /api/pdf/validation/validate endpoint

    - Test BOTH multipart/form-data AND Base64 JSON

  - ExtractSwissQrCodeEndpointTests.cs (updated)

    - Update endpoint path to /api/swissqrcode/extract

    - Test BOTH input formats

Unit test updates:

  - ValidatePdfHandlerTests.cs:

    - Update for Query + Handler co-location

    - Test AutoMapper integration

  - ExtractSwissQrCodeHandlerTests.cs:

    - Update for Query + Handler co-location

    - Test AutoMapper integration

Deleted:

  - DocumentEndpointsTests.cs (Minimal API tests, no longer relevant)

Result: 20/20 tests passing, Controller endpoint coverage
2026-07-07 19:01:35 +02:00
57e36fc004 refactor: Migrate from Minimal API to Controller-based API
Architecture decision change:

  - Previous: Minimal API (DocumentEndpoints.cs) - WRONG approach

  - Required: Controller-based API (per CONTROLLER_ENDPOINTS.md)

New controllers:

  - PdfValidationController:

    - POST /api/pdf/validation/validate

    - Accepts BOTH IFormFile (multipart) AND Base64 JSON

    - Returns PdfValidationResult

  - SwissQrCodeController:

    - POST /api/swissqrcode/extract

    - Accepts BOTH IFormFile (multipart) AND Base64 JSON

    - Returns SwissQrCodeExtractionResult

Controller best practices:

  - Primary constructors (C# 12)

  - Thin controllers (pass request to MediatR directly)

  - No manual mapping (AutoMapper handles domain -> DTO)

  - XML documentation for Swagger

  - [ProducesResponseType] attributes

Deleted:

  - API/Endpoints/v1/DocumentEndpoints.cs (Minimal API)

  - ROADMAP.md (conflicting guidance with CONTROLLER_ENDPOINTS.md)

Result: Controller-based API, dual input support (multipart + JSON)
2026-07-07 19:01:20 +02:00
d6e3a5fda1 refactor: Restructure Application layer with vertical slices and AutoMapper
Vertical slice architecture:

  - Move Features/Documents/{UseCase}/ to {UseCase}/Queries/

  - Query + Handler in SAME file (co-located)

  - Validator in separate file (single responsibility)

New structure:

  - ValidatePdf/Queries/ValidatePdfQuery.cs (Query + Handler)

  - ValidatePdf/Queries/ValidatePdfQueryValidator.cs

  - SwissQrCode/Queries/ExtractSwissQrCodeQuery.cs (Query + Handler)

  - SwissQrCode/Queries/ExtractSwissQrCodeQueryValidator.cs

AutoMapper integration:

  - Add Common/Mapping/MappingProfile.cs

  - Map PdfMetadata -> PdfValidationResult (domain -> DTO)

  - Map SwissQrCodeData -> SwissQrCodeExtractionResult (domain -> DTO)

  - Controllers now thin: pass request to MediatR, AutoMapper handles mapping

DTO improvements:

  - Rename: ValidatePdfResponse -> PdfValidationResult (business-friendly)

  - Rename: ExtractSwissQrCodeResponse -> SwissQrCodeExtractionResult

  - Support BOTH byte[] and Base64Pdf string (XOR validation)

  - Use modern C# 12 collection expressions

Code quality:

  - Use PascalCase for primary constructor parameters

  - Fix LoggingBehavior logging format

Deleted old structure:

  - Features/Documents/ValidatePdf/ (old horizontal structure)

  - Features/Documents/ExtractSwissQrCode/ (old horizontal structure)

  - Common/DTOs/{Request|Response} (replaced with {Result})

Result: Vertical slices, AutoMapper v16.2.0, thin controllers
2026-07-07 19:01:05 +02:00
b460d8df39 refactor: Remove Base64String value object per YAGNI principle
Remove unnecessary Base64String value object:

  - Performance overhead (validation runs twice: value object + FluentValidation)

  - Unnecessary abstraction (Convert.FromBase64String already validates)

  - YAGNI principle: use string directly + extension methods if needed

Replaced with:

  - Direct string usage in DTOs

  - FluentValidation for Base64 format validation

  - FormatException handling in ExceptionHandlingMiddleware (maps to 400)

Result: Simpler code, better performance, same validation coverage
2026-07-07 19:00:43 +02:00
398651964e chore: Upgrade AutoMapper to v16.2.0 and fix DI registration
- Upgrade AutoMapper from 12.0.1 to 16.2.0

- Remove deprecated AutoMapper.Extensions.Microsoft.DependencyInjection v12.0.1

  (deprecated 25 May 2023, DI moved to main package in v13.0+)

- Update DI registration: AddAutoMapper(cfg => {}, typeof(MappingProfile))

  (v13.0+ requires Action<IMapperConfigurationExpression> + marker type)

Security fix:

  - Resolves NU1903 vulnerability (GHSA-rvv3-g6hj-g44x DoS in v12.0.1)

Result: AutoMapper v16.2.0, 0 security warnings, all tests passing
2026-07-07 19:00:29 +02:00
f8690b9417 docs: Add AGENTS.md architecture guidance for AI agents
Comprehensive architecture documentation including:

  - Clean Architecture with Controller-based API (NOT Minimal API)

  - Vertical slice architecture pattern

  - Exception-based error handling (no Result<T>)

  - Feature-driven development approach

  - Primary constructor coding standards

  - Git commit guidelines

  - Swiss QR Bill backward compatibility decisions

Key decisions documented:

  - Windows-only targeting (no Linux support needed)

  - Support BOTH multipart/form-data AND Base64 JSON

  - Separate endpoints for Combined Address (K-Type) legacy support

  - Multi-tenancy deferred until after all sync features complete
2026-07-07 19:00:12 +02:00
077eb1e017 docs: Add XML documentation comments to API layer
Add missing XML doc comments to resolve CS1591 warnings:

  - SerilogConfiguration: Class comment

  - SwaggerConfiguration: Class and AddSwaggerDocumentation() method

  - ExceptionHandlingMiddleware: Constructor and InvokeAsync() method

  - RequestLoggingMiddleware: Placeholder class comment

  - TenantResolutionMiddleware: Placeholder class comment

  - Program: Partial class comment for integration test access

Result: 0 CS1591 warnings in DocumentOperator.API project
2026-07-07 18:56:23 +02:00
8b154e7378 fix: Replace CreateBitmap with CreateDXBitmap for cross-platform compatibility
- Replace System.Drawing.Bitmap with DevExpress.Drawing.DXBitmap

- Fix CA1416 warnings (Windows-specific API usage)

- Fix CS0618 warning (TryInverted property moved to Options.TryInverted)

- Add [SupportedOSPlatform(windows)] attribute to DecodeQrCodeFromImage()

- Add Swiss QR Bill backward compatibility documentation

- Suppress CS0618 for AddressLine1/AddressLine2 (deprecated since Nov 2025)

- Use modern C# 12 collection expression syntax

Technical changes:

  - CreateBitmap() to CreateDXBitmap() (returns DXBitmap)

  - Convert DXBitmap to PNG stream to System.Drawing.Bitmap for ZXing

  - Add using DevExpress.Drawing and System.Runtime.Versioning

Result: 0 CA1416 warnings, 0 CS0618 warnings in DevExpressSwissQrCodeProcessor
2026-07-07 18:56:09 +02:00
a12d529d9e Add documentation for DocumentOperator service
Added `CONTROLLER_ENDPOINTS.md` to define REST API endpoints and
`REQUIRED_FEATURES.md` to outline required functions and features
for the `DocumentOperator` service. These documents include
detailed specifications for controllers, input/output formats,
usage scenarios, and technical requirements.

Updated `DocumentOperator.sln` to include the new documentation
files under a "Solution Items" section for better visibility.

Defined a prioritization strategy for feature implementation,
technical requirements, and a comprehensive test strategy.
Referenced relevant standards (e.g., PDF/A, ZUGFeRD) and
documented usage of the DevExpress Office File API.
2026-07-06 10:33:01 +02:00
166 changed files with 13880 additions and 2574 deletions

726
AGENTS.md Normal file
View File

@@ -0,0 +1,726 @@
# AGENTS.md
Agent guidance for DocumentService service. Read this before working on the codebase.
---
## ⚠️ CRITICAL: Architecture Decision Change
**Previous developer used Minimal API** (`DocumentEndpoints.cs`), but this is **WRONG**.
**YOU MUST use Controller-based approach** as specified in `CONTROLLER_ENDPOINTS.md`.
### Key Differences
| Previous Approach (WRONG) | Required Approach (CORRECT) |
|---------------------------|------------------------------|
| Minimal API (`DocumentEndpoints.cs`) | **Controllers** (`PdfValidationController`, etc.) |
| Only Base64 JSON | **Both multipart/form-data AND Base64 JSON** |
| `/api/v1/documents/validate` | **`/api/pdf/validation/validate`** |
**Do NOT follow ROADMAP.md's "Minimal API" guidance.** It conflicts with the requirements.
### Migration Required
**Existing code that needs replacement:**
- `DocumentService.API/Endpoints/v1/DocumentEndpoints.cs` → Delete, replace with Controllers
- `Program.cs` line 72: `app.MapDocumentEndpoints()` → Replace with `app.MapControllers()`
- `Program.cs` line 44: Add `builder.Services.AddControllers()`
- All DTOs → Support **BOTH** `IFormFile` (multipart) AND `Base64String` (JSON)
**Dual Input Support Required:**
- Controllers must accept **BOTH** file upload (multipart/form-data) and Base64 JSON
- Each endpoint should have overloads or flexible parameter binding
- Preserve existing Base64 functionality while adding file upload support
---
## Architecture & Development Approach
**Clean Architecture with Controller-Based API:**
- 4 layers: API → Application → Infrastructure → Domain
- Domain has **ZERO** external dependencies (only standard .NET)
- Feature-driven development: complete one feature end-to-end before starting the next
- Feature = Domain + Infrastructure + Application + **Controller** + Tests + Swagger (all layers)
**Dependency flow (enforced):**
```
API → Application → Domain
API → Infrastructure → Application
Infrastructure → Application (for interfaces only)
Domain → NOTHING
```
**Vertical Slice structure** (NOT horizontal layers):
```
Features/Documents/
├── ValidatePdf/
│ ├── ValidatePdfQuery.cs (request)
│ ├── ValidatePdfHandler.cs (logic)
│ └── ValidatePdfValidator.cs (validation)
└── ExtractSwissQrCode/
├── ExtractSwissQrCodeQuery.cs
├── ExtractSwissQrCodeHandler.cs
└── ExtractSwissQrCodeValidator.cs
```
All files for a feature live together. Do NOT create separate Commands/, Handlers/, Validators/ folders.
---
## 🏗️ Architecture Principles
### Clean Architecture (Pragmatic)
**4 Layers with strict dependency rules:**
- API → Application → Domain
- Infrastructure → Application (interfaces only)
- Domain → NOTHING (zero external dependencies)
**Key Principles:**
- ✅ Testability (Application layer mocks Infrastructure services)
- ✅ Replaceability (swap DevExpress without touching Application)
- ✅ Separation of Concerns
- ❌ NO overengineering (only what we need, YAGNI principle)
- ❌ NO speculative abstractions (wait for 2nd use case)
### CQRS with MediatR
**Why MediatR:**
- 1 Command/Query = 1 Handler = 1 Responsibility
- Isolated, testable handlers
- Pipeline Behaviors (Validation, Logging) run centrally
- Avoids bloated services with 20+ methods
**Pattern:**
- **Command:** Modifies data (ApplyStamp, EmbedCertificate)
- **Query:** Reads data (ValidatePdf returns metadata only)
**Pipeline:** ValidationBehavior → LoggingBehavior → Handler
### Vertical Slice Architecture
**NOT Horizontal** (Commands/, Handlers/, Validators/ folders)
**YES Vertical** (all files for one feature together)
**Benefits:**
- Related code stays together (high cohesion)
- Easier to find ("Where's ValidatePdf?" → one folder!)
- Easier to modify (all files in same folder)
- Fewer merge conflicts in teams
### Exception-Based Error Handling
**NO Result<T> pattern library**
**Flow:**
1. FluentValidation (DTO level) → ValidationException → 400
2. Domain validation → DomainValidationException → 400
3. Business logic → DomainException → 400/404
4. Infrastructure → PdfProcessingException → 500
**Middleware:** Central exception handler maps exceptions to HTTP status codes
**Why exceptions:**
- Simpler code (no `if (result.IsSuccess)` everywhere)
- Less boilerplate (no Result<T> wrapping)
- Standard .NET exception flow
- Centralized error handling (one place to maintain)
### Feature-Driven Development
**Feature-Driven (NOT Layer-by-Layer):**
- Complete one feature end-to-end before starting next
- Feature = Domain + Infrastructure + Application + API + Tests + Swagger
- Feature is DONE when testable in Swagger UI
**Why:**
- Faster value delivery (Feature 1 done in ~1 day)
- Clear definition of done (Swagger testable)
- Less complexity (not all layers in parallel)
- Better learning (pattern repeats)
**Alternative rejected:** Complete all Domain → all Infrastructure → all Application → all API
**Problem:** Too much speculative code without visible results
### Test-Driven Development (TDD)
**Flow:** Red → Green → Refactor
**Test Pyramid:**
- **Unit Tests (many):** Value Objects, Handlers, Services
- **Integration Tests (some):** Endpoints, MediatR Pipeline
- **E2E Tests (few/none):** API is already top-level
**Why TDD:**
- Tests as documentation
- Tests as safety net for refactoring
- Better design (testable = good code)
- No forgotten tests (test comes FIRST)
### Cross-Cutting Concerns Timing
**Multi-Tenancy Implementation Deferred**
**Decision:** Implement multi-tenancy (X-API-Key header, tenant database, Redis cache) AFTER all synchronous PDF operation features are complete.
**Why:**
- Multi-tenancy affects ALL endpoints
- Better to implement once for all features (avoid repetition)
- Easier to test features first without tenancy, then add tenancy layer
- Cleaner separation: Features first, then cross-cutting concerns
**Impact on current architecture:**
- ❌ NO Entity Framework yet (tenant database comes with multi-tenancy)
- ❌ NO Redis yet (API key caching comes with multi-tenancy)
- ❌ NO X-API-Key authentication yet (comes with multi-tenancy)
- ✅ All features currently work without authentication
**When to implement:**
After completing all Phase 1-3 controllers (PdfValidation, PdfAttachment, SwissQrCode, PdfOperations, PdfConversion), then add multi-tenancy to ALL endpoints in one refactoring phase.
---
## Build, Test, Run
**Build:**
```powershell
dotnet build
```
**Run tests (101 passed, 7 skipped as of Feature 7 - PDF Stamp):**
```powershell
dotnet test
```
**Run API (Development):**
```powershell
dotnet run --project DocumentService.API
```
Swagger UI: `https://localhost:7186/swagger`
Serilog UI: `https://localhost:7186/serilog-ui` (Web-based log viewer)
**Target framework:** .NET 8.0
**SDK required:** 8.0.412 or later (repo has 8.0.41210.0.203 available)
---
## Key Libraries & Their Roles
| Library | Purpose | Where Used |
|---------|---------|------------|
| **DevExpress.Document.Processor** (26.1.3) | PDF operations (validation, QR extraction, attachments) | Infrastructure layer only |
| **Codecrete.SwissQRBill.Generator** (3.4.0) | Swiss QR Bill parsing (Standard 2.0) | Infrastructure.Services.QrCodeProcessing |
| **ZXing.Net.Bindings.Windows.Compatibility** (0.16.14) | QR code image decoding | Infrastructure.Services.QrCodeProcessing |
| **MediatR** (14.1.0) | CQRS: 1 handler per feature | Application layer |
| **FluentValidation** (12.1.1) | Request validation (runs via ValidationBehavior before handlers) | Application layer |
| **Serilog.AspNetCore** (10.0.0) | Structured logging | API layer |
| **Serilog.Sinks.SQLite** (7.0.0) | SQLite log persistence | API layer |
| **Serilog.UI** (3.2.0) + **Serilog.UI.SqliteProvider** (1.1.0) | Web-based log viewer UI | API layer |
**Critical:** DevExpress requires a license. All PDF operations use `DevExpress.Pdf.PdfDocumentProcessor`.
---
## Exception Handling Strategy
**No Result<T> pattern.** Use exceptions + central middleware.
**Flow:**
1. FluentValidation validates request DTOs → throws `ValidationException` → HTTP 400
2. Domain validation in Value Objects → throws `DomainValidationException` → HTTP 400
3. Business logic errors → throws `DomainException` subtypes → HTTP 400/404/500
4. Infrastructure errors (e.g., PDF parsing) → throws `PdfProcessingException` → HTTP 500
**Middleware maps exceptions to HTTP status codes** (`ExceptionHandlingMiddleware.cs`).
Do NOT add `if (result.IsSuccess)` checks. Throw exceptions for errors. The middleware handles the rest.
---
## Required Controllers & Endpoints
**See `CONTROLLER_ENDPOINTS.md` for complete specification.**
### Priority Order
**Phase 1 (PRIORITY):**
1. `PdfValidationController` 2 endpoints
- `POST /api/pdf/validation/validate` (Basic PDF validation)
- `POST /api/pdf/validation/validate-pdfa` (PDF/A conformance)
2. `PdfAttachmentController` check endpoint
- `POST /api/pdf/attachments/check` (Attachment detection)
3. `SwissQrCodeController` extract endpoint
- `POST /api/swissqrcode/extract` (Swiss QR Bill extraction)
4. `PdfAttachmentController` extract endpoint
- `POST /api/pdf/attachments/extract` (Extract attachments as ZIP)
5. `PdfOperationsController` merge endpoint
- `POST /api/pdf/operations/merge` (Merge multiple PDFs)
**Phase 2:**
6. `PdfOperationsController` stamp & annotate
- `POST /api/pdf/operations/stamp` (Add stamps)
- `POST /api/pdf/operations/annotate` (Add annotations)
7. `PdfAttachmentController` add attachment
- `POST /api/pdf/attachments/add` (Embed attachments in PDF/A-3)
**Phase 3:**
8. `PdfConversionController` PDF ↔ PDF/A conversion
- `POST /api/pdf/conversion/to-pdfa` (Convert to PDF/A)
- `POST /api/pdf/conversion/from-pdfa` (Convert from PDF/A)
**Removed:**
- `PdfRenderController` Moved to .NET client library (WinForms/WPF DevExpress controls)
### Current Status
| Controller | Status | Tests |
|-----------|--------|-------|
| **PdfValidationController** | ✅ DONE | 13 (7 validate + 6 validate-pdfa) |
| **SwissQrCodeController** | ✅ DONE | 2 |
| **PdfAttachmentController** | ⏳ Partial (2/3 endpoints) | 10 (4 check + 6 extract) |
| **PdfOperationsController** | ⏳ Partial (3/3 endpoints, integration tests pending) | 29 (7 merge + 22 annotate: 12 unit + 10 integration) |
| **PdfConversionController** | ⏳ Pending | 0 |
**PdfAttachmentController Status:**
-`POST /api/pdf/attachments/check` - DONE (with multipart + Base64 support)
-`POST /api/pdf/attachments/extract` - DONE (Phase 1, Priority 4) - Returns ZIP with all attachments
-`POST /api/pdf/attachments/add` - TODO (Phase 2, Priority 7)
**PdfOperationsController Status:**
-`POST /api/pdf/operations/merge` - DONE (Phase 1, Priority 5) - Merges multiple PDFs with optional page ranges (multipart + Base64)
-`POST /api/pdf/operations/annotate` - DONE (Phase 2, Priority 6) - Adds annotations (TextMarkup/FreeText/StickyNote/Circle/Square) with multipart + Base64 support
-`POST /api/pdf/operations/stamp` - DONE (Phase 2, Priority 6) - Adds text/image/predefined stamps (multipart + Base64 support, origin/rotation/opacity/placement)
**Note:** PdfRenderController removed - moved to .NET client library.
---
## Adding a New Feature
**Required steps (follow CONTROLLER_ENDPOINTS.md):**
1. **Domain:** Value Objects, Exceptions (if needed)
2. **Infrastructure:** Service interface + DevExpress implementation + unit tests
3. **Application:** Query/Command + Handler + FluentValidator + DTOs + unit tests
4. **API:** **Controller** + actions + integration tests
5. **Swagger:** XML comments on controller actions + DTOs
**Example (PdfValidationController):**
```
Step 1: Application/Features/Documents/ValidatePdf/
- ValidatePdfCommand.cs (record)
- ValidatePdfHandler.cs (IRequestHandler)
- ValidatePdfValidator.cs (AbstractValidator)
Step 2: API/Controllers/PdfValidationController.cs
- [HttpPost("validate")] action
- Accepts IFormFile (multipart/form-data)
- Returns ValidatePdfResponse
Step 3: XML comments + [ProducesResponseType] attributes
```
**CRITICAL: Support BOTH multipart/form-data AND Base64 JSON for all file-based endpoints.**
**Input Flexibility:**
- Primary: `IFormFile` (multipart/form-data) - for direct file uploads
- Secondary: `Base64String` (application/json) - for API clients that can't send multipart
Do NOT skip steps. Each feature is done when it's **testable in Swagger UI with both input methods**.
---
## Test Data
**Embedded test PDFs:**
- `TestData/Pdfs/valid.pdf` (simple PDF for validation)
- `TestData/Pdfs/pdfWithSwissQRCode.pdf` (Swiss QR Code on last page)
- `TestData/Pdfs/pdfWithMoreThanOneAttachment.pdf` (6 attachments)
**All test PDFs are EmbeddedResource.** Access via:
```csharp
var stream = Assembly.GetExecutingAssembly()
.GetManifestResourceStream("DocumentService.Tests.TestData.Pdfs.valid.pdf");
```
**Do NOT commit new binary files** without marking them as `<EmbeddedResource>`.
---
## Test Structure & Strategy
**3-folder structure (CORRECT approach by previous developer):**
```
DocumentService.Tests/
├── Integration/
│ └── API/
│ ├── PdfValidationControllerTests.cs (13 tests)
│ └── ExtractSwissQrCodeEndpointTests.cs (2 tests)
├── TestData/
│ └── Pdfs/ (EmbeddedResource PDFs)
├── Unit/
│ ├── Application/
│ │ └── Features/
│ │ ├── ValidatePdf/
│ │ │ └── ValidatePdfHandlerTests.cs (2 tests)
│ │ ├── ValidatePdfA/
│ │ │ └── ValidatePdfAQueryHandlerTests.cs (4 tests)
│ │ └── ExtractSwissQrCode/
│ │ └── ExtractSwissQrCodeHandlerTests.cs (2 tests)
│ └── Infrastructure/
│ └── Services/
│ └── PdfProcessing/
│ └── DevExpressPdfProcessorTests.cs (7 tests)
```
**✅ Why this structure is CORRECT:**
1. **Integration vs Unit separation:**
- **Integration:** WebApplicationFactory → REAL API calls (HTTP, middleware, MediatR pipeline, DevExpress)
- **Unit:** Mock-based ISOLATED tests (Handler only depends on mocked IPdfProcessor)
2. **TestData centralization:**
- All 3 layers share same EmbeddedResource PDFs (no duplication)
- Accessed via `Assembly.GetManifestResourceStream()`
3. **Vertical Slice compliance:**
- `Unit/Application/Features/ValidatePdf/` → Each feature's tests co-located
- Matches Application layer structure exactly
4. **Test Pyramid:**
- **Unit tests (60+):** Fast, isolated, many scenarios
- **Integration tests (27):** Slower, full pipeline, critical paths only
**Test count:** 101 passed, 7 skipped (as of Feature 6 - PDF Annotation)
**Test breakdown by feature:**
- Feature 1 (PDF Validation): 13 integration tests
- Feature 2 (Swiss QR Code): 2 integration tests
- Feature 3 (PDF/A Validation): 6 integration tests (validate-pdfa) + 4 unit tests (handler)
- Feature 4 (PDF Attachments): 10 tests (4 check + 6 extract integration)
- Feature 5 (PDF Merge): 7 integration + 10 unit tests (DevExpressPdfProcessor)
- Feature 6 (PDF Annotation): 10 integration + 12 unit tests (DevExpressPdfProcessor)
- Infrastructure: 37 unit tests (DevExpressPdfProcessor for validation, attachments, merge, annotation)
**FluentValidation in tests:**
- Base64 format validation happens in `ValidatePdfQueryValidator` and `ValidatePdfAQueryValidator`
- Prevents `FormatException` from reaching handler (caught as 400 Bad Request, not 500)
- Unit tests verify handler behavior with valid inputs only
- Integration tests verify full validation pipeline (including FluentValidation)
---
## Swiss QR Code Feature (Feature 2)
**Swiss QR Bill Standard 2.0** requires:
- QR code is on the **last page** of the PDF (not first!)
- Use `DevExpress.Pdf.PdfDocumentProcessor` to render last page as image
- Use `ZXing` to decode QR code from image
- Use `Codecrete.SwissQRBill.Generator` to parse Swiss QR Bill payload
**Known quirks:**
- PDF must be rendered at **300 DPI** for reliable QR detection
- Alternative procedure parameters (AV1, AV2) are split by newline, not semicolon
---
## MediatR Pipeline Behaviors
**Two behaviors run for EVERY request:**
1. **ValidationBehavior** (runs first): Executes all `IValidator<TRequest>` and throws `ValidationException` if invalid
2. **LoggingBehavior** (runs second): Logs request name + execution time
**Registered in:** `Application/DependencyInjection.cs`
Do NOT manually call validators in handlers. The pipeline does it.
---
## Controller Pattern (CORRECT Approach)
**Controllers must support BOTH file upload and Base64 input.**
### Option 1: Separate Endpoints (Recommended)
```csharp
[ApiController]
[Route("api/pdf/validation")]
public class PdfValidationController : ControllerBase
{
private readonly IMediator _mediator;
public PdfValidationController(IMediator mediator)
{
_mediator = mediator;
}
/// <summary>
/// Validates a PDF document (multipart/form-data)
/// </summary>
[HttpPost("validate")]
[Consumes("multipart/form-data")]
[ProducesResponseType(typeof(ValidatePdfResponse), 200)]
[ProducesResponseType(typeof(ProblemDetails), 400)]
public async Task<IActionResult> ValidateFromFile(IFormFile file, CancellationToken ct)
{
using var ms = new MemoryStream();
await file.CopyToAsync(ms, ct);
byte[] pdfBytes = ms.ToArray();
var command = new ValidatePdfCommand(pdfBytes);
var result = await _mediator.Send(command, ct);
return Ok(result);
}
/// <summary>
/// Validates a PDF document (Base64 JSON)
/// </summary>
[HttpPost("validate")]
[Consumes("application/json")]
[ProducesResponseType(typeof(ValidatePdfResponse), 200)]
[ProducesResponseType(typeof(ProblemDetails), 400)]
public async Task<IActionResult> ValidateFromBase64(
[FromBody] ValidatePdfRequest request,
CancellationToken ct)
{
var query = new ValidatePdfQuery(Base64String.Create(request.Base64Pdf));
var result = await _mediator.Send(query, ct);
return Ok(result);
}
}
```
### Option 2: Single Endpoint with Model Binding
```csharp
public class PdfInputModel
{
public IFormFile? File { get; set; }
public string? Base64Pdf { get; set; }
}
[HttpPost("validate")]
public async Task<IActionResult> Validate([FromForm] PdfInputModel input, CancellationToken ct)
{
byte[] pdfBytes = input.File != null
? await GetBytesFromFile(input.File)
: Base64String.Create(input.Base64Pdf!).ToByteArray();
// Process...
}
```
**Use Controllers, NOT Minimal API endpoints.**
---
## Configuration
**appsettings.json sections:**
- `DocumentServiceSettings` (future: file size limits, temp paths)
- `RedisSettings` (future: multi-tenancy caching)
- `ApiKeySettings` (future: authentication)
**Currently:** All features work without authentication. Multi-tenancy is deferred until after all sync features are complete.
---
## Coding Standards
### Primary Constructors
**ALWAYS use primary constructors** (C# 12 feature) unless there's a technical limitation.
**✅ Correct:**
```csharp
public class PdfValidationController(IMediator mediator, ILogger<PdfValidationController> logger) : ControllerBase
{
// Use parameters directly, no field declarations needed
public async Task<IActionResult> Validate(...)
{
await mediator.Send(...);
}
}
```
**❌ Wrong:**
```csharp
public class PdfValidationController : ControllerBase
{
private readonly IMediator _mediator;
private readonly ILogger<PdfValidationController> _logger;
public PdfValidationController(IMediator mediator, ILogger<PdfValidationController> logger)
{
_mediator = mediator;
_logger = logger;
}
}
```
### Controller Responsibilities
**Controllers should be thin.** Do NOT add mapping logic.
**✅ Correct:**
```csharp
public async Task<IActionResult> Validate([FromBody] ValidatePdfRequest request, CancellationToken ct)
{
// Direct pass-through to MediatR
var result = await mediator.Send(request, ct);
return Ok(result);
}
```
**❌ Wrong:**
```csharp
public async Task<IActionResult> Validate([FromBody] ValidatePdfRequest request, CancellationToken ct)
{
// Manual mapping (WRONG!)
var command = new ValidatePdfCommand(request.Base64Pdf);
var metadata = await mediator.Send(command, ct);
var response = new ValidatePdfResponse(metadata.PageCount, ...);
return Ok(response);
}
```
**If mapping is absolutely necessary:** Use AutoMapper.
### Request DTOs - Flexible Input
**Support BOTH `byte[]` and `Base64String` in requests.**
```csharp
public record ValidatePdfRequest
{
public byte[]? PdfBytes { get; init; }
public string? Base64Pdf { get; init; }
}
```
**FluentValidation:** Ensure exactly ONE is provided:
```csharp
public class ValidatePdfRequestValidator : AbstractValidator<ValidatePdfRequest>
{
public ValidatePdfRequestValidator()
{
RuleFor(x => x)
.Must(x => (x.PdfBytes != null && x.PdfBytes.Length > 0) ^
(!string.IsNullOrWhiteSpace(x.Base64Pdf)))
.WithMessage("Either PdfBytes or Base64Pdf must be provided, but not both");
}
}
```
**Handler:** Use `byte[]` if available, otherwise convert Base64:
```csharp
public async Task<PdfMetadata> Handle(ValidatePdfRequest request, CancellationToken ct)
{
byte[] pdfBytes = request.PdfBytes ?? Convert.FromBase64String(request.Base64Pdf!);
return await _processor.ValidateAsync(pdfBytes);
}
```
### No Unnecessary Value Objects
**Do NOT create value objects for simple types** (e.g., Base64String).
**❌ Wrong:** Creating `Base64String` value object just to wrap `string`
**✅ Correct:** Use `string` directly + extension methods if needed
**Why:**
- Performance overhead (validation runs twice: once in value object, once in FluentValidation)
- Unnecessary abstraction (YAGNI principle)
- `Convert.FromBase64String()` already validates format
### Exception Handling in Controllers
**Let FormatException bubble up naturally.** ExceptionHandlingMiddleware will catch it.
```csharp
// Handler
byte[] pdfBytes = request.PdfBytes ?? Convert.FromBase64String(request.Base64Pdf!);
// If Base64 is invalid, FormatException → Middleware → 400 Bad Request
```
**Middleware handles:**
- `FormatException` → 400 Bad Request
- `ValidationException` → 400 Bad Request
- `DomainException` → 400/404
- `PdfProcessingException` → 500
---
## Git Commit Guidelines
### ⚠️ CRITICAL: Never Commit Without Approval
**NEVER run `git commit` without explicit user approval.**
### Systematic Commits
**Do NOT commit everything in one giant commit.**
**✅ Correct approach:**
1. Complete one logical change (e.g., "Add PdfValidationController")
2. Stage only related files: `git add <specific-files>`
3. Ask user: "Ready to commit 'Add PdfValidationController'?"
4. After approval: `git commit -m "Add PdfValidationController with dual input support"`
5. Repeat for next logical change
**❌ Wrong approach:**
```bash
git add -A
git commit -m "Migrate everything to controllers, update tests, add AGENTS.md, delete ROADMAP.md"
# This is TOO MUCH in one commit!
```
**Good commit messages:**
- `feat: Add PdfValidationController with multipart/form-data support`
- `refactor: Replace Base64String value object with direct string usage`
- `test: Add integration tests for PdfValidationController`
- `docs: Add AGENTS.md with architecture guidance`
- `chore: Delete deprecated ROADMAP.md`
**Commit size guideline:** 1-5 files per commit, one logical change
---
## What NOT to Do
- ❌ Do NOT create horizontal folders (Commands/, Handlers/, Validators/)
- ❌ Do NOT add Entity Framework until multi-tenancy phase
- ❌ Do NOT use Minimal API endpoints (use Controllers instead)
- ❌ Do NOT support only ONE input type (must support BOTH multipart AND Base64)
- ❌ Do NOT use Result<T> pattern (use exceptions)
- ❌ Do NOT skip tests (TDD: write test first, then implementation)
- ❌ Do NOT add dependencies to Domain layer (keep it clean!)
- ❌ Do NOT commit without user approval
- ❌ Do NOT use old-style constructors (use primary constructors)
- ❌ Do NOT add mapping logic in controllers (keep them thin)
- ❌ Do NOT create unnecessary value objects (YAGNI principle)
---
## Debugging Tips
**DevExpress PDF errors:**
- Check if file is actually a valid PDF (magic bytes: `%PDF-`)
- DevExpress throws generic exceptions; wrap in try-catch and add context
**Swiss QR Code not found:**
- Verify QR is on **last page** (not first)
- Check DPI setting (300 DPI required, see ROADMAP.md Feature 2)
- Use `ZXing` with `TryHarder` hint enabled
**Attachment count wrong:**
- Search entire PDF stream, not just first 1000 chars (see ROADMAP.md fix log 17.01.2025)
- Count `/EmbeddedFiles` object references correctly (not divided by 2)
---
## References
- **CONTROLLER_ENDPOINTS.md** **PRIMARY SOURCE** for API specification (all planned endpoints)
- **REQUIRED_FEATURES.md** Business requirements (what PDF operations are needed and why)
- **ROADMAP.md** Feature-by-feature implementation plan (1101 lines, detailed) **NOTE: Uses Minimal API, which is incorrect. Follow CONTROLLER_ENDPOINTS.md instead.**
- **DevExpress Docs** https://docs.devexpress.com/OfficeFileAPI/
- **Swiss QR Bill Standard** https://www.ferd-net.de/ (ZUGFeRD/XRechnung context)
**When implementing endpoints:** Follow CONTROLLER_ENDPOINTS.md, NOT ROADMAP.md's Minimal API approach.

352
CONTROLLER_ENDPOINTS.md Normal file
View File

@@ -0,0 +1,352 @@
# DocumentService - Controller & Endpoint Specification
**Project:** DocumentService (DOC)
**Ticket:** DOC-1 - GDPicture and Nutrient Replacing
**Owner:** Hakan Tek
**Date:** July 3, 2026
---
## Overview
This specification defines the controller structure and REST API endpoints for the DocumentService service.
---
## PdfValidationController
### Endpoint: PDF Validation
**Route:** `POST /api/pdf/validation/validate`
**Function:** Checks whether the file is a valid PDF, whether it is corrupted, and returns basic information
**Input:**
- PDF file (multipart/form-data)
**Output:**
```json
{
"isValid": bool,
"pdfVersion": string,
"pageCount": int,
"fileSize": long,
"encrypted": bool,
"errors": string[]
}
```
**Usage:** All products - basic PDF input check
---
### Endpoint: PDF/A Validation
**Route:** `POST /api/pdf/validation/validate-pdfa`
**Function:** PDF/A conformance check (embedded fonts, encryption, JavaScript, etc.)
**Input:**
- PDF file (multipart/form-data)
**Output:**
```json
{
"isValid": bool,
"pdfaVersion": string,
"pageCount": int,
"errors": string[],
"warnings": string[]
}
```
**Usage:** taskFLOW, eParser - ensuring PDF/A conformance
---
## PdfAttachmentController
### Endpoint: Attachment Check
**Route:** `POST /api/pdf/attachments/check`
**Function:** Detects whether embedded files (e.g. ZUGFeRD XML) are present in the PDF
**Input:**
- PDF file (multipart/form-data)
**Output:**
```json
{
"hasAttachments": bool,
"attachmentCount": int,
"attachments": [
{
"fileName": string,
"mimeType": string,
"size": long
}
]
}
```
**Usage:** eParser (ZUGFeRD), ErgebnisberichtCreator
---
### Endpoint: Attachment Extraction
**Route:** `POST /api/pdf/attachments/extract`
**Function:** Extracts all embedded files from the PDF and returns them as a ZIP archive
**Input:**
- PDF file (multipart/form-data)
**Output:**
- Binary stream (application/zip)
- Content-Disposition: attachment; filename="attachments.zip"
- ZIP archive containing all extracted files
**Usage:** eParser (ZUGFeRD XML extraction)
---
### Endpoint: Add Attachment
**Route:** `POST /api/pdf/attachments/add`
**Function:** Embeds one or more files as attachments in a PDF (supports PDF/A-3)
**Input:**
- PDF file (multipart/form-data)
- Attachment files (multipart/form-data, multiple)
**Output:**
- Binary stream (application/pdf)
- Content-Disposition: attachment; filename="with-attachments.pdf"
- PDF with embedded attachments
**Usage:** eParser (ZUGFeRD XML embedding), PDF/A-3 archiving
---
## PdfOperationsController
### Endpoint: PDF Merge
**Route:** `POST /api/pdf/operations/merge`
**Function:** Merges multiple PDFs into a single file
**Input:**
- Multiple PDF files (multipart/form-data)
- Field name: "files" (array of IFormFile)
**Output:**
- Binary stream (application/pdf)
- Content-Disposition: attachment; filename="merged.pdf"
- Merged PDF document
**Usage:** signFLOW (Envelope Generator), ErgebnisberichtCreator, ResultHandler (windream)
---
### Endpoint: PDF Stamp
**Route:** `POST /api/pdf/operations/stamp`
**Function:** Adds stamps to PDF pages (APPROVED, CONFIDENTIAL, etc.)
**Input:**
- PDF file (multipart/form-data)
- Stamp configuration (JSON):
```json
{
"text": string,
"position": string,
"pages": string,
"color": string,
"opacity": float
}
```
**Output:**
- Binary stream (application/pdf)
- Content-Disposition: attachment; filename="stamped.pdf"
- PDF with applied stamps
**Usage:** ErgebnisberichtCreator
---
### Endpoint: PDF Annotate
**Route:** `POST /api/pdf/operations/annotate`
**Function:** Adds comments, highlights, and markings to the PDF
**Input:**
- PDF file (multipart/form-data)
- Annotations (JSON):
```json
{
"annotations": [
{
"type": string,
"page": int,
"position": object,
"text": string
}
]
}
```
**Output:**
- Binary stream (application/pdf)
- Content-Disposition: attachment; filename="annotated.pdf"
- PDF with applied annotations
**Usage:** signFLOW (Envelope Generator)
---
## SwissQrCodeController
### Endpoint: Swiss QR Code Extraction
**Route:** `POST /api/swissqrcode/extract`
**Function:** Extracts and parses Swiss QR Bill (Swiss QR Code) from PDF
**Input:**
- PDF file (multipart/form-data)
**Output:**
```json
{
"qrType": "SwissQrBill",
"version": "0200",
"creditorIban": "CH4431999123000889012",
"creditorName": "Example AG",
"creditorAddress": {
"addressType": "Structured",
"street": "Musterstrasse",
"houseNumber": "1",
"postalCode": "8000",
"city": "Zürich",
"country": "CH"
},
"amount": 1234.56,
"currency": "CHF",
"debtorName": "Max Mustermann",
"debtorAddress": { ... },
"referenceType": "QRR",
"reference": "210000000003139471430009017",
"unstructuredMessage": "Invoice #12345",
"billInformation": "//S1/10/12345",
"alternativeProcedures": ["UV1", "UV2"]
}
```
**Usage:** eParser (Swiss QR Bill processing), signFLOW (payment reference extraction)
**Note:** Supports only Structured Address (S-Type) as per Swiss QR Bill Standard 2.0. Combined Address (K-Type) deprecated November 21, 2025.
---
## PdfRenderController
**Status:** REMOVED - PDF preview functionality will be implemented in .NET client library using DevExpress WinForms/WPF controls. Server-side rendering is unnecessary CPU/memory overhead.
---
## PdfConversionController
### Endpoint: Convert PDF to PDF/A
**Route:** `POST /api/pdf/conversion/to-pdfa`
**Function:** Converts a standard PDF to PDF/A
**Input:**
- PDF file (multipart/form-data)
- PDF/A level (query parameter): "PDF/A-1b", "PDF/A-2b", "PDF/A-3b"
**Output:**
- Binary stream (application/pdf)
- Content-Disposition: attachment; filename="converted-pdfa.pdf"
- PDF/A compliant document
**Usage:** taskFLOW (optional conversion)
---
### Endpoint: Convert PDF/A to PDF
**Route:** `POST /api/pdf/conversion/from-pdfa`
**Function:** Converts PDF/A to a standard PDF
**Input:**
- PDF/A file (multipart/form-data)
**Output:**
- Binary stream (application/pdf)
- Content-Disposition: attachment; filename="converted-pdf.pdf"
- Standard PDF document
**Usage:** taskFLOW (optional conversion)
---
## Technical Specifications
### Framework Support
- ✓ .NET Core (3.1+, 6.0+, 8.0+)
- ✓ .NET Framework (4.7.2+, 4.8+)
### Client Usage
The service can be used on the client side **without manual HTTP response handling**:
- Provide REST client wrapper
- SDK for C# clients
- Automatic serialization/deserialization
- Abstracted error handling
**Example Client SDK:**
```csharp
var client = new DocumentServiceClient("https://api.example.com");
var result = await client.Pdf.Validation.ValidateAsync(pdfFile);
if (result.IsValid) { ... }
```
### Response Format
- Default: JSON (for metadata endpoints like validation, check)
- Binary streams: application/pdf, application/zip (for operations, conversion, extraction)
- Content-Disposition header: attachment; filename="<output-filename>"
- Errors: HTTP Status Codes (400, 404, 500) + JSON error object
- Success: HTTP 200 + JSON/Binary response
**Binary Stream Endpoints:**
- PDF Operations: merge, stamp, annotate
- PDF Conversion: to-pdfa, from-pdfa
- Attachment Operations: extract (ZIP), add (PDF)
**JSON Response Endpoints:**
- PDF Validation: validate, validate-pdfa
- Attachment Check: check
- Swiss QR Code: extract
### Authentication
- API Key (Header: `X-API-Key`)
- Optional: OAuth2/JWT for advanced scenarios
### Swagger/OpenAPI
- Complete API documentation
- Interactive test UI
- Code generation for clients
---
## Prioritization
### Phase 1 (Priority)
1. PdfValidationController - both endpoints (validate, validate-pdfa)
2. PdfAttachmentController - check endpoint
3. SwissQrCodeController - extract endpoint (already implemented)
4. PdfAttachmentController - extract endpoint
5. PdfOperationsController - merge endpoint
### Phase 2
6. PdfOperationsController - stamp & annotate endpoints
7. PdfAttachmentController - add attachment endpoint
### Phase 3
8. PdfConversionController - both endpoints (to-pdfa, from-pdfa)
### Removed
- PdfRenderController - moved to .NET client library (WinForms/WPF DevExpress controls)
---
**Last Updated:** July 3, 2026
**Author:** Hakan Tek
**Status:** Draft - Awaiting Feedback

View File

@@ -0,0 +1,125 @@
using Microsoft.AspNetCore.Mvc.ApiExplorer;
using Microsoft.OpenApi.Models;
using Swashbuckle.AspNetCore.SwaggerGen;
namespace DocumentService.API.Configuration
{
/// <summary>
/// Swagger document filter that merges operations with same path but different [Consumes] attributes.
/// Ensures both multipart/form-data and application/json variants are visible in Swagger UI.
/// </summary>
public class DualInputDocumentFilter : IDocumentFilter
{
private readonly IApiDescriptionGroupCollectionProvider _apiDescriptionProvider;
/// <summary>
/// Initializes a new instance of the <see cref="DualInputDocumentFilter"/> class.
/// </summary>
/// <param name="apiDescriptionProvider">API description provider to access all endpoints</param>
public DualInputDocumentFilter(IApiDescriptionGroupCollectionProvider apiDescriptionProvider)
{
_apiDescriptionProvider = apiDescriptionProvider;
}
/// <summary>
/// Applies the filter to merge operations with different content types.
/// </summary>
public void Apply(OpenApiDocument swaggerDoc, DocumentFilterContext context)
{
var allApiDescriptions = _apiDescriptionProvider.ApiDescriptionGroups.Items
.SelectMany(g => g.Items)
.ToList();
// Group by path
var groupedByPath = allApiDescriptions
.GroupBy(x => "/" + x.RelativePath)
.ToList();
foreach (var group in groupedByPath)
{
var path = group.Key;
if (!swaggerDoc.Paths.ContainsKey(path))
continue;
var pathItem = swaggerDoc.Paths[path];
// Find multipart and JSON variants
var multipartDesc = group.FirstOrDefault(x =>
x.SupportedRequestFormats.Any(f => f.MediaType == "multipart/form-data"));
var jsonDesc = group.FirstOrDefault(x =>
x.SupportedRequestFormats.Any(f => f.MediaType == "application/json"));
// If we have both variants, merge them into single operation
if (multipartDesc != null && jsonDesc != null)
{
var httpMethod = multipartDesc.HttpMethod?.ToLowerInvariant();
OperationType operationType;
if (!Enum.TryParse<OperationType>(httpMethod, true, out operationType))
continue;
if (!pathItem.Operations.ContainsKey(operationType))
continue;
var operation = pathItem.Operations[operationType];
// Ensure RequestBody exists
if (operation.RequestBody == null)
{
operation.RequestBody = new OpenApiRequestBody
{
Required = true,
Content = new Dictionary<string, OpenApiMediaType>()
};
}
// Add multipart/form-data if missing
if (!operation.RequestBody.Content.ContainsKey("multipart/form-data"))
{
operation.RequestBody.Content.Add("multipart/form-data", new OpenApiMediaType
{
Schema = new OpenApiSchema
{
Type = "object",
Properties = new Dictionary<string, OpenApiSchema>
{
["file"] = new OpenApiSchema
{
Type = "string",
Format = "binary",
Description = "PDF file to upload"
}
},
Required = new HashSet<string> { "file" }
}
});
}
// Add application/json if missing
if (!operation.RequestBody.Content.ContainsKey("application/json"))
{
operation.RequestBody.Content.Add("application/json", new OpenApiMediaType
{
Schema = new OpenApiSchema
{
Type = "object",
Properties = new Dictionary<string, OpenApiSchema>
{
["base64Pdf"] = new OpenApiSchema
{
Type = "string",
Format = "byte",
Description = "Base64-encoded PDF file content"
}
},
Required = new HashSet<string> { "base64Pdf" }
}
});
}
}
}
}
}
}

View File

@@ -1,5 +1,8 @@
namespace DocumentOperator.API.Configuration
namespace DocumentService.API.Configuration
{
/// <summary>
/// Placeholder class for Serilog configuration extensions.
/// </summary>
public class SerilogConfiguration
{
}

View File

@@ -1,21 +1,43 @@
using Microsoft.OpenApi.Models;
using Microsoft.Extensions.Options;
using Microsoft.OpenApi.Models;
using System.Reflection;
namespace DocumentOperator.API.Configuration
namespace DocumentService.API.Configuration
{
/// <summary>
/// Provides extension methods for configuring Swagger/OpenAPI documentation.
/// </summary>
public static class SwaggerConfiguration
{
public static IServiceCollection AddSwaggerDocumentation(this IServiceCollection services)
/// <summary>
/// Adds Swagger documentation generation to the service collection.
/// </summary>
/// <param name="services">The service collection to add Swagger to.</param>
/// <param name="configuration">Configuration to read SwaggerSettings from.</param>
/// <returns>The modified service collection.</returns>
public static IServiceCollection AddSwaggerDocumentation(
this IServiceCollection services,
IConfiguration configuration)
{
var swaggerSettings = configuration.GetSection(SwaggerSettings.SectionName).Get<SwaggerSettings>()
?? new SwaggerSettings();
services.AddSwaggerGen(options =>
{
options.SwaggerDoc("v1", new OpenApiInfo
options.SwaggerDoc(swaggerSettings.Version, new OpenApiInfo
{
Title = "DD Document Operator API",
Version = "v1",
Description = "PDF Verarbeitungs-Service für Validierung, Stempel, Zertifikate, Anhänge & Zusammenführung"
Title = swaggerSettings.Title,
Version = swaggerSettings.Version,
Description = swaggerSettings.Description
});
// Resolve conflicting actions: Keep first variant
// DualInputDocumentFilter will merge both variants into single operation
options.ResolveConflictingActions(apiDescriptions => apiDescriptions.First());
// Add document filter to merge operations with different content types
options.DocumentFilter<DualInputDocumentFilter>();
// XML-Kommentare einbinden
var xmlFile = $"{Assembly.GetExecutingAssembly().GetName().Name}.xml";
var xmlPath = Path.Combine(AppContext.BaseDirectory, xmlFile);

View File

@@ -0,0 +1,33 @@
namespace DocumentService.API.Configuration;
/// <summary>
/// Configuration settings for Swagger/OpenAPI documentation.
/// </summary>
public class SwaggerSettings
{
/// <summary>
///
/// </summary>
public const string SectionName = "SwaggerSettings";
/// <summary>
/// Enable Swagger UI in Production environment.
/// Default: true (allows production testing/debugging).
/// </summary>
public bool EnableInProduction { get; set; } = true;
/// <summary>
/// API title displayed in Swagger UI.
/// </summary>
public string Title { get; set; } = "DocumentService API";
/// <summary>
/// API version.
/// </summary>
public string Version { get; set; } = "v1";
/// <summary>
/// API description displayed in Swagger UI.
/// </summary>
public string Description { get; set; } = "PDF document processing service";
}

View File

@@ -0,0 +1,356 @@
using DocumentService.Application.AddAttachments;
using DocumentService.Application.CheckPdfAttachments.Queries;
using DocumentService.Application.Common.DTOs;
using DocumentService.Application.ExtractPdfAttachments;
using DocumentService.Client.Models.Requests;
using DocumentService.Domain.Common.Exceptions;
using MediatR;
using Microsoft.AspNetCore.Http;
using Microsoft.AspNetCore.Mvc;
namespace DocumentService.API.Controllers;
/// <summary>
/// Controller for PDF attachment operations (detection, extraction, embedding)
/// </summary>
[ApiController]
[Route("api/pdf/attachments")]
[Produces("application/json")]
public class PdfAttachmentController(IMediator mediator) : ControllerBase
{
/// <summary>
/// Checks if a PDF contains embedded files (attachments) and returns their metadata.
/// Supports multipart/form-data file upload.
/// </summary>
/// <param name="file">The PDF file to check for attachments</param>
/// <param name="cancellationToken">Cancellation token</param>
/// <returns>Attachment check result with metadata for all found attachments</returns>
/// <response code="200">PDF successfully checked - returns attachment details</response>
/// <response code="400">Invalid input (file missing, not a PDF, or corrupted)</response>
/// <response code="500">Internal server error during PDF processing</response>
[HttpPost("check")]
[Consumes("multipart/form-data")]
[ProducesResponseType(typeof(AttachmentCheckResult), StatusCodes.Status200OK)]
[ProducesResponseType(typeof(ProblemDetails), StatusCodes.Status400BadRequest)]
[ProducesResponseType(typeof(ProblemDetails), StatusCodes.Status500InternalServerError)]
public async Task<IActionResult> CheckAttachmentsFromFile(
IFormFile file,
CancellationToken cancellationToken)
{
// Use IFormFile stream directly (no intermediate byte[] conversion)
using var pdfStream = file.OpenReadStream();
// Send query to MediatR (ValidationBehavior runs automatically)
var query = new CheckPdfAttachmentsQuery { PdfStream = pdfStream };
var result = await mediator.Send(query, cancellationToken);
return Ok(result);
}
/// <summary>
/// Checks if a PDF contains embedded files (attachments) and returns their metadata.
/// Supports Base64-encoded PDF via JSON payload.
/// </summary>
/// <param name="request">Request containing Base64-encoded PDF</param>
/// <param name="cancellationToken">Cancellation token</param>
/// <returns>Attachment check result with metadata for all found attachments</returns>
/// <response code="200">PDF successfully checked - returns attachment details</response>
/// <response code="400">Invalid input (Base64 format error, not a PDF, or corrupted)</response>
/// <response code="500">Internal server error during PDF processing</response>
[HttpPost("check")]
[Consumes("application/json")]
[ProducesResponseType(typeof(AttachmentCheckResult), StatusCodes.Status200OK)]
[ProducesResponseType(typeof(ProblemDetails), StatusCodes.Status400BadRequest)]
[ProducesResponseType(typeof(ProblemDetails), StatusCodes.Status500InternalServerError)]
public async Task<IActionResult> CheckAttachmentsFromBase64(
[FromBody] CheckPdfAttachmentsRequest request,
CancellationToken cancellationToken)
{
// Convert Base64 to stream (wrap in try-catch to throw BadRequestException)
byte[] pdfBytes;
try
{
pdfBytes = Convert.FromBase64String(request.Base64Pdf);
}
catch (FormatException ex)
{
throw new BadRequestException("Invalid Base64 format: " + ex.Message);
}
using var pdfStream = new MemoryStream(pdfBytes);
// Send query to MediatR (ValidationBehavior runs automatically)
var query = new CheckPdfAttachmentsQuery { PdfStream = pdfStream };
var result = await mediator.Send(query, cancellationToken);
return Ok(result);
}
/// <summary>
/// Extracts all embedded files from a PDF and returns them as a ZIP archive.
/// Supports multipart/form-data file upload.
/// </summary>
/// <param name="file">The PDF file to extract attachments from</param>
/// <param name="cancellationToken">Cancellation token</param>
/// <returns>ZIP archive containing all extracted attachments</returns>
/// <response code="200">Attachments extracted successfully - returns ZIP file</response>
/// <response code="400">Invalid input (file missing, not a PDF, or corrupted)</response>
/// <response code="404">PDF contains no attachments</response>
/// <response code="500">Internal server error during PDF processing</response>
[HttpPost("extract")]
[Consumes("multipart/form-data")]
[ProducesResponseType(typeof(FileContentResult), StatusCodes.Status200OK)]
[ProducesResponseType(typeof(ProblemDetails), StatusCodes.Status400BadRequest)]
[ProducesResponseType(typeof(ProblemDetails), StatusCodes.Status404NotFound)]
[ProducesResponseType(typeof(ProblemDetails), StatusCodes.Status500InternalServerError)]
public async Task<IActionResult> ExtractAttachmentsFromFile(
IFormFile file,
CancellationToken cancellationToken)
{
// Use IFormFile stream directly (no intermediate byte[] conversion)
using var pdfStream = file.OpenReadStream();
// Send command to MediatR
var command = new ExtractPdfAttachmentsCommand { PdfStream = pdfStream };
byte[] zipBytes = await mediator.Send(command, cancellationToken);
// Return ZIP file
return File(zipBytes, "application/zip", "attachments.zip");
}
/// <summary>
/// Extracts all embedded files from a PDF and returns them as a ZIP archive.
/// Supports Base64-encoded PDF via JSON payload.
/// </summary>
/// <param name="request">Request containing Base64-encoded PDF</param>
/// <param name="cancellationToken">Cancellation token</param>
/// <returns>ZIP archive containing all extracted attachments</returns>
/// <response code="200">Attachments extracted successfully - returns ZIP file</response>
/// <response code="400">Invalid input (Base64 format error, not a PDF, or corrupted)</response>
/// <response code="404">PDF contains no attachments</response>
/// <response code="500">Internal server error during PDF processing</response>
[HttpPost("extract")]
[Consumes("application/json")]
[ProducesResponseType(typeof(FileContentResult), StatusCodes.Status200OK)]
[ProducesResponseType(typeof(ProblemDetails), StatusCodes.Status400BadRequest)]
[ProducesResponseType(typeof(ProblemDetails), StatusCodes.Status404NotFound)]
[ProducesResponseType(typeof(ProblemDetails), StatusCodes.Status500InternalServerError)]
public async Task<IActionResult> ExtractAttachmentsFromBase64(
[FromBody] ExtractPdfAttachmentsRequest request,
CancellationToken cancellationToken)
{
// Convert Base64 to stream (wrap in try-catch to throw BadRequestException)
byte[] pdfBytes;
try
{
pdfBytes = Convert.FromBase64String(request.Base64Pdf);
}
catch (FormatException ex)
{
throw new BadRequestException("Invalid Base64 format: " + ex.Message);
}
using var pdfStream = new MemoryStream(pdfBytes);
// Send command to MediatR
var command = new ExtractPdfAttachmentsCommand { PdfStream = pdfStream };
byte[] zipBytes = await mediator.Send(command, cancellationToken);
// Return ZIP file
return File(zipBytes, "application/zip", "attachments.zip");
}
/// <summary>
/// Embeds one or more files as attachments in a PDF document (supports PDF/A-3).
/// Supports multipart/form-data file upload.
/// </summary>
/// <param name="pdfFile">The PDF file to add attachments to</param>
/// <param name="attachmentFiles">Files to embed as attachments (one or more)</param>
/// <param name="cancellationToken">Cancellation token</param>
/// <returns>PDF with embedded attachments</returns>
/// <response code="200">Attachments added successfully - returns PDF</response>
/// <response code="400">Invalid input (file missing, not a PDF, or no attachments provided)</response>
/// <response code="500">Internal server error during PDF processing</response>
[Obsolete("This endpoint is not implemented yet.")]
[HttpPost("add")]
[Consumes("multipart/form-data")]
[ProducesResponseType(typeof(FileContentResult), StatusCodes.Status200OK)]
[ProducesResponseType(typeof(ProblemDetails), StatusCodes.Status400BadRequest)]
[ProducesResponseType(typeof(ProblemDetails), StatusCodes.Status500InternalServerError)]
public async Task<IActionResult> AddAttachmentsFromFile(
IFormFile pdfFile,
List<IFormFile> attachmentFiles,
CancellationToken cancellationToken)
{
if (pdfFile == null || pdfFile.Length == 0)
{
throw new BadRequestException("PDF file is required");
}
if (attachmentFiles == null || attachmentFiles.Count == 0)
{
throw new BadRequestException("At least one attachment file is required");
}
// Use IFormFile stream directly (no intermediate byte[] conversion)
using var pdfStream = pdfFile.OpenReadStream();
// Convert attachment files to AttachmentFile records
var attachments = new List<AttachmentFile>();
foreach (var file in attachmentFiles)
{
using var ms = new MemoryStream();
await file.CopyToAsync(ms, cancellationToken);
attachments.Add(new AttachmentFile
{
FileName = file.FileName,
Content = ms.ToArray(),
MimeType = file.ContentType
});
}
// Send command to MediatR
var command = new AddAttachmentsCommand
{
PdfStream = pdfStream,
Attachments = attachments
};
byte[] resultPdf = await mediator.Send(command, cancellationToken);
// Return PDF with attachments
return File(resultPdf, "application/pdf", "with-attachments.pdf");
}
/// <summary>
/// Embeds one or more files as attachments in a PDF document (supports PDF/A-3).
/// Supports Base64-encoded PDF and attachments via JSON payload.
/// </summary>
/// <param name="request">Request containing Base64-encoded PDF and attachments</param>
/// <param name="cancellationToken">Cancellation token</param>
/// <returns>PDF with embedded attachments</returns>
/// <response code="200">Attachments added successfully - returns PDF</response>
/// <response code="400">Invalid input (Base64 format error, not a PDF, or no attachments provided)</response>
/// <response code="500">Internal server error during PDF processing</response>
[Obsolete("This endpoint is not implemented yet.")]
[HttpPost("add")]
[Consumes("application/json")]
[ProducesResponseType(typeof(FileContentResult), StatusCodes.Status200OK)]
[ProducesResponseType(typeof(ProblemDetails), StatusCodes.Status400BadRequest)]
[ProducesResponseType(typeof(ProblemDetails), StatusCodes.Status500InternalServerError)]
public async Task<IActionResult> AddAttachmentsFromBase64(
[FromBody] AddAttachmentsRequest request,
CancellationToken cancellationToken)
{
// Convert Base64 PDF to stream
byte[] pdfBytes;
try
{
pdfBytes = Convert.FromBase64String(request.Base64Pdf);
}
catch (FormatException ex)
{
throw new BadRequestException("Invalid Base64 PDF format: " + ex.Message);
}
using var pdfStream = new MemoryStream(pdfBytes);
// Convert Base64 attachments to AttachmentFile records
var attachments = new List<AttachmentFile>();
foreach (var att in request.Attachments)
{
byte[] attBytes;
try
{
attBytes = Convert.FromBase64String(att.Base64Content);
}
catch (FormatException ex)
{
throw new BadRequestException($"Invalid Base64 format for attachment '{att.FileName}': " + ex.Message);
}
attachments.Add(new AttachmentFile
{
FileName = att.FileName,
Content = attBytes,
MimeType = att.MimeType
});
}
// Send command to MediatR
var command = new AddAttachmentsCommand
{
PdfStream = pdfStream,
Attachments = attachments
};
byte[] resultPdf = await mediator.Send(command, cancellationToken);
// Return PDF with attachments
return File(resultPdf, "application/pdf", "with-attachments.pdf");
}
}
/// <summary>
/// Request DTO for Base64-encoded PDF attachment check
/// </summary>
public record CheckPdfAttachmentsRequest
{
/// <summary>
/// PDF document encoded as Base64 string
/// </summary>
/// <example>JVBERi0xLjQKJeLjz9MKMSAwIG9iago8PC9UeXBlL0NhdGFsb2c...</example>
public string Base64Pdf { get; init; } = string.Empty;
}
/// <summary>
/// Request DTO for Base64-encoded PDF attachment extraction
/// </summary>
public record ExtractPdfAttachmentsRequest
{
/// <summary>
/// PDF document encoded as Base64 string
/// </summary>
/// <example>JVBERi0xLjQKJeLjz9MKMSAwIG9iago8PC9UeXBlL0NhdGFsb2c...</example>
public required string Base64Pdf { get; init; }
}
/// <summary>
/// Request DTO for Base64-encoded PDF with attachments to add
/// </summary>
public record AddAttachmentsRequest
{
/// <summary>
/// PDF document encoded as Base64 string
/// </summary>
/// <example>JVBERi0xLjQKJeLjz9MKMSAwIG9iago8PC9UeXBlL0NhdGFsb2c...</example>
public required string Base64Pdf { get; init; }
/// <summary>
/// List of attachments to embed
/// </summary>
public required List<AttachmentRequestDto> Attachments { get; init; }
}
/// <summary>
/// DTO for attachment file in request
/// </summary>
public record AttachmentRequestDto
{
/// <summary>
/// File name (e.g., "invoice.xml", "document.pdf")
/// </summary>
/// <example>factur-x.xml</example>
public required string FileName { get; init; }
/// <summary>
/// File content encoded as Base64 string
/// </summary>
/// <example>PD94bWwgdmVyc2lvbj0iMS4wIj8+...</example>
public required string Base64Content { get; init; }
/// <summary>
/// MIME type (optional, e.g., "application/xml")
/// </summary>
/// <example>application/xml</example>
public string? MimeType { get; init; }
}

View File

@@ -0,0 +1,182 @@
using DocumentService.Application.ConvertFromPdfA;
using DocumentService.Application.ConvertToPdfA;
using DocumentService.Client.Models.Requests;
using DocumentService.Domain.Common.Exceptions;
using MediatR;
using Microsoft.AspNetCore.Http;
using Microsoft.AspNetCore.Mvc;
namespace DocumentService.API.Controllers;
/// <summary>
/// Controller for PDF conversion operations (PDF ? PDF/A)
/// </summary>
[ApiController]
[Route("api/pdf/conversion")]
[Obsolete("This endpoint is not implemented yet.")]
public class PdfConversionController(IMediator mediator) : ControllerBase
{
/// <summary>
/// Converts a standard PDF to PDF/A format.
/// Supports multipart/form-data file upload.
/// </summary>
/// <param name="file">The PDF file to convert</param>
/// <param name="pdfALevel">Target PDF/A level (e.g., "PDF/A-1b", "PDF/A-2b", "PDF/A-3b")</param>
/// <param name="cancellationToken">Cancellation token</param>
/// <returns>PDF/A compliant document</returns>
/// <response code="200">PDF converted to PDF/A successfully</response>
/// <response code="400">Invalid input (file missing, not a PDF, or invalid PDF/A level)</response>
/// <response code="500">Internal server error during PDF processing</response>
[Obsolete("This endpoint is not implemented yet.")]
[HttpPost("to-pdfa")]
[Consumes("multipart/form-data")]
[ProducesResponseType(typeof(FileContentResult), StatusCodes.Status200OK)]
[ProducesResponseType(typeof(ProblemDetails), StatusCodes.Status400BadRequest)]
[ProducesResponseType(typeof(ProblemDetails), StatusCodes.Status500InternalServerError)]
public async Task<IActionResult> ConvertToPdfAFromFile(
IFormFile file,
[FromQuery] string pdfALevel = "PDF/A-3b",
CancellationToken cancellationToken = default)
{
if (file == null || file.Length == 0)
{
throw new BadRequestException("PDF file is required");
}
// Use IFormFile stream directly (no intermediate byte[] conversion)
using var pdfStream = file.OpenReadStream();
// Send command to MediatR
var command = new ConvertToPdfACommand
{
PdfStream = pdfStream,
PdfALevel = pdfALevel
};
byte[] resultPdf = await mediator.Send(command, cancellationToken);
// Return PDF/A file
return File(resultPdf, "application/pdf", "converted-pdfa.pdf");
}
/// <summary>
/// Converts a standard PDF to PDF/A format.
/// Supports Base64-encoded PDF via JSON payload.
/// </summary>
/// <param name="request">Request containing Base64-encoded PDF and PDF/A level</param>
/// <param name="cancellationToken">Cancellation token</param>
/// <returns>PDF/A compliant document</returns>
/// <response code="200">PDF converted to PDF/A successfully</response>
/// <response code="400">Invalid input (Base64 format error, not a PDF, or invalid PDF/A level)</response>
/// <response code="500">Internal server error during PDF processing</response>
[Obsolete("This endpoint is not implemented yet.")]
[HttpPost("to-pdfa")]
[Consumes("application/json")]
[ProducesResponseType(typeof(FileContentResult), StatusCodes.Status200OK)]
[ProducesResponseType(typeof(ProblemDetails), StatusCodes.Status400BadRequest)]
[ProducesResponseType(typeof(ProblemDetails), StatusCodes.Status500InternalServerError)]
public async Task<IActionResult> ConvertToPdfAFromBase64(
[FromBody] ConvertToPdfARequest request,
CancellationToken cancellationToken = default)
{
// Convert Base64 PDF to stream
byte[] pdfBytes;
try
{
pdfBytes = Convert.FromBase64String(request.Base64Pdf);
}
catch (FormatException ex)
{
throw new BadRequestException("Invalid Base64 PDF format: " + ex.Message);
}
using var pdfStream = new MemoryStream(pdfBytes);
// Send command to MediatR
var command = new ConvertToPdfACommand
{
PdfStream = pdfStream,
PdfALevel = request.PdfALevel ?? "PDF/A-3b"
};
byte[] resultPdf = await mediator.Send(command, cancellationToken);
// Return PDF/A file
return File(resultPdf, "application/pdf", "converted-pdfa.pdf");
}
/// <summary>
/// Converts a PDF/A document to a standard PDF (removes PDF/A restrictions).
/// Supports multipart/form-data file upload.
/// </summary>
/// <param name="file">The PDF/A file to convert</param>
/// <param name="cancellationToken">Cancellation token</param>
/// <returns>Standard PDF document</returns>
/// <response code="200">PDF/A converted to standard PDF successfully</response>
/// <response code="400">Invalid input (file missing, not a PDF)</response>
/// <response code="500">Internal server error during PDF processing</response>
[Obsolete("This endpoint is not implemented yet.")]
[HttpPost("from-pdfa")]
[Consumes("multipart/form-data")]
[ProducesResponseType(typeof(FileContentResult), StatusCodes.Status200OK)]
[ProducesResponseType(typeof(ProblemDetails), StatusCodes.Status400BadRequest)]
[ProducesResponseType(typeof(ProblemDetails), StatusCodes.Status500InternalServerError)]
public async Task<IActionResult> ConvertFromPdfAFromFile(
IFormFile file,
CancellationToken cancellationToken = default)
{
if (file == null || file.Length == 0)
{
throw new BadRequestException("PDF/A file is required");
}
// Use IFormFile stream directly (no intermediate byte[] conversion)
using var pdfStream = file.OpenReadStream();
// Send command to MediatR
var command = new ConvertFromPdfACommand { PdfStream = pdfStream };
byte[] resultPdf = await mediator.Send(command, cancellationToken);
// Return standard PDF file
return File(resultPdf, "application/pdf", "converted-pdf.pdf");
}
/// <summary>
/// Converts a PDF/A document to a standard PDF (removes PDF/A restrictions).
/// Supports Base64-encoded PDF via JSON payload.
/// </summary>
/// <param name="request">Request containing Base64-encoded PDF/A</param>
/// <param name="cancellationToken">Cancellation token</param>
/// <returns>Standard PDF document</returns>
/// <response code="200">PDF/A converted to standard PDF successfully</response>
/// <response code="400">Invalid input (Base64 format error, not a PDF)</response>
/// <response code="500">Internal server error during PDF processing</response>
[Obsolete("This endpoint is not implemented yet.")]
[HttpPost("from-pdfa")]
[Consumes("application/json")]
[ProducesResponseType(typeof(FileContentResult), StatusCodes.Status200OK)]
[ProducesResponseType(typeof(ProblemDetails), StatusCodes.Status400BadRequest)]
[ProducesResponseType(typeof(ProblemDetails), StatusCodes.Status500InternalServerError)]
public async Task<IActionResult> ConvertFromPdfAFromBase64(
[FromBody] ConvertFromPdfARequest request,
CancellationToken cancellationToken = default)
{
// Convert Base64 PDF to stream
byte[] pdfBytes;
try
{
pdfBytes = Convert.FromBase64String(request.Base64Pdf);
}
catch (FormatException ex)
{
throw new BadRequestException("Invalid Base64 PDF format: " + ex.Message);
}
using var pdfStream = new MemoryStream(pdfBytes);
// Send command to MediatR
var command = new ConvertFromPdfACommand { PdfStream = pdfStream };
byte[] resultPdf = await mediator.Send(command, cancellationToken);
// Return standard PDF file
return File(resultPdf, "application/pdf", "converted-pdf.pdf");
}
}

View File

@@ -0,0 +1,728 @@
using DocumentService.Application.AddAnnotation;
using DocumentService.Application.AddStamp;
using DocumentService.Application.MergePdfs;
using DocumentService.Domain.Common.Exceptions;
using DocumentService.Domain.Models.ValueObjects;
using MediatR;
using Microsoft.AspNetCore.Http;
using Microsoft.AspNetCore.Mvc;
namespace DocumentService.API.Controllers;
/// <summary>
/// Controller for PDF operations (merge, stamp, annotate).
/// </summary>
[ApiController]
[Route("api/pdf/operations")]
public class PdfOperationsController(IMediator mediator) : ControllerBase
{
/// <summary>
/// Merges multiple PDF files into a single PDF.
/// Supports multipart/form-data file upload.
/// </summary>
/// <param name="files">PDF files to merge (minimum 2 required)</param>
/// <param name="cancellationToken">Cancellation token</param>
/// <returns>Merged PDF file</returns>
/// <response code="200">PDFs merged successfully - returns merged PDF</response>
/// <response code="400">Invalid input (fewer than 2 files, corrupted PDF)</response>
/// <response code="500">Internal server error during PDF processing</response>
[HttpPost("merge", Name = "MergeFromFiles")]
[Consumes("multipart/form-data")]
[ProducesResponseType(typeof(FileContentResult), StatusCodes.Status200OK)]
[ProducesResponseType(typeof(ProblemDetails), StatusCodes.Status400BadRequest)]
[ProducesResponseType(typeof(ProblemDetails), StatusCodes.Status500InternalServerError)]
public async Task<IActionResult> MergeFromFiles(
[FromForm] List<IFormFile> files,
CancellationToken cancellationToken)
{
// Convert IFormFile[] to Stream[] (use OpenReadStream directly - no buffering)
var streams = files.Select(f => f.OpenReadStream()).ToList();
// Send command to MediatR (no page ranges for now - multipart binding is complex)
var command = new MergePdfsCommand
{
PdfStreams = streams,
PageRanges = null
};
byte[] mergedPdf = await mediator.Send(command, cancellationToken);
// Return merged PDF
return File(mergedPdf, "application/pdf", "merged.pdf");
}
/// <summary>
/// Merges multiple PDF files into a single PDF.
/// Supports Base64-encoded PDFs via JSON payload.
/// </summary>
/// <param name="request">Request containing Base64-encoded PDFs and optional page ranges</param>
/// <param name="cancellationToken">Cancellation token</param>
/// <returns>Merged PDF file</returns>
/// <response code="200">PDFs merged successfully - returns merged PDF</response>
/// <response code="400">Invalid input (Base64 format error, fewer than 2 files, corrupted PDF, invalid page range)</response>
/// <response code="500">Internal server error during PDF processing</response>
[HttpPost("merge", Name = "MergeFromBase64")]
[Consumes("application/json")]
[ProducesResponseType(typeof(FileContentResult), StatusCodes.Status200OK)]
[ProducesResponseType(typeof(ProblemDetails), StatusCodes.Status400BadRequest)]
[ProducesResponseType(typeof(ProblemDetails), StatusCodes.Status500InternalServerError)]
public async Task<IActionResult> MergeFromBase64(
[FromBody] MergePdfsBase64Request request,
CancellationToken cancellationToken)
{
// Convert Base64[] to MemoryStream[]
List<Stream> streams = [];
try
{
foreach (var base64Pdf in request.Base64Pdfs)
{
byte[] pdfBytes = Convert.FromBase64String(base64Pdf);
streams.Add(new MemoryStream(pdfBytes));
}
}
catch (FormatException ex)
{
// Dispose opened streams on error
foreach (var stream in streams) stream.Dispose();
throw new BadRequestException("Invalid Base64 format: " + ex.Message);
}
var command = new MergePdfsCommand
{
PdfStreams = streams,
PageRanges = request.PageRanges
};
byte[] mergedPdf = await mediator.Send(command, cancellationToken);
// Cleanup streams (important for MemoryStreams we created)
foreach (var stream in streams) stream.Dispose();
return File(mergedPdf, "application/pdf", "merged.pdf");
}
/// <summary>
/// Adds an annotation to a PDF document.
/// Supports multipart/form-data file upload.
/// </summary>
/// <param name="request">Multipart form data containing PDF file and annotation parameters</param>
/// <param name="cancellationToken">Cancellation token</param>
/// <returns>Annotated PDF file</returns>
/// <response code="200">Annotation added successfully - returns annotated PDF</response>
/// <response code="400">Invalid input (invalid page number, missing required parameters)</response>
/// <response code="500">Internal server error during PDF processing</response>
[HttpPost("annotate", Name = "AnnotateFromFile")]
[Consumes("multipart/form-data")]
[ProducesResponseType(typeof(FileContentResult), StatusCodes.Status200OK)]
[ProducesResponseType(typeof(ProblemDetails), StatusCodes.Status400BadRequest)]
[ProducesResponseType(typeof(ProblemDetails), StatusCodes.Status500InternalServerError)]
public async Task<IActionResult> AnnotateFromFile(
[FromForm] AddAnnotationMultipartRequest request,
CancellationToken cancellationToken)
{
// Calculate X2, Y2 from Width/Height if provided
double x2 = request.X2 ?? request.X1 + (request.Width ?? throw new BadRequestException("Either X2 or Width must be provided"));
double y2 = request.Y2 ?? request.Y1 + (request.Height ?? throw new BadRequestException("Either Y2 or Height must be provided"));
var command = new AddAnnotationCommand
{
PdfStream = request.File.OpenReadStream(),
AnnotationType = request.AnnotationType,
PageNumber = request.PageNumber,
Rectangle = (request.X1, request.Y1, x2, y2),
Content = request.Content,
Author = request.Author,
Color = request.Color,
TextMarkupStyle = request.TextMarkupStyle,
Origin = request.Origin
};
byte[] annotatedPdf = await mediator.Send(command, cancellationToken);
return File(annotatedPdf, "application/pdf", "annotated.pdf");
}
/// <summary>
/// Adds an annotation to a PDF document.
/// Supports Base64-encoded PDF via JSON payload.
/// </summary>
/// <param name="command">Command containing all annotation parameters (including Base64 PDF)</param>
/// <param name="cancellationToken">Cancellation token</param>
/// <returns>Annotated PDF file</returns>
/// <response code="200">Annotation added successfully - returns annotated PDF</response>
/// <response code="400">Invalid input (Base64 format error, invalid page number, missing required parameters)</response>
/// <response code="500">Internal server error during PDF processing</response>
[HttpPost("annotate", Name = "AnnotateFromBase64")]
[Consumes("application/json")]
[ProducesResponseType(typeof(FileContentResult), StatusCodes.Status200OK)]
[ProducesResponseType(typeof(ProblemDetails), StatusCodes.Status400BadRequest)]
[ProducesResponseType(typeof(ProblemDetails), StatusCodes.Status500InternalServerError)]
public async Task<IActionResult> AnnotateFromBase64(
[FromBody] AddAnnotationBase64Command command,
CancellationToken cancellationToken)
{
// Convert Base64 to MemoryStream
Stream pdfStream;
try
{
byte[] pdfBytes = Convert.FromBase64String(command.Base64Pdf);
pdfStream = new MemoryStream(pdfBytes);
}
catch (FormatException ex)
{
throw new BadRequestException("Invalid Base64 format: " + ex.Message);
}
// Calculate X2, Y2 from Width/Height if provided
double x2 = command.X2 ?? command.X1 + (command.Width ?? throw new BadRequestException("Either X2 or Width must be provided"));
double y2 = command.Y2 ?? command.Y1 + (command.Height ?? throw new BadRequestException("Either Y2 or Height must be provided"));
var annotationCommand = new AddAnnotationCommand
{
PdfStream = pdfStream,
AnnotationType = command.AnnotationType,
PageNumber = command.PageNumber,
Rectangle = (command.X1, command.Y1, x2, y2),
Content = command.Content,
Author = command.Author,
Color = command.Color,
TextMarkupStyle = command.TextMarkupStyle,
Origin = command.Origin
};
byte[] annotatedPdf = await mediator.Send(annotationCommand, cancellationToken);
// Cleanup stream
pdfStream.Dispose();
return File(annotatedPdf, "application/pdf", "annotated.pdf");
}
/// <summary>
/// Adds a stamp (text, image, or predefined) to PDF pages.
/// Supports multipart/form-data file upload.
/// </summary>
/// <param name="request">Multipart form data containing PDF file and stamp parameters</param>
/// <param name="cancellationToken">Cancellation token</param>
/// <returns>Stamped PDF file</returns>
/// <response code="200">Stamp added successfully - returns stamped PDF</response>
/// <response code="400">Invalid input (invalid page number, missing required parameters, invalid image format)</response>
/// <response code="500">Internal server error during PDF processing</response>
[HttpPost("stamp", Name = "AddStampFromFile")]
[Consumes("multipart/form-data")]
[ProducesResponseType(typeof(FileContentResult), StatusCodes.Status200OK)]
[ProducesResponseType(typeof(ProblemDetails), StatusCodes.Status400BadRequest)]
[ProducesResponseType(typeof(ProblemDetails), StatusCodes.Status500InternalServerError)]
public async Task<IActionResult> AddStampFromFile(
[FromForm] AddStampMultipartRequest request,
CancellationToken cancellationToken)
{
// Convert ImageFile to byte[] if provided
byte[]? imageBytes = null;
if (request.ImageFile != null)
{
using var ms = new MemoryStream();
await request.ImageFile.CopyToAsync(ms, cancellationToken);
imageBytes = ms.ToArray();
}
var command = new AddStampCommand
{
PdfStream = request.File.OpenReadStream(),
StampType = request.StampType,
PageNumbers = request.PageNumbers,
Position = (request.X, request.Y),
Size = request.Width.HasValue && request.Height.HasValue
? (request.Width.Value, request.Height.Value)
: null,
Origin = request.Origin,
Text = request.Text,
FontName = request.FontName,
FontSize = request.FontSize,
Color = request.Color,
Opacity = request.Opacity,
Rotation = request.Rotation,
Placement = request.Placement,
ImageBytes = imageBytes,
PredefinedType = request.PredefinedType
};
byte[] stampedPdf = await mediator.Send(command, cancellationToken);
return File(stampedPdf, "application/pdf", "stamped.pdf");
}
/// <summary>
/// Adds a stamp (text, image, or predefined) to PDF pages.
/// Supports Base64-encoded PDF and image via JSON payload.
/// </summary>
/// <param name="request">Request containing Base64-encoded PDF, stamp parameters, and optional Base64 image</param>
/// <param name="cancellationToken">Cancellation token</param>
/// <returns>Stamped PDF file</returns>
/// <response code="200">Stamp added successfully - returns stamped PDF</response>
/// <response code="400">Invalid input (Base64 format error, invalid page number, missing required parameters)</response>
/// <response code="500">Internal server error during PDF processing</response>
[HttpPost("stamp", Name = "AddStampFromBase64")]
[Consumes("application/json")]
[ProducesResponseType(typeof(FileContentResult), StatusCodes.Status200OK)]
[ProducesResponseType(typeof(ProblemDetails), StatusCodes.Status400BadRequest)]
[ProducesResponseType(typeof(ProblemDetails), StatusCodes.Status500InternalServerError)]
public async Task<IActionResult> AddStampFromBase64(
[FromBody] AddStampBase64Request request,
CancellationToken cancellationToken)
{
// Convert Base64 PDF to MemoryStream
Stream pdfStream;
try
{
byte[] pdfBytes = Convert.FromBase64String(request.Base64Pdf);
pdfStream = new MemoryStream(pdfBytes);
}
catch (FormatException ex)
{
throw new BadRequestException("Invalid Base64 PDF format: " + ex.Message);
}
// Convert Base64 image to byte[] if provided
byte[]? imageBytes = null;
if (!string.IsNullOrWhiteSpace(request.Base64Image))
{
try
{
imageBytes = Convert.FromBase64String(request.Base64Image);
}
catch (FormatException ex)
{
pdfStream.Dispose();
throw new BadRequestException("Invalid Base64 image format: " + ex.Message);
}
}
var command = new AddStampCommand
{
PdfStream = pdfStream,
StampType = request.StampType,
PageNumbers = request.PageNumbers,
Position = (request.X, request.Y),
Size = request.Width.HasValue && request.Height.HasValue
? (request.Width.Value, request.Height.Value)
: null,
Origin = request.Origin,
Text = request.Text,
FontName = request.FontName,
FontSize = request.FontSize,
Color = request.Color,
Opacity = request.Opacity,
Rotation = request.Rotation,
Placement = request.Placement,
ImageBytes = imageBytes,
PredefinedType = request.PredefinedType
};
byte[] stampedPdf = await mediator.Send(command, cancellationToken);
// Cleanup stream
pdfStream.Dispose();
return File(stampedPdf, "application/pdf", "stamped.pdf");
}
}
/// <summary>
/// Request DTO for multipart/form-data annotation operation
/// </summary>
public class AddAnnotationMultipartRequest
{
/// <summary>
/// PDF file to annotate
/// </summary>
public required IFormFile File { get; set; }
/// <summary>
/// Type of annotation (TextMarkup, FreeText, StickyNote, Circle, Square)
/// </summary>
public required AnnotationType AnnotationType { get; set; }
/// <summary>
/// Target page number (1-indexed)
/// </summary>
public required int PageNumber { get; set; }
/// <summary>
/// Rectangle X1 coordinate (left)
/// </summary>
public required double X1 { get; set; }
/// <summary>
/// Rectangle Y1 coordinate (top or bottom depending on Origin)
/// </summary>
public required double Y1 { get; set; }
/// <summary>
/// Rectangle X2 coordinate (right). Optional if Width is provided.
/// </summary>
public double? X2 { get; set; }
/// <summary>
/// Rectangle Y2 coordinate (bottom or top depending on Origin). Optional if Height is provided.
/// </summary>
public double? Y2 { get; set; }
/// <summary>
/// Rectangle width. Alternative to X2 (X2 = X1 + Width). Optional if X2 is provided.
/// </summary>
public double? Width { get; set; }
/// <summary>
/// Rectangle height. Alternative to Y2 (Y2 = Y1 + Height). Optional if Y2 is provided.
/// </summary>
public double? Height { get; set; }
/// <summary>
/// Annotation content (required for FreeText/StickyNote)
/// </summary>
public string? Content { get; set; }
/// <summary>
/// Author name (optional)
/// </summary>
public string? Author { get; set; }
/// <summary>
/// Hex color (6 digits, e.g., "FF0000" for red)
/// </summary>
public string? Color { get; set; }
/// <summary>
/// Markup style (Highlight/Underline/Strikeout, required for TextMarkup)
/// </summary>
public TextMarkupStyle? TextMarkupStyle { get; set; }
/// <summary>
/// Coordinate origin (BottomLeft = PDF native, TopLeft = UI-friendly). Default: BottomLeft
/// </summary>
public AnnotationOrigin Origin { get; set; } = AnnotationOrigin.BottomLeft;
}
/// <summary>
/// Request DTO for Base64-encoded PDF merge operation (API layer only - converts to MergePdfsCommand)
/// </summary>
public record MergePdfsBase64Request
{
/// <summary>
/// Array of Base64-encoded PDF files (minimum 2 required)
/// </summary>
/// <example>["JVBERi0xLjQK...", "JVBERi0xLjQK..."]</example>
public required List<string> Base64Pdfs { get; init; }
/// <summary>
/// Optional page ranges per PDF (null = all pages).
/// Format: "1-3,5" means pages 1, 2, 3, and 5.
/// If provided, array length must match Base64Pdfs length.
/// </summary>
/// <example>["1-2", "1,3,5", null]</example>
public List<string?>? PageRanges { get; init; }
}
/// <summary>
/// Request DTO for Base64-encoded PDF annotation (API layer only - converts to AddAnnotationCommand)
/// </summary>
public record AddAnnotationBase64Command
{
/// <summary>
/// Base64-encoded PDF file
/// </summary>
/// <example>"JVBERi0xLjQK..."</example>
public required string Base64Pdf { get; init; }
/// <summary>
/// Type of annotation to add
/// </summary>
/// <example>TextMarkup</example>
public required AnnotationType AnnotationType { get; init; }
/// <summary>
/// Target page number (1-indexed)
/// </summary>
/// <example>1</example>
public required int PageNumber { get; init; }
/// <summary>
/// Rectangle X1 coordinate (left)
/// </summary>
/// <example>100.0</example>
public required double X1 { get; init; }
/// <summary>
/// Rectangle Y1 coordinate (top or bottom depending on Origin)
/// </summary>
/// <example>100.0</example>
public required double Y1 { get; init; }
/// <summary>
/// Rectangle X2 coordinate (right). Optional if Width is provided.
/// </summary>
/// <example>200.0</example>
public double? X2 { get; init; }
/// <summary>
/// Rectangle Y2 coordinate (bottom or top depending on Origin). Optional if Height is provided.
/// </summary>
/// <example>120.0</example>
public double? Y2 { get; init; }
/// <summary>
/// Rectangle width. Alternative to X2 (X2 = X1 + Width). Optional if X2 is provided.
/// </summary>
/// <example>100.0</example>
public double? Width { get; init; }
/// <summary>
/// Rectangle height. Alternative to Y2 (Y2 = Y1 + Height). Optional if Y2 is provided.
/// </summary>
/// <example>20.0</example>
public double? Height { get; init; }
/// <summary>
/// Annotation content (required for FreeText and StickyNote)
/// </summary>
/// <example>"Important text to highlight"</example>
public string? Content { get; init; }
/// <summary>
/// Author name (optional)
/// </summary>
/// <example>"John Doe"</example>
public string? Author { get; init; }
/// <summary>
/// Hex color (6 digits, e.g., "FF0000" for red). Optional - defaults vary by annotation type.
/// </summary>
/// <example>"FFFF00"</example>
public string? Color { get; init; }
/// <summary>
/// Text markup style (Highlight, Underline, or Strikeout). Required for TextMarkup annotations.
/// </summary>
/// <example>Highlight</example>
public TextMarkupStyle? TextMarkupStyle { get; init; }
/// <summary>
/// Coordinate origin (BottomLeft = PDF native, TopLeft = UI-friendly). Default: BottomLeft
/// </summary>
/// <example>BottomLeft</example>
public AnnotationOrigin Origin { get; init; } = AnnotationOrigin.BottomLeft;
}
/// <summary>
/// Request DTO for multipart/form-data stamp operation
/// </summary>
public class AddStampMultipartRequest
{
/// <summary>
/// PDF file to stamp
/// </summary>
public required IFormFile File { get; set; }
/// <summary>
/// Type of stamp (Text, Image, or Predefined)
/// </summary>
public required StampType StampType { get; set; }
/// <summary>
/// Target page numbers (1-indexed). Null or empty = all pages.
/// </summary>
/// <example>[1, 3, 5]</example>
public int[]? PageNumbers { get; set; }
/// <summary>
/// Stamp position X coordinate
/// </summary>
/// <example>100.0</example>
public required double X { get; set; }
/// <summary>
/// Stamp position Y coordinate
/// </summary>
/// <example>100.0</example>
public required double Y { get; set; }
/// <summary>
/// Stamp width (optional, auto-size for images if not specified)
/// </summary>
/// <example>200.0</example>
public double? Width { get; set; }
/// <summary>
/// Stamp height (optional, auto-size for images if not specified)
/// </summary>
/// <example>50.0</example>
public double? Height { get; set; }
/// <summary>
/// Coordinate origin (BottomLeft = PDF native, TopLeft = UI-friendly). Default: BottomLeft
/// </summary>
/// <example>BottomLeft</example>
public AnnotationOrigin Origin { get; set; } = AnnotationOrigin.BottomLeft;
/// <summary>
/// Text content (required for Text stamps)
/// </summary>
/// <example>"CONFIDENTIAL"</example>
public string? Text { get; set; }
/// <summary>
/// Font name (default: Arial)
/// </summary>
/// <example>"Arial"</example>
public string? FontName { get; set; }
/// <summary>
/// Font size in points (default: 12)
/// </summary>
/// <example>24.0</example>
public double? FontSize { get; set; }
/// <summary>
/// Hex color (6 digits, e.g., "FF0000" for red, default: "000000")
/// </summary>
/// <example>"FF0000"</example>
public string? Color { get; set; }
/// <summary>
/// Opacity (0.0 = transparent, 1.0 = opaque, default: 0.5)
/// </summary>
/// <example>0.5</example>
public double? Opacity { get; set; }
/// <summary>
/// Rotation angle in degrees (0-360, default: 0)
/// </summary>
/// <example>45.0</example>
public double? Rotation { get; set; }
/// <summary>
/// Stamp placement (Foreground = on top, Background = watermark effect, default: Foreground)
/// </summary>
/// <example>Foreground</example>
public StampPlacement Placement { get; set; } = StampPlacement.Foreground;
/// <summary>
/// Image file (required for Image stamps, PNG/JPEG)
/// </summary>
public IFormFile? ImageFile { get; set; }
/// <summary>
/// Predefined stamp type (required for Predefined stamps)
/// </summary>
/// <example>Confidential</example>
public PredefinedStampType? PredefinedType { get; set; }
}
/// <summary>
/// Request DTO for Base64-encoded PDF stamp operation (API layer only - converts to AddStampCommand)
/// </summary>
public record AddStampBase64Request
{
/// <summary>
/// Base64-encoded PDF file
/// </summary>
/// <example>"JVBERi0xLjQK..."</example>
public required string Base64Pdf { get; init; }
/// <summary>
/// Type of stamp (Text, Image, or Predefined)
/// </summary>
/// <example>Text</example>
public required StampType StampType { get; init; }
/// <summary>
/// Target page numbers (1-indexed). Null or empty = all pages.
/// </summary>
/// <example>[1, 3, 5]</example>
public int[]? PageNumbers { get; init; }
/// <summary>
/// Stamp position X coordinate
/// </summary>
/// <example>100.0</example>
public required double X { get; init; }
/// <summary>
/// Stamp position Y coordinate
/// </summary>
/// <example>100.0</example>
public required double Y { get; init; }
/// <summary>
/// Stamp width (optional, auto-size for images if not specified)
/// </summary>
/// <example>200.0</example>
public double? Width { get; init; }
/// <summary>
/// Stamp height (optional, auto-size for images if not specified)
/// </summary>
/// <example>50.0</example>
public double? Height { get; init; }
/// <summary>
/// Coordinate origin (BottomLeft = PDF native, TopLeft = UI-friendly). Default: BottomLeft
/// </summary>
/// <example>BottomLeft</example>
public AnnotationOrigin Origin { get; init; } = AnnotationOrigin.BottomLeft;
/// <summary>
/// Text content (required for Text stamps)
/// </summary>
/// <example>"CONFIDENTIAL"</example>
public string? Text { get; init; }
/// <summary>
/// Font name (default: Arial)
/// </summary>
/// <example>"Arial"</example>
public string? FontName { get; init; }
/// <summary>
/// Font size in points (default: 12)
/// </summary>
/// <example>24.0</example>
public double? FontSize { get; init; }
/// <summary>
/// Hex color (6 digits, e.g., "FF0000" for red, default: "000000")
/// </summary>
/// <example>"FF0000"</example>
public string? Color { get; init; }
/// <summary>
/// Opacity (0.0 = transparent, 1.0 = opaque, default: 0.5)
/// </summary>
/// <example>0.5</example>
public double? Opacity { get; init; }
/// <summary>
/// Rotation angle in degrees (0-360, default: 0)
/// </summary>
/// <example>45.0</example>
public double? Rotation { get; init; }
/// <summary>
/// Stamp placement (Foreground = on top, Background = watermark effect, default: Foreground)
/// </summary>
/// <example>Foreground</example>
public StampPlacement Placement { get; init; } = StampPlacement.Foreground;
/// <summary>
/// Base64-encoded image (required for Image stamps, PNG/JPEG)
/// </summary>
/// <example>"iVBORw0KGgoAAAANSUhEUgAA..."</example>
public string? Base64Image { get; init; }
/// <summary>
/// Predefined stamp type (required for Predefined stamps)
/// </summary>
/// <example>Confidential</example>
public PredefinedStampType? PredefinedType { get; init; }
}

View File

@@ -0,0 +1,170 @@
using DocumentService.Application.Common.DTOs;
using DocumentService.Application.ValidatePdf.Queries;
using DocumentService.Application.ValidatePdfA.Queries;
using DocumentService.Client.Models.Requests;
using DocumentService.Domain.Common.Exceptions;
using MediatR;
using Microsoft.AspNetCore.Mvc;
namespace DocumentService.API.Controllers;
/// <summary>
/// PDF validation operations
/// </summary>
[ApiController]
[Route("api/pdf/validation")]
[Produces("application/json")]
public class PdfValidationController(IMediator Mediator) : ControllerBase
{
/// <summary>
/// Validates a PDF document and returns metadata (multipart/form-data)
/// </summary>
/// <param name="file">PDF file to validate</param>
/// <param name="cancellationToken">Cancellation token</param>
/// <returns>PDF metadata (page count, file size, PDF version, attachments)</returns>
/// <response code="200">PDF is valid, metadata returned</response>
/// <response code="400">Invalid PDF or file format</response>
/// <response code="500">Internal server error during validation</response>
[HttpPost("validate")]
[Consumes("multipart/form-data")]
[ProducesResponseType(typeof(PdfValidationResult), StatusCodes.Status200OK)]
[ProducesResponseType(typeof(ProblemDetails), StatusCodes.Status400BadRequest)]
[ProducesResponseType(typeof(ProblemDetails), StatusCodes.Status500InternalServerError)]
public async Task<IActionResult> ValidateFromFile(
IFormFile file,
CancellationToken cancellationToken)
{
if (file == null || file.Length == 0)
{
return BadRequest(new ProblemDetails
{
Title = "Invalid file",
Detail = "File is required and cannot be empty",
Status = StatusCodes.Status400BadRequest
});
}
// Use IFormFile stream directly (no intermediate byte[] conversion)
using var pdfStream = file.OpenReadStream();
// Direct pass-through to MediatR
var query = new ValidatePdfQuery { PdfStream = pdfStream };
var result = await Mediator.Send(query, cancellationToken);
return Ok(result);
}
/// <summary>
/// Validates a PDF document and returns metadata (Base64 JSON)
/// </summary>
/// <param name="request">Request containing Base64-encoded PDF</param>
/// <param name="cancellationToken">Cancellation token</param>
/// <returns>PDF metadata (page count, file size, PDF version, attachments)</returns>
/// <response code="200">PDF is valid, metadata returned</response>
/// <response code="400">Invalid PDF or Base64 format</response>
/// <response code="500">Internal server error during validation</response>
[HttpPost("validate")]
[Consumes("application/json")]
[ProducesResponseType(typeof(PdfValidationResult), StatusCodes.Status200OK)]
[ProducesResponseType(typeof(ProblemDetails), StatusCodes.Status400BadRequest)]
[ProducesResponseType(typeof(ProblemDetails), StatusCodes.Status500InternalServerError)]
public async Task<IActionResult> ValidateFromBase64(
[FromBody] ValidatePdfBase64Request request,
CancellationToken cancellationToken)
{
// Convert Base64 to stream (wrap in try-catch to throw BadRequestException)
byte[] pdfBytes;
try
{
pdfBytes = Convert.FromBase64String(request.Base64Pdf);
}
catch (FormatException ex)
{
throw new BadRequestException("Invalid Base64 format: " + ex.Message);
}
using var pdfStream = new MemoryStream(pdfBytes);
// Direct pass-through to MediatR
var query = new ValidatePdfQuery { PdfStream = pdfStream };
var result = await Mediator.Send(query, cancellationToken);
return Ok(result);
}
/// <summary>
/// Validates a PDF/A document and checks conformance level (multipart/form-data)
/// </summary>
/// <param name="file">PDF file to validate</param>
/// <param name="cancellationToken">Cancellation token</param>
/// <returns>PDF/A metadata (conformance level, errors, warnings)</returns>
/// <response code="200">PDF/A validation completed, results returned</response>
/// <response code="400">Invalid PDF or file format</response>
/// <response code="500">Internal server error during validation</response>
[HttpPost("validate-pdfa")]
[Consumes("multipart/form-data")]
[ProducesResponseType(typeof(PdfAValidationResult), StatusCodes.Status200OK)]
[ProducesResponseType(typeof(ProblemDetails), StatusCodes.Status400BadRequest)]
[ProducesResponseType(typeof(ProblemDetails), StatusCodes.Status500InternalServerError)]
public async Task<IActionResult> ValidatePdfAFromFile(
IFormFile file,
CancellationToken cancellationToken)
{
if (file == null || file.Length == 0)
{
return BadRequest(new ProblemDetails
{
Title = "Invalid file",
Detail = "File is required and cannot be empty",
Status = StatusCodes.Status400BadRequest
});
}
// Use IFormFile stream directly (no intermediate byte[] conversion)
using var pdfStream = file.OpenReadStream();
// Direct pass-through to MediatR
var query = new ValidatePdfAQuery { PdfStream = pdfStream };
var result = await Mediator.Send(query, cancellationToken);
return Ok(result);
}
/// <summary>
/// Validates a PDF/A document and checks conformance level (Base64 JSON)
/// </summary>
/// <param name="request">Request containing Base64-encoded PDF</param>
/// <param name="cancellationToken">Cancellation token</param>
/// <returns>PDF/A metadata (conformance level, errors, warnings)</returns>
/// <response code="200">PDF/A validation completed, results returned</response>
/// <response code="400">Invalid PDF or Base64 format</response>
/// <response code="500">Internal server error during validation</response>
[HttpPost("validate-pdfa")]
[Consumes("application/json")]
[ProducesResponseType(typeof(PdfAValidationResult), StatusCodes.Status200OK)]
[ProducesResponseType(typeof(ProblemDetails), StatusCodes.Status400BadRequest)]
[ProducesResponseType(typeof(ProblemDetails), StatusCodes.Status500InternalServerError)]
public async Task<IActionResult> ValidatePdfAFromBase64(
[FromBody] ValidatePdfABase64Request request,
CancellationToken cancellationToken)
{
// Convert Base64 to stream (wrap in try-catch to throw BadRequestException)
byte[] pdfBytes;
try
{
pdfBytes = Convert.FromBase64String(request.Base64Pdf);
}
catch (FormatException ex)
{
throw new BadRequestException("Invalid Base64 format: " + ex.Message);
}
using var pdfStream = new MemoryStream(pdfBytes);
// Direct pass-through to MediatR
var query = new ValidatePdfAQuery { PdfStream = pdfStream };
var result = await Mediator.Send(query, cancellationToken);
return Ok(result);
}
}

View File

@@ -0,0 +1,113 @@
using DocumentService.Application.Common.DTOs;
using DocumentService.Application.SwissQrCode.Queries;
using DocumentService.Domain.Common.Exceptions;
using MediatR;
using Microsoft.AspNetCore.Mvc;
namespace DocumentService.API.Controllers;
/// <summary>
/// Swiss QR Code extraction operations
/// </summary>
[ApiController]
[Route("api/pdf/qr-code")]
[Produces("application/json")]
public class SwissQrCodeController(IMediator Mediator) : ControllerBase
{
/// <summary>
/// Extracts Swiss QR Code from the last page of a PDF document (multipart/form-data)
/// </summary>
/// <param name="file">PDF file containing Swiss QR Code</param>
/// <param name="raw">If true, returns raw QR text lines instead of parsed Bill object</param>
/// <param name="cancellationToken">Cancellation token</param>
/// <returns>Swiss QR Code data (IBAN, amount, creditor, debtor, reference, etc.)</returns>
/// <response code="200">Swiss QR Code extracted successfully</response>
/// <response code="400">Invalid PDF or file format</response>
/// <response code="404">No Swiss QR Code found on the last page</response>
/// <response code="500">Internal server error during extraction</response>
[HttpPost("extract-swiss")]
[Consumes("multipart/form-data")]
[ProducesResponseType(typeof(SwissQrCodeExtractionResult), StatusCodes.Status200OK)]
[ProducesResponseType(typeof(ProblemDetails), StatusCodes.Status400BadRequest)]
[ProducesResponseType(typeof(ProblemDetails), StatusCodes.Status404NotFound)]
[ProducesResponseType(typeof(ProblemDetails), StatusCodes.Status500InternalServerError)]
public async Task<IActionResult> ExtractFromFile(
IFormFile file,
[FromQuery] bool raw = false,
CancellationToken cancellationToken = default)
{
if (file.Length == 0)
return BadRequest(new ProblemDetails
{
Title = "Invalid file",
Detail = "File is required and cannot be empty",
Status = StatusCodes.Status400BadRequest
});
// Use IFormFile stream directly (no intermediate byte[] conversion)
using var pdfStream = file.OpenReadStream();
// Direct pass-through to MediatR
var query = new ExtractSwissQrCodeQuery
{
PdfStream = pdfStream
};
var result = await Mediator.Send(query, cancellationToken);
return Ok(raw ? result.RawLines : result.Bill);
}
/// <summary>
/// Extracts Swiss QR Code from the last page of a PDF document (Base64 JSON)
/// </summary>
/// <param name="request">Request containing Base64-encoded PDF</param>
/// <param name="raw">If true, returns raw QR text lines instead of parsed Bill object</param>
/// <param name="cancellationToken">Cancellation token</param>
/// <returns>Swiss QR Code data (IBAN, amount, creditor, debtor, reference, etc.)</returns>
/// <response code="200">Swiss QR Code extracted successfully</response>
/// <response code="400">Invalid PDF or Base64 format</response>
/// <response code="404">No Swiss QR Code found on the last page</response>
/// <response code="500">Internal server error during extraction</response>
[HttpPost("extract-swiss")]
[Consumes("application/json")]
[ProducesResponseType(typeof(SwissQrCodeExtractionResult), StatusCodes.Status200OK)]
[ProducesResponseType(typeof(ProblemDetails), StatusCodes.Status400BadRequest)]
[ProducesResponseType(typeof(ProblemDetails), StatusCodes.Status404NotFound)]
[ProducesResponseType(typeof(ProblemDetails), StatusCodes.Status500InternalServerError)]
public async Task<IActionResult> ExtractFromBase64(
[FromBody] ExtractSwissQrCodeBase64Request request,
[FromQuery] bool raw = false,
CancellationToken cancellationToken = default)
{
// Convert Base64 to stream (wrap in try-catch to throw BadRequestException)
byte[] pdfBytes;
try
{
pdfBytes = Convert.FromBase64String(request.Base64Pdf);
}
catch (FormatException ex)
{
throw new BadRequestException("Invalid Base64 format: " + ex.Message);
}
using var pdfStream = new MemoryStream(pdfBytes);
// Direct pass-through to MediatR
var query = new ExtractSwissQrCodeQuery { PdfStream = pdfStream };
var result = await Mediator.Send(query, cancellationToken);
return Ok(raw ? result.RawLines : result.Bill);
}
}
/// <summary>
/// Request DTO for Base64-encoded Swiss QR Code extraction
/// </summary>
public record ExtractSwissQrCodeBase64Request
{
/// <summary>
/// PDF document encoded as Base64 string
/// </summary>
/// <example>JVBERi0xLjQKJeLjz9MKMSAwIG9iago8PC9UeXBlL0NhdGFsb2c...</example>
public required string Base64Pdf { get; init; }
}

View File

@@ -0,0 +1,179 @@
using DocumentService.Application.Common.DTOs;
using DocumentService.Application.ExtractZugferd;
using DocumentService.Application.HasZugferd.Queries;
using DocumentService.Client.Models.Requests;
using DocumentService.Domain.Common.Exceptions;
using MediatR;
using Microsoft.AspNetCore.Http;
using Microsoft.AspNetCore.Mvc;
namespace DocumentService.API.Controllers;
/// <summary>
/// Controller for ZUGFeRD operations (detection, extraction)
/// </summary>
[ApiController]
[Route("api/pdf/zugferd")]
[Produces("application/json")]
public class ZugferdController(IMediator mediator) : ControllerBase
{
/// <summary>
/// Checks if a PDF contains ZUGFeRD XML attachment.
/// Supports multipart/form-data file upload.
/// </summary>
/// <param name="file">The PDF file to check for ZUGFeRD</param>
/// <param name="cancellationToken">Cancellation token</param>
/// <returns>ZUGFeRD check result with metadata</returns>
/// <response code="200">PDF successfully checked - returns ZUGFeRD status</response>
/// <response code="400">Invalid input (file missing, not a PDF, or corrupted)</response>
/// <response code="500">Internal server error during PDF processing</response>
[HttpPost("has-zugferd")]
[Consumes("multipart/form-data")]
[ProducesResponseType(typeof(ZugferdCheckResult), StatusCodes.Status200OK)]
[ProducesResponseType(typeof(ProblemDetails), StatusCodes.Status400BadRequest)]
[ProducesResponseType(typeof(ProblemDetails), StatusCodes.Status500InternalServerError)]
public async Task<IActionResult> HasZugferdFromFile(
IFormFile file,
CancellationToken cancellationToken)
{
// Use IFormFile stream directly (no intermediate byte[] conversion)
using var pdfStream = file.OpenReadStream();
// Send query to MediatR (ValidationBehavior runs automatically)
var query = new HasZugferdQuery { PdfStream = pdfStream };
var result = await mediator.Send(query, cancellationToken);
return Ok(result);
}
/// <summary>
/// Checks if a PDF contains ZUGFeRD XML attachment.
/// Supports Base64-encoded PDF via JSON payload.
/// </summary>
/// <param name="request">Request containing Base64-encoded PDF</param>
/// <param name="cancellationToken">Cancellation token</param>
/// <returns>ZUGFeRD check result with metadata</returns>
/// <response code="200">PDF successfully checked - returns ZUGFeRD status</response>
/// <response code="400">Invalid input (Base64 format error, not a PDF, or corrupted)</response>
/// <response code="500">Internal server error during PDF processing</response>
[HttpPost("has-zugferd")]
[Consumes("application/json")]
[ProducesResponseType(typeof(ZugferdCheckResult), StatusCodes.Status200OK)]
[ProducesResponseType(typeof(ProblemDetails), StatusCodes.Status400BadRequest)]
[ProducesResponseType(typeof(ProblemDetails), StatusCodes.Status500InternalServerError)]
public async Task<IActionResult> HasZugferdFromBase64(
[FromBody] HasZugferdRequest request,
CancellationToken cancellationToken)
{
// Convert Base64 to stream (wrap in try-catch to throw BadRequestException)
byte[] pdfBytes;
try
{
pdfBytes = Convert.FromBase64String(request.Base64Pdf);
}
catch (FormatException ex)
{
throw new BadRequestException("Invalid Base64 format: " + ex.Message);
}
using var pdfStream = new MemoryStream(pdfBytes);
// Send query to MediatR (ValidationBehavior runs automatically)
var query = new HasZugferdQuery { PdfStream = pdfStream };
var result = await mediator.Send(query, cancellationToken);
return Ok(result);
}
/// <summary>
/// Extracts ZUGFeRD XML from a PDF document.
/// Supports multipart/form-data file upload.
/// </summary>
/// <param name="file">The PDF file to extract ZUGFeRD from</param>
/// <param name="asFile">if true, 'file' (returns XML file directly); otherwise output format: 'json' (default, returns metadata + XML content)</param>
/// <param name="cancellationToken">Cancellation token</param>
/// <returns>ZUGFeRD XML content and metadata (JSON) or XML file (application/xml)</returns>
/// <response code="200">ZUGFeRD XML extracted successfully</response>
/// <response code="400">Invalid input (file missing, not a PDF, or corrupted)</response>
/// <response code="404">PDF contains no ZUGFeRD XML</response>
/// <response code="500">Internal server error during PDF processing</response>
[HttpPost("extract")]
[Consumes("multipart/form-data")]
[ProducesResponseType(typeof(ZugferdExtractionResult), StatusCodes.Status200OK)]
[ProducesResponseType(typeof(FileContentResult), StatusCodes.Status200OK)]
[ProducesResponseType(typeof(ProblemDetails), StatusCodes.Status400BadRequest)]
[ProducesResponseType(typeof(ProblemDetails), StatusCodes.Status404NotFound)]
[ProducesResponseType(typeof(ProblemDetails), StatusCodes.Status500InternalServerError)]
public async Task<IActionResult> ExtractZugferdFromFile(
IFormFile file,
[FromQuery] bool asFile = true,
CancellationToken cancellationToken = default)
{
// Use IFormFile stream directly (no intermediate byte[] conversion)
using var pdfStream = file.OpenReadStream();
// Send command to MediatR
var command = new ExtractZugferdCommand { PdfStream = pdfStream };
var result = await mediator.Send(command, cancellationToken);
// Return as file or JSON based on format parameter
if (asFile)
{
byte[] xmlBytes = System.Text.Encoding.UTF8.GetBytes(result.XmlContent);
return File(xmlBytes, "application/xml", result.FileName);
}
return Ok(result);
}
/// <summary>
/// Extracts ZUGFeRD XML from a PDF document.
/// Supports Base64-encoded PDF via JSON payload.
/// </summary>
/// <param name="request">Request containing Base64-encoded PDF</param>
/// <param name="format">Output format: 'json' (default, returns metadata + XML content) or 'file' (returns XML file directly)</param>
/// <param name="cancellationToken">Cancellation token</param>
/// <returns>ZUGFeRD XML content and metadata (JSON) or XML file (application/xml)</returns>
/// <response code="200">ZUGFeRD XML extracted successfully</response>
/// <response code="400">Invalid input (Base64 format error, not a PDF, or corrupted)</response>
/// <response code="404">PDF contains no ZUGFeRD XML</response>
/// <response code="500">Internal server error during PDF processing</response>
[HttpPost("extract")]
[Consumes("application/json")]
[ProducesResponseType(typeof(ZugferdExtractionResult), StatusCodes.Status200OK)]
[ProducesResponseType(typeof(FileContentResult), StatusCodes.Status200OK)]
[ProducesResponseType(typeof(ProblemDetails), StatusCodes.Status400BadRequest)]
[ProducesResponseType(typeof(ProblemDetails), StatusCodes.Status404NotFound)]
[ProducesResponseType(typeof(ProblemDetails), StatusCodes.Status500InternalServerError)]
public async Task<IActionResult> ExtractZugferdFromBase64(
[FromBody] ExtractZugferdRequest request,
[FromQuery] string format = "json",
CancellationToken cancellationToken = default)
{
// Convert Base64 to stream (wrap in try-catch to throw BadRequestException)
byte[] pdfBytes;
try
{
pdfBytes = Convert.FromBase64String(request.Base64Pdf);
}
catch (FormatException ex)
{
throw new BadRequestException("Invalid Base64 format: " + ex.Message);
}
using var pdfStream = new MemoryStream(pdfBytes);
// Send command to MediatR
var command = new ExtractZugferdCommand { PdfStream = pdfStream };
var result = await mediator.Send(command, cancellationToken);
// Return as file or JSON based on format parameter
if (format.Equals("file", StringComparison.OrdinalIgnoreCase))
{
byte[] xmlBytes = System.Text.Encoding.UTF8.GetBytes(result.XmlContent);
return File(xmlBytes, "application/xml", result.FileName);
}
return Ok(result);
}
}

View File

@@ -1,25 +0,0 @@
<Project Sdk="Microsoft.NET.Sdk.Web">
<PropertyGroup>
<TargetFramework>net8.0</TargetFramework>
<Nullable>enable</Nullable>
<ImplicitUsings>enable</ImplicitUsings>
<GenerateDocumentationFile>true</GenerateDocumentationFile>
</PropertyGroup>
<ItemGroup>
<PackageReference Include="Asp.Versioning.Http" Version="8.1.1" />
<PackageReference Include="Microsoft.Extensions.Caching.StackExchangeRedis" Version="8.0.28" />
<PackageReference Include="Serilog.AspNetCore" Version="10.0.0" />
<PackageReference Include="Serilog.Enrichers.Environment" Version="3.0.1" />
<PackageReference Include="Serilog.Sinks.File" Version="7.0.0" />
<PackageReference Include="Swashbuckle.AspNetCore" Version="6.6.2" />
</ItemGroup>
<ItemGroup>
<ProjectReference Include="..\DocumentOperator.Application\DocumentOperator.Application.csproj" />
<ProjectReference Include="..\DocumentOperator.Domain\DocumentOperator.Domain.csproj" />
<ProjectReference Include="..\DocumentOperator.Infrastructure\DocumentOperator.Infrastructure.csproj" />
</ItemGroup>
</Project>

View File

@@ -1,6 +0,0 @@
@DocumentOperator.API_HostAddress = http://localhost:5028
GET {{DocumentOperator.API_HostAddress}}/weatherforecast/
Accept: application/json
###

View File

@@ -0,0 +1,41 @@
<Project Sdk="Microsoft.NET.Sdk.Web">
<PropertyGroup>
<TargetFramework>net8.0</TargetFramework>
<Nullable>enable</Nullable>
<ImplicitUsings>enable</ImplicitUsings>
<GenerateDocumentationFile>true</GenerateDocumentationFile>
<PackageId>DocumentOperator.API</PackageId>
<Authors>Digital Data GmbH</Authors>
<Company>Digital Data GmbH</Company>
<Product>DocumentOperator.API</Product>
<Version>1.0.0</Version>
<FileVersion>1.0.0.0</FileVersion>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
<InformationalVersion>1.0.0</InformationalVersion>
<Copyright>Copyright © 2026 Digital Data GmbH. All rights reserved.</Copyright>
<Description>PDF Document Operations REST API - Validation, Swiss QR Code extraction, attachments, merge, annotation, stamp operations powered by DevExpress Office File API</Description>
<PackageTags>pdf document operator validation swiss-qr-code annotations stamp devexpress</PackageTags>
</PropertyGroup>
<ItemGroup>
<PackageReference Include="Asp.Versioning.Http" Version="8.1.1" />
<PackageReference Include="Microsoft.Extensions.Caching.StackExchangeRedis" Version="8.0.28" />
<PackageReference Include="Scalar.AspNetCore" Version="1.2.58" />
<PackageReference Include="Serilog.AspNetCore" Version="10.0.0" />
<PackageReference Include="Serilog.Enrichers.Environment" Version="3.0.1" />
<PackageReference Include="Serilog.Sinks.File" Version="7.0.0" />
<PackageReference Include="Serilog.Sinks.SQLite" Version="7.0.0" />
<PackageReference Include="Serilog.UI" Version="3.2.0" />
<PackageReference Include="Serilog.UI.SqliteProvider" Version="1.1.0" />
<PackageReference Include="Swashbuckle.AspNetCore" Version="6.6.2" />
</ItemGroup>
<ItemGroup>
<ProjectReference Include="..\DocumentOperator.Application\DocumentService.Application.csproj" />
<ProjectReference Include="..\DocumentOperator.Domain\DocumentService.Domain.csproj" />
<ProjectReference Include="..\DocumentOperator.Infrastructure\DocumentService.Infrastructure.csproj" />
<ProjectReference Include="..\DocumentService.Client\DocumentService.Client.csproj" />
</ItemGroup>
</Project>

View File

@@ -0,0 +1,6 @@
@DocumentService.API_HostAddress = http://localhost:5028
GET {{DocumentService.API_HostAddress}}/weatherforecast/
Accept: application/json
###

View File

@@ -1,165 +0,0 @@
using DocumentOperator.Application.Common.DTOs;
using DocumentOperator.Application.Features.Documents.ExtractSwissQrCode;
using DocumentOperator.Application.Features.Documents.ValidatePdf;
using DocumentOperator.Domain.Models.ValueObjects;
using MediatR;
using Microsoft.AspNetCore.Mvc;
namespace DocumentOperator.API.Endpoints.v1;
/// <summary>
/// Document endpoints (Minimal API)
/// </summary>
public static class DocumentEndpoints
{
/// <summary>
/// Maps all document-related endpoints
/// </summary>
public static void MapDocumentEndpoints(this IEndpointRouteBuilder app)
{
var group = app.MapGroup("/api/v1/documents")
.WithTags("Documents");
// POST /api/v1/documents/validate
group.MapPost("/validate", ValidatePdf)
.WithName("ValidatePdf")
.WithSummary("Validates a PDF document and returns metadata")
.WithDescription("Validates the PDF format and extracts metadata (page count, file size, PDF version, attachments)")
.Produces<ValidatePdfResponse>(StatusCodes.Status200OK)
.Produces<ProblemDetails>(StatusCodes.Status400BadRequest)
.Produces<ProblemDetails>(StatusCodes.Status500InternalServerError);
// POST /api/v1/documents/extract-swiss-qr-code
group.MapPost("/extract-swiss-qr-code", ExtractSwissQrCode)
.WithName("ExtractSwissQrCode")
.WithSummary("Extracts Swiss QR Code from the last page of a PDF document")
.WithDescription(@"Extracts and parses a Swiss QR Code (Swiss QR Bill Standard 2.0) from the last page of a PDF document.
**Requirements:**
- PDF must contain a valid Swiss QR Code on the last page
- QR Code must conform to Swiss QR Bill Standard 2.0
- References array is required (can be empty)
**Returns:**
- All QR code fields (IBAN, amount, creditor, debtor, reference, etc.)
- References array (passed through from request)
**Use Case:**
Extract payment information from Swiss QR invoices for automated processing.")
.Produces<ExtractSwissQrCodeResponse>(StatusCodes.Status200OK)
.Produces<ProblemDetails>(StatusCodes.Status400BadRequest)
.Produces<ProblemDetails>(StatusCodes.Status404NotFound)
.Produces<ProblemDetails>(StatusCodes.Status500InternalServerError);
}
/// <summary>
/// Validates a PDF document and returns metadata
/// </summary>
/// <param name="request">PDF as Base64 string</param>
/// <param name="mediator">MediatR instance</param>
/// <param name="cancellationToken">Cancellation token</param>
/// <returns>PDF metadata (page count, file size, etc.)</returns>
/// <response code="200">PDF is valid, metadata returned</response>
/// <response code="400">Invalid PDF or Base64 format</response>
/// <response code="500">Internal server error during validation</response>
private static async Task<IResult> ValidatePdf(
ValidatePdfRequest request,
IMediator mediator,
CancellationToken cancellationToken)
{
// DTO → Query (Value Objects erstellen - kann DomainValidationException werfen!)
var query = new ValidatePdfQuery(
Base64String.Create(request.Base64Pdf)
);
// MediatR Handler aufrufen (ValidationBehavior → Handler)
var metadata = await mediator.Send(query, cancellationToken);
// PdfMetadata → Response DTO
var response = new ValidatePdfResponse(
metadata.PageCount,
metadata.FileSizeBytes,
metadata.FileSizeMB,
metadata.PdfVersion,
metadata.HasAttachments,
metadata.AttachmentCount
);
return Results.Ok(response);
}
/// <summary>
/// Extracts Swiss QR Code from the last page of a PDF document
/// </summary>
/// <param name="request">References array + PDF as Base64 string</param>
/// <param name="mediator">MediatR instance</param>
/// <param name="cancellationToken">Cancellation token</param>
/// <returns>References (passed through) + Swiss QR Code data</returns>
/// <response code="200">Swiss QR Code extracted successfully</response>
/// <response code="400">Invalid PDF or Base64 format</response>
/// <response code="404">No Swiss QR Code found on the last page</response>
/// <response code="500">Internal server error during extraction</response>
private static async Task<IResult> ExtractSwissQrCode(
ExtractSwissQrCodeRequest request,
IMediator mediator,
CancellationToken cancellationToken)
{
// DTO → Query (Value Objects erstellen)
var query = new ExtractSwissQrCodeQuery(
References: request.References,
PdfContent: Base64String.Create(request.Base64Pdf)
);
// MediatR Handler aufrufen
var result = await mediator.Send(query, cancellationToken);
// Map Domain Value Object → DTO
var response = new ExtractSwissQrCodeResponse(
References: result.References,
QrCodeData: MapQrCodeDataToDto(result.QrCodeData)
);
return Results.Ok(response);
}
/// <summary>
/// Maps SwissQrCodeData domain value object to DTO
/// </summary>
private static SwissQrCodeDataDto MapQrCodeDataToDto(Domain.ValueObjects.SwissQrCodeData qrCodeData)
{
return new SwissQrCodeDataDto(
QrType: qrCodeData.QrType,
Version: qrCodeData.Version,
CodingType: qrCodeData.CodingType,
Iban: qrCodeData.Iban,
Creditor: MapAddressToDto(qrCodeData.Creditor),
UltimateCreditor: qrCodeData.UltimateCreditor != null ? MapAddressToDto(qrCodeData.UltimateCreditor) : null,
Amount: qrCodeData.Amount,
Currency: qrCodeData.Currency,
UltimateDebtor: qrCodeData.UltimateDebtor != null ? MapAddressToDto(qrCodeData.UltimateDebtor) : null,
ReferenceType: qrCodeData.ReferenceType,
Reference: qrCodeData.Reference,
UnstructuredMessage: qrCodeData.UnstructuredMessage,
BillInformation: qrCodeData.BillInformation,
AlternativeProcedureParameters: qrCodeData.AlternativeProcedureParameters
);
}
/// <summary>
/// Maps AddressData domain value object to DTO
/// </summary>
private static AddressDataDto MapAddressToDto(Domain.ValueObjects.AddressData address)
{
return new AddressDataDto(
AddressType: address.AddressType,
Name: address.Name,
Street: address.Street,
BuildingNumber: address.BuildingNumber,
AddressLine1: address.AddressLine1,
AddressLine2: address.AddressLine2,
PostalCode: address.PostalCode,
City: address.City,
Country: address.Country
);
}
}

View File

@@ -1,36 +1,38 @@
using DocumentOperator.Domain.Common.Exceptions;
using DocumentOperator.Domain.Exceptions;
using DocumentService.Domain.Common.Exceptions;
using FluentValidation;
using Microsoft.AspNetCore.Mvc;
using System.Net;
using System.Text.Json;
namespace DocumentOperator.API.Middleware;
namespace DocumentService.API.Middleware;
/// <summary>
/// Central exception handling middleware
/// Maps exceptions to HTTP status codes and RFC 7807 Problem Details
/// </summary>
public class ExceptionHandlingMiddleware
/// <remarks>
/// Initializes a new instance of the <see cref="ExceptionHandlingMiddleware"/> class.
/// </remarks>
/// <param name="Next">The next middleware in the pipeline.</param>
public class ExceptionHandlingMiddleware(RequestDelegate Next)
{
private readonly RequestDelegate _next;
private readonly ILogger<ExceptionHandlingMiddleware> _logger;
public ExceptionHandlingMiddleware(RequestDelegate next, ILogger<ExceptionHandlingMiddleware> logger)
private static readonly JsonSerializerOptions ProbDetailsJsonOpt = new()
{
_next = next;
_logger = logger;
}
PropertyNamingPolicy = JsonNamingPolicy.CamelCase
};
/// <summary>
/// Invokes the middleware to handle incoming HTTP requests and catch exceptions.
/// </summary>
/// <param name="context">The HTTP context for the current request.</param>
public async Task InvokeAsync(HttpContext context)
{
try
{
await _next(context);
await Next(context);
}
catch (Exception ex)
{
_logger.LogError(ex, "Unhandled exception: {ExceptionMessage}", ex.Message);
await HandleExceptionAsync(context, ex);
}
}
@@ -42,12 +44,7 @@ public class ExceptionHandlingMiddleware
context.Response.StatusCode = (int)statusCode;
context.Response.ContentType = "application/problem+json";
var options = new JsonSerializerOptions
{
PropertyNamingPolicy = JsonNamingPolicy.CamelCase
};
await context.Response.WriteAsync(JsonSerializer.Serialize(problemDetails, options));
await context.Response.WriteAsync(JsonSerializer.Serialize(problemDetails, ProbDetailsJsonOpt));
}
private static (HttpStatusCode StatusCode, ProblemDetails ProblemDetails) MapExceptionToProblemDetails(
@@ -69,15 +66,15 @@ public class ExceptionHandlingMiddleware
}
),
// Domain Validation Exception (400 Bad Request)
DomainValidationException domainEx => (
// Bad Request Exception (400 Bad Request)
BadRequestException badReqEx => (
HttpStatusCode.BadRequest,
new ProblemDetails
{
Type = "https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.1",
Title = "Domain Validation Error",
Type = "https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.4",
Title = "Bad Request",
Status = (int)HttpStatusCode.BadRequest,
Detail = domainEx.Message,
Detail = badReqEx.Message,
Instance = context.Request.Path
}
),
@@ -95,32 +92,6 @@ public class ExceptionHandlingMiddleware
}
),
// Swiss QR Code Not Found Exception (404 Not Found)
SwissQrCodeNotFoundException qrNotFoundEx => (
HttpStatusCode.NotFound,
new ProblemDetails
{
Type = "https://datatracker.ietf.org/doc/html/rfc7231#section-6.5.4",
Title = "Swiss QR Code Not Found",
Status = (int)HttpStatusCode.NotFound,
Detail = qrNotFoundEx.Message,
Instance = context.Request.Path
}
),
// PDF Processing Exception (500 Internal Server Error)
PdfProcessingException pdfEx => (
HttpStatusCode.InternalServerError,
new ProblemDetails
{
Type = "https://datatracker.ietf.org/doc/html/rfc7231#section-6.6.1",
Title = "PDF Processing Error",
Status = (int)HttpStatusCode.InternalServerError,
Detail = pdfEx.Message,
Instance = context.Request.Path
}
),
// Generic Exception (500 Internal Server Error)
_ => (
HttpStatusCode.InternalServerError,

View File

@@ -1,5 +1,8 @@
namespace DocumentOperator.API.Middleware
namespace DocumentService.API.Middleware
{
/// <summary>
/// Placeholder middleware for HTTP request/response logging.
/// </summary>
public class RequestLoggingMiddleware
{
}

View File

@@ -1,5 +1,8 @@
namespace DocumentOperator.API.Middleware
namespace DocumentService.API.Middleware
{
/// <summary>
/// Placeholder middleware for multi-tenancy resolution via X-API-Key header.
/// </summary>
public class TenantResolutionMiddleware
{
}

View File

@@ -1,4 +1,4 @@
# ?? DocumentOperator - Phasenplan (Feature-Driven Development)
# ?? DocumentService - Phasenplan (Feature-Driven Development)
> **Stand:** 17.01.2025 | **Aktuell:** Feature 3 - ExtractAttachments ? NEXT | **Projektdauer:** 6 Wochen
@@ -132,7 +132,7 @@
- ? XML Comments aktiviert
2. **XML-Dokumentation aktiviert**
- ? `API/DocumentOperator.API.csproj`
- ? `API/DocumentService.API.csproj`
- ? `<GenerateDocumentationFile>true</GenerateDocumentationFile>`
3. **Endpoint Dokumentation**
@@ -146,12 +146,12 @@
5. **Program.cs Updates**
- ? `builder.Services.AddSwaggerDocumentation()` statt `AddSwaggerGen()`
- ? `using DocumentOperator.API.Configuration;` hinzugefügt
- ? `using DocumentService.API.Configuration;` hinzugefügt
**Akzeptanzkriterien:**
- ? Build erfolgreich
- ? Alle Tests grün (11/11)
- ? XML-Dokumentation wird generiert (`DocumentOperator.API.xml`)
- ? XML-Dokumentation wird generiert (`DocumentService.API.xml`)
- ? Swagger UI zeigt Endpoint `/api/v1/documents/validate` mit Dokumentation
- ? Request/Response-Schemas sind dokumentiert
- ? Endpoint ist im Swagger UI testbar

View File

@@ -1,10 +1,14 @@
using Serilog;
using DocumentOperator.Infrastructure.Configuration;
using DocumentOperator.Application;
using DocumentOperator.Infrastructure;
using DocumentOperator.API.Middleware;
using DocumentOperator.API.Endpoints.v1;
using DocumentOperator.API.Configuration;
using Serilog.Ui.Core.Extensions;
using Serilog.Ui.SqliteDataProvider.Extensions;
using Serilog.Ui.Web.Extensions;
using Scalar.AspNetCore;
using DocumentService.Infrastructure.Configuration;
using DocumentService.Application;
using DocumentService.Application.Common.Configuration;
using DocumentService.Infrastructure;
using DocumentService.API.Middleware;
using DocumentService.API.Configuration;
var builder = WebApplication.CreateBuilder(args);
@@ -14,20 +18,23 @@ var builder = WebApplication.CreateBuilder(args);
Log.Logger = new LoggerConfiguration()
.ReadFrom.Configuration(builder.Configuration)
.Enrich.FromLogContext()
.Enrich.WithProperty("Application", "DocumentOperator")
.Enrich.WithProperty("Application", "DocumentService")
.CreateLogger();
builder.Host.UseSerilog();
Log.Information("Starting DocumentOperator API...");
Log.Information("Starting DocumentService API...");
try
{
// ========================================
// 2. Options Pattern Configuration
// ========================================
builder.Services.Configure<DocumentOperatorSettings>(
builder.Configuration.GetSection(DocumentOperatorSettings.SectionName));
builder.Services.Configure<DocumentServiceSettings>(
builder.Configuration.GetSection(DocumentServiceSettings.SectionName));
builder.Services.Configure<ZugferdSettings>(
builder.Configuration.GetSection("ZugferdSettings"));
builder.Services.Configure<RedisSettings>(
builder.Configuration.GetSection(RedisSettings.SectionName));
@@ -35,17 +42,37 @@ try
builder.Services.Configure<ApiKeySettings>(
builder.Configuration.GetSection(ApiKeySettings.SectionName));
builder.Services.Configure<SwaggerSettings>(
builder.Configuration.GetSection(SwaggerSettings.SectionName));
// ========================================
// 3. Services (Clean Architecture Layers)
// ========================================
builder.Services.AddApplication(); // Application Layer (MediatR, FluentValidation, Behaviors)
builder.Services.AddApplication(builder.Configuration); // Application Layer (MediatR, FluentValidation, Behaviors)
builder.Services.AddInfrastructure(); // Infrastructure Layer (DevExpress, Services)
builder.Services.AddControllers(); // Controllers (Controller-based API)
builder.Services.AddEndpointsApiExplorer();
builder.Services.AddSwaggerDocumentation();
builder.Services.AddSwaggerDocumentation(builder.Configuration);
// ========================================
// 4. Build App
// 4. Serilog.UI Configuration
// ========================================
var logDirectory = builder.Configuration.GetValue<string>("Application:LogDirectory")
?? throw new InvalidOperationException("Application:LogDirectory not found in configuration.");
var sqliteDbPath = Path.Combine(logDirectory, "logs.db");
builder.Services.AddSerilogUi(logUIOpt =>
{
logUIOpt.UseSqliteServer(dbOpt =>
{
dbOpt.WithConnectionString($"Data Source={sqliteDbPath}");
dbOpt.WithTable("Logs");
});
});
// ========================================
// 5. Build App
// ========================================
var app = builder.Build();
@@ -56,10 +83,32 @@ try
// Exception Handling FIRST (catches all exceptions from subsequent middleware)
app.UseMiddleware<ExceptionHandlingMiddleware>();
if (app.Environment.IsDevelopment())
// ========================================
// Swagger/OpenAPI (Conditional based on settings)
// ========================================
var swaggerSettings = builder.Configuration.GetSection(SwaggerSettings.SectionName).Get<SwaggerSettings>()
?? new SwaggerSettings();
if (app.Environment.IsDevelopment() || swaggerSettings.EnableInProduction)
{
app.UseSwagger();
app.UseSwaggerUI();
// Swagger UI (classic)
app.UseSwaggerUI(options =>
{
options.SwaggerEndpoint($"/swagger/{swaggerSettings.Version}/swagger.json",
$"{swaggerSettings.Title} {swaggerSettings.Version}");
options.RoutePrefix = "swagger"; // /swagger
});
// Scalar UI (modern alternative)
app.MapScalarApiReference(options =>
{
options
.WithTitle(swaggerSettings.Title)
.WithTheme(ScalarTheme.DeepSpace)
.WithDefaultHttpClient(ScalarTarget.CSharp, ScalarClient.HttpClient);
});
}
app.UseSerilogRequestLogging(); // Log HTTP Requests
@@ -67,11 +116,16 @@ try
app.UseHttpsRedirection();
// ========================================
// 6. Endpoints (Minimal API)
// 6. Serilog.UI Dashboard
// ========================================
app.MapDocumentEndpoints(); // POST /api/v1/documents/validate
app.UseSerilogUi(); // Accessible at /serilog-ui
Log.Information("DocumentOperator API started successfully");
// ========================================
// 7. Endpoints (Controller-based API)
// ========================================
app.MapControllers(); // Maps all [ApiController] controllers
Log.Information("DocumentService API started successfully");
app.Run();
}
@@ -86,4 +140,8 @@ finally
}
// Make Program class accessible for Integration Tests
/// <summary>
/// Entry point class for the DocumentService API.
/// Made partial and public for integration test access.
/// </summary>
public partial class Program { }

View File

@@ -0,0 +1,18 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- https://go.microsoft.com/fwlink/?LinkID=208121. -->
<Project>
<PropertyGroup>
<WebPublishMethod>Package</WebPublishMethod>
<LastUsedBuildConfiguration>Release</LastUsedBuildConfiguration>
<LastUsedPlatform>Any CPU</LastUsedPlatform>
<SiteUrlToLaunchAfterPublish />
<LaunchSiteAfterPublish>true</LaunchSiteAfterPublish>
<ExcludeApp_Data>false</ExcludeApp_Data>
<ProjectGuid>c60bc965-d293-ea64-b153-1941f0648df4</ProjectGuid>
<DesktopBuildPackageLocation>M:\App&amp;Service\0 DD - Smart UP\DocumentService\PreRelease\API\net8\$(Version)\DocumentService.API.zip</DesktopBuildPackageLocation>
<PackageAsSingleFile>true</PackageAsSingleFile>
<DeployIisAppPath>DocumentService.API</DeployIisAppPath>
<_TargetId>IISWebDeployPackage</_TargetId>
<TargetFramework>net8.0</TargetFramework>
</PropertyGroup>
</Project>

View File

@@ -0,0 +1,387 @@
# DocumentService API - Manual Testing Guide
This guide contains manual test scenarios for validating the DocumentService API endpoints using Swagger UI or tools like Postman.
---
## Prerequisites
1. **Start the API:**
```powershell
dotnet run --project DocumentService.API
```
Default URL: `https://localhost:5001` (check console output for actual port)
2. **Open Swagger UI:**
Navigate to `https://localhost:<port>/swagger`
3. **Test PDFs:**
- Use PDFs from `fake-pdf/` folder (form.pdf, multi-page.pdf, one-page.pdf, with-image.pdf)
- Or use your own PDF files
---
## Feature 1: Basic PDF Validation
### Endpoint: `POST /api/pdf/validation/validate`
#### Test Case 1.1: Valid PDF (Multipart Upload)
**Objective:** Verify basic PDF validation works with file upload
**Steps:**
1. Open Swagger UI → `/api/pdf/validation/validate`
2. Click "Try it out"
3. Select **multipart/form-data** from dropdown
4. Click "Choose File" and select `fake-pdf/one-page.pdf`
5. Click "Execute"
**Expected Result:**
- **Status Code:** 200 OK
- **Response Body:**
```json
{
"pageCount": 1,
"fileSizeBytes": 7168,
"fileSizeMB": 0.01,
"pdfVersion": "1.4",
"hasAttachments": false,
"attachmentCount": 0
}
```
---
#### Test Case 1.2: Valid PDF (Base64 JSON)
**Objective:** Verify Base64 input works
**Steps:**
1. Convert a PDF to Base64:
```powershell
$bytes = [System.IO.File]::ReadAllBytes("fake-pdf/one-page.pdf")
$base64 = [Convert]::ToBase64String($bytes)
Write-Output $base64
```
2. Open Swagger UI → `/api/pdf/validation/validate`
3. Click "Try it out"
4. Select **application/json** from dropdown
5. Paste into Request Body:
```json
{
"base64Pdf": "<paste-your-base64-here>"
}
```
6. Click "Execute"
**Expected Result:**
- **Status Code:** 200 OK
- Same response as Test 1.1
---
#### Test Case 1.3: Invalid Base64 String
**Objective:** Verify validation rejects malformed Base64
**Steps:**
1. Open Swagger UI → `/api/pdf/validation/validate`
2. Select **application/json**
3. Paste into Request Body:
```json
{
"base64Pdf": "invalid-base64!!!"
}
```
4. Click "Execute"
**Expected Result:**
- **Status Code:** 400 Bad Request
- **Error Message:** Contains "Base64"
---
#### Test Case 1.4: Empty File Upload
**Objective:** Verify empty files are rejected
**Steps:**
1. Create an empty file (`empty.pdf`)
2. Upload via multipart/form-data
**Expected Result:**
- **Status Code:** 400 Bad Request
- **Error Message:** Contains "cannot be empty"
---
#### Test Case 1.5: Large Multi-Page PDF
**Objective:** Verify handling of larger PDFs
**Steps:**
1. Upload `fake-pdf/multi-page.pdf` (49 KB)
**Expected Result:**
- **Status Code:** 200 OK
- **Response:**
```json
{
"pageCount": 3,
"fileSizeBytes": 49152,
"fileSizeMB": 0.05,
"pdfVersion": "1.7",
"hasAttachments": false,
"attachmentCount": 0
}
```
---
#### Test Case 1.6: PDF with Images
**Objective:** Verify image-heavy PDFs are processed
**Steps:**
1. Upload `fake-pdf/with-image.pdf` (256 KB)
**Expected Result:**
- **Status Code:** 200 OK
- **Response:**
```json
{
"pageCount": 1,
"fileSizeBytes": 262144,
"fileSizeMB": 0.25,
"pdfVersion": "1.6",
"hasAttachments": false,
"attachmentCount": 0
}
```
---
## Feature 3: PDF/A Validation
### Endpoint: `POST /api/pdf/validation/validate-pdfa`
#### Test Case 3.1: PDF/A Compliant Document (Multipart)
**Objective:** Verify PDF/A validation detects conformance
**Steps:**
1. Open Swagger UI → `/api/pdf/validation/validate-pdfa`
2. Select **multipart/form-data**
3. Upload a PDF/A-compliant PDF (if available)
4. Click "Execute"
**Expected Result (if PDF/A compliant):**
- **Status Code:** 200 OK
- **Response:**
```json
{
"isValid": true,
"pdfVersion": "1.7",
"pageCount": 1,
"fileSize": 12345,
"encrypted": false,
"pdfAVersion": "PDF/A-3b",
"pdfACompliant": true,
"errors": [],
"warnings": []
}
```
---
#### Test Case 3.2: Non-PDF/A Document
**Objective:** Verify regular PDFs are detected as non-compliant
**Steps:**
1. Upload `fake-pdf/one-page.pdf` (regular PDF, NOT PDF/A)
**Expected Result:**
- **Status Code:** 200 OK
- **Response:**
```json
{
"isValid": true,
"pdfVersion": "1.4",
"pageCount": 1,
"fileSize": 7168,
"encrypted": false,
"pdfAVersion": null,
"pdfACompliant": false,
"errors": [],
"warnings": ["Manual verification recommended: PDF/A compliance requires all fonts to be embedded"]
}
```
---
#### Test Case 3.3: Encrypted PDF
**Objective:** Verify encrypted PDFs are flagged
**Steps:**
1. Create or obtain a password-protected PDF
2. Upload via multipart/form-data
**Expected Result:**
- **Status Code:** 200 OK
- **Response:**
```json
{
"isValid": true,
"pdfVersion": "1.7",
"pageCount": 1,
"fileSize": 12345,
"encrypted": true,
"pdfAVersion": null,
"pdfACompliant": false,
"errors": ["Encrypted PDFs cannot be PDF/A compliant"],
"warnings": []
}
```
---
#### Test Case 3.4: Invalid Base64 (PDF/A Endpoint)
**Objective:** Verify validation works on PDF/A endpoint
**Steps:**
1. Select **application/json**
2. Paste:
```json
{
"base64Pdf": "not-base64!!!"
}
```
**Expected Result:**
- **Status Code:** 400 Bad Request
- **Error Message:** Contains "Base64"
---
#### Test Case 3.5: Empty Request
**Objective:** Verify both inputs missing is rejected
**Steps:**
1. Select **application/json**
2. Paste:
```json
{
"pdfBytes": null,
"base64Pdf": ""
}
```
**Expected Result:**
- **Status Code:** 400 Bad Request
- **Error Message:** "Either PdfBytes or Base64Pdf must be provided, but not both"
---
## Feature 2: Swiss QR Code Extraction
### Endpoint: `POST /api/swissqrcode/extract`
#### Test Case 2.1: PDF with Swiss QR Code
**Objective:** Extract Swiss QR Bill from PDF
**Steps:**
1. Open Swagger UI → `/api/swissqrcode/extract`
2. Select **multipart/form-data**
3. Upload a PDF containing Swiss QR Code on the **last page**
4. Click "Execute"
**Expected Result (if QR code present):**
- **Status Code:** 200 OK
- **Response:** Contains Swiss QR Bill details (IBAN, amount, creditor, debtor, reference)
---
#### Test Case 2.2: PDF without QR Code
**Objective:** Verify graceful handling when no QR code exists
**Steps:**
1. Upload `fake-pdf/one-page.pdf` (no QR code)
**Expected Result:**
- **Status Code:** 404 Not Found
- **Error Message:** "Swiss QR Code not found in PDF"
---
## Common Error Scenarios
### Test Case E1: Missing File in Multipart Request
**Steps:**
1. Any multipart endpoint
2. Don't select a file, click "Execute"
**Expected Result:**
- **Status Code:** 400 Bad Request
---
### Test Case E2: Both PdfBytes AND Base64Pdf Provided
**Steps:**
1. Attempt to send JSON with both fields populated
```json
{
"pdfBytes": [1,2,3],
"base64Pdf": "dGVzdA=="
}
```
**Expected Result:**
- **Status Code:** 400 Bad Request
- **Error Message:** "Either PdfBytes or Base64Pdf must be provided, but not both"
---
### Test Case E3: Corrupted PDF File
**Steps:**
1. Create a text file with `.pdf` extension containing "FAKE PDF CONTENT"
2. Upload it
**Expected Result:**
- **Status Code:** 500 Internal Server Error
- **Error Message:** Contains "PDF processing error"
---
## Test Coverage Summary
| Feature | Endpoint | Test Cases |
|---------|----------|------------|
| Basic PDF Validation | `POST /api/pdf/validation/validate` | 6 |
| PDF/A Validation | `POST /api/pdf/validation/validate-pdfa` | 5 |
| Swiss QR Code | `POST /api/swissqrcode/extract` | 2 |
| Error Handling | All endpoints | 3 |
| **TOTAL** | | **16 Manual Test Cases** |
---
## Notes
- All endpoints support **BOTH** `multipart/form-data` (file upload) AND `application/json` (Base64)
- FluentValidation runs before handlers (400 errors indicate validation failures)
- DevExpress evaluation warnings (DX1000/DX1001) are expected and can be ignored
- Test PDFs in `fake-pdf/` folder are small samples; use real-world PDFs for comprehensive testing
---
## Quick PowerShell Helpers
**Convert PDF to Base64:**
```powershell
$bytes = [System.IO.File]::ReadAllBytes("path\to\file.pdf")
$base64 = [Convert]::ToBase64String($bytes)
$base64 | Set-Clipboard # Copies to clipboard
```
**Create empty PDF for testing:**
```powershell
New-Item -Path "empty.pdf" -ItemType File -Force
```
**Check if file is valid PDF:**
```powershell
$header = Get-Content -Path "file.pdf" -TotalCount 1 -Encoding Byte
# Should start with: 0x25 0x50 0x44 0x46 (%PDF)
```

File diff suppressed because it is too large Load Diff

View File

@@ -5,8 +5,8 @@
}
},
"DocumentOperatorSettings": {
"TempFolderPath": "C:\\Temp\\DocumentOperator\\Dev",
"DocumentServiceSettings": {
"TempFolderPath": "C:\\Temp\\DocumentService\\Dev",
"EnableDetailedLogging": true
},

View File

@@ -7,6 +7,17 @@
},
"AllowedHosts": "*",
"Application": {
"LogDirectory": "E:\\LogFiles\\Digital Data\\DocumentService.API"
},
"SwaggerSettings": {
"EnableInProduction": true,
"Title": "DocumentService API",
"Version": "v1",
"Description": "PDF document processing service using DevExpress"
},
"Serilog": {
"MinimumLevel": {
"Default": "Information",
@@ -30,21 +41,45 @@
"rollingInterval": "Day",
"outputTemplate": "{Timestamp:yyyy-MM-dd HH:mm:ss.fff zzz} [{Level:u3}] {Message:lj} {Properties:j}{NewLine}{Exception}"
}
},
{
"Name": "SQLite",
"Args": {
"sqliteDbPath": "E:\\LogFiles\\Digital Data\\DocumentService.API\\logs.db",
"tableName": "Logs",
"storeTimestampInUtc": true
}
}
],
"Enrich": [ "FromLogContext", "WithMachineName", "WithThreadId" ]
},
"DocumentOperatorSettings": {
"TempFolderPath": "C:\\Temp\\DocumentOperator",
"DocumentServiceSettings": {
"TempFolderPath": "C:\\Temp\\DocumentService",
"TempFileRetentionHours": 24,
"MaxPdfSizeMB": 50,
"EnableDetailedLogging": true
},
"ZugferdSettings": {
"ZugferdFileNames": [
"factur-x.xml",
"zugferd-invoice.xml",
"ZUGFeRD-invoice.xml",
"xrechnung.xml",
"XRechnung.xml"
],
"ZugferdFileNamePatterns": [
"factur",
"zugferd",
"xrechnung",
"peppol"
]
},
"RedisSettings": {
"ConnectionString": "localhost:6379",
"InstanceName": "DocumentOperator:",
"InstanceName": "DocumentService:",
"CacheExpirationMinutes": 60
},
@@ -62,5 +97,6 @@
"IsActive": true
}
}
}
},
"LuckyPennySoftLicenseKey": "eyJhbGciOiJSUzI1NiIsImtpZCI6Ikx1Y2t5UGVubnlTb2Z0d2FyZUxpY2Vuc2VLZXkvYmJiMTNhY2I1OTkwNGQ4OWI0Y2IxYzg1ZjA4OGNjZjkiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL2x1Y2t5cGVubnlzb2Z0d2FyZS5jb20iLCJhdWQiOiJMdWNreVBlbm55U29mdHdhcmUiLCJleHAiOiIxODE2MTI4MDAwIiwiaWF0IjoiMTc4NDYyNDU1NyIsImFjY291bnRfaWQiOiIwMTk4M2M1OWU0YjM3MjhlYmZkMzEwM2MyYTQ4NmU4NSIsImN1c3RvbWVyX2lkIjoiMDE5ODNjNTllNGIzNzI4ZWJmZDMxMDNjMmE0ODZlODUiLCJzdWJfaWQiOiItIiwiZWRpdGlvbiI6IjAiLCJ0eXBlIjoiMiJ9.IUUO926m9crYGYxMjjKD_n9BnUm-EDyjFIn0YmMUCo7C-QTwvB8WhXP8veTSFsBq-leIIDJ4jyl7Pgc_7ciwg1XhUSIs4mkQroEUaSFCGOxw7Pi41WM8MK5YFSaqLTYYXec9zxgiJbGzABbh3CHTSup3okGnVm_CMoPEs91l2c0A6N1JyZy74urd_tF0KGVKf0MOvzdlQIWLQ8o73S4pTv2N-F6UlzI0fdMtTHMLNNQyr0NdWdnuBk_jMBXO-gy5RE_oCRfMTTYRX2n3XLK6pTfXE0Ct338o9F5sH8Ph2lTXSu56cpdsfZOQZGqCH0LoFp1Dd7RJgIgNmBiTGfvDnA"
}

View File

@@ -0,0 +1,78 @@
using DocumentService.Application.Common.Interfaces;
using DocumentService.Domain.Models.ValueObjects;
using FluentValidation;
using MediatR;
namespace DocumentService.Application.AddAnnotation;
/// <summary>
/// Command to add an annotation to a PDF document.
/// </summary>
public record AddAnnotationCommand : IRequest<byte[]>
{
public required Stream PdfStream { get; init; }
public required AnnotationType AnnotationType { get; init; }
public required int PageNumber { get; init; }
public required (double X1, double Y1, double X2, double Y2) Rectangle { get; init; }
public string? Content { get; init; }
public string? Author { get; init; }
public string? Color { get; init; }
public TextMarkupStyle? TextMarkupStyle { get; init; }
public AnnotationOrigin Origin { get; init; } = AnnotationOrigin.BottomLeft;
}
/// <summary>
/// Handler for AddAnnotationCommand.
/// </summary>
public class AddAnnotationHandler(IPdfProcessor pdfProcessor) : IRequestHandler<AddAnnotationCommand, byte[]>
{
public async Task<byte[]> Handle(AddAnnotationCommand request, CancellationToken cancellationToken)
{
return await pdfProcessor.AddAnnotationAsync(
request.PdfStream,
request.AnnotationType,
request.PageNumber,
request.Rectangle,
request.Content,
request.Author,
request.Color,
request.TextMarkupStyle,
request.Origin);
}
}
/// <summary>
/// Validator for AddAnnotationCommand.
/// </summary>
public class AddAnnotationValidator : AbstractValidator<AddAnnotationCommand>
{
public AddAnnotationValidator()
{
RuleFor(x => x.PdfStream)
.NotNull()
.WithMessage("PDF stream is required");
RuleFor(x => x.PageNumber)
.GreaterThan(0)
.WithMessage("Page number must be greater than 0");
RuleFor(x => x.Content)
.NotEmpty()
.When(x => x.AnnotationType == AnnotationType.FreeText || x.AnnotationType == AnnotationType.StickyNote)
.WithMessage("Content is required for FreeText and StickyNote annotations");
RuleFor(x => x.TextMarkupStyle)
.NotNull()
.When(x => x.AnnotationType == AnnotationType.TextMarkup)
.WithMessage("TextMarkupStyle is required for TextMarkup annotations");
RuleFor(x => x.Color)
.Matches("^[0-9A-Fa-f]{6}$")
.When(x => !string.IsNullOrWhiteSpace(x.Color))
.WithMessage("Color must be a 6-digit hex value (e.g., 'FF0000' for red)");
RuleFor(x => x.Rectangle)
.Must(r => r.X2 > r.X1 && r.Y2 > r.Y1)
.WithMessage("Rectangle coordinates must define a valid area (X2 > X1 and Y2 > Y1)");
}
}

View File

@@ -0,0 +1,90 @@
using DocumentService.Application.Common.Interfaces;
using FluentValidation;
using MediatR;
namespace DocumentService.Application.AddAttachments;
/// <summary>
/// Command to add one or more attachments to a PDF document (supports PDF/A-3)
/// </summary>
public record AddAttachmentsCommand : IRequest<byte[]>
{
/// <summary>
/// PDF document stream. Must be positioned at the beginning (Position = 0).
/// </summary>
public required Stream PdfStream { get; init; }
/// <summary>
/// List of attachments to embed (filename, content, optional MIME type)
/// </summary>
public required IReadOnlyList<AttachmentFile> Attachments { get; init; }
}
/// <summary>
/// Represents a file to be attached to a PDF
/// </summary>
public record AttachmentFile
{
/// <summary>
/// File name (e.g., "invoice.xml", "document.pdf")
/// </summary>
public required string FileName { get; init; }
/// <summary>
/// File content as byte array
/// </summary>
public required byte[] Content { get; init; }
/// <summary>
/// MIME type (optional, e.g., "application/xml", "application/pdf")
/// If not provided, will be inferred from file extension
/// </summary>
public string? MimeType { get; init; }
}
/// <summary>
/// Handler for AddAttachmentsCommand
/// </summary>
public class AddAttachmentsCommandHandler(IPdfProcessor pdfProcessor)
: IRequestHandler<AddAttachmentsCommand, byte[]>
{
public async Task<byte[]> Handle(AddAttachmentsCommand request, CancellationToken cancellationToken)
{
// Convert to tuple list for IPdfProcessor
var attachmentTuples = request.Attachments
.Select(a => (a.FileName, a.Content, a.MimeType))
.ToList();
return await pdfProcessor.AddAttachmentsAsync(request.PdfStream, attachmentTuples);
}
}
/// <summary>
/// Validator for AddAttachmentsCommand
/// </summary>
public class AddAttachmentsCommandValidator : AbstractValidator<AddAttachmentsCommand>
{
public AddAttachmentsCommandValidator()
{
RuleFor(x => x.PdfStream)
.NotNull()
.WithMessage("PDF stream is required");
RuleFor(x => x.Attachments)
.NotNull()
.NotEmpty()
.WithMessage("At least one attachment is required");
RuleForEach(x => x.Attachments).ChildRules(attachment =>
{
attachment.RuleFor(a => a.FileName)
.NotEmpty()
.WithMessage("Attachment file name is required");
attachment.RuleFor(a => a.Content)
.NotNull()
.NotEmpty()
.WithMessage("Attachment content is required");
});
}
}

View File

@@ -0,0 +1,125 @@
using FluentValidation;
using MediatR;
namespace DocumentService.Application.AddStamp;
/// <summary>
/// Command to add a stamp (text, image, or predefined) to PDF pages.
/// Combines Command, Handler, and Validator in a single file (Vertical Slice pattern).
/// </summary>
public record AddStampCommand : IRequest<byte[]>
{
public required Stream PdfStream { get; init; }
public required Domain.Models.ValueObjects.StampType StampType { get; init; }
public int[]? PageNumbers { get; init; } // null = all pages
public required (double X, double Y) Position { get; init; }
public (double Width, double Height)? Size { get; init; }
public Domain.Models.ValueObjects.AnnotationOrigin Origin { get; init; } = Domain.Models.ValueObjects.AnnotationOrigin.BottomLeft;
public string? Text { get; init; }
public string? FontName { get; init; }
public double? FontSize { get; init; }
public string? Color { get; init; }
public double? Opacity { get; init; }
public double? Rotation { get; init; }
public Domain.Models.ValueObjects.StampPlacement Placement { get; init; } = Domain.Models.ValueObjects.StampPlacement.Foreground;
public byte[]? ImageBytes { get; init; }
public Domain.Models.ValueObjects.PredefinedStampType? PredefinedType { get; init; }
}
/// <summary>
/// Handler for AddStampCommand.
/// </summary>
public class AddStampHandler(Common.Interfaces.IPdfProcessor pdfProcessor) : IRequestHandler<AddStampCommand, byte[]>
{
public async Task<byte[]> Handle(AddStampCommand command, CancellationToken cancellationToken)
{
return await pdfProcessor.AddStampAsync(
command.PdfStream,
command.StampType,
command.PageNumbers,
command.Position,
command.Size,
command.Origin,
command.Text,
command.FontName,
command.FontSize,
command.Color,
command.Opacity,
command.Rotation,
command.Placement,
command.ImageBytes,
command.PredefinedType
);
}
}
/// <summary>
/// Validator for AddStampCommand.
/// </summary>
public class AddStampValidator : AbstractValidator<AddStampCommand>
{
public AddStampValidator()
{
RuleFor(x => x.PdfStream)
.NotNull().WithMessage("PDF stream is required");
RuleFor(x => x.Position.X)
.GreaterThanOrEqualTo(0).WithMessage("Position X must be >= 0");
RuleFor(x => x.Position.Y)
.GreaterThanOrEqualTo(0).WithMessage("Position Y must be >= 0");
// Text stamp validation
When(x => x.StampType == Domain.Models.ValueObjects.StampType.Text, () =>
{
RuleFor(x => x.Text)
.NotEmpty().WithMessage("Text is required for Text stamp type");
});
// Image stamp validation
When(x => x.StampType == Domain.Models.ValueObjects.StampType.Image, () =>
{
RuleFor(x => x.ImageBytes)
.NotNull().WithMessage("Image bytes are required for Image stamp type")
.Must(bytes => bytes != null && bytes.Length > 0).WithMessage("Image bytes cannot be empty");
});
// Predefined stamp validation
When(x => x.StampType == Domain.Models.ValueObjects.StampType.Predefined, () =>
{
RuleFor(x => x.PredefinedType)
.NotNull().WithMessage("Predefined type is required for Predefined stamp type");
});
// Optional parameter validations
When(x => x.Opacity.HasValue, () =>
{
RuleFor(x => x.Opacity!.Value)
.InclusiveBetween(0.0, 1.0).WithMessage("Opacity must be between 0.0 and 1.0");
});
When(x => x.Rotation.HasValue, () =>
{
RuleFor(x => x.Rotation!.Value)
.InclusiveBetween(0.0, 360.0).WithMessage("Rotation must be between 0 and 360 degrees");
});
When(x => x.FontSize.HasValue, () =>
{
RuleFor(x => x.FontSize!.Value)
.GreaterThan(0).WithMessage("Font size must be positive");
});
When(x => !string.IsNullOrWhiteSpace(x.Color), () =>
{
RuleFor(x => x.Color!)
.Matches(@"^[0-9A-Fa-f]{6}$").WithMessage("Color must be 6-digit hex (e.g., 'FF0000')");
});
When(x => x.PageNumbers != null, () =>
{
RuleFor(x => x.PageNumbers!)
.Must(pages => pages.All(p => p > 0)).WithMessage("All page numbers must be >= 1");
});
}
}

View File

@@ -0,0 +1,37 @@
using AutoMapper;
using DocumentService.Application.Common.DTOs;
using DocumentService.Application.Common.Interfaces;
using MediatR;
namespace DocumentService.Application.CheckPdfAttachments.Queries;
/// <summary>
/// Query for checking PDF attachments (Stream-based)
/// </summary>
public record CheckPdfAttachmentsQuery : IRequest<AttachmentCheckResult>
{
/// <summary>
/// PDF as stream (caller is responsible for disposal)
/// </summary>
public required Stream PdfStream { get; init; }
}
/// <summary>
/// Handler for CheckPdfAttachmentsQuery
/// Orchestrates PDF attachment checking using IPdfProcessor and AutoMapper
/// </summary>
public class CheckPdfAttachmentsQueryHandler(IPdfProcessor PdfProcessor, IMapper Mapper)
: IRequestHandler<CheckPdfAttachmentsQuery, AttachmentCheckResult>
{
/// <summary>
/// Checks PDF attachments and returns detailed metadata
/// </summary>
public async Task<AttachmentCheckResult> Handle(CheckPdfAttachmentsQuery request, CancellationToken cancellationToken)
{
// Call DevExpress service directly with stream (exceptions propagate naturally)
var attachmentInfo = await PdfProcessor.CheckAttachmentsAsync(request.PdfStream);
// Map DTO to response DTO using AutoMapper
return Mapper.Map<AttachmentCheckResult>(attachmentInfo);
}
}

View File

@@ -0,0 +1,18 @@
using FluentValidation;
namespace DocumentService.Application.CheckPdfAttachments.Queries;
/// <summary>
/// Validator for CheckPdfAttachmentsQuery
/// Ensures PdfStream is not null
/// </summary>
public class CheckPdfAttachmentsQueryValidator : AbstractValidator<CheckPdfAttachmentsQuery>
{
public CheckPdfAttachmentsQueryValidator()
{
// Rule: PdfStream must be provided and non-empty
RuleFor(x => x.PdfStream)
.NotNull()
.WithMessage("PdfStream is required");
}
}

View File

@@ -2,22 +2,15 @@ using MediatR;
using Microsoft.Extensions.Logging;
using System.Diagnostics;
namespace DocumentOperator.Application.Common.Behaviors;
namespace DocumentService.Application.Common.Behaviors;
/// <summary>
/// MediatR Pipeline Behavior that logs requests and tracks performance
/// Executes AFTER ValidationBehavior, BEFORE Handler
/// </summary>
public class LoggingBehavior<TRequest, TResponse> : IPipelineBehavior<TRequest, TResponse>
public class LoggingBehavior<TRequest, TResponse>(ILogger<LoggingBehavior<TRequest, TResponse>> Logger) : IPipelineBehavior<TRequest, TResponse>
where TRequest : IRequest<TResponse>
{
private readonly ILogger<LoggingBehavior<TRequest, TResponse>> _logger;
public LoggingBehavior(ILogger<LoggingBehavior<TRequest, TResponse>> logger)
{
_logger = logger;
}
public async Task<TResponse> Handle(
TRequest request,
RequestHandlerDelegate<TResponse> next,
@@ -25,21 +18,18 @@ public class LoggingBehavior<TRequest, TResponse> : IPipelineBehavior<TRequest,
{
var requestName = typeof(TRequest).Name;
// Request Start
_logger.LogInformation("Handling {RequestName}: {@Request}", requestName, request);
// Performance Tracking
var stopwatch = Stopwatch.StartNew();
try
{
// Handler ausführen
var response = await next();
var response = await next(cancellationToken);
stopwatch.Stop();
// Request Success
_logger.LogInformation(
Logger.LogInformation(
"Handled {RequestName} in {ElapsedMs}ms",
requestName,
stopwatch.ElapsedMilliseconds
@@ -52,7 +42,7 @@ public class LoggingBehavior<TRequest, TResponse> : IPipelineBehavior<TRequest,
stopwatch.Stop();
// Request Failed
_logger.LogError(
Logger.LogError(
ex,
"Error handling {RequestName} after {ElapsedMs}ms: {ErrorMessage}",
requestName,

View File

@@ -1,7 +1,7 @@
using FluentValidation;
using MediatR;
namespace DocumentOperator.Application.Common.Behaviors;
namespace DocumentService.Application.Common.Behaviors;
/// <summary>
/// MediatR Pipeline Behavior that validates requests using FluentValidation

View File

@@ -0,0 +1,29 @@
namespace DocumentService.Application.Common.Configuration;
/// <summary>
/// Configuration settings for ZUGFeRD/Factur-X/XRechnung detection
/// </summary>
public class ZugferdSettings
{
/// <summary>
/// Exact ZUGFeRD/Factur-X/XRechnung file names to check (case-insensitive)
/// </summary>
public List<string> ZugferdFileNames { get; set; } = new()
{
"factur-x.xml",
"zugferd-invoice.xml",
"ZUGFeRD-invoice.xml",
"xrechnung.xml"
};
/// <summary>
/// Partial filename patterns for ZUGFeRD detection (case-insensitive)
/// </summary>
public List<string> ZugferdFileNamePatterns { get; set; } = new()
{
"factur",
"zugferd",
"xrechnung",
"peppol"
};
}

View File

@@ -0,0 +1,43 @@
namespace DocumentService.Application.Common.DTOs;
/// <summary>
/// DTO for attachment check result returned to API layer
/// </summary>
public record AttachmentCheckResult
{
/// <summary>
/// Indicates whether the PDF contains any attachments
/// </summary>
public bool HasAttachments { get; init; }
/// <summary>
/// Total number of attachments in the PDF
/// </summary>
public int AttachmentCount { get; init; }
/// <summary>
/// List of attachment metadata (file details)
/// </summary>
public List<AttachmentDto> Attachments { get; init; } = new();
}
/// <summary>
/// DTO for individual attachment metadata
/// </summary>
public record AttachmentDto
{
/// <summary>
/// Attachment file name (e.g., "invoice.xml", "document.pdf")
/// </summary>
public string FileName { get; init; } = string.Empty;
/// <summary>
/// MIME type of the attachment (e.g., "text/xml", "application/pdf")
/// </summary>
public string MimeType { get; init; } = string.Empty;
/// <summary>
/// Attachment file size in bytes
/// </summary>
public long Size { get; init; }
}

View File

@@ -0,0 +1,60 @@
namespace DocumentService.Application.Common.DTOs;
/// <summary>
/// Represents complete attachment information for a PDF document.
/// Immutable value object containing attachment presence flag, count, and detailed metadata.
/// </summary>
public sealed class AttachmentInfo
{
/// <summary>
/// Gets a value indicating whether the PDF contains any attachments
/// </summary>
public bool HasAttachments { get; }
/// <summary>
/// Gets the total number of attachments in the PDF
/// </summary>
public int AttachmentCount { get; }
/// <summary>
/// Gets the collection of attachment metadata (file details)
/// </summary>
public IReadOnlyList<AttachmentMetadata> Attachments { get; }
/// <summary>
/// Initializes a new instance of the AttachmentInfo class.
/// </summary>
/// <param name="hasAttachments">Whether PDF has attachments</param>
/// <param name="attachmentCount">Total number of attachments</param>
/// <param name="attachments">List of attachment metadata (can be empty)</param>
public AttachmentInfo(bool hasAttachments, int attachmentCount, IReadOnlyList<AttachmentMetadata> attachments)
{
HasAttachments = hasAttachments;
AttachmentCount = attachmentCount;
Attachments = attachments ?? [];
// Defensive Programming: Ensure count matches list length
if (Attachments.Count != attachmentCount)
{
throw new ArgumentException(
$"Attachment count mismatch: expected {attachmentCount}, got {Attachments.Count}",
nameof(attachments));
}
}
/// <summary>
/// Creates an AttachmentInfo instance for a PDF with no attachments.
/// </summary>
public static AttachmentInfo Empty =>
new(
hasAttachments: false,
attachmentCount: 0,
attachments: []);
public override string ToString()
{
return HasAttachments
? $"PDF has {AttachmentCount} attachment(s): {string.Join(", ", Attachments.Select(a => a.FileName))}"
: "PDF has no attachments";
}
}

View File

@@ -0,0 +1,44 @@
namespace DocumentService.Application.Common.DTOs;
/// <summary>
/// Represents metadata of a single PDF attachment (embedded file).
/// Immutable value object containing file information without the actual binary data.
/// </summary>
/// <remarks>
/// Initializes a new instance of the AttachmentMetadata class.
/// </remarks>
/// <param name="fileName">Attachment file name</param>
/// <param name="mimeType">MIME type (e.g., "text/xml")</param>
/// <param name="sizeBytes">File size in bytes</param>
public sealed class AttachmentMetadata(string fileName, string mimeType, long sizeBytes)
{
/// <summary>
/// Gets the attachment file name (e.g., "invoice.xml", "document.pdf")
/// </summary>
public string FileName { get; } = fileName ?? string.Empty;
/// <summary>
/// Gets the MIME type of the attachment (e.g., "text/xml", "application/pdf")
/// </summary>
public string MimeType { get; } = mimeType ?? "application/octet-stream"; // Default MIME type if unknown
/// <summary>
/// Gets the attachment file size in bytes
/// </summary>
public long SizeBytes { get; } = sizeBytes;
/// <summary>
/// Gets the attachment file size in kilobytes (computed property)
/// </summary>
public double SizeKB => SizeBytes / 1024.0;
/// <summary>
/// Gets the attachment file size in megabytes (computed property)
/// </summary>
public double SizeMB => SizeBytes / 1024.0 / 1024.0;
public override string ToString()
{
return $"{FileName} ({MimeType}, {SizeKB:F2} KB)";
}
}

View File

@@ -1,18 +0,0 @@
namespace DocumentOperator.Application.Common.DTOs;
/// <summary>
/// Request to extract Swiss QR Code from a PDF document.
/// The QR code must be located on the last page of the document.
/// </summary>
/// <param name="References">Array of reference strings to pass through in the response</param>
/// <param name="Base64Pdf">PDF document encoded as Base64 string</param>
/// <example>
/// {
/// "references": ["REF-001", "REF-002"],
/// "base64Pdf": "JVBERi0xLjQK..."
/// }
/// </example>
public record ExtractSwissQrCodeRequest(
IReadOnlyList<string> References,
string Base64Pdf
);

View File

@@ -1,116 +0,0 @@
namespace DocumentOperator.Application.Common.DTOs;
/// <summary>
/// Response containing extracted Swiss QR Code data and passed-through references.
/// </summary>
/// <param name="References">Reference strings passed through from the request</param>
/// <param name="QrCodeData">Parsed Swiss QR Code data from the last page of the PDF</param>
/// <example>
/// {
/// "references": ["REF-001", "REF-002"],
/// "qrCodeData": {
/// "qrType": "SPC",
/// "version": "0200",
/// "codingType": "1",
/// "iban": "CH4431999123000889012",
/// "creditor": {
/// "addressType": "S",
/// "name": "Robert Schneider AG",
/// "street": "Rue du Lac",
/// "buildingNumber": "1268",
/// "postalCode": "2501",
/// "city": "Biel",
/// "country": "CH"
/// },
/// "amount": 1949.75,
/// "currency": "CHF",
/// "referenceType": "QRR",
/// "reference": "210000000003139471430009017"
/// }
/// }
/// </example>
public record ExtractSwissQrCodeResponse(
IReadOnlyList<string> References,
SwissQrCodeDataDto QrCodeData
);
/// <summary>
/// Swiss QR Code data according to Swiss QR Bill Standard 2.0.
/// Contains all fields defined in the Swiss Payment Standards.
/// </summary>
public record SwissQrCodeDataDto(
/// <summary>QR type - always "SPC" for Swiss Payment Code</summary>
string QrType,
/// <summary>Version of the Swiss QR Code standard (e.g., "0200" for version 2.0)</summary>
string Version,
/// <summary>Character set code (always "1" for UTF-8)</summary>
string CodingType,
/// <summary>IBAN of the creditor (payee)</summary>
string Iban,
/// <summary>Creditor (payee) information</summary>
AddressDataDto Creditor,
/// <summary>Ultimate creditor information (optional)</summary>
AddressDataDto? UltimateCreditor,
/// <summary>Payment amount (null if not specified)</summary>
decimal? Amount,
/// <summary>Currency code (CHF or EUR)</summary>
string Currency,
/// <summary>Ultimate debtor (payer) information (optional)</summary>
AddressDataDto? UltimateDebtor,
/// <summary>Reference type: "QRR" (QR Reference), "SCOR" (Creditor Reference ISO 11649), or "NON" (No Reference)</summary>
string ReferenceType,
/// <summary>Payment reference (format depends on ReferenceType)</summary>
string? Reference,
/// <summary>Unstructured message (max 140 characters)</summary>
string? UnstructuredMessage,
/// <summary>Bill information (structured data for automated processing)</summary>
string? BillInformation,
/// <summary>Alternative procedure parameters (up to 2 entries)</summary>
IReadOnlyList<string>? AlternativeProcedureParameters
);
/// <summary>
/// Address data in Swiss QR Code (creditor or debtor).
/// Can be either structured (S) or combined (K) format.
/// </summary>
public record AddressDataDto(
/// <summary>Address type: "S" for structured, "K" for combined</summary>
string AddressType,
/// <summary>Name of person or company</summary>
string Name,
/// <summary>Street name (structured address only)</summary>
string? Street,
/// <summary>Building number (structured address only)</summary>
string? BuildingNumber,
/// <summary>Address line 1 (combined address only)</summary>
string? AddressLine1,
/// <summary>Address line 2 (combined address only)</summary>
string? AddressLine2,
/// <summary>Postal code</summary>
string PostalCode,
/// <summary>City/town name</summary>
string City,
/// <summary>Two-letter country code (ISO 3166-1 alpha-2)</summary>
string Country
);

View File

@@ -0,0 +1,34 @@
namespace DocumentService.Application.Common.DTOs;
/// <summary>
/// PDF/A validation metadata including conformance level and validation errors/warnings
/// </summary>
public sealed class PdfAMetadata(
bool isValid,
string pdfVersion,
int pageCount,
long fileSizeBytes,
bool encrypted,
string? pdfaVersion,
bool pdfaCompliant,
IReadOnlyList<string> errors,
IReadOnlyList<string> warnings)
{
public bool IsValid { get; } = isValid;
public string PdfVersion { get; } = pdfVersion;
public int PageCount { get; } = pageCount;
public long FileSizeBytes { get; } = fileSizeBytes;
public bool Encrypted { get; } = encrypted;
public string? PdfAVersion { get; } = pdfaVersion;
public bool PdfACompliant { get; } = pdfaCompliant;
public IReadOnlyList<string> Errors { get; } = errors;
public IReadOnlyList<string> Warnings { get; } = warnings;
// Computed property
public double FileSizeMB => FileSizeBytes / 1024.0 / 1024.0;
public override string ToString()
{
return $"PDF/A: {PdfAVersion ?? "None"}, {PageCount} pages, {FileSizeMB:F2} MB, Compliant: {PdfACompliant}";
}
}

View File

@@ -0,0 +1,52 @@
namespace DocumentService.Application.Common.DTOs;
/// <summary>
/// PDF/A validation result including conformance level and validation errors/warnings
/// </summary>
public record PdfAValidationResult
{
/// <summary>
/// Whether the PDF is valid (no errors)
/// </summary>
public bool IsValid { get; init; }
/// <summary>
/// PDF version (e.g., "1.4", "1.7")
/// </summary>
public string PdfVersion { get; init; } = string.Empty;
/// <summary>
/// Number of pages in the PDF
/// </summary>
public int PageCount { get; init; }
/// <summary>
/// File size in bytes
/// </summary>
public long FileSize { get; init; }
/// <summary>
/// Whether the PDF is encrypted
/// </summary>
public bool Encrypted { get; init; }
/// <summary>
/// PDF/A version (e.g., "PDF/A-1b", "PDF/A-2a", "PDF/A-3u") or null if not PDF/A compliant
/// </summary>
public string? PdfAVersion { get; init; }
/// <summary>
/// Whether the PDF conforms to PDF/A standard
/// </summary>
public bool PdfACompliant { get; init; }
/// <summary>
/// Validation errors (e.g., "PDF/A documents cannot be encrypted")
/// </summary>
public IReadOnlyList<string> Errors { get; init; } = [];
/// <summary>
/// Validation warnings (e.g., "Manual verification recommended: All fonts must be embedded")
/// </summary>
public IReadOnlyList<string> Warnings { get; init; } = [];
}

View File

@@ -0,0 +1,23 @@
namespace DocumentService.Application.Common.DTOs;
public sealed class PdfMetadata(
int pageCount,
long fileSizeBytes,
string pdfVersion,
bool hasAttachments,
int attachmentCount)
{
public int PageCount { get; } = pageCount;
public long FileSizeBytes { get; } = fileSizeBytes;
public string PdfVersion { get; } = pdfVersion;
public bool HasAttachments { get; } = hasAttachments;
public int AttachmentCount { get; } = attachmentCount;
// Computed Property (berechnet aus FileSizeBytes)
public double FileSizeMB => FileSizeBytes / 1024.0 / 1024.0;
public override string ToString()
{
return $"PDF: {PageCount} pages, {FileSizeMB:F2} MB, Version {PdfVersion}, Attachments: {AttachmentCount}";
}
}

View File

@@ -0,0 +1,18 @@
namespace DocumentService.Application.Common.DTOs;
/// <summary>
/// Response mit PDF-Metadaten
/// </summary>
/// <param name="PageCount">Anzahl der Seiten</param>
/// <param name="FileSizeBytes">Dateigröße in Bytes</param>
/// <param name="FileSizeMB">Dateigröße in MB (gerundet auf 2 Dezimalstellen)</param>
/// <param name="PdfVersion">PDF-Version (z.B. "1.4")</param>
/// <param name="HasAttachments">Hat das PDF Anhänge?</param>
/// <param name="AttachmentCount">Anzahl der Anhänge</param>
public record PdfValidationResult(
int PageCount,
long FileSizeBytes,
double FileSizeMB,
string PdfVersion,
bool HasAttachments,
int AttachmentCount);

View File

@@ -0,0 +1,93 @@
namespace DocumentService.Application.Common.DTOs;
/// <summary>
/// Swiss QR Bill data transfer object (mapped from Codecrete Bill)
/// </summary>
public record SwissQrBillDto
{
/// <summary>QR Bill standard version (e.g., "V2_0")</summary>
public required string Version { get; init; }
/// <summary>Payment amount (null if not specified)</summary>
public decimal? Amount { get; init; }
/// <summary>Payment currency (CHF or EUR)</summary>
public required string Currency { get; init; }
/// <summary>Creditor's IBAN account number</summary>
public required string Account { get; init; }
/// <summary>Creditor address</summary>
public required AddressDto Creditor { get; init; }
/// <summary>Payment reference type: "QRR", "SCOR", or "NON"</summary>
public required string ReferenceType { get; init; }
/// <summary>Payment reference (format depends on ReferenceType)</summary>
public string? Reference { get; init; }
/// <summary>Debtor address (optional)</summary>
public AddressDto? Debtor { get; init; }
/// <summary>Additional unstructured message (max 140 chars)</summary>
public string? UnstructuredMessage { get; init; }
/// <summary>Additional structured bill information</summary>
public string? BillInformation { get; init; }
/// <summary>Alternative payment schemes (max 2)</summary>
public IReadOnlyList<AlternativeSchemeDto>? AlternativeSchemes { get; init; }
}
/// <summary>
/// Address data transfer object (mapped from Codecrete Address)
/// </summary>
public record AddressDto
{
/// <summary>Address type: "Structured" or "CombinedElements"</summary>
public required string Type { get; init; }
/// <summary>Name of person or company</summary>
public required string Name { get; init; }
/// <summary>Street name (structured address only)</summary>
public string? Street { get; init; }
/// <summary>House number (structured address only)</summary>
public string? HouseNo { get; init; }
/// <summary>
/// Address line 1 (combined address only).
/// OBSOLETE: Use structured address instead. Will be removed when Codecrete v4 is adopted.
/// </summary>
[Obsolete("Use structured address (Street + HouseNo) instead. This field will be removed when upgrading to Codecrete.SwissQRBill.Generator v4.x")]
public string? AddressLine1 { get; init; }
/// <summary>
/// Address line 2 (combined address only).
/// OBSOLETE: Use structured address instead. Will be removed when Codecrete v4 is adopted.
/// </summary>
[Obsolete("Use structured address (Street + HouseNo) instead. This field will be removed when upgrading to Codecrete.SwissQRBill.Generator v4.x")]
public string? AddressLine2 { get; init; }
/// <summary>Postal code</summary>
public required string PostalCode { get; init; }
/// <summary>Town/city name</summary>
public required string Town { get; init; }
/// <summary>Two-letter country code (ISO 3166-1 alpha-2)</summary>
public required string CountryCode { get; init; }
}
/// <summary>
/// Alternative payment scheme (mapped from Codecrete AlternativeScheme)
/// </summary>
public record AlternativeSchemeDto
{
/// <summary>Scheme name (e.g., "AV1", "AV2")</summary>
public required string Name { get; init; }
/// <summary>Scheme instruction/parameter</summary>
public required string Instruction { get; init; }
}

View File

@@ -0,0 +1,37 @@
namespace DocumentService.Application.Common.DTOs;
/// <summary>
/// Response containing extracted Swiss QR Code in dual format.
/// </summary>
/// <param name="Bill">Parsed Swiss QR Bill (structured format)</param>
/// <param name="RawLines">Raw Swiss QR Code lines (original newline-separated format)</param>
/// <example>
/// {
/// "bill": {
/// "version": "V2_0",
/// "amount": 630.20,
/// "currency": "CHF",
/// "account": "CH953000520280564701R",
/// "creditor": {
/// "type": "Structured",
/// "name": "ALMAT AG",
/// "town": "Tagelswangen"
/// },
/// "referenceType": "QRR",
/// "reference": "000000000000000000252080824"
/// },
/// "rawLines": [
/// "SPC",
/// "0200",
/// "1",
/// "CH953000520280564701R",
/// "S",
/// "ALMAT AG",
/// "..."
/// ]
/// }
/// </example>
public record SwissQrCodeExtractionResult(
SwissQrBillDto Bill,
IReadOnlyList<string> RawLines
);

View File

@@ -1,7 +0,0 @@
namespace DocumentOperator.Application.Common.DTOs;
/// <summary>
/// Request für PDF-Validierung
/// </summary>
/// <param name="Base64Pdf">Base64-encodiertes PDF-Dokument</param>
public record ValidatePdfRequest(string Base64Pdf);

View File

@@ -1,18 +0,0 @@
namespace DocumentOperator.Application.Common.DTOs;
/// <summary>
/// Response mit PDF-Metadaten
/// </summary>
/// <param name="PageCount">Anzahl der Seiten</param>
/// <param name="FileSizeBytes">Dateigröße in Bytes</param>
/// <param name="FileSizeMB">Dateigröße in MB (gerundet auf 2 Dezimalstellen)</param>
/// <param name="PdfVersion">PDF-Version (z.B. "1.4")</param>
/// <param name="HasAttachments">Hat das PDF Anhänge?</param>
/// <param name="AttachmentCount">Anzahl der Anhänge</param>
public record ValidatePdfResponse(
int PageCount,
long FileSizeBytes,
double FileSizeMB,
string PdfVersion,
bool HasAttachments,
int AttachmentCount);

View File

@@ -0,0 +1,27 @@
namespace DocumentService.Application.Common.DTOs;
/// <summary>
/// DTO for ZUGFeRD check result
/// </summary>
public record ZugferdCheckResult
{
/// <summary>
/// Indicates whether the PDF contains ZUGFeRD XML attachment
/// </summary>
public bool HasZugferd { get; init; }
/// <summary>
/// ZUGFeRD XML file name (e.g., "factur-x.xml")
/// </summary>
public string? ZugferdFileName { get; init; }
/// <summary>
/// ZUGFeRD XML file size in bytes
/// </summary>
public long? ZugferdFileSize { get; init; }
/// <summary>
/// MIME type of the ZUGFeRD XML file
/// </summary>
public string? ZugferdMimeType { get; init; }
}

View File

@@ -1,16 +1,191 @@
using DocumentOperator.Domain.Models.ValueObjects;
using DocumentService.Application.Common.DTOs;
namespace DocumentOperator.Application.Common.Interfaces;
namespace DocumentService.Application.Common.Interfaces;
public interface IPdfProcessor
{
/// <summary>
/// Validates a PDF and extracts metadata.
/// </summary>
/// <param name="pdfBytes">PDF content as byte array</param>
/// <param name="pdfStream">
/// PDF document stream. Must be readable and positioned at the beginning (Position = 0).
/// Non-seekable streams are supported. Caller is responsible for disposal.
/// </param>
/// <returns>PDF metadata (page count, size, version, attachments)</returns>
/// <exception cref="Domain.Common.Exceptions.PdfProcessingException">
/// Thrown when PDF is corrupted or cannot be processed
/// <exception cref="Domain.Common.Exceptions.BadRequestException">
/// Thrown when stream is empty, invalid, or not positioned at the beginning
/// </exception>
Task<PdfMetadata> ValidateAsync(byte[] pdfBytes);
Task<PdfMetadata> ValidateAsync(Stream pdfStream);
/// <summary>
/// Validates a PDF/A document and checks conformance level.
/// </summary>
/// <param name="pdfStream">
/// PDF document stream. Must be readable and positioned at the beginning (Position = 0).
/// Non-seekable streams are supported. Caller is responsible for disposal.
/// </param>
/// <returns>PDF/A metadata including conformance level and validation errors/warnings</returns>
/// <exception cref="Domain.Common.Exceptions.BadRequestException">
/// Thrown when stream is empty, invalid, or not positioned at the beginning
/// </exception>
Task<PdfAMetadata> ValidatePdfAAsync(Stream pdfStream);
/// <summary>
/// Checks for embedded files (attachments) in a PDF document and returns detailed metadata.
/// </summary>
/// <param name="pdfStream">
/// PDF document stream. Must be readable and positioned at the beginning (Position = 0).
/// Non-seekable streams are supported. Caller is responsible for disposal.
/// </param>
/// <returns>Attachment information (count, file names, MIME types, sizes)</returns>
/// <exception cref="Domain.Common.Exceptions.BadRequestException">
/// Thrown when stream is empty, invalid, or not positioned at the beginning
/// </exception>
Task<AttachmentInfo> CheckAttachmentsAsync(Stream pdfStream);
/// <summary>
/// Extracts all embedded files from a PDF document and returns them as a ZIP archive.
/// </summary>
/// <param name="pdfStream">
/// PDF document stream. Must be readable and positioned at the beginning (Position = 0).
/// Non-seekable streams are supported. Caller is responsible for disposal.
/// </param>
/// <returns>ZIP archive containing all extracted attachments as byte array</returns>
/// <exception cref="Domain.Common.Exceptions.BadRequestException">
/// Thrown when stream is empty, invalid, or not positioned at the beginning
/// </exception>
/// <exception cref="Domain.Common.Exceptions.NotFoundException">
/// Thrown when PDF contains no attachments
/// </exception>
Task<byte[]> ExtractAttachmentsAsync(Stream pdfStream);
/// <summary>
/// Merges multiple PDF documents into a single PDF.
/// </summary>
/// <param name="pdfStreams">
/// PDF streams to merge (minimum 2 required). Each stream must be readable and positioned
/// at the beginning (Position = 0). Caller is responsible for disposal.
/// </param>
/// <param name="pageRanges">
/// Optional page ranges per PDF (null = all pages). Format: "1-3,5" means pages 1, 2, 3, and 5.
/// If null or empty for a PDF, all pages are included. Array length must match pdfStreams length if provided.
/// </param>
/// <returns>Merged PDF as byte array</returns>
/// <exception cref="Domain.Common.Exceptions.BadRequestException">
/// Thrown when fewer than 2 PDFs provided, any stream is empty/invalid/not at Position=0,
/// or page range format is invalid
/// </exception>
Task<byte[]> MergePdfsAsync(IReadOnlyList<Stream> pdfStreams, IReadOnlyList<string?>? pageRanges = null);
/// <summary>
/// Adds an annotation to a PDF document at the specified page and rectangle.
/// </summary>
/// <param name="pdfStream">
/// PDF document stream. Must be readable and positioned at the beginning (Position = 0).
/// Non-seekable streams are supported. Caller is responsible for disposal.
/// </param>
/// <param name="annotationType">Type of annotation to add (TextMarkup, FreeText, StickyNote, Circle, Square)</param>
/// <param name="pageNumber">Page number (1-based) where annotation should be added</param>
/// <param name="rectangle">Annotation bounding rectangle (X1, Y1, X2, Y2)</param>
/// <param name="content">Annotation content/comment text (required for FreeText and StickyNote)</param>
/// <param name="author">Optional author name</param>
/// <param name="color">Optional annotation color in RGB format (hex string like "FF0000" for red)</param>
/// <param name="textMarkupStyle">Text markup style (Highlight, Underline, Strikeout) - only for TextMarkup type</param>
/// <param name="origin">Coordinate origin (BottomLeft = PDF native, TopLeft = UI-friendly). Default: BottomLeft</param>
/// <returns>Annotated PDF as byte array</returns>
/// <exception cref="Domain.Common.Exceptions.BadRequestException">
/// Thrown when stream is empty/invalid/not at Position=0, page number out of range,
/// rectangle invalid, or content missing for types that require it
/// </exception>
Task<byte[]> AddAnnotationAsync(
Stream pdfStream,
Domain.Models.ValueObjects.AnnotationType annotationType,
int pageNumber,
(double X1, double Y1, double X2, double Y2) rectangle,
string? content = null,
string? author = null,
string? color = null,
Domain.Models.ValueObjects.TextMarkupStyle? textMarkupStyle = null,
Domain.Models.ValueObjects.AnnotationOrigin origin = Domain.Models.ValueObjects.AnnotationOrigin.BottomLeft);
/// <summary>
/// Adds a stamp (text, image, or predefined) to specified pages of a PDF document.
/// </summary>
/// <param name="pdfStream">Input PDF stream (must support reading and seeking)</param>
/// <param name="stampType">Type of stamp (Text, Image, or Predefined)</param>
/// <param name="pageNumbers">Target page numbers (1-based). Null = all pages.</param>
/// <param name="position">Stamp position (X, Y coordinates)</param>
/// <param name="size">Stamp size (Width, Height). Null = auto-size for images.</param>
/// <param name="origin">Coordinate origin (BottomLeft or TopLeft)</param>
/// <param name="text">Text content (required for Text stamps)</param>
/// <param name="fontName">Font name (default: Arial)</param>
/// <param name="fontSize">Font size in points (default: 12)</param>
/// <param name="color">Hex color without # (e.g., "FF0000" for red, default: "000000")</param>
/// <param name="opacity">Opacity 0.0 (transparent) to 1.0 (opaque, default: 0.5)</param>
/// <param name="rotation">Rotation angle in degrees 0-360 (default: 0)</param>
/// <param name="placement">Foreground (on top) or Background (behind content)</param>
/// <param name="imageBytes">Image data (required for Image stamps, PNG/JPEG)</param>
/// <param name="predefinedType">Predefined stamp type (required for Predefined stamps)</param>
/// <returns>Stamped PDF as byte array</returns>
/// <exception cref="BadRequestException">Invalid parameters (missing text/image, invalid page numbers, invalid opacity/rotation)</exception>
/// <exception cref="PdfProcessingException">DevExpress processing error</exception>
Task<byte[]> AddStampAsync(
Stream pdfStream,
Domain.Models.ValueObjects.StampType stampType,
int[]? pageNumbers,
(double X, double Y) position,
(double Width, double Height)? size = null,
Domain.Models.ValueObjects.AnnotationOrigin origin = Domain.Models.ValueObjects.AnnotationOrigin.BottomLeft,
string? text = null,
string? fontName = null,
double? fontSize = null,
string? color = null,
double? opacity = null,
double? rotation = null,
Domain.Models.ValueObjects.StampPlacement placement = Domain.Models.ValueObjects.StampPlacement.Foreground,
byte[]? imageBytes = null,
Domain.Models.ValueObjects.PredefinedStampType? predefinedType = null);
/// <summary>
/// Embeds one or more files as attachments in a PDF document (supports PDF/A-3).
/// </summary>
/// <param name="pdfStream">
/// PDF document stream. Must be readable and positioned at the beginning (Position = 0).
/// Non-seekable streams are supported. Caller is responsible for disposal.
/// </param>
/// <param name="attachments">List of files to embed (filename, content, optional MIME type)</param>
/// <returns>PDF with embedded attachments as byte array</returns>
/// <exception cref="Domain.Common.Exceptions.BadRequestException">
/// Thrown when stream is empty/invalid, or attachments list is empty
/// </exception>
Task<byte[]> AddAttachmentsAsync(
Stream pdfStream,
IReadOnlyList<(string FileName, byte[] Content, string? MimeType)> attachments);
/// <summary>
/// Converts a standard PDF to PDF/A format.
/// </summary>
/// <param name="pdfStream">
/// PDF document stream. Must be readable and positioned at the beginning (Position = 0).
/// Non-seekable streams are supported. Caller is responsible for disposal.
/// </param>
/// <param name="pdfALevel">Target PDF/A level (e.g., "PDF/A-1b", "PDF/A-2b", "PDF/A-3b")</param>
/// <returns>PDF/A compliant document as byte array</returns>
/// <exception cref="Domain.Common.Exceptions.BadRequestException">
/// Thrown when stream is empty/invalid or PDF/A level is unsupported
/// </exception>
Task<byte[]> ConvertToPdfAAsync(Stream pdfStream, string pdfALevel);
/// <summary>
/// Converts a PDF/A document to a standard PDF (removes PDF/A restrictions).
/// </summary>
/// <param name="pdfStream">
/// PDF/A document stream. Must be readable and positioned at the beginning (Position = 0).
/// Non-seekable streams are supported. Caller is responsible for disposal.
/// </param>
/// <returns>Standard PDF document as byte array</returns>
/// <exception cref="Domain.Common.Exceptions.BadRequestException">
/// Thrown when stream is empty/invalid
/// </exception>
Task<byte[]> ConvertFromPdfAAsync(Stream pdfStream);
}

View File

@@ -1,6 +1,6 @@
using DocumentOperator.Domain.ValueObjects;
using Codecrete.SwissQRBill.Generator;
namespace DocumentOperator.Application.Common.Interfaces;
namespace DocumentService.Application.Common.Interfaces;
/// <summary>
/// Interface for Swiss QR Code processing operations.
@@ -9,16 +9,24 @@ namespace DocumentOperator.Application.Common.Interfaces;
public interface ISwissQrCodeProcessor
{
/// <summary>
/// Extracts and parses Swiss QR Code from the last page of a PDF document.
/// Extracts and parses Swiss QR Code from a PDF document.
/// Returns both parsed Bill object and raw QR text lines.
/// </summary>
/// <param name="pdfBytes">PDF document as byte array</param>
/// <param name="pdfStream">
/// PDF document stream. Must be readable and positioned at the beginning (Position = 0).
/// Non-seekable streams are supported. Caller is responsible for disposal.
/// </param>
/// <param name="pageNumbers">Optional: Specific page numbers to scan (1-indexed). If null, scans all pages starting with last page.</param>
/// <param name="cancellationToken">Cancellation token</param>
/// <returns>Parsed Swiss QR Code data</returns>
/// <exception cref="Domain.Exceptions.SwissQrCodeNotFoundException">
/// Thrown when no Swiss QR Code is found on the last page
/// <returns>Tuple: (Parsed Codecrete Bill, Raw QR lines as string array)</returns>
/// <exception cref="Domain.Common.Exceptions.NotFoundException">
/// Thrown when no Swiss QR Code is found in the specified pages
/// </exception>
/// <exception cref="Domain.Exceptions.PdfProcessingException">
/// Thrown when PDF processing fails
/// <exception cref="ArgumentException">
/// Thrown when stream is empty or (for seekable streams) not positioned at the beginning
/// </exception>
Task<SwissQrCodeData> ExtractSwissQrCodeAsync(byte[] pdfBytes, CancellationToken cancellationToken = default);
Task<(Bill Bill, string[] RawLines)> ExtractSwissQrCodeAsync(
Stream pdfStream,
int[]? pageNumbers = null,
CancellationToken cancellationToken = default);
}

View File

@@ -0,0 +1,54 @@
using AutoMapper;
using Codecrete.SwissQRBill.Generator;
using DocumentService.Application.Common.DTOs;
using DocumentService.Domain.Models.ValueObjects;
namespace DocumentService.Application.Common.Mapping;
/// <summary>
/// AutoMapper profile for mapping domain entities and external models to DTOs.
/// NOTE: Always use AutoMapper for all mappings in this project.
/// </summary>
public class MappingProfile : Profile
{
public MappingProfile()
{
// PdfMetadata -> PdfValidationResult
CreateMap<PdfMetadata, PdfValidationResult>();
// PdfAMetadata -> PdfAValidationResult
CreateMap<PdfAMetadata, PdfAValidationResult>()
.ForMember(dest => dest.FileSize, opt => opt.MapFrom(src => src.FileSizeBytes));
// Codecrete Bill -> SwissQrBillDto
CreateMap<Bill, SwissQrBillDto>()
.ForMember(dest => dest.Version, opt => opt.MapFrom(src => src.Version.ToString()))
.ForMember(dest => dest.Currency, opt => opt.MapFrom(src => src.Currency ?? "CHF"))
.ForMember(dest => dest.Account, opt => opt.MapFrom(src => src.Account ?? string.Empty))
.ForMember(dest => dest.ReferenceType, opt => opt.MapFrom(src => src.ReferenceType ?? Bill.ReferenceTypeNoRef));
// Codecrete Address -> AddressDto
CreateMap<Address, AddressDto>()
.ForMember(dest => dest.Type, opt => opt.MapFrom(src => src.Type.ToString()))
.ForMember(dest => dest.Name, opt => opt.MapFrom(src => src.Name ?? string.Empty))
.ForMember(dest => dest.PostalCode, opt => opt.MapFrom(src => src.PostalCode ?? string.Empty))
.ForMember(dest => dest.Town, opt => opt.MapFrom(src => src.Town ?? string.Empty))
.ForMember(dest => dest.CountryCode, opt => opt.MapFrom(src => src.CountryCode ?? string.Empty))
#pragma warning disable CS0618 // Suppress obsolete warning for AddressLine1/2 mapping
.ForMember(dest => dest.AddressLine1, opt => opt.MapFrom(src => src.AddressLine1))
.ForMember(dest => dest.AddressLine2, opt => opt.MapFrom(src => src.AddressLine2));
#pragma warning restore CS0618
// Codecrete AlternativeScheme -> AlternativeSchemeDto
CreateMap<AlternativeScheme, AlternativeSchemeDto>()
.ForMember(dest => dest.Name, opt => opt.MapFrom(src => src.Name ?? string.Empty))
.ForMember(dest => dest.Instruction, opt => opt.MapFrom(src => src.Instruction ?? string.Empty));
// AttachmentInfo -> AttachmentCheckResult
CreateMap<AttachmentInfo, AttachmentCheckResult>();
// AttachmentMetadata -> AttachmentDto
CreateMap<AttachmentMetadata, AttachmentDto>()
.ForMember(dest => dest.Size, opt => opt.MapFrom(src => src.SizeBytes));
}
}

View File

@@ -0,0 +1,41 @@
using DocumentService.Application.Common.Interfaces;
using FluentValidation;
using MediatR;
namespace DocumentService.Application.ConvertFromPdfA;
/// <summary>
/// Command to convert a PDF/A document to a standard PDF (removes PDF/A restrictions)
/// </summary>
public record ConvertFromPdfACommand : IRequest<byte[]>
{
/// <summary>
/// PDF/A document stream. Must be positioned at the beginning (Position = 0).
/// </summary>
public required Stream PdfStream { get; init; }
}
/// <summary>
/// Handler for ConvertFromPdfACommand
/// </summary>
public class ConvertFromPdfACommandHandler(IPdfProcessor pdfProcessor)
: IRequestHandler<ConvertFromPdfACommand, byte[]>
{
public async Task<byte[]> Handle(ConvertFromPdfACommand request, CancellationToken cancellationToken)
{
return await pdfProcessor.ConvertFromPdfAAsync(request.PdfStream);
}
}
/// <summary>
/// Validator for ConvertFromPdfACommand
/// </summary>
public class ConvertFromPdfACommandValidator : AbstractValidator<ConvertFromPdfACommand>
{
public ConvertFromPdfACommandValidator()
{
RuleFor(x => x.PdfStream)
.NotNull()
.WithMessage("PDF stream is required");
}
}

View File

@@ -0,0 +1,59 @@
using DocumentService.Application.Common.Interfaces;
using FluentValidation;
using MediatR;
namespace DocumentService.Application.ConvertToPdfA;
/// <summary>
/// Command to convert a standard PDF to PDF/A format
/// </summary>
public record ConvertToPdfACommand : IRequest<byte[]>
{
/// <summary>
/// PDF document stream. Must be positioned at the beginning (Position = 0).
/// </summary>
public required Stream PdfStream { get; init; }
/// <summary>
/// Target PDF/A level (e.g., "PDF/A-1b", "PDF/A-2b", "PDF/A-3b")
/// </summary>
public required string PdfALevel { get; init; }
}
/// <summary>
/// Handler for ConvertToPdfACommand
/// </summary>
public class ConvertToPdfACommandHandler(IPdfProcessor pdfProcessor)
: IRequestHandler<ConvertToPdfACommand, byte[]>
{
public async Task<byte[]> Handle(ConvertToPdfACommand request, CancellationToken cancellationToken)
{
return await pdfProcessor.ConvertToPdfAAsync(request.PdfStream, request.PdfALevel);
}
}
/// <summary>
/// Validator for ConvertToPdfACommand
/// </summary>
public class ConvertToPdfACommandValidator : AbstractValidator<ConvertToPdfACommand>
{
private static readonly string[] ValidPdfALevels =
{
"PDF/A-1b", "PDF/A-1a",
"PDF/A-2b", "PDF/A-2u", "PDF/A-2a",
"PDF/A-3b", "PDF/A-3u", "PDF/A-3a"
};
public ConvertToPdfACommandValidator()
{
RuleFor(x => x.PdfStream)
.NotNull()
.WithMessage("PDF stream is required");
RuleFor(x => x.PdfALevel)
.NotEmpty()
.WithMessage("PDF/A level is required")
.Must(level => ValidPdfALevels.Contains(level, StringComparer.OrdinalIgnoreCase))
.WithMessage($"Invalid PDF/A level. Valid values: {string.Join(", ", ValidPdfALevels)}");
}
}

View File

@@ -1,7 +1,8 @@
using FluentValidation;
using Microsoft.Extensions.Configuration;
using Microsoft.Extensions.DependencyInjection;
namespace DocumentOperator.Application;
namespace DocumentService.Application;
/// <summary>
/// Dependency Injection configuration for Application Layer
@@ -9,15 +10,20 @@ namespace DocumentOperator.Application;
public static class DependencyInjection
{
/// <summary>
/// Registers Application Layer services (MediatR, FluentValidation, Behaviors)
/// Registers Application Layer services (MediatR, FluentValidation, AutoMapper, Behaviors)
/// </summary>
public static IServiceCollection AddApplication(this IServiceCollection services)
public static IServiceCollection AddApplication(this IServiceCollection services, IConfiguration configuration)
{
var assembly = typeof(DependencyInjection).Assembly;
// Read LuckyPennySoft license key from appsettings.json
var licenseKey = configuration.GetValue<string>("LuckyPennySoftLicenseKey")
?? throw new InvalidOperationException("LuckyPennySoftLicenseKey not found in configuration");
// Register MediatR (scannt Assembly nach Handlers)
services.AddMediatR(config =>
{
config.LicenseKey = licenseKey;
config.RegisterServicesFromAssembly(assembly);
// Pipeline Behaviors (Reihenfolge wichtig!)
@@ -28,6 +34,11 @@ public static class DependencyInjection
// Register FluentValidation (scannt Assembly nach Validators)
services.AddValidatorsFromAssembly(assembly);
// Register AutoMapper (scannt Assembly nach Profiles)
services.AddAutoMapper(cfg => {
cfg.LicenseKey = licenseKey;
}, typeof(Common.Mapping.MappingProfile));
return services;
}
}

View File

@@ -1,28 +0,0 @@
<Project Sdk="Microsoft.NET.Sdk">
<PropertyGroup>
<TargetFramework>net8.0</TargetFramework>
<ImplicitUsings>enable</ImplicitUsings>
<Nullable>enable</Nullable>
</PropertyGroup>
<ItemGroup>
<PackageReference Include="FluentValidation" Version="12.1.1" />
<PackageReference Include="FluentValidation.DependencyInjectionExtensions" Version="12.1.1" />
<PackageReference Include="MediatR" Version="14.1.0" />
</ItemGroup>
<ItemGroup>
<ProjectReference Include="..\DocumentOperator.Domain\DocumentOperator.Domain.csproj" />
</ItemGroup>
<ItemGroup>
<Folder Include="Common\Mappings\" />
<Folder Include="DependencyInjection\" />
<Folder Include="Features\Documents\ExtractAttachments\" />
<Folder Include="Features\Documents\ConcatenatePdfs\" />
<Folder Include="Features\Documents\ApplyStamp\" />
<Folder Include="Features\Documents\EmbedCertificate\" />
</ItemGroup>
</Project>

View File

@@ -0,0 +1,36 @@
<Project Sdk="Microsoft.NET.Sdk">
<PropertyGroup>
<TargetFramework>net8.0</TargetFramework>
<ImplicitUsings>enable</ImplicitUsings>
<Nullable>enable</Nullable>
</PropertyGroup>
<ItemGroup>
<Compile Remove="DependencyInjection\**" />
<Compile Remove="Features\**" />
<EmbeddedResource Remove="DependencyInjection\**" />
<EmbeddedResource Remove="Features\**" />
<None Remove="DependencyInjection\**" />
<None Remove="Features\**" />
</ItemGroup>
<ItemGroup>
<PackageReference Include="AutoMapper" Version="16.2.0" />
<PackageReference Include="Codecrete.SwissQRBill.Generator" Version="3.4.0" />
<PackageReference Include="FluentValidation" Version="12.1.1" />
<PackageReference Include="FluentValidation.DependencyInjectionExtensions" Version="12.1.1" />
<PackageReference Include="MediatR" Version="14.1.0" />
<PackageReference Include="Microsoft.Extensions.Configuration.Abstractions" Version="10.0.10" />
<PackageReference Include="Microsoft.Extensions.Configuration.Binder" Version="10.0.10" />
</ItemGroup>
<ItemGroup>
<ProjectReference Include="..\DocumentOperator.Domain\DocumentService.Domain.csproj" />
</ItemGroup>
<ItemGroup>
<Folder Include="Common\Mappings\" />
</ItemGroup>
</Project>

View File

@@ -0,0 +1,43 @@
using DocumentService.Application.Common.Interfaces;
using FluentValidation;
using MediatR;
namespace DocumentService.Application.ExtractPdfAttachments;
/// <summary>
/// Command to extract all embedded files from a PDF document and return as ZIP archive.
/// </summary>
public record ExtractPdfAttachmentsCommand : IRequest<byte[]>
{
/// <summary>
/// PDF document stream. Must be positioned at the beginning (Position = 0).
/// </summary>
public required Stream PdfStream { get; init; }
}
/// <summary>
/// Handler for ExtractPdfAttachmentsCommand.
/// Extracts all embedded files from PDF and returns as ZIP archive.
/// </summary>
public class ExtractPdfAttachmentsCommandHandler(IPdfProcessor pdfProcessor)
: IRequestHandler<ExtractPdfAttachmentsCommand, byte[]>
{
public async Task<byte[]> Handle(ExtractPdfAttachmentsCommand request, CancellationToken cancellationToken)
{
// Delegate to infrastructure layer
return await pdfProcessor.ExtractAttachmentsAsync(request.PdfStream);
}
}
/// <summary>
/// Validator for ExtractPdfAttachmentsCommand.
/// </summary>
public class ExtractPdfAttachmentsCommandValidator : AbstractValidator<ExtractPdfAttachmentsCommand>
{
public ExtractPdfAttachmentsCommandValidator()
{
RuleFor(x => x.PdfStream)
.NotNull()
.WithMessage("PDF stream is required");
}
}

View File

@@ -0,0 +1,113 @@
using DocumentService.Application.Common.Configuration;
using DocumentService.Application.Common.Interfaces;
using DocumentService.Domain.Common.Exceptions;
using FluentValidation;
using MediatR;
using Microsoft.Extensions.Options;
namespace DocumentService.Application.ExtractZugferd;
/// <summary>
/// Command to extract ZUGFeRD XML from a PDF document
/// </summary>
public record ExtractZugferdCommand : IRequest<ZugferdExtractionResult>
{
/// <summary>
/// PDF document stream. Must be positioned at the beginning (Position = 0).
/// </summary>
public required Stream PdfStream { get; init; }
}
/// <summary>
/// Handler for ExtractZugferdCommand.
/// Extracts ZUGFeRD XML from PDF and returns XML content
/// </summary>
public class ExtractZugferdCommandHandler(
IPdfProcessor pdfProcessor,
IOptions<ZugferdSettings> settings)
: IRequestHandler<ExtractZugferdCommand, ZugferdExtractionResult>
{
private readonly ZugferdSettings _settings = settings.Value;
public async Task<ZugferdExtractionResult> Handle(ExtractZugferdCommand request, CancellationToken cancellationToken)
{
// Get all attachments
var attachmentInfo = await pdfProcessor.CheckAttachmentsAsync(request.PdfStream);
// Find ZUGFeRD XML file using configured names and patterns
var zugferdAttachment = attachmentInfo.Attachments.FirstOrDefault(a =>
_settings.ZugferdFileNames.Any(name =>
a.FileName.Equals(name, StringComparison.OrdinalIgnoreCase)) ||
_settings.ZugferdFileNamePatterns.Any(pattern =>
a.FileName.Contains(pattern, StringComparison.OrdinalIgnoreCase)));
if (zugferdAttachment == null)
{
throw new NotFoundException("ZUGFeRD XML not found in PDF attachments");
}
// Reset stream position for extraction
request.PdfStream.Position = 0;
// Extract all attachments as ZIP
byte[] zipBytes = await pdfProcessor.ExtractAttachmentsAsync(request.PdfStream);
// Find ZUGFeRD XML in ZIP
using var zipStream = new MemoryStream(zipBytes);
using var zipArchive = new System.IO.Compression.ZipArchive(zipStream, System.IO.Compression.ZipArchiveMode.Read);
var zugferdEntry = zipArchive.Entries.FirstOrDefault(e =>
e.Name.Equals(zugferdAttachment.FileName, StringComparison.OrdinalIgnoreCase));
if (zugferdEntry == null)
{
throw new NotFoundException($"ZUGFeRD XML '{zugferdAttachment.FileName}' not found in extracted attachments");
}
// Read XML content
using var entryStream = zugferdEntry.Open();
using var reader = new StreamReader(entryStream);
string xmlContent = await reader.ReadToEndAsync(cancellationToken);
return new ZugferdExtractionResult
{
FileName = zugferdAttachment.FileName,
XmlContent = xmlContent,
FileSize = zugferdAttachment.SizeBytes
};
}
}
/// <summary>
/// Validator for ExtractZugferdCommand.
/// </summary>
public class ExtractZugferdCommandValidator : AbstractValidator<ExtractZugferdCommand>
{
public ExtractZugferdCommandValidator()
{
RuleFor(x => x.PdfStream)
.NotNull()
.WithMessage("PDF stream is required");
}
}
/// <summary>
/// Result DTO for ZUGFeRD extraction
/// </summary>
public record ZugferdExtractionResult
{
/// <summary>
/// ZUGFeRD XML file name
/// </summary>
public required string FileName { get; init; }
/// <summary>
/// ZUGFeRD XML content as string
/// </summary>
public required string XmlContent { get; init; }
/// <summary>
/// File size in bytes
/// </summary>
public long FileSize { get; init; }
}

View File

@@ -1,33 +0,0 @@
using DocumentOperator.Application.Common.Interfaces;
using MediatR;
namespace DocumentOperator.Application.Features.Documents.ExtractSwissQrCode;
/// <summary>
/// Handles extraction of Swiss QR Code from PDF documents.
/// Uses ISwissQrCodeProcessor to extract QR code from the last page and parse it.
/// </summary>
public sealed class ExtractSwissQrCodeHandler : IRequestHandler<ExtractSwissQrCodeQuery, ExtractSwissQrCodeResult>
{
private readonly ISwissQrCodeProcessor _qrCodeProcessor;
public ExtractSwissQrCodeHandler(ISwissQrCodeProcessor qrCodeProcessor)
{
_qrCodeProcessor = qrCodeProcessor;
}
public async Task<ExtractSwissQrCodeResult> Handle(ExtractSwissQrCodeQuery request, CancellationToken cancellationToken)
{
// Convert Base64 string to byte array
byte[] pdfBytes = request.PdfContent.ToByteArray();
// Extract and parse Swiss QR Code from last page
var qrCodeData = await _qrCodeProcessor.ExtractSwissQrCodeAsync(pdfBytes, cancellationToken);
// Return references (passed through) + QR code data
return new ExtractSwissQrCodeResult(
References: request.References,
QrCodeData: qrCodeData
);
}
}

View File

@@ -1,26 +0,0 @@
using DocumentOperator.Domain.Models.ValueObjects;
using DocumentOperator.Domain.ValueObjects;
using MediatR;
namespace DocumentOperator.Application.Features.Documents.ExtractSwissQrCode;
/// <summary>
/// Query to extract Swiss QR Code data from a PDF document.
/// Returns references (passed through) and parsed QR code data.
/// </summary>
/// <param name="References">Array of reference strings to pass through in the response</param>
/// <param name="PdfContent">PDF document content as Base64 string</param>
public record ExtractSwissQrCodeQuery(
IReadOnlyList<string> References,
Base64String PdfContent
) : IRequest<ExtractSwissQrCodeResult>;
/// <summary>
/// Result containing passed-through references and extracted Swiss QR Code data
/// </summary>
/// <param name="References">Reference strings passed through from request</param>
/// <param name="QrCodeData">Parsed Swiss QR Code data from the last page of the PDF</param>
public record ExtractSwissQrCodeResult(
IReadOnlyList<string> References,
SwissQrCodeData QrCodeData
);

View File

@@ -1,21 +0,0 @@
using FluentValidation;
namespace DocumentOperator.Application.Features.Documents.ExtractSwissQrCode;
/// <summary>
/// Validates ExtractSwissQrCodeQuery before handler execution.
/// Ensures references array and PDF content are provided.
/// </summary>
public sealed class ExtractSwissQrCodeValidator : AbstractValidator<ExtractSwissQrCodeQuery>
{
public ExtractSwissQrCodeValidator()
{
RuleFor(x => x.References)
.NotNull()
.WithMessage("References array is required.");
RuleFor(x => x.PdfContent)
.NotNull()
.WithMessage("PDF content is required.");
}
}

View File

@@ -1,33 +0,0 @@
using DocumentOperator.Application.Common.Interfaces;
using DocumentOperator.Domain.Models.ValueObjects;
using MediatR;
namespace DocumentOperator.Application.Features.Documents.ValidatePdf;
/// <summary>
/// Handler for ValidatePdfQuery
/// Orchestrates PDF validation using IPdfProcessor
/// </summary>
public class ValidatePdfHandler : IRequestHandler<ValidatePdfQuery, PdfMetadata>
{
private readonly IPdfProcessor _pdfProcessor;
public ValidatePdfHandler(IPdfProcessor pdfProcessor)
{
_pdfProcessor = pdfProcessor;
}
/// <summary>
/// Validates PDF and returns metadata
/// </summary>
public async Task<PdfMetadata> Handle(ValidatePdfQuery request, CancellationToken cancellationToken)
{
// Value Object ? Byte Array
byte[] pdfBytes = request.PdfContent.ToByteArray();
// DevExpress Service aufrufen (kann PdfProcessingException werfen)
var metadata = await _pdfProcessor.ValidateAsync(pdfBytes);
return metadata;
}
}

View File

@@ -1,10 +0,0 @@
using DocumentOperator.Domain.Models.ValueObjects;
using MediatR;
namespace DocumentOperator.Application.Features.Documents.ValidatePdf;
/// <summary>
/// Query to validate a PDF document and return metadata
/// </summary>
/// <param name="PdfContent">PDF content as Base64 string (validated by Value Object)</param>
public record ValidatePdfQuery(Base64String PdfContent) : IRequest<PdfMetadata>;

View File

@@ -1,17 +0,0 @@
using FluentValidation;
namespace DocumentOperator.Application.Features.Documents.ValidatePdf;
/// <summary>
/// Validator for ValidatePdfQuery
/// Validates that PdfContent is not null (Base64String already validates format in its constructor)
/// </summary>
public class ValidatePdfValidator : AbstractValidator<ValidatePdfQuery>
{
public ValidatePdfValidator()
{
RuleFor(x => x.PdfContent)
.NotNull()
.WithMessage("PDF content is required");
}
}

View File

@@ -0,0 +1,62 @@
using DocumentService.Application.Common.Configuration;
using DocumentService.Application.Common.DTOs;
using DocumentService.Application.Common.Interfaces;
using MediatR;
using Microsoft.Extensions.Options;
namespace DocumentService.Application.HasZugferd.Queries;
/// <summary>
/// Query for checking if PDF contains ZUGFeRD XML attachment
/// </summary>
public record HasZugferdQuery : IRequest<ZugferdCheckResult>
{
/// <summary>
/// PDF as stream (caller is responsible for disposal)
/// </summary>
public required Stream PdfStream { get; init; }
}
/// <summary>
/// Handler for HasZugferdQuery
/// Checks if PDF contains ZUGFeRD/Factur-X XML attachment
/// </summary>
public class HasZugferdQueryHandler(
IPdfProcessor pdfProcessor,
IOptions<ZugferdSettings> settings)
: IRequestHandler<HasZugferdQuery, ZugferdCheckResult>
{
private readonly ZugferdSettings _settings = settings.Value;
/// <summary>
/// Checks if PDF contains ZUGFeRD XML and returns metadata
/// </summary>
public async Task<ZugferdCheckResult> Handle(HasZugferdQuery request, CancellationToken cancellationToken)
{
// Get all attachments
var attachmentInfo = await pdfProcessor.CheckAttachmentsAsync(request.PdfStream);
// Check for ZUGFeRD/Factur-X XML files using configured names and patterns
var zugferdAttachment = attachmentInfo.Attachments.FirstOrDefault(a =>
_settings.ZugferdFileNames.Any(name =>
a.FileName.Equals(name, StringComparison.OrdinalIgnoreCase)) ||
_settings.ZugferdFileNamePatterns.Any(pattern =>
a.FileName.Contains(pattern, StringComparison.OrdinalIgnoreCase)));
if (zugferdAttachment != null)
{
return new ZugferdCheckResult
{
HasZugferd = true,
ZugferdFileName = zugferdAttachment.FileName,
ZugferdFileSize = zugferdAttachment.SizeBytes,
ZugferdMimeType = zugferdAttachment.MimeType
};
}
return new ZugferdCheckResult
{
HasZugferd = false
};
}
}

View File

@@ -0,0 +1,16 @@
using FluentValidation;
namespace DocumentService.Application.HasZugferd.Queries;
/// <summary>
/// Validator for HasZugferdQuery
/// </summary>
public class HasZugferdQueryValidator : AbstractValidator<HasZugferdQuery>
{
public HasZugferdQueryValidator()
{
RuleFor(x => x.PdfStream)
.NotNull()
.WithMessage("PDF stream is required");
}
}

View File

@@ -0,0 +1,53 @@
using DocumentService.Application.Common.Interfaces;
using FluentValidation;
using MediatR;
namespace DocumentService.Application.MergePdfs;
/// <summary>
/// Command to merge multiple PDF documents into a single PDF.
/// </summary>
public record MergePdfsCommand : IRequest<byte[]>
{
/// <summary>
/// PDF streams to merge. Minimum 2 required. Each must be at Position=0.
/// </summary>
public required IReadOnlyList<Stream> PdfStreams { get; init; }
/// <summary>
/// Optional page ranges per PDF (null = all pages).
/// Format: "1-3,5" means pages 1, 2, 3, and 5.
/// If provided, array length must match PdfStreams length.
/// </summary>
public IReadOnlyList<string?>? PageRanges { get; init; }
}
/// <summary>
/// Handler for MergePdfsCommand.
/// Delegates PDF merge operation to infrastructure layer.
/// </summary>
public class MergePdfsCommandHandler(IPdfProcessor pdfProcessor)
: IRequestHandler<MergePdfsCommand, byte[]>
{
public async Task<byte[]> Handle(MergePdfsCommand request, CancellationToken cancellationToken)
{
return await pdfProcessor.MergePdfsAsync(request.PdfStreams, request.PageRanges);
}
}
/// <summary>
/// Validator for MergePdfsCommand.
/// </summary>
public class MergePdfsCommandValidator : AbstractValidator<MergePdfsCommand>
{
public MergePdfsCommandValidator()
{
RuleFor(x => x.PdfStreams)
.NotNull()
.WithMessage("PDF streams are required");
RuleFor(x => x.PdfStreams)
.Must(streams => streams != null && streams.Count >= 2)
.WithMessage("At least 2 PDF files are required for merging");
}
}

View File

@@ -0,0 +1,44 @@
using AutoMapper;
using DocumentService.Application.Common.DTOs;
using DocumentService.Application.Common.Interfaces;
using MediatR;
namespace DocumentService.Application.SwissQrCode.Queries;
/// <summary>
/// Query for extracting Swiss QR Code from PDF (Stream-based)
/// </summary>
public record ExtractSwissQrCodeQuery : IRequest<SwissQrCodeExtractionResult>
{
/// <summary>
/// PDF as stream (caller is responsible for disposal)
/// </summary>
public required Stream PdfStream { get; init; }
}
/// <summary>
/// Handler for ExtractSwissQrCodeQuery
/// Orchestrates Swiss QR Code extraction using ISwissQrCodeProcessor and AutoMapper
/// </summary>
public class ExtractSwissQrCodeQueryHandler(ISwissQrCodeProcessor qrCodeProcessor, IMapper mapper)
: IRequestHandler<ExtractSwissQrCodeQuery, SwissQrCodeExtractionResult>
{
/// <summary>
/// Extracts and parses Swiss QR Code from the PDF (default: scans all pages starting with last)
/// Returns both parsed Bill DTO and raw QR text lines
/// </summary>
public async Task<SwissQrCodeExtractionResult> Handle(ExtractSwissQrCodeQuery request, CancellationToken cancellationToken)
{
// Extract: returns (Bill, RawLines) - pass stream directly
var (bill, rawLines) = await qrCodeProcessor.ExtractSwissQrCodeAsync(request.PdfStream, pageNumbers: null, cancellationToken);
// Map Codecrete Bill to DTO using AutoMapper
var billDto = mapper.Map<SwissQrBillDto>(bill);
// Return references (passed through) + Bill DTO + raw lines
return new SwissQrCodeExtractionResult(
Bill: billDto,
RawLines: rawLines
);
}
}

View File

@@ -0,0 +1,19 @@
using DocumentService.Application.SwissQrCode.Queries;
using FluentValidation;
namespace DocumentService.Application.SwissQrCode.Queries;
/// <summary>
/// Validates ExtractSwissQrCodeQuery before handler execution.
/// Ensures PdfStream is not null.
/// </summary>
public sealed class ExtractSwissQrCodeQueryValidator : AbstractValidator<ExtractSwissQrCodeQuery>
{
public ExtractSwissQrCodeQueryValidator()
{
// Rule: PdfStream must be provided
RuleFor(x => x.PdfStream)
.NotNull()
.WithMessage("PdfStream is required");
}
}

View File

@@ -0,0 +1,37 @@
using AutoMapper;
using DocumentService.Application.Common.DTOs;
using DocumentService.Application.Common.Interfaces;
using MediatR;
namespace DocumentService.Application.ValidatePdf.Queries;
/// <summary>
/// Query for PDF validation (Stream-based)
/// </summary>
public record ValidatePdfQuery : IRequest<PdfValidationResult>
{
/// <summary>
/// PDF as stream (caller is responsible for disposal)
/// </summary>
public required Stream PdfStream { get; init; }
}
/// <summary>
/// Handler for ValidatePdfQuery
/// Orchestrates PDF validation using IPdfProcessor and AutoMapper
/// </summary>
public class ValidatePdfQueryHandler(IPdfProcessor PdfProcessor, IMapper Mapper)
: IRequestHandler<ValidatePdfQuery, PdfValidationResult>
{
/// <summary>
/// Validates PDF and returns metadata
/// </summary>
public async Task<PdfValidationResult> Handle(ValidatePdfQuery request, CancellationToken cancellationToken)
{
// Call DevExpress service directly with stream (exceptions propagate naturally)
var metadata = await PdfProcessor.ValidateAsync(request.PdfStream);
// Map DTO to response DTO using AutoMapper
return Mapper.Map<PdfValidationResult>(metadata);
}
}

View File

@@ -0,0 +1,19 @@
using DocumentService.Application.ValidatePdf.Queries;
using FluentValidation;
namespace DocumentService.Application.ValidatePdf.Queries;
/// <summary>
/// Validator for ValidatePdfQuery
/// Ensures PdfStream is not null
/// </summary>
public class ValidatePdfQueryValidator : AbstractValidator<ValidatePdfQuery>
{
public ValidatePdfQueryValidator()
{
// Rule: PdfStream must be provided
RuleFor(x => x.PdfStream)
.NotNull()
.WithMessage("PdfStream is required");
}
}

View File

@@ -0,0 +1,37 @@
using AutoMapper;
using DocumentService.Application.Common.DTOs;
using DocumentService.Application.Common.Interfaces;
using MediatR;
namespace DocumentService.Application.ValidatePdfA.Queries;
/// <summary>
/// Query for PDF/A validation (Stream-based)
/// </summary>
public record ValidatePdfAQuery : IRequest<PdfAValidationResult>
{
/// <summary>
/// PDF as stream (caller is responsible for disposal)
/// </summary>
public required Stream PdfStream { get; init; }
}
/// <summary>
/// Handler for ValidatePdfAQuery
/// Orchestrates PDF/A validation using IPdfProcessor and AutoMapper
/// </summary>
public class ValidatePdfAQueryHandler(IPdfProcessor PdfProcessor, IMapper Mapper)
: IRequestHandler<ValidatePdfAQuery, PdfAValidationResult>
{
/// <summary>
/// Validates PDF/A and returns metadata with conformance level
/// </summary>
public async Task<PdfAValidationResult> Handle(ValidatePdfAQuery request, CancellationToken cancellationToken)
{
// Call DevExpress service directly with stream (exceptions propagate naturally)
var metadata = await PdfProcessor.ValidatePdfAAsync(request.PdfStream);
// Map DTO to response DTO using AutoMapper
return Mapper.Map<PdfAValidationResult>(metadata);
}
}

View File

@@ -0,0 +1,18 @@
using FluentValidation;
namespace DocumentService.Application.ValidatePdfA.Validators;
/// <summary>
/// Validator for ValidatePdfAQuery
/// Ensures PdfStream is not null
/// </summary>
public class ValidatePdfAQueryValidator : AbstractValidator<Queries.ValidatePdfAQuery>
{
public ValidatePdfAQueryValidator()
{
// Rule: PdfStream must be provided
RuleFor(x => x.PdfStream)
.NotNull()
.WithMessage("PdfStream is required");
}
}

View File

@@ -0,0 +1,23 @@
using System;
using System.Collections.Generic;
using System.Linq;
using System.Runtime.Serialization;
using System.Text;
using System.Threading.Tasks;
namespace DocumentService.Domain.Common.Exceptions;
public class BadRequestException : Exception
{
public BadRequestException()
{
}
public BadRequestException(string? message) : base(message)
{
}
public BadRequestException(string? message, Exception? innerException) : base(message, innerException)
{
}
}

View File

@@ -1,9 +1,10 @@
namespace DocumentOperator.Domain.Common.Exceptions;
namespace DocumentService.Domain.Common.Exceptions;
/// <summary>
/// Base exception for all domain-related exceptions.
/// Caught by the Exception Handling Middleware in the API layer.
/// </summary>
[Obsolete("This exception is deprecated. Use more specific exceptions for domain errors.")]
public abstract class DomainException : Exception
{
/// <summary>

View File

@@ -1,9 +1,10 @@
namespace DocumentOperator.Domain.Common.Exceptions;
namespace DocumentService.Domain.Common.Exceptions;
/// <summary>
/// Exception thrown when domain validation fails (e.g., invalid Value Objects).
/// Maps to HTTP 400 Bad Request in the API layer.
/// </summary>
[Obsolete("This exception is deprecated. Use more specific exceptions for domain validation errors.")]
public class DomainValidationException : DomainException
{
public string PropertyName { get; }

View File

@@ -1,25 +1,22 @@
namespace DocumentOperator.Domain.Common.Exceptions;
using System.Runtime.Serialization;
namespace DocumentService.Domain.Common.Exceptions;
/// <summary>
/// Exception thrown when a requested resource is not found.
/// Maps to HTTP 404 Not Found in the API layer.
/// </summary>
public class NotFoundException : DomainException
public class NotFoundException : Exception
{
public string ResourceType { get; }
public object ResourceId { get; }
public NotFoundException(string resourceType, object resourceId)
: base($"{resourceType} with ID '{resourceId}' was not found.", "RESOURCE_NOT_FOUND")
public NotFoundException()
{
ResourceType = resourceType;
ResourceId = resourceId;
}
public NotFoundException(string resourceType, object resourceId, string customMessage)
: base(customMessage, "RESOURCE_NOT_FOUND")
public NotFoundException(string? message) : base(message)
{
}
public NotFoundException(string? message, Exception? innerException) : base(message, innerException)
{
ResourceType = resourceType;
ResourceId = resourceId;
}
}

View File

@@ -1,34 +0,0 @@
namespace DocumentOperator.Domain.Common.Exceptions;
/// <summary>
/// Exception thrown when PDF processing operations fail.
/// Maps to HTTP 500 Internal Server Error or 422 Unprocessable Entity in the API layer.
/// </summary>
public class PdfProcessingException : DomainException
{
public string Operation { get; }
public PdfProcessingException(string operation, string message)
: base($"PDF processing failed during '{operation}': {message}", "PDF_PROCESSING_ERROR")
{
Operation = operation;
}
public PdfProcessingException(string operation, string message, Exception innerException)
: base($"PDF processing failed during '{operation}': {message}", "PDF_PROCESSING_ERROR", innerException)
{
Operation = operation;
}
public PdfProcessingException(string message)
: base(message, "PDF_PROCESSING_ERROR")
{
Operation = "Unknown";
}
public PdfProcessingException(string message, Exception innerException)
: base(message, "PDF_PROCESSING_ERROR", innerException)
{
Operation = "Unknown";
}
}

View File

@@ -1,14 +0,0 @@
<Project Sdk="Microsoft.NET.Sdk">
<PropertyGroup>
<TargetFramework>net8.0</TargetFramework>
<ImplicitUsings>enable</ImplicitUsings>
<Nullable>enable</Nullable>
</PropertyGroup>
<ItemGroup>
<Folder Include="Common\Results\" />
<Folder Include="Constants\" />
</ItemGroup>
</Project>

View File

@@ -0,0 +1,18 @@
<Project Sdk="Microsoft.NET.Sdk">
<PropertyGroup>
<TargetFramework>net8.0</TargetFramework>
<ImplicitUsings>enable</ImplicitUsings>
<Nullable>enable</Nullable>
</PropertyGroup>
<ItemGroup>
<Compile Remove="Common\Results\**" />
<Compile Remove="Constants\**" />
<EmbeddedResource Remove="Common\Results\**" />
<EmbeddedResource Remove="Constants\**" />
<None Remove="Common\Results\**" />
<None Remove="Constants\**" />
</ItemGroup>
</Project>

View File

@@ -1,22 +0,0 @@
namespace DocumentOperator.Domain.Exceptions;
/// <summary>
/// Exception thrown when a Swiss QR Code cannot be found in a PDF document.
/// </summary>
public sealed class SwissQrCodeNotFoundException : Exception
{
public SwissQrCodeNotFoundException()
: base("No Swiss QR Code found on the last page of the PDF document.")
{
}
public SwissQrCodeNotFoundException(string message)
: base(message)
{
}
public SwissQrCodeNotFoundException(string message, Exception innerException)
: base(message, innerException)
{
}
}

View File

@@ -1,10 +0,0 @@
namespace DocumentOperator.Domain.Models.Enums;
public enum DocumentOperationType
{
Validate,
ExtractAttachments,
Concatenate,
ApplyStamp,
EmbedCertificate
}

View File

@@ -1,9 +0,0 @@
namespace DocumentOperator.Domain.Models.Enums;
public enum ProcessingStatus
{
Pending,
Processing,
Success,
Failed
}

View File

@@ -0,0 +1,18 @@
namespace DocumentService.Domain.Models.ValueObjects;
/// <summary>
/// Coordinate origin point for PDF annotations.
/// PDF default is BottomLeft, but users may prefer TopLeft for easier UI integration.
/// </summary>
public enum AnnotationOrigin
{
/// <summary>
/// Bottom-left corner (PDF native coordinate system, default)
/// </summary>
BottomLeft,
/// <summary>
/// Top-left corner (common in UI frameworks)
/// </summary>
TopLeft
}

View File

@@ -0,0 +1,32 @@
namespace DocumentService.Domain.Models.ValueObjects;
/// <summary>
/// Supported PDF annotation types
/// </summary>
public enum AnnotationType
{
/// <summary>
/// Text markup annotation (highlight, underline, strikeout)
/// </summary>
TextMarkup,
/// <summary>
/// Free text annotation (text box with visible text)
/// </summary>
FreeText,
/// <summary>
/// Sticky note annotation (popup comment icon)
/// </summary>
StickyNote,
/// <summary>
/// Circle shape annotation
/// </summary>
Circle,
/// <summary>
/// Square shape annotation
/// </summary>
Square
}

View File

@@ -1,59 +0,0 @@
namespace DocumentOperator.Domain.Models.ValueObjects;
public sealed class Base64String
{
public string Value { get; }
private Base64String(string value)
{
Value = value;
}
public static Base64String Create(string value)
{
if (string.IsNullOrWhiteSpace(value))
throw new Common.Exceptions.DomainValidationException("Base64 string cannot be empty.");
// Validierung: Ist es gültiges Base64?
try
{
Convert.FromBase64String(value);
}
catch (FormatException)
{
throw new Common.Exceptions.DomainValidationException("Invalid Base64 format.");
}
return new Base64String(value);
}
public static Base64String FromByteArray(byte[] bytes)
{
if (bytes == null || bytes.Length == 0)
throw new Common.Exceptions.DomainValidationException("Byte array cannot be null or empty.");
var base64 = Convert.ToBase64String(bytes);
return new Base64String(base64);
}
public byte[] ToByteArray()
{
return Convert.FromBase64String(Value);
}
public override string ToString() => Value;
// Equality (wichtig für Value Objects!)
public override bool Equals(object? obj)
{
if (obj is not Base64String other)
return false;
return Value == other.Value;
}
public override int GetHashCode()
{
return Value.GetHashCode();
}
}

View File

@@ -1,32 +0,0 @@
namespace DocumentOperator.Domain.Models.ValueObjects;
public sealed class PdfMetadata
{
public int PageCount { get; }
public long FileSizeBytes { get; }
public string PdfVersion { get; }
public bool HasAttachments { get; }
public int AttachmentCount { get; }
// Computed Property (berechnet aus FileSizeBytes)
public double FileSizeMB => FileSizeBytes / 1024.0 / 1024.0;
public PdfMetadata(
int pageCount,
long fileSizeBytes,
string pdfVersion,
bool hasAttachments,
int attachmentCount)
{
PageCount = pageCount;
FileSizeBytes = fileSizeBytes;
PdfVersion = pdfVersion;
HasAttachments = hasAttachments;
AttachmentCount = attachmentCount;
}
public override string ToString()
{
return $"PDF: {PageCount} pages, {FileSizeMB:F2} MB, Version {PdfVersion}, Attachments: {AttachmentCount}";
}
}

View File

@@ -0,0 +1,32 @@
namespace DocumentService.Domain.Models.ValueObjects;
/// <summary>
/// Predefined stamp types with standard text and styling.
/// </summary>
public enum PredefinedStampType
{
/// <summary>
/// CONFIDENTIAL stamp (red, bold).
/// </summary>
Confidential,
/// <summary>
/// APPROVED stamp (green, bold).
/// </summary>
Approved,
/// <summary>
/// DRAFT stamp (gray, italic).
/// </summary>
Draft,
/// <summary>
/// VOID stamp (red, strikethrough effect).
/// </summary>
Void,
/// <summary>
/// FOR REVIEW stamp (orange, bold).
/// </summary>
ForReview
}

View File

@@ -0,0 +1,17 @@
namespace DocumentService.Domain.Models.ValueObjects;
/// <summary>
/// Specifies whether the stamp should appear in the foreground (on top of content) or background (behind content).
/// </summary>
public enum StampPlacement
{
/// <summary>
/// Stamp appears on top of existing page content.
/// </summary>
Foreground,
/// <summary>
/// Stamp appears behind existing page content (watermark effect).
/// </summary>
Background
}

View File

@@ -0,0 +1,22 @@
namespace DocumentService.Domain.Models.ValueObjects;
/// <summary>
/// Specifies the type of stamp to add to a PDF document.
/// </summary>
public enum StampType
{
/// <summary>
/// Text-based stamp with custom text, font, and color.
/// </summary>
Text,
/// <summary>
/// Image-based stamp (PNG/JPEG overlay).
/// </summary>
Image,
/// <summary>
/// Predefined stamp with standard text (e.g., CONFIDENTIAL, APPROVED).
/// </summary>
Predefined
}

View File

@@ -1,4 +1,4 @@
namespace DocumentOperator.Domain.Models.ValueObjects;
namespace DocumentService.Domain.Models.ValueObjects;
public sealed class TenantId
{

View File

@@ -0,0 +1,23 @@
namespace DocumentService.Domain.Models.ValueObjects;
/// <summary>
/// Text markup annotation style (highlight, underline, strikeout)
/// Maps to DevExpress PdfTextMarkupAnnotationType
/// </summary>
public enum TextMarkupStyle
{
/// <summary>
/// Highlight text with background color
/// </summary>
Highlight,
/// <summary>
/// Underline text
/// </summary>
Underline,
/// <summary>
/// Strikeout text (strikethrough)
/// </summary>
Strikeout
}

View File

@@ -1,129 +0,0 @@
namespace DocumentOperator.Domain.ValueObjects;
/// <summary>
/// Represents Swiss QR Code data according to Swiss QR Bill Standard 2.0.
/// Immutable value object containing all fields from a Swiss QR payment part.
/// </summary>
public sealed record SwissQrCodeData
{
/// <summary>
/// QR type - always "SPC" for Swiss Payment Code
/// </summary>
public required string QrType { get; init; }
/// <summary>
/// Version of the Swiss QR Code standard (e.g., "0200" for version 2.0)
/// </summary>
public required string Version { get; init; }
/// <summary>
/// Character set code (always "1" for UTF-8)
/// </summary>
public required string CodingType { get; init; }
/// <summary>
/// IBAN of the creditor (payee)
/// </summary>
public required string Iban { get; init; }
/// <summary>
/// Creditor (payee) information
/// </summary>
public required AddressData Creditor { get; init; }
/// <summary>
/// Ultimate creditor information (optional)
/// </summary>
public AddressData? UltimateCreditor { get; init; }
/// <summary>
/// Payment amount (null if not specified)
/// </summary>
public decimal? Amount { get; init; }
/// <summary>
/// Currency code (CHF or EUR)
/// </summary>
public required string Currency { get; init; }
/// <summary>
/// Ultimate debtor (payer) information (optional)
/// </summary>
public AddressData? UltimateDebtor { get; init; }
/// <summary>
/// Reference type (QRR, SCOR, or NON)
/// </summary>
public required string ReferenceType { get; init; }
/// <summary>
/// Payment reference (format depends on ReferenceType)
/// </summary>
public string? Reference { get; init; }
/// <summary>
/// Unstructured message (max 140 characters)
/// </summary>
public string? UnstructuredMessage { get; init; }
/// <summary>
/// Bill information (structured data for automated processing)
/// </summary>
public string? BillInformation { get; init; }
/// <summary>
/// Alternative procedure parameters (up to 2 entries)
/// </summary>
public IReadOnlyList<string>? AlternativeProcedureParameters { get; init; }
}
/// <summary>
/// Represents address data in Swiss QR Code (creditor or debtor)
/// </summary>
public sealed record AddressData
{
/// <summary>
/// Address type: "S" for structured, "K" for combined
/// </summary>
public required string AddressType { get; init; }
/// <summary>
/// Name of person or company
/// </summary>
public required string Name { get; init; }
/// <summary>
/// Street name (structured address only)
/// </summary>
public string? Street { get; init; }
/// <summary>
/// Building number (structured address only)
/// </summary>
public string? BuildingNumber { get; init; }
/// <summary>
/// Address line 1 (combined address only)
/// </summary>
public string? AddressLine1 { get; init; }
/// <summary>
/// Address line 2 (combined address only)
/// </summary>
public string? AddressLine2 { get; init; }
/// <summary>
/// Postal code
/// </summary>
public required string PostalCode { get; init; }
/// <summary>
/// City/town name
/// </summary>
public required string City { get; init; }
/// <summary>
/// Two-letter country code (ISO 3166-1 alpha-2)
/// </summary>
public required string Country { get; init; }
}

View File

@@ -1,4 +1,4 @@
namespace DocumentOperator.Infrastructure.Configuration;
namespace DocumentService.Infrastructure.Configuration;
public class ApiKeySettings
{

View File

@@ -1,8 +1,8 @@
namespace DocumentOperator.Infrastructure.Configuration;
namespace DocumentService.Infrastructure.Configuration;
public class DocumentOperatorSettings
public class DocumentServiceSettings
{
public const string SectionName = "DocumentOperatorSettings";
public const string SectionName = "DocumentServiceSettings";
public string TempFolderPath { get; set; } = string.Empty;
public int TempFileRetentionHours { get; set; }

View File

@@ -1,10 +1,10 @@
namespace DocumentOperator.Infrastructure.Configuration;
namespace DocumentService.Infrastructure.Configuration;
public class RedisSettings
{
public const string SectionName = "RedisSettings";
public string ConnectionString { get; set; } = "localhost:6379";
public string InstanceName { get; set; } = "DocumentOperator:";
public string InstanceName { get; set; } = "DocumentService:";
public int CacheExpirationMinutes { get; set; } = 60;
}

View File

@@ -1,4 +1,4 @@
namespace DocumentOperator.Infrastructure.Configuration;
namespace DocumentService.Infrastructure.Configuration;
public class TenantInfo
{

View File

@@ -1,9 +1,9 @@
using DocumentOperator.Application.Common.Interfaces;
using DocumentOperator.Infrastructure.Services.PdfProcessing;
using DocumentOperator.Infrastructure.Services.QrCodeProcessing;
using DocumentService.Application.Common.Interfaces;
using DocumentService.Infrastructure.Services.PdfProcessing;
using DocumentService.Infrastructure.Services.QrCodeProcessing;
using Microsoft.Extensions.DependencyInjection;
namespace DocumentOperator.Infrastructure;
namespace DocumentService.Infrastructure;
/// <summary>
/// Dependency Injection configuration for Infrastructure Layer

View File

@@ -6,23 +6,29 @@
<Nullable>enable</Nullable>
</PropertyGroup>
<ItemGroup>
<Compile Remove="DependencyInjection\**" />
<Compile Remove="Services\DocumentValidation\**" />
<Compile Remove="Services\FileStorage\**" />
<EmbeddedResource Remove="DependencyInjection\**" />
<EmbeddedResource Remove="Services\DocumentValidation\**" />
<EmbeddedResource Remove="Services\FileStorage\**" />
<None Remove="DependencyInjection\**" />
<None Remove="Services\DocumentValidation\**" />
<None Remove="Services\FileStorage\**" />
</ItemGroup>
<ItemGroup>
<PackageReference Include="Codecrete.SwissQRBill.Generator" Version="3.4.0" />
<PackageReference Include="DevExpress.Document.Processor" Version="26.1.3" />
<PackageReference Include="Microsoft.Extensions.Options.ConfigurationExtensions" Version="8.0.0" />
<PackageReference Include="SkiaSharp.QrCode" Version="1.0.0" />
<PackageReference Include="System.Drawing.Common" Version="10.0.9" />
<PackageReference Include="ZXing.Net.Bindings.Windows.Compatibility" Version="0.16.14" />
</ItemGroup>
<ItemGroup>
<ProjectReference Include="..\DocumentOperator.Application\DocumentOperator.Application.csproj" />
<ProjectReference Include="..\DocumentOperator.Domain\DocumentOperator.Domain.csproj" />
</ItemGroup>
<ItemGroup>
<Folder Include="DependencyInjection\" />
<Folder Include="Services\FileStorage\" />
<Folder Include="Services\DocumentValidation\" />
<ProjectReference Include="..\DocumentOperator.Application\DocumentService.Application.csproj" />
<ProjectReference Include="..\DocumentOperator.Domain\DocumentService.Domain.csproj" />
</ItemGroup>
</Project>

Some files were not shown because too many files have changed in this diff Show More