pi-lean-portal 0.3.3 → 0.4.0

package/README.md

@@ -115,17 +115,10 @@ toggles guide-saving mode, and manages browser profiles.
 ### Persistence
 
 The toggle state is stored in the conversation's branch history. A fresh
-conversation starts with the default from `settings.json` (`browserToggle.defaultEnabled`,
-which defaults to `true`).
-
-> ⚠️ `browserToggle.defaultEnabled` is still read today but is scheduled to be
-> replaced by the `pi-tool-masking` library's `toolsetDefaults` block in an
-> upcoming release — **that block is not read yet**, so keep the legacy key
-> until the replacement ships. See
-> [Configuration (`settings.json`)](#configuration-settingsjson) for the
-> future shape and how to pre-add it harmlessly. A migration warning fires on
-> session start once the legacy key is present and the web default hasn't yet
-> been mirrored into `toolsetDefaults`.
+conversation starts with the default from `settings.json` — the
+`pi-tool-masking` library's `toolsetDefaults` block (see
+[Configuration (`settings.json`)](#configuration-settingsjson)), falling back
+to the toolset's packaged default (`true` for `web`).
 
 ---
 
@@ -615,48 +608,30 @@ a `profile` parameter:
 }
 ```
 
-### `browserToggle.defaultEnabled` *(deprecated — not yet replaced)*
+### `toolsetDefaults` *(settings-based toolset defaults)*
 
-Whether browser tools are enabled on fresh conversations. **This key is still
-read today and works as shown.** It is *scheduled* to be replaced by the
-`pi-tool-masking` library's `toolsetDefaults` block in an upcoming release —
-**that block is not read yet**, so keep this key until the replacement ships.
+Whether browser tools are enabled on fresh conversations. Read by the
+`pi-tool-masking` library at restore time, between the chat-branch tier and
+the toolset's packaged default:
 
 ```jsonc
 {
-  "browserToggle": {
-    "defaultEnabled": true
+  "toolsetDefaults": {
+    "toolset-state:pi-lean-dimension.web": { "enabled": true },
+    "toolset-state:pi-lean-dimension.web-learn": { "enabled": false },
+    "toolset-state:pi-lean-dimension.search": { "enabled": true }
   }
 }
 ```
 
-> ⚠️ **Preparing for the offload.** Settings-based toolset defaults are being
-> offloaded to the `pi-tool-masking` library, which will read a new
-> `toolsetDefaults` block keyed by persist key. **The new block is not read
-> by the current release** — it's harmless to add now and will take effect
-> automatically once the offload ships, at which point the legacy key stops
-> being read. To pre-stage the migration, set both:
->
-> ```jsonc
-> {
->   "browserToggle": { "defaultEnabled": true },
->   "toolsetDefaults": {
->     "toolset-state:pi-lean-dimension.web": { "enabled": true },
->     "toolset-state:pi-lean-dimension.web-learn": { "enabled": false },
->     "toolset-state:pi-lean-dimension.search": { "enabled": true }
->   }
-> }
-> ```
->
-> - Keys are the toolsets' `persistKey` values (`toolset-state:<id>`).
-> - Omit a `toolsetDefaults` key to use the toolset's packaged default (`web`
->   and `search` default `true`; `web-learn` defaults `false`).
-> - The `search` key only applies when `pi-lean-search` is installed.
->
-> Once the offload ships and the legacy read is removed, delete the
-> `browserToggle` block. Until then, a migration warning fires on session
-> start when the legacy key is present and the web default hasn't yet been
-> mirrored into `toolsetDefaults`; mirroring it suppresses the warning.
+- Keys are the toolsets' `persistKey` values (`toolset-state:<id>`).
+- Omit a `toolsetDefaults` key to use the toolset's packaged default (`web`
+  and `search` default `true`; `web-learn` defaults `false`).
+- The `search` key only applies when `pi-lean-search` is installed.
+
+> The legacy `browserToggle.defaultEnabled` key is **removed in 0.4.0** — it
+> is no longer read. If you pinned it, move the value into the matching
+> `toolsetDefaults` entry above.
 
 ### `browser.maxStorageStateSize`
 

package/browser-toggle.ts

@@ -9,24 +9,12 @@ import {
 	getDefaultResolutionMode,
 } from "pi-tool-masking";
 import type { ToolsetSpec } from "pi-tool-masking";
-import { readMergedSettings } from "./core/shared/settings-reader.js";
-
-// Focus-mode guard helper. The library's published `DefaultResolutionMode`
-// type is `"exclusion" | "inclusion"` (the allowlist mode is unpublished /
-// ships in pi-tool-masking 1.2.0), so the string cast is load-bearing: an
-// allowlist-capable consumer sharing the `globalThis` module state writes
-// `"allowlist"` into it, and this consumer reads that value back at runtime
-// even though its own bundled type doesn't name the mode. On published
-// versions no caller ever writes `"allowlist"`, so this is a no-op for
-// ordinary users — it only activates when an allowlist-capable
-// pi-tool-masking consumer is in play.
-//
-// Cleanup at the ^1.2.0 bump: once `DefaultResolutionMode` names
-// `"allowlist"`, drop the `as string` cast here and in pi-lean-search's
-// co-activation mirror — the type system can then check the comparison
-// directly and the cast becomes a suppressor of a check it should perform.
+
+// Focus-mode guard: refuse actuating subcommands while the library holds the
+// line — inclusion mode or allowlist focus (an upstream pi-tool-masking
+// consumer).
 function isFocusHolding(): boolean {
-	const mode = getDefaultResolutionMode() as string;
+	const mode = getDefaultResolutionMode();
 	return mode === "inclusion" || mode === "allowlist";
 }
 
@@ -154,86 +142,13 @@ function renderBrowserGlyph(
 	}
 }
 
-// ---- Legacy settings migration warning ---------------------------
-//
-// The portal currently seeds the web toolset's fresh-session default from
-// `browserToggle.defaultEnabled` in settings.json. An upcoming pi-tool-masking
-// release takes over settings-based toolset defaults and reads a new
-// `toolsetDefaults` block instead. Warn users who pinned the legacy key so
-// they can migrate before the offload lands and the legacy read is removed.
-//
-// ponytail: warn-only — we still honor the legacy key for backward compat
-// until pi-tool-masking owns the settings tier; then delete this helper and
-// the `browserToggle` read below. Ceiling: a silent default shift for users
-// who ignore the warning; upgrade path is the pi-tool-masking bump.
-const TOOLSET_DEFAULTS_MIGRATION_MSG =
-	"⚠️ pi-lean-portal: settings-based toolset defaults are moving to the " +
-	"pi-tool-masking library. The `browserToggle.defaultEnabled` key in your " +
-	"settings.json will stop being read in an upcoming release. It still works " +
-	"today — KEEP it until the replacement ships, and add the new " +
-	"`toolsetDefaults` block alongside it so your config is ready (the new " +
-	"block is not read yet, but is harmless now and will take effect " +
-	"automatically once the offload lands):\n\n" +
-	"{\n" +
-	'  "browserToggle": { "defaultEnabled": true },\n' +
-	'  "toolsetDefaults": {\n' +
-	'    "toolset-state:pi-lean-dimension.web": { "enabled": true },\n' +
-	'    "toolset-state:pi-lean-dimension.web-learn": { "enabled": true },\n' +
-	'    "toolset-state:pi-lean-dimension.search": { "enabled": true }\n' +
-	"  }\n" +
-	"}\n" +
-	"(omit a `toolsetDefaults` key to use the toolset's packaged default; the " +
-	"`search` key only applies when pi-lean-search is installed). Mirror your " +
-	"web default into `toolset-state:pi-lean-dimension.web` to silence this " +
-	"warning.";
-
-function hasLegacyToolsetDefault(merged: Record<string, unknown>): boolean {
-	const seg = merged["browserToggle"];
-	if (!seg || typeof seg !== "object" || Array.isArray(seg)) return false;
-	return (
-		typeof (seg as Record<string, unknown>)["defaultEnabled"] === "boolean"
-	);
-}
-
-// The new `toolsetDefaults` block the pi-tool-masking offload will read.
-// When the user has already migrated the web toolset's default into it,
-// the warning is redundant even if the legacy `browserToggle.defaultEnabled`
-// key is still sitting on disk — suppress so a migrated settings file stays
-// quiet. Only the web persist key gates this: it's the one the legacy key
-// controlled, so its presence means the user acted on the migration.
-const WEB_TOOLSET_PERSIST_KEY = "toolset-state:pi-lean-dimension.web";
-function hasMigratedToolsetDefault(merged: Record<string, unknown>): boolean {
-	const td = merged["toolsetDefaults"];
-	if (!td || typeof td !== "object" || Array.isArray(td)) return false;
-	const entry = (td as Record<string, unknown>)[WEB_TOOLSET_PERSIST_KEY];
-	if (!entry || typeof entry !== "object" || Array.isArray(entry)) return false;
-	return typeof (entry as Record<string, unknown>)["enabled"] === "boolean";
-}
-
 // ---- Toggle initializer ------------------------------------------
 
 export default function initBrowserToggle(pi: ExtensionAPI) {
-	const merged = readMergedSettings();
-	// Warn only when the legacy key is pinned AND the user hasn't already
-	// migrated the web default into `toolsetDefaults`. Once the migrated
-	// entry exists, pi-tool-masking will read it directly and the legacy
-	// key is dead weight — no need to nag.
-	const legacyDefaultPinned =
-		hasLegacyToolsetDefault(merged) && !hasMigratedToolsetDefault(merged);
-	const browserToggleSegment = (merged as Record<string, unknown>)[
-		"browserToggle"
-	] as Record<string, unknown> | undefined;
-	const webDefault =
-		browserToggleSegment &&
-		typeof browserToggleSegment["defaultEnabled"] === "boolean"
-			? (browserToggleSegment["defaultEnabled"] as boolean)
-			: true;
-
-	const webSpec: ToolsetSpec = {
-		...PORTAL_WEB_SPEC,
-		defaultEnabled: webDefault,
-	};
-	const webToolset = defineToolset(pi, webSpec);
+	// Settings-based toolset defaults (`toolsetDefaults` tier) are read by
+	// pi-tool-masking itself inside defineToolset/restore — pass the packaged
+	// spec straight through.
+	const webToolset = defineToolset(pi, PORTAL_WEB_SPEC);
 	const learnToolset = defineToolset(pi, PORTAL_LEARN_SPEC);
 
 	// ── Keep cached state in sync with library events ─────────
@@ -267,8 +182,7 @@ export default function initBrowserToggle(pi: ExtensionAPI) {
 			// unguarded, matching the focus controller's treatment of its own
 			// read-only commands.
 			if (["on", "off", "learn"].includes(cmd) && isFocusHolding()) {
-				const inInclusion =
-					(getDefaultResolutionMode() as string) === "inclusion";
+				const inInclusion = getDefaultResolutionMode() === "inclusion";
 				ctx.ui.notify(
 					inInclusion
 						? "Another plugin has active inclusion mode — this toolset can't be toggled while inclusion is holding the line. Deactivate it there first."
@@ -348,11 +262,6 @@ export default function initBrowserToggle(pi: ExtensionAPI) {
 		restoreProfile(pi, ctx);
 		_lastCtx = ctx;
 		syncCachedState();
-		// One-time-per-session migration warning when the legacy
-		// `browserToggle.defaultEnabled` pin is still on disk.
-		if (legacyDefaultPinned) {
-			ctx.ui.notify(TOOLSET_DEFAULTS_MIGRATION_MSG, "warning");
-		}
 	});
 
 	pi.on("session_tree", async (_event, ctx) => {

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "pi-lean-portal",
-	"version": "0.3.3",
+	"version": "0.4.0",
 	"description": "Pi extension. Interactive web browsing for Pi — a /web toggle removes the tools from context when switched off, Playwright Chromium/Firefox deliver accessibility-tree snapshots, persistent profiles, cookies, and domain-matched guides; custom/stealth backends (Camoufox) plug in when a site blocks the shipped browsers.",
 	"keywords": [
 		"pi-package",
@@ -56,7 +56,7 @@
 	},
 	"dependencies": {
 		"node-html-parser": "^6.1.0",
-		"pi-tool-masking": "^1.1.0",
+		"pi-tool-masking": "^1.2.0",
 		"playwright": "^1.60.0",
 		"turndown": "^7.2.0"
 	},