@ekwo-ai/document-reading 0.0.0-stage → 0.19.0

package/dist/purchase.js

@@ -0,0 +1,184 @@
+/**
+ * The purchase a received invoice becomes, before anybody's books are read.
+ *
+ * Whichever way the invoice was read — a Factur-X file, a UBL message, a
+ * photograph read by a model — it is one `ReceivedInvoice`, and this file
+ * turns it into the draft of a purchase document in the columns of Ekwo OS
+ * (`documents`, `document_lines`): the fields a caller passes to
+ * `create_document` once it has chosen, in its own books, the supplier, the
+ * account and the tax. Those three choices need the books and the country
+ * pack, so they are not made here; the draft carries what they are made
+ * from — the supplier as the invoice names it, and each line's VAT category
+ * and rate.
+ *
+ * What the core has a column for goes in that column: the unit code of a
+ * line, the supplier's invoice number, the references, the due date, the
+ * tax point. What it has none for and EN 16931 carries on a line — the period
+ * a line bills (BG-26) — goes in the line's `attributes`, which hold "what an
+ * electronic invoice format asks of this line that no other column says".
+ * The period of the whole invoice (BG-14) has no column on a document: each
+ * line that states no period of its own takes it, which is what EN 16931
+ * means by it, and the draft returns it as well for whoever keeps it beside
+ * the document.
+ *
+ * Nothing is defaulted: no currency, no date, no name. Where the invoice is
+ * silent the draft is silent, and the caller asks, or fills in its own.
+ */
+/**
+ * The names under which a line's `attributes` carry what no column of
+ * `document_lines` holds. The period is BT-134 and BT-135; the three
+ * `invoiced_*` keep the invoice's own quantity, unit and price where the
+ * line had to be written as one unit at its amount (see `PurchaseDraftLine`).
+ */
+export const LINE_ATTRIBUTES = {
+    periodStart: 'period_start',
+    periodEnd: 'period_end',
+    invoicedQuantity: 'invoiced_quantity',
+    invoicedUnitCode: 'invoiced_unit_code',
+    invoicedNetPrice: 'invoiced_net_price',
+};
+const nonEmpty = (value) => value === null || value === undefined || value.trim().length === 0 ? null : value;
+/** The decimals a currency is written with, as the platform's `Intl` knows it; null for a code it does not know. */
+export function currencyDigits(currency) {
+    try {
+        return new Intl.NumberFormat('en', { style: 'currency', currency }).resolvedOptions().maximumFractionDigits ?? null;
+    }
+    catch {
+        return null;
+    }
+}
+/** A decimal as an integer and a scale: `-12.50` is `{ units: -1250n, scale: 2 }`. */
+function decimal(text) {
+    const match = /^(-?)(\d+)(?:\.(\d+))?$/.exec(text.trim());
+    if (match === null)
+        return null;
+    const fraction = match[3] ?? '';
+    const units = BigInt(`${match[2]}${fraction}`);
+    return { units: match[1] === '-' ? -units : units, scale: fraction.length };
+}
+/**
+ * Whether `quantity × price`, rounded half up on its absolute value at
+ * `digits` decimals — the rounding of `document_lines.amount_untaxed` — is
+ * `amount`.
+ */
+export function makesAmount(quantity, price, amount, digits) {
+    const q = decimal(quantity);
+    const p = decimal(price);
+    const a = decimal(amount);
+    if (q === null || p === null || a === null)
+        return false;
+    const product = q.units * p.units;
+    const scale = q.scale + p.scale;
+    const negative = product < 0n;
+    const magnitude = negative ? -product : product;
+    let rounded;
+    if (scale <= digits) {
+        rounded = magnitude * 10n ** BigInt(digits - scale);
+    }
+    else {
+        const divisor = 10n ** BigInt(scale - digits);
+        rounded = magnitude / divisor + ((magnitude % divisor) * 2n >= divisor ? 1n : 0n);
+    }
+    const signed = negative ? -rounded : rounded;
+    // The amount may be written with more decimals than the currency has, as long as they are zeros.
+    return a.scale <= digits ? signed === a.units * 10n ** BigInt(digits - a.scale) : signed * 10n ** BigInt(a.scale - digits) === a.units;
+}
+function periodAttributes(period) {
+    const out = {};
+    if (period?.start)
+        out[LINE_ATTRIBUTES.periodStart] = period.start;
+    if (period?.end)
+        out[LINE_ATTRIBUTES.periodEnd] = period.end;
+    return out;
+}
+function lineOf(line, digits, invoicing) {
+    const name = nonEmpty(line.name) ?? nonEmpty(line.description) ?? nonEmpty(line.note);
+    const perUnit = line.priceBaseQuantity === null || /^0*1(\.0*)?$/.test(line.priceBaseQuantity);
+    const exact = line.quantity !== null &&
+        line.netPrice !== null &&
+        perUnit &&
+        line.netAmount.length > 0 &&
+        makesAmount(line.quantity, line.netPrice, line.netAmount, digits);
+    const attributes = periodAttributes(line.period ?? invoicing);
+    if (!exact) {
+        if (line.quantity !== null)
+            attributes[LINE_ATTRIBUTES.invoicedQuantity] = line.quantity;
+        if (line.unitCode !== null)
+            attributes[LINE_ATTRIBUTES.invoicedUnitCode] = line.unitCode;
+        if (line.netPrice !== null)
+            attributes[LINE_ATTRIBUTES.invoicedNetPrice] = line.netPrice;
+    }
+    return {
+        name,
+        description: name === nonEmpty(line.name) ? nonEmpty(line.description) : null,
+        quantity: exact ? line.quantity : '1',
+        unit_code: exact ? (line.unitCode ?? 'C62') : 'C62',
+        unit_price: exact ? line.netPrice : line.netAmount,
+        vat_category: line.vatCategory,
+        vat_rate: line.vatRate,
+        attributes,
+    };
+}
+function adjustmentOf(one, invoicing) {
+    return {
+        name: nonEmpty(one.reason) ?? nonEmpty(one.reasonCode),
+        description: null,
+        quantity: '1',
+        unit_code: 'C62',
+        unit_price: one.charge ? one.amount : one.amount.startsWith('-') ? one.amount.slice(1) : `-${one.amount}`,
+        vat_category: one.vatCategory,
+        vat_rate: one.vatRate,
+        attributes: periodAttributes(invoicing),
+    };
+}
+/**
+ * The draft of the purchase a received invoice becomes.
+ *
+ * One line per line of the invoice, its amount net of the line's own
+ * allowances; then one line per allowance (negative) or charge of the whole
+ * document. A credit note is a purchase credit note, its figures positive as
+ * the invoice writes them. Where the currency was not read, amounts are
+ * compared at the decimals the invoice wrote them with.
+ */
+export function purchaseDraftOf(invoice) {
+    const currency = nonEmpty(invoice.currency);
+    const invoicing = invoice.invoicingPeriod === null || (invoice.invoicingPeriod.start === null && invoice.invoicingPeriod.end === null)
+        ? null
+        : invoice.invoicingPeriod;
+    const lines = invoice.lines.map((line) => {
+        const written = decimal(line.netAmount)?.scale ?? 2;
+        const digits = currency === null ? written : (currencyDigits(currency) ?? written);
+        return lineOf(line, digits, invoicing);
+    });
+    lines.push(...invoice.allowances.map((one) => adjustmentOf(one, invoicing)));
+    const means = invoice.paymentMeans.find((one) => one.reference !== null || one.account !== null);
+    const iban = invoice.paymentMeans.map((one) => one.account).find((account) => account?.kind === 'iban');
+    return {
+        doc_type: invoice.kind === 'credit_note' ? 'purchase_credit_note' : 'purchase_invoice',
+        document_date: nonEmpty(invoice.issueDate),
+        due_date: invoice.dueDate,
+        tax_point_date: invoice.taxPointDate,
+        supplier_reference: nonEmpty(invoice.number),
+        currency_code: currency,
+        buyer_reference: invoice.buyerReference,
+        order_reference: invoice.orderReference,
+        contract_reference: invoice.contractReference,
+        project_reference: invoice.projectReference,
+        delivery_date: invoice.deliveryDate,
+        payment_terms: invoice.paymentTerms,
+        payment_reference: means?.reference ?? null,
+        payee_iban: iban?.value ?? null,
+        invoicing_period: invoicing,
+        supplier: {
+            name: invoice.seller.name,
+            trade_name: invoice.seller.tradeName,
+            vat_id: invoice.seller.vatId,
+            legal_id: invoice.seller.legalId?.value ?? null,
+            country: invoice.seller.address?.country ?? null,
+        },
+        total: nonEmpty(invoice.totals.taxInclusive),
+        payable: nonEmpty(invoice.totals.payable),
+        lines,
+    };
+}
+//# sourceMappingURL=purchase.js.map

