@rndmjoker/proton-mcp 0.4.13 → 0.5.1

package/dist/browser/setup.js

@@ -0,0 +1,170 @@
+/**
+ * Sets up the connector Chrome starts for the browser extension (#59):
+ *
+ *   npx -y @rndmjoker/proton-mcp@latest setup-browser
+ *   npx -y @rndmjoker/proton-mcp@latest setup-browser --remove
+ *
+ * What it writes, all of it for the current user only:
+ *
+ * - the secret both ends of the socket prove they know, readable by the user
+ *   alone, kept when the setup runs again so a running connector keeps working;
+ * - a copy of the connector's five files under ~/.config/proton-mcp/browser/host,
+ *   because an npx cache can be cleared or replaced at any time and Chrome
+ *   needs a path that stays;
+ * - a launcher that starts that copy with the Node this setup runs under,
+ *   since Chrome's environment may not find Node on its own;
+ * - the manifest that tells Chrome which program the extension may start,
+ *   naming the extension's fixed id as the only one allowed;
+ * - on Windows, the registry entry that points Chrome at that manifest.
+ *
+ * Nothing here needs administrator rights, and nothing outside the user's own
+ * directories and, on Windows, the user's own part of the registry is touched.
+ */
+import { mkdirSync, writeFileSync, copyFileSync, chmodSync, existsSync, rmSync, readFileSync } from 'node:fs';
+import { execFileSync } from 'node:child_process';
+import { randomBytes } from 'node:crypto';
+import { dirname, join, win32 } from 'node:path';
+import { fileURLToPath } from 'node:url';
+import { HOST_NAME, EXTENSION_ID } from './messages.js';
+import { browserPaths, UnsupportedPlatform } from './paths.js';
+import { readSecret } from './channel.js';
+/** The files the connector needs, copied together because they import each other and nothing else. */
+export const HOST_FILES = ['connector.js', 'host.js', 'messages.js', 'paths.js', 'channel.js'];
+/** Quotes a path for a POSIX shell script: single quotes, with any single quote closed and escaped. */
+function shellQuote(value) {
+    return `'${value.replace(/'/g, `'\\''`)}'`;
+}
+function launcherText(paths, node) {
+    if (paths.platform === 'win32') {
+        // Chrome runs a .cmd through cmd.exe and passes the origin and the parent
+        // window as arguments, which %* hands on. cmd.exe reads a batch file in
+        // the console's code page, so it switches to UTF-8 first for paths with
+        // letters like the umlauts in a user name, and a percent sign in a path
+        // is doubled so cmd.exe does not read it as a variable. Not measured on
+        // Windows yet.
+        const quoted = (value) => `"${value.replace(/%/g, '%%')}"`;
+        return ('@echo off\r\n' +
+            'rem Written by proton-mcp setup-browser. Chrome starts this for the extension.\r\n' +
+            'chcp 65001 >nul\r\n' +
+            `${quoted(node)} ${quoted(paths.hostScript)} %*\r\n`);
+    }
+    return ('#!/bin/sh\n' +
+        '# Written by proton-mcp setup-browser. Chrome starts this for the extension.\n' +
+        `exec ${shellQuote(node)} ${shellQuote(paths.hostScript)} "$@"\n`);
+}
+function manifestText(paths) {
+    return `${JSON.stringify({
+        name: HOST_NAME,
+        description: 'Connector for the Proton MCP Helper extension',
+        path: paths.launcher,
+        type: 'stdio',
+        allowed_origins: [`chrome-extension://${EXTENSION_ID}/`],
+    }, null, 2)}\n`;
+}
+function defaultRegistry(args) {
+    // By its full path: a bare name is looked up in the current directory first.
+    const reg = win32.join(process.env.SystemRoot ?? 'C:\\Windows', 'System32', 'reg.exe');
+    execFileSync(reg, args, { stdio: 'ignore', windowsHide: true });
+}
+/** Writes everything, or with remove takes it all away again. Returns the exit code. */
+export function setupBrowser(options = {}) {
+    const write = options.write ?? ((text) => process.stdout.write(text));
+    let paths;
+    try {
+        paths = options.paths ?? browserPaths(options.platform !== undefined ? { platform: options.platform } : {});
+    }
+    catch (error) {
+        if (error instanceof UnsupportedPlatform) {
+            write(`${error.message}\n`);
+            return 1;
+        }
+        throw error;
+    }
+    const registry = options.registry ?? defaultRegistry;
+    if (options.remove) {
+        rmSync(paths.manifestFile, { force: true });
+        rmSync(paths.hostDir, { recursive: true, force: true });
+        rmSync(paths.secretFile, { force: true });
+        if (paths.registryKey) {
+            try {
+                registry(['delete', paths.registryKey, '/f']);
+            }
+            catch {
+                // Not there to begin with.
+            }
+        }
+        write('The connector for the browser extension is removed: its manifest, its copy and its secret.\n' +
+            'Remove the extension itself in chrome://extensions.\n');
+        return 0;
+    }
+    const node = options.node ?? process.execPath;
+    const sourceDir = options.sourceDir ?? dirname(fileURLToPath(import.meta.url));
+    const missing = HOST_FILES.filter((file) => !existsSync(join(sourceDir, file)));
+    if (missing.length > 0) {
+        write(`The connector's files are missing from ${sourceDir}: ${missing.join(', ')}. Build the server first.\n`);
+        return 1;
+    }
+    mkdirSync(paths.browserDir, { recursive: true, mode: 0o700 });
+    mkdirSync(paths.hostDir, { recursive: true, mode: 0o700 });
+    if (paths.platform !== 'win32') {
+        chmodSync(paths.browserDir, 0o700);
+        chmodSync(paths.hostDir, 0o700);
+    }
+    // Kept when it exists: a connector Chrome already started read it once and
+    // would refuse every connection after a change, until the extension reloads.
+    const keptSecret = readSecret(paths.secretFile) !== undefined;
+    if (!keptSecret) {
+        writeFileSync(paths.secretFile, `${randomBytes(32).toString('hex')}\n`, { mode: 0o600 });
+    }
+    if (paths.platform !== 'win32')
+        chmodSync(paths.secretFile, 0o600);
+    for (const file of HOST_FILES)
+        copyFileSync(join(sourceDir, file), join(paths.hostDir, file));
+    // The copies are ES modules and need to be read as such without the package around them.
+    writeFileSync(join(paths.hostDir, 'package.json'), '{ "type": "module", "private": true }\n');
+    writeFileSync(paths.launcher, launcherText(paths, node), { mode: 0o700 });
+    if (paths.platform !== 'win32')
+        chmodSync(paths.launcher, 0o700);
+    mkdirSync(dirname(paths.manifestFile), { recursive: true });
+    // Readable by the user alone: whoever can change "path" in it decides what
+    // Chrome starts as this user.
+    writeFileSync(paths.manifestFile, manifestText(paths), { mode: 0o600 });
+    if (paths.platform !== 'win32')
+        chmodSync(paths.manifestFile, 0o600);
+    if (paths.registryKey) {
+        registry(['add', paths.registryKey, '/ve', '/t', 'REG_SZ', '/d', paths.manifestFile, '/f']);
+    }
+    write([
+        'The connector for the browser extension is set up.',
+        '',
+        `  Connector: ${paths.launcher}`,
+        `  Node:      ${node}`,
+        `  Manifest:  ${paths.manifestFile}`,
+        ...(paths.registryKey ? [`  Registry:  ${paths.registryKey}`] : []),
+        `  Secret:    ${paths.secretFile}${keptSecret ? ' (kept)' : ' (new)'}`,
+        `  Socket:    ${paths.socket}`,
+        '',
+        'Next:',
+        '  1. Load the extension in Chrome: open chrome://extensions, switch on Developer mode,',
+        '     choose "Load unpacked" and pick the unpacked folder of the extension from the release.',
+        `     Its id has to be ${EXTENSION_ID}.`,
+        '     If it was loaded before, click its reload arrow instead.',
+        '  2. Reload any open Proton tab once, or open https://mail.proton.me and sign in.',
+        '  3. Ask your assistant to list your filters.',
+        '',
+        'If Node moves, for example after an upgrade under another path, run this again.',
+        'To take all of it away: the same command with --remove.',
+        '',
+    ].join('\n'));
+    return 0;
+}
+/** Reads the manifest back, for the diagnosis and the tests. */
+export function readManifest(paths) {
+    try {
+        return JSON.parse(readFileSync(paths.manifestFile, 'utf8'));
+    }
+    catch {
+        return undefined;
+    }
+}
+//# sourceMappingURL=setup.js.map

