@orpc/client 0.0.0-next.bb2589d → 0.0.0-next.bbe55b7

package/dist/plugins/index.d.mts

@@ -1,7 +1,8 @@
-import { Value } 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.Bt2hFtM_.mjs';
-import { a as ClientContext } from '../shared/client.CipPQkhk.mjs';
+import { Value, Promisable } from '@orpc/shared';
+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.CPgZaUox.mjs';
+import { b as ClientContext } from '../shared/client.BH1AYT_p.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.
      *
@@ -51,6 +58,12 @@ interface BatchLinkPluginOptions<T extends ClientContext> {
      */
     exclude?: (options: StandardLinkClientInterceptorOptions<T>) => boolean;
 }
+/**
+ * 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-requests Batch Requests Plugin Docs}
+ */
 declare class BatchLinkPlugin<T extends ClientContext> implements StandardLinkPlugin<T> {
     #private;
     private readonly groups;
@@ -60,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;
 }
 
@@ -78,59 +124,118 @@ 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.
      */
-    onRetry?: (options: ClientRetryPluginAttemptOptions<ClientRetryPluginContext>) => void | (() => void);
+    onRetry?: (options: ClientRetryPluginAttemptOptions<ClientRetryPluginContext>) => void | ((isSuccess: boolean) => void);
 }
 declare class ClientRetryPluginInvalidEventIteratorRetryResponse extends Error {
 }
 interface ClientRetryPluginOptions {
     default?: ClientRetryPluginContext;
 }
+/**
+ * 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}
+ */
 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.unnoq.com/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.
      *
      * @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.
+ * 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}
+ */
 declare class SimpleCsrfProtectionLinkPlugin<T extends ClientContext> implements StandardLinkPlugin<T> {
     private readonly headerName;
     private readonly headerValue;
@@ -140,4 +245,5 @@ declare class SimpleCsrfProtectionLinkPlugin<T extends ClientContext> implements
     init(options: StandardLinkOptions<T>): void;
 }
 
-export { BatchLinkPlugin, type BatchLinkPluginGroup, type BatchLinkPluginOptions, ClientRetryPlugin, type ClientRetryPluginAttemptOptions, type ClientRetryPluginContext, ClientRetryPluginInvalidEventIteratorRetryResponse, type ClientRetryPluginOptions, SimpleCsrfProtectionLinkPlugin, type 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 } 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.FvDtk0Vr.js';
-import { a as ClientContext } from '../shared/client.CipPQkhk.js';
+import { Value, Promisable } from '@orpc/shared';
+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.De8SW4Kw.js';
+import { b as ClientContext } from '../shared/client.BH1AYT_p.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.
      *
@@ -51,6 +58,12 @@ interface BatchLinkPluginOptions<T extends ClientContext> {
      */
     exclude?: (options: StandardLinkClientInterceptorOptions<T>) => boolean;
 }
+/**
+ * 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-requests Batch Requests Plugin Docs}
+ */
 declare class BatchLinkPlugin<T extends ClientContext> implements StandardLinkPlugin<T> {
     #private;
     private readonly groups;
@@ -60,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;
 }
 
@@ -78,59 +124,118 @@ 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.
      */
-    onRetry?: (options: ClientRetryPluginAttemptOptions<ClientRetryPluginContext>) => void | (() => void);
+    onRetry?: (options: ClientRetryPluginAttemptOptions<ClientRetryPluginContext>) => void | ((isSuccess: boolean) => void);
 }
 declare class ClientRetryPluginInvalidEventIteratorRetryResponse extends Error {
 }
 interface ClientRetryPluginOptions {
     default?: ClientRetryPluginContext;
 }
+/**
+ * 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}
+ */
 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.unnoq.com/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.
      *
      * @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.
+ * 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}
+ */
 declare class SimpleCsrfProtectionLinkPlugin<T extends ClientContext> implements StandardLinkPlugin<T> {
     private readonly headerName;
     private readonly headerValue;
@@ -140,4 +245,5 @@ declare class SimpleCsrfProtectionLinkPlugin<T extends ClientContext> implements
     init(options: StandardLinkOptions<T>): void;
 }
 
-export { BatchLinkPlugin, type BatchLinkPluginGroup, type BatchLinkPluginOptions, ClientRetryPlugin, type ClientRetryPluginAttemptOptions, type ClientRetryPluginContext, ClientRetryPluginInvalidEventIteratorRetryResponse, type ClientRetryPluginOptions, SimpleCsrfProtectionLinkPlugin, type SimpleCsrfProtectionLinkPluginOptions };
+export { BatchLinkPlugin, ClientRetryPlugin, ClientRetryPluginInvalidEventIteratorRetryResponse, DedupeRequestsPlugin, RetryAfterPlugin, SimpleCsrfProtectionLinkPlugin };
+export type { BatchLinkPluginGroup, BatchLinkPluginOptions, ClientRetryPluginAttemptOptions, ClientRetryPluginContext, ClientRetryPluginOptions, DedupeRequestsPluginGroup, DedupeRequestsPluginOptions, RetryAfterPluginOptions, SimpleCsrfProtectionLinkPluginOptions };