@bobfrankston/rmfmail 1.1.4 → 1.1.6

package/packages/mailx-store/charset.ts

@@ -0,0 +1,45 @@
+/**
+ * Charset normalization for incoming email bodies.
+ *
+ * Many senders (esp. PHPMailer-driven marketing) declare
+ * `charset=iso-8859-1` but emit UTF-8 bytes. simpleParser honors the
+ * declared charset and produces "â??" garbage for every non-ASCII
+ * codepoint (em-dash, smart quotes, …). When the raw body bytes are
+ * valid UTF-8, rewrite the charset header before parsing. We only
+ * override the obviously-wrong legacy declarations; explicit utf-8 /
+ * koi8 / etc. pass through.
+ */
+
+/** Returns either the original buffer (no change needed) or a copy with
+ *  the leading charset declaration rewritten to utf-8. */
+export function sniffAndFixCharset(raw: Buffer): Buffer {
+    const HEAD_LIMIT = 16384;
+    const head = raw.subarray(0, Math.min(HEAD_LIMIT, raw.length)).toString("latin1");
+    const re = /charset\s*=\s*"?(iso-8859-1|us-ascii|windows-1252|latin1)"?/gi;
+    if (!re.test(head)) return raw;
+    if (!isValidUtf8(raw)) return raw;
+    const fixed = head.replace(/charset\s*=\s*"?(iso-8859-1|us-ascii|windows-1252|latin1)"?/gi, "charset=utf-8");
+    return Buffer.concat([Buffer.from(fixed, "latin1"), raw.subarray(head.length)]);
+}
+
+/** Strict UTF-8 validity check: rejects overlong forms, invalid start
+ *  bytes, and dangling continuations. Used to confirm the body is really
+ *  UTF-8 before overriding a Latin-1 declaration. */
+function isValidUtf8(buf: Buffer): boolean {
+    let i = 0;
+    while (i < buf.length) {
+        const b = buf[i];
+        if (b < 0x80) { i++; continue; }
+        let need: number;
+        if ((b & 0xE0) === 0xC0) { if (b < 0xC2) return false; need = 1; }
+        else if ((b & 0xF0) === 0xE0) need = 2;
+        else if ((b & 0xF8) === 0xF0) { if (b > 0xF4) return false; need = 3; }
+        else return false;
+        if (i + need >= buf.length) return false;
+        for (let k = 1; k <= need; k++) {
+            if ((buf[i + k] & 0xC0) !== 0x80) return false;
+        }
+        i += need + 1;
+    }
+    return true;
+}

package/packages/mailx-store/index.d.ts

@@ -5,6 +5,8 @@
 export { MailxDB } from "./db.js";
 export { FileMessageStore } from "./file-store.js";
 export { parseSerial, prewarmParseWorker } from "./parse-serial.js";
+export { Store } from "./store.js";
+export type { StoreMessage } from "./store.js";
 export { StoreBus, storeBus } from "@bobfrankston/mailx-bus";
 export type { StoreEvent, StoreEventKind, StoreEventHandler } from "@bobfrankston/mailx-bus";
 //# sourceMappingURL=index.d.ts.map

package/packages/mailx-store/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,OAAO,EAAE,MAAM,SAAS,CAAC;AAClC,OAAO,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAC;AACnD,OAAO,EAAE,WAAW,EAAE,kBAAkB,EAAE,MAAM,mBAAmB,CAAC;AAMpE,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,yBAAyB,CAAC;AAC7D,YAAY,EAAE,UAAU,EAAE,cAAc,EAAE,iBAAiB,EAAE,MAAM,yBAAyB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,OAAO,EAAE,MAAM,SAAS,CAAC;AAClC,OAAO,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAC;AACnD,OAAO,EAAE,WAAW,EAAE,kBAAkB,EAAE,MAAM,mBAAmB,CAAC;AAGpE,OAAO,EAAE,KAAK,EAAE,MAAM,YAAY,CAAC;AACnC,YAAY,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AAM/C,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,yBAAyB,CAAC;AAC7D,YAAY,EAAE,UAAU,EAAE,cAAc,EAAE,iBAAiB,EAAE,MAAM,yBAAyB,CAAC"}

package/packages/mailx-store/index.js

