@postalsys/email-text-tools 2.4.26 → 2.5.0

package/{lib → dist/esm/lib}/html-guard.js

@@ -1,29 +1,20 @@
-'use strict';
-
-const he = require('he');
-
+import he from 'he';
 // jsdom builds a tree in time quadratic to its depth (10,000 unclosed <b> tags take about 9 s) and
 // its serializer overflows the stack a few thousand levels down; node-html-parser spends cubic time
 // on the elements left open at the end of a document. Deeper input is not parsed at all. Real
 // email nests a few dozen levels.
-const MAX_NESTING_DEPTH = 1000;
-
+export const MAX_NESTING_DEPTH = 1000;
 // Elements that never stay open in HTML content, either void or closed implicitly by a sibling,
 // so they do not add to the depth an HTML parser ends up with. Inside SVG and MathML they can nest,
 // so there every start tag counts.
-const NON_NESTING_TAGS = new Set(
-    'area,base,br,col,embed,hr,img,input,keygen,link,meta,param,source,track,wbr,p,li,dt,dd,td,th,tr,tbody,thead,tfoot,colgroup,caption,option,optgroup,rt,rp'.split(
-        ','
-    )
-);
-
+const NON_NESTING_TAGS = new Set('area,base,br,col,embed,hr,img,input,keygen,link,meta,param,source,track,wbr,p,li,dt,dd,td,th,tr,tbody,thead,tfoot,colgroup,caption,option,optgroup,rt,rp'.split(','));
 // A single linear pass estimating how deep the parsed tree would get. An end tag closes the
 // nearest open element of its name together with everything opened inside it, and one that names
 // no open element is ignored, as an HTML parser ignores it: counting every end tag down instead
 // let "<b></i>" repeated nest as deep as the input allowed, and 10,000 copies took jsdom ten
 // seconds. Otherwise the estimate only ever overestimates (tags inside comments, attribute values
 // and raw text count too), which at worst means an extreme message is shown as plain text.
