@orpc/client 0.0.0-next.eae6003 → 0.0.0-next.eaec0b2

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 (31) hide show
  1. package/README.md +19 -16
  2. package/dist/adapters/fetch/index.d.mts +25 -12
  3. package/dist/adapters/fetch/index.d.ts +25 -12
  4. package/dist/adapters/fetch/index.mjs +25 -8
  5. package/dist/adapters/message-port/index.d.mts +80 -0
  6. package/dist/adapters/message-port/index.d.ts +80 -0
  7. package/dist/adapters/message-port/index.mjs +87 -0
  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 +4 -2
  11. package/dist/adapters/websocket/index.d.mts +14 -14
  12. package/dist/adapters/websocket/index.d.ts +14 -14
  13. package/dist/adapters/websocket/index.mjs +27 -11
  14. package/dist/index.d.mts +88 -27
  15. package/dist/index.d.ts +88 -27
  16. package/dist/index.mjs +55 -8
  17. package/dist/plugins/index.d.mts +107 -20
  18. package/dist/plugins/index.d.ts +107 -20
  19. package/dist/plugins/index.mjs +221 -27
  20. package/dist/shared/{client.7ZYxJok_.d.ts → client.2jUAqzYU.d.ts} +4 -5
  21. package/dist/shared/{client.B2432-Lu.d.ts → client.B3pNRBih.d.ts} +7 -7
  22. package/dist/shared/{client.ClwIM_ku.d.mts → client.BFAVy68H.d.mts} +7 -7
  23. package/dist/shared/client.BLtwTQUg.mjs +40 -0
  24. package/dist/shared/{client.ds1abV85.d.mts → client.CpCa3si8.d.mts} +4 -5
  25. package/dist/shared/{client.CRWEpqLB.mjs → client.D9OcfSSt.mjs} +37 -41
  26. package/dist/shared/{client.DpICn1BD.mjs → client.DtEZLmWK.mjs} +63 -20
  27. package/dist/shared/client.i2uoJbEp.d.mts +83 -0
  28. package/dist/shared/client.i2uoJbEp.d.ts +83 -0
  29. package/package.json +13 -9
  30. package/dist/shared/client.4TS_0JaO.d.mts +0 -29
  31. package/dist/shared/client.4TS_0JaO.d.ts +0 -29
@@ -1,29 +1,29 @@
1
1
  import { StandardRequest, StandardLazyResponse } from '@orpc/standard-server';
2
- import { a as ClientContext, b as ClientOptions } from '../../shared/client.4TS_0JaO.js';
3
- import { f as StandardLinkClient } from '../../shared/client.7ZYxJok_.js';
4
- import { f as StandardRPCLinkOptions, g as StandardRPCLink } from '../../shared/client.B2432-Lu.js';
2
+ import { b as ClientContext, c as ClientOptions } from '../../shared/client.i2uoJbEp.js';
3
+ import { f as StandardLinkClient } from '../../shared/client.2jUAqzYU.js';
4
+ import { f as StandardRPCLinkOptions, g as StandardRPCLink } from '../../shared/client.B3pNRBih.js';
5
5
  import '@orpc/shared';
6
6
 
