@orpc/client 0.0.0-next.b6b0cc3 → 0.0.0-next.b6b8746

package/dist/index.mjs

@@ -1,7 +1,9 @@
-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';
-export { ErrorEvent } from '@orpc/standard-server';
+import { preventNativeAwait, isTypescriptObject } from '@orpc/shared';
+export { AsyncIteratorClass, EventPublisher, asyncIteratorToStream as eventIteratorToStream, asyncIteratorToUnproxiedDataStream as eventIteratorToUnproxiedDataStream, onError, onFinish, onStart, onSuccess, streamToAsyncIteratorClass as streamToEventIterator } from '@orpc/shared';
+import { i as isDefinedError } from './shared/client.CsERrg1E.mjs';
+export { C as COMMON_ORPC_ERROR_DEFS, c as ORPCError, O as ORPC_CLIENT_PACKAGE_NAME, a as ORPC_CLIENT_PACKAGE_VERSION, g as createORPCErrorFromJson, b as fallbackORPCErrorMessage, f as fallbackORPCErrorStatus, e as isORPCErrorJson, d as isORPCErrorStatus, t as toORPCError } from './shared/client.CsERrg1E.mjs';
+export { m as mapEventIterator } from './shared/client.BLtwTQUg.mjs';
+export { ErrorEvent, getEventMeta, withEventMeta } from '@orpc/standard-server';
 
 async function safe(promise) {
   try {
@@ -27,13 +29,42 @@ async function safe(promise) {
 function resolveFriendlyClientOptions(options) {
   return {
     ...options,
-    context: options?.context ?? {}
+    context: options.context ?? {}
     // Context only optional if all fields are optional
   };
 }
+function consumeEventIterator(iterator, options) {
+  void (async () => {
+    let onFinishState;
+    try {
+      const resolvedIterator = await iterator;
+      while (true) {
+        const { done, value } = await resolvedIterator.next();
+        if (done) {
+          const realValue = value;
+          onFinishState = [null, realValue, true];
+          options.onSuccess?.(realValue);
+          break;
+        }
+        options.onEvent(value);
+      }
+    } catch (error) {
+      onFinishState = [error, void 0, false];
+      if (!options.onError && !options.onFinish) {
+        throw error;
+      }
+      options.onError?.(error);
+    } finally {
+      options.onFinish?.(onFinishState);
+    }
+  })();
+  return async () => {
+    await (await iterator)?.return?.();
+  };
+}
 
-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));
   };
@@ -48,7 +79,23 @@ function createORPCClient(link, options) {
       });
     }
   });
