From 6bea19a9ee02598644b1ac3ab67c705dcc495832 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Wed, 22 Jul 2026 11:13:27 +0000 Subject: [PATCH 1/3] fix: remediate Dependabot security alerts Automated by fix-dependabot-alerts workflow. Applied: @hono/node-server brace-expansion diff dompurify esbuild fast-uri js-yaml linkify-it nodemailer qs underscore undici uuid vite ws xml2js Rolled back: (none) Blocked: 1 package(s) Deferred (min release age): 0 package(s) Shell packaging: passed Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> --- ts/packages/agentServer/client/package.json | 2 +- ts/packages/agentServer/server/package.json | 2 +- ts/packages/agents/browser/package.json | 4 +- .../agents/browserControlRpc/package.json | 2 +- .../agents/browserExtension/package.json | 2 +- ts/packages/agents/code/package.json | 2 +- ts/packages/agents/desktop/package.json | 2 +- ts/packages/agents/markdown/package.json | 4 +- ts/packages/agents/onboarding/package.json | 2 +- ts/packages/agents/studio/package.json | 2 +- ts/packages/agents/visualStudio/package.json | 2 +- ts/packages/api/package.json | 2 +- ts/packages/chat-ui/package.json | 2 +- ts/packages/coda/package.json | 2 +- ts/packages/defaultAgentProvider/package.json | 2 +- ts/packages/memory/website/package.json | 2 +- ts/packages/shell/package.json | 4 +- ts/packages/studio-service/package.json | 2 +- ts/packages/typeagent-studio/package.json | 2 +- .../utils/webSocketChannelServer/package.json | 2 +- ts/packages/utils/webSocketUtils/package.json | 2 +- ts/packages/vscode-shell/package.json | 4 +- ts/pnpm-lock.yaml | 203 +++++++++--------- 23 files changed, 126 insertions(+), 129 deletions(-) diff --git a/ts/packages/agentServer/client/package.json b/ts/packages/agentServer/client/package.json index ba4d37817e..457eb6856c 100644 --- a/ts/packages/agentServer/client/package.json +++ b/ts/packages/agentServer/client/package.json @@ -48,6 +48,6 @@ "rimraf": "^6.0.1", "typescript": "~5.4.5", "websocket-channel-server": "workspace:*", - "ws": "^8.21.0" + "ws": "^8.21.1" } } diff --git a/ts/packages/agentServer/server/package.json b/ts/packages/agentServer/server/package.json index 0f47decbf8..625da5e96a 100644 --- a/ts/packages/agentServer/server/package.json +++ b/ts/packages/agentServer/server/package.json @@ -55,7 +55,7 @@ "dispatcher-node-providers": "workspace:*", "dotenv": "^16.3.1", "websocket-channel-server": "workspace:*", - "ws": "^8.21.0" + "ws": "^8.21.1" }, "devDependencies": { "@jest/globals": "^29.7.0", diff --git a/ts/packages/agents/browser/package.json b/ts/packages/agents/browser/package.json index d529d00a44..e3cc38f2dd 100644 --- a/ts/packages/agents/browser/package.json +++ b/ts/packages/agents/browser/package.json @@ -64,7 +64,7 @@ "cheerio": "^1.1.0", "conversation-memory": "workspace:*", "debug": "^4.4.0", - "dompurify": "^3.4.11", + "dompurify": "^3.4.12", "express": "^4.22.0", "express-rate-limit": "^7.5.0", "graphology": "^0.25.4", @@ -92,7 +92,7 @@ "typescript": "~5.4.5", "website-memory": "workspace:*", "websocket-channel-server": "workspace:*", - "ws": "^8.21.0", + "ws": "^8.21.1", "xss": "^1.0.15", "yaml": "^2.8.3", "zod": "^4.1.13" diff --git a/ts/packages/agents/browserControlRpc/package.json b/ts/packages/agents/browserControlRpc/package.json index 27e775c812..91a2d27f3d 100644 --- a/ts/packages/agents/browserControlRpc/package.json +++ b/ts/packages/agents/browserControlRpc/package.json @@ -32,7 +32,7 @@ }, "dependencies": { "@typeagent/agent-rpc": "workspace:*", - "dompurify": "^3.4.11" + "dompurify": "^3.4.12" }, "devDependencies": { "prettier": "^3.5.3", diff --git a/ts/packages/agents/browserExtension/package.json b/ts/packages/agents/browserExtension/package.json index 5447c30151..634a8b0f91 100644 --- a/ts/packages/agents/browserExtension/package.json +++ b/ts/packages/agents/browserExtension/package.json @@ -45,7 +45,7 @@ "cytoscape-dagre": "^2.5.0", "dagre": "^0.8.5", "debug": "^4.4.0", - "dompurify": "^3.4.11", + "dompurify": "^3.4.12", "html-to-text": "^9.0.5", "markdown-it": "^14.2.0", "prismjs": "^1.30.0" diff --git a/ts/packages/agents/code/package.json b/ts/packages/agents/code/package.json index 51af26992a..2e2a43791b 100644 --- a/ts/packages/agents/code/package.json +++ b/ts/packages/agents/code/package.json @@ -54,7 +54,7 @@ "debug": "^4.4.0", "telemetry": "workspace:*", "websocket-channel-server": "workspace:*", - "ws": "^8.21.0" + "ws": "^8.21.1" }, "devDependencies": { "@typeagent/action-grammar-compiler": "workspace:*", diff --git a/ts/packages/agents/desktop/package.json b/ts/packages/agents/desktop/package.json index 0b9e2e3166..f860543688 100644 --- a/ts/packages/agents/desktop/package.json +++ b/ts/packages/agents/desktop/package.json @@ -60,7 +60,7 @@ "typeagent": "workspace:*", "typechat": "^0.1.1", "typechat-utils": "workspace:*", - "ws": "^8.21.0" + "ws": "^8.21.1" }, "devDependencies": { "@jest/globals": "^29.7.0", diff --git a/ts/packages/agents/markdown/package.json b/ts/packages/agents/markdown/package.json index 852a533c00..d26a9ea628 100644 --- a/ts/packages/agents/markdown/package.json +++ b/ts/packages/agents/markdown/package.json @@ -46,7 +46,7 @@ "@typeagent/aiclient": "workspace:*", "@typeagent/websocket-utils": "workspace:*", "debug": "^4.3.4", - "dompurify": "^3.4.11", + "dompurify": "^3.4.12", "express": "^4.22.0", "express-rate-limit": "^7.5.0", "katex": "^0.16.21", @@ -61,7 +61,7 @@ "telemetry": "workspace:*", "typechat": "^0.1.1", "unist-util-visit": "^4.1.2", - "ws": "^8.21.0", + "ws": "^8.21.1", "y-prosemirror": "^1.2.3", "y-protocols": "^1.0.5", "y-websocket": "^3.0.0", diff --git a/ts/packages/agents/onboarding/package.json b/ts/packages/agents/onboarding/package.json index 79f88d78e4..4817c79ea3 100644 --- a/ts/packages/agents/onboarding/package.json +++ b/ts/packages/agents/onboarding/package.json @@ -65,7 +65,7 @@ "prettier": "^3.5.3", "rimraf": "^6.0.1", "typescript": "~5.4.5", - "ws": "^8.21.0" + "ws": "^8.21.1" }, "engines": { "node": ">=22" diff --git a/ts/packages/agents/studio/package.json b/ts/packages/agents/studio/package.json index 6e075c11f7..f866ffa649 100644 --- a/ts/packages/agents/studio/package.json +++ b/ts/packages/agents/studio/package.json @@ -37,7 +37,7 @@ "@typeagent/websocket-utils": "workspace:*", "debug": "^4.4.0", "studio-service": "workspace:*", - "ws": "^8.21.0" + "ws": "^8.21.1" }, "devDependencies": { "@typeagent/action-schema-compiler": "workspace:*", diff --git a/ts/packages/agents/visualStudio/package.json b/ts/packages/agents/visualStudio/package.json index c391251976..96bc0f5e9b 100644 --- a/ts/packages/agents/visualStudio/package.json +++ b/ts/packages/agents/visualStudio/package.json @@ -30,7 +30,7 @@ "@typeagent/agent-sdk": "workspace:*", "@typeagent/websocket-utils": "workspace:*", "debug": "^4.4.0", - "ws": "^8.21.0" + "ws": "^8.21.1" }, "devDependencies": { "@typeagent/action-grammar-compiler": "workspace:*", diff --git a/ts/packages/api/package.json b/ts/packages/api/package.json index 297d2933ff..99455409f8 100644 --- a/ts/packages/api/package.json +++ b/ts/packages/api/package.json @@ -47,7 +47,7 @@ "telemetry": "workspace:*", "typeagent": "workspace:*", "typechat-utils": "workspace:*", - "ws": "^8.21.0" + "ws": "^8.21.1" }, "devDependencies": { "@types/debug": "^4.1.12", diff --git a/ts/packages/chat-ui/package.json b/ts/packages/chat-ui/package.json index 05891f17ad..ff67fa6f09 100644 --- a/ts/packages/chat-ui/package.json +++ b/ts/packages/chat-ui/package.json @@ -28,7 +28,7 @@ "@typeagent/completion-ui": "workspace:*", "@typeagent/dispatcher-types": "workspace:*", "ansi_up": "^6.0.2", - "dompurify": "^3.4.11", + "dompurify": "^3.4.12", "markdown-it": "^14.2.0" }, "devDependencies": { diff --git a/ts/packages/coda/package.json b/ts/packages/coda/package.json index 3251cea144..f2529452b7 100644 --- a/ts/packages/coda/package.json +++ b/ts/packages/coda/package.json @@ -59,7 +59,7 @@ "cors": "^2.8.5", "debug": "^4.4.0", "dotenv": "^16.3.1", - "ws": "^8.21.0" + "ws": "^8.21.1" }, "devDependencies": { "@types/body-parser": "^1.19.5", diff --git a/ts/packages/defaultAgentProvider/package.json b/ts/packages/defaultAgentProvider/package.json index 3dc7e6d2d8..5542fc64f8 100644 --- a/ts/packages/defaultAgentProvider/package.json +++ b/ts/packages/defaultAgentProvider/package.json @@ -93,7 +93,7 @@ "weather-agent": "workspace:*", "windowsclock-agent": "workspace:*", "workflow-agent": "workspace:*", - "ws": "^8.21.0", + "ws": "^8.21.1", "zod": "^4.1.13" }, "devDependencies": { diff --git a/ts/packages/memory/website/package.json b/ts/packages/memory/website/package.json index b569f69976..f279161ca2 100644 --- a/ts/packages/memory/website/package.json +++ b/ts/packages/memory/website/package.json @@ -37,7 +37,7 @@ "cheerio": "^1.0.0", "conversation-memory": "workspace:*", "debug": "^4.4.0", - "dompurify": "^3.4.11", + "dompurify": "^3.4.12", "get-folder-size": "^5.0.0", "graphology": "^0.25.4", "graphology-communities-louvain": "^2.0.1", diff --git a/ts/packages/shell/package.json b/ts/packages/shell/package.json index 67dfb1f5f3..847189b323 100644 --- a/ts/packages/shell/package.json +++ b/ts/packages/shell/package.json @@ -75,7 +75,7 @@ "ansi_up": "^6.0.2", "chat-ui": "workspace:*", "debug": "^4.4.0", - "dompurify": "^3.4.11", + "dompurify": "^3.4.12", "dotenv": "^16.3.1", "electron-updater": "^6.6.2", "jose": "^5.9.6", @@ -86,7 +86,7 @@ "typechat": "^0.1.1", "typechat-utils": "workspace:*", "websocket-channel-server": "workspace:*", - "ws": "^8.21.0" + "ws": "^8.21.1" }, "devDependencies": { "@electron-toolkit/tsconfig": "^1.0.1", diff --git a/ts/packages/studio-service/package.json b/ts/packages/studio-service/package.json index 923470525e..6277bf38f2 100644 --- a/ts/packages/studio-service/package.json +++ b/ts/packages/studio-service/package.json @@ -38,7 +38,7 @@ "@typeagent/core": "workspace:*", "@typeagent/websocket-utils": "workspace:*", "debug": "^4.4.0", - "ws": "^8.21.0" + "ws": "^8.21.1" }, "devDependencies": { "@types/debug": "^4.1.12", diff --git a/ts/packages/typeagent-studio/package.json b/ts/packages/typeagent-studio/package.json index 8bf9cf817a..31898d8ae0 100644 --- a/ts/packages/typeagent-studio/package.json +++ b/ts/packages/typeagent-studio/package.json @@ -522,7 +522,7 @@ "@typeagent/websocket-utils": "workspace:*", "debug": "^4.4.0", "default-agent-provider": "workspace:*", - "ws": "^8.21.0" + "ws": "^8.21.1" }, "devDependencies": { "@types/debug": "^4.1.0", diff --git a/ts/packages/utils/webSocketChannelServer/package.json b/ts/packages/utils/webSocketChannelServer/package.json index e9c438500e..8b93bff5f0 100644 --- a/ts/packages/utils/webSocketChannelServer/package.json +++ b/ts/packages/utils/webSocketChannelServer/package.json @@ -34,7 +34,7 @@ "@typeagent/common-utils": "workspace:*", "@typeagent/websocket-utils": "workspace:*", "debug": "^4.4.0", - "ws": "^8.21.0" + "ws": "^8.21.1" }, "devDependencies": { "@jest/globals": "^29.7.0", diff --git a/ts/packages/utils/webSocketUtils/package.json b/ts/packages/utils/webSocketUtils/package.json index 9f77489583..a7a62b384b 100644 --- a/ts/packages/utils/webSocketUtils/package.json +++ b/ts/packages/utils/webSocketUtils/package.json @@ -36,7 +36,7 @@ "dotenv": "^16.3.1", "find-config": "^1.0.0", "isomorphic-ws": "^5.0.0", - "ws": "^8.21.0" + "ws": "^8.21.1" }, "devDependencies": { "@types/debug": "^4.1.12", diff --git a/ts/packages/vscode-shell/package.json b/ts/packages/vscode-shell/package.json index ab9b9191eb..1d13e8ad2a 100644 --- a/ts/packages/vscode-shell/package.json +++ b/ts/packages/vscode-shell/package.json @@ -213,11 +213,11 @@ "ansi_up": "^6.0.6", "chat-ui": "workspace:*", "debug": "^4.4.0", - "dompurify": "^3.4.11", + "dompurify": "^3.4.12", "isomorphic-ws": "^5.0.0", "markdown-it": "^14.2.0", "microsoft-cognitiveservices-speech-sdk": "1.43.1", - "ws": "^8.21.0" + "ws": "^8.21.1" }, "devDependencies": { "@types/debug": "^4.1.0", diff --git a/ts/pnpm-lock.yaml b/ts/pnpm-lock.yaml index 3b25c1b458..4d7709553c 100644 --- a/ts/pnpm-lock.yaml +++ b/ts/pnpm-lock.yaml @@ -880,7 +880,7 @@ importers: dependencies: '@azure/ai-projects': specifier: ^2.2.0 - version: 2.2.0(ws@8.21.0)(zod@3.25.76) + version: 2.2.0(ws@8.21.1)(zod@3.25.76) '@azure/identity': specifier: ^4.10.0 version: 4.10.0 @@ -1558,7 +1558,7 @@ importers: version: 1.43.1(supports-color@8.1.1) openai: specifier: ^4.73.0 - version: 4.103.0(encoding@0.1.13)(ws@8.21.0)(zod@4.3.6) + version: 4.103.0(encoding@0.1.13)(ws@8.21.1)(zod@4.3.6) zod: specifier: ^4.1.13 version: 4.3.6 @@ -1595,7 +1595,7 @@ importers: version: 4.4.3(supports-color@8.1.1) isomorphic-ws: specifier: ^5.0.0 - version: 5.0.0(ws@8.21.0) + version: 5.0.0(ws@8.21.1) devDependencies: '@jest/globals': specifier: ^29.7.0 @@ -1625,8 +1625,8 @@ importers: specifier: workspace:* version: link:../../utils/webSocketChannelServer ws: - specifier: ^8.21.0 - version: 8.21.0 + specifier: ^8.21.1 + version: 8.21.1 packages/agentServer/protocol: dependencies: @@ -1704,8 +1704,8 @@ importers: specifier: workspace:* version: link:../../utils/webSocketChannelServer ws: - specifier: ^8.21.0 - version: 8.21.0 + specifier: ^8.21.1 + version: 8.21.1 devDependencies: '@jest/globals': specifier: ^29.7.0 @@ -1905,8 +1905,8 @@ importers: specifier: ^4.4.0 version: 4.4.1(supports-color@8.1.1) dompurify: - specifier: ^3.4.11 - version: 3.4.11 + specifier: ^3.4.12 + version: 3.4.12 express: specifier: ^4.22.0 version: 4.22.1 @@ -1989,8 +1989,8 @@ importers: specifier: workspace:* version: link:../../utils/webSocketChannelServer ws: - specifier: ^8.21.0 - version: 8.21.0 + specifier: ^8.21.1 + version: 8.21.1 xss: specifier: ^1.0.15 version: 1.0.15 @@ -2059,8 +2059,8 @@ importers: specifier: workspace:* version: link:../../agentRpc dompurify: - specifier: ^3.4.11 - version: 3.4.11 + specifier: ^3.4.12 + version: 3.4.12 devDependencies: prettier: specifier: ^3.5.3 @@ -2120,8 +2120,8 @@ importers: specifier: ^4.4.0 version: 4.4.3(supports-color@8.1.1) dompurify: - specifier: ^3.4.11 - version: 3.4.11 + specifier: ^3.4.12 + version: 3.4.12 html-to-text: specifier: ^9.0.5 version: 9.0.5 @@ -2327,8 +2327,8 @@ importers: specifier: workspace:* version: link:../../utils/webSocketChannelServer ws: - specifier: ^8.21.0 - version: 8.21.0 + specifier: ^8.21.1 + version: 8.21.1 devDependencies: '@typeagent/action-grammar-compiler': specifier: workspace:* @@ -2403,8 +2403,8 @@ importers: specifier: workspace:* version: link:../../utils/typechatUtils ws: - specifier: ^8.21.0 - version: 8.21.0 + specifier: ^8.21.1 + version: 8.21.1 devDependencies: '@jest/globals': specifier: ^29.7.0 @@ -2732,8 +2732,8 @@ importers: specifier: ^4.3.4 version: 4.4.1(supports-color@8.1.1) dompurify: - specifier: ^3.4.11 - version: 3.4.11 + specifier: ^3.4.12 + version: 3.4.12 express: specifier: ^4.22.0 version: 4.22.1 @@ -2777,8 +2777,8 @@ importers: specifier: ^4.1.2 version: 4.1.2 ws: - specifier: ^8.21.0 - version: 8.21.0 + specifier: ^8.21.1 + version: 8.21.1 y-prosemirror: specifier: ^1.2.3 version: 1.3.5(prosemirror-model@1.25.1)(prosemirror-state@1.4.3)(prosemirror-view@1.40.0)(y-protocols@1.0.6(yjs@13.6.27))(yjs@13.6.27) @@ -2996,8 +2996,8 @@ importers: specifier: ~5.4.5 version: 5.4.5 ws: - specifier: ^8.21.0 - version: 8.21.0 + specifier: ^8.21.1 + version: 8.21.1 packages/agents/osNotifications: dependencies: @@ -3321,8 +3321,8 @@ importers: specifier: workspace:* version: link:../../studio-service ws: - specifier: ^8.21.0 - version: 8.21.0 + specifier: ^8.21.1 + version: 8.21.1 devDependencies: '@typeagent/action-schema-compiler': specifier: workspace:* @@ -3596,8 +3596,8 @@ importers: specifier: ^4.4.0 version: 4.4.3(supports-color@8.1.1) ws: - specifier: ^8.21.0 - version: 8.21.0 + specifier: ^8.21.1 + version: 8.21.1 devDependencies: '@typeagent/action-grammar-compiler': specifier: workspace:* @@ -3818,8 +3818,8 @@ importers: specifier: workspace:* version: link:../utils/typechatUtils ws: - specifier: ^8.21.0 - version: 8.21.0 + specifier: ^8.21.1 + version: 8.21.1 devDependencies: '@types/debug': specifier: ^4.1.12 @@ -3850,7 +3850,7 @@ importers: dependencies: '@azure/ai-projects': specifier: ^2.2.0 - version: 2.2.0(ws@8.21.0)(zod@3.25.76) + version: 2.2.0(ws@8.21.1)(zod@3.25.76) '@azure/identity': specifier: ^4.10.0 version: 4.10.0 @@ -3871,7 +3871,7 @@ importers: version: 4.4.1(supports-color@8.1.1) openai: specifier: ^6.16.0 - version: 6.41.0(ws@8.21.0)(zod@3.25.76) + version: 6.41.0(ws@8.21.1)(zod@3.25.76) telemetry: specifier: workspace:* version: link:../telemetry @@ -4038,8 +4038,8 @@ importers: specifier: ^6.0.2 version: 6.0.5 dompurify: - specifier: ^3.4.11 - version: 3.4.11 + specifier: ^3.4.12 + version: 3.4.12 markdown-it: specifier: ^14.2.0 version: 14.2.0 @@ -4190,8 +4190,8 @@ importers: specifier: ^16.3.1 version: 16.5.0 ws: - specifier: ^8.21.0 - version: 8.21.0 + specifier: ^8.21.1 + version: 8.21.1 devDependencies: '@types/body-parser': specifier: ^1.19.5 @@ -4317,7 +4317,7 @@ importers: version: 9.0.5 isomorphic-ws: specifier: ^5.0.0 - version: 5.0.0(ws@8.21.0) + version: 5.0.0(ws@8.21.1) weather-agent: specifier: workspace:* version: link:../agents/weather @@ -4619,8 +4619,8 @@ importers: specifier: workspace:* version: link:../../examples/workflow/adapter ws: - specifier: ^8.21.0 - version: 8.21.0 + specifier: ^8.21.1 + version: 8.21.1 zod: specifier: ^4.1.13 version: 4.1.13 @@ -5483,8 +5483,8 @@ importers: specifier: ^4.4.0 version: 4.4.1(supports-color@8.1.1) dompurify: - specifier: ^3.4.11 - version: 3.4.11 + specifier: ^3.4.12 + version: 3.4.12 get-folder-size: specifier: ^5.0.0 version: 5.0.0 @@ -5688,8 +5688,8 @@ importers: specifier: ^4.4.0 version: 4.4.1(supports-color@8.1.1) dompurify: - specifier: ^3.4.11 - version: 3.4.11 + specifier: ^3.4.12 + version: 3.4.12 dotenv: specifier: ^16.3.1 version: 16.5.0 @@ -5721,8 +5721,8 @@ importers: specifier: workspace:* version: link:../utils/webSocketChannelServer ws: - specifier: ^8.21.0 - version: 8.21.0 + specifier: ^8.21.1 + version: 8.21.1 devDependencies: '@electron-toolkit/tsconfig': specifier: ^1.0.1 @@ -5818,8 +5818,8 @@ importers: specifier: ^4.4.0 version: 4.4.3(supports-color@8.1.1) ws: - specifier: ^8.21.0 - version: 8.21.0 + specifier: ^8.21.1 + version: 8.21.1 devDependencies: '@types/debug': specifier: ^4.1.12 @@ -6049,8 +6049,8 @@ importers: specifier: workspace:* version: link:../defaultAgentProvider ws: - specifier: ^8.21.0 - version: 8.21.0 + specifier: ^8.21.1 + version: 8.21.1 devDependencies: '@types/debug': specifier: ^4.1.0 @@ -6203,8 +6203,8 @@ importers: specifier: ^4.4.0 version: 4.4.3(supports-color@8.1.1) ws: - specifier: ^8.21.0 - version: 8.21.0 + specifier: ^8.21.1 + version: 8.21.1 devDependencies: '@jest/globals': specifier: ^29.7.0 @@ -6250,10 +6250,10 @@ importers: version: 1.0.0 isomorphic-ws: specifier: ^5.0.0 - version: 5.0.0(ws@8.21.0) + version: 5.0.0(ws@8.21.1) ws: - specifier: ^8.21.0 - version: 8.21.0 + specifier: ^8.21.1 + version: 8.21.1 devDependencies: '@types/debug': specifier: ^4.1.12 @@ -6362,11 +6362,11 @@ importers: specifier: ^4.4.0 version: 4.4.3(supports-color@8.1.1) dompurify: - specifier: ^3.4.11 - version: 3.4.11 + specifier: ^3.4.12 + version: 3.4.12 isomorphic-ws: specifier: ^5.0.0 - version: 5.0.0(ws@8.21.0) + version: 5.0.0(ws@8.21.1) markdown-it: specifier: ^14.2.0 version: 14.2.0 @@ -6374,8 +6374,8 @@ importers: specifier: 1.43.1 version: 1.43.1(supports-color@8.1.1) ws: - specifier: ^8.21.0 - version: 8.21.0 + specifier: ^8.21.1 + version: 8.21.1 devDependencies: '@types/debug': specifier: ^4.1.0 @@ -12876,8 +12876,8 @@ packages: resolution: {integrity: sha512-cgwlv/1iFQiFnU96XXgROh8xTeetsnJiDsTc7TYCLFd9+/WNkIqPTxiM/8pSd8VIrhXGTf1Ny1q1hquVqDJB5w==} engines: {node: '>= 4'} - dompurify@3.4.11: - resolution: {integrity: sha512-zhlUV12GsaRzMsf9q5M254YhA4+VuF0fG+QFqu6aYpoGlKtz+w8//jBcGVYBgQkR5GHjUomejY84AV+/uPbWdw==} + dompurify@3.4.12: + resolution: {integrity: sha512-zQvGet8Z2sWbQhCmfFz/T5QWH2oBmjnqK3qvOjaqaNLrLEF912WamU+ohnTp0TCep/MFVHpdJuCZEdFOdTnEFg==} domutils@2.8.0: resolution: {integrity: sha512-w96Cjofp72M5IIhpjgobBimYEfoPjx1Vx0BSX9P30WBdZW2WIKU0T1Bd0kz2eNZ9ikjKgHbEyKx8BB6H1L3h3A==} @@ -12939,8 +12939,8 @@ packages: electron-publish@26.8.1: resolution: {integrity: sha512-q+jrSTIh/Cv4eGZa7oVR+grEJo/FoLMYBAnSL5GCtqwUpr1T+VgKB/dn1pnzxIxqD8S/jP1yilT9VrwCqINR4w==} - electron-to-chromium@1.5.389: - resolution: {integrity: sha512-cEto7aeOqBfU1D+c5py5pE+ooscKE75JifxLBdFUZsqAxRS6y7kebtxAZvICszSl05gPjYHDTjY+lXpyGvpJbg==} + electron-to-chromium@1.5.392: + resolution: {integrity: sha512-1yQq3VQCZRwsnYc67Oc+1fge6Lwtn0hzi6zmEVkB61Zx21kTbwJAW4dFLadl5Rc1tKhG/kSpYXnfiAhu0f0a1g==} electron-updater@6.6.2: resolution: {integrity: sha512-Cr4GDOkbAUqRHP5/oeOmH/L2Bn6+FQPxVLZtPbcmKZC63a1F3uu5EefYOssgZXG3u/zBlubbJ5PJdITdMVggbw==} @@ -13335,9 +13335,6 @@ packages: fast-levenshtein@3.0.0: resolution: {integrity: sha512-hKKNajm46uNmTlhHSyZkmToAc56uZJwYq7yrciZjqOxnlfQwERDQJmHPUp7m1m9wx8vgOe8IaCKZ5Kv2k1DdCQ==} - fast-uri@3.1.2: - resolution: {integrity: sha512-rVjf7ArG3LTk+FS6Yw81V1DLuZl1bRbNrev6Tmd/9RaroeeRRJhAt7jg/6YFxbvAQXUCavSoZhPPj6oOx+5KjQ==} - fast-uri@3.1.3: resolution: {integrity: sha512-i70LwGWUduXqzicKXWshooq+sWL1K3WUU5rKZNG/0i3a1OSoX3HqhH5WbWwTmqWfor4urUakGPiRQcleRZTwOg==} @@ -18446,8 +18443,8 @@ packages: resolution: {integrity: sha512-7KxauUdBmSdWnmpaGFg+ppNjKF8uNLry8LyzjauQDOVONfFLNKrKvQOxZ/VuTIcS/gge/YNahf5RIIQWTSarlg==} engines: {node: ^12.13.0 || ^14.15.0 || >=16.0.0} - ws@7.5.11: - resolution: {integrity: sha512-zS54Oen9bITtp7kp2XM3AydrCIq1D+HwJOuH+c+e4LfpL/lotP5osijd+UoMnxwAam1GN8R4KtLAyIrIcBNpiA==} + ws@7.5.12: + resolution: {integrity: sha512-1xGnbYN3zbog9CwuNDQULNRrTCLIn46/WmpR1f0w6PsCYQHkylZr5vkd6kfMZYV6pRnQkcPNRyiA8LsrNKyhpg==} engines: {node: '>=8.3.0'} peerDependencies: bufferutil: ^4.0.1 @@ -18458,8 +18455,8 @@ packages: utf-8-validate: optional: true - ws@8.21.0: - resolution: {integrity: sha512-Vsp28b7DRcimFQvrqu2Wek3z1iYxDCWqHYB8Qsnk/S4RfaCQzPGPyBNuVjJV3cd6UiKtUtp6sNM77gWvzcCH+g==} + ws@8.21.1: + resolution: {integrity: sha512-+0NTnW77fFN/DjQi6k/Sq/Yvk4Sgajw7urW8V+asjXnRgDs9gyGkdb7EzgfhA4goXsRIZKE28fzIXBHEzhuiWw==} engines: {node: '>=10.0.0'} peerDependencies: bufferutil: ^4.0.1 @@ -19332,7 +19329,7 @@ snapshots: dependencies: tslib: 2.8.1 - '@azure/ai-projects@2.2.0(ws@8.21.0)(zod@3.25.76)': + '@azure/ai-projects@2.2.0(ws@8.21.1)(zod@3.25.76)': dependencies: '@azure-rest/core-client': 2.4.0 '@azure/abort-controller': 2.1.2 @@ -19346,7 +19343,7 @@ snapshots: '@azure/identity': 4.13.1 '@azure/logger': 1.3.0 '@azure/storage-blob': 12.27.0 - openai: 6.41.0(ws@8.21.0)(zod@3.25.76) + openai: 6.41.0(ws@8.21.1)(zod@3.25.76) tslib: 2.8.1 transitivePeerDependencies: - supports-color @@ -20418,7 +20415,7 @@ snapshots: fs-extra: 10.1.0 isbinaryfile: 4.0.10 minimist: 1.2.8 - plist: 3.1.1 + plist: 3.1.0 transitivePeerDependencies: - supports-color @@ -20441,7 +20438,7 @@ snapshots: dir-compare: 4.2.0 fs-extra: 11.3.6 minimatch: 9.0.9 - plist: 3.1.1 + plist: 3.1.0 transitivePeerDependencies: - supports-color @@ -22112,7 +22109,7 @@ snapshots: '@types/lodash.debounce': 4.0.9 '@types/lodash.throttle': 4.1.9 clsx: 2.1.1 - dompurify: 3.4.11 + dompurify: 3.4.12 lodash.debounce: 4.0.8 lodash.throttle: 4.1.1 nanoid: 5.1.5 @@ -24873,7 +24870,7 @@ snapshots: mime-types: 2.1.35 parse5: 6.0.1 picomatch: 2.3.2 - ws: 7.5.11 + ws: 7.5.12 transitivePeerDependencies: - bufferutil - supports-color @@ -25126,7 +25123,8 @@ snapshots: '@xmldom/xmldom@0.8.13': {} - '@xmldom/xmldom@0.9.10': {} + '@xmldom/xmldom@0.9.10': + optional: true '@xtuc/ieee754@1.2.0': {} @@ -25225,7 +25223,7 @@ snapshots: ajv@8.18.0: dependencies: fast-deep-equal: 3.1.3 - fast-uri: 3.1.2 + fast-uri: 3.1.3 json-schema-traverse: 1.0.0 require-from-string: 2.0.2 @@ -25725,7 +25723,7 @@ snapshots: dependencies: baseline-browser-mapping: 2.10.43 caniuse-lite: 1.0.30001805 - electron-to-chromium: 1.5.389 + electron-to-chromium: 1.5.392 node-releases: 2.0.51 update-browserslist-db: 1.2.3(browserslist@4.28.6) @@ -27029,7 +27027,7 @@ snapshots: dependencies: domelementtype: 2.3.0 - dompurify@3.4.11: + dompurify@3.4.12: optionalDependencies: '@types/trusted-types': 2.0.7 @@ -27124,7 +27122,7 @@ snapshots: transitivePeerDependencies: - supports-color - electron-to-chromium@1.5.389: {} + electron-to-chromium@1.5.392: {} electron-updater@6.6.2(supports-color@8.1.1): dependencies: @@ -27862,8 +27860,6 @@ snapshots: dependencies: fastest-levenshtein: 1.0.16 - fast-uri@3.1.2: {} - fast-uri@3.1.3: {} fast-xml-builder@1.2.0: @@ -28806,7 +28802,7 @@ snapshots: type-fest: 4.41.0 widest-line: 5.0.0 wrap-ansi: 9.0.2 - ws: 8.21.0 + ws: 8.21.1 yoga-wasm-web: 0.3.3 optionalDependencies: '@types/react': 18.3.18 @@ -29078,9 +29074,9 @@ snapshots: isobject@3.0.1: {} - isomorphic-ws@5.0.0(ws@8.21.0): + isomorphic-ws@5.0.0(ws@8.21.1): dependencies: - ws: 8.21.0 + ws: 8.21.1 isomorphic.js@0.2.5: {} @@ -29759,7 +29755,7 @@ snapshots: jest-worker@27.5.1: dependencies: - '@types/node': 22.20.1 + '@types/node': 26.1.1 merge-stream: 2.0.0 supports-color: 8.1.1 @@ -29897,7 +29893,7 @@ snapshots: whatwg-encoding: 2.0.0 whatwg-mimetype: 3.0.0 whatwg-url: 11.0.0 - ws: 8.21.0 + ws: 8.21.1 xml-name-validator: 4.0.0 transitivePeerDependencies: - bufferutil @@ -30673,7 +30669,7 @@ snapshots: d3-sankey: 0.12.3 dagre-d3-es: 7.0.14 dayjs: 1.11.20 - dompurify: 3.4.11 + dompurify: 3.4.12 es-toolkit: 1.46.1 katex: 0.16.47 khroma: 2.1.0 @@ -30900,7 +30896,7 @@ snapshots: bent: 7.3.12 https-proxy-agent: 4.0.0(supports-color@8.1.1) uuid: 9.0.1 - ws: 7.5.11 + ws: 7.5.12 transitivePeerDependencies: - bufferutil - supports-color @@ -31133,7 +31129,7 @@ snapshots: node-abi@4.33.0: dependencies: - semver: 7.8.5 + semver: 7.7.4 node-addon-api@1.7.2: optional: true @@ -31144,7 +31140,7 @@ snapshots: node-api-version@0.2.1: dependencies: - semver: 7.8.5 + semver: 7.7.4 node-domexception@1.0.0: {} @@ -31173,7 +31169,7 @@ snapshots: graceful-fs: 4.2.11 nopt: 9.0.0 proc-log: 6.1.0 - semver: 7.8.5 + semver: 7.7.4 tar: 7.5.20 tinyglobby: 0.2.17 undici: 6.27.0 @@ -31333,7 +31329,7 @@ snapshots: is-docker: 2.2.1 is-wsl: 2.2.0 - openai@4.103.0(encoding@0.1.13)(ws@8.21.0)(zod@4.3.6): + openai@4.103.0(encoding@0.1.13)(ws@8.21.1)(zod@4.3.6): dependencies: '@types/node': 18.19.130 '@types/node-fetch': 2.6.12 @@ -31343,14 +31339,14 @@ snapshots: formdata-node: 4.4.1 node-fetch: 2.7.0(encoding@0.1.13) optionalDependencies: - ws: 8.21.0 + ws: 8.21.1 zod: 4.3.6 transitivePeerDependencies: - encoding - openai@6.41.0(ws@8.21.0)(zod@3.25.76): + openai@6.41.0(ws@8.21.1)(zod@3.25.76): optionalDependencies: - ws: 8.21.0 + ws: 8.21.1 zod: 3.25.76 optionator@0.9.4: @@ -31712,6 +31708,7 @@ snapshots: '@xmldom/xmldom': 0.9.10 base64-js: 1.5.1 xmlbuilder: 15.1.1 + optional: true pluralize@2.0.0: {} @@ -32065,7 +32062,7 @@ snapshots: debug: 4.4.3(supports-color@8.1.1) devtools-protocol: 0.0.1367902 typed-query-selector: 2.12.2 - ws: 8.21.0 + ws: 8.21.1 transitivePeerDependencies: - bare-abort-controller - bare-buffer @@ -32082,7 +32079,7 @@ snapshots: devtools-protocol: 0.0.1566079 typed-query-selector: 2.12.2 webdriver-bidi-protocol: 0.4.1 - ws: 8.21.0 + ws: 8.21.1 transitivePeerDependencies: - bare-abort-controller - bare-buffer @@ -34448,7 +34445,7 @@ snapshots: sockjs: 0.3.24 spdy: 4.0.2(supports-color@8.1.1) webpack-dev-middleware: 7.4.5(tslib@2.8.1)(webpack@5.105.0) - ws: 8.21.0 + ws: 8.21.1 optionalDependencies: webpack: 5.105.0(postcss@8.5.19)(webpack-cli@5.1.4) webpack-cli: 5.1.4(webpack-dev-server@5.2.6)(webpack@5.105.0) @@ -34720,9 +34717,9 @@ snapshots: imurmurhash: 0.1.4 signal-exit: 3.0.7 - ws@7.5.11: {} + ws@7.5.12: {} - ws@8.21.0: {} + ws@8.21.1: {} wsl-utils@0.1.0: dependencies: From 10c156699bb8436ffeeb5042da164ea166f9eb74 Mon Sep 17 00:00:00 2001 From: typeagent-bot Date: Wed, 22 Jul 2026 11:24:59 +0000 Subject: [PATCH 2/3] docs: regenerate README.AUTOGEN.md, command reference, and action browser --- .../agentServer/client/README.AUTOGEN.md | 36 +++--- .../agentServer/server/README.AUTOGEN.md | 6 +- ts/packages/agents/browser/README.AUTOGEN.md | 32 +++-- .../browserControlRpc/README.AUTOGEN.md | 116 +++++++++++++++++ .../agents/browserExtension/README.AUTOGEN.md | 118 ++++++++++++++++++ ts/packages/agents/code/README.AUTOGEN.md | 6 +- ts/packages/agents/desktop/README.AUTOGEN.md | 4 +- ts/packages/agents/markdown/README.AUTOGEN.md | 31 +++-- .../agents/onboarding/README.AUTOGEN.md | 4 +- ts/packages/agents/studio/README.AUTOGEN.md | 24 ++-- .../agents/visualStudio/README.AUTOGEN.md | 26 ++-- ts/packages/chat-ui/README.AUTOGEN.md | 6 +- ts/packages/coda/README.AUTOGEN.md | 6 +- .../defaultAgentProvider/README.AUTOGEN.md | 11 +- ts/packages/memory/website/README.AUTOGEN.md | 20 +-- ts/packages/shell/README.AUTOGEN.md | 18 +-- ts/packages/studio-service/README.AUTOGEN.md | 20 +-- .../typeagent-studio/README.AUTOGEN.md | 18 +-- .../webSocketChannelServer/README.AUTOGEN.md | 74 ++++++----- ts/packages/vscode-shell/README.AUTOGEN.md | 8 +- 20 files changed, 416 insertions(+), 168 deletions(-) create mode 100644 ts/packages/agents/browserControlRpc/README.AUTOGEN.md create mode 100644 ts/packages/agents/browserExtension/README.AUTOGEN.md diff --git a/ts/packages/agentServer/client/README.AUTOGEN.md b/ts/packages/agentServer/client/README.AUTOGEN.md index 4299cec395..66b5b79dd3 100644 --- a/ts/packages/agentServer/client/README.AUTOGEN.md +++ b/ts/packages/agentServer/client/README.AUTOGEN.md @@ -3,7 +3,7 @@ - + # @typeagent/agent-server-client — AI-generated documentation @@ -12,17 +12,17 @@ ## Overview -The `@typeagent/agent-server-client` package is a TypeScript library that provides tools for interacting with a running `agentServer`. It enables clients to manage server connections, handle conversations, and ensure the server's availability. This package is a core component of the TypeAgent ecosystem and is utilized by various clients, including the Shell, CLI, and other integrations. +The `@typeagent/agent-server-client` package is a TypeScript library designed to facilitate interaction with a running `agentServer`. It provides tools for managing server connections, handling conversations, and ensuring the server's availability. This package is a foundational component of the TypeAgent ecosystem and is used by various clients, including the Shell, CLI, and other integrations. ## What it does -The `@typeagent/agent-server-client` package offers the following key functionalities: +The package offers a comprehensive set of features for interacting with the `agentServer`: - **Server Connection Management**: - - The `connectAgentServer` function establishes a WebSocket connection to an `agentServer` and returns an `AgentServerConnection` object. This object provides methods for managing conversations and interacting with the server. - - The `isServerRunning` function checks if an `agentServer` is already running at a specified WebSocket URL. - - The `ensureAgentServer` function ensures that the `agentServer` is running, spawning it if necessary. + - `connectAgentServer`: Establishes a WebSocket connection to an `agentServer` and returns an `AgentServerConnection` object. This object provides methods for managing conversations and interacting with the server. + - `isServerRunning`: Checks if an `agentServer` is already running at a specified WebSocket URL. + - `ensureAgentServer`: Ensures that the `agentServer` is running, spawning it if necessary. This includes options for hidden mode and idle timeout. - **Conversation Management**: @@ -31,7 +31,7 @@ The `@typeagent/agent-server-client` package offers the following key functional - **Convenience Wrappers**: - - The `ensureAndConnectConversation` function combines multiple steps into a single operation, including ensuring the server is running, connecting to it, and joining a conversation. + - `ensureAndConnectConversation`: Combines multiple steps into a single operation, including ensuring the server is running, connecting to it, and joining a conversation. - **Discovery**: - The `discovery` module helps external clients locate the dynamically assigned port of an in-process agent, which is useful for browser extensions, IDE plugins, and other external integrations. @@ -50,11 +50,16 @@ To use this package, follow these steps: ``` 2. **Set up environment variables**: + The following environment variables are required for the package to function correctly: - - `TYPEAGENT_TUNNEL_TOKEN`: This environment variable is required for certain server interactions. Refer to the hand-written README for instructions on obtaining and setting this value. + - `TYPEAGENT_SERVER_PATH`: Specifies the path to the `agentServer`. Ensure this is set to the correct location of the server binary or executable. + - `TYPEAGENT_TUNNEL_TOKEN`: Required for certain server interactions. Refer to the hand-written README for instructions on obtaining and setting this value. + - `XDG_DATA_HOME`: Used for locating user-specific data files. Ensure this is set to a valid directory path. -3. **Configure your environment**: - Ensure that the `TYPEAGENT_TUNNEL_TOKEN` environment variable is set in your shell or `.env` file before running any code that interacts with the `agentServer`. + These variables can be set in your shell or a `.env` file. + +3. **Verify the environment**: + Ensure that the required environment variables are correctly configured before running any code that interacts with the `agentServer`. ## Key Files @@ -111,6 +116,7 @@ By following these steps, you can effectively extend the capabilities of the `@t Workspace: - [@typeagent/agent-rpc](../../../packages/agentRpc/README.md) +- [@typeagent/agent-sdk](../../../packages/agentSdk/README.md) - [@typeagent/agent-server-protocol](../../../packages/agentServer/protocol/README.md) - [@typeagent/dispatcher-rpc](../../../packages/dispatcher/rpc/README.md) - [websocket-channel-server](../../../packages/utils/webSocketChannelServer/README.md) @@ -119,6 +125,7 @@ External: `debug`, `isomorphic-ws` ### Used by +- [@typeagent/browser-extension](../../../packages/agents/browserExtension/README.md) - [@typeagent/copilot-plugin](../../../packages/copilot-plugin/README.md) - [agent-cli](../../../packages/cli/README.md) - [agent-coda](../../../packages/coda/README.md) @@ -128,8 +135,7 @@ External: `debug`, `isomorphic-ws` - [coder-wrapper](../../../packages/coderWrapper/README.md) - [command-executor-mcp](../../../packages/commandExecutor/README.md) - [remote-client-example](../../../examples/remoteClient/README.md) -- [studio-service](../../../packages/studio-service/README.md) -- _…and 5 more workspace consumers._ +- _…and 6 more workspace consumers._ ### Files of interest @@ -144,12 +150,14 @@ External: `debug`, `isomorphic-ws` ### Environment variables -_1 environment variable referenced from `./src/` (set in `ts/.env` or your shell). See the `## Setup` section above for guidance on obtaining each value._ +_3 environment variables referenced from `./src/` (set in `ts/.env` or your shell). See the `## Setup` section above for guidance on obtaining each value._ +- `TYPEAGENT_SERVER_PATH` - `TYPEAGENT_TUNNEL_TOKEN` +- `XDG_DATA_HOME` --- -_Auto-generated against commit `b1b5bcafdde8ba2387d669eec198eb70e8fa5986` on `2026-07-17T23:52:55.795Z` by `docs-generate.yml`. Links validated at that commit; the working tree may have drifted by up to 24h. Re-run `pnpm --filter @typeagent/agent-server-client docs:verify-links` to spot-check._ +_Auto-generated against commit `6bea19a9ee02598644b1ac3ab67c705dcc495832` on `2026-07-22T11:19:17.632Z` by `docs-generate.yml`. Links validated at that commit; the working tree may have drifted by up to 24h. Re-run `pnpm --filter @typeagent/agent-server-client docs:verify-links` to spot-check._ diff --git a/ts/packages/agentServer/server/README.AUTOGEN.md b/ts/packages/agentServer/server/README.AUTOGEN.md index 64ef493c44..110558df69 100644 --- a/ts/packages/agentServer/server/README.AUTOGEN.md +++ b/ts/packages/agentServer/server/README.AUTOGEN.md @@ -3,7 +3,7 @@ - + # agent-server — AI-generated documentation @@ -12,7 +12,7 @@ ## Overview -The `agent-server` package is a TypeScript library that implements a long-running WebSocket server for hosting TypeAgent dispatchers. It acts as a central hub for managing client connections, orchestrating conversations, and facilitating communication between clients and agents. The server supports multiple clients and conversations simultaneously, with features like conversation persistence, idle timeouts, and ephemeral conversation cleanup. +The `agent-server` package is a TypeScript library that implements a long-running WebSocket server for hosting TypeAgent dispatchers. It serves as the central hub for managing client connections, orchestrating conversations, and facilitating communication between clients and agents. The server supports multiple clients and conversations simultaneously, with features like conversation persistence, idle timeouts, and ephemeral conversation cleanup. ## What it does @@ -169,6 +169,6 @@ _8 environment variables referenced from `./src/` (set in `ts/.env` or your shel --- -_Auto-generated against commit `d9ee555d43867e97462e8fa147f7ef73b8da05ec` on `2026-07-19T20:27:13.071Z` by `docs-generate.yml`. Links validated at that commit; the working tree may have drifted by up to 24h. Re-run `pnpm --filter agent-server docs:verify-links` to spot-check._ +_Auto-generated against commit `6bea19a9ee02598644b1ac3ab67c705dcc495832` on `2026-07-22T11:19:17.632Z` by `docs-generate.yml`. Links validated at that commit; the working tree may have drifted by up to 24h. Re-run `pnpm --filter agent-server docs:verify-links` to spot-check._ diff --git a/ts/packages/agents/browser/README.AUTOGEN.md b/ts/packages/agents/browser/README.AUTOGEN.md index 271aade55f..a14d784320 100644 --- a/ts/packages/agents/browser/README.AUTOGEN.md +++ b/ts/packages/agents/browser/README.AUTOGEN.md @@ -3,7 +3,7 @@ - + # browser-typeagent — AI-generated documentation @@ -16,7 +16,7 @@ The `browser-typeagent` package is a TypeAgent application agent designed for br ## What it does -The `browser-typeagent` package provides a comprehensive set of browser automation capabilities, enabling users to interact with web pages and manage browser sessions programmatically. Key functionalities include: +The `browser-typeagent` package provides a wide range of browser automation capabilities, enabling users to interact with web pages and manage browser sessions programmatically. Key functionalities include: - **Web Navigation**: Actions such as `openWebPage`, `goBack`, `goForward`, and `reloadPage` allow users to navigate between web pages and control browser tabs. - **User Interaction**: Users can interact with web content using actions like `clickOn`, `followLinkByText`, `scrollDown`, and `scrollUp`. @@ -87,8 +87,8 @@ The `browser-typeagent` package is organized into several key files, each respon - [src/agent/browserSchema.agr](./src/agent/browserSchema.agr): Contains the action grammar for the browser agent. - **Extension Components**: - - [src/extension/contentScript/index.ts](./src/extension/contentScript/index.ts): Entry point for the browser extension's content script. - - [src/extension/serviceWorker/index.ts](./src/extension/serviceWorker/index.ts): Manages the service worker for the browser extension. + - src/extension/contentScript/index.ts: Entry point for the browser extension's content script. + - src/extension/serviceWorker/index.ts: Manages the service worker for the browser extension. ## How to extend @@ -123,11 +123,7 @@ By following these steps, you can enhance the `browser-typeagent` package to sup - `./agent/manifest` → [./src/agent/manifest.json](./src/agent/manifest.json) - `./agent/handlers` → [./dist/agent/browserActionHandler.mjs](./dist/agent/browserActionHandler.mjs) -- `./agent/types` → [./dist/common/browserControl.mjs](./dist/common/browserControl.mjs) - `./agent/indexing` → [./dist/agent/indexing/browserIndexingService.js](./dist/agent/indexing/browserIndexingService.js) -- `./contentScriptRpc/types` → [./dist/common/contentScriptRpc/types.mjs](./dist/common/contentScriptRpc/types.mjs) -- `./contentScriptRpc/client` → [./dist/common/contentScriptRpc/client.mjs](./dist/common/contentScriptRpc/client.mjs) -- `./htmlReducer` → [./dist/common/crossContextHtmlReducer.js](./dist/common/crossContextHtmlReducer.js) ### Dependencies @@ -142,6 +138,7 @@ Workspace: - [@typeagent/agent-server-client](../../../packages/agentServer/client/README.md) - [@typeagent/agent-server-protocol](../../../packages/agentServer/protocol/README.md) - [@typeagent/aiclient](../../../packages/aiclient/README.md) +- [@typeagent/browser-control-rpc](../../../packages/agents/browserControlRpc/README.md) - [@typeagent/common-utils](../../../packages/utils/commonUtils/README.md) - [@typeagent/config](../../../packages/config/README.md) - [@typeagent/dispatcher-rpc](../../../packages/dispatcher/rpc/README.md) @@ -158,15 +155,14 @@ Workspace: - [website-memory](../../../packages/memory/website/README.md) - [websocket-channel-server](../../../packages/utils/webSocketChannelServer/README.md) -External: `@anthropic-ai/claude-agent-sdk`, `@modelcontextprotocol/sdk`, `@mozilla/readability`, `@popperjs/core`, `bootstrap`, `chalk`, `cheerio`, `cytoscape`, `cytoscape-dagre`, `dagre`, `debug`, `dompurify`, `express`, `express-rate-limit`, `graphology`, `graphology-communities-louvain`, `graphology-layout`, `graphology-layout-forceatlas2`, `graphology-layout-noverlap`, `graphology-types` +External: `@anthropic-ai/claude-agent-sdk`, `@modelcontextprotocol/sdk`, `chalk`, `cheerio`, `debug`, `dompurify`, `express`, `express-rate-limit`, `graphology`, `graphology-communities-louvain`, `graphology-layout`, `graphology-layout-forceatlas2`, `graphology-layout-noverlap`, `graphology-types`, `html-to-text`, `jsdom`, `jsonpath`, `pdfjs-dist`, `puppeteer`, `puppeteer-extra` -_…and 18 more not shown._ +_…and 10 more not shown._ ### Used by - [agent-shell](../../../packages/shell/README.md) - [default-agent-provider](../../../packages/defaultAgentProvider/README.md) -- utility-typeagent ### Files of interest @@ -175,12 +171,12 @@ _…and 18 more not shown._ - [./src/agent/browserSchema.agr](./src/agent/browserSchema.agr) - [./src/agent/indexing/index.mts](./src/agent/indexing/index.mts) - [./src/agent/webFlows/index.mts](./src/agent/webFlows/index.mts) -- [./src/extension/contentScript/continuationHandler.ts](./src/extension/contentScript/continuationHandler.ts) -- [./src/extension/contentScript/index.ts](./src/extension/contentScript/index.ts) -- [./src/extension/contentScript/recording/index.ts](./src/extension/contentScript/recording/index.ts) -- [./src/extension/serviceWorker/index.ts](./src/extension/serviceWorker/index.ts) -- [./src/extension/webagent/crossword/crosswordSchema.agr](./src/extension/webagent/crossword/crosswordSchema.agr) -- _…and 294 more under `./src/`._ +- [./src/puppeteer/index.mts](./src/puppeteer/index.mts) +- [./src/agent/agentServiceHandlers.mts](./src/agent/agentServiceHandlers.mts) +- [./src/agent/agentWebSocketServer.mts](./src/agent/agentWebSocketServer.mts) +- [./src/agent/browserActionHandler.mts](./src/agent/browserActionHandler.mts) +- [./src/agent/browserActions.mts](./src/agent/browserActions.mts) +- _…and 161 more under `./src/`._ ### Environment variables @@ -191,6 +187,6 @@ _2 environment variables referenced from `./src/` (set in `ts/.env` or your shel --- -_Auto-generated against commit `d9ee555d43867e97462e8fa147f7ef73b8da05ec` on `2026-07-19T20:27:13.071Z` by `docs-generate.yml`. Links validated at that commit; the working tree may have drifted by up to 24h. Re-run `pnpm --filter browser-typeagent docs:verify-links` to spot-check._ +_Auto-generated against commit `6bea19a9ee02598644b1ac3ab67c705dcc495832` on `2026-07-22T11:19:17.632Z` by `docs-generate.yml`. Links validated at that commit; the working tree may have drifted by up to 24h. Re-run `pnpm --filter browser-typeagent docs:verify-links` to spot-check._ diff --git a/ts/packages/agents/browserControlRpc/README.AUTOGEN.md b/ts/packages/agents/browserControlRpc/README.AUTOGEN.md new file mode 100644 index 0000000000..e5d60a6bc0 --- /dev/null +++ b/ts/packages/agents/browserControlRpc/README.AUTOGEN.md @@ -0,0 +1,116 @@ + + + + + + + + +# @typeagent/browser-control-rpc — AI-generated documentation + +> 🤖 **AI-authored documentation**, regenerated daily and validated for length, tone, and link integrity. Cross-check against the deterministic Reference section below before relying on specifics. Hand-written context from [`./README.md`](./README.md) was provided to the model as authoritative source. May lag the working tree by up to 24h — see the staleness footer at the end of this file. + +## Overview + +The `@typeagent/browser-control-rpc` package provides browser control types and a content script RPC client for the TypeAgent framework. It facilitates communication between browser agents and other components, enabling actions such as controlling browser tabs, extracting knowledge from web pages, and managing browser settings. + +This package is a core part of the TypeAgent ecosystem, supporting browser-related operations and interactions. It is used by other packages like `@typeagent/browser-extension` and `agent-shell` to implement browser automation and data extraction workflows. + +## What it does + +The package defines a set of types, interfaces, and RPC mechanisms to control browser behavior and facilitate communication between browser agents and other system components. Key capabilities include: + +- **Browser Control**: Actions such as `openWebPage`, `closeWebPage`, `goBack`, `goForward`, `reload`, and `zoomIn` allow for programmatic control of browser tabs and navigation. +- **Knowledge Extraction**: Functions like `extractKnowledgeFromPage` and `searchWebMemories` enable the extraction and querying of knowledge from web pages. +- **Content Script RPC**: Provides a client for communicating with content scripts, enabling cross-context messaging between browser extensions and agents. +- **Event Handling**: Defines events such as `connectionStatusChanged` and `knowledgeExtractionProgress` to track the state of browser operations and workflows. +- **HTML Reduction**: Includes utilities for reducing HTML size by removing unnecessary elements and attributes, ensuring compatibility across browser and Node.js contexts. +- **PDF Support**: Defines types and interfaces for managing PDF documents, including annotations, viewer state, and search results. + +This package integrates with other TypeAgent components to provide a unified interface for browser-related tasks. + +## Setup + +No special setup is required for this package beyond installing it as part of the TypeAgent monorepo. Dependencies are managed within the workspace, and the package relies on `@typeagent/agent-rpc` and the external library `dompurify`. + +If you are working with this package in isolation, ensure that all workspace dependencies are installed using `pnpm install` from the root of the monorepo. + +## Key Files + +The package is organized into several key files, each responsible for specific functionality: + +- **[browserControl.ts](./src/browserControl.ts)**: Defines the main browser control functions, such as `openWebPage`, `closeWebPage`, and navigation-related actions like `goBack` and `goForward`. +- **[webAgentMessageTypes.ts](./src/webAgentMessageTypes.ts)**: Contains type definitions for messages exchanged between web agents and the dispatcher, including registration, RPC, and disconnection messages. +- **[serviceTypes.ts](./src/serviceTypes.ts)**: Defines agent-side operations for knowledge extraction and querying, such as `extractKnowledgeFromPage` and `searchWebMemories`. +- **[extensionEvents.ts](./src/extensionEvents.ts)**: Specifies the structure of events emitted by the browser extension, such as `connectionStatusChanged` and `settingsUpdated`. +- **[platformServices.ts](./src/platformServices.ts)**: Provides interfaces for platform-specific services like storage, tab management, and WebSocket connection checks. +- **[crossContextHtmlReducer.ts](./src/crossContextHtmlReducer.ts)**: Implements a utility for reducing HTML size, compatible with both browser and Node.js environments. +- **[pdfTypes.ts](./src/pdfTypes.ts)**: Defines types for managing PDF documents, including viewer state, annotations, and search results. +- **[answerEnhancement.ts](./src/answerEnhancement.ts)**: Contains types for answer enhancement, including dynamic summaries and follow-up suggestions. + +These files collectively define the package's functionality and serve as the foundation for browser-related operations in the TypeAgent ecosystem. + +## How to extend + +To extend the functionality of this package, follow these steps: + +1. **Understand the Existing Structure**: Start by reviewing the key files mentioned above to understand the current capabilities and patterns used in the package. +2. **Add New Browser Actions**: If you need to add new browser control actions, modify or extend the [browserControl.ts](./src/browserControl.ts) file. Ensure that new actions are well-documented and tested. +3. **Extend Message Types**: To introduce new message types for communication, update [webAgentMessageTypes.ts](./src/webAgentMessageTypes.ts) and ensure compatibility with existing message handlers. +4. **Enhance Knowledge Extraction**: If your changes involve knowledge extraction or querying, extend the relevant functions in [serviceTypes.ts](./src/serviceTypes.ts). +5. **Update Event Handling**: For new events, add definitions to [extensionEvents.ts](./src/extensionEvents.ts) and ensure they are emitted and handled appropriately. +6. **Test Your Changes**: Write unit tests for any new functionality and run the existing test suite to ensure that your changes do not introduce regressions. + +By following these steps, you can contribute new features or enhancements to the `@typeagent/browser-control-rpc` package while maintaining consistency with its existing design. + +## Reference + +> ⚙️ **Auto-generated, no AI involvement.** Built deterministically from `package.json`, `src/`, and the workspace dependency graph at the commit recorded in the staleness footer at the end of this file. Hand edits to this file will be overwritten on the next run. + +### Entry points + +- `./types` → [./dist/browserControl.js](./dist/browserControl.js) +- `./webAgentMessageTypes` → [./dist/webAgentMessageTypes.js](./dist/webAgentMessageTypes.js) +- `./serviceTypes` → [./dist/serviceTypes.js](./dist/serviceTypes.js) +- `./extensionEvents` → [./dist/extensionEvents.js](./dist/extensionEvents.js) +- `./platformServices` → [./dist/platformServices.js](./dist/platformServices.js) +- `./htmlReducer` → [./dist/crossContextHtmlReducer.js](./dist/crossContextHtmlReducer.js) +- `./pdfTypes` → [./dist/pdfTypes.js](./dist/pdfTypes.js) +- `./answerEnhancement` → [./dist/answerEnhancement.js](./dist/answerEnhancement.js) +- `./contentScriptRpc/types` → [./dist/contentScriptRpc/types.js](./dist/contentScriptRpc/types.js) +- `./contentScriptRpc/client` → [./dist/contentScriptRpc/client.js](./dist/contentScriptRpc/client.js) + +### Dependencies + +Workspace: + +- [@typeagent/agent-rpc](../../../packages/agentRpc/README.md) + +External: `dompurify` + +### Used by + +- [@typeagent/browser-extension](../../../packages/agents/browserExtension/README.md) +- [agent-shell](../../../packages/shell/README.md) +- [browser-typeagent](../../../packages/agents/browser/README.md) +- utility-typeagent + +### Files of interest + +- [./src/answerEnhancement.ts](./src/answerEnhancement.ts) +- [./src/browserControl.ts](./src/browserControl.ts) +- [./src/contentScriptRpc/client.ts](./src/contentScriptRpc/client.ts) +- [./src/contentScriptRpc/types.ts](./src/contentScriptRpc/types.ts) +- [./src/crossContextHtmlReducer.ts](./src/crossContextHtmlReducer.ts) +- [./src/extensionEvents.ts](./src/extensionEvents.ts) +- [./src/pdfTypes.ts](./src/pdfTypes.ts) +- [./src/platformServices.ts](./src/platformServices.ts) +- [./src/serviceTypes.ts](./src/serviceTypes.ts) +- [./src/tsconfig.json](./src/tsconfig.json) +- _…and 1 more under `./src/`._ + +--- + +_Auto-generated against commit `6bea19a9ee02598644b1ac3ab67c705dcc495832` on `2026-07-22T11:19:17.632Z` by `docs-generate.yml`. Links validated at that commit; the working tree may have drifted by up to 24h. Re-run `pnpm --filter @typeagent/browser-control-rpc docs:verify-links` to spot-check._ + + diff --git a/ts/packages/agents/browserExtension/README.AUTOGEN.md b/ts/packages/agents/browserExtension/README.AUTOGEN.md new file mode 100644 index 0000000000..4fc55e08bc --- /dev/null +++ b/ts/packages/agents/browserExtension/README.AUTOGEN.md @@ -0,0 +1,118 @@ + + + + + + + + +# @typeagent/browser-extension — AI-generated documentation + +> 🤖 **AI-authored documentation**, regenerated daily and validated for length, tone, and link integrity. Cross-check against the deterministic Reference section below before relying on specifics. Hand-written context from [`./README.md`](./README.md) was provided to the model as authoritative source. May lag the working tree by up to 24h — see the staleness footer at the end of this file. + +## Overview + +The `@typeagent/browser-extension` package provides the browser extension implementation for the TypeAgent system, supporting both Chrome and Electron environments. It enables automation of browser actions, interaction with web content, and integration with the broader TypeAgent ecosystem. This package is a key component for enabling browser-based agents to perform tasks such as content discovery, indexing, and interaction. + +## What it does + +This package implements a browser extension that integrates with the TypeAgent framework. It supports the following capabilities: + +- **Content Discovery and Indexing**: The extension includes features for automatic discovery (`autoDiscovery`) and indexing (`autoIndexing`) of web content. These features can be configured to exclude sensitive sites, adjust indexing quality, and focus on specific content types. +- **Content Interaction**: The extension provides utilities for interacting with web elements, such as retrieving bounding boxes of interactive elements, matching elements against patterns, and checking visibility. +- **Agent Activation**: The extension manages the activation and deactivation of site-specific agents, ensuring that the appropriate agent is enabled for the current context. +- **Cross-Environment Support**: The extension is designed to work in both Chrome and Electron environments, with mechanisms to handle environment-specific differences, such as tab management and API availability. +- **Integration with TypeAgent Ecosystem**: The extension communicates with other TypeAgent components, such as the dispatcher and agent server, to coordinate actions and share data. + +The extension supports a variety of actions, including `autoDiscovery`, `autoIndexing`, and `getInteractiveElementsBoundingBoxes`. These actions are implemented in the content scripts and are triggered based on user interaction or predefined rules. + +## Setup + +To use this package, ensure the following setup steps are completed: + +1. **Environment Variables**: No specific environment variables are required for this package. +2. **Browser Extension Installation**: The extension must be built and installed in the target browser (e.g., Chrome or Electron). Refer to the build and installation instructions in the hand-written README for details. +3. **Dependencies**: The package relies on several internal and external dependencies, such as `@typeagent/agent-sdk`, `@mozilla/readability`, and `dompurify`. These dependencies are managed automatically during the build process. + +## Key Files + +The package's source code is organized into several key areas: + +- **Content Scripts**: + + - [`autoDiscovery.ts`](./src/extension/contentScript/autoDiscovery.ts): Manages automatic discovery of web content, including settings management and navigation listeners. + - [`autoIndexing.ts`](./src/extension/contentScript/autoIndexing.ts): Handles automatic indexing of web content, with configurable settings for quality and scope. + - [`continuationHandler.ts`](./src/extension/contentScript/continuationHandler.ts): Manages continuation states and tab-specific data for both Chrome and Electron environments. + - [`domUtils.ts`](./src/extension/contentScript/domUtils.ts): Provides utility functions for DOM interaction, such as visibility checks and string matching. + - [`elementInteraction.ts`](./src/extension/contentScript/elementInteraction.ts): Retrieves bounding boxes of interactive elements and facilitates interaction with web content. + +- **Electron-Specific Files**: + + - [`agentActivation.ts`](./src/electron/agentActivation.ts): Handles the activation and deactivation of site agents in the Electron environment. + - [`manifest.json`](./src/electron/manifest.json): Defines the extension's manifest for Electron, including content scripts and permissions. + +- **Configuration**: + - [`tsconfig.json`](./src/electron/tsconfig.json): TypeScript configuration for the Electron-specific code. + +## How to extend + +To extend the functionality of this package, follow these steps: + +1. **Identify the Area to Extend**: + + - For new content discovery or indexing features, start with [`autoDiscovery.ts`](./src/extension/contentScript/autoDiscovery.ts) or [`autoIndexing.ts`](./src/extension/contentScript/autoIndexing.ts). + - For new DOM interaction utilities, add functions to [`domUtils.ts`](./src/extension/contentScript/domUtils.ts) or [`elementInteraction.ts`](./src/extension/contentScript/elementInteraction.ts). + +2. **Follow Existing Patterns**: + + - Review the existing code to understand the structure and patterns used for settings management, event listeners, and API integration. + - Use the `chrome.storage` API for managing settings and the `chrome.runtime` API for communication between content scripts and the background service. + +3. **Test Your Changes**: + + - Add unit tests for new functionality where applicable. + - Test the extension in both Chrome and Electron environments to ensure compatibility. + +4. **Update Documentation**: + - Document any new actions or features in the hand-written README or other relevant documentation files. + - Ensure that the deterministic action reference table is updated to reflect new or modified actions. + +By following these guidelines, you can effectively contribute to the `@typeagent/browser-extension` package and enhance its capabilities. + +## Reference + +> ⚙️ **Auto-generated, no AI involvement.** Built deterministically from `package.json`, `src/`, and the workspace dependency graph at the commit recorded in the staleness footer at the end of this file. Hand edits to this file will be overwritten on the next run. + +### Entry points + +_No public exports declared in `package.json`._ + +### Dependencies + +Workspace: + +- [@typeagent/action-grammar-compiler](../../../packages/actionGrammarCompiler/README.md) +- [@typeagent/agent-rpc](../../../packages/agentRpc/README.md) +- [@typeagent/agent-sdk](../../../packages/agentSdk/README.md) +- [@typeagent/agent-server-client](../../../packages/agentServer/client/README.md) +- [@typeagent/agent-server-protocol](../../../packages/agentServer/protocol/README.md) +- [@typeagent/browser-control-rpc](../../../packages/agents/browserControlRpc/README.md) +- [@typeagent/dispatcher-rpc](../../../packages/dispatcher/rpc/README.md) +- [@typeagent/dispatcher-types](../../../packages/dispatcher/types/README.md) +- [chat-ui](../../../packages/chat-ui/README.md) + +External: `@mozilla/readability`, `@popperjs/core`, `bootstrap`, `cytoscape`, `cytoscape-dagre`, `dagre`, `debug`, `dompurify`, `html-to-text`, `markdown-it`, `prismjs` + +### Used by + +- [agent-shell](../../../packages/shell/README.md) + +### Files of interest + +`./src/extension/contentScript/continuationHandler.ts`, `./src/extension/contentScript/index.ts`, `./src/extension/contentScript/recording/index.ts`, …and 118 more under `./src/`. + +--- + +_Auto-generated against commit `6bea19a9ee02598644b1ac3ab67c705dcc495832` on `2026-07-22T11:19:17.632Z` by `docs-generate.yml`. Links validated at that commit; the working tree may have drifted by up to 24h. Re-run `pnpm --filter @typeagent/browser-extension docs:verify-links` to spot-check._ + + diff --git a/ts/packages/agents/code/README.AUTOGEN.md b/ts/packages/agents/code/README.AUTOGEN.md index 68c4a0ccc8..7aeab956f7 100644 --- a/ts/packages/agents/code/README.AUTOGEN.md +++ b/ts/packages/agents/code/README.AUTOGEN.md @@ -3,7 +3,7 @@ - + # code-agent — AI-generated documentation @@ -12,7 +12,7 @@ ## Overview -The `code-agent` package is a TypeAgent application agent designed to automate tasks within Visual Studio Code (VSCode). It acts as a dispatcher for code-related actions, enabling users to interact with VSCode through natural language commands. This agent is integrated with the [coda](../../coda/README.md) VSCode extension, which must be deployed for the `code-agent` to function. The agent is not enabled by default and requires explicit configuration to activate. +The `code-agent` package is a TypeAgent application agent designed to automate tasks in Visual Studio Code (VSCode). It acts as a dispatcher for code-related actions, enabling users to interact with VSCode through natural language commands. This agent integrates with the [coda](../../coda/README.md) VSCode extension, which must be deployed for the `code-agent` to function. The agent is not enabled by default and requires explicit configuration to activate. ## What it does @@ -158,6 +158,6 @@ _1 action implemented by this agent, parsed deterministically from `./src/codeAc --- -_Auto-generated against commit `5cbcf613f047f08749d0451296eb1cdc610ae414` on `2026-07-17T18:24:18.404Z` by `docs-generate.yml`. Links validated at that commit; the working tree may have drifted by up to 24h. Re-run `pnpm --filter code-agent docs:verify-links` to spot-check._ +_Auto-generated against commit `6bea19a9ee02598644b1ac3ab67c705dcc495832` on `2026-07-22T11:19:17.632Z` by `docs-generate.yml`. Links validated at that commit; the working tree may have drifted by up to 24h. Re-run `pnpm --filter code-agent docs:verify-links` to spot-check._ diff --git a/ts/packages/agents/desktop/README.AUTOGEN.md b/ts/packages/agents/desktop/README.AUTOGEN.md index 7da93f804b..c45da27921 100644 --- a/ts/packages/agents/desktop/README.AUTOGEN.md +++ b/ts/packages/agents/desktop/README.AUTOGEN.md @@ -3,7 +3,7 @@ - + # desktop-automation — AI-generated documentation @@ -166,6 +166,6 @@ _32 actions declared in the schema, none yet implemented in [`./src/actionHandle --- -_Auto-generated against commit `de9d1d44c33525463327199c8f244a24ddfdd874` on `2026-07-21T11:18:03.349Z` by `docs-generate.yml`. Links validated at that commit; the working tree may have drifted by up to 24h. Re-run `pnpm --filter desktop-automation docs:verify-links` to spot-check._ +_Auto-generated against commit `6bea19a9ee02598644b1ac3ab67c705dcc495832` on `2026-07-22T11:19:17.632Z` by `docs-generate.yml`. Links validated at that commit; the working tree may have drifted by up to 24h. Re-run `pnpm --filter desktop-automation docs:verify-links` to spot-check._ diff --git a/ts/packages/agents/markdown/README.AUTOGEN.md b/ts/packages/agents/markdown/README.AUTOGEN.md index 9cdb6f1df8..2169a9ad68 100644 --- a/ts/packages/agents/markdown/README.AUTOGEN.md +++ b/ts/packages/agents/markdown/README.AUTOGEN.md @@ -3,7 +3,7 @@ - + # markdown-agent — AI-generated documentation @@ -12,26 +12,23 @@ ## Overview -The `markdown-agent` is a TypeAgent application agent designed to handle the creation, editing, and management of markdown documents. It supports a variety of use cases, including real-time collaboration, AI-assisted updates, and advanced markdown processing. The agent is particularly suited for working with GitHub-flavored markdown and integrates with several libraries, such as `@milkdown/core` and `@typeagent/aiclient`, to provide enhanced functionality. - -This package is part of the TypeAgent monorepo and serves as a sample implementation for exploring markdown editing scenarios. +The `markdown-agent` is a TypeAgent application agent designed to handle markdown document creation, editing, and management. It supports a variety of use cases, including real-time collaboration, AI-assisted updates, and advanced markdown processing. This package is part of the TypeAgent monorepo and serves as a sample implementation for exploring markdown editing scenarios, particularly with GitHub-flavored markdown. ## What it does -The `markdown-agent` provides a set of actions to facilitate markdown document management. These actions include: +The `markdown-agent` provides a set of actions to manage markdown documents effectively. These actions include: - **`createDocument`**: Creates a new markdown document with a specified name. - **`openDocument`**: Opens an existing markdown document for editing. - **`updateDocument`**: Updates a document by performing operations such as inserting, deleting, replacing, or formatting text. - **`streamingUpdateDocument`**: Enables real-time updates to a document using AI streaming support, allowing for dynamic and interactive editing. -The agent leverages a combination of tools and libraries to deliver its functionality: - -- **Markdown processing**: Utilizes `@milkdown/core` and related plugins for rendering and editing markdown content. -- **Real-time collaboration**: Employs Yjs for collaborative editing, enabling multiple users to work on the same document simultaneously. -- **AI-assisted updates**: Integrates with AI models via `@typeagent/aiclient` to provide intelligent suggestions and real-time content updates. +### Key Features -These features make the `markdown-agent` a versatile tool for both individual and collaborative markdown editing workflows. +1. **Markdown Processing**: The agent uses the `@milkdown` library and its plugins for rendering and editing markdown content. It supports both CommonMark and GitHub-flavored markdown. +2. **Real-Time Collaboration**: The agent integrates with Yjs to enable multiple users to collaborate on the same document in real time. +3. **AI-Assisted Updates**: By leveraging `@typeagent/aiclient`, the agent provides intelligent suggestions and real-time content updates powered by AI models. +4. **Advanced Document Operations**: The agent supports a variety of document operations, including inserting, deleting, replacing, and formatting content. These operations are defined in the [markdownOperationSchema.ts](./src/agent/markdownOperationSchema.ts) file. ## Setup @@ -40,7 +37,7 @@ To configure the `markdown-agent`, you need to set the following environment var - **`MARKDOWN_FILE`**: Specifies the path to the markdown file to be edited. This can be an absolute or relative path. - **`TYPEAGENT_MARKDOWN_ROOT`**: Defines the root directory for markdown files. This is used as the base directory for file operations. -You can set these variables in your shell or in the `ts/.env` file. For additional details on obtaining and configuring these values, refer to the hand-written README. +These variables can be set in your shell or in the `ts/.env` file. For more details on obtaining and configuring these values, refer to the hand-written README. ## Key Files @@ -48,11 +45,11 @@ The `markdown-agent` is implemented across several key files, each responsible f ### Manifest -- **[markdownManifest.json](./src/agent/markdownManifest.json)**: This file contains metadata about the agent, including its description, supported actions, and schema details. It also specifies the emoji identifier for the agent and the schema file used for action validation. +- **[markdownManifest.json](./src/agent/markdownManifest.json)**: Contains metadata about the agent, including its description, supported actions, and schema details. It also specifies the emoji identifier for the agent and the schema file used for action validation. ### Action Handlers -- **[markdownActionHandler.ts](./src/agent/markdownActionHandler.ts)**: This file implements the core logic for handling actions such as `createDocument`, `openDocument`, `updateDocument`, and `streamingUpdateDocument`. It serves as the main entry point for executing and validating actions. +- **[markdownActionHandler.ts](./src/agent/markdownActionHandler.ts)**: Implements the core logic for handling actions such as `createDocument`, `openDocument`, `updateDocument`, and `streamingUpdateDocument`. This file serves as the main entry point for executing and validating actions. ### Schemas @@ -61,7 +58,7 @@ The `markdown-agent` is implemented across several key files, each responsible f ### Translator -- **[translator.ts](./src/agent/translator.ts)**: This file integrates AI models and translates user actions into document operations. It is a critical component for enabling AI-assisted updates and real-time collaboration. +- **[translator.ts](./src/agent/translator.ts)**: Integrates AI models and translates user actions into document operations. It is a critical component for enabling AI-assisted updates and real-time collaboration. ### Collaboration Manager @@ -103,7 +100,7 @@ By following these steps, you can enhance the `markdown-agent` to support additi ### Entry points - `./agent/manifest` → [./src/agent/markdownManifest.json](./src/agent/markdownManifest.json) -- `./agent/handlers` → `./dist/agent/markdownActionHandler.js` _(not found on disk)_ +- `./agent/handlers` → [./dist/agent/markdownActionHandler.js](./dist/agent/markdownActionHandler.js) ### Dependencies @@ -135,6 +132,6 @@ _2 environment variables referenced from `./src/` (set in `ts/.env` or your shel --- -_Auto-generated against commit `44b34a9ac8794b6f90489ff7e55fe57283c34960` on `2026-07-13T09:04:14.089Z` by `docs-generate.yml`. Links validated at that commit; the working tree may have drifted by up to 24h. Re-run `pnpm --filter markdown-agent docs:verify-links` to spot-check._ +_Auto-generated against commit `6bea19a9ee02598644b1ac3ab67c705dcc495832` on `2026-07-22T11:19:17.632Z` by `docs-generate.yml`. Links validated at that commit; the working tree may have drifted by up to 24h. Re-run `pnpm --filter markdown-agent docs:verify-links` to spot-check._ diff --git a/ts/packages/agents/onboarding/README.AUTOGEN.md b/ts/packages/agents/onboarding/README.AUTOGEN.md index 28f06e3355..802666dc13 100644 --- a/ts/packages/agents/onboarding/README.AUTOGEN.md +++ b/ts/packages/agents/onboarding/README.AUTOGEN.md @@ -3,7 +3,7 @@ - + # onboarding-agent — AI-generated documentation @@ -164,6 +164,6 @@ _4 actions implemented by this agent, parsed deterministically from `./src/onboa --- -_Auto-generated against commit `c97eb42726a9196c7ac72138faa0777c5cbc1aab` on `2026-07-18T09:48:36.613Z` by `docs-generate.yml`. Links validated at that commit; the working tree may have drifted by up to 24h. Re-run `pnpm --filter onboarding-agent docs:verify-links` to spot-check._ +_Auto-generated against commit `6bea19a9ee02598644b1ac3ab67c705dcc495832` on `2026-07-22T11:19:17.632Z` by `docs-generate.yml`. Links validated at that commit; the working tree may have drifted by up to 24h. Re-run `pnpm --filter onboarding-agent docs:verify-links` to spot-check._ diff --git a/ts/packages/agents/studio/README.AUTOGEN.md b/ts/packages/agents/studio/README.AUTOGEN.md index c5e11eed2c..164b2641ed 100644 --- a/ts/packages/agents/studio/README.AUTOGEN.md +++ b/ts/packages/agents/studio/README.AUTOGEN.md @@ -3,7 +3,7 @@ - + # studio-agent — AI-generated documentation @@ -12,13 +12,13 @@ ## Overview -The `studio-agent` package is a TypeAgent application agent that serves as the conversational interface for the TypeAgent Studio runtime. It provides developers with tools to inspect, monitor, and debug the Studio environment. By exposing read-only actions, the agent allows users to query the state of the Studio environment, identify schema collisions, and review recent events. This agent is a key component of the TypeAgent ecosystem, supporting the development and validation of other agents. +The `studio-agent` package is a TypeAgent application agent that acts as the conversational interface for the TypeAgent Studio runtime. It enables developers to inspect, monitor, and debug the Studio environment by exposing read-only actions. These actions provide insights into the Studio's configuration, schema collisions, and recent events, making it a critical tool for managing and troubleshooting the TypeAgent ecosystem. ## What it does -The `studio-agent` package implements three read-only actions that provide insights into the TypeAgent Studio environment: +The `studio-agent` provides three key read-only actions that allow developers to interact with the TypeAgent Studio environment: -- **`getStudioInfo`**: This action reports the Studio's environment, including the repository root and the directories it scans for agent packages. It also provides the count of agent packages in each directory. This is useful for verifying that Studio is configured correctly and scanning the intended locations. +- **`getStudioInfo`**: This action provides an overview of the Studio environment, including the repository root being inspected, the directories scanned for agent packages, and the number of agent packages in each directory. It is useful for verifying that Studio is correctly configured and scanning the intended locations. - **`listCollisions`**: This action lists cross-schema grammar collisions detected by Studio, ordered from newest to oldest. These collisions are identified during grammar scans and are essential for debugging and resolving conflicts between agent schemas. @@ -30,7 +30,7 @@ These actions are designed to provide developers with a clear understanding of t To use the `studio-agent` package, you need to configure the following environment variable: -- **`STUDIO_REGISTRY_PORT`**: This variable specifies the port on which the Studio registry server will run. It is required for the agent to communicate with the Studio service. If additional details on how to set this variable are provided in the hand-written README, refer to that document for guidance. +- **`STUDIO_REGISTRY_PORT`**: Specifies the port on which the Studio registry server will run. This is required for the agent to communicate with the Studio service. If additional details on how to set this variable are provided in the hand-written README, refer to that document for guidance. Ensure that the environment variable is set in your shell or in the `ts/.env` file before running the agent. @@ -38,15 +38,15 @@ Ensure that the environment variable is set in your shell or in the `ts/.env` fi The `studio-agent` package is organized into several key files, each with a specific role in the agent's functionality: -- **[studioActionHandler.ts](./src/studioActionHandler.ts)**: This file contains the main logic for the agent, including the `executeAction` function that processes the supported actions. It also manages the initialization, updating, and closing of the agent context. +- **[studioActionHandler.ts](./src/studioActionHandler.ts)**: Contains the main logic for the agent, including the `executeAction` function that processes the supported actions. It also manages the initialization, updating, and closing of the agent context. -- **[studioManifest.json](./src/studioManifest.json)**: This file defines the agent's metadata, such as its description, emoji representation, and the schema file that specifies the supported actions. +- **[studioManifest.json](./src/studioManifest.json)**: Defines the agent's metadata, such as its description, emoji representation, and the schema file that specifies the supported actions. -- **[studioSchema.ts](./src/studioSchema.ts)**: This file contains the type definitions for the actions supported by the agent. It defines the structure and parameters for actions like `getStudioInfo`, `listCollisions`, and `queryEvents`. +- **[studioSchema.ts](./src/studioSchema.ts)**: Contains the type definitions for the actions supported by the agent. It defines the structure and parameters for actions like `getStudioInfo`, `listCollisions`, and `queryEvents`. -- **[inspect.ts](./src/lib/inspect.ts)**: This file provides pure Markdown formatters for the agent's read-only inspection results. These formatters are designed to be unit-testable and are used to generate human-readable output for the actions. +- **[inspect.ts](./src/lib/inspect.ts)**: Provides pure Markdown formatters for the agent's read-only inspection results. These formatters are designed to be unit-testable and are used to generate human-readable output for the actions. -- **[studioServiceLifecycle.ts](./src/lib/studioServiceLifecycle.ts)**: This file manages the lifecycle of the Studio service, including the registry server and session context. It ensures that the agent can discover and communicate with the Studio service. +- **[studioServiceLifecycle.ts](./src/lib/studioServiceLifecycle.ts)**: Manages the lifecycle of the Studio service, including the registry server and session context. It ensures that the agent can discover and communicate with the Studio service. ## How to extend @@ -85,7 +85,7 @@ By following these steps, you can extend the `studio-agent` package to support a ### Entry points - `./agent/manifest` → [./src/studioManifest.json](./src/studioManifest.json) -- `./agent/handlers` → `./dist/studioActionHandler.js` _(not found on disk)_ +- `./agent/handlers` → [./dist/studioActionHandler.js](./dist/studioActionHandler.js) ### Dependencies @@ -132,6 +132,6 @@ _3 actions implemented by this agent, parsed deterministically from `./src/studi --- -_Auto-generated against commit `44b34a9ac8794b6f90489ff7e55fe57283c34960` on `2026-07-13T09:04:14.089Z` by `docs-generate.yml`. Links validated at that commit; the working tree may have drifted by up to 24h. Re-run `pnpm --filter studio-agent docs:verify-links` to spot-check._ +_Auto-generated against commit `6bea19a9ee02598644b1ac3ab67c705dcc495832` on `2026-07-22T11:19:17.632Z` by `docs-generate.yml`. Links validated at that commit; the working tree may have drifted by up to 24h. Re-run `pnpm --filter studio-agent docs:verify-links` to spot-check._ diff --git a/ts/packages/agents/visualStudio/README.AUTOGEN.md b/ts/packages/agents/visualStudio/README.AUTOGEN.md index 9350df15b5..6d272532f8 100644 --- a/ts/packages/agents/visualStudio/README.AUTOGEN.md +++ b/ts/packages/agents/visualStudio/README.AUTOGEN.md @@ -3,7 +3,7 @@ - + # visualstudio-agent — AI-generated documentation @@ -12,21 +12,21 @@ ## Overview -The `visualstudio-agent` package integrates TypeAgent with Visual Studio through the EnvDTE automation API. It serves as the Node-side agent, enabling communication between the TypeAgent system and Visual Studio for tasks such as managing solutions, debugging, and performing editor operations. The corresponding host-side Visual Studio extension (VSIX) resides in the `host/` directory. +The `visualstudio-agent` package integrates TypeAgent with Visual Studio using the EnvDTE automation API. It acts as the Node-side agent, enabling communication between the TypeAgent system and Visual Studio for tasks such as debugging, file operations, and solution management. The corresponding host-side Visual Studio extension (VSIX) resides in the `host/` directory. -This agent facilitates communication between the TypeAgent dispatcher and Visual Studio via WebSocket channels, enabling a wide range of actions such as managing breakpoints, debugging, file operations, and more. +This agent establishes two WebSocket channels to facilitate communication: one for chat interactions and another for action dispatching. It supports a wide range of actions grouped into categories like debugging, file operations, and build management. ## What it does -The `visualstudio-agent` provides a bridge between the TypeAgent system and Visual Studio, enabling the execution of various actions within the IDE. These actions are grouped into the following categories: +The `visualstudio-agent` bridges the TypeAgent system and Visual Studio, enabling the execution of various actions within the IDE. These actions are grouped into the following categories: -- **breakpointsManagement**: Includes actions like `addBreakpoint` and `removeBreakpoint` to manage breakpoints in the Visual Studio debugger. -- **debuggingControl**: Provides basic debugging controls such as `break`, `go`, `stepInto`, `stepOut`, `stepOver`, `stop`, and `debug`. -- **fileOperations**: Actions like `openFile`, `closeAll`, and `saveAll` allow for managing files in the editor. -- **buildAndRun**: Includes solution-wide build and execution actions such as `build`, `clean`, and `run`. -- **searchAndNavigation**: Actions like `findInFiles`, `findText`, and `gotoLine` enable searching and navigating through code. -- **commandExecution**: The `executeCommand` action allows the execution of Visual Studio commands via the EnvDTE API. -- **editActions**: Includes `redo` and `undo` for basic editing operations. +- **breakpointsManagement**: Manage breakpoints with actions like `addBreakpoint` and `removeBreakpoint`. +- **debuggingControl**: Control debugging sessions with actions such as `break`, `go`, `stepInto`, `stepOut`, `stepOver`, `stop`, and `debug`. +- **fileOperations**: Perform file-related tasks like `openFile`, `closeAll`, and `saveAll`. +- **buildAndRun**: Execute solution-wide build and run tasks with actions like `build`, `clean`, and `run`. +- **searchAndNavigation**: Search and navigate code using actions like `findInFiles`, `findText`, and `gotoLine`. +- **commandExecution**: Execute Visual Studio commands via the `executeCommand` action. +- **editActions**: Perform basic editing operations with `redo` and `undo`. The agent communicates with the Visual Studio host through two WebSocket channels: @@ -121,7 +121,7 @@ By following this process, you can extend the `visualstudio-agent` to support ad ### Entry points - `./agent/manifest` → [./src/visualStudioManifest.json](./src/visualStudioManifest.json) -- `./agent/handlers` → `./dist/visualStudioActionHandler.js` _(not found on disk)_ +- `./agent/handlers` → [./dist/visualStudioActionHandler.js](./dist/visualStudioActionHandler.js) ### Dependencies @@ -162,6 +162,6 @@ _21 actions declared in the schema, none yet implemented in [`./src/visualStudio --- -_Auto-generated against commit `44b34a9ac8794b6f90489ff7e55fe57283c34960` on `2026-07-13T09:04:14.089Z` by `docs-generate.yml`. Links validated at that commit; the working tree may have drifted by up to 24h. Re-run `pnpm --filter visualstudio-agent docs:verify-links` to spot-check._ +_Auto-generated against commit `6bea19a9ee02598644b1ac3ab67c705dcc495832` on `2026-07-22T11:19:17.632Z` by `docs-generate.yml`. Links validated at that commit; the working tree may have drifted by up to 24h. Re-run `pnpm --filter visualstudio-agent docs:verify-links` to spot-check._ diff --git a/ts/packages/chat-ui/README.AUTOGEN.md b/ts/packages/chat-ui/README.AUTOGEN.md index 8e699568f4..d31483bf6f 100644 --- a/ts/packages/chat-ui/README.AUTOGEN.md +++ b/ts/packages/chat-ui/README.AUTOGEN.md @@ -3,7 +3,7 @@ - + # chat-ui — AI-generated documentation @@ -12,7 +12,7 @@ ## Overview -The `chat-ui` package provides a shared, framework-free chat user interface for TypeAgent applications. It is designed to ensure a consistent and interactive chat experience across multiple platforms, including the VS Code shell extension, the browser extension chat panel, and the Visual Studio extension webview. The package includes components for rendering user and agent messages, handling streaming updates, replaying chat history, managing connection status, and collecting user feedback. +The `chat-ui` package provides a shared, framework-free chat user interface for TypeAgent applications. It is designed to deliver a consistent and interactive chat experience across multiple platforms, including the VS Code shell extension, the browser extension chat panel, and the Visual Studio extension webview. The package includes components for rendering user and agent messages, handling streaming updates, replaying chat history, managing connection status, and collecting user feedback. ## What it does @@ -120,6 +120,6 @@ External: `ansi_up`, `dompurify`, `markdown-it` --- -_Auto-generated against commit `0b06d6a1cc9d93888e91e217057d9c148b3cc49f` on `2026-07-22T04:45:01.388Z` by `docs-generate.yml`. Links validated at that commit; the working tree may have drifted by up to 24h. Re-run `pnpm --filter chat-ui docs:verify-links` to spot-check._ +_Auto-generated against commit `6bea19a9ee02598644b1ac3ab67c705dcc495832` on `2026-07-22T11:19:17.632Z` by `docs-generate.yml`. Links validated at that commit; the working tree may have drifted by up to 24h. Re-run `pnpm --filter chat-ui docs:verify-links` to spot-check._ diff --git a/ts/packages/coda/README.AUTOGEN.md b/ts/packages/coda/README.AUTOGEN.md index 9c317feb0e..060c771950 100644 --- a/ts/packages/coda/README.AUTOGEN.md +++ b/ts/packages/coda/README.AUTOGEN.md @@ -3,7 +3,7 @@ - + # agent-coda — AI-generated documentation @@ -12,7 +12,7 @@ ## Overview -The `agent-coda` package is a TypeScript library that powers the Coda Operated Assistance (CODA) system, a voice-controlled coding assistant for Visual Studio Code (VSCode). It integrates with the TypeAgent shell or CLI to enable developers to perform coding and workspace management tasks using natural language commands. This package is designed to improve accessibility and streamline workflows by enabling hands-free interaction with the VSCode environment. +The `agent-coda` package is a TypeScript library that implements the Coda Operated Assistance (CODA) system, a voice-controlled coding assistant for Visual Studio Code (VSCode). It integrates with the TypeAgent shell or CLI to enable developers to perform coding tasks and manage their workspace using natural language commands. This package is designed to enhance accessibility and streamline workflows by enabling hands-free interaction with the VSCode environment. ## What it does @@ -137,6 +137,6 @@ _2 environment variables referenced from `./src/` (set in `ts/.env` or your shel --- -_Auto-generated against commit `de9d1d44c33525463327199c8f244a24ddfdd874` on `2026-07-21T11:18:03.349Z` by `docs-generate.yml`. Links validated at that commit; the working tree may have drifted by up to 24h. Re-run `pnpm --filter agent-coda docs:verify-links` to spot-check._ +_Auto-generated against commit `6bea19a9ee02598644b1ac3ab67c705dcc495832` on `2026-07-22T11:19:17.632Z` by `docs-generate.yml`. Links validated at that commit; the working tree may have drifted by up to 24h. Re-run `pnpm --filter agent-coda docs:verify-links` to spot-check._ diff --git a/ts/packages/defaultAgentProvider/README.AUTOGEN.md b/ts/packages/defaultAgentProvider/README.AUTOGEN.md index 241c925c60..3bb89e9f84 100644 --- a/ts/packages/defaultAgentProvider/README.AUTOGEN.md +++ b/ts/packages/defaultAgentProvider/README.AUTOGEN.md @@ -3,7 +3,7 @@ - + # default-agent-provider — AI-generated documentation @@ -12,11 +12,11 @@ ## Overview -The `default-agent-provider` package is a TypeScript library that serves as the default agent provider for the TypeAgent framework. It is a core component used by the shell and CLI to initialize and manage both built-in agents and external agent providers. This package ensures that the necessary agents and configurations are available to support the TypeAgent ecosystem, including test agents and dispatcher configurations. +The `default-agent-provider` package is a TypeScript library that acts as the default agent provider for the TypeAgent framework. It is a foundational component used by the shell and CLI to initialize and manage both built-in agents and external agent providers. This package ensures that the necessary agents, configurations, and dispatcher settings are available to support the TypeAgent ecosystem. ## What it does -The `default-agent-provider` package provides a centralized mechanism for managing agents and their configurations. Its primary responsibilities include: +The `default-agent-provider` package provides a centralized mechanism for managing agents and their configurations. Its key responsibilities include: - **Default Agent Providers**: Functions like `getDefaultAppAgentProviders` and `getDefaultConstructionProvider` supply pre-configured agent providers and construction mechanisms for initializing agents. - **Agent Source Management**: The `getDefaultAppAgentSource` function manages the connected app-agent source, including the installed-agent record store and the host-owned `@package` agent. @@ -29,7 +29,7 @@ The package includes test agents, such as the `vampire` agent, which are used to ### Collision Testing -The package also includes operational scripts for testing dispatcher functionality and agent behavior under various scenarios, such as action collision detection and optimization pipelines. These scripts are located in the `collisions` directory and are primarily used for internal testing and debugging. +The package includes operational scripts for testing dispatcher functionality and agent behavior under various scenarios, such as action collision detection and optimization pipelines. These scripts are located in the `collisions` directory and are primarily used for internal testing and debugging. ### Managing Non-Bundled Agents @@ -127,6 +127,7 @@ Workspace: - [@typeagent/aiclient](../../packages/aiclient/README.md) - [@typeagent/common-utils](../../packages/utils/commonUtils/README.md) - [@typeagent/config](../../packages/config/README.md) +- [@typeagent/dispatcher-types](../../packages/dispatcher/types/README.md) - [agent-cache](../../packages/cache/README.md) - [agent-dispatcher](../../packages/dispatcher/dispatcher/README.md) - [browser-typeagent](../../packages/agents/browser/README.md) @@ -195,6 +196,6 @@ _4 environment variables referenced from `./src/` (set in `ts/.env` or your shel --- -_Auto-generated against commit `5fc3c615e8d9fa175d635713c0ef64d7bda1ae1d` on `2026-07-15T22:53:07.031Z` by `docs-generate.yml`. Links validated at that commit; the working tree may have drifted by up to 24h. Re-run `pnpm --filter default-agent-provider docs:verify-links` to spot-check._ +_Auto-generated against commit `6bea19a9ee02598644b1ac3ab67c705dcc495832` on `2026-07-22T11:19:17.632Z` by `docs-generate.yml`. Links validated at that commit; the working tree may have drifted by up to 24h. Re-run `pnpm --filter default-agent-provider docs:verify-links` to spot-check._ diff --git a/ts/packages/memory/website/README.AUTOGEN.md b/ts/packages/memory/website/README.AUTOGEN.md index 3412c03aa6..d8e0cd051b 100644 --- a/ts/packages/memory/website/README.AUTOGEN.md +++ b/ts/packages/memory/website/README.AUTOGEN.md @@ -3,7 +3,7 @@ - + # website-memory — AI-generated documentation @@ -12,20 +12,20 @@ ## Overview -The `website-memory` package is a TypeScript library that implements structured Retrieval-Augmented Generation (RAG) for managing website visit memory. It provides tools for importing, organizing, and analyzing website data, such as bookmarks and browsing history, with advanced content extraction and knowledge processing capabilities. +The `website-memory` package is a TypeScript library designed to implement structured Retrieval-Augmented Generation (RAG) for managing website visit memory. It provides tools for importing, organizing, and analyzing website data, such as bookmarks and browsing history, with advanced content extraction and knowledge processing capabilities. ## What it does -The `website-memory` package offers a comprehensive set of features for handling website visit data: +The `website-memory` package provides a range of features for handling website visit data: -- **Data Import**: Import bookmarks and browsing history from popular browsers like Chrome and Edge. +- **Data Import**: Import bookmarks and browsing history from browsers like Chrome and Edge. - **Content Extraction**: Extract structured data from websites using four distinct modes: - `basic`: Extracts only URLs and titles. - `content`: Extracts full content and AI-processed knowledge. - `macros`: Extracts content and detects actions. - `full`: Extracts content, actions, and relationships. - **Batch Processing**: Process multiple websites concurrently with progress tracking and error handling. -- **Knowledge Extraction**: Leverage AI models to extract entities, actions, and relationships from website content. +- **Knowledge Extraction**: Use AI models to extract entities, actions, and relationships from website content. - **Indexing and Search**: Build structured data frames for visit frequency, categories, and bookmark organization. Perform semantic searches over website content and metadata. - **Graph Management**: Create and update graphs to represent relationships between topics and entities extracted from websites. - **Error Handling**: Implements strict error handling with clear messages and fallback mechanisms. @@ -34,7 +34,7 @@ The package integrates with other components in the TypeAgent ecosystem, such as ## Setup -To use the `website-memory` package, you need to configure the environment and set up any required dependencies. Follow these steps: +To use the `website-memory` package, follow these steps to configure the environment and dependencies: 1. **Install Dependencies**: Run `pnpm install` in the package directory to install all required dependencies. 2. **Set Environment Variables**: @@ -53,7 +53,7 @@ To use the `website-memory` package, you need to configure the environment and s const knowledgeExtractor = kpLib.createKnowledgeExtractor(languageModel); ``` -For more detailed setup instructions, refer to the hand-written README. +For additional setup details, refer to the hand-written README. ## Key Files @@ -68,7 +68,7 @@ The `website-memory` package is organized into several key files, each responsib ## How to extend -To extend the `website-memory` package, you can follow these steps: +To extend the `website-memory` package, follow these steps: 1. **Add or Modify Extraction Modes**: @@ -101,7 +101,7 @@ By following these steps, you can effectively extend the `website-memory` packag ### Entry points -- default → `./dist/index.js` _(not found on disk)_ +- default → [./dist/index.js](./dist/index.js) ### Dependencies @@ -130,6 +130,6 @@ External: `better-sqlite3`, `cheerio`, `debug`, `dompurify`, `get-folder-size`, --- -_Auto-generated against commit `366aaf867a7e8e5d130b6c87a365516bab725269` on `2026-07-07T09:05:05.703Z` by `docs-generate.yml`. Links validated at that commit; the working tree may have drifted by up to 24h. Re-run `pnpm --filter website-memory docs:verify-links` to spot-check._ +_Auto-generated against commit `6bea19a9ee02598644b1ac3ab67c705dcc495832` on `2026-07-22T11:19:17.632Z` by `docs-generate.yml`. Links validated at that commit; the working tree may have drifted by up to 24h. Re-run `pnpm --filter website-memory docs:verify-links` to spot-check._ diff --git a/ts/packages/shell/README.AUTOGEN.md b/ts/packages/shell/README.AUTOGEN.md index 4a8eb1e849..dde2f80c2d 100644 --- a/ts/packages/shell/README.AUTOGEN.md +++ b/ts/packages/shell/README.AUTOGEN.md @@ -3,7 +3,7 @@ - + # agent-shell — AI-generated documentation @@ -12,27 +12,27 @@ ## Overview -The `agent-shell` package is a TypeScript library that serves as the graphical user interface (GUI) entry point for the TypeAgent ecosystem. Built on Electron, it provides a personal agent interface for handling user requests, performing actions, answering questions, and managing conversations. The shell integrates with other TypeAgent components, such as the dispatcher and agent server, to deliver an interactive and extensible experience. It supports both text and voice input, multi-conversation management, and local or remote operation modes. +The `agent-shell` package is a TypeScript library that provides the graphical user interface (GUI) for the TypeAgent ecosystem. Built on Electron, it acts as a personal agent interface, enabling users to interact with an extensible set of agents to perform actions, answer questions, and manage conversations. The shell supports both text and voice input, integrates with other TypeAgent components like the dispatcher and agent server, and operates in both local and remote modes. ## What it does -The `agent-shell` package offers a range of features to enable interactive and conversational agent experiences: +The `agent-shell` package offers the following key features: ### Conversation Management -- **Multi-Conversation Support**: Users can create, switch, rename, and delete conversations. Conversations persist across sessions, and history is replayed on reconnect. -- **Default Conversation**: Automatically joins a default conversation named `"Shell"` when connected to the agent server. This conversation is persistent and serves as the starting point for interactions. +- **Multi-Conversation Support**: Users can create, switch, rename, and delete conversations. Conversations persist across sessions, with history replayed on reconnect. +- **Default Conversation**: Automatically joins a persistent default conversation named `"Shell"` when connected to the agent server. - **Commands for Conversation Management**: Users can manage conversations using commands like `/conversation list`, `/conversation new [name]`, `/conversation switch `, and more. These commands can also be executed via natural language inputs. - **Request Queue Management**: Visual indicators for queued and running requests allow users to manage and cancel requests directly from the chat interface. ### Speech Input -- **Azure Speech Services**: Enables speech-to-text functionality using Azure's cloud-based service. -- **Local Whisper Service**: Provides an alternative for speech-to-text processing using a local service. +- **Azure Speech Services**: Provides cloud-based speech-to-text functionality. +- **Local Whisper Service**: Offers an alternative for speech-to-text processing using a local service. ### Multi-Client Notifications -- The shell notifies users when other clients join or leave the same conversation, facilitating collaborative interactions. +- Notifies users when other clients join or leave the same conversation, enabling collaborative interactions. ### Local Mode @@ -176,6 +176,6 @@ _6 environment variables referenced from `./src/` (set in `ts/.env` or your shel --- -_Auto-generated against commit `8ec451103180b2a383dfb4e1c7f80c1ad50e9d35` on `2026-07-22T00:05:15.961Z` by `docs-generate.yml`. Links validated at that commit; the working tree may have drifted by up to 24h. Re-run `pnpm --filter agent-shell docs:verify-links` to spot-check._ +_Auto-generated against commit `6bea19a9ee02598644b1ac3ab67c705dcc495832` on `2026-07-22T11:19:17.632Z` by `docs-generate.yml`. Links validated at that commit; the working tree may have drifted by up to 24h. Re-run `pnpm --filter agent-shell docs:verify-links` to spot-check._ diff --git a/ts/packages/studio-service/README.AUTOGEN.md b/ts/packages/studio-service/README.AUTOGEN.md index 7707fe8abf..978b815003 100644 --- a/ts/packages/studio-service/README.AUTOGEN.md +++ b/ts/packages/studio-service/README.AUTOGEN.md @@ -3,7 +3,7 @@ - + # studio-service — AI-generated documentation @@ -16,15 +16,15 @@ The `studio-service` package is a standalone, per-workspace host for the TypeAge ## What it does -The `studio-service` package provides the following key functionalities: +The `studio-service` package provides the following core functionalities: -- **Studio Runtime Hosting**: It runs the Studio runtime, which is responsible for managing the state of the developer's workspace and executing actions within it. -- **Typed Service Channel**: The package establishes a typed `agent-rpc` service channel, enabling structured communication between the Studio runtime and its clients, such as the `studio` agent and the `typeagent-studio` extension. -- **Workspace State Management**: The service uses a file-backed `StudioWorkspaceState` implementation to persist runtime state across service restarts, ensuring continuity and durability. -- **Service Discovery and Registration**: The service includes mechanisms for announcing its availability, discovering its port and token, and enabling clients to connect securely. -- **Proxy Client**: A lightweight proxy client is provided for the `studio` agent to forward read-only actions to the standalone Studio service. +- **Studio Runtime Hosting**: It runs the Studio runtime, which manages the state of the developer's workspace and executes actions within it. +- **Typed Service Channel**: Establishes a typed `agent-rpc` service channel for structured communication between the Studio runtime and its clients, such as the `studio` agent and the `typeagent-studio` extension. +- **Workspace State Management**: Implements a file-backed `StudioWorkspaceState` to persist runtime state across service restarts, ensuring continuity and durability. +- **Service Discovery and Registration**: Includes mechanisms for announcing the service's availability, discovering its port and token, and enabling secure client connections. +- **Proxy Client**: Provides a lightweight proxy client for the `studio` agent to forward read-only actions to the standalone Studio service. -The service supports a range of actions, including workspace state management and communication with the Studio runtime. These actions are exposed through typed `agent-rpc` handlers defined in [studioRpcHandlers.ts](./src/studioRpcHandlers.ts). +The service supports a range of actions related to workspace state management and runtime communication. These actions are exposed through typed `agent-rpc` handlers defined in [studioRpcHandlers.ts](./src/studioRpcHandlers.ts). ## Setup @@ -32,7 +32,7 @@ To configure and run the `studio-service` package, you need to set the following - `TYPEAGENT_STUDIO_REPO_ROOT`: Specifies the root directory of the repository that the Studio service should inspect. If this variable is not set, the service defaults to using the current working directory. You can set this variable in your shell or in a `.env` file located in the `ts/` directory. -Once the environment variable is set, you can launch the service using the `typeagent-studio serve` CLI or programmatically via its API. For more details on the setup process, refer to the hand-written README. +Once the environment variable is set, you can launch the service using the `typeagent-studio serve` CLI or programmatically via its API. For more details, refer to the hand-written README. ## Key Files @@ -97,6 +97,6 @@ _1 environment variable referenced from `./src/` (set in `ts/.env` or your shell --- -_Auto-generated against commit `fbf54a8aff55bd1ef482ad8fbf2064bc3d38486c` on `2026-07-17T05:44:32.534Z` by `docs-generate.yml`. Links validated at that commit; the working tree may have drifted by up to 24h. Re-run `pnpm --filter studio-service docs:verify-links` to spot-check._ +_Auto-generated against commit `6bea19a9ee02598644b1ac3ab67c705dcc495832` on `2026-07-22T11:19:17.632Z` by `docs-generate.yml`. Links validated at that commit; the working tree may have drifted by up to 24h. Re-run `pnpm --filter studio-service docs:verify-links` to spot-check._ diff --git a/ts/packages/typeagent-studio/README.AUTOGEN.md b/ts/packages/typeagent-studio/README.AUTOGEN.md index a8ae5e0d2c..10d9d0194b 100644 --- a/ts/packages/typeagent-studio/README.AUTOGEN.md +++ b/ts/packages/typeagent-studio/README.AUTOGEN.md @@ -3,7 +3,7 @@ - + # typeagent-studio — AI-generated documentation @@ -12,25 +12,25 @@ ## Overview -The `typeagent-studio` package is a TypeScript library that provides the developer experience for working with TypeAgent agents within Visual Studio Code. It offers tools for authoring, debugging, and optimizing agents, with features such as schema and grammar tuning, compare-and-replay regression detection, trace investigation, and live observation. This package is designed to support developers in creating and refining TypeAgent agents efficiently. +The `typeagent-studio` package is a TypeScript library that powers the Visual Studio Code extension for working with TypeAgent agents. It provides a developer experience tailored to agent authoring, schema and grammar tuning, regression testing through compare-and-replay, trace investigation, and live observation. This package is a critical tool for developers building and refining TypeAgent agents, offering both command-based workflows and rich visual interfaces. ## What it does -The `typeagent-studio` package integrates with Visual Studio Code to deliver a comprehensive set of tools for managing and debugging TypeAgent agents. These tools are accessible through commands and views, enabling developers to perform tasks such as onboarding, sandbox management, corpus replay, and collision detection. +The `typeagent-studio` package integrates deeply with Visual Studio Code to provide a suite of tools for managing and debugging TypeAgent agents. Its functionality is organized into commands, views, and status indicators, enabling developers to efficiently onboard, test, and optimize agents. ### Commands -The package provides a wide range of commands accessible via the VS Code command palette. These commands are grouped into several categories: +The package exposes a comprehensive set of commands through the VS Code command palette. These commands are grouped into several categories: - **Onboarding and Sandbox Management**: - Commands like `TypeAgent Studio: Start onboarding session`, `TypeAgent Studio: Run onboarding phase`, and `TypeAgent Studio: Advance onboarding phase` guide developers through the onboarding process for new agents. - - Sandbox-related commands such as `TypeAgent Studio: Start sandbox`, `TypeAgent Studio: Stop sandbox`, and `TypeAgent Studio: Refresh sandboxes` allow developers to manage and interact with sandboxes for testing and debugging. + - Sandbox-related commands such as `TypeAgent Studio: Start sandbox`, `TypeAgent Studio: Stop sandbox`, and `TypeAgent Studio: Refresh sandboxes` allow developers to manage isolated environments for testing and debugging. - **Agent and Corpus Management**: - Commands like `TypeAgent Studio: Install latest onboarding session to sandbox` and `TypeAgent Studio: Refresh corpora` help manage agents and their associated corpora. - - The `TypeAgent Studio: Replay corpus` command enables developers to replay a corpus through the `replayCorpus()` engine, facilitating regression testing and comparison of agent behavior across versions. + - The `TypeAgent Studio: Replay corpus` command enables regression testing by replaying a corpus through the `replayCorpus()` engine, comparing agent behavior across versions. - **Health and Diagnostics**: - Commands such as `TypeAgent Studio: Check packaging health gate` and `TypeAgent Studio: Enforce packaging health gate` provide insights into the health and readiness of agents. @@ -63,6 +63,10 @@ The package introduces several specialized views within the **TypeAgent Studio** - Summarizes the health of all agents loaded into running sandboxes. - Offers a quick visual indicator of the overall system health. +### Replay and Compare + +The package supports regression testing through its replay and compare functionality. Developers can replay a corpus through the `replayCorpus()` engine, which evaluates each utterance against two versions of an agent and produces a detailed comparison report. This feature is accessible via the Corpora view and provides actionable insights into changes in agent behavior. + ## Setup To set up and use the `typeagent-studio` package, follow these steps: @@ -172,6 +176,6 @@ External: `debug`, `ws` --- -_Auto-generated against commit `38f6b8e5cb0688da34e930559899bb2ea7bb0aca` on `2026-07-21T01:16:36.018Z` by `docs-generate.yml`. Links validated at that commit; the working tree may have drifted by up to 24h. Re-run `pnpm --filter typeagent-studio docs:verify-links` to spot-check._ +_Auto-generated against commit `6bea19a9ee02598644b1ac3ab67c705dcc495832` on `2026-07-22T11:19:17.632Z` by `docs-generate.yml`. Links validated at that commit; the working tree may have drifted by up to 24h. Re-run `pnpm --filter typeagent-studio docs:verify-links` to spot-check._ diff --git a/ts/packages/utils/webSocketChannelServer/README.AUTOGEN.md b/ts/packages/utils/webSocketChannelServer/README.AUTOGEN.md index 37f80cd6b8..eaf7696d34 100644 --- a/ts/packages/utils/webSocketChannelServer/README.AUTOGEN.md +++ b/ts/packages/utils/webSocketChannelServer/README.AUTOGEN.md @@ -3,7 +3,7 @@ - + # websocket-channel-server — AI-generated documentation @@ -12,65 +12,73 @@ ## Overview -The `websocket-channel-server` package provides a WebSocket server implementation for RpcChannel communication within the TypeAgent monorepo. It is designed to facilitate real-time communication between different parts of the system using WebSockets, enabling efficient and reliable RPC (Remote Procedure Call) channels. +The `websocket-channel-server` package provides a WebSocket server implementation for managing RpcChannel communication within the TypeAgent monorepo. It serves as a foundational utility for enabling real-time, bidirectional communication between various components of the system using WebSockets. This package is widely used across the monorepo to facilitate Remote Procedure Call (RPC) interactions. ## What it does -The `websocket-channel-server` package enables the creation and management of a WebSocket server that handles RPC channels. It provides functionalities to: +The `websocket-channel-server` package is responsible for creating and managing a WebSocket server that supports RPC communication. Its key capabilities include: -- Set up the WebSocket server. -- Manage WebSocket connections. -- Enforce origin policies. -- Handle RPC messages. +- **WebSocket Server Setup**: Initializes and configures a WebSocket server using the `ws` library. +- **Connection Management**: Handles WebSocket connections, including opening, closing, and maintaining active sessions. +- **Origin Policy Enforcement**: Provides an optional mechanism to restrict connections based on the `Origin` header, ensuring only trusted clients can connect. +- **RPC Message Handling**: Integrates with `@typeagent/agent-rpc` to process RPC messages over WebSocket channels. +- **Heartbeat Support**: Re-exports heartbeat utilities from `@typeagent/websocket-utils` for liveness checks, ensuring connections remain active and responsive. -This package integrates with other TypeAgent packages such as `@typeagent/agent-rpc`, `@typeagent/common-utils`, and `@typeagent/websocket-utils` to provide a comprehensive solution for RPC communication over WebSockets. It is used by several other packages within the TypeAgent monorepo, including `@typeagent/agent-server-client`, `agent-server`, and `agent-shell`. +This package integrates with other utilities in the TypeAgent ecosystem, such as `@typeagent/agent-rpc`, `@typeagent/common-utils`, and `@typeagent/websocket-utils`, to provide a cohesive solution for WebSocket-based RPC communication. It is a critical dependency for several other packages, including `@typeagent/agent-server-client`, `agent-server`, and `agent-shell`. ## Setup -To set up the `websocket-channel-server` package, follow these steps: +To use the `websocket-channel-server` package, follow these steps: -1. Install the necessary dependencies: +1. **Install Dependencies**: Ensure the required dependencies are installed in your project. Run the following command: ```sh pnpm install @typeagent/agent-rpc @typeagent/common-utils @typeagent/websocket-utils debug ws ``` -2. Ensure that the environment variables and configuration options are set up as required. Refer to the hand-written README for detailed setup instructions. +2. **Configuration**: No additional environment variables are required for this package. However, you may need to configure the `WebSocketChannelServerOptions` interface to suit your application's needs, such as specifying an `isOriginAllowed` function for origin policy enforcement. -No additional environment variables are required for this package beyond the standard configuration for WebSocket servers. +For more detailed setup instructions, refer to the hand-written README. ## Key Files -The package's architecture is centered around the WebSocket server implementation. Key files include: +The package's implementation is organized into several key files, each responsible for specific aspects of the WebSocket server: -- [index.ts](./src/index.ts): This file exports the main functionalities of the package, primarily the server implementation. -- [server.ts](./src/server.ts): Contains the core logic for setting up and managing the WebSocket server, including handling connections and RPC channels. -- [heartbeat.ts](./src/heartbeat.ts): Re-exports heartbeat primitives from `@typeagent/websocket-utils` for liveness checks. -- [tsconfig.json](./src/tsconfig.json): TypeScript configuration file that sets up the compiler options and project structure. +- **[index.ts](./src/index.ts)**: The main entry point of the package. It re-exports functionalities from other files, including the server implementation and heartbeat utilities. +- **[server.ts](./src/server.ts)**: Contains the core logic for the WebSocket server, including connection management, origin policy enforcement, and RPC message handling. +- **[heartbeat.ts](./src/heartbeat.ts)**: Re-exports heartbeat utilities from `@typeagent/websocket-utils`, providing liveness check primitives for both server and client contexts. +- **[tsconfig.json](./src/tsconfig.json)**: Configures TypeScript compiler options for the package, ensuring proper build and type-checking behavior. -### Key Components +### Core Components -- **WebSocketChannelServer**: Defined in [server.ts](./src/server.ts), this type represents the WebSocket server and includes methods for managing connections and handling RPC messages. -- **WebSocketChannelServerOptions**: An interface that extends `ws.ServerOptions` with additional options for origin allowlist, allowing for more granular control over which origins are permitted to connect. +1. **WebSocketChannelServer**: Defined in [server.ts](./src/server.ts), this type represents the WebSocket server instance. It includes methods for managing connections and handling RPC messages. +2. **WebSocketChannelServerOptions**: An interface extending `ws.ServerOptions` with additional options, such as `isOriginAllowed`, for customizing server behavior. +3. **Heartbeat Utilities**: Re-exported from `@typeagent/websocket-utils`, these utilities enable liveness checks to ensure active and responsive WebSocket connections. -### Core Logic +### Key Functions -The core logic for the WebSocket server is implemented in [server.ts](./src/server.ts). This file includes functions for: - -- Creating and managing WebSocket connections. -- Enforcing origin policies based on the `originAllowlist` option. -- Handling RPC messages using the `ChannelProvider` and `createChannelProviderAdapter` from `@typeagent/agent-rpc`. +- **`createWebSocketChannelServer`**: The primary function for initializing a WebSocket server. It accepts `WebSocketChannelServerOptions` and a connection handler callback, which processes incoming connections and establishes RPC channels. +- **`attachHeartbeat`**: A utility for adding heartbeat functionality to WebSocket connections, ensuring they remain active and responsive. ## How to extend -To extend the `websocket-channel-server` package, follow these steps: +To extend the functionality of the `websocket-channel-server` package, follow these steps: + +1. **Understand the Core Logic**: Start by reviewing the [server.ts](./src/server.ts) file, which contains the main implementation of the WebSocket server. Familiarize yourself with the `createWebSocketChannelServer` function and its options. + +2. **Add New Features**: + + - Extend the `WebSocketChannelServerOptions` interface to include additional configuration options. + - Implement new connection handlers or message processing logic to support custom use cases. + - Modify the `isOriginAllowed` function to enforce more complex origin policies if needed. + +3. **Leverage Heartbeat Utilities**: Use the re-exported heartbeat utilities from [heartbeat.ts](./src/heartbeat.ts) to add liveness checks or customize existing ones. + +4. **Write Tests**: Ensure your changes are thoroughly tested. Add test cases to validate new features or modifications. Place your tests in the appropriate test files within the package. -1. Open the [server.ts](./src/server.ts) file. This is where the core logic for the WebSocket server is implemented. -2. Add new functionalities or modify existing ones by extending the `WebSocketChannelServer` type or the `WebSocketChannelServerOptions` interface. -3. Implement additional handlers or utilities as needed to support new features or improve existing ones. -4. Write tests to ensure your changes work as expected. You can add test cases in the appropriate test files within the package. +5. **Follow Existing Patterns**: Maintain consistency with the existing codebase by adhering to the patterns and conventions used in the package. -By following these steps, you can effectively extend the capabilities of the `websocket-channel-server` package to meet your specific requirements. +By following these steps, you can effectively extend the `websocket-channel-server` package to meet your specific requirements while maintaining compatibility with the broader TypeAgent ecosystem. ## Reference @@ -104,6 +112,6 @@ External: `debug`, `ws` --- -_Auto-generated against commit `127a36a95a15e918be533d6eaaf08adebe9070d9` on `2026-06-26T03:01:52.873Z` by `docs-generate.yml`. Links validated at that commit; the working tree may have drifted by up to 24h. Re-run `pnpm --filter websocket-channel-server docs:verify-links` to spot-check._ +_Auto-generated against commit `6bea19a9ee02598644b1ac3ab67c705dcc495832` on `2026-07-22T11:19:17.632Z` by `docs-generate.yml`. Links validated at that commit; the working tree may have drifted by up to 24h. Re-run `pnpm --filter websocket-channel-server docs:verify-links` to spot-check._ diff --git a/ts/packages/vscode-shell/README.AUTOGEN.md b/ts/packages/vscode-shell/README.AUTOGEN.md index 12f187e849..5831293584 100644 --- a/ts/packages/vscode-shell/README.AUTOGEN.md +++ b/ts/packages/vscode-shell/README.AUTOGEN.md @@ -3,7 +3,7 @@ - + # vscode-shell — AI-generated documentation @@ -12,11 +12,11 @@ ## Overview -The `vscode-shell` package integrates the TypeAgent shell chat into Visual Studio Code, allowing users to interact with TypeAgent conversations directly within the editor. It provides a chat interface accessible via a side panel and editor tabs, enabling efficient conversation management and interaction. +The `vscode-shell` package integrates the TypeAgent shell chat into Visual Studio Code, providing a chat interface directly within the editor. This extension allows users to interact with TypeAgent conversations through a side panel or editor tabs, enabling efficient communication and conversation management. ## What it does -The `vscode-shell` package provides a rich chat interface within Visual Studio Code, designed to work with the TypeAgent ecosystem. Its key features include: +The `vscode-shell` package offers a feature-rich chat interface tailored for the TypeAgent ecosystem. Key capabilities include: - **Chat Interface**: @@ -174,6 +174,6 @@ External: `ansi_up`, `debug`, `dompurify`, `isomorphic-ws`, `markdown-it`, `micr --- -_Auto-generated against commit `0b06d6a1cc9d93888e91e217057d9c148b3cc49f` on `2026-07-22T04:45:01.388Z` by `docs-generate.yml`. Links validated at that commit; the working tree may have drifted by up to 24h. Re-run `pnpm --filter vscode-shell docs:verify-links` to spot-check._ +_Auto-generated against commit `6bea19a9ee02598644b1ac3ab67c705dcc495832` on `2026-07-22T11:19:17.632Z` by `docs-generate.yml`. Links validated at that commit; the working tree may have drifted by up to 24h. Re-run `pnpm --filter vscode-shell docs:verify-links` to spot-check._ From 7e85cf4337809a80f32c3a13bdae33f90d7ff060 Mon Sep 17 00:00:00 2001 From: typeagent-bot Date: Wed, 22 Jul 2026 11:33:54 +0000 Subject: [PATCH 3/3] docs: regenerate README.AUTOGEN.md, command reference, and action browser --- ts/packages/api/README.AUTOGEN.md | 17 ++-- .../utils/webSocketUtils/README.AUTOGEN.md | 93 +++++++++++++------ 2 files changed, 75 insertions(+), 35 deletions(-) diff --git a/ts/packages/api/README.AUTOGEN.md b/ts/packages/api/README.AUTOGEN.md index df795ccf89..2fb17a659e 100644 --- a/ts/packages/api/README.AUTOGEN.md +++ b/ts/packages/api/README.AUTOGEN.md @@ -3,7 +3,7 @@ - + # agent-api — AI-generated documentation @@ -12,16 +12,17 @@ ## Overview -The `agent-api` package is a TypeScript library that provides an HTTP and WebSocket API server for the TypeAgent sample code. It is part of the TypeAgent ecosystem, which explores architectures for distributed interactive agents with natural language interfaces. This package enables developers to extend the functionality of agents to web-enabled devices, such as browsers, mobile devices, and IoT-connected systems, by leveraging structured prompting and large language models (LLMs). +The `agent-api` package is a TypeScript library that provides an HTTP and WebSocket API server for the TypeAgent ecosystem. It is designed to enable distributed interactive agents with natural language interfaces, extending their functionality to web-enabled devices such as browsers, mobile devices, and IoT systems. This package is a key component of the TypeAgent architecture, facilitating communication, storage, and configuration for agent-based applications. ## What it does -The `agent-api` package offers several key features: +The `agent-api` package offers the following capabilities: -- **HTTP and WebSocket API Server**: Provides a server that supports both HTTP and WebSocket protocols, enabling real-time communication with agents. -- **Storage Provider Integration**: Supports multiple storage backends, including AWS S3 and Azure Blob Storage, for managing remote files. Actions such as `listRemoteFiles`, `downloadFile`, and `uploadFile` are implemented to interact with these storage systems. -- **Web Dispatcher**: Handles actions and commands sent to agents via WebSocket connections, enabling dynamic interaction with agents. -- **Configuration Management**: Uses environment variables to configure the server and storage providers, allowing flexibility across different deployment environments. +- **HTTP and WebSocket API Server**: Serves as the main interface for interacting with agents, supporting both HTTP and WebSocket protocols for real-time communication. +- **Storage Provider Integration**: Includes support for multiple storage backends, such as AWS S3 and Azure Blob Storage, enabling actions like `listRemoteFiles`, `downloadFile`, and `uploadFile`. +- **Web Dispatcher**: Manages WebSocket connections and processes actions sent to agents, allowing dynamic interaction and command execution. +- **Configuration Management**: Uses environment variables to configure the server and storage providers, ensuring flexibility across different deployment environments. +- **Static File Hosting**: Serves static files, such as the Shell interface (`chatView.html`), for browser-based interaction with agents. The package integrates with other components in the TypeAgent ecosystem, such as `agent-cache`, `agent-dispatcher`, and `telemetry`, to provide a cohesive framework for building and managing interactive agents. @@ -122,6 +123,6 @@ _4 environment variables referenced from `./src/` (set in `ts/.env` or your shel --- -_Auto-generated against commit `463e6bf5c6f8eeaf9cc7512e33f3976761eece62` on `2026-07-10T09:05:05.791Z` by `docs-generate.yml`. Links validated at that commit; the working tree may have drifted by up to 24h. Re-run `pnpm --filter agent-api docs:verify-links` to spot-check._ +_Auto-generated against commit `10c156699bb8436ffeeb5042da164ea166f9eb74` on `2026-07-22T11:31:33.221Z` by `docs-generate.yml`. Links validated at that commit; the working tree may have drifted by up to 24h. Re-run `pnpm --filter agent-api docs:verify-links` to spot-check._ diff --git a/ts/packages/utils/webSocketUtils/README.AUTOGEN.md b/ts/packages/utils/webSocketUtils/README.AUTOGEN.md index c01c5fcd67..a6ef44de2a 100644 --- a/ts/packages/utils/webSocketUtils/README.AUTOGEN.md +++ b/ts/packages/utils/webSocketUtils/README.AUTOGEN.md @@ -3,7 +3,7 @@ - + # @typeagent/websocket-utils — AI-generated documentation @@ -12,58 +12,91 @@ ## Overview -The `websocket-utils` package provides utility functions for working with WebSockets in the TypeAgent project. It facilitates the creation and management of WebSocket connections, enabling communication between different components of the system. +The `@typeagent/websocket-utils` package provides a set of utility functions and modules for managing WebSocket connections within the TypeAgent project. It simplifies the creation, configuration, and maintenance of WebSocket connections, enabling efficient communication between system components. + +This library is designed to handle WebSocket-specific tasks such as connection setup, origin validation, heartbeat monitoring, and retry logic. It is used by multiple agents and services across the TypeAgent ecosystem. ## What it does -The package primarily handles the creation of WebSocket connections through the `createWebSocket` function. This function allows you to specify the channel, role, client ID, port, and session ID for the WebSocket connection. It reads the WebSocket host from the environment variable `WEBSOCKET_HOST` or from a `.env` file if the environment variable is not set. The package also defines the `WebSocketMessageV2` type, which structures the messages sent over the WebSocket. +The package offers several key features for working with WebSockets: + +- **WebSocket Connection Management**: The `createWebSocket` function in [webSockets.ts](./src/webSockets.ts) facilitates the creation of WebSocket connections. It constructs the WebSocket endpoint using parameters such as channel, role, client ID, port, and session ID. The WebSocket host is determined by the `WEBSOCKET_HOST` environment variable. +- **Message Structure**: The `WebSocketMessageV2` type defines the structure of messages exchanged over WebSocket connections, including fields for method, parameters, results, and errors. + +- **Origin Allowlist**: The [originAllowlist.ts](./src/originAllowlist.ts) module provides functionality to define and enforce an allowlist of origins that are permitted to connect to the WebSocket server. This is useful for enhancing security by restricting access to trusted origins. + +- **Heartbeat Monitoring**: The [heartbeat.ts](./src/heartbeat.ts) module implements RFC 6455 ping/pong liveness checks. It ensures that inactive or unresponsive WebSocket clients are detected and terminated, maintaining the health of the connection pool. + +- **Exponential Backoff**: The [backoff.ts](./src/backoff.ts) module provides a mechanism for retrying failed WebSocket connections with exponential delays. This helps manage reconnection attempts in a controlled manner. -Additionally, the package includes functionality for managing origin allowlists through the `originAllowlist` module. This module helps in setting up security measures by defining which origins are allowed to connect to the WebSocket server. The `heartbeat` module provides functionality to attach RFC 6455 ping/pong liveness checks to WebSocket clients, ensuring that dead peers are detected and terminated promptly. +- **RPC Channel Integration**: The [rpcChannel.ts](./src/rpcChannel.ts) module adapts WebSocket connections to the `agent-rpc` `RpcChannel` interface, enabling JSON-based message exchange and integration with the broader TypeAgent RPC system. + +These features collectively support reliable WebSocket communication and are used by various agents and services in the TypeAgent project. ## Setup -To use the `websocket-utils` package, you need to set the `WEBSOCKET_HOST` environment variable. This variable specifies the host for the WebSocket connection. You can set it directly in your environment or in a `.env` file located in your project directory. +To use the `@typeagent/websocket-utils` package, you need to configure the `WEBSOCKET_HOST` environment variable. This variable specifies the host for WebSocket connections. 1. Set the `WEBSOCKET_HOST` environment variable: - Directly in your shell: ```sh export WEBSOCKET_HOST="ws://your-websocket-host" ``` - - Or in a `.env` file: + - Or in a `.env` file in your project directory: ```text WEBSOCKET_HOST=ws://your-websocket-host ``` -For detailed setup instructions, see the hand-written README. +For additional setup details, refer to the hand-written README. ## Key Files -The package consists of the following key files: +The package is organized into several key files, each responsible for specific functionality: + +- **[index.ts](./src/index.ts)**: Serves as the entry point for the package, re-exporting functions and types from [webSockets.ts](./src/webSockets.ts). + +- **[webSockets.ts](./src/webSockets.ts)**: Contains the `createWebSocket` function, which is the primary method for establishing WebSocket connections. It also defines the `WebSocketMessageV2` type for structuring WebSocket messages. + +- **[originAllowlist.ts](./src/originAllowlist.ts)**: Implements logic for managing an origin allowlist, ensuring that only trusted origins can connect to the WebSocket server. + +- **[heartbeat.ts](./src/heartbeat.ts)**: Provides functionality for monitoring WebSocket connection liveness using ping/pong messages. It detects and terminates unresponsive clients. -- [index.ts](./src/index.ts): Exports the functions and types from `webSockets.ts`. -- [webSockets.ts](./src/webSockets.ts): Contains the main logic for creating WebSocket connections and defines the `WebSocketMessageV2` type. -- [originAllowlist.ts](./src/originAllowlist.ts): Manages the origin allowlist for WebSocket connections, ensuring that only allowed origins can connect. -- [heartbeat.ts](./src/heartbeat.ts): Implements the heartbeat functionality to maintain WebSocket connection liveness. -- [tsconfig.json](./src/tsconfig.json): TypeScript configuration file that extends the base configuration and specifies compiler options. +- **[rpcChannel.ts](./src/rpcChannel.ts)**: Adapts WebSocket connections to the `agent-rpc` `RpcChannel` interface, enabling JSON-based communication and integration with the TypeAgent RPC system. -The `createWebSocket` function in [webSockets.ts](./src/webSockets.ts) is the core of the package. It constructs the WebSocket endpoint using the provided parameters and environment variables, and returns a promise that resolves to a WebSocket instance. +- **[backoff.ts](./src/backoff.ts)**: Implements an exponential backoff mechanism for retrying failed WebSocket connections. It provides configurable options for base delay and maximum delay. + +- **[tsconfig.json](./src/tsconfig.json)**: TypeScript configuration file that extends the base configuration and specifies compiler options for the package. ## How to extend -To extend the `websocket-utils` package, follow these steps: +To extend the functionality of the `@typeagent/websocket-utils` package, follow these steps: + +1. **Understand the Existing Code**: + + - Start by reviewing the [webSockets.ts](./src/webSockets.ts) file to understand how WebSocket connections are created and managed. + - Explore other modules such as [originAllowlist.ts](./src/originAllowlist.ts) and [heartbeat.ts](./src/heartbeat.ts) to see how they contribute to the overall functionality. + +2. **Add New Features**: + + - Introduce new functions or modify existing ones to support additional WebSocket features or configurations. + - For example, you could add support for custom authentication headers or implement new message types. -1. Open [webSockets.ts](./src/webSockets.ts) to understand the existing implementation of the `createWebSocket` function. -2. Add new functions or modify existing ones to support additional WebSocket features or configurations. -3. Ensure that any new environment variables or configurations are documented and handled appropriately. -4. Write tests for your new or modified functions to ensure they work as expected. +3. **Handle New Configurations**: -To run tests, use the following command: + - If your changes require new environment variables or configuration options, ensure they are documented and integrated into the existing setup process. + +4. **Write Tests**: + + - Add unit tests for your new or modified functions to verify their correctness and compatibility with the existing codebase. + - Use the following command to run tests: + ```sh + pnpm test + ``` -```sh -pnpm test -``` +5. **Follow Project Standards**: + - Adhere to the coding and documentation standards used in the TypeAgent project. Review similar modules for guidance on naming conventions and patterns. -By following these steps, you can extend the functionality of the `websocket-utils` package to meet your specific requirements. +By following these steps, you can extend the `@typeagent/websocket-utils` package to meet your specific requirements while maintaining compatibility with the rest of the TypeAgent ecosystem. ## Reference @@ -73,12 +106,15 @@ By following these steps, you can extend the functionality of the `websocket-uti - default → [./dist/index.js](./dist/index.js) - `./originAllowlist` → [./dist/originAllowlist.js](./dist/originAllowlist.js) -- `./heartbeat` → `./dist/heartbeat.js` _(not found on disk)_ +- `./heartbeat` → [./dist/heartbeat.js](./dist/heartbeat.js) +- `./rpcChannel` → [./dist/rpcChannel.js](./dist/rpcChannel.js) +- `./backoff` → [./dist/backoff.js](./dist/backoff.js) ### Dependencies Workspace: +- [@typeagent/agent-rpc](../../../packages/agentRpc/README.md) - [@typeagent/config](../../../packages/config/README.md) External: `debug`, `dotenv`, `find-config`, `isomorphic-ws`, `ws` @@ -94,13 +130,16 @@ External: `debug`, `dotenv`, `find-config`, `isomorphic-ws`, `ws` - [studio-service](../../../packages/studio-service/README.md) - [typeagent-studio](../../../packages/typeagent-studio/README.md) - [visualstudio-agent](../../../packages/agents/visualStudio/README.md) -- [websocket-channel-server](../../../packages/utils/webSocketChannelServer/README.md) +- [vscode-shell](../../../packages/vscode-shell/README.md) +- _…and 1 more workspace consumers._ ### Files of interest - [./src/index.ts](./src/index.ts) +- [./src/backoff.ts](./src/backoff.ts) - [./src/heartbeat.ts](./src/heartbeat.ts) - [./src/originAllowlist.ts](./src/originAllowlist.ts) +- [./src/rpcChannel.ts](./src/rpcChannel.ts) - [./src/tsconfig.json](./src/tsconfig.json) - [./src/webSockets.ts](./src/webSockets.ts) @@ -112,6 +151,6 @@ _1 environment variable referenced from `./src/` (set in `ts/.env` or your shell --- -_Auto-generated against commit `127a36a95a15e918be533d6eaaf08adebe9070d9` on `2026-06-26T03:01:52.873Z` by `docs-generate.yml`. Links validated at that commit; the working tree may have drifted by up to 24h. Re-run `pnpm --filter @typeagent/websocket-utils docs:verify-links` to spot-check._ +_Auto-generated against commit `10c156699bb8436ffeeb5042da164ea166f9eb74` on `2026-07-22T11:31:33.221Z` by `docs-generate.yml`. Links validated at that commit; the working tree may have drifted by up to 24h. Re-run `pnpm --filter @typeagent/websocket-utils docs:verify-links` to spot-check._