@kreiseck/kasseneck-api 1.28.0 → 1.29.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.
Files changed (49) hide show
  1. package/CHANGELOG.md +11 -0
  2. package/README.md +84 -0
  3. package/dist/cjs/client/api.d.ts +15 -0
  4. package/dist/cjs/client/api.js +8 -0
  5. package/dist/cjs/client/aufrufe.d.ts +3 -3
  6. package/dist/cjs/client/aufrufe.js +28 -0
  7. package/dist/cjs/client/index.d.ts +1 -0
  8. package/dist/cjs/client/index.js +17 -1
  9. package/dist/cjs/client/terminal.d.ts +206 -0
  10. package/dist/cjs/client/terminal.js +288 -0
  11. package/dist/cjs/index.d.ts +1 -1
  12. package/dist/cjs/index.js +17 -1
  13. package/dist/cjs/stored/vokabular.d.ts +1 -1
  14. package/dist/cjs/stored/vokabular.js +1 -1
  15. package/dist/cjs/version.d.ts +1 -1
  16. package/dist/cjs/version.js +1 -1
  17. package/dist/esm/client/api.d.ts +15 -0
  18. package/dist/esm/client/api.js +8 -0
  19. package/dist/esm/client/aufrufe.d.ts +3 -3
  20. package/dist/esm/client/aufrufe.js +28 -0
  21. package/dist/esm/client/index.d.ts +1 -0
  22. package/dist/esm/client/index.js +1 -0
  23. package/dist/esm/client/terminal.d.ts +206 -0
  24. package/dist/esm/client/terminal.js +278 -0
  25. package/dist/esm/index.d.ts +1 -1
  26. package/dist/esm/index.js +1 -1
  27. package/dist/esm/stored/vokabular.d.ts +1 -1
  28. package/dist/esm/stored/vokabular.js +1 -1
  29. package/dist/esm/version.d.ts +1 -1
  30. package/dist/esm/version.js +1 -1
  31. package/fixtures/hobex-hps-codes.json +1 -1
  32. package/fixtures/invoice-api.schema.json +1 -1
  33. package/fixtures/invoice-texts.json +1 -1
  34. package/fixtures/pos-texts.json +1 -1
  35. package/fixtures/surface.json +19 -3
  36. package/fixtures/v3/antworten/belege.json +1 -1
  37. package/fixtures/v3/antworten/belegmail.json +1 -1
  38. package/fixtures/v3/antworten/berichte.json +1 -1
  39. package/fixtures/v3/antworten/kasse-belege.json +1 -1
  40. package/fixtures/v3/antworten/kasse.json +2 -2
  41. package/fixtures/v3/antworten/lager.json +1 -1
  42. package/fixtures/v3/antworten/rechnungen.json +1 -1
  43. package/fixtures/v3/antworten/storno.json +1 -1
  44. package/fixtures/v3/stored/belege.json +1 -1
  45. package/fixtures/v3/stored/kasse.json +2 -2
  46. package/fixtures/v3/stored/rechnungen.json +1 -1
  47. package/fixtures/v3/v3-vokabular.json +55 -4
  48. package/fixtures/v3/zahlbetrag-faelle.json +1 -1
  49. package/package.json +1 -1
package/CHANGELOG.md CHANGED
@@ -4,6 +4,17 @@ Was vor 0.7.0 geschah, steht in der Commit-Historie (`git log`); ab hier wird
4
4
  es hier geführt. Ein Eintrag nennt die Änderung **und ihren Grund** —
5
5
  nur der Grund überlebt den nächsten Umbau.
6
6
 
7
+ ## 1.29.0 - 2026-11-07
8
+
9
+ Card terminal on the phone: Kasseneck keeps the terminal app's accounts, the terminal IDs (TID) of each business and the code the provider mails when a TID moves to another device. Any app gets access, TID and code over `/v3`; nobody at the device types e-mail, password or TID. Additive.
10
+
11
+ - **Seven calls** (root and `createKasseneckApi`, only on `/v3`, `PUBLIC_CALLS` now 120; not on the register path yet): `registerTerminalDevice({ label, platform, app, requestedBy? })` -> `{ deviceId, deviceSecret }` (the secret only in this answer); `getTerminalAccess({ deviceId, deviceSecret, platform?, app?, label? })` -> `TerminalAccess` (`available: true`, `username`, `password`, `terminalId`, `terminalName`, `accountId`, `autoCode`, `codeFormat { length, labels }`, `setup { state, since }`, `updatedAt`) or `{ available: false, reason: 'no_free_terminal', terminals[] }` with the TIDs of the own business; `claimTerminal({ …, terminalId, label? })` -> `TerminalAccess`; `requestTerminalCode({ …, platform, requestedBy? })` -> `{ status }`; `getTerminalCode({ deviceId, deviceSecret })` -> `{ status, code?, source?, validUntil?, setup }`; `reportTerminalLogin({ …, terminalId, success, newOnDevice })` and `reportTerminalReady({ … })` answer nothing. Sign-in is the business's `api_key` alone; the `cashregister-token` of `apiKeyAuth` is ignored, an app without a register can use `inventoryKeyAuth`. Reason: three apps share one terminal account and moved TIDs by typing credentials and asking support for the code.
12
+ - **Secrets:** `deviceSecret`, `password` and `code` never appear in an error of this package (the device secret goes to the transport as a secret parameter, response checks name only the missing field). Callers must never log them and keep `deviceSecret` in the device's secure storage.
13
+ - **Form checked before sending** (`KasseneckValidationError`, `scope: 'request'`): `label` 1-60, `app` 1-40, `requestedBy` 1-80 characters (spaces at the edges do not count, as on the server), `platform` `android|ios`, `deviceId`/`deviceSecret`/`terminalId` not empty, `success`/`newOnDevice` booleans; only set optional fields go out. A later setup state, code status or source arrives unchanged (`(string & {})`).
14
+ - **Outcome after a timeout:** only `registerTerminalDevice` (a retry registers another device) and `getTerminalCode` (on Android the answer consumes the code) report `outcome: 'unknown'`. The other five are repeatable and stay `'rejected'`: `getTerminalAccess` (a retry returns the same assignment), `claimTerminal` (claiming the same TID again changes nothing), `requestTerminalCode` (an open request younger than 6 minutes stays, no new one) and `reportTerminalLogin`/`reportTerminalReady` (the same state written again). Same classification as the Dart package.
15
+ - **`TERMINAL_ERROR_CODES`** equal to `errorCodes.terminal` of the contract (order included, pinned by a test): `terminal_not_enabled`, `terminal_test_environment`, `terminal_device_unknown`, `terminal_device_blocked`, `invalid_terminal_device`, `too_many_terminal_devices`, `terminal_not_in_business`, `terminal_code_manual`, `terminal_code_rate_limited`, `terminal_not_assigned`, `server_error`. Lists `TERMINAL_PLATFORMS`, `TERMINAL_SETUP_STATES`, `TERMINAL_CODE_STATUSES`, `TERMINAL_CODE_SOURCES`.
16
+ - Contract `v3` re-fetched from the backend (the seven endpoints, `errorCodes.terminal`).
17
+
7
18
  ## 1.28.0 - 2026-11-06
8
19
 
9
20
  Shift flow of the till: start a shift, count in between, close in steps, tip kinds, column width. Additive; every field below is sent by the server only when it applies, a reader without them behaves as before (all existing goldens unchanged).
package/README.md CHANGED
@@ -1218,6 +1218,90 @@ this README.
1218
1218
  Terminals that can only be driven through a vendor's Android SDK cannot be
