@orpc/client 0.0.0-next.cdf567b → 0.0.0-next.ce777b8

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -30,7 +30,8 @@
30
30
  - **🔗 End-to-End Type Safety**: Ensure type-safe inputs, outputs, and errors from client to server.
31
31
  - **📘 First-Class OpenAPI**: Built-in support that fully adheres to the OpenAPI standard.
32
32
  - **📝 Contract-First Development**: Optionally define your API contract before implementation.
33
- - **⚙️ Framework Integrations**: Seamlessly integrate with TanStack Query (React, Vue, Solid, Svelte, Angular), Pinia Colada, and more.
33
+ - **🔍 First-Class OpenTelemetry**: Seamlessly integrate with OpenTelemetry for observability.
34
+ - **⚙️ Framework Integrations**: Seamlessly integrate with TanStack Query (React, Vue, Solid, Svelte, Angular), SWR, Pinia Colada, and more.
34
35
  - **🚀 Server Actions**: Fully compatible with React Server Actions on Next.js, TanStack Start, and other platforms.
35
36
  - **🔠 Standard Schema Support**: Works out of the box with Zod, Valibot, ArkType, and other schema validators.
36
37
  - **🗃️ Native Types**: Supports native types like Date, File, Blob, BigInt, URL, and more.
@@ -38,7 +39,6 @@
38
39
  - **📡 SSE & Streaming**: Enjoy full type-safe support for SSE and streaming.
39
40
  - **🌍 Multi-Runtime Support**: Fast and lightweight on Cloudflare, Deno, Bun, Node.js, and beyond.
40
41
  - **🔌 Extendability**: Easily extend functionality with plugins, middleware, and interceptors.
41
- - **🛡️ Reliability**: Well-tested, TypeScript-based, production-ready, and MIT licensed.
42
42
 
43
43
  ## Documentation
44
44
 
