Added Attachment to org package

CHANGELOG.md

@@ -16,6 +16,9 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/) and this p
 - `cbc`: `Key.Pop` method for splitting keys with sub-keys, e.g. `cbc.Key("a+b").Pop() == cbc.Key("a")`.
 - `in`: added Indian regime
 - `cef`: catalogue for CEF VATEX reason codes.
+- `org`: `Attachment` new structure for dealing with attachments.
+- `bill`: `Attachments` added to invoices.
+- `eu-en16931-v2017`: addon now includes additional validation for attachment codes.
 
 ### Changed
 

addons/eu/en16931/en16931.go

@@ -6,6 +6,7 @@
 	"github.com/invopop/gobl/bill"
 	"github.com/invopop/gobl/cbc"
 	"github.com/invopop/gobl/i18n"
+	"github.com/invopop/gobl/org"
 	"github.com/invopop/gobl/pay"
 	"github.com/invopop/gobl/pkg/here"
 	"github.com/invopop/gobl/tax"
@@ -69,6 +70,8 @@
 		return validateBillInvoice(obj)
 	case *tax.Combo:
 		return validateTaxCombo(obj)
+	case *org.Attachment:
+		return validateOrgAttachment(obj)
 	}
 	return nil
 }

addons/eu/en16931/org.go

@@ -0,0 +1,15 @@
+package en16931
+
+import (
+	"github.com/invopop/gobl/org"
+	"github.com/invopop/validation"
+)
+
+func validateOrgAttachment(a *org.Attachment) error {
+	return validation.ValidateStruct(a,
+		validation.Field(&a.Code,
+			validation.Required,
+			validation.Skip,
+		),
+	)
+}

bill/invoice.go

@@ -96,6 +96,11 @@ type Invoice struct {
 
 	// Additional semi-structured data that doesn't fit into the body of the invoice.
 	Meta cbc.Meta `json:"meta,omitempty" jsonschema:"title=Meta"`
+
+	// Attachments provide additional information or supporting documents that are not included
+	// in the main document. It is important that attachments are not used for alternative
+	// versions of the PDF, for that, see "links" inside the envelope headers.
+	Attachments []*org.Attachment `json:"attachments,omitempty" jsonschema:"title=Attachments"`
 }
 
 // Validate checks to ensure the invoice is valid and contains all the information we need.

internal/cli/bulk_test.go

