@orpc/client 0.0.0-next.f16d90e → 0.0.0-next.f21e305
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/README.md +8 -8
- package/dist/adapters/fetch/index.d.mts +23 -10
- package/dist/adapters/fetch/index.d.ts +23 -10
- package/dist/adapters/fetch/index.mjs +24 -8
- package/dist/adapters/message-port/index.d.mts +12 -12
- package/dist/adapters/message-port/index.d.ts +12 -12
- package/dist/adapters/message-port/index.mjs +9 -8
- package/dist/adapters/standard/index.d.mts +6 -5
- package/dist/adapters/standard/index.d.ts +6 -5
- package/dist/adapters/standard/index.mjs +3 -2
- package/dist/adapters/websocket/index.d.mts +12 -12
- package/dist/adapters/websocket/index.d.ts +12 -12
- package/dist/adapters/websocket/index.mjs +25 -10
- package/dist/index.d.mts +86 -25
- package/dist/index.d.ts +86 -25
- package/dist/index.mjs +54 -8
- package/dist/plugins/index.d.mts +12 -4
- package/dist/plugins/index.d.ts +12 -4
- package/dist/plugins/index.mjs +45 -25
- package/dist/shared/{client.C0KbSWlC.d.ts → client.BG98rYdO.d.ts} +1 -2
- package/dist/shared/{client.DpICn1BD.mjs → client.BIYmXux0.mjs} +62 -20
- package/dist/shared/{client.4TS_0JaO.d.mts → client.BOYsZIRq.d.mts} +1 -1
- package/dist/shared/{client.4TS_0JaO.d.ts → client.BOYsZIRq.d.ts} +1 -1
- package/dist/shared/{client.BMoG_EdN.d.mts → client.Bwgm6dgk.d.mts} +1 -2
- package/dist/shared/{client.CRWEpqLB.mjs → client.C9Q9FzmH.mjs} +66 -33
- package/dist/shared/{client.7UM0t5o-.d.ts → client.CVVVqf1Y.d.ts} +3 -3
- package/dist/shared/{client.BdD8cpjs.d.mts → client._Y_enhib.d.mts} +3 -3
- package/package.json +6 -6
package/dist/index.d.mts
CHANGED
@@ -1,14 +1,14 @@
|
|
1
|
-
import { N as NestedClient, C as ClientLink, I as InferClientContext, a as
|
2
|
-
export { f as
|
3
|
-
import {
|
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, ...
|
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.f21e305";
|
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
|
2
|
-
export { f as
|
3
|
-
import {
|
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, ...
|
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.f21e305";
|
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 {
|
2
|
-
export {
|
3
|
-
|
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.C9Q9FzmH.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.C9Q9FzmH.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
|
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
|
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 };
|
package/dist/plugins/index.d.mts
CHANGED
@@ -1,7 +1,8 @@
|
|
1
1
|
import { Value, Promisable } from '@orpc/shared';
|
2
2
|
import { StandardHeaders, StandardRequest } from '@orpc/standard-server';
|
3
|
-
import {
|
4
|
-
import { a as
|
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;
|
@@ -17,6 +18,12 @@ interface BatchLinkPluginOptions<T extends ClientContext> {
|
|
17
18
|
* @default 10
|
18
19
|
*/
|
19
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
|
*
|
@@ -52,10 +59,10 @@ interface BatchLinkPluginOptions<T extends ClientContext> {
|
|
52
59
|
exclude?: (options: StandardLinkClientInterceptorOptions<T>) => boolean;
|
53
60
|
}
|
54
61
|
/**
|
55
|
-
* The 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-
|
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,6 +73,7 @@ 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>>);
|
package/dist/plugins/index.d.ts
CHANGED
@@ -1,7 +1,8 @@
|
|
1
1
|
import { Value, Promisable } from '@orpc/shared';
|
2
2
|
import { StandardHeaders, StandardRequest } from '@orpc/standard-server';
|
3
|
-
import {
|
4
|
-
import { a as
|
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.BG98rYdO.js';
|
5
|
+
import { b as ClientContext } from '../shared/client.BOYsZIRq.js';
|
5
6
|
|
6
7
|
interface BatchLinkPluginGroup<T extends ClientContext> {
|
7
8
|
condition(options: StandardLinkClientInterceptorOptions<T>): boolean;
|
@@ -17,6 +18,12 @@ interface BatchLinkPluginOptions<T extends ClientContext> {
|
|
17
18
|
* @default 10
|
18
19
|
*/
|
19
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
|
*
|
@@ -52,10 +59,10 @@ interface BatchLinkPluginOptions<T extends ClientContext> {
|
|
52
59
|
exclude?: (options: StandardLinkClientInterceptorOptions<T>) => boolean;
|
53
60
|
}
|
54
61
|
/**
|
55
|
-
* The 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-
|
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,6 +73,7 @@ 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>>);
|
package/dist/plugins/index.mjs
CHANGED
@@ -1,4 +1,4 @@
|
|
1
|
-
import { isAsyncIteratorObject, value, splitInHalf, toArray, stringifyJSON } from '@orpc/shared';
|
1
|
+
import { isAsyncIteratorObject, defer, value, splitInHalf, toArray, stringifyJSON, 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
|
|
@@ -10,6 +10,7 @@ class BatchLinkPlugin {
|
|
10
10
|
batchHeaders;
|
11
11
|
mapRequestItem;
|
12
12
|
exclude;
|
13
|
+
mode;
|
13
14
|
pending;
|
14
15
|
order = 5e6;
|
15
16
|
constructor(options) {
|
@@ -17,6 +18,7 @@ class BatchLinkPlugin {
|
|
17
18
|
this.pending = /* @__PURE__ */ new Map();
|
18
19
|
this.maxSize = options.maxSize ?? 10;
|
19
20
|
this.maxUrlLength = options.maxUrlLength ?? 2083;
|
21
|
+
this.mode = options.mode ?? "streaming";
|
20
22
|
this.batchUrl = options.url ?? (([options2]) => `${options2.request.url.origin}${options2.request.url.pathname}/__batch__`);
|
21
23
|
this.batchHeaders = options.headers ?? (([options2, ...rest]) => {
|
22
24
|
const headers = {};
|
@@ -62,7 +64,7 @@ class BatchLinkPlugin {
|
|
62
64
|
});
|
63
65
|
});
|
64
66
|
options.clientInterceptors.push((options2) => {
|
65
|
-
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) {
|
66
68
|
return options2.next();
|
67
69
|
}
|
68
70
|
const group = this.groups.find((group2) => group2.condition(options2));
|
@@ -71,7 +73,7 @@ class BatchLinkPlugin {
|
|
71
73
|
}
|
72
74
|
return new Promise((resolve, reject) => {
|
73
75
|
this.#enqueueRequest(group, options2, resolve, reject);
|
74
|
-
|
76
|
+
defer(() => this.#processPendingBatches());
|
75
77
|
});
|
76
78
|
});
|
77
79
|
}
|
@@ -127,16 +129,28 @@ class BatchLinkPlugin {
|
|
127
129
|
this.#executeBatch(method, group, second);
|
128
130
|
return;
|
129
131
|
}
|
130
|
-
const
|
131
|
-
|
132
|
-
|
133
|
-
|
134
|
-
|
135
|
-
|
136
|
-
|
137
|
-
|
138
|
-
|
139
|
-
|
132
|
+
const mode = value(this.mode, options);
|
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;
|
140
154
|
}
|
141
155
|
throw new Error("Something went wrong make batch response not contains enough responses. This can be a bug please report it.");
|
142
156
|
} catch (error) {
|
@@ -169,7 +183,7 @@ class DedupeRequestsPlugin {
|
|
169
183
|
}
|
170
184
|
return new Promise((resolve, reject) => {
|
171
185
|
this.#enqueue(group, options2, resolve, reject);
|
172
|
-
|
186
|
+
defer(() => this.#dequeue());
|
173
187
|
});
|
174
188
|
});
|
175
189
|
}
|
@@ -303,7 +317,7 @@ class ClientRetryPlugin {
|
|
303
317
|
return await interceptorOptions.next(updatedInterceptorOptions);
|
304
318
|
} catch (error) {
|
305
319
|
currentError = { error };
|
306
|
-
if (updatedInterceptorOptions.signal?.aborted
|
320
|
+
if (updatedInterceptorOptions.signal?.aborted) {
|
307
321
|
throw error;
|
308
322
|
}
|
309
323
|
} finally {
|
@@ -316,19 +330,17 @@ class ClientRetryPlugin {
|
|
316
330
|
if (!isAsyncIteratorObject(output)) {
|
317
331
|
return output;
|
318
332
|
}
|
319
|
-
|
320
|
-
|
321
|
-
|
333
|
+
let current = output;
|
334
|
+
let isIteratorAborted = false;
|
335
|
+
return new AsyncIteratorClass(
|
336
|
+
async () => {
|
322
337
|
while (true) {
|
323
338
|
try {
|
324
339
|
const item = await current.next();
|
325
340
|
const meta = getEventMeta(item.value);
|
326
341
|
lastEventId = meta?.id ?? lastEventId;
|
327
342
|
lastEventRetry = meta?.retry ?? lastEventRetry;
|
328
|
-
|
329
|
-
return item.value;
|
330
|
-
}
|
331
|
-
yield item.value;
|
343
|
+
return item;
|
332
344
|
} catch (error) {
|
333
345
|
const meta = getEventMeta(error);
|
334
346
|
lastEventId = meta?.id ?? lastEventId;
|
@@ -340,12 +352,20 @@ class ClientRetryPlugin {
|
|
340
352
|
);
|
341
353
|
}
|
342
354
|
current = maybeEventIterator;
|
355
|
+
if (isIteratorAborted) {
|
356
|
+
await current.return?.();
|
357
|
+
throw error;
|
358
|
+
}
|
343
359
|
}
|
344
360
|
}
|
345
|
-
}
|
346
|
-
|
361
|
+
},
|
362
|
+
async (reason) => {
|
363
|
+
isIteratorAborted = true;
|
364
|
+
if (reason !== "next") {
|
365
|
+
await current.return?.();
|
366
|
+
}
|
347
367
|
}
|
348
|
-
|
368
|
+
);
|
349
369
|
});
|
350
370
|
}
|
351
371
|
}
|
@@ -1,6 +1,6 @@
|
|
1
1
|
import { Interceptor } from '@orpc/shared';
|
2
2
|
import { StandardRequest, StandardLazyResponse } from '@orpc/standard-server';
|
3
|
-
import {
|
3
|
+
import { b as ClientContext, c as ClientOptions, C as ClientLink } from './client.BOYsZIRq.js';
|
4
4
|
|
5
5
|
interface StandardLinkPlugin<T extends ClientContext> {
|
6
6
|
order?: number;
|
@@ -33,7 +33,6 @@ interface StandardLinkOptions<T extends ClientContext> {
|
|
33
33
|
plugins?: StandardLinkPlugin<T>[];
|
34
34
|
}
|
35
35
|
declare class StandardLink<T extends ClientContext> implements ClientLink<T> {
|
36
|
-
#private;
|
37
36
|
readonly codec: StandardLinkCodec<T>;
|
38
37
|
readonly sender: StandardLinkClient<T>;
|
39
38
|
private readonly interceptors;
|