@orpc/client 0.0.0-next.4fc998d → 0.0.0-next.54ba24c
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 +8 -0
- package/dist/adapters/fetch/index.d.mts +9 -12
- package/dist/adapters/fetch/index.d.ts +9 -12
- package/dist/adapters/fetch/index.mjs +5 -9
- package/dist/adapters/standard/index.d.mts +7 -167
- package/dist/adapters/standard/index.d.ts +7 -167
- package/dist/adapters/standard/index.mjs +2 -2
- package/dist/index.d.mts +11 -15
- package/dist/index.d.ts +11 -15
- package/dist/index.mjs +34 -32
- package/dist/plugins/index.d.mts +61 -0
- package/dist/plugins/index.d.ts +61 -0
- package/dist/plugins/index.mjs +126 -0
- package/dist/shared/client.87WXDX8t.d.mts +32 -0
- package/dist/shared/client.87WXDX8t.d.ts +32 -0
- package/dist/shared/client.BC0T26HA.d.mts +103 -0
- package/dist/shared/client.BaocqKnn.d.ts +39 -0
- package/dist/shared/client.CZFIVTQj.d.ts +103 -0
- package/dist/shared/{client.CPmBUYbj.mjs → client.D77bw0hs.mjs} +29 -47
- package/dist/shared/client.D9lmRwGB.d.mts +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
|
@@ -87,6 +87,14 @@ const client: RouterClient<typeof router> = createORPCClient(link)
|
|
|
87
87
|
const client: ContractRouterClient<typeof contract> = createORPCClient(link)
|
|
88
88
|
```
|
|
89
89
|
|
|
90
|
+
## Sponsors
|
|
91
|
+
|
|
92
|
+
<p align="center">
|
|
93
|
+
<a href="https://cdn.jsdelivr.net/gh/unnoq/unnoq/sponsors.svg">
|
|
94
|
+
<img src='https://cdn.jsdelivr.net/gh/unnoq/unnoq/sponsors.svg'/>
|
|
95
|
+
</a>
|
|
96
|
+
</p>
|
|
97
|
+
|
|
90
98
|
## License
|
|
91
99
|
|
|
92
100
|
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.87WXDX8t.mjs';
|
|
4
|
+
import { d as StandardLinkClient, b as StandardLink } from '../../shared/client.D9lmRwGB.mjs';
|
|
5
|
+
import { f as StandardRPCLinkOptions } from '../../shared/client.BC0T26HA.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
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.87WXDX8t.js';
|
|
4
|
+
import { d as StandardLinkClient, b as StandardLink } from '../../shared/client.BaocqKnn.js';
|
|
5
|
+
import { f as StandardRPCLinkOptions } from '../../shared/client.CZFIVTQj.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
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 { b as StandardRPCJsonSerializer, c as StandardRPCLinkCodec, d as StandardRPCSerializer
|
|
2
|
+
import { S as StandardLink, b as StandardRPCJsonSerializer, c as StandardRPCLinkCodec, d as StandardRPCSerializer } from '../../shared/client.D77bw0hs.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,23 +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
24
|
const jsonSerializer = new StandardRPCJsonSerializer(options);
|
|
26
25
|
const serializer = new StandardRPCSerializer(jsonSerializer);
|
|
27
26
|
const linkCodec = new StandardRPCLinkCodec(serializer, options);
|
|
28
27
|
const linkClient = new LinkFetchClient(options);
|
|
29
|
-
|
|
30
|
-
}
|
|
31
|
-
async call(path, input, options) {
|
|
32
|
-
return this.standardLink.call(path, input, options);
|
|
28
|
+
super(linkCodec, linkClient, options);
|
|
33
29
|
}
|
|
34
30
|
}
|
|
35
31
|
|
|
@@ -1,169 +1,9 @@
|
|
|
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.D9lmRwGB.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.BC0T26HA.mjs';
|
|
3
|
+
import { H as HTTPPath } from '../../shared/client.87WXDX8t.mjs';
|
|
4
|
+
import '@orpc/shared';
|
|
5
|
+
import '@orpc/standard-server';
|
|
4
6
|
|
|
5
|
-
|
|
6
|
-
encode(path: readonly string[], input: unknown, options: ClientOptionsOut<any>): Promise<StandardRequest>;
|
|
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;
|
|
12
8
|
|
|
13
|
-
|
|
14
|
-
}
|
|
15
|
-
interface StandardLinkOptions<T extends ClientContext> {
|
|
16
|
-
/**
|
|
17
|
-
* Maximum retry attempts for **consecutive failures** 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
|
-
declare const STANDARD_RPC_JSON_SERIALIZER_BUILT_IN_TYPES: {
|
|
72
|
-
readonly BIGINT: 0;
|
|
73
|
-
readonly DATE: 1;
|
|
74
|
-
readonly NAN: 2;
|
|
75
|
-
readonly UNDEFINED: 3;
|
|
76
|
-
readonly URL: 4;
|
|
77
|
-
readonly REGEXP: 5;
|
|
78
|
-
readonly SET: 6;
|
|
79
|
-
readonly MAP: 7;
|
|
80
|
-
};
|
|
81
|
-
type StandardRPCJsonSerializedMetaItem = readonly [type: number, ...path: Segment[]];
|
|
82
|
-
type StandardRPCJsonSerialized = [json: unknown, meta: StandardRPCJsonSerializedMetaItem[], maps: Segment[][], blobs: Blob[]];
|
|
83
|
-
interface StandardRPCCustomJsonSerializer {
|
|
84
|
-
type: number;
|
|
85
|
-
condition(data: unknown): boolean;
|
|
86
|
-
serialize(data: any): unknown;
|
|
87
|
-
deserialize(serialized: any): unknown;
|
|
88
|
-
}
|
|
89
|
-
interface StandardRPCJsonSerializerOptions {
|
|
90
|
-
customJsonSerializers?: readonly StandardRPCCustomJsonSerializer[];
|
|
91
|
-
}
|
|
92
|
-
declare class StandardRPCJsonSerializer {
|
|
93
|
-
private readonly customSerializers;
|
|
94
|
-
constructor(options?: StandardRPCJsonSerializerOptions);
|
|
95
|
-
serialize(data: unknown, segments?: Segment[], meta?: StandardRPCJsonSerializedMetaItem[], maps?: Segment[][], blobs?: Blob[]): StandardRPCJsonSerialized;
|
|
96
|
-
deserialize(json: unknown, meta: readonly StandardRPCJsonSerializedMetaItem[]): unknown;
|
|
97
|
-
deserialize(json: unknown, meta: readonly StandardRPCJsonSerializedMetaItem[], maps: readonly Segment[][], getBlob: (index: number) => Blob): unknown;
|
|
98
|
-
}
|
|
99
|
-
|
|
100
|
-
declare class StandardRPCSerializer {
|
|
101
|
-
#private;
|
|
102
|
-
private readonly jsonSerializer;
|
|
103
|
-
constructor(jsonSerializer: StandardRPCJsonSerializer);
|
|
104
|
-
serialize(data: unknown): unknown;
|
|
105
|
-
deserialize(data: unknown): unknown;
|
|
106
|
-
}
|
|
107
|
-
|
|
108
|
-
type HTTPMethod = 'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH';
|
|
109
|
-
interface StandardRPCLinkCodecOptions<T extends ClientContext> {
|
|
110
|
-
/**
|
|
111
|
-
* Base url for all requests.
|
|
112
|
-
*/
|
|
113
|
-
url: Value<string | URL, [
|
|
114
|
-
options: ClientOptionsOut<T>,
|
|
115
|
-
path: readonly string[],
|
|
116
|
-
input: unknown
|
|
117
|
-
]>;
|
|
118
|
-
/**
|
|
119
|
-
* The maximum length of the URL.
|
|
120
|
-
*
|
|
121
|
-
* @default 2083
|
|
122
|
-
*/
|
|
123
|
-
maxUrlLength?: Value<number, [
|
|
124
|
-
options: ClientOptionsOut<T>,
|
|
125
|
-
path: readonly string[],
|
|
126
|
-
input: unknown
|
|
127
|
-
]>;
|
|
128
|
-
/**
|
|
129
|
-
* The method used to make the request.
|
|
130
|
-
*
|
|
131
|
-
* @default 'POST'
|
|
132
|
-
*/
|
|
133
|
-
method?: Value<HTTPMethod, [
|
|
134
|
-
options: ClientOptionsOut<T>,
|
|
135
|
-
path: readonly string[],
|
|
136
|
-
input: unknown
|
|
137
|
-
]>;
|
|
138
|
-
/**
|
|
139
|
-
* The method to use when the payload cannot safely pass to the server with method return from method function.
|
|
140
|
-
* GET is not allowed, it's very dangerous.
|
|
141
|
-
*
|
|
142
|
-
* @default 'POST'
|
|
143
|
-
*/
|
|
144
|
-
fallbackMethod?: Exclude<HTTPMethod, 'GET'>;
|
|
145
|
-
/**
|
|
146
|
-
* Inject headers to the request.
|
|
147
|
-
*/
|
|
148
|
-
headers?: Value<StandardHeaders, [
|
|
149
|
-
options: ClientOptionsOut<T>,
|
|
150
|
-
path: readonly string[],
|
|
151
|
-
input: unknown
|
|
152
|
-
]>;
|
|
153
|
-
}
|
|
154
|
-
declare class StandardRPCLinkCodec<T extends ClientContext> implements StandardLinkCodec<T> {
|
|
155
|
-
private readonly serializer;
|
|
156
|
-
private readonly baseUrl;
|
|
157
|
-
private readonly maxUrlLength;
|
|
158
|
-
private readonly fallbackMethod;
|
|
159
|
-
private readonly expectedMethod;
|
|
160
|
-
private readonly headers;
|
|
161
|
-
constructor(serializer: StandardRPCSerializer, options: StandardRPCLinkCodecOptions<T>);
|
|
162
|
-
encode(path: readonly string[], input: unknown, options: ClientOptionsOut<any>): Promise<StandardRequest>;
|
|
163
|
-
decode(response: StandardLazyResponse): Promise<unknown>;
|
|
164
|
-
}
|
|
165
|
-
|
|
166
|
-
interface StandardRPCLinkOptions<T extends ClientContext> extends StandardLinkOptions<T>, StandardRPCLinkCodecOptions<T>, StandardRPCJsonSerializerOptions {
|
|
167
|
-
}
|
|
168
|
-
|
|
169
|
-
export { InvalidEventIteratorRetryResponse, STANDARD_RPC_JSON_SERIALIZER_BUILT_IN_TYPES, StandardLink, type StandardLinkClient, type StandardLinkCodec, type StandardLinkOptions, type StandardRPCCustomJsonSerializer, type StandardRPCJsonSerialized, type StandardRPCJsonSerializedMetaItem, StandardRPCJsonSerializer, type StandardRPCJsonSerializerOptions, StandardRPCLinkCodec, type StandardRPCLinkCodecOptions, type StandardRPCLinkOptions, StandardRPCSerializer };
|
|
9
|
+
export { toHttpPath };
|
|
@@ -1,169 +1,9 @@
|
|
|
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.BaocqKnn.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.CZFIVTQj.js';
|
|
3
|
+
import { H as HTTPPath } from '../../shared/client.87WXDX8t.js';
|
|
4
|
+
import '@orpc/shared';
|
|
5
|
+
import '@orpc/standard-server';
|
|
4
6
|
|
|
5
|
-
|
|
6
|
-
encode(path: readonly string[], input: unknown, options: ClientOptionsOut<any>): Promise<StandardRequest>;
|
|
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;
|
|
12
8
|
|
|
13
|
-
|
|
14
|
-
}
|
|
15
|
-
interface StandardLinkOptions<T extends ClientContext> {
|
|
16
|
-
/**
|
|
17
|
-
* Maximum retry attempts for **consecutive failures** 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
|
-
declare const STANDARD_RPC_JSON_SERIALIZER_BUILT_IN_TYPES: {
|
|
72
|
-
readonly BIGINT: 0;
|
|
73
|
-
readonly DATE: 1;
|
|
74
|
-
readonly NAN: 2;
|
|
75
|
-
readonly UNDEFINED: 3;
|
|
76
|
-
readonly URL: 4;
|
|
77
|
-
readonly REGEXP: 5;
|
|
78
|
-
readonly SET: 6;
|
|
79
|
-
readonly MAP: 7;
|
|
80
|
-
};
|
|
81
|
-
type StandardRPCJsonSerializedMetaItem = readonly [type: number, ...path: Segment[]];
|
|
82
|
-
type StandardRPCJsonSerialized = [json: unknown, meta: StandardRPCJsonSerializedMetaItem[], maps: Segment[][], blobs: Blob[]];
|
|
83
|
-
interface StandardRPCCustomJsonSerializer {
|
|
84
|
-
type: number;
|
|
85
|
-
condition(data: unknown): boolean;
|
|
86
|
-
serialize(data: any): unknown;
|
|
87
|
-
deserialize(serialized: any): unknown;
|
|
88
|
-
}
|
|
89
|
-
interface StandardRPCJsonSerializerOptions {
|
|
90
|
-
customJsonSerializers?: readonly StandardRPCCustomJsonSerializer[];
|
|
91
|
-
}
|
|
92
|
-
declare class StandardRPCJsonSerializer {
|
|
93
|
-
private readonly customSerializers;
|
|
94
|
-
constructor(options?: StandardRPCJsonSerializerOptions);
|
|
95
|
-
serialize(data: unknown, segments?: Segment[], meta?: StandardRPCJsonSerializedMetaItem[], maps?: Segment[][], blobs?: Blob[]): StandardRPCJsonSerialized;
|
|
96
|
-
deserialize(json: unknown, meta: readonly StandardRPCJsonSerializedMetaItem[]): unknown;
|
|
97
|
-
deserialize(json: unknown, meta: readonly StandardRPCJsonSerializedMetaItem[], maps: readonly Segment[][], getBlob: (index: number) => Blob): unknown;
|
|
98
|
-
}
|
|
99
|
-
|
|
100
|
-
declare class StandardRPCSerializer {
|
|
101
|
-
#private;
|
|
102
|
-
private readonly jsonSerializer;
|
|
103
|
-
constructor(jsonSerializer: StandardRPCJsonSerializer);
|
|
104
|
-
serialize(data: unknown): unknown;
|
|
105
|
-
deserialize(data: unknown): unknown;
|
|
106
|
-
}
|
|
107
|
-
|
|
108
|
-
type HTTPMethod = 'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH';
|
|
109
|
-
interface StandardRPCLinkCodecOptions<T extends ClientContext> {
|
|
110
|
-
/**
|
|
111
|
-
* Base url for all requests.
|
|
112
|
-
*/
|
|
113
|
-
url: Value<string | URL, [
|
|
114
|
-
options: ClientOptionsOut<T>,
|
|
115
|
-
path: readonly string[],
|
|
116
|
-
input: unknown
|
|
117
|
-
]>;
|
|
118
|
-
/**
|
|
119
|
-
* The maximum length of the URL.
|
|
120
|
-
*
|
|
121
|
-
* @default 2083
|
|
122
|
-
*/
|
|
123
|
-
maxUrlLength?: Value<number, [
|
|
124
|
-
options: ClientOptionsOut<T>,
|
|
125
|
-
path: readonly string[],
|
|
126
|
-
input: unknown
|
|
127
|
-
]>;
|
|
128
|
-
/**
|
|
129
|
-
* The method used to make the request.
|
|
130
|
-
*
|
|
131
|
-
* @default 'POST'
|
|
132
|
-
*/
|
|
133
|
-
method?: Value<HTTPMethod, [
|
|
134
|
-
options: ClientOptionsOut<T>,
|
|
135
|
-
path: readonly string[],
|
|
136
|
-
input: unknown
|
|
137
|
-
]>;
|
|
138
|
-
/**
|
|
139
|
-
* The method to use when the payload cannot safely pass to the server with method return from method function.
|
|
140
|
-
* GET is not allowed, it's very dangerous.
|
|
141
|
-
*
|
|
142
|
-
* @default 'POST'
|
|
143
|
-
*/
|
|
144
|
-
fallbackMethod?: Exclude<HTTPMethod, 'GET'>;
|
|
145
|
-
/**
|
|
146
|
-
* Inject headers to the request.
|
|
147
|
-
*/
|
|
148
|
-
headers?: Value<StandardHeaders, [
|
|
149
|
-
options: ClientOptionsOut<T>,
|
|
150
|
-
path: readonly string[],
|
|
151
|
-
input: unknown
|
|
152
|
-
]>;
|
|
153
|
-
}
|
|
154
|
-
declare class StandardRPCLinkCodec<T extends ClientContext> implements StandardLinkCodec<T> {
|
|
155
|
-
private readonly serializer;
|
|
156
|
-
private readonly baseUrl;
|
|
157
|
-
private readonly maxUrlLength;
|
|
158
|
-
private readonly fallbackMethod;
|
|
159
|
-
private readonly expectedMethod;
|
|
160
|
-
private readonly headers;
|
|
161
|
-
constructor(serializer: StandardRPCSerializer, options: StandardRPCLinkCodecOptions<T>);
|
|
162
|
-
encode(path: readonly string[], input: unknown, options: ClientOptionsOut<any>): Promise<StandardRequest>;
|
|
163
|
-
decode(response: StandardLazyResponse): Promise<unknown>;
|
|
164
|
-
}
|
|
165
|
-
|
|
166
|
-
interface StandardRPCLinkOptions<T extends ClientContext> extends StandardLinkOptions<T>, StandardRPCLinkCodecOptions<T>, StandardRPCJsonSerializerOptions {
|
|
167
|
-
}
|
|
168
|
-
|
|
169
|
-
export { InvalidEventIteratorRetryResponse, STANDARD_RPC_JSON_SERIALIZER_BUILT_IN_TYPES, StandardLink, type StandardLinkClient, type StandardLinkCodec, type StandardLinkOptions, type StandardRPCCustomJsonSerializer, type StandardRPCJsonSerialized, type StandardRPCJsonSerializedMetaItem, StandardRPCJsonSerializer, type StandardRPCJsonSerializerOptions, StandardRPCLinkCodec, type StandardRPCLinkCodecOptions, type StandardRPCLinkOptions, StandardRPCSerializer };
|
|
9
|
+
export { toHttpPath };
|
|
@@ -1,4 +1,4 @@
|
|
|
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 } from '../../shared/client.
|
|
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, t as toHttpPath } from '../../shared/client.D77bw0hs.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,5 +1,5 @@
|
|
|
1
|
-
import { N as NestedClient,
|
|
2
|
-
export {
|
|
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.87WXDX8t.mjs';
|
|
2
|
+
export { f as Client, e as ClientRest, d as HTTPMethod, H as HTTPPath } from './shared/client.87WXDX8t.mjs';
|
|
3
3
|
import { Promisable, MaybeOptionalOptions } from '@orpc/shared';
|
|
4
4
|
export { onError, onFinish, onStart, onSuccess } from '@orpc/shared';
|
|
5
5
|
export { ErrorEvent } from '@orpc/standard-server';
|
|
@@ -18,8 +18,8 @@ declare function createORPCClient<T extends NestedClient<any>>(link: ClientLink<
|
|
|
18
18
|
*/
|
|
19
19
|
declare class DynamicLink<TClientContext extends ClientContext> implements ClientLink<TClientContext> {
|
|
20
20
|
private readonly linkResolver;
|
|
21
|
-
constructor(linkResolver: (options:
|
|
22
|
-
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>;
|
|
23
23
|
}
|
|
24
24
|
|
|
25
25
|
declare const COMMON_ORPC_ERROR_DEFS: {
|
|
@@ -126,17 +126,12 @@ declare class ORPCError<TCode extends ORPCErrorCode, TData> extends Error {
|
|
|
126
126
|
type ORPCErrorJSON<TCode extends string, TData> = Pick<ORPCError<TCode, TData>, 'defined' | 'code' | 'status' | 'message' | 'data'>;
|
|
127
127
|
declare function isDefinedError<T>(error: T): error is Extract<T, ORPCError<any, any>>;
|
|
128
128
|
declare function toORPCError(error: unknown): ORPCError<any, any>;
|
|
129
|
+
declare function isORPCErrorStatus(status: number): boolean;
|
|
129
130
|
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
|
|
134
|
-
}
|
|
135
|
-
declare function registerEventIteratorState(iterator: AsyncIteratorObject<unknown, unknown, void>, state: EventIteratorState): void;
|
|
136
|
-
declare function updateEventIteratorStatus(state: EventIteratorState, status: ConnectionStatus): void;
|
|
137
|
-
declare function onEventIteratorStatusChange(iterator: AsyncIteratorObject<unknown, unknown, void>, callback: (status: ConnectionStatus) => void, options?: {
|
|
138
|
-
notifyImmediately?: boolean;
|
|
139
|
-
}): () => 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>;
|
|
140
135
|
|
|
141
136
|
type SafeResult<TOutput, TError extends Error> = [error: null, data: TOutput, isDefined: false] & {
|
|
142
137
|
error: null;
|
|
@@ -152,5 +147,6 @@ type SafeResult<TOutput, TError extends Error> = [error: null, data: TOutput, is
|
|
|
152
147
|
isDefined: true;
|
|
153
148
|
};
|
|
154
149
|
declare function safe<TOutput, TError extends Error>(promise: ClientPromiseResult<TOutput, TError>): Promise<SafeResult<TOutput, TError>>;
|
|
150
|
+
declare function resolveFriendlyClientOptions<T extends ClientContext>(options: FriendlyClientOptions<T>): ClientOptions<T>;
|
|
155
151
|
|
|
156
|
-
export { COMMON_ORPC_ERROR_DEFS, ClientContext, ClientLink,
|
|
152
|
+
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,5 +1,5 @@
|
|
|
1
|
-
import { N as NestedClient,
|
|
2
|
-
export {
|
|
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.87WXDX8t.js';
|
|
2
|
+
export { f as Client, e as ClientRest, d as HTTPMethod, H as HTTPPath } from './shared/client.87WXDX8t.js';
|
|
3
3
|
import { Promisable, MaybeOptionalOptions } from '@orpc/shared';
|
|
4
4
|
export { onError, onFinish, onStart, onSuccess } from '@orpc/shared';
|
|
5
5
|
export { ErrorEvent } from '@orpc/standard-server';
|
|
@@ -18,8 +18,8 @@ declare function createORPCClient<T extends NestedClient<any>>(link: ClientLink<
|
|
|
18
18
|
*/
|
|
19
19
|
declare class DynamicLink<TClientContext extends ClientContext> implements ClientLink<TClientContext> {
|
|
20
20
|
private readonly linkResolver;
|
|
21
|
-
constructor(linkResolver: (options:
|
|
22
|
-
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>;
|
|
23
23
|
}
|
|
24
24
|
|
|
25
25
|
declare const COMMON_ORPC_ERROR_DEFS: {
|
|
@@ -126,17 +126,12 @@ declare class ORPCError<TCode extends ORPCErrorCode, TData> extends Error {
|
|
|
126
126
|
type ORPCErrorJSON<TCode extends string, TData> = Pick<ORPCError<TCode, TData>, 'defined' | 'code' | 'status' | 'message' | 'data'>;
|
|
127
127
|
declare function isDefinedError<T>(error: T): error is Extract<T, ORPCError<any, any>>;
|
|
128
128
|
declare function toORPCError(error: unknown): ORPCError<any, any>;
|
|
129
|
+
declare function isORPCErrorStatus(status: number): boolean;
|
|
129
130
|
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
|
|
134
|
-
}
|
|
135
|
-
declare function registerEventIteratorState(iterator: AsyncIteratorObject<unknown, unknown, void>, state: EventIteratorState): void;
|
|
136
|
-
declare function updateEventIteratorStatus(state: EventIteratorState, status: ConnectionStatus): void;
|
|
137
|
-
declare function onEventIteratorStatusChange(iterator: AsyncIteratorObject<unknown, unknown, void>, callback: (status: ConnectionStatus) => void, options?: {
|
|
138
|
-
notifyImmediately?: boolean;
|
|
139
|
-
}): () => 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>;
|
|
140
135
|
|
|
141
136
|
type SafeResult<TOutput, TError extends Error> = [error: null, data: TOutput, isDefined: false] & {
|
|
142
137
|
error: null;
|
|
@@ -152,5 +147,6 @@ type SafeResult<TOutput, TError extends Error> = [error: null, data: TOutput, is
|
|
|
152
147
|
isDefined: true;
|
|
153
148
|
};
|
|
154
149
|
declare function safe<TOutput, TError extends Error>(promise: ClientPromiseResult<TOutput, TError>): Promise<SafeResult<TOutput, TError>>;
|
|
150
|
+
declare function resolveFriendlyClientOptions<T extends ClientContext>(options: FriendlyClientOptions<T>): ClientOptions<T>;
|
|
155
151
|
|
|
156
|
-
export { COMMON_ORPC_ERROR_DEFS, ClientContext, ClientLink,
|
|
152
|
+
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 };
|