@orpc/client 1.3.0 → 1.4.1

package/dist/plugins/index.d.mts

@@ -1,5 +1,6 @@
 import { Value, Promisable } from '@orpc/shared';
 import { StandardHeaders, StandardRequest } from '@orpc/standard-server';
+import { BatchResponseMode } from '@orpc/standard-server/batch';
 import { S as StandardLinkClientInterceptorOptions, a as StandardLinkPlugin, b as StandardLinkOptions, c as StandardLinkInterceptorOptions } from '../shared/client.BMoG_EdN.mjs';
 import { a as ClientContext } from '../shared/client.4TS_0JaO.mjs';
 
@@ -17,6 +18,12 @@ interface BatchLinkPluginOptions<T extends ClientContext> {
      * @default 10
      */
     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.
      *
@@ -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,12 +73,45 @@ 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: 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;
+}
+
 interface ClientRetryPluginAttemptOptions<T extends ClientContext> extends StandardLinkInterceptorOptions<T> {
     lastEventRetry: number | undefined;
     attemptIndex: number;
@@ -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,5 +1,6 @@
 import { Value, Promisable } from '@orpc/shared';
 import { StandardHeaders, StandardRequest } from '@orpc/standard-server';
+import { BatchResponseMode } from '@orpc/standard-server/batch';
 import { S as StandardLinkClientInterceptorOptions, a as StandardLinkPlugin, b as StandardLinkOptions, c as StandardLinkInterceptorOptions } from '../shared/client.C0KbSWlC.js';
 import { a as ClientContext } from '../shared/client.4TS_0JaO.js';
 
@@ -17,6 +18,12 @@ interface BatchLinkPluginOptions<T extends ClientContext> {
      * @default 10
      */
     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.
      *
@@ -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,12 +73,45 @@ 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: 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;
+}
+
 interface ClientRetryPluginAttemptOptions<T extends ClientContext> extends StandardLinkInterceptorOptions<T> {
     lastEventRetry: number | undefined;
     attemptIndex: number;
@@ -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 = {};
@@ -71,7 +73,7 @@ class BatchLinkPlugin {
       }
       return new Promise((resolve, reject) => {
         this.#enqueueRequest(group, options2, resolve, reject);
-        setTimeout(() => this.#processPendingBatches());
+        defer(() => this.#processPendingBatches());
       });
     });
   }
@@ -127,8 +129,9 @@ class BatchLinkPlugin {
         this.#executeBatch(method, group, second);
         return;
       }
+      const mode = value(this.mode, options);
       const lazyResponse = await options[0].next({
-        request: { ...batchRequest, headers: { ...batchRequest.headers, "x-orpc-batch": "1" } },
+        request: { ...batchRequest, headers: { ...batchRequest.headers, "x-orpc-batch": mode } },
         signal: batchRequest.signal,
         context: group.context,
         input: group.input,
@@ -147,6 +150,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 +386,4 @@ class SimpleCsrfProtectionLinkPlugin {
   }
 }
 
-export { BatchLinkPlugin, ClientRetryPlugin, ClientRetryPluginInvalidEventIteratorRetryResponse, SimpleCsrfProtectionLinkPlugin };
+export { BatchLinkPlugin, ClientRetryPlugin, ClientRetryPluginInvalidEventIteratorRetryResponse, DedupeRequestsPlugin, SimpleCsrfProtectionLinkPlugin };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@orpc/client",
   "type": "module",
-  "version": "1.3.0",
+  "version": "1.4.1",
   "license": "MIT",
   "homepage": "https://orpc.unnoq.com",
   "repository": {
@@ -49,13 +49,13 @@
     "dist"
   ],
   "dependencies": {
-    "@orpc/shared": "1.3.0",
-    "@orpc/standard-server": "1.3.0",
-    "@orpc/standard-server-fetch": "1.3.0",
-    "@orpc/standard-server-peer": "1.3.0"
+    "@orpc/shared": "1.4.1",
+    "@orpc/standard-server": "1.4.1",
+    "@orpc/standard-server-fetch": "1.4.1",
+    "@orpc/standard-server-peer": "1.4.1"
   },
   "devDependencies": {
-    "zod": "^3.25.11"
+    "zod": "^3.25.49"
   },
   "scripts": {
     "build": "unbuild",