package/dist/purchase.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"purchase.js","sourceRoot":"","sources":["../src/purchase.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AAUH;;;;;GAKG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG;IAC7B,WAAW,EAAE,cAAc;IAC3B,SAAS,EAAE,YAAY;IACvB,gBAAgB,EAAE,mBAAmB;IACrC,gBAAgB,EAAE,oBAAoB;IACtC,gBAAgB,EAAE,oBAAoB;CAC9B,CAAC;AA+DX,MAAM,QAAQ,GAAG,CAAC,KAAgC,EAAiB,EAAE,CACnE,KAAK,KAAK,IAAI,IAAI,KAAK,KAAK,SAAS,IAAI,KAAK,CAAC,IAAI,EAAE,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC;AAEpF,oHAAoH;AACpH,MAAM,UAAU,cAAc,CAAC,QAAgB;IAC7C,IAAI,CAAC;QACH,OAAO,IAAI,IAAI,CAAC,YAAY,CAAC,IAAI,EAAE,EAAE,KAAK,EAAE,UAAU,EAAE,QAAQ,EAAE,CAAC,CAAC,eAAe,EAAE,CAAC,qBAAqB,IAAI,IAAI,CAAC;IACtH,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,IAAI,CAAC;IACd,CAAC;AACH,CAAC;AAED,sFAAsF;AACtF,SAAS,OAAO,CAAC,IAAY;IAC3B,MAAM,KAAK,GAAG,yBAAyB,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC;IAC1D,IAAI,KAAK,KAAK,IAAI;QAAE,OAAO,IAAI,CAAC;IAChC,MAAM,QAAQ,GAAG,KAAK,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;IAChC,MAAM,KAAK,GAAG,MAAM,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,GAAG,QAAQ,EAAE,CAAC,CAAC;IAC/C,OAAO,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,EAAE,KAAK,EAAE,QAAQ,CAAC,MAAM,EAAE,CAAC;AAC9E,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,WAAW,CAAC,QAAgB,EAAE,KAAa,EAAE,MAAc,EAAE,MAAc;IACzF,MAAM,CAAC,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC;IAC5B,MAAM,CAAC,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC;IACzB,MAAM,CAAC,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IAC1B,IAAI,CAAC,KAAK,IAAI,IAAI,CAAC,KAAK,IAAI,IAAI,CAAC,KAAK,IAAI;QAAE,OAAO,KAAK,CAAC;IACzD,MAAM,OAAO,GAAG,CAAC,CAAC,KAAK,GAAG,CAAC,CAAC,KAAK,CAAC;IAClC,MAAM,KAAK,GAAG,CAAC,CAAC,KAAK,GAAG,CAAC,CAAC,KAAK,CAAC;IAChC,MAAM,QAAQ,GAAG,OAAO,GAAG,EAAE,CAAC;IAC9B,MAAM,SAAS,GAAG,QAAQ,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC;IAChD,IAAI,OAAe,CAAC;IACpB,IAAI,KAAK,IAAI,MAAM,EAAE,CAAC;QACpB,OAAO,GAAG,SAAS,GAAG,GAAG,IAAI,MAAM,CAAC,MAAM,GAAG,KAAK,CAAC,CAAC;IACtD,CAAC;SAAM,CAAC;QACN,MAAM,OAAO,GAAG,GAAG,IAAI,MAAM,CAAC,KAAK,GAAG,MAAM,CAAC,CAAC;QAC9C,OAAO,GAAG,SAAS,GAAG,OAAO,GAAG,CAAC,CAAC,SAAS,GAAG,OAAO,CAAC,GAAG,EAAE,IAAI,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;IACpF,CAAC;IACD,MAAM,MAAM,GAAG,QAAQ,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC;IAC7C,iGAAiG;IACjG,OAAO,CAAC,CAAC,KAAK,IAAI,MAAM,CAAC,CAAC,CAAC,MAAM,KAAK,CAAC,CAAC,KAAK,GAAG,GAAG,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,GAAG,GAAG,IAAI,MAAM,CAAC,CAAC,CAAC,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC,KAAK,CAAC;AACzI,CAAC;AAED,SAAS,gBAAgB,CAAC,MAAqB;IAC7C,MAAM,GAAG,GAA2B,EAAE,CAAC;IACvC,IAAI,MAAM,EAAE,KAAK;QAAE,GAAG,CAAC,eAAe,CAAC,WAAW,CAAC,GAAG,MAAM,CAAC,KAAK,CAAC;IACnE,IAAI,MAAM,EAAE,GAAG;QAAE,GAAG,CAAC,eAAe,CAAC,SAAS,CAAC,GAAG,MAAM,CAAC,GAAG,CAAC;IAC7D,OAAO,GAAG,CAAC;AACb,CAAC;AAED,SAAS,MAAM,CAAC,IAAkB,EAAE,MAAc,EAAE,SAAwB;IAC1E,MAAM,IAAI,GAAG,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,QAAQ,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACtF,MAAM,OAAO,GAAG,IAAI,CAAC,iBAAiB,KAAK,IAAI,IAAI,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC;IAC/F,MAAM,KAAK,GACT,IAAI,CAAC,QAAQ,KAAK,IAAI;QACtB,IAAI,CAAC,QAAQ,KAAK,IAAI;QACtB,OAAO;QACP,IAAI,CAAC,SAAS,CAAC,MAAM,GAAG,CAAC;QACzB,WAAW,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC;IACpE,MAAM,UAAU,GAAG,gBAAgB,CAAC,IAAI,CAAC,MAAM,IAAI,SAAS,CAAC,CAAC;IAC9D,IAAI,CAAC,KAAK,EAAE,CAAC;QACX,IAAI,IAAI,CAAC,QAAQ,KAAK,IAAI;YAAE,UAAU,CAAC,eAAe,CAAC,gBAAgB,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC;QACzF,IAAI,IAAI,CAAC,QAAQ,KAAK,IAAI;YAAE,UAAU,CAAC,eAAe,CAAC,gBAAgB,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC;QACzF,IAAI,IAAI,CAAC,QAAQ,KAAK,IAAI;YAAE,UAAU,CAAC,eAAe,CAAC,gBAAgB,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC;IAC3F,CAAC;IACD,OAAO;QACL,IAAI;QACJ,WAAW,EAAE,IAAI,KAAK,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,IAAI;QAC7E,QAAQ,EAAE,KAAK,CAAC,CAAC,CAAE,IAAI,CAAC,QAAmB,CAAC,CAAC,CAAC,GAAG;QACjD,SAAS,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,IAAI,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK;QACnD,UAAU,EAAE,KAAK,CAAC,CAAC,CAAE,IAAI,CAAC,QAAmB,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS;QAC9D,YAAY,EAAE,IAAI,CAAC,WAAW;QAC9B,QAAQ,EAAE,IAAI,CAAC,OAAO;QACtB,UAAU;KACX,CAAC;AACJ,CAAC;AAED,SAAS,YAAY,CAAC,GAA4B,EAAE,SAAwB;IAC1E,OAAO;QACL,IAAI,EAAE,QAAQ,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,QAAQ,CAAC,GAAG,CAAC,UAAU,CAAC;QACtD,WAAW,EAAE,IAAI;QACjB,QAAQ,EAAE,GAAG;QACb,SAAS,EAAE,KAAK;QAChB,UAAU,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,GAAG,CAAC,MAAM,EAAE;QACzG,YAAY,EAAE,GAAG,CAAC,WAAW;QAC7B,QAAQ,EAAE,GAAG,CAAC,OAAO;QACrB,UAAU,EAAE,gBAAgB,CAAC,SAAS,CAAC;KACxC,CAAC;AACJ,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,eAAe,CAAC,OAAwB;IACtD,MAAM,QAAQ,GAAG,QAAQ,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;IAC5C,MAAM,SAAS,GACb,OAAO,CAAC,eAAe,KAAK,IAAI,IAAI,CAAC,OAAO,CAAC,eAAe,CAAC,KAAK,KAAK,IAAI,IAAI,OAAO,CAAC,eAAe,CAAC,GAAG,KAAK,IAAI,CAAC;QAClH,CAAC,CAAC,IAAI;QACN,CAAC,CAAC,OAAO,CAAC,eAAe,CAAC;IAC9B,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE;QACvC,MAAM,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,KAAK,IAAI,CAAC,CAAC;QACpD,MAAM,MAAM,GAAG,QAAQ,KAAK,IAAI,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,cAAc,CAAC,QAAQ,CAAC,IAAI,OAAO,CAAC,CAAC;QACnF,OAAO,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,SAAS,CAAC,CAAC;IACzC,CAAC,CAAC,CAAC;IACH,KAAK,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,YAAY,CAAC,GAAG,EAAE,SAAS,CAAC,CAAC,CAAC,CAAC;IAC7E,MAAM,KAAK,GAAG,OAAO,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,SAAS,KAAK,IAAI,IAAI,GAAG,CAAC,OAAO,KAAK,IAAI,CAAC,CAAC;IACjG,MAAM,IAAI,GAAG,OAAO,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,EAAE,IAAI,KAAK,MAAM,CAAC,CAAC;IACxG,OAAO;QACL,QAAQ,EAAE,OAAO,CAAC,IAAI,KAAK,aAAa,CAAC,CAAC,CAAC,sBAAsB,CAAC,CAAC,CAAC,kBAAkB;QACtF,aAAa,EAAE,QAAQ,CAAC,OAAO,CAAC,SAAS,CAAC;QAC1C,QAAQ,EAAE,OAAO,CAAC,OAAO;QACzB,cAAc,EAAE,OAAO,CAAC,YAAY;QACpC,kBAAkB,EAAE,QAAQ,CAAC,OAAO,CAAC,MAAM,CAAC;QAC5C,aAAa,EAAE,QAAQ;QACvB,eAAe,EAAE,OAAO,CAAC,cAAc;QACvC,eAAe,EAAE,OAAO,CAAC,cAAc;QACvC,kBAAkB,EAAE,OAAO,CAAC,iBAAiB;QAC7C,iBAAiB,EAAE,OAAO,CAAC,gBAAgB;QAC3C,aAAa,EAAE,OAAO,CAAC,YAAY;QACnC,aAAa,EAAE,OAAO,CAAC,YAAY;QACnC,iBAAiB,EAAE,KAAK,EAAE,SAAS,IAAI,IAAI;QAC3C,UAAU,EAAE,IAAI,EAAE,KAAK,IAAI,IAAI;QAC/B,gBAAgB,EAAE,SAAS;QAC3B,QAAQ,EAAE;YACR,IAAI,EAAE,OAAO,CAAC,MAAM,CAAC,IAAI;YACzB,UAAU,EAAE,OAAO,CAAC,MAAM,CAAC,SAAS;YACpC,MAAM,EAAE,OAAO,CAAC,MAAM,CAAC,KAAK;YAC5B,QAAQ,EAAE,OAAO,CAAC,MAAM,CAAC,OAAO,EAAE,KAAK,IAAI,IAAI;YAC/C,OAAO,EAAE,OAAO,CAAC,MAAM,CAAC,OAAO,EAAE,OAAO,IAAI,IAAI;SACjD;QACD,KAAK,EAAE,QAAQ,CAAC,OAAO,CAAC,MAAM,CAAC,YAAY,CAAC;QAC5C,OAAO,EAAE,QAAQ,CAAC,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC;QACzC,KAAK;KACN,CAAC;AACJ,CAAC"}