package/dist/browser/setup.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"setup.js","sourceRoot":"","sources":["../../src/browser/setup.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;GAqBG;AAEH,OAAO,EAAE,SAAS,EAAE,aAAa,EAAE,YAAY,EAAE,SAAS,EAAE,UAAU,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,SAAS,CAAA;AAC7G,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAA;AACjD,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAA;AACzC,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM,WAAW,CAAA;AAChD,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAA;AACxC,OAAO,EAAE,SAAS,EAAE,YAAY,EAAE,MAAM,eAAe,CAAA;AACvD,OAAO,EAAE,YAAY,EAAE,mBAAmB,EAAqB,MAAM,YAAY,CAAA;AACjF,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAA;AAEzC,sGAAsG;AACtG,MAAM,CAAC,MAAM,UAAU,GAAG,CAAC,cAAc,EAAE,SAAS,EAAE,aAAa,EAAE,UAAU,EAAE,YAAY,CAAU,CAAA;AAgBvG,uGAAuG;AACvG,SAAS,UAAU,CAAC,KAAa;IAC/B,OAAO,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,EAAE,OAAO,CAAC,GAAG,CAAA;AAC5C,CAAC;AAED,SAAS,YAAY,CAAC,KAAmB,EAAE,IAAY;IACrD,IAAI,KAAK,CAAC,QAAQ,KAAK,OAAO,EAAE,CAAC;QAC/B,0EAA0E;QAC1E,wEAAwE;QACxE,wEAAwE;QACxE,wEAAwE;QACxE,wEAAwE;QACxE,eAAe;QACf,MAAM,MAAM,GAAG,CAAC,KAAa,EAAU,EAAE,CAAC,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,EAAE,IAAI,CAAC,GAAG,CAAA;QAC1E,OAAO,CACL,eAAe;YACf,oFAAoF;YACpF,qBAAqB;YACrB,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC,SAAS,CACrD,CAAA;IACH,CAAC;IACD,OAAO,CACL,aAAa;QACb,gFAAgF;QAChF,QAAQ,UAAU,CAAC,IAAI,CAAC,IAAI,UAAU,CAAC,KAAK,CAAC,UAAU,CAAC,SAAS,CAClE,CAAA;AACH,CAAC;AAED,SAAS,YAAY,CAAC,KAAmB;IACvC,OAAO,GAAG,IAAI,CAAC,SAAS,CACtB;QACE,IAAI,EAAE,SAAS;QACf,WAAW,EAAE,+CAA+C;QAC5D,IAAI,EAAE,KAAK,CAAC,QAAQ;QACpB,IAAI,EAAE,OAAO;QACb,eAAe,EAAE,CAAC,sBAAsB,YAAY,GAAG,CAAC;KACzD,EACD,IAAI,EACJ,CAAC,CACF,IAAI,CAAA;AACP,CAAC;AAED,SAAS,eAAe,CAAC,IAAc;IACrC,6EAA6E;IAC7E,MAAM,GAAG,GAAG,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,UAAU,IAAI,aAAa,EAAE,UAAU,EAAE,SAAS,CAAC,CAAA;IACtF,YAAY,CAAC,GAAG,EAAE,IAAI,EAAE,EAAE,KAAK,EAAE,QAAQ,EAAE,WAAW,EAAE,IAAI,EAAE,CAAC,CAAA;AACjE,CAAC;AAED,wFAAwF;AACxF,MAAM,UAAU,YAAY,CAAC,OAAO,GAAiB,EAAE;IACrD,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,IAAI,CAAC,CAAC,IAAY,EAAE,EAAE,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAA;IAC7E,IAAI,KAAmB,CAAA;IACvB,IAAI,CAAC;QACH,KAAK,GAAG,OAAO,CAAC,KAAK,IAAI,YAAY,CAAC,OAAO,CAAC,QAAQ,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE,OAAO,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CAAA;IAC7G,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,IAAI,KAAK,YAAY,mBAAmB,EAAE,CAAC;YACzC,KAAK,CAAC,GAAG,KAAK,CAAC,OAAO,IAAI,CAAC,CAAA;YAC3B,OAAO,CAAC,CAAA;QACV,CAAC;QACD,MAAM,KAAK,CAAA;IACb,CAAC;IACD,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAQ,IAAI,eAAe,CAAA;IAEpD,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC;QACnB,MAAM,CAAC,KAAK,CAAC,YAAY,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAA;QAC3C,MAAM,CAAC,KAAK,CAAC,OAAO,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAA;QACvD,MAAM,CAAC,KAAK,CAAC,UAAU,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAA;QACzC,IAAI,KAAK,CAAC,WAAW,EAAE,CAAC;YACtB,IAAI,CAAC;gBACH,QAAQ,CAAC,CAAC,QAAQ,EAAE,KAAK,CAAC,WAAW,EAAE,IAAI,CAAC,CAAC,CAAA;YAC/C,CAAC;YAAC,MAAM,CAAC;gBACP,2BAA2B;YAC7B,CAAC;QACH,CAAC;QACD,KAAK,CACH,8FAA8F;YAC5F,uDAAuD,CAC1D,CAAA;QACD,OAAO,CAAC,CAAA;IACV,CAAC;IAED,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,IAAI,OAAO,CAAC,QAAQ,CAAA;IAC7C,MAAM,SAAS,GAAG,OAAO,CAAC,SAAS,IAAI,OAAO,CAAC,aAAa,CAAC,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC,CAAA;IAC9E,MAAM,OAAO,GAAG,UAAU,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,UAAU,CAAC,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC,CAAC,CAAA;IAC/E,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACvB,KAAK,CAAC,0CAA0C,SAAS,KAAK,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,6BAA6B,CAAC,CAAA;QAC9G,OAAO,CAAC,CAAA;IACV,CAAC;IAED,SAAS,CAAC,KAAK,CAAC,UAAU,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC,CAAA;IAC7D,SAAS,CAAC,KAAK,CAAC,OAAO,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC,CAAA;IAC1D,IAAI,KAAK,CAAC,QAAQ,KAAK,OAAO,EAAE,CAAC;QAC/B,SAAS,CAAC,KAAK,CAAC,UAAU,EAAE,KAAK,CAAC,CAAA;QAClC,SAAS,CAAC,KAAK,CAAC,OAAO,EAAE,KAAK,CAAC,CAAA;IACjC,CAAC;IAED,2EAA2E;IAC3E,6EAA6E;IAC7E,MAAM,UAAU,GAAG,UAAU,CAAC,KAAK,CAAC,UAAU,CAAC,KAAK,SAAS,CAAA;IAC7D,IAAI,CAAC,UAAU,EAAE,CAAC;QAChB,aAAa,CAAC,KAAK,CAAC,UAAU,EAAE,GAAG,WAAW,CAAC,EAAE,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC,CAAA;IAC1F,CAAC;IACD,IAAI,KAAK,CAAC,QAAQ,KAAK,OAAO;QAAE,SAAS,CAAC,KAAK,CAAC,UAAU,EAAE,KAAK,CAAC,CAAA;IAElE,KAAK,MAAM,IAAI,IAAI,UAAU;QAAE,YAAY,CAAC,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,EAAE,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC,CAAA;IAC7F,yFAAyF;IACzF,aAAa,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE,cAAc,CAAC,EAAE,yCAAyC,CAAC,CAAA;IAE7F,aAAa,CAAC,KAAK,CAAC,QAAQ,EAAE,YAAY,CAAC,KAAK,EAAE,IAAI,CAAC,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC,CAAA;IACzE,IAAI,KAAK,CAAC,QAAQ,KAAK,OAAO;QAAE,SAAS,CAAC,KAAK,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAA;IAEhE,SAAS,CAAC,OAAO,CAAC,KAAK,CAAC,YAAY,CAAC,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAA;IAC3D,2EAA2E;IAC3E,8BAA8B;IAC9B,aAAa,CAAC,KAAK,CAAC,YAAY,EAAE,YAAY,CAAC,KAAK,CAAC,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC,CAAA;IACvE,IAAI,KAAK,CAAC,QAAQ,KAAK,OAAO;QAAE,SAAS,CAAC,KAAK,CAAC,YAAY,EAAE,KAAK,CAAC,CAAA;IACpE,IAAI,KAAK,CAAC,WAAW,EAAE,CAAC;QACtB,QAAQ,CAAC,CAAC,KAAK,EAAE,KAAK,CAAC,WAAW,EAAE,KAAK,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,KAAK,CAAC,YAAY,EAAE,IAAI,CAAC,CAAC,CAAA;IAC7F,CAAC;IAED,KAAK,CACH;QACE,oDAAoD;QACpD,EAAE;QACF,gBAAgB,KAAK,CAAC,QAAQ,EAAE;QAChC,gBAAgB,IAAI,EAAE;QACtB,gBAAgB,KAAK,CAAC,YAAY,EAAE;QACpC,GAAG,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,gBAAgB,KAAK,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;QACnE,gBAAgB,KAAK,CAAC,UAAU,GAAG,UAAU,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,QAAQ,EAAE;QACtE,gBAAgB,KAAK,CAAC,MAAM,EAAE;QAC9B,EAAE;QACF,OAAO;QACP,wFAAwF;QACxF,6FAA6F;QAC7F,yBAAyB,YAAY,GAAG;QACxC,+DAA+D;QAC/D,mFAAmF;QACnF,+CAA+C;QAC/C,EAAE;QACF,iFAAiF;QACjF,yDAAyD;QACzD,EAAE;KACH,CAAC,IAAI,CAAC,IAAI,CAAC,CACb,CAAA;IACD,OAAO,CAAC,CAAA;AACV,CAAC;AAED,gEAAgE;AAChE,MAAM,UAAU,YAAY,CAAC,KAAmB;IAC9C,IAAI,CAAC;QACH,OAAO,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,KAAK,CAAC,YAAY,EAAE,MAAM,CAAC,CAA4B,CAAA;IACxF,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,SAAS,CAAA;IAClB,CAAC;AACH,CAAC"}