1219
1219
  reached from a browser and are not part of this package.
1220
1220
 
1221
+ ### Card terminal on the phone: access, terminal ID and code
1222
+
1223
+ For a card terminal that runs as an app on the phone, Kasseneck keeps the
1224
+ terminal app's login, the terminal IDs (TID) of each business and the code the
1225
+ provider mails when a TID moves to another device. The app gets all three from
1226
+ here; nobody at the device types e-mail, password or TID. Only on `/v3`, not on
1227
+ the register path yet. Sign-in is the business's `api_key` alone: the
1228
+ `cashregister-token` of `apiKeyAuth` is ignored, and an app without a register
1229
+ can sign in with `inventoryKeyAuth` from `./inventory`. A business gets access
1230
+ only once Kasseneck has assigned it at least one TID, and never in the test
1231
+ environment (`kr_test_`).
1232
+
1233
+ ```ts
1234
+ // Once per device; keep deviceSecret in the device's secure storage.
1235
+ const device = await api.registerTerminalDevice({ label: 'Pixel 8 - Livia', platform: 'android', app: 'karteck/1.6.21' });
1236
+
1237
+ // On every start and at least once a day.
1238
+ const access = await api.getTerminalAccess({ ...device, app: 'karteck/1.6.22' });
1239
+ if (!access.available) {
1240
+ // No free TID: show access.terminals (TIDs of the own business) and let the user pick one.
1241
+ const taken = await api.claimTerminal({ ...device, terminalId: access.terminals[0]!.terminalId });
1242
+ }
1243
+
1244
+ // The terminal app asks for the code after a TID moved: let Kasseneck read it from the mailbox.
1245
+ if (access.available && access.autoCode) {
1246
+ await api.requestTerminalCode({ ...device, platform: 'android' });
1247
+ const code = await api.getTerminalCode(device); // poll until status 'found'
1248
+ }
1249
+ await api.reportTerminalLogin({ ...device, terminalId: '12345678', success: true, newOnDevice: true });
1250
+ await api.reportTerminalReady(device);
1251
+ ```
1252
+
1253
+ - **`registerTerminalDevice({ label, platform, app, requestedBy? })`**:
1254
+ `label` 1-60 characters, `platform` `android` or `ios`, `app` 1-40 (app and
1255
+ version), `requestedBy` up to 80 (written to the log). Answers
1256
+ `{ deviceId, deviceSecret }`; the secret comes only in this answer. At most
1257
+ 20 devices per business and 10 registrations per day
1258
+ (`too_many_terminal_devices`). After a lost answer (`outcome: 'unknown'`) a
1259
+ retry registers another device.
1260
+ - **`getTerminalAccess({ deviceId, deviceSecret, platform?, app?, label? })`**:
1261
+ the device keeps its TID; without one it gets a free TID of its business.
1262
+ Answers `TerminalAccess` (`available: true`, `username`, `password`,
1263
+ `terminalId`, `terminalName`, `accountId`, `autoCode`, `codeFormat { length, labels }`
1264
+ for checking a pasted code, `setup { state, since }`, `updatedAt`) or, when no
1265
+ TID is free, `{ available: false, reason: 'no_free_terminal', terminals }`
1266
+ with `{ terminalId, name, lastUsedBy, lastUsedAt }` of the own business only.
1267
+ The optional fields update what the device shows in the log. Repeatable.
1268
+ - **`claimTerminal({ deviceId, deviceSecret, terminalId, label? })`** moves a
1269
+ TID of the own business to this device (the previous device loses it) and
1270
+ answers `TerminalAccess`. Unknown and foreign TIDs get the same answer,
1271
+ `terminal_not_in_business`.
1272
+ - **`requestTerminalCode({ deviceId, deviceSecret, platform, requestedBy? })`**
1273
+ only when `autoCode` is `true` (otherwise `terminal_code_manual`: the app asks
1274
+ the user for the code). An open request younger than 6 minutes stays, so a
1275
+ double tap does no harm; at most 6 requests per device and hour
1276
+ (`terminal_code_rate_limited`). Answers `{ status }`.
1277
+ - **`getTerminalCode({ deviceId, deviceSecret })`** answers
1278
+ `{ status, code?, source?, validUntil?, setup }`; `status` is `none` (no
1279
+ request), `searching`, `found`, `delivered`, `unclear`, `no_code` or
1280
+ `expired`. The `code` (case matters, never change it) comes with `found`; on
1281
+ Android this answer consumes it, on iOS it stays readable until `validUntil`.
1282
+ After a lost answer (`outcome: 'unknown'`) the code may be gone: request a new
1283
+ one. Without a request the call still reports the `setup` state.
1284
+ - **`reportTerminalLogin({ deviceId, deviceSecret, terminalId, success, newOnDevice })`**
1285
+ and **`reportTerminalReady({ deviceId, deviceSecret })`** report the login in
1286
+ the terminal app (`newOnDevice`: first login of this TID on this device) and
1287
+ the finished setup. Both answer nothing.
1288
+ - **After a timeout:** only `registerTerminalDevice` and `getTerminalCode`
1289
+ report `outcome: 'unknown'`. The other five are repeatable: claiming the same
1290
+ TID again changes nothing, an open code request younger than 6 minutes stays
1291
+ (no new one), and both reports write the same state again.
1292
+ - **Secrets:** `deviceSecret`, `password` and `code` never appear in an error of
1293
+ this package. **Never log them** in the app, and do not keep the password or
1294
+ the code longer than the terminal app needs them.
1295
+ - **Errors** (`KasseneckApiError.code`, `TERMINAL_ERROR_CODES`, the list
1296
+ `errorCodes.terminal` of the contract): `terminal_not_enabled` (no TID
1297
+ assigned to the business), `terminal_test_environment`,
1298
+ `terminal_device_unknown` (id or secret wrong, same answer for both),
1299
+ `terminal_device_blocked`, `invalid_terminal_device`,
1300
+ `too_many_terminal_devices`, `terminal_not_in_business`,
1301
+ `terminal_code_manual`, `terminal_code_rate_limited`, `terminal_not_assigned`
1302
+ (call `getTerminalAccess` first), `server_error`, plus the codes of sign-in and
1303
+ edge. A later setup state, code status or source arrives unchanged.
1304
+
1221
1305
  ## Partner API (`./partner`)
1222
1306
 
1223
1307
  For software vendors who build Kasseneck into their own product: create
@@ -5,6 +5,7 @@ import { type TransportOptions } from './transport.js';
5
5
  import { type CashregisterReportPeriod, type ReportV2, type ReportV2Options } from './reports.js';
6
6
  import { type CashboxStatus, type SignatureStatus } from './status.js';
7
7
  import { type CreateDepExportOptions, type CreateDepExportResult, type DepExport, type DepExportFile, type DepHandoverLink, type GetDepExportFileOptions, type RevokedDepHandoverLink, type WaitForDepExportOptions } from './dep-export.js';
8
+ import { type ClaimTerminalOptions, type GetTerminalAccessOptions, type RegisteredTerminalDevice, type RegisterTerminalDeviceOptions, type ReportTerminalLoginOptions, type RequestTerminalCodeOptions, type TerminalAccess, type TerminalAccessResult, type TerminalCode, type TerminalCodeRequest, type TerminalDeviceCredentials } from './terminal.js';
8
9
  import { type ListedReceipt, type ListReceiptsOptions, type ListReceiptsPage, type ListReceiptsView } from './list-receipts.js';