package/dist/structured.d.ts

@@ -0,0 +1,29 @@
+/**
+ * The exact path: a file that carries its invoice as data.
+ *
+ * Three files do — a CII D16B `CrossIndustryInvoice`, a UBL 2.1 invoice or
+ * credit note, and a PDF with its Factur-X or ZUGFeRD XML attached — and the
+ * e-invoicing bricks of this repository read each of them into one shape,
+ * EN 16931's `ReceivedInvoice`: `readCii()` and `readFacturX()` of
+ * `@ekwo-ai/factur-x`, `readUbl()` of `@ekwo-ai/peppol-ubl`. This file only
+ * says which of them a file is for. No model is called: what the file says is
+ * what is returned.
+ *
+ * The readers are imported when a file needs them, so a page that never reads
+ * a PDF never downloads the PDF library.
+ */
+import type { ReadOptions, ReceivedInvoiceFile } from '@ekwo-ai/factur-x';
+/** What a file is, as far as reading it goes: by its first bytes, never by its name. */
+export type FileKind = 'pdf' | 'xml' | 'other';
+/** The kind of a file, from its first kilobyte: `%PDF-` makes a PDF, a `<` after the byte-order mark and blanks makes XML. */
+export declare function fileKind(bytes: Uint8Array): FileKind;
+/**
+ * The e-invoice a file holds, read exactly; `undefined` where it holds none —
+ * a photograph, a PDF with no XML inside, an XML that is not an invoice, a
+ * file over the readers' limits — so that the caller reads it another way,
+ * with a model (`readingSchema()`, `readingOf()`).
+ *
+ * CII and UBL are told apart by the root the first four kilobytes name.
+ */
+export declare function readStructured(file: Uint8Array | ArrayBuffer, options?: ReadOptions): Promise<ReceivedInvoiceFile | undefined>;
+//# sourceMappingURL=structured.d.ts.map

