@kevludwig/lexware-office 0.1.2 → 0.1.4

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, 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, 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, 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, sendReminder, } from "./reminders.js";
+export { DEFAULT_REMINDER_POLICY, daysPastReminderDue, earliestReminderDate, isDueImmediately, isOpenForReminder, reminderDueDate, 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, 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,10 +134,40 @@ 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";
 };
+/**
+ * What a sent payment reminder did, in a fixed shape an app's protocol keeps
+ * as it is. `amount` and `contentSha256` are null only when the effect is
+ * reconstructed after the fact and they are no longer known — never guessed.
+ */
+export interface PaymentReminderEffect {
+    kind: "payment_reminder";
+    to: string;
+    cc: string[];
+    test: boolean;
+    /** The invoice's voucher number. */
+    invoice: string;
+    invoiceId: string;
+    /** The open amount the mail stated. */
+    amount: number | null;
+    currency: string;
+    /** sha256 of the mail's content, see mailContentSha256. */
+    contentSha256: string | null;
+}
+/**
+ * The effect of a reminder sent to `target`. Pass the send's outcome; pass
+ * null to reconstruct it from the target alone, which leaves amount and hash
+ * unknown (null).
+ */
+export declare function paymentReminderEffect(target: ReminderTarget, sent: {
+    openAmount: number;
+    contentSha256: string;
+} | null): PaymentReminderEffect;
 /**
  * Sends one reminder, at most once per round: re-checks that the invoice is
  * still overdue, claims the round, renders and sends with the invoice PDF,
@@ -153,4 +183,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 = {
@@ -121,6 +122,24 @@ export async function selectDueReminders(client, ledger, options = {}) {
         held: checked.flatMap(({ invoice, hold }) => (hold ? [{ invoice, hold }] : [])),
     };
 }
+/**
+ * The effect of a reminder sent to `target`. Pass the send's outcome; pass
+ * null to reconstruct it from the target alone, which leaves amount and hash
+ * unknown (null).
+ */
+export function paymentReminderEffect(target, sent) {
+    return {
+        kind: "payment_reminder",
+        to: target.to,
+        cc: [...(target.cc ?? [])],
+        test: target.test,
+        invoice: target.voucherNumber,
+        invoiceId: target.invoiceId,
+        amount: sent?.openAmount ?? null,
+        currency: target.currency,
+        contentSha256: sent?.contentSha256 ?? null,
+    };
+}
 /**
  * Sends one reminder, at most once per round: re-checks that the invoice is
  * still overdue, claims the round, renders and sends with the invoice PDF,
@@ -171,5 +190,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.2",
+  "version": "0.1.4",
   "description": "Typed client and domain logic for the Lexware Office Public API: contacts, receivables, payment reminder rules.",
   "type": "module",
   "license": "MIT",