@orpc/client 0.0.0-next.df024bb → 0.0.0-next.e0f01a5
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 +14 -1
- package/dist/adapters/fetch/index.d.mts +11 -15
- package/dist/adapters/fetch/index.d.ts +11 -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 +23 -20
- package/dist/index.d.ts +23 -20
- package/dist/index.mjs +35 -33
- package/dist/plugins/index.d.mts +144 -0
- package/dist/plugins/index.d.ts +144 -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
@@ -32,7 +32,7 @@
|
|
32
32
|
- **Contract-First Development 📜**: (Optional) Define your API contract upfront and implement it with confidence.
|
33
33
|
- **Exceptional Developer Experience ✨**: Enjoy a streamlined workflow with robust typing and clear, in-code documentation.
|
34
34
|
- **Multi-Runtime Support 🌍**: Run your code seamlessly on Cloudflare, Deno, Bun, Node.js, and more.
|
35
|
-
- **Framework Integrations 🧩**: Supports Tanstack Query (React, Vue), Pinia Colada, and more.
|
35
|
+
- **Framework Integrations 🧩**: Supports Tanstack Query (React, Vue, Solid, Svelte), Pinia Colada, and more.
|
36
36
|
- **Server Actions ⚡️**: Fully compatible with React Server Actions on Next.js, TanStack Start, and more.
|
37
37
|
- **Standard Schema Support 🗂️**: Effortlessly work with Zod, Valibot, ArkType, and others right out of the box.
|
38
38
|
- **Fast & Lightweight 💨**: Built on native APIs across all runtimes – optimized for speed and efficiency.
|
@@ -53,11 +53,16 @@ You can find the full documentation [here](https://orpc.unnoq.com).
|
|
53
53
|
- [@orpc/contract](https://www.npmjs.com/package/@orpc/contract): Build your API contract.
|
54
54
|
- [@orpc/server](https://www.npmjs.com/package/@orpc/server): Build your API or implement API contract.
|
55
55
|
- [@orpc/client](https://www.npmjs.com/package/@orpc/client): Consume your API on the client with type-safety.
|
56
|
+
- [@orpc/react](https://www.npmjs.com/package/@orpc/react): Utilities for integrating oRPC with React and React Server Actions.
|
56
57
|
- [@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
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).
|
58
61
|
- [@orpc/vue-colada](https://www.npmjs.com/package/@orpc/vue-colada): Integration with [Pinia Colada](https://pinia-colada.esm.dev/).
|
59
62
|
- [@orpc/openapi](https://www.npmjs.com/package/@orpc/openapi): Generate OpenAPI specs and handle OpenAPI requests.
|
60
63
|
- [@orpc/zod](https://www.npmjs.com/package/@orpc/zod): More schemas that [Zod](https://zod.dev/) doesn't support yet.
|
64
|
+
- [@orpc/valibot](https://www.npmjs.com/package/@orpc/valibot): OpenAPI spec generation from [Valibot](https://valibot.dev/).
|
65
|
+
- [@orpc/arktype](https://www.npmjs.com/package/@orpc/arktype): OpenAPI spec generation from [ArkType](https://arktype.io/).
|
61
66
|
|
62
67
|
## `@orpc/client`
|
63
68
|
|
@@ -83,6 +88,14 @@ const client: RouterClient<typeof router> = createORPCClient(link)
|
|
83
88
|
const client: ContractRouterClient<typeof contract> = createORPCClient(link)
|
84
89
|
```
|
85
90
|
|
91
|
+
## Sponsors
|
92
|
+
|
93
|
+
<p align="center">
|
94
|
+
<a href="https://cdn.jsdelivr.net/gh/unnoq/unnoq/sponsors.svg">
|
95
|
+
<img src='https://cdn.jsdelivr.net/gh/unnoq/unnoq/sponsors.svg'/>
|
96
|
+
</a>
|
97
|
+
</p>
|
98
|
+
|
86
99
|
## License
|
87
100
|
|
88
101
|
Distributed under the MIT License. See [LICENSE](https://github.com/unnoq/orpc/blob/main/LICENSE) for more information.
|
@@ -1,31 +1,27 @@
|
|
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
|
-
declare class RPCLink<T extends ClientContext>
|
22
|
-
private readonly standardLink;
|
22
|
+
declare class RPCLink<T extends ClientContext> extends StandardRPCLink<T> {
|
23
23
|
constructor(options: RPCLinkOptions<T>);
|
24
|
-
call(path: readonly string[], input: unknown, options: ClientOptionsOut<T>): Promise<unknown>;
|
25
24
|
}
|
26
25
|
|
27
|
-
|
28
|
-
|
29
|
-
}
|
30
|
-
|
31
|
-
export { type FetchWithContext, RPCLink, type RPCLinkOptions };
|
26
|
+
export { LinkFetchClient, RPCLink };
|
27
|
+
export type { LinkFetchClientOptions, RPCLinkOptions };
|
@@ -1,31 +1,27 @@
|
|
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
|
-
declare class RPCLink<T extends ClientContext>
|
22
|
-
private readonly standardLink;
|
22
|
+
declare class RPCLink<T extends ClientContext> extends StandardRPCLink<T> {
|
23
23
|
constructor(options: RPCLinkOptions<T>);
|
24
|
-
call(path: readonly string[], input: unknown, options: ClientOptionsOut<T>): Promise<unknown>;
|
25
24
|
}
|
26
25
|
|
27
|
-
|
28
|
-
|
29
|
-
}
|
30
|
-
|
31
|
-
export { type FetchWithContext, RPCLink, type RPCLinkOptions };
|
26
|
+
export { LinkFetchClient, RPCLink };
|
27
|
+
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 {
|
@@ -17,8 +18,8 @@ declare function createORPCClient<T extends NestedClient<any>>(link: ClientLink<
|
|
17
18
|
*/
|
18
19
|
declare class DynamicLink<TClientContext extends ClientContext> implements ClientLink<TClientContext> {
|
19
20
|
private readonly linkResolver;
|
20
|
-
constructor(linkResolver: (options:
|
21
|
-
call(path: readonly string[], input: unknown, options:
|
21
|
+
constructor(linkResolver: (options: ClientOptions<TClientContext>, path: readonly string[], input: unknown) => Promisable<ClientLink<TClientContext>>);
|
22
|
+
call(path: readonly string[], input: unknown, options: ClientOptions<TClientContext>): Promise<unknown>;
|
22
23
|
}
|
23
24
|
|
24
25
|
declare const COMMON_ORPC_ERROR_DEFS: {
|
@@ -119,35 +120,37 @@ declare class ORPCError<TCode extends ORPCErrorCode, TData> extends Error {
|
|
119
120
|
readonly data: TData;
|
120
121
|
constructor(code: TCode, ...[options]: MaybeOptionalOptions<ORPCErrorOptions<TData>>);
|
121
122
|
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
123
|
}
|
125
124
|
type ORPCErrorJSON<TCode extends string, TData> = Pick<ORPCError<TCode, TData>, 'defined' | 'code' | 'status' | 'message' | 'data'>;
|
126
125
|
declare function isDefinedError<T>(error: T): error is Extract<T, ORPCError<any, any>>;
|
127
126
|
declare function toORPCError(error: unknown): ORPCError<any, any>;
|
127
|
+
declare function isORPCErrorStatus(status: number): boolean;
|
128
|
+
declare function isORPCErrorJson(json: unknown): json is ORPCErrorJSON<ORPCErrorCode, unknown>;
|
129
|
+
declare function createORPCErrorFromJson<TCode extends ORPCErrorCode, TData>(json: ORPCErrorJSON<TCode, TData>, options?: ErrorOptions): ORPCError<TCode, TData>;
|
128
130
|
|
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;
|
131
|
+
declare function mapEventIterator<TYield, TReturn, TNext, TMap = TYield | TReturn>(iterator: AsyncIterator<TYield, TReturn, TNext>, maps: {
|
132
|
+
value: (value: NoInfer<TYield | TReturn>, done: boolean | undefined) => Promise<TMap>;
|
133
|
+
error: (error: unknown) => Promise<unknown>;
|
134
|
+
}): AsyncGenerator<TMap, TMap, TNext>;
|
137
135
|
|
138
|
-
type SafeResult<TOutput, TError
|
136
|
+
type SafeResult<TOutput, TError> = [error: null, data: TOutput, isDefined: false, isSuccess: true] & {
|
139
137
|
error: null;
|
140
138
|
data: TOutput;
|
141
139
|
isDefined: false;
|
142
|
-
|
140
|
+
isSuccess: true;
|
141
|
+
} | [error: Exclude<TError, ORPCError<any, any>>, data: undefined, isDefined: false, isSuccess: false] & {
|
143
142
|
error: Exclude<TError, ORPCError<any, any>>;
|
144
143
|
data: undefined;
|
145
144
|
isDefined: false;
|
146
|
-
|
145
|
+
isSuccess: false;
|
146
|
+
} | [error: Extract<TError, ORPCError<any, any>>, data: undefined, isDefined: true, isSuccess: false] & {
|
147
147
|
error: Extract<TError, ORPCError<any, any>>;
|
148
148
|
data: undefined;
|
149
149
|
isDefined: true;
|
150
|
+
isSuccess: false;
|
150
151
|
};
|
151
|
-
declare function safe<TOutput, TError
|
152
|
+
declare function safe<TOutput, TError = ThrowableError>(promise: ClientPromiseResult<TOutput, TError>): Promise<SafeResult<TOutput, TError>>;
|
153
|
+
declare function resolveFriendlyClientOptions<T extends ClientContext>(options: FriendlyClientOptions<T>): ClientOptions<T>;
|
152
154
|
|
153
|
-
export { COMMON_ORPC_ERROR_DEFS, ClientContext, ClientLink,
|
155
|
+
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 };
|
156
|
+
export type { CommonORPCErrorCode, ORPCErrorCode, ORPCErrorJSON, ORPCErrorOptions, SafeResult, createORPCClientOptions };
|