@orpc/client 0.0.0-next.f72e6b9 → 0.0.0-next.f7af1c4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.d.mts CHANGED
@@ -1,14 +1,14 @@
1
- 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.mjs';
2
- export { f as Client, e as ClientRest, d as HTTPMethod, H as HTTPPath } from './shared/client.CipPQkhk.mjs';
3
- import { Promisable, MaybeOptionalOptions, ThrowableError } from '@orpc/shared';
4
- export { Registry, ThrowableError, onError, onFinish, onStart, onSuccess } from '@orpc/shared';
1
+ 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.mjs';
2
+ export { f as HTTPMethod, H as HTTPPath } from './shared/client.BOYsZIRq.mjs';
3
+ import { MaybeOptionalOptions, ThrowableError, OnFinishState, Promisable, AsyncIteratorClass } from '@orpc/shared';
4
+ export { AsyncIteratorClass, EventPublisher, EventPublisherOptions, EventPublisherSubscribeIteratorOptions, Registry, ThrowableError, asyncIteratorToStream as eventIteratorToStream, onError, onFinish, onStart, onSuccess, streamToAsyncIteratorClass as streamToEventIterator } from '@orpc/shared';
5
5
  export { ErrorEvent } from '@orpc/standard-server';
6
6
 
7
7
  interface createORPCClientOptions {
8
8
  /**
9
9
  * Use as base path for all procedure, useful when you only want to call a subset of the procedure.
10
10
  */
11
- path?: string[];
11
+ path?: readonly string[];
12
12
  }
13
13
  /**
14
14
  * Create a oRPC client-side client from a link.
@@ -17,18 +17,6 @@ interface createORPCClientOptions {
17
17
  */
18
18
  declare function createORPCClient<T extends NestedClient<any>>(link: ClientLink<InferClientContext<T>>, options?: createORPCClientOptions): T;
19
19
 