package/dist/structured.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"structured.d.ts","sourceRoot":"","sources":["../src/structured.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;GAaG;AAEH,OAAO,KAAK,EAAE,WAAW,EAAE,mBAAmB,EAAE,MAAM,mBAAmB,CAAC;AAE1E,wFAAwF;AACxF,MAAM,MAAM,QAAQ,GAAG,KAAK,GAAG,KAAK,GAAG,OAAO,CAAC;AAE/C,8HAA8H;AAC9H,wBAAgB,QAAQ,CAAC,KAAK,EAAE,UAAU,GAAG,QAAQ,CAIpD;AAED;;;;;;;GAOG;AACH,wBAAsB,cAAc,CAClC,IAAI,EAAE,UAAU,GAAG,WAAW,EAC9B,OAAO,GAAE,WAAgB,GACxB,OAAO,CAAC,mBAAmB,GAAG,SAAS,CAAC,CAkB1C"}

package/dist/structured.js

@@ -0,0 +1,51 @@
+/**
+ * The exact path: a file that carries its invoice as data.
+ *
+ * Three files do — a CII D16B `CrossIndustryInvoice`, a UBL 2.1 invoice or
+ * credit note, and a PDF with its Factur-X or ZUGFeRD XML attached — and the
+ * e-invoicing bricks of this repository read each of them into one shape,
+ * EN 16931's `ReceivedInvoice`: `readCii()` and `readFacturX()` of
+ * `@ekwo-ai/factur-x`, `readUbl()` of `@ekwo-ai/peppol-ubl`. This file only
+ * says which of them a file is for. No model is called: what the file says is
+ * what is returned.
+ *
+ * The readers are imported when a file needs them, so a page that never reads
+ * a PDF never downloads the PDF library.
+ */
+/** The kind of a file, from its first kilobyte: `%PDF-` makes a PDF, a `<` after the byte-order mark and blanks makes XML. */
+export function fileKind(bytes) {
+    const head = new TextDecoder('latin1').decode(bytes.subarray(0, 1024));
+    if (head.includes('%PDF-'))
+        return 'pdf';
+    return /^()?\s*</.test(head) ? 'xml' : 'other';
+}
+/**
+ * The e-invoice a file holds, read exactly; `undefined` where it holds none —
+ * a photograph, a PDF with no XML inside, an XML that is not an invoice, a
+ * file over the readers' limits — so that the caller reads it another way,
+ * with a model (`readingSchema()`, `readingOf()`).
+ *
+ * CII and UBL are told apart by the root the first four kilobytes name.
+ */
+export async function readStructured(file, options = {}) {
+    const bytes = file instanceof Uint8Array ? file : new Uint8Array(file);
+    try {
+        switch (fileKind(bytes)) {
+            case 'pdf':
+                return await (await import('@ekwo-ai/factur-x/pdf')).readFacturX(bytes, options);
+            case 'xml': {
+                const head = new TextDecoder().decode(bytes.subarray(0, 4096));
+                if (/CrossIndustryInvoice/.test(head))
+                    return (await import('@ekwo-ai/factur-x')).readCii(bytes, options);
+                return (await import('@ekwo-ai/peppol-ubl')).readUbl(bytes, options);
+            }
+            default:
+                return undefined;
+        }
+    }
+    catch {
+        // Not an e-invoice the readers take: it is read as a picture of one.
+        return undefined;
+    }
+}
+//# sourceMappingURL=structured.js.map

