@orpc/client 0.0.0-next.aac73c2 → 0.0.0-next.ab8d9e3
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 +17 -22
- package/dist/adapters/fetch/index.d.mts +12 -5
- package/dist/adapters/fetch/index.d.ts +12 -5
- package/dist/adapters/fetch/index.mjs +4 -7
- package/dist/adapters/message-port/index.d.mts +59 -0
- package/dist/adapters/message-port/index.d.ts +59 -0
- package/dist/adapters/message-port/index.mjs +71 -0
- package/dist/adapters/standard/index.d.mts +5 -4
- package/dist/adapters/standard/index.d.ts +5 -4
- 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 +44 -0
- package/dist/index.d.mts +29 -12
- package/dist/index.d.ts +29 -12
- package/dist/index.mjs +10 -10
- package/dist/plugins/index.d.mts +162 -21
- package/dist/plugins/index.d.ts +162 -21
- package/dist/plugins/index.mjs +306 -43
- package/dist/shared/{client.Bnaxb-CE.d.mts → client.4TS_0JaO.d.mts} +10 -11
- package/dist/shared/{client.Bnaxb-CE.d.ts → client.4TS_0JaO.d.ts} +10 -11
- package/dist/shared/{client.DczFzIj1.d.ts → client.7UM0t5o-.d.ts} +13 -25
- package/dist/shared/{client.D_TnaeH1.d.mts → client.BMoG_EdN.d.mts} +20 -13
- package/dist/shared/{client.jKEwIsRd.mjs → client.BX0_8bnM.mjs} +30 -33
- package/dist/shared/{client.DnHi1dp8.d.mts → client.BdD8cpjs.d.mts} +13 -25
- package/dist/shared/{client.BZZMKcrk.d.ts → client.C0KbSWlC.d.ts} +20 -13
- package/dist/shared/{client.D77bw0hs.mjs → client.CQCGVpTM.mjs} +38 -16
- package/package.json +16 -5
@@ -1,4 +1,4 @@
|
|
1
|
-
import { isObject, isTypescriptObject } from '@orpc/shared';
|
1
|
+
import { isObject, AsyncIteratorClass, isTypescriptObject } from '@orpc/shared';
|
2
2
|
import { getEventMeta, withEventMeta } from '@orpc/standard-server';
|
3
3
|
|
4
4
|
const COMMON_ORPC_ERROR_DEFS = {
|
@@ -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;
|
@@ -139,24 +123,35 @@ function toORPCError(error) {
|
|
139
123
|
function isORPCErrorStatus(status) {
|
140
124
|
return status < 200 || status >= 400;
|
141
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
|
+
}
|
142
142
|
|
143
143
|
function mapEventIterator(iterator, maps) {
|
144
|
-
return async
|
144
|
+
return new AsyncIteratorClass(async () => {
|
145
145
|
try {
|
146
|
-
|
147
|
-
|
148
|
-
|
149
|
-
|
150
|
-
|
151
|
-
|
152
|
-
mappedValue = withEventMeta(mappedValue, meta);
|
153
|
-
}
|
146
|
+
const { done, value } = await iterator.next();
|
147
|
+
let mappedValue = await maps.value(value, done);
|
148
|
+
if (mappedValue !== value) {
|
149
|
+
const meta = getEventMeta(value);
|
150
|
+
if (meta && isTypescriptObject(mappedValue)) {
|
151
|
+
mappedValue = withEventMeta(mappedValue, meta);
|
154
152
|
}
|
155
|
-
if (done) {
|
156
|
-
return mappedValue;
|
157
|
-
}
|
158
|
-
yield mappedValue;
|
159
153
|
}
|
154
|
+
return { done, value: mappedValue };
|
160
155
|
} catch (error) {
|
161
156
|
let mappedError = await maps.error(error);
|
162
157
|
if (mappedError !== error) {
|
@@ -166,10 +161,12 @@ function mapEventIterator(iterator, maps) {
|
|
166
161
|
}
|
167
162
|
}
|
168
163
|
throw mappedError;
|
169
|
-
}
|
164
|
+
}
|
165
|
+
}, async (reason) => {
|
166
|
+
if (reason !== "next") {
|
170
167
|
await iterator.return?.();
|
171
168
|
}
|
172
|
-
}
|
169
|
+
});
|
173
170
|
}
|
174
171
|
|
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 };
|
172
|
+
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 };
|
@@ -1,6 +1,6 @@
|
|
1
|
-
import { a as ClientContext, b as ClientOptions, d as HTTPMethod } from './client.
|
2
|
-
import {
|
3
|
-
import { Segment, Value } from '@orpc/shared';
|
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.BMoG_EdN.mjs';
|
3
|
+
import { Segment, Value, Promisable } from '@orpc/shared';
|
4
4
|
import { StandardHeaders, StandardRequest, StandardLazyResponse } from '@orpc/standard-server';
|
5
5
|
|
6
6
|
declare const STANDARD_RPC_JSON_SERIALIZER_BUILT_IN_TYPES: {
|
@@ -44,46 +44,30 @@ interface StandardRPCLinkCodecOptions<T extends ClientContext> {
|
|
44
44
|
/**
|
45
45
|
* Base url for all requests.
|
46
46
|
*/
|
47
|
-
url: Value<string | URL,
|
48
|
-
options: ClientOptions<T>,
|
49
|
-
path: readonly string[],
|
50
|
-
input: unknown
|
51
|
-
]>;
|
47
|
+
url: Value<Promisable<string | URL>, [options: ClientOptions<T>, path: readonly string[], input: unknown]>;
|
52
48
|
/**
|
53
49
|
* The maximum length of the URL.
|
54
50
|
*
|
55
51
|
* @default 2083
|
56
52
|
*/
|
57
|
-
maxUrlLength?: Value<number,
|
58
|
-
options: ClientOptions<T>,
|
59
|
-
path: readonly string[],
|
60
|
-
input: unknown
|
61
|
-
]>;
|
53
|
+
maxUrlLength?: Value<Promisable<number>, [options: ClientOptions<T>, path: readonly string[], input: unknown]>;
|
62
54
|
/**
|
63
55
|
* The method used to make the request.
|
64
56
|
*
|
65
57
|
* @default 'POST'
|
66
58
|
*/
|
67
|
-
method?: Value<HTTPMethod, [
|
68
|
-
options: ClientOptions<T>,
|
69
|
-
path: readonly string[],
|
70
|
-
input: unknown
|
71
|
-
]>;
|
59
|
+
method?: Value<Promisable<Exclude<HTTPMethod, 'HEAD'>>, [options: ClientOptions<T>, path: readonly string[], input: unknown]>;
|
72
60
|
/**
|
73
61
|
* The method to use when the payload cannot safely pass to the server with method return from method function.
|
74
62
|
* GET is not allowed, it's very dangerous.
|
75
63
|
*
|
76
64
|
* @default 'POST'
|
77
65
|
*/
|
78
|
-
fallbackMethod?: Exclude<HTTPMethod, 'GET'>;
|
66
|
+
fallbackMethod?: Exclude<HTTPMethod, 'HEAD' | 'GET'>;
|
79
67
|
/**
|
80
68
|
* Inject headers to the request.
|
81
69
|
*/
|
82
|
-
headers?: Value<StandardHeaders,
|
83
|
-
options: ClientOptions<T>,
|
84
|
-
path: readonly string[],
|
85
|
-
input: unknown
|
86
|
-
]>;
|
70
|
+
headers?: Value<Promisable<StandardHeaders>, [options: ClientOptions<T>, path: readonly string[], input: unknown]>;
|
87
71
|
}
|
88
72
|
declare class StandardRPCLinkCodec<T extends ClientContext> implements StandardLinkCodec<T> {
|
89
73
|
private readonly serializer;
|
@@ -99,5 +83,9 @@ declare class StandardRPCLinkCodec<T extends ClientContext> implements StandardL
|
|
99
83
|
|
100
84
|
interface StandardRPCLinkOptions<T extends ClientContext> extends StandardLinkOptions<T>, StandardRPCLinkCodecOptions<T>, StandardRPCJsonSerializerOptions {
|
101
85
|
}
|
86
|
+
declare class StandardRPCLink<T extends ClientContext> extends StandardLink<T> {
|
87
|
+
constructor(linkClient: StandardLinkClient<T>, options: StandardRPCLinkOptions<T>);
|
88
|
+
}
|
102
89
|
|
103
|
-
export { STANDARD_RPC_JSON_SERIALIZER_BUILT_IN_TYPES as S,
|
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,6 +1,16 @@
|
|
1
1
|
import { Interceptor } from '@orpc/shared';
|
2
2
|
import { StandardRequest, StandardLazyResponse } from '@orpc/standard-server';
|
3
|
-
import { a as ClientContext, b as ClientOptions, C as ClientLink } from './client.
|
3
|
+
import { a as ClientContext, b as ClientOptions, C as ClientLink } from './client.4TS_0JaO.js';
|
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>, Promise<unknown>>[];
|
32
|
+
clientInterceptors?: Interceptor<StandardLinkClientInterceptorOptions<T>, Promise<StandardLazyResponse>>[];
|
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 };
|
@@ -1,23 +1,32 @@
|
|
1
1
|
import { toArray, intercept, isObject, value, isAsyncIteratorObject, stringifyJSON } from '@orpc/shared';
|
2
2
|
import { mergeStandardHeaders, ErrorEvent } from '@orpc/standard-server';
|
3
|
-
import { b as isORPCErrorStatus, O as ORPCError, m as mapEventIterator, t as toORPCError } from './client.
|
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.BX0_8bnM.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;
|
@@ -183,6 +192,9 @@ class StandardRPCJsonSerializer {
|
|
183
192
|
function toHttpPath(path) {
|
184
193
|
return `/${path.map(encodeURIComponent).join("/")}`;
|
185
194
|
}
|
195
|
+
function getMalformedResponseErrorCode(status) {
|
196
|
+
return Object.entries(COMMON_ORPC_ERROR_DEFS).find(([, def]) => def.status === status)?.[0] ?? "MALFORMED_ORPC_ERROR_RESPONSE";
|
197
|
+
}
|
186
198
|
|
187
199
|
class StandardRPCLinkCodec {
|
188
200
|
constructor(serializer, options) {
|
@@ -202,7 +214,8 @@ class StandardRPCLinkCodec {
|
|
202
214
|
const expectedMethod = await value(this.expectedMethod, options, path, input);
|
203
215
|
let headers = await value(this.headers, options, path, input);
|
204
216
|
const baseUrl = await value(this.baseUrl, options, path, input);
|
205
|
-
const url = new URL(
|
217
|
+
const url = new URL(baseUrl);
|
218
|
+
url.pathname = `${url.pathname.replace(/\/$/, "")}${toHttpPath(path)}`;
|
206
219
|
if (options.lastEventId !== void 0) {
|
207
220
|
headers = mergeStandardHeaders(headers, { "last-event-id": options.lastEventId });
|
208
221
|
}
|
@@ -249,12 +262,12 @@ class StandardRPCLinkCodec {
|
|
249
262
|
}
|
250
263
|
})();
|
251
264
|
if (!isOk) {
|
252
|
-
if (
|
253
|
-
throw
|
265
|
+
if (isORPCErrorJson(deserialized)) {
|
266
|
+
throw createORPCErrorFromJson(deserialized);
|
254
267
|
}
|
255
|
-
throw new ORPCError(
|
268
|
+
throw new ORPCError(getMalformedResponseErrorCode(response.status), {
|
256
269
|
status: response.status,
|
257
|
-
data: deserialized
|
270
|
+
data: { ...response, body: deserialized }
|
258
271
|
});
|
259
272
|
}
|
260
273
|
return deserialized;
|
@@ -304,8 +317,8 @@ class StandardRPCSerializer {
|
|
304
317
|
return e;
|
305
318
|
}
|
306
319
|
const deserialized = this.#deserialize(e.data);
|
307
|
-
if (
|
308
|
-
return
|
320
|
+
if (isORPCErrorJson(deserialized)) {
|
321
|
+
return createORPCErrorFromJson(deserialized, { cause: e });
|
309
322
|
}
|
310
323
|
return new ErrorEvent({
|
311
324
|
data: deserialized,
|
@@ -330,4 +343,13 @@ class StandardRPCSerializer {
|
|
330
343
|
}
|
331
344
|
}
|
332
345
|
|
333
|
-
|
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 };
|
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.ab8d9e3",
|
5
5
|
"license": "MIT",
|
6
6
|
"homepage": "https://orpc.unnoq.com",
|
7
7
|
"repository": {
|
@@ -33,18 +33,29 @@
|
|
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"
|
41
|
+
},
|
42
|
+
"./message-port": {
|
43
|
+
"types": "./dist/adapters/message-port/index.d.mts",
|
44
|
+
"import": "./dist/adapters/message-port/index.mjs",
|
45
|
+
"default": "./dist/adapters/message-port/index.mjs"
|
36
46
|
}
|
37
47
|
},
|
38
48
|
"files": [
|
39
49
|
"dist"
|
40
50
|
],
|
41
51
|
"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.
|
52
|
+
"@orpc/shared": "0.0.0-next.ab8d9e3",
|
53
|
+
"@orpc/standard-server": "0.0.0-next.ab8d9e3",
|
54
|
+
"@orpc/standard-server-fetch": "0.0.0-next.ab8d9e3",
|
55
|
+
"@orpc/standard-server-peer": "0.0.0-next.ab8d9e3"
|
45
56
|
},
|
46
57
|
"devDependencies": {
|
47
|
-
"zod": "^3.
|
58
|
+
"zod": "^3.25.57"
|
48
59
|
},
|
49
60
|
"scripts": {
|
50
61
|
"build": "unbuild",
|