@reportwright/pdf 0.0.0-stage → 0.1.0-beta.1

package/examples/factur-x.mjs

@@ -0,0 +1,37 @@
+// A Factur-X (ZUGFeRD 2.1+) invoice: a tagged PDF/A-3a page with the CII XML embedded as factur-x.xml.
+//
+//   node examples/factur-x.mjs invoice.xml font.ttf out.pdf [profile]
+//
+// The XML must be a UN/CEFACT CrossIndustryInvoice whose GuidelineSpecifiedDocumentContextParameter ID names the
+// profile (EN 16931 by default: urn:cen.eu:en16931:2017). pdf.facturX checks that, refuses any DOCTYPE or entity, and
+// writes the fx XMP schema; it does not validate the invoice itself (run the Factur-X XSD and Schematron for that).
+// The page here only shows a few fields; a real one draws the whole invoice from the same data as the XML.
+import fs from 'node:fs';
+import { createPdf } from '../dist/index.js';
+
+const [xmlFile, fontFile, outFile, profile = 'EN 16931'] = process.argv.slice(2);
+if (!outFile) { console.error('node examples/factur-x.mjs invoice.xml font.ttf out.pdf [profile]'); process.exit(2); }
+const xml = fs.readFileSync(xmlFile);
+const text = xml.toString('utf8');
+/** the first <ram:tag> after anchor (display only: the page shows a few fields of the XML) */
+const field = (tag, anchor = '') => new RegExp(`${anchor}[\\s\\S]*?<ram:${tag}[^>]*>([^<]*)<`).exec(text)?.[1] ?? '';
+const number = field('ID', '<rsm:ExchangedDocument>'), seller = field('Name', '<ram:SellerTradeParty>');
+
+const pdf = createPdf(fs.createWriteStream(outFile), {
+  title: `Invoice ${number}`, author: seller, subject: 'Factur-X invoice', keywords: `invoice, Factur-X, ${profile}`,
+  pdfa: { part: 3, conformance: 'a' }, tagged: { lang: 'en' },
+});
+const font = await pdf.embedFont(fs.readFileSync(fontFile));
+const page = pdf.addPage({ trimBox: [0, 0, 595.28, 841.89] });
+const line = (s, y, size = 11) => page.text(s, { x: 56, y, font, size });
+page.artifact({ type: 'Pagination', subtype: 'Header' }, () => line('Factur-X invoice: the XML inside this PDF is the legal invoice', 24, 8));
+page.tag('H1', () => line(`Invoice ${number}`, 60, 22));
+page.tag('P', () => line(`Seller: ${seller}`, 110));
+page.tag('Table', () => {
+  page.tag('TR', () => ['Net', 'VAT', 'Total'].forEach((h, i) => page.tag('TH', () => page.text(h, { x: 56 + i * 140, y: 150, font }), { scope: 'Column', id: `h${i}` })));
+  page.tag('TR', () => [field('TaxBasisTotalAmount'), field('TaxTotalAmount'), field('GrandTotalAmount')].forEach((v, i) =>
+    page.tag('TD', () => page.text(`${v} ${field('InvoiceCurrencyCode')}`, { x: 56 + i * 140, y: 170, font }), { headers: [`h${i}`] })));
+});
+await pdf.facturX(xml, { profile });
+await pdf.end();
+console.log(`wrote ${outFile}: PDF/A-3a with factur-x.xml (${profile})`);

package/examples/harfbuzz-shaper.mjs

@@ -0,0 +1,27 @@
+// A shaper for @reportwright/pdf's embedFont(bytes, { shaper }) built on harfbuzzjs (npm i harfbuzzjs). harfbuzzjs is
+// not a dependency of @reportwright/pdf: copy this file, or import it where harfbuzzjs is installed.
+//
+//   import { harfbuzzShaper } from './harfbuzz-shaper.mjs';
+//   const bytes = fs.readFileSync('NotoSansArabic-Regular.ttf');
+//   const arabic = await pdf.embedFont(bytes, { shaper: harfbuzzShaper(bytes) });
+//   page.text('مرحبا بالعالم', { x: 40, y: 40, font: arabic, size: 18, direction: 'rtl' });
+//
+// The shaper gets one run (one font, one direction) and returns its glyphs in visual order, in font units:
+// { g: glyph ID, cl: cluster (UTF-16 index of its first character), ax: x advance, dx, dy: offsets }.
+import * as hb from 'harfbuzzjs';
+
+const NO_KERN = [new hb.Feature('kern', 0)];
+
+/** @param {Uint8Array} fontBytes the same bytes passed to embedFont */
+export function harfbuzzShaper(fontBytes) {
+  const font = new hb.Font(new hb.Face(new hb.Blob(fontBytes))); // scale: units per em, so positions are font units
+  return (text, _font, { direction, kerning }) => {
+    const b = new hb.Buffer();
+    b.addText(text); // clusters are UTF-16 indices, as JavaScript strings count
+    b.guessSegmentProperties(); // script and language from the text
+    b.setDirection(direction === 'rtl' ? hb.Direction.RTL : hb.Direction.LTR);
+    hb.shape(font, b, kerning ? [] : NO_KERN);
+    const pos = b.getGlyphPositions();
+    return b.getGlyphInfos().map((g, i) => ({ g: g.codepoint, cl: g.cluster, ax: pos[i].xAdvance, dx: pos[i].xOffset, dy: pos[i].yOffset }));
+  };
+}