7
- interface experimental_LinkWebsocketClientOptions {
8
- websocket: Pick<WebSocket, 'addEventListener' | 'send'>;
7
+ interface LinkWebsocketClientOptions {
8
+ websocket: Pick<WebSocket, 'addEventListener' | 'send' | 'readyState'>;
9
9
  }
10
- declare class experimental_LinkWebsocketClient<T extends ClientContext> implements StandardLinkClient<T> {
10
+ declare class LinkWebsocketClient<T extends ClientContext> implements StandardLinkClient<T> {
11
11
  private readonly peer;
12
- constructor(options: experimental_LinkWebsocketClientOptions);
12
+ constructor(options: LinkWebsocketClientOptions);
13
13
  call(request: StandardRequest, _options: ClientOptions<T>, _path: readonly string[], _input: unknown): Promise<StandardLazyResponse>;
14
14
  }
15
15
 
16
- interface experimental_RPCLinkOptions<T extends ClientContext> extends Omit<StandardRPCLinkOptions<T>, 'url' | 'headers' | 'method' | 'fallbackMethod' | 'maxUrlLength'>, experimental_LinkWebsocketClientOptions {
16
+ interface RPCLinkOptions<T extends ClientContext> extends Omit<StandardRPCLinkOptions<T>, 'url' | 'method' | 'fallbackMethod' | 'maxUrlLength'>, LinkWebsocketClientOptions {
17
17
  }
18
18
  /**
19
19
  * The RPC Link communicates with the server using the RPC protocol over WebSocket.
20
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}
21
+ * @see {@link https://orpc.dev/docs/client/rpc-link RPC Link Docs}
22
+ * @see {@link https://orpc.dev/docs/adapters/websocket WebSocket Adapter Docs}
23
23
  */
24
- declare class experimental_RPCLink<T extends ClientContext> extends StandardRPCLink<T> {
25
- constructor(options: experimental_RPCLinkOptions<T>);
24
+ declare class RPCLink<T extends ClientContext> extends StandardRPCLink<T> {
25
+ constructor(options: RPCLinkOptions<T>);
26
26
  }
27
27
 
28
- export { experimental_LinkWebsocketClient, experimental_RPCLink };
29
- export type { experimental_LinkWebsocketClientOptions, experimental_RPCLinkOptions };
28
+ export { LinkWebsocketClient, RPCLink };
29
+ export type { LinkWebsocketClientOptions, RPCLinkOptions };
@@ -1,15 +1,31 @@
1
+ import { readAsBuffer } from '@orpc/shared';
1
2
  import { ClientPeer } from '@orpc/standard-server-peer';
2
- import '@orpc/shared';
3
- import { c as StandardRPCLink } from '../../shared/client.DpICn1BD.mjs';
3
+ import { c as StandardRPCLink } from '../../shared/client.DtEZLmWK.mjs';
4
4
  import '@orpc/standard-server';
5
- import '../../shared/client.CRWEpqLB.mjs';
5
+ import '../../shared/client.D9OcfSSt.mjs';
6
+ import '@orpc/standard-server-fetch';
7
+ import '../../shared/client.BLtwTQUg.mjs';
6
8
 
7
- class experimental_LinkWebsocketClient {
9
+ const WEBSOCKET_CONNECTING = 0;
10
+ class LinkWebsocketClient {
8
11
  peer;
9
12
  constructor(options) {
10
- this.peer = new ClientPeer(options.websocket.send.bind(options.websocket));
11
- options.websocket.addEventListener("message", (event) => {
12
- this.peer.message(event.data);
13
+ const untilOpen = new Promise((resolve) => {
14
+ if (options.websocket.readyState === WEBSOCKET_CONNECTING) {
15
+ options.websocket.addEventListener("open", () => {
16
+ resolve();
17
+ }, { once: true });
18
+ } else {
19
+ resolve();
20
+ }
21
+ });
22
+ this.peer = new ClientPeer(async (message) => {
23
+ await untilOpen;
24
+ return options.websocket.send(message);
25
+ });
26
+ options.websocket.addEventListener("message", async (event) => {
27
+ const message = event.data instanceof Blob ? await readAsBuffer(event.data) : event.data;
28
+ this.peer.message(message);
13
29
  });
14
30
  options.websocket.addEventListener("close", () => {
15
31
  this.peer.close();
@@ -21,11 +37,11 @@ class experimental_LinkWebsocketClient {
21
37
  }
22
38
  }
23
39
 
24
- class experimental_RPCLink extends StandardRPCLink {
40
+ class RPCLink extends StandardRPCLink {
25
41
  constructor(options) {
26
- const linkClient = new experimental_LinkWebsocketClient(options);
27
- super(linkClient, { ...options, url: "orpc:/" });
42
+ const linkClient = new LinkWebsocketClient(options);
43
+ super(linkClient, { ...options, url: "http://orpc" });
28
44
  }
29
45
  }
30
46
 
31
- export { experimental_LinkWebsocketClient, experimental_RPCLink };
47
+ export { LinkWebsocketClient, RPCLink };
package/dist/index.d.mts CHANGED
@@ -1,34 +1,22 @@
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.i2uoJbEp.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.i2uoJbEp.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.
15
15
  *
16
- * @see {@link https://orpc.unnoq.com/docs/client/client-side Client-side Client Docs}
16
+ * @see {@link https://orpc.dev/docs/client/client-side Client-side Client Docs}
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;
@@ -160,10 +156,75 @@ type SafeResult<TOutput, TError> = [error: null, data: TOutput, isDefined: false
160
156
  * Works like try/catch, but can infer error types.
161
157
  *
162
158
  * @info support both tuple `[error, data, isDefined, isSuccess]` and object `{ error, data, isDefined, isSuccess }` styles.
163
- * @see {@link https://orpc.unnoq.com/docs/client/error-handling Client Error Handling Docs}
159
+ * @see {@link https://orpc.dev/docs/client/error-handling Client Error Handling Docs}
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.dev/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.eaec0b2";
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.dev/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,34 +1,22 @@
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.i2uoJbEp.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.i2uoJbEp.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.
15
15
  *
16
- * @see {@link https://orpc.unnoq.com/docs/client/client-side Client-side Client Docs}
16
+ * @see {@link https://orpc.dev/docs/client/client-side Client-side Client Docs}
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;
@@ -160,10 +156,75 @@ type SafeResult<TOutput, TError> = [error: null, data: TOutput, isDefined: false
160
156
  * Works like try/catch, but can infer error types.
161
157
  *
162
158
  * @info support both tuple `[error, data, isDefined, isSuccess]` and object `{ error, data, isDefined, isSuccess }` styles.
163
- * @see {@link https://orpc.unnoq.com/docs/client/error-handling Client Error Handling Docs}
159
+ * @see {@link https://orpc.dev/docs/client/error-handling Client Error Handling Docs}
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.dev/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.eaec0b2";
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.dev/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,8 @@
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.D9OcfSSt.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, t as toORPCError } from './shared/client.D9OcfSSt.mjs';
5
+ export { m as mapEventIterator } from './shared/client.BLtwTQUg.mjs';
4
6
  export { ErrorEvent } from '@orpc/standard-server';
5
7
 
6
8
  async function safe(promise) {
@@ -27,13 +29,42 @@ async function safe(promise) {
27
29
  function resolveFriendlyClientOptions(options) {
28
30
  return {
29
31
  ...options,
30
- context: options?.context ?? {}
32
+ context: options.context ?? {}
31
33
  // Context only optional if all fields are optional
32
34
  };
33
35
  }
36
+ function consumeEventIterator(iterator, options) {
37
+ void (async () => {
38
+ let onFinishState;
39
+ try {
40
+ const resolvedIterator = await iterator;
41
+ while (true) {
42
+ const { done, value } = await resolvedIterator.next();
43
+ if (done) {
44
+ const realValue = value;
45
+ onFinishState = [null, realValue, true];
46
+ options.onSuccess?.(realValue);
47
+ break;
48
+ }
49
+ options.onEvent(value);
50
+ }
51
+ } catch (error) {
52
+ onFinishState = [error, void 0, false];
53
+ if (!options.onError && !options.onFinish) {
54
+ throw error;
55
+ }
56
+ options.onError?.(error);
57
+ } finally {
58
+ options.onFinish?.(onFinishState);
59
+ }
60
+ })();
61
+ return async () => {
62
+ await (await iterator)?.return?.();
63
+ };
64
+ }
34
65
 
35
- function createORPCClient(link, options) {
36
- const path = options?.path ?? [];
66
+ function createORPCClient(link, options = {}) {
67
+ const path = options.path ?? [];
37
68
  const procedureClient = async (...[input, options2 = {}]) => {
38
69
  return await link.call(path, input, resolveFriendlyClientOptions(options2));
39
70
  };
@@ -48,7 +79,23 @@ function createORPCClient(link, options) {
48
79
  });
49
80
  }
50
81
  });
51
- return recursive;
82
+ return preventNativeAwait(recursive);
83
+ }
84
+
85
+ function createSafeClient(client) {
86
+ const proxy = new Proxy((...args) => safe(client(...args)), {
87
+ get(_, prop, receiver) {
88
+ const value = Reflect.get(client, prop, receiver);
89
+ if (typeof prop !== "string") {
90
+ return value;
91
+ }
92
+ if (!isTypescriptObject(value)) {
93
+ return value;
94
+ }
95
+ return createSafeClient(value);
96
+ }
97
+ });
98
+ return proxy;
52
99
  }
53
100
 
54
101
  class DynamicLink {
@@ -62,4 +109,4 @@ class DynamicLink {
62
109
  }
63
110
  }
64
111
 
65
- export { DynamicLink, createORPCClient, isDefinedError, resolveFriendlyClientOptions, safe };
112
+ export { DynamicLink, consumeEventIterator, createORPCClient, createSafeClient, isDefinedError, resolveFriendlyClientOptions, safe };