@@ -648,7 +648,7 @@ func TestBulk(t *testing.T) { //nolint:gocyclo
 				// Following raw message is copied and pasted! (sorry!)
 				Payload: json.RawMessage(`{
 					"list": [
-						"https://gobl.org/draft-0/bill/correction-options", "https://gobl.org/draft-0/bill/invoice", "https://gobl.org/draft-0/cal/date", "https://gobl.org/draft-0/cal/date-time", "https://gobl.org/draft-0/cal/period", "https://gobl.org/draft-0/cbc/code", "https://gobl.org/draft-0/cbc/code-map", "https://gobl.org/draft-0/cbc/definition", "https://gobl.org/draft-0/cbc/key", "https://gobl.org/draft-0/cbc/meta", "https://gobl.org/draft-0/cbc/note", "https://gobl.org/draft-0/currency/amount", "https://gobl.org/draft-0/currency/code", "https://gobl.org/draft-0/currency/exchange-rate", "https://gobl.org/draft-0/dsig/digest", "https://gobl.org/draft-0/dsig/signature", "https://gobl.org/draft-0/envelope", "https://gobl.org/draft-0/head/header", "https://gobl.org/draft-0/head/link", "https://gobl.org/draft-0/head/stamp", "https://gobl.org/draft-0/i18n/string", "https://gobl.org/draft-0/l10n/code", "https://gobl.org/draft-0/l10n/iso-country-code", "https://gobl.org/draft-0/l10n/tax-country-code", "https://gobl.org/draft-0/note/message", "https://gobl.org/draft-0/num/amount", "https://gobl.org/draft-0/num/percentage", "https://gobl.org/draft-0/org/address", "https://gobl.org/draft-0/org/coordinates", "https://gobl.org/draft-0/org/document-ref", "https://gobl.org/draft-0/org/email", "https://gobl.org/draft-0/org/identity", "https://gobl.org/draft-0/org/image", "https://gobl.org/draft-0/org/inbox", "https://gobl.org/draft-0/org/item", "https://gobl.org/draft-0/org/name", "https://gobl.org/draft-0/org/party", "https://gobl.org/draft-0/org/person", "https://gobl.org/draft-0/org/registration", "https://gobl.org/draft-0/org/telephone", "https://gobl.org/draft-0/org/unit", "https://gobl.org/draft-0/org/website", "https://gobl.org/draft-0/pay/advance", "https://gobl.org/draft-0/pay/instructions", "https://gobl.org/draft-0/pay/terms", "https://gobl.org/draft-0/regimes/mx/food-vouchers", "https://gobl.org/draft-0/regimes/mx/fuel-account-balance", "https://gobl.org/draft-0/schema/object", "https://gobl.org/draft-0/tax/addon-def", "https://gobl.org/draft-0/tax/catalogue-def", "https://gobl.org/draft-0/tax/extensions", "https://gobl.org/draft-0/tax/identity", "https://gobl.org/draft-0/tax/regime-def", "https://gobl.org/draft-0/tax/set", "https://gobl.org/draft-0/tax/total"
+						"https://gobl.org/draft-0/bill/correction-options", "https://gobl.org/draft-0/bill/invoice", "https://gobl.org/draft-0/cal/date", "https://gobl.org/draft-0/cal/date-time", "https://gobl.org/draft-0/cal/period", "https://gobl.org/draft-0/cbc/code", "https://gobl.org/draft-0/cbc/code-map", "https://gobl.org/draft-0/cbc/definition", "https://gobl.org/draft-0/cbc/key", "https://gobl.org/draft-0/cbc/meta", "https://gobl.org/draft-0/cbc/note", "https://gobl.org/draft-0/currency/amount", "https://gobl.org/draft-0/currency/code", "https://gobl.org/draft-0/currency/exchange-rate", "https://gobl.org/draft-0/dsig/digest", "https://gobl.org/draft-0/dsig/signature", "https://gobl.org/draft-0/envelope", "https://gobl.org/draft-0/head/header", "https://gobl.org/draft-0/head/link", "https://gobl.org/draft-0/head/stamp", "https://gobl.org/draft-0/i18n/string", "https://gobl.org/draft-0/l10n/code", "https://gobl.org/draft-0/l10n/iso-country-code", "https://gobl.org/draft-0/l10n/tax-country-code", "https://gobl.org/draft-0/note/message", "https://gobl.org/draft-0/num/amount", "https://gobl.org/draft-0/num/percentage", "https://gobl.org/draft-0/org/address", "https://gobl.org/draft-0/org/attachment", "https://gobl.org/draft-0/org/coordinates", "https://gobl.org/draft-0/org/document-ref", "https://gobl.org/draft-0/org/email", "https://gobl.org/draft-0/org/identity", "https://gobl.org/draft-0/org/image", "https://gobl.org/draft-0/org/inbox", "https://gobl.org/draft-0/org/item", "https://gobl.org/draft-0/org/name", "https://gobl.org/draft-0/org/party", "https://gobl.org/draft-0/org/person", "https://gobl.org/draft-0/org/registration", "https://gobl.org/draft-0/org/telephone", "https://gobl.org/draft-0/org/unit", "https://gobl.org/draft-0/org/website", "https://gobl.org/draft-0/pay/advance", "https://gobl.org/draft-0/pay/instructions", "https://gobl.org/draft-0/pay/terms", "https://gobl.org/draft-0/regimes/mx/food-vouchers", "https://gobl.org/draft-0/regimes/mx/fuel-account-balance", "https://gobl.org/draft-0/schema/object", "https://gobl.org/draft-0/tax/addon-def", "https://gobl.org/draft-0/tax/catalogue-def", "https://gobl.org/draft-0/tax/extensions", "https://gobl.org/draft-0/tax/identity", "https://gobl.org/draft-0/tax/regime-def", "https://gobl.org/draft-0/tax/set", "https://gobl.org/draft-0/tax/total"
 					]
 				}`),
 				IsFinal: false,

org/attachment.go

@@ -0,0 +1,97 @@
+package org
+
+import (
+	"context"
+
+	"github.com/invopop/gobl/cbc"
+	"github.com/invopop/gobl/dsig"
+	"github.com/invopop/gobl/tax"
+	"github.com/invopop/gobl/uuid"
+	"github.com/invopop/validation"
+	"github.com/invopop/validation/is"
+)
+
+// An Attachment provides a structure to be used to attach documents
+// inside a GOBL document, either as a reference via a URL, or directly
+// as a base64 encoded string.
+//
+// Attachments must not be used to include alternative versions of the
+// same document, but rather include supporting documents or additional
+// information that is not included in the main document.
+//
+// While it is possible to include the data directly in the JSON document,
+// it is recommended to use the URL field to link to the document instead.
+type Attachment struct {
+	uuid.Identify
+
+	// Key used to identify the attachment inside the document.
+	Key cbc.Key `json:"key,omitempty" jsonschema:"title=Key"`
+
+	// Code used to identify the payload of the attachment.
+	Code cbc.Code `json:"code,omitempty" jsonschema:"title=Code"`
+
+	// Filename of the attachment.
+	Name string `json:"name" jsonschema:"title=Name"`
+
+	// Details of why the attachment is being included and details on
+	// what it contains.
+	Description string `json:"description,omitempty" jsonschema:"title=Description"`
+
+	// URL of where to find the attachment. Prefer using this field
+	// over the Data field.
+	URL string `json:"url,omitempty" jsonschema:"title=URL,format=uri"`
+
+	// Digest is used to verify the integrity of the attachment
+	// when downloaded from the URL.
+	Digest *dsig.Digest `json:"digest,omitempty" jsonschema:"title=Digest"`
+
+	// MIME type of the attachment.
+	MIME string `json:"mime,omitempty" jsonschema:"title=MIME Type"`
+
+	// Data is the base64 encoded data of the attachment directly embedded
+	// inside the GOBL document. This should only be used when the URL cannot
+	// be used as it can dramatically increase the size of the JSON
+	// document, thus effectiving usability and performance.
+	Data []byte `json:"data,omitempty" jsonschema:"title=Data"`
+}
+
+// Validate checks that the attachment looks okay.
+func (a *Attachment) Validate() error {
+	return a.ValidateWithContext(context.Background())
+}
+
+// ValidateWithContext checks that the attachment looks okay within
+// the provided context.
+func (a *Attachment) ValidateWithContext(ctx context.Context) error {
+	return tax.ValidateStructWithContext(ctx, a,
+		validation.Field(&a.Key),
+		validation.Field(&a.Code),
+		validation.Field(&a.Name, validation.Required),
+		validation.Field(&a.Description),
+		validation.Field(&a.URL,
+			is.URL,
+			validation.When(
+				len(a.Data) == 0,
+				validation.Required,
+			),
+		),
+		validation.Field(&a.Data,
+			validation.When(
+				len(a.URL) > 0,
+				validation.Empty.Error("must be blank with url"),
+			),
+		),
+		validation.Field(&a.Digest),
+		validation.Field(&a.MIME,
+			// MIME types as defined by EN 16931-1:2017
+			validation.In(
+				"application/pdf",
+				"image/jpeg",
+				"image/png",
+				"test/csv",
+				"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet",
+				"applicaiton/vnd.oasis.opendocument.spreadsheet",
+			),
+		),
+	)
+}

org/attachment_test.go

@@ -0,0 +1,43 @@
+package org_test
+
+import (
+	"testing"
+
+	"github.com/invopop/gobl/org"
+	"github.com/stretchr/testify/assert"
+)
+
+func TestAttachmentValidation(t *testing.T) {
+	t.Run("valid", func(t *testing.T) {
+		a := &org.Attachment{
+			Key:  "key",
+			Code: "ABC",
+			Name: "test.txt",
+			URL:  "https://example.com/test.txt",
+		}
+		err := a.Validate()
+		assert.NoError(t, err)
+	})
+
+	t.Run("both URL and data", func(t *testing.T) {
+		a := &org.Attachment{
+			Key:  "key",
+			Code: "ABC",
+			Name: "test.txt",
+			URL:  "https://example.com/test.txt",
+			Data: []byte("test"),
+		}
+		err := a.Validate()
+		assert.ErrorContains(t, err, "data: must be blank with url")
+	})
+
+	t.Run("missing URL and data", func(t *testing.T) {
+		a := &org.Attachment{
+			Key:  "key",
+			Code: "ABC",
+			Name: "test.txt",
+		}
+		err := a.Validate()
+		assert.ErrorContains(t, err, "url: cannot be blank")
+	})
+}

org/org.go

@@ -20,5 +20,6 @@ func init() {
 		Telephone{},
 		Unit(""),
 		Website{},
+		Attachment{},
 	)
 }