@orpc/client 0.0.0-next.f17a1a0 → 0.0.0-next.f21e305
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 +31 -21
- package/dist/adapters/fetch/index.d.mts +46 -0
- package/dist/adapters/fetch/index.d.ts +46 -0
- package/dist/adapters/fetch/index.mjs +45 -0
- 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 +72 -0
- package/dist/adapters/standard/index.d.mts +11 -0
- package/dist/adapters/standard/index.d.ts +11 -0
- package/dist/adapters/standard/index.mjs +5 -0
- package/dist/adapters/websocket/index.d.mts +29 -0
- package/dist/adapters/websocket/index.d.ts +29 -0
- package/dist/adapters/websocket/index.mjs +46 -0
- package/dist/index.d.mts +230 -0
- package/dist/index.d.ts +230 -0
- package/dist/index.mjs +111 -0
- package/dist/plugins/index.d.mts +202 -0
- package/dist/plugins/index.d.ts +202 -0
- package/dist/plugins/index.mjs +406 -0
- package/dist/shared/client.BG98rYdO.d.ts +45 -0
- package/dist/shared/client.BIYmXux0.mjs +397 -0
- package/dist/shared/client.BOYsZIRq.d.mts +29 -0
- package/dist/shared/client.BOYsZIRq.d.ts +29 -0
- package/dist/shared/client.Bwgm6dgk.d.mts +45 -0
- package/dist/shared/client.C9Q9FzmH.mjs +208 -0
- package/dist/shared/client.CVVVqf1Y.d.ts +91 -0
- package/dist/shared/client._Y_enhib.d.mts +91 -0
- package/package.json +30 -24
- package/dist/chunk-4FUUNP74.js +0 -212
- package/dist/chunk-OGAGXWCU.js +0 -281
- package/dist/fetch.js +0 -128
- package/dist/index.js +0 -81
- package/dist/openapi.js +0 -231
- package/dist/rpc.js +0 -10
- package/dist/src/adapters/fetch/index.d.ts +0 -3
- package/dist/src/adapters/fetch/rpc-link.d.ts +0 -98
- package/dist/src/adapters/fetch/types.d.ts +0 -5
- package/dist/src/client.d.ts +0 -9
- package/dist/src/dynamic-link.d.ts +0 -12
- package/dist/src/error.d.ts +0 -106
- package/dist/src/event-iterator-state.d.ts +0 -9
- package/dist/src/event-iterator.d.ts +0 -12
- package/dist/src/index.d.ts +0 -9
- package/dist/src/openapi/bracket-notation.d.ts +0 -9
- package/dist/src/openapi/index.d.ts +0 -4
- package/dist/src/openapi/json-serializer.d.ts +0 -7
- package/dist/src/openapi/serializer.d.ts +0 -11
- package/dist/src/rpc/index.d.ts +0 -3
- package/dist/src/rpc/json-serializer.d.ts +0 -12
- package/dist/src/rpc/serializer.d.ts +0 -9
- package/dist/src/types.d.ts +0 -29
- package/dist/src/utils.d.ts +0 -5
package/README.md
CHANGED
@@ -1,5 +1,5 @@
|
|
1
1
|
<div align="center">
|
2
|
-
<image align="center" src="https://orpc.unnoq.com/logo.webp" width=280 />
|
2
|
+
<image align="center" src="https://orpc.unnoq.com/logo.webp" width=280 alt="oRPC logo" />
|
3
3
|
</div>
|
4
4
|
|
5
5
|
<h1></h1>
|
@@ -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), SWR, 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,11 +49,17 @@ 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/vue-colada](https://www.npmjs.com/package/@orpc/vue-colada): Integration with [Pinia Colada](https://pinia-colada.esm.dev/).
|
59
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/).
|
55
|
+
- [@orpc/react](https://www.npmjs.com/package/@orpc/react): Utilities for integrating oRPC with React and React Server Actions.
|
56
|
+
- [@orpc/tanstack-query](https://www.npmjs.com/package/@orpc/tanstack-query): [TanStack Query](https://tanstack.com/query/latest) integration.
|
57
|
+
- [@orpc/experimental-react-swr](https://www.npmjs.com/package/@orpc/experimental-react-swr): [SWR](https://swr.vercel.app/) integration.
|
58
|
+
- [@orpc/vue-colada](https://www.npmjs.com/package/@orpc/vue-colada): Integration with [Pinia Colada](https://pinia-colada.esm.dev/).
|
59
|
+
- [@orpc/hey-api](https://www.npmjs.com/package/@orpc/hey-api): [Hey API](https://heyapi.dev/) integration.
|
60
60
|
- [@orpc/zod](https://www.npmjs.com/package/@orpc/zod): More schemas that [Zod](https://zod.dev/) doesn't support yet.
|
61
|
+
- [@orpc/valibot](https://www.npmjs.com/package/@orpc/valibot): OpenAPI spec generation from [Valibot](https://valibot.dev/).
|
62
|
+
- [@orpc/arktype](https://www.npmjs.com/package/@orpc/arktype): OpenAPI spec generation from [ArkType](https://arktype.io/).
|
61
63
|
|
62
64
|
## `@orpc/client`
|
63
65
|
|
@@ -83,6 +85,14 @@ const client: RouterClient<typeof router> = createORPCClient(link)
|
|
83
85
|
const client: ContractRouterClient<typeof contract> = createORPCClient(link)
|
84
86
|
```
|
85
87
|
|
88
|
+
## Sponsors
|
89
|
+
|
90
|
+
<p align="center">
|
91
|
+
<a href="https://cdn.jsdelivr.net/gh/unnoq/unnoq/sponsors.svg">
|
92
|
+
<img src='https://cdn.jsdelivr.net/gh/unnoq/unnoq/sponsors.svg'/>
|
93
|
+
</a>
|
94
|
+
</p>
|
95
|
+
|
86
96
|
## License
|
87
97
|
|
88
98
|
Distributed under the MIT License. See [LICENSE](https://github.com/unnoq/orpc/blob/main/LICENSE) for more information.
|
@@ -0,0 +1,46 @@
|
|
1
|
+
import { Interceptor } from '@orpc/shared';
|
2
|
+
import { StandardRequest, StandardLazyResponse } from '@orpc/standard-server';
|
3
|
+
import { ToFetchRequestOptions } from '@orpc/standard-server-fetch';
|
4
|
+
import { b as ClientContext, c as ClientOptions } from '../../shared/client.BOYsZIRq.mjs';
|
5
|
+
import { a as StandardLinkPlugin, f as StandardLinkClient } from '../../shared/client.Bwgm6dgk.mjs';
|
6
|
+
import { f as StandardRPCLinkOptions, g as StandardRPCLink } from '../../shared/client._Y_enhib.mjs';
|
7
|
+
|
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: {
|
15
|
+
redirect?: Request['redirect'];
|
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>[];
|
24
|
+
}
|
25
|
+
declare class LinkFetchClient<T extends ClientContext> implements StandardLinkClient<T> {
|
26
|
+
private readonly fetch;
|
27
|
+
private readonly toFetchRequestOptions;
|
28
|
+
private readonly adapterInterceptors;
|
29
|
+
constructor(options: LinkFetchClientOptions<T>);
|
30
|
+
call(standardRequest: StandardRequest, options: ClientOptions<T>, path: readonly string[], input: unknown): Promise<StandardLazyResponse>;
|
31
|
+
}
|
32
|
+
|
33
|
+
interface RPCLinkOptions<T extends ClientContext> extends LinkFetchClientOptions<T>, Omit<StandardRPCLinkOptions<T>, 'plugins'> {
|
34
|
+
}
|
35
|
+
/**
|
36
|
+
* The RPC Link communicates with the server using the RPC protocol.
|
37
|
+
*
|
38
|
+
* @see {@link https://orpc.unnoq.com/docs/client/rpc-link RPC Link Docs}
|
39
|
+
* @see {@link https://orpc.unnoq.com/docs/advanced/rpc-protocol RPC Protocol Docs}
|
40
|
+
*/
|
41
|
+
declare class RPCLink<T extends ClientContext> extends StandardRPCLink<T> {
|
42
|
+
constructor(options: RPCLinkOptions<T>);
|
43
|
+
}
|
44
|
+
|
45
|
+
export { LinkFetchClient, RPCLink };
|
46
|
+
export type { LinkFetchClientOptions, LinkFetchInterceptorOptions, RPCLinkOptions };
|
@@ -0,0 +1,46 @@
|
|
1
|
+
import { Interceptor } from '@orpc/shared';
|
2
|
+
import { StandardRequest, StandardLazyResponse } from '@orpc/standard-server';
|
3
|
+
import { ToFetchRequestOptions } from '@orpc/standard-server-fetch';
|
4
|
+
import { b as ClientContext, c as ClientOptions } from '../../shared/client.BOYsZIRq.js';
|
5
|
+
import { a as StandardLinkPlugin, f as StandardLinkClient } from '../../shared/client.BG98rYdO.js';
|
6
|
+
import { f as StandardRPCLinkOptions, g as StandardRPCLink } from '../../shared/client.CVVVqf1Y.js';
|
7
|
+
|
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: {
|
15
|
+
redirect?: Request['redirect'];
|
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>[];
|
24
|
+
}
|
25
|
+
declare class LinkFetchClient<T extends ClientContext> implements StandardLinkClient<T> {
|
26
|
+
private readonly fetch;
|
27
|
+
private readonly toFetchRequestOptions;
|
28
|
+
private readonly adapterInterceptors;
|
29
|
+
constructor(options: LinkFetchClientOptions<T>);
|
30
|
+
call(standardRequest: StandardRequest, options: ClientOptions<T>, path: readonly string[], input: unknown): Promise<StandardLazyResponse>;
|
31
|
+
}
|
32
|
+
|
33
|
+
interface RPCLinkOptions<T extends ClientContext> extends LinkFetchClientOptions<T>, Omit<StandardRPCLinkOptions<T>, 'plugins'> {
|
34
|
+
}
|
35
|
+
/**
|
36
|
+
* The RPC Link communicates with the server using the RPC protocol.
|
37
|
+
*
|
38
|
+
* @see {@link https://orpc.unnoq.com/docs/client/rpc-link RPC Link Docs}
|
39
|
+
* @see {@link https://orpc.unnoq.com/docs/advanced/rpc-protocol RPC Protocol Docs}
|
40
|
+
*/
|
41
|
+
declare class RPCLink<T extends ClientContext> extends StandardRPCLink<T> {
|
42
|
+
constructor(options: RPCLinkOptions<T>);
|
43
|
+
}
|
44
|
+
|
45
|
+
export { LinkFetchClient, RPCLink };
|
46
|
+
export type { LinkFetchClientOptions, LinkFetchInterceptorOptions, RPCLinkOptions };
|
@@ -0,0 +1,45 @@
|
|
1
|
+
import { toArray, intercept } from '@orpc/shared';
|
2
|
+
import { toFetchRequest, toStandardLazyResponse } from '@orpc/standard-server-fetch';
|
3
|
+
import { C as CompositeStandardLinkPlugin, c as StandardRPCLink } from '../../shared/client.BIYmXux0.mjs';
|
4
|
+
import '@orpc/standard-server';
|
5
|
+
import '../../shared/client.C9Q9FzmH.mjs';
|
6
|
+
|
7
|
+
class CompositeLinkFetchPlugin extends CompositeStandardLinkPlugin {
|
8
|
+
initRuntimeAdapter(options) {
|
9
|
+
for (const plugin of this.plugins) {
|
10
|
+
plugin.initRuntimeAdapter?.(options);
|
11
|
+
}
|
12
|
+
}
|
13
|
+
}
|
14
|
+
|
15
|
+
class LinkFetchClient {
|
16
|
+
fetch;
|
17
|
+
toFetchRequestOptions;
|
18
|
+
adapterInterceptors;
|
19
|
+
constructor(options) {
|
20
|
+
const plugin = new CompositeLinkFetchPlugin(options.plugins);
|
21
|
+
plugin.initRuntimeAdapter(options);
|
22
|
+
this.fetch = options.fetch ?? globalThis.fetch.bind(globalThis);
|
23
|
+
this.toFetchRequestOptions = options;
|
24
|
+
this.adapterInterceptors = toArray(options.adapterInterceptors);
|
25
|
+
}
|
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 });
|
34
|
+
return lazyResponse;
|
35
|
+
}
|
36
|
+
}
|
37
|
+
|
38
|
+
class RPCLink extends StandardRPCLink {
|
39
|
+
constructor(options) {
|
40
|
+
const linkClient = new LinkFetchClient(options);
|
41
|
+
super(linkClient, options);
|
42
|
+
}
|
43
|
+
}
|
44
|
+
|
45
|
+
export { LinkFetchClient, RPCLink };
|
@@ -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._Y_enhib.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.CVVVqf1Y.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,72 @@
|
|
1
|
+
import { ClientPeer } from '@orpc/standard-server-peer';
|
2
|
+
import '@orpc/shared';
|
3
|
+
import { c as StandardRPCLink } from '../../shared/client.BIYmXux0.mjs';
|
4
|
+
import '@orpc/standard-server';
|
5
|
+
import '../../shared/client.C9Q9FzmH.mjs';
|
6
|
+
import '@orpc/standard-server-fetch';
|
7
|
+
|
8
|
+
function postMessagePortMessage(port, data) {
|
9
|
+
port.postMessage(data);
|
10
|
+
}
|
11
|
+
function onMessagePortMessage(port, callback) {
|
12
|
+
if ("addEventListener" in port) {
|
13
|
+
port.addEventListener("message", (event) => {
|
14
|
+
callback(event.data);
|
15
|
+
});
|
16
|
+
} else if ("on" in port) {
|
17
|
+
port.on("message", (event) => {
|
18
|
+
callback(event?.data);
|
19
|
+
});
|
20
|
+
} else if ("onMessage" in port) {
|
21
|
+
port.onMessage.addListener((data) => {
|
22
|
+
callback(data);
|
23
|
+
});
|
24
|
+
} else {
|
25
|
+
throw new Error("Cannot find a addEventListener/on/onMessage method on the port");
|
26
|
+
}
|
27
|
+
}
|
28
|
+
function onMessagePortClose(port, callback) {
|
29
|
+
if ("addEventListener" in port) {
|
30
|
+
port.addEventListener("close", async () => {
|
31
|
+
callback();
|
32
|
+
});
|
33
|
+
} else if ("on" in port) {
|
34
|
+
port.on("close", async () => {
|
35
|
+
callback();
|
36
|
+
});
|
37
|
+
} else if ("onDisconnect" in port) {
|
38
|
+
port.onDisconnect.addListener(() => {
|
39
|
+
callback();
|
40
|
+
});
|
41
|
+
} else {
|
42
|
+
throw new Error("Cannot find a addEventListener/on/onDisconnect method on the port");
|
43
|
+
}
|
44
|
+
}
|
45
|
+
|
46
|
+
class LinkMessagePortClient {
|
47
|
+
peer;
|
48
|
+
constructor(options) {
|
49
|
+
this.peer = new ClientPeer((message) => {
|
50
|
+
return postMessagePortMessage(options.port, message);
|
51
|
+
});
|
52
|
+
onMessagePortMessage(options.port, async (message) => {
|
53
|
+
await this.peer.message(message);
|
54
|
+
});
|
55
|
+
onMessagePortClose(options.port, () => {
|
56
|
+
this.peer.close();
|
57
|
+
});
|
58
|
+
}
|
59
|
+
async call(request, _options, _path, _input) {
|
60
|
+
const response = await this.peer.request(request);
|
61
|
+
return { ...response, body: () => Promise.resolve(response.body) };
|
62
|
+
}
|
63
|
+
}
|
64
|
+
|
65
|
+
class RPCLink extends StandardRPCLink {
|
66
|
+
constructor(options) {
|
67
|
+
const linkClient = new LinkMessagePortClient(options);
|
68
|
+
super(linkClient, { ...options, url: "orpc:/" });
|
69
|
+
}
|
70
|
+
}
|
71
|
+
|
72
|
+
export { LinkMessagePortClient, RPCLink, onMessagePortClose, onMessagePortMessage, postMessagePortMessage };
|
@@ -0,0 +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.Bwgm6dgk.mjs';
|
2
|
+
export { S as STANDARD_RPC_JSON_SERIALIZER_BUILT_IN_TYPES, c as StandardRPCCustomJsonSerializer, b as StandardRPCJsonSerialized, a as StandardRPCJsonSerializedMetaItem, e as StandardRPCJsonSerializer, d as StandardRPCJsonSerializerOptions, g as StandardRPCLink, i as StandardRPCLinkCodec, h as StandardRPCLinkCodecOptions, f as StandardRPCLinkOptions, j as StandardRPCSerializer } from '../../shared/client._Y_enhib.mjs';
|
3
|
+
import { StandardHeaders } from '@orpc/standard-server';
|
4
|
+
import { H as HTTPPath } from '../../shared/client.BOYsZIRq.mjs';
|
5
|
+
import '@orpc/shared';
|
6
|
+
|
7
|
+
declare function toHttpPath(path: readonly string[]): HTTPPath;
|
8
|
+
declare function toStandardHeaders(headers: Headers | StandardHeaders): StandardHeaders;
|
9
|
+
declare function getMalformedResponseErrorCode(status: number): string;
|
10
|
+
|
11
|
+
export { getMalformedResponseErrorCode, toHttpPath, toStandardHeaders };
|
@@ -0,0 +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.BG98rYdO.js';
|
2
|
+
export { S as STANDARD_RPC_JSON_SERIALIZER_BUILT_IN_TYPES, c as StandardRPCCustomJsonSerializer, b as StandardRPCJsonSerialized, a as StandardRPCJsonSerializedMetaItem, e as StandardRPCJsonSerializer, d as StandardRPCJsonSerializerOptions, g as StandardRPCLink, i as StandardRPCLinkCodec, h as StandardRPCLinkCodecOptions, f as StandardRPCLinkOptions, j as StandardRPCSerializer } from '../../shared/client.CVVVqf1Y.js';
|
3
|
+
import { StandardHeaders } from '@orpc/standard-server';
|
4
|
+
import { H as HTTPPath } from '../../shared/client.BOYsZIRq.js';
|
5
|
+
import '@orpc/shared';
|
6
|
+
|
7
|
+
declare function toHttpPath(path: readonly string[]): HTTPPath;
|
8
|
+
declare function toStandardHeaders(headers: Headers | StandardHeaders): StandardHeaders;
|
9
|
+
declare function getMalformedResponseErrorCode(status: number): string;
|
10
|
+
|
11
|
+
export { getMalformedResponseErrorCode, toHttpPath, toStandardHeaders };
|
@@ -0,0 +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, f as toStandardHeaders } from '../../shared/client.BIYmXux0.mjs';
|
2
|
+
import '@orpc/shared';
|
3
|
+
import '@orpc/standard-server';
|
4
|
+
import '../../shared/client.C9Q9FzmH.mjs';
|
5
|
+
import '@orpc/standard-server-fetch';
|
@@ -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._Y_enhib.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.CVVVqf1Y.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,46 @@
|
|
1
|
+
import { readAsBuffer } from '@orpc/shared';
|
2
|
+
import { ClientPeer } from '@orpc/standard-server-peer';
|
3
|
+
import { c as StandardRPCLink } from '../../shared/client.BIYmXux0.mjs';
|
4
|
+
import '@orpc/standard-server';
|
5
|
+
import '../../shared/client.C9Q9FzmH.mjs';
|
6
|
+
import '@orpc/standard-server-fetch';
|
7
|
+
|
8
|
+
const WEBSOCKET_CONNECTING = 0;
|
9
|
+
class LinkWebsocketClient {
|
10
|
+
peer;
|
11
|
+
constructor(options) {
|
12
|
+
const untilOpen = new Promise((resolve) => {
|
13
|
+
if (options.websocket.readyState === WEBSOCKET_CONNECTING) {
|
14
|
+
options.websocket.addEventListener("open", () => {
|
15
|
+
resolve();
|
16
|
+
}, { once: true });
|
17
|
+
} else {
|
18
|
+
resolve();
|
19
|
+
}
|
20
|
+
});
|
21
|
+
this.peer = new ClientPeer(async (message) => {
|
22
|
+
await untilOpen;
|
23
|
+
return options.websocket.send(message);
|
24
|
+
});
|
25
|
+
options.websocket.addEventListener("message", async (event) => {
|
26
|
+
const message = event.data instanceof Blob ? await readAsBuffer(event.data) : event.data;
|
27
|
+
this.peer.message(message);
|
28
|
+
});
|
29
|
+
options.websocket.addEventListener("close", () => {
|
30
|
+
this.peer.close();
|
31
|
+
});
|
32
|
+
}
|
33
|
+
async call(request, _options, _path, _input) {
|
34
|
+
const response = await this.peer.request(request);
|
35
|
+
return { ...response, body: () => Promise.resolve(response.body) };
|
36
|
+
}
|
37
|
+
}
|
38
|
+
|
39
|
+
class RPCLink extends StandardRPCLink {
|
40
|
+
constructor(options) {
|
41
|
+
const linkClient = new LinkWebsocketClient(options);
|
42
|
+
super(linkClient, { ...options, url: "orpc:/" });
|
43
|
+
}
|
44
|
+
}
|
45
|
+
|
46
|
+
export { LinkWebsocketClient, RPCLink };
|