@design.estate/dees-document 3.1.2 → 3.3.0

package/dist_ts_shared/unitnames.js

@@ -0,0 +1,103 @@
+const EN_unitNames = {
+    locale: "en",
+    names: {
+        // counts
+        C62: { one: "unit", other: "units" },
+        H87: { one: "piece", other: "pieces" },
+        XPP: { one: "piece", other: "pieces" },
+        PR: { one: "pair", other: "pairs" },
+        E48: { one: "service unit", other: "service units" },
+        LS: { one: "lump sum", other: "lump sums" },
+        // time
+        MIN: { one: "minute", other: "minutes" },
+        HUR: { one: "hour", other: "hours" },
+        DAY: { one: "day", other: "days" },
+        WEE: { one: "week", other: "weeks" },
+        MON: { one: "month", other: "months" },
+        ANN: { one: "year", other: "years" },
+        // mass
+        GRM: { one: "gram", other: "grams" },
+        KGM: { one: "kilogram", other: "kilograms" },
+        TNE: { one: "tonne", other: "tonnes" },
+        // length, area, volume
+        MTR: { one: "metre", other: "metres" },
+        KMT: { one: "kilometre", other: "kilometres" },
+        MTK: { one: "square metre", other: "square metres" },
+        MTQ: { one: "cubic metre", other: "cubic metres" },
+        LTR: { one: "litre", other: "litres" },
+        // energy
+        KWH: { one: "kilowatt hour", other: "kilowatt hours" },
+    },
+};
+const DE_unitNames = {
+    locale: "de",
+    names: {
+        // counts
+        C62: { one: "Einheit", other: "Einheiten" },
+        H87: { one: "Stück", other: "Stück" },
+        XPP: { one: "Stück", other: "Stück" },
+        PR: { one: "Paar", other: "Paar" },
+        E48: { one: "Leistungseinheit", other: "Leistungseinheiten" },
+        LS: { one: "Pauschale", other: "Pauschalen" },
+        // time
+        MIN: { one: "Minute", other: "Minuten" },
+        HUR: { one: "Stunde", other: "Stunden" },
+        DAY: { one: "Tag", other: "Tage" },
+        WEE: { one: "Woche", other: "Wochen" },
+        MON: { one: "Monat", other: "Monate" },
+        ANN: { one: "Jahr", other: "Jahre" },
+        // mass
+        GRM: { one: "Gramm", other: "Gramm" },
+        KGM: { one: "Kilogramm", other: "Kilogramm" },
+        TNE: { one: "Tonne", other: "Tonnen" },
+        // length, area, volume
+        MTR: { one: "Meter", other: "Meter" },
+        KMT: { one: "Kilometer", other: "Kilometer" },
+        MTK: { one: "Quadratmeter", other: "Quadratmeter" },
+        MTQ: { one: "Kubikmeter", other: "Kubikmeter" },
+        LTR: { one: "Liter", other: "Liter" },
+        // energy
+        KWH: { one: "Kilowattstunde", other: "Kilowattstunden" },
+    },
+};
+/**
+ * The decimals a quantity carries: those of its shortest representation, the
+ * one `String()` gives, so 12.5 has one and 1.0000001 has seven. NaN and
+ * Infinity have none. Capped at 100, the most `Intl` formats.
+ */
+export const quantityFractionDigits = (quantity) => {
+    const digits = /^(\d+)(?:\.(\d+))?(?:e([+-]\d+))?$/.exec(String(Math.abs(quantity)));
+    if (!digits) {
+        return 0;
+    }
+    return Math.min(100, Math.max(0, (digits[2] ?? "").length - Number(digits[3] ?? 0)));
+};
+/** Unit names by document language code, keyed like `translation.languageCodeMap`. */
+export const unitNameTables = {
+    EN: EN_unitNames,
+    DE: DE_unitNames,
+};
+/**
+ * The unit of a position as the document prints it: the name of a known code in
+ * the document's language, in the singular or plural the quantity asks for, and
+ * anything else as it is. The plural rules see every decimal the quantity
+ * carries, so 1.0001 hours are "hours", not "hour". A language without its own names takes the English
+ * ones, as `translation.translate()` does for every other word.
+ */
+export const unitName = (languageCode, unitType, quantity) => {
+    const table = (languageCode && unitNameTables[languageCode]) || EN_unitNames;
+    const name = Object.hasOwn(table.names, unitType)
+        ? table.names[unitType]
+        : undefined;
+    if (!name) {
+        return unitType;
+    }
+    const fractionDigits = quantityFractionDigits(quantity);
+    return new Intl.PluralRules(table.locale, {
+        minimumFractionDigits: fractionDigits,
+        maximumFractionDigits: fractionDigits,
+    }).select(quantity) === "one"
+        ? name.one
+        : name.other;
+};
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidW5pdG5hbWVzLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vdHNfc2hhcmVkL3VuaXRuYW1lcy50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFnQ0EsTUFBTSxZQUFZLEdBQW1CO0lBQ25DLE1BQU0sRUFBRSxJQUFJO0lBQ1osS0FBSyxFQUFFO1FBQ0wsU0FBUztRQUNULEdBQUcsRUFBRSxFQUFFLEdBQUcsRUFBRSxNQUFNLEVBQUUsS0FBSyxFQUFFLE9BQU8sRUFBRTtRQUNwQyxHQUFHLEVBQUUsRUFBRSxHQUFHLEVBQUUsT0FBTyxFQUFFLEtBQUssRUFBRSxRQUFRLEVBQUU7UUFDdEMsR0FBRyxFQUFFLEVBQUUsR0FBRyxFQUFFLE9BQU8sRUFBRSxLQUFLLEVBQUUsUUFBUSxFQUFFO1FBQ3RDLEVBQUUsRUFBRSxFQUFFLEdBQUcsRUFBRSxNQUFNLEVBQUUsS0FBSyxFQUFFLE9BQU8sRUFBRTtRQUNuQyxHQUFHLEVBQUUsRUFBRSxHQUFHLEVBQUUsY0FBYyxFQUFFLEtBQUssRUFBRSxlQUFlLEVBQUU7UUFDcEQsRUFBRSxFQUFFLEVBQUUsR0FBRyxFQUFFLFVBQVUsRUFBRSxLQUFLLEVBQUUsV0FBVyxFQUFFO1FBQzNDLE9BQU87UUFDUCxHQUFHLEVBQUUsRUFBRSxHQUFHLEVBQUUsUUFBUSxFQUFFLEtBQUssRUFBRSxTQUFTLEVBQUU7UUFDeEMsR0FBRyxFQUFFLEVBQUUsR0FBRyxFQUFFLE1BQU0sRUFBRSxLQUFLLEVBQUUsT0FBTyxFQUFFO1FBQ3BDLEdBQUcsRUFBRSxFQUFFLEdBQUcsRUFBRSxLQUFLLEVBQUUsS0FBSyxFQUFFLE1BQU0sRUFBRTtRQUNsQyxHQUFHLEVBQUUsRUFBRSxHQUFHLEVBQUUsTUFBTSxFQUFFLEtBQUssRUFBRSxPQUFPLEVBQUU7UUFDcEMsR0FBRyxFQUFFLEVBQUUsR0FBRyxFQUFFLE9BQU8sRUFBRSxLQUFLLEVBQUUsUUFBUSxFQUFFO1FBQ3RDLEdBQUcsRUFBRSxFQUFFLEdBQUcsRUFBRSxNQUFNLEVBQUUsS0FBSyxFQUFFLE9BQU8sRUFBRTtRQUNwQyxPQUFPO1FBQ1AsR0FBRyxFQUFFLEVBQUUsR0FBRyxFQUFFLE1BQU0sRUFBRSxLQUFLLEVBQUUsT0FBTyxFQUFFO1FBQ3BDLEdBQUcsRUFBRSxFQUFFLEdBQUcsRUFBRSxVQUFVLEVBQUUsS0FBSyxFQUFFLFdBQVcsRUFBRTtRQUM1QyxHQUFHLEVBQUUsRUFBRSxHQUFHLEVBQUUsT0FBTyxFQUFFLEtBQUssRUFBRSxRQUFRLEVBQUU7UUFDdEMsdUJBQXVCO1FBQ3ZCLEdBQUcsRUFBRSxFQUFFLEdBQUcsRUFBRSxPQUFPLEVBQUUsS0FBSyxFQUFFLFFBQVEsRUFBRTtRQUN0QyxHQUFHLEVBQUUsRUFBRSxHQUFHLEVBQUUsV0FBVyxFQUFFLEtBQUssRUFBRSxZQUFZLEVBQUU7UUFDOUMsR0FBRyxFQUFFLEVBQUUsR0FBRyxFQUFFLGNBQWMsRUFBRSxLQUFLLEVBQUUsZUFBZSxFQUFFO1FBQ3BELEdBQUcsRUFBRSxFQUFFLEdBQUcsRUFBRSxhQUFhLEVBQUUsS0FBSyxFQUFFLGNBQWMsRUFBRTtRQUNsRCxHQUFHLEVBQUUsRUFBRSxHQUFHLEVBQUUsT0FBTyxFQUFFLEtBQUssRUFBRSxRQUFRLEVBQUU7UUFDdEMsU0FBUztRQUNULEdBQUcsRUFBRSxFQUFFLEdBQUcsRUFBRSxlQUFlLEVBQUUsS0FBSyxFQUFFLGdCQUFnQixFQUFFO0tBQ3ZEO0NBQ0YsQ0FBQztBQUVGLE1BQU0sWUFBWSxHQUFtQjtJQUNuQyxNQUFNLEVBQUUsSUFBSTtJQUNaLEtBQUssRUFBRTtRQUNMLFNBQVM7UUFDVCxHQUFHLEVBQUUsRUFBRSxHQUFHLEVBQUUsU0FBUyxFQUFFLEtBQUssRUFBRSxXQUFXLEVBQUU7UUFDM0MsR0FBRyxFQUFFLEVBQUUsR0FBRyxFQUFFLE9BQU8sRUFBRSxLQUFLLEVBQUUsT0FBTyxFQUFFO1FBQ3JDLEdBQUcsRUFBRSxFQUFFLEdBQUcsRUFBRSxPQUFPLEVBQUUsS0FBSyxFQUFFLE9BQU8sRUFBRTtRQUNyQyxFQUFFLEVBQUUsRUFBRSxHQUFHLEVBQUUsTUFBTSxFQUFFLEtBQUssRUFBRSxNQUFNLEVBQUU7UUFDbEMsR0FBRyxFQUFFLEVBQUUsR0FBRyxFQUFFLGtCQUFrQixFQUFFLEtBQUssRUFBRSxvQkFBb0IsRUFBRTtRQUM3RCxFQUFFLEVBQUUsRUFBRSxHQUFHLEVBQUUsV0FBVyxFQUFFLEtBQUssRUFBRSxZQUFZLEVBQUU7UUFDN0MsT0FBTztRQUNQLEdBQUcsRUFBRSxFQUFFLEdBQUcsRUFBRSxRQUFRLEVBQUUsS0FBSyxFQUFFLFNBQVMsRUFBRTtRQUN4QyxHQUFHLEVBQUUsRUFBRSxHQUFHLEVBQUUsUUFBUSxFQUFFLEtBQUssRUFBRSxTQUFTLEVBQUU7UUFDeEMsR0FBRyxFQUFFLEVBQUUsR0FBRyxFQUFFLEtBQUssRUFBRSxLQUFLLEVBQUUsTUFBTSxFQUFFO1FBQ2xDLEdBQUcsRUFBRSxFQUFFLEdBQUcsRUFBRSxPQUFPLEVBQUUsS0FBSyxFQUFFLFFBQVEsRUFBRTtRQUN0QyxHQUFHLEVBQUUsRUFBRSxHQUFHLEVBQUUsT0FBTyxFQUFFLEtBQUssRUFBRSxRQUFRLEVBQUU7UUFDdEMsR0FBRyxFQUFFLEVBQUUsR0FBRyxFQUFFLE1BQU0sRUFBRSxLQUFLLEVBQUUsT0FBTyxFQUFFO1FBQ3BDLE9BQU87UUFDUCxHQUFHLEVBQUUsRUFBRSxHQUFHLEVBQUUsT0FBTyxFQUFFLEtBQUssRUFBRSxPQUFPLEVBQUU7UUFDckMsR0FBRyxFQUFFLEVBQUUsR0FBRyxFQUFFLFdBQVcsRUFBRSxLQUFLLEVBQUUsV0FBVyxFQUFFO1FBQzdDLEdBQUcsRUFBRSxFQUFFLEdBQUcsRUFBRSxPQUFPLEVBQUUsS0FBSyxFQUFFLFFBQVEsRUFBRTtRQUN0Qyx1QkFBdUI7UUFDdkIsR0FBRyxFQUFFLEVBQUUsR0FBRyxFQUFFLE9BQU8sRUFBRSxLQUFLLEVBQUUsT0FBTyxFQUFFO1FBQ3JDLEdBQUcsRUFBRSxFQUFFLEdBQUcsRUFBRSxXQUFXLEVBQUUsS0FBSyxFQUFFLFdBQVcsRUFBRTtRQUM3QyxHQUFHLEVBQUUsRUFBRSxHQUFHLEVBQUUsY0FBYyxFQUFFLEtBQUssRUFBRSxjQUFjLEVBQUU7UUFDbkQsR0FBRyxFQUFFLEVBQUUsR0FBRyxFQUFFLFlBQVksRUFBRSxLQUFLLEVBQUUsWUFBWSxFQUFFO1FBQy9DLEdBQUcsRUFBRSxFQUFFLEdBQUcsRUFBRSxPQUFPLEVBQUUsS0FBSyxFQUFFLE9BQU8sRUFBRTtRQUNyQyxTQUFTO1FBQ1QsR0FBRyxFQUFFLEVBQUUsR0FBRyxFQUFFLGdCQUFnQixFQUFFLEtBQUssRUFBRSxpQkFBaUIsRUFBRTtLQUN6RDtDQUNGLENBQUM7QUFFRjs7OztHQUlHO0FBQ0gsTUFBTSxDQUFDLE1BQU0sc0JBQXNCLEdBQUcsQ0FBQyxRQUFnQixFQUFVLEVBQUU7SUFDakUsTUFBTSxNQUFNLEdBQUcsb0NBQW9DLENBQUMsSUFBSSxDQUN0RCxNQUFNLENBQUMsSUFBSSxDQUFDLEdBQUcsQ0FBQyxRQUFRLENBQUMsQ0FBQyxDQUMzQixDQUFDO0lBQ0YsSUFBSSxDQUFDLE1BQU0sRUFBRSxDQUFDO1FBQ1osT0FBTyxDQUFDLENBQUM7SUFDWCxDQUFDO0lBQ0QsT0FBTyxJQUFJLENBQUMsR0FBRyxDQUNiLEdBQUcsRUFDSCxJQUFJLENBQUMsR0FBRyxDQUFDLENBQUMsRUFBRSxDQUFDLE1BQU0sQ0FBQyxDQUFDLENBQUMsSUFBSSxFQUFFLENBQUMsQ0FBQyxNQUFNLEdBQUcsTUFBTSxDQUFDLE1BQU0sQ0FBQyxDQUFDLENBQUMsSUFBSSxDQUFDLENBQUMsQ0FBQyxDQUMvRCxDQUFDO0FBQ0osQ0FBQyxDQUFDO0FBRUYsc0ZBQXNGO0FBQ3RGLE1BQU0sQ0FBQyxNQUFNLGNBQWMsR0FBbUM7SUFDNUQsRUFBRSxFQUFFLFlBQVk7SUFDaEIsRUFBRSxFQUFFLFlBQVk7Q0FDakIsQ0FBQztBQUVGOzs7Ozs7R0FNRztBQUNILE1BQU0sQ0FBQyxNQUFNLFFBQVEsR0FBRyxDQUN0QixZQUFzQyxFQUN0QyxRQUFnQixFQUNoQixRQUFnQixFQUNSLEVBQUU7SUFDVixNQUFNLEtBQUssR0FDVCxDQUFDLFlBQVksSUFBSSxjQUFjLENBQUMsWUFBWSxDQUFDLENBQUMsSUFBSSxZQUFZLENBQUM7SUFDakUsTUFBTSxJQUFJLEdBQUcsTUFBTSxDQUFDLE1BQU0sQ0FBQyxLQUFLLENBQUMsS0FBSyxFQUFFLFFBQVEsQ0FBQztRQUMvQyxDQUFDLENBQUMsS0FBSyxDQUFDLEtBQUssQ0FBQyxRQUFRLENBQUM7UUFDdkIsQ0FBQyxDQUFDLFNBQVMsQ0FBQztJQUNkLElBQUksQ0FBQyxJQUFJLEVBQUUsQ0FBQztRQUNWLE9BQU8sUUFBUSxDQUFDO0lBQ2xCLENBQUM7SUFDRCxNQUFNLGNBQWMsR0FBRyxzQkFBc0IsQ0FBQyxRQUFRLENBQUMsQ0FBQztJQUN4RCxPQUFPLElBQUksSUFBSSxDQUFDLFdBQVcsQ0FBQyxLQUFLLENBQUMsTUFBTSxFQUFFO1FBQ3hDLHFCQUFxQixFQUFFLGNBQWM7UUFDckMscUJBQXFCLEVBQUUsY0FBYztLQUN0QyxDQUFDLENBQUMsTUFBTSxDQUFDLFFBQVEsQ0FBQyxLQUFLLEtBQUs7UUFDM0IsQ0FBQyxDQUFDLElBQUksQ0FBQyxHQUFHO1FBQ1YsQ0FBQyxDQUFDLElBQUksQ0FBQyxLQUFLLENBQUM7QUFDakIsQ0FBQyxDQUFDIn0=

