@orpc/client 1.0.0-beta.4 → 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 +1 -0
- package/dist/adapters/fetch/index.d.mts +8 -12
- package/dist/adapters/fetch/index.d.ts +8 -12
- package/dist/adapters/fetch/index.mjs +5 -9
- 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 -2
- package/dist/index.d.mts +13 -9
- package/dist/index.d.ts +13 -9
- package/dist/index.mjs +8 -8
- package/dist/plugins/index.d.mts +2 -2
- package/dist/plugins/index.d.ts +2 -2
- package/dist/shared/{client.CKw2tbcl.d.mts → client.5813Ufvs.d.mts} +5 -5
- package/dist/shared/client.Bt94sjrK.d.mts +103 -0
- package/dist/shared/{client.RZs5Myak.d.mts → client.C0lT7w02.d.mts} +8 -8
- package/dist/shared/{client.RZs5Myak.d.ts → client.C0lT7w02.d.ts} +8 -8
- package/dist/shared/client.D-jrSuDb.d.ts +103 -0
- package/dist/shared/{client.CAwgYDwB.mjs → client.DhAxdT4W.mjs} +17 -15
- package/dist/shared/{client.Bt40CWA-.d.ts → client.grRbC25r.d.ts} +5 -5
- package/dist/shared/{client.BacCdg3F.mjs → client.jKEwIsRd.mjs} +6 -3
- package/package.json +4 -4
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).
|
@@ -1,12 +1,14 @@
|
|
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;
|
@@ -17,14 +19,8 @@ declare class LinkFetchClient<T extends ClientContext> implements StandardLinkCl
|
|
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: ClientOptions<T>): Promise<unknown>;
|
24
24
|
}
|
25
25
|
|
26
|
-
|
27
|
-
(url: URL, init: RequestInit, options: ClientOptions<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,12 +1,14 @@
|
|
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;
|
@@ -17,14 +19,8 @@ declare class LinkFetchClient<T extends ClientContext> implements StandardLinkCl
|
|
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: ClientOptions<T>): Promise<unknown>;
|
24
24
|
}
|
25
25
|
|
26
|
-
|
27
|
-
(url: URL, init: RequestInit, options: ClientOptions<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,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.DhAxdT4W.mjs';
|
3
3
|
import '@orpc/shared';
|
4
|
-
import '../../shared/client.BacCdg3F.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,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: ClientOptions<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: ClientOptions<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: ClientOptions<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: ClientOptions<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: ClientOptions<T>): 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: ClientOptions<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: ClientOptions<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: ClientOptions<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: ClientOptions<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: ClientOptions<T>): 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,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, g as getMalformedResponseErrorCode, t as toHttpPath } from '../../shared/client.DhAxdT4W.mjs';
|
2
2
|
import '@orpc/shared';
|
3
|
-
import '../../shared/client.BacCdg3F.mjs';
|
4
3
|
import '@orpc/standard-server';
|
4
|
+
import '../../shared/client.jKEwIsRd.mjs';
|
package/dist/index.d.mts
CHANGED
@@ -1,7 +1,7 @@
|
|
1
|
-
import { N as NestedClient,
|
2
|
-
export {
|
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 {
|
@@ -126,26 +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>>;
|
149
153
|
declare function resolveFriendlyClientOptions<T extends ClientContext>(options: FriendlyClientOptions<T>): ClientOptions<T>;
|
150
154
|
|
151
|
-
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, mapEventIterator, resolveFriendlyClientOptions, safe, toORPCError };
|
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 {
|
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 {
|
@@ -126,26 +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>>;
|
149
153
|
declare function resolveFriendlyClientOptions<T extends ClientContext>(options: FriendlyClientOptions<T>): ClientOptions<T>;
|
150
154
|
|
151
|
-
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, mapEventIterator, resolveFriendlyClientOptions, safe, toORPCError };
|
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,5 +1,5 @@
|
|
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
|
|
@@ -7,20 +7,20 @@ async function safe(promise) {
|
|
7
7
|
try {
|
8
8
|
const output = await promise;
|
9
9
|
return Object.assign(
|
10
|
-
[null, output, false],
|
11
|
-
{ error: null, data: output, isDefined: false }
|
10
|
+
[null, output, false, true],
|
11
|
+
{ error: null, data: output, isDefined: false, success: true }
|
12
12
|
);
|
13
13
|
} catch (e) {
|
14
14
|
const error = e;
|
15
15
|
if (isDefinedError(error)) {
|
16
16
|
return Object.assign(
|
17
|
-
[error, void 0, true],
|
18
|
-
{ error, data: void 0, isDefined: true }
|
17
|
+
[error, void 0, true, false],
|
18
|
+
{ error, data: void 0, isDefined: true, success: false }
|
19
19
|
);
|
20
20
|
}
|
21
21
|
return Object.assign(
|
22
|
-
[error, void 0, false],
|
23
|
-
{ error, data: void 0, isDefined: false }
|
22
|
+
[error, void 0, false, false],
|
23
|
+
{ error, data: void 0, isDefined: false, success: false }
|
24
24
|
);
|
25
25
|
}
|
26
26
|
}
|
package/dist/plugins/index.d.mts
CHANGED
@@ -1,6 +1,6 @@
|
|
1
1
|
import { Value } from '@orpc/shared';
|
2
|
-
import { S as StandardLinkPlugin, a as StandardLinkOptions } from '../shared/client.
|
3
|
-
import {
|
2
|
+
import { S as StandardLinkPlugin, a as StandardLinkOptions } from '../shared/client.5813Ufvs.mjs';
|
3
|
+
import { b as ClientOptions } from '../shared/client.C0lT7w02.mjs';
|
4
4
|
import '@orpc/standard-server';
|
5
5
|
|
6
6
|
interface ClientRetryPluginAttemptOptions {
|
package/dist/plugins/index.d.ts
CHANGED
@@ -1,6 +1,6 @@
|
|
1
1
|
import { Value } from '@orpc/shared';
|
2
|
-
import { S as StandardLinkPlugin, a as StandardLinkOptions } from '../shared/client.
|
3
|
-
import {
|
2
|
+
import { S as StandardLinkPlugin, a as StandardLinkOptions } from '../shared/client.grRbC25r.js';
|
3
|
+
import { b as ClientOptions } from '../shared/client.C0lT7w02.js';
|
4
4
|
import '@orpc/standard-server';
|
5
5
|
|
6
6
|
interface ClientRetryPluginAttemptOptions {
|
@@ -1,6 +1,6 @@
|
|
1
|
-
import { Interceptor } from '@orpc/shared';
|
1
|
+
import { Interceptor, ThrowableError } from '@orpc/shared';
|
2
2
|
import { StandardRequest, StandardLazyResponse } from '@orpc/standard-server';
|
3
|
-
import { a as ClientContext,
|
3
|
+
import { a as ClientContext, b as ClientOptions, C as ClientLink } from './client.C0lT7w02.mjs';
|
4
4
|
|
5
5
|
interface StandardLinkCodec<T extends ClientContext> {
|
6
6
|
encode(path: readonly string[], input: unknown, options: ClientOptions<T>): Promise<StandardRequest>;
|
@@ -20,10 +20,10 @@ interface StandardLinkOptions<T extends ClientContext> {
|
|
20
20
|
path: readonly string[];
|
21
21
|
input: unknown;
|
22
22
|
options: ClientOptions<T>;
|
23
|
-
}, unknown,
|
23
|
+
}, unknown, ThrowableError>[];
|
24
24
|
clientInterceptors?: Interceptor<{
|
25
25
|
request: StandardRequest;
|
26
|
-
}, StandardLazyResponse,
|
26
|
+
}, StandardLazyResponse, ThrowableError>[];
|
27
27
|
plugins?: StandardLinkPlugin<T>[];
|
28
28
|
}
|
29
29
|
declare class StandardLink<T extends ClientContext> implements ClientLink<T> {
|
@@ -36,4 +36,4 @@ declare class StandardLink<T extends ClientContext> implements ClientLink<T> {
|
|
36
36
|
call(path: readonly string[], input: unknown, options: ClientOptions<T>): Promise<unknown>;
|
37
37
|
}
|
38
38
|
|
39
|
-
export { InvalidEventIteratorRetryResponse as I, type StandardLinkPlugin as S, type StandardLinkOptions as a,
|
39
|
+
export { InvalidEventIteratorRetryResponse as I, type StandardLinkPlugin as S, type StandardLinkOptions as a, StandardLink as b, type StandardLinkCodec as c, type StandardLinkClient as d };
|
@@ -0,0 +1,103 @@
|
|
1
|
+
import { a as ClientContext, b as ClientOptions, d as HTTPMethod } from './client.C0lT7w02.mjs';
|
2
|
+
import { c as StandardLinkCodec, a as StandardLinkOptions } from './client.5813Ufvs.mjs';
|
3
|
+
import { Segment, Value } from '@orpc/shared';
|
4
|
+
import { StandardHeaders, StandardRequest, StandardLazyResponse } from '@orpc/standard-server';
|
5
|
+
|
6
|
+
declare const STANDARD_RPC_JSON_SERIALIZER_BUILT_IN_TYPES: {
|
7
|
+
readonly BIGINT: 0;
|
8
|
+
readonly DATE: 1;
|
9
|
+
readonly NAN: 2;
|
10
|
+
readonly UNDEFINED: 3;
|
11
|
+
readonly URL: 4;
|
12
|
+
readonly REGEXP: 5;
|
13
|
+
readonly SET: 6;
|
14
|
+
readonly MAP: 7;
|
15
|
+
};
|
16
|
+
type StandardRPCJsonSerializedMetaItem = readonly [type: number, ...path: Segment[]];
|
17
|
+
type StandardRPCJsonSerialized = [json: unknown, meta: StandardRPCJsonSerializedMetaItem[], maps: Segment[][], blobs: Blob[]];
|
18
|
+
interface StandardRPCCustomJsonSerializer {
|
19
|
+
type: number;
|
20
|
+
condition(data: unknown): boolean;
|
21
|
+
serialize(data: any): unknown;
|
22
|
+
deserialize(serialized: any): unknown;
|
23
|
+
}
|
24
|
+
interface StandardRPCJsonSerializerOptions {
|
25
|
+
customJsonSerializers?: readonly StandardRPCCustomJsonSerializer[];
|
26
|
+
}
|
27
|
+
declare class StandardRPCJsonSerializer {
|
28
|
+
private readonly customSerializers;
|
29
|
+
constructor(options?: StandardRPCJsonSerializerOptions);
|
30
|
+
serialize(data: unknown, segments?: Segment[], meta?: StandardRPCJsonSerializedMetaItem[], maps?: Segment[][], blobs?: Blob[]): StandardRPCJsonSerialized;
|
31
|
+
deserialize(json: unknown, meta: readonly StandardRPCJsonSerializedMetaItem[]): unknown;
|
32
|
+
deserialize(json: unknown, meta: readonly StandardRPCJsonSerializedMetaItem[], maps: readonly Segment[][], getBlob: (index: number) => Blob): unknown;
|
33
|
+
}
|
34
|
+
|
35
|
+
declare class StandardRPCSerializer {
|
36
|
+
#private;
|
37
|
+
private readonly jsonSerializer;
|
38
|
+
constructor(jsonSerializer: StandardRPCJsonSerializer);
|
39
|
+
serialize(data: unknown): object;
|
40
|
+
deserialize(data: unknown): unknown;
|
41
|
+
}
|
42
|
+
|
43
|
+
interface StandardRPCLinkCodecOptions<T extends ClientContext> {
|
44
|
+
/**
|
45
|
+
* Base url for all requests.
|
46
|
+
*/
|
47
|
+
url: Value<string | URL, [
|
48
|
+
options: ClientOptions<T>,
|
49
|
+
path: readonly string[],
|
50
|
+
input: unknown
|
51
|
+
]>;
|
52
|
+
/**
|
53
|
+
* The maximum length of the URL.
|
54
|
+
*
|
55
|
+
* @default 2083
|
56
|
+
*/
|
57
|
+
maxUrlLength?: Value<number, [
|
58
|
+
options: ClientOptions<T>,
|
59
|
+
path: readonly string[],
|
60
|
+
input: unknown
|
61
|
+
]>;
|
62
|
+
/**
|
63
|
+
* The method used to make the request.
|
64
|
+
*
|
65
|
+
* @default 'POST'
|
66
|
+
*/
|
67
|
+
method?: Value<HTTPMethod, [
|
68
|
+
options: ClientOptions<T>,
|
69
|
+
path: readonly string[],
|
70
|
+
input: unknown
|
71
|
+
]>;
|
72
|
+
/**
|
73
|
+
* The method to use when the payload cannot safely pass to the server with method return from method function.
|
74
|
+
* GET is not allowed, it's very dangerous.
|
75
|
+
*
|
76
|
+
* @default 'POST'
|
77
|
+
*/
|
78
|
+
fallbackMethod?: Exclude<HTTPMethod, 'GET'>;
|
79
|
+
/**
|
80
|
+
* Inject headers to the request.
|
81
|
+
*/
|
82
|
+
headers?: Value<StandardHeaders, [
|
83
|
+
options: ClientOptions<T>,
|
84
|
+
path: readonly string[],
|
85
|
+
input: unknown
|
86
|
+
]>;
|
87
|
+
}
|
88
|
+
declare class StandardRPCLinkCodec<T extends ClientContext> implements StandardLinkCodec<T> {
|
89
|
+
private readonly serializer;
|
90
|
+
private readonly baseUrl;
|
91
|
+
private readonly maxUrlLength;
|
92
|
+
private readonly fallbackMethod;
|
93
|
+
private readonly expectedMethod;
|
94
|
+
private readonly headers;
|
95
|
+
constructor(serializer: StandardRPCSerializer, options: StandardRPCLinkCodecOptions<T>);
|
96
|
+
encode(path: readonly string[], input: unknown, options: ClientOptions<T>): Promise<StandardRequest>;
|
97
|
+
decode(response: StandardLazyResponse): Promise<unknown>;
|
98
|
+
}
|
99
|
+
|
100
|
+
interface StandardRPCLinkOptions<T extends ClientContext> extends StandardLinkOptions<T>, StandardRPCLinkCodecOptions<T>, StandardRPCJsonSerializerOptions {
|
101
|
+
}
|
102
|
+
|
103
|
+
export { STANDARD_RPC_JSON_SERIALIZER_BUILT_IN_TYPES as S, type StandardRPCJsonSerializedMetaItem as a, type StandardRPCJsonSerialized as b, type StandardRPCCustomJsonSerializer as c, type StandardRPCJsonSerializerOptions as d, StandardRPCJsonSerializer as e, type StandardRPCLinkOptions as f, type StandardRPCLinkCodecOptions as g, StandardRPCLinkCodec as h, StandardRPCSerializer as i };
|
@@ -1,4 +1,8 @@
|
|
1
|
-
|
1
|
+
import { PromiseWithError } from '@orpc/shared';
|
2
|
+
|
3
|
+
type HTTPPath = `/${string}`;
|
4
|
+
type HTTPMethod = 'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH';
|
5
|
+
type ClientContext = Record<PropertyKey, any>;
|
2
6
|
type FriendlyClientOptions<TClientContext extends ClientContext> = {
|
3
7
|
signal?: AbortSignal;
|
4
8
|
lastEventId?: string | undefined;
|
@@ -8,12 +12,8 @@ type FriendlyClientOptions<TClientContext extends ClientContext> = {
|
|
8
12
|
context: TClientContext;
|
9
13
|
});
|
10
14
|
type ClientRest<TClientContext extends ClientContext, TInput> = Record<never, never> extends TClientContext ? undefined extends TInput ? [input?: TInput, options?: FriendlyClientOptions<TClientContext>] : [input: TInput, options?: FriendlyClientOptions<TClientContext>] : [input: TInput, options: FriendlyClientOptions<TClientContext>];
|
11
|
-
type ClientPromiseResult<TOutput, TError
|
12
|
-
|
13
|
-
type: TError;
|
14
|
-
};
|
15
|
-
};
|
16
|
-
interface Client<TClientContext extends ClientContext, TInput, TOutput, TError extends Error> {
|
15
|
+
type ClientPromiseResult<TOutput, TError> = PromiseWithError<TOutput, TError>;
|
16
|
+
interface Client<TClientContext extends ClientContext, TInput, TOutput, TError> {
|
17
17
|
(...rest: ClientRest<TClientContext, TInput>): ClientPromiseResult<TOutput, TError>;
|
18
18
|
}
|
19
19
|
type NestedClient<TClientContext extends ClientContext> = Client<TClientContext, any, any, any> | {
|
@@ -27,4 +27,4 @@ interface ClientLink<TClientContext extends ClientContext> {
|
|
27
27
|
call: (path: readonly string[], input: unknown, options: ClientOptions<TClientContext>) => Promise<unknown>;
|
28
28
|
}
|
29
29
|
|
30
|
-
export type {
|
30
|
+
export type { ClientLink as C, FriendlyClientOptions as F, HTTPPath as H, InferClientContext as I, NestedClient as N, ClientContext as a, ClientOptions as b, ClientPromiseResult as c, HTTPMethod as d, ClientRest as e, Client as f };
|
@@ -1,4 +1,8 @@
|
|
1
|
-
|
1
|
+
import { PromiseWithError } from '@orpc/shared';
|
2
|
+
|
3
|
+
type HTTPPath = `/${string}`;
|
4
|
+
type HTTPMethod = 'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH';
|
5
|
+
type ClientContext = Record<PropertyKey, any>;
|
2
6
|
type FriendlyClientOptions<TClientContext extends ClientContext> = {
|
3
7
|
signal?: AbortSignal;
|
4
8
|
lastEventId?: string | undefined;
|
@@ -8,12 +12,8 @@ type FriendlyClientOptions<TClientContext extends ClientContext> = {
|
|
8
12
|
context: TClientContext;
|
9
13
|
});
|
10
14
|
type ClientRest<TClientContext extends ClientContext, TInput> = Record<never, never> extends TClientContext ? undefined extends TInput ? [input?: TInput, options?: FriendlyClientOptions<TClientContext>] : [input: TInput, options?: FriendlyClientOptions<TClientContext>] : [input: TInput, options: FriendlyClientOptions<TClientContext>];
|
11
|
-
type ClientPromiseResult<TOutput, TError
|
12
|
-
|
13
|
-
type: TError;
|
14
|
-
};
|
15
|
-
};
|
16
|
-
interface Client<TClientContext extends ClientContext, TInput, TOutput, TError extends Error> {
|
15
|
+
type ClientPromiseResult<TOutput, TError> = PromiseWithError<TOutput, TError>;
|
16
|
+
interface Client<TClientContext extends ClientContext, TInput, TOutput, TError> {
|
17
17
|
(...rest: ClientRest<TClientContext, TInput>): ClientPromiseResult<TOutput, TError>;
|
18
18
|
}
|
19
19
|
type NestedClient<TClientContext extends ClientContext> = Client<TClientContext, any, any, any> | {
|
@@ -27,4 +27,4 @@ interface ClientLink<TClientContext extends ClientContext> {
|
|
27
27
|
call: (path: readonly string[], input: unknown, options: ClientOptions<TClientContext>) => Promise<unknown>;
|
28
28
|
}
|
29
29
|
|
30
|
-
export type {
|
30
|
+
export type { ClientLink as C, FriendlyClientOptions as F, HTTPPath as H, InferClientContext as I, NestedClient as N, ClientContext as a, ClientOptions as b, ClientPromiseResult as c, HTTPMethod as d, ClientRest as e, Client as f };
|
@@ -0,0 +1,103 @@
|
|
1
|
+
import { a as ClientContext, b as ClientOptions, d as HTTPMethod } from './client.C0lT7w02.js';
|
2
|
+
import { c as StandardLinkCodec, a as StandardLinkOptions } from './client.grRbC25r.js';
|
3
|
+
import { Segment, Value } from '@orpc/shared';
|
4
|
+
import { StandardHeaders, StandardRequest, StandardLazyResponse } from '@orpc/standard-server';
|
5
|
+
|
6
|
+
declare const STANDARD_RPC_JSON_SERIALIZER_BUILT_IN_TYPES: {
|
7
|
+
readonly BIGINT: 0;
|
8
|
+
readonly DATE: 1;
|
9
|
+
readonly NAN: 2;
|
10
|
+
readonly UNDEFINED: 3;
|
11
|
+
readonly URL: 4;
|
12
|
+
readonly REGEXP: 5;
|
13
|
+
readonly SET: 6;
|
14
|
+
readonly MAP: 7;
|
15
|
+
};
|
16
|
+
type StandardRPCJsonSerializedMetaItem = readonly [type: number, ...path: Segment[]];
|
17
|
+
type StandardRPCJsonSerialized = [json: unknown, meta: StandardRPCJsonSerializedMetaItem[], maps: Segment[][], blobs: Blob[]];
|
18
|
+
interface StandardRPCCustomJsonSerializer {
|
19
|
+
type: number;
|
20
|
+
condition(data: unknown): boolean;
|
21
|
+
serialize(data: any): unknown;
|
22
|
+
deserialize(serialized: any): unknown;
|
23
|
+
}
|
24
|
+
interface StandardRPCJsonSerializerOptions {
|
25
|
+
customJsonSerializers?: readonly StandardRPCCustomJsonSerializer[];
|
26
|
+
}
|
27
|
+
declare class StandardRPCJsonSerializer {
|
28
|
+
private readonly customSerializers;
|
29
|
+
constructor(options?: StandardRPCJsonSerializerOptions);
|
30
|
+
serialize(data: unknown, segments?: Segment[], meta?: StandardRPCJsonSerializedMetaItem[], maps?: Segment[][], blobs?: Blob[]): StandardRPCJsonSerialized;
|
31
|
+
deserialize(json: unknown, meta: readonly StandardRPCJsonSerializedMetaItem[]): unknown;
|
32
|
+
deserialize(json: unknown, meta: readonly StandardRPCJsonSerializedMetaItem[], maps: readonly Segment[][], getBlob: (index: number) => Blob): unknown;
|
33
|
+
}
|
34
|
+
|
35
|
+
declare class StandardRPCSerializer {
|
36
|
+
#private;
|
37
|
+
private readonly jsonSerializer;
|
38
|
+
constructor(jsonSerializer: StandardRPCJsonSerializer);
|
39
|
+
serialize(data: unknown): object;
|
40
|
+
deserialize(data: unknown): unknown;
|
41
|
+
}
|
42
|
+
|
43
|
+
interface StandardRPCLinkCodecOptions<T extends ClientContext> {
|
44
|
+
/**
|
45
|
+
* Base url for all requests.
|
46
|
+
*/
|
47
|
+
url: Value<string | URL, [
|
48
|
+
options: ClientOptions<T>,
|
49
|
+
path: readonly string[],
|
50
|
+
input: unknown
|
51
|
+
]>;
|
52
|
+
/**
|
53
|
+
* The maximum length of the URL.
|
54
|
+
*
|
55
|
+
* @default 2083
|
56
|
+
*/
|
57
|
+
maxUrlLength?: Value<number, [
|
58
|
+
options: ClientOptions<T>,
|
59
|
+
path: readonly string[],
|
60
|
+
input: unknown
|
61
|
+
]>;
|
62
|
+
/**
|
63
|
+
* The method used to make the request.
|
64
|
+
*
|
65
|
+
* @default 'POST'
|
66
|
+
*/
|
67
|
+
method?: Value<HTTPMethod, [
|
68
|
+
options: ClientOptions<T>,
|
69
|
+
path: readonly string[],
|
70
|
+
input: unknown
|
71
|
+
]>;
|
72
|
+
/**
|
73
|
+
* The method to use when the payload cannot safely pass to the server with method return from method function.
|
74
|
+
* GET is not allowed, it's very dangerous.
|
75
|
+
*
|
76
|
+
* @default 'POST'
|
77
|
+
*/
|
78
|
+
fallbackMethod?: Exclude<HTTPMethod, 'GET'>;
|
79
|
+
/**
|
80
|
+
* Inject headers to the request.
|
81
|
+
*/
|
82
|
+
headers?: Value<StandardHeaders, [
|
83
|
+
options: ClientOptions<T>,
|
84
|
+
path: readonly string[],
|
85
|
+
input: unknown
|
86
|
+
]>;
|
87
|
+
}
|
88
|
+
declare class StandardRPCLinkCodec<T extends ClientContext> implements StandardLinkCodec<T> {
|
89
|
+
private readonly serializer;
|
90
|
+
private readonly baseUrl;
|
91
|
+
private readonly maxUrlLength;
|
92
|
+
private readonly fallbackMethod;
|
93
|
+
private readonly expectedMethod;
|
94
|
+
private readonly headers;
|
95
|
+
constructor(serializer: StandardRPCSerializer, options: StandardRPCLinkCodecOptions<T>);
|
96
|
+
encode(path: readonly string[], input: unknown, options: ClientOptions<T>): Promise<StandardRequest>;
|
97
|
+
decode(response: StandardLazyResponse): Promise<unknown>;
|
98
|
+
}
|
99
|
+
|
100
|
+
interface StandardRPCLinkOptions<T extends ClientContext> extends StandardLinkOptions<T>, StandardRPCLinkCodecOptions<T>, StandardRPCJsonSerializerOptions {
|
101
|
+
}
|
102
|
+
|
103
|
+
export { STANDARD_RPC_JSON_SERIALIZER_BUILT_IN_TYPES as S, type StandardRPCJsonSerializedMetaItem as a, type StandardRPCJsonSerialized as b, type StandardRPCCustomJsonSerializer as c, type StandardRPCJsonSerializerOptions as d, StandardRPCJsonSerializer as e, type StandardRPCLinkOptions as f, type StandardRPCLinkCodecOptions as g, StandardRPCLinkCodec as h, StandardRPCSerializer as i };
|
@@ -1,6 +1,6 @@
|
|
1
1
|
import { toArray, intercept, isObject, value, isAsyncIteratorObject, stringifyJSON } from '@orpc/shared';
|
2
|
-
import {
|
3
|
-
import {
|
2
|
+
import { mergeStandardHeaders, ErrorEvent } from '@orpc/standard-server';
|
3
|
+
import { C as COMMON_ORPC_ERROR_DEFS, b as isORPCErrorStatus, O as ORPCError, m as mapEventIterator, t as toORPCError } from './client.jKEwIsRd.mjs';
|
4
4
|
|
5
5
|
class InvalidEventIteratorRetryResponse extends Error {
|
6
6
|
}
|
@@ -180,6 +180,13 @@ class StandardRPCJsonSerializer {
|
|
180
180
|
}
|
181
181
|
}
|
182
182
|
|
183
|
+
function toHttpPath(path) {
|
184
|
+
return `/${path.map(encodeURIComponent).join("/")}`;
|
185
|
+
}
|
186
|
+
function getMalformedResponseErrorCode(status) {
|
187
|
+
return Object.entries(COMMON_ORPC_ERROR_DEFS).find(([, def]) => def.status === status)?.[0] ?? "MALFORMED_ORPC_ERROR_RESPONSE";
|
188
|
+
}
|
189
|
+
|
183
190
|
class StandardRPCLinkCodec {
|
184
191
|
constructor(serializer, options) {
|
185
192
|
this.serializer = serializer;
|
@@ -196,17 +203,11 @@ class StandardRPCLinkCodec {
|
|
196
203
|
headers;
|
197
204
|
async encode(path, input, options) {
|
198
205
|
const expectedMethod = await value(this.expectedMethod, options, path, input);
|
199
|
-
|
206
|
+
let headers = await value(this.headers, options, path, input);
|
200
207
|
const baseUrl = await value(this.baseUrl, options, path, input);
|
201
|
-
const url = new URL(`${baseUrl.toString().replace(/\/$/, "")}
|
208
|
+
const url = new URL(`${baseUrl.toString().replace(/\/$/, "")}${toHttpPath(path)}`);
|
202
209
|
if (options.lastEventId !== void 0) {
|
203
|
-
|
204
|
-
headers["last-event-id"] = [...headers["last-event-id"], options.lastEventId];
|
205
|
-
} else if (headers["last-event-id"] !== void 0) {
|
206
|
-
headers["last-event-id"] = [headers["last-event-id"], options.lastEventId];
|
207
|
-
} else {
|
208
|
-
headers["last-event-id"] = options.lastEventId;
|
209
|
-
}
|
210
|
+
headers = mergeStandardHeaders(headers, { "last-event-id": options.lastEventId });
|
210
211
|
}
|
211
212
|
const serialized = this.serializer.serialize(input);
|
212
213
|
if (expectedMethod === "GET" && !(serialized instanceof FormData) && !isAsyncIteratorObject(serialized)) {
|
@@ -232,7 +233,7 @@ class StandardRPCLinkCodec {
|
|
232
233
|
};
|
233
234
|
}
|
234
235
|
async decode(response) {
|
235
|
-
const isOk = response.status
|
236
|
+
const isOk = !isORPCErrorStatus(response.status);
|
236
237
|
const deserialized = await (async () => {
|
237
238
|
let isBodyOk = false;
|
238
239
|
try {
|
@@ -254,8 +255,9 @@ class StandardRPCLinkCodec {
|
|
254
255
|
if (ORPCError.isValidJSON(deserialized)) {
|
255
256
|
throw ORPCError.fromJSON(deserialized);
|
256
257
|
}
|
257
|
-
throw new
|
258
|
-
|
258
|
+
throw new ORPCError(getMalformedResponseErrorCode(response.status), {
|
259
|
+
status: response.status,
|
260
|
+
data: deserialized
|
259
261
|
});
|
260
262
|
}
|
261
263
|
return deserialized;
|
@@ -331,4 +333,4 @@ class StandardRPCSerializer {
|
|
331
333
|
}
|
332
334
|
}
|
333
335
|
|
334
|
-
export { InvalidEventIteratorRetryResponse as I, StandardLink as S, STANDARD_RPC_JSON_SERIALIZER_BUILT_IN_TYPES as a, StandardRPCJsonSerializer as b, StandardRPCLinkCodec as c, StandardRPCSerializer as d };
|
336
|
+
export { InvalidEventIteratorRetryResponse as I, StandardLink as S, STANDARD_RPC_JSON_SERIALIZER_BUILT_IN_TYPES as a, StandardRPCJsonSerializer as b, StandardRPCLinkCodec as c, StandardRPCSerializer as d, getMalformedResponseErrorCode as g, toHttpPath as t };
|
@@ -1,6 +1,6 @@
|
|
1
|
-
import { Interceptor } from '@orpc/shared';
|
1
|
+
import { Interceptor, ThrowableError } from '@orpc/shared';
|
2
2
|
import { StandardRequest, StandardLazyResponse } from '@orpc/standard-server';
|
3
|
-
import { a as ClientContext,
|
3
|
+
import { a as ClientContext, b as ClientOptions, C as ClientLink } from './client.C0lT7w02.js';
|
4
4
|
|
5
5
|
interface StandardLinkCodec<T extends ClientContext> {
|
6
6
|
encode(path: readonly string[], input: unknown, options: ClientOptions<T>): Promise<StandardRequest>;
|
@@ -20,10 +20,10 @@ interface StandardLinkOptions<T extends ClientContext> {
|
|
20
20
|
path: readonly string[];
|
21
21
|
input: unknown;
|
22
22
|
options: ClientOptions<T>;
|
23
|
-
}, unknown,
|
23
|
+
}, unknown, ThrowableError>[];
|
24
24
|
clientInterceptors?: Interceptor<{
|
25
25
|
request: StandardRequest;
|
26
|
-
}, StandardLazyResponse,
|
26
|
+
}, StandardLazyResponse, ThrowableError>[];
|
27
27
|
plugins?: StandardLinkPlugin<T>[];
|
28
28
|
}
|
29
29
|
declare class StandardLink<T extends ClientContext> implements ClientLink<T> {
|
@@ -36,4 +36,4 @@ declare class StandardLink<T extends ClientContext> implements ClientLink<T> {
|
|
36
36
|
call(path: readonly string[], input: unknown, options: ClientOptions<T>): Promise<unknown>;
|
37
37
|
}
|
38
38
|
|
39
|
-
export { InvalidEventIteratorRetryResponse as I, type StandardLinkPlugin as S, type StandardLinkOptions as a,
|
39
|
+
export { InvalidEventIteratorRetryResponse as I, type StandardLinkPlugin as S, type StandardLinkOptions as a, StandardLink as b, type StandardLinkCodec as c, type StandardLinkClient as d };
|
@@ -91,8 +91,8 @@ class ORPCError extends Error {
|
|
91
91
|
status;
|
92
92
|
data;
|
93
93
|
constructor(code, ...[options]) {
|
94
|
-
if (options?.status && (options.status
|
95
|
-
throw new Error("[ORPCError]
|
94
|
+
if (options?.status && !isORPCErrorStatus(options.status)) {
|
95
|
+
throw new Error("[ORPCError] Invalid error status code.");
|
96
96
|
}
|
97
97
|
const message = fallbackORPCErrorMessage(code, options?.message);
|
98
98
|
super(message, options);
|
@@ -136,6 +136,9 @@ function toORPCError(error) {
|
|
136
136
|
cause: error
|
137
137
|
});
|
138
138
|
}
|
139
|
+
function isORPCErrorStatus(status) {
|
140
|
+
return status < 200 || status >= 400;
|
141
|
+
}
|
139
142
|
|
140
143
|
function mapEventIterator(iterator, maps) {
|
141
144
|
return async function* () {
|
@@ -169,4 +172,4 @@ function mapEventIterator(iterator, maps) {
|
|
169
172
|
}();
|
170
173
|
}
|
171
174
|
|
172
|
-
export { COMMON_ORPC_ERROR_DEFS as C, ORPCError as O, fallbackORPCErrorMessage as a, fallbackORPCErrorStatus as f, isDefinedError as i, mapEventIterator as m, toORPCError as t };
|
175
|
+
export { COMMON_ORPC_ERROR_DEFS as C, ORPCError as O, fallbackORPCErrorMessage as a, isORPCErrorStatus as b, fallbackORPCErrorStatus as f, isDefinedError as i, mapEventIterator as m, toORPCError as t };
|
package/package.json
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
{
|
2
2
|
"name": "@orpc/client",
|
3
3
|
"type": "module",
|
4
|
-
"version": "1.0.0-beta.
|
4
|
+
"version": "1.0.0-beta.5",
|
5
5
|
"license": "MIT",
|
6
6
|
"homepage": "https://orpc.unnoq.com",
|
7
7
|
"repository": {
|
@@ -39,9 +39,9 @@
|
|
39
39
|
"dist"
|
40
40
|
],
|
41
41
|
"dependencies": {
|
42
|
-
"@orpc/shared": "1.0.0-beta.
|
43
|
-
"@orpc/standard-server": "1.0.0-beta.
|
44
|
-
"@orpc/standard-server
|
42
|
+
"@orpc/shared": "1.0.0-beta.5",
|
43
|
+
"@orpc/standard-server-fetch": "1.0.0-beta.5",
|
44
|
+
"@orpc/standard-server": "1.0.0-beta.5"
|
45
45
|
},
|
46
46
|
"devDependencies": {
|
47
47
|
"zod": "^3.24.2"
|