@@ -50,9 +50,11 @@ You can find the full documentation [here](https://orpc.unnoq.com).
50
50
  - [@orpc/server](https://www.npmjs.com/package/@orpc/server): Build your API or implement API contract.
51
51
  - [@orpc/client](https://www.npmjs.com/package/@orpc/client): Consume your API on the client with type-safety.
52
52
  - [@orpc/openapi](https://www.npmjs.com/package/@orpc/openapi): Generate OpenAPI specs and handle OpenAPI requests.
53
+ - [@orpc/otel](https://www.npmjs.com/package/@orpc/otel): [OpenTelemetry](https://opentelemetry.io/) integration for observability.
53
54
  - [@orpc/nest](https://www.npmjs.com/package/@orpc/nest): Deeply integrate oRPC with [NestJS](https://nestjs.com/).
54
55
  - [@orpc/react](https://www.npmjs.com/package/@orpc/react): Utilities for integrating oRPC with React and React Server Actions.
55
56
  - [@orpc/tanstack-query](https://www.npmjs.com/package/@orpc/tanstack-query): [TanStack Query](https://tanstack.com/query/latest) integration.
57
+ - [@orpc/experimental-react-swr](https://www.npmjs.com/package/@orpc/experimental-react-swr): [SWR](https://swr.vercel.app/) integration.
56
58
  - [@orpc/vue-colada](https://www.npmjs.com/package/@orpc/vue-colada): Integration with [Pinia Colada](https://pinia-colada.esm.dev/).
57
59
  - [@orpc/hey-api](https://www.npmjs.com/package/@orpc/hey-api): [Hey API](https://heyapi.dev/) integration.
58
60
  - [@orpc/zod](https://www.npmjs.com/package/@orpc/zod): More schemas that [Zod](https://zod.dev/) doesn't support yet.
@@ -1,23 +1,36 @@
1
+ import { Interceptor } from '@orpc/shared';
1
2
  import { StandardRequest, StandardLazyResponse } from '@orpc/standard-server';
2
3
  import { ToFetchRequestOptions } from '@orpc/standard-server-fetch';
3
- import { a as ClientContext, b as ClientOptions } from '../../shared/client.4TS_0JaO.mjs';
4
- import { f as StandardLinkClient } from '../../shared/client.BMoG_EdN.mjs';
5
- import { f as StandardRPCLinkOptions, g as StandardRPCLink } from '../../shared/client.BdD8cpjs.mjs';
6
- import '@orpc/shared';
4
+ import { b as ClientContext, c as ClientOptions } from '../../shared/client.BOYsZIRq.mjs';
5
+ import { a as StandardLinkPlugin, f as StandardLinkClient } from '../../shared/client.Bwgm6dgk.mjs';
6
+ import { f as StandardRPCLinkOptions, g as StandardRPCLink } from '../../shared/client._Y_enhib.mjs';
7
7
 
8
- interface LinkFetchClientOptions<T extends ClientContext> extends ToFetchRequestOptions {
9
- fetch?: (request: Request, init: {
8
+ interface LinkFetchPlugin<T extends ClientContext> extends StandardLinkPlugin<T> {
9
+ initRuntimeAdapter?(options: LinkFetchClientOptions<T>): void;
10
+ }
11
+
12
+ interface LinkFetchInterceptorOptions<T extends ClientContext> extends ClientOptions<T> {
13
+ request: Request;
14
+ init: {
10
15
  redirect?: Request['redirect'];
11
- }, options: ClientOptions<T>, path: readonly string[], input: unknown) => Promise<Response>;
16
+ };
17
+ path: readonly string[];
18
+ input: unknown;
19
+ }
20
+ interface LinkFetchClientOptions<T extends ClientContext> extends ToFetchRequestOptions {
21
+ fetch?: (request: Request, init: LinkFetchInterceptorOptions<T>['init'], options: ClientOptions<T>, path: readonly string[], input: unknown) => Promise<Response>;
22
+ adapterInterceptors?: Interceptor<LinkFetchInterceptorOptions<T>, Promise<Response>>[];
23
+ plugins?: LinkFetchPlugin<T>[];
12
24
  }
13
25
  declare class LinkFetchClient<T extends ClientContext> implements StandardLinkClient<T> {
14
26
  private readonly fetch;
15
27
  private readonly toFetchRequestOptions;
28
+ private readonly adapterInterceptors;
16
29
  constructor(options: LinkFetchClientOptions<T>);
17
- call(request: StandardRequest, options: ClientOptions<T>, path: readonly string[], input: unknown): Promise<StandardLazyResponse>;
30
+ call(standardRequest: StandardRequest, options: ClientOptions<T>, path: readonly string[], input: unknown): Promise<StandardLazyResponse>;
18
31
  }
19
32
 
20
- interface RPCLinkOptions<T extends ClientContext> extends StandardRPCLinkOptions<T>, LinkFetchClientOptions<T> {
33
+ interface RPCLinkOptions<T extends ClientContext> extends LinkFetchClientOptions<T>, Omit<StandardRPCLinkOptions<T>, 'plugins'> {
21
34
  }
22
35
  /**
23
36
  * The RPC Link communicates with the server using the RPC protocol.
@@ -30,4 +43,4 @@ declare class RPCLink<T extends ClientContext> extends StandardRPCLink<T> {
30
43
  }
31
44
 
32
45
  export { LinkFetchClient, RPCLink };
33
- export type { LinkFetchClientOptions, RPCLinkOptions };
46
+ export type { LinkFetchClientOptions, LinkFetchInterceptorOptions, RPCLinkOptions };
@@ -1,23 +1,36 @@
1
+ import { Interceptor } from '@orpc/shared';
1
2
  import { StandardRequest, StandardLazyResponse } from '@orpc/standard-server';
2
3
  import { ToFetchRequestOptions } from '@orpc/standard-server-fetch';
3
- import { a as ClientContext, b as ClientOptions } from '../../shared/client.4TS_0JaO.js';
4
- import { f as StandardLinkClient } from '../../shared/client.C0KbSWlC.js';
5
- import { f as StandardRPCLinkOptions, g as StandardRPCLink } from '../../shared/client.7UM0t5o-.js';
6
- import '@orpc/shared';
4
+ import { b as ClientContext, c as ClientOptions } from '../../shared/client.BOYsZIRq.js';
5
+ import { a as StandardLinkPlugin, f as StandardLinkClient } from '../../shared/client.BG98rYdO.js';
6
+ import { f as StandardRPCLinkOptions, g as StandardRPCLink } from '../../shared/client.CVVVqf1Y.js';
7
7
 
8
- interface LinkFetchClientOptions<T extends ClientContext> extends ToFetchRequestOptions {
9
- fetch?: (request: Request, init: {
8
+ interface LinkFetchPlugin<T extends ClientContext> extends StandardLinkPlugin<T> {
9
+ initRuntimeAdapter?(options: LinkFetchClientOptions<T>): void;
10
+ }
11
+
12
+ interface LinkFetchInterceptorOptions<T extends ClientContext> extends ClientOptions<T> {
13
+ request: Request;
14
+ init: {
10
15
  redirect?: Request['redirect'];
11
- }, options: ClientOptions<T>, path: readonly string[], input: unknown) => Promise<Response>;
16
+ };
17
+ path: readonly string[];
18
+ input: unknown;
19
+ }
20
+ interface LinkFetchClientOptions<T extends ClientContext> extends ToFetchRequestOptions {
21
+ fetch?: (request: Request, init: LinkFetchInterceptorOptions<T>['init'], options: ClientOptions<T>, path: readonly string[], input: unknown) => Promise<Response>;
22
+ adapterInterceptors?: Interceptor<LinkFetchInterceptorOptions<T>, Promise<Response>>[];
23
+ plugins?: LinkFetchPlugin<T>[];
12
24
  }
13
25
  declare class LinkFetchClient<T extends ClientContext> implements StandardLinkClient<T> {
14
26
  private readonly fetch;
15
27
  private readonly toFetchRequestOptions;
28
+ private readonly adapterInterceptors;
16
29
  constructor(options: LinkFetchClientOptions<T>);
17
- call(request: StandardRequest, options: ClientOptions<T>, path: readonly string[], input: unknown): Promise<StandardLazyResponse>;
30
+ call(standardRequest: StandardRequest, options: ClientOptions<T>, path: readonly string[], input: unknown): Promise<StandardLazyResponse>;
18
31
  }
19
32
 
20
- interface RPCLinkOptions<T extends ClientContext> extends StandardRPCLinkOptions<T>, LinkFetchClientOptions<T> {
33
+ interface RPCLinkOptions<T extends ClientContext> extends LinkFetchClientOptions<T>, Omit<StandardRPCLinkOptions<T>, 'plugins'> {
21
34
  }
22
35
  /**
23
36
  * The RPC Link communicates with the server using the RPC protocol.
@@ -30,4 +43,4 @@ declare class RPCLink<T extends ClientContext> extends StandardRPCLink<T> {
30
43
  }
31
44
 
32
45
  export { LinkFetchClient, RPCLink };
33
- export type { LinkFetchClientOptions, RPCLinkOptions };
46
+ export type { LinkFetchClientOptions, LinkFetchInterceptorOptions, RPCLinkOptions };
@@ -1,20 +1,36 @@
1
+ import { toArray, intercept } from '@orpc/shared';
1
2
  import { toFetchRequest, toStandardLazyResponse } from '@orpc/standard-server-fetch';
2
- import '@orpc/shared';
3
- import { c as StandardRPCLink } from '../../shared/client.CQCGVpTM.mjs';
3
+ import { C as CompositeStandardLinkPlugin, c as StandardRPCLink } from '../../shared/client.W-O_y5wk.mjs';
4
4
  import '@orpc/standard-server';
5
- import '../../shared/client.BX0_8bnM.mjs';
5
+ import '../../shared/client.Dpln0Rf1.mjs';
6
+
7
+ class CompositeLinkFetchPlugin extends CompositeStandardLinkPlugin {
8
+ initRuntimeAdapter(options) {
9
+ for (const plugin of this.plugins) {
10
+ plugin.initRuntimeAdapter?.(options);
11
+ }
12
+ }
13
+ }
6
14
 
7
15
  class LinkFetchClient {
8
16
  fetch;
9
17
  toFetchRequestOptions;
18
+ adapterInterceptors;
10
19
  constructor(options) {
11
- this.fetch = options?.fetch ?? globalThis.fetch.bind(globalThis);
20
+ const plugin = new CompositeLinkFetchPlugin(options.plugins);
21
+ plugin.initRuntimeAdapter(options);
22
+ this.fetch = options.fetch ?? globalThis.fetch.bind(globalThis);
12
23
  this.toFetchRequestOptions = options;
24
+ this.adapterInterceptors = toArray(options.adapterInterceptors);
13
25
  }
14
- async call(request, options, path, input) {
15
- const fetchRequest = toFetchRequest(request, this.toFetchRequestOptions);
16
- const fetchResponse = await this.fetch(fetchRequest, { redirect: "manual" }, options, path, input);
17
- const lazyResponse = toStandardLazyResponse(fetchResponse);
26
+ async call(standardRequest, options, path, input) {
27
+ const request = toFetchRequest(standardRequest, this.toFetchRequestOptions);
28
+ const fetchResponse = await intercept(
29
+ this.adapterInterceptors,
30
+ { ...options, request, path, input, init: { redirect: "manual" } },
31
+ ({ request: request2, path: path2, input: input2, init, ...options2 }) => this.fetch(request2, init, options2, path2, input2)
32
+ );
33
+ const lazyResponse = toStandardLazyResponse(fetchResponse, { signal: request.signal });
18
34
  return lazyResponse;
19
35
  }
20
36
  }
@@ -1,7 +1,7 @@
1
1
  import { StandardRequest, StandardLazyResponse } from '@orpc/standard-server';
2
- import { a as ClientContext, b as ClientOptions } from '../../shared/client.4TS_0JaO.mjs';
3
- import { f as StandardLinkClient } from '../../shared/client.BMoG_EdN.mjs';
4
- import { f as StandardRPCLinkOptions, g as StandardRPCLink } from '../../shared/client.BdD8cpjs.mjs';
2
+ import { b as ClientContext, c as ClientOptions } from '../../shared/client.BOYsZIRq.mjs';
3
+ import { f as StandardLinkClient } from '../../shared/client.Bwgm6dgk.mjs';
4
+ import { f as StandardRPCLinkOptions, g as StandardRPCLink } from '../../shared/client._Y_enhib.mjs';
5
5
  import '@orpc/shared';
6
6
 
7
7
  /**
@@ -29,21 +29,21 @@ type SupportedMessagePort = Pick<MessagePort, 'addEventListener' | 'postMessage'
29
29
  /**
30
30
  * Message port can support [The structured clone algorithm](https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API/Structured_clone_algorithm)
31
31
  */
32
- type SupportedMessagePortData = string | ArrayBufferLike;
32
+ type SupportedMessagePortData = string | ArrayBufferLike | Uint8Array;
33
33
  declare function postMessagePortMessage(port: SupportedMessagePort, data: SupportedMessagePortData): void;
34
34
  declare function onMessagePortMessage(port: SupportedMessagePort, callback: (data: SupportedMessagePortData) => void): void;
35
35
  declare function onMessagePortClose(port: SupportedMessagePort, callback: () => void): void;
36
36
 
37
- interface experimental_LinkMessagePortClientOptions {
37
+ interface LinkMessagePortClientOptions {
38
38
  port: SupportedMessagePort;
39
39
  }
40
- declare class experimental_LinkMessagePortClient<T extends ClientContext> implements StandardLinkClient<T> {
40
+ declare class LinkMessagePortClient<T extends ClientContext> implements StandardLinkClient<T> {
41
41
  private readonly peer;
42
- constructor(options: experimental_LinkMessagePortClientOptions);
42
+ constructor(options: LinkMessagePortClientOptions);
43
43
  call(request: StandardRequest, _options: ClientOptions<T>, _path: readonly string[], _input: unknown): Promise<StandardLazyResponse>;
44
44
  }
45
45
 
46
- interface experimental_RPCLinkOptions<T extends ClientContext> extends Omit<StandardRPCLinkOptions<T>, 'url' | 'headers' | 'method' | 'fallbackMethod' | 'maxUrlLength'>, experimental_LinkMessagePortClientOptions {
46
+ interface RPCLinkOptions<T extends ClientContext> extends Omit<StandardRPCLinkOptions<T>, 'url' | 'method' | 'fallbackMethod' | 'maxUrlLength'>, LinkMessagePortClientOptions {
47
47
  }
48
48
  /**
49
49
  * The RPC Link for common message port implementations.
@@ -51,9 +51,9 @@ interface experimental_RPCLinkOptions<T extends ClientContext> extends Omit<Stan
51
51
  * @see {@link https://orpc.unnoq.com/docs/client/rpc-link RPC Link Docs}
52
52
  * @see {@link https://orpc.unnoq.com/docs/adapters/message-port Message Port Adapter Docs}
53
53
  */
54
- declare class experimental_RPCLink<T extends ClientContext> extends StandardRPCLink<T> {
55
- constructor(options: experimental_RPCLinkOptions<T>);
54
+ declare class RPCLink<T extends ClientContext> extends StandardRPCLink<T> {
55
+ constructor(options: RPCLinkOptions<T>);
56
56
  }
57
57
 
58
- export { experimental_LinkMessagePortClient, experimental_RPCLink, onMessagePortClose, onMessagePortMessage, postMessagePortMessage };
59
- export type { BrowserPortLike, MessagePortMainLike, SupportedMessagePort, SupportedMessagePortData, experimental_LinkMessagePortClientOptions, experimental_RPCLinkOptions };
58
+ export { LinkMessagePortClient, RPCLink, onMessagePortClose, onMessagePortMessage, postMessagePortMessage };
59
+ export type { BrowserPortLike, LinkMessagePortClientOptions, MessagePortMainLike, RPCLinkOptions, SupportedMessagePort, SupportedMessagePortData };
@@ -1,7 +1,7 @@
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.C0KbSWlC.js';
4
- import { f as StandardRPCLinkOptions, g as StandardRPCLink } from '../../shared/client.7UM0t5o-.js';
2
+ import { b as ClientContext, c as ClientOptions } from '../../shared/client.BOYsZIRq.js';
3
+ import { f as StandardLinkClient } from '../../shared/client.BG98rYdO.js';
4
+ import { f as StandardRPCLinkOptions, g as StandardRPCLink } from '../../shared/client.CVVVqf1Y.js';
5
5
  import '@orpc/shared';
6
6
 
7
7
  /**
@@ -29,21 +29,21 @@ type SupportedMessagePort = Pick<MessagePort, 'addEventListener' | 'postMessage'
29
29
  /**
30
30
  * Message port can support [The structured clone algorithm](https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API/Structured_clone_algorithm)
31
31
  */
32
- type SupportedMessagePortData = string | ArrayBufferLike;
32
+ type SupportedMessagePortData = string | ArrayBufferLike | Uint8Array;
33
33
  declare function postMessagePortMessage(port: SupportedMessagePort, data: SupportedMessagePortData): void;
34
34
  declare function onMessagePortMessage(port: SupportedMessagePort, callback: (data: SupportedMessagePortData) => void): void;
35
35
  declare function onMessagePortClose(port: SupportedMessagePort, callback: () => void): void;
36
36
 
37
- interface experimental_LinkMessagePortClientOptions {
37
+ interface LinkMessagePortClientOptions {
38
38
  port: SupportedMessagePort;
39
39
  }
40
- declare class experimental_LinkMessagePortClient<T extends ClientContext> implements StandardLinkClient<T> {
40
+ declare class LinkMessagePortClient<T extends ClientContext> implements StandardLinkClient<T> {
41
41
  private readonly peer;
42
- constructor(options: experimental_LinkMessagePortClientOptions);
42
+ constructor(options: LinkMessagePortClientOptions);
43
43
  call(request: StandardRequest, _options: ClientOptions<T>, _path: readonly string[], _input: unknown): Promise<StandardLazyResponse>;
44
44
  }
45
45
 
46
- interface experimental_RPCLinkOptions<T extends ClientContext> extends Omit<StandardRPCLinkOptions<T>, 'url' | 'headers' | 'method' | 'fallbackMethod' | 'maxUrlLength'>, experimental_LinkMessagePortClientOptions {
46
+ interface RPCLinkOptions<T extends ClientContext> extends Omit<StandardRPCLinkOptions<T>, 'url' | 'method' | 'fallbackMethod' | 'maxUrlLength'>, LinkMessagePortClientOptions {
47
47
  }
48
48
  /**
49
49
  * The RPC Link for common message port implementations.
@@ -51,9 +51,9 @@ interface experimental_RPCLinkOptions<T extends ClientContext> extends Omit<Stan
51
51
  * @see {@link https://orpc.unnoq.com/docs/client/rpc-link RPC Link Docs}
52
52
  * @see {@link https://orpc.unnoq.com/docs/adapters/message-port Message Port Adapter Docs}
53
53
  */
54
- declare class experimental_RPCLink<T extends ClientContext> extends StandardRPCLink<T> {
55
- constructor(options: experimental_RPCLinkOptions<T>);
54
+ declare class RPCLink<T extends ClientContext> extends StandardRPCLink<T> {
55
+ constructor(options: RPCLinkOptions<T>);
56
56
  }
57
57
 
58
- export { experimental_LinkMessagePortClient, experimental_RPCLink, onMessagePortClose, onMessagePortMessage, postMessagePortMessage };
59
- export type { BrowserPortLike, MessagePortMainLike, SupportedMessagePort, SupportedMessagePortData, experimental_LinkMessagePortClientOptions, experimental_RPCLinkOptions };
58
+ export { LinkMessagePortClient, RPCLink, onMessagePortClose, onMessagePortMessage, postMessagePortMessage };
59
+ export type { BrowserPortLike, LinkMessagePortClientOptions, MessagePortMainLike, RPCLinkOptions, SupportedMessagePort, SupportedMessagePortData };
@@ -1,8 +1,9 @@
1
1
  import { ClientPeer } from '@orpc/standard-server-peer';
2
2
  import '@orpc/shared';
3
- import { c as StandardRPCLink } from '../../shared/client.CQCGVpTM.mjs';
3
+ import { c as StandardRPCLink } from '../../shared/client.W-O_y5wk.mjs';
4
4
  import '@orpc/standard-server';
5
- import '../../shared/client.BX0_8bnM.mjs';
5
+ import '../../shared/client.Dpln0Rf1.mjs';
6
+ import '@orpc/standard-server-fetch';
6
7
 
7
8
  function postMessagePortMessage(port, data) {
8
9
  port.postMessage(data);
@@ -42,7 +43,7 @@ function onMessagePortClose(port, callback) {
42
43
  }
43
44
  }
44
45
 
45
- class experimental_LinkMessagePortClient {
46
+ class LinkMessagePortClient {
46
47
  peer;
47
48
  constructor(options) {
48
49
  this.peer = new ClientPeer((message) => {
@@ -61,11 +62,11 @@ class experimental_LinkMessagePortClient {
61
62
  }
62
63
  }
63
64
 
64
- class experimental_RPCLink extends StandardRPCLink {
65
+ class RPCLink extends StandardRPCLink {
65
66
  constructor(options) {
66
- const linkClient = new experimental_LinkMessagePortClient(options);
67
+ const linkClient = new LinkMessagePortClient(options);
67
68
  super(linkClient, { ...options, url: "orpc:/" });
68
69
  }
69
70
  }
70
71
 
71
- export { experimental_LinkMessagePortClient, experimental_RPCLink, onMessagePortClose, onMessagePortMessage, postMessagePortMessage };
72
+ export { LinkMessagePortClient, RPCLink, onMessagePortClose, onMessagePortMessage, postMessagePortMessage };
@@ -1,10 +1,11 @@
1
- export { C as CompositeStandardLinkPlugin, d as StandardLink, f as StandardLinkClient, S as StandardLinkClientInterceptorOptions, e as StandardLinkCodec, c as StandardLinkInterceptorOptions, b as StandardLinkOptions, a as StandardLinkPlugin } from '../../shared/client.BMoG_EdN.mjs';
2
- export { S as STANDARD_RPC_JSON_SERIALIZER_BUILT_IN_TYPES, c as StandardRPCCustomJsonSerializer, b as StandardRPCJsonSerialized, a as StandardRPCJsonSerializedMetaItem, e as StandardRPCJsonSerializer, d as StandardRPCJsonSerializerOptions, g as StandardRPCLink, i as StandardRPCLinkCodec, h as StandardRPCLinkCodecOptions, f as StandardRPCLinkOptions, j as StandardRPCSerializer } from '../../shared/client.BdD8cpjs.mjs';
3
- import { H as HTTPPath } from '../../shared/client.4TS_0JaO.mjs';
1
+ export { C as CompositeStandardLinkPlugin, d as StandardLink, f as StandardLinkClient, S as StandardLinkClientInterceptorOptions, e as StandardLinkCodec, c as StandardLinkInterceptorOptions, b as StandardLinkOptions, a as StandardLinkPlugin } from '../../shared/client.Bwgm6dgk.mjs';
2
+ export { S as STANDARD_RPC_JSON_SERIALIZER_BUILT_IN_TYPES, c as StandardRPCCustomJsonSerializer, b as StandardRPCJsonSerialized, a as StandardRPCJsonSerializedMetaItem, e as StandardRPCJsonSerializer, d as StandardRPCJsonSerializerOptions, g as StandardRPCLink, i as StandardRPCLinkCodec, h as StandardRPCLinkCodecOptions, f as StandardRPCLinkOptions, j as StandardRPCSerializer } from '../../shared/client._Y_enhib.mjs';
3
+ import { StandardHeaders } from '@orpc/standard-server';
4
+ import { H as HTTPPath } from '../../shared/client.BOYsZIRq.mjs';
4
5
  import '@orpc/shared';
5
- import '@orpc/standard-server';
6
6
 
7
7
  declare function toHttpPath(path: readonly string[]): HTTPPath;
8
+ declare function toStandardHeaders(headers: Headers | StandardHeaders): StandardHeaders;
8
9
  declare function getMalformedResponseErrorCode(status: number): string;
9
10
 
10
- export { getMalformedResponseErrorCode, toHttpPath };
11
+ export { getMalformedResponseErrorCode, toHttpPath, toStandardHeaders };
@@ -1,10 +1,11 @@
1
- export { C as CompositeStandardLinkPlugin, d as StandardLink, f as StandardLinkClient, S as StandardLinkClientInterceptorOptions, e as StandardLinkCodec, c as StandardLinkInterceptorOptions, b as StandardLinkOptions, a as StandardLinkPlugin } from '../../shared/client.C0KbSWlC.js';
2
- export { S as STANDARD_RPC_JSON_SERIALIZER_BUILT_IN_TYPES, c as StandardRPCCustomJsonSerializer, b as StandardRPCJsonSerialized, a as StandardRPCJsonSerializedMetaItem, e as StandardRPCJsonSerializer, d as StandardRPCJsonSerializerOptions, g as StandardRPCLink, i as StandardRPCLinkCodec, h as StandardRPCLinkCodecOptions, f as StandardRPCLinkOptions, j as StandardRPCSerializer } from '../../shared/client.7UM0t5o-.js';
3
- import { H as HTTPPath } from '../../shared/client.4TS_0JaO.js';
1
+ export { C as CompositeStandardLinkPlugin, d as StandardLink, f as StandardLinkClient, S as StandardLinkClientInterceptorOptions, e as StandardLinkCodec, c as StandardLinkInterceptorOptions, b as StandardLinkOptions, a as StandardLinkPlugin } from '../../shared/client.BG98rYdO.js';
2
+ export { S as STANDARD_RPC_JSON_SERIALIZER_BUILT_IN_TYPES, c as StandardRPCCustomJsonSerializer, b as StandardRPCJsonSerialized, a as StandardRPCJsonSerializedMetaItem, e as StandardRPCJsonSerializer, d as StandardRPCJsonSerializerOptions, g as StandardRPCLink, i as StandardRPCLinkCodec, h as StandardRPCLinkCodecOptions, f as StandardRPCLinkOptions, j as StandardRPCSerializer } from '../../shared/client.CVVVqf1Y.js';
3
+ import { StandardHeaders } from '@orpc/standard-server';
4
+ import { H as HTTPPath } from '../../shared/client.BOYsZIRq.js';
4
5
  import '@orpc/shared';
5
- import '@orpc/standard-server';
6
6
 
7
7
  declare function toHttpPath(path: readonly string[]): HTTPPath;
8
+ declare function toStandardHeaders(headers: Headers | StandardHeaders): StandardHeaders;
8
9
  declare function getMalformedResponseErrorCode(status: number): string;
9
10
 
10
- export { getMalformedResponseErrorCode, toHttpPath };
11
+ export { getMalformedResponseErrorCode, toHttpPath, toStandardHeaders };
@@ -1,4 +1,5 @@
1
- export { C as CompositeStandardLinkPlugin, a as STANDARD_RPC_JSON_SERIALIZER_BUILT_IN_TYPES, S as StandardLink, b as StandardRPCJsonSerializer, c as StandardRPCLink, d as StandardRPCLinkCodec, e as StandardRPCSerializer, g as getMalformedResponseErrorCode, t as toHttpPath } from '../../shared/client.CQCGVpTM.mjs';
1
+ export { C as CompositeStandardLinkPlugin, a as STANDARD_RPC_JSON_SERIALIZER_BUILT_IN_TYPES, S as StandardLink, b as StandardRPCJsonSerializer, c as StandardRPCLink, d as StandardRPCLinkCodec, e as StandardRPCSerializer, g as getMalformedResponseErrorCode, t as toHttpPath, f as toStandardHeaders } from '../../shared/client.W-O_y5wk.mjs';
2
2
  import '@orpc/shared';
3
3
  import '@orpc/standard-server';
4
- import '../../shared/client.BX0_8bnM.mjs';
4
+ import '../../shared/client.Dpln0Rf1.mjs';
5
+ import '@orpc/standard-server-fetch';
@@ -1,19 +1,19 @@
1
1
  import { StandardRequest, StandardLazyResponse } from '@orpc/standard-server';
2
- import { a as ClientContext, b as ClientOptions } from '../../shared/client.4TS_0JaO.mjs';
3
- import { f as StandardLinkClient } from '../../shared/client.BMoG_EdN.mjs';
4
- import { f as StandardRPCLinkOptions, g as StandardRPCLink } from '../../shared/client.BdD8cpjs.mjs';
2
+ import { b as ClientContext, c as ClientOptions } from '../../shared/client.BOYsZIRq.mjs';
3
+ import { f as StandardLinkClient } from '../../shared/client.Bwgm6dgk.mjs';
4
+ import { f as StandardRPCLinkOptions, g as StandardRPCLink } from '../../shared/client._Y_enhib.mjs';
5
5
  import '@orpc/shared';
6
6
 
7
- interface experimental_LinkWebsocketClientOptions {
7
+ interface LinkWebsocketClientOptions {
8
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.
@@ -21,9 +21,9 @@ interface experimental_RPCLinkOptions<T extends ClientContext> extends Omit<Stan
21
21
  * @see {@link https://orpc.unnoq.com/docs/client/rpc-link RPC Link Docs}
22
22
  * @see {@link https://orpc.unnoq.com/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,19 +1,19 @@
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.C0KbSWlC.js';
4
- import { f as StandardRPCLinkOptions, g as StandardRPCLink } from '../../shared/client.7UM0t5o-.js';
2
+ import { b as ClientContext, c as ClientOptions } from '../../shared/client.BOYsZIRq.js';
3
+ import { f as StandardLinkClient } from '../../shared/client.BG98rYdO.js';
4
+ import { f as StandardRPCLinkOptions, g as StandardRPCLink } from '../../shared/client.CVVVqf1Y.js';
5
5
  import '@orpc/shared';
6
6
 
7
- interface experimental_LinkWebsocketClientOptions {
7
+ interface LinkWebsocketClientOptions {
8
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.
@@ -21,9 +21,9 @@ interface experimental_RPCLinkOptions<T extends ClientContext> extends Omit<Stan
21
21
  * @see {@link https://orpc.unnoq.com/docs/client/rpc-link RPC Link Docs}
22
22
  * @see {@link https://orpc.unnoq.com/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,14 +1,16 @@
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.CQCGVpTM.mjs';
3
+ import { c as StandardRPCLink } from '../../shared/client.W-O_y5wk.mjs';
4
4
  import '@orpc/standard-server';
5
- import '../../shared/client.BX0_8bnM.mjs';
5
+ import '../../shared/client.Dpln0Rf1.mjs';
6
+ import '@orpc/standard-server-fetch';
6
7
 
7
- class experimental_LinkWebsocketClient {
8
+ const WEBSOCKET_CONNECTING = 0;
9
+ class LinkWebsocketClient {
8
10
  peer;
9
11
  constructor(options) {
10
12
  const untilOpen = new Promise((resolve) => {
11
- if (options.websocket.readyState === 0) {
13
+ if (options.websocket.readyState === WEBSOCKET_CONNECTING) {
12
14
  options.websocket.addEventListener("open", () => {
13
15
  resolve();
14
16
  }, { once: true });
@@ -21,7 +23,7 @@ class experimental_LinkWebsocketClient {
21
23
  return options.websocket.send(message);
22
24
  });
23
25
  options.websocket.addEventListener("message", async (event) => {
24
- const message = event.data instanceof Blob ? await event.data.arrayBuffer() : event.data;
26
+ const message = event.data instanceof Blob ? await readAsBuffer(event.data) : event.data;
25
27
  this.peer.message(message);
26
28
  });
27
29
  options.websocket.addEventListener("close", () => {
@@ -34,11 +36,11 @@ class experimental_LinkWebsocketClient {
34
36
  }
35
37
  }
36
38
 
37
- class experimental_RPCLink extends StandardRPCLink {
39
+ class RPCLink extends StandardRPCLink {
38
40
  constructor(options) {
39
- const linkClient = new experimental_LinkWebsocketClient(options);
41
+ const linkClient = new LinkWebsocketClient(options);
40
42
  super(linkClient, { ...options, url: "orpc:/" });
41
43
  }
42
44
  }
43
45
 
44
- export { experimental_LinkWebsocketClient, experimental_RPCLink };
46
+ export { LinkWebsocketClient, RPCLink };
package/dist/index.d.mts CHANGED
@@ -1,14 +1,14 @@
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, AsyncIteratorClass, ThrowableError } from '@orpc/shared';
4
- export { EventPublisher, EventPublisherOptions, EventPublisherSubscribeIteratorOptions, Registry, ThrowableError, onError, onFinish, onStart, onSuccess } from '@orpc/shared';
1
+ import { N as NestedClient, C as ClientLink, I as InferClientContext, a as ClientPromiseResult, b as ClientContext, F as FriendlyClientOptions, c as ClientOptions, d as Client, e as ClientRest } from './shared/client.BOYsZIRq.mjs';
2
+ export { f as HTTPMethod, H as HTTPPath } from './shared/client.BOYsZIRq.mjs';
3
+ import { MaybeOptionalOptions, ThrowableError, Promisable, AsyncIteratorClass } from '@orpc/shared';
4
+ export { AsyncIteratorClass, EventPublisher, EventPublisherOptions, EventPublisherSubscribeIteratorOptions, Registry, ThrowableError, asyncIteratorToStream as eventIteratorToStream, onError, onFinish, onStart, onSuccess, streamToAsyncIteratorClass as streamToEventIterator } from '@orpc/shared';
5
5
  export { ErrorEvent } from '@orpc/standard-server';
6
6
 
7
7
  interface createORPCClientOptions {
8
8
  /**
9
9
  * Use as base path for all procedure, useful when you only want to call a subset of the procedure.
10
10
  */
11
- path?: string[];
11
+ path?: readonly string[];
12
12
  }
13
13
  /**
14
14
  * Create a oRPC client-side client from a link.
@@ -17,18 +17,6 @@ interface createORPCClientOptions {
17
17
  */
18
18
  declare function createORPCClient<T extends NestedClient<any>>(link: ClientLink<InferClientContext<T>>, options?: createORPCClientOptions): T;
19
19
 
20
- /**
21
- * DynamicLink provides a way to dynamically resolve and delegate calls to other ClientLinks
22
- * based on the request path, input, and context.
23
- *
24
- * @see {@link https://orpc.unnoq.com/docs/client/dynamic-link Dynamic Link Docs}
25
- */
26
- declare class DynamicLink<TClientContext extends ClientContext> implements ClientLink<TClientContext> {
27
- private readonly linkResolver;
28
- constructor(linkResolver: (options: ClientOptions<TClientContext>, path: readonly string[], input: unknown) => Promisable<ClientLink<TClientContext>>);
29
- call(path: readonly string[], input: unknown, options: ClientOptions<TClientContext>): Promise<unknown>;
30
- }
31
-
32
20
  declare const COMMON_ORPC_ERROR_DEFS: {
33
21
  readonly BAD_REQUEST: {
34
22
  readonly status: 400;
@@ -125,8 +113,21 @@ declare class ORPCError<TCode extends ORPCErrorCode, TData> extends Error {
125
113
  readonly code: TCode;
126
114
  readonly status: number;
127
115
  readonly data: TData;
128
- constructor(code: TCode, ...[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
- }): AsyncIteratorClass<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;
@@ -165,5 +161,41 @@ type SafeResult<TOutput, TError> = [error: null, data: TOutput, isDefined: false
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>;
167
163
 
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 };
164
+ 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>> : {
165
+ [K in keyof T]: T[K] extends NestedClient<any> ? SafeClient<T[K]> : never;
166
+ };
167
+ /**
168
+ * Create a safe client that automatically wraps all procedure calls with the `safe` util.
169
+ *
170
+ * @example
171
+ * ```ts
172
+ * const safeClient = createSafeClient(client)
173
+ * const { error, data, isDefined } = await safeClient.doSomething({ id: '123' })
174
+ * ```
175
+ *
176
+ * @see {@link https://orpc.unnoq.com/docs/client/error-handling#using-createsafeclient Safe Client Docs}
177
+ */
178
+ declare function createSafeClient<T extends NestedClient<any>>(client: T): SafeClient<T>;
179
+
180
+ declare const ORPC_CLIENT_PACKAGE_NAME = "@orpc/client";
181
+ declare const ORPC_CLIENT_PACKAGE_VERSION = "0.0.0-next.ce777b8";
182
+
183
+ /**
184
+ * DynamicLink provides a way to dynamically resolve and delegate calls to other ClientLinks
185
+ * based on the request path, input, and context.
186
+ *
187
+ * @see {@link https://orpc.unnoq.com/docs/client/dynamic-link Dynamic Link Docs}
188
+ */
189
+ declare class DynamicLink<TClientContext extends ClientContext> implements ClientLink<TClientContext> {
190
+ private readonly linkResolver;
191
+ constructor(linkResolver: (options: ClientOptions<TClientContext>, path: readonly string[], input: unknown) => Promisable<ClientLink<TClientContext>>);
192
+ call(path: readonly string[], input: unknown, options: ClientOptions<TClientContext>): Promise<unknown>;
193
+ }
194
+
195
+ declare function mapEventIterator<TYield, TReturn, TNext, TMap = TYield | TReturn>(iterator: AsyncIterator<TYield, TReturn, TNext>, maps: {
196
+ value: (value: NoInfer<TYield | TReturn>, done: boolean | undefined) => Promise<TMap>;
197
+ error: (error: unknown) => Promise<unknown>;
198
+ }): AsyncIteratorClass<TMap, TMap, TNext>;
199
+
200
+ export { COMMON_ORPC_ERROR_DEFS, Client, ClientContext, ClientLink, ClientOptions, ClientPromiseResult, ClientRest, DynamicLink, FriendlyClientOptions, InferClientContext, NestedClient, ORPCError, ORPC_CLIENT_PACKAGE_NAME, ORPC_CLIENT_PACKAGE_VERSION, createORPCClient, createORPCErrorFromJson, createSafeClient, fallbackORPCErrorMessage, fallbackORPCErrorStatus, isDefinedError, isORPCErrorJson, isORPCErrorStatus, mapEventIterator, resolveFriendlyClientOptions, safe, toORPCError };
201
+ export type { CommonORPCErrorCode, ORPCErrorCode, ORPCErrorJSON, ORPCErrorOptions, SafeClient, SafeResult, createORPCClientOptions };