package/dist/filters/order.d.ts

@@ -0,0 +1,66 @@
+/**
+ * Moving filters in the order Proton runs them (#59), shared by the server and
+ * the extension. Nothing from Node in here.
+ *
+ * Proton runs every filter on every incoming message, top to bottom. A filter
+ * that matches does not stop the ones after it; only stop and discard end the
+ * run. A message lives in one folder, so when several filters file it into
+ * folders, the last one wins, while labels add up. So the order decides where
+ * mail ends up, and moving a filter can change that for every message it and
+ * the filters it passes have in common.
+ *
+ * Proton takes a new order as the complete list of ids. Assistants describe
+ * moves instead, one or several, each a filter and the position it should
+ * end up at, applied one after the other. Asked for by Tobi on 06.11.2026.
+ */
+export interface FilterMove {
+    id: string;
+    /** Where the filter ends up, counted from 1 as list_filters shows the order. */
+    position: number;
+}
+/** A move that cannot be made. The message says why. */
+export declare class OrderError extends Error {
+}
+/** The most moves taken in one go. */
+export declare const MAX_MOVES = 50;
+/**
+ * The order after the moves, each applied to the result of the one before.
+ * Throws OrderError for a filter that does not exist, a position outside the
+ * list, or a filter moved twice, which would leave its place to chance.
+ */
+export declare function applyMoves(order: readonly string[], moves: readonly FilterMove[]): string[];
+/**
+ * The filters whose place relative to this one changed: before the move they
+ * ran on one side of it, after the move on the other. For each of them, the
+ * outcome for a message both match can now be different.
+ */
+export declare function passed(before: readonly string[], after: readonly string[], id: string): string[];
+/** True when both lists hold the same ids in the same order. */
+export declare function sameOrder(a: readonly string[], b: readonly string[]): boolean;
+/** A filter whose place changed relative to others, and on which side of them it now runs. */
+export interface MovedFilter {
+    id: string;
+    /** Positions counted from 1. */
+    from: number;
+    to: number;
+    /** The filters it used to run after and now runs before. */
+    before: string[];
+    /** The filters it used to run before and now runs after: against these it now has the last word. */
+    after: string[];
+}
+/**
+ * The filters that were asked to move and now stand in a new place relative
+ * to at least one other, even when their position number did not change:
+ * moved to the front and pushed back by a later move, a filter can end on its
+ * old number with a different neighbour order. The ones that only shifted
+ * because another moved past them are not listed; they appear in the lists of
+ * the one that did.
+ */
+export declare function movedFilters(before: readonly string[], after: readonly string[], ids: readonly string[]): MovedFilter[];
+/**
+ * Where a move touches a filter that does more than file and flag, such as
+ * filing into Trash, whether the user allowed it or not: the order decides
+ * which folder wins and what still runs after a stop, so the person agreeing
+ * should look twice there. One line per such filter and move.
+ */
+export declare function orderWarnings(moved: readonly MovedFilter[], refusedOf: (id: string) => string[], nameOf: (id: string) => string): string[];

