@kevludwig/lexware-office 0.1.0 → 0.1.1

package/dist/client.d.ts

@@ -21,6 +21,12 @@ export interface LexwareClientOptions {
     minSpacingMs?: number;
     /** Time limit per request in ms, counted from when it actually fires. Default: 20 000. */
     timeoutMs?: number;
+    /**
+     * Time limit for file uploads in ms. A scan of a few MB can take Lexware
+     * longer than a JSON call to accept — an early abort reports a failure for
+     * a file that arrives anyway. Default: 120 000.
+     */
+    uploadTimeoutMs?: number;
     /** Wait before retrying a request answered with 429, in ms. Default: 1 000. */
     rateLimitBackoffMs?: number;
     /** A fetch implementation, e.g. for tests. Default: the global fetch. */

package/dist/client.js

@@ -61,6 +61,7 @@ export function createLexwareClient(options) {
     const appUrl = (options.appUrl ?? DEFAULT_APP_URL).replace(/\/+$/, "");
     const minSpacingMs = options.minSpacingMs ?? 550;
     const timeoutMs = options.timeoutMs ?? 20_000;
+    const uploadTimeoutMs = options.uploadTimeoutMs ?? 120_000;
     const backoffMs = options.rateLimitBackoffMs ?? 1_000;
     const fetchImpl = options.fetch ?? fetch;
     // The queue: each request waits for the previous one to start plus the
@@ -84,10 +85,10 @@ export function createLexwareClient(options) {
      * demonstrably did not run it. A transport error after a POST is never
      * retried: the voucher may well exist already.
      */
-    async function send(path, init) {
+    async function send(path, init, limitMs = timeoutMs) {
         const method = init.method ?? "GET";
         const fire = () => schedule(() => {
-            const timeout = AbortSignal.timeout(timeoutMs);
+            const timeout = AbortSignal.timeout(limitMs);
             return fetchImpl(`${baseUrl}${path}`, {
                 ...init,
                 headers: { Authorization: `Bearer ${options.apiKey}`, Accept: "application/json", ...init.headers },
@@ -134,7 +135,7 @@ export function createLexwareClient(options) {
             // An own ArrayBuffer: Blob refuses shared buffers.
             form.set("file", new Blob([Uint8Array.from(file.bytes)], { type: file.mediaType }), file.filename);
             // No Content-Type: fetch sets the multipart boundary.
-            return json(await send(path, { ...init, method: "POST", body: form }));
+            return json(await send(path, { ...init, method: "POST", body: form }, uploadTimeoutMs));
         },
         voucherUrl(id) {
             return `${appUrl}/vouchers#!/VoucherDetail/${id}`;

package/dist/index.d.ts

@@ -7,5 +7,5 @@ export { MailNotSentError, defaultReminderMail, reminderSubject, type ReminderMa
 export { keySegment, memoryStore, type JsonStore } from "./store.ts";
 export { DUPLICATE_TOTAL_TOLERANCE, ITEMS_TOTAL_TOLERANCE, netTotal, round2, taxFromGross, taxFromNet, type PricedLine, } from "./money.ts";
 export { REVERSE_CHARGE_TAX_RATE, isReverseChargeCategory, listPostingCategories, resolveCategory, type PostingCategory, } from "./categories.ts";
-export { createVoucher, findPurchaseInvoiceByNumber, findVendorCategoryHistory, findVouchers, uploadVoucherFile, type CategoryHistory, type CreateVoucherOptions, type CreatedVoucher, type VoucherItem, type VoucherListEntry, type VoucherListFilter, type VoucherStatus, type VoucherTaxType, type VoucherType, } from "./vouchers.ts";
+export { createVoucher, findPurchaseInvoiceByNumber, findVendorCategoryHistory, findVouchers, uploadVoucherFile, voucherFileIds, type CategoryHistory, type CreateVoucherOptions, type CreatedVoucher, type VoucherItem, type VoucherListEntry, type VoucherListFilter, type VoucherStatus, type VoucherTaxType, type VoucherType, } from "./vouchers.ts";
 export { SALES_DOCUMENT_STATUSES, VOUCHERLIST_TYPE, createSalesDocument, findDuplicateSalesDocument, findRecentSalesDocuments, getSalesDocument, invoiceExists, isPursueRejection, type CreatedSalesDocument, type DuplicateSearchResult, type LineItem, type SalesDocumentDetail, type SalesDocumentKind, type SalesListEntry, } from "./sales-documents.ts";

package/dist/index.js

@@ -7,5 +7,5 @@ export { MailNotSentError, defaultReminderMail, reminderSubject, } from "./remin
 export { keySegment, memoryStore } from "./store.js";
 export { DUPLICATE_TOTAL_TOLERANCE, ITEMS_TOTAL_TOLERANCE, netTotal, round2, taxFromGross, taxFromNet, } from "./money.js";
 export { REVERSE_CHARGE_TAX_RATE, isReverseChargeCategory, listPostingCategories, resolveCategory, } from "./categories.js";
-export { createVoucher, findPurchaseInvoiceByNumber, findVendorCategoryHistory, findVouchers, uploadVoucherFile, } from "./vouchers.js";
+export { createVoucher, findPurchaseInvoiceByNumber, findVendorCategoryHistory, findVouchers, uploadVoucherFile, voucherFileIds, } from "./vouchers.js";
 export { SALES_DOCUMENT_STATUSES, VOUCHERLIST_TYPE, createSalesDocument, findDuplicateSalesDocument, findRecentSalesDocuments, getSalesDocument, invoiceExists, isPursueRejection, } from "./sales-documents.js";

package/dist/vouchers.d.ts

@@ -59,6 +59,12 @@ export declare function createVoucher(client: LexwareClient, options: CreateVouc
 export declare function uploadVoucherFile(client: LexwareClient, voucherId: string, file: FileUpload, signal?: AbortSignal): Promise<{
     id: string;
 }>;
+/**
+ * The ids of the files attached to a voucher. After an upload that ended in
+ * a timeout or a dropped connection this tells whether the file arrived
+ * anyway — Lexware often finishes after the client has given up.
+ */
+export declare function voucherFileIds(client: LexwareClient, voucherId: string, signal?: AbortSignal): Promise<string[]>;
 export interface VoucherListEntry {
     id: string;
     voucherType: string;

package/dist/vouchers.js

@@ -46,6 +46,15 @@ export async function createVoucher(client, options, signal) {
 export async function uploadVoucherFile(client, voucherId, file, signal) {
     return client.upload(`/vouchers/${encodeURIComponent(voucherId)}/files`, file, { signal });
 }
+/**
+ * The ids of the files attached to a voucher. After an upload that ended in
+ * a timeout or a dropped connection this tells whether the file arrived
+ * anyway — Lexware often finishes after the client has given up.
+ */
+export async function voucherFileIds(client, voucherId, signal) {
+    const voucher = await client.request(`/vouchers/${encodeURIComponent(voucherId)}`, { signal });
+    return voucher.files ?? [];
+}
 /** The voucher list — the one search across all voucher types. Newest first, 50 by default. */
 export async function findVouchers(client, filter, signal) {
     const page = await client.request(`/voucherlist${query({ size: 50, sort: "voucherDate,DESC", ...filter })}`, { signal });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kevludwig/lexware-office",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "Typed client and domain logic for the Lexware Office Public API: contacts, receivables, payment reminder rules.",
   "type": "module",
   "license": "MIT",