@ekwo-ai/peppol-ubl 0.11.0 → 0.12.0

package/CHANGELOG.md

@@ -7,6 +7,21 @@ All notable changes to this project are documented here. The format follows
 ## [Unreleased]
 
 ### Added
+- **Reading a received invoice.** `readUbl()` reads a UBL 2.1 `Invoice` or
+  `CreditNote`, bare or in the envelope of an access point, into a
+  `ReceivedInvoice`: parties with their schemes, dates, references, lines, VAT
+  breakdown, totals, payment means and the documents attached, an embedded PDF
+  as bytes. Figures stay the decimal text the file wrote; the arithmetic of
+  EN 16931 (BR-CO-10 to BR-CO-17) is reported in `violations`, never
+  corrected. A file that is not an invoice throws an `InvoiceFileError` with a
+  code, read by a strict XML reader of the package's own (no DOCTYPE, size,
+  depth and element limits). `@ekwo-ai/factur-x` returns the same shape from
+  CII.
+- **Participant identifiers.** `validateParticipantId()` checks a Peppol
+  participant identifier — scheme of the EAS list Peppol delivers to, numeric
+  or symbolic spelling, and the check digits of seven schemes whose rule is
+  published. `smlHostname()` computes the DNS name of a participant on an SML,
+  for the CNAME and the NAPTR lookups, without any network call.
 - **The first version.** A sales invoice or credit note as Peppol BIS Billing
   3.0 (UBL 2.1), from a posted document as three row shapes — header, lines,
   VAT breakdown — with the figures written as they were posted and never

package/README.md

@@ -21,7 +21,8 @@ VAT rounded once per tax. They are declared in this package's own types, so
 any invoicing system that can produce the same three things can use it. It
 reads no database and knows no accounting.
 
