@orpc/client 0.0.0-next.3e1c2e9 → 0.0.0-next.3ee2e95
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 +18 -13
- package/dist/index.d.ts +18 -13
- package/dist/index.mjs +34 -32
- package/dist/plugins/index.d.mts +103 -22
- package/dist/plugins/index.d.ts +103 -22
- package/dist/plugins/index.mjs +196 -33
- package/dist/shared/client.2CWETx1V.d.mts +47 -0
- package/dist/shared/client.BCCZFC-T.d.ts +87 -0
- package/dist/shared/{client.BacCdg3F.mjs → client.CRWEpqLB.mjs} +22 -19
- package/dist/shared/client.CipPQkhk.d.mts +29 -0
- package/dist/shared/client.CipPQkhk.d.ts +29 -0
- package/dist/shared/client.DUjXqpDq.d.ts +47 -0
- package/dist/shared/client.DcDnlyRo.d.mts +87 -0
- package/dist/shared/{client.3Q53fveR.mjs → client.vy3P78P6.mjs} +41 -27
- 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/dist/shared/client.DrOAzyMB.d.mts +0 -45
- package/dist/shared/client.aGal-uGY.d.ts +0 -45
|
@@ -0,0 +1,87 @@
|
|
|
1
|
+
import { a as ClientContext, b as ClientOptions, d as HTTPMethod } from './client.CipPQkhk.js';
|
|
2
|
+
import { e as StandardLinkCodec, b as StandardLinkOptions } from './client.DUjXqpDq.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, [options: ClientOptions<T>, path: readonly string[], input: unknown]>;
|
|
48
|
+
/**
|
|
49
|
+
* The maximum length of the URL.
|
|
50
|
+
*
|
|
51
|
+
* @default 2083
|
|
52
|
+
*/
|
|
53
|
+
maxUrlLength?: Value<number, [options: ClientOptions<T>, path: readonly string[], input: unknown]>;
|
|
54
|
+
/**
|
|
55
|
+
* The method used to make the request.
|
|
56
|
+
*
|
|
57
|
+
* @default 'POST'
|
|
58
|
+
*/
|
|
59
|
+
method?: Value<HTTPMethod, [options: ClientOptions<T>, path: readonly string[], input: unknown]>;
|
|
60
|
+
/**
|
|
61
|
+
* The method to use when the payload cannot safely pass to the server with method return from method function.
|
|
62
|
+
* GET is not allowed, it's very dangerous.
|
|
63
|
+
*
|
|
64
|
+
* @default 'POST'
|
|
65
|
+
*/
|
|
66
|
+
fallbackMethod?: Exclude<HTTPMethod, 'GET'>;
|
|
67
|
+
/**
|
|
68
|
+
* Inject headers to the request.
|
|
69
|
+
*/
|
|
70
|
+
headers?: Value<StandardHeaders, [options: ClientOptions<T>, path: readonly string[], input: unknown]>;
|
|
71
|
+
}
|
|
72
|
+
declare class StandardRPCLinkCodec<T extends ClientContext> implements StandardLinkCodec<T> {
|
|
73
|
+
private readonly serializer;
|
|
74
|
+
private readonly baseUrl;
|
|
75
|
+
private readonly maxUrlLength;
|
|
76
|
+
private readonly fallbackMethod;
|
|
77
|
+
private readonly expectedMethod;
|
|
78
|
+
private readonly headers;
|
|
79
|
+
constructor(serializer: StandardRPCSerializer, options: StandardRPCLinkCodecOptions<T>);
|
|
80
|
+
encode(path: readonly string[], input: unknown, options: ClientOptions<T>): Promise<StandardRequest>;
|
|
81
|
+
decode(response: StandardLazyResponse): Promise<unknown>;
|
|
82
|
+
}
|
|
83
|
+
|
|
84
|
+
interface StandardRPCLinkOptions<T extends ClientContext> extends StandardLinkOptions<T>, StandardRPCLinkCodecOptions<T>, StandardRPCJsonSerializerOptions {
|
|
85
|
+
}
|
|
86
|
+
|
|
87
|
+
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 };
|
|
@@ -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);
|
|
@@ -110,22 +110,6 @@ class ORPCError extends Error {
|
|
|
110
110
|
data: this.data
|
|
111
111
|
};
|
|
112
112
|
}
|
|
113
|
-
static fromJSON(json, options) {
|
|
114
|
-
return new ORPCError(json.code, {
|
|
115
|
-
...options,
|
|
116
|
-
...json
|
|
117
|
-
});
|
|
118
|
-
}
|
|
119
|
-
static isValidJSON(json) {
|
|
120
|
-
if (!isObject(json)) {
|
|
121
|
-
return false;
|
|
122
|
-
}
|
|
123
|
-
const validKeys = ["defined", "code", "status", "message", "data"];
|
|
124
|
-
if (Object.keys(json).some((k) => !validKeys.includes(k))) {
|
|
125
|
-
return false;
|
|
126
|
-
}
|
|
127
|
-
return "defined" in json && typeof json.defined === "boolean" && "code" in json && typeof json.code === "string" && "status" in json && typeof json.status === "number" && "message" in json && typeof json.message === "string";
|
|
128
|
-
}
|
|
129
113
|
}
|
|
130
114
|
function isDefinedError(error) {
|
|
131
115
|
return error instanceof ORPCError && error.defined;
|
|
@@ -136,6 +120,25 @@ function toORPCError(error) {
|
|
|
136
120
|
cause: error
|
|
137
121
|
});
|
|
138
122
|
}
|
|
123
|
+
function isORPCErrorStatus(status) {
|
|
124
|
+
return status < 200 || status >= 400;
|
|
125
|
+
}
|
|
126
|
+
function isORPCErrorJson(json) {
|
|
127
|
+
if (!isObject(json)) {
|
|
128
|
+
return false;
|
|
129
|
+
}
|
|
130
|
+
const validKeys = ["defined", "code", "status", "message", "data"];
|
|
131
|
+
if (Object.keys(json).some((k) => !validKeys.includes(k))) {
|
|
132
|
+
return false;
|
|
133
|
+
}
|
|
134
|
+
return "defined" in json && typeof json.defined === "boolean" && "code" in json && typeof json.code === "string" && "status" in json && typeof json.status === "number" && isORPCErrorStatus(json.status) && "message" in json && typeof json.message === "string";
|
|
135
|
+
}
|
|
136
|
+
function createORPCErrorFromJson(json, options = {}) {
|
|
137
|
+
return new ORPCError(json.code, {
|
|
138
|
+
...options,
|
|
139
|
+
...json
|
|
140
|
+
});
|
|
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, isORPCErrorJson as c, createORPCErrorFromJson as d, fallbackORPCErrorStatus as f, isDefinedError as i, mapEventIterator as m, toORPCError as t };
|
|
@@ -0,0 +1,29 @@
|
|
|
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>;
|
|
6
|
+
interface ClientOptions<T extends ClientContext> {
|
|
7
|
+
signal?: AbortSignal;
|
|
8
|
+
lastEventId?: string | undefined;
|
|
9
|
+
context: T;
|
|
10
|
+
}
|
|
11
|
+
type FriendlyClientOptions<T extends ClientContext> = Omit<ClientOptions<T>, 'context'> & (Record<never, never> extends T ? {
|
|
12
|
+
context?: T;
|
|
13
|
+
} : {
|
|
14
|
+
context: T;
|
|
15
|
+
});
|
|
16
|
+
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>];
|
|
17
|
+
type ClientPromiseResult<TOutput, TError> = PromiseWithError<TOutput, TError>;
|
|
18
|
+
interface Client<TClientContext extends ClientContext, TInput, TOutput, TError> {
|
|
19
|
+
(...rest: ClientRest<TClientContext, TInput>): ClientPromiseResult<TOutput, TError>;
|
|
20
|
+
}
|
|
21
|
+
type NestedClient<TClientContext extends ClientContext> = Client<TClientContext, any, any, any> | {
|
|
22
|
+
[k: string]: NestedClient<TClientContext>;
|
|
23
|
+
};
|
|
24
|
+
type InferClientContext<T extends NestedClient<any>> = T extends NestedClient<infer U> ? U : never;
|
|
25
|
+
interface ClientLink<TClientContext extends ClientContext> {
|
|
26
|
+
call: (path: readonly string[], input: unknown, options: ClientOptions<TClientContext>) => Promise<unknown>;
|
|
27
|
+
}
|
|
28
|
+
|
|
29
|
+
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,29 @@
|
|
|
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>;
|
|
6
|
+
interface ClientOptions<T extends ClientContext> {
|
|
7
|
+
signal?: AbortSignal;
|
|
8
|
+
lastEventId?: string | undefined;
|
|
9
|
+
context: T;
|
|
10
|
+
}
|
|
11
|
+
type FriendlyClientOptions<T extends ClientContext> = Omit<ClientOptions<T>, 'context'> & (Record<never, never> extends T ? {
|
|
12
|
+
context?: T;
|
|
13
|
+
} : {
|
|
14
|
+
context: T;
|
|
15
|
+
});
|
|
16
|
+
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>];
|
|
17
|
+
type ClientPromiseResult<TOutput, TError> = PromiseWithError<TOutput, TError>;
|
|
18
|
+
interface Client<TClientContext extends ClientContext, TInput, TOutput, TError> {
|
|
19
|
+
(...rest: ClientRest<TClientContext, TInput>): ClientPromiseResult<TOutput, TError>;
|
|
20
|
+
}
|
|
21
|
+
type NestedClient<TClientContext extends ClientContext> = Client<TClientContext, any, any, any> | {
|
|
22
|
+
[k: string]: NestedClient<TClientContext>;
|
|
23
|
+
};
|
|
24
|
+
type InferClientContext<T extends NestedClient<any>> = T extends NestedClient<infer U> ? U : never;
|
|
25
|
+
interface ClientLink<TClientContext extends ClientContext> {
|
|
26
|
+
call: (path: readonly string[], input: unknown, options: ClientOptions<TClientContext>) => Promise<unknown>;
|
|
27
|
+
}
|
|
28
|
+
|
|
29
|
+
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,47 @@
|
|
|
1
|
+
import { Interceptor, ThrowableError } from '@orpc/shared';
|
|
2
|
+
import { StandardRequest, StandardLazyResponse } from '@orpc/standard-server';
|
|
3
|
+
import { a as ClientContext, b as ClientOptions, C as ClientLink } from './client.CipPQkhk.js';
|
|
4
|
+
|
|
5
|
+
interface StandardLinkCodec<T extends ClientContext> {
|
|
6
|
+
encode(path: readonly string[], input: unknown, options: ClientOptions<T>): Promise<StandardRequest>;
|
|
7
|
+
decode(response: StandardLazyResponse, options: ClientOptions<T>, path: readonly string[], input: unknown): Promise<unknown>;
|
|
8
|
+
}
|
|
9
|
+
interface StandardLinkClient<T extends ClientContext> {
|
|
10
|
+
call(request: StandardRequest, options: ClientOptions<T>, path: readonly string[], input: unknown): Promise<StandardLazyResponse>;
|
|
11
|
+
}
|
|
12
|
+
|
|
13
|
+
interface StandardLinkPlugin<T extends ClientContext> {
|
|
14
|
+
order?: number;
|
|
15
|
+
init?(options: StandardLinkOptions<T>): void;
|
|
16
|
+
}
|
|
17
|
+
declare class CompositeStandardLinkPlugin<T extends ClientContext, TPlugin extends StandardLinkPlugin<T>> implements StandardLinkPlugin<T> {
|
|
18
|
+
protected readonly plugins: TPlugin[];
|
|
19
|
+
constructor(plugins?: readonly TPlugin[]);
|
|
20
|
+
init(options: StandardLinkOptions<T>): void;
|
|
21
|
+
}
|
|
22
|
+
|
|
23
|
+
declare class InvalidEventIteratorRetryResponse extends Error {
|
|
24
|
+
}
|
|
25
|
+
interface StandardLinkInterceptorOptions<T extends ClientContext> extends ClientOptions<T> {
|
|
26
|
+
path: readonly string[];
|
|
27
|
+
input: unknown;
|
|
28
|
+
}
|
|
29
|
+
interface StandardLinkClientInterceptorOptions<T extends ClientContext> extends StandardLinkInterceptorOptions<T> {
|
|
30
|
+
request: StandardRequest;
|
|
31
|
+
}
|
|
32
|
+
interface StandardLinkOptions<T extends ClientContext> {
|
|
33
|
+
interceptors?: Interceptor<StandardLinkInterceptorOptions<T>, unknown, ThrowableError>[];
|
|
34
|
+
clientInterceptors?: Interceptor<StandardLinkClientInterceptorOptions<T>, StandardLazyResponse, ThrowableError>[];
|
|
35
|
+
plugins?: StandardLinkPlugin<T>[];
|
|
36
|
+
}
|
|
37
|
+
declare class StandardLink<T extends ClientContext> implements ClientLink<T> {
|
|
38
|
+
#private;
|
|
39
|
+
readonly codec: StandardLinkCodec<T>;
|
|
40
|
+
readonly sender: StandardLinkClient<T>;
|
|
41
|
+
private readonly interceptors;
|
|
42
|
+
private readonly clientInterceptors;
|
|
43
|
+
constructor(codec: StandardLinkCodec<T>, sender: StandardLinkClient<T>, options?: StandardLinkOptions<T>);
|
|
44
|
+
call(path: readonly string[], input: unknown, options: ClientOptions<T>): Promise<unknown>;
|
|
45
|
+
}
|
|
46
|
+
|
|
47
|
+
export { CompositeStandardLinkPlugin as C, InvalidEventIteratorRetryResponse as I, type StandardLinkClientInterceptorOptions as S, type StandardLinkPlugin as a, type StandardLinkOptions as b, type StandardLinkInterceptorOptions as c, StandardLink as d, type StandardLinkCodec as e, type StandardLinkClient as f };
|
|
@@ -0,0 +1,87 @@
|
|
|
1
|
+
import { a as ClientContext, b as ClientOptions, d as HTTPMethod } from './client.CipPQkhk.mjs';
|
|
2
|
+
import { e as StandardLinkCodec, b as StandardLinkOptions } from './client.2CWETx1V.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, [options: ClientOptions<T>, path: readonly string[], input: unknown]>;
|
|
48
|
+
/**
|
|
49
|
+
* The maximum length of the URL.
|
|
50
|
+
*
|
|
51
|
+
* @default 2083
|
|
52
|
+
*/
|
|
53
|
+
maxUrlLength?: Value<number, [options: ClientOptions<T>, path: readonly string[], input: unknown]>;
|
|
54
|
+
/**
|
|
55
|
+
* The method used to make the request.
|
|
56
|
+
*
|
|
57
|
+
* @default 'POST'
|
|
58
|
+
*/
|
|
59
|
+
method?: Value<HTTPMethod, [options: ClientOptions<T>, path: readonly string[], input: unknown]>;
|
|
60
|
+
/**
|
|
61
|
+
* The method to use when the payload cannot safely pass to the server with method return from method function.
|
|
62
|
+
* GET is not allowed, it's very dangerous.
|
|
63
|
+
*
|
|
64
|
+
* @default 'POST'
|
|
65
|
+
*/
|
|
66
|
+
fallbackMethod?: Exclude<HTTPMethod, 'GET'>;
|
|
67
|
+
/**
|
|
68
|
+
* Inject headers to the request.
|
|
69
|
+
*/
|
|
70
|
+
headers?: Value<StandardHeaders, [options: ClientOptions<T>, path: readonly string[], input: unknown]>;
|
|
71
|
+
}
|
|
72
|
+
declare class StandardRPCLinkCodec<T extends ClientContext> implements StandardLinkCodec<T> {
|
|
73
|
+
private readonly serializer;
|
|
74
|
+
private readonly baseUrl;
|
|
75
|
+
private readonly maxUrlLength;
|
|
76
|
+
private readonly fallbackMethod;
|
|
77
|
+
private readonly expectedMethod;
|
|
78
|
+
private readonly headers;
|
|
79
|
+
constructor(serializer: StandardRPCSerializer, options: StandardRPCLinkCodecOptions<T>);
|
|
80
|
+
encode(path: readonly string[], input: unknown, options: ClientOptions<T>): Promise<StandardRequest>;
|
|
81
|
+
decode(response: StandardLazyResponse): Promise<unknown>;
|
|
82
|
+
}
|
|
83
|
+
|
|
84
|
+
interface StandardRPCLinkOptions<T extends ClientContext> extends StandardLinkOptions<T>, StandardRPCLinkCodecOptions<T>, StandardRPCJsonSerializerOptions {
|
|
85
|
+
}
|
|
86
|
+
|
|
87
|
+
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,7 +1,18 @@
|
|
|
1
|
-
import { intercept, isObject, value,
|
|
2
|
-
import {
|
|
3
|
-
import {
|
|
4
|
-
|
|
1
|
+
import { toArray, intercept, isObject, value, isAsyncIteratorObject, stringifyJSON } from '@orpc/shared';
|
|
2
|
+
import { mergeStandardHeaders, ErrorEvent } from '@orpc/standard-server';
|
|
3
|
+
import { C as COMMON_ORPC_ERROR_DEFS, b as isORPCErrorStatus, c as isORPCErrorJson, d as createORPCErrorFromJson, O as ORPCError, m as mapEventIterator, t as toORPCError } from './client.CRWEpqLB.mjs';
|
|
4
|
+
|
|
5
|
+
class CompositeStandardLinkPlugin {
|
|
6
|
+
plugins;
|
|
7
|
+
constructor(plugins = []) {
|
|
8
|
+
this.plugins = [...plugins].sort((a, b) => (a.order ?? 0) - (b.order ?? 0));
|
|
9
|
+
}
|
|
10
|
+
init(options) {
|
|
11
|
+
for (const plugin of this.plugins) {
|
|
12
|
+
plugin.init?.(options);
|
|
13
|
+
}
|
|
14
|
+
}
|
|
15
|
+
}
|
|
5
16
|
|
|
6
17
|
class InvalidEventIteratorRetryResponse extends Error {
|
|
7
18
|
}
|
|
@@ -9,15 +20,15 @@ class StandardLink {
|
|
|
9
20
|
constructor(codec, sender, options = {}) {
|
|
10
21
|
this.codec = codec;
|
|
11
22
|
this.sender = sender;
|
|
12
|
-
const plugin = new
|
|
23
|
+
const plugin = new CompositeStandardLinkPlugin(options.plugins);
|
|
13
24
|
plugin.init(options);
|
|
14
|
-
this.interceptors = options.interceptors
|
|
15
|
-
this.clientInterceptors = options.clientInterceptors
|
|
25
|
+
this.interceptors = toArray(options.interceptors);
|
|
26
|
+
this.clientInterceptors = toArray(options.clientInterceptors);
|
|
16
27
|
}
|
|
17
28
|
interceptors;
|
|
18
29
|
clientInterceptors;
|
|
19
30
|
call(path, input, options) {
|
|
20
|
-
return intercept(this.interceptors, { path, input
|
|
31
|
+
return intercept(this.interceptors, { ...options, path, input }, async ({ path: path2, input: input2, ...options2 }) => {
|
|
21
32
|
const output = await this.#call(path2, input2, options2);
|
|
22
33
|
return output;
|
|
23
34
|
});
|
|
@@ -26,8 +37,8 @@ class StandardLink {
|
|
|
26
37
|
const request = await this.codec.encode(path, input, options);
|
|
27
38
|
const response = await intercept(
|
|
28
39
|
this.clientInterceptors,
|
|
29
|
-
{ request },
|
|
30
|
-
({ request: request2 }) => this.sender.call(request2,
|
|
40
|
+
{ ...options, input, path, request },
|
|
41
|
+
({ input: input2, path: path2, request: request2, ...options2 }) => this.sender.call(request2, options2, path2, input2)
|
|
31
42
|
);
|
|
32
43
|
const output = await this.codec.decode(response, options, path, input);
|
|
33
44
|
return output;
|
|
@@ -180,6 +191,13 @@ class StandardRPCJsonSerializer {
|
|
|
180
191
|
}
|
|
181
192
|
}
|
|
182
193
|
|
|
194
|
+
function toHttpPath(path) {
|
|
195
|
+
return `/${path.map(encodeURIComponent).join("/")}`;
|
|
196
|
+
}
|
|
197
|
+
function getMalformedResponseErrorCode(status) {
|
|
198
|
+
return Object.entries(COMMON_ORPC_ERROR_DEFS).find(([, def]) => def.status === status)?.[0] ?? "MALFORMED_ORPC_ERROR_RESPONSE";
|
|
199
|
+
}
|
|
200
|
+
|
|
183
201
|
class StandardRPCLinkCodec {
|
|
184
202
|
constructor(serializer, options) {
|
|
185
203
|
this.serializer = serializer;
|
|
@@ -196,17 +214,12 @@ class StandardRPCLinkCodec {
|
|
|
196
214
|
headers;
|
|
197
215
|
async encode(path, input, options) {
|
|
198
216
|
const expectedMethod = await value(this.expectedMethod, options, path, input);
|
|
199
|
-
|
|
217
|
+
let headers = await value(this.headers, options, path, input);
|
|
200
218
|
const baseUrl = await value(this.baseUrl, options, path, input);
|
|
201
|
-
const url = new URL(
|
|
219
|
+
const url = new URL(baseUrl);
|
|
220
|
+
url.pathname = `${url.pathname.replace(/\/$/, "")}${toHttpPath(path)}`;
|
|
202
221
|
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
|
-
}
|
|
222
|
+
headers = mergeStandardHeaders(headers, { "last-event-id": options.lastEventId });
|
|
210
223
|
}
|
|
211
224
|
const serialized = this.serializer.serialize(input);
|
|
212
225
|
if (expectedMethod === "GET" && !(serialized instanceof FormData) && !isAsyncIteratorObject(serialized)) {
|
|
@@ -232,7 +245,7 @@ class StandardRPCLinkCodec {
|
|
|
232
245
|
};
|
|
233
246
|
}
|
|
234
247
|
async decode(response) {
|
|
235
|
-
const isOk = response.status
|
|
248
|
+
const isOk = !isORPCErrorStatus(response.status);
|
|
236
249
|
const deserialized = await (async () => {
|
|
237
250
|
let isBodyOk = false;
|
|
238
251
|
try {
|
|
@@ -251,11 +264,12 @@ class StandardRPCLinkCodec {
|
|
|
251
264
|
}
|
|
252
265
|
})();
|
|
253
266
|
if (!isOk) {
|
|
254
|
-
if (
|
|
255
|
-
throw
|
|
267
|
+
if (isORPCErrorJson(deserialized)) {
|
|
268
|
+
throw createORPCErrorFromJson(deserialized);
|
|
256
269
|
}
|
|
257
|
-
throw new
|
|
258
|
-
|
|
270
|
+
throw new ORPCError(getMalformedResponseErrorCode(response.status), {
|
|
271
|
+
status: response.status,
|
|
272
|
+
data: { ...response, body: deserialized }
|
|
259
273
|
});
|
|
260
274
|
}
|
|
261
275
|
return deserialized;
|
|
@@ -305,8 +319,8 @@ class StandardRPCSerializer {
|
|
|
305
319
|
return e;
|
|
306
320
|
}
|
|
307
321
|
const deserialized = this.#deserialize(e.data);
|
|
308
|
-
if (
|
|
309
|
-
return
|
|
322
|
+
if (isORPCErrorJson(deserialized)) {
|
|
323
|
+
return createORPCErrorFromJson(deserialized, { cause: e });
|
|
310
324
|
}
|
|
311
325
|
return new ErrorEvent({
|
|
312
326
|
data: deserialized,
|
|
@@ -331,4 +345,4 @@ class StandardRPCSerializer {
|
|
|
331
345
|
}
|
|
332
346
|
}
|
|
333
347
|
|
|
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 };
|
|
348
|
+
export { CompositeStandardLinkPlugin as C, 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 };
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@orpc/client",
|
|
3
3
|
"type": "module",
|
|
4
|
-
"version": "0.0.0-next.
|
|
4
|
+
"version": "0.0.0-next.3ee2e95",
|
|
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": "0.0.0-next.
|
|
43
|
-
"@orpc/standard-server-fetch": "0.0.0-next.
|
|
44
|
-
"@orpc/standard-server": "0.0.0-next.
|
|
42
|
+
"@orpc/shared": "0.0.0-next.3ee2e95",
|
|
43
|
+
"@orpc/standard-server-fetch": "0.0.0-next.3ee2e95",
|
|
44
|
+
"@orpc/standard-server": "0.0.0-next.3ee2e95"
|
|
45
45
|
},
|
|
46
46
|
"devDependencies": {
|
|
47
47
|
"zod": "^3.24.2"
|
|
@@ -1,30 +0,0 @@
|
|
|
1
|
-
type ClientContext = Record<string, any>;
|
|
2
|
-
type ClientOptions<TClientContext extends ClientContext> = {
|
|
3
|
-
signal?: AbortSignal;
|
|
4
|
-
lastEventId?: string | undefined;
|
|
5
|
-
} & (Record<never, never> extends TClientContext ? {
|
|
6
|
-
context?: TClientContext;
|
|
7
|
-
} : {
|
|
8
|
-
context: TClientContext;
|
|
9
|
-
});
|
|
10
|
-
type ClientRest<TClientContext extends ClientContext, TInput> = Record<never, never> extends TClientContext ? undefined extends TInput ? [input?: TInput, options?: ClientOptions<TClientContext>] : [input: TInput, options?: ClientOptions<TClientContext>] : [input: TInput, options: ClientOptions<TClientContext>];
|
|
11
|
-
type ClientPromiseResult<TOutput, TError extends Error> = Promise<TOutput> & {
|
|
12
|
-
__error?: {
|
|
13
|
-
type: TError;
|
|
14
|
-
};
|
|
15
|
-
};
|
|
16
|
-
interface Client<TClientContext extends ClientContext, TInput, TOutput, TError extends Error> {
|
|
17
|
-
(...rest: ClientRest<TClientContext, TInput>): ClientPromiseResult<TOutput, TError>;
|
|
18
|
-
}
|
|
19
|
-
type NestedClient<TClientContext extends ClientContext> = Client<TClientContext, any, any, any> | {
|
|
20
|
-
[k: string]: NestedClient<TClientContext>;
|
|
21
|
-
};
|
|
22
|
-
type InferClientContext<T extends NestedClient<any>> = T extends NestedClient<infer U> ? U : never;
|
|
23
|
-
type ClientOptionsOut<TClientContext extends ClientContext> = ClientOptions<TClientContext> & {
|
|
24
|
-
context: TClientContext;
|
|
25
|
-
};
|
|
26
|
-
interface ClientLink<TClientContext extends ClientContext> {
|
|
27
|
-
call: (path: readonly string[], input: unknown, options: ClientOptionsOut<TClientContext>) => Promise<unknown>;
|
|
28
|
-
}
|
|
29
|
-
|
|
30
|
-
export type { ClientOptionsOut as C, InferClientContext as I, NestedClient as N, ClientContext as a, ClientLink as b, ClientPromiseResult as c, ClientOptions as d, ClientRest as e, Client as f };
|
|
@@ -1,30 +0,0 @@
|
|
|
1
|
-
type ClientContext = Record<string, any>;
|
|
2
|
-
type ClientOptions<TClientContext extends ClientContext> = {
|
|
3
|
-
signal?: AbortSignal;
|
|
4
|
-
lastEventId?: string | undefined;
|
|
5
|
-
} & (Record<never, never> extends TClientContext ? {
|
|
6
|
-
context?: TClientContext;
|
|
7
|
-
} : {
|
|
8
|
-
context: TClientContext;
|
|
9
|
-
});
|
|
10
|
-
type ClientRest<TClientContext extends ClientContext, TInput> = Record<never, never> extends TClientContext ? undefined extends TInput ? [input?: TInput, options?: ClientOptions<TClientContext>] : [input: TInput, options?: ClientOptions<TClientContext>] : [input: TInput, options: ClientOptions<TClientContext>];
|
|
11
|
-
type ClientPromiseResult<TOutput, TError extends Error> = Promise<TOutput> & {
|
|
12
|
-
__error?: {
|
|
13
|
-
type: TError;
|
|
14
|
-
};
|
|
15
|
-
};
|
|
16
|
-
interface Client<TClientContext extends ClientContext, TInput, TOutput, TError extends Error> {
|
|
17
|
-
(...rest: ClientRest<TClientContext, TInput>): ClientPromiseResult<TOutput, TError>;
|
|
18
|
-
}
|
|
19
|
-
type NestedClient<TClientContext extends ClientContext> = Client<TClientContext, any, any, any> | {
|
|
20
|
-
[k: string]: NestedClient<TClientContext>;
|
|
21
|
-
};
|
|
22
|
-
type InferClientContext<T extends NestedClient<any>> = T extends NestedClient<infer U> ? U : never;
|
|
23
|
-
type ClientOptionsOut<TClientContext extends ClientContext> = ClientOptions<TClientContext> & {
|
|
24
|
-
context: TClientContext;
|
|
25
|
-
};
|
|
26
|
-
interface ClientLink<TClientContext extends ClientContext> {
|
|
27
|
-
call: (path: readonly string[], input: unknown, options: ClientOptionsOut<TClientContext>) => Promise<unknown>;
|
|
28
|
-
}
|
|
29
|
-
|
|
30
|
-
export type { ClientOptionsOut as C, InferClientContext as I, NestedClient as N, ClientContext as a, ClientLink as b, ClientPromiseResult as c, ClientOptions as d, ClientRest as e, Client as f };
|
|
@@ -1,45 +0,0 @@
|
|
|
1
|
-
import { Interceptor } from '@orpc/shared';
|
|
2
|
-
import { StandardRequest, StandardLazyResponse } from '@orpc/standard-server';
|
|
3
|
-
import { a as ClientContext, C as ClientOptionsOut, b as ClientLink } from './client.CupM8eRP.mjs';
|
|
4
|
-
|
|
5
|
-
interface StandardLinkCodec<T extends ClientContext> {
|
|
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
|
-
}
|
|
12
|
-
|
|
13
|
-
declare class InvalidEventIteratorRetryResponse extends Error {
|
|
14
|
-
}
|
|
15
|
-
interface StandardLinkOptions<T extends ClientContext> {
|
|
16
|
-
interceptors?: Interceptor<{
|
|
17
|
-
path: readonly string[];
|
|
18
|
-
input: unknown;
|
|
19
|
-
options: ClientOptionsOut<T>;
|
|
20
|
-
}, unknown, unknown>[];
|
|
21
|
-
clientInterceptors?: Interceptor<{
|
|
22
|
-
request: StandardRequest;
|
|
23
|
-
}, StandardLazyResponse, unknown>[];
|
|
24
|
-
plugins?: ClientPlugin<T>[];
|
|
25
|
-
}
|
|
26
|
-
declare class StandardLink<T extends ClientContext> implements ClientLink<T> {
|
|
27
|
-
#private;
|
|
28
|
-
readonly codec: StandardLinkCodec<T>;
|
|
29
|
-
readonly sender: StandardLinkClient<T>;
|
|
30
|
-
private readonly interceptors;
|
|
31
|
-
private readonly clientInterceptors;
|
|
32
|
-
constructor(codec: StandardLinkCodec<T>, sender: StandardLinkClient<T>, options?: StandardLinkOptions<T>);
|
|
33
|
-
call(path: readonly string[], input: unknown, options: ClientOptionsOut<T>): Promise<unknown>;
|
|
34
|
-
}
|
|
35
|
-
|
|
36
|
-
interface ClientPlugin<T extends ClientContext> {
|
|
37
|
-
init?(options: StandardLinkOptions<T>): void;
|
|
38
|
-
}
|
|
39
|
-
declare class CompositeClientPlugin<T extends ClientContext> implements ClientPlugin<T> {
|
|
40
|
-
private readonly plugins;
|
|
41
|
-
constructor(plugins?: ClientPlugin<T>[]);
|
|
42
|
-
init(options: StandardLinkOptions<T>): void;
|
|
43
|
-
}
|
|
44
|
-
|
|
45
|
-
export { type ClientPlugin as C, InvalidEventIteratorRetryResponse as I, type StandardLinkOptions as S, CompositeClientPlugin as a, type StandardLinkClient as b, type StandardLinkCodec as c, StandardLink as d };
|