@mrclrchtr/supi-web 1.4.0 → 1.6.0

package/README.md

@@ -20,73 +20,75 @@ After editing the source, run `/reload`.
 
 After install, pi gets three tools:
 
-- `web_fetch_md` — fetch a web page and convert it to Markdown
-- `web_docs_search` — search Context7 for a library ID
-- `web_docs_fetch` — fetch up-to-date documentation for a specific Context7 library
+| Tool | Purpose |
+|------|---------|
+| `web_fetch_md` | Fetch a web page and convert it to clean Markdown for LLM ingestion |
+| `web_docs_search` | Search Context7 for library IDs and metadata before fetching docs |
+| `web_docs_fetch` | Fetch up-to-date documentation for a known Context7 library |
 
-## Choose the right tool
+## `web_fetch_md`
 
-### `web_fetch_md`
+Fetches a public URL and returns clean Markdown.
 
-Use this for general web pages.
+### Parameters
 
-Important behavior:
+| Parameter | Type | Required | Default | Description |
+|-----------|------|----------|---------|-------------|
+| `url` | string | ✓ | — | `http://` or `https://` URL to fetch |
+| `output_mode` | `"auto"` \| `"inline"` \| `"file"` | — | `"auto"` | How to return the result |
+| `abs_links` | boolean | — | `true` | Absolutize relative links and images |
+| `timeout_ms` | number | — | `30000` | Fetch timeout in milliseconds |
 
-- accepts only real `http://` or `https://` URLs
-- defaults to `output_mode: auto`
-- returns Markdown inline when the result is at most **15,000 characters**
-- otherwise writes the Markdown to a temporary `.md` file and returns the file path
-- absolutizes links and image URLs by default
-- wraps plain-text responses as fenced code blocks instead of pretending they are prose
+### Output modes
 
-The fetch pipeline tries several strategies in order:
+- **`auto`** — returns Markdown inline if ≤15,000 characters; otherwise writes to a temporary file and returns the path
+- **`inline`** — always returns Markdown inline
+- **`file`** — always writes to a temporary file and returns the path
 
-1. Markdown-aware content negotiation
-2. content sniffing
-3. sibling `.md` / `.markdown` probing
-4. HTML fetch followed by Readability + Turndown conversion
+### Behavior
 
-### `web_docs_search`
+- Only accepts real `http://` or `https://` URLs
+- Access-controlled pages (login, paywall) should be skipped — ask the user for an allowed source instead
+- Plain-text responses are wrapped in fenced code blocks
+- Links and images are absolutized by default; set `abs_links: false` to keep them relative
 
-Use this when you need a Context7 library ID first.
+## `web_docs_search`
 
-It returns a Markdown table of matching libraries with fields such as:
+Searches Context7 for library IDs before fetching documentation.
 
-- ID
-- name
-- description
-- trust score
-- benchmark score
-- snippet count
-- versions
+### Parameters
 
-### `web_docs_fetch`
+| Parameter | Type | Required | Description |
+|-----------|------|----------|-------------|
+| `library_name` | string | ✓ | Library name to search for (e.g. `"react"`, `"next.js"`) |
+| `query` | string | ✓ | What you're trying to do — used for relevance ranking |
 
-Use this when you already know the Context7 library ID and want current docs or snippets for a specific question.
+Results return as a Markdown table with library ID, name, description, trust score, benchmark score, snippet count, and available versions.
 
-- `library_id` is required
-- `query` is required
-- `raw: true` returns JSON-serialized snippet objects instead of plain text Markdown
+## `web_docs_fetch`
 
-## Context7 notes
+Retrieves documentation context for a known Context7 library.
 
-`web_docs_search` and `web_docs_fetch` use Context7 through `@upstash/context7-sdk`.
+### Parameters
 
-If `CONTEXT7_API_KEY` is set, the SDK will use it automatically.
+| Parameter | Type | Required | Default | Description |
+|-----------|------|----------|---------|-------------|
+| `library_id` | string | ✓ | — | Context7 library ID (e.g. `/facebook/react`, `/vercel/next.js`) |
+| `query` | string | ✓ | — | Specific question about the library |
+| `raw` | boolean | — | `false` | When `true`, returns JSON-serialized snippet objects instead of Markdown |
 
