@orpc/client 0.0.0-next.a4bc49e → 0.0.0-next.a55d49f

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 (30) hide show
  1. package/README.md +7 -2
  2. package/dist/adapters/fetch/index.d.mts +23 -10
  3. package/dist/adapters/fetch/index.d.ts +23 -10
  4. package/dist/adapters/fetch/index.mjs +24 -8
  5. package/dist/adapters/message-port/index.d.mts +29 -8
  6. package/dist/adapters/message-port/index.d.ts +29 -8
  7. package/dist/adapters/message-port/index.mjs +25 -10
  8. package/dist/adapters/standard/index.d.mts +6 -5
  9. package/dist/adapters/standard/index.d.ts +6 -5
  10. package/dist/adapters/standard/index.mjs +3 -2
  11. package/dist/adapters/websocket/index.d.mts +4 -4
  12. package/dist/adapters/websocket/index.d.ts +4 -4
  13. package/dist/adapters/websocket/index.mjs +6 -4
  14. package/dist/index.d.mts +52 -7
  15. package/dist/index.d.ts +52 -7
  16. package/dist/index.mjs +35 -6
  17. package/dist/plugins/index.d.mts +3 -2
  18. package/dist/plugins/index.d.ts +3 -2
  19. package/dist/plugins/index.mjs +41 -23
  20. package/dist/shared/client.BH1AYT_p.d.mts +83 -0
  21. package/dist/shared/client.BH1AYT_p.d.ts +83 -0
  22. package/dist/shared/{client.DHOfWE0c.mjs → client.BW3SBw-r.mjs} +53 -17
  23. package/dist/shared/{client.WCinBImJ.d.ts → client.BxV-mzeR.d.ts} +3 -3
  24. package/dist/shared/{client.CXXEPIbK.d.ts → client.CPgZaUox.d.mts} +1 -2
  25. package/dist/shared/{client.aTp4sII-.d.mts → client.D8lMmWVC.d.mts} +3 -3
  26. package/dist/shared/{client.C4VxIexA.d.mts → client.De8SW4Kw.d.ts} +1 -2
  27. package/dist/shared/{client.DwfV9Oyl.mjs → client.ufURaY18.mjs} +62 -20
  28. package/package.json +6 -6
  29. package/dist/shared/client.BOYsZIRq.d.mts +0 -29
  30. package/dist/shared/client.BOYsZIRq.d.ts +0 -29
package/README.md CHANGED
@@ -17,6 +17,9 @@
17
17
  <a href="https://discord.gg/TXEbwRBvQn">
18
18
  <img alt="Discord" src="https://img.shields.io/discord/1308966753044398161?color=7389D8&label&logo=discord&logoColor=ffffff" />
19
19
  </a>
20
+ <a href="https://deepwiki.com/unnoq/orpc">
21
+ <img src="https://deepwiki.com/badge.svg" alt="Ask DeepWiki">
22
+ </a>
20
23
  </div>
21
24
 
22
25
  <h3 align="center">Typesafe APIs Made Simple 🪄</h3>
@@ -30,7 +33,8 @@
30
33
  - **🔗 End-to-End Type Safety**: Ensure type-safe inputs, outputs, and errors from client to server.
31
34
  - **📘 First-Class OpenAPI**: Built-in support that fully adheres to the OpenAPI standard.
32
35
  - **📝 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.
36
+ - **🔍 First-Class OpenTelemetry**: Seamlessly integrate with OpenTelemetry for observability.
37
+ - **⚙️ Framework Integrations**: Seamlessly integrate with TanStack Query (React, Vue, Solid, Svelte, Angular), SWR, Pinia Colada, and more.
34
38
  - **🚀 Server Actions**: Fully compatible with React Server Actions on Next.js, TanStack Start, and other platforms.
35
39
  - **🔠 Standard Schema Support**: Works out of the box with Zod, Valibot, ArkType, and other schema validators.
36
40
  - **🗃️ Native Types**: Supports native types like Date, File, Blob, BigInt, URL, and more.
