@orpc/client 0.0.0-next.d452413 → 0.0.0-next.d4f9056

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.
@@ -1,148 +1,11 @@
1
- import { Value, Interceptor, Segment } from '@orpc/shared';
2
- import { StandardRequest, StandardLazyResponse, StandardHeaders } from '@orpc/standard-server';
3
- import { C as ClientContext, a as ClientOptionsOut, E as EventIteratorReconnectOptions, b as ClientLink } from '../../shared/client.D_CzLDyB.js';
1
+ export { C as CompositeStandardLinkPlugin, d as StandardLink, f as StandardLinkClient, S as StandardLinkClientInterceptorOptions, e as StandardLinkCodec, c as StandardLinkInterceptorOptions, b as StandardLinkOptions, a as StandardLinkPlugin } from '../../shared/client.BG98rYdO.js';
2
+ export { S as STANDARD_RPC_JSON_SERIALIZER_BUILT_IN_TYPES, c as StandardRPCCustomJsonSerializer, b as StandardRPCJsonSerialized, a as StandardRPCJsonSerializedMetaItem, e as StandardRPCJsonSerializer, d as StandardRPCJsonSerializerOptions, g as StandardRPCLink, i as StandardRPCLinkCodec, h as StandardRPCLinkCodecOptions, f as StandardRPCLinkOptions, j as StandardRPCSerializer } from '../../shared/client.CVVVqf1Y.js';
3
+ import { StandardHeaders } from '@orpc/standard-server';
4
+ import { H as HTTPPath } from '../../shared/client.BOYsZIRq.js';
5
+ import '@orpc/shared';
4
6
 
5
- interface StandardLinkCodec<T extends ClientContext> {
6
- encode(path: readonly string[], input: unknown, options: ClientOptionsOut<any>): Promise<StandardRequest>;
7
- decode(response: StandardLazyResponse, options: ClientOptionsOut<T>, path: readonly string[], input: unknown): Promise<unknown>;
8
- }
9
- interface StandardLinkClient<T extends ClientContext> {
10
- call(request: StandardRequest, options: ClientOptionsOut<T>, path: readonly string[], input: unknown): Promise<StandardLazyResponse>;
11
- }
7
+ declare function toHttpPath(path: readonly string[]): HTTPPath;
8
+ declare function toStandardHeaders(headers: Headers | StandardHeaders): StandardHeaders;
9
+ declare function getMalformedResponseErrorCode(status: number): string;
12
10
 
