dsh-builtin-browser 0.1.23 → 0.2.0

package/lib/browser-electron/provider.js

@@ -10,6 +10,8 @@ import { randomUUID } from 'node:crypto';
 import { existsSync, mkdirSync, writeFileSync } from 'node:fs';
 import { homedir } from 'node:os';
 import { dirname, isAbsolute, join, resolve, sep } from 'node:path';
+import { HistoryStore } from './history-store.js';
+import { paintCursor } from './virtual-cursor.js';
 import { BrowserError } from '../browser/types.js';
 /**
  * Page-context human-verification (CAPTCHA / bot-detection) detection. Runs
@@ -135,6 +137,13 @@ export class ElectronBrowserProvider {
     snapshotMaxElements;
     contentMaxChars;
     downloadDir;
+    /**
+     * Persistent browsing history, or `undefined` when the user turned it off.
+     * Sessions come and go; this record outlives all of them.
+     */
+    historyStore;
+    /** Live settings source; absent when nothing owns a settings document. */
+    settingsSource;
     constructor(host, config = {}) {
         this.host = host;
         this.httpOnly = config.httpOnly ?? true;
@@ -146,9 +155,21 @@ export class ElectronBrowserProvider {
         // sandbox does not have to arbitrate. The localized name is probed so a
         // Chinese desktop (`~/下载`) works without configuring `downloadDir`.
         this.downloadDir = config.downloadDir ?? defaultDownloadDir();
+        this.settingsSource = config.settings;
+        // Browsing history follows the browser profile's persistence rules (close
+        // the interface, lose nothing), and can be switched off from settings.
+        this.historyStore = config.history?.enabled === false
+            ? undefined
+            : new HistoryStore(config.history?.file, {
+                ...config.history?.maxEntries !== undefined ? { maxEntries: config.history.maxEntries } : {},
+                ...config.history?.maxAgeDays !== undefined ? { maxAgeDays: config.history.maxAgeDays } : {},
+            });
         // Route toolbar (host UI) actions into the session model: the human and
         // the agent then always drive the same tabs, history, and navigation.
         this.host.onUserAction?.(action => { void this.handleUserAction(action); });
+        // A window the human closed ends the session it showed: the next call opens a
+        // clean one instead of driving a page nobody can see.
+        this.host.onViewClosed?.(windowId => { void this.handleViewClosed(windowId); });
     }
     /**
      * Usable when the host says it can back views (the self-hosted host probes
@@ -313,6 +334,7 @@ export class ElectronBrowserProvider {
             // NEXT observation sees, not whether this action happened).
             this.record(s, 'navigate', { url }, true);
             await this.settleDocument(handle, before, signal);
+            this.recordVisit(s, handle);
             this.showActive(s);
         }
         catch (error) {
@@ -951,6 +973,9 @@ export class ElectronBrowserProvider {
         catch (error) {
             throw new BrowserError(`browser: click failed: ${String(error)}`, 'BROWSER_CLICK_FAILED', { cause: error });
         }
+        // Paint before the press so the ripple is already on screen when the click
+        // lands — the cursor exists to show the human WHERE the agent acts.
+        this.showCursor(handle, x, y, 'click');
         const release = () => {
             void handle
                 .sendCommand('Input.dispatchMouseEvent', {
@@ -997,7 +1022,11 @@ export class ElectronBrowserProvider {
         el.focus()
         return { ok: true }
       `);
-            await this.runTargetScript(this.activeTab(s), script, locateMs, signal, 'BROWSER_TYPE_FAILED', 'browser: type');
+            const locateTab = this.activeTab(s);
+            const out = await this.runTargetScript(locateTab, script, locateMs, signal, 'BROWSER_TYPE_FAILED', 'browser: type');
+            const cursorPoint = scriptPoint(out);
+            if (cursorPoint !== undefined)
+                this.showCursor(locateTab.handle, cursorPoint.x, cursorPoint.y, 'click');
         }
         const text = 'text' in request ? request.text : '';
         const timeoutMs = 30_000;
@@ -1067,6 +1096,7 @@ export class ElectronBrowserProvider {
         await withTimeout(handle.sendCommand('Page.navigateToHistoryEntry', { entryId: entry.id }), timeoutMs, signal, `browser: history navigation timed out after ${timeoutMs}ms`, () => { void handle.sendCommand('Page.stopLoading').catch(() => { }); });
         this.record(s, direction === -1 ? 'back' : 'forward', {}, true);
         await this.settleDocument(handle, before, signal);
+        this.recordVisit(s, handle);
         this.showActive(s);
     }
     /** Go back in the active tab's history. */
@@ -1091,6 +1121,7 @@ export class ElectronBrowserProvider {
         () => { void handle.sendCommand('Page.stopLoading').catch(() => { }); });
         this.record(s, 'reload', {}, true);
         await this.settleDocument(handle, before, signal);
+        this.recordVisit(s, handle);
         this.showActive(s);
     }
     /** Press one named key (Enter/Tab/arrows/…) via CDP key events. */
