beliq-cli 0.2.1 → 0.2.2

package/README.md

@@ -24,6 +24,8 @@ beliq convert  <file|->  --target-format cii|ubl|zugferd|facturx|xrechnung|peppo
 beliq me                 [--json]
 ```
 
+`generate --pdf` returns a hybrid PDF/A-3 with the XML embedded for `zugferd` and `facturx`. `xrechnung` and `peppol-bis` have no hybrid form, so `--pdf` returns a visualization with no XML inside it, and their legal document stays the XML.
+
 `validate` accepts an XML document or a ZUGFeRD/Factur-X PDF. A file argument of `-` reads from stdin. Pass several files, a shell glob, or a directory (its `.xml`/`.pdf` files, recursively) to validate a batch: you get a per-file verdict, a summary, and one exit code for the whole run. `--json` prints the raw API result (a report object in batch mode) as the only thing on stdout, so it pipes cleanly.
 
 ```bash

package/dist/commands/generate.js

@@ -1,4 +1,4 @@
-import { LIVE_GENERATE_STANDARDS } from '@beliq/sdk';
+import { LIVE_GENERATE_STANDARDS, isProfileAllowedForStandard, profilesForStandard, } from '@beliq/sdk';
 import { flagBool, flagStr, oneOf, requirePositional } from '../args.js';
 import { UsageError } from '../errors.js';
 import { emitDocument } from './emit.js';
