@opencraw/driver 0.7.10 → 0.7.11

package/README.md

@@ -1,79 +1,3 @@
-<p align="center">
-  <img src="https://raw.githubusercontent.com/Open-Craw/OpenCraw/main/docs/assets/opencraw-logo.svg" alt="OpenCraw" width="360">
-</p>
-
 # @opencraw/driver
 
-[OpenCraw](https://github.com/Open-Craw/OpenCraw/blob/main/README.md)'s engine as a process another language talks
-to. A client in Python, Go, Dart, C#, Rust, Java, Ruby, PHP or C++ starts `opencraw-driver` once, and speaks
-**JSON-RPC 2.0 over its stdin and stdout, one message per line**. It sends recipes, gets every crawl event and
-record as it happens, and answers the recipes' hooks with functions in its own language. This is how the
-OpenCraw packages for other languages work (`docs/research/driver-and-language-packages.md`).
-
-```sh
-npx opencraw-driver   # then write JSON-RPC lines to it
-```
-
-## The conversation
-
-```jsonc
-→ {"jsonrpc":"2.0","id":1,"method":"initialize","params":{"clientName":"opencraw-python","clientVersion":"1.0.0","protocolVersion":"1.2.0"}}
-← {"jsonrpc":"2.0","id":1,"result":{"driverVersion":"0.2.0","protocolVersion":"1.2.0","methods":["initialize","validate","run","work","cancel","probe","diff","export","shutdown"]}}
-→ {"jsonrpc":"2.0","id":2,"method":"run","params":{"paths":["recipes/"],"hooks":["tidy"]}}
-← {"jsonrpc":"2.0","id":2,"result":{"runId":"run-1"}}
-← {"jsonrpc":"2.0","method":"event","params":{"runId":"run-1","event":{"type":"recipe:start",…}}}
-← {"jsonrpc":"2.0","id":1,"method":"callout","params":{"runId":"run-1","request":{"kind":"hook","name":"tidy","input":" A ",…}}}
-→ {"jsonrpc":"2.0","id":1,"result":{"status":"ok","output":"a"}}
-← {"jsonrpc":"2.0","method":"record","params":{"runId":"run-1","recipeId":"things","key":"…","data":{…}}}
-← {"jsonrpc":"2.0","method":"finished","params":{"runId":"run-1","report":{…}}}
-→ {"jsonrpc":"2.0","id":3,"method":"shutdown"}
-```
-
-| Method | From | Does |
-|---|---|---|
-| `initialize` | client | Must come first. The driver refuses a protocol of another major. |
-| `validate` | client | Loads recipes (`paths` or inline `recipes`) without running them: the inputs that would run, every hook they call, and every problem with its path. |
-| `run` | client | Starts a run and answers its `runId` at once; the crawl goes on in the background. `hooks`, `captchaSolvers` and `accessPlugins` name what the client answers; `accessConfig` and `access` pick the access config and profile; `out` writes records to a file instead of sending them. |
-| `work` | client | Starts a worker pool and answers its `runId` at once. Its windows ask the client for items (`work.next`) and keep the steps marked `keep` between them; `windows` is a count or core's `WindowsPolicy`. Takes the same crawler fields as `run`. |
-| `cancel` | client | Stops a run (its crawler is closed); it still ends with `finished`. |
-| `probe` | client | Fetches a page (or renders it, with `browser`) and says where its data lives: the CLI's and MCP's probe, through the same access fields as `run`. |
-| `diff` | client | Compares two runs' JSON Lines files by key: counts, the report a person reads, and the changes up to `limit`. |
-| `export` | client | Writes a run's JSON Lines file in another format (the extension of `out`), with an output recipe's columns. |
-| `shutdown` | client | Closes every run, answers, then exits. Closing stdin does the same. |
-| `event` | driver | Every crawl event, as core reports it. |
-| `record` | driver | Each record, unless the run has `out`. |
-| `finished` | driver | The run is over: its report (for `work`, the work report), or why it could not run. |
-| `work.next` | driver | A window wants an item: answer `{ "item": { "id", "vars", "recipe"? } }`, holding the answer until there is one, or `{ "item": null }` to end the work. An id already queued or running runs once. |
-| `work.done`, `work.failed` | driver | How an item ended: its report and records, or its outcome (`failure`, `neutral`). |
-| `callout` | driver | A hook, captcha solver or access plugin the client serves (`request.kind`: `hook`, `captcha`, `access`). The request and its answer are core's [callout contract](../core/README.md): `ok`, `error`, or `pending` with `retryAfterMs`, asked again with the same idempotency key. |
-
-A run's answer (`run`, `work`) always comes before any of its events, records or callouts. Every answer comes back before the driver stops, even when a client writes its last requests and closes
-stdin at once. Answers may arrive out of order; match them by `id`.
-
-## For client authors
-
-- `schemas/driver-protocol.schema.json` is every message's shape, generated from the protocol's zod
-  contracts. Generate your models from it rather than typing them by hand.
-- `conformance/*.json` are recorded conversations. A client is done when it replays them all against the real
-  driver. See `conformance/README.md`.
-- Errors are JSON-RPC's codes: `-32700` (not JSON), `-32600` (not JSON-RPC), `-32601` (no such method),
-  `-32602` (bad params, the problems listed), `-32000` (a failure to act on: its message says what to do).
-- stdout carries protocol messages only. The driver's own logs go to stderr.
-
-## The runtime: no Node needed
-
-Each driver release carries, as assets of its GitHub release `driver@<version>`, an archive per platform
-(`win32-x64`, `darwin-arm64`, `darwin-x64`, `linux-x64`, `linux-arm64`): a Node binary, the driver and its
-dependencies, and `runtime.json`, whose `command` starts it (both paths relative to the unpacked folder).
-`driver-runtime.json` lists them with their SHA-256 and size; its schema is `schemas/driver-runtime.schema.json`
-and `schemas/driver-runtime.fixture.json` is an example. A client downloads its platform's archive once, refuses
-one whose hash does not match, unpacks it into a per-user cache and starts the driver from there.
-
-`node packages/driver/packaging/stage-runtime.mjs` builds this platform's archive into `dist/drop/driver-runtime`
-(after `smith build -p driver`), and starts the staged driver once with `PATH` emptied, to prove it needs nothing
-else. Browsers are not in it: they are installed through the driver, the Playwright way.
-
-## Development
-
-`smith run lint typecheck test build -p driver`. After changing a contract in `src/protocol/`, run
-`smith run schemas -p driver` to rewrite `schemas/driver-protocol.schema.json`; a test fails until you do.
+This package is no longer available.

package/package.json

@@ -1,47 +1,6 @@
 {
   "name": "@opencraw/driver",
-  "version": "0.7.10",
-  "description": "OpenCraw's driver: the engine over JSON-RPC on stdio, for clients in other languages",
-  "license": "MIT",
-  "type": "module",
-  "smith": {
-    "kind": "package",
-    "stack": "node-vitest"
-  },
-  "main": "./dist/index.esm.js",
-  "module": "./dist/index.esm.js",
-  "types": "./dist/src/index.d.ts",
-  "exports": {
-    "./package.json": "./package.json",
-    ".": {
-      "types": "./dist/src/index.d.ts",
-      "import": "./dist/index.esm.js",
-      "default": "./dist/index.esm.js"
-    }
-  },
-  "bin": {
-    "opencraw-driver": "./dist/main.esm.js"
-  },
-  "files": [
-    "dist",
-    "schemas",
-    "!**/*.tsbuildinfo",
-    "!**/*.d.ts.map",
-    "!**/*.js.map"
-  ],
-  "publishConfig": {
-    "access": "public"
-  },
-  "scripts": {
-    "build": "esbuild src/index.ts src/main.ts --bundle --packages=external --platform=node --format=esm --outdir=dist --out-extension:.js=.esm.js --sourcemap && tsc -p tsconfig.build.json && node ../../declaration-specifiers.mjs dist/src",
-    "typecheck": "tsc -p tsconfig.json",
-    "lint": "eslint .",
-    "test": "vitest run",
-    "schemas": "node tools/emit-protocol-schema.mjs"
-  },
-  "dependencies": {
-    "@opencraw/cli": "^0.2.2",
-    "@opencraw/core": "^0.5.0",
-    "zod": "^4.6.5"
-  }
-}
+  "version": "0.7.11",
+  "description": "This package is no longer available.",
+  "license": "MIT"
+}