package/dist/filters/order.js

@@ -0,0 +1,108 @@
+/**
+ * Moving filters in the order Proton runs them (#59), shared by the server and
+ * the extension. Nothing from Node in here.
+ *
+ * Proton runs every filter on every incoming message, top to bottom. A filter
+ * that matches does not stop the ones after it; only stop and discard end the
+ * run. A message lives in one folder, so when several filters file it into
+ * folders, the last one wins, while labels add up. So the order decides where
+ * mail ends up, and moving a filter can change that for every message it and
+ * the filters it passes have in common.
+ *
+ * Proton takes a new order as the complete list of ids. Assistants describe
+ * moves instead, one or several, each a filter and the position it should
+ * end up at, applied one after the other. Asked for by Tobi on 06.11.2026.
+ */
+/** A move that cannot be made. The message says why. */
+export class OrderError extends Error {
+}
+/** The most moves taken in one go. */
+export const MAX_MOVES = 50;
+/**
+ * The order after the moves, each applied to the result of the one before.
+ * Throws OrderError for a filter that does not exist, a position outside the
+ * list, or a filter moved twice, which would leave its place to chance.
+ */
+export function applyMoves(order, moves) {
+    if (moves.length === 0)
+        throw new OrderError('No move was given.');
+    if (moves.length > MAX_MOVES)
+        throw new OrderError(`At most ${MAX_MOVES} moves are taken at once.`);
+    const result = [...order];
+    const seen = new Set();
+    for (const move of moves) {
+        if (seen.has(move.id))
+            throw new OrderError(`The filter ${move.id} is moved twice. Move each filter once.`);
+        seen.add(move.id);
+        const from = result.indexOf(move.id);
+        if (from < 0)
+            throw new OrderError(`There is no filter with the id ${move.id}. Call list_filters for the current ones.`);
+        if (!Number.isInteger(move.position) || move.position < 1 || move.position > result.length) {
+            throw new OrderError(`Position ${move.position} is outside the order, which runs from 1 to ${result.length}.`);
+        }
+        result.splice(from, 1);
+        result.splice(move.position - 1, 0, move.id);
+    }
+    return result;
+}
+/**
+ * The filters whose place relative to this one changed: before the move they
+ * ran on one side of it, after the move on the other. For each of them, the
+ * outcome for a message both match can now be different.
+ */
+export function passed(before, after, id) {
+    const was = before.indexOf(id);
+    const is = after.indexOf(id);
+    return after.filter((other) => other !== id && before.indexOf(other) < was !== after.indexOf(other) < is);
+}
+/** True when both lists hold the same ids in the same order. */
+export function sameOrder(a, b) {
+    return a.length === b.length && a.every((id, index) => id === b[index]);
+}
+/**
+ * The filters that were asked to move and now stand in a new place relative
+ * to at least one other, even when their position number did not change:
+ * moved to the front and pushed back by a later move, a filter can end on its
+ * old number with a different neighbour order. The ones that only shifted
+ * because another moved past them are not listed; they appear in the lists of
+ * the one that did.
+ */
+export function movedFilters(before, after, ids) {
+    const moved = [];
+    for (const id of new Set(ids)) {
+        const others = passed(before, after, id);
+        if (others.length === 0)
+            continue;
+        const at = after.indexOf(id);
+        moved.push({
+            id,
+            from: before.indexOf(id) + 1,
+            to: at + 1,
+            before: others.filter((other) => after.indexOf(other) > at),
+            after: others.filter((other) => after.indexOf(other) < at),
+        });
+    }
+    return moved;
+}
+/**
+ * Where a move touches a filter that does more than file and flag, such as
+ * filing into Trash, whether the user allowed it or not: the order decides
+ * which folder wins and what still runs after a stop, so the person agreeing
+ * should look twice there. One line per such filter and move.
+ */
+export function orderWarnings(moved, refusedOf, nameOf) {
+    const warnings = [];
+    for (const move of moved) {
+        for (const other of [move.id, ...move.before, ...move.after]) {
+            const refused = refusedOf(other);
+            if (refused.length === 0)
+                continue;
+            const warning = `"${nameOf(other)}" does more than file and flag (${refused.join(', ')}), ` +
+                `and its place relative to "${nameOf(move.id)}" changes.`;
+            if (!warnings.includes(warning))
+                warnings.push(warning);
+        }
+    }
+    return warnings;
+}
+//# sourceMappingURL=order.js.map

