@orpc/server 0.0.0-next.eae6003 → 0.0.0-next.eaf61c7

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

@@ -1,17 +1,40 @@
 import { MaybeOptionalOptions } from '@orpc/shared';
-import { C as Context, R as Router } from '../../shared/server.DPWk5pjW.js';
-import { i as StandardHandler } from '../../shared/server.YZzrREz9.js';
-import { F as FriendlyStandardHandleOptions } from '../../shared/server.BjiJH9Vo.js';
-import { S as StandardRPCHandlerOptions } from '../../shared/server.Cy1vfSiG.js';
+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 '@orpc/client';
 import '@orpc/contract';
 import '@orpc/standard-server';
 import '@orpc/client/standard';
 
+type experimental_MinimalWebsocket = Pick<WebSocket, 'addEventListener' | 'send'>;
 declare class experimental_WebsocketHandler<T extends Context> {
-    private readonly standardHandler;
+    #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: experimental_MinimalWebsocket, ...rest: MaybeOptionalOptions<Omit<FriendlyStandardHandleOptions<T>, 'prefix'>>): 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: experimental_MinimalWebsocket, data: string | ArrayBuffer | Blob, ...rest: MaybeOptionalOptions<Omit<FriendlyStandardHandleOptions<T>, 'prefix'>>): Promise<void>;
+    /**
+     * Closes the WebSocket peer and cleans up.
+     *
+     * @warning Avoid calling this directly if `.upgrade()` is used.
+     */
+    close(ws: experimental_MinimalWebsocket): void;
 }
 
 /**
@@ -25,3 +48,4 @@ declare class experimental_RPCHandler<T extends Context> extends experimental_We
 }
 
 export { experimental_RPCHandler, experimental_WebsocketHandler };
+export type { experimental_MinimalWebsocket };

package/dist/adapters/websocket/index.mjs

@@ -1,31 +1,62 @@
 import { resolveMaybeOptionalOptions } from '@orpc/shared';
 import { ServerPeer } from '@orpc/standard-server-peer';
-import { r as resolveFriendlyStandardHandleOptions } from '../../shared/server.BVwwTHyO.mjs';
+import { r as resolveFriendlyStandardHandleOptions } from '../../shared/server.DZ5BIITo.mjs';
 import '@orpc/client';
 import '@orpc/standard-server';
 import '@orpc/contract';
-import { b as StandardRPCHandler } from '../../shared/server.4FnxLwwr.mjs';
+import { b as StandardRPCHandler } from '../../shared/server.CHvOkcM3.mjs';
 import '@orpc/client/standard';
 import '../../shared/server.DG7Tamti.mjs';
 
 class experimental_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 [id, request] = await peer.message(event.data);
-      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 data.arrayBuffer() : data;
+    const [id, request] = await peer.message(message);
+    if (!request) {
+      return;
+    }
+    const options = resolveFriendlyStandardHandleOptions(resolveMaybeOptionalOptions(rest));
+    const { response } = await this.#handler.handle({ ...request, body: () => Promise.resolve(request.body) }, options);
+    await peer.response(id, response ?? { status: 404, headers: {}, body: "No procedure matched" });
+  }
+  /**
+   * 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();
-    });
+    }
   }
 }
 

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

@@ -1,9 +1,9 @@
 import { MaybeOptionalOptions } from '@orpc/shared';
 import { WebSocket } from 'ws';
-import { C as Context, R as Router } from '../../shared/server.DPWk5pjW.mjs';
-import { i as StandardHandler } from '../../shared/server.eWLxY3lq.mjs';
-import { F as FriendlyStandardHandleOptions } from '../../shared/server.QUe9N8P4.mjs';
-import { S as StandardRPCHandlerOptions } from '../../shared/server.BRoxSiSC.mjs';
+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 '@orpc/client';
 import '@orpc/contract';
 import '@orpc/standard-server';

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

@@ -1,9 +1,9 @@
 import { MaybeOptionalOptions } from '@orpc/shared';
 import { WebSocket } from 'ws';
-import { C as Context, R as Router } from '../../shared/server.DPWk5pjW.js';
-import { i as StandardHandler } from '../../shared/server.YZzrREz9.js';
-import { F as FriendlyStandardHandleOptions } from '../../shared/server.BjiJH9Vo.js';
-import { S as StandardRPCHandlerOptions } from '../../shared/server.Cy1vfSiG.js';
+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 '@orpc/client';
 import '@orpc/contract';
 import '@orpc/standard-server';

package/dist/adapters/ws/index.mjs

@@ -1,10 +1,10 @@
 import { resolveMaybeOptionalOptions } from '@orpc/shared';
 import { ServerPeer } from '@orpc/standard-server-peer';
-import { r as resolveFriendlyStandardHandleOptions } from '../../shared/server.BVwwTHyO.mjs';
+import { r as resolveFriendlyStandardHandleOptions } from '../../shared/server.DZ5BIITo.mjs';
 import '@orpc/client';
 import '@orpc/standard-server';
 import '@orpc/contract';
-import { b as StandardRPCHandler } from '../../shared/server.4FnxLwwr.mjs';
+import { b as StandardRPCHandler } from '../../shared/server.CHvOkcM3.mjs';
 import '@orpc/client/standard';
 import '../../shared/server.DG7Tamti.mjs';
 
@@ -15,7 +15,8 @@ class experimental_WsHandler {
   async upgrade(ws, ...rest) {
     const peer = new ServerPeer(ws.send.bind(ws));
     ws.addEventListener("message", async (event) => {
-      const [id, request] = await peer.message(new Blob(Array.isArray(event.data) ? event.data : [event.data]));
+      const message = Array.isArray(event.data) ? await new Blob(event.data).arrayBuffer() : event.data;
+      const [id, request] = await peer.message(message);
       if (!request) {
         return;
       }

package/dist/hibernation/index.d.mts

@@ -0,0 +1,44 @@
+import { StandardRPCJsonSerializerOptions } from '@orpc/client/standard';
+import { a as StandardHandlerPlugin, b as StandardHandlerOptions } from '../shared/server.Dq8xr7PQ.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.DD2C4ujN.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: number, payload: unknown, options?: experimental_EncodeHibernationRPCEventOptions): string;
+
+interface experimental_HibernationContext {
+    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 HIBERNATION_CONTEXT_SYMBOL: symbol;
+    order: number;
+    init(options: StandardHandlerOptions<T>, _router: Router<any, T>): void;
+}
+
+export { experimental_HibernationPlugin, experimental_encodeHibernationRPCEvent };
+export type { experimental_EncodeHibernationRPCEventOptions, experimental_HibernationContext };

package/dist/hibernation/index.d.ts

@@ -0,0 +1,44 @@
+import { StandardRPCJsonSerializerOptions } from '@orpc/client/standard';
+import { a as StandardHandlerPlugin, b as StandardHandlerOptions } from '../shared/server.-ACo36I0.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.DD2C4ujN.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: number, payload: unknown, options?: experimental_EncodeHibernationRPCEventOptions): string;
+
+interface experimental_HibernationContext {
+    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 HIBERNATION_CONTEXT_SYMBOL: symbol;
+    order: number;
+    init(options: StandardHandlerOptions<T>, _router: Router<any, T>): void;
+}
+
+export { experimental_HibernationPlugin, experimental_encodeHibernationRPCEvent };
+export type { experimental_EncodeHibernationRPCEventOptions, experimental_HibernationContext };

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 {
+  HIBERNATION_CONTEXT_SYMBOL = Symbol("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.HIBERNATION_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.HIBERNATION_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, ClientPromiseResult } from '@orpc/client';
+import { ORPCErrorJSON, ORPCError, Client, ClientContext, HTTPPath, HTTPMethod, 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 { 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.DPWk5pjW.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.DPWk5pjW.mjs';
+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';
 export { getEventMeta, withEventMeta } from '@orpc/standard-server';
 
 type ActionableError<T> = T extends ORPCError<infer U, infer V> ? ORPCErrorJSON<U, V> & {
@@ -789,6 +789,11 @@ type Implementer<TContract extends AnyContractRouter, TInitialContext extends Co
 } & ImplementerInternal<TContract, TInitialContext, TCurrentContext>;
 declare function implement<T extends AnyContractRouter, TContext extends Context = Record<never, never>>(contract: T, config?: BuilderConfig): Implementer<T, TContext, TContext>;
 
+/**
+ * Help RPCLink automatically send requests using the specified HTTP method in the router.
+ */
+declare function inferRPCMethodFromRouter(router: AnyRouter): (options: unknown, path: readonly string[]) => Promise<Exclude<HTTPMethod, 'HEAD'>>;
+
 declare function isStartWithMiddlewares(middlewares: readonly AnyMiddleware[], compare: readonly AnyMiddleware[]): boolean;
 declare function mergeMiddlewares(first: readonly AnyMiddleware[], second: readonly AnyMiddleware[], options: {
     dedupeLeading: boolean;
@@ -825,5 +830,5 @@ declare function createRouterClient<T extends AnyRouter, TClientContext extends
 declare function setHiddenRouterContract<T extends Lazyable<AnyRouter>>(router: T, contract: AnyContractRouter): T;
 declare function getHiddenRouterContract(router: Lazyable<AnyRouter | AnyContractRouter>): AnyContractRouter | undefined;
 
-export { AnyMiddleware, AnyProcedure, AnyRouter, Builder, Context, CreateProcedureClientOptions, DecoratedProcedure, InferRouterInitialContext, Lazy, Lazyable, MapInputMiddleware, MergedCurrentContext, MergedInitialContext, Middleware, ORPCErrorConstructorMap, Procedure, ProcedureClient, ProcedureHandler, Router, addMiddleware, call, createAccessibleLazyRouter, createActionableClient, createAssertedLazyProcedure, createContractedProcedure, createRouterClient, decorateMiddleware, enhanceRouter, fallbackConfig, getHiddenRouterContract, getRouter, implement, implementerInternal, isStartWithMiddlewares, mergeMiddlewares, os, resolveContractProcedures, setHiddenRouterContract, traverseContractProcedures, unlazyRouter };
+export { AnyMiddleware, AnyProcedure, AnyRouter, Builder, Context, CreateProcedureClientOptions, DecoratedProcedure, InferRouterInitialContext, Lazy, Lazyable, MapInputMiddleware, MergedCurrentContext, MergedInitialContext, Middleware, ORPCErrorConstructorMap, Procedure, ProcedureClient, ProcedureHandler, Router, addMiddleware, call, createAccessibleLazyRouter, createActionableClient, createAssertedLazyProcedure, createContractedProcedure, createRouterClient, decorateMiddleware, enhanceRouter, fallbackConfig, getHiddenRouterContract, getRouter, implement, implementerInternal, inferRPCMethodFromRouter, isStartWithMiddlewares, mergeMiddlewares, os, resolveContractProcedures, setHiddenRouterContract, traverseContractProcedures, unlazyRouter };
 export type { AccessibleLazyRouter, ActionableClient, ActionableClientRest, ActionableClientResult, ActionableError, BuilderConfig, BuilderDef, BuilderWithMiddlewares, Config, ContractProcedureCallbackOptions, DecoratedMiddleware, EnhanceRouterOptions, EnhancedRouter, ImplementedProcedure, Implementer, ImplementerInternal, ImplementerInternalWithMiddlewares, LazyTraverseContractProceduresOptions, ProcedureActionableClient, ProcedureBuilder, ProcedureBuilderWithInput, ProcedureBuilderWithInputOutput, ProcedureBuilderWithOutput, ProcedureImplementer, RouterBuilder, RouterClient, RouterImplementer, RouterImplementerWithMiddlewares, TraverseContractProceduresOptions, UnactionableError, UnlaziedRouter };

package/dist/index.d.ts

@@ -1,11 +1,11 @@
-import { ORPCErrorJSON, ORPCError, Client, ClientContext, HTTPPath, ClientPromiseResult } from '@orpc/client';
+import { ORPCErrorJSON, ORPCError, Client, ClientContext, HTTPPath, HTTPMethod, 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 { 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.DPWk5pjW.js';
-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.DPWk5pjW.js';
+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.js';
+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.js';
 export { getEventMeta, withEventMeta } from '@orpc/standard-server';
 
 type ActionableError<T> = T extends ORPCError<infer U, infer V> ? ORPCErrorJSON<U, V> & {
@@ -789,6 +789,11 @@ type Implementer<TContract extends AnyContractRouter, TInitialContext extends Co
 } & ImplementerInternal<TContract, TInitialContext, TCurrentContext>;
 declare function implement<T extends AnyContractRouter, TContext extends Context = Record<never, never>>(contract: T, config?: BuilderConfig): Implementer<T, TContext, TContext>;
 
+/**
+ * Help RPCLink automatically send requests using the specified HTTP method in the router.
+ */
+declare function inferRPCMethodFromRouter(router: AnyRouter): (options: unknown, path: readonly string[]) => Promise<Exclude<HTTPMethod, 'HEAD'>>;
+
 declare function isStartWithMiddlewares(middlewares: readonly AnyMiddleware[], compare: readonly AnyMiddleware[]): boolean;
 declare function mergeMiddlewares(first: readonly AnyMiddleware[], second: readonly AnyMiddleware[], options: {
     dedupeLeading: boolean;
@@ -825,5 +830,5 @@ declare function createRouterClient<T extends AnyRouter, TClientContext extends
 declare function setHiddenRouterContract<T extends Lazyable<AnyRouter>>(router: T, contract: AnyContractRouter): T;
 declare function getHiddenRouterContract(router: Lazyable<AnyRouter | AnyContractRouter>): AnyContractRouter | undefined;
 
-export { AnyMiddleware, AnyProcedure, AnyRouter, Builder, Context, CreateProcedureClientOptions, DecoratedProcedure, InferRouterInitialContext, Lazy, Lazyable, MapInputMiddleware, MergedCurrentContext, MergedInitialContext, Middleware, ORPCErrorConstructorMap, Procedure, ProcedureClient, ProcedureHandler, Router, addMiddleware, call, createAccessibleLazyRouter, createActionableClient, createAssertedLazyProcedure, createContractedProcedure, createRouterClient, decorateMiddleware, enhanceRouter, fallbackConfig, getHiddenRouterContract, getRouter, implement, implementerInternal, isStartWithMiddlewares, mergeMiddlewares, os, resolveContractProcedures, setHiddenRouterContract, traverseContractProcedures, unlazyRouter };
+export { AnyMiddleware, AnyProcedure, AnyRouter, Builder, Context, CreateProcedureClientOptions, DecoratedProcedure, InferRouterInitialContext, Lazy, Lazyable, MapInputMiddleware, MergedCurrentContext, MergedInitialContext, Middleware, ORPCErrorConstructorMap, Procedure, ProcedureClient, ProcedureHandler, Router, addMiddleware, call, createAccessibleLazyRouter, createActionableClient, createAssertedLazyProcedure, createContractedProcedure, createRouterClient, decorateMiddleware, enhanceRouter, fallbackConfig, getHiddenRouterContract, getRouter, implement, implementerInternal, inferRPCMethodFromRouter, isStartWithMiddlewares, mergeMiddlewares, os, resolveContractProcedures, setHiddenRouterContract, traverseContractProcedures, unlazyRouter };
 export type { AccessibleLazyRouter, ActionableClient, ActionableClientRest, ActionableClientResult, ActionableError, BuilderConfig, BuilderDef, BuilderWithMiddlewares, Config, ContractProcedureCallbackOptions, DecoratedMiddleware, EnhanceRouterOptions, EnhancedRouter, ImplementedProcedure, Implementer, ImplementerInternal, ImplementerInternalWithMiddlewares, LazyTraverseContractProceduresOptions, ProcedureActionableClient, ProcedureBuilder, ProcedureBuilderWithInput, ProcedureBuilderWithInputOutput, ProcedureBuilderWithOutput, ProcedureImplementer, RouterBuilder, RouterClient, RouterImplementer, RouterImplementerWithMiddlewares, TraverseContractProceduresOptions, UnactionableError, UnlaziedRouter };

package/dist/index.mjs

@@ -1,10 +1,11 @@
-import { mergeErrorMap, mergeMeta, mergeRoute, mergePrefix, mergeTags, isContractProcedure, getContractRouter } from '@orpc/contract';
+import { mergeErrorMap, mergeMeta, mergeRoute, mergePrefix, mergeTags, isContractProcedure, getContractRouter, fallbackContractConfig } from '@orpc/contract';
 export { ValidationError, eventIterator, type } from '@orpc/contract';
-import { P as Procedure, b as addMiddleware, c as createProcedureClient, e as enhanceRouter, l as lazy, s as setHiddenRouterContract, i as isProcedure, d as isLazy, f as createAssertedLazyProcedure, g as getRouter } from './shared/server.DG7Tamti.mjs';
-export { L as LAZY_SYMBOL, p as call, r as createAccessibleLazyRouter, a as createContractedProcedure, h as createORPCErrorConstructorMap, q as getHiddenRouterContract, j as getLazyMeta, n as isStartWithMiddlewares, m as mergeCurrentContext, o as mergeMiddlewares, k as middlewareOutputFn, w as resolveContractProcedures, t as traverseContractProcedures, u as unlazy, x as unlazyRouter, v as validateORPCError } from './shared/server.DG7Tamti.mjs';
+import { P as Procedure, b as addMiddleware, c as createProcedureClient, e as enhanceRouter, l as lazy, s as setHiddenRouterContract, u as unlazy, g as getRouter, i as isProcedure, d as isLazy, f as createAssertedLazyProcedure } from './shared/server.DG7Tamti.mjs';
+export { L as LAZY_SYMBOL, p as call, r as createAccessibleLazyRouter, a as createContractedProcedure, h as createORPCErrorConstructorMap, q as getHiddenRouterContract, j as getLazyMeta, n as isStartWithMiddlewares, m as mergeCurrentContext, o as mergeMiddlewares, k as middlewareOutputFn, w as resolveContractProcedures, t as traverseContractProcedures, x as unlazyRouter, v as validateORPCError } from './shared/server.DG7Tamti.mjs';
 import { toORPCError } from '@orpc/client';
 export { ORPCError, isDefinedError, safe } from '@orpc/client';
-export { onError, onFinish, onStart, onSuccess } from '@orpc/shared';
+import { resolveMaybeOptionalOptions } from '@orpc/shared';
+export { EventPublisher, onError, onFinish, onStart, onSuccess } from '@orpc/shared';
 export { getEventMeta, withEventMeta } from '@orpc/standard-server';
 
 const DEFAULT_CONFIG = {
@@ -447,12 +448,25 @@ function implement(contract, config = {}) {
   return impl;
 }
 
+function inferRPCMethodFromRouter(router) {
+  return async (_, path) => {
+    const { default: procedure } = await unlazy(getRouter(router, path));
+    if (!isProcedure(procedure)) {
+      throw new Error(
+        `[inferRPCMethodFromRouter] No valid procedure found at path "${path.join(".")}". This may happen when the router is not properly configured.`
+      );
+    }
+    const method = fallbackContractConfig("defaultMethod", procedure["~orpc"].route.method);
+    return method === "HEAD" ? "GET" : method;
+  };
+}
+
 function createRouterClient(router, ...rest) {
   if (isProcedure(router)) {
-    const caller = createProcedureClient(router, ...rest);
+    const caller = createProcedureClient(router, resolveMaybeOptionalOptions(rest));
     return caller;
   }
-  const procedureCaller = isLazy(router) ? createProcedureClient(createAssertedLazyProcedure(router), ...rest) : {};
+  const procedureCaller = isLazy(router) ? createProcedureClient(createAssertedLazyProcedure(router), resolveMaybeOptionalOptions(rest)) : {};
   const recursive = new Proxy(procedureCaller, {
     get(target, key) {
       if (typeof key !== "string") {
@@ -471,4 +485,4 @@ function createRouterClient(router, ...rest) {
   return recursive;
 }
 
-export { Builder, DecoratedProcedure, Procedure, addMiddleware, createActionableClient, createAssertedLazyProcedure, createProcedureClient, createRouterClient, decorateMiddleware, enhanceRouter, fallbackConfig, getRouter, implement, implementerInternal, isLazy, isProcedure, lazy, os, setHiddenRouterContract };
+export { Builder, DecoratedProcedure, Procedure, addMiddleware, createActionableClient, createAssertedLazyProcedure, createProcedureClient, createRouterClient, decorateMiddleware, enhanceRouter, fallbackConfig, getRouter, implement, implementerInternal, inferRPCMethodFromRouter, isLazy, isProcedure, lazy, os, setHiddenRouterContract, unlazy };

package/dist/plugins/index.d.mts

@@ -1,8 +1,8 @@
-import { Value } from '@orpc/shared';
+import { Value, Promisable } from '@orpc/shared';
 import { StandardRequest, StandardHeaders } from '@orpc/standard-server';
 import { BatchResponseBodyItem } from '@orpc/standard-server/batch';
-import { S as StandardHandlerInterceptorOptions, a as StandardHandlerPlugin, b as StandardHandlerOptions } from '../shared/server.eWLxY3lq.mjs';
-import { C as Context, F as ProcedureClientInterceptorOptions } from '../shared/server.DPWk5pjW.mjs';
+import { S as StandardHandlerInterceptorOptions, a as StandardHandlerPlugin, b as StandardHandlerOptions } from '../shared/server.Dq8xr7PQ.mjs';
+import { C as Context, F as ProcedureClientInterceptorOptions } from '../shared/server.DD2C4ujN.mjs';
 import { Meta, ORPCError as ORPCError$1 } from '@orpc/contract';
 import { ORPCError } from '@orpc/client';
 
@@ -12,7 +12,7 @@ interface BatchHandlerOptions<T extends Context> {
      *
      * @default 10
      */
-    maxSize?: Value<number, [StandardHandlerInterceptorOptions<T>]>;
+    maxSize?: Value<Promisable<number>, [StandardHandlerInterceptorOptions<T>]>;
     /**
      * Map the request before processing it.
      *
@@ -24,19 +24,19 @@ interface BatchHandlerOptions<T extends Context> {
      *
      * @default 207
      */
-    successStatus?: Value<number, [responses: Promise<BatchResponseBodyItem>[], batchOptions: StandardHandlerInterceptorOptions<T>]>;
+    successStatus?: Value<Promisable<number>, [responses: Promise<BatchResponseBodyItem>[], batchOptions: StandardHandlerInterceptorOptions<T>]>;
     /**
      * success batch response headers.
      *
      * @default {}
      */
-    headers?: Value<StandardHeaders, [responses: Promise<BatchResponseBodyItem>[], batchOptions: StandardHandlerInterceptorOptions<T>]>;
+    headers?: Value<Promisable<StandardHeaders>, [responses: Promise<BatchResponseBodyItem>[], batchOptions: StandardHandlerInterceptorOptions<T>]>;
 }
 /**
- * The Batch Request/Response Plugin allows you to combine multiple requests and responses into a single batch,
+ * The Batch Requests Plugin allows you to combine multiple requests and responses into a single batch,
  * reducing the overhead of sending each one separately.
  *
- * @see {@link https://orpc.unnoq.com/docs/plugins/batch-request-response Batch Request/Response Plugin Docs}
+ * @see {@link https://orpc.unnoq.com/docs/plugins/batch-requests Batch Requests Plugin Docs}
  */
 declare class BatchHandlerPlugin<T extends Context> implements StandardHandlerPlugin<T> {
     private readonly maxSize;
@@ -49,8 +49,8 @@ declare class BatchHandlerPlugin<T extends Context> implements StandardHandlerPl
 }
 
 interface CORSOptions<T extends Context> {
-    origin?: Value<string | readonly string[] | null | undefined, [origin: string, options: StandardHandlerInterceptorOptions<T>]>;
-    timingOrigin?: Value<string | readonly string[] | null | undefined, [origin: string, options: StandardHandlerInterceptorOptions<T>]>;
+    origin?: Value<Promisable<string | readonly string[] | null | undefined>, [origin: string, options: StandardHandlerInterceptorOptions<T>]>;
+    timingOrigin?: Value<Promisable<string | readonly string[] | null | undefined>, [origin: string, options: StandardHandlerInterceptorOptions<T>]>;
     allowMethods?: readonly string[];
     allowHeaders?: readonly string[];
     maxAge?: number;
@@ -88,21 +88,21 @@ interface SimpleCsrfProtectionHandlerPluginOptions<T extends Context> {
      *
      * @default 'x-csrf-token'
      */
-    headerName?: Value<string, [options: StandardHandlerInterceptorOptions<T>]>;
+    headerName?: Value<Promisable<string>, [options: StandardHandlerInterceptorOptions<T>]>;
     /**
      * The value of the header to check.
      *
      * @default 'orpc'
      *
      */
-    headerValue?: Value<string, [options: StandardHandlerInterceptorOptions<T>]>;
+    headerValue?: Value<Promisable<string>, [options: StandardHandlerInterceptorOptions<T>]>;
     /**
      * Exclude a procedure from the plugin.
      *
      * @default false
      *
      */
-    exclude?: Value<boolean, [options: ProcedureClientInterceptorOptions<T, Record<never, never>, Meta>]>;
+    exclude?: Value<Promisable<boolean>, [options: ProcedureClientInterceptorOptions<T, Record<never, never>, Meta>]>;
     /**
      * The error thrown when the CSRF token is invalid.
      *