pi-cursor-sdk 0.1.47 → 0.1.49
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 +17 -0
- package/README.md +2 -2
- 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 +161 -156
- package/src/context.ts +1 -1
- package/src/cursor-context-tools.ts +1 -1
- package/src/cursor-live-run-accounting.ts +1 -1
- package/src/cursor-live-run-coordinator.ts +1 -1
- package/src/cursor-native-replay-routing.ts +1 -1
- package/src/cursor-partial-content-emitter.ts +1 -1
- package/src/cursor-pi-tool-bridge-mcp.ts +1 -1
- package/src/cursor-pi-tool-bridge-run.ts +1 -1
- package/src/cursor-pi-tool-bridge-types.ts +1 -1
- package/src/cursor-provider-lazy.ts +1 -1
- package/src/cursor-provider-live-run-drain.ts +1 -1
- package/src/cursor-provider-run-finalizer.ts +1 -1
- package/src/cursor-provider-turn-coordinator.ts +1 -1
- package/src/cursor-provider-turn-lifecycle-emitter.ts +1 -1
- package/src/cursor-provider-turn-prepare.ts +1 -1
- package/src/cursor-provider-turn-types.ts +1 -1
- package/src/cursor-provider.ts +1 -1
- package/src/cursor-run-final-text.ts +1 -1
- package/src/cursor-sdk-event-debug.ts +1 -1
- package/src/cursor-session-agent.ts +1 -1
- package/src/cursor-session-send-policy.ts +1 -1
- package/src/cursor-usage-accounting.ts +1 -1
- package/src/model-discovery.ts +1 -1
|
@@ -0,0 +1,96 @@
|
|
|
1
|
+
import type { Interceptor, Transport } from "@connectrpc/connect";
|
|
2
|
+
import type { Compression } from "@connectrpc/connect/protocol";
|
|
3
|
+
import type { BinaryReadOptions, BinaryWriteOptions, JsonReadOptions, JsonWriteOptions } from "@bufbuild/protobuf";
|
|
4
|
+
import type { NodeTransportOptions } from "./node-transport-options.js";
|
|
5
|
+
/**
|
|
6
|
+
* Options used to configure the gRPC-web transport.
|
|
7
|
+
*
|
|
8
|
+
* See createGrpcWebTransport().
|
|
9
|
+
*/
|
|
10
|
+
export type GrpcWebTransportOptions = 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, clients use the binary format for gRPC-web, because
|
|
24
|
+
* not all gRPC-web implementations support JSON.
|
|
25
|
+
*/
|
|
26
|
+
useBinaryFormat?: boolean;
|
|
27
|
+
/**
|
|
28
|
+
* Interceptors that should be applied to all calls running through
|
|
29
|
+
* this transport. See the Interceptor type for details.
|
|
30
|
+
*/
|
|
31
|
+
interceptors?: Interceptor[];
|
|
32
|
+
/**
|
|
33
|
+
* Options for the JSON format.
|
|
34
|
+
* By default, unknown fields are ignored.
|
|
35
|
+
*/
|
|
36
|
+
jsonOptions?: Partial<JsonReadOptions & JsonWriteOptions>;
|
|
37
|
+
/**
|
|
38
|
+
* Options for the binary wire format.
|
|
39
|
+
*/
|
|
40
|
+
binaryOptions?: Partial<BinaryReadOptions & BinaryWriteOptions>;
|
|
41
|
+
/**
|
|
42
|
+
* Compression algorithms available to a client. Clients ask servers to
|
|
43
|
+
* compress responses using any of the registered algorithms. The first
|
|
44
|
+
* registered algorithm is the most preferred.
|
|
45
|
+
*
|
|
46
|
+
* It is safe to use this option liberally: servers will ignore any
|
|
47
|
+
* compression algorithms they don't support. To compress requests, pair this
|
|
48
|
+
* option with `sendCompression`.
|
|
49
|
+
*
|
|
50
|
+
* If this option is not provided, the compression algorithms "gzip" and "br"
|
|
51
|
+
* (Brotli) are accepted. To opt out of response compression, pass an
|
|
52
|
+
* empty array.
|
|
53
|
+
*/
|
|
54
|
+
acceptCompression?: Compression[];
|
|
55
|
+
/**
|
|
56
|
+
* Configures the client to use the specified algorithm to compress request
|
|
57
|
+
* messages.
|
|
58
|
+
*
|
|
59
|
+
* Because some servers don't support compression, clients default to sending
|
|
60
|
+
* uncompressed requests.
|
|
61
|
+
*/
|
|
62
|
+
sendCompression?: Compression;
|
|
63
|
+
/**
|
|
64
|
+
* Sets a minimum size threshold for compression: Messages that are smaller
|
|
65
|
+
* than the configured minimum are sent uncompressed.
|
|
66
|
+
*
|
|
67
|
+
* The default value is 1 kibibyte, because the CPU cost of compressing very
|
|
68
|
+
* small messages usually isn't worth the small reduction in network I/O.
|
|
69
|
+
*/
|
|
70
|
+
compressMinBytes?: number;
|
|
71
|
+
/**
|
|
72
|
+
* Limits the performance impact of pathologically large messages sent by the
|
|
73
|
+
* server. Limits apply to each individual message, not to the stream as a
|
|
74
|
+
* whole.
|
|
75
|
+
*
|
|
76
|
+
* The default limit is the maximum supported value of ~4GiB.
|
|
77
|
+
*/
|
|
78
|
+
readMaxBytes?: number;
|
|
79
|
+
/**
|
|
80
|
+
* Prevents sending messages too large for the server to handle.
|
|
81
|
+
*
|
|
82
|
+
* The default limit is the maximum supported value of ~4GiB.
|
|
83
|
+
*/
|
|
84
|
+
writeMaxBytes?: number;
|
|
85
|
+
/**
|
|
86
|
+
* The timeout in milliseconds to apply to all requests.
|
|
87
|
+
*
|
|
88
|
+
* This can be overridden on a per-request basis by passing a timeoutMs.
|
|
89
|
+
*/
|
|
90
|
+
defaultTimeoutMs?: number;
|
|
91
|
+
};
|
|
92
|
+
/**
|
|
93
|
+
* Create a Transport for the gRPC-web protocol using the Node.js `http`,
|
|
94
|
+
* `http2`, or `http2` module.
|
|
95
|
+
*/
|
|
96
|
+
export declare function createGrpcWebTransport(options: GrpcWebTransportOptions): 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.createGrpcWebTransport = createGrpcWebTransport;
|
|
17
|
+
const protocol_grpc_web_1 = require("@connectrpc/connect/protocol-grpc-web");
|
|
18
|
+
const node_transport_options_js_1 = require("./node-transport-options.js");
|
|
19
|
+
/**
|
|
20
|
+
* Create a Transport for the gRPC-web protocol using the Node.js `http`,
|
|
21
|
+
* `http2`, or `http2` module.
|
|
22
|
+
*/
|
|
23
|
+
function createGrpcWebTransport(options) {
|
|
24
|
+
return (0, protocol_grpc_web_1.createTransport)((0, node_transport_options_js_1.validateNodeTransportOptions)(options));
|
|
25
|
+
}
|
|
@@ -0,0 +1,146 @@
|
|
|
1
|
+
import * as http2 from "http2";
|
|
2
|
+
export interface Http2SessionOptions {
|
|
3
|
+
/**
|
|
4
|
+
* The interval to send PING frames to keep a connection alive. The interval
|
|
5
|
+
* is reset whenever a stream receives data. If a PING frame is not responded
|
|
6
|
+
* to within pingTimeoutMs, the connection and all open streams close.
|
|
7
|
+
*
|
|
8
|
+
* By default, no PING frames are sent. If a value is provided, PING frames
|
|
9
|
+
* are sent only for connections that have open streams, unless
|
|
10
|
+
* pingIdleConnections is enabled.
|
|
11
|
+
*
|
|
12
|
+
* Sensible values can be between 10 seconds and 2 hours, depending on your
|
|
13
|
+
* infrastructure.
|
|
14
|
+
*
|
|
15
|
+
* This option is equivalent to GRPC_ARG_KEEPALIVE_TIME_MS in gRPC Core.
|
|
16
|
+
*/
|
|
17
|
+
pingIntervalMs?: number;
|
|
18
|
+
/**
|
|
19
|
+
* Enable PING frames for connections that are have no open streams.
|
|
20
|
+
* This option is only effective if a value for pingIntervalMs is provided.
|
|
21
|
+
*
|
|
22
|
+
* Note that it may not be necessary to enable this option. If a request is
|
|
23
|
+
* made on a connection that has not been used for longer than pingIntervalMs,
|
|
24
|
+
* a PING frame is sent to verify that the connection is still alive, and a
|
|
25
|
+
* new connection is opened transparently if necessary.
|
|
26
|
+
*
|
|
27
|
+
* Defaults to false.
|
|
28
|
+
*
|
|
29
|
+
* This option is equivalent to GRPC_ARG_KEEPALIVE_PERMIT_WITHOUT_CALLS in
|
|
30
|
+
* gRPC Core.
|
|
31
|
+
*/
|
|
32
|
+
pingIdleConnection?: boolean;
|
|
33
|
+
/**
|
|
34
|
+
* Timeout for PING frames. If a PING is not answered within this time, the
|
|
35
|
+
* connection is considered dead.
|
|
36
|
+
*
|
|
37
|
+
* Defaults to 15 seconds. This option is only used if a value for
|
|
38
|
+
* pingIntervalMs is provided.
|
|
39
|
+
*
|
|
40
|
+
* This option is equivalent to GRPC_ARG_KEEPALIVE_TIMEOUT_MS in gRPC Core.
|
|
41
|
+
*/
|
|
42
|
+
pingTimeoutMs?: number;
|
|
43
|
+
/**
|
|
44
|
+
* Automatically close a connection if the time since the last request stream
|
|
45
|
+
* exceeds this value.
|
|
46
|
+
*
|
|
47
|
+
* Defaults to 15 minutes.
|
|
48
|
+
*
|
|
49
|
+
* This option is equivalent to GRPC_ARG_CLIENT_IDLE_TIMEOUT_MS of gRPC core.
|
|
50
|
+
*/
|
|
51
|
+
idleConnectionTimeoutMs?: number;
|
|
52
|
+
}
|
|
53
|
+
/**
|
|
54
|
+
* Manage an HTTP/2 connection and keep it alive with PING frames.
|
|
55
|
+
*
|
|
56
|
+
* The logic is based on "Basic Keepalive" described in
|
|
57
|
+
* https://github.com/grpc/proposal/blob/0ba0c1905050525f9b0aee46f3f23c8e1e515489/A8-client-side-keepalive.md#basic-keepalive
|
|
58
|
+
* as well as the client channel arguments described in
|
|
59
|
+
* https://github.com/grpc/grpc/blob/8e137e524a1b1da7bbf4603662876d5719563b57/doc/keepalive.md
|
|
60
|
+
*
|
|
61
|
+
* Usually, the managers tracks exactly one connection, but if a connection
|
|
62
|
+
* receives a GOAWAY frame with NO_ERROR, the connection is maintained until
|
|
63
|
+
* all streams have finished, and new requests will open a new connection.
|
|
64
|
+
*/
|
|
65
|
+
export declare class Http2SessionManager {
|
|
66
|
+
/**
|
|
67
|
+
* The host this session manager connect to.
|
|
68
|
+
*/
|
|
69
|
+
authority: string;
|
|
70
|
+
/**
|
|
71
|
+
* The current state of the connection:
|
|
72
|
+
*
|
|
73
|
+
* - "closed"
|
|
74
|
+
* The connection is closed, or no connection has been opened yet.
|
|
75
|
+
* - connecting
|
|
76
|
+
* Currently establishing a connection.
|
|
77
|
+
*
|
|
78
|
+
* - "open"
|
|
79
|
+
* A connection is open and has open streams. PING frames are sent every
|
|
80
|
+
* pingIntervalMs, unless a stream received data.
|
|
81
|
+
* If a PING frame is not responded to within pingTimeoutMs, the connection
|
|
82
|
+
* and all open streams close.
|
|
83
|
+
*
|
|
84
|
+
* - "idle"
|
|
85
|
+
* A connection is open, but it does not have any open streams.
|
|
86
|
+
* If pingIdleConnection is enabled, PING frames are used to keep the
|
|
87
|
+
* connection alive, similar to an "open" connection.
|
|
88
|
+
* If a connection is idle for longer than idleConnectionTimeoutMs, it closes.
|
|
89
|
+
* If a request is made on an idle connection that has not been used for
|
|
90
|
+
* longer than pingIntervalMs, the connection is verified.
|
|
91
|
+
*
|
|
92
|
+
* - "verifying"
|
|
93
|
+
* Verifying a connection after a long period of inactivity before issuing a
|
|
94
|
+
* request. A PING frame is sent, and if it times out within pingTimeoutMs, a
|
|
95
|
+
* new connection is opened.
|
|
96
|
+
*
|
|
97
|
+
* - "error"
|
|
98
|
+
* The connection is closed because of a transient error. A connection
|
|
99
|
+
* may have failed to reach the host, or the connection may have died,
|
|
100
|
+
* or it may have been aborted.
|
|
101
|
+
*/
|
|
102
|
+
state(): "closed" | "connecting" | "open" | "idle" | "verifying" | "error";
|
|
103
|
+
/**
|
|
104
|
+
* Returns the error object if the connection is in the "error" state,
|
|
105
|
+
* `undefined` otherwise.
|
|
106
|
+
*/
|
|
107
|
+
error(): unknown;
|
|
108
|
+
private s;
|
|
109
|
+
private shuttingDown;
|
|
110
|
+
private readonly http2SessionOptions;
|
|
111
|
+
private readonly options;
|
|
112
|
+
private verifying;
|
|
113
|
+
constructor(url: URL | string, pingOptions?: Http2SessionOptions, http2SessionOptions?: http2.ClientSessionOptions | http2.SecureClientSessionOptions);
|
|
114
|
+
/**
|
|
115
|
+
* Open a connection if none exists, verify an existing connection if
|
|
116
|
+
* necessary.
|
|
117
|
+
*/
|
|
118
|
+
connect(): Promise<"open" | "idle" | "error">;
|
|
119
|
+
/**
|
|
120
|
+
* Issue a request.
|
|
121
|
+
*
|
|
122
|
+
* This method automatically opens a connection if none exists, and verifies
|
|
123
|
+
* an existing connection if necessary. It calls http2.ClientHttp2Session.request(),
|
|
124
|
+
* and keeps track of all open http2.ClientHttp2Stream.
|
|
125
|
+
*
|
|
126
|
+
* Clients must call notifyResponseByteRead() whenever they successfully read
|
|
127
|
+
* data from the http2.ClientHttp2Stream.
|
|
128
|
+
*/
|
|
129
|
+
request(method: string, path: string, headers: http2.OutgoingHttpHeaders, options: Omit<http2.ClientSessionRequestOptions, "signal">): Promise<http2.ClientHttp2Stream>;
|
|
130
|
+
/**
|
|
131
|
+
* Notify the manager of a successful read from a http2.ClientHttp2Stream.
|
|
132
|
+
*
|
|
133
|
+
* Clients must call this function whenever they successfully read data from
|
|
134
|
+
* a http2.ClientHttp2Stream obtained from request(). This informs the
|
|
135
|
+
* keep-alive logic that the connection is alive, and prevents it from sending
|
|
136
|
+
* unnecessary PING frames.
|
|
137
|
+
*/
|
|
138
|
+
notifyResponseByteRead(stream: http2.ClientHttp2Stream): void;
|
|
139
|
+
/**
|
|
140
|
+
* If there is an open connection, close it. This also closes any open streams.
|
|
141
|
+
*/
|
|
142
|
+
abort(reason?: Error): void;
|
|
143
|
+
private gotoReady;
|
|
144
|
+
private setState;
|
|
145
|
+
private verify;
|
|
146
|
+
}
|