@orpc/server 0.0.0-next.c854c60 → 0.0.0-next.c8607a4

package/dist/adapters/standard-peer/index.d.mts

@@ -0,0 +1,14 @@
+import { ServerPeer, EncodedMessage } from '@orpc/standard-server-peer';
+import { C as Context } from '../../shared/server.6ohwBdwx.mjs';
+import { a as StandardHandler } from '../../shared/server.BtQsqpPB.mjs';
+import { F as FriendlyStandardHandleOptions } from '../../shared/server.B3dVpAsJ.mjs';
+import '@orpc/client';
+import '@orpc/contract';
+import '@orpc/shared';
+import '@orpc/standard-server';
+
+type HandleStandardServerPeerMessageOptions<T extends Context> = Omit<FriendlyStandardHandleOptions<T>, 'prefix'>;
+declare function handleStandardServerPeerMessage<T extends Context>(handler: StandardHandler<T>, peer: ServerPeer, message: EncodedMessage, options: HandleStandardServerPeerMessageOptions<T>): Promise<void>;
+
+export { handleStandardServerPeerMessage };
+export type { HandleStandardServerPeerMessageOptions };

package/dist/adapters/standard-peer/index.d.ts

@@ -0,0 +1,14 @@
+import { ServerPeer, EncodedMessage } from '@orpc/standard-server-peer';
+import { C as Context } from '../../shared/server.6ohwBdwx.js';
+import { a as StandardHandler } from '../../shared/server.BE3B4vij.js';
+import { F as FriendlyStandardHandleOptions } from '../../shared/server.CeW2jMCj.js';
+import '@orpc/client';
+import '@orpc/contract';
+import '@orpc/shared';
+import '@orpc/standard-server';
+
+type HandleStandardServerPeerMessageOptions<T extends Context> = Omit<FriendlyStandardHandleOptions<T>, 'prefix'>;
+declare function handleStandardServerPeerMessage<T extends Context>(handler: StandardHandler<T>, peer: ServerPeer, message: EncodedMessage, options: HandleStandardServerPeerMessageOptions<T>): Promise<void>;
+
+export { handleStandardServerPeerMessage };
+export type { HandleStandardServerPeerMessageOptions };

package/dist/adapters/standard-peer/index.mjs

@@ -0,0 +1,7 @@
+export { h as handleStandardServerPeerMessage } from '../../shared/server.C6Q5sqYw.mjs';
+import '@orpc/client';
+import '@orpc/shared';
+import '@orpc/standard-server';
+import '@orpc/contract';
+import '@orpc/client/standard';
+import '../../shared/server.DZ5BIITo.mjs';

package/dist/adapters/websocket/index.d.mts

@@ -1,17 +1,42 @@
 import { MaybeOptionalOptions } from '@orpc/shared';
-import { C as Context, R as Router } from '../../shared/server.DD2C4ujN.mjs';
-import { i as StandardHandler } from '../../shared/server.Dq8xr7PQ.mjs';
-import { F as FriendlyStandardHandleOptions } from '../../shared/server.BliFSTnG.mjs';
-import { S as StandardRPCHandlerOptions } from '../../shared/server.Bd52nNaH.mjs';
+import { C as Context, R as Router } from '../../shared/server.6ohwBdwx.mjs';
+import { a as StandardHandler } from '../../shared/server.BtQsqpPB.mjs';
+import { HandleStandardServerPeerMessageOptions } from '../standard-peer/index.mjs';
+import { S as StandardRPCHandlerOptions } from '../../shared/server.CKafa5G2.mjs';
 import '@orpc/client';
 import '@orpc/contract';
 import '@orpc/standard-server';
+import '@orpc/standard-server-peer';
+import '../../shared/server.B3dVpAsJ.mjs';
 import '@orpc/client/standard';
 
