@orpc/client 2.0.0-beta.4 → 2.0.0-beta.41

package/dist/adapters/fetch/index.mjs

@@ -1,37 +1,37 @@
-import { sortPlugins, value, intercept } from '@orpc/shared';
-import { toFetchBody, toFetchHeaders, toStandardLazyResponse } from '@standardserver/fetch';
-import { S as StandardLink, R as RPCLinkCodec } from '../../shared/client.DXhchJ84.mjs';
-import '@standardserver/core';
-import '../../shared/client.Dnfj8jnT.mjs';
-import '../../shared/client.DMXKFDyV.mjs';
+import { value, once } from '@orpc/shared';
+import { toFetchBody, toFetchHeaders, toStandardLazyResponse } from '@standard-server/fetch';
+import { S as StandardLink, R as RPCLinkCodec } from '../../shared/client.Bstqyaro.mjs';
+import '@standard-server/core';
+import '../../shared/client.DpkGsZt-.mjs';
+import '../../shared/client.DD2eNne_.mjs';
 
-class CompositeFetchLinkTransportPlugin {
-  constructor(plugins = []) {
-    this.plugins = plugins;
-    this.plugins = sortPlugins(plugins);
-  }
-  name = "~composite/fetch-link-transport";
-  initFetchLinkTransportOptions(options) {
-    for (const plugin of this.plugins) {
-      if (plugin.initFetchLinkTransportOptions) {
-        options = plugin.initFetchLinkTransportOptions(options);
+const GET_SUPPORTED_DUPLEX_MODE = once(() => {
+  try {
+    let duplex;
+    void new Request(
+      "https://example.com",
+      {
+        method: "POST",
+        body: new ReadableStream(),
+        get duplex() {
+          duplex = "half";
+          return "half";
+        }
       }
-    }
-    return options;
+    );
+    return duplex;
+  } catch {
+    return void 0;
   }
-}
-
+});
 class FetchLinkTransport {
   origin;
   fetch;
   toFetchRequestOptions;
-  fetchInterceptors;
   constructor(options) {
-    options = new CompositeFetchLinkTransportPlugin(options.plugins).initFetchLinkTransportOptions(options);
     this.origin = options.origin;
-    this.fetch = options.fetch ?? globalThis.fetch.bind(globalThis);
+    this.fetch = options.fetch ?? ((url, init) => globalThis.fetch(url, init));
     this.toFetchRequestOptions = options.toFetchRequest;
-    this.fetchInterceptors = options.fetchInterceptors;
   }
   async send(standardRequest, path, options) {
     let origin = await value(this.origin, options, path);
@@ -47,11 +47,14 @@ class FetchLinkTransport {
       signal: options.signal,
       redirect: "manual"
     };
-    const response = await intercept(
-      this.fetchInterceptors,
-      { ...options, url, path, init },
-      ({ url: url2, path: path2, init: init2, ...options2 }) => this.fetch(url2, init2, options2, path2)
-    );
+    if (body instanceof ReadableStream) {
+      const duplex = GET_SUPPORTED_DUPLEX_MODE();
+      if (duplex !== void 0) {
+        init.duplex = duplex;
+      }
+    }
+    const fetch = this.fetch;
+    const response = await fetch(url, init, options, path);
     const standardResponse = toStandardLazyResponse(response);
     return standardResponse;
   }
@@ -65,4 +68,4 @@ class RPCLink extends StandardLink {
   }
 }
 
-export { CompositeFetchLinkTransportPlugin, FetchLinkTransport, RPCLink };
+export { FetchLinkTransport, RPCLink };

package/dist/adapters/message-port/index.d.mts

@@ -1,10 +1,10 @@
-import { C as ClientContext, a as ClientOptions } from '../../shared/client.8ug8I-zu.mjs';
+import { ClientContext, ClientOptions } from '../../index.mjs';
 import { Value, Promisable } from '@orpc/shared';
-import { StandardRequest, StandardLazyResponse } from '@standardserver/core';
-import { ClientPeer, EncodePeerMessageOptions, DecodePeerMessageOptions } from '@standardserver/peer';
-import { S as StandardLinkTransport, a as StandardLink, b as StandardLinkOptions } from '../../shared/client.Cby_-GGh.mjs';
+import { StandardRequest, StandardLazyResponse } from '@standard-server/core';
+import { ClientPeer, EncodePeerMessageOptions, DecodePeerMessageOptions } from '@standard-server/peer';
+import { StandardLinkTransport, StandardLink, StandardLinkOptions } from '../standard/index.mjs';
 import { RPCLinkCodecOptions } from '../standard/index.mjs';
-import '../../shared/client.BdItY5DT.mjs';
+import '../../shared/client.BPa_Mmuh.mjs';
 
 /**
  * The message port used by electron in main process
@@ -45,9 +45,8 @@ interface MessagePortLinkTransportOptions<_T extends ClientContext> {
      * such as transferring ownership of objects to the other side or support unserializable objects like `OffscreenCanvas`.
      *
      * @remarks
-     * - return null | undefined to disable this feature
-     *
-     * @warning Make sure your message port supports `transfer` before using this feature.
+     * **Note**: Returning `null` or `undefined` disables this feature.
+     * **Warning**: Make sure your message port supports `transfer` before using this feature.
      */
     experimental_transfer?: Value<Promisable<object[] | null | undefined>, [message: DecodedRequestMessage, port: SupportedMessagePort]>;
     /**
@@ -67,6 +66,12 @@ declare class MessagePortLinkTransport<T extends ClientContext> implements Stand
 
 interface RPCLinkOptions<T extends ClientContext> extends StandardLinkOptions<T>, MessagePortLinkTransportOptions<T>, RPCLinkCodecOptions<T> {
 }
+/**
+ * Client link that communicates with an RPC Handler over a Message Port
+ * (e.g. workers, iframes, browser extensions, Electron).
+ *
+ * @see {@link https://orpc.dev/docs/adapters/message-port | Message Port Adapter}
+ */
 declare class RPCLink<T extends ClientContext> extends StandardLink<T> {
     constructor(options: RPCLinkOptions<T>);
 }

package/dist/adapters/message-port/index.d.ts

@@ -1,10 +1,10 @@
-import { C as ClientContext, a as ClientOptions } from '../../shared/client.8ug8I-zu.js';
+import { ClientContext, ClientOptions } from '../../index.js';
 import { Value, Promisable } from '@orpc/shared';
-import { StandardRequest, StandardLazyResponse } from '@standardserver/core';
-import { ClientPeer, EncodePeerMessageOptions, DecodePeerMessageOptions } from '@standardserver/peer';
-import { S as StandardLinkTransport, a as StandardLink, b as StandardLinkOptions } from '../../shared/client.CPF3hX6O.js';
+import { StandardRequest, StandardLazyResponse } from '@standard-server/core';
+import { ClientPeer, EncodePeerMessageOptions, DecodePeerMessageOptions } from '@standard-server/peer';
+import { StandardLinkTransport, StandardLink, StandardLinkOptions } from '../standard/index.js';
 import { RPCLinkCodecOptions } from '../standard/index.js';
-import '../../shared/client.BdItY5DT.js';
+import '../../shared/client.BPa_Mmuh.js';
 
 /**
  * The message port used by electron in main process
@@ -45,9 +45,8 @@ interface MessagePortLinkTransportOptions<_T extends ClientContext> {
      * such as transferring ownership of objects to the other side or support unserializable objects like `OffscreenCanvas`.
      *
      * @remarks
-     * - return null | undefined to disable this feature
-     *
-     * @warning Make sure your message port supports `transfer` before using this feature.
+     * **Note**: Returning `null` or `undefined` disables this feature.
+     * **Warning**: Make sure your message port supports `transfer` before using this feature.
      */
     experimental_transfer?: Value<Promisable<object[] | null | undefined>, [message: DecodedRequestMessage, port: SupportedMessagePort]>;
     /**
@@ -67,6 +66,12 @@ declare class MessagePortLinkTransport<T extends ClientContext> implements Stand
 
 interface RPCLinkOptions<T extends ClientContext> extends StandardLinkOptions<T>, MessagePortLinkTransportOptions<T>, RPCLinkCodecOptions<T> {
 }
+/**
+ * Client link that communicates with an RPC Handler over a Message Port
+ * (e.g. workers, iframes, browser extensions, Electron).
+ *
+ * @see {@link https://orpc.dev/docs/adapters/message-port | Message Port Adapter}
+ */
 declare class RPCLink<T extends ClientContext> extends StandardLink<T> {
     constructor(options: RPCLinkOptions<T>);
 }

package/dist/adapters/message-port/index.mjs

@@ -1,10 +1,10 @@
-import { value, isPlainObject, toStringOrBytes } from '@orpc/shared';
-import { ClientPeer, encodePeerMessage, decodePeerMessage, isServerPeerSendMessage } from '@standardserver/peer';
-import { S as StandardLink, R as RPCLinkCodec } from '../../shared/client.DXhchJ84.mjs';
-import '@standardserver/core';
-import '@standardserver/fetch';
-import '../../shared/client.Dnfj8jnT.mjs';
-import '../../shared/client.DMXKFDyV.mjs';
+import { value, AbortError } from '@orpc/shared';
+import { ClientPeer, encodePeerMessage, decodePeerMessage, isServerPeerSendMessage, isPeerMessage } from '@standard-server/peer';
+import { S as StandardLink, R as RPCLinkCodec } from '../../shared/client.Bstqyaro.mjs';
+import '@standard-server/core';
+import '@standard-server/fetch';
+import '../../shared/client.DpkGsZt-.mjs';
+import '../../shared/client.DD2eNne_.mjs';
 
 function postMessagePortMessage(port, data, transfer) {
   if (transfer) {
@@ -51,7 +51,11 @@ function onMessagePortClose(port, callback) {
 class MessagePortLinkTransport {
   peer;
   constructor({ port, experimental_transfer, encodePeerMessage: encodePeerMessageOptions, decodePeerMessage: decodePeerMessageOptions }) {
+    let closeReason;
     this.peer = new ClientPeer(async (message) => {
+      if (closeReason) {
+        throw closeReason;
+      }
       const transfer = await value(experimental_transfer, message, port);
       if (transfer) {
         postMessagePortMessage(port, message, transfer);
@@ -59,19 +63,25 @@ class MessagePortLinkTransport {
         postMessagePortMessage(port, await encodePeerMessage(message, encodePeerMessageOptions));
       }
     });
-    onMessagePortMessage(port, async (message) => {
-      if (isPlainObject(message)) {
-        await this.peer.message(message);
-        return;
+    onMessagePortMessage(port, async (data) => {
+      let peerMessage;
+      if (typeof data === "string" || data instanceof Uint8Array) {
+        const result = decodePeerMessage(data, decodePeerMessageOptions);
+        if (result.matched && isServerPeerSendMessage(result.message)) {
+          peerMessage = result.message;
+        }
+      } else if (isPeerMessage(data) && isServerPeerSendMessage(data)) {
+        peerMessage = data;
       }
-      const encodedMessage = await toStringOrBytes(message);
-      const result = decodePeerMessage(encodedMessage, decodePeerMessageOptions);
-      if (result.matched && isServerPeerSendMessage(result.message)) {
-        await this.peer.message(result.message);
+      if (peerMessage === void 0) {
+        return { matched: false };
       }
+      await this.peer.message(peerMessage);
+      return { matched: true };
     });
-    onMessagePortClose(port, () => {
-      this.peer.close();
+    onMessagePortClose(port, async () => {
+      closeReason = new AbortError("MessagePort closed");
+      await this.peer.close(closeReason);
     });
   }
   async send(standardRequest, _path, _options) {

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

@@ -1,10 +1,9 @@
-import { f as StandardLinkCodec, g as StandardLinkCodecDecodedResponse } from '../../shared/client.Cby_-GGh.mjs';
-export { C as CompositeStandardLinkPlugin, a as StandardLink, h as StandardLinkInterceptor, e as StandardLinkInterceptorOptions, b as StandardLinkOptions, c as StandardLinkPlugin, S as StandardLinkTransport, i as StandardLinkTransportInterceptor, d as StandardLinkTransportInterceptorOptions } from '../../shared/client.Cby_-GGh.mjs';
-import { Value, Promisable } from '@orpc/shared';
-import { StandardUrl, StandardHeaders, StandardRequest, StandardLazyResponse } from '@standardserver/core';
-export { StandardBody, StandardBodyHint, StandardHeaders, StandardLazyRequest, StandardLazyResponse, StandardMethod, StandardRequest, StandardResponse, StandardUrl } from '@standardserver/core';
-import { C as ClientContext, a as ClientOptions } from '../../shared/client.8ug8I-zu.mjs';
-import { e as RPCSerializer } from '../../shared/client.BdItY5DT.mjs';
+import { f as StandardLinkCodec, g as StandardLinkCodecDecodedResponse } from '../../shared/client.BjbdW5Rj.mjs';
+export { C as CompositeStandardLinkPlugin, a as StandardLink, h as StandardLinkInterceptor, e as StandardLinkInterceptorOptions, b as StandardLinkOptions, c as StandardLinkPlugin, S as StandardLinkTransport, i as StandardLinkTransportInterceptor, d as StandardLinkTransportInterceptorOptions } from '../../shared/client.BjbdW5Rj.mjs';
+import { Value, Promisable, Public } from '@orpc/shared';
+import { StandardUrl, StandardHeaders, StandardRequest, StandardLazyResponse } from '@standard-server/core';
+import { ClientContext, ClientOptions } from '../../index.mjs';
+import { RPCSerializer } from '../../index.mjs';
 
 interface RPCLinkCodecOptions<T extends ClientContext> {
     /**
@@ -28,14 +27,14 @@ interface RPCLinkCodecOptions<T extends ClientContext> {
      *
      * @default 'POST'
      */
-    method?: Value<Promisable<'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE'>, [options: ClientOptions<T>, path: string[], input: unknown]>;
+    method?: Value<Promisable<'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE' | 'QUERY'>, [options: ClientOptions<T>, path: string[], input: unknown]>;
     /**
      * The method to use when the payload cannot safely pass to the server with method return from method function.
      * GET is not allowed, it's very dangerous.
      *
      * @default 'POST'
      */
-    fallbackMethod?: 'POST' | 'PUT' | 'PATCH' | 'DELETE';
+    fallbackMethod?: 'POST' | 'PUT' | 'PATCH' | 'DELETE' | 'QUERY';
     /**
      * Inject headers to the request.
      */
@@ -43,7 +42,7 @@ interface RPCLinkCodecOptions<T extends ClientContext> {
     /**
      * Override the default RPC serializer.
      */
-    serializer?: Pick<RPCSerializer, keyof RPCSerializer>;
+    serializer?: Public<RPCSerializer>;
 }
 declare class RPCLinkCodec<T extends ClientContext> implements StandardLinkCodec<T> {
     private readonly baseUrl;

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

@@ -1,10 +1,9 @@
-import { f as StandardLinkCodec, g as StandardLinkCodecDecodedResponse } from '../../shared/client.CPF3hX6O.js';
-export { C as CompositeStandardLinkPlugin, a as StandardLink, h as StandardLinkInterceptor, e as StandardLinkInterceptorOptions, b as StandardLinkOptions, c as StandardLinkPlugin, S as StandardLinkTransport, i as StandardLinkTransportInterceptor, d as StandardLinkTransportInterceptorOptions } from '../../shared/client.CPF3hX6O.js';
-import { Value, Promisable } from '@orpc/shared';
-import { StandardUrl, StandardHeaders, StandardRequest, StandardLazyResponse } from '@standardserver/core';
-export { StandardBody, StandardBodyHint, StandardHeaders, StandardLazyRequest, StandardLazyResponse, StandardMethod, StandardRequest, StandardResponse, StandardUrl } from '@standardserver/core';
-import { C as ClientContext, a as ClientOptions } from '../../shared/client.8ug8I-zu.js';
-import { e as RPCSerializer } from '../../shared/client.BdItY5DT.js';
+import { f as StandardLinkCodec, g as StandardLinkCodecDecodedResponse } from '../../shared/client.DiHfJmHK.js';
+export { C as CompositeStandardLinkPlugin, a as StandardLink, h as StandardLinkInterceptor, e as StandardLinkInterceptorOptions, b as StandardLinkOptions, c as StandardLinkPlugin, S as StandardLinkTransport, i as StandardLinkTransportInterceptor, d as StandardLinkTransportInterceptorOptions } from '../../shared/client.DiHfJmHK.js';
+import { Value, Promisable, Public } from '@orpc/shared';
+import { StandardUrl, StandardHeaders, StandardRequest, StandardLazyResponse } from '@standard-server/core';
+import { ClientContext, ClientOptions } from '../../index.js';
+import { RPCSerializer } from '../../index.js';
 
 interface RPCLinkCodecOptions<T extends ClientContext> {
     /**
@@ -28,14 +27,14 @@ interface RPCLinkCodecOptions<T extends ClientContext> {
      *
      * @default 'POST'
      */
-    method?: Value<Promisable<'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE'>, [options: ClientOptions<T>, path: string[], input: unknown]>;
+    method?: Value<Promisable<'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE' | 'QUERY'>, [options: ClientOptions<T>, path: string[], input: unknown]>;
     /**
      * The method to use when the payload cannot safely pass to the server with method return from method function.
      * GET is not allowed, it's very dangerous.
      *
      * @default 'POST'
      */
-    fallbackMethod?: 'POST' | 'PUT' | 'PATCH' | 'DELETE';
+    fallbackMethod?: 'POST' | 'PUT' | 'PATCH' | 'DELETE' | 'QUERY';
     /**
      * Inject headers to the request.
      */
@@ -43,7 +42,7 @@ interface RPCLinkCodecOptions<T extends ClientContext> {
     /**
      * Override the default RPC serializer.
      */
-    serializer?: Pick<RPCSerializer, keyof RPCSerializer>;
+    serializer?: Public<RPCSerializer>;
 }
 declare class RPCLinkCodec<T extends ClientContext> implements StandardLinkCodec<T> {
     private readonly baseUrl;

package/dist/adapters/standard/index.mjs

@@ -1,6 +1,6 @@
-export { C as CompositeStandardLinkPlugin, R as RPCLinkCodec, S as StandardLink } from '../../shared/client.DXhchJ84.mjs';
+export { C as CompositeStandardLinkPlugin, R as RPCLinkCodec, S as StandardLink } from '../../shared/client.Bstqyaro.mjs';
 import '@orpc/shared';
-import '@standardserver/core';
-import '@standardserver/fetch';
-import '../../shared/client.Dnfj8jnT.mjs';
-import '../../shared/client.DMXKFDyV.mjs';
+import '@standard-server/core';
+import '@standard-server/fetch';
+import '../../shared/client.DpkGsZt-.mjs';
+import '../../shared/client.DD2eNne_.mjs';

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

@@ -1,13 +1,13 @@
-import { C as ClientContext, a as ClientOptions } from '../../shared/client.8ug8I-zu.mjs';
+import { ClientContext, ClientOptions } from '../../index.mjs';
 import { Promisable } from '@orpc/shared';
-import { StandardRequest, StandardLazyResponse } from '@standardserver/core';
-import { EncodePeerMessageOptions, DecodePeerMessageOptions } from '@standardserver/peer';
-import { S as StandardLinkTransport, a as StandardLink, b as StandardLinkOptions } from '../../shared/client.Cby_-GGh.mjs';
+import { StandardRequest, StandardLazyResponse } from '@standard-server/core';
+import { EncodePeerMessageOptions, DecodePeerMessageOptions } from '@standard-server/peer';
+import { StandardLinkTransport, StandardLink, StandardLinkOptions } from '../standard/index.mjs';
 import { RPCLinkCodecOptions } from '../standard/index.mjs';
-import '../../shared/client.BdItY5DT.mjs';
+import '../../shared/client.BPa_Mmuh.mjs';
 
 type WebSocketLike = Pick<WebSocket, 'addEventListener' | 'removeEventListener' | 'send' | 'readyState'>;
-interface WebsocketLinkTransportAttemptInfo {
+interface WebSocketLinkTransportAttemptInfo {
     /**
      * Total number of connection attempts for this transport's lifetime.
      * Starts at 1 on the first attempt, increments on every subsequent
@@ -17,11 +17,11 @@ interface WebsocketLinkTransportAttemptInfo {
     /**
      * Attempt number within the current (re)connect cycle.
      * Starts at 1, increments on each consecutive failure, and resets to 1
-     * once a connection succeeds. Use this for backoff calculations.
+     * once a connection succeeds or the cycle gives up. Use this for backoff calculations.
      */
     attempt: number;
 }
-interface WebsocketLinkTransportReconnectOptions {
+interface WebSocketLinkTransportReconnectOptions {
     /**
      * Whether to automatically reconnect when the connection is lost.
      *
@@ -33,15 +33,24 @@ interface WebsocketLinkTransportReconnectOptions {
      *
      * @default info => info.attempt === 1 ? 0 : 2_000
      */
-    delay?: undefined | ((info: WebsocketLinkTransportAttemptInfo) => number);
+    delay?: undefined | ((info: WebSocketLinkTransportAttemptInfo) => number);
     /**
      * Maximum number of consecutive failed attempts before giving up.
-     * When exceeded, `getConnectedPeer` throws instead of retrying.
+     * When reached, calls waiting for the connection fail, and the next
+     * call starts a new reconnect cycle.
      * Should greater than 1
      *
      * @default Infinity
      */
     maxAttempt?: undefined | number;
+    /**
+     * Maximum number of connection attempts over the transport's lifetime,
+     * successful ones included (see `totalAttempt`).
+     * When reached, calls that need a new connection fail instead of connecting.
+     *
+     * @default Infinity
+     */
+    maxTotalAttempt?: undefined | number;
     /**
      * Whether to proactively reconnect right after the socket closes,
      * rather than waiting for the next call to trigger reconnection.
@@ -66,12 +75,12 @@ interface WebsocketLinkTransportReconnectOptions {
         delay?: number;
     };
 }
-interface WebsocketLinkTransportOptions<_T extends ClientContext> {
+interface WebSocketLinkTransportOptions<_T extends ClientContext> {
     /**
      * Returns a WebSocket instance for peer communication.
      * Can be async for lazy resolution.
      */
-    connect: (info: WebsocketLinkTransportAttemptInfo) => Promisable<WebSocketLike>;
+    connect: (info: WebSocketLinkTransportAttemptInfo) => Promisable<WebSocketLike>;
     /**
      * Whether to connect immediately on initialization, instead of waiting
      * for the first call. Reduces latency for the first request.
@@ -84,7 +93,7 @@ interface WebsocketLinkTransportOptions<_T extends ClientContext> {
      *
      * @default { enabled: false }
      */
-    reconnect?: undefined | WebsocketLinkTransportReconnectOptions;
+    reconnect?: undefined | WebSocketLinkTransportReconnectOptions;
     /**
      * Options for encoding peer messages. such as `prefix` for distinguishing messages on the same channel..
      */
@@ -94,16 +103,17 @@ interface WebsocketLinkTransportOptions<_T extends ClientContext> {
      */
     decodePeerMessage?: DecodePeerMessageOptions | undefined;
 }
-declare class WebsocketLinkTransport<T extends ClientContext> implements StandardLinkTransport<T> {
+declare class WebSocketLinkTransport<T extends ClientContext> implements StandardLinkTransport<T> {
     private readonly connect;
     private readonly reconnectEnabled;
     private readonly reconnectDelay;
     private readonly reconnectMaxAttempt;
+    private readonly reconnectMaxTotalAttempt;
     private readonly reconnectOnCloseEnabled;
     private readonly reconnectOnCloseDelay;
     private readonly encodePeerMessageOptions;
     private readonly decodePeerMessageOptions;
-    constructor(options: WebsocketLinkTransportOptions<T>);
+    constructor(options: WebSocketLinkTransportOptions<T>);
     send(standardRequest: StandardRequest, _path: string[], _options: ClientOptions<T>): Promise<StandardLazyResponse>;
     private totalAttempt;
     private attempt;
@@ -111,11 +121,16 @@ declare class WebsocketLinkTransport<T extends ClientContext> implements Standar
     private getConnectedPeer;
 }
 
-interface RPCLinkOptions<T extends ClientContext> extends StandardLinkOptions<T>, WebsocketLinkTransportOptions<T>, RPCLinkCodecOptions<T> {
+interface RPCLinkOptions<T extends ClientContext> extends StandardLinkOptions<T>, WebSocketLinkTransportOptions<T>, RPCLinkCodecOptions<T> {
 }
+/**
+ * Client link that communicates with an RPC Handler over a WebSocket connection.
+ *
+ * @see {@link https://orpc.dev/docs/adapters/websocket | WebSocket Adapters}
+ */
 declare class RPCLink<T extends ClientContext> extends StandardLink<T> {
     constructor(options: RPCLinkOptions<T>);
 }
 
-export { RPCLink, WebsocketLinkTransport };
-export type { RPCLinkOptions, WebSocketLike, WebsocketLinkTransportAttemptInfo, WebsocketLinkTransportOptions, WebsocketLinkTransportReconnectOptions };
+export { RPCLink, WebSocketLinkTransport };
+export type { RPCLinkOptions, WebSocketLike, WebSocketLinkTransportAttemptInfo, WebSocketLinkTransportOptions, WebSocketLinkTransportReconnectOptions };

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

@@ -1,13 +1,13 @@
-import { C as ClientContext, a as ClientOptions } from '../../shared/client.8ug8I-zu.js';
+import { ClientContext, ClientOptions } from '../../index.js';
 import { Promisable } from '@orpc/shared';
-import { StandardRequest, StandardLazyResponse } from '@standardserver/core';
-import { EncodePeerMessageOptions, DecodePeerMessageOptions } from '@standardserver/peer';
-import { S as StandardLinkTransport, a as StandardLink, b as StandardLinkOptions } from '../../shared/client.CPF3hX6O.js';
+import { StandardRequest, StandardLazyResponse } from '@standard-server/core';
+import { EncodePeerMessageOptions, DecodePeerMessageOptions } from '@standard-server/peer';
+import { StandardLinkTransport, StandardLink, StandardLinkOptions } from '../standard/index.js';
 import { RPCLinkCodecOptions } from '../standard/index.js';
-import '../../shared/client.BdItY5DT.js';
+import '../../shared/client.BPa_Mmuh.js';
 
 type WebSocketLike = Pick<WebSocket, 'addEventListener' | 'removeEventListener' | 'send' | 'readyState'>;
-interface WebsocketLinkTransportAttemptInfo {
+interface WebSocketLinkTransportAttemptInfo {
     /**
      * Total number of connection attempts for this transport's lifetime.
      * Starts at 1 on the first attempt, increments on every subsequent
@@ -17,11 +17,11 @@ interface WebsocketLinkTransportAttemptInfo {
     /**
      * Attempt number within the current (re)connect cycle.
      * Starts at 1, increments on each consecutive failure, and resets to 1
-     * once a connection succeeds. Use this for backoff calculations.
+     * once a connection succeeds or the cycle gives up. Use this for backoff calculations.
      */
     attempt: number;
 }
-interface WebsocketLinkTransportReconnectOptions {
+interface WebSocketLinkTransportReconnectOptions {
     /**
      * Whether to automatically reconnect when the connection is lost.
      *
@@ -33,15 +33,24 @@ interface WebsocketLinkTransportReconnectOptions {
      *
      * @default info => info.attempt === 1 ? 0 : 2_000
      */
-    delay?: undefined | ((info: WebsocketLinkTransportAttemptInfo) => number);
+    delay?: undefined | ((info: WebSocketLinkTransportAttemptInfo) => number);
     /**
      * Maximum number of consecutive failed attempts before giving up.
-     * When exceeded, `getConnectedPeer` throws instead of retrying.
+     * When reached, calls waiting for the connection fail, and the next
+     * call starts a new reconnect cycle.
      * Should greater than 1
      *
      * @default Infinity
      */
     maxAttempt?: undefined | number;
+    /**
+     * Maximum number of connection attempts over the transport's lifetime,
+     * successful ones included (see `totalAttempt`).
+     * When reached, calls that need a new connection fail instead of connecting.
+     *
+     * @default Infinity
+     */
+    maxTotalAttempt?: undefined | number;
     /**
      * Whether to proactively reconnect right after the socket closes,
      * rather than waiting for the next call to trigger reconnection.
@@ -66,12 +75,12 @@ interface WebsocketLinkTransportReconnectOptions {
         delay?: number;
     };
 }
-interface WebsocketLinkTransportOptions<_T extends ClientContext> {
+interface WebSocketLinkTransportOptions<_T extends ClientContext> {
     /**
      * Returns a WebSocket instance for peer communication.
      * Can be async for lazy resolution.
      */
-    connect: (info: WebsocketLinkTransportAttemptInfo) => Promisable<WebSocketLike>;
+    connect: (info: WebSocketLinkTransportAttemptInfo) => Promisable<WebSocketLike>;
     /**
      * Whether to connect immediately on initialization, instead of waiting
      * for the first call. Reduces latency for the first request.
@@ -84,7 +93,7 @@ interface WebsocketLinkTransportOptions<_T extends ClientContext> {
      *
      * @default { enabled: false }
      */
-    reconnect?: undefined | WebsocketLinkTransportReconnectOptions;
+    reconnect?: undefined | WebSocketLinkTransportReconnectOptions;
     /**
      * Options for encoding peer messages. such as `prefix` for distinguishing messages on the same channel..
      */
@@ -94,16 +103,17 @@ interface WebsocketLinkTransportOptions<_T extends ClientContext> {
      */
     decodePeerMessage?: DecodePeerMessageOptions | undefined;
 }
-declare class WebsocketLinkTransport<T extends ClientContext> implements StandardLinkTransport<T> {
+declare class WebSocketLinkTransport<T extends ClientContext> implements StandardLinkTransport<T> {
     private readonly connect;
     private readonly reconnectEnabled;
     private readonly reconnectDelay;
     private readonly reconnectMaxAttempt;
+    private readonly reconnectMaxTotalAttempt;
     private readonly reconnectOnCloseEnabled;
     private readonly reconnectOnCloseDelay;
     private readonly encodePeerMessageOptions;
     private readonly decodePeerMessageOptions;
-    constructor(options: WebsocketLinkTransportOptions<T>);
+    constructor(options: WebSocketLinkTransportOptions<T>);
     send(standardRequest: StandardRequest, _path: string[], _options: ClientOptions<T>): Promise<StandardLazyResponse>;
     private totalAttempt;
     private attempt;
@@ -111,11 +121,16 @@ declare class WebsocketLinkTransport<T extends ClientContext> implements Standar
     private getConnectedPeer;
 }
 
-interface RPCLinkOptions<T extends ClientContext> extends StandardLinkOptions<T>, WebsocketLinkTransportOptions<T>, RPCLinkCodecOptions<T> {
+interface RPCLinkOptions<T extends ClientContext> extends StandardLinkOptions<T>, WebSocketLinkTransportOptions<T>, RPCLinkCodecOptions<T> {
 }
+/**
+ * Client link that communicates with an RPC Handler over a WebSocket connection.
+ *
+ * @see {@link https://orpc.dev/docs/adapters/websocket | WebSocket Adapters}
+ */
 declare class RPCLink<T extends ClientContext> extends StandardLink<T> {
     constructor(options: RPCLinkOptions<T>);
 }
 
-export { RPCLink, WebsocketLinkTransport };
-export type { RPCLinkOptions, WebSocketLike, WebsocketLinkTransportAttemptInfo, WebsocketLinkTransportOptions, WebsocketLinkTransportReconnectOptions };
+export { RPCLink, WebSocketLinkTransport };
+export type { RPCLinkOptions, WebSocketLike, WebSocketLinkTransportAttemptInfo, WebSocketLinkTransportOptions, WebSocketLinkTransportReconnectOptions };