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

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 (94) hide show
  1. package/README.md +6 -7
  2. package/dist/adapters/fetch/index.d.ts +2 -48
  3. package/dist/adapters/fetch/index.js +2 -0
  4. package/dist/adapters/fetch/rpc-link.d.ts +14 -0
  5. package/dist/adapters/fetch/rpc-link.js +14 -0
  6. package/dist/adapters/fetch/transport.d.ts +34 -0
  7. package/dist/adapters/fetch/transport.js +65 -0
  8. package/dist/adapters/message-port/index.d.ts +3 -80
  9. package/dist/adapters/message-port/index.js +3 -0
  10. package/dist/adapters/message-port/message-port.d.ts +29 -0
  11. package/dist/adapters/message-port/message-port.js +56 -0
  12. package/dist/adapters/message-port/rpc-link.d.ts +15 -0
  13. package/dist/adapters/message-port/rpc-link.js +15 -0
  14. package/dist/adapters/message-port/transport.d.ts +38 -0
  15. package/dist/adapters/message-port/transport.js +52 -0
  16. package/dist/adapters/standard/codec.d.ts +14 -0
  17. package/dist/adapters/standard/codec.js +1 -0
  18. package/dist/adapters/standard/index.d.ts +5 -60
  19. package/dist/adapters/standard/index.js +4 -0
  20. package/dist/adapters/standard/link.d.ts +40 -0
  21. package/dist/adapters/standard/link.js +85 -0
  22. package/dist/adapters/standard/plugin.d.ts +32 -0
  23. package/dist/adapters/standard/plugin.js +16 -0
  24. package/dist/adapters/standard/{index.d.mts → rpc-link-codec.d.ts} +17 -14
  25. package/dist/adapters/standard/rpc-link-codec.js +104 -0
  26. package/dist/adapters/standard/transport.d.ts +14 -0
  27. package/dist/adapters/standard/transport.js +1 -0
  28. package/dist/adapters/websocket/index.d.ts +2 -136
  29. package/dist/adapters/websocket/index.js +2 -0
  30. package/dist/adapters/websocket/rpc-link.d.ts +14 -0
  31. package/dist/adapters/websocket/rpc-link.js +14 -0
  32. package/dist/adapters/websocket/{index.d.mts → transport.d.ts} +32 -53
  33. package/dist/adapters/websocket/transport.js +133 -0
  34. package/dist/async-iterator-object.d.ts +2 -0
  35. package/dist/async-iterator-object.js +29 -0
  36. package/dist/client-safe.d.ts +18 -0
  37. package/dist/client-safe.js +36 -0
  38. package/dist/client.d.ts +40 -0
  39. package/dist/client.js +39 -0
  40. package/dist/consts.d.ts +10 -0
  41. package/dist/consts.js +43 -0
  42. package/dist/dynamic-link.d.ts +13 -0
  43. package/dist/dynamic-link.js +17 -0
  44. package/dist/error-utils.d.ts +21 -0
  45. package/dist/error-utils.js +58 -0
  46. package/dist/error.d.ts +132 -0
  47. package/dist/error.js +178 -0
  48. package/dist/index.d.ts +38 -129
  49. package/dist/index.js +40 -0
  50. package/dist/plugins/batch.d.ts +185 -0
  51. package/dist/plugins/batch.js +401 -0
  52. package/dist/plugins/cookie-jar.d.ts +82 -0
  53. package/dist/plugins/cookie-jar.js +268 -0
  54. package/dist/plugins/dedupe.d.ts +64 -0
  55. package/dist/plugins/dedupe.js +226 -0
  56. package/dist/plugins/index.d.ts +20 -412
  57. package/dist/plugins/index.js +23 -0
  58. package/dist/plugins/request-compression.d.ts +44 -0
  59. package/dist/plugins/request-compression.js +178 -0
  60. package/dist/plugins/response-compression.d.ts +28 -0
  61. package/dist/plugins/response-compression.js +91 -0
  62. package/dist/plugins/retry-after.d.ts +50 -0
  63. package/dist/plugins/retry-after.js +88 -0
  64. package/dist/plugins/retry.d.ts +84 -0
  65. package/dist/plugins/retry.js +140 -0
  66. package/dist/plugins/timeout.d.ts +25 -0
  67. package/dist/plugins/timeout.js +37 -0
  68. package/dist/{shared/client.DqIWeNhQ.d.mts → rpc-json-serializer.d.ts} +9 -41
  69. package/dist/rpc-json-serializer.js +392 -0
  70. package/dist/rpc-serializer.d.ts +32 -0
  71. package/dist/rpc-serializer.js +130 -0
  72. package/dist/types.d.ts +97 -0
  73. package/dist/types.js +1 -0
  74. package/dist/utils.d.ts +47 -0
  75. package/dist/utils.js +51 -0
  76. package/package.json +43 -45
  77. package/dist/adapters/fetch/index.d.mts +0 -48
  78. package/dist/adapters/fetch/index.mjs +0 -77
  79. package/dist/adapters/message-port/index.d.mts +0 -80
  80. package/dist/adapters/message-port/index.mjs +0 -101
  81. package/dist/adapters/standard/index.mjs +0 -6
  82. package/dist/adapters/websocket/index.mjs +0 -131
  83. package/dist/index.d.mts +0 -144
  84. package/dist/index.mjs +0 -147
  85. package/dist/plugins/index.d.mts +0 -420
  86. package/dist/plugins/index.mjs +0 -971
  87. package/dist/shared/client.BoHJeq15.d.mts +0 -233
  88. package/dist/shared/client.BoHJeq15.d.ts +0 -233
  89. package/dist/shared/client.CKQeJJ2U.mjs +0 -172
  90. package/dist/shared/client.DqIWeNhQ.d.ts +0 -131
  91. package/dist/shared/client.JBJwBhR8.d.ts +0 -90
  92. package/dist/shared/client.LF04eOvL.mjs +0 -115
  93. package/dist/shared/client._wG5INmC.mjs +0 -505
  94. package/dist/shared/client.euYjjcFz.d.mts +0 -90
