@kreiseck/kasseneck-api 1.3.0 → 1.5.0
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 +176 -0
- package/README.md +293 -1
- package/dist/cjs/client/aufrufe.d.ts +2 -2
- package/dist/cjs/client/aufrufe.js +58 -0
- package/dist/cjs/inventory/api.d.ts +61 -0
- package/dist/cjs/inventory/api.js +54 -0
- package/dist/cjs/inventory/auth.d.ts +17 -0
- package/dist/cjs/inventory/auth.js +27 -0
- package/dist/cjs/inventory/endpunkte.d.ts +91 -0
- package/dist/cjs/inventory/endpunkte.js +290 -0
- package/dist/cjs/inventory/fehler.d.ts +43 -0
- package/dist/cjs/inventory/fehler.js +66 -0
- package/dist/cjs/inventory/index.d.ts +21 -0
- package/dist/cjs/inventory/index.js +94 -0
- package/dist/cjs/inventory/lesen.d.ts +45 -0
- package/dist/cjs/inventory/lesen.js +424 -0
- package/dist/cjs/inventory/schreiben.d.ts +83 -0
- package/dist/cjs/inventory/schreiben.js +315 -0
- package/dist/cjs/inventory/typen.d.ts +679 -0
- package/dist/cjs/inventory/typen.js +14 -0
- package/dist/cjs/inventory/vertrag.d.ts +136 -0
- package/dist/cjs/inventory/vertrag.js +291 -0
- package/dist/cjs/inventory/webhook.d.ts +52 -0
- package/dist/cjs/inventory/webhook.js +116 -0
- 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/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 +2 -2
- package/dist/esm/client/aufrufe.js +58 -0
- package/dist/esm/inventory/api.d.ts +61 -0
- package/dist/esm/inventory/api.js +51 -0
- package/dist/esm/inventory/auth.d.ts +17 -0
- package/dist/esm/inventory/auth.js +24 -0
- package/dist/esm/inventory/endpunkte.d.ts +91 -0
- package/dist/esm/inventory/endpunkte.js +267 -0
- package/dist/esm/inventory/fehler.d.ts +43 -0
- package/dist/esm/inventory/fehler.js +57 -0
- package/dist/esm/inventory/index.d.ts +21 -0
- package/dist/esm/inventory/index.js +20 -0
- package/dist/esm/inventory/lesen.d.ts +45 -0
- package/dist/esm/inventory/lesen.js +404 -0
- package/dist/esm/inventory/schreiben.d.ts +83 -0
- package/dist/esm/inventory/schreiben.js +298 -0
- package/dist/esm/inventory/typen.d.ts +679 -0
- package/dist/esm/inventory/typen.js +13 -0
- package/dist/esm/inventory/vertrag.d.ts +136 -0
- package/dist/esm/inventory/vertrag.js +288 -0
- package/dist/esm/inventory/webhook.d.ts +52 -0
- package/dist/esm/inventory/webhook.js +107 -0
- 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/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 +306 -5
- package/fixtures/v3/README.md +9 -1
- 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 +3881 -0
- 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 +404 -4
- package/fixtures/v3/stored/rechnungen.json +174 -18
- package/fixtures/v3/v3-vokabular.json +1007 -20
- package/fixtures/v3/zahlbetrag-faelle.json +2 -2
- package/package.json +14 -2
|
@@ -0,0 +1,83 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Die schreibenden Aufrufe der Lager-API (Backend Stufe 5b): Artikel anlegen,
|
|
3
|
+
* aendern und stilllegen, Bestand buchen (Wareneingang, Umbuchung, Abgang,
|
|
4
|
+
* Zustand, Gegenbuchung) und reservieren.
|
|
5
|
+
*
|
|
6
|
+
* Wie in `endpunkte.ts` nimmt jede Funktion den Transport als ersten Parameter
|
|
7
|
+
* und ist einzeln importierbar. Die Anfrage geht flach hinaus, genau mit den
|
|
8
|
+
* Feldern, die der Aufrufer nennt (`undefined` faellt weg, `null` bleibt: es
|
|
9
|
+
* leert ein Feld bzw. heisst bei der Anlage „nicht angegeben“).
|
|
10
|
+
*
|
|
11
|
+
* **Vor dem Senden geprueft wird nur, was ohne Netz sicher falsch ist:**
|
|
12
|
+
* - `idempotencyKey` fehlt, ist leer oder laenger als 120 Zeichen. Ohne
|
|
13
|
+
* Schluessel gaebe es keine sichere Wiederholung, und der Server wiese die
|
|
14
|
+
* Anfrage ohnehin ab (`idempotency_key_required` bzw. `validation`);
|
|
15
|
+
* - eine Pflichtkennung fehlt oder ist leer;
|
|
16
|
+
* - eine Menge, ein Betrag oder ein Preis ist keine Ganzzahl (Tausendstel,
|
|
17
|
+
* Cent, Mikro-Euro): `1.5` waere nie „1,5 Stueck“, sondern ein Fehler;
|
|
18
|
+
* - `expiresInMinutes` liegt ausserhalb 5 … 43 200;
|
|
19
|
+
* - eine Aenderung nennt kein Feld, eine Freigabe eine leere Liste.
|
|
20
|
+
* Alles Fachliche (Pruefziffer der EAN, Kataloge, Bestand, Rechte) prueft der
|
|
21
|
+
* Server und meldet es mit seinem Code.
|
|
22
|
+
*
|
|
23
|
+
* **Wiederholen:** nach einem Zeitlimit oder Netzfehler denselben Aufruf mit
|
|
24
|
+
* **demselben** `idempotencyKey` noch einmal senden. Er wirkt genau einmal und
|
|
25
|
+
* liefert die gespeicherte Antwort; ein neuer Schluessel buchte ein zweites Mal.
|
|
26
|
+
*/
|
|
27
|
+
import type { InternerTransport } from '../client/aufrufe.js';
|
|
28
|
+
import type { Article, ChangeStockConditionRequest, CreateArticleRequest, CreateReservationRequest, DeactivateArticleRequest, ExtendReservationRequest, GoodsReceiptPreview, GoodsReceiptPreviewRequest, ReceiveGoodsRequest, RecordStockLossRequest, ReleaseReservationRequest, Reservation, ReservationListQuery, ReservationPage, ReverseStockMovementRequest, StockOperation, TransferStockRequest, UpdateArticleRequest } from './typen.js';
|
|
29
|
+
/**
|
|
30
|
+
* Legt einen Artikel an. Mit `ean` ein Fremdartikel mit diesem Code (gueltige
|
|
31
|
+
* Pruefziffer, frei im Konto), sonst vergibt der Server den naechsten eigenen
|
|
32
|
+
* Code. Antwort: der Artikel wie `getArticle`.
|
|
33
|
+
*/
|
|
34
|
+
export declare function createArticle(transport: InternerTransport, request: CreateArticleRequest): Promise<Article>;
|
|
35
|
+
/** Aendert nur die genannten Felder eines Artikels (siehe [UpdateArticleRequest]). */
|
|
36
|
+
export declare function updateArticle(transport: InternerTransport, request: UpdateArticleRequest): Promise<Article>;
|
|
37
|
+
/** Legt einen Artikel still (`active: false`); Code und eigene Kennungen werden frei. */
|
|
38
|
+
export declare function deactivateArticle(transport: InternerTransport, request: DeactivateArticleRequest): Promise<Article>;
|
|
39
|
+
/**
|
|
40
|
+
* Bucht einen Wareneingang. Ohne `locationId` am Standard-Standort; die
|
|
41
|
+
* Antwort traegt keine Werte, auch mit dem Recht `costs` nicht. Fuer die
|
|
42
|
+
* Vorschau mit Werten: [previewGoodsReceipt].
|
|
43
|
+
*/
|
|
44
|
+
export declare function receiveGoods(transport: InternerTransport, request: ReceiveGoodsRequest): Promise<StockOperation>;
|
|
45
|
+
/**
|
|
46
|
+
* Vorschau eines Wareneingangs (`receiveGoods` mit `dryRun: true`): prueft
|
|
47
|
+
* Positionen, Artikel, Preise und Nebenkosten und rechnet die Verteilung,
|
|
48
|
+
* schreibt aber nichts. Ein `idempotencyKey` ist freigestellt (`null` wie nicht
|
|
49
|
+
* angegeben, geht nicht hinaus) und wird nicht verbraucht; dieselbe Anfrage
|
|
50
|
+
* laesst sich danach mit ihm buchen. Werte
|
|
51
|
+
* (`baseCents` …) nur mit dem Recht `costs`. Den Standort prueft erst die Buchung.
|
|
52
|
+
*/
|
|
53
|
+
export declare function previewGoodsReceipt(transport: InternerTransport, request: GoodsReceiptPreviewRequest): Promise<GoodsReceiptPreview>;
|
|
54
|
+
/** Bucht Ware von einem Standort an einen anderen; ueberzieht nie (`exceeds_stock`). */
|
|
55
|
+
export declare function transferStock(transport: InternerTransport, request: TransferStockRequest): Promise<StockOperation>;
|
|
56
|
+
/** Bucht einen Abgang (Bruch, Schwund, Diebstahl, Entnahme …); ueberzieht nie (`exceeds_stock`). */
|
|
57
|
+
export declare function recordStockLoss(transport: InternerTransport, request: RecordStockLossRequest): Promise<StockOperation>;
|
|
58
|
+
/** Bucht Ware zwischen `sellable` und `defective` um; ueberzieht nie (`exceeds_stock`). */
|
|
59
|
+
export declare function changeStockCondition(transport: InternerTransport, request: ChangeStockConditionRequest): Promise<StockOperation>;
|
|
60
|
+
/** Nimmt einen ganzen Vorgang (`operationId`) mit einer Gegenbuchung zurueck. */
|
|
61
|
+
export declare function reverseStockMovement(transport: InternerTransport, request: ReverseStockMovementRequest): Promise<StockOperation>;
|
|
62
|
+
/**
|
|
63
|
+
* Reserviert Ware (Checkout im Shop): ganz oder gar nicht, gemessen am
|
|
64
|
+
* verfuegbaren Bestand (`onHand − reserved`). Fehlt etwas, entsteht nichts:
|
|
65
|
+
* `insufficient_available`, die fehlenden Positionen in [inventoryShortfalls].
|
|
66
|
+
* Eingeloest wird ueber eine Rechnung (`issueInvoice` mit `items[].reservationId`),
|
|
67
|
+
* sonst laeuft die Reservierung ab und gibt die Ware wieder frei.
|
|
68
|
+
*/
|
|
69
|
+
export declare function createReservation(transport: InternerTransport, request: CreateReservationRequest): Promise<Reservation>;
|
|
70
|
+
/** Verlaengert eine aktive Reservierung: neuer Ablauf = jetzt + `expiresInMinutes`. */
|
|
71
|
+
export declare function extendReservation(transport: InternerTransport, request: ExtendReservationRequest): Promise<Reservation>;
|
|
72
|
+
/**
|
|
73
|
+
* Gibt reservierte Ware frei: ohne `items` alles, sonst je Position (ohne
|
|
74
|
+
* `quantity` der ganze offene Rest). Die Antwort traegt den Stand danach;
|
|
75
|
+
* `released` wird der Status erst, wenn nichts mehr offen ist.
|
|
76
|
+
*/
|
|
77
|
+
export declare function releaseReservation(transport: InternerTransport, request: ReleaseReservationRequest): Promise<Reservation>;
|
|
78
|
+
/** Eine Reservierung mit ihrem aktuellen Stand. */
|
|
79
|
+
export declare function getReservation(transport: InternerTransport, reservationId: string): Promise<Reservation>;
|
|
80
|
+
/** Reservierungen, neueste zuerst; Filter `status` und/oder `reference`. */
|
|
81
|
+
export declare function listReservations(transport: InternerTransport, query?: ReservationListQuery): Promise<ReservationPage>;
|
|
82
|
+
/** Alle Reservierungen der Abfrage, Seite fuer Seite ueber `nextCursor`. */
|
|
83
|
+
export declare function iterateReservations(transport: InternerTransport, query?: ReservationListQuery): AsyncGenerator<Reservation, void, undefined>;
|
|
@@ -0,0 +1,315 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/**
|
|
3
|
+
* Die schreibenden Aufrufe der Lager-API (Backend Stufe 5b): Artikel anlegen,
|
|
4
|
+
* aendern und stilllegen, Bestand buchen (Wareneingang, Umbuchung, Abgang,
|
|
5
|
+
* Zustand, Gegenbuchung) und reservieren.
|
|
6
|
+
*
|
|
7
|
+
* Wie in `endpunkte.ts` nimmt jede Funktion den Transport als ersten Parameter
|
|
8
|
+
* und ist einzeln importierbar. Die Anfrage geht flach hinaus, genau mit den
|
|
9
|
+
* Feldern, die der Aufrufer nennt (`undefined` faellt weg, `null` bleibt: es
|
|
10
|
+
* leert ein Feld bzw. heisst bei der Anlage „nicht angegeben“).
|
|
11
|
+
*
|
|
12
|
+
* **Vor dem Senden geprueft wird nur, was ohne Netz sicher falsch ist:**
|
|
13
|
+
* - `idempotencyKey` fehlt, ist leer oder laenger als 120 Zeichen. Ohne
|
|
14
|
+
* Schluessel gaebe es keine sichere Wiederholung, und der Server wiese die
|
|
15
|
+
* Anfrage ohnehin ab (`idempotency_key_required` bzw. `validation`);
|
|
16
|
+
* - eine Pflichtkennung fehlt oder ist leer;
|
|
17
|
+
* - eine Menge, ein Betrag oder ein Preis ist keine Ganzzahl (Tausendstel,
|
|
18
|
+
* Cent, Mikro-Euro): `1.5` waere nie „1,5 Stueck“, sondern ein Fehler;
|
|
19
|
+
* - `expiresInMinutes` liegt ausserhalb 5 … 43 200;
|
|
20
|
+
* - eine Aenderung nennt kein Feld, eine Freigabe eine leere Liste.
|
|
21
|
+
* Alles Fachliche (Pruefziffer der EAN, Kataloge, Bestand, Rechte) prueft der
|
|
22
|
+
* Server und meldet es mit seinem Code.
|
|
23
|
+
*
|
|
24
|
+
* **Wiederholen:** nach einem Zeitlimit oder Netzfehler denselben Aufruf mit
|
|
25
|
+
* **demselben** `idempotencyKey` noch einmal senden. Er wirkt genau einmal und
|
|
26
|
+
* liefert die gespeicherte Antwort; ein neuer Schluessel buchte ein zweites Mal.
|
|
27
|
+
*/
|
|
28
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
29
|
+
exports.createArticle = createArticle;
|
|
30
|
+
exports.updateArticle = updateArticle;
|
|
31
|
+
exports.deactivateArticle = deactivateArticle;
|
|
32
|
+
exports.receiveGoods = receiveGoods;
|
|
33
|
+
exports.previewGoodsReceipt = previewGoodsReceipt;
|
|
34
|
+
exports.transferStock = transferStock;
|
|
35
|
+
exports.recordStockLoss = recordStockLoss;
|
|
36
|
+
exports.changeStockCondition = changeStockCondition;
|
|
37
|
+
exports.reverseStockMovement = reverseStockMovement;
|
|
38
|
+
exports.createReservation = createReservation;
|
|
39
|
+
exports.extendReservation = extendReservation;
|
|
40
|
+
exports.releaseReservation = releaseReservation;
|
|
41
|
+
exports.getReservation = getReservation;
|
|
42
|
+
exports.listReservations = listReservations;
|
|
43
|
+
exports.iterateReservations = iterateReservations;
|
|
44
|
+
const endpunkte_js_1 = require("./endpunkte.js");
|
|
45
|
+
const lesen_js_1 = require("./lesen.js");
|
|
46
|
+
const vertrag_js_1 = require("./vertrag.js");
|
|
47
|
+
// ---- Pruefung vor dem Senden ------------------------------------------------------
|
|
48
|
+
/** Die Anfrage als flache Kopie ohne `undefined`; der Aufrufer behaelt sein Objekt. */
|
|
49
|
+
function anfrage(name, request) {
|
|
50
|
+
if (request === null || typeof request !== 'object' || Array.isArray(request)) {
|
|
51
|
+
throw (0, endpunkte_js_1.anfragefehler)(name, 'Anfrage muss ein Objekt sein');
|
|
52
|
+
}
|
|
53
|
+
const raus = {};
|
|
54
|
+
for (const [feld, w] of Object.entries(request))
|
|
55
|
+
if (w !== undefined)
|
|
56
|
+
raus[feld] = w;
|
|
57
|
+
return raus;
|
|
58
|
+
}
|
|
59
|
+
/**
|
|
60
|
+
* `idempotencyKey`: Text mit 1–120 Zeichen, nicht nur Leerraum. Er wird nie
|
|
61
|
+
* getrimmt oder gekuerzt: ein veraenderter Schluessel waere ein anderer.
|
|
62
|
+
*/
|
|
63
|
+
function schluessel(name, p, { pflicht }) {
|
|
64
|
+
const w = p.idempotencyKey;
|
|
65
|
+
if (w === undefined || w === null) {
|
|
66
|
+
if (pflicht) {
|
|
67
|
+
throw (0, endpunkte_js_1.anfragefehler)(name, 'idempotencyKey fehlt (Pflicht bei jedem Schreiben); bei einer Wiederholung denselben Schluessel senden');
|
|
68
|
+
}
|
|
69
|
+
return;
|
|
70
|
+
}
|
|
71
|
+
if (typeof w !== 'string' || w.trim() === '')
|
|
72
|
+
throw (0, endpunkte_js_1.anfragefehler)(name, 'idempotencyKey muss ein nicht leerer Text sein');
|
|
73
|
+
if (w.length > vertrag_js_1.INVENTORY_IDEMPOTENCY_KEY_MAX) {
|
|
74
|
+
throw (0, endpunkte_js_1.anfragefehler)(name, `idempotencyKey ist laenger als ${vertrag_js_1.INVENTORY_IDEMPOTENCY_KEY_MAX} Zeichen`);
|
|
75
|
+
}
|
|
76
|
+
}
|
|
77
|
+
/** Eine Ganzzahl (Tausendstel, Cent, Mikro-Euro); fehlt sie, nur wenn sie darf. `null` nur, wo es leert. */
|
|
78
|
+
function ganz(name, feld, w, { pflicht = false, leerbar = false } = {}) {
|
|
79
|
+
if (w === undefined || (w === null && leerbar)) {
|
|
80
|
+
if (pflicht)
|
|
81
|
+
throw (0, endpunkte_js_1.anfragefehler)(name, `${feld} fehlt`);
|
|
82
|
+
return;
|
|
83
|
+
}
|
|
84
|
+
if (typeof w !== 'number' || !Number.isSafeInteger(w)) {
|
|
85
|
+
throw (0, endpunkte_js_1.anfragefehler)(name, `${feld} muss eine ganze Zahl sein (Mengen in Tausendstel, Geld in Cent, Preise in Mikro-Euro)`);
|
|
86
|
+
}
|
|
87
|
+
}
|
|
88
|
+
/** Haltedauer einer Reservierung in ganzen Minuten. */
|
|
89
|
+
function minuten(name, w, { pflicht }) {
|
|
90
|
+
if (w === undefined || (w === null && !pflicht)) {
|
|
91
|
+
if (pflicht)
|
|
92
|
+
throw (0, endpunkte_js_1.anfragefehler)(name, 'expiresInMinutes fehlt');
|
|
93
|
+
return;
|
|
94
|
+
}
|
|
95
|
+
if (typeof w !== 'number' || !Number.isSafeInteger(w) || w < vertrag_js_1.RESERVATION_MINUTES_MIN || w > vertrag_js_1.RESERVATION_MINUTES_MAX) {
|
|
96
|
+
throw (0, endpunkte_js_1.anfragefehler)(name, `expiresInMinutes muss eine ganze Zahl von ${vertrag_js_1.RESERVATION_MINUTES_MIN} bis ${vertrag_js_1.RESERVATION_MINUTES_MAX} sein`);
|
|
97
|
+
}
|
|
98
|
+
}
|
|
99
|
+
/**
|
|
100
|
+
* Positionen: eine Liste (Pflicht, wo der Aufruf sie verlangt), jede ein
|
|
101
|
+
* Objekt mit `articleId` und ganzzahliger `quantity`. `weiter` prueft die
|
|
102
|
+
* uebrigen Zahlenfelder einer Position. Leer und zu lang entscheidet der Server
|
|
103
|
+
* (`no_positions`, `too_many_positions`).
|
|
104
|
+
*/
|
|
105
|
+
function positionen(name, w, { pflicht, menge }, weiter = () => { }) {
|
|
106
|
+
if (w === undefined) {
|
|
107
|
+
if (pflicht)
|
|
108
|
+
throw (0, endpunkte_js_1.anfragefehler)(name, 'items fehlt');
|
|
109
|
+
return;
|
|
110
|
+
}
|
|
111
|
+
if (!Array.isArray(w))
|
|
112
|
+
throw (0, endpunkte_js_1.anfragefehler)(name, 'items muss eine Liste sein');
|
|
113
|
+
w.forEach((x, i) => {
|
|
114
|
+
const f = `items[${i}]`;
|
|
115
|
+
if (x === null || typeof x !== 'object' || Array.isArray(x))
|
|
116
|
+
throw (0, endpunkte_js_1.anfragefehler)(name, `${f} muss ein Objekt sein`);
|
|
117
|
+
const o = x;
|
|
118
|
+
(0, endpunkte_js_1.kennung)(name, `${f}.articleId`, o.articleId);
|
|
119
|
+
ganz(name, `${f}.quantity`, o.quantity, { pflicht: menge === 'pflicht' });
|
|
120
|
+
weiter(o, f);
|
|
121
|
+
});
|
|
122
|
+
}
|
|
123
|
+
// ---- Artikel ------------------------------------------------------------------
|
|
124
|
+
/** Zahlenfelder eines Artikels; `null` leert sie (bzw. heisst bei der Anlage „nicht angegeben“). */
|
|
125
|
+
function artikelZahlen(name, p) {
|
|
126
|
+
for (const feld of ['unitPriceCents', 'minStock', 'purchasePriceMicros'])
|
|
127
|
+
ganz(name, feld, p[feld], { leerbar: true });
|
|
128
|
+
const jeStandort = p.minStockByLocation;
|
|
129
|
+
if (jeStandort === undefined || jeStandort === null)
|
|
130
|
+
return;
|
|
131
|
+
if (typeof jeStandort !== 'object' || Array.isArray(jeStandort))
|
|
132
|
+
throw (0, endpunkte_js_1.anfragefehler)(name, 'minStockByLocation muss ein Objekt { standort: Tausendstel } sein');
|
|
133
|
+
for (const [standort, w] of Object.entries(jeStandort))
|
|
134
|
+
ganz(name, `minStockByLocation.${standort}`, w, { leerbar: true });
|
|
135
|
+
}
|
|
136
|
+
const artikelAus = (name, daten) => (0, lesen_js_1.artikel)({ name, pfad: 'article' }, (0, lesen_js_1.objekt)(daten)?.article);
|
|
137
|
+
/**
|
|
138
|
+
* Legt einen Artikel an. Mit `ean` ein Fremdartikel mit diesem Code (gueltige
|
|
139
|
+
* Pruefziffer, frei im Konto), sonst vergibt der Server den naechsten eigenen
|
|
140
|
+
* Code. Antwort: der Artikel wie `getArticle`.
|
|
141
|
+
*/
|
|
142
|
+
async function createArticle(transport, request) {
|
|
143
|
+
const name = 'createArticle';
|
|
144
|
+
const p = anfrage(name, request);
|
|
145
|
+
schluessel(name, p, { pflicht: true });
|
|
146
|
+
artikelZahlen(name, p);
|
|
147
|
+
return artikelAus(name, await transport(name, p));
|
|
148
|
+
}
|
|
149
|
+
/** Aendert nur die genannten Felder eines Artikels (siehe [UpdateArticleRequest]). */
|
|
150
|
+
async function updateArticle(transport, request) {
|
|
151
|
+
const name = 'updateArticle';
|
|
152
|
+
const p = anfrage(name, request);
|
|
153
|
+
schluessel(name, p, { pflicht: true });
|
|
154
|
+
(0, endpunkte_js_1.kennung)(name, 'articleId', p.articleId);
|
|
155
|
+
if (Object.keys(p).every((k) => k === 'idempotencyKey' || k === 'articleId')) {
|
|
156
|
+
throw (0, endpunkte_js_1.anfragefehler)(name, 'die Aenderung nennt kein Feld');
|
|
157
|
+
}
|
|
158
|
+
artikelZahlen(name, p);
|
|
159
|
+
return artikelAus(name, await transport(name, p));
|
|
160
|
+
}
|
|
161
|
+
/** Legt einen Artikel still (`active: false`); Code und eigene Kennungen werden frei. */
|
|
162
|
+
async function deactivateArticle(transport, request) {
|
|
163
|
+
const name = 'deactivateArticle';
|
|
164
|
+
const p = anfrage(name, request);
|
|
165
|
+
schluessel(name, p, { pflicht: true });
|
|
166
|
+
(0, endpunkte_js_1.kennung)(name, 'articleId', p.articleId);
|
|
167
|
+
return artikelAus(name, await transport(name, p));
|
|
168
|
+
}
|
|
169
|
+
// ---- Buchen ------------------------------------------------------------------
|
|
170
|
+
function eingangZahlen(name, p) {
|
|
171
|
+
positionen(name, p.items, { pflicht: true, menge: 'pflicht' }, (x, f) => {
|
|
172
|
+
for (const feld of ['totalCents', 'unitPriceMicros', 'landedCostCents'])
|
|
173
|
+
ganz(name, `${f}.${feld}`, x[feld]);
|
|
174
|
+
});
|
|
175
|
+
const nebenkosten = p.landedCosts;
|
|
176
|
+
if (nebenkosten === undefined)
|
|
177
|
+
return;
|
|
178
|
+
if (!Array.isArray(nebenkosten))
|
|
179
|
+
throw (0, endpunkte_js_1.anfragefehler)(name, 'landedCosts muss eine Liste sein');
|
|
180
|
+
nebenkosten.forEach((n, i) => {
|
|
181
|
+
if (n === null || typeof n !== 'object' || Array.isArray(n))
|
|
182
|
+
throw (0, endpunkte_js_1.anfragefehler)(name, `landedCosts[${i}] muss ein Objekt sein`);
|
|
183
|
+
ganz(name, `landedCosts[${i}].amountCents`, n.amountCents, { pflicht: true });
|
|
184
|
+
});
|
|
185
|
+
}
|
|
186
|
+
/**
|
|
187
|
+
* Bucht einen Wareneingang. Ohne `locationId` am Standard-Standort; die
|
|
188
|
+
* Antwort traegt keine Werte, auch mit dem Recht `costs` nicht. Fuer die
|
|
189
|
+
* Vorschau mit Werten: [previewGoodsReceipt].
|
|
190
|
+
*/
|
|
191
|
+
async function receiveGoods(transport, request) {
|
|
192
|
+
const name = 'receiveGoods';
|
|
193
|
+
const p = anfrage(name, request);
|
|
194
|
+
if (p.dryRun === true) {
|
|
195
|
+
throw (0, endpunkte_js_1.anfragefehler)(name, 'dryRun: true bucht nichts und liefert eine Vorschau statt eines Vorgangs; dafuer previewGoodsReceipt aufrufen');
|
|
196
|
+
}
|
|
197
|
+
schluessel(name, p, { pflicht: true });
|
|
198
|
+
eingangZahlen(name, p);
|
|
199
|
+
return (0, lesen_js_1.vorgang)(name, await transport(name, p));
|
|
200
|
+
}
|
|
201
|
+
/**
|
|
202
|
+
* Vorschau eines Wareneingangs (`receiveGoods` mit `dryRun: true`): prueft
|
|
203
|
+
* Positionen, Artikel, Preise und Nebenkosten und rechnet die Verteilung,
|
|
204
|
+
* schreibt aber nichts. Ein `idempotencyKey` ist freigestellt (`null` wie nicht
|
|
205
|
+
* angegeben, geht nicht hinaus) und wird nicht verbraucht; dieselbe Anfrage
|
|
206
|
+
* laesst sich danach mit ihm buchen. Werte
|
|
207
|
+
* (`baseCents` …) nur mit dem Recht `costs`. Den Standort prueft erst die Buchung.
|
|
208
|
+
*/
|
|
209
|
+
async function previewGoodsReceipt(transport, request) {
|
|
210
|
+
const name = 'receiveGoods';
|
|
211
|
+
const p = anfrage(name, request);
|
|
212
|
+
// null heisst hier „kein Schluessel“ und geht wie undefined nicht hinaus.
|
|
213
|
+
if (p.idempotencyKey === null)
|
|
214
|
+
delete p.idempotencyKey;
|
|
215
|
+
schluessel(name, p, { pflicht: false });
|
|
216
|
+
eingangZahlen(name, p);
|
|
217
|
+
const daten = await transport(name, { ...p, dryRun: true });
|
|
218
|
+
return { preview: (0, lesen_js_1.liste)(name, daten, 'preview', lesen_js_1.vorschauZeile) };
|
|
219
|
+
}
|
|
220
|
+
const stueckPositionen = (name, p) => positionen(name, p.items, { pflicht: true, menge: 'pflicht' });
|
|
221
|
+
/** Bucht Ware von einem Standort an einen anderen; ueberzieht nie (`exceeds_stock`). */
|
|
222
|
+
async function transferStock(transport, request) {
|
|
223
|
+
const name = 'transferStock';
|
|
224
|
+
const p = anfrage(name, request);
|
|
225
|
+
schluessel(name, p, { pflicht: true });
|
|
226
|
+
(0, endpunkte_js_1.kennung)(name, 'fromLocationId', p.fromLocationId);
|
|
227
|
+
(0, endpunkte_js_1.kennung)(name, 'toLocationId', p.toLocationId);
|
|
228
|
+
stueckPositionen(name, p);
|
|
229
|
+
return (0, lesen_js_1.vorgang)(name, await transport(name, p));
|
|
230
|
+
}
|
|
231
|
+
/** Bucht einen Abgang (Bruch, Schwund, Diebstahl, Entnahme …); ueberzieht nie (`exceeds_stock`). */
|
|
232
|
+
async function recordStockLoss(transport, request) {
|
|
233
|
+
const name = 'recordStockLoss';
|
|
234
|
+
const p = anfrage(name, request);
|
|
235
|
+
schluessel(name, p, { pflicht: true });
|
|
236
|
+
stueckPositionen(name, p);
|
|
237
|
+
return (0, lesen_js_1.vorgang)(name, await transport(name, p));
|
|
238
|
+
}
|
|
239
|
+
/** Bucht Ware zwischen `sellable` und `defective` um; ueberzieht nie (`exceeds_stock`). */
|
|
240
|
+
async function changeStockCondition(transport, request) {
|
|
241
|
+
const name = 'changeStockCondition';
|
|
242
|
+
const p = anfrage(name, request);
|
|
243
|
+
schluessel(name, p, { pflicht: true });
|
|
244
|
+
stueckPositionen(name, p);
|
|
245
|
+
return (0, lesen_js_1.vorgang)(name, await transport(name, p));
|
|
246
|
+
}
|
|
247
|
+
/** Nimmt einen ganzen Vorgang (`operationId`) mit einer Gegenbuchung zurueck. */
|
|
248
|
+
async function reverseStockMovement(transport, request) {
|
|
249
|
+
const name = 'reverseStockMovement';
|
|
250
|
+
const p = anfrage(name, request);
|
|
251
|
+
schluessel(name, p, { pflicht: true });
|
|
252
|
+
(0, endpunkte_js_1.kennung)(name, 'operationId', p.operationId);
|
|
253
|
+
return (0, lesen_js_1.vorgang)(name, await transport(name, p));
|
|
254
|
+
}
|
|
255
|
+
// ---- Reservierung ---------------------------------------------------------------
|
|
256
|
+
const reservierungAus = (name, daten) => (0, lesen_js_1.reservierung)({ name, pfad: 'reservation' }, (0, lesen_js_1.objekt)(daten)?.reservation);
|
|
257
|
+
/**
|
|
258
|
+
* Reserviert Ware (Checkout im Shop): ganz oder gar nicht, gemessen am
|
|
259
|
+
* verfuegbaren Bestand (`onHand − reserved`). Fehlt etwas, entsteht nichts:
|
|
260
|
+
* `insufficient_available`, die fehlenden Positionen in [inventoryShortfalls].
|
|
261
|
+
* Eingeloest wird ueber eine Rechnung (`issueInvoice` mit `items[].reservationId`),
|
|
262
|
+
* sonst laeuft die Reservierung ab und gibt die Ware wieder frei.
|
|
263
|
+
*/
|
|
264
|
+
async function createReservation(transport, request) {
|
|
265
|
+
const name = 'createReservation';
|
|
266
|
+
const p = anfrage(name, request);
|
|
267
|
+
schluessel(name, p, { pflicht: true });
|
|
268
|
+
positionen(name, p.items, { pflicht: true, menge: 'pflicht' });
|
|
269
|
+
minuten(name, p.expiresInMinutes, { pflicht: false });
|
|
270
|
+
return reservierungAus(name, await transport(name, p));
|
|
271
|
+
}
|
|
272
|
+
/** Verlaengert eine aktive Reservierung: neuer Ablauf = jetzt + `expiresInMinutes`. */
|
|
273
|
+
async function extendReservation(transport, request) {
|
|
274
|
+
const name = 'extendReservation';
|
|
275
|
+
const p = anfrage(name, request);
|
|
276
|
+
schluessel(name, p, { pflicht: true });
|
|
277
|
+
(0, endpunkte_js_1.kennung)(name, 'reservationId', p.reservationId);
|
|
278
|
+
minuten(name, p.expiresInMinutes, { pflicht: true });
|
|
279
|
+
return reservierungAus(name, await transport(name, p));
|
|
280
|
+
}
|
|
281
|
+
/**
|
|
282
|
+
* Gibt reservierte Ware frei: ohne `items` alles, sonst je Position (ohne
|
|
283
|
+
* `quantity` der ganze offene Rest). Die Antwort traegt den Stand danach;
|
|
284
|
+
* `released` wird der Status erst, wenn nichts mehr offen ist.
|
|
285
|
+
*/
|
|
286
|
+
async function releaseReservation(transport, request) {
|
|
287
|
+
const name = 'releaseReservation';
|
|
288
|
+
const p = anfrage(name, request);
|
|
289
|
+
schluessel(name, p, { pflicht: true });
|
|
290
|
+
(0, endpunkte_js_1.kennung)(name, 'reservationId', p.reservationId);
|
|
291
|
+
if (Array.isArray(p.items) && p.items.length === 0) {
|
|
292
|
+
throw (0, endpunkte_js_1.anfragefehler)(name, 'items ist leer; um alles freizugeben, items ganz weglassen');
|
|
293
|
+
}
|
|
294
|
+
positionen(name, p.items, { pflicht: false, menge: 'frei' });
|
|
295
|
+
return reservierungAus(name, await transport(name, p));
|
|
296
|
+
}
|
|
297
|
+
/** Eine Reservierung mit ihrem aktuellen Stand. */
|
|
298
|
+
async function getReservation(transport, reservationId) {
|
|
299
|
+
const name = 'getReservation';
|
|
300
|
+
return reservierungAus(name, await transport(name, { reservationId: (0, endpunkte_js_1.kennung)(name, 'reservationId', reservationId) }));
|
|
301
|
+
}
|
|
302
|
+
/** Reservierungen, neueste zuerst; Filter `status` und/oder `reference`. */
|
|
303
|
+
async function listReservations(transport, query) {
|
|
304
|
+
const name = 'listReservations';
|
|
305
|
+
const daten = await transport(name, (0, endpunkte_js_1.abfrage)(name, query));
|
|
306
|
+
return { reservations: (0, lesen_js_1.liste)(name, daten, 'reservations', lesen_js_1.reservierung), nextCursor: (0, lesen_js_1.naechsterCursor)(name, daten) };
|
|
307
|
+
}
|
|
308
|
+
/** Alle Reservierungen der Abfrage, Seite fuer Seite ueber `nextCursor`. */
|
|
309
|
+
function iterateReservations(transport, query) {
|
|
310
|
+
const { cursor, ...rest } = query ?? {};
|
|
311
|
+
return (0, endpunkte_js_1.seitenweise)('listReservations', cursor, async (c) => {
|
|
312
|
+
const s = await listReservations(transport, { ...rest, cursor: c });
|
|
313
|
+
return { eintraege: s.reservations, nextCursor: s.nextCursor };
|
|
314
|
+
});
|
|
315
|
+
}
|