@orpc/client 2.0.0-beta.44 → 2.0.0-beta.45

package/dist/index.d.mts

@@ -1,8 +1,8 @@
 import { WrapAsyncIteratorOptions, AsyncIteratorClass, Interceptor, PromiseWithError, ThrowableError, Promisable } from '@orpc/shared';
 export { AsyncCleanupFn, AsyncIteratorClass, AsyncIteratorClassNextFn, PromiseWithError as ClientPromiseResult, MaybeOptionalOptions, PromiseWithError, Registry, ThrowableError, asyncIteratorToStream, asyncIteratorToUnproxiedDataStream, consumeAsyncIterator, consumeAsyncIterator as consumeEventIterator, asyncIteratorToStream as eventIteratorToStream, asyncIteratorToUnproxiedDataStream as eventIteratorToUnproxiedDataStream, onAsyncIteratorObjectError, onError, onFinish, onReadableStreamError, onStart, onSuccess, streamToAsyncIteratorObject, streamToAsyncIteratorObject as streamToEventIterator } from '@orpc/shared';
-import { C as ClientContext, a as ClientOptions, c as AnyNestedClient, I as InferClientContext, d as InferClientError, e as Client, b as ClientLink, A as AnyORPCError, f as ClientRest, F as FriendlyClientOptions, O as ORPCErrorCode, g as ORPCErrorJSON, h as ORPCError } from './shared/client.DZHZRyR6.mjs';
-export { i as AnyORPCErrorJSON, j as COMMON_ERROR_STATUS_MAP, k as InferClientBodyInputs, l as InferClientBodyOutputs, m as InferClientErrors, n as InferClientInputs, o as InferClientOutputs, M as MalformedResponseError, p as MalformedResponseErrorOptions, N as NestedClient, q as ORPCErrorOptions } from './shared/client.DZHZRyR6.mjs';
-export { R as RPCJsonSerialization, a as RPCJsonSerializationMeta, b as RPCJsonSerializer, c as RPCJsonSerializerHandler, d as RPCJsonSerializerOptions, e as RPCSerializer, f as RPCSerializerOptions, g as RPCSerializerSerializeOptions } from './shared/client.BPa_Mmuh.mjs';
+import { C as ClientContext, a as ClientOptions, c as AnyNestedClient, I as InferClientContext, d as InferClientError, e as Client, b as ClientLink, A as AnyORPCError, f as ClientRest, F as FriendlyClientOptions, O as ORPCErrorCode, g as ORPCErrorJSON, h as ORPCError } from './shared/client.BoHJeq15.mjs';
+export { i as AnyORPCErrorJSON, j as COMMON_ERROR_STATUS_MAP, k as InferClientBodyInputs, l as InferClientBodyOutputs, m as InferClientErrors, n as InferClientInputs, o as InferClientOutputs, M as MalformedResponseError, p as MalformedResponseErrorOptions, N as NestedClient, q as ORPCErrorOptions, R as ResponseError, r as ResponseErrorOptions } from './shared/client.BoHJeq15.mjs';
+export { R as RPCJsonSerialization, a as RPCJsonSerializationMeta, b as RPCJsonSerializer, c as RPCJsonSerializerHandler, d as RPCJsonSerializerOptions, e as RPCSerializer, f as RPCSerializerOptions, g as RPCSerializerSerializeOptions } from './shared/client.DqIWeNhQ.mjs';
 export { ErrorEvent, EventMeta, StandardBody, StandardBodyHint, StandardHeaders, StandardLazyRequest, StandardLazyResponse, StandardMethod, StandardRequest, StandardResponse, StandardUrl, getEventMeta, unwrapEvent, withEventMeta } from '@standard-server/core';
 
 declare function wrapAsyncIteratorPreservingEventMeta<TYield, TReturn, TMappedYield = TYield, TMappedReturn = TReturn>(iterator: AsyncIterator<TYield, TReturn>, { mapResult, mapError, ...rest }: WrapAsyncIteratorOptions<TYield, TReturn, TMappedYield, TMappedReturn>): AsyncIteratorClass<TMappedYield, TMappedReturn>;
@@ -16,26 +16,26 @@ interface ORPCClientScopedOptions<TClientContext extends ClientContext, TInput,
     /**
      * Interceptors that wrap the entire client call lifecycle.
      */
