@orpc/client 0.0.0-next.c0afbea → 0.0.0-next.c0ca4c7
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 +11 -0
- package/dist/adapters/fetch/index.d.mts +10 -13
- package/dist/adapters/fetch/index.d.ts +10 -13
- package/dist/adapters/fetch/index.mjs +7 -10
- package/dist/adapters/standard/index.d.mts +8 -146
- package/dist/adapters/standard/index.d.ts +8 -146
- package/dist/adapters/standard/index.mjs +2 -2
- package/dist/index.d.mts +20 -20
- package/dist/index.d.ts +20 -20
- package/dist/index.mjs +35 -33
- package/dist/plugins/index.d.mts +65 -0
- package/dist/plugins/index.d.ts +65 -0
- package/dist/plugins/index.mjs +131 -0
- package/dist/shared/client.5813Ufvs.d.mts +39 -0
- package/dist/shared/client.Bt94sjrK.d.mts +103 -0
- package/dist/shared/client.C0lT7w02.d.mts +30 -0
- package/dist/shared/client.C0lT7w02.d.ts +30 -0
- package/dist/shared/client.D-jrSuDb.d.ts +103 -0
- package/dist/shared/{client.Df5pd75N.mjs → client.DhAxdT4W.mjs} +86 -70
- package/dist/shared/client.grRbC25r.d.ts +39 -0
- package/dist/shared/{client.XAn8cDTM.mjs → client.jKEwIsRd.mjs} +6 -97
- package/package.json +9 -4
- package/dist/shared/client.D_CzLDyB.d.mts +0 -42
- package/dist/shared/client.D_CzLDyB.d.ts +0 -42
package/README.md
CHANGED
@@ -53,6 +53,7 @@ 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).
|
58
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,6 +61,8 @@ You can find the full documentation [here](https://orpc.unnoq.com).
|
|
60
61
|
- [@orpc/vue-colada](https://www.npmjs.com/package/@orpc/vue-colada): Integration with [Pinia Colada](https://pinia-colada.esm.dev/).
|
61
62
|
- [@orpc/openapi](https://www.npmjs.com/package/@orpc/openapi): Generate OpenAPI specs and handle OpenAPI requests.
|
62
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/).
|
63
66
|
|
64
67
|
## `@orpc/client`
|
65
68
|
|
@@ -85,6 +88,14 @@ const client: RouterClient<typeof router> = createORPCClient(link)
|
|
85
88
|
const client: ContractRouterClient<typeof contract> = createORPCClient(link)
|
86
89
|
```
|
87
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
|
+
|
88
99
|
## License
|
89
100
|
|
90
101
|
Distributed under the MIT License. See [LICENSE](https://github.com/unnoq/orpc/blob/main/LICENSE) for more information.
|
@@ -1,29 +1,26 @@
|
|
1
1
|
import { StandardRequest, StandardLazyResponse } from '@orpc/standard-server';
|
2
2
|
import { ToFetchRequestOptions } from '@orpc/standard-server-fetch';
|
3
|
-
import {
|
4
|
-
import { StandardLinkClient,
|
3
|
+
import { a as ClientContext, b as ClientOptions } from '../../shared/client.C0lT7w02.mjs';
|
4
|
+
import { d as StandardLinkClient, b as StandardLink } from '../../shared/client.5813Ufvs.mjs';
|
5
|
+
import { f as StandardRPCLinkOptions } from '../../shared/client.Bt94sjrK.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
|
20
|
+
interface RPCLinkOptions<T extends ClientContext> extends StandardRPCLinkOptions<T>, LinkFetchClientOptions<T> {
|
18
21
|
}
|
19
|
-
declare class RPCLink<T extends ClientContext>
|
20
|
-
private readonly standardLink;
|
22
|
+
declare class RPCLink<T extends ClientContext> extends StandardLink<T> {
|
21
23
|
constructor(options: RPCLinkOptions<T>);
|
22
|
-
call(path: readonly string[], input: unknown, options: ClientOptionsOut<T>): Promise<unknown>;
|
23
24
|
}
|
24
25
|
|
25
|
-
|
26
|
-
(url: URL, init: RequestInit, options: ClientOptionsOut<TClientContext>, path: readonly string[], input: unknown): Promise<Response>;
|
27
|
-
}
|
28
|
-
|
29
|
-
export { type FetchWithContext, LinkFetchClient, type LinkFetchClientOptions, RPCLink, type RPCLinkOptions };
|
26
|
+
export { LinkFetchClient, type LinkFetchClientOptions, RPCLink, type RPCLinkOptions };
|
@@ -1,29 +1,26 @@
|
|
1
1
|
import { StandardRequest, StandardLazyResponse } from '@orpc/standard-server';
|
2
2
|
import { ToFetchRequestOptions } from '@orpc/standard-server-fetch';
|
3
|
-
import {
|
4
|
-
import { StandardLinkClient,
|
3
|
+
import { a as ClientContext, b as ClientOptions } from '../../shared/client.C0lT7w02.js';
|
4
|
+
import { d as StandardLinkClient, b as StandardLink } from '../../shared/client.grRbC25r.js';
|
5
|
+
import { f as StandardRPCLinkOptions } from '../../shared/client.D-jrSuDb.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
|
20
|
+
interface RPCLinkOptions<T extends ClientContext> extends StandardRPCLinkOptions<T>, LinkFetchClientOptions<T> {
|
18
21
|
}
|
19
|
-
declare class RPCLink<T extends ClientContext>
|
20
|
-
private readonly standardLink;
|
22
|
+
declare class RPCLink<T extends ClientContext> extends StandardLink<T> {
|
21
23
|
constructor(options: RPCLinkOptions<T>);
|
22
|
-
call(path: readonly string[], input: unknown, options: ClientOptionsOut<T>): Promise<unknown>;
|
23
24
|
}
|
24
25
|
|
25
|
-
|
26
|
-
(url: URL, init: RequestInit, options: ClientOptionsOut<TClientContext>, path: readonly string[], input: unknown): Promise<Response>;
|
27
|
-
}
|
28
|
-
|
29
|
-
export { type FetchWithContext, LinkFetchClient, type LinkFetchClientOptions, RPCLink, type RPCLinkOptions };
|
26
|
+
export { LinkFetchClient, type LinkFetchClientOptions, RPCLink, type RPCLinkOptions };
|
@@ -1,8 +1,8 @@
|
|
1
1
|
import { toFetchRequest, toStandardLazyResponse } from '@orpc/standard-server-fetch';
|
2
|
-
import {
|
2
|
+
import { S as StandardLink, b as StandardRPCJsonSerializer, c as StandardRPCLinkCodec, d as StandardRPCSerializer } from '../../shared/client.DhAxdT4W.mjs';
|
3
3
|
import '@orpc/shared';
|
4
|
-
import '../../shared/client.XAn8cDTM.mjs';
|
5
4
|
import '@orpc/standard-server';
|
5
|
+
import '../../shared/client.jKEwIsRd.mjs';
|
6
6
|
|
7
7
|
class LinkFetchClient {
|
8
8
|
fetch;
|
@@ -13,22 +13,19 @@ 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 StandardLink {
|
24
23
|
constructor(options) {
|
25
|
-
const
|
24
|
+
const jsonSerializer = new StandardRPCJsonSerializer(options);
|
25
|
+
const serializer = new StandardRPCSerializer(jsonSerializer);
|
26
26
|
const linkCodec = new StandardRPCLinkCodec(serializer, options);
|
27
27
|
const linkClient = new LinkFetchClient(options);
|
28
|
-
|
29
|
-
}
|
30
|
-
async call(path, input, options) {
|
31
|
-
return this.standardLink.call(path, input, options);
|
28
|
+
super(linkCodec, linkClient, options);
|
32
29
|
}
|
33
30
|
}
|
34
31
|
|
@@ -1,148 +1,10 @@
|
|
1
|
-
|
2
|
-
|
3
|
-
import {
|
1
|
+
export { I as InvalidEventIteratorRetryResponse, b as StandardLink, d as StandardLinkClient, c as StandardLinkCodec, a as StandardLinkOptions, S as StandardLinkPlugin } from '../../shared/client.5813Ufvs.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, h as StandardRPCLinkCodec, g as StandardRPCLinkCodecOptions, f as StandardRPCLinkOptions, i as StandardRPCSerializer } from '../../shared/client.Bt94sjrK.mjs';
|
3
|
+
import { H as HTTPPath } from '../../shared/client.C0lT7w02.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
|
-
}
|
136
|
-
declare class StandardRPCLinkCodec<T extends ClientContext> implements StandardLinkCodec<T> {
|
137
|
-
private readonly serializer;
|
138
|
-
private readonly baseUrl;
|
139
|
-
private readonly maxUrlLength;
|
140
|
-
private readonly fallbackMethod;
|
141
|
-
private readonly expectedMethod;
|
142
|
-
private readonly headers;
|
143
|
-
constructor(serializer: RPCSerializer, options: StandardRPCLinkCodecOptions<T>);
|
144
|
-
encode(path: readonly string[], input: unknown, options: ClientOptionsOut<any>): Promise<StandardRequest>;
|
145
|
-
decode(response: StandardLazyResponse): Promise<unknown>;
|
146
|
-
}
|
147
|
-
|
148
|
-
export { InvalidEventIteratorRetryResponse, type RPCJsonSerialized, type RPCJsonSerializedMeta, RPCJsonSerializer, RPCSerializer, StandardLink, type StandardLinkClient, type StandardLinkCodec, type StandardLinkOptions, StandardRPCLinkCodec, type StandardRPCLinkCodecOptions };
|
10
|
+
export { getMalformedResponseErrorCode, toHttpPath };
|
@@ -1,148 +1,10 @@
|
|
1
|
-
|
2
|
-
|
3
|
-
import {
|
1
|
+
export { I as InvalidEventIteratorRetryResponse, b as StandardLink, d as StandardLinkClient, c as StandardLinkCodec, a as StandardLinkOptions, S as StandardLinkPlugin } from '../../shared/client.grRbC25r.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, h as StandardRPCLinkCodec, g as StandardRPCLinkCodecOptions, f as StandardRPCLinkOptions, i as StandardRPCSerializer } from '../../shared/client.D-jrSuDb.js';
|
3
|
+
import { H as HTTPPath } from '../../shared/client.C0lT7w02.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
|
-
}
|
136
|
-
declare class StandardRPCLinkCodec<T extends ClientContext> implements StandardLinkCodec<T> {
|
137
|
-
private readonly serializer;
|
138
|
-
private readonly baseUrl;
|
139
|
-
private readonly maxUrlLength;
|
140
|
-
private readonly fallbackMethod;
|
141
|
-
private readonly expectedMethod;
|
142
|
-
private readonly headers;
|
143
|
-
constructor(serializer: RPCSerializer, options: StandardRPCLinkCodecOptions<T>);
|
144
|
-
encode(path: readonly string[], input: unknown, options: ClientOptionsOut<any>): Promise<StandardRequest>;
|
145
|
-
decode(response: StandardLazyResponse): Promise<unknown>;
|
146
|
-
}
|
147
|
-
|
148
|
-
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 { I as InvalidEventIteratorRetryResponse,
|
1
|
+
export { I as InvalidEventIteratorRetryResponse, a as STANDARD_RPC_JSON_SERIALIZER_BUILT_IN_TYPES, S as StandardLink, b as StandardRPCJsonSerializer, c as StandardRPCLinkCodec, d as StandardRPCSerializer, g as getMalformedResponseErrorCode, t as toHttpPath } from '../../shared/client.DhAxdT4W.mjs';
|
2
2
|
import '@orpc/shared';
|
3
|
-
import '../../shared/client.XAn8cDTM.mjs';
|
4
3
|
import '@orpc/standard-server';
|
4
|
+
import '../../shared/client.jKEwIsRd.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.C0lT7w02.mjs';
|
2
|
+
export { f as Client, e as ClientRest, d as HTTPMethod, H as HTTPPath } from './shared/client.C0lT7w02.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: {
|
@@ -125,31 +126,30 @@ declare class ORPCError<TCode extends ORPCErrorCode, TData> extends Error {
|
|
125
126
|
type ORPCErrorJSON<TCode extends string, TData> = Pick<ORPCError<TCode, TData>, 'defined' | 'code' | 'status' | 'message' | 'data'>;
|
126
127
|
declare function isDefinedError<T>(error: T): error is Extract<T, ORPCError<any, any>>;
|
127
128
|
declare function toORPCError(error: unknown): ORPCError<any, any>;
|
129
|
+
declare function isORPCErrorStatus(status: number): boolean;
|
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, options?: {
|
137
|
-
notifyImmediately?: boolean;
|
138
|
-
}): () => 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>;
|
139
135
|
|
140
|
-
type SafeResult<TOutput, TError
|
136
|
+
type SafeResult<TOutput, TError> = [error: null, data: TOutput, isDefined: false, success: true] & {
|
141
137
|
error: null;
|
142
138
|
data: TOutput;
|
143
139
|
isDefined: false;
|
144
|
-
|
140
|
+
success: true;
|
141
|
+
} | [error: Exclude<TError, ORPCError<any, any>>, data: undefined, isDefined: false, success: false] & {
|
145
142
|
error: Exclude<TError, ORPCError<any, any>>;
|
146
143
|
data: undefined;
|
147
144
|
isDefined: false;
|
148
|
-
|
145
|
+
success: false;
|
146
|
+
} | [error: Extract<TError, ORPCError<any, any>>, data: undefined, isDefined: true, success: false] & {
|
149
147
|
error: Extract<TError, ORPCError<any, any>>;
|
150
148
|
data: undefined;
|
151
149
|
isDefined: true;
|
150
|
+
success: false;
|
152
151
|
};
|
153
|
-
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>;
|
154
154
|
|
155
|
-
export { COMMON_ORPC_ERROR_DEFS, ClientContext, ClientLink,
|
155
|
+
export { COMMON_ORPC_ERROR_DEFS, ClientContext, ClientLink, ClientOptions, ClientPromiseResult, type CommonORPCErrorCode, DynamicLink, FriendlyClientOptions, InferClientContext, NestedClient, ORPCError, type ORPCErrorCode, type ORPCErrorJSON, type ORPCErrorOptions, type SafeResult, createORPCClient, type createORPCClientOptions, fallbackORPCErrorMessage, fallbackORPCErrorStatus, isDefinedError, isORPCErrorStatus, mapEventIterator, resolveFriendlyClientOptions, safe, toORPCError };
|
package/dist/index.d.ts
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.C0lT7w02.js';
|
2
|
+
export { f as Client, e as ClientRest, d as HTTPMethod, H as HTTPPath } from './shared/client.C0lT7w02.js';
|
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: {
|
@@ -125,31 +126,30 @@ declare class ORPCError<TCode extends ORPCErrorCode, TData> extends Error {
|
|
125
126
|
type ORPCErrorJSON<TCode extends string, TData> = Pick<ORPCError<TCode, TData>, 'defined' | 'code' | 'status' | 'message' | 'data'>;
|
126
127
|
declare function isDefinedError<T>(error: T): error is Extract<T, ORPCError<any, any>>;
|
127
128
|
declare function toORPCError(error: unknown): ORPCError<any, any>;
|
129
|
+
declare function isORPCErrorStatus(status: number): boolean;
|
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, options?: {
|
137
|
-
notifyImmediately?: boolean;
|
138
|
-
}): () => 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>;
|
139
135
|
|
140
|
-
type SafeResult<TOutput, TError
|
136
|
+
type SafeResult<TOutput, TError> = [error: null, data: TOutput, isDefined: false, success: true] & {
|
141
137
|
error: null;
|
142
138
|
data: TOutput;
|
143
139
|
isDefined: false;
|
144
|
-
|
140
|
+
success: true;
|
141
|
+
} | [error: Exclude<TError, ORPCError<any, any>>, data: undefined, isDefined: false, success: false] & {
|
145
142
|
error: Exclude<TError, ORPCError<any, any>>;
|
146
143
|
data: undefined;
|
147
144
|
isDefined: false;
|
148
|
-
|
145
|
+
success: false;
|
146
|
+
} | [error: Extract<TError, ORPCError<any, any>>, data: undefined, isDefined: true, success: false] & {
|
149
147
|
error: Extract<TError, ORPCError<any, any>>;
|
150
148
|
data: undefined;
|
151
149
|
isDefined: true;
|
150
|
+
success: false;
|
152
151
|
};
|
153
|
-
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>;
|
154
154
|
|
155
|
-
export { COMMON_ORPC_ERROR_DEFS, ClientContext, ClientLink,
|
155
|
+
export { COMMON_ORPC_ERROR_DEFS, ClientContext, ClientLink, ClientOptions, ClientPromiseResult, type CommonORPCErrorCode, DynamicLink, FriendlyClientOptions, InferClientContext, NestedClient, ORPCError, type ORPCErrorCode, type ORPCErrorJSON, type ORPCErrorOptions, type SafeResult, createORPCClient, type createORPCClientOptions, fallbackORPCErrorMessage, fallbackORPCErrorStatus, isDefinedError, isORPCErrorStatus, mapEventIterator, resolveFriendlyClientOptions, safe, toORPCError };
|