-Writing the file is all it does. **Sending it takes a certified access point**,
+Writing the file, and [reading one received](#reading), is all it does.
+**Sending it takes a certified access point**,
 a certificate and somebody on call, and this package has none of the three: you
 get the same UBL anybody gets, and you send it through the access point you
 chose.
@@ -229,6 +230,93 @@ against it found what reading had not:
   found it to be an address scheme, which for two of the four countries that
   declare this profile is not an ISO 6523 identifier scheme at all (BR-CL-11).
 
+## Reading
+
+The other half of e-invoicing: the invoice a supplier sends you, turned into a
+plain object a purchase draft can be made from.
+
+```ts
+import { readUbl, InvoiceFileError } from '@ekwo-ai/peppol-ubl';
+
+const { invoice, violations } = readUbl(bytesOrText);
+invoice.kind;            // 'invoice' | 'credit_note'
+invoice.seller.vatId;    // 'BE0999999031'
+invoice.totals.payable;  // '648.40', a decimal as text, never a number
+invoice.attachments[0];  // { filename: 'RCV-2026-0107.pdf', mimeType: 'application/pdf', content: Uint8Array, … }
+```
+
+`readUbl(input: string | Uint8Array, options?: ReadOptions): ReceivedInvoiceFile`
+reads a UBL 2.1 `Invoice` or `CreditNote` — bare, or inside the
+`StandardBusinessDocument` envelope an access point hands it over in — and
+returns a `ReceivedInvoice`: the seller and the buyer (legal and trading
+names, VAT and legal identifiers, electronic addresses with their schemes,
+postal addresses, contacts), number, type code, dates, currency, references,
+notes, lines (quantity and unit, net amount, prices, VAT category and rate,
+item identifiers), document allowances and charges, the VAT breakdown, the
+totals, the payment means (an IBAN, told from another account by its check
+digits) and the documents attached — an embedded PDF comes back as bytes, with
+its MIME type and its file name. Every field names the business term of
+EN 16931 it holds.
+
+**The shape is shared.** `@ekwo-ai/factur-x` returns the same
+`ReceivedInvoice` from a CII invoice (`readCii`, `readFacturX`), so whoever
+turns a received invoice into a purchase does it once for both syntaxes. The
+two bricks hold byte-for-byte copies of the files that define it, and a test
+keeps them identical.
+
+**Nothing is recomputed, nothing is defaulted.** A figure is the text the file
+wrote, checked to be a decimal, compared on exact decimals; an absent element
+is `null`. The arithmetic of EN 16931 (BR-CO-10 to BR-CO-17) is checked and
+what does not add up comes back in `violations`, next to the figures as the
+file wrote them. A credit note's figures are positive, as written: the sign is
+`kind`.
+
+**A file that is not an invoice throws an `InvoiceFileError`**, with a `code`:
+`malformed_xml`, `unsupported_encoding` (UTF-8 only), `doctype_forbidden`,
+`undefined_entity`, `too_large`, `too_deep`, `too_many_elements`,
+`not_an_invoice` (another root; a CII file is pointed at the CII reader),
+`missing_element` (no number, date, currency, totals or line), `invalid_value`
+(a date that is not one, an amount that is not a decimal). No raw parser error
+escapes. The XML is read by a strict reader of the package's own — no DOCTYPE
+and so no entity expansion, the five predefined entities only, a size limit
+before reading (`maxBytes`, 64 MiB by default), a depth and an element limit
+while reading — because a received file is hostile until read.
+
+What it does not do: validate against the schemas or the Schematron (whether
+the file is valid on the network was the sending access point's question),
+check signatures, or read UBL extensions.
+
+### Participant identifiers and the SML
+
+```ts
+import { validateParticipantId, smlHostname, SML_ZONES } from '@ekwo-ai/peppol-ubl';
+
+validateParticipantId('BE:EN:0999999031');
+// { valid: true, scheme: '0208', value: '0999999031', identifier: '0208:0999999031', canonical: '0208:0999999031', problems: [] }
+
+smlHostname('0208:0999999031', SML_ZONES.production, 'naptr');
+// '<base32 of SHA-256>.iso6523-actorid-upis.edelivery.tech.ec.europa.eu'
+```
+
+`validateParticipantId(input: string): ParticipantIdCheck` takes
+`scheme:value`, with or without `iso6523-actorid-upis::` in front, and the
+symbolic scheme names of the Peppol code list (`BE:EN`, `GLN`, `NO:ORG`…),
+returned as the numeric code. It checks that the scheme is an electronic
+address scheme (EAS) Peppol delivers to, and the check digits of the schemes
+whose rule is published by their issuer: GLN (0088), Belgian enterprise number
+(0208), SIREN (0002), Swedish (0007) and Norwegian (0192) organisation
+numbers, Australian Business Number (0151) and LEI (0199) — `CHECKED_SCHEMES`.
+Other schemes are checked for nothing but being non-empty: a rule written from
+a guess would refuse somebody's real address. The SIRET (0009) is one of them,
+for the published exception to its Luhn rule this package could not source
+exactly.
+
+`smlHostname(participant, zone, lookup)` computes the DNS name under which the
+SML publishes a participant: `B-` and the MD5 of the lower-cased identifier for
+the `cname` lookup, the unpadded base32 of its SHA-256 for the `naptr` lookup
+of BDXL. It is pure — the hashes are written out in the package, there is no
+default zone, and nothing is resolved: the lookup belongs to a transport.
+
 ## Sources
 
 - OASIS, *Universal Business Language 2.1*, schemas of 4 November 2013:
@@ -239,6 +327,17 @@ against it found what reading had not:
   tag `v3.0.20`.
 - CEN/TC 434, the validation artefacts of EN 16931:
   <https://github.com/ConnectingEurope/eInvoicing-EN16931>.
+- OpenPeppol, *Policy for use of Identifiers*, version 4, and the code list
+  *Participant identifier schemes*: <https://docs.peppol.eu/edelivery/> —
+  the identifier scheme, case-insensitive comparison, symbolic scheme names.
+- OpenPeppol, *Service Metadata Locator (SML)* specification, and OASIS
+  *Business Document Metadata Service Location (BDXL) 1.0* — the DNS names
+  of a participant. RFC 1321 (MD5), FIPS 180-4 (SHA-256), RFC 4648 (base32).
+- The check digit rules, each cited where it is implemented in
+  `src/participant.ts`: GS1 General Specifications (GLN), the Crossroads Bank
+  for Enterprises (Belgian enterprise number), INSEE (SIREN), Skatteverket and
+  the Brønnøysund Register Centre (organisation numbers), the Australian
+  Business Register (ABN), ISO 17442 (LEI), ISO 13616 (IBAN).
 
 ## Licence
 

package/dist/decimal.d.ts

@@ -8,6 +8,9 @@
  * that is right. So nothing here is a `number`. A decimal is an integer and a
  * scale, the integer is a `bigint`, and the four operations the rules need are
  * exact.
+ *
+ * The Factur-X brick holds a copy of this file, byte for byte, for the reader
+ * of `received-checks.ts`; a test there compares the two.
  */
 export interface Decimal {
     /** The digits, as an integer: 12.30 is `1230n` at scale 2. */

package/dist/decimal.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"decimal.d.ts","sourceRoot":"","sources":["../src/decimal.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AAEH,MAAM,WAAW,OAAO;IACtB,8DAA8D;IAC9D,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,oDAAoD;IACpD,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;CACxB;AAID;;;;GAIG;AACH,wBAAgB,YAAY,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,GAAG,SAAS,GAAG,OAAO,GAAG,IAAI,CAkBtF;AAOD,wBAAgB,GAAG,CAAC,CAAC,EAAE,OAAO,EAAE,CAAC,EAAE,OAAO,GAAG,OAAO,CAGnD;AAED,wBAAgB,QAAQ,CAAC,CAAC,EAAE,OAAO,EAAE,CAAC,EAAE,OAAO,GAAG,OAAO,CAGxD;AAED,wBAAgB,QAAQ,CAAC,CAAC,EAAE,OAAO,EAAE,CAAC,EAAE,OAAO,GAAG,OAAO,CAExD;AAED,wBAAgB,OAAO,CAAC,CAAC,EAAE,OAAO,EAAE,CAAC,EAAE,OAAO,GAAG,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,CAG1D;AAED,eAAO,MAAM,KAAK,GAAI,GAAG,OAAO,EAAE,GAAG,OAAO,KAAG,OAA8B,CAAC;AAE9E,eAAO,MAAM,IAAI,EAAE,OAAiC,CAAC;AAErD,eAAO,MAAM,MAAM,GAAI,GAAG,OAAO,KAAG,OAAyB,CAAC;AAE9D,wBAAgB,GAAG,CAAC,CAAC,EAAE,OAAO,GAAG,OAAO,CAEvC;AAED,wBAAgB,GAAG,CAAC,MAAM,EAAE,SAAS,OAAO,EAAE,GAAG,OAAO,CAEvD;AAED;;;;;GAKG;AACH,wBAAgB,UAAU,CAAC,CAAC,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAS9D;AAED,iFAAiF;AACjF,wBAAgB,gBAAgB,CAAC,CAAC,EAAE,OAAO,GAAG,MAAM,CAOnD;AAED;;;;;GAKG;AACH,wBAAgB,aAAa,CAAC,CAAC,EAAE,OAAO,EAAE,QAAQ,SAAI,GAAG,MAAM,CAe9D"}
+{"version":3,"file":"decimal.d.ts","sourceRoot":"","sources":["../src/decimal.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;GAaG;AAEH,MAAM,WAAW,OAAO;IACtB,8DAA8D;IAC9D,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,oDAAoD;IACpD,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;CACxB;AAID;;;;GAIG;AACH,wBAAgB,YAAY,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,GAAG,SAAS,GAAG,OAAO,GAAG,IAAI,CAkBtF;AAOD,wBAAgB,GAAG,CAAC,CAAC,EAAE,OAAO,EAAE,CAAC,EAAE,OAAO,GAAG,OAAO,CAGnD;AAED,wBAAgB,QAAQ,CAAC,CAAC,EAAE,OAAO,EAAE,CAAC,EAAE,OAAO,GAAG,OAAO,CAGxD;AAED,wBAAgB,QAAQ,CAAC,CAAC,EAAE,OAAO,EAAE,CAAC,EAAE,OAAO,GAAG,OAAO,CAExD;AAED,wBAAgB,OAAO,CAAC,CAAC,EAAE,OAAO,EAAE,CAAC,EAAE,OAAO,GAAG,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,CAG1D;AAED,eAAO,MAAM,KAAK,GAAI,GAAG,OAAO,EAAE,GAAG,OAAO,KAAG,OAA8B,CAAC;AAE9E,eAAO,MAAM,IAAI,EAAE,OAAiC,CAAC;AAErD,eAAO,MAAM,MAAM,GAAI,GAAG,OAAO,KAAG,OAAyB,CAAC;AAE9D,wBAAgB,GAAG,CAAC,CAAC,EAAE,OAAO,GAAG,OAAO,CAEvC;AAED,wBAAgB,GAAG,CAAC,MAAM,EAAE,SAAS,OAAO,EAAE,GAAG,OAAO,CAEvD;AAED;;;;;GAKG;AACH,wBAAgB,UAAU,CAAC,CAAC,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAS9D;AAED,iFAAiF;AACjF,wBAAgB,gBAAgB,CAAC,CAAC,EAAE,OAAO,GAAG,MAAM,CAOnD;AAED;;;;;GAKG;AACH,wBAAgB,aAAa,CAAC,CAAC,EAAE,OAAO,EAAE,QAAQ,SAAI,GAAG,MAAM,CAe9D"}

package/dist/decimal.js

@@ -8,6 +8,9 @@
  * that is right. So nothing here is a `number`. A decimal is an integer and a
  * scale, the integer is a `bigint`, and the four operations the rules need are
  * exact.
+ *
+ * The Factur-X brick holds a copy of this file, byte for byte, for the reader
+ * of `received-checks.ts`; a test there compares the two.
  */
 const SYNTAX = /^[+-]?(\d+)(\.\d+)?$|^[+-]?(\.\d+)$/;
 /**

package/dist/decimal.js.map

@@ -1 +1 @@
-{"version":3,"file":"decimal.js","sourceRoot":"","sources":["../src/decimal.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AASH,MAAM,MAAM,GAAG,qCAAqC,CAAC;AAErD;;;;GAIG;AACH,MAAM,UAAU,YAAY,CAAC,KAAyC;IACpE,IAAI,KAAK,KAAK,IAAI,IAAI,KAAK,KAAK,SAAS;QAAE,OAAO,IAAI,CAAC;IACvD,IAAI,IAAY,CAAC;IACjB,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QAC9B,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC;YAAE,OAAO,IAAI,CAAC;QACzC,sEAAsE;QACtE,oEAAoE;QACpE,oEAAoE;QACpE,IAAI,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC;IACvB,CAAC;SAAM,CAAC;QACN,IAAI,GAAG,KAAK,CAAC,IAAI,EAAE,CAAC;IACtB,CAAC;IACD,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC;QAAE,OAAO,IAAI,CAAC;IACpC,MAAM,QAAQ,GAAG,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;IACtC,MAAM,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC;IAC3C,MAAM,CAAC,KAAK,GAAG,EAAE,EAAE,QAAQ,GAAG,EAAE,CAAC,GAAG,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IACxD,MAAM,KAAK,GAAG,MAAM,CAAC,CAAC,KAAK,IAAI,GAAG,CAAC,GAAG,QAAQ,CAAC,CAAC;IAChD,OAAO,EAAE,KAAK,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,EAAE,KAAK,EAAE,QAAQ,CAAC,MAAM,EAAE,CAAC;AACtE,CAAC;AAED,SAAS,KAAK,CAAC,CAAU,EAAE,CAAU;IACnC,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,KAAK,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC;IACzC,OAAO,CAAC,CAAC,CAAC,KAAK,GAAG,GAAG,IAAI,MAAM,CAAC,KAAK,GAAG,CAAC,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,KAAK,GAAG,GAAG,IAAI,MAAM,CAAC,KAAK,GAAG,CAAC,CAAC,KAAK,CAAC,EAAE,KAAK,CAAC,CAAC;AACrG,CAAC;AAED,MAAM,UAAU,GAAG,CAAC,CAAU,EAAE,CAAU;IACxC,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,KAAK,CAAC,GAAG,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IAClC,OAAO,EAAE,KAAK,EAAE,CAAC,GAAG,CAAC,EAAE,KAAK,EAAE,CAAC;AACjC,CAAC;AAED,MAAM,UAAU,QAAQ,CAAC,CAAU,EAAE,CAAU;IAC7C,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,KAAK,CAAC,GAAG,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IAClC,OAAO,EAAE,KAAK,EAAE,CAAC,GAAG,CAAC,EAAE,KAAK,EAAE,CAAC;AACjC,CAAC;AAED,MAAM,UAAU,QAAQ,CAAC,CAAU,EAAE,CAAU;IAC7C,OAAO,EAAE,KAAK,EAAE,CAAC,CAAC,KAAK,GAAG,CAAC,CAAC,KAAK,EAAE,KAAK,EAAE,CAAC,CAAC,KAAK,GAAG,CAAC,CAAC,KAAK,EAAE,CAAC;AAChE,CAAC;AAED,MAAM,UAAU,OAAO,CAAC,CAAU,EAAE,CAAU;IAC5C,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IAC3B,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;AACpC,CAAC;AAED,MAAM,CAAC,MAAM,KAAK,GAAG,CAAC,CAAU,EAAE,CAAU,EAAW,EAAE,CAAC,OAAO,CAAC,CAAC,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC;AAE9E,MAAM,CAAC,MAAM,IAAI,GAAY,EAAE,KAAK,EAAE,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE,CAAC;AAErD,MAAM,CAAC,MAAM,MAAM,GAAG,CAAC,CAAU,EAAW,EAAE,CAAC,CAAC,CAAC,KAAK,KAAK,EAAE,CAAC;AAE9D,MAAM,UAAU,GAAG,CAAC,CAAU;IAC5B,OAAO,CAAC,CAAC,KAAK,GAAG,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC,KAAK,EAAE,KAAK,EAAE,CAAC,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;AAChE,CAAC;AAED,MAAM,UAAU,GAAG,CAAC,MAA0B;IAC5C,OAAO,MAAM,CAAC,MAAM,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;AAClC,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,UAAU,CAAC,CAAU,EAAE,MAAc;IACnD,IAAI,CAAC,CAAC,KAAK,IAAI,MAAM;QAAE,OAAO,CAAC,CAAC;IAChC,MAAM,OAAO,GAAG,GAAG,IAAI,MAAM,CAAC,CAAC,CAAC,KAAK,GAAG,MAAM,CAAC,CAAC;IAChD,yEAAyE;IACzE,MAAM,SAAS,GAAG,EAAE,GAAG,CAAC,CAAC,KAAK,GAAG,OAAO,CAAC;IACzC,MAAM,WAAW,GAAG,EAAE,GAAG,OAAO,CAAC;IACjC,IAAI,QAAQ,GAAG,SAAS,GAAG,WAAW,CAAC;IACvC,IAAI,SAAS,GAAG,WAAW,KAAK,EAAE,IAAI,SAAS,GAAG,EAAE;QAAE,QAAQ,IAAI,EAAE,CAAC;IACrE,OAAO,EAAE,KAAK,EAAE,QAAQ,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC;AAC5C,CAAC;AAED,iFAAiF;AACjF,MAAM,UAAU,gBAAgB,CAAC,CAAU;IACzC,IAAI,EAAE,KAAK,EAAE,KAAK,EAAE,GAAG,CAAC,CAAC;IACzB,OAAO,KAAK,GAAG,CAAC,IAAI,KAAK,GAAG,GAAG,KAAK,EAAE,EAAE,CAAC;QACvC,KAAK,IAAI,GAAG,CAAC;QACb,KAAK,IAAI,CAAC,CAAC;IACb,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,aAAa,CAAC,CAAU,EAAE,QAAQ,GAAG,CAAC;IACpD,IAAI,EAAE,KAAK,EAAE,KAAK,EAAE,GAAG,CAAC,CAAC;IACzB,OAAO,KAAK,GAAG,QAAQ,IAAI,KAAK,GAAG,GAAG,KAAK,EAAE,EAAE,CAAC;QAC9C,KAAK,IAAI,GAAG,CAAC;QACb,KAAK,IAAI,CAAC,CAAC;IACb,CAAC;IACD,IAAI,KAAK,GAAG,QAAQ,EAAE,CAAC;QACrB,KAAK,IAAI,GAAG,IAAI,MAAM,CAAC,QAAQ,GAAG,KAAK,CAAC,CAAC;QACzC,KAAK,GAAG,QAAQ,CAAC;IACnB,CAAC;IACD,MAAM,QAAQ,GAAG,KAAK,GAAG,EAAE,CAAC;IAC5B,MAAM,MAAM,GAAG,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,KAAK,GAAG,CAAC,EAAE,GAAG,CAAC,CAAC;IAC/E,MAAM,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC,EAAE,MAAM,CAAC,MAAM,GAAG,KAAK,CAAC,CAAC;IACrD,MAAM,QAAQ,GAAG,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,GAAG,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;IAC5E,OAAO,GAAG,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,GAAG,KAAK,GAAG,QAAQ,EAAE,CAAC;AACrD,CAAC"}
+{"version":3,"file":"decimal.js","sourceRoot":"","sources":["../src/decimal.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;GAaG;AASH,MAAM,MAAM,GAAG,qCAAqC,CAAC;AAErD;;;;GAIG;AACH,MAAM,UAAU,YAAY,CAAC,KAAyC;IACpE,IAAI,KAAK,KAAK,IAAI,IAAI,KAAK,KAAK,SAAS;QAAE,OAAO,IAAI,CAAC;IACvD,IAAI,IAAY,CAAC;IACjB,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QAC9B,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC;YAAE,OAAO,IAAI,CAAC;QACzC,sEAAsE;QACtE,oEAAoE;QACpE,oEAAoE;QACpE,IAAI,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC;IACvB,CAAC;SAAM,CAAC;QACN,IAAI,GAAG,KAAK,CAAC,IAAI,EAAE,CAAC;IACtB,CAAC;IACD,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC;QAAE,OAAO,IAAI,CAAC;IACpC,MAAM,QAAQ,GAAG,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;IACtC,MAAM,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC;IAC3C,MAAM,CAAC,KAAK,GAAG,EAAE,EAAE,QAAQ,GAAG,EAAE,CAAC,GAAG,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IACxD,MAAM,KAAK,GAAG,MAAM,CAAC,CAAC,KAAK,IAAI,GAAG,CAAC,GAAG,QAAQ,CAAC,CAAC;IAChD,OAAO,EAAE,KAAK,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,EAAE,KAAK,EAAE,QAAQ,CAAC,MAAM,EAAE,CAAC;AACtE,CAAC;AAED,SAAS,KAAK,CAAC,CAAU,EAAE,CAAU;IACnC,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,KAAK,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC;IACzC,OAAO,CAAC,CAAC,CAAC,KAAK,GAAG,GAAG,IAAI,MAAM,CAAC,KAAK,GAAG,CAAC,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,KAAK,GAAG,GAAG,IAAI,MAAM,CAAC,KAAK,GAAG,CAAC,CAAC,KAAK,CAAC,EAAE,KAAK,CAAC,CAAC;AACrG,CAAC;AAED,MAAM,UAAU,GAAG,CAAC,CAAU,EAAE,CAAU;IACxC,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,KAAK,CAAC,GAAG,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IAClC,OAAO,EAAE,KAAK,EAAE,CAAC,GAAG,CAAC,EAAE,KAAK,EAAE,CAAC;AACjC,CAAC;AAED,MAAM,UAAU,QAAQ,CAAC,CAAU,EAAE,CAAU;IAC7C,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,KAAK,CAAC,GAAG,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IAClC,OAAO,EAAE,KAAK,EAAE,CAAC,GAAG,CAAC,EAAE,KAAK,EAAE,CAAC;AACjC,CAAC;AAED,MAAM,UAAU,QAAQ,CAAC,CAAU,EAAE,CAAU;IAC7C,OAAO,EAAE,KAAK,EAAE,CAAC,CAAC,KAAK,GAAG,CAAC,CAAC,KAAK,EAAE,KAAK,EAAE,CAAC,CAAC,KAAK,GAAG,CAAC,CAAC,KAAK,EAAE,CAAC;AAChE,CAAC;AAED,MAAM,UAAU,OAAO,CAAC,CAAU,EAAE,CAAU;IAC5C,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IAC3B,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;AACpC,CAAC;AAED,MAAM,CAAC,MAAM,KAAK,GAAG,CAAC,CAAU,EAAE,CAAU,EAAW,EAAE,CAAC,OAAO,CAAC,CAAC,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC;AAE9E,MAAM,CAAC,MAAM,IAAI,GAAY,EAAE,KAAK,EAAE,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE,CAAC;AAErD,MAAM,CAAC,MAAM,MAAM,GAAG,CAAC,CAAU,EAAW,EAAE,CAAC,CAAC,CAAC,KAAK,KAAK,EAAE,CAAC;AAE9D,MAAM,UAAU,GAAG,CAAC,CAAU;IAC5B,OAAO,CAAC,CAAC,KAAK,GAAG,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC,KAAK,EAAE,KAAK,EAAE,CAAC,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;AAChE,CAAC;AAED,MAAM,UAAU,GAAG,CAAC,MAA0B;IAC5C,OAAO,MAAM,CAAC,MAAM,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;AAClC,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,UAAU,CAAC,CAAU,EAAE,MAAc;IACnD,IAAI,CAAC,CAAC,KAAK,IAAI,MAAM;QAAE,OAAO,CAAC,CAAC;IAChC,MAAM,OAAO,GAAG,GAAG,IAAI,MAAM,CAAC,CAAC,CAAC,KAAK,GAAG,MAAM,CAAC,CAAC;IAChD,yEAAyE;IACzE,MAAM,SAAS,GAAG,EAAE,GAAG,CAAC,CAAC,KAAK,GAAG,OAAO,CAAC;IACzC,MAAM,WAAW,GAAG,EAAE,GAAG,OAAO,CAAC;IACjC,IAAI,QAAQ,GAAG,SAAS,GAAG,WAAW,CAAC;IACvC,IAAI,SAAS,GAAG,WAAW,KAAK,EAAE,IAAI,SAAS,GAAG,EAAE;QAAE,QAAQ,IAAI,EAAE,CAAC;IACrE,OAAO,EAAE,KAAK,EAAE,QAAQ,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC;AAC5C,CAAC;AAED,iFAAiF;AACjF,MAAM,UAAU,gBAAgB,CAAC,CAAU;IACzC,IAAI,EAAE,KAAK,EAAE,KAAK,EAAE,GAAG,CAAC,CAAC;IACzB,OAAO,KAAK,GAAG,CAAC,IAAI,KAAK,GAAG,GAAG,KAAK,EAAE,EAAE,CAAC;QACvC,KAAK,IAAI,GAAG,CAAC;QACb,KAAK,IAAI,CAAC,CAAC;IACb,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,aAAa,CAAC,CAAU,EAAE,QAAQ,GAAG,CAAC;IACpD,IAAI,EAAE,KAAK,EAAE,KAAK,EAAE,GAAG,CAAC,CAAC;IACzB,OAAO,KAAK,GAAG,QAAQ,IAAI,KAAK,GAAG,GAAG,KAAK,EAAE,EAAE,CAAC;QAC9C,KAAK,IAAI,GAAG,CAAC;QACb,KAAK,IAAI,CAAC,CAAC;IACb,CAAC;IACD,IAAI,KAAK,GAAG,QAAQ,EAAE,CAAC;QACrB,KAAK,IAAI,GAAG,IAAI,MAAM,CAAC,QAAQ,GAAG,KAAK,CAAC,CAAC;QACzC,KAAK,GAAG,QAAQ,CAAC;IACnB,CAAC;IACD,MAAM,QAAQ,GAAG,KAAK,GAAG,EAAE,CAAC;IAC5B,MAAM,MAAM,GAAG,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,KAAK,GAAG,CAAC,EAAE,GAAG,CAAC,CAAC;IAC/E,MAAM,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC,EAAE,MAAM,CAAC,MAAM,GAAG,KAAK,CAAC,CAAC;IACrD,MAAM,QAAQ,GAAG,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,GAAG,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;IAC5E,OAAO,GAAG,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,GAAG,KAAK,GAAG,QAAQ,EAAE,CAAC;AACrD,CAAC"}

package/dist/errors.d.ts

@@ -0,0 +1,39 @@
+/**
+ * What makes a received file unreadable, as opposed to an invoice that reads
+ * and does not add up. The second comes back in `violations`; the first is
+ * thrown, because a file that is not an invoice has nothing to hang a
+ * violation on.
+ *
+ * The same file, byte for byte, in the two e-invoicing bricks that read, so
+ * that a caller handles a refusal of either by the same codes.
+ */
+export type InvoiceFileErrorCode = 
+/** Larger than `maxBytes`. Refused before a single character is read. */
+'too_large'
+/** Bytes that are not UTF-8, or a declaration that names another encoding. */
+ | 'unsupported_encoding'
+/** A `<!DOCTYPE`. No invoice needs one, and every entity attack does. */
+ | 'doctype_forbidden'
+/** An entity other than the five XML predefines and character references. */
+ | 'undefined_entity'
+/** Elements nested deeper than `maxDepth`. */
+ | 'too_deep'
+/** More elements than `maxElements`. */
+ | 'too_many_elements'
+/** Not well-formed XML, in the subset this reader takes. */
+ | 'malformed_xml'
+/** Well-formed, and not a UBL 2.1 `Invoice` or `CreditNote`: another root, another namespace. */
+ | 'not_an_invoice'
+/** An element without which there is no invoice to book: its number, its date, its currency, its totals, a line. */
+ | 'missing_element'
+/** A value that is not what its element holds: a date that is not a date, an amount that is not a number. */
+ | 'invalid_value'
+/** Factur-X only: the bytes are not a PDF that can be opened. */
+ | 'not_a_pdf'
+/** Factur-X only: a PDF that carries no `factur-x.xml`, `zugferd-invoice.xml` or `xrechnung.xml`. */
+ | 'no_embedded_invoice';
+export declare class InvoiceFileError extends Error {
+    readonly code: InvoiceFileErrorCode;
+    constructor(code: InvoiceFileErrorCode, message: string);
+}
+//# sourceMappingURL=errors.d.ts.map

package/dist/errors.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../src/errors.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AACH,MAAM,MAAM,oBAAoB;AAC9B,yEAAyE;AACvE,WAAW;AACb,8EAA8E;GAC5E,sBAAsB;AACxB,yEAAyE;GACvE,mBAAmB;AACrB,6EAA6E;GAC3E,kBAAkB;AACpB,8CAA8C;GAC5C,UAAU;AACZ,wCAAwC;GACtC,mBAAmB;AACrB,4DAA4D;GAC1D,eAAe;AACjB,iGAAiG;GAC/F,gBAAgB;AAClB,oHAAoH;GAClH,iBAAiB;AACnB,6GAA6G;GAC3G,eAAe;AACjB,iEAAiE;GAC/D,WAAW;AACb,qGAAqG;GACnG,qBAAqB,CAAC;AAE1B,qBAAa,gBAAiB,SAAQ,KAAK;IACzC,QAAQ,CAAC,IAAI,EAAE,oBAAoB,CAAC;gBAExB,IAAI,EAAE,oBAAoB,EAAE,OAAO,EAAE,MAAM;CAKxD"}

package/dist/errors.js

@@ -0,0 +1,9 @@
+export class InvoiceFileError extends Error {
+    code;
+    constructor(code, message) {
+        super(message);
+        this.name = 'InvoiceFileError';
+        this.code = code;
+    }
+}
+//# sourceMappingURL=errors.js.map

package/dist/errors.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.js","sourceRoot":"","sources":["../src/errors.ts"],"names":[],"mappings":"AAmCA,MAAM,OAAO,gBAAiB,SAAQ,KAAK;IAChC,IAAI,CAAuB;IAEpC,YAAY,IAA0B,EAAE,OAAe;QACrD,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,IAAI,CAAC,IAAI,GAAG,kBAAkB,CAAC;QAC/B,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;IACnB,CAAC;CACF"}

package/dist/index.d.ts

@@ -31,4 +31,10 @@ export type { DocumentHeaderRow, DocumentLineRow, DocumentTaxRow, ElectronicAddr
  * as a violation, beside a file that says what it was given.
  */
 export declare function generatePeppolUbl(input: PeppolUblInput, options?: PeppolUblOptions): PeppolUbl;
+export { readUbl } from './read.js';
+export { InvoiceFileError, type InvoiceFileErrorCode } from './errors.js';
+export { CREDIT_NOTE_TYPE_CODES, checkReceived, isValidIban } from './received-checks.js';
+export type { DateText, DecimalText, ReadOptions, ReceivedAccount, ReceivedAddress, ReceivedAllowanceCharge, ReceivedAttachment, ReceivedContact, ReceivedIdentifier, ReceivedInvoice, ReceivedInvoiceFile, ReceivedLine, ReceivedParty, ReceivedPaymentMeans, ReceivedTax, ReceivedTotals, ReceivedViolation, } from './received.js';
+export { CHECKED_SCHEMES, PARTICIPANT_IDENTIFIER_SCHEME, ParticipantIdError, SYMBOLIC_SCHEMES, validateParticipantId, type ParticipantIdCheck, type ParticipantIdProblem, } from './participant.js';
+export { SML_ZONES, smlHostname, type SmlLookup } from './sml.js';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;GAiBG;AAIH,OAAO,KAAK,EAAE,SAAS,EAAE,cAAc,EAAE,gBAAgB,EAAE,MAAM,YAAY,CAAC;AAG9E,OAAO,EAAE,cAAc,EAAE,MAAM,YAAY,CAAC;AAC5C,OAAO,EAAE,gBAAgB,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AACxD,OAAO,EAAE,qBAAqB,EAAE,MAAM,YAAY,CAAC;AACnD,OAAO,EACL,aAAa,EACb,cAAc,EACd,0BAA0B,EAC1B,sBAAsB,EACtB,kBAAkB,EAClB,mBAAmB,EACnB,UAAU,EACV,kBAAkB,EAClB,uBAAuB,GACxB,MAAM,gBAAgB,CAAC;AACxB,YAAY,EACV,iBAAiB,EACjB,eAAe,EACf,cAAc,EACd,iBAAiB,EACjB,OAAO,EACP,OAAO,EACP,SAAS,EACT,cAAc,EACd,gBAAgB,EAChB,SAAS,GACV,MAAM,YAAY,CAAC;AAYpB;;;;;;;GAOG;AACH,wBAAgB,iBAAiB,CAAC,KAAK,EAAE,cAAc,EAAE,OAAO,GAAE,gBAAqB,GAAG,SAAS,CAQlG"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;GAiBG;AAIH,OAAO,KAAK,EAAE,SAAS,EAAE,cAAc,EAAE,gBAAgB,EAAE,MAAM,YAAY,CAAC;AAG9E,OAAO,EAAE,cAAc,EAAE,MAAM,YAAY,CAAC;AAC5C,OAAO,EAAE,gBAAgB,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AACxD,OAAO,EAAE,qBAAqB,EAAE,MAAM,YAAY,CAAC;AACnD,OAAO,EACL,aAAa,EACb,cAAc,EACd,0BAA0B,EAC1B,sBAAsB,EACtB,kBAAkB,EAClB,mBAAmB,EACnB,UAAU,EACV,kBAAkB,EAClB,uBAAuB,GACxB,MAAM,gBAAgB,CAAC;AACxB,YAAY,EACV,iBAAiB,EACjB,eAAe,EACf,cAAc,EACd,iBAAiB,EACjB,OAAO,EACP,OAAO,EACP,SAAS,EACT,cAAc,EACd,gBAAgB,EAChB,SAAS,GACV,MAAM,YAAY,CAAC;AAYpB;;;;;;;GAOG;AACH,wBAAgB,iBAAiB,CAAC,KAAK,EAAE,cAAc,EAAE,OAAO,GAAE,gBAAqB,GAAG,SAAS,CAQlG;AAID,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,OAAO,EAAE,gBAAgB,EAAE,KAAK,oBAAoB,EAAE,MAAM,aAAa,CAAC;AAC1E,OAAO,EAAE,sBAAsB,EAAE,aAAa,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC;AAC1F,YAAY,EACV,QAAQ,EACR,WAAW,EACX,WAAW,EACX,eAAe,EACf,eAAe,EACf,uBAAuB,EACvB,kBAAkB,EAClB,eAAe,EACf,kBAAkB,EAClB,eAAe,EACf,mBAAmB,EACnB,YAAY,EACZ,aAAa,EACb,oBAAoB,EACpB,WAAW,EACX,cAAc,EACd,iBAAiB,GAClB,MAAM,eAAe,CAAC;AAIvB,OAAO,EACL,eAAe,EACf,6BAA6B,EAC7B,kBAAkB,EAClB,gBAAgB,EAChB,qBAAqB,EACrB,KAAK,kBAAkB,EACvB,KAAK,oBAAoB,GAC1B,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EAAE,SAAS,EAAE,WAAW,EAAE,KAAK,SAAS,EAAE,MAAM,UAAU,CAAC"}

package/dist/index.js

@@ -50,4 +50,11 @@ export function generatePeppolUbl(input, options = {}) {
         violations: check(model),
     };
 }
+// --- reading ---------------------------------------------------------------
+export { readUbl } from './read.js';
+export { InvoiceFileError } from './errors.js';
+export { CREDIT_NOTE_TYPE_CODES, checkReceived, isValidIban } from './received-checks.js';
+// --- participants ----------------------------------------------------------
+export { CHECKED_SCHEMES, PARTICIPANT_IDENTIFIER_SCHEME, ParticipantIdError, SYMBOLIC_SCHEMES, validateParticipantId, } from './participant.js';
+export { SML_ZONES, smlHostname } from './sml.js';
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;GAiBG;AAEH,OAAO,EAAE,cAAc,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AACxD,OAAO,EAAE,KAAK,EAAE,MAAM,YAAY,CAAC;AAEnC,OAAO,EAAE,QAAQ,EAAE,MAAM,UAAU,CAAC;AAEpC,OAAO,EAAE,cAAc,EAAE,MAAM,YAAY,CAAC;AAC5C,OAAO,EAAE,gBAAgB,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AACxD,OAAO,EAAE,qBAAqB,EAAE,MAAM,YAAY,CAAC;AACnD,OAAO,EACL,aAAa,EACb,cAAc,EACd,0BAA0B,EAC1B,sBAAsB,EACtB,kBAAkB,EAClB,mBAAmB,EACnB,UAAU,EACV,kBAAkB,EAClB,uBAAuB,GACxB,MAAM,gBAAgB,CAAC;AAcxB;;;;GAIG;AACH,SAAS,UAAU,CAAC,MAAc,EAAE,IAA8B;IAChE,MAAM,IAAI,GAAG,MAAM,CAAC,OAAO,CAAC,mBAAmB,EAAE,GAAG,CAAC,CAAC,OAAO,CAAC,UAAU,EAAE,EAAE,CAAC,CAAC;IAC9E,OAAO,GAAG,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,aAAa,IAAI,IAAI,KAAK,EAAE,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,IAAI,MAAM,CAAC;AACpG,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,iBAAiB,CAAC,KAAqB,EAAE,UAA4B,EAAE;IACrF,IAAI,CAAC,KAAK,IAAI,CAAC,KAAK,CAAC,MAAM;QAAE,MAAM,IAAI,cAAc,CAAC,uBAAuB,CAAC,CAAC;IAC/E,MAAM,KAAK,GAAG,UAAU,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;IACzC,OAAO;QACL,IAAI,EAAE,QAAQ,CAAC,KAAK,CAAC;QACrB,QAAQ,EAAE,UAAU,CAAC,KAAK,CAAC,MAAM,EAAE,KAAK,CAAC,IAAI,CAAC;QAC9C,UAAU,EAAE,KAAK,CAAC,KAAK,CAAC;KACzB,CAAC;AACJ,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;GAiBG;AAEH,OAAO,EAAE,cAAc,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AACxD,OAAO,EAAE,KAAK,EAAE,MAAM,YAAY,CAAC;AAEnC,OAAO,EAAE,QAAQ,EAAE,MAAM,UAAU,CAAC;AAEpC,OAAO,EAAE,cAAc,EAAE,MAAM,YAAY,CAAC;AAC5C,OAAO,EAAE,gBAAgB,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AACxD,OAAO,EAAE,qBAAqB,EAAE,MAAM,YAAY,CAAC;AACnD,OAAO,EACL,aAAa,EACb,cAAc,EACd,0BAA0B,EAC1B,sBAAsB,EACtB,kBAAkB,EAClB,mBAAmB,EACnB,UAAU,EACV,kBAAkB,EAClB,uBAAuB,GACxB,MAAM,gBAAgB,CAAC;AAcxB;;;;GAIG;AACH,SAAS,UAAU,CAAC,MAAc,EAAE,IAA8B;IAChE,MAAM,IAAI,GAAG,MAAM,CAAC,OAAO,CAAC,mBAAmB,EAAE,GAAG,CAAC,CAAC,OAAO,CAAC,UAAU,EAAE,EAAE,CAAC,CAAC;IAC9E,OAAO,GAAG,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,aAAa,IAAI,IAAI,KAAK,EAAE,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,IAAI,MAAM,CAAC;AACpG,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,iBAAiB,CAAC,KAAqB,EAAE,UAA4B,EAAE;IACrF,IAAI,CAAC,KAAK,IAAI,CAAC,KAAK,CAAC,MAAM;QAAE,MAAM,IAAI,cAAc,CAAC,uBAAuB,CAAC,CAAC;IAC/E,MAAM,KAAK,GAAG,UAAU,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;IACzC,OAAO;QACL,IAAI,EAAE,QAAQ,CAAC,KAAK,CAAC;QACrB,QAAQ,EAAE,UAAU,CAAC,KAAK,CAAC,MAAM,EAAE,KAAK,CAAC,IAAI,CAAC;QAC9C,UAAU,EAAE,KAAK,CAAC,KAAK,CAAC;KACzB,CAAC;AACJ,CAAC;AAED,8EAA8E;AAE9E,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,OAAO,EAAE,gBAAgB,EAA6B,MAAM,aAAa,CAAC;AAC1E,OAAO,EAAE,sBAAsB,EAAE,aAAa,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC;AAqB1F,8EAA8E;AAE9E,OAAO,EACL,eAAe,EACf,6BAA6B,EAC7B,kBAAkB,EAClB,gBAAgB,EAChB,qBAAqB,GAGtB,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EAAE,SAAS,EAAE,WAAW,EAAkB,MAAM,UAAU,CAAC"}

package/dist/participant.d.ts

@@ -0,0 +1,83 @@
+/**
+ * Peppol participant identifiers: `scheme:value`, the address a business is
+ * registered under on the network and the one an invoice is delivered to.
+ *
+ * What is checked, and where it comes from:
+ *
+ * - **the scheme** is a code of the electronic address scheme list (EAS) that
+ *   EN 16931 publishes, as the Schematron Peppol ships carries it
+ *   (`ELECTRONIC_ADDRESS_SCHEMES`, generated from that file), less the schemes
+ *   Peppol does not deliver to (`SCHEMES_NOT_ON_PEPPOL`);
+ * - **the spelling**: the numeric code is the identifier. Some registrations
+ *   and older documents write a symbolic name instead (`BE:EN` for `0208`);
+ *   those of {@link SYMBOLIC_SCHEMES} are read and returned as the code;
+ * - **the value**, for the schemes whose number carries check digits under a
+ *   published, well-defined rule — each one cites where the rule is
+ *   published. A scheme that is not listed there is not checked beyond being
+ *   non-empty: a rule written from a guess would refuse somebody's real
+ *   address. The French SIRET (0009) is one: its Luhn rule has a published
+ *   exception for one issuer whose exact extent this package could not
+ *   source, so it is not checked at all rather than checked wrongly.
+ *
+ * The comparison is the network's: a participant identifier is
+ * case-insensitive (OpenPEPPOL, *Policy for use of Identifiers*, version 4,
+ * policy 1), which is why {@link validateParticipantId} returns it lower-cased
+ * beside the form it was given in.
+ */
+/** The identifier scheme of every participant identifier on Peppol (Policy for use of Identifiers, policy 2). */
+export declare const PARTICIPANT_IDENTIFIER_SCHEME = "iso6523-actorid-upis";
+/**
+ * Symbolic names of participant identifier schemes, and the numeric code each
+ * stands for, transcribed from the "Scheme ID" column of the Peppol code list
+ * *Participant identifier schemes* (docs.peppol.eu, Peppol Code Lists). Only
+ * the names that list gives are here; a name that is not is refused, not
+ * guessed.
+ */
+export declare const SYMBOLIC_SCHEMES: Readonly<Record<string, string>>;
+/** Why an identifier is not one Peppol can deliver to. */
+export type ParticipantIdProblem = 
+/** Not `scheme:value`: no separator, an empty side, or another identifier scheme than `iso6523-actorid-upis`. */
+'malformed'
+/** A scheme of no list: neither an EAS code nor a symbolic name of {@link SYMBOLIC_SCHEMES}. */
+ | 'unknown_scheme'
+/** An EAS code of EN 16931 that Peppol does not deliver to (an e-mail address, a telephone number…). */
+ | 'scheme_not_on_peppol'
+/** A value that is not written the way its scheme writes numbers. */
+ | 'invalid_format'
+/** A value whose check digits are wrong. */
+ | 'invalid_check_digits';
+export interface ParticipantIdCheck {
+    /** True when nothing below is wrong. */
+    valid: boolean;
+    /** The numeric scheme, `0208`, whatever spelling it was given in. Null where it could not be read. */
+    scheme: string | null;
+    /** The value, as given, trimmed. */
+    value: string | null;
+    /** `scheme:value`, numeric scheme, as given. Null where either side is. */
+    identifier: string | null;
+    /** The same, lower-cased: the form the network compares and hashes. */
+    canonical: string | null;
+    /** Empty when `valid`. */
+    problems: {
+        code: ParticipantIdProblem;
+        message: string;
+    }[];
+}
+/** The schemes whose values {@link validateParticipantId} checks digit by digit. */
+export declare const CHECKED_SCHEMES: readonly string[];
+/** Thrown where a participant identifier is needed and the one given is not one. */
+export declare class ParticipantIdError extends Error {
+    name: string;
+    readonly problems: ParticipantIdCheck['problems'];
+    constructor(problems: ParticipantIdCheck['problems']);
+}
+/**
+ * Checks a participant identifier: `0208:0999999922`, with or without the
+ * `iso6523-actorid-upis::` in front of it, or with a symbolic scheme
+ * (`BE:EN:0999999922`).
+ *
+ * Pure: the question whether the participant is *registered* is the SML's,
+ * and {@link smlHostname} computes where to ask it.
+ */
+export declare function validateParticipantId(input: string): ParticipantIdCheck;
+//# sourceMappingURL=participant.d.ts.map

package/dist/participant.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"participant.d.ts","sourceRoot":"","sources":["../src/participant.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AAKH,iHAAiH;AACjH,eAAO,MAAM,6BAA6B,yBAAyB,CAAC;AAEpE;;;;;;GAMG;AACH,eAAO,MAAM,gBAAgB,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAmD5D,CAAC;AAEH,0DAA0D;AAC1D,MAAM,MAAM,oBAAoB;AAC9B,iHAAiH;AAC/G,WAAW;AACb,gGAAgG;GAC9F,gBAAgB;AAClB,wGAAwG;GACtG,sBAAsB;AACxB,qEAAqE;GACnE,gBAAgB;AAClB,4CAA4C;GAC1C,sBAAsB,CAAC;AAE3B,MAAM,WAAW,kBAAkB;IACjC,wCAAwC;IACxC,KAAK,EAAE,OAAO,CAAC;IACf,sGAAsG;IACtG,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IACtB,oCAAoC;IACpC,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,2EAA2E;IAC3E,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,uEAAuE;IACvE,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,0BAA0B;IAC1B,QAAQ,EAAE;QAAE,IAAI,EAAE,oBAAoB,CAAC;QAAC,OAAO,EAAE,MAAM,CAAA;KAAE,EAAE,CAAC;CAC7D;AAoHD,oFAAoF;AACpF,eAAO,MAAM,eAAe,EAAE,SAAS,MAAM,EAAwC,CAAC;AAEtF,oFAAoF;AACpF,qBAAa,kBAAmB,SAAQ,KAAK;IAClC,IAAI,SAAwB;IACrC,QAAQ,CAAC,QAAQ,EAAE,kBAAkB,CAAC,UAAU,CAAC,CAAC;gBAEtC,QAAQ,EAAE,kBAAkB,CAAC,UAAU,CAAC;CAIrD;AAMD;;;;;;;GAOG;AACH,wBAAgB,qBAAqB,CAAC,KAAK,EAAE,MAAM,GAAG,kBAAkB,CA6CvE"}