@orpc/client 2.0.0-beta.47 → 2.0.0-beta.48

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 (91) hide show
  1. package/README.md +2 -3
  2. package/dist/adapters/fetch/index.d.mts +2 -48
  3. package/dist/adapters/fetch/index.mjs +2 -77
  4. package/dist/adapters/fetch/rpc-link.d.mts +13 -0
  5. package/dist/adapters/fetch/rpc-link.mjs +10 -0
  6. package/dist/adapters/fetch/transport.d.mts +31 -0
  7. package/dist/adapters/fetch/transport.mjs +65 -0
  8. package/dist/adapters/message-port/index.d.mts +3 -80
  9. package/dist/adapters/message-port/index.mjs +3 -101
  10. package/dist/adapters/message-port/message-port.d.mts +29 -0
  11. package/dist/adapters/message-port/message-port.mjs +43 -0
  12. package/dist/adapters/message-port/rpc-link.d.mts +14 -0
  13. package/dist/adapters/message-port/rpc-link.mjs +10 -0
  14. package/dist/adapters/message-port/transport.d.mts +35 -0
  15. package/dist/adapters/message-port/transport.mjs +47 -0
  16. package/dist/adapters/standard/codec.d.mts +14 -0
  17. package/dist/adapters/standard/codec.mjs +1 -0
  18. package/dist/adapters/standard/index.d.mts +5 -60
  19. package/dist/adapters/standard/index.mjs +4 -6
  20. package/dist/adapters/standard/link.d.mts +40 -0
  21. package/dist/adapters/standard/link.mjs +79 -0
  22. package/dist/adapters/standard/plugin.d.mts +32 -0
  23. package/dist/adapters/standard/plugin.mjs +16 -0
  24. package/dist/adapters/standard/rpc-link-codec.d.mts +55 -0
  25. package/dist/adapters/standard/rpc-link-codec.mjs +104 -0
  26. package/dist/adapters/standard/transport.d.mts +14 -0
  27. package/dist/adapters/standard/transport.mjs +1 -0
  28. package/dist/adapters/websocket/index.d.mts +2 -136
  29. package/dist/adapters/websocket/index.mjs +2 -131
  30. package/dist/adapters/websocket/rpc-link.d.mts +13 -0
  31. package/dist/adapters/websocket/rpc-link.mjs +10 -0
  32. package/dist/adapters/websocket/transport.d.mts +119 -0
  33. package/dist/adapters/websocket/transport.mjs +123 -0
  34. package/dist/async-iterator-object.d.mts +7 -0
  35. package/dist/async-iterator-object.mjs +30 -0
  36. package/dist/client-safe.d.mts +16 -0
  37. package/dist/client-safe.mjs +23 -0
  38. package/dist/client.d.mts +51 -0
  39. package/dist/client.mjs +32 -0
  40. package/dist/consts.d.mts +10 -0
  41. package/dist/consts.mjs +10 -0
  42. package/dist/dynamic-link.d.mts +13 -0
  43. package/dist/dynamic-link.mjs +12 -0
  44. package/dist/error-utils.d.mts +24 -0
  45. package/dist/error-utils.mjs +44 -0
  46. package/dist/error.d.mts +138 -0
  47. package/dist/error.mjs +105 -0
  48. package/dist/index.d.mts +42 -137
  49. package/dist/index.mjs +18 -142
  50. package/dist/plugins/batch.d.mts +150 -0
  51. package/dist/plugins/batch.mjs +339 -0
  52. package/dist/plugins/cookie-jar.d.mts +82 -0
  53. package/dist/plugins/cookie-jar.mjs +229 -0
  54. package/dist/plugins/dedupe.d.mts +58 -0
  55. package/dist/plugins/dedupe.mjs +199 -0
  56. package/dist/plugins/index.d.mts +28 -420
  57. package/dist/plugins/index.mjs +17 -971
  58. package/dist/plugins/request-compression.d.mts +44 -0
  59. package/dist/plugins/request-compression.mjs +150 -0
  60. package/dist/plugins/response-compression.d.mts +28 -0
  61. package/dist/plugins/response-compression.mjs +78 -0
  62. package/dist/plugins/retry-after.d.mts +41 -0
  63. package/dist/plugins/retry-after.mjs +71 -0
  64. package/dist/plugins/retry.d.mts +82 -0
  65. package/dist/plugins/retry.mjs +127 -0
  66. package/dist/plugins/timeout.d.mts +25 -0
  67. package/dist/plugins/timeout.mjs +36 -0
  68. package/dist/rpc-json-serializer.d.mts +99 -0
  69. package/dist/rpc-json-serializer.mjs +365 -0
  70. package/dist/rpc-serializer.d.mts +32 -0
  71. package/dist/rpc-serializer.mjs +100 -0
  72. package/dist/types.d.mts +93 -0
  73. package/dist/types.mjs +1 -0
  74. package/dist/utils.d.mts +46 -0
  75. package/dist/utils.mjs +53 -0
  76. package/package.json +5 -5
  77. package/dist/adapters/fetch/index.d.ts +0 -48
  78. package/dist/adapters/message-port/index.d.ts +0 -80
  79. package/dist/adapters/standard/index.d.ts +0 -60
  80. package/dist/adapters/websocket/index.d.ts +0 -136
  81. package/dist/index.d.ts +0 -144
  82. package/dist/plugins/index.d.ts +0 -420
  83. package/dist/shared/client.BoHJeq15.d.mts +0 -233
  84. package/dist/shared/client.BoHJeq15.d.ts +0 -233
  85. package/dist/shared/client.CKQeJJ2U.mjs +0 -172
  86. package/dist/shared/client.DqIWeNhQ.d.mts +0 -131
  87. package/dist/shared/client.DqIWeNhQ.d.ts +0 -131
  88. package/dist/shared/client.JBJwBhR8.d.ts +0 -90
  89. package/dist/shared/client.LF04eOvL.mjs +0 -115
  90. package/dist/shared/client._wG5INmC.mjs +0 -505
  91. package/dist/shared/client.euYjjcFz.d.mts +0 -90
