@kreiseck/kasseneck-api 1.4.0 → 1.5.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +166 -0
- package/README.md +255 -36
- package/dist/cjs/client/aufrufe.d.ts +58 -4
- package/dist/cjs/client/aufrufe.js +196 -1
- package/dist/cjs/client/errors.d.ts +32 -19
- package/dist/cjs/client/errors.js +28 -17
- package/dist/cjs/client/index.d.ts +2 -2
- package/dist/cjs/client/index.js +2 -1
- package/dist/cjs/client/transport.d.ts +27 -1
- package/dist/cjs/client/transport.js +25 -27
- package/dist/cjs/index.d.ts +1 -1
- package/dist/cjs/index.js +3 -2
- package/dist/cjs/inventory/api.d.ts +19 -3
- package/dist/cjs/inventory/api.js +18 -2
- package/dist/cjs/inventory/endpunkte.d.ts +22 -2
- package/dist/cjs/inventory/endpunkte.js +6 -1
- package/dist/cjs/inventory/fehler.d.ts +11 -1
- package/dist/cjs/inventory/fehler.js +19 -0
- package/dist/cjs/inventory/index.d.ts +6 -4
- package/dist/cjs/inventory/index.js +32 -2
- package/dist/cjs/inventory/lesen.d.ts +8 -1
- package/dist/cjs/inventory/lesen.js +131 -1
- package/dist/cjs/inventory/schreiben.d.ts +86 -0
- package/dist/cjs/inventory/schreiben.js +320 -0
- package/dist/cjs/inventory/typen.d.ts +371 -11
- package/dist/cjs/inventory/vertrag.d.ts +76 -16
- package/dist/cjs/inventory/vertrag.js +138 -13
- package/dist/cjs/inventory/webhook.d.ts +3 -1
- package/dist/cjs/inventory/webhook.js +7 -1
- package/dist/cjs/invoice/endpunkte.d.ts +6 -0
- package/dist/cjs/invoice/endpunkte.js +13 -2
- package/dist/cjs/invoice/index.d.ts +2 -2
- package/dist/cjs/invoice/index.js +2 -1
- package/dist/cjs/invoice/typen.d.ts +46 -2
- package/dist/cjs/invoice/vertrag.d.ts +19 -5
- package/dist/cjs/invoice/vertrag.js +37 -5
- package/dist/cjs/pos/texte.d.ts +11 -6
- package/dist/cjs/pos/texte.js +11 -6
- package/dist/cjs/stored/vokabular.d.ts +1 -1
- package/dist/cjs/stored/vokabular.js +5 -3
- package/dist/cjs/version.d.ts +1 -1
- package/dist/cjs/version.js +1 -1
- package/dist/esm/client/aufrufe.d.ts +58 -4
- package/dist/esm/client/aufrufe.js +194 -0
- package/dist/esm/client/errors.d.ts +32 -19
- package/dist/esm/client/errors.js +28 -17
- package/dist/esm/client/index.d.ts +2 -2
- package/dist/esm/client/index.js +1 -1
- package/dist/esm/client/transport.d.ts +27 -1
- package/dist/esm/client/transport.js +26 -28
- package/dist/esm/index.d.ts +1 -1
- package/dist/esm/index.js +1 -1
- package/dist/esm/inventory/api.d.ts +19 -3
- package/dist/esm/inventory/api.js +18 -2
- package/dist/esm/inventory/endpunkte.d.ts +22 -2
- package/dist/esm/inventory/endpunkte.js +6 -5
- package/dist/esm/inventory/fehler.d.ts +11 -1
- package/dist/esm/inventory/fehler.js +18 -1
- package/dist/esm/inventory/index.d.ts +6 -4
- package/dist/esm/inventory/index.js +5 -3
- package/dist/esm/inventory/lesen.d.ts +8 -1
- package/dist/esm/inventory/lesen.js +127 -1
- package/dist/esm/inventory/schreiben.d.ts +86 -0
- package/dist/esm/inventory/schreiben.js +303 -0
- package/dist/esm/inventory/typen.d.ts +371 -11
- package/dist/esm/inventory/vertrag.d.ts +76 -16
- package/dist/esm/inventory/vertrag.js +137 -12
- package/dist/esm/inventory/webhook.d.ts +3 -1
- package/dist/esm/inventory/webhook.js +8 -2
- package/dist/esm/invoice/endpunkte.d.ts +6 -0
- package/dist/esm/invoice/endpunkte.js +13 -2
- package/dist/esm/invoice/index.d.ts +2 -2
- package/dist/esm/invoice/index.js +1 -1
- package/dist/esm/invoice/typen.d.ts +46 -2
- package/dist/esm/invoice/vertrag.d.ts +19 -5
- package/dist/esm/invoice/vertrag.js +36 -4
- package/dist/esm/pos/texte.d.ts +11 -6
- package/dist/esm/pos/texte.js +11 -6
- package/dist/esm/stored/vokabular.d.ts +1 -1
- package/dist/esm/stored/vokabular.js +5 -3
- package/dist/esm/version.d.ts +1 -1
- package/dist/esm/version.js +1 -1
- package/fixtures/hobex-hps-codes.json +1 -1
- package/fixtures/invoice-api-examples/credit-error-reservation.json +26 -0
- package/fixtures/invoice-api-examples/issue-error-reservation-article.json +25 -0
- package/fixtures/invoice-api-examples/issue-error-vat-id-risk.json +26 -0
- package/fixtures/invoice-api-examples/issue-reservation.json +24 -0
- package/fixtures/invoice-api-examples/issue-vat-id-risk.json +28 -0
- package/fixtures/invoice-api.schema.json +15 -2
- package/fixtures/invoice-texts.json +1 -1
- package/fixtures/pos-texts.json +1 -1
- package/fixtures/surface.json +206 -9
- package/fixtures/v3/antworten/belege.json +2 -2
- package/fixtures/v3/antworten/belegmail.json +2 -2
- package/fixtures/v3/antworten/kasse-belege.json +2 -2
- package/fixtures/v3/antworten/kasse.json +3 -3
- package/fixtures/v3/antworten/lager.json +2491 -130
- package/fixtures/v3/antworten/rechnungen.json +267 -44
- package/fixtures/v3/antworten/storno.json +2 -2
- package/fixtures/v3/stored/belege.json +2 -2
- package/fixtures/v3/stored/kasse.json +3 -3
- package/fixtures/v3/stored/rechnungen.json +174 -18
- package/fixtures/v3/v3-vokabular.json +593 -23
- package/fixtures/v3/zahlbetrag-faelle.json +2 -2
- package/package.json +1 -1
|
@@ -12,8 +12,8 @@
|
|
|
12
12
|
* weiterhin jeden `string`: wer einen Aufruf braucht, den dieses Paket nicht
|
|
13
13
|
* umhuellt, muss ihn weiterhin absetzen koennen.
|
|
14
14
|
*/
|
|
15
|
-
import type { TransportBodyFields } from './transport.js';
|
|
16
|
-
export declare const ALL_CALLS: readonly ["activateCashregister", "cancelInvoice", "cancelReceipt", "createCreditNote", "createCustomer", "createCustomerCashregister", "createPartnerCustomer", "checkPartnerCustomerEmail", "createPartnerWebhook", "createPaymentLinkStripe", "createPrintJob", "createReceipt", "deletePartnerWebhook", "downloadDailyReport", "downloadReport", "endRegisterSession", "financeWebService", "generateFullReceiptId", "getCustomer", "getCustomerCredentials", "getCustomerSignatureStatus", "getFirstReceiptDate", "getInvoice", "getInvoicePdf", "getInvoiceSetupStatus", "getInvoiceXml", "getKasseSettings", "getPartnerCustomer", "getPartnerInfo", "getPrintJob", "getReceipt", "getReportV2", "hobexPayApi", "hobexRefundApi", "issueInvoice", "listCustomerCashregisters", "listInvoices", "listBrands", "listMyArticleGroups", "listMyArticles", "listMyCashregisters", "listMyPrinters", "listMyReceipts", "listMyStock", "listMyStockLocations", "listMyTipRecipients", "listPartnerCustomers", "listPartnerWebhookDeliveries", "listPartnerWebhooks", "listRegisterUsersForDevice", "listRegisterSessionsForDevice", "pairRegisterDevice", "recordInvoicePayment", "registerPinLogin", "registerUserLogin", "renewRegisterSession", "reportCustomerContract", "requestCustomerSignature", "searchCustomers", "sendPartnerCustomerFonLink", "sendPartnerWebhookTest", "sendReceiptEmail", "setMyCashregisterStockLocation", "setMyKasseLogo", "setMyKasseSettings", "setMyRegisterDeviceSettings", "stripeCaptureIntent", "unpairRegisterDevice", "rotatePartnerWebhookSecret", "updateCustomer", "updatePartnerWebhook", "getArticle", "listArticles", "lookupArticleByCode", "listLocations", "getStock", "listStock", "listStockMovements", "createWebhook", "updateWebhook", "deleteWebhook", "listWebhooks", "sendWebhookTest", "rotateWebhookSecret", "listWebhookDeliveries"];
|
|
15
|
+
import type { TransportBodyFields, TransportCallOptions } from './transport.js';
|
|
16
|
+
export declare const ALL_CALLS: readonly ["activateCashregister", "cancelInvoice", "cancelReceipt", "createCreditNote", "createCustomer", "createCustomerCashregister", "createPartnerCustomer", "checkPartnerCustomerEmail", "createPartnerWebhook", "createPaymentLinkStripe", "createPrintJob", "createReceipt", "deletePartnerWebhook", "downloadDailyReport", "downloadReport", "endRegisterSession", "financeWebService", "generateFullReceiptId", "getCustomer", "getCustomerCredentials", "getCustomerSignatureStatus", "getFirstReceiptDate", "getInvoice", "getInvoicePdf", "getInvoiceSetupStatus", "getInvoiceXml", "getKasseSettings", "getPartnerCustomer", "getPartnerInfo", "getPrintJob", "getReceipt", "getReportV2", "hobexPayApi", "hobexRefundApi", "issueInvoice", "listCustomerCashregisters", "listInvoices", "listBrands", "listMyArticleGroups", "listMyArticles", "listMyCashregisters", "listMyPrinters", "listMyReceipts", "listMyStock", "listMyStockLocations", "listMyTipRecipients", "listPartnerCustomers", "listPartnerWebhookDeliveries", "listPartnerWebhooks", "listRegisterUsersForDevice", "listRegisterSessionsForDevice", "pairRegisterDevice", "recordInvoicePayment", "registerPinLogin", "registerUserLogin", "renewRegisterSession", "reportCustomerContract", "requestCustomerSignature", "searchCustomers", "sendPartnerCustomerFonLink", "sendPartnerWebhookTest", "sendReceiptEmail", "setMyCashregisterStockLocation", "setMyKasseLogo", "setMyKasseSettings", "setMyRegisterDeviceSettings", "stripeCaptureIntent", "unpairRegisterDevice", "rotatePartnerWebhookSecret", "updateCustomer", "updatePartnerWebhook", "getArticle", "listArticles", "lookupArticleByCode", "listLocations", "getStock", "listStock", "listStockMovements", "createWebhook", "updateWebhook", "deleteWebhook", "listWebhooks", "sendWebhookTest", "rotateWebhookSecret", "listWebhookDeliveries", "createArticle", "updateArticle", "deactivateArticle", "receiveGoods", "transferStock", "recordStockLoss", "changeStockCondition", "reverseStockMovement", "createReservation", "extendReservation", "releaseReservation", "getReservation", "listReservations"];
|
|
17
17
|
export type ApiCall = typeof ALL_CALLS[number];
|
|
18
18
|
/**
|
|
19
19
|
* Die oeffentlichen Endpunkte unter `/v3` (`https://api.kasseneck.at/v3/<name>`),
|
|
@@ -21,7 +21,7 @@ export type ApiCall = typeof ALL_CALLS[number];
|
|
|
21
21
|
* (`fixtures/v3/v3-vokabular.json`, `endpoints.public`, umbenannt nach
|
|
22
22
|
* `names`). Ein Test haelt beide Listen deckungsgleich.
|
|
23
23
|
*/
|
|
24
|
-
export declare const PUBLIC_CALLS: readonly ["createReceipt", "getReceipt", "cancelReceipt", "sendReceiptEmail", "generateFullReceiptId", "downloadReceipt", "getFirstReceiptDate", "getReportV2", "downloadReport", "downloadDailyReport", "createPaymentLinkStripe", "stripeCaptureIntent", "hobexPayApi", "hobexRefundApi", "hobexGetStatus", "financeWebService", "listMyTipRecipients", "getPartnerInfo", "createPartnerCustomer", "checkPartnerCustomerEmail", "listPartnerCustomers", "getPartnerCustomer", "sendPartnerCustomerFonLink", "createPartnerWebhook", "updatePartnerWebhook", "deletePartnerWebhook", "listPartnerWebhooks", "sendPartnerWebhookTest", "rotatePartnerWebhookSecret", "listPartnerWebhookDeliveries", "requestCustomerSignature", "getCustomerSignatureStatus", "createCustomerCashregister", "activateCashregister", "listCustomerCashregisters", "getCustomerCredentials", "reportCustomerContract", "getPartnerBilling", "getPartnerBillingMonth", "createCustomer", "getCustomer", "updateCustomer", "searchCustomers", "issueInvoice", "cancelInvoice", "createCreditNote", "getInvoice", "listInvoices", "getInvoicePdf", "getInvoiceXml", "getInvoiceSetupStatus", "listBrands", "recordInvoicePayment", "createInvoiceItem", "updateInvoiceItem", "withdrawInvoiceItem", "getInvoiceItem", "listInvoiceItems", "setCustomerMandate", "revokeCustomerMandate", "getArticle", "listArticles", "lookupArticleByCode", "listLocations", "getStock", "listStock", "listStockMovements", "createWebhook", "updateWebhook", "deleteWebhook", "listWebhooks", "sendWebhookTest", "rotateWebhookSecret", "listWebhookDeliveries"];
|
|
24
|
+
export declare const PUBLIC_CALLS: readonly ["createReceipt", "getReceipt", "cancelReceipt", "sendReceiptEmail", "generateFullReceiptId", "downloadReceipt", "getFirstReceiptDate", "getReportV2", "downloadReport", "downloadDailyReport", "createPaymentLinkStripe", "stripeCaptureIntent", "hobexPayApi", "hobexRefundApi", "hobexGetStatus", "financeWebService", "listMyTipRecipients", "getPartnerInfo", "createPartnerCustomer", "checkPartnerCustomerEmail", "listPartnerCustomers", "getPartnerCustomer", "sendPartnerCustomerFonLink", "createPartnerWebhook", "updatePartnerWebhook", "deletePartnerWebhook", "listPartnerWebhooks", "sendPartnerWebhookTest", "rotatePartnerWebhookSecret", "listPartnerWebhookDeliveries", "requestCustomerSignature", "getCustomerSignatureStatus", "createCustomerCashregister", "activateCashregister", "listCustomerCashregisters", "getCustomerCredentials", "reportCustomerContract", "getPartnerBilling", "getPartnerBillingMonth", "createCustomer", "getCustomer", "updateCustomer", "searchCustomers", "issueInvoice", "cancelInvoice", "createCreditNote", "getInvoice", "listInvoices", "getInvoicePdf", "getInvoiceXml", "getInvoiceSetupStatus", "listBrands", "recordInvoicePayment", "createInvoiceItem", "updateInvoiceItem", "withdrawInvoiceItem", "getInvoiceItem", "listInvoiceItems", "setCustomerMandate", "revokeCustomerMandate", "getArticle", "listArticles", "lookupArticleByCode", "listLocations", "getStock", "listStock", "listStockMovements", "createWebhook", "updateWebhook", "deleteWebhook", "listWebhooks", "sendWebhookTest", "rotateWebhookSecret", "listWebhookDeliveries", "createArticle", "updateArticle", "deactivateArticle", "receiveGoods", "transferStock", "recordStockLoss", "changeStockCondition", "reverseStockMovement", "createReservation", "extendReservation", "releaseReservation", "getReservation", "listReservations"];
|
|
25
25
|
/**
|
|
26
26
|
* Die Endpunkte des Kassenwegs (`https://kasse.kasseneck.at/api/v3/<name>`,
|
|
27
27
|
* Web-Kasse: gleicher Ursprung `/api/v3`), in der Reihenfolge von
|
|
@@ -31,6 +31,60 @@ export declare const PUBLIC_CALLS: readonly ["createReceipt", "getReceipt", "can
|
|
|
31
31
|
export declare const POS_CALLS: readonly ["pairRegisterDevice", "listRegisterUsersForDevice", "listRegisterSessionsForDevice", "registerUserLogin", "registerPinLogin", "renewRegisterSession", "endRegisterSession", "unpairRegisterDevice", "listMyCashregisters", "listMyReceipts", "getReceipt", "createReceipt", "generateFullReceiptId", "cancelReceipt", "sendReceiptEmail", "listMyArticleGroups", "listMyArticles", "getKasseSettings", "setMyKasseSettings", "setMyKasseLogo", "setMyRegisterDeviceSettings", "listMyPrinters", "createPrintJob", "getPrintJob", "listMyTipRecipients", "listMyStockLocations", "listMyStock", "setMyCashregisterStockLocation"];
|
|
32
32
|
export type PublicCall = typeof PUBLIC_CALLS[number];
|
|
33
33
|
export type PosCall = typeof POS_CALLS[number];
|
|
34
|
+
/**
|
|
35
|
+
* Die Aufrufe **mit Wirkung**, alphabetisch: sie legen etwas an, aendern oder
|
|
36
|
+
* loeschen es, buchen, signieren, bewegen Geld oder senden etwas hinaus
|
|
37
|
+
* (Mail, Druckjob, Probesendung). Scheitert einer, nachdem die Anfrage
|
|
38
|
+
* unterwegs war (Netzfehler, Zeitlimit, HTTP 5xx, unlesbare Erfolgsantwort,
|
|
39
|
+
* HTML mit Kennzeichen), meldet der Transport `outcome: 'unknown'`: der
|
|
40
|
+
* Vorgang kann ausgefuehrt sein.
|
|
41
|
+
*
|
|
42
|
+
* Bis 1.5.0 galt das nur fuer die sechs signierenden und geldbewegenden
|
|
43
|
+
* Aufrufe; ein Wareneingang oder eine Rechnung nach einem Zeitlimit kam als
|
|
44
|
+
* `'rejected'` an, und wer das glaubte und mit NEUEM Idempotenzschluessel
|
|
45
|
+
* neu sendete, buchte doppelt.
|
|
46
|
+
*
|
|
47
|
+
* Geht als `unknownOutcomeCalls` in den Vertrag (`fixtures/surface.json`);
|
|
48
|
+
* der Dart-Zwilling prueft seine Liste dagegen. Jeder Aufruf aus
|
|
49
|
+
* [ALL_CALLS], [PUBLIC_CALLS] und [POS_CALLS] steht entweder hier oder in
|
|
50
|
+
* [CALLS_WITHOUT_EFFECT] (Waechter `test/ausgang-einordnung.test.ts`).
|
|
51
|
+
*/
|
|
52
|
+
export declare const UNKNOWN_OUTCOME_CALLS: readonly ["activateCashregister", "cancelInvoice", "cancelReceipt", "changeStockCondition", "createArticle", "createCreditNote", "createCustomer", "createCustomerCashregister", "createInvoiceItem", "createPartnerCustomer", "createPartnerWebhook", "createPrintJob", "createReceipt", "createReservation", "createWebhook", "deactivateArticle", "deletePartnerWebhook", "deleteWebhook", "extendReservation", "financeWebService", "hobexPayApi", "hobexRefundApi", "issueInvoice", "pairRegisterDevice", "receiveGoods", "recordInvoicePayment", "recordStockLoss", "releaseReservation", "reportCustomerContract", "requestCustomerSignature", "reverseStockMovement", "revokeCustomerMandate", "rotatePartnerWebhookSecret", "rotateWebhookSecret", "sendPartnerCustomerFonLink", "sendPartnerWebhookTest", "sendReceiptEmail", "sendWebhookTest", "setCustomerMandate", "setMyCashregisterStockLocation", "setMyKasseLogo", "setMyKasseSettings", "setMyRegisterDeviceSettings", "stripeCaptureIntent", "transferStock", "unpairRegisterDevice", "updateArticle", "updateCustomer", "updateInvoiceItem", "updatePartnerWebhook", "updateWebhook", "withdrawInvoiceItem"];
|
|
53
|
+
/** Warum ein Aufruf keine Wirkung hat, die ein Zeitlimit offen lassen koennte. */
|
|
54
|
+
export type CallWithoutEffectReason = 'read' | 'repeatable';
|
|
55
|
+
/**
|
|
56
|
+
* Die Aufrufe **ohne Wirkung**, je mit Grund. Bei ihnen bleibt es bei
|
|
57
|
+
* `outcome: 'rejected'`, auch nach Zeitlimit, Netzfehler oder HTTP 5xx; eine
|
|
58
|
+
* Wiederholung bucht nichts doppelt:
|
|
59
|
+
*
|
|
60
|
+
* - `read`: reines Lesen (auch Berichte, Dateien, `generateFullReceiptId`,
|
|
61
|
+
* das nur einen Link-Schluessel ableitet, und `getCustomerCredentials`,
|
|
62
|
+
* dessen Abruf das Backend nur mitschreibt).
|
|
63
|
+
* - `repeatable`: legt etwas an, das ohne die verlorene Antwort niemand
|
|
64
|
+
* erreicht und das von selbst verfaellt, und bucht nichts. Die Sitzung der
|
|
65
|
+
* Kassen-Anmeldung (anmelden, verlaengern, abmelden: eine Wiederholung legt
|
|
66
|
+
* hoechstens eine weitere kurzlebige Sitzung an bzw. verlaengert oder
|
|
67
|
+
* beendet dieselbe noch einmal) und der Stripe-Zahlungslink
|
|
68
|
+
* (`createPaymentLinkStripe`: den Link kennt nur die Antwort, ein nie
|
|
69
|
+
* zugestellter Link wird nie bezahlt; Geld bewegt erst die Zahlung bzw.
|
|
70
|
+
* `stripeCaptureIntent`).
|
|
71
|
+
*
|
|
72
|
+
* Probelaeufe (`previewGoodsReceipt`, `previewInvoice`) teilen den Namen mit
|
|
73
|
+
* dem echten Aufruf und stehen darum nicht hier; die Huellen setzen fuer sie
|
|
74
|
+
* `hasEffect: false` beim Aufruf, das nur zusammen mit `dryRun: true` gilt
|
|
75
|
+
* (siehe `TransportCallOptions`).
|
|
76
|
+
*
|
|
77
|
+
* Paketintern; nicht Teil der Paketoberflaeche.
|
|
78
|
+
*/
|
|
79
|
+
export declare const CALLS_WITHOUT_EFFECT: Readonly<Record<string, CallWithoutEffectReason>>;
|
|
80
|
+
/**
|
|
81
|
+
* Hat dieser Aufruf Wirkung, ist sein Ausgang nach Zeitlimit, Netzfehler,
|
|
82
|
+
* HTTP 5xx oder unlesbarer Erfolgsantwort also unklar? `financeWebService`
|
|
83
|
+
* zaehlt mit jedem Vorgang. Ein Name, den dieses Paket nicht kennt (der
|
|
84
|
+
* offene Transport nimmt jeden), ist `false`; wer so einen Aufruf mit Wirkung
|
|
85
|
+
* absetzt, sagt es mit `hasEffect: true`.
|
|
86
|
+
*/
|
|
87
|
+
export declare function isUnknownOutcomeCall(name: string): boolean;
|
|
34
88
|
/** Einer der 28 Aufrufe des Kassenwegs. */
|
|
35
89
|
export declare function isPosCall(name: string): boolean;
|
|
36
90
|
/**
|
|
@@ -40,6 +94,6 @@ export declare function isPosCall(name: string): boolean;
|
|
|
40
94
|
*/
|
|
41
95
|
export declare function isPosOnlyCall(name: string): boolean;
|
|
42
96
|
/** Wie [KasseneckTransport], nur mit bekanntem Aufrufnamen. Nicht exportiert nach aussen. */
|
|
43
|
-
export type InternerTransport = <T = unknown>(functionName: ApiCall, params?: Record<string, unknown>, extraBodyFields?: TransportBodyFields, secretParams?: readonly string[]) => Promise<T>;
|
|
97
|
+
export type InternerTransport = <T = unknown>(functionName: ApiCall, params?: Record<string, unknown>, extraBodyFields?: TransportBodyFields, secretParams?: readonly string[], options?: TransportCallOptions) => Promise<T>;
|
|
44
98
|
/** Wie [KasseneckBinaryTransport], nur mit bekanntem Aufrufnamen. */
|
|
45
99
|
export type InternerBinaerTransport = (functionName: ApiCall, params?: Record<string, unknown>) => Promise<Uint8Array>;
|
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.POS_CALLS = exports.PUBLIC_CALLS = exports.ALL_CALLS = void 0;
|
|
3
|
+
exports.CALLS_WITHOUT_EFFECT = exports.UNKNOWN_OUTCOME_CALLS = exports.POS_CALLS = exports.PUBLIC_CALLS = exports.ALL_CALLS = void 0;
|
|
4
|
+
exports.isUnknownOutcomeCall = isUnknownOutcomeCall;
|
|
4
5
|
exports.isPosCall = isPosCall;
|
|
5
6
|
exports.isPosOnlyCall = isPosOnlyCall;
|
|
6
7
|
exports.ALL_CALLS = [
|
|
@@ -90,6 +91,20 @@ exports.ALL_CALLS = [
|
|
|
90
91
|
'sendWebhookTest',
|
|
91
92
|
'rotateWebhookSecret',
|
|
92
93
|
'listWebhookDeliveries',
|
|
94
|
+
// Lager-API schreiben und Reservierung (Stufe 5b, ./inventory)
|
|
95
|
+
'createArticle',
|
|
96
|
+
'updateArticle',
|
|
97
|
+
'deactivateArticle',
|
|
98
|
+
'receiveGoods',
|
|
99
|
+
'transferStock',
|
|
100
|
+
'recordStockLoss',
|
|
101
|
+
'changeStockCondition',
|
|
102
|
+
'reverseStockMovement',
|
|
103
|
+
'createReservation',
|
|
104
|
+
'extendReservation',
|
|
105
|
+
'releaseReservation',
|
|
106
|
+
'getReservation',
|
|
107
|
+
'listReservations',
|
|
93
108
|
];
|
|
94
109
|
/**
|
|
95
110
|
* Die oeffentlichen Endpunkte unter `/v3` (`https://api.kasseneck.at/v3/<name>`),
|
|
@@ -176,6 +191,20 @@ exports.PUBLIC_CALLS = [
|
|
|
176
191
|
'sendWebhookTest',
|
|
177
192
|
'rotateWebhookSecret',
|
|
178
193
|
'listWebhookDeliveries',
|
|
194
|
+
// Lager-API schreiben und Reservierung (Backend Stufe 5b), umhuellt in `./inventory`.
|
|
195
|
+
'createArticle',
|
|
196
|
+
'updateArticle',
|
|
197
|
+
'deactivateArticle',
|
|
198
|
+
'receiveGoods',
|
|
199
|
+
'transferStock',
|
|
200
|
+
'recordStockLoss',
|
|
201
|
+
'changeStockCondition',
|
|
202
|
+
'reverseStockMovement',
|
|
203
|
+
'createReservation',
|
|
204
|
+
'extendReservation',
|
|
205
|
+
'releaseReservation',
|
|
206
|
+
'getReservation',
|
|
207
|
+
'listReservations',
|
|
179
208
|
];
|
|
180
209
|
/**
|
|
181
210
|
* Die Endpunkte des Kassenwegs (`https://kasse.kasseneck.at/api/v3/<name>`,
|
|
@@ -214,6 +243,172 @@ exports.POS_CALLS = [
|
|
|
214
243
|
'listMyStock',
|
|
215
244
|
'setMyCashregisterStockLocation',
|
|
216
245
|
];
|
|
246
|
+
/**
|
|
247
|
+
* Die Aufrufe **mit Wirkung**, alphabetisch: sie legen etwas an, aendern oder
|
|
248
|
+
* loeschen es, buchen, signieren, bewegen Geld oder senden etwas hinaus
|
|
249
|
+
* (Mail, Druckjob, Probesendung). Scheitert einer, nachdem die Anfrage
|
|
250
|
+
* unterwegs war (Netzfehler, Zeitlimit, HTTP 5xx, unlesbare Erfolgsantwort,
|
|
251
|
+
* HTML mit Kennzeichen), meldet der Transport `outcome: 'unknown'`: der
|
|
252
|
+
* Vorgang kann ausgefuehrt sein.
|
|
253
|
+
*
|
|
254
|
+
* Bis 1.5.0 galt das nur fuer die sechs signierenden und geldbewegenden
|
|
255
|
+
* Aufrufe; ein Wareneingang oder eine Rechnung nach einem Zeitlimit kam als
|
|
256
|
+
* `'rejected'` an, und wer das glaubte und mit NEUEM Idempotenzschluessel
|
|
257
|
+
* neu sendete, buchte doppelt.
|
|
258
|
+
*
|
|
259
|
+
* Geht als `unknownOutcomeCalls` in den Vertrag (`fixtures/surface.json`);
|
|
260
|
+
* der Dart-Zwilling prueft seine Liste dagegen. Jeder Aufruf aus
|
|
261
|
+
* [ALL_CALLS], [PUBLIC_CALLS] und [POS_CALLS] steht entweder hier oder in
|
|
262
|
+
* [CALLS_WITHOUT_EFFECT] (Waechter `test/ausgang-einordnung.test.ts`).
|
|
263
|
+
*/
|
|
264
|
+
exports.UNKNOWN_OUTCOME_CALLS = [
|
|
265
|
+
'activateCashregister',
|
|
266
|
+
'cancelInvoice',
|
|
267
|
+
'cancelReceipt',
|
|
268
|
+
'changeStockCondition',
|
|
269
|
+
'createArticle',
|
|
270
|
+
'createCreditNote',
|
|
271
|
+
'createCustomer',
|
|
272
|
+
'createCustomerCashregister',
|
|
273
|
+
'createInvoiceItem',
|
|
274
|
+
'createPartnerCustomer',
|
|
275
|
+
'createPartnerWebhook',
|
|
276
|
+
'createPrintJob',
|
|
277
|
+
'createReceipt',
|
|
278
|
+
'createReservation',
|
|
279
|
+
'createWebhook',
|
|
280
|
+
'deactivateArticle',
|
|
281
|
+
'deletePartnerWebhook',
|
|
282
|
+
'deleteWebhook',
|
|
283
|
+
'extendReservation',
|
|
284
|
+
'financeWebService',
|
|
285
|
+
'hobexPayApi',
|
|
286
|
+
'hobexRefundApi',
|
|
287
|
+
'issueInvoice',
|
|
288
|
+
'pairRegisterDevice',
|
|
289
|
+
'receiveGoods',
|
|
290
|
+
'recordInvoicePayment',
|
|
291
|
+
'recordStockLoss',
|
|
292
|
+
'releaseReservation',
|
|
293
|
+
'reportCustomerContract',
|
|
294
|
+
'requestCustomerSignature',
|
|
295
|
+
'reverseStockMovement',
|
|
296
|
+
'revokeCustomerMandate',
|
|
297
|
+
'rotatePartnerWebhookSecret',
|
|
298
|
+
'rotateWebhookSecret',
|
|
299
|
+
'sendPartnerCustomerFonLink',
|
|
300
|
+
'sendPartnerWebhookTest',
|
|
301
|
+
'sendReceiptEmail',
|
|
302
|
+
'sendWebhookTest',
|
|
303
|
+
'setCustomerMandate',
|
|
304
|
+
'setMyCashregisterStockLocation',
|
|
305
|
+
'setMyKasseLogo',
|
|
306
|
+
'setMyKasseSettings',
|
|
307
|
+
'setMyRegisterDeviceSettings',
|
|
308
|
+
'stripeCaptureIntent',
|
|
309
|
+
'transferStock',
|
|
310
|
+
'unpairRegisterDevice',
|
|
311
|
+
'updateArticle',
|
|
312
|
+
'updateCustomer',
|
|
313
|
+
'updateInvoiceItem',
|
|
314
|
+
'updatePartnerWebhook',
|
|
315
|
+
'updateWebhook',
|
|
316
|
+
'withdrawInvoiceItem',
|
|
317
|
+
];
|
|
318
|
+
/**
|
|
319
|
+
* Die Aufrufe **ohne Wirkung**, je mit Grund. Bei ihnen bleibt es bei
|
|
320
|
+
* `outcome: 'rejected'`, auch nach Zeitlimit, Netzfehler oder HTTP 5xx; eine
|
|
321
|
+
* Wiederholung bucht nichts doppelt:
|
|
322
|
+
*
|
|
323
|
+
* - `read`: reines Lesen (auch Berichte, Dateien, `generateFullReceiptId`,
|
|
324
|
+
* das nur einen Link-Schluessel ableitet, und `getCustomerCredentials`,
|
|
325
|
+
* dessen Abruf das Backend nur mitschreibt).
|
|
326
|
+
* - `repeatable`: legt etwas an, das ohne die verlorene Antwort niemand
|
|
327
|
+
* erreicht und das von selbst verfaellt, und bucht nichts. Die Sitzung der
|
|
328
|
+
* Kassen-Anmeldung (anmelden, verlaengern, abmelden: eine Wiederholung legt
|
|
329
|
+
* hoechstens eine weitere kurzlebige Sitzung an bzw. verlaengert oder
|
|
330
|
+
* beendet dieselbe noch einmal) und der Stripe-Zahlungslink
|
|
331
|
+
* (`createPaymentLinkStripe`: den Link kennt nur die Antwort, ein nie
|
|
332
|
+
* zugestellter Link wird nie bezahlt; Geld bewegt erst die Zahlung bzw.
|
|
333
|
+
* `stripeCaptureIntent`).
|
|
334
|
+
*
|
|
335
|
+
* Probelaeufe (`previewGoodsReceipt`, `previewInvoice`) teilen den Namen mit
|
|
336
|
+
* dem echten Aufruf und stehen darum nicht hier; die Huellen setzen fuer sie
|
|
337
|
+
* `hasEffect: false` beim Aufruf, das nur zusammen mit `dryRun: true` gilt
|
|
338
|
+
* (siehe `TransportCallOptions`).
|
|
339
|
+
*
|
|
340
|
+
* Paketintern; nicht Teil der Paketoberflaeche.
|
|
341
|
+
*/
|
|
342
|
+
exports.CALLS_WITHOUT_EFFECT = Object.freeze({
|
|
343
|
+
checkPartnerCustomerEmail: 'read',
|
|
344
|
+
downloadDailyReport: 'read',
|
|
345
|
+
downloadReceipt: 'read',
|
|
346
|
+
downloadReport: 'read',
|
|
347
|
+
createPaymentLinkStripe: 'repeatable',
|
|
348
|
+
endRegisterSession: 'repeatable',
|
|
349
|
+
generateFullReceiptId: 'read',
|
|
350
|
+
getArticle: 'read',
|
|
351
|
+
getCustomer: 'read',
|
|
352
|
+
getCustomerCredentials: 'read',
|
|
353
|
+
getCustomerSignatureStatus: 'read',
|
|
354
|
+
getFirstReceiptDate: 'read',
|
|
355
|
+
getInvoice: 'read',
|
|
356
|
+
getInvoiceItem: 'read',
|
|
357
|
+
getInvoicePdf: 'read',
|
|
358
|
+
getInvoiceSetupStatus: 'read',
|
|
359
|
+
getInvoiceXml: 'read',
|
|
360
|
+
getKasseSettings: 'read',
|
|
361
|
+
getPartnerBilling: 'read',
|
|
362
|
+
getPartnerBillingMonth: 'read',
|
|
363
|
+
getPartnerCustomer: 'read',
|
|
364
|
+
getPartnerInfo: 'read',
|
|
365
|
+
getPrintJob: 'read',
|
|
366
|
+
getReceipt: 'read',
|
|
367
|
+
getReportV2: 'read',
|
|
368
|
+
getReservation: 'read',
|
|
369
|
+
getStock: 'read',
|
|
370
|
+
hobexGetStatus: 'read',
|
|
371
|
+
listArticles: 'read',
|
|
372
|
+
listBrands: 'read',
|
|
373
|
+
listCustomerCashregisters: 'read',
|
|
374
|
+
listInvoiceItems: 'read',
|
|
375
|
+
listInvoices: 'read',
|
|
376
|
+
listLocations: 'read',
|
|
377
|
+
listMyArticleGroups: 'read',
|
|
378
|
+
listMyArticles: 'read',
|
|
379
|
+
listMyCashregisters: 'read',
|
|
380
|
+
listMyPrinters: 'read',
|
|
381
|
+
listMyReceipts: 'read',
|
|
382
|
+
listMyStock: 'read',
|
|
383
|
+
listMyStockLocations: 'read',
|
|
384
|
+
listMyTipRecipients: 'read',
|
|
385
|
+
listPartnerCustomers: 'read',
|
|
386
|
+
listPartnerWebhookDeliveries: 'read',
|
|
387
|
+
listPartnerWebhooks: 'read',
|
|
388
|
+
listRegisterSessionsForDevice: 'read',
|
|
389
|
+
listRegisterUsersForDevice: 'read',
|
|
390
|
+
listReservations: 'read',
|
|
391
|
+
listStock: 'read',
|
|
392
|
+
listStockMovements: 'read',
|
|
393
|
+
listWebhookDeliveries: 'read',
|
|
394
|
+
listWebhooks: 'read',
|
|
395
|
+
lookupArticleByCode: 'read',
|
|
396
|
+
registerPinLogin: 'repeatable',
|
|
397
|
+
registerUserLogin: 'repeatable',
|
|
398
|
+
renewRegisterSession: 'repeatable',
|
|
399
|
+
searchCustomers: 'read',
|
|
400
|
+
});
|
|
401
|
+
const MIT_WIRKUNG = new Set(exports.UNKNOWN_OUTCOME_CALLS);
|
|
402
|
+
/**
|
|
403
|
+
* Hat dieser Aufruf Wirkung, ist sein Ausgang nach Zeitlimit, Netzfehler,
|
|
404
|
+
* HTTP 5xx oder unlesbarer Erfolgsantwort also unklar? `financeWebService`
|
|
405
|
+
* zaehlt mit jedem Vorgang. Ein Name, den dieses Paket nicht kennt (der
|
|
406
|
+
* offene Transport nimmt jeden), ist `false`; wer so einen Aufruf mit Wirkung
|
|
407
|
+
* absetzt, sagt es mit `hasEffect: true`.
|
|
408
|
+
*/
|
|
409
|
+
function isUnknownOutcomeCall(name) {
|
|
410
|
+
return MIT_WIRKUNG.has(name);
|
|
411
|
+
}
|
|
217
412
|
const OEFFENTLICH = new Set(exports.PUBLIC_CALLS);
|
|
218
413
|
const KASSENWEG = new Set(exports.POS_CALLS);
|
|
219
414
|
const NUR_KASSE = new Set(exports.POS_CALLS.filter((name) => !OEFFENTLICH.has(name)));
|
|
@@ -25,20 +25,27 @@
|
|
|
25
25
|
* **Entscheidend ist `outcome`:** `'rejected'` heisst abgelehnt, nichts
|
|
26
26
|
* geschehen, Wiederholen hilft nicht. `'unknown'` heisst: der Vorgang kann
|
|
27
27
|
* ausgefuehrt sein (bei `createReceipt` ein signierter Beleg). Dann **nie
|
|
28
|
-
* wiederholen
|
|
28
|
+
* blind wiederholen**: Belege, Stornos und Zahlungen nachlesen
|
|
29
|
+
* (Belegliste, `getReceipt`, Terminal-Beleg); ein Aufruf mit
|
|
30
|
+
* `idempotencyKey` (Lager schreiben, Rechnung, Partner-Betrieb mit
|
|
31
|
+
* Schluessel) darf mit **demselben** Schluessel erneut gesendet werden und
|
|
32
|
+
* wirkt genau einmal, nie mit einem neuen. `createInvoiceItem` erkennt die
|
|
33
|
+
* Wiederholung an `source` + `reference` (dieselben Werte erneut senden);
|
|
34
|
+
* Posten aendern oder zurueckziehen und Mandate haben keinen Schluessel:
|
|
35
|
+
* erst nachlesen.
|
|
29
36
|
* - `KasseneckHttpError` — die Antwort war **keine** verwertbare Huelle:
|
|
30
37
|
* HTTP 500/404 ohne Huelle, leerer Rumpf oder Text statt JSON. Beim
|
|
31
38
|
* Bericht-Download gelten dieselben Gruende fuer alles, was kein PDF ist.
|
|
32
39
|
* `reason` trennt die Faelle maschinenlesbar. Auf einem Aufruf mit
|
|
33
|
-
* Wirkung (
|
|
40
|
+
* Wirkung (`UNKNOWN_OUTCOME_CALLS` in aufrufe.ts) hat HTTP 5xx
|
|
34
41
|
* `outcome: 'unknown'`, ebenso HTTP 200 mit Kennzeichen, aber leerem oder
|
|
35
42
|
* unlesbarem Rumpf.
|
|
36
43
|
* - `KasseneckNetworkError` — die Antwort kam gar nicht: Netz weg, DNS,
|
|
37
44
|
* abgebrochene Verbindung oder Zeitueberschreitung (`timedOut`). Auch hier
|
|
38
45
|
* gilt `outcome`: war die Anfrage schon unterwegs und ist der Aufruf einer
|
|
39
|
-
* mit Wirkung (
|
|
40
|
-
*
|
|
41
|
-
* `
|
|
46
|
+
* mit Wirkung (signieren, Geld bewegen, buchen, ausstellen, anlegen,
|
|
47
|
+
* aendern, loeschen, senden; die Liste `UNKNOWN_OUTCOME_CALLS`), ist er
|
|
48
|
+
* `'unknown'`. Lesen und Probelauf bleiben `'rejected'`.
|
|
42
49
|
* - `KasseneckAuthError` — es kam nicht einmal zur Anfrage, weil die Anmeldung
|
|
43
50
|
* scheiterte (fehlende Zugangsdaten, oder der Token-/Sitzungsgeber warf).
|
|
44
51
|
* In der Browser-Kasse mit ihrer 90-Sekunden-Sitzung ist das Alltag, kein
|
|
@@ -106,8 +113,10 @@ export declare function causeDigest(ursache: unknown, geheimnisse: readonly stri
|
|
|
106
113
|
export declare function fehlerDetails(daten: unknown, geheimnisse: readonly string[]): Record<string, unknown>;
|
|
107
114
|
/**
|
|
108
115
|
* Ausgang eines gescheiterten Aufrufs. `'rejected'`: nichts geschehen.
|
|
109
|
-
* `'unknown'`: der Vorgang kann ausgefuehrt sein; nie wiederholen
|
|
110
|
-
*
|
|
116
|
+
* `'unknown'`: der Vorgang kann ausgefuehrt sein; nie blind wiederholen.
|
|
117
|
+
* Belege, Stornos und Zahlungen nachlesen; ein Aufruf mit `idempotencyKey`
|
|
118
|
+
* nur mit **demselben** Schluessel erneut senden (wirkt genau einmal); ohne
|
|
119
|
+
* Schluessel erst nachlesen.
|
|
111
120
|
*/
|
|
112
121
|
export type ErrorOutcome = 'unknown' | 'rejected';
|
|
113
122
|
/**
|
|
@@ -195,12 +204,12 @@ export declare class KasseneckHttpError extends Error {
|
|
|
195
204
|
/** Maschinenlesbarer Grund — trennt den Rewrite-Fall vom 500er ohne Textparsen. */
|
|
196
205
|
readonly reason: HttpFailureReason;
|
|
197
206
|
/**
|
|
198
|
-
* `'unknown'` auf einem Aufruf mit Wirkung (`
|
|
199
|
-
*
|
|
200
|
-
*
|
|
201
|
-
*
|
|
202
|
-
*
|
|
203
|
-
*
|
|
207
|
+
* `'unknown'` auf einem Aufruf mit Wirkung (`UNKNOWN_OUTCOME_CALLS`:
|
|
208
|
+
* signieren, Geld bewegen, buchen, ausstellen, anlegen, aendern, loeschen,
|
|
209
|
+
* senden) bei HTTP 5xx und bei HTTP 200 mit Kennzeichen, aber unlesbarem
|
|
210
|
+
* Rumpf (`empty-body`, `not-json` auch bei `text/html`, `missing-status`):
|
|
211
|
+
* der Handler kann gelaufen sein, nie blind wiederholen (siehe
|
|
212
|
+
* [ErrorOutcome]). Sonst `'rejected'` (auch 4xx, Lesen und Probelauf).
|
|
204
213
|
*/
|
|
205
214
|
readonly outcome: ErrorOutcome;
|
|
206
215
|
constructor(functionName: string, statusCode: number, contentType: string | undefined, reason: HttpFailureReason, outcome?: ErrorOutcome);
|
|
@@ -218,9 +227,10 @@ export declare class KasseneckNetworkError extends Error {
|
|
|
218
227
|
/** Code der zugrunde liegenden Ursache, sofern unbedenklich (z. B. `ECONNREFUSED`). */
|
|
219
228
|
readonly causeCode: string | undefined;
|
|
220
229
|
/**
|
|
221
|
-
* `'unknown'`, wenn die Anfrage schon unterwegs war und der Aufruf
|
|
222
|
-
* (`
|
|
223
|
-
*
|
|
230
|
+
* `'unknown'`, wenn die Anfrage schon unterwegs war und der Aufruf Wirkung
|
|
231
|
+
* hat (`UNKNOWN_OUTCOME_CALLS`): dann nie blind wiederholen (siehe
|
|
232
|
+
* [ErrorOutcome]). Sonst `'rejected'`, auch bei Lesen und Probelauf und
|
|
233
|
+
* wenn schon die Anmeldung das Zeitlimit verbrauchte.
|
|
224
234
|
*/
|
|
225
235
|
readonly outcome: ErrorOutcome;
|
|
226
236
|
constructor(functionName: string, timedOut: boolean, timeoutMs: number, cause?: CauseDigest, outcome?: ErrorOutcome);
|
|
@@ -273,9 +283,12 @@ export declare class KasseneckValidationError extends Error {
|
|
|
273
283
|
export type KasseneckError = KasseneckApiError | KasseneckHttpError | KasseneckNetworkError | KasseneckAuthError | KasseneckValidationError;
|
|
274
284
|
/**
|
|
275
285
|
* Ist der Ausgang dieses Fehlers unklar (`outcome === 'unknown'`)? Dann den
|
|
276
|
-
* Aufruf **nicht wiederholen
|
|
277
|
-
*
|
|
278
|
-
*
|
|
286
|
+
* Aufruf **nicht blind wiederholen**: Belege, Stornos und Zahlungen
|
|
287
|
+
* nachlesen; einen Aufruf mit `idempotencyKey` nur mit **demselben**
|
|
288
|
+
* Schluessel erneut senden (wirkt genau einmal, ein neuer buchte doppelt);
|
|
289
|
+
* ohne Schluessel erst nachlesen. Gilt fuer jede Fehlerart; nur
|
|
290
|
+
* [KasseneckApiError], [KasseneckHttpError] und [KasseneckNetworkError]
|
|
291
|
+
* koennen `'unknown'` sein.
|
|
279
292
|
*/
|
|
280
293
|
export declare function isOutcomeUnknown(error: unknown): boolean;
|
|
281
294
|
export declare function isKasseneckApiError(error: unknown): error is KasseneckApiError;
|
|
@@ -26,20 +26,27 @@
|
|
|
26
26
|
* **Entscheidend ist `outcome`:** `'rejected'` heisst abgelehnt, nichts
|
|
27
27
|
* geschehen, Wiederholen hilft nicht. `'unknown'` heisst: der Vorgang kann
|
|
28
28
|
* ausgefuehrt sein (bei `createReceipt` ein signierter Beleg). Dann **nie
|
|
29
|
-
* wiederholen
|
|
29
|
+
* blind wiederholen**: Belege, Stornos und Zahlungen nachlesen
|
|
30
|
+
* (Belegliste, `getReceipt`, Terminal-Beleg); ein Aufruf mit
|
|
31
|
+
* `idempotencyKey` (Lager schreiben, Rechnung, Partner-Betrieb mit
|
|
32
|
+
* Schluessel) darf mit **demselben** Schluessel erneut gesendet werden und
|
|
33
|
+
* wirkt genau einmal, nie mit einem neuen. `createInvoiceItem` erkennt die
|
|
34
|
+
* Wiederholung an `source` + `reference` (dieselben Werte erneut senden);
|
|
35
|
+
* Posten aendern oder zurueckziehen und Mandate haben keinen Schluessel:
|
|
36
|
+
* erst nachlesen.
|
|
30
37
|
* - `KasseneckHttpError` — die Antwort war **keine** verwertbare Huelle:
|
|
31
38
|
* HTTP 500/404 ohne Huelle, leerer Rumpf oder Text statt JSON. Beim
|
|
32
39
|
* Bericht-Download gelten dieselben Gruende fuer alles, was kein PDF ist.
|
|
33
40
|
* `reason` trennt die Faelle maschinenlesbar. Auf einem Aufruf mit
|
|
34
|
-
* Wirkung (
|
|
41
|
+
* Wirkung (`UNKNOWN_OUTCOME_CALLS` in aufrufe.ts) hat HTTP 5xx
|
|
35
42
|
* `outcome: 'unknown'`, ebenso HTTP 200 mit Kennzeichen, aber leerem oder
|
|
36
43
|
* unlesbarem Rumpf.
|
|
37
44
|
* - `KasseneckNetworkError` — die Antwort kam gar nicht: Netz weg, DNS,
|
|
38
45
|
* abgebrochene Verbindung oder Zeitueberschreitung (`timedOut`). Auch hier
|
|
39
46
|
* gilt `outcome`: war die Anfrage schon unterwegs und ist der Aufruf einer
|
|
40
|
-
* mit Wirkung (
|
|
41
|
-
*
|
|
42
|
-
* `
|
|
47
|
+
* mit Wirkung (signieren, Geld bewegen, buchen, ausstellen, anlegen,
|
|
48
|
+
* aendern, loeschen, senden; die Liste `UNKNOWN_OUTCOME_CALLS`), ist er
|
|
49
|
+
* `'unknown'`. Lesen und Probelauf bleiben `'rejected'`.
|
|
43
50
|
* - `KasseneckAuthError` — es kam nicht einmal zur Anfrage, weil die Anmeldung
|
|
44
51
|
* scheiterte (fehlende Zugangsdaten, oder der Token-/Sitzungsgeber warf).
|
|
45
52
|
* In der Browser-Kasse mit ihrer 90-Sekunden-Sitzung ist das Alltag, kein
|
|
@@ -378,12 +385,12 @@ class KasseneckHttpError extends Error {
|
|
|
378
385
|
/** Maschinenlesbarer Grund — trennt den Rewrite-Fall vom 500er ohne Textparsen. */
|
|
379
386
|
reason;
|
|
380
387
|
/**
|
|
381
|
-
* `'unknown'` auf einem Aufruf mit Wirkung (`
|
|
382
|
-
*
|
|
383
|
-
*
|
|
384
|
-
*
|
|
385
|
-
*
|
|
386
|
-
*
|
|
388
|
+
* `'unknown'` auf einem Aufruf mit Wirkung (`UNKNOWN_OUTCOME_CALLS`:
|
|
389
|
+
* signieren, Geld bewegen, buchen, ausstellen, anlegen, aendern, loeschen,
|
|
390
|
+
* senden) bei HTTP 5xx und bei HTTP 200 mit Kennzeichen, aber unlesbarem
|
|
391
|
+
* Rumpf (`empty-body`, `not-json` auch bei `text/html`, `missing-status`):
|
|
392
|
+
* der Handler kann gelaufen sein, nie blind wiederholen (siehe
|
|
393
|
+
* [ErrorOutcome]). Sonst `'rejected'` (auch 4xx, Lesen und Probelauf).
|
|
387
394
|
*/
|
|
388
395
|
outcome;
|
|
389
396
|
constructor(functionName, statusCode, contentType, reason, outcome = 'rejected') {
|
|
@@ -410,9 +417,10 @@ class KasseneckNetworkError extends Error {
|
|
|
410
417
|
/** Code der zugrunde liegenden Ursache, sofern unbedenklich (z. B. `ECONNREFUSED`). */
|
|
411
418
|
causeCode;
|
|
412
419
|
/**
|
|
413
|
-
* `'unknown'`, wenn die Anfrage schon unterwegs war und der Aufruf
|
|
414
|
-
* (`
|
|
415
|
-
*
|
|
420
|
+
* `'unknown'`, wenn die Anfrage schon unterwegs war und der Aufruf Wirkung
|
|
421
|
+
* hat (`UNKNOWN_OUTCOME_CALLS`): dann nie blind wiederholen (siehe
|
|
422
|
+
* [ErrorOutcome]). Sonst `'rejected'`, auch bei Lesen und Probelauf und
|
|
423
|
+
* wenn schon die Anmeldung das Zeitlimit verbrauchte.
|
|
416
424
|
*/
|
|
417
425
|
outcome;
|
|
418
426
|
constructor(functionName, timedOut, timeoutMs, cause = {}, outcome = 'rejected') {
|
|
@@ -481,9 +489,12 @@ class KasseneckValidationError extends Error {
|
|
|
481
489
|
exports.KasseneckValidationError = KasseneckValidationError;
|
|
482
490
|
/**
|
|
483
491
|
* Ist der Ausgang dieses Fehlers unklar (`outcome === 'unknown'`)? Dann den
|
|
484
|
-
* Aufruf **nicht wiederholen
|
|
485
|
-
*
|
|
486
|
-
*
|
|
492
|
+
* Aufruf **nicht blind wiederholen**: Belege, Stornos und Zahlungen
|
|
493
|
+
* nachlesen; einen Aufruf mit `idempotencyKey` nur mit **demselben**
|
|
494
|
+
* Schluessel erneut senden (wirkt genau einmal, ein neuer buchte doppelt);
|
|
495
|
+
* ohne Schluessel erst nachlesen. Gilt fuer jede Fehlerart; nur
|
|
496
|
+
* [KasseneckApiError], [KasseneckHttpError] und [KasseneckNetworkError]
|
|
497
|
+
* koennen `'unknown'` sein.
|
|
487
498
|
*/
|
|
488
499
|
function isOutcomeUnknown(error) {
|
|
489
500
|
return ((error instanceof KasseneckApiError || error instanceof KasseneckHttpError || error instanceof KasseneckNetworkError)
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
export { type AuthCredentials, type KasseneckAuth, type ApiKeyAuthOptions, type RegisterUserAuthOptions, apiKeyAuth, registerUserAuth, } from './auth.js';
|
|
2
|
-
export { DEFAULT_BASE_URL, POS_BASE_URL, DEFAULT_TIMEOUT_MS, type HttpResponseLike, type HttpRequestInit, type FetchLike, type TransportOptions, type TransportBodyFields, type KasseneckTransport, type KasseneckBinaryTransport, createTransport, createBinaryTransport, } from './transport.js';
|
|
3
|
-
export { ALL_CALLS, type ApiCall, PUBLIC_CALLS, POS_CALLS, type PublicCall, type PosCall, } from './aufrufe.js';
|
|
2
|
+
export { DEFAULT_BASE_URL, POS_BASE_URL, DEFAULT_TIMEOUT_MS, type HttpResponseLike, type HttpRequestInit, type FetchLike, type TransportOptions, type TransportBodyFields, type TransportCallOptions, type KasseneckTransport, type KasseneckBinaryTransport, createTransport, createBinaryTransport, } from './transport.js';
|
|
3
|
+
export { ALL_CALLS, type ApiCall, PUBLIC_CALLS, POS_CALLS, UNKNOWN_OUTCOME_CALLS, type PublicCall, type PosCall, } from './aufrufe.js';
|
|
4
4
|
export { KasseneckApiError, KasseneckAuthError, KasseneckHttpError, KasseneckNetworkError, KasseneckValidationError, type ValidationScope, type KasseneckError, type HttpFailureReason, type CauseDigest, type ErrorOutcome, CLIENT_ERROR_CODES, type ClientErrorCode, isKasseneckApiError, isKasseneckAuthError, isKasseneckHttpError, isKasseneckNetworkError, isKasseneckValidationError, isOutcomeUnknown, } from './errors.js';
|
|
5
5
|
export { type ReceiptCommonOptions, type SellReceiptOptions, type TipOptions, type TipRecipientShare, type CancelReceiptOptions, type ReceiptWithCompany, sellReceipt, sellReceiptWithCompany, paymentsExpectedCents, cardRefundReference, receiptLayoutFromResult, cancelReceipt, type CancelReceiptResult, zeroReceipt, getReceipt, getReceiptWithCompany, generateFullReceiptId, getFirstReceiptDate, listMyReceipts, type ListMyReceiptsOptions, type ReceiptList, type ReceiptListStats, checkVoucherCombinationError, type SendReceiptEmailOptions, type SendReceiptEmailResult, sendReceiptEmail, } from './receipts.js';
|
|
6
6
|
export { listMyCashregisters } from './cashregisters.js';
|
package/dist/cjs/client/index.js
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.createKasseneckApi = exports.getSignatureStatus = exports.getCashboxStatus = exports.getReportV2 = exports.downloadMonthlyReport = exports.downloadDailyReport = exports.listMyCashregisters = exports.sendReceiptEmail = exports.checkVoucherCombinationError = exports.listMyReceipts = exports.getFirstReceiptDate = exports.generateFullReceiptId = exports.getReceiptWithCompany = exports.getReceipt = exports.zeroReceipt = exports.cancelReceipt = exports.receiptLayoutFromResult = exports.cardRefundReference = exports.paymentsExpectedCents = exports.sellReceiptWithCompany = exports.sellReceipt = exports.isOutcomeUnknown = exports.isKasseneckValidationError = exports.isKasseneckNetworkError = exports.isKasseneckHttpError = exports.isKasseneckAuthError = exports.isKasseneckApiError = exports.CLIENT_ERROR_CODES = exports.KasseneckValidationError = exports.KasseneckNetworkError = exports.KasseneckHttpError = exports.KasseneckAuthError = exports.KasseneckApiError = exports.POS_CALLS = exports.PUBLIC_CALLS = exports.ALL_CALLS = exports.createBinaryTransport = exports.createTransport = exports.DEFAULT_TIMEOUT_MS = exports.POS_BASE_URL = exports.DEFAULT_BASE_URL = exports.registerUserAuth = exports.apiKeyAuth = void 0;
|
|
3
|
+
exports.createKasseneckApi = exports.getSignatureStatus = exports.getCashboxStatus = exports.getReportV2 = exports.downloadMonthlyReport = exports.downloadDailyReport = exports.listMyCashregisters = exports.sendReceiptEmail = exports.checkVoucherCombinationError = exports.listMyReceipts = exports.getFirstReceiptDate = exports.generateFullReceiptId = exports.getReceiptWithCompany = exports.getReceipt = exports.zeroReceipt = exports.cancelReceipt = exports.receiptLayoutFromResult = exports.cardRefundReference = exports.paymentsExpectedCents = exports.sellReceiptWithCompany = exports.sellReceipt = exports.isOutcomeUnknown = exports.isKasseneckValidationError = exports.isKasseneckNetworkError = exports.isKasseneckHttpError = exports.isKasseneckAuthError = exports.isKasseneckApiError = exports.CLIENT_ERROR_CODES = exports.KasseneckValidationError = exports.KasseneckNetworkError = exports.KasseneckHttpError = exports.KasseneckAuthError = exports.KasseneckApiError = exports.UNKNOWN_OUTCOME_CALLS = exports.POS_CALLS = exports.PUBLIC_CALLS = exports.ALL_CALLS = exports.createBinaryTransport = exports.createTransport = exports.DEFAULT_TIMEOUT_MS = exports.POS_BASE_URL = exports.DEFAULT_BASE_URL = exports.registerUserAuth = exports.apiKeyAuth = void 0;
|
|
4
4
|
var auth_js_1 = require("./auth.js");
|
|
5
5
|
Object.defineProperty(exports, "apiKeyAuth", { enumerable: true, get: function () { return auth_js_1.apiKeyAuth; } });
|
|
6
6
|
Object.defineProperty(exports, "registerUserAuth", { enumerable: true, get: function () { return auth_js_1.registerUserAuth; } });
|
|
@@ -14,6 +14,7 @@ var aufrufe_js_1 = require("./aufrufe.js");
|
|
|
14
14
|
Object.defineProperty(exports, "ALL_CALLS", { enumerable: true, get: function () { return aufrufe_js_1.ALL_CALLS; } });
|
|
15
15
|
Object.defineProperty(exports, "PUBLIC_CALLS", { enumerable: true, get: function () { return aufrufe_js_1.PUBLIC_CALLS; } });
|
|
16
16
|
Object.defineProperty(exports, "POS_CALLS", { enumerable: true, get: function () { return aufrufe_js_1.POS_CALLS; } });
|
|
17
|
+
Object.defineProperty(exports, "UNKNOWN_OUTCOME_CALLS", { enumerable: true, get: function () { return aufrufe_js_1.UNKNOWN_OUTCOME_CALLS; } });
|
|
17
18
|
var errors_js_1 = require("./errors.js");
|
|
18
19
|
Object.defineProperty(exports, "KasseneckApiError", { enumerable: true, get: function () { return errors_js_1.KasseneckApiError; } });
|
|
19
20
|
Object.defineProperty(exports, "KasseneckAuthError", { enumerable: true, get: function () { return errors_js_1.KasseneckAuthError; } });
|
|
@@ -33,6 +33,12 @@ import { type KasseneckAuth } from './auth.js';
|
|
|
33
33
|
* **Kein Wiederholen fehlgeschlagener Aufrufe.** Ein Beleg ist nicht folgenlos
|
|
34
34
|
* wiederholbar; ohne entschiedene Idempotenz waere ein automatischer zweiter
|
|
35
35
|
* Versuch ein zweiter Beleg.
|
|
36
|
+
*
|
|
37
|
+
* **Ausgang je Aufruf.** Ob ein Scheitern nach dem Senden `outcome: 'unknown'`
|
|
38
|
+
* traegt, haengt am Aufruf: mit Wirkung ([UNKNOWN_OUTCOME_CALLS] in
|
|
39
|
+
* aufrufe.ts) ja, Lesen und Probelauf nein. Ein Probelauf traegt denselben
|
|
40
|
+
* Namen wie der echte Aufruf; die Huelle sagt es darum beim Aufruf
|
|
41
|
+
* (`hasEffect: false`, [TransportCallOptions]).
|
|
36
42
|
*/
|
|
37
43
|
/** Basis-URL der oeffentlichen API (Produktion). */
|
|
38
44
|
export declare const DEFAULT_BASE_URL = "https://api.kasseneck.at/v3";
|
|
@@ -151,7 +157,27 @@ export interface TransportBodyFields {
|
|
|
151
157
|
/** Vorgangsart von `financeWebService` (z. B. `status_cashbox`). */
|
|
152
158
|
method?: string;
|
|
153
159
|
}
|
|
154
|
-
|
|
160
|
+
/**
|
|
161
|
+
* Einstellungen fuer **einen** Aufruf, die nicht mitgesendet werden.
|
|
162
|
+
*/
|
|
163
|
+
export interface TransportCallOptions {
|
|
164
|
+
/**
|
|
165
|
+
* Hat dieser Aufruf Wirkung? Entscheidet den Ausgang, wenn er scheitert,
|
|
166
|
+
* nachdem die Anfrage unterwegs war (Netzfehler, Zeitlimit, HTTP 5xx,
|
|
167
|
+
* unlesbare Erfolgsantwort, HTML mit Kennzeichen): `true` ergibt
|
|
168
|
+
* `outcome: 'unknown'`. Ohne Angabe gilt die Liste des Pakets
|
|
169
|
+
* (`UNKNOWN_OUTCOME_CALLS`); ein Name, den sie nicht kennt, gilt dann als
|
|
170
|
+
* ohne Wirkung.
|
|
171
|
+
*
|
|
172
|
+
* `true` fuer einen Aufruf mit Wirkung, den dieses Paket nicht kennt.
|
|
173
|
+
* `false` gilt **nur zusammen mit `params.dryRun === true`** (Probelauf
|
|
174
|
+
* unter dem Namen des echten Aufrufs, schreibt nichts) und ergibt dann
|
|
175
|
+
* `'rejected'`; ohne `dryRun: true` bleibt ein Aufruf aus der Liste
|
|
176
|
+
* `'unknown'`, was immer hier steht.
|
|
177
|
+
*/
|
|
178
|
+
hasEffect?: boolean;
|
|
179
|
+
}
|
|
180
|
+
export type KasseneckTransport = <T = unknown>(functionName: string, params?: Record<string, unknown>, extraBodyFields?: TransportBodyFields, secretParams?: readonly string[], options?: TransportCallOptions) => Promise<T>;
|
|
155
181
|
/**
|
|
156
182
|
* Ruft eine Backend-Funktion auf, die **Binaerdaten** liefert (die beiden
|
|
157
183
|
* Bericht-PDFs), und gibt sie als `Uint8Array` zurueck.
|