@@ -5,6 +5,8 @@
 export { MailxDB } from "./db.js";
 export { FileMessageStore } from "./file-store.js";
 export { parseSerial, prewarmParseWorker } from "./parse-serial.js";
+// Store — the nexus. Owns DB + .eml files + operations + bus.
+export { Store } from "./store.js";
 // Store-event bus lives in `@bobfrankston/mailx-bus` so the browser-side
 // store (mailx-store-web) and the desktop-side store (this package) share
 // the same bus. Re-exported here so existing callers don't have to learn

package/packages/mailx-store/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,OAAO,EAAE,MAAM,SAAS,CAAC;AAClC,OAAO,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAC;AACnD,OAAO,EAAE,WAAW,EAAE,kBAAkB,EAAE,MAAM,mBAAmB,CAAC;AAEpE,yEAAyE;AACzE,0EAA0E;AAC1E,yEAAyE;AACzE,uBAAuB;AACvB,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,yBAAyB,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,OAAO,EAAE,MAAM,SAAS,CAAC;AAClC,OAAO,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAC;AACnD,OAAO,EAAE,WAAW,EAAE,kBAAkB,EAAE,MAAM,mBAAmB,CAAC;AAEpE,8DAA8D;AAC9D,OAAO,EAAE,KAAK,EAAE,MAAM,YAAY,CAAC;AAGnC,yEAAyE;AACzE,0EAA0E;AAC1E,yEAAyE;AACzE,uBAAuB;AACvB,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,yBAAyB,CAAC"}

package/packages/mailx-store/index.ts

@@ -7,6 +7,10 @@ export { MailxDB } from "./db.js";
 export { FileMessageStore } from "./file-store.js";
 export { parseSerial, prewarmParseWorker } from "./parse-serial.js";
 
+// Store — the nexus. Owns DB + .eml files + operations + bus.
+export { Store } from "./store.js";
+export type { StoreMessage } from "./store.js";
+
 // Store-event bus lives in `@bobfrankston/mailx-bus` so the browser-side
 // store (mailx-store-web) and the desktop-side store (this package) share
 // the same bus. Re-exported here so existing callers don't have to learn

package/packages/mailx-store/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bobfrankston/mailx-store",
-  "version": "0.1.25",
+  "version": "0.1.26",
   "type": "module",
   "main": "index.js",
   "types": "index.d.ts",

package/packages/mailx-store/store.d.ts

