@orpc/client 0.0.0-next.b0d4662 → 0.0.0-next.b11d127
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 +26 -17
- package/dist/adapters/fetch/index.d.mts +17 -15
- package/dist/adapters/fetch/index.d.ts +17 -15
- package/dist/adapters/fetch/index.mjs +8 -13
- package/dist/adapters/standard/index.d.mts +8 -147
- package/dist/adapters/standard/index.d.ts +8 -147
- package/dist/adapters/standard/index.mjs +2 -2
- package/dist/index.d.mts +36 -20
- package/dist/index.d.ts +36 -20
- package/dist/index.mjs +35 -33
- package/dist/plugins/index.d.mts +162 -0
- package/dist/plugins/index.d.ts +162 -0
- package/dist/plugins/index.mjs +291 -0
- package/dist/shared/client.8TjrVhkC.d.ts +91 -0
- package/dist/shared/client.BjJBZryq.d.mts +91 -0
- package/dist/shared/client.C9U9n1f3.d.ts +46 -0
- package/dist/shared/client.CRWEpqLB.mjs +175 -0
- package/dist/shared/client.CipPQkhk.d.mts +29 -0
- package/dist/shared/client.CipPQkhk.d.ts +29 -0
- package/dist/shared/{client.Ch8Gzz9n.mjs → client.DpICn1BD.mjs} +174 -140
- package/dist/shared/client.FXep-a3a.d.mts +46 -0
- package/package.json +10 -5
- package/dist/shared/client.D_CzLDyB.d.mts +0 -42
- package/dist/shared/client.D_CzLDyB.d.ts +0 -42
- package/dist/shared/client.DcaJQZfy.mjs +0 -265
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,11 +49,16 @@ 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/react](https://www.npmjs.com/package/@orpc/react): Utilities for integrating oRPC with React and React Server Actions.
|
56
53
|
- [@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
54
|
- [@orpc/vue-query](https://www.npmjs.com/package/@orpc/vue-query): Integration with [Vue Query](https://tanstack.com/query/latest/docs/framework/vue/overview).
|
55
|
+
- [@orpc/solid-query](https://www.npmjs.com/package/@orpc/solid-query): Integration with [Solid Query](https://tanstack.com/query/latest/docs/framework/solid/overview).
|
56
|
+
- [@orpc/svelte-query](https://www.npmjs.com/package/@orpc/svelte-query): Integration with [Svelte Query](https://tanstack.com/query/latest/docs/framework/svelte/overview).
|
58
57
|
- [@orpc/vue-colada](https://www.npmjs.com/package/@orpc/vue-colada): Integration with [Pinia Colada](https://pinia-colada.esm.dev/).
|
59
58
|
- [@orpc/openapi](https://www.npmjs.com/package/@orpc/openapi): Generate OpenAPI specs and handle OpenAPI requests.
|
60
59
|
- [@orpc/zod](https://www.npmjs.com/package/@orpc/zod): More schemas that [Zod](https://zod.dev/) doesn't support yet.
|
60
|
+
- [@orpc/valibot](https://www.npmjs.com/package/@orpc/valibot): OpenAPI spec generation from [Valibot](https://valibot.dev/).
|
61
|
+
- [@orpc/arktype](https://www.npmjs.com/package/@orpc/arktype): OpenAPI spec generation from [ArkType](https://arktype.io/).
|
61
62
|
|
62
63
|
## `@orpc/client`
|
63
64
|
|
@@ -83,6 +84,14 @@ const client: RouterClient<typeof router> = createORPCClient(link)
|
|
83
84
|
const client: ContractRouterClient<typeof contract> = createORPCClient(link)
|
84
85
|
```
|
85
86
|
|
87
|
+
## Sponsors
|
88
|
+
|
89
|
+
<p align="center">
|
90
|
+
<a href="https://cdn.jsdelivr.net/gh/unnoq/unnoq/sponsors.svg">
|
91
|
+
<img src='https://cdn.jsdelivr.net/gh/unnoq/unnoq/sponsors.svg'/>
|
92
|
+
</a>
|
93
|
+
</p>
|
94
|
+
|
86
95
|
## License
|
87
96
|
|
88
97
|
Distributed under the MIT License. See [LICENSE](https://github.com/unnoq/orpc/blob/main/LICENSE) for more information.
|
@@ -1,31 +1,33 @@
|
|
1
|
-
import { C as ClientContext, a as ClientOptionsOut, b as ClientLink } from '../../shared/client.D_CzLDyB.mjs';
|
2
|
-
import { StandardLinkClient, StandardLinkOptions, StandardRPCLinkCodecOptions, StandardRPCLinkCodec } from '../standard/index.mjs';
|
3
1
|
import { StandardRequest, StandardLazyResponse } from '@orpc/standard-server';
|
4
2
|
import { ToFetchRequestOptions } from '@orpc/standard-server-fetch';
|
3
|
+
import { a as ClientContext, b as ClientOptions } from '../../shared/client.CipPQkhk.mjs';
|
4
|
+
import { f as StandardLinkClient } from '../../shared/client.FXep-a3a.mjs';
|
5
|
+
import { f as StandardRPCLinkOptions, g as StandardRPCLink } from '../../shared/client.BjJBZryq.mjs';
|
5
6
|
import '@orpc/shared';
|
6
7
|
|
7
8
|
interface LinkFetchClientOptions<T extends ClientContext> extends ToFetchRequestOptions {
|
8
|
-
fetch?: (request: Request, init:
|
9
|
+
fetch?: (request: Request, init: {
|
10
|
+
redirect?: Request['redirect'];
|
11
|
+
}, options: ClientOptions<T>, path: readonly string[], input: unknown) => Promise<Response>;
|
9
12
|
}
|
10
13
|
declare class LinkFetchClient<T extends ClientContext> implements StandardLinkClient<T> {
|
11
14
|
private readonly fetch;
|
12
15
|
private readonly toFetchRequestOptions;
|
13
16
|
constructor(options: LinkFetchClientOptions<T>);
|
14
|
-
call(request: StandardRequest, options:
|
17
|
+
call(request: StandardRequest, options: ClientOptions<T>, path: readonly string[], input: unknown): Promise<StandardLazyResponse>;
|
15
18
|
}
|
16
19
|
|
17
|
-
interface RPCLinkOptions<T extends ClientContext> extends
|
18
|
-
linkCodec?: StandardRPCLinkCodec<T>;
|
19
|
-
linkClient?: LinkFetchClient<T>;
|
20
|
+
interface RPCLinkOptions<T extends ClientContext> extends StandardRPCLinkOptions<T>, LinkFetchClientOptions<T> {
|
20
21
|
}
|
21
|
-
|
22
|
-
|
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> {
|
23
29
|
constructor(options: RPCLinkOptions<T>);
|
24
|
-
call(path: readonly string[], input: unknown, options: ClientOptionsOut<T>): Promise<unknown>;
|
25
30
|
}
|
26
31
|
|
27
|
-
|
28
|
-
|
29
|
-
}
|
30
|
-
|
31
|
-
export { type FetchWithContext, RPCLink, type RPCLinkOptions };
|
32
|
+
export { LinkFetchClient, RPCLink };
|
33
|
+
export type { LinkFetchClientOptions, RPCLinkOptions };
|
@@ -1,31 +1,33 @@
|
|
1
|
-
import { C as ClientContext, a as ClientOptionsOut, b as ClientLink } from '../../shared/client.D_CzLDyB.js';
|
2
|
-
import { StandardLinkClient, StandardLinkOptions, StandardRPCLinkCodecOptions, StandardRPCLinkCodec } from '../standard/index.js';
|
3
1
|
import { StandardRequest, StandardLazyResponse } from '@orpc/standard-server';
|
4
2
|
import { ToFetchRequestOptions } from '@orpc/standard-server-fetch';
|
3
|
+
import { a as ClientContext, b as ClientOptions } from '../../shared/client.CipPQkhk.js';
|
4
|
+
import { f as StandardLinkClient } from '../../shared/client.C9U9n1f3.js';
|
5
|
+
import { f as StandardRPCLinkOptions, g as StandardRPCLink } from '../../shared/client.8TjrVhkC.js';
|
5
6
|
import '@orpc/shared';
|
6
7
|
|
7
8
|
interface LinkFetchClientOptions<T extends ClientContext> extends ToFetchRequestOptions {
|
8
|
-
fetch?: (request: Request, init:
|
9
|
+
fetch?: (request: Request, init: {
|
10
|
+
redirect?: Request['redirect'];
|
11
|
+
}, options: ClientOptions<T>, path: readonly string[], input: unknown) => Promise<Response>;
|
9
12
|
}
|
10
13
|
declare class LinkFetchClient<T extends ClientContext> implements StandardLinkClient<T> {
|
11
14
|
private readonly fetch;
|
12
15
|
private readonly toFetchRequestOptions;
|
13
16
|
constructor(options: LinkFetchClientOptions<T>);
|
14
|
-
call(request: StandardRequest, options:
|
17
|
+
call(request: StandardRequest, options: ClientOptions<T>, path: readonly string[], input: unknown): Promise<StandardLazyResponse>;
|
15
18
|
}
|
16
19
|
|
17
|
-
interface RPCLinkOptions<T extends ClientContext> extends
|
18
|
-
linkCodec?: StandardRPCLinkCodec<T>;
|
19
|
-
linkClient?: LinkFetchClient<T>;
|
20
|
+
interface RPCLinkOptions<T extends ClientContext> extends StandardRPCLinkOptions<T>, LinkFetchClientOptions<T> {
|
20
21
|
}
|
21
|
-
|
22
|
-
|
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> {
|
23
29
|
constructor(options: RPCLinkOptions<T>);
|
24
|
-
call(path: readonly string[], input: unknown, options: ClientOptionsOut<T>): Promise<unknown>;
|
25
30
|
}
|
26
31
|
|
27
|
-
|
28
|
-
|
29
|
-
}
|
30
|
-
|
31
|
-
export { type FetchWithContext, RPCLink, type RPCLinkOptions };
|
32
|
+
export { LinkFetchClient, RPCLink };
|
33
|
+
export type { LinkFetchClientOptions, RPCLinkOptions };
|
@@ -1,8 +1,8 @@
|
|
1
|
-
import {
|
1
|
+
import { toFetchRequest, toStandardLazyResponse } from '@orpc/standard-server-fetch';
|
2
2
|
import '@orpc/shared';
|
3
|
+
import { c as StandardRPCLink } from '../../shared/client.DpICn1BD.mjs';
|
3
4
|
import '@orpc/standard-server';
|
4
|
-
import
|
5
|
-
import '../../shared/client.DcaJQZfy.mjs';
|
5
|
+
import '../../shared/client.CRWEpqLB.mjs';
|
6
6
|
|
7
7
|
class LinkFetchClient {
|
8
8
|
fetch;
|
@@ -13,22 +13,17 @@ 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
|
26
|
-
|
27
|
-
this.standardLink = new StandardLink(linkCodec, linkClient, options);
|
28
|
-
}
|
29
|
-
async call(path, input, options) {
|
30
|
-
return this.standardLink.call(path, input, options);
|
24
|
+
const linkClient = new LinkFetchClient(options);
|
25
|
+
super(linkClient, options);
|
31
26
|
}
|
32
27
|
}
|
33
28
|
|
34
|
-
export { RPCLink };
|
29
|
+
export { LinkFetchClient, RPCLink };
|
@@ -1,149 +1,10 @@
|
|
1
|
-
|
2
|
-
|
3
|
-
import {
|
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.FXep-a3a.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.BjJBZryq.mjs';
|
3
|
+
import { H as HTTPPath } from '../../shared/client.CipPQkhk.mjs';
|
4
|
+
import '@orpc/shared';
|
5
|
+
import '@orpc/standard-server';
|
4
6
|
|
5
|
-
|
6
|
-
|
7
|
-
decode(response: StandardLazyResponse, options: ClientOptionsOut<T>, path: readonly string[], input: unknown): Promise<unknown>;
|
8
|
-
}
|
9
|
-
interface StandardLinkClient<T extends ClientContext> {
|
10
|
-
call(request: StandardRequest, options: ClientOptionsOut<T>, path: readonly string[], input: unknown): Promise<StandardLazyResponse>;
|
11
|
-
}
|
7
|
+
declare function toHttpPath(path: readonly string[]): HTTPPath;
|
8
|
+
declare function getMalformedResponseErrorCode(status: number): string;
|
12
9
|
|
13
|
-
|
14
|
-
}
|
15
|
-
interface StandardLinkOptions<T extends ClientContext> {
|
16
|
-
/**
|
17
|
-
* Maximum number of retry attempts for event iterator errors before throwing.
|
18
|
-
*
|
19
|
-
* @default 5
|
20
|
-
*/
|
21
|
-
eventIteratorMaxRetries?: Value<number, [
|
22
|
-
reconnectOptions: EventIteratorReconnectOptions,
|
23
|
-
options: ClientOptionsOut<T>,
|
24
|
-
path: readonly string[],
|
25
|
-
input: unknown
|
26
|
-
]>;
|
27
|
-
/**
|
28
|
-
* Delay (in ms) before retrying an event iterator call.
|
29
|
-
*
|
30
|
-
* @default (o) => o.lastRetry ?? (1000 * 2 ** o.retryTimes)
|
31
|
-
*/
|
32
|
-
eventIteratorRetryDelay?: Value<number, [
|
33
|
-
reconnectOptions: EventIteratorReconnectOptions,
|
34
|
-
options: ClientOptionsOut<T>,
|
35
|
-
path: readonly string[],
|
36
|
-
input: unknown
|
37
|
-
]>;
|
38
|
-
/**
|
39
|
-
* Function to determine if an error is retryable.
|
40
|
-
*
|
41
|
-
* @default true
|
42
|
-
*/
|
43
|
-
eventIteratorShouldRetry?: Value<boolean, [
|
44
|
-
reconnectOptions: EventIteratorReconnectOptions,
|
45
|
-
options: ClientOptionsOut<T>,
|
46
|
-
path: readonly string[],
|
47
|
-
input: unknown
|
48
|
-
]>;
|
49
|
-
interceptors?: Interceptor<{
|
50
|
-
path: readonly string[];
|
51
|
-
input: unknown;
|
52
|
-
options: ClientOptionsOut<T>;
|
53
|
-
}, unknown, unknown>[];
|
54
|
-
clientInterceptors?: Interceptor<{
|
55
|
-
request: StandardRequest;
|
56
|
-
}, StandardLazyResponse, unknown>[];
|
57
|
-
}
|
58
|
-
declare class StandardLink<T extends ClientContext> implements ClientLink<T> {
|
59
|
-
#private;
|
60
|
-
readonly codec: StandardLinkCodec<T>;
|
61
|
-
readonly sender: StandardLinkClient<T>;
|
62
|
-
private readonly eventIteratorMaxRetries;
|
63
|
-
private readonly eventIteratorRetryDelay;
|
64
|
-
private readonly eventIteratorShouldRetry;
|
65
|
-
private readonly interceptors;
|
66
|
-
private readonly clientInterceptors;
|
67
|
-
constructor(codec: StandardLinkCodec<T>, sender: StandardLinkClient<T>, options: StandardLinkOptions<T>);
|
68
|
-
call(path: readonly string[], input: unknown, options: ClientOptionsOut<T>): Promise<unknown>;
|
69
|
-
}
|
70
|
-
|
71
|
-
type RPCJsonSerializedMeta = [
|
72
|
-
0 | 1 | 2 | 3 | 4 | 5 | 6 | 7,
|
73
|
-
Segment[]
|
74
|
-
][];
|
75
|
-
type RPCJsonSerialized = [json: unknown, meta: RPCJsonSerializedMeta, maps: Segment[][], blobs: Blob[]];
|
76
|
-
declare class RPCJsonSerializer {
|
77
|
-
serialize(data: unknown, segments?: Segment[], meta?: RPCJsonSerializedMeta, maps?: Segment[][], blobs?: Blob[]): RPCJsonSerialized;
|
78
|
-
deserialize(json: unknown, meta: RPCJsonSerializedMeta): unknown;
|
79
|
-
deserialize(json: unknown, meta: RPCJsonSerializedMeta, maps: Segment[][], getBlob: (index: number) => Blob): unknown;
|
80
|
-
}
|
81
|
-
|
82
|
-
declare class RPCSerializer {
|
83
|
-
#private;
|
84
|
-
private readonly jsonSerializer;
|
85
|
-
constructor(jsonSerializer?: RPCJsonSerializer);
|
86
|
-
serialize(data: unknown): unknown;
|
87
|
-
deserialize(data: unknown): unknown;
|
88
|
-
}
|
89
|
-
|
90
|
-
type HTTPMethod = 'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH';
|
91
|
-
interface StandardRPCLinkCodecOptions<T extends ClientContext> {
|
92
|
-
/**
|
93
|
-
* Base url for all requests.
|
94
|
-
*/
|
95
|
-
url: Value<string | URL, [
|
96
|
-
options: ClientOptionsOut<T>,
|
97
|
-
path: readonly string[],
|
98
|
-
input: unknown
|
99
|
-
]>;
|
100
|
-
/**
|
101
|
-
* The maximum length of the URL.
|
102
|
-
*
|
103
|
-
* @default 2083
|
104
|
-
*/
|
105
|
-
maxUrlLength?: Value<number, [
|
106
|
-
options: ClientOptionsOut<T>,
|
107
|
-
path: readonly string[],
|
108
|
-
input: unknown
|
109
|
-
]>;
|
110
|
-
/**
|
111
|
-
* The method used to make the request.
|
112
|
-
*
|
113
|
-
* @default 'POST'
|
114
|
-
*/
|
115
|
-
method?: Value<HTTPMethod, [
|
116
|
-
options: ClientOptionsOut<T>,
|
117
|
-
path: readonly string[],
|
118
|
-
input: unknown
|
119
|
-
]>;
|
120
|
-
/**
|
121
|
-
* The method to use when the payload cannot safely pass to the server with method return from method function.
|
122
|
-
* GET is not allowed, it's very dangerous.
|
123
|
-
*
|
124
|
-
* @default 'POST'
|
125
|
-
*/
|
126
|
-
fallbackMethod?: Exclude<HTTPMethod, 'GET'>;
|
127
|
-
/**
|
128
|
-
* Inject headers to the request.
|
129
|
-
*/
|
130
|
-
headers?: Value<StandardHeaders, [
|
131
|
-
options: ClientOptionsOut<T>,
|
132
|
-
path: readonly string[],
|
133
|
-
input: unknown
|
134
|
-
]>;
|
135
|
-
rpcSerializer?: RPCSerializer;
|
136
|
-
}
|
137
|
-
declare class StandardRPCLinkCodec<T extends ClientContext> implements StandardLinkCodec<T> {
|
138
|
-
private readonly baseUrl;
|
139
|
-
private readonly maxUrlLength;
|
140
|
-
private readonly fallbackMethod;
|
141
|
-
private readonly expectedMethod;
|
142
|
-
private readonly headers;
|
143
|
-
private readonly rpcSerializer;
|
144
|
-
constructor(options: StandardRPCLinkCodecOptions<T>);
|
145
|
-
encode(path: readonly string[], input: unknown, options: ClientOptionsOut<any>): Promise<StandardRequest>;
|
146
|
-
decode(response: StandardLazyResponse): Promise<unknown>;
|
147
|
-
}
|
148
|
-
|
149
|
-
export { InvalidEventIteratorRetryResponse, type RPCJsonSerialized, type RPCJsonSerializedMeta, RPCJsonSerializer, RPCSerializer, StandardLink, type StandardLinkClient, type StandardLinkCodec, type StandardLinkOptions, StandardRPCLinkCodec, type StandardRPCLinkCodecOptions };
|
10
|
+
export { getMalformedResponseErrorCode, toHttpPath };
|
@@ -1,149 +1,10 @@
|
|
1
|
-
|
2
|
-
|
3
|
-
import {
|
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.C9U9n1f3.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.8TjrVhkC.js';
|
3
|
+
import { H as HTTPPath } from '../../shared/client.CipPQkhk.js';
|
4
|
+
import '@orpc/shared';
|
5
|
+
import '@orpc/standard-server';
|
4
6
|
|
5
|
-
|
6
|
-
|
7
|
-
decode(response: StandardLazyResponse, options: ClientOptionsOut<T>, path: readonly string[], input: unknown): Promise<unknown>;
|
8
|
-
}
|
9
|
-
interface StandardLinkClient<T extends ClientContext> {
|
10
|
-
call(request: StandardRequest, options: ClientOptionsOut<T>, path: readonly string[], input: unknown): Promise<StandardLazyResponse>;
|
11
|
-
}
|
7
|
+
declare function toHttpPath(path: readonly string[]): HTTPPath;
|
8
|
+
declare function getMalformedResponseErrorCode(status: number): string;
|
12
9
|
|
13
|
-
|
14
|
-
}
|
15
|
-
interface StandardLinkOptions<T extends ClientContext> {
|
16
|
-
/**
|
17
|
-
* Maximum number of retry attempts for event iterator errors before throwing.
|
18
|
-
*
|
19
|
-
* @default 5
|
20
|
-
*/
|
21
|
-
eventIteratorMaxRetries?: Value<number, [
|
22
|
-
reconnectOptions: EventIteratorReconnectOptions,
|
23
|
-
options: ClientOptionsOut<T>,
|
24
|
-
path: readonly string[],
|
25
|
-
input: unknown
|
26
|
-
]>;
|
27
|
-
/**
|
28
|
-
* Delay (in ms) before retrying an event iterator call.
|
29
|
-
*
|
30
|
-
* @default (o) => o.lastRetry ?? (1000 * 2 ** o.retryTimes)
|
31
|
-
*/
|
32
|
-
eventIteratorRetryDelay?: Value<number, [
|
33
|
-
reconnectOptions: EventIteratorReconnectOptions,
|
34
|
-
options: ClientOptionsOut<T>,
|
35
|
-
path: readonly string[],
|
36
|
-
input: unknown
|
37
|
-
]>;
|
38
|
-
/**
|
39
|
-
* Function to determine if an error is retryable.
|
40
|
-
*
|
41
|
-
* @default true
|
42
|
-
*/
|
43
|
-
eventIteratorShouldRetry?: Value<boolean, [
|
44
|
-
reconnectOptions: EventIteratorReconnectOptions,
|
45
|
-
options: ClientOptionsOut<T>,
|
46
|
-
path: readonly string[],
|
47
|
-
input: unknown
|
48
|
-
]>;
|
49
|
-
interceptors?: Interceptor<{
|
50
|
-
path: readonly string[];
|
51
|
-
input: unknown;
|
52
|
-
options: ClientOptionsOut<T>;
|
53
|
-
}, unknown, unknown>[];
|
54
|
-
clientInterceptors?: Interceptor<{
|
55
|
-
request: StandardRequest;
|
56
|
-
}, StandardLazyResponse, unknown>[];
|
57
|
-
}
|
58
|
-
declare class StandardLink<T extends ClientContext> implements ClientLink<T> {
|
59
|
-
#private;
|
60
|
-
readonly codec: StandardLinkCodec<T>;
|
61
|
-
readonly sender: StandardLinkClient<T>;
|
62
|
-
private readonly eventIteratorMaxRetries;
|
63
|
-
private readonly eventIteratorRetryDelay;
|
64
|
-
private readonly eventIteratorShouldRetry;
|
65
|
-
private readonly interceptors;
|
66
|
-
private readonly clientInterceptors;
|
67
|
-
constructor(codec: StandardLinkCodec<T>, sender: StandardLinkClient<T>, options: StandardLinkOptions<T>);
|
68
|
-
call(path: readonly string[], input: unknown, options: ClientOptionsOut<T>): Promise<unknown>;
|
69
|
-
}
|
70
|
-
|
71
|
-
type RPCJsonSerializedMeta = [
|
72
|
-
0 | 1 | 2 | 3 | 4 | 5 | 6 | 7,
|
73
|
-
Segment[]
|
74
|
-
][];
|
75
|
-
type RPCJsonSerialized = [json: unknown, meta: RPCJsonSerializedMeta, maps: Segment[][], blobs: Blob[]];
|
76
|
-
declare class RPCJsonSerializer {
|
77
|
-
serialize(data: unknown, segments?: Segment[], meta?: RPCJsonSerializedMeta, maps?: Segment[][], blobs?: Blob[]): RPCJsonSerialized;
|
78
|
-
deserialize(json: unknown, meta: RPCJsonSerializedMeta): unknown;
|
79
|
-
deserialize(json: unknown, meta: RPCJsonSerializedMeta, maps: Segment[][], getBlob: (index: number) => Blob): unknown;
|
80
|
-
}
|
81
|
-
|
82
|
-
declare class RPCSerializer {
|
83
|
-
#private;
|
84
|
-
private readonly jsonSerializer;
|
85
|
-
constructor(jsonSerializer?: RPCJsonSerializer);
|
86
|
-
serialize(data: unknown): unknown;
|
87
|
-
deserialize(data: unknown): unknown;
|
88
|
-
}
|
89
|
-
|
90
|
-
type HTTPMethod = 'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH';
|
91
|
-
interface StandardRPCLinkCodecOptions<T extends ClientContext> {
|
92
|
-
/**
|
93
|
-
* Base url for all requests.
|
94
|
-
*/
|
95
|
-
url: Value<string | URL, [
|
96
|
-
options: ClientOptionsOut<T>,
|
97
|
-
path: readonly string[],
|
98
|
-
input: unknown
|
99
|
-
]>;
|
100
|
-
/**
|
101
|
-
* The maximum length of the URL.
|
102
|
-
*
|
103
|
-
* @default 2083
|
104
|
-
*/
|
105
|
-
maxUrlLength?: Value<number, [
|
106
|
-
options: ClientOptionsOut<T>,
|
107
|
-
path: readonly string[],
|
108
|
-
input: unknown
|
109
|
-
]>;
|
110
|
-
/**
|
111
|
-
* The method used to make the request.
|
112
|
-
*
|
113
|
-
* @default 'POST'
|
114
|
-
*/
|
115
|
-
method?: Value<HTTPMethod, [
|
116
|
-
options: ClientOptionsOut<T>,
|
117
|
-
path: readonly string[],
|
118
|
-
input: unknown
|
119
|
-
]>;
|
120
|
-
/**
|
121
|
-
* The method to use when the payload cannot safely pass to the server with method return from method function.
|
122
|
-
* GET is not allowed, it's very dangerous.
|
123
|
-
*
|
124
|
-
* @default 'POST'
|
125
|
-
*/
|
126
|
-
fallbackMethod?: Exclude<HTTPMethod, 'GET'>;
|
127
|
-
/**
|
128
|
-
* Inject headers to the request.
|
129
|
-
*/
|
130
|
-
headers?: Value<StandardHeaders, [
|
131
|
-
options: ClientOptionsOut<T>,
|
132
|
-
path: readonly string[],
|
133
|
-
input: unknown
|
134
|
-
]>;
|
135
|
-
rpcSerializer?: RPCSerializer;
|
136
|
-
}
|
137
|
-
declare class StandardRPCLinkCodec<T extends ClientContext> implements StandardLinkCodec<T> {
|
138
|
-
private readonly baseUrl;
|
139
|
-
private readonly maxUrlLength;
|
140
|
-
private readonly fallbackMethod;
|
141
|
-
private readonly expectedMethod;
|
142
|
-
private readonly headers;
|
143
|
-
private readonly rpcSerializer;
|
144
|
-
constructor(options: StandardRPCLinkCodecOptions<T>);
|
145
|
-
encode(path: readonly string[], input: unknown, options: ClientOptionsOut<any>): Promise<StandardRequest>;
|
146
|
-
decode(response: StandardLazyResponse): Promise<unknown>;
|
147
|
-
}
|
148
|
-
|
149
|
-
export { InvalidEventIteratorRetryResponse, type RPCJsonSerialized, type RPCJsonSerializedMeta, RPCJsonSerializer, RPCSerializer, StandardLink, type StandardLinkClient, type StandardLinkCodec, type StandardLinkOptions, StandardRPCLinkCodec, type StandardRPCLinkCodecOptions };
|
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.DpICn1BD.mjs';
|
2
2
|
import '@orpc/shared';
|
3
|
-
import '../../shared/client.DcaJQZfy.mjs';
|
4
3
|
import '@orpc/standard-server';
|
4
|
+
import '../../shared/client.CRWEpqLB.mjs';
|
package/dist/index.d.mts
CHANGED
@@ -1,6 +1,7 @@
|
|
1
|
-
import { N as NestedClient,
|
2
|
-
export {
|
3
|
-
import { Promisable, MaybeOptionalOptions } 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.CipPQkhk.mjs';
|
2
|
+
export { f as Client, e as ClientRest, d as HTTPMethod, H as HTTPPath } from './shared/client.CipPQkhk.mjs';
|
3
|
+
import { Promisable, MaybeOptionalOptions, ThrowableError } from '@orpc/shared';
|
4
|
+
export { Registry, ThrowableError, onError, onFinish, onStart, onSuccess } from '@orpc/shared';
|
4
5
|
export { ErrorEvent } from '@orpc/standard-server';
|
5
6
|
|
6
7
|
interface createORPCClientOptions {
|
@@ -9,16 +10,23 @@ interface createORPCClientOptions {
|
|
9
10
|
*/
|
10
11
|
path?: string[];
|
11
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
|
+
*/
|
12
18
|
declare function createORPCClient<T extends NestedClient<any>>(link: ClientLink<InferClientContext<T>>, options?: createORPCClientOptions): T;
|
13
19
|
|
14
20
|
/**
|
15
21
|
* DynamicLink provides a way to dynamically resolve and delegate calls to other ClientLinks
|
16
22
|
* based on the request path, input, and context.
|
23
|
+
*
|
24
|
+
* @see {@link https://orpc.unnoq.com/docs/client/dynamic-link Dynamic Link Docs}
|
17
25
|
*/
|
18
26
|
declare class DynamicLink<TClientContext extends ClientContext> implements ClientLink<TClientContext> {
|
19
27
|
private readonly linkResolver;
|
20
|
-
constructor(linkResolver: (options:
|
21
|
-
call(path: readonly string[], input: unknown, options:
|
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>;
|
22
30
|
}
|
23
31
|
|
24
32
|
declare const COMMON_ORPC_ERROR_DEFS: {
|
@@ -119,35 +127,43 @@ declare class ORPCError<TCode extends ORPCErrorCode, TData> extends Error {
|
|
119
127
|
readonly data: TData;
|
120
128
|
constructor(code: TCode, ...[options]: MaybeOptionalOptions<ORPCErrorOptions<TData>>);
|
121
129
|
toJSON(): ORPCErrorJSON<TCode, TData>;
|
122
|
-
static fromJSON<TCode extends ORPCErrorCode, TData>(json: ORPCErrorJSON<TCode, TData>, options?: ErrorOptions): ORPCError<TCode, TData>;
|
123
|
-
static isValidJSON(json: unknown): json is ORPCErrorJSON<ORPCErrorCode, unknown>;
|
124
130
|
}
|
125
131
|
type ORPCErrorJSON<TCode extends string, TData> = Pick<ORPCError<TCode, TData>, 'defined' | 'code' | 'status' | 'message' | 'data'>;
|
126
132
|
declare function isDefinedError<T>(error: T): error is Extract<T, ORPCError<any, any>>;
|
127
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>;
|
128
137
|
|
129
|
-
|
130
|
-
|
131
|
-
|
132
|
-
|
133
|
-
}
|
134
|
-
declare function registerEventIteratorState(iterator: AsyncIteratorObject<unknown, unknown, void>, state: EventIteratorState): void;
|
135
|
-
declare function updateEventIteratorStatus(state: EventIteratorState, status: ConnectionStatus): void;
|
136
|
-
declare function onEventIteratorStatusChange(iterator: AsyncIteratorObject<unknown, unknown, void>, callback: (status: ConnectionStatus) => void, notifyImmediately?: boolean): () => void;
|
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>;
|
137
142
|
|
138
|
-
type SafeResult<TOutput, TError
|
143
|
+
type SafeResult<TOutput, TError> = [error: null, data: TOutput, isDefined: false, isSuccess: true] & {
|
139
144
|
error: null;
|
140
145
|
data: TOutput;
|
141
146
|
isDefined: false;
|
142
|
-
|
147
|
+
isSuccess: true;
|
148
|
+
} | [error: Exclude<TError, ORPCError<any, any>>, data: undefined, isDefined: false, isSuccess: false] & {
|
143
149
|
error: Exclude<TError, ORPCError<any, any>>;
|
144
150
|
data: undefined;
|
145
151
|
isDefined: false;
|
146
|
-
|
152
|
+
isSuccess: false;
|
153
|
+
} | [error: Extract<TError, ORPCError<any, any>>, data: undefined, isDefined: true, isSuccess: false] & {
|
147
154
|
error: Extract<TError, ORPCError<any, any>>;
|
148
155
|
data: undefined;
|
149
156
|
isDefined: true;
|
157
|
+
isSuccess: false;
|
150
158
|
};
|
151
|
-
|
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>>;
|
166
|
+
declare function resolveFriendlyClientOptions<T extends ClientContext>(options: FriendlyClientOptions<T>): ClientOptions<T>;
|
152
167
|
|
153
|
-
export { COMMON_ORPC_ERROR_DEFS, ClientContext, ClientLink,
|
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 };
|