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

package/dist/plugins/index.d.mts

@@ -1,7 +1,7 @@
 import { Value, Promisable } from '@orpc/shared';
-import { StandardUrl, StandardHeaders, StandardRequest, StandardLazyResponse } from '@standardserver/core';
-import { C as ClientContext } from '../shared/client.8ug8I-zu.mjs';
-import { c as StandardLinkPlugin, d as StandardLinkTransportInterceptorOptions, b as StandardLinkOptions, e as StandardLinkInterceptorOptions } from '../shared/client.Cby_-GGh.mjs';
+import { StandardUrl, StandardHeaders, StandardRequest, StandardLazyResponse } from '@standard-server/core';
+import { ClientContext } from '../index.mjs';
+import { StandardLinkPlugin, StandardLinkTransportInterceptorOptions, StandardLinkOptions, StandardLinkInterceptorOptions } from '../adapters/standard/index.mjs';
 
 type BatchLinkPluginMode = 'streaming' | 'buffered';
 interface BatchLinkPluginGroup<T extends ClientContext> {
@@ -23,8 +23,6 @@ interface BatchLinkPluginGroup<T extends ClientContext> {
      */
     path?: Value<string[], [items: [StandardLinkTransportInterceptorOptions<T>, ...StandardLinkTransportInterceptorOptions<T>[]]]>;
 }
-declare class BatchLinkPluginError extends TypeError {
-}
 interface BatchLinkPluginOptions<T extends ClientContext> {
     groups: [BatchLinkPluginGroup<T>, ...BatchLinkPluginGroup<T>[]];
     /**
@@ -79,6 +77,15 @@ interface BatchLinkPluginOptions<T extends ClientContext> {
      */
     mapSubresponse?: (subResponse: StandardLazyResponse, batchResponse: StandardLazyResponse, subOptions: StandardLinkTransportInterceptorOptions<T>) => StandardLazyResponse;
 }
+/**
+ * Combines multiple client requests into a single batch request
+ * and splits the batch response back into individual responses.
+ *
+ * @remarks
+ * **Note**: HTTP/2 and later already multiplex requests over a single connection, so this plugin is often less useful than it once was.
+ *
+ * @see {@link https://orpc.dev/docs/plugins/batch | Batch Plugin}
+ */
 declare class BatchLinkPlugin<T extends ClientContext> implements StandardLinkPlugin<T> {
     name: string;
     private readonly groups;
@@ -119,10 +126,16 @@ interface DedupeLinkPluginOptions<T extends ClientContext> {
     /**
      * Filters requests to dedupe.
      *
-     * @default ({ request }) => request.method === 'GET'
+     * @default ({ request }) => request.method === 'GET' || request.method === 'QUERY'
      */
     filter?: Value<boolean, [options: StandardLinkTransportInterceptorOptions<T>]>;
 }
+/**
+ * Prevents redundant requests by deduplicating similar in-flight requests,
+ * reducing the number of requests sent to the server.
+ *
+ * @see {@link https://orpc.dev/docs/plugins/dedupe | Dedupe Plugin}
+ */
 declare class DedupeLinkPlugin<T extends ClientContext> implements StandardLinkPlugin<T> {
     name: string;
     before: string[];
@@ -136,6 +149,76 @@ declare class DedupeLinkPlugin<T extends ClientContext> implements StandardLinkP
     private execute;
 }
 
+interface RequestCompressionLinkPluginOptions<T extends ClientContext> {
+    /**
+     * The compression scheme to use for request compression.
+     *
+     * @default 'gzip'
+     */
+    encoding?: 'gzip' | 'deflate' | 'deflate-raw';
+    /**
+     * The minimum request size in bytes required to trigger compression.
+     * Requests smaller than this threshold will not be compressed to avoid overhead.
+     * If the request size cannot be determined, compression will still be applied.
+     *
+     * @default 1024 (1KB)
+     */
+    threshold?: number;
+    /**
+     * Determines whether a request with the given Content-Type should be compressed.
+     * Only consulted for binary transfers (streams, files, and file form-data parts).
+     * Also receives the transport interceptor options for per-request decisions.
+     *
+     * @default isCompressibleContentType (covers common text-based formats)
+     */
+    isCompressibleContentType?: (contentType: string | null | undefined, options: StandardLinkTransportInterceptorOptions<T>) => boolean;
+}
+/**
+ * Compresses request bodies before sending them to the server,
+ * reducing bandwidth usage for large payloads.
+ *
+ * @see {@link https://orpc.dev/docs/plugins/request-compression | Request Compression Plugin}
+ */
+declare class RequestCompressionLinkPlugin<T extends ClientContext> implements StandardLinkPlugin<T> {
+    name: string;
+    /**
+     * Compression should be done after batching, to compress the final request
+     */
+    after: string[];
+    private readonly encoding;
+    private readonly threshold;
+    private readonly isCompressibleContentType;
+    constructor(options?: RequestCompressionLinkPluginOptions<T>);
+    init(options: StandardLinkOptions<T>): StandardLinkOptions<T>;
+}
+
+interface ResponseCompressionLinkPluginOptions<_T extends ClientContext> {
+    /**
+     * Compression schemes to advertise via Accept-Encoding, in preference order.
+     * Only schemes that can be decompressed by this plugin should be listed.
+     *
+     * @default ['gzip', 'deflate']
+     */
+    encodings?: readonly ('gzip' | 'deflate' | 'deflate-raw')[];
+}
+/**
+ * Advertises Accept-Encoding on requests and decompresses response bodies
+ * based on the Content-Encoding header. Works at the standard link level,
+ * so it supports all adapters.
+ *
+ * @see {@link https://orpc.dev/docs/plugins/response-compression | Response Compression Plugin}
+ */
+declare class ResponseCompressionLinkPlugin<T extends ClientContext> implements StandardLinkPlugin<T> {
+    name: string;
+    /**
+     * Decompression should wrap the final batch response instead of sub-responses.
+     */
+    after: string[];
+    private readonly encodings;
+    constructor(options?: ResponseCompressionLinkPluginOptions<T>);
+    init(options: StandardLinkOptions<T>): StandardLinkOptions<T>;
+}
+
 interface RetryLinkPluginAttemptOptions<T extends RetryLinkPluginContext> extends StandardLinkInterceptorOptions<T> {
     /**
      * Latest retry delay advertised by the server via event metadata.
@@ -150,10 +233,16 @@ interface RetryLinkPluginAttemptOptions<T extends RetryLinkPluginContext> extend
      */
     error: unknown;
 }
+/**
+ * Client context options that control retry behavior per call
+ * when the `RetryLinkPlugin` is enabled.
+ *
+ * @see {@link https://orpc.dev/docs/plugins/retry | Retry Plugin}
+ */
 interface RetryLinkPluginContext {
     /**
      * Maximum retry attempts before throwing.
-     * Use `Number.POSITIVE_INFINITY` for infinite retries (e.g. for event iterators).
+     * Use `Number.POSITIVE_INFINITY` for infinite retries (e.g. for AsyncIteratorObject).
      *
      * @default 0
      */
@@ -161,7 +250,9 @@ interface RetryLinkPluginContext {
     /**
      * Delay (in ms) before retrying.
      *
-     * @info Why 2000ms? The EventSource spec suggests a default retry delay of 2 seconds if it doesn't specify
+     * @remarks
+     * **Note**: Why 2000ms? The EventSource spec suggests a default retry delay of 2 seconds if it doesn't specify
+     *
      * @default (o) => o.lastEventRetry ?? 2000
      */
     retryDelay?: Value<Promisable<number>, [RetryLinkPluginAttemptOptions<RetryLinkPluginContext>]>;
@@ -182,8 +273,15 @@ interface RetryLinkPluginOptions<_T extends RetryLinkPluginContext> {
      */
     default?: RetryLinkPluginContext | undefined;
 }
-declare class RetryLinkPluginInvalidEventIteratorRetryResponse extends Error {
-}
+/**
+ * Automatically retries failed requests based on customizable retry strategies,
+ * improving the resilience of your application.
+ *
+ * @remarks
+ * **Note**: Retry behavior is configured through the client context on each call.
+ *
+ * @see {@link https://orpc.dev/docs/plugins/retry | Retry Plugin}
+ */
 declare class RetryLinkPlugin<T extends RetryLinkPluginContext & ClientContext> implements StandardLinkPlugin<T> {
     private readonly defaultRetry;
     private readonly defaultRetryDelay;
@@ -227,7 +325,7 @@ interface RetryAfterLinkPluginOptions<T extends ClientContext> {
  * The Retry After Link Plugin automatically retries requests based on server `retry-after` header.
  * This is particularly useful for handling rate limiting and temporary server unavailability.
  *
- * @see {@link https://orpc.dev/docs/plugins/retry-after Retry After Plugin Docs}
+ * @see {@link https://orpc.dev/docs/plugins/retry-after | Retry After Plugin}
  */
 declare class RetryAfterLinkPlugin<T extends ClientContext> implements StandardLinkPlugin<T> {
     private readonly condition;
@@ -238,5 +336,28 @@ declare class RetryAfterLinkPlugin<T extends ClientContext> implements StandardL
     init(options: StandardLinkOptions<T>): StandardLinkOptions<T>;
 }
 
-export { BatchLinkPlugin, BatchLinkPluginError, DedupeLinkPlugin, RetryAfterLinkPlugin, RetryLinkPlugin, RetryLinkPluginInvalidEventIteratorRetryResponse };
-export type { BatchLinkPluginGroup, BatchLinkPluginMode, BatchLinkPluginOptions, DedupeLinkPluginGroup, DedupeLinkPluginOptions, RetryAfterLinkPluginOptions, RetryLinkPluginAttemptOptions, RetryLinkPluginContext, RetryLinkPluginOptions };
+interface TimeoutLinkPluginOptions<T extends ClientContext> {
+    /**
+     * Timeout in milliseconds before the request is aborted.
+     * Use `null` or `undefined` to disable the timeout.
+     */
+    timeout: Value<number | null | undefined, [options: StandardLinkInterceptorOptions<T>]>;
+}
+/**
+ * The Timeout Link Plugin aborts requests that exceed a configured timeout with an `AbortError`.
+ *
+ * @see {@link https://orpc.dev/docs/plugins/timeout | Timeout Plugin}
+ */
+declare class TimeoutLinkPlugin<T extends ClientContext> implements StandardLinkPlugin<T> {
+    private readonly timeout;
+    name: string;
+    /**
+     * Should abort if the total retry time exceeds the configured timeout
+     */
+    after: string[];
+    constructor(options: NoInfer<TimeoutLinkPluginOptions<T>>);
+    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 };

package/dist/plugins/index.d.ts

@@ -1,7 +1,7 @@
 import { Value, Promisable } from '@orpc/shared';
-import { StandardUrl, StandardHeaders, StandardRequest, StandardLazyResponse } from '@standardserver/core';
-import { C as ClientContext } from '../shared/client.8ug8I-zu.js';
-import { c as StandardLinkPlugin, d as StandardLinkTransportInterceptorOptions, b as StandardLinkOptions, e as StandardLinkInterceptorOptions } from '../shared/client.CPF3hX6O.js';
+import { StandardUrl, StandardHeaders, StandardRequest, StandardLazyResponse } from '@standard-server/core';
+import { ClientContext } from '../index.js';
+import { StandardLinkPlugin, StandardLinkTransportInterceptorOptions, StandardLinkOptions, StandardLinkInterceptorOptions } from '../adapters/standard/index.js';
 
 type BatchLinkPluginMode = 'streaming' | 'buffered';
 interface BatchLinkPluginGroup<T extends ClientContext> {
@@ -23,8 +23,6 @@ interface BatchLinkPluginGroup<T extends ClientContext> {
      */
     path?: Value<string[], [items: [StandardLinkTransportInterceptorOptions<T>, ...StandardLinkTransportInterceptorOptions<T>[]]]>;
 }
-declare class BatchLinkPluginError extends TypeError {
-}
 interface BatchLinkPluginOptions<T extends ClientContext> {
     groups: [BatchLinkPluginGroup<T>, ...BatchLinkPluginGroup<T>[]];
     /**
@@ -79,6 +77,15 @@ interface BatchLinkPluginOptions<T extends ClientContext> {
      */
     mapSubresponse?: (subResponse: StandardLazyResponse, batchResponse: StandardLazyResponse, subOptions: StandardLinkTransportInterceptorOptions<T>) => StandardLazyResponse;
 }
+/**
+ * Combines multiple client requests into a single batch request
+ * and splits the batch response back into individual responses.
+ *
+ * @remarks
+ * **Note**: HTTP/2 and later already multiplex requests over a single connection, so this plugin is often less useful than it once was.
+ *
+ * @see {@link https://orpc.dev/docs/plugins/batch | Batch Plugin}
+ */
 declare class BatchLinkPlugin<T extends ClientContext> implements StandardLinkPlugin<T> {
     name: string;
     private readonly groups;
@@ -119,10 +126,16 @@ interface DedupeLinkPluginOptions<T extends ClientContext> {
     /**
      * Filters requests to dedupe.
      *
-     * @default ({ request }) => request.method === 'GET'
+     * @default ({ request }) => request.method === 'GET' || request.method === 'QUERY'
      */
     filter?: Value<boolean, [options: StandardLinkTransportInterceptorOptions<T>]>;
 }
+/**
+ * Prevents redundant requests by deduplicating similar in-flight requests,
+ * reducing the number of requests sent to the server.
+ *
+ * @see {@link https://orpc.dev/docs/plugins/dedupe | Dedupe Plugin}
+ */
 declare class DedupeLinkPlugin<T extends ClientContext> implements StandardLinkPlugin<T> {
     name: string;
     before: string[];
@@ -136,6 +149,76 @@ declare class DedupeLinkPlugin<T extends ClientContext> implements StandardLinkP
     private execute;
 }
 
+interface RequestCompressionLinkPluginOptions<T extends ClientContext> {
+    /**
+     * The compression scheme to use for request compression.
+     *
+     * @default 'gzip'
+     */
+    encoding?: 'gzip' | 'deflate' | 'deflate-raw';
+    /**
+     * The minimum request size in bytes required to trigger compression.
+     * Requests smaller than this threshold will not be compressed to avoid overhead.
+     * If the request size cannot be determined, compression will still be applied.
+     *
+     * @default 1024 (1KB)
+     */
+    threshold?: number;
+    /**
+     * Determines whether a request with the given Content-Type should be compressed.
+     * Only consulted for binary transfers (streams, files, and file form-data parts).
+     * Also receives the transport interceptor options for per-request decisions.
+     *
+     * @default isCompressibleContentType (covers common text-based formats)
+     */
+    isCompressibleContentType?: (contentType: string | null | undefined, options: StandardLinkTransportInterceptorOptions<T>) => boolean;
+}
+/**
+ * Compresses request bodies before sending them to the server,
+ * reducing bandwidth usage for large payloads.
+ *
+ * @see {@link https://orpc.dev/docs/plugins/request-compression | Request Compression Plugin}
+ */
+declare class RequestCompressionLinkPlugin<T extends ClientContext> implements StandardLinkPlugin<T> {
+    name: string;
+    /**
+     * Compression should be done after batching, to compress the final request
+     */
+    after: string[];
+    private readonly encoding;
+    private readonly threshold;
+    private readonly isCompressibleContentType;
+    constructor(options?: RequestCompressionLinkPluginOptions<T>);
+    init(options: StandardLinkOptions<T>): StandardLinkOptions<T>;
+}
+
+interface ResponseCompressionLinkPluginOptions<_T extends ClientContext> {
+    /**
+     * Compression schemes to advertise via Accept-Encoding, in preference order.
+     * Only schemes that can be decompressed by this plugin should be listed.
+     *
+     * @default ['gzip', 'deflate']
+     */
+    encodings?: readonly ('gzip' | 'deflate' | 'deflate-raw')[];
+}
+/**
+ * Advertises Accept-Encoding on requests and decompresses response bodies
+ * based on the Content-Encoding header. Works at the standard link level,
+ * so it supports all adapters.
+ *
+ * @see {@link https://orpc.dev/docs/plugins/response-compression | Response Compression Plugin}
+ */
+declare class ResponseCompressionLinkPlugin<T extends ClientContext> implements StandardLinkPlugin<T> {
+    name: string;
+    /**
+     * Decompression should wrap the final batch response instead of sub-responses.
+     */
+    after: string[];
+    private readonly encodings;
+    constructor(options?: ResponseCompressionLinkPluginOptions<T>);
+    init(options: StandardLinkOptions<T>): StandardLinkOptions<T>;
+}
+
 interface RetryLinkPluginAttemptOptions<T extends RetryLinkPluginContext> extends StandardLinkInterceptorOptions<T> {
     /**
      * Latest retry delay advertised by the server via event metadata.
@@ -150,10 +233,16 @@ interface RetryLinkPluginAttemptOptions<T extends RetryLinkPluginContext> extend
      */
     error: unknown;
 }
+/**
+ * Client context options that control retry behavior per call
+ * when the `RetryLinkPlugin` is enabled.
+ *
+ * @see {@link https://orpc.dev/docs/plugins/retry | Retry Plugin}
+ */
 interface RetryLinkPluginContext {
     /**
      * Maximum retry attempts before throwing.
-     * Use `Number.POSITIVE_INFINITY` for infinite retries (e.g. for event iterators).
+     * Use `Number.POSITIVE_INFINITY` for infinite retries (e.g. for AsyncIteratorObject).
      *
      * @default 0
      */
@@ -161,7 +250,9 @@ interface RetryLinkPluginContext {
     /**
      * Delay (in ms) before retrying.
      *
-     * @info Why 2000ms? The EventSource spec suggests a default retry delay of 2 seconds if it doesn't specify
+     * @remarks
+     * **Note**: Why 2000ms? The EventSource spec suggests a default retry delay of 2 seconds if it doesn't specify
+     *
      * @default (o) => o.lastEventRetry ?? 2000
      */
     retryDelay?: Value<Promisable<number>, [RetryLinkPluginAttemptOptions<RetryLinkPluginContext>]>;
@@ -182,8 +273,15 @@ interface RetryLinkPluginOptions<_T extends RetryLinkPluginContext> {
      */
     default?: RetryLinkPluginContext | undefined;
 }
-declare class RetryLinkPluginInvalidEventIteratorRetryResponse extends Error {
-}
+/**
+ * Automatically retries failed requests based on customizable retry strategies,
+ * improving the resilience of your application.
+ *
+ * @remarks
+ * **Note**: Retry behavior is configured through the client context on each call.
+ *
+ * @see {@link https://orpc.dev/docs/plugins/retry | Retry Plugin}
+ */
 declare class RetryLinkPlugin<T extends RetryLinkPluginContext & ClientContext> implements StandardLinkPlugin<T> {
     private readonly defaultRetry;
     private readonly defaultRetryDelay;
@@ -227,7 +325,7 @@ interface RetryAfterLinkPluginOptions<T extends ClientContext> {
  * The Retry After Link Plugin automatically retries requests based on server `retry-after` header.
  * This is particularly useful for handling rate limiting and temporary server unavailability.
  *
- * @see {@link https://orpc.dev/docs/plugins/retry-after Retry After Plugin Docs}
+ * @see {@link https://orpc.dev/docs/plugins/retry-after | Retry After Plugin}
  */
 declare class RetryAfterLinkPlugin<T extends ClientContext> implements StandardLinkPlugin<T> {
     private readonly condition;
@@ -238,5 +336,28 @@ declare class RetryAfterLinkPlugin<T extends ClientContext> implements StandardL
     init(options: StandardLinkOptions<T>): StandardLinkOptions<T>;
 }
 
-export { BatchLinkPlugin, BatchLinkPluginError, DedupeLinkPlugin, RetryAfterLinkPlugin, RetryLinkPlugin, RetryLinkPluginInvalidEventIteratorRetryResponse };
-export type { BatchLinkPluginGroup, BatchLinkPluginMode, BatchLinkPluginOptions, DedupeLinkPluginGroup, DedupeLinkPluginOptions, RetryAfterLinkPluginOptions, RetryLinkPluginAttemptOptions, RetryLinkPluginContext, RetryLinkPluginOptions };
+interface TimeoutLinkPluginOptions<T extends ClientContext> {
+    /**
+     * Timeout in milliseconds before the request is aborted.
+     * Use `null` or `undefined` to disable the timeout.
+     */
+    timeout: Value<number | null | undefined, [options: StandardLinkInterceptorOptions<T>]>;
+}
+/**
+ * The Timeout Link Plugin aborts requests that exceed a configured timeout with an `AbortError`.
+ *
+ * @see {@link https://orpc.dev/docs/plugins/timeout | Timeout Plugin}
+ */
+declare class TimeoutLinkPlugin<T extends ClientContext> implements StandardLinkPlugin<T> {
+    private readonly timeout;
+    name: string;
+    /**
+     * Should abort if the total retry time exceeds the configured timeout
+     */
+    after: string[];
+    constructor(options: NoInfer<TimeoutLinkPluginOptions<T>>);
+    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 };