-    interceptors?: ORPCClientInterceptor<TClientContext, TInput, TOutput, TError>[];
+    interceptors?: ORPCClientInterceptor<TClientContext, TInput, TOutput, TError>[] | undefined;
 }
 type ORPCClientScoped<T extends AnyNestedClient> = T extends Client<infer UClientContext, infer UInput, infer UOutput, infer UError> ? ORPCClientScopedOptions<UClientContext, UInput, UOutput, UError> : {
-    [K in keyof T]?: T[K] extends AnyNestedClient ? ORPCClientScoped<T[K]> : never;
+    [K in keyof T]?: (T[K] extends AnyNestedClient ? ORPCClientScoped<T[K]> : never) | undefined;
 };
 interface ORPCClientOptions<T extends AnyNestedClient> {
     /**
      * Use as base path for all procedure, useful when you only want to call a subset of the procedure.
      */
-    path?: string[];
+    path?: string[] | undefined;
     /**
      * Interceptors that wrap the entire client call lifecycle, applied to every procedure call.
      */
-    interceptors?: ORPCClientInterceptor<InferClientContext<T>, unknown, unknown, InferClientError<T>>[];
+    interceptors?: ORPCClientInterceptor<InferClientContext<T>, unknown, unknown, InferClientError<T>>[] | undefined;
     /**
      * Per-procedure options following the shape of the router.
      * Allows fine-grained configuration (e.g. additional interceptors) for individual procedures
      * without affecting the rest of the router.
      */
-    scoped?: ORPCClientScoped<T>;
+    scoped?: ORPCClientScoped<T> | undefined;
 }
 /**
  * Creates a fully typed oRPC client from a link.

package/dist/index.d.ts

@@ -1,8 +1,8 @@
 import { WrapAsyncIteratorOptions, AsyncIteratorClass, Interceptor, PromiseWithError, ThrowableError, Promisable } from '@orpc/shared';
 export { AsyncCleanupFn, AsyncIteratorClass, AsyncIteratorClassNextFn, PromiseWithError as ClientPromiseResult, MaybeOptionalOptions, PromiseWithError, Registry, ThrowableError, asyncIteratorToStream, asyncIteratorToUnproxiedDataStream, consumeAsyncIterator, consumeAsyncIterator as consumeEventIterator, asyncIteratorToStream as eventIteratorToStream, asyncIteratorToUnproxiedDataStream as eventIteratorToUnproxiedDataStream, onAsyncIteratorObjectError, onError, onFinish, onReadableStreamError, onStart, onSuccess, streamToAsyncIteratorObject, streamToAsyncIteratorObject as streamToEventIterator } from '@orpc/shared';
-import { C as ClientContext, a as ClientOptions, c as AnyNestedClient, I as InferClientContext, d as InferClientError, e as Client, b as ClientLink, A as AnyORPCError, f as ClientRest, F as FriendlyClientOptions, O as ORPCErrorCode, g as ORPCErrorJSON, h as ORPCError } from './shared/client.DZHZRyR6.js';
-export { i as AnyORPCErrorJSON, j as COMMON_ERROR_STATUS_MAP, k as InferClientBodyInputs, l as InferClientBodyOutputs, m as InferClientErrors, n as InferClientInputs, o as InferClientOutputs, M as MalformedResponseError, p as MalformedResponseErrorOptions, N as NestedClient, q as ORPCErrorOptions } from './shared/client.DZHZRyR6.js';
-export { R as RPCJsonSerialization, a as RPCJsonSerializationMeta, b as RPCJsonSerializer, c as RPCJsonSerializerHandler, d as RPCJsonSerializerOptions, e as RPCSerializer, f as RPCSerializerOptions, g as RPCSerializerSerializeOptions } from './shared/client.BPa_Mmuh.js';
+import { C as ClientContext, a as ClientOptions, c as AnyNestedClient, I as InferClientContext, d as InferClientError, e as Client, b as ClientLink, A as AnyORPCError, f as ClientRest, F as FriendlyClientOptions, O as ORPCErrorCode, g as ORPCErrorJSON, h as ORPCError } from './shared/client.BoHJeq15.js';
+export { i as AnyORPCErrorJSON, j as COMMON_ERROR_STATUS_MAP, k as InferClientBodyInputs, l as InferClientBodyOutputs, m as InferClientErrors, n as InferClientInputs, o as InferClientOutputs, M as MalformedResponseError, p as MalformedResponseErrorOptions, N as NestedClient, q as ORPCErrorOptions, R as ResponseError, r as ResponseErrorOptions } from './shared/client.BoHJeq15.js';
+export { R as RPCJsonSerialization, a as RPCJsonSerializationMeta, b as RPCJsonSerializer, c as RPCJsonSerializerHandler, d as RPCJsonSerializerOptions, e as RPCSerializer, f as RPCSerializerOptions, g as RPCSerializerSerializeOptions } from './shared/client.DqIWeNhQ.js';
 export { ErrorEvent, EventMeta, StandardBody, StandardBodyHint, StandardHeaders, StandardLazyRequest, StandardLazyResponse, StandardMethod, StandardRequest, StandardResponse, StandardUrl, getEventMeta, unwrapEvent, withEventMeta } from '@standard-server/core';
 
 declare function wrapAsyncIteratorPreservingEventMeta<TYield, TReturn, TMappedYield = TYield, TMappedReturn = TReturn>(iterator: AsyncIterator<TYield, TReturn>, { mapResult, mapError, ...rest }: WrapAsyncIteratorOptions<TYield, TReturn, TMappedYield, TMappedReturn>): AsyncIteratorClass<TMappedYield, TMappedReturn>;
@@ -16,26 +16,26 @@ interface ORPCClientScopedOptions<TClientContext extends ClientContext, TInput,
     /**
      * Interceptors that wrap the entire client call lifecycle.
      */
