diff --git a/extensions/browser/browser-bridge.ts b/extensions/browser/browser-bridge.ts index 6b80e8154133..9a8961554d62 100644 --- a/extensions/browser/browser-bridge.ts +++ b/extensions/browser/browser-bridge.ts @@ -1,2 +1,6 @@ +/** + * Browser bridge API barrel. It exposes the host/sandbox bridge server handle + * and lifecycle helpers without importing the full browser plugin entry. + */ export type { BrowserBridge } from "./src/browser/bridge-server.js"; export { startBrowserBridgeServer, stopBrowserBridgeServer } from "./src/browser/bridge-server.js"; diff --git a/extensions/browser/browser-cdp.ts b/extensions/browser/browser-cdp.ts index 691c3afaa40f..a4dccf5d1a2e 100644 --- a/extensions/browser/browser-cdp.ts +++ b/extensions/browser/browser-cdp.ts @@ -1 +1,5 @@ +/** + * Browser CDP helper barrel. It exposes URL parsing/redaction helpers used by + * browser config and diagnostics surfaces. + */ export { parseBrowserHttpUrl, redactCdpUrl } from "./src/browser/cdp.helpers.js"; diff --git a/extensions/browser/browser-config.ts b/extensions/browser/browser-config.ts index cbe08250978d..e76f9e3906e3 100644 --- a/extensions/browser/browser-config.ts +++ b/extensions/browser/browser-config.ts @@ -1,3 +1,7 @@ +/** + * Browser config API barrel. It re-exports default profile, upload, auth, and + * CDP config helpers for setup/runtime consumers. + */ export { DEFAULT_AI_SNAPSHOT_MAX_CHARS, DEFAULT_BROWSER_DEFAULT_PROFILE_NAME, diff --git a/extensions/browser/browser-control-auth.ts b/extensions/browser/browser-control-auth.ts index 72d63ded0a91..ae997bc67e5d 100644 --- a/extensions/browser/browser-control-auth.ts +++ b/extensions/browser/browser-control-auth.ts @@ -1,3 +1,7 @@ +/** + * Browser control-auth API barrel. It exposes auth generation and validation + * helpers for the browser control server. + */ export type { BrowserControlAuth } from "./src/browser/control-auth.js"; export { ensureBrowserControlAuth, diff --git a/extensions/browser/browser-doctor.ts b/extensions/browser/browser-doctor.ts index a468e407ea39..f97c3d975f86 100644 --- a/extensions/browser/browser-doctor.ts +++ b/extensions/browser/browser-doctor.ts @@ -1,3 +1,7 @@ +/** + * Browser doctor API barrel. It exposes legacy profile cleanup and Chrome MCP + * readiness helpers for OpenClaw doctor. + */ export { detectLegacyClawdBrowserProfileResidue, maybeArchiveLegacyClawdBrowserProfileResidue, diff --git a/extensions/browser/browser-host-inspection.ts b/extensions/browser/browser-host-inspection.ts index 87a3a9fb8127..50097663c250 100644 --- a/extensions/browser/browser-host-inspection.ts +++ b/extensions/browser/browser-host-inspection.ts @@ -1,3 +1,7 @@ +/** + * Browser host-inspection API barrel. It exposes Chrome executable discovery + * and version parsing helpers. + */ export type { BrowserExecutable } from "./src/browser/chrome.executables.js"; export { parseBrowserMajorVersion, diff --git a/extensions/browser/browser-maintenance.ts b/extensions/browser/browser-maintenance.ts index 3f8c71c25222..3dd774fbf4a7 100644 --- a/extensions/browser/browser-maintenance.ts +++ b/extensions/browser/browser-maintenance.ts @@ -1,2 +1,6 @@ +/** + * Browser maintenance API barrel. It exposes tab cleanup and trash helpers for + * runtime and doctor flows. + */ export { closeTrackedBrowserTabsForSessions } from "./src/browser/session-tab-registry.js"; export { movePathToTrash } from "./src/browser/trash.js"; diff --git a/extensions/browser/browser-profiles.ts b/extensions/browser/browser-profiles.ts index 570981279234..a92879e371c3 100644 --- a/extensions/browser/browser-profiles.ts +++ b/extensions/browser/browser-profiles.ts @@ -1,3 +1,7 @@ +/** + * Browser profile API barrel. It exposes browser profile defaults and config + * resolution helpers for setup and runtime paths. + */ export { DEFAULT_AI_SNAPSHOT_MAX_CHARS, DEFAULT_BROWSER_ACTION_TIMEOUT_MS, diff --git a/extensions/browser/cli-metadata.ts b/extensions/browser/cli-metadata.ts index ae27cf639d2c..c5ef8dffc3b3 100644 --- a/extensions/browser/cli-metadata.ts +++ b/extensions/browser/cli-metadata.ts @@ -1,5 +1,10 @@ +/** + * Browser CLI metadata entry. It registers the `openclaw browser` command lazily + * so command discovery does not load the full browser runtime. + */ import { definePluginEntry } from "openclaw/plugin-sdk/plugin-entry"; +/** Plugin entry that contributes Browser CLI commands. */ export default definePluginEntry({ id: "browser", name: "Browser", diff --git a/extensions/browser/index.ts b/extensions/browser/index.ts index dd33a3ef7382..8b0d73825ebe 100644 --- a/extensions/browser/index.ts +++ b/extensions/browser/index.ts @@ -1,3 +1,7 @@ +/** + * Browser plugin entry. It wires the browser tool, gateway request handler, + * node-host command, services, reload policy, and security audit collectors. + */ import { definePluginEntry } from "openclaw/plugin-sdk/plugin-entry"; import { browserPluginNodeHostCommands, @@ -6,6 +10,7 @@ import { registerBrowserPlugin, } from "./plugin-registration.js"; +/** Main Browser plugin entry for runtime registration. */ export default definePluginEntry({ id: "browser", name: "Browser", diff --git a/extensions/browser/plugin-registration.ts b/extensions/browser/plugin-registration.ts index f2afbc97fa66..96d4823e74d3 100644 --- a/extensions/browser/plugin-registration.ts +++ b/extensions/browser/plugin-registration.ts @@ -1,3 +1,7 @@ +/** + * Browser plugin registration helpers. This file keeps registration lazy while + * advertising Browser tools, services, node-host commands, and audits. + */ import type { AnyAgentTool, OpenClawPluginApi, @@ -140,8 +144,10 @@ function createBrowserToolOptions(ctx: OpenClawPluginToolContext): { }; } +/** Browser plugin reload policy. */ export const browserPluginReload = { restartPrefixes: ["browser"] }; +/** Node-host command descriptors exposed by the Browser plugin. */ export const browserPluginNodeHostCommands: OpenClawPluginNodeHostCommand[] = [ { command: "browser.proxy", @@ -153,6 +159,7 @@ export const browserPluginNodeHostCommands: OpenClawPluginNodeHostCommand[] = [ }, ]; +/** Security audit collectors contributed by the Browser plugin. */ export const browserSecurityAuditCollectors: OpenClawPluginSecurityAuditCollector[] = [ async (ctx) => { const { collectBrowserSecurityAuditFindings } = await loadBrowserRegistrationRuntimeModule(); @@ -189,6 +196,7 @@ function createLazyBrowserPluginService(): OpenClawPluginService { }; } +/** Register Browser tool factories, CLI, gateway methods, services, and audits. */ export function registerBrowserPlugin(api: OpenClawPluginApi) { api.registerTool(((ctx: OpenClawPluginToolContext) => createLazyBrowserTool(createBrowserToolOptions(ctx))) as OpenClawPluginToolFactory); diff --git a/extensions/browser/register.runtime.ts b/extensions/browser/register.runtime.ts index 52060f790809..dda88713982e 100644 --- a/extensions/browser/register.runtime.ts +++ b/extensions/browser/register.runtime.ts @@ -1,3 +1,7 @@ +/** + * Browser runtime registration barrel. Node host commands and plugin + * registration lazy-load these exports when browser runtime behavior is needed. + */ export { createBrowserTool } from "./src/browser-tool.js"; export { handleBrowserGatewayRequest } from "./src/gateway/browser-request.js"; export { runBrowserProxyCommand } from "./src/node-host/invoke-browser.js"; diff --git a/extensions/browser/runtime-api.ts b/extensions/browser/runtime-api.ts index 6a8ae2fa13f6..8069c8d1e8b6 100644 --- a/extensions/browser/runtime-api.ts +++ b/extensions/browser/runtime-api.ts @@ -1,3 +1,7 @@ +/** + * Browser runtime API barrel. It exposes the full Browser runtime surface for + * plugin consumers while keeping the entrypoint itself declarative. + */ export { createBrowserTool } from "./src/browser-tool.js"; export { applyBrowserProxyPaths, diff --git a/extensions/browser/setup-api.ts b/extensions/browser/setup-api.ts index c0734d7c6a93..eebd5686c059 100644 --- a/extensions/browser/setup-api.ts +++ b/extensions/browser/setup-api.ts @@ -1,3 +1,7 @@ +/** + * Browser setup entry. It auto-enables the Browser plugin when config or tool + * policies reference browser control. + */ import type { OpenClawConfig } from "openclaw/plugin-sdk/plugin-entry"; import { definePluginEntry } from "openclaw/plugin-sdk/plugin-entry"; import { normalizeOptionalLowercaseString } from "openclaw/plugin-sdk/string-coerce-runtime"; @@ -26,6 +30,7 @@ function hasBrowserToolReference(config: OpenClawConfig): boolean { : false; } +/** Setup entry that detects existing Browser configuration references. */ export default definePluginEntry({ id: "browser", name: "Browser Setup",