-  return recursive;
+  return preventNativeAwait(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 {
@@ -62,4 +109,4 @@ class DynamicLink {
   }
 }
 
-export { DynamicLink, createORPCClient, isDefinedError, resolveFriendlyClientOptions, safe };
+export { DynamicLink, consumeEventIterator, createORPCClient, createSafeClient, isDefinedError, resolveFriendlyClientOptions, safe };

package/dist/plugins/index.d.mts

@@ -1,7 +1,8 @@
 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.BMoG_EdN.mjs';
-import { a as ClientContext } from '../shared/client.4TS_0JaO.mjs';
+import { StandardHeaders, StandardRequest, StandardLazyResponse } 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.CpCa3si8.mjs';
+import { b as ClientContext } from '../shared/client.i2uoJbEp.mjs';
 
 interface BatchLinkPluginGroup<T extends ClientContext> {
     condition(options: StandardLinkClientInterceptorOptions<T>): boolean;
@@ -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.dev/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.dev/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;
@@ -110,17 +150,64 @@ interface ClientRetryPluginOptions {
 /**
  * The Client Retry Plugin enables retrying client calls when errors occur.
  *
- * @see {@link https://orpc.unnoq.com/docs/plugins/client-retry Client Retry Plugin Docs}
+ * @see {@link https://orpc.dev/docs/plugins/client-retry Client Retry Plugin Docs}
  */
 declare class ClientRetryPlugin<T extends ClientRetryPluginContext> implements StandardLinkPlugin<T> {
     private readonly defaultRetry;
     private readonly defaultRetryDelay;
     private readonly defaultShouldRetry;
     private readonly defaultOnRetry;
+    order: number;
     constructor(options?: ClientRetryPluginOptions);
     init(options: StandardLinkOptions<T>): void;
 }
 
+interface RetryAfterPluginOptions<T extends ClientContext> {
+    /**
+     * Override condition to determine whether to retry or not.
+     *
+     * @default ((response) => response.status === 429 || response.status === 503)
+     */
+    condition?: Value<boolean, [
+        response: StandardLazyResponse,
+        options: StandardLinkClientInterceptorOptions<T>
+    ]>;
+    /**
+     * Maximum attempts before giving up retries.
+     *
+     * @default 3
+     */
+    maxAttempts?: Value<number, [
+        response: StandardLazyResponse,
+        options: StandardLinkClientInterceptorOptions<T>
+    ]>;
+    /**
+     * Maximum timeout in milliseconds to wait before giving up retries.
+     *
+     * @default 5 * 60 * 1000 (5 minutes)
+     */
+    timeout?: Value<number, [
+        response: StandardLazyResponse,
+        options: StandardLinkClientInterceptorOptions<T>
+    ]>;
+}
+/**
+ * The Retry After Plugin automatically retries requests based on server `Retry-After` headers.
+ * 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}
+ */
+declare class RetryAfterPlugin<T extends ClientContext> implements StandardLinkPlugin<T> {
+    private readonly condition;
+    private readonly maxAttempts;
+    private readonly timeout;
+    order: number;
+    constructor(options?: RetryAfterPluginOptions<T>);
+    init(options: StandardLinkOptions<T>): void;
+    private parseRetryAfterHeader;
+    private delayExecution;
+}
+
 interface SimpleCsrfProtectionLinkPluginOptions<T extends ClientContext> {
     /**
      * The name of the header to check.
@@ -147,7 +234,7 @@ interface SimpleCsrfProtectionLinkPluginOptions<T extends ClientContext> {
  * It helps ensure that requests to your procedures originate from JavaScript code,
  * not from other sources like standard HTML forms or direct browser navigation.
  *
- * @see {@link https://orpc.unnoq.com/docs/plugins/simple-csrf-protection Simple CSRF Protection Plugin Docs}
+ * @see {@link https://orpc.dev/docs/plugins/simple-csrf-protection Simple CSRF Protection Plugin Docs}
  */
 declare class SimpleCsrfProtectionLinkPlugin<T extends ClientContext> implements StandardLinkPlugin<T> {
     private readonly headerName;
@@ -158,5 +245,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, RetryAfterPlugin, SimpleCsrfProtectionLinkPlugin };
+export type { BatchLinkPluginGroup, BatchLinkPluginOptions, ClientRetryPluginAttemptOptions, ClientRetryPluginContext, ClientRetryPluginOptions, DedupeRequestsPluginGroup, DedupeRequestsPluginOptions, RetryAfterPluginOptions, SimpleCsrfProtectionLinkPluginOptions };

package/dist/plugins/index.d.ts

@@ -1,7 +1,8 @@
 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.C0KbSWlC.js';
-import { a as ClientContext } from '../shared/client.4TS_0JaO.js';
+import { StandardHeaders, StandardRequest, StandardLazyResponse } 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.2jUAqzYU.js';
+import { b as ClientContext } from '../shared/client.i2uoJbEp.js';
 
 interface BatchLinkPluginGroup<T extends ClientContext> {
     condition(options: StandardLinkClientInterceptorOptions<T>): boolean;
@@ -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.dev/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.dev/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;
@@ -110,17 +150,64 @@ interface ClientRetryPluginOptions {
 /**
  * The Client Retry Plugin enables retrying client calls when errors occur.
  *
- * @see {@link https://orpc.unnoq.com/docs/plugins/client-retry Client Retry Plugin Docs}
+ * @see {@link https://orpc.dev/docs/plugins/client-retry Client Retry Plugin Docs}
  */
 declare class ClientRetryPlugin<T extends ClientRetryPluginContext> implements StandardLinkPlugin<T> {
     private readonly defaultRetry;
     private readonly defaultRetryDelay;
     private readonly defaultShouldRetry;
     private readonly defaultOnRetry;
+    order: number;
     constructor(options?: ClientRetryPluginOptions);
     init(options: StandardLinkOptions<T>): void;
 }
 
+interface RetryAfterPluginOptions<T extends ClientContext> {
+    /**
+     * Override condition to determine whether to retry or not.
+     *
+     * @default ((response) => response.status === 429 || response.status === 503)
+     */
+    condition?: Value<boolean, [
+        response: StandardLazyResponse,
+        options: StandardLinkClientInterceptorOptions<T>
+    ]>;
+    /**
+     * Maximum attempts before giving up retries.
+     *
+     * @default 3
+     */
+    maxAttempts?: Value<number, [
+        response: StandardLazyResponse,
+        options: StandardLinkClientInterceptorOptions<T>
+    ]>;
+    /**
+     * Maximum timeout in milliseconds to wait before giving up retries.
+     *
+     * @default 5 * 60 * 1000 (5 minutes)
+     */
+    timeout?: Value<number, [
+        response: StandardLazyResponse,
+        options: StandardLinkClientInterceptorOptions<T>
+    ]>;
+}
+/**
+ * The Retry After Plugin automatically retries requests based on server `Retry-After` headers.
+ * 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}
+ */
+declare class RetryAfterPlugin<T extends ClientContext> implements StandardLinkPlugin<T> {
+    private readonly condition;
+    private readonly maxAttempts;
+    private readonly timeout;
+    order: number;
+    constructor(options?: RetryAfterPluginOptions<T>);
+    init(options: StandardLinkOptions<T>): void;
+    private parseRetryAfterHeader;
+    private delayExecution;
+}
+
 interface SimpleCsrfProtectionLinkPluginOptions<T extends ClientContext> {
     /**
      * The name of the header to check.
@@ -147,7 +234,7 @@ interface SimpleCsrfProtectionLinkPluginOptions<T extends ClientContext> {
  * It helps ensure that requests to your procedures originate from JavaScript code,
  * not from other sources like standard HTML forms or direct browser navigation.
  *
- * @see {@link https://orpc.unnoq.com/docs/plugins/simple-csrf-protection Simple CSRF Protection Plugin Docs}
+ * @see {@link https://orpc.dev/docs/plugins/simple-csrf-protection Simple CSRF Protection Plugin Docs}
  */
 declare class SimpleCsrfProtectionLinkPlugin<T extends ClientContext> implements StandardLinkPlugin<T> {
     private readonly headerName;
@@ -158,5 +245,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, RetryAfterPlugin, SimpleCsrfProtectionLinkPlugin };
+export type { BatchLinkPluginGroup, BatchLinkPluginOptions, ClientRetryPluginAttemptOptions, ClientRetryPluginContext, ClientRetryPluginOptions, DedupeRequestsPluginGroup, DedupeRequestsPluginOptions, RetryAfterPluginOptions, SimpleCsrfProtectionLinkPluginOptions };