-    interceptors?: ORPCClientInterceptor<TClientContext, TInput, TOutput, TError>[];
+    interceptors?: ORPCClientInterceptor<TClientContext, TInput, TOutput, TError>[] | undefined;
 }
 type ORPCClientScoped<T extends AnyNestedClient> = T extends Client<infer UClientContext, infer UInput, infer UOutput, infer UError> ? ORPCClientScopedOptions<UClientContext, UInput, UOutput, UError> : {
-    [K in keyof T]?: T[K] extends AnyNestedClient ? ORPCClientScoped<T[K]> : never;
+    [K in keyof T]?: (T[K] extends AnyNestedClient ? ORPCClientScoped<T[K]> : never) | undefined;
 };
 interface ORPCClientOptions<T extends AnyNestedClient> {
     /**
      * Use as base path for all procedure, useful when you only want to call a subset of the procedure.
      */
-    path?: string[];
+    path?: string[] | undefined;
     /**
      * Interceptors that wrap the entire client call lifecycle, applied to every procedure call.
      */
-    interceptors?: ORPCClientInterceptor<InferClientContext<T>, unknown, unknown, InferClientError<T>>[];
+    interceptors?: ORPCClientInterceptor<InferClientContext<T>, unknown, unknown, InferClientError<T>>[] | undefined;
     /**
      * Per-procedure options following the shape of the router.
      * Allows fine-grained configuration (e.g. additional interceptors) for individual procedures
      * without affecting the rest of the router.
      */
-    scoped?: ORPCClientScoped<T>;
+    scoped?: ORPCClientScoped<T> | undefined;
 }
 /**
  * Creates a fully typed oRPC client from a link.

package/dist/index.mjs

@@ -1,8 +1,8 @@
-import { a as isDefinedError } from './shared/client.BLfXUpyF.mjs';
-export { b as RPCJsonSerializer, R as RPCSerializer, d as cloneORPCError, c as createORPCErrorFromJson, i as isORPCErrorJson, t as toORPCError, w as wrapAsyncIteratorPreservingEventMeta } from './shared/client.BLfXUpyF.mjs';
+import { a as isDefinedError } from './shared/client._wG5INmC.mjs';
+export { b as RPCJsonSerializer, R as RPCSerializer, d as cloneORPCError, c as createORPCErrorFromJson, i as isORPCErrorJson, t as toORPCError, w as wrapAsyncIteratorPreservingEventMeta } from './shared/client._wG5INmC.mjs';
 import { toArray, intercept, isTypescriptObject } from '@orpc/shared';
 export { AsyncIteratorClass, asyncIteratorToStream, asyncIteratorToUnproxiedDataStream, consumeAsyncIterator, consumeAsyncIterator as consumeEventIterator, asyncIteratorToStream as eventIteratorToStream, asyncIteratorToUnproxiedDataStream as eventIteratorToUnproxiedDataStream, onAsyncIteratorObjectError, onError, onFinish, onReadableStreamError, onStart, onSuccess, streamToAsyncIteratorObject, streamToAsyncIteratorObject as streamToEventIterator } from '@orpc/shared';
-export { C as COMMON_ERROR_STATUS_MAP, M as MalformedResponseError, O as ORPCError } from './shared/client.CrHurHrq.mjs';
+export { C as COMMON_ERROR_STATUS_MAP, M as MalformedResponseError, O as ORPCError, R as ResponseError } from './shared/client.LF04eOvL.mjs';
 export { ErrorEvent, getEventMeta, unwrapEvent, withEventMeta } from '@standard-server/core';
 
 const RECURSIVE_CLIENT_UNWRAP_KEYS = /* @__PURE__ */ new Set([

package/dist/plugins/index.d.mts

@@ -3,7 +3,19 @@ import { StandardUrl, StandardHeaders, StandardRequest, StandardLazyResponse } f
 import { ClientContext } from '../index.mjs';
 import { StandardLinkPlugin, StandardLinkTransportInterceptorOptions, StandardLinkOptions, StandardLinkInterceptorOptions } from '../adapters/standard/index.mjs';
 
-type BatchLinkPluginMode = 'streaming' | 'buffered';
+/**
+ * Header that marks a request as a batch, set by the Batch Link Plugin and detected by the Batch Handler Plugin.
+ * Nothing between the client and server, such as a CORS policy or proxy, should block or strip it.
+ *
+ * @see {@link https://orpc.dev/docs/plugins/batch#setup | Batch Plugin - Setup}
+ */
+declare const BATCH_HEADER = "orpc-batch";
+/**
+ * Default `maxSize` of both the Batch Link Plugin and the Batch Handler Plugin.
+ *
+ * @see {@link https://orpc.dev/docs/plugins/batch#max-size | Batch Plugin - Max Size}
+ */
+declare const DEFAULT_BATCH_MAX_SIZE = 10;
 interface BatchLinkPluginGroup<T extends ClientContext> {
     /**
      * Determines whether a request should be included in this batch group.
@@ -21,7 +33,7 @@ interface BatchLinkPluginGroup<T extends ClientContext> {
      *
      * @default []
      */
-    path?: Value<string[], [items: [StandardLinkTransportInterceptorOptions<T>, ...StandardLinkTransportInterceptorOptions<T>[]]]>;
+    path?: Value<string[], [items: [StandardLinkTransportInterceptorOptions<T>, ...StandardLinkTransportInterceptorOptions<T>[]]]> | undefined;
 }
 interface BatchLinkPluginOptions<T extends ClientContext> {
     groups: [BatchLinkPluginGroup<T>, ...BatchLinkPluginGroup<T>[]];
@@ -30,20 +42,22 @@ interface BatchLinkPluginOptions<T extends ClientContext> {
      *
      * @default () => true
      */
-    filter?: Value<boolean, [options: StandardLinkTransportInterceptorOptions<T>]>;
+    filter?: Value<boolean, [options: StandardLinkTransportInterceptorOptions<T>]> | undefined;
     /**
      * Only requests with the same scope are batched together.
      * On the server, return a value unique to the incoming request so different users never share a batch.
      *
      * @default () => undefined
      */
-    scope?: (options: StandardLinkTransportInterceptorOptions<T>) => unknown;
+    scope?: ((options: StandardLinkTransportInterceptorOptions<T>) => unknown) | undefined;
     /**
-     * The maximum number of requests in the batch.
+     * The maximum number of requests in the batch. Larger batches are split.
+     * Keep it at or below the server Batch Handler Plugin's `maxSize`, which rejects larger batches with a `413`.
      *
-     * @default 10
+     * @default DEFAULT_BATCH_MAX_SIZE (10)
+     * @see {@link https://orpc.dev/docs/plugins/batch#max-size | Batch Plugin - Max Size}
      */
-    maxSize?: Value<Promisable<number>, [subOptionsList: [StandardLinkTransportInterceptorOptions<T>, ...StandardLinkTransportInterceptorOptions<T>[]]]>;
+    maxSize?: Value<Promisable<number>, [subOptionsList: [StandardLinkTransportInterceptorOptions<T>, ...StandardLinkTransportInterceptorOptions<T>[]]]> | undefined;
     /**
      * How long (in ms) to wait for more requests before sending the batch,
      * counted from the first queued request.
@@ -51,20 +65,13 @@ interface BatchLinkPluginOptions<T extends ClientContext> {
      *
      * @default 0
      */
-    wait?: number;
-    /**
-     * The batch response mode.
-     * A `buffered` batch still streams once a procedure in it returns a stream.
-     *
-     * @default 'streaming'
-     */
-    mode?: Value<BatchLinkPluginMode, [subOptionsList: [StandardLinkTransportInterceptorOptions<T>, ...StandardLinkTransportInterceptorOptions<T>[]]]>;
+    wait?: number | undefined;
     /**
      * URL for the batch request.
      *
      * @default URL of the first subrequest in the batch + '/__batch__'
      */
-    url?: Value<Promisable<StandardUrl>, [subOptionsList: [StandardLinkTransportInterceptorOptions<T>, ...StandardLinkTransportInterceptorOptions<T>[]]]>;
+    url?: Value<Promisable<StandardUrl>, [subOptionsList: [StandardLinkTransportInterceptorOptions<T>, ...StandardLinkTransportInterceptorOptions<T>[]]]> | undefined;
     /**
      * The maximum length of the URL that runtime supports,
      * if exceeded, the batch will be split into smaller batches and sent sequentially.
@@ -73,25 +80,25 @@ interface BatchLinkPluginOptions<T extends ClientContext> {
      *
      * @default 2083
      */
-    maxUrlLength?: Value<Promisable<number>, [subOptionsList: [StandardLinkTransportInterceptorOptions<T>, ...StandardLinkTransportInterceptorOptions<T>[]]]>;
+    maxUrlLength?: Value<Promisable<number>, [subOptionsList: [StandardLinkTransportInterceptorOptions<T>, ...StandardLinkTransportInterceptorOptions<T>[]]]> | undefined;
     /**
      * Headers used for the batch request.
      *
      * @default Common headers among all subrequests in the batch.
      */
-    headers?: Value<Promisable<StandardHeaders>, [subOptionsList: [StandardLinkTransportInterceptorOptions<T>, ...StandardLinkTransportInterceptorOptions<T>[]]]>;
+    headers?: Value<Promisable<StandardHeaders>, [subOptionsList: [StandardLinkTransportInterceptorOptions<T>, ...StandardLinkTransportInterceptorOptions<T>[]]]> | undefined;
     /**
      * Map each subrequest in the batch before it is sent.
      *
      * @default Removes headers that are duplicated with the batch headers
      */
-    mapSubrequest?: (subOptions: StandardLinkTransportInterceptorOptions<T>, partialBatchRequest: Pick<StandardRequest, 'url' | 'headers'>) => StandardRequest;
+    mapSubrequest?: ((subOptions: StandardLinkTransportInterceptorOptions<T>, partialBatchRequest: Pick<StandardRequest, 'url' | 'headers'>) => StandardRequest) | undefined;
     /**
      * Maps each subresponse before returning the final response.
      *
      * @default Low-priority merges headers from the batch response into each subresponse.
      */
-    mapSubresponse?: (subResponse: StandardLazyResponse, batchResponse: StandardLazyResponse, subOptions: StandardLinkTransportInterceptorOptions<T>) => StandardLazyResponse;
+    mapSubresponse?: ((subResponse: StandardLazyResponse, batchResponse: StandardLazyResponse, subOptions: StandardLinkTransportInterceptorOptions<T>) => StandardLazyResponse) | undefined;
 }
 /**
  * Combines multiple client requests into a single batch request
@@ -109,7 +116,6 @@ declare class BatchLinkPlugin<T extends ClientContext> implements StandardLinkPl
     private readonly scope;
     private readonly maxSize;
     private readonly wait;
-    private readonly mode;
     private readonly batchUrl;
     private readonly maxUrlLength;
     private readonly batchHeaders;
@@ -152,14 +158,14 @@ interface DedupeLinkPluginOptions<T extends ClientContext> {
      *
      * @default ({ request }) => request.method === 'GET' || request.method === 'QUERY'
      */
-    filter?: Value<boolean, [options: StandardLinkTransportInterceptorOptions<T>]>;
+    filter?: Value<boolean, [options: StandardLinkTransportInterceptorOptions<T>]> | undefined;
     /**
      * Only requests with the same scope are deduplicated together.
      * On the server, return a value unique to the incoming request so different users never share a response.
      *
      * @default () => undefined
      */
-    scope?: (options: StandardLinkTransportInterceptorOptions<T>) => unknown;
+    scope?: ((options: StandardLinkTransportInterceptorOptions<T>) => unknown) | undefined;
     /**
      * How long (in ms) to wait for more identical requests before sending,
      * counted from the first queued request.
@@ -167,7 +173,7 @@ interface DedupeLinkPluginOptions<T extends ClientContext> {
      *
      * @default 0
      */
-    wait?: number;
+    wait?: number | undefined;
 }
 /**
  * Prevents redundant requests by deduplicating similar in-flight requests,
@@ -196,7 +202,7 @@ interface RequestCompressionLinkPluginOptions<T extends ClientContext> {
      *
      * @default 'gzip'
      */
-    encoding?: 'gzip' | 'deflate' | 'deflate-raw';
+    encoding?: 'gzip' | 'deflate' | 'deflate-raw' | undefined;
     /**
      * The minimum request size in bytes required to trigger compression.
      * Requests smaller than this threshold will not be compressed to avoid overhead.
@@ -204,7 +210,7 @@ interface RequestCompressionLinkPluginOptions<T extends ClientContext> {
      *
      * @default 1024 (1KB)
      */
-    threshold?: number;
+    threshold?: number | undefined;
     /**
      * Determines whether a request with the given Content-Type should be compressed.
      * Only consulted for binary transfers (streams, files, and file form-data parts).
@@ -212,7 +218,7 @@ interface RequestCompressionLinkPluginOptions<T extends ClientContext> {
      *
      * @default isCompressibleContentType (covers common text-based formats)
      */
-    isCompressibleContentType?: (contentType: string | null | undefined, options: StandardLinkTransportInterceptorOptions<T>) => boolean;
+    isCompressibleContentType?: ((contentType: string | null | undefined, options: StandardLinkTransportInterceptorOptions<T>) => boolean) | undefined;
 }
 /**
  * Compresses request bodies before sending them to the server,
@@ -240,7 +246,7 @@ interface ResponseCompressionLinkPluginOptions<_T extends ClientContext> {
      *
      * @default ['gzip', 'deflate']
      */
-    encodings?: readonly ('gzip' | 'deflate' | 'deflate-raw')[];
+    encodings?: readonly ('gzip' | 'deflate' | 'deflate-raw')[] | undefined;
 }
 /**
  * Advertises Accept-Encoding on requests and decompresses response bodies
@@ -287,7 +293,7 @@ interface RetryLinkPluginContext {
      *
      * @default 0
      */
