mirror of
https://github.com/gotenberg/gotenberg.git
synced 2026-08-10 01:22:14 +01:00
feat(pdfengines): redesign Factur-X API with dedicated form fields
This commit is contained in:
Julien Neuhart
@@ -26,6 +26,10 @@ const (
|
||||
|
||||
// StampFormField represents the form field name for the stamp file.
|
||||
StampFormField string = "stamp"
|
||||
|
||||
// FacturXXmlFormField represents the form field name for the Factur-X CII
|
||||
// invoice XML file.
|
||||
FacturXXmlFormField string = "facturxXml"
|
||||
)
|
||||
|
||||
// FormData is a helper for validating and hydrating values from a
|
||||
@@ -424,89 +428,6 @@ func (form *FormData) EmbedsMetadata(target *map[string]map[string]string) *Form
|
||||
return form
|
||||
}
|
||||
|
||||
// FacturX parses the "facturx" form field (a JSON string) into a
|
||||
// [gotenberg.FacturX]. The "conformanceLevel" property is mandatory; the
|
||||
// "documentType", "version", and "documentFileName" properties default to
|
||||
// "INVOICE", "1.0", and "factur-x.xml" respectively. It leaves the target
|
||||
// untouched when the field is absent.
|
||||
//
|
||||
// var facturX gotenberg.FacturX
|
||||
//
|
||||
// ctx.FormData().FacturX(&facturX, false)
|
||||
func (form *FormData) FacturX(target *gotenberg.FacturX, mandatory bool) *FormData {
|
||||
if form.errors != nil {
|
||||
return form
|
||||
}
|
||||
|
||||
val, ok := form.values["facturx"]
|
||||
if !ok || len(val) == 0 || val[0] == "" {
|
||||
if mandatory {
|
||||
form.append(fmt.Errorf("form field '%s' is required", "facturx"))
|
||||
}
|
||||
return form
|
||||
}
|
||||
|
||||
var parsed struct {
|
||||
ConformanceLevel string `json:"conformanceLevel"`
|
||||
DocumentType string `json:"documentType"`
|
||||
DocumentFileName string `json:"documentFileName"`
|
||||
Version string `json:"version"`
|
||||
}
|
||||
|
||||
err := json.Unmarshal([]byte(val[0]), &parsed)
|
||||
if err != nil {
|
||||
form.append(fmt.Errorf("form field 'facturx' is invalid: %w", err))
|
||||
return form
|
||||
}
|
||||
|
||||
facturX := gotenberg.FacturX{
|
||||
ConformanceLevel: parsed.ConformanceLevel,
|
||||
DocumentType: parsed.DocumentType,
|
||||
DocumentFileName: parsed.DocumentFileName,
|
||||
Version: parsed.Version,
|
||||
}
|
||||
|
||||
if facturX.DocumentType == "" {
|
||||
facturX.DocumentType = gotenberg.FacturXDocumentTypeInvoice
|
||||
}
|
||||
|
||||
if facturX.Version == "" {
|
||||
facturX.Version = "1.0"
|
||||
}
|
||||
|
||||
if facturX.DocumentFileName == "" {
|
||||
facturX.DocumentFileName = "factur-x.xml"
|
||||
}
|
||||
|
||||
switch facturX.ConformanceLevel {
|
||||
case gotenberg.FacturXConformanceMinimum,
|
||||
gotenberg.FacturXConformanceBasicWL,
|
||||
gotenberg.FacturXConformanceBasic,
|
||||
gotenberg.FacturXConformanceEN16931,
|
||||
gotenberg.FacturXConformanceExtended,
|
||||
gotenberg.FacturXConformanceXRechnung:
|
||||
case "":
|
||||
form.append(errors.New("form field 'facturx' is invalid: 'conformanceLevel' is required"))
|
||||
return form
|
||||
default:
|
||||
form.append(fmt.Errorf("form field 'facturx' is invalid: unsupported 'conformanceLevel' '%s'", facturX.ConformanceLevel))
|
||||
return form
|
||||
}
|
||||
|
||||
switch facturX.DocumentType {
|
||||
case gotenberg.FacturXDocumentTypeInvoice,
|
||||
gotenberg.FacturXDocumentTypeOrder,
|
||||
gotenberg.FacturXDocumentTypeOrderResponse,
|
||||
gotenberg.FacturXDocumentTypeOrderChange:
|
||||
default:
|
||||
form.append(fmt.Errorf("form field 'facturx' is invalid: unsupported 'documentType' '%s'", facturX.DocumentType))
|
||||
return form
|
||||
}
|
||||
|
||||
*target = facturX
|
||||
return form
|
||||
}
|
||||
|
||||
// MandatoryPaths binds the absolute paths of form data files, according to a
|
||||
// list of file extensions, to a string slice variable. It populates an error
|
||||
// if there is no file for given file extensions.
|
||||
@@ -558,13 +479,28 @@ func (form *FormData) Stamp(target *string) *FormData {
|
||||
return form
|
||||
}
|
||||
|
||||
// FacturXXml binds the absolute path of the uploaded Factur-X CII invoice
|
||||
// XML. Only a file uploaded with the "facturxXml" field name is included.
|
||||
func (form *FormData) FacturXXml(target *string) *FormData {
|
||||
if form.errors != nil {
|
||||
return form
|
||||
}
|
||||
|
||||
if paths, ok := form.filesByField[FacturXXmlFormField]; ok && len(paths) > 0 {
|
||||
*target = paths[0]
|
||||
}
|
||||
|
||||
return form
|
||||
}
|
||||
|
||||
// paths bind the absolute paths of form data files, according to a list of
|
||||
// file extensions, to a string slice variable.
|
||||
// embeds, watermark, and stamp files are excluded.
|
||||
// embeds, watermark, stamp, and facturxXml files are excluded.
|
||||
func (form *FormData) paths(extensions []string, target *[]string) *FormData {
|
||||
embeds, ok := form.filesByField[EmbedsFormField]
|
||||
watermarks, wmOk := form.filesByField[WatermarkFormField]
|
||||
stamps, stOk := form.filesByField[StampFormField]
|
||||
facturxXmls, fxOk := form.filesByField[FacturXXmlFormField]
|
||||
|
||||
// Collect (originalFilename, diskPath) pairs so that we can sort by
|
||||
// original filename rather than by UUID-based disk name.
|
||||
@@ -588,6 +524,10 @@ func (form *FormData) paths(extensions []string, target *[]string) *FormData {
|
||||
continue
|
||||
}
|
||||
|
||||
if fxOk && slices.Contains(facturxXmls, path) {
|
||||
continue
|
||||
}
|
||||
|
||||
for _, ext := range extensions {
|
||||
// See https://github.com/gotenberg/gotenberg/issues/228.
|
||||
if strings.ToLower(filepath.Ext(filename)) == ext {
|
||||
|
||||
@@ -7,8 +7,6 @@ import (
|
||||
"reflect"
|
||||
"testing"
|
||||
"time"
|
||||
|
||||
"github.com/gotenberg/gotenberg/v8/pkg/gotenberg"
|
||||
)
|
||||
|
||||
func TestFormData_Validate(t *testing.T) {
|
||||
@@ -1786,110 +1784,56 @@ func TestFormData_Embeds(t *testing.T) {
|
||||
}
|
||||
}
|
||||
|
||||
func TestFormData_FacturX(t *testing.T) {
|
||||
func TestFormData_FacturXXml(t *testing.T) {
|
||||
for _, tc := range []struct {
|
||||
scenario string
|
||||
form *FormData
|
||||
mandatory bool
|
||||
expect gotenberg.FacturX
|
||||
expectErr bool
|
||||
scenario string
|
||||
form *FormData
|
||||
expect string
|
||||
}{
|
||||
{
|
||||
scenario: "key does not exist, not mandatory",
|
||||
form: &FormData{},
|
||||
mandatory: false,
|
||||
expect: gotenberg.FacturX{},
|
||||
scenario: "no facturxXml file",
|
||||
form: &FormData{},
|
||||
expect: "",
|
||||
},
|
||||
{
|
||||
scenario: "key does not exist, mandatory",
|
||||
form: &FormData{},
|
||||
mandatory: true,
|
||||
expectErr: true,
|
||||
},
|
||||
{
|
||||
scenario: "all fields provided",
|
||||
scenario: "facturxXml file present",
|
||||
form: &FormData{
|
||||
values: map[string][]string{
|
||||
"facturx": {`{"conformanceLevel":"EXTENDED","documentType":"ORDER","documentFileName":"order.xml","version":"2.0"}`},
|
||||
filesByField: map[string][]string{
|
||||
FacturXXmlFormField: {"/tmp/abc/12345.xml"},
|
||||
},
|
||||
},
|
||||
expect: gotenberg.FacturX{
|
||||
ConformanceLevel: gotenberg.FacturXConformanceExtended,
|
||||
DocumentType: gotenberg.FacturXDocumentTypeOrder,
|
||||
DocumentFileName: "order.xml",
|
||||
Version: "2.0",
|
||||
},
|
||||
},
|
||||
{
|
||||
scenario: "only conformance level, defaults applied",
|
||||
form: &FormData{
|
||||
values: map[string][]string{
|
||||
"facturx": {`{"conformanceLevel":"EN 16931"}`},
|
||||
},
|
||||
},
|
||||
expect: gotenberg.FacturX{
|
||||
ConformanceLevel: gotenberg.FacturXConformanceEN16931,
|
||||
DocumentType: gotenberg.FacturXDocumentTypeInvoice,
|
||||
DocumentFileName: "factur-x.xml",
|
||||
Version: "1.0",
|
||||
},
|
||||
},
|
||||
{
|
||||
scenario: "invalid JSON",
|
||||
form: &FormData{
|
||||
values: map[string][]string{
|
||||
"facturx": {`{not json`},
|
||||
},
|
||||
},
|
||||
expectErr: true,
|
||||
},
|
||||
{
|
||||
scenario: "missing conformance level",
|
||||
form: &FormData{
|
||||
values: map[string][]string{
|
||||
"facturx": {`{"documentType":"INVOICE"}`},
|
||||
},
|
||||
},
|
||||
expectErr: true,
|
||||
},
|
||||
{
|
||||
scenario: "unsupported conformance level",
|
||||
form: &FormData{
|
||||
values: map[string][]string{
|
||||
"facturx": {`{"conformanceLevel":"FOO"}`},
|
||||
},
|
||||
},
|
||||
expectErr: true,
|
||||
},
|
||||
{
|
||||
scenario: "unsupported document type",
|
||||
form: &FormData{
|
||||
values: map[string][]string{
|
||||
"facturx": {`{"conformanceLevel":"BASIC","documentType":"RECEIPT"}`},
|
||||
},
|
||||
},
|
||||
expectErr: true,
|
||||
expect: "/tmp/abc/12345.xml",
|
||||
},
|
||||
} {
|
||||
t.Run(tc.scenario, func(t *testing.T) {
|
||||
var actual gotenberg.FacturX
|
||||
var actual string
|
||||
|
||||
tc.form.FacturX(&actual, tc.mandatory)
|
||||
tc.form.FacturXXml(&actual)
|
||||
|
||||
if tc.expectErr {
|
||||
if tc.form.errors == nil {
|
||||
t.Error("expected an error but got none")
|
||||
}
|
||||
return
|
||||
}
|
||||
|
||||
if tc.form.errors != nil {
|
||||
t.Errorf("expected no error but got: %v", tc.form.errors)
|
||||
}
|
||||
|
||||
if !reflect.DeepEqual(actual, tc.expect) {
|
||||
t.Errorf("expected %+v but got %+v", tc.expect, actual)
|
||||
if actual != tc.expect {
|
||||
t.Errorf("expected %q but got %q", tc.expect, actual)
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
// TestFormData_paths_excludesFacturXXml verifies that an uploaded facturxXml is
|
||||
// never picked up as an input document by paths().
|
||||
func TestFormData_paths_excludesFacturXXml(t *testing.T) {
|
||||
form := &FormData{
|
||||
files: map[string]string{
|
||||
"document.xml": "/tmp/abc/document.xml",
|
||||
"factur-x.xml": "/tmp/abc/invoice.xml",
|
||||
},
|
||||
filesByField: map[string][]string{
|
||||
FacturXXmlFormField: {"/tmp/abc/invoice.xml"},
|
||||
},
|
||||
}
|
||||
|
||||
var paths []string
|
||||
form.paths([]string{".xml"}, &paths)
|
||||
|
||||
if len(paths) != 1 || paths[0] != "/tmp/abc/document.xml" {
|
||||
t.Errorf("expected only the non-Factur-X .xml document, got %+v", paths)
|
||||
}
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user