package/dist/filters/order.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"order.js","sourceRoot":"","sources":["../../src/filters/order.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAQH,wDAAwD;AACxD,MAAM,OAAO,UAAW,SAAQ,KAAK;CAAG;AAExC,sCAAsC;AACtC,MAAM,CAAC,MAAM,SAAS,GAAG,EAAE,CAAA;AAE3B;;;;GAIG;AACH,MAAM,UAAU,UAAU,CAAC,KAAwB,EAAE,KAA4B;IAC/E,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC;QAAE,MAAM,IAAI,UAAU,CAAC,oBAAoB,CAAC,CAAA;IAClE,IAAI,KAAK,CAAC,MAAM,GAAG,SAAS;QAAE,MAAM,IAAI,UAAU,CAAC,WAAW,SAAS,2BAA2B,CAAC,CAAA;IACnG,MAAM,MAAM,GAAG,CAAC,GAAG,KAAK,CAAC,CAAA;IACzB,MAAM,IAAI,GAAG,IAAI,GAAG,EAAU,CAAA;IAC9B,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;QACzB,IAAI,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC;YAAE,MAAM,IAAI,UAAU,CAAC,cAAc,IAAI,CAAC,EAAE,yCAAyC,CAAC,CAAA;QAC3G,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;QACjB,MAAM,IAAI,GAAG,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;QACpC,IAAI,IAAI,GAAG,CAAC;YAAE,MAAM,IAAI,UAAU,CAAC,kCAAkC,IAAI,CAAC,EAAE,2CAA2C,CAAC,CAAA;QACxH,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,IAAI,CAAC,QAAQ,GAAG,CAAC,IAAI,IAAI,CAAC,QAAQ,GAAG,MAAM,CAAC,MAAM,EAAE,CAAC;YAC3F,MAAM,IAAI,UAAU,CAAC,YAAY,IAAI,CAAC,QAAQ,+CAA+C,MAAM,CAAC,MAAM,GAAG,CAAC,CAAA;QAChH,CAAC;QACD,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC,CAAC,CAAA;QACtB,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,GAAG,CAAC,EAAE,CAAC,EAAE,IAAI,CAAC,EAAE,CAAC,CAAA;IAC9C,CAAC;IACD,OAAO,MAAM,CAAA;AACf,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,MAAM,CAAC,MAAyB,EAAE,KAAwB,EAAE,EAAU;IACpF,MAAM,GAAG,GAAG,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC,CAAA;IAC9B,MAAM,EAAE,GAAG,KAAK,CAAC,OAAO,CAAC,EAAE,CAAC,CAAA;IAC5B,OAAO,KAAK,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,KAAK,EAAE,IAAI,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,GAAG,GAAG,KAAK,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,CAAA;AAC3G,CAAC;AAED,gEAAgE;AAChE,MAAM,UAAU,SAAS,CAAC,CAAoB,EAAE,CAAoB;IAClE,OAAO,CAAC,CAAC,MAAM,KAAK,CAAC,CAAC,MAAM,IAAI,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,KAAK,EAAE,EAAE,CAAC,EAAE,KAAK,CAAC,CAAC,KAAK,CAAC,CAAC,CAAA;AACzE,CAAC;AAcD;;;;;;;GAOG;AACH,MAAM,UAAU,YAAY,CAAC,MAAyB,EAAE,KAAwB,EAAE,GAAsB;IACtG,MAAM,KAAK,GAAkB,EAAE,CAAA;IAC/B,KAAK,MAAM,EAAE,IAAI,IAAI,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC;QAC9B,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,KAAK,EAAE,EAAE,CAAC,CAAA;QACxC,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC;YAAE,SAAQ;QACjC,MAAM,EAAE,GAAG,KAAK,CAAC,OAAO,CAAC,EAAE,CAAC,CAAA;QAC5B,KAAK,CAAC,IAAI,CAAC;YACT,EAAE;YACF,IAAI,EAAE,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC,GAAG,CAAC;YAC5B,EAAE,EAAE,EAAE,GAAG,CAAC;YACV,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC;YAC3D,KAAK,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC;SAC3D,CAAC,CAAA;IACJ,CAAC;IACD,OAAO,KAAK,CAAA;AACd,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,aAAa,CAC3B,KAA6B,EAC7B,SAAmC,EACnC,MAA8B;IAE9B,MAAM,QAAQ,GAAa,EAAE,CAAA;IAC7B,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;QACzB,KAAK,MAAM,KAAK,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,GAAG,IAAI,CAAC,MAAM,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;YAC7D,MAAM,OAAO,GAAG,SAAS,CAAC,KAAK,CAAC,CAAA;YAChC,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC;gBAAE,SAAQ;YAClC,MAAM,OAAO,GACX,IAAI,MAAM,CAAC,KAAK,CAAC,mCAAmC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK;gBAC3E,8BAA8B,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,YAAY,CAAA;YAC3D,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,OAAO,CAAC;gBAAE,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;QACzD,CAAC;IACH,CAAC;IACD,OAAO,QAAQ,CAAA;AACjB,CAAC"}