-    retry?: Value<Promisable<number>, [Omit<StandardLinkInterceptorOptions<RetryLinkPluginContext>, 'next'>]>;
+    retry?: Value<Promisable<number>, [Omit<StandardLinkInterceptorOptions<RetryLinkPluginContext>, 'next'>]> | undefined;
     /**
      * Delay (in ms) before retrying.
      *
@@ -296,17 +302,17 @@ interface RetryLinkPluginContext {
      *
      * @default (o) => o.lastEventRetry ?? 2000
      */
-    retryDelay?: Value<Promisable<number>, [RetryLinkPluginAttemptOptions<RetryLinkPluginContext>]>;
+    retryDelay?: Value<Promisable<number>, [RetryLinkPluginAttemptOptions<RetryLinkPluginContext>]> | undefined;
     /**
      * Determine whether to retry.
      *
-     * @default true
+     * @default (o) => isRetryableError(o.error)
      */
-    shouldRetry?: Value<Promisable<boolean>, [RetryLinkPluginAttemptOptions<RetryLinkPluginContext>]>;
+    shouldRetry?: Value<Promisable<boolean>, [RetryLinkPluginAttemptOptions<RetryLinkPluginContext>]> | undefined;
     /**
      * Hook called before each retry. Can return a cleanup callback.
      */