@@ -38,7 +42,6 @@
38
42
  - **📡 SSE & Streaming**: Enjoy full type-safe support for SSE and streaming.
39
43
  - **🌍 Multi-Runtime Support**: Fast and lightweight on Cloudflare, Deno, Bun, Node.js, and beyond.
40
44
  - **🔌 Extendability**: Easily extend functionality with plugins, middleware, and interceptors.
41
- - **🛡️ Reliability**: Well-tested, TypeScript-based, production-ready, and MIT licensed.
42
45
 
43
46
  ## Documentation
44
47
 
@@ -50,9 +53,11 @@ You can find the full documentation [here](https://orpc.unnoq.com).
50
53
  - [@orpc/server](https://www.npmjs.com/package/@orpc/server): Build your API or implement API contract.
51
54
  - [@orpc/client](https://www.npmjs.com/package/@orpc/client): Consume your API on the client with type-safety.
52
55
  - [@orpc/openapi](https://www.npmjs.com/package/@orpc/openapi): Generate OpenAPI specs and handle OpenAPI requests.
56
+ - [@orpc/otel](https://www.npmjs.com/package/@orpc/otel): [OpenTelemetry](https://opentelemetry.io/) integration for observability.
53
57
  - [@orpc/nest](https://www.npmjs.com/package/@orpc/nest): Deeply integrate oRPC with [NestJS](https://nestjs.com/).
54
58
  - [@orpc/react](https://www.npmjs.com/package/@orpc/react): Utilities for integrating oRPC with React and React Server Actions.
55
59
  - [@orpc/tanstack-query](https://www.npmjs.com/package/@orpc/tanstack-query): [TanStack Query](https://tanstack.com/query/latest) integration.
60
+ - [@orpc/experimental-react-swr](https://www.npmjs.com/package/@orpc/experimental-react-swr): [SWR](https://swr.vercel.app/) integration.
56
61
  - [@orpc/vue-colada](https://www.npmjs.com/package/@orpc/vue-colada): Integration with [Pinia Colada](https://pinia-colada.esm.dev/).
57
62
  - [@orpc/hey-api](https://www.npmjs.com/package/@orpc/hey-api): [Hey API](https://heyapi.dev/) integration.
58
63
  - [@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 { b as ClientContext, c as ClientOptions } from '../../shared/client.BOYsZIRq.mjs';
4
- import { f as StandardLinkClient } from '../../shared/client.C4VxIexA.mjs';
5
- import { f as StandardRPCLinkOptions, g as StandardRPCLink } from '../../shared/client.aTp4sII-.mjs';
6
- import '@orpc/shared';
4
+ import { b as ClientContext, c as ClientOptions } from '../../shared/client.BH1AYT_p.mjs';
5
+ import { a as StandardLinkPlugin, f as StandardLinkClient } from '../../shared/client.CPgZaUox.mjs';
6
+ import { f as StandardRPCLinkOptions, g as StandardRPCLink } from '../../shared/client.D8lMmWVC.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 { b as ClientContext, c as ClientOptions } from '../../shared/client.BOYsZIRq.js';
4
- import { f as StandardLinkClient } from '../../shared/client.CXXEPIbK.js';
5
- import { f as StandardRPCLinkOptions, g as StandardRPCLink } from '../../shared/client.WCinBImJ.js';
6
- import '@orpc/shared';
4
+ import { b as ClientContext, c as ClientOptions } from '../../shared/client.BH1AYT_p.js';
5
+ import { a as StandardLinkPlugin, f as StandardLinkClient } from '../../shared/client.De8SW4Kw.js';
6
+ import { f as StandardRPCLinkOptions, g as StandardRPCLink } from '../../shared/client.BxV-mzeR.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.DwfV9Oyl.mjs';
3
+ import { C as CompositeStandardLinkPlugin, c as StandardRPCLink } from '../../shared/client.ufURaY18.mjs';
4
4
  import '@orpc/standard-server';
5
- import '../../shared/client.DHOfWE0c.mjs';
5
+ import '../../shared/client.BW3SBw-r.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,8 +1,9 @@
1
+ import { Value, Promisable } from '@orpc/shared';
1
2
  import { StandardRequest, StandardLazyResponse } from '@orpc/standard-server';
2
- import { b as ClientContext, c as ClientOptions } from '../../shared/client.BOYsZIRq.mjs';
3
- import { f as StandardLinkClient } from '../../shared/client.C4VxIexA.mjs';
4
- import { f as StandardRPCLinkOptions, g as StandardRPCLink } from '../../shared/client.aTp4sII-.mjs';
5
- import '@orpc/shared';
3
+ import { DecodedRequestMessage } from '@orpc/standard-server-peer';
4
+ import { b as ClientContext, c as ClientOptions } from '../../shared/client.BH1AYT_p.mjs';
5
+ import { f as StandardLinkClient } from '../../shared/client.CPgZaUox.mjs';
6
+ import { f as StandardRPCLinkOptions, g as StandardRPCLink } from '../../shared/client.D8lMmWVC.mjs';
6
7
 
7
8
  /**
8
9
  * The message port used by electron in main process
@@ -11,7 +12,7 @@ interface MessagePortMainLike {
11
12
  on: <T extends string>(event: T, callback: (event?: {
12
13
  data: any;
13
14
  }) => void) => void;
14
- postMessage: (data: any) => void;
15
+ postMessage: (data: any, transfer?: any[]) => void;
15
16
  }
16
17
  /**
17
18
  * The message port used by browser extension
@@ -29,13 +30,33 @@ type SupportedMessagePort = Pick<MessagePort, 'addEventListener' | 'postMessage'
29
30
  /**
30
31
  * Message port can support [The structured clone algorithm](https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API/Structured_clone_algorithm)
31
32
  */
32
- type SupportedMessagePortData = string | ArrayBufferLike | Uint8Array;
33
- declare function postMessagePortMessage(port: SupportedMessagePort, data: SupportedMessagePortData): void;
33
+ type SupportedMessagePortData = any;
34
+ declare function postMessagePortMessage(port: SupportedMessagePort, data: SupportedMessagePortData, transfer?: any[]): void;
34
35
  declare function onMessagePortMessage(port: SupportedMessagePort, callback: (data: SupportedMessagePortData) => void): void;
35
36
  declare function onMessagePortClose(port: SupportedMessagePort, callback: () => void): void;
36
37
 
37
38
  interface LinkMessagePortClientOptions {
38
39
  port: SupportedMessagePort;
40
+ /**
41
+ * By default, oRPC serializes request/response messages to string/binary data before sending over message port.
42
+ * If needed, you can define the this option to utilize full power of [MessagePort: postMessage() method](https://developer.mozilla.org/en-US/docs/Web/API/MessagePort/postMessage),
43
+ * such as transferring ownership of objects to the other side or support unserializable objects like `OffscreenCanvas`.
44
+ *
45
+ * @remarks
46
+ * - return null | undefined to disable this feature
47
+ *
48
+ * @warning Make sure your message port supports `transfer` before using this feature.
49
+ * @example
50
+ * ```ts
51
+ * experimental_transfer: (message, port) => {
52
+ * const transfer = deepFindTransferableObjects(message) // implement your own logic
53
+ * return transfer.length ? transfer : null // only enable when needed
54
+ * }
55
+ * ```
56
+ *
57
+ * @see {@link https://orpc.unnoq.com/docs/adapters/message-port#transfer Message Port Transfer Docs}
58
+ */
59
+ experimental_transfer?: Value<Promisable<object[] | null | undefined>, [message: DecodedRequestMessage, port: SupportedMessagePort]>;
39
60
  }
40
61
  declare class LinkMessagePortClient<T extends ClientContext> implements StandardLinkClient<T> {
41
62
  private readonly peer;
@@ -43,7 +64,7 @@ declare class LinkMessagePortClient<T extends ClientContext> implements Standard
43
64
  call(request: StandardRequest, _options: ClientOptions<T>, _path: readonly string[], _input: unknown): Promise<StandardLazyResponse>;
44
65
  }
45
66
 
46
- interface RPCLinkOptions<T extends ClientContext> extends Omit<StandardRPCLinkOptions<T>, 'url' | 'headers' | 'method' | 'fallbackMethod' | 'maxUrlLength'>, LinkMessagePortClientOptions {
67
+ interface RPCLinkOptions<T extends ClientContext> extends Omit<StandardRPCLinkOptions<T>, 'url' | 'method' | 'fallbackMethod' | 'maxUrlLength'>, LinkMessagePortClientOptions {
47
68
  }
48
69
  /**
49
70
  * The RPC Link for common message port implementations.
@@ -1,8 +1,9 @@
1
+ import { Value, Promisable } from '@orpc/shared';
1
2
  import { StandardRequest, StandardLazyResponse } from '@orpc/standard-server';
2
- import { b as ClientContext, c as ClientOptions } from '../../shared/client.BOYsZIRq.js';
3
- import { f as StandardLinkClient } from '../../shared/client.CXXEPIbK.js';
4
- import { f as StandardRPCLinkOptions, g as StandardRPCLink } from '../../shared/client.WCinBImJ.js';
5
- import '@orpc/shared';
3
+ import { DecodedRequestMessage } from '@orpc/standard-server-peer';
4
+ import { b as ClientContext, c as ClientOptions } from '../../shared/client.BH1AYT_p.js';
5
+ import { f as StandardLinkClient } from '../../shared/client.De8SW4Kw.js';
6
+ import { f as StandardRPCLinkOptions, g as StandardRPCLink } from '../../shared/client.BxV-mzeR.js';
6
7
 
7
8
  /**
8
9
  * The message port used by electron in main process
@@ -11,7 +12,7 @@ interface MessagePortMainLike {
11
12
  on: <T extends string>(event: T, callback: (event?: {
12
13
  data: any;
13
14
  }) => void) => void;
14
- postMessage: (data: any) => void;
15
+ postMessage: (data: any, transfer?: any[]) => void;
15
16
  }
16
17
  /**
17
18
  * The message port used by browser extension
@@ -29,13 +30,33 @@ type SupportedMessagePort = Pick<MessagePort, 'addEventListener' | 'postMessage'
29
30
  /**
30
31
  * Message port can support [The structured clone algorithm](https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API/Structured_clone_algorithm)
31
32
  */
32
- type SupportedMessagePortData = string | ArrayBufferLike | Uint8Array;
33
- declare function postMessagePortMessage(port: SupportedMessagePort, data: SupportedMessagePortData): void;
33
+ type SupportedMessagePortData = any;
34
+ declare function postMessagePortMessage(port: SupportedMessagePort, data: SupportedMessagePortData, transfer?: any[]): void;
34
35
  declare function onMessagePortMessage(port: SupportedMessagePort, callback: (data: SupportedMessagePortData) => void): void;
35
36
  declare function onMessagePortClose(port: SupportedMessagePort, callback: () => void): void;
36
37
 
37
38
  interface LinkMessagePortClientOptions {
38
39
  port: SupportedMessagePort;
40
+ /**
41
+ * By default, oRPC serializes request/response messages to string/binary data before sending over message port.
42
+ * If needed, you can define the this option to utilize full power of [MessagePort: postMessage() method](https://developer.mozilla.org/en-US/docs/Web/API/MessagePort/postMessage),
43
+ * such as transferring ownership of objects to the other side or support unserializable objects like `OffscreenCanvas`.
44
+ *
45
+ * @remarks
46
+ * - return null | undefined to disable this feature
47
+ *
48
+ * @warning Make sure your message port supports `transfer` before using this feature.
49
+ * @example
50
+ * ```ts
51
+ * experimental_transfer: (message, port) => {
52
+ * const transfer = deepFindTransferableObjects(message) // implement your own logic
53
+ * return transfer.length ? transfer : null // only enable when needed
54
+ * }
55
+ * ```
56
+ *
57
+ * @see {@link https://orpc.unnoq.com/docs/adapters/message-port#transfer Message Port Transfer Docs}
58
+ */
59
+ experimental_transfer?: Value<Promisable<object[] | null | undefined>, [message: DecodedRequestMessage, port: SupportedMessagePort]>;
39
60
  }
40
61
  declare class LinkMessagePortClient<T extends ClientContext> implements StandardLinkClient<T> {
41
62
  private readonly peer;
@@ -43,7 +64,7 @@ declare class LinkMessagePortClient<T extends ClientContext> implements Standard
43
64
  call(request: StandardRequest, _options: ClientOptions<T>, _path: readonly string[], _input: unknown): Promise<StandardLazyResponse>;
44
65
  }
45
66
 
46
- interface RPCLinkOptions<T extends ClientContext> extends Omit<StandardRPCLinkOptions<T>, 'url' | 'headers' | 'method' | 'fallbackMethod' | 'maxUrlLength'>, LinkMessagePortClientOptions {
67
+ interface RPCLinkOptions<T extends ClientContext> extends Omit<StandardRPCLinkOptions<T>, 'url' | 'method' | 'fallbackMethod' | 'maxUrlLength'>, LinkMessagePortClientOptions {
47
68
  }
48
69
  /**
49
70
  * The RPC Link for common message port implementations.
@@ -1,11 +1,16 @@
1
- import { ClientPeer } from '@orpc/standard-server-peer';
2
- import '@orpc/shared';
3
- import { c as StandardRPCLink } from '../../shared/client.DwfV9Oyl.mjs';
1
+ import { value, isObject } from '@orpc/shared';
2
+ import { experimental_ClientPeerWithoutCodec, serializeRequestMessage, encodeRequestMessage, deserializeResponseMessage, decodeResponseMessage } from '@orpc/standard-server-peer';
3
+ import { c as StandardRPCLink } from '../../shared/client.ufURaY18.mjs';
4
4
  import '@orpc/standard-server';
5
- import '../../shared/client.DHOfWE0c.mjs';
5
+ import '../../shared/client.BW3SBw-r.mjs';
6
+ import '@orpc/standard-server-fetch';
6
7
 
7
- function postMessagePortMessage(port, data) {
8
- port.postMessage(data);
8
+ function postMessagePortMessage(port, data, transfer) {
9
+ if (transfer) {
10
+ port.postMessage(data, transfer);
11
+ } else {
12
+ port.postMessage(data);
13
+ }
9
14
  }
10
15
  function onMessagePortMessage(port, callback) {
11
16
  if ("addEventListener" in port) {
@@ -45,11 +50,21 @@ function onMessagePortClose(port, callback) {
45
50
  class LinkMessagePortClient {
46
51
  peer;
47
52
  constructor(options) {
48
- this.peer = new ClientPeer((message) => {
49
- return postMessagePortMessage(options.port, message);
53
+ this.peer = new experimental_ClientPeerWithoutCodec(async (message) => {
54
+ const [id, type, payload] = message;
55
+ const transfer = await value(options.experimental_transfer, message, options.port);
56
+ if (transfer) {
57
+ postMessagePortMessage(options.port, serializeRequestMessage(id, type, payload), transfer);
58
+ } else {
59
+ postMessagePortMessage(options.port, await encodeRequestMessage(id, type, payload));
60
+ }
50
61
  });
51
62
  onMessagePortMessage(options.port, async (message) => {
52
- await this.peer.message(message);
63
+ if (isObject(message)) {
64
+ await this.peer.message(deserializeResponseMessage(message));
65
+ } else {
66
+ await this.peer.message(await decodeResponseMessage(message));
67
+ }
53
68
  });
54
69
  onMessagePortClose(options.port, () => {
55
70
  this.peer.close();
@@ -64,7 +79,7 @@ class LinkMessagePortClient {
64
79
  class RPCLink extends StandardRPCLink {
65
80
  constructor(options) {
66
81
  const linkClient = new LinkMessagePortClient(options);
67
- super(linkClient, { ...options, url: "orpc:/" });
82
+ super(linkClient, { ...options, url: "orpc://localhost" });
68
83
  }
69
84
  }
70
85
 
@@ -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.C4VxIexA.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.aTp4sII-.mjs';
3
- import { H as HTTPPath } from '../../shared/client.BOYsZIRq.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.CPgZaUox.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.D8lMmWVC.mjs';
3
+ import { StandardHeaders } from '@orpc/standard-server';
4
+ import { H as HTTPPath } from '../../shared/client.BH1AYT_p.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.CXXEPIbK.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.WCinBImJ.js';
3
- import { H as HTTPPath } from '../../shared/client.BOYsZIRq.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.De8SW4Kw.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.BxV-mzeR.js';
3
+ import { StandardHeaders } from '@orpc/standard-server';
4
+ import { H as HTTPPath } from '../../shared/client.BH1AYT_p.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.DwfV9Oyl.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.ufURaY18.mjs';
2
2
  import '@orpc/shared';
3
3
  import '@orpc/standard-server';
4
- import '../../shared/client.DHOfWE0c.mjs';
4
+ import '../../shared/client.BW3SBw-r.mjs';
5
+ import '@orpc/standard-server-fetch';
@@ -1,7 +1,7 @@
1
1
  import { StandardRequest, StandardLazyResponse } from '@orpc/standard-server';
2
- import { b as ClientContext, c as ClientOptions } from '../../shared/client.BOYsZIRq.mjs';
3
- import { f as StandardLinkClient } from '../../shared/client.C4VxIexA.mjs';
4
- import { f as StandardRPCLinkOptions, g as StandardRPCLink } from '../../shared/client.aTp4sII-.mjs';
2
+ import { b as ClientContext, c as ClientOptions } from '../../shared/client.BH1AYT_p.mjs';
3
+ import { f as StandardLinkClient } from '../../shared/client.CPgZaUox.mjs';
4
+ import { f as StandardRPCLinkOptions, g as StandardRPCLink } from '../../shared/client.D8lMmWVC.mjs';
5
5
  import '@orpc/shared';
6
6
 
7
7
  interface LinkWebsocketClientOptions {
@@ -13,7 +13,7 @@ declare class LinkWebsocketClient<T extends ClientContext> implements StandardLi
13
13
  call(request: StandardRequest, _options: ClientOptions<T>, _path: readonly string[], _input: unknown): Promise<StandardLazyResponse>;
14
14
  }
15
15
 
16
- interface RPCLinkOptions<T extends ClientContext> extends Omit<StandardRPCLinkOptions<T>, 'url' | 'headers' | 'method' | 'fallbackMethod' | 'maxUrlLength'>, 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.
@@ -1,7 +1,7 @@
1
1
  import { StandardRequest, StandardLazyResponse } from '@orpc/standard-server';
2
- import { b as ClientContext, c as ClientOptions } from '../../shared/client.BOYsZIRq.js';
3
- import { f as StandardLinkClient } from '../../shared/client.CXXEPIbK.js';
4
- import { f as StandardRPCLinkOptions, g as StandardRPCLink } from '../../shared/client.WCinBImJ.js';
2
+ import { b as ClientContext, c as ClientOptions } from '../../shared/client.BH1AYT_p.js';
3
+ import { f as StandardLinkClient } from '../../shared/client.De8SW4Kw.js';
4
+ import { f as StandardRPCLinkOptions, g as StandardRPCLink } from '../../shared/client.BxV-mzeR.js';
5
5
  import '@orpc/shared';
6
6
 
7
7
  interface LinkWebsocketClientOptions {
@@ -13,7 +13,7 @@ declare class LinkWebsocketClient<T extends ClientContext> implements StandardLi
13
13
  call(request: StandardRequest, _options: ClientOptions<T>, _path: readonly string[], _input: unknown): Promise<StandardLazyResponse>;
14
14
  }
15
15
 
16
- interface RPCLinkOptions<T extends ClientContext> extends Omit<StandardRPCLinkOptions<T>, 'url' | 'headers' | 'method' | 'fallbackMethod' | 'maxUrlLength'>, 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.
@@ -1,14 +1,16 @@
1
1
  import { readAsBuffer } from '@orpc/shared';
2
2
  import { ClientPeer } from '@orpc/standard-server-peer';
3
- import { c as StandardRPCLink } from '../../shared/client.DwfV9Oyl.mjs';
3
+ import { c as StandardRPCLink } from '../../shared/client.ufURaY18.mjs';
4
4
  import '@orpc/standard-server';
5
- import '../../shared/client.DHOfWE0c.mjs';
5
+ import '../../shared/client.BW3SBw-r.mjs';
6
+ import '@orpc/standard-server-fetch';
6
7
 
8
+ const WEBSOCKET_CONNECTING = 0;
7
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 });
@@ -37,7 +39,7 @@ class LinkWebsocketClient {
37
39
  class RPCLink extends StandardRPCLink {
38
40
  constructor(options) {
39
41
  const linkClient = new LinkWebsocketClient(options);
40
- super(linkClient, { ...options, url: "orpc:/" });
42
+ super(linkClient, { ...options, url: "orpc://localhost" });
41
43
  }
42
44
  }
43
45
 
package/dist/index.d.mts CHANGED
@@ -1,7 +1,7 @@
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 { 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.BH1AYT_p.mjs';
2
+ export { f as HTTPMethod, H as HTTPPath, h as InferClientBodyInputs, j as InferClientBodyOutputs, l as InferClientErrorUnion, k as InferClientErrors, g as InferClientInputs, i as InferClientOutputs } from './shared/client.BH1AYT_p.mjs';
3
+ import { MaybeOptionalOptions, ThrowableError, OnFinishState, Promisable, AsyncIteratorClass } from '@orpc/shared';
4
+ export { AsyncIteratorClass, EventPublisher, EventPublisherOptions, EventPublisherSubscribeIteratorOptions, Registry, ThrowableError, asyncIteratorToStream as eventIteratorToStream, asyncIteratorToUnproxiedDataStream as eventIteratorToUnproxiedDataStream, onError, onFinish, onStart, onSuccess, streamToAsyncIteratorClass as streamToEventIterator } from '@orpc/shared';
5
5
  export { ErrorEvent } from '@orpc/standard-server';
6
6
 
7
7
  interface createORPCClientOptions {
@@ -113,8 +113,21 @@ declare class ORPCError<TCode extends ORPCErrorCode, TData> extends Error {
113
113
  readonly code: TCode;
114
114
  readonly status: number;
115
115
  readonly data: TData;
116
- constructor(code: TCode, ...[options]: MaybeOptionalOptions<ORPCErrorOptions<TData>>);
116
+ constructor(code: TCode, ...rest: MaybeOptionalOptions<ORPCErrorOptions<TData>>);
117
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;
118
131
  }
119
132
  type ORPCErrorJSON<TCode extends string, TData> = Pick<ORPCError<TCode, TData>, 'defined' | 'code' | 'status' | 'message' | 'data'>;
120
133
  declare function isDefinedError<T>(error: T): error is Extract<T, ORPCError<any, any>>;
@@ -147,6 +160,35 @@ type SafeResult<TOutput, TError> = [error: null, data: TOutput, isDefined: false
147
160
  */
148
161
  declare function safe<TOutput, TError = ThrowableError>(promise: ClientPromiseResult<TOutput, TError>): Promise<SafeResult<TOutput, TError>>;
149
162
  declare function resolveFriendlyClientOptions<T extends ClientContext>(options: FriendlyClientOptions<T>): ClientOptions<T>;
163
+ interface ConsumeEventIteratorOptions<T, TReturn, TError> {
164
+ /**
165
+ * Called on each event
166
+ */
167
+ onEvent: (event: T) => void;
168
+ /**
169
+ * Called once error happens
170
+ */
171
+ onError?: (error: TError) => void;
172
+ /**
173
+ * Called once event iterator is done
174
+ *
175
+ * @info If iterator is canceled, `undefined` can be passed on success
176
+ */
177
+ onSuccess?: (value: TReturn | undefined) => void;
178
+ /**
179
+ * Called once after onError or onSuccess
180
+ *
181
+ * @info If iterator is canceled, `undefined` can be passed on success
182
+ */
183
+ onFinish?: (state: OnFinishState<TReturn | undefined, TError>) => void;
184
+ }
185
+ /**
186
+ * Consumes an event iterator with lifecycle callbacks
187
+ *
188
+ * @warning If no `onError` or `onFinish` is provided, unhandled rejections will be thrown
189
+ * @return unsubscribe callback
190
+ */
191
+ declare function consumeEventIterator<T, TReturn, TError = ThrowableError>(iterator: AsyncIterator<T, TReturn> | ClientPromiseResult<AsyncIterator<T, TReturn>, TError>, options: ConsumeEventIteratorOptions<T, TReturn, TError>): () => Promise<void>;
150
192
 
151
193
  type SafeClient<T extends NestedClient<any>> = T extends Client<infer UContext, infer UInput, infer UOutput, infer UError> ? (...rest: ClientRest<UContext, UInput>) => Promise<SafeResult<UOutput, UError>> : {
152
194
  [K in keyof T]: T[K] extends NestedClient<any> ? SafeClient<T[K]> : never;
@@ -164,6 +206,9 @@ type SafeClient<T extends NestedClient<any>> = T extends Client<infer UContext,
164
206
  */
165
207
  declare function createSafeClient<T extends NestedClient<any>>(client: T): SafeClient<T>;
166
208
 
209
+ declare const ORPC_CLIENT_PACKAGE_NAME = "@orpc/client";
210
+ declare const ORPC_CLIENT_PACKAGE_VERSION = "0.0.0-next.a55d49f";
211
+
167
212
  /**
168
213
  * DynamicLink provides a way to dynamically resolve and delegate calls to other ClientLinks
169
214
  * based on the request path, input, and context.
@@ -181,5 +226,5 @@ declare function mapEventIterator<TYield, TReturn, TNext, TMap = TYield | TRetur
181
226
  error: (error: unknown) => Promise<unknown>;
182
227
  }): AsyncIteratorClass<TMap, TMap, TNext>;
183
228
 
184
- export { COMMON_ORPC_ERROR_DEFS, Client, ClientContext, ClientLink, ClientOptions, ClientPromiseResult, ClientRest, DynamicLink, FriendlyClientOptions, InferClientContext, NestedClient, ORPCError, createORPCClient, createORPCErrorFromJson, createSafeClient, fallbackORPCErrorMessage, fallbackORPCErrorStatus, isDefinedError, isORPCErrorJson, isORPCErrorStatus, mapEventIterator, resolveFriendlyClientOptions, safe, toORPCError };
185
- export type { CommonORPCErrorCode, ORPCErrorCode, ORPCErrorJSON, ORPCErrorOptions, SafeClient, SafeResult, createORPCClientOptions };
229
+ export { COMMON_ORPC_ERROR_DEFS, Client, ClientContext, ClientLink, ClientOptions, ClientPromiseResult, ClientRest, DynamicLink, FriendlyClientOptions, InferClientContext, NestedClient, ORPCError, ORPC_CLIENT_PACKAGE_NAME, ORPC_CLIENT_PACKAGE_VERSION, consumeEventIterator, createORPCClient, createORPCErrorFromJson, createSafeClient, fallbackORPCErrorMessage, fallbackORPCErrorStatus, isDefinedError, isORPCErrorJson, isORPCErrorStatus, mapEventIterator, resolveFriendlyClientOptions, safe, toORPCError };
230
+ export type { CommonORPCErrorCode, ConsumeEventIteratorOptions, ORPCErrorCode, ORPCErrorJSON, ORPCErrorOptions, SafeClient, SafeResult, createORPCClientOptions };