@dbx-tools/appkit-web-search 0.6.223 → 0.6.225
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +47 -26
- package/index.ts +2 -2
- package/lib/index.d.ts +2 -2
- package/lib/index.js +2 -2
- package/lib/src/fetch.d.ts +2 -2
- package/lib/src/fetch.js +6 -4
- package/lib/src/html-text.d.ts +4 -8
- package/lib/src/html-text.js +27 -36
- package/lib/src/plugin.d.ts +24 -27
- package/lib/src/plugin.js +30 -35
- package/lib/src/runtime.d.ts +29 -28
- package/lib/src/runtime.js +38 -40
- package/lib/src/scrape.d.ts +5 -3
- package/lib/src/scrape.js +17 -22
- package/lib/src/search.d.ts +2 -2
- package/lib/src/search.js +10 -7
- package/lib/src/tool.d.ts +11 -5
- package/lib/src/tool.js +22 -16
- package/package.json +10 -6
- package/src/fetch.ts +5 -3
- package/src/html-text.ts +28 -37
- package/src/plugin.ts +32 -39
- package/src/runtime.ts +61 -39
- package/src/scrape.ts +16 -20
- package/src/search.ts +14 -5
- package/src/tool.ts +28 -16
package/README.md
CHANGED
|
@@ -32,7 +32,10 @@ has no equivalent for.
|
|
|
32
32
|
whose URL matches a pattern, mapped onto Mastra's `requireApproval`.
|
|
33
33
|
- Every outbound call runs through AppKit's `execute()` chain - per-user cache,
|
|
34
34
|
retry with jittered backoff, timeout, telemetry - and unwinds on an
|
|
35
|
-
`AbortSignal`.
|
|
35
|
+
`AbortSignal`. Each plugin instance owns its policy and executor, so multiple
|
|
36
|
+
apps in one process remain isolated.
|
|
37
|
+
- Page and fallback-result HTML use parser-backed text conversion and selectors,
|
|
38
|
+
including complete HTML entity decoding and malformed-markup recovery.
|
|
36
39
|
|
|
37
40
|
## Why Use This Over Native AppKit
|
|
38
41
|
|
|
@@ -43,21 +46,20 @@ controls which sites are reachable and which calls pause for a human. Crucially,
|
|
|
43
46
|
the web-search tool resolves its own web-search-capable model, so an agent
|
|
44
47
|
running on any chat model (including one without web search) can still search. It
|
|
45
48
|
is a thin add-on in the same shape as [`@dbx-tools/email`](../email): a Mastra
|
|
46
|
-
tool pair plus an AppKit plugin
|
|
49
|
+
tool pair plus an AppKit plugin.
|
|
47
50
|
|
|
48
51
|
## Register The AppKit Plugin
|
|
49
52
|
|
|
50
53
|
```ts
|
|
51
54
|
import { createApp, lakebase, server } from "@databricks/appkit";
|
|
52
|
-
import { plugin as webSearchPlugin
|
|
55
|
+
import { plugin as webSearchPlugin } from "@dbx-tools/appkit-web-search";
|
|
53
56
|
import { agents, plugin as mastraPlugin } from "@dbx-tools/appkit-mastra";
|
|
54
57
|
|
|
55
58
|
const researcher = agents.createAgent({
|
|
56
59
|
instructions: "Research questions using web_search, then read sources with web_fetch.",
|
|
57
|
-
tools
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
}),
|
|
60
|
+
async tools(plugins) {
|
|
61
|
+
return { ...(await plugins["web-search"].toolkit()) };
|
|
62
|
+
},
|
|
61
63
|
});
|
|
62
64
|
|
|
63
65
|
await createApp({
|
|
@@ -74,10 +76,10 @@ await createApp({
|
|
|
74
76
|
```
|
|
75
77
|
|
|
76
78
|
`plugin.webSearch()` resolves config (over env), compiles the URL policy, and
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
Mastra plugin.
|
|
79
|
+
owns the executor used by its tools. App-integrated Mastra agents should consume
|
|
80
|
+
the native plugin toolkit as shown above, which preserves that plugin's policy,
|
|
81
|
+
OBO scope, and AppKit execution chain. Approval, when enabled, requires Mastra
|
|
82
|
+
storage, so register `lakebase()` or configure storage in the Mastra plugin.
|
|
81
83
|
|
|
82
84
|
The plugin is also an AppKit `ToolProvider`, so an AppKit agent can take the
|
|
83
85
|
same two tools without Mastra in the picture:
|
|
@@ -159,11 +161,13 @@ plugin.webSearch({
|
|
|
159
161
|
## Search And Fetch Without An Agent
|
|
160
162
|
|
|
161
163
|
```ts
|
|
162
|
-
import { search, fetch, runtime } from "@dbx-tools/appkit-web-search";
|
|
164
|
+
import { search, fetch, runtime, tool } from "@dbx-tools/appkit-web-search";
|
|
163
165
|
import { getExecutionContext } from "@databricks/appkit";
|
|
164
166
|
|
|
165
|
-
|
|
166
|
-
|
|
167
|
+
const webRuntime = runtime.createWebSearchRuntime({
|
|
168
|
+
model: "gemini",
|
|
169
|
+
allowedUrls: ["*.databricks.com"],
|
|
170
|
+
});
|
|
167
171
|
|
|
168
172
|
// web_search needs the OBO client + host from the active execution context:
|
|
169
173
|
const ctx = getExecutionContext();
|
|
@@ -171,19 +175,33 @@ const host = (await ctx.client.config.getHost()).toString();
|
|
|
171
175
|
|
|
172
176
|
const result = await search.runWebSearch(
|
|
173
177
|
{ query: "unity catalog lineage best practices" },
|
|
174
|
-
|
|
178
|
+
webRuntime,
|
|
175
179
|
{ client: ctx.client, host },
|
|
176
180
|
);
|
|
177
181
|
// result.answer, result.citations, result.model
|
|
178
182
|
|
|
179
|
-
const page = await fetch.runWebFetch(
|
|
180
|
-
{ url: result.citations[0]!.url, format: "text" },
|
|
181
|
-
runtime.getWebSearchRuntime().config,
|
|
182
|
-
);
|
|
183
|
+
const page = await fetch.runWebFetch({ url: result.citations[0]!.url, format: "text" }, webRuntime);
|
|
183
184
|
```
|
|
184
185
|
|
|
185
186
|
Use direct calls for operational lookups, tests, or admin flows where a model is
|
|
186
|
-
not involved.
|
|
187
|
+
not involved. Standalone Mastra tool factories likewise accept `runtime` or
|
|
188
|
+
`config`; they never discover or attach to a process-global plugin:
|
|
189
|
+
|
|
190
|
+
```ts
|
|
191
|
+
const webRuntime = runtime.createWebSearchRuntime({
|
|
192
|
+
allowedUrls: ["*.databricks.com"],
|
|
193
|
+
});
|
|
194
|
+
|
|
195
|
+
const tools = {
|
|
196
|
+
web_search: tool.webSearchTool({ runtime: webRuntime }),
|
|
197
|
+
web_fetch: tool.webFetchTool({ runtime: webRuntime }),
|
|
198
|
+
};
|
|
199
|
+
```
|
|
200
|
+
|
|
201
|
+
`getWebSearchRuntime()` remains as a deprecated compatibility constructor and
|
|
202
|
+
returns a new isolated runtime on every call. Process-global
|
|
203
|
+
`setWebSearchExecutor(executor)` registration is no longer supported; pass the
|
|
204
|
+
runtime explicitly or provide the executor to `createWebSearchRuntime`.
|
|
187
205
|
|
|
188
206
|
## Restrict Which URLs Are Reachable
|
|
189
207
|
|
|
@@ -249,8 +267,11 @@ tool.webFetchTool({ approval: "*.internal.example.com" });
|
|
|
249
267
|
// The same thing, with the mode named:
|
|
250
268
|
tool.webFetchTool({ approval: { mode: "urls", patterns: ["*.internal.example.com"] } });
|
|
251
269
|
|
|
252
|
-
// Plugin
|
|
270
|
+
// Plugin toolkit default:
|
|
253
271
|
plugin.webSearch({ approval: ["*.internal.example.com", "*.corp.example.com"] });
|
|
272
|
+
|
|
273
|
+
// Standalone tool config:
|
|
274
|
+
tool.webFetchTool({ config: { approval: ["*.internal.example.com"] } });
|
|
254
275
|
```
|
|
255
276
|
|
|
256
277
|
Every spelling normalizes to one of three modes - `{ mode: "none" }`,
|
|
@@ -316,14 +337,14 @@ the [Databricks docs](https://docs.databricks.com/aws/en/machine-learning/model-
|
|
|
316
337
|
with, and the reasoning behind each.
|
|
317
338
|
- `search` - `runWebSearch()` over the Databricks native web-search tool.
|
|
318
339
|
- `provider` - provider detection + the provider -> tool-spec map.
|
|
319
|
-
- `scrape` - `runScrapeSearch()` DuckDuckGo fallback
|
|
320
|
-
native web-search model.
|
|
340
|
+
- `scrape` - `runScrapeSearch()` DuckDuckGo fallback plus parser-backed
|
|
341
|
+
`parseDdgHtml()` result extraction for workspaces with no native web-search model.
|
|
321
342
|
- `fetch` - `runWebFetch()` over got-scraping.
|
|
322
343
|
- `html-text` - `htmlToText()` / `htmlFragmentToText()` / `decodeHtmlEntities()`, shared by
|
|
323
344
|
`fetch` and the DuckDuckGo scrape fallback.
|
|
324
|
-
- `runtime` -
|
|
325
|
-
`
|
|
326
|
-
`
|
|
345
|
+
- `runtime` - isolated runtime construction and execution:
|
|
346
|
+
`createWebSearchRuntime()`, `createResolvedWebSearchRuntime()`,
|
|
347
|
+
`executeRead()`, plus deprecated global-era compatibility names.
|
|
327
348
|
- `config` - config types, JSON schema, `resolveWebSearchConfig()`, URL policy
|
|
328
349
|
and approval helpers.
|
|
329
350
|
- `allowlist` - URL allow-list parsing/compiling on top of `@dbx-tools/path`.
|
package/index.ts
CHANGED
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
// Hand edits are overwritten on the next watch; this file is read-only.
|
|
4
4
|
|
|
5
5
|
export const PACKAGE_IDENTIFIER = "@dbx-tools/appkit-web-search";
|
|
6
|
-
export const PACKAGE_VERSION = "0.6.
|
|
6
|
+
export const PACKAGE_VERSION = "0.6.225";
|
|
7
7
|
export * as allowlist from "./src/allowlist.ts";
|
|
8
8
|
export * as config from "./src/config.ts";
|
|
9
9
|
export * as defaults from "./src/defaults.ts";
|
|
@@ -24,7 +24,7 @@ export type { WebSearchExecuteConfig, WebSearchExecutionSettings } from "./src/d
|
|
|
24
24
|
export { WebSearchPlugin, webSearch } from "./src/plugin.ts";
|
|
25
25
|
export { WEB_SEARCH_PROVIDERS } from "./src/provider.ts";
|
|
26
26
|
export type { WebSearchProvider, WebSearchProviderSpec } from "./src/provider.ts";
|
|
27
|
-
export type { WebSearchExecutor, WebSearchRuntime } from "./src/runtime.ts";
|
|
27
|
+
export type { WebSearchExecutor, WebSearchRuntime, WebSearchRuntimeInput } from "./src/runtime.ts";
|
|
28
28
|
export { WEB_SEARCH_TOOL_DESCRIPTION, WEB_FETCH_TOOL_DESCRIPTION, webSearchRequestSchema, webSearchCitationSchema, webSearchResultSchema, webFetchRequestSchema, webFetchResultSchema } from "./src/schema.ts";
|
|
29
29
|
export type { WebSearchRequest, WebSearchCitation, WebSearchResult, WebFetchRequest, WebFetchResult } from "./src/schema.ts";
|
|
30
30
|
export type { WebSearchContext } from "./src/search.ts";
|
package/lib/index.d.ts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
export declare const PACKAGE_IDENTIFIER = "@dbx-tools/appkit-web-search";
|
|
2
|
-
export declare const PACKAGE_VERSION = "0.6.
|
|
2
|
+
export declare const PACKAGE_VERSION = "0.6.225";
|
|
3
3
|
export * as allowlist from "./src/allowlist.ts";
|
|
4
4
|
export * as config from "./src/config.ts";
|
|
5
5
|
export * as defaults from "./src/defaults.ts";
|
|
@@ -20,7 +20,7 @@ export type { WebSearchExecuteConfig, WebSearchExecutionSettings } from "./src/d
|
|
|
20
20
|
export { WebSearchPlugin, webSearch } from "./src/plugin.ts";
|
|
21
21
|
export { WEB_SEARCH_PROVIDERS } from "./src/provider.ts";
|
|
22
22
|
export type { WebSearchProvider, WebSearchProviderSpec } from "./src/provider.ts";
|
|
23
|
-
export type { WebSearchExecutor, WebSearchRuntime } from "./src/runtime.ts";
|
|
23
|
+
export type { WebSearchExecutor, WebSearchRuntime, WebSearchRuntimeInput } from "./src/runtime.ts";
|
|
24
24
|
export { WEB_SEARCH_TOOL_DESCRIPTION, WEB_FETCH_TOOL_DESCRIPTION, webSearchRequestSchema, webSearchCitationSchema, webSearchResultSchema, webFetchRequestSchema, webFetchResultSchema } from "./src/schema.ts";
|
|
25
25
|
export type { WebSearchRequest, WebSearchCitation, WebSearchResult, WebFetchRequest, WebFetchResult } from "./src/schema.ts";
|
|
26
26
|
export type { WebSearchContext } from "./src/search.ts";
|
package/lib/index.js
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
// Regenerated from the exporting modules in ./src.
|
|
3
3
|
// Hand edits are overwritten on the next watch; this file is read-only.
|
|
4
4
|
export const PACKAGE_IDENTIFIER = "@dbx-tools/appkit-web-search";
|
|
5
|
-
export const PACKAGE_VERSION = "0.6.
|
|
5
|
+
export const PACKAGE_VERSION = "0.6.225";
|
|
6
6
|
export * as allowlist from "./src/allowlist.js";
|
|
7
7
|
export * as config from "./src/config.js";
|
|
8
8
|
export * as defaults from "./src/defaults.js";
|
|
@@ -20,4 +20,4 @@ export { SEARCH_CACHE_TTL_SECONDS, FETCH_CACHE_TTL_SECONDS, SERVING_RETRY_ATTEMP
|
|
|
20
20
|
export { WebSearchPlugin, webSearch } from "./src/plugin.js";
|
|
21
21
|
export { WEB_SEARCH_PROVIDERS } from "./src/provider.js";
|
|
22
22
|
export { WEB_SEARCH_TOOL_DESCRIPTION, WEB_FETCH_TOOL_DESCRIPTION, webSearchRequestSchema, webSearchCitationSchema, webSearchResultSchema, webFetchRequestSchema, webFetchResultSchema } from "./src/schema.js";
|
|
23
|
-
//# sourceMappingURL=data:application/json;base64,
|
|
23
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi9pbmRleC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFBQSwyQ0FBMkM7QUFDM0MsbURBQW1EO0FBQ25ELHdFQUF3RTtBQUV4RSxNQUFNLENBQUMsTUFBTSxrQkFBa0IsR0FBRyw4QkFBOEIsQ0FBQztBQUNqRSxNQUFNLENBQUMsTUFBTSxlQUFlLEdBQUcsU0FBUyxDQUFDO0FBQ3pDLE9BQU8sS0FBSyxTQUFTLE1BQU0sb0JBQW9CLENBQUM7QUFDaEQsT0FBTyxLQUFLLE1BQU0sTUFBTSxpQkFBaUIsQ0FBQztBQUMxQyxPQUFPLEtBQUssUUFBUSxNQUFNLG1CQUFtQixDQUFDO0FBQzlDLE9BQU8sS0FBSyxLQUFLLE1BQU0sZ0JBQWdCLENBQUM7QUFDeEMsT0FBTyxLQUFLLFFBQVEsTUFBTSxvQkFBb0IsQ0FBQztBQUMvQyxPQUFPLEtBQUssTUFBTSxNQUFNLGlCQUFpQixDQUFDO0FBQzFDLE9BQU8sS0FBSyxRQUFRLE1BQU0sbUJBQW1CLENBQUM7QUFDOUMsT0FBTyxLQUFLLE9BQU8sTUFBTSxrQkFBa0IsQ0FBQztBQUM1QyxPQUFPLEtBQUssTUFBTSxNQUFNLGlCQUFpQixDQUFDO0FBQzFDLE9BQU8sS0FBSyxNQUFNLE1BQU0saUJBQWlCLENBQUM7QUFDMUMsT0FBTyxLQUFLLE1BQU0sTUFBTSxpQkFBaUIsQ0FBQztBQUMxQyxPQUFPLEtBQUssSUFBSSxNQUFNLGVBQWUsQ0FBQztBQUV0QyxPQUFPLEVBQUUsU0FBUyxFQUFFLG9CQUFvQixFQUFFLHVCQUF1QixFQUFFLHFCQUFxQixFQUFFLHdCQUF3QixFQUFFLGtCQUFrQixFQUFFLHdCQUF3QixFQUFFLE1BQU0saUJBQWlCLENBQUM7QUFFMUwsT0FBTyxFQUFFLHdCQUF3QixFQUFFLHVCQUF1QixFQUFFLHNCQUFzQixFQUFFLGtCQUFrQixFQUFFLHdCQUF3QixFQUFFLHVCQUF1QixFQUFFLDJCQUEyQixFQUFFLE1BQU0sbUJBQW1CLENBQUM7QUFFbE4sT0FBTyxFQUFFLGVBQWUsRUFBRSxTQUFTLEVBQUUsTUFBTSxpQkFBaUIsQ0FBQztBQUM3RCxPQUFPLEVBQUUsb0JBQW9CLEVBQUUsTUFBTSxtQkFBbUIsQ0FBQztBQUd6RCxPQUFPLEVBQUUsMkJBQTJCLEVBQUUsMEJBQTBCLEVBQUUsc0JBQXNCLEVBQUUsdUJBQXVCLEVBQUUscUJBQXFCLEVBQUUscUJBQXFCLEVBQUUsb0JBQW9CLEVBQUUsTUFBTSxpQkFBaUIsQ0FBQyIsInNvdXJjZXNDb250ZW50IjpbIi8vIEdFTkVSQVRFRCBieSBwcm9qZW4gd2F0Y2ggLSBETyBOT1QgRURJVC5cbi8vIFJlZ2VuZXJhdGVkIGZyb20gdGhlIGV4cG9ydGluZyBtb2R1bGVzIGluIC4vc3JjLlxuLy8gSGFuZCBlZGl0cyBhcmUgb3ZlcndyaXR0ZW4gb24gdGhlIG5leHQgd2F0Y2g7IHRoaXMgZmlsZSBpcyByZWFkLW9ubHkuXG5cbmV4cG9ydCBjb25zdCBQQUNLQUdFX0lERU5USUZJRVIgPSBcIkBkYngtdG9vbHMvYXBwa2l0LXdlYi1zZWFyY2hcIjtcbmV4cG9ydCBjb25zdCBQQUNLQUdFX1ZFUlNJT04gPSBcIjAuNi4yMjVcIjtcbmV4cG9ydCAqIGFzIGFsbG93bGlzdCBmcm9tIFwiLi9zcmMvYWxsb3dsaXN0LnRzXCI7XG5leHBvcnQgKiBhcyBjb25maWcgZnJvbSBcIi4vc3JjL2NvbmZpZy50c1wiO1xuZXhwb3J0ICogYXMgZGVmYXVsdHMgZnJvbSBcIi4vc3JjL2RlZmF1bHRzLnRzXCI7XG5leHBvcnQgKiBhcyBmZXRjaCBmcm9tIFwiLi9zcmMvZmV0Y2gudHNcIjtcbmV4cG9ydCAqIGFzIGh0bWxUZXh0IGZyb20gXCIuL3NyYy9odG1sLXRleHQudHNcIjtcbmV4cG9ydCAqIGFzIHBsdWdpbiBmcm9tIFwiLi9zcmMvcGx1Z2luLnRzXCI7XG5leHBvcnQgKiBhcyBwcm92aWRlciBmcm9tIFwiLi9zcmMvcHJvdmlkZXIudHNcIjtcbmV4cG9ydCAqIGFzIHJ1bnRpbWUgZnJvbSBcIi4vc3JjL3J1bnRpbWUudHNcIjtcbmV4cG9ydCAqIGFzIHNjaGVtYSBmcm9tIFwiLi9zcmMvc2NoZW1hLnRzXCI7XG5leHBvcnQgKiBhcyBzY3JhcGUgZnJvbSBcIi4vc3JjL3NjcmFwZS50c1wiO1xuZXhwb3J0ICogYXMgc2VhcmNoIGZyb20gXCIuL3NyYy9zZWFyY2gudHNcIjtcbmV4cG9ydCAqIGFzIHRvb2wgZnJvbSBcIi4vc3JjL3Rvb2wudHNcIjtcbmV4cG9ydCB0eXBlIHsgVXJsQWxsb3dMaXN0IH0gZnJvbSBcIi4vc3JjL2FsbG93bGlzdC50c1wiO1xuZXhwb3J0IHsgTU9ERUxfRU5WLCBTRVJWSU5HX0VORFBPSU5UX0VOViwgREVGQVVMVF9NT0RFTF9GQUxMQkFDS1MsIERFRkFVTFRfTUFYX0NJVEFUSU9OUywgREVGQVVMVF9GRVRDSF9NQVhfTEVOR1RILCBERUZBVUxUX1RJTUVPVVRfTVMsIFdFQl9TRUFSQ0hfQ09ORklHX1NDSEVNQSB9IGZyb20gXCIuL3NyYy9jb25maWcudHNcIjtcbmV4cG9ydCB0eXBlIHsgQXBwcm92YWxHYXRlLCBBcHByb3ZhbFBvbGljeSwgVXJsUG9saWN5TW9kZSwgTW9kZWxTb3VyY2UsIFdlYlNlYXJjaFBsdWdpbkNvbmZpZywgUmVzb2x2ZWRXZWJTZWFyY2hDb25maWcgfSBmcm9tIFwiLi9zcmMvY29uZmlnLnRzXCI7XG5leHBvcnQgeyBTRUFSQ0hfQ0FDSEVfVFRMX1NFQ09ORFMsIEZFVENIX0NBQ0hFX1RUTF9TRUNPTkRTLCBTRVJWSU5HX1JFVFJZX0FUVEVNUFRTLCBXRUJfUkVUUllfQVRURU1QVFMsIHdlYlNlYXJjaEV4ZWN1dGVEZWZhdWx0cywgd2ViRmV0Y2hFeGVjdXRlRGVmYXVsdHMsIHNjcmFwZVNlYXJjaEV4ZWN1dGVEZWZhdWx0cyB9IGZyb20gXCIuL3NyYy9kZWZhdWx0cy50c1wiO1xuZXhwb3J0IHR5cGUgeyBXZWJTZWFyY2hFeGVjdXRlQ29uZmlnLCBXZWJTZWFyY2hFeGVjdXRpb25TZXR0aW5ncyB9IGZyb20gXCIuL3NyYy9kZWZhdWx0cy50c1wiO1xuZXhwb3J0IHsgV2ViU2VhcmNoUGx1Z2luLCB3ZWJTZWFyY2ggfSBmcm9tIFwiLi9zcmMvcGx1Z2luLnRzXCI7XG5leHBvcnQgeyBXRUJfU0VBUkNIX1BST1ZJREVSUyB9IGZyb20gXCIuL3NyYy9wcm92aWRlci50c1wiO1xuZXhwb3J0IHR5cGUgeyBXZWJTZWFyY2hQcm92aWRlciwgV2ViU2VhcmNoUHJvdmlkZXJTcGVjIH0gZnJvbSBcIi4vc3JjL3Byb3ZpZGVyLnRzXCI7XG5leHBvcnQgdHlwZSB7IFdlYlNlYXJjaEV4ZWN1dG9yLCBXZWJTZWFyY2hSdW50aW1lLCBXZWJTZWFyY2hSdW50aW1lSW5wdXQgfSBmcm9tIFwiLi9zcmMvcnVudGltZS50c1wiO1xuZXhwb3J0IHsgV0VCX1NFQVJDSF9UT09MX0RFU0NSSVBUSU9OLCBXRUJfRkVUQ0hfVE9PTF9ERVNDUklQVElPTiwgd2ViU2VhcmNoUmVxdWVzdFNjaGVtYSwgd2ViU2VhcmNoQ2l0YXRpb25TY2hlbWEsIHdlYlNlYXJjaFJlc3VsdFNjaGVtYSwgd2ViRmV0Y2hSZXF1ZXN0U2NoZW1hLCB3ZWJGZXRjaFJlc3VsdFNjaGVtYSB9IGZyb20gXCIuL3NyYy9zY2hlbWEudHNcIjtcbmV4cG9ydCB0eXBlIHsgV2ViU2VhcmNoUmVxdWVzdCwgV2ViU2VhcmNoQ2l0YXRpb24sIFdlYlNlYXJjaFJlc3VsdCwgV2ViRmV0Y2hSZXF1ZXN0LCBXZWJGZXRjaFJlc3VsdCB9IGZyb20gXCIuL3NyYy9zY2hlbWEudHNcIjtcbmV4cG9ydCB0eXBlIHsgV2ViU2VhcmNoQ29udGV4dCB9IGZyb20gXCIuL3NyYy9zZWFyY2gudHNcIjtcbmV4cG9ydCB0eXBlIHsgV2ViU2VhcmNoVG9vbE9wdGlvbnMgfSBmcm9tIFwiLi9zcmMvdG9vbC50c1wiO1xuIl19
|
package/lib/src/fetch.d.ts
CHANGED
|
@@ -14,7 +14,7 @@
|
|
|
14
14
|
*
|
|
15
15
|
* @module
|
|
16
16
|
*/
|
|
17
|
-
import type
|
|
17
|
+
import { type WebSearchRuntimeInput } from "./runtime.ts";
|
|
18
18
|
import type { WebFetchRequest, WebFetchResult } from "./schema.ts";
|
|
19
19
|
/**
|
|
20
20
|
* Fetch a single URL and return its content in the requested format.
|
|
@@ -24,4 +24,4 @@ import type { WebFetchRequest, WebFetchResult } from "./schema.ts";
|
|
|
24
24
|
* `maxLength` narrows (never widens) the plugin's `fetchMaxLength` cap.
|
|
25
25
|
* `signal` cancels the in-flight fetch.
|
|
26
26
|
*/
|
|
27
|
-
export declare function runWebFetch(request: WebFetchRequest,
|
|
27
|
+
export declare function runWebFetch(request: WebFetchRequest, runtimeOrConfig: WebSearchRuntimeInput, signal?: AbortSignal): Promise<WebFetchResult>;
|
package/lib/src/fetch.js
CHANGED
|
@@ -19,7 +19,7 @@ import { gotScraping } from "got-scraping";
|
|
|
19
19
|
import { assertFetchUrlAllowed } from "./_fetch-url.js";
|
|
20
20
|
import { toCallSettings, webFetchExecuteDefaults } from "./defaults.js";
|
|
21
21
|
import { decodeHtmlEntities, htmlToText } from "./html-text.js";
|
|
22
|
-
import { executeRead } from "./runtime.js";
|
|
22
|
+
import { executeRead, toWebSearchRuntime } from "./runtime.js";
|
|
23
23
|
const logger = log.logger("web-search/fetch");
|
|
24
24
|
/** Pull the <title> text out of an HTML document, when present. */
|
|
25
25
|
function extractTitle(html) {
|
|
@@ -41,12 +41,14 @@ function truncate(text, max) {
|
|
|
41
41
|
* `maxLength` narrows (never widens) the plugin's `fetchMaxLength` cap.
|
|
42
42
|
* `signal` cancels the in-flight fetch.
|
|
43
43
|
*/
|
|
44
|
-
export async function runWebFetch(request,
|
|
44
|
+
export async function runWebFetch(request, runtimeOrConfig, signal) {
|
|
45
|
+
const runtime = toWebSearchRuntime(runtimeOrConfig);
|
|
46
|
+
const { config } = runtime;
|
|
45
47
|
await assertFetchUrlAllowed(request.url, config.allowList);
|
|
46
48
|
const cap = Math.min(request.maxLength ?? config.fetchMaxLength, config.fetchMaxLength);
|
|
47
49
|
// The response is cached before the format reduction, so the same page read
|
|
48
50
|
// as text and as html shares one network round trip.
|
|
49
|
-
const page = await executeRead("page-fetch", toCallSettings(webFetchExecuteDefaults, config.timeoutMs, [
|
|
51
|
+
const page = await executeRead(runtime, "page-fetch", toCallSettings(webFetchExecuteDefaults, config.timeoutMs, [
|
|
50
52
|
"web-search",
|
|
51
53
|
"fetch",
|
|
52
54
|
request.url,
|
|
@@ -96,4 +98,4 @@ export async function runWebFetch(request, config, signal) {
|
|
|
96
98
|
truncated,
|
|
97
99
|
};
|
|
98
100
|
}
|
|
99
|
-
//# sourceMappingURL=data:application/json;base64,{"version":3,"file":"fetch.js","sourceRoot":"","sources":["../../src/fetch.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;GAeG;AAEH,OAAO,EAAE,GAAG,EAAE,MAAM,wBAAwB,CAAC;AAC7C,OAAO,EAAE,WAAW,EAAE,MAAM,cAAc,CAAC;AAC3C,OAAO,EAAE,qBAAqB,EAAE,MAAM,iBAAiB,CAAC;AAExD,OAAO,EAAE,cAAc,EAAE,uBAAuB,EAAE,MAAM,eAAe,CAAC;AACxE,OAAO,EAAE,kBAAkB,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAC;AAChE,OAAO,EAAE,WAAW,EAAE,MAAM,cAAc,CAAC;AAG3C,MAAM,MAAM,GAAG,GAAG,CAAC,MAAM,CAAC,kBAAkB,CAAC,CAAC;AAU9C,mEAAmE;AACnE,SAAS,YAAY,CAAC,IAAY;IAChC,MAAM,KAAK,GAAG,kCAAkC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC5D,MAAM,KAAK,GAAG,KAAK,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;IACpE,OAAO,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC;AAC9C,CAAC;AAED,oEAAoE;AACpE,SAAS,QAAQ,CAAC,IAAY,EAAE,GAAW;IACzC,IAAI,IAAI,CAAC,MAAM,IAAI,GAAG;QAAE,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE,CAAC;IACnE,OAAO,EAAE,OAAO,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,GAAG,CAAC,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC;AAC1D,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,CAAC,KAAK,UAAU,WAAW,CAC/B,OAAwB,EACxB,MAA+B,EAC/B,MAAoB;IAEpB,MAAM,qBAAqB,CAAC,OAAO,CAAC,GAAG,EAAE,MAAM,CAAC,SAAS,CAAC,CAAC;IAC3D,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,SAAS,IAAI,MAAM,CAAC,cAAc,EAAE,MAAM,CAAC,cAAc,CAAC,CAAC;IAExF,4EAA4E;IAC5E,qDAAqD;IACrD,MAAM,IAAI,GAAG,MAAM,WAAW,CAC5B,YAAY,EACZ,cAAc,CAAC,uBAAuB,EAAE,MAAM,CAAC,SAAS,EAAE;QACxD,YAAY;QACZ,OAAO;QACP,OAAO,CAAC,GAAG;QACX,GAAG,MAAM,CAAC,SAAS,CAAC,QAAQ;KAC7B,CAAC,EACF,KAAK,EAAE,aAAa,EAAwB,EAAE;QAC5C,MAAM,QAAQ,GAAG,MAAM,WAAW,CAAC;YACjC,GAAG,EAAE,OAAO,CAAC,GAAG;YAChB,oEAAoE;YACpE,mEAAmE;YACnE,OAAO,EAAE,EAAE,OAAO,EAAE,MAAM,CAAC,SAAS,EAAE;YACtC,eAAe,EAAE,KAAK;YACtB,cAAc,EAAE,IAAI;YACpB,KAAK,EAAE;gBACL,aAAa,EAAE;oBACb,KAAK,EAAE,OAAO,EAAE,EAAE;wBAChB,MAAM,qBAAqB,CAAC,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,MAAM,CAAC,SAAS,CAAC,CAAC;oBACrE,CAAC;iBACF;aACF;YACD,GAAG,CAAC,aAAa,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,aAAa,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;SACpD,CAAC,CAAC;QACH,OAAO;YACL,GAAG,EAAE,QAAQ,CAAC,GAAG,IAAI,OAAO,CAAC,GAAG;YAChC,UAAU,EAAE,QAAQ,CAAC,UAAU;YAC/B,WAAW,EAAE,QAAQ,CAAC,OAAO,CAAC,cAAc,CAAC;YAC7C,IAAI,EAAE,OAAO,QAAQ,CAAC,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,IAAI,EAAE,CAAC;SACtF,CAAC;IACJ,CAAC,EACD,MAAM,CACP,CAAC;IACF,MAAM,qBAAqB,CAAC,IAAI,CAAC,GAAG,EAAE,MAAM,CAAC,SAAS,CAAC,CAAC;IAExD,MAAM,MAAM,GAAG,CAAC,IAAI,CAAC,WAAW,IAAI,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;IACvE,MAAM,UAAU,GAAG,OAAO,CAAC,MAAM,KAAK,MAAM,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC5F,MAAM,EAAE,OAAO,EAAE,SAAS,EAAE,GAAG,QAAQ,CAAC,UAAU,EAAE,GAAG,CAAC,CAAC;IACzD,MAAM,KAAK,GAAG,MAAM,CAAC,CAAC,CAAC,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IAE3D,MAAM,CAAC,KAAK,CAAC,SAAS,EAAE;QACtB,GAAG,EAAE,IAAI,CAAC,GAAG;QACb,MAAM,EAAE,IAAI,CAAC,UAAU;QACvB,KAAK,EAAE,IAAI,CAAC,IAAI,CAAC,MAAM;QACvB,QAAQ,EAAE,OAAO,CAAC,MAAM;QACxB,GAAG,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;KAC1C,CAAC,CAAC;IAEH,OAAO;QACL,GAAG,EAAE,IAAI,CAAC,GAAG;QACb,MAAM,EAAE,IAAI,CAAC,UAAU;QACvB,GAAG,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,EAAE,WAAW,EAAE,IAAI,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QAC9D,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QAC3B,OAAO;QACP,SAAS;KACV,CAAC;AACJ,CAAC","sourcesContent":["/**\n * Page fetching over {@link https://www.npmjs.com/package/got-scraping | got-scraping}\n * - a `got` wrapper that generates browser-like TLS + header fingerprints, so\n * fetches survive the bot walls a plain `fetch` trips. {@link runWebFetch}\n * enforces the URL allow-list (an explicit fetch of a disallowed URL is\n * refused, not silently emptied), fetches with the plugin's timeout, and\n * returns either the raw HTML or a readable plain-text reduction, capped at\n * the configured length.\n *\n * The HTML-to-text reduction is deliberately dependency-free (strip\n * script/style, unwrap tags, decode a handful of entities, collapse\n * whitespace): good enough to feed a model, and it keeps the add-on's\n * dependency surface to the two libraries the task called for.\n *\n * @module\n */\n\nimport { log } from \"@dbx-tools/shared-core\";\nimport { gotScraping } from \"got-scraping\";\nimport { assertFetchUrlAllowed } from \"./_fetch-url.ts\";\nimport type { ResolvedWebSearchConfig } from \"./config.ts\";\nimport { toCallSettings, webFetchExecuteDefaults } from \"./defaults.ts\";\nimport { decodeHtmlEntities, htmlToText } from \"./html-text.ts\";\nimport { executeRead } from \"./runtime.ts\";\nimport type { WebFetchRequest, WebFetchResult } from \"./schema.ts\";\n\nconst logger = log.logger(\"web-search/fetch\");\n\n/** The slice of a got-scraping response this module reads. */\ninterface FetchedPage {\n  url: string;\n  statusCode: number;\n  contentType: string | undefined;\n  body: string;\n}\n\n/** Pull the <title> text out of an HTML document, when present. */\nfunction extractTitle(html: string): string | undefined {\n  const match = /<title[^>]*>([\\s\\S]*?)<\\/title>/i.exec(html);\n  const title = match?.[1] ? decodeHtmlEntities(match[1]).trim() : \"\";\n  return title.length > 0 ? title : undefined;\n}\n\n/** Truncate `text` to `max` chars, reporting whether it was cut. */\nfunction truncate(text: string, max: number): { content: string; truncated: boolean } {\n  if (text.length <= max) return { content: text, truncated: false };\n  return { content: text.slice(0, max), truncated: true };\n}\n\n/**\n * Fetch a single URL and return its content in the requested format.\n *\n * Throws when the URL is not permitted by the allow-list (the visible,\n * correctable failure the design calls for on the fetch path). The request's\n * `maxLength` narrows (never widens) the plugin's `fetchMaxLength` cap.\n * `signal` cancels the in-flight fetch.\n */\nexport async function runWebFetch(\n  request: WebFetchRequest,\n  config: ResolvedWebSearchConfig,\n  signal?: AbortSignal,\n): Promise<WebFetchResult> {\n  await assertFetchUrlAllowed(request.url, config.allowList);\n  const cap = Math.min(request.maxLength ?? config.fetchMaxLength, config.fetchMaxLength);\n\n  // The response is cached before the format reduction, so the same page read\n  // as text and as html shares one network round trip.\n  const page = await executeRead(\n    \"page-fetch\",\n    toCallSettings(webFetchExecuteDefaults, config.timeoutMs, [\n      \"web-search\",\n      \"fetch\",\n      request.url,\n      ...config.allowList.patterns,\n    ]),\n    async (executeSignal): Promise<FetchedPage> => {\n      const response = await gotScraping({\n        url: request.url,\n        // got's own timeout aborts the socket and reports which phase timed\n        // out; the interceptor timeout bounds the whole attempt around it.\n        timeout: { request: config.timeoutMs },\n        throwHttpErrors: false,\n        followRedirect: true,\n        hooks: {\n          beforeRequest: [\n            async (options) => {\n              await assertFetchUrlAllowed(String(options.url), config.allowList);\n            },\n          ],\n        },\n        ...(executeSignal ? { signal: executeSignal } : {}),\n      });\n      return {\n        url: response.url ?? request.url,\n        statusCode: response.statusCode,\n        contentType: response.headers[\"content-type\"],\n        body: typeof response.body === \"string\" ? response.body : String(response.body ?? \"\"),\n      };\n    },\n    signal,\n  );\n  await assertFetchUrlAllowed(page.url, config.allowList);\n\n  const isHtml = !page.contentType || /html|xml/i.test(page.contentType);\n  const rawContent = request.format === \"html\" || !isHtml ? page.body : htmlToText(page.body);\n  const { content, truncated } = truncate(rawContent, cap);\n  const title = isHtml ? extractTitle(page.body) : undefined;\n\n  logger.debug(\"fetched\", {\n    url: page.url,\n    status: page.statusCode,\n    bytes: page.body.length,\n    returned: content.length,\n    ...(truncated ? { truncated: true } : {}),\n  });\n\n  return {\n    url: page.url,\n    status: page.statusCode,\n    ...(page.contentType ? { contentType: page.contentType } : {}),\n    ...(title ? { title } : {}),\n    content,\n    truncated,\n  };\n}\n"]}
|
|
101
|
+
//# sourceMappingURL=data:application/json;base64,{"version":3,"file":"fetch.js","sourceRoot":"","sources":["../../src/fetch.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;GAeG;AAEH,OAAO,EAAE,GAAG,EAAE,MAAM,wBAAwB,CAAC;AAC7C,OAAO,EAAE,WAAW,EAAE,MAAM,cAAc,CAAC;AAC3C,OAAO,EAAE,qBAAqB,EAAE,MAAM,iBAAiB,CAAC;AACxD,OAAO,EAAE,cAAc,EAAE,uBAAuB,EAAE,MAAM,eAAe,CAAC;AACxE,OAAO,EAAE,kBAAkB,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAC;AAChE,OAAO,EAAE,WAAW,EAAE,kBAAkB,EAA8B,MAAM,cAAc,CAAC;AAG3F,MAAM,MAAM,GAAG,GAAG,CAAC,MAAM,CAAC,kBAAkB,CAAC,CAAC;AAU9C,mEAAmE;AACnE,SAAS,YAAY,CAAC,IAAY;IAChC,MAAM,KAAK,GAAG,kCAAkC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC5D,MAAM,KAAK,GAAG,KAAK,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;IACpE,OAAO,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC;AAC9C,CAAC;AAED,oEAAoE;AACpE,SAAS,QAAQ,CAAC,IAAY,EAAE,GAAW;IACzC,IAAI,IAAI,CAAC,MAAM,IAAI,GAAG;QAAE,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE,CAAC;IACnE,OAAO,EAAE,OAAO,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,GAAG,CAAC,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC;AAC1D,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,CAAC,KAAK,UAAU,WAAW,CAC/B,OAAwB,EACxB,eAAsC,EACtC,MAAoB;IAEpB,MAAM,OAAO,GAAG,kBAAkB,CAAC,eAAe,CAAC,CAAC;IACpD,MAAM,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC;IAC3B,MAAM,qBAAqB,CAAC,OAAO,CAAC,GAAG,EAAE,MAAM,CAAC,SAAS,CAAC,CAAC;IAC3D,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,SAAS,IAAI,MAAM,CAAC,cAAc,EAAE,MAAM,CAAC,cAAc,CAAC,CAAC;IAExF,4EAA4E;IAC5E,qDAAqD;IACrD,MAAM,IAAI,GAAG,MAAM,WAAW,CAC5B,OAAO,EACP,YAAY,EACZ,cAAc,CAAC,uBAAuB,EAAE,MAAM,CAAC,SAAS,EAAE;QACxD,YAAY;QACZ,OAAO;QACP,OAAO,CAAC,GAAG;QACX,GAAG,MAAM,CAAC,SAAS,CAAC,QAAQ;KAC7B,CAAC,EACF,KAAK,EAAE,aAAa,EAAwB,EAAE;QAC5C,MAAM,QAAQ,GAAG,MAAM,WAAW,CAAC;YACjC,GAAG,EAAE,OAAO,CAAC,GAAG;YAChB,oEAAoE;YACpE,mEAAmE;YACnE,OAAO,EAAE,EAAE,OAAO,EAAE,MAAM,CAAC,SAAS,EAAE;YACtC,eAAe,EAAE,KAAK;YACtB,cAAc,EAAE,IAAI;YACpB,KAAK,EAAE;gBACL,aAAa,EAAE;oBACb,KAAK,EAAE,OAAO,EAAE,EAAE;wBAChB,MAAM,qBAAqB,CAAC,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,MAAM,CAAC,SAAS,CAAC,CAAC;oBACrE,CAAC;iBACF;aACF;YACD,GAAG,CAAC,aAAa,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,aAAa,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;SACpD,CAAC,CAAC;QACH,OAAO;YACL,GAAG,EAAE,QAAQ,CAAC,GAAG,IAAI,OAAO,CAAC,GAAG;YAChC,UAAU,EAAE,QAAQ,CAAC,UAAU;YAC/B,WAAW,EAAE,QAAQ,CAAC,OAAO,CAAC,cAAc,CAAC;YAC7C,IAAI,EAAE,OAAO,QAAQ,CAAC,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,IAAI,EAAE,CAAC;SACtF,CAAC;IACJ,CAAC,EACD,MAAM,CACP,CAAC;IACF,MAAM,qBAAqB,CAAC,IAAI,CAAC,GAAG,EAAE,MAAM,CAAC,SAAS,CAAC,CAAC;IAExD,MAAM,MAAM,GAAG,CAAC,IAAI,CAAC,WAAW,IAAI,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;IACvE,MAAM,UAAU,GAAG,OAAO,CAAC,MAAM,KAAK,MAAM,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC5F,MAAM,EAAE,OAAO,EAAE,SAAS,EAAE,GAAG,QAAQ,CAAC,UAAU,EAAE,GAAG,CAAC,CAAC;IACzD,MAAM,KAAK,GAAG,MAAM,CAAC,CAAC,CAAC,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IAE3D,MAAM,CAAC,KAAK,CAAC,SAAS,EAAE;QACtB,GAAG,EAAE,IAAI,CAAC,GAAG;QACb,MAAM,EAAE,IAAI,CAAC,UAAU;QACvB,KAAK,EAAE,IAAI,CAAC,IAAI,CAAC,MAAM;QACvB,QAAQ,EAAE,OAAO,CAAC,MAAM;QACxB,GAAG,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;KAC1C,CAAC,CAAC;IAEH,OAAO;QACL,GAAG,EAAE,IAAI,CAAC,GAAG;QACb,MAAM,EAAE,IAAI,CAAC,UAAU;QACvB,GAAG,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,EAAE,WAAW,EAAE,IAAI,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QAC9D,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QAC3B,OAAO;QACP,SAAS;KACV,CAAC;AACJ,CAAC","sourcesContent":["/**\n * Page fetching over {@link https://www.npmjs.com/package/got-scraping | got-scraping}\n * - a `got` wrapper that generates browser-like TLS + header fingerprints, so\n * fetches survive the bot walls a plain `fetch` trips. {@link runWebFetch}\n * enforces the URL allow-list (an explicit fetch of a disallowed URL is\n * refused, not silently emptied), fetches with the plugin's timeout, and\n * returns either the raw HTML or a readable plain-text reduction, capped at\n * the configured length.\n *\n * The HTML-to-text reduction is deliberately dependency-free (strip\n * script/style, unwrap tags, decode a handful of entities, collapse\n * whitespace): good enough to feed a model, and it keeps the add-on's\n * dependency surface to the two libraries the task called for.\n *\n * @module\n */\n\nimport { log } from \"@dbx-tools/shared-core\";\nimport { gotScraping } from \"got-scraping\";\nimport { assertFetchUrlAllowed } from \"./_fetch-url.ts\";\nimport { toCallSettings, webFetchExecuteDefaults } from \"./defaults.ts\";\nimport { decodeHtmlEntities, htmlToText } from \"./html-text.ts\";\nimport { executeRead, toWebSearchRuntime, type WebSearchRuntimeInput } from \"./runtime.ts\";\nimport type { WebFetchRequest, WebFetchResult } from \"./schema.ts\";\n\nconst logger = log.logger(\"web-search/fetch\");\n\n/** The slice of a got-scraping response this module reads. */\ninterface FetchedPage {\n  url: string;\n  statusCode: number;\n  contentType: string | undefined;\n  body: string;\n}\n\n/** Pull the <title> text out of an HTML document, when present. */\nfunction extractTitle(html: string): string | undefined {\n  const match = /<title[^>]*>([\\s\\S]*?)<\\/title>/i.exec(html);\n  const title = match?.[1] ? decodeHtmlEntities(match[1]).trim() : \"\";\n  return title.length > 0 ? title : undefined;\n}\n\n/** Truncate `text` to `max` chars, reporting whether it was cut. */\nfunction truncate(text: string, max: number): { content: string; truncated: boolean } {\n  if (text.length <= max) return { content: text, truncated: false };\n  return { content: text.slice(0, max), truncated: true };\n}\n\n/**\n * Fetch a single URL and return its content in the requested format.\n *\n * Throws when the URL is not permitted by the allow-list (the visible,\n * correctable failure the design calls for on the fetch path). The request's\n * `maxLength` narrows (never widens) the plugin's `fetchMaxLength` cap.\n * `signal` cancels the in-flight fetch.\n */\nexport async function runWebFetch(\n  request: WebFetchRequest,\n  runtimeOrConfig: WebSearchRuntimeInput,\n  signal?: AbortSignal,\n): Promise<WebFetchResult> {\n  const runtime = toWebSearchRuntime(runtimeOrConfig);\n  const { config } = runtime;\n  await assertFetchUrlAllowed(request.url, config.allowList);\n  const cap = Math.min(request.maxLength ?? config.fetchMaxLength, config.fetchMaxLength);\n\n  // The response is cached before the format reduction, so the same page read\n  // as text and as html shares one network round trip.\n  const page = await executeRead(\n    runtime,\n    \"page-fetch\",\n    toCallSettings(webFetchExecuteDefaults, config.timeoutMs, [\n      \"web-search\",\n      \"fetch\",\n      request.url,\n      ...config.allowList.patterns,\n    ]),\n    async (executeSignal): Promise<FetchedPage> => {\n      const response = await gotScraping({\n        url: request.url,\n        // got's own timeout aborts the socket and reports which phase timed\n        // out; the interceptor timeout bounds the whole attempt around it.\n        timeout: { request: config.timeoutMs },\n        throwHttpErrors: false,\n        followRedirect: true,\n        hooks: {\n          beforeRequest: [\n            async (options) => {\n              await assertFetchUrlAllowed(String(options.url), config.allowList);\n            },\n          ],\n        },\n        ...(executeSignal ? { signal: executeSignal } : {}),\n      });\n      return {\n        url: response.url ?? request.url,\n        statusCode: response.statusCode,\n        contentType: response.headers[\"content-type\"],\n        body: typeof response.body === \"string\" ? response.body : String(response.body ?? \"\"),\n      };\n    },\n    signal,\n  );\n  await assertFetchUrlAllowed(page.url, config.allowList);\n\n  const isHtml = !page.contentType || /html|xml/i.test(page.contentType);\n  const rawContent = request.format === \"html\" || !isHtml ? page.body : htmlToText(page.body);\n  const { content, truncated } = truncate(rawContent, cap);\n  const title = isHtml ? extractTitle(page.body) : undefined;\n\n  logger.debug(\"fetched\", {\n    url: page.url,\n    status: page.statusCode,\n    bytes: page.body.length,\n    returned: content.length,\n    ...(truncated ? { truncated: true } : {}),\n  });\n\n  return {\n    url: page.url,\n    status: page.statusCode,\n    ...(page.contentType ? { contentType: page.contentType } : {}),\n    ...(title ? { title } : {}),\n    content,\n    truncated,\n  };\n}\n"]}
|
package/lib/src/html-text.d.ts
CHANGED
|
@@ -2,17 +2,13 @@
|
|
|
2
2
|
* Turning fetched HTML into the plain text a model can read.
|
|
3
3
|
*
|
|
4
4
|
* Both scraping paths need this: `runWebFetch`'s full-page read and
|
|
5
|
-
* `runScrapeSearch`'s title/snippet extraction.
|
|
6
|
-
* the
|
|
7
|
-
*
|
|
8
|
-
* This is deliberately regex-based rather than a DOM parse. The inputs are
|
|
9
|
-
* whole pages fetched for summarization, not documents to be queried, so the
|
|
10
|
-
* cost of a real parser buys nothing - and a malformed page still degrades to
|
|
11
|
-
* readable text instead of throwing.
|
|
5
|
+
* `runScrapeSearch`'s title/snippet extraction. Parser-backed conversion keeps
|
|
6
|
+
* malformed markup, quoted `>` characters, and the complete HTML entity table
|
|
7
|
+
* consistent across both paths.
|
|
12
8
|
*
|
|
13
9
|
* @module
|
|
14
10
|
*/
|
|
15
|
-
/** Decode
|
|
11
|
+
/** Decode named, decimal, and hexadecimal HTML entities without throwing. */
|
|
16
12
|
export declare function decodeHtmlEntities(text: string): string;
|
|
17
13
|
/**
|
|
18
14
|
* Strip tags and decode entities from a short HTML fragment, collapsing all
|
package/lib/src/html-text.js
CHANGED
|
@@ -2,39 +2,35 @@
|
|
|
2
2
|
* Turning fetched HTML into the plain text a model can read.
|
|
3
3
|
*
|
|
4
4
|
* Both scraping paths need this: `runWebFetch`'s full-page read and
|
|
5
|
-
* `runScrapeSearch`'s title/snippet extraction.
|
|
6
|
-
* the
|
|
7
|
-
*
|
|
8
|
-
* This is deliberately regex-based rather than a DOM parse. The inputs are
|
|
9
|
-
* whole pages fetched for summarization, not documents to be queried, so the
|
|
10
|
-
* cost of a real parser buys nothing - and a malformed page still degrades to
|
|
11
|
-
* readable text instead of throwing.
|
|
5
|
+
* `runScrapeSearch`'s title/snippet extraction. Parser-backed conversion keeps
|
|
6
|
+
* malformed markup, quoted `>` characters, and the complete HTML entity table
|
|
7
|
+
* consistent across both paths.
|
|
12
8
|
*
|
|
13
9
|
* @module
|
|
14
10
|
*/
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
"'": "'",
|
|
27
|
-
"'": "'",
|
|
28
|
-
"'": "'",
|
|
11
|
+
import { decodeHTML } from "entities";
|
|
12
|
+
import { compile } from "html-to-text";
|
|
13
|
+
const SHARED_OPTIONS = {
|
|
14
|
+
wordwrap: false,
|
|
15
|
+
selectors: [
|
|
16
|
+
{ selector: "script", format: "skip" },
|
|
17
|
+
{ selector: "style", format: "skip" },
|
|
18
|
+
{ selector: "noscript", format: "skip" },
|
|
19
|
+
{ selector: "a", options: { ignoreHref: true } },
|
|
20
|
+
{ selector: "img", format: "skip" },
|
|
21
|
+
],
|
|
29
22
|
};
|
|
30
|
-
const
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
23
|
+
const fragmentToText = compile({
|
|
24
|
+
...SHARED_OPTIONS,
|
|
25
|
+
preserveNewlines: false,
|
|
26
|
+
});
|
|
27
|
+
const documentToText = compile({
|
|
28
|
+
...SHARED_OPTIONS,
|
|
29
|
+
preserveNewlines: true,
|
|
30
|
+
});
|
|
31
|
+
/** Decode named, decimal, and hexadecimal HTML entities without throwing. */
|
|
34
32
|
export function decodeHtmlEntities(text) {
|
|
35
|
-
return text
|
|
36
|
-
.replace(NAMED_ENTITY_REGEXP, (entity) => NAMED_ENTITIES[entity] ?? entity)
|
|
37
|
-
.replace(NUMERIC_ENTITY_REGEXP, (_, code) => String.fromCodePoint(Number(code)));
|
|
33
|
+
return decodeHTML(text);
|
|
38
34
|
}
|
|
39
35
|
/**
|
|
40
36
|
* Strip tags and decode entities from a short HTML fragment, collapsing all
|
|
@@ -42,7 +38,7 @@ export function decodeHtmlEntities(text) {
|
|
|
42
38
|
* summary), where layout carries no meaning.
|
|
43
39
|
*/
|
|
44
40
|
export function htmlFragmentToText(html) {
|
|
45
|
-
return
|
|
41
|
+
return fragmentToText(html).replace(/\s+/g, " ").trim();
|
|
46
42
|
}
|
|
47
43
|
/**
|
|
48
44
|
* Reduce a full HTML document to readable plain text: drop `<script>` /
|
|
@@ -52,15 +48,10 @@ export function htmlFragmentToText(html) {
|
|
|
52
48
|
* preserves line structure because paragraph breaks carry meaning in a page.
|
|
53
49
|
*/
|
|
54
50
|
export function htmlToText(html) {
|
|
55
|
-
return
|
|
56
|
-
.replace(/<!--[\s\S]*?-->/g, "")
|
|
57
|
-
.replace(/<(script|style|noscript)[^>]*>[\s\S]*?<\/\1>/gi, "")
|
|
58
|
-
.replace(/<\/(p|div|section|article|li|tr|h[1-6]|header|footer|br)>/gi, "\n")
|
|
59
|
-
.replace(/<br\s*\/?>/gi, "\n")
|
|
60
|
-
.replace(TAG_REGEXP, ""))
|
|
51
|
+
return documentToText(html)
|
|
61
52
|
.replace(/[ \t]+\n/g, "\n")
|
|
62
53
|
.replace(/\n{3,}/g, "\n\n")
|
|
63
54
|
.replace(/[ \t]{2,}/g, " ")
|
|
64
55
|
.trim();
|
|
65
56
|
}
|
|
66
|
-
//# sourceMappingURL=data:application/json;base64,
|
|
57
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaHRtbC10ZXh0LmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vc3JjL2h0bWwtdGV4dC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFBQTs7Ozs7Ozs7O0dBU0c7QUFFSCxPQUFPLEVBQUUsVUFBVSxFQUFFLE1BQU0sVUFBVSxDQUFDO0FBQ3RDLE9BQU8sRUFBRSxPQUFPLEVBQTBCLE1BQU0sY0FBYyxDQUFDO0FBRS9ELE1BQU0sY0FBYyxHQUFzQjtJQUN4QyxRQUFRLEVBQUUsS0FBSztJQUNmLFNBQVMsRUFBRTtRQUNULEVBQUUsUUFBUSxFQUFFLFFBQVEsRUFBRSxNQUFNLEVBQUUsTUFBTSxFQUFFO1FBQ3RDLEVBQUUsUUFBUSxFQUFFLE9BQU8sRUFBRSxNQUFNLEVBQUUsTUFBTSxFQUFFO1FBQ3JDLEVBQUUsUUFBUSxFQUFFLFVBQVUsRUFBRSxNQUFNLEVBQUUsTUFBTSxFQUFFO1FBQ3hDLEVBQUUsUUFBUSxFQUFFLEdBQUcsRUFBRSxPQUFPLEVBQUUsRUFBRSxVQUFVLEVBQUUsSUFBSSxFQUFFLEVBQUU7UUFDaEQsRUFBRSxRQUFRLEVBQUUsS0FBSyxFQUFFLE1BQU0sRUFBRSxNQUFNLEVBQUU7S0FDcEM7Q0FDRixDQUFDO0FBRUYsTUFBTSxjQUFjLEdBQUcsT0FBTyxDQUFDO0lBQzdCLEdBQUcsY0FBYztJQUNqQixnQkFBZ0IsRUFBRSxLQUFLO0NBQ3hCLENBQUMsQ0FBQztBQUVILE1BQU0sY0FBYyxHQUFHLE9BQU8sQ0FBQztJQUM3QixHQUFHLGNBQWM7SUFDakIsZ0JBQWdCLEVBQUUsSUFBSTtDQUN2QixDQUFDLENBQUM7QUFFSCw2RUFBNkU7QUFDN0UsTUFBTSxVQUFVLGtCQUFrQixDQUFDLElBQVk7SUFDN0MsT0FBTyxVQUFVLENBQUMsSUFBSSxDQUFDLENBQUM7QUFDMUIsQ0FBQztBQUVEOzs7O0dBSUc7QUFDSCxNQUFNLFVBQVUsa0JBQWtCLENBQUMsSUFBWTtJQUM3QyxPQUFPLGNBQWMsQ0FBQyxJQUFJLENBQUMsQ0FBQyxPQUFPLENBQUMsTUFBTSxFQUFFLEdBQUcsQ0FBQyxDQUFDLElBQUksRUFBRSxDQUFDO0FBQzFELENBQUM7QUFFRDs7Ozs7O0dBTUc7QUFDSCxNQUFNLFVBQVUsVUFBVSxDQUFDLElBQVk7SUFDckMsT0FBTyxjQUFjLENBQUMsSUFBSSxDQUFDO1NBQ3hCLE9BQU8sQ0FBQyxXQUFXLEVBQUUsSUFBSSxDQUFDO1NBQzFCLE9BQU8sQ0FBQyxTQUFTLEVBQUUsTUFBTSxDQUFDO1NBQzFCLE9BQU8sQ0FBQyxZQUFZLEVBQUUsR0FBRyxDQUFDO1NBQzFCLElBQUksRUFBRSxDQUFDO0FBQ1osQ0FBQyIsInNvdXJjZXNDb250ZW50IjpbIi8qKlxuICogVHVybmluZyBmZXRjaGVkIEhUTUwgaW50byB0aGUgcGxhaW4gdGV4dCBhIG1vZGVsIGNhbiByZWFkLlxuICpcbiAqIEJvdGggc2NyYXBpbmcgcGF0aHMgbmVlZCB0aGlzOiBgcnVuV2ViRmV0Y2hgJ3MgZnVsbC1wYWdlIHJlYWQgYW5kXG4gKiBgcnVuU2NyYXBlU2VhcmNoYCdzIHRpdGxlL3NuaXBwZXQgZXh0cmFjdGlvbi4gUGFyc2VyLWJhY2tlZCBjb252ZXJzaW9uIGtlZXBzXG4gKiBtYWxmb3JtZWQgbWFya3VwLCBxdW90ZWQgYD5gIGNoYXJhY3RlcnMsIGFuZCB0aGUgY29tcGxldGUgSFRNTCBlbnRpdHkgdGFibGVcbiAqIGNvbnNpc3RlbnQgYWNyb3NzIGJvdGggcGF0aHMuXG4gKlxuICogQG1vZHVsZVxuICovXG5cbmltcG9ydCB7IGRlY29kZUhUTUwgfSBmcm9tIFwiZW50aXRpZXNcIjtcbmltcG9ydCB7IGNvbXBpbGUsIHR5cGUgSHRtbFRvVGV4dE9wdGlvbnMgfSBmcm9tIFwiaHRtbC10by10ZXh0XCI7XG5cbmNvbnN0IFNIQVJFRF9PUFRJT05TOiBIdG1sVG9UZXh0T3B0aW9ucyA9IHtcbiAgd29yZHdyYXA6IGZhbHNlLFxuICBzZWxlY3RvcnM6IFtcbiAgICB7IHNlbGVjdG9yOiBcInNjcmlwdFwiLCBmb3JtYXQ6IFwic2tpcFwiIH0sXG4gICAgeyBzZWxlY3RvcjogXCJzdHlsZVwiLCBmb3JtYXQ6IFwic2tpcFwiIH0sXG4gICAgeyBzZWxlY3RvcjogXCJub3NjcmlwdFwiLCBmb3JtYXQ6IFwic2tpcFwiIH0sXG4gICAgeyBzZWxlY3RvcjogXCJhXCIsIG9wdGlvbnM6IHsgaWdub3JlSHJlZjogdHJ1ZSB9IH0sXG4gICAgeyBzZWxlY3RvcjogXCJpbWdcIiwgZm9ybWF0OiBcInNraXBcIiB9LFxuICBdLFxufTtcblxuY29uc3QgZnJhZ21lbnRUb1RleHQgPSBjb21waWxlKHtcbiAgLi4uU0hBUkVEX09QVElPTlMsXG4gIHByZXNlcnZlTmV3bGluZXM6IGZhbHNlLFxufSk7XG5cbmNvbnN0IGRvY3VtZW50VG9UZXh0ID0gY29tcGlsZSh7XG4gIC4uLlNIQVJFRF9PUFRJT05TLFxuICBwcmVzZXJ2ZU5ld2xpbmVzOiB0cnVlLFxufSk7XG5cbi8qKiBEZWNvZGUgbmFtZWQsIGRlY2ltYWwsIGFuZCBoZXhhZGVjaW1hbCBIVE1MIGVudGl0aWVzIHdpdGhvdXQgdGhyb3dpbmcuICovXG5leHBvcnQgZnVuY3Rpb24gZGVjb2RlSHRtbEVudGl0aWVzKHRleHQ6IHN0cmluZyk6IHN0cmluZyB7XG4gIHJldHVybiBkZWNvZGVIVE1MKHRleHQpO1xufVxuXG4vKipcbiAqIFN0cmlwIHRhZ3MgYW5kIGRlY29kZSBlbnRpdGllcyBmcm9tIGEgc2hvcnQgSFRNTCBmcmFnbWVudCwgY29sbGFwc2luZyBhbGxcbiAqIHdoaXRlc3BhY2UgdG8gc2luZ2xlIHNwYWNlcy4gRm9yIGlubGluZSBzbmlwcGV0cyAoYSBzZWFyY2ggcmVzdWx0IHRpdGxlIG9yXG4gKiBzdW1tYXJ5KSwgd2hlcmUgbGF5b3V0IGNhcnJpZXMgbm8gbWVhbmluZy5cbiAqL1xuZXhwb3J0IGZ1bmN0aW9uIGh0bWxGcmFnbWVudFRvVGV4dChodG1sOiBzdHJpbmcpOiBzdHJpbmcge1xuICByZXR1cm4gZnJhZ21lbnRUb1RleHQoaHRtbCkucmVwbGFjZSgvXFxzKy9nLCBcIiBcIikudHJpbSgpO1xufVxuXG4vKipcbiAqIFJlZHVjZSBhIGZ1bGwgSFRNTCBkb2N1bWVudCB0byByZWFkYWJsZSBwbGFpbiB0ZXh0OiBkcm9wIGA8c2NyaXB0PmAgL1xuICogYDxzdHlsZT5gIC8gYDxub3NjcmlwdD5gIGJsb2NrcyBhbmQgY29tbWVudHMsIHR1cm4gYmxvY2stbGV2ZWwgdGFncyBpbnRvXG4gKiBuZXdsaW5lcywgc3RyaXAgdGhlIHJlbWFpbmluZyB0YWdzLCBkZWNvZGUgZW50aXRpZXMsIGFuZCBjb2xsYXBzZSBydW5zIG9mXG4gKiBibGFuayBsaW5lcyAvIHRyYWlsaW5nIHNwYWNlcy4gVW5saWtlIHtAbGluayBodG1sRnJhZ21lbnRUb1RleHR9LCB0aGlzXG4gKiBwcmVzZXJ2ZXMgbGluZSBzdHJ1Y3R1cmUgYmVjYXVzZSBwYXJhZ3JhcGggYnJlYWtzIGNhcnJ5IG1lYW5pbmcgaW4gYSBwYWdlLlxuICovXG5leHBvcnQgZnVuY3Rpb24gaHRtbFRvVGV4dChodG1sOiBzdHJpbmcpOiBzdHJpbmcge1xuICByZXR1cm4gZG9jdW1lbnRUb1RleHQoaHRtbClcbiAgICAucmVwbGFjZSgvWyBcXHRdK1xcbi9nLCBcIlxcblwiKVxuICAgIC5yZXBsYWNlKC9cXG57Myx9L2csIFwiXFxuXFxuXCIpXG4gICAgLnJlcGxhY2UoL1sgXFx0XXsyLH0vZywgXCIgXCIpXG4gICAgLnRyaW0oKTtcbn1cbiJdfQ==
|
package/lib/src/plugin.d.ts
CHANGED
|
@@ -1,16 +1,16 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* AppKit plugin (registered name: `web-search`) that owns the resolved
|
|
3
3
|
* web-search runtime - the URL policy, result / length caps, timeout, and
|
|
4
|
-
* default approval gate
|
|
5
|
-
*
|
|
6
|
-
*
|
|
7
|
-
*
|
|
8
|
-
*
|
|
9
|
-
* AppKit's cache / retry / timeout / telemetry chain.
|
|
4
|
+
* default approval gate its tools read. Registering it resolves and logs the
|
|
5
|
+
* effective config (which URL policy is in force, the caps) so a
|
|
6
|
+
* misconfiguration is visible in the boot logs rather than on the first
|
|
7
|
+
* search. The plugin's `execute()` is captured by its own runtime so every
|
|
8
|
+
* outbound call picks up AppKit's cache / retry / timeout / telemetry chain.
|
|
10
9
|
*
|
|
11
10
|
* The plugin also implements AppKit's `ToolProvider`, so an AppKit agent gets
|
|
12
|
-
* `web_search` / `web_fetch` without going through Mastra
|
|
13
|
-
*
|
|
11
|
+
* `web_search` / `web_fetch` without going through Mastra. App-integrated
|
|
12
|
+
* Mastra agents consume this provider through `plugins["web-search"].toolkit()`;
|
|
13
|
+
* standalone factories in `tool.ts` use their own explicit runtime or config.
|
|
14
14
|
*
|
|
15
15
|
* @module
|
|
16
16
|
*/
|
|
@@ -70,6 +70,8 @@ export declare class WebSearchPlugin extends Plugin<WebSearchPluginConfig> imple
|
|
|
70
70
|
schema: import("json-schema").JSONSchema7;
|
|
71
71
|
};
|
|
72
72
|
};
|
|
73
|
+
/** Runtime owned exclusively by this plugin instance. */
|
|
74
|
+
private readonly runtime;
|
|
73
75
|
/**
|
|
74
76
|
* Promote the serving endpoint to a required resource once a deployment
|
|
75
77
|
* pins one, through plugin config or either environment name. Left optional
|
|
@@ -93,24 +95,17 @@ export declare class WebSearchPlugin extends Plugin<WebSearchPluginConfig> imple
|
|
|
93
95
|
*/
|
|
94
96
|
private readonly tools;
|
|
95
97
|
/**
|
|
96
|
-
*
|
|
97
|
-
*
|
|
98
|
-
*
|
|
98
|
+
* Log the effective policy so an active allow-list and caps are obvious at
|
|
99
|
+
* boot. Runtime construction already resolved config and captured this
|
|
100
|
+
* plugin's interceptor chain.
|
|
99
101
|
*/
|
|
100
102
|
setup(): Promise<void>;
|
|
101
103
|
/**
|
|
102
|
-
*
|
|
103
|
-
*
|
|
104
|
-
* idempotent: there is no connection to drain, only the memo to clear.
|
|
105
|
-
*/
|
|
106
|
-
shutdown(): Promise<void>;
|
|
107
|
-
/**
|
|
108
|
-
* Abort in-flight work. AppKit's graceful shutdown only invokes this hook -
|
|
109
|
-
* it never calls {@link shutdown} - so the runtime memo is dropped from here
|
|
110
|
-
* to keep a restarted app from calling through a torn-down `execute()`. The
|
|
111
|
-
* teardown is synchronous and idempotent, so the un-awaited call costs
|
|
112
|
-
* nothing.
|
|
104
|
+
* No runtime resources require draining. The instance-owned config and
|
|
105
|
+
* executor become unreachable with this plugin.
|
|
113
106
|
*/
|
|
107
|
+
shutdown(): void;
|
|
108
|
+
/** Abort in-flight work owned by this plugin instance. */
|
|
114
109
|
abortActiveOperations(): void;
|
|
115
110
|
/** AppKit `ToolProvider`: the tool definitions offered to an agent. */
|
|
116
111
|
getAgentTools(): AgentToolDefinition[];
|
|
@@ -123,13 +118,13 @@ export declare class WebSearchPlugin extends Plugin<WebSearchPluginConfig> imple
|
|
|
123
118
|
exports(): {
|
|
124
119
|
/**
|
|
125
120
|
* Run a web search directly (bypassing the agent tool). Resolves the
|
|
126
|
-
* OBO client from the active execution context and reads
|
|
127
|
-
* runtime config
|
|
121
|
+
* OBO client from the active execution context and reads this plugin's
|
|
122
|
+
* runtime config.
|
|
128
123
|
*/
|
|
129
124
|
search: (request: WebSearchRequest, signal?: AbortSignal) => Promise<WebSearchResult>;
|
|
130
125
|
/**
|
|
131
126
|
* Fetch one URL directly (bypassing the agent tool). Enforces the
|
|
132
|
-
* configured URL policy.
|
|
127
|
+
* configured URL policy.
|
|
133
128
|
*/
|
|
134
129
|
fetch: (request: WebFetchRequest, signal?: AbortSignal) => Promise<WebFetchResult>;
|
|
135
130
|
};
|
|
@@ -142,12 +137,14 @@ export declare class WebSearchPlugin extends Plugin<WebSearchPluginConfig> imple
|
|
|
142
137
|
* @example
|
|
143
138
|
* ```ts
|
|
144
139
|
* import { createApp, server } from "@databricks/appkit";
|
|
145
|
-
* import { plugin as webSearchPlugin
|
|
140
|
+
* import { plugin as webSearchPlugin } from "@dbx-tools/appkit-web-search";
|
|
146
141
|
* import { agents, plugin as mastraPlugin } from "@dbx-tools/appkit-mastra";
|
|
147
142
|
*
|
|
148
143
|
* const researcher = agents.createAgent({
|
|
149
144
|
* instructions: "Research questions with web_search, then read sources with web_fetch.",
|
|
150
|
-
* tools
|
|
145
|
+
* async tools(plugins) {
|
|
146
|
+
* return { ...(await plugins["web-search"].toolkit()) };
|
|
147
|
+
* },
|
|
151
148
|
* });
|
|
152
149
|
*
|
|
153
150
|
* await createApp({
|