@orpc/client 0.0.0-next.d929a5e → 0.0.0-next.d92c7aa

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.
Files changed (30) hide show
  1. package/README.md +7 -2
  2. package/dist/adapters/fetch/index.d.mts +23 -10
  3. package/dist/adapters/fetch/index.d.ts +23 -10
  4. package/dist/adapters/fetch/index.mjs +24 -8
  5. package/dist/adapters/message-port/index.d.mts +36 -15
  6. package/dist/adapters/message-port/index.d.ts +36 -15
  7. package/dist/adapters/message-port/index.mjs +29 -14
  8. package/dist/adapters/standard/index.d.mts +6 -5
  9. package/dist/adapters/standard/index.d.ts +6 -5
  10. package/dist/adapters/standard/index.mjs +3 -2
  11. package/dist/adapters/websocket/index.d.mts +12 -12
  12. package/dist/adapters/websocket/index.d.ts +12 -12
  13. package/dist/adapters/websocket/index.mjs +26 -11
  14. package/dist/index.d.mts +86 -25
  15. package/dist/index.d.ts +86 -25
  16. package/dist/index.mjs +53 -7
  17. package/dist/plugins/index.d.mts +3 -2
  18. package/dist/plugins/index.d.ts +3 -2
  19. package/dist/plugins/index.mjs +41 -23
  20. package/dist/shared/client.BH1AYT_p.d.mts +83 -0
  21. package/dist/shared/client.BH1AYT_p.d.ts +83 -0
  22. package/dist/shared/{client.7UM0t5o-.d.ts → client.BxV-mzeR.d.ts} +3 -3
  23. package/dist/shared/{client.DpICn1BD.mjs → client.C0heK4ll.mjs} +62 -20
  24. package/dist/shared/{client.C0KbSWlC.d.ts → client.CPgZaUox.d.mts} +1 -2
  25. package/dist/shared/{client.BdD8cpjs.d.mts → client.D8lMmWVC.d.mts} +3 -3
  26. package/dist/shared/{client.BMoG_EdN.d.mts → client.De8SW4Kw.d.ts} +1 -2
  27. package/dist/shared/{client.CRWEpqLB.mjs → client.o7kYI1Tg.mjs} +66 -33
  28. package/package.json +6 -6
  29. package/dist/shared/client.4TS_0JaO.d.mts +0 -29
  30. package/dist/shared/client.4TS_0JaO.d.ts +0 -29
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.4TS_0JaO.mjs';
2
- export { f as Client, e as ClientRest, d as HTTPMethod, H as HTTPPath } from './shared/client.4TS_0JaO.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.BH1AYT_p.mjs';
2
+ export { f as HTTPMethod, H as HTTPPath, h as InferClientBodyInputs, j as InferClientBodyOutputs, l as InferClientErrorUnion, k as InferClientErrors, g as InferClientInputs, i as InferClientOutputs } from './shared/client.BH1AYT_p.mjs';
3
+ import { MaybeOptionalOptions, ThrowableError, OnFinishState, Promisable, AsyncIteratorClass } from '@orpc/shared';
4
+ export { AsyncIteratorClass, EventPublisher, EventPublisherOptions, EventPublisherSubscribeIteratorOptions, Registry, ThrowableError, asyncIteratorToStream as eventIteratorToStream, asyncIteratorToUnproxiedDataStream as eventIteratorToUnproxiedDataStream, 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.d92c7aa";
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.4TS_0JaO.js';
2
- export { f as Client, e as ClientRest, d as HTTPMethod, H as HTTPPath } from './shared/client.4TS_0JaO.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.BH1AYT_p.js';
2
+ export { f as HTTPMethod, H as HTTPPath, h as InferClientBodyInputs, j as InferClientBodyOutputs, l as InferClientErrorUnion, k as InferClientErrors, g as InferClientInputs, i as InferClientOutputs } from './shared/client.BH1AYT_p.js';
3
+ import { MaybeOptionalOptions, ThrowableError, OnFinishState, Promisable, AsyncIteratorClass } from '@orpc/shared';
4
+ export { AsyncIteratorClass, EventPublisher, EventPublisherOptions, EventPublisherSubscribeIteratorOptions, Registry, ThrowableError, asyncIteratorToStream as eventIteratorToStream, asyncIteratorToUnproxiedDataStream as eventIteratorToUnproxiedDataStream, 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.d92c7aa";
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, asyncIteratorToUnproxiedDataStream as eventIteratorToUnproxiedDataStream, onError, onFinish, onStart, onSuccess, streamToAsyncIteratorClass as streamToEventIterator } from '@orpc/shared';
3
+ import { i as isDefinedError } from './shared/client.o7kYI1Tg.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.o7kYI1Tg.mjs';
4
5
  export { ErrorEvent } from '@orpc/standard-server';
5
6
 
6
7
  async function safe(promise) {
@@ -31,9 +32,38 @@ function resolveFriendlyClientOptions(options) {
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,8 +1,8 @@
1
1
  import { Value, Promisable } from '@orpc/shared';
2
2
  import { StandardHeaders, StandardRequest } from '@orpc/standard-server';
3
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.BMoG_EdN.mjs';
5
- import { a as ClientContext } from '../shared/client.4TS_0JaO.mjs';
4
+ import { S as StandardLinkClientInterceptorOptions, a as StandardLinkPlugin, b as StandardLinkOptions, c as StandardLinkInterceptorOptions } from '../shared/client.CPgZaUox.mjs';
5
+ import { b as ClientContext } from '../shared/client.BH1AYT_p.mjs';
6
6
 
7
7
  interface BatchLinkPluginGroup<T extends ClientContext> {
8
8
  condition(options: StandardLinkClientInterceptorOptions<T>): boolean;
@@ -157,6 +157,7 @@ declare class ClientRetryPlugin<T extends ClientRetryPluginContext> implements S
157
157
  private readonly defaultRetryDelay;
158
158
  private readonly defaultShouldRetry;
159
159
  private readonly defaultOnRetry;
160
+ order: number;
160
161
  constructor(options?: ClientRetryPluginOptions);
161
162
  init(options: StandardLinkOptions<T>): void;
162
163
  }
@@ -1,8 +1,8 @@
1
1
  import { Value, Promisable } from '@orpc/shared';
2
2
  import { StandardHeaders, StandardRequest } from '@orpc/standard-server';
3
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.C0KbSWlC.js';
5
- import { a as ClientContext } from '../shared/client.4TS_0JaO.js';
4
+ import { S as StandardLinkClientInterceptorOptions, a as StandardLinkPlugin, b as StandardLinkOptions, c as StandardLinkInterceptorOptions } from '../shared/client.De8SW4Kw.js';
5
+ import { b as ClientContext } from '../shared/client.BH1AYT_p.js';
6
6
 
7
7
  interface BatchLinkPluginGroup<T extends ClientContext> {
8
8
  condition(options: StandardLinkClientInterceptorOptions<T>): boolean;
@@ -157,6 +157,7 @@ declare class ClientRetryPlugin<T extends ClientRetryPluginContext> implements S
157
157
  private readonly defaultRetryDelay;
158
158
  private readonly defaultShouldRetry;
159
159
  private readonly defaultOnRetry;
160
+ order: number;
160
161
  constructor(options?: ClientRetryPluginOptions);
161
162
  init(options: StandardLinkOptions<T>): void;
162
163
  }
@@ -1,4 +1,4 @@
1
- import { isAsyncIteratorObject, defer, value, splitInHalf, toArray, stringifyJSON } from '@orpc/shared';
1
+ import { isAsyncIteratorObject, defer, value, splitInHalf, toArray, stringifyJSON, overlayProxy, AsyncIteratorClass } from '@orpc/shared';
2
2
  import { toBatchRequest, parseBatchResponse, toBatchAbortSignal } from '@orpc/standard-server/batch';
3
3
  import { replicateStandardLazyResponse, getEventMeta } from '@orpc/standard-server';
4
4
 
@@ -64,7 +64,7 @@ class BatchLinkPlugin {
64
64
  });
65
65
  });