@@ -1332,7 +1363,18 @@ export class ElectronBrowserProvider {
         if (Date.now() >= deadline) return { ok: false, error: 'element not found: ' + JSON.stringify(spec) + ' (looked for ' + timeoutMs + 'ms)' }
         await sleep(100)
       }
+      const __result = await (async () => {
       ${body}
+      })()
+      // Report the operated element's viewport center next to the script's own
+      // verdict: the synthetic cursor (and any future feedback) needs the point,
+      // and no individual body should have to compute it a second time. Kept
+      // under a distinct key so a body that already returns x/y keeps them.
+      const __rect = el.getBoundingClientRect()
+      return {
+        ...(typeof __result === 'object' && __result !== null ? __result : { ok: true }),
+        __point: { x: Math.round(__rect.x + __rect.width / 2), y: Math.round(__rect.y + __rect.height / 2) },
+      }
     })()`;
     }
     /**
@@ -1397,6 +1439,9 @@ export class ElectronBrowserProvider {
     `;
         const script = this.buildTargetScript(request.target, timeoutMs, body);
         const out = await this.runTargetScript(tab, script, timeoutMs, signal, 'BROWSER_SET_VALUE_FAILED', 'browser: setValue');
+        const cursorPoint = scriptPoint(out);
+        if (cursorPoint !== undefined)
+            this.showCursor(tab.handle, cursorPoint.x, cursorPoint.y, 'click');
         this.record(s, 'setValue', { target: request.target, value: String(request.value) }, true, { result: out.method });
         return { method: out.method, value: out.value };
     }
@@ -1422,6 +1467,9 @@ export class ElectronBrowserProvider {
     `;
         const script = this.buildTargetScript(request.target, timeoutMs, body);
         const out = await this.runTargetScript(tab, script, timeoutMs, signal, 'BROWSER_CHECK_FAILED', 'browser: check');
+        const cursorPoint = scriptPoint(out);
+        if (cursorPoint !== undefined)
+            this.showCursor(tab.handle, cursorPoint.x, cursorPoint.y, 'click');
         this.record(s, 'check', { target: request.target, checked: want }, true);
         return { checked: out.checked === true };
     }
@@ -1453,6 +1501,9 @@ export class ElectronBrowserProvider {
     `;
         const script = this.buildTargetScript(request.target, timeoutMs, body);
         const out = await this.runTargetScript(tab, script, timeoutMs, signal, 'BROWSER_SELECT_FAILED', 'browser: select');
+        const cursorPoint = scriptPoint(out);
+        if (cursorPoint !== undefined)
+            this.showCursor(tab.handle, cursorPoint.x, cursorPoint.y, 'click');
         this.record(s, 'select', { target: request.target, optionValue: request.optionValue ?? null, optionText: request.optionText ?? null, optionIndex: request.optionIndex ?? null }, true);
         return { value: out.value, text: out.text };
     }
