feat(hibernation): Hibernation APIs

[dinwwwh]

Ports the v1 @orpc/server/hibernation module to v2 as a dedicated @orpc/hibernation package, so Cloudflare WebSocket Hibernation (and similar) setups work again on v2. The plugin preserves HibernationAsyncIteratorClass outputs through the RPC codec, and encodeHibernationRPCEvent emits peer event-stream messages that are byte-identical to what the normal transmitter sends — clients consume hibernated streams exactly like regular ones.

API changes vs v1

• v2 naming (HibernationHandlerPlugin, HibernationAsyncIteratorClass) with deprecated v1 aliases so old imports keep compiling and point at the new names.
• encodeHibernationRPCEvent is now async, takes a serializer instance (shareable with RPCHandler) and a dedicated encodePeerMessage options field; the 'done' event became 'close' to match the peer protocol.
• The plugin runs as a routing interceptor and declares before: ['~batch']; evlog/pino logging plugins now order themselves before ~hibernation as well.

Docs

• New Plugins page with v2 imports and an updated Cloudflare Durable Object chat-room example, including a warning that hibernation procedures must be excluded from batching.
• @orpc/hibernation added to the package list in all READMEs.

Testing

• 14 new tests cover the plugin (standard handler + websocket end-to-end: the callback receives the request id, only the response message hits the wire, later events decode as event-stream messages for that id) and the encoder (byte parity with encodePeerMessage, event meta, close/error events, prefix, undefined payloads).
• Full pnpm type:check, lint, and unbuild pass; server/evlog/pino suites unaffected (450 tests green).

[vercel]

The latest updates on your projects. Learn more about Vercel for GitHub.

Project	Deployment	Actions	Updated (UTC)
orpc	Ready	Preview	Aug 3, 2026 2:01am

[pkg-pr-new]

More templates

• @orpc/bun-playground
• @orpc/cloudflare-playground
• @orpc/nest-playground
• @orpc/next-playground

@orpc/ai-sdk

npm i https://pkg.pr.new/middleapi/orpc/@orpc/ai-sdk@1763

@orpc/arktype

npm i https://pkg.pr.new/middleapi/orpc/@orpc/arktype@1763

@orpc/bun

npm i https://pkg.pr.new/middleapi/orpc/@orpc/bun@1763

@orpc/client

npm i https://pkg.pr.new/middleapi/orpc/@orpc/client@1763

@orpc/cloudflare

npm i https://pkg.pr.new/middleapi/orpc/@orpc/cloudflare@1763

@orpc/contract

npm i https://pkg.pr.new/middleapi/orpc/@orpc/contract@1763

@orpc/experimental-effect

npm i https://pkg.pr.new/middleapi/orpc/@orpc/experimental-effect@1763

@orpc/evlog

npm i https://pkg.pr.new/middleapi/orpc/@orpc/evlog@1763

@orpc/hibernation

npm i https://pkg.pr.new/middleapi/orpc/@orpc/hibernation@1763

@orpc/json-schema

npm i https://pkg.pr.new/middleapi/orpc/@orpc/json-schema@1763

@orpc/nest

npm i https://pkg.pr.new/middleapi/orpc/@orpc/nest@1763

@orpc/next

npm i https://pkg.pr.new/middleapi/orpc/@orpc/next@1763

@orpc/openapi

npm i https://pkg.pr.new/middleapi/orpc/@orpc/openapi@1763

@orpc/opentelemetry

npm i https://pkg.pr.new/middleapi/orpc/@orpc/opentelemetry@1763

@orpc/pinia-colada

npm i https://pkg.pr.new/middleapi/orpc/@orpc/pinia-colada@1763

@orpc/pino

npm i https://pkg.pr.new/middleapi/orpc/@orpc/pino@1763

@orpc/publisher

npm i https://pkg.pr.new/middleapi/orpc/@orpc/publisher@1763

@orpc/ratelimit

npm i https://pkg.pr.new/middleapi/orpc/@orpc/ratelimit@1763

@orpc/server

npm i https://pkg.pr.new/middleapi/orpc/@orpc/server@1763

@orpc/shared

npm i https://pkg.pr.new/middleapi/orpc/@orpc/shared@1763

@orpc/swr

npm i https://pkg.pr.new/middleapi/orpc/@orpc/swr@1763

@orpc/tanstack-query

npm i https://pkg.pr.new/middleapi/orpc/@orpc/tanstack-query@1763

@orpc/trpc

npm i https://pkg.pr.new/middleapi/orpc/@orpc/trpc@1763

@orpc/valibot

npm i https://pkg.pr.new/middleapi/orpc/@orpc/valibot@1763

@orpc/zod

npm i https://pkg.pr.new/middleapi/orpc/@orpc/zod@1763

commit: 5cada09

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

[codspeed-hq]

Merging this PR will not alter performance

✅ 25 untouched benchmarks

---

_{Comparing dinwwwh:claude/orpc-v2-hibernation-08c0f5 (5cada09) with main (d9d031f)}

[pullfrog]

✅ No new issues found.

Reviewed changes — port of v1 hibernation module to v2 as a new @orpc/hibernation package with plugin, encoder, deprecated aliases, docs, and README updates.

• New @orpc/hibernation package — HibernationHandlerPlugin (routing + client interceptor), encodeHibernationRPCEvent, and HibernationAsyncIteratorClass re-export
• Plugin ordering updates — @orpc/pino and @orpc/evlog now declare before: ['~hibernation'] so logging interceptors run before the hibernation plugin
• Docs and READMEs — VitePress page with Cloudflare Durable Object chat-room example; 20+ package READMEs now list @orpc/hibernation

  ^{｜ View workflow run ｜ Using DeepSeek Pro (free via Pullfrog for OSS) ｜ 𝕏}

[pullfrog]

✅ No new issues found.

Reviewed changes — updated docs examples to v2-idiomatic os.$context<>() patterns and added a full Cloudflare Durable Object chat room playground with hibernation.

• Docs example modernization — onMessage and sendMessage procedures updated to use $context and .input() chaining instead of bare os.handler()
• Cloudflare playground — HibernationChatRoom component, chat-room.ts client with RPCLink + reconnect, and ChatRoomDO server with withoutOpenTelemetry() helper for the DO's webSocketMessage/webSocketClose handlers
• Wrangler config — CHAT_ROOM_DON binding and migration added to wrangler.jsonc

  ^{｜ View workflow run ｜ Using DeepSeek Pro (free via Pullfrog for OSS) ｜ 𝕏}

[pullfrog]

✅ No new issues found.

Reviewed changes — moved hibernation docs into the integrations section and inlined the OTEL disable helper in the playground DO.

• Docs reorganized to integrations — hibernation page moved from docs/plugins/ to docs/integrations/, sidebar link and page heading renamed to "Hibernation Integration", and JSDoc URLs in encode-event.ts and handler-plugin.ts updated to match
• Playground OTEL helper inlined — withoutOpenTelemetry() wrapper removed from ChatRoomDO; each webSocketMessage/webSocketClose handler now creates and disables an ORPCInstrumentation instance directly

  ^{｜ View workflow run ｜ Using DeepSeek Pro (free via Pullfrog for OSS) ｜ 𝕏}