@kevludwig/lexware-office 0.1.1 → 0.1.3

package/dist/contacts.d.ts

@@ -19,7 +19,13 @@ export interface Contact {
 export declare function getContact(client: LexwareClient, id: string, signal?: AbortSignal): Promise<Contact>;
 /** The contact with this customer number, or null. */
 export declare function findContactByNumber(client: LexwareClient, customerNumber: number, signal?: AbortSignal): Promise<Contact | null>;
-/** Contacts whose name matches — fuzzy, up to `size` (default 10). */
+/** Lexware searches names from three characters on; shorter ones it refuses with a 400. */
+export declare const MIN_NAME_SEARCH_LENGTH = 3;
+/**
+ * Contacts whose name matches — fuzzy, up to `size` (default 10). A name
+ * shorter than MIN_NAME_SEARCH_LENGTH finds nothing (no request): callers
+ * that must not mistake that for "no match" check the length themselves.
+ */
 export declare function findContactsByName(client: LexwareClient, name: string, options?: {
     customer?: boolean;
     vendor?: boolean;

package/dist/contacts.js

@@ -28,8 +28,16 @@ export async function findContactByNumber(client, customerNumber, signal) {
     const raw = page.content?.[0];
     return raw ? toContact(raw) : null;
 }
-/** Contacts whose name matches — fuzzy, up to `size` (default 10). */
+/** Lexware searches names from three characters on; shorter ones it refuses with a 400. */
+export const MIN_NAME_SEARCH_LENGTH = 3;
+/**
+ * Contacts whose name matches — fuzzy, up to `size` (default 10). A name
+ * shorter than MIN_NAME_SEARCH_LENGTH finds nothing (no request): callers
+ * that must not mistake that for "no match" check the length themselves.
+ */
 export async function findContactsByName(client, name, options = {}) {
+    if (name.trim().length < MIN_NAME_SEARCH_LENGTH)
+        return [];
     const page = await client.request(`/contacts${query({ name, customer: options.customer, vendor: options.vendor, size: options.size ?? 10 })}`, { signal: options.signal });
     return (page.content ?? []).map(toContact);
 }

package/dist/index.d.ts

@@ -1,8 +1,8 @@
 export { DEFAULT_APP_URL, DEFAULT_BASE_URL, LexwareApiError, createLexwareClient, describeError, query, type FileUpload, type LexwareClient, type LexwareClientOptions, } from "./client.ts";
-export { contactEmail, createCustomer, findContactByNumber, findContactsByName, getContact, resolveContactByName, type Contact, type CreatedCustomer, type NewCustomer, } from "./contacts.ts";
+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, sendReminder, type ReminderTarget, type SendReminderOutcome, } from "./reminders.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, sendReminder, 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, netTotal, round2, taxFromGross, taxFromNet, type PricedLine, } from "./money.ts";

package/dist/index.js

@@ -1,8 +1,8 @@
 export { DEFAULT_APP_URL, DEFAULT_BASE_URL, LexwareApiError, createLexwareClient, describeError, query, } from "./client.js";
-export { contactEmail, createCustomer, findContactByNumber, findContactsByName, getContact, resolveContactByName, } from "./contacts.js";
+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, sendReminder, } from "./reminders.js";
+export { DEFAULT_REMINDER_POLICY, daysPastReminderDue, earliestReminderDate, isDueImmediately, isOpenForReminder, reminderDueDate, reminderLedger, selectDueReminders, mailContentSha256, 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, netTotal, round2, taxFromGross, taxFromNet, } from "./money.js";

package/dist/reminders.d.ts

@@ -15,7 +15,7 @@
  */
 import type { LexwareClient } from "./client.ts";
 import { type OverdueInvoice } from "./receivables.ts";
-import { type RenderReminderMail, type SendReminderMail } from "./reminder-mail.ts";
+import { type RenderReminderMail, type ReminderMail, type SendReminderMail } from "./reminder-mail.ts";
 import { type JsonStore } from "./store.ts";
 export interface ReminderPolicy {
     /** Days past the reminder due date before a first reminder. Default: 3. */
@@ -134,6 +134,8 @@ export type SendReminderOutcome = {
     sent: true;
     openAmount: number;
     attachment: string;
+    /** sha256 of subject, text and HTML as sent: proves what went out without keeping the mail. */
+    contentSha256: string;
 } | {
     sent: false;
     reason: "paid" | "taken";
@@ -153,4 +155,10 @@ export declare function sendReminder(client: LexwareClient, ledger: ReminderLedg
     sessionId?: string;
     signal?: AbortSignal;
 }): Promise<SendReminderOutcome>;
+/**
+ * The fingerprint of a mail's content: subject, plain text and HTML, joined
+ * with a separator that cannot occur in them. The same mail always gives the
+ * same hash; a protocol can keep it instead of the mail.
+ */
+export declare function mailContentSha256(mail: Pick<ReminderMail, "subject" | "html" | "text">): string;
 export {};

package/dist/reminders.js

@@ -16,6 +16,7 @@
 import { contactEmail } from "./contacts.js";
 import { addDays, daysSince } from "./dates.js";
 import { downloadInvoicePdf, findOverdueInvoice, findOverdueInvoices } from "./receivables.js";
+import { createHash } from "node:crypto";
 import { MailNotSentError } from "./reminder-mail.js";
 import { keySegment } from "./store.js";
 export const DEFAULT_REMINDER_POLICY = {
@@ -171,5 +172,13 @@ export async function sendReminder(client, ledger, target, options) {
         ...(options.sessionId ? { sessionId: options.sessionId } : {}),
     })
         .catch(() => { });
-    return { sent: true, openAmount: still.openAmount, attachment: mail.attachments[0].filename };
+    return { sent: true, openAmount: still.openAmount, attachment: mail.attachments[0].filename, contentSha256: mailContentSha256(mail) };
+}
+/**
+ * The fingerprint of a mail's content: subject, plain text and HTML, joined
+ * with a separator that cannot occur in them. The same mail always gives the
+ * same hash; a protocol can keep it instead of the mail.
+ */
+export function mailContentSha256(mail) {
+    return createHash("sha256").update([mail.subject, mail.text ?? "", mail.html].join("\u0000")).digest("hex");
 }

package/package.json

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