@orpc/client 0.0.0-next.f81b4a2 → 0.0.0-next.f9e0a4c

package/dist/index.d.ts

@@ -1,14 +1,14 @@
-import { N as NestedClient, C as ClientLink, I as InferClientContext, a as ClientContext, b as ClientOptions, c as ClientPromiseResult, F as FriendlyClientOptions } from './shared/client.CipPQkhk.js';
-export { f as Client, e as ClientRest, d as HTTPMethod, H as HTTPPath } from './shared/client.CipPQkhk.js';
-import { Promisable, MaybeOptionalOptions, ThrowableError } from '@orpc/shared';
-export { Registry, ThrowableError, onError, onFinish, onStart, onSuccess } from '@orpc/shared';
+import { N as NestedClient, C as ClientLink, I as InferClientContext, a as ClientPromiseResult, b as ClientContext, F as FriendlyClientOptions, c as ClientOptions, d as Client, e as ClientRest } from './shared/client.BOYsZIRq.js';
+export { f as HTTPMethod, H as HTTPPath } from './shared/client.BOYsZIRq.js';
+import { MaybeOptionalOptions, ThrowableError, Promisable, AsyncIteratorClass } from '@orpc/shared';
+export { AsyncIteratorClass, EventPublisher, EventPublisherOptions, EventPublisherSubscribeIteratorOptions, Registry, ThrowableError, asyncIteratorToStream as eventIteratorToStream, onError, onFinish, onStart, onSuccess, streamToAsyncIteratorClass as streamToEventIterator } from '@orpc/shared';
 export { ErrorEvent } from '@orpc/standard-server';
 
 interface createORPCClientOptions {
     /**
      * Use as base path for all procedure, useful when you only want to call a subset of the procedure.
      */
-    path?: string[];
+    path?: readonly string[];
 }
 /**
  * Create a oRPC client-side client from a link.
@@ -17,18 +17,6 @@ interface createORPCClientOptions {
  */
 declare function createORPCClient<T extends NestedClient<any>>(link: ClientLink<InferClientContext<T>>, options?: createORPCClientOptions): T;
 