20
- /**
21
- * DynamicLink provides a way to dynamically resolve and delegate calls to other ClientLinks
22
- * based on the request path, input, and context.
23
- *
24
- * @see {@link https://orpc.unnoq.com/docs/client/dynamic-link Dynamic Link Docs}
25
- */
26
- declare class DynamicLink<TClientContext extends ClientContext> implements ClientLink<TClientContext> {
27
- private readonly linkResolver;
28
- constructor(linkResolver: (options: ClientOptions<TClientContext>, path: readonly string[], input: unknown) => Promisable<ClientLink<TClientContext>>);
29
- call(path: readonly string[], input: unknown, options: ClientOptions<TClientContext>): Promise<unknown>;
30
- }
31
-
32
20
  declare const COMMON_ORPC_ERROR_DEFS: {
33
21
  readonly BAD_REQUEST: {
34
22
  readonly status: 400;
@@ -125,8 +113,21 @@ declare class ORPCError<TCode extends ORPCErrorCode, TData> extends Error {
125
113
  readonly code: TCode;
126
114
  readonly status: number;
127
115
  readonly data: TData;
128
- constructor(code: TCode, ...[options]: MaybeOptionalOptions<ORPCErrorOptions<TData>>);
116
+ constructor(code: TCode, ...rest: MaybeOptionalOptions<ORPCErrorOptions<TData>>);
129
117
  toJSON(): ORPCErrorJSON<TCode, TData>;
118
+ /**
119
+ * Workaround for Next.js where different contexts use separate
120
+ * dependency graphs, causing multiple ORPCError constructors existing and breaking
121
+ * `instanceof` checks across contexts.
122
+ *
123
+ * This is particularly problematic with "Optimized SSR", where orpc-client
124
+ * executes in one context but is invoked from another. When an error is thrown
125
+ * in the execution context, `instanceof ORPCError` checks fail in the
126
+ * invocation context due to separate class constructors.
127
+ *
128
+ * @todo Remove this and related code if Next.js resolves the multiple dependency graph issue.
129
+ */
130
+ static [Symbol.hasInstance](instance: unknown): boolean;
130
131
  }
131
132
  type ORPCErrorJSON<TCode extends string, TData> = Pick<ORPCError<TCode, TData>, 'defined' | 'code' | 'status' | 'message' | 'data'>;
132
133
  declare function isDefinedError<T>(error: T): error is Extract<T, ORPCError<any, any>>;
@@ -135,11 +136,6 @@ declare function isORPCErrorStatus(status: number): boolean;
135
136
  declare function isORPCErrorJson(json: unknown): json is ORPCErrorJSON<ORPCErrorCode, unknown>;
136
137
  declare function createORPCErrorFromJson<TCode extends ORPCErrorCode, TData>(json: ORPCErrorJSON<TCode, TData>, options?: ErrorOptions): ORPCError<TCode, TData>;
137
138
 
138
- declare function mapEventIterator<TYield, TReturn, TNext, TMap = TYield | TReturn>(iterator: AsyncIterator<TYield, TReturn, TNext>, maps: {
139
- value: (value: NoInfer<TYield | TReturn>, done: boolean | undefined) => Promise<TMap>;
140
- error: (error: unknown) => Promise<unknown>;
141
- }): AsyncGenerator<TMap, TMap, TNext>;
142
-
143
139
  type SafeResult<TOutput, TError> = [error: null, data: TOutput, isDefined: false, isSuccess: true] & {
144
140
  error: null;
145
141
  data: TOutput;
@@ -164,6 +160,71 @@ type SafeResult<TOutput, TError> = [error: null, data: TOutput, isDefined: false
164
160
  */
165
161
  declare function safe<TOutput, TError = ThrowableError>(promise: ClientPromiseResult<TOutput, TError>): Promise<SafeResult<TOutput, TError>>;
166
162
  declare function resolveFriendlyClientOptions<T extends ClientContext>(options: FriendlyClientOptions<T>): ClientOptions<T>;
163
+ interface ConsumeEventIteratorOptions<T, TReturn, TError> {
164
+ /**
165
+ * Called on each event
166
+ */
167
+ onEvent: (event: T) => void;
168
+ /**
169
+ * Called once error happens
170
+ */
171
+ onError?: (error: TError) => void;
172
+ /**
173
+ * Called once event iterator is done
174
+ *
175
+ * @info If iterator is canceled, `undefined` can be passed on success
176
+ */
177
+ onSuccess?: (value: TReturn | undefined) => void;
178
+ /**
179
+ * Called once after onError or onSuccess
180
+ *
181
+ * @info If iterator is canceled, `undefined` can be passed on success
182
+ */
183
+ onFinish?: (state: OnFinishState<TReturn | undefined, TError>) => void;
184
+ }
185
+ /**
186
+ * Consumes an event iterator with lifecycle callbacks
187
+ *
188
+ * @warning If no `onError` or `onFinish` is provided, unhandled rejections will be thrown
189
+ * @return unsubscribe callback
190
+ */
191
+ declare function consumeEventIterator<T, TReturn, TError = ThrowableError>(iterator: AsyncIterator<T, TReturn> | ClientPromiseResult<AsyncIterator<T, TReturn>, TError>, options: ConsumeEventIteratorOptions<T, TReturn, TError>): () => Promise<void>;
192
+
193
+ 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>> : {
194
+ [K in keyof T]: T[K] extends NestedClient<any> ? SafeClient<T[K]> : never;
195
+ };
196
+ /**
197
+ * Create a safe client that automatically wraps all procedure calls with the `safe` util.
198
+ *
199
+ * @example
200
+ * ```ts
201
+ * const safeClient = createSafeClient(client)
202
+ * const { error, data, isDefined } = await safeClient.doSomething({ id: '123' })
203
+ * ```
204
+ *
205
+ * @see {@link https://orpc.unnoq.com/docs/client/error-handling#using-createsafeclient Safe Client Docs}
206
+ */
207
+ declare function createSafeClient<T extends NestedClient<any>>(client: T): SafeClient<T>;
208
+
209
+ declare const ORPC_CLIENT_PACKAGE_NAME = "@orpc/client";
210
+ declare const ORPC_CLIENT_PACKAGE_VERSION = "0.0.0-next.f7af1c4";
211
+
212
+ /**
213
+ * DynamicLink provides a way to dynamically resolve and delegate calls to other ClientLinks
214
+ * based on the request path, input, and context.
215
+ *
216
+ * @see {@link https://orpc.unnoq.com/docs/client/dynamic-link Dynamic Link Docs}
217
+ */
218
+ declare class DynamicLink<TClientContext extends ClientContext> implements ClientLink<TClientContext> {
219
+ private readonly linkResolver;
220
+ constructor(linkResolver: (options: ClientOptions<TClientContext>, path: readonly string[], input: unknown) => Promisable<ClientLink<TClientContext>>);
221
+ call(path: readonly string[], input: unknown, options: ClientOptions<TClientContext>): Promise<unknown>;
222
+ }
223
+
224
+ declare function mapEventIterator<TYield, TReturn, TNext, TMap = TYield | TReturn>(iterator: AsyncIterator<TYield, TReturn, TNext>, maps: {
225
+ value: (value: NoInfer<TYield | TReturn>, done: boolean | undefined) => Promise<TMap>;
226
+ error: (error: unknown) => Promise<unknown>;
227
+ }): AsyncIteratorClass<TMap, TMap, TNext>;
167
228
 
168
- 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 };
169
- export type { CommonORPCErrorCode, ORPCErrorCode, ORPCErrorJSON, ORPCErrorOptions, SafeResult, createORPCClientOptions };
229
+ export { COMMON_ORPC_ERROR_DEFS, Client, ClientContext, ClientLink, ClientOptions, ClientPromiseResult, ClientRest, DynamicLink, FriendlyClientOptions, InferClientContext, NestedClient, ORPCError, ORPC_CLIENT_PACKAGE_NAME, ORPC_CLIENT_PACKAGE_VERSION, consumeEventIterator, createORPCClient, createORPCErrorFromJson, createSafeClient, fallbackORPCErrorMessage, fallbackORPCErrorStatus, isDefinedError, isORPCErrorJson, isORPCErrorStatus, mapEventIterator, resolveFriendlyClientOptions, safe, toORPCError };
230
+ export type { CommonORPCErrorCode, ConsumeEventIteratorOptions, ORPCErrorCode, ORPCErrorJSON, ORPCErrorOptions, SafeClient, SafeResult, createORPCClientOptions };
package/dist/index.d.ts CHANGED
@@ -1,14 +1,14 @@
1
- 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';
2
- export { f as Client, e as ClientRest, d as HTTPMethod, H as HTTPPath } from './shared/client.CipPQkhk.js';
3
- import { Promisable, MaybeOptionalOptions, ThrowableError } from '@orpc/shared';
4
- export { Registry, ThrowableError, onError, onFinish, onStart, onSuccess } from '@orpc/shared';
1
+ 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';
2
+ export { f as HTTPMethod, H as HTTPPath } from './shared/client.BOYsZIRq.js';
3
+ import { MaybeOptionalOptions, ThrowableError, OnFinishState, Promisable, AsyncIteratorClass } from '@orpc/shared';
4
+ export { AsyncIteratorClass, EventPublisher, EventPublisherOptions, EventPublisherSubscribeIteratorOptions, Registry, ThrowableError, asyncIteratorToStream as eventIteratorToStream, onError, onFinish, onStart, onSuccess, streamToAsyncIteratorClass as streamToEventIterator } from '@orpc/shared';
5
5
  export { ErrorEvent } from '@orpc/standard-server';
6
6
 
7
7
  interface createORPCClientOptions {
8
8
  /**
9
9
  * Use as base path for all procedure, useful when you only want to call a subset of the procedure.
10
10
  */
11
- path?: string[];
11
+ path?: readonly string[];
12
12
  }
13
13
  /**
14
14
  * Create a oRPC client-side client from a link.
@@ -17,18 +17,6 @@ interface createORPCClientOptions {
17
17
  */
18
18
  declare function createORPCClient<T extends NestedClient<any>>(link: ClientLink<InferClientContext<T>>, options?: createORPCClientOptions): T;
19
19
 
20
- /**
21
- * DynamicLink provides a way to dynamically resolve and delegate calls to other ClientLinks
22
- * based on the request path, input, and context.
23
- *
24
- * @see {@link https://orpc.unnoq.com/docs/client/dynamic-link Dynamic Link Docs}
25
- */
26
- declare class DynamicLink<TClientContext extends ClientContext> implements ClientLink<TClientContext> {
27
- private readonly linkResolver;
28
- constructor(linkResolver: (options: ClientOptions<TClientContext>, path: readonly string[], input: unknown) => Promisable<ClientLink<TClientContext>>);
29
- call(path: readonly string[], input: unknown, options: ClientOptions<TClientContext>): Promise<unknown>;
30
- }
31
-
32
20
  declare const COMMON_ORPC_ERROR_DEFS: {
33
21
  readonly BAD_REQUEST: {
34
22
  readonly status: 400;
@@ -125,8 +113,21 @@ declare class ORPCError<TCode extends ORPCErrorCode, TData> extends Error {
125
113
  readonly code: TCode;
126
114
  readonly status: number;
127
115
  readonly data: TData;
128
- constructor(code: TCode, ...[options]: MaybeOptionalOptions<ORPCErrorOptions<TData>>);
116
+ constructor(code: TCode, ...rest: MaybeOptionalOptions<ORPCErrorOptions<TData>>);
129
117
  toJSON(): ORPCErrorJSON<TCode, TData>;
118
+ /**
119
+ * Workaround for Next.js where different contexts use separate
120
+ * dependency graphs, causing multiple ORPCError constructors existing and breaking
121
+ * `instanceof` checks across contexts.
122
+ *
123
+ * This is particularly problematic with "Optimized SSR", where orpc-client
124
+ * executes in one context but is invoked from another. When an error is thrown
125
+ * in the execution context, `instanceof ORPCError` checks fail in the
126
+ * invocation context due to separate class constructors.
127
+ *
128
+ * @todo Remove this and related code if Next.js resolves the multiple dependency graph issue.
129
+ */
130
+ static [Symbol.hasInstance](instance: unknown): boolean;
130
131
  }
131
132
  type ORPCErrorJSON<TCode extends string, TData> = Pick<ORPCError<TCode, TData>, 'defined' | 'code' | 'status' | 'message' | 'data'>;
132
133
  declare function isDefinedError<T>(error: T): error is Extract<T, ORPCError<any, any>>;
@@ -135,11 +136,6 @@ declare function isORPCErrorStatus(status: number): boolean;
135
136
  declare function isORPCErrorJson(json: unknown): json is ORPCErrorJSON<ORPCErrorCode, unknown>;
136
137
  declare function createORPCErrorFromJson<TCode extends ORPCErrorCode, TData>(json: ORPCErrorJSON<TCode, TData>, options?: ErrorOptions): ORPCError<TCode, TData>;
137
138
 
138
- declare function mapEventIterator<TYield, TReturn, TNext, TMap = TYield | TReturn>(iterator: AsyncIterator<TYield, TReturn, TNext>, maps: {
139
- value: (value: NoInfer<TYield | TReturn>, done: boolean | undefined) => Promise<TMap>;
140
- error: (error: unknown) => Promise<unknown>;
141
- }): AsyncGenerator<TMap, TMap, TNext>;
142
-
143
139
  type SafeResult<TOutput, TError> = [error: null, data: TOutput, isDefined: false, isSuccess: true] & {
144
140
  error: null;
145
141
  data: TOutput;
@@ -164,6 +160,71 @@ type SafeResult<TOutput, TError> = [error: null, data: TOutput, isDefined: false
164
160
  */
165
161
  declare function safe<TOutput, TError = ThrowableError>(promise: ClientPromiseResult<TOutput, TError>): Promise<SafeResult<TOutput, TError>>;
166
162
  declare function resolveFriendlyClientOptions<T extends ClientContext>(options: FriendlyClientOptions<T>): ClientOptions<T>;
163
+ interface ConsumeEventIteratorOptions<T, TReturn, TError> {
164
+ /**
165
+ * Called on each event
166
+ */
167
+ onEvent: (event: T) => void;
168
+ /**
169
+ * Called once error happens
170
+ */
171
+ onError?: (error: TError) => void;
172
+ /**
173
+ * Called once event iterator is done
174
+ *
175
+ * @info If iterator is canceled, `undefined` can be passed on success
176
+ */
177
+ onSuccess?: (value: TReturn | undefined) => void;
178
+ /**
179
+ * Called once after onError or onSuccess
180
+ *
181
+ * @info If iterator is canceled, `undefined` can be passed on success
182
+ */
183
+ onFinish?: (state: OnFinishState<TReturn | undefined, TError>) => void;
184
+ }
185
+ /**
186
+ * Consumes an event iterator with lifecycle callbacks
187
+ *
188
+ * @warning If no `onError` or `onFinish` is provided, unhandled rejections will be thrown
189
+ * @return unsubscribe callback
190
+ */
191
+ declare function consumeEventIterator<T, TReturn, TError = ThrowableError>(iterator: AsyncIterator<T, TReturn> | ClientPromiseResult<AsyncIterator<T, TReturn>, TError>, options: ConsumeEventIteratorOptions<T, TReturn, TError>): () => Promise<void>;
192
+
193
+ 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>> : {
194
+ [K in keyof T]: T[K] extends NestedClient<any> ? SafeClient<T[K]> : never;
195
+ };
196
+ /**
197
+ * Create a safe client that automatically wraps all procedure calls with the `safe` util.
198
+ *
199
+ * @example
200
+ * ```ts
201
+ * const safeClient = createSafeClient(client)
202
+ * const { error, data, isDefined } = await safeClient.doSomething({ id: '123' })
203
+ * ```
204
+ *
205
+ * @see {@link https://orpc.unnoq.com/docs/client/error-handling#using-createsafeclient Safe Client Docs}
206
+ */
207
+ declare function createSafeClient<T extends NestedClient<any>>(client: T): SafeClient<T>;
208
+
209
+ declare const ORPC_CLIENT_PACKAGE_NAME = "@orpc/client";
210
+ declare const ORPC_CLIENT_PACKAGE_VERSION = "0.0.0-next.f7af1c4";
211
+
212
+ /**
213
+ * DynamicLink provides a way to dynamically resolve and delegate calls to other ClientLinks
214
+ * based on the request path, input, and context.
215
+ *
216
+ * @see {@link https://orpc.unnoq.com/docs/client/dynamic-link Dynamic Link Docs}
217
+ */
218
+ declare class DynamicLink<TClientContext extends ClientContext> implements ClientLink<TClientContext> {
219
+ private readonly linkResolver;
220
+ constructor(linkResolver: (options: ClientOptions<TClientContext>, path: readonly string[], input: unknown) => Promisable<ClientLink<TClientContext>>);
221
+ call(path: readonly string[], input: unknown, options: ClientOptions<TClientContext>): Promise<unknown>;
222
+ }
223
+
224
+ declare function mapEventIterator<TYield, TReturn, TNext, TMap = TYield | TReturn>(iterator: AsyncIterator<TYield, TReturn, TNext>, maps: {
225
+ value: (value: NoInfer<TYield | TReturn>, done: boolean | undefined) => Promise<TMap>;
226
+ error: (error: unknown) => Promise<unknown>;
227
+ }): AsyncIteratorClass<TMap, TMap, TNext>;
167
228
 
168
- 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 };
169
- export type { CommonORPCErrorCode, ORPCErrorCode, ORPCErrorJSON, ORPCErrorOptions, SafeResult, createORPCClientOptions };
229
+ export { COMMON_ORPC_ERROR_DEFS, Client, ClientContext, ClientLink, ClientOptions, ClientPromiseResult, ClientRest, DynamicLink, FriendlyClientOptions, InferClientContext, NestedClient, ORPCError, ORPC_CLIENT_PACKAGE_NAME, ORPC_CLIENT_PACKAGE_VERSION, consumeEventIterator, createORPCClient, createORPCErrorFromJson, createSafeClient, fallbackORPCErrorMessage, fallbackORPCErrorStatus, isDefinedError, isORPCErrorJson, isORPCErrorStatus, mapEventIterator, resolveFriendlyClientOptions, safe, toORPCError };
230
+ export type { CommonORPCErrorCode, ConsumeEventIteratorOptions, ORPCErrorCode, ORPCErrorJSON, ORPCErrorOptions, SafeClient, SafeResult, createORPCClientOptions };
package/dist/index.mjs CHANGED
@@ -1,6 +1,7 @@
1
- import { i as isDefinedError } from './shared/client.CRWEpqLB.mjs';
2
- 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';
3
- export { onError, onFinish, onStart, onSuccess } from '@orpc/shared';
1
+ import { preventNativeAwait, isTypescriptObject } from '@orpc/shared';
2
+ export { AsyncIteratorClass, EventPublisher, asyncIteratorToStream as eventIteratorToStream, onError, onFinish, onStart, onSuccess, streamToAsyncIteratorClass as streamToEventIterator } from '@orpc/shared';
3
+ import { i as isDefinedError } from './shared/client.9Pe_7OOW.mjs';
4
+ 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, m as mapEventIterator, t as toORPCError } from './shared/client.9Pe_7OOW.mjs';
4
5
  export { ErrorEvent } from '@orpc/standard-server';
5
6
 
6
7
  async function safe(promise) {
@@ -27,13 +28,42 @@ async function safe(promise) {
27
28
  function resolveFriendlyClientOptions(options) {
28
29
  return {
29
30
  ...options,
30
- context: options?.context ?? {}
31
+ context: options.context ?? {}
31
32
  // Context only optional if all fields are optional
32
33
  };
33
34
  }
35
+ function consumeEventIterator(iterator, options) {
36
+ void (async () => {
37
+ let onFinishState;
38
+ try {
39
+ const resolvedIterator = await iterator;
40
+ while (true) {
41
+ const { done, value } = await resolvedIterator.next();
42
+ if (done) {
43
+ const realValue = value;
44
+ onFinishState = [null, realValue, true];
45
+ options.onSuccess?.(realValue);
46
+ break;
47
+ }
48
+ options.onEvent(value);
49
+ }
50
+ } catch (error) {
51
+ onFinishState = [error, void 0, false];
52
+ if (!options.onError && !options.onFinish) {
53
+ throw error;
54
+ }
55
+ options.onError?.(error);
56
+ } finally {
57
+ options.onFinish?.(onFinishState);
58
+ }
59
+ })();
60
+ return async () => {
61
+ await (await iterator)?.return?.();
62
+ };
63
+ }
34
64
 
35
- function createORPCClient(link, options) {
36
- const path = options?.path ?? [];
65
+ function createORPCClient(link, options = {}) {
66
+ const path = options.path ?? [];
37
67
  const procedureClient = async (...[input, options2 = {}]) => {
38
68
  return await link.call(path, input, resolveFriendlyClientOptions(options2));
39
69
  };
@@ -48,7 +78,23 @@ function createORPCClient(link, options) {
48
78
  });
49
79
  }
50
80
  });
51
- return recursive;
81
+ return preventNativeAwait(recursive);
82
+ }
83
+
84
+ function createSafeClient(client) {
85
+ const proxy = new Proxy((...args) => safe(client(...args)), {
86
+ get(_, prop, receiver) {
87
+ const value = Reflect.get(client, prop, receiver);
88
+ if (typeof prop !== "string") {
89
+ return value;
90
+ }
91
+ if (!isTypescriptObject(value)) {
92
+ return value;
93
+ }
94
+ return createSafeClient(value);
95
+ }
96
+ });
97
+ return proxy;
52
98
  }
53
99
 
54
100
  class DynamicLink {
@@ -62,4 +108,4 @@ class DynamicLink {
62
108
  }
63
109
  }
64
110
 
65
- export { DynamicLink, createORPCClient, isDefinedError, resolveFriendlyClientOptions, safe };
111
+ export { DynamicLink, consumeEventIterator, createORPCClient, createSafeClient, isDefinedError, resolveFriendlyClientOptions, safe };
@@ -1,7 +1,8 @@
1
- import { Value } from '@orpc/shared';
1
+ import { Value, Promisable } from '@orpc/shared';
2
2
  import { StandardHeaders, StandardRequest } from '@orpc/standard-server';
3
- import { S as StandardLinkClientInterceptorOptions, a as StandardLinkPlugin, b as StandardLinkOptions, c as StandardLinkInterceptorOptions } from '../shared/client.FXep-a3a.mjs';
4
- import { a as ClientContext } from '../shared/client.CipPQkhk.mjs';
3
+ import { BatchResponseMode } from '@orpc/standard-server/batch';
4
+ import { S as StandardLinkClientInterceptorOptions, a as StandardLinkPlugin, b as StandardLinkOptions, c as StandardLinkInterceptorOptions } from '../shared/client.Bwgm6dgk.mjs';
5
+ import { b as ClientContext } from '../shared/client.BOYsZIRq.mjs';
5
6
 
6
7
  interface BatchLinkPluginGroup<T extends ClientContext> {
7
8
  condition(options: StandardLinkClientInterceptorOptions<T>): boolean;
@@ -16,25 +17,31 @@ interface BatchLinkPluginOptions<T extends ClientContext> {
16
17
  *
17
18
  * @default 10
18
19
  */
19
- maxSize?: Value<number, [readonly [StandardLinkClientInterceptorOptions<T>, ...StandardLinkClientInterceptorOptions<T>[]]]>;
20
+ maxSize?: Value<Promisable<number>, [readonly [StandardLinkClientInterceptorOptions<T>, ...StandardLinkClientInterceptorOptions<T>[]]]>;
21
+ /**
22
+ * The batch response mode.
23
+ *
24
+ * @default 'streaming'
25
+ */
26
+ mode?: Value<BatchResponseMode, [readonly [StandardLinkClientInterceptorOptions<T>, ...StandardLinkClientInterceptorOptions<T>[]]]>;
20
27
  /**
21
28
  * Defines the URL to use for the batch request.
22
29
  *
23
30
  * @default the URL of the first request in the batch + '/__batch__'
24
31
  */
25
- url?: Value<string | URL, [readonly [StandardLinkClientInterceptorOptions<T>, ...StandardLinkClientInterceptorOptions<T>[]]]>;
32
+ url?: Value<Promisable<string | URL>, [readonly [StandardLinkClientInterceptorOptions<T>, ...StandardLinkClientInterceptorOptions<T>[]]]>;
26
33
  /**
27
34
  * The maximum length of the URL.
28
35
  *
29
36
  * @default 2083
30
37
  */
31
- maxUrlLength?: Value<number, [readonly [StandardLinkClientInterceptorOptions<T>, ...StandardLinkClientInterceptorOptions<T>[]]]>;
38
+ maxUrlLength?: Value<Promisable<number>, [readonly [StandardLinkClientInterceptorOptions<T>, ...StandardLinkClientInterceptorOptions<T>[]]]>;
32
39
  /**
33
40
  * Defines the HTTP headers to use for the batch request.
34
41
  *
35
42
  * @default The same headers of all requests in the batch
36
43
  */
37
- headers?: Value<StandardHeaders, [readonly [StandardLinkClientInterceptorOptions<T>, ...StandardLinkClientInterceptorOptions<T>[]]]>;
44
+ headers?: Value<Promisable<StandardHeaders>, [readonly [StandardLinkClientInterceptorOptions<T>, ...StandardLinkClientInterceptorOptions<T>[]]]>;
38
45
  /**
39
46
  * Map the batch request items before sending them.
40
47
  *
@@ -52,10 +59,10 @@ interface BatchLinkPluginOptions<T extends ClientContext> {
52
59
  exclude?: (options: StandardLinkClientInterceptorOptions<T>) => boolean;
53
60
  }
54
61
  /**
55
- * The Batch Request/Response Plugin allows you to combine multiple requests and responses into a single batch,
62
+ * The Batch Requests Plugin allows you to combine multiple requests and responses into a single batch,
56
63
  * reducing the overhead of sending each one separately.
57
64
  *
58
- * @see {@link https://orpc.unnoq.com/docs/plugins/batch-request-response Batch Request/Response Plugin Docs}
65
+ * @see {@link https://orpc.unnoq.com/docs/plugins/batch-requests Batch Requests Plugin Docs}
59
66
  */
60
67
  declare class BatchLinkPlugin<T extends ClientContext> implements StandardLinkPlugin<T> {
61
68
  #private;
@@ -66,12 +73,45 @@ declare class BatchLinkPlugin<T extends ClientContext> implements StandardLinkPl
66
73
  private readonly batchHeaders;
67
74
  private readonly mapRequestItem;
68
75
  private readonly exclude;
76
+ private readonly mode;
69
77
  private pending;
70
78
  order: number;
71
79
  constructor(options: NoInfer<BatchLinkPluginOptions<T>>);
72
80
  init(options: StandardLinkOptions<T>): void;
73
81
  }
74
82
 
83
+ interface DedupeRequestsPluginGroup<T extends ClientContext> {
84
+ condition(options: StandardLinkClientInterceptorOptions<T>): boolean;
85
+ /**
86
+ * The context used for the rest of the request lifecycle.
87
+ */
88
+ context: T;
89
+ }
90
+ interface DedupeRequestsPluginOptions<T extends ClientContext> {
91
+ /**
92
+ * To enable deduplication, a request must match at least one defined group.
93
+ * Requests that fall into the same group are considered for deduplication together.
94
+ */
95
+ groups: readonly [DedupeRequestsPluginGroup<T>, ...DedupeRequestsPluginGroup<T>[]];
96
+ /**
97
+ * Filters requests to dedupe
98
+ *
99
+ * @default (({ request }) => request.method === 'GET')
100
+ */
101
+ filter?: (options: StandardLinkClientInterceptorOptions<T>) => boolean;
102
+ }
103
+ /**
104
+ * Prevents duplicate requests by deduplicating similar ones to reduce server load.
105
+ *
106
+ * @see {@link https://orpc.unnoq.com/docs/plugins/dedupe-requests Dedupe Requests Plugin}
107
+ */
108
+ declare class DedupeRequestsPlugin<T extends ClientContext> implements StandardLinkPlugin<T> {
109
+ #private;
110
+ order: number;
111
+ constructor(options: NoInfer<DedupeRequestsPluginOptions<T>>);
112
+ init(options: StandardLinkOptions<T>): void;
113
+ }
114
+
75
115
  interface ClientRetryPluginAttemptOptions<T extends ClientContext> extends StandardLinkInterceptorOptions<T> {
76
116
  lastEventRetry: number | undefined;
77
117
  attemptIndex: number;
@@ -84,19 +124,19 @@ interface ClientRetryPluginContext {
84
124
  *
85
125
  * @default 0
86
126
  */
87
- retry?: Value<number, [StandardLinkInterceptorOptions<ClientRetryPluginContext>]>;
127
+ retry?: Value<Promisable<number>, [StandardLinkInterceptorOptions<ClientRetryPluginContext>]>;
88
128
  /**
89
129
  * Delay (in ms) before retrying.
90
130
  *
91
131
  * @default (o) => o.lastEventRetry ?? 2000
92
132
  */
93
- retryDelay?: Value<number, [ClientRetryPluginAttemptOptions<ClientRetryPluginContext>]>;
133
+ retryDelay?: Value<Promisable<number>, [ClientRetryPluginAttemptOptions<ClientRetryPluginContext>]>;
94
134
  /**
95
135
  * Determine should retry or not.
96
136
  *
97
137
  * @default true
98
138
  */
99
- shouldRetry?: Value<boolean, [ClientRetryPluginAttemptOptions<ClientRetryPluginContext>]>;
139
+ shouldRetry?: Value<Promisable<boolean>, [ClientRetryPluginAttemptOptions<ClientRetryPluginContext>]>;
100
140
  /**
101
141
  * The hook called when retrying, and return the unsubscribe function.
102
142
  */
@@ -117,6 +157,7 @@ declare class ClientRetryPlugin<T extends ClientRetryPluginContext> implements S
117
157
  private readonly defaultRetryDelay;
118
158
  private readonly defaultShouldRetry;
119
159
  private readonly defaultOnRetry;
160
+ order: number;
120
161
  constructor(options?: ClientRetryPluginOptions);
121
162
  init(options: StandardLinkOptions<T>): void;
122
163
  }
@@ -127,20 +168,20 @@ interface SimpleCsrfProtectionLinkPluginOptions<T extends ClientContext> {
127
168
  *
128
169
  * @default 'x-csrf-token'
129
170
  */
130
- headerName?: Value<string, [options: StandardLinkClientInterceptorOptions<T>]>;
171
+ headerName?: Value<Promisable<string>, [options: StandardLinkClientInterceptorOptions<T>]>;
131
172
  /**
132
173
  * The value of the header to check.
133
174
  *
134
175
  * @default 'orpc'
135
176
  *
136
177
  */
137
- headerValue?: Value<string, [options: StandardLinkClientInterceptorOptions<T>]>;
178
+ headerValue?: Value<Promisable<string>, [options: StandardLinkClientInterceptorOptions<T>]>;
138
179
  /**
139
180
  * Exclude a procedure from the plugin.
140
181
  *
141
182
  * @default false
142
183
  */
143
- exclude?: Value<boolean, [options: StandardLinkClientInterceptorOptions<T>]>;
184
+ exclude?: Value<Promisable<boolean>, [options: StandardLinkClientInterceptorOptions<T>]>;
144
185
  }
145
186
  /**
146
187
  * This plugin adds basic Cross-Site Request Forgery (CSRF) protection to your oRPC application.
@@ -158,5 +199,5 @@ declare class SimpleCsrfProtectionLinkPlugin<T extends ClientContext> implements
158
199
  init(options: StandardLinkOptions<T>): void;
159
200
  }
160
201
 
161
- export { BatchLinkPlugin, ClientRetryPlugin, ClientRetryPluginInvalidEventIteratorRetryResponse, SimpleCsrfProtectionLinkPlugin };
162
- export type { BatchLinkPluginGroup, BatchLinkPluginOptions, ClientRetryPluginAttemptOptions, ClientRetryPluginContext, ClientRetryPluginOptions, SimpleCsrfProtectionLinkPluginOptions };
202
+ export { BatchLinkPlugin, ClientRetryPlugin, ClientRetryPluginInvalidEventIteratorRetryResponse, DedupeRequestsPlugin, SimpleCsrfProtectionLinkPlugin };
203
+ export type { BatchLinkPluginGroup, BatchLinkPluginOptions, ClientRetryPluginAttemptOptions, ClientRetryPluginContext, ClientRetryPluginOptions, DedupeRequestsPluginGroup, DedupeRequestsPluginOptions, SimpleCsrfProtectionLinkPluginOptions };