@kreiseck/kasseneck-api 0.10.0 → 0.12.0

package/dist/esm/receipt/epos.js

@@ -1,11 +1,62 @@
+import { QR_DRUCK_PUNKTE, QR_MINDEST_PUNKTE, QR_MODUL_DECKEL, qrGroesseFuer, } from '../printing/index.js';
 import { renderReceiptGrid, ZEICHEN_JE_PAPIER } from './grid.js';
 export function eposXmlEscape(text) {
     return text.replace(/&/g, '&amp;').replace(/</g, '&lt;').replace(/>/g, '&gt;').replace(/"/g, '&quot;').replace(/'/g, '&apos;');
 }
 const NS = 'http://www.epson-pos.com/schemas/2011/03/epos-print';
+/** Nur das XML; wer die QR-Meldungen braucht, nimmt [eposPrintXmlErgebnis]. */
 export function eposPrintXml(layout, options = {}) {
+    return eposPrintXmlErgebnis(layout, options).xml;
+}
+/**
+ * Wie [eposPrintXml], gibt aber zusaetzlich zurueck, was dem QR zugestossen
+ * ist.
+ *
+ * **Die QR-Modulgroesse wird gerechnet.** Vorher stand hier fest 6, unabhaengig
+ * von der Papierbreite: ein Beleg-QR mit realer RKSV-Nutzlast hat 57 Module,
+ * mit Ruhezone 65, bei sechs Punkten also 390 Druckpunkte -- und ein
+ * 58-mm-Kopf hat 384. Der Epson schneidet ein zu breites Symbol nicht ab, er
+ * laesst es weg; genau daran fehlte am echten Beleg der QR.
+ */
+export function eposPrintXmlErgebnis(layout, options = {}) {
     const grid = renderReceiptGrid(layout, { zeichen: options.zeichen ?? ZEICHEN_JE_PAPIER[layout.paperSize] });
-    const qrBreite = Math.min(16, Math.max(3, Math.floor(options.qrBreite ?? 6)));
+    const deckel = options.qrGroesse ?? 'mittel';
+    const fest = options.qrBreite === undefined
+        ? null
+        : Math.min(16, Math.max(3, Math.floor(options.qrBreite)));
+    let qrFehler = null;
+    let qrAusweich = null;
+    /**
+     * Die Breite fuer eine QR-Zeile, oder `null` -- dann geht **kein** Symbol
+     * hinaus: ein Element, von dem man weiss, dass der Drucker es weglaesst,
+     * taeuscht nur einen Ausdruck vor.
+     *
+     * Eine leere Nutzlast geht unveraendert den Bestandsweg (Deckel), wie am
+     * ESC/POS-Befehl: sie ist ein Datenfehler, kein Papierfehler.
+     */
+    const qrBreiteFuer = (nutzlast) => {
+        if (fest !== null)
+            return fest;
+        if (nutzlast === '')
+            return QR_MODUL_DECKEL[deckel];
+        const mass = qrGroesseFuer({
+            nutzlast,
+            papierbreitePunkte: QR_DRUCK_PUNKTE[layout.paperSize],
+            groesse: deckel,
+        });
+        if (!mass.passt) {
+            qrFehler =
+                `QR mit ${mass.module} Modulen ist fuer ${layout.paperSize === 'mm58' ? 58 : 80} mm ` +
+                    `(${QR_DRUCK_PUNKTE[layout.paperSize]} Punkte) zu breit`;
+            return null;
+        }
+        if (mass.unterMindestmass) {
+            qrAusweich =
+                `QR mit ${mass.module} Modulen passt nur mit ${String(mass.punkte)} Punkten ` +
+                    `je Modul -- unter dem Mindestmass von ${QR_MINDEST_PUNKTE}`;
+        }
+        return mass.punkte;
+    };
     const out = [];
     out.push(`<epos-print xmlns="${NS}">`);
     out.push('<text lang="de"/>');
@@ -17,11 +68,15 @@ export function eposPrintXml(layout, options = {}) {
             case 'space':
                 out.push('<feed line="1"/>');
                 break;
-            case 'qr':
+            case 'qr': {
+                const breite = qrBreiteFuer(z.qr ?? '');
+                if (breite === null)
+                    break;
                 out.push('<text align="center"/>');
-                out.push(`<symbol type="qrcode_model_2" level="level_m" width="${qrBreite}" height="0" size="0">${eposXmlEscape(z.qr ?? '')}</symbol>`);
+                out.push(`<symbol type="qrcode_model_2" level="level_m" width="${breite}" height="0" size="0">${eposXmlEscape(z.qr ?? '')}</symbol>`);
                 out.push('<text align="left"/>');
                 break;
+            }
             case 'banner':
                 out.push(`<text width="1" height="2" reverse="${z.ton === 'warnung' ? 'true' : 'false'}" em="true">${eposXmlEscape(z.text)}&#10;</text>`);
                 out.push('<text width="1" height="1" reverse="false" em="false"/>');
@@ -41,7 +96,7 @@ export function eposPrintXml(layout, options = {}) {
         out.push('<cut type="feed"/>');
     }
     out.push('</epos-print>');
-    return out.join('\n');
+    return { xml: out.join('\n'), qrFehler, qrAusweich };
 }
 const EPOS_DEVID_VORGABE = 'local_printer';
 export function eposServiceUrl(ip, devid = EPOS_DEVID_VORGABE, timeoutMs = 10000) {
@@ -148,7 +203,12 @@ async function eposDirectSend(innerXml, o, fetchFn) {
 /** Beleg direkt drucken; wirft bei Netz-/Zertifikatsproblemen, sonst die Drucker-Antwort. */
 export function eposDirectPrint(layout, o, fetchFn = fetch) {
     const papier = o.papier ?? layout.paperSize;
-    return eposDirectSend(eposPrintXml({ ...layout, paperSize: papier }, { zeichen: ZEICHEN_JE_PAPIER[papier] }), o, fetchFn);
+    const xmlOptionen = { zeichen: ZEICHEN_JE_PAPIER[papier] };
+    if (o.qrBreite !== undefined)
+        xmlOptionen.qrBreite = o.qrBreite;
+    if (o.qrGroesse !== undefined)
+        xmlOptionen.qrGroesse = o.qrGroesse;
+    return eposDirectSend(eposPrintXml({ ...layout, paperSize: papier }, xmlOptionen), o, fetchFn);
 }
 /** Verbindungstest: leeres Dokument, druckt nichts, liefert den Druckerstatus. */
 export function eposDirectStatus(o, fetchFn = fetch) {

package/dist/esm/receipt/index.d.ts

@@ -1,4 +1,4 @@
 export { type LayoutAlign, type LayoutColumn, type LayoutTextLine, type LayoutColumnsLine, type LayoutRuleLine, type LayoutSpaceLine, type LayoutQrLine, type LayoutLine, type ReceiptLayout, type BuildReceiptLayoutOptions, buildReceiptLayout, receiptSignatureFailed, receiptSignatureIsTest, receiptIsZero, receiptAmountsAreZero, receiptIsSmallBusinessConsistent, receiptZdaText, type Pruefangaben, AKTUELLES_REGELWERK, type LayoutBannerLine, type LayoutRegelwerk, SMALL_BUSINESS_NOTICE, formatCents, } from './layout.js';
-export { type EscPosLayoutOptions, escPosLayoutBytes } from './layout-escpos.js';
+export { type EscPosLayoutOptions, type EscPosLayoutErgebnis, type QrPrintMode, escPosLayoutBytes, escPosLayoutErgebnis, } from './layout-escpos.js';
 export { type GridLine, type GridLineKind, type ReceiptGrid, type RenderReceiptGridOptions, renderReceiptGrid, gridSpaltenBreiten, gridAlsText, ZEICHEN_JE_PAPIER, } from './grid.js';
-export { type EposPrintXmlOptions, type EposDirectOptions, type EposResponse, EposConnectionError, eposPrintXml, eposXmlEscape, eposServiceUrl, eposSoapEnvelope, eposParseResponse, eposDirectPrint, eposDirectStatus } from './epos.js';
+export { type EposPrintXmlOptions, type EposPrintErgebnis, type EposDirectOptions, type EposResponse, EposConnectionError, eposPrintXml, eposPrintXmlErgebnis, eposXmlEscape, eposServiceUrl, eposSoapEnvelope, eposParseResponse, eposDirectPrint, eposDirectStatus } from './epos.js';

package/dist/esm/receipt/index.js

@@ -1,4 +1,4 @@
 export { buildReceiptLayout, receiptSignatureFailed, receiptSignatureIsTest, receiptIsZero, receiptAmountsAreZero, receiptIsSmallBusinessConsistent, receiptZdaText, AKTUELLES_REGELWERK, SMALL_BUSINESS_NOTICE, formatCents, } from './layout.js';
-export { escPosLayoutBytes } from './layout-escpos.js';
+export { escPosLayoutBytes, escPosLayoutErgebnis, } from './layout-escpos.js';
 export { renderReceiptGrid, gridSpaltenBreiten, gridAlsText, ZEICHEN_JE_PAPIER, } from './grid.js';
-export { EposConnectionError, eposPrintXml, eposXmlEscape, eposServiceUrl, eposSoapEnvelope, eposParseResponse, eposDirectPrint, eposDirectStatus } from './epos.js';
+export { EposConnectionError, eposPrintXml, eposPrintXmlErgebnis, eposXmlEscape, eposServiceUrl, eposSoapEnvelope, eposParseResponse, eposDirectPrint, eposDirectStatus } from './epos.js';

package/dist/esm/receipt/layout-escpos.d.ts

@@ -1,4 +1,4 @@
-import { type PosCodeTable, type PosCutMode, type PosPaperSize, type QrCorrection, type QrSize } from '../printing/index.js';
+import { type PosCodeTable, type PosCutMode, type PosPaperSize, type QrCorrection, type QrMatrix, type QrModulGroesse, type QrSize } from '../printing/index.js';
 import type { ReceiptLayout } from './layout.js';
 /**
  * Bruecke vom Layout-Modell zu ESC/POS-Bytes — der Bondrucker-Ausgabeweg.
@@ -14,6 +14,20 @@ import type { ReceiptLayout } from './layout.js';
  * ein unerwartetes Zeichen darin soll darum auffallen und nicht still
  * verfaelscht werden.
  */
+/**
+ * Wie der Beleg-QR auf das Papier kommt — Zwilling von `QrPrintMode`
+ * (kasseneck_api/lib/enums/qr_print_mode.dart).
+ *
+ * - `native`      — der Druckbefehl `GS ( k`; der Drucker zeichnet selbst.
+ *                   Ohne Modellbefehl, also byteidentisch zum Bestand.
+ * - `nativeModel1` — derselbe Befehl mit ausdruecklicher Wahl von **Modell 1**
+ *                   (`GS ( k 04 00 31 41 31 00`). Fuer guenstige Geraete, die
+ *                   nur diesen aelteren Symboltyp beherrschen; belegt ist
+ *                   eines, das bei Modell 2 unter dem Code eine "0" ausgibt.
+ * - `imageRaster` — der QR als Rasterbild. Braucht ein Raster vom Aufrufer
+ *                   (`qrMatrix`), weil dieses Paket keine QR-Codes rechnet.
+ */
+export type QrPrintMode = 'native' | 'nativeModel1' | 'imageRaster';
 export interface EscPosLayoutOptions {
     /** Papierbreite; Vorgabe ist die des Layouts (dessen Spaltenbreiten daran haengen). */
     paperSize?: PosPaperSize;
@@ -21,10 +35,38 @@ export interface EscPosLayoutOptions {
     codeTable?: PosCodeTable | null;
     /** Papierschnitt am Ende: `true` (voll), `'partial'` oder `false`. Vorgabe `true`. */
     cut?: boolean | PosCutMode;
-    /** Modulgroesse des QR-Codes. */
+    /**
+     * Feste Modulgroesse des QR-Codes. Gesetzt schaltet sie die Rechnung ab —
+     * dann passt der Aufrufer selbst auf, dass das Symbol aufs Papier geht.
+     */
     qrSize?: QrSize;
     /** Fehlerkorrekturstufe des QR-Codes. */
     qrCorrection?: QrCorrection;
+    /** Deckel fuer die gerechnete Modulgroesse; Vorgabe `auto`. */
+    qrGroesse?: QrModulGroesse;
+    /** Druckweg des QR; Vorgabe `native` (der Bestandsweg). */
+    qrModus?: QrPrintMode;
+    /**
+     * Raster fuer den Bildweg — ohne das gibt es keinen Notausgang.
+     *
+     * Dieses Paket rechnet keine QR-Codes und verarbeitet keine Bilder (siehe
+     * Kopf von `layout.ts`); der Aufrufer bringt das fertige Raster mit, etwa
+     * aus der QR-Bibliothek, die er ohnehin fuer den Bildschirm benutzt.
+     */
+    qrMatrix?: (nutzlast: string) => QrMatrix;
+}
+/**
+ * Der Bytestrom **samt** dem, was dem QR unterwegs zugestossen ist.
+ *
+ * Zwilling von `KeckPrintResult`: `qrFehler` heisst "Beleg ohne QR,
+ * nachdrucken oder elektronisch ausgeben", `qrAusweich` heisst "gedruckt,
+ * aber der eingestellte Weg taugt fuer dieses Geraet nicht" — das eine gehoert
+ * dem Kunden gesagt, das andere dem Chef.
+ */
+export interface EscPosLayoutErgebnis {
+    bytes: Uint8Array;
+    qrFehler: string | null;
+    qrAusweich: string | null;
 }
 /**
  * Bytes fuer den Bondrucker -- **aus dem Zeichenraster** ([renderReceiptGrid]):
@@ -33,3 +75,9 @@ export interface EscPosLayoutOptions {
  * zeigt, druckt der Drucker (Monospace, Font A: 32/48 Zeichen).
  */
 export declare function escPosLayoutBytes(layout: ReceiptLayout, options?: EscPosLayoutOptions): Uint8Array;
+/**
+ * Wie [escPosLayoutBytes], gibt aber zusaetzlich zurueck, was dem QR
+ * zugestossen ist. Die Bytes sind dieselben; wer die Meldungen braucht, nimmt
+ * diesen Weg.
+ */
+export declare function escPosLayoutErgebnis(layout: ReceiptLayout, options?: EscPosLayoutOptions): EscPosLayoutErgebnis;

package/dist/esm/receipt/layout-escpos.js

@@ -1,4 +1,4 @@
-import { createEscPosDocument, escPosBytes, escPosCut, escPosFeed, escPosPrintableText, escPosQrCode, escPosReset, escPosText, } from '../printing/index.js';
+import { createEscPosDocument, escPosBytes, escPosCut, escPosFeed, escPosPrintableText, escPosQrCode, escPosQrRaster, escPosReset, escPosText, QR_DRUCK_PUNKTE, qrGroesseFuer, } from '../printing/index.js';
 import { renderReceiptGrid, ZEICHEN_JE_PAPIER } from './grid.js';
 /**
  * Druckbar gemachtes Layout: Texte durch [escPosPrintableText] (Codepage,
@@ -26,6 +26,14 @@ function druckbaresLayout(layout) {
  * zeigt, druckt der Drucker (Monospace, Font A: 32/48 Zeichen).
  */
 export function escPosLayoutBytes(layout, options = {}) {
+    return escPosLayoutErgebnis(layout, options).bytes;
+}
+/**
+ * Wie [escPosLayoutBytes], gibt aber zusaetzlich zurueck, was dem QR
+ * zugestossen ist. Die Bytes sind dieselben; wer die Meldungen braucht, nimmt
+ * diesen Weg.
+ */
+export function escPosLayoutErgebnis(layout, options = {}) {
     const paperSize = options.paperSize ?? layout.paperSize;
     const dokumentOptionen = { paperSize };
     if (options.codeTable !== undefined) {
@@ -33,11 +41,59 @@ export function escPosLayoutBytes(layout, options = {}) {
     }
     const doc = createEscPosDocument(dokumentOptionen);
     escPosReset(doc);
+    const modus = options.qrModus ?? 'native';
     const qrOptionen = { align: 'center' };
     if (options.qrSize !== undefined)
         qrOptionen.size = options.qrSize;
     if (options.qrCorrection !== undefined)
         qrOptionen.correction = options.qrCorrection;
+    if (options.qrGroesse !== undefined)
+        qrOptionen.groesse = options.qrGroesse;
+    if (modus === 'nativeModel1')
+        qrOptionen.modell1 = true;
+    if (modus === 'imageRaster' && options.qrMatrix === undefined) {
+        throw new Error("qrModus 'imageRaster' braucht ein qrMatrix -- dieses Paket rastert nicht selbst");
+    }
+    const rasterOptionen = { align: 'center' };
+    if (options.qrGroesse !== undefined)
+        rasterOptionen.groesse = options.qrGroesse;
+    /**
+     * Eine QR-Zeile des Rasters. Hier sitzt der **Notausgang**: passt das Symbol
+     * nativ auch mit der Ausnahmegroesse nicht aufs Papier, druckt der Drucker
+     * es GAR NICHT -- er schneidet nicht ab, er laesst weg. Ein Pflichtbeleg
+     * ohne QR ist der schlechteste aller Ausgaenge, also geht der QR dann als
+     * Bild hinaus, und der Aufrufer erfaehrt es ueber `qrAusweich`.
+     *
+     * Ohne `qrMatrix` gibt es diesen Weg nicht -- dann bleibt nur die Meldung
+     * `qrFehler` aus `escPosQrCode`, und der Beleg geht ohne QR hinaus.
+     */
+    const qrZeile = (nutzlast) => {
+        const raster = options.qrMatrix;
+        if (nutzlast !== '' && raster !== undefined) {
+            if (modus === 'imageRaster') {
+                escPosQrRaster(doc, raster(nutzlast), rasterOptionen);
+                return;
+            }
+            // Feste `qrSize` heisst: der Aufrufer weiss, was er tut -- dann wird
+            // weder gerechnet noch ausgewichen.
+            if (options.qrSize === undefined) {
+                const mass = qrGroesseFuer({
+                    nutzlast,
+                    papierbreitePunkte: QR_DRUCK_PUNKTE[paperSize],
+                    groesse: options.qrGroesse ?? 'auto',
+                });
+                if (!mass.passt) {
+                    doc.qrAusweich =
+                        `QR mit ${mass.module} Modulen passt nativ nicht auf ` +
+                            `${paperSize === 'mm58' ? 58 : 80} mm (${QR_DRUCK_PUNKTE[paperSize]} Punkte) ` +
+                            `-- als Bild gedruckt`;
+                    escPosQrRaster(doc, raster(nutzlast), rasterOptionen);
+                    return;
+                }
+            }
+        }
+        escPosQrCode(doc, nutzlast, qrOptionen);
+    };
     const grid = renderReceiptGrid(druckbaresLayout(layout), { zeichen: ZEICHEN_JE_PAPIER[paperSize] });
     for (const zeile of grid.lines) {
         switch (zeile.kind) {
@@ -45,7 +101,7 @@ export function escPosLayoutBytes(layout, options = {}) {
                 escPosFeed(doc, 1);
                 break;
             case 'qr':
-                escPosQrCode(doc, zeile.qr ?? '', qrOptionen);
+                qrZeile(zeile.qr ?? '');
                 break;
             case 'banner': {
                 // Belegart/Warnung: fett zwischen zwei Volllinien — derselbe Rahmen-
@@ -65,5 +121,5 @@ export function escPosLayoutBytes(layout, options = {}) {
     if (options.cut !== false) {
         escPosCut(doc, options.cut === 'partial' ? 'partial' : 'full');
     }
-    return escPosBytes(doc);
+    return { bytes: escPosBytes(doc), qrFehler: doc.qrFehler, qrAusweich: doc.qrAusweich };
 }

package/fixtures/hobex-hps-codes.json

@@ -1,5 +1,5 @@
 {
-  "version": "0.10.0",
+  "version": "0.12.0",
   "gemessenAn": {
     "tid": "3600335",
     "hpsVersion": "1.10.0",

package/fixtures/kasse-texte.json

@@ -1,5 +1,5 @@
 {
-  "version": "0.10.0",
+  "version": "0.12.0",
   "meldungen": {
     "netz.keine_verbindung": {
       "text": "Keine Verbindung zum Server. Bitte die Internetverbindung prüfen und erneut versuchen."

package/fixtures/oberflaeche.json

@@ -1,5 +1,5 @@
 {
-  "version": "0.10.0",
+  "version": "0.12.0",
   "aufrufe": [
     "activateCashregister",
     "cancelReceipt",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kreiseck/kasseneck-api",
-  "version": "0.10.0",
+  "version": "0.12.0",
   "description": "JavaScript-Zwilling von kasseneck_api (Flutter) fuer das Kasseneck-Backend",
   "license": "Apache-2.0",
   "author": "Kreiseck",