pi-cursor-sdk 0.1.46 → 0.1.48
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/CHANGELOG.md +16 -0
- package/README.md +2 -2
- package/docs/cursor-live-smoke-checklist.md +4 -4
- package/docs/cursor-model-ux-spec.md +1 -1
- package/docs/cursor-native-tool-visual-audit.md +1 -1
- package/docs/cursor-testing-lessons.md +1 -1
- package/node_modules/@connectrpc/connect-node/README.md +141 -0
- package/node_modules/@connectrpc/connect-node/dist/cjs/compression.d.ts +15 -0
- package/node_modules/@connectrpc/connect-node/dist/cjs/compression.js +89 -0
- package/node_modules/@connectrpc/connect-node/dist/cjs/connect-node-adapter.d.ts +42 -0
- package/node_modules/@connectrpc/connect-node/dist/cjs/connect-node-adapter.js +61 -0
- package/node_modules/@connectrpc/connect-node/dist/cjs/connect-transport.d.ts +100 -0
- package/node_modules/@connectrpc/connect-node/dist/cjs/connect-transport.js +25 -0
- package/node_modules/@connectrpc/connect-node/dist/cjs/grpc-transport.d.ts +96 -0
- package/node_modules/@connectrpc/connect-node/dist/cjs/grpc-transport.js +25 -0
- package/node_modules/@connectrpc/connect-node/dist/cjs/grpc-web-transport.d.ts +96 -0
- package/node_modules/@connectrpc/connect-node/dist/cjs/grpc-web-transport.js +25 -0
- package/node_modules/@connectrpc/connect-node/dist/cjs/http2-session-manager.d.ts +146 -0
- package/node_modules/@connectrpc/connect-node/dist/cjs/http2-session-manager.js +536 -0
- package/node_modules/@connectrpc/connect-node/dist/cjs/index.d.ts +15 -0
- package/node_modules/@connectrpc/connect-node/dist/cjs/index.js +36 -0
- package/node_modules/@connectrpc/connect-node/dist/cjs/node-error.d.ts +45 -0
- package/node_modules/@connectrpc/connect-node/dist/cjs/node-error.js +154 -0
- package/node_modules/@connectrpc/connect-node/dist/cjs/node-headers-polyfill.d.ts +1 -0
- package/node_modules/@connectrpc/connect-node/dist/cjs/node-headers-polyfill.js +29 -0
- package/node_modules/@connectrpc/connect-node/dist/cjs/node-transport-options.d.ts +89 -0
- package/node_modules/@connectrpc/connect-node/dist/cjs/node-transport-options.js +58 -0
- package/node_modules/@connectrpc/connect-node/dist/cjs/node-universal-client.d.ts +54 -0
- package/node_modules/@connectrpc/connect-node/dist/cjs/node-universal-client.js +326 -0
- package/node_modules/@connectrpc/connect-node/dist/cjs/node-universal-handler.d.ts +41 -0
- package/node_modules/@connectrpc/connect-node/dist/cjs/node-universal-handler.js +234 -0
- package/node_modules/@connectrpc/connect-node/dist/cjs/node-universal-header.d.ts +19 -0
- package/node_modules/@connectrpc/connect-node/dist/cjs/node-universal-header.js +97 -0
- package/node_modules/@connectrpc/connect-node/dist/cjs/package.json +1 -0
- package/node_modules/@connectrpc/connect-node/dist/esm/compression.d.ts +15 -0
- package/node_modules/@connectrpc/connect-node/dist/esm/compression.js +86 -0
- package/node_modules/@connectrpc/connect-node/dist/esm/connect-node-adapter.d.ts +42 -0
- package/node_modules/@connectrpc/connect-node/dist/esm/connect-node-adapter.js +58 -0
- package/node_modules/@connectrpc/connect-node/dist/esm/connect-transport.d.ts +100 -0
- package/node_modules/@connectrpc/connect-node/dist/esm/connect-transport.js +22 -0
- package/node_modules/@connectrpc/connect-node/dist/esm/grpc-transport.d.ts +96 -0
- package/node_modules/@connectrpc/connect-node/dist/esm/grpc-transport.js +22 -0
- package/node_modules/@connectrpc/connect-node/dist/esm/grpc-web-transport.d.ts +96 -0
- package/node_modules/@connectrpc/connect-node/dist/esm/grpc-web-transport.js +22 -0
- package/node_modules/@connectrpc/connect-node/dist/esm/http2-session-manager.d.ts +146 -0
- package/node_modules/@connectrpc/connect-node/dist/esm/http2-session-manager.js +532 -0
- package/node_modules/@connectrpc/connect-node/dist/esm/index.d.ts +15 -0
- package/node_modules/@connectrpc/connect-node/dist/esm/index.js +23 -0
- package/node_modules/@connectrpc/connect-node/dist/esm/node-error.d.ts +45 -0
- package/node_modules/@connectrpc/connect-node/dist/esm/node-error.js +147 -0
- package/node_modules/@connectrpc/connect-node/dist/esm/node-headers-polyfill.d.ts +1 -0
- package/node_modules/@connectrpc/connect-node/dist/esm/node-headers-polyfill.js +27 -0
- package/node_modules/@connectrpc/connect-node/dist/esm/node-transport-options.d.ts +89 -0
- package/node_modules/@connectrpc/connect-node/dist/esm/node-transport-options.js +58 -0
- package/node_modules/@connectrpc/connect-node/dist/esm/node-universal-client.d.ts +54 -0
- package/node_modules/@connectrpc/connect-node/dist/esm/node-universal-client.js +324 -0
- package/node_modules/@connectrpc/connect-node/dist/esm/node-universal-handler.d.ts +41 -0
- package/node_modules/@connectrpc/connect-node/dist/esm/node-universal-handler.js +230 -0
- package/node_modules/@connectrpc/connect-node/dist/esm/node-universal-header.d.ts +19 -0
- package/node_modules/@connectrpc/connect-node/dist/esm/node-universal-header.js +93 -0
- package/node_modules/@connectrpc/connect-node/package.json +46 -0
- package/node_modules/undici/LICENSE +21 -0
- package/node_modules/undici/README.md +741 -0
- package/node_modules/undici/docs/docs/api/Agent.md +84 -0
- package/node_modules/undici/docs/docs/api/BalancedPool.md +99 -0
- package/node_modules/undici/docs/docs/api/CacheStorage.md +30 -0
- package/node_modules/undici/docs/docs/api/CacheStore.md +164 -0
- package/node_modules/undici/docs/docs/api/Client.md +288 -0
- package/node_modules/undici/docs/docs/api/ClientStats.md +27 -0
- package/node_modules/undici/docs/docs/api/Connector.md +115 -0
- package/node_modules/undici/docs/docs/api/ContentType.md +57 -0
- package/node_modules/undici/docs/docs/api/Cookies.md +128 -0
- package/node_modules/undici/docs/docs/api/Debug.md +62 -0
- package/node_modules/undici/docs/docs/api/DiagnosticsChannel.md +315 -0
- package/node_modules/undici/docs/docs/api/Dispatcher.md +1392 -0
- package/node_modules/undici/docs/docs/api/EnvHttpProxyAgent.md +159 -0
- package/node_modules/undici/docs/docs/api/Errors.md +49 -0
- package/node_modules/undici/docs/docs/api/EventSource.md +45 -0
- package/node_modules/undici/docs/docs/api/Fetch.md +60 -0
- package/node_modules/undici/docs/docs/api/GlobalInstallation.md +139 -0
- package/node_modules/undici/docs/docs/api/H2CClient.md +263 -0
- package/node_modules/undici/docs/docs/api/MockAgent.md +603 -0
- package/node_modules/undici/docs/docs/api/MockCallHistory.md +197 -0
- package/node_modules/undici/docs/docs/api/MockCallHistoryLog.md +43 -0
- package/node_modules/undici/docs/docs/api/MockClient.md +81 -0
- package/node_modules/undici/docs/docs/api/MockErrors.md +12 -0
- package/node_modules/undici/docs/docs/api/MockPool.md +555 -0
- package/node_modules/undici/docs/docs/api/Pool.md +84 -0
- package/node_modules/undici/docs/docs/api/PoolStats.md +35 -0
- package/node_modules/undici/docs/docs/api/ProxyAgent.md +229 -0
- package/node_modules/undici/docs/docs/api/RedirectHandler.md +93 -0
- package/node_modules/undici/docs/docs/api/RetryAgent.md +50 -0
- package/node_modules/undici/docs/docs/api/RetryHandler.md +118 -0
- package/node_modules/undici/docs/docs/api/RoundRobinPool.md +145 -0
- package/node_modules/undici/docs/docs/api/SnapshotAgent.md +616 -0
- package/node_modules/undici/docs/docs/api/Socks5ProxyAgent.md +275 -0
- package/node_modules/undici/docs/docs/api/Util.md +25 -0
- package/node_modules/undici/docs/docs/api/WebSocket.md +141 -0
- package/node_modules/undici/docs/docs/api/api-lifecycle.md +91 -0
- package/node_modules/undici/docs/docs/best-practices/client-certificate.md +64 -0
- package/node_modules/undici/docs/docs/best-practices/crawling.md +58 -0
- package/node_modules/undici/docs/docs/best-practices/mocking-request.md +190 -0
- package/node_modules/undici/docs/docs/best-practices/proxy.md +127 -0
- package/node_modules/undici/docs/docs/best-practices/undici-vs-builtin-fetch.md +224 -0
- package/node_modules/undici/docs/docs/best-practices/writing-tests.md +63 -0
- package/node_modules/undici/index-fetch.js +65 -0
- package/node_modules/undici/index.d.ts +3 -0
- package/node_modules/undici/index.js +234 -0
- package/node_modules/undici/lib/api/abort-signal.js +59 -0
- package/node_modules/undici/lib/api/api-connect.js +110 -0
- package/node_modules/undici/lib/api/api-pipeline.js +252 -0
- package/node_modules/undici/lib/api/api-request.js +214 -0
- package/node_modules/undici/lib/api/api-stream.js +209 -0
- package/node_modules/undici/lib/api/api-upgrade.js +111 -0
- package/node_modules/undici/lib/api/index.js +7 -0
- package/node_modules/undici/lib/api/readable.js +580 -0
- package/node_modules/undici/lib/cache/memory-cache-store.js +234 -0
- package/node_modules/undici/lib/cache/sqlite-cache-store.js +461 -0
- package/node_modules/undici/lib/core/connect.js +153 -0
- package/node_modules/undici/lib/core/constants.js +143 -0
- package/node_modules/undici/lib/core/diagnostics.js +227 -0
- package/node_modules/undici/lib/core/errors.js +477 -0
- package/node_modules/undici/lib/core/request.js +453 -0
- package/node_modules/undici/lib/core/socks5-client.js +422 -0
- package/node_modules/undici/lib/core/socks5-utils.js +212 -0
- package/node_modules/undici/lib/core/symbols.js +75 -0
- package/node_modules/undici/lib/core/tree.js +160 -0
- package/node_modules/undici/lib/core/util.js +992 -0
- package/node_modules/undici/lib/dispatcher/agent.js +158 -0
- package/node_modules/undici/lib/dispatcher/balanced-pool.js +219 -0
- package/node_modules/undici/lib/dispatcher/client-h1.js +1722 -0
- package/node_modules/undici/lib/dispatcher/client-h2.js +995 -0
- package/node_modules/undici/lib/dispatcher/client.js +664 -0
- package/node_modules/undici/lib/dispatcher/dispatcher-base.js +184 -0
- package/node_modules/undici/lib/dispatcher/dispatcher.js +48 -0
- package/node_modules/undici/lib/dispatcher/env-http-proxy-agent.js +146 -0
- package/node_modules/undici/lib/dispatcher/fixed-queue.js +135 -0
- package/node_modules/undici/lib/dispatcher/h2c-client.js +51 -0
- package/node_modules/undici/lib/dispatcher/pool-base.js +214 -0
- package/node_modules/undici/lib/dispatcher/pool.js +118 -0
- package/node_modules/undici/lib/dispatcher/proxy-agent.js +319 -0
- package/node_modules/undici/lib/dispatcher/retry-agent.js +35 -0
- package/node_modules/undici/lib/dispatcher/round-robin-pool.js +137 -0
- package/node_modules/undici/lib/dispatcher/socks5-proxy-agent.js +260 -0
- package/node_modules/undici/lib/encoding/index.js +33 -0
- package/node_modules/undici/lib/global.js +59 -0
- package/node_modules/undici/lib/handler/cache-handler.js +578 -0
- package/node_modules/undici/lib/handler/cache-revalidation-handler.js +124 -0
- package/node_modules/undici/lib/handler/decorator-handler.js +67 -0
- package/node_modules/undici/lib/handler/deduplication-handler.js +460 -0
- package/node_modules/undici/lib/handler/redirect-handler.js +238 -0
- package/node_modules/undici/lib/handler/retry-handler.js +394 -0
- package/node_modules/undici/lib/handler/unwrap-handler.js +106 -0
- package/node_modules/undici/lib/handler/wrap-handler.js +105 -0
- package/node_modules/undici/lib/interceptor/cache.js +495 -0
- package/node_modules/undici/lib/interceptor/decompress.js +259 -0
- package/node_modules/undici/lib/interceptor/deduplicate.js +117 -0
- package/node_modules/undici/lib/interceptor/dns.js +571 -0
- package/node_modules/undici/lib/interceptor/dump.js +112 -0
- package/node_modules/undici/lib/interceptor/redirect.js +21 -0
- package/node_modules/undici/lib/interceptor/response-error.js +95 -0
- package/node_modules/undici/lib/interceptor/retry.js +19 -0
- package/node_modules/undici/lib/llhttp/.gitkeep +0 -0
- package/node_modules/undici/lib/llhttp/constants.d.ts +195 -0
- package/node_modules/undici/lib/llhttp/constants.js +531 -0
- package/node_modules/undici/lib/llhttp/llhttp-wasm.js +15 -0
- package/node_modules/undici/lib/llhttp/llhttp_simd-wasm.js +15 -0
- package/node_modules/undici/lib/llhttp/utils.d.ts +2 -0
- package/node_modules/undici/lib/llhttp/utils.js +12 -0
- package/node_modules/undici/lib/mock/mock-agent.js +232 -0
- package/node_modules/undici/lib/mock/mock-call-history.js +248 -0
- package/node_modules/undici/lib/mock/mock-client.js +68 -0
- package/node_modules/undici/lib/mock/mock-errors.js +29 -0
- package/node_modules/undici/lib/mock/mock-interceptor.js +209 -0
- package/node_modules/undici/lib/mock/mock-pool.js +68 -0
- package/node_modules/undici/lib/mock/mock-symbols.js +32 -0
- package/node_modules/undici/lib/mock/mock-utils.js +486 -0
- package/node_modules/undici/lib/mock/pending-interceptors-formatter.js +43 -0
- package/node_modules/undici/lib/mock/snapshot-agent.js +353 -0
- package/node_modules/undici/lib/mock/snapshot-recorder.js +588 -0
- package/node_modules/undici/lib/mock/snapshot-utils.js +158 -0
- package/node_modules/undici/lib/util/cache.js +414 -0
- package/node_modules/undici/lib/util/date.js +653 -0
- package/node_modules/undici/lib/util/promise.js +28 -0
- package/node_modules/undici/lib/util/runtime-features.js +124 -0
- package/node_modules/undici/lib/util/stats.js +32 -0
- package/node_modules/undici/lib/util/timers.js +425 -0
- package/node_modules/undici/lib/web/cache/cache.js +864 -0
- package/node_modules/undici/lib/web/cache/cachestorage.js +152 -0
- package/node_modules/undici/lib/web/cache/util.js +45 -0
- package/node_modules/undici/lib/web/cookies/constants.js +12 -0
- package/node_modules/undici/lib/web/cookies/index.js +199 -0
- package/node_modules/undici/lib/web/cookies/parse.js +314 -0
- package/node_modules/undici/lib/web/cookies/util.js +282 -0
- package/node_modules/undici/lib/web/eventsource/eventsource-stream.js +399 -0
- package/node_modules/undici/lib/web/eventsource/eventsource.js +501 -0
- package/node_modules/undici/lib/web/eventsource/util.js +29 -0
- package/node_modules/undici/lib/web/fetch/LICENSE +21 -0
- package/node_modules/undici/lib/web/fetch/body.js +509 -0
- package/node_modules/undici/lib/web/fetch/constants.js +131 -0
- package/node_modules/undici/lib/web/fetch/data-url.js +596 -0
- package/node_modules/undici/lib/web/fetch/formdata-parser.js +586 -0
- package/node_modules/undici/lib/web/fetch/formdata.js +259 -0
- package/node_modules/undici/lib/web/fetch/global.js +40 -0
- package/node_modules/undici/lib/web/fetch/headers.js +719 -0
- package/node_modules/undici/lib/web/fetch/index.js +2413 -0
- package/node_modules/undici/lib/web/fetch/request.js +1115 -0
- package/node_modules/undici/lib/web/fetch/response.js +641 -0
- package/node_modules/undici/lib/web/fetch/util.js +1522 -0
- package/node_modules/undici/lib/web/infra/index.js +229 -0
- package/node_modules/undici/lib/web/subresource-integrity/Readme.md +9 -0
- package/node_modules/undici/lib/web/subresource-integrity/subresource-integrity.js +307 -0
- package/node_modules/undici/lib/web/webidl/index.js +1006 -0
- package/node_modules/undici/lib/web/websocket/connection.js +329 -0
- package/node_modules/undici/lib/web/websocket/constants.js +126 -0
- package/node_modules/undici/lib/web/websocket/events.js +331 -0
- package/node_modules/undici/lib/web/websocket/frame.js +133 -0
- package/node_modules/undici/lib/web/websocket/permessage-deflate.js +100 -0
- package/node_modules/undici/lib/web/websocket/receiver.js +507 -0
- package/node_modules/undici/lib/web/websocket/sender.js +109 -0
- package/node_modules/undici/lib/web/websocket/stream/websocketerror.js +104 -0
- package/node_modules/undici/lib/web/websocket/stream/websocketstream.js +498 -0
- package/node_modules/undici/lib/web/websocket/util.js +347 -0
- package/node_modules/undici/lib/web/websocket/websocket.js +758 -0
- package/node_modules/undici/package.json +152 -0
- package/node_modules/undici/scripts/strip-comments.js +10 -0
- package/node_modules/undici/types/README.md +6 -0
- package/node_modules/undici/types/agent.d.ts +32 -0
- package/node_modules/undici/types/api.d.ts +43 -0
- package/node_modules/undici/types/balanced-pool.d.ts +30 -0
- package/node_modules/undici/types/cache-interceptor.d.ts +179 -0
- package/node_modules/undici/types/cache.d.ts +36 -0
- package/node_modules/undici/types/client-stats.d.ts +15 -0
- package/node_modules/undici/types/client.d.ts +139 -0
- package/node_modules/undici/types/connector.d.ts +36 -0
- package/node_modules/undici/types/content-type.d.ts +21 -0
- package/node_modules/undici/types/cookies.d.ts +30 -0
- package/node_modules/undici/types/diagnostics-channel.d.ts +74 -0
- package/node_modules/undici/types/dispatcher.d.ts +275 -0
- package/node_modules/undici/types/env-http-proxy-agent.d.ts +22 -0
- package/node_modules/undici/types/errors.d.ts +177 -0
- package/node_modules/undici/types/eventsource.d.ts +66 -0
- package/node_modules/undici/types/fetch.d.ts +231 -0
- package/node_modules/undici/types/formdata.d.ts +114 -0
- package/node_modules/undici/types/global-dispatcher.d.ts +9 -0
- package/node_modules/undici/types/global-origin.d.ts +7 -0
- package/node_modules/undici/types/h2c-client.d.ts +73 -0
- package/node_modules/undici/types/handlers.d.ts +14 -0
- package/node_modules/undici/types/header.d.ts +160 -0
- package/node_modules/undici/types/index.d.ts +91 -0
- package/node_modules/undici/types/interceptors.d.ts +80 -0
- package/node_modules/undici/types/mock-agent.d.ts +68 -0
- package/node_modules/undici/types/mock-call-history.d.ts +111 -0
- package/node_modules/undici/types/mock-client.d.ts +27 -0
- package/node_modules/undici/types/mock-errors.d.ts +12 -0
- package/node_modules/undici/types/mock-interceptor.d.ts +94 -0
- package/node_modules/undici/types/mock-pool.d.ts +27 -0
- package/node_modules/undici/types/patch.d.ts +29 -0
- package/node_modules/undici/types/pool-stats.d.ts +19 -0
- package/node_modules/undici/types/pool.d.ts +41 -0
- package/node_modules/undici/types/proxy-agent.d.ts +29 -0
- package/node_modules/undici/types/readable.d.ts +68 -0
- package/node_modules/undici/types/retry-agent.d.ts +8 -0
- package/node_modules/undici/types/retry-handler.d.ts +125 -0
- package/node_modules/undici/types/round-robin-pool.d.ts +41 -0
- package/node_modules/undici/types/snapshot-agent.d.ts +109 -0
- package/node_modules/undici/types/socks5-proxy-agent.d.ts +25 -0
- package/node_modules/undici/types/util.d.ts +18 -0
- package/node_modules/undici/types/utility.d.ts +7 -0
- package/node_modules/undici/types/webidl.d.ts +347 -0
- package/node_modules/undici/types/websocket.d.ts +188 -0
- package/package.json +10 -5
package/CHANGELOG.md
CHANGED
|
@@ -2,6 +2,22 @@
|
|
|
2
2
|
|
|
3
3
|
## Unreleased
|
|
4
4
|
|
|
5
|
+
## 0.1.48 - 2026-06-22
|
|
6
|
+
|
|
7
|
+
### Fixed
|
|
8
|
+
|
|
9
|
+
- Bundle Cursor's Node ConnectRPC transport seam with `undici` `7.28.0` so downstream `pi install npm:pi-cursor-sdk` production installs inherit the audited transport dependency instead of npm's root-only `overrides` fix.
|
|
10
|
+
|
|
11
|
+
## 0.1.47 - 2026-06-22
|
|
12
|
+
|
|
13
|
+
### Changed
|
|
14
|
+
|
|
15
|
+
- Update the local pi validation baseline to `@earendil-works/pi-ai`, `@earendil-works/pi-coding-agent`, and `@earendil-works/pi-tui` `0.79.10` after reviewing the Pi 0.79.10 changelog, extension compaction events, provider/package docs, and release workflow.
|
|
16
|
+
|
|
17
|
+
### Fixed
|
|
18
|
+
|
|
19
|
+
- Refresh the test event harness for Pi 0.79.10's required `session_before_compact` and `session_compact` `reason` / `willRetry` metadata.
|
|
20
|
+
|
|
5
21
|
## 0.1.46 - 2026-06-21
|
|
6
22
|
|
|
7
23
|
### Changed
|
package/README.md
CHANGED
|
@@ -51,10 +51,10 @@ If pi started without a key, run `/cursor-refresh-models` after `/login` to refr
|
|
|
51
51
|
## Requirements
|
|
52
52
|
|
|
53
53
|
- Node.js 22.19+
|
|
54
|
-
- pi 0.79.
|
|
54
|
+
- pi 0.79.10 or newer recommended; pi core peer metadata is intentionally unpinned so newer pi releases are not blocked
|
|
55
55
|
- a Cursor SDK API key saved through `/login`, available as `CURSOR_API_KEY`, or passed with pi's `--api-key`
|
|
56
56
|
|
|
57
|
-
No global `@cursor/sdk` install is required. This package depends on exact `@cursor/sdk@1.0.19`, so normal package installation brings in the SDK version this extension was built and tested against. It also declares `@connectrpc/connect-node@1.7.0`
|
|
57
|
+
No global `@cursor/sdk` install is required. This package depends on exact `@cursor/sdk@1.0.19`, so normal package installation brings in the SDK version this extension was built and tested against. It also declares and bundles `@connectrpc/connect-node@1.7.0` with `undici@7.28.0` because Cursor SDK 1.0.19 still dynamically loads the Node ConnectRPC transport during local-agent runs, and npm dependency consumers do not inherit this package's root-only `overrides`. Cursor SDK 1.0.19 removes the older `sqlite3 -> node-gyp@8` dependency chain, so deprecated install warnings for `inflight`, `rimraf`, `glob@7`, `npmlog`, `gauge`, `are-we-there-yet`, and `tar@6` from that chain are no longer expected. This package follows pi package guidance by declaring pi core package peers with `"*"` ranges, so users who update pi before this extension is republished are not blocked by peer metadata. The current recommended and validated pi baseline is 0.79.10 plus Cursor SDK 1.0.19; older pi compatibility paths are best-effort and older Cursor SDK compatibility paths are not maintained.
|
|
58
58
|
|
|
59
59
|
## Install
|
|
60
60
|
|
|
@@ -67,8 +67,8 @@ The replay scan flags only error `toolResult` / error assistant messages with `T
|
|
|
67
67
|
|
|
68
68
|
Pass criteria:
|
|
69
69
|
|
|
70
|
-
- `pi --version` reports pi 0.79.
|
|
71
|
-
- `npm ls` shows `@cursor/sdk@1.0.19` and local `@earendil-works/*@0.79.
|
|
70
|
+
- `pi --version` reports pi 0.79.10 for this cutover baseline.
|
|
71
|
+
- `npm ls` shows `@cursor/sdk@1.0.19` and local `@earendil-works/*@0.79.10` packages.
|
|
72
72
|
- `cursor/composer-2-5` appears in the model list.
|
|
73
73
|
- No Cursor key or auth token is printed.
|
|
74
74
|
- If neither `~/.pi/agent/auth.json` cursor auth nor `CURSOR_API_KEY` is available, stop and report the live smoke as blocked.
|
|
@@ -125,7 +125,7 @@ Observe with `tmux capture-pane -pt "$SESSION"` or attach manually.
|
|
|
125
125
|
Pass criteria:
|
|
126
126
|
|
|
127
127
|
- Footer shows `(cursor) composer-2-5`. With `--cursor-no-fast`, Cursor fast mode is off and the Cursor extension status should not show `cursor fast`; ignore unrelated status text from other extensions.
|
|
128
|
-
- The run uses pi 0.79.
|
|
128
|
+
- The run uses pi 0.79.10 `--session-id` successfully.
|
|
129
129
|
- Assistant answer appears correctly.
|
|
130
130
|
- `/session` shows one user and one assistant message for the simple run.
|
|
131
131
|
- Persisted JSONL has one assistant message. If the screen appears duplicated, inspect JSONL before deciding whether it is a rendering bug.
|
|
@@ -133,7 +133,7 @@ Pass criteria:
|
|
|
133
133
|
|
|
134
134
|
## 4. Focused visual card/color rendering check
|
|
135
135
|
|
|
136
|
-
This is the canonical inner-loop visual debug path for Cursor provider/runtime changes. It requires offscreen TUI visual inspection, not only JSONL or code review. Use pi 0.79.
|
|
136
|
+
This is the canonical inner-loop visual debug path for Cursor provider/runtime changes. It requires offscreen TUI visual inspection, not only JSONL or code review. Use pi 0.79.10, `@cursor/sdk@1.0.19`, a fresh temporary session dir, Cursor SDK `plan` mode, native replay enabled, and the checked-in visual runner. The runner resolves `pi` by directly walking the parent `PATH`, uses `process.execPath` for Node, and prepends that Node directory for both prereq checks and tmux launches so `#!/usr/bin/env node` shims use the validated Node. The default matrix is native replay only: native replay registration is forced on, settings sources are `none`, the pi bridge is off, overlapping built-in pi tools are not exposed, and inherited Cursor SDK event-debug artifact env is cleared. With `--event-debug`, debug capture writes to a deterministic directory under `VISUAL_DIR`.
|
|
137
137
|
|
|
138
138
|
```bash
|
|
139
139
|
VISUAL_DIR="$(mktemp -d /tmp/pi-cursor-sdk-1016-visual.XXXXXX)"
|
|
@@ -15,7 +15,7 @@ Current implementation notes:
|
|
|
15
15
|
- Cursor status uses one coordinated `ctx.ui.setStatus("cursor", ...)` value for fast and non-default plan mode; the default pi footer remains intact.
|
|
16
16
|
- Installed `@cursor/sdk` user messages accept images, and Cursor models are treated as image-capable; registered input metadata is `text` plus `image`.
|
|
17
17
|
- Image payload forwarding sends images only from the latest user message. If the latest user turn is plain text after an earlier image turn, the transcript keeps an `[image omitted from transcript]` placeholder but no image bytes are sent to Cursor. The prompt explicitly tells Cursor that prior image bytes are unavailable and to ask the user to reattach or describe a prior image when needed. Carrying images forward across turns remains a future product decision because it affects token cost, privacy, stale visual context, and expected multimodal follow-up behavior.
|
|
18
|
-
- Exact `@cursor/sdk@1.0.19` is a package dependency of this extension; users should not need a global SDK install. pi 0.79.
|
|
18
|
+
- Exact `@cursor/sdk@1.0.19` is a package dependency of this extension; users should not need a global SDK install. pi 0.79.10 is the current recommended validation baseline, while published pi core peer dependencies use `"*"` ranges per current pi package guidance. Newer pi versions are allowed to attempt loading this extension before a matching extension release exists; compatibility is best-effort until validated.
|
|
19
19
|
- Cursor auth uses pi-native API-key resolution for provider `cursor`: CLI `--api-key`, stored `~/.pi/agent/auth.json` API key from `/login`, then `CURSOR_API_KEY`. The extension config file stores only non-secret Cursor-only state such as fast defaults.
|
|
20
20
|
- Local agents pass `settingSources: ["all"]` by default so Cursor MCP servers, plugin tools, project/user settings, and related Cursor-native capabilities are available. Users can narrow loading with a comma-separated list such as `PI_CURSOR_SETTING_SOURCES=project,user,plugins`, or disable ambient setting sources with `PI_CURSOR_SETTING_SOURCES=none`. The provider suppresses direct Cursor SDK bootstrap stdout/stderr/console noise (including late first-send workspace loading such as hook compatibility warnings) so it does not pollute pi's TUI.
|
|
21
21
|
- On `cursor/*` models, pi-cursor-sdk removes only pi-generated `<project_instructions>` blocks that overlap the effective Cursor `settingSources`: `user` for `~/.pi/agent/AGENTS.md`; `project` for discovered repo/parent `AGENTS.md` and `CLAUDE.md` (verified Cursor behavior: local agents load project `AGENTS.md` and `CLAUDE.md`). `~/.pi/agent/CLAUDE.md` is not removed (Cursor user layer uses `~/.claude/CLAUDE.md`). Blocks are removed by exact pi serialization match from structured `contextFiles` via the `before_agent_start` hook, not in `buildCursorPrompt` sanitization. Suppression is skipped with `-nc`, `PI_CURSOR_SETTING_SOURCES=none`, narrowed sources such as `plugins` that omit the matching layer, or `PI_CURSOR_PRESERVE_PI_AGENTS_MD=1`. Switching away from a Cursor model restores pi's full context block on the next user message.
|
|
@@ -6,7 +6,7 @@ This workflow is the canonical repo path for verifying Cursor SDK tool replay th
|
|
|
6
6
|
|
|
7
7
|
Use it before accepting replay-card commits or PRs, and for every Cursor provider/runtime release where TUI card/color behavior could regress. Text logs and JSONL are necessary, but they are not enough when the claim is visual parity: always keep PNGs for the exact prompt, and keep before/after PNGs when reviewing a rendering change.
|
|
8
8
|
|
|
9
|
-
Current validation baseline: pi 0.79.
|
|
9
|
+
Current validation baseline: pi 0.79.10, exact `@cursor/sdk@1.0.19`, local validation packages `@earendil-works/pi-ai`, `@earendil-works/pi-coding-agent`, and `@earendil-works/pi-tui` at 0.79.10. Published pi core peer dependencies use `"*"` ranges per current pi package guidance, so newer pi installs can try the extension before a matching validation release exists.
|
|
10
10
|
|
|
11
11
|
## Cursor SDK 1.0.17 / pi 0.79.0 cutover visual record
|
|
12
12
|
|
|
@@ -243,7 +243,7 @@ The script writes timestamped artifacts under `--out` (default `/tmp/pi-cursor-s
|
|
|
243
243
|
|
|
244
244
|
Stdout prints artifact paths and summary counts only. Raw payloads stay on disk and may contain local paths, project text, tool args/results, or secrets — do not commit or share them.
|
|
245
245
|
|
|
246
|
-
Hard repo rule: Cursor SDK behavior claims must come from the installed `@cursor/sdk` package and/or https://cursor.com/docs/sdk/typescript, not from memory or ad-hoc probes alone. Current cutover validation targets exact `@cursor/sdk@1.0.19` and pi 0.79.
|
|
246
|
+
Hard repo rule: Cursor SDK behavior claims must come from the installed `@cursor/sdk` package and/or https://cursor.com/docs/sdk/typescript, not from memory or ad-hoc probes alone. Current cutover validation targets exact `@cursor/sdk@1.0.19` and pi 0.79.10 local packages.
|
|
247
247
|
|
|
248
248
|
## Pi provider SDK event capture
|
|
249
249
|
|
|
@@ -0,0 +1,141 @@
|
|
|
1
|
+
# @connectrpc/connect-node
|
|
2
|
+
|
|
3
|
+
Connect is a family of libraries for building and consuming APIs on different languages and platforms, and
|
|
4
|
+
[@connectrpc/connect](https://www.npmjs.com/package/@connectrpc/connect) brings type-safe APIs with Protobuf to
|
|
5
|
+
TypeScript.
|
|
6
|
+
|
|
7
|
+
`@connectrpc/connect-node` provides the following adapters for Node.js:
|
|
8
|
+
|
|
9
|
+
### createConnectTransport()
|
|
10
|
+
|
|
11
|
+
Lets your clients running on Node.js talk to a server with the Connect protocol:
|
|
12
|
+
|
|
13
|
+
```diff
|
|
14
|
+
import { createClient } from "@connectrpc/connect";
|
|
15
|
+
+ import { createConnectTransport } from "@connectrpc/connect-node";
|
|
16
|
+
import { ElizaService } from "./gen/eliza_connect.js";
|
|
17
|
+
|
|
18
|
+
+ // A transport for clients using the Connect protocol with Node.js `http` module
|
|
19
|
+
+ const transport = createConnectTransport({
|
|
20
|
+
+ baseUrl: "https://demo.connectrpc.com",
|
|
21
|
+
+ httpVersion: "1.1"
|
|
22
|
+
+ });
|
|
23
|
+
|
|
24
|
+
const client = createClient(ElizaService, transport);
|
|
25
|
+
const { sentence } = await client.say({ sentence: "I feel happy." });
|
|
26
|
+
console.log(sentence) // you said: I feel happy.
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
### createGrpcTransport()
|
|
30
|
+
|
|
31
|
+
Lets your clients running on Node.js talk to a server with the gRPC protocol:
|
|
32
|
+
|
|
33
|
+
```diff
|
|
34
|
+
import { createClient } from "@connectrpc/connect";
|
|
35
|
+
+ import { createGrpcTransport } from "@connectrpc/connect-node";
|
|
36
|
+
import { ElizaService } from "./gen/eliza_connect.js";
|
|
37
|
+
|
|
38
|
+
+ // A transport for clients using the gRPC protocol with Node.js `http2` module
|
|
39
|
+
+ const transport = createGrpcTransport({
|
|
40
|
+
+ baseUrl: "https://demo.connectrpc.com",
|
|
41
|
+
+ httpVersion: "2"
|
|
42
|
+
+ });
|
|
43
|
+
|
|
44
|
+
const client = createClient(ElizaService, transport);
|
|
45
|
+
const { sentence } = await client.say({ sentence: "I feel happy." });
|
|
46
|
+
console.log(sentence) // you said: I feel happy.
|
|
47
|
+
```
|
|
48
|
+
|
|
49
|
+
### createGrpcWebTransport()
|
|
50
|
+
|
|
51
|
+
Lets your clients running on Node.js talk to a server with the gRPC-web protocol:
|
|
52
|
+
|
|
53
|
+
```diff
|
|
54
|
+
import { createClient } from "@connectrpc/connect";
|
|
55
|
+
+ import { createGrpcWebTransport } from "@connectrpc/connect-node";
|
|
56
|
+
import { ElizaService } from "./gen/eliza_connect.js";
|
|
57
|
+
|
|
58
|
+
+ // A transport for clients using the Connect protocol with Node.js `http` module
|
|
59
|
+
+ const transport = createGrpcWebTransport({
|
|
60
|
+
+ baseUrl: "https://demo.connectrpc.com",
|
|
61
|
+
+ httpVersion: "1.1"
|
|
62
|
+
+ });
|
|
63
|
+
|
|
64
|
+
const client = createClient(ElizaService, transport);
|
|
65
|
+
const { sentence } = await client.say({ sentence: "I feel happy." });
|
|
66
|
+
console.log(sentence) // you said: I feel happy.
|
|
67
|
+
```
|
|
68
|
+
|
|
69
|
+
### connectNodeAdapter()
|
|
70
|
+
|
|
71
|
+
Run your Connect RPCs on the Node.js `http`, `https`, or `http2` modules.
|
|
72
|
+
|
|
73
|
+
```ts
|
|
74
|
+
// connect.ts
|
|
75
|
+
import { ConnectRouter } from "@connectrpc/connect";
|
|
76
|
+
|
|
77
|
+
export default function (router: ConnectRouter) {
|
|
78
|
+
// implement rpc Say(SayRequest) returns (SayResponse)
|
|
79
|
+
router.rpc(ElizaService, ElizaService.methods.say, async (req) => ({
|
|
80
|
+
sentence: `you said: ${req.sentence}`,
|
|
81
|
+
}));
|
|
82
|
+
}
|
|
83
|
+
```
|
|
84
|
+
|
|
85
|
+
```diff
|
|
86
|
+
// server.ts
|
|
87
|
+
import * as http2 from "http2";
|
|
88
|
+
+ import routes from "connect";
|
|
89
|
+
+ import { connectNodeAdapter } from "@connectrpc/connect-node";
|
|
90
|
+
|
|
91
|
+
http2.createServer(
|
|
92
|
+
+ connectNodeAdapter({ routes }) // responds with 404 for other requests
|
|
93
|
+
).listen(8080);
|
|
94
|
+
```
|
|
95
|
+
|
|
96
|
+
With that server running, you can make requests with any gRPC, gRPC-Web, or Connect client.
|
|
97
|
+
|
|
98
|
+
`buf curl` with the gRPC protocol:
|
|
99
|
+
|
|
100
|
+
```bash
|
|
101
|
+
buf curl --schema buf.build/connectrpc/eliza \
|
|
102
|
+
--protocol grpc --http2-prior-knowledge \
|
|
103
|
+
-d '{"sentence": "I feel happy."}' \
|
|
104
|
+
http://localhost:8080/connectrpc.eliza.v1.ElizaService/Say
|
|
105
|
+
```
|
|
106
|
+
|
|
107
|
+
`curl` with the Connect protocol:
|
|
108
|
+
|
|
109
|
+
```bash
|
|
110
|
+
curl \
|
|
111
|
+
--header "Content-Type: application/json" \
|
|
112
|
+
--data '{"sentence": "I feel happy."}' \
|
|
113
|
+
--http2-prior-knowledge \
|
|
114
|
+
http://localhost:8080/connectrpc.eliza.v1.ElizaService/Say
|
|
115
|
+
```
|
|
116
|
+
|
|
117
|
+
Node.js with the gRPC protocol:
|
|
118
|
+
|
|
119
|
+
```ts
|
|
120
|
+
import { createClient } from "@connectrpc/connect";
|
|
121
|
+
import { createGrpcTransport } from "@connectrpc/connect-node";
|
|
122
|
+
import { ElizaService } from "./gen/eliza_connect.js";
|
|
123
|
+
|
|
124
|
+
const transport = createGrpcTransport({
|
|
125
|
+
baseUrl: "http://localhost:8080",
|
|
126
|
+
httpVersion: "2",
|
|
127
|
+
});
|
|
128
|
+
|
|
129
|
+
const client = createClient(ElizaService, transport);
|
|
130
|
+
const { sentence } = await client.say({ sentence: "I feel happy." });
|
|
131
|
+
console.log(sentence); // you said: I feel happy.
|
|
132
|
+
```
|
|
133
|
+
|
|
134
|
+
A client for the web browser actually looks identical to this example - it would
|
|
135
|
+
simply use `createConnectTransport` from [@connectrpc/connect-web](https://www.npmjs.com/package/@connectrpc/connect-web)
|
|
136
|
+
instead.
|
|
137
|
+
|
|
138
|
+
## Getting started
|
|
139
|
+
|
|
140
|
+
To get started with Connect, head over to the [docs](https://connectrpc.com/docs/node/getting-started)
|
|
141
|
+
for a tutorial, or take a look at [our example](https://github.com/connectrpc/connect-es/tree/main/packages/example).
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
import type { Compression } from "@connectrpc/connect/protocol";
|
|
2
|
+
/**
|
|
3
|
+
* The gzip compression algorithm, implemented with the Node.js built-in module
|
|
4
|
+
* zlib. This value can be used for the `sendCompression` and `acceptCompression`
|
|
5
|
+
* option of client transports, or for the `acceptCompression` option of server
|
|
6
|
+
* plugins like `fastifyConnectPlugin` from @connectrpc/connect-fastify.
|
|
7
|
+
*/
|
|
8
|
+
export declare const compressionGzip: Compression;
|
|
9
|
+
/**
|
|
10
|
+
* The brotli compression algorithm, implemented with the Node.js built-in module
|
|
11
|
+
* zlib. This value can be used for the `sendCompression` and `acceptCompression`
|
|
12
|
+
* option of client transports, or for the `acceptCompression` option of server
|
|
13
|
+
* plugins like `fastifyConnectPlugin` from @connectrpc/connect-fastify.
|
|
14
|
+
*/
|
|
15
|
+
export declare const compressionBrotli: Compression;
|
|
@@ -0,0 +1,89 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
// Copyright 2021-2024 The Connect Authors
|
|
3
|
+
//
|
|
4
|
+
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
5
|
+
// you may not use this file except in compliance with the License.
|
|
6
|
+
// You may obtain a copy of the License at
|
|
7
|
+
//
|
|
8
|
+
// http://www.apache.org/licenses/LICENSE-2.0
|
|
9
|
+
//
|
|
10
|
+
// Unless required by applicable law or agreed to in writing, software
|
|
11
|
+
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
12
|
+
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
13
|
+
// See the License for the specific language governing permissions and
|
|
14
|
+
// limitations under the License.
|
|
15
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
16
|
+
exports.compressionBrotli = exports.compressionGzip = void 0;
|
|
17
|
+
const zlib = require("zlib");
|
|
18
|
+
const util_1 = require("util");
|
|
19
|
+
const connect_1 = require("@connectrpc/connect");
|
|
20
|
+
const node_error_js_1 = require("./node-error.js");
|
|
21
|
+
const gzip = (0, util_1.promisify)(zlib.gzip);
|
|
22
|
+
const gunzip = (0, util_1.promisify)(zlib.gunzip);
|
|
23
|
+
const brotliCompress = (0, util_1.promisify)(zlib.brotliCompress);
|
|
24
|
+
const brotliDecompress = (0, util_1.promisify)(zlib.brotliDecompress);
|
|
25
|
+
/**
|
|
26
|
+
* The gzip compression algorithm, implemented with the Node.js built-in module
|
|
27
|
+
* zlib. This value can be used for the `sendCompression` and `acceptCompression`
|
|
28
|
+
* option of client transports, or for the `acceptCompression` option of server
|
|
29
|
+
* plugins like `fastifyConnectPlugin` from @connectrpc/connect-fastify.
|
|
30
|
+
*/
|
|
31
|
+
exports.compressionGzip = {
|
|
32
|
+
name: "gzip",
|
|
33
|
+
compress(bytes) {
|
|
34
|
+
return gzip(bytes, {});
|
|
35
|
+
},
|
|
36
|
+
decompress(bytes, readMaxBytes) {
|
|
37
|
+
if (bytes.length == 0) {
|
|
38
|
+
return Promise.resolve(new Uint8Array(0));
|
|
39
|
+
}
|
|
40
|
+
return wrapZLibErrors(gunzip(bytes, {
|
|
41
|
+
maxOutputLength: readMaxBytes,
|
|
42
|
+
}), readMaxBytes);
|
|
43
|
+
},
|
|
44
|
+
};
|
|
45
|
+
/**
|
|
46
|
+
* The brotli compression algorithm, implemented with the Node.js built-in module
|
|
47
|
+
* zlib. This value can be used for the `sendCompression` and `acceptCompression`
|
|
48
|
+
* option of client transports, or for the `acceptCompression` option of server
|
|
49
|
+
* plugins like `fastifyConnectPlugin` from @connectrpc/connect-fastify.
|
|
50
|
+
*/
|
|
51
|
+
exports.compressionBrotli = {
|
|
52
|
+
name: "br",
|
|
53
|
+
compress(bytes) {
|
|
54
|
+
return brotliCompress(bytes, {});
|
|
55
|
+
},
|
|
56
|
+
decompress(bytes, readMaxBytes) {
|
|
57
|
+
if (bytes.length == 0) {
|
|
58
|
+
return Promise.resolve(new Uint8Array(0));
|
|
59
|
+
}
|
|
60
|
+
return wrapZLibErrors(brotliDecompress(bytes, {
|
|
61
|
+
maxOutputLength: readMaxBytes,
|
|
62
|
+
}), readMaxBytes);
|
|
63
|
+
},
|
|
64
|
+
};
|
|
65
|
+
function wrapZLibErrors(promise, readMaxBytes) {
|
|
66
|
+
return promise.catch((e) => {
|
|
67
|
+
const props = (0, node_error_js_1.getNodeErrorProps)(e);
|
|
68
|
+
let code = connect_1.Code.Internal;
|
|
69
|
+
let message = "decompression failed";
|
|
70
|
+
// eslint-disable-next-line @typescript-eslint/switch-exhaustiveness-check
|
|
71
|
+
switch (props.code) {
|
|
72
|
+
case "ERR_BUFFER_TOO_LARGE":
|
|
73
|
+
code = connect_1.Code.ResourceExhausted;
|
|
74
|
+
message = `message is larger than configured readMaxBytes ${readMaxBytes} after decompression`;
|
|
75
|
+
break;
|
|
76
|
+
case "Z_DATA_ERROR":
|
|
77
|
+
case "ERR_PADDING_2":
|
|
78
|
+
code = connect_1.Code.InvalidArgument;
|
|
79
|
+
break;
|
|
80
|
+
default:
|
|
81
|
+
if (props.code !== undefined &&
|
|
82
|
+
props.code.startsWith("ERR__ERROR_FORMAT_")) {
|
|
83
|
+
code = connect_1.Code.InvalidArgument;
|
|
84
|
+
}
|
|
85
|
+
break;
|
|
86
|
+
}
|
|
87
|
+
return Promise.reject(new connect_1.ConnectError(message, code, undefined, undefined, e));
|
|
88
|
+
});
|
|
89
|
+
}
|
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
import type { ConnectRouter, ConnectRouterOptions, ContextValues } from "@connectrpc/connect";
|
|
2
|
+
import type { NodeHandlerFn, NodeServerRequest } from "./node-universal-handler.js";
|
|
3
|
+
export interface ConnectNodeAdapterOptions extends ConnectRouterOptions {
|
|
4
|
+
/**
|
|
5
|
+
* Route definitions. We recommend the following pattern:
|
|
6
|
+
*
|
|
7
|
+
* Create a file `connect.ts` with a default export such as this:
|
|
8
|
+
*
|
|
9
|
+
* ```ts
|
|
10
|
+
* import {ConnectRouter} from "@connectrpc/connect";
|
|
11
|
+
*
|
|
12
|
+
* export default (router: ConnectRouter) => {
|
|
13
|
+
* router.service(ElizaService, {});
|
|
14
|
+
* }
|
|
15
|
+
* ```
|
|
16
|
+
*
|
|
17
|
+
* Then pass this function here.
|
|
18
|
+
*/
|
|
19
|
+
routes: (router: ConnectRouter) => void;
|
|
20
|
+
/**
|
|
21
|
+
* If none of the handler request paths match, a 404 is served. This option
|
|
22
|
+
* can provide a custom fallback for this case.
|
|
23
|
+
*/
|
|
24
|
+
fallback?: NodeHandlerFn;
|
|
25
|
+
/**
|
|
26
|
+
* Serve all handlers under this prefix. For example, the prefix "/something"
|
|
27
|
+
* will serve the RPC foo.FooService/Bar under "/something/foo.FooService/Bar".
|
|
28
|
+
* Note that many gRPC client implementations do not allow for prefixes.
|
|
29
|
+
*/
|
|
30
|
+
requestPathPrefix?: string;
|
|
31
|
+
/**
|
|
32
|
+
* Context values to extract from the request. These values are passed to
|
|
33
|
+
* the handlers.
|
|
34
|
+
*/
|
|
35
|
+
contextValues?: (req: NodeServerRequest) => ContextValues;
|
|
36
|
+
}
|
|
37
|
+
/**
|
|
38
|
+
* Create a Node.js request handler from a ConnectRouter.
|
|
39
|
+
*
|
|
40
|
+
* The returned function is compatible with http.RequestListener and its equivalent for http2.
|
|
41
|
+
*/
|
|
42
|
+
export declare function connectNodeAdapter(options: ConnectNodeAdapterOptions): NodeHandlerFn;
|
|
@@ -0,0 +1,61 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
// Copyright 2021-2024 The Connect Authors
|
|
3
|
+
//
|
|
4
|
+
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
5
|
+
// you may not use this file except in compliance with the License.
|
|
6
|
+
// You may obtain a copy of the License at
|
|
7
|
+
//
|
|
8
|
+
// http://www.apache.org/licenses/LICENSE-2.0
|
|
9
|
+
//
|
|
10
|
+
// Unless required by applicable law or agreed to in writing, software
|
|
11
|
+
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
12
|
+
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
13
|
+
// See the License for the specific language governing permissions and
|
|
14
|
+
// limitations under the License.
|
|
15
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
16
|
+
exports.connectNodeAdapter = connectNodeAdapter;
|
|
17
|
+
const connect_1 = require("@connectrpc/connect");
|
|
18
|
+
const protocol_1 = require("@connectrpc/connect/protocol");
|
|
19
|
+
const node_universal_handler_js_1 = require("./node-universal-handler.js");
|
|
20
|
+
const compression_js_1 = require("./compression.js");
|
|
21
|
+
/**
|
|
22
|
+
* Create a Node.js request handler from a ConnectRouter.
|
|
23
|
+
*
|
|
24
|
+
* The returned function is compatible with http.RequestListener and its equivalent for http2.
|
|
25
|
+
*/
|
|
26
|
+
function connectNodeAdapter(options) {
|
|
27
|
+
var _a;
|
|
28
|
+
if (options.acceptCompression === undefined) {
|
|
29
|
+
options.acceptCompression = [compression_js_1.compressionGzip, compression_js_1.compressionBrotli];
|
|
30
|
+
}
|
|
31
|
+
const router = (0, connect_1.createConnectRouter)(options);
|
|
32
|
+
options.routes(router);
|
|
33
|
+
const prefix = (_a = options.requestPathPrefix) !== null && _a !== void 0 ? _a : "";
|
|
34
|
+
const paths = new Map();
|
|
35
|
+
for (const uHandler of router.handlers) {
|
|
36
|
+
paths.set(prefix + uHandler.requestPath, uHandler);
|
|
37
|
+
}
|
|
38
|
+
return function nodeRequestHandler(req, res) {
|
|
39
|
+
var _a, _b, _c, _d;
|
|
40
|
+
// Strip the query parameter when matching paths.
|
|
41
|
+
const uHandler = paths.get((_b = (_a = req.url) === null || _a === void 0 ? void 0 : _a.split("?", 2)[0]) !== null && _b !== void 0 ? _b : "");
|
|
42
|
+
if (!uHandler) {
|
|
43
|
+
((_c = options.fallback) !== null && _c !== void 0 ? _c : fallback)(req, res);
|
|
44
|
+
return;
|
|
45
|
+
}
|
|
46
|
+
const uReq = (0, node_universal_handler_js_1.universalRequestFromNodeRequest)(req, res, undefined, (_d = options.contextValues) === null || _d === void 0 ? void 0 : _d.call(options, req));
|
|
47
|
+
uHandler(uReq)
|
|
48
|
+
.then((uRes) => (0, node_universal_handler_js_1.universalResponseToNodeResponse)(uRes, res))
|
|
49
|
+
.catch((reason) => {
|
|
50
|
+
if (connect_1.ConnectError.from(reason).code == connect_1.Code.Aborted) {
|
|
51
|
+
return;
|
|
52
|
+
}
|
|
53
|
+
// eslint-disable-next-line no-console
|
|
54
|
+
console.error(`handler for rpc ${uHandler.method.name} of ${uHandler.service.typeName} failed`, reason);
|
|
55
|
+
});
|
|
56
|
+
};
|
|
57
|
+
}
|
|
58
|
+
const fallback = (request, response) => {
|
|
59
|
+
response.writeHead(protocol_1.uResponseNotFound.status);
|
|
60
|
+
response.end();
|
|
61
|
+
};
|
|
@@ -0,0 +1,100 @@
|
|
|
1
|
+
import type { BinaryReadOptions, BinaryWriteOptions, JsonReadOptions, JsonWriteOptions } from "@bufbuild/protobuf";
|
|
2
|
+
import type { Interceptor, Transport } from "@connectrpc/connect";
|
|
3
|
+
import type { Compression } from "@connectrpc/connect/protocol";
|
|
4
|
+
import type { NodeTransportOptions } from "./node-transport-options.js";
|
|
5
|
+
/**
|
|
6
|
+
* Options used to configure the Connect transport.
|
|
7
|
+
*
|
|
8
|
+
* See createConnectTransport().
|
|
9
|
+
*/
|
|
10
|
+
export type ConnectTransportOptions = NodeTransportOptions & {
|
|
11
|
+
/**
|
|
12
|
+
* Base URI for all HTTP requests.
|
|
13
|
+
*
|
|
14
|
+
* Requests will be made to <baseUrl>/<package>.<service>/method
|
|
15
|
+
*
|
|
16
|
+
* Example: `baseUrl: "https://example.com/my-api"`
|
|
17
|
+
*
|
|
18
|
+
* This will make a `POST /my-api/my_package.MyService/Foo` to
|
|
19
|
+
* `example.com` via HTTPS.
|
|
20
|
+
*/
|
|
21
|
+
baseUrl: string;
|
|
22
|
+
/**
|
|
23
|
+
* By default, connect-node clients use the binary format.
|
|
24
|
+
*/
|
|
25
|
+
useBinaryFormat?: boolean;
|
|
26
|
+
/**
|
|
27
|
+
* Interceptors that should be applied to all calls running through
|
|
28
|
+
* this transport. See the Interceptor type for details.
|
|
29
|
+
*/
|
|
30
|
+
interceptors?: Interceptor[];
|
|
31
|
+
/**
|
|
32
|
+
* Options for the JSON format.
|
|
33
|
+
* By default, unknown fields are ignored.
|
|
34
|
+
*/
|
|
35
|
+
jsonOptions?: Partial<JsonReadOptions & JsonWriteOptions>;
|
|
36
|
+
/**
|
|
37
|
+
* Options for the binary wire format.
|
|
38
|
+
*/
|
|
39
|
+
binaryOptions?: Partial<BinaryReadOptions & BinaryWriteOptions>;
|
|
40
|
+
/**
|
|
41
|
+
* Compression algorithms available to a client. Clients ask servers to
|
|
42
|
+
* compress responses using any of the registered algorithms. The first
|
|
43
|
+
* registered algorithm is the most preferred.
|
|
44
|
+
*
|
|
45
|
+
* It is safe to use this option liberally: servers will ignore any
|
|
46
|
+
* compression algorithms they don't support. To compress requests, pair this
|
|
47
|
+
* option with `sendCompression`.
|
|
48
|
+
*
|
|
49
|
+
* If this option is not provided, the compression algorithms "gzip" and "br"
|
|
50
|
+
* (Brotli) are accepted. To opt out of response compression, pass an
|
|
51
|
+
* empty array.
|
|
52
|
+
*/
|
|
53
|
+
acceptCompression?: Compression[];
|
|
54
|
+
/**
|
|
55
|
+
* Configures the client to use the specified algorithm to compress request
|
|
56
|
+
* messages.
|
|
57
|
+
*
|
|
58
|
+
* Because some servers don't support compression, clients default to sending
|
|
59
|
+
* uncompressed requests.
|
|
60
|
+
*/
|
|
61
|
+
sendCompression?: Compression;
|
|
62
|
+
/**
|
|
63
|
+
* Sets a minimum size threshold for compression: Messages that are smaller
|
|
64
|
+
* than the configured minimum are sent uncompressed.
|
|
65
|
+
*
|
|
66
|
+
* The default value is 1 kibibyte, because the CPU cost of compressing very
|
|
67
|
+
* small messages usually isn't worth the small reduction in network I/O.
|
|
68
|
+
*/
|
|
69
|
+
compressMinBytes?: number;
|
|
70
|
+
/**
|
|
71
|
+
* Limits the performance impact of pathologically large messages sent by the
|
|
72
|
+
* server. Limits apply to each individual message, not to the stream as a
|
|
73
|
+
* whole.
|
|
74
|
+
*
|
|
75
|
+
* The default limit is the maximum supported value of ~4GiB.
|
|
76
|
+
*/
|
|
77
|
+
readMaxBytes?: number;
|
|
78
|
+
/**
|
|
79
|
+
* Prevents sending messages too large for the server to handle.
|
|
80
|
+
*
|
|
81
|
+
* The default limit is the maximum supported value of ~4GiB.
|
|
82
|
+
*/
|
|
83
|
+
writeMaxBytes?: number;
|
|
84
|
+
/**
|
|
85
|
+
* Controls whether or not Connect GET requests should be used when
|
|
86
|
+
* available, on side-effect free methods. Defaults to false.
|
|
87
|
+
*/
|
|
88
|
+
useHttpGet?: boolean;
|
|
89
|
+
/**
|
|
90
|
+
* The timeout in milliseconds to apply to all requests.
|
|
91
|
+
*
|
|
92
|
+
* This can be overridden on a per-request basis by passing a timeoutMs.
|
|
93
|
+
*/
|
|
94
|
+
defaultTimeoutMs?: number;
|
|
95
|
+
};
|
|
96
|
+
/**
|
|
97
|
+
* Create a Transport for the Connect protocol using the Node.js `http`, `http2`,
|
|
98
|
+
* or `http2` module.
|
|
99
|
+
*/
|
|
100
|
+
export declare function createConnectTransport(options: ConnectTransportOptions): Transport;
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
// Copyright 2021-2024 The Connect Authors
|
|
3
|
+
//
|
|
4
|
+
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
5
|
+
// you may not use this file except in compliance with the License.
|
|
6
|
+
// You may obtain a copy of the License at
|
|
7
|
+
//
|
|
8
|
+
// http://www.apache.org/licenses/LICENSE-2.0
|
|
9
|
+
//
|
|
10
|
+
// Unless required by applicable law or agreed to in writing, software
|
|
11
|
+
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
12
|
+
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
13
|
+
// See the License for the specific language governing permissions and
|
|
14
|
+
// limitations under the License.
|
|
15
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
16
|
+
exports.createConnectTransport = createConnectTransport;
|
|
17
|
+
const protocol_connect_1 = require("@connectrpc/connect/protocol-connect");
|
|
18
|
+
const node_transport_options_js_1 = require("./node-transport-options.js");
|
|
19
|
+
/**
|
|
20
|
+
* Create a Transport for the Connect protocol using the Node.js `http`, `http2`,
|
|
21
|
+
* or `http2` module.
|
|
22
|
+
*/
|
|
23
|
+
function createConnectTransport(options) {
|
|
24
|
+
return (0, protocol_connect_1.createTransport)((0, node_transport_options_js_1.validateNodeTransportOptions)(options));
|
|
25
|
+
}
|