-    onRetry?: (options: RetryLinkPluginAttemptOptions<RetryLinkPluginContext>) => void | ((isSuccess: boolean) => void);
+    onRetry?: ((options: RetryLinkPluginAttemptOptions<RetryLinkPluginContext>) => void | ((isSuccess: boolean) => void)) | undefined;
 }
 interface RetryLinkPluginOptions<_T extends RetryLinkPluginContext> {
     /**
@@ -314,6 +320,13 @@ interface RetryLinkPluginOptions<_T extends RetryLinkPluginContext> {
      */
     default?: RetryLinkPluginContext | undefined;
 }
+/**
+ * Default `shouldRetry` check of `RetryLinkPlugin`. Returns `false` only for errors
+ * from a 4xx response other than `408` and `429`.
+ *
+ * @see {@link https://orpc.dev/docs/plugins/retry#client-error-responses | Retry Plugin - Client Error Responses}
+ */
+declare function isRetryableError(error: unknown): boolean;
 /**
  * Automatically retries failed requests based on customizable retry strategies,
  * improving the resilience of your application.
@@ -342,7 +355,7 @@ interface RetryAfterLinkPluginOptions<T extends ClientContext> {
     condition?: Value<boolean, [
         response: StandardLazyResponse,
         options: StandardLinkTransportInterceptorOptions<T>
-    ]>;
+    ]> | undefined;
     /**
      * Maximum attempts before giving up retries.
      *
@@ -351,7 +364,7 @@ interface RetryAfterLinkPluginOptions<T extends ClientContext> {
     maxAttempts?: Value<number, [
         response: StandardLazyResponse,
         options: StandardLinkTransportInterceptorOptions<T>
-    ]>;
+    ]> | undefined;
     /**
      * Maximum timeout in milliseconds to wait before giving up retries.
      *
@@ -360,7 +373,7 @@ interface RetryAfterLinkPluginOptions<T extends ClientContext> {
     timeout?: Value<number, [
         response: StandardLazyResponse,
         options: StandardLinkTransportInterceptorOptions<T>
-    ]>;
+    ]> | undefined;
 }
 /**
  * The Retry After Link Plugin automatically retries requests based on server `retry-after` header.
@@ -403,5 +416,5 @@ declare class TimeoutLinkPlugin<T extends ClientContext> implements StandardLink
     init(options: StandardLinkOptions<T>): StandardLinkOptions<T>;
 }
 
-export { BatchLinkPlugin, RetryLinkPlugin as ClientRetryPlugin, DedupeLinkPlugin, DedupeLinkPlugin as DedupeRequestsPlugin, RequestCompressionLinkPlugin, ResponseCompressionLinkPlugin, RetryAfterLinkPlugin, RetryAfterLinkPlugin as RetryAfterPlugin, RetryLinkPlugin, TimeoutLinkPlugin };
-export type { BatchLinkPluginGroup, BatchLinkPluginMode, BatchLinkPluginOptions, RetryLinkPluginContext as ClientRetryPluginContext, DedupeLinkPluginGroup, DedupeLinkPluginOptions, RequestCompressionLinkPluginOptions, ResponseCompressionLinkPluginOptions, RetryAfterLinkPluginOptions, RetryLinkPluginAttemptOptions, RetryLinkPluginContext, RetryLinkPluginOptions, TimeoutLinkPluginOptions };
+export { BATCH_HEADER, BatchLinkPlugin, RetryLinkPlugin as ClientRetryPlugin, DEFAULT_BATCH_MAX_SIZE, DedupeLinkPlugin, DedupeLinkPlugin as DedupeRequestsPlugin, RequestCompressionLinkPlugin, ResponseCompressionLinkPlugin, RetryAfterLinkPlugin, RetryAfterLinkPlugin as RetryAfterPlugin, RetryLinkPlugin, TimeoutLinkPlugin, isRetryableError };
+export type { BatchLinkPluginGroup, BatchLinkPluginOptions, RetryLinkPluginContext as ClientRetryPluginContext, DedupeLinkPluginGroup, DedupeLinkPluginOptions, RequestCompressionLinkPluginOptions, ResponseCompressionLinkPluginOptions, RetryAfterLinkPluginOptions, RetryLinkPluginAttemptOptions, RetryLinkPluginContext, RetryLinkPluginOptions, TimeoutLinkPluginOptions };

package/dist/plugins/index.d.ts

@@ -3,7 +3,19 @@ import { StandardUrl, StandardHeaders, StandardRequest, StandardLazyResponse } f
 import { ClientContext } from '../index.js';
 import { StandardLinkPlugin, StandardLinkTransportInterceptorOptions, StandardLinkOptions, StandardLinkInterceptorOptions } from '../adapters/standard/index.js';
 
-type BatchLinkPluginMode = 'streaming' | 'buffered';
+/**
+ * Header that marks a request as a batch, set by the Batch Link Plugin and detected by the Batch Handler Plugin.
+ * Nothing between the client and server, such as a CORS policy or proxy, should block or strip it.
+ *
+ * @see {@link https://orpc.dev/docs/plugins/batch#setup | Batch Plugin - Setup}
+ */
+declare const BATCH_HEADER = "orpc-batch";
+/**
+ * Default `maxSize` of both the Batch Link Plugin and the Batch Handler Plugin.
+ *
+ * @see {@link https://orpc.dev/docs/plugins/batch#max-size | Batch Plugin - Max Size}
+ */
+declare const DEFAULT_BATCH_MAX_SIZE = 10;
 interface BatchLinkPluginGroup<T extends ClientContext> {
     /**
      * Determines whether a request should be included in this batch group.
@@ -21,7 +33,7 @@ interface BatchLinkPluginGroup<T extends ClientContext> {
      *
      * @default []
      */
-    path?: Value<string[], [items: [StandardLinkTransportInterceptorOptions<T>, ...StandardLinkTransportInterceptorOptions<T>[]]]>;
+    path?: Value<string[], [items: [StandardLinkTransportInterceptorOptions<T>, ...StandardLinkTransportInterceptorOptions<T>[]]]> | undefined;
 }
 interface BatchLinkPluginOptions<T extends ClientContext> {
     groups: [BatchLinkPluginGroup<T>, ...BatchLinkPluginGroup<T>[]];
@@ -30,20 +42,22 @@ interface BatchLinkPluginOptions<T extends ClientContext> {
      *
      * @default () => true
      */
-    filter?: Value<boolean, [options: StandardLinkTransportInterceptorOptions<T>]>;
+    filter?: Value<boolean, [options: StandardLinkTransportInterceptorOptions<T>]> | undefined;
     /**
      * Only requests with the same scope are batched together.
      * On the server, return a value unique to the incoming request so different users never share a batch.
      *
      * @default () => undefined
      */
-    scope?: (options: StandardLinkTransportInterceptorOptions<T>) => unknown;
+    scope?: ((options: StandardLinkTransportInterceptorOptions<T>) => unknown) | undefined;
     /**
-     * The maximum number of requests in the batch.
+     * The maximum number of requests in the batch. Larger batches are split.
+     * Keep it at or below the server Batch Handler Plugin's `maxSize`, which rejects larger batches with a `413`.
      *
-     * @default 10
+     * @default DEFAULT_BATCH_MAX_SIZE (10)
+     * @see {@link https://orpc.dev/docs/plugins/batch#max-size | Batch Plugin - Max Size}
      */
-    maxSize?: Value<Promisable<number>, [subOptionsList: [StandardLinkTransportInterceptorOptions<T>, ...StandardLinkTransportInterceptorOptions<T>[]]]>;
+    maxSize?: Value<Promisable<number>, [subOptionsList: [StandardLinkTransportInterceptorOptions<T>, ...StandardLinkTransportInterceptorOptions<T>[]]]> | undefined;
     /**
      * How long (in ms) to wait for more requests before sending the batch,
      * counted from the first queued request.
@@ -51,20 +65,13 @@ interface BatchLinkPluginOptions<T extends ClientContext> {
      *
      * @default 0
      */
-    wait?: number;
-    /**
-     * The batch response mode.
-     * A `buffered` batch still streams once a procedure in it returns a stream.
-     *
-     * @default 'streaming'
-     */
-    mode?: Value<BatchLinkPluginMode, [subOptionsList: [StandardLinkTransportInterceptorOptions<T>, ...StandardLinkTransportInterceptorOptions<T>[]]]>;
+    wait?: number | undefined;
     /**
      * URL for the batch request.
      *
      * @default URL of the first subrequest in the batch + '/__batch__'
      */
-    url?: Value<Promisable<StandardUrl>, [subOptionsList: [StandardLinkTransportInterceptorOptions<T>, ...StandardLinkTransportInterceptorOptions<T>[]]]>;
+    url?: Value<Promisable<StandardUrl>, [subOptionsList: [StandardLinkTransportInterceptorOptions<T>, ...StandardLinkTransportInterceptorOptions<T>[]]]> | undefined;
     /**
      * The maximum length of the URL that runtime supports,
      * if exceeded, the batch will be split into smaller batches and sent sequentially.
@@ -73,25 +80,25 @@ interface BatchLinkPluginOptions<T extends ClientContext> {
      *
      * @default 2083
      */
-    maxUrlLength?: Value<Promisable<number>, [subOptionsList: [StandardLinkTransportInterceptorOptions<T>, ...StandardLinkTransportInterceptorOptions<T>[]]]>;
+    maxUrlLength?: Value<Promisable<number>, [subOptionsList: [StandardLinkTransportInterceptorOptions<T>, ...StandardLinkTransportInterceptorOptions<T>[]]]> | undefined;
     /**
      * Headers used for the batch request.
      *
      * @default Common headers among all subrequests in the batch.
      */
-    headers?: Value<Promisable<StandardHeaders>, [subOptionsList: [StandardLinkTransportInterceptorOptions<T>, ...StandardLinkTransportInterceptorOptions<T>[]]]>;
+    headers?: Value<Promisable<StandardHeaders>, [subOptionsList: [StandardLinkTransportInterceptorOptions<T>, ...StandardLinkTransportInterceptorOptions<T>[]]]> | undefined;
     /**
      * Map each subrequest in the batch before it is sent.
      *
      * @default Removes headers that are duplicated with the batch headers
      */
-    mapSubrequest?: (subOptions: StandardLinkTransportInterceptorOptions<T>, partialBatchRequest: Pick<StandardRequest, 'url' | 'headers'>) => StandardRequest;
+    mapSubrequest?: ((subOptions: StandardLinkTransportInterceptorOptions<T>, partialBatchRequest: Pick<StandardRequest, 'url' | 'headers'>) => StandardRequest) | undefined;
     /**
      * Maps each subresponse before returning the final response.
      *
      * @default Low-priority merges headers from the batch response into each subresponse.
      */
-    mapSubresponse?: (subResponse: StandardLazyResponse, batchResponse: StandardLazyResponse, subOptions: StandardLinkTransportInterceptorOptions<T>) => StandardLazyResponse;
+    mapSubresponse?: ((subResponse: StandardLazyResponse, batchResponse: StandardLazyResponse, subOptions: StandardLinkTransportInterceptorOptions<T>) => StandardLazyResponse) | undefined;
 }
 /**
  * Combines multiple client requests into a single batch request
@@ -109,7 +116,6 @@ declare class BatchLinkPlugin<T extends ClientContext> implements StandardLinkPl
     private readonly scope;
     private readonly maxSize;
     private readonly wait;
-    private readonly mode;
     private readonly batchUrl;
     private readonly maxUrlLength;
     private readonly batchHeaders;
@@ -152,14 +158,14 @@ interface DedupeLinkPluginOptions<T extends ClientContext> {
      *
      * @default ({ request }) => request.method === 'GET' || request.method === 'QUERY'
      */
-    filter?: Value<boolean, [options: StandardLinkTransportInterceptorOptions<T>]>;
+    filter?: Value<boolean, [options: StandardLinkTransportInterceptorOptions<T>]> | undefined;
     /**
      * Only requests with the same scope are deduplicated together.
      * On the server, return a value unique to the incoming request so different users never share a response.
      *
      * @default () => undefined
      */
-    scope?: (options: StandardLinkTransportInterceptorOptions<T>) => unknown;
+    scope?: ((options: StandardLinkTransportInterceptorOptions<T>) => unknown) | undefined;
     /**
      * How long (in ms) to wait for more identical requests before sending,
      * counted from the first queued request.
@@ -167,7 +173,7 @@ interface DedupeLinkPluginOptions<T extends ClientContext> {
      *
      * @default 0
      */
-    wait?: number;
+    wait?: number | undefined;
 }
 /**
  * Prevents redundant requests by deduplicating similar in-flight requests,
@@ -196,7 +202,7 @@ interface RequestCompressionLinkPluginOptions<T extends ClientContext> {
      *
      * @default 'gzip'
      */
