@asterxsk/kiln 0.1.0 → 0.2.0
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/LICENSE +21 -21
- package/README.md +170 -170
- package/agent/AGENTS.md +67 -67
- package/agent/README.md +5 -5
- package/agent/extensions/AGENTS.md +68 -68
- package/agent/extensions/ask-user/index.ts +418 -418
- package/agent/extensions/ask-user/package-lock.json +769 -769
- package/agent/extensions/ask-user/package.json +19 -19
- package/agent/extensions/ask-user/prompt.ts +45 -45
- package/agent/extensions/ask-user/tsconfig.json +7 -7
- package/agent/extensions/background-terminals/docs/implementation-guide.md +942 -942
- package/agent/extensions/background-terminals/index.ts +627 -627
- package/agent/extensions/background-terminals/manager.test.ts +735 -735
- package/agent/extensions/background-terminals/output.test.ts +109 -109
- package/agent/extensions/background-terminals/package-lock.json +769 -769
- package/agent/extensions/background-terminals/package.json +17 -17
- package/agent/extensions/background-terminals/prompt.test.ts +125 -125
- package/agent/extensions/background-terminals/ps.test.ts +82 -82
- package/agent/extensions/background-terminals/result-delivery.test.ts +44 -44
- package/agent/extensions/background-terminals/src/domain.ts +87 -87
- package/agent/extensions/background-terminals/src/manager.ts +907 -907
- package/agent/extensions/background-terminals/src/output.ts +84 -84
- package/agent/extensions/background-terminals/src/prompt.ts +142 -142
- package/agent/extensions/background-terminals/src/result-delivery.ts +27 -27
- package/agent/extensions/background-terminals/src/runtime.ts +36 -36
- package/agent/extensions/background-terminals/src/ui/output-view.ts +79 -79
- package/agent/extensions/background-terminals/src/ui/ps.ts +621 -621
- package/agent/extensions/background-terminals/tsconfig.json +7 -7
- package/agent/extensions/file-search/index.spec.ts +443 -443
- package/agent/extensions/file-search/index.ts +459 -459
- package/agent/extensions/file-search/package-lock.json +2253 -2253
- package/agent/extensions/file-search/package.json +23 -23
- package/agent/extensions/file-search/src/args.ts +122 -122
- package/agent/extensions/file-search/src/binaries.ts +422 -422
- package/agent/extensions/file-search/src/output.ts +126 -126
- package/agent/extensions/file-search/src/process.ts +146 -146
- package/agent/extensions/file-search/src/prompt.ts +52 -52
- package/agent/extensions/file-search/tsconfig.json +7 -7
- package/agent/extensions/modelconf/PLAN.md +915 -915
- package/agent/extensions/modelconf/index.ts +296 -296
- package/agent/extensions/modelconf/src/ui/ModelConfView.ts +1101 -1101
- package/agent/extensions/pi-web-access/CHANGELOG.md +690 -690
- package/agent/extensions/pi-web-access/LICENSE +21 -21
- package/agent/extensions/pi-web-access/README.md +470 -470
- package/agent/extensions/pi-web-access/SECURITY.md +5 -5
- package/agent/extensions/pi-web-access/activity.ts +101 -101
- package/agent/extensions/pi-web-access/auth-fetch.ts +148 -148
- package/agent/extensions/pi-web-access/brightdata-unlocker.ts +272 -272
- package/agent/extensions/pi-web-access/chrome-cookies.ts +669 -669
- package/agent/extensions/pi-web-access/content-find.ts +139 -139
- package/agent/extensions/pi-web-access/credential-source.ts +191 -191
- package/agent/extensions/pi-web-access/data-uri-sanitize.ts +406 -406
- package/agent/extensions/pi-web-access/datalab-pdf-extract.ts +568 -568
- package/agent/extensions/pi-web-access/declared-web-links.ts +173 -173
- package/agent/extensions/pi-web-access/evidence/CONTRACT-EVIDENCE.md +496 -496
- package/agent/extensions/pi-web-access/evidence/contract-probe.mjs +140 -140
- package/agent/extensions/pi-web-access/exa.ts +526 -526
- package/agent/extensions/pi-web-access/extract.ts +1196 -1196
- package/agent/extensions/pi-web-access/feature-config.ts +29 -29
- package/agent/extensions/pi-web-access/fetch-params.ts +111 -111
- package/agent/extensions/pi-web-access/gemini-adc.ts +298 -298
- package/agent/extensions/pi-web-access/gemini-api.ts +353 -353
- package/agent/extensions/pi-web-access/gemini-pdf-extract.ts +108 -108
- package/agent/extensions/pi-web-access/gemini-url-context.ts +128 -128
- package/agent/extensions/pi-web-access/gemini-web-config.ts +101 -101
- package/agent/extensions/pi-web-access/gemini-web.ts +487 -487
- package/agent/extensions/pi-web-access/github-api.ts +197 -197
- package/agent/extensions/pi-web-access/github-extract.ts +746 -746
- package/agent/extensions/pi-web-access/github-issue-pr.ts +700 -700
- package/agent/extensions/pi-web-access/index.ts +1737 -1737
- package/agent/extensions/pi-web-access/package-lock.json +5808 -5808
- package/agent/extensions/pi-web-access/package.json +64 -64
- package/agent/extensions/pi-web-access/page-query.ts +96 -96
- package/agent/extensions/pi-web-access/pdf-extract.ts +409 -409
- package/agent/extensions/pi-web-access/promise-try.d.ts +7 -7
- package/agent/extensions/pi-web-access/query-rewrite.ts +51 -51
- package/agent/extensions/pi-web-access/render-search-error.ts +170 -170
- package/agent/extensions/pi-web-access/rsc-extract.ts +338 -338
- package/agent/extensions/pi-web-access/source-check.ts +282 -282
- package/agent/extensions/pi-web-access/ssrf-protection.ts +526 -526
- package/agent/extensions/pi-web-access/storage.ts +521 -521
- package/agent/extensions/pi-web-access/summary-model-scope.ts +125 -125
- package/agent/extensions/pi-web-access/test/auth-fetch.test.mjs +208 -208
- package/agent/extensions/pi-web-access/test/brightdata-unlocker.test.mjs +840 -840
- package/agent/extensions/pi-web-access/test/chrome-cookie-extraction.test.mjs +441 -441
- package/agent/extensions/pi-web-access/test/config-path.test.mjs +283 -283
- package/agent/extensions/pi-web-access/test/content-find.test.mjs +25 -25
- package/agent/extensions/pi-web-access/test/credential-source.test.mjs +118 -118
- package/agent/extensions/pi-web-access/test/data-uri-sanitize.test.mjs +210 -210
- package/agent/extensions/pi-web-access/test/datalab-pdf-extract.test.mjs +552 -552
- package/agent/extensions/pi-web-access/test/declared-web-links.test.mjs +212 -212
- package/agent/extensions/pi-web-access/test/fetch-answer-storage.test.mjs +40 -40
- package/agent/extensions/pi-web-access/test/fetch-cache-storage.test.mjs +334 -334
- package/agent/extensions/pi-web-access/test/fetch-content-domain-policy.test.mjs +95 -95
- package/agent/extensions/pi-web-access/test/fetch-modes.test.mjs +53 -53
- package/agent/extensions/pi-web-access/test/fetch-not-found-guidance.test.mjs +92 -92
- package/agent/extensions/pi-web-access/test/fetch-params.test.mjs +86 -86
- package/agent/extensions/pi-web-access/test/fetch-render-call.test.mjs +34 -34
- package/agent/extensions/pi-web-access/test/fetch-routing.test.mjs +173 -173
- package/agent/extensions/pi-web-access/test/gemini-adc-auth.test.mjs +257 -257
- package/agent/extensions/pi-web-access/test/gemini-api-transport.test.mjs +170 -170
- package/agent/extensions/pi-web-access/test/gemini-pdf-extract.test.mjs +133 -133
- package/agent/extensions/pi-web-access/test/gemini-web-cookie-opt-in.test.mjs +178 -178
- package/agent/extensions/pi-web-access/test/gemini-web-header-overflow.test.mjs +148 -148
- package/agent/extensions/pi-web-access/test/get-search-content.test.mjs +223 -223
- package/agent/extensions/pi-web-access/test/github-extract.test.mjs +378 -378
- package/agent/extensions/pi-web-access/test/github-issue-pr.test.mjs +565 -565
- package/agent/extensions/pi-web-access/test/inline-content-config.test.mjs +99 -99
- package/agent/extensions/pi-web-access/test/lazy-extract-load.test.mjs +118 -118
- package/agent/extensions/pi-web-access/test/local-video-oversize.test.mjs +52 -52
- package/agent/extensions/pi-web-access/test/package-typebox-dependency.test.mjs +50 -50
- package/agent/extensions/pi-web-access/test/page-query.test.mjs +51 -51
- package/agent/extensions/pi-web-access/test/pdf-config.test.mjs +140 -140
- package/agent/extensions/pi-web-access/test/pdf-extract.test.mjs +500 -500
- package/agent/extensions/pi-web-access/test/proxy-transport.test.mjs +286 -286
- package/agent/extensions/pi-web-access/test/query-rewrite.test.mjs +52 -52
- package/agent/extensions/pi-web-access/test/rsc-fallback.test.mjs +102 -102
- package/agent/extensions/pi-web-access/test/search-error-render.test.mjs +152 -152
- package/agent/extensions/pi-web-access/test/search-providers.test.mjs +274 -274
- package/agent/extensions/pi-web-access/test/source-check.test.mjs +179 -179
- package/agent/extensions/pi-web-access/test/ssrf-allow-ranges-config.test.mjs +205 -205
- package/agent/extensions/pi-web-access/test/ssrf-protection.test.mjs +456 -456
- package/agent/extensions/pi-web-access/test/tool-registration-config.test.mjs +182 -182
- package/agent/extensions/pi-web-access/test/youtube-extract-errors.test.mjs +64 -64
- package/agent/extensions/pi-web-access/tsconfig.json +11 -11
- package/agent/extensions/pi-web-access/utils.ts +451 -451
- package/agent/extensions/pi-web-access/video-extract.ts +392 -392
- package/agent/extensions/pi-web-access/youtube-extract.ts +328 -328
- package/agent/extensions/shared/activity-status.ts +31 -31
- package/agent/extensions/shared/child-session.test.ts +270 -270
- package/agent/extensions/shared/child-session.ts +148 -148
- package/agent/extensions/shared/context-utilization.test.ts +48 -48
- package/agent/extensions/shared/context-utilization.ts +47 -47
- package/agent/extensions/shared/dashboard-state.ts +99 -99
- package/agent/extensions/shared/tool-call-timeout.test.ts +117 -117
- package/agent/extensions/shared/tool-call-timeout.ts +104 -104
- package/agent/extensions/subagents/by-the-way.test.ts +29 -29
- package/agent/extensions/subagents/claude.test.ts +119 -119
- package/agent/extensions/subagents/codex.test.ts +102 -102
- package/agent/extensions/subagents/context-usage.test.ts +107 -107
- package/agent/extensions/subagents/docs/design-plan.md +568 -568
- package/agent/extensions/subagents/docs/effect-v4-extension-guide.md +354 -354
- package/agent/extensions/subagents/docs/effect-v4-notes.md +571 -571
- package/agent/extensions/subagents/index.ts +779 -779
- package/agent/extensions/subagents/manager.test.ts +276 -276
- package/agent/extensions/subagents/package-lock.json +2244 -2244
- package/agent/extensions/subagents/package.json +19 -19
- package/agent/extensions/subagents/result-delivery.test.ts +27 -27
- package/agent/extensions/subagents/src/backend.ts +73 -73
- package/agent/extensions/subagents/src/backends/claude.ts +701 -701
- package/agent/extensions/subagents/src/backends/codex.ts +1060 -1060
- package/agent/extensions/subagents/src/backends/pi.ts +575 -575
- package/agent/extensions/subagents/src/backends/stub.ts +300 -300
- package/agent/extensions/subagents/src/by-the-way.ts +21 -21
- package/agent/extensions/subagents/src/domain.ts +253 -253
- package/agent/extensions/subagents/src/format.ts +74 -74
- package/agent/extensions/subagents/src/manager.ts +736 -736
- package/agent/extensions/subagents/src/prompt.ts +92 -92
- package/agent/extensions/subagents/src/result-delivery.ts +20 -20
- package/agent/extensions/subagents/src/runtime.ts +53 -53
- package/agent/extensions/subagents/src/ui/takeover.ts +583 -583
- package/agent/extensions/subagents/src/ui/transcript.ts +201 -201
- package/agent/extensions/subagents/takeover.test.ts +29 -29
- package/agent/extensions/subagents/tsconfig.json +7 -7
- package/agent/extensions/todo/AGENTS.md +38 -38
- package/agent/extensions/todo/LICENSE +21 -21
- package/agent/extensions/todo/config.ts +55 -55
- package/agent/extensions/todo/index.ts +151 -151
- package/agent/extensions/todo/locales/de.json +17 -17
- package/agent/extensions/todo/locales/en.json +15 -15
- package/agent/extensions/todo/locales/es.json +17 -17
- package/agent/extensions/todo/locales/fr.json +17 -17
- package/agent/extensions/todo/locales/pt-BR.json +17 -17
- package/agent/extensions/todo/locales/pt.json +17 -17
- package/agent/extensions/todo/locales/ru.json +17 -17
- package/agent/extensions/todo/locales/uk.json +17 -17
- package/agent/extensions/todo/locales/zh.json +17 -17
- package/agent/extensions/todo/package-lock.json +3358 -3358
- package/agent/extensions/todo/package.json +67 -67
- package/agent/extensions/todo/state/i18n-bridge.ts +64 -64
- package/agent/extensions/todo/state/invariants.ts +20 -20
- package/agent/extensions/todo/state/replay.ts +38 -38
- package/agent/extensions/todo/state/selectors.ts +107 -107
- package/agent/extensions/todo/state/state-reducer.ts +326 -326
- package/agent/extensions/todo/state/state.ts +18 -18
- package/agent/extensions/todo/state/store.ts +82 -82
- package/agent/extensions/todo/state/task-graph.ts +57 -57
- package/agent/extensions/todo/todo-overlay.ts +200 -200
- package/agent/extensions/todo/todo.ts +155 -155
- package/agent/extensions/todo/tool/response-envelope.ts +109 -109
- package/agent/extensions/todo/tool/types.ts +206 -206
- package/agent/extensions/todo/view/format.ts +177 -177
- package/agent/install.ps1 +637 -527
- package/agent/install.sh +620 -511
- package/agent/keybindings.json +7 -7
- package/bin/kiln.js +124 -11
- package/package.json +8 -2
- package/agent/extensions/taste/index.ts +0 -443
- package/agent/extensions/taste/install.ps1 +0 -23
- package/agent/extensions/taste/install.sh +0 -21
- /package/agent/extensions/{status line → statusline}/index.ts +0 -0
- /package/agent/extensions/{status line → statusline}/install.ps1 +0 -0
- /package/agent/extensions/{status line → statusline}/install.sh +0 -0
|
@@ -1,140 +1,140 @@
|
|
|
1
|
-
// Regenerates evidence/CONTRACT-EVIDENCE.md from REAL calls against the
|
|
2
|
-
// SERPdive API. Run it with your own key to reproduce the file:
|
|
3
|
-
//
|
|
4
|
-
// SERPDIVE_API_KEY=sd_live_… node evidence/contract-probe.mjs
|
|
5
|
-
//
|
|
6
|
-
// The key is read from the environment and never written to the output —
|
|
7
|
-
// the script asserts that before exiting.
|
|
8
|
-
import fs from 'node:fs';
|
|
9
|
-
|
|
10
|
-
const KEY = process.env.SERPDIVE_API_KEY;
|
|
11
|
-
if (!KEY) {
|
|
12
|
-
console.error('SERPDIVE_API_KEY is not set. Get a key at https://serpdive.com/dashboard/keys');
|
|
13
|
-
process.exit(1);
|
|
14
|
-
}
|
|
15
|
-
const URL = 'https://api.serpdive.com/v1/search';
|
|
16
|
-
const out = [];
|
|
17
|
-
const say = (s = '') => out.push(s);
|
|
18
|
-
|
|
19
|
-
async function call(body, { key = KEY, abortAfterMs = null } = {}) {
|
|
20
|
-
const ctrl = new AbortController();
|
|
21
|
-
if (abortAfterMs) setTimeout(() => ctrl.abort(), abortAfterMs);
|
|
22
|
-
const t0 = Date.now();
|
|
23
|
-
try {
|
|
24
|
-
const res = await fetch(URL, {
|
|
25
|
-
method: 'POST',
|
|
26
|
-
headers: { 'content-type': 'application/json', ...(key ? { authorization: `Bearer ${key}` } : {}) },
|
|
27
|
-
body: JSON.stringify(body),
|
|
28
|
-
signal: ctrl.signal,
|
|
29
|
-
});
|
|
30
|
-
const json = await res.json().catch(() => null);
|
|
31
|
-
return { status: res.status, ms: Date.now() - t0, json };
|
|
32
|
-
} catch (err) {
|
|
33
|
-
return { status: null, ms: Date.now() - t0, aborted: err.name === 'AbortError', err: err.name };
|
|
34
|
-
}
|
|
35
|
-
}
|
|
36
|
-
|
|
37
|
-
// Reduce a response to its SHAPE: keep the structure, truncate the content.
|
|
38
|
-
function shape(j) {
|
|
39
|
-
if (!j) return null;
|
|
40
|
-
const c = JSON.parse(JSON.stringify(j));
|
|
41
|
-
if (Array.isArray(c.results)) {
|
|
42
|
-
c.results = c.results.slice(0, 2).map((r) => ({
|
|
43
|
-
...r,
|
|
44
|
-
content: typeof r.content === 'string' ? `${r.content.slice(0, 90)}… (${r.content.length} chars)` : r.content,
|
|
45
|
-
}));
|
|
46
|
-
if (j.results.length > 2) c.results.push(`… ${j.results.length - 2} more, same shape`);
|
|
47
|
-
}
|
|
48
|
-
if (typeof c.answer === 'string') c.answer = `${c.answer.slice(0, 160)}… (${j.answer.length} chars)`;
|
|
49
|
-
return c;
|
|
50
|
-
}
|
|
51
|
-
|
|
52
|
-
async function section(title, note, body, opts = {}) {
|
|
53
|
-
const r = await call(body, opts);
|
|
54
|
-
const keyLine = !('key' in opts)
|
|
55
|
-
? 'authorization: Bearer sd_live_… # a valid key, redacted'
|
|
56
|
-
: opts.key === null
|
|
57
|
-
? '(no authorization header sent)'
|
|
58
|
-
: `authorization: Bearer ${opts.key}`;
|
|
59
|
-
say(`### ${title}`);
|
|
60
|
-
say();
|
|
61
|
-
if (note) { say(note); say(); }
|
|
62
|
-
say('```http');
|
|
63
|
-
say('POST https://api.serpdive.com/v1/search');
|
|
64
|
-
say(keyLine);
|
|
65
|
-
say('content-type: application/json');
|
|
66
|
-
say();
|
|
67
|
-
say(JSON.stringify(body));
|
|
68
|
-
say('```');
|
|
69
|
-
say();
|
|
70
|
-
if (r.aborted) {
|
|
71
|
-
say(`Client aborted after ${opts.abortAfterMs} ms → \`${r.err}\` raised locally; no response body.`);
|
|
72
|
-
} else {
|
|
73
|
-
say(`\`HTTP ${r.status}\` in ${r.ms} ms`);
|
|
74
|
-
say();
|
|
75
|
-
say('```json');
|
|
76
|
-
say(JSON.stringify(shape(r.json), null, 2));
|
|
77
|
-
say('```');
|
|
78
|
-
}
|
|
79
|
-
say();
|
|
80
|
-
return r;
|
|
81
|
-
}
|
|
82
|
-
|
|
83
|
-
const Q = 'best open source vector databases';
|
|
84
|
-
|
|
85
|
-
say('# SERPdive API — contract evidence');
|
|
86
|
-
say();
|
|
87
|
-
say('Every block below is a real call against `https://api.serpdive.com/v1/search`, captured on '
|
|
88
|
-
+ new Date().toISOString().slice(0, 10) + '. Reproduce any of them with your own key: the script that');
|
|
89
|
-
say('generated this file is `evidence/contract-probe.mjs`. Page content is truncated to keep the file');
|
|
90
|
-
say('readable — nothing else is edited, and the API key is redacted.');
|
|
91
|
-
say();
|
|
92
|
-
say('---');
|
|
93
|
-
say();
|
|
94
|
-
say('## 1. Default request and response shape');
|
|
95
|
-
say();
|
|
96
|
-
await section('Query only', 'The whole request surface is `query`, `model`, `answer`, `max_results`. Everything else is ignored.', { query: Q });
|
|
97
|
-
|
|
98
|
-
say('## 2. Models');
|
|
99
|
-
say();
|
|
100
|
-
await section('krill — free tier', 'No answer synthesis on this tier: requesting one is ignored rather than refused (see §3).', { query: Q, model: 'krill' });
|
|
101
|
-
await section('mako — 1 credit', null, { query: Q, model: 'mako' });
|
|
102
|
-
await section('moby — 1.5 credits', 'Full readable page content; note the content lengths against mako above.', { query: Q, model: 'moby' });
|
|
103
|
-
|
|
104
|
-
say('## 3. `answer`');
|
|
105
|
-
say();
|
|
106
|
-
await section('answer: true with mako', 'The `answer` key is present only when requested.', { query: Q, model: 'mako', answer: true });
|
|
107
|
-
await section('answer: true with krill', 'Silently ignored on the free tier — no `answer` key, no error, still a complete result.', { query: Q, model: 'krill', answer: true });
|
|
108
|
-
|
|
109
|
-
say('## 4. `max_results` is a cap, never a minimum');
|
|
110
|
-
say();
|
|
111
|
-
say('A cap, applied at the edge after the search. The engine still reads a full corpus, so a small');
|
|
112
|
-
say('cap trims the response, not the work — and asking for more does not produce more.');
|
|
113
|
-
say();
|
|
114
|
-
for (const [n, note] of [
|
|
115
|
-
[1, null],
|
|
116
|
-
[3, null],
|
|
117
|
-
[10, 'The ceiling of the range. Fewer come back when fewer are judged relevant — see §1, where no cap returned 5.'],
|
|
118
|
-
[50, 'Above the range: clamped down to 10, silently. Never a 400.'],
|
|
119
|
-
[0, 'Below the range: clamped UP to 1, silently — it is the minimum of the range, NOT a way to say "no cap". One result comes back.'],
|
|
120
|
-
['abc', 'Unparseable, and this is the asymmetry worth knowing: an out-of-range NUMBER is clamped into the range, but a value that is not a number at all drops the cap entirely and the default applies. Same for null or an absent field.'],
|
|
121
|
-
]) {
|
|
122
|
-
await section(`max_results: ${JSON.stringify(n)}`, note, { query: Q, model: 'krill', max_results: n });
|
|
123
|
-
}
|
|
124
|
-
|
|
125
|
-
say('## 5. Errors');
|
|
126
|
-
say();
|
|
127
|
-
await section('Missing query', null, { model: 'krill' });
|
|
128
|
-
await section('Invalid key', null, { query: Q }, { key: 'sd_live_not_a_real_key' });
|
|
129
|
-
await section('No key at all', null, { query: Q }, { key: null });
|
|
130
|
-
|
|
131
|
-
say('## 6. Abort');
|
|
132
|
-
say();
|
|
133
|
-
await section('Client aborts mid-flight', 'The request is cancellable at any point; the provider maps this to the framework abort path.', { query: Q, model: 'krill' }, { abortAfterMs: 300 });
|
|
134
|
-
|
|
135
|
-
const path = new URL('./CONTRACT-EVIDENCE.md', import.meta.url).pathname;
|
|
136
|
-
fs.writeFileSync(path, out.join('\n'));
|
|
137
|
-
console.log(`written: ${path}`);
|
|
138
|
-
console.log(`${out.join('\n').length} characters`);
|
|
139
|
-
if (out.join('\n').includes(KEY)) console.error('!! THE API KEY APPEARS IN THE OUTPUT — not written');
|
|
140
|
-
else console.log('verified: the key appears nowhere in the output');
|
|
1
|
+
// Regenerates evidence/CONTRACT-EVIDENCE.md from REAL calls against the
|
|
2
|
+
// SERPdive API. Run it with your own key to reproduce the file:
|
|
3
|
+
//
|
|
4
|
+
// SERPDIVE_API_KEY=sd_live_… node evidence/contract-probe.mjs
|
|
5
|
+
//
|
|
6
|
+
// The key is read from the environment and never written to the output —
|
|
7
|
+
// the script asserts that before exiting.
|
|
8
|
+
import fs from 'node:fs';
|
|
9
|
+
|
|
10
|
+
const KEY = process.env.SERPDIVE_API_KEY;
|
|
11
|
+
if (!KEY) {
|
|
12
|
+
console.error('SERPDIVE_API_KEY is not set. Get a key at https://serpdive.com/dashboard/keys');
|
|
13
|
+
process.exit(1);
|
|
14
|
+
}
|
|
15
|
+
const URL = 'https://api.serpdive.com/v1/search';
|
|
16
|
+
const out = [];
|
|
17
|
+
const say = (s = '') => out.push(s);
|
|
18
|
+
|
|
19
|
+
async function call(body, { key = KEY, abortAfterMs = null } = {}) {
|
|
20
|
+
const ctrl = new AbortController();
|
|
21
|
+
if (abortAfterMs) setTimeout(() => ctrl.abort(), abortAfterMs);
|
|
22
|
+
const t0 = Date.now();
|
|
23
|
+
try {
|
|
24
|
+
const res = await fetch(URL, {
|
|
25
|
+
method: 'POST',
|
|
26
|
+
headers: { 'content-type': 'application/json', ...(key ? { authorization: `Bearer ${key}` } : {}) },
|
|
27
|
+
body: JSON.stringify(body),
|
|
28
|
+
signal: ctrl.signal,
|
|
29
|
+
});
|
|
30
|
+
const json = await res.json().catch(() => null);
|
|
31
|
+
return { status: res.status, ms: Date.now() - t0, json };
|
|
32
|
+
} catch (err) {
|
|
33
|
+
return { status: null, ms: Date.now() - t0, aborted: err.name === 'AbortError', err: err.name };
|
|
34
|
+
}
|
|
35
|
+
}
|
|
36
|
+
|
|
37
|
+
// Reduce a response to its SHAPE: keep the structure, truncate the content.
|
|
38
|
+
function shape(j) {
|
|
39
|
+
if (!j) return null;
|
|
40
|
+
const c = JSON.parse(JSON.stringify(j));
|
|
41
|
+
if (Array.isArray(c.results)) {
|
|
42
|
+
c.results = c.results.slice(0, 2).map((r) => ({
|
|
43
|
+
...r,
|
|
44
|
+
content: typeof r.content === 'string' ? `${r.content.slice(0, 90)}… (${r.content.length} chars)` : r.content,
|
|
45
|
+
}));
|
|
46
|
+
if (j.results.length > 2) c.results.push(`… ${j.results.length - 2} more, same shape`);
|
|
47
|
+
}
|
|
48
|
+
if (typeof c.answer === 'string') c.answer = `${c.answer.slice(0, 160)}… (${j.answer.length} chars)`;
|
|
49
|
+
return c;
|
|
50
|
+
}
|
|
51
|
+
|
|
52
|
+
async function section(title, note, body, opts = {}) {
|
|
53
|
+
const r = await call(body, opts);
|
|
54
|
+
const keyLine = !('key' in opts)
|
|
55
|
+
? 'authorization: Bearer sd_live_… # a valid key, redacted'
|
|
56
|
+
: opts.key === null
|
|
57
|
+
? '(no authorization header sent)'
|
|
58
|
+
: `authorization: Bearer ${opts.key}`;
|
|
59
|
+
say(`### ${title}`);
|
|
60
|
+
say();
|
|
61
|
+
if (note) { say(note); say(); }
|
|
62
|
+
say('```http');
|
|
63
|
+
say('POST https://api.serpdive.com/v1/search');
|
|
64
|
+
say(keyLine);
|
|
65
|
+
say('content-type: application/json');
|
|
66
|
+
say();
|
|
67
|
+
say(JSON.stringify(body));
|
|
68
|
+
say('```');
|
|
69
|
+
say();
|
|
70
|
+
if (r.aborted) {
|
|
71
|
+
say(`Client aborted after ${opts.abortAfterMs} ms → \`${r.err}\` raised locally; no response body.`);
|
|
72
|
+
} else {
|
|
73
|
+
say(`\`HTTP ${r.status}\` in ${r.ms} ms`);
|
|
74
|
+
say();
|
|
75
|
+
say('```json');
|
|
76
|
+
say(JSON.stringify(shape(r.json), null, 2));
|
|
77
|
+
say('```');
|
|
78
|
+
}
|
|
79
|
+
say();
|
|
80
|
+
return r;
|
|
81
|
+
}
|
|
82
|
+
|
|
83
|
+
const Q = 'best open source vector databases';
|
|
84
|
+
|
|
85
|
+
say('# SERPdive API — contract evidence');
|
|
86
|
+
say();
|
|
87
|
+
say('Every block below is a real call against `https://api.serpdive.com/v1/search`, captured on '
|
|
88
|
+
+ new Date().toISOString().slice(0, 10) + '. Reproduce any of them with your own key: the script that');
|
|
89
|
+
say('generated this file is `evidence/contract-probe.mjs`. Page content is truncated to keep the file');
|
|
90
|
+
say('readable — nothing else is edited, and the API key is redacted.');
|
|
91
|
+
say();
|
|
92
|
+
say('---');
|
|
93
|
+
say();
|
|
94
|
+
say('## 1. Default request and response shape');
|
|
95
|
+
say();
|
|
96
|
+
await section('Query only', 'The whole request surface is `query`, `model`, `answer`, `max_results`. Everything else is ignored.', { query: Q });
|
|
97
|
+
|
|
98
|
+
say('## 2. Models');
|
|
99
|
+
say();
|
|
100
|
+
await section('krill — free tier', 'No answer synthesis on this tier: requesting one is ignored rather than refused (see §3).', { query: Q, model: 'krill' });
|
|
101
|
+
await section('mako — 1 credit', null, { query: Q, model: 'mako' });
|
|
102
|
+
await section('moby — 1.5 credits', 'Full readable page content; note the content lengths against mako above.', { query: Q, model: 'moby' });
|
|
103
|
+
|
|
104
|
+
say('## 3. `answer`');
|
|
105
|
+
say();
|
|
106
|
+
await section('answer: true with mako', 'The `answer` key is present only when requested.', { query: Q, model: 'mako', answer: true });
|
|
107
|
+
await section('answer: true with krill', 'Silently ignored on the free tier — no `answer` key, no error, still a complete result.', { query: Q, model: 'krill', answer: true });
|
|
108
|
+
|
|
109
|
+
say('## 4. `max_results` is a cap, never a minimum');
|
|
110
|
+
say();
|
|
111
|
+
say('A cap, applied at the edge after the search. The engine still reads a full corpus, so a small');
|
|
112
|
+
say('cap trims the response, not the work — and asking for more does not produce more.');
|
|
113
|
+
say();
|
|
114
|
+
for (const [n, note] of [
|
|
115
|
+
[1, null],
|
|
116
|
+
[3, null],
|
|
117
|
+
[10, 'The ceiling of the range. Fewer come back when fewer are judged relevant — see §1, where no cap returned 5.'],
|
|
118
|
+
[50, 'Above the range: clamped down to 10, silently. Never a 400.'],
|
|
119
|
+
[0, 'Below the range: clamped UP to 1, silently — it is the minimum of the range, NOT a way to say "no cap". One result comes back.'],
|
|
120
|
+
['abc', 'Unparseable, and this is the asymmetry worth knowing: an out-of-range NUMBER is clamped into the range, but a value that is not a number at all drops the cap entirely and the default applies. Same for null or an absent field.'],
|
|
121
|
+
]) {
|
|
122
|
+
await section(`max_results: ${JSON.stringify(n)}`, note, { query: Q, model: 'krill', max_results: n });
|
|
123
|
+
}
|
|
124
|
+
|
|
125
|
+
say('## 5. Errors');
|
|
126
|
+
say();
|
|
127
|
+
await section('Missing query', null, { model: 'krill' });
|
|
128
|
+
await section('Invalid key', null, { query: Q }, { key: 'sd_live_not_a_real_key' });
|
|
129
|
+
await section('No key at all', null, { query: Q }, { key: null });
|
|
130
|
+
|
|
131
|
+
say('## 6. Abort');
|
|
132
|
+
say();
|
|
133
|
+
await section('Client aborts mid-flight', 'The request is cancellable at any point; the provider maps this to the framework abort path.', { query: Q, model: 'krill' }, { abortAfterMs: 300 });
|
|
134
|
+
|
|
135
|
+
const path = new URL('./CONTRACT-EVIDENCE.md', import.meta.url).pathname;
|
|
136
|
+
fs.writeFileSync(path, out.join('\n'));
|
|
137
|
+
console.log(`written: ${path}`);
|
|
138
|
+
console.log(`${out.join('\n').length} characters`);
|
|
139
|
+
if (out.join('\n').includes(KEY)) console.error('!! THE API KEY APPEARS IN THE OUTPUT — not written');
|
|
140
|
+
else console.log('verified: the key appears nowhere in the output');
|