13
- declare class InvalidEventIteratorRetryResponse extends Error {
14
- }
15
- interface StandardLinkOptions<T extends ClientContext> {
16
- /**
17
- * Maximum number of retry attempts for event iterator errors before throwing.
18
- *
19
- * @default 5
20
- */
21
- eventIteratorMaxRetries?: Value<number, [
22
- reconnectOptions: EventIteratorReconnectOptions,
23
- options: ClientOptionsOut<T>,
24
- path: readonly string[],
25
- input: unknown
26
- ]>;
27
- /**
28
- * Delay (in ms) before retrying an event iterator call.
29
- *
30
- * @default (o) => o.lastRetry ?? (1000 * 2 ** o.retryTimes)
31
- */
32
- eventIteratorRetryDelay?: Value<number, [
33
- reconnectOptions: EventIteratorReconnectOptions,
34
- options: ClientOptionsOut<T>,
35
- path: readonly string[],
36
- input: unknown
37
- ]>;
38
- /**
39
- * Function to determine if an error is retryable.
40
- *
41
- * @default true
42
- */
43
- eventIteratorShouldRetry?: Value<boolean, [
44
- reconnectOptions: EventIteratorReconnectOptions,
45
- options: ClientOptionsOut<T>,
46
- path: readonly string[],
47
- input: unknown
48
- ]>;
49
- interceptors?: Interceptor<{
50
- path: readonly string[];
51
- input: unknown;
52
- options: ClientOptionsOut<T>;
53
- }, unknown, unknown>[];
54
- clientInterceptors?: Interceptor<{
55
- request: StandardRequest;
56
- }, StandardLazyResponse, unknown>[];
57
- }
58
- declare class StandardLink<T extends ClientContext> implements ClientLink<T> {
59
- #private;
60
- readonly codec: StandardLinkCodec<T>;
61
- readonly sender: StandardLinkClient<T>;
62
- private readonly eventIteratorMaxRetries;
63
- private readonly eventIteratorRetryDelay;
64
- private readonly eventIteratorShouldRetry;
65
- private readonly interceptors;
66
- private readonly clientInterceptors;
67
- constructor(codec: StandardLinkCodec<T>, sender: StandardLinkClient<T>, options: StandardLinkOptions<T>);
68
- call(path: readonly string[], input: unknown, options: ClientOptionsOut<T>): Promise<unknown>;
69
- }
70
-
71
- type RPCJsonSerializedMeta = [
72
- 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7,
73
- Segment[]
74
- ][];
75
- type RPCJsonSerialized = [json: unknown, meta: RPCJsonSerializedMeta, maps: Segment[][], blobs: Blob[]];
76
- declare class RPCJsonSerializer {
77
- serialize(data: unknown, segments?: Segment[], meta?: RPCJsonSerializedMeta, maps?: Segment[][], blobs?: Blob[]): RPCJsonSerialized;
78
- deserialize(json: unknown, meta: RPCJsonSerializedMeta): unknown;
79
- deserialize(json: unknown, meta: RPCJsonSerializedMeta, maps: Segment[][], getBlob: (index: number) => Blob): unknown;
80
- }
81
-
82
- declare class RPCSerializer {
83
- #private;
84
- private readonly jsonSerializer;
85
- constructor(jsonSerializer?: RPCJsonSerializer);
86
- serialize(data: unknown): unknown;
87
- deserialize(data: unknown): unknown;
88
- }
89
-
90
- type HTTPMethod = 'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH';
91
- interface StandardRPCLinkCodecOptions<T extends ClientContext> {
92
- /**
93
- * Base url for all requests.
94
- */
95
- url: Value<string | URL, [
96
- options: ClientOptionsOut<T>,
97
- path: readonly string[],
98
- input: unknown
99
- ]>;
100
- /**
101
- * The maximum length of the URL.
102
- *
103
- * @default 2083
104
- */
105
- maxUrlLength?: Value<number, [
106
- options: ClientOptionsOut<T>,
107
- path: readonly string[],
108
- input: unknown
109
- ]>;
110
- /**
111
- * The method used to make the request.
112
- *
113
- * @default 'POST'
114
- */
115
- method?: Value<HTTPMethod, [
116
- options: ClientOptionsOut<T>,
117
- path: readonly string[],
118
- input: unknown
119
- ]>;
120
- /**
121
- * The method to use when the payload cannot safely pass to the server with method return from method function.
122
- * GET is not allowed, it's very dangerous.
123
- *
124
- * @default 'POST'
125
- */
126
- fallbackMethod?: Exclude<HTTPMethod, 'GET'>;
127
- /**
128
- * Inject headers to the request.
129
- */
130
- headers?: Value<StandardHeaders, [
131
- options: ClientOptionsOut<T>,
132
- path: readonly string[],
133
- input: unknown
134
- ]>;
135
- }
136
- declare class StandardRPCLinkCodec<T extends ClientContext> implements StandardLinkCodec<T> {
137
- private readonly serializer;
138
- private readonly baseUrl;
139
- private readonly maxUrlLength;
140
- private readonly fallbackMethod;
141
- private readonly expectedMethod;
142
- private readonly headers;
143
- constructor(serializer: RPCSerializer, options: StandardRPCLinkCodecOptions<T>);
144
- encode(path: readonly string[], input: unknown, options: ClientOptionsOut<any>): Promise<StandardRequest>;
145
- decode(response: StandardLazyResponse): Promise<unknown>;
146
- }
147
-
148
- export { InvalidEventIteratorRetryResponse, type RPCJsonSerialized, type RPCJsonSerializedMeta, RPCJsonSerializer, RPCSerializer, StandardLink, type StandardLinkClient, type StandardLinkCodec, type StandardLinkOptions, StandardRPCLinkCodec, type StandardRPCLinkCodecOptions };
11
+ export { getMalformedResponseErrorCode, toHttpPath, toStandardHeaders };
@@ -1,4 +1,5 @@
1
- export { I as InvalidEventIteratorRetryResponse, R as RPCJsonSerializer, b as RPCSerializer, S as StandardLink, a as StandardRPCLinkCodec } from '../../shared/client.Df5pd75N.mjs';
1
+ export { C as CompositeStandardLinkPlugin, a as STANDARD_RPC_JSON_SERIALIZER_BUILT_IN_TYPES, S as StandardLink, b as StandardRPCJsonSerializer, c as StandardRPCLink, d as StandardRPCLinkCodec, e as StandardRPCSerializer, g as getMalformedResponseErrorCode, t as toHttpPath, f as toStandardHeaders } from '../../shared/client.BDTnZdQC.mjs';
2
2
  import '@orpc/shared';