-    encoding?: 'gzip' | 'deflate' | 'deflate-raw';
+    encoding?: 'gzip' | 'deflate' | 'deflate-raw' | undefined;
     /**
      * The minimum request size in bytes required to trigger compression.
      * Requests smaller than this threshold will not be compressed to avoid overhead.
@@ -204,7 +210,7 @@ interface RequestCompressionLinkPluginOptions<T extends ClientContext> {
      *
      * @default 1024 (1KB)
      */
-    threshold?: number;
+    threshold?: number | undefined;
     /**
      * Determines whether a request with the given Content-Type should be compressed.
      * Only consulted for binary transfers (streams, files, and file form-data parts).
@@ -212,7 +218,7 @@ interface RequestCompressionLinkPluginOptions<T extends ClientContext> {
      *
      * @default isCompressibleContentType (covers common text-based formats)
      */
-    isCompressibleContentType?: (contentType: string | null | undefined, options: StandardLinkTransportInterceptorOptions<T>) => boolean;
+    isCompressibleContentType?: ((contentType: string | null | undefined, options: StandardLinkTransportInterceptorOptions<T>) => boolean) | undefined;
 }
 /**
  * Compresses request bodies before sending them to the server,
@@ -240,7 +246,7 @@ interface ResponseCompressionLinkPluginOptions<_T extends ClientContext> {
      *
      * @default ['gzip', 'deflate']
      */
