@kreiseck/kasseneck-api 0.11.0 → 0.12.0

package/CHANGELOG.md

@@ -4,6 +4,26 @@ Was vor 0.7.0 geschah, steht in der Commit-Historie (`git log`); ab hier wird
 es hier geführt. Ein Eintrag nennt die Änderung **und ihren Grund** —
 nur der Grund überlebt den nächsten Umbau.
 
+## 0.12.0
+
+### Storno mit Kartendaten der Erstattung
+
+**Anlass:** sastre zieht vom alten Storno-Weg (`createCancelReceipt`, ohne
+Bezug) auf `cancelReceipt` um. Bei einer Kartenerstattung haengt sastre heute
+die Terminaldaten der Gutschrift/Aufhebung an den Stornobeleg -- ueber den
+neuen Endpunkt ging das bisher nicht, der Kartenblock fiele vom Storno-Bon.
+Backend: keck#371.
+
+- **`cancelReceipt` nimmt `creditCardProvider`, `cardPaymentId` und
+  `cardPaymentData` an** -- die Daten der ERSTATTUNG, nie der Originalzahlung.
+  Nur bei Rueckzahlweg Karte: ein ausdruecklich anderer `paymentMethod` wird
+  schon hier abgewiesen, ohne Angabe entscheidet das Backend an der
+  Zahlungsart des Originals. Ein unbekannter Kartenanbieter geht gar nicht erst
+  raus.
+- Ohne Kartendaten aendert sich nichts.
+- `package-lock.json` traegt wieder die Paketversion (stand seit 0.11.0 auf
+  0.10.0).
+
 ## 0.11.0
 
 ### Die QR-Modulgröße wird gerechnet, nicht gesetzt — samt Notausgang und Modell 1

package/dist/cjs/client/receipts.d.ts

@@ -117,6 +117,14 @@ export type CancelReceiptOptions = {
     note?: string;
     /** Rueckzahlweg; ohne Angabe die Zahlungsart des stornierten Belegs. */
     paymentMethod?: KeckPaymentMethod | KeckPaymentMethodKey;
+    /**
+     * Kartendaten der ERSTATTUNG (Gutschrift oder Aufhebung am Terminal) fuer
+     * den Kartenblock am Storno-Bon -- nur bei Rueckzahlweg Karte. Beschreiben
+     * nie die Originalzahlung; das Backend uebernimmt sie nicht vom Original.
+     */
+    creditCardProvider?: CreditCardProvider;
+    cardPaymentId?: string;
+    cardPaymentData?: Record<string, unknown>;
 } & ({
     receipt: Receipt;
     cashregisterId?: string;

package/dist/cjs/client/receipts.js

@@ -154,6 +154,24 @@ async function cancelReceipt(rufen, options) {
         params.note = options.note;
     if (options.paymentMethod != null)
         params.paymentMethod = gepruefteZahlungsart(options.paymentMethod);
+    const karte = options.creditCardProvider != null || options.cardPaymentId != null || options.cardPaymentData != null;
+    if (karte) {
+        // Ohne paymentMethod entscheidet das Backend an der Zahlungsart des
+        // Originals; ein ausdruecklich anderer Rueckzahlweg ist hier schon falsch.
+        if (params.paymentMethod != null && params.paymentMethod !== index_js_1.KeckPaymentMethod.creditCard.value) {
+            throw new errors_js_1.KasseneckValidationError('cancelReceipt', 'Kartendaten gibt es nur bei paymentMethod creditCard', 'request');
+        }
+        if (options.creditCardProvider != null) {
+            if (!Object.prototype.hasOwnProperty.call(index_js_1.CreditCardProvider, options.creditCardProvider)) {
+                throw new errors_js_1.KasseneckValidationError('cancelReceipt', `Kartenanbieter: unbekannter Schluessel "${options.creditCardProvider}"`, 'request');
+            }
+            params.creditCardProvider = options.creditCardProvider;
+        }
+        if (options.cardPaymentId != null && options.cardPaymentId !== '')
+            params.cardPaymentId = options.cardPaymentId;
+        if (options.cardPaymentData != null)
+            params.cardPaymentData = options.cardPaymentData;
+    }
     const daten = await rufen('cancelReceipt', params);
     const receipt = belegAusHuelle(daten, 'cancelReceipt');
     const huelle = daten;

package/dist/esm/client/receipts.d.ts

@@ -117,6 +117,14 @@ export type CancelReceiptOptions = {
     note?: string;
     /** Rueckzahlweg; ohne Angabe die Zahlungsart des stornierten Belegs. */
     paymentMethod?: KeckPaymentMethod | KeckPaymentMethodKey;
+    /**
+     * Kartendaten der ERSTATTUNG (Gutschrift oder Aufhebung am Terminal) fuer
+     * den Kartenblock am Storno-Bon -- nur bei Rueckzahlweg Karte. Beschreiben
+     * nie die Originalzahlung; das Backend uebernimmt sie nicht vom Original.
+     */
+    creditCardProvider?: CreditCardProvider;
+    cardPaymentId?: string;
+    cardPaymentData?: Record<string, unknown>;
 } & ({
     receipt: Receipt;
     cashregisterId?: string;

package/dist/esm/client/receipts.js

@@ -140,6 +140,24 @@ export async function cancelReceipt(rufen, options) {
         params.note = options.note;
     if (options.paymentMethod != null)
         params.paymentMethod = gepruefteZahlungsart(options.paymentMethod);
+    const karte = options.creditCardProvider != null || options.cardPaymentId != null || options.cardPaymentData != null;
+    if (karte) {
+        // Ohne paymentMethod entscheidet das Backend an der Zahlungsart des
+        // Originals; ein ausdruecklich anderer Rueckzahlweg ist hier schon falsch.
+        if (params.paymentMethod != null && params.paymentMethod !== KeckPaymentMethod.creditCard.value) {
+            throw new KasseneckValidationError('cancelReceipt', 'Kartendaten gibt es nur bei paymentMethod creditCard', 'request');
+        }
+        if (options.creditCardProvider != null) {
+            if (!Object.prototype.hasOwnProperty.call(CreditCardProvider, options.creditCardProvider)) {
+                throw new KasseneckValidationError('cancelReceipt', `Kartenanbieter: unbekannter Schluessel "${options.creditCardProvider}"`, 'request');
+            }
+            params.creditCardProvider = options.creditCardProvider;
+        }
+        if (options.cardPaymentId != null && options.cardPaymentId !== '')
+            params.cardPaymentId = options.cardPaymentId;
+        if (options.cardPaymentData != null)
+            params.cardPaymentData = options.cardPaymentData;
+    }
     const daten = await rufen('cancelReceipt', params);
     const receipt = belegAusHuelle(daten, 'cancelReceipt');
     const huelle = daten;

package/fixtures/hobex-hps-codes.json

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

package/fixtures/kasse-texte.json

@@ -1,5 +1,5 @@
 {
-  "version": "0.11.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.11.0",
+  "version": "0.12.0",
   "aufrufe": [
     "activateCashregister",
     "cancelReceipt",

package/package.json

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