9
10
  import { type SendReceiptEmailOptions, type SendReceiptEmailResult, type LogReceiptOutputsOptions, type LogReceiptOutputsResult, type ListMyReceiptsOptions, type ReceiptList, type ReceiptWithCompany, type SellReceiptOptions, type CancelReceiptOptions, type CancelReceiptResult } from './receipts.js';
10
11
  /**
@@ -80,6 +81,20 @@ export interface KasseneckApi {
80
81
  revokeDepHandoverLink(options: {
81
82
  linkId: string;
82
83
  }): Promise<RevokedDepHandoverLink>;
84
+ /** Geraet fuer das Kartenterminal am Handy einmal anmelden (`registerTerminalDevice`, nur /v3); `deviceSecret` nur in dieser Antwort. */
85
+ registerTerminalDevice(options: RegisterTerminalDeviceOptions): Promise<RegisteredTerminalDevice>;
86
+ /** Zugang und TID fuer das Geraet, oder die TIDs des eigenen Betriebs, wenn keine frei ist (`getTerminalAccess`). */
87
+ getTerminalAccess(options: GetTerminalAccessOptions): Promise<TerminalAccessResult>;
88
+ /** TID des eigenen Betriebs auf dieses Geraet uebernehmen (`claimTerminal`). */
89
+ claimTerminal(options: ClaimTerminalOptions): Promise<TerminalAccess>;
90
+ /** Code fuer die TID aus dem Postfach anfragen (`requestTerminalCode`, nur bei `autoCode`). */
91
+ requestTerminalCode(options: RequestTerminalCodeOptions): Promise<TerminalCodeRequest>;
92
+ /** Stand der Code-Anfrage und der Einrichtung, bei `found` mit Code (`getTerminalCode`). */
93
+ getTerminalCode(options: TerminalDeviceCredentials): Promise<TerminalCode>;
94
+ /** Ausgang der Anmeldung in der Terminal-App melden (`reportTerminalLogin`). */
95
+ reportTerminalLogin(options: ReportTerminalLoginOptions): Promise<void>;
96
+ /** Terminal-App fertig eingerichtet melden (`reportTerminalReady`). */
97
+ reportTerminalReady(options: TerminalDeviceCredentials): Promise<void>;
83
98
  /** Kassenbericht als PDF (v2): abgeschlossener Monat, Tag oder Zeitraum (Endpunkt `getCashregisterReport`). */
84
99
  getCashregisterReport(options: CashregisterReportPeriod): Promise<Uint8Array>;
85
100
  /** @deprecated Since 1.10.0: use getCashregisterReport. Tagesbericht als PDF (Kalendertag nach Wiener Zeit). */
@@ -7,6 +7,7 @@ const transport_js_1 = require("./transport.js");
7
7
  const reports_js_1 = require("./reports.js");
8
8
  const status_js_1 = require("./status.js");
9
9
  const dep_export_js_1 = require("./dep-export.js");
10
+ const terminal_js_1 = require("./terminal.js");
10
11
  const list_receipts_js_1 = require("./list-receipts.js");
11
12
  const receipts_js_1 = require("./receipts.js");
12
13
  const cashregisters_js_1 = require("./cashregisters.js");