package/dist/structured.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"structured.js","sourceRoot":"","sources":["../src/structured.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;GAaG;AAOH,8HAA8H;AAC9H,MAAM,UAAU,QAAQ,CAAC,KAAiB;IACxC,MAAM,IAAI,GAAG,IAAI,WAAW,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,CAAC;IACvE,IAAI,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC;QAAE,OAAO,KAAK,CAAC;IACzC,OAAO,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,OAAO,CAAC;AACpD,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,CAAC,KAAK,UAAU,cAAc,CAClC,IAA8B,EAC9B,UAAuB,EAAE;IAEzB,MAAM,KAAK,GAAG,IAAI,YAAY,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,UAAU,CAAC,IAAI,CAAC,CAAC;IACvE,IAAI,CAAC;QACH,QAAQ,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;YACxB,KAAK,KAAK;gBACR,OAAO,MAAM,CAAC,MAAM,MAAM,CAAC,uBAAuB,CAAC,CAAC,CAAC,WAAW,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;YACnF,KAAK,KAAK,CAAC,CAAC,CAAC;gBACX,MAAM,IAAI,GAAG,IAAI,WAAW,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,CAAC;gBAC/D,IAAI,sBAAsB,CAAC,IAAI,CAAC,IAAI,CAAC;oBAAE,OAAO,CAAC,MAAM,MAAM,CAAC,mBAAmB,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;gBAC1G,OAAO,CAAC,MAAM,MAAM,CAAC,qBAAqB,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;YACvE,CAAC;YACD;gBACE,OAAO,SAAS,CAAC;QACrB,CAAC;IACH,CAAC;IAAC,MAAM,CAAC;QACP,qEAAqE;QACrE,OAAO,SAAS,CAAC;IACnB,CAAC;AACH,CAAC"}