@@ -0,0 +1,169 @@
+/**
+ * Store — the nexus. Owns the local database, the .eml file store, the
+ * operations API, and the event bus. Single source of truth for everything
+ * about a mailx account that lives on this device.
+ *
+ *   UI ──┐                                ┌── Sync clients (IMAP, Gmail API, …)
+ *        │  reads / writes / subscribes  │   read pending actions, commit
+ *        ↓                                ↓   server-discovered changes
+ *                          [ Store ]
+ *
+ * Contract: every method here mutates local-only state. No IMAP, no Gmail,
+ * no SMTP, no DNS, no Drive API. Mutations emit on the bus; subscribers
+ * (UI in another process, in-process reconciler, etc.) react. Sync clients
+ * (mailx-imap, mailx-sync) hold a Store reference and never touch the
+ * underlying MailxDB / FileMessageStore directly.
+ *
+ * This was previously named `Store` and lived in mailx-service. It
+ * moved to mailx-store because mailx-imap (and other sync clients) must
+ * be able to consume it without depending on mailx-service — that's the
+ * "arrow points the right way" property of the architecture.
+ */
+import { MailxDB } from "./db.js";
+import { FileMessageStore } from "./file-store.js";
+import type { StoreBus } from "./bus.js";
+import type { MessageEnvelope, MessageQuery, PagedResult } from "@bobfrankston/mailx-types";
+/** What the UI gets back from a body read. Mirrors the historical
+ *  `getMessage` shape so call-site migration is mechanical. `cached: false`
+ *  means the body isn't on disk yet — the UI shows a "downloading…"
+ *  placeholder and listens for `bodyAvailable` to re-render. The reconciler
+ *  is responsible for actually fetching and emitting the event. */
+export interface StoreMessage extends MessageEnvelope {
+    bodyHtml: string;
+    bodyText: string;
+    hasRemoteContent: boolean;
+    remoteAllowed: boolean;
+    attachments: Array<{
+        id: number;
+        filename: string;
+        mimeType: string;
+        size: number;
+        contentId: string;
+    }>;
+    cached: boolean;
+    deliveredTo: string;
+    returnPath: string;
+    listUnsubscribe: string;
+    listUnsubscribeMail: string;
+    listUnsubscribeHttp: string;
+    listUnsubscribeOneClick: boolean;
+    emlPath: string;
+    isFlagged: boolean;
+}
+export declare class Store {
+    /** SQLite metadata index. Exposed as a public field — sync clients
+     *  (mailx-imap, mailx-sync) read/write through it during the
+     *  refactor. Future state: every external mutation routes through
+     *  a Store method that emits a bus event; raw `store.db.X()` calls
+     *  shrink to zero. Today, this is read mostly. */
+    readonly db: MailxDB;
+    /** .eml file backend. Same migration story as `db` — sync clients
+     *  read/write directly today, will route through Store methods. */
+    readonly bodyStore: FileMessageStore;
+    /** Event bus for Store mutations. Defaults to the process-singleton
+     *  so cross-package subscribers (bin/mailx.ts forwarder → WebView,
+     *  in-process reconciler triggers) see all writes without explicit
+     *  wiring. Tests can pass a fresh StoreBus for isolation. */
+    readonly bus: StoreBus;
+    private static readonly PARSED_LRU_CAPACITY;
+    private parsedLru;
+    private parsedLruGet;
+    private parsedLruPut;
+    private _allowlistCache;
+    private _settingsCache;
+    private getCachedAllowlist;
+    private getCachedSettings;
+    invalidateConfigCaches(): void;
+    constructor(
+    /** SQLite metadata index. Exposed as a public field — sync clients
+     *  (mailx-imap, mailx-sync) read/write through it during the
+     *  refactor. Future state: every external mutation routes through
+     *  a Store method that emits a bus event; raw `store.db.X()` calls
+     *  shrink to zero. Today, this is read mostly. */
+    db: MailxDB, 
+    /** .eml file backend. Same migration story as `db` — sync clients
+     *  read/write directly today, will route through Store methods. */
+    bodyStore: FileMessageStore, 
+    /** Event bus for Store mutations. Defaults to the process-singleton
+     *  so cross-package subscribers (bin/mailx.ts forwarder → WebView,
+     *  in-process reconciler triggers) see all writes without explicit
+     *  wiring. Tests can pass a fresh StoreBus for isolation. */
+    bus?: StoreBus);
+    /** DB-shape account list (id/name/email/lastSync). The richer
+     *  AccountConfig (with imap/smtp/etc.) lives in accounts.jsonc and is
+     *  loaded by mailx-settings, not the DB — that path stays in
+     *  MailxService until step 3 of the local-first plan. */
+    getAccounts(): {
+        id: string;
+        name: string;
+        email: string;
+        lastSync: number;
+    }[];
+    getFolders(accountId: string): any[];
+    /** Look up a folder by RFC 6154 specialUse tag (`trash`, `drafts`, `sent`,
+     *  `junk`, etc.) for the given account. Falls back to a case-insensitive
+     *  path match for legacy rows where specialUse never got tagged.
+     *  Returns null when the account has no such folder configured. */
+    findSpecialFolder(accountId: string, specialUse: string): {
+        id: number;
+        path: string;
+    } | null;
+    /** Single envelope by (account, uid, folder). Null when the row isn't
+     *  in the DB — caller decides whether to show "deleted" or queue a
+     *  server lookup via the reconciler. */
+    getMessageEnvelope(accountId: string, uid: number, folderId?: number): MessageEnvelope | null;
+    /** Paginated message list for a (account, folder, ...) query. */
+    getMessages(query: MessageQuery): PagedResult<MessageEnvelope>;
+    /** All-Inboxes view: union of every account's INBOX, paginated. */
+    getUnifiedInbox(page?: number, pageSize?: number): PagedResult<MessageEnvelope>;
+    /** Local FTS5 search. Server-scope search is the reconciler's job. */
+    searchMessages(query: string, page?: number, pageSize?: number, accountId?: string, folderId?: number, includeTrashSpam?: boolean): PagedResult<MessageEnvelope>;
+    /** Read a fully-parsed message (envelope + body + attachments) entirely
+     *  from local state. Returns null when the envelope isn't known.
+     *  Returns `{ ...envelope, cached: false }` when the envelope is known
+     *  but the body file isn't on disk — UI shows a placeholder and the
+     *  reconciler queues the fetch.
+     *
+     *  `allowRemote=true` skips HTML sanitization. Used when the user has
+     *  explicitly allowed remote content for this sender / domain. */
+    getMessage(accountId: string, uid: number, allowRemote: boolean, folderId?: number): Promise<StoreMessage | null>;
+    getCalendarEvents(accountId: string, fromMs: number, toMs: number): any[];
+    getTasks(accountId: string, includeCompleted?: boolean): any[];
+    searchContacts(query: string, limit?: number): any[];
+    listContacts(query: string, page?: number, pageSize?: number): any;
+    /** Update a message's flag set. Local DB write completes synchronously;
+     *  the server-mirror enqueue is the caller's responsibility (typically
+     *  via SyncQueue.enqueueFlag) so callers that don't want a server push
+     *  — pure-local UI state like "pin in pane" — can skip it.
+     *
+     *  Publishes:
+     *    `message:<uuid>` { kind: "flagsChanged" }
+     *    `folder:<id>`    (auto fan-out)
+     */
+    updateFlags(accountId: string, uid: number, folderId: number, flags: string[]): void;
+    /** Move a message between folders in the same account. Adds a tombstone
+     *  on the Message-ID so the next sync doesn't re-import the pre-move row
+     *  in the source folder before the server-side MOVE completes; tombstone
+     *  is cleared on terminal IMAP failure (see processSyncActions).
+     *
+     *  Returns true if a local row existed and was moved, false otherwise.
+     *
+     *  Publishes:
+     *    `message:<uuid>` { kind: "messageMoved", folderId: source, targetFolderId }
+     *    `folder:<source>` and `folder:<target>` (auto fan-out + explicit count)
+     */
+    moveMessage(accountId: string, uid: number, fromFolderId: number, targetFolderId: number): boolean;
+    /** Trash a message. If a trash folder is configured and the message is
+     *  not already in it, this is a move-to-trash. If the message is already
+     *  in trash (or no trash exists), it's a hard delete + body unlink.
+     *
+     *  Returns "moved-to-trash" or "expunged" so the caller knows whether
+     *  to enqueue an IMAP MOVE or a DELETE+EXPUNGE on the queue.
+     */
+    trashMessage(accountId: string, uid: number, folderId: number, trashFolderId: number | null): "moved-to-trash" | "expunged";
+    /** Restore a message from trash back to its original folder. Local-only;
+     *  caller handles the queue (cancel-pending-MOVE vs queue-counter-MOVE).
+     *  Returns true if a local row was moved. */
+    undeleteMessage(accountId: string, uid: number, trashFolderId: number, originalFolderId: number): boolean;
+}
+//# sourceMappingURL=store.d.ts.map