3
- import '../../shared/client.XAn8cDTM.mjs';
4
3
  import '@orpc/standard-server';
4
+ import '../../shared/client.B7f1cdI2.mjs';
5
+ import '@orpc/standard-server-fetch';
@@ -0,0 +1,29 @@
1
+ import { StandardRequest, StandardLazyResponse } from '@orpc/standard-server';
2
+ import { b as ClientContext, c as ClientOptions } from '../../shared/client.BOYsZIRq.mjs';
3
+ import { f as StandardLinkClient } from '../../shared/client.Bwgm6dgk.mjs';
4
+ import { f as StandardRPCLinkOptions, g as StandardRPCLink } from '../../shared/client._Y_enhib.mjs';
5
+ import '@orpc/shared';
6
+
7
+ interface LinkWebsocketClientOptions {
8
+ websocket: Pick<WebSocket, 'addEventListener' | 'send' | 'readyState'>;
9
+ }
10
+ declare class LinkWebsocketClient<T extends ClientContext> implements StandardLinkClient<T> {
11
+ private readonly peer;
12
+ constructor(options: LinkWebsocketClientOptions);
13
+ call(request: StandardRequest, _options: ClientOptions<T>, _path: readonly string[], _input: unknown): Promise<StandardLazyResponse>;
14
+ }
15
+
16
+ interface RPCLinkOptions<T extends ClientContext> extends Omit<StandardRPCLinkOptions<T>, 'url' | 'method' | 'fallbackMethod' | 'maxUrlLength'>, LinkWebsocketClientOptions {
17
+ }
18
+ /**
19
+ * The RPC Link communicates with the server using the RPC protocol over WebSocket.
20
+ *
21
+ * @see {@link https://orpc.unnoq.com/docs/client/rpc-link RPC Link Docs}
22
+ * @see {@link https://orpc.unnoq.com/docs/adapters/websocket WebSocket Adapter Docs}
23
+ */
24
+ declare class RPCLink<T extends ClientContext> extends StandardRPCLink<T> {
25
+ constructor(options: RPCLinkOptions<T>);
26
+ }
27
+
28
+ export { LinkWebsocketClient, RPCLink };
29
+ export type { LinkWebsocketClientOptions, RPCLinkOptions };
@@ -0,0 +1,29 @@
1
+ import { StandardRequest, StandardLazyResponse } from '@orpc/standard-server';
2
+ import { b as ClientContext, c as ClientOptions } from '../../shared/client.BOYsZIRq.js';
3
+ import { f as StandardLinkClient } from '../../shared/client.BG98rYdO.js';
4
+ import { f as StandardRPCLinkOptions, g as StandardRPCLink } from '../../shared/client.CVVVqf1Y.js';
5
+ import '@orpc/shared';
6
+
7
+ interface LinkWebsocketClientOptions {
8
+ websocket: Pick<WebSocket, 'addEventListener' | 'send' | 'readyState'>;
9
+ }
10
+ declare class LinkWebsocketClient<T extends ClientContext> implements StandardLinkClient<T> {
11
+ private readonly peer;
12
+ constructor(options: LinkWebsocketClientOptions);
13
+ call(request: StandardRequest, _options: ClientOptions<T>, _path: readonly string[], _input: unknown): Promise<StandardLazyResponse>;
14
+ }
15
+
16
+ interface RPCLinkOptions<T extends ClientContext> extends Omit<StandardRPCLinkOptions<T>, 'url' | 'method' | 'fallbackMethod' | 'maxUrlLength'>, LinkWebsocketClientOptions {
17
+ }
18
+ /**
19
+ * The RPC Link communicates with the server using the RPC protocol over WebSocket.
20
+ *
21
+ * @see {@link https://orpc.unnoq.com/docs/client/rpc-link RPC Link Docs}
22
+ * @see {@link https://orpc.unnoq.com/docs/adapters/websocket WebSocket Adapter Docs}
23
+ */
24
+ declare class RPCLink<T extends ClientContext> extends StandardRPCLink<T> {
25
+ constructor(options: RPCLinkOptions<T>);
26
+ }
27
+
28
+ export { LinkWebsocketClient, RPCLink };
29
+ export type { LinkWebsocketClientOptions, RPCLinkOptions };
@@ -0,0 +1,46 @@
1
+ import { readAsBuffer } from '@orpc/shared';
2
+ import { ClientPeer } from '@orpc/standard-server-peer';
3
+ import { c as StandardRPCLink } from '../../shared/client.BDTnZdQC.mjs';
4
+ import '@orpc/standard-server';
5
+ import '../../shared/client.B7f1cdI2.mjs';
6
+ import '@orpc/standard-server-fetch';
7
+
8
+ const WEBSOCKET_CONNECTING = 0;
9
+ class LinkWebsocketClient {
10
+ peer;
11
+ constructor(options) {
12
+ const untilOpen = new Promise((resolve) => {
13
+ if (options.websocket.readyState === WEBSOCKET_CONNECTING) {
14
+ options.websocket.addEventListener("open", () => {
15
+ resolve();
16
+ }, { once: true });
17
+ } else {
18
+ resolve();
19
+ }
20
+ });
21
+ this.peer = new ClientPeer(async (message) => {
22
+ await untilOpen;
23
+ return options.websocket.send(message);
24
+ });
25
+ options.websocket.addEventListener("message", async (event) => {
26
+ const message = event.data instanceof Blob ? await readAsBuffer(event.data) : event.data;
27
+ this.peer.message(message);
28
+ });
29
+ options.websocket.addEventListener("close", () => {
30
+ this.peer.close();
31
+ });
32
+ }
33
+ async call(request, _options, _path, _input) {
34
+ const response = await this.peer.request(request);
35
+ return { ...response, body: () => Promise.resolve(response.body) };
36
+ }
37
+ }
38
+
39
+ class RPCLink extends StandardRPCLink {
40
+ constructor(options) {
41
+ const linkClient = new LinkWebsocketClient(options);
42
+ super(linkClient, { ...options, url: "orpc://localhost" });
43
+ }
44
+ }
45
+
46
+ export { LinkWebsocketClient, RPCLink };
package/dist/index.d.mts CHANGED
@@ -1,25 +1,21 @@
1
- import { N as NestedClient, b as ClientLink, I as InferClientContext, C as ClientContext, a as ClientOptionsOut, c as ClientPromiseResult } from './shared/client.D_CzLDyB.mjs';
2
- export { g as Client, e as ClientOptions, f as ClientRest, E as EventIteratorReconnectOptions, d as createAutoRetryEventIterator, m as mapEventIterator } from './shared/client.D_CzLDyB.mjs';
3
- import { Promisable, MaybeOptionalOptions } 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';
4
5
  export { ErrorEvent } from '@orpc/standard-server';
