imapkit 4.0.3 → 4.1.0

package/dist/esm/mock-client.d.ts

@@ -0,0 +1,39 @@
+/**
+ * @namespace Mockup module
+ * @name mockup
+ */
+export default runClientMockup;
+/**
+ * <p>Runs a batch of IMAP commands against a server, like a well behaved client would</p>
+ *
+ * <ul>
+ * <li>a command is sent only after the tagged response of the previous command arrived
+ *     (RFC 3501 section 5.5 forbids pipelining in many cases)</li>
+ * <li>the data of a synchronizing literal ({n}) is sent only after the server's "+"
+ *     continuation request (RFC 3501 section 4.3)</li>
+ * <li>when the server sends a "+" continuation request and the command has no literal
+ *     data left, the next entry of the command list is sent as the continuation data
+ *     (an AUTHENTICATE response, or DONE to end IDLE)</li>
+ * <li>after the tagged response of a STARTTLS command the connection is upgraded to TLS</li>
+ * <li>after the tagged OK of a COMPRESS DEFLATE command, data in both directions is compressed
+ *     (RFC 4978). The client ends its compression after an UNAUTHENTICATE command, and expects
+ *     the server to end its compression after the tagged OK (RFC 8437 section 4.1)</li>
+ * <li>the callback gets the decompressed data</li>
+ * <li>after the last command the connection is closed and the callback gets the transcript</li>
+ * </ul>
+ *
+ * <pre>
+ * var cmds = ["A1 CAPABILITY", "A2 STARTTLS", "A3 LOGIN username password", "A4 LOGOUT"];
+ * runClientMockup(143, "localhost", cmds, false, function(resp){
+ *     console.log("Final:", resp.toString("utf-8").trim());
+ * });
+ * </pre>
+ *
+ * @memberOf mockup
+ * @param {Number} port Port number
+ * @param {String} host Hostname to connect to
+ * @param {Array} commands Command list to be sent to server, as binary strings
+ * @param {Boolean} [debug] if set to true log all input/output
+ * @param {Function} callback Callback function to run on completion, gets everything the server sent as a Buffer
+ */
+declare function runClientMockup(port: number | null | undefined, host: string | null | undefined, commands: string[], debug?: boolean | null, callback?: ((response: Buffer) => void) | null): void;

package/{lib → dist/esm}/mock-client.js

@@ -1,16 +1,12 @@
-'use strict';
-
-const net = require('net');
-const tls = require('tls');
-const { splitResponses, splitAtLiterals } = require('./framing');
-const DeflateLayer = require('./deflate-layer');
-
+import net from 'node:net';
+import tls from 'node:tls';
+import { splitResponses, splitAtLiterals } from './framing.js';
+import DeflateLayer from './deflate-layer.js';
 /**
  * @namespace Mockup module
  * @name mockup
  */
