@orpc/client 0.0.0-next.d17ef5e → 0.0.0-next.d3571d4
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 +15 -17
- package/dist/adapters/fetch/index.d.mts +15 -12
- package/dist/adapters/fetch/index.d.ts +15 -12
- package/dist/adapters/fetch/index.mjs +5 -12
- 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/adapters/websocket/index.d.mts +29 -0
- package/dist/adapters/websocket/index.d.ts +29 -0
- package/dist/adapters/websocket/index.mjs +31 -0
- package/dist/index.d.mts +29 -11
- package/dist/index.d.ts +29 -11
- package/dist/index.mjs +8 -8
- package/dist/plugins/index.d.mts +121 -20
- package/dist/plugins/index.d.ts +121 -20
- package/dist/plugins/index.mjs +207 -42
- package/dist/shared/{client.RZs5Myak.d.mts → client.4TS_0JaO.d.mts} +14 -15
- package/dist/shared/{client.RZs5Myak.d.ts → client.4TS_0JaO.d.ts} +14 -15
- package/dist/shared/{client.Bt40CWA-.d.ts → client.7ZYxJok_.d.ts} +21 -14
- package/dist/shared/client.B2432-Lu.d.ts +91 -0
- package/dist/shared/{client.BacCdg3F.mjs → client.CRWEpqLB.mjs} +22 -19
- package/dist/shared/client.ClwIM_ku.d.mts +91 -0
- package/dist/shared/{client.B1XjLWRe.mjs → client.DpICn1BD.mjs} +48 -27
- package/dist/shared/{client.CKw2tbcl.d.mts → client.ds1abV85.d.mts} +21 -14
- package/package.json +10 -4
@@ -0,0 +1,91 @@
|
|
1
|
+
import { a as ClientContext, b as ClientOptions, d as HTTPMethod } from './client.4TS_0JaO.mjs';
|
2
|
+
import { e as StandardLinkCodec, b as StandardLinkOptions, d as StandardLink, f as StandardLinkClient } from './client.ds1abV85.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<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<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
|
+
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,23 +1,32 @@
|
|
1
|
-
import { toArray, intercept, isObject, value,
|
2
|
-
import {
|
3
|
-
import {
|
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
4
|
|
5
|
-
class
|
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
|
+
}
|
6
15
|
}
|
16
|
+
|
7
17
|
class StandardLink {
|
8
18
|
constructor(codec, sender, options = {}) {
|
9
19
|
this.codec = codec;
|
10
20
|
this.sender = sender;
|
11
|
-
|
12
|
-
|
13
|
-
}
|
21
|
+
const plugin = new CompositeStandardLinkPlugin(options.plugins);
|
22
|
+
plugin.init(options);
|
14
23
|
this.interceptors = toArray(options.interceptors);
|
15
24
|
this.clientInterceptors = toArray(options.clientInterceptors);
|
16
25
|
}
|
17
26
|
interceptors;
|
18
27
|
clientInterceptors;
|
19
28
|
call(path, input, options) {
|
20
|
-
return intercept(this.interceptors, { path, input
|
29
|
+
return intercept(this.interceptors, { ...options, path, input }, async ({ path: path2, input: input2, ...options2 }) => {
|
21
30
|
const output = await this.#call(path2, input2, options2);
|
22
31
|
return output;
|
23
32
|
});
|
@@ -26,8 +35,8 @@ class StandardLink {
|
|
26
35
|
const request = await this.codec.encode(path, input, options);
|
27
36
|
const response = await intercept(
|
28
37
|
this.clientInterceptors,
|
29
|
-
{ request },
|
30
|
-
({ request: request2 }) => this.sender.call(request2,
|
38
|
+
{ ...options, input, path, request },
|
39
|
+
({ input: input2, path: path2, request: request2, ...options2 }) => this.sender.call(request2, options2, path2, input2)
|
31
40
|
);
|
32
41
|
const output = await this.codec.decode(response, options, path, input);
|
33
42
|
return output;
|
@@ -180,6 +189,13 @@ class StandardRPCJsonSerializer {
|
|
180
189
|
}
|
181
190
|
}
|
182
191
|
|
192
|
+
function toHttpPath(path) {
|
193
|
+
return `/${path.map(encodeURIComponent).join("/")}`;
|
194
|
+
}
|
195
|
+
function getMalformedResponseErrorCode(status) {
|
196
|
+
return Object.entries(COMMON_ORPC_ERROR_DEFS).find(([, def]) => def.status === status)?.[0] ?? "MALFORMED_ORPC_ERROR_RESPONSE";
|
197
|
+
}
|
198
|
+
|
183
199
|
class StandardRPCLinkCodec {
|
184
200
|
constructor(serializer, options) {
|
185
201
|
this.serializer = serializer;
|
@@ -196,17 +212,12 @@ class StandardRPCLinkCodec {
|
|
196
212
|
headers;
|
197
213
|
async encode(path, input, options) {
|
198
214
|
const expectedMethod = await value(this.expectedMethod, options, path, input);
|
199
|
-
|
215
|
+
let headers = await value(this.headers, options, path, input);
|
200
216
|
const baseUrl = await value(this.baseUrl, options, path, input);
|
201
|
-
const url = new URL(
|
217
|
+
const url = new URL(baseUrl);
|
218
|
+
url.pathname = `${url.pathname.replace(/\/$/, "")}${toHttpPath(path)}`;
|
202
219
|
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
|
-
}
|
220
|
+
headers = mergeStandardHeaders(headers, { "last-event-id": options.lastEventId });
|
210
221
|
}
|
211
222
|
const serialized = this.serializer.serialize(input);
|
212
223
|
if (expectedMethod === "GET" && !(serialized instanceof FormData) && !isAsyncIteratorObject(serialized)) {
|
@@ -232,7 +243,7 @@ class StandardRPCLinkCodec {
|
|
232
243
|
};
|
233
244
|
}
|
234
245
|
async decode(response) {
|
235
|
-
const isOk = response.status
|
246
|
+
const isOk = !isORPCErrorStatus(response.status);
|
236
247
|
const deserialized = await (async () => {
|
237
248
|
let isBodyOk = false;
|
238
249
|
try {
|
@@ -251,11 +262,12 @@ class StandardRPCLinkCodec {
|
|
251
262
|
}
|
252
263
|
})();
|
253
264
|
if (!isOk) {
|
254
|
-
if (
|
255
|
-
throw
|
265
|
+
if (isORPCErrorJson(deserialized)) {
|
266
|
+
throw createORPCErrorFromJson(deserialized);
|
256
267
|
}
|
257
|
-
throw new
|
258
|
-
|
268
|
+
throw new ORPCError(getMalformedResponseErrorCode(response.status), {
|
269
|
+
status: response.status,
|
270
|
+
data: { ...response, body: deserialized }
|
259
271
|
});
|
260
272
|
}
|
261
273
|
return deserialized;
|
@@ -305,8 +317,8 @@ class StandardRPCSerializer {
|
|
305
317
|
return e;
|
306
318
|
}
|
307
319
|
const deserialized = this.#deserialize(e.data);
|
308
|
-
if (
|
309
|
-
return
|
320
|
+
if (isORPCErrorJson(deserialized)) {
|
321
|
+
return createORPCErrorFromJson(deserialized, { cause: e });
|
310
322
|
}
|
311
323
|
return new ErrorEvent({
|
312
324
|
data: deserialized,
|
@@ -331,4 +343,13 @@ class StandardRPCSerializer {
|
|
331
343
|
}
|
332
344
|
}
|
333
345
|
|
334
|
-
|
346
|
+
class StandardRPCLink extends StandardLink {
|
347
|
+
constructor(linkClient, options) {
|
348
|
+
const jsonSerializer = new StandardRPCJsonSerializer(options);
|
349
|
+
const serializer = new StandardRPCSerializer(jsonSerializer);
|
350
|
+
const linkCodec = new StandardRPCLinkCodec(serializer, options);
|
351
|
+
super(linkCodec, linkClient, options);
|
352
|
+
}
|
353
|
+
}
|
354
|
+
|
355
|
+
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, getMalformedResponseErrorCode as g, toHttpPath as t };
|
@@ -1,6 +1,16 @@
|
|
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.4TS_0JaO.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
|
+
}
|
4
14
|
|
5
15
|
interface StandardLinkCodec<T extends ClientContext> {
|
6
16
|
encode(path: readonly string[], input: unknown, options: ClientOptions<T>): Promise<StandardRequest>;
|
@@ -10,20 +20,16 @@ interface StandardLinkClient<T extends ClientContext> {
|
|
10
20
|
call(request: StandardRequest, options: ClientOptions<T>, path: readonly string[], input: unknown): Promise<StandardLazyResponse>;
|
11
21
|
}
|
12
22
|
|
13
|
-
|
23
|
+
interface StandardLinkInterceptorOptions<T extends ClientContext> extends ClientOptions<T> {
|
24
|
+
path: readonly string[];
|
25
|
+
input: unknown;
|
14
26
|
}
|
15
|
-
interface
|
16
|
-
|
27
|
+
interface StandardLinkClientInterceptorOptions<T extends ClientContext> extends StandardLinkInterceptorOptions<T> {
|
28
|
+
request: StandardRequest;
|
17
29
|
}
|
18
30
|
interface StandardLinkOptions<T extends ClientContext> {
|
19
|
-
interceptors?: Interceptor<
|
20
|
-
|
21
|
-
input: unknown;
|
22
|
-
options: ClientOptions<T>;
|
23
|
-
}, unknown, unknown>[];
|
24
|
-
clientInterceptors?: Interceptor<{
|
25
|
-
request: StandardRequest;
|
26
|
-
}, StandardLazyResponse, unknown>[];
|
31
|
+
interceptors?: Interceptor<StandardLinkInterceptorOptions<T>, unknown, ThrowableError>[];
|
32
|
+
clientInterceptors?: Interceptor<StandardLinkClientInterceptorOptions<T>, StandardLazyResponse, ThrowableError>[];
|
27
33
|
plugins?: StandardLinkPlugin<T>[];
|
28
34
|
}
|
29
35
|
declare class StandardLink<T extends ClientContext> implements ClientLink<T> {
|
@@ -36,4 +42,5 @@ declare class StandardLink<T extends ClientContext> implements ClientLink<T> {
|
|
36
42
|
call(path: readonly string[], input: unknown, options: ClientOptions<T>): Promise<unknown>;
|
37
43
|
}
|
38
44
|
|
39
|
-
export {
|
45
|
+
export { CompositeStandardLinkPlugin as C, StandardLink as d };
|
46
|
+
export type { StandardLinkClientInterceptorOptions as S, StandardLinkPlugin as a, StandardLinkOptions as b, StandardLinkInterceptorOptions as c, StandardLinkCodec as e, StandardLinkClient as f };
|
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.d3571d4",
|
5
5
|
"license": "MIT",
|
6
6
|
"homepage": "https://orpc.unnoq.com",
|
7
7
|
"repository": {
|
@@ -33,15 +33,21 @@
|
|
33
33
|
"types": "./dist/adapters/fetch/index.d.mts",
|
34
34
|
"import": "./dist/adapters/fetch/index.mjs",
|
35
35
|
"default": "./dist/adapters/fetch/index.mjs"
|
36
|
+
},
|
37
|
+
"./websocket": {
|
38
|
+
"types": "./dist/adapters/websocket/index.d.mts",
|
39
|
+
"import": "./dist/adapters/websocket/index.mjs",
|
40
|
+
"default": "./dist/adapters/websocket/index.mjs"
|
36
41
|
}
|
37
42
|
},
|
38
43
|
"files": [
|
39
44
|
"dist"
|
40
45
|
],
|
41
46
|
"dependencies": {
|
42
|
-
"@orpc/shared": "0.0.0-next.
|
43
|
-
"@orpc/standard-server": "0.0.0-next.
|
44
|
-
"@orpc/standard-server-fetch": "0.0.0-next.
|
47
|
+
"@orpc/shared": "0.0.0-next.d3571d4",
|
48
|
+
"@orpc/standard-server": "0.0.0-next.d3571d4",
|
49
|
+
"@orpc/standard-server-fetch": "0.0.0-next.d3571d4",
|
50
|
+
"@orpc/standard-server-peer": "0.0.0-next.d3571d4"
|
45
51
|
},
|
46
52
|
"devDependencies": {
|
47
53
|
"zod": "^3.24.2"
|