-    encodings?: readonly ('gzip' | 'deflate' | 'deflate-raw')[];
+    encodings?: readonly ('gzip' | 'deflate' | 'deflate-raw')[] | undefined;
 }
 /**
  * Advertises Accept-Encoding on requests and decompresses response bodies
@@ -287,7 +293,7 @@ interface RetryLinkPluginContext {
      *
      * @default 0
      */
-    retry?: Value<Promisable<number>, [Omit<StandardLinkInterceptorOptions<RetryLinkPluginContext>, 'next'>]>;
+    retry?: Value<Promisable<number>, [Omit<StandardLinkInterceptorOptions<RetryLinkPluginContext>, 'next'>]> | undefined;
     /**
      * Delay (in ms) before retrying.
      *
@@ -296,17 +302,17 @@ interface RetryLinkPluginContext {
      *
      * @default (o) => o.lastEventRetry ?? 2000
      */
-    retryDelay?: Value<Promisable<number>, [RetryLinkPluginAttemptOptions<RetryLinkPluginContext>]>;
+    retryDelay?: Value<Promisable<number>, [RetryLinkPluginAttemptOptions<RetryLinkPluginContext>]> | undefined;
     /**
      * Determine whether to retry.
      *
-     * @default true
+     * @default (o) => isRetryableError(o.error)
      */