@@ -1,101 +0,0 @@
1
- import { value, AbortError } from '@orpc/shared';
2
- import { ClientPeer, encodePeerMessage, decodePeerMessage, isServerPeerSendMessage, isPeerMessage } 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
- function postMessagePortMessage(port, data, transfer) {
10
- if (transfer) {
11
- port.postMessage(data, transfer);
12
- } else {
13
- port.postMessage(data);
14
- }
15
- }
16
- function onMessagePortMessage(port, callback) {
17
- if ("addEventListener" in port) {
18
- port.addEventListener("message", (event) => {
19
- callback(event.data);
20
- });
21
- } else if ("on" in port) {
22
- port.on("message", (event) => {
23
- callback(event?.data);
24
- });
25
- } else if ("onMessage" in port) {
26
- port.onMessage.addListener((data) => {
27
- callback(data);
28
- });
29
- } else {
30
- throw new Error("Cannot find a addEventListener/on/onMessage method on the port");
31
- }
32
- }
33
- function onMessagePortClose(port, callback) {
34
- if ("addEventListener" in port) {
35
- port.addEventListener("close", () => {
36
- callback();
37
- });
38
- } else if ("on" in port) {
39
- port.on("close", () => {
40
- callback();
41
- });
42
- } else if ("onDisconnect" in port) {
43
- port.onDisconnect.addListener(() => {
44
- callback();
45
- });
46
- } else {
47
- throw new Error("Cannot find a addEventListener/on/onDisconnect method on the port");
48
- }
49
- }
50
-
51
- class MessagePortLinkTransport {
52
- peer;
53
- constructor({ port, experimental_transfer, encodePeerMessage: encodePeerMessageOptions, decodePeerMessage: decodePeerMessageOptions }) {
54
- let closeReason;
55
- this.peer = new ClientPeer(async (message) => {
56
- if (closeReason) {
57
- throw closeReason;
58
- }
59
- const transfer = await value(experimental_transfer, message, port);
60
- if (transfer) {
61
- postMessagePortMessage(port, message, transfer);
62
- } else {
63
- postMessagePortMessage(port, await encodePeerMessage(message, encodePeerMessageOptions));
64
- }
65
- });
66
- onMessagePortMessage(port, async (data) => {
67
- let peerMessage;
68
- if (typeof data === "string" || data instanceof Uint8Array) {
69
- const result = decodePeerMessage(data, decodePeerMessageOptions);
70
- if (result.matched && isServerPeerSendMessage(result.message)) {
71
- peerMessage = result.message;
72
- }
73
- } else if (isPeerMessage(data) && isServerPeerSendMessage(data)) {
74
- peerMessage = data;
75
- }
76
- if (peerMessage === void 0) {
77
- return { matched: false };
78
- }
79
- await this.peer.message(peerMessage);
80
- return { matched: true };
81
- });
82
- onMessagePortClose(port, async () => {
83
- closeReason = new AbortError("MessagePort closed");
84
- await this.peer.close(closeReason);
85
- });
86
- }
87
- async send(standardRequest, _path, _options) {
88
- const standardResponse = await this.peer.request(standardRequest);
89
- return standardResponse;
90
- }
91
- }
92
-
93
- class RPCLink extends StandardLink {
94
- constructor(options) {
95
- const codec = new RPCLinkCodec(options);
96
- const transport = new MessagePortLinkTransport(options);
97
- super(codec, transport, options);
98
- }
99
- }
100
-
101
- export { MessagePortLinkTransport, RPCLink, onMessagePortClose, onMessagePortMessage, postMessagePortMessage };
@@ -1,6 +0,0 @@
1
- export { R as RPCLinkCodec, S as StandardLink } from '../../shared/client.CKQeJJ2U.mjs';
2
- import '@orpc/shared';
3
- import '@standard-server/core';
4
- import '@standard-server/fetch';
5
- import '../../shared/client.LF04eOvL.mjs';
6
- import '../../shared/client._wG5INmC.mjs';
@@ -1,131 +0,0 @@
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 };
package/dist/index.d.mts DELETED
@@ -1,144 +0,0 @@
1
- import { WrapAsyncIteratorOptions, AsyncIteratorClass, Interceptor, PromiseWithError, ThrowableError, Promisable } from '@orpc/shared';
2
- export { AsyncCleanupFn, AsyncIteratorClass, AsyncIteratorClassNextFn, PromiseWithError as ClientPromiseResult, MaybeOptionalOptions, PromiseWithError, Registry, ThrowableError, asyncIteratorToStream, asyncIteratorToUnproxiedDataStream, consumeAsyncIterator, consumeAsyncIterator as consumeEventIterator, asyncIteratorToStream as eventIteratorToStream, asyncIteratorToUnproxiedDataStream as eventIteratorToUnproxiedDataStream, onAsyncIteratorObjectError, onError, onFinish, onReadableStreamError, onStart, onSuccess, streamToAsyncIteratorObject, streamToAsyncIteratorObject as streamToEventIterator } from '@orpc/shared';
3
- import { C as ClientContext, a as ClientOptions, c as AnyNestedClient, I as InferClientContext, d as InferClientError, e as Client, b as ClientLink, A as AnyORPCError, f as ClientRest, O as ORPCErrorCode, g as ORPCErrorJSON, h as ORPCError } from './shared/client.BoHJeq15.mjs';
4
- export { i as AnyORPCErrorJSON, j as COMMON_ERROR_STATUS_MAP, F as FriendlyClientOptions, k as InferClientBodyInputs, l as InferClientBodyOutputs, m as InferClientErrors, n as InferClientInputs, o as InferClientOutputs, M as MalformedResponseError, p as MalformedResponseErrorOptions, N as NestedClient, q as ORPCErrorOptions, R as ResponseError, r as ResponseErrorOptions } from './shared/client.BoHJeq15.mjs';
5
- export { R as RPCJsonSerialization, a as RPCJsonSerializationMeta, b as RPCJsonSerializer, c as RPCJsonSerializerHandler, d as RPCJsonSerializerOptions, e as RPCSerializer, f as RPCSerializerOptions, g as RPCSerializerSerializeOptions } from './shared/client.DqIWeNhQ.mjs';
6
- export { ErrorEvent, EventMeta, StandardBody, StandardBodyHint, StandardHeaders, StandardLazyRequest, StandardLazyResponse, StandardMethod, StandardRequest, StandardResponse, StandardUrl, getEventMeta, unwrapEvent, withEventMeta } from '@standard-server/core';
7
-
8
- declare function wrapAsyncIteratorPreservingEventMeta<TYield, TReturn, TMappedYield = TYield, TMappedReturn = TReturn>(iterator: AsyncIterator<TYield, TReturn>, { mapResult, mapError, ...rest }: WrapAsyncIteratorOptions<TYield, TReturn, TMappedYield, TMappedReturn>): AsyncIteratorClass<TMappedYield, TMappedReturn>;
9
-
10
- interface ORPCClientInterceptorOptions<TClientContext extends ClientContext, TInput> extends ClientOptions<TClientContext> {
11
- path: string[];
12
- input: TInput;
13
- }
14
- type ORPCClientInterceptor<TClientContext extends ClientContext, TInput, TOutput, TError> = Interceptor<ORPCClientInterceptorOptions<TClientContext, TInput>, PromiseWithError<TOutput, TError>>;
15
- interface ORPCClientScopedOptions<TClientContext extends ClientContext, TInput, TOutput, TError> {
16
- /**
17
- * Interceptors that wrap the entire client call lifecycle.
18
- */
19
- interceptors?: ORPCClientInterceptor<TClientContext, TInput, TOutput, TError>[] | undefined;
20
- }
21
- type ORPCClientScoped<T extends AnyNestedClient> = T extends Client<infer UClientContext, infer UInput, infer UOutput, infer UError> ? ORPCClientScopedOptions<UClientContext, UInput, UOutput, UError> : {
22
- [K in keyof T]?: (T[K] extends AnyNestedClient ? ORPCClientScoped<T[K]> : never) | undefined;
23
- };
24
- interface ORPCClientOptions<T extends AnyNestedClient> {
25
- /**
26
- * Use as base path for all procedure, useful when you only want to call a subset of the procedure.
27
- */
28
- path?: string[] | undefined;
29
- /**
30
- * Interceptors that wrap the entire client call lifecycle, applied to every procedure call.
31
- */
32
- interceptors?: ORPCClientInterceptor<InferClientContext<T>, unknown, unknown, InferClientError<T>>[] | undefined;
33
- /**
34
- * Per-procedure options following the shape of the router.
35
- * Allows fine-grained configuration (e.g. additional interceptors) for individual procedures
36
- * without affecting the rest of the router.
37
- */
38
- scoped?: ORPCClientScoped<T> | undefined;
39
- }
40
- /**
41
- * Creates a fully typed oRPC client from a link.
42
- * The returned client mirrors the shape of your router or contract,
43
- * so calling a procedure is as simple as calling a function.
44
- *
45
- * @see {@link https://orpc.dev/docs/client/client-side | Client-Side Clients}
46
- */
47
- declare function createORPCClient<T extends AnyNestedClient>(link: ClientLink<InferClientContext<T>>, { path, ...options }?: NoInfer<ORPCClientOptions<T>>): T;
48
-
49
- declare function resolveClientRest<TClientContext extends ClientContext, TInput>(rest: ClientRest<TClientContext, TInput>): [input: TInput, options: ClientOptions<TClientContext>];
50
- type SafeResult<TOutput, TError> = [error: null, data: TOutput, definedError: null, isSuccess: true] & {
51
- error: null;
52
- data: TOutput;
53
- definedError: null;
54
- isSuccess: true;
55
- } | [error: Exclude<TError, AnyORPCError>, data: undefined, definedError: null, isSuccess: false] & {
56
- error: Exclude<TError, AnyORPCError>;
57
- data: undefined;
58
- definedError: null;
59
- isSuccess: false;
60
- } | [error: Extract<TError, AnyORPCError>, data: undefined, definedError: Extract<TError, AnyORPCError>, isSuccess: false] & {
61
- error: Extract<TError, AnyORPCError>;
62
- data: undefined;
63
- definedError: Extract<TError, AnyORPCError>;
64
- isSuccess: false;
65
- };
66
- /**
67
- * Works like try/catch, but help you infer the error type if it is a defined ORPCError.
68
- *
69
- * @example
70
- * ```ts
71
- * const [error, data, definedError, isSuccess] = await safe(client(...))
72
- * // or const { error, data, definedError, isSuccess } = await safe(client(...))
73
- *
74
- * if (definedError) {
75
- * console.log(definedError) // or error, both are well typed
76
- * }
77
- * ```
78
- *
79
- * @see {@link https://orpc.dev/docs/client/error-handling#using-safe-and-isdefinederror | Client Error Handling - Using safe and isDefinedError}
80
- */
81
- declare function safe<TOutput, TError = ThrowableError>(promise: PromiseWithError<TOutput, TError>): Promise<SafeResult<TOutput, TError>>;
82
-
83
- type SafeClient<T extends AnyNestedClient> = T extends Client<infer UContext, infer UInput, infer UOutput, infer UError> ? (...rest: ClientRest<UContext, UInput>) => Promise<SafeResult<UOutput, UError>> : {
84
- [K in keyof T]: T[K] extends AnyNestedClient ? SafeClient<T[K]> : never;
85
- };
86
- /**
87
- * Create a safe client that automatically wraps all procedure calls with the `safe` util.
88
- *
89
- * @example
90
- * ```ts
91
- * const safeClient = createSafeClient(client)
92
- * const { error, data, definedError, isSuccess } = await safeClient.doSomething({ id: '123' })
93
- * // or const [error, data, definedError, isSuccess] = await safeClient.doSomething({ id: '123' })
94
- * ```
95
- *
96
- * @see {@link https://orpc.dev/docs/client/error-handling#safe-client | Client Error Handling - Safe Client}
97
- */
98
- declare function createSafeClient<T extends AnyNestedClient>(client: T): SafeClient<T>;
99
-
100
- /**
101
- * Property names that should resolve to the underlying value instead of
102
- * continuing recursive proxy traversal.
103
- *
104
- * These properties are commonly accessed automatically by JavaScript runtimes,
105
- * language features, or third-party libraries. Returning another recursive
106
- * proxy for them can cause unexpected behavior, compatibility issues, or
107
- * infinite proxy chains.
108
- */
109
- declare const RECURSIVE_CLIENT_UNWRAP_KEYS: Set<PropertyKey>;
110
-
111
- /**
112
- * DynamicLink provides a way to dynamically resolve and delegate calls to other ClientLinks
113
- * based on the request path, input, and context.
114
- *
115
- * @see {@link https://orpc.dev/docs/client/dynamic-link | DynamicLink}
116
- */
117
- declare class DynamicLink<TClientContext extends ClientContext> implements ClientLink<TClientContext> {
118
- private readonly linkResolver;
119
- constructor(linkResolver: (options: ClientOptions<TClientContext>, path: string[], input: unknown) => Promisable<ClientLink<TClientContext>>);
120
- call(path: string[], input: unknown, options: ClientOptions<TClientContext>): Promise<unknown>;
121
- }
122
-
123
- /**
124
- * Checks if an error is an `ORPCError` that matches a definition in the procedure's `.errors` map,
125
- * narrowing it so `code` and `data` are fully typed.
126
- *
127
- * @see {@link https://orpc.dev/docs/client/error-handling#using-safe-and-isdefinederror | Client Error Handling - Using safe and isDefinedError}
128
- */
129
- declare function isDefinedError<T>(error: T): error is Extract<T, AnyORPCError>;
130
- declare function toORPCError<T>(error: T): Extract<T, AnyORPCError> | ORPCError<'INTERNAL_SERVER_ERROR', undefined>;
131
- declare function isORPCErrorJson(json: unknown): json is ORPCErrorJSON<ORPCErrorCode, unknown>;
132
- declare function createORPCErrorFromJson<TCode extends ORPCErrorCode, TData>(json: ORPCErrorJSON<TCode, TData>, options?: ErrorOptions): ORPCError<TCode, TData>;
133
- /**
134
- * Clones an `ORPCError` while preserving its prototype chain, so instances of
135
- * `ORPCError` subclasses remain `instanceof` their class.
136
- *
137
- * Limitation: subclass constructors are not re-run, so private fields
138
- * (`#field`) are not carried over and subclass members that read them
139
- * will throw on the clone.
140
- */
141
- declare function cloneORPCError<T extends AnyORPCError>(error: T): T;
142
-
143
- export { AnyNestedClient, AnyORPCError, Client, ClientContext, ClientLink, ClientOptions, ClientRest, DynamicLink, InferClientContext, InferClientError, InferClientError as InferClientErrorUnion, ORPCError, ORPCErrorCode, ORPCErrorJSON, RECURSIVE_CLIENT_UNWRAP_KEYS, cloneORPCError, createORPCClient, createORPCErrorFromJson, createSafeClient, isDefinedError, isORPCErrorJson, resolveClientRest, safe, toORPCError, wrapAsyncIteratorPreservingEventMeta };
144
- export type { ORPCClientInterceptor, ORPCClientInterceptorOptions, ORPCClientOptions, ORPCClientScoped, ORPCClientScopedOptions, SafeClient, SafeResult };
package/dist/index.mjs DELETED
@@ -1,147 +0,0 @@
1
- import { a as isDefinedError } from './shared/client._wG5INmC.mjs';
2
- export { b as RPCJsonSerializer, R as RPCSerializer, d as cloneORPCError, c as createORPCErrorFromJson, i as isORPCErrorJson, t as toORPCError, w as wrapAsyncIteratorPreservingEventMeta } from './shared/client._wG5INmC.mjs';
3
- import { toArray, intercept, isTypescriptObject } from '@orpc/shared';
4
- export { AsyncIteratorClass, asyncIteratorToStream, asyncIteratorToUnproxiedDataStream, consumeAsyncIterator, consumeAsyncIterator as consumeEventIterator, asyncIteratorToStream as eventIteratorToStream, asyncIteratorToUnproxiedDataStream as eventIteratorToUnproxiedDataStream, onAsyncIteratorObjectError, onError, onFinish, onReadableStreamError, onStart, onSuccess, streamToAsyncIteratorObject, streamToAsyncIteratorObject as streamToEventIterator } from '@orpc/shared';
5
- export { C as COMMON_ERROR_STATUS_MAP, M as MalformedResponseError, O as ORPCError, R as ResponseError } from './shared/client.LF04eOvL.mjs';
6
- export { ErrorEvent, getEventMeta, unwrapEvent, withEventMeta } from '@standard-server/core';
7
-
8
- const RECURSIVE_CLIENT_UNWRAP_KEYS = /* @__PURE__ */ new Set([
9
- /**
10
- * Prevents the client from being treated as a thenable when users
11
- * accidentally write `await client`.
12
- */
13
- "then",
14
- /**
15
- * Commonly used by libraries to bind functions to a specific `this`
16
- * context.
17
- */
18
- "bind",
19
- /**
20
- * Commonly used by libraries to invoke functions with a specific `this`
21
- * context.
22
- */
23
- "call",
24
- /**
25
- * Commonly used by libraries to invoke functions with a specific `this`
26
- * context and an arguments array.
27
- */
28
- "apply",
29
- /**
30
- * Commonly accessed during primitive conversion, inspection, and logging.
31
- */
32
- "valueOf",
33
- /**
34
- * Commonly accessed during string conversion, inspection, and logging.
35
- */
36
- "toString",
37
- /**
38
- * Commonly accessed by serializers such as `JSON.stringify`.
39
- */
40
- "toJSON"
41
- ]);
42
-
43
- function resolveFriendlyClientOptions(options) {
44
- return {
45
- ...options,
46
- context: options.context ?? {}
47
- // Context only optional if all fields are optional
48
- };
49
- }
50
- function resolveClientRest(rest) {
51
- return [
52
- rest[0],
53
- // rest[0] can be undefined if TInput is optional,
54
- resolveFriendlyClientOptions(rest[1] ?? {})
55
- // rest[1] can be undefined if all fields of FriendlyClientOptions are optional
56
- ];
57
- }
58
- async function safe(promise) {
59
- try {
60
- const output = await promise;
61
- return Object.assign(
62
- [null, output, null, true],
63
- { error: null, data: output, definedError: null, isSuccess: true }
64
- );
65
- } catch (e) {
66
- const error = e;
67
- if (isDefinedError(error)) {
68
- return Object.assign(
69
- [error, void 0, error, false],
70
- { error, data: void 0, definedError: error, isSuccess: false }
71
- );
72
- }
73
- return Object.assign(
74
- [error, void 0, null, false],
75
- { error, data: void 0, definedError: null, isSuccess: false }
76
- );
77
- }
78
- }
79
-
80
- function createORPCClient(link, { path = [], ...options } = {}) {
81
- const procedureClient = (...rest) => {
82
- const [input, callOptions] = resolveClientRest(rest);
83
- const interceptors = [
84
- ...toArray(options.interceptors),
85
- ...toArray(options.scoped?.interceptors)
86
- ];
87
- return intercept(
88
- interceptors,
89
- { ...callOptions, input, path },
90
- ({ path: path2, input: input2, ...callOptions2 }) => link.call(path2, input2, callOptions2)
91
- );
92
- };
93
- const cache = /* @__PURE__ */ new Map();
94
- const recursive = new Proxy(procedureClient, {
95
- get(target, key) {
96
- if (typeof key !== "string" || RECURSIVE_CLIENT_UNWRAP_KEYS.has(key)) {
97
- return Reflect.get(target, key);
98
- }
99
- let client = cache.get(key);
100
- if (client === void 0) {
101
- client = createORPCClient(link, {
102
- ...options,
103
- path: [...path, key],
104
- scoped: options.scoped?.[key]
105
- });
106
- cache.set(key, client);
107
- }
108
- return client;
109
- }
110
- });
111
- return recursive;
112
- }
113
-
114
- function createSafeClient(client) {
115
- const cache = /* @__PURE__ */ new Map();
116
- const proxy = new Proxy((...args) => safe(client(...args)), {
117
- get(target, prop) {
118
- if (typeof prop !== "string" || RECURSIVE_CLIENT_UNWRAP_KEYS.has(prop)) {
119
- return Reflect.get(target, prop);
120
- }
121
- let safeClient = cache.get(prop);
122
- if (safeClient === void 0) {
123
- const value = client[prop];
124
- if (!isTypescriptObject(value)) {
125
- return value;
126
- }
127
- safeClient = createSafeClient(value);
128
- cache.set(prop, safeClient);
129
- }
130
- return safeClient;
131
- }
132
- });
133
- return proxy;
134
- }
135
-
136
- class DynamicLink {
137
- constructor(linkResolver) {
138
- this.linkResolver = linkResolver;
139
- }
140
- async call(path, input, options) {
141
- const resolvedLink = await this.linkResolver(options, path, input);
142
- const output = await resolvedLink.call(path, input, options);
143
- return output;
144
- }
145
- }
146
-
147
- export { DynamicLink, RECURSIVE_CLIENT_UNWRAP_KEYS, createORPCClient, createSafeClient, isDefinedError, resolveClientRest, safe };