@bobfrankston/rmfmail 1.1.3 → 1.1.5

package/packages/mailx-service/index.ts

@@ -13,7 +13,7 @@ const __dirname = import.meta.dirname;
 import { ImapManager } from "@bobfrankston/mailx-imap";
 import * as gsync from "./google-sync.js";
 import { sniffAndFixCharset } from "./charset.js";
-import { LocalStore } from "./local-store.js";
+import { Store } from "@bobfrankston/mailx-store";
 import { SyncQueue } from "./sync-queue.js";
 import { Reconciler } from "./reconciler.js";
 import { loadSettings, saveSettings, loadAccounts, loadAccountsAsync, saveAccounts, initCloudConfig, loadAllowlist, saveAllowlist, loadAutocomplete, saveAutocomplete, loadKeys, saveKeys, ensureKeysSectionExists, getStorePath, getStorageInfo, getConfigDir, loadUserDict, saveUserDict } from "@bobfrankston/mailx-settings";
@@ -135,7 +135,7 @@ export class MailxService implements MailxApi {
     /** Local-first read/write facade. Every UI IPC handler that touches the
      *  local DB or body store goes through this — no awaiting IMAP, no
      *  awaiting Gmail API, no awaiting SMTP. See docs/local-first-plan.md. */
-    private localStore: LocalStore;
+    private localStore: Store;
 
     /** Persistent (and in-memory body-fetch) queue. UI handlers commit
      *  locally, then enqueue a server-mirror task here. */
@@ -146,20 +146,21 @@ export class MailxService implements MailxApi {
     private reconciler: Reconciler;
 
     constructor(
-        private db: MailxDB,
+        /** The Store is the nexus — owns DB + .eml files + bus + operations.
+         *  MailxService is the IPC adapter on top: it routes UI requests to
+         *  Store reads/writes and to the SyncQueue/Reconciler for server-
+         *  mirror work. The raw `db` getter below is a transitional shim so
+         *  the ~50 `this.db.X(...)` callsites in this file don't all need
+         *  touching at once; all writes should migrate to `this.localStore.X(...)`. */
+        private store: Store,
         private imapManager: ImapManager,
     ) {
-        this.localStore = new LocalStore(db, imapManager.getBodyStore());
-        this.syncQueue = new SyncQueue(db, imapManager);
-        this.reconciler = new Reconciler(db, imapManager, this.syncQueue);
+        this.localStore = store;
+        this.syncQueue = new SyncQueue(store.db, imapManager);
+        this.reconciler = new Reconciler(store.db, imapManager, this.syncQueue);
         this.reconciler.start();
 
         // Invalidate caches when their source files change on disk / GDrive.
-        // configChanged fires for any *.jsonc the watcher tracks (accounts,
-        // preferences, allowlist, etc.); broadly invalidate settings too so
-        // a preferences edit takes effect on the next getMessage / refresh.
-        // LocalStore also caches allowlist + settings to keep .eml display
-        // off the GDrive hot path; nudge it on the same event.
         this.imapManager.on?.("configChanged", (filename: string) => {
             if (filename === "accounts.jsonc") this._accountsCache = null;
             this._settingsCache = null;
@@ -169,15 +170,15 @@ export class MailxService implements MailxApi {
                     console.error(`  [contacts] reload failed: ${e?.message || e}`));
             }
         });
-        // Wire DB → cloud flush. Debounced to absorb bursts (a sync run can
-        // call recordSentAddress hundreds of times). 30s flush window is
-        // long enough that the steady state is one cloud write per sync,
-        // short enough that quitting after a single send still flushes.
-        this.db.setOnContactsChanged(() => this.markContactsDirty());
-
+        // Wire DB → cloud flush. Debounced to absorb bursts.
+        this.store.db.setOnContactsChanged(() => this.markContactsDirty());
         // Initial load of contacts.jsonc — fire-and-forget; missing file is fine.
         this.loadContactsConfig().catch(() => { /* file may not exist yet */ });
     }
+    /** Transitional getter — direct DB access from MailxService for the
+     *  ~50 callsites that haven't yet migrated to Store methods. Future:
+     *  every mutation routes through `this.localStore.X(...)`. */
+    private get db(): MailxDB { return this.store.db; }
 
     private _contactsFlushTimer: ReturnType<typeof setTimeout> | null = null;
     private _contactsFlushInFlight = false;

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

@@ -1,147 +1,10 @@
 /**
- * LocalStore — the formal API surface for UI-bound reads and writes.
- *
- * Contract: every method here is local-only. No IMAP, no Gmail API, no
- * SMTP, no DNS, no Drive API. Methods complete in microseconds (DB reads)
- * or whatever a single local file IO takes (body reads). They never await
- * network calls.
- *
- * UI-side IPC dispatch lands here. The reconciler / sync queue is a
- * separate concern — it owns network IO and signals completed work via
- * events that the UI listens for. The two never call each other directly.
- *
- * This file is part of the local-first refactor (docs/local-first-plan.md).
- * Step 1 of that plan: introduce the facade, prove it compiles, route
- * one IPC method through it as proof-of-pattern. Subsequent steps migrate
- * remaining call sites and remove the server-fetch path from the UI.
+ * LocalStore — DEPRECATED. The Store moved to `@bobfrankston/mailx-store`
+ * (it's now the architectural nexus and lives in the package that owns
+ * the underlying DB + .eml file backend). Re-exported here only so any
+ * stale `./local-store.js` imports keep resolving while in-tree callers
+ * migrate to `import { Store } from "@bobfrankston/mailx-store"`.
  */
-import type { MailxDB, FileMessageStore, StoreBus } from "@bobfrankston/mailx-store";
-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 LocalMessage 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 LocalStore {
-    private db;
-    private bodyStore;
-    /** 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(db: MailxDB, 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<LocalMessage | 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;
-}
+export { Store as LocalStore } from "@bobfrankston/mailx-store";
+export type { StoreMessage as LocalMessage } from "@bobfrankston/mailx-store";
 //# sourceMappingURL=local-store.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"local-store.d.ts","sourceRoot":"","sources":["local-store.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;GAgBG;AAIH,OAAO,KAAK,EAAE,OAAO,EAAE,gBAAgB,EAAE,QAAQ,EAAE,MAAM,2BAA2B,CAAC;AACrF,OAAO,KAAK,EACR,eAAe,EAAW,YAAY,EAAE,WAAW,EACtD,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,UAAU;IAsDf,OAAO,CAAC,EAAE;IACV,OAAO,CAAC,SAAS;IACjB;;;iEAG6D;aAC7C,GAAG,EAAE,QAAQ;IAjDjC,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;gBAMlB,EAAE,EAAE,OAAO,EACX,SAAS,EAAE,gBAAgB;IACnC;;;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"}
+{"version":3,"file":"local-store.d.ts","sourceRoot":"","sources":["local-store.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AACH,OAAO,EAAE,KAAK,IAAI,UAAU,EAAE,MAAM,2BAA2B,CAAC;AAChE,YAAY,EAAE,YAAY,IAAI,YAAY,EAAE,MAAM,2BAA2B,CAAC"}