Compare commits
8
Commits
5bcaf97eba
...
main
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
cc129b9c23 | ||
|
|
dcf68fede6 | ||
|
|
60aba03633 | ||
|
|
c95cd99be7 | ||
|
|
fd71c272fa | ||
|
|
fa0d9da2b1 | ||
|
|
28f62cee06 | ||
|
|
6838ce3b20 |
@@ -6,3 +6,7 @@ MONGODB_URI=mongodb://BENUTZER:PASSWORT@localhost:27017/pdf-tool?authSource=admi
|
||||
|
||||
# HTTP-Port der Anwendung (Standard: 8083)
|
||||
SERVER_PORT=8083
|
||||
|
||||
# Basis-URL der PDF-Service-API (ZUGFeRD-Umwandlung); die Endpoints
|
||||
# /invoices/sign und /invoices/validate liegen unterhalb dieser URL.
|
||||
PDF_SERVICE_URL=http://localhost:8084/api/v1
|
||||
|
||||
Vendored
+3
@@ -0,0 +1,3 @@
|
||||
{
|
||||
"java.compile.nullAnalysis.mode": "disabled"
|
||||
}
|
||||
@@ -1,7 +1,7 @@
|
||||
# PDF Tool — ZUGFeRD E-Rechnungs-Konverter
|
||||
|
||||
Spring Boot + Vaadin Flow Anwendung, die ein herkömmliches B2B-Rechnungs-PDF in eine
|
||||
**rechtskonforme ZUGFeRD-E-Rechnung** umwandelt (PDF/A-3 mit eingebettetem EN16931-XML,
|
||||
Spring Boot + Vaadin Flow Anwendung, die aus gespeicherten Rechnungstemplates
|
||||
**rechtskonforme ZUGFeRD-E-Rechnungen** erzeugt (PDF/A-3 mit eingebettetem EN16931-XML,
|
||||
Profil EN 16931 / Factur-X), das Ergebnis mit dem **Mustang-Validator** prüft und als
|
||||
**ZIP-Datei** bereitstellt.
|
||||
|
||||
@@ -26,7 +26,8 @@ mvn spring-boot:run
|
||||
```
|
||||
|
||||
Die Weboberfläche ist dann unter <http://localhost:8083> erreichbar:
|
||||
PDF hochladen, Rechnungsdaten ausfüllen, "E-Rechnung erzeugen" klicken, ZIP herunterladen.
|
||||
Rechnungstemplate auswählen, Rechnungsdaten ausfüllen, "E-Rechnung erzeugen" klicken —
|
||||
das ZIP wird automatisch heruntergeladen.
|
||||
|
||||
Produktions-Build:
|
||||
|
||||
@@ -35,94 +36,21 @@ mvn clean package -Pproduction
|
||||
java -jar target/pdf-tool-1.0.0-SNAPSHOT.jar
|
||||
```
|
||||
|
||||
## REST-API
|
||||
## PDF Service
|
||||
|
||||
### E-Rechnung erzeugen
|
||||
|
||||
`POST /api/invoices/sign` (multipart/form-data) mit zwei Parts:
|
||||
|
||||
| Part | Inhalt |
|
||||
|------------|-------------------------------------------|
|
||||
| `file` | das Rechnungs-PDF |
|
||||
| `metadata` | Rechnungsdaten als JSON (siehe unten) |
|
||||
|
||||
Antwort: `application/zip` mit `<Rechnungsnummer>-zugferd.pdf`, `factur-x.xml` und
|
||||
`validation-report.xml` (Mustang-Prüfbericht). Der Header `X-Zugferd-Valid: true|false`
|
||||
meldet das Validierungsergebnis. Bei Fehlern: HTTP 400 mit `{"error": "..."}`.
|
||||
|
||||
> Häufigste Ursache für `X-Zugferd-Valid: false`: Das Quell-PDF bettet seine
|
||||
> Schriften nicht ein. Das kann die Konvertierung nicht reparieren — das PDF muss
|
||||
> dann mit eingebetteten Schriften neu erzeugt werden (Standard bei den meisten
|
||||
> ERP-/Reporting-Systemen konfigurierbar).
|
||||
|
||||
### Bestehende E-Rechnung prüfen
|
||||
|
||||
`POST /api/invoices/validate` (multipart/form-data, Part `file` = ZUGFeRD-PDF oder
|
||||
Factur-X-XML). Antwort: der Mustang-Prüfbericht als XML — HTTP 200 bei gültiger,
|
||||
HTTP 422 bei ungültiger Rechnung, ebenfalls mit `X-Zugferd-Valid`-Header.
|
||||
|
||||
```bash
|
||||
curl -X POST http://localhost:8083/api/invoices/validate \
|
||||
-F "file=@rechnung-zugferd.pdf"
|
||||
```
|
||||
|
||||
### Beispiel
|
||||
|
||||
```bash
|
||||
curl -X POST http://localhost:8083/api/invoices/sign \
|
||||
-F "file=@rechnung.pdf" \
|
||||
-F "metadata=@metadata.json;type=application/json" \
|
||||
-o rechnung-zugferd.zip
|
||||
```
|
||||
|
||||
`metadata.json`:
|
||||
|
||||
```json
|
||||
{
|
||||
"invoiceNumber": "RE-2026-0815",
|
||||
"issueDate": "2026-07-08",
|
||||
"deliveryDate": "2026-07-01",
|
||||
"dueDate": "2026-07-22",
|
||||
"currency": "EUR",
|
||||
"paymentTerms": "Zahlbar innerhalb von 14 Tagen ohne Abzug.",
|
||||
"sender": {
|
||||
"name": "Assecutor GmbH",
|
||||
"street": "Musterstrasse 1",
|
||||
"zip": "20095",
|
||||
"city": "Hamburg",
|
||||
"countryCode": "DE",
|
||||
"vatId": "DE123456789"
|
||||
},
|
||||
"recipient": {
|
||||
"name": "Kunde AG",
|
||||
"street": "Beispielweg 2",
|
||||
"zip": "10115",
|
||||
"city": "Berlin",
|
||||
"countryCode": "DE"
|
||||
},
|
||||
"items": [
|
||||
{
|
||||
"description": "Beratungsleistung",
|
||||
"quantity": 1,
|
||||
"unitPriceNet": 1500.00,
|
||||
"vatPercent": 19
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
Pflichtfelder: `invoiceNumber`, `issueDate`, `sender` (inkl. Adresse), `recipient`,
|
||||
mindestens ein Eintrag in `items`. `deliveryDate` fällt auf das Rechnungsdatum zurück,
|
||||
`dueDate` auf Rechnungsdatum + 14 Tage, `currency` auf `EUR`.
|
||||
Die ZUGFeRD-Umwandlung (PDF/A-3 + EN16931-XML, Mustangproject) übernimmt das
|
||||
eigenständige Projekt **PDF Service** (`../PDF Service`, Port 8084). Dieses Tool
|
||||
rendert die Rechnung aus dem Template und ruft dann dessen REST-API
|
||||
(`POST /api/v1/invoices/sign`) auf — der Service muss dafür laufen. Die Basis-URL
|
||||
der API ist über `PDF_SERVICE_URL` konfigurierbar (Standard
|
||||
`http://localhost:8084/api/v1`).
|
||||
|
||||
## Architektur
|
||||
|
||||
- [ZugferdService](src/main/java/de/assecutor/pdftool/zugferd/ZugferdService.java) — Kernlogik:
|
||||
PDF → PDF/A-3 + EN16931-XML (Mustangproject), Validierung, Verpackung als ZIP.
|
||||
Nicht-PDF/A-Eingaben (der Normalfall) werden tolerant konvertiert.
|
||||
- [ZugferdValidationService](src/main/java/de/assecutor/pdftool/zugferd/ZugferdValidationService.java) — Mustang-Validator
|
||||
(XSD + Schematron + veraPDF), liefert Status und XML-Prüfbericht
|
||||
- [InvoiceSigningController](src/main/java/de/assecutor/pdftool/api/InvoiceSigningController.java) — REST-Endpunkte `/sign` und `/validate`
|
||||
- [TemplatePdfService](src/main/java/de/assecutor/pdftool/template/TemplatePdfService.java) — rendert
|
||||
die Canvas-Templates (JSON aus MongoDB) über iText html2pdf zu einem PDF
|
||||
- [PdfServiceClient](src/main/java/de/assecutor/pdftool/pdfservice/PdfServiceClient.java) — ruft den
|
||||
PDF Service auf, der daraus die ZUGFeRD-E-Rechnung als ZIP erzeugt
|
||||
- [MainView](src/main/java/de/assecutor/pdftool/ui/MainView.java) — Vaadin-Weboberfläche
|
||||
- [InvoiceMetadata](src/main/java/de/assecutor/pdftool/invoice/InvoiceMetadata.java) — DTO für die Rechnungsdaten
|
||||
|
||||
@@ -132,6 +60,6 @@ mindestens ein Eintrag in `items`. `deliveryDate` fällt auf das Rechnungsdatum
|
||||
mvn test
|
||||
```
|
||||
|
||||
[ZugferdServiceTest](src/test/java/de/assecutor/pdftool/zugferd/ZugferdServiceTest.java) erzeugt ein
|
||||
Test-PDF, konvertiert es und prüft, dass das ZIP ein PDF/A-3 mit eingebettetem
|
||||
`factur-x.xml` (EN16931-Profil) enthält.
|
||||
Die Tests decken das Template-Rendering ([TemplatePdfServiceTest](src/test/java/de/assecutor/pdftool/template/TemplatePdfServiceTest.java),
|
||||
[TemplateVariablesTest](src/test/java/de/assecutor/pdftool/template/TemplateVariablesTest.java)) und die
|
||||
USt-IdNr.-Validierung ab; die ZUGFeRD-Umwandlung wird im Projekt PDF Service getestet.
|
||||
|
||||
Generated
+9537
File diff suppressed because it is too large
Load Diff
+104
@@ -0,0 +1,104 @@
|
||||
{
|
||||
"name": "no-name",
|
||||
"license": "UNLICENSED",
|
||||
"type": "module",
|
||||
"dependencies": {
|
||||
"@polymer/polymer": "3.5.2",
|
||||
"@vaadin/bundles": "24.7.6",
|
||||
"@vaadin/common-frontend": "0.0.19",
|
||||
"@vaadin/polymer-legacy-adapter": "24.7.6",
|
||||
"@vaadin/react-components": "24.7.6",
|
||||
"@vaadin/vaadin-development-mode-detector": "2.0.7",
|
||||
"@vaadin/vaadin-lumo-styles": "24.7.6",
|
||||
"@vaadin/vaadin-material-styles": "24.7.6",
|
||||
"@vaadin/vaadin-themable-mixin": "24.7.6",
|
||||
"@vaadin/vaadin-usage-statistics": "2.1.3",
|
||||
"construct-style-sheets-polyfill": "3.1.0",
|
||||
"date-fns": "2.29.3",
|
||||
"lit": "3.3.0",
|
||||
"react": "18.3.1",
|
||||
"react-dom": "18.3.1",
|
||||
"react-router": "7.5.2"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@babel/preset-react": "7.26.3",
|
||||
"@preact/signals-react-transform": "0.5.1",
|
||||
"@rollup/plugin-replace": "6.0.2",
|
||||
"@rollup/pluginutils": "5.1.4",
|
||||
"@types/react": "18.3.20",
|
||||
"@types/react-dom": "18.3.6",
|
||||
"@vitejs/plugin-react": "4.4.1",
|
||||
"async": "3.2.6",
|
||||
"glob": "11.0.2",
|
||||
"rollup-plugin-brotli": "3.1.0",
|
||||
"rollup-plugin-visualizer": "5.14.0",
|
||||
"strip-css-comments": "5.0.0",
|
||||
"transform-ast": "2.4.4",
|
||||
"typescript": "5.7.3",
|
||||
"vite": "6.3.4",
|
||||
"vite-plugin-checker": "0.9.1",
|
||||
"workbox-build": "7.3.0",
|
||||
"workbox-core": "7.3.0",
|
||||
"workbox-precaching": "7.3.0"
|
||||
},
|
||||
"vaadin": {
|
||||
"dependencies": {
|
||||
"@polymer/polymer": "3.5.2",
|
||||
"@vaadin/bundles": "24.7.6",
|
||||
"@vaadin/common-frontend": "0.0.19",
|
||||
"@vaadin/polymer-legacy-adapter": "24.7.6",
|
||||
"@vaadin/react-components": "24.7.6",
|
||||
"@vaadin/vaadin-development-mode-detector": "2.0.7",
|
||||
"@vaadin/vaadin-lumo-styles": "24.7.6",
|
||||
"@vaadin/vaadin-material-styles": "24.7.6",
|
||||
"@vaadin/vaadin-themable-mixin": "24.7.6",
|
||||
"@vaadin/vaadin-usage-statistics": "2.1.3",
|
||||
"construct-style-sheets-polyfill": "3.1.0",
|
||||
"date-fns": "2.29.3",
|
||||
"lit": "3.3.0",
|
||||
"react": "18.3.1",
|
||||
"react-dom": "18.3.1",
|
||||
"react-router": "7.5.2"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@babel/preset-react": "7.26.3",
|
||||
"@preact/signals-react-transform": "0.5.1",
|
||||
"@rollup/plugin-replace": "6.0.2",
|
||||
"@rollup/pluginutils": "5.1.4",
|
||||
"@types/react": "18.3.20",
|
||||
"@types/react-dom": "18.3.6",
|
||||
"@vitejs/plugin-react": "4.4.1",
|
||||
"async": "3.2.6",
|
||||
"glob": "11.0.2",
|
||||
"rollup-plugin-brotli": "3.1.0",
|
||||
"rollup-plugin-visualizer": "5.14.0",
|
||||
"strip-css-comments": "5.0.0",
|
||||
"transform-ast": "2.4.4",
|
||||
"typescript": "5.7.3",
|
||||
"vite": "6.3.4",
|
||||
"vite-plugin-checker": "0.9.1",
|
||||
"workbox-build": "7.3.0",
|
||||
"workbox-core": "7.3.0",
|
||||
"workbox-precaching": "7.3.0"
|
||||
},
|
||||
"hash": "79560e4ddc395b0ad64481d9a3f56513be65cec5fb700f13f4c25c4dd181fa94"
|
||||
},
|
||||
"overrides": {
|
||||
"@vaadin/bundles": "$@vaadin/bundles",
|
||||
"@vaadin/polymer-legacy-adapter": "$@vaadin/polymer-legacy-adapter",
|
||||
"@vaadin/vaadin-development-mode-detector": "$@vaadin/vaadin-development-mode-detector",
|
||||
"@vaadin/vaadin-usage-statistics": "$@vaadin/vaadin-usage-statistics",
|
||||
"@vaadin/react-components": "$@vaadin/react-components",
|
||||
"@vaadin/common-frontend": "$@vaadin/common-frontend",
|
||||
"react-dom": "$react-dom",
|
||||
"construct-style-sheets-polyfill": "$construct-style-sheets-polyfill",
|
||||
"lit": "$lit",
|
||||
"@polymer/polymer": "$@polymer/polymer",
|
||||
"react": "$react",
|
||||
"react-router": "$react-router",
|
||||
"date-fns": "$date-fns",
|
||||
"@vaadin/vaadin-themable-mixin": "$@vaadin/vaadin-themable-mixin",
|
||||
"@vaadin/vaadin-lumo-styles": "$@vaadin/vaadin-lumo-styles",
|
||||
"@vaadin/vaadin-material-styles": "$@vaadin/vaadin-material-styles"
|
||||
}
|
||||
}
|
||||
@@ -20,7 +20,6 @@
|
||||
<properties>
|
||||
<java.version>21</java.version>
|
||||
<vaadin.version>24.7.4</vaadin.version>
|
||||
<mustang.version>2.24.0</mustang.version>
|
||||
</properties>
|
||||
|
||||
<dependencyManagement>
|
||||
@@ -54,13 +53,6 @@
|
||||
<artifactId>spring-boot-starter-data-mongodb</artifactId>
|
||||
</dependency>
|
||||
|
||||
<!-- Mustangproject: Open-Source-Referenzimplementierung von ZUGFeRD / Factur-X -->
|
||||
<dependency>
|
||||
<groupId>org.mustangproject</groupId>
|
||||
<artifactId>library</artifactId>
|
||||
<version>${mustang.version}</version>
|
||||
</dependency>
|
||||
|
||||
<!-- iText html2pdf: rendert die Canvas-Templates des Rechnungsgenerators
|
||||
(HTML mit absoluter mm-Positionierung) nach PDF. Achtung: AGPL-Lizenz. -->
|
||||
<dependency>
|
||||
@@ -68,11 +60,6 @@
|
||||
<artifactId>html2pdf</artifactId>
|
||||
<version>5.0.5</version>
|
||||
</dependency>
|
||||
<dependency>
|
||||
<groupId>org.mustangproject</groupId>
|
||||
<artifactId>validator</artifactId>
|
||||
<version>${mustang.version}</version>
|
||||
</dependency>
|
||||
|
||||
<dependency>
|
||||
<groupId>org.springframework.boot</groupId>
|
||||
|
||||
Binary file not shown.
Binary file not shown.
@@ -345,10 +345,10 @@ window.initProfileInvoiceGenerator = function() {
|
||||
// Text elements
|
||||
var lines = (el.text || '').split('\n');
|
||||
var lineHeight = fontSize * 1.2;
|
||||
var totalTextHeight = lines.length * lineHeight;
|
||||
|
||||
// Vertically center the text in the element
|
||||
var ty = y + (h - totalTextHeight) / 2;
|
||||
// Oben ausrichten statt zentrieren — wie im gerenderten PDF, damit die
|
||||
// erste Zeile unabhängig von der Zeilenzahl an der Box-Oberkante beginnt
|
||||
var ty = y;
|
||||
|
||||
// Masterdata elements are never bold; other elements respect their fontStyle
|
||||
var fontWeight = (el.isStatic && !el.isCustomer) ? '' : (el.fontStyle || '');
|
||||
|
||||
@@ -25,6 +25,7 @@ public class Address {
|
||||
private String vatId;
|
||||
private String email;
|
||||
private String phone;
|
||||
private String website;
|
||||
|
||||
// Bankverbindung (v. a. für Rechnungssteller relevant)
|
||||
private String bankName;
|
||||
@@ -119,6 +120,14 @@ public class Address {
|
||||
this.phone = phone;
|
||||
}
|
||||
|
||||
public String getWebsite() {
|
||||
return website;
|
||||
}
|
||||
|
||||
public void setWebsite(String website) {
|
||||
this.website = website;
|
||||
}
|
||||
|
||||
public String getBankName() {
|
||||
return bankName;
|
||||
}
|
||||
|
||||
@@ -1,122 +0,0 @@
|
||||
package de.assecutor.pdftool.api;
|
||||
|
||||
import com.fasterxml.jackson.databind.ObjectMapper;
|
||||
import de.assecutor.pdftool.invoice.InvoiceMetadata;
|
||||
import de.assecutor.pdftool.zugferd.ZugferdConversionException;
|
||||
import de.assecutor.pdftool.zugferd.ZugferdResult;
|
||||
import de.assecutor.pdftool.zugferd.ZugferdService;
|
||||
import de.assecutor.pdftool.zugferd.ZugferdValidationService;
|
||||
import jakarta.validation.ConstraintViolation;
|
||||
import jakarta.validation.Validator;
|
||||
import org.springframework.http.ContentDisposition;
|
||||
import org.springframework.http.HttpHeaders;
|
||||
import org.springframework.http.HttpStatus;
|
||||
import org.springframework.http.MediaType;
|
||||
import org.springframework.http.ResponseEntity;
|
||||
import org.springframework.web.bind.annotation.ExceptionHandler;
|
||||
import org.springframework.web.bind.annotation.PostMapping;
|
||||
import org.springframework.web.bind.annotation.RequestMapping;
|
||||
import org.springframework.web.bind.annotation.RequestPart;
|
||||
import org.springframework.web.bind.annotation.RestController;
|
||||
import org.springframework.web.multipart.MultipartFile;
|
||||
|
||||
import java.io.IOException;
|
||||
import java.util.Map;
|
||||
import java.util.Set;
|
||||
import java.util.stream.Collectors;
|
||||
|
||||
/**
|
||||
* REST-API zur Erzeugung und Prüfung rechtskonformer ZUGFeRD-E-Rechnungen.
|
||||
*
|
||||
* <pre>
|
||||
* curl -X POST http://localhost:8083/api/invoices/sign \
|
||||
* -F "file=@rechnung.pdf" \
|
||||
* -F "metadata=@metadata.json;type=application/json" \
|
||||
* -o rechnung-zugferd.zip
|
||||
*
|
||||
* curl -X POST http://localhost:8083/api/invoices/validate \
|
||||
* -F "file=@rechnung-zugferd.pdf"
|
||||
* </pre>
|
||||
*/
|
||||
@RestController
|
||||
@RequestMapping("/api/invoices")
|
||||
public class InvoiceSigningController {
|
||||
|
||||
/** Response-Header mit dem Ergebnis der Mustang-Validierung (true/false). */
|
||||
public static final String VALIDATION_HEADER = "X-Zugferd-Valid";
|
||||
|
||||
private final ZugferdService zugferdService;
|
||||
private final ZugferdValidationService validationService;
|
||||
private final ObjectMapper objectMapper;
|
||||
private final Validator validator;
|
||||
|
||||
public InvoiceSigningController(ZugferdService zugferdService,
|
||||
ZugferdValidationService validationService,
|
||||
ObjectMapper objectMapper,
|
||||
Validator validator) {
|
||||
this.zugferdService = zugferdService;
|
||||
this.validationService = validationService;
|
||||
this.objectMapper = objectMapper;
|
||||
this.validator = validator;
|
||||
}
|
||||
|
||||
/**
|
||||
* Erzeugt aus PDF und Metadaten eine ZUGFeRD-Rechnung als ZIP (PDF + Prüfbericht).
|
||||
* HTTP 200 bei gültiger, HTTP 422 bei ungültiger Rechnung; das ZIP wird in
|
||||
* beiden Fällen geliefert.
|
||||
*/
|
||||
@PostMapping(value = "/sign", consumes = MediaType.MULTIPART_FORM_DATA_VALUE)
|
||||
public ResponseEntity<byte[]> sign(@RequestPart("file") MultipartFile file,
|
||||
@RequestPart("metadata") String metadataJson) throws IOException {
|
||||
InvoiceMetadata metadata = parseAndValidate(metadataJson);
|
||||
ZugferdResult result = zugferdService.createZugferdZip(file.getBytes(), metadata);
|
||||
|
||||
HttpHeaders headers = new HttpHeaders();
|
||||
headers.setContentType(MediaType.parseMediaType("application/zip"));
|
||||
headers.setContentDisposition(ContentDisposition.attachment().filename(result.zipFileName()).build());
|
||||
headers.set(VALIDATION_HEADER, String.valueOf(result.valid()));
|
||||
return new ResponseEntity<>(result.zip(), headers,
|
||||
result.valid() ? HttpStatus.OK : HttpStatus.UNPROCESSABLE_ENTITY);
|
||||
}
|
||||
|
||||
/**
|
||||
* Validiert eine bestehende ZUGFeRD-Rechnung (PDF oder Factur-X-XML).
|
||||
* Antwort ist der Mustang-Prüfbericht als XML; HTTP 200 bei gültiger,
|
||||
* HTTP 422 bei ungültiger Rechnung.
|
||||
*/
|
||||
@PostMapping(value = "/validate", consumes = MediaType.MULTIPART_FORM_DATA_VALUE,
|
||||
produces = MediaType.APPLICATION_XML_VALUE)
|
||||
public ResponseEntity<String> validate(@RequestPart("file") MultipartFile file) throws IOException {
|
||||
ZugferdValidationService.ValidationResult result =
|
||||
validationService.validate(file.getBytes(), file.getOriginalFilename());
|
||||
|
||||
HttpHeaders headers = new HttpHeaders();
|
||||
headers.setContentType(MediaType.APPLICATION_XML);
|
||||
headers.set(VALIDATION_HEADER, String.valueOf(result.valid()));
|
||||
return new ResponseEntity<>(result.reportXml(), headers,
|
||||
result.valid() ? HttpStatus.OK : HttpStatus.UNPROCESSABLE_ENTITY);
|
||||
}
|
||||
|
||||
private InvoiceMetadata parseAndValidate(String metadataJson) {
|
||||
InvoiceMetadata metadata;
|
||||
try {
|
||||
metadata = objectMapper.readValue(metadataJson, InvoiceMetadata.class);
|
||||
} catch (IOException e) {
|
||||
throw new ZugferdConversionException("Metadaten sind kein gültiges JSON: " + e.getMessage(), e);
|
||||
}
|
||||
Set<ConstraintViolation<InvoiceMetadata>> violations = validator.validate(metadata);
|
||||
if (!violations.isEmpty()) {
|
||||
String details = violations.stream()
|
||||
.map(v -> v.getPropertyPath() + ": " + v.getMessage())
|
||||
.sorted()
|
||||
.collect(Collectors.joining("; "));
|
||||
throw new ZugferdConversionException("Metadaten unvollständig: " + details);
|
||||
}
|
||||
return metadata;
|
||||
}
|
||||
|
||||
@ExceptionHandler(ZugferdConversionException.class)
|
||||
public ResponseEntity<Map<String, String>> handleConversionError(ZugferdConversionException e) {
|
||||
return ResponseEntity.badRequest().body(Map.of("error", e.getMessage()));
|
||||
}
|
||||
}
|
||||
@@ -27,6 +27,7 @@ public record InvoiceDraft(
|
||||
String buyerReference,
|
||||
String iban,
|
||||
String bic,
|
||||
String website,
|
||||
InvoiceMetadata.Party sender,
|
||||
InvoiceMetadata.Party recipient,
|
||||
List<InvoiceMetadata.LineItem> items,
|
||||
|
||||
@@ -36,6 +36,11 @@ public class InvoiceDraftService {
|
||||
return repository.existsByName(name);
|
||||
}
|
||||
|
||||
/** Löscht die unter dem Namen gespeicherten Eingaben; ohne Treffer passiert nichts. */
|
||||
public void delete(String name) {
|
||||
repository.findByName(name).ifPresent(existing -> repository.deleteById(existing.id()));
|
||||
}
|
||||
|
||||
/** @return die Namen aller gespeicherten Eingaben, alphabetisch sortiert. */
|
||||
public List<String> names() {
|
||||
return repository.findAll().stream()
|
||||
|
||||
@@ -0,0 +1,136 @@
|
||||
package de.assecutor.pdftool.pdfservice;
|
||||
|
||||
import com.fasterxml.jackson.databind.ObjectMapper;
|
||||
import de.assecutor.pdftool.invoice.InvoiceMetadata;
|
||||
import org.springframework.beans.factory.annotation.Value;
|
||||
import org.springframework.core.io.ByteArrayResource;
|
||||
import org.springframework.http.ContentDisposition;
|
||||
import org.springframework.http.HttpEntity;
|
||||
import org.springframework.http.HttpHeaders;
|
||||
import org.springframework.http.HttpStatus;
|
||||
import org.springframework.http.MediaType;
|
||||
import org.springframework.http.ResponseEntity;
|
||||
import org.springframework.http.client.SimpleClientHttpRequestFactory;
|
||||
import org.springframework.stereotype.Service;
|
||||
import org.springframework.util.LinkedMultiValueMap;
|
||||
import org.springframework.util.MultiValueMap;
|
||||
import org.springframework.web.client.ResourceAccessException;
|
||||
import org.springframework.web.client.RestClient;
|
||||
|
||||
import java.nio.charset.StandardCharsets;
|
||||
import java.time.Duration;
|
||||
import java.util.Map;
|
||||
|
||||
/**
|
||||
* Client für die REST-API des PDF Service (eigenständiges Projekt), der aus
|
||||
* einem Rechnungs-PDF und den Metadaten die ZUGFeRD-E-Rechnung als ZIP erzeugt
|
||||
* ({@code POST {pdfservice.url}/invoices/sign}, Standard-Basis
|
||||
* {@code http://localhost:8084/api/v1}).
|
||||
*/
|
||||
@Service
|
||||
public class PdfServiceClient {
|
||||
|
||||
/** Response-Header des PDF Service mit dem Ergebnis der Mustang-Validierung. */
|
||||
private static final String VALIDATION_HEADER = "X-Zugferd-Valid";
|
||||
|
||||
private final RestClient restClient;
|
||||
private final ObjectMapper objectMapper;
|
||||
private final String baseUrl;
|
||||
|
||||
/** Ergebnis der Umwandlung: das ZIP, sein Dateiname und das Validierungsergebnis. */
|
||||
public record SignResult(byte[] zip, String zipFileName, boolean valid) {
|
||||
}
|
||||
|
||||
public PdfServiceClient(ObjectMapper objectMapper,
|
||||
@Value("${pdfservice.url:http://localhost:8084/api/v1}") String baseUrl) {
|
||||
this.objectMapper = objectMapper;
|
||||
this.baseUrl = baseUrl;
|
||||
SimpleClientHttpRequestFactory requestFactory = new SimpleClientHttpRequestFactory();
|
||||
requestFactory.setConnectTimeout(Duration.ofSeconds(5));
|
||||
// Die Umwandlung (PDF/A-Konvertierung + Validierung) kann einige Sekunden dauern
|
||||
requestFactory.setReadTimeout(Duration.ofSeconds(120));
|
||||
this.restClient = RestClient.builder()
|
||||
.baseUrl(baseUrl)
|
||||
.requestFactory(requestFactory)
|
||||
.build();
|
||||
}
|
||||
|
||||
/**
|
||||
* Wandelt das PDF über den PDF Service in eine ZUGFeRD-E-Rechnung um. Das
|
||||
* ZIP wird auch bei fehlgeschlagener Validierung (HTTP 422) geliefert;
|
||||
* {@link SignResult#valid()} meldet das Ergebnis.
|
||||
*
|
||||
* @throws PdfServiceException wenn der Service nicht erreichbar ist oder
|
||||
* die Anfrage ablehnt (z. B. HTTP 400)
|
||||
*/
|
||||
public SignResult sign(byte[] pdf, InvoiceMetadata metadata) {
|
||||
String metadataJson;
|
||||
try {
|
||||
metadataJson = objectMapper.writeValueAsString(metadata);
|
||||
} catch (Exception e) {
|
||||
throw new PdfServiceException("Die Rechnungsdaten konnten nicht serialisiert werden: "
|
||||
+ e.getMessage(), e);
|
||||
}
|
||||
|
||||
MultiValueMap<String, Object> parts = new LinkedMultiValueMap<>();
|
||||
parts.add("file", new ByteArrayResource(pdf) {
|
||||
@Override
|
||||
public String getFilename() {
|
||||
return "rechnung.pdf";
|
||||
}
|
||||
});
|
||||
HttpHeaders metadataHeaders = new HttpHeaders();
|
||||
metadataHeaders.setContentType(MediaType.APPLICATION_JSON);
|
||||
parts.add("metadata", new HttpEntity<>(metadataJson, metadataHeaders));
|
||||
|
||||
ResponseEntity<byte[]> response;
|
||||
try {
|
||||
response = restClient.post()
|
||||
.uri("/invoices/sign")
|
||||
.contentType(MediaType.MULTIPART_FORM_DATA)
|
||||
.body(parts)
|
||||
.retrieve()
|
||||
// 422 = ungültige Rechnung, das ZIP kommt trotzdem mit
|
||||
.onStatus(status -> status == HttpStatus.UNPROCESSABLE_ENTITY, (request, res) -> {
|
||||
})
|
||||
.onStatus(org.springframework.http.HttpStatusCode::isError, (request, res) -> {
|
||||
throw new PdfServiceException(errorMessage(res.getStatusCode().value(),
|
||||
new String(res.getBody().readAllBytes(), StandardCharsets.UTF_8)));
|
||||
})
|
||||
.toEntity(byte[].class);
|
||||
} catch (ResourceAccessException e) {
|
||||
throw new PdfServiceException("Der PDF Service ist nicht erreichbar (" + baseUrl + "): "
|
||||
+ e.getMessage(), e);
|
||||
}
|
||||
|
||||
byte[] zip = response.getBody();
|
||||
if (zip == null || zip.length == 0) {
|
||||
throw new PdfServiceException("Der PDF Service hat ein leeres ZIP geliefert.");
|
||||
}
|
||||
boolean valid = Boolean.parseBoolean(response.getHeaders().getFirst(VALIDATION_HEADER));
|
||||
return new SignResult(zip, zipFileName(response.getHeaders(), metadata), valid);
|
||||
}
|
||||
|
||||
/** Dateiname aus dem Content-Disposition-Header, sonst aus der Rechnungsnummer. */
|
||||
private static String zipFileName(HttpHeaders headers, InvoiceMetadata metadata) {
|
||||
ContentDisposition disposition = headers.getContentDisposition();
|
||||
if (disposition.getFilename() != null && !disposition.getFilename().isBlank()) {
|
||||
return disposition.getFilename();
|
||||
}
|
||||
return metadata.invoiceNumber() + "-zugferd.zip";
|
||||
}
|
||||
|
||||
/** Fehlermeldung aus dem JSON-Body ({@code {"error": "..."}}) des PDF Service. */
|
||||
private String errorMessage(int status, String body) {
|
||||
try {
|
||||
Map<?, ?> json = objectMapper.readValue(body, Map.class);
|
||||
Object error = json.get("error");
|
||||
if (error != null) {
|
||||
return "Der PDF Service hat die Anfrage abgelehnt: " + error;
|
||||
}
|
||||
} catch (Exception ignored) {
|
||||
// Body war kein JSON — Rohtext verwenden
|
||||
}
|
||||
return "Der PDF Service hat die Anfrage abgelehnt (HTTP " + status + "): " + body;
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,13 @@
|
||||
package de.assecutor.pdftool.pdfservice;
|
||||
|
||||
/** Fehler beim Aufruf des PDF Service (nicht erreichbar oder Ablehnung der Anfrage). */
|
||||
public class PdfServiceException extends RuntimeException {
|
||||
|
||||
public PdfServiceException(String message) {
|
||||
super(message);
|
||||
}
|
||||
|
||||
public PdfServiceException(String message, Throwable cause) {
|
||||
super(message, cause);
|
||||
}
|
||||
}
|
||||
@@ -165,7 +165,10 @@ public class TemplatePdfService {
|
||||
if ("services.list".equals(variable)) {
|
||||
htmlBuilder.append("display:block;overflow:visible;padding:0;");
|
||||
} else {
|
||||
htmlBuilder.append("display:flex;align-items:center;");
|
||||
// Oben ausrichten statt zentrieren: Die erste Zeile muss an der
|
||||
// Box-Oberkante beginnen, sonst verschiebt sich mehrzeiliger
|
||||
// Variablentext gegenüber einzeiligen Nachbar-Elementen.
|
||||
htmlBuilder.append("display:flex;align-items:flex-start;");
|
||||
switch (textAlign) {
|
||||
case "center":
|
||||
htmlBuilder.append("justify-content:center;text-align:center;");
|
||||
|
||||
@@ -85,6 +85,8 @@ public class AddressBookView extends VerticalLayout {
|
||||
.setAutoWidth(true);
|
||||
grid.addColumn(address -> address.getName()).setHeader("Firma / Name").setSortable(true).setAutoWidth(true);
|
||||
grid.addColumn(address -> address.getStreet()).setHeader("Straße").setAutoWidth(true);
|
||||
// Feste Breite statt AutoWidth: Vaadin misst Komponentenspalten vor dem
|
||||
// Rendern der Buttons, dadurch würden die Icons rechts abgeschnitten.
|
||||
grid.addComponentColumn(address -> {
|
||||
Button edit = new Button(new Icon(VaadinIcon.EDIT), event -> openEditDialog(address));
|
||||
edit.addThemeVariants(ButtonVariant.LUMO_TERTIARY, ButtonVariant.LUMO_SMALL);
|
||||
@@ -93,8 +95,11 @@ public class AddressBookView extends VerticalLayout {
|
||||
delete.addThemeVariants(ButtonVariant.LUMO_TERTIARY, ButtonVariant.LUMO_ERROR,
|
||||
ButtonVariant.LUMO_SMALL);
|
||||
delete.setTooltipText("Löschen");
|
||||
return new HorizontalLayout(edit, delete);
|
||||
}).setHeader("").setFlexGrow(0).setAutoWidth(true);
|
||||
HorizontalLayout actions = new HorizontalLayout(edit, delete);
|
||||
actions.setSpacing(false);
|
||||
actions.setPadding(false);
|
||||
return actions;
|
||||
}).setHeader("").setFlexGrow(0).setWidth("110px");
|
||||
grid.addItemDoubleClickListener(event -> openEditDialog(event.getItem()));
|
||||
grid.setSizeFull();
|
||||
add(grid);
|
||||
@@ -142,7 +147,6 @@ public class AddressBookView extends VerticalLayout {
|
||||
countryCode.setPattern("[A-Za-z]{2}");
|
||||
TextField vatId = new TextField("USt-IdNr.");
|
||||
vatId.setValue(target.getVatId() != null ? target.getVatId() : "");
|
||||
vatId.setHelperText("z. B. DE261094748");
|
||||
EmailField email = new EmailField("E-Mail");
|
||||
email.setValue(target.getEmail() != null ? target.getEmail() : "");
|
||||
// E-Mail direkt beim Verlassen des Feldes prüfen
|
||||
@@ -154,18 +158,19 @@ public class AddressBookView extends VerticalLayout {
|
||||
});
|
||||
TextField phone = new TextField("Telefon");
|
||||
phone.setValue(target.getPhone() != null ? target.getPhone() : "");
|
||||
TextField website = new TextField("Webseite");
|
||||
website.setValue(target.getWebsite() != null ? target.getWebsite() : "");
|
||||
|
||||
// Bankverbindung (optional)
|
||||
TextField bankName = new TextField("Bank");
|
||||
bankName.setValue(target.getBankName() != null ? target.getBankName() : "");
|
||||
TextField iban = new TextField("IBAN");
|
||||
iban.setValue(target.getIban() != null ? target.getIban() : "");
|
||||
iban.setHelperText("z. B. DE02 1203 0000 0000 2020 51");
|
||||
TextField bic = new TextField("BIC");
|
||||
bic.setValue(target.getBic() != null ? target.getBic() : "");
|
||||
|
||||
FormLayout form = new FormLayout(type, name, street, zip, city, countryCode, vatId, email, phone,
|
||||
bankName, iban, bic);
|
||||
website, bankName, iban, bic);
|
||||
form.setResponsiveSteps(new FormLayout.ResponsiveStep("0", 1), new FormLayout.ResponsiveStep("500px", 2));
|
||||
form.setWidth("560px");
|
||||
dialog.add(form);
|
||||
@@ -226,6 +231,7 @@ public class AddressBookView extends VerticalLayout {
|
||||
target.setVatId(vatId.getValue().isBlank() ? "" : VatIdValidator.normalize(vatId.getValue()));
|
||||
target.setEmail(email.getValue().trim());
|
||||
target.setPhone(phone.getValue().trim());
|
||||
target.setWebsite(website.getValue().trim());
|
||||
target.setBankName(bankName.getValue().trim());
|
||||
target.setIban(iban.getValue().isBlank() ? "" : IbanValidator.normalize(iban.getValue()));
|
||||
target.setBic(bic.getValue().trim().toUpperCase());
|
||||
|
||||
@@ -13,6 +13,7 @@ import com.vaadin.flow.component.html.Anchor;
|
||||
import com.vaadin.flow.component.html.Div;
|
||||
import com.vaadin.flow.component.html.H3;
|
||||
import com.vaadin.flow.component.html.Paragraph;
|
||||
import com.vaadin.flow.component.html.Span;
|
||||
import com.vaadin.flow.component.icon.Icon;
|
||||
import com.vaadin.flow.component.icon.VaadinIcon;
|
||||
import com.vaadin.flow.component.notification.Notification;
|
||||
@@ -22,8 +23,7 @@ import com.vaadin.flow.component.orderedlayout.VerticalLayout;
|
||||
import com.vaadin.flow.component.textfield.BigDecimalField;
|
||||
import com.vaadin.flow.component.textfield.EmailField;
|
||||
import com.vaadin.flow.component.textfield.TextField;
|
||||
import com.vaadin.flow.component.upload.Upload;
|
||||
import com.vaadin.flow.component.upload.receivers.MemoryBuffer;
|
||||
import com.vaadin.flow.data.renderer.ComponentRenderer;
|
||||
import com.vaadin.flow.router.PageTitle;
|
||||
import com.vaadin.flow.router.Route;
|
||||
import com.vaadin.flow.server.StreamResource;
|
||||
@@ -40,13 +40,10 @@ import de.assecutor.pdftool.template.InvoiceTemplateService;
|
||||
import de.assecutor.pdftool.template.TemplatePdfService;
|
||||
import de.assecutor.pdftool.template.TemplateRenderException;
|
||||
import de.assecutor.pdftool.template.TemplateVariables;
|
||||
import de.assecutor.pdftool.zugferd.ZugferdConversionException;
|
||||
import de.assecutor.pdftool.zugferd.ZugferdResult;
|
||||
import de.assecutor.pdftool.zugferd.ZugferdService;
|
||||
import de.assecutor.pdftool.pdfservice.PdfServiceClient;
|
||||
import de.assecutor.pdftool.pdfservice.PdfServiceException;
|
||||
|
||||
import java.io.ByteArrayInputStream;
|
||||
import java.io.IOException;
|
||||
import java.io.UncheckedIOException;
|
||||
import java.math.BigDecimal;
|
||||
import java.text.NumberFormat;
|
||||
import java.time.LocalDate;
|
||||
@@ -65,15 +62,12 @@ public class MainView extends VerticalLayout {
|
||||
|
||||
private static final BigDecimal MAX_VAT_PERCENT = new BigDecimal("100");
|
||||
|
||||
private final ZugferdService zugferdService;
|
||||
private final PdfServiceClient pdfServiceClient;
|
||||
private final CapturedInvoiceData capturedInvoiceData;
|
||||
private final InvoiceTemplateService invoiceTemplateService;
|
||||
private final TemplatePdfService templatePdfService;
|
||||
|
||||
private final MemoryBuffer uploadBuffer = new MemoryBuffer();
|
||||
private byte[] uploadedPdf;
|
||||
|
||||
/** Alternative zum PDF-Upload: ein gespeichertes Rechnungstemplate. */
|
||||
/** Grundlage der Rechnung: ein gespeichertes Rechnungstemplate. */
|
||||
private final ComboBox<String> templateSelect = new ComboBox<>("Rechnungstemplate");
|
||||
|
||||
/** Vorbelegung der Rechnungssteller-Felder aus dem Adressbuch. */
|
||||
@@ -117,15 +111,15 @@ public class MainView extends VerticalLayout {
|
||||
private final Anchor downloadLink = new Anchor();
|
||||
|
||||
/**
|
||||
* Alle Controls unterhalb der Quellenwahl; sie sind erst aktiv, wenn ein PDF
|
||||
* hochgeladen oder ein Template ausgewählt wurde.
|
||||
* Alle Controls unterhalb der Template-Auswahl; sie sind erst aktiv, wenn
|
||||
* ein Template ausgewählt wurde.
|
||||
*/
|
||||
private final List<com.vaadin.flow.component.HasEnabled> sourceDependentControls = new ArrayList<>();
|
||||
|
||||
public MainView(ZugferdService zugferdService, CapturedInvoiceData capturedInvoiceData,
|
||||
public MainView(PdfServiceClient pdfServiceClient, CapturedInvoiceData capturedInvoiceData,
|
||||
InvoiceTemplateService invoiceTemplateService, TemplatePdfService templatePdfService,
|
||||
AddressRepository addressRepository, InvoiceDraftService invoiceDraftService) {
|
||||
this.zugferdService = zugferdService;
|
||||
this.pdfServiceClient = pdfServiceClient;
|
||||
this.capturedInvoiceData = capturedInvoiceData;
|
||||
this.invoiceTemplateService = invoiceTemplateService;
|
||||
this.templatePdfService = templatePdfService;
|
||||
@@ -134,15 +128,33 @@ public class MainView extends VerticalLayout {
|
||||
|
||||
setMaxWidth("960px");
|
||||
|
||||
add(new Paragraph("Laden Sie ein Rechnungs-PDF hoch oder wählen Sie ein gespeichertes "
|
||||
+ "Rechnungstemplate und ergänzen Sie die Rechnungsdaten. Die Rechnung wird als "
|
||||
+ "rechtskonforme ZUGFeRD-Rechnung (PDF/A-3 mit eingebettetem EN16931-XML) erzeugt "
|
||||
+ "und als ZIP-Datei bereitgestellt."));
|
||||
add(new Paragraph("Wählen Sie ein gespeichertes Rechnungstemplate und ergänzen Sie die "
|
||||
+ "Rechnungsdaten. Die Rechnung wird als rechtskonforme ZUGFeRD-Rechnung "
|
||||
+ "(PDF/A-3 mit eingebettetem EN16931-XML) erzeugt und als ZIP-Datei bereitgestellt."));
|
||||
|
||||
// Eingaben unter einem Namen speichern bzw. gespeicherte Eingaben laden.
|
||||
draftSelect.setPlaceholder("Vorbelegung laden");
|
||||
draftSelect.setClearButtonVisible(true);
|
||||
draftSelect.setWidth("300px");
|
||||
// Jeder Eintrag zeigt rechts ein Löschen-Icon, das die Vorbelegung
|
||||
// nach einer Sicherheitsabfrage aus MongoDB entfernt.
|
||||
draftSelect.setRenderer(new ComponentRenderer<>(name -> {
|
||||
Span label = new Span(name);
|
||||
Icon delete = VaadinIcon.TRASH.create();
|
||||
delete.setSize("var(--lumo-icon-size-s)");
|
||||
delete.getStyle().set("color", "var(--lumo-error-color)").set("cursor", "pointer");
|
||||
delete.getElement().setAttribute("title", "Vorbelegung löschen");
|
||||
// Der Klick auf das Icon darf den Eintrag nicht auswählen; der
|
||||
// Server-Listener auf dem Icon selbst wird davon nicht berührt.
|
||||
delete.getElement().executeJs("this.addEventListener('click', function(e) { e.stopPropagation(); })");
|
||||
delete.getElement().addEventListener("click", e -> confirmDeleteDraft(name));
|
||||
HorizontalLayout row = new HorizontalLayout(label, delete);
|
||||
row.setJustifyContentMode(JustifyContentMode.BETWEEN);
|
||||
row.setAlignItems(Alignment.CENTER);
|
||||
row.setWidthFull();
|
||||
row.setPadding(false);
|
||||
return row;
|
||||
}));
|
||||
draftSelect.addValueChangeListener(event -> {
|
||||
if (event.isFromClient() && event.getValue() != null) {
|
||||
loadDraft(event.getValue());
|
||||
@@ -153,46 +165,24 @@ public class MainView extends VerticalLayout {
|
||||
});
|
||||
add(draftSelect);
|
||||
|
||||
Upload upload = new Upload(uploadBuffer);
|
||||
upload.setAcceptedFileTypes("application/pdf", ".pdf");
|
||||
upload.setMaxFiles(1);
|
||||
upload.setMaxFileSize(25 * 1024 * 1024);
|
||||
upload.addSucceededListener(event -> {
|
||||
try {
|
||||
uploadedPdf = uploadBuffer.getInputStream().readAllBytes();
|
||||
} catch (IOException e) {
|
||||
throw new UncheckedIOException(e);
|
||||
}
|
||||
// Entweder PDF oder Template: hochgeladenes PDF hebt die Template-Auswahl auf.
|
||||
templateSelect.clear();
|
||||
updateControlsEnabled();
|
||||
});
|
||||
upload.addFileRemovedListener(event -> {
|
||||
uploadedPdf = null;
|
||||
updateControlsEnabled();
|
||||
});
|
||||
|
||||
templateSelect.setItems(invoiceTemplateService.templateNames());
|
||||
templateSelect.setPlaceholder("Template auswählen");
|
||||
templateSelect.setClearButtonVisible(true);
|
||||
templateSelect.setWidth("300px");
|
||||
templateSelect.addValueChangeListener(event -> {
|
||||
if (event.isFromClient() && event.getValue() != null) {
|
||||
// Entweder PDF oder Template: Auswahl entfernt ein hochgeladenes PDF.
|
||||
upload.clearFileList();
|
||||
uploadedPdf = null;
|
||||
// Rechnungssteller-Felder leer beginnen lassen.
|
||||
// Rechnungssteller-Felder nur bei der ersten Template-Auswahl
|
||||
// leer beginnen lassen; beim Wechsel zwischen Templates bleiben
|
||||
// die Eingaben erhalten (sonst wäre u. a. der Speichern-Button
|
||||
// wegen leerer Pflichtfelder nie aktiv).
|
||||
if (event.getOldValue() == null) {
|
||||
senderAddressSelect.clear();
|
||||
sender.clearFields();
|
||||
}
|
||||
}
|
||||
updateControlsEnabled();
|
||||
});
|
||||
HorizontalLayout sourceLayout = new HorizontalLayout(upload, templateSelect);
|
||||
sourceLayout.setAlignItems(Alignment.CENTER);
|
||||
// Das Label der ComboBox ausgleichen, damit das Eingabefeld selbst
|
||||
// mittig zur Upload-Fläche steht.
|
||||
templateSelect.getStyle().set("margin-top", "-1.25em");
|
||||
add(new H3("1. Rechnungs-PDF hochladen oder Template auswählen"), sourceLayout);
|
||||
add(new H3("1. Template auswählen"), templateSelect);
|
||||
|
||||
invoiceNumber.setRequired(true);
|
||||
invoiceNumber.setErrorMessage("Rechnungsnummer ist ein Pflichtfeld.");
|
||||
@@ -226,8 +216,11 @@ public class MainView extends VerticalLayout {
|
||||
recipientAddressSelect, recipient, itemsGrid, addItem, generate));
|
||||
updateControlsEnabled();
|
||||
|
||||
// Unsichtbarer Anchor: dient nur als Träger für den automatischen
|
||||
// Download nach dem Erzeugen (display:none statt setVisible, damit
|
||||
// callJsFunction("click") den Klick sofort ausführen kann).
|
||||
downloadLink.getElement().setAttribute("download", true);
|
||||
downloadLink.setVisible(false);
|
||||
downloadLink.getStyle().set("display", "none");
|
||||
|
||||
add(new HorizontalLayout(generate, saveDraftButton, downloadLink));
|
||||
|
||||
@@ -290,6 +283,39 @@ public class MainView extends VerticalLayout {
|
||||
confirm.open();
|
||||
}
|
||||
|
||||
/** Sicherheitsabfrage vor dem endgültigen Löschen einer Vorbelegung. */
|
||||
private void confirmDeleteDraft(String name) {
|
||||
ConfirmDialog confirm = new ConfirmDialog();
|
||||
confirm.setHeader("Vorbelegung löschen?");
|
||||
confirm.setText("Sollen die gespeicherten Eingaben \"" + name + "\" endgültig gelöscht werden?");
|
||||
confirm.setConfirmText("Löschen");
|
||||
confirm.setConfirmButtonTheme("error primary");
|
||||
confirm.setCancelable(true);
|
||||
confirm.setCancelText("Abbrechen");
|
||||
confirm.addConfirmListener(event -> deleteDraft(name));
|
||||
confirm.open();
|
||||
}
|
||||
|
||||
private void deleteDraft(String name) {
|
||||
try {
|
||||
invoiceDraftService.delete(name);
|
||||
} catch (Exception ex) {
|
||||
showErrors(List.of("Die Vorbelegung \"" + name + "\" konnte nicht gelöscht werden: " + ex.getMessage()));
|
||||
return;
|
||||
}
|
||||
boolean wasSelected = name.equals(draftSelect.getValue());
|
||||
draftSelect.setItems(invoiceDraftService.names());
|
||||
if (wasSelected) {
|
||||
// Die geladene Vorbelegung existiert nicht mehr; das Formular
|
||||
// behält seine Werte, gilt aber wieder als ungespeichert.
|
||||
draftSelect.clear();
|
||||
loadedDraftState = null;
|
||||
updateSaveDraftEnabled();
|
||||
}
|
||||
Notification.show("Vorbelegung \"" + name + "\" gelöscht.", 3000, Notification.Position.BOTTOM_START)
|
||||
.addThemeVariants(NotificationVariant.LUMO_SUCCESS);
|
||||
}
|
||||
|
||||
private void saveDraft(String name) {
|
||||
try {
|
||||
invoiceDraftService.save(buildDraft(name));
|
||||
@@ -306,7 +332,7 @@ public class MainView extends VerticalLayout {
|
||||
.addThemeVariants(NotificationVariant.LUMO_SUCCESS);
|
||||
}
|
||||
|
||||
/** Sammelt den aktuellen Formularstand; ein hochgeladenes PDF wird nicht mitgespeichert. */
|
||||
/** Sammelt den aktuellen Formularstand. */
|
||||
private InvoiceDraft buildDraft(String name) {
|
||||
return new InvoiceDraft(null, name,
|
||||
templateSelect.getValue(),
|
||||
@@ -317,6 +343,7 @@ public class MainView extends VerticalLayout {
|
||||
"",
|
||||
sender.ibanNormalized(),
|
||||
sender.bicNormalized(),
|
||||
sender.websiteValue(),
|
||||
sender.toParty(), recipient.toParty(),
|
||||
List.copyOf(lineItems),
|
||||
LocalDateTime.now());
|
||||
@@ -335,8 +362,7 @@ public class MainView extends VerticalLayout {
|
||||
|
||||
/** Überträgt gespeicherte Eingaben in das Formular. */
|
||||
private void applyDraft(InvoiceDraft draft) {
|
||||
// Die Template-Auswahl wiederherstellen, sofern das Template noch existiert;
|
||||
// ein hochgeladenes PDF ist nicht Teil der gespeicherten Eingaben.
|
||||
// Die Template-Auswahl wiederherstellen, sofern das Template noch existiert.
|
||||
if (draft.templateName() != null && !draft.templateName().isBlank()
|
||||
&& invoiceTemplateService.templateExists(draft.templateName())) {
|
||||
templateSelect.setValue(draft.templateName());
|
||||
@@ -348,6 +374,8 @@ public class MainView extends VerticalLayout {
|
||||
currency.setValue(nullToEmpty(draft.currency()));
|
||||
paymentTerms.setValue(nullToEmpty(draft.paymentTerms()));
|
||||
applyParty(sender, draft.sender());
|
||||
sender.prefillContact(draft.sender() != null ? nullToEmpty(draft.sender().phone()) : "",
|
||||
nullToEmpty(draft.website()));
|
||||
sender.prefillBank(nullToEmpty(draft.iban()), nullToEmpty(draft.bic()));
|
||||
applyParty(recipient, draft.recipient());
|
||||
lineItems.clear();
|
||||
@@ -385,6 +413,7 @@ public class MainView extends VerticalLayout {
|
||||
nullToEmpty(address.getZip()), nullToEmpty(address.getCity()),
|
||||
nullToEmpty(address.getCountryCode()), nullToEmpty(address.getVatId()),
|
||||
nullToEmpty(address.getEmail()));
|
||||
form.prefillContact(nullToEmpty(address.getPhone()), nullToEmpty(address.getWebsite()));
|
||||
form.prefillBank(nullToEmpty(address.getIban()), nullToEmpty(address.getBic()));
|
||||
}
|
||||
});
|
||||
@@ -412,6 +441,8 @@ public class MainView extends VerticalLayout {
|
||||
.setTextAlign(ColumnTextAlign.END).setAutoWidth(true).setFlexGrow(0);
|
||||
itemsGrid.addColumn(item -> formatDecimal(item.vatPercent())).setHeader("USt %")
|
||||
.setTextAlign(ColumnTextAlign.END).setAutoWidth(true).setFlexGrow(0);
|
||||
// Feste Breite statt AutoWidth: Vaadin misst Komponentenspalten vor dem
|
||||
// Rendern der Buttons, dadurch würden die Icons rechts abgeschnitten.
|
||||
itemsGrid.addComponentColumn(item -> {
|
||||
Button edit = new Button(new Icon(VaadinIcon.EDIT), event -> openItemDialog(item));
|
||||
edit.addThemeVariants(ButtonVariant.LUMO_TERTIARY, ButtonVariant.LUMO_SMALL);
|
||||
@@ -423,8 +454,11 @@ public class MainView extends VerticalLayout {
|
||||
delete.addThemeVariants(ButtonVariant.LUMO_TERTIARY, ButtonVariant.LUMO_ERROR,
|
||||
ButtonVariant.LUMO_SMALL);
|
||||
delete.setTooltipText("Löschen");
|
||||
return new HorizontalLayout(edit, delete);
|
||||
}).setHeader("").setAutoWidth(true).setFlexGrow(0);
|
||||
HorizontalLayout actions = new HorizontalLayout(edit, delete);
|
||||
actions.setSpacing(false);
|
||||
actions.setPadding(false);
|
||||
return actions;
|
||||
}).setHeader("").setWidth("110px").setFlexGrow(0);
|
||||
itemsGrid.addItemDoubleClickListener(event -> openItemDialog(event.getItem()));
|
||||
itemsGrid.setAllRowsVisible(true);
|
||||
itemsGrid.setWidthFull();
|
||||
@@ -478,6 +512,7 @@ public class MainView extends VerticalLayout {
|
||||
"",
|
||||
sender.ibanNormalized(),
|
||||
sender.bicNormalized(),
|
||||
sender.websiteValue(),
|
||||
sender.toParty(), recipient.toParty(),
|
||||
List.copyOf(lineItems),
|
||||
null);
|
||||
@@ -553,24 +588,19 @@ public class MainView extends VerticalLayout {
|
||||
|
||||
/**
|
||||
* Das Rechnungsformular und der Erzeugen-Button sind nur aktiv, wenn ein
|
||||
* PDF hochgeladen oder ein Template ausgewählt wurde.
|
||||
* Template ausgewählt wurde.
|
||||
*/
|
||||
private void updateControlsEnabled() {
|
||||
boolean sourceSelected = uploadedPdf != null || templateSelect.getValue() != null;
|
||||
boolean sourceSelected = templateSelect.getValue() != null;
|
||||
sourceDependentControls.forEach(control -> control.setEnabled(sourceSelected));
|
||||
}
|
||||
|
||||
private void generate() {
|
||||
downloadLink.setVisible(false);
|
||||
List<String> errors = validateForm();
|
||||
if (!errors.isEmpty()) {
|
||||
showErrors(errors);
|
||||
return;
|
||||
}
|
||||
if (uploadedPdf != null) {
|
||||
convertAndOfferDownload(uploadedPdf);
|
||||
return;
|
||||
}
|
||||
String templateName = templateSelect.getValue();
|
||||
Optional<String> templateData = invoiceTemplateService.loadTemplate(templateName);
|
||||
if (templateData.isEmpty()) {
|
||||
@@ -595,12 +625,20 @@ public class MainView extends VerticalLayout {
|
||||
private Map<String, String> buildTemplateVariables(InvoiceMetadata metadata) {
|
||||
Map<String, String> variables = new LinkedHashMap<>();
|
||||
InvoiceMetadata.Party senderParty = metadata.sender();
|
||||
// Telefon und Webseite kommen aus den Formularfeldern des
|
||||
// Rechnungsstellers; sind sie leer (z. B. alte Vorbelegung), springt
|
||||
// der Adressbuch-Eintrag des Rechnungsstellers ein.
|
||||
Optional<Address> senderAddress = findSenderAddress(senderParty.name());
|
||||
String phone = !senderParty.phone().isBlank() ? senderParty.phone()
|
||||
: senderAddress.map(address -> nullToEmpty(address.getPhone())).orElse("");
|
||||
String website = !sender.websiteValue().isBlank() ? sender.websiteValue()
|
||||
: senderAddress.map(address -> nullToEmpty(address.getWebsite())).orElse("");
|
||||
variables.put("masterdata.company_name", senderParty.name());
|
||||
variables.put("masterdata.street", senderParty.street());
|
||||
variables.put("masterdata.city", senderParty.zip() + " " + senderParty.city());
|
||||
variables.put("masterdata.phone", senderParty.phone());
|
||||
variables.put("masterdata.phone", phone);
|
||||
variables.put("masterdata.email", senderParty.email());
|
||||
variables.put("masterdata.website", "");
|
||||
variables.put("masterdata.website", website);
|
||||
variables.put("masterdata.sender_line",
|
||||
senderParty.name() + " · " + senderParty.street() + " · " + senderParty.zip() + " " + senderParty.city());
|
||||
variables.put("masterdata.payment_terms", metadata.paymentTerms());
|
||||
@@ -631,31 +669,46 @@ public class MainView extends VerticalLayout {
|
||||
return variables;
|
||||
}
|
||||
|
||||
/** Wandelt das Quell-PDF in die ZUGFeRD-E-Rechnung um und bietet das ZIP zum Download an. */
|
||||
/**
|
||||
* @return der Adressbuch-Eintrag des Rechnungsstellers: die Auswahl in
|
||||
* "Aus dem Adressbuch übernehmen", sonst der Namenstreffer unter
|
||||
* den Rechnungssteller-Adressen (z. B. nach Laden einer Vorbelegung).
|
||||
*/
|
||||
private Optional<Address> findSenderAddress(String senderName) {
|
||||
Address selected = senderAddressSelect.getValue();
|
||||
if (selected != null) {
|
||||
return Optional.of(selected);
|
||||
}
|
||||
String normalized = senderName == null ? "" : senderName.trim();
|
||||
return addressRepository.findByType(AddressType.RECHNUNGSSTELLER).stream()
|
||||
.filter(address -> normalized.equalsIgnoreCase(nullToEmpty(address.getName()).trim()))
|
||||
.findFirst();
|
||||
}
|
||||
|
||||
/** Wandelt das Quell-PDF über den PDF Service in die ZUGFeRD-E-Rechnung um und bietet das ZIP zum Download an. */
|
||||
private void convertAndOfferDownload(byte[] sourcePdf) {
|
||||
try {
|
||||
InvoiceMetadata metadata = collectMetadata();
|
||||
capturedInvoiceData.setItems(metadata.items());
|
||||
ZugferdResult result = zugferdService.createZugferdZip(sourcePdf, metadata);
|
||||
PdfServiceClient.SignResult result = pdfServiceClient.sign(sourcePdf, metadata);
|
||||
|
||||
StreamResource resource = new StreamResource(result.zipFileName(),
|
||||
() -> new ByteArrayInputStream(result.zip()));
|
||||
resource.setContentType("application/zip");
|
||||
downloadLink.setHref(resource);
|
||||
downloadLink.setText("ZIP herunterladen (" + result.zipFileName() + ")");
|
||||
downloadLink.setVisible(true);
|
||||
|
||||
if (result.valid()) {
|
||||
Notification.show("E-Rechnung erzeugt und erfolgreich validiert.", 4000,
|
||||
Notification.Position.BOTTOM_START)
|
||||
.addThemeVariants(NotificationVariant.LUMO_SUCCESS);
|
||||
downloadLink.getElement().callJsFunction("click");
|
||||
} else {
|
||||
Notification.show("E-Rechnung erzeugt, aber die Validierung meldet Probleme. "
|
||||
+ "Details stehen im Prüfbericht (validation-report.xml) im ZIP.", 8000,
|
||||
Notification.Position.MIDDLE)
|
||||
.addThemeVariants(NotificationVariant.LUMO_WARNING);
|
||||
}
|
||||
} catch (ZugferdConversionException e) {
|
||||
} catch (PdfServiceException e) {
|
||||
showErrors(List.of(e.getMessage()));
|
||||
}
|
||||
}
|
||||
@@ -758,6 +811,10 @@ public class MainView extends VerticalLayout {
|
||||
private final TextField vatId = new TextField("USt-IdNr.");
|
||||
private final EmailField email = new EmailField("E-Mail");
|
||||
|
||||
// Kontaktangaben; nur beim Rechnungssteller sichtbar und optional
|
||||
private final TextField phone = new TextField("Telefon");
|
||||
private final TextField website = new TextField("Webseite");
|
||||
|
||||
// Bankverbindung; nur beim Rechnungssteller sichtbar und Pflicht
|
||||
private final TextField iban = new TextField("IBAN");
|
||||
private final TextField bic = new TextField("BIC");
|
||||
@@ -774,7 +831,6 @@ public class MainView extends VerticalLayout {
|
||||
countryCode.setPattern("[A-Za-z]{2}");
|
||||
countryCode.setErrorMessage("Zweistelliger ISO-Code, z. B. DE.");
|
||||
vatId.setRequired(vatRequired);
|
||||
vatId.setHelperText("z. B. DE261094748");
|
||||
// USt-IdNr. direkt beim Verlassen des Feldes prüfen
|
||||
vatId.addValueChangeListener(event -> checkVatId());
|
||||
// Elektronische Adresse (BT-34/BT-49) ist nach PEPPOL-EN16931 Pflicht
|
||||
@@ -785,10 +841,8 @@ public class MainView extends VerticalLayout {
|
||||
add(name, street, zip, city, countryCode, vatId, email);
|
||||
if (vatRequired) {
|
||||
iban.setRequired(true);
|
||||
iban.setHelperText("Für die Zahlungsangaben (BG-16)");
|
||||
bic.setRequired(true);
|
||||
bic.setHelperText("8 oder 11 Stellen, z. B. NOLADE21RZB");
|
||||
add(iban, bic);
|
||||
add(phone, website, iban, bic);
|
||||
}
|
||||
setResponsiveSteps(new ResponsiveStep("0", 1), new ResponsiveStep("600px", 3));
|
||||
}
|
||||
@@ -799,6 +853,16 @@ public class MainView extends VerticalLayout {
|
||||
bic.setValue(bicValue);
|
||||
}
|
||||
|
||||
/** Belegt Telefon und Webseite vor, z. B. aus dem Adressbuch. */
|
||||
void prefillContact(String phoneValue, String websiteValue) {
|
||||
phone.setValue(phoneValue);
|
||||
website.setValue(websiteValue);
|
||||
}
|
||||
|
||||
String websiteValue() {
|
||||
return website.getValue().trim();
|
||||
}
|
||||
|
||||
/** IBAN ohne Leerzeichen in Großschreibung. */
|
||||
String ibanNormalized() {
|
||||
return iban.getValue().replaceAll("\\s", "").toUpperCase();
|
||||
@@ -841,6 +905,8 @@ public class MainView extends VerticalLayout {
|
||||
countryCode.addValueChangeListener(event -> listener.run());
|
||||
vatId.addValueChangeListener(event -> listener.run());
|
||||
email.addValueChangeListener(event -> listener.run());
|
||||
phone.addValueChangeListener(event -> listener.run());
|
||||
website.addValueChangeListener(event -> listener.run());
|
||||
iban.addValueChangeListener(event -> listener.run());
|
||||
bic.addValueChangeListener(event -> listener.run());
|
||||
}
|
||||
@@ -848,6 +914,7 @@ public class MainView extends VerticalLayout {
|
||||
/** Leert alle Felder; das Land behält den Standardwert "DE". */
|
||||
void clearFields() {
|
||||
prefill("", "", "", "", "DE", "", "");
|
||||
prefillContact("", "");
|
||||
prefillBank("", "");
|
||||
name.setInvalid(false);
|
||||
street.setInvalid(false);
|
||||
@@ -930,7 +997,7 @@ public class MainView extends VerticalLayout {
|
||||
countryCode.getValue().trim().toUpperCase(),
|
||||
vatId.isEmpty() ? "" : VatIdValidator.normalize(vatId.getValue()),
|
||||
email.getValue().trim(),
|
||||
""
|
||||
phone.getValue().trim()
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,12 +0,0 @@
|
||||
package de.assecutor.pdftool.zugferd;
|
||||
|
||||
public class ZugferdConversionException extends RuntimeException {
|
||||
|
||||
public ZugferdConversionException(String message) {
|
||||
super(message);
|
||||
}
|
||||
|
||||
public ZugferdConversionException(String message, Throwable cause) {
|
||||
super(message, cause);
|
||||
}
|
||||
}
|
||||
@@ -1,8 +0,0 @@
|
||||
package de.assecutor.pdftool.zugferd;
|
||||
|
||||
/**
|
||||
* Ergebnis einer ZUGFeRD-Konvertierung: die ZIP-Datei (ZUGFeRD-PDF, Factur-X-XML,
|
||||
* Prüfbericht) sowie das Ergebnis der Mustang-Validierung.
|
||||
*/
|
||||
public record ZugferdResult(byte[] zip, String zipFileName, boolean valid, String validationReport) {
|
||||
}
|
||||
@@ -1,242 +0,0 @@
|
||||
package de.assecutor.pdftool.zugferd;
|
||||
|
||||
import de.assecutor.pdftool.invoice.InvoiceMetadata;
|
||||
import org.apache.pdfbox.Loader;
|
||||
import org.apache.pdfbox.pdmodel.PDDocument;
|
||||
import org.apache.pdfbox.pdmodel.PDPage;
|
||||
import org.apache.pdfbox.pdmodel.PDResources;
|
||||
import org.mustangproject.BankDetails;
|
||||
import org.mustangproject.Contact;
|
||||
import org.mustangproject.Invoice;
|
||||
import org.mustangproject.Item;
|
||||
import org.mustangproject.Product;
|
||||
import org.mustangproject.SchemedID;
|
||||
import org.mustangproject.TradeParty;
|
||||
import org.mustangproject.ZUGFeRD.IZUGFeRDExporter;
|
||||
import org.mustangproject.ZUGFeRD.Profiles;
|
||||
import org.mustangproject.ZUGFeRD.ZUGFeRD2PullProvider;
|
||||
import org.mustangproject.ZUGFeRD.ZUGFeRDExporterFromA1;
|
||||
import org.mustangproject.ZUGFeRD.ZUGFeRDExporterFromPDFA;
|
||||
import org.slf4j.Logger;
|
||||
import org.slf4j.LoggerFactory;
|
||||
import org.springframework.stereotype.Service;
|
||||
|
||||
import java.io.ByteArrayInputStream;
|
||||
import java.io.ByteArrayOutputStream;
|
||||
import java.io.IOException;
|
||||
import java.nio.charset.StandardCharsets;
|
||||
import java.time.LocalDate;
|
||||
import java.time.ZoneId;
|
||||
import java.util.Date;
|
||||
import java.util.zip.ZipEntry;
|
||||
import java.util.zip.ZipOutputStream;
|
||||
|
||||
/**
|
||||
* Wandelt ein herkömmliches Rechnungs-PDF in eine rechtskonforme ZUGFeRD-Rechnung
|
||||
* (PDF/A-3 mit eingebettetem EN16931-XML, Profil EN 16931) um, validiert das
|
||||
* Ergebnis mit dem Mustang-Validator und verpackt PDF, Factur-X-XML und
|
||||
* Prüfbericht in eine ZIP-Datei.
|
||||
*/
|
||||
@Service
|
||||
public class ZugferdService {
|
||||
|
||||
private static final Logger log = LoggerFactory.getLogger(ZugferdService.class);
|
||||
|
||||
private static final String PROFILE = "EN16931";
|
||||
private static final String PRODUCER = "Assecutor Data Service GmbH Invoice Tool";
|
||||
|
||||
/** Business Process (BT-23), von PEPPOL-EN16931-R001 gefordert. */
|
||||
private static final String BUSINESS_PROCESS = "urn:fdc:peppol.eu:2017:poacc:billing:01:1.0";
|
||||
|
||||
/** EAS-Schema "EM" = E-Mail-Adresse für die elektronische Adresse (BT-34/BT-49). */
|
||||
private static final String EAS_EMAIL = "EM";
|
||||
|
||||
private final ZugferdValidationService validationService;
|
||||
|
||||
public ZugferdService(ZugferdValidationService validationService) {
|
||||
this.validationService = validationService;
|
||||
}
|
||||
|
||||
public ZugferdResult createZugferdZip(byte[] sourcePdf, InvoiceMetadata metadata) {
|
||||
validatePdf(sourcePdf);
|
||||
sourcePdf = ensurePageResources(sourcePdf);
|
||||
Invoice invoice = buildInvoice(metadata);
|
||||
|
||||
byte[] zugferdPdf = embedXmlIntoPdf(sourcePdf, invoice);
|
||||
byte[] facturXml = generateXml(invoice);
|
||||
|
||||
String baseName = sanitizeFileName(metadata.invoiceNumber());
|
||||
String pdfName = baseName + "-zugferd.pdf";
|
||||
ZugferdValidationService.ValidationResult validation = validationService.validate(zugferdPdf, pdfName);
|
||||
|
||||
byte[] zip = zip(
|
||||
pdfName, zugferdPdf,
|
||||
"factur-x.xml", facturXml,
|
||||
"validation-report.xml", validation.reportXml().getBytes(StandardCharsets.UTF_8));
|
||||
return new ZugferdResult(zip, baseName + ".zip", validation.valid(), validation.reportXml());
|
||||
}
|
||||
|
||||
private void validatePdf(byte[] pdf) {
|
||||
if (pdf == null || pdf.length < 5
|
||||
|| !"%PDF-".equals(new String(pdf, 0, 5, StandardCharsets.US_ASCII))) {
|
||||
throw new ZugferdConversionException("Die hochgeladene Datei ist kein gültiges PDF.");
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Mustang setzt bei jeder Seite ein Resources-Dictionary voraus und stürzt
|
||||
* sonst mit einer NullPointerException ab. Seiten ohne Resources (z.B. aus
|
||||
* manchen PDF-Generatoren) erhalten deshalb vorab ein leeres Dictionary.
|
||||
*/
|
||||
private byte[] ensurePageResources(byte[] pdf) {
|
||||
try (PDDocument doc = Loader.loadPDF(pdf)) {
|
||||
boolean changed = false;
|
||||
for (PDPage page : doc.getPages()) {
|
||||
if (page.getResources() == null) {
|
||||
page.setResources(new PDResources());
|
||||
changed = true;
|
||||
}
|
||||
}
|
||||
if (!changed) {
|
||||
return pdf;
|
||||
}
|
||||
try (ByteArrayOutputStream out = new ByteArrayOutputStream()) {
|
||||
doc.save(out);
|
||||
return out.toByteArray();
|
||||
}
|
||||
} catch (IOException e) {
|
||||
throw new ZugferdConversionException("Das PDF konnte nicht gelesen werden: " + e.getMessage(), e);
|
||||
}
|
||||
}
|
||||
|
||||
private Invoice buildInvoice(InvoiceMetadata m) {
|
||||
LocalDate delivery = m.deliveryDate() != null ? m.deliveryDate() : m.issueDate();
|
||||
LocalDate due = m.dueDate() != null ? m.dueDate() : m.issueDate().plusDays(14);
|
||||
String currency = m.currency() != null && !m.currency().isBlank() ? m.currency() : "EUR";
|
||||
|
||||
Invoice invoice = new Invoice()
|
||||
.setDocumentName("Rechnung")
|
||||
.setBusinessProcessId(BUSINESS_PROCESS)
|
||||
.setNumber(m.invoiceNumber())
|
||||
.setIssueDate(toDate(m.issueDate()))
|
||||
.setDeliveryDate(toDate(delivery))
|
||||
.setDueDate(toDate(due))
|
||||
.setCurrency(currency)
|
||||
.setSender(toSender(m))
|
||||
.setRecipient(toTradeParty(m.recipient()));
|
||||
|
||||
if (m.paymentTerms() != null && !m.paymentTerms().isBlank()) {
|
||||
invoice.setPaymentTermDescription(m.paymentTerms());
|
||||
}
|
||||
if (m.buyerReference() != null && !m.buyerReference().isBlank()) {
|
||||
// Käuferreferenz / Leitweg-ID (BT-10)
|
||||
invoice.setReferenceNumber(m.buyerReference().trim());
|
||||
}
|
||||
|
||||
for (InvoiceMetadata.LineItem li : m.items()) {
|
||||
// Einheit "C62" = Stück (UN/ECE Recommendation 20)
|
||||
Product product = new Product(li.description(), "", "C62", li.vatPercent());
|
||||
invoice.addItem(new Item(product, li.unitPriceNet(), li.quantity()));
|
||||
}
|
||||
return invoice;
|
||||
}
|
||||
|
||||
/** Rechnungssteller inkl. Verkäufer-Kontakt (BG-6) und Zahlungsverbindung (BG-16). */
|
||||
private TradeParty toSender(InvoiceMetadata m) {
|
||||
InvoiceMetadata.Party p = m.sender();
|
||||
TradeParty party = toTradeParty(p);
|
||||
party.setContact(new Contact(p.name(), p.phone(), p.email()));
|
||||
if (m.iban() != null && !m.iban().isBlank()) {
|
||||
String iban = m.iban().replaceAll("\\s", "").toUpperCase();
|
||||
party.addBankDetails(m.bic() != null && !m.bic().isBlank()
|
||||
? new BankDetails(iban, m.bic().trim().toUpperCase())
|
||||
: new BankDetails(iban));
|
||||
}
|
||||
return party;
|
||||
}
|
||||
|
||||
private TradeParty toTradeParty(InvoiceMetadata.Party p) {
|
||||
TradeParty party = new TradeParty(p.name(), p.street(), p.zip(), p.city(), p.countryCode());
|
||||
if (p.vatId() != null && !p.vatId().isBlank()) {
|
||||
party.addVATID(p.vatId());
|
||||
}
|
||||
if (p.email() != null && !p.email().isBlank()) {
|
||||
party.setEmail(p.email());
|
||||
party.addUriUniversalCommunicationID(new SchemedID(EAS_EMAIL, p.email()));
|
||||
}
|
||||
return party;
|
||||
}
|
||||
|
||||
private byte[] embedXmlIntoPdf(byte[] sourcePdf, Invoice invoice) {
|
||||
try (ByteArrayOutputStream out = new ByteArrayOutputStream();
|
||||
IZUGFeRDExporter exporter = loadExporter(sourcePdf)) {
|
||||
exporter.setProducer(PRODUCER)
|
||||
.setCreator(PRODUCER)
|
||||
.setProfile(Profiles.getByName(PROFILE))
|
||||
.setTransaction(invoice);
|
||||
exporter.export(out);
|
||||
return out.toByteArray();
|
||||
} catch (IOException | RuntimeException e) {
|
||||
// Mustang wirft bei problematischen PDFs auch unchecked Exceptions —
|
||||
// ohne diesen Catch würde daraus ein HTTP 500 statt einer Fehlermeldung.
|
||||
throw new ZugferdConversionException(
|
||||
"Das PDF konnte nicht in eine ZUGFeRD-Rechnung umgewandelt werden: " + e.getMessage(), e);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Versucht zuerst die automatische PDF/A-Erkennung; ist das PDF kein PDF/A
|
||||
* (der Normalfall bei ERP-Ausdrucken), wird es tolerant als PDF/A-1
|
||||
* interpretiert und nach PDF/A-3 konvertiert.
|
||||
*/
|
||||
private IZUGFeRDExporter loadExporter(byte[] sourcePdf) throws IOException {
|
||||
ZUGFeRDExporterFromPDFA exporter = new ZUGFeRDExporterFromPDFA();
|
||||
try {
|
||||
exporter.load(new ByteArrayInputStream(sourcePdf));
|
||||
return exporter;
|
||||
} catch (IOException | IllegalArgumentException e) {
|
||||
// Nicht exporter.close(): vor erfolgreichem load() hält er keine Ressourcen
|
||||
// und close() würde eine RuntimeException werfen.
|
||||
log.info("Eingabe ist kein PDF/A, konvertiere tolerant: {}", e.getMessage());
|
||||
ZUGFeRDExporterFromA1 fallback = new ZUGFeRDExporterFromA1();
|
||||
fallback.ignorePDFAErrors();
|
||||
fallback.load(new ByteArrayInputStream(sourcePdf));
|
||||
return fallback;
|
||||
}
|
||||
}
|
||||
|
||||
private byte[] generateXml(Invoice invoice) {
|
||||
ZUGFeRD2PullProvider provider = new ZUGFeRD2PullProvider();
|
||||
provider.setProfile(Profiles.getByName(PROFILE));
|
||||
provider.generateXML(invoice);
|
||||
return provider.getXML();
|
||||
}
|
||||
|
||||
/**
|
||||
* Packt die übergebenen Einträge (abwechselnd Dateiname als String und Inhalt
|
||||
* als byte[]) in eine ZIP-Datei.
|
||||
*/
|
||||
private byte[] zip(Object... namesAndContents) {
|
||||
try (ByteArrayOutputStream bos = new ByteArrayOutputStream();
|
||||
ZipOutputStream zos = new ZipOutputStream(bos)) {
|
||||
for (int i = 0; i < namesAndContents.length; i += 2) {
|
||||
zos.putNextEntry(new ZipEntry((String) namesAndContents[i]));
|
||||
zos.write((byte[]) namesAndContents[i + 1]);
|
||||
zos.closeEntry();
|
||||
}
|
||||
zos.finish();
|
||||
return bos.toByteArray();
|
||||
} catch (IOException e) {
|
||||
throw new ZugferdConversionException("ZIP-Datei konnte nicht erstellt werden.", e);
|
||||
}
|
||||
}
|
||||
|
||||
private static String sanitizeFileName(String name) {
|
||||
String cleaned = name.replaceAll("[^A-Za-z0-9._-]", "_");
|
||||
return cleaned.isBlank() ? "rechnung" : cleaned;
|
||||
}
|
||||
|
||||
private static Date toDate(LocalDate date) {
|
||||
return Date.from(date.atStartOfDay(ZoneId.systemDefault()).toInstant());
|
||||
}
|
||||
}
|
||||
@@ -1,38 +0,0 @@
|
||||
package de.assecutor.pdftool.zugferd;
|
||||
|
||||
import org.mustangproject.validator.ZUGFeRDValidator;
|
||||
import org.slf4j.Logger;
|
||||
import org.slf4j.LoggerFactory;
|
||||
import org.springframework.stereotype.Service;
|
||||
|
||||
/**
|
||||
* Validiert ZUGFeRD-Rechnungen (PDF oder XML) mit dem Mustang-Validator gegen
|
||||
* XSD-Schema und die EN16931-Schematron-Regeln sowie das PDF gegen PDF/A-3
|
||||
* (veraPDF). Liefert das Prüfergebnis samt XML-Prüfbericht.
|
||||
*/
|
||||
@Service
|
||||
public class ZugferdValidationService {
|
||||
|
||||
private static final Logger log = LoggerFactory.getLogger(ZugferdValidationService.class);
|
||||
|
||||
public ValidationResult validate(byte[] content, String fileName) {
|
||||
try {
|
||||
// ZUGFeRDValidator hält Zustand pro Prüfung und ist nicht threadsicher,
|
||||
// daher pro Aufruf eine neue Instanz
|
||||
ZUGFeRDValidator validator = new ZUGFeRDValidator();
|
||||
String report = validator.validate(content, fileName);
|
||||
boolean valid = validator.wasCompletelyValid();
|
||||
if (!valid) {
|
||||
log.warn("ZUGFeRD-Validierung von {} fehlgeschlagen:\n{}", fileName, report);
|
||||
}
|
||||
return new ValidationResult(valid, report);
|
||||
} catch (RuntimeException e) {
|
||||
log.error("Validierung von {} nicht durchführbar", fileName, e);
|
||||
return new ValidationResult(false,
|
||||
"<validation><error>Validierung nicht durchführbar: " + e.getMessage() + "</error></validation>");
|
||||
}
|
||||
}
|
||||
|
||||
public record ValidationResult(boolean valid, String reportXml) {
|
||||
}
|
||||
}
|
||||
@@ -15,8 +15,9 @@ server.servlet.session.cookie.name=PDFTOOL_SESSION
|
||||
# Wird beim Build durch die Version aus der pom.xml ersetzt (Resource-Filtering)
|
||||
pdftool.version=@project.version@
|
||||
|
||||
spring.servlet.multipart.max-file-size=25MB
|
||||
spring.servlet.multipart.max-request-size=30MB
|
||||
# PDF Service: erzeugt aus dem gerenderten Rechnungs-PDF die ZUGFeRD-E-Rechnung
|
||||
# (eigenständiges Projekt "PDF Service", POST {pdfservice.url}/invoices/sign)
|
||||
pdfservice.url=${PDF_SERVICE_URL:http://localhost:8084/api/v1}
|
||||
|
||||
# Auch normale (Nicht-Multipart-)Requests bis 30 MB zulassen: Canvas-Daten mit
|
||||
# eingebetteten Bild-Elementen können das Tomcat-Standardlimit von 2 MB
|
||||
|
||||
@@ -1,133 +0,0 @@
|
||||
package de.assecutor.pdftool.zugferd;
|
||||
|
||||
import de.assecutor.pdftool.invoice.InvoiceMetadata;
|
||||
import org.apache.pdfbox.Loader;
|
||||
import org.apache.pdfbox.pdmodel.PDDocument;
|
||||
import org.apache.pdfbox.pdmodel.PDPage;
|
||||
import org.apache.pdfbox.pdmodel.PDPageContentStream;
|
||||
import org.apache.pdfbox.pdmodel.font.PDType0Font;
|
||||
import org.junit.jupiter.api.Test;
|
||||
|
||||
import java.io.ByteArrayInputStream;
|
||||
import java.io.ByteArrayOutputStream;
|
||||
import java.math.BigDecimal;
|
||||
import java.nio.charset.StandardCharsets;
|
||||
import java.time.LocalDate;
|
||||
import java.util.HashMap;
|
||||
import java.util.List;
|
||||
import java.util.Map;
|
||||
import java.util.zip.ZipEntry;
|
||||
import java.util.zip.ZipInputStream;
|
||||
|
||||
import static org.junit.jupiter.api.Assertions.assertEquals;
|
||||
import static org.junit.jupiter.api.Assertions.assertNotNull;
|
||||
import static org.junit.jupiter.api.Assertions.assertThrows;
|
||||
import static org.junit.jupiter.api.Assertions.assertTrue;
|
||||
|
||||
class ZugferdServiceTest {
|
||||
|
||||
private final ZugferdService service = new ZugferdService(new ZugferdValidationService());
|
||||
|
||||
@Test
|
||||
void createsZipWithZugferdPdfAndFacturXml() throws Exception {
|
||||
byte[] sourcePdf = createSamplePdf();
|
||||
|
||||
ZugferdResult result = service.createZugferdZip(sourcePdf, sampleMetadata());
|
||||
|
||||
assertEquals("RE-2026-0815.zip", result.zipFileName());
|
||||
assertTrue(result.valid(), "Mustang-Validierung fehlgeschlagen:\n" + result.validationReport());
|
||||
|
||||
Map<String, byte[]> entries = readZip(result.zip());
|
||||
assertEquals(3, entries.size());
|
||||
byte[] pdf = entries.get("RE-2026-0815-zugferd.pdf");
|
||||
byte[] xml = entries.get("factur-x.xml");
|
||||
byte[] report = entries.get("validation-report.xml");
|
||||
assertNotNull(pdf, "ZUGFeRD-PDF fehlt im ZIP");
|
||||
assertNotNull(xml, "Factur-X-XML fehlt im ZIP");
|
||||
assertNotNull(report, "Prüfbericht fehlt im ZIP");
|
||||
|
||||
String xmlText = new String(xml, StandardCharsets.UTF_8);
|
||||
assertTrue(xmlText.contains("RE-2026-0815"), "Rechnungsnummer fehlt im XML");
|
||||
assertTrue(xmlText.contains("CrossIndustryInvoice"), "Kein CII-XML");
|
||||
assertTrue(xmlText.contains("urn:cen.eu:en16931:2017"), "EN16931-Profil fehlt");
|
||||
|
||||
// Das erzeugte PDF muss das XML als eingebettete Datei enthalten
|
||||
try (PDDocument doc = Loader.loadPDF(pdf)) {
|
||||
String names = doc.getDocumentCatalog().getNames().getEmbeddedFiles().getNames().keySet().toString();
|
||||
assertTrue(names.contains("factur-x.xml"), "factur-x.xml nicht ins PDF eingebettet: " + names);
|
||||
}
|
||||
}
|
||||
|
||||
@Test
|
||||
void convertsPdfWhosePageHasNoResources() throws Exception {
|
||||
// Mustang 2.17 stürzt ohne Resources-Dictionary mit einer NPE ab —
|
||||
// der Service muss solche PDFs vorab reparieren.
|
||||
byte[] sourcePdf;
|
||||
try (PDDocument doc = new PDDocument(); ByteArrayOutputStream out = new ByteArrayOutputStream()) {
|
||||
doc.addPage(new PDPage());
|
||||
doc.save(out);
|
||||
sourcePdf = out.toByteArray();
|
||||
}
|
||||
|
||||
ZugferdResult result = service.createZugferdZip(sourcePdf, sampleMetadata());
|
||||
|
||||
assertTrue(result.valid(), "Mustang-Validierung fehlgeschlagen:\n" + result.validationReport());
|
||||
}
|
||||
|
||||
@Test
|
||||
void rejectsNonPdfInput() {
|
||||
assertThrows(ZugferdConversionException.class,
|
||||
() -> service.createZugferdZip("kein pdf".getBytes(StandardCharsets.UTF_8), sampleMetadata()));
|
||||
}
|
||||
|
||||
private static InvoiceMetadata sampleMetadata() {
|
||||
return new InvoiceMetadata(
|
||||
"RE-2026-0815",
|
||||
LocalDate.of(2026, 7, 8),
|
||||
LocalDate.of(2026, 7, 1),
|
||||
LocalDate.of(2026, 7, 22),
|
||||
"EUR",
|
||||
"Zahlbar innerhalb von 14 Tagen ohne Abzug.",
|
||||
"KR-2026-042",
|
||||
"DE75512108001245126199",
|
||||
null,
|
||||
new InvoiceMetadata.Party("Assecutor Data Service GmbH", "Gerhart-Hauptmann-Weg 14",
|
||||
"21502", "Geesthacht", "DE", "DE261094748", "rechnung@example.com",
|
||||
"+49 40 18 123 771 0"),
|
||||
new InvoiceMetadata.Party("Kunde AG", "Beispielweg 2", "10115", "Berlin", "DE", null,
|
||||
"einkauf@example.com", null),
|
||||
List.of(new InvoiceMetadata.LineItem("Beratungsleistung", BigDecimal.ONE,
|
||||
new BigDecimal("1500.00"), new BigDecimal("19")))
|
||||
);
|
||||
}
|
||||
|
||||
private static byte[] createSamplePdf() throws Exception {
|
||||
try (PDDocument doc = new PDDocument(); ByteArrayOutputStream out = new ByteArrayOutputStream()) {
|
||||
PDPage page = new PDPage();
|
||||
doc.addPage(page);
|
||||
try (PDPageContentStream cs = new PDPageContentStream(doc, page)) {
|
||||
// PDF/A verlangt eingebettete Schriften; LiberationSans liegt pdfbox bei
|
||||
PDType0Font font = PDType0Font.load(doc, PDDocument.class.getResourceAsStream(
|
||||
"/org/apache/pdfbox/resources/ttf/LiberationSans-Regular.ttf"), true);
|
||||
cs.beginText();
|
||||
cs.setFont(font, 12);
|
||||
cs.newLineAtOffset(50, 700);
|
||||
cs.showText("Rechnung RE-2026-0815");
|
||||
cs.endText();
|
||||
}
|
||||
doc.save(out);
|
||||
return out.toByteArray();
|
||||
}
|
||||
}
|
||||
|
||||
private static Map<String, byte[]> readZip(byte[] zip) throws Exception {
|
||||
Map<String, byte[]> entries = new HashMap<>();
|
||||
try (ZipInputStream zis = new ZipInputStream(new ByteArrayInputStream(zip))) {
|
||||
ZipEntry entry;
|
||||
while ((entry = zis.getNextEntry()) != null) {
|
||||
entries.put(entry.getName(), zis.readAllBytes());
|
||||
}
|
||||
}
|
||||
return entries;
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,40 @@
|
||||
// This TypeScript configuration file is generated by vaadin-maven-plugin.
|
||||
// This is needed for TypeScript compiler to compile your TypeScript code in the project.
|
||||
// It is recommended to commit this file to the VCS.
|
||||
// You might want to change the configurations to fit your preferences
|
||||
// For more information about the configurations, please refer to http://www.typescriptlang.org/docs/handbook/tsconfig-json.html
|
||||
{
|
||||
"_version": "9.1",
|
||||
"compilerOptions": {
|
||||
"sourceMap": true,
|
||||
"jsx": "react-jsx",
|
||||
"inlineSources": true,
|
||||
"module": "esNext",
|
||||
"target": "es2022",
|
||||
"moduleResolution": "bundler",
|
||||
"strict": true,
|
||||
"skipLibCheck": true,
|
||||
"noFallthroughCasesInSwitch": true,
|
||||
"noImplicitReturns": true,
|
||||
"noImplicitAny": true,
|
||||
"noImplicitThis": true,
|
||||
"noUnusedLocals": false,
|
||||
"noUnusedParameters": false,
|
||||
"experimentalDecorators": true,
|
||||
"useDefineForClassFields": false,
|
||||
"ignoreDeprecations": "5.0",
|
||||
"baseUrl": "src/main/frontend",
|
||||
"paths": {
|
||||
"@vaadin/flow-frontend": ["generated/jar-resources"],
|
||||
"@vaadin/flow-frontend/*": ["generated/jar-resources/*"],
|
||||
"Frontend/*": ["*"]
|
||||
}
|
||||
},
|
||||
"include": [
|
||||
"src/main/frontend/**/*",
|
||||
"types.d.ts"
|
||||
],
|
||||
"exclude": [
|
||||
"src/main/frontend/generated/jar-resources/**"
|
||||
]
|
||||
}
|
||||
Vendored
+17
@@ -0,0 +1,17 @@
|
||||
// This TypeScript modules definition file is generated by vaadin-maven-plugin.
|
||||
// You can not directly import your different static files into TypeScript,
|
||||
// This is needed for TypeScript compiler to declare and export as a TypeScript module.
|
||||
// It is recommended to commit this file to the VCS.
|
||||
// You might want to change the configurations to fit your preferences
|
||||
declare module '*.css?inline' {
|
||||
import type { CSSResultGroup } from 'lit';
|
||||
const content: CSSResultGroup;
|
||||
export default content;
|
||||
}
|
||||
|
||||
// Allow any CSS Custom Properties
|
||||
declare module 'csstype' {
|
||||
interface Properties {
|
||||
[index: `--${string}`]: any;
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,9 @@
|
||||
import { UserConfigFn } from 'vite';
|
||||
import { overrideVaadinConfig } from './vite.generated';
|
||||
|
||||
const customConfig: UserConfigFn = (env) => ({
|
||||
// Here you can add custom Vite parameters
|
||||
// https://vitejs.dev/config/
|
||||
});
|
||||
|
||||
export default overrideVaadinConfig(customConfig);
|
||||
@@ -0,0 +1,858 @@
|
||||
/**
|
||||
* NOTICE: this is an auto-generated file
|
||||
*
|
||||
* This file has been generated by the `flow:prepare-frontend` maven goal.
|
||||
* This file will be overwritten on every run. Any custom changes should be made to vite.config.ts
|
||||
*/
|
||||
import path from 'path';
|
||||
import { existsSync, mkdirSync, readdirSync, readFileSync, writeFileSync, Stats } from 'fs';
|
||||
import { createHash } from 'crypto';
|
||||
import * as net from 'net';
|
||||
|
||||
import { processThemeResources } from './target/plugins/application-theme-plugin/theme-handle.js';
|
||||
import { rewriteCssUrls } from './target/plugins/theme-loader/theme-loader-utils.js';
|
||||
import { addFunctionComponentSourceLocationBabel } from './target/plugins/react-function-location-plugin/react-function-location-plugin.js';
|
||||
import settings from './target/vaadin-dev-server-settings.json';
|
||||
import {
|
||||
AssetInfo,
|
||||
ChunkInfo,
|
||||
build,
|
||||
defineConfig,
|
||||
mergeConfig,
|
||||
OutputOptions,
|
||||
PluginOption,
|
||||
InlineConfig,
|
||||
UserConfigFn
|
||||
} from 'vite';
|
||||
import { getManifest, type ManifestTransform } from 'workbox-build';
|
||||
|
||||
import * as rollup from 'rollup';
|
||||
import brotli from 'rollup-plugin-brotli';
|
||||
import checker from 'vite-plugin-checker';
|
||||
import postcssLit from './target/plugins/rollup-plugin-postcss-lit-custom/rollup-plugin-postcss-lit.js';
|
||||
|
||||
import { createRequire } from 'module';
|
||||
|
||||
import { visualizer } from 'rollup-plugin-visualizer';
|
||||
import reactPlugin from '@vitejs/plugin-react';
|
||||
|
||||
|
||||
|
||||
// Make `require` compatible with ES modules
|
||||
const require = createRequire(import.meta.url);
|
||||
|
||||
const appShellUrl = '.';
|
||||
|
||||
const frontendFolder = path.resolve(__dirname, settings.frontendFolder);
|
||||
const themeFolder = path.resolve(frontendFolder, settings.themeFolder);
|
||||
const frontendBundleFolder = path.resolve(__dirname, settings.frontendBundleOutput);
|
||||
const devBundleFolder = path.resolve(__dirname, settings.devBundleOutput);
|
||||
const devBundle = !!process.env.devBundle;
|
||||
const jarResourcesFolder = path.resolve(__dirname, settings.jarResourcesFolder);
|
||||
const themeResourceFolder = path.resolve(__dirname, settings.themeResourceFolder);
|
||||
const projectPackageJsonFile = path.resolve(__dirname, 'package.json');
|
||||
|
||||
const buildOutputFolder = devBundle ? devBundleFolder : frontendBundleFolder;
|
||||
const statsFolder = path.resolve(__dirname, devBundle ? settings.devBundleStatsOutput : settings.statsOutput);
|
||||
const statsFile = path.resolve(statsFolder, 'stats.json');
|
||||
const bundleSizeFile = path.resolve(statsFolder, 'bundle-size.html');
|
||||
const nodeModulesFolder = path.resolve(__dirname, 'node_modules');
|
||||
const webComponentTags = '';
|
||||
|
||||
const projectIndexHtml = path.resolve(frontendFolder, 'index.html');
|
||||
|
||||
const projectStaticAssetsFolders = [
|
||||
path.resolve(__dirname, 'src', 'main', 'resources', 'META-INF', 'resources'),
|
||||
path.resolve(__dirname, 'src', 'main', 'resources', 'static'),
|
||||
frontendFolder
|
||||
];
|
||||
|
||||
// Folders in the project which can contain application themes
|
||||
const themeProjectFolders = projectStaticAssetsFolders.map((folder) => path.resolve(folder, settings.themeFolder));
|
||||
|
||||
const themeOptions = {
|
||||
devMode: false,
|
||||
useDevBundle: devBundle,
|
||||
// The following matches folder 'frontend/generated/themes/'
|
||||
// (not 'frontend/themes') for theme in JAR that is copied there
|
||||
themeResourceFolder: path.resolve(themeResourceFolder, settings.themeFolder),
|
||||
themeProjectFolders: themeProjectFolders,
|
||||
projectStaticAssetsOutputFolder: devBundle
|
||||
? path.resolve(devBundleFolder, '../assets')
|
||||
: path.resolve(__dirname, settings.staticOutput),
|
||||
frontendGeneratedFolder: path.resolve(frontendFolder, settings.generatedFolder)
|
||||
};
|
||||
|
||||
const hasExportedWebComponents = existsSync(path.resolve(frontendFolder, 'web-component.html'));
|
||||
|
||||
// Block debug and trace logs.
|
||||
console.trace = () => {};
|
||||
console.debug = () => {};
|
||||
|
||||
function injectManifestToSWPlugin(): rollup.Plugin {
|
||||
const rewriteManifestIndexHtmlUrl: ManifestTransform = (manifest) => {
|
||||
const indexEntry = manifest.find((entry) => entry.url === 'index.html');
|
||||
if (indexEntry) {
|
||||
indexEntry.url = appShellUrl;
|
||||
}
|
||||
|
||||
return { manifest, warnings: [] };
|
||||
};
|
||||
|
||||
return {
|
||||
name: 'vaadin:inject-manifest-to-sw',
|
||||
async transform(code, id) {
|
||||
if (/sw\.(ts|js)$/.test(id)) {
|
||||
const { manifestEntries } = await getManifest({
|
||||
globDirectory: buildOutputFolder,
|
||||
globPatterns: ['**/*'],
|
||||
globIgnores: ['**/*.br', 'pwa-icons/**'],
|
||||
manifestTransforms: [rewriteManifestIndexHtmlUrl],
|
||||
maximumFileSizeToCacheInBytes: 100 * 1024 * 1024 // 100mb,
|
||||
});
|
||||
|
||||
return code.replace('self.__WB_MANIFEST', JSON.stringify(manifestEntries));
|
||||
}
|
||||
}
|
||||
};
|
||||
}
|
||||
|
||||
function buildSWPlugin(opts: { devMode: boolean }): PluginOption {
|
||||
let buildConfig: InlineConfig;
|
||||
let buildOutput: rollup.RollupOutput;
|
||||
const devMode = opts.devMode;
|
||||
|
||||
return {
|
||||
name: 'vaadin:build-sw',
|
||||
enforce: 'post',
|
||||
async configResolved(viteConfig) {
|
||||
buildConfig = {
|
||||
base: viteConfig.base,
|
||||
root: viteConfig.root,
|
||||
mode: viteConfig.mode,
|
||||
resolve: viteConfig.resolve,
|
||||
define: {
|
||||
...viteConfig.define,
|
||||
'process.env.NODE_ENV': JSON.stringify(viteConfig.mode),
|
||||
},
|
||||
build: {
|
||||
write: !devMode,
|
||||
minify: viteConfig.build.minify,
|
||||
outDir: viteConfig.build.outDir,
|
||||
sourcemap: viteConfig.command === 'serve' || viteConfig.build.sourcemap,
|
||||
emptyOutDir: false,
|
||||
modulePreload: false,
|
||||
target: ['safari15', 'es2022'],
|
||||
rollupOptions: {
|
||||
input: {
|
||||
sw: settings.clientServiceWorkerSource
|
||||
},
|
||||
output: {
|
||||
exports: 'none',
|
||||
entryFileNames: 'sw.js',
|
||||
inlineDynamicImports: true,
|
||||
},
|
||||
},
|
||||
},
|
||||
};
|
||||
},
|
||||
async buildStart() {
|
||||
if (devMode) {
|
||||
buildOutput = await build(buildConfig) as rollup.RollupOutput;
|
||||
}
|
||||
},
|
||||
async load(id) {
|
||||
if (id.endsWith('sw.js')) {
|
||||
return buildOutput.output[0].code;
|
||||
}
|
||||
},
|
||||
async closeBundle() {
|
||||
if (!devMode) {
|
||||
await build({
|
||||
...buildConfig,
|
||||
plugins: [injectManifestToSWPlugin(), brotli()]
|
||||
});
|
||||
}
|
||||
},
|
||||
};
|
||||
}
|
||||
|
||||
function statsExtracterPlugin(): PluginOption {
|
||||
function collectThemeJsonsInFrontend(themeJsonContents: Record<string, string>, themeName: string) {
|
||||
const themeJson = path.resolve(frontendFolder, settings.themeFolder, themeName, 'theme.json');
|
||||
if (existsSync(themeJson)) {
|
||||
const themeJsonContent = readFileSync(themeJson, { encoding: 'utf-8' }).replace(/\r\n/g, '\n');
|
||||
themeJsonContents[themeName] = themeJsonContent;
|
||||
const themeJsonObject = JSON.parse(themeJsonContent);
|
||||
if (themeJsonObject.parent) {
|
||||
collectThemeJsonsInFrontend(themeJsonContents, themeJsonObject.parent);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
return {
|
||||
name: 'vaadin:stats',
|
||||
enforce: 'post',
|
||||
async writeBundle(options: OutputOptions, bundle: { [fileName: string]: AssetInfo | ChunkInfo }) {
|
||||
const modules = Object.values(bundle).flatMap((b) => (b.modules ? Object.keys(b.modules) : []));
|
||||
const nodeModulesFolders = modules
|
||||
.map((id) => id.replace(/\\/g, '/'))
|
||||
.filter((id) => id.startsWith(nodeModulesFolder.replace(/\\/g, '/')))
|
||||
.map((id) => id.substring(nodeModulesFolder.length + 1));
|
||||
const npmModules = nodeModulesFolders
|
||||
.map((id) => id.replace(/\\/g, '/'))
|
||||
.map((id) => {
|
||||
const parts = id.split('/');
|
||||
if (id.startsWith('@')) {
|
||||
return parts[0] + '/' + parts[1];
|
||||
} else {
|
||||
return parts[0];
|
||||
}
|
||||
})
|
||||
.sort()
|
||||
.filter((value, index, self) => self.indexOf(value) === index);
|
||||
const npmModuleAndVersion = Object.fromEntries(npmModules.map((module) => [module, getVersion(module)]));
|
||||
const cvdls = Object.fromEntries(
|
||||
npmModules
|
||||
.filter((module) => getCvdlName(module) != null)
|
||||
.map((module) => [module, { name: getCvdlName(module), version: getVersion(module) }])
|
||||
);
|
||||
|
||||
mkdirSync(path.dirname(statsFile), { recursive: true });
|
||||
const projectPackageJson = JSON.parse(readFileSync(projectPackageJsonFile, { encoding: 'utf-8' }));
|
||||
|
||||
const entryScripts = Object.values(bundle)
|
||||
.filter((bundle) => bundle.isEntry)
|
||||
.map((bundle) => bundle.fileName);
|
||||
|
||||
const generatedIndexHtml = path.resolve(buildOutputFolder, 'index.html');
|
||||
const customIndexData: string = readFileSync(projectIndexHtml, { encoding: 'utf-8' });
|
||||
const generatedIndexData: string = readFileSync(generatedIndexHtml, {
|
||||
encoding: 'utf-8'
|
||||
});
|
||||
|
||||
const customIndexRows = new Set(customIndexData.split(/[\r\n]/).filter((row) => row.trim() !== ''));
|
||||
const generatedIndexRows = generatedIndexData.split(/[\r\n]/).filter((row) => row.trim() !== '');
|
||||
|
||||
const rowsGenerated: string[] = [];
|
||||
generatedIndexRows.forEach((row) => {
|
||||
if (!customIndexRows.has(row)) {
|
||||
rowsGenerated.push(row);
|
||||
}
|
||||
});
|
||||
|
||||
//After dev-bundle build add used Flow frontend imports JsModule/JavaScript/CssImport
|
||||
|
||||
const parseImports = (filename: string, result: Set<string>): void => {
|
||||
const content: string = readFileSync(filename, { encoding: 'utf-8' });
|
||||
const lines = content.split('\n');
|
||||
const staticImports = lines
|
||||
.filter((line) => line.startsWith('import '))
|
||||
.map((line) => line.substring(line.indexOf("'") + 1, line.lastIndexOf("'")))
|
||||
.map((line) => (line.includes('?') ? line.substring(0, line.lastIndexOf('?')) : line));
|
||||
const dynamicImports = lines
|
||||
.filter((line) => line.includes('import('))
|
||||
.map((line) => line.replace(/.*import\(/, ''))
|
||||
.map((line) => line.split(/'/)[1])
|
||||
.map((line) => (line.includes('?') ? line.substring(0, line.lastIndexOf('?')) : line));
|
||||
|
||||
staticImports.forEach((staticImport) => result.add(staticImport));
|
||||
|
||||
dynamicImports.map((dynamicImport) => {
|
||||
const importedFile = path.resolve(path.dirname(filename), dynamicImport);
|
||||
parseImports(importedFile, result);
|
||||
});
|
||||
};
|
||||
|
||||
const generatedImportsSet = new Set<string>();
|
||||
parseImports(
|
||||
path.resolve(themeOptions.frontendGeneratedFolder, 'flow', 'generated-flow-imports.js'),
|
||||
generatedImportsSet
|
||||
);
|
||||
const generatedImports = Array.from(generatedImportsSet).sort();
|
||||
|
||||
const frontendFiles: Record<string, string> = {};
|
||||
frontendFiles['index.html'] = createHash('sha256').update(customIndexData.replace(/\r\n/g, '\n'), 'utf8').digest('hex');
|
||||
|
||||
const projectFileExtensions = ['.js', '.js.map', '.ts', '.ts.map', '.tsx', '.tsx.map', '.css', '.css.map'];
|
||||
|
||||
const isThemeComponentsResource = (id: string) =>
|
||||
id.startsWith(themeOptions.frontendGeneratedFolder.replace(/\\/g, '/'))
|
||||
&& id.match(/.*\/jar-resources\/themes\/[^\/]+\/components\//);
|
||||
|
||||
const isGeneratedWebComponentResource = (id: string) =>
|
||||
id.startsWith(themeOptions.frontendGeneratedFolder.replace(/\\/g, '/'))
|
||||
&& id.match(/.*\/flow\/web-components\//);
|
||||
|
||||
const isFrontendResourceCollected = (id: string) =>
|
||||
!id.startsWith(themeOptions.frontendGeneratedFolder.replace(/\\/g, '/'))
|
||||
|| isThemeComponentsResource(id)
|
||||
|| isGeneratedWebComponentResource(id);
|
||||
|
||||
// collects project's frontend resources in frontend folder, excluding
|
||||
// 'generated' sub-folder, except for legacy shadow DOM stylesheets
|
||||
// packaged in `theme/components/` folder
|
||||
// and generated web component resources in `flow/web-components` folder.
|
||||
modules
|
||||
.map((id) => id.replace(/\\/g, '/'))
|
||||
.filter((id) => id.startsWith(frontendFolder.replace(/\\/g, '/')))
|
||||
.filter(isFrontendResourceCollected)
|
||||
.map((id) => id.substring(frontendFolder.length + 1))
|
||||
.map((line: string) => (line.includes('?') ? line.substring(0, line.lastIndexOf('?')) : line))
|
||||
.forEach((line: string) => {
|
||||
// \r\n from windows made files may be used so change to \n
|
||||
const filePath = path.resolve(frontendFolder, line);
|
||||
if (projectFileExtensions.includes(path.extname(filePath))) {
|
||||
const fileBuffer = readFileSync(filePath, { encoding: 'utf-8' }).replace(/\r\n/g, '\n');
|
||||
frontendFiles[line] = createHash('sha256').update(fileBuffer, 'utf8').digest('hex');
|
||||
}
|
||||
});
|
||||
|
||||
// collects frontend resources from the JARs
|
||||
generatedImports
|
||||
.filter((line: string) => line.includes('generated/jar-resources'))
|
||||
.forEach((line: string) => {
|
||||
let filename = line.substring(line.indexOf('generated'));
|
||||
// \r\n from windows made files may be used ro remove to be only \n
|
||||
const fileBuffer = readFileSync(path.resolve(frontendFolder, filename), { encoding: 'utf-8' }).replace(
|
||||
/\r\n/g,
|
||||
'\n'
|
||||
);
|
||||
const hash = createHash('sha256').update(fileBuffer, 'utf8').digest('hex');
|
||||
|
||||
const fileKey = line.substring(line.indexOf('jar-resources/') + 14);
|
||||
frontendFiles[fileKey] = hash;
|
||||
});
|
||||
// collects and hash rest of the Frontend resources excluding files in /generated/ and /themes/
|
||||
// and files already in frontendFiles.
|
||||
let frontendFolderAlias = "Frontend";
|
||||
generatedImports
|
||||
.filter((line: string) => line.startsWith(frontendFolderAlias + '/'))
|
||||
.filter((line: string) => !line.startsWith(frontendFolderAlias + '/generated/'))
|
||||
.filter((line: string) => !line.startsWith(frontendFolderAlias + '/themes/'))
|
||||
.map((line) => line.substring(frontendFolderAlias.length + 1))
|
||||
.filter((line: string) => !frontendFiles[line])
|
||||
.forEach((line: string) => {
|
||||
const filePath = path.resolve(frontendFolder, line);
|
||||
if (projectFileExtensions.includes(path.extname(filePath)) && existsSync(filePath)) {
|
||||
const fileBuffer = readFileSync(filePath, { encoding: 'utf-8' }).replace(/\r\n/g, '\n');
|
||||
frontendFiles[line] = createHash('sha256').update(fileBuffer, 'utf8').digest('hex');
|
||||
}
|
||||
});
|
||||
// If a index.ts exists hash it to be able to see if it changes.
|
||||
if (existsSync(path.resolve(frontendFolder, 'index.ts'))) {
|
||||
const fileBuffer = readFileSync(path.resolve(frontendFolder, 'index.ts'), { encoding: 'utf-8' }).replace(
|
||||
/\r\n/g,
|
||||
'\n'
|
||||
);
|
||||
frontendFiles[`index.ts`] = createHash('sha256').update(fileBuffer, 'utf8').digest('hex');
|
||||
}
|
||||
|
||||
const themeJsonContents: Record<string, string> = {};
|
||||
const themesFolder = path.resolve(jarResourcesFolder, 'themes');
|
||||
if (existsSync(themesFolder)) {
|
||||
readdirSync(themesFolder).forEach((themeFolder) => {
|
||||
const themeJson = path.resolve(themesFolder, themeFolder, 'theme.json');
|
||||
if (existsSync(themeJson)) {
|
||||
themeJsonContents[path.basename(themeFolder)] = readFileSync(themeJson, { encoding: 'utf-8' }).replace(
|
||||
/\r\n/g,
|
||||
'\n'
|
||||
);
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
collectThemeJsonsInFrontend(themeJsonContents, settings.themeName);
|
||||
|
||||
let webComponents: string[] = [];
|
||||
if (webComponentTags) {
|
||||
webComponents = webComponentTags.split(';');
|
||||
}
|
||||
|
||||
const stats = {
|
||||
packageJsonDependencies: projectPackageJson.dependencies,
|
||||
npmModules: npmModuleAndVersion,
|
||||
bundleImports: generatedImports,
|
||||
frontendHashes: frontendFiles,
|
||||
themeJsonContents: themeJsonContents,
|
||||
entryScripts,
|
||||
webComponents,
|
||||
cvdlModules: cvdls,
|
||||
packageJsonHash: projectPackageJson?.vaadin?.hash,
|
||||
indexHtmlGenerated: rowsGenerated
|
||||
};
|
||||
writeFileSync(statsFile, JSON.stringify(stats, null, 1));
|
||||
}
|
||||
};
|
||||
}
|
||||
function vaadinBundlesPlugin(): PluginOption {
|
||||
type ExportInfo =
|
||||
| string
|
||||
| {
|
||||
namespace?: string;
|
||||
source: string;
|
||||
};
|
||||
|
||||
type ExposeInfo = {
|
||||
exports: ExportInfo[];
|
||||
};
|
||||
|
||||
type PackageInfo = {
|
||||
version: string;
|
||||
exposes: Record<string, ExposeInfo>;
|
||||
};
|
||||
|
||||
type BundleJson = {
|
||||
packages: Record<string, PackageInfo>;
|
||||
};
|
||||
|
||||
const disabledMessage = 'Vaadin component dependency bundles are disabled.';
|
||||
|
||||
const modulesDirectory = nodeModulesFolder.replace(/\\/g, '/');
|
||||
|
||||
let vaadinBundleJson: BundleJson;
|
||||
|
||||
function parseModuleId(id: string): { packageName: string; modulePath: string } {
|
||||
const [scope, scopedPackageName] = id.split('/', 3);
|
||||
const packageName = scope.startsWith('@') ? `${scope}/${scopedPackageName}` : scope;
|
||||
const modulePath = `.${id.substring(packageName.length)}`;
|
||||
return {
|
||||
packageName,
|
||||
modulePath
|
||||
};
|
||||
}
|
||||
|
||||
function getExports(id: string): string[] | undefined {
|
||||
const { packageName, modulePath } = parseModuleId(id);
|
||||
const packageInfo = vaadinBundleJson.packages[packageName];
|
||||
|
||||
if (!packageInfo) return;
|
||||
|
||||
const exposeInfo: ExposeInfo = packageInfo.exposes[modulePath];
|
||||
if (!exposeInfo) return;
|
||||
|
||||
const exportsSet = new Set<string>();
|
||||
for (const e of exposeInfo.exports) {
|
||||
if (typeof e === 'string') {
|
||||
exportsSet.add(e);
|
||||
} else {
|
||||
const { namespace, source } = e;
|
||||
if (namespace) {
|
||||
exportsSet.add(namespace);
|
||||
} else {
|
||||
const sourceExports = getExports(source);
|
||||
if (sourceExports) {
|
||||
sourceExports.forEach((e) => exportsSet.add(e));
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
return Array.from(exportsSet);
|
||||
}
|
||||
|
||||
function getExportBinding(binding: string) {
|
||||
return binding === 'default' ? '_default as default' : binding;
|
||||
}
|
||||
|
||||
function getImportAssigment(binding: string) {
|
||||
return binding === 'default' ? 'default: _default' : binding;
|
||||
}
|
||||
|
||||
return {
|
||||
name: 'vaadin:bundles',
|
||||
enforce: 'pre',
|
||||
apply(config, { command }) {
|
||||
if (command !== 'serve') return false;
|
||||
|
||||
try {
|
||||
const vaadinBundleJsonPath = require.resolve('@vaadin/bundles/vaadin-bundle.json');
|
||||
vaadinBundleJson = JSON.parse(readFileSync(vaadinBundleJsonPath, { encoding: 'utf8' }));
|
||||
} catch (e: unknown) {
|
||||
if (typeof e === 'object' && (e as { code: string }).code === 'MODULE_NOT_FOUND') {
|
||||
vaadinBundleJson = { packages: {} };
|
||||
console.info(`@vaadin/bundles npm package is not found, ${disabledMessage}`);
|
||||
return false;
|
||||
} else {
|
||||
throw e;
|
||||
}
|
||||
}
|
||||
|
||||
const versionMismatches: Array<{ name: string; bundledVersion: string; installedVersion: string }> = [];
|
||||
for (const [name, packageInfo] of Object.entries(vaadinBundleJson.packages)) {
|
||||
let installedVersion: string | undefined = undefined;
|
||||
try {
|
||||
const { version: bundledVersion } = packageInfo;
|
||||
const installedPackageJsonFile = path.resolve(modulesDirectory, name, 'package.json');
|
||||
const packageJson = JSON.parse(readFileSync(installedPackageJsonFile, { encoding: 'utf8' }));
|
||||
installedVersion = packageJson.version;
|
||||
if (installedVersion && installedVersion !== bundledVersion) {
|
||||
versionMismatches.push({
|
||||
name,
|
||||
bundledVersion,
|
||||
installedVersion
|
||||
});
|
||||
}
|
||||
} catch (_) {
|
||||
// ignore package not found
|
||||
}
|
||||
}
|
||||
if (versionMismatches.length) {
|
||||
console.info(`@vaadin/bundles has version mismatches with installed packages, ${disabledMessage}`);
|
||||
console.info(`Packages with version mismatches: ${JSON.stringify(versionMismatches, undefined, 2)}`);
|
||||
vaadinBundleJson = { packages: {} };
|
||||
return false;
|
||||
}
|
||||
|
||||
return true;
|
||||
},
|
||||
async config(config) {
|
||||
return mergeConfig(
|
||||
{
|
||||
optimizeDeps: {
|
||||
exclude: [
|
||||
// Vaadin bundle
|
||||
'@vaadin/bundles',
|
||||
...Object.keys(vaadinBundleJson.packages),
|
||||
'@vaadin/vaadin-material-styles'
|
||||
]
|
||||
}
|
||||
},
|
||||
config
|
||||
);
|
||||
},
|
||||
load(rawId) {
|
||||
const [path, params] = rawId.split('?');
|
||||
if (!path.startsWith(modulesDirectory)) return;
|
||||
|
||||
const id = path.substring(modulesDirectory.length + 1);
|
||||
const bindings = getExports(id);
|
||||
if (bindings === undefined) return;
|
||||
|
||||
const cacheSuffix = params ? `?${params}` : '';
|
||||
const bundlePath = `@vaadin/bundles/vaadin.js${cacheSuffix}`;
|
||||
|
||||
return `import { init as VaadinBundleInit, get as VaadinBundleGet } from '${bundlePath}';
|
||||
await VaadinBundleInit('default');
|
||||
const { ${bindings.map(getImportAssigment).join(', ')} } = (await VaadinBundleGet('./node_modules/${id}'))();
|
||||
export { ${bindings.map(getExportBinding).join(', ')} };`;
|
||||
}
|
||||
};
|
||||
}
|
||||
|
||||
function themePlugin(opts: { devMode: boolean }): PluginOption {
|
||||
const fullThemeOptions = { ...themeOptions, devMode: opts.devMode };
|
||||
return {
|
||||
name: 'vaadin:theme',
|
||||
config() {
|
||||
processThemeResources(fullThemeOptions, console);
|
||||
},
|
||||
configureServer(server) {
|
||||
function handleThemeFileCreateDelete(themeFile: string, stats?: Stats) {
|
||||
if (themeFile.startsWith(themeFolder)) {
|
||||
const changed = path.relative(themeFolder, themeFile);
|
||||
console.debug('Theme file ' + (!!stats ? 'created' : 'deleted'), changed);
|
||||
processThemeResources(fullThemeOptions, console);
|
||||
}
|
||||
}
|
||||
server.watcher.on('add', handleThemeFileCreateDelete);
|
||||
server.watcher.on('unlink', handleThemeFileCreateDelete);
|
||||
},
|
||||
handleHotUpdate(context) {
|
||||
const contextPath = path.resolve(context.file);
|
||||
const themePath = path.resolve(themeFolder);
|
||||
if (contextPath.startsWith(themePath)) {
|
||||
const changed = path.relative(themePath, contextPath);
|
||||
|
||||
console.debug('Theme file changed', changed);
|
||||
|
||||
if (changed.startsWith(settings.themeName)) {
|
||||
processThemeResources(fullThemeOptions, console);
|
||||
}
|
||||
}
|
||||
},
|
||||
async resolveId(id, importer) {
|
||||
// force theme generation if generated theme sources does not yet exist
|
||||
// this may happen for example during Java hot reload when updating
|
||||
// @Theme annotation value
|
||||
if (
|
||||
path.resolve(themeOptions.frontendGeneratedFolder, 'theme.js') === importer &&
|
||||
!existsSync(path.resolve(themeOptions.frontendGeneratedFolder, id))
|
||||
) {
|
||||
console.debug('Generate theme file ' + id + ' not existing. Processing theme resource');
|
||||
processThemeResources(fullThemeOptions, console);
|
||||
return;
|
||||
}
|
||||
if (!id.startsWith(settings.themeFolder)) {
|
||||
return;
|
||||
}
|
||||
for (const location of [themeResourceFolder, frontendFolder]) {
|
||||
const result = await this.resolve(path.resolve(location, id));
|
||||
if (result) {
|
||||
return result;
|
||||
}
|
||||
}
|
||||
},
|
||||
async transform(raw, id, options) {
|
||||
// rewrite urls for the application theme css files
|
||||
const [bareId, query] = id.split('?');
|
||||
if (
|
||||
(!bareId?.startsWith(themeFolder) && !bareId?.startsWith(themeOptions.themeResourceFolder)) ||
|
||||
!bareId?.endsWith('.css')
|
||||
) {
|
||||
return;
|
||||
}
|
||||
const resourceThemeFolder = bareId.startsWith(themeFolder) ? themeFolder : themeOptions.themeResourceFolder;
|
||||
const [themeName] = bareId.substring(resourceThemeFolder.length + 1).split('/');
|
||||
return rewriteCssUrls(raw, path.dirname(bareId), path.resolve(resourceThemeFolder, themeName), console, opts);
|
||||
}
|
||||
};
|
||||
}
|
||||
|
||||
function runWatchDog(watchDogPort: number, watchDogHost: string | undefined) {
|
||||
const client = new net.Socket();
|
||||
client.setEncoding('utf8');
|
||||
client.on('error', function (err) {
|
||||
console.log('Watchdog connection error. Terminating vite process...', err);
|
||||
client.destroy();
|
||||
process.exit(0);
|
||||
});
|
||||
client.on('close', function () {
|
||||
client.destroy();
|
||||
runWatchDog(watchDogPort, watchDogHost);
|
||||
});
|
||||
|
||||
client.connect(watchDogPort, watchDogHost || 'localhost');
|
||||
}
|
||||
|
||||
const allowedFrontendFolders = [frontendFolder, nodeModulesFolder];
|
||||
|
||||
function showRecompileReason(): PluginOption {
|
||||
return {
|
||||
name: 'vaadin:why-you-compile',
|
||||
handleHotUpdate(context) {
|
||||
console.log('Recompiling because', context.file, 'changed');
|
||||
}
|
||||
};
|
||||
}
|
||||
|
||||
const DEV_MODE_START_REGEXP = /\/\*[\*!]\s+vaadin-dev-mode:start/;
|
||||
const DEV_MODE_CODE_REGEXP = /\/\*[\*!]\s+vaadin-dev-mode:start([\s\S]*)vaadin-dev-mode:end\s+\*\*\//i;
|
||||
|
||||
function preserveUsageStats() {
|
||||
return {
|
||||
name: 'vaadin:preserve-usage-stats',
|
||||
|
||||
transform(src: string, id: string) {
|
||||
if (id.includes('vaadin-usage-statistics')) {
|
||||
if (src.includes('vaadin-dev-mode:start')) {
|
||||
const newSrc = src.replace(DEV_MODE_START_REGEXP, '/*! vaadin-dev-mode:start');
|
||||
if (newSrc === src) {
|
||||
console.error('Comment replacement failed to change anything');
|
||||
} else if (!newSrc.match(DEV_MODE_CODE_REGEXP)) {
|
||||
console.error('New comment fails to match original regexp');
|
||||
} else {
|
||||
return { code: newSrc };
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
return { code: src };
|
||||
}
|
||||
};
|
||||
}
|
||||
|
||||
export const vaadinConfig: UserConfigFn = (env) => {
|
||||
const devMode = env.mode === 'development';
|
||||
const productionMode = !devMode && !devBundle
|
||||
|
||||
if (devMode && process.env.watchDogPort) {
|
||||
// Open a connection with the Java dev-mode handler in order to finish
|
||||
// vite when it exits or crashes.
|
||||
runWatchDog(parseInt(process.env.watchDogPort), process.env.watchDogHost);
|
||||
}
|
||||
|
||||
return {
|
||||
root: frontendFolder,
|
||||
base: '',
|
||||
publicDir: false,
|
||||
resolve: {
|
||||
alias: {
|
||||
'@vaadin/flow-frontend': jarResourcesFolder,
|
||||
Frontend: frontendFolder
|
||||
},
|
||||
preserveSymlinks: true
|
||||
},
|
||||
define: {
|
||||
OFFLINE_PATH: settings.offlinePath,
|
||||
VITE_ENABLED: 'true'
|
||||
},
|
||||
server: {
|
||||
host: '127.0.0.1',
|
||||
strictPort: true,
|
||||
fs: {
|
||||
allow: allowedFrontendFolders
|
||||
}
|
||||
},
|
||||
build: {
|
||||
minify: productionMode,
|
||||
outDir: buildOutputFolder,
|
||||
emptyOutDir: devBundle,
|
||||
assetsDir: 'VAADIN/build',
|
||||
target: ['safari15', 'es2022'],
|
||||
rollupOptions: {
|
||||
input: {
|
||||
indexhtml: projectIndexHtml,
|
||||
|
||||
...(hasExportedWebComponents ? { webcomponenthtml: path.resolve(frontendFolder, 'web-component.html') } : {})
|
||||
},
|
||||
onwarn: (warning: rollup.RollupLog, defaultHandler: rollup.LoggingFunction) => {
|
||||
const ignoreEvalWarning = [
|
||||
'generated/jar-resources/FlowClient.js',
|
||||
'generated/jar-resources/vaadin-spreadsheet/spreadsheet-export.js',
|
||||
'@vaadin/charts/src/helpers.js'
|
||||
];
|
||||
if (warning.code === 'EVAL' && warning.id && !!ignoreEvalWarning.find((id) => warning.id?.endsWith(id))) {
|
||||
return;
|
||||
}
|
||||
defaultHandler(warning);
|
||||
}
|
||||
}
|
||||
},
|
||||
optimizeDeps: {
|
||||
entries: [
|
||||
// Pre-scan entrypoints in Vite to avoid reloading on first open
|
||||
'generated/vaadin.ts'
|
||||
],
|
||||
exclude: [
|
||||
'@vaadin/router',
|
||||
'@vaadin/vaadin-license-checker',
|
||||
'@vaadin/vaadin-usage-statistics',
|
||||
'workbox-core',
|
||||
'workbox-precaching',
|
||||
'workbox-routing',
|
||||
'workbox-strategies'
|
||||
]
|
||||
},
|
||||
plugins: [
|
||||
productionMode && brotli(),
|
||||
devMode && vaadinBundlesPlugin(),
|
||||
devMode && showRecompileReason(),
|
||||
settings.offlineEnabled && buildSWPlugin({ devMode }),
|
||||
!devMode && statsExtracterPlugin(),
|
||||
!productionMode && preserveUsageStats(),
|
||||
themePlugin({ devMode }),
|
||||
postcssLit({
|
||||
include: ['**/*.css', /.*\/.*\.css\?.*/],
|
||||
exclude: [
|
||||
`${themeFolder}/**/*.css`,
|
||||
new RegExp(`${themeFolder}/.*/.*\\.css\\?.*`),
|
||||
`${themeResourceFolder}/**/*.css`,
|
||||
new RegExp(`${themeResourceFolder}/.*/.*\\.css\\?.*`),
|
||||
new RegExp('.*/.*\\?html-proxy.*')
|
||||
]
|
||||
}),
|
||||
// The React plugin provides fast refresh and debug source info
|
||||
reactPlugin({
|
||||
include: '**/*.tsx',
|
||||
babel: {
|
||||
// We need to use babel to provide the source information for it to be correct
|
||||
// (otherwise Babel will slightly rewrite the source file and esbuild generate source info for the modified file)
|
||||
presets: [
|
||||
[
|
||||
'@babel/preset-react',
|
||||
{
|
||||
runtime: 'automatic',
|
||||
importSource: productionMode ? 'react' : 'Frontend/generated/jsx-dev-transform',
|
||||
development: !productionMode
|
||||
}
|
||||
]
|
||||
],
|
||||
// React writes the source location for where components are used, this writes for where they are defined
|
||||
plugins: [
|
||||
!productionMode && addFunctionComponentSourceLocationBabel(),
|
||||
[
|
||||
'module:@preact/signals-react-transform',
|
||||
{
|
||||
mode: 'all' // Needed to include translations which do not use something.value
|
||||
}
|
||||
]
|
||||
].filter(Boolean)
|
||||
}
|
||||
}),
|
||||
{
|
||||
name: 'vaadin:force-remove-html-middleware',
|
||||
configureServer(server) {
|
||||
return () => {
|
||||
server.middlewares.stack = server.middlewares.stack.filter((mw) => {
|
||||
const handleName = `${mw.handle}`;
|
||||
return !handleName.includes('viteHtmlFallbackMiddleware');
|
||||
});
|
||||
};
|
||||
},
|
||||
},
|
||||
hasExportedWebComponents && {
|
||||
name: 'vaadin:inject-entrypoints-to-web-component-html',
|
||||
transformIndexHtml: {
|
||||
order: 'pre',
|
||||
handler(_html, { path, server }) {
|
||||
if (path !== '/web-component.html') {
|
||||
return;
|
||||
}
|
||||
|
||||
return [
|
||||
{
|
||||
tag: 'script',
|
||||
attrs: { type: 'module', src: `/generated/vaadin-web-component.ts` },
|
||||
injectTo: 'head'
|
||||
}
|
||||
];
|
||||
}
|
||||
}
|
||||
},
|
||||
{
|
||||
name: 'vaadin:inject-entrypoints-to-index-html',
|
||||
transformIndexHtml: {
|
||||
order: 'pre',
|
||||
handler(_html, { path, server }) {
|
||||
if (path !== '/index.html') {
|
||||
return;
|
||||
}
|
||||
|
||||
const scripts = [];
|
||||
|
||||
if (devMode) {
|
||||
scripts.push({
|
||||
tag: 'script',
|
||||
attrs: { type: 'module', src: `/generated/vite-devmode.ts`, onerror: "document.location.reload()" },
|
||||
injectTo: 'head'
|
||||
});
|
||||
}
|
||||
scripts.push({
|
||||
tag: 'script',
|
||||
attrs: { type: 'module', src: '/generated/vaadin.ts' },
|
||||
injectTo: 'head'
|
||||
});
|
||||
return scripts;
|
||||
}
|
||||
}
|
||||
},
|
||||
checker({
|
||||
typescript: true
|
||||
}),
|
||||
productionMode && visualizer({ brotliSize: true, filename: bundleSizeFile })
|
||||
|
||||
]
|
||||
};
|
||||
};
|
||||
|
||||
export const overrideVaadinConfig = (customConfig: UserConfigFn) => {
|
||||
return defineConfig((env) => mergeConfig(vaadinConfig(env), customConfig(env)));
|
||||
};
|
||||
function getVersion(module: string): string {
|
||||
const packageJson = path.resolve(nodeModulesFolder, module, 'package.json');
|
||||
return JSON.parse(readFileSync(packageJson, { encoding: 'utf-8' })).version;
|
||||
}
|
||||
function getCvdlName(module: string): string {
|
||||
const packageJson = path.resolve(nodeModulesFolder, module, 'package.json');
|
||||
return JSON.parse(readFileSync(packageJson, { encoding: 'utf-8' })).cvdlName;
|
||||
}
|
||||
Reference in New Issue
Block a user