-module.exports = runClientMockup;
-
+export default runClientMockup;
 /**
  * <p>Runs a batch of IMAP commands against a server, like a well behaved client would</p>
  *
@@ -45,10 +41,9 @@ module.exports = runClientMockup;
  * @param {Function} callback Callback function to run on completion, gets everything the server sent as a Buffer
  */
 function runClientMockup(port, host, commands, debug, callback) {
-    host = host || 'localhost';
-    port = port || 143;
+    const hostname = host || 'localhost';
+    const portNumber = port || 143;
     const queue = Array.isArray(commands) ? splitLiterals(commands) : [];
-
     const responses = [];
     let buffer = '';
     // tag of the command waiting for its tagged response
@@ -57,26 +52,23 @@ function runClientMockup(port, host, commands, debug, callback) {
     let lastResponse = '';
     let greeted = false;
     let finished = false;
-
-    let socket = net.connect(port, host);
+    let socket = net.connect(portNumber, hostname);
     // COMPRESS=DEFLATE layer, once the server accepted COMPRESS
     let layer = null;
-
     const log = (prefix, str) => {
         if (debug) {
             console.log(prefix + ' ' + str.replace(/\r?\n$/, ''));
         }
     };
-
-    const write = text => {
+    const write = (text) => {
         log('C:', text);
         if (layer) {
             layer.write(Buffer.from(text, 'binary'));
-        } else {
+        }
+        else {
             socket.write(text, 'binary');
         }
     };
-
     const finish = () => {
         if (finished) {
             return;
@@ -93,7 +85,6 @@ function runClientMockup(port, host, commands, debug, callback) {
             callback(Buffer.concat(responses));
         }
     };
-
     const sendNext = () => {
         // literal data that the previous command did not get to send is dropped
         while (queue.length && queue[0].continuation) {
@@ -113,7 +104,6 @@ function runClientMockup(port, host, commands, debug, callback) {
             layer.end();
         }
     };
-
     // literal data for the current command, or a continuation line such as DONE
     const onContinuation = () => {
         if (!queue.length) {
@@ -121,30 +111,27 @@ function runClientMockup(port, host, commands, debug, callback) {
         }
         write(queue.shift().text);
     };
-
     const upgrade = () => {
         const plain = socket;
         plain.removeAllListeners('data');
         plain.removeAllListeners('close');
-        socket = tls.connect({ socket: plain, host, rejectUnauthorized: false }, () => {
+        socket = tls.connect({ socket: plain, host: hostname, rejectUnauthorized: false }, () => {
             log('TLS', 'connection secured');
             sendNext();
         });
         attach(socket);
     };
-
     // everything after the CRLF of the tagged OK is compressed (RFC 4978 section 3)
     const startCompression = () => {
         layer = new DeflateLayer({
-            writeRaw: chunk => socket.write(chunk),
+            writeRaw: (chunk) => socket.write(chunk),
             onData: onData,
-            onError: err => {
+            onError: (err) => {
                 log('Compression error:', err.message);
                 socket.destroy();
             }
         });
     };
-
     // returns true if compression starts after this response
     const onTagged = () => {
         let compress = false;
@@ -156,7 +143,8 @@ function runClientMockup(port, host, commands, debug, callback) {
             if (/^\S+ COMPRESS DEFLATE$/i.test(currentCommand)) {
                 startCompression();
                 compress = true;
-            } else if (layer && /^\S+ UNAUTHENTICATE$/i.test(currentCommand)) {
+            }
+            else if (layer && /^\S+ UNAUTHENTICATE$/i.test(currentCommand)) {
                 // the server ends its compression after the CRLF of the OK
                 layer.endInput();
             }
@@ -164,24 +152,25 @@ function runClientMockup(port, host, commands, debug, callback) {
         sendNext();
         return compress;
     };
-
     // Splits the received data into complete responses, a response may contain literals
     const processBuffer = () => {
         const framed = splitResponses(buffer);
         for (const response of framed.responses) {
             lastResponse = buffer.slice(response.start, response.end);
             responses.push(Buffer.from(lastResponse, 'binary'));
-
             if (!greeted) {
                 greeted = true;
                 sendNext();
-            } else if (lastResponse.charAt(0) === '+') {
+            }
+            else if (lastResponse.charAt(0) === '+') {
                 onContinuation();
-            } else if (currentTag && lastResponse.substr(0, currentTag.length + 1) === currentTag + ' ' && onTagged()) {
+            }
+            else if (currentTag && lastResponse.substr(0, currentTag.length + 1) === currentTag + ' ' && onTagged()) {
                 // compression started, the rest of the data is compressed
                 const rest = buffer.slice(response.end);
                 buffer = '';
                 if (rest) {
+                    // onTagged() started the compression
                     layer.receive(Buffer.from(rest, 'binary'));
                 }
                 return;
@@ -189,32 +178,29 @@ function runClientMockup(port, host, commands, debug, callback) {
         }
         buffer = buffer.slice(framed.end);
     };
-
     function onData(chunk) {
         log('S:', chunk.toString('binary'));
         buffer += chunk.toString('binary');
         processBuffer();
     }
-
     function attach(sock) {
-        sock.on('data', chunk => {
+        sock.on('data', (chunk) => {
             if (layer) {
                 layer.receive(chunk);
-            } else {
+            }
+            else {
                 onData(chunk);
             }
         });
-        sock.on('error', err => {
+        sock.on('error', (err) => {
             log('Socket error:', err.message);
             // the close event follows and returns what was received so far
         });
         // the last data may still be in the decompressor
         sock.on('close', () => (layer ? layer.whenIdle(finish) : finish()));
     }
-
     attach(socket);
 }
-
 /**
  * Splits commands at synchronizing literals, so that literal data can wait for the
  * continuation request
@@ -224,7 +210,7 @@ function runClientMockup(port, host, commands, debug, callback) {
  */
 function splitLiterals(commands) {
     const parts = [];
-    commands.forEach(command => {
+    commands.forEach((command) => {
         splitAtLiterals(String(command) + '\r\n').forEach((text, i) => {
             parts.push({ text, continuation: i > 0 });
         });

package/dist/esm/numbers.d.ts

@@ -0,0 +1,28 @@
+declare const MAX_NUMBER = 4294967295;
+declare const MAX_NUMBER64: bigint;
+/**
+ * Checks if a value is a number by the grammar: 1*DIGIT, up to a limit
+ *
+ * @param {*} value Value to check, only strings can match
+ * @param {Number|BigInt} [max] Largest allowed value, MAX_NUMBER by default
+ * @return {Boolean} true if the value is a number within the limit
+ */
+declare function isNumber(value: unknown, max?: number | bigint): boolean;
+/**
+ * Checks if a value is a non-zero number (nz-number, nz-number64): digit-nz *DIGIT, up to a limit
+ *
+ * @param {*} value Value to check, only strings can match
+ * @param {Number|BigInt} [max] Largest allowed value, MAX_NUMBER by default
+ * @return {Boolean} true if the value is a non-zero number within the limit
+ */
+declare function isNzNumber(value: unknown, max?: number | bigint): boolean;
+/**
+ * Checks if a value is a sequence set (RFC 3501 and RFC 9051 section 9): seq-number or seq-range items
+ * separated by commas, seq-number = nz-number / "*"
+ *
+ * @param {*} value Value to check, only strings can match
+ * @param {Boolean} [noStar] If true, "*" is not allowed (e.g. known-uids of RFC 7162 section 7)
+ * @return {Boolean} true if the value is a valid sequence set
+ */
+declare function isSequenceSet(value: unknown, noStar?: boolean): boolean;
+export { MAX_NUMBER, MAX_NUMBER64, isNumber, isNzNumber, isSequenceSet };

package/{lib → dist/esm}/numbers.js

@@ -1,12 +1,8 @@
-'use strict';
-
 // Limits and checks of the numbers in the IMAP grammar
-
 // RFC 3501 and RFC 9051 section 9: number and nz-number are unsigned 32-bit integers
 const MAX_NUMBER = 4294967295;
 // RFC 9051 section 9: number64 is an unsigned 63-bit integer, so is mod-sequence-value (RFC 7162 section 7)
 const MAX_NUMBER64 = 2n ** 63n - 1n;
-
 /**
  * Checks if a value is a number by the grammar: 1*DIGIT, up to a limit
  *
@@ -22,7 +18,6 @@ function isNumber(value, max) {
     }
     return BigInt(value) <= BigInt(limit);
 }
-
 /**
  * Checks if a value is a non-zero number (nz-number, nz-number64): digit-nz *DIGIT, up to a limit
  *
@@ -33,7 +28,6 @@ function isNumber(value, max) {
 function isNzNumber(value, max) {
     return isNumber(value, max) && /^[1-9]/.test(value);
 }
-
 /**
  * Checks if a value is a sequence set (RFC 3501 and RFC 9051 section 9): seq-number or seq-range items
  * separated by commas, seq-number = nz-number / "*"
@@ -48,5 +42,4 @@ function isSequenceSet(value, noStar) {
     }
     return value.split(/[,:]/).every(part => (part === '*' ? !noStar : isNzNumber(part)));
 }
-
-module.exports = { MAX_NUMBER, MAX_NUMBER64, isNumber, isNzNumber, isSequenceSet };
+export { MAX_NUMBER, MAX_NUMBER64, isNumber, isNzNumber, isSequenceSet };

package/dist/esm/package.json

@@ -0,0 +1,3 @@
+{
+    "type": "module"
+}

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

@@ -0,0 +1,2 @@
+import type { IMAPServer } from '../types.js';
+export default function aclPlugin(server: IMAPServer): void;