@@ -1,131 +1,2 @@
1
- import { runWithSignal, AbortError, sleep, promiseWithResolvers, sequential, loadBytes, toStringOrBytes } from '@orpc/shared';
2
- import { ClientPeer, encodePeerMessage, decodePeerMessage, isServerPeerSendMessage } from '@standard-server/peer';
3
- import { S as StandardLink, R as RPCLinkCodec } from '../../shared/client.CKQeJJ2U.mjs';
4
- import '@standard-server/core';
5
- import '@standard-server/fetch';
6
- import '../../shared/client.LF04eOvL.mjs';
7
- import '../../shared/client._wG5INmC.mjs';
8
-
9
- const WEBSOCKET_CONNECTING = 0;
10
- const WEBSOCKET_OPEN = 1;
11
- class WebSocketLinkTransport {
12
- connect;
13
- reconnectEnabled;
14
- reconnectDelay;
15
- reconnectMaxAttempt;
16
- reconnectMaxTotalAttempt;
17
- reconnectOnCloseEnabled;
18
- reconnectOnCloseDelay;
19
- encodePeerMessageOptions;
20
- decodePeerMessageOptions;
21
- constructor(options) {
22
- this.connect = options.connect;
23
- this.reconnectEnabled = options.reconnect?.enabled ?? false;
24
- this.reconnectDelay = options.reconnect?.delay ?? ((info) => info.attempt === 1 ? 0 : 2e3);
25
- this.reconnectMaxAttempt = options.reconnect?.maxAttempt ?? Infinity;
26
- this.reconnectMaxTotalAttempt = options.reconnect?.maxTotalAttempt ?? Infinity;
27
- this.reconnectOnCloseEnabled = this.reconnectEnabled && (options.reconnect?.onClose?.enabled ?? false);
28
- this.reconnectOnCloseDelay = options.reconnect?.onClose?.delay ?? 0;
29
- this.encodePeerMessageOptions = options.encodePeerMessage;
30
- this.decodePeerMessageOptions = options.decodePeerMessage;
31
- if (options.connectOnInit) {
32
- this.getConnectedPeer().catch(() => {
33
- });
34
- }
35
- }
36
- async send(standardRequest, _path, _options) {
37
- const peer = await runWithSignal(
38
- standardRequest.signal,
39
- () => this.getConnectedPeer()
40
- );
41
- return peer.request(standardRequest);
42
- }
43
- totalAttempt = 0;
44
- attempt = 0;
45
- current;
46
- async getConnectedPeer() {
47
- const current = this.current;
48
- const resolved = await current;
49
- if (resolved && (!this.reconnectEnabled || resolved.websocket.readyState === WEBSOCKET_OPEN)) {
50
- return resolved.peer;
51
- }
52
- if (current !== this.current) {
53
- return this.getConnectedPeer();
54
- }
55
- if (this.totalAttempt >= this.reconnectMaxTotalAttempt) {
56
- throw new AbortError(`WebSocket reconnect stopped after ${this.totalAttempt} total attempt(s)`);
57
- }
58
- this.current = (async () => {
59
- this.totalAttempt += 1;
60
- this.attempt += 1;
61
- const info = { totalAttempt: this.totalAttempt, attempt: this.attempt };
62
- await sleep(this.reconnectDelay(info));
63
- const websocket = await this.connect(info);
64
- if (websocket.readyState !== WEBSOCKET_CONNECTING && websocket.readyState !== WEBSOCKET_OPEN) {
65
- throw new AbortError("WebSocket is already closing or closed");
66
- }
67
- let closeReason;
68
- const peer = new ClientPeer(async (message) => {
69
- if (closeReason) {
70
- throw closeReason;
71
- }
72
- const encoded = await encodePeerMessage(message, this.encodePeerMessageOptions);
73
- return websocket.send(encoded);
74
- });
75
- let connectingResolvers;
76
- if (websocket.readyState === WEBSOCKET_CONNECTING) {
77
- connectingResolvers = promiseWithResolvers();
78
- websocket.addEventListener("open", () => {
79
- connectingResolvers?.resolve();
80
- });
81
- }
82
- websocket.addEventListener("message", sequential(async (event) => {
83
- const message = event.data instanceof Blob ? await loadBytes(event.data) : toStringOrBytes(event.data);
84
- const result = decodePeerMessage(message, this.decodePeerMessageOptions);
85
- if (result.matched && isServerPeerSendMessage(result.message)) {
86
- peer.message(result.message);
87
- }
88
- }));
89
- websocket.addEventListener("close", async (event) => {
90
- closeReason = new AbortError(`WebSocket closed (code ${event.code}: ${event.reason})`);
91
- connectingResolvers?.resolve();
92
- await peer.close(closeReason);
93
- });
94
- websocket.addEventListener("error", () => {
95
- });
96
- await connectingResolvers?.promise;
97
- if (closeReason) {
98
- throw closeReason;
99
- }
100
- if (this.reconnectOnCloseEnabled) {
101
- websocket.addEventListener("close", () => {
102
- sleep(this.reconnectOnCloseDelay).then(() => this.getConnectedPeer()).catch(() => {
103
- });
104
- });
105
- }
106
- this.attempt = 0;
107
- return { websocket, peer };
108
- })().catch((error) => {
109
- if (!this.reconnectEnabled) {
110
- throw error;
111
- }
112
- if (this.attempt >= this.reconnectMaxAttempt) {
113
- const attempt = this.attempt;
114
- this.attempt = 0;
115
- this.current = void 0;
116
- throw new AbortError(`WebSocket reconnect failed after ${attempt} attempt(s)`, { cause: error });
117
- }
118
- });
119
- return this.getConnectedPeer();
120
- }
121
- }
122
-
123
- class RPCLink extends StandardLink {
124
- constructor(options) {
125
- const codec = new RPCLinkCodec(options);
126
- const transport = new WebSocketLinkTransport(options);
127
- super(codec, transport, options);
128
- }
129
- }
130
-
131
- export { RPCLink, WebSocketLinkTransport };
1
+ export * from "./rpc-link.mjs";
2
+ export * from "./transport.mjs";
@@ -0,0 +1,13 @@
1
+ import type { ClientContext } from "../../types.mjs";
2
+ import type { RPCLinkCodecOptions, StandardLinkOptions } from "../standard/index.mjs";
3
+ import type { WebSocketLinkTransportOptions } from "./transport.mjs";
4
+ import { StandardLink } from "../standard/index.mjs";
5
+ export interface RPCLinkOptions<T extends ClientContext> extends StandardLinkOptions<T>, WebSocketLinkTransportOptions<T>, RPCLinkCodecOptions<T> {}
6
+ /**
7
+ * Client link that communicates with an RPC Handler over a WebSocket connection.
8
+ *
9
+ * @see {@link https://orpc.dev/docs/adapters/websocket | WebSocket Adapters}
10
+ */
11
+ export declare class RPCLink<T extends ClientContext> extends StandardLink<T> {
12
+ constructor(options: RPCLinkOptions<T>);
13
+ }
@@ -0,0 +1,10 @@
1
+ import { RPCLinkCodec, StandardLink } from "../standard/index.mjs";
2
+ import { WebSocketLinkTransport } from "./transport.mjs";
3
+
4
+ export class RPCLink extends StandardLink {
5
+ constructor(options) {
6
+ const codec = new RPCLinkCodec(options);
7
+ const transport = new WebSocketLinkTransport(options);
8
+ super(codec, transport, options);
9
+ }
10
+ }
@@ -0,0 +1,119 @@
1
+ import type { Promisable } from "@orpc/shared";
2
+ import type { StandardLazyResponse, StandardRequest } from "@standard-server/core";
3
+ import type { DecodePeerMessageOptions, EncodePeerMessageOptions } from "@standard-server/peer";
4
+ import type { ClientContext, ClientOptions } from "../../types.mjs";
5
+ import type { StandardLinkTransport } from "../standard/index.mjs";
6
+ export type WebSocketLike = Pick<WebSocket, "addEventListener" | "removeEventListener" | "send" | "readyState">;
7
+ export interface WebSocketLinkTransportAttemptInfo {
8
+ /**
9
+ * Total number of connection attempts for this transport's lifetime.
10
+ * Starts at 1 on the first attempt, increments on every subsequent
11
+ * attempt, and never resets.
12
+ */
13
+ totalAttempt: number;
14
+ /**
15
+ * Attempt number within the current (re)connect cycle.
16
+ * Starts at 1, increments on each consecutive failure, and resets to 1
17
+ * once a connection succeeds or the cycle gives up. Use this for backoff calculations.
18
+ */
19
+ attempt: number;
20
+ }
21
+ export interface WebSocketLinkTransportReconnectOptions {
22
+ /**
23
+ * Whether to automatically reconnect when the connection is lost.
24
+ *
25
+ * @default false
26
+ */
27
+ enabled: boolean;
28
+ /**
29
+ * Delay before a (re)connect attempt, in milliseconds.
30
+ *
31
+ * @default info => info.attempt === 1 ? 0 : 2_000
32
+ */
33
+ delay?: ((info: WebSocketLinkTransportAttemptInfo) => number) | undefined;
34
+ /**
35
+ * Maximum number of consecutive failed attempts before giving up.
36
+ * When reached, calls waiting for the connection fail, and the next
37
+ * call starts a new reconnect cycle.
38
+ * Should greater than 1
39
+ *
40
+ * @default Infinity
41
+ */
42
+ maxAttempt?: number | undefined;
43
+ /**
44
+ * Maximum number of connection attempts over the transport's lifetime,
45
+ * successful ones included (see `totalAttempt`).
46
+ * When reached, calls that need a new connection fail instead of connecting.
47
+ *
48
+ * @default Infinity
49
+ */
50
+ maxTotalAttempt?: number | undefined;
51
+ /**
52
+ * Whether to proactively reconnect right after the socket closes,
53
+ * rather than waiting for the next call to trigger reconnection.
54
+ * Reduces latency for the next request.
55
+ *
56
+ * @default { enabled: false }
57
+ */
58
+ onClose?: {
59
+ /**
60
+ * Whether to proactively reconnect right after the socket closes,
61
+ * rather than waiting for the next call to trigger reconnection.
62
+ * Reduces latency for the next request.
63
+ *
64
+ * @default false
65
+ */
66
+ enabled: boolean;
67
+ /**
68
+ * Delay before reconnecting after the socket closes, in milliseconds.
69
+ *
70
+ * @default 0
71
+ */
72
+ delay?: number | undefined;
73
+ } | undefined;
74
+ }
75
+ export interface WebSocketLinkTransportOptions<_T extends ClientContext> {
76
+ /**
77
+ * Returns a WebSocket instance for peer communication.
78
+ * Can be async for lazy resolution.
79
+ */
80
+ connect: (info: WebSocketLinkTransportAttemptInfo) => Promisable<WebSocketLike>;
81
+ /**
82
+ * Whether to connect immediately on initialization, instead of waiting
83
+ * for the first call. Reduces latency for the first request.
84
+ *
85
+ * @default false
86
+ */
87
+ connectOnInit?: boolean | undefined;
88
+ /**
89
+ * Reconnection behavior when the connection is lost.
90
+ *
91
+ * @default { enabled: false }
92
+ */
93
+ reconnect?: WebSocketLinkTransportReconnectOptions | undefined;
94
+ /**
95
+ * Options for encoding peer messages. such as `prefix` for distinguishing messages on the same channel..
96
+ */
97
+ encodePeerMessage?: EncodePeerMessageOptions | undefined;
98
+ /**
99
+ * Options for decoding peer messages. such as `prefix` for distinguishing messages on the same channel..
100
+ */
101
+ decodePeerMessage?: DecodePeerMessageOptions | undefined;
102
+ }
103
+ export declare class WebSocketLinkTransport<T extends ClientContext> implements StandardLinkTransport<T> {
104
+ private readonly connect;
105
+ private readonly reconnectEnabled;
106
+ private readonly reconnectDelay;
107
+ private readonly reconnectMaxAttempt;
108
+ private readonly reconnectMaxTotalAttempt;
109
+ private readonly reconnectOnCloseEnabled;
110
+ private readonly reconnectOnCloseDelay;
111
+ private readonly encodePeerMessageOptions;
112
+ private readonly decodePeerMessageOptions;
113
+ constructor(options: WebSocketLinkTransportOptions<T>);
114
+ send(standardRequest: StandardRequest, _path: string[], _options: ClientOptions<T>): Promise<StandardLazyResponse>;
115
+ private totalAttempt;
116
+ private attempt;
117
+ private current;
118
+ private getConnectedPeer;
119
+ }
@@ -0,0 +1,123 @@
1
+ import { AbortError, loadBytes, promiseWithResolvers, runWithSignal, sequential, sleep, toStringOrBytes } from "@orpc/shared";
2
+ import { ClientPeer, decodePeerMessage, encodePeerMessage, isServerPeerSendMessage } from "@standard-server/peer";
3
+
4
+ const WEBSOCKET_CONNECTING = 0;
5
+ const WEBSOCKET_OPEN = 1;
6
+ export class WebSocketLinkTransport {
7
+ connect;
8
+ reconnectEnabled;
9
+ reconnectDelay;
10
+ reconnectMaxAttempt;
11
+ reconnectMaxTotalAttempt;
12
+ reconnectOnCloseEnabled;
13
+ reconnectOnCloseDelay;
14
+ encodePeerMessageOptions;
15
+ decodePeerMessageOptions;
16
+ constructor(options) {
17
+ this.connect = options.connect;
18
+ this.reconnectEnabled = options.reconnect?.enabled ?? false;
19
+ this.reconnectDelay = options.reconnect?.delay ?? ((info) => info.attempt === 1 ? 0 : 2e3);
20
+ this.reconnectMaxAttempt = options.reconnect?.maxAttempt ?? Infinity;
21
+ this.reconnectMaxTotalAttempt = options.reconnect?.maxTotalAttempt ?? Infinity;
22
+ this.reconnectOnCloseEnabled = this.reconnectEnabled && (options.reconnect?.onClose?.enabled ?? false);
23
+ this.reconnectOnCloseDelay = options.reconnect?.onClose?.delay ?? 0;
24
+ this.encodePeerMessageOptions = options.encodePeerMessage;
25
+ this.decodePeerMessageOptions = options.decodePeerMessage;
26
+ if (options.connectOnInit) {
27
+ this.getConnectedPeer().catch(() => {});
28
+ }
29
+ }
30
+ async send(standardRequest, _path, _options) {
31
+ const peer = await runWithSignal(standardRequest.signal, () => this.getConnectedPeer());
32
+ return peer.request(standardRequest);
33
+ }
34
+ totalAttempt = 0;
35
+ attempt = 0;
36
+ current;
37
+ async getConnectedPeer() {
38
+ const current = this.current;
39
+ const resolved = await current;
40
+ if (resolved && (!this.reconnectEnabled || resolved.websocket.readyState === WEBSOCKET_OPEN)) {
41
+ return resolved.peer;
42
+ }
43
+ if (current !== this.current) {
44
+ return this.getConnectedPeer();
45
+ }
46
+ if (this.totalAttempt >= this.reconnectMaxTotalAttempt) {
47
+ throw new AbortError(`WebSocket reconnect stopped after ${this.totalAttempt} total attempt(s)`);
48
+ }
49
+ this.current = (async () => {
50
+ this.totalAttempt += 1;
51
+ this.attempt += 1;
52
+ const info = {
53
+ totalAttempt: this.totalAttempt,
54
+ attempt: this.attempt
55
+ };
56
+ await sleep(this.reconnectDelay(info));
57
+ const websocket = await this.connect(info);
58
+ if (websocket.readyState !== WEBSOCKET_CONNECTING && websocket.readyState !== WEBSOCKET_OPEN) {
59
+ throw new AbortError("WebSocket is already closing or closed");
60
+ }
61
+ let closeReason;
62
+ const peer = new ClientPeer(async (message) => {
63
+
64
+ if (closeReason) {
65
+ throw closeReason;
66
+ }
67
+ const encoded = await encodePeerMessage(message, this.encodePeerMessageOptions);
68
+ return websocket.send(encoded);
69
+ });
70
+ let connectingResolvers;
71
+ if (websocket.readyState === WEBSOCKET_CONNECTING) {
72
+ connectingResolvers = promiseWithResolvers();
73
+ websocket.addEventListener("open", () => {
74
+ connectingResolvers?.resolve();
75
+ });
76
+ }
77
+
78
+ websocket.addEventListener("message", sequential(async (event) => {
79
+
80
+ const message = event.data instanceof Blob ? await loadBytes(event.data) : toStringOrBytes(event.data);
81
+ const result = decodePeerMessage(message, this.decodePeerMessageOptions);
82
+ if (result.matched && isServerPeerSendMessage(result.message)) {
83
+
84
+
85
+ peer.message(result.message);
86
+ }
87
+ }));
88
+ websocket.addEventListener("close", async (event) => {
89
+ closeReason = new AbortError(`WebSocket closed (code ${event.code}: ${event.reason})`);
90
+ connectingResolvers?.resolve();
91
+ await peer.close(closeReason);
92
+ });
93
+
94
+
95
+ websocket.addEventListener("error", () => {});
96
+ await connectingResolvers?.promise;
97
+ if (closeReason) {
98
+ throw closeReason;
99
+ }
100
+ if (this.reconnectOnCloseEnabled) {
101
+ websocket.addEventListener("close", () => {
102
+ sleep(this.reconnectOnCloseDelay).then(() => this.getConnectedPeer()).catch(() => {});
103
+ });
104
+ }
105
+ this.attempt = 0;
106
+ return {
107
+ websocket,
108
+ peer
109
+ };
110
+ })().catch((error) => {
111
+ if (!this.reconnectEnabled) {
112
+ throw error;
113
+ }
114
+ if (this.attempt >= this.reconnectMaxAttempt) {
115
+ const attempt = this.attempt;
116
+ this.attempt = 0;
117
+ this.current = undefined;
118
+ throw new AbortError(`WebSocket reconnect failed after ${attempt} attempt(s)`, { cause: error });
119
+ }
120
+ });
121
+ return this.getConnectedPeer();
122
+ }
123
+ }
@@ -0,0 +1,7 @@
1
+ import type { AsyncIteratorClass, WrapAsyncIteratorOptions } from "@orpc/shared";
2
+ export declare function wrapAsyncIteratorPreservingEventMeta<
3
+ TYield,
4
+ TReturn,
5
+ TMappedYield = TYield,
6
+ TMappedReturn = TReturn
7
+ >(iterator: AsyncIterator<TYield, TReturn>, { mapResult, mapError, ...rest }: WrapAsyncIteratorOptions<TYield, TReturn, TMappedYield, TMappedReturn>): AsyncIteratorClass<TMappedYield, TMappedReturn>;
@@ -0,0 +1,30 @@
1
+ import { isTypescriptObject, wrapAsyncIterator } from "@orpc/shared";
2
+ import { getEventMeta, withEventMeta } from "@standard-server/core";
3
+ export function wrapAsyncIteratorPreservingEventMeta(iterator, { mapResult, mapError, ...rest }) {
4
+ return wrapAsyncIterator(iterator, {
5
+ ...rest,
6
+ mapResult: mapResult && (async (result) => {
7
+ const mapped = await mapResult(result);
8
+ if (mapped.value !== result.value) {
9
+ const meta = getEventMeta(result.value);
10
+ if (meta && isTypescriptObject(mapped.value)) {
11
+ return {
12
+ done: mapped.done,
13
+ value: withEventMeta(mapped.value, meta)
14
+ };
15
+ }
16
+ }
17
+ return mapped;
18
+ }),
19
+ mapError: mapError && (async (error) => {
20
+ const mapped = await mapError(error);
21
+ if (mapped !== error) {
22
+ const meta = getEventMeta(error);
23
+ if (meta && isTypescriptObject(mapped)) {
24
+ return withEventMeta(mapped, meta);
25
+ }
26
+ }
27
+ return mapped;
28
+ })
29
+ });
30
+ }
@@ -0,0 +1,16 @@
1
+ import type { AnyNestedClient, Client, ClientRest } from "./types.mjs";
2
+ import type { SafeResult } from "./utils.mjs";
3
+ export type SafeClient<T extends AnyNestedClient> = T extends Client<infer UContext, infer UInput, infer UOutput, infer UError> ? (...rest: ClientRest<UContext, UInput>) => Promise<SafeResult<UOutput, UError>> : { [K in keyof T]: T[K] extends AnyNestedClient ? SafeClient<T[K]> : never };
4
+ /**
5
+ * Create a safe client that automatically wraps all procedure calls with the `safe` util.
6
+ *
7
+ * @example
8
+ * ```ts
9
+ * const safeClient = createSafeClient(client)
10
+ * const { error, data, definedError, isSuccess } = await safeClient.doSomething({ id: '123' })
11
+ * // or const [error, data, definedError, isSuccess] = await safeClient.doSomething({ id: '123' })
12
+ * ```
13
+ *
14
+ * @see {@link https://orpc.dev/docs/client/error-handling#safe-client | Client Error Handling - Safe Client}
15
+ */
16
+ export declare function createSafeClient<T extends AnyNestedClient>(client: T): SafeClient<T>;
@@ -0,0 +1,23 @@
1
+ import { isTypescriptObject } from "@orpc/shared";
2
+ import { RECURSIVE_CLIENT_UNWRAP_KEYS } from "./consts.mjs";
3
+ import { safe } from "./utils.mjs";
4
+
5
+ export function createSafeClient(client) {
6
+ const cache = new Map();
7
+ const proxy = new Proxy((...args) => safe(client(...args)), { get(target, prop) {
8
+ if (typeof prop !== "string" || RECURSIVE_CLIENT_UNWRAP_KEYS.has(prop)) {
9
+ return Reflect.get(target, prop);
10
+ }
11
+ let safeClient = cache.get(prop);
12
+ if (safeClient === undefined) {
13
+ const value = client[prop];
14
+ if (!isTypescriptObject(value)) {
15
+ return value;
16
+ }
17
+ safeClient = createSafeClient(value);
18
+ cache.set(prop, safeClient);
19
+ }
20
+ return safeClient;
21
+ } });
22
+ return proxy;
23
+ }
@@ -0,0 +1,51 @@
1
+ import type { Interceptor, PromiseWithError } from "@orpc/shared";
2
+ import type { AnyNestedClient, Client, ClientContext, ClientLink, ClientOptions, InferClientContext, InferClientError } from "./types.mjs";
3
+ export interface ORPCClientInterceptorOptions<
4
+ TClientContext extends ClientContext,
5
+ TInput
6
+ > extends ClientOptions<TClientContext> {
7
+ path: string[];
8
+ input: TInput;
9
+ }
10
+ export type ORPCClientInterceptor<
11
+ TClientContext extends ClientContext,
12
+ TInput,
13
+ TOutput,
14
+ TError
15
+ > = Interceptor<ORPCClientInterceptorOptions<TClientContext, TInput>, PromiseWithError<TOutput, TError>>;
16
+ export interface ORPCClientScopedOptions<
17
+ TClientContext extends ClientContext,
18
+ TInput,
19
+ TOutput,
20
+ TError
21
+ > {
22
+ /**
23
+ * Interceptors that wrap the entire client call lifecycle.
24
+ */
25
+ interceptors?: ORPCClientInterceptor<TClientContext, TInput, TOutput, TError>[] | undefined;
26
+ }
27
+ export type ORPCClientScoped<T extends AnyNestedClient> = T extends Client<infer UClientContext, infer UInput, infer UOutput, infer UError> ? ORPCClientScopedOptions<UClientContext, UInput, UOutput, UError> : { [K in keyof T]?: (T[K] extends AnyNestedClient ? ORPCClientScoped<T[K]> : never) | undefined };
28
+ export interface ORPCClientOptions<T extends AnyNestedClient> {
29
+ /**
30
+ * Use as base path for all procedure, useful when you only want to call a subset of the procedure.
31
+ */
32
+ path?: string[] | undefined;
33
+ /**
34
+ * Interceptors that wrap the entire client call lifecycle, applied to every procedure call.
35
+ */
36
+ interceptors?: ORPCClientInterceptor<InferClientContext<T>, unknown, unknown, InferClientError<T>>[] | undefined;
37
+ /**
38
+ * Per-procedure options following the shape of the router.
39
+ * Allows fine-grained configuration (e.g. additional interceptors) for individual procedures
40
+ * without affecting the rest of the router.
41
+ */
42
+ scoped?: ORPCClientScoped<T> | undefined;
43
+ }
44
+ /**
45
+ * Creates a fully typed oRPC client from a link.
46
+ * The returned client mirrors the shape of your router or contract,
47
+ * so calling a procedure is as simple as calling a function.
48
+ *
49
+ * @see {@link https://orpc.dev/docs/client/client-side | Client-Side Clients}
50
+ */
51
+ export declare function createORPCClient<T extends AnyNestedClient>(link: ClientLink<InferClientContext<T>>, { path, ...options }?: NoInfer<ORPCClientOptions<T>>): T;
@@ -0,0 +1,32 @@
1
+ import { intercept, toArray } from "@orpc/shared";
2
+ import { RECURSIVE_CLIENT_UNWRAP_KEYS } from "./consts.mjs";
3
+ import { resolveClientRest } from "./utils.mjs";
4
+
5
+ export function createORPCClient(link, { path = [], ...options } = {}) {
6
+ const procedureClient = (...rest) => {
7
+ const [input, callOptions] = resolveClientRest(rest);
8
+ const interceptors = [...toArray(options.interceptors), ...toArray(options.scoped?.interceptors)];
9
+ return intercept(interceptors, {
10
+ ...callOptions,
11
+ input,
12
+ path
13
+ }, ({ path, input, ...callOptions }) => link.call(path, input, callOptions));
14
+ };
15
+ const cache = new Map();
16
+ const recursive = new Proxy(procedureClient, { get(target, key) {
17
+ if (typeof key !== "string" || RECURSIVE_CLIENT_UNWRAP_KEYS.has(key)) {
18
+ return Reflect.get(target, key);
19
+ }
20
+ let client = cache.get(key);
21
+ if (client === undefined) {
22
+ client = createORPCClient(link, {
23
+ ...options,
24
+ path: [...path, key],
25
+ scoped: options.scoped?.[key]
26
+ });
27
+ cache.set(key, client);
28
+ }
29
+ return client;
30
+ } });
31
+ return recursive;
32
+ }
@@ -0,0 +1,10 @@
1
+ /**
2
+ * Property names that should resolve to the underlying value instead of
3
+ * continuing recursive proxy traversal.
4
+ *
5
+ * These properties are commonly accessed automatically by JavaScript runtimes,
6
+ * language features, or third-party libraries. Returning another recursive
7
+ * proxy for them can cause unexpected behavior, compatibility issues, or
8
+ * infinite proxy chains.
9
+ */
10
+ export declare const RECURSIVE_CLIENT_UNWRAP_KEYS: Set<PropertyKey>;
@@ -0,0 +1,10 @@
1
+
2
+ export const RECURSIVE_CLIENT_UNWRAP_KEYS = /* @__PURE__ */ new Set([
3
+ "then",
4
+ "bind",
5
+ "call",
6
+ "apply",
7
+ "valueOf",
8
+ "toString",
9
+ "toJSON"
10
+ ]);
@@ -0,0 +1,13 @@
1
+ import type { Promisable } from "@orpc/shared";
2
+ import type { ClientContext, ClientLink, ClientOptions } from "./types.mjs";
3
+ /**
4
+ * DynamicLink provides a way to dynamically resolve and delegate calls to other ClientLinks
5
+ * based on the request path, input, and context.
6
+ *
7
+ * @see {@link https://orpc.dev/docs/client/dynamic-link | DynamicLink}
8
+ */
9
+ export declare class DynamicLink<TClientContext extends ClientContext> implements ClientLink<TClientContext> {
10
+ private readonly linkResolver;
11
+ constructor(linkResolver: (options: ClientOptions<TClientContext>, path: string[], input: unknown) => Promisable<ClientLink<TClientContext>>);
12
+ call(path: string[], input: unknown, options: ClientOptions<TClientContext>): Promise<unknown>;
13
+ }
@@ -0,0 +1,12 @@
1
+
2
+ export class DynamicLink {
3
+ linkResolver;
4
+ constructor(linkResolver) {
5
+ this.linkResolver = linkResolver;
6
+ }
7
+ async call(path, input, options) {
8
+ const resolvedLink = await this.linkResolver(options, path, input);
9
+ const output = await resolvedLink.call(path, input, options);
10
+ return output;
11
+ }
12
+ }
@@ -0,0 +1,24 @@
1
+ import type { AnyORPCError, ORPCErrorCode, ORPCErrorJSON } from "./error.mjs";
2
+ import { ORPCError } from "./error.mjs";
3
+ /**
4
+ * Checks if an error is an `ORPCError` that matches a definition in the procedure's `.errors` map,
5
+ * narrowing it so `code` and `data` are fully typed.
6
+ *
7
+ * @see {@link https://orpc.dev/docs/client/error-handling#using-safe-and-isdefinederror | Client Error Handling - Using safe and isDefinedError}
8
+ */
9
+ export declare function isDefinedError<T>(error: T): error is Extract<T, AnyORPCError>;
10
+ export declare function toORPCError<T>(error: T): Extract<T, AnyORPCError> | ORPCError<"INTERNAL_SERVER_ERROR", undefined>;
11
+ export declare function isORPCErrorJson(json: unknown): json is ORPCErrorJSON<ORPCErrorCode, unknown>;
12
+ export declare function createORPCErrorFromJson<
13
+ TCode extends ORPCErrorCode,
14
+ TData
15
+ >(json: ORPCErrorJSON<TCode, TData>, options?: ErrorOptions): ORPCError<TCode, TData>;
16
+ /**
17
+ * Clones an `ORPCError` while preserving its prototype chain, so instances of
18
+ * `ORPCError` subclasses remain `instanceof` their class.
19
+ *
20
+ * Limitation: subclass constructors are not re-run, so private fields
21
+ * (`#field`) are not carried over and subclass members that read them
22
+ * will throw on the clone.
23
+ */
24
+ export declare function cloneORPCError<T extends AnyORPCError>(error: T): T;