5
6
 
6
7
  interface createORPCClientOptions {
7
8
  /**
8
9
  * Use as base path for all procedure, useful when you only want to call a subset of the procedure.
9
10
  */
10
- path?: string[];
11
+ path?: readonly string[];
11
12
  }
12
- declare function createORPCClient<T extends NestedClient<any>>(link: ClientLink<InferClientContext<T>>, options?: createORPCClientOptions): T;
13
-
14
13
  /**
15
- * DynamicLink provides a way to dynamically resolve and delegate calls to other ClientLinks
16
- * based on the request path, input, and context.
14
+ * Create a oRPC client-side client from a link.
15
+ *
16
+ * @see {@link https://orpc.unnoq.com/docs/client/client-side Client-side Client Docs}
17
17
  */
18
- declare class DynamicLink<TClientContext extends ClientContext> implements ClientLink<TClientContext> {
19
- private readonly linkResolver;
20
- constructor(linkResolver: (options: ClientOptionsOut<TClientContext>, path: readonly string[], input: unknown) => Promisable<ClientLink<TClientContext>>);
21
- call(path: readonly string[], input: unknown, options: ClientOptionsOut<TClientContext>): Promise<unknown>;
22
- }
18
+ declare function createORPCClient<T extends NestedClient<any>>(link: ClientLink<InferClientContext<T>>, options?: createORPCClientOptions): T;
23
19
 