-function exceedsNestingDepth(html, maxDepth) {
+export function exceedsNestingDepth(html, maxDepth) {
     const tagName = /[a-z][a-z0-9:-]*/iy;
     const stack = [];
     const open = new Map();
@@ -40,7 +31,6 @@ function exceedsNestingDepth(html, maxDepth) {
         }
         // resume right after the first ">", so no tag the parser would see is ever skipped
         pos = tagEnd + 1;
-
         const closing = html.charAt(tagStart + 1) === '/';
         tagName.lastIndex = tagStart + (closing ? 2 : 1);
         const nameMatch = tagName.exec(html);
@@ -49,13 +39,13 @@ function exceedsNestingDepth(html, maxDepth) {
         }
         const name = nameMatch[0].toLowerCase();
         const isForeignRoot = name === 'svg' || name === 'math';
-
         if (closing) {
             if (!open.get(name)) {
                 continue;
             }
             let popped;
             do {
+                // the end tag names an open element, so the stack can not run out before it
                 popped = stack.pop();
                 open.set(popped, open.get(popped) - 1);
                 if (popped === 'svg' || popped === 'math') {
@@ -64,20 +54,16 @@ function exceedsNestingDepth(html, maxDepth) {
             } while (popped !== name);
             continue;
         }
-
         if (!foreign && NON_NESTING_TAGS.has(name)) {
             continue;
         }
-
         // a self-closing flag is ignored on HTML elements, only SVG and MathML honor it
         if ((foreign || isForeignRoot) && html.charAt(tagEnd - 1) === '/') {
             continue;
         }
-
         if (isForeignRoot) {
             foreign++;
         }
-
         stack.push(name);
         open.set(name, (open.get(name) || 0) + 1);
         if (stack.length > maxDepth) {
@@ -86,13 +72,12 @@ function exceedsNestingDepth(html, maxDepth) {
     }
     return false;
 }
-
 // The text of an HTML body for a fallback rendering. The fallback runs when the HTML could not be
 // processed (hostile nesting, a parser or serializer overflow), so it cannot lean on a real HTML
 // parser either: html-to-text gives up on a body nested past its own limit and returned nothing
 // for exactly the input that lands here. One pass over the string: tags become a space, style and
 // script blocks are dropped whole, entities are decoded once
-function fallbackText(html) {
+export function fallbackText(html) {
     const lower = html.toLowerCase();
     const parts = [];
     let pos = 0;
@@ -116,12 +101,11 @@ function fallbackText(html) {
                 break;
             }
             pos = closeEnd + 1;
-        } else {
+        }
+        else {
             pos = gt + 1;
         }
         parts.push(' ');
     }
     return he.decode(parts.join(''));
 }
-
-module.exports = { MAX_NESTING_DEPTH, exceedsNestingDepth, fallbackText };

package/dist/esm/lib/html-to-text.d.ts

@@ -0,0 +1 @@
+export default function htmlToText(html: string): string;

package/{lib → dist/esm/lib}/html-to-text.js

@@ -1,13 +1,10 @@
-'use strict';
-const { compile } = require('html-to-text');
-
+import { compile } from 'html-to-text';
 // Post-process function to clean up excessive newlines
 function cleanupNewlines(text) {
     // Replace 3 or more consecutive newlines with just 2
     // This handles cases where HTML has many nested empty divs
     return text.replace(/\n{3,}/g, '\n\n');
 }
-
 const htmlToTextCompiled = compile({
     wordwrap: 160,
     selectors: [
@@ -17,7 +14,6 @@ const htmlToTextCompiled = compile({
         { selector: 'div', options: { leadingLineBreaks: 1, trailingLineBreaks: 0 } },
         { selector: 'pre', options: { leadingLineBreaks: 1, trailingLineBreaks: 1 } },
         { selector: 'blockquote', options: { leadingLineBreaks: 1, trailingLineBreaks: 1, trimEmptyLines: true } },
-
         // Headers should have spacing
         { selector: 'h1', options: { leadingLineBreaks: 2, trailingLineBreaks: 1, uppercase: false } },
         { selector: 'h2', options: { leadingLineBreaks: 2, trailingLineBreaks: 1, uppercase: false } },
@@ -25,32 +21,24 @@ const htmlToTextCompiled = compile({
         { selector: 'h4', options: { leadingLineBreaks: 2, trailingLineBreaks: 1, uppercase: false } },
         { selector: 'h5', options: { leadingLineBreaks: 2, trailingLineBreaks: 1, uppercase: false } },
         { selector: 'h6', options: { leadingLineBreaks: 2, trailingLineBreaks: 1, uppercase: false } },
-
         // Line breaks
         { selector: 'br', options: { leadingLineBreaks: 1, trailingLineBreaks: 0 } },
         { selector: 'hr', options: { leadingLineBreaks: 1, trailingLineBreaks: 1 } },
-
         // Lists should preserve structure
         { selector: 'ul', options: { leadingLineBreaks: 1, trailingLineBreaks: 1 } },
         { selector: 'ol', options: { leadingLineBreaks: 1, trailingLineBreaks: 1 } },
-
         // Tables
         { selector: 'table', format: 'dataTable' },
-
         // Ignore images
         { selector: 'img', format: 'skip' }
     ],
-    hideLinkHrefIfSameAsText: true,
     // Preserve whitespace better for content
     preserveNewlines: true,
     // The DOM walk is recursive, so hostile nesting would overflow the stack. Content below this
     // depth is dropped; real email nests a few dozen levels.
     limits: { maxDepth: 500, ellipsis: '' }
 });
-
 // Wrapper function that applies post-processing
-function htmlToText(html) {
+export default function htmlToText(html) {
     return cleanupNewlines(htmlToTextCompiled(html));
 }
-
-module.exports = htmlToText;

package/dist/esm/lib/inline-html.d.ts

@@ -0,0 +1,19 @@
+import type { FormatDateOptions } from './format-date.js';
+/** An address of the quoted message */
+export interface MessageAddress {
+    name?: string | undefined;
+    address?: string | undefined;
+}
+/** The message being replied to or forwarded */
+export interface QuotedMessage {
+    from?: MessageAddress | MessageAddress[] | null | undefined;
+    to?: MessageAddress | MessageAddress[] | null | undefined;
+    cc?: MessageAddress | MessageAddress[] | null | undefined;
+    bcc?: MessageAddress | MessageAddress[] | null | undefined;
+    subject?: string | null | undefined;
+    date?: Date | string | number | null | undefined;
+    html?: string | Buffer | null | undefined;
+    text?: string | null | undefined;
+}
+export type InlineAction = 'reply' | 'forward';
+export default function inlineHtml(action: InlineAction | string, messageContent: string | Buffer | null | undefined, messageData: QuotedMessage, options?: FormatDateOptions | null): string;

package/{lib → dist/esm/lib}/inline-html.js

@@ -1,22 +1,17 @@
-'use strict';
-
-const HTMLParser = require('node-html-parser');
-const he = require('he');
-const formatDate = require('./format-date');
-const textToHtml = require('./text-to-html');
-const { MAX_NESTING_DEPTH, exceedsNestingDepth, fallbackText } = require('./html-guard');
-
+import HTMLParser from 'node-html-parser';
+import he from 'he';
+import formatDate from './format-date.js';
+import textToHtml from './text-to-html.js';
+import { MAX_NESTING_DEPTH, exceedsNestingDepth, fallbackText } from './html-guard.js';
 // Escaped text in place of a body that is not worth parsing
 function fallbackBody(html) {
     return `<div style="white-space: pre-wrap;">${he.encode(fallbackText(html), { useNamedReferences: true })}</div>`;
 }
-
-function getHtmlBody(html) {
-    html = ((html && html.toString()) || '').trim();
+function getHtmlBody(input) {
+    const html = ((input && input.toString()) || '').trim();
     if (!html) {
         return '';
     }
-
     // node-html-parser spends cubic time removing the elements left open at the end of a document
     // (16 KB of unclosed <b> tags took ten seconds), so the depth check that guards mimeHtml()
     // refuses the obvious shapes before parsing. The parse option leaves whatever is still open in
@@ -30,38 +25,29 @@ function getHtmlBody(html) {
         const root = HTMLParser.parse(html, { parseNoneClosedTags: true });
         const body = root.querySelector('body') || root.querySelector('html') || root;
         return (body.innerHTML || '').trim();
-    } catch (_err) {
+    }
+    catch (_err) {
         return fallbackBody(html);
     }
 }
-
 function formatAddressHtml(addr) {
     if (!addr || (!addr.name && !addr.address)) {
         return false;
     }
-
     let parts = [];
     if (addr.name) {
         parts.push(he.encode(addr.name, { useNamedReferences: true }));
     }
     if (addr.address) {
-        parts.push(
-            `${he.encode('<', { useNamedReferences: true })}<a href="mailto:${he.encode(addr.address, { useNamedReferences: true })}">${he.encode(
-                addr.address,
-                { useNamedReferences: true }
-            )}</a>${he.encode('>', { useNamedReferences: true })}`
-        );
+        parts.push(`${he.encode('<', { useNamedReferences: true })}<a href="mailto:${he.encode(addr.address, { useNamedReferences: true })}">${he.encode(addr.address, { useNamedReferences: true })}</a>${he.encode('>', { useNamedReferences: true })}`);
     }
-
     return parts.join(' ');
 }
-
-function formatAddressesHtml(addresses) {
-    addresses = [].concat(addresses || []);
+function formatAddressesHtml(input) {
+    const addresses = [].concat(input || []);
     if (!addresses || !addresses.length) {
         return false;
     }
-
     let list = [];
     for (let address of addresses) {
         let entry = formatAddressHtml(address);
@@ -74,29 +60,22 @@ function formatAddressesHtml(addresses) {
     }
     return list.join(', ');
 }
-
-function inlineHtml(action, messageContent, messageData, options) {
+export default function inlineHtml(action, messageContent, messageData, options) {
     options = options || {};
-
     messageContent = (messageContent || '').toString();
-
     let originalBody;
-
     if (messageData.text && !messageData.html) {
         originalBody = textToHtml(messageData.text);
-    } else {
+    }
+    else {
         originalBody = getHtmlBody(messageData.html);
     }
-
     if (!originalBody) {
         return messageContent;
     }
-
     // remove html headers and stuff
     messageContent = getHtmlBody(messageContent);
-
     let headerLines = [];
-
     if (messageData.from) {
         let entry = {
             title: 'From',
@@ -104,7 +83,6 @@ function inlineHtml(action, messageContent, messageData, options) {
         };
         headerLines.push(entry);
     }
-
     if (messageData.subject) {
         let entry = {
             title: 'Subject',
@@ -112,19 +90,15 @@ function inlineHtml(action, messageContent, messageData, options) {
         };
         headerLines.push(entry);
     }
-
     let dateStr = '';
-
     if (messageData.date) {
         dateStr = formatDate(messageData.date, options);
-
         let entry = {
             title: 'Date',
             content: he.encode(dateStr, { useNamedReferences: true })
         };
         headerLines.push(entry);
     }
-
     for (let key of ['to', 'cc', 'bcc']) {
         if (messageData[key]) {
             let content = formatAddressesHtml(messageData[key]);
@@ -137,28 +111,18 @@ function inlineHtml(action, messageContent, messageData, options) {
             }
         }
     }
-
     let headers = [];
-
     switch (action) {
         case 'forward':
             headers.push(`<div>Begin forwarded message:</div><br class="Apple-interchange-newline">`);
-
             for (let line of headerLines) {
-                headers.push(
-                    `<div style="margin-top: 0px; margin-right: 0px; margin-bottom: 0px; margin-left: 0px;"><span style="font-family: -webkit-system-font, Helvetica Neue, Helvetica, sans-serif; color:rgba(0, 0, 0, 1.0);"><b>${line.title}: </b></span><span style="font-family: -webkit-system-font, Helvetica Neue, Helvetica, sans-serif;">${line.content}<br></span></div>`
-                );
+                headers.push(`<div style="margin-top: 0px; margin-right: 0px; margin-bottom: 0px; margin-left: 0px;"><span style="font-family: -webkit-system-font, Helvetica Neue, Helvetica, sans-serif; color:rgba(0, 0, 0, 1.0);"><b>${line.title}: </b></span><span style="font-family: -webkit-system-font, Helvetica Neue, Helvetica, sans-serif;">${line.content}<br></span></div>`);
             }
             break;
         case 'reply':
-            headers.push(
-                `<div>On ${he.encode(dateStr, { useNamedReferences: true })}, ${
-                    formatAddressesHtml(messageData.from) || he.encode('<>', { useNamedReferences: true })
-                } wrote:</div>`
-            );
+            headers.push(`<div>On ${he.encode(dateStr, { useNamedReferences: true })}, ${formatAddressesHtml(messageData.from) || he.encode('<>', { useNamedReferences: true })} wrote:</div>`);
             break;
     }
-
     return `<html>
 
 <head>
@@ -176,5 +140,3 @@ ${headers.join('\n')}<br>
 
 </html>`;
 }
-
-module.exports = inlineHtml;

package/dist/esm/lib/inline-text.d.ts

@@ -0,0 +1,3 @@
+import type { FormatDateOptions } from './format-date.js';
+import type { InlineAction, QuotedMessage } from './inline-html.js';
+export default function inlineText(type: InlineAction | string, messageContent: string | Buffer | null | undefined, messageData: QuotedMessage, options?: FormatDateOptions | null): string;

package/{lib → dist/esm/lib}/inline-text.js

@@ -1,27 +1,20 @@
-'use strict';
-
-const formatDate = require('./format-date');
-const htmlToText = require('./html-to-text');
-
+import formatDate from './format-date.js';
+import htmlToText from './html-to-text.js';
 function formatAddressText(addr) {
     if (!addr || (!addr.name && !addr.address)) {
         return false;
     }
-
     let parts = [];
     if (addr.name) {
         parts.push(addr.name);
     }
-
     if (addr.address) {
         parts.push(`<${addr.address}>`);
     }
-
     return parts.join(' ');
 }
-
-function formatAddressesText(addresses) {
-    addresses = [].concat(addresses || []);
+function formatAddressesText(input) {
+    const addresses = [].concat(input || []);
     if (!addresses || !addresses.length) {
         return false;
     }
@@ -37,29 +30,24 @@ function formatAddressesText(addresses) {
     }
     return list.join(', ');
 }
-
 function escapeText(text) {
     return '> ' + text.replace(/\r?\n/g, '\n> ');
 }
-
-function inlineText(type, messageContent, messageData, options) {
+export default function inlineText(type, messageContent, messageData, options) {
     options = options || {};
-
     messageContent = (messageContent || '').toString();
-
     let originalBody;
     if (!messageData.text && messageData.html) {
+        // passed on as given, a Buffer included
         originalBody = htmlToText(messageData.html);
-    } else {
+    }
+    else {
         originalBody = messageData.text;
     }
-
     if (!originalBody) {
         return messageContent;
     }
-
     let headerLines = [];
-
     if (messageData.from) {
         let entry = {
             title: 'From',
@@ -67,7 +55,6 @@ function inlineText(type, messageContent, messageData, options) {
         };
         headerLines.push(entry);
     }
-
     if (messageData.subject) {
         let entry = {
             title: 'Subject',
@@ -75,19 +62,15 @@ function inlineText(type, messageContent, messageData, options) {
         };
         headerLines.push(entry);
     }
-
     let dateStr = '';
-
     if (messageData.date) {
         dateStr = formatDate(messageData.date, options);
-
         let entry = {
             title: 'Date',
             content: dateStr
         };
         headerLines.push(entry);
     }
-
     for (let key of ['to', 'cc', 'bcc']) {
         if (messageData[key]) {
             let content = formatAddressesText(messageData[key]);
@@ -100,13 +83,10 @@ function inlineText(type, messageContent, messageData, options) {
             }
         }
     }
-
     let headers = [];
-
     switch (type) {
         case 'forward':
             headers.push('Begin forwarded message:\n');
-
             for (let line of headerLines) {
                 headers.push(`${line.title}: ${line.content}`);
             }
@@ -115,12 +95,9 @@ function inlineText(type, messageContent, messageData, options) {
             headers.push(`On ${dateStr}, ${formatAddressesText(messageData.from) || '<>'} wrote:\n`);
             break;
     }
-
     return `${messageContent}
 
 ${escapeText(headers.join('\n'))}
 >
 ${escapeText(originalBody)}`;
 }
-
-module.exports = inlineText;

package/dist/esm/lib/juice-worker.d.ts

@@ -0,0 +1 @@
+export {};

package/{lib → dist/esm/lib}/juice-worker.js

@@ -1,15 +1,14 @@
-'use strict';
-
-const { parentPort } = require('worker_threads');
+import workerThreads from 'node:worker_threads';
 // Pinned to juice 11.x: juice 12+ is pure ESM (requires Node >=22.12) and breaks pkg builds.
-// The `.default` fallback keeps this working if juice ever ships a CJS-compatible build again.
-const juice = require('juice').default || require('juice');
-
-parentPort.on('message', html => {
+import juice from 'juice';
+// Runs as a worker thread (see worker-pool.ts), the parent port is always there
+const parentPort = workerThreads.parentPort;
+parentPort.on('message', (html) => {
     try {
         const result = juice(html);
         parentPort.postMessage({ success: true, result });
-    } catch (error) {
+    }
+    catch (error) {
         parentPort.postMessage({ success: false, error: error.message });
     }
 });

package/dist/esm/lib/mime-html.d.ts

@@ -0,0 +1,34 @@
+import type { WorkerPoolStats } from './worker-pool.js';
+/** The message to render */
+export interface MimeHtmlMessage {
+    html?: string | Buffer | null | undefined;
+    text?: string | Buffer | null | undefined;
+}
+export interface MimeHtmlAsyncOptions {
+    /** How long juice may run in the worker, in milliseconds (default 5000) */
+    timeout?: number | undefined;
+    /** Run juice in the shared worker pool (default) or in a worker of its own */
+    useWorkerPool?: boolean | undefined;
+    /** false rethrows a juice failure or a pipeline error instead of falling back */
+    fallbackOnError?: boolean | undefined;
+    /** Size of the shared worker pool, used when the pool is created */
+    minWorkers?: number | undefined;
+    maxWorkers?: number | undefined;
+    idleTimeout?: number | undefined;
+}
+declare function hasNotWithPseudo(selector: string): boolean;
+declare function filterCss(css: string): string;
+declare function mimeHtmlSync(message: MimeHtmlMessage): string;
+declare function mimeHtmlAsync(message: MimeHtmlMessage, options?: MimeHtmlAsyncOptions): Promise<string>;
+declare function mimeHtml(message: MimeHtmlMessage): string;
+declare namespace mimeHtml {
+    var async: typeof mimeHtmlAsync;
+    var sync: typeof mimeHtmlSync;
+    var _internal: {
+        filterCss: typeof filterCss;
+        hasNotWithPseudo: typeof hasNotWithPseudo;
+    };
+    var closeWorkerPool: () => Promise<void>;
+    var getWorkerPoolStats: () => WorkerPoolStats | null;
+}
+export default mimeHtml;