@orpc/client 0.0.0-next.ff68fdb → 0.0.0-next.ff7ad2e
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 +30 -22
- package/dist/adapters/fetch/index.d.mts +17 -13
- package/dist/adapters/fetch/index.d.ts +17 -13
- package/dist/adapters/fetch/index.mjs +6 -12
- 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 +8 -146
- package/dist/adapters/standard/index.d.ts +8 -146
- 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 +45 -0
- package/dist/index.d.mts +62 -32
- package/dist/index.d.ts +62 -32
- package/dist/index.mjs +55 -36
- package/dist/plugins/index.d.mts +202 -0
- package/dist/plugins/index.d.ts +202 -0
- package/dist/plugins/index.mjs +400 -0
- package/dist/shared/client.BG98rYdO.d.ts +45 -0
- package/dist/shared/client.BOYsZIRq.d.mts +29 -0
- package/dist/shared/client.BOYsZIRq.d.ts +29 -0
- package/dist/shared/client.Bwgm6dgk.d.mts +45 -0
- package/dist/shared/client.C176log5.d.ts +91 -0
- package/dist/shared/client.DKmRtVO2.mjs +390 -0
- package/dist/shared/client.Ycwr4Tuo.d.mts +91 -0
- package/dist/shared/client.txdq_i5V.mjs +180 -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.Df5pd75N.mjs +0 -320
- package/dist/shared/client.XAn8cDTM.mjs +0 -266
@@ -0,0 +1,390 @@
|
|
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, b as isORPCErrorStatus, c as isORPCErrorJson, d as createORPCErrorFromJson, O as ORPCError, m as mapEventIterator, t as toORPCError } from './client.txdq_i5V.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
|
+
}
|
16
|
+
|
17
|
+
class StandardLink {
|
18
|
+
constructor(codec, sender, options = {}) {
|
19
|
+
this.codec = codec;
|
20
|
+
this.sender = sender;
|
21
|
+
const plugin = new CompositeStandardLinkPlugin(options.plugins);
|
22
|
+
plugin.init(options);
|
23
|
+
this.interceptors = toArray(options.interceptors);
|
24
|
+
this.clientInterceptors = toArray(options.clientInterceptors);
|
25
|
+
}
|
26
|
+
interceptors;
|
27
|
+
clientInterceptors;
|
28
|
+
call(path, input, options) {
|
29
|
+
return runWithSpan(
|
30
|
+
{ name: `${ORPC_NAME}.${path.join("/")}`, signal: options.signal },
|
31
|
+
(span) => {
|
32
|
+
span?.setAttribute("rpc.system", ORPC_NAME);
|
33
|
+
span?.setAttribute("rpc.method", path.join("."));
|
34
|
+
if (isAsyncIteratorObject(input)) {
|
35
|
+
input = asyncIteratorWithSpan(
|
36
|
+
{ name: "consume_event_iterator_input", signal: options.signal },
|
37
|
+
input
|
38
|
+
);
|
39
|
+
}
|
40
|
+
return intercept(this.interceptors, { ...options, path, input }, async ({ path: path2, input: input2, ...options2 }) => {
|
41
|
+
const otelConfig = getGlobalOtelConfig();
|
42
|
+
let otelContext;
|
43
|
+
const currentSpan = otelConfig?.trace.getActiveSpan() ?? span;
|
44
|
+
if (currentSpan && otelConfig) {
|
45
|
+
otelContext = otelConfig?.trace.setSpan(otelConfig.context.active(), currentSpan);
|
46
|
+
}
|
47
|
+
const request = await runWithSpan(
|
48
|
+
{ name: "encode_request", context: otelContext },
|
49
|
+
() => this.codec.encode(path2, input2, options2)
|
50
|
+
);
|
51
|
+
const response = await intercept(
|
52
|
+
this.clientInterceptors,
|
53
|
+
{ ...options2, input: input2, path: path2, request },
|
54
|
+
({ input: input3, path: path3, request: request2, ...options3 }) => {
|
55
|
+
return runWithSpan(
|
56
|
+
{ name: "send_request", signal: options3.signal, context: otelContext },
|
57
|
+
() => this.sender.call(request2, options3, path3, input3)
|
58
|
+
);
|
59
|
+
}
|
60
|
+
);
|
61
|
+
const output = await runWithSpan(
|
62
|
+
{ name: "decode_response", context: otelContext },
|
63
|
+
() => this.codec.decode(response, options2, path2, input2)
|
64
|
+
);
|
65
|
+
if (isAsyncIteratorObject(output)) {
|
66
|
+
return asyncIteratorWithSpan(
|
67
|
+
{ name: "consume_event_iterator_output", signal: options2.signal },
|
68
|
+
output
|
69
|
+
);
|
70
|
+
}
|
71
|
+
return output;
|
72
|
+
});
|
73
|
+
}
|
74
|
+
);
|
75
|
+
}
|
76
|
+
}
|
77
|
+
|
78
|
+
const STANDARD_RPC_JSON_SERIALIZER_BUILT_IN_TYPES = {
|
79
|
+
BIGINT: 0,
|
80
|
+
DATE: 1,
|
81
|
+
NAN: 2,
|
82
|
+
UNDEFINED: 3,
|
83
|
+
URL: 4,
|
84
|
+
REGEXP: 5,
|
85
|
+
SET: 6,
|
86
|
+
MAP: 7
|
87
|
+
};
|
88
|
+
class StandardRPCJsonSerializer {
|
89
|
+
customSerializers;
|
90
|
+
constructor(options = {}) {
|
91
|
+
this.customSerializers = options.customJsonSerializers ?? [];
|
92
|
+
if (this.customSerializers.length !== new Set(this.customSerializers.map((custom) => custom.type)).size) {
|
93
|
+
throw new Error("Custom serializer type must be unique.");
|
94
|
+
}
|
95
|
+
}
|
96
|
+
serialize(data, segments = [], meta = [], maps = [], blobs = []) {
|
97
|
+
for (const custom of this.customSerializers) {
|
98
|
+
if (custom.condition(data)) {
|
99
|
+
const result = this.serialize(custom.serialize(data), segments, meta, maps, blobs);
|
100
|
+
meta.push([custom.type, ...segments]);
|
101
|
+
return result;
|
102
|
+
}
|
103
|
+
}
|
104
|
+
if (data instanceof Blob) {
|
105
|
+
maps.push(segments);
|
106
|
+
blobs.push(data);
|
107
|
+
return [data, meta, maps, blobs];
|
108
|
+
}
|
109
|
+
if (typeof data === "bigint") {
|
110
|
+
meta.push([STANDARD_RPC_JSON_SERIALIZER_BUILT_IN_TYPES.BIGINT, ...segments]);
|
111
|
+
return [data.toString(), meta, maps, blobs];
|
112
|
+
}
|
113
|
+
if (data instanceof Date) {
|
114
|
+
meta.push([STANDARD_RPC_JSON_SERIALIZER_BUILT_IN_TYPES.DATE, ...segments]);
|
115
|
+
if (Number.isNaN(data.getTime())) {
|
116
|
+
return [null, meta, maps, blobs];
|
117
|
+
}
|
118
|
+
return [data.toISOString(), meta, maps, blobs];
|
119
|
+
}
|
120
|
+
if (Number.isNaN(data)) {
|
121
|
+
meta.push([STANDARD_RPC_JSON_SERIALIZER_BUILT_IN_TYPES.NAN, ...segments]);
|
122
|
+
return [null, meta, maps, blobs];
|
123
|
+
}
|
124
|
+
if (data instanceof URL) {
|
125
|
+
meta.push([STANDARD_RPC_JSON_SERIALIZER_BUILT_IN_TYPES.URL, ...segments]);
|
126
|
+
return [data.toString(), meta, maps, blobs];
|
127
|
+
}
|
128
|
+
if (data instanceof RegExp) {
|
129
|
+
meta.push([STANDARD_RPC_JSON_SERIALIZER_BUILT_IN_TYPES.REGEXP, ...segments]);
|
130
|
+
return [data.toString(), meta, maps, blobs];
|
131
|
+
}
|
132
|
+
if (data instanceof Set) {
|
133
|
+
const result = this.serialize(Array.from(data), segments, meta, maps, blobs);
|
134
|
+
meta.push([STANDARD_RPC_JSON_SERIALIZER_BUILT_IN_TYPES.SET, ...segments]);
|
135
|
+
return result;
|
136
|
+
}
|
137
|
+
if (data instanceof Map) {
|
138
|
+
const result = this.serialize(Array.from(data.entries()), segments, meta, maps, blobs);
|
139
|
+
meta.push([STANDARD_RPC_JSON_SERIALIZER_BUILT_IN_TYPES.MAP, ...segments]);
|
140
|
+
return result;
|
141
|
+
}
|
142
|
+
if (Array.isArray(data)) {
|
143
|
+
const json = data.map((v, i) => {
|
144
|
+
if (v === void 0) {
|
145
|
+
meta.push([STANDARD_RPC_JSON_SERIALIZER_BUILT_IN_TYPES.UNDEFINED, ...segments, i]);
|
146
|
+
return v;
|
147
|
+
}
|
148
|
+
return this.serialize(v, [...segments, i], meta, maps, blobs)[0];
|
149
|
+
});
|
150
|
+
return [json, meta, maps, blobs];
|
151
|
+
}
|
152
|
+
if (isObject(data)) {
|
153
|
+
const json = {};
|
154
|
+
for (const k in data) {
|
155
|
+
if (k === "toJSON" && typeof data[k] === "function") {
|
156
|
+
continue;
|
157
|
+
}
|
158
|
+
json[k] = this.serialize(data[k], [...segments, k], meta, maps, blobs)[0];
|
159
|
+
}
|
160
|
+
return [json, meta, maps, blobs];
|
161
|
+
}
|
162
|
+
return [data, meta, maps, blobs];
|
163
|
+
}
|
164
|
+
deserialize(json, meta, maps, getBlob) {
|
165
|
+
const ref = { data: json };
|
166
|
+
if (maps && getBlob) {
|
167
|
+
maps.forEach((segments, i) => {
|
168
|
+
let currentRef = ref;
|
169
|
+
let preSegment = "data";
|
170
|
+
segments.forEach((segment) => {
|
171
|
+
currentRef = currentRef[preSegment];
|
172
|
+
preSegment = segment;
|
173
|
+
});
|
174
|
+
currentRef[preSegment] = getBlob(i);
|
175
|
+
});
|
176
|
+
}
|
177
|
+
for (const item of meta) {
|
178
|
+
const type = item[0];
|
179
|
+
let currentRef = ref;
|
180
|
+
let preSegment = "data";
|
181
|
+
for (let i = 1; i < item.length; i++) {
|
182
|
+
currentRef = currentRef[preSegment];
|
183
|
+
preSegment = item[i];
|
184
|
+
}
|
185
|
+
for (const custom of this.customSerializers) {
|
186
|
+
if (custom.type === type) {
|
187
|
+
currentRef[preSegment] = custom.deserialize(currentRef[preSegment]);
|
188
|
+
break;
|
189
|
+
}
|
190
|
+
}
|
191
|
+
switch (type) {
|
192
|
+
case STANDARD_RPC_JSON_SERIALIZER_BUILT_IN_TYPES.BIGINT:
|
193
|
+
currentRef[preSegment] = BigInt(currentRef[preSegment]);
|
194
|
+
break;
|
195
|
+
case STANDARD_RPC_JSON_SERIALIZER_BUILT_IN_TYPES.DATE:
|
196
|
+
currentRef[preSegment] = new Date(currentRef[preSegment] ?? "Invalid Date");
|
197
|
+
break;
|
198
|
+
case STANDARD_RPC_JSON_SERIALIZER_BUILT_IN_TYPES.NAN:
|
199
|
+
currentRef[preSegment] = Number.NaN;
|
200
|
+
break;
|
201
|
+
case STANDARD_RPC_JSON_SERIALIZER_BUILT_IN_TYPES.UNDEFINED:
|
202
|
+
currentRef[preSegment] = void 0;
|
203
|
+
break;
|
204
|
+
case STANDARD_RPC_JSON_SERIALIZER_BUILT_IN_TYPES.URL:
|
205
|
+
currentRef[preSegment] = new URL(currentRef[preSegment]);
|
206
|
+
break;
|
207
|
+
case STANDARD_RPC_JSON_SERIALIZER_BUILT_IN_TYPES.REGEXP: {
|
208
|
+
const [, pattern, flags] = currentRef[preSegment].match(/^\/(.*)\/([a-z]*)$/);
|
209
|
+
currentRef[preSegment] = new RegExp(pattern, flags);
|
210
|
+
break;
|
211
|
+
}
|
212
|
+
case STANDARD_RPC_JSON_SERIALIZER_BUILT_IN_TYPES.SET:
|
213
|
+
currentRef[preSegment] = new Set(currentRef[preSegment]);
|
214
|
+
break;
|
215
|
+
case STANDARD_RPC_JSON_SERIALIZER_BUILT_IN_TYPES.MAP:
|
216
|
+
currentRef[preSegment] = new Map(currentRef[preSegment]);
|
217
|
+
break;
|
218
|
+
}
|
219
|
+
}
|
220
|
+
return ref.data;
|
221
|
+
}
|
222
|
+
}
|
223
|
+
|
224
|
+
function toHttpPath(path) {
|
225
|
+
return `/${path.map(encodeURIComponent).join("/")}`;
|
226
|
+
}
|
227
|
+
function getMalformedResponseErrorCode(status) {
|
228
|
+
return Object.entries(COMMON_ORPC_ERROR_DEFS).find(([, def]) => def.status === status)?.[0] ?? "MALFORMED_ORPC_ERROR_RESPONSE";
|
229
|
+
}
|
230
|
+
|
231
|
+
class StandardRPCLinkCodec {
|
232
|
+
constructor(serializer, options) {
|
233
|
+
this.serializer = serializer;
|
234
|
+
this.baseUrl = options.url;
|
235
|
+
this.maxUrlLength = options.maxUrlLength ?? 2083;
|
236
|
+
this.fallbackMethod = options.fallbackMethod ?? "POST";
|
237
|
+
this.expectedMethod = options.method ?? this.fallbackMethod;
|
238
|
+
this.headers = options.headers ?? {};
|
239
|
+
}
|
240
|
+
baseUrl;
|
241
|
+
maxUrlLength;
|
242
|
+
fallbackMethod;
|
243
|
+
expectedMethod;
|
244
|
+
headers;
|
245
|
+
async encode(path, input, options) {
|
246
|
+
const expectedMethod = await value(this.expectedMethod, options, path, input);
|
247
|
+
let headers = await value(this.headers, options, path, input);
|
248
|
+
const baseUrl = await value(this.baseUrl, options, path, input);
|
249
|
+
const url = new URL(baseUrl);
|
250
|
+
url.pathname = `${url.pathname.replace(/\/$/, "")}${toHttpPath(path)}`;
|
251
|
+
if (options.lastEventId !== void 0) {
|
252
|
+
headers = mergeStandardHeaders(headers, { "last-event-id": options.lastEventId });
|
253
|
+
}
|
254
|
+
const serialized = this.serializer.serialize(input);
|
255
|
+
if (expectedMethod === "GET" && !(serialized instanceof FormData) && !isAsyncIteratorObject(serialized)) {
|
256
|
+
const maxUrlLength = await value(this.maxUrlLength, options, path, input);
|
257
|
+
const getUrl = new URL(url);
|
258
|
+
getUrl.searchParams.append("data", stringifyJSON(serialized));
|
259
|
+
if (getUrl.toString().length <= maxUrlLength) {
|
260
|
+
return {
|
261
|
+
body: void 0,
|
262
|
+
method: expectedMethod,
|
263
|
+
headers,
|
264
|
+
url: getUrl,
|
265
|
+
signal: options.signal
|
266
|
+
};
|
267
|
+
}
|
268
|
+
}
|
269
|
+
return {
|
270
|
+
url,
|
271
|
+
method: expectedMethod === "GET" ? this.fallbackMethod : expectedMethod,
|
272
|
+
headers,
|
273
|
+
body: serialized,
|
274
|
+
signal: options.signal
|
275
|
+
};
|
276
|
+
}
|
277
|
+
async decode(response) {
|
278
|
+
const isOk = !isORPCErrorStatus(response.status);
|
279
|
+
const deserialized = await (async () => {
|
280
|
+
let isBodyOk = false;
|
281
|
+
try {
|
282
|
+
const body = await response.body();
|
283
|
+
isBodyOk = true;
|
284
|
+
return this.serializer.deserialize(body);
|
285
|
+
} catch (error) {
|
286
|
+
if (!isBodyOk) {
|
287
|
+
throw new Error("Cannot parse response body, please check the response body and content-type.", {
|
288
|
+
cause: error
|
289
|
+
});
|
290
|
+
}
|
291
|
+
throw new Error("Invalid RPC response format.", {
|
292
|
+
cause: error
|
293
|
+
});
|
294
|
+
}
|
295
|
+
})();
|
296
|
+
if (!isOk) {
|
297
|
+
if (isORPCErrorJson(deserialized)) {
|
298
|
+
throw createORPCErrorFromJson(deserialized);
|
299
|
+
}
|
300
|
+
throw new ORPCError(getMalformedResponseErrorCode(response.status), {
|
301
|
+
status: response.status,
|
302
|
+
data: { ...response, body: deserialized }
|
303
|
+
});
|
304
|
+
}
|
305
|
+
return deserialized;
|
306
|
+
}
|
307
|
+
}
|
308
|
+
|
309
|
+
class StandardRPCSerializer {
|
310
|
+
constructor(jsonSerializer) {
|
311
|
+
this.jsonSerializer = jsonSerializer;
|
312
|
+
}
|
313
|
+
serialize(data) {
|
314
|
+
if (isAsyncIteratorObject(data)) {
|
315
|
+
return mapEventIterator(data, {
|
316
|
+
value: async (value) => this.#serialize(value, false),
|
317
|
+
error: async (e) => {
|
318
|
+
return new ErrorEvent({
|
319
|
+
data: this.#serialize(toORPCError(e).toJSON(), false),
|
320
|
+
cause: e
|
321
|
+
});
|
322
|
+
}
|
323
|
+
});
|
324
|
+
}
|
325
|
+
return this.#serialize(data, true);
|
326
|
+
}
|
327
|
+
#serialize(data, enableFormData) {
|
328
|
+
const [json, meta_, maps, blobs] = this.jsonSerializer.serialize(data);
|
329
|
+
const meta = meta_.length === 0 ? void 0 : meta_;
|
330
|
+
if (!enableFormData || blobs.length === 0) {
|
331
|
+
return {
|
332
|
+
json,
|
333
|
+
meta
|
334
|
+
};
|
335
|
+
}
|
336
|
+
const form = new FormData();
|
337
|
+
form.set("data", stringifyJSON({ json, meta, maps }));
|
338
|
+
blobs.forEach((blob, i) => {
|
339
|
+
form.set(i.toString(), blob);
|
340
|
+
});
|
341
|
+
return form;
|
342
|
+
}
|
343
|
+
deserialize(data) {
|
344
|
+
if (isAsyncIteratorObject(data)) {
|
345
|
+
return mapEventIterator(data, {
|
346
|
+
value: async (value) => this.#deserialize(value),
|
347
|
+
error: async (e) => {
|
348
|
+
if (!(e instanceof ErrorEvent)) {
|
349
|
+
return e;
|
350
|
+
}
|
351
|
+
const deserialized = this.#deserialize(e.data);
|
352
|
+
if (isORPCErrorJson(deserialized)) {
|
353
|
+
return createORPCErrorFromJson(deserialized, { cause: e });
|
354
|
+
}
|
355
|
+
return new ErrorEvent({
|
356
|
+
data: deserialized,
|
357
|
+
cause: e
|
358
|
+
});
|
359
|
+
}
|
360
|
+
});
|
361
|
+
}
|
362
|
+
return this.#deserialize(data);
|
363
|
+
}
|
364
|
+
#deserialize(data) {
|
365
|
+
if (data === void 0) {
|
366
|
+
return void 0;
|
367
|
+
}
|
368
|
+
if (!(data instanceof FormData)) {
|
369
|
+
return this.jsonSerializer.deserialize(data.json, data.meta ?? []);
|
370
|
+
}
|
371
|
+
const serialized = JSON.parse(data.get("data"));
|
372
|
+
return this.jsonSerializer.deserialize(
|
373
|
+
serialized.json,
|
374
|
+
serialized.meta ?? [],
|
375
|
+
serialized.maps,
|
376
|
+
(i) => data.get(i.toString())
|
377
|
+
);
|
378
|
+
}
|
379
|
+
}
|
380
|
+
|
381
|
+
class StandardRPCLink extends StandardLink {
|
382
|
+
constructor(linkClient, options) {
|
383
|
+
const jsonSerializer = new StandardRPCJsonSerializer(options);
|
384
|
+
const serializer = new StandardRPCSerializer(jsonSerializer);
|
385
|
+
const linkCodec = new StandardRPCLinkCodec(serializer, options);
|
386
|
+
super(linkCodec, linkClient, options);
|
387
|
+
}
|
388
|
+
}
|
389
|
+
|
390
|
+
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 };
|
@@ -0,0 +1,91 @@
|
|
1
|
+
import { b as ClientContext, c as ClientOptions, f as HTTPMethod } from './client.BOYsZIRq.mjs';
|
2
|
+
import { e as StandardLinkCodec, b as StandardLinkOptions, d as StandardLink, f as StandardLinkClient } from './client.Bwgm6dgk.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>, [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,180 @@
|
|
1
|
+
import { resolveMaybeOptionalOptions, isObject, AsyncIteratorClass, isTypescriptObject } from '@orpc/shared';
|
2
|
+
import { getEventMeta, withEventMeta } from '@orpc/standard-server';
|
3
|
+
|
4
|
+
const COMMON_ORPC_ERROR_DEFS = {
|
5
|
+
BAD_REQUEST: {
|
6
|
+
status: 400,
|
7
|
+
message: "Bad Request"
|
8
|
+
},
|
9
|
+
UNAUTHORIZED: {
|
10
|
+
status: 401,
|
11
|
+
message: "Unauthorized"
|
12
|
+
},
|
13
|
+
FORBIDDEN: {
|
14
|
+
status: 403,
|
15
|
+
message: "Forbidden"
|
16
|
+
},
|
17
|
+
NOT_FOUND: {
|
18
|
+
status: 404,
|
19
|
+
message: "Not Found"
|
20
|
+
},
|
21
|
+
METHOD_NOT_SUPPORTED: {
|
22
|
+
status: 405,
|
23
|
+
message: "Method Not Supported"
|
24
|
+
},
|
25
|
+
NOT_ACCEPTABLE: {
|
26
|
+
status: 406,
|
27
|
+
message: "Not Acceptable"
|
28
|
+
},
|
29
|
+
TIMEOUT: {
|
30
|
+
status: 408,
|
31
|
+
message: "Request Timeout"
|
32
|
+
},
|
33
|
+
CONFLICT: {
|
34
|
+
status: 409,
|
35
|
+
message: "Conflict"
|
36
|
+
},
|
37
|
+
PRECONDITION_FAILED: {
|
38
|
+
status: 412,
|
39
|
+
message: "Precondition Failed"
|
40
|
+
},
|
41
|
+
PAYLOAD_TOO_LARGE: {
|
42
|
+
status: 413,
|
43
|
+
message: "Payload Too Large"
|
44
|
+
},
|
45
|
+
UNSUPPORTED_MEDIA_TYPE: {
|
46
|
+
status: 415,
|
47
|
+
message: "Unsupported Media Type"
|
48
|
+
},
|
49
|
+
UNPROCESSABLE_CONTENT: {
|
50
|
+
status: 422,
|
51
|
+
message: "Unprocessable Content"
|
52
|
+
},
|
53
|
+
TOO_MANY_REQUESTS: {
|
54
|
+
status: 429,
|
55
|
+
message: "Too Many Requests"
|
56
|
+
},
|
57
|
+
CLIENT_CLOSED_REQUEST: {
|
58
|
+
status: 499,
|
59
|
+
message: "Client Closed Request"
|
60
|
+
},
|
61
|
+
INTERNAL_SERVER_ERROR: {
|
62
|
+
status: 500,
|
63
|
+
message: "Internal Server Error"
|
64
|
+
},
|
65
|
+
NOT_IMPLEMENTED: {
|
66
|
+
status: 501,
|
67
|
+
message: "Not Implemented"
|
68
|
+
},
|
69
|
+
BAD_GATEWAY: {
|
70
|
+
status: 502,
|
71
|
+
message: "Bad Gateway"
|
72
|
+
},
|
73
|
+
SERVICE_UNAVAILABLE: {
|
74
|
+
status: 503,
|
75
|
+
message: "Service Unavailable"
|
76
|
+
},
|
77
|
+
GATEWAY_TIMEOUT: {
|
78
|
+
status: 504,
|
79
|
+
message: "Gateway Timeout"
|
80
|
+
}
|
81
|
+
};
|
82
|
+
function fallbackORPCErrorStatus(code, status) {
|
83
|
+
return status ?? COMMON_ORPC_ERROR_DEFS[code]?.status ?? 500;
|
84
|
+
}
|
85
|
+
function fallbackORPCErrorMessage(code, message) {
|
86
|
+
return message || COMMON_ORPC_ERROR_DEFS[code]?.message || code;
|
87
|
+
}
|
88
|
+
class ORPCError extends Error {
|
89
|
+
defined;
|
90
|
+
code;
|
91
|
+
status;
|
92
|
+
data;
|
93
|
+
constructor(code, ...rest) {
|
94
|
+
const options = resolveMaybeOptionalOptions(rest);
|
95
|
+
if (options.status !== void 0 && !isORPCErrorStatus(options.status)) {
|
96
|
+
throw new Error("[ORPCError] Invalid error status code.");
|
97
|
+
}
|
98
|
+
const message = fallbackORPCErrorMessage(code, options.message);
|
99
|
+
super(message, options);
|
100
|
+
this.code = code;
|
101
|
+
this.status = fallbackORPCErrorStatus(code, options.status);
|
102
|
+
this.defined = options.defined ?? false;
|
103
|
+
this.data = options.data;
|
104
|
+
}
|
105
|
+
toJSON() {
|
106
|
+
return {
|
107
|
+
defined: this.defined,
|
108
|
+
code: this.code,
|
109
|
+
status: this.status,
|
110
|
+
message: this.message,
|
111
|
+
data: this.data
|
112
|
+
};
|
113
|
+
}
|
114
|
+
}
|
115
|
+
function isDefinedError(error) {
|
116
|
+
return error instanceof ORPCError && error.defined;
|
117
|
+
}
|
118
|
+
function toORPCError(error) {
|
119
|
+
return error instanceof ORPCError ? error : new ORPCError("INTERNAL_SERVER_ERROR", {
|
120
|
+
message: "Internal server error",
|
121
|
+
cause: error
|
122
|
+
});
|
123
|
+
}
|
124
|
+
function isORPCErrorStatus(status) {
|
125
|
+
return status < 200 || status >= 400;
|
126
|
+
}
|
127
|
+
function isORPCErrorJson(json) {
|
128
|
+
if (!isObject(json)) {
|
129
|
+
return false;
|
130
|
+
}
|
131
|
+
const validKeys = ["defined", "code", "status", "message", "data"];
|
132
|
+
if (Object.keys(json).some((k) => !validKeys.includes(k))) {
|
133
|
+
return false;
|
134
|
+
}
|
135
|
+
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";
|
136
|
+
}
|
137
|
+
function createORPCErrorFromJson(json, options = {}) {
|
138
|
+
return new ORPCError(json.code, {
|
139
|
+
...options,
|
140
|
+
...json
|
141
|
+
});
|
142
|
+
}
|
143
|
+
|
144
|
+
function mapEventIterator(iterator, maps) {
|
145
|
+
const mapError = async (error) => {
|
146
|
+
let mappedError = await maps.error(error);
|
147
|
+
if (mappedError !== error) {
|
148
|
+
const meta = getEventMeta(error);
|
149
|
+
if (meta && isTypescriptObject(mappedError)) {
|
150
|
+
mappedError = withEventMeta(mappedError, meta);
|
151
|
+
}
|
152
|
+
}
|
153
|
+
return mappedError;
|
154
|
+
};
|
155
|
+
return new AsyncIteratorClass(async () => {
|
156
|
+
const { done, value } = await (async () => {
|
157
|
+
try {
|
158
|
+
return await iterator.next();
|
159
|
+
} catch (error) {
|
160
|
+
throw await mapError(error);
|
161
|
+
}
|
162
|
+
})();
|
163
|
+
let mappedValue = await maps.value(value, done);
|
164
|
+
if (mappedValue !== value) {
|
165
|
+
const meta = getEventMeta(value);
|
166
|
+
if (meta && isTypescriptObject(mappedValue)) {
|
167
|
+
mappedValue = withEventMeta(mappedValue, meta);
|
168
|
+
}
|
169
|
+
}
|
170
|
+
return { done, value: mappedValue };
|
171
|
+
}, async () => {
|
172
|
+
try {
|
173
|
+
await iterator.return?.();
|
174
|
+
} catch (error) {
|
175
|
+
throw await mapError(error);
|
176
|
+
}
|
177
|
+
});
|
178
|
+
}
|
179
|
+
|
180
|
+
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 };
|