66
66
  options.clientInterceptors.push((options2) => {
67
- if (this.exclude(options2) || options2.request.body instanceof Blob || options2.request.body instanceof FormData || isAsyncIteratorObject(options2.request.body)) {
67
+ if (this.exclude(options2) || options2.request.body instanceof Blob || options2.request.body instanceof FormData || isAsyncIteratorObject(options2.request.body) || options2.request.signal?.aborted) {
68
68
  return options2.next();
69
69
  }
70
70
  const group = this.groups.find((group2) => group2.condition(options2));
@@ -130,16 +130,27 @@ class BatchLinkPlugin {
130
130
  return;
131
131
  }
132
132
  const mode = value(this.mode, options);
133
- const lazyResponse = await options[0].next({
134
- request: { ...batchRequest, headers: { ...batchRequest.headers, "x-orpc-batch": mode } },
135
- signal: batchRequest.signal,
136
- context: group.context,
137
- input: group.input,
138
- path: toArray(group.path)
139
- });
140
- const parsed = parseBatchResponse({ ...lazyResponse, body: await lazyResponse.body() });
141
- for await (const item of parsed) {
142
- batchItems[item.index]?.[1]({ ...item, body: () => Promise.resolve(item.body) });
133
+ try {
134
+ const lazyResponse = await options[0].next({
135
+ request: { ...batchRequest, headers: { ...batchRequest.headers, "x-orpc-batch": mode } },
136
+ signal: batchRequest.signal,
137
+ context: group.context,
138
+ input: group.input,
139
+ path: toArray(group.path)
140
+ });
141
+ const parsed = parseBatchResponse({ ...lazyResponse, body: await lazyResponse.body() });
142
+ for await (const item of parsed) {
143
+ batchItems[item.index]?.[1]({ ...item, body: () => Promise.resolve(item.body) });
144
+ }
145
+ } catch (err) {
146
+ if (batchRequest.signal?.aborted && batchRequest.signal.reason === err) {
147
+ for (const [{ signal }, , reject] of batchItems) {
148
+ if (signal?.aborted) {
149
+ reject(signal.reason);
150
+ }
151
+ }
152
+ }
153
+ throw err;
143
154
  }
144
155
  throw new Error("Something went wrong make batch response not contains enough responses. This can be a bug please report it.");
145
156
  } catch (error) {
@@ -252,6 +263,7 @@ class ClientRetryPlugin {
252
263
  defaultRetryDelay;
253
264
  defaultShouldRetry;
254
265
  defaultOnRetry;
266
+ order = 18e5;
255
267
  constructor(options = {}) {
256
268
  this.defaultRetry = options.default?.retry ?? 0;
257
269
  this.defaultRetryDelay = options.default?.retryDelay ?? ((o) => o.lastEventRetry ?? 2e3);
@@ -306,7 +318,7 @@ class ClientRetryPlugin {
306
318
  return await interceptorOptions.next(updatedInterceptorOptions);
307
319
  } catch (error) {
308
320
  currentError = { error };
309
- if (updatedInterceptorOptions.signal?.aborted === true) {
321
+ if (updatedInterceptorOptions.signal?.aborted) {
310
322
  throw error;
311
323
  }
312
324
  } finally {
@@ -319,19 +331,17 @@ class ClientRetryPlugin {
319
331
  if (!isAsyncIteratorObject(output)) {
320
332
  return output;
321
333
  }
322
- return async function* () {
323
- let current = output;
324
- try {
334
+ let current = output;
335
+ let isIteratorAborted = false;
336
+ return overlayProxy(() => current, new AsyncIteratorClass(
337
+ async () => {
325
338
  while (true) {
326
339
  try {
327
340
  const item = await current.next();
328
341
  const meta = getEventMeta(item.value);
329
342
  lastEventId = meta?.id ?? lastEventId;
330
343
  lastEventRetry = meta?.retry ?? lastEventRetry;
331
- if (item.done) {
332
- return item.value;
333
- }
334
- yield item.value;
344
+ return item;
335
345
  } catch (error) {
336
346
  const meta = getEventMeta(error);
337
347
  lastEventId = meta?.id ?? lastEventId;
@@ -343,12 +353,20 @@ class ClientRetryPlugin {
343
353
  );
344
354
  }
345
355
  current = maybeEventIterator;
356
+ if (isIteratorAborted) {
357
+ await current.return?.();
358
+ throw error;
359
+ }
346
360
  }
347
361
  }
348
- } finally {
349
- await current.return?.();
362
+ },
363
+ async (reason) => {
364
+ isIteratorAborted = true;
365
+ if (reason !== "next") {
366
+ await current.return?.();
367
+ }
350
368
  }
351
- }();
369
+ ));
352
370
  });
353
371
  }
354
372
  }
@@ -0,0 +1,83 @@
1
+ import { PromiseWithError } from '@orpc/shared';
2
+
3
+ type HTTPPath = `/${string}`;
4
+ type HTTPMethod = 'HEAD' | 'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH';
5
+ type ClientContext = Record<PropertyKey, any>;
6
+ interface ClientOptions<T extends ClientContext> {
7
+ signal?: AbortSignal;
8
+ lastEventId?: string | undefined;
9
+ context: T;
10
+ }
11
+ type FriendlyClientOptions<T extends ClientContext> = Omit<ClientOptions<T>, 'context'> & (Record<never, never> extends T ? {
12
+ context?: T;
13
+ } : {
14
+ context: T;
15
+ });
16
+ type ClientRest<TClientContext extends ClientContext, TInput> = Record<never, never> extends TClientContext ? undefined extends TInput ? [input?: TInput, options?: FriendlyClientOptions<TClientContext>] : [input: TInput, options?: FriendlyClientOptions<TClientContext>] : [input: TInput, options: FriendlyClientOptions<TClientContext>];
17
+ type ClientPromiseResult<TOutput, TError> = PromiseWithError<TOutput, TError>;
18
+ interface Client<TClientContext extends ClientContext, TInput, TOutput, TError> {
19
+ (...rest: ClientRest<TClientContext, TInput>): ClientPromiseResult<TOutput, TError>;
20
+ }
21
+ type NestedClient<TClientContext extends ClientContext> = Client<TClientContext, any, any, any> | {
22
+ [k: string]: NestedClient<TClientContext>;
23
+ };
24
+ type InferClientContext<T extends NestedClient<any>> = T extends NestedClient<infer U> ? U : never;
25
+ interface ClientLink<TClientContext extends ClientContext> {
26
+ call: (path: readonly string[], input: unknown, options: ClientOptions<TClientContext>) => Promise<unknown>;
27
+ }
28
+ /**
29
+ * Recursively infers the **input types** from a client.
30
+ *
31
+ * Produces a nested map where each endpoint's input type is preserved.
32
+ */
33
+ type InferClientInputs<T extends NestedClient<any>> = T extends Client<any, infer U, any, any> ? U : {
34
+ [K in keyof T]: T[K] extends NestedClient<any> ? InferClientInputs<T[K]> : never;
35
+ };
36
+ /**
37
+ * Recursively infers the **body input types** from a client.
38
+ *
39
+ * If an endpoint's input includes `{ body: ... }`, only the `body` portion is extracted.
40
+ * Produces a nested map of body input types.
41
+ */
42
+ type InferClientBodyInputs<T extends NestedClient<any>> = T extends Client<any, infer U, any, any> ? U extends {
43
+ body: infer UBody;
44
+ } ? UBody : U : {
45
+ [K in keyof T]: T[K] extends NestedClient<any> ? InferClientBodyInputs<T[K]> : never;
46
+ };
47
+ /**
48
+ * Recursively infers the **output types** from a client.
49
+ *
50
+ * Produces a nested map where each endpoint's output type is preserved.
51
+ */
52
+ type InferClientOutputs<T extends NestedClient<any>> = T extends Client<any, any, infer U, any> ? U : {
53
+ [K in keyof T]: T[K] extends NestedClient<any> ? InferClientOutputs<T[K]> : never;
54
+ };
55
+ /**
56
+ * Recursively infers the **body output types** from a client.
57
+ *
58
+ * If an endpoint's output includes `{ body: ... }`, only the `body` portion is extracted.
59
+ * Produces a nested map of body output types.
60
+ */
61
+ type InferClientBodyOutputs<T extends NestedClient<any>> = T extends Client<any, any, infer U, any> ? U extends {
62
+ body: infer UBody;
63
+ } ? UBody : U : {
64
+ [K in keyof T]: T[K] extends NestedClient<any> ? InferClientBodyOutputs<T[K]> : never;
65
+ };
66
+ /**
67
+ * Recursively infers the **error types** from a client when you use [type-safe errors](https://orpc.unnoq.com/docs/error-handling#type‐safe-error-handling).
68
+ *
69
+ * Produces a nested map where each endpoint's error type is preserved.
70
+ */
71
+ type InferClientErrors<T extends NestedClient<any>> = T extends Client<any, any, any, infer U> ? U : {
72
+ [K in keyof T]: T[K] extends NestedClient<any> ? InferClientErrors<T[K]> : never;
73
+ };
74
+ /**
75
+ * Recursively infers a **union of all error types** from a client when you use [type-safe errors](https://orpc.unnoq.com/docs/error-handling#type‐safe-error-handling).
76
+ *
77
+ * Useful when you want to handle all possible errors from any endpoint at once.
78
+ */
79
+ type InferClientErrorUnion<T extends NestedClient<any>> = T extends Client<any, any, any, infer U> ? U : {
80
+ [K in keyof T]: T[K] extends NestedClient<any> ? InferClientErrorUnion<T[K]> : never;
81
+ }[keyof T];
82
+
83
+ export type { ClientLink as C, FriendlyClientOptions as F, HTTPPath as H, InferClientContext as I, NestedClient as N, ClientPromiseResult as a, ClientContext as b, ClientOptions as c, Client as d, ClientRest as e, HTTPMethod as f, InferClientInputs as g, InferClientBodyInputs as h, InferClientOutputs as i, InferClientBodyOutputs as j, InferClientErrors as k, InferClientErrorUnion as l };