@@ -1485,7 +1536,10 @@ export class ElectronBrowserProvider {
       return { ok: true }
     `;
         const script = this.buildTargetScript(request.target, timeoutMs, body);
-        await this.runTargetScript(tab, script, timeoutMs, signal, 'BROWSER_CLEAR_FAILED', 'browser: clear');
+        const out = await this.runTargetScript(tab, script, timeoutMs, signal, 'BROWSER_CLEAR_FAILED', 'browser: clear');
+        const cursorPoint = scriptPoint(out);
+        if (cursorPoint !== undefined)
+            this.showCursor(tab.handle, cursorPoint.x, cursorPoint.y, 'click');
         this.record(s, 'clear', { target: request.target }, true);
         return { cleared: true };
     }
@@ -1775,6 +1829,62 @@ export class ElectronBrowserProvider {
     async history(session) {
         return this.session(session).history;
     }
+    /**
+     * Record one page visit in the persistent browsing history. Fire-and-forget by
+     * design: a visit must never delay or fail the navigation that produced it,
+     * and the title is only worth reading once the document has settled.
+     * @param s - the session that drove the visit.
+     * @param handle - the view whose document just loaded.
+     */
+    recordVisit(s, handle) {
+        const store = this.historyStore;
+        if (store === undefined)
+            return;
+        // The settings panel can switch recording off at runtime; the static config
+        // only supplies the startup default.
+        if (this.settingsSource !== undefined && !this.settingsSource().history.enabled)
+            return;
+        void handleSendEvaluate(handle, 'location.href + "\\u0000" + (document.title || "")')
+            .then(result => {
+            if (!result.ok || typeof result.value !== 'string')
+                return;
+            const [url = '', title = ''] = result.value.split('\u0000');
+            // Internal documents are not visits: an untouched browser is not history.
+            if (url === '' || url.startsWith('about:') || url.startsWith('devtools:'))
+                return;
+            store.append({
+                at: Date.now(),
+                url,
+                ...title.trim() !== '' ? { title: title.trim() } : {},
+                ...s.label !== undefined ? { session: s.label } : {},
+            });
+            store.prune();
+        })
+            .catch(() => { });
+    }
+    /**
+     * List persisted visits, newest first — what `browser_visited` reads back.
+     * @param options - result cap and an optional hostname filter.
+     * @returns the matching visits, or an empty list when history is disabled.
+     */
+    visited(options = {}) {
+        return this.historyStore?.list(options) ?? [];
+    }
+    /**
+     * Show the synthetic pointer on a view, unless the user switched it off. The
+     * cursor is the "the agent has taken over this tab" signal, so it is painted
+     * for every operation that has a landing point — including DOM-level ones that
+     * move no real pointer.
+     * @param handle - the view to paint into.
+     * @param x - viewport x in CSS pixels.
+     * @param y - viewport y in CSS pixels.
+     * @param action - click pulses a ripple; move only relocates.
+     */
+    showCursor(handle, x, y, action) {
+        if (this.settingsSource !== undefined && !this.settingsSource().ui.virtualCursor)
+            return;
+        paintCursor(handle, x, y, action, (target, expression) => handleSendEvaluate(target, expression));
+    }
     /**
      * Replay one recorded operation by sequence number. Navigate/click/type are
      * re-issued against the current page; execute re-runs its script. The
@@ -1888,6 +1998,29 @@ export class ElectronBrowserProvider {
     tabByViewId(s, viewId) {
         return s.tabs.find(tab => tab.handle.id === viewId);
     }
+    /**
+     * Whether a session is still live. The human closing a window ends its session
+     * (see {@link handleViewClosed}), so callers that cache ids must ask first.
+     * @param session - the session id to test.
+     */
+    exists(session) {
+        return this.sessions.has(session);
+    }
+    /**
+     * The human closed a browser window: the session that window showed is over.
+     * Ending it here is what makes the next call a clean start rather than a
+     * resurrection of an invisible window. Browsing history and login state live
+     * on disk, so nothing the human cares about is lost with it.
+     * @param windowId - the group key the host reported, which is the session id.
+     */
+    async handleViewClosed(windowId) {
+        if (typeof windowId !== 'string' || windowId === '')
+            return;
+        const s = this.sessions.get(windowId);
+        if (s === undefined)
+            return;
+        await this.close(s.id).catch(() => { });
+    }
     /**
      * Route a user-initiated action from the host's UI into the session model.
      * Fire-and-forget by design: a user action failing (e.g. an unreachable
@@ -2079,6 +2212,13 @@ function terminatePage(handle) {
  * @param expression - the JS expression.
  * @param signal - optional abort signal; a fired signal rejects the call.
  */
+/** Viewport point a target script reported, when it reported one. */
+function scriptPoint(out) {
+    const point = out?.__point;
+    const x = Number(point?.x);
+    const y = Number(point?.y);
+    return Number.isFinite(x) && Number.isFinite(y) ? { x, y } : undefined;
+}
 async function handleSendEvaluate(handle, expression, signal) {
     signal?.throwIfAborted();
     const result = await handle.sendCommand(CDP_RUNTIME_EVALUATE, {

package/lib/browser-electron/remote-host.d.ts

@@ -118,6 +118,12 @@ export declare class RemoteElectronViewHost implements ElectronBrowserViewHost {
     private readonly groups;
     /** The provider's user-action handler; routes toolbar actions into sessions. */
     private userActionHandler;
+    /**
+     * The provider's handler for a window the human closed. Closing the interface
+     * ends the session it showed: history and login state stay on disk, so the
+     * next open starts clean instead of resuming a window nobody can see.
+     */
+    private viewClosedHandler;
     constructor(hostMainPath: string, 
     /** Test seam: the executable to spawn instead of the resolved Electron
      *  binary. Absent -> resolveElectronPath() (production behavior). */
@@ -167,6 +173,8 @@ export declare class RemoteElectronViewHost implements ElectronBrowserViewHost {
     groupView(handle: ElectronViewHandle, windowId: string, label?: string): void;
     /** Register the provider's handler for user-initiated toolbar actions. */
     onUserAction(handler: (action: BrowserUserAction) => void): void;
+    /** Register the provider's handler for windows the human closed. */
+    onViewClosed(handler: (windowId: string) => void): void;
     /** Surface a failed user action to the child's toolbar (address bar etc.). */
     notifyUserActionError(windowId: string, message: string): void;
     destroyView(handle: ElectronViewHandle): void;

package/lib/browser-electron/remote-host.js

@@ -374,6 +374,7 @@ class ElectronChildClient {
     token;
     onExit;
     onUserAction;
+    onViewClosed;
     executable;
     child;
     pending = new Map();
@@ -392,6 +393,12 @@ class ElectronChildClient {
     awaitingHello = true;
     helloTimer;
     constructor(hostMainPath, port, token, onExit, onUserAction, 
+    /**
+     * Called when the human closes a browser window. The session it showed is
+     * over: the provider releases it, while history and login state stay on disk
+     * so the next open is a clean session rather than a resurrected one.
+     */
+    onViewClosed, 
     /** Test seam: the executable to spawn instead of the resolved Electron
      *  binary. Absent -> resolveElectronPath() (production behavior). */
     executable) {
@@ -400,9 +407,18 @@ class ElectronChildClient {
         this.token = token;
         this.onExit = onExit;
         this.onUserAction = onUserAction;
+        this.onViewClosed = onViewClosed;
         this.executable = executable;
         const electron = this.executable ?? resolveElectronPath();
+        // Record what is about to be spawned — with existence checks — BEFORE the
+        // attempt. When Electron cannot load the app entry it exits 1 with EMPTY
+        // stderr, and that signature is otherwise indistinguishable from a missing
+        // binary: writing both paths (and whether they exist) in advance is what
+        // turns the next occurrence into a named cause instead of a guess.
         process.stderr.write(`[dsh-browser host] spawning electron: ${electron}\n`);
+        appendHostLog(`${hostStamp()} spawning: electron=${electron} (exists=${String(existsSync(electron))})`
+            + ` hostMain=${this.hostMainPath} (exists=${String(existsSync(this.hostMainPath))})`
+            + ` port=${String(this.port)}\n`);
         // ELECTRON_RUN_AS_NODE (even an empty string) makes Electron run as plain
         // Node, breaking require('electron'); NODE_OPTIONS can inject flags that
         // break the child. Rebuild the env without either.
@@ -439,15 +455,26 @@ class ElectronChildClient {
         // A failed spawn (bad/corrupt binary) emits 'error' — without a listener
         // that would crash the whole DSH process.
         this.child.on('error', error => {
-            const line = `spawn error: ${String(error)}`;
+            const line = `${hostStamp()} spawn error: ${String(error)} electron=${electron} hostMain=${this.hostMainPath}`;
             process.stderr.write(`[dsh-browser host] ${line}\n`);
             appendHostLog(`${line}\n`);
             this.fail(new Error(`dsh-builtin-browser: browser host failed to start: ${String(error)}`));
         });
         this.child.on('exit', (code, signal) => {
             // The exit code/signal is the other half of a crash report; without it a
-            // restart loop is indistinguishable from a clean stop.
-            const line = `browser host exited (code=${String(code)} signal=${String(signal)})`;
+            // restart loop is indistinguishable from a clean stop. The timestamp, pid
+            // and both paths are what turn a bare `code=1` into a diagnosis: Electron
+            // exits 1 with empty stderr precisely when it cannot load the app entry,
+            // so the dated `exists=` line written at spawn is the other half.
+            const entryExists = existsSync(this.hostMainPath);
+            const line = `${hostStamp()} browser host exited (code=${String(code)} signal=${String(signal)})`
+                + ` pid=${String(this.child?.pid)} electron=${electron} hostMain=${this.hostMainPath}`
+                + ` entryExists=${String(entryExists)}`
+                // Comparing this with the `exists=` recorded at spawn is the whole
+                // diagnosis: present at spawn and absent now means the installation was
+                // replaced underneath a running host, which is exactly how Electron ends
+                // up unable to load the app entry and exits 1 with empty stderr.
+                + (entryExists ? '' : ' [entry script missing at exit]');
             appendHostLog(`${line}\n`);
             this.fail(new Error(`dsh-builtin-browser: ${line}`));
         });
@@ -537,6 +564,14 @@ class ElectronChildClient {
                 this.onUserAction?.(msg.action);
                 continue;
             }
+            if (msg.op === 'viewClosed') {
+                // Fire-and-forget notification from the child's own UI: the human closed
+                // the window, so the interface that session showed is gone. The provider
+                // decides what that ends — browsing history and login state survive on
+                // disk, only the session itself does not.
+                this.onViewClosed?.(typeof msg.windowId === 'string' ? msg.windowId : '');
+                continue;
+            }
             if (this.awaitingHello) {
                 // The FIRST line must be the child's hello carrying the spawn token.
                 // Anything else (or a wrong token) means a spoofed connection: drop
@@ -681,6 +716,12 @@ export class RemoteElectronViewHost {
     groups = new Map();
     /** The provider's user-action handler; routes toolbar actions into sessions. */
     userActionHandler;
+    /**
+     * The provider's handler for a window the human closed. Closing the interface
+     * ends the session it showed: history and login state stay on disk, so the
+     * next open starts clean instead of resuming a window nobody can see.
+     */
+    viewClosedHandler;
     constructor(hostMainPath, 
     /** Test seam: the executable to spawn instead of the resolved Electron
      *  binary. Absent -> resolveElectronPath() (production behavior). */
@@ -787,7 +828,7 @@ export class RemoteElectronViewHost {
         // Random per-spawn token: the child must prove knowledge of it (via
         // stdin hello) before any command is written to the socket.
         const token = randomBytes(24).toString('hex');
-        this.client = new ElectronChildClient(this.hostMainPath, port, token, () => this.onChildExit(), action => this.userActionHandler?.(action), this.spawnExecutable);
+        this.client = new ElectronChildClient(this.hostMainPath, port, token, () => this.onChildExit(), action => this.userActionHandler?.(action), windowId => this.viewClosedHandler?.(windowId), this.spawnExecutable);
         if (this.pendingSocket !== undefined) {
             this.client.attach(this.pendingSocket);
             this.pendingSocket = undefined;
@@ -916,6 +957,10 @@ export class RemoteElectronViewHost {
     onUserAction(handler) {
         this.userActionHandler = handler;
     }
+    /** Register the provider's handler for windows the human closed. */
+    onViewClosed(handler) {
+        this.viewClosedHandler = handler;
+    }
     /** Surface a failed user action to the child's toolbar (address bar etc.). */
     notifyUserActionError(windowId, message) {
         void this.ready()
@@ -1028,6 +1073,15 @@ class DeferredRemoteView {
  * gets large (a crash loop writes quickly).
  */
 const HOST_LOG_MAX_BYTES = 2 * 1024 * 1024;
+/**
+ * ISO timestamp prefix for host-log lines. This log is the only place a spawn
+ * failure is recorded, and an undated line cannot be lined up with anything else
+ * that happened on the machine — a plugin update replacing the entry script, for
+ * instance — which is precisely the question this log gets asked.
+ */
+function hostStamp() {
+    return new Date().toISOString();
+}
 function appendHostLog(text) {
     const home = process.env.DSH_HOME;
     if (home === undefined || home === '')
@@ -1036,8 +1090,12 @@ function appendHostLog(text) {
         const dir = join(home, 'logs');
         const file = join(dir, 'dsh-builtin-browser-host.log');
         try {
-            if (statSync(file).size > HOST_LOG_MAX_BYTES)
-                writeFileSync(file, '');
+            if (statSync(file).size > HOST_LOG_MAX_BYTES) {
+                // Discard the old bytes but leave a dated marker: truncating to empty
+                // makes a rotation look like "nothing ever happened", which is how the
+                // history of a crash loop gets silently swallowed.
+                writeFileSync(file, `${hostStamp()} log rotated: previous content exceeded ${String(HOST_LOG_MAX_BYTES)} bytes and was discarded\n`);
+            }
         }
         catch { /* first write, or unreadable: just append */ }
         mkdirSync(dir, { recursive: true });

package/lib/browser-electron/settings-store.d.ts

@@ -0,0 +1,87 @@
+/**
+ * Plugin-owned settings document — the switches the browser settings panel
+ * exposes, stored next to the browsing history so both follow the same rules:
+ * they survive the browser process and DSH restarts.
+ *
+ * Every field is optional on disk and falls back to a default, so a hand-edited
+ * or older file never breaks startup; an unreadable file is treated as "all
+ * defaults" rather than an error.
+ * @module dsh-browser/browser-electron/settings-store
+ */
+/** Vision/operation strategy the provider prefers when the model can see. */
+export type VisionStrategy = 'auto' | 'nonVisual';
+/** The full settings document, with every field resolved. */
+export interface BrowserSettings {
+    /** Persistent browsing history (visited pages). */
+    readonly history: {
+        readonly enabled: boolean;
+        readonly maxEntries: number;
+        readonly maxAgeDays: number;
+    };
+    /** Login-state retention: cookies and the browser profile. */
+    readonly cookies: {
+        readonly persist: boolean;
+    };
+    /** Presentation behaviour. */
+    readonly ui: {
+        /** Auto-expand the side panel once per task, then leave the user alone. */
+        readonly autoExpandOnce: boolean;
+        /** Release the browser when its session ends, instead of waiting for a close. */
+        readonly closeWithSession: boolean;
+        /** Show the synthetic cursor/click feedback while the agent operates. */
+        readonly virtualCursor: boolean;
+    };
+    /** Visual vs non-visual operation strategy. */
+    readonly vision: {
+        readonly strategy: VisionStrategy;
+    };
+    /** Whether the agent may read cookies / export login state. */
+    readonly credentials: {
+        readonly allowRead: boolean;
+    };
+}
+/** Defaults for every switch: the documented out-of-the-box behaviour. */
+export declare const DEFAULT_SETTINGS: BrowserSettings;
+/**
+ * Absolute path of the settings file, beside the browser profile and the
+ * browsing history.
+ * @returns the settings file path.
+ */
+export declare function settingsPath(): string;
+/**
+ * Resolve a raw settings document (already parsed, shape unknown) into the full
+ * document, field by field. Unknown keys are dropped: the file is not a place to
+ * smuggle configuration.
+ * @param raw - the parsed file contents.
+ * @returns the resolved settings.
+ */
+export declare function resolveSettings(raw: unknown): BrowserSettings;
+/**
+ * File-backed settings with an in-memory snapshot. Reads re-stat the file so an
+ * edit from another process (or the settings panel writing through a second
+ * code path) is picked up without a restart; writes are atomic enough for a
+ * single-writer plugin and never throw at the caller.
+ */
+export declare class SettingsStore {
+    private readonly file;
+    private cached;
+    /** Last observed mtime, used to invalidate the cache on external edits. */
+    private cachedMtimeMs;
+    /**
+     * @param file - settings file path (defaults beside the browser profile).
+     */
+    constructor(file?: string);
+    /** Path this store reads and writes. */
+    path(): string;
+    /**
+     * Current settings, re-read when the file changed on disk.
+     * @returns the resolved settings document.
+     */
+    get(): BrowserSettings;
+    /**
+     * Merge a partial patch into the stored document and persist it.
+     * @param patch - the fields to change (unknown keys are ignored).
+     * @returns the settings after the merge.
+     */
+    update(patch: unknown): BrowserSettings;
+}

package/lib/browser-electron/settings-store.js

@@ -0,0 +1,160 @@
+/**
+ * Plugin-owned settings document — the switches the browser settings panel
+ * exposes, stored next to the browsing history so both follow the same rules:
+ * they survive the browser process and DSH restarts.
+ *
+ * Every field is optional on disk and falls back to a default, so a hand-edited
+ * or older file never breaks startup; an unreadable file is treated as "all
+ * defaults" rather than an error.
+ * @module dsh-browser/browser-electron/settings-store
+ */
+import { existsSync, mkdirSync, readFileSync, statSync, writeFileSync } from 'node:fs';
+import { homedir } from 'node:os';
+import { dirname, join } from 'node:path';
+/** Defaults for every switch: the documented out-of-the-box behaviour. */
+export const DEFAULT_SETTINGS = {
+    history: { enabled: true, maxEntries: 5_000, maxAgeDays: 90 },
+    cookies: { persist: true },
+    ui: { autoExpandOnce: true, closeWithSession: false, virtualCursor: true },
+    vision: { strategy: 'auto' },
+    credentials: { allowRead: true },
+};
+/**
+ * Absolute path of the settings file, beside the browser profile and the
+ * browsing history.
+ * @returns the settings file path.
+ */
+export function settingsPath() {
+    const home = process.env.DSH_HOME ?? join(homedir(), '.dsh');
+    return join(home, 'dsh-builtin-browser-host', 'settings.json');
+}
+/** Coerce one boolean field, keeping the default when absent or mistyped. */
+function bool(value, fallback) {
+    return typeof value === 'boolean' ? value : fallback;
+}
+/** Coerce one positive-integer field, keeping the default when invalid. */
+function count(value, fallback) {
+    return typeof value === 'number' && Number.isFinite(value) && value > 0 ? Math.floor(value) : fallback;
+}
+/** Read one nested section of an unknown document, or an empty object. */
+function section(source, key) {
+    const value = source[key];
+    return typeof value === 'object' && value !== null ? value : {};
+}
+/**
+ * Resolve a raw settings document (already parsed, shape unknown) into the full
+ * document, field by field. Unknown keys are dropped: the file is not a place to
+ * smuggle configuration.
+ * @param raw - the parsed file contents.
+ * @returns the resolved settings.
+ */
+export function resolveSettings(raw) {
+    const source = typeof raw === 'object' && raw !== null ? raw : {};
+    const history = section(source, 'history');
+    const cookies = section(source, 'cookies');
+    const ui = section(source, 'ui');
+    const vision = section(source, 'vision');
+    const credentials = section(source, 'credentials');
+    return {
+        history: {
+            enabled: bool(history.enabled, DEFAULT_SETTINGS.history.enabled),
+            maxEntries: count(history.maxEntries, DEFAULT_SETTINGS.history.maxEntries),
+            maxAgeDays: count(history.maxAgeDays, DEFAULT_SETTINGS.history.maxAgeDays),
+        },
+        cookies: { persist: bool(cookies.persist, DEFAULT_SETTINGS.cookies.persist) },
+        ui: {
+            autoExpandOnce: bool(ui.autoExpandOnce, DEFAULT_SETTINGS.ui.autoExpandOnce),
+            closeWithSession: bool(ui.closeWithSession, DEFAULT_SETTINGS.ui.closeWithSession),
+            virtualCursor: bool(ui.virtualCursor, DEFAULT_SETTINGS.ui.virtualCursor),
+        },
+        vision: { strategy: vision.strategy === 'nonVisual' ? 'nonVisual' : DEFAULT_SETTINGS.vision.strategy },
+        credentials: { allowRead: bool(credentials.allowRead, DEFAULT_SETTINGS.credentials.allowRead) },
+    };
+}
+/**
+ * File-backed settings with an in-memory snapshot. Reads re-stat the file so an
+ * edit from another process (or the settings panel writing through a second
+ * code path) is picked up without a restart; writes are atomic enough for a
+ * single-writer plugin and never throw at the caller.
+ */
+export class SettingsStore {
+    file;
+    cached;
+    /** Last observed mtime, used to invalidate the cache on external edits. */
+    cachedMtimeMs = -1;
+    /**
+     * @param file - settings file path (defaults beside the browser profile).
+     */
+    constructor(file = settingsPath()) {
+        this.file = file;
+    }
+    /** Path this store reads and writes. */
+    path() {
+        return this.file;
+    }
+    /**
+     * Current settings, re-read when the file changed on disk.
+     * @returns the resolved settings document.
+     */
+    get() {
+        let mtimeMs = -1;
+        let text;
+        try {
+            if (existsSync(this.file)) {
+                mtimeMs = statSync(this.file).mtimeMs;
+                text = readFileSync(this.file, 'utf8');
+            }
+        }
+        catch {
+            // Unreadable file: fall through to defaults below.
+            mtimeMs = -1;
+            text = undefined;
+        }
+        if (this.cached !== undefined && mtimeMs === this.cachedMtimeMs)
+            return this.cached;
+        try {
+            this.cached = text === undefined ? DEFAULT_SETTINGS : resolveSettings(JSON.parse(text));
+        }
+        catch {
+            // Malformed JSON: behave as defaults rather than fail startup.
+            this.cached = DEFAULT_SETTINGS;
+        }
+        this.cachedMtimeMs = mtimeMs;
+        return this.cached;
+    }
+    /**
+     * Merge a partial patch into the stored document and persist it.
+     * @param patch - the fields to change (unknown keys are ignored).
+     * @returns the settings after the merge.
+     */
+    update(patch) {
+        const current = this.get();
+        const merged = resolveSettings(deepMerge(current, patch));
+        try {
+            mkdirSync(dirname(this.file), { recursive: true });
+            writeFileSync(this.file, `${JSON.stringify(merged, null, 2)}\n`);
+        }
+        catch {
+            // Keep the merged value in memory even when the write fails.
+        }
+        this.cached = merged;
+        this.cachedMtimeMs = Date.now();
+        return merged;
+    }
+}
+/** One-level-deep merge over the settings sections (patch wins). */
+function deepMerge(base, patch) {
+    if (typeof patch !== 'object' || patch === null)
+        return base;
+    const result = { ...base };
+    for (const [key, value] of Object.entries(patch)) {
+        const existing = result[key];
+        if (typeof value === 'object' && value !== null && typeof existing === 'object' && existing !== null) {
+            result[key] = { ...existing, ...value };
+        }
+        else {
+            result[key] = value;
+        }
+    }
+    return result;
+}