package/packages/mailx-store/store.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"store.d.ts","sourceRoot":"","sources":["store.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;AAKH,OAAO,EAAE,OAAO,EAAE,MAAM,SAAS,CAAC;AAClC,OAAO,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAC;AACnD,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,UAAU,CAAC;AACzC,OAAO,KAAK,EACR,eAAe,EAAE,YAAY,EAAE,WAAW,EAC7C,MAAM,2BAA2B,CAAC;AAuCnC;;;;mEAImE;AACnE,MAAM,WAAW,YAAa,SAAQ,eAAe;IACjD,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,MAAM,CAAC;IACjB,gBAAgB,EAAE,OAAO,CAAC;IAC1B,aAAa,EAAE,OAAO,CAAC;IACvB,WAAW,EAAE,KAAK,CAAC;QAAE,EAAE,EAAE,MAAM,CAAC;QAAC,QAAQ,EAAE,MAAM,CAAC;QAAC,QAAQ,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAC;QAAC,SAAS,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;IACxG,MAAM,EAAE,OAAO,CAAC;IAChB,WAAW,EAAE,MAAM,CAAC;IACpB,UAAU,EAAE,MAAM,CAAC;IACnB,eAAe,EAAE,MAAM,CAAC;IACxB,mBAAmB,EAAE,MAAM,CAAC;IAC5B,mBAAmB,EAAE,MAAM,CAAC;IAC5B,uBAAuB,EAAE,OAAO,CAAC;IACjC,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,EAAE,OAAO,CAAC;CACtB;AAED,qBAAa,KAAK;IAsDV;;;;sDAIkD;aAClC,EAAE,EAAE,OAAO;IAC3B;uEACmE;aACnD,SAAS,EAAE,gBAAgB;IAC3C;;;iEAG6D;aAC7C,GAAG,EAAE,QAAQ;IAxDjC,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,mBAAmB,CAAO;IAClD,OAAO,CAAC,SAAS,CAAmC;IACpD,OAAO,CAAC,YAAY;IAQpB,OAAO,CAAC,YAAY;IAiBpB,OAAO,CAAC,eAAe,CAAoB;IAC3C,OAAO,CAAC,cAAc,CAAoB;IAC1C,OAAO,CAAC,kBAAkB;IAI1B,OAAO,CAAC,iBAAiB;IAIzB,sBAAsB,IAAI,IAAI;;IAM1B;;;;sDAIkD;IAClC,EAAE,EAAE,OAAO;IAC3B;uEACmE;IACnD,SAAS,EAAE,gBAAgB;IAC3C;;;iEAG6D;IAC7C,GAAG,GAAE,QAAmB;IAM5C;;;6DAGyD;IACzD,WAAW,IAAI;QAAE,EAAE,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAC;QAAC,QAAQ,EAAE,MAAM,CAAA;KAAE,EAAE;IAM9E,UAAU,CAAC,SAAS,EAAE,MAAM,GAAG,GAAG,EAAE;IAIpC;;;uEAGmE;IACnE,iBAAiB,CAAC,SAAS,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,GAAG;QAAE,EAAE,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAA;KAAE,GAAG,IAAI;IAW7F;;4CAEwC;IACxC,kBAAkB,CAAC,SAAS,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM,GAAG,eAAe,GAAG,IAAI;IAK7F,iEAAiE;IACjE,WAAW,CAAC,KAAK,EAAE,YAAY,GAAG,WAAW,CAAC,eAAe,CAAC;IAI9D,mEAAmE;IACnE,eAAe,CAAC,IAAI,SAAI,EAAE,QAAQ,SAAK,GAAG,WAAW,CAAC,eAAe,CAAC;IAItE,sEAAsE;IACtE,cAAc,CAAC,KAAK,EAAE,MAAM,EAAE,IAAI,SAAI,EAAE,QAAQ,SAAK,EAAE,SAAS,CAAC,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM,EAAE,gBAAgB,UAAQ,GAAG,WAAW,CAAC,eAAe,CAAC;IAMrJ;;;;;;;sEAOkE;IAC5D,UAAU,CAAC,SAAS,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,WAAW,EAAE,OAAO,EAAE,QAAQ,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,GAAG,IAAI,CAAC;IAqMvH,iBAAiB,CAAC,SAAS,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,GAAG,EAAE;IAIzE,QAAQ,CAAC,SAAS,EAAE,MAAM,EAAE,gBAAgB,UAAQ,GAAG,GAAG,EAAE;IAI5D,cAAc,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,SAAK,GAAG,GAAG,EAAE;IAIhD,YAAY,CAAC,KAAK,EAAE,MAAM,EAAE,IAAI,SAAI,EAAE,QAAQ,SAAM,GAAG,GAAG;IAM1D;;;;;;;;OAQG;IACH,WAAW,CAAC,SAAS,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,IAAI;IAapF;;;;;;;;;;OAUG;IACH,WAAW,CAAC,SAAS,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,EAAE,cAAc,EAAE,MAAM,GAAG,OAAO;IA2BlG;;;;;;OAMG;IACH,YAAY,CAAC,SAAS,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,aAAa,EAAE,MAAM,GAAG,IAAI,GAAG,gBAAgB,GAAG,UAAU;IAkC3H;;iDAE6C;IAC7C,eAAe,CAAC,SAAS,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,aAAa,EAAE,MAAM,EAAE,gBAAgB,EAAE,MAAM,GAAG,OAAO;CAqB5G"}