-declare class experimental_WebsocketHandler<T extends Context> {
-    private readonly standardHandler;
+type MinimalWebsocket = Pick<WebSocket, 'addEventListener' | 'send'>;
+declare class WebsocketHandler<T extends Context> {
+    #private;
     constructor(standardHandler: StandardHandler<T>);
-    upgrade(ws: Pick<WebSocket, 'addEventListener' | 'send'>, ...rest: MaybeOptionalOptions<Omit<FriendlyStandardHandleOptions<T>, 'prefix'>>): void;
+    /**
+     * Upgrades a WebSocket to enable handling
+     *
+     * This attaches the necessary 'message' and 'close' listeners to the WebSocket
+     *
+     * @warning Do not use this method if you're using `.message()` or `.close()`
+     */
+    upgrade(ws: MinimalWebsocket, ...rest: MaybeOptionalOptions<HandleStandardServerPeerMessageOptions<T>>): void;
+    /**
+     * Handles a single message received from a WebSocket.
+     *
+     * @warning Avoid calling this directly if `.upgrade()` is used.
+     *
+     * @param ws The WebSocket instance
+     * @param data The message payload, usually place in `event.data`
+     */
+    message(ws: MinimalWebsocket, data: string | ArrayBuffer | Blob, ...rest: MaybeOptionalOptions<HandleStandardServerPeerMessageOptions<T>>): Promise<void>;
+    /**
+     * Closes the WebSocket peer and cleans up.
+     *
+     * @warning Avoid calling this directly if `.upgrade()` is used.
+     */
+    close(ws: MinimalWebsocket): void;
 }
 
 /**
@@ -20,8 +45,9 @@ declare class experimental_WebsocketHandler<T extends Context> {
  * @see {@link https://orpc.unnoq.com/docs/rpc-handler RPC Handler Docs}
  * @see {@link https://orpc.unnoq.com/docs/adapters/websocket Websocket Adapter Docs}
  */
-declare class experimental_RPCHandler<T extends Context> extends experimental_WebsocketHandler<T> {
+declare class RPCHandler<T extends Context> extends WebsocketHandler<T> {
     constructor(router: Router<any, T>, options?: NoInfer<StandardRPCHandlerOptions<T>>);
 }
 
-export { experimental_RPCHandler, experimental_WebsocketHandler };
+export { RPCHandler, WebsocketHandler };
+export type { MinimalWebsocket };

package/dist/adapters/websocket/index.d.ts

@@ -1,17 +1,42 @@
 import { MaybeOptionalOptions } from '@orpc/shared';
-import { C as Context, R as Router } from '../../shared/server.DD2C4ujN.js';
-import { i as StandardHandler } from '../../shared/server.-ACo36I0.js';
-import { F as FriendlyStandardHandleOptions } from '../../shared/server.IG2MjhrD.js';
-import { S as StandardRPCHandlerOptions } from '../../shared/server.BPAWobQg.js';
+import { C as Context, R as Router } from '../../shared/server.6ohwBdwx.js';
+import { a as StandardHandler } from '../../shared/server.BE3B4vij.js';
+import { HandleStandardServerPeerMessageOptions } from '../standard-peer/index.js';
+import { S as StandardRPCHandlerOptions } from '../../shared/server.B6GspgNq.js';
 import '@orpc/client';
 import '@orpc/contract';
 import '@orpc/standard-server';
+import '@orpc/standard-server-peer';
+import '../../shared/server.CeW2jMCj.js';
 import '@orpc/client/standard';
 
-declare class experimental_WebsocketHandler<T extends Context> {
-    private readonly standardHandler;
+type MinimalWebsocket = Pick<WebSocket, 'addEventListener' | 'send'>;
+declare class WebsocketHandler<T extends Context> {
+    #private;
     constructor(standardHandler: StandardHandler<T>);
-    upgrade(ws: Pick<WebSocket, 'addEventListener' | 'send'>, ...rest: MaybeOptionalOptions<Omit<FriendlyStandardHandleOptions<T>, 'prefix'>>): void;
+    /**
+     * Upgrades a WebSocket to enable handling
+     *
+     * This attaches the necessary 'message' and 'close' listeners to the WebSocket
+     *
+     * @warning Do not use this method if you're using `.message()` or `.close()`
+     */
+    upgrade(ws: MinimalWebsocket, ...rest: MaybeOptionalOptions<HandleStandardServerPeerMessageOptions<T>>): void;
+    /**
+     * Handles a single message received from a WebSocket.
+     *
+     * @warning Avoid calling this directly if `.upgrade()` is used.
+     *
+     * @param ws The WebSocket instance
+     * @param data The message payload, usually place in `event.data`
+     */
+    message(ws: MinimalWebsocket, data: string | ArrayBuffer | Blob, ...rest: MaybeOptionalOptions<HandleStandardServerPeerMessageOptions<T>>): Promise<void>;
+    /**
+     * Closes the WebSocket peer and cleans up.
+     *
+     * @warning Avoid calling this directly if `.upgrade()` is used.
+     */
+    close(ws: MinimalWebsocket): void;
 }
 
 /**
@@ -20,8 +45,9 @@ declare class experimental_WebsocketHandler<T extends Context> {
  * @see {@link https://orpc.unnoq.com/docs/rpc-handler RPC Handler Docs}
  * @see {@link https://orpc.unnoq.com/docs/adapters/websocket Websocket Adapter Docs}
  */
-declare class experimental_RPCHandler<T extends Context> extends experimental_WebsocketHandler<T> {
+declare class RPCHandler<T extends Context> extends WebsocketHandler<T> {
     constructor(router: Router<any, T>, options?: NoInfer<StandardRPCHandlerOptions<T>>);
 }
 
-export { experimental_RPCHandler, experimental_WebsocketHandler };
+export { RPCHandler, WebsocketHandler };
+export type { MinimalWebsocket };

package/dist/adapters/websocket/index.mjs

@@ -1,39 +1,69 @@
-import { resolveMaybeOptionalOptions } from '@orpc/shared';
+import { readAsBuffer, resolveMaybeOptionalOptions } from '@orpc/shared';
 import { ServerPeer } from '@orpc/standard-server-peer';
-import { r as resolveFriendlyStandardHandleOptions } from '../../shared/server.DZ5BIITo.mjs';
+import { h as handleStandardServerPeerMessage } from '../../shared/server.C6Q5sqYw.mjs';
 import '@orpc/client';
 import '@orpc/standard-server';
 import '@orpc/contract';
-import { b as StandardRPCHandler } from '../../shared/server.CHvOkcM3.mjs';
+import { b as StandardRPCHandler } from '../../shared/server.CB8Snncu.mjs';
 import '@orpc/client/standard';
-import '../../shared/server.DG7Tamti.mjs';
+import '../../shared/server.DZ5BIITo.mjs';
+import '../../shared/server.DLJzqnSX.mjs';
 
-class experimental_WebsocketHandler {
+class WebsocketHandler {
+  #peers = /* @__PURE__ */ new WeakMap();
+  #handler;
   constructor(standardHandler) {
-    this.standardHandler = standardHandler;
+    this.#handler = standardHandler;
   }
+  /**
+   * Upgrades a WebSocket to enable handling
+   *
+   * This attaches the necessary 'message' and 'close' listeners to the WebSocket
+   *
+   * @warning Do not use this method if you're using `.message()` or `.close()`
+   */
   upgrade(ws, ...rest) {
-    const peer = new ServerPeer(ws.send.bind(ws));
-    ws.addEventListener("message", async (event) => {
-      const message = event.data instanceof Blob ? await event.data.arrayBuffer() : event.data;
-      const [id, request] = await peer.message(message);
-      if (!request) {
-        return;
-      }
-      const options = resolveFriendlyStandardHandleOptions(resolveMaybeOptionalOptions(rest));
-      const { response } = await this.standardHandler.handle({ ...request, body: () => Promise.resolve(request.body) }, options);
-      await peer.response(id, response ?? { status: 404, headers: {}, body: "No procedure matched" });
-    });
-    ws.addEventListener("close", () => {
+    ws.addEventListener("message", (event) => this.message(ws, event.data, ...rest));
+    ws.addEventListener("close", () => this.close(ws));
+  }
+  /**
+   * Handles a single message received from a WebSocket.
+   *
+   * @warning Avoid calling this directly if `.upgrade()` is used.
+   *
+   * @param ws The WebSocket instance
+   * @param data The message payload, usually place in `event.data`
+   */
+  async message(ws, data, ...rest) {
+    let peer = this.#peers.get(ws);
+    if (!peer) {
+      this.#peers.set(ws, peer = new ServerPeer(ws.send.bind(ws)));
+    }
+    const message = data instanceof Blob ? await readAsBuffer(data) : data;
+    await handleStandardServerPeerMessage(
+      this.#handler,
+      peer,
+      message,
+      resolveMaybeOptionalOptions(rest)
+    );
+  }
+  /**
+   * Closes the WebSocket peer and cleans up.
+   *
+   * @warning Avoid calling this directly if `.upgrade()` is used.
+   */
+  close(ws) {
+    const peer = this.#peers.get(ws);
+    if (peer) {
       peer.close();
-    });
+    }
   }
 }
 
-class experimental_RPCHandler extends experimental_WebsocketHandler {
+class RPCHandler extends WebsocketHandler {
   constructor(router, options = {}) {
     super(new StandardRPCHandler(router, options));
   }
 }
 
-export { experimental_RPCHandler, experimental_WebsocketHandler };
+export { RPCHandler, WebsocketHandler };

package/dist/adapters/ws/index.d.mts

@@ -1,18 +1,20 @@
 import { MaybeOptionalOptions } from '@orpc/shared';
 import { WebSocket } from 'ws';
-import { C as Context, R as Router } from '../../shared/server.DD2C4ujN.mjs';
-import { i as StandardHandler } from '../../shared/server.Dq8xr7PQ.mjs';
-import { F as FriendlyStandardHandleOptions } from '../../shared/server.BliFSTnG.mjs';
-import { S as StandardRPCHandlerOptions } from '../../shared/server.Bd52nNaH.mjs';
+import { C as Context, R as Router } from '../../shared/server.6ohwBdwx.mjs';
+import { a as StandardHandler } from '../../shared/server.BtQsqpPB.mjs';
+import { HandleStandardServerPeerMessageOptions } from '../standard-peer/index.mjs';
+import { S as StandardRPCHandlerOptions } from '../../shared/server.CKafa5G2.mjs';
 import '@orpc/client';
 import '@orpc/contract';
 import '@orpc/standard-server';
+import '@orpc/standard-server-peer';
+import '../../shared/server.B3dVpAsJ.mjs';
 import '@orpc/client/standard';
 
-declare class experimental_WsHandler<T extends Context> {
+declare class WsHandler<T extends Context> {
     private readonly standardHandler;
     constructor(standardHandler: StandardHandler<T>);
-    upgrade(ws: Pick<WebSocket, 'addEventListener' | 'send'>, ...rest: MaybeOptionalOptions<Omit<FriendlyStandardHandleOptions<T>, 'prefix'>>): Promise<void>;
+    upgrade(ws: Pick<WebSocket, 'addEventListener' | 'send'>, ...rest: MaybeOptionalOptions<HandleStandardServerPeerMessageOptions<T>>): Promise<void>;
 }
 
 /**
@@ -21,8 +23,8 @@ declare class experimental_WsHandler<T extends Context> {
  * @see {@link https://orpc.unnoq.com/docs/rpc-handler RPC Handler Docs}
  * @see {@link https://orpc.unnoq.com/docs/adapters/websocket Websocket Adapter Docs}
  */
-declare class experimental_RPCHandler<T extends Context> extends experimental_WsHandler<T> {
+declare class RPCHandler<T extends Context> extends WsHandler<T> {
     constructor(router: Router<any, T>, options?: NoInfer<StandardRPCHandlerOptions<T>>);
 }
 
-export { experimental_RPCHandler, experimental_WsHandler };
+export { RPCHandler, WsHandler };

package/dist/adapters/ws/index.d.ts

@@ -1,18 +1,20 @@
 import { MaybeOptionalOptions } from '@orpc/shared';
 import { WebSocket } from 'ws';
-import { C as Context, R as Router } from '../../shared/server.DD2C4ujN.js';
-import { i as StandardHandler } from '../../shared/server.-ACo36I0.js';
-import { F as FriendlyStandardHandleOptions } from '../../shared/server.IG2MjhrD.js';
-import { S as StandardRPCHandlerOptions } from '../../shared/server.BPAWobQg.js';
+import { C as Context, R as Router } from '../../shared/server.6ohwBdwx.js';
+import { a as StandardHandler } from '../../shared/server.BE3B4vij.js';
+import { HandleStandardServerPeerMessageOptions } from '../standard-peer/index.js';
+import { S as StandardRPCHandlerOptions } from '../../shared/server.B6GspgNq.js';
 import '@orpc/client';
 import '@orpc/contract';
 import '@orpc/standard-server';
+import '@orpc/standard-server-peer';
+import '../../shared/server.CeW2jMCj.js';
 import '@orpc/client/standard';
 
-declare class experimental_WsHandler<T extends Context> {
+declare class WsHandler<T extends Context> {
     private readonly standardHandler;
     constructor(standardHandler: StandardHandler<T>);
-    upgrade(ws: Pick<WebSocket, 'addEventListener' | 'send'>, ...rest: MaybeOptionalOptions<Omit<FriendlyStandardHandleOptions<T>, 'prefix'>>): Promise<void>;
+    upgrade(ws: Pick<WebSocket, 'addEventListener' | 'send'>, ...rest: MaybeOptionalOptions<HandleStandardServerPeerMessageOptions<T>>): Promise<void>;
 }
 
 /**
@@ -21,8 +23,8 @@ declare class experimental_WsHandler<T extends Context> {
  * @see {@link https://orpc.unnoq.com/docs/rpc-handler RPC Handler Docs}
  * @see {@link https://orpc.unnoq.com/docs/adapters/websocket Websocket Adapter Docs}
  */
-declare class experimental_RPCHandler<T extends Context> extends experimental_WsHandler<T> {
+declare class RPCHandler<T extends Context> extends WsHandler<T> {
     constructor(router: Router<any, T>, options?: NoInfer<StandardRPCHandlerOptions<T>>);
 }
 
-export { experimental_RPCHandler, experimental_WsHandler };
+export { RPCHandler, WsHandler };

package/dist/adapters/ws/index.mjs

@@ -1,28 +1,28 @@
-import { resolveMaybeOptionalOptions } from '@orpc/shared';
+import { readAsBuffer, resolveMaybeOptionalOptions } from '@orpc/shared';
 import { ServerPeer } from '@orpc/standard-server-peer';
-import { r as resolveFriendlyStandardHandleOptions } from '../../shared/server.DZ5BIITo.mjs';
+import { h as handleStandardServerPeerMessage } from '../../shared/server.C6Q5sqYw.mjs';
 import '@orpc/client';
 import '@orpc/standard-server';
 import '@orpc/contract';
-import { b as StandardRPCHandler } from '../../shared/server.CHvOkcM3.mjs';
+import { b as StandardRPCHandler } from '../../shared/server.CB8Snncu.mjs';
 import '@orpc/client/standard';
-import '../../shared/server.DG7Tamti.mjs';
+import '../../shared/server.DZ5BIITo.mjs';
+import '../../shared/server.DLJzqnSX.mjs';
 
-class experimental_WsHandler {
+class WsHandler {
   constructor(standardHandler) {
     this.standardHandler = standardHandler;
   }
   async upgrade(ws, ...rest) {
     const peer = new ServerPeer(ws.send.bind(ws));
     ws.addEventListener("message", async (event) => {
-      const message = Array.isArray(event.data) ? await new Blob(event.data).arrayBuffer() : event.data;
-      const [id, request] = await peer.message(message);
-      if (!request) {
-        return;
-      }
-      const options = resolveFriendlyStandardHandleOptions(resolveMaybeOptionalOptions(rest));
-      const { response } = await this.standardHandler.handle({ ...request, body: () => Promise.resolve(request.body) }, options);
-      await peer.response(id, response ?? { status: 404, headers: {}, body: "No procedure matched" });
+      const message = Array.isArray(event.data) ? await readAsBuffer(new Blob(event.data)) : event.data;
+      await handleStandardServerPeerMessage(
+        this.standardHandler,
+        peer,
+        message,
+        resolveMaybeOptionalOptions(rest)
+      );
     });
     ws.addEventListener("close", () => {
       peer.close();
@@ -30,10 +30,10 @@ class experimental_WsHandler {
   }
 }
 
-class experimental_RPCHandler extends experimental_WsHandler {
+class RPCHandler extends WsHandler {
   constructor(router, options = {}) {
     super(new StandardRPCHandler(router, options));
   }
 }
 
-export { experimental_RPCHandler, experimental_WsHandler };
+export { RPCHandler, WsHandler };

package/dist/hibernation/index.d.mts

@@ -0,0 +1,44 @@
+import { StandardRPCJsonSerializerOptions } from '@orpc/client/standard';
+import { c as StandardHandlerPlugin, S as StandardHandlerOptions } from '../shared/server.BtQsqpPB.mjs';
+import { experimental_HibernationEventIterator } from '@orpc/standard-server';
+export { experimental_HibernationEventIterator, experimental_HibernationEventIteratorCallback } from '@orpc/standard-server';
+import { C as Context, R as Router } from '../shared/server.6ohwBdwx.mjs';
+import '@orpc/client';
+import '@orpc/contract';
+import '@orpc/shared';
+
+interface experimental_EncodeHibernationRPCEventOptions extends StandardRPCJsonSerializerOptions {
+    /**
+     * The type of event, each type corresponds a different operation
+     *
+     * - 'message' = 'yield'
+     * - 'error' = 'throw'
+     * - 'done' = 'return'
+     *
+     * @default 'message'
+     */
+    event?: 'message' | 'error' | 'done';
+}
+/**
+ * Encodes a Hibernation RPC Event
+ *
+ * @see {@link https://orpc.unnoq.com/docs/plugins/hibernation Hibernation Plugin}
+ */
+declare function experimental_encodeHibernationRPCEvent(id: string, payload: unknown, options?: experimental_EncodeHibernationRPCEventOptions): string;
+
+interface experimental_HibernationPluginContext {
+    iterator?: experimental_HibernationEventIterator<any>;
+}
+/**
+ * Enable Hibernation APIs
+ *
+ * @see {@link https://orpc.unnoq.com/docs/plugins/hibernation Hibernation Plugin}
+ */
+declare class experimental_HibernationPlugin<T extends Context> implements StandardHandlerPlugin<T> {
+    readonly CONTEXT_SYMBOL: symbol;
+    order: number;
+    init(options: StandardHandlerOptions<T>, _router: Router<any, T>): void;
+}
+
+export { experimental_HibernationPlugin, experimental_encodeHibernationRPCEvent };
+export type { experimental_EncodeHibernationRPCEventOptions, experimental_HibernationPluginContext };

package/dist/hibernation/index.d.ts

@@ -0,0 +1,44 @@
+import { StandardRPCJsonSerializerOptions } from '@orpc/client/standard';
+import { c as StandardHandlerPlugin, S as StandardHandlerOptions } from '../shared/server.BE3B4vij.js';
+import { experimental_HibernationEventIterator } from '@orpc/standard-server';
+export { experimental_HibernationEventIterator, experimental_HibernationEventIteratorCallback } from '@orpc/standard-server';
+import { C as Context, R as Router } from '../shared/server.6ohwBdwx.js';
+import '@orpc/client';
+import '@orpc/contract';
+import '@orpc/shared';
+
+interface experimental_EncodeHibernationRPCEventOptions extends StandardRPCJsonSerializerOptions {
+    /**
+     * The type of event, each type corresponds a different operation
+     *
+     * - 'message' = 'yield'
+     * - 'error' = 'throw'
+     * - 'done' = 'return'
+     *
+     * @default 'message'
+     */
+    event?: 'message' | 'error' | 'done';
+}
+/**
+ * Encodes a Hibernation RPC Event
+ *
+ * @see {@link https://orpc.unnoq.com/docs/plugins/hibernation Hibernation Plugin}
+ */
+declare function experimental_encodeHibernationRPCEvent(id: string, payload: unknown, options?: experimental_EncodeHibernationRPCEventOptions): string;
+
+interface experimental_HibernationPluginContext {
+    iterator?: experimental_HibernationEventIterator<any>;
+}
+/**
+ * Enable Hibernation APIs
+ *
+ * @see {@link https://orpc.unnoq.com/docs/plugins/hibernation Hibernation Plugin}
+ */
+declare class experimental_HibernationPlugin<T extends Context> implements StandardHandlerPlugin<T> {
+    readonly CONTEXT_SYMBOL: symbol;
+    order: number;
+    init(options: StandardHandlerOptions<T>, _router: Router<any, T>): void;
+}
+
+export { experimental_HibernationPlugin, experimental_encodeHibernationRPCEvent };
+export type { experimental_EncodeHibernationRPCEventOptions, experimental_HibernationPluginContext };

package/dist/hibernation/index.mjs

@@ -0,0 +1,65 @@
+import { toORPCError } from '@orpc/client';
+import { StandardRPCJsonSerializer } from '@orpc/client/standard';
+import { stringifyJSON } from '@orpc/shared';
+import { getEventMeta, experimental_HibernationEventIterator } from '@orpc/standard-server';
+export { experimental_HibernationEventIterator } from '@orpc/standard-server';
+import { MessageType } from '@orpc/standard-server-peer';
+
+function experimental_encodeHibernationRPCEvent(id, payload, options = {}) {
+  const { event = "message", ...rest } = options;
+  const serializer = new StandardRPCJsonSerializer(rest);
+  const data = event === "error" ? toORPCError(payload).toJSON() : payload;
+  const [json, meta] = serializer.serialize(data);
+  return stringifyJSON({
+    i: id,
+    t: MessageType.EVENT_ITERATOR,
+    p: {
+      e: event,
+      d: { json, meta: meta.length > 0 ? meta : void 0 },
+      m: getEventMeta(payload)
+    }
+  });
+}
+
+class experimental_HibernationPlugin {
+  CONTEXT_SYMBOL = Symbol("ORPC_HIBERNATION_CONTEXT");
+  order = 2e6;
+  // make sure execute after the batch plugin
+  init(options, _router) {
+    options.interceptors ??= [];
+    options.clientInterceptors ??= [];
+    options.interceptors.unshift(async (options2) => {
+      const hibernationContext = {};
+      const result = await options2.next({
+        ...options2,
+        context: {
+          [this.CONTEXT_SYMBOL]: hibernationContext,
+          ...options2.context
+        }
+      });
+      if (!result.matched || !hibernationContext.iterator) {
+        return result;
+      }
+      return {
+        ...result,
+        response: {
+          ...result.response,
+          body: hibernationContext.iterator
+        }
+      };
+    });
+    options.clientInterceptors.unshift(async (options2) => {
+      const hibernationContext = options2.context[this.CONTEXT_SYMBOL];
+      if (!hibernationContext) {
+        throw new TypeError("[HibernationPlugin] Hibernation context has been corrupted or modified by another plugin or interceptor");
+      }
+      const output = await options2.next();
+      if (output instanceof experimental_HibernationEventIterator) {
+        hibernationContext.iterator = output;
+      }
+      return output;
+    });
+  }
+}
+
+export { experimental_HibernationPlugin, experimental_encodeHibernationRPCEvent };

package/dist/index.d.mts

@@ -1,11 +1,11 @@
-import { ORPCErrorJSON, ORPCError, Client, ClientContext, HTTPPath, HTTPMethod, ClientPromiseResult } from '@orpc/client';
+import { ORPCErrorJSON, ORPCError, Client, ClientContext, HTTPPath, HTTPMethod, ClientOptions, ClientPromiseResult } from '@orpc/client';
 export { ClientContext, HTTPMethod, HTTPPath, ORPCError, isDefinedError, safe } from '@orpc/client';
 import { AnySchema, ErrorMap, InferSchemaInput, InferSchemaOutput, ErrorFromErrorMap, Meta, MergedErrorMap, Route, EnhanceRouteOptions, AnyContractRouter, AnyContractProcedure, Schema, ContractRouter, ContractProcedureDef, ContractProcedure, InferContractRouterErrorMap, InferContractRouterMeta } from '@orpc/contract';
 export { ContractProcedure, ContractProcedureDef, ContractRouter, ErrorMap, ErrorMapItem, InferSchemaInput, InferSchemaOutput, InputStructure, MergedErrorMap, Meta, OutputStructure, Route, Schema, ValidationError, eventIterator, type } from '@orpc/contract';
 import { ThrowableError, IntersectPick, MaybeOptionalOptions } from '@orpc/shared';
 export { EventPublisher, EventPublisherOptions, EventPublisherSubscribeIteratorOptions, IntersectPick, Registry, ThrowableError, onError, onFinish, onStart, onSuccess } from '@orpc/shared';
-import { C as Context, P as Procedure, M as Middleware, O as ORPCErrorConstructorMap, a as MergedInitialContext, b as MergedCurrentContext, c as MapInputMiddleware, d as CreateProcedureClientOptions, e as ProcedureClient, A as AnyMiddleware, L as Lazyable, f as AnyRouter, g as Lazy, h as AnyProcedure, i as ProcedureHandler, R as Router, I as InferRouterInitialContext } from './shared/server.DD2C4ujN.mjs';
-export { J as InferRouterCurrentContexts, H as InferRouterInitialContexts, K as InferRouterInputs, N as InferRouterOutputs, n as LAZY_SYMBOL, o as LazyMeta, w as MiddlewareNextFn, t as MiddlewareNextFnOptions, y as MiddlewareOptions, x as MiddlewareOutputFn, s as MiddlewareResult, k as ORPCErrorConstructorMapItem, j as ORPCErrorConstructorMapItemOptions, F as ProcedureClientInterceptorOptions, D as ProcedureDef, B as ProcedureHandlerOptions, l as createORPCErrorConstructorMap, G as createProcedureClient, r as getLazyMeta, q as isLazy, E as isProcedure, p as lazy, m as mergeCurrentContext, z as middlewareOutputFn, u as unlazy, v as validateORPCError } from './shared/server.DD2C4ujN.mjs';
+import { C as Context, b as Procedure, M as Middleware, O as ORPCErrorConstructorMap, c as MergedInitialContext, d as MergedCurrentContext, e as MapInputMiddleware, f as CreateProcedureClientOptions, g as ProcedureClient, h as AnyMiddleware, L as Lazyable, a as AnyRouter, i as Lazy, A as AnyProcedure, j as ProcedureHandler, R as Router, I as InferRouterInitialContext } from './shared/server.6ohwBdwx.mjs';
+export { J as InferRouterCurrentContexts, H as InferRouterInitialContexts, K as InferRouterInputs, N as InferRouterOutputs, o as LAZY_SYMBOL, p as LazyMeta, x as MiddlewareNextFn, w as MiddlewareNextFnOptions, z as MiddlewareOptions, y as MiddlewareOutputFn, t as MiddlewareResult, l as ORPCErrorConstructorMapItem, k as ORPCErrorConstructorMapItemOptions, P as ProcedureClientInterceptorOptions, E as ProcedureDef, D as ProcedureHandlerOptions, n as createORPCErrorConstructorMap, G as createProcedureClient, s as getLazyMeta, r as isLazy, F as isProcedure, q as lazy, m as mergeCurrentContext, B as middlewareOutputFn, u as unlazy, v as validateORPCError } from './shared/server.6ohwBdwx.mjs';
 export { getEventMeta, withEventMeta } from '@orpc/standard-server';
 
 type ActionableError<T> = T extends ORPCError<infer U, infer V> ? ORPCErrorJSON<U, V> & {
@@ -510,7 +510,7 @@ declare class Builder<TInitialContext extends Context, TCurrentContext extends C
     /**
      * Sets or overrides the config.
      *
-     * @see {@link https://orpc.unnoq.com/docs/lifecycle#middlewares-order Middlewares Order Docs}
+     * @see {@link https://orpc.unnoq.com/docs/client/server-side#middlewares-order Middlewares Order Docs}
      * @see {@link https://orpc.unnoq.com/docs/best-practices/dedupe-middleware#configuration Dedupe Middleware Docs}
      */
     $config(config: BuilderConfig): Builder<TInitialContext, TCurrentContext, TInputSchema, TOutputSchema, TErrorMap, TMeta>;
@@ -730,9 +730,9 @@ interface RouterImplementerWithMiddlewares<T extends AnyContractRouter, TInitial
         default: U;
     }>): EnhancedRouter<Lazy<U>, TInitialContext, TCurrentContext, Record<never, never>>;
 }
-type ImplementerInternalWithMiddlewares<TContract extends AnyContractRouter, TInitialContext extends Context, TCurrentContext extends Context> = (TContract extends ContractProcedure<infer UInputSchema, infer UOutputSchema, infer UErrorMap, infer UMeta> ? ProcedureImplementer<TInitialContext, TCurrentContext, UInputSchema, UOutputSchema, UErrorMap, UMeta> : RouterImplementerWithMiddlewares<TContract, TInitialContext, TCurrentContext> & {
+type ImplementerInternalWithMiddlewares<TContract extends AnyContractRouter, TInitialContext extends Context, TCurrentContext extends Context> = TContract extends ContractProcedure<infer UInputSchema, infer UOutputSchema, infer UErrorMap, infer UMeta> ? ProcedureImplementer<TInitialContext, TCurrentContext, UInputSchema, UOutputSchema, UErrorMap, UMeta> : RouterImplementerWithMiddlewares<TContract, TInitialContext, TCurrentContext> & {
     [K in keyof TContract]: TContract[K] extends AnyContractRouter ? ImplementerInternalWithMiddlewares<TContract[K], TInitialContext, TCurrentContext> : never;
-});
+};
 
 interface RouterImplementer<T extends AnyContractRouter, TInitialContext extends Context, TCurrentContext extends Context> {
     /**
@@ -768,9 +768,9 @@ interface RouterImplementer<T extends AnyContractRouter, TInitialContext extends
         default: U;
     }>): EnhancedRouter<Lazy<U>, TInitialContext, TCurrentContext, Record<never, never>>;
 }
-type ImplementerInternal<TContract extends AnyContractRouter, TInitialContext extends Context, TCurrentContext extends Context> = (TContract extends ContractProcedure<infer UInputSchema, infer UOutputSchema, infer UErrorMap, infer UMeta> ? ProcedureImplementer<TInitialContext, TCurrentContext, UInputSchema, UOutputSchema, UErrorMap, UMeta> : RouterImplementer<TContract, TInitialContext, TCurrentContext> & {
+type ImplementerInternal<TContract extends AnyContractRouter, TInitialContext extends Context, TCurrentContext extends Context> = TContract extends ContractProcedure<infer UInputSchema, infer UOutputSchema, infer UErrorMap, infer UMeta> ? ProcedureImplementer<TInitialContext, TCurrentContext, UInputSchema, UOutputSchema, UErrorMap, UMeta> : RouterImplementer<TContract, TInitialContext, TCurrentContext> & {
     [K in keyof TContract]: TContract[K] extends AnyContractRouter ? ImplementerInternal<TContract[K], TInitialContext, TCurrentContext> : never;
-});
+};
 declare function implementerInternal<T extends AnyContractRouter, TInitialContext extends Context, TCurrentContext extends Context>(contract: T, config: BuilderConfig, middlewares: AnyMiddleware[]): ImplementerInternal<T, TInitialContext, TCurrentContext>;
 type Implementer<TContract extends AnyContractRouter, TInitialContext extends Context, TCurrentContext extends Context> = {
     /**
@@ -782,7 +782,7 @@ type Implementer<TContract extends AnyContractRouter, TInitialContext extends Co
     /**
      * Sets or overrides the config.
      *
-     * @see {@link https://orpc.unnoq.com/docs/lifecycle#middlewares-order Middlewares Order Docs}
+     * @see {@link https://orpc.unnoq.com/docs/client/server-side#middlewares-order Middlewares Order Docs}
      * @see {@link https://orpc.unnoq.com/docs/best-practices/dedupe-middleware#configuration Dedupe Middleware Docs}
      */
     $config(config: BuilderConfig): Implementer<TContract, TInitialContext, TCurrentContext>;
@@ -815,7 +815,7 @@ declare function createContractedProcedure(procedure: AnyProcedure, contract: An
  * ```
  *
  */
-declare function call<TInitialContext extends Context, TInputSchema extends AnySchema, TOutputSchema extends AnySchema, TErrorMap extends ErrorMap, TMeta extends Meta>(procedure: Lazyable<Procedure<TInitialContext, any, TInputSchema, TOutputSchema, TErrorMap, TMeta>>, input: InferSchemaInput<TInputSchema>, ...rest: MaybeOptionalOptions<CreateProcedureClientOptions<TInitialContext, TOutputSchema, TErrorMap, TMeta, Record<never, never>>>): ClientPromiseResult<InferSchemaOutput<TOutputSchema>, ErrorFromErrorMap<TErrorMap>>;
+declare function call<TInitialContext extends Context, TInputSchema extends AnySchema, TOutputSchema extends AnySchema, TErrorMap extends ErrorMap, TMeta extends Meta>(procedure: Lazyable<Procedure<TInitialContext, any, TInputSchema, TOutputSchema, TErrorMap, TMeta>>, input: InferSchemaInput<TInputSchema>, ...rest: MaybeOptionalOptions<CreateProcedureClientOptions<TInitialContext, TOutputSchema, TErrorMap, TMeta, Record<never, never>> & Omit<ClientOptions<Record<never, never>>, 'context'>>): ClientPromiseResult<InferSchemaOutput<TOutputSchema>, ErrorFromErrorMap<TErrorMap>>;
 
 type RouterClient<TRouter extends AnyRouter, TClientContext extends ClientContext = Record<never, never>> = TRouter extends Procedure<any, any, infer UInputSchema, infer UOutputSchema, infer UErrorMap, any> ? ProcedureClient<TClientContext, UInputSchema, UOutputSchema, UErrorMap> : {
     [K in keyof TRouter]: TRouter[K] extends Lazyable<infer U extends AnyRouter> ? RouterClient<U, TClientContext> : never;