@kevludwig/lexware-office 0.4.0 → 0.4.2

package/README.md

@@ -90,7 +90,7 @@ The ledger needs somewhere to keep one small JSON record per invoice. `JsonStore
 
 ## Tests
 
-`npm test` runs 38 tests against a fake API — no account, no network. `test/fake-api.ts` shows the pattern: routes answer by method and path, and every call is recorded.
+`npm test` runs 59 tests against a fake API — no account, no network. `test/fake-api.ts` shows the pattern: routes answer by method and path, and every call is recorded.
 
 ## Not affiliated with Lexware
 

package/dist/client.js

@@ -55,6 +55,24 @@ export function query(params) {
     return rendered ? `?${rendered}` : "";
 }
 const sleep = (ms) => new Promise((resolve) => setTimeout(resolve, ms));
+/** Waits `ms`, or rejects with the signal's reason as soon as it aborts. */
+function abortableSleep(ms, signal) {
+    if (!signal)
+        return sleep(ms).then(() => undefined);
+    if (signal.aborted)
+        return Promise.reject(signal.reason);
+    return new Promise((resolve, reject) => {
+        const onAbort = () => {
+            clearTimeout(timer);
+            reject(signal.reason);
+        };
+        const timer = setTimeout(() => {
+            signal.removeEventListener("abort", onAbort);
+            resolve();
+        }, ms);
+        signal.addEventListener("abort", onAbort, { once: true });
+    });
+}
 /** The server's Retry-After in ms (seconds or an HTTP date), capped at 10 s; null without one. */
 function retryAfterMs(response) {
     const header = response.headers.get("retry-after")?.trim();
@@ -109,7 +127,8 @@ export function createLexwareClient(options) {
         let response = await fire();
         for (let attempt = 1; response.status === 429 && attempt <= retries; attempt++) {
             await response.body?.cancel().catch(() => undefined);
-            await sleep(retryAfterMs(response) ?? backoffMs * attempt);
+            // The caller's cancellation also ends the wait between retries.
+            await abortableSleep(retryAfterMs(response) ?? backoffMs * attempt, init.signal);
             response = await fire();
         }
         if (!response.ok) {

package/dist/contacts.d.ts

@@ -1,8 +1,8 @@
 /**
  * Contacts — customers and vendors alike.
  *
- * Search is fuzzy on the API side: "Nordlicht" finds "Nordlicht Consulting
- * GmbH", "Müller" may find three. Functions here return candidates and leave
+ * Search is fuzzy on the API side: "Beispiel" finds "Beispiel GmbH",
+ * "Müller" may find three. Functions here return candidates and leave
  * the choice to the caller; guessing one of several is the worse mistake.
  */
 import { type LexwareClient } from "./client.ts";

package/dist/contacts.js

@@ -1,8 +1,8 @@
 /**
  * Contacts — customers and vendors alike.
  *
- * Search is fuzzy on the API side: "Nordlicht" finds "Nordlicht Consulting
- * GmbH", "Müller" may find three. Functions here return candidates and leave
+ * Search is fuzzy on the API side: "Beispiel" finds "Beispiel GmbH",
+ * "Müller" may find three. Functions here return candidates and leave
  * the choice to the caller; guessing one of several is the worse mistake.
  */
 import { query } from "./client.js";

package/dist/index.d.ts

@@ -2,7 +2,7 @@ export { DEFAULT_APP_URL, DEFAULT_BASE_URL, LexwareApiError, createLexwareClient
 export { contactEmail, createCustomer, findContactByNumber, findContactsByName, MIN_NAME_SEARCH_LENGTH, getContact, resolveContactByName, type Contact, type CreatedCustomer, type NewCustomer, } from "./contacts.ts";
 export { addDays, berlinDay, daysSince } from "./dates.ts";
 export { downloadInvoicePdf, findOverdueInvoice, findOverdueInvoices, type OverdueInvoice, } from "./receivables.ts";
-export { DEFAULT_REMINDER_POLICY, daysPastReminderDue, earliestReminderDate, isDueImmediately, isOpenForReminder, reminderDueDate, reminderLedger, selectDueReminders, type DueReminder, type ReminderHold, type ReminderLedger, type ReminderPolicy, type ReminderRecord, type ReminderSelection, type ReminderStatus, mailContentSha256, paymentReminderEffect, sendReminder, type PaymentReminderEffect, type ReminderTarget, type SendReminderOutcome, } from "./reminders.ts";
+export { DEFAULT_REMINDER_POLICY, daysPastReminderDue, earliestReminderDate, isDueImmediately, isOpenForReminder, reminderDueDate, nextPaymentDay, germanNationwideHolidays, germanPaymentDay, reminderLedger, selectDueReminders, type DueReminder, type ReminderHold, type ReminderLedger, type ReminderPolicy, type ReminderRecord, type ReminderSelection, type ReminderStatus, mailContentSha256, paymentReminderEffect, sendReminder, type PaymentReminderEffect, type ReminderTarget, type SendReminderOutcome, } from "./reminders.ts";
 export { MailNotSentError, defaultReminderMail, reminderSubject, type ReminderMail, type ReminderMailData, type ReminderSender, type RenderReminderMail, type SendReminderMail, } from "./reminder-mail.ts";
 export { keySegment, memoryStore, type JsonStore } from "./store.ts";
 export { DUPLICATE_TOTAL_TOLERANCE, ITEMS_TOTAL_TOLERANCE, lineNet, netTotal, round2, taxFromGross, taxFromNet, type PricedLine, } from "./money.ts";

package/dist/index.js

@@ -2,7 +2,7 @@ export { DEFAULT_APP_URL, DEFAULT_BASE_URL, LexwareApiError, createLexwareClient
 export { contactEmail, createCustomer, findContactByNumber, findContactsByName, MIN_NAME_SEARCH_LENGTH, getContact, resolveContactByName, } from "./contacts.js";
 export { addDays, berlinDay, daysSince } from "./dates.js";
 export { downloadInvoicePdf, findOverdueInvoice, findOverdueInvoices, } from "./receivables.js";
-export { DEFAULT_REMINDER_POLICY, daysPastReminderDue, earliestReminderDate, isDueImmediately, isOpenForReminder, reminderDueDate, reminderLedger, selectDueReminders, mailContentSha256, paymentReminderEffect, sendReminder, } from "./reminders.js";
+export { DEFAULT_REMINDER_POLICY, daysPastReminderDue, earliestReminderDate, isDueImmediately, isOpenForReminder, reminderDueDate, nextPaymentDay, germanNationwideHolidays, germanPaymentDay, reminderLedger, selectDueReminders, mailContentSha256, paymentReminderEffect, sendReminder, } from "./reminders.js";
 export { MailNotSentError, defaultReminderMail, reminderSubject, } from "./reminder-mail.js";
 export { keySegment, memoryStore } from "./store.js";
 export { DUPLICATE_TOTAL_TOLERANCE, ITEMS_TOTAL_TOLERANCE, lineNet, netTotal, round2, taxFromGross, taxFromNet, } from "./money.js";

package/dist/reminders.d.ts

@@ -26,7 +26,20 @@ export interface ReminderPolicy {
     pendingValidHours: number;
     /** A declined reminder stays quiet this many days. Default: 7. */
     declinedQuietDays: number;
+    /**
+     * Whether a day (yyyy-MM-dd) counts as a day by which money can arrive.
+     * Set, a due date on another day moves to the next one that does — as § 193
+     * BGB moves a deadline off weekends and holidays. Not set: due dates count
+     * as they are. `germanPaymentDay` covers weekends and nationwide holidays.
+     */
+    isPaymentDay?: (day: string) => boolean;
 }
+/** The day itself, or the next one `isPaymentDay` accepts (at most two weeks on). */
+export declare function nextPaymentDay(day: string, isPaymentDay?: (day: string) => boolean): string;
+/** Germany's nationwide public holidays of a year (yyyy-MM-dd). Regional ones are left to the caller. */
+export declare function germanNationwideHolidays(year: number): string[];
+/** A weekday that is no nationwide public holiday in Germany — when banks book. */
+export declare function germanPaymentDay(day: string): boolean;
 export declare const DEFAULT_REMINDER_POLICY: ReminderPolicy;
 interface Dated {
     voucherDate: string;

package/dist/reminders.js

@@ -19,6 +19,56 @@ import { downloadInvoicePdf, findOverdueInvoice, findOverdueInvoices } from "./r
 import { createHash } from "node:crypto";
 import { MailNotSentError } from "./reminder-mail.js";
 import { keySegment } from "./store.js";
+/** The day itself, or the next one `isPaymentDay` accepts (at most two weeks on). */
+export function nextPaymentDay(day, isPaymentDay) {
+    if (!isPaymentDay)
+        return day;
+    let current = day;
+    for (let step = 0; step < 14 && !isPaymentDay(current); step++)
+        current = addDays(current, 1);
+    return current;
+}
+/** Easter Sunday of a year (Gregorian, anonymous algorithm), yyyy-MM-dd. */
+function easterSunday(year) {
+    const a = year % 19;
+    const b = Math.floor(year / 100);
+    const c = year % 100;
+    const d = Math.floor(b / 4);
+    const e = b % 4;
+    const f = Math.floor((b + 8) / 25);
+    const g = Math.floor((b - f + 1) / 3);
+    const h = (19 * a + b - d - g + 15) % 30;
+    const i = Math.floor(c / 4);
+    const k = c % 4;
+    const l = (32 + 2 * e + 2 * i - h - k) % 7;
+    const m = Math.floor((a + 11 * h + 22 * l) / 451);
+    const month = Math.floor((h + l - 7 * m + 114) / 31);
+    const dayOfMonth = ((h + l - 7 * m + 114) % 31) + 1;
+    return `${year}-${String(month).padStart(2, "0")}-${String(dayOfMonth).padStart(2, "0")}`;
+}
+/** Germany's nationwide public holidays of a year (yyyy-MM-dd). Regional ones are left to the caller. */
+export function germanNationwideHolidays(year) {
+    const easter = easterSunday(year);
+    return [
+        `${year}-01-01`,
+        addDays(easter, -2),
+        addDays(easter, 1),
+        `${year}-05-01`,
+        addDays(easter, 39),
+        addDays(easter, 50),
+        `${year}-10-03`,
+        `${year}-12-25`,
+        `${year}-12-26`,
+    ];
+}
+/** A weekday that is no nationwide public holiday in Germany — when banks book. */
+export function germanPaymentDay(day) {
+    const date = new Date(`${day.slice(0, 10)}T00:00:00Z`);
+    const weekday = date.getUTCDay();
+    if (weekday === 0 || weekday === 6)
+        return false;
+    return !germanNationwideHolidays(date.getUTCFullYear()).includes(day.slice(0, 10));
+}
 export const DEFAULT_REMINDER_POLICY = {
     minDaysOverdue: 3,
     immediatePaymentTermDays: 14,
@@ -31,9 +81,10 @@ export function isDueImmediately(invoice) {
 }
 /** The day from which lateness counts (yyyy-MM-dd). */
 export function reminderDueDate(invoice, policy = DEFAULT_REMINDER_POLICY) {
-    return isDueImmediately(invoice)
+    const due = isDueImmediately(invoice)
         ? addDays(invoice.voucherDate, policy.immediatePaymentTermDays)
         : invoice.dueDate.slice(0, 10);
+    return nextPaymentDay(due, policy.isPaymentDay);
 }
 /** Days past the reminder due date. */
 export function daysPastReminderDue(invoice, policy = DEFAULT_REMINDER_POLICY, today) {

package/package.json

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