@orpc/client 0.0.0-next.32f3296 → 0.0.0-next.3312214
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 +33 -22
- package/dist/adapters/fetch/index.d.mts +31 -14
- package/dist/adapters/fetch/index.d.ts +31 -14
- package/dist/adapters/fetch/index.mjs +26 -17
- package/dist/adapters/message-port/index.d.mts +80 -0
- package/dist/adapters/message-port/index.d.ts +80 -0
- package/dist/adapters/message-port/index.mjs +86 -0
- package/dist/adapters/standard/index.d.mts +9 -167
- package/dist/adapters/standard/index.d.ts +9 -167
- package/dist/adapters/standard/index.mjs +3 -2
- package/dist/adapters/websocket/index.d.mts +29 -0
- package/dist/adapters/websocket/index.d.ts +29 -0
- package/dist/adapters/websocket/index.mjs +46 -0
- package/dist/index.d.mts +107 -32
- package/dist/index.d.ts +107 -32
- package/dist/index.mjs +84 -36
- package/dist/plugins/index.d.mts +203 -0
- package/dist/plugins/index.d.ts +203 -0
- package/dist/plugins/index.mjs +407 -0
- package/dist/shared/client.BH1AYT_p.d.mts +83 -0
- package/dist/shared/client.BH1AYT_p.d.ts +83 -0
- package/dist/shared/client.BxV-mzeR.d.ts +91 -0
- package/dist/shared/client.CPgZaUox.d.mts +45 -0
- package/dist/shared/client.D8lMmWVC.d.mts +91 -0
- package/dist/shared/{client.d_qAa5GQ.mjs → client.DG0b9zac.mjs} +122 -75
- package/dist/shared/client.De8SW4Kw.d.ts +45 -0
- package/dist/shared/client.Dh97HgVt.mjs +208 -0
- package/package.json +21 -5
- package/dist/shared/client.D_CzLDyB.d.mts +0 -42
- package/dist/shared/client.D_CzLDyB.d.ts +0 -42
- package/dist/shared/client.XAn8cDTM.mjs +0 -266
|
@@ -0,0 +1,83 @@
|
|
|
1
|
+
import { PromiseWithError } from '@orpc/shared';
|
|
2
|
+
|
|
3
|
+
type HTTPPath = `/${string}`;
|
|
4
|
+
type HTTPMethod = 'HEAD' | '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
|
+
* Recursively infers the **input types** from a client.
|
|
30
|
+
*
|
|
31
|
+
* Produces a nested map where each endpoint's input type is preserved.
|
|
32
|
+
*/
|
|
33
|
+
type InferClientInputs<T extends NestedClient<any>> = T extends Client<any, infer U, any, any> ? U : {
|
|
34
|
+
[K in keyof T]: T[K] extends NestedClient<any> ? InferClientInputs<T[K]> : never;
|
|
35
|
+
};
|
|
36
|
+
/**
|
|
37
|
+
* Recursively infers the **body input types** from a client.
|
|
38
|
+
*
|
|
39
|
+
* If an endpoint's input includes `{ body: ... }`, only the `body` portion is extracted.
|
|
40
|
+
* Produces a nested map of body input types.
|
|
41
|
+
*/
|
|
42
|
+
type InferClientBodyInputs<T extends NestedClient<any>> = T extends Client<any, infer U, any, any> ? U extends {
|
|
43
|
+
body: infer UBody;
|
|
44
|
+
} ? UBody : U : {
|
|
45
|
+
[K in keyof T]: T[K] extends NestedClient<any> ? InferClientBodyInputs<T[K]> : never;
|
|
46
|
+
};
|
|
47
|
+
/**
|
|
48
|
+
* Recursively infers the **output types** from a client.
|
|
49
|
+
*
|
|
50
|
+
* Produces a nested map where each endpoint's output type is preserved.
|
|
51
|
+
*/
|
|
52
|
+
type InferClientOutputs<T extends NestedClient<any>> = T extends Client<any, any, infer U, any> ? U : {
|
|
53
|
+
[K in keyof T]: T[K] extends NestedClient<any> ? InferClientOutputs<T[K]> : never;
|
|
54
|
+
};
|
|
55
|
+
/**
|
|
56
|
+
* Recursively infers the **body output types** from a client.
|
|
57
|
+
*
|
|
58
|
+
* If an endpoint's output includes `{ body: ... }`, only the `body` portion is extracted.
|
|
59
|
+
* Produces a nested map of body output types.
|
|
60
|
+
*/
|
|
61
|
+
type InferClientBodyOutputs<T extends NestedClient<any>> = T extends Client<any, any, infer U, any> ? U extends {
|
|
62
|
+
body: infer UBody;
|
|
63
|
+
} ? UBody : U : {
|
|
64
|
+
[K in keyof T]: T[K] extends NestedClient<any> ? InferClientBodyOutputs<T[K]> : never;
|
|
65
|
+
};
|
|
66
|
+
/**
|
|
67
|
+
* Recursively infers the **error types** from a client when you use [type-safe errors](https://orpc.unnoq.com/docs/error-handling#type‐safe-error-handling).
|
|
68
|
+
*
|
|
69
|
+
* Produces a nested map where each endpoint's error type is preserved.
|
|
70
|
+
*/
|
|
71
|
+
type InferClientErrors<T extends NestedClient<any>> = T extends Client<any, any, any, infer U> ? U : {
|
|
72
|
+
[K in keyof T]: T[K] extends NestedClient<any> ? InferClientErrors<T[K]> : never;
|
|
73
|
+
};
|
|
74
|
+
/**
|
|
75
|
+
* Recursively infers a **union of all error types** from a client when you use [type-safe errors](https://orpc.unnoq.com/docs/error-handling#type‐safe-error-handling).
|
|
76
|
+
*
|
|
77
|
+
* Useful when you want to handle all possible errors from any endpoint at once.
|
|
78
|
+
*/
|
|
79
|
+
type InferClientErrorUnion<T extends NestedClient<any>> = T extends Client<any, any, any, infer U> ? U : {
|
|
80
|
+
[K in keyof T]: T[K] extends NestedClient<any> ? InferClientErrorUnion<T[K]> : never;
|
|
81
|
+
}[keyof T];
|
|
82
|
+
|
|
83
|
+
export type { ClientLink as C, FriendlyClientOptions as F, HTTPPath as H, InferClientContext as I, NestedClient as N, ClientPromiseResult as a, ClientContext as b, ClientOptions as c, Client as d, ClientRest as e, HTTPMethod as f, InferClientInputs as g, InferClientBodyInputs as h, InferClientOutputs as i, InferClientBodyOutputs as j, InferClientErrors as k, InferClientErrorUnion as l };
|
|
@@ -0,0 +1,91 @@
|
|
|
1
|
+
import { b as ClientContext, c as ClientOptions, f as HTTPMethod } from './client.BH1AYT_p.js';
|
|
2
|
+
import { e as StandardLinkCodec, b as StandardLinkOptions, d as StandardLink, f as StandardLinkClient } from './client.De8SW4Kw.js';
|
|
3
|
+
import { Segment, Value, Promisable } 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<Promisable<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<Promisable<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<Promisable<Exclude<HTTPMethod, 'HEAD'>>, [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, 'HEAD' | 'GET'>;
|
|
67
|
+
/**
|
|
68
|
+
* Inject headers to the request.
|
|
69
|
+
*/
|
|
70
|
+
headers?: Value<Promisable<StandardHeaders | Headers>, [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
|
+
declare class StandardRPCLink<T extends ClientContext> extends StandardLink<T> {
|
|
87
|
+
constructor(linkClient: StandardLinkClient<T>, options: StandardRPCLinkOptions<T>);
|
|
88
|
+
}
|
|
89
|
+
|
|
90
|
+
export { STANDARD_RPC_JSON_SERIALIZER_BUILT_IN_TYPES as S, StandardRPCJsonSerializer as e, StandardRPCLink as g, StandardRPCLinkCodec as i, StandardRPCSerializer as j };
|
|
91
|
+
export type { StandardRPCJsonSerializedMetaItem as a, StandardRPCJsonSerialized as b, StandardRPCCustomJsonSerializer as c, StandardRPCJsonSerializerOptions as d, StandardRPCLinkOptions as f, StandardRPCLinkCodecOptions as h };
|
|
@@ -0,0 +1,45 @@
|
|
|
1
|
+
import { Interceptor } from '@orpc/shared';
|
|
2
|
+
import { StandardRequest, StandardLazyResponse } from '@orpc/standard-server';
|
|
3
|
+
import { b as ClientContext, c as ClientOptions, C as ClientLink } from './client.BH1AYT_p.mjs';
|
|
4
|
+
|
|
5
|
+
interface StandardLinkPlugin<T extends ClientContext> {
|
|
6
|
+
order?: number;
|
|
7
|
+
init?(options: StandardLinkOptions<T>): void;
|
|
8
|
+
}
|
|
9
|
+
declare class CompositeStandardLinkPlugin<T extends ClientContext, TPlugin extends StandardLinkPlugin<T>> implements StandardLinkPlugin<T> {
|
|
10
|
+
protected readonly plugins: TPlugin[];
|
|
11
|
+
constructor(plugins?: readonly TPlugin[]);
|
|
12
|
+
init(options: StandardLinkOptions<T>): void;
|
|
13
|
+
}
|
|
14
|
+
|
|
15
|
+
interface StandardLinkCodec<T extends ClientContext> {
|
|
16
|
+
encode(path: readonly string[], input: unknown, options: ClientOptions<T>): Promise<StandardRequest>;
|
|
17
|
+
decode(response: StandardLazyResponse, options: ClientOptions<T>, path: readonly string[], input: unknown): Promise<unknown>;
|
|
18
|
+
}
|
|
19
|
+
interface StandardLinkClient<T extends ClientContext> {
|
|
20
|
+
call(request: StandardRequest, options: ClientOptions<T>, path: readonly string[], input: unknown): Promise<StandardLazyResponse>;
|
|
21
|
+
}
|
|
22
|
+
|
|
23
|
+
interface StandardLinkInterceptorOptions<T extends ClientContext> extends ClientOptions<T> {
|
|
24
|
+
path: readonly string[];
|
|
25
|
+
input: unknown;
|
|
26
|
+
}
|
|
27
|
+
interface StandardLinkClientInterceptorOptions<T extends ClientContext> extends StandardLinkInterceptorOptions<T> {
|
|
28
|
+
request: StandardRequest;
|
|
29
|
+
}
|
|
30
|
+
interface StandardLinkOptions<T extends ClientContext> {
|
|
31
|
+
interceptors?: Interceptor<StandardLinkInterceptorOptions<T>, Promise<unknown>>[];
|
|
32
|
+
clientInterceptors?: Interceptor<StandardLinkClientInterceptorOptions<T>, Promise<StandardLazyResponse>>[];
|
|
33
|
+
plugins?: StandardLinkPlugin<T>[];
|
|
34
|
+
}
|
|
35
|
+
declare class StandardLink<T extends ClientContext> implements ClientLink<T> {
|
|
36
|
+
readonly codec: StandardLinkCodec<T>;
|
|
37
|
+
readonly sender: StandardLinkClient<T>;
|
|
38
|
+
private readonly interceptors;
|
|
39
|
+
private readonly clientInterceptors;
|
|
40
|
+
constructor(codec: StandardLinkCodec<T>, sender: StandardLinkClient<T>, options?: StandardLinkOptions<T>);
|
|
41
|
+
call(path: readonly string[], input: unknown, options: ClientOptions<T>): Promise<unknown>;
|
|
42
|
+
}
|
|
43
|
+
|
|
44
|
+
export { CompositeStandardLinkPlugin as C, StandardLink as d };
|
|
45
|
+
export type { StandardLinkClientInterceptorOptions as S, StandardLinkPlugin as a, StandardLinkOptions as b, StandardLinkInterceptorOptions as c, StandardLinkCodec as e, StandardLinkClient as f };
|
|
@@ -0,0 +1,91 @@
|
|
|
1
|
+
import { b as ClientContext, c as ClientOptions, f as HTTPMethod } from './client.BH1AYT_p.mjs';
|
|
2
|
+
import { e as StandardLinkCodec, b as StandardLinkOptions, d as StandardLink, f as StandardLinkClient } from './client.CPgZaUox.mjs';
|
|
3
|
+
import { Segment, Value, Promisable } 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<Promisable<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<Promisable<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<Promisable<Exclude<HTTPMethod, 'HEAD'>>, [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, 'HEAD' | 'GET'>;
|
|
67
|
+
/**
|
|
68
|
+
* Inject headers to the request.
|
|
69
|
+
*/
|
|
70
|
+
headers?: Value<Promisable<StandardHeaders | Headers>, [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
|
+
declare class StandardRPCLink<T extends ClientContext> extends StandardLink<T> {
|
|
87
|
+
constructor(linkClient: StandardLinkClient<T>, options: StandardRPCLinkOptions<T>);
|
|
88
|
+
}
|
|
89
|
+
|
|
90
|
+
export { STANDARD_RPC_JSON_SERIALIZER_BUILT_IN_TYPES as S, StandardRPCJsonSerializer as e, StandardRPCLink as g, StandardRPCLinkCodec as i, StandardRPCSerializer as j };
|
|
91
|
+
export type { StandardRPCJsonSerializedMetaItem as a, StandardRPCJsonSerialized as b, StandardRPCCustomJsonSerializer as c, StandardRPCJsonSerializerOptions as d, StandardRPCLinkOptions as f, StandardRPCLinkCodecOptions as h };
|
|
@@ -1,59 +1,78 @@
|
|
|
1
|
-
import {
|
|
2
|
-
import {
|
|
3
|
-
import {
|
|
1
|
+
import { toArray, runWithSpan, ORPC_NAME, isAsyncIteratorObject, asyncIteratorWithSpan, intercept, getGlobalOtelConfig, isObject, value, stringifyJSON } from '@orpc/shared';
|
|
2
|
+
import { mergeStandardHeaders, ErrorEvent } from '@orpc/standard-server';
|
|
3
|
+
import { C as COMMON_ORPC_ERROR_DEFS, d as isORPCErrorStatus, e as isORPCErrorJson, g as createORPCErrorFromJson, c as ORPCError, m as mapEventIterator, t as toORPCError } from './client.Dh97HgVt.mjs';
|
|
4
|
+
import { toStandardHeaders as toStandardHeaders$1 } from '@orpc/standard-server-fetch';
|
|
4
5
|
|
|
5
|
-
class
|
|
6
|
+
class CompositeStandardLinkPlugin {
|
|
7
|
+
plugins;
|
|
8
|
+
constructor(plugins = []) {
|
|
9
|
+
this.plugins = [...plugins].sort((a, b) => (a.order ?? 0) - (b.order ?? 0));
|
|
10
|
+
}
|
|
11
|
+
init(options) {
|
|
12
|
+
for (const plugin of this.plugins) {
|
|
13
|
+
plugin.init?.(options);
|
|
14
|
+
}
|
|
15
|
+
}
|
|
6
16
|
}
|
|
17
|
+
|
|
7
18
|
class StandardLink {
|
|
8
|
-
constructor(codec, sender, options) {
|
|
19
|
+
constructor(codec, sender, options = {}) {
|
|
9
20
|
this.codec = codec;
|
|
10
21
|
this.sender = sender;
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
this.
|
|
14
|
-
this.
|
|
15
|
-
this.clientInterceptors = options.clientInterceptors ?? [];
|
|
22
|
+
const plugin = new CompositeStandardLinkPlugin(options.plugins);
|
|
23
|
+
plugin.init(options);
|
|
24
|
+
this.interceptors = toArray(options.interceptors);
|
|
25
|
+
this.clientInterceptors = toArray(options.clientInterceptors);
|
|
16
26
|
}
|
|
17
|
-
eventIteratorMaxRetries;
|
|
18
|
-
eventIteratorRetryDelay;
|
|
19
|
-
eventIteratorShouldRetry;
|
|
20
27
|
interceptors;
|
|
21
28
|
clientInterceptors;
|
|
22
29
|
call(path, input, options) {
|
|
23
|
-
return
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
const shouldRetry = await value(this.eventIteratorShouldRetry, reconnectOptions, options2, path2, input2);
|
|
34
|
-
if (!shouldRetry) {
|
|
35
|
-
return null;
|
|
36
|
-
}
|
|
37
|
-
const retryDelay = await value(this.eventIteratorRetryDelay, reconnectOptions, options2, path2, input2);
|
|
38
|
-
await new Promise((resolve) => setTimeout(resolve, retryDelay));
|
|
39
|
-
const updatedOptions = { ...options2, lastEventId: reconnectOptions.lastEventId };
|
|
40
|
-
const maybeIterator = await this.#call(path2, input2, updatedOptions);
|
|
41
|
-
if (!isAsyncIteratorObject(maybeIterator)) {
|
|
42
|
-
throw new InvalidEventIteratorRetryResponse("Invalid Event Iterator retry response");
|
|
30
|
+
return runWithSpan(
|
|
31
|
+
{ name: `${ORPC_NAME}.${path.join("/")}`, signal: options.signal },
|
|
32
|
+
(span) => {
|
|
33
|
+
span?.setAttribute("rpc.system", ORPC_NAME);
|
|
34
|
+
span?.setAttribute("rpc.method", path.join("."));
|
|
35
|
+
if (isAsyncIteratorObject(input)) {
|
|
36
|
+
input = asyncIteratorWithSpan(
|
|
37
|
+
{ name: "consume_event_iterator_input", signal: options.signal },
|
|
38
|
+
input
|
|
39
|
+
);
|
|
43
40
|
}
|
|
44
|
-
return
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
41
|
+
return intercept(this.interceptors, { ...options, path, input }, async ({ path: path2, input: input2, ...options2 }) => {
|
|
42
|
+
const otelConfig = getGlobalOtelConfig();
|
|
43
|
+
let otelContext;
|
|
44
|
+
const currentSpan = otelConfig?.trace.getActiveSpan() ?? span;
|
|
45
|
+
if (currentSpan && otelConfig) {
|
|
46
|
+
otelContext = otelConfig?.trace.setSpan(otelConfig.context.active(), currentSpan);
|
|
47
|
+
}
|
|
48
|
+
const request = await runWithSpan(
|
|
49
|
+
{ name: "encode_request", context: otelContext },
|
|
50
|
+
() => this.codec.encode(path2, input2, options2)
|
|
51
|
+
);
|
|
52
|
+
const response = await intercept(
|
|
53
|
+
this.clientInterceptors,
|
|
54
|
+
{ ...options2, input: input2, path: path2, request },
|
|
55
|
+
({ input: input3, path: path3, request: request2, ...options3 }) => {
|
|
56
|
+
return runWithSpan(
|
|
57
|
+
{ name: "send_request", signal: options3.signal, context: otelContext },
|
|
58
|
+
() => this.sender.call(request2, options3, path3, input3)
|
|
59
|
+
);
|
|
60
|
+
}
|
|
61
|
+
);
|
|
62
|
+
const output = await runWithSpan(
|
|
63
|
+
{ name: "decode_response", context: otelContext },
|
|
64
|
+
() => this.codec.decode(response, options2, path2, input2)
|
|
65
|
+
);
|
|
66
|
+
if (isAsyncIteratorObject(output)) {
|
|
67
|
+
return asyncIteratorWithSpan(
|
|
68
|
+
{ name: "consume_event_iterator_output", signal: options2.signal },
|
|
69
|
+
output
|
|
70
|
+
);
|
|
71
|
+
}
|
|
72
|
+
return output;
|
|
73
|
+
});
|
|
74
|
+
}
|
|
54
75
|
);
|
|
55
|
-
const output = await this.codec.decode(response, options, path, input);
|
|
56
|
-
return output;
|
|
57
76
|
}
|
|
58
77
|
}
|
|
59
78
|
|
|
@@ -79,7 +98,7 @@ class StandardRPCJsonSerializer {
|
|
|
79
98
|
for (const custom of this.customSerializers) {
|
|
80
99
|
if (custom.condition(data)) {
|
|
81
100
|
const result = this.serialize(custom.serialize(data), segments, meta, maps, blobs);
|
|
82
|
-
meta.push([custom.type, segments]);
|
|
101
|
+
meta.push([custom.type, ...segments]);
|
|
83
102
|
return result;
|
|
84
103
|
}
|
|
85
104
|
}
|
|
@@ -89,42 +108,42 @@ class StandardRPCJsonSerializer {
|
|
|
89
108
|
return [data, meta, maps, blobs];
|
|
90
109
|
}
|
|
91
110
|
if (typeof data === "bigint") {
|
|
92
|
-
meta.push([STANDARD_RPC_JSON_SERIALIZER_BUILT_IN_TYPES.BIGINT, segments]);
|
|
111
|
+
meta.push([STANDARD_RPC_JSON_SERIALIZER_BUILT_IN_TYPES.BIGINT, ...segments]);
|
|
93
112
|
return [data.toString(), meta, maps, blobs];
|
|
94
113
|
}
|
|
95
114
|
if (data instanceof Date) {
|
|
96
|
-
meta.push([STANDARD_RPC_JSON_SERIALIZER_BUILT_IN_TYPES.DATE, segments]);
|
|
115
|
+
meta.push([STANDARD_RPC_JSON_SERIALIZER_BUILT_IN_TYPES.DATE, ...segments]);
|
|
97
116
|
if (Number.isNaN(data.getTime())) {
|
|
98
117
|
return [null, meta, maps, blobs];
|
|
99
118
|
}
|
|
100
119
|
return [data.toISOString(), meta, maps, blobs];
|
|
101
120
|
}
|
|
102
121
|
if (Number.isNaN(data)) {
|
|
103
|
-
meta.push([STANDARD_RPC_JSON_SERIALIZER_BUILT_IN_TYPES.NAN, segments]);
|
|
122
|
+
meta.push([STANDARD_RPC_JSON_SERIALIZER_BUILT_IN_TYPES.NAN, ...segments]);
|
|
104
123
|
return [null, meta, maps, blobs];
|
|
105
124
|
}
|
|
106
125
|
if (data instanceof URL) {
|
|
107
|
-
meta.push([STANDARD_RPC_JSON_SERIALIZER_BUILT_IN_TYPES.URL, segments]);
|
|
126
|
+
meta.push([STANDARD_RPC_JSON_SERIALIZER_BUILT_IN_TYPES.URL, ...segments]);
|
|
108
127
|
return [data.toString(), meta, maps, blobs];
|
|
109
128
|
}
|
|
110
129
|
if (data instanceof RegExp) {
|
|
111
|
-
meta.push([STANDARD_RPC_JSON_SERIALIZER_BUILT_IN_TYPES.REGEXP, segments]);
|
|
130
|
+
meta.push([STANDARD_RPC_JSON_SERIALIZER_BUILT_IN_TYPES.REGEXP, ...segments]);
|
|
112
131
|
return [data.toString(), meta, maps, blobs];
|
|
113
132
|
}
|
|
114
133
|
if (data instanceof Set) {
|
|
115
134
|
const result = this.serialize(Array.from(data), segments, meta, maps, blobs);
|
|
116
|
-
meta.push([STANDARD_RPC_JSON_SERIALIZER_BUILT_IN_TYPES.SET, segments]);
|
|
135
|
+
meta.push([STANDARD_RPC_JSON_SERIALIZER_BUILT_IN_TYPES.SET, ...segments]);
|
|
117
136
|
return result;
|
|
118
137
|
}
|
|
119
138
|
if (data instanceof Map) {
|
|
120
139
|
const result = this.serialize(Array.from(data.entries()), segments, meta, maps, blobs);
|
|
121
|
-
meta.push([STANDARD_RPC_JSON_SERIALIZER_BUILT_IN_TYPES.MAP, segments]);
|
|
140
|
+
meta.push([STANDARD_RPC_JSON_SERIALIZER_BUILT_IN_TYPES.MAP, ...segments]);
|
|
122
141
|
return result;
|
|
123
142
|
}
|
|
124
143
|
if (Array.isArray(data)) {
|
|
125
144
|
const json = data.map((v, i) => {
|
|
126
145
|
if (v === void 0) {
|
|
127
|
-
meta.push([STANDARD_RPC_JSON_SERIALIZER_BUILT_IN_TYPES.UNDEFINED,
|
|
146
|
+
meta.push([STANDARD_RPC_JSON_SERIALIZER_BUILT_IN_TYPES.UNDEFINED, ...segments, i]);
|
|
128
147
|
return v;
|
|
129
148
|
}
|
|
130
149
|
return this.serialize(v, [...segments, i], meta, maps, blobs)[0];
|
|
@@ -134,6 +153,9 @@ class StandardRPCJsonSerializer {
|
|
|
134
153
|
if (isObject(data)) {
|
|
135
154
|
const json = {};
|
|
136
155
|
for (const k in data) {
|
|
156
|
+
if (k === "toJSON" && typeof data[k] === "function") {
|
|
157
|
+
continue;
|
|
158
|
+
}
|
|
137
159
|
json[k] = this.serialize(data[k], [...segments, k], meta, maps, blobs)[0];
|
|
138
160
|
}
|
|
139
161
|
return [json, meta, maps, blobs];
|
|
@@ -153,13 +175,14 @@ class StandardRPCJsonSerializer {
|
|
|
153
175
|
currentRef[preSegment] = getBlob(i);
|
|
154
176
|
});
|
|
155
177
|
}
|
|
156
|
-
for (const
|
|
178
|
+
for (const item of meta) {
|
|
179
|
+
const type = item[0];
|
|
157
180
|
let currentRef = ref;
|
|
158
181
|
let preSegment = "data";
|
|
159
|
-
|
|
182
|
+
for (let i = 1; i < item.length; i++) {
|
|
160
183
|
currentRef = currentRef[preSegment];
|
|
161
|
-
preSegment =
|
|
162
|
-
}
|
|
184
|
+
preSegment = item[i];
|
|
185
|
+
}
|
|
163
186
|
for (const custom of this.customSerializers) {
|
|
164
187
|
if (custom.type === type) {
|
|
165
188
|
currentRef[preSegment] = custom.deserialize(currentRef[preSegment]);
|
|
@@ -199,6 +222,19 @@ class StandardRPCJsonSerializer {
|
|
|
199
222
|
}
|
|
200
223
|
}
|
|
201
224
|
|
|
225
|
+
function toHttpPath(path) {
|
|
226
|
+
return `/${path.map(encodeURIComponent).join("/")}`;
|
|
227
|
+
}
|
|
228
|
+
function toStandardHeaders(headers) {
|
|
229
|
+
if (typeof headers.forEach === "function") {
|
|
230
|
+
return toStandardHeaders$1(headers);
|
|
231
|
+
}
|
|
232
|
+
return headers;
|
|
233
|
+
}
|
|
234
|
+
function getMalformedResponseErrorCode(status) {
|
|
235
|
+
return Object.entries(COMMON_ORPC_ERROR_DEFS).find(([, def]) => def.status === status)?.[0] ?? "MALFORMED_ORPC_ERROR_RESPONSE";
|
|
236
|
+
}
|
|
237
|
+
|
|
202
238
|
class StandardRPCLinkCodec {
|
|
203
239
|
constructor(serializer, options) {
|
|
204
240
|
this.serializer = serializer;
|
|
@@ -214,15 +250,19 @@ class StandardRPCLinkCodec {
|
|
|
214
250
|
expectedMethod;
|
|
215
251
|
headers;
|
|
216
252
|
async encode(path, input, options) {
|
|
253
|
+
let headers = toStandardHeaders(await value(this.headers, options, path, input));
|
|
254
|
+
if (options.lastEventId !== void 0) {
|
|
255
|
+
headers = mergeStandardHeaders(headers, { "last-event-id": options.lastEventId });
|
|
256
|
+
}
|
|
217
257
|
const expectedMethod = await value(this.expectedMethod, options, path, input);
|
|
218
|
-
const headers = await value(this.headers, options, path, input);
|
|
219
258
|
const baseUrl = await value(this.baseUrl, options, path, input);
|
|
220
|
-
const url = new URL(
|
|
259
|
+
const url = new URL(baseUrl);
|
|
260
|
+
url.pathname = `${url.pathname.replace(/\/$/, "")}${toHttpPath(path)}`;
|
|
221
261
|
const serialized = this.serializer.serialize(input);
|
|
222
|
-
if (expectedMethod === "GET" && !(serialized instanceof FormData) && !
|
|
262
|
+
if (expectedMethod === "GET" && !(serialized instanceof FormData) && !isAsyncIteratorObject(serialized)) {
|
|
223
263
|
const maxUrlLength = await value(this.maxUrlLength, options, path, input);
|
|
224
264
|
const getUrl = new URL(url);
|
|
225
|
-
getUrl.searchParams.append("data", stringifyJSON(serialized)
|
|
265
|
+
getUrl.searchParams.append("data", stringifyJSON(serialized));
|
|
226
266
|
if (getUrl.toString().length <= maxUrlLength) {
|
|
227
267
|
return {
|
|
228
268
|
body: void 0,
|
|
@@ -242,7 +282,7 @@ class StandardRPCLinkCodec {
|
|
|
242
282
|
};
|
|
243
283
|
}
|
|
244
284
|
async decode(response) {
|
|
245
|
-
const isOk = response.status
|
|
285
|
+
const isOk = !isORPCErrorStatus(response.status);
|
|
246
286
|
const deserialized = await (async () => {
|
|
247
287
|
let isBodyOk = false;
|
|
248
288
|
try {
|
|
@@ -261,11 +301,12 @@ class StandardRPCLinkCodec {
|
|
|
261
301
|
}
|
|
262
302
|
})();
|
|
263
303
|
if (!isOk) {
|
|
264
|
-
if (
|
|
265
|
-
throw
|
|
304
|
+
if (isORPCErrorJson(deserialized)) {
|
|
305
|
+
throw createORPCErrorFromJson(deserialized);
|
|
266
306
|
}
|
|
267
|
-
throw new
|
|
268
|
-
|
|
307
|
+
throw new ORPCError(getMalformedResponseErrorCode(response.status), {
|
|
308
|
+
status: response.status,
|
|
309
|
+
data: { ...response, body: deserialized }
|
|
269
310
|
});
|
|
270
311
|
}
|
|
271
312
|
return deserialized;
|
|
@@ -291,9 +332,6 @@ class StandardRPCSerializer {
|
|
|
291
332
|
return this.#serialize(data, true);
|
|
292
333
|
}
|
|
293
334
|
#serialize(data, enableFormData) {
|
|
294
|
-
if (data === void 0 || data instanceof Blob) {
|
|
295
|
-
return data;
|
|
296
|
-
}
|
|
297
335
|
const [json, meta_, maps, blobs] = this.jsonSerializer.serialize(data);
|
|
298
336
|
const meta = meta_.length === 0 ? void 0 : meta_;
|
|
299
337
|
if (!enableFormData || blobs.length === 0) {
|
|
@@ -318,8 +356,8 @@ class StandardRPCSerializer {
|
|
|
318
356
|
return e;
|
|
319
357
|
}
|
|
320
358
|
const deserialized = this.#deserialize(e.data);
|
|
321
|
-
if (
|
|
322
|
-
return
|
|
359
|
+
if (isORPCErrorJson(deserialized)) {
|
|
360
|
+
return createORPCErrorFromJson(deserialized, { cause: e });
|
|
323
361
|
}
|
|
324
362
|
return new ErrorEvent({
|
|
325
363
|
data: deserialized,
|
|
@@ -331,8 +369,8 @@ class StandardRPCSerializer {
|
|
|
331
369
|
return this.#deserialize(data);
|
|
332
370
|
}
|
|
333
371
|
#deserialize(data) {
|
|
334
|
-
if (data === void 0
|
|
335
|
-
return
|
|
372
|
+
if (data === void 0) {
|
|
373
|
+
return void 0;
|
|
336
374
|
}
|
|
337
375
|
if (!(data instanceof FormData)) {
|
|
338
376
|
return this.jsonSerializer.deserialize(data.json, data.meta ?? []);
|
|
@@ -347,4 +385,13 @@ class StandardRPCSerializer {
|
|
|
347
385
|
}
|
|
348
386
|
}
|
|
349
387
|
|
|
350
|
-
|
|
388
|
+
class StandardRPCLink extends StandardLink {
|
|
389
|
+
constructor(linkClient, options) {
|
|
390
|
+
const jsonSerializer = new StandardRPCJsonSerializer(options);
|
|
391
|
+
const serializer = new StandardRPCSerializer(jsonSerializer);
|
|
392
|
+
const linkCodec = new StandardRPCLinkCodec(serializer, options);
|
|
393
|
+
super(linkCodec, linkClient, options);
|
|
394
|
+
}
|
|
395
|
+
}
|
|
396
|
+
|
|
397
|
+
export { CompositeStandardLinkPlugin as C, StandardLink as S, STANDARD_RPC_JSON_SERIALIZER_BUILT_IN_TYPES as a, StandardRPCJsonSerializer as b, StandardRPCLink as c, StandardRPCLinkCodec as d, StandardRPCSerializer as e, toStandardHeaders as f, getMalformedResponseErrorCode as g, toHttpPath as t };
|