-    shouldRetry?: Value<Promisable<boolean>, [RetryLinkPluginAttemptOptions<RetryLinkPluginContext>]>;
+    shouldRetry?: Value<Promisable<boolean>, [RetryLinkPluginAttemptOptions<RetryLinkPluginContext>]> | undefined;
     /**
      * Hook called before each retry. Can return a cleanup callback.
      */
-    onRetry?: (options: RetryLinkPluginAttemptOptions<RetryLinkPluginContext>) => void | ((isSuccess: boolean) => void);
+    onRetry?: ((options: RetryLinkPluginAttemptOptions<RetryLinkPluginContext>) => void | ((isSuccess: boolean) => void)) | undefined;
 }
 interface RetryLinkPluginOptions<_T extends RetryLinkPluginContext> {
     /**
@@ -314,6 +320,13 @@ interface RetryLinkPluginOptions<_T extends RetryLinkPluginContext> {
      */
     default?: RetryLinkPluginContext | undefined;
 }
+/**
+ * Default `shouldRetry` check of `RetryLinkPlugin`. Returns `false` only for errors
+ * from a 4xx response other than `408` and `429`.
+ *
+ * @see {@link https://orpc.dev/docs/plugins/retry#client-error-responses | Retry Plugin - Client Error Responses}
+ */
+declare function isRetryableError(error: unknown): boolean;
 /**
  * Automatically retries failed requests based on customizable retry strategies,
  * improving the resilience of your application.
@@ -342,7 +355,7 @@ interface RetryAfterLinkPluginOptions<T extends ClientContext> {
     condition?: Value<boolean, [
         response: StandardLazyResponse,
         options: StandardLinkTransportInterceptorOptions<T>
-    ]>;
+    ]> | undefined;
     /**
      * Maximum attempts before giving up retries.
      *
@@ -351,7 +364,7 @@ interface RetryAfterLinkPluginOptions<T extends ClientContext> {
     maxAttempts?: Value<number, [
         response: StandardLazyResponse,
         options: StandardLinkTransportInterceptorOptions<T>
-    ]>;
+    ]> | undefined;
     /**
      * Maximum timeout in milliseconds to wait before giving up retries.
      *
@@ -360,7 +373,7 @@ interface RetryAfterLinkPluginOptions<T extends ClientContext> {
     timeout?: Value<number, [
         response: StandardLazyResponse,
         options: StandardLinkTransportInterceptorOptions<T>
-    ]>;
+    ]> | undefined;
 }
 /**
  * The Retry After Link Plugin automatically retries requests based on server `retry-after` header.
@@ -403,5 +416,5 @@ declare class TimeoutLinkPlugin<T extends ClientContext> implements StandardLink
     init(options: StandardLinkOptions<T>): StandardLinkOptions<T>;
 }
 
-export { BatchLinkPlugin, RetryLinkPlugin as ClientRetryPlugin, DedupeLinkPlugin, DedupeLinkPlugin as DedupeRequestsPlugin, RequestCompressionLinkPlugin, ResponseCompressionLinkPlugin, RetryAfterLinkPlugin, RetryAfterLinkPlugin as RetryAfterPlugin, RetryLinkPlugin, TimeoutLinkPlugin };
-export type { BatchLinkPluginGroup, BatchLinkPluginMode, BatchLinkPluginOptions, RetryLinkPluginContext as ClientRetryPluginContext, DedupeLinkPluginGroup, DedupeLinkPluginOptions, RequestCompressionLinkPluginOptions, ResponseCompressionLinkPluginOptions, RetryAfterLinkPluginOptions, RetryLinkPluginAttemptOptions, RetryLinkPluginContext, RetryLinkPluginOptions, TimeoutLinkPluginOptions };
+export { BATCH_HEADER, BatchLinkPlugin, RetryLinkPlugin as ClientRetryPlugin, DEFAULT_BATCH_MAX_SIZE, DedupeLinkPlugin, DedupeLinkPlugin as DedupeRequestsPlugin, RequestCompressionLinkPlugin, ResponseCompressionLinkPlugin, RetryAfterLinkPlugin, RetryAfterLinkPlugin as RetryAfterPlugin, RetryLinkPlugin, TimeoutLinkPlugin, isRetryableError };
+export type { BatchLinkPluginGroup, BatchLinkPluginOptions, RetryLinkPluginContext as ClientRetryPluginContext, DedupeLinkPluginGroup, DedupeLinkPluginOptions, RequestCompressionLinkPluginOptions, ResponseCompressionLinkPluginOptions, RetryAfterLinkPluginOptions, RetryLinkPluginAttemptOptions, RetryLinkPluginContext, RetryLinkPluginOptions, TimeoutLinkPluginOptions };