@@ -13,6 +13,15 @@ export async function runGenerate(args, deps, io) {
     if (!standard) {
         throw new UsageError(`--standard is required (one of: ${LIVE_GENERATE_STANDARDS.join(', ')})`);
     }
+    // The SDK drops --facturx-profile outside the Factur-X / ZUGFeRD family.
+    // Inside it the pair is pinned (extended-ctc-fr is Factur-X only) and the API
+    // answers a wrong one with 422, so fail as a usage error before the call.
+    const facturxProfile = flagStr(args, 'facturx-profile');
+    if (facturxProfile !== undefined &&
+        (standard === 'facturx' || standard === 'zugferd') &&
+        !isProfileAllowedForStandard(standard, facturxProfile)) {
+        throw new UsageError(`--facturx-profile for ${standard} must be one of: ${profilesForStandard(standard).join(', ')}`);
+    }
     const raw = await io.readInput(file);
     let invoice;
     try {
@@ -28,7 +37,11 @@ export async function runGenerate(args, deps, io) {
         standard,
         invoice,
         output,
-        facturxProfile: flagStr(args, 'facturx-profile'),
+        facturxProfile: facturxProfile,
+        // XRechnung and Peppol BIS have no hybrid PDF, and the API refuses PDF for
+        // them unless the request names a visual to render. Factur-X and ZUGFeRD
+        // render theirs either way, so this is inert for them.
+        template: output === 'pdf' ? 'standard' : undefined,
         verify: !flagBool(args, 'no-verify'),
         seal,
     });

package/dist/help.js

@@ -20,6 +20,10 @@ batch: a per-file verdict, a summary, and one exit code for the whole run.
 generate --seal also returns the document sha256 and validation verdict, so you
 can prove which rules the document passed; hashing the output reproduces it.
 
+--pdf gives a hybrid PDF/A-3 with the XML embedded for zugferd and facturx.
+xrechnung and peppol-bis have no hybrid form, so --pdf returns a visualization
+with no XML inside it, and their legal document stays the XML.
+
 Global options:
   --api-key <key>   beliq API key (default: BELIQ_API_KEY)
   --base-url <url>  API base URL (default: BELIQ_BASE_URL, else https://api.beliq.eu)

package/examples/invalid-xrechnung.xml

@@ -0,0 +1,94 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!-- A minimal CII (UN/CEFACT Cross Industry Invoice) carrying the XRechnung
+     guideline id but missing the Buyer reference (BT-10), which XRechnung
+     requires (rule BR-DE-15). Used as a known-invalid example for the gated
+     live test and for the skill walkthrough. -->
+<rsm:CrossIndustryInvoice
+    xmlns:rsm="urn:un:unece:uncefact:data:standard:CrossIndustryInvoice:100"
+    xmlns:ram="urn:un:unece:uncefact:data:standard:ReusableAggregateBusinessInformationEntity:100"
+    xmlns:udt="urn:un:unece:uncefact:data:standard:UnqualifiedDataType:100">
+  <rsm:ExchangedDocumentContext>
+    <ram:GuidelineSpecifiedDocumentContextParameter>
+      <ram:ID>urn:cen.eu:en16931:2017#compliant#urn:xeinkauf.de:kosit:xrechnung_3.0</ram:ID>
+    </ram:GuidelineSpecifiedDocumentContextParameter>
+  </rsm:ExchangedDocumentContext>
+  <rsm:ExchangedDocument>
+    <ram:ID>INV-2026-001</ram:ID>
+    <ram:TypeCode>380</ram:TypeCode>
+    <ram:IssueDateTime>
+      <udt:DateTimeString format="102">20260115</udt:DateTimeString>
+    </ram:IssueDateTime>
+  </rsm:ExchangedDocument>
+  <rsm:SupplyChainTradeTransaction>
+    <ram:IncludedSupplyChainTradeLineItem>
+      <ram:AssociatedDocumentLineDocument>
+        <ram:LineID>1</ram:LineID>
+      </ram:AssociatedDocumentLineDocument>
+      <ram:SpecifiedTradeProduct>
+        <ram:Name>Consulting</ram:Name>
+      </ram:SpecifiedTradeProduct>
+      <ram:SpecifiedLineTradeAgreement>
+        <ram:NetPriceProductTradePrice>
+          <ram:ChargeAmount>100.00</ram:ChargeAmount>
+        </ram:NetPriceProductTradePrice>
+      </ram:SpecifiedLineTradeAgreement>
+      <ram:SpecifiedLineTradeDelivery>
+        <ram:BilledQuantity unitCode="HUR">10</ram:BilledQuantity>
+      </ram:SpecifiedLineTradeDelivery>
+      <ram:SpecifiedLineTradeSettlement>
+        <ram:ApplicableTradeTax>
+          <ram:TypeCode>VAT</ram:TypeCode>
+          <ram:CategoryCode>S</ram:CategoryCode>
+          <ram:RateApplicablePercent>19.00</ram:RateApplicablePercent>
+        </ram:ApplicableTradeTax>
+        <ram:SpecifiedTradeSettlementLineMonetarySummation>
+          <ram:LineTotalAmount>1000.00</ram:LineTotalAmount>
+        </ram:SpecifiedTradeSettlementLineMonetarySummation>
+      </ram:SpecifiedLineTradeSettlement>
+    </ram:IncludedSupplyChainTradeLineItem>
+    <ram:ApplicableHeaderTradeAgreement>
+      <ram:SellerTradeParty>
+        <ram:Name>Seller GmbH</ram:Name>
+        <ram:PostalTradeAddress>
+          <ram:PostcodeCode>10115</ram:PostcodeCode>
+          <ram:CityName>Berlin</ram:CityName>
+          <ram:CountryID>DE</ram:CountryID>
+        </ram:PostalTradeAddress>
+        <ram:SpecifiedTaxRegistration>
+          <ram:ID schemeID="VA">DE123456789</ram:ID>
+        </ram:SpecifiedTaxRegistration>
+      </ram:SellerTradeParty>
+      <ram:BuyerTradeParty>
+        <ram:Name>Buyer GmbH</ram:Name>
+        <ram:PostalTradeAddress>
+          <ram:PostcodeCode>80331</ram:PostcodeCode>
+          <ram:CityName>Munich</ram:CityName>
+          <ram:CountryID>DE</ram:CountryID>
+        </ram:PostalTradeAddress>
+      </ram:BuyerTradeParty>
+    </ram:ApplicableHeaderTradeAgreement>
+    <ram:ApplicableHeaderTradeDelivery />
+    <ram:ApplicableHeaderTradeSettlement>
+      <ram:InvoiceCurrencyCode>EUR</ram:InvoiceCurrencyCode>
+      <ram:ApplicableTradeTax>
+        <ram:CalculatedAmount>190.00</ram:CalculatedAmount>
+        <ram:TypeCode>VAT</ram:TypeCode>
+        <ram:BasisAmount>1000.00</ram:BasisAmount>
+        <ram:CategoryCode>S</ram:CategoryCode>
+        <ram:RateApplicablePercent>19.00</ram:RateApplicablePercent>
+      </ram:ApplicableTradeTax>
+      <ram:SpecifiedTradePaymentTerms>
+        <ram:DueDateDateTime>
+          <udt:DateTimeString format="102">20260214</udt:DateTimeString>
+        </ram:DueDateDateTime>
+      </ram:SpecifiedTradePaymentTerms>
+      <ram:SpecifiedTradeSettlementHeaderMonetarySummation>
+        <ram:LineTotalAmount>1000.00</ram:LineTotalAmount>
+        <ram:TaxBasisTotalAmount>1000.00</ram:TaxBasisTotalAmount>
+        <ram:TaxTotalAmount currencyID="EUR">190.00</ram:TaxTotalAmount>
+        <ram:GrandTotalAmount>1190.00</ram:GrandTotalAmount>
+        <ram:DuePayableAmount>1190.00</ram:DuePayableAmount>
+      </ram:SpecifiedTradeSettlementHeaderMonetarySummation>
+    </ram:ApplicableHeaderTradeSettlement>
+  </rsm:SupplyChainTradeTransaction>
+</rsm:CrossIndustryInvoice>

package/examples/invoice.json

@@ -0,0 +1,64 @@
+{
+  "number": "INV-2026-001",
+  "issueDate": "2026-01-15",
+  "currencyCode": "EUR",
+  "buyerReference": "04011000-12345-06",
+  "seller": {
+    "name": "Seller GmbH",
+    "vatId": "DE123456789",
+    "contactName": "Anna Muster",
+    "email": "billing@seller.example",
+    "phone": "+49 30 1234567",
+    "address": {
+      "street": "Hauptstr. 1",
+      "city": "Berlin",
+      "postalCode": "10115",
+      "countryCode": "DE"
+    },
+    "peppol": {
+      "schemeId": "9930",
+      "id": "DE123456789"
+    }
+  },
+  "buyer": {
+    "name": "Buyer GmbH",
+    "email": "ap@buyer.example",
+    "address": {
+      "street": "Marktweg 2",
+      "city": "Munich",
+      "postalCode": "80331",
+      "countryCode": "DE"
+    },
+    "vatId": "DE987654321",
+    "peppol": {
+      "schemeId": "9930",
+      "id": "DE987654321"
+    }
+  },
+  "lines": [
+    {
+      "description": "Consulting",
+      "quantity": 10,
+      "unitCode": "HUR",
+      "unitPrice": 100,
+      "lineTotal": 1000,
+      "vatRate": 19,
+      "vatCategoryCode": "S"
+    }
+  ],
+  "taxSummary": [
+    {
+      "vatCategoryCode": "S",
+      "vatRate": 19,
+      "taxableAmount": 1000,
+      "taxAmount": 190
+    }
+  ],
+  "paymentMeans": {
+    "typeCode": "58",
+    "iban": "DE89370400440532013000"
+  },
+  "totalNetAmount": 1000,
+  "totalTaxAmount": 190,
+  "totalGrossAmount": 1190
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "beliq-cli",
-  "version": "0.2.1",
+  "version": "0.2.2",
   "description": "beliq CLI: validate, generate, parse, and convert EU e-invoices (XRechnung, ZUGFeRD, Factur-X, Peppol BIS) against authority-pinned, drift-checked rules, from the terminal or CI.",
   "license": "MIT",
   "type": "module",
@@ -37,7 +37,8 @@
     "beliq": "dist/index.js"
   },
   "files": [
-    "dist"
+    "dist",
+    "examples"
   ],
   "publishConfig": {
     "provenance": true
@@ -56,7 +57,7 @@
     "prepublishOnly": "npm run build"
   },
   "dependencies": {
-    "@beliq/sdk": "^0.3.0"
+    "@beliq/sdk": "^0.4.0"
   },
   "devDependencies": {
     "@types/node": "^20.14.0",