@auggieteo/dsh-synthetic-web-search 0.2.2 → 0.2.3
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 +6 -2
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -22,7 +22,7 @@ dsh plugin --profile web add @auggieteo/dsh-synthetic-web-search
|
|
|
22
22
|
|
|
23
23
|
### Public Git URL
|
|
24
24
|
|
|
25
|
-
|
|
25
|
+
Install directly from the public Git repository:
|
|
26
26
|
|
|
27
27
|
```bash
|
|
28
28
|
dsh plugin --profile web add git+https://github.com/auggie246/dsh-synthetic-web-search.git
|
|
@@ -101,6 +101,8 @@ npm run verify
|
|
|
101
101
|
|
|
102
102
|
`npm run verify` cleans generated output, type-checks, runs mocked provider tests, builds `lib/` from source (including the browser client bundle), and checks the npm package contents with `npm pack --dry-run`.
|
|
103
103
|
|
|
104
|
+
Releases are automated. Publish a GitHub release tagged `v<version>`, where `<version>` matches `package.json`. The publish workflow installs with `npm ci`, checks the tag, tests, builds, and publishes to npm. A prerelease publishes under the npm dist-tag `next`. A stable release publishes under `latest`.
|
|
105
|
+
|
|
104
106
|
To test a local checkout without touching another profile, point a throwaway profile at its absolute path:
|
|
105
107
|
|
|
106
108
|
```bash
|
|
@@ -114,7 +116,9 @@ The provider sends the documented request:
|
|
|
114
116
|
```http
|
|
115
117
|
POST https://api.synthetic.new/v2/search
|
|
116
118
|
Authorization: Bearer $SYNTHETIC_API_KEY
|
|
119
|
+
Accept: application/json
|
|
117
120
|
Content-Type: application/json
|
|
121
|
+
User-Agent: deepseek-harness-synthetic/0.1.0
|
|
118
122
|
|
|
119
123
|
{ "query": "…" }
|
|
120
124
|
```
|
|
@@ -128,6 +132,6 @@ It maps valid results into the Harness source vocabulary:
|
|
|
128
132
|
| `text` | `snippet` |
|
|
129
133
|
| `published` | `publishedAt` |
|
|
130
134
|
|
|
131
|
-
Malformed or non-URL entries are ignored. The provider does not create a generated answer (`content`) and returns `truncated: false`; the `ctx.web` seam applies the caller's `maxResults` cap. Network, redirect, HTTP, and response-shape failures surface as `WEB_PROVIDER_ERROR`; aborted requests surface as `WEB_ABORTED`.
|
|
135
|
+
Malformed or non-URL entries are ignored. The provider does not create a generated answer (`content`) and returns `truncated: false`; the `ctx.web` seam applies the caller's `maxResults` cap. Network, redirect, HTTP, and response-shape failures surface as `WEB_PROVIDER_ERROR`; a missing API key surfaces as `WEB_PROVIDER_CREDENTIAL_MISSING`; aborted requests surface as `WEB_ABORTED`.
|
|
132
136
|
|
|
133
137
|
Synthetic's documented API currently exposes only `query`, so `maxResults` is intentionally not sent upstream.
|
package/package.json
CHANGED