imapkit 4.0.2 → 4.1.0

package/{lib → dist/esm}/plugins/preview.js

@@ -1,8 +1,5 @@
-'use strict';
-
-const { getMessageData, partsOf } = require('../mimeparser');
-const { isAtom } = require('../arguments');
-
+import { getMessageData, partsOf } from '../mimeparser.js';
+import { isAtom } from '../arguments.js';
 /**
  * @help Adds PREVIEW [RFC8970] capability
  * @help Previews come from the first text/plain or text/html body part,
@@ -14,14 +11,12 @@ const { isAtom } = require('../arguments');
  * Message storage property:
  * - preview: preview text to return instead of a generated one
  */
-module.exports = function (server) {
+export default function previewPlugin(server) {
     server.registerCapability('PREVIEW');
-
     // Generated previews, so PREVIEW (LAZY) knows which ones are available without "undue delay"
     const generated = new WeakMap();
-
     // The preview that is available without generating it: the storage value or an earlier generated one
-    const readyPreview = message => {
+    const readyPreview = (message) => {
         if (typeof message.preview === 'string') {
             // RFC 8970 3.3: the MUST NOT limits apply to the value from storage as well
             return finishPreview(message.preview, MAX_PREVIEW_LENGTH);
@@ -29,7 +24,6 @@ module.exports = function (server) {
         const cached = generated.get(message);
         return cached && cached.source === message.raw ? cached.preview : undefined;
     };
-
     server.fetchHandlers.PREVIEW = function (connection, message, query) {
         let preview = readyPreview(message);
         if (preview === undefined) {
@@ -44,7 +38,6 @@ module.exports = function (server) {
         // RFC 8970 3.3: UTF-8, sent as a literal by the compiler when it holds 8-bit characters
         return Buffer.from(preview, 'utf8').toString('binary');
     };
-
     // RFC 8970 6: fetch-att =/ "PREVIEW" [SP "(" preview-mod *(SP preview-mod) ")"]. The parser returns the
     // modifiers as a list that follows the PREVIEW atom, so fold them into the atom before FETCH sees them
     ['FETCH', 'UID FETCH'].forEach(command => {
@@ -52,24 +45,21 @@ module.exports = function (server) {
         server.setCommandHandler(command, (connection, parsed, data, callback) => {
             try {
                 foldModifiers(parsed);
-            } catch (E) {
+            }
+            catch (E) {
                 connection.sendStatus(parsed, data, 'BAD', E.message, false, 'PREVIEW FAILED');
                 return callback();
             }
             prevHandler(connection, parsed, data, callback);
         });
     });
-};
-
+}
 // RFC 8970 3.3: the server SHOULD limit previews to 200 characters and MUST NOT exceed 256
 const PREVIEW_LENGTH = 200;
 const MAX_PREVIEW_LENGTH = 256;
-
 // Input of preview generation is limited to the start of the part, enough for a 200 character preview
 const MAX_INPUT = 64 * 1024;
-
-const isModifierList = list => Array.isArray(list) && list.length > 0 && list.every(item => isAtom(item, 'LAZY'));
-
+const isModifierList = (list) => Array.isArray(list) && list.length > 0 && list.every(item => isAtom(item, 'LAZY'));
 /**
  * Returns the PREVIEW item with its modifiers. RFC 8970 6: preview-mod = "LAZY", at least one is required
  *
@@ -86,7 +76,6 @@ function withModifiers(item, list) {
     }
     return Object.assign({}, item, { previewLazy: true });
 }
-
 /**
  * Turns `PREVIEW (LAZY)` in the FETCH arguments into a single PREVIEW item with the previewLazy flag
  *
@@ -97,7 +86,6 @@ function foldModifiers(parsed) {
     if (!Array.isArray(attributes)) {
         return;
     }
-
     const items = attributes[1];
     if (Array.isArray(items)) {
         // inside the item list every list that follows PREVIEW is a modifier list
@@ -109,7 +97,6 @@ function foldModifiers(parsed) {
         }
         return;
     }
-
     // A single PREVIEW item may be followed by both its modifiers and the FETCH modifiers of other extensions
     // (RFC 7162 CHANGEDSINCE), so "FETCH 1 PREVIEW (X)" is a preview modifier only if it looks like one or if
     // another list follows
@@ -118,7 +105,6 @@ function foldModifiers(parsed) {
         attributes.splice(2, 1);
     }
 }
-
 /**
  * Generates the preview text of a message (RFC 8970 3.3) from the first text/plain or text/html part
  *
@@ -131,15 +117,12 @@ function generatePreview(tree) {
         // RFC 8970 3.2: the server MUST return an empty string when there is no meaningful preview
         return '';
     }
-
     const text = decodeBody(part);
     if (text === false) {
         return '';
     }
-
     return finishPreview(part.parsedHeader['content-type'].subtype === 'html' ? htmlToText(text) : plainToText(text), PREVIEW_LENGTH);
 }
-
 /**
  * Finds the part to build the preview from. Attachments, attached messages and encrypted content are skipped.
  * In a multipart/alternative a text/plain part is preferred over text/html
@@ -151,18 +134,16 @@ function findTextPart(node) {
     // the parser fills in the RFC 2045 5.2 and RFC 2046 5.1.5 default content types
     const { type, subtype } = node.parsedHeader['content-type'];
     const disposition = node.parsedHeader['content-disposition'];
-
     if (disposition && disposition.type === 'attachment') {
         return false;
     }
-
     if (type === 'multipart') {
         if (subtype === 'encrypted') {
             return false;
         }
         const parts = partsOf(node) || [];
         if (subtype === 'alternative') {
-            const candidates = parts.map(findTextPart).filter(Boolean);
+            const candidates = parts.map(findTextPart).filter((part) => !!part);
             return candidates.find(part => part.parsedHeader['content-type'].subtype === 'plain') || candidates[0] || false;
         }
         for (const part of parts) {
@@ -173,10 +154,8 @@ function findTextPart(node) {
         }
         return false;
     }
-
     return type === 'text' && (subtype === 'plain' || subtype === 'html') ? node : false;
 }
-
 /**
  * Decodes the content transfer encoding and the charset of the start of a part
  *
@@ -187,7 +166,6 @@ function decodeBody(node) {
     const encoding = String(node.parsedHeader['content-transfer-encoding'] || '7bit').toLowerCase();
     const body = node.body;
     let octets;
-
     switch (encoding) {
         case '7bit':
         case '8bit':
@@ -204,23 +182,21 @@ function decodeBody(node) {
         default:
             return false;
     }
-
     const charset = String(node.parsedHeader['content-type'].params.charset || '')
         .trim()
         .toLowerCase();
-
     // Like Dovecot, a missing, US-ASCII or unsupported charset is decoded as UTF-8, invalid octets become U+FFFD
     let decoder;
     if (charset && !['us-ascii', 'ascii'].includes(charset)) {
         try {
             decoder = new TextDecoder(charset);
-        } catch {
+        }
+        catch {
             // unknown charset label
         }
     }
     return (decoder || new TextDecoder('utf-8')).decode(octets);
 }
-
 /**
  * Decodes quoted-printable content (RFC 2045 6.7). Malformed escapes are kept as they are
  *
@@ -232,19 +208,18 @@ function decodeQuotedPrintable(body) {
     // backtrack over long runs of whitespace. Line breaks are CRLF after getMessageData()
     const decoded = body
         .split('\r\n')
-        .map(line => {
-            let end = line.length;
-            while (end > 0 && (line[end - 1] === ' ' || line[end - 1] === '\t')) {
-                end--;
-            }
-            return line.slice(0, end);
-        })
+        .map((line) => {
+        let end = line.length;
+        while (end > 0 && (line[end - 1] === ' ' || line[end - 1] === '\t')) {
+            end--;
+        }
+        return line.slice(0, end);
+    })
         .join('\r\n')
         .replace(/=\r\n/g, '')
         .replace(/=([0-9A-Fa-f]{2})/g, (match, hex) => String.fromCharCode(parseInt(hex, 16)));
     return Buffer.from(decoded, 'binary');
 }
-
 /**
  * Plain text without quoted lines. Like Dovecot, lines that start with ">" are left out unless nothing else is left
  *
@@ -258,7 +233,6 @@ function plainToText(text) {
         .join('\n');
     return unquoted.trim() ? unquoted : text;
 }
-
 // Inline elements are removed without a trace, every other tag separates words like a space
 const INLINE_ELEMENTS = new Set([
     'a',
@@ -292,15 +266,12 @@ const INLINE_ELEMENTS = new Set([
     'var',
     'wbr'
 ]);
-
 // HTML 4 character entity references for U+00A0 to U+00FF, in code point order
-const LATIN1_ENTITIES =
-    'nbsp iexcl cent pound curren yen brvbar sect uml copy ordf laquo not shy reg macr deg plusmn sup2 sup3 acute micro para ' +
+const LATIN1_ENTITIES = 'nbsp iexcl cent pound curren yen brvbar sect uml copy ordf laquo not shy reg macr deg plusmn sup2 sup3 acute micro para ' +
     'middot cedil sup1 ordm raquo frac14 frac12 frac34 iquest Agrave Aacute Acirc Atilde Auml Aring AElig Ccedil Egrave Eacute ' +
     'Ecirc Euml Igrave Iacute Icirc Iuml ETH Ntilde Ograve Oacute Ocirc Otilde Ouml times Oslash Ugrave Uacute Ucirc Uuml Yacute ' +
     'THORN szlig agrave aacute acirc atilde auml aring aelig ccedil egrave eacute ecirc euml igrave iacute icirc iuml eth ntilde ' +
     'ograve oacute ocirc otilde ouml divide oslash ugrave uacute ucirc uuml yacute thorn yuml';
-
 const NAMED_ENTITIES = Object.assign(Object.fromEntries(LATIN1_ENTITIES.split(' ').map((name, i) => [name, String.fromCharCode(0xa0 + i)])), {
     amp: '&',
     lt: '<',
@@ -320,7 +291,6 @@ const NAMED_ENTITIES = Object.assign(Object.fromEntries(LATIN1_ENTITIES.split('
     zwnj: '\u200c',
     zwj: '\u200d'
 });
-
 /**
  * Converts HTML into plain text: markup, comments and non-rendered elements (head, script, style) are removed,
  * character references are decoded. Like quoted lines of plain text, blockquote elements are left out unless
@@ -331,11 +301,9 @@ const NAMED_ENTITIES = Object.assign(Object.fromEntries(LATIN1_ENTITIES.split('
  */
 function htmlToText(html) {
     html = html.replace(/<!--[\s\S]*?(?:-->|$)/g, ' ').replace(/<(head|script|style|title|template)\b[^<>]*>[\s\S]*?(?:<\/\1\s*>|$)/gi, ' ');
-
     const text = markupToText(removeBlockquotes(html));
     return text.trim() ? text : markupToText(html);
 }
-
 /**
  * Removes blockquote elements, nested ones included, in a single pass
  *
@@ -357,7 +325,6 @@ function removeBlockquotes(html) {
     }
     return depth ? output : output + html.slice(pos);
 }
-
 /**
  * Removes tags and decodes character references
  *
@@ -367,19 +334,16 @@ function removeBlockquotes(html) {
 function markupToText(html) {
     return html
         .replace(/<!\[CDATA\[([\s\S]*?)(?:\]\]>|$)/g, '$1')
-        .replace(/<\/?([A-Za-z][A-Za-z0-9-]*)(?![A-Za-z0-9-])[^<>]*>|<[!?][^<>]*>/g, (match, name) =>
-            name && INLINE_ELEMENTS.has(name.toLowerCase()) ? '' : ' '
-        )
+        .replace(/<\/?([A-Za-z][A-Za-z0-9-]*)(?![A-Za-z0-9-])[^<>]*>|<[!?][^<>]*>/g, (match, name) => name && INLINE_ELEMENTS.has(name.toLowerCase()) ? '' : ' ')
         .replace(/&(#[0-9]+|#[xX][0-9A-Fa-f]+|[A-Za-z][A-Za-z0-9]*);/g, (match, ref) => {
-            if (ref[0] === '#') {
-                const code = /^#x/i.test(ref) ? parseInt(ref.slice(2), 16) : parseInt(ref.slice(1), 10);
-                // NUL, surrogates and values outside Unicode are not characters
-                return code > 0 && code <= 0x10ffff && (code < 0xd800 || code > 0xdfff) ? String.fromCodePoint(code) : '\ufffd';
-            }
-            return Object.hasOwn(NAMED_ENTITIES, ref) ? NAMED_ENTITIES[ref] : match;
-        });
+        if (ref[0] === '#') {
+            const code = /^#x/i.test(ref) ? parseInt(ref.slice(2), 16) : parseInt(ref.slice(1), 10);
+            // NUL, surrogates and values outside Unicode are not characters
+            return code > 0 && code <= 0x10ffff && (code < 0xd800 || code > 0xdfff) ? String.fromCodePoint(code) : '\ufffd';
+        }
+        return Object.hasOwn(NAMED_ENTITIES, ref) ? NAMED_ENTITIES[ref] : match;
+    });
 }
-
 /**
  * Normalizes preview text: control characters are removed, whitespace runs become a single space (so there are no
  * CR or LF characters) and the text is cut to at most `length` characters (code points, RFC 8970 3.3)
@@ -395,6 +359,4 @@ function finishPreview(text, length) {
         .trim();
     return Array.from(normalized).slice(0, length).join('').trimEnd();
 }
-
-module.exports.generatePreview = generatePreview;
-module.exports.finishPreview = finishPreview;
+export { generatePreview, finishPreview };

package/dist/esm/plugins/qresync.d.ts

@@ -0,0 +1,11 @@
+/**
+ * @help Adds QRESYNC [RFC7162] capability, loads CONDSTORE and ENABLE as well
+ * @help After ENABLE QRESYNC: SELECT/EXAMINE (QRESYNC (...)), UID FETCH (CHANGEDSINCE n VANISHED),
+ * @help and VANISHED responses instead of EXPUNGE
+ */
+import type { IMAPServer } from '../types.js';
+declare function qresyncPlugin(server: IMAPServer): void;
+declare namespace qresyncPlugin {
+    var requires: string[];
+}
+export default qresyncPlugin;