capnweb 0.0.0-03c82e8 → 0.0.0-064b0f3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -6,7 +6,7 @@ Cap'n Web is a spiritual sibling to [Cap'n Proto](https://capnproto.org) (and is
6
6
  * That said, it integrates nicely with TypeScript.
7
7
  * Also unlike Cap'n Proto, Cap'n Web's underlying serialization is human-readable. In fact, it's just JSON, with a little pre-/post-processing.
8
8
  * It works over HTTP, WebSocket, and postMessage() out-of-the-box, with the ability to extend it to other transports easily.
9
- * It works in all major browsers, Cloudflare Workers, Node.js, and other modern JavaScript runtimes.
9
+ * It works in all major browsers, Cloudflare Workers, Node.js, Bun, Deno, and other modern JavaScript runtimes.
10
10
  The whole thing compresses (minify+gzip) to under 10kB with no dependencies.
11
11
 
12
12
  Cap'n Web is more expressive than almost every other RPC system, because it implements an object-capability RPC model. That means it:
@@ -199,14 +199,15 @@ The following types can be passed over RPC (in arguments or return values), and
199
199
  * Arrays
200
200
  * `bigint`
201
201
  * `Date`
202
- * `Uint8Array`
202
+ * `ArrayBuffer`, `DataView`, and typed arrays
203
203
  * `Error` and its well-known subclasses
204
+ * `Blob`
204
205
  * `ReadableStream` and `WritableStream`, with automatic flow control.
206
+ * `URL`
205
207
  * `Headers`, `Request`, and `Response` from the Fetch API.
206
208
 
207
209
  The following types are not supported as of this writing, but may be added in the future:
208
210
  * `Map` and `Set`
209
- * `ArrayBuffer` and typed arrays other than `Uint8Array`
210
211
  * `RegExp`
211
212
 
212
213
  The following are intentionally NOT supported:
@@ -378,6 +379,40 @@ Sometimes you need to pass a stub somewhere where it will be disposed, but also
378
379
 
379
380
  Hint: You can call `.dup()` on a property of a stub or promise, in order to create a stub backed by that property. This is particularly useful when you know in advance that the property is going to resolve to a stub: calling `.dup()` on it gives you a stub you can start using immediately, that otherwise behaves exactly the same as the eventual stub would if you awaited it.
380
381
 
382
+ #### Holding on to a callback past the call that delivered it
383
+
384
+ A common bidirectional-calling pattern is for the client to pass a callback to the server, which the server then invokes later (for example from a timer, an event handler, or a subsequent RPC). Because the callback parameter is a stub, and stubs in params are implicitly disposed when the call returns, the server must duplicate the stub with `.dup()` if it wants to invoke the callback after the call completes:
385
+
386
+ ```ts
387
+ import { type RpcStub, RpcTarget } from 'capnweb';
388
+
389
+ // A callback the client passes in: a stub wrapping a function.
390
+ type Listener = RpcStub<(msg: string) => void>;
391
+
392
+ class Api extends RpcTarget {
393
+ #listener?: Listener;
394
+
395
+ // Stubs passed as params are disposed when the call returns, so `.dup()`
396
+ // to keep a reference that outlives registerListener().
397
+ registerListener(listener: Listener) {
398
+ this.#listener?.[Symbol.dispose](); // release any previous listener
399
+ this.#listener = listener.dup();
400
+ }
401
+
402
+ // A *later* call can invoke the retained callback -- still valid thanks to .dup().
403
+ notify(msg: string) {
404
+ this.#listener?.(msg);
405
+ }
406
+
407
+ // Dispose our duplicate when done so the client-side stub can be freed.
408
+ [Symbol.dispose]() {
409
+ this.#listener?.[Symbol.dispose]();
410
+ }
411
+ }
412
+ ```
413
+
414
+ The same rule applies in the other direction: if the server returns a stub to the client and the client wants to keep using it after disposing the result, the client should `.dup()` the stub before the result is disposed.
415
+
381
416
  ### Listening for disposal
382
417
 
383
418
  An `RpcTarget` may declare a `Symbol.dispose` method. If it does, the RPC system will automatically invoke it when a stub pointing at it (and all its duplicates) has been disposed.
@@ -404,6 +439,8 @@ If anything happens to the stub that would cause all further method calls and pr
404
439
 
405
440
  * Cap'n Web's pipelining can make it easy for a malicious client to enqueue a large amount of work to occur on a server. To mitigate this, we recommend implementing rate limits on expensive operations. If using Cloudflare Workers, you may also consider configuring [per-request CPU limits](https://developers.cloudflare.com/workers/wrangler/configuration/#limits) to be lower than the default 30s. Note that in stateless Workers (i.e. not Durable Objects), the system considers an entire WebSocket session to be one "request" for CPU limits purposes.
406
441
 
442
+ * Cap'n Web applies receiver-side resource limits before expensive message processing, including a maximum incoming message size before `JSON.parse`. If your app is exposed to untrusted peers, also configure native transport or socket payload limits where available, such as `ws`'s `maxPayload`, Bun's `maxPayloadLength`, or the runtime's built-in WebSocket cap. Cap'n Web's own check runs after `RpcTransport.receive()` has returned a complete message string, so transport-level limits are still the first line of defense against buffering very large frames.
443
+
407
444
  * Cap'n Web currently does not provide any runtime type checking. When using TypeScript, keep in mind that types are checked only at compile time. A malicious client can send types you did not expect, and this could cause you application to behave in unexpected ways. For example, MongoDB uses special property names to express queries; placing attacker-provided values directly into queries can result in query injection vulnerabilities (similar to SQL injection). Of course, JSON has always had the same problem, and there exists tooling to solve it. You might consider using a runtime type-checking framework like Zod to check your inputs. In the future, we hope to explore auto-generating type-checking code based on TypeScript types.
408
445
 
409
446
  ## Setting up a session
@@ -630,6 +667,45 @@ Deno.serve(async (req) => {
630
667
  });
631
668
  ```
632
669
 
670
+ ### HTTP server on Bun
671
+
672
+ Bun's server-side WebSocket API uses [callback-based handlers](https://bun.sh/docs/runtime/http/websockets) instead of the standard `addEventListener` interface. Cap'n Web provides `newBunWebSocketRpcHandler()` which returns a handler object you can pass directly to `Bun.serve()`.
673
+
674
+ ```ts
675
+ import { RpcTarget, newBunWebSocketRpcHandler, newHttpBatchRpcResponse } from "capnweb";
676
+
677
+ class MyApiImpl extends RpcTarget implements MyApi {
678
+ // ... define API, same as above ...
679
+ }
680
+
681
+ // Create a WebSocket handler that manages RPC sessions automatically.
682
+ // The callback is invoked once per connection to create a fresh API instance.
683
+ let rpcHandler = newBunWebSocketRpcHandler(() => new MyApiImpl());
684
+
685
+ Bun.serve({
686
+ async fetch(req, server) {
687
+ let url = new URL(req.url);
688
+ if (url.pathname === "/api") {
689
+ // Upgrade WebSocket requests.
690
+ if (req.headers.get("upgrade")?.toLowerCase() === "websocket") {
691
+ if (server.upgrade(req)) return;
692
+ return new Response("WebSocket upgrade failed", { status: 500 });
693
+ }
694
+
695
+ // Handle HTTP batch requests.
696
+ let response = await newHttpBatchRpcResponse(req, new MyApiImpl());
697
+ response.headers.set("Access-Control-Allow-Origin", "*");
698
+ return response;
699
+ }
700
+
701
+ return new Response("Not Found", { status: 404 });
702
+ },
703
+
704
+ // Pass the handler directly — no manual wiring needed.
705
+ websocket: rpcHandler,
706
+ });
707
+ ```
708
+
633
709
  ### HTTP server on other runtimes
634
710
 
635
711
  Every runtime does HTTP handling and WebSockets a little differently, although most modern runtimes use the standard `Request` and `Response` types from the Fetch API, as well as the standard `WebSocket` API. You should be able to use these two functions (exported by `capnweb`) to implement both HTTP batch and WebSocket handling on all platforms:
@@ -736,3 +812,10 @@ let stub: RemoteMainInterface = session.getRemoteMain();
736
812
  ```
737
813
 
738
814
  Note that sessions are entirely symmetric: neither side is defined as the "client" nor the "server". Each side can optionally expose a "main interface" to the other. In typical scenarios with a logical client and server, the server exposes a main interface but the client does not.
815
+
816
+ By default, `send()` accepts a string, and `receive()` returns a string, with Cap'n Web handling the encoding all the way to and from strings. However, transports that want more control over the serialization can declare the property `encodingLevel` to control how much encoding Cap'n Web does before passing off the message:
817
+
818
+ * `"string"` (default): Full JSON round-trip. The transport deals in strings only. Cap'n Web handles all encoding/decoding. This is what HTTP batch and WebSocket transports use.
819
+ * `"jsonCompatible"`: The transport works with JavaScript value trees, but they must be JSON-compatible. Cap'n Web still encodes special types, but skips the final `JSON.stringify`. The transport is responsible for serialization (e.g. to CBOR, MessagePack).
820
+ * `"jsonCompatibleWithBytes"`: Like `"jsonCompatible"` except that byte arrays are left as `Uint8Array` instead of base64-encoded, avoiding the ~33% base64 size overhead and the encode/decode CPU cost. Handy for use with serializations like CBOR or MessagePack that support this efficiently.
821
+ * `"structuredClonable"`: Messages are structured-clonable values. Cap'n Web passes through native structured-clone types where possible, while still handling RPC-specific values such as stubs. This is useful when the transport is a `MessagePort` or similar.