@orpc/client 0.0.0-next.232b708 → 0.0.0-next.24085bc
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 +26 -22
- package/dist/adapters/fetch/index.d.mts +16 -12
- package/dist/adapters/fetch/index.d.ts +16 -12
- package/dist/adapters/fetch/index.mjs +5 -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 -167
- package/dist/adapters/standard/index.d.ts +8 -167
- 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 +61 -32
- package/dist/index.d.ts +61 -32
- package/dist/index.mjs +54 -35
- package/dist/plugins/index.d.mts +202 -0
- package/dist/plugins/index.d.ts +202 -0
- package/dist/plugins/index.mjs +389 -0
- package/dist/shared/client.BOYsZIRq.d.mts +29 -0
- package/dist/shared/client.BOYsZIRq.d.ts +29 -0
- package/dist/shared/client.C4VxIexA.d.mts +46 -0
- package/dist/shared/client.CXXEPIbK.d.ts +46 -0
- package/dist/shared/client.DHOfWE0c.mjs +172 -0
- package/dist/shared/{client.CcWl0MKf.mjs → client.DwfV9Oyl.mjs} +57 -62
- package/dist/shared/client.WCinBImJ.d.ts +91 -0
- package/dist/shared/client.aTp4sII-.d.mts +91 -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,172 @@
|
|
|
1
|
+
import { 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, ...[options]) {
|
|
94
|
+
if (options?.status && !isORPCErrorStatus(options.status)) {
|
|
95
|
+
throw new Error("[ORPCError] Invalid error status code.");
|
|
96
|
+
}
|
|
97
|
+
const message = fallbackORPCErrorMessage(code, options?.message);
|
|
98
|
+
super(message, options);
|
|
99
|
+
this.code = code;
|
|
100
|
+
this.status = fallbackORPCErrorStatus(code, options?.status);
|
|
101
|
+
this.defined = options?.defined ?? false;
|
|
102
|
+
this.data = options?.data;
|
|
103
|
+
}
|
|
104
|
+
toJSON() {
|
|
105
|
+
return {
|
|
106
|
+
defined: this.defined,
|
|
107
|
+
code: this.code,
|
|
108
|
+
status: this.status,
|
|
109
|
+
message: this.message,
|
|
110
|
+
data: this.data
|
|
111
|
+
};
|
|
112
|
+
}
|
|
113
|
+
}
|
|
114
|
+
function isDefinedError(error) {
|
|
115
|
+
return error instanceof ORPCError && error.defined;
|
|
116
|
+
}
|
|
117
|
+
function toORPCError(error) {
|
|
118
|
+
return error instanceof ORPCError ? error : new ORPCError("INTERNAL_SERVER_ERROR", {
|
|
119
|
+
message: "Internal server error",
|
|
120
|
+
cause: error
|
|
121
|
+
});
|
|
122
|
+
}
|
|
123
|
+
function isORPCErrorStatus(status) {
|
|
124
|
+
return status < 200 || status >= 400;
|
|
125
|
+
}
|
|
126
|
+
function isORPCErrorJson(json) {
|
|
127
|
+
if (!isObject(json)) {
|
|
128
|
+
return false;
|
|
129
|
+
}
|
|
130
|
+
const validKeys = ["defined", "code", "status", "message", "data"];
|
|
131
|
+
if (Object.keys(json).some((k) => !validKeys.includes(k))) {
|
|
132
|
+
return false;
|
|
133
|
+
}
|
|
134
|
+
return "defined" in json && typeof json.defined === "boolean" && "code" in json && typeof json.code === "string" && "status" in json && typeof json.status === "number" && isORPCErrorStatus(json.status) && "message" in json && typeof json.message === "string";
|
|
135
|
+
}
|
|
136
|
+
function createORPCErrorFromJson(json, options = {}) {
|
|
137
|
+
return new ORPCError(json.code, {
|
|
138
|
+
...options,
|
|
139
|
+
...json
|
|
140
|
+
});
|
|
141
|
+
}
|
|
142
|
+
|
|
143
|
+
function mapEventIterator(iterator, maps) {
|
|
144
|
+
return new AsyncIteratorClass(async () => {
|
|
145
|
+
const { done, value } = await (async () => {
|
|
146
|
+
try {
|
|
147
|
+
return await iterator.next();
|
|
148
|
+
} catch (error) {
|
|
149
|
+
let mappedError = await maps.error(error);
|
|
150
|
+
if (mappedError !== error) {
|
|
151
|
+
const meta = getEventMeta(error);
|
|
152
|
+
if (meta && isTypescriptObject(mappedError)) {
|
|
153
|
+
mappedError = withEventMeta(mappedError, meta);
|
|
154
|
+
}
|
|
155
|
+
}
|
|
156
|
+
throw mappedError;
|
|
157
|
+
}
|
|
158
|
+
})();
|
|
159
|
+
let mappedValue = await maps.value(value, done);
|
|
160
|
+
if (mappedValue !== value) {
|
|
161
|
+
const meta = getEventMeta(value);
|
|
162
|
+
if (meta && isTypescriptObject(mappedValue)) {
|
|
163
|
+
mappedValue = withEventMeta(mappedValue, meta);
|
|
164
|
+
}
|
|
165
|
+
}
|
|
166
|
+
return { done, value: mappedValue };
|
|
167
|
+
}, async () => {
|
|
168
|
+
await iterator.return?.();
|
|
169
|
+
});
|
|
170
|
+
}
|
|
171
|
+
|
|
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,56 +1,42 @@
|
|
|
1
|
-
import { intercept,
|
|
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.DHOfWE0c.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
|
-
constructor(codec, sender, options) {
|
|
18
|
+
constructor(codec, sender, options = {}) {
|
|
9
19
|
this.codec = codec;
|
|
10
20
|
this.sender = sender;
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
this.
|
|
14
|
-
this.
|
|
15
|
-
this.clientInterceptors = options.clientInterceptors ?? [];
|
|
21
|
+
const plugin = new CompositeStandardLinkPlugin(options.plugins);
|
|
22
|
+
plugin.init(options);
|
|
23
|
+
this.interceptors = toArray(options.interceptors);
|
|
24
|
+
this.clientInterceptors = toArray(options.clientInterceptors);
|
|
16
25
|
}
|
|
17
|
-
eventIteratorMaxRetries;
|
|
18
|
-
eventIteratorRetryDelay;
|
|
19
|
-
eventIteratorShouldRetry;
|
|
20
26
|
interceptors;
|
|
21
27
|
clientInterceptors;
|
|
22
28
|
call(path, input, options) {
|
|
23
|
-
return intercept(this.interceptors, { path, input
|
|
29
|
+
return intercept(this.interceptors, { ...options, path, input }, async ({ path: path2, input: input2, ...options2 }) => {
|
|
24
30
|
const output = await this.#call(path2, input2, options2);
|
|
25
|
-
|
|
26
|
-
return output;
|
|
27
|
-
}
|
|
28
|
-
return createAutoRetryEventIterator(output, async (reconnectOptions) => {
|
|
29
|
-
const maxRetries = await value(this.eventIteratorMaxRetries, reconnectOptions, options2, path2, input2);
|
|
30
|
-
if (options2.signal?.aborted || reconnectOptions.retryTimes > maxRetries) {
|
|
31
|
-
return null;
|
|
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");
|
|
43
|
-
}
|
|
44
|
-
return maybeIterator;
|
|
45
|
-
}, options2.lastEventId);
|
|
31
|
+
return output;
|
|
46
32
|
});
|
|
47
33
|
}
|
|
48
34
|
async #call(path, input, options) {
|
|
49
35
|
const request = await this.codec.encode(path, input, options);
|
|
50
36
|
const response = await intercept(
|
|
51
37
|
this.clientInterceptors,
|
|
52
|
-
{ request },
|
|
53
|
-
({ 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)
|
|
54
40
|
);
|
|
55
41
|
const output = await this.codec.decode(response, options, path, input);
|
|
56
42
|
return output;
|
|
@@ -134,6 +120,9 @@ class StandardRPCJsonSerializer {
|
|
|
134
120
|
if (isObject(data)) {
|
|
135
121
|
const json = {};
|
|
136
122
|
for (const k in data) {
|
|
123
|
+
if (k === "toJSON" && typeof data[k] === "function") {
|
|
124
|
+
continue;
|
|
125
|
+
}
|
|
137
126
|
json[k] = this.serialize(data[k], [...segments, k], meta, maps, blobs)[0];
|
|
138
127
|
}
|
|
139
128
|
return [json, meta, maps, blobs];
|
|
@@ -200,6 +189,13 @@ class StandardRPCJsonSerializer {
|
|
|
200
189
|
}
|
|
201
190
|
}
|
|
202
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
|
+
|
|
203
199
|
class StandardRPCLinkCodec {
|
|
204
200
|
constructor(serializer, options) {
|
|
205
201
|
this.serializer = serializer;
|
|
@@ -216,23 +212,18 @@ class StandardRPCLinkCodec {
|
|
|
216
212
|
headers;
|
|
217
213
|
async encode(path, input, options) {
|
|
218
214
|
const expectedMethod = await value(this.expectedMethod, options, path, input);
|
|
219
|
-
|
|
215
|
+
let headers = await value(this.headers, options, path, input);
|
|
220
216
|
const baseUrl = await value(this.baseUrl, options, path, input);
|
|
221
|
-
const url = new URL(
|
|
217
|
+
const url = new URL(baseUrl);
|
|
218
|
+
url.pathname = `${url.pathname.replace(/\/$/, "")}${toHttpPath(path)}`;
|
|
222
219
|
if (options.lastEventId !== void 0) {
|
|
223
|
-
|
|
224
|
-
headers["last-event-id"] = [...headers["last-event-id"], options.lastEventId];
|
|
225
|
-
} else if (headers["last-event-id"] !== void 0) {
|
|
226
|
-
headers["last-event-id"] = [headers["last-event-id"], options.lastEventId];
|
|
227
|
-
} else {
|
|
228
|
-
headers["last-event-id"] = options.lastEventId;
|
|
229
|
-
}
|
|
220
|
+
headers = mergeStandardHeaders(headers, { "last-event-id": options.lastEventId });
|
|
230
221
|
}
|
|
231
222
|
const serialized = this.serializer.serialize(input);
|
|
232
|
-
if (expectedMethod === "GET" && !(serialized instanceof FormData) && !
|
|
223
|
+
if (expectedMethod === "GET" && !(serialized instanceof FormData) && !isAsyncIteratorObject(serialized)) {
|
|
233
224
|
const maxUrlLength = await value(this.maxUrlLength, options, path, input);
|
|
234
225
|
const getUrl = new URL(url);
|
|
235
|
-
getUrl.searchParams.append("data", stringifyJSON(serialized)
|
|
226
|
+
getUrl.searchParams.append("data", stringifyJSON(serialized));
|
|
236
227
|
if (getUrl.toString().length <= maxUrlLength) {
|
|
237
228
|
return {
|
|
238
229
|
body: void 0,
|
|
@@ -252,7 +243,7 @@ class StandardRPCLinkCodec {
|
|
|
252
243
|
};
|
|
253
244
|
}
|
|
254
245
|
async decode(response) {
|
|
255
|
-
const isOk = response.status
|
|
246
|
+
const isOk = !isORPCErrorStatus(response.status);
|
|
256
247
|
const deserialized = await (async () => {
|
|
257
248
|
let isBodyOk = false;
|
|
258
249
|
try {
|
|
@@ -271,11 +262,12 @@ class StandardRPCLinkCodec {
|
|
|
271
262
|
}
|
|
272
263
|
})();
|
|
273
264
|
if (!isOk) {
|
|
274
|
-
if (
|
|
275
|
-
throw
|
|
265
|
+
if (isORPCErrorJson(deserialized)) {
|
|
266
|
+
throw createORPCErrorFromJson(deserialized);
|
|
276
267
|
}
|
|
277
|
-
throw new
|
|
278
|
-
|
|
268
|
+
throw new ORPCError(getMalformedResponseErrorCode(response.status), {
|
|
269
|
+
status: response.status,
|
|
270
|
+
data: { ...response, body: deserialized }
|
|
279
271
|
});
|
|
280
272
|
}
|
|
281
273
|
return deserialized;
|
|
@@ -301,9 +293,6 @@ class StandardRPCSerializer {
|
|
|
301
293
|
return this.#serialize(data, true);
|
|
302
294
|
}
|
|
303
295
|
#serialize(data, enableFormData) {
|
|
304
|
-
if (data === void 0 || data instanceof Blob) {
|
|
305
|
-
return data;
|
|
306
|
-
}
|
|
307
296
|
const [json, meta_, maps, blobs] = this.jsonSerializer.serialize(data);
|
|
308
297
|
const meta = meta_.length === 0 ? void 0 : meta_;
|
|
309
298
|
if (!enableFormData || blobs.length === 0) {
|
|
@@ -328,8 +317,8 @@ class StandardRPCSerializer {
|
|
|
328
317
|
return e;
|
|
329
318
|
}
|
|
330
319
|
const deserialized = this.#deserialize(e.data);
|
|
331
|
-
if (
|
|
332
|
-
return
|
|
320
|
+
if (isORPCErrorJson(deserialized)) {
|
|
321
|
+
return createORPCErrorFromJson(deserialized, { cause: e });
|
|
333
322
|
}
|
|
334
323
|
return new ErrorEvent({
|
|
335
324
|
data: deserialized,
|
|
@@ -341,9 +330,6 @@ class StandardRPCSerializer {
|
|
|
341
330
|
return this.#deserialize(data);
|
|
342
331
|
}
|
|
343
332
|
#deserialize(data) {
|
|
344
|
-
if (data === void 0 || data instanceof Blob) {
|
|
345
|
-
return data;
|
|
346
|
-
}
|
|
347
333
|
if (!(data instanceof FormData)) {
|
|
348
334
|
return this.jsonSerializer.deserialize(data.json, data.meta ?? []);
|
|
349
335
|
}
|
|
@@ -357,4 +343,13 @@ class StandardRPCSerializer {
|
|
|
357
343
|
}
|
|
358
344
|
}
|
|
359
345
|
|
|
360
|
-
|
|
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 };
|
|
@@ -0,0 +1,91 @@
|
|
|
1
|
+
import { b as ClientContext, c as ClientOptions, f as HTTPMethod } from './client.BOYsZIRq.js';
|
|
2
|
+
import { e as StandardLinkCodec, b as StandardLinkOptions, d as StandardLink, f as StandardLinkClient } from './client.CXXEPIbK.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>, [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,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.C4VxIexA.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 };
|
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.24085bc",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"homepage": "https://orpc.unnoq.com",
|
|
7
7
|
"repository": {
|
|
@@ -19,6 +19,11 @@
|
|
|
19
19
|
"import": "./dist/index.mjs",
|
|
20
20
|
"default": "./dist/index.mjs"
|
|
21
21
|
},
|
|
22
|
+
"./plugins": {
|
|
23
|
+
"types": "./dist/plugins/index.d.mts",
|
|
24
|
+
"import": "./dist/plugins/index.mjs",
|
|
25
|
+
"default": "./dist/plugins/index.mjs"
|
|
26
|
+
},
|
|
22
27
|
"./standard": {
|
|
23
28
|
"types": "./dist/adapters/standard/index.d.mts",
|
|
24
29
|
"import": "./dist/adapters/standard/index.mjs",
|
|
@@ -28,18 +33,29 @@
|
|
|
28
33
|
"types": "./dist/adapters/fetch/index.d.mts",
|
|
29
34
|
"import": "./dist/adapters/fetch/index.mjs",
|
|
30
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"
|
|
31
46
|
}
|
|
32
47
|
},
|
|
33
48
|
"files": [
|
|
34
49
|
"dist"
|
|
35
50
|
],
|
|
36
51
|
"dependencies": {
|
|
37
|
-
"@orpc/
|
|
38
|
-
"@orpc/standard-server-fetch": "0.0.0-next.
|
|
39
|
-
"@orpc/
|
|
52
|
+
"@orpc/shared": "0.0.0-next.24085bc",
|
|
53
|
+
"@orpc/standard-server-fetch": "0.0.0-next.24085bc",
|
|
54
|
+
"@orpc/standard-server": "0.0.0-next.24085bc",
|
|
55
|
+
"@orpc/standard-server-peer": "0.0.0-next.24085bc"
|
|
40
56
|
},
|
|
41
57
|
"devDependencies": {
|
|
42
|
-
"zod": "^
|
|
58
|
+
"zod": "^4.0.5"
|
|
43
59
|
},
|
|
44
60
|
"scripts": {
|
|
45
61
|
"build": "unbuild",
|
|
@@ -1,42 +0,0 @@
|
|
|
1
|
-
type ClientContext = Record<string, any>;
|
|
2
|
-
type ClientOptions<TClientContext extends ClientContext> = {
|
|
3
|
-
signal?: AbortSignal;
|
|
4
|
-
lastEventId?: string | undefined;
|
|
5
|
-
} & (Record<never, never> extends TClientContext ? {
|
|
6
|
-
context?: TClientContext;
|
|
7
|
-
} : {
|
|
8
|
-
context: TClientContext;
|
|
9
|
-
});
|
|
10
|
-
type ClientRest<TClientContext extends ClientContext, TInput> = Record<never, never> extends TClientContext ? undefined extends TInput ? [input?: TInput, options?: ClientOptions<TClientContext>] : [input: TInput, options?: ClientOptions<TClientContext>] : [input: TInput, options: ClientOptions<TClientContext>];
|
|
11
|
-
type ClientPromiseResult<TOutput, TError extends Error> = Promise<TOutput> & {
|
|
12
|
-
__error?: {
|
|
13
|
-
type: TError;
|
|
14
|
-
};
|
|
15
|
-
};
|
|
16
|
-
interface Client<TClientContext extends ClientContext, TInput, TOutput, TError extends Error> {
|
|
17
|
-
(...rest: ClientRest<TClientContext, TInput>): ClientPromiseResult<TOutput, TError>;
|
|
18
|
-
}
|
|
19
|
-
type NestedClient<TClientContext extends ClientContext> = Client<TClientContext, any, any, any> | {
|
|
20
|
-
[k: string]: NestedClient<TClientContext>;
|
|
21
|
-
};
|
|
22
|
-
type InferClientContext<T extends NestedClient<any>> = T extends NestedClient<infer U> ? U : never;
|
|
23
|
-
type ClientOptionsOut<TClientContext extends ClientContext> = ClientOptions<TClientContext> & {
|
|
24
|
-
context: TClientContext;
|
|
25
|
-
};
|
|
26
|
-
interface ClientLink<TClientContext extends ClientContext> {
|
|
27
|
-
call: (path: readonly string[], input: unknown, options: ClientOptionsOut<TClientContext>) => Promise<unknown>;
|
|
28
|
-
}
|
|
29
|
-
|
|
30
|
-
declare function mapEventIterator<TYield, TReturn, TNext, TMap = TYield | TReturn>(iterator: AsyncIterator<TYield, TReturn, TNext>, maps: {
|
|
31
|
-
value: (value: NoInfer<TYield | TReturn>, done: boolean | undefined) => Promise<TMap>;
|
|
32
|
-
error: (error: unknown) => Promise<unknown>;
|
|
33
|
-
}): AsyncGenerator<TMap, TMap, TNext>;
|
|
34
|
-
interface EventIteratorReconnectOptions {
|
|
35
|
-
lastRetry: number | undefined;
|
|
36
|
-
lastEventId: string | undefined;
|
|
37
|
-
retryTimes: number;
|
|
38
|
-
error: unknown;
|
|
39
|
-
}
|
|
40
|
-
declare function createAutoRetryEventIterator<TYield, TReturn>(initial: AsyncIterator<TYield, TReturn, void>, reconnect: (options: EventIteratorReconnectOptions) => Promise<AsyncIterator<TYield, TReturn, void> | null>, initialLastEventId: string | undefined): AsyncGenerator<TYield, TReturn, void>;
|
|
41
|
-
|
|
42
|
-
export { type ClientContext as C, type EventIteratorReconnectOptions as E, type InferClientContext as I, type NestedClient as N, type ClientOptionsOut as a, type ClientLink as b, type ClientPromiseResult as c, createAutoRetryEventIterator as d, type ClientOptions as e, type ClientRest as f, type Client as g, mapEventIterator as m };
|