-/**
- * DynamicLink provides a way to dynamically resolve and delegate calls to other ClientLinks
- * based on the request path, input, and context.
- *
- * @see {@link https://orpc.unnoq.com/docs/client/dynamic-link Dynamic Link Docs}
- */
-declare class DynamicLink<TClientContext extends ClientContext> implements ClientLink<TClientContext> {
-    private readonly linkResolver;
-    constructor(linkResolver: (options: ClientOptions<TClientContext>, path: readonly string[], input: unknown) => Promisable<ClientLink<TClientContext>>);
-    call(path: readonly string[], input: unknown, options: ClientOptions<TClientContext>): Promise<unknown>;
-}
-
 declare const COMMON_ORPC_ERROR_DEFS: {
     readonly BAD_REQUEST: {
         readonly status: 400;
@@ -125,7 +113,7 @@ declare class ORPCError<TCode extends ORPCErrorCode, TData> extends Error {
     readonly code: TCode;
     readonly status: number;
     readonly data: TData;
-    constructor(code: TCode, ...[options]: MaybeOptionalOptions<ORPCErrorOptions<TData>>);
+    constructor(code: TCode, ...rest: MaybeOptionalOptions<ORPCErrorOptions<TData>>);
     toJSON(): ORPCErrorJSON<TCode, TData>;
 }
 type ORPCErrorJSON<TCode extends string, TData> = Pick<ORPCError<TCode, TData>, 'defined' | 'code' | 'status' | 'message' | 'data'>;
@@ -135,11 +123,6 @@ declare function isORPCErrorStatus(status: number): boolean;
 declare function isORPCErrorJson(json: unknown): json is ORPCErrorJSON<ORPCErrorCode, unknown>;
 declare function createORPCErrorFromJson<TCode extends ORPCErrorCode, TData>(json: ORPCErrorJSON<TCode, TData>, options?: ErrorOptions): ORPCError<TCode, TData>;
 
-declare function mapEventIterator<TYield, TReturn, TNext, TMap = TYield | TReturn>(iterator: AsyncIterator<TYield, TReturn, TNext>, maps: {
-    value: (value: NoInfer<TYield | TReturn>, done: boolean | undefined) => Promise<TMap>;
-    error: (error: unknown) => Promise<unknown>;
-}): AsyncGenerator<TMap, TMap, TNext>;
-
 type SafeResult<TOutput, TError> = [error: null, data: TOutput, isDefined: false, isSuccess: true] & {
     error: null;
     data: TOutput;
@@ -165,5 +148,38 @@ type SafeResult<TOutput, TError> = [error: null, data: TOutput, isDefined: false
 declare function safe<TOutput, TError = ThrowableError>(promise: ClientPromiseResult<TOutput, TError>): Promise<SafeResult<TOutput, TError>>;
 declare function resolveFriendlyClientOptions<T extends ClientContext>(options: FriendlyClientOptions<T>): ClientOptions<T>;
 
-export { COMMON_ORPC_ERROR_DEFS, ClientContext, ClientLink, ClientOptions, ClientPromiseResult, DynamicLink, FriendlyClientOptions, InferClientContext, NestedClient, ORPCError, createORPCClient, createORPCErrorFromJson, fallbackORPCErrorMessage, fallbackORPCErrorStatus, isDefinedError, isORPCErrorJson, isORPCErrorStatus, mapEventIterator, resolveFriendlyClientOptions, safe, toORPCError };
-export type { CommonORPCErrorCode, ORPCErrorCode, ORPCErrorJSON, ORPCErrorOptions, SafeResult, createORPCClientOptions };
+type SafeClient<T extends NestedClient<any>> = T extends Client<infer UContext, infer UInput, infer UOutput, infer UError> ? (...rest: ClientRest<UContext, UInput>) => Promise<SafeResult<UOutput, UError>> : {
+    [K in keyof T]: T[K] extends NestedClient<any> ? SafeClient<T[K]> : never;
+};
+/**
+ * Create a safe client that automatically wraps all procedure calls with the `safe` util.
+ *
+ * @example
+ * ```ts
+ * const safeClient = createSafeClient(client)
+ * const { error, data, isDefined } = await safeClient.doSomething({ id: '123' })
+ * ```
+ *
+ * @see {@link https://orpc.unnoq.com/docs/client/error-handling#using-createsafeclient Safe Client Docs}
+ */
+declare function createSafeClient<T extends NestedClient<any>>(client: T): SafeClient<T>;
+
+/**
+ * DynamicLink provides a way to dynamically resolve and delegate calls to other ClientLinks
+ * based on the request path, input, and context.
+ *
+ * @see {@link https://orpc.unnoq.com/docs/client/dynamic-link Dynamic Link Docs}
+ */
+declare class DynamicLink<TClientContext extends ClientContext> implements ClientLink<TClientContext> {
+    private readonly linkResolver;
+    constructor(linkResolver: (options: ClientOptions<TClientContext>, path: readonly string[], input: unknown) => Promisable<ClientLink<TClientContext>>);
+    call(path: readonly string[], input: unknown, options: ClientOptions<TClientContext>): Promise<unknown>;
+}
+
+declare function mapEventIterator<TYield, TReturn, TNext, TMap = TYield | TReturn>(iterator: AsyncIterator<TYield, TReturn, TNext>, maps: {
+    value: (value: NoInfer<TYield | TReturn>, done: boolean | undefined) => Promise<TMap>;
+    error: (error: unknown) => Promise<unknown>;
+}): AsyncIteratorClass<TMap, TMap, TNext>;
+
+export { COMMON_ORPC_ERROR_DEFS, Client, ClientContext, ClientLink, ClientOptions, ClientPromiseResult, ClientRest, DynamicLink, FriendlyClientOptions, InferClientContext, NestedClient, ORPCError, createORPCClient, createORPCErrorFromJson, createSafeClient, fallbackORPCErrorMessage, fallbackORPCErrorStatus, isDefinedError, isORPCErrorJson, isORPCErrorStatus, mapEventIterator, resolveFriendlyClientOptions, safe, toORPCError };
+export type { CommonORPCErrorCode, ORPCErrorCode, ORPCErrorJSON, ORPCErrorOptions, SafeClient, SafeResult, createORPCClientOptions };

package/dist/index.mjs

@@ -1,6 +1,7 @@
-import { i as isDefinedError } from './shared/client.CRWEpqLB.mjs';
-export { C as COMMON_ORPC_ERROR_DEFS, O as ORPCError, d as createORPCErrorFromJson, a as fallbackORPCErrorMessage, f as fallbackORPCErrorStatus, c as isORPCErrorJson, b as isORPCErrorStatus, m as mapEventIterator, t as toORPCError } from './shared/client.CRWEpqLB.mjs';
-export { onError, onFinish, onStart, onSuccess } from '@orpc/shared';
+import { i as isDefinedError } from './shared/client.txdq_i5V.mjs';
+export { C as COMMON_ORPC_ERROR_DEFS, O as ORPCError, d as createORPCErrorFromJson, a as fallbackORPCErrorMessage, f as fallbackORPCErrorStatus, c as isORPCErrorJson, b as isORPCErrorStatus, m as mapEventIterator, t as toORPCError } from './shared/client.txdq_i5V.mjs';
+import { isTypescriptObject } from '@orpc/shared';
+export { AsyncIteratorClass, EventPublisher, asyncIteratorToStream as eventIteratorToStream, onError, onFinish, onStart, onSuccess, streamToAsyncIteratorClass as streamToEventIterator } from '@orpc/shared';
 export { ErrorEvent } from '@orpc/standard-server';
 
 async function safe(promise) {
@@ -27,13 +28,13 @@ async function safe(promise) {
 function resolveFriendlyClientOptions(options) {
   return {
     ...options,
-    context: options?.context ?? {}
+    context: options.context ?? {}
     // Context only optional if all fields are optional
   };
 }
 
-function createORPCClient(link, options) {
-  const path = options?.path ?? [];
+function createORPCClient(link, options = {}) {
+  const path = options.path ?? [];
   const procedureClient = async (...[input, options2 = {}]) => {
     return await link.call(path, input, resolveFriendlyClientOptions(options2));
   };
@@ -51,6 +52,22 @@ function createORPCClient(link, options) {
   return recursive;
 }
 
+function createSafeClient(client) {
+  const proxy = new Proxy((...args) => safe(client(...args)), {
+    get(_, prop, receiver) {
+      const value = Reflect.get(client, prop, receiver);
+      if (typeof prop !== "string") {
+        return value;
+      }
+      if (!isTypescriptObject(value)) {
+        return value;
+      }
+      return createSafeClient(value);
+    }
+  });
+  return proxy;
+}
+
 class DynamicLink {
   constructor(linkResolver) {
     this.linkResolver = linkResolver;
@@ -62,4 +79,4 @@ class DynamicLink {
   }
 }
 
-export { DynamicLink, createORPCClient, isDefinedError, resolveFriendlyClientOptions, safe };
+export { DynamicLink, createORPCClient, createSafeClient, isDefinedError, resolveFriendlyClientOptions, safe };

package/dist/plugins/index.d.mts

@@ -1,7 +1,8 @@
-import { Value } from '@orpc/shared';
+import { Value, Promisable } from '@orpc/shared';
 import { StandardHeaders, StandardRequest } from '@orpc/standard-server';
-import { S as StandardLinkClientInterceptorOptions, a as StandardLinkPlugin, b as StandardLinkOptions, c as StandardLinkInterceptorOptions } from '../shared/client.FXep-a3a.mjs';
-import { a as ClientContext } from '../shared/client.CipPQkhk.mjs';
+import { BatchResponseMode } from '@orpc/standard-server/batch';
+import { S as StandardLinkClientInterceptorOptions, a as StandardLinkPlugin, b as StandardLinkOptions, c as StandardLinkInterceptorOptions } from '../shared/client.Bwgm6dgk.mjs';
+import { b as ClientContext } from '../shared/client.BOYsZIRq.mjs';
 
 interface BatchLinkPluginGroup<T extends ClientContext> {
     condition(options: StandardLinkClientInterceptorOptions<T>): boolean;
@@ -16,25 +17,31 @@ interface BatchLinkPluginOptions<T extends ClientContext> {
      *
      * @default 10
      */
-    maxSize?: Value<number, [readonly [StandardLinkClientInterceptorOptions<T>, ...StandardLinkClientInterceptorOptions<T>[]]]>;
+    maxSize?: Value<Promisable<number>, [readonly [StandardLinkClientInterceptorOptions<T>, ...StandardLinkClientInterceptorOptions<T>[]]]>;
+    /**
+     * The batch response mode.
+     *
+     * @default 'streaming'
+     */
+    mode?: Value<BatchResponseMode, [readonly [StandardLinkClientInterceptorOptions<T>, ...StandardLinkClientInterceptorOptions<T>[]]]>;
     /**
      * Defines the URL to use for the batch request.
      *
      * @default the URL of the first request in the batch + '/__batch__'
      */
-    url?: Value<string | URL, [readonly [StandardLinkClientInterceptorOptions<T>, ...StandardLinkClientInterceptorOptions<T>[]]]>;
+    url?: Value<Promisable<string | URL>, [readonly [StandardLinkClientInterceptorOptions<T>, ...StandardLinkClientInterceptorOptions<T>[]]]>;
     /**
      * The maximum length of the URL.
      *
      * @default 2083
      */
-    maxUrlLength?: Value<number, [readonly [StandardLinkClientInterceptorOptions<T>, ...StandardLinkClientInterceptorOptions<T>[]]]>;
+    maxUrlLength?: Value<Promisable<number>, [readonly [StandardLinkClientInterceptorOptions<T>, ...StandardLinkClientInterceptorOptions<T>[]]]>;
     /**
      * Defines the HTTP headers to use for the batch request.
      *
      * @default The same headers of all requests in the batch
      */
-    headers?: Value<StandardHeaders, [readonly [StandardLinkClientInterceptorOptions<T>, ...StandardLinkClientInterceptorOptions<T>[]]]>;
+    headers?: Value<Promisable<StandardHeaders>, [readonly [StandardLinkClientInterceptorOptions<T>, ...StandardLinkClientInterceptorOptions<T>[]]]>;
     /**
      * Map the batch request items before sending them.
      *
@@ -52,10 +59,10 @@ interface BatchLinkPluginOptions<T extends ClientContext> {
     exclude?: (options: StandardLinkClientInterceptorOptions<T>) => boolean;
 }
 /**
- * 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 BatchLinkPlugin<T extends ClientContext> implements StandardLinkPlugin<T> {
     #private;
@@ -66,9 +73,42 @@ declare class BatchLinkPlugin<T extends ClientContext> implements StandardLinkPl
     private readonly batchHeaders;
     private readonly mapRequestItem;
     private readonly exclude;
+    private readonly mode;
     private pending;
     order: number;
-    constructor(options: BatchLinkPluginOptions<T>);
+    constructor(options: NoInfer<BatchLinkPluginOptions<T>>);
+    init(options: StandardLinkOptions<T>): void;
+}
+
+interface DedupeRequestsPluginGroup<T extends ClientContext> {
+    condition(options: StandardLinkClientInterceptorOptions<T>): boolean;
+    /**
+     * The context used for the rest of the request lifecycle.
+     */
+    context: T;
+}
+interface DedupeRequestsPluginOptions<T extends ClientContext> {
+    /**
+     * To enable deduplication, a request must match at least one defined group.
+     * Requests that fall into the same group are considered for deduplication together.
+     */
+    groups: readonly [DedupeRequestsPluginGroup<T>, ...DedupeRequestsPluginGroup<T>[]];
+    /**
+     * Filters requests to dedupe
+     *
+     * @default (({ request }) => request.method === 'GET')
+     */
+    filter?: (options: StandardLinkClientInterceptorOptions<T>) => boolean;
+}
+/**
+ * Prevents duplicate requests by deduplicating similar ones to reduce server load.
+ *
+ * @see {@link https://orpc.unnoq.com/docs/plugins/dedupe-requests Dedupe Requests Plugin}
+ */
+declare class DedupeRequestsPlugin<T extends ClientContext> implements StandardLinkPlugin<T> {
+    #private;
+    order: number;
+    constructor(options: NoInfer<DedupeRequestsPluginOptions<T>>);
     init(options: StandardLinkOptions<T>): void;
 }
 
@@ -84,19 +124,19 @@ interface ClientRetryPluginContext {
      *
      * @default 0
      */
-    retry?: Value<number, [StandardLinkInterceptorOptions<ClientRetryPluginContext>]>;
+    retry?: Value<Promisable<number>, [StandardLinkInterceptorOptions<ClientRetryPluginContext>]>;
     /**
      * Delay (in ms) before retrying.
      *
      * @default (o) => o.lastEventRetry ?? 2000
      */
-    retryDelay?: Value<number, [ClientRetryPluginAttemptOptions<ClientRetryPluginContext>]>;
+    retryDelay?: Value<Promisable<number>, [ClientRetryPluginAttemptOptions<ClientRetryPluginContext>]>;
     /**
      * Determine should retry or not.
      *
      * @default true
      */
-    shouldRetry?: Value<boolean, [ClientRetryPluginAttemptOptions<ClientRetryPluginContext>]>;
+    shouldRetry?: Value<Promisable<boolean>, [ClientRetryPluginAttemptOptions<ClientRetryPluginContext>]>;
     /**
      * The hook called when retrying, and return the unsubscribe function.
      */
@@ -127,20 +167,20 @@ interface SimpleCsrfProtectionLinkPluginOptions<T extends ClientContext> {
      *
      * @default 'x-csrf-token'
      */
-    headerName?: Value<string, [options: StandardLinkClientInterceptorOptions<T>]>;
+    headerName?: Value<Promisable<string>, [options: StandardLinkClientInterceptorOptions<T>]>;
     /**
      * The value of the header to check.
      *
      * @default 'orpc'
      *
      */
-    headerValue?: Value<string, [options: StandardLinkClientInterceptorOptions<T>]>;
+    headerValue?: Value<Promisable<string>, [options: StandardLinkClientInterceptorOptions<T>]>;
     /**
      * Exclude a procedure from the plugin.
      *
      * @default false
      */
-    exclude?: Value<boolean, [options: StandardLinkClientInterceptorOptions<T>]>;
+    exclude?: Value<Promisable<boolean>, [options: StandardLinkClientInterceptorOptions<T>]>;
 }
 /**
  * This plugin adds basic Cross-Site Request Forgery (CSRF) protection to your oRPC application.
@@ -158,5 +198,5 @@ declare class SimpleCsrfProtectionLinkPlugin<T extends ClientContext> implements
     init(options: StandardLinkOptions<T>): void;
 }
 
-export { BatchLinkPlugin, ClientRetryPlugin, ClientRetryPluginInvalidEventIteratorRetryResponse, SimpleCsrfProtectionLinkPlugin };
-export type { BatchLinkPluginGroup, BatchLinkPluginOptions, ClientRetryPluginAttemptOptions, ClientRetryPluginContext, ClientRetryPluginOptions, SimpleCsrfProtectionLinkPluginOptions };
+export { BatchLinkPlugin, ClientRetryPlugin, ClientRetryPluginInvalidEventIteratorRetryResponse, DedupeRequestsPlugin, SimpleCsrfProtectionLinkPlugin };
+export type { BatchLinkPluginGroup, BatchLinkPluginOptions, ClientRetryPluginAttemptOptions, ClientRetryPluginContext, ClientRetryPluginOptions, DedupeRequestsPluginGroup, DedupeRequestsPluginOptions, SimpleCsrfProtectionLinkPluginOptions };

package/dist/plugins/index.d.ts

@@ -1,7 +1,8 @@
-import { Value } from '@orpc/shared';
+import { Value, Promisable } from '@orpc/shared';
 import { StandardHeaders, StandardRequest } from '@orpc/standard-server';
-import { S as StandardLinkClientInterceptorOptions, a as StandardLinkPlugin, b as StandardLinkOptions, c as StandardLinkInterceptorOptions } from '../shared/client.C9U9n1f3.js';
-import { a as ClientContext } from '../shared/client.CipPQkhk.js';
+import { BatchResponseMode } from '@orpc/standard-server/batch';
+import { S as StandardLinkClientInterceptorOptions, a as StandardLinkPlugin, b as StandardLinkOptions, c as StandardLinkInterceptorOptions } from '../shared/client.BG98rYdO.js';
+import { b as ClientContext } from '../shared/client.BOYsZIRq.js';
 
 interface BatchLinkPluginGroup<T extends ClientContext> {
     condition(options: StandardLinkClientInterceptorOptions<T>): boolean;
@@ -16,25 +17,31 @@ interface BatchLinkPluginOptions<T extends ClientContext> {
      *
      * @default 10
      */
-    maxSize?: Value<number, [readonly [StandardLinkClientInterceptorOptions<T>, ...StandardLinkClientInterceptorOptions<T>[]]]>;
+    maxSize?: Value<Promisable<number>, [readonly [StandardLinkClientInterceptorOptions<T>, ...StandardLinkClientInterceptorOptions<T>[]]]>;
+    /**
+     * The batch response mode.
+     *
+     * @default 'streaming'
+     */
+    mode?: Value<BatchResponseMode, [readonly [StandardLinkClientInterceptorOptions<T>, ...StandardLinkClientInterceptorOptions<T>[]]]>;
     /**
      * Defines the URL to use for the batch request.
      *
      * @default the URL of the first request in the batch + '/__batch__'
      */
-    url?: Value<string | URL, [readonly [StandardLinkClientInterceptorOptions<T>, ...StandardLinkClientInterceptorOptions<T>[]]]>;
+    url?: Value<Promisable<string | URL>, [readonly [StandardLinkClientInterceptorOptions<T>, ...StandardLinkClientInterceptorOptions<T>[]]]>;
     /**
      * The maximum length of the URL.
      *
      * @default 2083
      */
-    maxUrlLength?: Value<number, [readonly [StandardLinkClientInterceptorOptions<T>, ...StandardLinkClientInterceptorOptions<T>[]]]>;
+    maxUrlLength?: Value<Promisable<number>, [readonly [StandardLinkClientInterceptorOptions<T>, ...StandardLinkClientInterceptorOptions<T>[]]]>;
     /**
      * Defines the HTTP headers to use for the batch request.
      *
      * @default The same headers of all requests in the batch
      */
-    headers?: Value<StandardHeaders, [readonly [StandardLinkClientInterceptorOptions<T>, ...StandardLinkClientInterceptorOptions<T>[]]]>;
+    headers?: Value<Promisable<StandardHeaders>, [readonly [StandardLinkClientInterceptorOptions<T>, ...StandardLinkClientInterceptorOptions<T>[]]]>;
     /**
      * Map the batch request items before sending them.
      *
@@ -52,10 +59,10 @@ interface BatchLinkPluginOptions<T extends ClientContext> {
     exclude?: (options: StandardLinkClientInterceptorOptions<T>) => boolean;
 }
 /**
- * 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 BatchLinkPlugin<T extends ClientContext> implements StandardLinkPlugin<T> {
     #private;
@@ -66,9 +73,42 @@ declare class BatchLinkPlugin<T extends ClientContext> implements StandardLinkPl
     private readonly batchHeaders;
     private readonly mapRequestItem;
     private readonly exclude;
+    private readonly mode;
     private pending;
     order: number;
-    constructor(options: BatchLinkPluginOptions<T>);
+    constructor(options: NoInfer<BatchLinkPluginOptions<T>>);
+    init(options: StandardLinkOptions<T>): void;
+}
+
+interface DedupeRequestsPluginGroup<T extends ClientContext> {
+    condition(options: StandardLinkClientInterceptorOptions<T>): boolean;
+    /**
+     * The context used for the rest of the request lifecycle.
+     */
+    context: T;
+}
+interface DedupeRequestsPluginOptions<T extends ClientContext> {
+    /**
+     * To enable deduplication, a request must match at least one defined group.
+     * Requests that fall into the same group are considered for deduplication together.
+     */
+    groups: readonly [DedupeRequestsPluginGroup<T>, ...DedupeRequestsPluginGroup<T>[]];
+    /**
+     * Filters requests to dedupe
+     *
+     * @default (({ request }) => request.method === 'GET')
+     */
+    filter?: (options: StandardLinkClientInterceptorOptions<T>) => boolean;
+}
+/**
+ * Prevents duplicate requests by deduplicating similar ones to reduce server load.
+ *
+ * @see {@link https://orpc.unnoq.com/docs/plugins/dedupe-requests Dedupe Requests Plugin}
+ */
+declare class DedupeRequestsPlugin<T extends ClientContext> implements StandardLinkPlugin<T> {
+    #private;
+    order: number;
+    constructor(options: NoInfer<DedupeRequestsPluginOptions<T>>);
     init(options: StandardLinkOptions<T>): void;
 }
 
@@ -84,19 +124,19 @@ interface ClientRetryPluginContext {
      *
      * @default 0
      */
-    retry?: Value<number, [StandardLinkInterceptorOptions<ClientRetryPluginContext>]>;
+    retry?: Value<Promisable<number>, [StandardLinkInterceptorOptions<ClientRetryPluginContext>]>;
     /**
      * Delay (in ms) before retrying.
      *
      * @default (o) => o.lastEventRetry ?? 2000
      */
-    retryDelay?: Value<number, [ClientRetryPluginAttemptOptions<ClientRetryPluginContext>]>;
+    retryDelay?: Value<Promisable<number>, [ClientRetryPluginAttemptOptions<ClientRetryPluginContext>]>;
     /**
      * Determine should retry or not.
      *
      * @default true
      */
-    shouldRetry?: Value<boolean, [ClientRetryPluginAttemptOptions<ClientRetryPluginContext>]>;
+    shouldRetry?: Value<Promisable<boolean>, [ClientRetryPluginAttemptOptions<ClientRetryPluginContext>]>;
     /**
      * The hook called when retrying, and return the unsubscribe function.
      */
@@ -127,20 +167,20 @@ interface SimpleCsrfProtectionLinkPluginOptions<T extends ClientContext> {
      *
      * @default 'x-csrf-token'
      */
-    headerName?: Value<string, [options: StandardLinkClientInterceptorOptions<T>]>;
+    headerName?: Value<Promisable<string>, [options: StandardLinkClientInterceptorOptions<T>]>;
     /**
      * The value of the header to check.
      *
      * @default 'orpc'
      *
      */
-    headerValue?: Value<string, [options: StandardLinkClientInterceptorOptions<T>]>;
+    headerValue?: Value<Promisable<string>, [options: StandardLinkClientInterceptorOptions<T>]>;
     /**
      * Exclude a procedure from the plugin.
      *
      * @default false
      */
-    exclude?: Value<boolean, [options: StandardLinkClientInterceptorOptions<T>]>;
+    exclude?: Value<Promisable<boolean>, [options: StandardLinkClientInterceptorOptions<T>]>;
 }
 /**
  * This plugin adds basic Cross-Site Request Forgery (CSRF) protection to your oRPC application.
@@ -158,5 +198,5 @@ declare class SimpleCsrfProtectionLinkPlugin<T extends ClientContext> implements
     init(options: StandardLinkOptions<T>): void;
 }
 
-export { BatchLinkPlugin, ClientRetryPlugin, ClientRetryPluginInvalidEventIteratorRetryResponse, SimpleCsrfProtectionLinkPlugin };
-export type { BatchLinkPluginGroup, BatchLinkPluginOptions, ClientRetryPluginAttemptOptions, ClientRetryPluginContext, ClientRetryPluginOptions, SimpleCsrfProtectionLinkPluginOptions };
+export { BatchLinkPlugin, ClientRetryPlugin, ClientRetryPluginInvalidEventIteratorRetryResponse, DedupeRequestsPlugin, SimpleCsrfProtectionLinkPlugin };
+export type { BatchLinkPluginGroup, BatchLinkPluginOptions, ClientRetryPluginAttemptOptions, ClientRetryPluginContext, ClientRetryPluginOptions, DedupeRequestsPluginGroup, DedupeRequestsPluginOptions, SimpleCsrfProtectionLinkPluginOptions };

package/dist/plugins/index.mjs

@@ -1,6 +1,6 @@
-import { isAsyncIteratorObject, value, splitInHalf, toArray } from '@orpc/shared';
-import { toBatchRequest, parseBatchResponse } from '@orpc/standard-server/batch';
-import { getEventMeta } from '@orpc/standard-server';
+import { isAsyncIteratorObject, defer, value, splitInHalf, toArray, stringifyJSON } from '@orpc/shared';
+import { toBatchRequest, parseBatchResponse, toBatchAbortSignal } from '@orpc/standard-server/batch';
+import { replicateStandardLazyResponse, getEventMeta } from '@orpc/standard-server';
 
 class BatchLinkPlugin {
   groups;
@@ -10,6 +10,7 @@ class BatchLinkPlugin {
   batchHeaders;
   mapRequestItem;
   exclude;
+  mode;
   pending;
   order = 5e6;
   constructor(options) {
@@ -17,6 +18,7 @@ class BatchLinkPlugin {
     this.pending = /* @__PURE__ */ new Map();
     this.maxSize = options.maxSize ?? 10;
     this.maxUrlLength = options.maxUrlLength ?? 2083;
+    this.mode = options.mode ?? "streaming";
     this.batchUrl = options.url ?? (([options2]) => `${options2.request.url.origin}${options2.request.url.pathname}/__batch__`);
     this.batchHeaders = options.headers ?? (([options2, ...rest]) => {
       const headers = {};
@@ -62,7 +64,7 @@ class BatchLinkPlugin {
       });
     });
     options.clientInterceptors.push((options2) => {
-      if (this.exclude(options2) || options2.request.body instanceof Blob || options2.request.body instanceof FormData || isAsyncIteratorObject(options2.request.body)) {
+      if (this.exclude(options2) || options2.request.body instanceof Blob || options2.request.body instanceof FormData || isAsyncIteratorObject(options2.request.body) || options2.request.signal?.aborted) {
         return options2.next();
       }
       const group = this.groups.find((group2) => group2.condition(options2));
@@ -71,7 +73,7 @@ class BatchLinkPlugin {
       }
       return new Promise((resolve, reject) => {
         this.#enqueueRequest(group, options2, resolve, reject);
-        setTimeout(() => this.#processPendingBatches());
+        defer(() => this.#processPendingBatches());
       });
     });
   }
@@ -127,16 +129,28 @@ class BatchLinkPlugin {
         this.#executeBatch(method, group, second);
         return;
       }
-      const lazyResponse = await options[0].next({
-        request: { ...batchRequest, headers: { ...batchRequest.headers, "x-orpc-batch": "1" } },
-        signal: batchRequest.signal,
-        context: group.context,
-        input: group.input,
-        path: toArray(group.path)
-      });
-      const parsed = parseBatchResponse({ ...lazyResponse, body: await lazyResponse.body() });
-      for await (const item of parsed) {
-        batchItems[item.index]?.[1]({ ...item, body: () => Promise.resolve(item.body) });
+      const mode = value(this.mode, options);
+      try {
+        const lazyResponse = await options[0].next({
+          request: { ...batchRequest, headers: { ...batchRequest.headers, "x-orpc-batch": mode } },
+          signal: batchRequest.signal,
+          context: group.context,
+          input: group.input,
+          path: toArray(group.path)
+        });
+        const parsed = parseBatchResponse({ ...lazyResponse, body: await lazyResponse.body() });
+        for await (const item of parsed) {
+          batchItems[item.index]?.[1]({ ...item, body: () => Promise.resolve(item.body) });
+        }
+      } catch (err) {
+        if (batchRequest.signal?.aborted && batchRequest.signal.reason === err) {
+          for (const [{ signal }, , reject] of batchItems) {
+            if (signal?.aborted) {
+              reject(signal.reason);
+            }
+          }
+        }
+        throw err;
       }
       throw new Error("Something went wrong make batch response not contains enough responses. This can be a bug please report it.");
     } catch (error) {
@@ -147,6 +161,101 @@ class BatchLinkPlugin {
   }
 }
 
+class DedupeRequestsPlugin {
+  #groups;
+  #filter;
+  order = 4e6;
+  // make sure execute before batch plugin
+  #queue = /* @__PURE__ */ new Map();
+  constructor(options) {
+    this.#groups = options.groups;
+    this.#filter = options.filter ?? (({ request }) => request.method === "GET");
+  }
+  init(options) {
+    options.clientInterceptors ??= [];
+    options.clientInterceptors.push((options2) => {
+      if (options2.request.body instanceof Blob || options2.request.body instanceof FormData || options2.request.body instanceof URLSearchParams || isAsyncIteratorObject(options2.request.body) || !this.#filter(options2)) {
+        return options2.next();
+      }
+      const group = this.#groups.find((group2) => group2.condition(options2));
+      if (!group) {
+        return options2.next();
+      }
+      return new Promise((resolve, reject) => {
+        this.#enqueue(group, options2, resolve, reject);
+        defer(() => this.#dequeue());
+      });
+    });
+  }
+  #enqueue(group, options, resolve, reject) {
+    let queue = this.#queue.get(group);
+    if (!queue) {
+      this.#queue.set(group, queue = []);
+    }
+    const matched = queue.find((item) => {
+      const requestString1 = stringifyJSON({
+        body: item.options.request.body,
+        headers: item.options.request.headers,
+        method: item.options.request.method,
+        url: item.options.request.url
+      });
+      const requestString2 = stringifyJSON({
+        body: options.request.body,
+        headers: options.request.headers,
+        method: options.request.method,
+        url: options.request.url
+      });
+      return requestString1 === requestString2;
+    });
+    if (matched) {
+      matched.signals.push(options.request.signal);
+      matched.resolves.push(resolve);
+      matched.rejects.push(reject);
+    } else {
+      queue.push({
+        options,
+        signals: [options.request.signal],
+        resolves: [resolve],
+        rejects: [reject]
+      });
+    }
+  }
+  async #dequeue() {
+    const promises = [];
+    for (const [group, items] of this.#queue) {
+      for (const { options, signals, resolves, rejects } of items) {
+        promises.push(
+          this.#execute(group, options, signals, resolves, rejects)
+        );
+      }
+    }
+    this.#queue.clear();
+    await Promise.all(promises);
+  }
+  async #execute(group, options, signals, resolves, rejects) {
+    try {
+      const dedupedRequest = {
+        ...options.request,
+        signal: toBatchAbortSignal(signals)
+      };
+      const response = await options.next({
+        ...options,
+        request: dedupedRequest,
+        signal: dedupedRequest.signal,
+        context: group.context
+      });
+      const replicatedResponses = replicateStandardLazyResponse(response, resolves.length);
+      for (const resolve of resolves) {
+        resolve(replicatedResponses.shift());
+      }
+    } catch (error) {
+      for (const reject of rejects) {
+        reject(error);
+      }
+    }
+  }
+}
+
 class ClientRetryPluginInvalidEventIteratorRetryResponse extends Error {
 }
 class ClientRetryPlugin {
@@ -288,4 +397,4 @@ class SimpleCsrfProtectionLinkPlugin {
   }
 }
 
-export { BatchLinkPlugin, ClientRetryPlugin, ClientRetryPluginInvalidEventIteratorRetryResponse, SimpleCsrfProtectionLinkPlugin };
+export { BatchLinkPlugin, ClientRetryPlugin, ClientRetryPluginInvalidEventIteratorRetryResponse, DedupeRequestsPlugin, SimpleCsrfProtectionLinkPlugin };