@@ -49,6 +50,13 @@ function createKasseneckApi(options) {
49
50
  getDepExportFile: (o) => (0, dep_export_js_1.getDepExportFile)(rufenDatei, holen, o),
50
51
  createDepHandoverLink: (o) => (0, dep_export_js_1.createDepHandoverLink)(rufen, o),
51
52
  revokeDepHandoverLink: (o) => (0, dep_export_js_1.revokeDepHandoverLink)(rufen, o),
53
+ registerTerminalDevice: (o) => (0, terminal_js_1.registerTerminalDevice)(rufen, o),
54
+ getTerminalAccess: (o) => (0, terminal_js_1.getTerminalAccess)(rufen, o),
55
+ claimTerminal: (o) => (0, terminal_js_1.claimTerminal)(rufen, o),
56
+ requestTerminalCode: (o) => (0, terminal_js_1.requestTerminalCode)(rufen, o),
57
+ getTerminalCode: (o) => (0, terminal_js_1.getTerminalCode)(rufen, o),
58
+ reportTerminalLogin: (o) => (0, terminal_js_1.reportTerminalLogin)(rufen, o),
59
+ reportTerminalReady: (o) => (0, terminal_js_1.reportTerminalReady)(rufen, o),
52
60
  getCashregisterReport: (options) => (0, reports_js_1.getCashregisterReport)(rufenBinaer, options),
53
61
  downloadDailyReport: (date) => (0, reports_js_1.downloadDailyReport)(rufenBinaer, date),
54
62
  downloadMonthlyReport: (reportMonth) => (0, reports_js_1.downloadMonthlyReport)(rufenBinaer, reportMonth),
@@ -13,7 +13,7 @@
13
13
  * umhuellt, muss ihn weiterhin absetzen koennen.
14
14
  */
15
15
  import type { FileOrData, FileOrDataCallOptions, PdfOrData, TransportBodyFields, TransportCallOptions } from './transport.js';
16
- export declare const ALL_CALLS: readonly ["activateCashregister", "cancelInvoice", "cancelReceipt", "createCreditNote", "createCustomer", "createCustomerCashregister", "createDepExport", "createDepHandoverLink", "createPartnerCustomer", "checkPartnerCustomerEmail", "createPartnerWebhook", "createPaymentLinkStripe", "createPrintJob", "createReceipt", "deletePartnerWebhook", "downloadDailyReport", "downloadReport", "endRegisterSession", "financeWebService", "generateFullReceiptId", "getCashregisterReport", "getCustomer", "getCustomerCredentials", "getCustomerSignatureStatus", "getDepExport", "getDepExportFile", "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", "listReceipts", "listRegisterUsersForDevice", "listRegisterSessionsForDevice", "pairRegisterDevice", "recordInvoicePayment", "registerPinLogin", "registerUserLogin", "renewRegisterSession", "reportCustomerContract", "requestCustomerSignature", "revokeDepHandoverLink", "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", "createVariantGroup", "updateVariantGroup", "getVariantGroup", "listVariantGroups", "addVariant", "createStocktake", "listStocktakes", "getStocktake", "listStocktakeItems", "recordStocktakeCount", "voidStocktakeCount", "listStocktakeCounts", "reviewStocktake", "recountStocktake", "closeStocktake", "cancelStocktake", "getStocktakePdf", "orderSignatureCard", "getSignatureCardOrder", "listMyStocktakes", "listMyStocktakeItems", "listMyStocktakeCounts", "recordMyStocktakeCount", "voidMyStocktakeCount", "checkVoucher", "reprintVoucherLabel", "getMyDrawerState", "openMyShift", "recordMyCashMovement", "logMyDrawerOpenings", "getMyShiftReport", "closeMyShift", "recordMyShiftCount", "logReceiptOutputs", "getRegisterInspectionInfo", "reportConnectState"];
16
+ export declare const ALL_CALLS: readonly ["activateCashregister", "cancelInvoice", "cancelReceipt", "createCreditNote", "createCustomer", "createCustomerCashregister", "createDepExport", "createDepHandoverLink", "createPartnerCustomer", "checkPartnerCustomerEmail", "createPartnerWebhook", "createPaymentLinkStripe", "createPrintJob", "createReceipt", "deletePartnerWebhook", "downloadDailyReport", "downloadReport", "endRegisterSession", "financeWebService", "generateFullReceiptId", "getCashregisterReport", "getCustomer", "getCustomerCredentials", "getCustomerSignatureStatus", "getDepExport", "getDepExportFile", "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", "listReceipts", "listRegisterUsersForDevice", "listRegisterSessionsForDevice", "pairRegisterDevice", "recordInvoicePayment", "registerPinLogin", "registerUserLogin", "renewRegisterSession", "reportCustomerContract", "requestCustomerSignature", "revokeDepHandoverLink", "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", "createVariantGroup", "updateVariantGroup", "getVariantGroup", "listVariantGroups", "addVariant", "createStocktake", "listStocktakes", "getStocktake", "listStocktakeItems", "recordStocktakeCount", "voidStocktakeCount", "listStocktakeCounts", "reviewStocktake", "recountStocktake", "closeStocktake", "cancelStocktake", "getStocktakePdf", "orderSignatureCard", "getSignatureCardOrder", "listMyStocktakes", "listMyStocktakeItems", "listMyStocktakeCounts", "recordMyStocktakeCount", "voidMyStocktakeCount", "checkVoucher", "reprintVoucherLabel", "getMyDrawerState", "openMyShift", "recordMyCashMovement", "logMyDrawerOpenings", "getMyShiftReport", "closeMyShift", "recordMyShiftCount", "logReceiptOutputs", "getRegisterInspectionInfo", "reportConnectState", "registerTerminalDevice", "getTerminalAccess", "claimTerminal", "requestTerminalCode", "getTerminalCode", "reportTerminalLogin", "reportTerminalReady"];
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", "getCashregisterReport", "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", "createVariantGroup", "updateVariantGroup", "getVariantGroup", "listVariantGroups", "addVariant", "createStocktake", "listStocktakes", "getStocktake", "listStocktakeItems", "recordStocktakeCount", "voidStocktakeCount", "listStocktakeCounts", "reviewStocktake", "recountStocktake", "closeStocktake", "cancelStocktake", "getStocktakePdf", "orderSignatureCard", "getSignatureCardOrder", "listReceipts", "createDepExport", "getDepExport", "getDepExportFile", "createDepHandoverLink", "revokeDepHandoverLink"];
24
+ export declare const PUBLIC_CALLS: readonly ["createReceipt", "getReceipt", "cancelReceipt", "sendReceiptEmail", "generateFullReceiptId", "downloadReceipt", "getFirstReceiptDate", "getReportV2", "downloadReport", "downloadDailyReport", "getCashregisterReport", "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", "createVariantGroup", "updateVariantGroup", "getVariantGroup", "listVariantGroups", "addVariant", "createStocktake", "listStocktakes", "getStocktake", "listStocktakeItems", "recordStocktakeCount", "voidStocktakeCount", "listStocktakeCounts", "reviewStocktake", "recountStocktake", "closeStocktake", "cancelStocktake", "getStocktakePdf", "orderSignatureCard", "getSignatureCardOrder", "listReceipts", "createDepExport", "getDepExport", "getDepExportFile", "createDepHandoverLink", "revokeDepHandoverLink", "registerTerminalDevice", "getTerminalAccess", "claimTerminal", "requestTerminalCode", "getTerminalCode", "reportTerminalLogin", "reportTerminalReady"];
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
@@ -50,7 +50,7 @@ export type PosCall = typeof POS_CALLS[number];
50
50
  * [ALL_CALLS], [PUBLIC_CALLS] und [POS_CALLS] steht entweder hier oder in
51
51
  * [CALLS_WITHOUT_EFFECT] (Waechter `test/ausgang-einordnung.test.ts`).
52
52
  */
53
- export declare const UNKNOWN_OUTCOME_CALLS: readonly ["activateCashregister", "addVariant", "cancelInvoice", "cancelReceipt", "cancelStocktake", "changeStockCondition", "closeMyShift", "closeStocktake", "createArticle", "createCreditNote", "createCustomer", "createCustomerCashregister", "createInvoiceItem", "createPartnerCustomer", "createPartnerWebhook", "createPrintJob", "createReceipt", "createReservation", "createStocktake", "createVariantGroup", "createWebhook", "deactivateArticle", "deletePartnerWebhook", "deleteWebhook", "extendReservation", "financeWebService", "hobexPayApi", "hobexRefundApi", "issueInvoice", "logMyDrawerOpenings", "logReceiptOutputs", "openMyShift", "orderSignatureCard", "pairRegisterDevice", "receiveGoods", "recordInvoicePayment", "recordMyCashMovement", "recordMyShiftCount", "recordMyStocktakeCount", "recordStockLoss", "recordStocktakeCount", "recountStocktake", "releaseReservation", "reportConnectState", "reportCustomerContract", "requestCustomerSignature", "reverseStockMovement", "reviewStocktake", "revokeCustomerMandate", "rotatePartnerWebhookSecret", "rotateWebhookSecret", "sendPartnerCustomerFonLink", "sendPartnerWebhookTest", "sendReceiptEmail", "sendWebhookTest", "setCustomerMandate", "setMyCashregisterStockLocation", "setMyKasseLogo", "setMyKasseSettings", "setMyRegisterDeviceSettings", "stripeCaptureIntent", "transferStock", "unpairRegisterDevice", "updateArticle", "updateCustomer", "updateInvoiceItem", "updatePartnerWebhook", "updateVariantGroup", "updateWebhook", "voidMyStocktakeCount", "voidStocktakeCount", "withdrawInvoiceItem"];
53
+ export declare const UNKNOWN_OUTCOME_CALLS: readonly ["activateCashregister", "addVariant", "cancelInvoice", "cancelReceipt", "cancelStocktake", "changeStockCondition", "closeMyShift", "closeStocktake", "createArticle", "createCreditNote", "createCustomer", "createCustomerCashregister", "createInvoiceItem", "createPartnerCustomer", "createPartnerWebhook", "createPrintJob", "createReceipt", "createReservation", "createStocktake", "createVariantGroup", "createWebhook", "deactivateArticle", "deletePartnerWebhook", "deleteWebhook", "extendReservation", "financeWebService", "getTerminalCode", "hobexPayApi", "hobexRefundApi", "issueInvoice", "logMyDrawerOpenings", "logReceiptOutputs", "openMyShift", "orderSignatureCard", "pairRegisterDevice", "receiveGoods", "recordInvoicePayment", "recordMyCashMovement", "recordMyShiftCount", "recordMyStocktakeCount", "recordStockLoss", "recordStocktakeCount", "recountStocktake", "registerTerminalDevice", "releaseReservation", "reportConnectState", "reportCustomerContract", "requestCustomerSignature", "reverseStockMovement", "reviewStocktake", "revokeCustomerMandate", "rotatePartnerWebhookSecret", "rotateWebhookSecret", "sendPartnerCustomerFonLink", "sendPartnerWebhookTest", "sendReceiptEmail", "sendWebhookTest", "setCustomerMandate", "setMyCashregisterStockLocation", "setMyKasseLogo", "setMyKasseSettings", "setMyRegisterDeviceSettings", "stripeCaptureIntent", "transferStock", "unpairRegisterDevice", "updateArticle", "updateCustomer", "updateInvoiceItem", "updatePartnerWebhook", "updateVariantGroup", "updateWebhook", "voidMyStocktakeCount", "voidStocktakeCount", "withdrawInvoiceItem"];
54
54
  /** Warum ein Aufruf keine Wirkung hat, die ein Zeitlimit offen lassen koennte. */
55
55
  export type CallWithoutEffectReason = 'read' | 'repeatable';
56
56
  /**
@@ -157,6 +157,14 @@ exports.ALL_CALLS = [
157
157
  'getRegisterInspectionInfo',
158
158
  // Connect-Bestand (./pos): welche Connect-Version an welchem Kassengeraet laeuft; nur ueber den Kassenweg.
159
159
  'reportConnectState',
160
+ // Kartenterminal am Handy: Geraet, Zugang, TID und Code (nur /v3).
161
+ 'registerTerminalDevice',
162
+ 'getTerminalAccess',
163
+ 'claimTerminal',
164
+ 'requestTerminalCode',
165
+ 'getTerminalCode',
166
+ 'reportTerminalLogin',
167
+ 'reportTerminalReady',
160
168
  ];
161
169
  /**
162
170
  * Die oeffentlichen Endpunkte unter `/v3` (`https://api.kasseneck.at/v3/<name>`),
@@ -287,6 +295,14 @@ exports.PUBLIC_CALLS = [
287
295
  'getDepExportFile',
288
296
  'createDepHandoverLink',
289
297
  'revokeDepHandoverLink',
298
+ // Kartenterminal am Handy (api_key + Geraete-Ausweis), nur unter /v3; am Kassenweg noch nicht.
299
+ 'registerTerminalDevice',
300
+ 'getTerminalAccess',
301
+ 'claimTerminal',
302
+ 'requestTerminalCode',
303
+ 'getTerminalCode',
304
+ 'reportTerminalLogin',
305
+ 'reportTerminalReady',
290
306
  ];
291
307
  /**
292
308
  * Die Endpunkte des Kassenwegs (`https://kasse.kasseneck.at/api/v3/<name>`,
@@ -400,6 +416,8 @@ exports.UNKNOWN_OUTCOME_CALLS = [
400
416
  'deleteWebhook',
401
417
  'extendReservation',
402
418
  'financeWebService',
419
+ // Auf Android verbraucht die Antwort den Code: nach einem Zeitlimit kann er zugestellt und weg sein.
420
+ 'getTerminalCode',
403
421
  'hobexPayApi',
404
422
  'hobexRefundApi',
405
423
  'issueInvoice',
@@ -416,6 +434,7 @@ exports.UNKNOWN_OUTCOME_CALLS = [
416
434
  'recordStockLoss',
417
435
  'recordStocktakeCount',
418
436
  'recountStocktake',
437
+ 'registerTerminalDevice',
419
438
  'releaseReservation',
420
439
  'reportConnectState',
421
440
  'reportCustomerContract',
@@ -474,6 +493,8 @@ exports.UNKNOWN_OUTCOME_CALLS = [
474
493
  exports.CALLS_WITHOUT_EFFECT = Object.freeze({
475
494
  checkPartnerCustomerEmail: 'read',
476
495
  checkVoucher: 'read',
496
+ // Kartenterminal: dieselbe TID noch einmal uebernehmen aendert nichts am Server.
497
+ claimTerminal: 'repeatable',
477
498
  downloadDailyReport: 'read',
478
499
  downloadReceipt: 'read',
479
500
  downloadReport: 'read',
@@ -516,6 +537,8 @@ exports.CALLS_WITHOUT_EFFECT = Object.freeze({
516
537
  getStocktake: 'read',
517
538
  getSignatureCardOrder: 'read',
518
539
  getStocktakePdf: 'read',
540
+ // Behaelt die TID des Geraets bzw. vergibt eine freie; eine Wiederholung liefert dieselbe Zuordnung und bucht nichts.
541
+ getTerminalAccess: 'repeatable',
519
542
  getVariantGroup: 'read',
520
543
  hobexGetStatus: 'read',
521
544
  listArticles: 'read',
@@ -554,7 +577,12 @@ exports.CALLS_WITHOUT_EFFECT = Object.freeze({
554
577
  registerPinLogin: 'repeatable',
555
578
  registerUserLogin: 'repeatable',
556
579
  renewRegisterSession: 'repeatable',
580
+ // Kartenterminal: Anmeldung und Einrichtung melden schreiben denselben Stand noch einmal.
581
+ reportTerminalLogin: 'repeatable',
582
+ reportTerminalReady: 'repeatable',
557
583
  reprintVoucherLabel: 'repeatable',
584
+ // Eine offene Code-Anfrage juenger als 6 Minuten bleibt; eine Wiederholung legt keine neue an.
585
+ requestTerminalCode: 'repeatable',
558
586
  searchCustomers: 'read',
559
587
  });
560
588
  const MIT_WIRKUNG = new Set(exports.UNKNOWN_OUTCOME_CALLS);
@@ -6,6 +6,7 @@ export { type ReceiptCommonOptions, type SellReceiptOptions, type TipOptions, ty
6
6
  export { listMyCashregisters } from './cashregisters.js';
7
7
  export { listReceipts, listAllReceipts, fromListReceiptsSummaryPayload, listedReceiptWithCompany, LIST_RECEIPTS_VIEWS, LIST_RECEIPTS_ORDERS, LIST_RECEIPTS_LIMIT_MAX, LIST_RECEIPTS_DAYS_MAX, LIST_ALL_RECEIPTS_MAX_PAGES, LIST_RECEIPTS_ERROR_CODES, type ListReceiptsErrorCode, type ListReceiptsView, type ListReceiptsOrder, type ListReceiptsOptions, type ListReceiptsWindow, type ListReceiptsGrossByRate, type ListReceiptsSummary, type ListReceiptsDaySummary, type ListReceiptsPage, type ListedReceipt, type ListedFullReceipt, type ListReceiptsHeader, } from './list-receipts.js';
8
8
  export { createDepExport, getDepExport, waitForDepExport, getDepExportFile, createDepHandoverLink, revokeDepHandoverLink, DepExportTimeoutError, DepExportChecksumError, DEP_EXPORT_STATUSES, DEP_EXPORT_FILES, DEP_EXPORT_ERROR_CODES, DEP_EXPORT_FAILURES, DEP_EXPORT_POLL_START_MS, DEP_EXPORT_POLL_FACTOR, DEP_EXPORT_POLL_MAX_MS, DEP_EXPORT_WAIT_TIMEOUT_MS, DEP_EXPORT_DOWNLOAD_TIMEOUT_MS, type DepExportStatus, type DepExportFileKind, type DepExportErrorCode, type DepExportFailure, type CreateDepExportOptions, type CreateDepExportResult, type DepExportGap, type DepExportChainBreak, type DepExportFindings, type DepExportItems, type DepHandoverLinkInfo, type DepExport, type WaitForDepExportOptions, type GetDepExportFileOptions, type DepExportFile, type DepHandoverLink, type RevokedDepHandoverLink, } from './dep-export.js';
9
+ export { registerTerminalDevice, getTerminalAccess, claimTerminal, requestTerminalCode, getTerminalCode, reportTerminalLogin, reportTerminalReady, TERMINAL_PLATFORMS, TERMINAL_SETUP_STATES, TERMINAL_CODE_STATUSES, TERMINAL_CODE_SOURCES, TERMINAL_ERROR_CODES, TERMINAL_LABEL_MAX, TERMINAL_APP_MAX, TERMINAL_REQUESTED_BY_MAX, type TerminalPlatform, type TerminalSetupState, type TerminalCodeStatus, type TerminalCodeSource, type TerminalErrorCode, type TerminalDeviceCredentials, type RegisterTerminalDeviceOptions, type RegisteredTerminalDevice, type GetTerminalAccessOptions, type ClaimTerminalOptions, type RequestTerminalCodeOptions, type ReportTerminalLoginOptions, type TerminalSetup, type TerminalCodeFormat, type TerminalAccess, type TerminalListEntry, type TerminalAccessUnavailable, type TerminalAccessResult, type TerminalCodeRequest, type TerminalCode, } from './terminal.js';
9
10
  export { downloadDailyReport, downloadMonthlyReport, getCashregisterReport, getReportV2, type CashregisterReportPeriod, type ReportV2, type ReportV2Metadata, type ReportV2Options } from './reports.js';
10
11
  export { type CashboxStatus, type SignatureStatus, getCashboxStatus, getSignatureStatus, } from './status.js';
11
12
  export { type KasseneckApi, createKasseneckApi } from './api.js';
@@ -1,7 +1,7 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.LIST_ALL_RECEIPTS_MAX_PAGES = exports.LIST_RECEIPTS_DAYS_MAX = exports.LIST_RECEIPTS_LIMIT_MAX = exports.LIST_RECEIPTS_ORDERS = exports.LIST_RECEIPTS_VIEWS = exports.listedReceiptWithCompany = exports.fromListReceiptsSummaryPayload = exports.listAllReceipts = exports.listReceipts = exports.listMyCashregisters = exports.logReceiptOutputs = 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.createFileOrDataTransport = exports.createPdfOrDataTransport = exports.createBinaryTransport = exports.createTransport = exports.DEFAULT_TIMEOUT_MS = exports.POS_BASE_URL = exports.DEFAULT_BASE_URL = exports.registerUserAuth = exports.apiKeyAuth = void 0;
4
- exports.createKasseneckApi = exports.getSignatureStatus = exports.getCashboxStatus = exports.getReportV2 = exports.getCashregisterReport = exports.downloadMonthlyReport = exports.downloadDailyReport = exports.DEP_EXPORT_DOWNLOAD_TIMEOUT_MS = exports.DEP_EXPORT_WAIT_TIMEOUT_MS = exports.DEP_EXPORT_POLL_MAX_MS = exports.DEP_EXPORT_POLL_FACTOR = exports.DEP_EXPORT_POLL_START_MS = exports.DEP_EXPORT_FAILURES = exports.DEP_EXPORT_ERROR_CODES = exports.DEP_EXPORT_FILES = exports.DEP_EXPORT_STATUSES = exports.DepExportChecksumError = exports.DepExportTimeoutError = exports.revokeDepHandoverLink = exports.createDepHandoverLink = exports.getDepExportFile = exports.waitForDepExport = exports.getDepExport = exports.createDepExport = exports.LIST_RECEIPTS_ERROR_CODES = void 0;
4
+ exports.createKasseneckApi = exports.getSignatureStatus = exports.getCashboxStatus = exports.getReportV2 = exports.getCashregisterReport = exports.downloadMonthlyReport = exports.downloadDailyReport = exports.TERMINAL_REQUESTED_BY_MAX = exports.TERMINAL_APP_MAX = exports.TERMINAL_LABEL_MAX = exports.TERMINAL_ERROR_CODES = exports.TERMINAL_CODE_SOURCES = exports.TERMINAL_CODE_STATUSES = exports.TERMINAL_SETUP_STATES = exports.TERMINAL_PLATFORMS = exports.reportTerminalReady = exports.reportTerminalLogin = exports.getTerminalCode = exports.requestTerminalCode = exports.claimTerminal = exports.getTerminalAccess = exports.registerTerminalDevice = exports.DEP_EXPORT_DOWNLOAD_TIMEOUT_MS = exports.DEP_EXPORT_WAIT_TIMEOUT_MS = exports.DEP_EXPORT_POLL_MAX_MS = exports.DEP_EXPORT_POLL_FACTOR = exports.DEP_EXPORT_POLL_START_MS = exports.DEP_EXPORT_FAILURES = exports.DEP_EXPORT_ERROR_CODES = exports.DEP_EXPORT_FILES = exports.DEP_EXPORT_STATUSES = exports.DepExportChecksumError = exports.DepExportTimeoutError = exports.revokeDepHandoverLink = exports.createDepHandoverLink = exports.getDepExportFile = exports.waitForDepExport = exports.getDepExport = exports.createDepExport = exports.LIST_RECEIPTS_ERROR_CODES = void 0;
5
5
  var auth_js_1 = require("./auth.js");
6
6
  Object.defineProperty(exports, "apiKeyAuth", { enumerable: true, get: function () { return auth_js_1.apiKeyAuth; } });
7
7
  Object.defineProperty(exports, "registerUserAuth", { enumerable: true, get: function () { return auth_js_1.registerUserAuth; } });
@@ -78,6 +78,22 @@ Object.defineProperty(exports, "DEP_EXPORT_POLL_FACTOR", { enumerable: true, get
78
78
  Object.defineProperty(exports, "DEP_EXPORT_POLL_MAX_MS", { enumerable: true, get: function () { return dep_export_js_1.DEP_EXPORT_POLL_MAX_MS; } });
79
79
  Object.defineProperty(exports, "DEP_EXPORT_WAIT_TIMEOUT_MS", { enumerable: true, get: function () { return dep_export_js_1.DEP_EXPORT_WAIT_TIMEOUT_MS; } });
80
80
  Object.defineProperty(exports, "DEP_EXPORT_DOWNLOAD_TIMEOUT_MS", { enumerable: true, get: function () { return dep_export_js_1.DEP_EXPORT_DOWNLOAD_TIMEOUT_MS; } });
81
+ var terminal_js_1 = require("./terminal.js");
82
+ Object.defineProperty(exports, "registerTerminalDevice", { enumerable: true, get: function () { return terminal_js_1.registerTerminalDevice; } });
83
+ Object.defineProperty(exports, "getTerminalAccess", { enumerable: true, get: function () { return terminal_js_1.getTerminalAccess; } });
84
+ Object.defineProperty(exports, "claimTerminal", { enumerable: true, get: function () { return terminal_js_1.claimTerminal; } });
85
+ Object.defineProperty(exports, "requestTerminalCode", { enumerable: true, get: function () { return terminal_js_1.requestTerminalCode; } });
86
+ Object.defineProperty(exports, "getTerminalCode", { enumerable: true, get: function () { return terminal_js_1.getTerminalCode; } });
87
+ Object.defineProperty(exports, "reportTerminalLogin", { enumerable: true, get: function () { return terminal_js_1.reportTerminalLogin; } });
88
+ Object.defineProperty(exports, "reportTerminalReady", { enumerable: true, get: function () { return terminal_js_1.reportTerminalReady; } });
89
+ Object.defineProperty(exports, "TERMINAL_PLATFORMS", { enumerable: true, get: function () { return terminal_js_1.TERMINAL_PLATFORMS; } });
90
+ Object.defineProperty(exports, "TERMINAL_SETUP_STATES", { enumerable: true, get: function () { return terminal_js_1.TERMINAL_SETUP_STATES; } });
91
+ Object.defineProperty(exports, "TERMINAL_CODE_STATUSES", { enumerable: true, get: function () { return terminal_js_1.TERMINAL_CODE_STATUSES; } });
92
+ Object.defineProperty(exports, "TERMINAL_CODE_SOURCES", { enumerable: true, get: function () { return terminal_js_1.TERMINAL_CODE_SOURCES; } });
93
+ Object.defineProperty(exports, "TERMINAL_ERROR_CODES", { enumerable: true, get: function () { return terminal_js_1.TERMINAL_ERROR_CODES; } });
94
+ Object.defineProperty(exports, "TERMINAL_LABEL_MAX", { enumerable: true, get: function () { return terminal_js_1.TERMINAL_LABEL_MAX; } });
95
+ Object.defineProperty(exports, "TERMINAL_APP_MAX", { enumerable: true, get: function () { return terminal_js_1.TERMINAL_APP_MAX; } });
96
+ Object.defineProperty(exports, "TERMINAL_REQUESTED_BY_MAX", { enumerable: true, get: function () { return terminal_js_1.TERMINAL_REQUESTED_BY_MAX; } });
81
97
  var reports_js_1 = require("./reports.js");
82
98
  Object.defineProperty(exports, "downloadDailyReport", { enumerable: true, get: function () { return reports_js_1.downloadDailyReport; } });
83
99
  Object.defineProperty(exports, "downloadMonthlyReport", { enumerable: true, get: function () { return reports_js_1.downloadMonthlyReport; } });
@@ -0,0 +1,206 @@
1
+ import type { InternerTransport } from './aufrufe.js';
2
+ /**
3
+ * Kartenterminal am Handy (nur unter `/v3`): Kasseneck verwaltet die Zugaenge
4
+ * der Terminal-App, die Terminal-IDs (TID) je Betrieb und den Code, den der
5
+ * Anbieter beim Umzug einer TID auf ein anderes Geraet per E-Mail schickt.
6
+ * Die App holt sich Zugang, TID und Code von hier; am Geraet tippt niemand
7
+ * E-Mail, Passwort oder TID.
8
+ *
9
+ * **Anmeldung:** der `api_key` des Betriebs als Bearer. Ein `cashregister-token`
10
+ * (wie ihn `apiKeyAuth` mitsendet) stoert nicht, wird aber nicht gebraucht; eine
11
+ * App ohne Kasse nimmt eine Anmeldung nur mit dem Schluessel (etwa
12
+ * `inventoryKeyAuth` aus `./inventory`). Das Geraet weist sich zusaetzlich mit
13
+ * `deviceId` + `deviceSecret` aus, die es einmal mit [registerTerminalDevice]
14
+ * bekommt. Am Kassenweg gibt es die Aufrufe noch nicht.
15
+ *
16
+ * **Geheimnisse:** `deviceSecret`, `password` und `code` stehen nur in den
17
+ * Antworten bzw. Anfragen. Das Paket schreibt sie in kein Log und in keinen
18
+ * Fehler (das Geraetegeheimnis geht als `secretParams` an den Transport); die
19
+ * App darf sie ebenfalls nie loggen und speichert `deviceSecret` im sicheren
20
+ * Speicher des Geraets.
21
+ *
22
+ * Geprueft wird hier nur die Form; was der Server nicht annimmt, lehnt er mit
23
+ * einem Code aus [TERMINAL_ERROR_CODES] ab.
24
+ */
25
+ /** Plattform des Geraets. */
26
+ export declare const TERMINAL_PLATFORMS: readonly ["android", "ios"];
27
+ export type TerminalPlatform = (typeof TERMINAL_PLATFORMS)[number];
28
+ /**
29
+ * Einrichtungsstand der Terminal-App am Geraet: TID zugewiesen, wartet auf den
30
+ * Code, wird eingerichtet, bereit, fehlgeschlagen.
31
+ */
32
+ export declare const TERMINAL_SETUP_STATES: readonly ["assigned", "waiting_for_code", "setting_up", "ready", "failed"];
33
+ export type TerminalSetupState = (typeof TERMINAL_SETUP_STATES)[number];
34
+ /**
35
+ * Stand einer Code-Anfrage: keine Anfrage, sucht, gefunden, zugestellt,
36
+ * unklar (mehrere Geraete warteten gleichzeitig), kein Code gefunden,
37
+ * abgelaufen.
38
+ */
39
+ export declare const TERMINAL_CODE_STATUSES: readonly ["none", "searching", "found", "delivered", "unclear", "no_code", "expired"];
40
+ export type TerminalCodeStatus = (typeof TERMINAL_CODE_STATUSES)[number];
41
+ /** Woher ein Code kam: aus dem Postfach oder vom Support eingetragen. */
42
+ export declare const TERMINAL_CODE_SOURCES: readonly ["mailbox", "support"];
43
+ export type TerminalCodeSource = (typeof TERMINAL_CODE_SOURCES)[number];
44
+ /**
45
+ * Fehlercodes der sieben Aufrufe (`code` des [KasseneckApiError]) wie im
46
+ * Vertrag des Backends (`errorCodes.terminal` in `fixtures/v3/v3-vokabular.json`),
47
+ * in dessen Reihenfolge; dazu kommen die gemeinsamen Codes von Anmeldung und
48
+ * Rand. Ein Code ausserhalb bleibt ueber `KasseneckApiError.code` lesbar.
49
+ */
50
+ export declare const TERMINAL_ERROR_CODES: readonly ["terminal_not_enabled", "terminal_test_environment", "terminal_device_unknown", "terminal_device_blocked", "invalid_terminal_device", "too_many_terminal_devices", "terminal_not_in_business", "terminal_code_manual", "terminal_code_rate_limited", "terminal_not_assigned", "server_error"];
51
+ export type TerminalErrorCode = (typeof TERMINAL_ERROR_CODES)[number];
52
+ /** Laengen der Texte, die der Server annimmt (nach Abzug von Leerraum am Rand). */
53
+ export declare const TERMINAL_LABEL_MAX = 60;
54
+ export declare const TERMINAL_APP_MAX = 40;
55
+ export declare const TERMINAL_REQUESTED_BY_MAX = 80;
56
+ /** Ausweis des Geraets, aus [registerTerminalDevice]. */
57
+ export interface TerminalDeviceCredentials {
58
+ deviceId: string;
59
+ /** Geheimnis des Geraets: nur im sicheren Speicher ablegen, nie loggen. */
60
+ deviceSecret: string;
61
+ }
62
+ /** Eingabe von [registerTerminalDevice]. */
63
+ export interface RegisterTerminalDeviceOptions {
64
+ /** Anzeige des Geraets, 1 bis 60 Zeichen (etwa Modell und Fahrer). */
65
+ label: string;
66
+ platform: TerminalPlatform;
67
+ /** App und Version, 1 bis 40 Zeichen, z. B. `karteck/1.6.21`. */
68
+ app: string;
69
+ /** Wer das Geraet anmeldet, hoechstens 80 Zeichen; steht im Protokoll. */
70
+ requestedBy?: string;
71
+ }
72
+ /** Antwort von [registerTerminalDevice]. `deviceSecret` kommt nur in dieser Antwort, danach nie wieder. */
73
+ export type RegisteredTerminalDevice = TerminalDeviceCredentials;
74
+ /** Eingabe von [getTerminalAccess]: Ausweis, dazu optional neue Anzeigewerte des Geraets. */
75
+ export interface GetTerminalAccessOptions extends TerminalDeviceCredentials {
76
+ platform?: TerminalPlatform;
77
+ /** App und Version, 1 bis 40 Zeichen. */
78
+ app?: string;
79
+ /** Anzeige des Geraets, 1 bis 60 Zeichen. */
80
+ label?: string;
81
+ }
82
+ /** Eingabe von [claimTerminal]. */
83
+ export interface ClaimTerminalOptions extends TerminalDeviceCredentials {
84
+ /** TID aus `TerminalAccessUnavailable.terminals`. */
85
+ terminalId: string;
86
+ /** Anzeige des Geraets, 1 bis 60 Zeichen. */
87
+ label?: string;
88
+ }
89
+ /** Eingabe von [requestTerminalCode]. */
90
+ export interface RequestTerminalCodeOptions extends TerminalDeviceCredentials {
91
+ platform: TerminalPlatform;
92
+ /** Wer den Code anfragt, hoechstens 80 Zeichen; steht im Protokoll. */
93
+ requestedBy?: string;
94
+ }
95
+ /** Eingabe von [reportTerminalLogin]. */
96
+ export interface ReportTerminalLoginOptions extends TerminalDeviceCredentials {
97
+ /** TID, mit der sich die Terminal-App angemeldet hat. */
98
+ terminalId: string;
99
+ success: boolean;
100
+ /** Erste Anmeldung dieser TID auf diesem Geraet. */
101
+ newOnDevice: boolean;
102
+ }
103
+ /** Einrichtungsstand mit Zeitpunkt (ISO 8601, UTC). Ein spaeter ergaenzter Stand kommt unveraendert an. */
104
+ export interface TerminalSetup {
105
+ state: TerminalSetupState | (string & {});
106
+ since: string | null;
107
+ }
108
+ /** Wie die App einen eingefuegten Code prueft: Laenge und Bezeichnungen vor dem Code in der Mail. */
109
+ export interface TerminalCodeFormat {
110
+ length: number;
111
+ labels: string[];
112
+ }
113
+ /** Zugang fuer die Terminal-App ([getTerminalAccess], [claimTerminal]). */
114
+ export interface TerminalAccess {
115
+ available: true;
116
+ /** Login der Terminal-App. */
117
+ username: string;
118
+ /** Passwort der Terminal-App: nie loggen, nie dauerhaft ausserhalb des sicheren Speichers ablegen. */
119
+ password: string;
120
+ terminalId: string;
121
+ terminalName: string | null;
122
+ accountId: string;
123
+ /** `true`: der Code kommt automatisch ([requestTerminalCode]); sonst fragt die App den Menschen danach. */
124
+ autoCode: boolean;
125
+ codeFormat: TerminalCodeFormat;
126
+ setup: TerminalSetup;
127
+ /** Letzte Aenderung von Konto oder Zuordnung (ISO 8601), `null` unbekannt. */
128
+ updatedAt: string | null;
129
+ }
130
+ /** Eine TID des eigenen Betriebs, die gerade ein anderes Geraet nutzt. */
131
+ export interface TerminalListEntry {
132
+ terminalId: string;
133
+ name: string | null;
134
+ /** Anzeige des Geraets, das sie zuletzt nutzte. */
135
+ lastUsedBy: string | null;
136
+ lastUsedAt: string | null;
137
+ }
138
+ /** Keine TID frei: die TIDs des eigenen Betriebs zur Auswahl fuer [claimTerminal]. */
139
+ export interface TerminalAccessUnavailable {
140
+ available: false;
141
+ reason: 'no_free_terminal' | (string & {});
142
+ terminals: TerminalListEntry[];
143
+ }
144
+ /** Antwort von [getTerminalAccess]: Zugang oder Liste. */
145
+ export type TerminalAccessResult = TerminalAccess | TerminalAccessUnavailable;
146
+ /** Antwort von [requestTerminalCode]. */
147
+ export interface TerminalCodeRequest {
148
+ status: TerminalCodeStatus | (string & {});
149
+ }
150
+ /**
151
+ * Antwort von [getTerminalCode]. `code` (6 Zeichen, Gross-/Kleinschreibung
152
+ * zaehlt) nur bei `found` bzw. auf iOS auch bei `delivered` bis `validUntil`.
153
+ */
154
+ export interface TerminalCode {
155
+ status: TerminalCodeStatus | (string & {});
156
+ /** Der Code: nie loggen. */
157
+ code?: string;
158
+ source?: TerminalCodeSource | (string & {});
159
+ validUntil?: string | null;
160
+ setup: TerminalSetup;
161
+ }
162
+ /**
163
+ * Meldet ein Geraet einmal an (`registerTerminalDevice`) und liefert seinen
164
+ * Ausweis. `deviceSecret` steht nur in dieser Antwort: im sicheren Speicher
165
+ * ablegen, nie loggen. Hoechstens 20 Geraete je Betrieb und 10 Anmeldungen je
166
+ * Tag (`too_many_terminal_devices`). Eine Wiederholung nach unklarem Ausgang
167
+ * legt ein weiteres Geraet an.
168
+ */
169
+ export declare function registerTerminalDevice(transport: InternerTransport, options: RegisterTerminalDeviceOptions): Promise<RegisteredTerminalDevice>;
170
+ /**
171
+ * Zugang und TID fuer dieses Geraet (`getTerminalAccess`). Das Geraet behaelt
172
+ * seine TID; ohne eine bekommt es eine freie seines Betriebs. Ist keine frei,
173
+ * kommt `available: false` mit den TIDs des eigenen Betriebs zur Auswahl fuer
174
+ * [claimTerminal]. Die App ruft das bei jedem Start und mindestens einmal am
175
+ * Tag. `password` nie loggen.
176
+ */
177
+ export declare function getTerminalAccess(transport: InternerTransport, options: GetTerminalAccessOptions): Promise<TerminalAccessResult>;
178
+ /**
179
+ * Uebernimmt eine TID des eigenen Betriebs (`claimTerminal`); das Geraet, das
180
+ * sie bisher nutzte, verliert sie. Antwort wie [getTerminalAccess] mit
181
+ * Zugang. Eine fremde oder unbekannte TID ist `terminal_not_in_business`.
182
+ */
183
+ export declare function claimTerminal(transport: InternerTransport, options: ClaimTerminalOptions): Promise<TerminalAccess>;
184
+ /**
185
+ * Fragt den Code fuer die TID dieses Geraets an (`requestTerminalCode`); nur
186
+ * bei Konten mit Postfach (`TerminalAccess.autoCode`), sonst
187
+ * `terminal_code_manual`. Eine offene Anfrage juenger als 6 Minuten bleibt
188
+ * (doppeltes Tippen schadet nicht); hoechstens 6 Anfragen je Stunde
189
+ * (`terminal_code_rate_limited`). Den Code holt danach [getTerminalCode].
190
+ */
191
+ export declare function requestTerminalCode(transport: InternerTransport, options: RequestTerminalCodeOptions): Promise<TerminalCodeRequest>;
192
+ /**
193
+ * Stand der Code-Anfrage und der Einrichtung (`getTerminalCode`); ohne Anfrage
194
+ * `status: 'none'`. Bei `found` steht der Code genau in dieser Antwort: auf
195
+ * Android wird er dabei verbraucht (eine verlorene Antwort verliert ihn), auf
196
+ * iOS bleibt er bis `validUntil` lesbar. Den Code nie loggen.
197
+ */
198
+ export declare function getTerminalCode(transport: InternerTransport, options: TerminalDeviceCredentials): Promise<TerminalCode>;
199
+ /**
200
+ * Meldet den Ausgang der Anmeldung in der Terminal-App (`reportTerminalLogin`).
201
+ * Antwort: nichts. Eine andere als die zugewiesene TID schreibt der Server
202
+ * nicht.
203
+ */
204
+ export declare function reportTerminalLogin(transport: InternerTransport, options: ReportTerminalLoginOptions): Promise<void>;
205
+ /** Meldet, dass die Terminal-App fertig eingerichtet ist (`reportTerminalReady`). Antwort: nichts. */
206
+ export declare function reportTerminalReady(transport: InternerTransport, options: TerminalDeviceCredentials): Promise<void>;