24
20
  declare const COMMON_ORPC_ERROR_DEFS: {
25
21
  readonly BAD_REQUEST: {
@@ -117,39 +113,118 @@ declare class ORPCError<TCode extends ORPCErrorCode, TData> extends Error {
117
113
  readonly code: TCode;
118
114
  readonly status: number;
119
115
  readonly data: TData;
120
- constructor(code: TCode, ...[options]: MaybeOptionalOptions<ORPCErrorOptions<TData>>);
116
+ constructor(code: TCode, ...rest: MaybeOptionalOptions<ORPCErrorOptions<TData>>);
121
117
  toJSON(): ORPCErrorJSON<TCode, TData>;
122
- static fromJSON<TCode extends ORPCErrorCode, TData>(json: ORPCErrorJSON<TCode, TData>, options?: ErrorOptions): ORPCError<TCode, TData>;
123
- static isValidJSON(json: unknown): json is ORPCErrorJSON<ORPCErrorCode, unknown>;
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;
124
131
  }
125
132
  type ORPCErrorJSON<TCode extends string, TData> = Pick<ORPCError<TCode, TData>, 'defined' | 'code' | 'status' | 'message' | 'data'>;
126
133
  declare function isDefinedError<T>(error: T): error is Extract<T, ORPCError<any, any>>;
127
134
  declare function toORPCError(error: unknown): ORPCError<any, any>;
135
+ declare function isORPCErrorStatus(status: number): boolean;
136
+ declare function isORPCErrorJson(json: unknown): json is ORPCErrorJSON<ORPCErrorCode, unknown>;
137
+ declare function createORPCErrorFromJson<TCode extends ORPCErrorCode, TData>(json: ORPCErrorJSON<TCode, TData>, options?: ErrorOptions): ORPCError<TCode, TData>;
128
138
 
129
- type ConnectionStatus = 'reconnecting' | 'connected' | 'closed';
130
- interface EventIteratorState {
131
- status: ConnectionStatus;
132
- listeners: Array<(newStatus: ConnectionStatus) => void>;
133
- }
134
- declare function registerEventIteratorState(iterator: AsyncIteratorObject<unknown, unknown, void>, state: EventIteratorState): void;
135
- declare function updateEventIteratorStatus(state: EventIteratorState, status: ConnectionStatus): void;
136
- declare function onEventIteratorStatusChange(iterator: AsyncIteratorObject<unknown, unknown, void>, callback: (status: ConnectionStatus) => void, options?: {
137
- notifyImmediately?: boolean;
138
- }): () => void;
139
-
140
- type SafeResult<TOutput, TError extends Error> = [error: null, data: TOutput, isDefined: false] & {
139
+ type SafeResult<TOutput, TError> = [error: null, data: TOutput, isDefined: false, isSuccess: true] & {
141
140
  error: null;
142
141
  data: TOutput;
143
142
  isDefined: false;
144
- } | [error: Exclude<TError, ORPCError<any, any>>, data: undefined, isDefined: false] & {
143
+ isSuccess: true;
144
+ } | [error: Exclude<TError, ORPCError<any, any>>, data: undefined, isDefined: false, isSuccess: false] & {
145
145
  error: Exclude<TError, ORPCError<any, any>>;
146
146
  data: undefined;
147
147
  isDefined: false;
148
- } | [error: Extract<TError, ORPCError<any, any>>, data: undefined, isDefined: true] & {
148
+ isSuccess: false;
149
+ } | [error: Extract<TError, ORPCError<any, any>>, data: undefined, isDefined: true, isSuccess: false] & {
149
150
  error: Extract<TError, ORPCError<any, any>>;
150
151
  data: undefined;
151
152
  isDefined: true;
153
+ isSuccess: false;
152
154
  };
153
- declare function safe<TOutput, TError extends Error>(promise: ClientPromiseResult<TOutput, TError>): Promise<SafeResult<TOutput, TError>>;
155
+ /**
156
+ * Works like try/catch, but can infer error types.
157
+ *
158
+ * @info support both tuple `[error, data, isDefined, isSuccess]` and object `{ error, data, isDefined, isSuccess }` styles.
159
+ * @see {@link https://orpc.unnoq.com/docs/client/error-handling Client Error Handling Docs}
160
+ */
161
+ declare function safe<TOutput, TError = ThrowableError>(promise: ClientPromiseResult<TOutput, TError>): Promise<SafeResult<TOutput, TError>>;
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.d4f9056";
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>;
154
228
 
155
- export { COMMON_ORPC_ERROR_DEFS, ClientContext, ClientLink, ClientOptionsOut, ClientPromiseResult, type CommonORPCErrorCode, type ConnectionStatus, DynamicLink, type EventIteratorState, InferClientContext, NestedClient, ORPCError, type ORPCErrorCode, type ORPCErrorJSON, type ORPCErrorOptions, type SafeResult, createORPCClient, type createORPCClientOptions, fallbackORPCErrorMessage, fallbackORPCErrorStatus, isDefinedError, onEventIteratorStatusChange, registerEventIteratorState, safe, toORPCError, updateEventIteratorStatus };
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,25 +1,21 @@
1
- import { N as NestedClient, b as ClientLink, I as InferClientContext, C as ClientContext, a as ClientOptionsOut, c as ClientPromiseResult } from './shared/client.D_CzLDyB.js';
2
- export { g as Client, e as ClientOptions, f as ClientRest, E as EventIteratorReconnectOptions, d as createAutoRetryEventIterator, m as mapEventIterator } from './shared/client.D_CzLDyB.js';
3
- import { Promisable, MaybeOptionalOptions } 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';
4
5
  export { ErrorEvent } from '@orpc/standard-server';
5
6
 
6
7
  interface createORPCClientOptions {
7
8
  /**
8
9
  * Use as base path for all procedure, useful when you only want to call a subset of the procedure.
9
10
  */
10
- path?: string[];
11
+ path?: readonly string[];
11
12
  }
12
- declare function createORPCClient<T extends NestedClient<any>>(link: ClientLink<InferClientContext<T>>, options?: createORPCClientOptions): T;
13
-
14
13
  /**
15
- * DynamicLink provides a way to dynamically resolve and delegate calls to other ClientLinks
16
- * based on the request path, input, and context.
14
+ * Create a oRPC client-side client from a link.
15
+ *
16
+ * @see {@link https://orpc.unnoq.com/docs/client/client-side Client-side Client Docs}
17
17
  */
18
- declare class DynamicLink<TClientContext extends ClientContext> implements ClientLink<TClientContext> {
19
- private readonly linkResolver;
20
- constructor(linkResolver: (options: ClientOptionsOut<TClientContext>, path: readonly string[], input: unknown) => Promisable<ClientLink<TClientContext>>);
21
- call(path: readonly string[], input: unknown, options: ClientOptionsOut<TClientContext>): Promise<unknown>;
22
- }
18
+ declare function createORPCClient<T extends NestedClient<any>>(link: ClientLink<InferClientContext<T>>, options?: createORPCClientOptions): T;
23
19
 
24
20
  declare const COMMON_ORPC_ERROR_DEFS: {
25
21
  readonly BAD_REQUEST: {
@@ -117,39 +113,118 @@ declare class ORPCError<TCode extends ORPCErrorCode, TData> extends Error {
117
113
  readonly code: TCode;
118
114
  readonly status: number;
119
115
  readonly data: TData;
120
- constructor(code: TCode, ...[options]: MaybeOptionalOptions<ORPCErrorOptions<TData>>);
116
+ constructor(code: TCode, ...rest: MaybeOptionalOptions<ORPCErrorOptions<TData>>);
121
117
  toJSON(): ORPCErrorJSON<TCode, TData>;
122
- static fromJSON<TCode extends ORPCErrorCode, TData>(json: ORPCErrorJSON<TCode, TData>, options?: ErrorOptions): ORPCError<TCode, TData>;
123
- static isValidJSON(json: unknown): json is ORPCErrorJSON<ORPCErrorCode, unknown>;
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;
124
131
  }
125
132
  type ORPCErrorJSON<TCode extends string, TData> = Pick<ORPCError<TCode, TData>, 'defined' | 'code' | 'status' | 'message' | 'data'>;
126
133
  declare function isDefinedError<T>(error: T): error is Extract<T, ORPCError<any, any>>;
127
134
  declare function toORPCError(error: unknown): ORPCError<any, any>;
135
+ declare function isORPCErrorStatus(status: number): boolean;
136
+ declare function isORPCErrorJson(json: unknown): json is ORPCErrorJSON<ORPCErrorCode, unknown>;
137
+ declare function createORPCErrorFromJson<TCode extends ORPCErrorCode, TData>(json: ORPCErrorJSON<TCode, TData>, options?: ErrorOptions): ORPCError<TCode, TData>;
128
138
 
129
- type ConnectionStatus = 'reconnecting' | 'connected' | 'closed';
130
- interface EventIteratorState {
131
- status: ConnectionStatus;
132
- listeners: Array<(newStatus: ConnectionStatus) => void>;
133
- }
134
- declare function registerEventIteratorState(iterator: AsyncIteratorObject<unknown, unknown, void>, state: EventIteratorState): void;
135
- declare function updateEventIteratorStatus(state: EventIteratorState, status: ConnectionStatus): void;
136
- declare function onEventIteratorStatusChange(iterator: AsyncIteratorObject<unknown, unknown, void>, callback: (status: ConnectionStatus) => void, options?: {
137
- notifyImmediately?: boolean;
138
- }): () => void;
139
-
140
- type SafeResult<TOutput, TError extends Error> = [error: null, data: TOutput, isDefined: false] & {
139
+ type SafeResult<TOutput, TError> = [error: null, data: TOutput, isDefined: false, isSuccess: true] & {
141
140
  error: null;
142
141
  data: TOutput;
143
142
  isDefined: false;
144
- } | [error: Exclude<TError, ORPCError<any, any>>, data: undefined, isDefined: false] & {
143
+ isSuccess: true;
144
+ } | [error: Exclude<TError, ORPCError<any, any>>, data: undefined, isDefined: false, isSuccess: false] & {
145
145
  error: Exclude<TError, ORPCError<any, any>>;
146
146
  data: undefined;
147
147
  isDefined: false;
148
- } | [error: Extract<TError, ORPCError<any, any>>, data: undefined, isDefined: true] & {
148
+ isSuccess: false;
149
+ } | [error: Extract<TError, ORPCError<any, any>>, data: undefined, isDefined: true, isSuccess: false] & {
149
150
  error: Extract<TError, ORPCError<any, any>>;
150
151
  data: undefined;
151
152
  isDefined: true;
153
+ isSuccess: false;
152
154
  };
153
- declare function safe<TOutput, TError extends Error>(promise: ClientPromiseResult<TOutput, TError>): Promise<SafeResult<TOutput, TError>>;
155
+ /**
156
+ * Works like try/catch, but can infer error types.
157
+ *
158
+ * @info support both tuple `[error, data, isDefined, isSuccess]` and object `{ error, data, isDefined, isSuccess }` styles.
159
+ * @see {@link https://orpc.unnoq.com/docs/client/error-handling Client Error Handling Docs}
160
+ */
161
+ declare function safe<TOutput, TError = ThrowableError>(promise: ClientPromiseResult<TOutput, TError>): Promise<SafeResult<TOutput, TError>>;
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.d4f9056";
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>;
154
228
 
155
- export { COMMON_ORPC_ERROR_DEFS, ClientContext, ClientLink, ClientOptionsOut, ClientPromiseResult, type CommonORPCErrorCode, type ConnectionStatus, DynamicLink, type EventIteratorState, InferClientContext, NestedClient, ORPCError, type ORPCErrorCode, type ORPCErrorJSON, type ORPCErrorOptions, type SafeResult, createORPCClient, type createORPCClientOptions, fallbackORPCErrorMessage, fallbackORPCErrorStatus, isDefinedError, onEventIteratorStatusChange, registerEventIteratorState, safe, toORPCError, updateEventIteratorStatus };
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 };