package/package.json

@@ -1,6 +1,64 @@
 {
   "name": "@ekwo-ai/document-reading",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.19.0",
+  "description": "One reader for received invoices: CII, Factur-X and UBL read exactly, and a photograph or a plain PDF read by a vision model through a published schema and prompt — both into the EN 16931 ReceivedInvoice.",
+  "keywords": [
+    "invoice",
+    "receipt",
+    "ocr",
+    "vision",
+    "en16931",
+    "factur-x",
+    "zugferd",
+    "ubl",
+    "cii",
+    "peppol",
+    "json-schema"
+  ],
+  "license": "MIT",
+  "author": "Ekwo AI",
+  "homepage": "https://github.com/Ekwo-ai/ekwo-os/tree/main/packages/document-reading#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Ekwo-ai/ekwo-os.git",
+    "directory": "packages/document-reading"
+  },
+  "bugs": {
+    "url": "https://github.com/Ekwo-ai/ekwo-os/issues"
+  },
+  "type": "module",
+  "sideEffects": false,
+  "engines": {
+    "node": ">=18"
+  },
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE",
+    "CHANGELOG.md"
+  ],
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "scripts": {
+    "build": "tsc -p tsconfig.build.json",
+    "typecheck": "tsc -p tsconfig.json --noEmit",
+    "test": "vitest run",
+    "prepublishOnly": "npm run typecheck && npm test && npm run build"
+  },
+  "dependencies": {
+    "@ekwo-ai/factur-x": "^0.19.0",
+    "@ekwo-ai/peppol-ubl": "^0.19.0"
+  },
+  "devDependencies": {
+    "@types/node": "^24.0.0",
+    "pdf-lib": "^1.17.1",
+    "typescript": "^5.9.0",
+    "vitest": "^5.0.3"
+  }
+}