@orpc/client 0.0.0-next.ea0903c → 0.0.0-next.eaf61c7
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 +18 -22
- package/dist/adapters/fetch/index.d.mts +15 -12
- package/dist/adapters/fetch/index.d.ts +15 -12
- package/dist/adapters/fetch/index.mjs +5 -12
- package/dist/adapters/message-port/index.d.mts +59 -0
- package/dist/adapters/message-port/index.d.ts +59 -0
- package/dist/adapters/message-port/index.mjs +71 -0
- package/dist/adapters/standard/index.d.mts +5 -4
- package/dist/adapters/standard/index.d.ts +5 -4
- package/dist/adapters/standard/index.mjs +2 -2
- package/dist/adapters/websocket/index.d.mts +29 -0
- package/dist/adapters/websocket/index.d.ts +29 -0
- package/dist/adapters/websocket/index.mjs +44 -0
- package/dist/index.d.mts +30 -12
- package/dist/index.d.ts +30 -12
- package/dist/index.mjs +10 -10
- package/dist/plugins/index.d.mts +162 -21
- package/dist/plugins/index.d.ts +162 -21
- package/dist/plugins/index.mjs +306 -43
- package/dist/shared/{client.87WXDX8t.d.mts → client.4TS_0JaO.d.mts} +12 -15
- package/dist/shared/{client.87WXDX8t.d.ts → client.4TS_0JaO.d.ts} +12 -15
- package/dist/shared/{client.CZFIVTQj.d.ts → client.7UM0t5o-.d.ts} +13 -25
- package/dist/shared/{client.D9lmRwGB.d.mts → client.BMoG_EdN.d.mts} +20 -13
- package/dist/shared/{client.BacCdg3F.mjs → client.BX0_8bnM.mjs} +35 -35
- package/dist/shared/{client.BC0T26HA.d.mts → client.BdD8cpjs.d.mts} +13 -25
- package/dist/shared/{client.BaocqKnn.d.ts → client.C0KbSWlC.d.ts} +20 -13
- package/dist/shared/{client.F0iTxiCl.mjs → client.CQCGVpTM.mjs} +43 -26
- package/package.json +16 -5
package/README.md
CHANGED
@@ -21,28 +21,24 @@
|
|
21
21
|
|
22
22
|
<h3 align="center">Typesafe APIs Made Simple 🪄</h3>
|
23
23
|
|
24
|
-
**oRPC is a powerful combination of RPC and OpenAPI**, makes it easy to build APIs that are end-to-end type-safe and adhere to OpenAPI standards
|
24
|
+
**oRPC is a powerful combination of RPC and OpenAPI**, makes it easy to build APIs that are end-to-end type-safe and adhere to OpenAPI standards
|
25
25
|
|
26
26
|
---
|
27
27
|
|
28
28
|
## Highlights
|
29
29
|
|
30
|
-
-
|
31
|
-
-
|
32
|
-
-
|
33
|
-
-
|
34
|
-
-
|
35
|
-
-
|
36
|
-
-
|
37
|
-
-
|
38
|
-
-
|
39
|
-
-
|
40
|
-
-
|
41
|
-
-
|
42
|
-
- **Reusability 🔄**: Write once and reuse your code across multiple purposes effortlessly.
|
43
|
-
- **Extendability 🔌**: Easily enhance oRPC with plugins, middleware, and interceptors.
|
44
|
-
- **Reliability 🛡️**: Well-tested, fully TypeScript, production-ready, and MIT licensed for peace of mind.
|
45
|
-
- **Simplicity 💡**: Enjoy straightforward, clean code with no hidden magic.
|
30
|
+
- **🔗 End-to-End Type Safety**: Ensure type-safe inputs, outputs, and errors from client to server.
|
31
|
+
- **📘 First-Class OpenAPI**: Built-in support that fully adheres to the OpenAPI standard.
|
32
|
+
- **📝 Contract-First Development**: Optionally define your API contract before implementation.
|
33
|
+
- **⚙️ Framework Integrations**: Seamlessly integrate with TanStack Query (React, Vue, Solid, Svelte), Pinia Colada, and more.
|
34
|
+
- **🚀 Server Actions**: Fully compatible with React Server Actions on Next.js, TanStack Start, and other platforms.
|
35
|
+
- **🔠 Standard Schema Support**: Works out of the box with Zod, Valibot, ArkType, and other schema validators.
|
36
|
+
- **🗃️ Native Types**: Supports native types like Date, File, Blob, BigInt, URL, and more.
|
37
|
+
- **⏱️ Lazy Router**: Enhance cold start times with our lazy routing feature.
|
38
|
+
- **📡 SSE & Streaming**: Enjoy full type-safe support for SSE and streaming.
|
39
|
+
- **🌍 Multi-Runtime Support**: Fast and lightweight on Cloudflare, Deno, Bun, Node.js, and beyond.
|
40
|
+
- **🔌 Extendability**: Easily extend functionality with plugins, middleware, and interceptors.
|
41
|
+
- **🛡️ Reliability**: Well-tested, TypeScript-based, production-ready, and MIT licensed.
|
46
42
|
|
47
43
|
## Documentation
|
48
44
|
|
@@ -53,12 +49,12 @@ You can find the full documentation [here](https://orpc.unnoq.com).
|
|
53
49
|
- [@orpc/contract](https://www.npmjs.com/package/@orpc/contract): Build your API contract.
|
54
50
|
- [@orpc/server](https://www.npmjs.com/package/@orpc/server): Build your API or implement API contract.
|
55
51
|
- [@orpc/client](https://www.npmjs.com/package/@orpc/client): Consume your API on the client with type-safety.
|
56
|
-
- [@orpc/react-query](https://www.npmjs.com/package/@orpc/react-query): Integration with [React Query](https://tanstack.com/query/latest/docs/framework/react/overview).
|
57
|
-
- [@orpc/vue-query](https://www.npmjs.com/package/@orpc/vue-query): Integration with [Vue Query](https://tanstack.com/query/latest/docs/framework/vue/overview).
|
58
|
-
- [@orpc/solid-query](https://www.npmjs.com/package/@orpc/solid-query): Integration with [Solid Query](https://tanstack.com/query/latest/docs/framework/solid/overview).
|
59
|
-
- [@orpc/svelte-query](https://www.npmjs.com/package/@orpc/svelte-query): Integration with [Svelte Query](https://tanstack.com/query/latest/docs/framework/svelte/overview).
|
60
|
-
- [@orpc/vue-colada](https://www.npmjs.com/package/@orpc/vue-colada): Integration with [Pinia Colada](https://pinia-colada.esm.dev/).
|
61
52
|
- [@orpc/openapi](https://www.npmjs.com/package/@orpc/openapi): Generate OpenAPI specs and handle OpenAPI requests.
|
53
|
+
- [@orpc/nest](https://www.npmjs.com/package/@orpc/nest): Deeply integrate oRPC with [NestJS](https://nestjs.com/).
|
54
|
+
- [@orpc/react](https://www.npmjs.com/package/@orpc/react): Utilities for integrating oRPC with React and React Server Actions.
|
55
|
+
- [@orpc/tanstack-query](https://www.npmjs.com/package/@orpc/tanstack-query): [TanStack Query](https://tanstack.com/query/latest) integration.
|
56
|
+
- [@orpc/vue-colada](https://www.npmjs.com/package/@orpc/vue-colada): Integration with [Pinia Colada](https://pinia-colada.esm.dev/).
|
57
|
+
- [@orpc/hey-api](https://www.npmjs.com/package/@orpc/hey-api): [Hey API](https://heyapi.dev/) integration.
|
62
58
|
- [@orpc/zod](https://www.npmjs.com/package/@orpc/zod): More schemas that [Zod](https://zod.dev/) doesn't support yet.
|
63
59
|
- [@orpc/valibot](https://www.npmjs.com/package/@orpc/valibot): OpenAPI spec generation from [Valibot](https://valibot.dev/).
|
64
60
|
- [@orpc/arktype](https://www.npmjs.com/package/@orpc/arktype): OpenAPI spec generation from [ArkType](https://arktype.io/).
|
@@ -1,12 +1,14 @@
|
|
1
1
|
import { StandardRequest, StandardLazyResponse } from '@orpc/standard-server';
|
2
2
|
import { ToFetchRequestOptions } from '@orpc/standard-server-fetch';
|
3
|
-
import { a as ClientContext, b as ClientOptions
|
4
|
-
import {
|
5
|
-
import { f as StandardRPCLinkOptions } from '../../shared/client.
|
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
6
|
import '@orpc/shared';
|
7
7
|
|
8
8
|
interface LinkFetchClientOptions<T extends ClientContext> extends ToFetchRequestOptions {
|
9
|
-
fetch?: (request: Request, init:
|
9
|
+
fetch?: (request: Request, init: {
|
10
|
+
redirect?: Request['redirect'];
|
11
|
+
}, options: ClientOptions<T>, path: readonly string[], input: unknown) => Promise<Response>;
|
10
12
|
}
|
11
13
|
declare class LinkFetchClient<T extends ClientContext> implements StandardLinkClient<T> {
|
12
14
|
private readonly fetch;
|
@@ -17,14 +19,15 @@ declare class LinkFetchClient<T extends ClientContext> implements StandardLinkCl
|
|
17
19
|
|
18
20
|
interface RPCLinkOptions<T extends ClientContext> extends StandardRPCLinkOptions<T>, LinkFetchClientOptions<T> {
|
19
21
|
}
|
20
|
-
|
21
|
-
|
22
|
+
/**
|
23
|
+
* The RPC Link communicates with the server using the RPC protocol.
|
24
|
+
*
|
25
|
+
* @see {@link https://orpc.unnoq.com/docs/client/rpc-link RPC Link Docs}
|
26
|
+
* @see {@link https://orpc.unnoq.com/docs/advanced/rpc-protocol RPC Protocol Docs}
|
27
|
+
*/
|
28
|
+
declare class RPCLink<T extends ClientContext> extends StandardRPCLink<T> {
|
22
29
|
constructor(options: RPCLinkOptions<T>);
|
23
|
-
call(path: readonly string[], input: unknown, options: ClientOptions<T>): Promise<unknown>;
|
24
30
|
}
|
25
31
|
|
26
|
-
|
27
|
-
|
28
|
-
}
|
29
|
-
|
30
|
-
export { type FetchWithContext, LinkFetchClient, type LinkFetchClientOptions, RPCLink, type RPCLinkOptions };
|
32
|
+
export { LinkFetchClient, RPCLink };
|
33
|
+
export type { LinkFetchClientOptions, RPCLinkOptions };
|
@@ -1,12 +1,14 @@
|
|
1
1
|
import { StandardRequest, StandardLazyResponse } from '@orpc/standard-server';
|
2
2
|
import { ToFetchRequestOptions } from '@orpc/standard-server-fetch';
|
3
|
-
import { a as ClientContext, b as ClientOptions
|
4
|
-
import {
|
5
|
-
import { f as StandardRPCLinkOptions } from '../../shared/client.
|
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
6
|
import '@orpc/shared';
|
7
7
|
|
8
8
|
interface LinkFetchClientOptions<T extends ClientContext> extends ToFetchRequestOptions {
|
9
|
-
fetch?: (request: Request, init:
|
9
|
+
fetch?: (request: Request, init: {
|
10
|
+
redirect?: Request['redirect'];
|
11
|
+
}, options: ClientOptions<T>, path: readonly string[], input: unknown) => Promise<Response>;
|
10
12
|
}
|
11
13
|
declare class LinkFetchClient<T extends ClientContext> implements StandardLinkClient<T> {
|
12
14
|
private readonly fetch;
|
@@ -17,14 +19,15 @@ declare class LinkFetchClient<T extends ClientContext> implements StandardLinkCl
|
|
17
19
|
|
18
20
|
interface RPCLinkOptions<T extends ClientContext> extends StandardRPCLinkOptions<T>, LinkFetchClientOptions<T> {
|
19
21
|
}
|
20
|
-
|
21
|
-
|
22
|
+
/**
|
23
|
+
* The RPC Link communicates with the server using the RPC protocol.
|
24
|
+
*
|
25
|
+
* @see {@link https://orpc.unnoq.com/docs/client/rpc-link RPC Link Docs}
|
26
|
+
* @see {@link https://orpc.unnoq.com/docs/advanced/rpc-protocol RPC Protocol Docs}
|
27
|
+
*/
|
28
|
+
declare class RPCLink<T extends ClientContext> extends StandardRPCLink<T> {
|
22
29
|
constructor(options: RPCLinkOptions<T>);
|
23
|
-
call(path: readonly string[], input: unknown, options: ClientOptions<T>): Promise<unknown>;
|
24
30
|
}
|
25
31
|
|
26
|
-
|
27
|
-
|
28
|
-
}
|
29
|
-
|
30
|
-
export { type FetchWithContext, LinkFetchClient, type LinkFetchClientOptions, RPCLink, type RPCLinkOptions };
|
32
|
+
export { LinkFetchClient, RPCLink };
|
33
|
+
export type { LinkFetchClientOptions, RPCLinkOptions };
|
@@ -1,8 +1,8 @@
|
|
1
1
|
import { toFetchRequest, toStandardLazyResponse } from '@orpc/standard-server-fetch';
|
2
|
-
import { b as StandardRPCJsonSerializer, c as StandardRPCLinkCodec, d as StandardRPCSerializer, S as StandardLink } from '../../shared/client.F0iTxiCl.mjs';
|
3
2
|
import '@orpc/shared';
|
4
|
-
import '../../shared/client.
|
3
|
+
import { c as StandardRPCLink } from '../../shared/client.CQCGVpTM.mjs';
|
5
4
|
import '@orpc/standard-server';
|
5
|
+
import '../../shared/client.BX0_8bnM.mjs';
|
6
6
|
|
7
7
|
class LinkFetchClient {
|
8
8
|
fetch;
|
@@ -13,23 +13,16 @@ class LinkFetchClient {
|
|
13
13
|
}
|
14
14
|
async call(request, options, path, input) {
|
15
15
|
const fetchRequest = toFetchRequest(request, this.toFetchRequestOptions);
|
16
|
-
const fetchResponse = await this.fetch(fetchRequest, {}, options, path, input);
|
16
|
+
const fetchResponse = await this.fetch(fetchRequest, { redirect: "manual" }, options, path, input);
|
17
17
|
const lazyResponse = toStandardLazyResponse(fetchResponse);
|
18
18
|
return lazyResponse;
|
19
19
|
}
|
20
20
|
}
|
21
21
|
|
22
|
-
class RPCLink {
|
23
|
-
standardLink;
|
22
|
+
class RPCLink extends StandardRPCLink {
|
24
23
|
constructor(options) {
|
25
|
-
const jsonSerializer = new StandardRPCJsonSerializer(options);
|
26
|
-
const serializer = new StandardRPCSerializer(jsonSerializer);
|
27
|
-
const linkCodec = new StandardRPCLinkCodec(serializer, options);
|
28
24
|
const linkClient = new LinkFetchClient(options);
|
29
|
-
|
30
|
-
}
|
31
|
-
async call(path, input, options) {
|
32
|
-
return this.standardLink.call(path, input, options);
|
25
|
+
super(linkClient, options);
|
33
26
|
}
|
34
27
|
}
|
35
28
|
|
@@ -0,0 +1,59 @@
|
|
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';
|
5
|
+
import '@orpc/shared';
|
6
|
+
|
7
|
+
/**
|
8
|
+
* The message port used by electron in main process
|
9
|
+
*/
|
10
|
+
interface MessagePortMainLike {
|
11
|
+
on: <T extends string>(event: T, callback: (event?: {
|
12
|
+
data: any;
|
13
|
+
}) => void) => void;
|
14
|
+
postMessage: (data: any) => void;
|
15
|
+
}
|
16
|
+
/**
|
17
|
+
* The message port used by browser extension
|
18
|
+
*/
|
19
|
+
interface BrowserPortLike {
|
20
|
+
onMessage: {
|
21
|
+
addListener: (callback: (data: any) => void) => void;
|
22
|
+
};
|
23
|
+
onDisconnect: {
|
24
|
+
addListener: (callback: () => void) => void;
|
25
|
+
};
|
26
|
+
postMessage: (data: any) => void;
|
27
|
+
}
|
28
|
+
type SupportedMessagePort = Pick<MessagePort, 'addEventListener' | 'postMessage'> | MessagePortMainLike | BrowserPortLike;
|
29
|
+
/**
|
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
|
+
*/
|
32
|
+
type SupportedMessagePortData = string | ArrayBufferLike;
|
33
|
+
declare function postMessagePortMessage(port: SupportedMessagePort, data: SupportedMessagePortData): void;
|
34
|
+
declare function onMessagePortMessage(port: SupportedMessagePort, callback: (data: SupportedMessagePortData) => void): void;
|
35
|
+
declare function onMessagePortClose(port: SupportedMessagePort, callback: () => void): void;
|
36
|
+
|
37
|
+
interface experimental_LinkMessagePortClientOptions {
|
38
|
+
port: SupportedMessagePort;
|
39
|
+
}
|
40
|
+
declare class experimental_LinkMessagePortClient<T extends ClientContext> implements StandardLinkClient<T> {
|
41
|
+
private readonly peer;
|
42
|
+
constructor(options: experimental_LinkMessagePortClientOptions);
|
43
|
+
call(request: StandardRequest, _options: ClientOptions<T>, _path: readonly string[], _input: unknown): Promise<StandardLazyResponse>;
|
44
|
+
}
|
45
|
+
|
46
|
+
interface experimental_RPCLinkOptions<T extends ClientContext> extends Omit<StandardRPCLinkOptions<T>, 'url' | 'headers' | 'method' | 'fallbackMethod' | 'maxUrlLength'>, experimental_LinkMessagePortClientOptions {
|
47
|
+
}
|
48
|
+
/**
|
49
|
+
* The RPC Link for common message port implementations.
|
50
|
+
*
|
51
|
+
* @see {@link https://orpc.unnoq.com/docs/client/rpc-link RPC Link Docs}
|
52
|
+
* @see {@link https://orpc.unnoq.com/docs/adapters/message-port Message Port Adapter Docs}
|
53
|
+
*/
|
54
|
+
declare class experimental_RPCLink<T extends ClientContext> extends StandardRPCLink<T> {
|
55
|
+
constructor(options: experimental_RPCLinkOptions<T>);
|
56
|
+
}
|
57
|
+
|
58
|
+
export { experimental_LinkMessagePortClient, experimental_RPCLink, onMessagePortClose, onMessagePortMessage, postMessagePortMessage };
|
59
|
+
export type { BrowserPortLike, MessagePortMainLike, SupportedMessagePort, SupportedMessagePortData, experimental_LinkMessagePortClientOptions, experimental_RPCLinkOptions };
|
@@ -0,0 +1,59 @@
|
|
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';
|
5
|
+
import '@orpc/shared';
|
6
|
+
|
7
|
+
/**
|
8
|
+
* The message port used by electron in main process
|
9
|
+
*/
|
10
|
+
interface MessagePortMainLike {
|
11
|
+
on: <T extends string>(event: T, callback: (event?: {
|
12
|
+
data: any;
|
13
|
+
}) => void) => void;
|
14
|
+
postMessage: (data: any) => void;
|
15
|
+
}
|
16
|
+
/**
|
17
|
+
* The message port used by browser extension
|
18
|
+
*/
|
19
|
+
interface BrowserPortLike {
|
20
|
+
onMessage: {
|
21
|
+
addListener: (callback: (data: any) => void) => void;
|
22
|
+
};
|
23
|
+
onDisconnect: {
|
24
|
+
addListener: (callback: () => void) => void;
|
25
|
+
};
|
26
|
+
postMessage: (data: any) => void;
|
27
|
+
}
|
28
|
+
type SupportedMessagePort = Pick<MessagePort, 'addEventListener' | 'postMessage'> | MessagePortMainLike | BrowserPortLike;
|
29
|
+
/**
|
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
|
+
*/
|
32
|
+
type SupportedMessagePortData = string | ArrayBufferLike;
|
33
|
+
declare function postMessagePortMessage(port: SupportedMessagePort, data: SupportedMessagePortData): void;
|
34
|
+
declare function onMessagePortMessage(port: SupportedMessagePort, callback: (data: SupportedMessagePortData) => void): void;
|
35
|
+
declare function onMessagePortClose(port: SupportedMessagePort, callback: () => void): void;
|
36
|
+
|
37
|
+
interface experimental_LinkMessagePortClientOptions {
|
38
|
+
port: SupportedMessagePort;
|
39
|
+
}
|
40
|
+
declare class experimental_LinkMessagePortClient<T extends ClientContext> implements StandardLinkClient<T> {
|
41
|
+
private readonly peer;
|
42
|
+
constructor(options: experimental_LinkMessagePortClientOptions);
|
43
|
+
call(request: StandardRequest, _options: ClientOptions<T>, _path: readonly string[], _input: unknown): Promise<StandardLazyResponse>;
|
44
|
+
}
|
45
|
+
|
46
|
+
interface experimental_RPCLinkOptions<T extends ClientContext> extends Omit<StandardRPCLinkOptions<T>, 'url' | 'headers' | 'method' | 'fallbackMethod' | 'maxUrlLength'>, experimental_LinkMessagePortClientOptions {
|
47
|
+
}
|
48
|
+
/**
|
49
|
+
* The RPC Link for common message port implementations.
|
50
|
+
*
|
51
|
+
* @see {@link https://orpc.unnoq.com/docs/client/rpc-link RPC Link Docs}
|
52
|
+
* @see {@link https://orpc.unnoq.com/docs/adapters/message-port Message Port Adapter Docs}
|
53
|
+
*/
|
54
|
+
declare class experimental_RPCLink<T extends ClientContext> extends StandardRPCLink<T> {
|
55
|
+
constructor(options: experimental_RPCLinkOptions<T>);
|
56
|
+
}
|
57
|
+
|
58
|
+
export { experimental_LinkMessagePortClient, experimental_RPCLink, onMessagePortClose, onMessagePortMessage, postMessagePortMessage };
|
59
|
+
export type { BrowserPortLike, MessagePortMainLike, SupportedMessagePort, SupportedMessagePortData, experimental_LinkMessagePortClientOptions, experimental_RPCLinkOptions };
|
@@ -0,0 +1,71 @@
|
|
1
|
+
import { ClientPeer } from '@orpc/standard-server-peer';
|
2
|
+
import '@orpc/shared';
|
3
|
+
import { c as StandardRPCLink } from '../../shared/client.CQCGVpTM.mjs';
|
4
|
+
import '@orpc/standard-server';
|
5
|
+
import '../../shared/client.BX0_8bnM.mjs';
|
6
|
+
|
7
|
+
function postMessagePortMessage(port, data) {
|
8
|
+
port.postMessage(data);
|
9
|
+
}
|
10
|
+
function onMessagePortMessage(port, callback) {
|
11
|
+
if ("addEventListener" in port) {
|
12
|
+
port.addEventListener("message", (event) => {
|
13
|
+
callback(event.data);
|
14
|
+
});
|
15
|
+
} else if ("on" in port) {
|
16
|
+
port.on("message", (event) => {
|
17
|
+
callback(event?.data);
|
18
|
+
});
|
19
|
+
} else if ("onMessage" in port) {
|
20
|
+
port.onMessage.addListener((data) => {
|
21
|
+
callback(data);
|
22
|
+
});
|
23
|
+
} else {
|
24
|
+
throw new Error("Cannot find a addEventListener/on/onMessage method on the port");
|
25
|
+
}
|
26
|
+
}
|
27
|
+
function onMessagePortClose(port, callback) {
|
28
|
+
if ("addEventListener" in port) {
|
29
|
+
port.addEventListener("close", async () => {
|
30
|
+
callback();
|
31
|
+
});
|
32
|
+
} else if ("on" in port) {
|
33
|
+
port.on("close", async () => {
|
34
|
+
callback();
|
35
|
+
});
|
36
|
+
} else if ("onDisconnect" in port) {
|
37
|
+
port.onDisconnect.addListener(() => {
|
38
|
+
callback();
|
39
|
+
});
|
40
|
+
} else {
|
41
|
+
throw new Error("Cannot find a addEventListener/on/onDisconnect method on the port");
|
42
|
+
}
|
43
|
+
}
|
44
|
+
|
45
|
+
class experimental_LinkMessagePortClient {
|
46
|
+
peer;
|
47
|
+
constructor(options) {
|
48
|
+
this.peer = new ClientPeer((message) => {
|
49
|
+
return postMessagePortMessage(options.port, message);
|
50
|
+
});
|
51
|
+
onMessagePortMessage(options.port, async (message) => {
|
52
|
+
await this.peer.message(message);
|
53
|
+
});
|
54
|
+
onMessagePortClose(options.port, () => {
|
55
|
+
this.peer.close();
|
56
|
+
});
|
57
|
+
}
|
58
|
+
async call(request, _options, _path, _input) {
|
59
|
+
const response = await this.peer.request(request);
|
60
|
+
return { ...response, body: () => Promise.resolve(response.body) };
|
61
|
+
}
|
62
|
+
}
|
63
|
+
|
64
|
+
class experimental_RPCLink extends StandardRPCLink {
|
65
|
+
constructor(options) {
|
66
|
+
const linkClient = new experimental_LinkMessagePortClient(options);
|
67
|
+
super(linkClient, { ...options, url: "orpc:/" });
|
68
|
+
}
|
69
|
+
}
|
70
|
+
|
71
|
+
export { experimental_LinkMessagePortClient, experimental_RPCLink, onMessagePortClose, onMessagePortMessage, postMessagePortMessage };
|
@@ -1,9 +1,10 @@
|
|
1
|
-
export {
|
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,
|
3
|
-
import { H as HTTPPath } from '../../shared/client.
|
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';
|
4
4
|
import '@orpc/shared';
|
5
5
|
import '@orpc/standard-server';
|
6
6
|
|
7
7
|
declare function toHttpPath(path: readonly string[]): HTTPPath;
|
8
|
+
declare function getMalformedResponseErrorCode(status: number): string;
|
8
9
|
|
9
|
-
export { toHttpPath };
|
10
|
+
export { getMalformedResponseErrorCode, toHttpPath };
|
@@ -1,9 +1,10 @@
|
|
1
|
-
export {
|
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,
|
3
|
-
import { H as HTTPPath } from '../../shared/client.
|
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';
|
4
4
|
import '@orpc/shared';
|
5
5
|
import '@orpc/standard-server';
|
6
6
|
|
7
7
|
declare function toHttpPath(path: readonly string[]): HTTPPath;
|
8
|
+
declare function getMalformedResponseErrorCode(status: number): string;
|
8
9
|
|
9
|
-
export { toHttpPath };
|
10
|
+
export { getMalformedResponseErrorCode, toHttpPath };
|
@@ -1,4 +1,4 @@
|
|
1
|
-
export {
|
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';
|
2
2
|
import '@orpc/shared';
|
3
|
-
import '../../shared/client.BacCdg3F.mjs';
|
4
3
|
import '@orpc/standard-server';
|
4
|
+
import '../../shared/client.BX0_8bnM.mjs';
|
@@ -0,0 +1,29 @@
|
|
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';
|
5
|
+
import '@orpc/shared';
|
6
|
+
|
7
|
+
interface experimental_LinkWebsocketClientOptions {
|
8
|
+
websocket: Pick<WebSocket, 'addEventListener' | 'send' | 'readyState'>;
|
9
|
+
}
|
10
|
+
declare class experimental_LinkWebsocketClient<T extends ClientContext> implements StandardLinkClient<T> {
|
11
|
+
private readonly peer;
|
12
|
+
constructor(options: experimental_LinkWebsocketClientOptions);
|
13
|
+
call(request: StandardRequest, _options: ClientOptions<T>, _path: readonly string[], _input: unknown): Promise<StandardLazyResponse>;
|
14
|
+
}
|
15
|
+
|
16
|
+
interface experimental_RPCLinkOptions<T extends ClientContext> extends Omit<StandardRPCLinkOptions<T>, 'url' | 'headers' | 'method' | 'fallbackMethod' | 'maxUrlLength'>, experimental_LinkWebsocketClientOptions {
|
17
|
+
}
|
18
|
+
/**
|
19
|
+
* The RPC Link communicates with the server using the RPC protocol over WebSocket.
|
20
|
+
*
|
21
|
+
* @see {@link https://orpc.unnoq.com/docs/client/rpc-link RPC Link Docs}
|
22
|
+
* @see {@link https://orpc.unnoq.com/docs/adapters/websocket WebSocket Adapter Docs}
|
23
|
+
*/
|
24
|
+
declare class experimental_RPCLink<T extends ClientContext> extends StandardRPCLink<T> {
|
25
|
+
constructor(options: experimental_RPCLinkOptions<T>);
|
26
|
+
}
|
27
|
+
|
28
|
+
export { experimental_LinkWebsocketClient, experimental_RPCLink };
|
29
|
+
export type { experimental_LinkWebsocketClientOptions, experimental_RPCLinkOptions };
|
@@ -0,0 +1,29 @@
|
|
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';
|
5
|
+
import '@orpc/shared';
|
6
|
+
|
7
|
+
interface experimental_LinkWebsocketClientOptions {
|
8
|
+
websocket: Pick<WebSocket, 'addEventListener' | 'send' | 'readyState'>;
|
9
|
+
}
|
10
|
+
declare class experimental_LinkWebsocketClient<T extends ClientContext> implements StandardLinkClient<T> {
|
11
|
+
private readonly peer;
|
12
|
+
constructor(options: experimental_LinkWebsocketClientOptions);
|
13
|
+
call(request: StandardRequest, _options: ClientOptions<T>, _path: readonly string[], _input: unknown): Promise<StandardLazyResponse>;
|
14
|
+
}
|
15
|
+
|
16
|
+
interface experimental_RPCLinkOptions<T extends ClientContext> extends Omit<StandardRPCLinkOptions<T>, 'url' | 'headers' | 'method' | 'fallbackMethod' | 'maxUrlLength'>, experimental_LinkWebsocketClientOptions {
|
17
|
+
}
|
18
|
+
/**
|
19
|
+
* The RPC Link communicates with the server using the RPC protocol over WebSocket.
|
20
|
+
*
|
21
|
+
* @see {@link https://orpc.unnoq.com/docs/client/rpc-link RPC Link Docs}
|
22
|
+
* @see {@link https://orpc.unnoq.com/docs/adapters/websocket WebSocket Adapter Docs}
|
23
|
+
*/
|
24
|
+
declare class experimental_RPCLink<T extends ClientContext> extends StandardRPCLink<T> {
|
25
|
+
constructor(options: experimental_RPCLinkOptions<T>);
|
26
|
+
}
|
27
|
+
|
28
|
+
export { experimental_LinkWebsocketClient, experimental_RPCLink };
|
29
|
+
export type { experimental_LinkWebsocketClientOptions, experimental_RPCLinkOptions };
|
@@ -0,0 +1,44 @@
|
|
1
|
+
import { ClientPeer } from '@orpc/standard-server-peer';
|
2
|
+
import '@orpc/shared';
|
3
|
+
import { c as StandardRPCLink } from '../../shared/client.CQCGVpTM.mjs';
|
4
|
+
import '@orpc/standard-server';
|
5
|
+
import '../../shared/client.BX0_8bnM.mjs';
|
6
|
+
|
7
|
+
class experimental_LinkWebsocketClient {
|
8
|
+
peer;
|
9
|
+
constructor(options) {
|
10
|
+
const untilOpen = new Promise((resolve) => {
|
11
|
+
if (options.websocket.readyState === 0) {
|
12
|
+
options.websocket.addEventListener("open", () => {
|
13
|
+
resolve();
|
14
|
+
}, { once: true });
|
15
|
+
} else {
|
16
|
+
resolve();
|
17
|
+
}
|
18
|
+
});
|
19
|
+
this.peer = new ClientPeer(async (message) => {
|
20
|
+
await untilOpen;
|
21
|
+
return options.websocket.send(message);
|
22
|
+
});
|
23
|
+
options.websocket.addEventListener("message", async (event) => {
|
24
|
+
const message = event.data instanceof Blob ? await event.data.arrayBuffer() : event.data;
|
25
|
+
this.peer.message(message);
|
26
|
+
});
|
27
|
+
options.websocket.addEventListener("close", () => {
|
28
|
+
this.peer.close();
|
29
|
+
});
|
30
|
+
}
|
31
|
+
async call(request, _options, _path, _input) {
|
32
|
+
const response = await this.peer.request(request);
|
33
|
+
return { ...response, body: () => Promise.resolve(response.body) };
|
34
|
+
}
|
35
|
+
}
|
36
|
+
|
37
|
+
class experimental_RPCLink extends StandardRPCLink {
|
38
|
+
constructor(options) {
|
39
|
+
const linkClient = new experimental_LinkWebsocketClient(options);
|
40
|
+
super(linkClient, { ...options, url: "orpc:/" });
|
41
|
+
}
|
42
|
+
}
|
43
|
+
|
44
|
+
export { experimental_LinkWebsocketClient, experimental_RPCLink };
|
package/dist/index.d.mts
CHANGED
@@ -1,7 +1,7 @@
|
|
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.
|
2
|
-
export { f as Client, e as ClientRest, d as HTTPMethod, H as HTTPPath } from './shared/client.
|
3
|
-
import { Promisable, MaybeOptionalOptions } from '@orpc/shared';
|
4
|
-
export { onError, onFinish, onStart, onSuccess } from '@orpc/shared';
|
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';
|
5
5
|
export { ErrorEvent } from '@orpc/standard-server';
|
6
6
|
|
7
7
|
interface createORPCClientOptions {
|
@@ -10,11 +10,18 @@ interface createORPCClientOptions {
|
|
10
10
|
*/
|
11
11
|
path?: string[];
|
12
12
|
}
|
13
|
+
/**
|
14
|
+
* Create a oRPC client-side client from a link.
|
15
|
+
*
|
16
|
+
* @see {@link https://orpc.unnoq.com/docs/client/client-side Client-side Client Docs}
|
17
|
+
*/
|
13
18
|
declare function createORPCClient<T extends NestedClient<any>>(link: ClientLink<InferClientContext<T>>, options?: createORPCClientOptions): T;
|
14
19
|
|
15
20
|
/**
|
16
21
|
* DynamicLink provides a way to dynamically resolve and delegate calls to other ClientLinks
|
17
22
|
* based on the request path, input, and context.
|
23
|
+
*
|
24
|
+
* @see {@link https://orpc.unnoq.com/docs/client/dynamic-link Dynamic Link Docs}
|
18
25
|
*/
|
19
26
|
declare class DynamicLink<TClientContext extends ClientContext> implements ClientLink<TClientContext> {
|
20
27
|
private readonly linkResolver;
|
@@ -120,32 +127,43 @@ declare class ORPCError<TCode extends ORPCErrorCode, TData> extends Error {
|
|
120
127
|
readonly data: TData;
|
121
128
|
constructor(code: TCode, ...[options]: MaybeOptionalOptions<ORPCErrorOptions<TData>>);
|
122
129
|
toJSON(): ORPCErrorJSON<TCode, TData>;
|
123
|
-
static fromJSON<TCode extends ORPCErrorCode, TData>(json: ORPCErrorJSON<TCode, TData>, options?: ErrorOptions): ORPCError<TCode, TData>;
|
124
|
-
static isValidJSON(json: unknown): json is ORPCErrorJSON<ORPCErrorCode, unknown>;
|
125
130
|
}
|
126
131
|
type ORPCErrorJSON<TCode extends string, TData> = Pick<ORPCError<TCode, TData>, 'defined' | 'code' | 'status' | 'message' | 'data'>;
|
127
132
|
declare function isDefinedError<T>(error: T): error is Extract<T, ORPCError<any, any>>;
|
128
133
|
declare function toORPCError(error: unknown): ORPCError<any, any>;
|
134
|
+
declare function isORPCErrorStatus(status: number): boolean;
|
135
|
+
declare function isORPCErrorJson(json: unknown): json is ORPCErrorJSON<ORPCErrorCode, unknown>;
|
136
|
+
declare function createORPCErrorFromJson<TCode extends ORPCErrorCode, TData>(json: ORPCErrorJSON<TCode, TData>, options?: ErrorOptions): ORPCError<TCode, TData>;
|
129
137
|
|
130
138
|
declare function mapEventIterator<TYield, TReturn, TNext, TMap = TYield | TReturn>(iterator: AsyncIterator<TYield, TReturn, TNext>, maps: {
|
131
139
|
value: (value: NoInfer<TYield | TReturn>, done: boolean | undefined) => Promise<TMap>;
|
132
140
|
error: (error: unknown) => Promise<unknown>;
|
133
|
-
}):
|
141
|
+
}): AsyncIteratorClass<TMap, TMap, TNext>;
|
134
142
|
|
135
|
-
type SafeResult<TOutput, TError
|
143
|
+
type SafeResult<TOutput, TError> = [error: null, data: TOutput, isDefined: false, isSuccess: true] & {
|
136
144
|
error: null;
|
137
145
|
data: TOutput;
|
138
146
|
isDefined: false;
|
139
|
-
|
147
|
+
isSuccess: true;
|
148
|
+
} | [error: Exclude<TError, ORPCError<any, any>>, data: undefined, isDefined: false, isSuccess: false] & {
|
140
149
|
error: Exclude<TError, ORPCError<any, any>>;
|
141
150
|
data: undefined;
|
142
151
|
isDefined: false;
|
143
|
-
|
152
|
+
isSuccess: false;
|
153
|
+
} | [error: Extract<TError, ORPCError<any, any>>, data: undefined, isDefined: true, isSuccess: false] & {
|
144
154
|
error: Extract<TError, ORPCError<any, any>>;
|
145
155
|
data: undefined;
|
146
156
|
isDefined: true;
|
157
|
+
isSuccess: false;
|
147
158
|
};
|
148
|
-
|
159
|
+
/**
|
160
|
+
* Works like try/catch, but can infer error types.
|
161
|
+
*
|
162
|
+
* @info support both tuple `[error, data, isDefined, isSuccess]` and object `{ error, data, isDefined, isSuccess }` styles.
|
163
|
+
* @see {@link https://orpc.unnoq.com/docs/client/error-handling Client Error Handling Docs}
|
164
|
+
*/
|
165
|
+
declare function safe<TOutput, TError = ThrowableError>(promise: ClientPromiseResult<TOutput, TError>): Promise<SafeResult<TOutput, TError>>;
|
149
166
|
declare function resolveFriendlyClientOptions<T extends ClientContext>(options: FriendlyClientOptions<T>): ClientOptions<T>;
|
150
167
|
|
151
|
-
export { COMMON_ORPC_ERROR_DEFS, ClientContext, ClientLink, ClientOptions, ClientPromiseResult,
|
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 };
|