package/dist_ts_web/00_commitinfo_data.js

@@ -3,7 +3,7 @@
  */
 export const commitinfo = {
     name: '@design.estate/dees-document',
-    version: '3.1.2',
+    version: '3.3.0',
     description: 'A sophisticated framework for dynamically generating and rendering business documents like invoices with modern web technologies, featuring PDF creation, templating, and automation.'
 };
 //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiMDBfY29tbWl0aW5mb19kYXRhLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vdHNfd2ViLzAwX2NvbW1pdGluZm9fZGF0YS50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFBQTs7R0FFRztBQUNILE1BQU0sQ0FBQyxNQUFNLFVBQVUsR0FBRztJQUN4QixJQUFJLEVBQUUsOEJBQThCO0lBQ3BDLE9BQU8sRUFBRSxPQUFPO0lBQ2hCLFdBQVcsRUFBRSx1TEFBdUw7Q0FDck0sQ0FBQSJ9

package/dist_ts_web/elements/contentinvoice.d.ts

@@ -19,6 +19,10 @@ export declare class DeContentInvoice extends DeesElement {
      * gates the number row and the period row of the letterhead.
      */
     private get accountingDoc();
+    /** The payment reminder this content prints, or null. */
+    private get paymentReminder();
+    /** The currency of the letter's amounts: an accounting document's or a reminder's. */
+    private get currency();
     /**
      * The document builds this element for every letter; one that is no
      * accounting document, and one of a type this version does not know, keep
@@ -35,6 +39,18 @@ export declare class DeContentInvoice extends DeesElement {
      * an unknown or missing currency falls back to a plain decimal number.
      */
     protected formatPrice(value: number): string;
+    /**
+     * Formats a quantity in the document's language with every decimal it
+     * carries: 12.5 prints as "12,5" in German and "12.5" in English, and no
+     * stated quantity is rounded. The decimals are those of the shortest
+     * representation of the number, the one `String()` gives, as the unit name
+     * counts them for its singular or plural.
+     */
+    protected formatQuantity(quantityArg: number): string;
+    /** Formats a rate in percent, with as many decimals as it states, up to four. */
+    protected formatPercent(percentArg: number): string;
+    /** Formats a day in the document's language and date style. */
+    protected formatDay(timestampArg: number): string;
     getTotalNet: () => number;
     getTotalGross: () => number;
     getVatGroups: () => {
@@ -58,9 +74,36 @@ export declare class DeContentInvoice extends DeesElement {
      * Apply pre-computed pagination offsets for thumbnail rendering
      */
     private applyOffsetTrimming;
-    /** The due date, which only an accounting document has: it counts from its date. */
+    /**
+     * The due date, which only an accounting document and a payment reminder
+     * have: it counts `dueInDays` from the letter's date.
+     */
     private renderPaymentTerms;
+    /**
+     * The QR pay box. It is printed only when the payment has a valid EPC QR
+     * code: a euro amount to the sender's IBAN, which a document in another
+     * currency or without the sender's IBAN does not have.
+     */
     private renderPaymentInfo;
+    /**
+     * The reverse-charge statement. § 14a UStG requires the words
+     * "Steuerschuldnerschaft des Leistungsempfängers": Abs. 5 for a domestic
+     * supply whose recipient owes the tax under § 13b, Abs. 1 for a supply in
+     * another member state whose recipient owes the tax there, such as a
+     * business-to-business service under Art. 196 of the VAT Directive. They are
+     * printed on every reverse-charge document, and a document in another language adds its own
+     * line, in English "Reverse charge", the words of Art. 226 Nr. 11a of the VAT
+     * Directive (2006/112/EC).
+     */
+    private renderReverseChargeNote;
+    /**
+     * What makes a corrected invoice a correction (§ 31 Abs. 5 UStDV): its
+     * title, the invoice it corrects by number and issue date when the document
+     * states them ("spezifisch und eindeutig", Satz 2), and the details it
+     * supplies or corrects, in words. A received corrected invoice may name
+     * neither; then only the title is printed, and no reference is made up.
+     */
+    private renderCorrection;
     /** The earlier documents a correction answers, by number and, when known, by date. */
     private renderRelatedDocuments;
     /**
@@ -70,6 +113,51 @@ export declare class DeContentInvoice extends DeesElement {
      * paragraph in one piece could be taller than a page and would never fit.
      */
     private renderNotes;
+    /**
+     * The document a reminder claims, as the claims table and the charges name
+     * it: its kind and its number.
+     */
+    private claimLabel;
+    /**
+     * The ground of the claim: every reminded document with its number, its
+     * date, the date it fell due when it stated one, its gross total and what is
+     * still open on it.
+     */
+    private renderReminderClaims;
+    /**
+     * What a charge rests on, as the reminder states it: default interest its
+     * computation (principal, rate a year with the base rate and the surcharge
+     * points of § 288 Abs. 1 or 2 BGB, first and last day), the default lump sum
+     * its provision, and every charge the claim it accrues on. A cost with lump
+     * sums credited against it lists them (§ 288 Abs. 5 Satz 3 BGB); its amount
+     * is already the cost less them.
+     */
+    private renderChargeBasis;
+    /** One row per charge: its description, what it rests on, and its amount. */
+    private renderReminderCharges;
+    /** The sums of a reminder: the open claims, the charges and the total payable, without VAT. */
+    private renderReminderSums;
+    /**
+     * A payment reminder: the issuer's intro or the standard one, the reminded
+     * documents, the charges, the sums, the notes, the new payment deadline and
+     * the QR pay box for the total payable with the reminder's number.
+     */
+    private renderPaymentReminder;
     private renderReferencedContract;
     attachInvoiceDom(): Promise<void>;
+    /**
+     * Sizes the columns of a table to their widest cell. Every row is a grid of
+     * its own, so the rows only line up when a column has one width for all of
+     * them; each page renders every row before it is trimmed, so every page
+     * measures the same widths.
+     *
+     * A column is never narrower than its minimum. The widths the columns ask
+     * for beyond their minimums are granted out of the row's width less its
+     * fixed columns and the minimum of its flexible column (the description),
+     * in equal shares, so the table always fits the page. A cell whose text is
+     * still wider than its column, such as an amount beyond hundreds of
+     * billions, is set in a smaller font, down to 8 px, and wraps inside its
+     * column once that is not enough, so it never runs into its neighbour.
+     */
+    private fitColumns;
 }