@orpc/client 0.0.0-next.f81b4a2 → 0.0.0-next.f9e0a4c
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 +3 -3
- package/dist/adapters/fetch/index.d.ts +3 -3
- package/dist/adapters/fetch/index.mjs +3 -3
- 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 +3 -3
- package/dist/adapters/standard/index.d.ts +3 -3
- 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 +45 -0
- package/dist/index.d.mts +41 -25
- package/dist/index.d.ts +41 -25
- package/dist/index.mjs +24 -7
- package/dist/plugins/index.d.mts +58 -18
- package/dist/plugins/index.d.ts +58 -18
- package/dist/plugins/index.mjs +125 -16
- package/dist/shared/{client.C9U9n1f3.d.ts → client.BG98rYdO.d.ts} +4 -5
- package/dist/shared/{client.CipPQkhk.d.mts → client.BOYsZIRq.d.mts} +2 -2
- package/dist/shared/{client.CipPQkhk.d.ts → client.BOYsZIRq.d.ts} +2 -2
- package/dist/shared/{client.FXep-a3a.d.mts → client.Bwgm6dgk.d.mts} +4 -5
- package/dist/shared/{client.8TjrVhkC.d.ts → client.C176log5.d.ts} +8 -8
- package/dist/shared/{client.DpICn1BD.mjs → client.DKmRtVO2.mjs} +50 -15
- package/dist/shared/{client.BjJBZryq.d.mts → client.Ycwr4Tuo.d.mts} +8 -8
- package/dist/shared/{client.CRWEpqLB.mjs → client.txdq_i5V.mjs} +37 -32
- 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
|
+
- **🔍 First-Class OpenTelemetry**: Seamlessly integrate with OpenTelemetry for observability.
|
34
|
+
- **⚙️ Framework Integrations**: Seamlessly integrate with TanStack Query (React, Vue, Solid, Svelte, Angular), Pinia Colada, and more.
|
35
|
+
- **🚀 Server Actions**: Fully compatible with React Server Actions on Next.js, TanStack Start, and other platforms.
|
36
|
+
- **🔠 Standard Schema Support**: Works out of the box with Zod, Valibot, ArkType, and other schema validators.
|
37
|
+
- **🗃️ Native Types**: Supports native types like Date, File, Blob, BigInt, URL, and more.
|
38
|
+
- **⏱️ Lazy Router**: Enhance cold start times with our lazy routing feature.
|
39
|
+
- **📡 SSE & Streaming**: Enjoy full type-safe support for SSE and streaming.
|
40
|
+
- **🌍 Multi-Runtime Support**: Fast and lightweight on Cloudflare, Deno, Bun, Node.js, and beyond.
|
41
|
+
- **🔌 Extendability**: Easily extend functionality with plugins, middleware, and interceptors.
|
46
42
|
|
47
43
|
## Documentation
|
48
44
|
|
@@ -53,13 +49,13 @@ 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.
|
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.
|
54
|
+
- [@orpc/nest](https://www.npmjs.com/package/@orpc/nest): Deeply integrate oRPC with [NestJS](https://nestjs.com/).
|
56
55
|
- [@orpc/react](https://www.npmjs.com/package/@orpc/react): Utilities for integrating oRPC with React and React Server Actions.
|
57
|
-
- [@orpc/
|
58
|
-
- [@orpc/vue-query](https://www.npmjs.com/package/@orpc/vue-query): Integration with [Vue Query](https://tanstack.com/query/latest/docs/framework/vue/overview).
|
59
|
-
- [@orpc/solid-query](https://www.npmjs.com/package/@orpc/solid-query): Integration with [Solid Query](https://tanstack.com/query/latest/docs/framework/solid/overview).
|
60
|
-
- [@orpc/svelte-query](https://www.npmjs.com/package/@orpc/svelte-query): Integration with [Svelte Query](https://tanstack.com/query/latest/docs/framework/svelte/overview).
|
56
|
+
- [@orpc/tanstack-query](https://www.npmjs.com/package/@orpc/tanstack-query): [TanStack Query](https://tanstack.com/query/latest) integration.
|
61
57
|
- [@orpc/vue-colada](https://www.npmjs.com/package/@orpc/vue-colada): Integration with [Pinia Colada](https://pinia-colada.esm.dev/).
|
62
|
-
- [@orpc/
|
58
|
+
- [@orpc/hey-api](https://www.npmjs.com/package/@orpc/hey-api): [Hey API](https://heyapi.dev/) integration.
|
63
59
|
- [@orpc/zod](https://www.npmjs.com/package/@orpc/zod): More schemas that [Zod](https://zod.dev/) doesn't support yet.
|
64
60
|
- [@orpc/valibot](https://www.npmjs.com/package/@orpc/valibot): OpenAPI spec generation from [Valibot](https://valibot.dev/).
|
65
61
|
- [@orpc/arktype](https://www.npmjs.com/package/@orpc/arktype): OpenAPI spec generation from [ArkType](https://arktype.io/).
|
@@ -1,8 +1,8 @@
|
|
1
1
|
import { StandardRequest, StandardLazyResponse } from '@orpc/standard-server';
|
2
2
|
import { ToFetchRequestOptions } from '@orpc/standard-server-fetch';
|
3
|
-
import {
|
4
|
-
import { f as StandardLinkClient } from '../../shared/client.
|
5
|
-
import { f as StandardRPCLinkOptions, g as StandardRPCLink } from '../../shared/client.
|
3
|
+
import { b as ClientContext, c as ClientOptions } from '../../shared/client.BOYsZIRq.mjs';
|
4
|
+
import { f as StandardLinkClient } from '../../shared/client.Bwgm6dgk.mjs';
|
5
|
+
import { f as StandardRPCLinkOptions, g as StandardRPCLink } from '../../shared/client.Ycwr4Tuo.mjs';
|
6
6
|
import '@orpc/shared';
|
7
7
|
|
8
8
|
interface LinkFetchClientOptions<T extends ClientContext> extends ToFetchRequestOptions {
|
@@ -1,8 +1,8 @@
|
|
1
1
|
import { StandardRequest, StandardLazyResponse } from '@orpc/standard-server';
|
2
2
|
import { ToFetchRequestOptions } from '@orpc/standard-server-fetch';
|
3
|
-
import {
|
4
|
-
import { f as StandardLinkClient } from '../../shared/client.
|
5
|
-
import { f as StandardRPCLinkOptions, g as StandardRPCLink } from '../../shared/client.
|
3
|
+
import { b as ClientContext, c as ClientOptions } from '../../shared/client.BOYsZIRq.js';
|
4
|
+
import { f as StandardLinkClient } from '../../shared/client.BG98rYdO.js';
|
5
|
+
import { f as StandardRPCLinkOptions, g as StandardRPCLink } from '../../shared/client.C176log5.js';
|
6
6
|
import '@orpc/shared';
|
7
7
|
|
8
8
|
interface LinkFetchClientOptions<T extends ClientContext> extends ToFetchRequestOptions {
|
@@ -1,8 +1,8 @@
|
|
1
1
|
import { toFetchRequest, toStandardLazyResponse } from '@orpc/standard-server-fetch';
|
2
2
|
import '@orpc/shared';
|
3
|
-
import { c as StandardRPCLink } from '../../shared/client.
|
3
|
+
import { c as StandardRPCLink } from '../../shared/client.DKmRtVO2.mjs';
|
4
4
|
import '@orpc/standard-server';
|
5
|
-
import '../../shared/client.
|
5
|
+
import '../../shared/client.txdq_i5V.mjs';
|
6
6
|
|
7
7
|
class LinkFetchClient {
|
8
8
|
fetch;
|
@@ -14,7 +14,7 @@ class LinkFetchClient {
|
|
14
14
|
async call(request, options, path, input) {
|
15
15
|
const fetchRequest = toFetchRequest(request, this.toFetchRequestOptions);
|
16
16
|
const fetchResponse = await this.fetch(fetchRequest, { redirect: "manual" }, options, path, input);
|
17
|
-
const lazyResponse = toStandardLazyResponse(fetchResponse);
|
17
|
+
const lazyResponse = toStandardLazyResponse(fetchResponse, { signal: fetchRequest.signal });
|
18
18
|
return lazyResponse;
|
19
19
|
}
|
20
20
|
}
|
@@ -0,0 +1,59 @@
|
|
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.Bwgm6dgk.mjs';
|
4
|
+
import { f as StandardRPCLinkOptions, g as StandardRPCLink } from '../../shared/client.Ycwr4Tuo.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 | Uint8Array;
|
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 LinkMessagePortClientOptions {
|
38
|
+
port: SupportedMessagePort;
|
39
|
+
}
|
40
|
+
declare class LinkMessagePortClient<T extends ClientContext> implements StandardLinkClient<T> {
|
41
|
+
private readonly peer;
|
42
|
+
constructor(options: LinkMessagePortClientOptions);
|
43
|
+
call(request: StandardRequest, _options: ClientOptions<T>, _path: readonly string[], _input: unknown): Promise<StandardLazyResponse>;
|
44
|
+
}
|
45
|
+
|
46
|
+
interface RPCLinkOptions<T extends ClientContext> extends Omit<StandardRPCLinkOptions<T>, 'url' | 'method' | 'fallbackMethod' | 'maxUrlLength'>, 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 RPCLink<T extends ClientContext> extends StandardRPCLink<T> {
|
55
|
+
constructor(options: RPCLinkOptions<T>);
|
56
|
+
}
|
57
|
+
|
58
|
+
export { LinkMessagePortClient, RPCLink, onMessagePortClose, onMessagePortMessage, postMessagePortMessage };
|
59
|
+
export type { BrowserPortLike, LinkMessagePortClientOptions, MessagePortMainLike, RPCLinkOptions, SupportedMessagePort, SupportedMessagePortData };
|
@@ -0,0 +1,59 @@
|
|
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.BG98rYdO.js';
|
4
|
+
import { f as StandardRPCLinkOptions, g as StandardRPCLink } from '../../shared/client.C176log5.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 | Uint8Array;
|
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 LinkMessagePortClientOptions {
|
38
|
+
port: SupportedMessagePort;
|
39
|
+
}
|
40
|
+
declare class LinkMessagePortClient<T extends ClientContext> implements StandardLinkClient<T> {
|
41
|
+
private readonly peer;
|
42
|
+
constructor(options: LinkMessagePortClientOptions);
|
43
|
+
call(request: StandardRequest, _options: ClientOptions<T>, _path: readonly string[], _input: unknown): Promise<StandardLazyResponse>;
|
44
|
+
}
|
45
|
+
|
46
|
+
interface RPCLinkOptions<T extends ClientContext> extends Omit<StandardRPCLinkOptions<T>, 'url' | 'method' | 'fallbackMethod' | 'maxUrlLength'>, 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 RPCLink<T extends ClientContext> extends StandardRPCLink<T> {
|
55
|
+
constructor(options: RPCLinkOptions<T>);
|
56
|
+
}
|
57
|
+
|
58
|
+
export { LinkMessagePortClient, RPCLink, onMessagePortClose, onMessagePortMessage, postMessagePortMessage };
|
59
|
+
export type { BrowserPortLike, LinkMessagePortClientOptions, MessagePortMainLike, RPCLinkOptions, SupportedMessagePort, SupportedMessagePortData };
|
@@ -0,0 +1,71 @@
|
|
1
|
+
import { ClientPeer } from '@orpc/standard-server-peer';
|
2
|
+
import '@orpc/shared';
|
3
|
+
import { c as StandardRPCLink } from '../../shared/client.DKmRtVO2.mjs';
|
4
|
+
import '@orpc/standard-server';
|
5
|
+
import '../../shared/client.txdq_i5V.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 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 RPCLink extends StandardRPCLink {
|
65
|
+
constructor(options) {
|
66
|
+
const linkClient = new LinkMessagePortClient(options);
|
67
|
+
super(linkClient, { ...options, url: "orpc:/" });
|
68
|
+
}
|
69
|
+
}
|
70
|
+
|
71
|
+
export { LinkMessagePortClient, RPCLink, onMessagePortClose, onMessagePortMessage, postMessagePortMessage };
|
@@ -1,6 +1,6 @@
|
|
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.
|
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.
|
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.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.Ycwr4Tuo.mjs';
|
3
|
+
import { H as HTTPPath } from '../../shared/client.BOYsZIRq.mjs';
|
4
4
|
import '@orpc/shared';
|
5
5
|
import '@orpc/standard-server';
|
6
6
|
|
@@ -1,6 +1,6 @@
|
|
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.
|
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.
|
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.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.C176log5.js';
|
3
|
+
import { H as HTTPPath } from '../../shared/client.BOYsZIRq.js';
|
4
4
|
import '@orpc/shared';
|
5
5
|
import '@orpc/standard-server';
|
6
6
|
|
@@ -1,4 +1,4 @@
|
|
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.
|
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.DKmRtVO2.mjs';
|
2
2
|
import '@orpc/shared';
|
3
3
|
import '@orpc/standard-server';
|
4
|
-
import '../../shared/client.
|
4
|
+
import '../../shared/client.txdq_i5V.mjs';
|
@@ -0,0 +1,29 @@
|
|
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.Bwgm6dgk.mjs';
|
4
|
+
import { f as StandardRPCLinkOptions, g as StandardRPCLink } from '../../shared/client.Ycwr4Tuo.mjs';
|
5
|
+
import '@orpc/shared';
|
6
|
+
|
7
|
+
interface LinkWebsocketClientOptions {
|
8
|
+
websocket: Pick<WebSocket, 'addEventListener' | 'send' | 'readyState'>;
|
9
|
+
}
|
10
|
+
declare class LinkWebsocketClient<T extends ClientContext> implements StandardLinkClient<T> {
|
11
|
+
private readonly peer;
|
12
|
+
constructor(options: LinkWebsocketClientOptions);
|
13
|
+
call(request: StandardRequest, _options: ClientOptions<T>, _path: readonly string[], _input: unknown): Promise<StandardLazyResponse>;
|
14
|
+
}
|
15
|
+
|
16
|
+
interface RPCLinkOptions<T extends ClientContext> extends Omit<StandardRPCLinkOptions<T>, 'url' | 'method' | 'fallbackMethod' | 'maxUrlLength'>, 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 RPCLink<T extends ClientContext> extends StandardRPCLink<T> {
|
25
|
+
constructor(options: RPCLinkOptions<T>);
|
26
|
+
}
|
27
|
+
|
28
|
+
export { LinkWebsocketClient, RPCLink };
|
29
|
+
export type { LinkWebsocketClientOptions, RPCLinkOptions };
|
@@ -0,0 +1,29 @@
|
|
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.BG98rYdO.js';
|
4
|
+
import { f as StandardRPCLinkOptions, g as StandardRPCLink } from '../../shared/client.C176log5.js';
|
5
|
+
import '@orpc/shared';
|
6
|
+
|
7
|
+
interface LinkWebsocketClientOptions {
|
8
|
+
websocket: Pick<WebSocket, 'addEventListener' | 'send' | 'readyState'>;
|
9
|
+
}
|
10
|
+
declare class LinkWebsocketClient<T extends ClientContext> implements StandardLinkClient<T> {
|
11
|
+
private readonly peer;
|
12
|
+
constructor(options: LinkWebsocketClientOptions);
|
13
|
+
call(request: StandardRequest, _options: ClientOptions<T>, _path: readonly string[], _input: unknown): Promise<StandardLazyResponse>;
|
14
|
+
}
|
15
|
+
|
16
|
+
interface RPCLinkOptions<T extends ClientContext> extends Omit<StandardRPCLinkOptions<T>, 'url' | 'method' | 'fallbackMethod' | 'maxUrlLength'>, 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 RPCLink<T extends ClientContext> extends StandardRPCLink<T> {
|
25
|
+
constructor(options: RPCLinkOptions<T>);
|
26
|
+
}
|
27
|
+
|
28
|
+
export { LinkWebsocketClient, RPCLink };
|
29
|
+
export type { LinkWebsocketClientOptions, RPCLinkOptions };
|
@@ -0,0 +1,45 @@
|
|
1
|
+
import { readAsBuffer } from '@orpc/shared';
|
2
|
+
import { ClientPeer } from '@orpc/standard-server-peer';
|
3
|
+
import { c as StandardRPCLink } from '../../shared/client.DKmRtVO2.mjs';
|
4
|
+
import '@orpc/standard-server';
|
5
|
+
import '../../shared/client.txdq_i5V.mjs';
|
6
|
+
|
7
|
+
const WEBSOCKET_CONNECTING = 0;
|
8
|
+
class LinkWebsocketClient {
|
9
|
+
peer;
|
10
|
+
constructor(options) {
|
11
|
+
const untilOpen = new Promise((resolve) => {
|
12
|
+
if (options.websocket.readyState === WEBSOCKET_CONNECTING) {
|
13
|
+
options.websocket.addEventListener("open", () => {
|
14
|
+
resolve();
|
15
|
+
}, { once: true });
|
16
|
+
} else {
|
17
|
+
resolve();
|
18
|
+
}
|
19
|
+
});
|
20
|
+
this.peer = new ClientPeer(async (message) => {
|
21
|
+
await untilOpen;
|
22
|
+
return options.websocket.send(message);
|
23
|
+
});
|
24
|
+
options.websocket.addEventListener("message", async (event) => {
|
25
|
+
const message = event.data instanceof Blob ? await readAsBuffer(event.data) : event.data;
|
26
|
+
this.peer.message(message);
|
27
|
+
});
|
28
|
+
options.websocket.addEventListener("close", () => {
|
29
|
+
this.peer.close();
|
30
|
+
});
|
31
|
+
}
|
32
|
+
async call(request, _options, _path, _input) {
|
33
|
+
const response = await this.peer.request(request);
|
34
|
+
return { ...response, body: () => Promise.resolve(response.body) };
|
35
|
+
}
|
36
|
+
}
|
37
|
+
|
38
|
+
class RPCLink extends StandardRPCLink {
|
39
|
+
constructor(options) {
|
40
|
+
const linkClient = new LinkWebsocketClient(options);
|
41
|
+
super(linkClient, { ...options, url: "orpc:/" });
|
42
|
+
}
|
43
|
+
}
|
44
|
+
|
45
|
+
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
|
2
|
-
export { f as
|
3
|
-
import {
|
4
|
-
export { 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,7 +113,7 @@ 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, ...
|
116
|
+
constructor(code: TCode, ...rest: MaybeOptionalOptions<ORPCErrorOptions<TData>>);
|
129
117
|
toJSON(): ORPCErrorJSON<TCode, TData>;
|
130
118
|
}
|
131
119
|
type ORPCErrorJSON<TCode extends string, TData> = Pick<ORPCError<TCode, TData>, 'defined' | 'code' | 'status' | 'message' | 'data'>;
|
@@ -135,11 +123,6 @@ declare function isORPCErrorStatus(status: number): boolean;
|
|
135
123
|
declare function isORPCErrorJson(json: unknown): json is ORPCErrorJSON<ORPCErrorCode, unknown>;
|
136
124
|
declare function createORPCErrorFromJson<TCode extends ORPCErrorCode, TData>(json: ORPCErrorJSON<TCode, TData>, options?: ErrorOptions): ORPCError<TCode, TData>;
|
137
125
|
|
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
|
-
}): AsyncGenerator<TMap, TMap, TNext>;
|
142
|
-
|
143
126
|
type SafeResult<TOutput, TError> = [error: null, data: TOutput, isDefined: false, isSuccess: true] & {
|
144
127
|
error: null;
|
145
128
|
data: TOutput;
|
@@ -165,5 +148,38 @@ type SafeResult<TOutput, TError> = [error: null, data: TOutput, isDefined: false
|
|
165
148
|
declare function safe<TOutput, TError = ThrowableError>(promise: ClientPromiseResult<TOutput, TError>): Promise<SafeResult<TOutput, TError>>;
|
166
149
|
declare function resolveFriendlyClientOptions<T extends ClientContext>(options: FriendlyClientOptions<T>): ClientOptions<T>;
|
167
150
|
|
168
|
-
|
169
|
-
|
151
|
+
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
|
+
[K in keyof T]: T[K] extends NestedClient<any> ? SafeClient<T[K]> : never;
|
153
|
+
};
|
154
|
+
/**
|
155
|
+
* Create a safe client that automatically wraps all procedure calls with the `safe` util.
|
156
|
+
*
|
157
|
+
* @example
|
158
|
+
* ```ts
|
159
|
+
* const safeClient = createSafeClient(client)
|
160
|
+
* const { error, data, isDefined } = await safeClient.doSomething({ id: '123' })
|
161
|
+
* ```
|
162
|
+
*
|
163
|
+
* @see {@link https://orpc.unnoq.com/docs/client/error-handling#using-createsafeclient Safe Client Docs}
|
164
|
+
*/
|
165
|
+
declare function createSafeClient<T extends NestedClient<any>>(client: T): SafeClient<T>;
|
166
|
+
|
167
|
+
/**
|
168
|
+
* DynamicLink provides a way to dynamically resolve and delegate calls to other ClientLinks
|
169
|
+
* based on the request path, input, and context.
|
170
|
+
*
|
171
|
+
* @see {@link https://orpc.unnoq.com/docs/client/dynamic-link Dynamic Link Docs}
|
172
|
+
*/
|
173
|
+
declare class DynamicLink<TClientContext extends ClientContext> implements ClientLink<TClientContext> {
|
174
|
+
private readonly linkResolver;
|
175
|
+
constructor(linkResolver: (options: ClientOptions<TClientContext>, path: readonly string[], input: unknown) => Promisable<ClientLink<TClientContext>>);
|
176
|
+
call(path: readonly string[], input: unknown, options: ClientOptions<TClientContext>): Promise<unknown>;
|
177
|
+
}
|
178
|
+
|
179
|
+
declare function mapEventIterator<TYield, TReturn, TNext, TMap = TYield | TReturn>(iterator: AsyncIterator<TYield, TReturn, TNext>, maps: {
|
180
|
+
value: (value: NoInfer<TYield | TReturn>, done: boolean | undefined) => Promise<TMap>;
|
181
|
+
error: (error: unknown) => Promise<unknown>;
|
182
|
+
}): AsyncIteratorClass<TMap, TMap, TNext>;
|
183
|
+
|
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 };
|