@orpc/client 1.0.0-beta.3 → 1.0.0-beta.5
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 +9 -0
- package/dist/adapters/fetch/index.d.mts +9 -13
- package/dist/adapters/fetch/index.d.ts +9 -13
- package/dist/adapters/fetch/index.mjs +5 -10
- package/dist/adapters/standard/index.d.mts +8 -103
- package/dist/adapters/standard/index.d.ts +8 -103
- package/dist/adapters/standard/index.mjs +2 -3
- package/dist/index.d.mts +16 -11
- package/dist/index.d.ts +16 -11
- package/dist/index.mjs +34 -32
- package/dist/plugins/index.d.mts +7 -8
- package/dist/plugins/index.d.ts +7 -8
- package/dist/plugins/index.mjs +0 -1
- package/dist/shared/{client.aGal-uGY.d.ts → client.5813Ufvs.d.mts} +14 -20
- 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.3Q53fveR.mjs → client.DhAxdT4W.mjs} +23 -21
- package/dist/shared/{client.DrOAzyMB.d.mts → client.grRbC25r.d.ts} +14 -20
- package/dist/shared/{client.BacCdg3F.mjs → client.jKEwIsRd.mjs} +6 -3
- package/package.json +4 -4
- package/dist/shared/client.CupM8eRP.d.mts +0 -30
- package/dist/shared/client.CupM8eRP.d.ts +0 -30
- package/dist/shared/client.CvnV7_uV.mjs +0 -12
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).
|
@@ -87,6 +88,14 @@ const client: RouterClient<typeof router> = createORPCClient(link)
|
|
87
88
|
const client: ContractRouterClient<typeof contract> = createORPCClient(link)
|
88
89
|
```
|
89
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
|
+
|
90
99
|
## License
|
91
100
|
|
92
101
|
Distributed under the MIT License. See [LICENSE](https://github.com/unnoq/orpc/blob/main/LICENSE) for more information.
|
@@ -1,30 +1,26 @@
|
|
1
1
|
import { StandardRequest, StandardLazyResponse } from '@orpc/standard-server';
|
2
2
|
import { ToFetchRequestOptions } from '@orpc/standard-server-fetch';
|
3
|
-
import { a as ClientContext,
|
4
|
-
import {
|
5
|
-
import { StandardRPCLinkOptions } from '
|
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';
|
6
6
|
import '@orpc/shared';
|
7
7
|
|
8
8
|
interface LinkFetchClientOptions<T extends ClientContext> extends ToFetchRequestOptions {
|
9
|
-
fetch?: (request: Request, init:
|
9
|
+
fetch?: (request: Request, init: {
|
10
|
+
redirect?: Request['redirect'];
|
11
|
+
}, options: ClientOptions<T>, path: readonly string[], input: unknown) => Promise<Response>;
|
10
12
|
}
|
11
13
|
declare class LinkFetchClient<T extends ClientContext> implements StandardLinkClient<T> {
|
12
14
|
private readonly fetch;
|
13
15
|
private readonly toFetchRequestOptions;
|
14
16
|
constructor(options: LinkFetchClientOptions<T>);
|
15
|
-
call(request: StandardRequest, options:
|
17
|
+
call(request: StandardRequest, options: ClientOptions<T>, path: readonly string[], input: unknown): Promise<StandardLazyResponse>;
|
16
18
|
}
|
17
19
|
|
18
20
|
interface RPCLinkOptions<T extends ClientContext> extends StandardRPCLinkOptions<T>, LinkFetchClientOptions<T> {
|
19
21
|
}
|
20
|
-
declare class RPCLink<T extends ClientContext>
|
21
|
-
private readonly standardLink;
|
22
|
+
declare class RPCLink<T extends ClientContext> extends StandardLink<T> {
|
22
23
|
constructor(options: RPCLinkOptions<T>);
|
23
|
-
call(path: readonly string[], input: unknown, options: ClientOptionsOut<T>): Promise<unknown>;
|
24
24
|
}
|
25
25
|
|
26
|
-
|
27
|
-
(url: URL, init: RequestInit, options: ClientOptionsOut<TClientContext>, path: readonly string[], input: unknown): Promise<Response>;
|
28
|
-
}
|
29
|
-
|
30
|
-
export { type FetchWithContext, LinkFetchClient, type LinkFetchClientOptions, RPCLink, type RPCLinkOptions };
|
26
|
+
export { LinkFetchClient, type LinkFetchClientOptions, RPCLink, type RPCLinkOptions };
|
@@ -1,30 +1,26 @@
|
|
1
1
|
import { StandardRequest, StandardLazyResponse } from '@orpc/standard-server';
|
2
2
|
import { ToFetchRequestOptions } from '@orpc/standard-server-fetch';
|
3
|
-
import { a as ClientContext,
|
4
|
-
import {
|
5
|
-
import { StandardRPCLinkOptions } from '
|
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';
|
6
6
|
import '@orpc/shared';
|
7
7
|
|
8
8
|
interface LinkFetchClientOptions<T extends ClientContext> extends ToFetchRequestOptions {
|
9
|
-
fetch?: (request: Request, init:
|
9
|
+
fetch?: (request: Request, init: {
|
10
|
+
redirect?: Request['redirect'];
|
11
|
+
}, options: ClientOptions<T>, path: readonly string[], input: unknown) => Promise<Response>;
|
10
12
|
}
|
11
13
|
declare class LinkFetchClient<T extends ClientContext> implements StandardLinkClient<T> {
|
12
14
|
private readonly fetch;
|
13
15
|
private readonly toFetchRequestOptions;
|
14
16
|
constructor(options: LinkFetchClientOptions<T>);
|
15
|
-
call(request: StandardRequest, options:
|
17
|
+
call(request: StandardRequest, options: ClientOptions<T>, path: readonly string[], input: unknown): Promise<StandardLazyResponse>;
|
16
18
|
}
|
17
19
|
|
18
20
|
interface RPCLinkOptions<T extends ClientContext> extends StandardRPCLinkOptions<T>, LinkFetchClientOptions<T> {
|
19
21
|
}
|
20
|
-
declare class RPCLink<T extends ClientContext>
|
21
|
-
private readonly standardLink;
|
22
|
+
declare class RPCLink<T extends ClientContext> extends StandardLink<T> {
|
22
23
|
constructor(options: RPCLinkOptions<T>);
|
23
|
-
call(path: readonly string[], input: unknown, options: ClientOptionsOut<T>): Promise<unknown>;
|
24
24
|
}
|
25
25
|
|
26
|
-
|
27
|
-
(url: URL, init: RequestInit, options: ClientOptionsOut<TClientContext>, path: readonly string[], input: unknown): Promise<Response>;
|
28
|
-
}
|
29
|
-
|
30
|
-
export { type FetchWithContext, LinkFetchClient, type LinkFetchClientOptions, RPCLink, type RPCLinkOptions };
|
26
|
+
export { LinkFetchClient, type LinkFetchClientOptions, RPCLink, type RPCLinkOptions };
|
@@ -1,9 +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.DhAxdT4W.mjs';
|
3
3
|
import '@orpc/shared';
|
4
|
-
import '../../shared/client.CvnV7_uV.mjs';
|
5
4
|
import '@orpc/standard-server';
|
6
|
-
import '../../shared/client.
|
5
|
+
import '../../shared/client.jKEwIsRd.mjs';
|
7
6
|
|
8
7
|
class LinkFetchClient {
|
9
8
|
fetch;
|
@@ -14,23 +13,19 @@ class LinkFetchClient {
|
|
14
13
|
}
|
15
14
|
async call(request, options, path, input) {
|
16
15
|
const fetchRequest = toFetchRequest(request, this.toFetchRequestOptions);
|
17
|
-
const fetchResponse = await this.fetch(fetchRequest, {}, options, path, input);
|
16
|
+
const fetchResponse = await this.fetch(fetchRequest, { redirect: "manual" }, options, path, input);
|
18
17
|
const lazyResponse = toStandardLazyResponse(fetchResponse);
|
19
18
|
return lazyResponse;
|
20
19
|
}
|
21
20
|
}
|
22
21
|
|
23
|
-
class RPCLink {
|
24
|
-
standardLink;
|
22
|
+
class RPCLink extends StandardLink {
|
25
23
|
constructor(options) {
|
26
24
|
const jsonSerializer = new StandardRPCJsonSerializer(options);
|
27
25
|
const serializer = new StandardRPCSerializer(jsonSerializer);
|
28
26
|
const linkCodec = new StandardRPCLinkCodec(serializer, options);
|
29
27
|
const linkClient = new LinkFetchClient(options);
|
30
|
-
|
31
|
-
}
|
32
|
-
async call(path, input, options) {
|
33
|
-
return this.standardLink.call(path, input, options);
|
28
|
+
super(linkCodec, linkClient, options);
|
34
29
|
}
|
35
30
|
}
|
36
31
|
|
@@ -1,105 +1,10 @@
|
|
1
|
-
|
2
|
-
export {
|
3
|
-
import {
|
4
|
-
import
|
5
|
-
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';
|
6
6
|
|
7
|
-
declare
|
8
|
-
|
9
|
-
readonly DATE: 1;
|
10
|
-
readonly NAN: 2;
|
11
|
-
readonly UNDEFINED: 3;
|
12
|
-
readonly URL: 4;
|
13
|
-
readonly REGEXP: 5;
|
14
|
-
readonly SET: 6;
|
15
|
-
readonly MAP: 7;
|
16
|
-
};
|
17
|
-
type StandardRPCJsonSerializedMetaItem = readonly [type: number, ...path: Segment[]];
|
18
|
-
type StandardRPCJsonSerialized = [json: unknown, meta: StandardRPCJsonSerializedMetaItem[], maps: Segment[][], blobs: Blob[]];
|
19
|
-
interface StandardRPCCustomJsonSerializer {
|
20
|
-
type: number;
|
21
|
-
condition(data: unknown): boolean;
|
22
|
-
serialize(data: any): unknown;
|
23
|
-
deserialize(serialized: any): unknown;
|
24
|
-
}
|
25
|
-
interface StandardRPCJsonSerializerOptions {
|
26
|
-
customJsonSerializers?: readonly StandardRPCCustomJsonSerializer[];
|
27
|
-
}
|
28
|
-
declare class StandardRPCJsonSerializer {
|
29
|
-
private readonly customSerializers;
|
30
|
-
constructor(options?: StandardRPCJsonSerializerOptions);
|
31
|
-
serialize(data: unknown, segments?: Segment[], meta?: StandardRPCJsonSerializedMetaItem[], maps?: Segment[][], blobs?: Blob[]): StandardRPCJsonSerialized;
|
32
|
-
deserialize(json: unknown, meta: readonly StandardRPCJsonSerializedMetaItem[]): unknown;
|
33
|
-
deserialize(json: unknown, meta: readonly StandardRPCJsonSerializedMetaItem[], maps: readonly Segment[][], getBlob: (index: number) => Blob): unknown;
|
34
|
-
}
|
7
|
+
declare function toHttpPath(path: readonly string[]): HTTPPath;
|
8
|
+
declare function getMalformedResponseErrorCode(status: number): string;
|
35
9
|
|
36
|
-
|
37
|
-
#private;
|
38
|
-
private readonly jsonSerializer;
|
39
|
-
constructor(jsonSerializer: StandardRPCJsonSerializer);
|
40
|
-
serialize(data: unknown): object;
|
41
|
-
deserialize(data: unknown): unknown;
|
42
|
-
}
|
43
|
-
|
44
|
-
type HTTPMethod = 'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH';
|
45
|
-
interface StandardRPCLinkCodecOptions<T extends ClientContext> {
|
46
|
-
/**
|
47
|
-
* Base url for all requests.
|
48
|
-
*/
|
49
|
-
url: Value<string | URL, [
|
50
|
-
options: ClientOptionsOut<T>,
|
51
|
-
path: readonly string[],
|
52
|
-
input: unknown
|
53
|
-
]>;
|
54
|
-
/**
|
55
|
-
* The maximum length of the URL.
|
56
|
-
*
|
57
|
-
* @default 2083
|
58
|
-
*/
|
59
|
-
maxUrlLength?: Value<number, [
|
60
|
-
options: ClientOptionsOut<T>,
|
61
|
-
path: readonly string[],
|
62
|
-
input: unknown
|
63
|
-
]>;
|
64
|
-
/**
|
65
|
-
* The method used to make the request.
|
66
|
-
*
|
67
|
-
* @default 'POST'
|
68
|
-
*/
|
69
|
-
method?: Value<HTTPMethod, [
|
70
|
-
options: ClientOptionsOut<T>,
|
71
|
-
path: readonly string[],
|
72
|
-
input: unknown
|
73
|
-
]>;
|
74
|
-
/**
|
75
|
-
* The method to use when the payload cannot safely pass to the server with method return from method function.
|
76
|
-
* GET is not allowed, it's very dangerous.
|
77
|
-
*
|
78
|
-
* @default 'POST'
|
79
|
-
*/
|
80
|
-
fallbackMethod?: Exclude<HTTPMethod, 'GET'>;
|
81
|
-
/**
|
82
|
-
* Inject headers to the request.
|
83
|
-
*/
|
84
|
-
headers?: Value<StandardHeaders, [
|
85
|
-
options: ClientOptionsOut<T>,
|
86
|
-
path: readonly string[],
|
87
|
-
input: unknown
|
88
|
-
]>;
|
89
|
-
}
|
90
|
-
declare class StandardRPCLinkCodec<T extends ClientContext> implements StandardLinkCodec<T> {
|
91
|
-
private readonly serializer;
|
92
|
-
private readonly baseUrl;
|
93
|
-
private readonly maxUrlLength;
|
94
|
-
private readonly fallbackMethod;
|
95
|
-
private readonly expectedMethod;
|
96
|
-
private readonly headers;
|
97
|
-
constructor(serializer: StandardRPCSerializer, options: StandardRPCLinkCodecOptions<T>);
|
98
|
-
encode(path: readonly string[], input: unknown, options: ClientOptionsOut<any>): Promise<StandardRequest>;
|
99
|
-
decode(response: StandardLazyResponse): Promise<unknown>;
|
100
|
-
}
|
101
|
-
|
102
|
-
interface StandardRPCLinkOptions<T extends ClientContext> extends StandardLinkOptions<T>, StandardRPCLinkCodecOptions<T>, StandardRPCJsonSerializerOptions {
|
103
|
-
}
|
104
|
-
|
105
|
-
export { STANDARD_RPC_JSON_SERIALIZER_BUILT_IN_TYPES, StandardLinkCodec, StandardLinkOptions, type StandardRPCCustomJsonSerializer, type StandardRPCJsonSerialized, type StandardRPCJsonSerializedMetaItem, StandardRPCJsonSerializer, type StandardRPCJsonSerializerOptions, StandardRPCLinkCodec, type StandardRPCLinkCodecOptions, type StandardRPCLinkOptions, StandardRPCSerializer };
|
10
|
+
export { getMalformedResponseErrorCode, toHttpPath };
|
@@ -1,105 +1,10 @@
|
|
1
|
-
|
2
|
-
export {
|
3
|
-
import {
|
4
|
-
import
|
5
|
-
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';
|
6
6
|
|
7
|
-
declare
|
8
|
-
|
9
|
-
readonly DATE: 1;
|
10
|
-
readonly NAN: 2;
|
11
|
-
readonly UNDEFINED: 3;
|
12
|
-
readonly URL: 4;
|
13
|
-
readonly REGEXP: 5;
|
14
|
-
readonly SET: 6;
|
15
|
-
readonly MAP: 7;
|
16
|
-
};
|
17
|
-
type StandardRPCJsonSerializedMetaItem = readonly [type: number, ...path: Segment[]];
|
18
|
-
type StandardRPCJsonSerialized = [json: unknown, meta: StandardRPCJsonSerializedMetaItem[], maps: Segment[][], blobs: Blob[]];
|
19
|
-
interface StandardRPCCustomJsonSerializer {
|
20
|
-
type: number;
|
21
|
-
condition(data: unknown): boolean;
|
22
|
-
serialize(data: any): unknown;
|
23
|
-
deserialize(serialized: any): unknown;
|
24
|
-
}
|
25
|
-
interface StandardRPCJsonSerializerOptions {
|
26
|
-
customJsonSerializers?: readonly StandardRPCCustomJsonSerializer[];
|
27
|
-
}
|
28
|
-
declare class StandardRPCJsonSerializer {
|
29
|
-
private readonly customSerializers;
|
30
|
-
constructor(options?: StandardRPCJsonSerializerOptions);
|
31
|
-
serialize(data: unknown, segments?: Segment[], meta?: StandardRPCJsonSerializedMetaItem[], maps?: Segment[][], blobs?: Blob[]): StandardRPCJsonSerialized;
|
32
|
-
deserialize(json: unknown, meta: readonly StandardRPCJsonSerializedMetaItem[]): unknown;
|
33
|
-
deserialize(json: unknown, meta: readonly StandardRPCJsonSerializedMetaItem[], maps: readonly Segment[][], getBlob: (index: number) => Blob): unknown;
|
34
|
-
}
|
7
|
+
declare function toHttpPath(path: readonly string[]): HTTPPath;
|
8
|
+
declare function getMalformedResponseErrorCode(status: number): string;
|
35
9
|
|
36
|
-
|
37
|
-
#private;
|
38
|
-
private readonly jsonSerializer;
|
39
|
-
constructor(jsonSerializer: StandardRPCJsonSerializer);
|
40
|
-
serialize(data: unknown): object;
|
41
|
-
deserialize(data: unknown): unknown;
|
42
|
-
}
|
43
|
-
|
44
|
-
type HTTPMethod = 'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH';
|
45
|
-
interface StandardRPCLinkCodecOptions<T extends ClientContext> {
|
46
|
-
/**
|
47
|
-
* Base url for all requests.
|
48
|
-
*/
|
49
|
-
url: Value<string | URL, [
|
50
|
-
options: ClientOptionsOut<T>,
|
51
|
-
path: readonly string[],
|
52
|
-
input: unknown
|
53
|
-
]>;
|
54
|
-
/**
|
55
|
-
* The maximum length of the URL.
|
56
|
-
*
|
57
|
-
* @default 2083
|
58
|
-
*/
|
59
|
-
maxUrlLength?: Value<number, [
|
60
|
-
options: ClientOptionsOut<T>,
|
61
|
-
path: readonly string[],
|
62
|
-
input: unknown
|
63
|
-
]>;
|
64
|
-
/**
|
65
|
-
* The method used to make the request.
|
66
|
-
*
|
67
|
-
* @default 'POST'
|
68
|
-
*/
|
69
|
-
method?: Value<HTTPMethod, [
|
70
|
-
options: ClientOptionsOut<T>,
|
71
|
-
path: readonly string[],
|
72
|
-
input: unknown
|
73
|
-
]>;
|
74
|
-
/**
|
75
|
-
* The method to use when the payload cannot safely pass to the server with method return from method function.
|
76
|
-
* GET is not allowed, it's very dangerous.
|
77
|
-
*
|
78
|
-
* @default 'POST'
|
79
|
-
*/
|
80
|
-
fallbackMethod?: Exclude<HTTPMethod, 'GET'>;
|
81
|
-
/**
|
82
|
-
* Inject headers to the request.
|
83
|
-
*/
|
84
|
-
headers?: Value<StandardHeaders, [
|
85
|
-
options: ClientOptionsOut<T>,
|
86
|
-
path: readonly string[],
|
87
|
-
input: unknown
|
88
|
-
]>;
|
89
|
-
}
|
90
|
-
declare class StandardRPCLinkCodec<T extends ClientContext> implements StandardLinkCodec<T> {
|
91
|
-
private readonly serializer;
|
92
|
-
private readonly baseUrl;
|
93
|
-
private readonly maxUrlLength;
|
94
|
-
private readonly fallbackMethod;
|
95
|
-
private readonly expectedMethod;
|
96
|
-
private readonly headers;
|
97
|
-
constructor(serializer: StandardRPCSerializer, options: StandardRPCLinkCodecOptions<T>);
|
98
|
-
encode(path: readonly string[], input: unknown, options: ClientOptionsOut<any>): Promise<StandardRequest>;
|
99
|
-
decode(response: StandardLazyResponse): Promise<unknown>;
|
100
|
-
}
|
101
|
-
|
102
|
-
interface StandardRPCLinkOptions<T extends ClientContext> extends StandardLinkOptions<T>, StandardRPCLinkCodecOptions<T>, StandardRPCJsonSerializerOptions {
|
103
|
-
}
|
104
|
-
|
105
|
-
export { STANDARD_RPC_JSON_SERIALIZER_BUILT_IN_TYPES, StandardLinkCodec, StandardLinkOptions, type StandardRPCCustomJsonSerializer, type StandardRPCJsonSerialized, type StandardRPCJsonSerializedMetaItem, StandardRPCJsonSerializer, type StandardRPCJsonSerializerOptions, StandardRPCLinkCodec, type StandardRPCLinkCodecOptions, type StandardRPCLinkOptions, StandardRPCSerializer };
|
10
|
+
export { getMalformedResponseErrorCode, toHttpPath };
|
@@ -1,5 +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, g as getMalformedResponseErrorCode, t as toHttpPath } from '../../shared/client.DhAxdT4W.mjs';
|
2
2
|
import '@orpc/shared';
|
3
|
-
import '../../shared/client.CvnV7_uV.mjs';
|
4
3
|
import '@orpc/standard-server';
|
5
|
-
import '../../shared/client.
|
4
|
+
import '../../shared/client.jKEwIsRd.mjs';
|
package/dist/index.d.mts
CHANGED
@@ -1,7 +1,7 @@
|
|
1
|
-
import { N as NestedClient,
|
2
|
-
export { f as Client, d as
|
3
|
-
import { Promisable, MaybeOptionalOptions } from '@orpc/shared';
|
4
|
-
export { onError, onFinish, onStart, onSuccess } 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';
|
5
5
|
export { ErrorEvent } from '@orpc/standard-server';
|
6
6
|
|
7
7
|
interface createORPCClientOptions {
|
@@ -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,25 +126,30 @@ 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
|
declare function mapEventIterator<TYield, TReturn, TNext, TMap = TYield | TReturn>(iterator: AsyncIterator<TYield, TReturn, TNext>, maps: {
|
131
132
|
value: (value: NoInfer<TYield | TReturn>, done: boolean | undefined) => Promise<TMap>;
|
132
133
|
error: (error: unknown) => Promise<unknown>;
|
133
134
|
}): AsyncGenerator<TMap, TMap, TNext>;
|
134
135
|
|
135
|
-
type SafeResult<TOutput, TError
|
136
|
+
type SafeResult<TOutput, TError> = [error: null, data: TOutput, isDefined: false, success: true] & {
|
136
137
|
error: null;
|
137
138
|
data: TOutput;
|
138
139
|
isDefined: false;
|
139
|
-
|
140
|
+
success: true;
|
141
|
+
} | [error: Exclude<TError, ORPCError<any, any>>, data: undefined, isDefined: false, success: false] & {
|
140
142
|
error: Exclude<TError, ORPCError<any, any>>;
|
141
143
|
data: undefined;
|
142
144
|
isDefined: false;
|
143
|
-
|
145
|
+
success: false;
|
146
|
+
} | [error: Extract<TError, ORPCError<any, any>>, data: undefined, isDefined: true, success: false] & {
|
144
147
|
error: Extract<TError, ORPCError<any, any>>;
|
145
148
|
data: undefined;
|
146
149
|
isDefined: true;
|
150
|
+
success: false;
|
147
151
|
};
|
148
|
-
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>;
|
149
154
|
|
150
|
-
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,7 +1,7 @@
|
|
1
|
-
import { N as NestedClient,
|
2
|
-
export { f as Client, d as
|
3
|
-
import { Promisable, MaybeOptionalOptions } from '@orpc/shared';
|
4
|
-
export { onError, onFinish, onStart, onSuccess } 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';
|
5
5
|
export { ErrorEvent } from '@orpc/standard-server';
|
6
6
|
|
7
7
|
interface createORPCClientOptions {
|
@@ -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,25 +126,30 @@ 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
|
declare function mapEventIterator<TYield, TReturn, TNext, TMap = TYield | TReturn>(iterator: AsyncIterator<TYield, TReturn, TNext>, maps: {
|
131
132
|
value: (value: NoInfer<TYield | TReturn>, done: boolean | undefined) => Promise<TMap>;
|
132
133
|
error: (error: unknown) => Promise<unknown>;
|
133
134
|
}): AsyncGenerator<TMap, TMap, TNext>;
|
134
135
|
|
135
|
-
type SafeResult<TOutput, TError
|
136
|
+
type SafeResult<TOutput, TError> = [error: null, data: TOutput, isDefined: false, success: true] & {
|
136
137
|
error: null;
|
137
138
|
data: TOutput;
|
138
139
|
isDefined: false;
|
139
|
-
|
140
|
+
success: true;
|
141
|
+
} | [error: Exclude<TError, ORPCError<any, any>>, data: undefined, isDefined: false, success: false] & {
|
140
142
|
error: Exclude<TError, ORPCError<any, any>>;
|
141
143
|
data: undefined;
|
142
144
|
isDefined: false;
|
143
|
-
|
145
|
+
success: false;
|
146
|
+
} | [error: Extract<TError, ORPCError<any, any>>, data: undefined, isDefined: true, success: false] & {
|
144
147
|
error: Extract<TError, ORPCError<any, any>>;
|
145
148
|
data: undefined;
|
146
149
|
isDefined: true;
|
150
|
+
success: false;
|
147
151
|
};
|
148
|
-
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>;
|
149
154
|
|
150
|
-
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.mjs
CHANGED
@@ -1,17 +1,41 @@
|
|
1
|
-
import { i as isDefinedError } from './shared/client.
|
2
|
-
export { C as COMMON_ORPC_ERROR_DEFS, O as ORPCError, a as fallbackORPCErrorMessage, f as fallbackORPCErrorStatus, m as mapEventIterator, t as toORPCError } from './shared/client.
|
1
|
+
import { i as isDefinedError } from './shared/client.jKEwIsRd.mjs';
|
2
|
+
export { C as COMMON_ORPC_ERROR_DEFS, O as ORPCError, a as fallbackORPCErrorMessage, f as fallbackORPCErrorStatus, b as isORPCErrorStatus, m as mapEventIterator, t as toORPCError } from './shared/client.jKEwIsRd.mjs';
|
3
3
|
export { onError, onFinish, onStart, onSuccess } from '@orpc/shared';
|
4
4
|
export { ErrorEvent } from '@orpc/standard-server';
|
5
5
|
|
6
|
+
async function safe(promise) {
|
7
|
+
try {
|
8
|
+
const output = await promise;
|
9
|
+
return Object.assign(
|
10
|
+
[null, output, false, true],
|
11
|
+
{ error: null, data: output, isDefined: false, success: true }
|
12
|
+
);
|
13
|
+
} catch (e) {
|
14
|
+
const error = e;
|
15
|
+
if (isDefinedError(error)) {
|
16
|
+
return Object.assign(
|
17
|
+
[error, void 0, true, false],
|
18
|
+
{ error, data: void 0, isDefined: true, success: false }
|
19
|
+
);
|
20
|
+
}
|
21
|
+
return Object.assign(
|
22
|
+
[error, void 0, false, false],
|
23
|
+
{ error, data: void 0, isDefined: false, success: false }
|
24
|
+
);
|
25
|
+
}
|
26
|
+
}
|
27
|
+
function resolveFriendlyClientOptions(options) {
|
28
|
+
return {
|
29
|
+
...options,
|
30
|
+
context: options?.context ?? {}
|
31
|
+
// Context only optional if all fields are optional
|
32
|
+
};
|
33
|
+
}
|
34
|
+
|
6
35
|
function createORPCClient(link, options) {
|
7
36
|
const path = options?.path ?? [];
|
8
|
-
const procedureClient = async (...[input, options2]) => {
|
9
|
-
|
10
|
-
...options2,
|
11
|
-
context: options2?.context ?? {}
|
12
|
-
// options.context can be undefined when all field is optional
|
13
|
-
};
|
14
|
-
return await link.call(path, input, optionsOut);
|
37
|
+
const procedureClient = async (...[input, options2 = {}]) => {
|
38
|
+
return await link.call(path, input, resolveFriendlyClientOptions(options2));
|
15
39
|
};
|
16
40
|
const recursive = new Proxy(procedureClient, {
|
17
41
|
get(target, key) {
|
@@ -38,26 +62,4 @@ class DynamicLink {
|
|
38
62
|
}
|
39
63
|
}
|
40
64
|
|
41
|
-
|
42
|
-
try {
|
43
|
-
const output = await promise;
|
44
|
-
return Object.assign(
|
45
|
-
[null, output, false],
|
46
|
-
{ error: null, data: output, isDefined: false }
|
47
|
-
);
|
48
|
-
} catch (e) {
|
49
|
-
const error = e;
|
50
|
-
if (isDefinedError(error)) {
|
51
|
-
return Object.assign(
|
52
|
-
[error, void 0, true],
|
53
|
-
{ error, data: void 0, isDefined: true }
|
54
|
-
);
|
55
|
-
}
|
56
|
-
return Object.assign(
|
57
|
-
[error, void 0, false],
|
58
|
-
{ error, data: void 0, isDefined: false }
|
59
|
-
);
|
60
|
-
}
|
61
|
-
}
|
62
|
-
|
63
|
-
export { DynamicLink, createORPCClient, isDefinedError, safe };
|
65
|
+
export { DynamicLink, createORPCClient, isDefinedError, resolveFriendlyClientOptions, safe };
|
package/dist/plugins/index.d.mts
CHANGED
@@ -1,7 +1,6 @@
|
|
1
|
-
import { C as ClientPlugin, S as StandardLinkOptions } from '../shared/client.DrOAzyMB.mjs';
|
2
|
-
export { a as CompositeClientPlugin } from '../shared/client.DrOAzyMB.mjs';
|
3
1
|
import { Value } from '@orpc/shared';
|
4
|
-
import {
|
2
|
+
import { S as StandardLinkPlugin, a as StandardLinkOptions } from '../shared/client.5813Ufvs.mjs';
|
3
|
+
import { b as ClientOptions } from '../shared/client.C0lT7w02.mjs';
|
5
4
|
import '@orpc/standard-server';
|
6
5
|
|
7
6
|
interface ClientRetryPluginAttemptOptions {
|
@@ -25,7 +24,7 @@ interface ClientRetryPluginContext {
|
|
25
24
|
*/
|
26
25
|
retryDelay?: Value<number, [
|
27
26
|
attemptOptions: ClientRetryPluginAttemptOptions,
|
28
|
-
clientOptions:
|
27
|
+
clientOptions: ClientOptions<ClientRetryPluginContext>,
|
29
28
|
path: readonly string[],
|
30
29
|
input: unknown
|
31
30
|
]>;
|
@@ -36,21 +35,21 @@ interface ClientRetryPluginContext {
|
|
36
35
|
*/
|
37
36
|
shouldRetry?: Value<boolean, [
|
38
37
|
attemptOptions: ClientRetryPluginAttemptOptions,
|
39
|
-
clientOptions:
|
38
|
+
clientOptions: ClientOptions<ClientRetryPluginContext>,
|
40
39
|
path: readonly string[],
|
41
40
|
input: unknown
|
42
41
|
]>;
|
43
42
|
/**
|
44
43
|
* The hook called when retrying, and return the unsubscribe function.
|
45
44
|
*/
|
46
|
-
onRetry?: (options: ClientRetryPluginAttemptOptions, clientOptions:
|
45
|
+
onRetry?: (options: ClientRetryPluginAttemptOptions, clientOptions: ClientOptions<ClientRetryPluginContext>, path: readonly string[], input: unknown) => void | (() => void);
|
47
46
|
}
|
48
47
|
declare class ClientRetryPluginInvalidEventIteratorRetryResponse extends Error {
|
49
48
|
}
|
50
49
|
interface ClientRetryPluginOptions {
|
51
50
|
default?: ClientRetryPluginContext;
|
52
51
|
}
|
53
|
-
declare class ClientRetryPlugin<T extends
|
52
|
+
declare class ClientRetryPlugin<T extends ClientRetryPluginContext> implements StandardLinkPlugin<T> {
|
54
53
|
private readonly defaultRetry;
|
55
54
|
private readonly defaultRetryDelay;
|
56
55
|
private readonly defaultShouldRetry;
|
@@ -59,4 +58,4 @@ declare class ClientRetryPlugin<T extends ClientContext & ClientRetryPluginConte
|
|
59
58
|
init(options: StandardLinkOptions<T>): void;
|
60
59
|
}
|
61
60
|
|
62
|
-
export {
|
61
|
+
export { ClientRetryPlugin, type ClientRetryPluginAttemptOptions, type ClientRetryPluginContext, ClientRetryPluginInvalidEventIteratorRetryResponse, type ClientRetryPluginOptions };
|