-## Package surfaces
+Default mode returns pre-formatted Markdown. Set `raw: true` when you need structured JSON for programmatic use.
 
-- `@mrclrchtr/supi-web/api` — conversion helpers, fetch helpers, and extension exports
-- `@mrclrchtr/supi-web/extension` — extension entrypoint that registers all three tools
+## Typical workflow
 
-## Source
+1. **`web_docs_search`** — find the right library ID
+2. **Pick a `library_id`** from the results
+3. **`web_docs_fetch`** — retrieve focused, version-aware docs
 
-- `src/web.ts` — `web_fetch_md`
-- `src/docs.ts` — `web_docs_search` and `web_docs_fetch`
-- `src/fetch.ts` — HTTP fetching and negotiation
-- `src/convert.ts` — HTML-to-Markdown conversion
-- `src/context7-client.ts` — Context7 client wrapper
-- `src/temp-file.ts` — temp-file output helper
-- `src/tool/web-fetch-md-guidance.ts` — model-facing prompt surfaces for `web_fetch_md`
-- `src/tool/web-docs-search-guidance.ts` — model-facing prompt surfaces for `web_docs_search`
-- `src/tool/web-docs-fetch-guidance.ts` — model-facing prompt surfaces for `web_docs_fetch`
+Skip step 1 if you already know the exact Context7 `library_id`.
+
+## Context7 API key
+
+`web_docs_search` and `web_docs_fetch` use [Context7](https://context7.com/) through `@upstash/context7-sdk`.
+
+If `CONTEXT7_API_KEY` is set in your environment, the SDK uses it automatically for higher rate limits. Without a key, the tools still work with lower defaults.

package/node_modules/@mrclrchtr/supi-core/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mrclrchtr/supi-core",
-  "version": "1.4.0",
+  "version": "1.6.0",
   "description": "SuPi core — shared infrastructure for SuPi extensions (XML context tags, config system)",
   "license": "MIT",
   "repository": {

package/node_modules/@mrclrchtr/supi-core/src/api.ts

@@ -49,6 +49,7 @@ export {
   redactDebugData,
   resetDebugRegistry,
 } from "./debug-registry.ts";
+export { fileToUri, resolveToolPath, stripToolPathPrefix, uriToFile } from "./path-utils.ts";
 export type { KnownRootEntry } from "./project-roots.ts";
 export {
   buildKnownRootsMap,
@@ -63,6 +64,7 @@ export {
   sortRootsBySpecificity,
   walkProject,
 } from "./project-roots.ts";
+export { createRegistry, createSessionStateRegistry } from "./registry-utils.ts";
 export { getActiveBranchEntries } from "./session-utils.ts";
 export { registerSettingsCommand } from "./settings/settings-command.ts";
 export type { SettingsScope, SettingsSection } from "./settings/settings-registry.ts";

package/node_modules/@mrclrchtr/supi-core/src/index.ts

@@ -49,6 +49,7 @@ export {
   redactDebugData,
   resetDebugRegistry,
 } from "./debug-registry.ts";
+export { fileToUri, resolveToolPath, stripToolPathPrefix, uriToFile } from "./path-utils.ts";
 export type { KnownRootEntry } from "./project-roots.ts";
 export {
   buildKnownRootsMap,
@@ -63,6 +64,7 @@ export {
   sortRootsBySpecificity,
   walkProject,
 } from "./project-roots.ts";
+export { createRegistry, createSessionStateRegistry } from "./registry-utils.ts";
 export { getActiveBranchEntries } from "./session-utils.ts";
 export { registerSettingsCommand } from "./settings/settings-command.ts";
 export type { SettingsScope, SettingsSection } from "./settings/settings-registry.ts";

package/node_modules/@mrclrchtr/supi-core/src/path-utils.ts

@@ -0,0 +1,40 @@
+import * as path from "node:path";
+
+/** Strip pi's optional leading `@` file-path prefix from a tool input. */
+export function stripToolPathPrefix(target: string): string {
+  return target.startsWith("@") ? target.slice(1) : target;
+}
+
+/**
+ * Resolve a tool-style file path from a session cwd.
+ *
+ * Built-in pi file tools accept a leading `@` prefix in path arguments, so
+ * shared SuPi path helpers normalize that prefix before resolving relative
+ * paths.
+ */
+export function resolveToolPath(cwd: string, target: string): string {
+  return path.resolve(cwd, stripToolPathPrefix(target));
+}
+
+/** Convert a file path to a file:// URI. */
+export function fileToUri(filePath: string): string {
+  const resolved = path.resolve(filePath);
+  if (process.platform === "win32") {
+    return `file:///${resolved.replace(/\\/g, "/")}`;
+  }
+  return `file://${resolved}`;
+}
+
+/** Convert a file:// URI to a file path. */
+export function uriToFile(uri: string): string {
+  if (!uri.startsWith("file://")) return uri;
+  let filePath = decodeURIComponent(uri.slice(7));
+  if (
+    process.platform === "win32" &&
+    filePath.startsWith("/") &&
+    /^[A-Za-z]:/.test(filePath.slice(1))
+  ) {
+    filePath = filePath.slice(1);
+  }
+  return filePath;
+}

package/node_modules/@mrclrchtr/supi-core/src/registry-utils.ts

@@ -5,8 +5,20 @@
 // Without this, each symlink path gets its own module copy and its own Map,
 // so registrations from one instance are invisible to consumers in another.
 
+import * as path from "node:path";
+
 const SYMBOL_PREFIX = "@mrclrchtr/supi-core/";
 
+function getGlobalRegistryMap<T>(name: string): Map<string, T> {
+  const key = Symbol.for(SYMBOL_PREFIX + name);
+  let map = (globalThis as Record<symbol, unknown>)[key] as Map<string, T> | undefined;
+  if (!map) {
+    map = new Map<string, T>();
+    (globalThis as Record<symbol, unknown>)[key] = map;
+  }
+  return map;
+}
+
 /**
  * Create a named registry backed by `globalThis` + `Symbol.for`.
  *
@@ -18,16 +30,7 @@ const SYMBOL_PREFIX = "@mrclrchtr/supi-core/";
  * @returns An object with `register`, `getAll`, and `clear` functions.
  */
 export function createRegistry<T>(name: string) {
-  const key = Symbol.for(SYMBOL_PREFIX + name);
-
-  const getMap = (): Map<string, T> => {
-    let map = (globalThis as Record<symbol, unknown>)[key] as Map<string, T> | undefined;
-    if (!map) {
-      map = new Map<string, T>();
-      (globalThis as Record<symbol, unknown>)[key] = map;
-    }
-    return map;
-  };
+  const getMap = (): Map<string, T> => getGlobalRegistryMap<T>(name);
 
   return {
     /**
@@ -52,3 +55,32 @@ export function createRegistry<T>(name: string) {
     },
   };
 }
+
+/**
+ * Create a named session-state registry keyed by normalized cwd.
+ *
+ * This helper is intended for session-scoped runtime services that should be
+ * shared across duplicate jiti module instances while keeping package-specific
+ * state unions and convenience wrappers local to the calling package.
+ */
+export function createSessionStateRegistry<TState>(name: string) {
+  const getMap = (): Map<string, TState> => getGlobalRegistryMap<TState>(name);
+  const normalizeCwd = (cwd: string): string => path.resolve(cwd);
+
+  return {
+    /** Get the current state for one session cwd. */
+    get: (cwd: string): TState | undefined => {
+      return getMap().get(normalizeCwd(cwd));
+    },
+
+    /** Store the current state for one session cwd. */
+    set: (cwd: string, state: TState): void => {
+      getMap().set(normalizeCwd(cwd), state);
+    },
+
+    /** Clear the current state for one session cwd. */
+    clear: (cwd: string): void => {
+      getMap().delete(normalizeCwd(cwd));
+    },
+  };
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mrclrchtr/supi-web",
-  "version": "1.4.0",
+  "version": "1.6.0",
   "description": "SuPi Web extension — fetch web pages as clean Markdown (web_fetch_md) and library docs via Context7 (web_docs_search, web_docs_fetch)",
   "license": "MIT",
   "repository": {
@@ -25,7 +25,7 @@
     "@mozilla/readability": "^0.6.0",
     "turndown": "^7.2.0",
     "turndown-plugin-gfm": "^1.0.2",
-    "@mrclrchtr/supi-core": "1.4.0"
+    "@mrclrchtr/supi-core": "1.6.0"
   },
   "bundledDependencies": [
     "@mrclrchtr/supi-core"