package/dist/filters/sieve.d.ts

@@ -0,0 +1,184 @@
+/**
+ * Reading and checking a Sieve script before it reaches Proton (#59).
+ *
+ * A filter keeps acting on every message that arrives, long after the
+ * conversation that wrote it. So a script an assistant proposes is held to a
+ * list of what it may do, not to a list of what it may not: anything this file
+ * does not know is refused, and the refusal says why.
+ *
+ * The same code runs in two places: in this server before a proposal leaves,
+ * and in the browser extension before anything is written. Neither trusts the
+ * check of the other, which is why this file uses nothing from Node.
+ *
+ * What it refuses, as decided on 05.11.2026:
+ *
+ * - discard, expire, reject and vacation: they delete mail, turn it away or
+ *   answer it in the user's name.
+ * - stop: it ends every later filter for a matching message, which switches
+ *   those filters off without anyone seeing it. Proton's own assistant allows
+ *   it; this one does not.
+ * - filing into Trash or Spam: it hides mail.
+ * - a script without Proton's spam guard at the top: without it the filter
+ *   runs on spam as well and can file spam among normal mail.
+ * - a script that does nothing beyond the guard: an empty filter is how a rule
+ *   is switched off, and switching off is the user's decision.
+ *
+ * Tightened on 06.11.2026, after two reviewers found scripts that passed and
+ * read differently in the confirmation from what they do, or that Proton's
+ * own parser may read differently from this one:
+ *
+ * - no comment but Proton's own two, the line above the spam guard and the
+ *   one its filter editor writes above each rule, and no text: blocks: both
+ *   are where Proton's public parser (libsieve-php) and RFC 5228 part ways,
+ *   and where a discard can sit that looks commented out;
+ * - no line break, no invisible character and no lone carriage return
+ *   anywhere, and addresses in plain ASCII, as for recipients since #42;
+ * - the spam guard written as Proton writes it, without escapes;
+ * - no :regex and no :eval: a pattern or a sum that fails while Proton runs
+ *   the filter might end it like stop, and that is not known;
+ * - folder paths that name Trash, Spam or Junk in any spelling, and folders
+ *   given by Proton's internal numbers;
+ * - arguments, tags and comparators that are not on the list, and conditions
+ *   where only allof, anyof and not take them;
+ * - rules that can never match or are never reached count as doing nothing.
+ *
+ * It is not Proton's check and does not replace it. Proton reads the grammar
+ * again through mail/v4/filters/check before anything is saved.
+ */
+/**
+ * The longest script accepted. A filter is confirmed by reading it, so it has
+ * to stay readable. Raised from 20,000 on 06.11.2026, after a real account
+ * held a filter of 20,130 characters, a long list of senders, that an
+ * assistant could then neither change nor apply. A change to such a script is
+ * read through the difference the window shows, not line by line.
+ */
+export declare const MAX_SCRIPT_LENGTH = 50000;
+/** The longest filter name accepted. */
+export declare const MAX_NAME_LENGTH = 100;
+/** One of the two comments a script may carry: Proton's own line above the spam guard. */
+export declare const GUARD_COMMENT = "# Generated: Do not run this script on spam messages";
+/**
+ * The other: the comment Proton's filter editor writes above each rule, which
+ * its settings read back to show the rule in the simple editor. It holds
+ * nothing but Proton's fixed words, "@type and" or "@type or" and one
+ * "@comparator" per condition, so nothing can hide in it. Allowed since Tobi
+ * decided so on 06.11.2026: 94 of his 98 filters carry it, and refused, it
+ * kept an assistant from replacing or applying any of them. Proton writes it
+ * with Windows line ends; a plain line feed is read the same.
+ */
+export declare const EDITOR_COMMENT: RegExp;
+/**
+ * Proton's spam guard, as Proton's own filter editor and assistant write it.
+ *
+ * The comparison below is on the parsed structure and the strings as written,
+ * so a reformatted guard still counts, an escaped one does not. The text is
+ * here for the tool description and the examples, which must show the guard
+ * the same way Proton does.
+ */
+export declare const SPAM_GUARD_PROLOGUE: string;
+/**
+ * What a filter may do beyond filing and flags, each only where the user
+ * allows it: on the Permissions page of proton-mcp and, as a second lock, in
+ * the popup of the extension. All off by default. Tobi's principle of
+ * 06.11.2026: what an assistant may set up is the user's decision, and the
+ * settings are where they make it. The checks against a script that reads
+ * differently from what it does stay, whatever is allowed, and so does the
+ * spam guard.
+ */
+export declare const UNLOCKABLE: readonly ['trash', 'discard', 'expire', 'reject', 'vacation', 'stop'];
+export type Unlockable = (typeof UNLOCKABLE)[number];
+/** How each is named for people, and what it costs, in the settings, in refusals and in the window. */
+export declare const UNLOCKABLE_TEXT: Readonly<Record<Unlockable, {
+    title: string;
+    risk: string;
+}>>;
+/** Nothing allowed beyond filing and flags: how every check runs unless the user allowed more. */
+export declare const NO_UNLOCKS: ReadonlySet<Unlockable>;
+/** A list of allowed actions as read from settings or a message, or nothing when it is not one. */
+export declare function parseUnlocks(value: unknown): Unlockable[] | undefined;
+export type SieveArgument = {
+    kind: 'strings';
+    values: string[];
+    raws: string[];
+    list: boolean;
+    multiLine: boolean;
+    line: number;
+} | {
+    kind: 'number';
+    value: number;
+    line: number;
+} | {
+    kind: 'tag';
+    name: string;
+    line: number;
+};
+export interface SieveTest {
+    name: string;
+    args: SieveArgument[];
+    tests: SieveTest[];
+    line: number;
+}
+export interface SieveCommand {
+    name: string;
+    args: SieveArgument[];
+    tests: SieveTest[];
+    block?: SieveCommand[];
+    line: number;
+}
+/** A comment as written, kept so the check can see it. */
+export interface SieveComment {
+    kind: 'hash' | 'bracket';
+    text: string;
+    line: number;
+}
+/** A script this file cannot read. The line is where the reading stopped. */
+export declare class SieveSyntaxError extends Error {
+    readonly line: number;
+    constructor(message: string, line: number);
+}
+/** Reads a script into commands. Throws SieveSyntaxError when it cannot. */
+export declare function parseSieve(source: string): SieveCommand[];
+export interface SieveReview {
+    /** Why the script cannot be proposed. Empty when it can. */
+    problems: string[];
+    /** What the script does to a matching message, in plain words, without repeats. */
+    effects: string[];
+    /** What a person should look at twice before agreeing: mail that would go unnoticed. */
+    warnings: string[];
+    /**
+     * The refused things the script does, in a few words each, such as
+     * "discard" or "filing into Trash". Empty when it does none of them. For a
+     * script this file cannot read, it says so. Used where a filter the user
+     * wrote is moved: the order decides what those actions end up doing.
+     */
+    refused: string[];
+    /**
+     * What the script does beyond filing and flags that the user allowed, in
+     * the same words. Shown where filters move, like refused: the order
+     * decides what those actions end up doing.
+     */
+    unlocked: string[];
+}
+/** Why a filter name cannot be used, or nothing when it can. */
+export declare function filterNameProblem(name: string): string | undefined;
+/**
+ * The path segments of a folder name, folded the way a lenient reader might:
+ * compatibility forms joined (fullwidth letters, the long s), case dropped,
+ * the backslashes Proton uses to escape a slash removed, empty and "." parts
+ * dropped. Whatever Proton does exactly, a name that folds to Trash, Spam or
+ * Junk here is refused.
+ */
+export declare function folderSegments(target: string): string[];
+/**
+ * Checks a proposed script against everything above.
+ *
+ * Every problem is listed, not just the first, so an assistant can correct
+ * the script in one go rather than one refusal at a time.
+ */
+export declare function reviewSieve(source: string, allowed?: ReadonlySet<Unlockable>): SieveReview;
+/**
+ * Whether two scripts are the same filter as far as a person could tell:
+ * the same characters, with line ends and trailing spaces evened out. Proton
+ * may store a script with other line ends than it was sent with.
+ */
+export declare function sameScript(a: string, b: string): boolean;